codeceptjs 3.4.1 → 3.5.1

package/lib/workers.js

@@ -10,12 +10,14 @@ const MochaFactory = require('./mochaFactory');
 const Container = require('./container');
 const { getTestRoot } = require('./command/utils');
 const { isFunction, fileExists } = require('./utils');
+const { replaceValueDeep, deepClone } = require('./utils');
 const mainConfig = require('./config');
 const output = require('./output');
 const event = require('./event');
 const recorder = require('./recorder');
 const runHook = require('./hooks');
 const WorkerStorage = require('./workerStorage');
+const collection = require('./command/run-multiple/collection');
 
 const pathToWorker = path.join(__dirname, 'command', 'workers', 'runTests.js');
 
@@ -79,15 +81,39 @@ const repackTest = (test) => {
   return test;
 };
 
-const createWorkerObjects = (testGroups, config, testRoot, options) => {
-  return testGroups.map((tests, index) => {
-    const workerObj = new WorkerObject(index);
-    workerObj.addConfig(config);
-    workerObj.addTests(tests);
-    workerObj.setTestRoot(testRoot);
-    workerObj.addOptions(options);
-    return workerObj;
+const createWorkerObjects = (testGroups, config, testRoot, options, selectedRuns) => {
+  selectedRuns = options && options.all && config.multiple ? Object.keys(config.multiple) : selectedRuns;
+  if (selectedRuns === undefined || !selectedRuns.length || config.multiple === undefined) {
+    return testGroups.map((tests, index) => {
+      const workerObj = new WorkerObject(index);
+      workerObj.addConfig(config);
+      workerObj.addTests(tests);
+      workerObj.setTestRoot(testRoot);
+      workerObj.addOptions(options);
+      return workerObj;
+    });
+  }
+  const workersToExecute = [];
+  collection.createRuns(selectedRuns, config).forEach((worker) => {
+    const workerName = worker.getOriginalName() || worker.getName();
+    const workerConfig = worker.getConfig();
+    workersToExecute.push(getOverridenConfig(workerName, workerConfig, config));
+  });
+  const workers = [];
+  let index = 0;
+  testGroups.forEach((tests) => {
+    const testWorkerArray = [];
+    workersToExecute.forEach((finalConfig) => {
+      const workerObj = new WorkerObject(index++);
+      workerObj.addConfig(finalConfig);
+      workerObj.addTests(tests);
+      workerObj.setTestRoot(testRoot);
+      workerObj.addOptions(options);
+      testWorkerArray.push(workerObj);
+    });
+    workers.push(...testWorkerArray);
   });
+  return workers;
 };
 
 const indexOfSmallestElement = (groups) => {
@@ -115,6 +141,28 @@ const convertToMochaTests = (testGroup) => {
   return group;
 };
 
+const getOverridenConfig = (workerName, workerConfig, config) => {
+  // clone config
+  const overriddenConfig = deepClone(config);
+
+  // get configuration
+  const browserConfig = workerConfig.browser;
+
+  for (const key in browserConfig) {
+    overriddenConfig.helpers = replaceValueDeep(overriddenConfig.helpers, key, browserConfig[key]);
+  }
+
+  // override tests configuration
+  if (overriddenConfig.tests) {
+    overriddenConfig.tests = workerConfig.tests;
+  }
+
+  if (overriddenConfig.gherkin && workerConfig.gherkin && workerConfig.gherkin.features) {
+    overriddenConfig.gherkin.features = workerConfig.gherkin.features;
+  }
+  return overriddenConfig;
+};
+
 class WorkerObject {
   /**
    * @param {Number} workerIndex - Unique ID for worker
@@ -183,7 +231,7 @@ class Workers extends EventEmitter {
 
   _initWorkers(numberOfWorkers, config) {
     this.splitTestsByGroups(numberOfWorkers, config);
-    this.workers = createWorkerObjects(this.testGroups, this.codecept.config, config.testConfig, config.options);
+    this.workers = createWorkerObjects(this.testGroups, this.codecept.config, config.testConfig, config.options, config.selectedRuns);
     this.numberOfWorkers = this.workers.length;
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.4.1",
+  "version": "3.5.1",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -45,8 +45,14 @@
     "test": "npm run test:unit && npm run test:runner",
     "test:appium-quick": "mocha test/helper/Appium_test.js --grep 'quick'",
     "test:appium-other": "mocha test/helper/Appium_test.js --grep 'second'",
+    "test-app:start": "php -S 127.0.0.1:8000 -t test/data/app",
+    "test-app:stop": "kill -9 $(lsof -t -i:8000)",
+    "test:unit:webbapi:playwright": "mocha test/helper/Playwright_test.js",
+    "test:unit:webbapi:puppeteer": "mocha test/helper/Puppeteer_test.js",
+    "test:unit:webbapi:webDriver": "mocha test/helper/WebDriver_test.js",
+    "test:unit:webbapi:testCafe": "mocha test/helper/TestCafe_test.js",
     "def": "./runok.js def",
-    "dev:graphql": "nodemon test/data/graphql/index.js",
+    "dev:graphql": "node test/data/graphql/index.js",
     "publish:site": "./runok.js publish:site",
     "update-contributor-faces": "contributor-faces .",
     "dtslint": "dtslint typings --localTs './node_modules/typescript/lib'",
@@ -58,13 +64,14 @@
     "@cucumber/cucumber-expressions": "^16",
     "@cucumber/gherkin": "^26",
     "@cucumber/messages": "^21.0.1",
+    "@xmldom/xmldom": "^0.7.9",
     "acorn": "^7.4.1",
     "arrify": "^2.0.1",
     "axios": "^1.3.3",
     "chai": "^4.3.6",
     "chai-deep-match": "^1.2.1",
     "chalk": "^4.1.2",
-    "commander": "^2.20.3",
+    "commander": "^11.0.0",
     "cross-spawn": "^7.0.3",
     "css-to-xpath": "^0.1.0",
     "envinfo": "^7.8.1",
@@ -73,6 +80,7 @@
     "fn-args": "^4.0.0",
     "fs-extra": "^8.1.0",
     "glob": "^6.0.1",
+    "html-minifier": "^4.0.0",
     "inquirer": "^6.5.2",
     "joi": "^17.6.0",
     "js-beautify": "^1.14.0",
@@ -80,9 +88,11 @@
     "lodash.merge": "^4.6.2",
     "mkdirp": "^1.0.4",
     "mocha": "^10.2.0",
-    "mocha-junit-reporter": "^1.23.3",
     "ms": "^2.1.3",
+    "openai": "^3.2.1",
+    "ora-classic": "^5.4.2",
     "parse-function": "^5.6.4",
+    "parse5": "^7.1.2",
     "promise-retry": "^1.1.1",
     "resq": "^1.10.2",
     "sprintf-js": "^1.1.1",
@@ -92,14 +102,14 @@
     "@codeceptjs/detox-helper": "^1.0.2",
     "@codeceptjs/mock-request": "^0.3.1",
     "@faker-js/faker": "^7.6.0",
-    "@pollyjs/adapter-puppeteer": "^5.1.0",
+    "@pollyjs/adapter-puppeteer": "^6.0.5",
     "@pollyjs/core": "^5.1.0",
     "@types/inquirer": "^0.0.35",
     "@types/node": "^8.10.66",
-    "@wdio/sauce-service": "^5.22.5",
-    "@wdio/selenium-standalone-service": "^5.16.10",
-    "@wdio/utils": "^5.23.0",
-    "apollo-server-express": "^2.25.3",
+    "@wdio/sauce-service": "^8.3.8",
+    "@wdio/selenium-standalone-service": "^8.3.2",
+    "@wdio/utils": "^8.3.0",
+    "apollo-server-express": "2.25.3",
     "chai-as-promised": "^7.1.1",
     "chai-subset": "^1.6.0",
     "contributor-faces": "^1.0.3",
@@ -107,7 +117,7 @@
     "dtslint": "^4.1.6",
     "electron": "^12.2.3",
     "eslint": "^6.8.0",
-    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-mocha": "^6.3.0",
     "expect": "^26.6.2",
@@ -120,11 +130,10 @@
     "jsdoc-typeof-plugin": "^1.0.0",
     "json-server": "^0.10.1",
     "nightmare": "^3.0.2",
-    "nodemon": "^1.19.4",
-    "playwright": "^1.23.2",
+    "playwright": "^1.35.1",
     "puppeteer": "^10.4.0",
     "qrcode-terminal": "^0.12.0",
-    "rosie": "^1.6.0",
+    "rosie": "^2.1.0",
     "runok": "^0.9.2",
     "sinon": "^9.2.4",
     "sinon-chai": "^3.7.0",
@@ -137,12 +146,12 @@
     "typescript": "^4.8.4",
     "wdio-docker-service": "^1.5.0",
     "webdriverio": "^8.3.8",
-    "xml2js": "^0.4.23",
-    "xmldom": "^0.1.31",
+    "xml2js": "^0.6.0",
+    "xmldom": "^0.5.0",
     "xpath": "0.0.27"
   },
   "engines": {
-    "node": ">=8.9.1",
+    "node": ">=16.0",
     "npm": ">=5.6.0"
   },
   "es6": true

package/translations/ja-JP.js

@@ -14,34 +14,34 @@ module.exports = {
     amOnPage: 'ページを移動する',
     click: 'クリックする',
     doubleClick: 'ダブルクリックする',
-    see: 'テキストがあるか確認する',
+    see: 'テキストがあることを確認する',
     dontSee: 'テキストがないことを確認する',
     selectOption: 'オプションを選ぶ',
     fillField: 'フィールドに入力する',
     pressKey: 'キー入力する',
     triggerMouseEvent: 'マウスイベントを発火させる',
     attachFile: 'ファイルを添付する',
-    seeInField: 'フィールドに文字が入っているか確認する',
-    dontSeeInField: 'フィールドに文字が入っていないか確認する',
+    seeInField: 'フィールドに文字が入っていることを確認する',
+    dontSeeInField: 'フィールドに文字が入っていないことを確認する',
     appendField: 'フィールドに文字を追加する',
     checkOption: 'オプションをチェックする',
-    seeCheckboxIsChecked: 'チェックされているか確認する',
+    seeCheckboxIsChecked: 'チェックされていることを確認する',
     dontSeeCheckboxIsChecked: 'チェックされていないことを確認する',
     grabTextFrom: 'テキストを取得する',
     grabValueFrom: '入力値を取得する',
     grabAttributeFrom: '要素を取得する',
-    seeInTitle: 'タイトルに文字が含まれるか確認する',
+    seeInTitle: 'タイトルに文字が含まれていることを確認する',
     dontSeeInTitle: 'タイトルに文字が含まれないことを確認する',
     grabTitle: 'タイトルを取得する',
-    seeElement: '要素があるか確認する',
+    seeElement: '要素があることを確認する',
     dontSeeElement: '要素がないことを確認する',
-    seeInSource: 'ソースにあるか確認する',
+    seeInSource: 'ソースにあることを確認する',
     dontSeeInSource: 'ソースにないことを確認する',
     executeScript: 'スクリプトを実行する',
     executeAsyncScript: '非同期スクリプトを実行する',
-    seeInCurrentUrl: 'URLに含まれるか確認する',
+    seeInCurrentUrl: 'URLに含まれることを確認する',
     dontSeeInCurrentUrl: 'URLに含まれないことを確認する',
-    seeCurrentUrlEquals: 'URLが等しいか確認する',
+    seeCurrentUrlEquals: 'URLが等しいことを確認する',
     dontSeeCurrentUrlEquals: 'URLが等しくないことを確認する',
     saveScreenshot: 'スクリーンショットを保存する',
     setCookie: 'Cookieをセットする',

package/typings/index.d.ts

@@ -12,26 +12,26 @@ declare namespace CodeceptJS {
 
   type Cookie = {
     name: string;
-    value: string;
+    value: string | boolean;
     domain?: string,
     path?: string,
   };
 
   type RetryConfig = {
     /** Filter tests by string or regexp pattern */
-    grep: string | RegExp;
+    grep?: string | RegExp;
     /** Number of times to repeat scenarios of a Feature */
-    Feature: number;
+    Feature?: number;
     /** Number of times to repeat scenarios */
-    Scenario: number;
+    Scenario?: number;
     /** Number of times to repeat Before hook */
-    Before: number;
+    Before?: number;
     /** Number of times to repeat After hook */
-    After: number;
+    After?: number;
     /** Number of times to repeat BeforeSuite hook */
-    BeforeSuite: number;
+    BeforeSuite?: number;
     /** Number of times to repeat AfterSuite hook */
-    AfterSuite: number;
+    AfterSuite?: number;
   };
 
   type TimeoutConfig = {
@@ -67,6 +67,14 @@ declare namespace CodeceptJS {
      * ```
      */
     output: string;
+    /**
+     * empty output folder for next run
+     *
+     * ```js
+     * emptyOutputFolder: true
+     * ```
+     */
+    emptyOutputFolder?: boolean;
     /**
      * Pattern to filter tests by name.
      * This option is useful if you plan to use multiple configs for different environments.
@@ -341,6 +349,29 @@ declare namespace CodeceptJS {
       steps: string | Array<string>
     };
 
+    /**
+     * [AI](https://codecept.io/ai/) features configuration.
+     */
+    ai?: {
+      /** OpenAI model to use */
+      model?: string,
+      /** temperature, measure of randomness. Lower is better. */
+      temperature?: number,
+      /** configuration for processing HTML for GPT */
+      html?: {
+        /** max size of HTML to be sent to OpenAI to avoid token limit */
+        maxLength?: number,
+        /** should HTML be changed by removing non-interactive elements */
+        simplify?: boolean,
+        /** should HTML be minified before sending */
+        minify?: boolean,
+        interactiveElements?: Array<string>,
+        textElements?: Array<string>,
+        allowedAttrs?: Array<string>,
+        allowedRoles?: Array<string>,
+      }
+    },
+
     /**
      * Enable full promise-based helper methods for [TypeScript](https://codecept.io/typescript/) project.
      * If true, all helper methods are typed as asynchronous;
@@ -392,7 +423,7 @@ declare namespace CodeceptJS {
     | { ios: string }
     | { android: string; ios: string }
     | { react: string }
-    | { shadow: string }
+    | { shadow: string[] }
     | { custom: string };
 
   interface CustomLocators {}
@@ -489,6 +520,9 @@ declare const Background: CodeceptJS.IHook;
 declare const Before: CodeceptJS.IHook;
 declare const After: CodeceptJS.IHook;
 
+// Plugins
+declare const __: any
+
 interface Window {
   codeceptjs: typeof CodeceptJS.browserCodecept;
   resq: any;