codeceptjs 3.5.4 → 3.5.5

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