codeceptjs 3.3.2 → 3.3.5-beta.1

package/docs/wiki/.git/hooks/prepare-commit-msg.sample

@@ -0,0 +1,42 @@
+#!/bin/sh
+#
+# An example hook script to prepare the commit log message.
+# Called by "git commit" with the name of the file that has the
+# commit message, followed by the description of the commit
+# message's source.  The hook's purpose is to edit the commit
+# message file.  If the hook fails with a non-zero status,
+# the commit is aborted.
+#
+# To enable this hook, rename this file to "prepare-commit-msg".
+
+# This hook includes three examples. The first one removes the
+# "# Please enter the commit message..." help message.
+#
+# The second includes the output of "git diff --name-status -r"
+# into the message, just before the "git status" output.  It is
+# commented because it doesn't cope with --amend or with squashed
+# commits.
+#
+# The third example adds a Signed-off-by line to the message, that can
+# still be edited.  This is rarely a good idea.
+
+COMMIT_MSG_FILE=$1
+COMMIT_SOURCE=$2
+SHA1=$3
+
+/usr/bin/perl -i.bak -ne 'print unless(m/^. Please enter the commit message/..m/^#$/)' "$COMMIT_MSG_FILE"
+
+# case "$COMMIT_SOURCE,$SHA1" in
+#  ,|template,)
+#    /usr/bin/perl -i.bak -pe '
+#       print "\n" . `git diff --cached --name-status -r`
+# 	 if /^#/ && $first++ == 0' "$COMMIT_MSG_FILE" ;;
+#  *) ;;
+# esac
+
+# SOB=$(git var GIT_COMMITTER_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# git interpret-trailers --in-place --trailer "$SOB" "$COMMIT_MSG_FILE"
+# if test -z "$COMMIT_SOURCE"
+# then
+#   /usr/bin/perl -i.bak -pe 'print "\n" if !$first_line++' "$COMMIT_MSG_FILE"
+# fi

package/docs/wiki/.git/hooks/push-to-checkout.sample

@@ -0,0 +1,78 @@
+#!/bin/sh
+
+# An example hook script to update a checked-out tree on a git push.
+#
+# This hook is invoked by git-receive-pack(1) when it reacts to git
+# push and updates reference(s) in its repository, and when the push
+# tries to update the branch that is currently checked out and the
+# receive.denyCurrentBranch configuration variable is set to
+# updateInstead.
+#
+# By default, such a push is refused if the working tree and the index
+# of the remote repository has any difference from the currently
+# checked out commit; when both the working tree and the index match
+# the current commit, they are updated to match the newly pushed tip
+# of the branch. This hook is to be used to override the default
+# behaviour; however the code below reimplements the default behaviour
+# as a starting point for convenient modification.
+#
+# The hook receives the commit with which the tip of the current
+# branch is going to be updated:
+commit=$1
+
+# It can exit with a non-zero status to refuse the push (when it does
+# so, it must not modify the index or the working tree).
+die () {
+	echo >&2 "$*"
+	exit 1
+}
+
+# Or it can make any necessary changes to the working tree and to the
+# index to bring them to the desired state when the tip of the current
+# branch is updated to the new commit, and exit with a zero status.
+#
+# For example, the hook can simply run git read-tree -u -m HEAD "$1"
+# in order to emulate git fetch that is run in the reverse direction
+# with git push, as the two-tree form of git read-tree -u -m is
+# essentially the same as git switch or git checkout that switches
+# branches while keeping the local changes in the working tree that do
+# not interfere with the difference between the branches.
+
+# The below is a more-or-less exact translation to shell of the C code
+# for the default behaviour for git's push-to-checkout hook defined in
+# the push_to_deploy() function in builtin/receive-pack.c.
+#
+# Note that the hook will be executed from the repository directory,
+# not from the working tree, so if you want to perform operations on
+# the working tree, you will have to adapt your code accordingly, e.g.
+# by adding "cd .." or using relative paths.
+
+if ! git update-index -q --ignore-submodules --refresh
+then
+	die "Up-to-date check failed"
+fi
+
+if ! git diff-files --quiet --ignore-submodules --
+then
+	die "Working directory has unstaged changes"
+fi
+
+# This is a rough translation of:
+#
+#   head_has_history() ? "HEAD" : EMPTY_TREE_SHA1_HEX
+if git cat-file -e HEAD 2>/dev/null
+then
+	head=HEAD
+else
+	head=$(git hash-object -t tree --stdin </dev/null)
+fi
+
+if ! git diff-index --quiet --cached --ignore-submodules $head --
+then
+	die "Working directory has staged changes"
+fi
+
+if ! git read-tree -u -m "$commit"
+then
+	die "Could not update working tree to new HEAD"
+fi

package/docs/wiki/.git/hooks/update.sample

@@ -0,0 +1,128 @@
+#!/bin/sh
+#
+# An example hook script to block unannotated tags from entering.
+# Called by "git receive-pack" with arguments: refname sha1-old sha1-new
+#
+# To enable this hook, rename this file to "update".
+#
+# Config
+# ------
+# hooks.allowunannotated
+#   This boolean sets whether unannotated tags will be allowed into the
+#   repository.  By default they won't be.
+# hooks.allowdeletetag
+#   This boolean sets whether deleting tags will be allowed in the
+#   repository.  By default they won't be.
+# hooks.allowmodifytag
+#   This boolean sets whether a tag may be modified after creation. By default
+#   it won't be.
+# hooks.allowdeletebranch
+#   This boolean sets whether deleting branches will be allowed in the
+#   repository.  By default they won't be.
+# hooks.denycreatebranch
+#   This boolean sets whether remotely creating branches will be denied
+#   in the repository.  By default this is allowed.
+#
+
+# --- Command line
+refname="$1"
+oldrev="$2"
+newrev="$3"
+
+# --- Safety check
+if [ -z "$GIT_DIR" ]; then
+	echo "Don't run this script from the command line." >&2
+	echo " (if you want, you could supply GIT_DIR then run" >&2
+	echo "  $0 <ref> <oldrev> <newrev>)" >&2
+	exit 1
+fi
+
+if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then
+	echo "usage: $0 <ref> <oldrev> <newrev>" >&2
+	exit 1
+fi
+
+# --- Config
+allowunannotated=$(git config --type=bool hooks.allowunannotated)
+allowdeletebranch=$(git config --type=bool hooks.allowdeletebranch)
+denycreatebranch=$(git config --type=bool hooks.denycreatebranch)
+allowdeletetag=$(git config --type=bool hooks.allowdeletetag)
+allowmodifytag=$(git config --type=bool hooks.allowmodifytag)
+
+# check for no description
+projectdesc=$(sed -e '1q' "$GIT_DIR/description")
+case "$projectdesc" in
+"Unnamed repository"* | "")
+	echo "*** Project description file hasn't been set" >&2
+	exit 1
+	;;
+esac
+
+# --- Check types
+# if $newrev is 0000...0000, it's a commit to delete a ref.
+zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0')
+if [ "$newrev" = "$zero" ]; then
+	newrev_type=delete
+else
+	newrev_type=$(git cat-file -t $newrev)
+fi
+
+case "$refname","$newrev_type" in
+	refs/tags/*,commit)
+		# un-annotated tag
+		short_refname=${refname##refs/tags/}
+		if [ "$allowunannotated" != "true" ]; then
+			echo "*** The un-annotated tag, $short_refname, is not allowed in this repository" >&2
+			echo "*** Use 'git tag [ -a | -s ]' for tags you want to propagate." >&2
+			exit 1
+		fi
+		;;
+	refs/tags/*,delete)
+		# delete tag
+		if [ "$allowdeletetag" != "true" ]; then
+			echo "*** Deleting a tag is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	refs/tags/*,tag)
+		# annotated tag
+		if [ "$allowmodifytag" != "true" ] && git rev-parse $refname > /dev/null 2>&1
+		then
+			echo "*** Tag '$refname' already exists." >&2
+			echo "*** Modifying a tag is not allowed in this repository." >&2
+			exit 1
+		fi
+		;;
+	refs/heads/*,commit)
+		# branch
+		if [ "$oldrev" = "$zero" -a "$denycreatebranch" = "true" ]; then
+			echo "*** Creating a branch is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	refs/heads/*,delete)
+		# delete branch
+		if [ "$allowdeletebranch" != "true" ]; then
+			echo "*** Deleting a branch is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	refs/remotes/*,commit)
+		# tracking branch
+		;;
+	refs/remotes/*,delete)
+		# delete tracking branch
+		if [ "$allowdeletebranch" != "true" ]; then
+			echo "*** Deleting a tracking branch is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	*)
+		# Anything else (is there anything else?)
+		echo "*** Update hook: unknown type of update to ref $refname of type $newrev_type" >&2
+		exit 1
+		;;
+esac
+
+# --- Finished
+exit 0

package/docs/wiki/.git/info/exclude

@@ -0,0 +1,6 @@
+# git ls-files --others --exclude-from=.git/info/exclude
+# Lines that start with '#' are comments.
+# For a project mostly in C, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~

package/docs/wiki/.git/logs/HEAD

@@ -0,0 +1 @@
+0000000000000000000000000000000000000000 5f1ae54d1bc8bb84bfa836e2547181e31d01bc7a Davert <davert.ua@gmail.com> 1657708587 +0300	clone: from github.com:codeceptjs/CodeceptJS.wiki.git

package/docs/wiki/.git/logs/refs/heads/master

@@ -0,0 +1 @@
+0000000000000000000000000000000000000000 5f1ae54d1bc8bb84bfa836e2547181e31d01bc7a Davert <davert.ua@gmail.com> 1657708587 +0300	clone: from github.com:codeceptjs/CodeceptJS.wiki.git

package/docs/wiki/.git/logs/refs/remotes/origin/HEAD

@@ -0,0 +1 @@
+0000000000000000000000000000000000000000 5f1ae54d1bc8bb84bfa836e2547181e31d01bc7a Davert <davert.ua@gmail.com> 1657708587 +0300	clone: from github.com:codeceptjs/CodeceptJS.wiki.git

package/docs/wiki/.git/packed-refs

@@ -0,0 +1,2 @@
+# pack-refs with: peeled fully-peeled sorted 
+5f1ae54d1bc8bb84bfa836e2547181e31d01bc7a refs/remotes/origin/master

package/docs/wiki/.git/refs/heads/master

@@ -0,0 +1 @@
+5f1ae54d1bc8bb84bfa836e2547181e31d01bc7a

package/docs/wiki/.git/refs/remotes/origin/HEAD

@@ -0,0 +1 @@
+ref: refs/remotes/origin/master

package/docs/wiki/Community-Helpers-&-Plugins.md

@@ -1,10 +1,15 @@
 Here is the list of helpers created by our community.
 Please **add your own** by editing this page.
+## Webhooks
+
+* [codeceptjs-webhook-helper](https://github.com/onemolegames/codeceptjs-webhook-helper) - to check webhook calls during the tests.
 
 ## Email Checking
 
 * [MailCatcher](https://gist.github.com/schmkr/026732dfa1627b927ff3a08dc31ee884) - to check emails via Mailcatcher locally.
 * [codeceptjs-mailhog-helper](https://github.com/tsuemura/codeceptjs-mailhog-helper) - to check emails via Mailhog locally.
+* [codeceptjs-testmailapp-helper](https://github.com/pavkam/codeceptjs-testmailapp-helper) - to check emails via Testmail.app service.
+* [codeceptjs-mailosaurhelper](https://github.com/yurkovychv/codeceptjs-mailosaur) - to check emails via [Mailosaur](https://mailosaur.com/) service.
 
 ## Data Sources
 
@@ -23,14 +28,13 @@ Please **add your own** by editing this page.
 ## Visual-Testing
 * [codeceptjs-resemblehelper](https://github.com/puneet0191/codeceptjs-resemblehelper) - a helper which helps with visual testing using resemble.js. 
 * [codeceptjs-applitoolshelper](https://www.npmjs.com/package/codeceptjs-applitoolshelper) - a helper which helps interaction with [Applitools](https://applitools.com)
+* [codeceptjs-pixelmatchhelper](https://github.com/stracker-phil/codeceptjs-pixelmatchhelper) - a helper that integrates pixelmatch for visual testing. 
 
 ## Reporters
 * [codeceptjs-rphelper](https://github.com/reportportal/agent-js-codecept) is a CodeceptJS helper which can publish tests results on ReportPortal after execution.
 * [codeceptjs-xray-helper](https://www.npmjs.com/package/codeceptjs-xray-helper) is a CodeceptJS helper which can publish tests results on [XRAY](https://confluence.xpand-it.com/display/XRAYCLOUD/Import+Execution+Results+-+REST).
 * [codeceptjs-slack-reporter](https://www.npmjs.com/package/codeceptjs-slack-reporter) Get a Slack notification when one or more scenarios fail.
-
-## Page Object Code Generator
-* [codeceptjs-CodeGenerator](https://github.com/senthillkumar/CodeCeptJS-PageObject) is a CodeceptJS custom wrapper which can create page class with action methods from the page object file(JSON) and project setup(Folder Structure).
+* [codeceptjs-browserlogs-plugin](https://github.com/pavkam/codeceptjs-browserlogs-plugin) Record the browser logs for failed tests.
 
 ## Browser request control
 * [codeceptjs-resources-check](https://github.com/luarmr/codeceptjs-resources-check) Load a URL with Puppeteer and listen to the requests while the page is loading. Enabling count the number or check the sizes of the requests.

package/docs/wiki/Converting-Playwright-to-Istanbul-Coverage.md

@@ -0,0 +1,29 @@
+How to convert `playwright` coverage format to `istanbul` coverage
+
+To convert coverage generated from `playwright` to `istanbul` coverage, you first need to install
+- [`v8-to-istanbul`](https://www.npmjs.com/package/v8-to-istanbul)
+
+Once installed, convert the coverage to a format which `istanbul` can recognize, by writing a script as shown below.
+
+```js
+const v8toIstanbul = require('v8-to-istanbul');
+// read all the coverage file from output/coverage folder
+const coverage = require('./output/coverage/Visit_Home_1630335005.coverage.json');
+const fs = require('fs/promises');
+
+(async () => {
+    for (const entry of coverage) {
+        // Used to get file name
+        const file = entry.url.match(/(?:http(s)*:\/\/.*\/)(?<file>.*)/);
+        const converter = new v8toIstanbul(file.groups.file, 0, {
+            source: entry.source
+        });
+
+        await converter.load();
+        converter.applyCoverage(entry.functions);
+
+        // Store converted coverage file which can later be used to generate report
+        await fs.writeFile('./coverage/final.json', JSON.stringify(converter.toIstanbul(), null, 2));
+    }
+})();
+```

package/docs/wiki/Examples.md

@@ -19,11 +19,35 @@ CodeceptJS repo contains basic tests (both failing and passing) just to show how
 Our team uses it to test new features and run simple scenarios.
 
 
-## [Testing Single Page Application](https://github.com/bugiratracker/codeceptjs-demo)
+## [CodeceptJS Cucumber E2E Framework](https://github.com/gkushang/codeceptjs-e2e)
 
-![](https://user-images.githubusercontent.com/220264/56353972-56975080-61db-11e9-8b23-06e8b4620995.png)
+This repository contains complete E2E framework for CodeceptJS with Cucumber and SauceLabs Integration
 
-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.
+* 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
+
+## [Enterprise Grade Tests](https://github.com/uc-cdis/gen3-qa)
+
+Complex testing solution by [Gen3](https://github.com/uc-cdis/gen3-qa) 
+
+Includes 
+
+* classical CodeceptJS tests
+* BDD tests
+* Jenkins integration
+* Complex Before/BeforeSuite scripts and more
+
+## [Testing Single Page Application](https://github.com/bugiratracker/codeceptjs-demo)
+
+End 2 end tests for Task management app (currently offline).
 
 Tests repository demonstrate usage of
 
@@ -42,21 +66,6 @@ This repository demonstrates usage of:
 * 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.
@@ -69,17 +78,6 @@ This repository demonstrates usage of:
 * 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
@@ -91,17 +89,6 @@ This repository demonstrates usage of:
 * 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.
@@ -137,12 +124,16 @@ This is a ready to use example that shows how to integrate CodeceptJS with Puppe
 * examples for sequential and parallel execution
 * generation of allure test results  
 
-## [Framework with UI and API test support : CodeceptJS , Puppeteer , REST , ESLint](https://github.com/avighub/CodeceptJS-puppeteer)
-This is a basic framework with Puppeteer , REST helpers which can support both UI and API actions within same test.
-More improvements and features will be added and will be updated. 
-Suggestions and improvements are welcome , please raise a ticket in Issue tab.
+## [Example for Advanced REST API testing: TypeScript, Axios, CodeceptJS, Jest Expect, Docker, Allure, Mock-Server, Prettier + Eslint, pre-commit, Jest Unit Tests ](https://github.com/EgorBodnar/rest-axios-codeceptjs-allure-docker-test-example)
+One button example with built-in mocked backend. 
+
+If you already have a UI testing solution based on the CodeceptJS and you need to implement advanced REST API testing you can just extend your existing framework. Use this implementation as an example.
+This is necessary if all integrations with TMS and CI/CD are already configured, and you do not want to reconnect and configure the plugins and libraries used for the new test runner. Use CodeceptJS!
 
-* Step by step setup in README
-* Two helpers are added. UI - Puppeteer , API - REST and chai-codeceptJS for assetion
-* ESLint for code check
-* Upcoming : API generic functions , Adaptor design pattern , More utilities
+* Easy run
+* Detailed README
+* Well documented mocked backend's REST API endpoints
+* HTTP request client with session support and unit tests
+* Exemplary code control
+* Ready to launch in a CI/CD system as is
+* OOP, Test data models and builders, endpoint decorators

package/docs/wiki/Release-Process.md

@@ -2,23 +2,23 @@ This is the guide for maintainers:
 
 ## Release Process
 
-1. Pull the latest changes from master
-2. Create a branch `release-x.x.x` and switch to it `git checkout -b release-x.x.x`
+1. Pull the latest changes from main branch for release stream e.g. 3.x
+2. Create a release branch and switch to it by `git checkout -b release-x.x.x`
 3. Update version in `package.json`
 4. Go through the commits for the new release and add them to the CHANGELOG.md: 
   * Changelog should be written for humans (not for robots). 
   * Use simple wording explaining what the change is, how to use a new feature (maybe with a code example) and mention the 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
+5. Run `./runok.js docs` to build documentation
 6. Commit all changes, push and create a PR
 7. Check that all tests pass and merge your PR
-8. Run `./runio.js release` to publish latest release. The website will be updated.
-  * To update version for patch release: `./runio.js release patch`
-  * To update version for minor release: `./runio.js release minor`
+8. Run `./runok.js release` to publish latest release. The website will be updated.
+  * To update version for patch release: `./runok.js release patch`
+  * To update version for minor release: `./runok.js release minor`
 9. Post announcements in Twitter & Slack
 
 ## Updating the website
 
-* Run `./runio.js docs:helpers` to build docs from helpers
-* Run `./runio.js publish:site` to update a website
+* Run `./runok.js docs:helpers` to build docs from helpers
+* Run `./runok.js publish:site` to update a website