codeceptjs 3.5.0 → 3.5.1-2.beta.7

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

@@ -1,49 +0,0 @@
-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
-
-* [codeceptjs-httpmock](https://github.com/testphony/codeceptjs-httpMock) -  a helper which wraps mockttp library to manage http mock in tests.
-* [codeceptjs-http](https://github.com/testphony/codeceptjs-http) - a helper which wraps then-request library to process HTTP requests. It's alternative helper that provides more flexible request management.
-* [codeceptjs-dbhelper](https://github.com/thiagodp/codeceptjs-dbhelper) - allows you to execute queries or commands to databases using database-js. 
-
-## Cloud Providers
-* [codeceptjs-saucehelper](https://github.com/puneet0191/codeceptjs-saucehelper/) - a helper which updates `Test Names` & `Test Results` on Saucelabs 
-* [codeceptjs-bshelper](https://github.com/PeterNgTr/codeceptjs-bshelper) - a helper which updates `Test Names` & `Test Results` on Browserstack 
-* [codeceptjs-tbhelper](https://github.com/testingbot/codeceptjs-tbhelper) - a helper which updates `Test Names` & `Test Results` on TestingBot 
-
-## Integrations
-* [codeceptjs-testrail](https://github.com/PeterNgTr/codeceptjs-testrail) - a plugin to integrate with [Testrail](https://www.gurock.com/testrail)
-
-## 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.
-* [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.
-
-## Assertion & Validations
-* [codeceptjs-chai](https://www.npmjs.com/package/codeceptjs-chai) is a CodeceptJS helper which wraps
-[chai](https://www.chaijs.com/) library to complete chai assertion steps with CodeceptJS logging.
-
-## Other
-
-* [codeceptjs-cmdhelper](https://github.com/thiagodp/codeceptjs-cmdhelper) allows you to run commands in the terminal/console
-* [eslint-plugin-codeceptjs](https://www.npmjs.com/package/eslint-plugin-codeceptjs) Eslint rules for CodeceptJS.

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

@@ -1,29 +0,0 @@
-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

@@ -1,139 +0,0 @@
-## [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.
-
-
-## [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
-
-## [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
-
-* 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
-
-## [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
-
-## [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
-
-
-## [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  
-
-## [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!
-
-* 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/Google-Summer-of-Code-(GSoC)-2020.md

@@ -1,68 +0,0 @@
-### About
-GSoC is an international annual program in which Google awards stipends to university students who successfully complete a requested coding project during the summer. 
-
-Codecept-JS has decided to apply to participate in GSoC 2020, Please note that the final list of GSoC 2020 organizations will be announced on 22nd Feb 2020.  
-
-To read more about the program please visit [GSoC Program](https://summerofcode.withgoogle.com/)
-
-The timeline for the program can be found on [Official Program Timeline](https://summerofcode.withgoogle.com/how-it-works/#timeline)
-
-### Contact Information
-
-For all the students who are interested in working with Codecept-JS organization for GSoC 2020, you can start by reaching out to our organization team by posting your interest in our [Forum](https://codecept.discourse.group/)
-
-Read about the Project on our [Official Project Website](https://codecept.io/)
-
-You can also join our Community Slack, which is used for community conversation, our GSoC team will be available on slack, we will have dedicated channel for GSoC Students and Projects, join [here](http://bit.ly/chat-codeceptjs)
-
-### Student Information
-
-If you are a student and are interested in participating, the following is useful information. 
-
-#### Proposal Guidelines
-Before applying as a Codeceptjs Contributor, we suggest you review the points below. It can help you with creating a strong Proposal.
-
-1. Read about Codeceptjs on our [Official Website](https://codecept.io/)
-2. Setup Codeceptjs on your working system, and then Go through the list of open issues on our [Github Repo](https://github.com/Codeception/CodeceptJS/issues), try to help us with fixing some of them, or help in testing existing PR's from our developers. 
-3. Go through the guides available on our official website, understand how our helpers work and check the list of current helpers on our organization [Github](https://github.com/codecept-js)
-
-#### Application Template
-
-If you are planning to send us a proposal, please make sure you have addressed the following elements:
-
-1. About you (your background, experience, education, hobbies)
-2. Project background (current state of what exist)
-3. Design/description of work
-4. Benefit of your work to the project users and developers
-5. Deliverables
-6. Scheduling
-7. Other commitments (i.e., exams, part time work, holidays, lectures, etc.)
-8. Community engagement (involvement, sample PR's, forum discussions, other open-source involvement)
-
-### Idea's for GSoC 2020
-
-#### Improve Visual Testing Support in Codeceptjs
-CodeceptJS has a visual testing helper which is based on resemble.js, instructions to set up and use the helper can be found [here](https://github.com/codecept-js/codeceptjs-resemblehelper)
-
-We have several improvements we want to make to our helper, here is the list. 
-1. Add Support for Allure Reporter
-2. Add Support for Visual Testing with [Codecept UI](https://codecept.io/ui/) 
-3. Support for [Workers](https://codecept.io/parallel/)
-
-Knowledge Prerequisite: Github, Nodejs, CodeceptJS, Resemble.js
-
-Difficulty: Medium
-
-Possible Mentors: Puneet Kala, Koushik Mohan
-
-#### Improve Codecept UI
-CodeceptJS has an interactive, graphical test runner, which is called CodeceptUI. It works on Browsers and helps in managing tests. 
-We need help with improving the CodeceptUI project, fixing existing issues. 
-1. To get started, please read about CodeceptUI [here](https://codecept.io/ui/)
-2. To get your hands on the code, you can check out the Repo [here](https://github.com/codecept-js/ui), look at the list of open issues and start with fixing them. 
-
-Knowledge Prerequisite: Github, CodeceptJS, JS, VueJS, Express.js, WebSockets, NodeJS
-
-Difficulty: Medium
-
-Possible Mentors: Michael Bodnarchuk, Paul 

package/docs/wiki/Home.md

@@ -1,16 +0,0 @@
-Wiki Pages contain community content which is partly copied into the website.
-
-* :toolbox:  [Community Helpers & Plugins](https://github.com/codeceptjs/CodeceptJS/wiki/Community-Helpers-&-Plugins) - collection of community-driven plugins and helpers (synced with website).
-* :eyes:  [Examples](https://github.com/codeceptjs/CodeceptJS/wiki/Examples) - collection of CodeceptJS sample projects (synced with website).
-* :book: [Books & Posts](https://github.com/Codeception/CodeceptJS/wiki/Books-&-Posts) - posts about CodeceptJS (synced with website).
-* :tv: [Videos](https://github.com/codeceptjs/CodeceptJS/wiki/Videos) - videos on CodeceptJS (synced with website).
-Add your own entries to these lists.
-
-Other useful links:
-* [Official Site](http://codecept.io)
-* [Roadmap](https://github.com/Codeception/CodeceptJS/wiki/Roadmap)
-* [Code on Github](https://github.com/Codeception/CodeceptJS)
-* [Change log](https://github.com/Codeception/CodeceptJS/blob/master/CHANGELOG.md)
-* [GSoC](https://github.com/Codeception/CodeceptJS/wiki/Google-Summer-of-Code-(GSoC)-2020)
-
-

package/docs/wiki/Release-Process.md

@@ -1,24 +0,0 @@
-This is the guide for maintainers:
-
-## Release Process
-
-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 `./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 `./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 `./runok.js docs:helpers` to build docs from helpers
-* Run `./runok.js publish:site` to update a website

package/docs/wiki/Roadmap.md

@@ -1,23 +0,0 @@
-[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)