codeceptjs - npm Package Versions

3.5.1

🛩️ Features

• [Puppeteer][WebDriver][TestCafe] Added methods by @KobeNguyenT in #3737
  • blur
  • focus
• Improved BDD output to print steps without I. commands` by @davertmik #3739
• Improved codecept init setup for Electron tests by @KobeNguyenT. See #3733

🐛 Bug Fixes

• Fixed serializing of custom errors making tests stuck. Fix #3739 by @davertmik.

📖 Documentation

• Fixed Playwright docs by @Horsty80
• Fixed ai docs by @ngraf
• Various fixes by @KobeNguyenT

3.5.0

🛩️ Features

• 🪄 AI Powered Test Automation - use OpenAI as a copilot for test automation. #3713 By @davertmik

  • AI guide added
  • added support for OpenAI in pause()
  • added heal plugin for self-healing tests
  • added OpenAI helper

• [Playwright][Puppeteer][WebDriver] Highlight the interacting elements in debug mode or with highlightElement option set (#3672) - by @KobeNguyenT

• [Playwright] Support for APIs in Playwright (#3665) - by Egor Bodnar

  • clearField replaced to use new Playwright API
  • blur added
  • focus added

• Added support for multiple browsers in run-workers (#3606) by @karanshah-browserstack :

Multiple browsers configured as profiles:

exports.config = {
  helpers: {
    WebDriver: {
      url: 'http://localhost:3000',
    }
  },
  multiple: {
    profile1: {
      browsers: [
        {
          browser: "firefox",
        },
        {
          browser: "chrome",
        }
      ]
    }, 

And executed via run-workers with all argument

npx codeceptjs run-workers 2 all

• [Appium] Add Appium v2 support (#3622) - by @KobeNguyenT
• Improve gpo command to create page objects as modules or as classes (#3625) - by @KobeNguyenT
• Added emptyOutputFolder config to clean up output before running tests (#3604) - by @KobeNguyenT
• Add secret() function support to append() and type() (#3615) - by @anils92
• [Playwright] Add bypassCSP option to helper's config (#3641) - by @KobeNguyenT
• Print number of tests for each suite in dryRun (#3620) - by @KobeNguyenT

🐛 Bug Fixes

• Support --grep in dry-run command (#3673) - by @KobeNguyenT
• Fix typings improvements in playwright (#3650) - by @KobeNguyenT
• Fixed global retry #3667 by @KobeNguyenT
• Fixed creating JavaScript test using "codeceptjs gt" (#3611) - by Jaromir Obr

3.4.1

• Updated mocha to v 10.2. Fixes #3591
• Fixes executing a faling Before hook. Resolves #3592

3.4.0

• Updated to latest mocha and modern Cucumber
• Allure plugin moved to @codeceptjs/allure-legacy package. This happened because allure-commons package v1 was not updated and caused vulnarabilities. Fixes #3422. We don't plan to maintain allure v2 plugin so it's up to community to take this initiative. Current allure plugin will print a warning message without interfering the run, so it won't accidentally fail your builds.
• Added ability to retry Before, BeforeSuite, After, AfterSuite hooks by @davertmik:

Feature('flaky Before & BeforeSuite', { retryBefore: 2, retryBeforeSuite: 3 })

• Flexible retries configuration introduced by @davertmik:

retry: [
  {
    // enable this config only for flaky tests
    grep: '@flaky', 
    Before: 3 // retry Before 3 times
    Scenario: 3 // retry Scenario 3 times
  }, 
  {
    // retry less when running slow tests
    grep: '@slow' 
    Scenario: 1
    Before: 1
  }, {
    // retry all BeforeSuite 3 times
    BeforeSuite: 3
  }
]

• Flexible timeout configuration introduced by @davertmik:

timeout: [
  10, // default timeout is 10secs  
  {   // but increase timeout for slow tests
    grep: '@slow',
    Feature: 50
  },
]

• JsDoc: Removed promise from I.say. See #3535 by @danielrentz
• [Playwright] handleDownloads requires now a filename param. See #3511 by @PeterNgTr
• [WebDriver] Added support for v8, removed support for webdriverio v5 and lower. See #3578 by @PeterNgTr

3.3.7

🛩️ Features

• Promise-based typings for TypeScript definitions in #3465 by @nlespiaucq. If you use TypeScript or use linters check how it may be useful to you.
• Translation improved to use custom vocabulary.
• [Playwright] Added methods in #3398 by @mirao
  • restartBrowser - to restart a browser (with different config)
  • _createContextPage - to create a new browser context with a page from a helper
• Added Cucumber custom types for BDD in #3435 by @Likstern
• Propose using JSONResponse helper when initializing project for API testing. #3455 by @PeterNgTr
• When translation enabled, generate tests using localized aliases. By @davertmik
• [Appium] Added checkIfAppIsInstalled in #3507 by @PeterNgTr

🐛 Bugfixes

• Fixed #3462 TypeError: Cannot read properties of undefined (reading 'setStatus') by @dwentland24 in #3438
• Fixed creating steps file for TypeScript setup #3459 by @PeterNgTr
• Fixed issue of after all event in run-rerun command after complete execution #3464 by @jain-neeeraj
• [Playwright][WebDriver][Appium] Do not change waitForTimeout value on validation. See #3478 by @pmajewski24. Fixes #2589
• [Playwright][WebDriver][Protractor][Puppeteer][TestCafe] Fixes Element "{null: undefined}" was not found and element ([object Object]) still not present messages when using object locators. See #3501 and #3502 by @pmajewski24
• [Playwright] Improved file names when downloading file in #3449 by @PeterNgTr. Fixes #3412 and #3409
• Add default value to profile env variable. See #3443 by @dwentland24. Resolves #3339
• [Playwright] Using system-native path separator when saving artifacts in #3460 by @PeterNgTr
• [Playwright] Saving videos and traces from multiple sessions in #3505 by @davertmik
• [Playwright] Fixed amOnPage to navigate to about:blank by @zaxoavoki in #3470 Fixes #2311
• Various typing improvements by @AWolf81 @PeterNgTr @mirao

📖 Documentation

• Updated Quickstart with detailed explanation of questions in init
• Added Translation guide
• Updated TypeScript guide for promise-based typings
• Reordered guides list on a website

3.3.6

• run-rerun command was re-introduced by @dwentland24 in #3436. Use it to perform run multiple times and detect flaky tests
• Enabled retryFailedStep by default in @codeceptjs/configure v 0.10. See https://github.com/codeceptjs/configure/pull/26
• [Playwright] Fixed properties types "waitForNavigation" and "firefox" by @mirao in #3401
• [REST] Changed "endpoint" to optional by @mirao in #3404
• [REST] Use secret for form encoded string by @PeterNgTr:

const secretData = secret('name=john&password=123456');
const response = await I.sendPostRequest('/user', secretData);

• [Playwright]Fixed docs related to fixed properties types "waitForNavigation" and "firefox" by @mirao in #3407
• [Playwright]Fixed parameters of startActivity() by @mirao in #3408
• Move semver to prod dependencies by @timja in #3413
• check if browser is W3C instead of Android by @mikk150 in #3414
• Pass service configs with options and caps as array for browsers… by @07souravkunda in #3418
• fix for type of "webdriver.port" by @ngraf in #3421
• fix for type of "webdriver.smartWait" by @pmajewski24 in #3426
• fix(datatable): mask secret text by @PeterNgTr in #3432
• fix(playwright) - video name and missing type by @PeterNgTr in #3430
• fix for expected type of "bootstrap", "teardown", "bootstrapAll" and "teardownAll" by @ngraf in #3424
• Improve generate pageobject gpo command to work with TypeScript by @PeterNgTr in #3411
• Fixed dry-run to always return 0 code and exit
• Added minimal version notice for NodeJS >= 12
• fix(utils): remove . of test title to avoid confusion by @PeterNgTr in #3431

3.3.5

🛩️ Features

• Added TypeScript types for CodeceptJS config.

Update codecept.conf.js to get intellisense when writing config file:

/**@type {CodeceptJS.MainConfig}**/
exports.config = {
  //...
}

• Added TS types for helpers config:
  • Playwright
  • Puppeteer
  • WebDriver
  • REST
• Added TypeScript option for installation via codeceptjs init to initialize new projects in TS (by @PeterNgTr and @davertmik)
• Includes node-ts automatically when using TypeScript setup.

🐛 Bugfixes

• [Puppeteer] Fixed support for Puppeteer > 14.4 by @PeterNgTr
• Don't report files as existing when non-directory is in path by @jonathanperret. See #3374
• Fixed TS type for secret function by @PeterNgTr
• Fixed wrong order for async MetaSteps by @dwentland24. See #3393
• Fixed same param substitution in BDD step. See #3385 by @snehabhandge

📖 Documentation

• Updated configuration options to match TypeScript types
• Updated TypeScript documentation on simplifying TS installation
• Added codecept-tesults plugin documentation by @ajeetd