codeceptjs 3.4.1 → 3.5.1-2.beta.7

package/README.md

@@ -2,15 +2,19 @@
 
 
 
-[<img src="https://img.shields.io/badge/slack-@codeceptjs-purple.svg?logo=slack">](https://join.slack.com/t/codeceptjs/shared_invite/enQtMzA5OTM4NDM2MzA4LWE4MThhN2NmYTgxNTU5MTc4YzAyYWMwY2JkMmZlYWI5MWQ2MDM5MmRmYzZmYmNiNmY5NTAzM2EwMGIwOTNhOGQ) [<img src="https://img.shields.io/badge/discourse-codeceptjs-purple">](https://codecept.discourse.group) [![NPM version][npm-image]][npm-url]
-[![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) 
+[<img src="https://img.shields.io/badge/slack-@codeceptjs-purple.svg?logo=slack">](https://join.slack.com/t/codeceptjs/shared_invite/enQtMzA5OTM4NDM2MzA4LWE4MThhN2NmYTgxNTU5MTc4YzAyYWMwY2JkMmZlYWI5MWQ2MDM5MmRmYzZmYmNiNmY5NTAzM2EwMGIwOTNhOGQ) [<img src="https://img.shields.io/badge/discourse-codeceptjs-purple">](https://codecept.discourse.group) [![NPM version][npm-image]][npm-url] [<img src="https://img.shields.io/badge/dockerhub-images-blue.svg?logo=codeceptjs">](https://hub.docker.com/r/codeceptjs/codeceptjs)
+[![AI features](https://img.shields.io/badge/AI-features?logo=openai&logoColor=white)](https://github.com/codeceptjs/CodeceptJS/edit/3.x/docs/ai.md) [![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) 
 
 Build Status:
 
+Appium Helper:
+[![Appium V2 Tests - Android](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appiumV2_Android.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appiumV2_Android.yml)
+[![Appium V2 Tests - iOS](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appiumV2_iOS.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appiumV2_iOS.yml)
+
+Web Helper:
 [![Playwright Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/playwright.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/playwright.yml)
 [![Puppeteer Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/puppeteer.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/puppeteer.yml)
 [![WebDriver Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/webdriver.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/webdriver.yml)
-[![Appium Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appium.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appium.yml)
 [![TestCafe Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/testcafe.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/testcafe.yml)
 
 # CodeceptJS [![Made in Ukraine](https://img.shields.io/badge/made_in-ukraine-ffd700.svg?labelColor=0057b7)](https://stand-with-ukraine.pp.ua)
@@ -20,7 +24,7 @@ Reference: [Helpers API](https://github.com/codeceptjs/CodeceptJS/tree/master/do
 ## Supercharged E2E Testing
 
 CodeceptJS is a new testing framework for end-to-end testing with WebDriver (or others).
-It abstracts browser interaction to simple steps that are written from a user perspective.
+It abstracts browser interaction to simple steps that are written from a user's perspective.
 A simple test that verifies the "Welcome" text is present on a main page of a site will look like:
 
 ```js
@@ -36,15 +40,14 @@ CodeceptJS tests are:
 
 * **Synchronous**. You don't need to care about callbacks or promises or test scenarios which are linear. But, your tests should be linear.
 * Written from **user's perspective**. Every action is a method of `I`. That makes test easy to read, write and maintain even for non-tech persons.
-* Backend **API agnostic**. We don't know which WebDriver implementation is running this test. We can easily switch from WebDriverIO to Protractor or PhantomJS.
+* Backend **API agnostic**. We don't know which WebDriver implementation is running this test.
 
-CodeceptJS uses **Helper** modules to provide actions to `I` object. Currently CodeceptJS has these helpers:
+CodeceptJS uses **Helper** modules to provide actions to `I` object. Currently, CodeceptJS has these helpers:
 
 * [**Playwright**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Playwright.md) - is a Node library to automate the Chromium, WebKit and Firefox browsers with a single API.
 * [**Puppeteer**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Puppeteer.md) - uses Google Chrome's Puppeteer for fast headless testing.
 * [**WebDriver**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/WebDriver.md) - uses [webdriverio](http://webdriver.io/) to run tests via WebDriver protocol.
 * [**TestCafe**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/TestCafe.md) - cheap and fast cross-browser test automation.
-* [**Nightmare**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Nightmare.md) - uses Electron and NightmareJS to run tests.
 * [**Appium**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Appium.md) - for **mobile testing** with Appium
 * [**Detox**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Detox.md) - This is a wrapper on top of Detox library, aimed to unify testing experience for CodeceptJS framework. Detox provides a grey box testing for mobile applications, playing especially well for React Native apps.
 
@@ -54,25 +57,27 @@ And more to come...
 
 CodeceptJS is a successor of [Codeception](http://codeception.com), a popular full-stack testing framework for PHP.
 With CodeceptJS your scenario-driven functional and acceptance tests will be as simple and clean as they can be.
-You don't need to worry about asynchronous nature of NodeJS or about various APIs of Selenium, Puppeteer, Protractor, TestCafe, etc. as CodeceptJS unifies them and makes them work as they are synchronous.
+You don't need to worry about asynchronous nature of NodeJS or about various APIs of Playwright, Selenium, Puppeteer, TestCafe, etc. as CodeceptJS unifies them and makes them work as they are synchronous.
 
-## Features
 
-* Based on [Mocha](https://mochajs.org/) testing framework.
-* Designed for scenario driven acceptance testing in BDD-style
-* Uses ES6 natively without transpiler.
+## Features
+ 
+* 🪄 **AI-powered** with GPT features to assist and heal failing tests.
+* ☕ Based on [Mocha](https://mochajs.org/) testing framework.
+* 💼 Designed for scenario driven acceptance testing in BDD-style.
+* 💻 Uses ES6 natively without transpiler.
 * Also plays nice with TypeScript.
-* Smart locators: use names, labels, matching text, CSS or XPath to locate elements.
-* Interactive debugging shell: pause test at any point and try different commands in a browser.
+* </> Smart locators: use names, labels, matching text, CSS or XPath to locate elements.
+* 🌐 Interactive debugging shell: pause test at any point and try different commands in a browser.
 * Easily create tests, pageobjects, stepobjects with CLI generators.
 
-## Install
+## Installation
 
 ```sh
 npm i codeceptjs --save
 ```
 
-Move to directory where you'd like to have your tests (and codeceptjs config) stored, and execute
+Move to directory where you'd like to have your tests (and CodeceptJS config) stored, and execute:
 
 ```sh
 npx codeceptjs init
@@ -126,8 +131,8 @@ Scenario('test some forms', ({ I }) => {
 });
 ```
 
-All actions are performed by I object; assertions functions start with `see` function.
-In this examples all methods of `I` are taken from WebDriver helper, see [reference](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/WebDriver.md) to learn how to use them.
+All actions are performed by `I` object; assertions functions start with `see` function.
+In these examples all methods of `I` are taken from WebDriver helper, see [reference](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/WebDriver.md) to learn how to use them.
 
 Let's execute this test with `run` command. Additional option `--steps` will show us the running process. We recommend use `--steps` or `--debug` during development.
 
@@ -193,17 +198,15 @@ In this case 'User is valid' string will be searched only inside elements locate
 ### Grabbers
 
 In case you need to return a value from a webpage and use it directly in test, you should use methods with `grab` prefix.
-They are expected to be used inside async/await functions, and their results will be available in test:
+They are expected to be used inside `async/await` functions, and their results will be available in test:
 
 ```js
-const assert = require('assert');
-
 Feature('CodeceptJS Demonstration');
 
 Scenario('test page title', async ({ I }) => {
   I.amOnPage('http://simple-form-bootstrap.plataformatec.com.br/documentation');
   const title = await I.grabTitle();
-  assert.equal(title, 'Example application with SimpleForm and Twitter Bootstrap');
+  I.expectEqual(title, 'Example application with SimpleForm and Twitter Bootstrap'); // Avaiable with Expect helper. -> https://codecept.io/helpers/Expect/
 });
 ```
 
@@ -294,35 +297,33 @@ Thanks all to those who are and will have contributing to this awesome project!
 
 [//]: contributor-faces
 <a href="https://github.com/DavertMik"><img src="https://avatars.githubusercontent.com/u/220264?v=4" title="DavertMik" width="80" height="80"></a>
-<a href="https://github.com/PeterNgTr"><img src="https://avatars.githubusercontent.com/u/7845001?v=4" title="PeterNgTr" width="80" height="80"></a>
+<a href="https://github.com/kobenguyent"><img src="https://avatars.githubusercontent.com/u/7845001?v=4" title="kobenguyent" width="80" height="80"></a>
 <a href="https://github.com/Vorobeyko"><img src="https://avatars.githubusercontent.com/u/11293201?v=4" title="Vorobeyko" width="80" height="80"></a>
 <a href="https://github.com/reubenmiller"><img src="https://avatars.githubusercontent.com/u/3029781?v=4" title="reubenmiller" width="80" height="80"></a>
 <a href="https://github.com/Arhell"><img src="https://avatars.githubusercontent.com/u/26163841?v=4" title="Arhell" width="80" height="80"></a>
 <a href="https://github.com/APshenkin"><img src="https://avatars.githubusercontent.com/u/14344430?v=4" title="APshenkin" width="80" height="80"></a>
 <a href="https://github.com/fabioel"><img src="https://avatars.githubusercontent.com/u/9824235?v=4" title="fabioel" width="80" height="80"></a>
 <a href="https://github.com/pablopaul"><img src="https://avatars.githubusercontent.com/u/635526?v=4" title="pablopaul" width="80" height="80"></a>
-<a href="https://github.com/Georgegriff"><img src="https://avatars.githubusercontent.com/u/9056958?v=4" title="Georgegriff" width="80" height="80"></a>
 <a href="https://github.com/mirao"><img src="https://avatars.githubusercontent.com/u/12584138?v=4" title="mirao" width="80" height="80"></a>
+<a href="https://github.com/Georgegriff"><img src="https://avatars.githubusercontent.com/u/9056958?v=4" title="Georgegriff" width="80" height="80"></a>
 <a href="https://github.com/KMKoushik"><img src="https://avatars.githubusercontent.com/u/24666922?v=4" title="KMKoushik" width="80" height="80"></a>
 <a href="https://github.com/nikocanvacom"><img src="https://avatars.githubusercontent.com/u/83254493?v=4" title="nikocanvacom" width="80" height="80"></a>
 <a href="https://github.com/elukoyanov"><img src="https://avatars.githubusercontent.com/u/11647141?v=4" title="elukoyanov" width="80" height="80"></a>
 <a href="https://github.com/gkushang"><img src="https://avatars.githubusercontent.com/u/3663389?v=4" title="gkushang" width="80" height="80"></a>
 <a href="https://github.com/tsuemura"><img src="https://avatars.githubusercontent.com/u/17092259?v=4" title="tsuemura" width="80" height="80"></a>
+<a href="https://github.com/EgorBodnar"><img src="https://avatars.githubusercontent.com/u/63167966?v=4" title="EgorBodnar" width="80" height="80"></a>
 <a href="https://github.com/VikalpP"><img src="https://avatars.githubusercontent.com/u/11846339?v=4" title="VikalpP" width="80" height="80"></a>
 <a href="https://github.com/BorisOsipov"><img src="https://avatars.githubusercontent.com/u/6514276?v=4" title="BorisOsipov" width="80" height="80"></a>
 <a href="https://github.com/elaichenkov"><img src="https://avatars.githubusercontent.com/u/29764053?v=4" title="elaichenkov" width="80" height="80"></a>
 <a href="https://github.com/nitschSB"><img src="https://avatars.githubusercontent.com/u/39341455?v=4" title="nitschSB" width="80" height="80"></a>
 <a href="https://github.com/hubidu"><img src="https://avatars.githubusercontent.com/u/13134082?v=4" title="hubidu" width="80" height="80"></a>
 <a href="https://github.com/jploskonka"><img src="https://avatars.githubusercontent.com/u/669483?v=4" title="jploskonka" width="80" height="80"></a>
+<a href="https://github.com/ngraf"><img src="https://avatars.githubusercontent.com/u/7094389?v=4" title="ngraf" width="80" height="80"></a>
 <a href="https://github.com/maojunxyz"><img src="https://avatars.githubusercontent.com/u/28778042?v=4" title="maojunxyz" width="80" height="80"></a>
 <a href="https://github.com/abhimanyupandian"><img src="https://avatars.githubusercontent.com/u/36107381?v=4" title="abhimanyupandian" width="80" height="80"></a>
 <a href="https://github.com/martomo"><img src="https://avatars.githubusercontent.com/u/1850135?v=4" title="martomo" width="80" height="80"></a>
-<a href="https://github.com/denis-sokolov"><img src="https://avatars.githubusercontent.com/u/113721?v=4" title="denis-sokolov" width="80" height="80"></a>
-<a href="https://github.com/lennym"><img src="https://avatars.githubusercontent.com/u/117398?v=4" title="lennym" width="80" height="80"></a>
-<a href="https://github.com/petehouston"><img src="https://avatars.githubusercontent.com/u/9006720?v=4" title="petehouston" width="80" height="80"></a>
-<a href="https://github.com/Holorium"><img src="https://avatars.githubusercontent.com/u/10815542?v=4" title="Holorium" width="80" height="80"></a>
-<a href="https://github.com/jancorvus"><img src="https://avatars.githubusercontent.com/u/67001310?v=4" title="jancorvus" width="80" height="80"></a>
-<a href="https://github.com/ngraf"><img src="https://avatars.githubusercontent.com/u/7094389?v=4" title="ngraf" width="80" height="80"></a>
+<a href="https://github.com/hatufacci"><img src="https://avatars.githubusercontent.com/u/4963181?v=4" title="hatufacci" width="80" height="80"></a>
+<a href="https://github.com/johnyb"><img src="https://avatars.githubusercontent.com/u/86358?v=4" title="johnyb" width="80" height="80"></a>
 
 [//]: contributor-faces
 

package/bin/codecept.js

@@ -130,7 +130,7 @@ program.command('run [test]')
   .option('--child <string>', 'option for child processes')
   .action(errorHandler(require('../lib/command/run')));
 
-program.command('run-workers <workers>')
+program.command('run-workers <workers> [selectedRuns...]')
   .description('Executes tests in workers')
   .option('-c, --config [file]', 'configuration file to be used')
   .option('-g, --grep <pattern>', 'only run tests matching <pattern>')

package/lib/actor.js

@@ -13,15 +13,18 @@ const output = require('./output');
  */
 class Actor {
   /**
-   * add print comment method`
+   * Print the comment on log. Also, adding a step in the `Test.steps` object
    * @param {string} msg
    * @param {string} color
    * @inner
    *
    * ⚠️ returns a promise which is synchronized internally by recorder
    */
-  say(msg, color = 'cyan') {
-    return recorder.add(`say ${msg}`, () => {
+  async say(msg, color = 'cyan') {
+    const step = new Step('say', 'say');
+    step.status = 'passed';
+    return recordStep(step, [msg]).then(() => {
+      // this is backward compatibility as this event may be used somewhere
       event.emit(event.step.comment, msg);
       output.say(msg, `${color}`);
     });

package/lib/ai.js

@@ -0,0 +1,180 @@
+const { Configuration, OpenAIApi } = require('openai');
+const debug = require('debug')('codeceptjs:ai');
+const config = require('./config');
+const output = require('./output');
+const { removeNonInteractiveElements, minifyHtml, splitByChunks } = require('./html');
+
+const defaultConfig = {
+  model: 'gpt-3.5-turbo-16k',
+  temperature: 0.1,
+};
+
+const htmlConfig = {
+  maxLength: 50000,
+  simplify: true,
+  minify: true,
+  html: {},
+};
+
+const aiInstance = null;
+
+class AiAssistant {
+  constructor() {
+    this.config = config.get('ai', defaultConfig);
+    this.htmlConfig = Object.assign(htmlConfig, this.config.html);
+    delete this.config.html;
+    this.html = null;
+    this.response = null;
+
+    this.isEnabled = !!process.env.OPENAI_API_KEY;
+
+    if (!this.isEnabled) {
+      debug('No OpenAI API key provided. AI assistant is disabled.');
+      return;
+    }
+
+    const configuration = new Configuration({
+      apiKey: process.env.OPENAI_API_KEY,
+    });
+
+    this.openai = new OpenAIApi(configuration);
+  }
+
+  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 = await minifyHtml(processedHTML);
+    if (this.htmlConfig.maxLength) processedHTML = splitByChunks(processedHTML, this.htmlConfig.maxLength)[0];
+
+    debug(processedHTML);
+
+    this.html = processedHTML;
+  }
+
+  getResponse() {
+    return this.response || '';
+  }
+
+  mockResponse(response) {
+    this.mockedResponse = response;
+  }
+
+  async createCompletion(messages) {
+    if (!this.openai) return;
+
+    debug(messages);
+
+    if (this.mockedResponse) return this.mockedResponse;
+
+    this.response = null;
+
+    try {
+      const completion = await this.openai.createChatCompletion({
+        ...this.config,
+        messages,
+      });
+
+      this.response = completion?.data?.choices[0]?.message?.content;
+
+      debug(this.response);
+
+      return this.response;
+    } catch (err) {
+      debug(err.response);
+      output.print('');
+      output.error(`OpenAI error: ${err.message}`);
+      output.error(err?.response?.data?.error?.code);
+      output.error(err?.response?.data?.error?.message);
+      return '';
+    }
+  }
+
+  async healFailedStep(step, err, test) {
+    if (!this.isEnabled) return [];
+    if (!this.html) throw new Error('No HTML context provided');
+
+    const messages = [
+      { role: 'user', content: 'As a test automation engineer I am testing web application using CodeceptJS.' },
+      { role: 'user', content: `I want to heal a test that fails. Here is the list of executed steps: ${test.steps.join(', ')}` },
+      { role: 'user', content: `Propose how to adjust ${step.toCode()} step to fix the test.` },
+      { role: 'user', content: 'Use locators in order of preference: semantic locator by text, CSS, XPath. Use codeblocks marked with ```.' },
+      { role: 'user', content: `Here is the error message: ${err.message}` },
+      { role: 'user', content: `Here is HTML code of a page where the failure has happened: \n\n${this.html}` },
+    ];
+
+    const response = await this.createCompletion(messages);
+    if (!response) return [];
+
+    return parseCodeBlocks(response);
+  }
+
+  async writeSteps(input) {
+    if (!this.isEnabled) return;
+    if (!this.html) throw new Error('No HTML context provided');
+
+    const snippets = [];
+
+    const messages = [
+      {
+        role: 'user',
+        content: `I am test engineer writing test in CodeceptJS
+          I have opened web page and I want to use CodeceptJS to ${input} on this page
+          Provide me valid CodeceptJS code to accomplish it
+          Use only locators from this HTML: \n\n${this.html}`,
+      },
+      { role: 'user', content: 'Propose only CodeceptJS steps code. Do not include Scenario or Feature into response' },
+
+      // old prompt
+      // { role: 'user', content: 'I want to click button Submit using CodeceptJS on this HTML page: <html><body><button>Submit</button></body></html>' },
+      // { role: 'assistant', content: '```js\nI.click("Submit");\n```' },
+      // { role: 'user', content: 'I want to click button Submit using CodeceptJS on this HTML page: <html><body><button>Login</button></body></html>' },
+      // { role: 'assistant', content: 'No suggestions' },
+      // { role: 'user', content: `Now I want to ${input} on this HTML page using CodeceptJS code` },
+      // { role: 'user', content: `Provide me with CodeceptJS code to achieve this on THIS page.` },
+    ];
+    const response = await this.createCompletion(messages);
+    if (!response) return;
+    snippets.push(...parseCodeBlocks(response));
+
+    debug(snippets[0]);
+
+    return snippets[0];
+  }
+}
+
+function parseCodeBlocks(response) {
+  // Regular expression pattern to match code snippets
+  const codeSnippetPattern = /```(?:javascript|js|typescript|ts)?\n([\s\S]+?)\n```/g;
+
+  // Array to store extracted code snippets
+  const codeSnippets = [];
+
+  response = response.split('\n').map(line => line.trim()).join('\n');
+
+  // Iterate over matches and extract code snippets
+  let match;
+  while ((match = codeSnippetPattern.exec(response)) !== null) {
+    codeSnippets.push(match[1]);
+  }
+
+  // Remove "Scenario", "Feature", and "require()" lines
+  const modifiedSnippets = codeSnippets.map(snippet => {
+    const lines = snippet.split('\n');
+
+    const filteredLines = lines.filter(line => !line.includes('I.amOnPage') && !line.startsWith('Scenario') && !line.startsWith('Feature') && !line.includes('= require('));
+
+    return filteredLines.join('\n');
+    // remove snippets that move from current url
+  }); // .filter(snippet => !line.includes('I.amOnPage'));
+
+  return modifiedSnippets.filter(snippet => !!snippet);
+}
+
+module.exports = AiAssistant;

package/lib/cli.js

@@ -81,6 +81,11 @@ class Cli extends Base {
       if (!codeceptjsEventDispatchersRegistered) {
         codeceptjsEventDispatchersRegistered = true;
 
+        event.dispatcher.on(event.bddStep.started, (step) => {
+          output.stepShift = 2;
+          output.step(step);
+        });
+
         event.dispatcher.on(event.step.started, (step) => {
           let processingStep = step;
           const metaSteps = [];
@@ -93,12 +98,17 @@ class Cli extends Base {
           for (let i = 0; i < Math.max(currentMetaStep.length, metaSteps.length); i++) {
             if (currentMetaStep[i] !== metaSteps[i]) {
               output.stepShift = 3 + 2 * i;
-              if (metaSteps[i]) output.step(metaSteps[i]);
+              if (!metaSteps[i]) continue;
+              // bdd steps are handled by bddStep.started
+              if (metaSteps[i].isBDD()) continue;
+              output.step(metaSteps[i]);
             }
           }
           currentMetaStep = metaSteps;
           output.stepShift = 3 + 2 * shift;
-          output.step(step);
+          if (step.helper.constructor.name !== 'ExpectHelper') {
+            output.step(step);
+          }
         });
 
         event.dispatcher.on(event.step.finished, () => {
@@ -168,7 +178,7 @@ class Cli extends Base {
         }
 
         // display artifacts in debug mode
-        if (test.artifacts && Object.keys(test.artifacts).length) {
+        if (test?.artifacts && Object.keys(test.artifacts).length) {
           log += `\n${output.styles.bold('Artifacts:')}`;
           for (const artifact of Object.keys(test.artifacts)) {
             log += `\n- ${artifact}: ${test.artifacts[artifact]}`;

package/lib/codecept.js

@@ -8,6 +8,7 @@ const Config = require('./config');
 const event = require('./event');
 const runHook = require('./hooks');
 const output = require('./output');
+const { emptyFolder } = require('./utils');
 
 /**
  * CodeceptJS runner
@@ -66,6 +67,8 @@ class Codecept {
     global.codecept_dir = dir;
     global.output_dir = fsPath.resolve(dir, this.config.output);
 
+    if (this.config.emptyOutputFolder) emptyFolder(global.output_dir);
+
     if (!this.config.noGlobals) {
       global.Helper = global.codecept_helper = require('@codeceptjs/helper');
       global.actor = global.codecept_actor = require('./actor');
@@ -86,6 +89,9 @@ class Codecept {
       global.When = stepDefinitions.When;
       global.Then = stepDefinitions.Then;
       global.DefineParameterType = stepDefinitions.defineParameterType;
+
+      // debug mode
+      global.debugMode = false;
     }
   }
 
@@ -158,6 +164,7 @@ class Codecept {
 
     for (pattern of patterns) {
       glob.sync(pattern, options).forEach((file) => {
+        if (file.includes('node_modules')) return;
         if (!fsPath.isAbsolute(file)) {
           file = fsPath.join(global.codecept_dir, file);
         }
@@ -172,6 +179,7 @@ class Codecept {
    * Run a specific test or all loaded tests.
    *
    * @param {string} [test]
+   * @returns {Promise<void>}
    */
   async run(test) {
     return new Promise((resolve, reject) => {

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/definitions.js

@@ -17,7 +17,6 @@ const actingHelpers = [...require('../plugin/standardActingHelpers'), 'REST'];
  * @param {Map} params.supportObject
  * @param {Array<string>} params.helperNames
  * @param {Array<string>} params.importPaths
- * @param {Array<string>} params.customHelpers
  * @param params.translations
  *
  * @returns {string}
@@ -29,15 +28,13 @@ const getDefinitionsFileContent = ({
   supportObject,
   importPaths,
   translations,
-  customHelpers,
 }) => {
   const getHelperListFragment = ({
     hasCustomHelper,
     hasCustomStepsFile,
-    customHelpers,
   }) => {
     if (hasCustomHelper && hasCustomStepsFile) {
-      return `${['ReturnType<steps_file>', ...customHelpers].join(', ')}`;
+      return `${['ReturnType<steps_file>', 'WithTranslation<Methods>'].join(', ')}`;
     }
 
     if (hasCustomStepsFile) {
@@ -50,7 +47,6 @@ const getDefinitionsFileContent = ({
   const helpersListFragment = getHelperListFragment({
     hasCustomHelper,
     hasCustomStepsFile,
-    customHelpers,
   });
 
   const importPathsFragment = importPaths.join('\n');
@@ -143,7 +139,7 @@ module.exports = function (genPath, options) {
     }
 
     if (!actingHelpers.includes(name)) {
-      customHelpers.push(`WithTranslation<${name}>`);
+      customHelpers.push(name);
     }
   }
 
@@ -186,7 +182,6 @@ module.exports = function (genPath, options) {
     translations,
     hasCustomStepsFile,
     hasCustomHelper,
-    customHelpers,
   });
 
   // add aliases for translations

package/lib/command/dryRun.js

@@ -7,6 +7,7 @@ const store = require('../store');
 const Container = require('../container');
 
 module.exports = async function (test, options) {
+  if (options.grep) process.env.grep = options.grep.toLowerCase();
   const configFile = options.config;
   let codecept;
 
@@ -19,7 +20,8 @@ module.exports = async function (test, options) {
   if (config.plugins) {
     // disable all plugins by default, they can be enabled with -p option
     for (const plugin in config.plugins) {
-      config.plugins[plugin].enabled = false;
+      // if `-p all` is passed, then enabling all plugins, otherwise plugins could be enabled by `-p customLocator,commentStep,tryTo`
+      config.plugins[plugin].enabled = options.plugins === 'all';
     }
   }
 
@@ -57,9 +59,16 @@ function printTests(files) {
 
   let numOfTests = 0;
   let numOfSuites = 0;
+  const filteredSuites = [];
 
   for (const suite of mocha.suite.suites) {
-    output.print(`${colors.white.bold(suite.title)} -- ${output.styles.log(suite.file || '')}`);
+    if (process.env.grep && suite.title.toLowerCase().includes(process.env.grep)) {
+      filteredSuites.push(suite);
+    }
+  }
+  const displayedSuites = process.env.grep ? filteredSuites : mocha.suite.suites;
+  for (const suite of displayedSuites) {
+    output.print(`${colors.white.bold(suite.title)} -- ${output.styles.log(suite.file || '')} -- ${suite.tests.length} tests`);
     numOfSuites++;
 
     for (const test of suite.tests) {

package/lib/command/generate.js

@@ -24,6 +24,7 @@ Scenario('test something', async ({ {{actor}} }) => {
 // generates empty test
 module.exports.test = function (genPath) {
   const testsPath = getTestRoot(genPath);
+  global.codecept_dir = testsPath;
   const config = getConfig(testsPath);
   if (!config) return;
 
@@ -83,6 +84,29 @@ module.exports = {
 }
 `;
 
+const poModuleTemplateTS = `const { I } = inject();
+
+export = {
+
+  // insert your locators and methods here
+}
+`;
+
+const poClassTemplate = `const { I } = inject();
+
+class {{name}} {
+  constructor() {
+    //insert your locators
+    // this.button = '#button'
+  }
+  // insert your methods here
+}
+
+// For inheritance
+module.exports = new {{name}}();
+export = {{name}};
+`;
+
 module.exports.pageObject = function (genPath, opts) {
   const testsPath = getTestRoot(genPath);
   const config = getConfig(testsPath);
@@ -110,7 +134,15 @@ module.exports.pageObject = function (genPath, opts) {
       name: 'filename',
       message: 'Where should it be stored',
       default: answers => `./${kind}s/${answers.name}.${extension}`,
-    }]).then((result) => {
+    },
+    {
+      type: 'list',
+      name: 'objectType',
+      message: 'What is your preferred object type',
+      choices: ['module', 'class'],
+      default: 'module',
+    },
+  ]).then((result) => {
     const pageObjectFile = path.join(testsPath, result.filename);
     const dir = path.dirname(pageObjectFile);
     if (!fileExists(dir)) fs.mkdirSync(dir);
@@ -124,13 +156,24 @@ module.exports.pageObject = function (genPath, opts) {
       }
       actor = `require('${actorPath}')`;
     }
-    if (!safeFileWrite(pageObjectFile, pageObjectTemplate.replace('{{actor}}', actor))) return;
+
     const name = lcfirst(result.name) + ucfirst(kind);
+    if (result.objectType === 'module' && extension === 'ts') {
+      if (!safeFileWrite(pageObjectFile, poModuleTemplateTS.replace('{{actor}}', actor))) return;
+    } else if (result.objectType === 'module' && extension === 'js') {
+      if (!safeFileWrite(pageObjectFile, pageObjectTemplate.replace('{{actor}}', actor))) return;
+    } else if (result.objectType === 'class') {
+      const content = poClassTemplate.replace(/{{actor}}/g, actor).replace(/{{name}}/g, name);
+      if (!safeFileWrite(pageObjectFile, content)) return;
+    }
+
     let data = readConfig(configFile);
     config.include[name] = result.filename;
+
+    if (!data) throw Error('Config file is empty');
     const currentInclude = `${data.match(/include:[\s\S][^\}]*/i)[0]}\n ${name}:${JSON.stringify(config.include[name])}`;
 
-    data = data.replace(/include:[\s\S][^\}]*/i, `${currentInclude}`);
+    data = data.replace(/include:[\s\S][^\}]*/i, `${currentInclude},`);
 
     fs.writeFileSync(configFile, beautify(data), 'utf-8');