codeceptjs 3.5.9 → 3.5.10

package/docs/helpers/Puppeteer.md

@@ -1216,6 +1216,21 @@ let inputs = await I.grabValueFromAll('//form/input');
 
 Returns **[Promise][13]<[Array][15]<[string][6]>>** attribute value
 
+### grabWebElements
+
+Grab WebElements for given locator
+Resumes test execution, so **should be used inside an async function with `await`** operator.
+
+```js
+const webElements = await I.grabWebElements('#button');
+```
+
+#### Parameters
+
+-   `locator` **([string][6] | [object][4])** element located by CSS|XPath|strict locator.
+
+Returns **[Promise][13]<any>** WebElement of being used Web helper
+
 ### handleDownloads
 
 Sets a directory to where save files. Allows to test file downloads.

package/docs/helpers/WebDriver.md

@@ -1367,6 +1367,21 @@ let inputs = await I.grabValueFromAll('//form/input');
 
 Returns **[Promise][25]<[Array][28]<[string][17]>>** attribute value
 
+### grabWebElements
+
+Grab WebElements for given locator
+Resumes test execution, so **should be used inside an async function with `await`** operator.
+
+```js
+const webElements = await I.grabWebElements('#button');
+```
+
+#### Parameters
+
+-   `locator` **([string][17] | [object][16])** element located by CSS|XPath|strict locator.
+
+Returns **[Promise][25]<any>** WebElement of being used Web helper
+
 ### moveCursorTo
 
 Moves cursor to element matched by locator.

package/docs/internal-api.md

@@ -119,6 +119,7 @@ Available events:
 * `event.all.result` - when results are printed
 * `event.workers.before` - before spawning workers in parallel run
 * `event.workers.after` - after workers finished in parallel run
+* `event.workers.result` - test results after workers finished in parallel run
 
 
 > *sync* - means that event is fired in the moment of the action happening.

package/docs/parallel.md

@@ -26,12 +26,124 @@ This command is similar to `run`, however, steps output can't be shown in worker
 
 Each worker spins an instance of CodeceptJS, executes a group of tests, and sends back report to the main process.
 
-By default the tests are assigned one by one to the available workers this may lead to multiple execution of `BeforeSuite()`. Use the option `--suites` to assigne the suites one by one to the workers.
+By default, the tests are assigned one by one to the available workers this may lead to multiple execution of `BeforeSuite()`. Use the option `--suites` to assign the suites one by one to the workers.
 
 ```sh
 npx codeceptjs run-workers --suites 2
 ```
 
+## Test stats with Parallel Execution by Workers
+
+```js
+const { event } = require('codeceptjs');
+
+module.exports = function() {
+
+  event.dispatcher.on(event.workers.result, function (result) {
+
+    console.log(result);
+
+  });
+}
+
+// in console log
+FAIL  | 7 passed, 1 failed, 1 skipped   // 2s
+{
+  "tests": {
+  "passed": [
+    {
+      "type": "test",
+      "title": "Assert @C3",
+      "body": "() => { }",
+      "async": 0,
+      "sync": true,
+      "_timeout": 2000,
+      "_slow": 75,
+      "_retries": -1,
+      "timedOut": false,
+      "_currentRetry": 0,
+      "pending": false,
+      "opts": {},
+      "tags": [
+        "@C3"
+      ],
+      "uid": "xe4q1HdqpRrZG5dPe0JG+A",
+      "workerIndex": 3,
+      "retries": -1,
+      "duration": 493,
+      "err": null,
+      "parent": {
+        "title": "My",
+        "ctx": {},
+        "suites": [],
+        "tests": [],
+        "root": false,
+        "pending": false,
+        "_retries": -1,
+        "_beforeEach": [],
+        "_beforeAll": [],
+        "_afterEach": [],
+        "_afterAll": [],
+        "_timeout": 2000,
+        "_slow": 75,
+        "_bail": false,
+        "_onlyTests": [],
+        "_onlySuites": [],
+        "delayed": false
+      },
+      "steps": [
+        {
+          "actor": "I",
+          "name": "amOnPage",
+          "status": "success",
+          "agrs": [
+            "https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST"
+          ],
+          "startedAt": 1698760652610,
+          "startTime": 1698760652611,
+          "endTime": 1698760653098,
+          "finishedAt": 1698760653098,
+          "duration": 488
+        },
+        {
+          "actor": "I",
+          "name": "grabCurrentUrl",
+          "status": "success",
+          "agrs": [],
+          "startedAt": 1698760653098,
+          "startTime": 1698760653098,
+          "endTime": 1698760653099,
+          "finishedAt": 1698760653099,
+          "duration": 1
+        }
+      ]
+    }
+  ],
+    "failed": [],
+    "skipped": []
+}
+}
+```
+
+CodeceptJS also exposes the env var `process.env.RUNS_WITH_WORKERS` when running tests with `run-workers` command so that you could handle the events better in your plugins/helpers
+
+```js
+const { event } = require('codeceptjs');
+
+module.exports = function() {
+    // this event would trigger the  `_publishResultsToTestrail` when running `run-workers` command
+  event.dispatcher.on(event.workers.result, async () => {
+    await _publishResultsToTestrail();
+  });
+  
+  // this event would not trigger the  `_publishResultsToTestrail` multiple times when running `run-workers` command
+  event.dispatcher.on(event.all.result, async () => {
+      // when running `run` command, this env var is undefined
+    if (!process.env.RUNS_WITH_WORKERS) await _publishResultsToTestrail();
+  });
+}
+```
+
 ## Parallel Execution by Workers on Multiple Browsers
 
 To run tests in parallel across multiple browsers, modify your `codecept.conf.js` file to configure multiple browsers on which you want to run your tests and your tests will run across multiple browsers. 
@@ -236,7 +348,7 @@ customWorkers.on(event.all.result, () => {
 
 ### Emitting messages to the parent worker
 
-Child workers can send non test events to the main process. This is useful if you want to pass along information not related to the tests event cycles itself such as `event.test.success`.
+Child workers can send non-test events to the main process. This is useful if you want to pass along information not related to the tests event cycles itself such as `event.test.success`.
 
 ```js
 // inside main process

package/docs/plugins.md

@@ -65,12 +65,14 @@ If a session expires automatically logs in again.
 ```js
 // inside a test file
 // use login to inject auto-login function
+Feature('Login');
+
 Before(({ login }) => {
    login('user'); // login using user session
 });
 
-// Alternatively log in for one scenario
-Scenario('log me in', ( {I, login} ) => {
+// Alternatively log in for one scenario.
+Scenario('log me in', ( { I, login } ) => {
    login('admin');
    I.see('I am logged in');
 });

package/docs/webapi/grabWebElement.mustache

@@ -0,0 +1,9 @@
+Grab WebElement for given locator
+Resumes test execution, so **should be used inside an async function with `await`** operator.
+
+```js
+const webElement = await I.grabWebElement('#button');
+```
+
+@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+@returns {Promise<*>} WebElement of being used Web helper

package/docs/webapi/grabWebElements.mustache

@@ -0,0 +1,9 @@
+Grab WebElements for given locator
+Resumes test execution, so **should be used inside an async function with `await`** operator.
+
+```js
+const webElements = await I.grabWebElements('#button');
+```
+
+@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+@returns {Promise<*>} WebElement of being used Web helper

package/lib/ai.js

@@ -16,6 +16,8 @@ const htmlConfig = {
   html: {},
 };
 
+const aiInstance = null;
+
 class AiAssistant {
   constructor() {
     this.config = config.get('ai', defaultConfig);
@@ -26,7 +28,10 @@ class AiAssistant {
 
     this.isEnabled = !!process.env.OPENAI_API_KEY;
 
-    if (!this.isEnabled) return;
+    if (!this.isEnabled) {
+      debug('No OpenAI API key provided. AI assistant is disabled.');
+      return;
+    }
 
     const configuration = new Configuration({
       apiKey: process.env.OPENAI_API_KEY,
@@ -35,13 +40,17 @@ class AiAssistant {
     this.openai = new OpenAIApi(configuration);
   }
 
-  setHtmlContext(html) {
+  static getInstance() {
+    return aiInstance || new AiAssistant();
+  }
+
+  async setHtmlContext(html) {
     let processedHTML = html;
 
     if (this.htmlConfig.simplify) {
       processedHTML = removeNonInteractiveElements(processedHTML, this.htmlConfig);
     }
-    if (this.htmlConfig.minify) processedHTML = minifyHtml(processedHTML);
+    if (this.htmlConfig.minify) processedHTML = await minifyHtml(processedHTML);
     if (this.htmlConfig.maxLength) processedHTML = splitByChunks(processedHTML, this.htmlConfig.maxLength)[0];
 
     debug(processedHTML);

package/lib/colorUtils.js

@@ -226,15 +226,25 @@ function isColorProperty(prop) {
     'color',
     'background',
     'backgroundColor',
+    'background-color',
     'borderColor',
+    'border-color',
     'borderBottomColor',
+    'border-bottom-color',
     'borderLeftColor',
+    'border-left-color',
     'borderRightColor',
     'borderTopColor',
     'caretColor',
     'columnRuleColor',
     'outlineColor',
     'textDecorationColor',
+    'border-right-color',
+    'border-top-color',
+    'caret-color',
+    'column-rule-color',
+    'outline-color',
+    'text-decoration-color',
   ].indexOf(prop) > -1;
 }
 

package/lib/command/run-multiple.js

@@ -124,7 +124,7 @@ function executeRun(runName, runConfig) {
   if (browserConfig.outputName) {
     outputDir += typeof browserConfig.outputName === 'function' ? browserConfig.outputName() : browserConfig.outputName;
   } else {
-    const hash = crypto.createHash('md5');
+    const hash = crypto.createHash('sha256');
     hash.update(JSON.stringify(browserConfig));
     outputDir += hash.digest('hex');
   }

package/lib/command/run-workers.js

@@ -7,6 +7,11 @@ const Workers = require('../workers');
 module.exports = async function (workerCount, selectedRuns, options) {
   process.env.profile = options.profile;
 
+  const suiteArr = [];
+  const passedTestArr = [];
+  const failedTestArr = [];
+  const skippedTestArr = [];
+
   const { config: testConfig, override = '' } = options;
   const overrideConfigs = tryOrDefault(() => JSON.parse(override), {});
   const by = options.suites ? 'suite' : 'test';
@@ -26,15 +31,36 @@ module.exports = async function (workerCount, selectedRuns, options) {
 
   const workers = new Workers(numberOfWorkers, config);
   workers.overrideConfig(overrideConfigs);
-  workers.on(event.test.failed, (failedTest) => {
-    output.test.failed(failedTest);
+
+  workers.on(event.suite.before, (suite) => {
+    suiteArr.push(suite);
+  });
+
+  workers.on(event.test.failed, (test) => {
+    failedTestArr.push(test);
+    output.test.failed(test);
+  });
+
+  workers.on(event.test.passed, (test) => {
+    passedTestArr.push(test);
+    output.test.passed(test);
   });
 
-  workers.on(event.test.passed, (successTest) => {
-    output.test.passed(successTest);
+  workers.on(event.test.skipped, (test) => {
+    skippedTestArr.push(test);
+    output.test.passed(test);
   });
 
   workers.on(event.all.result, () => {
+    // expose test stats after all workers finished their execution
+    event.dispatcher.emit(event.workers.result, {
+      suites: suiteArr,
+      tests: {
+        passed: passedTestArr,
+        failed: failedTestArr,
+        skipped: skippedTestArr,
+      },
+    });
     workers.printResults();
   });
 

package/lib/command/workers/runTests.js

@@ -132,9 +132,32 @@ function initializeListeners() {
       duration: test.duration || 0,
       err,
       parent,
+      steps: test.steps ? simplifyStepsInTestObject(test.steps, err) : [],
     };
   }
 
+  function simplifyStepsInTestObject(steps, err) {
+    steps = [...steps];
+    const _steps = [];
+
+    for (step of steps) {
+      _steps.push({
+        actor: step.actor,
+        name: step.name,
+        status: step.status,
+        agrs: step.args,
+        startedAt: step.startedAt,
+        startTime: step.startTime,
+        endTime: step.endTime,
+        finishedAt: step.finishedAt,
+        duration: step.duration,
+        err,
+      });
+    }
+
+    return _steps;
+  }
+
   function simplifyStep(step, err = null) {
     step = { ...step };
 

package/lib/event.js

@@ -127,10 +127,12 @@ module.exports = {
    * @inner
    * @property {'workers.before'} before
    * @property {'workers.after'} after
+   * @property {'workers.result'} result
    */
   workers: {
     before: 'workers.before',
     after: 'workers.after',
+    result: 'workers.result',
   },
 
   /**

package/lib/helper/Appium.js

@@ -276,7 +276,7 @@ class Appium extends Webdriver {
     const _convertedCaps = {};
     for (const [key, value] of Object.entries(capabilities)) {
       if (!key.startsWith(vendorPrefix.appium)) {
-        if (key !== 'platformName') {
+        if (key !== 'platformName' && key !== 'bstack:options') {
           _convertedCaps[`${vendorPrefix.appium}:${key}`] = value;
         } else {
           _convertedCaps[`${key}`] = value;
@@ -368,7 +368,7 @@ class Appium extends Webdriver {
       if (context.web) return this.switchToWeb(context.web);
       if (context.webview) return this.switchToWeb(context.webview);
     }
-    return this._switchToContext(context);
+    return this.switchToContext(context);
   }
 
   _withinEnd() {
@@ -423,8 +423,8 @@ class Appium extends Webdriver {
   async runOnIOS(caps, fn) {
     if (this.platform !== 'ios') return;
     recorder.session.start('iOS-only actions');
-    this._runWithCaps(caps, fn);
-    recorder.add('restore from iOS session', () => recorder.session.restore());
+    await this._runWithCaps(caps, fn);
+    await recorder.add('restore from iOS session', () => recorder.session.restore());
     return recorder.promise();
   }
 
@@ -465,8 +465,8 @@ class Appium extends Webdriver {
   async runOnAndroid(caps, fn) {
     if (this.platform !== 'android') return;
     recorder.session.start('Android-only actions');
-    this._runWithCaps(caps, fn);
-    recorder.add('restore from Android session', () => recorder.session.restore());
+    await this._runWithCaps(caps, fn);
+    await recorder.add('restore from Android session', () => recorder.session.restore());
     return recorder.promise();
   }
 
@@ -834,7 +834,7 @@ class Appium extends Webdriver {
    *
    * @param {*} context the context to switch to
    */
-  async _switchToContext(context) {
+  async switchToContext(context) {
     return this.browser.switchContext(context);
   }
 
@@ -858,11 +858,11 @@ class Appium extends Webdriver {
     this.isWeb = true;
     this.defaultContext = 'body';
 
-    if (context) return this._switchToContext(context);
+    if (context) return this.switchToContext(context);
     const contexts = await this.grabAllContexts();
     this.debugSection('Contexts', contexts.toString());
     for (const idx in contexts) {
-      if (contexts[idx].match(/^WEBVIEW/)) return this._switchToContext(contexts[idx]);
+      if (contexts[idx].match(/^WEBVIEW/)) return this.switchToContext(contexts[idx]);
     }
 
     throw new Error('No WEBVIEW could be guessed, please specify one in params');
@@ -885,8 +885,8 @@ class Appium extends Webdriver {
     this.isWeb = false;
     this.defaultContext = '//*';
 
-    if (context) return this._switchToContext(context);
-    return this._switchToContext('NATIVE_APP');
+    if (context) return this.switchToContext(context);
+    return this.switchToContext('NATIVE_APP');
   }
 
   /**
@@ -1424,10 +1424,10 @@ class Appium extends Webdriver {
    *
    * @return {Promise<void>}
    *
-   * Appium: support only iOS
+   * Appium: support both Android and iOS
    */
   async closeApp() {
-    onlyForApps.call(this, 'iOS');
+    onlyForApps.call(this);
     return this.browser.closeApp();
   }