preparing release

DavertMik · DavertMik · commit 65686a2d4ea6 · 2019-06-05T03:26:52.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,28 @@
+## 2.1.4
+
+* [WebDriver][Puppeteer][Protractor][Nightmare] A11y locator support introduced by @Holorium. Clickable elements as well as fields can be located by following attributes:
+  * `aria-label`
+  * `title`
+  * `aria-labelledby`
+* [Puppeteer] Added support for React locators.
+  * New [React Guide](https://codecept.io/react) added.
+* [Puppeteer] Deprecated `downloadFile`
+* [Puppeteer] Introduced `handleDownloads` replacing `downloadFile`
+* [puppeteerCoverage plugin] Fixed path already exists error by @seta-tuha.
+* Fixed 'ERROR: ENAMETOOLONG' creating directory names in `run-multiple` with long config. By @artvinn
+* [REST] Fixed url autocompletion combining base and relative paths by @LukoyanovE
+* [Nightmare][Protractor] `uncheckOption` method introduced by @PeterNgTr
+* [autoLogin plugin] Enable to use  without `await` by @tsuemura
+* [Puppeteer] Fixed `UnhandledPromiseRejectionWarning: "Execution context was destroyed...` by @adrielcodeco
+* [WebDriver] Keep browser window dimensions when starting a new session by @spiroid
+* Replace Ghekrin plceholders with values in files that combine a scenerio outline and table by @medtoure18.
+* Added Documentation to [locate elements in React Native](https://codecept.io/react-native-locators) apps. By @DimGun.
+* Adding optional `path` parameter to `bdd:snippets` command to append snippets to a specific file. By @cthorsen31.
+* Added optional `output` parameter to `def` command by @LukoyanovE.
+* [Puppeteer] Added `grabDataFromPerformanceTiming` by @PeterNgTr.
+* axios updated to `0.19.0` by @SteveShaffer
+* TypeScript defitions updated by @LukoyanovE. Added `secret` and `inject` function.
+
 ## 2.1.3
 
 * Fixed autoLogin plugin to inject `login` function
diff --git a/RoboFile.php b/RoboFile.php
@@ -7,7 +7,16 @@
 class RoboFile extends \Robo\Tasks
 {
 
-    function docs()
+    function docs() {
+        $this->docsHelpers();
+        $this->docsPlugins();
+    }
+
+    function docsPlugins() {
+        $this->_exec("npx documentation build lib/plugin/*.js -o docs/plugins.md -f md --shallow --markdown-toc=false --sort-order=alpha ");
+    }
+
+    function docsHelpers()
     {
         $files = scandir('lib/helper');
 
@@ -88,25 +97,47 @@ function wiki()
             ->run();
 
         $this->taskWriteToFile('docs/community-helpers.md')
-        ->line('---')
-        ->line('id: community-helpers')
-        ->line('title: Community Helpers')
-        ->line('---')
-        ->line('')
-        ->line('> Share your helpers at our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Community-Helpers)')
-        ->line('')
-        ->textFromFile('website/wiki/Community-Helpers.md')
-        ->run();
+            ->line('---')
+            ->line('id: community-helpers')
+            ->line('title: Community Helpers')
+            ->line('---')
+            ->line('')
+            ->line('> Share your helpers at our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Community-Helpers)')
+            ->line('')
+            ->textFromFile('website/wiki/Community-Helpers.md')
+            ->run();
 
         $this->taskWriteToFile('docs/examples.md')
-        ->line('---')
-        ->line('id: examples')
-        ->line('title: Examples')
-        ->line('---')
-        ->line('')
-        ->line('> Add your own examples to our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Examples)')
-        ->textFromFile('website/wiki/Examples.md')
-        ->run();
+            ->line('---')
+            ->line('id: examples')
+            ->line('title: Examples')
+            ->line('---')
+            ->line('')
+            ->line('> Add your own examples to our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Examples)')
+            ->textFromFile('website/wiki/Examples.md')
+            ->run();
+
+        $this->taskWriteToFile('docs/books.md')
+            ->line('---')
+            ->line('id: books')
+            ->line('title: Books & Posts')
+            ->line('---')
+            ->line('')
+            ->line('> Add your own books or posts to our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Books-&-Posts)')
+            ->textFromFile('website/wiki/Books-&-Posts.md')
+            ->run();
+
+        $this->taskWriteToFile('docs/videos.md')
+            ->line('---')
+            ->line('id: videos')
+            ->line('title: Videos')
+            ->line('---')
+            ->line('')
+            ->line('> Add your own videos to our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Videos)')
+            ->textFromFile('website/wiki/Videos.md')
+            ->run();
+
+
     }
 
     function testServer()
diff --git a/docs/books.md b/docs/books.md
@@ -0,0 +1,31 @@
+---
+id: books
+title: Books & Posts
+---
+
+> Add your own books or posts to our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Books-&-Posts)
+### Practical End 2 End Testing with CodeceptJS
+
+A book by **Paul Vincent Beigang**
+
+[![](https://user-images.githubusercontent.com/220264/58870454-e2e8ce80-86c8-11e9-868e-7deefdde47ce.png)](https://leanpub.com/codeceptjs/)
+
+#### Contents:
+
+1. Preparation for End 2 End Testing with CodeceptJS
+1. Setup CodeceptJS with WebdriverIO
+1. Create Your First CodeceptJS Test
+1. Run Your First CodeceptJS Test Locally
+1. Run Test on BrowserStack Against with the Safari Browser
+1. How to Debug & Fix a Failing E2E Test
+1. Run a CodeceptJS Test in GitLab´s Continuous Integration (CI) Environment
+1. Delicious Test Reports With Allure
+
+### Posts
+
+A list of good educational posts about CodeceptJS
+
+* [Effective End2End Tests with CodeceptJS](https://hackernoon.com/effective-end-2-end-testing-in-javascript-with-codeceptjs-37c8d7d6a928) by @davertmik
+* [Running End to End tests as Google Cloud Functions](https://hackernoon.com/running-end-to-end-tests-as-google-cloud-functions-f5e34ffc3984)
+* [End-To-End Testing With CodeceptJS](https://www.monterail.com/blog/end-to-end-testing-with-codeceptjs) by Piotr Michalski
+* [Getting started with CodeceptJS and Selenium WebDriver](https://medium.com/@garrettvorce/getting-started-with-selenium-and-codeceptjs-c0698e8df677)
diff --git a/docs/examples.md b/docs/examples.md
@@ -9,13 +9,6 @@ title: 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.
 
-## [CodeceptJS Quick Start with Cucumber/Gherkin](https://github.com/gkushang/codeceptjs-quick-start)
-
-This repository demonstrate the CodeceptJS with Cucumber/Gherkin configuration
-
-* Easy 3-Steps process to colocate the CodeceptJS with Gherkin tests with your project
-* Quick Start with CodeceptJS wih Cucumber/Gherkin
-* Sample example and feature files to test GitHub Features
 
 ## [Testing Single Page Application](https://github.com/bugiratracker/codeceptjs-demo)
 
@@ -40,6 +33,14 @@ This repository demonstrates usage of:
 * testing WYSIWYG editor
 * GitLab CI
 
+## [Quick Start with Cucumber/Gherkin](https://github.com/gkushang/codeceptjs-quick-start)
+
+This repository demonstrates the CodeceptJS with Cucumber/Gherkin configuration
+
+* Easy 3-Steps process to colocate the CodeceptJS with Gherkin tests with your project
+* Quick Start with CodeceptJS wih Cucumber/Gherkin
+* Sample example and feature files to test GitHub Features
+
 ## [Amazon Tests v2](https://gitlab.com/thanhnguyendh/codeceptjs-wdio-services)
 
 Testing Amazon website using Selenium WebDriver.
@@ -100,3 +101,11 @@ This repository demonstrates usage of
 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
diff --git a/docs/plugins.md b/docs/plugins.md
@@ -1,7 +1,3 @@
----
-id: plugins
-title: Plugins
----
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
 ## allure
@@ -54,6 +50,12 @@ const allure = codeceptjs.container.plugins('allure');
 
 -   `addAttachment(name, buffer, type)` - add an attachment to current test / suite
 -   `addLabel(name, value)` - adds a label to current test
+-   `severity(value)` - adds severity label
+-   `epic(value)` - adds epic label
+-   `feature(value)` - adds feature label
+-   `story(value)` - adds story label
+-   `issue(value)` - adds issue label
+-   `setDescription(description, type)` - sets a description
 
 ### Parameters
 
diff --git a/docs/video.md b/docs/video.md
diff --git a/docs/videos.md b/docs/videos.md
@@ -0,0 +1,19 @@
+---
+id: videos
+title: Videos
+---
+
+> Add your own videos to our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Videos)
+## [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
+
+
diff --git a/lib/plugin/allure.js b/lib/plugin/allure.js
@@ -61,6 +61,12 @@ const defaultConfig = {
  *
  * * `addAttachment(name, buffer, type)` - add an attachment to current test / suite
  * * `addLabel(name, value)` - adds a label to current test
+ * * `severity(value)` - adds severity label
+ * * `epic(value)` - adds epic label
+ * * `feature(value)` - adds feature label
+ * * `story(value)` - adds story label
+ * * `issue(value)` - adds issue label
+ * * `setDescription(description, type)` - sets a description
  *
  */
 module.exports = (config) => {
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "2.1.3",
+  "version": "2.1.4",
   "description": "Modern Era Acceptance Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
diff --git a/website/sidebars.json b/website/sidebars.json
@@ -1,9 +1,11 @@
 {
   "docs": {
     "Quickstart": [
-      "quickstart",
-      "basics",
-      "video",
+      "quickstart"
+    ],
+    "Tutorials": [
+      "books",
+      "videos",
       "examples"
     ],
     "Web Testing": [
@@ -37,8 +39,7 @@
       "plugins",
       "docker",
       "reports",
-      "translation",
-      "community-helpers"
+      "translation"
     ],
     "Driver Helpers": [
       "helpers/WebDriver",
@@ -47,10 +48,11 @@
       "helpers/Nightmare",
       "helpers/Appium"
     ],
-    "Data Helpers": [
+    "Additional Helpers": [
       "helpers/REST",
       "helpers/ApiDataFactory",
-      "helpers/FileSystem"
+      "helpers/FileSystem",
+      "community-helpers"
     ]
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,12 @@ const defaultConfig = {`
`61`	`61`	`*`
`62`	`62`	* * `addAttachment(name, buffer, type)` - add an attachment to current test / suite
`63`	`63`	* * `addLabel(name, value)` - adds a label to current test
	`64`	+ * * `severity(value)` - adds severity label
	`65`	+ * * `epic(value)` - adds epic label
	`66`	+ * * `feature(value)` - adds feature label
	`67`	+ * * `story(value)` - adds story label
	`68`	+ * * `issue(value)` - adds issue label
	`69`	+ * * `setDescription(description, type)` - sets a description
`64`	`70`	`*`
`65`	`71`	`*/`
`66`	`72`	`module.exports = (config) => {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "codeceptjs",`
`3`		`- "version": "2.1.3",`
	`3`	`+ "version": "2.1.4",`
`4`	`4`	`"description": "Modern Era Acceptance Testing Framework for NodeJS",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"acceptance",`