chore: create test matcher that can skip test suites with coverage (#1285)

Author: metal-messiah

tests/specs/spa/harvesting.e2e.js

@@ -2,7 +2,7 @@ import { checkSpa } from '../../util/basic-checks'
 import { testInteractionEventsRequest } from '../../../tools/testing-server/utils/expect-tests'
 import { JSONPath } from 'jsonpath-plus'
 
-describe('spa harvesting', () => {
+describe.withoutCoverage()('spa harvesting', () => {
   let interactionsCapture
 
   beforeEach(async () => {

tools/wdio/plugins/browser-matcher.mjs

@@ -7,10 +7,15 @@ import { getBrowserName, getBrowserVersion } from '../../browsers-lists/utils.mj
 export default class BrowserMatcher {
   #browserName
   #browserVersion
+  #collectCoverage
 
   async beforeSession (_, capabilities) {
     this.#browserName = getBrowserName(capabilities)
     this.#browserVersion = getBrowserVersion(capabilities)
+
+    this.#collectCoverage = capabilities.collectCoverage
+    delete capabilities.collectCoverage
+
     this.#setupMochaGlobals()
   }
 
@@ -50,6 +55,32 @@ export default class BrowserMatcher {
         return this.#wrapFnWithBrowserMatcher(matcher, originalGlobal)
       }
     })
+
+    Object.defineProperty(originalGlobal, 'withoutCoverage', {
+      value: () => {
+        return this.#wrapFnWithCoverageCheck(originalGlobal)
+      }
+    })
+  }
+
+  #wrapFnWithCoverageCheck (originalGlobal) {
+    const skip = !!this.#collectCoverage
+
+    return function (...args) {
+      /*
+        We only call global.it for tests that are not skipped.
+        The test will skip if coverage flag is passed is on and the test is marked as 'withoutCoverage'. This registers the test
+        with the mocha engine. When all tests in a file are skipped, WDIO will not launch
+        a browser in LambdaTest.
+
+        Do not use global.it.skip. This still registers the test with mocha and will cause
+        WDIO to launch a browser in LambdaTest. If all the tests are skipped in a file, this
+        is a waste of time.
+      */
+      if (!skip) {
+        originalGlobal.apply(this, args)
+      }
+    }
   }
 
   #wrapFnWithBrowserMatcher (matcher, originalGlobal) {

tools/wdio/plugins/testing-server/launcher.mjs

@@ -9,12 +9,14 @@ const log = logger('testing-server')
  */
 export default class TestingServerLauncher {
   #testingServer
+  #collectCoverage
 
   constructor (opts) {
     this.#testingServer = new TestServer({
       ...opts,
       logger: log
     })
+    this.#collectCoverage = opts.coverage
   }
 
   async onPrepare (_, capabilities) {
@@ -25,9 +27,11 @@ export default class TestingServerLauncher {
     log.info(`Command server started on http://${this.#testingServer.commandServer.host}:${this.#testingServer.commandServer.port}`)
 
     capabilities.forEach((capability) => {
+      /** these props will be deleted later before sending to LT */
       capability.assetServer = serialize({ host: this.#testingServer.assetServer.host, port: this.#testingServer.assetServer.port })
       capability.bamServer = serialize({ host: this.#testingServer.bamServer.host, port: this.#testingServer.bamServer.port })
       capability.commandServer = serialize({ host: this.#testingServer.commandServer.host, port: this.#testingServer.commandServer.port })
+      capability.collectCoverage = this.#collectCoverage
     })
   }