codeceptjs 3.3.7 → 3.4.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/CHANGELOG.md +2422 -0
  2. package/README.md +31 -32
  3. package/docs/advanced.md +48 -24
  4. package/docs/basics.md +115 -40
  5. package/docs/best.md +2 -2
  6. package/docs/build/ApiDataFactory.js +6 -6
  7. package/docs/build/Appium.js +2 -19
  8. package/docs/build/FileSystem.js +2 -2
  9. package/docs/build/GraphQLDataFactory.js +2 -2
  10. package/docs/build/Playwright.js +3 -2
  11. package/docs/build/TestCafe.js +4 -4
  12. package/docs/build/WebDriver.js +29 -164
  13. package/docs/helpers/ApiDataFactory.md +6 -6
  14. package/docs/helpers/FileSystem.md +2 -2
  15. package/docs/helpers/GraphQLDataFactory.md +2 -2
  16. package/docs/helpers/Playwright.md +2 -1
  17. package/docs/index.md +1 -1
  18. package/docs/plugins.md +73 -48
  19. package/docs/reports.md +0 -56
  20. package/docs/typescript.md +2 -8
  21. package/lib/actor.js +2 -1
  22. package/lib/cli.js +3 -3
  23. package/lib/codecept.js +2 -1
  24. package/lib/command/generate.js +3 -1
  25. package/lib/command/gherkin/snippets.js +8 -4
  26. package/lib/command/init.js +0 -8
  27. package/lib/command/run-workers.js +3 -6
  28. package/lib/command/utils.js +0 -10
  29. package/lib/command/workers/runTests.js +2 -2
  30. package/lib/config.js +5 -1
  31. package/lib/helper/ApiDataFactory.js +7 -7
  32. package/lib/helper/Appium.js +2 -19
  33. package/lib/helper/FileSystem.js +3 -3
  34. package/lib/helper/GraphQL.js +1 -1
  35. package/lib/helper/GraphQLDataFactory.js +3 -3
  36. package/lib/helper/JSONResponse.js +1 -1
  37. package/lib/helper/Mochawesome.js +1 -1
  38. package/lib/helper/Nightmare.js +1 -1
  39. package/lib/helper/Playwright.js +4 -3
  40. package/lib/helper/Protractor.js +1 -1
  41. package/lib/helper/Puppeteer.js +1 -1
  42. package/lib/helper/REST.js +1 -1
  43. package/lib/helper/TestCafe.js +5 -5
  44. package/lib/helper/WebDriver.js +30 -165
  45. package/lib/helper.js +0 -2
  46. package/lib/interfaces/bdd.js +1 -1
  47. package/lib/interfaces/featureConfig.js +1 -0
  48. package/lib/interfaces/gherkin.js +38 -25
  49. package/lib/listener/exit.js +2 -2
  50. package/lib/listener/retry.js +67 -0
  51. package/lib/listener/steps.js +1 -1
  52. package/lib/listener/timeout.js +47 -10
  53. package/lib/mochaFactory.js +3 -3
  54. package/lib/plugin/allure.js +14 -323
  55. package/lib/plugin/fakerTransform.js +2 -2
  56. package/lib/recorder.js +1 -1
  57. package/lib/scenario.js +20 -21
  58. package/lib/utils.js +6 -0
  59. package/lib/workers.js +4 -7
  60. package/package.json +13 -17
  61. package/typings/index.d.ts +66 -1
  62. package/typings/promiseBasedTypes.d.ts +12 -12
  63. package/typings/types.d.ts +95 -262
package/CHANGELOG.md ADDED
@@ -0,0 +1,2422 @@
1
+ ## 3.4.0
2
+
3
+ * **Updated to latest mocha and modern Cucumber**
4
+ * **Allure plugin moved to [@codeceptjs/allure-legacy](https://github.com/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.
5
+ * Added ability to **[retry Before](https://codecept.io/basics/#retry-before), BeforeSuite, After, AfterSuite** hooks by @davertmik:
6
+ ```js
7
+ Feature('flaky Before & BeforeSuite', { retryBefore: 2, retryBeforeSuite: 3 })
8
+ ```
9
+
10
+ * **Flexible [retries configuration](https://codecept.io/basics/#retry-configuration) introduced** by @davertmik:
11
+
12
+ ```js
13
+ retry: [
14
+ {
15
+ // enable this config only for flaky tests
16
+ grep: '@flaky',
17
+ Before: 3 // retry Before 3 times
18
+ Scenario: 3 // retry Scenario 3 times
19
+ },
20
+ {
21
+ // retry less when running slow tests
22
+ grep: '@slow'
23
+ Scenario: 1
24
+ Before: 1
25
+ }, {
26
+ // retry all BeforeSuite 3 times
27
+ BeforeSuite: 3
28
+ }
29
+ ]
30
+ ```
31
+ * **Flexible [timeout configuration](https://codecept.io/advanced/#timeout-configuration)** introduced by @davertmik:
32
+
33
+ ```js
34
+ timeout: [
35
+ 10, // default timeout is 10secs
36
+ { // but increase timeout for slow tests
37
+ grep: '@slow',
38
+ Feature: 50
39
+ },
40
+ ]
41
+ ```
42
+
43
+ * JsDoc: Removed promise from `I.say`. See #3535 by @danielrentz
44
+ * [Playwright] `handleDownloads` requires now a filename param. See #3511 by @PeterNgTr
45
+ * [WebDriver] Added support for v8, removed support for webdriverio v5 and lower. See #3578 by @PeterNgTr
46
+
47
+
48
+ ## 3.3.7
49
+
50
+ 🛩️ Features
51
+
52
+ * **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](https://bit.ly/3XIMq6n).
53
+ * **Translation** improved to use [custom vocabulary](https://codecept.io/translation/).
54
+ * [Playwright] Added methods in #3398 by @mirao
55
+ * `restartBrowser` - to restart a browser (with different config)
56
+ * `_createContextPage` - to create a new browser context with a page from a helper
57
+ * Added [Cucumber custom types](/bdd#custom-types) for BDD in #3435 by @Likstern
58
+ * Propose using JSONResponse helper when initializing project for API testing. #3455 by @PeterNgTr
59
+ * When translation enabled, generate tests using localized aliases. By @davertmik
60
+ * [Appium] Added `checkIfAppIsInstalled` in #3507 by @PeterNgTr
61
+
62
+ 🐛 Bugfixes
63
+
64
+ * Fixed #3462 `TypeError: Cannot read properties of undefined (reading 'setStatus')` by @dwentland24 in #3438
65
+ * Fixed creating steps file for TypeScript setup #3459 by @PeterNgTr
66
+ * Fixed issue of after all event in `run-rerun` command after complete execution #3464 by @jain-neeeraj
67
+ * [Playwright][WebDriver][Appium] Do not change `waitForTimeout` value on validation. See #3478 by @pmajewski24. Fixes #2589
68
+ * [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
69
+ * [Playwright] Improved file names when downloading file in #3449 by @PeterNgTr. Fixes #3412 and #3409
70
+ * Add default value to `profile` env variable. See #3443 by @dwentland24. Resolves #3339
71
+ * [Playwright] Using system-native path separator when saving artifacts in #3460 by @PeterNgTr
72
+ * [Playwright] Saving videos and traces from multiple sessions in #3505 by @davertmik
73
+ * [Playwright] Fixed `amOnPage` to navigate to `about:blank` by @zaxoavoki in #3470 Fixes #2311
74
+ * Various typing improvements by @AWolf81 @PeterNgTr @mirao
75
+
76
+ 📖 Documentation
77
+
78
+ * Updated [Quickstart](https://codecept.io/quickstart/) with detailed explanation of questions in init
79
+ * Added [Translation](/translation/) guide
80
+ * Updated [TypeScript](https://bit.ly/3XIMq6n) guide for promise-based typings
81
+ * Reordered guides list on a website
82
+
83
+ ## 3.3.6
84
+
85
+ * [`run-rerun`](https://codecept.io/commands/#run-rerun) command was re-introduced by @dwentland24 in #3436. Use it to perform run multiple times and detect flaky tests
86
+ * Enabled `retryFailedStep` by default in `@codeceptjs/configure` v 0.10. See https://github.com/codeceptjs/configure/pull/26
87
+ * [Playwright] Fixed properties types "waitForNavigation" and "firefox" by @mirao in #3401
88
+ * [REST] Changed "endpoint" to optional by @mirao in #3404
89
+ * [REST] Use [`secret`](/secrets) for form encoded string by @PeterNgTr:
90
+
91
+ ```js
92
+ const secretData = secret('name=john&password=123456');
93
+ const response = await I.sendPostRequest('/user', secretData);
94
+ ```
95
+
96
+ * [Playwright]Fixed docs related to fixed properties types "waitForNavigation" and "firefox" by @mirao in #3407
97
+ * [Playwright]Fixed parameters of startActivity() by @mirao in #3408
98
+ * Move semver to prod dependencies by @timja in #3413
99
+ * check if browser is W3C instead of Android by @mikk150 in #3414
100
+ * Pass service configs with options and caps as array for browsers… by @07souravkunda in #3418
101
+ * fix for type of "webdriver.port" by @ngraf in #3421
102
+ * fix for type of "webdriver.smartWait" by @pmajewski24 in #3426
103
+ * fix(datatable): mask secret text by @PeterNgTr in #3432
104
+ * fix(playwright) - video name and missing type by @PeterNgTr in #3430
105
+ * fix for expected type of "bootstrap", "teardown", "bootstrapAll" and "teardownAll" by @ngraf in #3424
106
+ * Improve generate pageobject `gpo` command to work with TypeScript by @PeterNgTr in #3411
107
+ * Fixed dry-run to always return 0 code and exit
108
+ * Added minimal version notice for NodeJS >= 12
109
+ * fix(utils): remove . of test title to avoid confusion by @PeterNgTr in #3431
110
+
111
+ ## 3.3.5
112
+
113
+ 🛩️ Features
114
+
115
+ * Added **TypeScript types for CodeceptJS config**.
116
+
117
+ Update `codecept.conf.js` to get intellisense when writing config file:
118
+
119
+ ```js
120
+ /**@type {CodeceptJS.MainConfig}**/
121
+ exports.config = {
122
+ //...
123
+ }
124
+ ```
125
+ * Added TS types for helpers config:
126
+ * Playwright
127
+ * Puppeteer
128
+ * WebDriver
129
+ * REST
130
+ * Added **[TypeScript option](/typescript)** for installation via `codeceptjs init` to initialize new projects in TS (by @PeterNgTr and @davertmik)
131
+ * Includes `node-ts` automatically when using TypeScript setup.
132
+
133
+
134
+ 🐛 Bugfixes
135
+
136
+ * [Puppeteer] Fixed support for Puppeteer > 14.4 by @PeterNgTr
137
+ * Don't report files as existing when non-directory is in path by @jonathanperret. See #3374
138
+ * Fixed TS type for `secret` function by @PeterNgTr
139
+ * Fixed wrong order for async MetaSteps by @dwentland24. See #3393
140
+ * Fixed same param substitution in BDD step. See #3385 by @snehabhandge
141
+
142
+ 📖 Documentation
143
+
144
+ * Updated [configuration options](https://codecept.io/configuration/) to match TypeScript types
145
+ * Updated [TypeScript documentation](https://codecept.io/typescript/) on simplifying TS installation
146
+ * Added codecept-tesults plugin documentation by @ajeetd
147
+
148
+
149
+
150
+ ## 3.3.4
151
+
152
+ * Added support for masking fields in objects via `secret` function:
153
+
154
+ ```js
155
+ I.sendPostRequest('/auth', secret({ name: 'jon', password: '123456' }, 'password'));
156
+ ```
157
+ * Added [a guide about using of `secret`](/secrets) function
158
+ * [Appium] Use `touchClick` when interacting with elements in iOS. See #3317 by @mikk150
159
+ * [Playwright] Added `cdpConnection` option to connect over CDP. See #3309 by @Hmihaly
160
+ * [customLocator plugin] Allowed to specify multiple attributes for custom locator. Thanks to @aruiz-caritsqa
161
+
162
+ ```js
163
+ plugins: {
164
+ customLocator: {
165
+ enabled: true,
166
+ prefix: '$',
167
+ attribute: ['data-qa', 'data-test'],
168
+ }
169
+ }
170
+ ```
171
+ * [retryTo plugin] Fixed #3147 using `pollInterval` option. See #3351 by @cyonkee
172
+ * [Playwright] Fixed grabbing of browser console messages and window resize in new tab. Thanks to @mirao
173
+ * [REST] Added `prettyPrintJson` option to print JSON in nice way by @PeterNgTr
174
+ * [JSONResponse] Updated response validation to iterate over array items if response is array. Thanks to @PeterNgTr
175
+
176
+ ```js
177
+ // response.data == [
178
+ // { user: { name: 'jon', email: 'jon@doe.com' } },
179
+ // { user: { name: 'matt', email: 'matt@doe.com' } },
180
+ //]
181
+
182
+ I.seeResponseContainsKeys(['user']);
183
+ I.seeResponseContainsJson({ user: { email: 'jon@doe.com' } });
184
+ I.seeResponseContainsJson({ user: { email: 'matt@doe.com' } });
185
+ I.dontSeeResponseContainsJson({ user: 2 });
186
+ ```
187
+
188
+ ## 3.3.3
189
+
190
+ * Fixed `DataCloneError: () => could not be cloned` when running data tests in run-workers
191
+ * 🇺🇦 Added #StandWithUkraine notice to CLI
192
+
193
+
194
+ ## 3.3.2
195
+
196
+ * [REST] Fixed override of headers/token in `haveRequestHeaders()` and `amBearerAuthenticated()`. See #3304 by @mirao
197
+ * Reverted typings change introduced in #3245. [More details on this](https://twitter.com/CodeceptJS/status/1519725963856207873)
198
+
199
+ ## 3.3.1
200
+
201
+ 🛩️ Features:
202
+
203
+ * Add option to avoid duplicate gherkin step definitions (#3257) - @raywiis
204
+ * Added `step.*` for run-workers #3272. Thanks to @abhimanyupandian
205
+ * Fixed loading tests for `codecept run` using glob patterns. By @jayudey-wf
206
+
207
+ ```
208
+ npx codeceptjs run test-dir/*"
209
+ ```
210
+
211
+ * [Playwright] **Possible breaking change.** By default `timeout` is changed to 5000ms. The value set in 3.3.0 was too low. Please set `timeout` explicitly to not depend on release values.
212
+ * [Playwright] Added for color scheme option by @PeterNgTr
213
+
214
+ ```js
215
+ helpers: {
216
+ Playwright : {
217
+ url: "http://localhost",
218
+ colorScheme: "dark",
219
+ }
220
+ }
221
+ ```
222
+
223
+
224
+ 🐛 Bugfixes:
225
+
226
+ * [Playwright] Fixed `Cannot read property 'video' of undefined`
227
+ * Fixed haveRequestHeaders() and amBearerAuthenticated() of REST helper (#3260) - @mirao
228
+ * Fixed: allure attachment fails if screenshot failed #3298 by @ruudvanderweijde
229
+ * Fixed #3105 using autoLogin() plugin with TypeScript. Fix #3290 by @PeterNgTr
230
+ * [Playwright] Added extra params for click and dragAndDrop to type definitions by @mirao
231
+
232
+
233
+ 📖 Documentation
234
+ * Improving the typings in many places
235
+ * Improving the return type of helpers for TS users (#3245) - @nlespiaucq
236
+
237
+ ## 3.3.0
238
+
239
+ 🛩️ Features:
240
+
241
+ * [**API Testing introduced**](/api)
242
+ * Introduced [`JSONResponse`](/helpers/JSONResponse) helper which connects to REST, GraphQL or Playwright helper
243
+ * [REST] Added `amBearerAuthenticated` method
244
+ * [REST] Added `haveRequestHeaders` method
245
+ * Added dependency on `joi` and `chai`
246
+ * [Playwright] Added `timeout` option to set [timeout](https://playwright.dev/docs/api/class-page#page-set-default-timeout) for all Playwright actions. If an action fails, Playwright keeps retrying it for a time set by timeout.
247
+ * [Playwright] **Possible breaking change.** By default `timeout` is set to 1000ms. *Previous default was set by Playwright internally to 30s. This was causing contradiction to CodeceptJS retries, so triggered up to 3 retries for 30s of time. This timeout option was lowered so retryFailedStep plugin would not cause long delays.*
248
+ * [Playwright] Updated `restart` config option to include 3 restart strategies:
249
+ * 'context' or **false** - restarts [browser context](https://playwright.dev/docs/api/class-browsercontext) but keeps running browser. Recommended by Playwright team to keep tests isolated.
250
+ * 'browser' or **true** - closes browser and opens it again between tests.
251
+ * 'session' or 'keep' - keeps browser context and session, but cleans up cookies and localStorage between tests. The fastest option when running tests in windowed mode. Works with `keepCookies` and `keepBrowserState` options. This behavior was default prior CodeceptJS 3.1
252
+ * [Playwright] Extended methods to provide more options from engine. These methods were updated so additional options can be be passed as the last argument:
253
+ * [`click`](/helpers/Playwright#click)
254
+ * [`dragAndDrop`](/helpers/Playwright#dragAndDrop)
255
+ * [`checkOption`](/helpers/Playwright#checkOption)
256
+ * [`uncheckOption`](/helpers/Playwright#uncheckOption)
257
+
258
+ ```js
259
+ // use Playwright click options as 3rd argument
260
+ I.click('canvas', '.model', { position: { x: 20, y: 40 } })
261
+ // check option also has options
262
+ I.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } })
263
+ ```
264
+
265
+ * `eachElement` plugin introduced. It allows you to iterate over elements and perform some action on them using direct engines API
266
+
267
+ ```js
268
+ await eachElement('click all links in .list', '.list a', (el) => {
269
+ await el.click();
270
+ })
271
+ ```
272
+ * [Playwright] Added support to `playwright-core` package if `playwright` is not installed. See #3190, fixes #2663.
273
+ * [Playwright] Added `makeApiRequest` action to perform API requests. Requires Playwright >= 1.18
274
+ * Added support to `codecept.config.js` for name consistency across other JS tools. See motivation at #3195 by @JiLiZART
275
+ * [ApiDataFactory] Added options arg to `have` method. See #3197 by @JJlokidoki
276
+ * Improved pt-br translations to include keywords: 'Funcionalidade', 'Cenário', 'Antes', 'Depois', 'AntesDaSuite', 'DepoisDaSuite'. See #3206 by @danilolutz
277
+ * [allure plugin] Introduced `addStep` method to add comments and attachments. See #3104 by @EgorBodnar
278
+
279
+ 🐛 Bugfixes:
280
+
281
+ * Fixed #3212: using Regex flags for Cucumber steps. See #3214 by @anils92
282
+
283
+ 📖 Documentation
284
+
285
+ * Added [Testomat.io reporter](/reports#testomatio)
286
+ * Added [api testing](/api) guides
287
+ * Added [internal api](/internal-api) guides
288
+ * [Appium] Fixed documentation for `performSwipe`
289
+ * [Playwright] update docs for `usePlaywrightTo` method by @dbudzins
290
+
291
+ ## 3.2.3
292
+
293
+ * Documentation improvements by @maojunxyz
294
+ * Guard mocha cli reporter from registering step logger multiple times #3180 by @nikocanvacom
295
+ * [Playwright] Fixed "tracing.stop: tracing.stop: ENAMETOOLONG: name too long" by @hatufacci
296
+ * Fixed #2889: return always the same error contract from simplifyTest. See #3168 by @andremoah
297
+
298
+ ## 3.2.2
299
+
300
+ * [Playwright] Reverted removal of retry on context errors. Fixes #3130
301
+ * Timeout improvements by @nikocanvacom:
302
+ * Added priorites to timeouts
303
+ * Added `overrideStepLimits` to [stepTimeout plugin](https://codecept.io/plugins/#steptimeout) to override steps timeouts set by `limitTime`.
304
+ * Fixed step timeout not working due to override by NaN by test timeout #3126
305
+ * [Appium] Fixed logging error when `manualStart` is true. See #3140 by @nikocanvacom
306
+
307
+
308
+ ## 3.2.1
309
+
310
+ > ♻️ This release fixes hanging of tests by reducing timeouts for automatic retries on failures.
311
+
312
+ * [retryFailedStep plugin] **New Defaults**: retries steps up to 3 times with factor of 1.5 (previously 5 with factor 2)
313
+ * [Playwright] - disabled retry on failed context actions (not needed anymore)
314
+ * [Puppeteer] - reduced retries on context failures to 3 times.
315
+ * [Playwright] Handling `crash` event to automatically close crashed pages.
316
+
317
+ ## 3.2.0
318
+
319
+ 🛩️ Features:
320
+
321
+ **[Timeouts](https://codecept.io/advanced/#timeout) implemented**
322
+ * global timeouts (via `timeout` config option).
323
+ * _Breaking change:_ timeout option expects **timeout in seconds**, not in milliseconds as it was previously.
324
+ * test timeouts (via `Scenario` and `Feature` options)
325
+ * _Breaking change:_ `Feature().timeout()` and `Scenario().timeout()` calls has no effect and are deprecated
326
+
327
+ ```js
328
+ // set timeout for every test in suite to 10 secs
329
+ Feature('tests with timeout', { timeout: 10 });
330
+
331
+ // set timeout for this test to 20 secs
332
+ Scenario('a test with timeout', { timeout: 20 }, ({ I }) => {});
333
+ ```
334
+
335
+ * step timeouts (See #3059 by @nikocanvacom)
336
+
337
+ ```js
338
+ // set step timeout to 5 secs
339
+ I.limitTime(5).click('Link');
340
+ ```
341
+ * `stepTimeout` plugin introduced to automatically add timeouts for each step (#3059 by @nikocanvacom).
342
+
343
+ [**retryTo**](/plugins/#retryto) plugin introduced to rerun a set of steps on failure:
344
+
345
+ ```js
346
+ // editing in text in iframe
347
+ // if iframe was not loaded - retry 5 times
348
+ await retryTo(() => {
349
+ I.switchTo('#editor frame');
350
+ I.fillField('textarea', 'value');
351
+ }, 5);
352
+ ```
353
+
354
+ * [Playwright] added `locale` configuration
355
+ * [WebDriver] upgraded to webdriverio v7
356
+
357
+ 🐛 Bugfixes:
358
+
359
+ * Fixed allure plugin "Unexpected endStep()" error in #3098 by @abhimanyupandian
360
+ * [Puppeteer] always close remote browser on test end. See #3054 by @mattonem
361
+ * stepbyStepReport Plugin: Disabled screenshots after test has failed. See #3119 by @ioannisChalkias
362
+
363
+
364
+ ## 3.1.3
365
+
366
+ 🛩️ Features:
367
+
368
+ * BDD Improvement. Added `DataTableArgument` class to work with table data structures.
369
+
370
+ ```js
371
+ const { DataTableArgument } = require('codeceptjs');
372
+ //...
373
+ Given('I have an employee card', (table) => {
374
+ const dataTableArgument = new DataTableArgument(table);
375
+ const hashes = dataTableArgument.hashes();
376
+ // hashes = [{ name: 'Harry', surname: 'Potter', position: 'Seeker' }];
377
+ const rows = dataTableArgument.rows();
378
+ // rows = [['Harry', 'Potter', Seeker]];
379
+ }
380
+ ```
381
+ See updated [BDD section](https://codecept.io/bdd/) for more API options. Thanks to @EgorBodnar
382
+
383
+ * Support `cjs` file extensions for config file: `codecept.conf.cjs`. See #3052 by @kalvenschraut
384
+ * API updates: Added `test.file` and `suite.file` properties to `test` and `suite` objects to use in helpers and plugins.
385
+
386
+ 🐛 Bugfixes:
387
+
388
+ * [Playwright] Fixed resetting `test.artifacts` for failing tests. See #3033 by @jancorvus. Fixes #3032
389
+ * [Playwright] Apply `basicAuth` credentials to all opened browser contexts. See #3036 by @nikocanvacom. Fixes #3035
390
+ * [WebDriver] Updated `webdriverio` default version to `^6.12.1`. See #3043 by @sridhareaswaran
391
+ * [Playwright] `I.haveRequestHeaders` affects all tabs. See #3049 by @jancorvus
392
+ * BDD: Fixed unhandled empty feature files. Fix #3046 by @abhimanyupandian
393
+ * Fixed `RangeError: Invalid string length` in `recorder.js` when running huge amount of tests.
394
+ * [Appium] Fixed definitions for `touchPerform`, `hideDeviceKeyboard`, `removeApp` by @mirao
395
+
396
+ 📖 Documentation:
397
+
398
+ * Added Testrail reporter [Reports Docs](https://codecept.io/reports/#testrail)
399
+
400
+
401
+ ## 3.1.2
402
+
403
+ 🛩️ Features:
404
+
405
+ * Added `coverage` plugin to generate code coverage for Playwright & Puppeteer. By @anirudh-modi
406
+ * Added `subtitle` plugin to generate subtitles for videos recorded with Playwright. By @anirudh-modi
407
+ * Configuration: `config.tests` to accept array of file patterns. See #2994 by @monsteramba
408
+
409
+ ```js
410
+ exports.config = {
411
+ tests: ['./*_test.js','./sampleTest.js'],
412
+ // ...
413
+ }
414
+ ```
415
+ * Notification is shown for test files without `Feature()`. See #3011 by @PeterNgTr
416
+
417
+ 🐛 Bugfixes:
418
+
419
+ * [Playwright] Fixed #2986 error is thrown when deleting a missing video. Fix by @hatufacci
420
+ * Fixed false positive result when invalid function is called in a helper. See #2997 by @abhimanyupandian
421
+ * [Appium] Removed full page mode for `saveScreenshot`. See #3002 by @nlespiaucq
422
+ * [Playwright] Fixed #3003 saving trace for a test with a long name. Fix by @hatufacci
423
+
424
+ 🎱 Other:
425
+
426
+ * Deprecated `puppeteerCoverage` plugin in favor of `coverage` plugin.
427
+
428
+ ## 3.1.1
429
+
430
+ * [Appium] Fixed #2759
431
+ `grabNumberOfVisibleElements`, `grabAttributeFrom`, `grabAttributeFromAll` to allow id locators.
432
+
433
+ ## 3.1.0
434
+
435
+ * [Plawyright] Updated to Playwright 1.13
436
+ * [Playwright] **Possible breaking change**: `BrowserContext` is initialized before each test and closed after. This behavior matches recommendation from Playwright team to use different contexts for tests.
437
+ * [Puppeteer] Updated to Puppeteer 10.2.
438
+ * [Protractor] Helper deprecated
439
+
440
+ 🛩️ Features:
441
+
442
+ * [Playwright] Added recording of [video](https://codecept.io/playwright/#video) and [traces](https://codecept.io/playwright/#trace) by @davertmik
443
+ * [Playwritght] [Mocking requests](https://codecept.io/playwright/#mocking-network-requests) implemented via `route` API of Playwright by @davertmik
444
+ * [Playwright] Added **support for [React locators](https://codecept.io/react/#locators)** in #2912 by @AAAstorga
445
+
446
+ 🐛 Bugfixes:
447
+
448
+ * [Puppeteer] Fixed #2244 `els[0]._clickablePoint is not a function` by @karunandrii.
449
+ * [Puppeteer] Fixed `fillField` to check for invisible elements. See #2916 by @anne-open-xchange
450
+ * [Playwright] Reset of dialog event listener before registration of new one. #2946 by @nikocanvacom
451
+ * Fixed running Gherkin features with `run-multiple` using chunks. See #2900 by @andrenoberto
452
+ * Fixed #2937 broken typings for subfolders on Windows by @jancorvus
453
+ * Fixed issue where cucumberJsonReporter not working with fakerTransform plugin. See #2942 by @ilangv
454
+ * Fixed #2952 finished job with status code 0 when playwright cannot connect to remote wss url. By @davertmik
455
+
456
+
457
+ ## 3.0.7
458
+
459
+ 📖 Documentation fixes:
460
+
461
+ * Remove broken link from `Nightmare helper`. See #2860 by @Arhell
462
+ * Fixed broken links in `playwright.md`. See #2848 by @johnhoodjr
463
+ * Fix mocha-multi config example. See #2881 by @rimesc
464
+ * Fix small errors in email documentation file. See #2884 by @mkrtchian
465
+ * Improve documentation for `Sharing Data Between Workers` section. See #2891 by @ngraf
466
+
467
+ 🛩️ Features:
468
+
469
+ * [WebDriver] Shadow DOM Support for `Webdriver`. See #2741 by @gkushang
470
+ * [Release management] Introduce the versioning automatically, it follows the semantics versioning. See #2883 by @PeterNgTr
471
+ * Adding opts into `Scenario.skip` that it would be useful for building reports. See #2867 by @AlexKo4
472
+ * Added support for attaching screenshots to [cucumberJsonReporter](https://github.com/ktryniszewski-mdsol/codeceptjs-cucumber-json-reporter) See #2888 by @fijijavis
473
+ * Supported config file for `codeceptjs shell` command. See #2895 by @PeterNgTr:
474
+
475
+ ```
476
+ npx codeceptjs shell -c foo.conf.js
477
+ ```
478
+
479
+ Bug fixes:
480
+ * [GraphQL] Use a helper-specific instance of Axios to avoid contaminating global defaults. See #2868 by @vanvoljg
481
+ * A default system color is used when passing non supported system color when using I.say(). See #2874 by @PeterNgTr
482
+ * [Playwright] Avoid the timout due to calling the click on invisible elements. See #2875 by cbayer97
483
+
484
+
485
+ ## 3.0.6
486
+
487
+ * [Playwright] Added `electron` as a browser to config. See #2834 by @cbayer97
488
+ * [Playwright] Implemented `launchPersistentContext` to be able to launch persistent remote browsers. See #2817 by @brunoqueiros. Fixes #2376.
489
+ * Fixed printing logs and stack traces for `run-workers`. See #2857 by @haveac1gar. Fixes #2621, #2852
490
+ * Emit custom messages from worker to the main thread. See #2824 by @jccguimaraes
491
+ * Improved workers processes output. See #2804 by @drfiresign
492
+ * BDD. Added ability to use an array of feature files inside config in `gherkin.features`. See #2814 by @jbergeronjr
493
+
494
+ ```js
495
+ "features": [
496
+ "./features/*.feature",
497
+ "./features/api_features/*.feature"
498
+ ],
499
+ ```
500
+ * Added `getQueueId` to reporter to rerun a specific promise. See #2837 by @jonatask
501
+ * **Added `fakerTransform` plugin** to use faker data in Gherkin scenarios. See #2854 by @adrielcodeco
502
+
503
+ ```feature
504
+ Scenario Outline: ...
505
+ Given ...
506
+ When ...
507
+ Then ...
508
+
509
+ Examples:
510
+ | productName | customer | email | anythingMore |
511
+ | {{commerce.product}} | Dr. {{name.findName}} | {{internet.email}} | staticData |
512
+ ```
513
+ * [REST] Use class instance of axios, not the global instance, to avoid contaminating global configuration. #2846 by @vanvoljg
514
+ * [Appium] Added `tunnelIdentifier` config option to provide tunnel for SauceLabs. See #2832 by @gurjeetbains
515
+
516
+ ## 3.0.5
517
+
518
+
519
+ Features:
520
+
521
+ * **[Official Docker image for CodeceptJS v3](https://hub.docker.com/r/codeceptjs/codeceptjs)**. New Docker image is based on official Playwright image and supports Playwright, Puppeteer, WebDriver engines. Thanks @VikentyShevyrin
522
+ * Better support for Typescript `codecept.conf.ts` configuration files. See #2750 by @elaichenkov
523
+ * Propagate more events for custom parallel script. See #2796 by @jccguimaraes
524
+ * [mocha-junit-reporter] Now supports attachments, see documentation for details. See #2675 by @Shard
525
+ * CustomLocators interface for TypeScript to extend from LocatorOrString. See #2798 by @danielrentz
526
+ * [REST] Mask sensitive data from log messages.
527
+ ```js
528
+ I.sendPatchRequest('/api/users.json', secret({ "email": "user@user.com" }));
529
+ ```
530
+ See #2786 by @PeterNgTr
531
+
532
+ Bug fixes:
533
+ * Fixed reporting of nested steps with PageObjects and BDD scenarios. See #2800 by @davertmik. Fixes #2720 #2682
534
+ * Fixed issue with `codeceptjs shell` which was broken since 3.0.0. See #2743 by @stedman
535
+ * [Gherkin] Fixed issue suppressed or hidden errors in tests. See #2745 by @ktryniszewski-mdsol
536
+ * [Playwright] fix grabCssPropertyFromAll serialization by using property names. See #2757 by @elaichenkov
537
+ * [Allure] fix report for multi sessions. See #2771 by @cbayer97
538
+ * [WebDriver] Fix locator object debug log messages in smart wait. See 2748 by @elaichenkov
539
+
540
+ Documentation fixes:
541
+ * Fixed some broken examples. See #2756 by @danielrentz
542
+ * Fixed Typescript typings. See #2747, #2758 and #2769 by @elaichenkov
543
+ * Added missing type for xFeature. See #2754 by @PeterNgTr
544
+ * Fixed code example in Page Object documentation. See #2793 by @mkrtchian
545
+
546
+ Library updates:
547
+ * Updated Axios to 0.21.1. See by @sseide
548
+ * Updated @pollyjs/core @pollyjs/adapter-puppeteer. See #2760 by @Anikethana
549
+
550
+ ## 3.0.4
551
+
552
+ * **Hotfix** Fixed `init` script by adding `cross-spawn` package. By @vipulgupta2048
553
+ * Fixed handling error during initialization of `run-multiple`. See #2730 by @wagoid
554
+
555
+ ## 3.0.3
556
+
557
+ * **Playwright 1.7 support**
558
+ * [Playwright] Fixed handling null context in click. See #2667 by @matthewjf
559
+ * [Playwright] Fixed `Cannot read property '$$' of null` when locating elements. See #2713 by @matthewjf
560
+ * Command `npx codeceptjs init` improved
561
+ * auto-installing required packages
562
+ * better error messages
563
+ * fixed generating type definitions
564
+ * 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
565
+ * [Puppeteer] Fixed that `waitForFunction` was not working with number values. See #2703 by @MumblesNZ
566
+ * Enabled autocompletion for custom helpers. #2695 by @PeterNgTr
567
+ * Emit test.after on workers. Fix #2693 by @jccguimaraes
568
+ * TypeScript: Allow .ts config files. See #2708 by @elukoyanov
569
+ * Fixed definitions generation errors by @elukoyanov. See #2707 and #2718
570
+ * 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
571
+ * Emit hook.failed in workers. Fix #2723 by @jccguimaraes
572
+ * [wdio plugin] Added `seleniumArgs` and `seleniumInstallArgs` config options for plugin. See #2687 by @andrerleao
573
+ * [allure plugin] Added `addParameter` method in #2717 by @jancorvus. Fixes #2716
574
+ * Added mocha-based `--reporter-options` and `--reporter <name>` commands to `run-workers` command by in #2691 @Ameterezu
575
+ * Fixed infinite loop for junit reports. See #2691 @Ameterezu
576
+ * Added status, start/end time, and match line for BDD steps. See #2678 by @ktryniszewski-mdsol
577
+ * [stepByStepReport plugin] Fixed "helper.saveScreenshot is not a function". Fix #2688 by @andrerleao
578
+
579
+
580
+
581
+ ## 3.0.2
582
+
583
+ * [Playwright] Fix connection close with remote browser. See #2629 by @dipiash
584
+ * [REST] set maxUploadFileSize when performing api calls. See #2611 by @PeterNgTr
585
+ * Duplicate Scenario names (combined with Feature name) are now detected via a warning message.
586
+ Duplicate test names can cause `codeceptjs run-workers` to not function. See #2656 by @Georgegriff
587
+ * Documentation fixes
588
+
589
+ Bug Fixes:
590
+ * --suites flag now should function correctly for `codeceptjs run-workers`. See #2655 by @Georgegriff
591
+ * [autoLogin plugin] Login methods should now function as expected with `codeceptjs run-workers`. See #2658 by @Georgegriff, resolves #2620
592
+
593
+
594
+
595
+ ## 3.0.1
596
+
597
+ ♨️ Hot fix:
598
+ * Lock the mocha version to avoid the errors. See #2624 by PeterNgTr
599
+
600
+ 🐛 Bug Fix:
601
+ * Fixed error handling in Scenario.js. See #2607 by haveac1gar
602
+ * Changing type definition in order to allow the use of functions with any number of any arguments. See #2616 by akoltun
603
+
604
+ * Some updates/changes on documentations
605
+
606
+ ## 3.0.0
607
+ > [ 👌 **LEARN HOW TO UPGRADE TO CODECEPTJS 3 ➡**](https://bit.ly/codecept3Up)
608
+
609
+ * Playwright set to be a default engine.
610
+ * **NodeJS 12+ required**
611
+ * **BREAKING CHANGE:** Syntax for tests has changed.
612
+
613
+
614
+ ```js
615
+ // Previous
616
+ Scenario('title', (I, loginPage) => {});
617
+
618
+ // Current
619
+ Scenario('title', ({ I, loginPage }) => {});
620
+ ```
621
+
622
+ * **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 upgrade guide](https://bit.ly/codecept3Up).
623
+ * **[TypeScript guide](/typescript)** and [boilerplate project](https://github.com/codeceptjs/typescript-boilerplate)
624
+ * [tryTo](/plugins/#tryto) and [pauseOnFail](/plugins/#pauseOnFail) plugins installed by default
625
+ * Introduced one-line installer:
626
+
627
+ ```
628
+ npx create-codeceptjs .
629
+ ```
630
+
631
+ Read changelog to learn more about version 👇
632
+
633
+ ## 3.0.0-rc
634
+
635
+
636
+
637
+ * Moved [Helper class into its own package](https://github.com/codeceptjs/helper) to simplify publishing standalone helpers.
638
+ * Fixed typings for `I.say` and `I.retry` by @Vorobeyko
639
+ * Updated documentation:
640
+ * [Quickstart](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/quickstart.md#quickstart)
641
+ * [Best Practices](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/best.md)
642
+ * [Custom Helpers](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/custom-helpers.md)
643
+ * [TypeScript](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/typescript.md)
644
+
645
+ ## 3.0.0-beta.4
646
+
647
+ 🐛 Bug Fix:
648
+ * PageObject was broken when using "this" inside a simple object.
649
+ * The typings for all WebDriver methods work correctly.
650
+ * The typings for "this.helper" and helper constructor work correctly, too.
651
+
652
+ 🧤 Internal:
653
+ * Our TS Typings will be tested now! We strarted using [dtslint](https://github.com/microsoft/dtslint) to check all typings and all rules for linter.
654
+ Example:
655
+ ```ts
656
+ const psp = wd.grabPageScrollPosition() // $ExpectType Promise<PageScrollPosition>
657
+ psp.then(
658
+ result => {
659
+ result.x // $ExpectType number
660
+ result.y // $ExpectType number
661
+ }
662
+ )
663
+ ```
664
+ * And last: Reducing package size from 3.3Mb to 2.0Mb
665
+
666
+ ## 3.0.0-beta-3
667
+
668
+ * **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](https://bit.ly/codecept3Up).
669
+ * 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.
670
+ * Improved output for test execution
671
+ * Changed colors for steps output, simplified
672
+ * Added stack trace for test failures
673
+ * Removed `Event emitted` from log in `--verbose` mode
674
+ * List artifacts of a failed tests
675
+
676
+ ![](https://user-images.githubusercontent.com/220264/82160052-397bf800-989b-11ea-81c0-8e58b3d33525.png)
677
+
678
+ * Steps & metasteps refactored by @Vorobeyko. Logs to arguments passed to page objects:
679
+
680
+ ```js
681
+ // TEST:
682
+ MyPage.hasFiles('first arg', 'second arg');
683
+
684
+ // OUTPUT:
685
+ MyPage: hasFile "First arg", "Second arg"
686
+ I see file "codecept.js"
687
+ I see file "codecept.po.json"
688
+ ```
689
+ * Introduced official [TypeScript boilerplate](https://github.com/codeceptjs/typescript-boilerplate). Started by @Vorobeyko.
690
+
691
+ ## 3.0.0-beta
692
+
693
+
694
+ * **NodeJS 12+ required**
695
+ * **BREAKING CHANGE:** Syntax for tests has changed.
696
+
697
+
698
+ ```js
699
+ // Previous
700
+ Scenario('title', (I, loginPage) => {});
701
+
702
+ // Current
703
+ Scenario('title', ({ I, loginPage }) => {});
704
+ ```
705
+
706
+ * **BREAKING CHANGE:** [WebDriver][Protractor][Puppeteer][Playwright][Nightmare] `grab*` functions unified:
707
+ * `grab*From` => **returns single value** from element or throws error when no matchng elements found
708
+ * `grab*FromAll` => returns array of values, or empty array when no matching elements
709
+ * Public API for workers introduced by @koushikmohan1996. [Customize parallel execution](https://github.com/Codeception/CodeceptJS/blob/codeceptjs-v3.0/docs/parallel.md#custom-parallel-execution) with workers by building custom scripts.
710
+
711
+ * [Playwright] Added `usePlaywrightTo` method to access Playwright API in tests directly:
712
+
713
+ ```js
714
+ I.usePlaywrightTo('do something special', async ({ page }) => {
715
+ // use page or browser objects here
716
+ });
717
+ ```
718
+
719
+ * [Puppeteer] Introduced `usePuppeteerTo` method to access Puppeteer API:
720
+
721
+ ```js
722
+ I.usePuppeteerTo('do something special', async ({ page, browser }) => {
723
+ // use page or browser objects here
724
+ });
725
+ ```
726
+
727
+ * [WebDriver] Introduced `useWebDriverTo` method to access webdriverio API:
728
+
729
+ ```js
730
+ I.useWebDriverTo('do something special', async ({ browser }) => {
731
+ // use browser object here
732
+ });
733
+ ```
734
+
735
+ * [Protractor] Introduced `useProtractorTo` method to access protractor API
736
+ * `tryTo` plugin introduced. Allows conditional action execution:
737
+
738
+ ```js
739
+ const isSeen = await tryTo(() => {
740
+ I.see('Some text');
741
+ });
742
+ // we are not sure if cookie bar is displayed, but if so - accept cookies
743
+ tryTo(() => I.click('Accept', '.cookies'));
744
+ ```
745
+
746
+ * **Possible breaking change** In semantic locators `[` char indicates CSS selector.
747
+ ## 2.6.11
748
+
749
+ * [Playwright] Playwright 1.4 compatibility
750
+ * [Playwright] Added `ignoreHTTPSErrors` config option (default: false). See #2566 by gurjeetbains
751
+ * Added French translation by @vimar
752
+ * [WebDriver] Updated `dragSlider` to work in WebDriver W3C protocol. Fixes #2557 by suniljaiswal01
753
+
754
+ ## 2.6.10
755
+
756
+ * Fixed saving options for suite via `Feature('title', {key: value})` by @Diokuz. See #2553 and [Docs](https://codecept.io/advanced/#dynamic-configuration)
757
+
758
+ ## 2.6.9
759
+
760
+ * [Puppeteer][Playwright] SessionStorage is now cleared in after hook. See #2524
761
+ * When helper load failed the error stack is now logged by @SkReD. See #2541
762
+ * Small documentation fixes.
763
+
764
+ ## 2.6.8
765
+
766
+ * [WebDriver][Protractor][Playwright][Puppeteer][Nightmare] `saveElementScreenshot` method added to make screenshot of an element. By @suniljaiswal01
767
+ * [Playwright][Puppeteer] Added `type` method to type a text using keyboard with an optional delay.
768
+ * [WebDriver] Added optional `delay` argument to `type` method to slow down typing.
769
+ * [Puppeteer] Fixed `amOnPage` freeze when `getPageTimeout` is 0"; set 30 sec as default timeout by @Vorobeyko.
770
+ * Fixed printing step with null argument in custom helper by @sjana-aj. See #2494
771
+ * Fix missing screenshot on failure when REST helper is in use #2513 by @PeterNgTr
772
+ * Improve error logging in the `screenshotOnFail` plugin #2512 by @pablopaul
773
+
774
+ ## 2.6.7
775
+
776
+ * Add REST helper into `standardActingHelpers` array #2474 by @PeterNgTr
777
+ * Add missing `--invert` option for `run-workers` command #2504 by @pablopaul
778
+ * [WebDriver] Introduce `forceRightClick` method #2485 bylsuniljaiswal01
779
+ * [Playwright] Fix `setCookie` method #2491 by @bmbarker90
780
+ * [TypeScript] Update compilerOptions.target to es2017 #2483 by @shanplourde
781
+ * [Mocha] Honor reporter configuration #2465 by @trinhpham
782
+
783
+ ## 2.6.6
784
+
785
+ * Puppeteer 4.0 support. Important: MockRequest helper won't work with Puppeter > 3.3
786
+ * Added `xFeature` and `Feature.skip` to skip all tests in a suite. By @Georgegriff
787
+ * [Appium] Fixed #2428 Android native locator support by @idxn
788
+ * [WebDriver] Fixed `waitNumberOfVisibleElements` to actually filter visible elements. By @ilangv
789
+ * [Puppeteer] Fixed handling error which is not an Error object. Fixes `cannot read property indexOf of undefined` error. Fix #2436 by @Georgegriff
790
+ * [Puppeteer] Print error on page crash by @Georgegriff
791
+
792
+ ## 2.6.5
793
+
794
+ * Added `test.skipped` event to run-workers, fixing allure reports with skipped tests in workers #2391. Fix #2387 by @koushikmohan1996
795
+ * [Playwright] Fixed calling `waitFor*` methods with custom locators #2314. Fix #2389 by @Georgegriff
796
+
797
+ ## 2.6.4
798
+
799
+ * [Playwright] **Playwright 1.0 support** by @Georgegriff.
800
+
801
+ ## 2.6.3
802
+
803
+ * [stepByStepReport plugin] Fixed when using plugin with BeforeSuite. Fixes #2337 by @mirao
804
+ * [allure plugin] Fixed reporting of tests skipped by failure in before hook. Refer to #2349 & #2354. Fix by @koushikmohan1996
805
+
806
+ ## 2.6.2
807
+
808
+ * [WebDriver][Puppeteer] Added `forceClick` method to emulate click event instead of using native events.
809
+ * [Playwright] Updated to 0.14
810
+ * [Puppeteer] Updated to Puppeteer v3.0
811
+ * [wdio] Fixed undefined output directory for wdio plugns. Fix By @PeterNgTr
812
+ * [Playwright] Introduced `handleDownloads` method to download file. Please note, this method has slightly different API than the same one in Puppeteer.
813
+ * [allure] Fixed undefined output directory for allure plugin on using custom runner. Fix by @charliepradeep
814
+ * [WebDriver] Fixed `waitForEnabled` fix for webdriver 6. Fix by @dsharapkou
815
+ * Workers: Fixed negative failure result if use scenario with the same names. Fix by @Vorobeyko
816
+ * [MockRequest] Updated documentation to match new helper version
817
+ * Fixed: skipped tests are not reported if a suite failed in `before`. Refer #2349 & #2354. Fix by @koushikmohan1996
818
+
819
+ ## 2.6.1
820
+
821
+ * [screenshotOnFail plugin] Fixed saving screenshot of active session.
822
+ * [screenshotOnFail plugin] Fix issue #2301 when having the flag `uniqueScreenshotNames`=true results in `undefined` in screenshot file name by @PeterNgTr
823
+ * [WebDriver] Fixed `waitForElement` not applying the optional second argument to override the default timeout in webdriverio 6. Fix by @Mooksc
824
+ * [WebDriver] Updated `waitUntil` method which is used by all of the wait* functions. This updates the `waitForElement` by the same convention used to update `waitForVisible` and `waitInUrl` to be compatible with both WebDriverIO v5 & v6. See #2313 by @Mooksc
825
+
826
+ ## 2.6.0
827
+
828
+ * **[Playwright] Updated to Playwright 0.12** by @Georgegriff.
829
+
830
+ Upgrade playwright to ^0.12:
831
+
832
+ ```
833
+ npm i playwright@^0.12 --save
834
+ ```
835
+
836
+ [Notable changes](https://github.com/microsoft/playwright/releases/tag/v0.12.0):
837
+ * Fixed opening two browsers on start
838
+ * `executeScript` - passed function now accepts only one argument. Pass in objects or arrays if you need multtple arguments:
839
+ ```js
840
+ // Old style, does not work anymore:
841
+ I.executeScript((x, y) => x + y, x, y);
842
+ // New style, passing an object:
843
+ I.executeScript(({x, y}) => x + y, {x, y});
844
+ ```
845
+ * `click` - automatically waits for element to become clickable (visible, not animated) and waits for navigation.
846
+ * `clickLink` - deprecated
847
+ * `waitForClickable` - deprecated
848
+ * `forceClick` - added
849
+ * Added support for custom locators. See #2277
850
+ * Introduced [device emulation](/playwright/#device-emulation):
851
+ * globally via `emulate` config option
852
+ * per session
853
+
854
+ **[WebDriver] Updated to webdriverio v6** by @PeterNgTr.
855
+
856
+ Read [release notes](https://webdriver.io/blog/2020/03/26/webdriverio-v6-released.html), then
857
+ upgrade webdriverio to ^6.0:
858
+
859
+ ```
860
+ npm i webdriverio@^6.0 --save
861
+ ```
862
+ *(webdriverio v5 support is deprecated and will be removed in CodeceptJS 3.0)*
863
+
864
+ [WebDriver] Introduced [Shadow DOM support](/shadow) by @gkushang
865
+
866
+ ```js
867
+ I.click({ shadow: ['my-app', 'recipe-hello', 'button'] });
868
+ ```
869
+
870
+ * **Fixed parallel execution of `run-workers` for Gherkin** scenarios by @koushikmohan1996
871
+ * [MockRequest] Updated and **moved to [standalone package](https://github.com/codeceptjs/mock-request)**:
872
+ * full support for record/replay mode for Puppeteer
873
+ * added `mockServer` method to use flexible PollyJS API to define mocks
874
+ * fixed stale browser screen in record mode.
875
+ * [Playwright] Added support on for `screenshotOnFail` plugin by @amonkc
876
+ * Gherkin improvement: setting different tags per examples. See #2208 by @acuper
877
+ * [TestCafe] Updated `click` to take first visible element. Fixes #2226 by @theTainted
878
+ * [Puppeteer][WebDriver] Updated `waitForClickable` method to check for element overlapping. See #2261 by @PiQx
879
+ * [Puppeteer] Dropped `puppeteer-firefox` support, as Puppeteer supports Firefox natively.
880
+ * [REST] Rrespect Content-Type header. See #2262 by @pmarshall-legacy
881
+ * [allure plugin] Fixes BeforeSuite failures in allure reports. See #2248 by @Georgegriff
882
+ * [WebDriver][Puppeteer][Playwright] A screenshot of for an active session is saved in multi-session mode. See #2253 by @ChexWarrior
883
+ * Fixed `--profile` option by @pablopaul. Profile value to be passed into `run-multiple` and `run-workers`:
884
+
885
+ ```
886
+ npx codecept run-workers 2 --profile firefox
887
+ ```
888
+
889
+ Value is available at `process.env.profile` (previously `process.profile`). See #2302. Fixes #1968 #1315
890
+
891
+ * [commentStep Plugin introduced](/plugins#commentstep). Allows to annotate logical parts of a test:
892
+
893
+ ```js
894
+ __`Given`;
895
+ I.amOnPage('/profile')
896
+
897
+ __`When`;
898
+ I.click('Logout');
899
+
900
+ __`Then`;
901
+ I.see('You are logged out');
902
+ ```
903
+
904
+ ## 2.5.0
905
+
906
+ * **Experimental: [Playwright](/playwright) helper introduced**.
907
+
908
+ > [Playwright](https://github.com/microsoft/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.
909
+
910
+ * [Puppeteer] Fixed basic auth support when running in multiple sessions. See #2178 by @ian-bartholomew
911
+ * [Puppeteer] Fixed `waitForText` when there is no `body` element on page (redirect). See #2181 by @Vorobeyko
912
+ * [Selenoid plugin] Fixed overriding current capabilities by adding deepMerge. Fixes #2183 by @koushikmohan1996
913
+ * Added types for `Scenario.todo` by @Vorobeyko
914
+ * Added types for Mocha by @Vorobeyko. Fixed typing conflicts with Jest
915
+ * [FileSystem] Added methods by @nitschSB
916
+ * `waitForFile`
917
+ * `seeFileContentsEqualReferenceFile`
918
+ * Added `--colors` option to `run` and `run-multiple` so you force colored output in dockerized environment. See #2189 by @mirao
919
+ * [WebDriver] Added `type` command to enter value without focusing on a field. See #2198 by @xMutaGenx
920
+ * Fixed `codeceptjs gt` command to respect config pattern for tests. See #2200 and #2204 by @matheo
921
+
922
+
923
+ ## 2.4.3
924
+
925
+ * Hotfix for interactive pause
926
+
927
+ ## 2.4.2
928
+
929
+ * **Interactive pause improvements** by @koushikmohan1996
930
+ * allows using in page objects and variables: `pause({ loginPage, a })`
931
+ * enables custom commands inside pause with `=>` prefix: `=> loginPage.open()`
932
+ * [Selenoid plugin](/plugins#selenoid) added by by @koushikmohan1996
933
+ * uses Selenoid to launch browsers inside Docker containers
934
+ * automatically **records videos** and attaches them to allure reports
935
+ * can delete videos for successful tests
936
+ * can automatically pull in and start Selenoid containers
937
+ * works with WebDriver helper
938
+ * Avoid failiure report on successful retry in worker by @koushikmohan1996
939
+ * Added translation ability to Scenario, Feature and other context methods by @koushikmohan1996
940
+ * 📢 Please help us translate context methods to your language! See [italian translation](https://github.com/codeceptjs/CodeceptJS/blob/master/translations/it-IT.js#L3) as an example and send [patches to vocabularies](https://github.com/codeceptjs/CodeceptJS/tree/master/translations).
941
+ * allurePlugin: Added `say` comments to allure reports by @PeterNgTr.
942
+ * Fixed no custom output folder created when executed with run-worker. Fix by @PeterNgTr
943
+ * [Puppeteer] Fixed error description for context element not found. See #2065. Fix by @PeterNgTr
944
+ * [WebDriver] Fixed `waitForClickable` to wait for exact number of seconds by @mirao. Resolves #2166
945
+ * Fixed setting `compilerOptions` in `jsconfig.json` file on init by @PeterNgTr
946
+ * [Filesystem] Added method by @nitschSB
947
+ * `seeFileContentsEqualReferenceFile`
948
+ * `waitForFile`
949
+
950
+
951
+ ## 2.4.1
952
+
953
+ * [Hotfix] - Add missing lib that prevents codeceptjs from initializing.
954
+
955
+ ## 2.4.0
956
+
957
+ * Improved setup wizard with `npx codecept init`:
958
+ * **enabled [retryFailedStep](/plugins/#retryfailedstep) plugin for new setups**.
959
+ * enabled [@codeceptjs/configure](/configuration/#common-configuration-patterns) to toggle headless/window mode via env variable
960
+ * creates a new test on init
961
+ * removed question on "steps file", create it by default.
962
+ * Added [pauseOnFail plugin](/plugins/#pauseonfail). *Sponsored by Paul Vincent Beigang and his book "[Practical End 2 End Testing with CodeceptJS](https://leanpub.com/codeceptjs/)"*.
963
+ * Added [`run-rerun` command](/commands/#run-rerun) to run tests multiple times to detect and fix flaky tests. By @Ilrilan and @Vorobeyko.
964
+ * Added [`Scenario.todo()` to declare tests as pending](/basics#todotest). See #2100 by @Vorobeyko
965
+ * Added support for absolute path for `output` dir. See #2049 by @elukoyanov
966
+ * Fixed error in `npx codecept init` caused by calling `console.print`. See #2071 by @Atinux.
967
+ * [Filesystem] Methods added by @aefluke:
968
+ * `seeFileNameMatching`
969
+ * `grabFileNames`
970
+ * [Puppeteer] Fixed grabbing attributes with hyphen by @Holorium
971
+ * [TestCafe] Fixed `grabAttributeFrom` method by @elukoyanov
972
+ * [MockRequest] Added support for [Polly config options](https://netflix.github.io/pollyjs/#/configuration?id=configuration) by @ecrmnn
973
+ * [TestCafe] Fixes exiting with zero code on failure. Fixed #2090 with #2106 by @koushikmohan1996
974
+ * [WebDriver][Puppeteer] Added basicAuth support via config. Example: `basicAuth: {username: 'username', password: 'password'}`. See #1962 by @PeterNgTr
975
+ * [WebDriver][Appium] Added `scrollIntoView` by @pablopaul
976
+ * Fixed #2118: No error stack trace for syntax error by @senthillkumar
977
+ * Added `parse()` method to data table inside Cucumber tests. Use it to obtain rows and hashes for test data. See #2082 by @Sraime
978
+
979
+ ## 2.3.6
980
+
981
+ * Create better Typescript definition file through JSDoc. By @lemnis
982
+ * `run-workers` now can use glob pattern. By @Ilrilan
983
+ ```js
984
+ // Example:
985
+ exports.config = {
986
+ tests: '{./workers/base_test.workers.js,./workers/test_grep.workers.js}',
987
+ }
988
+ ```
989
+ * Added new command `npx codeceptjs info` which print information about your environment and CodeceptJS configs. By @jamesgeorge007
990
+ * Fixed some typos in documantation. By @pablopaul @atomicpages @EricTendian
991
+ * Added PULL_REQUEST template.
992
+ * [Puppeteer][WebDriver] Added `waitForClickable` for waiting clickable element on page.
993
+ * [TestCafe] Added support for remote connection. By @jvdieten
994
+ * [Puppeteer] Fixed `waitForText` XPath context now works correctly. By @Heavik
995
+ * [TestCafe] Fixed `clearField` clear field now awaits TestCafe's promise. By @orihomie
996
+ * [Puppeteer] Fixed fails when executing localStorage on services pages. See #2026
997
+ * Fixed empty tags in test name. See #2038
998
+
999
+ ## 2.3.5
1000
+
1001
+ * Set "parse-function" dependency to "5.2.11" to avoid further installation errors.
1002
+
1003
+ ## 2.3.4
1004
+
1005
+ * Fixed installation error "Cannot find module '@babel/runtime/helpers/interopRequireDefault'". The issue came from `parse-function` package. Fixed by @pablopaul.
1006
+ * [Puppeteer] Fixed switching to iframe without an ID by @johnyb. See #1974
1007
+ * Added `--profile` option to `run-workers` by @orihomie
1008
+ * Added a tag definition to `FeatureConfig` and `ScenarioConfig` by @sseliverstov
1009
+
1010
+ ## 2.3.3
1011
+
1012
+ * **[customLocator plugin](#customlocator) introduced**. Adds a locator strategy for special test attributes on elements.
1013
+
1014
+ ```js
1015
+ // when data-test-id is a special test attribute
1016
+ // enable and configure plugin to replace this
1017
+ I.click({ css: '[data-test-id=register_button]');
1018
+ // with this
1019
+ I.click('$register_button');
1020
+ ```
1021
+ * [Puppeteer][WebDriver] `pressKey` improvements by @martomo:
1022
+ Changed pressKey method to resolve issues and extend functionality.
1023
+ * Did not properly recognize 'Meta' (or 'Command') as modifier key.
1024
+ * Right modifier keys did not work in WebDriver using JsonWireProtocol.
1025
+ * 'Shift' + 'key' combination would not reflect actual keyboard behavior.
1026
+ * Respect sequence with multiple modifier keys passed to pressKey.
1027
+ * Added support to automatic change operation modifier key based on operating system.
1028
+ * [Puppeteer][WebDriver] Added `pressKeyUp` and `pressKeyDown` to press and release modifier keys like `Control` or `Shift`. By @martomo.
1029
+ * [Puppeteer][WebDriver] Added `grabElementBoundingRect` by @PeterNgTr.
1030
+ * [Puppeteer] Fixed speed degradation introduced in #1306 with accessibility locators support. See #1953.
1031
+ * Added `Config.addHook` to add a function that will update configuration on load.
1032
+ * Started [`@codeceptjs/configure`](https://github.com/codeceptjs/configure) package with a collection of common configuration patterns.
1033
+ * [TestCafe] port's management removed (left on TestCafe itself) by @orihomie. Fixes #1934.
1034
+ * [REST] Headers are no more declared as singleton variable. Fixes #1959
1035
+ * Updated Docker image to include run tests in workers with `NUMBER_OF_WORKERS` env variable. By @PeterNgTr.
1036
+
1037
+ ## 2.3.2
1038
+
1039
+ * [Puppeteer] Fixed Puppeteer 1.20 support by @davertmik
1040
+ * Fixed `run-workers` to run with complex configs. See #1887 by @nitschSB
1041
+ * Added `--suites` option to `run-workers` to split suites by workers (tests of the same suite goes to teh same worker). Thanks @nitschSB.
1042
+ * Added a guide on [Email Testing](https://codecept.io/email).
1043
+ * [retryFailedStepPlugin] Improved to ignore wait* steps and others. Also added option to ignore this plugin per test bases. See [updated documentation](https://codecept.io/plugins#retryfailedstep). By @davertmik
1044
+ * Fixed using PageObjects as classes by @Vorobeyko. See #1896
1045
+ * [WebDriver] Fixed opening more than one tab. See #1875 by @jplegoff. Fixes #1874
1046
+ * Fixed #1891 when `I.retry()` affected retries of next steps. By @davertmik
1047
+
1048
+ ## 2.3.1
1049
+
1050
+ * [MockRequest] Polly helper was renamed to MockRequest.
1051
+ * [MockRequest][WebDriver] [Mocking requests](https://codecept.io/webdriver#mocking-requests) is now available in WebDriver. Thanks @radhey1851
1052
+ * [Puppeteer] Ensure configured user agent and/or window size is applied to all pages. See #1862 by @martomo
1053
+ * Improve handling of xpath locators with round brackets by @nitschSB. See #1870
1054
+ * Use WebDriver capabilities config in wdio plugin. #1869 by @quekshuy
1055
+
1056
+ ## 2.3.0
1057
+
1058
+
1059
+ * **[Parallel testing by workers](https://codecept.io/parallel#parallel-execution-by-workers) introduced** by @VikalpP and @davertmik. Use `run-workers` command as faster and simpler alternative to `run-multiple`. Requires NodeJS v12
1060
+
1061
+ ```
1062
+ # run all tests in parallel using 3 workers
1063
+ npx codeceptjs run-workers 3
1064
+ ```
1065
+ * [GraphQL][GraphQLDataFactory] **Helpers for data management over GraphQL** APIs added. By @radhey1851.
1066
+ * Learn how to [use GraphQL helper](https://codecept.io/data#graphql) to access GarphQL API
1067
+ * And how to combine it with [GraphQLDataFactory](https://codecept.io/data#graphql-data-factory) to generate and persist test data.
1068
+ * **Updated to use Mocha 6**. See #1802 by @elukoyanov
1069
+ * Added `dry-run` command to print steps of test scenarios without running them. Fails to execute scenarios with `grab*` methods or custom code. See #1825 for more details.
1070
+
1071
+ ```
1072
+ npx codeceptjs dry-run
1073
+ ```
1074
+
1075
+ * [Appium] Optimization when clicking, searching for fields by accessibility id. See #1777 by @gagandeepsingh26
1076
+ * [TestCafe] Fixed `switchTo` by @KadoBOT
1077
+ * [WebDriver] Added geolocation actions by @PeterNgTr
1078
+ * `grabGeoLocation()`
1079
+ * `setGeoLocation()`
1080
+ * [Polly] Check typeof arguments for mock requests by @VikalpP. Fixes #1815
1081
+ * CLI improvements by @jamesgeorge007
1082
+ * `codeceptjs` command prints list of all available commands
1083
+ * added `codeceptjs -V` flag to print version information
1084
+ * warns on unknown command
1085
+ * Added TypeScript files support to `run-multiple` by @z4o4z
1086
+ * Fixed element position bug in locator builder. See #1829 by @AnotherAnkor
1087
+ * Various TypeScript typings updates by @elukoyanov and @Vorobeyko
1088
+ * Added `event.step.comment` event for all comment steps like `I.say` or gherking steps.
1089
+
1090
+ ## 2.2.1
1091
+
1092
+ * [WebDriver] A [dedicated guide](https://codecept.io/webdriver) written.
1093
+ * [TestCafe] A [dedicated guide](https://codecept.io/testcafe) written.
1094
+ * [Puppeteer] A [chapter on mocking](https://codecept.io/puppeteer#mocking-requests) written
1095
+ * [Puppeteer][Nightmare][TestCafe] Window mode is enabled by default on `codeceptjs init`.
1096
+ * [TestCafe] Actions implemented by @hubidu
1097
+ * `grabPageScrollPosition`
1098
+ * `scrollPageToTop`
1099
+ * `scrollPageToBottom`
1100
+ * `scrollTo`
1101
+ * `switchTo`
1102
+ * Intellisense improvements. Renamed `tsconfig.json` to `jsconfig.json` on init. Fixed autocompletion for Visual Studio Code.
1103
+ * [Polly] Take configuration values from Puppeteer. Fix #1766 by @VikalpP
1104
+ * [Polly] Add preconditions to check for puppeteer page availability by @VikalpP. Fixes #1767
1105
+ * [WebDriver] Use filename for `uploadFile` by @VikalpP. See #1797
1106
+ * [Puppeteer] Configure speed of input with `pressKeyDelay` option. By @hubidu
1107
+ * Fixed recursive loading of support objects by @davertmik.
1108
+ * Fixed support object definitions in steps.d.ts by @johnyb. Fixes #1795
1109
+ * Fixed `Data().Scenario().injectDependencies()` is not a function by @andrerleao
1110
+ * Fixed crash when using xScenario & Scenario.skip with tag by @VikalpP. Fixes #1751
1111
+ * Dynamic configuration of helpers can be performed with async function. See #1786 by @cviejo
1112
+ * Added TS definitions for internal objects by @Vorobeyko
1113
+ * BDD improvements:
1114
+ * Fix for snippets command with a .feature file that has special characters by @asselin
1115
+ * Fix `--path` option on `gherkin:snippets` command by @asselin. See #1790
1116
+ * Added `--feature` option to `gherkin:snippets` to enable creating snippets for a subset of .feature files. See #1803 by @asselin.
1117
+ * Fixed: dynamic configs not reset after test. Fixes #1776 by @cviejo.
1118
+
1119
+ ## 2.2.0
1120
+
1121
+ * **EXPERIMENTAL** [**TestCafe** helper](https://codecept.io/helpers/TestCafe) 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.
1122
+ * [Puppeteer] Mocking requests enabled by introducing [Polly.js helper](https://codecept.io/helpers/Polly). Thanks @VikalpP
1123
+
1124
+ ```js
1125
+ // use Polly & Puppeteer helpers
1126
+ I.mockRequest('GET', '/api/users', 200);
1127
+ I.mockRequest('POST', '/users', { user: { name: 'fake' }});
1128
+ ```
1129
+
1130
+ * **EXPERIMENTAL** [Puppeteer] [Firefox support](https://codecept.io/helpers/Puppeteer-firefox) introduced by @ngadiyak, see #1740
1131
+ * [stepByStepReportPlugin] use md5 hash to generate reports into unique folder. Fix #1744 by @chimurai
1132
+ * Interactive pause improvements:
1133
+ * print result of `grab` commands
1134
+ * print message for successful assertions
1135
+ * `run-multiple` (parallel execution) improvements:
1136
+ * `bootstrapAll` must be called before creating chunks. #1741 by @Vorobeyko
1137
+ * Bugfix: If value in config has falsy value then multiple config does not overwrite original value. #1756 by @LukoyanovE
1138
+ * Fixed hooks broken in 2.1.5 by @Vorobeyko
1139
+ * Fix references to support objects when using Dependency Injection. Fix by @johnyb. See #1701
1140
+ * Fix dynamic config applied for multiple helpers by @VikalpP #1743
1141
+
1142
+
1143
+ ## 2.1.5
1144
+
1145
+ * **EXPERIMENTAL** [Wix Detox support](https://github.com/codeceptjs/detox-helper) introduced as standalone helper. Provides a faster alternative to Appium for mobile testing.
1146
+ * Saving successful commands inside interactive pause into `_output/cli-history` file. By @hubidu
1147
+ * Fixed hanging error handler inside scenario. See #1721 by @haily-lgc.
1148
+ * Fixed by @Vorobeyko: tests did not fail when an exception was raised in async bootstrap.
1149
+ * [WebDriver] Added window control methods by @emmonspired
1150
+ * `grabAllWindowHandles` returns all window handles
1151
+ * `grabCurrentWindowHandle` returns current window handle
1152
+ * `switchToWindow` switched to window by its handle
1153
+ * [Appium] Fixed using `host` as configuration by @trinhpham
1154
+ * Fixed `run-multiple` command when `tests` config option is undefined (in Gherkin scenarios). By @gkushang.
1155
+ * German translation introduced by @hubidu
1156
+
1157
+ ## 2.1.4
1158
+
1159
+ * [WebDriver][Puppeteer][Protractor][Nightmare] A11y locator support introduced by @Holorium. Clickable elements as well as fields can be located by following attributes:
1160
+ * `aria-label`
1161
+ * `title`
1162
+ * `aria-labelledby`
1163
+ * [Puppeteer] Added support for React locators.
1164
+ * New [React Guide](https://codecept.io/react) added.
1165
+ * [Puppeteer] Deprecated `downloadFile`
1166
+ * [Puppeteer] Introduced `handleDownloads` replacing `downloadFile`
1167
+ * [puppeteerCoverage plugin] Fixed path already exists error by @seta-tuha.
1168
+ * Fixed 'ERROR: ENAMETOOLONG' creating directory names in `run-multiple` with long config. By @artvinn
1169
+ * [REST] Fixed url autocompletion combining base and relative paths by @LukoyanovE
1170
+ * [Nightmare][Protractor] `uncheckOption` method introduced by @PeterNgTr
1171
+ * [autoLogin plugin] Enable to use without `await` by @tsuemura
1172
+ * [Puppeteer] Fixed `UnhandledPromiseRejectionWarning: "Execution context was destroyed...` by @adrielcodeco
1173
+ * [WebDriver] Keep browser window dimensions when starting a new session by @spiroid
1174
+ * Replace Ghekrin plceholders with values in files that combine a scenerio outline and table by @medtoure18.
1175
+ * Added Documentation to [locate elements in React Native](https://codecept.io/mobile-react-native-locators) apps. By @DimGun.
1176
+ * Adding optional `path` parameter to `bdd:snippets` command to append snippets to a specific file. By @cthorsen31.
1177
+ * Added optional `output` parameter to `def` command by @LukoyanovE.
1178
+ * [Puppeteer] Added `grabDataFromPerformanceTiming` by @PeterNgTr.
1179
+ * axios updated to `0.19.0` by @SteveShaffer
1180
+ * TypeScript defitions updated by @LukoyanovE. Added `secret` and `inject` function.
1181
+
1182
+ ## 2.1.3
1183
+
1184
+ * Fixed autoLogin plugin to inject `login` function
1185
+ * Fixed using `toString()` in DataTablewhen it is defined by @tsuemura
1186
+
1187
+ ## 2.1.2
1188
+
1189
+ * Fixed `inject` to load objects recursively.
1190
+ * Fixed TypeScript definitions for locators by @LukoyanovE
1191
+ * **EXPERIMENTAL** [WebDriver] ReactJS locators support with webdriverio v5.8+:
1192
+
1193
+ ```js
1194
+ // locating React element by name, prop, state
1195
+ I.click({ react: 'component-name', props: {}, state: {} });
1196
+ I.seeElement({ react: 'component-name', props: {}, state: {} });
1197
+ ```
1198
+
1199
+ ## 2.1.1
1200
+
1201
+ * Do not retry `within` and `session` calls inside `retryFailedStep` plugin. Fix by @tsuemura
1202
+
1203
+ ## 2.1.0
1204
+
1205
+ * Added global `inject()` function to require actor and page objects using dependency injection. Recommended to use in page objects, step definition files, support objects:
1206
+
1207
+ ```js
1208
+ // old way
1209
+ const I = actor();
1210
+ const myPage = require('../page/myPage');
1211
+
1212
+ // new way
1213
+ const { I, myPage } = inject();
1214
+ ```
1215
+
1216
+ * Added global `secret` function to fill in sensitive data. By @RohanHart:
1217
+
1218
+ ```js
1219
+ I.fillField('password', secret('123456'));
1220
+ ```
1221
+
1222
+ * [wdioPlugin](https://codecept.io/plugins/#wdio) Added a plugin to **support webdriverio services** including *selenium-standalone*, *sauce*, *browserstack*, etc. **Sponsored by @GSasu**
1223
+ * [Appium] Fixed `swipe*` methods by @PeterNgTr
1224
+ * BDD Gherkin Improvements:
1225
+ * Implemented `run-multiple` for feature files. **Sponsored by @GSasu**
1226
+ * Added `--features` and `--tests` options to `run-multiple`. **Sponsored by @GSasu**
1227
+ * Implemented `Before` and `After` hooks in [step definitions](https://codecept.io/bdd#before)
1228
+ * Fixed running tests by absolute path. By @batalov.
1229
+ * Enabled the adding screenshot to failed test for moch-junit-reporter by @PeterNgTr.
1230
+ * [Puppeteer] Implemented `uncheckOption` and fixed behavior of `checkOption` by @aml2610
1231
+ * [WebDriver] Fixed `seeTextEquals` on empty strings by @PeterNgTr
1232
+ * [Puppeteer] Fixed launch with `browserWSEndpoint` config by @ngadiyak.
1233
+ * [Puppeteer] Fixed switching back to main window in multi-session mode by @davertmik.
1234
+ * [autoLoginPlugin] Fixed using async functions for auto login by @nitschSB
1235
+
1236
+ > This release was partly sponsored by @GSasu. Thanks for the support!
1237
+ Do you want to improve this project? [Learn more about sponsorin CodeceptJS
1238
+
1239
+
1240
+ ## 2.0.8
1241
+
1242
+ * [Puppeteer] Added `downloadFile` action by @PeterNgTr.
1243
+
1244
+ Use it with `FileSystem` helper to test availability of a file:
1245
+ ```js
1246
+ const fileName = await I.downloadFile('a.file-link');
1247
+ I.amInPath('output');
1248
+ I.seeFile(fileName);
1249
+ ```
1250
+ > Actions `amInPath` and `seeFile` are taken from [FileSystem](https://codecept.io/helpers/FileSystem) helper
1251
+
1252
+ * [Puppeteer] Fixed `autoLogin` plugin with Puppeteer by @davertmik
1253
+ * [WebDriver] `seeInField` should throw error if element has no value attrubite. By @PeterNgTr
1254
+ * [WebDriver] Fixed `seeTextEquals` passes for any string if element is empty by @PeterNgTr.
1255
+ * [WebDriver] Internal refctoring to use `el.isDisplayed` to match latest webdriverio implementation. Thanks to @LukoyanovE
1256
+ * [allure plugin] Add ability enable [screenshotDiff plugin](https://github.com/allure-framework/allure2/blob/master/plugins/screen-diff-plugin/README.md) by @Vorobeyko
1257
+ * [Appium] Fixed `locator.stringify` call by @LukoyanovE
1258
+
1259
+ ## 2.0.7
1260
+
1261
+ * [WebDriver][Protractor][Nightmare] `rightClick` method implemented (fixed) in a standard way. By @davertmik
1262
+ * [WebDriver] Updated WebDriver API calls in helper. By @PeterNgTr
1263
+ * [stepByStepReportPlugin] Added `screenshotsForAllureReport` config options to automatically attach screenshots to allure reports. By @PeterNgTr
1264
+ * [allurePlugin] Added `addLabel` method by @Vorobeyko
1265
+ * Locator Builder: fixed `withChild` and `withDescendant` to match deep nested siblings by @Vorobeyko.
1266
+
1267
+ ## 2.0.6
1268
+
1269
+ * Introduced [Custom Locator Strategies](https://codecept.io/locators#custom-locators).
1270
+ * Added [Visual Testing Guide](https://codecept.io/visual) by @puneet0191 and @MitkoTschimev.
1271
+ * [Puppeteer] [`puppeteerCoverage`](https://codecept.io/plugins#puppeteercoverage) plugin added to collect code coverage in JS. By @dvillarama
1272
+ * Make override option in `run-multiple` to respect the generated overridden config by @kinyat
1273
+ * Fixed deep merge for `container.append()`. Introduced `lodash.merge()`. By @Vorobeyko
1274
+ * Fixed saving screenshot on Windows by
1275
+ * Fix errors on using interactive shell with Allure plugin by tsuemura
1276
+ * Fixed using dynamic injections with `Scenario().injectDependencies` by @tsemura
1277
+ * [WebDriver][Puppeteer][Nightmare][Protractor] Fixed url protocol detection for non-http urls by @LukoyanovE
1278
+ * [WebDriver] Enabled compatibility with `stepByStepReport` by @tsuemura
1279
+ * [WebDriver] Fixed `grabHTMLFrom` to return innerHTML value by @Holorium. Fixed compatibility with WebDriverIO.
1280
+ * [WebDriver] `grabHTMLFrom` to return one HTML vlaue for one element matched, array if multiple elements found by @davertmik.
1281
+ * [Nightmare] Added `grabHTMLFrom` by @davertmik
1282
+ * Fixed `bootstrapAll` and `teardownAll` launch with path as argument by @LukoyanovE
1283
+ * Fixed `bootstrapAll` and `teardownAll` calls from exported object by @LukoyanovE
1284
+ * [WebDriver] Added possibility to define conditional checks interval for `waitUntil` by @LukoyanovE
1285
+ * Fixed storing current data in data driven tests in a test object. By @Vorobeyko
1286
+ * [WebDriver] Fixed `hostname` config option overwrite when setting a cloud provider. By @LukoyanovE
1287
+ * [WebDriver] `dragSlider` method implemented by @DavertMik
1288
+ * [WebDrover] Fixed `scrollTo` to use new webdriverio API by @PeterNgTr
1289
+ * Added Japanese translation file by @tsemura
1290
+ * Added `Locator.withDescendant()` method to find an element which contains a descendant (child, grandchild) by @Vorobeyko
1291
+ * [WebDriver] Fixed configuring capabilities for Selenoid and IE by @Vorobeyko
1292
+ * [WebDriver] Restore original window size when taking full size screenshot by @tsuemura
1293
+ * Enabled `throws()`,` fails()`, `retry()`, `timeout()`, `config()` functions for data driven tests. By @jjm409
1294
+
1295
+ ## 2.0.5
1296
+
1297
+ [Broken Release]
1298
+
1299
+ ## 2.0.4
1300
+
1301
+ * [WebDriver][Protractor][Nightmare][Puppeteer] `grabAttributeFrom` returns an array when multiple elements matched. By @PeterNgTr
1302
+ * [autoLogin plugin] Fixed merging users config by @nealfennimore
1303
+ * [autoDelay plugin] Added WebDriver to list of supported helpers by @mattin4d
1304
+ * [Appium] Fixed using locators in `waitForElement`, `waitForVisible`, `waitForInvisible`. By @eduardofinotti
1305
+ * [allure plugin] Add tags to allure reports by @Vorobeyko
1306
+ * [allure plugin] Add skipped tests to allure reports by @Vorobeyko
1307
+ * Fixed `Logged Test name | [object Object]` when used Data().Scenario(). By @Vorobeyko
1308
+ * Fixed Data().only.Scenario() to run for all datasets. By @Vorobeyko
1309
+ * [WebDriver] `attachFile` to work with hidden elements. Fixed in #1460 by @tsuemura
1310
+
1311
+
1312
+
1313
+ ## 2.0.3
1314
+
1315
+ * [**autoLogin plugin**](https://codecept.io/plugins#autologin) 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.
1316
+ * Fixed `Maximum stack trace` issue in `retryFailedStep` plugin.
1317
+ * Added `locate()` function into the interactive shell.
1318
+ * [WebDriver] Disabled smartWait for interactive shell.
1319
+ * [Appium] Updated methods to use for mobile locators
1320
+ * `waitForElement`
1321
+ * `waitForVisible`
1322
+ * `waitForInvisible`
1323
+ * Helper and page object generators no longer update config automatically. Please add your page objects and helpers manually.
1324
+
1325
+ ## 2.0.2
1326
+
1327
+ * [Puppeteer] Improved handling of connection with remote browser using Puppeteer by @martomo
1328
+ * [WebDriver] Updated to webdriverio 5.2.2 by @martomo
1329
+ * Interactive pause improvements by @davertmik
1330
+ * Disable retryFailedStep plugin in in interactive mode
1331
+ * Removes `Interface: parseInput` while in interactive pause
1332
+ * [ApiDataFactory] Improvements
1333
+ * added `fetchId` config option to override id retrieval from payload
1334
+ * added `onRequest` config option to update request in realtime
1335
+ * added `returnId` config option to return ids of created items instead of items themvelves
1336
+ * added `headers` config option to override default headers.
1337
+ * added a new chapter into [DataManagement](https://codecept.io/data#api-requests-using-browser-session)
1338
+ * [REST] Added `onRequest` config option
1339
+
1340
+
1341
+ ## 2.0.1
1342
+
1343
+ * Fixed creating project with `codecept init`.
1344
+ * Fixed error while installing webdriverio@5.
1345
+ * Added code beautifier for generated configs.
1346
+ * [WebDriver] Updated to webdriverio 5.1.0
1347
+
1348
+ ## 2.0.0
1349
+
1350
+ * [WebDriver] **Breaking Change.** Updated to webdriverio v5. New helper **WebDriver** helper introduced.
1351
+
1352
+ * **Upgrade plan**:
1353
+
1354
+ 1. Install latest webdriverio
1355
+ ```
1356
+ npm install webdriverio@5 --save
1357
+ ```
1358
+
1359
+ 2. Replace `WebDriverIO` => `WebDriver` helper name in config.
1360
+ 3. Read [webdriverio changelog](https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md). If you were using webdriver API in your helpers, upgrade accordingly.
1361
+ 4. We made WebDriver helper to be compatible with old API so no additional changes required.
1362
+
1363
+ > 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.
1364
+
1365
+ * Known issues: `attachFile` doesn't work with proxy server.
1366
+
1367
+ * [Appium] **Breaking Change.** Updated to use webdriverio v5 as well. See upgrade plan ↑
1368
+ * [REST] **Breaking Change.** Replaced `unirest` library with `axios`.
1369
+
1370
+ * **Upgrade plan**:
1371
+
1372
+ 1. Refer to [axios API](https://github.com/axios/axios).
1373
+ 2. If you were using `unirest` requests/responses in your tests change them to axios format.
1374
+ * **Breaking Change.** Generators support in tests removed. Use `async/await` in your tests
1375
+ * **Using `codecept.conf.js` as default configuration format**
1376
+ * Fixed "enametoolong" error when saving screenshots for data driven tests by @PeterNgTr
1377
+ * Updated NodeJS to 10 in Docker image
1378
+ * [Pupeteer] Add support to use WSEndpoint. Allows to execute tests remotely. [See #1350] by @gabrielcaires (https://github.com/codeceptjs/CodeceptJS/pull/1350)
1379
+ * In interactive shell [Enter] goes to next step. Improvement by @PeterNgTr.
1380
+ * `I.say` accepts second parameter as color to print colorful comments. Improvement by @PeterNgTr.
1381
+
1382
+ ```js
1383
+ I.say('This is red', 'red'); //red is used
1384
+ I.say('This is blue', 'blue'); //blue is used
1385
+ I.say('This is by default'); //cyan is used
1386
+ ```
1387
+ * Fixed allure reports for multi session testing by @PeterNgTr
1388
+ * Fixed allure reports for hooks by @PeterNgTr
1389
+
1390
+ ## 1.4.6
1391
+
1392
+ * [Puppeteer] `dragSlider` action added by @PeterNgTr
1393
+ * [Puppeteer] Fixed opening browser in shell mode by @allenhwkim
1394
+ * [Puppeteer] Fixed making screenshot on additional sessions by @PeterNgTr. Fixes #1266
1395
+ * Added `--invert` option to `run-multiple` command by @LukoyanovE
1396
+ * Fixed steps in Allure reports by @PeterNgTr
1397
+ * Add option `output` to customize output directory in [stepByStepReport plugin](https://codecept.io/plugins/#stepbystepreport). By @fpsthirty
1398
+ * Changed type definition of PageObjects to get auto completion by @rhicu
1399
+ * Fixed steps output for async/arrow functions in CLI by @LukoyanovE. See #1329
1400
+
1401
+ ## 1.4.5
1402
+
1403
+ * Add **require** param to main config. Allows to require Node modules before executing tests. By @LukoyanovE. For example:
1404
+ * Use `ts-node/register` to register TypeScript parser
1405
+ * Use `should` to register should-style assertions
1406
+
1407
+ ```js
1408
+ "require": ["ts-node/register", "should"]
1409
+ ```
1410
+
1411
+ * [WebDriverIO] Fix timeouts definition to be compatible with W3C drivers. By @LukoyanovE
1412
+ * Fixed: exception in Before block w/ Mocha causes test not to report failure. See #1292 by @PeterNgTr
1413
+ * Command `run-parallel` now accepts `--override` flag. Thanks to @ClemCB
1414
+ * Fixed Allure report with Before/BeforeSuite/After/AfterSuite steps. By @PeterNgTr
1415
+ * Added `RUN_MULTIPLE` env variable to [Docker config](https://codecept.io/docker/). Allows to run tests in parallel inside a container. Thanks to @PeterNgTr
1416
+ * [Mochawesome] Fixed showing screenshot on failure. Fix by @PeterNgTr
1417
+ * Fixed running tests filtering by tag names defined via `Scenario.tag()`
1418
+
1419
+ ## 1.4.4
1420
+
1421
+ * [autoDelay plugin](https://codecept.io/plugins/#autoDelay) added. Adds tiny delay before and after an action so the page could react to actions performed.
1422
+ * [Puppeteer] improvements by @luismanuel001
1423
+ * `click` no longer waits for navigation
1424
+ * `clickLink` method added. Performs a click and waits for navigation.
1425
+ * Bootstrap scripts to be started only for `run` command and ignored on `list`, `def`, etc. Fix by @LukoyanovE
1426
+
1427
+
1428
+ ## 1.4.3
1429
+
1430
+ * Groups renamed to Tags for compatibility with BDD layer
1431
+ * Test and suite objects to contain tags property which can be accessed from internal API
1432
+ * Fixed adding tags for Scenario Outline in BDD
1433
+ * Added `tag()` method to ScenarioConfig and FeatureConfig:
1434
+
1435
+ ```js
1436
+ Scenario('update user profile', () => {
1437
+ // test goes here
1438
+ }).tag('@slow');
1439
+ ```
1440
+
1441
+ * Fixed attaching Allure screenshot on exception. Fix by @DevinWatson
1442
+ * Improved type definitions for custom steps. By @Akxe
1443
+ * Fixed setting `multiple.parallel.chunks` as environment variable in config. See #1238 by @ngadiyak
1444
+
1445
+ ## 1.4.2
1446
+
1447
+ * Fixed setting config for plugins (inclunding setting `outputDir` for allure) by @jplegoff
1448
+
1449
+ ## 1.4.1
1450
+
1451
+ * Added `plugins` option to `run-multiple`
1452
+ * Minor output fixes
1453
+ * Added Type Definition for Helper class by @Akxe
1454
+ * Fixed extracing devault extension in generators by @Akxe
1455
+
1456
+ ## 1.4.0
1457
+
1458
+ * [**Allure Reporter Integration**](https://codecept.io/reports/#allure). 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.
1459
+ * [Plugins API introduced](https://codecept.io/hooks/#plugins). Create custom plugins for CodeceptJS by hooking into event dispatcher, and using promise recorder.
1460
+ * **Official [CodeceptJS plugins](https://codecept.io/plugins) added**:
1461
+ * **`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.
1462
+ * `allure` - Allure reporter added as plugin.
1463
+ * `screenshotOnFail` - saves screenshot on fail. Replaces similar functionality from helpers.
1464
+ * `retryFailedStep` - to rerun each failed step.
1465
+ * [Puppeteer] Fix `executeAsyncScript` unexpected token by @jonathanz
1466
+ * Added `override` option to `run-multiple` command by @svarlet
1467
+
1468
+ ## 1.3.3
1469
+
1470
+ * Added `initGlobals()` function to API of [custom runner](https://codecept.io/hooks/#custom-runner).
1471
+
1472
+ ## 1.3.2
1473
+
1474
+ * Interactve Shell improvements for `pause()`
1475
+ * Added `next` command for **step-by-step debug** when using `pause()`.
1476
+ * Use `After(pause);` in a to start interactive console after last step.
1477
+ * [Puppeteer] Updated to Puppeteer 1.6.0
1478
+ * Added `waitForRequest` to wait for network request.
1479
+ * Added `waitForResponse` to wait for network response.
1480
+ * Improved TypeScript definitions to support custom steps and page objects. By @xt1
1481
+ * Fixed XPath detection to accept XPath which starts with `./` by @BenoitZugmeyer
1482
+
1483
+ ## 1.3.1
1484
+
1485
+ * BDD-Gherkin: Fixed running async steps.
1486
+ * [Puppeteer] Fixed process hanging for 30 seconds. Page loading timeout default via `getPageTimeout` set 0 seconds.
1487
+ * [Puppeteer] Improved displaying client-side console messages in debug mode.
1488
+ * [Puppeteer] Fixed closing sessions in `restart:false` mode for multi-session mode.
1489
+ * [Protractor] Fixed `grabPopupText` to not throw error popup is not opened.
1490
+ * [Protractor] Added info on using 'direct' Protractor driver to helper documentation by @xt1.
1491
+ * [WebDriverIO] Added a list of all special keys to WebDriverIO helper by @davertmik and @xt1.
1492
+ * Improved TypeScript definitions generator by @xt1
1493
+
1494
+ ## 1.3.0
1495
+
1496
+ * **Cucumber-style BDD. Introduced [Gherkin support](https://codecept.io/bdd). Thanks to [David Vins](https://github.com/dvins) and [Omedym](https://www.omedym.com) for sponsoring this feature**.
1497
+
1498
+ Basic feature file:
1499
+
1500
+ ```gherkin
1501
+ Feature: Business rules
1502
+ In order to achieve my goals
1503
+ As a persona
1504
+ I want to be able to interact with a system
1505
+
1506
+ Scenario: do anything in my life
1507
+ Given I need to open Google
1508
+ ```
1509
+
1510
+ Step definition:
1511
+
1512
+ ```js
1513
+ const I = actor();
1514
+
1515
+ Given('I need to open Google', () => {
1516
+ I.amOnPage('https://google.com');
1517
+ });
1518
+ ```
1519
+
1520
+ Run it with `--features --steps` flag:
1521
+
1522
+ ```
1523
+ codeceptjs run --steps --features
1524
+ ```
1525
+
1526
+ ---
1527
+
1528
+ * **Brekaing Chnage** `run` command now uses relative path + test name to run exactly one test file.
1529
+
1530
+ Previous behavior (removed):
1531
+ ```
1532
+ codeceptjs run basic_test.js
1533
+ ```
1534
+ Current behavior (relative path to config + a test name)
1535
+
1536
+ ```
1537
+ codeceptjs run tests/basic_test.js
1538
+ ```
1539
+ This change allows using auto-completion when running a specific test.
1540
+
1541
+ ---
1542
+
1543
+ * Nested steps output enabled for page objects.
1544
+ * to see high-level steps only run tests with `--steps` flag.
1545
+ * to see PageObjects implementation run tests with `--debug`.
1546
+ * PageObjects simplified to remove `_init()` extra method. Try updated generators and see [updated guide](https://codecept.io/pageobjects/#pageobject).
1547
+ * [Puppeteer] [Multiple sessions](https://codecept.io/acceptance/#multiple-sessions) enabled. Requires Puppeteer >= 1.5
1548
+ * [Puppeteer] Stability improvement. Waits for for `load` event on page load. This strategy can be changed in config:
1549
+ * `waitForNavigation` config option introduced. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions)
1550
+ * `getPageTimeout` config option to set maximum navigation time in milliseconds. Default is 30 seconds.
1551
+ * `waitForNavigation` method added. Explicitly waits for navigation to be finished.
1552
+ * [WebDriverIO][Protractor][Puppeteer][Nightmare] **Possible BC** `grabTextFrom` unified. Return a text for single matched element and an array of texts for multiple elements.
1553
+ * [Puppeteer]Fixed `resizeWindow` by @sergejkaravajnij
1554
+ * [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForFunction` added. Waits for client-side JavaScript function to return true by @GREENpoint.
1555
+ * [Puppeteer] `waitUntil` deprecated in favor of `waitForFunction`.
1556
+ * Added `filter` function to DataTable.
1557
+ * Send non-nested array of files to custom parallel execution chunking by @mikecbrant.
1558
+ * Fixed invalid output directory path for run-multiple by @mikecbrant.
1559
+ * [WebDriverIO] `waitUntil` timeout accepts time in seconds (as all other wait* functions). Fix by @truesrc.
1560
+ * [Nightmare] Fixed `grabNumberOfVisibleElements` to work similarly to `seeElement`. Thx to @stefanschenk and Jinbo Jinboson.
1561
+ * [Protractor] Fixed alert handling error with message 'no such alert' by @truesrc.
1562
+
1563
+
1564
+ ## 1.2.1
1565
+
1566
+ * Fixed running `I.retry()` on multiple steps.
1567
+ * Fixed parallel execution wih chunks.
1568
+ * [Puppeteer] Fixed `grabNumberOfVisibleElements` to return `0` instead of throwing error if no elements are found.
1569
+
1570
+ ## 1.2.0
1571
+
1572
+ * [WebDriverIO][Protractor][Multiple Sessions](https://codecept.io/acceptance/#multiple-sessions). Run several browser sessions in one test. Introduced `session` command, which opens additional browser window and closes it after a test.
1573
+
1574
+ ```js
1575
+ Scenario('run in different browsers', (I) => {
1576
+ I.amOnPage('/hello');
1577
+ I.see('Hello!');
1578
+ session('john', () => {
1579
+ I.amOnPage('/bye');
1580
+ I.dontSee('Hello');
1581
+ I.see('Bye');
1582
+ });
1583
+ I.see('Hello');
1584
+ });
1585
+ ```
1586
+
1587
+ * [Parallel Execution](https://codecept.io/advanced/#parallel-execution) by @sveneisenschmidt. Run tests in parallel specifying number of chunks:
1588
+
1589
+ ```js
1590
+ "multiple": {
1591
+ "parallel": {
1592
+ // run in 2 processes
1593
+ "chunks": 2,
1594
+ // run all tests in chrome
1595
+ "browsers": ["chrome"]
1596
+ },
1597
+ }
1598
+ ```
1599
+
1600
+ * [Locator Builder](https://codecept.io/locators). Write complex locators with simplest API combining CSS and XPath:
1601
+
1602
+ ```js
1603
+ // select 'Edit' link inside 2nd row of a table
1604
+ locate('//table')
1605
+ .find('tr')
1606
+ .at(2)
1607
+ .find('a')
1608
+ .withText('Edit');
1609
+ ```
1610
+
1611
+ * [Dynamic configuration](https://codecept.io/advanced/#dynamic-configuration) to update helpers config per test or per suite.
1612
+ * Added `event.test.finished` which fires synchronously for both failed and passed tests.
1613
+ * [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.
1614
+ * `within` blocks can return values. See [updated documentation](https://codecept.io/basics/#within).
1615
+ * Removed doublt call to `_init` in helpers. Fixes issue #1036
1616
+ * Added scenario and feature configuration via fluent API:
1617
+
1618
+ ```js
1619
+ Feature('checkout')
1620
+ .timeout(3000)
1621
+ .retry(2);
1622
+
1623
+ Scenario('user can order in firefox', (I) => {
1624
+ // see dynamic configuration
1625
+ }).config({ browser: 'firefox' })
1626
+ .timeout(20000);
1627
+
1628
+ Scenario('this test should throw error', (I) => {
1629
+ // I.amOnPage
1630
+ }).throws(new Error);
1631
+ ```
1632
+
1633
+ ## 1.1.8
1634
+
1635
+ * Fixed generating TypeScript definitions with `codeceptjs def`.
1636
+ * Added Chinese translation ("zh-CN" and "zh-TW") by @TechQuery.
1637
+ * Fixed running tests from a different folder specified by `-c` option.
1638
+ * [Puppeteer] Added support for hash handling in URL by @gavoja.
1639
+ * [Puppeteer] Fixed setting viewport size by @gavoja. See [Puppeteer issue](https://github.com/GoogleChrome/puppeteer/issues/1183)
1640
+
1641
+
1642
+ ## 1.1.7
1643
+
1644
+ * Docker Image updateed. [See updated reference](https://codecept.io/docker/):
1645
+ * codeceptjs package is mounted as `/codecept` insde container
1646
+ * tests directory is expected to be mounted as `/tests`
1647
+ * `codeceptjs` global runner added (symlink to `/codecept/bin/codecept.js`)
1648
+ * [Protractor] Functions added by @reubenmiller:
1649
+ * `_locateCheckable (only available from other helpers)`
1650
+ * `_locateClickable (only available from other helpers)`
1651
+ * `_locateFields (only available from other helpers)`
1652
+ * `acceptPopup`
1653
+ * `cancelPopup`
1654
+ * `dragAndDrop`
1655
+ * `grabBrowserLogs`
1656
+ * `grabCssPropertyFrom`
1657
+ * `grabHTMLFrom`
1658
+ * `grabNumberOfVisibleElements`
1659
+ * `grabPageScrollPosition (new)`
1660
+ * `rightClick`
1661
+ * `scrollPageToBottom`
1662
+ * `scrollPageToTop`
1663
+ * `scrollTo`
1664
+ * `seeAttributesOnElements`
1665
+ * `seeCssPropertiesOnElements`
1666
+ * `seeInPopup`
1667
+ * `seeNumberOfVisibleElements`
1668
+ * `switchTo`
1669
+ * `waitForEnabled`
1670
+ * `waitForValue`
1671
+ * `waitInUrl`
1672
+ * `waitNumberOfVisibleElements`
1673
+ * `waitToHide`
1674
+ * `waitUntil`
1675
+ * `waitUrlEquals`
1676
+ * [Nightmare] added:
1677
+ * `grabPageScrollPosition` (new)
1678
+ * `seeNumberOfVisibleElements`
1679
+ * `waitToHide`
1680
+ * [Puppeteer] added:
1681
+ * `grabPageScrollPosition` (new)
1682
+ * [WebDriverIO] added"
1683
+ * `grabPageScrollPosition` (new)
1684
+ * [Puppeteer] Fixed running wait* functions without setting `sec` parameter.
1685
+ * [Puppeteer][Protractor] Fixed bug with I.click when using an object selector with the xpath property. By @reubenmiller
1686
+ * [WebDriverIO][Protractor][Nightmare][Puppeteer] Fixed I.switchTo(0) and I.scrollTo(100, 100) api inconsistencies between helpers.
1687
+ * [Protractor] Fixing bug when `seeAttributesOnElements` and `seeCssPropertiesOnElement` were incorrectly passing when the attributes/properties did not match by @reubenmiller
1688
+ * [WebDriverIO] Use inbuilt dragAndDrop function (still doesn't work in Firefox). By @reubenmiller
1689
+ * Support for Nightmare 3.0
1690
+ * Enable glob patterns in `config.test` / `Codecept.loadTests` by @sveneisenschmidt
1691
+ * Enable overriding of `config.tests` for `run-multiple` by @sveneisenschmidt
1692
+
1693
+
1694
+ ## 1.1.6
1695
+
1696
+ * Added support for `async I =>` functions syntax in Scenario by @APshenkin
1697
+ * [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForInvisible` waits for element to hide or to be removed from page. By @reubenmiller
1698
+ * [Protractor][Puppeteer][Nightmare] Added `grabCurrentUrl` function. By @reubenmiller
1699
+ * [WebDriverIO] `grabBrowserUrl` deprecated in favor of `grabCurrentUrl` to unify the API.
1700
+ * [Nightmare] Improved element visibility detection by @reubenmiller
1701
+ * [Puppeteer] Fixing function calls when clearing the cookies and localstorage. By @reubenmiller
1702
+ * [Puppeteer] Added `waitForEnabled`, `waitForValue` and `waitNumberOfVisibleElements` methods by @reubenmiller
1703
+ * [WebDriverIO] Fixed `grabNumberOfVisibleElements` to return 0 when no visible elements are on page. By @michaltrunek
1704
+ * Helpers API improvements (by @reubenmiller)
1705
+ * `_passed` hook runs after a test passed successfully
1706
+ * `_failed` hook runs on a failed test
1707
+ * Hooks API. New events added by @reubenmiller:
1708
+ * `event.all.before` - executed before all tests
1709
+ * `event.all.after` - executed after all tests
1710
+ * `event.multiple.before` - executed before all processes in run-multiple
1711
+ * `event.multiple.after` - executed after all processes in run-multiple
1712
+ * Multiple execution
1713
+ * Allow `AfterSuite` and `After` test hooks to be defined after the first Scenario. By @reubenmiller
1714
+ * [Nightmare] Prevent `I.amOnpage` navigation if the browser is already at the given url
1715
+ * Multiple-Run: Added new `bootstrapAll` and `teardownAll` hooks to be executed before and after all processes
1716
+ * `codeceptjs def` command accepts `--config` option. By @reubenmiller
1717
+
1718
+ ## 1.1.5
1719
+
1720
+ * [Puppeteer] Rerun steps failed due to "Cannot find context with specified id" Error.
1721
+ * Added syntax to retry a single step:
1722
+
1723
+ ```js
1724
+ // retry action once on failure
1725
+ I.retry().see('Hello');
1726
+
1727
+ // retry action 3 times on failure
1728
+ I.retry(3).see('Hello');
1729
+
1730
+ // retry action 3 times waiting for 0.1 second before next try
1731
+ I.retry({ retries: 3, minTimeout: 100 }).see('Hello');
1732
+
1733
+ // retry action 3 times waiting no more than 3 seconds for last retry
1734
+ I.retry({ retries: 3, maxTimeout: 3000 }).see('Hello');
1735
+
1736
+ // retry 2 times if error with message 'Node not visible' happens
1737
+ I.retry({
1738
+ retries: 2,
1739
+ when: err => err.message === 'Node not visible'
1740
+ }).seeElement('#user');
1741
+ ```
1742
+
1743
+ * `Scenario().injectDependencies` added to dynamically add objects into DI container by @Apshenkin. See [Dependency Injection section in PageObjects](https://codecept.io/pageobjects/#dependency-injection).
1744
+ * Fixed using async/await functions inside `within`
1745
+ * [WebDriverIO][Protractor][Puppeteer][Nightmare] **`waitUntilExists` deprecated** in favor of `waitForElement`
1746
+ * [WebDriverIO][Protractor] **`waitForStalenessOf` deprecated** in favor of `waitForDetached`
1747
+ * [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForDetached` added
1748
+ * [Nightmare] Added `I.seeNumberOfElements()` by @pmoncadaisla
1749
+ * [Nightmare] Load blank page when starting nightmare so that the .evaluate function will work if _failed/saveScreenshot is triggered by @reubenmiller
1750
+ * Fixed using plain arrays for data driven tests by @reubenmiller
1751
+ * [Puppeteer] Use default tab instead of opening a new tab when starting the browser by @reubenmiller
1752
+ * [Puppeteer] Added `grabNumberOfTabs` function by @reubenmiller
1753
+ * [Puppeteer] Add ability to set user-agent by @abidhahmed
1754
+ * [Puppeteer] Add keepCookies and keepBrowserState @abidhahmed
1755
+ * [Puppeteer] Clear value attribute instead of innerhtml for TEXTAREA by @reubenmiller
1756
+ * [REST] fixed sending string payload by @michaltrunek
1757
+ * Fixed unhandled rejection in async/await tests by @APshenkin
1758
+
1759
+
1760
+ ## 1.1.4
1761
+
1762
+ * Removed `yarn` call in package.json
1763
+ * Fixed `console.log` in Puppeteer by @othree
1764
+ * [Appium] `runOnAndroid` and `runOnIOS` can receive a function to check capabilities dynamically:
1765
+
1766
+ ```js
1767
+ I.runOnAndroid(caps => caps.platformVersion >= 7, () => {
1768
+ // run code only on Android 7+
1769
+ });
1770
+ ```
1771
+
1772
+ ## 1.1.3
1773
+
1774
+ * [Puppeteer] +25 Functions added by @reubenmiller
1775
+ * `_locateCheckable`
1776
+ * `_locateClickable`
1777
+ * `_locateFields`
1778
+ * `closeOtherTabs`
1779
+ * `dragAndDrop`
1780
+ * `grabBrowserLogs`
1781
+ * `grabCssPropertyFrom`
1782
+ * `grabHTMLFrom`
1783
+ * `grabNumberOfVisibleElements`
1784
+ * `grabSource`
1785
+ * `rightClick`
1786
+ * `scrollPageToBottom`
1787
+ * `scrollPageToTop`
1788
+ * `scrollTo`
1789
+ * `seeAttributesOnElements`
1790
+ * `seeCssPropertiesOnElements`
1791
+ * `seeInField`
1792
+ * `seeNumberOfElements`
1793
+ * `seeNumberOfVisibleElements`
1794
+ * `seeTextEquals`
1795
+ * `seeTitleEquals`
1796
+ * `switchTo`
1797
+ * `waitForInvisible`
1798
+ * `waitInUrl`
1799
+ * `waitUrlEquals`
1800
+ * [Protractor] +8 functions added by @reubenmiller
1801
+ * `closeCurrentTab`
1802
+ * `grabSource`
1803
+ * `openNewTab`
1804
+ * `seeNumberOfElements`
1805
+ * `seeTextEquals`
1806
+ * `seeTitleEquals`
1807
+ * `switchToNextTab`
1808
+ * `switchToPreviousTab`
1809
+ * [Nightmare] `waitForInvisible` added by @reubenmiller
1810
+ * [Puppeteer] Printing console.log information in debug mode.
1811
+ * [Nightmare] Integrated with `nightmare-har-plugin` by mingfang. Added `enableHAR` option. Added HAR functions:
1812
+ * `grabHAR`
1813
+ * `saveHAR`
1814
+ * `resetHAR`
1815
+ * [WebDriverIO] Fixed execution stability for parallel requests with Chromedriver
1816
+ * [WebDriverIO] Fixed resizeWindow when resizing to 'maximize' by @reubenmiller
1817
+ * [WebDriverIO] Fixing resizing window to full screen when taking a screenshot by @reubenmiller
1818
+
1819
+ ## 1.1.2
1820
+
1821
+ * [Puppeteer] Upgraded to Puppeteer 1.0
1822
+ * Added `grep` option to config to set default matching pattern for tests.
1823
+ * [Puppeteer] Added `acceptPopup`, `cancelPopup`, `seeInPopup` and `grabPopupText` functions by @reubenmiller
1824
+ * [Puppeteer] `within` iframe and nested iframe support added by @reubenmiller
1825
+ * [REST] Added support for JSON objects since payload (as a JSON) was automatically converted into "URL query" type of parameter by @Kalostrinho
1826
+ * [REST] Added `resetRequestHeaders` method by @Kalostrinho
1827
+ * [REST] Added `followRedirect` option and `amFollowingRequestRedirects`/`amNotFollowingRequestRedirects` methods by @Kalostrinho
1828
+ * [WebDriverIO] `uncheckOption` implemented by @brunobg
1829
+ * [WebDriverIO] Added `grabBrowserUrl` by @Kalostrinho
1830
+ * Add ability to require helpers from node_modules by @APshenkin
1831
+ * Added `--profile` option to `run-multiple` command by @jamie-beck
1832
+ * Custom output name for multiple browser run by @tfiwm
1833
+ * Fixed passing data to scenarios by @KennyRules
1834
+
1835
+ ## 1.1.1
1836
+
1837
+ * [WebDriverIO] fixed `waitForInvisible` by @Kporal
1838
+
1839
+ ## 1.1.0
1840
+
1841
+ Major update to CodeceptJS. **NodeJS v 8.9.1** is now minimal Node version required.
1842
+ This brings native async-await support to CodeceptJS. It is recommended to start using await for tests instead of generators:
1843
+
1844
+ ```js
1845
+ async () => {
1846
+ I.amOnPage('/page');
1847
+ const url = await I.grabTextFrom('.nextPage');
1848
+ I.amOnPage(url);
1849
+ }
1850
+ ```
1851
+
1852
+ Thanks to [@Apshenkin](https://github.com/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!
1853
+
1854
+ We also introduced strict ESLint policies for our codebase. Thanks to [@Galkin](https://github.com/galkin) for that.
1855
+
1856
+ * **[Puppeteer] Helper introduced**. [Learn how to run tests headlessly with Google Chrome's Puppeteer](http://codecept.io/puppeteer/).
1857
+ * [SeleniumWebdriver] Helper is deprecated, it is recommended to use Protractor with config option `angular: false` instead.
1858
+ * [WebDriverIO] nested iframe support in the within block by @reubenmiller. Example:
1859
+
1860
+ ```js
1861
+ within({frame: ['#wrapperId', '[name=content]']}, () => {
1862
+ I.click('Sign in!');
1863
+ I.see('Email Address');
1864
+ });
1865
+ I.see('Nested Iframe test');
1866
+ I.dontSee('Email Address');
1867
+ });
1868
+ ```
1869
+ * [WebDriverIO] Support for `~` locator to find elements by `aria-label`. This behavior is similar as it is in Appium and helps testing cross-platform React apps. Example:
1870
+
1871
+ ```html
1872
+ <Text accessibilityLabel="foobar">
1873
+ CodeceptJS is awesome
1874
+ </Text>
1875
+ ```
1876
+ ↑ This element can be located with `~foobar` in WebDriverIO and Appium helpers. Thanks to @flyskywhy
1877
+
1878
+ * Allow providing arbitrary objects in config includes by @rlewan
1879
+ * [REST] Prevent from mutating default headers by @alexashley. See #789
1880
+ * [REST] Fixed sending empty helpers with `haveRequestHeaders` in `sendPostRequest`. By @petrisorionel
1881
+ * Fixed displaying undefined args in output by @APshenkin
1882
+ * Fixed NaN instead of seconds in output by @APshenkin
1883
+ * Add browser name to report file for `multiple-run` by @trollr
1884
+ * Mocha updated to 4.x
1885
+
1886
+
1887
+
1888
+ ## 1.0.3
1889
+
1890
+ * [WebDriverIO][Protractor][Nightmare] method `waitUntilExists` implemented by @sabau
1891
+ * Absolute path can be set for `output` dir by @APshenkin. Fix #571* Data table rows can be ignored by using `xadd`. By @APhenkin
1892
+ * Added `Data(table).only.Scenario` to give ability to launch only Data tests. By @APhenkin
1893
+ * Implemented `ElementNotFound` error by @BorisOsipov.
1894
+ * Added TypeScript compiler / configs to check the JavaScript by @KennyRules
1895
+ * [Nightmare] fix executeScript return value by @jploskonka
1896
+ * [Nightmare] fixed: err.indexOf not a function when waitForText times out in nightmare by @joeypedicini92
1897
+ * Fixed: Retries not working when using .only. By @APhenkin
1898
+
1899
+
1900
+ ## 1.0.2
1901
+
1902
+ * Introduced generators support in scenario hooks for `BeforeSuite`/`Before`/`AfterSuite`/`After`
1903
+ * [ApiDataFactory] Fixed loading helper; `requireg` package included.
1904
+ * Fix #485`run-multiple`: the first browser-resolution combination was be used in all configurations
1905
+ * Fixed unique test names:
1906
+ * Fixed #447 tests failed silently if they have the same name as other tests.
1907
+ * Use uuid in screenshot names when `uniqueScreenshotNames: true`
1908
+ * [Protractor] Fixed testing non-angular application. `amOutsideAngularApp` is executed before each step. Fixes #458* Added output for steps in hooks when they fail
1909
+
1910
+ ## 1.0.1
1911
+
1912
+ * Reporters improvements:
1913
+ * Allows to execute [multiple reporters](http://codecept.io/advanced/#Multi-Reports)
1914
+ * Added [Mochawesome](http://codecept.io/helpers/Mochawesome/) helper
1915
+ * `addMochawesomeContext` method to add custom data to mochawesome reports
1916
+ * Fixed Mochawesome context for failed screenshots.
1917
+ * [WebDriverIO] improved click on context to match clickable element with a text inside. Fixes #647* [Nightmare] Added `refresh` function by @awhanks
1918
+ * fixed `Unhandled promise rejection (rejection id: 1): Error: Unknown wait type: pageLoad`
1919
+ * support for tests with retries in html report
1920
+ * be sure that change window size and timeouts completes before test
1921
+ * [Nightmare] Fixed `[Wrapped Error] "codeceptjs is not defined"`; Reinjectiing client scripts to a webpage on changes.
1922
+ * [Nightmare] Added more detailed error messages for `Wait*` methods
1923
+ * [Nightmare] Fixed adding screenshots to Mochawesome
1924
+ * [Nightmare] Fix unique screenshots names in Nightmare
1925
+ * Fixed CodeceptJS work with hooks in helpers to finish codeceptJS correctly if errors appears in helpers hooks
1926
+ * Create a new session for next test If selenium grid error received
1927
+ * Create screenshots for failed hooks from a Feature file
1928
+ * Fixed `retries` option
1929
+
1930
+ ## 1.0
1931
+
1932
+ CodeceptJS hits first stable release. CodeceptJS provides a unified API for [web testing for Webdriverio](http://codecept.io/acceptance/), [Protractor](http://codecept.io/angular/), and [NightmareJS](http://codecept.io/nightmare/). Since 1.0 you can also **test mobile applications** in the similar manner with Appium.
1933
+
1934
+ Sample test:
1935
+
1936
+ ```js
1937
+ I.seeAppIsInstalled("io.super.app");
1938
+ I.click('~startUserRegistrationCD');
1939
+ I.fillField('~email of the customer', 'Nothing special'));
1940
+ I.see('davert@codecept.io', '~email of the customer'));
1941
+ I.clearField('~email of the customer'));
1942
+ I.dontSee('Nothing special', '~email of the customer'));
1943
+ ```
1944
+
1945
+ * Read [the Mobile Testing guide](http://codecept.io/mobile).
1946
+ * Discover [Appium Helper](http://codecept.io/helpers/Appium/)
1947
+
1948
+ ---
1949
+
1950
+ We also introduced two new **helpers for data management**.
1951
+ Using them you can easily prepare and cleanup data for your tests using public REST API.
1952
+
1953
+ Sample test
1954
+
1955
+ ```js
1956
+ // create a user using data factories and REST API
1957
+ I.have('user', { name: 'davert', password: '123456' });
1958
+ // use it to login
1959
+ I.amOnPage('/login');
1960
+ I.fillField('login', 'davert');
1961
+ I.fillField('password', '123456');
1962
+ I.click('Login');
1963
+ I.see('Hello, davert');
1964
+ // user will be removed after the test
1965
+ ```
1966
+
1967
+ * Read [Data Management guide](http://codecept.io/data)
1968
+ * [REST Helper](http://codecept.io/helpers/REST)
1969
+ * [ApiDataFactory](http://codecept.io/helpers/ApiDataFactory/)
1970
+
1971
+ ---
1972
+
1973
+ Next notable feature is **[SmartWait](http://codecept.io/acceptance/#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`
1974
+
1975
+ * Read more about [SmartWait](http://codecept.io/acceptance/#smartwait)
1976
+
1977
+ ##### Changelog
1978
+
1979
+ * Minimal NodeJS version is 6.11.1 LTS
1980
+ * Use `within` command with generators.
1981
+ * [Data Driven Tests](http://codecept.io/advanced/#data-driven-tests) introduced.
1982
+ * Print execution time per step in `--debug` mode. #591 by @APshenkin
1983
+ * [WebDriverIO][Protractor][Nightmare] Added `disableScreenshots` option to disable screenshots on fail by @Apshenkin
1984
+ * [WebDriverIO][Protractor][Nightmare] Added `uniqueScreenshotNames` option to generate unique names for screenshots on failure by @Apshenkin
1985
+ * [WebDriverIO][Nightmare] Fixed click on context; `click('text', '#el')` will throw exception if text is not found inside `#el`.
1986
+ * [WebDriverIO][Protractor][SeleniumWebdriver] [SmartWait introduced](http://codecept.io/acceptance/#smartwait).
1987
+ * [WebDriverIO][Protractor][Nightmare]Fixed `saveScreenshot` for PhantomJS, `fullPageScreenshots` option introduced by @HughZurname #549
1988
+ * [Appium] helper introduced by @APshenkin
1989
+ * [REST] helper introduced by @atrevino in #504
1990
+ * [WebDriverIO][SeleniumWebdriver] Fixed "windowSize": "maximize" for Chrome 59+ version #560 by @APshenkin
1991
+ * [Nightmare] Fixed restarting by @APshenkin #581
1992
+ * [WebDriverIO] Methods added by @APshenkin:
1993
+ * [grabCssPropertyFrom](http://codecept.io/helpers/WebDriverIO/#grabcsspropertyfrom)
1994
+ * [seeTitleEquals](http://codecept.io/helpers/WebDriverIO/#seetitleequals)
1995
+ * [seeTextEquals](http://codecept.io/helpers/WebDriverIO/#seetextequals)
1996
+ * [seeCssPropertiesOnElements](http://codecept.io/helpers/WebDriverIO/#seecsspropertiesonelements)
1997
+ * [seeAttributesOnElements](http://codecept.io/helpers/WebDriverIO/#seeattributesonelements)
1998
+ * [grabNumberOfVisibleElements](http://codecept.io/helpers/WebDriverIO/#grabnumberofvisibleelements)
1999
+ * [waitInUrl](http://codecept.io/helpers/WebDriverIO/#waitinurl)
2000
+ * [waitUrlEquals](http://codecept.io/helpers/WebDriverIO/#waiturlequals)
2001
+ * [waitForValue](http://codecept.io/helpers/WebDriverIO/#waitforvalue)
2002
+ * [waitNumberOfVisibleElements](http://codecept.io/helpers/WebDriverIO/#waitnumberofvisibleelements)
2003
+ * [switchToNextTab](http://codecept.io/helpers/WebDriverIO/#switchtonexttab)
2004
+ * [switchToPreviousTab](http://codecept.io/helpers/WebDriverIO/#switchtoprevioustab)
2005
+ * [closeCurrentTab](http://codecept.io/helpers/WebDriverIO/#closecurrenttab)
2006
+ * [openNewTab](http://codecept.io/helpers/WebDriverIO/#opennewtab)
2007
+ * [refreshPage](http://codecept.io/helpers/WebDriverIO/#refreshpage)
2008
+ * [scrollPageToBottom](http://codecept.io/helpers/WebDriverIO/#scrollpagetobottom)
2009
+ * [scrollPageToTop](http://codecept.io/helpers/WebDriverIO/#scrollpagetotop)
2010
+ * [grabBrowserLogs](http://codecept.io/helpers/WebDriverIO/#grabbrowserlogs)
2011
+ * Use mkdirp to create output directory. #592 by @vkramskikh
2012
+ * [WebDriverIO] Fixed `seeNumberOfVisibleElements` by @BorisOsipov #574
2013
+ * Lots of fixes for promise chain by @APshenkin #568
2014
+ * Fix #543- After block not properly executed if Scenario fails
2015
+ * 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.
2016
+ * if during test we got errors from any hook (in test or in helper) - stop complete this suite and go to another
2017
+ * if during test we got error from Selenium server - stop complete this suite and go to another
2018
+ * [WebDriverIO][Protractor] if `restart` option is false - close all tabs expect one in `_after`.
2019
+ * Complete `_after`, `_afterSuite` hooks even After/AfterSuite from test was failed
2020
+ * 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.
2021
+ * Close tabs and clear local storage, if `keepCookies` flag is enabled
2022
+ * Fix TypeError when using babel-node or ts-node on node.js 7+ #586 by @vkramskikh
2023
+ * [Nightmare] fixed usage of `_locate`
2024
+
2025
+ Special thanks to **Andrey Pshenkin** for his work on this release and the major improvements.
2026
+
2027
+ ## 0.6.3
2028
+
2029
+ * Errors are printed in non-verbose mode. Shows "Selenium not started" and other important errors.
2030
+ * Allowed to set custom test options:
2031
+
2032
+ ```js
2033
+ Scenario('My scenario', { build_id: 123, type: 'slow' }, function (I)
2034
+ ```
2035
+ those options can be accessed as `opts` property inside a `test` object. Can be used in custom listeners.
2036
+
2037
+ * Added `docs` directory to a package.
2038
+ * [WebDriverIO][Protractor][SeleniumWebdriver] Bugfix: cleaning session when `restart: false` by @tfiwm #519
2039
+ * [WebDriverIO][Protractor][Nightmare] Added second parameter to `saveScreenshot` to allow a full page screenshot. By @HughZurname
2040
+ * Added suite object to `suite.before` and `suite.after` events by @implico. #496
2041
+
2042
+ ## 0.6.2
2043
+
2044
+ * Added `config` object to [public API](http://codecept.io/hooks/#api)
2045
+ * Extended `index.js` to include `actor` and `helpers`, so they could be required:
2046
+
2047
+ ```js
2048
+ const actor = require('codeceptjs').actor;
2049
+ ```
2050
+
2051
+ * Added [example for creating custom runner](http://codecept.io/hooks/#custom-runner) with public API.
2052
+ * run command to create `output` directory if it doesn't exist
2053
+ * [Protractor] fixed loading globally installed Protractor
2054
+ * run-multiple command improvements:
2055
+ * create output directories for each process
2056
+ * print process ids in output
2057
+
2058
+ ## 0.6.1
2059
+
2060
+ * Fixed loading hooks
2061
+
2062
+ ## 0.6.0
2063
+
2064
+ Major release with extension API and parallel execution.
2065
+
2066
+ * **Breaking** Removed path argument from `run`. To specify path other than current directory use `--config` or `-c` option:
2067
+
2068
+ Instead of: `codeceptjs run tests` use:
2069
+
2070
+ ```
2071
+ # load config and run from tests directory
2072
+ codeceptjs run -c tests/
2073
+
2074
+ # or load codecept.json from tests directory
2075
+ codeceptjs run -c tests/codecept.json
2076
+
2077
+ # run users_test.js inside tests directory
2078
+ codeceptjs run users_test.js -c tests
2079
+ ```
2080
+
2081
+ * **Command `multiple-run` added**, to execute tests in several browsers in parallel by @APshenkin and @davertmik. [See documentation](http://codecept.io/advanced/#multiple-execution).
2082
+ * **Hooks API added to extend CodeceptJS** with custom listeners and plugins. [See documentation](http://codecept.io/hooks/#hooks_1).
2083
+ * [Nightmare][WebDriverIO] `within` can work with iframes by @imvetri. [See documentation](http://codecept.io/acceptance/#iframes).
2084
+ * [WebDriverIO][SeleniumWebdriver][Protractor] Default browser changed to `chrome`
2085
+ * [Nightmare] Fixed globally locating `nightmare-upload`.
2086
+ * [WebDriverIO] added `seeNumberOfVisibleElements` method by @elarouche.
2087
+ * Exit with non-zero code if init throws an error by @rincedd
2088
+ * New guides published:
2089
+ * [Installation](http://codecept.io/installation/)
2090
+ * [Hooks](http://codecept.io/hooks/)
2091
+ * [Advanced Usage](http://codecept.io/advanced/)
2092
+ * Meta packages published:
2093
+ * [codecept-webdriverio](https://www.npmjs.com/package/codecept-webdriverio)
2094
+ * [codecept-protractor](https://www.npmjs.com/package/codecept-protractor)
2095
+ * [codecept-nightmare](https://www.npmjs.com/package/codecept-nightmare)
2096
+
2097
+
2098
+ ## 0.5.1
2099
+
2100
+ * [Polish translation](http://codecept.io/translation/#polish) added by @limes.
2101
+ * Update process exit code so that mocha saves reports before exit by @romanovma.
2102
+ * [Nightmare] fixed `getAttributeFrom` for custom attributes by @robrkerr
2103
+ * [Nightmare] Fixed *UnhandledPromiseRejectionWarning error* when selecting the dropdown using `selectOption` by @robrkerr. [Se PR.
2104
+ * [Protractor] fixed `pressKey` method by @romanovma
2105
+
2106
+ ## 0.5.0
2107
+
2108
+ * Protractor ^5.0.0 support (while keeping ^4.0.9 compatibility)
2109
+ * Fix 'fullTitle() is not a function' in exit.js by @hubidu. See #388.
2110
+ * [Nightmare] Fix for `waitTimeout` by @HughZurname. See #391. Resolves #236* Dockerized CodeceptJS setup by @artiomnist. [See reference](https://github.com/codeceptjs/CodeceptJS/blob/master/docker/README.md)
2111
+
2112
+ ## 0.4.16
2113
+
2114
+ * Fixed steps output synchronization (regression since 0.4.14).
2115
+ * [WebDriverIO][Protractor][SeleniumWebdriver][Nightmare] added `keepCookies` option to keep cookies between tests with `restart: false`.
2116
+ * [Protractor] added `waitForTimeout` config option to set default waiting time for all wait* functions.
2117
+ * Fixed `_test` hook for helpers by @cjhille.
2118
+
2119
+ ## 0.4.15
2120
+
2121
+ * Fixed regression in recorder sessions: `oldpromise is not defined`.
2122
+
2123
+ ## 0.4.14
2124
+
2125
+ * `_beforeStep` and `_afterStep` hooks in helpers are synchronized. Allows to perform additional actions between steps.
2126
+
2127
+ Example: fail if JS error occur in custom helper using WebdriverIO:
2128
+
2129
+ ```js
2130
+ _before() {
2131
+ this.err = null;
2132
+ this.helpers['WebDriverIO'].browser.on('error', (e) => this.err = e);
2133
+ }
2134
+
2135
+ _afterStep() {
2136
+ if (this.err) throw new Error('Browser JS error '+this.err);
2137
+ }
2138
+ ```
2139
+
2140
+ Example: fail if JS error occur in custom helper using Nightmare:
2141
+
2142
+ ```js
2143
+ _before() {
2144
+ this.err = null;
2145
+ this.helpers['Nightmare'].browser.on('page', (type, message, stack) => {
2146
+ this.err = `${message} ${stack}`;
2147
+ });
2148
+ }
2149
+
2150
+ _afterStep() {
2151
+ if (this.err) throw new Error('Browser JS error '+this.err);
2152
+ }
2153
+ ```
2154
+
2155
+ * Fixed `codecept list` and `codecept def` commands.
2156
+ * Added `I.say` method to print arbitrary comments.
2157
+
2158
+ ```js
2159
+ I.say('I am going to publish post');
2160
+ I.say('I enter title and body');
2161
+ I.say('I expect post is visible on site');
2162
+ ```
2163
+
2164
+ * [Nightmare] `restart` option added. `restart: false` allows to run all tests in a single window, disabled by default. By @nairvijays99
2165
+ * [Nightmare] Fixed `resizeWindow` command.
2166
+ * [Protractor][SeleniumWebdriver] added `windowSize` config option to resize window on start.
2167
+ * Fixed "Scenario.skip causes 'Cannot read property retries of undefined'" by @MasterOfPoppets
2168
+ * Fixed providing absolute paths for tests in config by @lennym
2169
+
2170
+ ## 0.4.13
2171
+
2172
+ * Added **retries** option `Feature` and `Scenario` to rerun fragile tests:
2173
+
2174
+ ```js
2175
+ Feature('Complex JS Stuff', {retries: 3});
2176
+
2177
+ Scenario('Not that complex', {retries: 1}, (I) => {
2178
+ // test goes here
2179
+ });
2180
+ ```
2181
+
2182
+ * Added **timeout** option `Feature` and `Scenario` to specify timeout.
2183
+
2184
+ ```js
2185
+ Feature('Complex JS Stuff', {timeout: 5000});
2186
+
2187
+ Scenario('Not that complex', {timeout: 1000}, (I) => {
2188
+ // test goes here
2189
+ });
2190
+ ```
2191
+
2192
+ * [WebDriverIO] Added `uniqueScreenshotNames` option to set unique screenshot names for failed tests. By @APshenkin. See #299
2193
+ * [WebDriverIO] `clearField` method improved to accept name/label locators and throw errors.
2194
+ * [Nightmare][SeleniumWebdriver][Protractor] `clearField` method added.
2195
+ * [Nightmare] Fixed `waitForElement`, and `waitForVisible` methods.
2196
+ * [Nightmare] Fixed `resizeWindow` by @norisk-it
2197
+ * Added italian [translation](http://codecept.io/translation/#italian).
2198
+
2199
+ ## 0.4.12
2200
+
2201
+ * Bootstrap / Teardown improved with [Hooks](http://codecept.io/configuration/#hooks). Various options for setup/teardown provided.
2202
+ * Added `--override` or `-o` option for runner to dynamically override configs. Valid JSON should be passed:
2203
+
2204
+ ```
2205
+ codeceptjs run -o '{ "bootstrap": "bootstrap.js"}'
2206
+ codeceptjs run -o '{ "helpers": {"WebDriverIO": {"browser": "chrome"}}}'
2207
+ ```
2208
+
2209
+ * Added [regression tests](https://github.com/codeceptjs/CodeceptJS/tree/master/test/runner) for codeceptjs tests runner.
2210
+
2211
+ ## 0.4.11
2212
+
2213
+ * Fixed regression in 0.4.10
2214
+ * Added `bootstrap`/`teardown` config options to accept functions as parameters by @pscanf. See updated [config reference](http://codecept.io/configuration/) #319
2215
+
2216
+ ## 0.4.10
2217
+
2218
+ * [Protractor] Protrctor 4.0.12+ support.
2219
+ * Enabled async bootstrap file by @abachar. Use inside `bootstrap.js`:
2220
+
2221
+ ```js
2222
+ module.exports = function(done) {
2223
+ // async instructions
2224
+ // call done() to continue execution
2225
+ // otherwise call done('error description')
2226
+ }
2227
+ ```
2228
+
2229
+ * Changed 'pending' to 'skipped' in reports by @timja-kainos. See #315
2230
+
2231
+ ## 0.4.9
2232
+
2233
+ * [SeleniumWebdriver][Protractor][WebDriverIO][Nightmare] fixed `executeScript`, `executeAsyncScript` to work and return values.
2234
+ * [Protractor][SeleniumWebdriver][WebDriverIO] Added `waitForInvisible` and `waitForStalenessOf` methods by @Nighthawk14.
2235
+ * Added `--config` option to `codeceptjs run` to manually specify config file by @cnworks
2236
+ * [Protractor] Simplified behavior of `amOutsideAngularApp` by using `ignoreSynchronization`. Fixes #278
2237
+ * Set exit code to 1 when test fails at `Before`/`After` hooks. Fixes #279
2238
+
2239
+
2240
+ ## 0.4.8
2241
+
2242
+ * [Protractor][SeleniumWebdriver][Nightmare] added `moveCursorTo` method.
2243
+ * [Protractor][SeleniumWebdriver][WebDriverIO] Added `manualStart` option to start browser manually in the beginning of test. By @cnworks. [PR#250
2244
+ * Fixed `codeceptjs init` to work with nested directories and file masks.
2245
+ * Fixed `codeceptjs gt` to generate test with proper file name suffix. By @Zougi.
2246
+ * [Nightmare] Fixed: Error is thrown when clicking on element which can't be locate. By @davetmik
2247
+ * [WebDriverIO] Fixed `attachFile` for file upload. By @giuband and @davetmik
2248
+ * [WebDriverIO] Add support for timeouts in config and with `defineTimeouts` method. By @easternbloc #258 and #267 by @davetmik
2249
+ * Fixed hanging of CodeceptJS when error is thrown by event dispatcher. Fix by @Zougi and @davetmik
2250
+
2251
+
2252
+ ## 0.4.7
2253
+
2254
+ * Improved docs for `BeforeSuite`; fixed its usage with `restart: false` option by @APshenkin.
2255
+ * Added `Nightmare` to list of available helpers on `init`.
2256
+ * [Nightmare] Removed double `resizeWindow` implementation.
2257
+
2258
+ ## 0.4.6
2259
+
2260
+ * Added `BeforeSuite` and `AfterSuite` hooks to scenario by @APshenkin. See [updated documentation](http://codecept.io/basics/#beforesuite)
2261
+
2262
+ ## 0.4.5
2263
+
2264
+ * Fixed running `codecept def` command by @jankaspar
2265
+ * [Protractor][SeleniumWebdriver] Added support for special keys in `pressKey` method. Fixes #216
2266
+
2267
+ ## 0.4.4
2268
+
2269
+ * Interactive shell fixed. Start it by running `codeceptjs shell`
2270
+ * Added `--profile` option to `shell` command to use dynamic configuration.
2271
+ * Added `--verbose` option to `shell` command for most complete output.
2272
+
2273
+ ## 0.4.3
2274
+
2275
+ * [Protractor] Regression fixed to ^4.0.0 support
2276
+ * Translations included into package.
2277
+ * `teardown` option added to config (opposite to `bootstrap`), expects a JS file to be executed after tests stop.
2278
+ * [Configuration](http://codecept.io/configuration/) can be set via JavaScript file `codecept.conf.js` instead of `codecept.json`. It should export `config` object:
2279
+
2280
+ ```js
2281
+ // inside codecept.conf.js
2282
+ exports.config = {
2283
+ // contents of codecept.js
2284
+ }
2285
+ ```
2286
+ * Added `--profile` option to pass its value to `codecept.conf.js` as `process.profile` for [dynamic configuration](http://codecept.io/configuration#dynamic-configuration).
2287
+ * Documentation for [StepObjects, PageFragments](http://codecept.io/pageobjects#PageFragments) updated.
2288
+ * Documentation for [Configuration](http://codecept.io/configuration/) added.
2289
+
2290
+ ## 0.4.2
2291
+
2292
+ * Added ability to localize tests with translation #189. Thanks to @abner
2293
+ * [Translation] ru-RU translation added.
2294
+ * [Translation] pt-BR translation added.
2295
+ * [Protractor] Protractor 4.0.4 compatibility.
2296
+ * [WebDriverIO][SeleniumWebdriver][Protractor] Fixed single browser session mode for `restart: false`
2297
+ * Fixed using of 3rd party reporters (xunit, mocha-junit-reporter, mochawesome). Added guide.
2298
+ * Documentation for [Translation](http://codecept.io/translation/) added.
2299
+ * Documentation for [Reports](http://codecept.io/reports/) added.
2300
+
2301
+ ## 0.4.1
2302
+
2303
+ * Added custom steps to step definition list. See #174 by @jayS-de
2304
+ * [WebDriverIO] Fixed using `waitForTimeout` option by @stephane-ruhlmann. See #178
2305
+
2306
+ ## 0.4.0
2307
+
2308
+ * **[Nightmare](http://codecept.io/nightmare) Helper** added for faster web testing.
2309
+ * [Protractor][SeleniumWebdriver][WebDriverIO] added `restart: false` option to reuse one browser between tests (improves speed).
2310
+ * **Protractor 4.0** compatibility. Please upgrade Protractor library.
2311
+ * Added `--verbose` option for `run` command to log and print global promise and events.
2312
+ * Fixed errors with shutting down and cleanup.
2313
+ * Fixed starting interactive shell with `codeceptjs shell`.
2314
+ * Fixed handling of failures inside within block
2315
+
2316
+ ## 0.3.5
2317
+
2318
+ * Introduced IDE autocompletion support for Visual Studio Code and others. Added command for generating TypeScript definitions for `I` object. Use it as
2319
+
2320
+ ```
2321
+ codeceptjs def
2322
+ ```
2323
+
2324
+ to generate steps definition file and include it into tests by reference. By @kaflan
2325
+
2326
+ ## 0.3.4
2327
+
2328
+ * [Protractor] version 3.3.0 comptaibility, NPM 3 compatibility. Please update Protractor!
2329
+ * allows using absolute path for helpers, output, in config and in command line. By @denis-sokolov
2330
+ * Fixes 'Cannot read property '1' of null in generate.js:44' by @seethislight
2331
+
2332
+ ## 0.3.3
2333
+
2334
+ **Fixed global installation**. CodeceptJS can now locate globally located modules.
2335
+ CodeceptJS is also recommended for local installation.
2336
+ Depending on installation type additional modules (webdriverio, protractor, ...) will be loaded either from local or from global path.
2337
+
2338
+ ## 0.3.2
2339
+
2340
+ * Added `codeceptjs list` command which shows all available methods of `I` object.
2341
+ * [Protractor][SeleniumWebdriver] fixed closing browser instances
2342
+ * [Protractor][SeleniumWebdriver] `doubleClick` method added
2343
+ * [WebDriverIO][Protractor][SeleniumWebdriver] `doubleClick` method to locate clickable elements by text, `context` option added.
2344
+ * Fixed using assert in generator without yields #89
2345
+
2346
+ ## 0.3.1
2347
+
2348
+ * Fixed `init` command
2349
+
2350
+ ## 0.3.0
2351
+
2352
+ **Breaking Change**: webdriverio package removed from dependencies list. You will need to install it manually after the upgrade.
2353
+ 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.
2354
+
2355
+ * **[Protractor] helper added**. Now you can test AngularJS applications by using its official library within the unigied CodeceptJS API!
2356
+ * **[SeleniumWebdriver] helper added**. You can switch to official JS bindings for Selenium.
2357
+ * [WebDriverIO] **updated to webdriverio v 4.0**
2358
+ * [WebDriverIO] `clearField` method added by @fabioel
2359
+ * [WebDriverIO] added `dragAndDrop` by @fabioel
2360
+ * [WebDriverIO] fixed `scrollTo` method by @sensone
2361
+ * [WebDriverIO] fixed `windowSize: maximize` option in config
2362
+ * [WebDriverIO] `seeElement` and `dontSeeElement` check element for visibility by @fabioel and @davertmik
2363
+ * [WebDriverIO] `seeElementInDOM`, `dontSeeElementInDOM` added to check element exists on page.
2364
+ * [WebDriverIO] fixed saving screenshots on failure. Fixes #70
2365
+ * fixed `within` block doesn't end in output not #79
2366
+
2367
+
2368
+ ## 0.2.8
2369
+
2370
+ * [WebDriverIO] added `seeNumberOfElements` by @fabioel
2371
+
2372
+ ## 0.2.7
2373
+
2374
+ * process ends with exit code 1 on error or failure #49
2375
+ * fixed registereing global Helper #57
2376
+ * fixed handling error in within block #50
2377
+
2378
+ ## 0.2.6
2379
+
2380
+ * Fixed `done() was called multiple times`
2381
+ * [WebDriverIO] added `waitToHide` method by @fabioel
2382
+ * Added global `Helper` (alias `codecept_helper)`, object use for writing custom Helpers. Generator updated. Changes to #48
2383
+
2384
+ ## 0.2.5
2385
+
2386
+ * Fixed issues with using yield inside a test #45 #47 #43
2387
+ * Fixed generating a custom helper. Helper class is now accessible with `codecept_helper` var. Fixes #48
2388
+
2389
+ ## 0.2.4
2390
+
2391
+ * Fixed accessing helpers from custom helper by @pim.
2392
+
2393
+ ## 0.2.3
2394
+
2395
+ * [WebDriverIO] fixed `seeInField` to work with single value elements like: input[type=text], textareas, and multiple: select, input[type=radio], input[type=checkbox]
2396
+ * [WebDriverIO] fixed `pressKey`, key modifeiers (Control, Command, Alt, Shift) are released after the action
2397
+
2398
+ ## 0.2.2
2399
+
2400
+ Fixed generation of custom steps file and page objects.
2401
+ Please replace `require('codeceptjs/actor')` to `actor` in your `custom_steps.js`.
2402
+ Whenever you need to create `I` object (in page objects, custom steps, but not in tests) just call `actor()`;
2403
+
2404
+ ## 0.2.0
2405
+
2406
+ * **within** context hook added
2407
+ * `--reporter` option supported
2408
+ * [WebDriverIO] added features and methods:
2409
+ - elements: `seeElement`, ...
2410
+ - popups: `acceptPopup`, `cancelPopup`, `seeInPopup`,...
2411
+ - navigation: `moveCursorTo`, `scrollTo`
2412
+ - saving screenshots on failure; `saveScreenshot`
2413
+ - cookies: `setCookie`, `seeCookie`, ...
2414
+ - source: `seeInSource`
2415
+ - form: `seeCheckboxIsChecked`, `selectOption` to support multiple selects
2416
+ - keyboard: `appendField`, `pressKey`
2417
+ - mouse: `rightClick`
2418
+ * tests added
2419
+ * [WebDriverIO] proxy configuration added by @petehouston
2420
+ * [WebDriverIO] fixed `waitForText` method by @roadhump. Fixes #11
2421
+ * Fixed creating output dir when it already exists on init by @alfirin
2422
+ * Fixed loading of custom helpers