Features:
- Official Docker image for CodeceptJS v3. New Docker image is based on official Playwright image and supports Playwright, Puppeteer, WebDriver engines. Thanks @VikentyShevyrin
- Better support for Typescript
codecept.conf.ts
configuration files. See #2750 by @elaichenkov - Propagate more events for custom parallel script. See #2796 by @jccguimaraes
- [mocha-junit-reporter] Now supports attachments, see documentation for details. See #2675 by @Shard
- CustomLocators interface for TypeScript to extend from LocatorOrString. See #2798 by @danielrentz
- [REST] Mask sensitive data from log messages.
I.sendPatchRequest('/api/users.json', secret({ "email": "user@user.com" }));
See #2786 by @PeterNgTr
Bug fixes:
- Fixed reporting of nested steps with PageObjects and BDD scenarios. See #2800 by @davertmik. Fixes #2720 #2682
- Fixed issue with
codeceptjs shell
which was broken since 3.0.0. See #2743 by @stedman - [Gherkin] Fixed issue suppressed or hidden errors in tests. See #2745 by @ktryniszewski-mdsol
- [Playwright] fix grabCssPropertyFromAll serialization by using property names. See #2757 by @elaichenkov
- [Allure] fix report for multi sessions. See #2771 by @cbayer97
- [WebDriver] Fix locator object debug log messages in smart wait. See 2748 by @elaichenkov
Documentation fixes:
- Fixed some broken examples. See #2756 by @danielrentz
- Fixed Typescript typings. See #2747, #2758 and #2769 by @elaichenkov
- Added missing type for xFeature. See #2754 by @PeterNgTr
- Fixed code example in Page Object documentation. See #2793 by @mkrtchian
Library updates:
- Updated Axios to 0.21.1. See by @sseide
- Updated @pollyjs/core @pollyjs/adapter-puppeteer. See #2760 by @Anikethana
- Hotfix Fixed
init
script by addingcross-spawn
package. By @vipulgupta2048 - Fixed handling error during initialization of
run-multiple
. See #2730 by @wagoid
- Playwright 1.7 support
- [Playwright] Fixed handling null context in click. See #2667 by @matthewjf
- [Playwright] Fixed
Cannot read property '$$' of null
when locating elements. See #2713 by @matthewjf - Command
npx codeceptjs init
improved- auto-installing required packages
- better error messages
- fixed generating type definitions
- Data Driven Tests improvements: instead of having one skipped test for data driven scenarios when using xData you get a skipped test for each entry in the data table. See #2698 by @Georgegriff
- [Puppeteer] Fixed that
waitForFunction
was not working with number values. See #2703 by @MumblesNZ - Enabled autocompletion for custom helpers. #2695 by @PeterNgTr
- Emit test.after on workers. Fix #2693 by @jccguimaraes
- TypeScript: Allow .ts config files. See #2708 by @elukoyanov
- Fixed definitions generation errors by @elukoyanov. See #2707 and #2718
- Fixed handing error in _after function; for example, browser is closed during test and tests executions is stopped, but error was not logged. See #2715 by @elukoyanov
- Emit hook.failed in workers. Fix #2723 by @jccguimaraes
- [wdio plugin] Added
seleniumArgs
andseleniumInstallArgs
config options for plugin. See #2687 by @andrerleao - [allure plugin] Added
addParameter
method in #2717 by @jancorvus. Fixes #2716 - Added mocha-based
--reporter-options
and--reporter <name>
commands torun-workers
command by in #2691 @Ameterezu - Fixed infinite loop for junit reports. See #2691 @Ameterezu
- Added status, start/end time, and match line for BDD steps. See #2678 by @ktryniszewski-mdsol
- [stepByStepReport plugin] Fixed "helper.saveScreenshot is not a function". Fix #2688 by @andrerleao
- [Playwright] Fix connection close with remote browser. See #2629 by @dipiash
- [REST] set maxUploadFileSize when performing api calls. See #2611 by @PeterNgTr
- Duplicate Scenario names (combined with Feature name) are now detected via a warning message.
Duplicate test names can cause
codeceptjs run-workers
to not function. See #2656 by @Georgegriff - Documentation fixes
Bug Fixes:
- --suites flag now should function correctly for
codeceptjs run-workers
. See #2655 by @Georgegriff - [autoLogin plugin] Login methods should now function as expected with
codeceptjs run-workers
. See #2658 by @Georgegriff, resolves #2620
♨️ Hot fix:
- Lock the mocha version to avoid the errors. See #2624 by PeterNgTr
🐛 Bug Fix:
-
Fixed error handling in Scenario.js. See #2607 by haveac1gar
-
Changing type definition in order to allow the use of functions with any number of any arguments. See #2616 by akoltun
-
Some updates/changes on documentations
- Playwright set to be a default engine.
- NodeJS 12+ required
- BREAKING CHANGE: Syntax for tests has changed.
// Previous
Scenario('title', (I, loginPage) => {});
// Current
Scenario('title', ({ I, loginPage }) => {});
- BREAKING Replaced bootstrap/teardown scripts to accept only functions or async functions. Async function with callback (with done parameter) should be replaced with async/await. See our upgrde guide.
- TypeScript guide and boilerplate project
- tryTo and pauseOnFail plugins installed by default
- Introduced one-line installer:
npx create-codeceptjs .
Read changelog to learn more about version 👇
- Moved Helper class into its own package to simplify publishing standalone helpers.
- Fixed typings for
I.say
andI.retry
by @Vorobeyko - Updated documentation:
🐛 Bug Fix:
- PageObject was broken when using "this" inside a simple object.
- The typings for all WebDriver methods work correctly.
- The typings for "this.helper" and helper constructor work correctly, too.
🧤 Internal:
- Our TS Typings will be tested now! We strarted using dtslint to check all typings and all rules for linter. Example:
const psp = wd.grabPageScrollPosition() // $ExpectType Promise<PageScrollPosition>
psp.then(
result => {
result.x // $ExpectType number
result.y // $ExpectType number
}
)
- And last: Reducing package size from 3.3Mb to 2.0Mb
- BREAKING Replaced bootstrap/teardown scripts to accept only functions or async functions. Async function with callback (with done parameter) should be replaced with async/await. See our upgrde guide.
- Test artifacts introduced. Each test object has
artifacts
property, to keep attachment files. For instance, a screenshot of a failed test is attached to a test as artifact. - Improved output for test execution
- Changed colors for steps output, simplified
- Added stack trace for test failures
- Removed
Event emitted
from log in--verbose
mode - List artifacts of a failed tests
- Steps & metasteps refactored by @Vorobeyko. Logs to arguments passed to page objects:
// TEST:
MyPage.hasFiles('first arg', 'second arg');
// OUTPUT:
MyPage: hasFile "First arg", "Second arg"
I see file "codecept.json"
I see file "codecept.po.json"
- Introduced official TypeScript boilerplate. Started by @Vorobeyko.
- NodeJS 12+ required
- BREAKING CHANGE: Syntax for tests has changed.
// Previous
Scenario('title', (I, loginPage) => {});
// Current
Scenario('title', ({ I, loginPage }) => {});
-
BREAKING CHANGE: [WebDriver][Protractor][Puppeteer][Playwright][Nightmare]
grab*
functions unified:grab*From
=> returns single value from element or throws error when no matchng elements foundgrab*FromAll
=> returns array of values, or empty array when no matching elements
-
Public API for workers introduced by @koushikmohan1996. Customize parallel execution with workers by building custom scripts.
-
[Playwright] Added
usePlaywrightTo
method to access Playwright API in tests directly:
I.usePlaywrightTo('do something special', async ({ page }) => {
// use page or browser objects here
});
- [Puppeteer] Introduced
usePuppeteerTo
method to access Puppeteer API:
I.usePuppeteerTo('do something special', async ({ page, browser }) => {
// use page or browser objects here
});
- [WebDriver] Introduced
useWebDriverTo
method to access webdriverio API:
I.useWebDriverTo('do something special', async ({ browser }) => {
// use browser object here
});
- [Protractor] Introduced
useProtractorTo
method to access protractor API tryTo
plugin introduced. Allows conditional action execution:
const isSeen = await tryTo(() => {
I.see('Some text');
});
// we are not sure if cookie bar is displayed, but if so - accept cookies
tryTo(() => I.click('Accept', '.cookies'));
- Possible breaking change In semantic locators
[
char indicates CSS selector.
- [Playwright] Playwright 1.4 compatibility
- [Playwright] Added
ignoreHTTPSErrors
config option (default: false). See #2566 by gurjeetbains - Added French translation by @vimar
- [WebDriver] Updated
dragSlider
to work in WebDriver W3C protocol. Fixes #2557 by suniljaiswal01
- Fixed saving options for suite via
Feature('title', {key: value})
by @Diokuz. See #2553 and Docs
- [Puppeteer][Playwright] SessionStorage is now cleared in after hook. See #2524
- When helper load failed the error stack is now logged by @SkReD. See #2541
- Small documentation fixes.
- [WebDriver][Protractor][Playwright][Puppeteer][Nightmare]
saveElementScreenshot
method added to make screenshot of an element. By @suniljaiswal01 - [Playwright][Puppeteer] Added
type
method to type a text using keyboard with an optional delay. - [WebDriver] Added optional
delay
argument totype
method to slow down typing. - [Puppeteer] Fixed
amOnPage
freeze whengetPageTimeout
is 0"; set 30 sec as default timeout by @Vorobeyko. - Fixed printing step with null argument in custom helper by @sjana-aj. See #2494
- Fix missing screenshot on failure when REST helper is in use #2513 by @PeterNgTr
- Improve error logging in the
screenshotOnFail
plugin #2512 by @pablopaul
- Add REST helper into
standardActingHelpers
array #2474 by @PeterNgTr - Add missing
--invert
option forrun-workers
command #2504 by @pablopaul - [WebDriver] Introduce
forceRightClick
method #2485 bylsuniljaiswal01 - [Playwright] Fix
setCookie
method #2491 by @bmbarker90 - [TypeScript] Update compilerOptions.target to es2017 #2483 by @shanplourde
- [Mocha] Honor reporter configuration #2465 by @trinhpham
- Puppeteer 4.0 support. Important: MockRequest helper won't work with Puppeter > 3.3
- Added
xFeature
andFeature.skip
to skip all tests in a suite. By @Georgegriff - [Appium] Fixed #2428 Android native locator support by @idxn
- [WebDriver] Fixed
waitNumberOfVisibleElements
to actually filter visible elements. By @ilangv - [Puppeteer] Fixed handling error which is not an Error object. Fixes
cannot read property indexOf of undefined
error. Fix #2436 by @Georgegriff - [Puppeteer] Print error on page crash by @Georgegriff
- Added
test.skipped
event to run-workers, fixing allure reports with skipped tests in workers #2391. Fix #2387 by @koushikmohan1996 - [Playwright] Fixed calling
waitFor*
methods with custom locators #2314. Fix #2389 by @Georgegriff
- [Playwright] Playwright 1.0 support by @Georgegriff.
- [stepByStepReport plugin] Fixed when using plugin with BeforeSuite. Fixes #2337 by @mirao
- [allure plugin] Fixed reporting of tests skipped by failure in before hook. Refer to #2349 & #2354. Fix by @koushikmohan1996
- [WebDriver][Puppeteer] Added
forceClick
method to emulate click event instead of using native events. - [Playwright] Updated to 0.14
- [Puppeteer] Updated to Puppeteer v3.0
- [wdio] Fixed undefined output directory for wdio plugns. Fix By @PeterNgTr
- [Playwright] Introduced
handleDownloads
method to download file. Please note, this method has slightly different API than the same one in Puppeteer. - [allure] Fixed undefined output directory for allure plugin on using custom runner. Fix by @charliepradeep
- [WebDriver] Fixed
waitForEnabled
fix for webdriver 6. Fix by @dsharapkou - Workers: Fixed negative failure result if use scenario with the same names. Fix by @Vorobeyko
- [MockRequest] Updated documentation to match new helper version
- Fixed: skipped tests are not reported if a suite failed in
before
. Refer #2349 & #2354. Fix by @koushikmohan1996
- [screenshotOnFail plugin] Fixed saving screenshot of active session.
- [screenshotOnFail plugin] Fix issue #2301 when having the flag
uniqueScreenshotNames
=true results inundefined
in screenshot file name by @PeterNgTr - [WebDriver] Fixed
waitForElement
not applying the optional second argument to override the default timeout in webdriverio 6. Fix by @Mooksc - [WebDriver] Updated
waitUntil
method which is used by all of the wait* functions. This updates thewaitForElement
by the same convention used to updatewaitForVisible
andwaitInUrl
to be compatible with both WebDriverIO v5 & v6. See #2313 by @Mooksc
- [Playwright] Updated to Playwright 0.12 by @Georgegriff.
Upgrade playwright to ^0.12:
npm i playwright@^0.12 --save
- Fixed opening two browsers on start
executeScript
- passed function now accepts only one argument. Pass in objects or arrays if you need multtple arguments:
// Old style, does not work anymore:
I.executeScript((x, y) => x + y, x, y);
// New style, passing an object:
I.executeScript(({x, y}) => x + y, {x, y});
click
- automatically waits for element to become clickable (visible, not animated) and waits for navigation.clickLink
- deprecatedwaitForClickable
- deprecatedforceClick
- added- Added support for custom locators. See #2277
- Introduced device emulation:
- globally via
emulate
config option - per session
- globally via
[WebDriver] Updated to webdriverio v6 by @PeterNgTr.
Read release notes, then upgrade webdriverio to ^6.0:
npm i webdriverio@^6.0 --save
(webdriverio v5 support is deprecated and will be removed in CodeceptJS 3.0)
[WebDriver] Introduced Shadow DOM support by @gkushang
I.click({ shadow: ['my-app', 'recipe-hello', 'button'] });
- Fixed parallel execution of
run-workers
for Gherkin scenarios by @koushikmohan1996 - [MockRequest] Updated and moved to standalone package:
- full support for record/replay mode for Puppeteer
- added
mockServer
method to use flexible PollyJS API to define mocks - fixed stale browser screen in record mode.
- [Playwright] Added support on for
screenshotOnFail
plugin by @amonkc - Gherkin improvement: setting different tags per examples. See #2208 by @acuper
- [TestCafe] Updated
click
to take first visible element. Fixes #2226 by @theTainted - [Puppeteer][WebDriver] Updated
waitForClickable
method to check for element overlapping. See #2261 by @PiQx - [Puppeteer] Dropped
puppeteer-firefox
support, as Puppeteer supports Firefox natively. - [REST] Rrespect Content-Type header. See #2262 by @pmarshall-legacy
- [allure plugin] Fixes BeforeSuite failures in allure reports. See #2248 by @Georgegriff
- [WebDriver][Puppeteer][Playwright] A screenshot of for an active session is saved in multi-session mode. See #2253 by @ChexWarrior
- Fixed
--profile
option by @pablopaul. Profile value to be passed intorun-multiple
andrun-workers
:
npx codecept run-workers 2 --profile firefox
Value is available at process.env.profile
(previously process.profile
). See #2302. Fixes #1968 #1315
- commentStep Plugin introduced. Allows to annotate logical parts of a test:
__`Given`;
I.amOnPage('/profile')
__`When`;
I.click('Logout');
__`Then`;
I.see('You are logged out');
- Experimental: Playwright helper introduced.
Playwright is an alternative to Puppeteer which works very similarly to it but adds cross-browser support with Firefox and Webkit. Until v1.0 Playwright API is not stable but we introduce it to CodeceptJS so you could try it.
- [Puppeteer] Fixed basic auth support when running in multiple sessions. See #2178 by @ian-bartholomew
- [Puppeteer] Fixed
waitForText
when there is nobody
element on page (redirect). See #2181 by @Vorobeyko - [Selenoid plugin] Fixed overriding current capabilities by adding deepMerge. Fixes #2183 by @koushikmohan1996
- Added types for
Scenario.todo
by @Vorobeyko - Added types for Mocha by @Vorobeyko. Fixed typing conflicts with Jest
- [FileSystem] Added methods by @nitschSB
waitForFile
seeFileContentsEqualReferenceFile
- Added
--colors
option torun
andrun-multiple
so you force colored output in dockerized environment. See #2189 by @mirao - [WebDriver] Added
type
command to enter value without focusing on a field. See #2198 by @xMutaGenx - Fixed
codeceptjs gt
command to respect config pattern for tests. See #2200 and #2204 by @matheo
- Hotfix for interactive pause
- Interactive pause improvements by @koushikmohan1996
- allows using in page objects and variables:
pause({ loginPage, a })
- enables custom commands inside pause with
=>
prefix:=> loginPage.open()
- allows using in page objects and variables:
- Selenoid plugin added by by @koushikmohan1996
- uses Selenoid to launch browsers inside Docker containers
- automatically records videos and attaches them to allure reports
- can delete videos for successful tests
- can automatically pull in and start Selenoid containers
- works with WebDriver helper
- Avoid failiure report on successful retry in worker by @koushikmohan1996
- Added translation ability to Scenario, Feature and other context methods by @koushikmohan1996
- 📢 Please help us translate context methods to your language! See italian translation as an example and send patches to vocabularies.
- allurePlugin: Added
say
comments to allure reports by @PeterNgTr. - Fixed no custom output folder created when executed with run-worker. Fix by @PeterNgTr
- [Puppeteer] Fixed error description for context element not found. See #2065. Fix by @PeterNgTr
- [WebDriver] Fixed
waitForClickable
to wait for exact number of seconds by @mirao. Resolves #2166 - Fixed setting
compilerOptions
injsconfig.json
file on init by @PeterNgTr - [Filesystem] Added method by @nitschSB
seeFileContentsEqualReferenceFile
waitForFile
- [Hotfix] - Add missing lib that prevents codeceptjs from initializing.
- Improved setup wizard with
npx codecept init
:- enabled retryFailedStep plugin for new setups.
- enabled @codeceptjs/configure to toggle headless/window mode via env variable
- creates a new test on init
- removed question on "steps file", create it by default.
- Added pauseOnFail plugin. Sponsored by Paul Vincent Beigang and his book "Practical End 2 End Testing with CodeceptJS".
- Added
run-rerun
command to run tests multiple times to detect and fix flaky tests. By @Ilrilan and @Vorobeyko. - Added
Scenario.todo()
to declare tests as pending. See #2100 by @Vorobeyko - Added support for absolute path for
output
dir. See #2049 by @elukoyanov - Fixed error in
npx codecept init
caused by callingconsole.print
. See #2071 by @Atinux. - [Filesystem] Methods added by @aefluke:
seeFileNameMatching
grabFileNames
- [Puppeteer] Fixed grabbing attributes with hyphen by @Holorium
- [TestCafe] Fixed
grabAttributeFrom
method by @elukoyanov - [MockRequest] Added support for Polly config options by @ecrmnn
- [TestCafe] Fixes exiting with zero code on failure. Fixed #2090 with #2106 by @koushikmohan1996
- [WebDriver][Puppeteer] Added basicAuth support via config. Example:
basicAuth: {username: 'username', password: 'password'}
. See #1962 by @PeterNgTr - [WebDriver][Appium] Added
scrollIntoView
by @pablopaul - Fixed #2118: No error stack trace for syntax error by @senthillkumar
- Added
parse()
method to data table inside Cucumber tests. Use it to obtain rows and hashes for test data. See #2082 by @Sraime
- Create better Typescript definition file through JSDoc. By @lemnis
run-workers
now can use glob pattern. By @Ilrilan
// Example:
exports.config = {
tests: '{./workers/base_test.workers.js,./workers/test_grep.workers.js}',
}
- Added new command
npx codeceptjs info
which print information about your environment and CodeceptJS configs. By @jamesgeorge007 - Fixed some typos in documantation. By @pablopaul @atomicpages @EricTendian
- Added PULL_REQUEST template.
- [Puppeteer][WebDriver] Added
waitForClickable
for waiting clickable element on page. - [TestCafe] Added support for remote connection. By @jvdieten
- [Puppeteer] Fixed
waitForText
XPath context now works correctly. By @Heavik - [TestCafe] Fixed
clearField
clear field now awaits TestCafe's promise. By @orihomie - [Puppeteer] Fixed fails when executing localStorage on services pages. See #2026
- Fixed empty tags in test name. See #2038
- Set "parse-function" dependency to "5.2.11" to avoid further installation errors.
- Fixed installation error "Cannot find module '@babel/runtime/helpers/interopRequireDefault'". The issue came from
parse-function
package. Fixed by @pablopaul. - [Puppeteer] Fixed switching to iframe without an ID by @johnyb. See #1974
- Added
--profile
option torun-workers
by @orihomie - Added a tag definition to
FeatureConfig
andScenarioConfig
by @sseliverstov
- customLocator plugin introduced. Adds a locator strategy for special test attributes on elements.
// when data-test-id is a special test attribute
// enable and configure plugin to replace this
I.click({ css: '[data-test-id=register_button]');
// with this
I.click('$register_button');
- [Puppeteer][WebDriver]
pressKey
improvements by @martomo: Changed pressKey method to resolve issues and extend functionality.- Did not properly recognize 'Meta' (or 'Command') as modifier key.
- Right modifier keys did not work in WebDriver using JsonWireProtocol.
- 'Shift' + 'key' combination would not reflect actual keyboard behavior.
- Respect sequence with multiple modifier keys passed to pressKey.
- Added support to automatic change operation modifier key based on operating system.
- [Puppeteer][WebDriver] Added
pressKeyUp
andpressKeyDown
to press and release modifier keys likeControl
orShift
. By @martomo. - [Puppeteer][WebDriver] Added
grabElementBoundingRect
by @PeterNgTr. - [Puppeteer] Fixed speed degradation introduced in #1306 with accessibility locators support. See #1953.
- Added
Config.addHook
to add a function that will update configuration on load. - Started
@codeceptjs/configure
package with a collection of common configuration patterns. - [TestCafe] port's management removed (left on TestCafe itself) by @orihomie. Fixes #1934.
- [REST] Headers are no more declared as singleton variable. Fixes #1959
- Updated Docker image to include run tests in workers with
NUMBER_OF_WORKERS
env variable. By @PeterNgTr.
- [Puppeteer] Fixed Puppeteer 1.20 support by @davertmik
- Fixed
run-workers
to run with complex configs. See #1887 by @nitschSB - Added
--suites
option torun-workers
to split suites by workers (tests of the same suite goes to teh same worker). Thanks @nitschSB. - Added a guide on Email Testing.
- [retryFailedStepPlugin] Improved to ignore wait* steps and others. Also added option to ignore this plugin per test bases. See updated documentation. By @davertmik
- Fixed using PageObjects as classes by @Vorobeyko. See #1896
- [WebDriver] Fixed opening more than one tab. See #1875 by @jplegoff. Fixes #1874
- Fixed #1891 when
I.retry()
affected retries of next steps. By @davertmik
- [MockRequest] Polly helper was renamed to MockRequest.
- [MockRequest][WebDriver] Mocking requests is now available in WebDriver. Thanks @radhey1851
- [Puppeteer] Ensure configured user agent and/or window size is applied to all pages. See #1862 by @martomo
- Improve handling of xpath locators with round brackets by @nitschSB. See #1870
- Use WebDriver capabilities config in wdio plugin. #1869 by @quekshuy
- Parallel testing by workers introduced by @VikalpP and @davertmik. Use
run-workers
command as faster and simpler alternative torun-multiple
. Requires NodeJS v12
# run all tests in parallel using 3 workers
npx codeceptjs run-workers 3
- [GraphQL][GraphQLDataFactory] Helpers for data management over GraphQL APIs added. By @radhey1851.
- Learn how to use GraphQL helper to access GarphQL API
- And how to combine it with GraphQLDataFactory to generate and persist test data.
- Updated to use Mocha 6. See #1802 by @elukoyanov
- Added
dry-run
command to print steps of test scenarios without running them. Fails to execute scenarios withgrab*
methods or custom code. See #1825 for more details.
npx codeceptjs dry-run
- [Appium] Optimization when clicking, searching for fields by accessibility id. See #1777 by @gagandeepsingh26
- [TestCafe] Fixed
switchTo
by @KadoBOT - [WebDriver] Added geolocation actions by @PeterNgTr
grabGeoLocation()
setGeoLocation()
- [Polly] Check typeof arguments for mock requests by @VikalpP. Fixes #1815
- CLI improvements by @jamesgeorge007
codeceptjs
command prints list of all available commands- added
codeceptjs -V
flag to print version information - warns on unknown command
- Added TypeScript files support to
run-multiple
by @z4o4z - Fixed element position bug in locator builder. See #1829 by @AnotherAnkor
- Various TypeScript typings updates by @elukoyanov and @Vorobeyko
- Added
event.step.comment
event for all comment steps likeI.say
or gherking steps.
- [WebDriver] A dedicated guide written.
- [TestCafe] A dedicated guide written.
- [Puppeteer] A chapter on mocking written
- [Puppeteer][Nightmare][TestCafe] Window mode is enabled by default on
codeceptjs init
. - [TestCafe] Actions implemented by @hubidu
grabPageScrollPosition
scrollPageToTop
scrollPageToBottom
scrollTo
switchTo
- Intellisense improvements. Renamed
tsconfig.json
tojsconfig.json
on init. Fixed autocompletion for Visual Studio Code. - [Polly] Take configuration values from Puppeteer. Fix #1766 by @VikalpP
- [Polly] Add preconditions to check for puppeteer page availability by @VikalpP. Fixes #1767
- [WebDriver] Use filename for
uploadFile
by @VikalpP. See #1797 - [Puppeteer] Configure speed of input with
pressKeyDelay
option. By @hubidu - Fixed recursive loading of support objects by @davertmik.
- Fixed support object definitions in steps.d.ts by @johnyb. Fixes #1795
- Fixed
Data().Scenario().injectDependencies()
is not a function by @andrerleao - Fixed crash when using xScenario & Scenario.skip with tag by @VikalpP. Fixes #1751
- Dynamic configuration of helpers can be performed with async function. See #1786 by @cviejo
- Added TS definitions for internal objects by @Vorobeyko
- BDD improvements:
- Fix for snippets command with a .feature file that has special characters by @asselin
- Fix
--path
option ongherkin:snippets
command by @asselin. See #1790 - Added
--feature
option togherkin:snippets
to enable creating snippets for a subset of .feature files. See #1803 by @asselin.
- Fixed: dynamic configs not reset after test. Fixes #1776 by @cviejo.
- EXPERIMENTAL TestCafe helper introduced. TestCafe allows to run cross-browser tests it its own very fast engine. Supports all browsers including mobile. Thanks to @hubidu for implementation! Please test it and send us feedback.
- [Puppeteer] Mocking requests enabled by introducing Polly.js helper. Thanks @VikalpP
// use Polly & Puppeteer helpers
I.mockRequest('GET', '/api/users', 200);
I.mockRequest('POST', '/users', { user: { name: 'fake' }});
- EXPERIMENTAL [Puppeteer] Firefox support introduced by @ngadiyak, see #1740
- [stepByStepReportPlugin] use md5 hash to generate reports into unique folder. Fix #1744 by @chimurai
- Interactive pause improvements:
- print result of
grab
commands - print message for successful assertions
- print result of
run-multiple
(parallel execution) improvements:bootstrapAll
must be called before creating chunks. #1741 by @Vorobeyko- Bugfix: If value in config has falsy value then multiple config does not overwrite original value. #1756 by @LukoyanovE
- Fixed hooks broken in 2.1.5 by @Vorobeyko
- Fix references to support objects when using Dependency Injection. Fix by @johnyb. See #1701
- Fix dynamic config applied for multiple helpers by @VikalpP #1743
- EXPERIMENTAL Wix Detox support introduced as standalone helper. Provides a faster alternative to Appium for mobile testing.
- Saving successful commands inside interactive pause into
_output/cli-history
file. By @hubidu - Fixed hanging error handler inside scenario. See #1721 by @haily-lgc.
- Fixed by @Vorobeyko: tests did not fail when an exception was raised in async bootstrap.
- [WebDriver] Added window control methods by @emmonspired
grabAllWindowHandles
returns all window handlesgrabCurrentWindowHandle
returns current window handleswitchToWindow
switched to window by its handle
- [Appium] Fixed using
host
as configuration by @trinhpham - Fixed
run-multiple
command whentests
config option is undefined (in Gherkin scenarios). By @gkushang. - German translation introduced by @hubidu
- [WebDriver][Puppeteer][Protractor][Nightmare] A11y locator support introduced by @Holorium. Clickable elements as well as fields can be located by following attributes:
aria-label
title
aria-labelledby
- [Puppeteer] Added support for React locators.
- New React Guide added.
- [Puppeteer] Deprecated
downloadFile
- [Puppeteer] Introduced
handleDownloads
replacingdownloadFile
- [puppeteerCoverage plugin] Fixed path already exists error by @seta-tuha.
- Fixed 'ERROR: ENAMETOOLONG' creating directory names in
run-multiple
with long config. By @artvinn - [REST] Fixed url autocompletion combining base and relative paths by @LukoyanovE
- [Nightmare][Protractor]
uncheckOption
method introduced by @PeterNgTr - [autoLogin plugin] Enable to use without
await
by @tsuemura - [Puppeteer] Fixed
UnhandledPromiseRejectionWarning: "Execution context was destroyed...
by @adrielcodeco - [WebDriver] Keep browser window dimensions when starting a new session by @spiroid
- Replace Ghekrin plceholders with values in files that combine a scenerio outline and table by @medtoure18.
- Added Documentation to locate elements in React Native apps. By @DimGun.
- Adding optional
path
parameter tobdd:snippets
command to append snippets to a specific file. By @cthorsen31. - Added optional
output
parameter todef
command by @LukoyanovE. - [Puppeteer] Added
grabDataFromPerformanceTiming
by @PeterNgTr. - axios updated to
0.19.0
by @SteveShaffer - TypeScript defitions updated by @LukoyanovE. Added
secret
andinject
function.
- Fixed autoLogin plugin to inject
login
function - Fixed using
toString()
in DataTablewhen it is defined by @tsuemura
- Fixed
inject
to load objects recursively. - Fixed TypeScript definitions for locators by @LukoyanovE
- EXPERIMENTAL [WebDriver] ReactJS locators support with webdriverio v5.8+:
// locating React element by name, prop, state
I.click({ react: 'component-name', props: {}, state: {} });
I.seeElement({ react: 'component-name', props: {}, state: {} });
- Do not retry
within
andsession
calls insideretryFailedStep
plugin. Fix by @tsuemura
- Added global
inject()
function to require actor and page objects using dependency injection. Recommended to use in page objects, step definition files, support objects:
// old way
const I = actor();
const myPage = require('../page/myPage');
// new way
const { I, myPage } = inject();
- Added global
secret
function to fill in sensitive data. By @RohanHart:
I.fillField('password', secret('123456'));
- wdioPlugin Added a plugin to support webdriverio services including selenium-standalone, sauce, browserstack, etc. Sponsored by @GSasu
- [Appium] Fixed
swipe*
methods by @PeterNgTr - BDD Gherkin Improvements:
- Implemented
run-multiple
for feature files. Sponsored by @GSasu - Added
--features
and--tests
options torun-multiple
. Sponsored by @GSasu - Implemented
Before
andAfter
hooks in step definitions
- Implemented
- Fixed running tests by absolute path. By @batalov.
- Enabled the adding screenshot to failed test for moch-junit-reporter by @PeterNgTr.
- [Puppeteer] Implemented
uncheckOption
and fixed behavior ofcheckOption
by @aml2610 - [WebDriver] Fixed
seeTextEquals
on empty strings by @PeterNgTr - [Puppeteer] Fixed launch with
browserWSEndpoint
config by @ngadiyak. - [Puppeteer] Fixed switching back to main window in multi-session mode by @davertmik.
- [autoLoginPlugin] Fixed using async functions for auto login by @nitschSB
This release was partly sponsored by @GSasu. Thanks for the support! Do you want to improve this project? [Learn more about sponsorin CodeceptJS
- [Puppeteer] Added
downloadFile
action by @PeterNgTr.
Use it with FileSystem
helper to test availability of a file:
const fileName = await I.downloadFile('a.file-link');
I.amInPath('output');
I.seeFile(fileName);
Actions
amInPath
andseeFile
are taken from FileSystem helper
- [Puppeteer] Fixed
autoLogin
plugin with Puppeteer by @davertmik - [WebDriver]
seeInField
should throw error if element has no value attrubite. By @PeterNgTr - [WebDriver] Fixed
seeTextEquals
passes for any string if element is empty by @PeterNgTr. - [WebDriver] Internal refctoring to use
el.isDisplayed
to match latest webdriverio implementation. Thanks to @LukoyanovE - [allure plugin] Add ability enable screenshotDiff plugin by @Vorobeyko
- [Appium] Fixed
locator.stringify
call by @LukoyanovE
- [WebDriver][Protractor][Nightmare]
rightClick
method implemented (fixed) in a standard way. By @davertmik - [WebDriver] Updated WebDriver API calls in helper. By @PeterNgTr
- [stepByStepReportPlugin] Added
screenshotsForAllureReport
config options to automatically attach screenshots to allure reports. By @PeterNgTr - [allurePlugin] Added
addLabel
method by @Vorobeyko - Locator Builder: fixed
withChild
andwithDescendant
to match deep nested siblings by @Vorobeyko.
- Introduced Custom Locator Strategies.
- Added Visual Testing Guide by @puneet0191 and @MitkoTschimev.
- [Puppeteer]
puppeteerCoverage
plugin added to collect code coverage in JS. By @dvillarama - Make override option in
run-multiple
to respect the generated overridden config by @kinyat - Fixed deep merge for
container.append()
. Introducedlodash.merge()
. By @Vorobeyko - Fixed saving screenshot on Windows by
- Fix errors on using interactive shell with Allure plugin by tsuemura
- Fixed using dynamic injections with
Scenario().injectDependencies
by @tsemura - [WebDriver][Puppeteer][Nightmare][Protractor] Fixed url protocol detection for non-http urls by @LukoyanovE
- [WebDriver] Enabled compatibility with
stepByStepReport
by @tsuemura - [WebDriver] Fixed
grabHTMLFrom
to return innerHTML value by @Holorium. Fixed compatibility with WebDriverIO. - [WebDriver]
grabHTMLFrom
to return one HTML vlaue for one element matched, array if multiple elements found by @davertmik. - [Nightmare] Added
grabHTMLFrom
by @davertmik - Fixed
bootstrapAll
andteardownAll
launch with path as argument by @LukoyanovE - Fixed
bootstrapAll
andteardownAll
calls from exported object by @LukoyanovE - [WebDriver] Added possibility to define conditional checks interval for
waitUntil
by @LukoyanovE - Fixed storing current data in data driven tests in a test object. By @Vorobeyko
- [WebDriver] Fixed
hostname
config option overwrite when setting a cloud provider. By @LukoyanovE - [WebDriver]
dragSlider
method implemented by @DavertMik - [WebDrover] Fixed
scrollTo
to use new webdriverio API by @PeterNgTr - Added Japanese translation file by @tsemura
- Added
Locator.withDescendant()
method to find an element which contains a descendant (child, grandchild) by @Vorobeyko - [WebDriver] Fixed configuring capabilities for Selenoid and IE by @Vorobeyko
- [WebDriver] Restore original window size when taking full size screenshot by @tsuemura
- Enabled
throws()
,fails()
,retry()
,timeout()
,config()
functions for data driven tests. By @jjm409
[Broken Release]
- [WebDriver][Protractor][Nightmare][Puppeteer]
grabAttributeFrom
returns an array when multiple elements matched. By @PeterNgTr - [autoLogin plugin] Fixed merging users config by @nealfennimore
- [autoDelay plugin] Added WebDriver to list of supported helpers by @mattin4d
- [Appium] Fixed using locators in
waitForElement
,waitForVisible
,waitForInvisible
. By @eduardofinotti - [allure plugin] Add tags to allure reports by @Vorobeyko
- [allure plugin] Add skipped tests to allure reports by @Vorobeyko
- Fixed
Logged Test name | [object Object]
when used Data().Scenario(). By @Vorobeyko - Fixed Data().only.Scenario() to run for all datasets. By @Vorobeyko
- [WebDriver]
attachFile
to work with hidden elements. Fixed in #1460 by @tsuemura
- autoLogin plugin added. Allows to log in once and reuse browser session. When session expires - automatically logs in again. Can persist session between runs by saving cookies to file.
- Fixed
Maximum stack trace
issue inretryFailedStep
plugin. - Added
locate()
function into the interactive shell. - [WebDriver] Disabled smartWait for interactive shell.
- [Appium] Updated methods to use for mobile locators
waitForElement
waitForVisible
waitForInvisible
- Helper and page object generators no longer update config automatically. Please add your page objects and helpers manually.
- [Puppeteer] Improved handling of connection with remote browser using Puppeteer by @martomo
- [WebDriver] Updated to webdriverio 5.2.2 by @martomo
- Interactive pause improvements by @davertmik
- Disable retryFailedStep plugin in in interactive mode
- Removes
Interface: parseInput
while in interactive pause
- [ApiDataFactory] Improvements
- added
fetchId
config option to override id retrieval from payload - added
onRequest
config option to update request in realtime - added
returnId
config option to return ids of created items instead of items themvelves - added
headers
config option to override default headers. - added a new chapter into DataManagement
- added
- [REST] Added
onRequest
config option
- Fixed creating project with
codecept init
. - Fixed error while installing webdriverio@5.
- Added code beautifier for generated configs.
- [WebDriver] Updated to webdriverio 5.1.0
-
[WebDriver] Breaking Change. Updated to webdriverio v5. New helper WebDriver helper introduced.
-
Upgrade plan:
- Install latest webdriverio
npm install webdriverio@5 --save
- Replace
WebDriverIO
=>WebDriver
helper name in config. - Read webdriverio changelog. If you were using webdriver API in your helpers, upgrade accordingly.
- We made WebDriver helper to be compatible with old API so no additional changes required.
If you face issues using webdriverio v5 you can still use webdriverio 4.x and WebDriverIO helper. Make sure you have
webdriverio: ^4.0
installed. -
Known issues:
attachFile
doesn't work with proxy server.
-
-
[Appium] Breaking Change. Updated to use webdriverio v5 as well. See upgrade plan ↑
-
[REST] Breaking Change. Replaced
unirest
library withaxios
.-
Upgrade plan:
- Refer to axios API.
- If you were using
unirest
requests/responses in your tests change them to axios format.
-
-
Breaking Change. Generators support in tests removed. Use
async/await
in your tests -
Using
codecept.conf.js
as default configuration format -
Fixed "enametoolong" error when saving screenshots for data driven tests by @PeterNgTr
-
Updated NodeJS to 10 in Docker image
-
[Pupeteer] Add support to use WSEndpoint. Allows to execute tests remotely. [See #1350] by @gabrielcaires (codeceptjs#1350)
-
In interactive shell [Enter] goes to next step. Improvement by @PeterNgTr.
-
I.say
accepts second parameter as color to print colorful comments. Improvement by @PeterNgTr.
I.say('This is red', 'red'); //red is used
I.say('This is blue', 'blue'); //blue is used
I.say('This is by default'); //cyan is used
- Fixed allure reports for multi session testing by @PeterNgTr
- Fixed allure reports for hooks by @PeterNgTr
- [Puppeteer]
dragSlider
action added by @PeterNgTr - [Puppeteer] Fixed opening browser in shell mode by @allenhwkim
- [Puppeteer] Fixed making screenshot on additional sessions by @PeterNgTr. Fixes #1266
- Added
--invert
option torun-multiple
command by @LukoyanovE - Fixed steps in Allure reports by @PeterNgTr
- Add option
output
to customize output directory in stepByStepReport plugin. By @fpsthirty - Changed type definition of PageObjects to get auto completion by @rhicu
- Fixed steps output for async/arrow functions in CLI by @LukoyanovE. See #1329
- Add require param to main config. Allows to require Node modules before executing tests. By @LukoyanovE. For example:
- Use
ts-node/register
to register TypeScript parser - Use
should
to register should-style assertions
- Use
"require": ["ts-node/register", "should"]
- [WebDriverIO] Fix timeouts definition to be compatible with W3C drivers. By @LukoyanovE
- Fixed: exception in Before block w/ Mocha causes test not to report failure. See #1292 by @PeterNgTr
- Command
run-parallel
now accepts--override
flag. Thanks to @ClemCB - Fixed Allure report with Before/BeforeSuite/After/AfterSuite steps. By @PeterNgTr
- Added
RUN_MULTIPLE
env variable to Docker config. Allows to run tests in parallel inside a container. Thanks to @PeterNgTr - [Mochawesome] Fixed showing screenshot on failure. Fix by @PeterNgTr
- Fixed running tests filtering by tag names defined via
Scenario.tag()
- autoDelay plugin added. Adds tiny delay before and after an action so the page could react to actions performed.
- [Puppeteer] improvements by @luismanuel001
click
no longer waits for navigationclickLink
method added. Performs a click and waits for navigation.
- Bootstrap scripts to be started only for
run
command and ignored onlist
,def
, etc. Fix by @LukoyanovE
- Groups renamed to Tags for compatibility with BDD layer
- Test and suite objects to contain tags property which can be accessed from internal API
- Fixed adding tags for Scenario Outline in BDD
- Added
tag()
method to ScenarioConfig and FeatureConfig:
Scenario('update user profile', () => {
// test goes here
}).tag('@slow');
- Fixed attaching Allure screenshot on exception. Fix by @DevinWatson
- Improved type definitions for custom steps. By @Akxe
- Fixed setting
multiple.parallel.chunks
as environment variable in config. See #1238 by @ngadiyak
- Fixed setting config for plugins (inclunding setting
outputDir
for allure) by @jplegoff
- Added
plugins
option torun-multiple
- Minor output fixes
- Added Type Definition for Helper class by @Akxe
- Fixed extracing devault extension in generators by @Akxe
- Allure Reporter Integration. Full inegration with Allure Server. Get nicely looking UI for tests,including steps, nested steps, and screenshots. Thanks Natarajan Krishnamurthy @krish for sponsoring this feature.
- Plugins API introduced. Create custom plugins for CodeceptJS by hooking into event dispatcher, and using promise recorder.
- Official CodeceptJS plugins added:
stepByStepReport
- creates nicely looking report to see test execution as a slideshow. Use this plugin to debug tests in headless environment without recording a video.allure
- Allure reporter added as plugin.screenshotOnFail
- saves screenshot on fail. Replaces similar functionality from helpers.retryFailedStep
- to rerun each failed step.
- [Puppeteer] Fix
executeAsyncScript
unexpected token by @jonathanz - Added
override
option torun-multiple
command by @svarlet
- Added
initGlobals()
function to API of custom runner.
- Interactve Shell improvements for
pause()
- Added
next
command for step-by-step debug when usingpause()
. - Use
After(pause);
in a to start interactive console after last step.
- Added
- [Puppeteer] Updated to Puppeteer 1.6.0
- Added
waitForRequest
to wait for network request. - Added
waitForResponse
to wait for network response.
- Added
- Improved TypeScript definitions to support custom steps and page objects. By @xt1
- Fixed XPath detection to accept XPath which starts with
./
by @BenoitZugmeyer
- BDD-Gherkin: Fixed running async steps.
- [Puppeteer] Fixed process hanging for 30 seconds. Page loading timeout default via
getPageTimeout
set 0 seconds. - [Puppeteer] Improved displaying client-side console messages in debug mode.
- [Puppeteer] Fixed closing sessions in
restart:false
mode for multi-session mode. - [Protractor] Fixed
grabPopupText
to not throw error popup is not opened. - [Protractor] Added info on using 'direct' Protractor driver to helper documentation by @xt1.
- [WebDriverIO] Added a list of all special keys to WebDriverIO helper by @davertmik and @xt1.
- Improved TypeScript definitions generator by @xt1
- Cucumber-style BDD. Introduced Gherkin support. Thanks to David Vins and Omedym for sponsoring this feature.
Basic feature file:
Feature: Business rules
In order to achieve my goals
As a persona
I want to be able to interact with a system
Scenario: do anything in my life
Given I need to open Google
Step definition:
const I = actor();
Given('I need to open Google', () => {
I.amOnPage('https://google.com');
});
Run it with --features --steps
flag:
codeceptjs run --steps --features
- Brekaing Chnage
run
command now uses relative path + test name to run exactly one test file.
Previous behavior (removed):
codeceptjs run basic_test.js
Current behavior (relative path to config + a test name)
codeceptjs run tests/basic_test.js
This change allows using auto-completion when running a specific test.
- Nested steps output enabled for page objects.
- to see high-level steps only run tests with
--steps
flag. - to see PageObjects implementation run tests with
--debug
.
- to see high-level steps only run tests with
- PageObjects simplified to remove
_init()
extra method. Try updated generators and see updated guide. - [Puppeteer] Multiple sessions enabled. Requires Puppeteer >= 1.5
- [Puppeteer] Stability improvement. Waits for for
load
event on page load. This strategy can be changed in config:waitForNavigation
config option introduced. Possible options:load
,domcontentloaded
,networkidle0
,networkidle2
. See Puppeteer APIgetPageTimeout
config option to set maximum navigation time in milliseconds. Default is 30 seconds.waitForNavigation
method added. Explicitly waits for navigation to be finished.
- [WebDriverIO][Protractor][Puppeteer][Nightmare] Possible BC
grabTextFrom
unified. Return a text for single matched element and an array of texts for multiple elements. - [Puppeteer]Fixed
resizeWindow
by @sergejkaravajnij - [WebDriverIO][Protractor][Puppeteer][Nightmare]
waitForFunction
added. Waits for client-side JavaScript function to return true by @GREENpoint. - [Puppeteer]
waitUntil
deprecated in favor ofwaitForFunction
. - Added
filter
function to DataTable. - Send non-nested array of files to custom parallel execution chunking by @mikecbrant.
- Fixed invalid output directory path for run-multiple by @mikecbrant.
- [WebDriverIO]
waitUntil
timeout accepts time in seconds (as all other wait* functions). Fix by @truesrc. - [Nightmare] Fixed
grabNumberOfVisibleElements
to work similarly toseeElement
. Thx to @stefanschenk and Jinbo Jinboson. - [Protractor] Fixed alert handling error with message 'no such alert' by @truesrc.
- Fixed running
I.retry()
on multiple steps. - Fixed parallel execution wih chunks.
- [Puppeteer] Fixed
grabNumberOfVisibleElements
to return0
instead of throwing error if no elements are found.
- [WebDriverIO][Protractor]Multiple Sessions. Run several browser sessions in one test. Introduced
session
command, which opens additional browser window and closes it after a test.
Scenario('run in different browsers', (I) => {
I.amOnPage('/hello');
I.see('Hello!');
session('john', () => {
I.amOnPage('/bye');
I.dontSee('Hello');
I.see('Bye');
});
I.see('Hello');
});
- Parallel Execution by @sveneisenschmidt. Run tests in parallel specifying number of chunks:
"multiple": {
"parallel": {
// run in 2 processes
"chunks": 2,
// run all tests in chrome
"browsers": ["chrome"]
},
}
- Locator Builder. Write complex locators with simplest API combining CSS and XPath:
// select 'Edit' link inside 2nd row of a table
locate('//table')
.find('tr')
.at(2)
.find('a')
.withText('Edit');
- Dynamic configuration to update helpers config per test or per suite.
- Added
event.test.finished
which fires synchronously for both failed and passed tests. - [WebDriverIO][Protractor][Nightmare][Puppeteer] Full page screenshots on failure disabled by default. See [issue#1600. You can enabled them with
fullPageScreenshots: true
, however they may work unstable in Selenium. within
blocks can return values. See updated documentation.- Removed doublt call to
_init
in helpers. Fixes issue #1036 - Added scenario and feature configuration via fluent API:
Feature('checkout')
.timeout(3000)
.retry(2);
Scenario('user can order in firefox', (I) => {
// see dynamic configuration
}).config({ browser: 'firefox' })
.timeout(20000);
Scenario('this test should throw error', (I) => {
// I.amOnPage
}).throws(new Error);
- Fixed generating TypeScript definitions with
codeceptjs def
. - Added Chinese translation ("zh-CN" and "zh-TW") by @TechQuery.
- Fixed running tests from a different folder specified by
-c
option. - [Puppeteer] Added support for hash handling in URL by @gavoja.
- [Puppeteer] Fixed setting viewport size by @gavoja. See Puppeteer issue
- Docker Image updateed. See updated reference:
- codeceptjs package is mounted as
/codecept
insde container - tests directory is expected to be mounted as
/tests
codeceptjs
global runner added (symlink to/codecept/bin/codecept.js
)
- codeceptjs package is mounted as
- [Protractor] Functions added by @reubenmiller:
_locateCheckable (only available from other helpers)
_locateClickable (only available from other helpers)
_locateFields (only available from other helpers)
acceptPopup
cancelPopup
dragAndDrop
grabBrowserLogs
grabCssPropertyFrom
grabHTMLFrom
grabNumberOfVisibleElements
grabPageScrollPosition (new)
rightClick
scrollPageToBottom
scrollPageToTop
scrollTo
seeAttributesOnElements
seeCssPropertiesOnElements
seeInPopup
seeNumberOfVisibleElements
switchTo
waitForEnabled
waitForValue
waitInUrl
waitNumberOfVisibleElements
waitToHide
waitUntil
waitUrlEquals
- [Nightmare] added:
grabPageScrollPosition
(new)seeNumberOfVisibleElements
waitToHide
- [Puppeteer] added:
grabPageScrollPosition
(new)
- [WebDriverIO] added"
grabPageScrollPosition
(new)
- [Puppeteer] Fixed running wait* functions without setting
sec
parameter. - [Puppeteer][Protractor] Fixed bug with I.click when using an object selector with the xpath property. By @reubenmiller
- [WebDriverIO][Protractor][Nightmare][Puppeteer] Fixed I.switchTo(0) and I.scrollTo(100, 100) api inconsistencies between helpers.
- [Protractor] Fixing bug when
seeAttributesOnElements
andseeCssPropertiesOnElement
were incorrectly passing when the attributes/properties did not match by @reubenmiller - [WebDriverIO] Use inbuilt dragAndDrop function (still doesn't work in Firefox). By @reubenmiller
- Support for Nightmare 3.0
- Enable glob patterns in
config.test
/Codecept.loadTests
by @sveneisenschmidt - Enable overriding of
config.tests
forrun-multiple
by @sveneisenschmidt
- Added support for
async I =>
functions syntax in Scenario by @APshenkin - [WebDriverIO][Protractor][Puppeteer][Nightmare]
waitForInvisible
waits for element to hide or to be removed from page. By @reubenmiller - [Protractor][Puppeteer][Nightmare] Added
grabCurrentUrl
function. By @reubenmiller - [WebDriverIO]
grabBrowserUrl
deprecated in favor ofgrabCurrentUrl
to unify the API. - [Nightmare] Improved element visibility detection by @reubenmiller
- [Puppeteer] Fixing function calls when clearing the cookies and localstorage. By @reubenmiller
- [Puppeteer] Added
waitForEnabled
,waitForValue
andwaitNumberOfVisibleElements
methods by @reubenmiller - [WebDriverIO] Fixed
grabNumberOfVisibleElements
to return 0 when no visible elements are on page. By @michaltrunek - Helpers API improvements (by @reubenmiller)
_passed
hook runs after a test passed successfully_failed
hook runs on a failed test
- Hooks API. New events added by @reubenmiller:
event.all.before
- executed before all testsevent.all.after
- executed after all testsevent.multiple.before
- executed before all processes in run-multipleevent.multiple.after
- executed after all processes in run-multiple
- Multiple execution
- Allow
AfterSuite
andAfter
test hooks to be defined after the first Scenario. By @reubenmiller - [Nightmare] Prevent
I.amOnpage
navigation if the browser is already at the given url - Multiple-Run: Added new
bootstrapAll
andteardownAll
hooks to be executed before and after all processes codeceptjs def
command accepts--config
option. By @reubenmiller
- [Puppeteer] Rerun steps failed due to "Cannot find context with specified id" Error.
- Added syntax to retry a single step:
// retry action once on failure
I.retry().see('Hello');
// retry action 3 times on failure
I.retry(3).see('Hello');
// retry action 3 times waiting for 0.1 second before next try
I.retry({ retries: 3, minTimeout: 100 }).see('Hello');
// retry action 3 times waiting no more than 3 seconds for last retry
I.retry({ retries: 3, maxTimeout: 3000 }).see('Hello');
// retry 2 times if error with message 'Node not visible' happens
I.retry({
retries: 2,
when: err => err.message === 'Node not visible'
}).seeElement('#user');
Scenario().injectDependencies
added to dynamically add objects into DI container by @Apshenkin. See Dependency Injection section in PageObjects.- Fixed using async/await functions inside
within
- [WebDriverIO][Protractor][Puppeteer][Nightmare]
waitUntilExists
deprecated in favor ofwaitForElement
- [WebDriverIO][Protractor]
waitForStalenessOf
deprecated in favor ofwaitForDetached
- [WebDriverIO][Protractor][Puppeteer][Nightmare]
waitForDetached
added - [Nightmare] Added
I.seeNumberOfElements()
by @pmoncadaisla - [Nightmare] Load blank page when starting nightmare so that the .evaluate function will work if _failed/saveScreenshot is triggered by @reubenmiller
- Fixed using plain arrays for data driven tests by @reubenmiller
- [Puppeteer] Use default tab instead of opening a new tab when starting the browser by @reubenmiller
- [Puppeteer] Added
grabNumberOfTabs
function by @reubenmiller - [Puppeteer] Add ability to set user-agent by @abidhahmed
- [Puppeteer] Add keepCookies and keepBrowserState @abidhahmed
- [Puppeteer] Clear value attribute instead of innerhtml for TEXTAREA by @reubenmiller
- [REST] fixed sending string payload by @michaltrunek
- Fixed unhandled rejection in async/await tests by @APshenkin
- Removed
yarn
call in package.json - Fixed
console.log
in Puppeteer by @othree - [Appium]
runOnAndroid
andrunOnIOS
can receive a function to check capabilities dynamically:
I.runOnAndroid(caps => caps.platformVersion >= 7, () => {
// run code only on Android 7+
});
- [Puppeteer] +25 Functions added by @reubenmiller
_locateCheckable
_locateClickable
_locateFields
closeOtherTabs
dragAndDrop
grabBrowserLogs
grabCssPropertyFrom
grabHTMLFrom
grabNumberOfVisibleElements
grabSource
rightClick
scrollPageToBottom
scrollPageToTop
scrollTo
seeAttributesOnElements
seeCssPropertiesOnElements
seeInField
seeNumberOfElements
seeNumberOfVisibleElements
seeTextEquals
seeTitleEquals
switchTo
waitForInvisible
waitInUrl
waitUrlEquals
- [Protractor] +8 functions added by @reubenmiller
closeCurrentTab
grabSource
openNewTab
seeNumberOfElements
seeTextEquals
seeTitleEquals
switchToNextTab
switchToPreviousTab
- [Nightmare]
waitForInvisible
added by @reubenmiller - [Puppeteer] Printing console.log information in debug mode.
- [Nightmare] Integrated with
nightmare-har-plugin
by mingfang. AddedenableHAR
option. Added HAR functions:grabHAR
saveHAR
resetHAR
- [WebDriverIO] Fixed execution stability for parallel requests with Chromedriver
- [WebDriverIO] Fixed resizeWindow when resizing to 'maximize' by @reubenmiller
- [WebDriverIO] Fixing resizing window to full screen when taking a screenshot by @reubenmiller
- [Puppeteer] Upgraded to Puppeteer 1.0
- Added
grep
option to config to set default matching pattern for tests. - [Puppeteer] Added
acceptPopup
,cancelPopup
,seeInPopup
andgrabPopupText
functions by @reubenmiller - [Puppeteer]
within
iframe and nested iframe support added by @reubenmiller - [REST] Added support for JSON objects since payload (as a JSON) was automatically converted into "URL query" type of parameter by @Kalostrinho
- [REST] Added
resetRequestHeaders
method by @Kalostrinho - [REST] Added
followRedirect
option andamFollowingRequestRedirects
/amNotFollowingRequestRedirects
methods by @Kalostrinho - [WebDriverIO]
uncheckOption
implemented by @brunobg - [WebDriverIO] Added
grabBrowserUrl
by @Kalostrinho - Add ability to require helpers from node_modules by @APshenkin
- Added
--profile
option torun-multiple
command by @jamie-beck - Custom output name for multiple browser run by @tfiwm
- Fixed passing data to scenarios by @KennyRules
- [WebDriverIO] fixed
waitForInvisible
by @Kporal
Major update to CodeceptJS. NodeJS v 8.9.1 is now minimal Node version required. This brings native async-await support to CodeceptJS. It is recommended to start using await for tests instead of generators:
async () => {
I.amOnPage('/page');
const url = await I.grabTextFrom('.nextPage');
I.amOnPage(url);
}
Thanks to @Apshenkin for implementation. Also, most helpers were refactored to use async-await. This made our code simpler. We hope that this encourages more users to send pull requests!
We also introduced strict ESLint policies for our codebase. Thanks to @Galkin for that.
- [Puppeteer] Helper introduced. Learn how to run tests headlessly with Google Chrome's Puppeteer.
- [SeleniumWebdriver] Helper is deprecated, it is recommended to use Protractor with config option
angular: false
instead. - [WebDriverIO] nested iframe support in the within block by @reubenmiller. Example:
within({frame: ['#wrapperId', '[name=content]']}, () => {
I.click('Sign in!');
I.see('Email Address');
});
I.see('Nested Iframe test');
I.dontSee('Email Address');
});
- [WebDriverIO] Support for
~
locator to find elements byaria-label
. This behavior is similar as it is in Appium and helps testing cross-platform React apps. Example:
<Text accessibilityLabel="foobar">
CodeceptJS is awesome
</Text>
↑ This element can be located with ~foobar
in WebDriverIO and Appium helpers. Thanks to @flyskywhy
- Allow providing arbitrary objects in config includes by @rlewan
- [REST] Prevent from mutating default headers by @alexashley. See #789
- [REST] Fixed sending empty helpers with
haveRequestHeaders
insendPostRequest
. By @petrisorionel - Fixed displaying undefined args in output by @APshenkin
- Fixed NaN instead of seconds in output by @APshenkin
- Add browser name to report file for
multiple-run
by @trollr - Mocha updated to 4.x
- [WebDriverIO][Protractor][Nightmare] method
waitUntilExists
implemented by @sabau - Absolute path can be set for
output
dir by @APshenkin. Fix #571* Data table rows can be ignored by usingxadd
. By @APhenkin - Added
Data(table).only.Scenario
to give ability to launch only Data tests. By @APhenkin - Implemented
ElementNotFound
error by @BorisOsipov. - Added TypeScript compiler / configs to check the JavaScript by @KennyRules
- [Nightmare] fix executeScript return value by @jploskonka
- [Nightmare] fixed: err.indexOf not a function when waitForText times out in nightmare by @joeypedicini92
- Fixed: Retries not working when using .only. By @APhenkin
- Introduced generators support in scenario hooks for
BeforeSuite
/Before
/AfterSuite
/After
- [ApiDataFactory] Fixed loading helper;
requireg
package included. - Fix #485
run-multiple
: the first browser-resolution combination was be used in all configurations - Fixed unique test names:
- Fixed #447 tests failed silently if they have the same name as other tests.
- Use uuid in screenshot names when
uniqueScreenshotNames: true
- [Protractor] Fixed testing non-angular application.
amOutsideAngularApp
is executed before each step. Fixes #458* Added output for steps in hooks when they fail
- Reporters improvements:
- Allows to execute multiple reporters
- Added Mochawesome helper
addMochawesomeContext
method to add custom data to mochawesome reports- Fixed Mochawesome context for failed screenshots.
- [WebDriverIO] improved click on context to match clickable element with a text inside. Fixes #647* [Nightmare] Added
refresh
function by @awhanks - fixed
Unhandled promise rejection (rejection id: 1): Error: Unknown wait type: pageLoad
- support for tests with retries in html report
- be sure that change window size and timeouts completes before test
- [Nightmare] Fixed
[Wrapped Error] "codeceptjs is not defined"
; Reinjectiing client scripts to a webpage on changes. - [Nightmare] Added more detailed error messages for
Wait*
methods - [Nightmare] Fixed adding screenshots to Mochawesome
- [Nightmare] Fix unique screenshots names in Nightmare
- Fixed CodeceptJS work with hooks in helpers to finish codeceptJS correctly if errors appears in helpers hooks
- Create a new session for next test If selenium grid error received
- Create screenshots for failed hooks from a Feature file
- Fixed
retries
option
CodeceptJS hits first stable release. CodeceptJS provides a unified API for web testing for Webdriverio, Protractor, and NightmareJS. Since 1.0 you can also test mobile applications in the similar manner with Appium.
Sample test:
I.seeAppIsInstalled("io.super.app");
I.click('~startUserRegistrationCD');
I.fillField('~email of the customer', 'Nothing special'));
I.see('davert@codecept.io', '~email of the customer'));
I.clearField('~email of the customer'));
I.dontSee('Nothing special', '~email of the customer'));
- Read the Mobile Testing guide.
- Discover Appium Helper
We also introduced two new helpers for data management. Using them you can easily prepare and cleanup data for your tests using public REST API.
Sample test
// create a user using data factories and REST API
I.have('user', { name: 'davert', password: '123456' });
// use it to login
I.amOnPage('/login');
I.fillField('login', 'davert');
I.fillField('password', '123456');
I.click('Login');
I.see('Hello, davert');
// user will be removed after the test
Next notable feature is SmartWait for WebDriverIO, Protractor, SeleniumWebdriver. When smartwait
option is set, script will wait for extra milliseconds to locate an element before failing. This feature uses implicit waits of Selenium but turns them on only in applicable pieces. For instance, implicit waits are enabled for seeElement
but disabled for dontSeeElement
- Read more about SmartWait
- Minimal NodeJS version is 6.11.1 LTS
- Use
within
command with generators. - Data Driven Tests introduced.
- Print execution time per step in
--debug
mode. #591 by @APshenkin - [WebDriverIO][Protractor][Nightmare] Added
disableScreenshots
option to disable screenshots on fail by @Apshenkin - [WebDriverIO][Protractor][Nightmare] Added
uniqueScreenshotNames
option to generate unique names for screenshots on failure by @Apshenkin - [WebDriverIO][Nightmare] Fixed click on context;
click('text', '#el')
will throw exception if text is not found inside#el
. - [WebDriverIO][Protractor][SeleniumWebdriver] SmartWait introduced.
- [WebDriverIO][Protractor][Nightmare]Fixed
saveScreenshot
for PhantomJS,fullPageScreenshots
option introduced by @HughZurname #549 - [Appium] helper introduced by @APshenkin
- [REST] helper introduced by @atrevino in #504
- [WebDriverIO][SeleniumWebdriver] Fixed "windowSize": "maximize" for Chrome 59+ version #560 by @APshenkin
- [Nightmare] Fixed restarting by @APshenkin #581
- [WebDriverIO] Methods added by @APshenkin:
- grabCssPropertyFrom
- seeTitleEquals
- seeTextEquals
- seeCssPropertiesOnElements
- seeAttributesOnElements
- grabNumberOfVisibleElements
- waitInUrl
- waitUrlEquals
- waitForValue
- waitNumberOfVisibleElements
- switchToNextTab
- switchToPreviousTab
- closeCurrentTab
- openNewTab
- refreshPage
- scrollPageToBottom
- scrollPageToTop
- grabBrowserLogs
- Use mkdirp to create output directory. #592 by @vkramskikh
- [WebDriverIO] Fixed
seeNumberOfVisibleElements
by @BorisOsipov #574 - Lots of fixes for promise chain by @APshenkin #568
- Fix #543- After block not properly executed if Scenario fails
- Expected behavior in promise chains:
_beforeSuite
hooks from helpers ->BeforeSuite
from test ->_before
hooks from helpers ->Before
from test - > Test steps ->_failed
hooks from helpers (if test failed) ->After
from test ->_after
hooks from helpers ->AfterSuite
from test ->_afterSuite
hook from helpers. - if during test we got errors from any hook (in test or in helper) - stop complete this suite and go to another
- if during test we got error from Selenium server - stop complete this suite and go to another
- [WebDriverIO][Protractor] if
restart
option is false - close all tabs expect one in_after
. - Complete
_after
,_afterSuite
hooks even After/AfterSuite from test was failed - Don't close browser between suites, when
restart
option is false. We should start browser only one time and close it only after all tests. - Close tabs and clear local storage, if
keepCookies
flag is enabled
- Fix TypeError when using babel-node or ts-node on node.js 7+ #586 by @vkramskikh
- [Nightmare] fixed usage of
_locate
Special thanks to Andrey Pshenkin for his work on this release and the major improvements.
- Errors are printed in non-verbose mode. Shows "Selenium not started" and other important errors.
- Allowed to set custom test options:
Scenario('My scenario', { build_id: 123, type: 'slow' }, function (I)
those options can be accessed as opts
property inside a test
object. Can be used in custom listeners.
- Added
docs
directory to a package. - [WebDriverIO][Protractor][SeleniumWebdriver] Bugfix: cleaning session when
restart: false
by @tfiwm #519 - [WebDriverIO][Protractor][Nightmare] Added second parameter to
saveScreenshot
to allow a full page screenshot. By @HughZurname - Added suite object to
suite.before
andsuite.after
events by @implico. #496
- Added
config
object to public API - Extended
index.js
to includeactor
andhelpers
, so they could be required:
const actor = require('codeceptjs').actor;
- Added example for creating custom runner with public API.
- run command to create
output
directory if it doesn't exist - [Protractor] fixed loading globally installed Protractor
- run-multiple command improvements:
- create output directories for each process
- print process ids in output
- Fixed loading hooks
Major release with extension API and parallel execution.
- Breaking Removed path argument from
run
. To specify path other than current directory use--config
or-c
option:
Instead of: codeceptjs run tests
use:
# load config and run from tests directory
codeceptjs run -c tests/
# or load codecept.json from tests directory
codeceptjs run -c tests/codecept.json
# run users_test.js inside tests directory
codeceptjs run users_test.js -c tests
- Command
multiple-run
added, to execute tests in several browsers in parallel by @APshenkin and @davertmik. See documentation. - Hooks API added to extend CodeceptJS with custom listeners and plugins. See documentation.
- [Nightmare][WebDriverIO]
within
can work with iframes by @imvetri. See documentation. - [WebDriverIO][SeleniumWebdriver][Protractor] Default browser changed to
chrome
- [Nightmare] Fixed globally locating
nightmare-upload
. - [WebDriverIO] added
seeNumberOfVisibleElements
method by @elarouche. - Exit with non-zero code if init throws an error by @rincedd
- New guides published:
- Meta packages published:
- Polish translation added by @limes.
- Update process exit code so that mocha saves reports before exit by @romanovma.
- [Nightmare] fixed
getAttributeFrom
for custom attributes by @robrkerr - [Nightmare] Fixed UnhandledPromiseRejectionWarning error when selecting the dropdown using
selectOption
by @robrkerr. [Se PR. - [Protractor] fixed
pressKey
method by @romanovma
- Protractor ^5.0.0 support (while keeping ^4.0.9 compatibility)
- Fix 'fullTitle() is not a function' in exit.js by @hubidu. See #388.
- [Nightmare] Fix for
waitTimeout
by @HughZurname. See #391. Resolves #236* Dockerized CodeceptJS setup by @artiomnist. See reference
- Fixed steps output synchronization (regression since 0.4.14).
- [WebDriverIO][Protractor][SeleniumWebdriver][Nightmare] added
keepCookies
option to keep cookies between tests withrestart: false
. - [Protractor] added
waitForTimeout
config option to set default waiting time for all wait* functions. - Fixed
_test
hook for helpers by @cjhille.
- Fixed regression in recorder sessions:
oldpromise is not defined
.
_beforeStep
and_afterStep
hooks in helpers are synchronized. Allows to perform additional actions between steps.
Example: fail if JS error occur in custom helper using WebdriverIO:
_before() {
this.err = null;
this.helpers['WebDriverIO'].browser.on('error', (e) => this.err = e);
}
_afterStep() {
if (this.err) throw new Error('Browser JS error '+this.err);
}
Example: fail if JS error occur in custom helper using Nightmare:
_before() {
this.err = null;
this.helpers['Nightmare'].browser.on('page', (type, message, stack) => {
this.err = `${message} ${stack}`;
});
}
_afterStep() {
if (this.err) throw new Error('Browser JS error '+this.err);
}
- Fixed
codecept list
andcodecept def
commands. - Added
I.say
method to print arbitrary comments.
I.say('I am going to publish post');
I.say('I enter title and body');
I.say('I expect post is visible on site');
- [Nightmare]
restart
option added.restart: false
allows to run all tests in a single window, disabled by default. By @nairvijays99 - [Nightmare] Fixed
resizeWindow
command. - [Protractor][SeleniumWebdriver] added
windowSize
config option to resize window on start. - Fixed "Scenario.skip causes 'Cannot read property retries of undefined'" by @MasterOfPoppets
- Fixed providing absolute paths for tests in config by @lennym
- Added retries option
Feature
andScenario
to rerun fragile tests:
Feature('Complex JS Stuff', {retries: 3});
Scenario('Not that complex', {retries: 1}, (I) => {
// test goes here
});
- Added timeout option
Feature
andScenario
to specify timeout.
Feature('Complex JS Stuff', {timeout: 5000});
Scenario('Not that complex', {timeout: 1000}, (I) => {
// test goes here
});
- [WebDriverIO] Added
uniqueScreenshotNames
option to set unique screenshot names for failed tests. By @APshenkin. See #299 - [WebDriverIO]
clearField
method improved to accept name/label locators and throw errors. - [Nightmare][SeleniumWebdriver][Protractor]
clearField
method added. - [Nightmare] Fixed
waitForElement
, andwaitForVisible
methods. - [Nightmare] Fixed
resizeWindow
by @norisk-it - Added italian translation.
- Bootstrap / Teardown improved with Hooks. Various options for setup/teardown provided.
- Added
--override
or-o
option for runner to dynamically override configs. Valid JSON should be passed:
codeceptjs run -o '{ "bootstrap": "bootstrap.js"}'
codeceptjs run -o '{ "helpers": {"WebDriverIO": {"browser": "chrome"}}}'
- Added regression tests for codeceptjs tests runner.
- Fixed regression in 0.4.10
- Added
bootstrap
/teardown
config options to accept functions as parameters by @pscanf. See updated config reference #319
- [Protractor] Protrctor 4.0.12+ support.
- Enabled async bootstrap file by @abachar. Use inside
bootstrap.js
:
module.exports = function(done) {
// async instructions
// call done() to continue execution
// otherwise call done('error description')
}
- Changed 'pending' to 'skipped' in reports by @timja-kainos. See #315
- [SeleniumWebdriver][Protractor][WebDriverIO][Nightmare] fixed
executeScript
,executeAsyncScript
to work and return values. - [Protractor][SeleniumWebdriver][WebDriverIO] Added
waitForInvisible
andwaitForStalenessOf
methods by @Nighthawk14. - Added
--config
option tocodeceptjs run
to manually specify config file by @cnworks - [Protractor] Simplified behavior of
amOutsideAngularApp
by usingignoreSynchronization
. Fixes #278 - Set exit code to 1 when test fails at
Before
/After
hooks. Fixes #279
- [Protractor][SeleniumWebdriver][Nightmare] added
moveCursorTo
method. - [Protractor][SeleniumWebdriver][WebDriverIO] Added
manualStart
option to start browser manually in the beginning of test. By @cnworks. [PR#250 - Fixed
codeceptjs init
to work with nested directories and file masks. - Fixed
codeceptjs gt
to generate test with proper file name suffix. By @Zougi. - [Nightmare] Fixed: Error is thrown when clicking on element which can't be locate. By @davetmik
- [WebDriverIO] Fixed
attachFile
for file upload. By @giuband and @davetmik - [WebDriverIO] Add support for timeouts in config and with
defineTimeouts
method. By @easternbloc #258 and #267 by @davetmik - Fixed hanging of CodeceptJS when error is thrown by event dispatcher. Fix by @Zougi and @davetmik
- Improved docs for
BeforeSuite
; fixed its usage withrestart: false
option by @APshenkin. - Added
Nightmare
to list of available helpers oninit
. - [Nightmare] Removed double
resizeWindow
implementation.
- Added
BeforeSuite
andAfterSuite
hooks to scenario by @APshenkin. See updated documentation
- Fixed running
codecept def
command by @jankaspar - [Protractor][SeleniumWebdriver] Added support for special keys in
pressKey
method. Fixes #216
- Interactive shell fixed. Start it by running
codeceptjs shell
- Added
--profile
option toshell
command to use dynamic configuration. - Added
--verbose
option toshell
command for most complete output.
- [Protractor] Regression fixed to ^4.0.0 support
- Translations included into package.
teardown
option added to config (opposite tobootstrap
), expects a JS file to be executed after tests stop.- Configuration can be set via JavaScript file
codecept.conf.js
instead ofcodecept.json
. It should exportconfig
object:
// inside codecept.conf.js
exports.config = {
// contents of codecept.json
}
- Added
--profile
option to pass its value tocodecept.conf.js
asprocess.profile
for dynamic configuration. - Documentation for StepObjects, PageFragments updated.
- Documentation for Configuration added.
- Added ability to localize tests with translation #189. Thanks to @abner
- [Translation] ru-RU translation added.
- [Translation] pt-BR translation added.
- [Protractor] Protractor 4.0.4 compatibility.
- [WebDriverIO][SeleniumWebdriver][Protractor] Fixed single browser session mode for
restart: false
- Fixed using of 3rd party reporters (xunit, mocha-junit-reporter, mochawesome). Added guide.
- Documentation for Translation added.
- Documentation for Reports added.
- Added custom steps to step definition list. See #174 by @jayS-de
- [WebDriverIO] Fixed using
waitForTimeout
option by @stephane-ruhlmann. See #178
- Nightmare Helper added for faster web testing.
- [Protractor][SeleniumWebdriver][WebDriverIO] added
restart: false
option to reuse one browser between tests (improves speed). - Protractor 4.0 compatibility. Please upgrade Protractor library.
- Added
--verbose
option forrun
command to log and print global promise and events. - Fixed errors with shutting down and cleanup.
- Fixed starting interactive shell with
codeceptjs shell
. - Fixed handling of failures inside within block
- Introduced IDE autocompletion support for Visual Studio Code and others. Added command for generating TypeScript definitions for
I
object. Use it as
codeceptjs def
to generate steps definition file and include it into tests by reference. By @kaflan
- [Protractor] version 3.3.0 comptaibility, NPM 3 compatibility. Please update Protractor!
- allows using absolute path for helpers, output, in config and in command line. By @denis-sokolov
- Fixes 'Cannot read property '1' of null in generate.js:44' by @seethislight
Fixed global installation. CodeceptJS can now locate globally located modules. CodeceptJS is also recommended for local installation. Depending on installation type additional modules (webdriverio, protractor, ...) will be loaded either from local or from global path.
- Added
codeceptjs list
command which shows all available methods ofI
object. - [Protractor][SeleniumWebdriver] fixed closing browser instances
- [Protractor][SeleniumWebdriver]
doubleClick
method added - [WebDriverIO][Protractor][SeleniumWebdriver]
doubleClick
method to locate clickable elements by text,context
option added. - Fixed using assert in generator without yields #89
- Fixed
init
command
Breaking Change: webdriverio package removed from dependencies list. You will need to install it manually after the upgrade. Starting from 0.3.0 webdriverio is not the only backend for running selenium tests, so you are free to choose between Protractor, SeleniumWebdriver, and webdriverio and install them.
- [Protractor] helper added. Now you can test AngularJS applications by using its official library within the unigied CodeceptJS API!
- [SeleniumWebdriver] helper added. You can switch to official JS bindings for Selenium.
- [WebDriverIO] updated to webdriverio v 4.0
- [WebDriverIO]
clearField
method added by @fabioel - [WebDriverIO] added
dragAndDrop
by @fabioel - [WebDriverIO] fixed
scrollTo
method by @sensone - [WebDriverIO] fixed
windowSize: maximize
option in config - [WebDriverIO]
seeElement
anddontSeeElement
check element for visibility by @fabioel and @davertmik - [WebDriverIO]
seeElementInDOM
,dontSeeElementInDOM
added to check element exists on page. - [WebDriverIO] fixed saving screenshots on failure. Fixes #70
- fixed
within
block doesn't end in output not #79
- [WebDriverIO] added
seeNumberOfElements
by @fabioel
- process ends with exit code 1 on error or failure #49
- fixed registereing global Helper #57
- fixed handling error in within block #50
- Fixed
done() was called multiple times
- [WebDriverIO] added
waitToHide
method by @fabioel - Added global
Helper
(aliascodecept_helper)
, object use for writing custom Helpers. Generator updated. Changes to #48
- Fixed issues with using yield inside a test #45 #47 #43
- Fixed generating a custom helper. Helper class is now accessible with
codecept_helper
var. Fixes #48
- Fixed accessing helpers from custom helper by @pim.
- [WebDriverIO] fixed
seeInField
to work with single value elements like: input[type=text], textareas, and multiple: select, input[type=radio], input[type=checkbox] - [WebDriverIO] fixed
pressKey
, key modifeiers (Control, Command, Alt, Shift) are released after the action
Fixed generation of custom steps file and page objects.
Please replace require('codeceptjs/actor')
to actor
in your custom_steps.js
.
Whenever you need to create I
object (in page objects, custom steps, but not in tests) just call actor()
;
- within context hook added
--reporter
option supported- [WebDriverIO] added features and methods:
- elements:
seeElement
, ... - popups:
acceptPopup
,cancelPopup
,seeInPopup
,... - navigation:
moveCursorTo
,scrollTo
- saving screenshots on failure;
saveScreenshot
- cookies:
setCookie
,seeCookie
, ... - source:
seeInSource
- form:
seeCheckboxIsChecked
,selectOption
to support multiple selects - keyboard:
appendField
,pressKey
- mouse:
rightClick
- elements:
- tests added
- [WebDriverIO] proxy configuration added by @petehouston
- [WebDriverIO] fixed
waitForText
method by @roadhump. Fixes #11 - Fixed creating output dir when it already exists on init by @alfirin
- Fixed loading of custom helpers