codeceptjs 2.3.4 → 2.4.1

package/docs/wiki/Examples.md

@@ -0,0 +1,138 @@
+## [TodoMVC Examples](https://github.com/codecept-js/examples)
+
+![](https://github.com/codecept-js/examples/raw/master/todo.png)
+
+Playground repository where you can run tests in different helpers on a basic single-page website.
+
+Tests repository demonstrate usage of
+
+* Puppeteer helper
+* WebDriver helper
+* TestCafe plugin
+* Toggle headless mode with env variables
+* PageObjects
+* Cucumber syntax
+
+## [Basic Examples](https://github.com/Codeception/CodeceptJS/tree/master/examples)
+
+CodeceptJS repo contains basic tests (both failing and passing) just to show how it works.
+Our team uses it to test new features and run simple scenarios.
+
+
+## [Testing Single Page Application](https://github.com/bugiratracker/codeceptjs-demo)
+
+![](https://user-images.githubusercontent.com/220264/56353972-56975080-61db-11e9-8b23-06e8b4620995.png)
+
+End 2 end tests for [Bugira Bugtracker](https://bugira.com) app built with Rails & EmberJS. Bugira is a SaaS application that helps collecting users' feedbacks and transforming them into professional bug reports.
+
+Tests repository demonstrate usage of
+
+* Puppeteer helper
+* ApiDataFactory helper
+* autoLogin plugin
+* Dynamic config with profiles
+
+## [Practical E2E Tests](https://gitlab.com/paulvincent/codeceptjs-e2e-testing)
+
+Examples from the book [Practical End 2 End Testing with CodeceptJS](https://leanpub.com/codeceptjs/) by **Paul Vincent Beigang**. 
+
+This repository demonstrates usage of:
+
+* dynamic config with profiles
+* testing WYSIWYG editor
+* GitLab CI
+
+## [CodeceptJS Cucumber E2E Framework](https://github.com/gkushang/codeceptjs-e2e)
+
+This repository contains complete E2E framework for CodeceptJS with Cucumber and SauceLabs Integration
+
+* CodecepJS-Cucumber E2E Framework
+* Saucelabs Integration
+* Run Cross Browser tests in Parallel on SauceLabs with a simple command
+* Run tests on `chrome:headless`
+* Page Objects
+* `Should.js` Assertion Library
+* Uses `wdio` service (selenium-standalone, sauce)
+* Allure HTML Reports
+* Uses shared Master configuration
+* Sample example and feature files of GitHub Features
+
+## [Amazon Tests v2](https://gitlab.com/thanhnguyendh/codeceptjs-wdio-services)
+
+Testing Amazon website using Selenium WebDriver.
+
+This repository demonstrates usage of:
+
+* WebDriver helper
+* Page Objects
+* wdio services (selenium-standalone)
+* Parallel execution
+* GitLab CI setup
+
+## [Amazon Tests v1](https://github.com/PeterNgTr/amazon-ui-tests)
+
+Previous version of Amazon Tests, still valid but quite different.
+
+This repository demonstrates usage of:
+
+* WebDriver helper
+* Page Objects
+* Bootstrap and teardown
+* Parallel execution
+
+## [Tests with Docker Compose](https://github.com/mathesouza/codeceptjs-docker-compose)
+
+Running CodeceptJS tests with Docker Compose
+
+This repository demonstrates usage of:
+
+* CodeceptJS Docker image 
+* WebDriver helper
+* Allure plugin
+
+
+## [ModusCreate Tests](https://github.com/ModusCreateOrg/codeceptjs-nightmare-harness)
+
+Test automation by ModusCreate agency with NightmareJS.
+
+This repository demonstrates usage of:
+
+* Nightmare helper
+* Reports with Mochawesome
+* Docker
+* Page objects and page fragments
+
+## [AngularJS Example Tests](https://github.com/armno/angular-e2e-codeceptjs-example)
+
+Based on [Setting up End-to-End Testing in Angular Project with CodeceptJS](https://medium.com/@armno/setting-up-end-to-end-testing-in-angular-project-with-codeceptjs-ac1784de3420) post by Armno Prommarak.
+
+This repository demonstrates usage of
+
+* Puppeteer helper
+* Working with Angular CLI
+* Reports with Mochawesome helper
+
+## [REST Example Tests](https://github.com/PeterNgTr/codeceptjs-rest-demo)
+
+This repository demonstrates usage of
+
+* REST helper
+
+## [Automation Starter](https://github.com/sjorrillo/automation-starter)
+
+The purpose of this application is for learning the basics and how to use good practices and useful tools in automation.
+
+* Puppeteer helper
+* Working with gherkin, also it has type definitions and to be able to use them inside when, given and then make sure you add `declare function inject(): { I: CodeceptJS.I, [key: string]: any; };`in the `steps.d.ts`file 
+* Linting `airbnb-base`, `codeceptjs/codeceptjs` and full ES6 support
+
+## [Example for using: Puppeteer, Gherkin, Allure with parallel execution](https://github.com/SchnuckySchuster/codeceptJSExample)
+
+This is a ready to use example that shows how to integrate CodeceptJS with Puppeteer and Allure as reporting tool.
+
+* detailed ReadMe
+* tests written in cucumber alongside tests written in the codeceptJS DSL
+* puppeteer helper example
+* test steps, pages, fragments
+* examples for sequential and parallel execution
+* generation of allure test results  

package/docs/wiki/Home.md

@@ -0,0 +1,11 @@
+Welcome to the CodeceptJS wiki!
+
+Some useful links:
+* [Official Site](http://codecept.io)
+* [Roadmap](https://github.com/Codeception/CodeceptJS/wiki/Roadmap)
+* [Books & Posts](https://github.com/Codeception/CodeceptJS/wiki/Books-&-Posts)
+* [Community Helpers](https://github.com/Codeception/CodeceptJS/wiki/Community-Helpers)
+* [Code on Github](https://github.com/Codeception/CodeceptJS)
+* [Change log](https://github.com/Codeception/CodeceptJS/blob/master/CHANGELOG.md)
+
+

package/docs/wiki/Release-process.md

@@ -0,0 +1,25 @@
+This is the guide for maintainers:
+
+## Release Process
+
+1. pull in the latest changes from master
+2. create branch `release-x.x.x` and switch to it
+3. update version in `package.json`
+4. go through commits in this release and write a changelog. 
+  * Changelog should be written not for robots! 
+  * Use simple wording explaining what a change was, how to use a new feature (maybe with a code example), and mention a related issue. 
+  * When using `#123` a link for issue #123 will be automatically added. 
+  * A contributor must be mentioned. We use GitHub names with `@` prefix. A link to user profile is automatically added.
+5. run `./runio.js docs` to build documentation
+6. commit all changes, push, and make PR
+7. check that all tests pass and merge your PR
+8. run `./runio.js release` to publish latest release. A website will be updated.
+  * to update version for patch release: `./runio release patch`
+  * to update version for minor release: `./runio release minor`
+9. Post announcements in Twitter & Slack
+
+## Updating a website
+
+* Run `./runio.js docs:helpers` to build docs from helpers
+* Run `./runio.js publish:site` to update a website
+

package/docs/wiki/Roadmap.md

@@ -0,0 +1,23 @@
+[Upcoming releases](https://github.com/Codeception/CodeceptJS/projects)
+
+## Backlog
+
+* Shadow-DOM locator integration with webdriverio 5.x
+* Cypress integration
+* Reuse a single browser session while writing tests
+
+---
+
+## Done
+
+To make those features implemented, consider [sponsoring CodeceptJS](https://github.com/Codeception/CodeceptJS/issues/1462).
+
+* ~GraphQL helper~
+* ~Cypress-like Development mode:~
+  * ~UI for selecting and executing tests~
+* ~[Detox](https://github.com/wix/Detox) integration for React Native and mobile testing~ 
+* ~TestCafe integration~
+* ~Parallel execution via workers (improves CPU consumation, reporting)~
+* ~Mock Request/Response in Puppeteer helper via [PollyJS](https://github.com/Netflix/pollyjs).~
+* Update BDD/Gherkin support to Gherkin version 6 specification
+  * [See Version 6.0.13](https://github.com/cucumber/cucumber/blob/master/gherkin/CHANGELOG.md#6013---2018-09-25)

package/docs/wiki/Videos.md

@@ -0,0 +1,19 @@
+[![](http://i3.ytimg.com/vi/BRMWstiOTks/maxresdefault.jpg)](https://www.youtube.com/watch?v=BRMWstiOTks)
+
+* ## [An Introduction, Getting started and working with CodeceptJS & Puppeteer (EAWeekend)](https://www.youtube.com/watch?v=BRMWstiOTks)
+
+* ## [CodeceptJS Official YouTube Channel](https://www.youtube.com/channel/UCEs4030bmtonyDhTHEXa_2g)
+
+* ## [Introductory Videos](https://www.youtube.com/watch?v=FPFG1rBNJ64&list=PLcFXthgti9Lt4SjSvL1ALDg6dOeTC0TvT)
+
+Free educational videos provided by our community member **[@ontytoom](http://github.com/ontytoom)**.
+
+1. [Installation](https://www.youtube.com/watch?v=FPFG1rBNJ64)
+1. [Creating a Test](https://www.youtube.com/watch?v=mdQZjL3h9d0)
+1. [Using Page Objects](https://www.youtube.com/watch?v=s677_6VctjQ)
+
+## [Practical E2E Testing with CodeceptJS](https://www.udemy.com/practical-e2e-testing-with-codeceptjs/)
+
+Udemy course by Luke Beilharz
+
+

package/lib/actor.js

@@ -9,8 +9,13 @@ const output = require('./output');
  * Fetches all methods from all enabled helpers,
  * and makes them available to use from I. object
  * Wraps helper methods into promises.
+ * @ignore
  */
 module.exports = function (obj) {
+  /**
+   * @interface
+   * @alias ActorStatic
+   */
   obj = obj || {};
 
   const helpers = container.helpers();
@@ -36,11 +41,23 @@ module.exports = function (obj) {
         });
     });
 
-  // add print comment method`
+  /**
+   * add print comment method`
+   * @param {string} msg
+   * @param {string} color
+   * @return {Promise<any> | undefined}
+   * @inner
+   */
   obj.say = (msg, color = 'cyan') => recorder.add(`say ${msg}`, () => {
     event.emit(event.step.comment, msg);
     output.say(msg, `${color}`);
   });
+  /**
+   * @function
+   * @param {*} opts
+   * @return {this}
+   * @inner
+   */
   obj.retry = retryStep;
 
   return obj;

package/lib/assert/error.js

@@ -11,9 +11,9 @@ function AssertionFailedError(params, template) {
   // this.message = "AssertionFailedError";
   let stack = new Error().stack;
   // this.showDiff = true;
-  stack = stack ? stack.split('\n').filter(line =>
-    // @todo cut assert things nicer
-    line.indexOf('lib/assert') < 0).join('\n') : '';
+
+  // @todo cut assert things nicer
+  stack = stack ? stack.split('\n').filter(line => line.indexOf('lib/assert') < 0).join('\n') : '';
   this.showDiff = true;
 
   this.actual = this.params.actual;

package/lib/codecept.js

@@ -1,12 +1,14 @@
-const fsPath = require('path');
+const existsSync = require('fs').existsSync;
 const readFileSync = require('fs').readFileSync;
+const glob = require('glob');
+const fsPath = require('path');
+const resolve = require('path').resolve;
+
 const container = require('./container');
 const Config = require('./config');
 const event = require('../lib/event');
-const glob = require('glob');
 const runHook = require('./hooks');
-const existsSync = require('fs').existsSync;
-const resolve = require('path').resolve;
+const output = require('./output');
 
 /**
  * CodeceptJS runner
@@ -29,7 +31,7 @@ class Codecept {
   /**
    * Require modules before codeceptjs running
    *
-   * @param {[string]} requiringModules
+   * @param {string[]} requiringModules
    */
   requireModules(requiringModules) {
     if (requiringModules) {
@@ -104,7 +106,7 @@ class Codecept {
    * Executes bootstrap.
    * If bootstrap is async, second parameter is required.
    *
-   * @param {() => any} [done]
+   * @param {Function} [done]
    */
   runBootstrap(done) {
     runHook(this.config.bootstrap, done, 'bootstrap');
@@ -171,6 +173,7 @@ class Codecept {
       mocha.run(() => this.teardown(done));
     } catch (e) {
       this.teardown(done);
+      output.error(e.stack);
       throw new Error(e);
     }
   }

package/lib/command/configMigrate.js

@@ -1,15 +1,16 @@
-const print = require('../output').print;
-const success = require('../output').success;
-const error = require('../output').error;
 const colors = require('chalk');
 const fs = require('fs');
-const path = require('path');
-const fileExists = require('../utils').fileExists;
 const inquirer = require('inquirer');
-const getTestRoot = require('./utils').getTestRoot;
 const mkdirp = require('mkdirp');
+const path = require('path');
 const util = require('util');
 
+const print = require('../output').print;
+const success = require('../output').success;
+const error = require('../output').error;
+const fileExists = require('../utils').fileExists;
+const getTestRoot = require('./utils').getTestRoot;
+
 module.exports = function (initPath) {
   const testsPath = getTestRoot(initPath);