deprecated: nightmare (#3754)

* depreacted: nightmare

* depreacted: nightmare

* depreacted: nightmare

* fix: typings

Author: kobenguyent

.circleci/config.yml

@@ -19,10 +19,6 @@ defaults: &defaults
         command: docker-compose run --rm test-acceptance.webdriverio
         working_directory: test
         when: always
-    - run:
-        command: docker-compose run --rm test-acceptance.nightmare
-        working_directory: test
-        when: always
     - run:
         command: docker-compose run --rm test-acceptance.puppeteer
         working_directory: test

.circleci/test.sh

@@ -7,5 +7,4 @@ cd test
 docker-compose run --rm test-unit &&
 docker-compose run --rm test-rest &&
 docker-compose run --rm test-acceptance.webdriverio &&
-docker-compose run --rm test-acceptance.nightmare &&
 docker-compose run --rm test-acceptance.puppeteer

.github/CONTRIBUTING.md

@@ -39,9 +39,9 @@ DEBUG=codeceptjs:* npx codeceptjs run
 
 ## Helpers
 
-Please keep in mind that CodeceptJS have **unified API** for Playwright, WebDriverIO, Appium, Nightmare, Puppeteer, TestCafe. Tests written using those helpers should be compatible at syntax level. However, some of helpers may contain unique methods. That happens. If, for instance, WebDriverIO has method XXX and Nightmare doesn't, you can implement XXX inside Nightmare using the same method signature.
+Please keep in mind that CodeceptJS have **unified API** for Playwright, WebDriverIO, Appium, Puppeteer, TestCafe. Tests written using those helpers should be compatible at syntax level. However, some helpers may contain unique methods. That happens. If, for instance, WebDriverIO has method XXX and Playwright doesn't, you can implement XXX inside Playwright using the same method signature.
 
-### Updating Playwright | Puppeteer | WebDriver | Nightmare
+### Updating Playwright | Puppeteer | WebDriver
 
 *Whenever a new method or new behavior is added it should be documented in a docblock. Valid JS-example is required! Do **not edit** `docs/helpers/`, those files are generated from docblocks in corresponding helpers! *
 
@@ -61,7 +61,6 @@ Execute test suite:
 ```sh
 mocha test/helper/WebDriver_test.js
 mocha test/helper/Puppeteer_test.js
-mocha test/helper/Nightmare_test.js
 ```
 
 Use `--grep` to execute tests only for changed parts.
@@ -187,11 +186,14 @@ docker-compose run --rm test-helpers test/rest
 
 #### Run acceptance tests
 
+<<<<<<< HEAD
+To that we provide three separate services respectively for WebDriver, Puppeteer tests:
+=======
 To that we provide three separate services respectively for WebDriver, Nightmare and Puppeteer tests:
+>>>>>>> 3.x
 
 ```sh
 docker-compose run --rm test-acceptance.webdriverio
-docker-compose run --rm test-acceptance.nightmare
 docker-compose run --rm test-acceptance.puppeteer
 ```
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -4,14 +4,13 @@
 
 Applicable helpers:
 
-- [ ] WebDriver
+- [ ] Playwright
 - [ ] Puppeteer
-- [ ] Nightmare
+- [ ] WebDriver
 - [ ] REST
 - [ ] FileHelper
 - [ ] Appium
 - [ ] TestCafe
-- [ ] Playwright
 
 Applicable plugins:
 

Dockerfile

@@ -1,11 +1,7 @@
 # Download Playwright and its dependencies
 FROM mcr.microsoft.com/playwright:focal
 
-# Add our user and group first to make sure their IDs get assigned consistently,
-# regardless of whatever dependencies get added.
-RUN groupadd --system nightmare && useradd --system --create-home --gid nightmare nightmare
-
-# Installing the pre-required packages and libraries for electron & Nightmare
+# Installing the pre-required packages and libraries
 RUN apt-get update && \
       apt-get install -y libgtk2.0-0 libgconf-2-4 \
       libasound2 libxtst6 libxss1 libnss3 xvfb
@@ -38,7 +34,7 @@ ENV HOST=selenium
 # Run user as non privileged.
 # USER pptruser
 
-# Set the entrypoint for Nightmare
+# Set the entrypoint
 ENTRYPOINT ["/codecept/docker/entrypoint"]
 
 # Run tests

README.md

@@ -44,7 +44,6 @@ CodeceptJS uses **Helper** modules to provide actions to `I` object. Currently,
 * [**Puppeteer**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Puppeteer.md) - uses Google Chrome's Puppeteer for fast headless testing.
 * [**WebDriver**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/WebDriver.md) - uses [webdriverio](http://webdriver.io/) to run tests via WebDriver protocol.
 * [**TestCafe**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/TestCafe.md) - cheap and fast cross-browser test automation.
-* [**Nightmare**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Nightmare.md) - uses Electron and NightmareJS to run tests.
 * [**Appium**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Appium.md) - for **mobile testing** with Appium
 * [**Detox**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Detox.md) - This is a wrapper on top of Detox library, aimed to unify testing experience for CodeceptJS framework. Detox provides a grey box testing for mobile applications, playing especially well for React Native apps.
 

docker/README.md

@@ -1,6 +1,6 @@
 # Codeceptjs Docker
 
-CodeceptJS packed into container with the Nightmare, Playwright, Puppeteer, and WebDriverIO drivers.
+CodeceptJS packed into container with the Playwright, Puppeteer, and WebDriverIO drivers.
 
 ## How to Use
 
@@ -13,7 +13,7 @@ CodeceptJS runner is available inside container as `codeceptjs`.
 
 ### Locally
 
-You can execute CodeceptJS with Puppeteer or Nightmare locally with no extra configuration.
+You can execute CodeceptJS with either Playwright or Puppeteer locally with no extra configuration.
 
 ```sh
 docker run --net=host -v $PWD:/tests codeception/codeceptjs
@@ -80,7 +80,6 @@ $ docker run -it --rm -v /<path_to_codeceptjs_test_dir>/:/tests/ --link selenium
 
 You may run use `-v $(pwd)/:tests/` if running this from the root of your CodeceptJS tests directory.
 _Note: The output of your test run will appear in your local directory if your output path is `./output` in the CodeceptJS config_
-_Note: If running with the Nightmare driver, it is not necessary to run a selenium docker container and link it. So `--link selenium-chrome:selenium` may be omitted_
 
 ### Build
 

docs/basics.md

@@ -41,7 +41,6 @@ Refer to following guides to more information on:
 * [▶ Playwright](/playwright)
 * [▶ WebDriver](/webdriver)
 * [▶ Puppeteer](/puppeteer)
-* [▶ Nightmare](/nightmare)
 * [▶ TestCafe](/testcafe)
 
 > ℹ Depending on a helper selected a list of available actions may change.
@@ -783,7 +782,7 @@ within({frame: "#editor"}, () => {
 
 > ℹ IFrames can also be accessed via `I.switchTo` command of a corresponding helper.
 
-Nested IFrames can be set by passing an array *(WebDriver, Nightmare & Puppeteer only)*:
+Nested IFrames can be set by passing an array *(WebDriver & Puppeteer only)*:
 
 ```js
 within({frame: [".content", "#editor"]}, () => {

docs/custom-helpers.md

@@ -154,7 +154,7 @@ You can also pass additional config options to your helper from a config - **(pl
 ```js
 helpers: {
   // here goes standard helpers:
-  // WebDriver, Nightmare, etc...
+  // WebDriver, Playwright, etc...
   // and their configuration
   MyHelper: {
     require: "./my_helper.js", // path to module

docs/data.md

@@ -23,7 +23,7 @@ API is supposed to be a stable interface and it can be used by acceptance tests.
 ## REST
 
 [REST helper](https://codecept.io/helpers/REST/) allows sending raw HTTP requests to application.
-This is a tool to make shortcuts and create your data pragmatically via API. However, it doesn't provide tools for testing APIs, so it should be paired with WebDriver helper for browser testing.
+This is a tool to make shortcuts and create your data pragmatically via API. However, it doesn't provide tools for testing APIs, so it should be paired with Playwright or WebDriver helper for browser testing.
 
 Enable REST helper in the config. It is recommended to set `endpoint`, a base URL for all API requests. If you need some authorization you can optionally set default headers too.
 
@@ -92,7 +92,11 @@ I.sendPostRequest('/update-status', {}, { http_x_requested_with: 'xmlhttprequest
 ## GraphQL
 
 [GraphQL helper](https://codecept.io/helpers/GraphQL/) allows sending GraphQL queries and mutations to application, over Http.
+<<<<<<< HEAD
+This is a tool to make shortcuts and create your data pragmatically via GraphQL endpoint. However, it doesn't provide tools for testing the endpoint, so it should be paired with WebDriver helper for browser testing.
+=======
 This is a tool to make shortcuts and create your data pragmatically via GraphQL endpoint. However, it doesn't provide tools for testing the endpoint, so it should be paired with WebDriver helpers for browser testing.
+>>>>>>> 3.x
 
 Enable GraphQL helper in the config. It is recommended to set `endpoint`, the URL to which the requests go to. If you need some authorization you can optionally set default headers too.
 

docs/docker.md

@@ -13,7 +13,7 @@ CodeceptJS runner is available inside container as `codeceptjs`.
 
 ### Locally
 
-You can execute CodeceptJS with Puppeteer or Nightmare locally with no extra configuration.
+You can execute CodeceptJS with Puppeteer locally with no extra configuration.
 
 ```sh
 docker run --net=host -v $PWD:/tests codeceptjs/codeceptjs
@@ -80,7 +80,6 @@ $ docker run -it --rm -v /<path_to_codeceptjs_test_dir>/:/tests/ --link selenium
 
 You may run use `-v $(pwd)/:tests/` if running this from the root of your CodeceptJS tests directory.
 _Note: The output of your test run will appear in your local directory if your output path is `./output` in the CodeceptJS config_
-_Note: If running with the Nightmare driver, it is not necessary to run a selenium docker container and link it. So `--link selenium-chrome:selenium` may be omitted_
 
 ### Build