diff --git a/.circleci/build.sh b/.circleci/build.sh deleted file mode 100755 index b0cfa6ac7..000000000 --- a/.circleci/build.sh +++ /dev/null @@ -1,4 +0,0 @@ -cd test - -docker-compose build -docker-compose pull php selenium.chrome diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index 43923136d..000000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,40 +0,0 @@ -version: 2.1 - -orbs: - browser-tools: circleci/browser-tools@1.4.8 - -defaults: &defaults - machine: - image: default - docker_layer_caching: false - steps: - - checkout - - run: .circleci/build.sh - - browser-tools/install-chrome: - chrome-version: latest # TODO: remove until: https://github.com/CircleCI-Public/browser-tools-orb/issues/75 - replace-existing: true # TODO: remove until: https://github.com/CircleCI-Public/browser-tools-orb/issues/75 - - run: - command: docker-compose run --rm test-rest - working_directory: test - when: always - - run: - command: docker-compose run --rm test-acceptance.webdriverio - working_directory: test - when: always - - run: - command: docker-compose run --rm test-bdd.faker - working_directory: test - when: always - -jobs: - docker: - <<: *defaults - environment: - - NODE_VERSION: 18.16.0 - -workflows: - version: 2 - - test_all: - jobs: - - docker diff --git a/.circleci/test.sh b/.circleci/test.sh deleted file mode 100755 index 711aa14ca..000000000 --- a/.circleci/test.sh +++ /dev/null @@ -1,9 +0,0 @@ -#!/usr/bin/env bash - -set -e - -cd test - -docker-compose run --rm test-unit && -docker-compose run --rm test-rest && -docker-compose run --rm test-acceptance.webdriverio diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ac35a3875..af0a7a38c 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -7,13 +7,14 @@ Go over the steps in [this](https://github.com/firstcontributions/first-contribu To start you need: 1. Fork and clone the repo. -2. Run `npm i --force --omit=optional` to install all required libraries +2. Run `npm i --force` to install all required libraries 3. Do the changes. 4. Add/Update Test (if possible) 5. Update documentation -6. Run `npm run docs` if you change the documentation -7. Commit and Push to your fork -8. Make Pull Request +6. Run `npm run def` to generate types +7. Run `npm run docs` if you change the documentation +8. Commit and Push to your fork +9. Make Pull Request To run codeceptjs from this repo use: @@ -27,7 +28,6 @@ To run examples: node bin/codecept.js run -c examples ``` - Depending on a type of change you should do the following. ## Debugging @@ -44,12 +44,12 @@ Please keep in mind that CodeceptJS have **unified API** for Playwright, WebDriv ### 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! * +_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! _ Working test is highly appreciated. To run the test suite you need: -* selenium server + chromedriver -* PHP installed +- selenium server + chromedriver +- PHP installed To launch PHP demo application run: @@ -82,7 +82,7 @@ http://localhost:8000/form/myexample ### Updating REST | ApiDataFactory -*Whenever a new method or new behavior is added it should be documented in a docblock. Valid JS-example is required!* +_Whenever a new method or new behavior is added it should be documented in a docblock. Valid JS-example is required!_ Adding a test is highly appreciated. @@ -96,7 +96,7 @@ Edit a test at `test/rest/REST_test.js` or `test/rest/ApiDataFactory_test.js` ## Appium -*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! * +_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! _ It is recommended to run mobile tests on CI. So do the changes, make pull request, see the CI status. @@ -211,6 +211,7 @@ docker-compose run --rm test-helpers test/rest ``` #### Run acceptance tests + To that we provide three separate services respectively for WebDriver, Nightmare and Puppeteer tests: ```sh @@ -235,11 +236,13 @@ And now every command based on `test-helpers` service will use node 9.4.0. The same argument can be passed when building unit and acceptance tests services. ### CI flow + We're currently using a bunch of CI services to build and test codecept in different environments. Here's short summary of what are differences between separate services #### CircleCI + Here we use CodeceptJS docker image to build and execute tests inside it. We start with building Docker container based on Dockerfile present in main project directory. Then we run (in this order) unit tests, all helpers present in diff --git a/.github/dependabot.yml b/.github/dependabot.yml index bbbcf4c35..0c6b96faf 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,17 +1,17 @@ version: 2 updates: # github-actions - - package-ecosystem: "github-actions" - directory: "/" + - package-ecosystem: 'github-actions' + directory: '/' schedule: - interval: "weekly" - target-branch: "3.x" + interval: 'weekly' + target-branch: '3.x' # npm - - package-ecosystem: "npm" - directory: "/" + - package-ecosystem: 'npm' + directory: '/' schedule: - interval: "weekly" - target-branch: "3.x" + interval: 'weekly' + target-branch: '3.x' ignore: - - dependency-name: "escape-string-regexp" - versions: [">=5.0"] + - dependency-name: 'escape-string-regexp' + versions: ['>=5.0'] diff --git a/.github/workflows/acceptance-tests.yml b/.github/workflows/acceptance-tests.yml index ed1cc7135..92315d047 100644 --- a/.github/workflows/acceptance-tests.yml +++ b/.github/workflows/acceptance-tests.yml @@ -15,7 +15,6 @@ env: jobs: build: - runs-on: ubuntu-latest strategy: @@ -30,7 +29,7 @@ jobs: # Install Docker Compose - name: Install Docker Compose run: | - sudo apt-get update + sudo apt-get update --allow-releaseinfo-change sudo apt-get install -y docker-compose # Run rest tests using docker-compose diff --git a/.github/workflows/appiumV2_Android.yml b/.github/workflows/appiumV2_Android.yml deleted file mode 100644 index 2b4a0f3eb..000000000 --- a/.github/workflows/appiumV2_Android.yml +++ /dev/null @@ -1,36 +0,0 @@ -name: Appium V2 Tests - Android - -on: - push: - branches: - - 3.x - -env: - CI: true - # Force terminal colors. @see https://www.npmjs.com/package/colors - FORCE_COLOR: 1 - -jobs: - appium: - runs-on: ubuntu-22.04 - - strategy: - matrix: - node-version: [20.x] - test-suite: ['other', 'quick'] - - steps: - - uses: actions/checkout@v4 - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v4 - with: - node-version: ${{ matrix.node-version }} - - run: npm i --force - env: - PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: true - PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true - - run: "npm run test:appium-${{ matrix.test-suite }}" - env: # Or as an environment variable - SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} - SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} - diff --git a/.github/workflows/appium_Android.yml b/.github/workflows/appium_Android.yml new file mode 100644 index 000000000..c5e884b81 --- /dev/null +++ b/.github/workflows/appium_Android.yml @@ -0,0 +1,44 @@ +name: Appium Tests - Android + +on: + push: + branches: + - 3.x + +env: + CI: true + # Force terminal colors. @see https://www.npmjs.com/package/colors + FORCE_COLOR: 1 + SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} + SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} + +jobs: + appium: + runs-on: ubuntu-22.04 + + strategy: + matrix: + node-version: [20.x] + test-suite: ['other', 'quick'] + + steps: + - uses: actions/checkout@v4 + + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v4 + with: + node-version: ${{ matrix.node-version }} + + - run: npm i + env: + PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: true + PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true + + - name: Upload APK to Sauce Labs + run: | + curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" \ + --location --request POST 'https://api.us-west-1.saucelabs.com/v1/storage/upload' \ + --form 'payload=@test/data/mobile/selendroid-test-app-0.17.0.apk' \ + --form 'name="selendroid-test-app-0.17.0.apk"' + + - run: 'npm run test:appium-${{ matrix.test-suite }}' diff --git a/.github/workflows/appiumV2_iOS.yml b/.github/workflows/appium_iOS.yml similarity index 53% rename from .github/workflows/appiumV2_iOS.yml rename to .github/workflows/appium_iOS.yml index 64ae5e12a..c44a71df7 100644 --- a/.github/workflows/appiumV2_iOS.yml +++ b/.github/workflows/appium_iOS.yml @@ -1,4 +1,4 @@ -name: Appium V2 Tests - iOS +name: Appium Tests - iOS on: push: @@ -9,9 +9,12 @@ env: CI: true # Force terminal colors. @see https://www.npmjs.com/package/colors FORCE_COLOR: 1 + SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} + SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} jobs: appium: + if: false runs-on: ubuntu-22.04 strategy: @@ -29,8 +32,12 @@ jobs: env: PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: true PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true - - run: "npm run test:ios:appium-${{ matrix.test-suite }}" - env: # Or as an environment variable - SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} - SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} + - name: Upload APK to Sauce Labs + run: | + curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" \ + --location --request POST 'https://api.us-west-1.saucelabs.com/v1/storage/upload' \ + --form 'payload=@test/data/mobile/TestApp-iphonesimulator.zip' \ + --form 'name="TestApp-iphonesimulator.zip"' + + - run: 'npm run test:ios:appium-${{ matrix.test-suite }}' diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index 237f17b0c..bd6a2427d 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -4,17 +4,29 @@ on: push: branches: - 3.x - release: - types: [published] jobs: push_to_registry: name: Build and push Docker image to Docker Hub runs-on: ubuntu-22.04 + env: + DOCKER_REPO: ${{ secrets.DOCKERHUB_USERNAME }}/${{ secrets.DOCKERHUB_REPOSITORY }} steps: - - name: Check out the repo with the latest code + - name: Fetch full Git history and tags uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Get the latest tag + id: get_tag + run: | + TAG=$(git describe --tags `git rev-list --tags --max-count=1`) + echo "TAG=$TAG" >> $GITHUB_ENV + echo "::set-output name=tag::$TAG" + + - name: Checkout latest tag + run: git checkout tags/${{ env.TAG }} - name: Set up Docker Buildx uses: docker/setup-buildx-action@v3 @@ -25,15 +37,19 @@ jobs: username: ${{ secrets.DOCKERHUB_USERNAME }} password: ${{ secrets.DOCKERHUB_PASSWORD }} - - name: Get the current tag - id: currentTag - run: git fetch --prune --unshallow && TAG=$(git describe --tags --abbrev=0) && echo $TAG && echo "TAG="$TAG >> "$GITHUB_ENV" + - name: Check if Docker tag exists + id: tag_check + run: | + TAG_EXISTS=$(curl -s -o /dev/null -w "%{http_code}" \ + https://hub.docker.com/v2/repositories/${DOCKER_REPO}/tags/${TAG}/) + echo "exists=$TAG_EXISTS" >> $GITHUB_OUTPUT - name: Build and push Docker image + if: steps.tag_check.outputs.exists != '200' uses: docker/build-push-action@v6 with: context: . push: true tags: | - ${{ secrets.DOCKERHUB_REPOSITORY }}:latest - ${{ secrets.DOCKERHUB_REPOSITORY }}:${{ env.TAG }} \ No newline at end of file + ${{ env.DOCKER_REPO }}:latest + ${{ env.DOCKER_REPO }}:${{ env.TAG }} diff --git a/.github/workflows/expectHelper.yml b/.github/workflows/expectHelper.yml deleted file mode 100644 index 8f9a6ee11..000000000 --- a/.github/workflows/expectHelper.yml +++ /dev/null @@ -1,34 +0,0 @@ -name: Expect Helper Tests - -on: - push: - branches: - - 3.x - pull_request: - branches: - - '**' - -env: - CI: true - # Force terminal colors. @see https://www.npmjs.com/package/colors - FORCE_COLOR: 1 - -jobs: - build: - - runs-on: ubuntu-22.04 - - strategy: - matrix: - node-version: [20.x] - - steps: - - uses: actions/checkout@v4 - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v4 - with: - node-version: ${{ matrix.node-version }} - - name: npm install - run: npm i --force - - name: run unit tests - run: ./node_modules/.bin/mocha test/helper/Expect_test.js --timeout 5000 diff --git a/.github/workflows/playwright.yml b/.github/workflows/playwright.yml index 1f8dc9769..d00fe7196 100644 --- a/.github/workflows/playwright.yml +++ b/.github/workflows/playwright.yml @@ -15,7 +15,6 @@ env: jobs: build: - runs-on: ubuntu-latest strategy: @@ -23,32 +22,37 @@ jobs: node-version: [20.x] steps: - - uses: actions/checkout@v4 - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v4 - with: - node-version: ${{ matrix.node-version }} - - uses: shivammathur/setup-php@v2 - with: - php-version: 7.4 - - name: npm install - run: | - npm i --force - env: - PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true - - name: Install browsers and deps - run: npx playwright install && npx playwright install-deps - - name: start a server - run: "php -S 127.0.0.1:8000 -t test/data/app &" - - name: run chromium tests - run: "./bin/codecept.js run -c test/acceptance/codecept.Playwright.js --grep @Playwright --debug" - - name: run chromium with restart==browser tests - run: "BROWSER_RESTART=browser ./bin/codecept.js run -c test/acceptance/codecept.Playwright.js --grep @Playwright --debug" - - name: run chromium with restart==session tests - run: "BROWSER_RESTART=session ./bin/codecept.js run -c test/acceptance/codecept.Playwright.js --grep @Playwright --debug" - - name: run firefox tests - run: "BROWSER=firefox node ./bin/codecept.js run -c test/acceptance/codecept.Playwright.js --grep @Playwright --debug" - - name: run webkit tests - run: "BROWSER=webkit node ./bin/codecept.js run -c test/acceptance/codecept.Playwright.js --grep @Playwright --debug" - - name: run chromium unit tests - run: ./node_modules/.bin/mocha test/helper/Playwright_test.js --timeout 5000 + - uses: actions/checkout@v4 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v4 + with: + node-version: ${{ matrix.node-version }} + - uses: shivammathur/setup-php@v2 + with: + php-version: 7.4 + - name: npm install + run: | + npm i --force + env: + PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true + - name: Allow Release info Change + run: | + sudo apt-get update --allow-releaseinfo-change + - name: Install browsers and deps + run: npx playwright install && npx playwright install-deps + - name: check + run: './bin/codecept.js check -c test/acceptance/codecept.Playwright.js' + - name: start a server + run: 'php -S 127.0.0.1:8000 -t test/data/app &' + - name: run chromium tests + run: './bin/codecept.js run -c test/acceptance/codecept.Playwright.js --grep @Playwright --debug' + - name: run chromium with restart==browser tests + run: 'BROWSER_RESTART=browser ./bin/codecept.js run -c test/acceptance/codecept.Playwright.js --grep @Playwright --debug' + - name: run chromium with restart==session tests + run: 'BROWSER_RESTART=session ./bin/codecept.js run -c test/acceptance/codecept.Playwright.js --grep @Playwright --debug' + - name: run firefox tests + run: 'BROWSER=firefox node ./bin/codecept.js run -c test/acceptance/codecept.Playwright.js --grep @Playwright --debug' + - name: run webkit tests + run: 'BROWSER=webkit node ./bin/codecept.js run -c test/acceptance/codecept.Playwright.js --grep @Playwright --debug' + - name: run chromium unit tests + run: ./node_modules/.bin/mocha test/helper/Playwright_test.js --timeout 5000 diff --git a/.github/workflows/plugin.yml b/.github/workflows/plugin.yml index ec456fa7f..6795da6bf 100644 --- a/.github/workflows/plugin.yml +++ b/.github/workflows/plugin.yml @@ -15,7 +15,6 @@ env: jobs: build: - runs-on: ubuntu-22.04 strategy: @@ -23,22 +22,25 @@ jobs: node-version: [20.x] steps: - - uses: actions/checkout@v4 - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v4 - with: - node-version: ${{ matrix.node-version }} - - uses: shivammathur/setup-php@v2 - with: - php-version: 7.4 - - name: npm install - run: | - npm i --force - env: - PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true - - name: Install browsers and deps - run: npx playwright install chromium && npx playwright install-deps - - name: start a server - run: "php -S 127.0.0.1:8000 -t test/data/app &" - - name: run plugin tests - run: npm run test:plugin + - uses: actions/checkout@v4 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v4 + with: + node-version: ${{ matrix.node-version }} + - uses: shivammathur/setup-php@v2 + with: + php-version: 7.4 + - name: npm install + run: | + npm i --force + env: + PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true + - name: Allow Release info Change + run: | + sudo apt-get update --allow-releaseinfo-change + - name: Install browsers and deps + run: npx playwright install chromium && npx playwright install-deps + - name: start a server + run: 'php -S 127.0.0.1:8000 -t test/data/app &' + - name: run plugin tests + run: npm run test:plugin diff --git a/.github/workflows/softExpectHelper.yml b/.github/workflows/softExpectHelper.yml deleted file mode 100644 index 141c056b8..000000000 --- a/.github/workflows/softExpectHelper.yml +++ /dev/null @@ -1,34 +0,0 @@ -name: Soft Expect Helper Tests - -on: - push: - branches: - - 3.x - pull_request: - branches: - - '**' - -env: - CI: true - # Force terminal colors. @see https://www.npmjs.com/package/colors - FORCE_COLOR: 1 - -jobs: - build: - - runs-on: ubuntu-22.04 - - strategy: - matrix: - node-version: [20.x] - - steps: - - uses: actions/checkout@v4 - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v4 - with: - node-version: ${{ matrix.node-version }} - - name: npm install - run: npm i --force - - name: run unit tests - run: ./node_modules/.bin/mocha test/helper/SoftExpect_test.js --timeout 5000 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index ae84f5304..6ac6e3d7e 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -9,27 +9,42 @@ on: - '**' jobs: - build: + unit-tests: + name: Unit tests + runs-on: ubuntu-22.04 + + strategy: + matrix: + node-version: [20.x, 22.x] + + steps: + - uses: actions/checkout@v4 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v4 + with: + node-version: ${{ matrix.node-version }} + - run: npm i + env: + PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: true + PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true + - run: npm run test:unit + runner-tests: + name: Runner tests runs-on: ubuntu-22.04 strategy: matrix: - node-version: [20.x] + node-version: [20.x, 22.x] steps: - - uses: actions/checkout@v4 - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v4 - with: - node-version: ${{ matrix.node-version }} - - run: npm i --force - env: - PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: true - PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true - - uses: nick-fields/retry@v3 - with: - timeout_minutes: 6 - max_attempts: 3 - retry_on: error - command: npm test + - uses: actions/checkout@v4 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v4 + with: + node-version: ${{ matrix.node-version }} + - run: npm i + env: + PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: true + PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true + - run: npm run test:runner diff --git a/.github/workflows/webdriver.yml b/.github/workflows/webdriver.yml index 603dba1ab..74e1a9882 100644 --- a/.github/workflows/webdriver.yml +++ b/.github/workflows/webdriver.yml @@ -15,34 +15,32 @@ env: jobs: build: - runs-on: ubuntu-latest strategy: matrix: node-version: [20.x] steps: - - run: docker run -d --net=host --shm-size=2g selenium/standalone-chrome:3.141.0 - - uses: actions/checkout@v4 - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v4 - with: - node-version: ${{ matrix.node-version }} - - uses: shivammathur/setup-php@v2 - with: - php-version: 8.0 - - name: npm install - run: | - npm i --force - env: - PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: true - PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true - - name: start a server - run: "php -S 127.0.0.1:8000 -t test/data/app &" - - name: run unit tests - run: ./node_modules/.bin/mocha test/helper/WebDriver_test.js --exit - - name: run unit tests - no selenium server - run: ./node_modules/.bin/mocha test/helper/WebDriver.noSeleniumServer_test.js --exit - - name: run tests - run: "./bin/codecept.js run -c test/acceptance/codecept.WebDriver.js --grep @WebDriver --debug" - + - run: docker run -d --net=host --shm-size=2g selenium/standalone-chrome:4.27 + - uses: actions/checkout@v4 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v4 + with: + node-version: ${{ matrix.node-version }} + - uses: shivammathur/setup-php@v2 + with: + php-version: 8.0 + - name: npm install + run: | + npm i + env: + PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: true + PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true + - name: start a server + run: 'php -S 127.0.0.1:8000 -t test/data/app &' + - name: check + run: './bin/codecept.js check -c test/acceptance/codecept.WebDriver.js' + - name: run unit tests + run: ./node_modules/.bin/mocha test/helper/WebDriver_test.js --exit + - name: run tests + run: './bin/codecept.js run -c test/acceptance/codecept.WebDriver.js --grep @WebDriver --debug' diff --git a/.gitignore b/.gitignore index 899a0b988..fc1f70320 100644 --- a/.gitignore +++ b/.gitignore @@ -16,6 +16,7 @@ examples/output examples/selenoid-example/output test/data/app/db test/data/sandbox/steps.d.ts +test/data/sandbox/configs/custom-reporter-plugin/output/result.json testpullfilecache* .DS_Store package-lock.json diff --git a/.husky/pre-commit b/.husky/pre-commit index 635d81b70..3f4f6f4eb 100755 --- a/.husky/pre-commit +++ b/.husky/pre-commit @@ -1,4 +1,4 @@ -#!/usr/bin/env sh -. "$(dirname -- "$0")/_/husky.sh" - -npm run prettier && npm run lint && npm run dtslint +prettier $(git diff --cached --name-only --diff-filter=ACMR | sed 's| |\\ |g') --write --ignore-unknown +git update-index --again +npx eslint $(git diff --cached --name-only --diff-filter=ACMR | sed 's| |\\ |g') +npm run dtslint diff --git a/CHANGELOG.md b/CHANGELOG.md index 7c769257c..9ce6dd1b6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,407 @@ +## 3.7.3 + +❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ + +🛩ī¸ _Features_ + +- feat(cli): improve info command to return installed browsers (#4890) - by @kobenguyent + +``` +➜ helloworld npx codeceptjs info +Environment information: + +codeceptVersion: "3.7.2" +nodeInfo: 18.19.0 +osInfo: macOS 14.4 +cpuInfo: (8) x64 Apple M1 Pro +osBrowsers: "chrome: 133.0.6943.143, edge: 133.0.3065.92, firefox: not installed, safari: 17.4" +playwrightBrowsers: "chromium: 133.0.6943.16, firefox: 134.0, webkit: 18.2" +helpers: { +"Playwright": { +"url": "http://localhost", +... +``` + +🐛 _Bug Fixes_ + +- fix: resolving path inconsistency in container.js and appium.js (#4866) - by @mjalav +- fix: broken screenshot links in mochawesome reports (#4889) - by @kobenguyent +- some internal fixes to make UTs more stable by @thomashohn +- dependencies upgrades by @thomashohn + +## 3.7.2 + +❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ + +🛩ī¸ _Features_ + +- feat(playwright): Clear cookie by name (#4693) - by @ngraf + +🐛 _Bug Fixes_ + +- fix(stepByStepReport): no records html is generated when running with run-workers (#4638) +- fix(webdriver): bidi error in log with webdriver (#4850) +- fix(types): TS types of methods (Feature|Scenario)Config.config (#4851) +- fix: redundant popup log (#4830) +- fix(webdriver): grab browser logs using bidi protocol (#4754) +- fix(webdriver): screenshots for sessions (#4748) + +📖 _Documentation_ + +- fix(docs): mask sensitive data (#4636) - by @gkushang + +## 3.7.1 + +- Fixed `reading charAt` error in `asyncWrapper.js` + +## 3.7.0 + +This release introduces major new features and internal refactoring. It is an important step toward the 4.0 release planned soon, which will remove all deprecations introduced in 3.7. + +🛩ī¸ _Features_ + +### đŸ”Ĩ **Native Element Functions** + +A new [Els API](/els) for direct element interactions has been introduced. This API provides low-level element manipulation functions for more granular control over element interactions and assertions: + +- `element()` - perform custom operations on first matching element +- `eachElement()` - iterate and perform operations on each matching element +- `expectElement()` - assert condition on first matching element +- `expectAnyElement()` - assert condition matches at least one element +- `expectAllElements()` - assert condition matches all elements + +Example using all element functions: + +```js +const { element, eachElement, expectElement, expectAnyElement, expectAllElements } = require('codeceptjs/els') + +// ... + +Scenario('element functions demo', async ({ I }) => { + // Get attribute of first button + const attr = await element('.button', async el => await el.getAttribute('data-test')) + + // Log text of each list item + await eachElement('.list-item', async (el, idx) => { + console.log(`Item ${idx}: ${await el.getText()}`) + }) + + // Assert first submit button is enabled + await expectElement('.submit', async el => await el.isEnabled()) + + // Assert at least one product is in stock + await expectAnyElement('.product', async el => { + return (await el.getAttribute('data-status')) === 'in-stock' + }) + + // Assert all required fields have required attribute + await expectAllElements('.required', async el => { + return (await el.getAttribute('required')) !== null + }) +}) +``` + +[Els](/els) functions expose the native API of Playwright, WebDriver, and Puppeteer helpers. The actual `el` API will differ depending on which helper is used, which affects test code interoperability. + +### 🔮 **Effects introduced** + +[Effects](/effects) is a new concept that encompasses all functions that can modify scenario flow. These functions are now part of a single module. Previously, they were used via plugins like `tryTo` and `retryTo`. Now, it is recommended to import them directly: + +```js +const { tryTo, retryTo } = require('codeceptjs/effects') + +Scenario(..., ({ I }) => { + I.amOnPage('/') + // tryTo returns boolean if code in function fails + // use it to execute actions that may fail but not affect the test flow + // for instance, for accepting cookie banners + const isItWorking = tryTo(() => I.see('It works')) + + // run multiple steps and retry on failure + retryTo(() => { + I.click('Start Working!'); + I.see('It works') + }, 5); +}) +``` + +Previously `tryTo` and `retryTo` were available globally via plugins. This behavior is deprecated as of 3.7 and will be removed in 4.0. Import these functions via effects instead. Similarly, `within` will be moved to `effects` in 4.0. + +### ✅ `check` command added + +``` +npx codeceptjs check +``` + +This command can be executed locally or in CI environments to verify that tests can be executed correctly. + +It checks: + +- configuration +- tests +- helpers + +And will attempt to open and close a browser if a corresponding helper is enabled. If something goes wrong, the command will fail with a message. Run `npx codeceptjs check` on CI before actual tests to ensure everything is set up correctly and all services and browsers are accessible. + +For GitHub Actions, add this command: + +```yaml +steps: + # ... + - name: check configuration and browser + run: npx codeceptjs check + + - name: run codeceptjs tests + run: npx codeceptjs run-workers 4 +``` + +### 👨‍đŸ”Ŧ **analyze plugin introduced** + +This [AI plugin](./plugins#analyze) analyzes failures in test runs and provides brief summaries. For more than 5 failures, it performs cluster analysis and aggregates failures into groups, attempting to find common causes. It is recommended to use Deepseek R1 model or OpenAI o3 for better reasoning on clustering: + +```js +â€ĸ SUMMARY The test failed because the expected text "Sign in" was not found on the page, indicating a possible issue with HTML elements or their visibility. +â€ĸ ERROR expected web application to include "Sign in" +â€ĸ CATEGORY HTML / page elements (not found, not visible, etc) +â€ĸ URL http://127.0.0.1:3000/users/sign_in +``` + +For fewer than 5 failures, they are analyzed individually. If a visual recognition model is connected, AI will also scan screenshots to suggest potential failure causes (missing button, missing text, etc). + +This plugin should be paired with the newly added [`pageInfo` plugin](./plugins/#pageInfo) which stores important information like URL, console logs, and error classes for further analysis. + +### 👨‍đŸ’ŧ **autoLogin plugin** renamed to **auth plugin** + +[`auth`](/plugins#auth) is the new name for the autoLogin plugin and aims to solve common authorization issues. In 3.7 it can use Playwright's storage state to load authorization cookies in a browser on start. So if a user is already authorized, a browser session starts with cookies already loaded for this user. If you use Playwright, you can enable this behavior using the `loginAs` method inside a `BeforeSuite` hook: + +```js +BeforeSuite(({ loginAs }) => loginAs('user')) +``` + +The previous behavior where `loginAs` was called from a `Before` hook also works. However, cookie loading and authorization checking is performed after the browser starts. + +#### Metadata introduced + +Meta information in key-value format can be attached to Scenarios to provide more context when reporting tests: + +```js +// add Jira issue to scenario +Scenario('...', () => { + // ... +}).meta('JIRA', 'TST-123') + +// or pass meta info in the beginning of scenario: +Scenario('my test linked to Jira', meta: { issue: 'TST-123' }, () => { + // ... +}) +``` + +By default, Playwright helpers add browser and window size as meta information to tests. + +### đŸ‘ĸ Custom Steps API + +Custom Steps or Sections API introduced to group steps into sections: + +```js +const { Section } = require('codeceptjs/steps'); + +Scenario({ I } => { + I.amOnPage('/projects'); + + // start section "Create project" + Section('Create a project'); + I.click('Create'); + I.fillField('title', 'Project 123') + I.click('Save') + I.see('Project created') + // calling Section with empty param closes previous section + Section() + + // previous section automatically closes + // when new section starts + Section('open project') + // ... +}); +``` + +To hide steps inside a section from output use `Section().hidden()` call: + +```js +Section('Create a project').hidden() +// next steps are not printed: +I.click('Create') +I.fillField('title', 'Project 123') +Section() +``` + +Alternative syntax for closing section: `EndSection`: + +```js +const { Section, EndSection } = require('codeceptjs/steps'); + +// ... +Scenario(..., ({ I }) => // ... + + Section('Create a project').hidden() + // next steps are not printed: + I.click('Create'); + I.fillField('title', 'Project 123') + EndSection() +``` + +Also available BDD-style pre-defined sections: + +```js +const { Given, When, Then } = require('codeceptjs/steps'); + +// ... +Scenario(..., ({ I }) => // ... + + Given('I have a project') + // next steps are not printed: + I.click('Create'); + I.fillField('title', 'Project 123') + + When('I open project'); + // ... + + Then('I should see analytics in a project') + //.... +``` + +### đŸĨž Step Options + +Better syntax to set general step options for specific tests. + +Use it to set timeout or retries for specific steps: + +```js +const step = require('codeceptjs/steps'); + +Scenario(..., ({ I }) => // ... + I.click('Create', step.timeout(10).retry(2)); + //.... +``` + +Alternative syntax: + +```js +const { stepTimeout, stepRetry } = require('codeceptjs/steps'); + +Scenario(..., ({ I }) => // ... + I.click('Create', stepTimeout(10)); + I.see('Created', stepRetry(2)); + //.... +``` + +This change deprecates previous syntax: + +- `I.limitTime().act(...)` => replaced with `I.act(..., stepTimeout())` +- `I.retry().act(...)` => replaced with `I.act(..., stepRetry())` + +Step options should be passed as the very last argument to `I.action()` call. + +Step options can be used to pass additional options to currently existing methods: + +```js +const { stepOpts } = require('codeceptjs/steps') + +I.see('SIGN IN', stepOpts({ ignoreCase: true })) +``` + +Currently this works only on `see` and only with `ignoreCase` param. +However, this syntax will be extended in next versions. + +### Test object can be injected into Scenario + +API for direct access to test object inside Scenario or hooks to add metadata or artifacts: + +```js +BeforeSuite(({ suite }) => { + // no test object here, test is not created yet +}) + +Before(({ test }) => { + // add artifact to test + test.artifacts.myScreenshot = 'screenshot' +}) + +Scenario('test store-test-and-suite test', ({ test }) => { + // add custom meta data + test.meta.browser = 'chrome' +}) + +After(({ test }) => {}) +``` + +Object for `suite` is also injected for all Scenario and hooks. + +### Notable changes + +- Load official Gherkin translations into CodeceptJS. See #4784 by @ebo-zig +- đŸ‡ŗ🇱 `NL` translation introduced by @ebo-zig in #4784: +- [Playwright] Improved experience to highlight and print elements in debug mode +- `codeceptjs run` fails on CI if no tests were executed. This helps to avoid false positive checks. Use `DONT_FAIL_ON_EMPTY_RUN` env variable to disable this behavior +- Various console output improvements +- AI suggested fixes from `heal` plugin (which heals failing tests on the fly) shown in `run-workers` command +- `plugin/standatdActingHelpers` replaced with `Container.STANDARD_ACTING_HELPERS` + +### 🐛 _Bug Fixes_ + +- Fixed timeouts for `BeforeSuite` and `AfterSuite` +- Fixed stucking process on session switch + +### 🎇 Internal Refactoring + +This section is listed briefly. A new dedicated page for internal API concepts will be added to documentation + +- File structure changed: + - mocha classes moved to `lib/mocha` + - step is split to multiple classes and moved to `lib/step` +- Extended and exposed to public API classes for Test, Suite, Hook + - [Test](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/mocha/test.js) + - [Suite](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/mocha/suite.js) + - [Hook](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/mocha/hooks.js) (Before, After, BeforeSuite, AfterSuite) +- Container: + - refactored to be prepared for async imports in ESM. + - added proxy classes to resolve circular dependencies +- Step + - added different step types [`HelperStep`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/step/helper.js), [`MetaStep`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/step/meta.js), [`FuncStep`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/step/func.js), [`CommentStep`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/step/comment.js) + - added `step.addToRecorder()` to schedule test execution as part of global promise chain +- [Result object](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/result.js) added + - `event.all.result` now sends Result object with all failures and stats included +- `run-workers` refactored to use `Result` to send results from workers to main process +- Timeouts refactored `listener/timeout` => [`globalTimeout`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/listener/globalTimeout.js) +- Reduced usages of global variables, more attributes added to [`store`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/store.js) to share data on current state between different parts of system +- `events` API improved + - Hook class is sent as param for `event.hook.passed`, `event.hook.finished` + - `event.test.failed`, `event.test.finished` always sends Test. If test has failed in `Before` or `BeforeSuite` hook, event for all failed test in this suite will be sent + - if a test has failed in a hook, a hook name is sent as 3rd arg to `event.test.failed` + +--- + +## 3.6.10 + +❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ + +🐛 _Bug Fixes_ +fix(cli): missing failure counts when there is failedHooks (#4633) - by @kobenguyent + +## 3.6.9 + +❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ + +🐛 _Hot Fixes_ +fix: could not run tests due to missing `invisi-data` lib - by @kobenguyent + ## 3.6.8 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat(cli): mask sensitive data in logs (#4630) - by @kobenguyent +🛩ī¸ _Features_ + +- feat(cli): mask sensitive data in logs (#4630) - by @kobenguyent + ``` export const config: CodeceptJS.MainConfig = { tests: '**/*.e2e.test.ts', @@ -19,43 +417,50 @@ export const config: CodeceptJS.MainConfig = { â€ē [Response] {"access-token": "****"} ``` -* feat(REST): DELETE request supports payload (#4493) - by @schaudhary111 +- feat(REST): DELETE request supports payload (#4493) - by @schaudhary111 ```js -I.sendDeleteRequestWithPayload('/api/users/1', { author: 'john' }); +I.sendDeleteRequestWithPayload('/api/users/1', { author: 'john' }) ``` -🐛 *Bug Fixes* -* fix(playwright): Different behavior of see* and waitFor* when used in within (#4557) - by @kobenguyent -* fix(cli): dry run returns no tests when using a regex grep (#4608) - by @kobenguyent +🐛 _Bug Fixes_ + +- fix(playwright): Different behavior of see* and waitFor* when used in within (#4557) - by @kobenguyent +- fix(cli): dry run returns no tests when using a regex grep (#4608) - by @kobenguyent + ```bash > codeceptjs dry-run --steps --grep "(?=.*Checkout process)" ``` -* fix: Replace deprecated faker.name with faker.person (#4581) - by @thomashohn -* fix(wdio): Remove dependency to devtools (#4563) - by @thomashohn -* fix(typings): wrong defineParameterType (#4548) - by @kobenguyent -* fix(typing): `Locator.build` complains the empty locator (#4543) - by @kobenguyent -* fix: add hint to `I.seeEmailAttachment` treats parameter as regular expression (#4629) - by @ngraf + +- fix: Replace deprecated faker.name with faker.person (#4581) - by @thomashohn +- fix(wdio): Remove dependency to devtools (#4563) - by @thomashohn +- fix(typings): wrong defineParameterType (#4548) - by @kobenguyent +- fix(typing): `Locator.build` complains the empty locator (#4543) - by @kobenguyent +- fix: add hint to `I.seeEmailAttachment` treats parameter as regular expression (#4629) - by @ngraf + ``` -Add hint to "I.seeEmailAttachment" that under the hood parameter is treated as RegExp. +Add hint to "I.seeEmailAttachment" that under the hood parameter is treated as RegExp. When you don't know it, it can cause a lot of pain, wondering why your test fails with I.seeEmailAttachment('Attachment(1).pdf') although it looks just fine, but actually I.seeEmailAttachment('Attachment\\(1\\).pdf is required to make the test green, in case the attachment is called "Attachment(1).pdf" with special character in it. ``` -* fix(playwright): waitForText fails when text contains double quotes (#4528) - by @DavertMik -* fix(mock-server-helper): move to stand-alone package: https://www.npmjs.com/package/@codeceptjs/mock-server-helper (#4536) - by @kobenguyent -* fix(appium): issue with async on runOnIos and runOnAndroid (#4525) - by @kobenguyent -* fix: push ws messages to array (#4513) - by @kobenguyent -📖 *Documentation* -* fix(docs): typo in ai.md (#4501) - by @tomaculum +- fix(playwright): waitForText fails when text contains double quotes (#4528) - by @DavertMik +- fix(mock-server-helper): move to stand-alone package: https://www.npmjs.com/package/@codeceptjs/mock-server-helper (#4536) - by @kobenguyent +- fix(appium): issue with async on runOnIos and runOnAndroid (#4525) - by @kobenguyent +- fix: push ws messages to array (#4513) - by @kobenguyent + +📖 _Documentation_ + +- fix(docs): typo in ai.md (#4501) - by @tomaculum ## 3.6.6 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat(locator): add withAttrEndsWith, withAttrStartsWith, withAttrContains (#4334) - by @Maksym-Artemenko -* feat: soft assert (#4473) - by @kobenguyent - * Soft assert +🛩ī¸ _Features_ + +- feat(locator): add withAttrEndsWith, withAttrStartsWith, withAttrContains (#4334) - by @Maksym-Artemenko +- feat: soft assert (#4473) - by @kobenguyent + - Soft assert Zero-configuration when paired with other helpers like REST, Playwright: @@ -74,21 +479,23 @@ Zero-configuration when paired with other helpers like REST, Playwright: I.softExpectEqual('a', 'b') I.flushSoftAssertions() // Throws an error if any soft assertions have failed. The error message contains all the accumulated failures. ``` -* feat(cli): print failed hooks (#4476) - by @kobenguyent - * run command - ![Screenshot 2024-09-02 at 15 25 20](https://github.com/user-attachments/assets/625c6b54-03f6-41c6-9d0c-cd699582404a) - * run workers command -![Screenshot 2024-09-02 at 15 24 53](https://github.com/user-attachments/assets/efff0312-1229-44b6-a94f-c9b9370b9a64) +- feat(cli): print failed hooks (#4476) - by @kobenguyent -🐛 *Bug Fixes* -* fix(AI): minor AI improvements - by @DavertMik -* fix(AI): add missing await in AI.js (#4486) - by @tomaculum -* fix(playwright): no async save video page (#4472) - by @kobenguyent -* fix(rest): httpAgent condition (#4484) - by @kobenguyent -* fix: DataCloneError error when `I.executeScript` command is used with `run-workers` (#4483) - by @code4muktesh -* fix: no error thrown from rerun script (#4494) - by @lin-brian-l + - run command + ![Screenshot 2024-09-02 at 15 25 20](https://github.com/user-attachments/assets/625c6b54-03f6-41c6-9d0c-cd699582404a) + - run workers command + ![Screenshot 2024-09-02 at 15 24 53](https://github.com/user-attachments/assets/efff0312-1229-44b6-a94f-c9b9370b9a64) + +🐛 _Bug Fixes_ + +- fix(AI): minor AI improvements - by @DavertMik +- fix(AI): add missing await in AI.js (#4486) - by @tomaculum +- fix(playwright): no async save video page (#4472) - by @kobenguyent +- fix(rest): httpAgent condition (#4484) - by @kobenguyent +- fix: DataCloneError error when `I.executeScript` command is used with `run-workers` (#4483) - by @code4muktesh +- fix: no error thrown from rerun script (#4494) - by @lin-brian-l ```js // fix the validation of httpAgent config. we could now pass ca, instead of key/cert. @@ -107,15 +514,18 @@ I.flushSoftAssertions() // Throws an error if any soft assertions have failed. T } ``` -📖 *Documentation* -* doc(AI): minor AI improvements - by @DavertMik +📖 _Documentation_ + +- doc(AI): minor AI improvements - by @DavertMik ## 3.6.5 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat(helper): playwright > wait for disabled (#4412) - by @kobenguyent +🛩ī¸ _Features_ + +- feat(helper): playwright > wait for disabled (#4412) - by @kobenguyent + ``` it('should wait for input text field to be disabled', () => I.amOnPage('/form/wait_disabled').then(() => I.waitForDisabled('#text', 1))) @@ -134,20 +544,23 @@ Element can be located by CSS or XPath. @returns {void} automatically synchronized promise through #recorder ``` -🐛 *Bug Fixes* -* fix(AI): AI is not triggered (#4422) - by @kobenguyent -* fix(plugin): stepByStep > report doesn't sync properly (#4413) - by @kobenguyent -* fix: Locator > Unsupported pseudo selector 'has' (#4448) - by @anils92 +🐛 _Bug Fixes_ + +- fix(AI): AI is not triggered (#4422) - by @kobenguyent +- fix(plugin): stepByStep > report doesn't sync properly (#4413) - by @kobenguyent +- fix: Locator > Unsupported pseudo selector 'has' (#4448) - by @anils92 + +📖 _Documentation_ -📖 *Documentation* -* docs: setup azure open ai using bearer token (#4434) - by @kobenguyent +- docs: setup azure open ai using bearer token (#4434) - by @kobenguyent ## 3.6.4 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat(rest): print curl (#4396) - by @kobenguyent +🛩ī¸ _Features_ + +- feat(rest): print curl (#4396) - by @kobenguyent ``` Config: @@ -158,49 +571,55 @@ REST: { printCurl: true, ... } -... +... â€ē [CURL Request] curl --location --request POST https://httpbin.org/post -H ... ``` -* feat(AI): Generate PageObject, added types, shell improvement (#4319) - by @DavertMik - * added `askForPageObject` method to generate PageObjects on the fly - * improved AI types - * interactive shell improved to restore history +- feat(AI): Generate PageObject, added types, shell improvement (#4319) - by @DavertMik + - added `askForPageObject` method to generate PageObjects on the fly + - improved AI types + - interactive shell improved to restore history ![Screenshot from 2024-06-17 02-47-37](https://github.com/codeceptjs/CodeceptJS/assets/220264/12acd2c7-18d1-4105-a24b-84070ec4d393) -🐛 *Bug Fixes* -* fix(heal): wrong priority (#4394) - by @kobenguyent +🐛 _Bug Fixes_ + +- fix(heal): wrong priority (#4394) - by @kobenguyent -📖 *Documentation* -* AI docs improvements by @DavertMik +📖 _Documentation_ + +- AI docs improvements by @DavertMik ## 3.6.3 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat(plugin): coverage with WebDriver - devtools (#4349) - by @KobeNguyent +🛩ī¸ _Features_ + +- feat(plugin): coverage with WebDriver - devtools (#4349) - by @KobeNguyent ![Screenshot 2024-05-16 at 16 49 20](https://github.com/codeceptjs/CodeceptJS/assets/7845001/a02f0f99-ac78-4d3f-9774-2cb51c688025) -🐛 *Bug Fixes* -* fix(cli): stale process (#4367) - by @Horsty80 @kobenguyent -* fix(runner): screenshot error in beforeSuite/AfterSuite (#4385) - by @kobenguyent -* fix(cli): gherkin command init with TypeScript (#4366) - by @andonary -* fix(webApi): error message of dontSeeCookie (#4357) - by @a-stankevich +🐛 _Bug Fixes_ + +- fix(cli): stale process (#4367) - by @Horsty80 @kobenguyent +- fix(runner): screenshot error in beforeSuite/AfterSuite (#4385) - by @kobenguyent +- fix(cli): gherkin command init with TypeScript (#4366) - by @andonary +- fix(webApi): error message of dontSeeCookie (#4357) - by @a-stankevich -📖 *Documentation* -* fix(doc): Expect helper is not described correctly (#4370) - by @kobenguyent -* fix(docs): some strange characters (#4387) - by @kobenguyent -* fix: Puppeteer helper doc typo (#4369) - by @yoannfleurydev +📖 _Documentation_ + +- fix(doc): Expect helper is not described correctly (#4370) - by @kobenguyent +- fix(docs): some strange characters (#4387) - by @kobenguyent +- fix: Puppeteer helper doc typo (#4369) - by @yoannfleurydev ## 3.6.2 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat(REST): support httpAgent conf (#4328) - by @KobeNguyent +🛩ī¸ _Features_ + +- feat(REST): support httpAgent conf (#4328) - by @KobeNguyent Support the httpAgent conf to create the TSL connection via REST helper @@ -221,7 +640,7 @@ Support the httpAgent conf to create the TSL connection via REST helper } ``` -* feat(wd): screenshots for sessions (#4322) - by @KobeNguyent +- feat(wd): screenshots for sessions (#4322) - by @KobeNguyent Currently only screenshot of the active session is saved, this PR aims to save the screenshot of every session for easy debugging @@ -253,20 +672,21 @@ Scenario('should save screenshot for sessions @WebDriverIO @Puppeteer @Playwrigh await I.expectNotEqual(main_original, session_failed); }); ``` -![Screenshot 2024-04-29 at 11 07 47](https://github.com/codeceptjs/CodeceptJS/assets/7845001/5dddf85a-ed77-474b-adfd-2f208d3c16a8) +![Screenshot 2024-04-29 at 11 07 47](https://github.com/codeceptjs/CodeceptJS/assets/7845001/5dddf85a-ed77-474b-adfd-2f208d3c16a8) -* feat: locate element with withClassAttr (#4321) - by @KobeNguyent +- feat: locate element with withClassAttr (#4321) - by @KobeNguyent Find an element with class attribute ```js // find div with class contains 'form' -locate('div').withClassAttr('text'); +locate('div').withClassAttr('text') ``` -* fix(playwright): set the record video resolution (#4311) - by @KobeNguyent -You could now set the recording video resolution +- fix(playwright): set the record video resolution (#4311) - by @KobeNguyent + You could now set the recording video resolution + ``` url: siteUrl, windowSize: '300x500', @@ -283,68 +703,70 @@ You could now set the recording video resolution }, ``` -🐛 *Bug Fixes* -* fix: several issues of stepByStep report (#4331) - by @KobeNguyent +🐛 _Bug Fixes_ + +- fix: several issues of stepByStep report (#4331) - by @KobeNguyent + +📖 _Documentation_ -📖 *Documentation* -* fix: wrong format docs (#4330) - by @KobeNguyent -* fix(docs): wrong method is mentioned (#4320) - by @KobeNguyent -* fix: ChatGPT docs - by @davert +- fix: wrong format docs (#4330) - by @KobeNguyent +- fix(docs): wrong method is mentioned (#4320) - by @KobeNguyent +- fix: ChatGPT docs - by @davert ## 3.6.1 -* Fixed regression in interactive pause. +- Fixed regression in interactive pause. ## 3.6.0 -🛩ī¸ *Features* +🛩ī¸ _Features_ -* Introduced [healers](./heal) to improve stability of failed tests. Write functions that can perform actions to fix a failing test: +- Introduced [healers](./heal) to improve stability of failed tests. Write functions that can perform actions to fix a failing test: ```js heal.addRecipe('reloadPageIfModalIsNotVisisble', { - steps: [ - 'click', - ], + steps: ['click'], fn: async ({ error, step }) => { // this function will be executed only if test failed with // "model is not visible" message - if (error.message.include('modal is not visible')) return; + if (error.message.include('modal is not visible')) return // we return a function that will refresh a page // and tries to perform last step again return async ({ I }) => { - I.reloadPage(); - I.wait(1); - await step.run(); - }; + I.reloadPage() + I.wait(1) + await step.run() + } // if a function succeeds, test continues without an error }, -}); +}) ``` -* **Breaking Change** **AI** features refactored. Read updated [AI guide](./ai): - * **removed dependency on `openai`** - * added support for **Azure OpenAI**, **Claude**, **Mistal**, or any AI via custom request function - * `--ai` option added to explicitly enable AI features - * heal plugin decoupled from AI to run custom heal recipes - * improved healing for async/await scenarios - * token limits added - * token calculation introduced - * `OpenAI` helper renamed to `AI` +- **Breaking Change** **AI** features refactored. Read updated [AI guide](./ai): + - **removed dependency on `openai`** + - added support for **Azure OpenAI**, **Claude**, **Mistal**, or any AI via custom request function + - `--ai` option added to explicitly enable AI features + - heal plugin decoupled from AI to run custom heal recipes + - improved healing for async/await scenarios + - token limits added + - token calculation introduced + - `OpenAI` helper renamed to `AI` -* feat(puppeteer): network traffic manipulation. See #4263 by @KobeNguyenT - * `startRecordingTraffic` - * `grabRecordedNetworkTraffics` - * `flushNetworkTraffics` - * `stopRecordingTraffic` - * `seeTraffic` - * `dontSeeTraffic` +- feat(puppeteer): network traffic manipulation. See #4263 by @KobeNguyenT -* feat(Puppeteer): recording WS messages. See #4264 by @KobeNguyenT + - `startRecordingTraffic` + - `grabRecordedNetworkTraffics` + - `flushNetworkTraffics` + - `stopRecordingTraffic` + - `seeTraffic` + - `dontSeeTraffic` + +- feat(Puppeteer): recording WS messages. See #4264 by @KobeNguyenT Recording WS messages: + ``` I.startRecordingWebSocketMessages(); I.amOnPage('https://websocketstest.com/'); @@ -354,6 +776,7 @@ Recording WS messages: ``` flushing WS messages: + ``` I.startRecordingWebSocketMessages(); I.amOnPage('https://websocketstest.com/'); @@ -367,26 +790,26 @@ Examples: ```js // recording traffics and verify the traffic - I.startRecordingTraffic(); - I.amOnPage('https://codecept.io/'); - I.seeTraffic({ name: 'traffics', url: 'https://codecept.io/img/companies/BC_LogoScreen_C.jpg' }); +I.startRecordingTraffic() +I.amOnPage('https://codecept.io/') +I.seeTraffic({ name: 'traffics', url: 'https://codecept.io/img/companies/BC_LogoScreen_C.jpg' }) ``` ```js // check the traffic with advanced params - I.amOnPage('https://openai.com/blog/chatgpt'); - I.startRecordingTraffic(); - I.seeTraffic({ - name: 'sentry event', - url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600', - parameters: { - width: '1919', - height: '1138', - }, - }); +I.amOnPage('https://openai.com/blog/chatgpt') +I.startRecordingTraffic() +I.seeTraffic({ + name: 'sentry event', + url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600', + parameters: { + width: '1919', + height: '1138', + }, +}) ``` -* Introduce the playwright locator: `_react`, `_vue`, `data-testid` attribute. See #4255 by @KobeNguyenT +- Introduce the playwright locator: `_react`, `_vue`, `data-testid` attribute. See #4255 by @KobeNguyenT ``` Scenario('using playwright locator @Playwright', () => { @@ -410,7 +833,7 @@ Scenario('using playwright data-testid attribute @Playwright', () => { }); ``` -* feat(puppeteer): mockRoute support. See #4262 by @KobeNguyenT +- feat(puppeteer): mockRoute support. See #4262 by @KobeNguyenT Network requests & responses can be mocked and modified. Use `mockRoute` which strictly follows [Puppeteer's setRequestInterception API](https://pptr.dev/next/api/puppeteer.page.setrequestinterception). @@ -424,6 +847,7 @@ I.mockRoute('https://reqres.in/api/comments/1', request => { }); }) ``` + ``` I.mockRoute('**/*.{png,jpg,jpeg}', route => route.abort()); @@ -431,24 +855,26 @@ I.mockRoute('**/*.{png,jpg,jpeg}', route => route.abort()); // for previously mocked URL I.stopMockingRoute('**/*.{png,jpg,jpeg}'); ``` + To master request intercepting [use HTTPRequest object](https://pptr.dev/next/api/puppeteer.httprequest) passed into mock request handler. -🐛 *Bug Fixes* +🐛 _Bug Fixes_ -* Fixed double help message #4278 by @masiuchi -* waitNumberOfVisibleElements always failed when passing num as 0. See #4274 by @KobeNguyenT +- Fixed double help message #4278 by @masiuchi +- waitNumberOfVisibleElements always failed when passing num as 0. See #4274 by @KobeNguyenT ## 3.5.15 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat: improve code coverage plugin (#4252) - by @KobeNguyenT +🛩ī¸ _Features_ + +- feat: improve code coverage plugin (#4252) - by @KobeNguyenT We revamp the coverage plugin to make it easier to use Once all the tests are completed, `codecept` will create and store coverage in `output/coverage` folder, as shown below. -![]((https://github.com/codeceptjs/CodeceptJS/assets/7845001/3b8b81a3-7c85-470c-992d-ecdc7d5b4a1e)) +![](<(https://github.com/codeceptjs/CodeceptJS/assets/7845001/3b8b81a3-7c85-470c-992d-ecdc7d5b4a1e)>) Open `index.html` in your browser to view the full interactive coverage report. @@ -456,9 +882,10 @@ Open `index.html` in your browser to view the full interactive coverage report. ![](https://github.com/codeceptjs/CodeceptJS/assets/7845001/c821ce45-6590-4ace-b7ae-2cafb3a4e532) -🐛 *Bug Fixes* -* fix: bump puppeteer to v22.x (#4249) - by @KobeNguyenT -* fix: improve dry-run command (#4225) - by @KobeNguyenT +🐛 _Bug Fixes_ + +- fix: bump puppeteer to v22.x (#4249) - by @KobeNguyenT +- fix: improve dry-run command (#4225) - by @KobeNguyenT dry-run command now supports test level grep. @@ -472,10 +899,10 @@ PUT tests -- /Users/t/Desktop/projects/codeceptjs-rest-demo/src/PUT_test.ts -- 4 ☐ Verify creating new user @Jaja - Total: 2 suites | 3 tests + Total: 2 suites | 3 tests --- DRY MODE: No tests were executed --- -➜ codeceptjs-rest-demo git:(master) ✗ npx codeceptjs dry-run +➜ codeceptjs-rest-demo git:(master) ✗ npx codeceptjs dry-run Tests from /Users/t/Desktop/projects/codeceptjs-rest-demo: DELETE tests -- /Users/t/Desktop/projects/codeceptjs-rest-demo/src/DELETE_test.ts -- 4 tests @@ -492,92 +919,99 @@ PUT tests -- /Users/tDesktop/projects/codeceptjs-rest-demo/src/PUT_test.ts -- 4 ☐ Verify creating new user @Jaja - Total: 4 suites | 8 tests + Total: 4 suites | 8 tests --- DRY MODE: No tests were executed --- ``` -* Several internal fixes and improvements for github workflows +- Several internal fixes and improvements for github workflows ## 3.5.14 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🐛 *Bug Fixes* -* **Hotfix** Fixed missing `joi` package - by @KobeNguyenT +🐛 _Bug Fixes_ + +- **Hotfix** Fixed missing `joi` package - by @KobeNguyenT ## 3.5.13 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat: mock server helper (#4155) - by @KobeNguyenT +🛩ī¸ _Features_ + +- feat: mock server helper (#4155) - by @KobeNguyenT ![Screenshot 2024-01-25 at 13 47 59](https://github.com/codeceptjs/CodeceptJS/assets/7845001/8fe7aacf-f1c9-4d7e-89a6-3748b3ccb26c) -* feat(webdriver): network traffics manipulation (#4166) - by @KobeNguyenT - [Webdriver] Added commands to check network traffics - supported only with devtoolsProtocol - * `startRecordingTraffic` - * `grabRecordedNetworkTraffics` - * `flushNetworkTraffics` - * `stopRecordingTraffic` - * `seeTraffic` - * `dontSeeTraffic` +- feat(webdriver): network traffics manipulation (#4166) - by @KobeNguyenT + [Webdriver] Added commands to check network traffics - supported only with devtoolsProtocol + - `startRecordingTraffic` + - `grabRecordedNetworkTraffics` + - `flushNetworkTraffics` + - `stopRecordingTraffic` + - `seeTraffic` + - `dontSeeTraffic` Examples: ```js // recording traffics and verify the traffic - I.startRecordingTraffic(); - I.amOnPage('https://codecept.io/'); - I.seeTraffic({ name: 'traffics', url: 'https://codecept.io/img/companies/BC_LogoScreen_C.jpg' }); +I.startRecordingTraffic() +I.amOnPage('https://codecept.io/') +I.seeTraffic({ name: 'traffics', url: 'https://codecept.io/img/companies/BC_LogoScreen_C.jpg' }) ``` ```js // check the traffic with advanced params - I.amOnPage('https://openai.com/blog/chatgpt'); - I.startRecordingTraffic(); - I.seeTraffic({ - name: 'sentry event', - url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600', - parameters: { - width: '1919', - height: '1138', - }, - }); +I.amOnPage('https://openai.com/blog/chatgpt') +I.startRecordingTraffic() +I.seeTraffic({ + name: 'sentry event', + url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600', + parameters: { + width: '1919', + height: '1138', + }, +}) ``` -* feat(webapi): add waitForCookie (#4169) - by @KobeNguyenT + +- feat(webapi): add waitForCookie (#4169) - by @KobeNguyenT Waits for the specified cookie in the cookies. ```js -I.waitForCookie("token"); +I.waitForCookie('token') ``` -🐛 *Bug Fixes* -* fix(appium): update performSwipe with w3c protocol v2 (#4181) - by @MykaLev -* fix(webapi): selectOption method (#4157) - by @dyaroman -* fix: waitForText doesnt throw error when text doesnt exist (#4195) - by @KobeNguyenT -* fix: use this.options instead of this.config (#4186) - by @KobeNguyenT -* fix: config path without selenium (#4184) - by @KobeNguyenT -* fix: bring to front condition in _setPage (#4173) - by @KobeNguyenT -* fix: complicated locator (#4170) - by @KobeNguyenT +🐛 _Bug Fixes_ + +- fix(appium): update performSwipe with w3c protocol v2 (#4181) - by @MykaLev +- fix(webapi): selectOption method (#4157) - by @dyaroman +- fix: waitForText doesnt throw error when text doesnt exist (#4195) - by @KobeNguyenT +- fix: use this.options instead of this.config (#4186) - by @KobeNguyenT +- fix: config path without selenium (#4184) - by @KobeNguyenT +- fix: bring to front condition in \_setPage (#4173) - by @KobeNguyenT +- fix: complicated locator (#4170) - by @KobeNguyenT Adding of `':nth-child'` into the array -` const limitation = [':nth-of-type', ':first-of-type', ':last-of-type', ':nth-last-child', ':nth-last-of-type', ':checked', ':disabled', ':enabled', ':required', ':lang']; ` fixes the issue. Then an old conversion way over `css-to-xpath` is used. +`const limitation = [':nth-of-type', ':first-of-type', ':last-of-type', ':nth-last-child', ':nth-last-of-type', ':checked', ':disabled', ':enabled', ':required', ':lang'];` fixes the issue. Then an old conversion way over `css-to-xpath` is used. -📖 *Documentation* -* fix(docs): missing docs for codecept UI (#4175) - by @KobeNguyenT -* fix(docs): Appium documentation sidebar menu links (#4188) - by @mirao +📖 _Documentation_ -🛩ī¸ **Several bugfixes and improvements for Codecept-UI** -* Several internal improvements -* fix: title is not showing when visiting a test -* fix: handle erros nicely +- fix(docs): missing docs for codecept UI (#4175) - by @KobeNguyenT +- fix(docs): Appium documentation sidebar menu links (#4188) - by @mirao + +🛩ī¸ **Several bugfixes and improvements for Codecept-UI** + +- Several internal improvements +- fix: title is not showing when visiting a test +- fix: handle erros nicely ## 3.5.12 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat: upgrade wdio (#4123) - by @KobeNguyenT +🛩ī¸ _Features_ + +- feat: upgrade wdio (#4123) - by @KobeNguyenT 🛩ī¸ With the release of WebdriverIO version `v8.14.0`, and onwards, all driver management hassles are now a thing of the past 🙌. Read more [here](https://webdriver.io/blog/2023/07/31/driver-management/). One of the significant advantages of this update is that you can now get rid of any driver services you previously had to manage, such as @@ -625,7 +1059,8 @@ For example: } } ``` -* feat: wdio with devtools protocol (#4105) - by @KobeNguyenT + +- feat: wdio with devtools protocol (#4105) - by @KobeNguyenT Running with devtools protocol @@ -645,29 +1080,34 @@ Running with devtools protocol } } ``` -* feat: add a locator builder method withTextEquals() (#4100) - by @mirao + +- feat: add a locator builder method withTextEquals() (#4100) - by @mirao Find an element with exact text + ```js -locate('button').withTextEquals('Add'); +locate('button').withTextEquals('Add') ``` -* feat: waitForNumberOfTabs (#4124) - by @KobeNguyenT + +- feat: waitForNumberOfTabs (#4124) - by @KobeNguyenT Waits for number of tabs. ```js -I.waitForNumberOfTabs(2); +I.waitForNumberOfTabs(2) ``` -* feat: I.say would be added to Test.steps array (#4145) - by @KobeNguyenT + +- feat: I.say would be added to Test.steps array (#4145) - by @KobeNguyenT Currently `I.say` is not added into the `Test.steps` array. This PR aims to add this to steps array so that we could use it to print steps in ReportPortal for instance. ![Screenshot 2024-01-19 at 15 41 34](https://github.com/codeceptjs/CodeceptJS/assets/7845001/82af552a-aeb3-487e-ac10-b5bb7e42470f) -🐛 *Bug Fixes* -* fix: reduce the package size to 2MB (#4138) - by @KobeNguyenT -* fix(webapi): see attributes on elements (#4147) - by @KobeNguyenT -* fix: some assertion methods (#4144) - by @KobeNguyenT +🐛 _Bug Fixes_ + +- fix: reduce the package size to 2MB (#4138) - by @KobeNguyenT +- fix(webapi): see attributes on elements (#4147) - by @KobeNguyenT +- fix: some assertion methods (#4144) - by @KobeNguyenT Improve the error message for `seeElement`, `dontSeeElement`, `seeElementInDOM`, `dontSeeElementInDOM` @@ -693,29 +1133,29 @@ Updated at Playwright.dontSeeElement (lib/helper/Playwright.js:1472:7) ``` -* fix: css to xpath backward compatibility (#4141) - by @KobeNguyenT +- fix: css to xpath backward compatibility (#4141) - by @KobeNguyenT -- [css-to-xpath](https://www.npmjs.com/package/css-to-xpath): old lib, which works perfectly unless you have hyphen in locator. (https://github.com/codeceptjs/CodeceptJS/issues/3563) -- [csstoxpath](https://www.npmjs.com/package/csstoxpath): new lib, to solve the issue locator with hyphen but also have some [limitations](https://www.npmjs.com/package/csstoxpath#limitations) +* [css-to-xpath](https://www.npmjs.com/package/css-to-xpath): old lib, which works perfectly unless you have hyphen in locator. (https://github.com/codeceptjs/CodeceptJS/issues/3563) +* [csstoxpath](https://www.npmjs.com/package/csstoxpath): new lib, to solve the issue locator with hyphen but also have some [limitations](https://www.npmjs.com/package/csstoxpath#limitations) -* fix: grabRecordedNetworkTraffics throws error when being called twice (#4143) - by @KobeNguyenT -* fix: missing steps of test when running with workers (#4127) - by @KobeNguyenT +- fix: grabRecordedNetworkTraffics throws error when being called twice (#4143) - by @KobeNguyenT +- fix: missing steps of test when running with workers (#4127) - by @KobeNguyenT ```js Scenario('Verify getting list of users', async () => { -let res = await I.getUserPerPage(2); -res.data = []; // this line causes the issue -await I.expectEqual(res.data.data[0].id, 7); -}); + let res = await I.getUserPerPage(2) + res.data = [] // this line causes the issue + await I.expectEqual(res.data.data[0].id, 7) +}) ``` + at this time, res.data.data[0].id would throw undefined error and somehow the test is missing all its steps. -* fix: process.env.profile when --profile isn't set in run-multiple mode (#4131) - by @mirao +- fix: process.env.profile when --profile isn't set in run-multiple mode (#4131) - by @mirao `process.env.profile` is the string "undefined" instead of type undefined when no --profile is specified in the mode "run-multiple" - -* fix: session doesn't respect the context options (#4111) - by @KobeNguyenT +- fix: session doesn't respect the context options (#4111) - by @KobeNguyenT ```js Helpers: Playwright @@ -740,18 +1180,18 @@ sessionScreen is {"width":375,"height":667} OK | 1 passed // 4s ``` -* fix(plugin): retryTo issue (#4117) - by @KobeNguyenT +- fix(plugin): retryTo issue (#4117) - by @KobeNguyenT ![Screenshot 2024-01-08 at 17 36 54](https://github.com/codeceptjs/CodeceptJS/assets/7845001/39c97073-e2e9-4c4c-86ee-62540bc95015) -* fix(types): CustomLocator typing broken for custom strict locators (#4120) - by @KobeNguyenT -* fix: wrong output for skipped tests - by @KobeNguyenT -* fix: no retry failed step after tryto block (#4103) - by @KobeNguyenT -* fix: deprecate some JSON Wire Protocol commands (#4104) - by @KobeNguyenT +- fix(types): CustomLocator typing broken for custom strict locators (#4120) - by @KobeNguyenT +- fix: wrong output for skipped tests - by @KobeNguyenT +- fix: no retry failed step after tryto block (#4103) - by @KobeNguyenT +- fix: deprecate some JSON Wire Protocol commands (#4104) - by @KobeNguyenT deprecate some JSON Wire Protocol commands: `grabGeoLocation`, `setGeoLocation` -* fix: cannot locate complicated locator (#4101) - by @KobeNguyenT - +- fix: cannot locate complicated locator (#4101) - by @KobeNguyenT + Locator issue due to the lib changes ``` @@ -764,34 +1204,39 @@ The locator locate(".ps-menu-button").withText("Authoring").inside(".ps-submenu- ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat: other locators from playwright (#4090) - by @KobeNguyenT - * CodeceptJS - Playwright now supports other locators like - * React (https://playwright.dev/docs/other-locators#react-locator), - * Vue (https://playwright.dev/docs/other-locators#vue-locator) +🛩ī¸ _Features_ + +- feat: other locators from playwright (#4090) - by @KobeNguyenT + - CodeceptJS - Playwright now supports other locators like + - React (https://playwright.dev/docs/other-locators#react-locator), + - Vue (https://playwright.dev/docs/other-locators#vue-locator) ![Vue Locators](https://github.com/codeceptjs/CodeceptJS/assets/7845001/841e9e54-847b-4326-b95f-f9406955a3ce) ![Example](https://github.com/codeceptjs/CodeceptJS/assets/7845001/763e6788-143b-4a00-a249-d9ca5f0b2a09) -🐛 *Bug Fixes* -* fix: step object is broken when step arg is a function (#4092) - by @KobeNguyenT -* fix: step object is broken when step arg contains joi object (#4084) - by @KobeNguyenT -* fix(expect helper): custom error message as optional param (#4082) - by @KobeNguyenT -* fix(puppeteer): hide deprecation info (#4075) - by @KobeNguyenT -* fix: seeattributesonelements throws error when attribute doesn't exist (#4073) - by @KobeNguyenT -* fix: typo in agrs (#4077) - by @KobeNguyenT -* fix: retryFailedStep is disabled for non tryTo steps (#4069) - by @KobeNguyenT -* fix(typings): scrollintoview complains scrollintoviewoptions (#4067) - by @KobeNguyenT +🐛 _Bug Fixes_ + +- fix: step object is broken when step arg is a function (#4092) - by @KobeNguyenT +- fix: step object is broken when step arg contains joi object (#4084) - by @KobeNguyenT +- fix(expect helper): custom error message as optional param (#4082) - by @KobeNguyenT +- fix(puppeteer): hide deprecation info (#4075) - by @KobeNguyenT +- fix: seeattributesonelements throws error when attribute doesn't exist (#4073) - by @KobeNguyenT +- fix: typo in agrs (#4077) - by @KobeNguyenT +- fix: retryFailedStep is disabled for non tryTo steps (#4069) - by @KobeNguyenT +- fix(typings): scrollintoview complains scrollintoviewoptions (#4067) - by @KobeNguyenT -📖 *Documentation* -* fix(docs): some doc blocks are broken (#4076) - by @KobeNguyenT -* fix(docs): expect docs (#4058) - by @KobeNguyenT +📖 _Documentation_ + +- fix(docs): some doc blocks are broken (#4076) - by @KobeNguyenT +- fix(docs): expect docs (#4058) - by @KobeNguyenT ## 3.5.10 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat: expose WebElement (#4043) - by @KobeNguyenT +🛩ī¸ _Features_ + +- feat: expose WebElement (#4043) - by @KobeNguyenT + ``` Now we expose the WebElements that are returned by the WebHelper and you could make the subsequence actions on them. @@ -801,7 +1246,9 @@ I.amOnPage('/form/focus_blur_elements'); const webElements = await I.grabWebElements('#button'); webElements[0].click(); ``` -* feat(playwright): support HAR replaying (#3990) - by @KobeNguyenT + +- feat(playwright): support HAR replaying (#3990) - by @KobeNguyenT + ``` Replaying from HAR @@ -815,11 +1262,13 @@ Replaying from HAR harFilePath [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) Path to recorded HAR file opts [object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)? [Options for replaying from HAR](https://playwright.dev/docs/api/class-page#page-route-from-har) ``` -* feat(playwright): support HAR recording (#3986) - by @KobeNguyenT + +- feat(playwright): support HAR recording (#3986) - by @KobeNguyenT + ``` -A HAR file is an HTTP Archive file that contains a record of all the network requests that are made when a page is loaded. -It contains information about the request and response headers, cookies, content, timings, and more. -You can use HAR files to mock network requests in your tests. HAR will be saved to output/har. +A HAR file is an HTTP Archive file that contains a record of all the network requests that are made when a page is loaded. +It contains information about the request and response headers, cookies, content, timings, and more. +You can use HAR files to mock network requests in your tests. HAR will be saved to output/har. More info could be found here https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har. ... @@ -829,16 +1278,20 @@ recordHar: { } ... ``` -* improvement(playwright): support partial string for option (#4016) - by @KobeNguyenT + +- improvement(playwright): support partial string for option (#4016) - by @KobeNguyenT + ``` await I.amOnPage('/form/select'); await I.selectOption('Select your age', '21-'); ``` -🐛 *Bug Fixes* -* fix(playwright): proceedSee could not find the element (#4006) - by @hatufacci -* fix(appium): remove the vendor prefix of 'bstack:options' (#4053) - by @mojtabaalavi -* fix(workers): event improvements (#3953) - by @KobeNguyenT +🐛 _Bug Fixes_ + +- fix(playwright): proceedSee could not find the element (#4006) - by @hatufacci +- fix(appium): remove the vendor prefix of 'bstack:options' (#4053) - by @mojtabaalavi +- fix(workers): event improvements (#3953) - by @KobeNguyenT + ``` Emit the new event: event.workers.result. @@ -851,7 +1304,7 @@ module.exports = function() { event.dispatcher.on(event.workers.result, async () => { await _publishResultsToTestrail(); }); - + // this event would not trigger the `_publishResultsToTestrail` multiple times when running `run-workers` command event.dispatcher.on(event.all.result, async () => { // when running `run` command, this env var is undefined @@ -859,7 +1312,9 @@ module.exports = function() { }); } ``` -* fix: ai html updates (#3962) - by @DavertMik + +- fix: ai html updates (#3962) - by @DavertMik + ``` replaced minify library with a modern and more secure fork. Fixes html-minifier@4.0.0 Regular Expression Denial of Service vulnerability #3829 AI class is implemented as singleton @@ -868,18 +1323,22 @@ add configuration params on number of fixes performed by ay heal improved recorder class to add more verbose log improved recorder class to ignore some of errors ``` -* fix(appium): closeApp supports both Android/iOS (#4046) - by @KobeNguyenT -* fix: some security vulnerability of some packages (#4045) - by @KobeNguyenT -* fix: seeAttributesOnElements check condition (#4029) - by @KobeNguyenT -* fix: waitForText locator issue (#4039) - by @KobeNguyenT + +- fix(appium): closeApp supports both Android/iOS (#4046) - by @KobeNguyenT +- fix: some security vulnerability of some packages (#4045) - by @KobeNguyenT +- fix: seeAttributesOnElements check condition (#4029) - by @KobeNguyenT +- fix: waitForText locator issue (#4039) - by @KobeNguyenT + ``` Fixed this error: locator.isVisible: Unexpected token "s" while parsing selector ":has-text('Were you able to resolve the resident's issue?') >> nth=0" at Playwright.waitForText (node_modules\codeceptjs\lib\helper\Playwright.js:2584:79) ``` -* fix: move to sha256 (#4038) - by @KobeNguyenT -* fix: respect retries from retryfailedstep plugin in helpers (#4028) - by @KobeNguyenT + +- fix: move to sha256 (#4038) - by @KobeNguyenT +- fix: respect retries from retryfailedstep plugin in helpers (#4028) - by @KobeNguyenT + ``` Currently inside the _before() of helpers for example Playwright, the retries is set there, however, when retryFailedStep plugin is enabled, the retries of recorder is still using the value from _before() not the value from retryFailedStep plugin. @@ -888,7 +1347,9 @@ Fix: - introduce the process.env.FAILED_STEP_RETIRES which could be access everywhere as the helper won't know anything about the plugin. - set default retries of Playwright to 3 to be on the same page with Puppeteer. ``` -* fix: examples in test title (#4030) - by @KobeNguyenT + +- fix: examples in test title (#4030) - by @KobeNguyenT + ``` When test title doesn't have the data in examples: @@ -902,7 +1363,7 @@ Feature: Faker examples Faker examples -- [1] Starting recording promises - Timeouts: + Timeouts: Below are the users {"user":"John","role":"admin"} ✔ OK in 4ms @@ -923,33 +1384,35 @@ Feature: Faker examples Faker examples -- [1] Starting recording promises - Timeouts: - Below are the users - John - admin + Timeouts: + Below are the users - John - admin ✔ OK in 4ms - Below are the users - Tim - client + Below are the users - Tim - client ✔ OK in 1ms ``` -* fix: disable retryFailedStep when using with tryTo (#4022) - by @KobeNguyenT -* fix: locator builder returns error when class name contains hyphen (#4024) - by @KobeNguyenT -* fix: seeCssPropertiesOnElements failed when font-weight is a number (#4026) - by @KobeNguyenT -* fix(appium): missing await on some steps of runOnIOS and runOnAndroid (#4018) - by @KobeNguyenT -* fix(cli): no error of failed tests when using retry with scenario only (#4020) - by @KobeNguyenT -* fix: set getPageTimeout to 30s (#4031) - by @KobeNguyenT -* fix(appium): expose switchToContext (#4015) - by @KobeNguyenT -* fix: promise issue (#4013) - by @KobeNguyenT -* fix: seeCssPropertiesOnElements issue with improper condition (#4057) - by @KobeNguyenT - -📖 *Documentation* -* docs: Update clearCookie documentation for Playwright helper (#4005) - by @Hellosager -* docs: improve the example code for autoLogin (#4019) - by @KobeNguyenT + +- fix: disable retryFailedStep when using with tryTo (#4022) - by @KobeNguyenT +- fix: locator builder returns error when class name contains hyphen (#4024) - by @KobeNguyenT +- fix: seeCssPropertiesOnElements failed when font-weight is a number (#4026) - by @KobeNguyenT +- fix(appium): missing await on some steps of runOnIOS and runOnAndroid (#4018) - by @KobeNguyenT +- fix(cli): no error of failed tests when using retry with scenario only (#4020) - by @KobeNguyenT +- fix: set getPageTimeout to 30s (#4031) - by @KobeNguyenT +- fix(appium): expose switchToContext (#4015) - by @KobeNguyenT +- fix: promise issue (#4013) - by @KobeNguyenT +- fix: seeCssPropertiesOnElements issue with improper condition (#4057) - by @KobeNguyenT + +📖 _Documentation_ + +- docs: Update clearCookie documentation for Playwright helper (#4005) - by @Hellosager +- docs: improve the example code for autoLogin (#4019) - by @KobeNguyenT ![Screenshot 2023-11-22 at 14 40 11](https://github.com/codeceptjs/CodeceptJS/assets/7845001/c05ac436-efd0-4bc0-a46c-386f915c0f17) ## 3.5.8 Thanks all to those who contributed to make this release! -🐛 *Bug Fixes* +🐛 _Bug Fixes_ fix(appium): type of setNetworkConnection() (#3994) - by @mirao fix: improve the way to show deprecated appium v1 message (#3992) - by @KobeNguyenT fix: missing exit condition of some wait functions - by @KobeNguyenT @@ -958,14 +1421,16 @@ fix: missing exit condition of some wait functions - by @KobeNguyenT Thanks all to those who contributed to make this release! -🐛 *Bug Fixes* -* Bump playwright to 1.39.0 - run `npx playwright install` to install the browsers as starting from 1.39.0 browsers are not installed automatically (#3924) - by @KobeNguyenT -* fix(playwright): some wait functions draw error due to switchTo iframe (#3918) - by @KobeNguyenT -* fix(appium): AppiumTestDistribution/appium-device-farm requires 'platformName' (#3950) - by @rock-tran -* fix: autologin with empty fetch (#3947) - by @andonary -* fix(cli): customLocator draws error in dry-mode (#3940) - by @KobeNguyenT -* fix: ensure docs include @returns Promise where appropriate (#3954) - by @fwouts -* fix: long text in data table cuts off (#3936) - by @KobeNguyenT +🐛 _Bug Fixes_ + +- Bump playwright to 1.39.0 - run `npx playwright install` to install the browsers as starting from 1.39.0 browsers are not installed automatically (#3924) - by @KobeNguyenT +- fix(playwright): some wait functions draw error due to switchTo iframe (#3918) - by @KobeNguyenT +- fix(appium): AppiumTestDistribution/appium-device-farm requires 'platformName' (#3950) - by @rock-tran +- fix: autologin with empty fetch (#3947) - by @andonary +- fix(cli): customLocator draws error in dry-mode (#3940) - by @KobeNguyenT +- fix: ensure docs include @returns Promise where appropriate (#3954) - by @fwouts +- fix: long text in data table cuts off (#3936) - by @KobeNguyenT + ``` #language: de Funktionalität: Faker examples @@ -974,51 +1439,58 @@ Funktionalität: Faker examples Angenommen que estou logado via REST com o usuÃĄrio "" | protocol | https: | | hostname | https://cucumber.io/docs/gherkin/languages/ | - + Faker examples -- Atualizar senha do usuÃĄrio {"product":"{{vehicle.vehicle}}","customer":"Dr. {{name.findName}}","price":"{{commerce.price}}","cashier":"cashier 2"} - On Angenommen: que estou logado via rest com o usuÃĄrio "dr. {{name.find name}}" - protocol | https: + On Angenommen: que estou logado via rest com o usuÃĄrio "dr. {{name.find name}}" + protocol | https: hostname | https://cucumber.io/docs/gherkin/languages/ - + Dr. {{name.findName}} ✔ OK in 13ms ``` -* fix(playwright): move to waitFor (#3933) - by @KobeNguyenT -* fix: relax grabCookie type (#3919) - by @KobeNguyenT -* fix: proceedSee error when being called inside within (#3939) - by @KobeNguyenT -* fix: rename haveRequestHeaders of ppt and pw helpers (#3937) - by @KobeNguyenT + +- fix(playwright): move to waitFor (#3933) - by @KobeNguyenT +- fix: relax grabCookie type (#3919) - by @KobeNguyenT +- fix: proceedSee error when being called inside within (#3939) - by @KobeNguyenT +- fix: rename haveRequestHeaders of ppt and pw helpers (#3937) - by @KobeNguyenT + ``` Renamed haveRequestHeaders of Puppeteer, Playwright helper so that it would not confuse the REST helper. Puppeteer: setPuppeteerRequestHeaders Playwright: setPlaywrightRequestHeaders ``` -* improvement: handle the way to load apifactory nicely (#3941) - by @KobeNguyenT + +- improvement: handle the way to load apifactory nicely (#3941) - by @KobeNguyenT + ``` With this fix, we could now use the following syntax: export = new Factory() .attr('name', () => faker.name.findName()) .attr('job', () => 'leader'); - + export default new Factory() .attr('name', () => faker.name.findName()) .attr('job', () => 'leader'); - + modules.export = new Factory() .attr('name', () => faker.name.findName()) .attr('job', () => 'leader'); ``` -📖 *Documentation* -* docs(appium): update to v2 (#3932) - by @KobeNguyenT -* docs: improve BDD Gherkin docs (#3938) - by @KobeNguyenT -* Other docs improvements +📖 _Documentation_ + +- docs(appium): update to v2 (#3932) - by @KobeNguyenT +- docs: improve BDD Gherkin docs (#3938) - by @KobeNguyenT +- Other docs improvements + +🛩ī¸ _Features_ + +- feat(puppeteer): support trace recording - by @KobeNguyenT -🛩ī¸ *Features* -* feat(puppeteer): support trace recording - by @KobeNguyenT ``` [Trace Recording Customization] Trace recording provides complete information on test execution and includes screenshots, and network requests logged during run. Traces will be saved to output/trace @@ -1026,8 +1498,10 @@ Trace recording provides complete information on test execution and includes scr trace: enables trace recording for failed tests; trace are saved into output/trace folder keepTraceForPassedTests: - save trace for passed tests ``` -* feat: expect helper (#3923) - by @KobeNguyenT -``` + +- feat: expect helper (#3923) - by @KobeNguyenT + +```` * This helper allows performing assertions based on Chai. * * ### Examples @@ -1041,7 +1515,7 @@ keepTraceForPassedTests: - save trace for passed tests * Playwright: {...}, * ExpectHelper: {}, * } - + Expect Helper #expectEqual #expectNotEqual @@ -1070,16 +1544,22 @@ keepTraceForPassedTests: - save trace for passed tests #expectDeepIncludeMembers #expectDeepEqualExcluding #expectLengthBelowThan -``` -* feat: run-workers with multiple browsers output folders - by @KobeNguyenT -- ![Screenshot 2023-11-04 at 10 49 56](https://github.com/codeceptjs/CodeceptJS/assets/7845001/8eaecc54-de14-4597-b148-1e087bec3c76) -- ![Screenshot 2023-11-03 at 15 56 38](https://github.com/codeceptjs/CodeceptJS/assets/7845001/715aed17-3535-48df-80dd-84f7024f08e3) -* feat: introduce new Playwright methods - by @hatufacci +```` + +- feat: run-workers with multiple browsers output folders - by @KobeNguyenT + +* ![Screenshot 2023-11-04 at 10 49 56](https://github.com/codeceptjs/CodeceptJS/assets/7845001/8eaecc54-de14-4597-b148-1e087bec3c76) +* ![Screenshot 2023-11-03 at 15 56 38](https://github.com/codeceptjs/CodeceptJS/assets/7845001/715aed17-3535-48df-80dd-84f7024f08e3) + +- feat: introduce new Playwright methods - by @hatufacci + ``` - grabCheckedElementStatus - grabDisabledElementStatus ``` -* feat: gherkin supports i18n (#3934) - by @KobeNguyenT + +- feat: gherkin supports i18n (#3934) - by @KobeNguyenT + ``` #language: de Funktionalität: Checkout-Prozess @@ -1098,7 +1578,9 @@ Funktionalität: Checkout-Prozess | price | total | | 10 | 10.0 | ``` -* feat(autoLogin): improve the check method (#3935) - by @KobeNguyenT + +- feat(autoLogin): improve the check method (#3935) - by @KobeNguyenT + ``` Instead of asserting on page elements for the current user in check, you can use the session you saved in fetch @@ -1132,16 +1614,20 @@ Scenario('login', async ( {I, login} ) => { Thanks all to those who contributed to make this release! -🐛 *Bug Fixes* -* fix: switchTo/within block doesn't switch to expected iframe (#3892) - by @KobeNguyenT -* fix: highlight element doesn't work as expected (#3896) - by @KobeNguyenT +🐛 _Bug Fixes_ + +- fix: switchTo/within block doesn't switch to expected iframe (#3892) - by @KobeNguyenT +- fix: highlight element doesn't work as expected (#3896) - by @KobeNguyenT + ``` verbose/ highlight TRUE TRUE -> highlight element verbose/ highlight TRUE FALSE -> no highlight element verbose/ highlight FALSE TRUE -> no highlight element verbose/ highlight FALSE FALSE -> no highlight element - ``` -* fix: masked value issue in data table (#3885) - by @KobeNguyenT +``` + +- fix: masked value issue in data table (#3885) - by @KobeNguyenT + ``` const accounts = new DataTable(['role', 'username', 'password']); accounts.add([ @@ -1163,8 +1649,8 @@ Data(accounts) I.amOnPage('/'); loginPage.**sendForm**(current.username, current.password); ) - - + + // output The test feature -- The scenario | {"username":"Username","password": ***} @@ -1178,14 +1664,17 @@ Data(accounts) ✔ OK in 1ms ``` -* fix: debug info causes error (#3882) - by @KobeNguyenT +- fix: debug info causes error (#3882) - by @KobeNguyenT + +📖 _Documentation_ + +- fix: get rid of complaining when using session without await and returning nothing. (#3899) - by @KobeNguyenT +- fix(FileSystem): a typo in writeToFile() (#3897) - by @mirao -📖 *Documentation* -* fix: get rid of complaining when using session without await and returning nothing. (#3899) - by @KobeNguyenT -* fix(FileSystem): a typo in writeToFile() (#3897) - by @mirao +🛩ī¸ _Features_ + +- feat(translation): add more french keywords and fix deprecated waitForClickable (#3906) - by @andonary -🛩ī¸ *Features* -* feat(translation): add more french keywords and fix deprecated waitForClickable (#3906) - by @andonary ``` - Add some french keywords for translation - I.waitForClickable has the same "attends" than I.wait. Using "attends" leads to use the deprecated waitForClickable. Fix it by using different words. @@ -1194,7 +1683,9 @@ Data(accounts) ## 3.5.5 🐛 Bug Fixes -* fix(browserstack): issue with vendor prefix (#3845) - by @KobeNguyenT + +- fix(browserstack): issue with vendor prefix (#3845) - by @KobeNguyenT + ``` export const caps = { androidCaps: { @@ -1228,7 +1719,7 @@ export const caps = { } ``` -* switchTo/within now supports strict locator (#3847) - by @KobeNguyenT +- switchTo/within now supports strict locator (#3847) - by @KobeNguyenT ``` I.switchTo({ css: 'iframe[id^=number-frame]' }) // support the strict locator @@ -1244,24 +1735,28 @@ within({ }); ``` -* Improve the IntelliSense when using other languages (#3848) - by @andonary +- Improve the IntelliSense when using other languages (#3848) - by @andonary + ``` include: { Je: './steps_file.js' } ``` -* bypassCSP support for Playwright helper (#3865) - by @sammeel +- bypassCSP support for Playwright helper (#3865) - by @sammeel + ``` helpers: { Playwright: { bypassCSP: true } ``` -* fix: missing requests when recording network (#3834) - by @KobeNguyenT + +- fix: missing requests when recording network (#3834) - by @KobeNguyenT 🛩ī¸ Features and Improvements -* Show environment info in verbose mode (#3858) - by @KobeNguyenT + +- Show environment info in verbose mode (#3858) - by @KobeNguyenT ``` Environment information:- @@ -1327,9 +1822,9 @@ Please copy environment info when you report issues on GitHub: https://github.co CodeceptJS v3.5.4 #StandWithUkraine ``` -* some typings improvements (#3855) - by @nikzupancic -* support the puppeteer 21.1.1 (#3856) - by @KobeNguyenT -* fix: support secret value for some methods (#3837) - by @KobeNguyenT +- some typings improvements (#3855) - by @nikzupancic +- support the puppeteer 21.1.1 (#3856) - by @KobeNguyenT +- fix: support secret value for some methods (#3837) - by @KobeNguyenT ``` await I.amOnPage('/form/field_values'); @@ -1341,18 +1836,21 @@ await I.dontSeeInField('checkbox[]', secret('not seen three')); await I.seeInField('checkbox[]', secret('see test three')); ``` -🛩ī¸ **Several bugfixes and improvements for Codecept-UI** -* Mask the secret value in UI -* Improve UX/UI -* PageObjects are now showing in UI +🛩ī¸ **Several bugfixes and improvements for Codecept-UI** + +- Mask the secret value in UI +- Improve UX/UI +- PageObjects are now showing in UI ## 3.5.4 🐛 Bug Fixes: - * [Playwright] When passing `userDataDir`, it throws error after test execution (#3814) - by @KobeNguyenT - * [CodeceptJS-CLI] Improve command to generate types (#3788) - by @KobeNguyenT - * Heal plugin fix (#3820) - by @davert - * Fix for error in using `all` with `run-workers` (#3805) - by @KobeNguyenT + +- [Playwright] When passing `userDataDir`, it throws error after test execution (#3814) - by @KobeNguyenT +- [CodeceptJS-CLI] Improve command to generate types (#3788) - by @KobeNguyenT +- Heal plugin fix (#3820) - by @davert +- Fix for error in using `all` with `run-workers` (#3805) - by @KobeNguyenT + ```js helpers: { Playwright: { @@ -1375,29 +1873,33 @@ await I.seeInField('checkbox[]', secret('see test three')); }, }, ``` - * Highlight elements issues (#3779) (#3778) - by @philkas - * Support ` ` symbol in `I.see` method (#3815) - by @KobeNguyenT + +- Highlight elements issues (#3779) (#3778) - by @philkas +- Support ` ` symbol in `I.see` method (#3815) - by @KobeNguyenT ```js // HTML code uses   instead of space -
My Text!
+;
+ My Text! +
-I.see("My Text!") // this test would work with both   and space +I.see('My Text!') // this test would work with both   and space ``` 📖 Documentation - * Improve the configuration of electron testing when the app is build with electron-forge (#3802) - by @KobeNguyenT + +- Improve the configuration of electron testing when the app is build with electron-forge (#3802) - by @KobeNguyenT ```js -const path = require("path"); +const path = require('path') exports.config = { helpers: { Playwright: { - browser: "electron", + browser: 'electron', electron: { - executablePath: require("electron"), - args: [path.join(__dirname, ".webpack/main/index.js")], + executablePath: require('electron'), + args: [path.join(__dirname, '.webpack/main/index.js')], }, }, }, @@ -1408,26 +1910,28 @@ exports.config = { 🛩ī¸ Features #### [Playwright] new features and improvements - * Parse the response in recording network steps (#3771) - by @KobeNguyenT + +- Parse the response in recording network steps (#3771) - by @KobeNguyenT ```js - const traffics = await I.grabRecordedNetworkTraffics(); - expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1'); - expect(traffics[0].response.status).to.equal(200); - expect(traffics[0].response.body).to.contain({ name: 'this was mocked' }); +const traffics = await I.grabRecordedNetworkTraffics() +expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1') +expect(traffics[0].response.status).to.equal(200) +expect(traffics[0].response.body).to.contain({ name: 'this was mocked' }) - expect(traffics[1].url).to.equal('https://reqres.in/api/comments/1'); - expect(traffics[1].response.status).to.equal(200); - expect(traffics[1].response.body).to.contain({ name: 'this was another mocked' }); +expect(traffics[1].url).to.equal('https://reqres.in/api/comments/1') +expect(traffics[1].response.status).to.equal(200) +expect(traffics[1].response.body).to.contain({ name: 'this was another mocked' }) ``` - * Grab metrics (#3809) - by @KobeNguyenT + +- Grab metrics (#3809) - by @KobeNguyenT ```js -const metrics = await I.grabMetrics(); +const metrics = await I.grabMetrics() // returned metrics -[ +;[ { name: 'Timestamp', value: 1584904.203473 }, { name: 'AudioHandlers', value: 0 }, { name: 'AudioWorkletProcessors', value: 0 }, @@ -1463,149 +1967,150 @@ const metrics = await I.grabMetrics(); { name: 'JSHeapTotalSize', value: 26820608 }, { name: 'FirstMeaningfulPaint', value: 0 }, { name: 'DomContentLoaded', value: 1584903.690491 }, - { name: 'NavigationStart', value: 1584902.841845 } + { name: 'NavigationStart', value: 1584902.841845 }, ] ``` -* Grab WebSocket (WS) messages (#3789) - by @KobeNguyenT - * `flushWebSocketMessages` - * `grabWebSocketMessages` - * `startRecordingWebSocketMessages` - * `stopRecordingWebSocketMessages` +- Grab WebSocket (WS) messages (#3789) - by @KobeNguyenT + - `flushWebSocketMessages` + - `grabWebSocketMessages` + - `startRecordingWebSocketMessages` + - `stopRecordingWebSocketMessages` ```js -await I.startRecordingWebSocketMessages(); -I.amOnPage('https://websocketstest.com/'); -I.waitForText('Work for You!'); -I.flushNetworkTraffics(); -const wsMessages = I.grabWebSocketMessages(); -expect(wsMessages.length).to.equal(0); +await I.startRecordingWebSocketMessages() +I.amOnPage('https://websocketstest.com/') +I.waitForText('Work for You!') +I.flushNetworkTraffics() +const wsMessages = I.grabWebSocketMessages() +expect(wsMessages.length).to.equal(0) ``` ```js -await I.startRecordingWebSocketMessages(); -await I.amOnPage('https://websocketstest.com/'); -I.waitForText('Work for You!'); -const wsMessages = I.grabWebSocketMessages(); -expect(wsMessages.length).to.greaterThan(0); +await I.startRecordingWebSocketMessages() +await I.amOnPage('https://websocketstest.com/') +I.waitForText('Work for You!') +const wsMessages = I.grabWebSocketMessages() +expect(wsMessages.length).to.greaterThan(0) ``` ```js -await I.startRecordingWebSocketMessages(); -await I.amOnPage('https://websocketstest.com/'); -I.waitForText('Work for You!'); -const wsMessages = I.grabWebSocketMessages(); -await I.stopRecordingWebSocketMessages(); -await I.amOnPage('https://websocketstest.com/'); -I.waitForText('Work for You!'); -const afterWsMessages = I.grabWebSocketMessages(); -expect(wsMessages.length).to.equal(afterWsMessages.length); +await I.startRecordingWebSocketMessages() +await I.amOnPage('https://websocketstest.com/') +I.waitForText('Work for You!') +const wsMessages = I.grabWebSocketMessages() +await I.stopRecordingWebSocketMessages() +await I.amOnPage('https://websocketstest.com/') +I.waitForText('Work for You!') +const afterWsMessages = I.grabWebSocketMessages() +expect(wsMessages.length).to.equal(afterWsMessages.length) ``` -* Move from `ElementHandle` to `Locator`. This change is quite major, but it happened under hood, so should not affect your code. (#3738) - by @KobeNguyenT +- Move from `ElementHandle` to `Locator`. This change is quite major, but it happened under hood, so should not affect your code. (#3738) - by @KobeNguyenT ## 3.5.3 🛩ī¸ Features -* [Playwright] Added commands to check network traffic #3748 - by @ngraf @KobeNguyenT - * `startRecordingTraffic` - * `grabRecordedNetworkTraffics` - * `blockTraffic` - * `mockTraffic` - * `flushNetworkTraffics` - * `stopRecordingTraffic` - * `seeTraffic` - * `grabTrafficUrl` - * `dontSeeTraffic` +- [Playwright] Added commands to check network traffic #3748 - by @ngraf @KobeNguyenT + - `startRecordingTraffic` + - `grabRecordedNetworkTraffics` + - `blockTraffic` + - `mockTraffic` + - `flushNetworkTraffics` + - `stopRecordingTraffic` + - `seeTraffic` + - `grabTrafficUrl` + - `dontSeeTraffic` Examples: ```js // recording traffics and verify the traffic - await I.startRecordingTraffic(); - I.amOnPage('https://codecept.io/'); - await I.seeTraffic({ name: 'traffics', url: 'https://codecept.io/img/companies/BC_LogoScreen_C.jpg' }); +await I.startRecordingTraffic() +I.amOnPage('https://codecept.io/') +await I.seeTraffic({ name: 'traffics', url: 'https://codecept.io/img/companies/BC_LogoScreen_C.jpg' }) ``` ```js // block the traffic - I.blockTraffic('https://reqres.in/api/comments/*'); - await I.amOnPage('/form/fetch_call'); - await I.startRecordingTraffic(); - await I.click('GET COMMENTS'); - await I.see('Can not load data!'); +I.blockTraffic('https://reqres.in/api/comments/*') +await I.amOnPage('/form/fetch_call') +await I.startRecordingTraffic() +await I.click('GET COMMENTS') +await I.see('Can not load data!') ``` ```js // check the traffic with advanced params - I.amOnPage('https://openai.com/blog/chatgpt'); - await I.startRecordingTraffic(); - await I.seeTraffic({ - name: 'sentry event', - url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600', - parameters: { - width: '1919', - height: '1138', - }, - }); +I.amOnPage('https://openai.com/blog/chatgpt') +await I.startRecordingTraffic() +await I.seeTraffic({ + name: 'sentry event', + url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600', + parameters: { + width: '1919', + height: '1138', + }, +}) ``` 🐛 Bugfix -* [retryStepPlugin] Fix retry step when using global retry #3768 - by @KobeNguyenT +- [retryStepPlugin] Fix retry step when using global retry #3768 - by @KobeNguyenT 🗑 Deprecated -* Nightmare and Protractor helpers have been deprecated +- Nightmare and Protractor helpers have been deprecated ## 3.5.2 🐛 Bug Fixes -* [Playwright] reverted `clearField` to previous implementation -* [OpenAI] fixed running helper in pause mode. #3755 by @KobeNguyenT +- [Playwright] reverted `clearField` to previous implementation +- [OpenAI] fixed running helper in pause mode. #3755 by @KobeNguyenT ## 3.5.1 🛩ī¸ Features -* [Puppeteer][WebDriver][TestCafe] Added methods by @KobeNguyenT in #3737 - * `blur` - * `focus` -* Improved BDD output to print steps without `I.` commands` by @davertmik #3739 -* Improved `codecept init` setup for Electron tests by @KobeNguyenT. See #3733 +- [Puppeteer][WebDriver][TestCafe] Added methods by @KobeNguyenT in #3737 + - `blur` + - `focus` +- Improved BDD output to print steps without `I.` commands` by @davertmik #3739 +- Improved `codecept init` setup for Electron tests by @KobeNguyenT. See #3733 🐛 Bug Fixes -* Fixed serializing of custom errors making tests stuck. Fix #3739 by @davertmik. +- Fixed serializing of custom errors making tests stuck. Fix #3739 by @davertmik. 📖 Documentation -* Fixed Playwright docs by @Horsty80 -* Fixed ai docs by @ngraf -* Various fixes by @KobeNguyenT +- Fixed Playwright docs by @Horsty80 +- Fixed ai docs by @ngraf +- Various fixes by @KobeNguyenT ## 3.5.0 🛩ī¸ Features - **đŸĒ„ [AI Powered Test Automation](/ai)** - use OpenAI as a copilot for test automation. #3713 By @davertmik -![](https://user-images.githubusercontent.com/220264/250418764-c382709a-3ccb-4eb5-b6bc-538f3b3b3d35.png) - * [AI guide](/ai) added - * added support for OpenAI in `pause()` - * added [`heal` plugin](/plugins#heal) for self-healing tests - * added [`OpenAI`](/helpers/openai) helper + ![](https://user-images.githubusercontent.com/220264/250418764-c382709a-3ccb-4eb5-b6bc-538f3b3b3d35.png) + - [AI guide](/ai) added + - added support for OpenAI in `pause()` + - added [`heal` plugin](/plugins#heal) for self-healing tests + - added [`OpenAI`](/helpers/openai) helper - [Playwright][Puppeteer][WebDriver] Highlight the interacting elements in debug mode or with `highlightElement` option set (#3672) - by @KobeNguyenT ![](https://user-images.githubusercontent.com/220264/250415226-a7620418-56a4-4837-b790-b15e91e5d1f0.png) - [Playwright] Support for APIs in Playwright (#3665) - by Egor Bodnar - * `clearField` replaced to use new Playwright API - * `blur` added - * `focus` added + + - `clearField` replaced to use new Playwright API + - `blur` added + - `focus` added - **[Added support for multiple browsers](/parallel#Parallel-Execution-by-Workers-on-Multiple-Browsers)** in `run-workers` (#3606) by @karanshah-browserstack : @@ -1628,8 +2133,9 @@ exports.config = { browser: "chrome", } ] - }, + }, ``` + And executed via `run-workers` with `all` argument ``` @@ -1650,34 +2156,34 @@ npx codeceptjs run-workers 2 all - Fixed global retry #3667 by @KobeNguyenT - Fixed creating JavaScript test using "codeceptjs gt" (#3611) - by Jaromir Obr - ## 3.4.1 -* Updated mocha to v 10.2. Fixes #3591 -* Fixes executing a faling Before hook. Resolves #3592 +- Updated mocha to v 10.2. Fixes #3591 +- Fixes executing a faling Before hook. Resolves #3592 ## 3.4.0 -* **Updated to latest mocha and modern Cucumber** -* **Allure plugin moved to [@codeceptjs/allure-legacy](https://github.com/codeceptjs/allure-legacy) package**. This happened because allure-commons package v1 was not updated and caused vulnarabilities. Fixes #3422. We don't plan to maintain allure v2 plugin so it's up to community to take this initiative. Current allure plugin will print a warning message without interfering the run, so it won't accidentally fail your builds. -* Added ability to **[retry Before](https://codecept.io/basics/#retry-before), BeforeSuite, After, AfterSuite** hooks by @davertmik: +- **Updated to latest mocha and modern Cucumber** +- **Allure plugin moved to [@codeceptjs/allure-legacy](https://github.com/codeceptjs/allure-legacy) package**. This happened because allure-commons package v1 was not updated and caused vulnarabilities. Fixes #3422. We don't plan to maintain allure v2 plugin so it's up to community to take this initiative. Current allure plugin will print a warning message without interfering the run, so it won't accidentally fail your builds. +- Added ability to **[retry Before](https://codecept.io/basics/#retry-before), BeforeSuite, After, AfterSuite** hooks by @davertmik: + ```js Feature('flaky Before & BeforeSuite', { retryBefore: 2, retryBeforeSuite: 3 }) ``` -* **Flexible [retries configuration](https://codecept.io/basics/#retry-configuration) introduced** by @davertmik: +- **Flexible [retries configuration](https://codecept.io/basics/#retry-configuration) introduced** by @davertmik: ```js retry: [ { // enable this config only for flaky tests - grep: '@flaky', + grep: '@flaky', Before: 3 // retry Before 3 times Scenario: 3 // retry Scenario 3 times - }, + }, { // retry less when running slow tests - grep: '@slow' + grep: '@slow' Scenario: 1 Before: 1 }, { @@ -1686,91 +2192,92 @@ retry: [ } ] ``` -* **Flexible [timeout configuration](https://codecept.io/advanced/#timeout-configuration)** introduced by @davertmik: + +- **Flexible [timeout configuration](https://codecept.io/advanced/#timeout-configuration)** introduced by @davertmik: ```js timeout: [ - 10, // default timeout is 10secs - { // but increase timeout for slow tests + 10, // default timeout is 10secs + { + // but increase timeout for slow tests grep: '@slow', - Feature: 50 + Feature: 50, }, ] ``` -* JsDoc: Removed promise from `I.say`. See #3535 by @danielrentz -* [Playwright] `handleDownloads` requires now a filename param. See #3511 by @PeterNgTr -* [WebDriver] Added support for v8, removed support for webdriverio v5 and lower. See #3578 by @PeterNgTr - +- JsDoc: Removed promise from `I.say`. See #3535 by @danielrentz +- [Playwright] `handleDownloads` requires now a filename param. See #3511 by @PeterNgTr +- [WebDriver] Added support for v8, removed support for webdriverio v5 and lower. See #3578 by @PeterNgTr ## 3.3.7 🛩ī¸ Features -* **Promise-based typings** for TypeScript definitions in #3465 by @nlespiaucq. If you use TypeScript or use linters [check how it may be useful to you](https://bit.ly/3XIMq6n). -* **Translation** improved to use [custom vocabulary](https://codecept.io/translation/). -* [Playwright] Added methods in #3398 by @mirao - * `restartBrowser` - to restart a browser (with different config) - * `_createContextPage` - to create a new browser context with a page from a helper -* Added [Cucumber custom types](/bdd#custom-types) for BDD in #3435 by @Likstern -* Propose using JSONResponse helper when initializing project for API testing. #3455 by @PeterNgTr -* When translation enabled, generate tests using localized aliases. By @davertmik -* [Appium] Added `checkIfAppIsInstalled` in #3507 by @PeterNgTr +- **Promise-based typings** for TypeScript definitions in #3465 by @nlespiaucq. If you use TypeScript or use linters [check how it may be useful to you](https://bit.ly/3XIMq6n). +- **Translation** improved to use [custom vocabulary](https://codecept.io/translation/). +- [Playwright] Added methods in #3398 by @mirao + - `restartBrowser` - to restart a browser (with different config) + - `_createContextPage` - to create a new browser context with a page from a helper +- Added [Cucumber custom types](/bdd#custom-types) for BDD in #3435 by @Likstern +- Propose using JSONResponse helper when initializing project for API testing. #3455 by @PeterNgTr +- When translation enabled, generate tests using localized aliases. By @davertmik +- [Appium] Added `checkIfAppIsInstalled` in #3507 by @PeterNgTr 🐛 Bugfixes -* Fixed #3462 `TypeError: Cannot read properties of undefined (reading 'setStatus')` by @dwentland24 in #3438 -* Fixed creating steps file for TypeScript setup #3459 by @PeterNgTr -* Fixed issue of after all event in `run-rerun` command after complete execution #3464 by @jain-neeeraj -* [Playwright][WebDriver][Appium] Do not change `waitForTimeout` value on validation. See #3478 by @pmajewski24. Fixes #2589 -* [Playwright][WebDriver][Protractor][Puppeteer][TestCafe] Fixes `Element "{null: undefined}" was not found` and `element ([object Object]) still not present` messages when using object locators. See #3501 and #3502 by @pmajewski24 -* [Playwright] Improved file names when downloading file in #3449 by @PeterNgTr. Fixes #3412 and #3409 -* Add default value to `profile` env variable. See #3443 by @dwentland24. Resolves #3339 -* [Playwright] Using system-native path separator when saving artifacts in #3460 by @PeterNgTr -* [Playwright] Saving videos and traces from multiple sessions in #3505 by @davertmik -* [Playwright] Fixed `amOnPage` to navigate to `about:blank` by @zaxoavoki in #3470 Fixes #2311 -* Various typing improvements by @AWolf81 @PeterNgTr @mirao +- Fixed #3462 `TypeError: Cannot read properties of undefined (reading 'setStatus')` by @dwentland24 in #3438 +- Fixed creating steps file for TypeScript setup #3459 by @PeterNgTr +- Fixed issue of after all event in `run-rerun` command after complete execution #3464 by @jain-neeeraj +- [Playwright][WebDriver][Appium] Do not change `waitForTimeout` value on validation. See #3478 by @pmajewski24. Fixes #2589 +- [Playwright][WebDriver][Protractor][Puppeteer][TestCafe] Fixes `Element "{null: undefined}" was not found` and `element ([object Object]) still not present` messages when using object locators. See #3501 and #3502 by @pmajewski24 +- [Playwright] Improved file names when downloading file in #3449 by @PeterNgTr. Fixes #3412 and #3409 +- Add default value to `profile` env variable. See #3443 by @dwentland24. Resolves #3339 +- [Playwright] Using system-native path separator when saving artifacts in #3460 by @PeterNgTr +- [Playwright] Saving videos and traces from multiple sessions in #3505 by @davertmik +- [Playwright] Fixed `amOnPage` to navigate to `about:blank` by @zaxoavoki in #3470 Fixes #2311 +- Various typing improvements by @AWolf81 @PeterNgTr @mirao 📖 Documentation -* Updated [Quickstart](https://codecept.io/quickstart/) with detailed explanation of questions in init -* Added [Translation](/translation/) guide -* Updated [TypeScript](https://bit.ly/3XIMq6n) guide for promise-based typings -* Reordered guides list on a website +- Updated [Quickstart](https://codecept.io/quickstart/) with detailed explanation of questions in init +- Added [Translation](/translation/) guide +- Updated [TypeScript](https://bit.ly/3XIMq6n) guide for promise-based typings +- Reordered guides list on a website ## 3.3.6 -* [`run-rerun`](https://codecept.io/commands/#run-rerun) command was re-introduced by @dwentland24 in #3436. Use it to perform run multiple times and detect flaky tests -* Enabled `retryFailedStep` by default in `@codeceptjs/configure` v 0.10. See https://github.com/codeceptjs/configure/pull/26 -* [Playwright] Fixed properties types "waitForNavigation" and "firefox" by @mirao in #3401 -* [REST] Changed "endpoint" to optional by @mirao in #3404 -* [REST] Use [`secret`](/secrets) for form encoded string by @PeterNgTr: +- [`run-rerun`](https://codecept.io/commands/#run-rerun) command was re-introduced by @dwentland24 in #3436. Use it to perform run multiple times and detect flaky tests +- Enabled `retryFailedStep` by default in `@codeceptjs/configure` v 0.10. See https://github.com/codeceptjs/configure/pull/26 +- [Playwright] Fixed properties types "waitForNavigation" and "firefox" by @mirao in #3401 +- [REST] Changed "endpoint" to optional by @mirao in #3404 +- [REST] Use [`secret`](/secrets) for form encoded string by @PeterNgTr: ```js -const secretData = secret('name=john&password=123456'); -const response = await I.sendPostRequest('/user', secretData); -``` - -* [Playwright]Fixed docs related to fixed properties types "waitForNavigation" and "firefox" by @mirao in #3407 -* [Playwright]Fixed parameters of startActivity() by @mirao in #3408 -* Move semver to prod dependencies by @timja in #3413 -* check if browser is W3C instead of Android by @mikk150 in #3414 -* Pass service configs with options and caps as array for browsersâ€Ļ by @07souravkunda in #3418 -* fix for type of "webdriver.port" by @ngraf in #3421 -* fix for type of "webdriver.smartWait" by @pmajewski24 in #3426 -* fix(datatable): mask secret text by @PeterNgTr in #3432 -* fix(playwright) - video name and missing type by @PeterNgTr in #3430 -* fix for expected type of "bootstrap", "teardown", "bootstrapAll" and "teardownAll" by @ngraf in #3424 -* Improve generate pageobject `gpo` command to work with TypeScript by @PeterNgTr in #3411 -* Fixed dry-run to always return 0 code and exit -* Added minimal version notice for NodeJS >= 12 -* fix(utils): remove . of test title to avoid confusion by @PeterNgTr in #3431 +const secretData = secret('name=john&password=123456') +const response = await I.sendPostRequest('/user', secretData) +``` + +- [Playwright]Fixed docs related to fixed properties types "waitForNavigation" and "firefox" by @mirao in #3407 +- [Playwright]Fixed parameters of startActivity() by @mirao in #3408 +- Move semver to prod dependencies by @timja in #3413 +- check if browser is W3C instead of Android by @mikk150 in #3414 +- Pass service configs with options and caps as array for browsersâ€Ļ by @07souravkunda in #3418 +- fix for type of "webdriver.port" by @ngraf in #3421 +- fix for type of "webdriver.smartWait" by @pmajewski24 in #3426 +- fix(datatable): mask secret text by @PeterNgTr in #3432 +- fix(playwright) - video name and missing type by @PeterNgTr in #3430 +- fix for expected type of "bootstrap", "teardown", "bootstrapAll" and "teardownAll" by @ngraf in #3424 +- Improve generate pageobject `gpo` command to work with TypeScript by @PeterNgTr in #3411 +- Fixed dry-run to always return 0 code and exit +- Added minimal version notice for NodeJS >= 12 +- fix(utils): remove . of test title to avoid confusion by @PeterNgTr in #3431 ## 3.3.5 🛩ī¸ Features -* Added **TypeScript types for CodeceptJS config**. +- Added **TypeScript types for CodeceptJS config**. Update `codecept.conf.js` to get intellisense when writing config file: @@ -1780,42 +2287,41 @@ exports.config = { //... } ``` -* Added TS types for helpers config: - * Playwright - * Puppeteer - * WebDriver - * REST -* Added **[TypeScript option](/typescript)** for installation via `codeceptjs init` to initialize new projects in TS (by @PeterNgTr and @davertmik) -* Includes `node-ts` automatically when using TypeScript setup. +- Added TS types for helpers config: + - Playwright + - Puppeteer + - WebDriver + - REST +- Added **[TypeScript option](/typescript)** for installation via `codeceptjs init` to initialize new projects in TS (by @PeterNgTr and @davertmik) +- Includes `node-ts` automatically when using TypeScript setup. 🐛 Bugfixes -* [Puppeteer] Fixed support for Puppeteer > 14.4 by @PeterNgTr -* Don't report files as existing when non-directory is in path by @jonathanperret. See #3374 -* Fixed TS type for `secret` function by @PeterNgTr -* Fixed wrong order for async MetaSteps by @dwentland24. See #3393 -* Fixed same param substitution in BDD step. See #3385 by @snehabhandge +- [Puppeteer] Fixed support for Puppeteer > 14.4 by @PeterNgTr +- Don't report files as existing when non-directory is in path by @jonathanperret. See #3374 +- Fixed TS type for `secret` function by @PeterNgTr +- Fixed wrong order for async MetaSteps by @dwentland24. See #3393 +- Fixed same param substitution in BDD step. See #3385 by @snehabhandge 📖 Documentation -* Updated [configuration options](https://codecept.io/configuration/) to match TypeScript types -* Updated [TypeScript documentation](https://codecept.io/typescript/) on simplifying TS installation -* Added codecept-tesults plugin documentation by @ajeetd - - +- Updated [configuration options](https://codecept.io/configuration/) to match TypeScript types +- Updated [TypeScript documentation](https://codecept.io/typescript/) on simplifying TS installation +- Added codecept-tesults plugin documentation by @ajeetd ## 3.3.4 -* Added support for masking fields in objects via `secret` function: +- Added support for masking fields in objects via `secret` function: ```js -I.sendPostRequest('/auth', secret({ name: 'jon', password: '123456' }, 'password')); +I.sendPostRequest('/auth', secret({ name: 'jon', password: '123456' }, 'password')) ``` -* Added [a guide about using of `secret`](/secrets) function -* [Appium] Use `touchClick` when interacting with elements in iOS. See #3317 by @mikk150 -* [Playwright] Added `cdpConnection` option to connect over CDP. See #3309 by @Hmihaly -* [customLocator plugin] Allowed to specify multiple attributes for custom locator. Thanks to @aruiz-caritsqa + +- Added [a guide about using of `secret`](/secrets) function +- [Appium] Use `touchClick` when interacting with elements in iOS. See #3317 by @mikk150 +- [Playwright] Added `cdpConnection` option to connect over CDP. See #3309 by @Hmihaly +- [customLocator plugin] Allowed to specify multiple attributes for custom locator. Thanks to @aruiz-caritsqa ```js plugins: { @@ -1826,10 +2332,11 @@ plugins: { } } ``` -* [retryTo plugin] Fixed #3147 using `pollInterval` option. See #3351 by @cyonkee -* [Playwright] Fixed grabbing of browser console messages and window resize in new tab. Thanks to @mirao -* [REST] Added `prettyPrintJson` option to print JSON in nice way by @PeterNgTr -* [JSONResponse] Updated response validation to iterate over array items if response is array. Thanks to @PeterNgTr + +- [retryTo plugin] Fixed #3147 using `pollInterval` option. See #3351 by @cyonkee +- [Playwright] Fixed grabbing of browser console messages and window resize in new tab. Thanks to @mirao +- [REST] Added `prettyPrintJson` option to print JSON in nice way by @PeterNgTr +- [JSONResponse] Updated response validation to iterate over array items if response is array. Thanks to @PeterNgTr ```js // response.data == [ @@ -1837,37 +2344,36 @@ plugins: { // { user: { name: 'matt', email: 'matt@doe.com' } }, //] -I.seeResponseContainsKeys(['user']); -I.seeResponseContainsJson({ user: { email: 'jon@doe.com' } }); -I.seeResponseContainsJson({ user: { email: 'matt@doe.com' } }); -I.dontSeeResponseContainsJson({ user: 2 }); +I.seeResponseContainsKeys(['user']) +I.seeResponseContainsJson({ user: { email: 'jon@doe.com' } }) +I.seeResponseContainsJson({ user: { email: 'matt@doe.com' } }) +I.dontSeeResponseContainsJson({ user: 2 }) ``` ## 3.3.3 -* Fixed `DataCloneError: () => could not be cloned` when running data tests in run-workers -* đŸ‡ēđŸ‡Ļ Added #StandWithUkraine notice to CLI - +- Fixed `DataCloneError: () => could not be cloned` when running data tests in run-workers +- đŸ‡ēđŸ‡Ļ Added #StandWithUkraine notice to CLI ## 3.3.2 -* [REST] Fixed override of headers/token in `haveRequestHeaders()` and `amBearerAuthenticated()`. See #3304 by @mirao -* Reverted typings change introduced in #3245. [More details on this](https://twitter.com/CodeceptJS/status/1519725963856207873) +- [REST] Fixed override of headers/token in `haveRequestHeaders()` and `amBearerAuthenticated()`. See #3304 by @mirao +- Reverted typings change introduced in #3245. [More details on this](https://twitter.com/CodeceptJS/status/1519725963856207873) ## 3.3.1 🛩ī¸ Features: -* Add option to avoid duplicate gherkin step definitions (#3257) - @raywiis -* Added `step.*` for run-workers #3272. Thanks to @abhimanyupandian -* Fixed loading tests for `codecept run` using glob patterns. By @jayudey-wf +- Add option to avoid duplicate gherkin step definitions (#3257) - @raywiis +- Added `step.*` for run-workers #3272. Thanks to @abhimanyupandian +- Fixed loading tests for `codecept run` using glob patterns. By @jayudey-wf ``` npx codeceptjs run test-dir/*" ``` -* [Playwright] **Possible breaking change.** By default `timeout` is changed to 5000ms. The value set in 3.3.0 was too low. Please set `timeout` explicitly to not depend on release values. -* [Playwright] Added for color scheme option by @PeterNgTr +- [Playwright] **Possible breaking change.** By default `timeout` is changed to 5000ms. The value set in 3.3.0 was too low. Please set `timeout` explicitly to not depend on release values. +- [Playwright] Added for color scheme option by @PeterNgTr ```js helpers: { @@ -1878,40 +2384,39 @@ npx codeceptjs run test-dir/*" } ``` - 🐛 Bugfixes: -* [Playwright] Fixed `Cannot read property 'video' of undefined` -* Fixed haveRequestHeaders() and amBearerAuthenticated() of REST helper (#3260) - @mirao -* Fixed: allure attachment fails if screenshot failed #3298 by @ruudvanderweijde -* Fixed #3105 using autoLogin() plugin with TypeScript. Fix #3290 by @PeterNgTr -* [Playwright] Added extra params for click and dragAndDrop to type definitions by @mirao - +- [Playwright] Fixed `Cannot read property 'video' of undefined` +- Fixed haveRequestHeaders() and amBearerAuthenticated() of REST helper (#3260) - @mirao +- Fixed: allure attachment fails if screenshot failed #3298 by @ruudvanderweijde +- Fixed #3105 using autoLogin() plugin with TypeScript. Fix #3290 by @PeterNgTr +- [Playwright] Added extra params for click and dragAndDrop to type definitions by @mirao 📖 Documentation -* Improving the typings in many places -* Improving the return type of helpers for TS users (#3245) - @nlespiaucq + +- Improving the typings in many places +- Improving the return type of helpers for TS users (#3245) - @nlespiaucq ## 3.3.0 🛩ī¸ Features: -* [**API Testing introduced**](/api) - * Introduced [`JSONResponse`](/helpers/JSONResponse) helper which connects to REST, GraphQL or Playwright helper - * [REST] Added `amBearerAuthenticated` method - * [REST] Added `haveRequestHeaders` method - * Added dependency on `joi` and `chai` -* [Playwright] Added `timeout` option to set [timeout](https://playwright.dev/docs/api/class-page#page-set-default-timeout) for all Playwright actions. If an action fails, Playwright keeps retrying it for a time set by timeout. -* [Playwright] **Possible breaking change.** By default `timeout` is set to 1000ms. *Previous default was set by Playwright internally to 30s. This was causing contradiction to CodeceptJS retries, so triggered up to 3 retries for 30s of time. This timeout option was lowered so retryFailedStep plugin would not cause long delays.* -* [Playwright] Updated `restart` config option to include 3 restart strategies: - * 'context' or **false** - restarts [browser context](https://playwright.dev/docs/api/class-browsercontext) but keeps running browser. Recommended by Playwright team to keep tests isolated. - * 'browser' or **true** - closes browser and opens it again between tests. - * 'session' or 'keep' - keeps browser context and session, but cleans up cookies and localStorage between tests. The fastest option when running tests in windowed mode. Works with `keepCookies` and `keepBrowserState` options. This behavior was default prior CodeceptJS 3.1 -* [Playwright] Extended methods to provide more options from engine. These methods were updated so additional options can be be passed as the last argument: - * [`click`](/helpers/Playwright#click) - * [`dragAndDrop`](/helpers/Playwright#dragAndDrop) - * [`checkOption`](/helpers/Playwright#checkOption) - * [`uncheckOption`](/helpers/Playwright#uncheckOption) +- [**API Testing introduced**](/api) + - Introduced [`JSONResponse`](/helpers/JSONResponse) helper which connects to REST, GraphQL or Playwright helper + - [REST] Added `amBearerAuthenticated` method + - [REST] Added `haveRequestHeaders` method + - Added dependency on `joi` and `chai` +- [Playwright] Added `timeout` option to set [timeout](https://playwright.dev/docs/api/class-page#page-set-default-timeout) for all Playwright actions. If an action fails, Playwright keeps retrying it for a time set by timeout. +- [Playwright] **Possible breaking change.** By default `timeout` is set to 1000ms. _Previous default was set by Playwright internally to 30s. This was causing contradiction to CodeceptJS retries, so triggered up to 3 retries for 30s of time. This timeout option was lowered so retryFailedStep plugin would not cause long delays._ +- [Playwright] Updated `restart` config option to include 3 restart strategies: + - 'context' or **false** - restarts [browser context](https://playwright.dev/docs/api/class-browsercontext) but keeps running browser. Recommended by Playwright team to keep tests isolated. + - 'browser' or **true** - closes browser and opens it again between tests. + - 'session' or 'keep' - keeps browser context and session, but cleans up cookies and localStorage between tests. The fastest option when running tests in windowed mode. Works with `keepCookies` and `keepBrowserState` options. This behavior was default prior CodeceptJS 3.1 +- [Playwright] Extended methods to provide more options from engine. These methods were updated so additional options can be be passed as the last argument: + - [`click`](/helpers/Playwright#click) + - [`dragAndDrop`](/helpers/Playwright#dragAndDrop) + - [`checkOption`](/helpers/Playwright#checkOption) + - [`uncheckOption`](/helpers/Playwright#uncheckOption) ```js // use Playwright click options as 3rd argument @@ -1920,83 +2425,85 @@ I.click('canvas', '.model', { position: { x: 20, y: 40 } }) I.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } }) ``` -* `eachElement` plugin introduced. It allows you to iterate over elements and perform some action on them using direct engines API +- `eachElement` plugin introduced. It allows you to iterate over elements and perform some action on them using direct engines API ```js await eachElement('click all links in .list', '.list a', (el) => { await el.click(); }) ``` -* [Playwright] Added support to `playwright-core` package if `playwright` is not installed. See #3190, fixes #2663. -* [Playwright] Added `makeApiRequest` action to perform API requests. Requires Playwright >= 1.18 -* Added support to `codecept.config.js` for name consistency across other JS tools. See motivation at #3195 by @JiLiZART -* [ApiDataFactory] Added options arg to `have` method. See #3197 by @JJlokidoki -* Improved pt-br translations to include keywords: 'Funcionalidade', 'CenÃĄrio', 'Antes', 'Depois', 'AntesDaSuite', 'DepoisDaSuite'. See #3206 by @danilolutz -* [allure plugin] Introduced `addStep` method to add comments and attachments. See #3104 by @EgorBodnar + +- [Playwright] Added support to `playwright-core` package if `playwright` is not installed. See #3190, fixes #2663. +- [Playwright] Added `makeApiRequest` action to perform API requests. Requires Playwright >= 1.18 +- Added support to `codecept.config.js` for name consistency across other JS tools. See motivation at #3195 by @JiLiZART +- [ApiDataFactory] Added options arg to `have` method. See #3197 by @JJlokidoki +- Improved pt-br translations to include keywords: 'Funcionalidade', 'CenÃĄrio', 'Antes', 'Depois', 'AntesDaSuite', 'DepoisDaSuite'. See #3206 by @danilolutz +- [allure plugin] Introduced `addStep` method to add comments and attachments. See #3104 by @EgorBodnar 🐛 Bugfixes: -* Fixed #3212: using Regex flags for Cucumber steps. See #3214 by @anils92 +- Fixed #3212: using Regex flags for Cucumber steps. See #3214 by @anils92 📖 Documentation -* Added [Testomat.io reporter](/reports#testomatio) -* Added [api testing](/api) guides -* Added [internal api](/internal-api) guides -* [Appium] Fixed documentation for `performSwipe` -* [Playwright] update docs for `usePlaywrightTo` method by @dbudzins +- Added [Testomat.io reporter](/reports#testomatio) +- Added [api testing](/api) guides +- Added [internal api](/internal-api) guides +- [Appium] Fixed documentation for `performSwipe` +- [Playwright] update docs for `usePlaywrightTo` method by @dbudzins ## 3.2.3 -* Documentation improvements by @maojunxyz -* Guard mocha cli reporter from registering step logger multiple times #3180 by @nikocanvacom -* [Playwright] Fixed "tracing.stop: tracing.stop: ENAMETOOLONG: name too long" by @hatufacci -* Fixed #2889: return always the same error contract from simplifyTest. See #3168 by @andremoah +- Documentation improvements by @maojunxyz +- Guard mocha cli reporter from registering step logger multiple times #3180 by @nikocanvacom +- [Playwright] Fixed "tracing.stop: tracing.stop: ENAMETOOLONG: name too long" by @hatufacci +- Fixed #2889: return always the same error contract from simplifyTest. See #3168 by @andremoah ## 3.2.2 -* [Playwright] Reverted removal of retry on context errors. Fixes #3130 -* Timeout improvements by @nikocanvacom: - * Added priorites to timeouts - * Added `overrideStepLimits` to [stepTimeout plugin](https://codecept.io/plugins/#steptimeout) to override steps timeouts set by `limitTime`. - * Fixed step timeout not working due to override by NaN by test timeout #3126 -* [Appium] Fixed logging error when `manualStart` is true. See #3140 by @nikocanvacom - +- [Playwright] Reverted removal of retry on context errors. Fixes #3130 +- Timeout improvements by @nikocanvacom: + - Added priorites to timeouts + - Added `overrideStepLimits` to [stepTimeout plugin](https://codecept.io/plugins/#steptimeout) to override steps timeouts set by `limitTime`. + - Fixed step timeout not working due to override by NaN by test timeout #3126 +- [Appium] Fixed logging error when `manualStart` is true. See #3140 by @nikocanvacom ## 3.2.1 > â™ģī¸ This release fixes hanging of tests by reducing timeouts for automatic retries on failures. -* [retryFailedStep plugin] **New Defaults**: retries steps up to 3 times with factor of 1.5 (previously 5 with factor 2) -* [Playwright] - disabled retry on failed context actions (not needed anymore) -* [Puppeteer] - reduced retries on context failures to 3 times. -* [Playwright] Handling `crash` event to automatically close crashed pages. +- [retryFailedStep plugin] **New Defaults**: retries steps up to 3 times with factor of 1.5 (previously 5 with factor 2) +- [Playwright] - disabled retry on failed context actions (not needed anymore) +- [Puppeteer] - reduced retries on context failures to 3 times. +- [Playwright] Handling `crash` event to automatically close crashed pages. ## 3.2.0 🛩ī¸ Features: **[Timeouts](https://codecept.io/advanced/#timeout) implemented** - * global timeouts (via `timeout` config option). - * _Breaking change:_ timeout option expects **timeout in seconds**, not in milliseconds as it was previously. - * test timeouts (via `Scenario` and `Feature` options) - * _Breaking change:_ `Feature().timeout()` and `Scenario().timeout()` calls has no effect and are deprecated + +- global timeouts (via `timeout` config option). + - _Breaking change:_ timeout option expects **timeout in seconds**, not in milliseconds as it was previously. +- test timeouts (via `Scenario` and `Feature` options) + - _Breaking change:_ `Feature().timeout()` and `Scenario().timeout()` calls has no effect and are deprecated ```js // set timeout for every test in suite to 10 secs -Feature('tests with timeout', { timeout: 10 }); +Feature('tests with timeout', { timeout: 10 }) // set timeout for this test to 20 secs -Scenario('a test with timeout', { timeout: 20 }, ({ I }) => {}); -``` +Scenario('a test with timeout', { timeout: 20 }, ({ I }) => {}) +``` - * step timeouts (See #3059 by @nikocanvacom) +- step timeouts (See #3059 by @nikocanvacom) ```js // set step timeout to 5 secs -I.limitTime(5).click('Link'); -``` - * `stepTimeout` plugin introduced to automatically add timeouts for each step (#3059 by @nikocanvacom). +I.limitTime(5).click('Link') +``` + +- `stepTimeout` plugin introduced to automatically add timeouts for each step (#3059 by @nikocanvacom). [**retryTo**](/plugins/#retryto) plugin introduced to rerun a set of steps on failure: @@ -2004,150 +2511,149 @@ I.limitTime(5).click('Link'); // editing in text in iframe // if iframe was not loaded - retry 5 times await retryTo(() => { - I.switchTo('#editor frame'); - I.fillField('textarea', 'value'); -}, 5); + I.switchTo('#editor frame') + I.fillField('textarea', 'value') +}, 5) ``` -* [Playwright] added `locale` configuration -* [WebDriver] upgraded to webdriverio v7 +- [Playwright] added `locale` configuration +- [WebDriver] upgraded to webdriverio v7 🐛 Bugfixes: -* Fixed allure plugin "Unexpected endStep()" error in #3098 by @abhimanyupandian -* [Puppeteer] always close remote browser on test end. See #3054 by @mattonem -* stepbyStepReport Plugin: Disabled screenshots after test has failed. See #3119 by @ioannisChalkias - +- Fixed allure plugin "Unexpected endStep()" error in #3098 by @abhimanyupandian +- [Puppeteer] always close remote browser on test end. See #3054 by @mattonem +- stepbyStepReport Plugin: Disabled screenshots after test has failed. See #3119 by @ioannisChalkias ## 3.1.3 🛩ī¸ Features: -* BDD Improvement. Added `DataTableArgument` class to work with table data structures. +- BDD Improvement. Added `DataTableArgument` class to work with table data structures. ```js const { DataTableArgument } = require('codeceptjs'); //... Given('I have an employee card', (table) => { const dataTableArgument = new DataTableArgument(table); - const hashes = dataTableArgument.hashes(); + const hashes = dataTableArgument.hashes(); // hashes = [{ name: 'Harry', surname: 'Potter', position: 'Seeker' }]; const rows = dataTableArgument.rows(); // rows = [['Harry', 'Potter', Seeker]]; } ``` + See updated [BDD section](https://codecept.io/bdd/) for more API options. Thanks to @EgorBodnar -* Support `cjs` file extensions for config file: `codecept.conf.cjs`. See #3052 by @kalvenschraut -* API updates: Added `test.file` and `suite.file` properties to `test` and `suite` objects to use in helpers and plugins. +- Support `cjs` file extensions for config file: `codecept.conf.cjs`. See #3052 by @kalvenschraut +- API updates: Added `test.file` and `suite.file` properties to `test` and `suite` objects to use in helpers and plugins. 🐛 Bugfixes: -* [Playwright] Fixed resetting `test.artifacts` for failing tests. See #3033 by @jancorvus. Fixes #3032 -* [Playwright] Apply `basicAuth` credentials to all opened browser contexts. See #3036 by @nikocanvacom. Fixes #3035 -* [WebDriver] Updated `webdriverio` default version to `^6.12.1`. See #3043 by @sridhareaswaran -* [Playwright] `I.haveRequestHeaders` affects all tabs. See #3049 by @jancorvus -* BDD: Fixed unhandled empty feature files. Fix #3046 by @abhimanyupandian -* Fixed `RangeError: Invalid string length` in `recorder.js` when running huge amount of tests. -* [Appium] Fixed definitions for `touchPerform`, `hideDeviceKeyboard`, `removeApp` by @mirao +- [Playwright] Fixed resetting `test.artifacts` for failing tests. See #3033 by @jancorvus. Fixes #3032 +- [Playwright] Apply `basicAuth` credentials to all opened browser contexts. See #3036 by @nikocanvacom. Fixes #3035 +- [WebDriver] Updated `webdriverio` default version to `^6.12.1`. See #3043 by @sridhareaswaran +- [Playwright] `I.haveRequestHeaders` affects all tabs. See #3049 by @jancorvus +- BDD: Fixed unhandled empty feature files. Fix #3046 by @abhimanyupandian +- Fixed `RangeError: Invalid string length` in `recorder.js` when running huge amount of tests. +- [Appium] Fixed definitions for `touchPerform`, `hideDeviceKeyboard`, `removeApp` by @mirao 📖 Documentation: -* Added Testrail reporter [Reports Docs](https://codecept.io/reports/#testrail) - +- Added Testrail reporter [Reports Docs](https://codecept.io/reports/#testrail) ## 3.1.2 🛩ī¸ Features: -* Added `coverage` plugin to generate code coverage for Playwright & Puppeteer. By @anirudh-modi -* Added `subtitle` plugin to generate subtitles for videos recorded with Playwright. By @anirudh-modi -* Configuration: `config.tests` to accept array of file patterns. See #2994 by @monsteramba +- Added `coverage` plugin to generate code coverage for Playwright & Puppeteer. By @anirudh-modi +- Added `subtitle` plugin to generate subtitles for videos recorded with Playwright. By @anirudh-modi +- Configuration: `config.tests` to accept array of file patterns. See #2994 by @monsteramba ```js exports.config = { - tests: ['./*_test.js','./sampleTest.js'], - // ... + tests: ['./*_test.js', './sampleTest.js'], + // ... } ``` -* Notification is shown for test files without `Feature()`. See #3011 by @PeterNgTr + +- Notification is shown for test files without `Feature()`. See #3011 by @PeterNgTr 🐛 Bugfixes: -* [Playwright] Fixed #2986 error is thrown when deleting a missing video. Fix by @hatufacci -* Fixed false positive result when invalid function is called in a helper. See #2997 by @abhimanyupandian -* [Appium] Removed full page mode for `saveScreenshot`. See #3002 by @nlespiaucq -* [Playwright] Fixed #3003 saving trace for a test with a long name. Fix by @hatufacci +- [Playwright] Fixed #2986 error is thrown when deleting a missing video. Fix by @hatufacci +- Fixed false positive result when invalid function is called in a helper. See #2997 by @abhimanyupandian +- [Appium] Removed full page mode for `saveScreenshot`. See #3002 by @nlespiaucq +- [Playwright] Fixed #3003 saving trace for a test with a long name. Fix by @hatufacci 🎱 Other: -* Deprecated `puppeteerCoverage` plugin in favor of `coverage` plugin. +- Deprecated `puppeteerCoverage` plugin in favor of `coverage` plugin. ## 3.1.1 -* [Appium] Fixed #2759 - `grabNumberOfVisibleElements`, `grabAttributeFrom`, `grabAttributeFromAll` to allow id locators. +- [Appium] Fixed #2759 + `grabNumberOfVisibleElements`, `grabAttributeFrom`, `grabAttributeFromAll` to allow id locators. ## 3.1.0 -* [Plawyright] Updated to Playwright 1.13 -* [Playwright] **Possible breaking change**: `BrowserContext` is initialized before each test and closed after. This behavior matches recommendation from Playwright team to use different contexts for tests. -* [Puppeteer] Updated to Puppeteer 10.2. -* [Protractor] Helper deprecated +- [Plawyright] Updated to Playwright 1.13 +- [Playwright] **Possible breaking change**: `BrowserContext` is initialized before each test and closed after. This behavior matches recommendation from Playwright team to use different contexts for tests. +- [Puppeteer] Updated to Puppeteer 10.2. +- [Protractor] Helper deprecated 🛩ī¸ Features: -* [Playwright] Added recording of [video](https://codecept.io/playwright/#video) and [traces](https://codecept.io/playwright/#trace) by @davertmik -* [Playwritght] [Mocking requests](https://codecept.io/playwright/#mocking-network-requests) implemented via `route` API of Playwright by @davertmik -* [Playwright] Added **support for [React locators](https://codecept.io/react/#locators)** in #2912 by @AAAstorga +- [Playwright] Added recording of [video](https://codecept.io/playwright/#video) and [traces](https://codecept.io/playwright/#trace) by @davertmik +- [Playwritght] [Mocking requests](https://codecept.io/playwright/#mocking-network-requests) implemented via `route` API of Playwright by @davertmik +- [Playwright] Added **support for [React locators](https://codecept.io/react/#locators)** in #2912 by @AAAstorga 🐛 Bugfixes: -* [Puppeteer] Fixed #2244 `els[0]._clickablePoint is not a function` by @karunandrii. -* [Puppeteer] Fixed `fillField` to check for invisible elements. See #2916 by @anne-open-xchange -* [Playwright] Reset of dialog event listener before registration of new one. #2946 by @nikocanvacom -* Fixed running Gherkin features with `run-multiple` using chunks. See #2900 by @andrenoberto -* Fixed #2937 broken typings for subfolders on Windows by @jancorvus -* Fixed issue where cucumberJsonReporter not working with fakerTransform plugin. See #2942 by @ilangv -* Fixed #2952 finished job with status code 0 when playwright cannot connect to remote wss url. By @davertmik - +- [Puppeteer] Fixed #2244 `els[0]._clickablePoint is not a function` by @karunandrii. +- [Puppeteer] Fixed `fillField` to check for invisible elements. See #2916 by @anne-open-xchange +- [Playwright] Reset of dialog event listener before registration of new one. #2946 by @nikocanvacom +- Fixed running Gherkin features with `run-multiple` using chunks. See #2900 by @andrenoberto +- Fixed #2937 broken typings for subfolders on Windows by @jancorvus +- Fixed issue where cucumberJsonReporter not working with fakerTransform plugin. See #2942 by @ilangv +- Fixed #2952 finished job with status code 0 when playwright cannot connect to remote wss url. By @davertmik ## 3.0.7 📖 Documentation fixes: -* Remove broken link from `Nightmare helper`. See #2860 by @Arhell -* Fixed broken links in `playwright.md`. See #2848 by @johnhoodjr -* Fix mocha-multi config example. See #2881 by @rimesc -* Fix small errors in email documentation file. See #2884 by @mkrtchian -* Improve documentation for `Sharing Data Between Workers` section. See #2891 by @ngraf +- Remove broken link from `Nightmare helper`. See #2860 by @Arhell +- Fixed broken links in `playwright.md`. See #2848 by @johnhoodjr +- Fix mocha-multi config example. See #2881 by @rimesc +- Fix small errors in email documentation file. See #2884 by @mkrtchian +- Improve documentation for `Sharing Data Between Workers` section. See #2891 by @ngraf 🛩ī¸ Features: -* [WebDriver] Shadow DOM Support for `Webdriver`. See #2741 by @gkushang -* [Release management] Introduce the versioning automatically, it follows the semantics versioning. See #2883 by @PeterNgTr -* Adding opts into `Scenario.skip` that it would be useful for building reports. See #2867 by @AlexKo4 -* Added support for attaching screenshots to [cucumberJsonReporter](https://github.com/ktryniszewski-mdsol/codeceptjs-cucumber-json-reporter) See #2888 by @fijijavis -* Supported config file for `codeceptjs shell` command. See #2895 by @PeterNgTr: +- [WebDriver] Shadow DOM Support for `Webdriver`. See #2741 by @gkushang +- [Release management] Introduce the versioning automatically, it follows the semantics versioning. See #2883 by @PeterNgTr +- Adding opts into `Scenario.skip` that it would be useful for building reports. See #2867 by @AlexKo4 +- Added support for attaching screenshots to [cucumberJsonReporter](https://github.com/ktryniszewski-mdsol/codeceptjs-cucumber-json-reporter) See #2888 by @fijijavis +- Supported config file for `codeceptjs shell` command. See #2895 by @PeterNgTr: ``` npx codeceptjs shell -c foo.conf.js ``` Bug fixes: -* [GraphQL] Use a helper-specific instance of Axios to avoid contaminating global defaults. See #2868 by @vanvoljg -* A default system color is used when passing non supported system color when using I.say(). See #2874 by @PeterNgTr -* [Playwright] Avoid the timout due to calling the click on invisible elements. See #2875 by cbayer97 +- [GraphQL] Use a helper-specific instance of Axios to avoid contaminating global defaults. See #2868 by @vanvoljg +- A default system color is used when passing non supported system color when using I.say(). See #2874 by @PeterNgTr +- [Playwright] Avoid the timout due to calling the click on invisible elements. See #2875 by cbayer97 ## 3.0.6 -* [Playwright] Added `electron` as a browser to config. See #2834 by @cbayer97 -* [Playwright] Implemented `launchPersistentContext` to be able to launch persistent remote browsers. See #2817 by @brunoqueiros. Fixes #2376. -* Fixed printing logs and stack traces for `run-workers`. See #2857 by @haveac1gar. Fixes #2621, #2852 -* Emit custom messages from worker to the main thread. See #2824 by @jccguimaraes -* Improved workers processes output. See #2804 by @drfiresign -* BDD. Added ability to use an array of feature files inside config in `gherkin.features`. See #2814 by @jbergeronjr +- [Playwright] Added `electron` as a browser to config. See #2834 by @cbayer97 +- [Playwright] Implemented `launchPersistentContext` to be able to launch persistent remote browsers. See #2817 by @brunoqueiros. Fixes #2376. +- Fixed printing logs and stack traces for `run-workers`. See #2857 by @haveac1gar. Fixes #2621, #2852 +- Emit custom messages from worker to the main thread. See #2824 by @jccguimaraes +- Improved workers processes output. See #2804 by @drfiresign +- BDD. Added ability to use an array of feature files inside config in `gherkin.features`. See #2814 by @jbergeronjr ```js "features": [ @@ -2155,8 +2661,9 @@ Bug fixes: "./features/api_features/*.feature" ], ``` -* Added `getQueueId` to reporter to rerun a specific promise. See #2837 by @jonatask -* **Added `fakerTransform` plugin** to use faker data in Gherkin scenarios. See #2854 by @adrielcodeco + +- Added `getQueueId` to reporter to rerun a specific promise. See #2837 by @jonatask +- **Added `fakerTransform` plugin** to use faker data in Gherkin scenarios. See #2854 by @adrielcodeco ```feature Scenario Outline: ... @@ -2168,119 +2675,123 @@ Scenario Outline: ... | productName | customer | email | anythingMore | | {{commerce.product}} | Dr. {{name.findName}} | {{internet.email}} | staticData | ``` -* [REST] Use class instance of axios, not the global instance, to avoid contaminating global configuration. #2846 by @vanvoljg -* [Appium] Added `tunnelIdentifier` config option to provide tunnel for SauceLabs. See #2832 by @gurjeetbains -## 3.0.5 +- [REST] Use class instance of axios, not the global instance, to avoid contaminating global configuration. #2846 by @vanvoljg +- [Appium] Added `tunnelIdentifier` config option to provide tunnel for SauceLabs. See #2832 by @gurjeetbains +## 3.0.5 Features: -* **[Official Docker image for CodeceptJS v3](https://hub.docker.com/r/codeceptjs/codeceptjs)**. New Docker image is based on official Playwright image and supports Playwright, Puppeteer, WebDriver engines. Thanks @VikentyShevyrin -* Better support for Typescript `codecept.conf.ts` configuration files. See #2750 by @elaichenkov -* Propagate more events for custom parallel script. See #2796 by @jccguimaraes -* [mocha-junit-reporter] Now supports attachments, see documentation for details. See #2675 by @Shard -* CustomLocators interface for TypeScript to extend from LocatorOrString. See #2798 by @danielrentz -* [REST] Mask sensitive data from log messages. +- **[Official Docker image for CodeceptJS v3](https://hub.docker.com/r/codeceptjs/codeceptjs)**. New Docker image is based on official Playwright image and supports Playwright, Puppeteer, WebDriver engines. Thanks @VikentyShevyrin +- Better support for Typescript `codecept.conf.ts` configuration files. See #2750 by @elaichenkov +- Propagate more events for custom parallel script. See #2796 by @jccguimaraes +- [mocha-junit-reporter] Now supports attachments, see documentation for details. See #2675 by @Shard +- CustomLocators interface for TypeScript to extend from LocatorOrString. See #2798 by @danielrentz +- [REST] Mask sensitive data from log messages. + ```js -I.sendPatchRequest('/api/users.json', secret({ "email": "user@user.com" })); +I.sendPatchRequest('/api/users.json', secret({ email: 'user@user.com' })) ``` + See #2786 by @PeterNgTr Bug fixes: -* Fixed reporting of nested steps with PageObjects and BDD scenarios. See #2800 by @davertmik. Fixes #2720 #2682 -* Fixed issue with `codeceptjs shell` which was broken since 3.0.0. See #2743 by @stedman -* [Gherkin] Fixed issue suppressed or hidden errors in tests. See #2745 by @ktryniszewski-mdsol -* [Playwright] fix grabCssPropertyFromAll serialization by using property names. See #2757 by @elaichenkov -* [Allure] fix report for multi sessions. See #2771 by @cbayer97 -* [WebDriver] Fix locator object debug log messages in smart wait. See 2748 by @elaichenkov + +- Fixed reporting of nested steps with PageObjects and BDD scenarios. See #2800 by @davertmik. Fixes #2720 #2682 +- Fixed issue with `codeceptjs shell` which was broken since 3.0.0. See #2743 by @stedman +- [Gherkin] Fixed issue suppressed or hidden errors in tests. See #2745 by @ktryniszewski-mdsol +- [Playwright] fix grabCssPropertyFromAll serialization by using property names. See #2757 by @elaichenkov +- [Allure] fix report for multi sessions. See #2771 by @cbayer97 +- [WebDriver] Fix locator object debug log messages in smart wait. See 2748 by @elaichenkov Documentation fixes: -* Fixed some broken examples. See #2756 by @danielrentz -* Fixed Typescript typings. See #2747, #2758 and #2769 by @elaichenkov -* Added missing type for xFeature. See #2754 by @PeterNgTr -* Fixed code example in Page Object documentation. See #2793 by @mkrtchian + +- Fixed some broken examples. See #2756 by @danielrentz +- Fixed Typescript typings. See #2747, #2758 and #2769 by @elaichenkov +- Added missing type for xFeature. See #2754 by @PeterNgTr +- Fixed code example in Page Object documentation. See #2793 by @mkrtchian Library updates: -* Updated Axios to 0.21.1. See by @sseide -* Updated @pollyjs/core @pollyjs/adapter-puppeteer. See #2760 by @Anikethana + +- Updated Axios to 0.21.1. See by @sseide +- Updated @pollyjs/core @pollyjs/adapter-puppeteer. See #2760 by @Anikethana ## 3.0.4 -* **Hotfix** Fixed `init` script by adding `cross-spawn` package. By @vipulgupta2048 -* Fixed handling error during initialization of `run-multiple`. See #2730 by @wagoid +- **Hotfix** Fixed `init` script by adding `cross-spawn` package. By @vipulgupta2048 +- Fixed handling error during initialization of `run-multiple`. See #2730 by @wagoid ## 3.0.3 -* **Playwright 1.7 support** -* [Playwright] Fixed handling null context in click. See #2667 by @matthewjf -* [Playwright] Fixed `Cannot read property '$$' of null` when locating elements. See #2713 by @matthewjf -* Command `npx codeceptjs init` improved - * auto-installing required packages - * better error messages - * fixed generating type definitions -* Data Driven Tests improvements: instead of having one skipped test for data driven scenarios when using xData you get a skipped test for each entry in the data table. See #2698 by @Georgegriff -* [Puppeteer] Fixed that `waitForFunction` was not working with number values. See #2703 by @MumblesNZ -* Enabled autocompletion for custom helpers. #2695 by @PeterNgTr -* Emit test.after on workers. Fix #2693 by @jccguimaraes -* TypeScript: Allow .ts config files. See #2708 by @elukoyanov -* Fixed definitions generation errors by @elukoyanov. See #2707 and #2718 -* Fixed handing error in _after function; for example, browser is closed during test and tests executions is stopped, but error was not logged. See #2715 by @elukoyanov -* Emit hook.failed in workers. Fix #2723 by @jccguimaraes -* [wdio plugin] Added `seleniumArgs` and `seleniumInstallArgs` config options for plugin. See #2687 by @andrerleao -* [allure plugin] Added `addParameter` method in #2717 by @jancorvus. Fixes #2716 -* Added mocha-based `--reporter-options` and `--reporter ` commands to `run-workers` command by in #2691 @Ameterezu -* Fixed infinite loop for junit reports. See #2691 @Ameterezu -* Added status, start/end time, and match line for BDD steps. See #2678 by @ktryniszewski-mdsol -* [stepByStepReport plugin] Fixed "helper.saveScreenshot is not a function". Fix #2688 by @andrerleao - - +- **Playwright 1.7 support** +- [Playwright] Fixed handling null context in click. See #2667 by @matthewjf +- [Playwright] Fixed `Cannot read property '$$' of null` when locating elements. See #2713 by @matthewjf +- Command `npx codeceptjs init` improved + - auto-installing required packages + - better error messages + - fixed generating type definitions +- Data Driven Tests improvements: instead of having one skipped test for data driven scenarios when using xData you get a skipped test for each entry in the data table. See #2698 by @Georgegriff +- [Puppeteer] Fixed that `waitForFunction` was not working with number values. See #2703 by @MumblesNZ +- Enabled autocompletion for custom helpers. #2695 by @PeterNgTr +- Emit test.after on workers. Fix #2693 by @jccguimaraes +- TypeScript: Allow .ts config files. See #2708 by @elukoyanov +- Fixed definitions generation errors by @elukoyanov. See #2707 and #2718 +- Fixed handing error in \_after function; for example, browser is closed during test and tests executions is stopped, but error was not logged. See #2715 by @elukoyanov +- Emit hook.failed in workers. Fix #2723 by @jccguimaraes +- [wdio plugin] Added `seleniumArgs` and `seleniumInstallArgs` config options for plugin. See #2687 by @andrerleao +- [allure plugin] Added `addParameter` method in #2717 by @jancorvus. Fixes #2716 +- Added mocha-based `--reporter-options` and `--reporter ` commands to `run-workers` command by in #2691 @Ameterezu +- Fixed infinite loop for junit reports. See #2691 @Ameterezu +- Added status, start/end time, and match line for BDD steps. See #2678 by @ktryniszewski-mdsol +- [stepByStepReport plugin] Fixed "helper.saveScreenshot is not a function". Fix #2688 by @andrerleao ## 3.0.2 -* [Playwright] Fix connection close with remote browser. See #2629 by @dipiash -* [REST] set maxUploadFileSize when performing api calls. See #2611 by @PeterNgTr -* Duplicate Scenario names (combined with Feature name) are now detected via a warning message. -Duplicate test names can cause `codeceptjs run-workers` to not function. See #2656 by @Georgegriff -* Documentation fixes +- [Playwright] Fix connection close with remote browser. See #2629 by @dipiash +- [REST] set maxUploadFileSize when performing api calls. See #2611 by @PeterNgTr +- Duplicate Scenario names (combined with Feature name) are now detected via a warning message. + Duplicate test names can cause `codeceptjs run-workers` to not function. See #2656 by @Georgegriff +- Documentation fixes Bug Fixes: - * --suites flag now should function correctly for `codeceptjs run-workers`. See #2655 by @Georgegriff - * [autoLogin plugin] Login methods should now function as expected with `codeceptjs run-workers`. See #2658 by @Georgegriff, resolves #2620 - +- --suites flag now should function correctly for `codeceptjs run-workers`. See #2655 by @Georgegriff +- [autoLogin plugin] Login methods should now function as expected with `codeceptjs run-workers`. See #2658 by @Georgegriff, resolves #2620 ## 3.0.1 ♨ī¸ Hot fix: - * Lock the mocha version to avoid the errors. See #2624 by PeterNgTr + +- Lock the mocha version to avoid the errors. See #2624 by PeterNgTr 🐛 Bug Fix: - * Fixed error handling in Scenario.js. See #2607 by haveac1gar - * Changing type definition in order to allow the use of functions with any number of any arguments. See #2616 by akoltun -* Some updates/changes on documentations +- Fixed error handling in Scenario.js. See #2607 by haveac1gar +- Changing type definition in order to allow the use of functions with any number of any arguments. See #2616 by akoltun + +- Some updates/changes on documentations ## 3.0.0 -> [ 👌 **LEARN HOW TO UPGRADE TO CODECEPTJS 3 ➡**](https://bit.ly/codecept3Up) -* Playwright set to be a default engine. -* **NodeJS 12+ required** -* **BREAKING CHANGE:** Syntax for tests has changed. +> [ 👌 **LEARN HOW TO UPGRADE TO CODECEPTJS 3 ➡**](https://bit.ly/codecept3Up) +- Playwright set to be a default engine. +- **NodeJS 12+ required** +- **BREAKING CHANGE:** Syntax for tests has changed. ```js // Previous -Scenario('title', (I, loginPage) => {}); +Scenario('title', (I, loginPage) => {}) // Current -Scenario('title', ({ I, loginPage }) => {}); +Scenario('title', ({ I, loginPage }) => {}) ``` -* **BREAKING** Replaced bootstrap/teardown scripts to accept only functions or async functions. Async function with callback (with done parameter) should be replaced with async/await. [See our upgrade guide](https://bit.ly/codecept3Up). -* **[TypeScript guide](/typescript)** and [boilerplate project](https://github.com/codeceptjs/typescript-boilerplate) -* [tryTo](/plugins/#tryto) and [pauseOnFail](/plugins/#pauseOnFail) plugins installed by default -* Introduced one-line installer: +- **BREAKING** Replaced bootstrap/teardown scripts to accept only functions or async functions. Async function with callback (with done parameter) should be replaced with async/await. [See our upgrade guide](https://bit.ly/codecept3Up). +- **[TypeScript guide](/typescript)** and [boilerplate project](https://github.com/codeceptjs/typescript-boilerplate) +- [tryTo](/plugins/#tryto) and [pauseOnFail](/plugins/#pauseOnFail) plugins installed by default +- Introduced one-line installer: ``` npx create-codeceptjs . @@ -2290,50 +2801,50 @@ Read changelog to learn more about version 👇 ## 3.0.0-rc - - -* Moved [Helper class into its own package](https://github.com/codeceptjs/helper) to simplify publishing standalone helpers. -* Fixed typings for `I.say` and `I.retry` by @Vorobeyko -* Updated documentation: - * [Quickstart](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/quickstart.md#quickstart) - * [Best Practices](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/best.md) - * [Custom Helpers](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/custom-helpers.md) - * [TypeScript](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/typescript.md) +- Moved [Helper class into its own package](https://github.com/codeceptjs/helper) to simplify publishing standalone helpers. +- Fixed typings for `I.say` and `I.retry` by @Vorobeyko +- Updated documentation: + - [Quickstart](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/quickstart.md#quickstart) + - [Best Practices](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/best.md) + - [Custom Helpers](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/custom-helpers.md) + - [TypeScript](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/typescript.md) ## 3.0.0-beta.4 🐛 Bug Fix: - * PageObject was broken when using "this" inside a simple object. - * The typings for all WebDriver methods work correctly. - * The typings for "this.helper" and helper constructor work correctly, too. + +- PageObject was broken when using "this" inside a simple object. +- The typings for all WebDriver methods work correctly. +- The typings for "this.helper" and helper constructor work correctly, too. 🧤 Internal: - * Our TS Typings will be tested now! We strarted using [dtslint](https://github.com/microsoft/dtslint) to check all typings and all rules for linter. - Example: - ```ts - const psp = wd.grabPageScrollPosition() // $ExpectType Promise - psp.then( - result => { - result.x // $ExpectType number - result.y // $ExpectType number - } - ) - ``` - * And last: Reducing package size from 3.3Mb to 2.0Mb + +- Our TS Typings will be tested now! We strarted using [dtslint](https://github.com/microsoft/dtslint) to check all typings and all rules for linter. + Example: + +```ts +const psp = wd.grabPageScrollPosition() // $ExpectType Promise +psp.then(result => { + result.x // $ExpectType number + result.y // $ExpectType number +}) +``` + +- And last: Reducing package size from 3.3Mb to 2.0Mb ## 3.0.0-beta-3 -* **BREAKING** Replaced bootstrap/teardown scripts to accept only functions or async functions. Async function with callback (with done parameter) should be replaced with async/await. [See our upgrde guide](https://bit.ly/codecept3Up). -* Test artifacts introduced. Each test object has `artifacts` property, to keep attachment files. For instance, a screenshot of a failed test is attached to a test as artifact. -* Improved output for test execution - * Changed colors for steps output, simplified - * Added stack trace for test failures - * Removed `Event emitted` from log in `--verbose` mode - * List artifacts of a failed tests +- **BREAKING** Replaced bootstrap/teardown scripts to accept only functions or async functions. Async function with callback (with done parameter) should be replaced with async/await. [See our upgrde guide](https://bit.ly/codecept3Up). +- Test artifacts introduced. Each test object has `artifacts` property, to keep attachment files. For instance, a screenshot of a failed test is attached to a test as artifact. +- Improved output for test execution + - Changed colors for steps output, simplified + - Added stack trace for test failures + - Removed `Event emitted` from log in `--verbose` mode + - List artifacts of a failed tests ![](https://user-images.githubusercontent.com/220264/82160052-397bf800-989b-11ea-81c0-8e58b3d33525.png) -* Steps & metasteps refactored by @Vorobeyko. Logs to arguments passed to page objects: +- Steps & metasteps refactored by @Vorobeyko. Logs to arguments passed to page objects: ```js // TEST: @@ -2344,146 +2855,146 @@ MyPage: hasFile "First arg", "Second arg" I see file "codecept.js" I see file "codecept.po.json" ``` -* Introduced official [TypeScript boilerplate](https://github.com/codeceptjs/typescript-boilerplate). Started by @Vorobeyko. - -## 3.0.0-beta +- Introduced official [TypeScript boilerplate](https://github.com/codeceptjs/typescript-boilerplate). Started by @Vorobeyko. -* **NodeJS 12+ required** -* **BREAKING CHANGE:** Syntax for tests has changed. +## 3.0.0-beta +- **NodeJS 12+ required** +- **BREAKING CHANGE:** Syntax for tests has changed. ```js // Previous -Scenario('title', (I, loginPage) => {}); +Scenario('title', (I, loginPage) => {}) // Current -Scenario('title', ({ I, loginPage }) => {}); +Scenario('title', ({ I, loginPage }) => {}) ``` -* **BREAKING CHANGE:** [WebDriver][Protractor][Puppeteer][Playwright][Nightmare] `grab*` functions unified: - * `grab*From` => **returns single value** from element or throws error when no matchng elements found - * `grab*FromAll` => returns array of values, or empty array when no matching elements -* Public API for workers introduced by @koushikmohan1996. [Customize parallel execution](https://github.com/Codeception/CodeceptJS/blob/codeceptjs-v3.0/docs/parallel.md#custom-parallel-execution) with workers by building custom scripts. +- **BREAKING CHANGE:** [WebDriver][Protractor][Puppeteer][Playwright][Nightmare] `grab*` functions unified: + - `grab*From` => **returns single value** from element or throws error when no matchng elements found + - `grab*FromAll` => returns array of values, or empty array when no matching elements +- Public API for workers introduced by @koushikmohan1996. [Customize parallel execution](https://github.com/Codeception/CodeceptJS/blob/codeceptjs-v3.0/docs/parallel.md#custom-parallel-execution) with workers by building custom scripts. -* [Playwright] Added `usePlaywrightTo` method to access Playwright API in tests directly: +- [Playwright] Added `usePlaywrightTo` method to access Playwright API in tests directly: ```js I.usePlaywrightTo('do something special', async ({ page }) => { // use page or browser objects here -}); +}) ``` -* [Puppeteer] Introduced `usePuppeteerTo` method to access Puppeteer API: +- [Puppeteer] Introduced `usePuppeteerTo` method to access Puppeteer API: ```js I.usePuppeteerTo('do something special', async ({ page, browser }) => { // use page or browser objects here -}); +}) ``` -* [WebDriver] Introduced `useWebDriverTo` method to access webdriverio API: +- [WebDriver] Introduced `useWebDriverTo` method to access webdriverio API: ```js I.useWebDriverTo('do something special', async ({ browser }) => { // use browser object here -}); +}) ``` -* [Protractor] Introduced `useProtractorTo` method to access protractor API -* `tryTo` plugin introduced. Allows conditional action execution: +- [Protractor] Introduced `useProtractorTo` method to access protractor API +- `tryTo` plugin introduced. Allows conditional action execution: ```js const isSeen = await tryTo(() => { - I.see('Some text'); -}); + I.see('Some text') +}) // we are not sure if cookie bar is displayed, but if so - accept cookies -tryTo(() => I.click('Accept', '.cookies')); +tryTo(() => I.click('Accept', '.cookies')) ``` -* **Possible breaking change** In semantic locators `[` char indicates CSS selector. +- **Possible breaking change** In semantic locators `[` char indicates CSS selector. + ## 2.6.11 -* [Playwright] Playwright 1.4 compatibility -* [Playwright] Added `ignoreHTTPSErrors` config option (default: false). See #2566 by gurjeetbains -* Added French translation by @vimar -* [WebDriver] Updated `dragSlider` to work in WebDriver W3C protocol. Fixes #2557 by suniljaiswal01 +- [Playwright] Playwright 1.4 compatibility +- [Playwright] Added `ignoreHTTPSErrors` config option (default: false). See #2566 by gurjeetbains +- Added French translation by @vimar +- [WebDriver] Updated `dragSlider` to work in WebDriver W3C protocol. Fixes #2557 by suniljaiswal01 ## 2.6.10 -* Fixed saving options for suite via `Feature('title', {key: value})` by @Diokuz. See #2553 and [Docs](https://codecept.io/advanced/#dynamic-configuration) +- Fixed saving options for suite via `Feature('title', {key: value})` by @Diokuz. See #2553 and [Docs](https://codecept.io/advanced/#dynamic-configuration) ## 2.6.9 -* [Puppeteer][Playwright] SessionStorage is now cleared in after hook. See #2524 -* When helper load failed the error stack is now logged by @SkReD. See #2541 -* Small documentation fixes. +- [Puppeteer][Playwright] SessionStorage is now cleared in after hook. See #2524 +- When helper load failed the error stack is now logged by @SkReD. See #2541 +- Small documentation fixes. ## 2.6.8 -* [WebDriver][Protractor][Playwright][Puppeteer][Nightmare] `saveElementScreenshot` method added to make screenshot of an element. By @suniljaiswal01 -* [Playwright][Puppeteer] Added `type` method to type a text using keyboard with an optional delay. -* [WebDriver] Added optional `delay` argument to `type` method to slow down typing. -* [Puppeteer] Fixed `amOnPage` freeze when `getPageTimeout` is 0"; set 30 sec as default timeout by @Vorobeyko. -* Fixed printing step with null argument in custom helper by @sjana-aj. See #2494 -* Fix missing screenshot on failure when REST helper is in use #2513 by @PeterNgTr -* Improve error logging in the `screenshotOnFail` plugin #2512 by @pablopaul +- [WebDriver][Protractor][Playwright][Puppeteer][Nightmare] `saveElementScreenshot` method added to make screenshot of an element. By @suniljaiswal01 +- [Playwright][Puppeteer] Added `type` method to type a text using keyboard with an optional delay. +- [WebDriver] Added optional `delay` argument to `type` method to slow down typing. +- [Puppeteer] Fixed `amOnPage` freeze when `getPageTimeout` is 0"; set 30 sec as default timeout by @Vorobeyko. +- Fixed printing step with null argument in custom helper by @sjana-aj. See #2494 +- Fix missing screenshot on failure when REST helper is in use #2513 by @PeterNgTr +- Improve error logging in the `screenshotOnFail` plugin #2512 by @pablopaul ## 2.6.7 -* Add REST helper into `standardActingHelpers` array #2474 by @PeterNgTr -* Add missing `--invert` option for `run-workers` command #2504 by @pablopaul -* [WebDriver] Introduce `forceRightClick` method #2485 bylsuniljaiswal01 -* [Playwright] Fix `setCookie` method #2491 by @bmbarker90 -* [TypeScript] Update compilerOptions.target to es2017 #2483 by @shanplourde -* [Mocha] Honor reporter configuration #2465 by @trinhpham +- Add REST helper into `standardActingHelpers` array #2474 by @PeterNgTr +- Add missing `--invert` option for `run-workers` command #2504 by @pablopaul +- [WebDriver] Introduce `forceRightClick` method #2485 bylsuniljaiswal01 +- [Playwright] Fix `setCookie` method #2491 by @bmbarker90 +- [TypeScript] Update compilerOptions.target to es2017 #2483 by @shanplourde +- [Mocha] Honor reporter configuration #2465 by @trinhpham ## 2.6.6 -* Puppeteer 4.0 support. Important: MockRequest helper won't work with Puppeter > 3.3 -* Added `xFeature` and `Feature.skip` to skip all tests in a suite. By @Georgegriff -* [Appium] Fixed #2428 Android native locator support by @idxn -* [WebDriver] Fixed `waitNumberOfVisibleElements` to actually filter visible elements. By @ilangv -* [Puppeteer] Fixed handling error which is not an Error object. Fixes `cannot read property indexOf of undefined` error. Fix #2436 by @Georgegriff -* [Puppeteer] Print error on page crash by @Georgegriff +- Puppeteer 4.0 support. Important: MockRequest helper won't work with Puppeter > 3.3 +- Added `xFeature` and `Feature.skip` to skip all tests in a suite. By @Georgegriff +- [Appium] Fixed #2428 Android native locator support by @idxn +- [WebDriver] Fixed `waitNumberOfVisibleElements` to actually filter visible elements. By @ilangv +- [Puppeteer] Fixed handling error which is not an Error object. Fixes `cannot read property indexOf of undefined` error. Fix #2436 by @Georgegriff +- [Puppeteer] Print error on page crash by @Georgegriff ## 2.6.5 -* Added `test.skipped` event to run-workers, fixing allure reports with skipped tests in workers #2391. Fix #2387 by @koushikmohan1996 -* [Playwright] Fixed calling `waitFor*` methods with custom locators #2314. Fix #2389 by @Georgegriff +- Added `test.skipped` event to run-workers, fixing allure reports with skipped tests in workers #2391. Fix #2387 by @koushikmohan1996 +- [Playwright] Fixed calling `waitFor*` methods with custom locators #2314. Fix #2389 by @Georgegriff ## 2.6.4 -* [Playwright] **Playwright 1.0 support** by @Georgegriff. +- [Playwright] **Playwright 1.0 support** by @Georgegriff. ## 2.6.3 -* [stepByStepReport plugin] Fixed when using plugin with BeforeSuite. Fixes #2337 by @mirao -* [allure plugin] Fixed reporting of tests skipped by failure in before hook. Refer to #2349 & #2354. Fix by @koushikmohan1996 +- [stepByStepReport plugin] Fixed when using plugin with BeforeSuite. Fixes #2337 by @mirao +- [allure plugin] Fixed reporting of tests skipped by failure in before hook. Refer to #2349 & #2354. Fix by @koushikmohan1996 ## 2.6.2 -* [WebDriver][Puppeteer] Added `forceClick` method to emulate click event instead of using native events. -* [Playwright] Updated to 0.14 -* [Puppeteer] Updated to Puppeteer v3.0 -* [wdio] Fixed undefined output directory for wdio plugns. Fix By @PeterNgTr -* [Playwright] Introduced `handleDownloads` method to download file. Please note, this method has slightly different API than the same one in Puppeteer. -* [allure] Fixed undefined output directory for allure plugin on using custom runner. Fix by @charliepradeep -* [WebDriver] Fixed `waitForEnabled` fix for webdriver 6. Fix by @dsharapkou -* Workers: Fixed negative failure result if use scenario with the same names. Fix by @Vorobeyko -* [MockRequest] Updated documentation to match new helper version -* Fixed: skipped tests are not reported if a suite failed in `before`. Refer #2349 & #2354. Fix by @koushikmohan1996 +- [WebDriver][Puppeteer] Added `forceClick` method to emulate click event instead of using native events. +- [Playwright] Updated to 0.14 +- [Puppeteer] Updated to Puppeteer v3.0 +- [wdio] Fixed undefined output directory for wdio plugns. Fix By @PeterNgTr +- [Playwright] Introduced `handleDownloads` method to download file. Please note, this method has slightly different API than the same one in Puppeteer. +- [allure] Fixed undefined output directory for allure plugin on using custom runner. Fix by @charliepradeep +- [WebDriver] Fixed `waitForEnabled` fix for webdriver 6. Fix by @dsharapkou +- Workers: Fixed negative failure result if use scenario with the same names. Fix by @Vorobeyko +- [MockRequest] Updated documentation to match new helper version +- Fixed: skipped tests are not reported if a suite failed in `before`. Refer #2349 & #2354. Fix by @koushikmohan1996 ## 2.6.1 -* [screenshotOnFail plugin] Fixed saving screenshot of active session. -* [screenshotOnFail plugin] Fix issue #2301 when having the flag `uniqueScreenshotNames`=true results in `undefined` in screenshot file name by @PeterNgTr -* [WebDriver] Fixed `waitForElement` not applying the optional second argument to override the default timeout in webdriverio 6. Fix by @Mooksc -* [WebDriver] Updated `waitUntil` method which is used by all of the wait* functions. This updates the `waitForElement` by the same convention used to update `waitForVisible` and `waitInUrl` to be compatible with both WebDriverIO v5 & v6. See #2313 by @Mooksc +- [screenshotOnFail plugin] Fixed saving screenshot of active session. +- [screenshotOnFail plugin] Fix issue #2301 when having the flag `uniqueScreenshotNames`=true results in `undefined` in screenshot file name by @PeterNgTr +- [WebDriver] Fixed `waitForElement` not applying the optional second argument to override the default timeout in webdriverio 6. Fix by @Mooksc +- [WebDriver] Updated `waitUntil` method which is used by all of the wait\* functions. This updates the `waitForElement` by the same convention used to update `waitForVisible` and `waitInUrl` to be compatible with both WebDriverIO v5 & v6. See #2313 by @Mooksc ## 2.6.0 -* **[Playwright] Updated to Playwright 0.12** by @Georgegriff. +- **[Playwright] Updated to Playwright 0.12** by @Georgegriff. Upgrade playwright to ^0.12: @@ -2492,22 +3003,25 @@ npm i playwright@^0.12 --save ``` [Notable changes](https://github.com/microsoft/playwright/releases/tag/v0.12.0): - * Fixed opening two browsers on start - * `executeScript` - passed function now accepts only one argument. Pass in objects or arrays if you need multtple arguments: + +- Fixed opening two browsers on start +- `executeScript` - passed function now accepts only one argument. Pass in objects or arrays if you need multtple arguments: + ```js // Old style, does not work anymore: -I.executeScript((x, y) => x + y, x, y); +I.executeScript((x, y) => x + y, x, y) // New style, passing an object: -I.executeScript(({x, y}) => x + y, {x, y}); +I.executeScript(({ x, y }) => x + y, { x, y }) ``` - * `click` - automatically waits for element to become clickable (visible, not animated) and waits for navigation. - * `clickLink` - deprecated - * `waitForClickable` - deprecated - * `forceClick` - added - * Added support for custom locators. See #2277 - * Introduced [device emulation](/playwright/#device-emulation): - * globally via `emulate` config option - * per session + +- `click` - automatically waits for element to become clickable (visible, not animated) and waits for navigation. +- `clickLink` - deprecated +- `waitForClickable` - deprecated +- `forceClick` - added +- Added support for custom locators. See #2277 +- Introduced [device emulation](/playwright/#device-emulation): + - globally via `emulate` config option + - per session **[WebDriver] Updated to webdriverio v6** by @PeterNgTr. @@ -2517,28 +3031,29 @@ upgrade webdriverio to ^6.0: ``` npm i webdriverio@^6.0 --save ``` -*(webdriverio v5 support is deprecated and will be removed in CodeceptJS 3.0)* + +_(webdriverio v5 support is deprecated and will be removed in CodeceptJS 3.0)_ [WebDriver] Introduced [Shadow DOM support](/shadow) by @gkushang ```js -I.click({ shadow: ['my-app', 'recipe-hello', 'button'] }); +I.click({ shadow: ['my-app', 'recipe-hello', 'button'] }) ``` -* **Fixed parallel execution of `run-workers` for Gherkin** scenarios by @koushikmohan1996 -* [MockRequest] Updated and **moved to [standalone package](https://github.com/codeceptjs/mock-request)**: - * full support for record/replay mode for Puppeteer - * added `mockServer` method to use flexible PollyJS API to define mocks - * fixed stale browser screen in record mode. -* [Playwright] Added support on for `screenshotOnFail` plugin by @amonkc -* Gherkin improvement: setting different tags per examples. See #2208 by @acuper -* [TestCafe] Updated `click` to take first visible element. Fixes #2226 by @theTainted -* [Puppeteer][WebDriver] Updated `waitForClickable` method to check for element overlapping. See #2261 by @PiQx -* [Puppeteer] Dropped `puppeteer-firefox` support, as Puppeteer supports Firefox natively. -* [REST] Rrespect Content-Type header. See #2262 by @pmarshall-legacy -* [allure plugin] Fixes BeforeSuite failures in allure reports. See #2248 by @Georgegriff -* [WebDriver][Puppeteer][Playwright] A screenshot of for an active session is saved in multi-session mode. See #2253 by @ChexWarrior -* Fixed `--profile` option by @pablopaul. Profile value to be passed into `run-multiple` and `run-workers`: +- **Fixed parallel execution of `run-workers` for Gherkin** scenarios by @koushikmohan1996 +- [MockRequest] Updated and **moved to [standalone package](https://github.com/codeceptjs/mock-request)**: + - full support for record/replay mode for Puppeteer + - added `mockServer` method to use flexible PollyJS API to define mocks + - fixed stale browser screen in record mode. +- [Playwright] Added support on for `screenshotOnFail` plugin by @amonkc +- Gherkin improvement: setting different tags per examples. See #2208 by @acuper +- [TestCafe] Updated `click` to take first visible element. Fixes #2226 by @theTainted +- [Puppeteer][WebDriver] Updated `waitForClickable` method to check for element overlapping. See #2261 by @PiQx +- [Puppeteer] Dropped `puppeteer-firefox` support, as Puppeteer supports Firefox natively. +- [REST] Rrespect Content-Type header. See #2262 by @pmarshall-legacy +- [allure plugin] Fixes BeforeSuite failures in allure reports. See #2248 by @Georgegriff +- [WebDriver][Puppeteer][Playwright] A screenshot of for an active session is saved in multi-session mode. See #2253 by @ChexWarrior +- Fixed `--profile` option by @pablopaul. Profile value to be passed into `run-multiple` and `run-workers`: ``` npx codecept run-workers 2 --profile firefox @@ -2546,128 +3061,128 @@ npx codecept run-workers 2 --profile firefox Value is available at `process.env.profile` (previously `process.profile`). See #2302. Fixes #1968 #1315 -* [commentStep Plugin introduced](/plugins#commentstep). Allows to annotate logical parts of a test: +- [commentStep Plugin introduced](/plugins#commentstep). Allows to annotate logical parts of a test: ```js -__`Given`; +__`Given` I.amOnPage('/profile') -__`When`; -I.click('Logout'); +__`When` +I.click('Logout') -__`Then`; -I.see('You are logged out'); +__`Then` +I.see('You are logged out') ``` ## 2.5.0 -* **Experimental: [Playwright](/playwright) helper introduced**. +- **Experimental: [Playwright](/playwright) helper introduced**. > [Playwright](https://github.com/microsoft/playwright/) is an alternative to Puppeteer which works very similarly to it but adds cross-browser support with Firefox and Webkit. Until v1.0 Playwright API is not stable but we introduce it to CodeceptJS so you could try it. -* [Puppeteer] Fixed basic auth support when running in multiple sessions. See #2178 by @ian-bartholomew -* [Puppeteer] Fixed `waitForText` when there is no `body` element on page (redirect). See #2181 by @Vorobeyko -* [Selenoid plugin] Fixed overriding current capabilities by adding deepMerge. Fixes #2183 by @koushikmohan1996 -* Added types for `Scenario.todo` by @Vorobeyko -* Added types for Mocha by @Vorobeyko. Fixed typing conflicts with Jest -* [FileSystem] Added methods by @nitschSB - * `waitForFile` - * `seeFileContentsEqualReferenceFile` -* Added `--colors` option to `run` and `run-multiple` so you force colored output in dockerized environment. See #2189 by @mirao -* [WebDriver] Added `type` command to enter value without focusing on a field. See #2198 by @xMutaGenx -* Fixed `codeceptjs gt` command to respect config pattern for tests. See #2200 and #2204 by @matheo - +- [Puppeteer] Fixed basic auth support when running in multiple sessions. See #2178 by @ian-bartholomew +- [Puppeteer] Fixed `waitForText` when there is no `body` element on page (redirect). See #2181 by @Vorobeyko +- [Selenoid plugin] Fixed overriding current capabilities by adding deepMerge. Fixes #2183 by @koushikmohan1996 +- Added types for `Scenario.todo` by @Vorobeyko +- Added types for Mocha by @Vorobeyko. Fixed typing conflicts with Jest +- [FileSystem] Added methods by @nitschSB + - `waitForFile` + - `seeFileContentsEqualReferenceFile` +- Added `--colors` option to `run` and `run-multiple` so you force colored output in dockerized environment. See #2189 by @mirao +- [WebDriver] Added `type` command to enter value without focusing on a field. See #2198 by @xMutaGenx +- Fixed `codeceptjs gt` command to respect config pattern for tests. See #2200 and #2204 by @matheo ## 2.4.3 -* Hotfix for interactive pause +- Hotfix for interactive pause ## 2.4.2 -* **Interactive pause improvements** by @koushikmohan1996 - * allows using in page objects and variables: `pause({ loginPage, a })` - * enables custom commands inside pause with `=>` prefix: `=> loginPage.open()` -* [Selenoid plugin](/plugins#selenoid) added by by @koushikmohan1996 - * uses Selenoid to launch browsers inside Docker containers - * automatically **records videos** and attaches them to allure reports - * can delete videos for successful tests - * can automatically pull in and start Selenoid containers - * works with WebDriver helper -* Avoid failiure report on successful retry in worker by @koushikmohan1996 -* Added translation ability to Scenario, Feature and other context methods by @koushikmohan1996 - * đŸ“ĸ Please help us translate context methods to your language! See [italian translation](https://github.com/codeceptjs/CodeceptJS/blob/master/translations/it-IT.js#L3) as an example and send [patches to vocabularies](https://github.com/codeceptjs/CodeceptJS/tree/master/translations). -* allurePlugin: Added `say` comments to allure reports by @PeterNgTr. -* Fixed no custom output folder created when executed with run-worker. Fix by @PeterNgTr -* [Puppeteer] Fixed error description for context element not found. See #2065. Fix by @PeterNgTr -* [WebDriver] Fixed `waitForClickable` to wait for exact number of seconds by @mirao. Resolves #2166 -* Fixed setting `compilerOptions` in `jsconfig.json` file on init by @PeterNgTr -* [Filesystem] Added method by @nitschSB - * `seeFileContentsEqualReferenceFile` - * `waitForFile` - +- **Interactive pause improvements** by @koushikmohan1996 + - allows using in page objects and variables: `pause({ loginPage, a })` + - enables custom commands inside pause with `=>` prefix: `=> loginPage.open()` +- [Selenoid plugin](/plugins#selenoid) added by by @koushikmohan1996 + - uses Selenoid to launch browsers inside Docker containers + - automatically **records videos** and attaches them to allure reports + - can delete videos for successful tests + - can automatically pull in and start Selenoid containers + - works with WebDriver helper +- Avoid failiure report on successful retry in worker by @koushikmohan1996 +- Added translation ability to Scenario, Feature and other context methods by @koushikmohan1996 + - đŸ“ĸ Please help us translate context methods to your language! See [italian translation](https://github.com/codeceptjs/CodeceptJS/blob/master/translations/it-IT.js#L3) as an example and send [patches to vocabularies](https://github.com/codeceptjs/CodeceptJS/tree/master/translations). +- allurePlugin: Added `say` comments to allure reports by @PeterNgTr. +- Fixed no custom output folder created when executed with run-worker. Fix by @PeterNgTr +- [Puppeteer] Fixed error description for context element not found. See #2065. Fix by @PeterNgTr +- [WebDriver] Fixed `waitForClickable` to wait for exact number of seconds by @mirao. Resolves #2166 +- Fixed setting `compilerOptions` in `jsconfig.json` file on init by @PeterNgTr +- [Filesystem] Added method by @nitschSB + - `seeFileContentsEqualReferenceFile` + - `waitForFile` ## 2.4.1 -* [Hotfix] - Add missing lib that prevents codeceptjs from initializing. +- [Hotfix] - Add missing lib that prevents codeceptjs from initializing. ## 2.4.0 -* Improved setup wizard with `npx codecept init`: - * **enabled [retryFailedStep](/plugins/#retryfailedstep) plugin for new setups**. - * enabled [@codeceptjs/configure](/configuration/#common-configuration-patterns) to toggle headless/window mode via env variable - * creates a new test on init - * removed question on "steps file", create it by default. -* Added [pauseOnFail plugin](/plugins/#pauseonfail). *Sponsored by Paul Vincent Beigang and his book "[Practical End 2 End Testing with CodeceptJS](https://leanpub.com/codeceptjs/)"*. -* Added [`run-rerun` command](/commands/#run-rerun) to run tests multiple times to detect and fix flaky tests. By @Ilrilan and @Vorobeyko. -* Added [`Scenario.todo()` to declare tests as pending](/basics#todotest). See #2100 by @Vorobeyko -* Added support for absolute path for `output` dir. See #2049 by @elukoyanov -* Fixed error in `npx codecept init` caused by calling `console.print`. See #2071 by @Atinux. -* [Filesystem] Methods added by @aefluke: - * `seeFileNameMatching` - * `grabFileNames` -* [Puppeteer] Fixed grabbing attributes with hyphen by @Holorium -* [TestCafe] Fixed `grabAttributeFrom` method by @elukoyanov -* [MockRequest] Added support for [Polly config options](https://netflix.github.io/pollyjs/#/configuration?id=configuration) by @ecrmnn -* [TestCafe] Fixes exiting with zero code on failure. Fixed #2090 with #2106 by @koushikmohan1996 -* [WebDriver][Puppeteer] Added basicAuth support via config. Example: `basicAuth: {username: 'username', password: 'password'}`. See #1962 by @PeterNgTr -* [WebDriver][Appium] Added `scrollIntoView` by @pablopaul -* Fixed #2118: No error stack trace for syntax error by @senthillkumar -* Added `parse()` method to data table inside Cucumber tests. Use it to obtain rows and hashes for test data. See #2082 by @Sraime +- Improved setup wizard with `npx codecept init`: + - **enabled [retryFailedStep](/plugins/#retryfailedstep) plugin for new setups**. + - enabled [@codeceptjs/configure](/configuration/#common-configuration-patterns) to toggle headless/window mode via env variable + - creates a new test on init + - removed question on "steps file", create it by default. +- Added [pauseOnFail plugin](/plugins/#pauseonfail). _Sponsored by Paul Vincent Beigang and his book "[Practical End 2 End Testing with CodeceptJS](https://leanpub.com/codeceptjs/)"_. +- Added [`run-rerun` command](/commands/#run-rerun) to run tests multiple times to detect and fix flaky tests. By @Ilrilan and @Vorobeyko. +- Added [`Scenario.todo()` to declare tests as pending](/basics#todotest). See #2100 by @Vorobeyko +- Added support for absolute path for `output` dir. See #2049 by @elukoyanov +- Fixed error in `npx codecept init` caused by calling `console.print`. See #2071 by @Atinux. +- [Filesystem] Methods added by @aefluke: + - `seeFileNameMatching` + - `grabFileNames` +- [Puppeteer] Fixed grabbing attributes with hyphen by @Holorium +- [TestCafe] Fixed `grabAttributeFrom` method by @elukoyanov +- [MockRequest] Added support for [Polly config options](https://netflix.github.io/pollyjs/#/configuration?id=configuration) by @ecrmnn +- [TestCafe] Fixes exiting with zero code on failure. Fixed #2090 with #2106 by @koushikmohan1996 +- [WebDriver][Puppeteer] Added basicAuth support via config. Example: `basicAuth: {username: 'username', password: 'password'}`. See #1962 by @PeterNgTr +- [WebDriver][Appium] Added `scrollIntoView` by @pablopaul +- Fixed #2118: No error stack trace for syntax error by @senthillkumar +- Added `parse()` method to data table inside Cucumber tests. Use it to obtain rows and hashes for test data. See #2082 by @Sraime ## 2.3.6 -* Create better Typescript definition file through JSDoc. By @lemnis -* `run-workers` now can use glob pattern. By @Ilrilan +- Create better Typescript definition file through JSDoc. By @lemnis +- `run-workers` now can use glob pattern. By @Ilrilan + ```js // Example: exports.config = { tests: '{./workers/base_test.workers.js,./workers/test_grep.workers.js}', } ``` -* Added new command `npx codeceptjs info` which print information about your environment and CodeceptJS configs. By @jamesgeorge007 -* Fixed some typos in documantation. By @pablopaul @atomicpages @EricTendian -* Added PULL_REQUEST template. -* [Puppeteer][WebDriver] Added `waitForClickable` for waiting clickable element on page. -* [TestCafe] Added support for remote connection. By @jvdieten -* [Puppeteer] Fixed `waitForText` XPath context now works correctly. By @Heavik -* [TestCafe] Fixed `clearField` clear field now awaits TestCafe's promise. By @orihomie -* [Puppeteer] Fixed fails when executing localStorage on services pages. See #2026 -* Fixed empty tags in test name. See #2038 + +- Added new command `npx codeceptjs info` which print information about your environment and CodeceptJS configs. By @jamesgeorge007 +- Fixed some typos in documantation. By @pablopaul @atomicpages @EricTendian +- Added PULL_REQUEST template. +- [Puppeteer][WebDriver] Added `waitForClickable` for waiting clickable element on page. +- [TestCafe] Added support for remote connection. By @jvdieten +- [Puppeteer] Fixed `waitForText` XPath context now works correctly. By @Heavik +- [TestCafe] Fixed `clearField` clear field now awaits TestCafe's promise. By @orihomie +- [Puppeteer] Fixed fails when executing localStorage on services pages. See #2026 +- Fixed empty tags in test name. See #2038 ## 2.3.5 -* Set "parse-function" dependency to "5.2.11" to avoid further installation errors. +- Set "parse-function" dependency to "5.2.11" to avoid further installation errors. ## 2.3.4 -* Fixed installation error "Cannot find module '@babel/runtime/helpers/interopRequireDefault'". The issue came from `parse-function` package. Fixed by @pablopaul. -* [Puppeteer] Fixed switching to iframe without an ID by @johnyb. See #1974 -* Added `--profile` option to `run-workers` by @orihomie -* Added a tag definition to `FeatureConfig` and `ScenarioConfig` by @sseliverstov +- Fixed installation error "Cannot find module '@babel/runtime/helpers/interopRequireDefault'". The issue came from `parse-function` package. Fixed by @pablopaul. +- [Puppeteer] Fixed switching to iframe without an ID by @johnyb. See #1974 +- Added `--profile` option to `run-workers` by @orihomie +- Added a tag definition to `FeatureConfig` and `ScenarioConfig` by @sseliverstov ## 2.3.3 -* **[customLocator plugin](#customlocator) introduced**. Adds a locator strategy for special test attributes on elements. +- **[customLocator plugin](#customlocator) introduced**. Adds a locator strategy for special test attributes on elements. ```js // when data-test-id is a special test attribute @@ -2676,279 +3191,280 @@ I.click({ css: '[data-test-id=register_button]'); // with this I.click('$register_button'); ``` -* [Puppeteer][WebDriver] `pressKey` improvements by @martomo: -Changed pressKey method to resolve issues and extend functionality. - * Did not properly recognize 'Meta' (or 'Command') as modifier key. - * Right modifier keys did not work in WebDriver using JsonWireProtocol. - * 'Shift' + 'key' combination would not reflect actual keyboard behavior. - * Respect sequence with multiple modifier keys passed to pressKey. - * Added support to automatic change operation modifier key based on operating system. -* [Puppeteer][WebDriver] Added `pressKeyUp` and `pressKeyDown` to press and release modifier keys like `Control` or `Shift`. By @martomo. -* [Puppeteer][WebDriver] Added `grabElementBoundingRect` by @PeterNgTr. -* [Puppeteer] Fixed speed degradation introduced in #1306 with accessibility locators support. See #1953. -* Added `Config.addHook` to add a function that will update configuration on load. -* Started [`@codeceptjs/configure`](https://github.com/codeceptjs/configure) package with a collection of common configuration patterns. -* [TestCafe] port's management removed (left on TestCafe itself) by @orihomie. Fixes #1934. -* [REST] Headers are no more declared as singleton variable. Fixes #1959 -* Updated Docker image to include run tests in workers with `NUMBER_OF_WORKERS` env variable. By @PeterNgTr. + +- [Puppeteer][WebDriver] `pressKey` improvements by @martomo: + Changed pressKey method to resolve issues and extend functionality. + - Did not properly recognize 'Meta' (or 'Command') as modifier key. + - Right modifier keys did not work in WebDriver using JsonWireProtocol. + - 'Shift' + 'key' combination would not reflect actual keyboard behavior. + - Respect sequence with multiple modifier keys passed to pressKey. + - Added support to automatic change operation modifier key based on operating system. +- [Puppeteer][WebDriver] Added `pressKeyUp` and `pressKeyDown` to press and release modifier keys like `Control` or `Shift`. By @martomo. +- [Puppeteer][WebDriver] Added `grabElementBoundingRect` by @PeterNgTr. +- [Puppeteer] Fixed speed degradation introduced in #1306 with accessibility locators support. See #1953. +- Added `Config.addHook` to add a function that will update configuration on load. +- Started [`@codeceptjs/configure`](https://github.com/codeceptjs/configure) package with a collection of common configuration patterns. +- [TestCafe] port's management removed (left on TestCafe itself) by @orihomie. Fixes #1934. +- [REST] Headers are no more declared as singleton variable. Fixes #1959 +- Updated Docker image to include run tests in workers with `NUMBER_OF_WORKERS` env variable. By @PeterNgTr. ## 2.3.2 -* [Puppeteer] Fixed Puppeteer 1.20 support by @davertmik -* Fixed `run-workers` to run with complex configs. See #1887 by @nitschSB -* Added `--suites` option to `run-workers` to split suites by workers (tests of the same suite goes to teh same worker). Thanks @nitschSB. -* Added a guide on [Email Testing](https://codecept.io/email). -* [retryFailedStepPlugin] Improved to ignore wait* steps and others. Also added option to ignore this plugin per test bases. See [updated documentation](https://codecept.io/plugins#retryfailedstep). By @davertmik -* Fixed using PageObjects as classes by @Vorobeyko. See #1896 -* [WebDriver] Fixed opening more than one tab. See #1875 by @jplegoff. Fixes #1874 -* Fixed #1891 when `I.retry()` affected retries of next steps. By @davertmik +- [Puppeteer] Fixed Puppeteer 1.20 support by @davertmik +- Fixed `run-workers` to run with complex configs. See #1887 by @nitschSB +- Added `--suites` option to `run-workers` to split suites by workers (tests of the same suite goes to teh same worker). Thanks @nitschSB. +- Added a guide on [Email Testing](https://codecept.io/email). +- [retryFailedStepPlugin] Improved to ignore wait\* steps and others. Also added option to ignore this plugin per test bases. See [updated documentation](https://codecept.io/plugins#retryfailedstep). By @davertmik +- Fixed using PageObjects as classes by @Vorobeyko. See #1896 +- [WebDriver] Fixed opening more than one tab. See #1875 by @jplegoff. Fixes #1874 +- Fixed #1891 when `I.retry()` affected retries of next steps. By @davertmik ## 2.3.1 -* [MockRequest] Polly helper was renamed to MockRequest. -* [MockRequest][WebDriver] [Mocking requests](https://codecept.io/webdriver#mocking-requests) is now available in WebDriver. Thanks @radhey1851 -* [Puppeteer] Ensure configured user agent and/or window size is applied to all pages. See #1862 by @martomo -* Improve handling of xpath locators with round brackets by @nitschSB. See #1870 -* Use WebDriver capabilities config in wdio plugin. #1869 by @quekshuy +- [MockRequest] Polly helper was renamed to MockRequest. +- [MockRequest][WebDriver] [Mocking requests](https://codecept.io/webdriver#mocking-requests) is now available in WebDriver. Thanks @radhey1851 +- [Puppeteer] Ensure configured user agent and/or window size is applied to all pages. See #1862 by @martomo +- Improve handling of xpath locators with round brackets by @nitschSB. See #1870 +- Use WebDriver capabilities config in wdio plugin. #1869 by @quekshuy ## 2.3.0 - -* **[Parallel testing by workers](https://codecept.io/parallel#parallel-execution-by-workers) introduced** by @VikalpP and @davertmik. Use `run-workers` command as faster and simpler alternative to `run-multiple`. Requires NodeJS v12 +- **[Parallel testing by workers](https://codecept.io/parallel#parallel-execution-by-workers) introduced** by @VikalpP and @davertmik. Use `run-workers` command as faster and simpler alternative to `run-multiple`. Requires NodeJS v12 ``` # run all tests in parallel using 3 workers npx codeceptjs run-workers 3 ``` -* [GraphQL][GraphQLDataFactory] **Helpers for data management over GraphQL** APIs added. By @radhey1851. - * Learn how to [use GraphQL helper](https://codecept.io/data#graphql) to access GarphQL API - * And how to combine it with [GraphQLDataFactory](https://codecept.io/data#graphql-data-factory) to generate and persist test data. -* **Updated to use Mocha 6**. See #1802 by @elukoyanov -* Added `dry-run` command to print steps of test scenarios without running them. Fails to execute scenarios with `grab*` methods or custom code. See #1825 for more details. + +- [GraphQL][GraphQLDataFactory] **Helpers for data management over GraphQL** APIs added. By @radhey1851. + - Learn how to [use GraphQL helper](https://codecept.io/data#graphql) to access GarphQL API + - And how to combine it with [GraphQLDataFactory](https://codecept.io/data#graphql-data-factory) to generate and persist test data. +- **Updated to use Mocha 6**. See #1802 by @elukoyanov +- Added `dry-run` command to print steps of test scenarios without running them. Fails to execute scenarios with `grab*` methods or custom code. See #1825 for more details. ``` npx codeceptjs dry-run ``` -* [Appium] Optimization when clicking, searching for fields by accessibility id. See #1777 by @gagandeepsingh26 -* [TestCafe] Fixed `switchTo` by @KadoBOT -* [WebDriver] Added geolocation actions by @PeterNgTr - * `grabGeoLocation()` - * `setGeoLocation()` -* [Polly] Check typeof arguments for mock requests by @VikalpP. Fixes #1815 -* CLI improvements by @jamesgeorge007 - * `codeceptjs` command prints list of all available commands - * added `codeceptjs -V` flag to print version information - * warns on unknown command -* Added TypeScript files support to `run-multiple` by @z4o4z -* Fixed element position bug in locator builder. See #1829 by @AnotherAnkor -* Various TypeScript typings updates by @elukoyanov and @Vorobeyko -* Added `event.step.comment` event for all comment steps like `I.say` or gherking steps. +- [Appium] Optimization when clicking, searching for fields by accessibility id. See #1777 by @gagandeepsingh26 +- [TestCafe] Fixed `switchTo` by @KadoBOT +- [WebDriver] Added geolocation actions by @PeterNgTr + - `grabGeoLocation()` + - `setGeoLocation()` +- [Polly] Check typeof arguments for mock requests by @VikalpP. Fixes #1815 +- CLI improvements by @jamesgeorge007 + - `codeceptjs` command prints list of all available commands + - added `codeceptjs -V` flag to print version information + - warns on unknown command +- Added TypeScript files support to `run-multiple` by @z4o4z +- Fixed element position bug in locator builder. See #1829 by @AnotherAnkor +- Various TypeScript typings updates by @elukoyanov and @Vorobeyko +- Added `event.step.comment` event for all comment steps like `I.say` or gherking steps. ## 2.2.1 -* [WebDriver] A [dedicated guide](https://codecept.io/webdriver) written. -* [TestCafe] A [dedicated guide](https://codecept.io/testcafe) written. -* [Puppeteer] A [chapter on mocking](https://codecept.io/puppeteer#mocking-requests) written -* [Puppeteer][Nightmare][TestCafe] Window mode is enabled by default on `codeceptjs init`. -* [TestCafe] Actions implemented by @hubidu - * `grabPageScrollPosition` - * `scrollPageToTop` - * `scrollPageToBottom` - * `scrollTo` - * `switchTo` -* Intellisense improvements. Renamed `tsconfig.json` to `jsconfig.json` on init. Fixed autocompletion for Visual Studio Code. -* [Polly] Take configuration values from Puppeteer. Fix #1766 by @VikalpP -* [Polly] Add preconditions to check for puppeteer page availability by @VikalpP. Fixes #1767 -* [WebDriver] Use filename for `uploadFile` by @VikalpP. See #1797 -* [Puppeteer] Configure speed of input with `pressKeyDelay` option. By @hubidu -* Fixed recursive loading of support objects by @davertmik. -* Fixed support object definitions in steps.d.ts by @johnyb. Fixes #1795 -* Fixed `Data().Scenario().injectDependencies()` is not a function by @andrerleao -* Fixed crash when using xScenario & Scenario.skip with tag by @VikalpP. Fixes #1751 -* Dynamic configuration of helpers can be performed with async function. See #1786 by @cviejo -* Added TS definitions for internal objects by @Vorobeyko -* BDD improvements: - * Fix for snippets command with a .feature file that has special characters by @asselin - * Fix `--path` option on `gherkin:snippets` command by @asselin. See #1790 - * Added `--feature` option to `gherkin:snippets` to enable creating snippets for a subset of .feature files. See #1803 by @asselin. -* Fixed: dynamic configs not reset after test. Fixes #1776 by @cviejo. +- [WebDriver] A [dedicated guide](https://codecept.io/webdriver) written. +- [TestCafe] A [dedicated guide](https://codecept.io/testcafe) written. +- [Puppeteer] A [chapter on mocking](https://codecept.io/puppeteer#mocking-requests) written +- [Puppeteer][Nightmare][TestCafe] Window mode is enabled by default on `codeceptjs init`. +- [TestCafe] Actions implemented by @hubidu + - `grabPageScrollPosition` + - `scrollPageToTop` + - `scrollPageToBottom` + - `scrollTo` + - `switchTo` +- Intellisense improvements. Renamed `tsconfig.json` to `jsconfig.json` on init. Fixed autocompletion for Visual Studio Code. +- [Polly] Take configuration values from Puppeteer. Fix #1766 by @VikalpP +- [Polly] Add preconditions to check for puppeteer page availability by @VikalpP. Fixes #1767 +- [WebDriver] Use filename for `uploadFile` by @VikalpP. See #1797 +- [Puppeteer] Configure speed of input with `pressKeyDelay` option. By @hubidu +- Fixed recursive loading of support objects by @davertmik. +- Fixed support object definitions in steps.d.ts by @johnyb. Fixes #1795 +- Fixed `Data().Scenario().injectDependencies()` is not a function by @andrerleao +- Fixed crash when using xScenario & Scenario.skip with tag by @VikalpP. Fixes #1751 +- Dynamic configuration of helpers can be performed with async function. See #1786 by @cviejo +- Added TS definitions for internal objects by @Vorobeyko +- BDD improvements: + - Fix for snippets command with a .feature file that has special characters by @asselin + - Fix `--path` option on `gherkin:snippets` command by @asselin. See #1790 + - Added `--feature` option to `gherkin:snippets` to enable creating snippets for a subset of .feature files. See #1803 by @asselin. +- Fixed: dynamic configs not reset after test. Fixes #1776 by @cviejo. ## 2.2.0 -* **EXPERIMENTAL** [**TestCafe** helper](https://codecept.io/helpers/TestCafe) introduced. TestCafe allows to run cross-browser tests it its own very fast engine. Supports all browsers including mobile. Thanks to @hubidu for implementation! Please test it and send us feedback. -* [Puppeteer] Mocking requests enabled by introducing [Polly.js helper](https://codecept.io/helpers/Polly). Thanks @VikalpP +- **EXPERIMENTAL** [**TestCafe** helper](https://codecept.io/helpers/TestCafe) introduced. TestCafe allows to run cross-browser tests it its own very fast engine. Supports all browsers including mobile. Thanks to @hubidu for implementation! Please test it and send us feedback. +- [Puppeteer] Mocking requests enabled by introducing [Polly.js helper](https://codecept.io/helpers/Polly). Thanks @VikalpP ```js // use Polly & Puppeteer helpers -I.mockRequest('GET', '/api/users', 200); -I.mockRequest('POST', '/users', { user: { name: 'fake' }}); -``` - -* **EXPERIMENTAL** [Puppeteer] [Firefox support](https://codecept.io/helpers/Puppeteer-firefox) introduced by @ngadiyak, see #1740 -* [stepByStepReportPlugin] use md5 hash to generate reports into unique folder. Fix #1744 by @chimurai -* Interactive pause improvements: - * print result of `grab` commands - * print message for successful assertions -* `run-multiple` (parallel execution) improvements: - * `bootstrapAll` must be called before creating chunks. #1741 by @Vorobeyko - * Bugfix: If value in config has falsy value then multiple config does not overwrite original value. #1756 by @LukoyanovE -* Fixed hooks broken in 2.1.5 by @Vorobeyko -* Fix references to support objects when using Dependency Injection. Fix by @johnyb. See #1701 -* Fix dynamic config applied for multiple helpers by @VikalpP #1743 - +I.mockRequest('GET', '/api/users', 200) +I.mockRequest('POST', '/users', { user: { name: 'fake' } }) +``` + +- **EXPERIMENTAL** [Puppeteer] [Firefox support](https://codecept.io/helpers/Puppeteer-firefox) introduced by @ngadiyak, see #1740 +- [stepByStepReportPlugin] use md5 hash to generate reports into unique folder. Fix #1744 by @chimurai +- Interactive pause improvements: + - print result of `grab` commands + - print message for successful assertions +- `run-multiple` (parallel execution) improvements: + - `bootstrapAll` must be called before creating chunks. #1741 by @Vorobeyko + - Bugfix: If value in config has falsy value then multiple config does not overwrite original value. #1756 by @LukoyanovE +- Fixed hooks broken in 2.1.5 by @Vorobeyko +- Fix references to support objects when using Dependency Injection. Fix by @johnyb. See #1701 +- Fix dynamic config applied for multiple helpers by @VikalpP #1743 ## 2.1.5 -* **EXPERIMENTAL** [Wix Detox support](https://github.com/codeceptjs/detox-helper) introduced as standalone helper. Provides a faster alternative to Appium for mobile testing. -* Saving successful commands inside interactive pause into `_output/cli-history` file. By @hubidu -* Fixed hanging error handler inside scenario. See #1721 by @haily-lgc. -* Fixed by @Vorobeyko: tests did not fail when an exception was raised in async bootstrap. -* [WebDriver] Added window control methods by @emmonspired - * `grabAllWindowHandles` returns all window handles - * `grabCurrentWindowHandle` returns current window handle - * `switchToWindow` switched to window by its handle -* [Appium] Fixed using `host` as configuration by @trinhpham -* Fixed `run-multiple` command when `tests` config option is undefined (in Gherkin scenarios). By @gkushang. -* German translation introduced by @hubidu +- **EXPERIMENTAL** [Wix Detox support](https://github.com/codeceptjs/detox-helper) introduced as standalone helper. Provides a faster alternative to Appium for mobile testing. +- Saving successful commands inside interactive pause into `_output/cli-history` file. By @hubidu +- Fixed hanging error handler inside scenario. See #1721 by @haily-lgc. +- Fixed by @Vorobeyko: tests did not fail when an exception was raised in async bootstrap. +- [WebDriver] Added window control methods by @emmonspired + - `grabAllWindowHandles` returns all window handles + - `grabCurrentWindowHandle` returns current window handle + - `switchToWindow` switched to window by its handle +- [Appium] Fixed using `host` as configuration by @trinhpham +- Fixed `run-multiple` command when `tests` config option is undefined (in Gherkin scenarios). By @gkushang. +- German translation introduced by @hubidu ## 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/mobile-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. +- [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/mobile-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 -* Fixed using `toString()` in DataTablewhen it is defined by @tsuemura +- Fixed autoLogin plugin to inject `login` function +- Fixed using `toString()` in DataTablewhen it is defined by @tsuemura ## 2.1.2 -* Fixed `inject` to load objects recursively. -* Fixed TypeScript definitions for locators by @LukoyanovE -* **EXPERIMENTAL** [WebDriver] ReactJS locators support with webdriverio v5.8+: +- Fixed `inject` to load objects recursively. +- Fixed TypeScript definitions for locators by @LukoyanovE +- **EXPERIMENTAL** [WebDriver] ReactJS locators support with webdriverio v5.8+: ```js // locating React element by name, prop, state -I.click({ react: 'component-name', props: {}, state: {} }); -I.seeElement({ react: 'component-name', props: {}, state: {} }); +I.click({ react: 'component-name', props: {}, state: {} }) +I.seeElement({ react: 'component-name', props: {}, state: {} }) ``` ## 2.1.1 -* Do not retry `within` and `session` calls inside `retryFailedStep` plugin. Fix by @tsuemura +- Do not retry `within` and `session` calls inside `retryFailedStep` plugin. Fix by @tsuemura ## 2.1.0 -* Added global `inject()` function to require actor and page objects using dependency injection. Recommended to use in page objects, step definition files, support objects: +- Added global `inject()` function to require actor and page objects using dependency injection. Recommended to use in page objects, step definition files, support objects: ```js // old way -const I = actor(); -const myPage = require('../page/myPage'); +const I = actor() +const myPage = require('../page/myPage') // new way -const { I, myPage } = inject(); +const { I, myPage } = inject() ``` -* Added global `secret` function to fill in sensitive data. By @RohanHart: +- Added global `secret` function to fill in sensitive data. By @RohanHart: ```js -I.fillField('password', secret('123456')); -``` - -* [wdioPlugin](https://codecept.io/plugins/#wdio) Added a plugin to **support webdriverio services** including *selenium-standalone*, *sauce*, *browserstack*, etc. **Sponsored by @GSasu** -* [Appium] Fixed `swipe*` methods by @PeterNgTr -* BDD Gherkin Improvements: - * Implemented `run-multiple` for feature files. **Sponsored by @GSasu** - * Added `--features` and `--tests` options to `run-multiple`. **Sponsored by @GSasu** - * Implemented `Before` and `After` hooks in [step definitions](https://codecept.io/bdd#before) -* Fixed running tests by absolute path. By @batalov. -* Enabled the adding screenshot to failed test for moch-junit-reporter by @PeterNgTr. -* [Puppeteer] Implemented `uncheckOption` and fixed behavior of `checkOption` by @aml2610 -* [WebDriver] Fixed `seeTextEquals` on empty strings by @PeterNgTr -* [Puppeteer] Fixed launch with `browserWSEndpoint` config by @ngadiyak. -* [Puppeteer] Fixed switching back to main window in multi-session mode by @davertmik. -* [autoLoginPlugin] Fixed using async functions for auto login by @nitschSB +I.fillField('password', secret('123456')) +``` + +- [wdioPlugin](https://codecept.io/plugins/#wdio) Added a plugin to **support webdriverio services** including _selenium-standalone_, _sauce_, _browserstack_, etc. **Sponsored by @GSasu** +- [Appium] Fixed `swipe*` methods by @PeterNgTr +- BDD Gherkin Improvements: + - Implemented `run-multiple` for feature files. **Sponsored by @GSasu** + - Added `--features` and `--tests` options to `run-multiple`. **Sponsored by @GSasu** + - Implemented `Before` and `After` hooks in [step definitions](https://codecept.io/bdd#before) +- Fixed running tests by absolute path. By @batalov. +- Enabled the adding screenshot to failed test for moch-junit-reporter by @PeterNgTr. +- [Puppeteer] Implemented `uncheckOption` and fixed behavior of `checkOption` by @aml2610 +- [WebDriver] Fixed `seeTextEquals` on empty strings by @PeterNgTr +- [Puppeteer] Fixed launch with `browserWSEndpoint` config by @ngadiyak. +- [Puppeteer] Fixed switching back to main window in multi-session mode by @davertmik. +- [autoLoginPlugin] Fixed using async functions for auto login by @nitschSB > This release was partly sponsored by @GSasu. Thanks for the support! -Do you want to improve this project? [Learn more about sponsorin CodeceptJS - +> Do you want to improve this project? [Learn more about sponsorin CodeceptJS ## 2.0.8 -* [Puppeteer] Added `downloadFile` action by @PeterNgTr. +- [Puppeteer] Added `downloadFile` action by @PeterNgTr. Use it with `FileSystem` helper to test availability of a file: + ```js - const fileName = await I.downloadFile('a.file-link'); - I.amInPath('output'); - I.seeFile(fileName); +const fileName = await I.downloadFile('a.file-link') +I.amInPath('output') +I.seeFile(fileName) ``` + > Actions `amInPath` and `seeFile` are taken from [FileSystem](https://codecept.io/helpers/FileSystem) helper -* [Puppeteer] Fixed `autoLogin` plugin with Puppeteer by @davertmik -* [WebDriver] `seeInField` should throw error if element has no value attrubite. By @PeterNgTr -* [WebDriver] Fixed `seeTextEquals` passes for any string if element is empty by @PeterNgTr. -* [WebDriver] Internal refctoring to use `el.isDisplayed` to match latest webdriverio implementation. Thanks to @LukoyanovE -* [allure plugin] Add ability enable [screenshotDiff plugin](https://github.com/allure-framework/allure2/blob/master/plugins/screen-diff-plugin/README.md) by @Vorobeyko -* [Appium] Fixed `locator.stringify` call by @LukoyanovE +- [Puppeteer] Fixed `autoLogin` plugin with Puppeteer by @davertmik +- [WebDriver] `seeInField` should throw error if element has no value attrubite. By @PeterNgTr +- [WebDriver] Fixed `seeTextEquals` passes for any string if element is empty by @PeterNgTr. +- [WebDriver] Internal refctoring to use `el.isDisplayed` to match latest webdriverio implementation. Thanks to @LukoyanovE +- [allure plugin] Add ability enable [screenshotDiff plugin](https://github.com/allure-framework/allure2/blob/master/plugins/screen-diff-plugin/README.md) by @Vorobeyko +- [Appium] Fixed `locator.stringify` call by @LukoyanovE ## 2.0.7 -* [WebDriver][Protractor][Nightmare] `rightClick` method implemented (fixed) in a standard way. By @davertmik -* [WebDriver] Updated WebDriver API calls in helper. By @PeterNgTr -* [stepByStepReportPlugin] Added `screenshotsForAllureReport` config options to automatically attach screenshots to allure reports. By @PeterNgTr -* [allurePlugin] Added `addLabel` method by @Vorobeyko -* Locator Builder: fixed `withChild` and `withDescendant` to match deep nested siblings by @Vorobeyko. +- [WebDriver][Protractor][Nightmare] `rightClick` method implemented (fixed) in a standard way. By @davertmik +- [WebDriver] Updated WebDriver API calls in helper. By @PeterNgTr +- [stepByStepReportPlugin] Added `screenshotsForAllureReport` config options to automatically attach screenshots to allure reports. By @PeterNgTr +- [allurePlugin] Added `addLabel` method by @Vorobeyko +- Locator Builder: fixed `withChild` and `withDescendant` to match deep nested siblings by @Vorobeyko. ## 2.0.6 -* Introduced [Custom Locator Strategies](https://codecept.io/locators#custom-locators). -* Added [Visual Testing Guide](https://codecept.io/visual) by @puneet0191 and @MitkoTschimev. -* [Puppeteer] [`puppeteerCoverage`](https://codecept.io/plugins#puppeteercoverage) plugin added to collect code coverage in JS. By @dvillarama -* Make override option in `run-multiple` to respect the generated overridden config by @kinyat -* Fixed deep merge for `container.append()`. Introduced `lodash.merge()`. By @Vorobeyko -* Fixed saving screenshot on Windows by -* Fix errors on using interactive shell with Allure plugin by tsuemura -* Fixed using dynamic injections with `Scenario().injectDependencies` by @tsemura -* [WebDriver][Puppeteer][Nightmare][Protractor] Fixed url protocol detection for non-http urls by @LukoyanovE -* [WebDriver] Enabled compatibility with `stepByStepReport` by @tsuemura -* [WebDriver] Fixed `grabHTMLFrom` to return innerHTML value by @Holorium. Fixed compatibility with WebDriverIO. -* [WebDriver] `grabHTMLFrom` to return one HTML vlaue for one element matched, array if multiple elements found by @davertmik. -* [Nightmare] Added `grabHTMLFrom` by @davertmik -* Fixed `bootstrapAll` and `teardownAll` launch with path as argument by @LukoyanovE -* Fixed `bootstrapAll` and `teardownAll` calls from exported object by @LukoyanovE -* [WebDriver] Added possibility to define conditional checks interval for `waitUntil` by @LukoyanovE -* Fixed storing current data in data driven tests in a test object. By @Vorobeyko -* [WebDriver] Fixed `hostname` config option overwrite when setting a cloud provider. By @LukoyanovE -* [WebDriver] `dragSlider` method implemented by @DavertMik -* [WebDrover] Fixed `scrollTo` to use new webdriverio API by @PeterNgTr -* Added Japanese translation file by @tsemura -* Added `Locator.withDescendant()` method to find an element which contains a descendant (child, grandchild) by @Vorobeyko -* [WebDriver] Fixed configuring capabilities for Selenoid and IE by @Vorobeyko -* [WebDriver] Restore original window size when taking full size screenshot by @tsuemura -* Enabled `throws()`,` fails()`, `retry()`, `timeout()`, `config()` functions for data driven tests. By @jjm409 +- Introduced [Custom Locator Strategies](https://codecept.io/locators#custom-locators). +- Added [Visual Testing Guide](https://codecept.io/visual) by @puneet0191 and @MitkoTschimev. +- [Puppeteer] [`puppeteerCoverage`](https://codecept.io/plugins#puppeteercoverage) plugin added to collect code coverage in JS. By @dvillarama +- Make override option in `run-multiple` to respect the generated overridden config by @kinyat +- Fixed deep merge for `container.append()`. Introduced `lodash.merge()`. By @Vorobeyko +- Fixed saving screenshot on Windows by +- Fix errors on using interactive shell with Allure plugin by tsuemura +- Fixed using dynamic injections with `Scenario().injectDependencies` by @tsemura +- [WebDriver][Puppeteer][Nightmare][Protractor] Fixed url protocol detection for non-http urls by @LukoyanovE +- [WebDriver] Enabled compatibility with `stepByStepReport` by @tsuemura +- [WebDriver] Fixed `grabHTMLFrom` to return innerHTML value by @Holorium. Fixed compatibility with WebDriverIO. +- [WebDriver] `grabHTMLFrom` to return one HTML vlaue for one element matched, array if multiple elements found by @davertmik. +- [Nightmare] Added `grabHTMLFrom` by @davertmik +- Fixed `bootstrapAll` and `teardownAll` launch with path as argument by @LukoyanovE +- Fixed `bootstrapAll` and `teardownAll` calls from exported object by @LukoyanovE +- [WebDriver] Added possibility to define conditional checks interval for `waitUntil` by @LukoyanovE +- Fixed storing current data in data driven tests in a test object. By @Vorobeyko +- [WebDriver] Fixed `hostname` config option overwrite when setting a cloud provider. By @LukoyanovE +- [WebDriver] `dragSlider` method implemented by @DavertMik +- [WebDrover] Fixed `scrollTo` to use new webdriverio API by @PeterNgTr +- Added Japanese translation file by @tsemura +- Added `Locator.withDescendant()` method to find an element which contains a descendant (child, grandchild) by @Vorobeyko +- [WebDriver] Fixed configuring capabilities for Selenoid and IE by @Vorobeyko +- [WebDriver] Restore original window size when taking full size screenshot by @tsuemura +- Enabled `throws()`,` fails()`, `retry()`, `timeout()`, `config()` functions for data driven tests. By @jjm409 ## 2.0.5 @@ -2956,60 +3472,58 @@ Use it with `FileSystem` helper to test availability of a file: ## 2.0.4 -* [WebDriver][Protractor][Nightmare][Puppeteer] `grabAttributeFrom` returns an array when multiple elements matched. By @PeterNgTr -* [autoLogin plugin] Fixed merging users config by @nealfennimore -* [autoDelay plugin] Added WebDriver to list of supported helpers by @mattin4d -* [Appium] Fixed using locators in `waitForElement`, `waitForVisible`, `waitForInvisible`. By @eduardofinotti -* [allure plugin] Add tags to allure reports by @Vorobeyko -* [allure plugin] Add skipped tests to allure reports by @Vorobeyko -* Fixed `Logged Test name | [object Object]` when used Data().Scenario(). By @Vorobeyko -* Fixed Data().only.Scenario() to run for all datasets. By @Vorobeyko -* [WebDriver] `attachFile` to work with hidden elements. Fixed in #1460 by @tsuemura - - +- [WebDriver][Protractor][Nightmare][Puppeteer] `grabAttributeFrom` returns an array when multiple elements matched. By @PeterNgTr +- [autoLogin plugin] Fixed merging users config by @nealfennimore +- [autoDelay plugin] Added WebDriver to list of supported helpers by @mattin4d +- [Appium] Fixed using locators in `waitForElement`, `waitForVisible`, `waitForInvisible`. By @eduardofinotti +- [allure plugin] Add tags to allure reports by @Vorobeyko +- [allure plugin] Add skipped tests to allure reports by @Vorobeyko +- Fixed `Logged Test name | [object Object]` when used Data().Scenario(). By @Vorobeyko +- Fixed Data().only.Scenario() to run for all datasets. By @Vorobeyko +- [WebDriver] `attachFile` to work with hidden elements. Fixed in #1460 by @tsuemura ## 2.0.3 -* [**autoLogin plugin**](https://codecept.io/plugins#autologin) added. Allows to log in once and reuse browser session. When session expires - automatically logs in again. Can persist session between runs by saving cookies to file. -* Fixed `Maximum stack trace` issue in `retryFailedStep` plugin. -* Added `locate()` function into the interactive shell. -* [WebDriver] Disabled smartWait for interactive shell. -* [Appium] Updated methods to use for mobile locators - * `waitForElement` - * `waitForVisible` - * `waitForInvisible` -* Helper and page object generators no longer update config automatically. Please add your page objects and helpers manually. +- [**autoLogin plugin**](https://codecept.io/plugins#autologin) added. Allows to log in once and reuse browser session. When session expires - automatically logs in again. Can persist session between runs by saving cookies to file. +- Fixed `Maximum stack trace` issue in `retryFailedStep` plugin. +- Added `locate()` function into the interactive shell. +- [WebDriver] Disabled smartWait for interactive shell. +- [Appium] Updated methods to use for mobile locators + - `waitForElement` + - `waitForVisible` + - `waitForInvisible` +- Helper and page object generators no longer update config automatically. Please add your page objects and helpers manually. ## 2.0.2 -* [Puppeteer] Improved handling of connection with remote browser using Puppeteer by @martomo -* [WebDriver] Updated to webdriverio 5.2.2 by @martomo -* Interactive pause improvements by @davertmik - * Disable retryFailedStep plugin in in interactive mode - * Removes `Interface: parseInput` while in interactive pause -* [ApiDataFactory] Improvements - * added `fetchId` config option to override id retrieval from payload - * added `onRequest` config option to update request in realtime - * added `returnId` config option to return ids of created items instead of items themvelves - * added `headers` config option to override default headers. - * added a new chapter into [DataManagement](https://codecept.io/data#api-requests-using-browser-session) -* [REST] Added `onRequest` config option - +- [Puppeteer] Improved handling of connection with remote browser using Puppeteer by @martomo +- [WebDriver] Updated to webdriverio 5.2.2 by @martomo +- Interactive pause improvements by @davertmik + - Disable retryFailedStep plugin in in interactive mode + - Removes `Interface: parseInput` while in interactive pause +- [ApiDataFactory] Improvements + - added `fetchId` config option to override id retrieval from payload + - added `onRequest` config option to update request in realtime + - added `returnId` config option to return ids of created items instead of items themvelves + - added `headers` config option to override default headers. + - added a new chapter into [DataManagement](https://codecept.io/data#api-requests-using-browser-session) +- [REST] Added `onRequest` config option ## 2.0.1 -* Fixed creating project with `codecept init`. -* Fixed error while installing webdriverio@5. -* Added code beautifier for generated configs. -* [WebDriver] Updated to webdriverio 5.1.0 +- Fixed creating project with `codecept init`. +- Fixed error while installing webdriverio@5. +- Added code beautifier for generated configs. +- [WebDriver] Updated to webdriverio 5.1.0 ## 2.0.0 -* [WebDriver] **Breaking Change.** Updated to webdriverio v5. New helper **WebDriver** helper introduced. +- [WebDriver] **Breaking Change.** Updated to webdriverio v5. New helper **WebDriver** helper introduced. - * **Upgrade plan**: + - **Upgrade plan**: 1. Install latest webdriverio + ``` npm install webdriverio@5 --save ``` @@ -3020,138 +3534,139 @@ Use it with `FileSystem` helper to test availability of a file: > If you face issues using webdriverio v5 you can still use webdriverio 4.x and WebDriverIO helper. Make sure you have `webdriverio: ^4.0` installed. - * Known issues: `attachFile` doesn't work with proxy server. + - Known issues: `attachFile` doesn't work with proxy server. -* [Appium] **Breaking Change.** Updated to use webdriverio v5 as well. See upgrade plan ↑ -* [REST] **Breaking Change.** Replaced `unirest` library with `axios`. +- [Appium] **Breaking Change.** Updated to use webdriverio v5 as well. See upgrade plan ↑ +- [REST] **Breaking Change.** Replaced `unirest` library with `axios`. - * **Upgrade plan**: + - **Upgrade plan**: 1. Refer to [axios API](https://github.com/axios/axios). 2. If you were using `unirest` requests/responses in your tests change them to axios format. -* **Breaking Change.** Generators support in tests removed. Use `async/await` in your tests -* **Using `codecept.conf.js` as default configuration format** -* Fixed "enametoolong" error when saving screenshots for data driven tests by @PeterNgTr -* Updated NodeJS to 10 in Docker image -* [Pupeteer] Add support to use WSEndpoint. Allows to execute tests remotely. [See #1350] by @gabrielcaires (https://github.com/codeceptjs/CodeceptJS/pull/1350) -* In interactive shell [Enter] goes to next step. Improvement by @PeterNgTr. -* `I.say` accepts second parameter as color to print colorful comments. Improvement by @PeterNgTr. + +- **Breaking Change.** Generators support in tests removed. Use `async/await` in your tests +- **Using `codecept.conf.js` as default configuration format** +- Fixed "enametoolong" error when saving screenshots for data driven tests by @PeterNgTr +- Updated NodeJS to 10 in Docker image +- [Pupeteer] Add support to use WSEndpoint. Allows to execute tests remotely. [See #1350] by @gabrielcaires (https://github.com/codeceptjs/CodeceptJS/pull/1350) +- In interactive shell [Enter] goes to next step. Improvement by @PeterNgTr. +- `I.say` accepts second parameter as color to print colorful comments. Improvement by @PeterNgTr. ```js -I.say('This is red', 'red'); //red is used -I.say('This is blue', 'blue'); //blue is used -I.say('This is by default'); //cyan is used +I.say('This is red', 'red') //red is used +I.say('This is blue', 'blue') //blue is used +I.say('This is by default') //cyan is used ``` -* Fixed allure reports for multi session testing by @PeterNgTr -* Fixed allure reports for hooks by @PeterNgTr + +- Fixed allure reports for multi session testing by @PeterNgTr +- Fixed allure reports for hooks by @PeterNgTr ## 1.4.6 -* [Puppeteer] `dragSlider` action added by @PeterNgTr -* [Puppeteer] Fixed opening browser in shell mode by @allenhwkim -* [Puppeteer] Fixed making screenshot on additional sessions by @PeterNgTr. Fixes #1266 -* Added `--invert` option to `run-multiple` command by @LukoyanovE -* Fixed steps in Allure reports by @PeterNgTr -* Add option `output` to customize output directory in [stepByStepReport plugin](https://codecept.io/plugins/#stepbystepreport). By @fpsthirty -* Changed type definition of PageObjects to get auto completion by @rhicu -* Fixed steps output for async/arrow functions in CLI by @LukoyanovE. See #1329 +- [Puppeteer] `dragSlider` action added by @PeterNgTr +- [Puppeteer] Fixed opening browser in shell mode by @allenhwkim +- [Puppeteer] Fixed making screenshot on additional sessions by @PeterNgTr. Fixes #1266 +- Added `--invert` option to `run-multiple` command by @LukoyanovE +- Fixed steps in Allure reports by @PeterNgTr +- Add option `output` to customize output directory in [stepByStepReport plugin](https://codecept.io/plugins/#stepbystepreport). By @fpsthirty +- Changed type definition of PageObjects to get auto completion by @rhicu +- Fixed steps output for async/arrow functions in CLI by @LukoyanovE. See #1329 ## 1.4.5 -* Add **require** param to main config. Allows to require Node modules before executing tests. By @LukoyanovE. For example: - * Use `ts-node/register` to register TypeScript parser - * Use `should` to register should-style assertions +- Add **require** param to main config. Allows to require Node modules before executing tests. By @LukoyanovE. For example: + - Use `ts-node/register` to register TypeScript parser + - Use `should` to register should-style assertions ```js "require": ["ts-node/register", "should"] ``` -* [WebDriverIO] Fix timeouts definition to be compatible with W3C drivers. By @LukoyanovE -* Fixed: exception in Before block w/ Mocha causes test not to report failure. See #1292 by @PeterNgTr -* Command `run-parallel` now accepts `--override` flag. Thanks to @ClemCB -* Fixed Allure report with Before/BeforeSuite/After/AfterSuite steps. By @PeterNgTr -* Added `RUN_MULTIPLE` env variable to [Docker config](https://codecept.io/docker/). Allows to run tests in parallel inside a container. Thanks to @PeterNgTr -* [Mochawesome] Fixed showing screenshot on failure. Fix by @PeterNgTr -* Fixed running tests filtering by tag names defined via `Scenario.tag()` +- [WebDriverIO] Fix timeouts definition to be compatible with W3C drivers. By @LukoyanovE +- Fixed: exception in Before block w/ Mocha causes test not to report failure. See #1292 by @PeterNgTr +- Command `run-parallel` now accepts `--override` flag. Thanks to @ClemCB +- Fixed Allure report with Before/BeforeSuite/After/AfterSuite steps. By @PeterNgTr +- Added `RUN_MULTIPLE` env variable to [Docker config](https://codecept.io/docker/). Allows to run tests in parallel inside a container. Thanks to @PeterNgTr +- [Mochawesome] Fixed showing screenshot on failure. Fix by @PeterNgTr +- Fixed running tests filtering by tag names defined via `Scenario.tag()` ## 1.4.4 -* [autoDelay plugin](https://codecept.io/plugins/#autoDelay) added. Adds tiny delay before and after an action so the page could react to actions performed. -* [Puppeteer] improvements by @luismanuel001 - * `click` no longer waits for navigation - * `clickLink` method added. Performs a click and waits for navigation. -* Bootstrap scripts to be started only for `run` command and ignored on `list`, `def`, etc. Fix by @LukoyanovE - +- [autoDelay plugin](https://codecept.io/plugins/#autoDelay) added. Adds tiny delay before and after an action so the page could react to actions performed. +- [Puppeteer] improvements by @luismanuel001 + - `click` no longer waits for navigation + - `clickLink` method added. Performs a click and waits for navigation. +- Bootstrap scripts to be started only for `run` command and ignored on `list`, `def`, etc. Fix by @LukoyanovE ## 1.4.3 -* Groups renamed to Tags for compatibility with BDD layer -* Test and suite objects to contain tags property which can be accessed from internal API -* Fixed adding tags for Scenario Outline in BDD -* Added `tag()` method to ScenarioConfig and FeatureConfig: +- Groups renamed to Tags for compatibility with BDD layer +- Test and suite objects to contain tags property which can be accessed from internal API +- Fixed adding tags for Scenario Outline in BDD +- Added `tag()` method to ScenarioConfig and FeatureConfig: ```js Scenario('update user profile', () => { // test goes here -}).tag('@slow'); +}).tag('@slow') ``` -* Fixed attaching Allure screenshot on exception. Fix by @DevinWatson -* Improved type definitions for custom steps. By @Akxe -* Fixed setting `multiple.parallel.chunks` as environment variable in config. See #1238 by @ngadiyak +- Fixed attaching Allure screenshot on exception. Fix by @DevinWatson +- Improved type definitions for custom steps. By @Akxe +- Fixed setting `multiple.parallel.chunks` as environment variable in config. See #1238 by @ngadiyak ## 1.4.2 -* Fixed setting config for plugins (inclunding setting `outputDir` for allure) by @jplegoff +- Fixed setting config for plugins (inclunding setting `outputDir` for allure) by @jplegoff ## 1.4.1 -* Added `plugins` option to `run-multiple` -* Minor output fixes -* Added Type Definition for Helper class by @Akxe -* Fixed extracing devault extension in generators by @Akxe +- Added `plugins` option to `run-multiple` +- Minor output fixes +- Added Type Definition for Helper class by @Akxe +- Fixed extracing devault extension in generators by @Akxe ## 1.4.0 -* [**Allure Reporter Integration**](https://codecept.io/reports/#allure). Full inegration with Allure Server. Get nicely looking UI for tests,including steps, nested steps, and screenshots. Thanks **Natarajan Krishnamurthy @krish** for sponsoring this feature. -* [Plugins API introduced](https://codecept.io/hooks/#plugins). Create custom plugins for CodeceptJS by hooking into event dispatcher, and using promise recorder. -* **Official [CodeceptJS plugins](https://codecept.io/plugins) added**: - * **`stepByStepReport` - creates nicely looking report to see test execution as a slideshow**. Use this plugin to debug tests in headless environment without recording a video. - * `allure` - Allure reporter added as plugin. - * `screenshotOnFail` - saves screenshot on fail. Replaces similar functionality from helpers. - * `retryFailedStep` - to rerun each failed step. -* [Puppeteer] Fix `executeAsyncScript` unexpected token by @jonathanz -* Added `override` option to `run-multiple` command by @svarlet +- [**Allure Reporter Integration**](https://codecept.io/reports/#allure). Full inegration with Allure Server. Get nicely looking UI for tests,including steps, nested steps, and screenshots. Thanks **Natarajan Krishnamurthy @krish** for sponsoring this feature. +- [Plugins API introduced](https://codecept.io/hooks/#plugins). Create custom plugins for CodeceptJS by hooking into event dispatcher, and using promise recorder. +- **Official [CodeceptJS plugins](https://codecept.io/plugins) added**: + - **`stepByStepReport` - creates nicely looking report to see test execution as a slideshow**. Use this plugin to debug tests in headless environment without recording a video. + - `allure` - Allure reporter added as plugin. + - `screenshotOnFail` - saves screenshot on fail. Replaces similar functionality from helpers. + - `retryFailedStep` - to rerun each failed step. +- [Puppeteer] Fix `executeAsyncScript` unexpected token by @jonathanz +- Added `override` option to `run-multiple` command by @svarlet ## 1.3.3 -* Added `initGlobals()` function to API of [custom runner](https://codecept.io/hooks/#custom-runner). +- Added `initGlobals()` function to API of [custom runner](https://codecept.io/hooks/#custom-runner). ## 1.3.2 -* Interactve Shell improvements for `pause()` - * Added `next` command for **step-by-step debug** when using `pause()`. - * Use `After(pause);` in a to start interactive console after last step. -* [Puppeteer] Updated to Puppeteer 1.6.0 - * Added `waitForRequest` to wait for network request. - * Added `waitForResponse` to wait for network response. -* Improved TypeScript definitions to support custom steps and page objects. By @xt1 -* Fixed XPath detection to accept XPath which starts with `./` by @BenoitZugmeyer +- Interactve Shell improvements for `pause()` + - Added `next` command for **step-by-step debug** when using `pause()`. + - Use `After(pause);` in a to start interactive console after last step. +- [Puppeteer] Updated to Puppeteer 1.6.0 + - Added `waitForRequest` to wait for network request. + - Added `waitForResponse` to wait for network response. +- Improved TypeScript definitions to support custom steps and page objects. By @xt1 +- Fixed XPath detection to accept XPath which starts with `./` by @BenoitZugmeyer ## 1.3.1 -* BDD-Gherkin: Fixed running async steps. -* [Puppeteer] Fixed process hanging for 30 seconds. Page loading timeout default via `getPageTimeout` set 0 seconds. -* [Puppeteer] Improved displaying client-side console messages in debug mode. -* [Puppeteer] Fixed closing sessions in `restart:false` mode for multi-session mode. -* [Protractor] Fixed `grabPopupText` to not throw error popup is not opened. -* [Protractor] Added info on using 'direct' Protractor driver to helper documentation by @xt1. -* [WebDriverIO] Added a list of all special keys to WebDriverIO helper by @davertmik and @xt1. -* Improved TypeScript definitions generator by @xt1 +- BDD-Gherkin: Fixed running async steps. +- [Puppeteer] Fixed process hanging for 30 seconds. Page loading timeout default via `getPageTimeout` set 0 seconds. +- [Puppeteer] Improved displaying client-side console messages in debug mode. +- [Puppeteer] Fixed closing sessions in `restart:false` mode for multi-session mode. +- [Protractor] Fixed `grabPopupText` to not throw error popup is not opened. +- [Protractor] Added info on using 'direct' Protractor driver to helper documentation by @xt1. +- [WebDriverIO] Added a list of all special keys to WebDriverIO helper by @davertmik and @xt1. +- Improved TypeScript definitions generator by @xt1 ## 1.3.0 -* **Cucumber-style BDD. Introduced [Gherkin support](https://codecept.io/bdd). Thanks to [David Vins](https://github.com/dvins) and [Omedym](https://www.omedym.com) for sponsoring this feature**. +- **Cucumber-style BDD. Introduced [Gherkin support](https://codecept.io/bdd). Thanks to [David Vins](https://github.com/dvins) and [Omedym](https://www.omedym.com) for sponsoring this feature**. Basic feature file: @@ -3168,11 +3683,11 @@ Feature: Business rules Step definition: ```js -const I = actor(); +const I = actor() Given('I need to open Google', () => { - I.amOnPage('https://google.com'); -}); + I.amOnPage('https://google.com') +}) ``` Run it with `--features --steps` flag: @@ -3183,66 +3698,68 @@ codeceptjs run --steps --features --- -* **Brekaing Chnage** `run` command now uses relative path + test name to run exactly one test file. +- **Brekaing Chnage** `run` command now uses relative path + test name to run exactly one test file. Previous behavior (removed): + ``` codeceptjs run basic_test.js ``` + Current behavior (relative path to config + a test name) ``` codeceptjs run tests/basic_test.js ``` + This change allows using auto-completion when running a specific test. --- -* Nested steps output enabled for page objects. - * to see high-level steps only run tests with `--steps` flag. - * to see PageObjects implementation run tests with `--debug`. -* PageObjects simplified to remove `_init()` extra method. Try updated generators and see [updated guide](https://codecept.io/pageobjects/#pageobject). -* [Puppeteer] [Multiple sessions](https://codecept.io/acceptance/#multiple-sessions) enabled. Requires Puppeteer >= 1.5 -* [Puppeteer] Stability improvement. Waits for for `load` event on page load. This strategy can be changed in config: - * `waitForNavigation` config option introduced. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions) - * `getPageTimeout` config option to set maximum navigation time in milliseconds. Default is 30 seconds. - * `waitForNavigation` method added. Explicitly waits for navigation to be finished. -* [WebDriverIO][Protractor][Puppeteer][Nightmare] **Possible BC** `grabTextFrom` unified. Return a text for single matched element and an array of texts for multiple elements. -* [Puppeteer]Fixed `resizeWindow` by @sergejkaravajnij -* [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForFunction` added. Waits for client-side JavaScript function to return true by @GREENpoint. -* [Puppeteer] `waitUntil` deprecated in favor of `waitForFunction`. -* Added `filter` function to DataTable. -* Send non-nested array of files to custom parallel execution chunking by @mikecbrant. -* Fixed invalid output directory path for run-multiple by @mikecbrant. -* [WebDriverIO] `waitUntil` timeout accepts time in seconds (as all other wait* functions). Fix by @truesrc. -* [Nightmare] Fixed `grabNumberOfVisibleElements` to work similarly to `seeElement`. Thx to @stefanschenk and Jinbo Jinboson. -* [Protractor] Fixed alert handling error with message 'no such alert' by @truesrc. - +- Nested steps output enabled for page objects. + - to see high-level steps only run tests with `--steps` flag. + - to see PageObjects implementation run tests with `--debug`. +- PageObjects simplified to remove `_init()` extra method. Try updated generators and see [updated guide](https://codecept.io/pageobjects/#pageobject). +- [Puppeteer] [Multiple sessions](https://codecept.io/acceptance/#multiple-sessions) enabled. Requires Puppeteer >= 1.5 +- [Puppeteer] Stability improvement. Waits for for `load` event on page load. This strategy can be changed in config: + - `waitForNavigation` config option introduced. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions) + - `getPageTimeout` config option to set maximum navigation time in milliseconds. Default is 30 seconds. + - `waitForNavigation` method added. Explicitly waits for navigation to be finished. +- [WebDriverIO][Protractor][Puppeteer][Nightmare] **Possible BC** `grabTextFrom` unified. Return a text for single matched element and an array of texts for multiple elements. +- [Puppeteer]Fixed `resizeWindow` by @sergejkaravajnij +- [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForFunction` added. Waits for client-side JavaScript function to return true by @GREENpoint. +- [Puppeteer] `waitUntil` deprecated in favor of `waitForFunction`. +- Added `filter` function to DataTable. +- Send non-nested array of files to custom parallel execution chunking by @mikecbrant. +- Fixed invalid output directory path for run-multiple by @mikecbrant. +- [WebDriverIO] `waitUntil` timeout accepts time in seconds (as all other wait\* functions). Fix by @truesrc. +- [Nightmare] Fixed `grabNumberOfVisibleElements` to work similarly to `seeElement`. Thx to @stefanschenk and Jinbo Jinboson. +- [Protractor] Fixed alert handling error with message 'no such alert' by @truesrc. ## 1.2.1 -* Fixed running `I.retry()` on multiple steps. -* Fixed parallel execution wih chunks. -* [Puppeteer] Fixed `grabNumberOfVisibleElements` to return `0` instead of throwing error if no elements are found. +- Fixed running `I.retry()` on multiple steps. +- Fixed parallel execution wih chunks. +- [Puppeteer] Fixed `grabNumberOfVisibleElements` to return `0` instead of throwing error if no elements are found. ## 1.2.0 -* [WebDriverIO][Protractor][Multiple Sessions](https://codecept.io/acceptance/#multiple-sessions). Run several browser sessions in one test. Introduced `session` command, which opens additional browser window and closes it after a test. +- [WebDriverIO][Protractor][Multiple Sessions](https://codecept.io/acceptance/#multiple-sessions). Run several browser sessions in one test. Introduced `session` command, which opens additional browser window and closes it after a test. ```js -Scenario('run in different browsers', (I) => { - I.amOnPage('/hello'); - I.see('Hello!'); +Scenario('run in different browsers', I => { + I.amOnPage('/hello') + I.see('Hello!') session('john', () => { - I.amOnPage('/bye'); - I.dontSee('Hello'); - I.see('Bye'); - }); - I.see('Hello'); -}); + I.amOnPage('/bye') + I.dontSee('Hello') + I.see('Bye') + }) + I.see('Hello') +}) ``` -* [Parallel Execution](https://codecept.io/advanced/#parallel-execution) by @sveneisenschmidt. Run tests in parallel specifying number of chunks: +- [Parallel Execution](https://codecept.io/advanced/#parallel-execution) by @sveneisenschmidt. Run tests in parallel specifying number of chunks: ```js "multiple": { @@ -3255,244 +3772,239 @@ Scenario('run in different browsers', (I) => { } ``` -* [Locator Builder](https://codecept.io/locators). Write complex locators with simplest API combining CSS and XPath: +- [Locator Builder](https://codecept.io/locators). Write complex locators with simplest API combining CSS and XPath: ```js // select 'Edit' link inside 2nd row of a table -locate('//table') - .find('tr') - .at(2) - .find('a') - .withText('Edit'); +locate('//table').find('tr').at(2).find('a').withText('Edit') ``` -* [Dynamic configuration](https://codecept.io/advanced/#dynamic-configuration) to update helpers config per test or per suite. -* Added `event.test.finished` which fires synchronously for both failed and passed tests. -* [WebDriverIO][Protractor][Nightmare][Puppeteer] Full page screenshots on failure disabled by default. See [issue#1600. You can enabled them with `fullPageScreenshots: true`, however they may work unstable in Selenium. -* `within` blocks can return values. See [updated documentation](https://codecept.io/basics/#within). -* Removed doublt call to `_init` in helpers. Fixes issue #1036 -* Added scenario and feature configuration via fluent API: +- [Dynamic configuration](https://codecept.io/advanced/#dynamic-configuration) to update helpers config per test or per suite. +- Added `event.test.finished` which fires synchronously for both failed and passed tests. +- [WebDriverIO][Protractor][Nightmare][Puppeteer] Full page screenshots on failure disabled by default. See [issue#1600. You can enabled them with `fullPageScreenshots: true`, however they may work unstable in Selenium. +- `within` blocks can return values. See [updated documentation](https://codecept.io/basics/#within). +- Removed doublt call to `_init` in helpers. Fixes issue #1036 +- Added scenario and feature configuration via fluent API: ```js -Feature('checkout') - .timeout(3000) - .retry(2); +Feature('checkout').timeout(3000).retry(2) -Scenario('user can order in firefox', (I) => { +Scenario('user can order in firefox', I => { // see dynamic configuration -}).config({ browser: 'firefox' }) - .timeout(20000); +}) + .config({ browser: 'firefox' }) + .timeout(20000) -Scenario('this test should throw error', (I) => { +Scenario('this test should throw error', I => { // I.amOnPage -}).throws(new Error); +}).throws(new Error()) ``` ## 1.1.8 -* Fixed generating TypeScript definitions with `codeceptjs def`. -* Added Chinese translation ("zh-CN" and "zh-TW") by @TechQuery. -* Fixed running tests from a different folder specified by `-c` option. -* [Puppeteer] Added support for hash handling in URL by @gavoja. -* [Puppeteer] Fixed setting viewport size by @gavoja. See [Puppeteer issue](https://github.com/GoogleChrome/puppeteer/issues/1183) - +- Fixed generating TypeScript definitions with `codeceptjs def`. +- Added Chinese translation ("zh-CN" and "zh-TW") by @TechQuery. +- Fixed running tests from a different folder specified by `-c` option. +- [Puppeteer] Added support for hash handling in URL by @gavoja. +- [Puppeteer] Fixed setting viewport size by @gavoja. See [Puppeteer issue](https://github.com/GoogleChrome/puppeteer/issues/1183) ## 1.1.7 -* Docker Image updateed. [See updated reference](https://codecept.io/docker/): - * codeceptjs package is mounted as `/codecept` insde container - * tests directory is expected to be mounted as `/tests` - * `codeceptjs` global runner added (symlink to `/codecept/bin/codecept.js`) -* [Protractor] Functions added by @reubenmiller: - * `_locateCheckable (only available from other helpers)` - * `_locateClickable (only available from other helpers)` - * `_locateFields (only available from other helpers)` - * `acceptPopup` - * `cancelPopup` - * `dragAndDrop` - * `grabBrowserLogs` - * `grabCssPropertyFrom` - * `grabHTMLFrom` - * `grabNumberOfVisibleElements` - * `grabPageScrollPosition (new)` - * `rightClick` - * `scrollPageToBottom` - * `scrollPageToTop` - * `scrollTo` - * `seeAttributesOnElements` - * `seeCssPropertiesOnElements` - * `seeInPopup` - * `seeNumberOfVisibleElements` - * `switchTo` - * `waitForEnabled` - * `waitForValue` - * `waitInUrl` - * `waitNumberOfVisibleElements` - * `waitToHide` - * `waitUntil` - * `waitUrlEquals` -* [Nightmare] added: - * `grabPageScrollPosition` (new) - * `seeNumberOfVisibleElements` - * `waitToHide` -* [Puppeteer] added: - * `grabPageScrollPosition` (new) -* [WebDriverIO] added" - * `grabPageScrollPosition` (new) -* [Puppeteer] Fixed running wait* functions without setting `sec` parameter. -* [Puppeteer][Protractor] Fixed bug with I.click when using an object selector with the xpath property. By @reubenmiller -* [WebDriverIO][Protractor][Nightmare][Puppeteer] Fixed I.switchTo(0) and I.scrollTo(100, 100) api inconsistencies between helpers. -* [Protractor] Fixing bug when `seeAttributesOnElements` and `seeCssPropertiesOnElement` were incorrectly passing when the attributes/properties did not match by @reubenmiller -* [WebDriverIO] Use inbuilt dragAndDrop function (still doesn't work in Firefox). By @reubenmiller -* Support for Nightmare 3.0 -* Enable glob patterns in `config.test` / `Codecept.loadTests` by @sveneisenschmidt -* Enable overriding of `config.tests` for `run-multiple` by @sveneisenschmidt - +- Docker Image updateed. [See updated reference](https://codecept.io/docker/): + - codeceptjs package is mounted as `/codecept` insde container + - tests directory is expected to be mounted as `/tests` + - `codeceptjs` global runner added (symlink to `/codecept/bin/codecept.js`) +- [Protractor] Functions added by @reubenmiller: + - `_locateCheckable (only available from other helpers)` + - `_locateClickable (only available from other helpers)` + - `_locateFields (only available from other helpers)` + - `acceptPopup` + - `cancelPopup` + - `dragAndDrop` + - `grabBrowserLogs` + - `grabCssPropertyFrom` + - `grabHTMLFrom` + - `grabNumberOfVisibleElements` + - `grabPageScrollPosition (new)` + - `rightClick` + - `scrollPageToBottom` + - `scrollPageToTop` + - `scrollTo` + - `seeAttributesOnElements` + - `seeCssPropertiesOnElements` + - `seeInPopup` + - `seeNumberOfVisibleElements` + - `switchTo` + - `waitForEnabled` + - `waitForValue` + - `waitInUrl` + - `waitNumberOfVisibleElements` + - `waitToHide` + - `waitUntil` + - `waitUrlEquals` +- [Nightmare] added: + - `grabPageScrollPosition` (new) + - `seeNumberOfVisibleElements` + - `waitToHide` +- [Puppeteer] added: + - `grabPageScrollPosition` (new) +- [WebDriverIO] added" + - `grabPageScrollPosition` (new) +- [Puppeteer] Fixed running wait\* functions without setting `sec` parameter. +- [Puppeteer][Protractor] Fixed bug with I.click when using an object selector with the xpath property. By @reubenmiller +- [WebDriverIO][Protractor][Nightmare][Puppeteer] Fixed I.switchTo(0) and I.scrollTo(100, 100) api inconsistencies between helpers. +- [Protractor] Fixing bug when `seeAttributesOnElements` and `seeCssPropertiesOnElement` were incorrectly passing when the attributes/properties did not match by @reubenmiller +- [WebDriverIO] Use inbuilt dragAndDrop function (still doesn't work in Firefox). By @reubenmiller +- Support for Nightmare 3.0 +- Enable glob patterns in `config.test` / `Codecept.loadTests` by @sveneisenschmidt +- Enable overriding of `config.tests` for `run-multiple` by @sveneisenschmidt ## 1.1.6 -* Added support for `async I =>` functions syntax in Scenario by @APshenkin -* [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForInvisible` waits for element to hide or to be removed from page. By @reubenmiller -* [Protractor][Puppeteer][Nightmare] Added `grabCurrentUrl` function. By @reubenmiller -* [WebDriverIO] `grabBrowserUrl` deprecated in favor of `grabCurrentUrl` to unify the API. -* [Nightmare] Improved element visibility detection by @reubenmiller -* [Puppeteer] Fixing function calls when clearing the cookies and localstorage. By @reubenmiller -* [Puppeteer] Added `waitForEnabled`, `waitForValue` and `waitNumberOfVisibleElements` methods by @reubenmiller -* [WebDriverIO] Fixed `grabNumberOfVisibleElements` to return 0 when no visible elements are on page. By @michaltrunek -* Helpers API improvements (by @reubenmiller) - * `_passed` hook runs after a test passed successfully - * `_failed` hook runs on a failed test -* Hooks API. New events added by @reubenmiller: - * `event.all.before` - executed before all tests - * `event.all.after` - executed after all tests - * `event.multiple.before` - executed before all processes in run-multiple - * `event.multiple.after` - executed after all processes in run-multiple -* Multiple execution -* Allow `AfterSuite` and `After` test hooks to be defined after the first Scenario. By @reubenmiller -* [Nightmare] Prevent `I.amOnpage` navigation if the browser is already at the given url -* Multiple-Run: Added new `bootstrapAll` and `teardownAll` hooks to be executed before and after all processes -* `codeceptjs def` command accepts `--config` option. By @reubenmiller +- Added support for `async I =>` functions syntax in Scenario by @APshenkin +- [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForInvisible` waits for element to hide or to be removed from page. By @reubenmiller +- [Protractor][Puppeteer][Nightmare] Added `grabCurrentUrl` function. By @reubenmiller +- [WebDriverIO] `grabBrowserUrl` deprecated in favor of `grabCurrentUrl` to unify the API. +- [Nightmare] Improved element visibility detection by @reubenmiller +- [Puppeteer] Fixing function calls when clearing the cookies and localstorage. By @reubenmiller +- [Puppeteer] Added `waitForEnabled`, `waitForValue` and `waitNumberOfVisibleElements` methods by @reubenmiller +- [WebDriverIO] Fixed `grabNumberOfVisibleElements` to return 0 when no visible elements are on page. By @michaltrunek +- Helpers API improvements (by @reubenmiller) + - `_passed` hook runs after a test passed successfully + - `_failed` hook runs on a failed test +- Hooks API. New events added by @reubenmiller: + - `event.all.before` - executed before all tests + - `event.all.after` - executed after all tests + - `event.multiple.before` - executed before all processes in run-multiple + - `event.multiple.after` - executed after all processes in run-multiple +- Multiple execution +- Allow `AfterSuite` and `After` test hooks to be defined after the first Scenario. By @reubenmiller +- [Nightmare] Prevent `I.amOnpage` navigation if the browser is already at the given url +- Multiple-Run: Added new `bootstrapAll` and `teardownAll` hooks to be executed before and after all processes +- `codeceptjs def` command accepts `--config` option. By @reubenmiller ## 1.1.5 -* [Puppeteer] Rerun steps failed due to "Cannot find context with specified id" Error. -* Added syntax to retry a single step: +- [Puppeteer] Rerun steps failed due to "Cannot find context with specified id" Error. +- Added syntax to retry a single step: ```js // retry action once on failure -I.retry().see('Hello'); +I.retry().see('Hello') // retry action 3 times on failure -I.retry(3).see('Hello'); +I.retry(3).see('Hello') // retry action 3 times waiting for 0.1 second before next try -I.retry({ retries: 3, minTimeout: 100 }).see('Hello'); +I.retry({ retries: 3, minTimeout: 100 }).see('Hello') // retry action 3 times waiting no more than 3 seconds for last retry -I.retry({ retries: 3, maxTimeout: 3000 }).see('Hello'); +I.retry({ retries: 3, maxTimeout: 3000 }).see('Hello') // retry 2 times if error with message 'Node not visible' happens I.retry({ retries: 2, - when: err => err.message === 'Node not visible' -}).seeElement('#user'); -``` - -* `Scenario().injectDependencies` added to dynamically add objects into DI container by @Apshenkin. See [Dependency Injection section in PageObjects](https://codecept.io/pageobjects/#dependency-injection). -* Fixed using async/await functions inside `within` -* [WebDriverIO][Protractor][Puppeteer][Nightmare] **`waitUntilExists` deprecated** in favor of `waitForElement` -* [WebDriverIO][Protractor] **`waitForStalenessOf` deprecated** in favor of `waitForDetached` -* [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForDetached` added -* [Nightmare] Added `I.seeNumberOfElements()` by @pmoncadaisla -* [Nightmare] Load blank page when starting nightmare so that the .evaluate function will work if _failed/saveScreenshot is triggered by @reubenmiller -* Fixed using plain arrays for data driven tests by @reubenmiller -* [Puppeteer] Use default tab instead of opening a new tab when starting the browser by @reubenmiller -* [Puppeteer] Added `grabNumberOfTabs` function by @reubenmiller -* [Puppeteer] Add ability to set user-agent by @abidhahmed -* [Puppeteer] Add keepCookies and keepBrowserState @abidhahmed -* [Puppeteer] Clear value attribute instead of innerhtml for TEXTAREA by @reubenmiller -* [REST] fixed sending string payload by @michaltrunek -* Fixed unhandled rejection in async/await tests by @APshenkin - + when: err => err.message === 'Node not visible', +}).seeElement('#user') +``` + +- `Scenario().injectDependencies` added to dynamically add objects into DI container by @Apshenkin. See [Dependency Injection section in PageObjects](https://codecept.io/pageobjects/#dependency-injection). +- Fixed using async/await functions inside `within` +- [WebDriverIO][Protractor][Puppeteer][Nightmare] **`waitUntilExists` deprecated** in favor of `waitForElement` +- [WebDriverIO][Protractor] **`waitForStalenessOf` deprecated** in favor of `waitForDetached` +- [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForDetached` added +- [Nightmare] Added `I.seeNumberOfElements()` by @pmoncadaisla +- [Nightmare] Load blank page when starting nightmare so that the .evaluate function will work if \_failed/saveScreenshot is triggered by @reubenmiller +- Fixed using plain arrays for data driven tests by @reubenmiller +- [Puppeteer] Use default tab instead of opening a new tab when starting the browser by @reubenmiller +- [Puppeteer] Added `grabNumberOfTabs` function by @reubenmiller +- [Puppeteer] Add ability to set user-agent by @abidhahmed +- [Puppeteer] Add keepCookies and keepBrowserState @abidhahmed +- [Puppeteer] Clear value attribute instead of innerhtml for TEXTAREA by @reubenmiller +- [REST] fixed sending string payload by @michaltrunek +- Fixed unhandled rejection in async/await tests by @APshenkin ## 1.1.4 -* Removed `yarn` call in package.json -* Fixed `console.log` in Puppeteer by @othree -* [Appium] `runOnAndroid` and `runOnIOS` can receive a function to check capabilities dynamically: +- Removed `yarn` call in package.json +- Fixed `console.log` in Puppeteer by @othree +- [Appium] `runOnAndroid` and `runOnIOS` can receive a function to check capabilities dynamically: ```js -I.runOnAndroid(caps => caps.platformVersion >= 7, () => { - // run code only on Android 7+ -}); +I.runOnAndroid( + caps => caps.platformVersion >= 7, + () => { + // run code only on Android 7+ + }, +) ``` ## 1.1.3 -* [Puppeteer] +25 Functions added by @reubenmiller - * `_locateCheckable` - * `_locateClickable` - * `_locateFields` - * `closeOtherTabs` - * `dragAndDrop` - * `grabBrowserLogs` - * `grabCssPropertyFrom` - * `grabHTMLFrom` - * `grabNumberOfVisibleElements` - * `grabSource` - * `rightClick` - * `scrollPageToBottom` - * `scrollPageToTop` - * `scrollTo` - * `seeAttributesOnElements` - * `seeCssPropertiesOnElements` - * `seeInField` - * `seeNumberOfElements` - * `seeNumberOfVisibleElements` - * `seeTextEquals` - * `seeTitleEquals` - * `switchTo` - * `waitForInvisible` - * `waitInUrl` - * `waitUrlEquals` -* [Protractor] +8 functions added by @reubenmiller - * `closeCurrentTab` - * `grabSource` - * `openNewTab` - * `seeNumberOfElements` - * `seeTextEquals` - * `seeTitleEquals` - * `switchToNextTab` - * `switchToPreviousTab` -* [Nightmare] `waitForInvisible` added by @reubenmiller -* [Puppeteer] Printing console.log information in debug mode. -* [Nightmare] Integrated with `nightmare-har-plugin` by mingfang. Added `enableHAR` option. Added HAR functions: - * `grabHAR` - * `saveHAR` - * `resetHAR` -* [WebDriverIO] Fixed execution stability for parallel requests with Chromedriver -* [WebDriverIO] Fixed resizeWindow when resizing to 'maximize' by @reubenmiller -* [WebDriverIO] Fixing resizing window to full screen when taking a screenshot by @reubenmiller +- [Puppeteer] +25 Functions added by @reubenmiller + - `_locateCheckable` + - `_locateClickable` + - `_locateFields` + - `closeOtherTabs` + - `dragAndDrop` + - `grabBrowserLogs` + - `grabCssPropertyFrom` + - `grabHTMLFrom` + - `grabNumberOfVisibleElements` + - `grabSource` + - `rightClick` + - `scrollPageToBottom` + - `scrollPageToTop` + - `scrollTo` + - `seeAttributesOnElements` + - `seeCssPropertiesOnElements` + - `seeInField` + - `seeNumberOfElements` + - `seeNumberOfVisibleElements` + - `seeTextEquals` + - `seeTitleEquals` + - `switchTo` + - `waitForInvisible` + - `waitInUrl` + - `waitUrlEquals` +- [Protractor] +8 functions added by @reubenmiller + - `closeCurrentTab` + - `grabSource` + - `openNewTab` + - `seeNumberOfElements` + - `seeTextEquals` + - `seeTitleEquals` + - `switchToNextTab` + - `switchToPreviousTab` +- [Nightmare] `waitForInvisible` added by @reubenmiller +- [Puppeteer] Printing console.log information in debug mode. +- [Nightmare] Integrated with `nightmare-har-plugin` by mingfang. Added `enableHAR` option. Added HAR functions: + - `grabHAR` + - `saveHAR` + - `resetHAR` +- [WebDriverIO] Fixed execution stability for parallel requests with Chromedriver +- [WebDriverIO] Fixed resizeWindow when resizing to 'maximize' by @reubenmiller +- [WebDriverIO] Fixing resizing window to full screen when taking a screenshot by @reubenmiller ## 1.1.2 -* [Puppeteer] Upgraded to Puppeteer 1.0 -* Added `grep` option to config to set default matching pattern for tests. -* [Puppeteer] Added `acceptPopup`, `cancelPopup`, `seeInPopup` and `grabPopupText` functions by @reubenmiller -* [Puppeteer] `within` iframe and nested iframe support added by @reubenmiller -* [REST] Added support for JSON objects since payload (as a JSON) was automatically converted into "URL query" type of parameter by @Kalostrinho -* [REST] Added `resetRequestHeaders` method by @Kalostrinho -* [REST] Added `followRedirect` option and `amFollowingRequestRedirects`/`amNotFollowingRequestRedirects` methods by @Kalostrinho -* [WebDriverIO] `uncheckOption` implemented by @brunobg -* [WebDriverIO] Added `grabBrowserUrl` by @Kalostrinho -* Add ability to require helpers from node_modules by @APshenkin -* Added `--profile` option to `run-multiple` command by @jamie-beck -* Custom output name for multiple browser run by @tfiwm -* Fixed passing data to scenarios by @KennyRules +- [Puppeteer] Upgraded to Puppeteer 1.0 +- Added `grep` option to config to set default matching pattern for tests. +- [Puppeteer] Added `acceptPopup`, `cancelPopup`, `seeInPopup` and `grabPopupText` functions by @reubenmiller +- [Puppeteer] `within` iframe and nested iframe support added by @reubenmiller +- [REST] Added support for JSON objects since payload (as a JSON) was automatically converted into "URL query" type of parameter by @Kalostrinho +- [REST] Added `resetRequestHeaders` method by @Kalostrinho +- [REST] Added `followRedirect` option and `amFollowingRequestRedirects`/`amNotFollowingRequestRedirects` methods by @Kalostrinho +- [WebDriverIO] `uncheckOption` implemented by @brunobg +- [WebDriverIO] Added `grabBrowserUrl` by @Kalostrinho +- Add ability to require helpers from node_modules by @APshenkin +- Added `--profile` option to `run-multiple` command by @jamie-beck +- Custom output name for multiple browser run by @tfiwm +- Fixed passing data to scenarios by @KennyRules ## 1.1.1 -* [WebDriverIO] fixed `waitForInvisible` by @Kporal +- [WebDriverIO] fixed `waitForInvisible` by @Kporal ## 1.1.0 @@ -3500,10 +4012,10 @@ Major update to CodeceptJS. **NodeJS v 8.9.1** is now minimal Node version requi This brings native async-await support to CodeceptJS. It is recommended to start using await for tests instead of generators: ```js -async () => { - I.amOnPage('/page'); - const url = await I.grabTextFrom('.nextPage'); - I.amOnPage(url); +;async () => { + I.amOnPage('/page') + const url = await I.grabTextFrom('.nextPage') + I.amOnPage(url) } ``` @@ -3511,9 +4023,9 @@ Thanks to [@Apshenkin](https://github.com/apshenkin) for implementation. Also, m We also introduced strict ESLint policies for our codebase. Thanks to [@Galkin](https://github.com/galkin) for that. -* **[Puppeteer] Helper introduced**. [Learn how to run tests headlessly with Google Chrome's Puppeteer](http://codecept.io/puppeteer/). -* [SeleniumWebdriver] Helper is deprecated, it is recommended to use Protractor with config option `angular: false` instead. -* [WebDriverIO] nested iframe support in the within block by @reubenmiller. Example: +- **[Puppeteer] Helper introduced**. [Learn how to run tests headlessly with Google Chrome's Puppeteer](http://codecept.io/puppeteer/). +- [SeleniumWebdriver] Helper is deprecated, it is recommended to use Protractor with config option `angular: false` instead. +- [WebDriverIO] nested iframe support in the within block by @reubenmiller. Example: ```js within({frame: ['#wrapperId', '[name=content]']}, () => { @@ -3524,66 +4036,63 @@ I.see('Nested Iframe test'); I.dontSee('Email Address'); }); ``` -* [WebDriverIO] Support for `~` locator to find elements by `aria-label`. This behavior is similar as it is in Appium and helps testing cross-platform React apps. Example: + +- [WebDriverIO] Support for `~` locator to find elements by `aria-label`. This behavior is similar as it is in Appium and helps testing cross-platform React apps. Example: ```html - - CodeceptJS is awesome - + CodeceptJS is awesome ``` -↑ This element can be located with `~foobar` in WebDriverIO and Appium helpers. Thanks to @flyskywhy - -* Allow providing arbitrary objects in config includes by @rlewan -* [REST] Prevent from mutating default headers by @alexashley. See #789 -* [REST] Fixed sending empty helpers with `haveRequestHeaders` in `sendPostRequest`. By @petrisorionel -* Fixed displaying undefined args in output by @APshenkin -* Fixed NaN instead of seconds in output by @APshenkin -* Add browser name to report file for `multiple-run` by @trollr -* Mocha updated to 4.x +↑ This element can be located with `~foobar` in WebDriverIO and Appium helpers. Thanks to @flyskywhy +- Allow providing arbitrary objects in config includes by @rlewan +- [REST] Prevent from mutating default headers by @alexashley. See #789 +- [REST] Fixed sending empty helpers with `haveRequestHeaders` in `sendPostRequest`. By @petrisorionel +- Fixed displaying undefined args in output by @APshenkin +- Fixed NaN instead of seconds in output by @APshenkin +- Add browser name to report file for `multiple-run` by @trollr +- Mocha updated to 4.x ## 1.0.3 -* [WebDriverIO][Protractor][Nightmare] method `waitUntilExists` implemented by @sabau -* Absolute path can be set for `output` dir by @APshenkin. Fix #571* Data table rows can be ignored by using `xadd`. By @APhenkin -* Added `Data(table).only.Scenario` to give ability to launch only Data tests. By @APhenkin -* Implemented `ElementNotFound` error by @BorisOsipov. -* Added TypeScript compiler / configs to check the JavaScript by @KennyRules -* [Nightmare] fix executeScript return value by @jploskonka -* [Nightmare] fixed: err.indexOf not a function when waitForText times out in nightmare by @joeypedicini92 -* Fixed: Retries not working when using .only. By @APhenkin - +- [WebDriverIO][Protractor][Nightmare] method `waitUntilExists` implemented by @sabau +- Absolute path can be set for `output` dir by @APshenkin. Fix #571\* Data table rows can be ignored by using `xadd`. By @APhenkin +- Added `Data(table).only.Scenario` to give ability to launch only Data tests. By @APhenkin +- Implemented `ElementNotFound` error by @BorisOsipov. +- Added TypeScript compiler / configs to check the JavaScript by @KennyRules +- [Nightmare] fix executeScript return value by @jploskonka +- [Nightmare] fixed: err.indexOf not a function when waitForText times out in nightmare by @joeypedicini92 +- Fixed: Retries not working when using .only. By @APhenkin ## 1.0.2 -* Introduced generators support in scenario hooks for `BeforeSuite`/`Before`/`AfterSuite`/`After` -* [ApiDataFactory] Fixed loading helper; `requireg` package included. -* Fix #485`run-multiple`: the first browser-resolution combination was be used in all configurations -* Fixed unique test names: - * Fixed #447 tests failed silently if they have the same name as other tests. - * Use uuid in screenshot names when `uniqueScreenshotNames: true` -* [Protractor] Fixed testing non-angular application. `amOutsideAngularApp` is executed before each step. Fixes #458* Added output for steps in hooks when they fail +- Introduced generators support in scenario hooks for `BeforeSuite`/`Before`/`AfterSuite`/`After` +- [ApiDataFactory] Fixed loading helper; `requireg` package included. +- Fix #485`run-multiple`: the first browser-resolution combination was be used in all configurations +- Fixed unique test names: + - Fixed #447 tests failed silently if they have the same name as other tests. + - Use uuid in screenshot names when `uniqueScreenshotNames: true` +- [Protractor] Fixed testing non-angular application. `amOutsideAngularApp` is executed before each step. Fixes #458\* Added output for steps in hooks when they fail ## 1.0.1 -* Reporters improvements: - * Allows to execute [multiple reporters](http://codecept.io/advanced/#Multi-Reports) - * Added [Mochawesome](http://codecept.io/helpers/Mochawesome/) helper - * `addMochawesomeContext` method to add custom data to mochawesome reports - * Fixed Mochawesome context for failed screenshots. -* [WebDriverIO] improved click on context to match clickable element with a text inside. Fixes #647* [Nightmare] Added `refresh` function by @awhanks -* fixed `Unhandled promise rejection (rejection id: 1): Error: Unknown wait type: pageLoad` -* support for tests with retries in html report -* be sure that change window size and timeouts completes before test -* [Nightmare] Fixed `[Wrapped Error] "codeceptjs is not defined"`; Reinjectiing client scripts to a webpage on changes. -* [Nightmare] Added more detailed error messages for `Wait*` methods -* [Nightmare] Fixed adding screenshots to Mochawesome -* [Nightmare] Fix unique screenshots names in Nightmare -* Fixed CodeceptJS work with hooks in helpers to finish codeceptJS correctly if errors appears in helpers hooks -* Create a new session for next test If selenium grid error received -* Create screenshots for failed hooks from a Feature file -* Fixed `retries` option +- Reporters improvements: + - Allows to execute [multiple reporters](http://codecept.io/advanced/#Multi-Reports) + - Added [Mochawesome](http://codecept.io/helpers/Mochawesome/) helper + - `addMochawesomeContext` method to add custom data to mochawesome reports + - Fixed Mochawesome context for failed screenshots. +- [WebDriverIO] improved click on context to match clickable element with a text inside. Fixes #647\* [Nightmare] Added `refresh` function by @awhanks +- fixed `Unhandled promise rejection (rejection id: 1): Error: Unknown wait type: pageLoad` +- support for tests with retries in html report +- be sure that change window size and timeouts completes before test +- [Nightmare] Fixed `[Wrapped Error] "codeceptjs is not defined"`; Reinjectiing client scripts to a webpage on changes. +- [Nightmare] Added more detailed error messages for `Wait*` methods +- [Nightmare] Fixed adding screenshots to Mochawesome +- [Nightmare] Fix unique screenshots names in Nightmare +- Fixed CodeceptJS work with hooks in helpers to finish codeceptJS correctly if errors appears in helpers hooks +- Create a new session for next test If selenium grid error received +- Create screenshots for failed hooks from a Feature file +- Fixed `retries` option ## 1.0 @@ -3600,8 +4109,8 @@ I.clearField('~email of the customer')); I.dontSee('Nothing special', '~email of the customer')); ``` -* Read [the Mobile Testing guide](http://codecept.io/mobile). -* Discover [Appium Helper](http://codecept.io/helpers/Appium/) +- Read [the Mobile Testing guide](http://codecept.io/mobile). +- Discover [Appium Helper](http://codecept.io/helpers/Appium/) --- @@ -3612,116 +4121,117 @@ Sample test ```js // create a user using data factories and REST API -I.have('user', { name: 'davert', password: '123456' }); +I.have('user', { name: 'davert', password: '123456' }) // use it to login -I.amOnPage('/login'); -I.fillField('login', 'davert'); -I.fillField('password', '123456'); -I.click('Login'); -I.see('Hello, davert'); +I.amOnPage('/login') +I.fillField('login', 'davert') +I.fillField('password', '123456') +I.click('Login') +I.see('Hello, davert') // user will be removed after the test ``` -* Read [Data Management guide](http://codecept.io/data) -* [REST Helper](http://codecept.io/helpers/REST) -* [ApiDataFactory](http://codecept.io/helpers/ApiDataFactory/) +- Read [Data Management guide](http://codecept.io/data) +- [REST Helper](http://codecept.io/helpers/REST) +- [ApiDataFactory](http://codecept.io/helpers/ApiDataFactory/) --- Next notable feature is **[SmartWait](http://codecept.io/acceptance/#smartwait)** for WebDriverIO, Protractor, SeleniumWebdriver. When `smartwait` option is set, script will wait for extra milliseconds to locate an element before failing. This feature uses implicit waits of Selenium but turns them on only in applicable pieces. For instance, implicit waits are enabled for `seeElement` but disabled for `dontSeeElement` -* Read more about [SmartWait](http://codecept.io/acceptance/#smartwait) +- Read more about [SmartWait](http://codecept.io/acceptance/#smartwait) ##### Changelog -* Minimal NodeJS version is 6.11.1 LTS -* Use `within` command with generators. -* [Data Driven Tests](http://codecept.io/advanced/#data-driven-tests) introduced. -* Print execution time per step in `--debug` mode. #591 by @APshenkin -* [WebDriverIO][Protractor][Nightmare] Added `disableScreenshots` option to disable screenshots on fail by @Apshenkin -* [WebDriverIO][Protractor][Nightmare] Added `uniqueScreenshotNames` option to generate unique names for screenshots on failure by @Apshenkin -* [WebDriverIO][Nightmare] Fixed click on context; `click('text', '#el')` will throw exception if text is not found inside `#el`. -* [WebDriverIO][Protractor][SeleniumWebdriver] [SmartWait introduced](http://codecept.io/acceptance/#smartwait). -* [WebDriverIO][Protractor][Nightmare]Fixed `saveScreenshot` for PhantomJS, `fullPageScreenshots` option introduced by @HughZurname #549 -* [Appium] helper introduced by @APshenkin -* [REST] helper introduced by @atrevino in #504 -* [WebDriverIO][SeleniumWebdriver] Fixed "windowSize": "maximize" for Chrome 59+ version #560 by @APshenkin -* [Nightmare] Fixed restarting by @APshenkin #581 -* [WebDriverIO] Methods added by @APshenkin: - * [grabCssPropertyFrom](http://codecept.io/helpers/WebDriverIO/#grabcsspropertyfrom) - * [seeTitleEquals](http://codecept.io/helpers/WebDriverIO/#seetitleequals) - * [seeTextEquals](http://codecept.io/helpers/WebDriverIO/#seetextequals) - * [seeCssPropertiesOnElements](http://codecept.io/helpers/WebDriverIO/#seecsspropertiesonelements) - * [seeAttributesOnElements](http://codecept.io/helpers/WebDriverIO/#seeattributesonelements) - * [grabNumberOfVisibleElements](http://codecept.io/helpers/WebDriverIO/#grabnumberofvisibleelements) - * [waitInUrl](http://codecept.io/helpers/WebDriverIO/#waitinurl) - * [waitUrlEquals](http://codecept.io/helpers/WebDriverIO/#waiturlequals) - * [waitForValue](http://codecept.io/helpers/WebDriverIO/#waitforvalue) - * [waitNumberOfVisibleElements](http://codecept.io/helpers/WebDriverIO/#waitnumberofvisibleelements) - * [switchToNextTab](http://codecept.io/helpers/WebDriverIO/#switchtonexttab) - * [switchToPreviousTab](http://codecept.io/helpers/WebDriverIO/#switchtoprevioustab) - * [closeCurrentTab](http://codecept.io/helpers/WebDriverIO/#closecurrenttab) - * [openNewTab](http://codecept.io/helpers/WebDriverIO/#opennewtab) - * [refreshPage](http://codecept.io/helpers/WebDriverIO/#refreshpage) - * [scrollPageToBottom](http://codecept.io/helpers/WebDriverIO/#scrollpagetobottom) - * [scrollPageToTop](http://codecept.io/helpers/WebDriverIO/#scrollpagetotop) - * [grabBrowserLogs](http://codecept.io/helpers/WebDriverIO/#grabbrowserlogs) -* Use mkdirp to create output directory. #592 by @vkramskikh -* [WebDriverIO] Fixed `seeNumberOfVisibleElements` by @BorisOsipov #574 -* Lots of fixes for promise chain by @APshenkin #568 - * Fix #543- After block not properly executed if Scenario fails - * Expected behavior in promise chains: `_beforeSuite` hooks from helpers -> `BeforeSuite` from test -> `_before` hooks from helpers -> `Before` from test - > Test steps -> `_failed` hooks from helpers (if test failed) -> `After` from test -> `_after` hooks from helpers -> `AfterSuite` from test -> `_afterSuite` hook from helpers. - * if during test we got errors from any hook (in test or in helper) - stop complete this suite and go to another - * if during test we got error from Selenium server - stop complete this suite and go to another - * [WebDriverIO][Protractor] if `restart` option is false - close all tabs expect one in `_after`. - * Complete `_after`, `_afterSuite` hooks even After/AfterSuite from test was failed - * Don't close browser between suites, when `restart` option is false. We should start browser only one time and close it only after all tests. - * Close tabs and clear local storage, if `keepCookies` flag is enabled -* Fix TypeError when using babel-node or ts-node on node.js 7+ #586 by @vkramskikh -* [Nightmare] fixed usage of `_locate` +- Minimal NodeJS version is 6.11.1 LTS +- Use `within` command with generators. +- [Data Driven Tests](http://codecept.io/advanced/#data-driven-tests) introduced. +- Print execution time per step in `--debug` mode. #591 by @APshenkin +- [WebDriverIO][Protractor][Nightmare] Added `disableScreenshots` option to disable screenshots on fail by @Apshenkin +- [WebDriverIO][Protractor][Nightmare] Added `uniqueScreenshotNames` option to generate unique names for screenshots on failure by @Apshenkin +- [WebDriverIO][Nightmare] Fixed click on context; `click('text', '#el')` will throw exception if text is not found inside `#el`. +- [WebDriverIO][Protractor][SeleniumWebdriver] [SmartWait introduced](http://codecept.io/acceptance/#smartwait). +- [WebDriverIO][Protractor][Nightmare]Fixed `saveScreenshot` for PhantomJS, `fullPageScreenshots` option introduced by @HughZurname #549 +- [Appium] helper introduced by @APshenkin +- [REST] helper introduced by @atrevino in #504 +- [WebDriverIO][SeleniumWebdriver] Fixed "windowSize": "maximize" for Chrome 59+ version #560 by @APshenkin +- [Nightmare] Fixed restarting by @APshenkin #581 +- [WebDriverIO] Methods added by @APshenkin: + - [grabCssPropertyFrom](http://codecept.io/helpers/WebDriverIO/#grabcsspropertyfrom) + - [seeTitleEquals](http://codecept.io/helpers/WebDriverIO/#seetitleequals) + - [seeTextEquals](http://codecept.io/helpers/WebDriverIO/#seetextequals) + - [seeCssPropertiesOnElements](http://codecept.io/helpers/WebDriverIO/#seecsspropertiesonelements) + - [seeAttributesOnElements](http://codecept.io/helpers/WebDriverIO/#seeattributesonelements) + - [grabNumberOfVisibleElements](http://codecept.io/helpers/WebDriverIO/#grabnumberofvisibleelements) + - [waitInUrl](http://codecept.io/helpers/WebDriverIO/#waitinurl) + - [waitUrlEquals](http://codecept.io/helpers/WebDriverIO/#waiturlequals) + - [waitForValue](http://codecept.io/helpers/WebDriverIO/#waitforvalue) + - [waitNumberOfVisibleElements](http://codecept.io/helpers/WebDriverIO/#waitnumberofvisibleelements) + - [switchToNextTab](http://codecept.io/helpers/WebDriverIO/#switchtonexttab) + - [switchToPreviousTab](http://codecept.io/helpers/WebDriverIO/#switchtoprevioustab) + - [closeCurrentTab](http://codecept.io/helpers/WebDriverIO/#closecurrenttab) + - [openNewTab](http://codecept.io/helpers/WebDriverIO/#opennewtab) + - [refreshPage](http://codecept.io/helpers/WebDriverIO/#refreshpage) + - [scrollPageToBottom](http://codecept.io/helpers/WebDriverIO/#scrollpagetobottom) + - [scrollPageToTop](http://codecept.io/helpers/WebDriverIO/#scrollpagetotop) + - [grabBrowserLogs](http://codecept.io/helpers/WebDriverIO/#grabbrowserlogs) +- Use mkdirp to create output directory. #592 by @vkramskikh +- [WebDriverIO] Fixed `seeNumberOfVisibleElements` by @BorisOsipov #574 +- Lots of fixes for promise chain by @APshenkin #568 + - Fix #543- After block not properly executed if Scenario fails + - Expected behavior in promise chains: `_beforeSuite` hooks from helpers -> `BeforeSuite` from test -> `_before` hooks from helpers -> `Before` from test - > Test steps -> `_failed` hooks from helpers (if test failed) -> `After` from test -> `_after` hooks from helpers -> `AfterSuite` from test -> `_afterSuite` hook from helpers. + - if during test we got errors from any hook (in test or in helper) - stop complete this suite and go to another + - if during test we got error from Selenium server - stop complete this suite and go to another + - [WebDriverIO][Protractor] if `restart` option is false - close all tabs expect one in `_after`. + - Complete `_after`, `_afterSuite` hooks even After/AfterSuite from test was failed + - Don't close browser between suites, when `restart` option is false. We should start browser only one time and close it only after all tests. + - Close tabs and clear local storage, if `keepCookies` flag is enabled +- Fix TypeError when using babel-node or ts-node on node.js 7+ #586 by @vkramskikh +- [Nightmare] fixed usage of `_locate` Special thanks to **Andrey Pshenkin** for his work on this release and the major improvements. ## 0.6.3 -* Errors are printed in non-verbose mode. Shows "Selenium not started" and other important errors. -* Allowed to set custom test options: +- Errors are printed in non-verbose mode. Shows "Selenium not started" and other important errors. +- Allowed to set custom test options: ```js Scenario('My scenario', { build_id: 123, type: 'slow' }, function (I) ``` + those options can be accessed as `opts` property inside a `test` object. Can be used in custom listeners. -* Added `docs` directory to a package. -* [WebDriverIO][Protractor][SeleniumWebdriver] Bugfix: cleaning session when `restart: false` by @tfiwm #519 -* [WebDriverIO][Protractor][Nightmare] Added second parameter to `saveScreenshot` to allow a full page screenshot. By @HughZurname -* Added suite object to `suite.before` and `suite.after` events by @implico. #496 +- Added `docs` directory to a package. +- [WebDriverIO][Protractor][SeleniumWebdriver] Bugfix: cleaning session when `restart: false` by @tfiwm #519 +- [WebDriverIO][Protractor][Nightmare] Added second parameter to `saveScreenshot` to allow a full page screenshot. By @HughZurname +- Added suite object to `suite.before` and `suite.after` events by @implico. #496 ## 0.6.2 -* Added `config` object to [public API](http://codecept.io/hooks/#api) -* Extended `index.js` to include `actor` and `helpers`, so they could be required: +- Added `config` object to [public API](http://codecept.io/hooks/#api) +- Extended `index.js` to include `actor` and `helpers`, so they could be required: ```js -const actor = require('codeceptjs').actor; +const actor = require('codeceptjs').actor ``` -* Added [example for creating custom runner](http://codecept.io/hooks/#custom-runner) with public API. -* run command to create `output` directory if it doesn't exist -* [Protractor] fixed loading globally installed Protractor -* run-multiple command improvements: - * create output directories for each process - * print process ids in output +- Added [example for creating custom runner](http://codecept.io/hooks/#custom-runner) with public API. +- run command to create `output` directory if it doesn't exist +- [Protractor] fixed loading globally installed Protractor +- run-multiple command improvements: + - create output directories for each process + - print process ids in output ## 0.6.1 -* Fixed loading hooks +- Fixed loading hooks ## 0.6.0 Major release with extension API and parallel execution. -* **Breaking** Removed path argument from `run`. To specify path other than current directory use `--config` or `-c` option: +- **Breaking** Removed path argument from `run`. To specify path other than current directory use `--config` or `-c` option: Instead of: `codeceptjs run tests` use: @@ -3736,51 +4246,50 @@ codeceptjs run -c tests/codecept.json codeceptjs run users_test.js -c tests ``` -* **Command `multiple-run` added**, to execute tests in several browsers in parallel by @APshenkin and @davertmik. [See documentation](http://codecept.io/advanced/#multiple-execution). -* **Hooks API added to extend CodeceptJS** with custom listeners and plugins. [See documentation](http://codecept.io/hooks/#hooks_1). -* [Nightmare][WebDriverIO] `within` can work with iframes by @imvetri. [See documentation](http://codecept.io/acceptance/#iframes). -* [WebDriverIO][SeleniumWebdriver][Protractor] Default browser changed to `chrome` -* [Nightmare] Fixed globally locating `nightmare-upload`. -* [WebDriverIO] added `seeNumberOfVisibleElements` method by @elarouche. -* Exit with non-zero code if init throws an error by @rincedd -* New guides published: - * [Installation](http://codecept.io/installation/) - * [Hooks](http://codecept.io/hooks/) - * [Advanced Usage](http://codecept.io/advanced/) -* Meta packages published: - * [codecept-webdriverio](https://www.npmjs.com/package/codecept-webdriverio) - * [codecept-protractor](https://www.npmjs.com/package/codecept-protractor) - * [codecept-nightmare](https://www.npmjs.com/package/codecept-nightmare) - +- **Command `multiple-run` added**, to execute tests in several browsers in parallel by @APshenkin and @davertmik. [See documentation](http://codecept.io/advanced/#multiple-execution). +- **Hooks API added to extend CodeceptJS** with custom listeners and plugins. [See documentation](http://codecept.io/hooks/#hooks_1). +- [Nightmare][WebDriverIO] `within` can work with iframes by @imvetri. [See documentation](http://codecept.io/acceptance/#iframes). +- [WebDriverIO][SeleniumWebdriver][Protractor] Default browser changed to `chrome` +- [Nightmare] Fixed globally locating `nightmare-upload`. +- [WebDriverIO] added `seeNumberOfVisibleElements` method by @elarouche. +- Exit with non-zero code if init throws an error by @rincedd +- New guides published: + - [Installation](http://codecept.io/installation/) + - [Hooks](http://codecept.io/hooks/) + - [Advanced Usage](http://codecept.io/advanced/) +- Meta packages published: + - [codecept-webdriverio](https://www.npmjs.com/package/codecept-webdriverio) + - [codecept-protractor](https://www.npmjs.com/package/codecept-protractor) + - [codecept-nightmare](https://www.npmjs.com/package/codecept-nightmare) ## 0.5.1 -* [Polish translation](http://codecept.io/translation/#polish) added by @limes. -* Update process exit code so that mocha saves reports before exit by @romanovma. -* [Nightmare] fixed `getAttributeFrom` for custom attributes by @robrkerr -* [Nightmare] Fixed *UnhandledPromiseRejectionWarning error* when selecting the dropdown using `selectOption` by @robrkerr. [Se PR. -* [Protractor] fixed `pressKey` method by @romanovma +- [Polish translation](http://codecept.io/translation/#polish) added by @limes. +- Update process exit code so that mocha saves reports before exit by @romanovma. +- [Nightmare] fixed `getAttributeFrom` for custom attributes by @robrkerr +- [Nightmare] Fixed _UnhandledPromiseRejectionWarning error_ when selecting the dropdown using `selectOption` by @robrkerr. [Se PR. +- [Protractor] fixed `pressKey` method by @romanovma ## 0.5.0 -* Protractor ^5.0.0 support (while keeping ^4.0.9 compatibility) -* Fix 'fullTitle() is not a function' in exit.js by @hubidu. See #388. -* [Nightmare] Fix for `waitTimeout` by @HughZurname. See #391. Resolves #236* Dockerized CodeceptJS setup by @artiomnist. [See reference](https://github.com/codeceptjs/CodeceptJS/blob/master/docker/README.md) +- Protractor ^5.0.0 support (while keeping ^4.0.9 compatibility) +- Fix 'fullTitle() is not a function' in exit.js by @hubidu. See #388. +- [Nightmare] Fix for `waitTimeout` by @HughZurname. See #391. Resolves #236\* Dockerized CodeceptJS setup by @artiomnist. [See reference](https://github.com/codeceptjs/CodeceptJS/blob/master/docker/README.md) ## 0.4.16 -* Fixed steps output synchronization (regression since 0.4.14). -* [WebDriverIO][Protractor][SeleniumWebdriver][Nightmare] added `keepCookies` option to keep cookies between tests with `restart: false`. -* [Protractor] added `waitForTimeout` config option to set default waiting time for all wait* functions. -* Fixed `_test` hook for helpers by @cjhille. +- Fixed steps output synchronization (regression since 0.4.14). +- [WebDriverIO][Protractor][SeleniumWebdriver][Nightmare] added `keepCookies` option to keep cookies between tests with `restart: false`. +- [Protractor] added `waitForTimeout` config option to set default waiting time for all wait\* functions. +- Fixed `_test` hook for helpers by @cjhille. ## 0.4.15 -* Fixed regression in recorder sessions: `oldpromise is not defined`. +- Fixed regression in recorder sessions: `oldpromise is not defined`. ## 0.4.14 -* `_beforeStep` and `_afterStep` hooks in helpers are synchronized. Allows to perform additional actions between steps. +- `_beforeStep` and `_afterStep` hooks in helpers are synchronized. Allows to perform additional actions between steps. Example: fail if JS error occur in custom helper using WebdriverIO: @@ -3810,130 +4319,128 @@ _afterStep() { } ``` -* Fixed `codecept list` and `codecept def` commands. -* Added `I.say` method to print arbitrary comments. +- Fixed `codecept list` and `codecept def` commands. +- Added `I.say` method to print arbitrary comments. ```js -I.say('I am going to publish post'); -I.say('I enter title and body'); -I.say('I expect post is visible on site'); +I.say('I am going to publish post') +I.say('I enter title and body') +I.say('I expect post is visible on site') ``` -* [Nightmare] `restart` option added. `restart: false` allows to run all tests in a single window, disabled by default. By @nairvijays99 -* [Nightmare] Fixed `resizeWindow` command. -* [Protractor][SeleniumWebdriver] added `windowSize` config option to resize window on start. -* Fixed "Scenario.skip causes 'Cannot read property retries of undefined'" by @MasterOfPoppets -* Fixed providing absolute paths for tests in config by @lennym +- [Nightmare] `restart` option added. `restart: false` allows to run all tests in a single window, disabled by default. By @nairvijays99 +- [Nightmare] Fixed `resizeWindow` command. +- [Protractor][SeleniumWebdriver] added `windowSize` config option to resize window on start. +- Fixed "Scenario.skip causes 'Cannot read property retries of undefined'" by @MasterOfPoppets +- Fixed providing absolute paths for tests in config by @lennym ## 0.4.13 -* Added **retries** option `Feature` and `Scenario` to rerun fragile tests: +- Added **retries** option `Feature` and `Scenario` to rerun fragile tests: ```js -Feature('Complex JS Stuff', {retries: 3}); +Feature('Complex JS Stuff', { retries: 3 }) -Scenario('Not that complex', {retries: 1}, (I) => { +Scenario('Not that complex', { retries: 1 }, I => { // test goes here -}); +}) ``` -* Added **timeout** option `Feature` and `Scenario` to specify timeout. +- Added **timeout** option `Feature` and `Scenario` to specify timeout. ```js -Feature('Complex JS Stuff', {timeout: 5000}); +Feature('Complex JS Stuff', { timeout: 5000 }) -Scenario('Not that complex', {timeout: 1000}, (I) => { +Scenario('Not that complex', { timeout: 1000 }, I => { // test goes here -}); +}) ``` -* [WebDriverIO] Added `uniqueScreenshotNames` option to set unique screenshot names for failed tests. By @APshenkin. See #299 -* [WebDriverIO] `clearField` method improved to accept name/label locators and throw errors. -* [Nightmare][SeleniumWebdriver][Protractor] `clearField` method added. -* [Nightmare] Fixed `waitForElement`, and `waitForVisible` methods. -* [Nightmare] Fixed `resizeWindow` by @norisk-it -* Added italian [translation](http://codecept.io/translation/#italian). +- [WebDriverIO] Added `uniqueScreenshotNames` option to set unique screenshot names for failed tests. By @APshenkin. See #299 +- [WebDriverIO] `clearField` method improved to accept name/label locators and throw errors. +- [Nightmare][SeleniumWebdriver][Protractor] `clearField` method added. +- [Nightmare] Fixed `waitForElement`, and `waitForVisible` methods. +- [Nightmare] Fixed `resizeWindow` by @norisk-it +- Added italian [translation](http://codecept.io/translation/#italian). ## 0.4.12 -* Bootstrap / Teardown improved with [Hooks](http://codecept.io/configuration/#hooks). Various options for setup/teardown provided. -* Added `--override` or `-o` option for runner to dynamically override configs. Valid JSON should be passed: +- Bootstrap / Teardown improved with [Hooks](http://codecept.io/configuration/#hooks). Various options for setup/teardown provided. +- Added `--override` or `-o` option for runner to dynamically override configs. Valid JSON should be passed: ``` codeceptjs run -o '{ "bootstrap": "bootstrap.js"}' codeceptjs run -o '{ "helpers": {"WebDriverIO": {"browser": "chrome"}}}' ``` -* Added [regression tests](https://github.com/codeceptjs/CodeceptJS/tree/master/test/runner) for codeceptjs tests runner. +- Added [regression tests](https://github.com/codeceptjs/CodeceptJS/tree/master/test/runner) for codeceptjs tests runner. ## 0.4.11 -* Fixed regression in 0.4.10 -* Added `bootstrap`/`teardown` config options to accept functions as parameters by @pscanf. See updated [config reference](http://codecept.io/configuration/) #319 +- Fixed regression in 0.4.10 +- Added `bootstrap`/`teardown` config options to accept functions as parameters by @pscanf. See updated [config reference](http://codecept.io/configuration/) #319 ## 0.4.10 -* [Protractor] Protrctor 4.0.12+ support. -* Enabled async bootstrap file by @abachar. Use inside `bootstrap.js`: +- [Protractor] Protrctor 4.0.12+ support. +- Enabled async bootstrap file by @abachar. Use inside `bootstrap.js`: ```js -module.exports = function(done) { +module.exports = function (done) { // async instructions // call done() to continue execution // otherwise call done('error description') } ``` -* Changed 'pending' to 'skipped' in reports by @timja-kainos. See #315 +- Changed 'pending' to 'skipped' in reports by @timja-kainos. See #315 ## 0.4.9 -* [SeleniumWebdriver][Protractor][WebDriverIO][Nightmare] fixed `executeScript`, `executeAsyncScript` to work and return values. -* [Protractor][SeleniumWebdriver][WebDriverIO] Added `waitForInvisible` and `waitForStalenessOf` methods by @Nighthawk14. -* Added `--config` option to `codeceptjs run` to manually specify config file by @cnworks -* [Protractor] Simplified behavior of `amOutsideAngularApp` by using `ignoreSynchronization`. Fixes #278 -* Set exit code to 1 when test fails at `Before`/`After` hooks. Fixes #279 - +- [SeleniumWebdriver][Protractor][WebDriverIO][Nightmare] fixed `executeScript`, `executeAsyncScript` to work and return values. +- [Protractor][SeleniumWebdriver][WebDriverIO] Added `waitForInvisible` and `waitForStalenessOf` methods by @Nighthawk14. +- Added `--config` option to `codeceptjs run` to manually specify config file by @cnworks +- [Protractor] Simplified behavior of `amOutsideAngularApp` by using `ignoreSynchronization`. Fixes #278 +- Set exit code to 1 when test fails at `Before`/`After` hooks. Fixes #279 ## 0.4.8 -* [Protractor][SeleniumWebdriver][Nightmare] added `moveCursorTo` method. -* [Protractor][SeleniumWebdriver][WebDriverIO] Added `manualStart` option to start browser manually in the beginning of test. By @cnworks. [PR#250 -* Fixed `codeceptjs init` to work with nested directories and file masks. -* Fixed `codeceptjs gt` to generate test with proper file name suffix. By @Zougi. -* [Nightmare] Fixed: Error is thrown when clicking on element which can't be locate. By @davetmik -* [WebDriverIO] Fixed `attachFile` for file upload. By @giuband and @davetmik -* [WebDriverIO] Add support for timeouts in config and with `defineTimeouts` method. By @easternbloc #258 and #267 by @davetmik -* Fixed hanging of CodeceptJS when error is thrown by event dispatcher. Fix by @Zougi and @davetmik - +- [Protractor][SeleniumWebdriver][Nightmare] added `moveCursorTo` method. +- [Protractor][SeleniumWebdriver][WebDriverIO] Added `manualStart` option to start browser manually in the beginning of test. By @cnworks. [PR#250 +- Fixed `codeceptjs init` to work with nested directories and file masks. +- Fixed `codeceptjs gt` to generate test with proper file name suffix. By @Zougi. +- [Nightmare] Fixed: Error is thrown when clicking on element which can't be locate. By @davetmik +- [WebDriverIO] Fixed `attachFile` for file upload. By @giuband and @davetmik +- [WebDriverIO] Add support for timeouts in config and with `defineTimeouts` method. By @easternbloc #258 and #267 by @davetmik +- Fixed hanging of CodeceptJS when error is thrown by event dispatcher. Fix by @Zougi and @davetmik ## 0.4.7 -* Improved docs for `BeforeSuite`; fixed its usage with `restart: false` option by @APshenkin. -* Added `Nightmare` to list of available helpers on `init`. -* [Nightmare] Removed double `resizeWindow` implementation. +- Improved docs for `BeforeSuite`; fixed its usage with `restart: false` option by @APshenkin. +- Added `Nightmare` to list of available helpers on `init`. +- [Nightmare] Removed double `resizeWindow` implementation. ## 0.4.6 -* Added `BeforeSuite` and `AfterSuite` hooks to scenario by @APshenkin. See [updated documentation](http://codecept.io/basics/#beforesuite) +- Added `BeforeSuite` and `AfterSuite` hooks to scenario by @APshenkin. See [updated documentation](http://codecept.io/basics/#beforesuite) ## 0.4.5 -* Fixed running `codecept def` command by @jankaspar -* [Protractor][SeleniumWebdriver] Added support for special keys in `pressKey` method. Fixes #216 +- Fixed running `codecept def` command by @jankaspar +- [Protractor][SeleniumWebdriver] Added support for special keys in `pressKey` method. Fixes #216 ## 0.4.4 -* Interactive shell fixed. Start it by running `codeceptjs shell` -* Added `--profile` option to `shell` command to use dynamic configuration. -* Added `--verbose` option to `shell` command for most complete output. +- Interactive shell fixed. Start it by running `codeceptjs shell` +- Added `--profile` option to `shell` command to use dynamic configuration. +- Added `--verbose` option to `shell` command for most complete output. ## 0.4.3 -* [Protractor] Regression fixed to ^4.0.0 support -* Translations included into package. -* `teardown` option added to config (opposite to `bootstrap`), expects a JS file to be executed after tests stop. -* [Configuration](http://codecept.io/configuration/) can be set via JavaScript file `codecept.conf.js` instead of `codecept.json`. It should export `config` object: +- [Protractor] Regression fixed to ^4.0.0 support +- Translations included into package. +- `teardown` option added to config (opposite to `bootstrap`), expects a JS file to be executed after tests stop. +- [Configuration](http://codecept.io/configuration/) can be set via JavaScript file `codecept.conf.js` instead of `codecept.json`. It should export `config` object: ```js // inside codecept.conf.js @@ -3941,39 +4448,40 @@ exports.config = { // contents of codecept.js } ``` -* Added `--profile` option to pass its value to `codecept.conf.js` as `process.profile` for [dynamic configuration](http://codecept.io/configuration#dynamic-configuration). -* Documentation for [StepObjects, PageFragments](http://codecept.io/pageobjects#PageFragments) updated. -* Documentation for [Configuration](http://codecept.io/configuration/) added. + +- Added `--profile` option to pass its value to `codecept.conf.js` as `process.profile` for [dynamic configuration](http://codecept.io/configuration#dynamic-configuration). +- Documentation for [StepObjects, PageFragments](http://codecept.io/pageobjects#PageFragments) updated. +- Documentation for [Configuration](http://codecept.io/configuration/) added. ## 0.4.2 -* Added ability to localize tests with translation #189. Thanks to @abner - * [Translation] ru-RU translation added. - * [Translation] pt-BR translation added. -* [Protractor] Protractor 4.0.4 compatibility. -* [WebDriverIO][SeleniumWebdriver][Protractor] Fixed single browser session mode for `restart: false` -* Fixed using of 3rd party reporters (xunit, mocha-junit-reporter, mochawesome). Added guide. -* Documentation for [Translation](http://codecept.io/translation/) added. -* Documentation for [Reports](http://codecept.io/reports/) added. +- Added ability to localize tests with translation #189. Thanks to @abner + - [Translation] ru-RU translation added. + - [Translation] pt-BR translation added. +- [Protractor] Protractor 4.0.4 compatibility. +- [WebDriverIO][SeleniumWebdriver][Protractor] Fixed single browser session mode for `restart: false` +- Fixed using of 3rd party reporters (xunit, mocha-junit-reporter, mochawesome). Added guide. +- Documentation for [Translation](http://codecept.io/translation/) added. +- Documentation for [Reports](http://codecept.io/reports/) added. ## 0.4.1 -* Added custom steps to step definition list. See #174 by @jayS-de -* [WebDriverIO] Fixed using `waitForTimeout` option by @stephane-ruhlmann. See #178 +- Added custom steps to step definition list. See #174 by @jayS-de +- [WebDriverIO] Fixed using `waitForTimeout` option by @stephane-ruhlmann. See #178 ## 0.4.0 -* **[Nightmare](http://codecept.io/nightmare) Helper** added for faster web testing. -* [Protractor][SeleniumWebdriver][WebDriverIO] added `restart: false` option to reuse one browser between tests (improves speed). -* **Protractor 4.0** compatibility. Please upgrade Protractor library. -* Added `--verbose` option for `run` command to log and print global promise and events. -* Fixed errors with shutting down and cleanup. -* Fixed starting interactive shell with `codeceptjs shell`. -* Fixed handling of failures inside within block +- **[Nightmare](http://codecept.io/nightmare) Helper** added for faster web testing. +- [Protractor][SeleniumWebdriver][WebDriverIO] added `restart: false` option to reuse one browser between tests (improves speed). +- **Protractor 4.0** compatibility. Please upgrade Protractor library. +- Added `--verbose` option for `run` command to log and print global promise and events. +- Fixed errors with shutting down and cleanup. +- Fixed starting interactive shell with `codeceptjs shell`. +- Fixed handling of failures inside within block ## 0.3.5 -* Introduced IDE autocompletion support for Visual Studio Code and others. Added command for generating TypeScript definitions for `I` object. Use it as +- Introduced IDE autocompletion support for Visual Studio Code and others. Added command for generating TypeScript definitions for `I` object. Use it as ``` codeceptjs def @@ -3983,9 +4491,9 @@ to generate steps definition file and include it into tests by reference. By @ka ## 0.3.4 -* [Protractor] version 3.3.0 comptaibility, NPM 3 compatibility. Please update Protractor! -* allows using absolute path for helpers, output, in config and in command line. By @denis-sokolov -* Fixes 'Cannot read property '1' of null in generate.js:44' by @seethislight +- [Protractor] version 3.3.0 comptaibility, NPM 3 compatibility. Please update Protractor! +- allows using absolute path for helpers, output, in config and in command line. By @denis-sokolov +- Fixes 'Cannot read property '1' of null in generate.js:44' by @seethislight ## 0.3.3 @@ -3995,63 +4503,62 @@ Depending on installation type additional modules (webdriverio, protractor, ...) ## 0.3.2 -* Added `codeceptjs list` command which shows all available methods of `I` object. -* [Protractor][SeleniumWebdriver] fixed closing browser instances -* [Protractor][SeleniumWebdriver] `doubleClick` method added -* [WebDriverIO][Protractor][SeleniumWebdriver] `doubleClick` method to locate clickable elements by text, `context` option added. -* Fixed using assert in generator without yields #89 +- Added `codeceptjs list` command which shows all available methods of `I` object. +- [Protractor][SeleniumWebdriver] fixed closing browser instances +- [Protractor][SeleniumWebdriver] `doubleClick` method added +- [WebDriverIO][Protractor][SeleniumWebdriver] `doubleClick` method to locate clickable elements by text, `context` option added. +- Fixed using assert in generator without yields #89 ## 0.3.1 -* Fixed `init` command +- Fixed `init` command ## 0.3.0 **Breaking Change**: webdriverio package removed from dependencies list. You will need to install it manually after the upgrade. Starting from 0.3.0 webdriverio is not the only backend for running selenium tests, so you are free to choose between Protractor, SeleniumWebdriver, and webdriverio and install them. -* **[Protractor] helper added**. Now you can test AngularJS applications by using its official library within the unigied CodeceptJS API! -* **[SeleniumWebdriver] helper added**. You can switch to official JS bindings for Selenium. -* [WebDriverIO] **updated to webdriverio v 4.0** -* [WebDriverIO] `clearField` method added by @fabioel -* [WebDriverIO] added `dragAndDrop` by @fabioel -* [WebDriverIO] fixed `scrollTo` method by @sensone -* [WebDriverIO] fixed `windowSize: maximize` option in config -* [WebDriverIO] `seeElement` and `dontSeeElement` check element for visibility by @fabioel and @davertmik -* [WebDriverIO] `seeElementInDOM`, `dontSeeElementInDOM` added to check element exists on page. -* [WebDriverIO] fixed saving screenshots on failure. Fixes #70 -* fixed `within` block doesn't end in output not #79 - +- **[Protractor] helper added**. Now you can test AngularJS applications by using its official library within the unigied CodeceptJS API! +- **[SeleniumWebdriver] helper added**. You can switch to official JS bindings for Selenium. +- [WebDriverIO] **updated to webdriverio v 4.0** +- [WebDriverIO] `clearField` method added by @fabioel +- [WebDriverIO] added `dragAndDrop` by @fabioel +- [WebDriverIO] fixed `scrollTo` method by @sensone +- [WebDriverIO] fixed `windowSize: maximize` option in config +- [WebDriverIO] `seeElement` and `dontSeeElement` check element for visibility by @fabioel and @davertmik +- [WebDriverIO] `seeElementInDOM`, `dontSeeElementInDOM` added to check element exists on page. +- [WebDriverIO] fixed saving screenshots on failure. Fixes #70 +- fixed `within` block doesn't end in output not #79 ## 0.2.8 -* [WebDriverIO] added `seeNumberOfElements` by @fabioel +- [WebDriverIO] added `seeNumberOfElements` by @fabioel ## 0.2.7 -* process ends with exit code 1 on error or failure #49 -* fixed registereing global Helper #57 -* fixed handling error in within block #50 +- process ends with exit code 1 on error or failure #49 +- fixed registereing global Helper #57 +- fixed handling error in within block #50 ## 0.2.6 -* Fixed `done() was called multiple times` -* [WebDriverIO] added `waitToHide` method by @fabioel -* Added global `Helper` (alias `codecept_helper)`, object use for writing custom Helpers. Generator updated. Changes to #48 +- Fixed `done() was called multiple times` +- [WebDriverIO] added `waitToHide` method by @fabioel +- Added global `Helper` (alias `codecept_helper)`, object use for writing custom Helpers. Generator updated. Changes to #48 ## 0.2.5 -* Fixed issues with using yield inside a test #45 #47 #43 -* Fixed generating a custom helper. Helper class is now accessible with `codecept_helper` var. Fixes #48 +- Fixed issues with using yield inside a test #45 #47 #43 +- Fixed generating a custom helper. Helper class is now accessible with `codecept_helper` var. Fixes #48 ## 0.2.4 -* Fixed accessing helpers from custom helper by @pim. +- Fixed accessing helpers from custom helper by @pim. ## 0.2.3 -* [WebDriverIO] fixed `seeInField` to work with single value elements like: input[type=text], textareas, and multiple: select, input[type=radio], input[type=checkbox] -* [WebDriverIO] fixed `pressKey`, key modifeiers (Control, Command, Alt, Shift) are released after the action +- [WebDriverIO] fixed `seeInField` to work with single value elements like: input[type=text], textareas, and multiple: select, input[type=radio], input[type=checkbox] +- [WebDriverIO] fixed `pressKey`, key modifeiers (Control, Command, Alt, Shift) are released after the action ## 0.2.2 @@ -4061,9 +4568,9 @@ Whenever you need to create `I` object (in page objects, custom steps, but not i ## 0.2.0 -* **within** context hook added -* `--reporter` option supported -* [WebDriverIO] added features and methods: +- **within** context hook added +- `--reporter` option supported +- [WebDriverIO] added features and methods: - elements: `seeElement`, ... - popups: `acceptPopup`, `cancelPopup`, `seeInPopup`,... - navigation: `moveCursorTo`, `scrollTo` @@ -4073,8 +4580,8 @@ Whenever you need to create `I` object (in page objects, custom steps, but not i - form: `seeCheckboxIsChecked`, `selectOption` to support multiple selects - keyboard: `appendField`, `pressKey` - mouse: `rightClick` -* tests added -* [WebDriverIO] proxy configuration added by @petehouston -* [WebDriverIO] fixed `waitForText` method by @roadhump. Fixes #11 -* Fixed creating output dir when it already exists on init by @alfirin -* Fixed loading of custom helpers +- tests added +- [WebDriverIO] proxy configuration added by @petehouston +- [WebDriverIO] fixed `waitForText` method by @roadhump. Fixes #11 +- Fixed creating output dir when it already exists on init by @alfirin +- Fixed loading of custom helpers diff --git a/Dockerfile b/Dockerfile index 445b740c8..d637da4b5 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,11 +1,13 @@ # Download Playwright and its dependencies -FROM mcr.microsoft.com/playwright:v1.39.0 +FROM mcr.microsoft.com/playwright:v1.48.1-noble ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true +RUN apt-get update --allow-releaseinfo-change + # 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 + apt-get install -y libgtk2.0-0 \ + libxtst6 libxss1 libnss3 xvfb # Install latest chrome dev package and fonts to support major charsets (Chinese, Japanese, Arabic, Hebrew, Thai and a few others) # Note: this installs the necessary libs to make the bundled version of Chromium that Puppeteer @@ -29,7 +31,7 @@ RUN groupadd -r pptruser && useradd -r -g pptruser -G audio,video pptruser \ COPY . /codecept RUN chown -R pptruser:pptruser /codecept -RUN runuser -l pptruser -c 'npm i --force --loglevel=warn --prefix /codecept' +RUN runuser -l pptruser -c 'npm i --loglevel=warn --prefix /codecept' RUN ln -s /codecept/bin/codecept.js /usr/local/bin/codeceptjs RUN mkdir /tests diff --git a/README.md b/README.md index 044a7c55a..992f36f4c 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,17 @@ [![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg)](https://stand-with-ukraine.pp.ua) - - [](https://join.slack.com/t/codeceptjs/shared_invite/enQtMzA5OTM4NDM2MzA4LWE4MThhN2NmYTgxNTU5MTc4YzAyYWMwY2JkMmZlYWI5MWQ2MDM5MmRmYzZmYmNiNmY5NTAzM2EwMGIwOTNhOGQ) [](https://codecept.discourse.group) [![NPM version][npm-image]][npm-url] [](https://hub.docker.com/r/codeceptjs/codeceptjs) -[![AI features](https://img.shields.io/badge/AI-features?logo=openai&logoColor=white)](https://github.com/codeceptjs/CodeceptJS/edit/3.x/docs/ai.md) [![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) - -Build Status: +[![AI features](https://img.shields.io/badge/AI-features?logo=openai&logoColor=white)](https://github.com/codeceptjs/CodeceptJS/edit/3.x/docs/ai.md) [![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) -Appium Helper: -[![Appium V2 Tests - Android](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appiumV2_Android.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appiumV2_Android.yml) +## Build Status -Web Helper: -[![Playwright Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/playwright.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/playwright.yml) -[![Puppeteer Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/puppeteer.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/puppeteer.yml) -[![WebDriver Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/webdriver.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/webdriver.yml) -[![TestCafe Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/testcafe.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/testcafe.yml) +| Type | Engine | Status | +| --------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 🌐 Web | Playwright | [![Playwright Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/playwright.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/playwright.yml) | +| 🌐 Web | Puppeteer | [![Puppeteer Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/puppeteer.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/puppeteer.yml) | +| 🌐 Web | WebDriver | [![WebDriver Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/webdriver.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/webdriver.yml) | +| 🌐 Web | TestCafe | [![TestCafe Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/testcafe.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/testcafe.yml) | +| 📱 Mobile | Appium | [![Appium Tests - Android](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appium_Android.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appium_Android.yml) | # CodeceptJS [![Made in Ukraine](https://img.shields.io/badge/made_in-ukraine-ffd700.svg?labelColor=0057b7)](https://stand-with-ukraine.pp.ua) @@ -27,28 +24,28 @@ It abstracts browser interaction to simple steps that are written from a user's A simple test that verifies the "Welcome" text is present on a main page of a site will look like: ```js -Feature('CodeceptJS demo'); +Feature('CodeceptJS demo') Scenario('check Welcome page on site', ({ I }) => { - I.amOnPage('/'); - I.see('Welcome'); -}); + I.amOnPage('/') + I.see('Welcome') +}) ``` CodeceptJS tests are: -* **Synchronous**. You don't need to care about callbacks or promises or test scenarios which are linear. But, your tests should be linear. -* Written from **user's perspective**. Every action is a method of `I`. That makes test easy to read, write and maintain even for non-tech persons. -* Backend **API agnostic**. We don't know which WebDriver implementation is running this test. +- **Synchronous**. You don't need to care about callbacks or promises or test scenarios which are linear. But, your tests should be linear. +- Written from **user's perspective**. Every action is a method of `I`. That makes test easy to read, write and maintain even for non-tech persons. +- Backend **API agnostic**. We don't know which WebDriver implementation is running this test. CodeceptJS uses **Helper** modules to provide actions to `I` object. Currently, CodeceptJS has these helpers: -* [**Playwright**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Playwright.md) - is a Node library to automate the Chromium, WebKit and Firefox browsers with a single API. -* [**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 or Devtools protocol. -* [**TestCafe**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/TestCafe.md) - cheap and fast cross-browser test automation. -* [**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. +- [**Playwright**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Playwright.md) - is a Node library to automate the Chromium, WebKit and Firefox browsers with a single API. +- [**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 or Devtools protocol. +- [**TestCafe**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/TestCafe.md) - cheap and fast cross-browser test automation. +- [**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. And more to come... @@ -58,17 +55,16 @@ CodeceptJS is a successor of [Codeception](http://codeception.com), a popular fu With CodeceptJS your scenario-driven functional and acceptance tests will be as simple and clean as they can be. You don't need to worry about asynchronous nature of NodeJS or about various APIs of Playwright, Selenium, Puppeteer, TestCafe, etc. as CodeceptJS unifies them and makes them work as they are synchronous. - ## Features - -* đŸĒ„ **AI-powered** with GPT features to assist and heal failing tests. -* ☕ Based on [Mocha](https://mochajs.org/) testing framework. -* đŸ’ŧ Designed for scenario driven acceptance testing in BDD-style. -* đŸ’ģ Uses ES6 natively without transpiler. -* Also plays nice with TypeScript. -* Smart locators: use names, labels, matching text, CSS or XPath to locate elements. -* 🌐 Interactive debugging shell: pause test at any point and try different commands in a browser. -* Easily create tests, pageobjects, stepobjects with CLI generators. + +- đŸĒ„ **AI-powered** with GPT features to assist and heal failing tests. +- ☕ Based on [Mocha](https://mochajs.org/) testing framework. +- đŸ’ŧ Designed for scenario driven acceptance testing in BDD-style. +- đŸ’ģ Uses ES6 natively without transpiler. +- Also plays nice with TypeScript. +- Smart locators: use names, labels, matching text, CSS or XPath to locate elements. +- 🌐 Interactive debugging shell: pause test at any point and try different commands in a browser. +- Easily create tests, pageobjects, stepobjects with CLI generators. ## Installation @@ -105,7 +101,8 @@ npx codeceptjs def . Later you can even automagically update Type Definitions to include your own custom [helpers methods](docs/helpers.md). Note: -- CodeceptJS requires Node.js version `12+` or later. + +- CodeceptJS requires Node.js version `12+` or later. ## Usage @@ -116,18 +113,18 @@ Learn CodeceptJS by examples. Let's assume we have CodeceptJS installed and WebD Let's see how we can handle basic form testing: ```js -Feature('CodeceptJS Demonstration'); +Feature('CodeceptJS Demonstration') Scenario('test some forms', ({ I }) => { - I.amOnPage('http://simple-form-bootstrap.plataformatec.com.br/documentation'); - I.fillField('Email', 'hello@world.com'); - I.fillField('Password', secret('123456')); - I.checkOption('Active'); - I.checkOption('Male'); - I.click('Create User'); - I.see('User is valid'); - I.dontSeeInCurrentUrl('/documentation'); -}); + I.amOnPage('http://simple-form-bootstrap.plataformatec.com.br/documentation') + I.fillField('Email', 'hello@world.com') + I.fillField('Password', secret('123456')) + I.checkOption('Active') + I.checkOption('Male') + I.click('Create User') + I.see('User is valid') + I.dontSeeInCurrentUrl('/documentation') +}) ``` All actions are performed by `I` object; assertions functions start with `see` function. @@ -172,11 +169,11 @@ The same way you can locate element by name, `CSS` or `XPath` locators in tests: ```js // by name -I.fillField('user_basic[email]', 'hello@world.com'); +I.fillField('user_basic[email]', 'hello@world.com') // by CSS -I.fillField('#user_basic_email', 'hello@world.com'); +I.fillField('#user_basic_email', 'hello@world.com') // don't make us guess locator type, specify it -I.fillField({css: '#user_basic_email'}, 'hello@world.com'); +I.fillField({ css: '#user_basic_email' }, 'hello@world.com') ``` Other methods like `checkOption`, and `click` work in a similar manner. They can take labels or CSS or XPath locators to find elements to interact. @@ -187,9 +184,9 @@ Assertions start with `see` or `dontSee` prefix. In our case we are asserting th However, we can narrow the search to particular element by providing a second parameter: ```js -I.see('User is valid'); +I.see('User is valid') // better to specify context: -I.see('User is valid', '.alert-success'); +I.see('User is valid', '.alert-success') ``` In this case 'User is valid' string will be searched only inside elements located by CSS `.alert-success`. @@ -200,13 +197,13 @@ In case you need to return a value from a webpage and use it directly in test, y They are expected to be used inside `async/await` functions, and their results will be available in test: ```js -Feature('CodeceptJS Demonstration'); +Feature('CodeceptJS Demonstration') Scenario('test page title', async ({ I }) => { - I.amOnPage('http://simple-form-bootstrap.plataformatec.com.br/documentation'); - const title = await I.grabTitle(); - I.expectEqual(title, 'Example application with SimpleForm and Twitter Bootstrap'); // Avaiable with Expect helper. -> https://codecept.io/helpers/Expect/ -}); + I.amOnPage('http://simple-form-bootstrap.plataformatec.com.br/documentation') + const title = await I.grabTitle() + I.expectEqual(title, 'Example application with SimpleForm and Twitter Bootstrap') // Avaiable with Expect helper. -> https://codecept.io/helpers/Expect/ +}) ``` The same way you can grab text, attributes, or form values and use them in next test steps. @@ -216,23 +213,24 @@ The same way you can grab text, attributes, or form values and use them in next Common preparation steps like opening a web page, logging in a user, can be placed in `Before` or `Background`: ```js -const { I } = inject(); +const { I } = inject() -Feature('CodeceptJS Demonstration'); +Feature('CodeceptJS Demonstration') -Before(() => { // or Background - I.amOnPage('http://simple-form-bootstrap.plataformatec.com.br/documentation'); -}); +Before(() => { + // or Background + I.amOnPage('http://simple-form-bootstrap.plataformatec.com.br/documentation') +}) Scenario('test some forms', () => { - I.click('Create User'); - I.see('User is valid'); - I.dontSeeInCurrentUrl('/documentation'); -}); + I.click('Create User') + I.see('User is valid') + I.dontSeeInCurrentUrl('/documentation') +}) Scenario('test title', () => { - I.seeInTitle('Example application'); -}); + I.seeInTitle('Example application') +}) ``` ## PageObjects @@ -248,83 +246,55 @@ It will create a page object file for you and add it to the config. Let's assume we created one named `docsPage`: ```js -const { I } = inject(); +const { I } = inject() module.exports = { fields: { email: '#user_basic_email', - password: '#user_basic_password' + password: '#user_basic_password', }, - submitButton: {css: '#new_user_basic input[type=submit]'}, + submitButton: { css: '#new_user_basic input[type=submit]' }, sendForm(email, password) { - I.fillField(this.fields.email, email); - I.fillField(this.fields.password, password); - I.click(this.submitButton); - } + I.fillField(this.fields.email, email) + I.fillField(this.fields.password, password) + I.click(this.submitButton) + }, } ``` You can easily inject it to test by providing its name in test arguments: ```js -Feature('CodeceptJS Demonstration'); +Feature('CodeceptJS Demonstration') -Before(({ I }) => { // or Background - I.amOnPage('http://simple-form-bootstrap.plataformatec.com.br/documentation'); -}); +Before(({ I }) => { + // or Background + I.amOnPage('http://simple-form-bootstrap.plataformatec.com.br/documentation') +}) Scenario('test some forms', ({ I, docsPage }) => { - docsPage.sendForm('hello@world.com','123456'); - I.see('User is valid'); - I.dontSeeInCurrentUrl('/documentation'); -}); + docsPage.sendForm('hello@world.com', '123456') + I.see('User is valid') + I.dontSeeInCurrentUrl('/documentation') +}) ``` When using Typescript, replace `module.exports` with `export` for autocompletion. - ## Contributing - - ### [Contributing Guide](https://github.com/codeceptjs/CodeceptJS/blob/master/.github/CONTRIBUTING.md) - - ### [Code of conduct](https://github.com/codeceptjs/CodeceptJS/blob/master/.github/CODE_OF_CONDUCT.md) - +- ### [Contributing Guide](https://github.com/codeceptjs/CodeceptJS/blob/master/.github/CONTRIBUTING.md) +- ### [Code of conduct](https://github.com/codeceptjs/CodeceptJS/blob/master/.github/CODE_OF_CONDUCT.md) ## Contributors -Thanks all to those who are and will have contributing to this awesome project! - -[//]: contributor-faces - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -[//]: contributor-faces +Thanks to our awesome contributors! 🎉 + + + + +Made with [contrib.rocks](https://contrib.rocks). ## License diff --git a/bin/codecept.js b/bin/codecept.js index 9a0ff7db0..5a4752129 100755 --- a/bin/codecept.js +++ b/bin/codecept.js @@ -32,7 +32,7 @@ const commandFlags = { } const errorHandler = - (fn) => + fn => async (...args) => { try { await fn(...args) @@ -58,6 +58,13 @@ program .description('Creates dummy config in current dir or [path]') .action(errorHandler(require('../lib/command/init'))) +program + .command('check') + .option(commandFlags.config.flag, commandFlags.config.description) + .description('Checks configuration and environment before running tests') + .option('-t, --timeout [ms]', 'timeout for checks in ms, 50000 by default') + .action(errorHandler(require('../lib/command/check'))) + program .command('migrate [path]') .description('Migrate json config to js config in current dir or [path]') @@ -286,7 +293,7 @@ program .action(require('../lib/command/run-rerun')) -program.on('command:*', (cmd) => { +program.on('command:*', cmd => { console.log(`\nUnknown command ${cmd}\n`) program.outputHelp() }) diff --git a/docs/ai.md b/docs/ai.md index 9d1776b77..83f050b7c 100644 --- a/docs/ai.md +++ b/docs/ai.md @@ -11,7 +11,6 @@ Think of it as your testing co-pilot built into the testing framework > đŸĒ„ **AI features for testing are experimental**. AI works only for web based testing with Playwright, WebDriver, etc. Those features will be improved based on user's experience. - ## How AI Improves Automated Testing LLMs like ChatGPT can technically write automated tests for you. However, ChatGPT misses the context of your application so it will guess elements on page, instead of writing the code that works. @@ -22,10 +21,10 @@ So, instead of asking "write me a test" it can ask "write a test for **this** pa CodeceptJS AI can do the following: -* 🏋ī¸â€â™€ī¸ **assist writing tests** in `pause()` or interactive shell mode -* 📃 **generate page objects** in `pause()` or interactive shell mode -* 🚑 **self-heal failing tests** (can be used on CI) -* đŸ’Ŧ send arbitrary prompts to AI provider from any tested page attaching its HTML contents +- 🏋ī¸â€â™€ī¸ **assist writing tests** in `pause()` or interactive shell mode +- 📃 **generate page objects** in `pause()` or interactive shell mode +- 🚑 **self-heal failing tests** (can be used on CI) +- đŸ’Ŧ send arbitrary prompts to AI provider from any tested page attaching its HTML contents ![](/img/fill_form.gif) @@ -39,18 +38,16 @@ Even though, the HTML is still quite big and may exceed the token limit. So we r > ❗AI features require sending HTML contents to AI provider. Choosing one may depend on the descurity policy of your company. Ask your security department which AI providers you can use. - - ## Set up AI Provider To enable AI features in CodeceptJS you should pick an AI provider and add `ai` section to `codecept.conf` file. This section should contain `request` function which will take a prompt from CodeceptJS, send it to AI provider and return a result. ```js ai: { - request: async (messages) => { + request: async messages => { // implement OpenAI or any other provider like this const ai = require('my-ai-provider') - return ai.send(messages); + return ai.send(messages) } } ``` @@ -58,7 +55,7 @@ ai: { In `request` function `messages` is an array of prompt messages in format ```js -[{ role: 'user', content: 'prompt text'}] +;[{ role: 'user', content: 'prompt text' }] ``` Which is natively supported by OpenAI, Anthropic, and others. You can adjust messages to expected format before sending a request. The expected response from AI provider is a text in markdown format with code samples, which can be interpreted by CodeceptJS. @@ -71,33 +68,33 @@ npx codeceptjs run --ai Below we list sample configuration for popular AI providers -#### OpenAI GPT +### OpenAI GPT Prerequisite: -* Install `openai` package -* obtain `OPENAI_API_KEY` from OpenAI -* set `OPENAI_API_KEY` as environment variable +- Install `openai` package +- obtain `OPENAI_API_KEY` from OpenAI +- set `OPENAI_API_KEY` as environment variable Sample OpenAI configuration: ```js ai: { - request: async (messages) => { - const OpenAI = require('openai'); + request: async messages => { + const OpenAI = require('openai') const openai = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'] }) const completion = await openai.chat.completions.create({ - model: 'gpt-3.5-turbo-0125', + model: 'gpt-3.5-turbo', messages, - }); + }) - return completion?.choices[0]?.message?.content; + return completion?.choices[0]?.message?.content } } ``` -#### Mixtral +### Mixtral Mixtral is opensource and can be used via Cloudflare, Google Cloud, Azure or installed locally. @@ -105,74 +102,77 @@ The simplest way to try Mixtral on your case is using [Groq Cloud](https://groq. Prerequisite: -* Install `groq-sdk` package -* obtain `GROQ_API_KEY` from OpenAI -* set `GROQ_API_KEY` as environment variable +- Install `groq-sdk` package +- obtain `GROQ_API_KEY` from Groq Cloud +- set `GROQ_API_KEY` as environment variable Sample Groq configuration with Mixtral model: ```js ai: { - request: async (messages) => { + request: async messages => { + const Groq = require('groq-sdk') + + const client = new Groq({ + apiKey: process.env['GROQ_API_KEY'], // This is the default and can be omitted + }) + const chatCompletion = await groq.chat.completions.create({ - messages, - model: "mixtral-8x7b-32768", - }); - return chatCompletion.choices[0]?.message?.content || ""; + messages, + model: 'mixtral-8x7b-32768', + }) + return chatCompletion.choices[0]?.message?.content || '' } } ``` > Groq also provides access to other opensource models like llama or gemma -#### Anthropic Claude +### Anthropic Claude Prerequisite: -* Install `@anthropic-ai/sdk` package -* obtain `CLAUDE_API_KEY` from Anthropic -* set `CLAUDE_API_KEY` as environment variable +- Install `@anthropic-ai/sdk` package +- obtain `CLAUDE_API_KEY` from Anthropic +- set `CLAUDE_API_KEY` as environment variable ```js ai: { - request: async(messages) => { - const Anthropic = require('@anthropic-ai/sdk'); + request: async messages => { + const Anthropic = require('@anthropic-ai/sdk') const anthropic = new Anthropic({ apiKey: process.env.CLAUDE_API_KEY, - }); + }) const resp = await anthropic.messages.create({ model: 'claude-2.1', max_tokens: 1024, - messages - }); - return resp.content.map((c) => c.text).join('\n\n'); + messages, + }) + return resp.content.map(c => c.text).join('\n\n') } } ``` -#### Azure OpenAI +### Azure OpenAI When your setup using Azure API key Prerequisite: -* Install `@azure/openai` package -* obtain `Azure API key`, `resource name` and `deployment ID` +- Install `@azure/openai` package +- obtain `Azure API key`, `resource name` and `deployment ID` ```js ai: { - request: async(messages) => { - const { OpenAIClient, AzureKeyCredential } = require("@azure/openai"); + request: async messages => { + const { OpenAIClient, AzureKeyCredential } = require('@azure/openai') - const client = new OpenAIClient( - "https://.openai.azure.com/", - new AzureKeyCredential("") - ); - const { choices } = await client.getCompletions("", messages); + const client = new OpenAIClient('https://.openai.azure.com/', new AzureKeyCredential('')) + const { choices } = await client.getCompletions('', messages) - return choices[0]?.message?.content; + return choices[0]?.message?.content } } ``` @@ -181,29 +181,29 @@ When your setup using `bearer token` Prerequisite: -* Install `@azure/openai`, `@azure/identity` packages -* obtain `AZURE_TENANT_ID`, `AZURE_CLIENT_ID`, and `AZURE_CLIENT_SECRET` +- Install `@azure/openai`, `@azure/identity` packages +- obtain `AZURE_TENANT_ID`, `AZURE_CLIENT_ID`, and `AZURE_CLIENT_SECRET` ```js ai: { - request: async (messages) => { + request: async messages => { try { - const { OpenAIClient} = require("@azure/openai"); - const { DefaultAzureCredential } = require("@azure/identity"); + const { OpenAIClient } = require('@azure/openai') + const { DefaultAzureCredential } = require('@azure/identity') - const endpoint = process.env.API_ENDPOINT; - const deploymentId = process.env.DEPLOYMENT_ID; + const endpoint = process.env.API_ENDPOINT + const deploymentId = process.env.DEPLOYMENT_ID - const client = new OpenAIClient(endpoint, new DefaultAzureCredential()); + const client = new OpenAIClient(endpoint, new DefaultAzureCredential()) const result = await client.getCompletions(deploymentId, { prompt: messages, - model: 'gpt-3.5-turbo' // your preferred model - }); + model: 'gpt-3.5-turbo', // your preferred model + }) - return result.choices[0]?.text; + return result.choices[0]?.text } catch (error) { - console.error("Error calling API:", error); - throw error; + console.error('Error calling API:', error) + throw error } } } @@ -273,12 +273,12 @@ npx codeceptjs gt Name a test and write the code. We will use `Scenario.only` instead of Scenario to execute only this exact test. ```js -Feature('ai'); +Feature('ai') Scenario.only('test ai features', ({ I }) => { I.amOnPage('https://getbootstrap.com/docs/5.1/examples/checkout/') - pause(); -}); + pause() +}) ``` Now run the test in debug mode with AI enabled: @@ -289,7 +289,6 @@ npx codeceptjs run --debug --ai When pause mode started you can ask GPT to fill in the fields on this page. Use natural language to describe your request, and provide enough details that AI could operate with it. It is important to include at least a space char in your input, otherwise, CodeceptJS will consider the input to be JavaScript code. - ``` I.fill checkout form with valid values without submitting it ``` @@ -310,16 +309,14 @@ Please keep in mind that GPT can't react to page changes and operates with stati In large test suites, the cost of maintaining tests goes exponentially. That's why any effort that can improve the stability of tests pays itself. That's why CodeceptJS has concept of [heal recipes](./heal), functions that can be executed on a test failure. Those functions can try to revive the test and continue execution. When combined with AI, heal recipe can ask AI provider how to fix the test. It will provide error message, step being executed and HTML context of a page. Based on this information AI can suggest the code to be executed to fix the failing test. - AI healing can solve exactly one problem: if a locator of an element has changed, and an action can't be performed, **it matches a new locator, tries a command again, and continues executing a test**. For instance, if the "Sign in" button was renamed to "Login" or changed its class, it will detect a new locator of the button and will retry execution. > You can define your own [heal recipes](./heal) that won't use AI to revive failing tests. -Heal actions **work only on actions like `click`, `fillField`, etc, and won't work on assertions, waiters, grabbers, etc. Assertions can't be guessed by AI, the same way as grabbers, as this may lead to unpredictable results. +Heal actions \*\*work only on actions like `click`, `fillField`, etc, and won't work on assertions, waiters, grabbers, etc. Assertions can't be guessed by AI, the same way as grabbers, as this may lead to unpredictable results. If Heal plugin successfully fixes the step, it will print a suggested change at the end of execution. Take it as actionable advice and use it to update the codebase. Heal plugin is supposed to be used on CI, and works automatically without human assistance. - To start, make sure [AI provider is connected](#set-up-ai-provider), and [heal recipes were created](/heal#how-to-start-healing) by running this command: ``` @@ -357,6 +354,130 @@ npx codeceptjs run --ai When execution finishes, you will receive information on token usage and code suggestions proposed by AI. By evaluating this information you will be able to check how effective AI can be for your case. +## Analyze Results + +When running tests with AI enabled, CodeceptJS can automatically analyze test failures and provide insights. The analyze plugin helps identify patterns in test failures and provides detailed explanations of what went wrong. + +Enable the analyze plugin in your config: + +```js +plugins: { + analyze: { + enabled: true, + // analyze up to 3 failures in detail + analyze: 3, + // group similar failures when 5 or more tests fail + clusterize: 5, + // enable screenshot analysis (requires modal that can analyze screenshots) + vision: false + } +} +``` + +When tests are executed with `--ai` flag, the analyze plugin will: + +**Analyze Individual Failures**: For each failed test (up to the `analyze` limit), it will: + +- Examine the error message and stack trace +- Review the test steps that led to the failure +- Provide a detailed explanation of what likely caused the failure +- Suggest possible fixes and improvements + +Sample Analysis report: + +When analyzing individual failures (less than `clusterize` threshold), the output looks like this: + +``` +đŸĒ„ AI REPORT: +-------------------------------- +→ Cannot submit registration form with invalid email 👀 + +* SUMMARY: Form submission failed due to invalid email format, system correctly shows validation message +* ERROR: expected element ".success-message" to be visible, but it is not present in DOM +* CATEGORY: Data errors (password incorrect, no options in select, invalid format, etc) +* STEPS: I.fillField('#email', 'invalid-email'); I.click('Submit'); I.see('.success-message') +* URL: /register + +``` + +> The 👀 emoji indicates that screenshot analysis was performed (when `vision: true`). + +**Cluster Similar Failures**: When number of failures exceeds the `clusterize` threshold: + +- Groups failures with similar error patterns +- Identifies common root causes +- Suggests fixes that could resolve multiple failures +- Helps prioritize which issues to tackle first + +**Categorize Failures**: Automatically classifies failures into categories like: + +- Browser/connection issues +- Network errors +- Element locator problems +- Navigation errors +- Code errors +- Data validation issues +- etc. + +Clusterization output: + +``` +đŸĒ„ AI REPORT: +_______________________________ + +## Group 1 🔍 + +* SUMMARY: Element locator failures across login flow +* CATEGORY: HTML / page elements (not found, not visible, etc) +* ERROR: Element "#login-button" is not visible +* STEP: I.click('#login-button') +* SUITE: Authentication +* TAG: @login +* AFFECTED TESTS (4): + x Cannot login with valid credentials + x Should show error on invalid login + x Login button should be disabled when form empty + x Should redirect to dashboard after login + +## Group 2 🌐 + +* SUMMARY: API timeout issues during user data fetch +* CATEGORY: Network errors (server error, timeout, etc) +* URL: /api/v1/users +* ERROR: Request failed with status code 504, Gateway Timeout +* SUITE: User Management +* AFFECTED TESTS (3): + x Should load user profile data + x Should display user settings + x Should fetch user notifications + +## Group 3 ⚠ī¸ + +* SUMMARY: Form validation errors on registration page +* CATEGORY: Data errors (password incorrect, no options in select, invalid format, etc) +* ERROR: Expected field "password" to have error "Must be at least 8 characters" +* STEP: I.see('Must be at least 8 characters', '.error-message') +* SUITE: User Registration +* TAG: @registration +* AFFECTED TESTS (2): + x Should validate password requirements + x Should show all validation errors on submit +``` + +If `vision: true` is enabled and your tests take screenshots on failure, the plugin will also analyze screenshots to provide additional visual context about the failure. + +The analysis helps teams: + +- Quickly understand the root cause of failures +- Identify patterns in failing tests +- Prioritize fixes based on impact +- Maintain more stable test suites + +Run tests with both AI and analyze enabled: + +```bash +npx codeceptjs run --ai +``` ## Arbitrary Prompts @@ -377,23 +498,23 @@ helpers: { AI helper will be automatically attached to Playwright, WebDriver, or another web helper you use. It includes the following methods: -* `askGptOnPage` - sends GPT prompt attaching the HTML of the page. Large pages will be split into chunks, according to `chunkSize` config. You will receive responses for all chunks. -* `askGptOnPageFragment` - sends GPT prompt attaching the HTML of the specific element. This method is recommended over `askGptOnPage` as you can reduce the amount of data to be processed. -* `askGptGeneralPrompt` - sends GPT prompt without HTML. -* `askForPageObject` - creates PageObject for you, explained in next section. +- `askGptOnPage` - sends GPT prompt attaching the HTML of the page. Large pages will be split into chunks, according to `chunkSize` config. You will receive responses for all chunks. +- `askGptOnPageFragment` - sends GPT prompt attaching the HTML of the specific element. This method is recommended over `askGptOnPage` as you can reduce the amount of data to be processed. +- `askGptGeneralPrompt` - sends GPT prompt without HTML. +- `askForPageObject` - creates PageObject for you, explained in next section. `askGpt` methods won't remove non-interactive elements, so it is recommended to manually control the size of the sent HTML. Here are some good use cases for this helper: -* get page summaries -* inside pause mode navigate through your application and ask to document pages -* etc... +- get page summaries +- inside pause mode navigate through your application and ask to document pages +- etc... ```js // use it inside test or inside interactive pause // pretend you are technical writer asking for documentation -const pageDoc = await I.askGptOnPageFragment('Act as technical writer, describe what is this page for', '#container'); +const pageDoc = await I.askGptOnPageFragment('Act as technical writer, describe what is this page for', '#container') ``` As of now, those use cases do not apply to test automation but maybe you can apply them to your testing setup. @@ -508,7 +629,7 @@ ai: { prompts: { writeStep: (html, input) => [{ role: 'user', content: 'As a test engineer...' }] healStep: (html, { step, error, prevSteps }) => [{ role: 'user', content: 'As a test engineer...' }] - generatePageObject: (html, extraPrompt = '', rootLocator = null) => [{ role: 'user', content: 'As a test engineer...' }] + generatePageObject: (html, extraPrompt = '', rootLocator = null) => [{ role: 'user', content: 'As a test engineer...' }] } } ``` @@ -531,34 +652,33 @@ ai: { } ``` -* `maxLength`: the size of HTML to cut to not reach the token limit. 50K is the current default but you may try to increase it or even set it to null. -* `simplify`: should we process HTML before sending to GPT. This will remove all non-interactive elements from HTML. -* `minify`: should HTML be additionally minified. This removed empty attributes, shortens notations, etc. -* `interactiveElements`: explicit list of all elements that are considered interactive. -* `textElements`: elements that contain text which can be used for test automation. -* `allowedAttrs`: explicit list of attributes that may be used to construct locators. If you use special `data-` attributes to enable locators, add them to the list. -* `allowedRoles`: list of roles that make standard elements interactive. +- `maxLength`: the size of HTML to cut to not reach the token limit. 50K is the current default but you may try to increase it or even set it to null. +- `simplify`: should we process HTML before sending to GPT. This will remove all non-interactive elements from HTML. +- `minify`: should HTML be additionally minified. This removed empty attributes, shortens notations, etc. +- `interactiveElements`: explicit list of all elements that are considered interactive. +- `textElements`: elements that contain text which can be used for test automation. +- `allowedAttrs`: explicit list of attributes that may be used to construct locators. If you use special `data-` attributes to enable locators, add them to the list. +- `allowedRoles`: list of roles that make standard elements interactive. It is recommended to try HTML processing on one of your web pages before launching AI features of CodeceptJS. - To do that open the common page of your application and using DevTools copy the outerHTML of `` element. Don't use `Page Source` for that, as it may not include dynamically added HTML elements. Save this HTML into a file and create a NodeJS script: ```js -const { removeNonInteractiveElements } = require('codeceptjs/lib/html'); -const fs = require('fs'); +const { removeNonInteractiveElements } = require('codeceptjs/lib/html') +const fs = require('fs') const htmlOpts = { interactiveElements: ['a', 'input', 'button', 'select', 'textarea', 'label', 'option'], allowedAttrs: ['id', 'for', 'class', 'name', 'type', 'value', 'aria-labelledby', 'aria-label', 'label', 'placeholder', 'title', 'alt', 'src', 'role'], textElements: ['label', 'h1', 'h2'], allowedRoles: ['button', 'checkbox', 'search', 'textbox', 'tab'], -}; +} -html = fs.readFileSync('saved.html', 'utf8'); -const result = removeNonInteractiveElements(html, htmlOpts); +html = fs.readFileSync('saved.html', 'utf8') +const result = removeNonInteractiveElements(html, htmlOpts) -console.log(result); +console.log(result) ``` Tune the options until you are satisfied with the results and use this as `html` config for `ai` section inside `codecept.conf` file. @@ -571,9 +691,7 @@ For instance, if you use `data-qa` attributes to specify locators and you want t // inside codecept.conf.js ai: { html: { - allowedAttrs: [ - 'data-qa', 'id', 'for', 'class', 'name', 'type', 'value', 'aria-labelledby', 'aria-label', 'label', 'placeholder', 'title', 'alt', 'src', 'role' - ] + allowedAttrs: ['data-qa', 'id', 'for', 'class', 'name', 'type', 'value', 'aria-labelledby', 'aria-label', 'label', 'placeholder', 'title', 'alt', 'src', 'role'] } } } diff --git a/docs/basics.md b/docs/basics.md index 6904c78d9..39134b4b7 100644 --- a/docs/basics.md +++ b/docs/basics.md @@ -8,12 +8,12 @@ title: Getting Started CodeceptJS is a modern end to end testing framework with a special BDD-style syntax. The tests are written as a linear scenario of the user's action on a site. ```js -Feature('CodeceptJS demo'); +Feature('CodeceptJS demo') Scenario('check Welcome page on site', ({ I }) => { - I.amOnPage('/'); - I.see('Welcome'); -}); + I.amOnPage('/') + I.see('Welcome') +}) ``` Tests are expected to be written in **ECMAScript 7**. @@ -38,10 +38,10 @@ However, because of the difference in backends and their limitations, they are n Refer to following guides to more information on: -* [â–ļ Playwright](/playwright) -* [â–ļ WebDriver](/webdriver) -* [â–ļ Puppeteer](/puppeteer) -* [â–ļ TestCafe](/testcafe) +- [â–ļ Playwright](/playwright) +- [â–ļ WebDriver](/webdriver) +- [â–ļ Puppeteer](/puppeteer) +- [â–ļ TestCafe](/testcafe) > ℹ Depending on a helper selected a list of available actions may change. @@ -50,15 +50,14 @@ or enable [auto-completion by generating TypeScript definitions](#intellisense). > 🤔 It is possible to access API of a backend you use inside a test or a [custom helper](/helpers/). For instance, to use Puppeteer API inside a test use [`I.usePuppeteerTo`](/helpers/Puppeteer/#usepuppeteerto) inside a test. Similar methods exist for each helper. - ## Writing Tests Tests are written from a user's perspective. There is an actor (represented as `I`) which contains actions taken from helpers. A test is written as a sequence of actions performed by an actor: ```js -I.amOnPage('/'); -I.click('Login'); -I.see('Please Login', 'h1'); +I.amOnPage('/') +I.click('Login') +I.see('Please Login', 'h1') // ... ``` @@ -70,40 +69,39 @@ Start a test by opening a page. Use the `I.amOnPage()` command for this: ```js // When "http://site.com" is url in config -I.amOnPage('/'); // -> opens http://site.com/ -I.amOnPage('/about'); // -> opens http://site.com/about -I.amOnPage('https://google.com'); // -> https://google.com +I.amOnPage('/') // -> opens http://site.com/ +I.amOnPage('/about') // -> opens http://site.com/about +I.amOnPage('https://google.com') // -> https://google.com ``` When an URL doesn't start with a protocol (http:// or https://) it is considered to be a relative URL and will be appended to the URL which was initially set-up in the config. > It is recommended to use a relative URL and keep the base URL in the config file, so you can easily switch between development, stage, and production environments. - ### Locating Element Element can be found by CSS or XPath locators. ```js -I.seeElement('.user'); // element with CSS class user -I.seeElement('//button[contains(., "press me")]'); // button +I.seeElement('.user') // element with CSS class user +I.seeElement('//button[contains(., "press me")]') // button ``` By default CodeceptJS tries to guess the locator type. In order to specify the exact locator type you can pass an object called **strict locator**. ```js -I.seeElement({css: 'div.user'}); -I.seeElement({xpath: '//div[@class=user]'}); +I.seeElement({ css: 'div.user' }) +I.seeElement({ xpath: '//div[@class=user]' }) ``` Strict locators allow to specify additional locator types: ```js // locate form element by name -I.seeElement({name: 'password'}); +I.seeElement({ name: 'password' }) // locate element by React component and props -I.seeElement({react: 'user-profile', props: {name: 'davert'}}); +I.seeElement({ react: 'user-profile', props: { name: 'davert' } }) ``` In [mobile testing](https://codecept.io/mobile/#locating-elements) you can use `~` to specify the accessibility id to locate an element. In web application you can locate elements by their `aria-label` value. @@ -111,7 +109,7 @@ In [mobile testing](https://codecept.io/mobile/#locating-elements) you can use ` ```js // locate element by [aria-label] attribute in web // or by accessibility id in mobile -I.seeElement('~username'); +I.seeElement('~username') ``` > [â–ļ Learn more about using locators in CodeceptJS](/locators). @@ -124,7 +122,7 @@ By default CodeceptJS tries to find the button or link with the exact text on it ```js // search for link or button -I.click('Login'); +I.click('Login') ``` If none was found, CodeceptJS tries to find a link or button containing that text. In case an image is clickable its `alt` attribute will be checked for text inclusion. Form buttons will also be searched by name. @@ -132,8 +130,8 @@ If none was found, CodeceptJS tries to find a link or button containing that tex To narrow down the results you can specify a context in the second parameter. ```js -I.click('Login', '.nav'); // search only in .nav -I.click('Login', {css: 'footer'}); // search only in footer +I.click('Login', '.nav') // search only in .nav +I.click('Login', { css: 'footer' }) // search only in footer ``` > To skip guessing the locator type, pass in a strict locator - A locator starting with '#' or '.' is considered to be CSS. Locators starting with '//' or './/' are considered to be XPath. @@ -142,9 +140,9 @@ You are not limited to buttons and links. Any element can be found by passing in ```js // click element by CSS -I.click('#signup'); +I.click('#signup') // click element located by special test-id attribute -I.click('//dev[@test-id="myid"]'); +I.click('//dev[@test-id="myid"]') ``` > ℹ If click doesn't work in a test but works for user, it is possible that frontend application is not designed for automated testing. To overcome limitation of standard click in this edgecase use `forceClick` method. It will emulate click instead of sending native event. This command will click an element no matter if this element is visible or animating. It will send JavaScript "click" event to it. @@ -159,19 +157,19 @@ Let's submit this sample form for a test: ```html
- -
- -
- -
- -
- -
+ +
+ +
+ +
+ +
+ +
``` @@ -179,14 +177,14 @@ We need to fill in all those fields and click the "Update" button. CodeceptJS ma ```js // we are using label to match user_name field -I.fillField('Name', 'Miles'); +I.fillField('Name', 'Miles') // we can use input name -I.fillField('user[email]','miles@davis.com'); +I.fillField('user[email]', 'miles@davis.com') // select element by label, choose option by text -I.selectOption('Role','Admin'); +I.selectOption('Role', 'Admin') // click 'Save' button, found by text -I.checkOption('Accept'); -I.click('Save'); +I.checkOption('Accept') +I.click('Save') ``` > ℹ `selectOption` works only with standard ` HTML elements. If your selectbox is created by React, Vue, or as a component of any other framework, this method potentially won't work with it. Use `click` to manipulate it. @@ -197,18 +195,18 @@ Alternative scenario: ```js // we are using CSS -I.fillField('#user_name', 'Miles'); -I.fillField('#user_email','miles@davis.com'); +I.fillField('#user_name', 'Miles') +I.fillField('#user_email', 'miles@davis.com') // select element by label, option by value -I.selectOption('#user_role','1'); +I.selectOption('#user_role', '1') // click 'Update' button, found by name -I.click('submitButton', '#update_form'); +I.click('submitButton', '#update_form') ``` To fill in sensitive data use the `secret` function, it won't expose actual value in logs. ```js -I.fillField('password', secret('123456')); +I.fillField('password', secret('123456')) ``` > ℹī¸ Learn more about [masking secret](/secrets/) output @@ -222,11 +220,11 @@ The most general and common assertion is `see`, which checks visilibility of a t ```js // Just a visible text on a page -I.see('Hello'); +I.see('Hello') // text inside .msg element -I.see('Hello', '.msg'); +I.see('Hello', '.msg') // opposite -I.dontSee('Bye'); +I.dontSee('Bye') ``` You should provide a text as first argument and, optionally, a locator to search for a text in a context. @@ -234,16 +232,16 @@ You should provide a text as first argument and, optionally, a locator to search You can check that specific element exists (or not) on a page, as it was described in [Locating Element](#locating-element) section. ```js -I.seeElement('.notice'); -I.dontSeeElement('.error'); +I.seeElement('.notice') +I.dontSeeElement('.error') ``` Additional assertions: ```js -I.seeInCurrentUrl('/user/miles'); -I.seeInField('user[name]', 'Miles'); -I.seeInTitle('My Website'); +I.seeInCurrentUrl('/user/miles') +I.seeInField('user[name]', 'Miles') +I.seeInTitle('My Website') ``` To see all possible assertions, check the helper's reference. @@ -257,15 +255,15 @@ Imagine the application generates a password, and you want to ensure that user c ```js Scenario('login with generated password', async ({ I }) => { - I.fillField('email', 'miles@davis.com'); - I.click('Generate Password'); - const password = await I.grabTextFrom('#password'); - I.click('Login'); - I.fillField('email', 'miles@davis.com'); - I.fillField('password', password); - I.click('Log in!'); - I.see('Hello, Miles'); -}); + I.fillField('email', 'miles@davis.com') + I.click('Generate Password') + const password = await I.grabTextFrom('#password') + I.click('Login') + I.fillField('email', 'miles@davis.com') + I.fillField('password', password) + I.click('Log in!') + I.see('Hello, Miles') +}) ``` The `grabTextFrom` action is used to retrieve the text from an element. All actions starting with the `grab` prefix are expected to return data. In order to synchronize this step with a scenario you should pause the test execution with the `await` keyword of ES6. To make it work, your test should be written inside a async function (notice `async` in its definition). @@ -273,9 +271,9 @@ The `grabTextFrom` action is used to retrieve the text from an element. All acti ```js Scenario('use page title', async ({ I }) => { // ... - const password = await I.grabTextFrom('#password'); - I.fillField('password', password); -}); + const password = await I.grabTextFrom('#password') + I.fillField('password', password) +}) ``` ### Waiting @@ -285,9 +283,9 @@ Sometimes that may cause delays. A test may fail while trying to click an elemen To handle these cases, the `wait*` methods has been introduced. ```js -I.waitForElement('#agree_button', 30); // secs +I.waitForElement('#agree_button', 30) // secs // clicks a button only when it is visible -I.click('#agree_button'); +I.click('#agree_button') ``` ## How It Works @@ -304,16 +302,16 @@ If you want to get information from a running test you can use `await` inside th ```js Scenario('try grabbers', async ({ I }) => { - let title = await I.grabTitle(); -}); + let title = await I.grabTitle() +}) ``` then you can use those variables in assertions: ```js -var title = await I.grabTitle(); -var assert = require('assert'); -assert.equal(title, 'CodeceptJS'); +var title = await I.grabTitle() +var assert = require('assert') +assert.equal(title, 'CodeceptJS') ``` It is important to understand the usage of **async** functions in CodeceptJS. While non-returning actions can be called without await, if an async function uses `grab*` action it must be called with `await`: @@ -321,15 +319,15 @@ It is important to understand the usage of **async** functions in CodeceptJS. Wh ```js // a helper function async function getAllUsers(I) { - const users = await I.grabTextFrom('.users'); - return users.filter(u => u.includes('active')) + const users = await I.grabTextFrom('.users') + return users.filter(u => u.includes('active')) } // a test Scenario('try helper functions', async ({ I }) => { // we call function with await because it includes `grab` - const users = await getAllUsers(I); -}); + const users = await getAllUsers(I) +}) ``` If you miss `await` you get commands unsynchrhonized. And this will result to an error like this: @@ -388,7 +386,6 @@ npx codeceptjs run --grep "slow" It is recommended to [filter tests by tags](/advanced/#tags). - > For more options see [full reference of `run` command](/commands/#run). ### Parallel Run @@ -416,7 +413,7 @@ exports.config = { }, include: { // current actor and page objects - } + }, } ``` @@ -433,12 +430,12 @@ Tuning configuration for helpers like WebDriver, Puppeteer can be hard, as it re For instance, you can set the window size or toggle headless mode, no matter of which helpers are actually used. ```js -const { setHeadlessWhen, setWindowSize } = require('@codeceptjs/configure'); +const { setHeadlessWhen, setWindowSize } = require('@codeceptjs/configure') // run headless when CI environment variable set -setHeadlessWhen(process.env.CI); +setHeadlessWhen(process.env.CI) // set window size for any helper: Puppeteer, WebDriver, TestCafe -setWindowSize(1600, 1200); +setWindowSize(1600, 1200) exports.config = { // ... @@ -455,8 +452,8 @@ By using the interactive shell you can stop execution at any point and type in a This is especially useful while writing a new scratch. After opening a page call `pause()` to start interacting with a page: ```js -I.amOnPage('/'); -pause(); +I.amOnPage('/') +pause() ``` Try to perform your scenario step by step. Then copy succesful commands and insert them into a test. @@ -492,7 +489,7 @@ To see all available commands, press TAB two times to see list of all actions in PageObjects and other variables can also be passed to as object: ```js -pause({ loginPage, data: 'hi', func: () => console.log('hello') }); +pause({ loginPage, data: 'hi', func: () => console.log('hello') }) ``` Inside a pause mode you can use `loginPage`, `data`, `func` variables. @@ -519,7 +516,6 @@ npx codeceptjs run -p pauseOnFail > To enable pause after a test without a plugin you can use `After(pause)` inside a test file. - ### Screenshot on Failure By default CodeceptJS saves a screenshot of a failed test. @@ -536,21 +532,22 @@ To see how the test was executed, use [stepByStepReport Plugin](/plugins/#stepby Common preparation steps like opening a web page or logging in a user, can be placed in the `Before` or `Background` hooks: ```js -Feature('CodeceptJS Demonstration'); +Feature('CodeceptJS Demonstration') -Before(({ I }) => { // or Background - I.amOnPage('/documentation'); -}); +Before(({ I }) => { + // or Background + I.amOnPage('/documentation') +}) Scenario('test some forms', ({ I }) => { - I.click('Create User'); - I.see('User is valid'); - I.dontSeeInCurrentUrl('/documentation'); -}); + I.click('Create User') + I.see('User is valid') + I.dontSeeInCurrentUrl('/documentation') +}) Scenario('test title', ({ I }) => { - I.seeInTitle('Example application'); -}); + I.seeInTitle('Example application') +}) ``` Same as `Before` you can use `After` to run teardown for each scenario. @@ -563,13 +560,13 @@ You can use them to execute handlers that will setup your environment. `BeforeSu ```js BeforeSuite(({ I }) => { - I.syncDown('testfolder'); -}); + I.syncDown('testfolder') +}) AfterSuite(({ I }) => { - I.syncUp('testfolder'); - I.clearDir('testfolder'); -}); + I.syncUp('testfolder') + I.clearDir('testfolder') +}) ``` ## Retries @@ -577,7 +574,7 @@ AfterSuite(({ I }) => { ### Auto Retry Each failed step is auto-retried by default via [retryFailedStep Plugin](/plugins/#retryfailedstep). -If this is not expected, this plugin can be disabled in a config. +If this is not expected, this plugin can be disabled in a config. > **[retryFailedStep plugin](/plugins/#retryfailedstep) is enabled by default** incide global configuration @@ -589,30 +586,29 @@ If you have a step which often fails, you can retry execution for this single st Use the `retry()` function before an action to ask CodeceptJS to retry it on failure: ```js -I.retry().see('Welcome'); +I.retry().see('Welcome') ``` If you'd like to retry a step more than once, pass the amount as a parameter: ```js -I.retry(3).see('Welcome'); +I.retry(3).see('Welcome') ``` Additional options can be provided to `retry`, so you can set the additional options (defined in [promise-retry](https://www.npmjs.com/package/promise-retry) library). - ```js // retry action 3 times waiting for 0.1 second before next try -I.retry({ retries: 3, minTimeout: 100 }).see('Hello'); +I.retry({ retries: 3, minTimeout: 100 }).see('Hello') // retry action 3 times waiting no more than 3 seconds for last retry -I.retry({ retries: 3, maxTimeout: 3000 }).see('Hello'); +I.retry({ retries: 3, maxTimeout: 3000 }).see('Hello') // retry 2 times if error with message 'Node not visible' happens I.retry({ retries: 2, - when: err => err.message === 'Node not visible' -}).seeElement('#user'); + when: err => err.message === 'Node not visible', +}).seeElement('#user') ``` Pass a function to the `when` option to retry only when an error matches the expected one. @@ -623,11 +619,11 @@ To retry a group of steps enable [retryTo plugin](/plugins/#retryto): ```js // retry these steps 5 times before failing -await retryTo((tryNum) => { - I.switchTo('#editor frame'); - I.click('Open'); +await retryTo(tryNum => { + I.switchTo('#editor frame') + I.click('Open') I.see('Opened') -}, 5); +}, 5) ``` ### Retry Scenario @@ -640,38 +636,57 @@ You can set the number of a retries for a feature: ```js Scenario('Really complex', ({ I }) => { // test goes here -}).retry(2); +}).retry(2) // alternative -Scenario('Really complex', { retries: 2 },({ I }) => {}); +Scenario('Really complex', { retries: 2 }, ({ I }) => {}) ``` This scenario will be restarted two times on a failure. Unlike retry step, there is no `when` condition supported for retries on a scenario level. -### Retry Before +### Retry Before + +To retry `Before`, `BeforeSuite`, `After`, `AfterSuite` hooks, call `retry()` after declaring the hook. + +- `Before().retry()` +- `BeforeSuite().retry()` +- `After().retry()` +- `AfterSuite().retry()` -To retry `Before`, `BeforeSuite`, `After`, `AfterSuite` hooks, add corresponding option to a `Feature`: +For instance, to retry Before hook 3 times before failing: -* `retryBefore` -* `retryBeforeSuite` -* `retryAfter` -* `retryAfterSuite` +```js +Before(({ I }) => { + I.amOnPage('/') +}).retry(3) +``` -For instance, to retry Before hook 3 times: +Same applied for `BeforeSuite`: ```js -Feature('this have a flaky Befure', { retryBefore: 3 }) +BeforeSuite(() => { + // do some prepreations +}).retry(3) ``` -Multiple options of different values can be set at the same time +Alternatively, retry options can be set on Feature level: + +```js +Feature('my tests', { + retryBefore: 3, + retryBeforeSuite: 2, + retryAfter: 1, + retryAfterSuite: 3, +}) +``` ### Retry Feature To set this option for all scenarios in a file, add `retry` to a feature: ```js -Feature('Complex JS Stuff').retry(3); +Feature('Complex JS Stuff').retry(3) // or Feature('Complex JS Stuff', { retries: 3 }) ``` @@ -701,7 +716,7 @@ retry: { Before: ..., BeforeSuite: ..., After: ..., - AfterSuite: ..., + AfterSuite: ..., } ``` @@ -712,32 +727,32 @@ Multiple retry configs can be added via array. To use different retry configs fo retry: [ { // enable this config only for flaky tests - grep: '@flaky', + grep: '@flaky', Before: 3 Scenario: 3 - }, + }, { // retry less when running slow tests - grep: '@slow' + grep: '@slow' Scenario: 1 Before: 1 }, { - // retry all BeforeSuite + // retry all BeforeSuite BeforeSuite: 3 } ] ``` -When using `grep` with `Before`, `After`, `BeforeSuite`, `AfterSuite`, a suite title will be checked for included value. +When using `grep` with `Before`, `After`, `BeforeSuite`, `AfterSuite`, a suite title will be checked for included value. > ℹī¸ `grep` value can be string or regexp Rules are applied in the order of array element, so the last option will override a previous one. Global retries config can be overridden in a file as described previously. -### Retry Run +### Retry Run On the highest level of the "retry pyramid" there is an option to retry a complete run multiple times. -Even this is the slowest option of all, it can be helpful to detect flaky tests. +Even this is the slowest option of all, it can be helpful to detect flaky tests. [`run-rerun`](https://codecept.io/commands/#run-rerun) command will restart the run multiple times to values you provide. You can set minimal and maximal number of restarts in configuration file. @@ -745,7 +760,6 @@ Even this is the slowest option of all, it can be helpful to detect flaky tests. npx codeceptjs run-rerun ``` - [Here are some ideas](https://github.com/codeceptjs/CodeceptJS/pull/231#issuecomment-249554933) on where to use BeforeSuite hooks. ## Within @@ -756,14 +770,14 @@ Everything executed in its context will be narrowed to context specified by loca Usage: `within('section', ()=>{})` ```js -I.amOnPage('https://github.com'); +I.amOnPage('https://github.com') within('.js-signup-form', () => { - I.fillField('user[login]', 'User'); - I.fillField('user[email]', 'user@user.com'); - I.fillField('user[password]', 'user@user.com'); - I.click('button'); -}); -I.see('There were problems creating your account.'); + I.fillField('user[login]', 'User') + I.fillField('user[email]', 'user@user.com') + I.fillField('user[password]', 'user@user.com') + I.click('button') +}) +I.see('There were problems creating your account.') ``` > ⚠ `within` can cause problems when used incorrectly. If you see a weird behavior of a test try to refactor it to not use `within`. It is recommended to keep within for simplest cases when possible. @@ -771,23 +785,22 @@ I.see('There were problems creating your account.'); `within` can also work with IFrames. A special `frame` locator is required to locate the iframe and get into its context. - See example: ```js -within({frame: "#editor"}, () => { - I.see('Page'); -}); +within({ frame: '#editor' }, () => { + I.see('Page') +}) ``` > ℹ IFrames can also be accessed via `I.switchTo` command of a corresponding helper. -Nested IFrames can be set by passing an array *(WebDriver & Puppeteer only)*: +Nested IFrames can be set by passing an array _(WebDriver & Puppeteer only)_: ```js -within({frame: [".content", "#editor"]}, () => { - I.see('Page'); -}); +within({ frame: ['.content', '#editor'] }, () => { + I.see('Page') +}) ``` When running steps inside, a within block will be shown with a shift: @@ -799,26 +812,26 @@ Within can return a value, which can be used in a scenario: ```js // inside async function const val = await within('#sidebar', () => { - return I.grabTextFrom({ css: 'h1' }); -}); -I.fillField('Description', val); + return I.grabTextFrom({ css: 'h1' }) +}) +I.fillField('Description', val) ``` ## Conditional Actions -There is a way to execute unsuccessful actions to without failing a test. +There is a way to execute unsuccessful actions to without failing a test. This might be useful when you might need to click "Accept cookie" button but probably cookies were already accepted. To handle these cases `tryTo` function was introduced: ```js -tryTo(() => I.click('Accept', '.cookies')); +tryTo(() => I.click('Accept', '.cookies')) ``` You may also use `tryTo` for cases when you deal with uncertainty on page: -* A/B testing -* soft assertions -* cookies & gdpr +- A/B testing +- soft assertions +- cookies & gdpr `tryTo` function is enabled by default via [tryTo plugin](/plugins/#tryto) @@ -828,20 +841,19 @@ There is a simple way to add additional comments to your test scenario: Use the `say` command to print information to screen: ```js -I.say('I am going to publish post'); -I.say('I enter title and body'); -I.say('I expect post is visible on site'); +I.say('I am going to publish post') +I.say('I enter title and body') +I.say('I expect post is visible on site') ``` Use the second parameter to pass in a color value (ASCII). ```js -I.say('This is red', 'red'); //red is used -I.say('This is blue', 'blue'); //blue is used -I.say('This is by default'); //cyan is used +I.say('This is red', 'red') //red is used +I.say('This is blue', 'blue') //blue is used +I.say('This is by default') //cyan is used ``` - ## IntelliSense ![Edit](/img/edit.gif) @@ -867,33 +879,32 @@ Create a file called `jsconfig.json` in your project root directory, unless you Alternatively, you can include `/// ` into your test files to get method autocompletion while writing tests. - ## Multiple Sessions CodeceptJS allows to run several browser sessions inside a test. This can be useful for testing communication between users inside a chat or other systems. To open another browser use the `session()` function as shown in the example: ```js Scenario('test app', ({ I }) => { - I.amOnPage('/chat'); - I.fillField('name', 'davert'); - I.click('Sign In'); - I.see('Hello, davert'); + I.amOnPage('/chat') + I.fillField('name', 'davert') + I.click('Sign In') + I.see('Hello, davert') session('john', () => { // another session started - I.amOnPage('/chat'); - I.fillField('name', 'john'); - I.click('Sign In'); - I.see('Hello, john'); - }); + I.amOnPage('/chat') + I.fillField('name', 'john') + I.click('Sign In') + I.see('Hello, john') + }) // switching back to default session - I.fillField('message', 'Hi, john'); + I.fillField('message', 'Hi, john') // there is a message from current user - I.see('me: Hi, john', '.messages'); + I.see('me: Hi, john', '.messages') session('john', () => { // let's check if john received it - I.see('davert: Hi, john', '.messages'); - }); -}); + I.see('davert: Hi, john', '.messages') + }) +}) ``` The `session` function expects the first parameter to be the name of the session. You can switch back to this session by using the same name. @@ -901,10 +912,10 @@ The `session` function expects the first parameter to be the name of the session You can override the configuration for the session by passing a second parameter: ```js -session('john', { browser: 'firefox' } , () => { +session('john', { browser: 'firefox' }, () => { // run this steps in firefox - I.amOnPage('/'); -}); + I.amOnPage('/') +}) ``` or just start the session without switching to it. Call `session` passing only its name: @@ -924,15 +935,16 @@ Scenario('test', ({ I }) => { }); } ``` + `session` can return a value which can be used in a scenario: ```js // inside async function const val = await session('john', () => { - I.amOnPage('/info'); - return I.grabTextFrom({ css: 'h1' }); -}); -I.fillField('Description', val); + I.amOnPage('/info') + return I.grabTextFrom({ css: 'h1' }) +}) +I.fillField('Description', val) ``` Functions passed into a session can use the `I` object, page objects, and any other objects declared for the scenario. @@ -940,17 +952,15 @@ This function can also be declared as async (but doesn't work as generator). Also, you can use `within` inside a session, but you can't call session from inside `within`. - ## Skipping Like in Mocha you can use `x` and `only` to skip tests or to run a single test. -* `xScenario` - skips current test -* `Scenario.skip` - skips current test -* `Scenario.only` - executes only the current test -* `xFeature` - skips current suite -* `Feature.skip` - skips the current suite - +- `xScenario` - skips current test +- `Scenario.skip` - skips current test +- `Scenario.only` - executes only the current test +- `xFeature` - skips current suite +- `Feature.skip` - skips the current suite ## Todo Test @@ -961,19 +971,19 @@ This test will be skipped like with regular `Scenario.skip` but with additional Use it with a test body as a test plan: ```js -Scenario.todo('Test', I => { -/** - * 1. Click to field - * 2. Fill field - * - * Result: - * 3. Field contains text - */ -}); +Scenario.todo('Test', I => { + /** + * 1. Click to field + * 2. Fill field + * + * Result: + * 3. Field contains text + */ +}) ``` Or even without a test body: ```js -Scenario.todo('Test'); +Scenario.todo('Test') ``` diff --git a/docs/changelog.md b/docs/changelog.md index bd22e1210..5cd90701a 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -7,14 +7,413 @@ layout: Section # Releases +## 3.7.0 + +This release introduces major new features and internal refactoring. It is an important step toward the 4.0 release planned soon, which will remove all deprecations introduced in 3.7. + +🛩ī¸ _Features_ + +### đŸ”Ĩ **Native Element Functions** + +A new [Els API](/els) for direct element interactions has been introduced. This API provides low-level element manipulation functions for more granular control over element interactions and assertions: + +- `element()` - perform custom operations on first matching element +- `eachElement()` - iterate and perform operations on each matching element +- `expectElement()` - assert condition on first matching element +- `expectAnyElement()` - assert condition matches at least one element +- `expectAllElements()` - assert condition matches all elements + +Example using all element functions: + +```js +const { element, eachElement, expectElement, expectAnyElement, expectAllElements } = require('codeceptjs/els') + +// ... + +Scenario('element functions demo', async ({ I }) => { + // Get attribute of first button + const attr = await element('.button', async el => await el.getAttribute('data-test')) + + // Log text of each list item + await eachElement('.list-item', async (el, idx) => { + console.log(`Item ${idx}: ${await el.getText()}`) + }) + + // Assert first submit button is enabled + await expectElement('.submit', async el => await el.isEnabled()) + + // Assert at least one product is in stock + await expectAnyElement('.product', async el => { + return (await el.getAttribute('data-status')) === 'in-stock' + }) + + // Assert all required fields have required attribute + await expectAllElements('.required', async el => { + return (await el.getAttribute('required')) !== null + }) +}) +``` + +[Els](/els) functions expose the native API of Playwright, WebDriver, and Puppeteer helpers. The actual `el` API will differ depending on which helper is used, which affects test code interoperability. + +### 🔮 **Effects introduced** + +[Effects](/effects) is a new concept that encompasses all functions that can modify scenario flow. These functions are now part of a single module. Previously, they were used via plugins like `tryTo` and `retryTo`. Now, it is recommended to import them directly: + +```js +const { tryTo, retryTo } = require('codeceptjs/effects') + +Scenario(..., ({ I }) => { + I.amOnPage('/') + // tryTo returns boolean if code in function fails + // use it to execute actions that may fail but not affect the test flow + // for instance, for accepting cookie banners + const isItWorking = tryTo(() => I.see('It works')) + + // run multiple steps and retry on failure + retryTo(() => { + I.click('Start Working!'); + I.see('It works') + }, 5); +}) +``` + +Previously `tryTo` and `retryTo` were available globally via plugins. This behavior is deprecated as of 3.7 and will be removed in 4.0. Import these functions via effects instead. Similarly, `within` will be moved to `effects` in 4.0. + +### ✅ `check` command added + +``` +npx codeceptjs check +``` + +This command can be executed locally or in CI environments to verify that tests can be executed correctly. + +It checks: + +- configuration +- tests +- helpers + +And will attempt to open and close a browser if a corresponding helper is enabled. If something goes wrong, the command will fail with a message. Run `npx codeceptjs check` on CI before actual tests to ensure everything is set up correctly and all services and browsers are accessible. + +For GitHub Actions, add this command: + +```yaml +steps: + # ... + - name: check configuration and browser + run: npx codeceptjs check + + - name: run codeceptjs tests + run: npx codeceptjs run-workers 4 +``` + +### 👨‍đŸ”Ŧ **analyze plugin introduced** + +This [AI plugin](./plugins#analyze) analyzes failures in test runs and provides brief summaries. For more than 5 failures, it performs cluster analysis and aggregates failures into groups, attempting to find common causes. It is recommended to use Deepseek R1 model or OpenAI o3 for better reasoning on clustering: + +```js +â€ĸ SUMMARY The test failed because the expected text "Sign in" was not found on the page, indicating a possible issue with HTML elements or their visibility. +â€ĸ ERROR expected web application to include "Sign in" +â€ĸ CATEGORY HTML / page elements (not found, not visible, etc) +â€ĸ URL http://127.0.0.1:3000/users/sign_in +``` + +For fewer than 5 failures, they are analyzed individually. If a visual recognition model is connected, AI will also scan screenshots to suggest potential failure causes (missing button, missing text, etc). + +This plugin should be paired with the newly added [`pageInfo` plugin](./plugins/#pageInfo) which stores important information like URL, console logs, and error classes for further analysis. + +### 👨‍đŸ’ŧ **autoLogin plugin** renamed to **auth plugin** + +[`auth`](/plugins#auth) is the new name for the autoLogin plugin and aims to solve common authorization issues. In 3.7 it can use Playwright's storage state to load authorization cookies in a browser on start. So if a user is already authorized, a browser session starts with cookies already loaded for this user. If you use Playwright, you can enable this behavior using the `loginAs` method inside a `BeforeSuite` hook: + +```js +BeforeSuite(({ loginAs }) => loginAs('user')) +``` + +The previous behavior where `loginAs` was called from a `Before` hook also works. However, cookie loading and authorization checking is performed after the browser starts. + +#### Metadata introduced + +Meta information in key-value format can be attached to Scenarios to provide more context when reporting tests: + +```js +// add Jira issue to scenario +Scenario('...', () => { + // ... +}).meta('JIRA', 'TST-123') + +// or pass meta info in the beginning of scenario: +Scenario('my test linked to Jira', meta: { issue: 'TST-123' }, () => { + // ... +}) +``` + +By default, Playwright helpers add browser and window size as meta information to tests. + +### đŸ‘ĸ Custom Steps API + +Custom Steps or Sections API introduced to group steps into sections: + +```js +const { Section } = require('codeceptjs/steps'); + +Scenario({ I } => { + I.amOnPage('/projects'); + + // start section "Create project" + Section('Create a project'); + I.click('Create'); + I.fillField('title', 'Project 123') + I.click('Save') + I.see('Project created') + // calling Section with empty param closes previous section + Section() + + // previous section automatically closes + // when new section starts + Section('open project') + // ... +}); +``` + +To hide steps inside a section from output use `Section().hidden()` call: + +```js +Section('Create a project').hidden() +// next steps are not printed: +I.click('Create') +I.fillField('title', 'Project 123') +Section() +``` + +Alternative syntax for closing section: `EndSection`: + +```js +const { Section, EndSection } = require('codeceptjs/steps'); + +// ... +Scenario(..., ({ I }) => // ... + + Section('Create a project').hidden() + // next steps are not printed: + I.click('Create'); + I.fillField('title', 'Project 123') + EndSection() +``` + +Also available BDD-style pre-defined sections: + +```js +const { Given, When, Then } = require('codeceptjs/steps'); + +// ... +Scenario(..., ({ I }) => // ... + + Given('I have a project') + // next steps are not printed: + I.click('Create'); + I.fillField('title', 'Project 123') + + When('I open project'); + // ... + + Then('I should see analytics in a project') + //.... +``` + +### đŸĨž Step Options + +Better syntax to set general step options for specific tests. + +Use it to set timeout or retries for specific steps: + +```js +const step = require('codeceptjs/steps'); + +Scenario(..., ({ I }) => // ... + I.click('Create', step.timeout(10).retry(2)); + //.... +``` + +Alternative syntax: + +```js +const { stepTimeout, stepRetry } = require('codeceptjs/steps'); + +Scenario(..., ({ I }) => // ... + I.click('Create', stepTimeout(10)); + I.see('Created', stepRetry(2)); + //.... +``` + +This change deprecates previous syntax: + +- `I.limitTime().act(...)` => replaced with `I.act(..., stepTimeout())` +- `I.retry().act(...)` => replaced with `I.act(..., stepRetry())` + +Step options should be passed as the very last argument to `I.action()` call. + +Step options can be used to pass additional options to currently existing methods: + +```js +const { stepOpts } = require('codeceptjs/steps') + +I.see('SIGN IN', stepOpts({ ignoreCase: true })) +``` + +Currently this works only on `see` and only with `ignoreCase` param. +However, this syntax will be extended in next versions. + +### Test object can be injected into Scenario + +API for direct access to test object inside Scenario or hooks to add metadata or artifacts: + +```js +BeforeSuite(({ suite }) => { + // no test object here, test is not created yet +}) + +Before(({ test }) => { + // add artifact to test + test.artifacts.myScreenshot = 'screenshot' +}) + +Scenario('test store-test-and-suite test', ({ test }) => { + // add custom meta data + test.meta.browser = 'chrome' +}) + +After(({ test }) => {}) +``` + +Object for `suite` is also injected for all Scenario and hooks. + +### Notable changes + +- Load official Gherkin translations into CodeceptJS. See [#4784](https://github.com/codeceptjs/CodeceptJS/issues/4784) by **[ebo-zig](https://github.com/ebo-zig)** +- đŸ‡ŗ🇱 `NL` translation introduced by **[ebo-zig](https://github.com/ebo-zig)** in [#4784](https://github.com/codeceptjs/CodeceptJS/issues/4784): +- **[Playwright]** Improved experience to highlight and print elements in debug mode +- `codeceptjs run` fails on CI if no tests were executed. This helps to avoid false positive checks. Use `DONT_FAIL_ON_EMPTY_RUN` env variable to disable this behavior +- Various console output improvements +- AI suggested fixes from `heal` plugin (which heals failing tests on the fly) shown in `run-workers` command +- `plugin/standatdActingHelpers` replaced with `Container.STANDARD_ACTING_HELPERS` + +### 🐛 _Bug Fixes_ + +- Fixed timeouts for `BeforeSuite` and `AfterSuite` +- Fixed stucking process on session switch + +### 🎇 Internal Refactoring + +This section is listed briefly. A new dedicated page for internal API concepts will be added to documentation + +- File structure changed: + - mocha classes moved to `lib/mocha` + - step is split to multiple classes and moved to `lib/step` +- Extended and exposed to public API classes for Test, Suite, Hook + - [Test](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/mocha/test.js) + - [Suite](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/mocha/suite.js) + - [Hook](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/mocha/hooks.js) (Before, After, BeforeSuite, AfterSuite) +- Container: + - refactored to be prepared for async imports in ESM. + - added proxy classes to resolve circular dependencies +- Step + - added different step types [`HelperStep`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/step/helper.js), [`MetaStep`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/step/meta.js), [`FuncStep`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/step/func.js), [`CommentStep`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/step/comment.js) + - added `step.addToRecorder()` to schedule test execution as part of global promise chain +- [Result object](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/result.js) added + - `event.all.result` now sends Result object with all failures and stats included +- `run-workers` refactored to use `Result` to send results from workers to main process +- Timeouts refactored `listener/timeout` => [`globalTimeout`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/listener/globalTimeout.js) +- Reduced usages of global variables, more attributes added to [`store`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/store.js) to share data on current state between different parts of system +- `events` API improved + - Hook class is sent as param for `event.hook.passed`, `event.hook.finished` + - `event.test.failed`, `event.test.finished` always sends Test. If test has failed in `Before` or `BeforeSuite` hook, event for all failed test in this suite will be sent + - if a test has failed in a hook, a hook name is sent as 3rd arg to `event.test.failed` + +--- + +## 3.6.10 + +❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ + +🐛 _Bug Fixes_ +fix(cli): missing failure counts when there is failedHooks ([#4633](https://github.com/codeceptjs/CodeceptJS/issues/4633)) - by **[kobenguyent](https://github.com/kobenguyent)** + +## 3.6.9 + +❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ + +🐛 _Hot Fixes_ +fix: could not run tests due to missing `invisi-data` lib - by **[kobenguyent](https://github.com/kobenguyent)** + +## 3.6.8 + +❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ + +🛩ī¸ _Features_ + +- feat(cli): mask sensitive data in logs ([#4630](https://github.com/codeceptjs/CodeceptJS/issues/4630)) - by **[kobenguyent](https://github.com/kobenguyent)** + +``` +export const config: CodeceptJS.MainConfig = { + tests: '**/*.e2e.test.ts', + retry: 4, + output: './output', + maskSensitiveData: true, + emptyOutputFolder: true, +... + + I login {"username":"helloworld@test.com","password": "****"} + I send post request "https://localhost:8000/login", {"username":"helloworld@test.com","password": "****"} + â€ē **[Request]** {"baseURL":"https://localhost:8000/login","method":"POST","data":{"username":"helloworld@test.com","password": "****"},"headers":{}} + â€ē **[Response]** {"access-token": "****"} +``` + +- feat(REST): DELETE request supports payload ([#4493](https://github.com/codeceptjs/CodeceptJS/issues/4493)) - by **[schaudhary111](https://github.com/schaudhary111)** + +```js +I.sendDeleteRequestWithPayload('/api/users/1', { author: 'john' }) +``` + +🐛 _Bug Fixes_ + +- fix(playwright): Different behavior of see* and waitFor* when used in within ([#4557](https://github.com/codeceptjs/CodeceptJS/issues/4557)) - by **[kobenguyent](https://github.com/kobenguyent)** +- fix(cli): dry run returns no tests when using a regex grep ([#4608](https://github.com/codeceptjs/CodeceptJS/issues/4608)) - by **[kobenguyent](https://github.com/kobenguyent)** + +```bash +> codeceptjs dry-run --steps --grep "(?=.*Checkout process)" +``` + +- fix: Replace deprecated faker.name with faker.person ([#4581](https://github.com/codeceptjs/CodeceptJS/issues/4581)) - by **[thomashohn](https://github.com/thomashohn)** +- fix(wdio): Remove dependency to devtools ([#4563](https://github.com/codeceptjs/CodeceptJS/issues/4563)) - by **[thomashohn](https://github.com/thomashohn)** +- fix(typings): wrong defineParameterType ([#4548](https://github.com/codeceptjs/CodeceptJS/issues/4548)) - by **[kobenguyent](https://github.com/kobenguyent)** +- fix(typing): `Locator.build` complains the empty locator ([#4543](https://github.com/codeceptjs/CodeceptJS/issues/4543)) - by **[kobenguyent](https://github.com/kobenguyent)** +- fix: add hint to `I.seeEmailAttachment` treats parameter as regular expression ([#4629](https://github.com/codeceptjs/CodeceptJS/issues/4629)) - by **[ngraf](https://github.com/ngraf)** + +``` +Add hint to "I.seeEmailAttachment" that under the hood parameter is treated as RegExp. +When you don't know it, it can cause a lot of pain, wondering why your test fails with I.seeEmailAttachment('Attachment(1).pdf') although it looks just fine, but actually I.seeEmailAttachment('Attachment\\(1\\).pdf is required to make the test green, in case the attachment is called "Attachment(1).pdf" with special character in it. +``` + +- fix(playwright): waitForText fails when text contains double quotes ([#4528](https://github.com/codeceptjs/CodeceptJS/issues/4528)) - by **[DavertMik](https://github.com/DavertMik)** +- fix(mock-server-helper): move to stand-alone package: https://www.npmjs.com/package/@codeceptjs/mock-server-helper ([#4536](https://github.com/codeceptjs/CodeceptJS/issues/4536)) - by **[kobenguyent](https://github.com/kobenguyent)** +- fix(appium): issue with async on runOnIos and runOnAndroid ([#4525](https://github.com/codeceptjs/CodeceptJS/issues/4525)) - by **[kobenguyent](https://github.com/kobenguyent)** +- fix: push ws messages to array ([#4513](https://github.com/codeceptjs/CodeceptJS/issues/4513)) - by **[kobenguyent](https://github.com/kobenguyent)** + +📖 _Documentation_ + +- fix(docs): typo in ai.md ([#4501](https://github.com/codeceptjs/CodeceptJS/issues/4501)) - by **[tomaculum](https://github.com/tomaculum)** + ## 3.6.6 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat(locator): add withAttrEndsWith, withAttrStartsWith, withAttrContains ([#4334](https://github.com/codeceptjs/CodeceptJS/issues/4334)) - by **[Maksym-Artemenko](https://github.com/Maksym-Artemenko)** -* feat: soft assert ([#4473](https://github.com/codeceptjs/CodeceptJS/issues/4473)) - by **[kobenguyent](https://github.com/kobenguyent)** - * Soft assert +🛩ī¸ _Features_ + +- feat(locator): add withAttrEndsWith, withAttrStartsWith, withAttrContains ([#4334](https://github.com/codeceptjs/CodeceptJS/issues/4334)) - by **[Maksym-Artemenko](https://github.com/Maksym-Artemenko)** +- feat: soft assert ([#4473](https://github.com/codeceptjs/CodeceptJS/issues/4473)) - by **[kobenguyent](https://github.com/kobenguyent)** + - Soft assert Zero-configuration when paired with other helpers like REST, Playwright: @@ -33,21 +432,23 @@ Zero-configuration when paired with other helpers like REST, Playwright: I.softExpectEqual('a', 'b') I.flushSoftAssertions() // Throws an error if any soft assertions have failed. The error message contains all the accumulated failures. ``` -* feat(cli): print failed hooks ([#4476](https://github.com/codeceptjs/CodeceptJS/issues/4476)) - by **[kobenguyent](https://github.com/kobenguyent)** - * run command - ![Screenshot 2024-09-02 at 15 25 20](https://github.com/user-attachments/assets/625c6b54-03f6-41c6-9d0c-cd699582404a) - * run workers command -![Screenshot 2024-09-02 at 15 24 53](https://github.com/user-attachments/assets/efff0312-1229-44b6-a94f-c9b9370b9a64) +- feat(cli): print failed hooks ([#4476](https://github.com/codeceptjs/CodeceptJS/issues/4476)) - by **[kobenguyent](https://github.com/kobenguyent)** + + - run command + ![Screenshot 2024-09-02 at 15 25 20](https://github.com/user-attachments/assets/625c6b54-03f6-41c6-9d0c-cd699582404a) + + - run workers command + ![Screenshot 2024-09-02 at 15 24 53](https://github.com/user-attachments/assets/efff0312-1229-44b6-a94f-c9b9370b9a64) -🐛 *Bug Fixes* -* fix(AI): minor AI improvements - by **[DavertMik](https://github.com/DavertMik)** -* fix(AI): add missing await in AI.js ([#4486](https://github.com/codeceptjs/CodeceptJS/issues/4486)) - by **[tomaculum](https://github.com/tomaculum)** -* fix(playwright): no async save video page ([#4472](https://github.com/codeceptjs/CodeceptJS/issues/4472)) - by **[kobenguyent](https://github.com/kobenguyent)** -* fix(rest): httpAgent condition ([#4484](https://github.com/codeceptjs/CodeceptJS/issues/4484)) - by **[kobenguyent](https://github.com/kobenguyent)** -* fix: DataCloneError error when `I.executeScript` command is used with `run-workers` ([#4483](https://github.com/codeceptjs/CodeceptJS/issues/4483)) - by **[code4muktesh](https://github.com/code4muktesh)** -* fix: no error thrown from rerun script ([#4494](https://github.com/codeceptjs/CodeceptJS/issues/4494)) - by **[lin-brian-l](https://github.com/lin-brian-l)** +🐛 _Bug Fixes_ +- fix(AI): minor AI improvements - by **[DavertMik](https://github.com/DavertMik)** +- fix(AI): add missing await in AI.js ([#4486](https://github.com/codeceptjs/CodeceptJS/issues/4486)) - by **[tomaculum](https://github.com/tomaculum)** +- fix(playwright): no async save video page ([#4472](https://github.com/codeceptjs/CodeceptJS/issues/4472)) - by **[kobenguyent](https://github.com/kobenguyent)** +- fix(rest): httpAgent condition ([#4484](https://github.com/codeceptjs/CodeceptJS/issues/4484)) - by **[kobenguyent](https://github.com/kobenguyent)** +- fix: DataCloneError error when `I.executeScript` command is used with `run-workers` ([#4483](https://github.com/codeceptjs/CodeceptJS/issues/4483)) - by **[code4muktesh](https://github.com/code4muktesh)** +- fix: no error thrown from rerun script ([#4494](https://github.com/codeceptjs/CodeceptJS/issues/4494)) - by **[lin-brian-l](https://github.com/lin-brian-l)** ```js // fix the validation of httpAgent config. we could now pass ca, instead of key/cert. @@ -66,15 +467,18 @@ I.flushSoftAssertions() // Throws an error if any soft assertions have failed. T } ``` -📖 *Documentation* -* doc(AI): minor AI improvements - by **[DavertMik](https://github.com/DavertMik)** +📖 _Documentation_ + +- doc(AI): minor AI improvements - by **[DavertMik](https://github.com/DavertMik)** ## 3.6.5 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat(helper): playwright > wait for disabled ([#4412](https://github.com/codeceptjs/CodeceptJS/issues/4412)) - by **[kobenguyent](https://github.com/kobenguyent)** +🛩ī¸ _Features_ + +- feat(helper): playwright > wait for disabled ([#4412](https://github.com/codeceptjs/CodeceptJS/issues/4412)) - by **[kobenguyent](https://github.com/kobenguyent)** + ``` it('should wait for input text field to be disabled', () => I.amOnPage('/form/wait_disabled').then(() => I.waitForDisabled('#text', 1))) @@ -90,20 +494,23 @@ Element can be located by CSS or XPath. **[param](https://github.com/param)** {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator. **[param](https://github.com/param)** {number} [sec=1] (optional) time in seconds to wait, 1 by default. **[returns](https://github.com/returns)** {void} automatically synchronized promise through #recorder ``` -🐛 *Bug Fixes* -* fix(AI): AI is not triggered ([#4422](https://github.com/codeceptjs/CodeceptJS/issues/4422)) - by **[kobenguyent](https://github.com/kobenguyent)** -* fix(plugin): stepByStep > report doesn't sync properly ([#4413](https://github.com/codeceptjs/CodeceptJS/issues/4413)) - by **[kobenguyent](https://github.com/kobenguyent)** -* fix: Locator > Unsupported pseudo selector 'has' ([#4448](https://github.com/codeceptjs/CodeceptJS/issues/4448)) - by **[anils92](https://github.com/anils92)** +🐛 _Bug Fixes_ -📖 *Documentation* -* docs: setup azure open ai using bearer token ([#4434](https://github.com/codeceptjs/CodeceptJS/issues/4434)) - by **[kobenguyent](https://github.com/kobenguyent)** +- fix(AI): AI is not triggered ([#4422](https://github.com/codeceptjs/CodeceptJS/issues/4422)) - by **[kobenguyent](https://github.com/kobenguyent)** +- fix(plugin): stepByStep > report doesn't sync properly ([#4413](https://github.com/codeceptjs/CodeceptJS/issues/4413)) - by **[kobenguyent](https://github.com/kobenguyent)** +- fix: Locator > Unsupported pseudo selector 'has' ([#4448](https://github.com/codeceptjs/CodeceptJS/issues/4448)) - by **[anils92](https://github.com/anils92)** + +📖 _Documentation_ + +- docs: setup azure open ai using bearer token ([#4434](https://github.com/codeceptjs/CodeceptJS/issues/4434)) - by **[kobenguyent](https://github.com/kobenguyent)** ## 3.6.4 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat(rest): print curl ([#4396](https://github.com/codeceptjs/CodeceptJS/issues/4396)) - by **[kobenguyent](https://github.com/kobenguyent)** +🛩ī¸ _Features_ + +- feat(rest): print curl ([#4396](https://github.com/codeceptjs/CodeceptJS/issues/4396)) - by **[kobenguyent](https://github.com/kobenguyent)** ``` Config: @@ -114,49 +521,55 @@ REST: { printCurl: true, ... } -... +... â€ē [CURL Request] curl --location --request POST https://httpbin.org/post -H ... ``` -* feat(AI): Generate PageObject, added types, shell improvement ([#4319](https://github.com/codeceptjs/CodeceptJS/issues/4319)) - by **[DavertMik](https://github.com/DavertMik)** - * added `askForPageObject` method to generate PageObjects on the fly - * improved AI types - * interactive shell improved to restore history +- feat(AI): Generate PageObject, added types, shell improvement ([#4319](https://github.com/codeceptjs/CodeceptJS/issues/4319)) - by **[DavertMik](https://github.com/DavertMik)** + - added `askForPageObject` method to generate PageObjects on the fly + - improved AI types + - interactive shell improved to restore history ![Screenshot from 2024-06-17 02-47-37](https://github.com/codeceptjs/CodeceptJS/assets/220264/12acd2c7-18d1-4105-a24b-84070ec4d393) -🐛 *Bug Fixes* -* fix(heal): wrong priority ([#4394](https://github.com/codeceptjs/CodeceptJS/issues/4394)) - by **[kobenguyent](https://github.com/kobenguyent)** +🐛 _Bug Fixes_ -📖 *Documentation* -* AI docs improvements by **[DavertMik](https://github.com/DavertMik)** +- fix(heal): wrong priority ([#4394](https://github.com/codeceptjs/CodeceptJS/issues/4394)) - by **[kobenguyent](https://github.com/kobenguyent)** + +📖 _Documentation_ + +- AI docs improvements by **[DavertMik](https://github.com/DavertMik)** ## 3.6.3 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat(plugin): coverage with WebDriver - devtools ([#4349](https://github.com/codeceptjs/CodeceptJS/issues/4349)) - by **[KobeNguyent](https://github.com/KobeNguyent)** +🛩ī¸ _Features_ + +- feat(plugin): coverage with WebDriver - devtools ([#4349](https://github.com/codeceptjs/CodeceptJS/issues/4349)) - by **[KobeNguyent](https://github.com/KobeNguyent)** ![Screenshot 2024-05-16 at 16 49 20](https://github.com/codeceptjs/CodeceptJS/assets/7845001/a02f0f99-ac78-4d3f-9774-2cb51c688025) -🐛 *Bug Fixes* -* fix(cli): stale process ([#4367](https://github.com/codeceptjs/CodeceptJS/issues/4367)) - by **[Horsty80](https://github.com/Horsty80)** **[kobenguyent](https://github.com/kobenguyent)** -* fix(runner): screenshot error in beforeSuite/AfterSuite ([#4385](https://github.com/codeceptjs/CodeceptJS/issues/4385)) - by **[kobenguyent](https://github.com/kobenguyent)** -* fix(cli): gherkin command init with TypeScript ([#4366](https://github.com/codeceptjs/CodeceptJS/issues/4366)) - by **[andonary](https://github.com/andonary)** -* fix(webApi): error message of dontSeeCookie ([#4357](https://github.com/codeceptjs/CodeceptJS/issues/4357)) - by **[a-stankevich](https://github.com/a-stankevich)** +🐛 _Bug Fixes_ -📖 *Documentation* -* fix(doc): Expect helper is not described correctly ([#4370](https://github.com/codeceptjs/CodeceptJS/issues/4370)) - by **[kobenguyent](https://github.com/kobenguyent)** -* fix(docs): some strange characters ([#4387](https://github.com/codeceptjs/CodeceptJS/issues/4387)) - by **[kobenguyent](https://github.com/kobenguyent)** -* fix: Puppeteer helper doc typo ([#4369](https://github.com/codeceptjs/CodeceptJS/issues/4369)) - by **[yoannfleurydev](https://github.com/yoannfleurydev)** +- fix(cli): stale process ([#4367](https://github.com/codeceptjs/CodeceptJS/issues/4367)) - by **[Horsty80](https://github.com/Horsty80)** **[kobenguyent](https://github.com/kobenguyent)** +- fix(runner): screenshot error in beforeSuite/AfterSuite ([#4385](https://github.com/codeceptjs/CodeceptJS/issues/4385)) - by **[kobenguyent](https://github.com/kobenguyent)** +- fix(cli): gherkin command init with TypeScript ([#4366](https://github.com/codeceptjs/CodeceptJS/issues/4366)) - by **[andonary](https://github.com/andonary)** +- fix(webApi): error message of dontSeeCookie ([#4357](https://github.com/codeceptjs/CodeceptJS/issues/4357)) - by **[a-stankevich](https://github.com/a-stankevich)** + +📖 _Documentation_ + +- fix(doc): Expect helper is not described correctly ([#4370](https://github.com/codeceptjs/CodeceptJS/issues/4370)) - by **[kobenguyent](https://github.com/kobenguyent)** +- fix(docs): some strange characters ([#4387](https://github.com/codeceptjs/CodeceptJS/issues/4387)) - by **[kobenguyent](https://github.com/kobenguyent)** +- fix: Puppeteer helper doc typo ([#4369](https://github.com/codeceptjs/CodeceptJS/issues/4369)) - by **[yoannfleurydev](https://github.com/yoannfleurydev)** ## 3.6.2 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat(REST): support httpAgent conf ([#4328](https://github.com/codeceptjs/CodeceptJS/issues/4328)) - by **[KobeNguyent](https://github.com/KobeNguyent)** +🛩ī¸ _Features_ + +- feat(REST): support httpAgent conf ([#4328](https://github.com/codeceptjs/CodeceptJS/issues/4328)) - by **[KobeNguyent](https://github.com/KobeNguyent)** Support the httpAgent conf to create the TSL connection via REST helper @@ -177,7 +590,7 @@ Support the httpAgent conf to create the TSL connection via REST helper } ``` -* feat(wd): screenshots for sessions ([#4322](https://github.com/codeceptjs/CodeceptJS/issues/4322)) - by **[KobeNguyent](https://github.com/KobeNguyent)** +- feat(wd): screenshots for sessions ([#4322](https://github.com/codeceptjs/CodeceptJS/issues/4322)) - by **[KobeNguyent](https://github.com/KobeNguyent)** Currently only screenshot of the active session is saved, this PR aims to save the screenshot of every session for easy debugging @@ -209,20 +622,21 @@ Scenario('should save screenshot for sessions **[WebDriverIO](https://github.com await I.expectNotEqual(main_original, session_failed); }); ``` -![Screenshot 2024-04-29 at 11 07 47](https://github.com/codeceptjs/CodeceptJS/assets/7845001/5dddf85a-ed77-474b-adfd-2f208d3c16a8) +![Screenshot 2024-04-29 at 11 07 47](https://github.com/codeceptjs/CodeceptJS/assets/7845001/5dddf85a-ed77-474b-adfd-2f208d3c16a8) -* feat: locate element with withClassAttr ([#4321](https://github.com/codeceptjs/CodeceptJS/issues/4321)) - by **[KobeNguyent](https://github.com/KobeNguyent)** +- feat: locate element with withClassAttr ([#4321](https://github.com/codeceptjs/CodeceptJS/issues/4321)) - by **[KobeNguyent](https://github.com/KobeNguyent)** Find an element with class attribute ```js // find div with class contains 'form' -locate('div').withClassAttr('text'); +locate('div').withClassAttr('text') ``` -* fix(playwright): set the record video resolution ([#4311](https://github.com/codeceptjs/CodeceptJS/issues/4311)) - by **[KobeNguyent](https://github.com/KobeNguyent)** -You could now set the recording video resolution +- fix(playwright): set the record video resolution ([#4311](https://github.com/codeceptjs/CodeceptJS/issues/4311)) - by **[KobeNguyent](https://github.com/KobeNguyent)** + You could now set the recording video resolution + ``` url: siteUrl, windowSize: '300x500', @@ -239,68 +653,70 @@ You could now set the recording video resolution }, ``` -🐛 *Bug Fixes* -* fix: several issues of stepByStep report ([#4331](https://github.com/codeceptjs/CodeceptJS/issues/4331)) - by **[KobeNguyent](https://github.com/KobeNguyent)** +🐛 _Bug Fixes_ -📖 *Documentation* -* fix: wrong format docs ([#4330](https://github.com/codeceptjs/CodeceptJS/issues/4330)) - by **[KobeNguyent](https://github.com/KobeNguyent)** -* fix(docs): wrong method is mentioned ([#4320](https://github.com/codeceptjs/CodeceptJS/issues/4320)) - by **[KobeNguyent](https://github.com/KobeNguyent)** -* fix: ChatGPT docs - by **[davert](https://github.com/davert)** +- fix: several issues of stepByStep report ([#4331](https://github.com/codeceptjs/CodeceptJS/issues/4331)) - by **[KobeNguyent](https://github.com/KobeNguyent)** + +📖 _Documentation_ + +- fix: wrong format docs ([#4330](https://github.com/codeceptjs/CodeceptJS/issues/4330)) - by **[KobeNguyent](https://github.com/KobeNguyent)** +- fix(docs): wrong method is mentioned ([#4320](https://github.com/codeceptjs/CodeceptJS/issues/4320)) - by **[KobeNguyent](https://github.com/KobeNguyent)** +- fix: ChatGPT docs - by **[davert](https://github.com/davert)** ## 3.6.1 -* Fixed regression in interactive pause. +- Fixed regression in interactive pause. ## 3.6.0 -🛩ī¸ *Features* +🛩ī¸ _Features_ -* Introduced [healers](./heal) to improve stability of failed tests. Write functions that can perform actions to fix a failing test: +- Introduced [healers](./heal) to improve stability of failed tests. Write functions that can perform actions to fix a failing test: ```js heal.addRecipe('reloadPageIfModalIsNotVisisble', { - steps: [ - 'click', - ], + steps: ['click'], fn: async ({ error, step }) => { // this function will be executed only if test failed with // "model is not visible" message - if (error.message.include('modal is not visible')) return; + if (error.message.include('modal is not visible')) return // we return a function that will refresh a page // and tries to perform last step again return async ({ I }) => { - I.reloadPage(); - I.wait(1); - await step.run(); - }; + I.reloadPage() + I.wait(1) + await step.run() + } // if a function succeeds, test continues without an error }, -}); +}) ``` -* **Breaking Change** **AI** features refactored. Read updated [AI guide](./ai): - * **removed dependency on `openai`** - * added support for **Azure OpenAI**, **Claude**, **Mistal**, or any AI via custom request function - * `--ai` option added to explicitly enable AI features - * heal plugin decoupled from AI to run custom heal recipes - * improved healing for async/await scenarios - * token limits added - * token calculation introduced - * `OpenAI` helper renamed to `AI` +- **Breaking Change** **AI** features refactored. Read updated [AI guide](./ai): + + - **removed dependency on `openai`** + - added support for **Azure OpenAI**, **Claude**, **Mistal**, or any AI via custom request function + - `--ai` option added to explicitly enable AI features + - heal plugin decoupled from AI to run custom heal recipes + - improved healing for async/await scenarios + - token limits added + - token calculation introduced + - `OpenAI` helper renamed to `AI` +- feat(puppeteer): network traffic manipulation. See [#4263](https://github.com/codeceptjs/CodeceptJS/issues/4263) by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* feat(puppeteer): network traffic manipulation. See [#4263](https://github.com/codeceptjs/CodeceptJS/issues/4263) by **[KobeNguyenT](https://github.com/KobeNguyenT)** - * `startRecordingTraffic` - * `grabRecordedNetworkTraffics` - * `flushNetworkTraffics` - * `stopRecordingTraffic` - * `seeTraffic` - * `dontSeeTraffic` + - `startRecordingTraffic` + - `grabRecordedNetworkTraffics` + - `flushNetworkTraffics` + - `stopRecordingTraffic` + - `seeTraffic` + - `dontSeeTraffic` -* feat(Puppeteer): recording WS messages. See [#4264](https://github.com/codeceptjs/CodeceptJS/issues/4264) by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- feat(Puppeteer): recording WS messages. See [#4264](https://github.com/codeceptjs/CodeceptJS/issues/4264) by **[KobeNguyenT](https://github.com/KobeNguyenT)** Recording WS messages: + ``` I.startRecordingWebSocketMessages(); I.amOnPage('https://websocketstest.com/'); @@ -310,6 +726,7 @@ Recording WS messages: ``` flushing WS messages: + ``` I.startRecordingWebSocketMessages(); I.amOnPage('https://websocketstest.com/'); @@ -323,26 +740,26 @@ Examples: ```js // recording traffics and verify the traffic - I.startRecordingTraffic(); - I.amOnPage('https://codecept.io/'); - I.seeTraffic({ name: 'traffics', url: 'https://codecept.io/img/companies/BC_LogoScreen_C.jpg' }); +I.startRecordingTraffic() +I.amOnPage('https://codecept.io/') +I.seeTraffic({ name: 'traffics', url: 'https://codecept.io/img/companies/BC_LogoScreen_C.jpg' }) ``` ```js // check the traffic with advanced params - I.amOnPage('https://openai.com/blog/chatgpt'); - I.startRecordingTraffic(); - I.seeTraffic({ - name: 'sentry event', - url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600', - parameters: { - width: '1919', - height: '1138', - }, - }); +I.amOnPage('https://openai.com/blog/chatgpt') +I.startRecordingTraffic() +I.seeTraffic({ + name: 'sentry event', + url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600', + parameters: { + width: '1919', + height: '1138', + }, +}) ``` -* Introduce the playwright locator: `_react`, `_vue`, `data-testid` attribute. See [#4255](https://github.com/codeceptjs/CodeceptJS/issues/4255) by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- Introduce the playwright locator: `_react`, `_vue`, `data-testid` attribute. See [#4255](https://github.com/codeceptjs/CodeceptJS/issues/4255) by **[KobeNguyenT](https://github.com/KobeNguyenT)** ``` Scenario('using playwright locator **[Playwright](https://github.com/Playwright)**', () => { @@ -366,7 +783,7 @@ Scenario('using playwright data-testid attribute **[Playwright](https://github.c }); ``` -* feat(puppeteer): mockRoute support. See [#4262](https://github.com/codeceptjs/CodeceptJS/issues/4262) by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- feat(puppeteer): mockRoute support. See [#4262](https://github.com/codeceptjs/CodeceptJS/issues/4262) by **[KobeNguyenT](https://github.com/KobeNguyenT)** Network requests & responses can be mocked and modified. Use `mockRoute` which strictly follows [Puppeteer's setRequestInterception API](https://pptr.dev/next/api/puppeteer.page.setrequestinterception). @@ -380,6 +797,7 @@ I.mockRoute('https://reqres.in/api/comments/1', request => { }); }) ``` + ``` I.mockRoute('**/*.{png,jpg,jpeg}', route => route.abort()); @@ -387,24 +805,26 @@ I.mockRoute('**/*.{png,jpg,jpeg}', route => route.abort()); // for previously mocked URL I.stopMockingRoute('**/*.{png,jpg,jpeg}'); ``` + To master request intercepting [use HTTPRequest object](https://pptr.dev/next/api/puppeteer.httprequest) passed into mock request handler. -🐛 *Bug Fixes* +🐛 _Bug Fixes_ -* Fixed double help message [#4278](https://github.com/codeceptjs/CodeceptJS/issues/4278) by **[masiuchi](https://github.com/masiuchi)** -* waitNumberOfVisibleElements always failed when passing num as 0. See [#4274](https://github.com/codeceptjs/CodeceptJS/issues/4274) by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- Fixed double help message [#4278](https://github.com/codeceptjs/CodeceptJS/issues/4278) by **[masiuchi](https://github.com/masiuchi)** +- waitNumberOfVisibleElements always failed when passing num as 0. See [#4274](https://github.com/codeceptjs/CodeceptJS/issues/4274) by **[KobeNguyenT](https://github.com/KobeNguyenT)** ## 3.5.15 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat: improve code coverage plugin ([#4252](https://github.com/codeceptjs/CodeceptJS/issues/4252)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +🛩ī¸ _Features_ + +- feat: improve code coverage plugin ([#4252](https://github.com/codeceptjs/CodeceptJS/issues/4252)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** We revamp the coverage plugin to make it easier to use Once all the tests are completed, `codecept` will create and store coverage in `output/coverage` folder, as shown below. -![]((https://github.com/codeceptjs/CodeceptJS/assets/7845001/3b8b81a3-7c85-470c-992d-ecdc7d5b4a1e)) +![](<(https://github.com/codeceptjs/CodeceptJS/assets/7845001/3b8b81a3-7c85-470c-992d-ecdc7d5b4a1e)>) Open `index.html` in your browser to view the full interactive coverage report. @@ -412,9 +832,10 @@ Open `index.html` in your browser to view the full interactive coverage report. ![](https://github.com/codeceptjs/CodeceptJS/assets/7845001/c821ce45-6590-4ace-b7ae-2cafb3a4e532) -🐛 *Bug Fixes* -* fix: bump puppeteer to v22.x ([#4249](https://github.com/codeceptjs/CodeceptJS/issues/4249)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: improve dry-run command ([#4225](https://github.com/codeceptjs/CodeceptJS/issues/4225)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +🐛 _Bug Fixes_ + +- fix: bump puppeteer to v22.x ([#4249](https://github.com/codeceptjs/CodeceptJS/issues/4249)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: improve dry-run command ([#4225](https://github.com/codeceptjs/CodeceptJS/issues/4225)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** dry-run command now supports test level grep. @@ -428,10 +849,10 @@ PUT tests -- /Users/t/Desktop/projects/codeceptjs-rest-demo/src/PUT_test.ts -- 4 ☐ Verify creating new user **[Jaja](https://github.com/Jaja)** - Total: 2 suites | 3 tests + Total: 2 suites | 3 tests --- DRY MODE: No tests were executed --- -➜ codeceptjs-rest-demo git:(master) ✗ npx codeceptjs dry-run +➜ codeceptjs-rest-demo git:(master) ✗ npx codeceptjs dry-run Tests from /Users/t/Desktop/projects/codeceptjs-rest-demo: DELETE tests -- /Users/t/Desktop/projects/codeceptjs-rest-demo/src/DELETE_test.ts -- 4 tests @@ -448,92 +869,99 @@ PUT tests -- /Users/tDesktop/projects/codeceptjs-rest-demo/src/PUT_test.ts -- 4 ☐ Verify creating new user **[Jaja](https://github.com/Jaja)** - Total: 4 suites | 8 tests + Total: 4 suites | 8 tests --- DRY MODE: No tests were executed --- ``` -* Several internal fixes and improvements for github workflows +- Several internal fixes and improvements for github workflows ## 3.5.14 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🐛 *Bug Fixes* -* **Hotfix** Fixed missing `joi` package - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +🐛 _Bug Fixes_ + +- **Hotfix** Fixed missing `joi` package - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ## 3.5.13 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat: mock server helper ([#4155](https://github.com/codeceptjs/CodeceptJS/issues/4155)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +🛩ī¸ _Features_ + +- feat: mock server helper ([#4155](https://github.com/codeceptjs/CodeceptJS/issues/4155)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ![Screenshot 2024-01-25 at 13 47 59](https://github.com/codeceptjs/CodeceptJS/assets/7845001/8fe7aacf-f1c9-4d7e-89a6-3748b3ccb26c) -* feat(webdriver): network traffics manipulation ([#4166](https://github.com/codeceptjs/CodeceptJS/issues/4166)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** - **[Webdriver]** Added commands to check network traffics - supported only with devtoolsProtocol - * `startRecordingTraffic` - * `grabRecordedNetworkTraffics` - * `flushNetworkTraffics` - * `stopRecordingTraffic` - * `seeTraffic` - * `dontSeeTraffic` +- feat(webdriver): network traffics manipulation ([#4166](https://github.com/codeceptjs/CodeceptJS/issues/4166)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + **[Webdriver]** Added commands to check network traffics - supported only with devtoolsProtocol + - `startRecordingTraffic` + - `grabRecordedNetworkTraffics` + - `flushNetworkTraffics` + - `stopRecordingTraffic` + - `seeTraffic` + - `dontSeeTraffic` Examples: ```js // recording traffics and verify the traffic - I.startRecordingTraffic(); - I.amOnPage('https://codecept.io/'); - I.seeTraffic({ name: 'traffics', url: 'https://codecept.io/img/companies/BC_LogoScreen_C.jpg' }); +I.startRecordingTraffic() +I.amOnPage('https://codecept.io/') +I.seeTraffic({ name: 'traffics', url: 'https://codecept.io/img/companies/BC_LogoScreen_C.jpg' }) ``` ```js // check the traffic with advanced params - I.amOnPage('https://openai.com/blog/chatgpt'); - I.startRecordingTraffic(); - I.seeTraffic({ - name: 'sentry event', - url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600', - parameters: { - width: '1919', - height: '1138', - }, - }); +I.amOnPage('https://openai.com/blog/chatgpt') +I.startRecordingTraffic() +I.seeTraffic({ + name: 'sentry event', + url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600', + parameters: { + width: '1919', + height: '1138', + }, +}) ``` -* feat(webapi): add waitForCookie ([#4169](https://github.com/codeceptjs/CodeceptJS/issues/4169)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- feat(webapi): add waitForCookie ([#4169](https://github.com/codeceptjs/CodeceptJS/issues/4169)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** Waits for the specified cookie in the cookies. ```js -I.waitForCookie("token"); +I.waitForCookie('token') ``` -🐛 *Bug Fixes* -* fix(appium): update performSwipe with w3c protocol v2 ([#4181](https://github.com/codeceptjs/CodeceptJS/issues/4181)) - by **[MykaLev](https://github.com/MykaLev)** -* fix(webapi): selectOption method ([#4157](https://github.com/codeceptjs/CodeceptJS/issues/4157)) - by **[dyaroman](https://github.com/dyaroman)** -* fix: waitForText doesnt throw error when text doesnt exist ([#4195](https://github.com/codeceptjs/CodeceptJS/issues/4195)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: use this.options instead of this.config ([#4186](https://github.com/codeceptjs/CodeceptJS/issues/4186)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: config path without selenium ([#4184](https://github.com/codeceptjs/CodeceptJS/issues/4184)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: bring to front condition in _setPage ([#4173](https://github.com/codeceptjs/CodeceptJS/issues/4173)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: complicated locator ([#4170](https://github.com/codeceptjs/CodeceptJS/issues/4170)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +🐛 _Bug Fixes_ + +- fix(appium): update performSwipe with w3c protocol v2 ([#4181](https://github.com/codeceptjs/CodeceptJS/issues/4181)) - by **[MykaLev](https://github.com/MykaLev)** +- fix(webapi): selectOption method ([#4157](https://github.com/codeceptjs/CodeceptJS/issues/4157)) - by **[dyaroman](https://github.com/dyaroman)** +- fix: waitForText doesnt throw error when text doesnt exist ([#4195](https://github.com/codeceptjs/CodeceptJS/issues/4195)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: use this.options instead of this.config ([#4186](https://github.com/codeceptjs/CodeceptJS/issues/4186)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: config path without selenium ([#4184](https://github.com/codeceptjs/CodeceptJS/issues/4184)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: bring to front condition in \_setPage ([#4173](https://github.com/codeceptjs/CodeceptJS/issues/4173)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: complicated locator ([#4170](https://github.com/codeceptjs/CodeceptJS/issues/4170)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** Adding of `':nth-child'` into the array -` const limitation = [':nth-of-type', ':first-of-type', ':last-of-type', ':nth-last-child', ':nth-last-of-type', ':checked', ':disabled', ':enabled', ':required', ':lang']; ` fixes the issue. Then an old conversion way over `css-to-xpath` is used. +`const limitation = [':nth-of-type', ':first-of-type', ':last-of-type', ':nth-last-child', ':nth-last-of-type', ':checked', ':disabled', ':enabled', ':required', ':lang'];` fixes the issue. Then an old conversion way over `css-to-xpath` is used. + +📖 _Documentation_ -📖 *Documentation* -* fix(docs): missing docs for codecept UI ([#4175](https://github.com/codeceptjs/CodeceptJS/issues/4175)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix(docs): Appium documentation sidebar menu links ([#4188](https://github.com/codeceptjs/CodeceptJS/issues/4188)) - by **[mirao](https://github.com/mirao)** +- fix(docs): missing docs for codecept UI ([#4175](https://github.com/codeceptjs/CodeceptJS/issues/4175)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix(docs): Appium documentation sidebar menu links ([#4188](https://github.com/codeceptjs/CodeceptJS/issues/4188)) - by **[mirao](https://github.com/mirao)** -🛩ī¸ **Several bugfixes and improvements for Codecept-UI** -* Several internal improvements -* fix: title is not showing when visiting a test -* fix: handle erros nicely +🛩ī¸ **Several bugfixes and improvements for Codecept-UI** + +- Several internal improvements +- fix: title is not showing when visiting a test +- fix: handle erros nicely ## 3.5.12 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat: upgrade wdio ([#4123](https://github.com/codeceptjs/CodeceptJS/issues/4123)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +🛩ī¸ _Features_ + +- feat: upgrade wdio ([#4123](https://github.com/codeceptjs/CodeceptJS/issues/4123)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** 🛩ī¸ With the release of WebdriverIO version `v8.14.0`, and onwards, all driver management hassles are now a thing of the past 🙌. Read more [here](https://webdriver.io/blog/2023/07/31/driver-management/). One of the significant advantages of this update is that you can now get rid of any driver services you previously had to manage, such as @@ -581,7 +1009,8 @@ For example: } } ``` -* feat: wdio with devtools protocol ([#4105](https://github.com/codeceptjs/CodeceptJS/issues/4105)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- feat: wdio with devtools protocol ([#4105](https://github.com/codeceptjs/CodeceptJS/issues/4105)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** Running with devtools protocol @@ -601,29 +1030,34 @@ Running with devtools protocol } } ``` -* feat: add a locator builder method withTextEquals() ([#4100](https://github.com/codeceptjs/CodeceptJS/issues/4100)) - by **[mirao](https://github.com/mirao)** + +- feat: add a locator builder method withTextEquals() ([#4100](https://github.com/codeceptjs/CodeceptJS/issues/4100)) - by **[mirao](https://github.com/mirao)** Find an element with exact text + ```js -locate('button').withTextEquals('Add'); +locate('button').withTextEquals('Add') ``` -* feat: waitForNumberOfTabs ([#4124](https://github.com/codeceptjs/CodeceptJS/issues/4124)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- feat: waitForNumberOfTabs ([#4124](https://github.com/codeceptjs/CodeceptJS/issues/4124)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** Waits for number of tabs. ```js -I.waitForNumberOfTabs(2); +I.waitForNumberOfTabs(2) ``` -* feat: I.say would be added to Test.steps array ([#4145](https://github.com/codeceptjs/CodeceptJS/issues/4145)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- feat: I.say would be added to Test.steps array ([#4145](https://github.com/codeceptjs/CodeceptJS/issues/4145)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** Currently `I.say` is not added into the `Test.steps` array. This PR aims to add this to steps array so that we could use it to print steps in ReportPortal for instance. ![Screenshot 2024-01-19 at 15 41 34](https://github.com/codeceptjs/CodeceptJS/assets/7845001/82af552a-aeb3-487e-ac10-b5bb7e42470f) -🐛 *Bug Fixes* -* fix: reduce the package size to 2MB ([#4138](https://github.com/codeceptjs/CodeceptJS/issues/4138)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix(webapi): see attributes on elements ([#4147](https://github.com/codeceptjs/CodeceptJS/issues/4147)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: some assertion methods ([#4144](https://github.com/codeceptjs/CodeceptJS/issues/4144)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +🐛 _Bug Fixes_ + +- fix: reduce the package size to 2MB ([#4138](https://github.com/codeceptjs/CodeceptJS/issues/4138)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix(webapi): see attributes on elements ([#4147](https://github.com/codeceptjs/CodeceptJS/issues/4147)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: some assertion methods ([#4144](https://github.com/codeceptjs/CodeceptJS/issues/4144)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** Improve the error message for `seeElement`, `dontSeeElement`, `seeElementInDOM`, `dontSeeElementInDOM` @@ -649,29 +1083,29 @@ Updated at Playwright.dontSeeElement (lib/helper/Playwright.js:1472:7) ``` -* fix: css to xpath backward compatibility ([#4141](https://github.com/codeceptjs/CodeceptJS/issues/4141)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: css to xpath backward compatibility ([#4141](https://github.com/codeceptjs/CodeceptJS/issues/4141)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -- [css-to-xpath](https://www.npmjs.com/package/css-to-xpath): old lib, which works perfectly unless you have hyphen in locator. (https://github.com/codeceptjs/CodeceptJS/issues/3563) -- [csstoxpath](https://www.npmjs.com/package/csstoxpath): new lib, to solve the issue locator with hyphen but also have some [limitations](https://www.npmjs.com/package/csstoxpath#limitations) +* [css-to-xpath](https://www.npmjs.com/package/css-to-xpath): old lib, which works perfectly unless you have hyphen in locator. (https://github.com/codeceptjs/CodeceptJS/issues/3563) +* [csstoxpath](https://www.npmjs.com/package/csstoxpath): new lib, to solve the issue locator with hyphen but also have some [limitations](https://www.npmjs.com/package/csstoxpath#limitations) -* fix: grabRecordedNetworkTraffics throws error when being called twice ([#4143](https://github.com/codeceptjs/CodeceptJS/issues/4143)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: missing steps of test when running with workers ([#4127](https://github.com/codeceptjs/CodeceptJS/issues/4127)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: grabRecordedNetworkTraffics throws error when being called twice ([#4143](https://github.com/codeceptjs/CodeceptJS/issues/4143)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: missing steps of test when running with workers ([#4127](https://github.com/codeceptjs/CodeceptJS/issues/4127)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ```js Scenario('Verify getting list of users', async () => { -let res = await I.getUserPerPage(2); -res.data = []; // this line causes the issue -await I.expectEqual(res.data.data[0].id, 7); -}); + let res = await I.getUserPerPage(2) + res.data = [] // this line causes the issue + await I.expectEqual(res.data.data[0].id, 7) +}) ``` + at this time, res.data.data[0].id would throw undefined error and somehow the test is missing all its steps. -* fix: process.env.profile when --profile isn't set in run-multiple mode ([#4131](https://github.com/codeceptjs/CodeceptJS/issues/4131)) - by **[mirao](https://github.com/mirao)** +- fix: process.env.profile when --profile isn't set in run-multiple mode ([#4131](https://github.com/codeceptjs/CodeceptJS/issues/4131)) - by **[mirao](https://github.com/mirao)** `process.env.profile` is the string "undefined" instead of type undefined when no --profile is specified in the mode "run-multiple" - -* fix: session doesn't respect the context options ([#4111](https://github.com/codeceptjs/CodeceptJS/issues/4111)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: session doesn't respect the context options ([#4111](https://github.com/codeceptjs/CodeceptJS/issues/4111)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ```js Helpers: Playwright @@ -695,18 +1129,18 @@ sessionScreen is {"width":375,"height":667} OK | 1 passed // 4s ``` -* fix(plugin): retryTo issue ([#4117](https://github.com/codeceptjs/CodeceptJS/issues/4117)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix(plugin): retryTo issue ([#4117](https://github.com/codeceptjs/CodeceptJS/issues/4117)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ![Screenshot 2024-01-08 at 17 36 54](https://github.com/codeceptjs/CodeceptJS/assets/7845001/39c97073-e2e9-4c4c-86ee-62540bc95015) -* fix(types): CustomLocator typing broken for custom strict locators ([#4120](https://github.com/codeceptjs/CodeceptJS/issues/4120)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: wrong output for skipped tests - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: no retry failed step after tryto block ([#4103](https://github.com/codeceptjs/CodeceptJS/issues/4103)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: deprecate some JSON Wire Protocol commands ([#4104](https://github.com/codeceptjs/CodeceptJS/issues/4104)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix(types): CustomLocator typing broken for custom strict locators ([#4120](https://github.com/codeceptjs/CodeceptJS/issues/4120)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: wrong output for skipped tests - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: no retry failed step after tryto block ([#4103](https://github.com/codeceptjs/CodeceptJS/issues/4103)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: deprecate some JSON Wire Protocol commands ([#4104](https://github.com/codeceptjs/CodeceptJS/issues/4104)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** deprecate some JSON Wire Protocol commands: `grabGeoLocation`, `setGeoLocation` -* fix: cannot locate complicated locator ([#4101](https://github.com/codeceptjs/CodeceptJS/issues/4101)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** - +- fix: cannot locate complicated locator ([#4101](https://github.com/codeceptjs/CodeceptJS/issues/4101)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + Locator issue due to the lib changes ``` @@ -719,34 +1153,39 @@ The locator locate(".ps-menu-button").withText("Authoring").inside(".ps-submenu- ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat: other locators from playwright ([#4090](https://github.com/codeceptjs/CodeceptJS/issues/4090)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** - * CodeceptJS - Playwright now supports other locators like - * React (https://playwright.dev/docs/other-locators#react-locator), - * Vue (https://playwright.dev/docs/other-locators#vue-locator) +🛩ī¸ _Features_ + +- feat: other locators from playwright ([#4090](https://github.com/codeceptjs/CodeceptJS/issues/4090)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + - CodeceptJS - Playwright now supports other locators like + - React (https://playwright.dev/docs/other-locators#react-locator), + - Vue (https://playwright.dev/docs/other-locators#vue-locator) ![Vue Locators](https://github.com/codeceptjs/CodeceptJS/assets/7845001/841e9e54-847b-4326-b95f-f9406955a3ce) ![Example](https://github.com/codeceptjs/CodeceptJS/assets/7845001/763e6788-143b-4a00-a249-d9ca5f0b2a09) -🐛 *Bug Fixes* -* fix: step object is broken when step arg is a function ([#4092](https://github.com/codeceptjs/CodeceptJS/issues/4092)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: step object is broken when step arg contains joi object ([#4084](https://github.com/codeceptjs/CodeceptJS/issues/4084)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix(expect helper): custom error message as optional param ([#4082](https://github.com/codeceptjs/CodeceptJS/issues/4082)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix(puppeteer): hide deprecation info ([#4075](https://github.com/codeceptjs/CodeceptJS/issues/4075)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: seeattributesonelements throws error when attribute doesn't exist ([#4073](https://github.com/codeceptjs/CodeceptJS/issues/4073)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: typo in agrs ([#4077](https://github.com/codeceptjs/CodeceptJS/issues/4077)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: retryFailedStep is disabled for non tryTo steps ([#4069](https://github.com/codeceptjs/CodeceptJS/issues/4069)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix(typings): scrollintoview complains scrollintoviewoptions ([#4067](https://github.com/codeceptjs/CodeceptJS/issues/4067)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +🐛 _Bug Fixes_ + +- fix: step object is broken when step arg is a function ([#4092](https://github.com/codeceptjs/CodeceptJS/issues/4092)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: step object is broken when step arg contains joi object ([#4084](https://github.com/codeceptjs/CodeceptJS/issues/4084)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix(expect helper): custom error message as optional param ([#4082](https://github.com/codeceptjs/CodeceptJS/issues/4082)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix(puppeteer): hide deprecation info ([#4075](https://github.com/codeceptjs/CodeceptJS/issues/4075)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: seeattributesonelements throws error when attribute doesn't exist ([#4073](https://github.com/codeceptjs/CodeceptJS/issues/4073)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: typo in agrs ([#4077](https://github.com/codeceptjs/CodeceptJS/issues/4077)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: retryFailedStep is disabled for non tryTo steps ([#4069](https://github.com/codeceptjs/CodeceptJS/issues/4069)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix(typings): scrollintoview complains scrollintoviewoptions ([#4067](https://github.com/codeceptjs/CodeceptJS/issues/4067)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +📖 _Documentation_ -📖 *Documentation* -* fix(docs): some doc blocks are broken ([#4076](https://github.com/codeceptjs/CodeceptJS/issues/4076)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix(docs): expect docs ([#4058](https://github.com/codeceptjs/CodeceptJS/issues/4058)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix(docs): some doc blocks are broken ([#4076](https://github.com/codeceptjs/CodeceptJS/issues/4076)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix(docs): expect docs ([#4058](https://github.com/codeceptjs/CodeceptJS/issues/4058)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ## 3.5.10 ❤ī¸ Thanks all to those who contributed to make this release! ❤ī¸ -🛩ī¸ *Features* -* feat: expose WebElement ([#4043](https://github.com/codeceptjs/CodeceptJS/issues/4043)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +🛩ī¸ _Features_ + +- feat: expose WebElement ([#4043](https://github.com/codeceptjs/CodeceptJS/issues/4043)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ``` Now we expose the WebElements that are returned by the WebHelper and you could make the subsequence actions on them. @@ -756,7 +1195,9 @@ I.amOnPage('/form/focus_blur_elements'); const webElements = await I.grabWebElements('#button'); webElements[0].click(); ``` -* feat(playwright): support HAR replaying ([#3990](https://github.com/codeceptjs/CodeceptJS/issues/3990)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- feat(playwright): support HAR replaying ([#3990](https://github.com/codeceptjs/CodeceptJS/issues/3990)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ``` Replaying from HAR @@ -768,11 +1209,13 @@ Replaying from HAR I.see('CodeceptJS'); **[Parameters]** harFilePath [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) Path to recorded HAR file opts [object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)? [Options for replaying from HAR](https://playwright.dev/docs/api/class-page#page-route-from-har) ``` -* feat(playwright): support HAR recording ([#3986](https://github.com/codeceptjs/CodeceptJS/issues/3986)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- feat(playwright): support HAR recording ([#3986](https://github.com/codeceptjs/CodeceptJS/issues/3986)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ``` -A HAR file is an HTTP Archive file that contains a record of all the network requests that are made when a page is loaded. -It contains information about the request and response headers, cookies, content, timings, and more. -You can use HAR files to mock network requests in your tests. HAR will be saved to output/har. +A HAR file is an HTTP Archive file that contains a record of all the network requests that are made when a page is loaded. +It contains information about the request and response headers, cookies, content, timings, and more. +You can use HAR files to mock network requests in your tests. HAR will be saved to output/har. More info could be found here https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har. ... @@ -782,16 +1225,20 @@ recordHar: { } ... ``` -* improvement(playwright): support partial string for option ([#4016](https://github.com/codeceptjs/CodeceptJS/issues/4016)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- improvement(playwright): support partial string for option ([#4016](https://github.com/codeceptjs/CodeceptJS/issues/4016)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ``` await I.amOnPage('/form/select'); await I.selectOption('Select your age', '21-'); ``` -🐛 *Bug Fixes* -* fix(playwright): proceedSee could not find the element ([#4006](https://github.com/codeceptjs/CodeceptJS/issues/4006)) - by **[hatufacci](https://github.com/hatufacci)** -* fix(appium): remove the vendor prefix of 'bstack:options' ([#4053](https://github.com/codeceptjs/CodeceptJS/issues/4053)) - by **[mojtabaalavi](https://github.com/mojtabaalavi)** -* fix(workers): event improvements ([#3953](https://github.com/codeceptjs/CodeceptJS/issues/3953)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +🐛 _Bug Fixes_ + +- fix(playwright): proceedSee could not find the element ([#4006](https://github.com/codeceptjs/CodeceptJS/issues/4006)) - by **[hatufacci](https://github.com/hatufacci)** +- fix(appium): remove the vendor prefix of 'bstack:options' ([#4053](https://github.com/codeceptjs/CodeceptJS/issues/4053)) - by **[mojtabaalavi](https://github.com/mojtabaalavi)** +- fix(workers): event improvements ([#3953](https://github.com/codeceptjs/CodeceptJS/issues/3953)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ``` Emit the new event: event.workers.result. @@ -804,7 +1251,7 @@ module.exports = function() { event.dispatcher.on(event.workers.result, async () => { await _publishResultsToTestrail(); }); - + // this event would not trigger the `_publishResultsToTestrail` multiple times when running `run-workers` command event.dispatcher.on(event.all.result, async () => { // when running `run` command, this env var is undefined @@ -812,7 +1259,9 @@ module.exports = function() { }); } ``` -* fix: ai html updates ([#3962](https://github.com/codeceptjs/CodeceptJS/issues/3962)) - by **[DavertMik](https://github.com/DavertMik)** + +- fix: ai html updates ([#3962](https://github.com/codeceptjs/CodeceptJS/issues/3962)) - by **[DavertMik](https://github.com/DavertMik)** + ``` replaced minify library with a modern and more secure fork. Fixes html-minifier@4.0.0 Regular Expression Denial of Service vulnerability [#3829](https://github.com/codeceptjs/CodeceptJS/issues/3829) AI class is implemented as singleton @@ -821,18 +1270,22 @@ add configuration params on number of fixes performed by ay heal improved recorder class to add more verbose log improved recorder class to ignore some of errors ``` -* fix(appium): closeApp supports both Android/iOS ([#4046](https://github.com/codeceptjs/CodeceptJS/issues/4046)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: some security vulnerability of some packages ([#4045](https://github.com/codeceptjs/CodeceptJS/issues/4045)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: seeAttributesOnElements check condition ([#4029](https://github.com/codeceptjs/CodeceptJS/issues/4029)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: waitForText locator issue ([#4039](https://github.com/codeceptjs/CodeceptJS/issues/4039)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- fix(appium): closeApp supports both Android/iOS ([#4046](https://github.com/codeceptjs/CodeceptJS/issues/4046)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: some security vulnerability of some packages ([#4045](https://github.com/codeceptjs/CodeceptJS/issues/4045)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: seeAttributesOnElements check condition ([#4029](https://github.com/codeceptjs/CodeceptJS/issues/4029)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: waitForText locator issue ([#4039](https://github.com/codeceptjs/CodeceptJS/issues/4039)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ``` Fixed this error: locator.isVisible: Unexpected token "s" while parsing selector ":has-text('Were you able to resolve the resident's issue?') >> nth=0" at Playwright.waitForText (node_modules\codeceptjs\lib\helper\Playwright.js:2584:79) ``` -* fix: move to sha256 ([#4038](https://github.com/codeceptjs/CodeceptJS/issues/4038)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: respect retries from retryfailedstep plugin in helpers ([#4028](https://github.com/codeceptjs/CodeceptJS/issues/4028)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- fix: move to sha256 ([#4038](https://github.com/codeceptjs/CodeceptJS/issues/4038)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: respect retries from retryfailedstep plugin in helpers ([#4028](https://github.com/codeceptjs/CodeceptJS/issues/4028)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ``` Currently inside the _before() of helpers for example Playwright, the retries is set there, however, when retryFailedStep plugin is enabled, the retries of recorder is still using the value from _before() not the value from retryFailedStep plugin. @@ -841,7 +1294,9 @@ Fix: - introduce the process.env.FAILED_STEP_RETIRES which could be access everywhere as the helper won't know anything about the plugin. - set default retries of Playwright to 3 to be on the same page with Puppeteer. ``` -* fix: examples in test title ([#4030](https://github.com/codeceptjs/CodeceptJS/issues/4030)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- fix: examples in test title ([#4030](https://github.com/codeceptjs/CodeceptJS/issues/4030)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ``` When test title doesn't have the data in examples: @@ -855,7 +1310,7 @@ Feature: Faker examples Faker examples -- **[1]** Starting recording promises - Timeouts: + Timeouts: Below are the users {"user":"John","role":"admin"} ✔ OK in 4ms @@ -876,33 +1331,35 @@ Feature: Faker examples Faker examples -- **[1]** Starting recording promises - Timeouts: - Below are the users - John - admin + Timeouts: + Below are the users - John - admin ✔ OK in 4ms - Below are the users - Tim - client + Below are the users - Tim - client ✔ OK in 1ms ``` -* fix: disable retryFailedStep when using with tryTo ([#4022](https://github.com/codeceptjs/CodeceptJS/issues/4022)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: locator builder returns error when class name contains hyphen ([#4024](https://github.com/codeceptjs/CodeceptJS/issues/4024)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: seeCssPropertiesOnElements failed when font-weight is a number ([#4026](https://github.com/codeceptjs/CodeceptJS/issues/4026)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix(appium): missing await on some steps of runOnIOS and runOnAndroid ([#4018](https://github.com/codeceptjs/CodeceptJS/issues/4018)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix(cli): no error of failed tests when using retry with scenario only ([#4020](https://github.com/codeceptjs/CodeceptJS/issues/4020)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: set getPageTimeout to 30s ([#4031](https://github.com/codeceptjs/CodeceptJS/issues/4031)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix(appium): expose switchToContext ([#4015](https://github.com/codeceptjs/CodeceptJS/issues/4015)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: promise issue ([#4013](https://github.com/codeceptjs/CodeceptJS/issues/4013)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: seeCssPropertiesOnElements issue with improper condition ([#4057](https://github.com/codeceptjs/CodeceptJS/issues/4057)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** - -📖 *Documentation* -* docs: Update clearCookie documentation for Playwright helper ([#4005](https://github.com/codeceptjs/CodeceptJS/issues/4005)) - by **[Hellosager](https://github.com/Hellosager)** -* docs: improve the example code for autoLogin ([#4019](https://github.com/codeceptjs/CodeceptJS/issues/4019)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- fix: disable retryFailedStep when using with tryTo ([#4022](https://github.com/codeceptjs/CodeceptJS/issues/4022)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: locator builder returns error when class name contains hyphen ([#4024](https://github.com/codeceptjs/CodeceptJS/issues/4024)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: seeCssPropertiesOnElements failed when font-weight is a number ([#4026](https://github.com/codeceptjs/CodeceptJS/issues/4026)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix(appium): missing await on some steps of runOnIOS and runOnAndroid ([#4018](https://github.com/codeceptjs/CodeceptJS/issues/4018)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix(cli): no error of failed tests when using retry with scenario only ([#4020](https://github.com/codeceptjs/CodeceptJS/issues/4020)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: set getPageTimeout to 30s ([#4031](https://github.com/codeceptjs/CodeceptJS/issues/4031)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix(appium): expose switchToContext ([#4015](https://github.com/codeceptjs/CodeceptJS/issues/4015)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: promise issue ([#4013](https://github.com/codeceptjs/CodeceptJS/issues/4013)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: seeCssPropertiesOnElements issue with improper condition ([#4057](https://github.com/codeceptjs/CodeceptJS/issues/4057)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +📖 _Documentation_ + +- docs: Update clearCookie documentation for Playwright helper ([#4005](https://github.com/codeceptjs/CodeceptJS/issues/4005)) - by **[Hellosager](https://github.com/Hellosager)** +- docs: improve the example code for autoLogin ([#4019](https://github.com/codeceptjs/CodeceptJS/issues/4019)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ![Screenshot 2023-11-22 at 14 40 11](https://github.com/codeceptjs/CodeceptJS/assets/7845001/c05ac436-efd0-4bc0-a46c-386f915c0f17) ## 3.5.8 Thanks all to those who contributed to make this release! -🐛 *Bug Fixes* +🐛 _Bug Fixes_ fix(appium): type of setNetworkConnection() ([#3994](https://github.com/codeceptjs/CodeceptJS/issues/3994)) - by **[mirao](https://github.com/mirao)** fix: improve the way to show deprecated appium v1 message ([#3992](https://github.com/codeceptjs/CodeceptJS/issues/3992)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** fix: missing exit condition of some wait functions - by **[KobeNguyenT](https://github.com/KobeNguyenT)** @@ -911,14 +1368,16 @@ fix: missing exit condition of some wait functions - by **[KobeNguyenT](https:// Thanks all to those who contributed to make this release! -🐛 *Bug Fixes* -* Bump playwright to 1.39.0 - run `npx playwright install` to install the browsers as starting from 1.39.0 browsers are not installed automatically ([#3924](https://github.com/codeceptjs/CodeceptJS/issues/3924)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix(playwright): some wait functions draw error due to switchTo iframe ([#3918](https://github.com/codeceptjs/CodeceptJS/issues/3918)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix(appium): AppiumTestDistribution/appium-device-farm requires 'platformName' ([#3950](https://github.com/codeceptjs/CodeceptJS/issues/3950)) - by **[rock-tran](https://github.com/rock-tran)** -* fix: autologin with empty fetch ([#3947](https://github.com/codeceptjs/CodeceptJS/issues/3947)) - by **[andonary](https://github.com/andonary)** -* fix(cli): customLocator draws error in dry-mode ([#3940](https://github.com/codeceptjs/CodeceptJS/issues/3940)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: ensure docs include **[returns](https://github.com/returns)** Promise where appropriate ([#3954](https://github.com/codeceptjs/CodeceptJS/issues/3954)) - by **[fwouts](https://github.com/fwouts)** -* fix: long text in data table cuts off ([#3936](https://github.com/codeceptjs/CodeceptJS/issues/3936)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +🐛 _Bug Fixes_ + +- Bump playwright to 1.39.0 - run `npx playwright install` to install the browsers as starting from 1.39.0 browsers are not installed automatically ([#3924](https://github.com/codeceptjs/CodeceptJS/issues/3924)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix(playwright): some wait functions draw error due to switchTo iframe ([#3918](https://github.com/codeceptjs/CodeceptJS/issues/3918)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix(appium): AppiumTestDistribution/appium-device-farm requires 'platformName' ([#3950](https://github.com/codeceptjs/CodeceptJS/issues/3950)) - by **[rock-tran](https://github.com/rock-tran)** +- fix: autologin with empty fetch ([#3947](https://github.com/codeceptjs/CodeceptJS/issues/3947)) - by **[andonary](https://github.com/andonary)** +- fix(cli): customLocator draws error in dry-mode ([#3940](https://github.com/codeceptjs/CodeceptJS/issues/3940)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: ensure docs include **[returns](https://github.com/returns)** Promise where appropriate ([#3954](https://github.com/codeceptjs/CodeceptJS/issues/3954)) - by **[fwouts](https://github.com/fwouts)** +- fix: long text in data table cuts off ([#3936](https://github.com/codeceptjs/CodeceptJS/issues/3936)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ``` #language: de Funktionalität: Faker examples @@ -927,51 +1386,58 @@ Funktionalität: Faker examples Angenommen que estou logado via REST com o usuÃĄrio "" | protocol | https: | | hostname | https://cucumber.io/docs/gherkin/languages/ | - + Faker examples -- Atualizar senha do usuÃĄrio {"product":"{{vehicle.vehicle}}","customer":"Dr. {{name.findName}}","price":"{{commerce.price}}","cashier":"cashier 2"} - On Angenommen: que estou logado via rest com o usuÃĄrio "dr. {{name.find name}}" - protocol | https: + On Angenommen: que estou logado via rest com o usuÃĄrio "dr. {{name.find name}}" + protocol | https: hostname | https://cucumber.io/docs/gherkin/languages/ - + Dr. {{name.findName}} ✔ OK in 13ms ``` -* fix(playwright): move to waitFor ([#3933](https://github.com/codeceptjs/CodeceptJS/issues/3933)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: relax grabCookie type ([#3919](https://github.com/codeceptjs/CodeceptJS/issues/3919)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: proceedSee error when being called inside within ([#3939](https://github.com/codeceptjs/CodeceptJS/issues/3939)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: rename haveRequestHeaders of ppt and pw helpers ([#3937](https://github.com/codeceptjs/CodeceptJS/issues/3937)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- fix(playwright): move to waitFor ([#3933](https://github.com/codeceptjs/CodeceptJS/issues/3933)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: relax grabCookie type ([#3919](https://github.com/codeceptjs/CodeceptJS/issues/3919)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: proceedSee error when being called inside within ([#3939](https://github.com/codeceptjs/CodeceptJS/issues/3939)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: rename haveRequestHeaders of ppt and pw helpers ([#3937](https://github.com/codeceptjs/CodeceptJS/issues/3937)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ``` Renamed haveRequestHeaders of Puppeteer, Playwright helper so that it would not confuse the REST helper. Puppeteer: setPuppeteerRequestHeaders Playwright: setPlaywrightRequestHeaders ``` -* improvement: handle the way to load apifactory nicely ([#3941](https://github.com/codeceptjs/CodeceptJS/issues/3941)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- improvement: handle the way to load apifactory nicely ([#3941](https://github.com/codeceptjs/CodeceptJS/issues/3941)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ``` With this fix, we could now use the following syntax: export = new Factory() .attr('name', () => faker.name.findName()) .attr('job', () => 'leader'); - + export default new Factory() .attr('name', () => faker.name.findName()) .attr('job', () => 'leader'); - + modules.export = new Factory() .attr('name', () => faker.name.findName()) .attr('job', () => 'leader'); ``` -📖 *Documentation* -* docs(appium): update to v2 ([#3932](https://github.com/codeceptjs/CodeceptJS/issues/3932)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* docs: improve BDD Gherkin docs ([#3938](https://github.com/codeceptjs/CodeceptJS/issues/3938)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* Other docs improvements +📖 _Documentation_ + +- docs(appium): update to v2 ([#3932](https://github.com/codeceptjs/CodeceptJS/issues/3932)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- docs: improve BDD Gherkin docs ([#3938](https://github.com/codeceptjs/CodeceptJS/issues/3938)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- Other docs improvements + +🛩ī¸ _Features_ + +- feat(puppeteer): support trace recording - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -🛩ī¸ *Features* -* feat(puppeteer): support trace recording - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ``` [Trace Recording Customization] Trace recording provides complete information on test execution and includes screenshots, and network requests logged during run. Traces will be saved to output/trace @@ -979,8 +1445,10 @@ Trace recording provides complete information on test execution and includes scr trace: enables trace recording for failed tests; trace are saved into output/trace folder keepTraceForPassedTests: - save trace for passed tests ``` -* feat: expect helper ([#3923](https://github.com/codeceptjs/CodeceptJS/issues/3923)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -``` + +- feat: expect helper ([#3923](https://github.com/codeceptjs/CodeceptJS/issues/3923)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +```` * This helper allows performing assertions based on Chai. * * ### Examples @@ -994,7 +1462,7 @@ keepTraceForPassedTests: - save trace for passed tests * Playwright: {...}, * ExpectHelper: {}, * } - + Expect Helper #expectEqual #expectNotEqual @@ -1023,16 +1491,22 @@ keepTraceForPassedTests: - save trace for passed tests #expectDeepIncludeMembers #expectDeepEqualExcluding #expectLengthBelowThan -``` -* feat: run-workers with multiple browsers output folders - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -- ![Screenshot 2023-11-04 at 10 49 56](https://github.com/codeceptjs/CodeceptJS/assets/7845001/8eaecc54-de14-4597-b148-1e087bec3c76) -- ![Screenshot 2023-11-03 at 15 56 38](https://github.com/codeceptjs/CodeceptJS/assets/7845001/715aed17-3535-48df-80dd-84f7024f08e3) -* feat: introduce new Playwright methods - by **[hatufacci](https://github.com/hatufacci)** +```` + +- feat: run-workers with multiple browsers output folders - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +* ![Screenshot 2023-11-04 at 10 49 56](https://github.com/codeceptjs/CodeceptJS/assets/7845001/8eaecc54-de14-4597-b148-1e087bec3c76) +* ![Screenshot 2023-11-03 at 15 56 38](https://github.com/codeceptjs/CodeceptJS/assets/7845001/715aed17-3535-48df-80dd-84f7024f08e3) + +- feat: introduce new Playwright methods - by **[hatufacci](https://github.com/hatufacci)** + ``` - grabCheckedElementStatus - grabDisabledElementStatus ``` -* feat: gherkin supports i18n ([#3934](https://github.com/codeceptjs/CodeceptJS/issues/3934)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- feat: gherkin supports i18n ([#3934](https://github.com/codeceptjs/CodeceptJS/issues/3934)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ``` #language: de Funktionalität: Checkout-Prozess @@ -1051,7 +1525,9 @@ Funktionalität: Checkout-Prozess | price | total | | 10 | 10.0 | ``` -* feat(autoLogin): improve the check method ([#3935](https://github.com/codeceptjs/CodeceptJS/issues/3935)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- feat(autoLogin): improve the check method ([#3935](https://github.com/codeceptjs/CodeceptJS/issues/3935)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ``` Instead of asserting on page elements for the current user in check, you can use the session you saved in fetch @@ -1085,16 +1561,20 @@ Scenario('login', async ( {I, login} ) => { Thanks all to those who contributed to make this release! -🐛 *Bug Fixes* -* fix: switchTo/within block doesn't switch to expected iframe ([#3892](https://github.com/codeceptjs/CodeceptJS/issues/3892)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: highlight element doesn't work as expected ([#3896](https://github.com/codeceptjs/CodeceptJS/issues/3896)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +🐛 _Bug Fixes_ + +- fix: switchTo/within block doesn't switch to expected iframe ([#3892](https://github.com/codeceptjs/CodeceptJS/issues/3892)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: highlight element doesn't work as expected ([#3896](https://github.com/codeceptjs/CodeceptJS/issues/3896)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ``` verbose/ highlight TRUE TRUE -> highlight element verbose/ highlight TRUE FALSE -> no highlight element verbose/ highlight FALSE TRUE -> no highlight element verbose/ highlight FALSE FALSE -> no highlight element - ``` -* fix: masked value issue in data table ([#3885](https://github.com/codeceptjs/CodeceptJS/issues/3885)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +``` + +- fix: masked value issue in data table ([#3885](https://github.com/codeceptjs/CodeceptJS/issues/3885)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ``` const accounts = new DataTable(['role', 'username', 'password']); accounts.add([ @@ -1116,8 +1596,8 @@ Data(accounts) I.amOnPage('/'); loginPage.**sendForm**(current.username, current.password); ) - - + + // output The test feature -- The scenario | {"username":"Username","password": ***} @@ -1131,14 +1611,17 @@ Data(accounts) ✔ OK in 1ms ``` -* fix: debug info causes error ([#3882](https://github.com/codeceptjs/CodeceptJS/issues/3882)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: debug info causes error ([#3882](https://github.com/codeceptjs/CodeceptJS/issues/3882)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +📖 _Documentation_ + +- fix: get rid of complaining when using session without await and returning nothing. ([#3899](https://github.com/codeceptjs/CodeceptJS/issues/3899)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix(FileSystem): a typo in writeToFile() ([#3897](https://github.com/codeceptjs/CodeceptJS/issues/3897)) - by **[mirao](https://github.com/mirao)** -📖 *Documentation* -* fix: get rid of complaining when using session without await and returning nothing. ([#3899](https://github.com/codeceptjs/CodeceptJS/issues/3899)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix(FileSystem): a typo in writeToFile() ([#3897](https://github.com/codeceptjs/CodeceptJS/issues/3897)) - by **[mirao](https://github.com/mirao)** +🛩ī¸ _Features_ + +- feat(translation): add more french keywords and fix deprecated waitForClickable ([#3906](https://github.com/codeceptjs/CodeceptJS/issues/3906)) - by **[andonary](https://github.com/andonary)** -🛩ī¸ *Features* -* feat(translation): add more french keywords and fix deprecated waitForClickable ([#3906](https://github.com/codeceptjs/CodeceptJS/issues/3906)) - by **[andonary](https://github.com/andonary)** ``` - Add some french keywords for translation - I.waitForClickable has the same "attends" than I.wait. Using "attends" leads to use the deprecated waitForClickable. Fix it by using different words. @@ -1147,7 +1630,9 @@ Data(accounts) ## 3.5.5 🐛 Bug Fixes -* fix(browserstack): issue with vendor prefix ([#3845](https://github.com/codeceptjs/CodeceptJS/issues/3845)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- fix(browserstack): issue with vendor prefix ([#3845](https://github.com/codeceptjs/CodeceptJS/issues/3845)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ``` export const caps = { androidCaps: { @@ -1181,7 +1666,7 @@ export const caps = { } ``` -* switchTo/within now supports strict locator ([#3847](https://github.com/codeceptjs/CodeceptJS/issues/3847)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- switchTo/within now supports strict locator ([#3847](https://github.com/codeceptjs/CodeceptJS/issues/3847)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ``` I.switchTo({ css: 'iframe[id^=number-frame]' }) // support the strict locator @@ -1197,24 +1682,28 @@ within({ }); ``` -* Improve the IntelliSense when using other languages ([#3848](https://github.com/codeceptjs/CodeceptJS/issues/3848)) - by **[andonary](https://github.com/andonary)** +- Improve the IntelliSense when using other languages ([#3848](https://github.com/codeceptjs/CodeceptJS/issues/3848)) - by **[andonary](https://github.com/andonary)** + ``` include: { Je: './steps_file.js' } ``` -* bypassCSP support for Playwright helper ([#3865](https://github.com/codeceptjs/CodeceptJS/issues/3865)) - by **[sammeel](https://github.com/sammeel)** +- bypassCSP support for Playwright helper ([#3865](https://github.com/codeceptjs/CodeceptJS/issues/3865)) - by **[sammeel](https://github.com/sammeel)** + ``` helpers: { Playwright: { bypassCSP: true } ``` -* fix: missing requests when recording network ([#3834](https://github.com/codeceptjs/CodeceptJS/issues/3834)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- fix: missing requests when recording network ([#3834](https://github.com/codeceptjs/CodeceptJS/issues/3834)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** 🛩ī¸ Features and Improvements -* Show environment info in verbose mode ([#3858](https://github.com/codeceptjs/CodeceptJS/issues/3858)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- Show environment info in verbose mode ([#3858](https://github.com/codeceptjs/CodeceptJS/issues/3858)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ``` Environment information:- @@ -1280,9 +1769,9 @@ Please copy environment info when you report issues on GitHub: https://github.co CodeceptJS v3.5.4 #StandWithUkraine ``` -* some typings improvements ([#3855](https://github.com/codeceptjs/CodeceptJS/issues/3855)) - by **[nikzupancic](https://github.com/nikzupancic)** -* support the puppeteer 21.1.1 ([#3856](https://github.com/codeceptjs/CodeceptJS/issues/3856)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** -* fix: support secret value for some methods ([#3837](https://github.com/codeceptjs/CodeceptJS/issues/3837)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- some typings improvements ([#3855](https://github.com/codeceptjs/CodeceptJS/issues/3855)) - by **[nikzupancic](https://github.com/nikzupancic)** +- support the puppeteer 21.1.1 ([#3856](https://github.com/codeceptjs/CodeceptJS/issues/3856)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- fix: support secret value for some methods ([#3837](https://github.com/codeceptjs/CodeceptJS/issues/3837)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ``` await I.amOnPage('/form/field_values'); @@ -1294,18 +1783,21 @@ await I.dontSeeInField('checkbox[]', secret('not seen three')); await I.seeInField('checkbox[]', secret('see test three')); ``` -🛩ī¸ **Several bugfixes and improvements for Codecept-UI** -* Mask the secret value in UI -* Improve UX/UI -* PageObjects are now showing in UI +🛩ī¸ **Several bugfixes and improvements for Codecept-UI** + +- Mask the secret value in UI +- Improve UX/UI +- PageObjects are now showing in UI ## 3.5.4 🐛 Bug Fixes: - * **[Playwright]** When passing `userDataDir`, it throws error after test execution ([#3814](https://github.com/codeceptjs/CodeceptJS/issues/3814)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** - * [CodeceptJS-CLI] Improve command to generate types ([#3788](https://github.com/codeceptjs/CodeceptJS/issues/3788)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** - * Heal plugin fix ([#3820](https://github.com/codeceptjs/CodeceptJS/issues/3820)) - by **[davert](https://github.com/davert)** - * Fix for error in using `all` with `run-workers` ([#3805](https://github.com/codeceptjs/CodeceptJS/issues/3805)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- **[Playwright]** When passing `userDataDir`, it throws error after test execution ([#3814](https://github.com/codeceptjs/CodeceptJS/issues/3814)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- [CodeceptJS-CLI] Improve command to generate types ([#3788](https://github.com/codeceptjs/CodeceptJS/issues/3788)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- Heal plugin fix ([#3820](https://github.com/codeceptjs/CodeceptJS/issues/3820)) - by **[davert](https://github.com/davert)** +- Fix for error in using `all` with `run-workers` ([#3805](https://github.com/codeceptjs/CodeceptJS/issues/3805)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + ```js helpers: { Playwright: { @@ -1328,29 +1820,33 @@ await I.seeInField('checkbox[]', secret('see test three')); }, }, ``` - * Highlight elements issues ([#3779](https://github.com/codeceptjs/CodeceptJS/issues/3779)) ([#3778](https://github.com/codeceptjs/CodeceptJS/issues/3778)) - by **[philkas](https://github.com/philkas)** - * Support ` ` symbol in `I.see` method ([#3815](https://github.com/codeceptjs/CodeceptJS/issues/3815)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- Highlight elements issues ([#3779](https://github.com/codeceptjs/CodeceptJS/issues/3779)) ([#3778](https://github.com/codeceptjs/CodeceptJS/issues/3778)) - by **[philkas](https://github.com/philkas)** +- Support ` ` symbol in `I.see` method ([#3815](https://github.com/codeceptjs/CodeceptJS/issues/3815)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ```js // HTML code uses   instead of space -
My Text!
+;
+ My Text! +
-I.see("My Text!") // this test would work with both   and space +I.see('My Text!') // this test would work with both   and space ``` 📖 Documentation - * Improve the configuration of electron testing when the app is build with electron-forge ([#3802](https://github.com/codeceptjs/CodeceptJS/issues/3802)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- Improve the configuration of electron testing when the app is build with electron-forge ([#3802](https://github.com/codeceptjs/CodeceptJS/issues/3802)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ```js -const path = require("path"); +const path = require('path') exports.config = { helpers: { Playwright: { - browser: "electron", + browser: 'electron', electron: { - executablePath: require("electron"), - args: [path.join(__dirname, ".webpack/main/index.js")], + executablePath: require('electron'), + args: [path.join(__dirname, '.webpack/main/index.js')], }, }, }, @@ -1361,26 +1857,28 @@ exports.config = { 🛩ī¸ Features #### **[Playwright]** new features and improvements - * Parse the response in recording network steps ([#3771](https://github.com/codeceptjs/CodeceptJS/issues/3771)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- Parse the response in recording network steps ([#3771](https://github.com/codeceptjs/CodeceptJS/issues/3771)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ```js - const traffics = await I.grabRecordedNetworkTraffics(); - expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1'); - expect(traffics[0].response.status).to.equal(200); - expect(traffics[0].response.body).to.contain({ name: 'this was mocked' }); +const traffics = await I.grabRecordedNetworkTraffics() +expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1') +expect(traffics[0].response.status).to.equal(200) +expect(traffics[0].response.body).to.contain({ name: 'this was mocked' }) - expect(traffics[1].url).to.equal('https://reqres.in/api/comments/1'); - expect(traffics[1].response.status).to.equal(200); - expect(traffics[1].response.body).to.contain({ name: 'this was another mocked' }); +expect(traffics[1].url).to.equal('https://reqres.in/api/comments/1') +expect(traffics[1].response.status).to.equal(200) +expect(traffics[1].response.body).to.contain({ name: 'this was another mocked' }) ``` - * Grab metrics ([#3809](https://github.com/codeceptjs/CodeceptJS/issues/3809)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + +- Grab metrics ([#3809](https://github.com/codeceptjs/CodeceptJS/issues/3809)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ```js -const metrics = await I.grabMetrics(); +const metrics = await I.grabMetrics() // returned metrics -[ +;[ { name: 'Timestamp', value: 1584904.203473 }, { name: 'AudioHandlers', value: 0 }, { name: 'AudioWorkletProcessors', value: 0 }, @@ -1416,149 +1914,150 @@ const metrics = await I.grabMetrics(); { name: 'JSHeapTotalSize', value: 26820608 }, { name: 'FirstMeaningfulPaint', value: 0 }, { name: 'DomContentLoaded', value: 1584903.690491 }, - { name: 'NavigationStart', value: 1584902.841845 } + { name: 'NavigationStart', value: 1584902.841845 }, ] ``` -* Grab WebSocket (WS) messages ([#3789](https://github.com/codeceptjs/CodeceptJS/issues/3789)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** - * `flushWebSocketMessages` - * `grabWebSocketMessages` - * `startRecordingWebSocketMessages` - * `stopRecordingWebSocketMessages` +- Grab WebSocket (WS) messages ([#3789](https://github.com/codeceptjs/CodeceptJS/issues/3789)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** + - `flushWebSocketMessages` + - `grabWebSocketMessages` + - `startRecordingWebSocketMessages` + - `stopRecordingWebSocketMessages` ```js -await I.startRecordingWebSocketMessages(); -I.amOnPage('https://websocketstest.com/'); -I.waitForText('Work for You!'); -I.flushNetworkTraffics(); -const wsMessages = I.grabWebSocketMessages(); -expect(wsMessages.length).to.equal(0); +await I.startRecordingWebSocketMessages() +I.amOnPage('https://websocketstest.com/') +I.waitForText('Work for You!') +I.flushNetworkTraffics() +const wsMessages = I.grabWebSocketMessages() +expect(wsMessages.length).to.equal(0) ``` ```js -await I.startRecordingWebSocketMessages(); -await I.amOnPage('https://websocketstest.com/'); -I.waitForText('Work for You!'); -const wsMessages = I.grabWebSocketMessages(); -expect(wsMessages.length).to.greaterThan(0); +await I.startRecordingWebSocketMessages() +await I.amOnPage('https://websocketstest.com/') +I.waitForText('Work for You!') +const wsMessages = I.grabWebSocketMessages() +expect(wsMessages.length).to.greaterThan(0) ``` ```js -await I.startRecordingWebSocketMessages(); -await I.amOnPage('https://websocketstest.com/'); -I.waitForText('Work for You!'); -const wsMessages = I.grabWebSocketMessages(); -await I.stopRecordingWebSocketMessages(); -await I.amOnPage('https://websocketstest.com/'); -I.waitForText('Work for You!'); -const afterWsMessages = I.grabWebSocketMessages(); -expect(wsMessages.length).to.equal(afterWsMessages.length); +await I.startRecordingWebSocketMessages() +await I.amOnPage('https://websocketstest.com/') +I.waitForText('Work for You!') +const wsMessages = I.grabWebSocketMessages() +await I.stopRecordingWebSocketMessages() +await I.amOnPage('https://websocketstest.com/') +I.waitForText('Work for You!') +const afterWsMessages = I.grabWebSocketMessages() +expect(wsMessages.length).to.equal(afterWsMessages.length) ``` -* Move from `ElementHandle` to `Locator`. This change is quite major, but it happened under hood, so should not affect your code. ([#3738](https://github.com/codeceptjs/CodeceptJS/issues/3738)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- Move from `ElementHandle` to `Locator`. This change is quite major, but it happened under hood, so should not affect your code. ([#3738](https://github.com/codeceptjs/CodeceptJS/issues/3738)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ## 3.5.3 🛩ī¸ Features -* **[Playwright]** Added commands to check network traffic [#3748](https://github.com/codeceptjs/CodeceptJS/issues/3748) - by **[ngraf](https://github.com/ngraf)** **[KobeNguyenT](https://github.com/KobeNguyenT)** - * `startRecordingTraffic` - * `grabRecordedNetworkTraffics` - * `blockTraffic` - * `mockTraffic` - * `flushNetworkTraffics` - * `stopRecordingTraffic` - * `seeTraffic` - * `grabTrafficUrl` - * `dontSeeTraffic` +- **[Playwright]** Added commands to check network traffic [#3748](https://github.com/codeceptjs/CodeceptJS/issues/3748) - by **[ngraf](https://github.com/ngraf)** **[KobeNguyenT](https://github.com/KobeNguyenT)** + - `startRecordingTraffic` + - `grabRecordedNetworkTraffics` + - `blockTraffic` + - `mockTraffic` + - `flushNetworkTraffics` + - `stopRecordingTraffic` + - `seeTraffic` + - `grabTrafficUrl` + - `dontSeeTraffic` Examples: ```js // recording traffics and verify the traffic - await I.startRecordingTraffic(); - I.amOnPage('https://codecept.io/'); - await I.seeTraffic({ name: 'traffics', url: 'https://codecept.io/img/companies/BC_LogoScreen_C.jpg' }); +await I.startRecordingTraffic() +I.amOnPage('https://codecept.io/') +await I.seeTraffic({ name: 'traffics', url: 'https://codecept.io/img/companies/BC_LogoScreen_C.jpg' }) ``` ```js // block the traffic - I.blockTraffic('https://reqres.in/api/comments/*'); - await I.amOnPage('/form/fetch_call'); - await I.startRecordingTraffic(); - await I.click('GET COMMENTS'); - await I.see('Can not load data!'); +I.blockTraffic('https://reqres.in/api/comments/*') +await I.amOnPage('/form/fetch_call') +await I.startRecordingTraffic() +await I.click('GET COMMENTS') +await I.see('Can not load data!') ``` ```js // check the traffic with advanced params - I.amOnPage('https://openai.com/blog/chatgpt'); - await I.startRecordingTraffic(); - await I.seeTraffic({ - name: 'sentry event', - url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600', - parameters: { - width: '1919', - height: '1138', - }, - }); +I.amOnPage('https://openai.com/blog/chatgpt') +await I.startRecordingTraffic() +await I.seeTraffic({ + name: 'sentry event', + url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600', + parameters: { + width: '1919', + height: '1138', + }, +}) ``` 🐛 Bugfix -* **[retryStepPlugin]** Fix retry step when using global retry [#3768](https://github.com/codeceptjs/CodeceptJS/issues/3768) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- **[retryStepPlugin]** Fix retry step when using global retry [#3768](https://github.com/codeceptjs/CodeceptJS/issues/3768) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** 🗑 Deprecated -* Nightmare and Protractor helpers have been deprecated +- Nightmare and Protractor helpers have been deprecated ## 3.5.2 🐛 Bug Fixes -* **[Playwright]** reverted `clearField` to previous implementation -* **[OpenAI]** fixed running helper in pause mode. [#3755](https://github.com/codeceptjs/CodeceptJS/issues/3755) by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- **[Playwright]** reverted `clearField` to previous implementation +- **[OpenAI]** fixed running helper in pause mode. [#3755](https://github.com/codeceptjs/CodeceptJS/issues/3755) by **[KobeNguyenT](https://github.com/KobeNguyenT)** ## 3.5.1 🛩ī¸ Features -* [Puppeteer][WebDriver][TestCafe] Added methods by **[KobeNguyenT](https://github.com/KobeNguyenT)** in [#3737](https://github.com/codeceptjs/CodeceptJS/issues/3737) - * `blur` - * `focus` -* Improved BDD output to print steps without `I.` commands` by **[davertmik](https://github.com/davertmik)** [#3739](https://github.com/codeceptjs/CodeceptJS/issues/3739) -* Improved `codecept init` setup for Electron tests by **[KobeNguyenT](https://github.com/KobeNguyenT)**. See [#3733](https://github.com/codeceptjs/CodeceptJS/issues/3733) +- [Puppeteer][WebDriver][TestCafe] Added methods by **[KobeNguyenT](https://github.com/KobeNguyenT)** in [#3737](https://github.com/codeceptjs/CodeceptJS/issues/3737) + - `blur` + - `focus` +- Improved BDD output to print steps without `I.` commands` by **[davertmik](https://github.com/davertmik)** [#3739](https://github.com/codeceptjs/CodeceptJS/issues/3739) +- Improved `codecept init` setup for Electron tests by **[KobeNguyenT](https://github.com/KobeNguyenT)**. See [#3733](https://github.com/codeceptjs/CodeceptJS/issues/3733) 🐛 Bug Fixes -* Fixed serializing of custom errors making tests stuck. Fix [#3739](https://github.com/codeceptjs/CodeceptJS/issues/3739) by **[davertmik](https://github.com/davertmik)**. +- Fixed serializing of custom errors making tests stuck. Fix [#3739](https://github.com/codeceptjs/CodeceptJS/issues/3739) by **[davertmik](https://github.com/davertmik)**. 📖 Documentation -* Fixed Playwright docs by **[Horsty80](https://github.com/Horsty80)** -* Fixed ai docs by **[ngraf](https://github.com/ngraf)** -* Various fixes by **[KobeNguyenT](https://github.com/KobeNguyenT)** +- Fixed Playwright docs by **[Horsty80](https://github.com/Horsty80)** +- Fixed ai docs by **[ngraf](https://github.com/ngraf)** +- Various fixes by **[KobeNguyenT](https://github.com/KobeNguyenT)** ## 3.5.0 🛩ī¸ Features - **đŸĒ„ [AI Powered Test Automation](/ai)** - use OpenAI as a copilot for test automation. [#3713](https://github.com/codeceptjs/CodeceptJS/issues/3713) By **[davertmik](https://github.com/davertmik)** -![](https://user-images.githubusercontent.com/220264/250418764-c382709a-3ccb-4eb5-b6bc-538f3b3b3d35.png) - * [AI guide](/ai) added - * added support for OpenAI in `pause()` - * added [`heal` plugin](/plugins#heal) for self-healing tests - * added [`OpenAI`](/helpers/openai) helper + ![](https://user-images.githubusercontent.com/220264/250418764-c382709a-3ccb-4eb5-b6bc-538f3b3b3d35.png) + - [AI guide](/ai) added + - added support for OpenAI in `pause()` + - added [`heal` plugin](/plugins#heal) for self-healing tests + - added [`OpenAI`](/helpers/openai) helper - [Playwright][Puppeteer][WebDriver] Highlight the interacting elements in debug mode or with `highlightElement` option set ([#3672](https://github.com/codeceptjs/CodeceptJS/issues/3672)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)** ![](https://user-images.githubusercontent.com/220264/250415226-a7620418-56a4-4837-b790-b15e91e5d1f0.png) - **[Playwright]** Support for APIs in Playwright ([#3665](https://github.com/codeceptjs/CodeceptJS/issues/3665)) - by Egor Bodnar - * `clearField` replaced to use new Playwright API - * `blur` added - * `focus` added + + - `clearField` replaced to use new Playwright API + - `blur` added + - `focus` added - **[Added support for multiple browsers](/parallel#Parallel-Execution-by-Workers-on-Multiple-Browsers)** in `run-workers` ([#3606](https://github.com/codeceptjs/CodeceptJS/issues/3606)) by **[karanshah-browserstack](https://github.com/karanshah-browserstack)** : @@ -1581,8 +2080,9 @@ exports.config = { browser: "chrome", } ] - }, + }, ``` + And executed via `run-workers` with `all` argument ``` @@ -1603,34 +2103,34 @@ npx codeceptjs run-workers 2 all - Fixed global retry [#3667](https://github.com/codeceptjs/CodeceptJS/issues/3667) by **[KobeNguyenT](https://github.com/KobeNguyenT)** - Fixed creating JavaScript test using "codeceptjs gt" ([#3611](https://github.com/codeceptjs/CodeceptJS/issues/3611)) - by Jaromir Obr - ## 3.4.1 -* Updated mocha to v 10.2. Fixes [#3591](https://github.com/codeceptjs/CodeceptJS/issues/3591) -* Fixes executing a faling Before hook. Resolves [#3592](https://github.com/codeceptjs/CodeceptJS/issues/3592) +- Updated mocha to v 10.2. Fixes [#3591](https://github.com/codeceptjs/CodeceptJS/issues/3591) +- Fixes executing a faling Before hook. Resolves [#3592](https://github.com/codeceptjs/CodeceptJS/issues/3592) ## 3.4.0 -* **Updated to latest mocha and modern Cucumber** -* **Allure plugin moved to [@codeceptjs/allure-legacy](https://github.com/codeceptjs/allure-legacy) package**. This happened because allure-commons package v1 was not updated and caused vulnarabilities. Fixes [#3422](https://github.com/codeceptjs/CodeceptJS/issues/3422). We don't plan to maintain allure v2 plugin so it's up to community to take this initiative. Current allure plugin will print a warning message without interfering the run, so it won't accidentally fail your builds. -* Added ability to **[retry Before](https://codecept.io/basics/#retry-before), BeforeSuite, After, AfterSuite** hooks by **[davertmik](https://github.com/davertmik)**: +- **Updated to latest mocha and modern Cucumber** +- **Allure plugin moved to [@codeceptjs/allure-legacy](https://github.com/codeceptjs/allure-legacy) package**. This happened because allure-commons package v1 was not updated and caused vulnarabilities. Fixes [#3422](https://github.com/codeceptjs/CodeceptJS/issues/3422). We don't plan to maintain allure v2 plugin so it's up to community to take this initiative. Current allure plugin will print a warning message without interfering the run, so it won't accidentally fail your builds. +- Added ability to **[retry Before](https://codecept.io/basics/#retry-before), BeforeSuite, After, AfterSuite** hooks by **[davertmik](https://github.com/davertmik)**: + ```js Feature('flaky Before & BeforeSuite', { retryBefore: 2, retryBeforeSuite: 3 }) ``` -* **Flexible [retries configuration](https://codecept.io/basics/#retry-configuration) introduced** by **[davertmik](https://github.com/davertmik)**: +- **Flexible [retries configuration](https://codecept.io/basics/#retry-configuration) introduced** by **[davertmik](https://github.com/davertmik)**: ```js retry: [ { // enable this config only for flaky tests - grep: '@flaky', + grep: '@flaky', Before: 3 // retry Before 3 times Scenario: 3 // retry Scenario 3 times - }, + }, { // retry less when running slow tests - grep: '@slow' + grep: '@slow' Scenario: 1 Before: 1 }, { @@ -1639,91 +2139,92 @@ retry: [ } ] ``` -* **Flexible [timeout configuration](https://codecept.io/advanced/#timeout-configuration)** introduced by **[davertmik](https://github.com/davertmik)**: + +- **Flexible [timeout configuration](https://codecept.io/advanced/#timeout-configuration)** introduced by **[davertmik](https://github.com/davertmik)**: ```js timeout: [ - 10, // default timeout is 10secs - { // but increase timeout for slow tests + 10, // default timeout is 10secs + { + // but increase timeout for slow tests grep: '@slow', - Feature: 50 + Feature: 50, }, ] ``` -* JsDoc: Removed promise from `I.say`. See [#3535](https://github.com/codeceptjs/CodeceptJS/issues/3535) by **[danielrentz](https://github.com/danielrentz)** -* **[Playwright]** `handleDownloads` requires now a filename param. See [#3511](https://github.com/codeceptjs/CodeceptJS/issues/3511) by **[PeterNgTr](https://github.com/PeterNgTr)** -* **[WebDriver]** Added support for v8, removed support for webdriverio v5 and lower. See [#3578](https://github.com/codeceptjs/CodeceptJS/issues/3578) by **[PeterNgTr](https://github.com/PeterNgTr)** - +- JsDoc: Removed promise from `I.say`. See [#3535](https://github.com/codeceptjs/CodeceptJS/issues/3535) by **[danielrentz](https://github.com/danielrentz)** +- **[Playwright]** `handleDownloads` requires now a filename param. See [#3511](https://github.com/codeceptjs/CodeceptJS/issues/3511) by **[PeterNgTr](https://github.com/PeterNgTr)** +- **[WebDriver]** Added support for v8, removed support for webdriverio v5 and lower. See [#3578](https://github.com/codeceptjs/CodeceptJS/issues/3578) by **[PeterNgTr](https://github.com/PeterNgTr)** ## 3.3.7 🛩ī¸ Features -* **Promise-based typings** for TypeScript definitions in [#3465](https://github.com/codeceptjs/CodeceptJS/issues/3465) by **[nlespiaucq](https://github.com/nlespiaucq)**. If you use TypeScript or use linters [check how it may be useful to you](https://bit.ly/3XIMq6n). -* **Translation** improved to use [custom vocabulary](https://codecept.io/translation/). -* **[Playwright]** Added methods in [#3398](https://github.com/codeceptjs/CodeceptJS/issues/3398) by **[mirao](https://github.com/mirao)** - * `restartBrowser` - to restart a browser (with different config) - * `_createContextPage` - to create a new browser context with a page from a helper -* Added [Cucumber custom types](/bdd#custom-types) for BDD in [#3435](https://github.com/codeceptjs/CodeceptJS/issues/3435) by **[Likstern](https://github.com/Likstern)** -* Propose using JSONResponse helper when initializing project for API testing. [#3455](https://github.com/codeceptjs/CodeceptJS/issues/3455) by **[PeterNgTr](https://github.com/PeterNgTr)** -* When translation enabled, generate tests using localized aliases. By **[davertmik](https://github.com/davertmik)** -* **[Appium]** Added `checkIfAppIsInstalled` in [#3507](https://github.com/codeceptjs/CodeceptJS/issues/3507) by **[PeterNgTr](https://github.com/PeterNgTr)** +- **Promise-based typings** for TypeScript definitions in [#3465](https://github.com/codeceptjs/CodeceptJS/issues/3465) by **[nlespiaucq](https://github.com/nlespiaucq)**. If you use TypeScript or use linters [check how it may be useful to you](https://bit.ly/3XIMq6n). +- **Translation** improved to use [custom vocabulary](https://codecept.io/translation/). +- **[Playwright]** Added methods in [#3398](https://github.com/codeceptjs/CodeceptJS/issues/3398) by **[mirao](https://github.com/mirao)** + - `restartBrowser` - to restart a browser (with different config) + - `_createContextPage` - to create a new browser context with a page from a helper +- Added [Cucumber custom types](/bdd#custom-types) for BDD in [#3435](https://github.com/codeceptjs/CodeceptJS/issues/3435) by **[Likstern](https://github.com/Likstern)** +- Propose using JSONResponse helper when initializing project for API testing. [#3455](https://github.com/codeceptjs/CodeceptJS/issues/3455) by **[PeterNgTr](https://github.com/PeterNgTr)** +- When translation enabled, generate tests using localized aliases. By **[davertmik](https://github.com/davertmik)** +- **[Appium]** Added `checkIfAppIsInstalled` in [#3507](https://github.com/codeceptjs/CodeceptJS/issues/3507) by **[PeterNgTr](https://github.com/PeterNgTr)** 🐛 Bugfixes -* Fixed [#3462](https://github.com/codeceptjs/CodeceptJS/issues/3462) `TypeError: Cannot read properties of undefined (reading 'setStatus')` by **[dwentland24](https://github.com/dwentland24)** in [#3438](https://github.com/codeceptjs/CodeceptJS/issues/3438) -* Fixed creating steps file for TypeScript setup [#3459](https://github.com/codeceptjs/CodeceptJS/issues/3459) by **[PeterNgTr](https://github.com/PeterNgTr)** -* Fixed issue of after all event in `run-rerun` command after complete execution [#3464](https://github.com/codeceptjs/CodeceptJS/issues/3464) by **[jain-neeeraj](https://github.com/jain-neeeraj)** -* [Playwright][WebDriver][Appium] Do not change `waitForTimeout` value on validation. See [#3478](https://github.com/codeceptjs/CodeceptJS/issues/3478) by **[pmajewski24](https://github.com/pmajewski24)**. Fixes [#2589](https://github.com/codeceptjs/CodeceptJS/issues/2589) -* [Playwright][WebDriver][Protractor][Puppeteer][TestCafe] Fixes `Element "{null: undefined}" was not found` and `element ([object Object]) still not present` messages when using object locators. See [#3501](https://github.com/codeceptjs/CodeceptJS/issues/3501) and [#3502](https://github.com/codeceptjs/CodeceptJS/issues/3502) by **[pmajewski24](https://github.com/pmajewski24)** -* **[Playwright]** Improved file names when downloading file in [#3449](https://github.com/codeceptjs/CodeceptJS/issues/3449) by **[PeterNgTr](https://github.com/PeterNgTr)**. Fixes [#3412](https://github.com/codeceptjs/CodeceptJS/issues/3412) and [#3409](https://github.com/codeceptjs/CodeceptJS/issues/3409) -* Add default value to `profile` env variable. See [#3443](https://github.com/codeceptjs/CodeceptJS/issues/3443) by **[dwentland24](https://github.com/dwentland24)**. Resolves [#3339](https://github.com/codeceptjs/CodeceptJS/issues/3339) -* **[Playwright]** Using system-native path separator when saving artifacts in [#3460](https://github.com/codeceptjs/CodeceptJS/issues/3460) by **[PeterNgTr](https://github.com/PeterNgTr)** -* **[Playwright]** Saving videos and traces from multiple sessions in [#3505](https://github.com/codeceptjs/CodeceptJS/issues/3505) by **[davertmik](https://github.com/davertmik)** -* **[Playwright]** Fixed `amOnPage` to navigate to `about:blank` by **[zaxoavoki](https://github.com/zaxoavoki)** in [#3470](https://github.com/codeceptjs/CodeceptJS/issues/3470) Fixes [#2311](https://github.com/codeceptjs/CodeceptJS/issues/2311) -* Various typing improvements by **[AWolf81](https://github.com/AWolf81)** **[PeterNgTr](https://github.com/PeterNgTr)** **[mirao](https://github.com/mirao)** +- Fixed [#3462](https://github.com/codeceptjs/CodeceptJS/issues/3462) `TypeError: Cannot read properties of undefined (reading 'setStatus')` by **[dwentland24](https://github.com/dwentland24)** in [#3438](https://github.com/codeceptjs/CodeceptJS/issues/3438) +- Fixed creating steps file for TypeScript setup [#3459](https://github.com/codeceptjs/CodeceptJS/issues/3459) by **[PeterNgTr](https://github.com/PeterNgTr)** +- Fixed issue of after all event in `run-rerun` command after complete execution [#3464](https://github.com/codeceptjs/CodeceptJS/issues/3464) by **[jain-neeeraj](https://github.com/jain-neeeraj)** +- [Playwright][WebDriver][Appium] Do not change `waitForTimeout` value on validation. See [#3478](https://github.com/codeceptjs/CodeceptJS/issues/3478) by **[pmajewski24](https://github.com/pmajewski24)**. Fixes [#2589](https://github.com/codeceptjs/CodeceptJS/issues/2589) +- [Playwright][WebDriver][Protractor][Puppeteer][TestCafe] Fixes `Element "{null: undefined}" was not found` and `element ([object Object]) still not present` messages when using object locators. See [#3501](https://github.com/codeceptjs/CodeceptJS/issues/3501) and [#3502](https://github.com/codeceptjs/CodeceptJS/issues/3502) by **[pmajewski24](https://github.com/pmajewski24)** +- **[Playwright]** Improved file names when downloading file in [#3449](https://github.com/codeceptjs/CodeceptJS/issues/3449) by **[PeterNgTr](https://github.com/PeterNgTr)**. Fixes [#3412](https://github.com/codeceptjs/CodeceptJS/issues/3412) and [#3409](https://github.com/codeceptjs/CodeceptJS/issues/3409) +- Add default value to `profile` env variable. See [#3443](https://github.com/codeceptjs/CodeceptJS/issues/3443) by **[dwentland24](https://github.com/dwentland24)**. Resolves [#3339](https://github.com/codeceptjs/CodeceptJS/issues/3339) +- **[Playwright]** Using system-native path separator when saving artifacts in [#3460](https://github.com/codeceptjs/CodeceptJS/issues/3460) by **[PeterNgTr](https://github.com/PeterNgTr)** +- **[Playwright]** Saving videos and traces from multiple sessions in [#3505](https://github.com/codeceptjs/CodeceptJS/issues/3505) by **[davertmik](https://github.com/davertmik)** +- **[Playwright]** Fixed `amOnPage` to navigate to `about:blank` by **[zaxoavoki](https://github.com/zaxoavoki)** in [#3470](https://github.com/codeceptjs/CodeceptJS/issues/3470) Fixes [#2311](https://github.com/codeceptjs/CodeceptJS/issues/2311) +- Various typing improvements by **[AWolf81](https://github.com/AWolf81)** **[PeterNgTr](https://github.com/PeterNgTr)** **[mirao](https://github.com/mirao)** 📖 Documentation -* Updated [Quickstart](https://codecept.io/quickstart/) with detailed explanation of questions in init -* Added [Translation](/translation/) guide -* Updated [TypeScript](https://bit.ly/3XIMq6n) guide for promise-based typings -* Reordered guides list on a website +- Updated [Quickstart](https://codecept.io/quickstart/) with detailed explanation of questions in init +- Added [Translation](/translation/) guide +- Updated [TypeScript](https://bit.ly/3XIMq6n) guide for promise-based typings +- Reordered guides list on a website ## 3.3.6 -* [`run-rerun`](https://codecept.io/commands/#run-rerun) command was re-introduced by **[dwentland24](https://github.com/dwentland24)** in [#3436](https://github.com/codeceptjs/CodeceptJS/issues/3436). Use it to perform run multiple times and detect flaky tests -* Enabled `retryFailedStep` by default in `@codeceptjs/configure` v 0.10. See https://github.com/codeceptjs/configure/pull/26 -* **[Playwright]** Fixed properties types "waitForNavigation" and "firefox" by **[mirao](https://github.com/mirao)** in [#3401](https://github.com/codeceptjs/CodeceptJS/issues/3401) -* **[REST]** Changed "endpoint" to optional by **[mirao](https://github.com/mirao)** in [#3404](https://github.com/codeceptjs/CodeceptJS/issues/3404) -* **[REST]** Use [`secret`](/secrets) for form encoded string by **[PeterNgTr](https://github.com/PeterNgTr)**: +- [`run-rerun`](https://codecept.io/commands/#run-rerun) command was re-introduced by **[dwentland24](https://github.com/dwentland24)** in [#3436](https://github.com/codeceptjs/CodeceptJS/issues/3436). Use it to perform run multiple times and detect flaky tests +- Enabled `retryFailedStep` by default in `@codeceptjs/configure` v 0.10. See https://github.com/codeceptjs/configure/pull/26 +- **[Playwright]** Fixed properties types "waitForNavigation" and "firefox" by **[mirao](https://github.com/mirao)** in [#3401](https://github.com/codeceptjs/CodeceptJS/issues/3401) +- **[REST]** Changed "endpoint" to optional by **[mirao](https://github.com/mirao)** in [#3404](https://github.com/codeceptjs/CodeceptJS/issues/3404) +- **[REST]** Use [`secret`](/secrets) for form encoded string by **[PeterNgTr](https://github.com/PeterNgTr)**: ```js -const secretData = secret('name=john&password=123456'); -const response = await I.sendPostRequest('/user', secretData); -``` - -* [Playwright]Fixed docs related to fixed properties types "waitForNavigation" and "firefox" by **[mirao](https://github.com/mirao)** in [#3407](https://github.com/codeceptjs/CodeceptJS/issues/3407) -* [Playwright]Fixed parameters of startActivity() by **[mirao](https://github.com/mirao)** in [#3408](https://github.com/codeceptjs/CodeceptJS/issues/3408) -* Move semver to prod dependencies by **[timja](https://github.com/timja)** in [#3413](https://github.com/codeceptjs/CodeceptJS/issues/3413) -* check if browser is W3C instead of Android by **[mikk150](https://github.com/mikk150)** in [#3414](https://github.com/codeceptjs/CodeceptJS/issues/3414) -* Pass service configs with options and caps as array for browsersâ€Ļ by **[07souravkunda](https://github.com/07souravkunda)** in [#3418](https://github.com/codeceptjs/CodeceptJS/issues/3418) -* fix for type of "webdriver.port" by **[ngraf](https://github.com/ngraf)** in [#3421](https://github.com/codeceptjs/CodeceptJS/issues/3421) -* fix for type of "webdriver.smartWait" by **[pmajewski24](https://github.com/pmajewski24)** in [#3426](https://github.com/codeceptjs/CodeceptJS/issues/3426) -* fix(datatable): mask secret text by **[PeterNgTr](https://github.com/PeterNgTr)** in [#3432](https://github.com/codeceptjs/CodeceptJS/issues/3432) -* fix(playwright) - video name and missing type by **[PeterNgTr](https://github.com/PeterNgTr)** in [#3430](https://github.com/codeceptjs/CodeceptJS/issues/3430) -* fix for expected type of "bootstrap", "teardown", "bootstrapAll" and "teardownAll" by **[ngraf](https://github.com/ngraf)** in [#3424](https://github.com/codeceptjs/CodeceptJS/issues/3424) -* Improve generate pageobject `gpo` command to work with TypeScript by **[PeterNgTr](https://github.com/PeterNgTr)** in [#3411](https://github.com/codeceptjs/CodeceptJS/issues/3411) -* Fixed dry-run to always return 0 code and exit -* Added minimal version notice for NodeJS >= 12 -* fix(utils): remove . of test title to avoid confusion by **[PeterNgTr](https://github.com/PeterNgTr)** in [#3431](https://github.com/codeceptjs/CodeceptJS/issues/3431) +const secretData = secret('name=john&password=123456') +const response = await I.sendPostRequest('/user', secretData) +``` + +- [Playwright]Fixed docs related to fixed properties types "waitForNavigation" and "firefox" by **[mirao](https://github.com/mirao)** in [#3407](https://github.com/codeceptjs/CodeceptJS/issues/3407) +- [Playwright]Fixed parameters of startActivity() by **[mirao](https://github.com/mirao)** in [#3408](https://github.com/codeceptjs/CodeceptJS/issues/3408) +- Move semver to prod dependencies by **[timja](https://github.com/timja)** in [#3413](https://github.com/codeceptjs/CodeceptJS/issues/3413) +- check if browser is W3C instead of Android by **[mikk150](https://github.com/mikk150)** in [#3414](https://github.com/codeceptjs/CodeceptJS/issues/3414) +- Pass service configs with options and caps as array for browsersâ€Ļ by **[07souravkunda](https://github.com/07souravkunda)** in [#3418](https://github.com/codeceptjs/CodeceptJS/issues/3418) +- fix for type of "webdriver.port" by **[ngraf](https://github.com/ngraf)** in [#3421](https://github.com/codeceptjs/CodeceptJS/issues/3421) +- fix for type of "webdriver.smartWait" by **[pmajewski24](https://github.com/pmajewski24)** in [#3426](https://github.com/codeceptjs/CodeceptJS/issues/3426) +- fix(datatable): mask secret text by **[PeterNgTr](https://github.com/PeterNgTr)** in [#3432](https://github.com/codeceptjs/CodeceptJS/issues/3432) +- fix(playwright) - video name and missing type by **[PeterNgTr](https://github.com/PeterNgTr)** in [#3430](https://github.com/codeceptjs/CodeceptJS/issues/3430) +- fix for expected type of "bootstrap", "teardown", "bootstrapAll" and "teardownAll" by **[ngraf](https://github.com/ngraf)** in [#3424](https://github.com/codeceptjs/CodeceptJS/issues/3424) +- Improve generate pageobject `gpo` command to work with TypeScript by **[PeterNgTr](https://github.com/PeterNgTr)** in [#3411](https://github.com/codeceptjs/CodeceptJS/issues/3411) +- Fixed dry-run to always return 0 code and exit +- Added minimal version notice for NodeJS >= 12 +- fix(utils): remove . of test title to avoid confusion by **[PeterNgTr](https://github.com/PeterNgTr)** in [#3431](https://github.com/codeceptjs/CodeceptJS/issues/3431) ## 3.3.5 🛩ī¸ Features -* Added **TypeScript types for CodeceptJS config**. +- Added **TypeScript types for CodeceptJS config**. Update `codecept.conf.js` to get intellisense when writing config file: @@ -1733,42 +2234,41 @@ exports.config = { //... } ``` -* Added TS types for helpers config: - * Playwright - * Puppeteer - * WebDriver - * REST -* Added **[TypeScript option](/typescript)** for installation via `codeceptjs init` to initialize new projects in TS (by **[PeterNgTr](https://github.com/PeterNgTr)** and **[davertmik](https://github.com/davertmik)**) -* Includes `node-ts` automatically when using TypeScript setup. +- Added TS types for helpers config: + - Playwright + - Puppeteer + - WebDriver + - REST +- Added **[TypeScript option](/typescript)** for installation via `codeceptjs init` to initialize new projects in TS (by **[PeterNgTr](https://github.com/PeterNgTr)** and **[davertmik](https://github.com/davertmik)**) +- Includes `node-ts` automatically when using TypeScript setup. 🐛 Bugfixes -* **[Puppeteer]** Fixed support for Puppeteer > 14.4 by **[PeterNgTr](https://github.com/PeterNgTr)** -* Don't report files as existing when non-directory is in path by **[jonathanperret](https://github.com/jonathanperret)**. See [#3374](https://github.com/codeceptjs/CodeceptJS/issues/3374) -* Fixed TS type for `secret` function by **[PeterNgTr](https://github.com/PeterNgTr)** -* Fixed wrong order for async MetaSteps by **[dwentland24](https://github.com/dwentland24)**. See [#3393](https://github.com/codeceptjs/CodeceptJS/issues/3393) -* Fixed same param substitution in BDD step. See [#3385](https://github.com/codeceptjs/CodeceptJS/issues/3385) by **[snehabhandge](https://github.com/snehabhandge)** +- **[Puppeteer]** Fixed support for Puppeteer > 14.4 by **[PeterNgTr](https://github.com/PeterNgTr)** +- Don't report files as existing when non-directory is in path by **[jonathanperret](https://github.com/jonathanperret)**. See [#3374](https://github.com/codeceptjs/CodeceptJS/issues/3374) +- Fixed TS type for `secret` function by **[PeterNgTr](https://github.com/PeterNgTr)** +- Fixed wrong order for async MetaSteps by **[dwentland24](https://github.com/dwentland24)**. See [#3393](https://github.com/codeceptjs/CodeceptJS/issues/3393) +- Fixed same param substitution in BDD step. See [#3385](https://github.com/codeceptjs/CodeceptJS/issues/3385) by **[snehabhandge](https://github.com/snehabhandge)** 📖 Documentation -* Updated [configuration options](https://codecept.io/configuration/) to match TypeScript types -* Updated [TypeScript documentation](https://codecept.io/typescript/) on simplifying TS installation -* Added codecept-tesults plugin documentation by **[ajeetd](https://github.com/ajeetd)** - - +- Updated [configuration options](https://codecept.io/configuration/) to match TypeScript types +- Updated [TypeScript documentation](https://codecept.io/typescript/) on simplifying TS installation +- Added codecept-tesults plugin documentation by **[ajeetd](https://github.com/ajeetd)** ## 3.3.4 -* Added support for masking fields in objects via `secret` function: +- Added support for masking fields in objects via `secret` function: ```js -I.sendPostRequest('/auth', secret({ name: 'jon', password: '123456' }, 'password')); +I.sendPostRequest('/auth', secret({ name: 'jon', password: '123456' }, 'password')) ``` -* Added [a guide about using of `secret`](/secrets) function -* **[Appium]** Use `touchClick` when interacting with elements in iOS. See [#3317](https://github.com/codeceptjs/CodeceptJS/issues/3317) by **[mikk150](https://github.com/mikk150)** -* **[Playwright]** Added `cdpConnection` option to connect over CDP. See [#3309](https://github.com/codeceptjs/CodeceptJS/issues/3309) by **[Hmihaly](https://github.com/Hmihaly)** -* [customLocator plugin] Allowed to specify multiple attributes for custom locator. Thanks to **[aruiz-caritsqa](https://github.com/aruiz-caritsqa)** + +- Added [a guide about using of `secret`](/secrets) function +- **[Appium]** Use `touchClick` when interacting with elements in iOS. See [#3317](https://github.com/codeceptjs/CodeceptJS/issues/3317) by **[mikk150](https://github.com/mikk150)** +- **[Playwright]** Added `cdpConnection` option to connect over CDP. See [#3309](https://github.com/codeceptjs/CodeceptJS/issues/3309) by **[Hmihaly](https://github.com/Hmihaly)** +- [customLocator plugin] Allowed to specify multiple attributes for custom locator. Thanks to **[aruiz-caritsqa](https://github.com/aruiz-caritsqa)** ```js plugins: { @@ -1779,10 +2279,11 @@ plugins: { } } ``` -* [retryTo plugin] Fixed [#3147](https://github.com/codeceptjs/CodeceptJS/issues/3147) using `pollInterval` option. See [#3351](https://github.com/codeceptjs/CodeceptJS/issues/3351) by **[cyonkee](https://github.com/cyonkee)** -* **[Playwright]** Fixed grabbing of browser console messages and window resize in new tab. Thanks to **[mirao](https://github.com/mirao)** -* **[REST]** Added `prettyPrintJson` option to print JSON in nice way by **[PeterNgTr](https://github.com/PeterNgTr)** -* **[JSONResponse]** Updated response validation to iterate over array items if response is array. Thanks to **[PeterNgTr](https://github.com/PeterNgTr)** + +- [retryTo plugin] Fixed [#3147](https://github.com/codeceptjs/CodeceptJS/issues/3147) using `pollInterval` option. See [#3351](https://github.com/codeceptjs/CodeceptJS/issues/3351) by **[cyonkee](https://github.com/cyonkee)** +- **[Playwright]** Fixed grabbing of browser console messages and window resize in new tab. Thanks to **[mirao](https://github.com/mirao)** +- **[REST]** Added `prettyPrintJson` option to print JSON in nice way by **[PeterNgTr](https://github.com/PeterNgTr)** +- **[JSONResponse]** Updated response validation to iterate over array items if response is array. Thanks to **[PeterNgTr](https://github.com/PeterNgTr)** ```js // response.data == [ @@ -1790,37 +2291,36 @@ plugins: { // { user: { name: 'matt', email: 'matt@doe.com' } }, //] -I.seeResponseContainsKeys(['user']); -I.seeResponseContainsJson({ user: { email: 'jon@doe.com' } }); -I.seeResponseContainsJson({ user: { email: 'matt@doe.com' } }); -I.dontSeeResponseContainsJson({ user: 2 }); +I.seeResponseContainsKeys(['user']) +I.seeResponseContainsJson({ user: { email: 'jon@doe.com' } }) +I.seeResponseContainsJson({ user: { email: 'matt@doe.com' } }) +I.dontSeeResponseContainsJson({ user: 2 }) ``` ## 3.3.3 -* Fixed `DataCloneError: () => could not be cloned` when running data tests in run-workers -* đŸ‡ēđŸ‡Ļ Added #StandWithUkraine notice to CLI - +- Fixed `DataCloneError: () => could not be cloned` when running data tests in run-workers +- đŸ‡ēđŸ‡Ļ Added #StandWithUkraine notice to CLI ## 3.3.2 -* **[REST]** Fixed override of headers/token in `haveRequestHeaders()` and `amBearerAuthenticated()`. See [#3304](https://github.com/codeceptjs/CodeceptJS/issues/3304) by **[mirao](https://github.com/mirao)** -* Reverted typings change introduced in [#3245](https://github.com/codeceptjs/CodeceptJS/issues/3245). [More details on this](https://twitter.com/CodeceptJS/status/1519725963856207873) +- **[REST]** Fixed override of headers/token in `haveRequestHeaders()` and `amBearerAuthenticated()`. See [#3304](https://github.com/codeceptjs/CodeceptJS/issues/3304) by **[mirao](https://github.com/mirao)** +- Reverted typings change introduced in [#3245](https://github.com/codeceptjs/CodeceptJS/issues/3245). [More details on this](https://twitter.com/CodeceptJS/status/1519725963856207873) ## 3.3.1 🛩ī¸ Features: -* Add option to avoid duplicate gherkin step definitions ([#3257](https://github.com/codeceptjs/CodeceptJS/issues/3257)) - **[raywiis](https://github.com/raywiis)** -* Added `step.*` for run-workers [#3272](https://github.com/codeceptjs/CodeceptJS/issues/3272). Thanks to **[abhimanyupandian](https://github.com/abhimanyupandian)** -* Fixed loading tests for `codecept run` using glob patterns. By **[jayudey-wf](https://github.com/jayudey-wf)** +- Add option to avoid duplicate gherkin step definitions ([#3257](https://github.com/codeceptjs/CodeceptJS/issues/3257)) - **[raywiis](https://github.com/raywiis)** +- Added `step.*` for run-workers [#3272](https://github.com/codeceptjs/CodeceptJS/issues/3272). Thanks to **[abhimanyupandian](https://github.com/abhimanyupandian)** +- Fixed loading tests for `codecept run` using glob patterns. By **[jayudey-wf](https://github.com/jayudey-wf)** ``` npx codeceptjs run test-dir/*" ``` -* **[Playwright]** **Possible breaking change.** By default `timeout` is changed to 5000ms. The value set in 3.3.0 was too low. Please set `timeout` explicitly to not depend on release values. -* **[Playwright]** Added for color scheme option by **[PeterNgTr](https://github.com/PeterNgTr)** +- **[Playwright]** **Possible breaking change.** By default `timeout` is changed to 5000ms. The value set in 3.3.0 was too low. Please set `timeout` explicitly to not depend on release values. +- **[Playwright]** Added for color scheme option by **[PeterNgTr](https://github.com/PeterNgTr)** ```js helpers: { @@ -1831,40 +2331,39 @@ npx codeceptjs run test-dir/*" } ``` - 🐛 Bugfixes: -* **[Playwright]** Fixed `Cannot read property 'video' of undefined` -* Fixed haveRequestHeaders() and amBearerAuthenticated() of REST helper ([#3260](https://github.com/codeceptjs/CodeceptJS/issues/3260)) - **[mirao](https://github.com/mirao)** -* Fixed: allure attachment fails if screenshot failed [#3298](https://github.com/codeceptjs/CodeceptJS/issues/3298) by **[ruudvanderweijde](https://github.com/ruudvanderweijde)** -* Fixed [#3105](https://github.com/codeceptjs/CodeceptJS/issues/3105) using autoLogin() plugin with TypeScript. Fix [#3290](https://github.com/codeceptjs/CodeceptJS/issues/3290) by **[PeterNgTr](https://github.com/PeterNgTr)** -* **[Playwright]** Added extra params for click and dragAndDrop to type definitions by **[mirao](https://github.com/mirao)** - +- **[Playwright]** Fixed `Cannot read property 'video' of undefined` +- Fixed haveRequestHeaders() and amBearerAuthenticated() of REST helper ([#3260](https://github.com/codeceptjs/CodeceptJS/issues/3260)) - **[mirao](https://github.com/mirao)** +- Fixed: allure attachment fails if screenshot failed [#3298](https://github.com/codeceptjs/CodeceptJS/issues/3298) by **[ruudvanderweijde](https://github.com/ruudvanderweijde)** +- Fixed [#3105](https://github.com/codeceptjs/CodeceptJS/issues/3105) using autoLogin() plugin with TypeScript. Fix [#3290](https://github.com/codeceptjs/CodeceptJS/issues/3290) by **[PeterNgTr](https://github.com/PeterNgTr)** +- **[Playwright]** Added extra params for click and dragAndDrop to type definitions by **[mirao](https://github.com/mirao)** 📖 Documentation -* Improving the typings in many places -* Improving the return type of helpers for TS users ([#3245](https://github.com/codeceptjs/CodeceptJS/issues/3245)) - **[nlespiaucq](https://github.com/nlespiaucq)** + +- Improving the typings in many places +- Improving the return type of helpers for TS users ([#3245](https://github.com/codeceptjs/CodeceptJS/issues/3245)) - **[nlespiaucq](https://github.com/nlespiaucq)** ## 3.3.0 🛩ī¸ Features: -* [**API Testing introduced**](/api) - * Introduced [`JSONResponse`](/helpers/JSONResponse) helper which connects to REST, GraphQL or Playwright helper - * **[REST]** Added `amBearerAuthenticated` method - * **[REST]** Added `haveRequestHeaders` method - * Added dependency on `joi` and `chai` -* **[Playwright]** Added `timeout` option to set [timeout](https://playwright.dev/docs/api/class-page#page-set-default-timeout) for all Playwright actions. If an action fails, Playwright keeps retrying it for a time set by timeout. -* **[Playwright]** **Possible breaking change.** By default `timeout` is set to 1000ms. *Previous default was set by Playwright internally to 30s. This was causing contradiction to CodeceptJS retries, so triggered up to 3 retries for 30s of time. This timeout option was lowered so retryFailedStep plugin would not cause long delays.* -* **[Playwright]** Updated `restart` config option to include 3 restart strategies: - * 'context' or **false** - restarts [browser context](https://playwright.dev/docs/api/class-browsercontext) but keeps running browser. Recommended by Playwright team to keep tests isolated. - * 'browser' or **true** - closes browser and opens it again between tests. - * 'session' or 'keep' - keeps browser context and session, but cleans up cookies and localStorage between tests. The fastest option when running tests in windowed mode. Works with `keepCookies` and `keepBrowserState` options. This behavior was default prior CodeceptJS 3.1 -* **[Playwright]** Extended methods to provide more options from engine. These methods were updated so additional options can be be passed as the last argument: - * [`click`](/helpers/Playwright#click) - * [`dragAndDrop`](/helpers/Playwright#dragAndDrop) - * [`checkOption`](/helpers/Playwright#checkOption) - * [`uncheckOption`](/helpers/Playwright#uncheckOption) +- [**API Testing introduced**](/api) + - Introduced [`JSONResponse`](/helpers/JSONResponse) helper which connects to REST, GraphQL or Playwright helper + - **[REST]** Added `amBearerAuthenticated` method + - **[REST]** Added `haveRequestHeaders` method + - Added dependency on `joi` and `chai` +- **[Playwright]** Added `timeout` option to set [timeout](https://playwright.dev/docs/api/class-page#page-set-default-timeout) for all Playwright actions. If an action fails, Playwright keeps retrying it for a time set by timeout. +- **[Playwright]** **Possible breaking change.** By default `timeout` is set to 1000ms. _Previous default was set by Playwright internally to 30s. This was causing contradiction to CodeceptJS retries, so triggered up to 3 retries for 30s of time. This timeout option was lowered so retryFailedStep plugin would not cause long delays._ +- **[Playwright]** Updated `restart` config option to include 3 restart strategies: + - 'context' or **false** - restarts [browser context](https://playwright.dev/docs/api/class-browsercontext) but keeps running browser. Recommended by Playwright team to keep tests isolated. + - 'browser' or **true** - closes browser and opens it again between tests. + - 'session' or 'keep' - keeps browser context and session, but cleans up cookies and localStorage between tests. The fastest option when running tests in windowed mode. Works with `keepCookies` and `keepBrowserState` options. This behavior was default prior CodeceptJS 3.1 +- **[Playwright]** Extended methods to provide more options from engine. These methods were updated so additional options can be be passed as the last argument: + - [`click`](/helpers/Playwright#click) + - [`dragAndDrop`](/helpers/Playwright#dragAndDrop) + - [`checkOption`](/helpers/Playwright#checkOption) + - [`uncheckOption`](/helpers/Playwright#uncheckOption) ```js // use Playwright click options as 3rd argument @@ -1873,83 +2372,85 @@ I.click('canvas', '.model', { position: { x: 20, y: 40 } }) I.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } }) ``` -* `eachElement` plugin introduced. It allows you to iterate over elements and perform some action on them using direct engines API +- `eachElement` plugin introduced. It allows you to iterate over elements and perform some action on them using direct engines API ```js await eachElement('click all links in .list', '.list a', (el) => { await el.click(); }) ``` -* **[Playwright]** Added support to `playwright-core` package if `playwright` is not installed. See [#3190](https://github.com/codeceptjs/CodeceptJS/issues/3190), fixes [#2663](https://github.com/codeceptjs/CodeceptJS/issues/2663). -* **[Playwright]** Added `makeApiRequest` action to perform API requests. Requires Playwright >= 1.18 -* Added support to `codecept.config.js` for name consistency across other JS tools. See motivation at [#3195](https://github.com/codeceptjs/CodeceptJS/issues/3195) by **[JiLiZART](https://github.com/JiLiZART)** -* **[ApiDataFactory]** Added options arg to `have` method. See [#3197](https://github.com/codeceptjs/CodeceptJS/issues/3197) by **[JJlokidoki](https://github.com/JJlokidoki)** -* Improved pt-br translations to include keywords: 'Funcionalidade', 'CenÃĄrio', 'Antes', 'Depois', 'AntesDaSuite', 'DepoisDaSuite'. See [#3206](https://github.com/codeceptjs/CodeceptJS/issues/3206) by **[danilolutz](https://github.com/danilolutz)** -* [allure plugin] Introduced `addStep` method to add comments and attachments. See [#3104](https://github.com/codeceptjs/CodeceptJS/issues/3104) by **[EgorBodnar](https://github.com/EgorBodnar)** + +- **[Playwright]** Added support to `playwright-core` package if `playwright` is not installed. See [#3190](https://github.com/codeceptjs/CodeceptJS/issues/3190), fixes [#2663](https://github.com/codeceptjs/CodeceptJS/issues/2663). +- **[Playwright]** Added `makeApiRequest` action to perform API requests. Requires Playwright >= 1.18 +- Added support to `codecept.config.js` for name consistency across other JS tools. See motivation at [#3195](https://github.com/codeceptjs/CodeceptJS/issues/3195) by **[JiLiZART](https://github.com/JiLiZART)** +- **[ApiDataFactory]** Added options arg to `have` method. See [#3197](https://github.com/codeceptjs/CodeceptJS/issues/3197) by **[JJlokidoki](https://github.com/JJlokidoki)** +- Improved pt-br translations to include keywords: 'Funcionalidade', 'CenÃĄrio', 'Antes', 'Depois', 'AntesDaSuite', 'DepoisDaSuite'. See [#3206](https://github.com/codeceptjs/CodeceptJS/issues/3206) by **[danilolutz](https://github.com/danilolutz)** +- [allure plugin] Introduced `addStep` method to add comments and attachments. See [#3104](https://github.com/codeceptjs/CodeceptJS/issues/3104) by **[EgorBodnar](https://github.com/EgorBodnar)** 🐛 Bugfixes: -* Fixed [#3212](https://github.com/codeceptjs/CodeceptJS/issues/3212): using Regex flags for Cucumber steps. See [#3214](https://github.com/codeceptjs/CodeceptJS/issues/3214) by **[anils92](https://github.com/anils92)** +- Fixed [#3212](https://github.com/codeceptjs/CodeceptJS/issues/3212): using Regex flags for Cucumber steps. See [#3214](https://github.com/codeceptjs/CodeceptJS/issues/3214) by **[anils92](https://github.com/anils92)** 📖 Documentation -* Added [Testomat.io reporter](/reports#testomatio) -* Added [api testing](/api) guides -* Added [internal api](/internal-api) guides -* **[Appium]** Fixed documentation for `performSwipe` -* **[Playwright]** update docs for `usePlaywrightTo` method by **[dbudzins](https://github.com/dbudzins)** +- Added [Testomat.io reporter](/reports#testomatio) +- Added [api testing](/api) guides +- Added [internal api](/internal-api) guides +- **[Appium]** Fixed documentation for `performSwipe` +- **[Playwright]** update docs for `usePlaywrightTo` method by **[dbudzins](https://github.com/dbudzins)** ## 3.2.3 -* Documentation improvements by **[maojunxyz](https://github.com/maojunxyz)** -* Guard mocha cli reporter from registering step logger multiple times [#3180](https://github.com/codeceptjs/CodeceptJS/issues/3180) by **[nikocanvacom](https://github.com/nikocanvacom)** -* **[Playwright]** Fixed "tracing.stop: tracing.stop: ENAMETOOLONG: name too long" by **[hatufacci](https://github.com/hatufacci)** -* Fixed [#2889](https://github.com/codeceptjs/CodeceptJS/issues/2889): return always the same error contract from simplifyTest. See [#3168](https://github.com/codeceptjs/CodeceptJS/issues/3168) by **[andremoah](https://github.com/andremoah)** +- Documentation improvements by **[maojunxyz](https://github.com/maojunxyz)** +- Guard mocha cli reporter from registering step logger multiple times [#3180](https://github.com/codeceptjs/CodeceptJS/issues/3180) by **[nikocanvacom](https://github.com/nikocanvacom)** +- **[Playwright]** Fixed "tracing.stop: tracing.stop: ENAMETOOLONG: name too long" by **[hatufacci](https://github.com/hatufacci)** +- Fixed [#2889](https://github.com/codeceptjs/CodeceptJS/issues/2889): return always the same error contract from simplifyTest. See [#3168](https://github.com/codeceptjs/CodeceptJS/issues/3168) by **[andremoah](https://github.com/andremoah)** ## 3.2.2 -* **[Playwright]** Reverted removal of retry on context errors. Fixes [#3130](https://github.com/codeceptjs/CodeceptJS/issues/3130) -* Timeout improvements by **[nikocanvacom](https://github.com/nikocanvacom)**: - * Added priorites to timeouts - * Added `overrideStepLimits` to [stepTimeout plugin](https://codecept.io/plugins/#steptimeout) to override steps timeouts set by `limitTime`. - * Fixed step timeout not working due to override by NaN by test timeout [#3126](https://github.com/codeceptjs/CodeceptJS/issues/3126) -* **[Appium]** Fixed logging error when `manualStart` is true. See [#3140](https://github.com/codeceptjs/CodeceptJS/issues/3140) by **[nikocanvacom](https://github.com/nikocanvacom)** - +- **[Playwright]** Reverted removal of retry on context errors. Fixes [#3130](https://github.com/codeceptjs/CodeceptJS/issues/3130) +- Timeout improvements by **[nikocanvacom](https://github.com/nikocanvacom)**: + - Added priorites to timeouts + - Added `overrideStepLimits` to [stepTimeout plugin](https://codecept.io/plugins/#steptimeout) to override steps timeouts set by `limitTime`. + - Fixed step timeout not working due to override by NaN by test timeout [#3126](https://github.com/codeceptjs/CodeceptJS/issues/3126) +- **[Appium]** Fixed logging error when `manualStart` is true. See [#3140](https://github.com/codeceptjs/CodeceptJS/issues/3140) by **[nikocanvacom](https://github.com/nikocanvacom)** ## 3.2.1 > â™ģī¸ This release fixes hanging of tests by reducing timeouts for automatic retries on failures. -* [retryFailedStep plugin] **New Defaults**: retries steps up to 3 times with factor of 1.5 (previously 5 with factor 2) -* **[Playwright]** - disabled retry on failed context actions (not needed anymore) -* **[Puppeteer]** - reduced retries on context failures to 3 times. -* **[Playwright]** Handling `crash` event to automatically close crashed pages. +- [retryFailedStep plugin] **New Defaults**: retries steps up to 3 times with factor of 1.5 (previously 5 with factor 2) +- **[Playwright]** - disabled retry on failed context actions (not needed anymore) +- **[Puppeteer]** - reduced retries on context failures to 3 times. +- **[Playwright]** Handling `crash` event to automatically close crashed pages. ## 3.2.0 🛩ī¸ Features: **[Timeouts](https://codecept.io/advanced/#timeout) implemented** - * global timeouts (via `timeout` config option). - * _Breaking change:_ timeout option expects **timeout in seconds**, not in milliseconds as it was previously. - * test timeouts (via `Scenario` and `Feature` options) - * _Breaking change:_ `Feature().timeout()` and `Scenario().timeout()` calls has no effect and are deprecated + +- global timeouts (via `timeout` config option). + - _Breaking change:_ timeout option expects **timeout in seconds**, not in milliseconds as it was previously. +- test timeouts (via `Scenario` and `Feature` options) + - _Breaking change:_ `Feature().timeout()` and `Scenario().timeout()` calls has no effect and are deprecated ```js // set timeout for every test in suite to 10 secs -Feature('tests with timeout', { timeout: 10 }); +Feature('tests with timeout', { timeout: 10 }) // set timeout for this test to 20 secs -Scenario('a test with timeout', { timeout: 20 }, ({ I }) => {}); -``` +Scenario('a test with timeout', { timeout: 20 }, ({ I }) => {}) +``` - * step timeouts (See [#3059](https://github.com/codeceptjs/CodeceptJS/issues/3059) by **[nikocanvacom](https://github.com/nikocanvacom)**) +- step timeouts (See [#3059](https://github.com/codeceptjs/CodeceptJS/issues/3059) by **[nikocanvacom](https://github.com/nikocanvacom)**) ```js // set step timeout to 5 secs -I.limitTime(5).click('Link'); -``` - * `stepTimeout` plugin introduced to automatically add timeouts for each step ([#3059](https://github.com/codeceptjs/CodeceptJS/issues/3059) by **[nikocanvacom](https://github.com/nikocanvacom)**). +I.limitTime(5).click('Link') +``` + +- `stepTimeout` plugin introduced to automatically add timeouts for each step ([#3059](https://github.com/codeceptjs/CodeceptJS/issues/3059) by **[nikocanvacom](https://github.com/nikocanvacom)**). [**retryTo**](/plugins/#retryto) plugin introduced to rerun a set of steps on failure: @@ -1957,150 +2458,149 @@ I.limitTime(5).click('Link'); // editing in text in iframe // if iframe was not loaded - retry 5 times await retryTo(() => { - I.switchTo('#editor frame'); - I.fillField('textarea', 'value'); -}, 5); + I.switchTo('#editor frame') + I.fillField('textarea', 'value') +}, 5) ``` -* **[Playwright]** added `locale` configuration -* **[WebDriver]** upgraded to webdriverio v7 +- **[Playwright]** added `locale` configuration +- **[WebDriver]** upgraded to webdriverio v7 🐛 Bugfixes: -* Fixed allure plugin "Unexpected endStep()" error in [#3098](https://github.com/codeceptjs/CodeceptJS/issues/3098) by **[abhimanyupandian](https://github.com/abhimanyupandian)** -* **[Puppeteer]** always close remote browser on test end. See [#3054](https://github.com/codeceptjs/CodeceptJS/issues/3054) by **[mattonem](https://github.com/mattonem)** -* stepbyStepReport Plugin: Disabled screenshots after test has failed. See [#3119](https://github.com/codeceptjs/CodeceptJS/issues/3119) by **[ioannisChalkias](https://github.com/ioannisChalkias)** - +- Fixed allure plugin "Unexpected endStep()" error in [#3098](https://github.com/codeceptjs/CodeceptJS/issues/3098) by **[abhimanyupandian](https://github.com/abhimanyupandian)** +- **[Puppeteer]** always close remote browser on test end. See [#3054](https://github.com/codeceptjs/CodeceptJS/issues/3054) by **[mattonem](https://github.com/mattonem)** +- stepbyStepReport Plugin: Disabled screenshots after test has failed. See [#3119](https://github.com/codeceptjs/CodeceptJS/issues/3119) by **[ioannisChalkias](https://github.com/ioannisChalkias)** ## 3.1.3 🛩ī¸ Features: -* BDD Improvement. Added `DataTableArgument` class to work with table data structures. +- BDD Improvement. Added `DataTableArgument` class to work with table data structures. ```js const { DataTableArgument } = require('codeceptjs'); //... Given('I have an employee card', (table) => { const dataTableArgument = new DataTableArgument(table); - const hashes = dataTableArgument.hashes(); + const hashes = dataTableArgument.hashes(); // hashes = [{ name: 'Harry', surname: 'Potter', position: 'Seeker' }]; const rows = dataTableArgument.rows(); // rows = [['Harry', 'Potter', Seeker]]; } ``` + See updated [BDD section](https://codecept.io/bdd/) for more API options. Thanks to **[EgorBodnar](https://github.com/EgorBodnar)** -* Support `cjs` file extensions for config file: `codecept.conf.cjs`. See [#3052](https://github.com/codeceptjs/CodeceptJS/issues/3052) by **[kalvenschraut](https://github.com/kalvenschraut)** -* API updates: Added `test.file` and `suite.file` properties to `test` and `suite` objects to use in helpers and plugins. +- Support `cjs` file extensions for config file: `codecept.conf.cjs`. See [#3052](https://github.com/codeceptjs/CodeceptJS/issues/3052) by **[kalvenschraut](https://github.com/kalvenschraut)** +- API updates: Added `test.file` and `suite.file` properties to `test` and `suite` objects to use in helpers and plugins. 🐛 Bugfixes: -* **[Playwright]** Fixed resetting `test.artifacts` for failing tests. See [#3033](https://github.com/codeceptjs/CodeceptJS/issues/3033) by **[jancorvus](https://github.com/jancorvus)**. Fixes [#3032](https://github.com/codeceptjs/CodeceptJS/issues/3032) -* **[Playwright]** Apply `basicAuth` credentials to all opened browser contexts. See [#3036](https://github.com/codeceptjs/CodeceptJS/issues/3036) by **[nikocanvacom](https://github.com/nikocanvacom)**. Fixes [#3035](https://github.com/codeceptjs/CodeceptJS/issues/3035) -* **[WebDriver]** Updated `webdriverio` default version to `^6.12.1`. See [#3043](https://github.com/codeceptjs/CodeceptJS/issues/3043) by **[sridhareaswaran](https://github.com/sridhareaswaran)** -* **[Playwright]** `I.haveRequestHeaders` affects all tabs. See [#3049](https://github.com/codeceptjs/CodeceptJS/issues/3049) by **[jancorvus](https://github.com/jancorvus)** -* BDD: Fixed unhandled empty feature files. Fix [#3046](https://github.com/codeceptjs/CodeceptJS/issues/3046) by **[abhimanyupandian](https://github.com/abhimanyupandian)** -* Fixed `RangeError: Invalid string length` in `recorder.js` when running huge amount of tests. -* **[Appium]** Fixed definitions for `touchPerform`, `hideDeviceKeyboard`, `removeApp` by **[mirao](https://github.com/mirao)** +- **[Playwright]** Fixed resetting `test.artifacts` for failing tests. See [#3033](https://github.com/codeceptjs/CodeceptJS/issues/3033) by **[jancorvus](https://github.com/jancorvus)**. Fixes [#3032](https://github.com/codeceptjs/CodeceptJS/issues/3032) +- **[Playwright]** Apply `basicAuth` credentials to all opened browser contexts. See [#3036](https://github.com/codeceptjs/CodeceptJS/issues/3036) by **[nikocanvacom](https://github.com/nikocanvacom)**. Fixes [#3035](https://github.com/codeceptjs/CodeceptJS/issues/3035) +- **[WebDriver]** Updated `webdriverio` default version to `^6.12.1`. See [#3043](https://github.com/codeceptjs/CodeceptJS/issues/3043) by **[sridhareaswaran](https://github.com/sridhareaswaran)** +- **[Playwright]** `I.haveRequestHeaders` affects all tabs. See [#3049](https://github.com/codeceptjs/CodeceptJS/issues/3049) by **[jancorvus](https://github.com/jancorvus)** +- BDD: Fixed unhandled empty feature files. Fix [#3046](https://github.com/codeceptjs/CodeceptJS/issues/3046) by **[abhimanyupandian](https://github.com/abhimanyupandian)** +- Fixed `RangeError: Invalid string length` in `recorder.js` when running huge amount of tests. +- **[Appium]** Fixed definitions for `touchPerform`, `hideDeviceKeyboard`, `removeApp` by **[mirao](https://github.com/mirao)** 📖 Documentation: -* Added Testrail reporter [Reports Docs](https://codecept.io/reports/#testrail) - +- Added Testrail reporter [Reports Docs](https://codecept.io/reports/#testrail) ## 3.1.2 🛩ī¸ Features: -* Added `coverage` plugin to generate code coverage for Playwright & Puppeteer. By **[anirudh-modi](https://github.com/anirudh-modi)** -* Added `subtitle` plugin to generate subtitles for videos recorded with Playwright. By **[anirudh-modi](https://github.com/anirudh-modi)** -* Configuration: `config.tests` to accept array of file patterns. See [#2994](https://github.com/codeceptjs/CodeceptJS/issues/2994) by **[monsteramba](https://github.com/monsteramba)** +- Added `coverage` plugin to generate code coverage for Playwright & Puppeteer. By **[anirudh-modi](https://github.com/anirudh-modi)** +- Added `subtitle` plugin to generate subtitles for videos recorded with Playwright. By **[anirudh-modi](https://github.com/anirudh-modi)** +- Configuration: `config.tests` to accept array of file patterns. See [#2994](https://github.com/codeceptjs/CodeceptJS/issues/2994) by **[monsteramba](https://github.com/monsteramba)** ```js exports.config = { - tests: ['./*_test.js','./sampleTest.js'], - // ... + tests: ['./*_test.js', './sampleTest.js'], + // ... } ``` -* Notification is shown for test files without `Feature()`. See [#3011](https://github.com/codeceptjs/CodeceptJS/issues/3011) by **[PeterNgTr](https://github.com/PeterNgTr)** + +- Notification is shown for test files without `Feature()`. See [#3011](https://github.com/codeceptjs/CodeceptJS/issues/3011) by **[PeterNgTr](https://github.com/PeterNgTr)** 🐛 Bugfixes: -* **[Playwright]** Fixed [#2986](https://github.com/codeceptjs/CodeceptJS/issues/2986) error is thrown when deleting a missing video. Fix by **[hatufacci](https://github.com/hatufacci)** -* Fixed false positive result when invalid function is called in a helper. See [#2997](https://github.com/codeceptjs/CodeceptJS/issues/2997) by **[abhimanyupandian](https://github.com/abhimanyupandian)** -* **[Appium]** Removed full page mode for `saveScreenshot`. See [#3002](https://github.com/codeceptjs/CodeceptJS/issues/3002) by **[nlespiaucq](https://github.com/nlespiaucq)** -* **[Playwright]** Fixed [#3003](https://github.com/codeceptjs/CodeceptJS/issues/3003) saving trace for a test with a long name. Fix by **[hatufacci](https://github.com/hatufacci)** +- **[Playwright]** Fixed [#2986](https://github.com/codeceptjs/CodeceptJS/issues/2986) error is thrown when deleting a missing video. Fix by **[hatufacci](https://github.com/hatufacci)** +- Fixed false positive result when invalid function is called in a helper. See [#2997](https://github.com/codeceptjs/CodeceptJS/issues/2997) by **[abhimanyupandian](https://github.com/abhimanyupandian)** +- **[Appium]** Removed full page mode for `saveScreenshot`. See [#3002](https://github.com/codeceptjs/CodeceptJS/issues/3002) by **[nlespiaucq](https://github.com/nlespiaucq)** +- **[Playwright]** Fixed [#3003](https://github.com/codeceptjs/CodeceptJS/issues/3003) saving trace for a test with a long name. Fix by **[hatufacci](https://github.com/hatufacci)** 🎱 Other: -* Deprecated `puppeteerCoverage` plugin in favor of `coverage` plugin. +- Deprecated `puppeteerCoverage` plugin in favor of `coverage` plugin. ## 3.1.1 -* **[Appium]** Fixed [#2759](https://github.com/codeceptjs/CodeceptJS/issues/2759) - `grabNumberOfVisibleElements`, `grabAttributeFrom`, `grabAttributeFromAll` to allow id locators. +- **[Appium]** Fixed [#2759](https://github.com/codeceptjs/CodeceptJS/issues/2759) + `grabNumberOfVisibleElements`, `grabAttributeFrom`, `grabAttributeFromAll` to allow id locators. ## 3.1.0 -* **[Plawyright]** Updated to Playwright 1.13 -* **[Playwright]** **Possible breaking change**: `BrowserContext` is initialized before each test and closed after. This behavior matches recommendation from Playwright team to use different contexts for tests. -* **[Puppeteer]** Updated to Puppeteer 10.2. -* **[Protractor]** Helper deprecated +- **[Plawyright]** Updated to Playwright 1.13 +- **[Playwright]** **Possible breaking change**: `BrowserContext` is initialized before each test and closed after. This behavior matches recommendation from Playwright team to use different contexts for tests. +- **[Puppeteer]** Updated to Puppeteer 10.2. +- **[Protractor]** Helper deprecated 🛩ī¸ Features: -* **[Playwright]** Added recording of [video](https://codecept.io/playwright/#video) and [traces](https://codecept.io/playwright/#trace) by **[davertmik](https://github.com/davertmik)** -* **[Playwritght]** [Mocking requests](https://codecept.io/playwright/#mocking-network-requests) implemented via `route` API of Playwright by **[davertmik](https://github.com/davertmik)** -* **[Playwright]** Added **support for [React locators](https://codecept.io/react/#locators)** in [#2912](https://github.com/codeceptjs/CodeceptJS/issues/2912) by **[AAAstorga](https://github.com/AAAstorga)** +- **[Playwright]** Added recording of [video](https://codecept.io/playwright/#video) and [traces](https://codecept.io/playwright/#trace) by **[davertmik](https://github.com/davertmik)** +- **[Playwritght]** [Mocking requests](https://codecept.io/playwright/#mocking-network-requests) implemented via `route` API of Playwright by **[davertmik](https://github.com/davertmik)** +- **[Playwright]** Added **support for [React locators](https://codecept.io/react/#locators)** in [#2912](https://github.com/codeceptjs/CodeceptJS/issues/2912) by **[AAAstorga](https://github.com/AAAstorga)** 🐛 Bugfixes: -* **[Puppeteer]** Fixed [#2244](https://github.com/codeceptjs/CodeceptJS/issues/2244) `els[0]._clickablePoint is not a function` by **[karunandrii](https://github.com/karunandrii)**. -* **[Puppeteer]** Fixed `fillField` to check for invisible elements. See [#2916](https://github.com/codeceptjs/CodeceptJS/issues/2916) by **[anne-open-xchange](https://github.com/anne-open-xchange)** -* **[Playwright]** Reset of dialog event listener before registration of new one. [#2946](https://github.com/codeceptjs/CodeceptJS/issues/2946) by **[nikocanvacom](https://github.com/nikocanvacom)** -* Fixed running Gherkin features with `run-multiple` using chunks. See [#2900](https://github.com/codeceptjs/CodeceptJS/issues/2900) by **[andrenoberto](https://github.com/andrenoberto)** -* Fixed [#2937](https://github.com/codeceptjs/CodeceptJS/issues/2937) broken typings for subfolders on Windows by **[jancorvus](https://github.com/jancorvus)** -* Fixed issue where cucumberJsonReporter not working with fakerTransform plugin. See [#2942](https://github.com/codeceptjs/CodeceptJS/issues/2942) by **[ilangv](https://github.com/ilangv)** -* Fixed [#2952](https://github.com/codeceptjs/CodeceptJS/issues/2952) finished job with status code 0 when playwright cannot connect to remote wss url. By **[davertmik](https://github.com/davertmik)** - +- **[Puppeteer]** Fixed [#2244](https://github.com/codeceptjs/CodeceptJS/issues/2244) `els[0]._clickablePoint is not a function` by **[karunandrii](https://github.com/karunandrii)**. +- **[Puppeteer]** Fixed `fillField` to check for invisible elements. See [#2916](https://github.com/codeceptjs/CodeceptJS/issues/2916) by **[anne-open-xchange](https://github.com/anne-open-xchange)** +- **[Playwright]** Reset of dialog event listener before registration of new one. [#2946](https://github.com/codeceptjs/CodeceptJS/issues/2946) by **[nikocanvacom](https://github.com/nikocanvacom)** +- Fixed running Gherkin features with `run-multiple` using chunks. See [#2900](https://github.com/codeceptjs/CodeceptJS/issues/2900) by **[andrenoberto](https://github.com/andrenoberto)** +- Fixed [#2937](https://github.com/codeceptjs/CodeceptJS/issues/2937) broken typings for subfolders on Windows by **[jancorvus](https://github.com/jancorvus)** +- Fixed issue where cucumberJsonReporter not working with fakerTransform plugin. See [#2942](https://github.com/codeceptjs/CodeceptJS/issues/2942) by **[ilangv](https://github.com/ilangv)** +- Fixed [#2952](https://github.com/codeceptjs/CodeceptJS/issues/2952) finished job with status code 0 when playwright cannot connect to remote wss url. By **[davertmik](https://github.com/davertmik)** ## 3.0.7 📖 Documentation fixes: -* Remove broken link from `Nightmare helper`. See [#2860](https://github.com/codeceptjs/CodeceptJS/issues/2860) by **[Arhell](https://github.com/Arhell)** -* Fixed broken links in `playwright.md`. See [#2848](https://github.com/codeceptjs/CodeceptJS/issues/2848) by **[johnhoodjr](https://github.com/johnhoodjr)** -* Fix mocha-multi config example. See [#2881](https://github.com/codeceptjs/CodeceptJS/issues/2881) by **[rimesc](https://github.com/rimesc)** -* Fix small errors in email documentation file. See [#2884](https://github.com/codeceptjs/CodeceptJS/issues/2884) by **[mkrtchian](https://github.com/mkrtchian)** -* Improve documentation for `Sharing Data Between Workers` section. See [#2891](https://github.com/codeceptjs/CodeceptJS/issues/2891) by **[ngraf](https://github.com/ngraf)** +- Remove broken link from `Nightmare helper`. See [#2860](https://github.com/codeceptjs/CodeceptJS/issues/2860) by **[Arhell](https://github.com/Arhell)** +- Fixed broken links in `playwright.md`. See [#2848](https://github.com/codeceptjs/CodeceptJS/issues/2848) by **[johnhoodjr](https://github.com/johnhoodjr)** +- Fix mocha-multi config example. See [#2881](https://github.com/codeceptjs/CodeceptJS/issues/2881) by **[rimesc](https://github.com/rimesc)** +- Fix small errors in email documentation file. See [#2884](https://github.com/codeceptjs/CodeceptJS/issues/2884) by **[mkrtchian](https://github.com/mkrtchian)** +- Improve documentation for `Sharing Data Between Workers` section. See [#2891](https://github.com/codeceptjs/CodeceptJS/issues/2891) by **[ngraf](https://github.com/ngraf)** 🛩ī¸ Features: -* **[WebDriver]** Shadow DOM Support for `Webdriver`. See [#2741](https://github.com/codeceptjs/CodeceptJS/issues/2741) by **[gkushang](https://github.com/gkushang)** -* [Release management] Introduce the versioning automatically, it follows the semantics versioning. See [#2883](https://github.com/codeceptjs/CodeceptJS/issues/2883) by **[PeterNgTr](https://github.com/PeterNgTr)** -* Adding opts into `Scenario.skip` that it would be useful for building reports. See [#2867](https://github.com/codeceptjs/CodeceptJS/issues/2867) by **[AlexKo4](https://github.com/AlexKo4)** -* Added support for attaching screenshots to [cucumberJsonReporter](https://github.com/ktryniszewski-mdsol/codeceptjs-cucumber-json-reporter) See [#2888](https://github.com/codeceptjs/CodeceptJS/issues/2888) by **[fijijavis](https://github.com/fijijavis)** -* Supported config file for `codeceptjs shell` command. See [#2895](https://github.com/codeceptjs/CodeceptJS/issues/2895) by **[PeterNgTr](https://github.com/PeterNgTr)**: +- **[WebDriver]** Shadow DOM Support for `Webdriver`. See [#2741](https://github.com/codeceptjs/CodeceptJS/issues/2741) by **[gkushang](https://github.com/gkushang)** +- [Release management] Introduce the versioning automatically, it follows the semantics versioning. See [#2883](https://github.com/codeceptjs/CodeceptJS/issues/2883) by **[PeterNgTr](https://github.com/PeterNgTr)** +- Adding opts into `Scenario.skip` that it would be useful for building reports. See [#2867](https://github.com/codeceptjs/CodeceptJS/issues/2867) by **[AlexKo4](https://github.com/AlexKo4)** +- Added support for attaching screenshots to [cucumberJsonReporter](https://github.com/ktryniszewski-mdsol/codeceptjs-cucumber-json-reporter) See [#2888](https://github.com/codeceptjs/CodeceptJS/issues/2888) by **[fijijavis](https://github.com/fijijavis)** +- Supported config file for `codeceptjs shell` command. See [#2895](https://github.com/codeceptjs/CodeceptJS/issues/2895) by **[PeterNgTr](https://github.com/PeterNgTr)**: ``` npx codeceptjs shell -c foo.conf.js ``` Bug fixes: -* **[GraphQL]** Use a helper-specific instance of Axios to avoid contaminating global defaults. See [#2868](https://github.com/codeceptjs/CodeceptJS/issues/2868) by **[vanvoljg](https://github.com/vanvoljg)** -* A default system color is used when passing non supported system color when using I.say(). See [#2874](https://github.com/codeceptjs/CodeceptJS/issues/2874) by **[PeterNgTr](https://github.com/PeterNgTr)** -* **[Playwright]** Avoid the timout due to calling the click on invisible elements. See [#2875](https://github.com/codeceptjs/CodeceptJS/issues/2875) by cbayer97 +- **[GraphQL]** Use a helper-specific instance of Axios to avoid contaminating global defaults. See [#2868](https://github.com/codeceptjs/CodeceptJS/issues/2868) by **[vanvoljg](https://github.com/vanvoljg)** +- A default system color is used when passing non supported system color when using I.say(). See [#2874](https://github.com/codeceptjs/CodeceptJS/issues/2874) by **[PeterNgTr](https://github.com/PeterNgTr)** +- **[Playwright]** Avoid the timout due to calling the click on invisible elements. See [#2875](https://github.com/codeceptjs/CodeceptJS/issues/2875) by cbayer97 ## 3.0.6 -* **[Playwright]** Added `electron` as a browser to config. See [#2834](https://github.com/codeceptjs/CodeceptJS/issues/2834) by **[cbayer97](https://github.com/cbayer97)** -* **[Playwright]** Implemented `launchPersistentContext` to be able to launch persistent remote browsers. See [#2817](https://github.com/codeceptjs/CodeceptJS/issues/2817) by **[brunoqueiros](https://github.com/brunoqueiros)**. Fixes [#2376](https://github.com/codeceptjs/CodeceptJS/issues/2376). -* Fixed printing logs and stack traces for `run-workers`. See [#2857](https://github.com/codeceptjs/CodeceptJS/issues/2857) by **[haveac1gar](https://github.com/haveac1gar)**. Fixes [#2621](https://github.com/codeceptjs/CodeceptJS/issues/2621), [#2852](https://github.com/codeceptjs/CodeceptJS/issues/2852) -* Emit custom messages from worker to the main thread. See [#2824](https://github.com/codeceptjs/CodeceptJS/issues/2824) by **[jccguimaraes](https://github.com/jccguimaraes)** -* Improved workers processes output. See [#2804](https://github.com/codeceptjs/CodeceptJS/issues/2804) by **[drfiresign](https://github.com/drfiresign)** -* BDD. Added ability to use an array of feature files inside config in `gherkin.features`. See [#2814](https://github.com/codeceptjs/CodeceptJS/issues/2814) by **[jbergeronjr](https://github.com/jbergeronjr)** +- **[Playwright]** Added `electron` as a browser to config. See [#2834](https://github.com/codeceptjs/CodeceptJS/issues/2834) by **[cbayer97](https://github.com/cbayer97)** +- **[Playwright]** Implemented `launchPersistentContext` to be able to launch persistent remote browsers. See [#2817](https://github.com/codeceptjs/CodeceptJS/issues/2817) by **[brunoqueiros](https://github.com/brunoqueiros)**. Fixes [#2376](https://github.com/codeceptjs/CodeceptJS/issues/2376). +- Fixed printing logs and stack traces for `run-workers`. See [#2857](https://github.com/codeceptjs/CodeceptJS/issues/2857) by **[haveac1gar](https://github.com/haveac1gar)**. Fixes [#2621](https://github.com/codeceptjs/CodeceptJS/issues/2621), [#2852](https://github.com/codeceptjs/CodeceptJS/issues/2852) +- Emit custom messages from worker to the main thread. See [#2824](https://github.com/codeceptjs/CodeceptJS/issues/2824) by **[jccguimaraes](https://github.com/jccguimaraes)** +- Improved workers processes output. See [#2804](https://github.com/codeceptjs/CodeceptJS/issues/2804) by **[drfiresign](https://github.com/drfiresign)** +- BDD. Added ability to use an array of feature files inside config in `gherkin.features`. See [#2814](https://github.com/codeceptjs/CodeceptJS/issues/2814) by **[jbergeronjr](https://github.com/jbergeronjr)** ```js "features": [ @@ -2108,8 +2608,9 @@ Bug fixes: "./features/api_features/*.feature" ], ``` -* Added `getQueueId` to reporter to rerun a specific promise. See [#2837](https://github.com/codeceptjs/CodeceptJS/issues/2837) by **[jonatask](https://github.com/jonatask)** -* **Added `fakerTransform` plugin** to use faker data in Gherkin scenarios. See [#2854](https://github.com/codeceptjs/CodeceptJS/issues/2854) by **[adrielcodeco](https://github.com/adrielcodeco)** + +- Added `getQueueId` to reporter to rerun a specific promise. See [#2837](https://github.com/codeceptjs/CodeceptJS/issues/2837) by **[jonatask](https://github.com/jonatask)** +- **Added `fakerTransform` plugin** to use faker data in Gherkin scenarios. See [#2854](https://github.com/codeceptjs/CodeceptJS/issues/2854) by **[adrielcodeco](https://github.com/adrielcodeco)** ```feature Scenario Outline: ... @@ -2121,119 +2622,123 @@ Scenario Outline: ... | productName | customer | email | anythingMore | | {{commerce.product}} | Dr. {{name.findName}} | {{internet.email}} | staticData | ``` -* **[REST]** Use class instance of axios, not the global instance, to avoid contaminating global configuration. [#2846](https://github.com/codeceptjs/CodeceptJS/issues/2846) by **[vanvoljg](https://github.com/vanvoljg)** -* **[Appium]** Added `tunnelIdentifier` config option to provide tunnel for SauceLabs. See [#2832](https://github.com/codeceptjs/CodeceptJS/issues/2832) by **[gurjeetbains](https://github.com/gurjeetbains)** -## 3.0.5 +- **[REST]** Use class instance of axios, not the global instance, to avoid contaminating global configuration. [#2846](https://github.com/codeceptjs/CodeceptJS/issues/2846) by **[vanvoljg](https://github.com/vanvoljg)** +- **[Appium]** Added `tunnelIdentifier` config option to provide tunnel for SauceLabs. See [#2832](https://github.com/codeceptjs/CodeceptJS/issues/2832) by **[gurjeetbains](https://github.com/gurjeetbains)** +## 3.0.5 Features: -* **[Official Docker image for CodeceptJS v3](https://hub.docker.com/r/codeceptjs/codeceptjs)**. New Docker image is based on official Playwright image and supports Playwright, Puppeteer, WebDriver engines. Thanks **[VikentyShevyrin](https://github.com/VikentyShevyrin)** -* Better support for Typescript `codecept.conf.ts` configuration files. See [#2750](https://github.com/codeceptjs/CodeceptJS/issues/2750) by **[elaichenkov](https://github.com/elaichenkov)** -* Propagate more events for custom parallel script. See [#2796](https://github.com/codeceptjs/CodeceptJS/issues/2796) by **[jccguimaraes](https://github.com/jccguimaraes)** -* [mocha-junit-reporter] Now supports attachments, see documentation for details. See [#2675](https://github.com/codeceptjs/CodeceptJS/issues/2675) by **[Shard](https://github.com/Shard)** -* CustomLocators interface for TypeScript to extend from LocatorOrString. See [#2798](https://github.com/codeceptjs/CodeceptJS/issues/2798) by **[danielrentz](https://github.com/danielrentz)** -* **[REST]** Mask sensitive data from log messages. +- **[Official Docker image for CodeceptJS v3](https://hub.docker.com/r/codeceptjs/codeceptjs)**. New Docker image is based on official Playwright image and supports Playwright, Puppeteer, WebDriver engines. Thanks **[VikentyShevyrin](https://github.com/VikentyShevyrin)** +- Better support for Typescript `codecept.conf.ts` configuration files. See [#2750](https://github.com/codeceptjs/CodeceptJS/issues/2750) by **[elaichenkov](https://github.com/elaichenkov)** +- Propagate more events for custom parallel script. See [#2796](https://github.com/codeceptjs/CodeceptJS/issues/2796) by **[jccguimaraes](https://github.com/jccguimaraes)** +- [mocha-junit-reporter] Now supports attachments, see documentation for details. See [#2675](https://github.com/codeceptjs/CodeceptJS/issues/2675) by **[Shard](https://github.com/Shard)** +- CustomLocators interface for TypeScript to extend from LocatorOrString. See [#2798](https://github.com/codeceptjs/CodeceptJS/issues/2798) by **[danielrentz](https://github.com/danielrentz)** +- **[REST]** Mask sensitive data from log messages. + ```js -I.sendPatchRequest('/api/users.json', secret({ "email": "user@user.com" })); +I.sendPatchRequest('/api/users.json', secret({ email: 'user@user.com' })) ``` + See [#2786](https://github.com/codeceptjs/CodeceptJS/issues/2786) by **[PeterNgTr](https://github.com/PeterNgTr)** Bug fixes: -* Fixed reporting of nested steps with PageObjects and BDD scenarios. See [#2800](https://github.com/codeceptjs/CodeceptJS/issues/2800) by **[davertmik](https://github.com/davertmik)**. Fixes [#2720](https://github.com/codeceptjs/CodeceptJS/issues/2720) [#2682](https://github.com/codeceptjs/CodeceptJS/issues/2682) -* Fixed issue with `codeceptjs shell` which was broken since 3.0.0. See [#2743](https://github.com/codeceptjs/CodeceptJS/issues/2743) by **[stedman](https://github.com/stedman)** -* **[Gherkin]** Fixed issue suppressed or hidden errors in tests. See [#2745](https://github.com/codeceptjs/CodeceptJS/issues/2745) by **[ktryniszewski-mdsol](https://github.com/ktryniszewski-mdsol)** -* **[Playwright]** fix grabCssPropertyFromAll serialization by using property names. See [#2757](https://github.com/codeceptjs/CodeceptJS/issues/2757) by **[elaichenkov](https://github.com/elaichenkov)** -* **[Allure]** fix report for multi sessions. See [#2771](https://github.com/codeceptjs/CodeceptJS/issues/2771) by **[cbayer97](https://github.com/cbayer97)** -* **[WebDriver]** Fix locator object debug log messages in smart wait. See 2748 by **[elaichenkov](https://github.com/elaichenkov)** + +- Fixed reporting of nested steps with PageObjects and BDD scenarios. See [#2800](https://github.com/codeceptjs/CodeceptJS/issues/2800) by **[davertmik](https://github.com/davertmik)**. Fixes [#2720](https://github.com/codeceptjs/CodeceptJS/issues/2720) [#2682](https://github.com/codeceptjs/CodeceptJS/issues/2682) +- Fixed issue with `codeceptjs shell` which was broken since 3.0.0. See [#2743](https://github.com/codeceptjs/CodeceptJS/issues/2743) by **[stedman](https://github.com/stedman)** +- **[Gherkin]** Fixed issue suppressed or hidden errors in tests. See [#2745](https://github.com/codeceptjs/CodeceptJS/issues/2745) by **[ktryniszewski-mdsol](https://github.com/ktryniszewski-mdsol)** +- **[Playwright]** fix grabCssPropertyFromAll serialization by using property names. See [#2757](https://github.com/codeceptjs/CodeceptJS/issues/2757) by **[elaichenkov](https://github.com/elaichenkov)** +- **[Allure]** fix report for multi sessions. See [#2771](https://github.com/codeceptjs/CodeceptJS/issues/2771) by **[cbayer97](https://github.com/cbayer97)** +- **[WebDriver]** Fix locator object debug log messages in smart wait. See 2748 by **[elaichenkov](https://github.com/elaichenkov)** Documentation fixes: -* Fixed some broken examples. See [#2756](https://github.com/codeceptjs/CodeceptJS/issues/2756) by **[danielrentz](https://github.com/danielrentz)** -* Fixed Typescript typings. See [#2747](https://github.com/codeceptjs/CodeceptJS/issues/2747), [#2758](https://github.com/codeceptjs/CodeceptJS/issues/2758) and [#2769](https://github.com/codeceptjs/CodeceptJS/issues/2769) by **[elaichenkov](https://github.com/elaichenkov)** -* Added missing type for xFeature. See [#2754](https://github.com/codeceptjs/CodeceptJS/issues/2754) by **[PeterNgTr](https://github.com/PeterNgTr)** -* Fixed code example in Page Object documentation. See [#2793](https://github.com/codeceptjs/CodeceptJS/issues/2793) by **[mkrtchian](https://github.com/mkrtchian)** + +- Fixed some broken examples. See [#2756](https://github.com/codeceptjs/CodeceptJS/issues/2756) by **[danielrentz](https://github.com/danielrentz)** +- Fixed Typescript typings. See [#2747](https://github.com/codeceptjs/CodeceptJS/issues/2747), [#2758](https://github.com/codeceptjs/CodeceptJS/issues/2758) and [#2769](https://github.com/codeceptjs/CodeceptJS/issues/2769) by **[elaichenkov](https://github.com/elaichenkov)** +- Added missing type for xFeature. See [#2754](https://github.com/codeceptjs/CodeceptJS/issues/2754) by **[PeterNgTr](https://github.com/PeterNgTr)** +- Fixed code example in Page Object documentation. See [#2793](https://github.com/codeceptjs/CodeceptJS/issues/2793) by **[mkrtchian](https://github.com/mkrtchian)** Library updates: -* Updated Axios to 0.21.1. See by **[sseide](https://github.com/sseide)** -* Updated **[pollyjs](https://github.com/pollyjs)**/core **[pollyjs](https://github.com/pollyjs)**/adapter-puppeteer. See [#2760](https://github.com/codeceptjs/CodeceptJS/issues/2760) by **[Anikethana](https://github.com/Anikethana)** + +- Updated Axios to 0.21.1. See by **[sseide](https://github.com/sseide)** +- Updated **[pollyjs](https://github.com/pollyjs)**/core **[pollyjs](https://github.com/pollyjs)**/adapter-puppeteer. See [#2760](https://github.com/codeceptjs/CodeceptJS/issues/2760) by **[Anikethana](https://github.com/Anikethana)** ## 3.0.4 -* **Hotfix** Fixed `init` script by adding `cross-spawn` package. By **[vipulgupta2048](https://github.com/vipulgupta2048)** -* Fixed handling error during initialization of `run-multiple`. See [#2730](https://github.com/codeceptjs/CodeceptJS/issues/2730) by **[wagoid](https://github.com/wagoid)** +- **Hotfix** Fixed `init` script by adding `cross-spawn` package. By **[vipulgupta2048](https://github.com/vipulgupta2048)** +- Fixed handling error during initialization of `run-multiple`. See [#2730](https://github.com/codeceptjs/CodeceptJS/issues/2730) by **[wagoid](https://github.com/wagoid)** ## 3.0.3 -* **Playwright 1.7 support** -* **[Playwright]** Fixed handling null context in click. See [#2667](https://github.com/codeceptjs/CodeceptJS/issues/2667) by **[matthewjf](https://github.com/matthewjf)** -* **[Playwright]** Fixed `Cannot read property '$$' of null` when locating elements. See [#2713](https://github.com/codeceptjs/CodeceptJS/issues/2713) by **[matthewjf](https://github.com/matthewjf)** -* Command `npx codeceptjs init` improved - * auto-installing required packages - * better error messages - * fixed generating type definitions -* Data Driven Tests improvements: instead of having one skipped test for data driven scenarios when using xData you get a skipped test for each entry in the data table. See [#2698](https://github.com/codeceptjs/CodeceptJS/issues/2698) by **[Georgegriff](https://github.com/Georgegriff)** -* **[Puppeteer]** Fixed that `waitForFunction` was not working with number values. See [#2703](https://github.com/codeceptjs/CodeceptJS/issues/2703) by **[MumblesNZ](https://github.com/MumblesNZ)** -* Enabled autocompletion for custom helpers. [#2695](https://github.com/codeceptjs/CodeceptJS/issues/2695) by **[PeterNgTr](https://github.com/PeterNgTr)** -* Emit test.after on workers. Fix [#2693](https://github.com/codeceptjs/CodeceptJS/issues/2693) by **[jccguimaraes](https://github.com/jccguimaraes)** -* TypeScript: Allow .ts config files. See [#2708](https://github.com/codeceptjs/CodeceptJS/issues/2708) by **[elukoyanov](https://github.com/elukoyanov)** -* Fixed definitions generation errors by **[elukoyanov](https://github.com/elukoyanov)**. See [#2707](https://github.com/codeceptjs/CodeceptJS/issues/2707) and [#2718](https://github.com/codeceptjs/CodeceptJS/issues/2718) -* Fixed handing error in _after function; for example, browser is closed during test and tests executions is stopped, but error was not logged. See [#2715](https://github.com/codeceptjs/CodeceptJS/issues/2715) by **[elukoyanov](https://github.com/elukoyanov)** -* Emit hook.failed in workers. Fix [#2723](https://github.com/codeceptjs/CodeceptJS/issues/2723) by **[jccguimaraes](https://github.com/jccguimaraes)** -* [wdio plugin] Added `seleniumArgs` and `seleniumInstallArgs` config options for plugin. See [#2687](https://github.com/codeceptjs/CodeceptJS/issues/2687) by **[andrerleao](https://github.com/andrerleao)** -* [allure plugin] Added `addParameter` method in [#2717](https://github.com/codeceptjs/CodeceptJS/issues/2717) by **[jancorvus](https://github.com/jancorvus)**. Fixes [#2716](https://github.com/codeceptjs/CodeceptJS/issues/2716) -* Added mocha-based `--reporter-options` and `--reporter ` commands to `run-workers` command by in [#2691](https://github.com/codeceptjs/CodeceptJS/issues/2691) **[Ameterezu](https://github.com/Ameterezu)** -* Fixed infinite loop for junit reports. See [#2691](https://github.com/codeceptjs/CodeceptJS/issues/2691) **[Ameterezu](https://github.com/Ameterezu)** -* Added status, start/end time, and match line for BDD steps. See [#2678](https://github.com/codeceptjs/CodeceptJS/issues/2678) by **[ktryniszewski-mdsol](https://github.com/ktryniszewski-mdsol)** -* [stepByStepReport plugin] Fixed "helper.saveScreenshot is not a function". Fix [#2688](https://github.com/codeceptjs/CodeceptJS/issues/2688) by **[andrerleao](https://github.com/andrerleao)** - - +- **Playwright 1.7 support** +- **[Playwright]** Fixed handling null context in click. See [#2667](https://github.com/codeceptjs/CodeceptJS/issues/2667) by **[matthewjf](https://github.com/matthewjf)** +- **[Playwright]** Fixed `Cannot read property '$$' of null` when locating elements. See [#2713](https://github.com/codeceptjs/CodeceptJS/issues/2713) by **[matthewjf](https://github.com/matthewjf)** +- Command `npx codeceptjs init` improved + - auto-installing required packages + - better error messages + - fixed generating type definitions +- Data Driven Tests improvements: instead of having one skipped test for data driven scenarios when using xData you get a skipped test for each entry in the data table. See [#2698](https://github.com/codeceptjs/CodeceptJS/issues/2698) by **[Georgegriff](https://github.com/Georgegriff)** +- **[Puppeteer]** Fixed that `waitForFunction` was not working with number values. See [#2703](https://github.com/codeceptjs/CodeceptJS/issues/2703) by **[MumblesNZ](https://github.com/MumblesNZ)** +- Enabled autocompletion for custom helpers. [#2695](https://github.com/codeceptjs/CodeceptJS/issues/2695) by **[PeterNgTr](https://github.com/PeterNgTr)** +- Emit test.after on workers. Fix [#2693](https://github.com/codeceptjs/CodeceptJS/issues/2693) by **[jccguimaraes](https://github.com/jccguimaraes)** +- TypeScript: Allow .ts config files. See [#2708](https://github.com/codeceptjs/CodeceptJS/issues/2708) by **[elukoyanov](https://github.com/elukoyanov)** +- Fixed definitions generation errors by **[elukoyanov](https://github.com/elukoyanov)**. See [#2707](https://github.com/codeceptjs/CodeceptJS/issues/2707) and [#2718](https://github.com/codeceptjs/CodeceptJS/issues/2718) +- Fixed handing error in \_after function; for example, browser is closed during test and tests executions is stopped, but error was not logged. See [#2715](https://github.com/codeceptjs/CodeceptJS/issues/2715) by **[elukoyanov](https://github.com/elukoyanov)** +- Emit hook.failed in workers. Fix [#2723](https://github.com/codeceptjs/CodeceptJS/issues/2723) by **[jccguimaraes](https://github.com/jccguimaraes)** +- [wdio plugin] Added `seleniumArgs` and `seleniumInstallArgs` config options for plugin. See [#2687](https://github.com/codeceptjs/CodeceptJS/issues/2687) by **[andrerleao](https://github.com/andrerleao)** +- [allure plugin] Added `addParameter` method in [#2717](https://github.com/codeceptjs/CodeceptJS/issues/2717) by **[jancorvus](https://github.com/jancorvus)**. Fixes [#2716](https://github.com/codeceptjs/CodeceptJS/issues/2716) +- Added mocha-based `--reporter-options` and `--reporter ` commands to `run-workers` command by in [#2691](https://github.com/codeceptjs/CodeceptJS/issues/2691) **[Ameterezu](https://github.com/Ameterezu)** +- Fixed infinite loop for junit reports. See [#2691](https://github.com/codeceptjs/CodeceptJS/issues/2691) **[Ameterezu](https://github.com/Ameterezu)** +- Added status, start/end time, and match line for BDD steps. See [#2678](https://github.com/codeceptjs/CodeceptJS/issues/2678) by **[ktryniszewski-mdsol](https://github.com/ktryniszewski-mdsol)** +- [stepByStepReport plugin] Fixed "helper.saveScreenshot is not a function". Fix [#2688](https://github.com/codeceptjs/CodeceptJS/issues/2688) by **[andrerleao](https://github.com/andrerleao)** ## 3.0.2 -* **[Playwright]** Fix connection close with remote browser. See [#2629](https://github.com/codeceptjs/CodeceptJS/issues/2629) by **[dipiash](https://github.com/dipiash)** -* **[REST]** set maxUploadFileSize when performing api calls. See [#2611](https://github.com/codeceptjs/CodeceptJS/issues/2611) by **[PeterNgTr](https://github.com/PeterNgTr)** -* Duplicate Scenario names (combined with Feature name) are now detected via a warning message. -Duplicate test names can cause `codeceptjs run-workers` to not function. See [#2656](https://github.com/codeceptjs/CodeceptJS/issues/2656) by **[Georgegriff](https://github.com/Georgegriff)** -* Documentation fixes +- **[Playwright]** Fix connection close with remote browser. See [#2629](https://github.com/codeceptjs/CodeceptJS/issues/2629) by **[dipiash](https://github.com/dipiash)** +- **[REST]** set maxUploadFileSize when performing api calls. See [#2611](https://github.com/codeceptjs/CodeceptJS/issues/2611) by **[PeterNgTr](https://github.com/PeterNgTr)** +- Duplicate Scenario names (combined with Feature name) are now detected via a warning message. + Duplicate test names can cause `codeceptjs run-workers` to not function. See [#2656](https://github.com/codeceptjs/CodeceptJS/issues/2656) by **[Georgegriff](https://github.com/Georgegriff)** +- Documentation fixes Bug Fixes: - * --suites flag now should function correctly for `codeceptjs run-workers`. See [#2655](https://github.com/codeceptjs/CodeceptJS/issues/2655) by **[Georgegriff](https://github.com/Georgegriff)** - * [autoLogin plugin] Login methods should now function as expected with `codeceptjs run-workers`. See [#2658](https://github.com/codeceptjs/CodeceptJS/issues/2658) by **[Georgegriff](https://github.com/Georgegriff)**, resolves [#2620](https://github.com/codeceptjs/CodeceptJS/issues/2620) - +- --suites flag now should function correctly for `codeceptjs run-workers`. See [#2655](https://github.com/codeceptjs/CodeceptJS/issues/2655) by **[Georgegriff](https://github.com/Georgegriff)** +- [autoLogin plugin] Login methods should now function as expected with `codeceptjs run-workers`. See [#2658](https://github.com/codeceptjs/CodeceptJS/issues/2658) by **[Georgegriff](https://github.com/Georgegriff)**, resolves [#2620](https://github.com/codeceptjs/CodeceptJS/issues/2620) ## 3.0.1 ♨ī¸ Hot fix: - * Lock the mocha version to avoid the errors. See [#2624](https://github.com/codeceptjs/CodeceptJS/issues/2624) by PeterNgTr + +- Lock the mocha version to avoid the errors. See [#2624](https://github.com/codeceptjs/CodeceptJS/issues/2624) by PeterNgTr 🐛 Bug Fix: - * Fixed error handling in Scenario.js. See [#2607](https://github.com/codeceptjs/CodeceptJS/issues/2607) by haveac1gar - * Changing type definition in order to allow the use of functions with any number of any arguments. See [#2616](https://github.com/codeceptjs/CodeceptJS/issues/2616) by akoltun -* Some updates/changes on documentations +- Fixed error handling in Scenario.js. See [#2607](https://github.com/codeceptjs/CodeceptJS/issues/2607) by haveac1gar +- Changing type definition in order to allow the use of functions with any number of any arguments. See [#2616](https://github.com/codeceptjs/CodeceptJS/issues/2616) by akoltun + +- Some updates/changes on documentations ## 3.0.0 -> [ 👌 **LEARN HOW TO UPGRADE TO CODECEPTJS 3 ➡**](https://bit.ly/codecept3Up) -* Playwright set to be a default engine. -* **NodeJS 12+ required** -* **BREAKING CHANGE:** Syntax for tests has changed. +> [ 👌 **LEARN HOW TO UPGRADE TO CODECEPTJS 3 ➡**](https://bit.ly/codecept3Up) +- Playwright set to be a default engine. +- **NodeJS 12+ required** +- **BREAKING CHANGE:** Syntax for tests has changed. ```js // Previous -Scenario('title', (I, loginPage) => {}); +Scenario('title', (I, loginPage) => {}) // Current -Scenario('title', ({ I, loginPage }) => {}); +Scenario('title', ({ I, loginPage }) => {}) ``` -* **BREAKING** Replaced bootstrap/teardown scripts to accept only functions or async functions. Async function with callback (with done parameter) should be replaced with async/await. [See our upgrade guide](https://bit.ly/codecept3Up). -* **[TypeScript guide](/typescript)** and [boilerplate project](https://github.com/codeceptjs/typescript-boilerplate) -* [tryTo](/plugins/#tryto) and [pauseOnFail](/plugins/#pauseOnFail) plugins installed by default -* Introduced one-line installer: +- **BREAKING** Replaced bootstrap/teardown scripts to accept only functions or async functions. Async function with callback (with done parameter) should be replaced with async/await. [See our upgrade guide](https://bit.ly/codecept3Up). +- **[TypeScript guide](/typescript)** and [boilerplate project](https://github.com/codeceptjs/typescript-boilerplate) +- [tryTo](/plugins/#tryto) and [pauseOnFail](/plugins/#pauseOnFail) plugins installed by default +- Introduced one-line installer: ``` npx create-codeceptjs . @@ -2243,50 +2748,50 @@ Read changelog to learn more about version 👇 ## 3.0.0-rc - - -* Moved [Helper class into its own package](https://github.com/codeceptjs/helper) to simplify publishing standalone helpers. -* Fixed typings for `I.say` and `I.retry` by **[Vorobeyko](https://github.com/Vorobeyko)** -* Updated documentation: - * [Quickstart](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/quickstart.md#quickstart) - * [Best Practices](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/best.md) - * [Custom Helpers](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/custom-helpers.md) - * [TypeScript](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/typescript.md) +- Moved [Helper class into its own package](https://github.com/codeceptjs/helper) to simplify publishing standalone helpers. +- Fixed typings for `I.say` and `I.retry` by **[Vorobeyko](https://github.com/Vorobeyko)** +- Updated documentation: + - [Quickstart](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/quickstart.md#quickstart) + - [Best Practices](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/best.md) + - [Custom Helpers](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/custom-helpers.md) + - [TypeScript](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/typescript.md) ## 3.0.0-beta.4 🐛 Bug Fix: - * PageObject was broken when using "this" inside a simple object. - * The typings for all WebDriver methods work correctly. - * The typings for "this.helper" and helper constructor work correctly, too. + +- PageObject was broken when using "this" inside a simple object. +- The typings for all WebDriver methods work correctly. +- The typings for "this.helper" and helper constructor work correctly, too. 🧤 Internal: - * Our TS Typings will be tested now! We strarted using [dtslint](https://github.com/microsoft/dtslint) to check all typings and all rules for linter. - Example: - ```ts - const psp = wd.grabPageScrollPosition() // $ExpectType Promise - psp.then( - result => { - result.x // $ExpectType number - result.y // $ExpectType number - } - ) - ``` - * And last: Reducing package size from 3.3Mb to 2.0Mb + +- Our TS Typings will be tested now! We strarted using [dtslint](https://github.com/microsoft/dtslint) to check all typings and all rules for linter. + Example: + +```ts +const psp = wd.grabPageScrollPosition() // $ExpectType Promise +psp.then(result => { + result.x // $ExpectType number + result.y // $ExpectType number +}) +``` + +- And last: Reducing package size from 3.3Mb to 2.0Mb ## 3.0.0-beta-3 -* **BREAKING** Replaced bootstrap/teardown scripts to accept only functions or async functions. Async function with callback (with done parameter) should be replaced with async/await. [See our upgrde guide](https://bit.ly/codecept3Up). -* Test artifacts introduced. Each test object has `artifacts` property, to keep attachment files. For instance, a screenshot of a failed test is attached to a test as artifact. -* Improved output for test execution - * Changed colors for steps output, simplified - * Added stack trace for test failures - * Removed `Event emitted` from log in `--verbose` mode - * List artifacts of a failed tests +- **BREAKING** Replaced bootstrap/teardown scripts to accept only functions or async functions. Async function with callback (with done parameter) should be replaced with async/await. [See our upgrde guide](https://bit.ly/codecept3Up). +- Test artifacts introduced. Each test object has `artifacts` property, to keep attachment files. For instance, a screenshot of a failed test is attached to a test as artifact. +- Improved output for test execution + - Changed colors for steps output, simplified + - Added stack trace for test failures + - Removed `Event emitted` from log in `--verbose` mode + - List artifacts of a failed tests ![](https://user-images.githubusercontent.com/220264/82160052-397bf800-989b-11ea-81c0-8e58b3d33525.png) -* Steps & metasteps refactored by **[Vorobeyko](https://github.com/Vorobeyko)**. Logs to arguments passed to page objects: +- Steps & metasteps refactored by **[Vorobeyko](https://github.com/Vorobeyko)**. Logs to arguments passed to page objects: ```js // TEST: @@ -2297,146 +2802,146 @@ MyPage: hasFile "First arg", "Second arg" I see file "codecept.js" I see file "codecept.po.json" ``` -* Introduced official [TypeScript boilerplate](https://github.com/codeceptjs/typescript-boilerplate). Started by **[Vorobeyko](https://github.com/Vorobeyko)**. -## 3.0.0-beta +- Introduced official [TypeScript boilerplate](https://github.com/codeceptjs/typescript-boilerplate). Started by **[Vorobeyko](https://github.com/Vorobeyko)**. +## 3.0.0-beta -* **NodeJS 12+ required** -* **BREAKING CHANGE:** Syntax for tests has changed. - +- **NodeJS 12+ required** +- **BREAKING CHANGE:** Syntax for tests has changed. ```js // Previous -Scenario('title', (I, loginPage) => {}); +Scenario('title', (I, loginPage) => {}) // Current -Scenario('title', ({ I, loginPage }) => {}); +Scenario('title', ({ I, loginPage }) => {}) ``` -* **BREAKING CHANGE:** [WebDriver][Protractor][Puppeteer][Playwright][Nightmare] `grab*` functions unified: - * `grab*From` => **returns single value** from element or throws error when no matchng elements found - * `grab*FromAll` => returns array of values, or empty array when no matching elements -* Public API for workers introduced by **[koushikmohan1996](https://github.com/koushikmohan1996)**. [Customize parallel execution](https://github.com/Codeception/CodeceptJS/blob/codeceptjs-v3.0/docs/parallel.md#custom-parallel-execution) with workers by building custom scripts. +- **BREAKING CHANGE:** [WebDriver][Protractor][Puppeteer][Playwright][Nightmare] `grab*` functions unified: + - `grab*From` => **returns single value** from element or throws error when no matchng elements found + - `grab*FromAll` => returns array of values, or empty array when no matching elements +- Public API for workers introduced by **[koushikmohan1996](https://github.com/koushikmohan1996)**. [Customize parallel execution](https://github.com/Codeception/CodeceptJS/blob/codeceptjs-v3.0/docs/parallel.md#custom-parallel-execution) with workers by building custom scripts. -* **[Playwright]** Added `usePlaywrightTo` method to access Playwright API in tests directly: +- **[Playwright]** Added `usePlaywrightTo` method to access Playwright API in tests directly: ```js I.usePlaywrightTo('do something special', async ({ page }) => { // use page or browser objects here -}); +}) ``` -* **[Puppeteer]** Introduced `usePuppeteerTo` method to access Puppeteer API: +- **[Puppeteer]** Introduced `usePuppeteerTo` method to access Puppeteer API: ```js I.usePuppeteerTo('do something special', async ({ page, browser }) => { // use page or browser objects here -}); +}) ``` -* **[WebDriver]** Introduced `useWebDriverTo` method to access webdriverio API: +- **[WebDriver]** Introduced `useWebDriverTo` method to access webdriverio API: ```js I.useWebDriverTo('do something special', async ({ browser }) => { // use browser object here -}); +}) ``` -* **[Protractor]** Introduced `useProtractorTo` method to access protractor API -* `tryTo` plugin introduced. Allows conditional action execution: +- **[Protractor]** Introduced `useProtractorTo` method to access protractor API +- `tryTo` plugin introduced. Allows conditional action execution: ```js const isSeen = await tryTo(() => { - I.see('Some text'); -}); + I.see('Some text') +}) // we are not sure if cookie bar is displayed, but if so - accept cookies -tryTo(() => I.click('Accept', '.cookies')); +tryTo(() => I.click('Accept', '.cookies')) ``` -* **Possible breaking change** In semantic locators `[` char indicates CSS selector. +- **Possible breaking change** In semantic locators `[` char indicates CSS selector. + ## 2.6.11 -* **[Playwright]** Playwright 1.4 compatibility -* **[Playwright]** Added `ignoreHTTPSErrors` config option (default: false). See [#2566](https://github.com/codeceptjs/CodeceptJS/issues/2566) by gurjeetbains -* Added French translation by **[vimar](https://github.com/vimar)** -* **[WebDriver]** Updated `dragSlider` to work in WebDriver W3C protocol. Fixes [#2557](https://github.com/codeceptjs/CodeceptJS/issues/2557) by suniljaiswal01 +- **[Playwright]** Playwright 1.4 compatibility +- **[Playwright]** Added `ignoreHTTPSErrors` config option (default: false). See [#2566](https://github.com/codeceptjs/CodeceptJS/issues/2566) by gurjeetbains +- Added French translation by **[vimar](https://github.com/vimar)** +- **[WebDriver]** Updated `dragSlider` to work in WebDriver W3C protocol. Fixes [#2557](https://github.com/codeceptjs/CodeceptJS/issues/2557) by suniljaiswal01 ## 2.6.10 -* Fixed saving options for suite via `Feature('title', {key: value})` by **[Diokuz](https://github.com/Diokuz)**. See [#2553](https://github.com/codeceptjs/CodeceptJS/issues/2553) and [Docs](https://codecept.io/advanced/#dynamic-configuration) +- Fixed saving options for suite via `Feature('title', {key: value})` by **[Diokuz](https://github.com/Diokuz)**. See [#2553](https://github.com/codeceptjs/CodeceptJS/issues/2553) and [Docs](https://codecept.io/advanced/#dynamic-configuration) ## 2.6.9 -* [Puppeteer][Playwright] SessionStorage is now cleared in after hook. See [#2524](https://github.com/codeceptjs/CodeceptJS/issues/2524) -* When helper load failed the error stack is now logged by **[SkReD](https://github.com/SkReD)**. See [#2541](https://github.com/codeceptjs/CodeceptJS/issues/2541) -* Small documentation fixes. +- [Puppeteer][Playwright] SessionStorage is now cleared in after hook. See [#2524](https://github.com/codeceptjs/CodeceptJS/issues/2524) +- When helper load failed the error stack is now logged by **[SkReD](https://github.com/SkReD)**. See [#2541](https://github.com/codeceptjs/CodeceptJS/issues/2541) +- Small documentation fixes. ## 2.6.8 -* [WebDriver][Protractor][Playwright][Puppeteer][Nightmare] `saveElementScreenshot` method added to make screenshot of an element. By **[suniljaiswal01](https://github.com/suniljaiswal01)** -* [Playwright][Puppeteer] Added `type` method to type a text using keyboard with an optional delay. -* **[WebDriver]** Added optional `delay` argument to `type` method to slow down typing. -* **[Puppeteer]** Fixed `amOnPage` freeze when `getPageTimeout` is 0"; set 30 sec as default timeout by **[Vorobeyko](https://github.com/Vorobeyko)**. -* Fixed printing step with null argument in custom helper by **[sjana-aj](https://github.com/sjana-aj)**. See [#2494](https://github.com/codeceptjs/CodeceptJS/issues/2494) -* Fix missing screenshot on failure when REST helper is in use [#2513](https://github.com/codeceptjs/CodeceptJS/issues/2513) by **[PeterNgTr](https://github.com/PeterNgTr)** -* Improve error logging in the `screenshotOnFail` plugin [#2512](https://github.com/codeceptjs/CodeceptJS/issues/2512) by **[pablopaul](https://github.com/pablopaul)** +- [WebDriver][Protractor][Playwright][Puppeteer][Nightmare] `saveElementScreenshot` method added to make screenshot of an element. By **[suniljaiswal01](https://github.com/suniljaiswal01)** +- [Playwright][Puppeteer] Added `type` method to type a text using keyboard with an optional delay. +- **[WebDriver]** Added optional `delay` argument to `type` method to slow down typing. +- **[Puppeteer]** Fixed `amOnPage` freeze when `getPageTimeout` is 0"; set 30 sec as default timeout by **[Vorobeyko](https://github.com/Vorobeyko)**. +- Fixed printing step with null argument in custom helper by **[sjana-aj](https://github.com/sjana-aj)**. See [#2494](https://github.com/codeceptjs/CodeceptJS/issues/2494) +- Fix missing screenshot on failure when REST helper is in use [#2513](https://github.com/codeceptjs/CodeceptJS/issues/2513) by **[PeterNgTr](https://github.com/PeterNgTr)** +- Improve error logging in the `screenshotOnFail` plugin [#2512](https://github.com/codeceptjs/CodeceptJS/issues/2512) by **[pablopaul](https://github.com/pablopaul)** ## 2.6.7 -* Add REST helper into `standardActingHelpers` array [#2474](https://github.com/codeceptjs/CodeceptJS/issues/2474) by **[PeterNgTr](https://github.com/PeterNgTr)** -* Add missing `--invert` option for `run-workers` command [#2504](https://github.com/codeceptjs/CodeceptJS/issues/2504) by **[pablopaul](https://github.com/pablopaul)** -* **[WebDriver]** Introduce `forceRightClick` method [#2485](https://github.com/codeceptjs/CodeceptJS/issues/2485) bylsuniljaiswal01 -* **[Playwright]** Fix `setCookie` method [#2491](https://github.com/codeceptjs/CodeceptJS/issues/2491) by **[bmbarker90](https://github.com/bmbarker90)** -* **[TypeScript]** Update compilerOptions.target to es2017 [#2483](https://github.com/codeceptjs/CodeceptJS/issues/2483) by **[shanplourde](https://github.com/shanplourde)** -* **[Mocha]** Honor reporter configuration [#2465](https://github.com/codeceptjs/CodeceptJS/issues/2465) by **[trinhpham](https://github.com/trinhpham)** +- Add REST helper into `standardActingHelpers` array [#2474](https://github.com/codeceptjs/CodeceptJS/issues/2474) by **[PeterNgTr](https://github.com/PeterNgTr)** +- Add missing `--invert` option for `run-workers` command [#2504](https://github.com/codeceptjs/CodeceptJS/issues/2504) by **[pablopaul](https://github.com/pablopaul)** +- **[WebDriver]** Introduce `forceRightClick` method [#2485](https://github.com/codeceptjs/CodeceptJS/issues/2485) bylsuniljaiswal01 +- **[Playwright]** Fix `setCookie` method [#2491](https://github.com/codeceptjs/CodeceptJS/issues/2491) by **[bmbarker90](https://github.com/bmbarker90)** +- **[TypeScript]** Update compilerOptions.target to es2017 [#2483](https://github.com/codeceptjs/CodeceptJS/issues/2483) by **[shanplourde](https://github.com/shanplourde)** +- **[Mocha]** Honor reporter configuration [#2465](https://github.com/codeceptjs/CodeceptJS/issues/2465) by **[trinhpham](https://github.com/trinhpham)** ## 2.6.6 -* Puppeteer 4.0 support. Important: MockRequest helper won't work with Puppeter > 3.3 -* Added `xFeature` and `Feature.skip` to skip all tests in a suite. By **[Georgegriff](https://github.com/Georgegriff)** -* **[Appium]** Fixed [#2428](https://github.com/codeceptjs/CodeceptJS/issues/2428) Android native locator support by **[idxn](https://github.com/idxn)** -* **[WebDriver]** Fixed `waitNumberOfVisibleElements` to actually filter visible elements. By **[ilangv](https://github.com/ilangv)** -* **[Puppeteer]** Fixed handling error which is not an Error object. Fixes `cannot read property indexOf of undefined` error. Fix [#2436](https://github.com/codeceptjs/CodeceptJS/issues/2436) by **[Georgegriff](https://github.com/Georgegriff)** -* **[Puppeteer]** Print error on page crash by **[Georgegriff](https://github.com/Georgegriff)** +- Puppeteer 4.0 support. Important: MockRequest helper won't work with Puppeter > 3.3 +- Added `xFeature` and `Feature.skip` to skip all tests in a suite. By **[Georgegriff](https://github.com/Georgegriff)** +- **[Appium]** Fixed [#2428](https://github.com/codeceptjs/CodeceptJS/issues/2428) Android native locator support by **[idxn](https://github.com/idxn)** +- **[WebDriver]** Fixed `waitNumberOfVisibleElements` to actually filter visible elements. By **[ilangv](https://github.com/ilangv)** +- **[Puppeteer]** Fixed handling error which is not an Error object. Fixes `cannot read property indexOf of undefined` error. Fix [#2436](https://github.com/codeceptjs/CodeceptJS/issues/2436) by **[Georgegriff](https://github.com/Georgegriff)** +- **[Puppeteer]** Print error on page crash by **[Georgegriff](https://github.com/Georgegriff)** ## 2.6.5 -* Added `test.skipped` event to run-workers, fixing allure reports with skipped tests in workers [#2391](https://github.com/codeceptjs/CodeceptJS/issues/2391). Fix [#2387](https://github.com/codeceptjs/CodeceptJS/issues/2387) by **[koushikmohan1996](https://github.com/koushikmohan1996)** -* **[Playwright]** Fixed calling `waitFor*` methods with custom locators [#2314](https://github.com/codeceptjs/CodeceptJS/issues/2314). Fix [#2389](https://github.com/codeceptjs/CodeceptJS/issues/2389) by **[Georgegriff](https://github.com/Georgegriff)** +- Added `test.skipped` event to run-workers, fixing allure reports with skipped tests in workers [#2391](https://github.com/codeceptjs/CodeceptJS/issues/2391). Fix [#2387](https://github.com/codeceptjs/CodeceptJS/issues/2387) by **[koushikmohan1996](https://github.com/koushikmohan1996)** +- **[Playwright]** Fixed calling `waitFor*` methods with custom locators [#2314](https://github.com/codeceptjs/CodeceptJS/issues/2314). Fix [#2389](https://github.com/codeceptjs/CodeceptJS/issues/2389) by **[Georgegriff](https://github.com/Georgegriff)** ## 2.6.4 -* **[Playwright]** **Playwright 1.0 support** by **[Georgegriff](https://github.com/Georgegriff)**. +- **[Playwright]** **Playwright 1.0 support** by **[Georgegriff](https://github.com/Georgegriff)**. ## 2.6.3 -* [stepByStepReport plugin] Fixed when using plugin with BeforeSuite. Fixes [#2337](https://github.com/codeceptjs/CodeceptJS/issues/2337) by **[mirao](https://github.com/mirao)** -* [allure plugin] Fixed reporting of tests skipped by failure in before hook. Refer to [#2349](https://github.com/codeceptjs/CodeceptJS/issues/2349) & [#2354](https://github.com/codeceptjs/CodeceptJS/issues/2354). Fix by **[koushikmohan1996](https://github.com/koushikmohan1996)** +- [stepByStepReport plugin] Fixed when using plugin with BeforeSuite. Fixes [#2337](https://github.com/codeceptjs/CodeceptJS/issues/2337) by **[mirao](https://github.com/mirao)** +- [allure plugin] Fixed reporting of tests skipped by failure in before hook. Refer to [#2349](https://github.com/codeceptjs/CodeceptJS/issues/2349) & [#2354](https://github.com/codeceptjs/CodeceptJS/issues/2354). Fix by **[koushikmohan1996](https://github.com/koushikmohan1996)** ## 2.6.2 -* [WebDriver][Puppeteer] Added `forceClick` method to emulate click event instead of using native events. -* **[Playwright]** Updated to 0.14 -* **[Puppeteer]** Updated to Puppeteer v3.0 -* **[wdio]** Fixed undefined output directory for wdio plugns. Fix By **[PeterNgTr](https://github.com/PeterNgTr)** -* **[Playwright]** Introduced `handleDownloads` method to download file. Please note, this method has slightly different API than the same one in Puppeteer. -* **[allure]** Fixed undefined output directory for allure plugin on using custom runner. Fix by **[charliepradeep](https://github.com/charliepradeep)** -* **[WebDriver]** Fixed `waitForEnabled` fix for webdriver 6. Fix by **[dsharapkou](https://github.com/dsharapkou)** -* Workers: Fixed negative failure result if use scenario with the same names. Fix by **[Vorobeyko](https://github.com/Vorobeyko)** -* **[MockRequest]** Updated documentation to match new helper version -* Fixed: skipped tests are not reported if a suite failed in `before`. Refer [#2349](https://github.com/codeceptjs/CodeceptJS/issues/2349) & [#2354](https://github.com/codeceptjs/CodeceptJS/issues/2354). Fix by **[koushikmohan1996](https://github.com/koushikmohan1996)** +- [WebDriver][Puppeteer] Added `forceClick` method to emulate click event instead of using native events. +- **[Playwright]** Updated to 0.14 +- **[Puppeteer]** Updated to Puppeteer v3.0 +- **[wdio]** Fixed undefined output directory for wdio plugns. Fix By **[PeterNgTr](https://github.com/PeterNgTr)** +- **[Playwright]** Introduced `handleDownloads` method to download file. Please note, this method has slightly different API than the same one in Puppeteer. +- **[allure]** Fixed undefined output directory for allure plugin on using custom runner. Fix by **[charliepradeep](https://github.com/charliepradeep)** +- **[WebDriver]** Fixed `waitForEnabled` fix for webdriver 6. Fix by **[dsharapkou](https://github.com/dsharapkou)** +- Workers: Fixed negative failure result if use scenario with the same names. Fix by **[Vorobeyko](https://github.com/Vorobeyko)** +- **[MockRequest]** Updated documentation to match new helper version +- Fixed: skipped tests are not reported if a suite failed in `before`. Refer [#2349](https://github.com/codeceptjs/CodeceptJS/issues/2349) & [#2354](https://github.com/codeceptjs/CodeceptJS/issues/2354). Fix by **[koushikmohan1996](https://github.com/koushikmohan1996)** ## 2.6.1 -* [screenshotOnFail plugin] Fixed saving screenshot of active session. -* [screenshotOnFail plugin] Fix issue [#2301](https://github.com/codeceptjs/CodeceptJS/issues/2301) when having the flag `uniqueScreenshotNames`=true results in `undefined` in screenshot file name by **[PeterNgTr](https://github.com/PeterNgTr)** -* **[WebDriver]** Fixed `waitForElement` not applying the optional second argument to override the default timeout in webdriverio 6. Fix by **[Mooksc](https://github.com/Mooksc)** -* **[WebDriver]** Updated `waitUntil` method which is used by all of the wait* functions. This updates the `waitForElement` by the same convention used to update `waitForVisible` and `waitInUrl` to be compatible with both WebDriverIO v5 & v6. See [#2313](https://github.com/codeceptjs/CodeceptJS/issues/2313) by **[Mooksc](https://github.com/Mooksc)** +- [screenshotOnFail plugin] Fixed saving screenshot of active session. +- [screenshotOnFail plugin] Fix issue [#2301](https://github.com/codeceptjs/CodeceptJS/issues/2301) when having the flag `uniqueScreenshotNames`=true results in `undefined` in screenshot file name by **[PeterNgTr](https://github.com/PeterNgTr)** +- **[WebDriver]** Fixed `waitForElement` not applying the optional second argument to override the default timeout in webdriverio 6. Fix by **[Mooksc](https://github.com/Mooksc)** +- **[WebDriver]** Updated `waitUntil` method which is used by all of the wait\* functions. This updates the `waitForElement` by the same convention used to update `waitForVisible` and `waitInUrl` to be compatible with both WebDriverIO v5 & v6. See [#2313](https://github.com/codeceptjs/CodeceptJS/issues/2313) by **[Mooksc](https://github.com/Mooksc)** ## 2.6.0 -* **[Playwright] Updated to Playwright 0.12** by **[Georgegriff](https://github.com/Georgegriff)**. +- **[Playwright] Updated to Playwright 0.12** by **[Georgegriff](https://github.com/Georgegriff)**. Upgrade playwright to ^0.12: @@ -2445,22 +2950,25 @@ npm i playwright@^0.12 --save ``` [Notable changes](https://github.com/microsoft/playwright/releases/tag/v0.12.0): - * Fixed opening two browsers on start - * `executeScript` - passed function now accepts only one argument. Pass in objects or arrays if you need multtple arguments: + +- Fixed opening two browsers on start +- `executeScript` - passed function now accepts only one argument. Pass in objects or arrays if you need multtple arguments: + ```js // Old style, does not work anymore: -I.executeScript((x, y) => x + y, x, y); +I.executeScript((x, y) => x + y, x, y) // New style, passing an object: -I.executeScript(({x, y}) => x + y, {x, y}); +I.executeScript(({ x, y }) => x + y, { x, y }) ``` - * `click` - automatically waits for element to become clickable (visible, not animated) and waits for navigation. - * `clickLink` - deprecated - * `waitForClickable` - deprecated - * `forceClick` - added - * Added support for custom locators. See [#2277](https://github.com/codeceptjs/CodeceptJS/issues/2277) - * Introduced [device emulation](/playwright/#device-emulation): - * globally via `emulate` config option - * per session + +- `click` - automatically waits for element to become clickable (visible, not animated) and waits for navigation. +- `clickLink` - deprecated +- `waitForClickable` - deprecated +- `forceClick` - added +- Added support for custom locators. See [#2277](https://github.com/codeceptjs/CodeceptJS/issues/2277) +- Introduced [device emulation](/playwright/#device-emulation): + - globally via `emulate` config option + - per session **[WebDriver] Updated to webdriverio v6** by **[PeterNgTr](https://github.com/PeterNgTr)**. @@ -2470,27 +2978,28 @@ upgrade webdriverio to ^6.0: ``` npm i webdriverio@^6.0 --save ``` -*(webdriverio v5 support is deprecated and will be removed in CodeceptJS 3.0)* - **[WebDriver]** Introduced [Shadow DOM support](/shadow) by **[gkushang](https://github.com/gkushang)** + +_(webdriverio v5 support is deprecated and will be removed in CodeceptJS 3.0)_ +**[WebDriver]** Introduced [Shadow DOM support](/shadow) by **[gkushang](https://github.com/gkushang)** ```js -I.click({ shadow: ['my-app', 'recipe-hello', 'button'] }); +I.click({ shadow: ['my-app', 'recipe-hello', 'button'] }) ``` -* **Fixed parallel execution of `run-workers` for Gherkin** scenarios by **[koushikmohan1996](https://github.com/koushikmohan1996)** -* **[MockRequest]** Updated and **moved to [standalone package](https://github.com/codeceptjs/mock-request)**: - * full support for record/replay mode for Puppeteer - * added `mockServer` method to use flexible PollyJS API to define mocks - * fixed stale browser screen in record mode. -* **[Playwright]** Added support on for `screenshotOnFail` plugin by **[amonkc](https://github.com/amonkc)** -* Gherkin improvement: setting different tags per examples. See [#2208](https://github.com/codeceptjs/CodeceptJS/issues/2208) by **[acuper](https://github.com/acuper)** -* **[TestCafe]** Updated `click` to take first visible element. Fixes [#2226](https://github.com/codeceptjs/CodeceptJS/issues/2226) by **[theTainted](https://github.com/theTainted)** -* [Puppeteer][WebDriver] Updated `waitForClickable` method to check for element overlapping. See [#2261](https://github.com/codeceptjs/CodeceptJS/issues/2261) by **[PiQx](https://github.com/PiQx)** -* **[Puppeteer]** Dropped `puppeteer-firefox` support, as Puppeteer supports Firefox natively. -* **[REST]** Rrespect Content-Type header. See [#2262](https://github.com/codeceptjs/CodeceptJS/issues/2262) by **[pmarshall-legacy](https://github.com/pmarshall-legacy)** -* [allure plugin] Fixes BeforeSuite failures in allure reports. See [#2248](https://github.com/codeceptjs/CodeceptJS/issues/2248) by **[Georgegriff](https://github.com/Georgegriff)** -* [WebDriver][Puppeteer][Playwright] A screenshot of for an active session is saved in multi-session mode. See [#2253](https://github.com/codeceptjs/CodeceptJS/issues/2253) by **[ChexWarrior](https://github.com/ChexWarrior)** -* Fixed `--profile` option by **[pablopaul](https://github.com/pablopaul)**. Profile value to be passed into `run-multiple` and `run-workers`: +- **Fixed parallel execution of `run-workers` for Gherkin** scenarios by **[koushikmohan1996](https://github.com/koushikmohan1996)** +- **[MockRequest]** Updated and **moved to [standalone package](https://github.com/codeceptjs/mock-request)**: + - full support for record/replay mode for Puppeteer + - added `mockServer` method to use flexible PollyJS API to define mocks + - fixed stale browser screen in record mode. +- **[Playwright]** Added support on for `screenshotOnFail` plugin by **[amonkc](https://github.com/amonkc)** +- Gherkin improvement: setting different tags per examples. See [#2208](https://github.com/codeceptjs/CodeceptJS/issues/2208) by **[acuper](https://github.com/acuper)** +- **[TestCafe]** Updated `click` to take first visible element. Fixes [#2226](https://github.com/codeceptjs/CodeceptJS/issues/2226) by **[theTainted](https://github.com/theTainted)** +- [Puppeteer][WebDriver] Updated `waitForClickable` method to check for element overlapping. See [#2261](https://github.com/codeceptjs/CodeceptJS/issues/2261) by **[PiQx](https://github.com/PiQx)** +- **[Puppeteer]** Dropped `puppeteer-firefox` support, as Puppeteer supports Firefox natively. +- **[REST]** Rrespect Content-Type header. See [#2262](https://github.com/codeceptjs/CodeceptJS/issues/2262) by **[pmarshall-legacy](https://github.com/pmarshall-legacy)** +- [allure plugin] Fixes BeforeSuite failures in allure reports. See [#2248](https://github.com/codeceptjs/CodeceptJS/issues/2248) by **[Georgegriff](https://github.com/Georgegriff)** +- [WebDriver][Puppeteer][Playwright] A screenshot of for an active session is saved in multi-session mode. See [#2253](https://github.com/codeceptjs/CodeceptJS/issues/2253) by **[ChexWarrior](https://github.com/ChexWarrior)** +- Fixed `--profile` option by **[pablopaul](https://github.com/pablopaul)**. Profile value to be passed into `run-multiple` and `run-workers`: ``` npx codecept run-workers 2 --profile firefox @@ -2498,128 +3007,128 @@ npx codecept run-workers 2 --profile firefox Value is available at `process.env.profile` (previously `process.profile`). See [#2302](https://github.com/codeceptjs/CodeceptJS/issues/2302). Fixes [#1968](https://github.com/codeceptjs/CodeceptJS/issues/1968) [#1315](https://github.com/codeceptjs/CodeceptJS/issues/1315) -* [commentStep Plugin introduced](/plugins#commentstep). Allows to annotate logical parts of a test: +- [commentStep Plugin introduced](/plugins#commentstep). Allows to annotate logical parts of a test: ```js -__`Given`; +__`Given` I.amOnPage('/profile') -__`When`; -I.click('Logout'); +__`When` +I.click('Logout') -__`Then`; -I.see('You are logged out'); +__`Then` +I.see('You are logged out') ``` ## 2.5.0 -* **Experimental: [Playwright](/playwright) helper introduced**. +- **Experimental: [Playwright](/playwright) helper introduced**. > [Playwright](https://github.com/microsoft/playwright/) is an alternative to Puppeteer which works very similarly to it but adds cross-browser support with Firefox and Webkit. Until v1.0 Playwright API is not stable but we introduce it to CodeceptJS so you could try it. -* **[Puppeteer]** Fixed basic auth support when running in multiple sessions. See [#2178](https://github.com/codeceptjs/CodeceptJS/issues/2178) by **[ian-bartholomew](https://github.com/ian-bartholomew)** -* **[Puppeteer]** Fixed `waitForText` when there is no `body` element on page (redirect). See [#2181](https://github.com/codeceptjs/CodeceptJS/issues/2181) by **[Vorobeyko](https://github.com/Vorobeyko)** -* [Selenoid plugin] Fixed overriding current capabilities by adding deepMerge. Fixes [#2183](https://github.com/codeceptjs/CodeceptJS/issues/2183) by **[koushikmohan1996](https://github.com/koushikmohan1996)** -* Added types for `Scenario.todo` by **[Vorobeyko](https://github.com/Vorobeyko)** -* Added types for Mocha by **[Vorobeyko](https://github.com/Vorobeyko)**. Fixed typing conflicts with Jest -* **[FileSystem]** Added methods by **[nitschSB](https://github.com/nitschSB)** - * `waitForFile` - * `seeFileContentsEqualReferenceFile` -* Added `--colors` option to `run` and `run-multiple` so you force colored output in dockerized environment. See [#2189](https://github.com/codeceptjs/CodeceptJS/issues/2189) by **[mirao](https://github.com/mirao)** -* **[WebDriver]** Added `type` command to enter value without focusing on a field. See [#2198](https://github.com/codeceptjs/CodeceptJS/issues/2198) by **[xMutaGenx](https://github.com/xMutaGenx)** -* Fixed `codeceptjs gt` command to respect config pattern for tests. See [#2200](https://github.com/codeceptjs/CodeceptJS/issues/2200) and [#2204](https://github.com/codeceptjs/CodeceptJS/issues/2204) by **[matheo](https://github.com/matheo)** - +- **[Puppeteer]** Fixed basic auth support when running in multiple sessions. See [#2178](https://github.com/codeceptjs/CodeceptJS/issues/2178) by **[ian-bartholomew](https://github.com/ian-bartholomew)** +- **[Puppeteer]** Fixed `waitForText` when there is no `body` element on page (redirect). See [#2181](https://github.com/codeceptjs/CodeceptJS/issues/2181) by **[Vorobeyko](https://github.com/Vorobeyko)** +- [Selenoid plugin] Fixed overriding current capabilities by adding deepMerge. Fixes [#2183](https://github.com/codeceptjs/CodeceptJS/issues/2183) by **[koushikmohan1996](https://github.com/koushikmohan1996)** +- Added types for `Scenario.todo` by **[Vorobeyko](https://github.com/Vorobeyko)** +- Added types for Mocha by **[Vorobeyko](https://github.com/Vorobeyko)**. Fixed typing conflicts with Jest +- **[FileSystem]** Added methods by **[nitschSB](https://github.com/nitschSB)** + - `waitForFile` + - `seeFileContentsEqualReferenceFile` +- Added `--colors` option to `run` and `run-multiple` so you force colored output in dockerized environment. See [#2189](https://github.com/codeceptjs/CodeceptJS/issues/2189) by **[mirao](https://github.com/mirao)** +- **[WebDriver]** Added `type` command to enter value without focusing on a field. See [#2198](https://github.com/codeceptjs/CodeceptJS/issues/2198) by **[xMutaGenx](https://github.com/xMutaGenx)** +- Fixed `codeceptjs gt` command to respect config pattern for tests. See [#2200](https://github.com/codeceptjs/CodeceptJS/issues/2200) and [#2204](https://github.com/codeceptjs/CodeceptJS/issues/2204) by **[matheo](https://github.com/matheo)** ## 2.4.3 -* Hotfix for interactive pause +- Hotfix for interactive pause ## 2.4.2 -* **Interactive pause improvements** by **[koushikmohan1996](https://github.com/koushikmohan1996)** - * allows using in page objects and variables: `pause({ loginPage, a })` - * enables custom commands inside pause with `=>` prefix: `=> loginPage.open()` -* [Selenoid plugin](/plugins#selenoid) added by by **[koushikmohan1996](https://github.com/koushikmohan1996)** - * uses Selenoid to launch browsers inside Docker containers - * automatically **records videos** and attaches them to allure reports - * can delete videos for successful tests - * can automatically pull in and start Selenoid containers - * works with WebDriver helper -* Avoid failiure report on successful retry in worker by **[koushikmohan1996](https://github.com/koushikmohan1996)** -* Added translation ability to Scenario, Feature and other context methods by **[koushikmohan1996](https://github.com/koushikmohan1996)** - * đŸ“ĸ Please help us translate context methods to your language! See [italian translation](https://github.com/codeceptjs/CodeceptJS/blob/master/translations/it-IT.js#L3) as an example and send [patches to vocabularies](https://github.com/codeceptjs/CodeceptJS/tree/master/translations). -* allurePlugin: Added `say` comments to allure reports by **[PeterNgTr](https://github.com/PeterNgTr)**. -* Fixed no custom output folder created when executed with run-worker. Fix by **[PeterNgTr](https://github.com/PeterNgTr)** -* **[Puppeteer]** Fixed error description for context element not found. See [#2065](https://github.com/codeceptjs/CodeceptJS/issues/2065). Fix by **[PeterNgTr](https://github.com/PeterNgTr)** -* **[WebDriver]** Fixed `waitForClickable` to wait for exact number of seconds by **[mirao](https://github.com/mirao)**. Resolves [#2166](https://github.com/codeceptjs/CodeceptJS/issues/2166) -* Fixed setting `compilerOptions` in `jsconfig.json` file on init by **[PeterNgTr](https://github.com/PeterNgTr)** -* **[Filesystem]** Added method by **[nitschSB](https://github.com/nitschSB)** - * `seeFileContentsEqualReferenceFile` - * `waitForFile` - +- **Interactive pause improvements** by **[koushikmohan1996](https://github.com/koushikmohan1996)** + - allows using in page objects and variables: `pause({ loginPage, a })` + - enables custom commands inside pause with `=>` prefix: `=> loginPage.open()` +- [Selenoid plugin](/plugins#selenoid) added by by **[koushikmohan1996](https://github.com/koushikmohan1996)** + - uses Selenoid to launch browsers inside Docker containers + - automatically **records videos** and attaches them to allure reports + - can delete videos for successful tests + - can automatically pull in and start Selenoid containers + - works with WebDriver helper +- Avoid failiure report on successful retry in worker by **[koushikmohan1996](https://github.com/koushikmohan1996)** +- Added translation ability to Scenario, Feature and other context methods by **[koushikmohan1996](https://github.com/koushikmohan1996)** + - đŸ“ĸ Please help us translate context methods to your language! See [italian translation](https://github.com/codeceptjs/CodeceptJS/blob/master/translations/it-IT.js#L3) as an example and send [patches to vocabularies](https://github.com/codeceptjs/CodeceptJS/tree/master/translations). +- allurePlugin: Added `say` comments to allure reports by **[PeterNgTr](https://github.com/PeterNgTr)**. +- Fixed no custom output folder created when executed with run-worker. Fix by **[PeterNgTr](https://github.com/PeterNgTr)** +- **[Puppeteer]** Fixed error description for context element not found. See [#2065](https://github.com/codeceptjs/CodeceptJS/issues/2065). Fix by **[PeterNgTr](https://github.com/PeterNgTr)** +- **[WebDriver]** Fixed `waitForClickable` to wait for exact number of seconds by **[mirao](https://github.com/mirao)**. Resolves [#2166](https://github.com/codeceptjs/CodeceptJS/issues/2166) +- Fixed setting `compilerOptions` in `jsconfig.json` file on init by **[PeterNgTr](https://github.com/PeterNgTr)** +- **[Filesystem]** Added method by **[nitschSB](https://github.com/nitschSB)** + - `seeFileContentsEqualReferenceFile` + - `waitForFile` ## 2.4.1 -* **[Hotfix]** - Add missing lib that prevents codeceptjs from initializing. +- **[Hotfix]** - Add missing lib that prevents codeceptjs from initializing. ## 2.4.0 -* Improved setup wizard with `npx codecept init`: - * **enabled [retryFailedStep](/plugins/#retryfailedstep) plugin for new setups**. - * enabled [@codeceptjs/configure](/configuration/#common-configuration-patterns) to toggle headless/window mode via env variable - * creates a new test on init - * removed question on "steps file", create it by default. -* Added [pauseOnFail plugin](/plugins/#pauseonfail). *Sponsored by Paul Vincent Beigang and his book "[Practical End 2 End Testing with CodeceptJS](https://leanpub.com/codeceptjs/)"*. -* Added [`run-rerun` command](/commands/#run-rerun) to run tests multiple times to detect and fix flaky tests. By **[Ilrilan](https://github.com/Ilrilan)** and **[Vorobeyko](https://github.com/Vorobeyko)**. -* Added [`Scenario.todo()` to declare tests as pending](/basics#todotest). See [#2100](https://github.com/codeceptjs/CodeceptJS/issues/2100) by **[Vorobeyko](https://github.com/Vorobeyko)** -* Added support for absolute path for `output` dir. See [#2049](https://github.com/codeceptjs/CodeceptJS/issues/2049) by **[elukoyanov](https://github.com/elukoyanov)** -* Fixed error in `npx codecept init` caused by calling `console.print`. See [#2071](https://github.com/codeceptjs/CodeceptJS/issues/2071) by **[Atinux](https://github.com/Atinux)**. -* **[Filesystem]** Methods added by **[aefluke](https://github.com/aefluke)**: - * `seeFileNameMatching` - * `grabFileNames` -* **[Puppeteer]** Fixed grabbing attributes with hyphen by **[Holorium](https://github.com/Holorium)** -* **[TestCafe]** Fixed `grabAttributeFrom` method by **[elukoyanov](https://github.com/elukoyanov)** -* **[MockRequest]** Added support for [Polly config options](https://netflix.github.io/pollyjs/#/configuration?id=configuration) by **[ecrmnn](https://github.com/ecrmnn)** -* **[TestCafe]** Fixes exiting with zero code on failure. Fixed [#2090](https://github.com/codeceptjs/CodeceptJS/issues/2090) with [#2106](https://github.com/codeceptjs/CodeceptJS/issues/2106) by **[koushikmohan1996](https://github.com/koushikmohan1996)** -* [WebDriver][Puppeteer] Added basicAuth support via config. Example: `basicAuth: {username: 'username', password: 'password'}`. See [#1962](https://github.com/codeceptjs/CodeceptJS/issues/1962) by **[PeterNgTr](https://github.com/PeterNgTr)** -* [WebDriver][Appium] Added `scrollIntoView` by **[pablopaul](https://github.com/pablopaul)** -* Fixed [#2118](https://github.com/codeceptjs/CodeceptJS/issues/2118): No error stack trace for syntax error by **[senthillkumar](https://github.com/senthillkumar)** -* Added `parse()` method to data table inside Cucumber tests. Use it to obtain rows and hashes for test data. See [#2082](https://github.com/codeceptjs/CodeceptJS/issues/2082) by **[Sraime](https://github.com/Sraime)** +- Improved setup wizard with `npx codecept init`: + - **enabled [retryFailedStep](/plugins/#retryfailedstep) plugin for new setups**. + - enabled [@codeceptjs/configure](/configuration/#common-configuration-patterns) to toggle headless/window mode via env variable + - creates a new test on init + - removed question on "steps file", create it by default. +- Added [pauseOnFail plugin](/plugins/#pauseonfail). _Sponsored by Paul Vincent Beigang and his book "[Practical End 2 End Testing with CodeceptJS](https://leanpub.com/codeceptjs/)"_. +- Added [`run-rerun` command](/commands/#run-rerun) to run tests multiple times to detect and fix flaky tests. By **[Ilrilan](https://github.com/Ilrilan)** and **[Vorobeyko](https://github.com/Vorobeyko)**. +- Added [`Scenario.todo()` to declare tests as pending](/basics#todotest). See [#2100](https://github.com/codeceptjs/CodeceptJS/issues/2100) by **[Vorobeyko](https://github.com/Vorobeyko)** +- Added support for absolute path for `output` dir. See [#2049](https://github.com/codeceptjs/CodeceptJS/issues/2049) by **[elukoyanov](https://github.com/elukoyanov)** +- Fixed error in `npx codecept init` caused by calling `console.print`. See [#2071](https://github.com/codeceptjs/CodeceptJS/issues/2071) by **[Atinux](https://github.com/Atinux)**. +- **[Filesystem]** Methods added by **[aefluke](https://github.com/aefluke)**: + - `seeFileNameMatching` + - `grabFileNames` +- **[Puppeteer]** Fixed grabbing attributes with hyphen by **[Holorium](https://github.com/Holorium)** +- **[TestCafe]** Fixed `grabAttributeFrom` method by **[elukoyanov](https://github.com/elukoyanov)** +- **[MockRequest]** Added support for [Polly config options](https://netflix.github.io/pollyjs/#/configuration?id=configuration) by **[ecrmnn](https://github.com/ecrmnn)** +- **[TestCafe]** Fixes exiting with zero code on failure. Fixed [#2090](https://github.com/codeceptjs/CodeceptJS/issues/2090) with [#2106](https://github.com/codeceptjs/CodeceptJS/issues/2106) by **[koushikmohan1996](https://github.com/koushikmohan1996)** +- [WebDriver][Puppeteer] Added basicAuth support via config. Example: `basicAuth: {username: 'username', password: 'password'}`. See [#1962](https://github.com/codeceptjs/CodeceptJS/issues/1962) by **[PeterNgTr](https://github.com/PeterNgTr)** +- [WebDriver][Appium] Added `scrollIntoView` by **[pablopaul](https://github.com/pablopaul)** +- Fixed [#2118](https://github.com/codeceptjs/CodeceptJS/issues/2118): No error stack trace for syntax error by **[senthillkumar](https://github.com/senthillkumar)** +- Added `parse()` method to data table inside Cucumber tests. Use it to obtain rows and hashes for test data. See [#2082](https://github.com/codeceptjs/CodeceptJS/issues/2082) by **[Sraime](https://github.com/Sraime)** ## 2.3.6 -* Create better Typescript definition file through JSDoc. By **[lemnis](https://github.com/lemnis)** -* `run-workers` now can use glob pattern. By **[Ilrilan](https://github.com/Ilrilan)** +- Create better Typescript definition file through JSDoc. By **[lemnis](https://github.com/lemnis)** +- `run-workers` now can use glob pattern. By **[Ilrilan](https://github.com/Ilrilan)** + ```js // Example: exports.config = { tests: '{./workers/base_test.workers.js,./workers/test_grep.workers.js}', } ``` -* Added new command `npx codeceptjs info` which print information about your environment and CodeceptJS configs. By **[jamesgeorge007](https://github.com/jamesgeorge007)** -* Fixed some typos in documantation. By **[pablopaul](https://github.com/pablopaul)** **[atomicpages](https://github.com/atomicpages)** **[EricTendian](https://github.com/EricTendian)** -* Added PULL_REQUEST template. -* [Puppeteer][WebDriver] Added `waitForClickable` for waiting clickable element on page. -* **[TestCafe]** Added support for remote connection. By **[jvdieten](https://github.com/jvdieten)** -* **[Puppeteer]** Fixed `waitForText` XPath context now works correctly. By **[Heavik](https://github.com/Heavik)** -* **[TestCafe]** Fixed `clearField` clear field now awaits TestCafe's promise. By **[orihomie](https://github.com/orihomie)** -* **[Puppeteer]** Fixed fails when executing localStorage on services pages. See [#2026](https://github.com/codeceptjs/CodeceptJS/issues/2026) -* Fixed empty tags in test name. See [#2038](https://github.com/codeceptjs/CodeceptJS/issues/2038) + +- Added new command `npx codeceptjs info` which print information about your environment and CodeceptJS configs. By **[jamesgeorge007](https://github.com/jamesgeorge007)** +- Fixed some typos in documantation. By **[pablopaul](https://github.com/pablopaul)** **[atomicpages](https://github.com/atomicpages)** **[EricTendian](https://github.com/EricTendian)** +- Added PULL_REQUEST template. +- [Puppeteer][WebDriver] Added `waitForClickable` for waiting clickable element on page. +- **[TestCafe]** Added support for remote connection. By **[jvdieten](https://github.com/jvdieten)** +- **[Puppeteer]** Fixed `waitForText` XPath context now works correctly. By **[Heavik](https://github.com/Heavik)** +- **[TestCafe]** Fixed `clearField` clear field now awaits TestCafe's promise. By **[orihomie](https://github.com/orihomie)** +- **[Puppeteer]** Fixed fails when executing localStorage on services pages. See [#2026](https://github.com/codeceptjs/CodeceptJS/issues/2026) +- Fixed empty tags in test name. See [#2038](https://github.com/codeceptjs/CodeceptJS/issues/2038) ## 2.3.5 -* Set "parse-function" dependency to "5.2.11" to avoid further installation errors. +- Set "parse-function" dependency to "5.2.11" to avoid further installation errors. ## 2.3.4 -* Fixed installation error "Cannot find module '@babel/runtime/helpers/interopRequireDefault'". The issue came from `parse-function` package. Fixed by **[pablopaul](https://github.com/pablopaul)**. -* **[Puppeteer]** Fixed switching to iframe without an ID by **[johnyb](https://github.com/johnyb)**. See [#1974](https://github.com/codeceptjs/CodeceptJS/issues/1974) -* Added `--profile` option to `run-workers` by **[orihomie](https://github.com/orihomie)** -* Added a tag definition to `FeatureConfig` and `ScenarioConfig` by **[sseliverstov](https://github.com/sseliverstov)** +- Fixed installation error "Cannot find module '@babel/runtime/helpers/interopRequireDefault'". The issue came from `parse-function` package. Fixed by **[pablopaul](https://github.com/pablopaul)**. +- **[Puppeteer]** Fixed switching to iframe without an ID by **[johnyb](https://github.com/johnyb)**. See [#1974](https://github.com/codeceptjs/CodeceptJS/issues/1974) +- Added `--profile` option to `run-workers` by **[orihomie](https://github.com/orihomie)** +- Added a tag definition to `FeatureConfig` and `ScenarioConfig` by **[sseliverstov](https://github.com/sseliverstov)** ## 2.3.3 -* **[customLocator plugin](#customlocator) introduced**. Adds a locator strategy for special test attributes on elements. +- **[customLocator plugin](#customlocator) introduced**. Adds a locator strategy for special test attributes on elements. ```js // when data-test-id is a special test attribute @@ -2628,279 +3137,280 @@ I.click({ css: '[data-test-id=register_button]'); // with this I.click('$register_button'); ``` -* [Puppeteer][WebDriver] `pressKey` improvements by **[martomo](https://github.com/martomo)**: -Changed pressKey method to resolve issues and extend functionality. - * Did not properly recognize 'Meta' (or 'Command') as modifier key. - * Right modifier keys did not work in WebDriver using JsonWireProtocol. - * 'Shift' + 'key' combination would not reflect actual keyboard behavior. - * Respect sequence with multiple modifier keys passed to pressKey. - * Added support to automatic change operation modifier key based on operating system. -* [Puppeteer][WebDriver] Added `pressKeyUp` and `pressKeyDown` to press and release modifier keys like `Control` or `Shift`. By **[martomo](https://github.com/martomo)**. -* [Puppeteer][WebDriver] Added `grabElementBoundingRect` by **[PeterNgTr](https://github.com/PeterNgTr)**. -* **[Puppeteer]** Fixed speed degradation introduced in [#1306](https://github.com/codeceptjs/CodeceptJS/issues/1306) with accessibility locators support. See [#1953](https://github.com/codeceptjs/CodeceptJS/issues/1953). -* Added `Config.addHook` to add a function that will update configuration on load. -* Started [`@codeceptjs/configure`](https://github.com/codeceptjs/configure) package with a collection of common configuration patterns. -* **[TestCafe]** port's management removed (left on TestCafe itself) by **[orihomie](https://github.com/orihomie)**. Fixes [#1934](https://github.com/codeceptjs/CodeceptJS/issues/1934). -* **[REST]** Headers are no more declared as singleton variable. Fixes [#1959](https://github.com/codeceptjs/CodeceptJS/issues/1959) -* Updated Docker image to include run tests in workers with `NUMBER_OF_WORKERS` env variable. By **[PeterNgTr](https://github.com/PeterNgTr)**. + +- [Puppeteer][WebDriver] `pressKey` improvements by **[martomo](https://github.com/martomo)**: + Changed pressKey method to resolve issues and extend functionality. + - Did not properly recognize 'Meta' (or 'Command') as modifier key. + - Right modifier keys did not work in WebDriver using JsonWireProtocol. + - 'Shift' + 'key' combination would not reflect actual keyboard behavior. + - Respect sequence with multiple modifier keys passed to pressKey. + - Added support to automatic change operation modifier key based on operating system. +- [Puppeteer][WebDriver] Added `pressKeyUp` and `pressKeyDown` to press and release modifier keys like `Control` or `Shift`. By **[martomo](https://github.com/martomo)**. +- [Puppeteer][WebDriver] Added `grabElementBoundingRect` by **[PeterNgTr](https://github.com/PeterNgTr)**. +- **[Puppeteer]** Fixed speed degradation introduced in [#1306](https://github.com/codeceptjs/CodeceptJS/issues/1306) with accessibility locators support. See [#1953](https://github.com/codeceptjs/CodeceptJS/issues/1953). +- Added `Config.addHook` to add a function that will update configuration on load. +- Started [`@codeceptjs/configure`](https://github.com/codeceptjs/configure) package with a collection of common configuration patterns. +- **[TestCafe]** port's management removed (left on TestCafe itself) by **[orihomie](https://github.com/orihomie)**. Fixes [#1934](https://github.com/codeceptjs/CodeceptJS/issues/1934). +- **[REST]** Headers are no more declared as singleton variable. Fixes [#1959](https://github.com/codeceptjs/CodeceptJS/issues/1959) +- Updated Docker image to include run tests in workers with `NUMBER_OF_WORKERS` env variable. By **[PeterNgTr](https://github.com/PeterNgTr)**. ## 2.3.2 -* **[Puppeteer]** Fixed Puppeteer 1.20 support by **[davertmik](https://github.com/davertmik)** -* Fixed `run-workers` to run with complex configs. See [#1887](https://github.com/codeceptjs/CodeceptJS/issues/1887) by **[nitschSB](https://github.com/nitschSB)** -* Added `--suites` option to `run-workers` to split suites by workers (tests of the same suite goes to teh same worker). Thanks **[nitschSB](https://github.com/nitschSB)**. -* Added a guide on [Email Testing](https://codecept.io/email). -* **[retryFailedStepPlugin]** Improved to ignore wait* steps and others. Also added option to ignore this plugin per test bases. See [updated documentation](https://codecept.io/plugins#retryfailedstep). By **[davertmik](https://github.com/davertmik)** -* Fixed using PageObjects as classes by **[Vorobeyko](https://github.com/Vorobeyko)**. See [#1896](https://github.com/codeceptjs/CodeceptJS/issues/1896) -* **[WebDriver]** Fixed opening more than one tab. See [#1875](https://github.com/codeceptjs/CodeceptJS/issues/1875) by **[jplegoff](https://github.com/jplegoff)**. Fixes [#1874](https://github.com/codeceptjs/CodeceptJS/issues/1874) -* Fixed [#1891](https://github.com/codeceptjs/CodeceptJS/issues/1891) when `I.retry()` affected retries of next steps. By **[davertmik](https://github.com/davertmik)** +- **[Puppeteer]** Fixed Puppeteer 1.20 support by **[davertmik](https://github.com/davertmik)** +- Fixed `run-workers` to run with complex configs. See [#1887](https://github.com/codeceptjs/CodeceptJS/issues/1887) by **[nitschSB](https://github.com/nitschSB)** +- Added `--suites` option to `run-workers` to split suites by workers (tests of the same suite goes to teh same worker). Thanks **[nitschSB](https://github.com/nitschSB)**. +- Added a guide on [Email Testing](https://codecept.io/email). +- **[retryFailedStepPlugin]** Improved to ignore wait\* steps and others. Also added option to ignore this plugin per test bases. See [updated documentation](https://codecept.io/plugins#retryfailedstep). By **[davertmik](https://github.com/davertmik)** +- Fixed using PageObjects as classes by **[Vorobeyko](https://github.com/Vorobeyko)**. See [#1896](https://github.com/codeceptjs/CodeceptJS/issues/1896) +- **[WebDriver]** Fixed opening more than one tab. See [#1875](https://github.com/codeceptjs/CodeceptJS/issues/1875) by **[jplegoff](https://github.com/jplegoff)**. Fixes [#1874](https://github.com/codeceptjs/CodeceptJS/issues/1874) +- Fixed [#1891](https://github.com/codeceptjs/CodeceptJS/issues/1891) when `I.retry()` affected retries of next steps. By **[davertmik](https://github.com/davertmik)** ## 2.3.1 -* **[MockRequest]** Polly helper was renamed to MockRequest. -* [MockRequest][WebDriver] [Mocking requests](https://codecept.io/webdriver#mocking-requests) is now available in WebDriver. Thanks **[radhey1851](https://github.com/radhey1851)** -* **[Puppeteer]** Ensure configured user agent and/or window size is applied to all pages. See [#1862](https://github.com/codeceptjs/CodeceptJS/issues/1862) by **[martomo](https://github.com/martomo)** -* Improve handling of xpath locators with round brackets by **[nitschSB](https://github.com/nitschSB)**. See [#1870](https://github.com/codeceptjs/CodeceptJS/issues/1870) -* Use WebDriver capabilities config in wdio plugin. [#1869](https://github.com/codeceptjs/CodeceptJS/issues/1869) by **[quekshuy](https://github.com/quekshuy)** +- **[MockRequest]** Polly helper was renamed to MockRequest. +- [MockRequest][WebDriver] [Mocking requests](https://codecept.io/webdriver#mocking-requests) is now available in WebDriver. Thanks **[radhey1851](https://github.com/radhey1851)** +- **[Puppeteer]** Ensure configured user agent and/or window size is applied to all pages. See [#1862](https://github.com/codeceptjs/CodeceptJS/issues/1862) by **[martomo](https://github.com/martomo)** +- Improve handling of xpath locators with round brackets by **[nitschSB](https://github.com/nitschSB)**. See [#1870](https://github.com/codeceptjs/CodeceptJS/issues/1870) +- Use WebDriver capabilities config in wdio plugin. [#1869](https://github.com/codeceptjs/CodeceptJS/issues/1869) by **[quekshuy](https://github.com/quekshuy)** ## 2.3.0 - -* **[Parallel testing by workers](https://codecept.io/parallel#parallel-execution-by-workers) introduced** by **[VikalpP](https://github.com/VikalpP)** and **[davertmik](https://github.com/davertmik)**. Use `run-workers` command as faster and simpler alternative to `run-multiple`. Requires NodeJS v12 +- **[Parallel testing by workers](https://codecept.io/parallel#parallel-execution-by-workers) introduced** by **[VikalpP](https://github.com/VikalpP)** and **[davertmik](https://github.com/davertmik)**. Use `run-workers` command as faster and simpler alternative to `run-multiple`. Requires NodeJS v12 ``` # run all tests in parallel using 3 workers npx codeceptjs run-workers 3 ``` -* [GraphQL][GraphQLDataFactory] **Helpers for data management over GraphQL** APIs added. By **[radhey1851](https://github.com/radhey1851)**. - * Learn how to [use GraphQL helper](https://codecept.io/data#graphql) to access GarphQL API - * And how to combine it with [GraphQLDataFactory](https://codecept.io/data#graphql-data-factory) to generate and persist test data. -* **Updated to use Mocha 6**. See [#1802](https://github.com/codeceptjs/CodeceptJS/issues/1802) by **[elukoyanov](https://github.com/elukoyanov)** -* Added `dry-run` command to print steps of test scenarios without running them. Fails to execute scenarios with `grab*` methods or custom code. See [#1825](https://github.com/codeceptjs/CodeceptJS/issues/1825) for more details. + +- [GraphQL][GraphQLDataFactory] **Helpers for data management over GraphQL** APIs added. By **[radhey1851](https://github.com/radhey1851)**. + - Learn how to [use GraphQL helper](https://codecept.io/data#graphql) to access GarphQL API + - And how to combine it with [GraphQLDataFactory](https://codecept.io/data#graphql-data-factory) to generate and persist test data. +- **Updated to use Mocha 6**. See [#1802](https://github.com/codeceptjs/CodeceptJS/issues/1802) by **[elukoyanov](https://github.com/elukoyanov)** +- Added `dry-run` command to print steps of test scenarios without running them. Fails to execute scenarios with `grab*` methods or custom code. See [#1825](https://github.com/codeceptjs/CodeceptJS/issues/1825) for more details. ``` npx codeceptjs dry-run ``` -* **[Appium]** Optimization when clicking, searching for fields by accessibility id. See [#1777](https://github.com/codeceptjs/CodeceptJS/issues/1777) by **[gagandeepsingh26](https://github.com/gagandeepsingh26)** -* **[TestCafe]** Fixed `switchTo` by **[KadoBOT](https://github.com/KadoBOT)** -* **[WebDriver]** Added geolocation actions by **[PeterNgTr](https://github.com/PeterNgTr)** - * `grabGeoLocation()` - * `setGeoLocation()` -* **[Polly]** Check typeof arguments for mock requests by **[VikalpP](https://github.com/VikalpP)**. Fixes [#1815](https://github.com/codeceptjs/CodeceptJS/issues/1815) -* CLI improvements by **[jamesgeorge007](https://github.com/jamesgeorge007)** - * `codeceptjs` command prints list of all available commands - * added `codeceptjs -V` flag to print version information - * warns on unknown command -* Added TypeScript files support to `run-multiple` by **[z4o4z](https://github.com/z4o4z)** -* Fixed element position bug in locator builder. See [#1829](https://github.com/codeceptjs/CodeceptJS/issues/1829) by **[AnotherAnkor](https://github.com/AnotherAnkor)** -* Various TypeScript typings updates by **[elukoyanov](https://github.com/elukoyanov)** and **[Vorobeyko](https://github.com/Vorobeyko)** -* Added `event.step.comment` event for all comment steps like `I.say` or gherking steps. +- **[Appium]** Optimization when clicking, searching for fields by accessibility id. See [#1777](https://github.com/codeceptjs/CodeceptJS/issues/1777) by **[gagandeepsingh26](https://github.com/gagandeepsingh26)** +- **[TestCafe]** Fixed `switchTo` by **[KadoBOT](https://github.com/KadoBOT)** +- **[WebDriver]** Added geolocation actions by **[PeterNgTr](https://github.com/PeterNgTr)** + - `grabGeoLocation()` + - `setGeoLocation()` +- **[Polly]** Check typeof arguments for mock requests by **[VikalpP](https://github.com/VikalpP)**. Fixes [#1815](https://github.com/codeceptjs/CodeceptJS/issues/1815) +- CLI improvements by **[jamesgeorge007](https://github.com/jamesgeorge007)** + - `codeceptjs` command prints list of all available commands + - added `codeceptjs -V` flag to print version information + - warns on unknown command +- Added TypeScript files support to `run-multiple` by **[z4o4z](https://github.com/z4o4z)** +- Fixed element position bug in locator builder. See [#1829](https://github.com/codeceptjs/CodeceptJS/issues/1829) by **[AnotherAnkor](https://github.com/AnotherAnkor)** +- Various TypeScript typings updates by **[elukoyanov](https://github.com/elukoyanov)** and **[Vorobeyko](https://github.com/Vorobeyko)** +- Added `event.step.comment` event for all comment steps like `I.say` or gherking steps. ## 2.2.1 -* **[WebDriver]** A [dedicated guide](https://codecept.io/webdriver) written. -* **[TestCafe]** A [dedicated guide](https://codecept.io/testcafe) written. -* **[Puppeteer]** A [chapter on mocking](https://codecept.io/puppeteer#mocking-requests) written -* [Puppeteer][Nightmare][TestCafe] Window mode is enabled by default on `codeceptjs init`. -* **[TestCafe]** Actions implemented by **[hubidu](https://github.com/hubidu)** - * `grabPageScrollPosition` - * `scrollPageToTop` - * `scrollPageToBottom` - * `scrollTo` - * `switchTo` -* Intellisense improvements. Renamed `tsconfig.json` to `jsconfig.json` on init. Fixed autocompletion for Visual Studio Code. -* **[Polly]** Take configuration values from Puppeteer. Fix [#1766](https://github.com/codeceptjs/CodeceptJS/issues/1766) by **[VikalpP](https://github.com/VikalpP)** -* **[Polly]** Add preconditions to check for puppeteer page availability by **[VikalpP](https://github.com/VikalpP)**. Fixes [#1767](https://github.com/codeceptjs/CodeceptJS/issues/1767) -* **[WebDriver]** Use filename for `uploadFile` by **[VikalpP](https://github.com/VikalpP)**. See [#1797](https://github.com/codeceptjs/CodeceptJS/issues/1797) -* **[Puppeteer]** Configure speed of input with `pressKeyDelay` option. By **[hubidu](https://github.com/hubidu)** -* Fixed recursive loading of support objects by **[davertmik](https://github.com/davertmik)**. -* Fixed support object definitions in steps.d.ts by **[johnyb](https://github.com/johnyb)**. Fixes [#1795](https://github.com/codeceptjs/CodeceptJS/issues/1795) -* Fixed `Data().Scenario().injectDependencies()` is not a function by **[andrerleao](https://github.com/andrerleao)** -* Fixed crash when using xScenario & Scenario.skip with tag by **[VikalpP](https://github.com/VikalpP)**. Fixes [#1751](https://github.com/codeceptjs/CodeceptJS/issues/1751) -* Dynamic configuration of helpers can be performed with async function. See [#1786](https://github.com/codeceptjs/CodeceptJS/issues/1786) by **[cviejo](https://github.com/cviejo)** -* Added TS definitions for internal objects by **[Vorobeyko](https://github.com/Vorobeyko)** -* BDD improvements: - * Fix for snippets command with a .feature file that has special characters by **[asselin](https://github.com/asselin)** - * Fix `--path` option on `gherkin:snippets` command by **[asselin](https://github.com/asselin)**. See [#1790](https://github.com/codeceptjs/CodeceptJS/issues/1790) - * Added `--feature` option to `gherkin:snippets` to enable creating snippets for a subset of .feature files. See [#1803](https://github.com/codeceptjs/CodeceptJS/issues/1803) by **[asselin](https://github.com/asselin)**. -* Fixed: dynamic configs not reset after test. Fixes [#1776](https://github.com/codeceptjs/CodeceptJS/issues/1776) by **[cviejo](https://github.com/cviejo)**. +- **[WebDriver]** A [dedicated guide](https://codecept.io/webdriver) written. +- **[TestCafe]** A [dedicated guide](https://codecept.io/testcafe) written. +- **[Puppeteer]** A [chapter on mocking](https://codecept.io/puppeteer#mocking-requests) written +- [Puppeteer][Nightmare][TestCafe] Window mode is enabled by default on `codeceptjs init`. +- **[TestCafe]** Actions implemented by **[hubidu](https://github.com/hubidu)** + - `grabPageScrollPosition` + - `scrollPageToTop` + - `scrollPageToBottom` + - `scrollTo` + - `switchTo` +- Intellisense improvements. Renamed `tsconfig.json` to `jsconfig.json` on init. Fixed autocompletion for Visual Studio Code. +- **[Polly]** Take configuration values from Puppeteer. Fix [#1766](https://github.com/codeceptjs/CodeceptJS/issues/1766) by **[VikalpP](https://github.com/VikalpP)** +- **[Polly]** Add preconditions to check for puppeteer page availability by **[VikalpP](https://github.com/VikalpP)**. Fixes [#1767](https://github.com/codeceptjs/CodeceptJS/issues/1767) +- **[WebDriver]** Use filename for `uploadFile` by **[VikalpP](https://github.com/VikalpP)**. See [#1797](https://github.com/codeceptjs/CodeceptJS/issues/1797) +- **[Puppeteer]** Configure speed of input with `pressKeyDelay` option. By **[hubidu](https://github.com/hubidu)** +- Fixed recursive loading of support objects by **[davertmik](https://github.com/davertmik)**. +- Fixed support object definitions in steps.d.ts by **[johnyb](https://github.com/johnyb)**. Fixes [#1795](https://github.com/codeceptjs/CodeceptJS/issues/1795) +- Fixed `Data().Scenario().injectDependencies()` is not a function by **[andrerleao](https://github.com/andrerleao)** +- Fixed crash when using xScenario & Scenario.skip with tag by **[VikalpP](https://github.com/VikalpP)**. Fixes [#1751](https://github.com/codeceptjs/CodeceptJS/issues/1751) +- Dynamic configuration of helpers can be performed with async function. See [#1786](https://github.com/codeceptjs/CodeceptJS/issues/1786) by **[cviejo](https://github.com/cviejo)** +- Added TS definitions for internal objects by **[Vorobeyko](https://github.com/Vorobeyko)** +- BDD improvements: + - Fix for snippets command with a .feature file that has special characters by **[asselin](https://github.com/asselin)** + - Fix `--path` option on `gherkin:snippets` command by **[asselin](https://github.com/asselin)**. See [#1790](https://github.com/codeceptjs/CodeceptJS/issues/1790) + - Added `--feature` option to `gherkin:snippets` to enable creating snippets for a subset of .feature files. See [#1803](https://github.com/codeceptjs/CodeceptJS/issues/1803) by **[asselin](https://github.com/asselin)**. +- Fixed: dynamic configs not reset after test. Fixes [#1776](https://github.com/codeceptjs/CodeceptJS/issues/1776) by **[cviejo](https://github.com/cviejo)**. ## 2.2.0 -* **EXPERIMENTAL** [**TestCafe** helper](https://codecept.io/helpers/TestCafe) introduced. TestCafe allows to run cross-browser tests it its own very fast engine. Supports all browsers including mobile. Thanks to **[hubidu](https://github.com/hubidu)** for implementation! Please test it and send us feedback. -* **[Puppeteer]** Mocking requests enabled by introducing [Polly.js helper](https://codecept.io/helpers/Polly). Thanks **[VikalpP](https://github.com/VikalpP)** +- **EXPERIMENTAL** [**TestCafe** helper](https://codecept.io/helpers/TestCafe) introduced. TestCafe allows to run cross-browser tests it its own very fast engine. Supports all browsers including mobile. Thanks to **[hubidu](https://github.com/hubidu)** for implementation! Please test it and send us feedback. +- **[Puppeteer]** Mocking requests enabled by introducing [Polly.js helper](https://codecept.io/helpers/Polly). Thanks **[VikalpP](https://github.com/VikalpP)** ```js // use Polly & Puppeteer helpers -I.mockRequest('GET', '/api/users', 200); -I.mockRequest('POST', '/users', { user: { name: 'fake' }}); -``` - -* **EXPERIMENTAL** **[Puppeteer]** [Firefox support](https://codecept.io/helpers/Puppeteer-firefox) introduced by **[ngadiyak](https://github.com/ngadiyak)**, see [#1740](https://github.com/codeceptjs/CodeceptJS/issues/1740) -* **[stepByStepReportPlugin]** use md5 hash to generate reports into unique folder. Fix [#1744](https://github.com/codeceptjs/CodeceptJS/issues/1744) by **[chimurai](https://github.com/chimurai)** -* Interactive pause improvements: - * print result of `grab` commands - * print message for successful assertions -* `run-multiple` (parallel execution) improvements: - * `bootstrapAll` must be called before creating chunks. [#1741](https://github.com/codeceptjs/CodeceptJS/issues/1741) by **[Vorobeyko](https://github.com/Vorobeyko)** - * Bugfix: If value in config has falsy value then multiple config does not overwrite original value. [#1756](https://github.com/codeceptjs/CodeceptJS/issues/1756) by **[LukoyanovE](https://github.com/LukoyanovE)** -* Fixed hooks broken in 2.1.5 by **[Vorobeyko](https://github.com/Vorobeyko)** -* Fix references to support objects when using Dependency Injection. Fix by **[johnyb](https://github.com/johnyb)**. See [#1701](https://github.com/codeceptjs/CodeceptJS/issues/1701) -* Fix dynamic config applied for multiple helpers by **[VikalpP](https://github.com/VikalpP)** [#1743](https://github.com/codeceptjs/CodeceptJS/issues/1743) - +I.mockRequest('GET', '/api/users', 200) +I.mockRequest('POST', '/users', { user: { name: 'fake' } }) +``` + +- **EXPERIMENTAL** **[Puppeteer]** [Firefox support](https://codecept.io/helpers/Puppeteer-firefox) introduced by **[ngadiyak](https://github.com/ngadiyak)**, see [#1740](https://github.com/codeceptjs/CodeceptJS/issues/1740) +- **[stepByStepReportPlugin]** use md5 hash to generate reports into unique folder. Fix [#1744](https://github.com/codeceptjs/CodeceptJS/issues/1744) by **[chimurai](https://github.com/chimurai)** +- Interactive pause improvements: + - print result of `grab` commands + - print message for successful assertions +- `run-multiple` (parallel execution) improvements: + - `bootstrapAll` must be called before creating chunks. [#1741](https://github.com/codeceptjs/CodeceptJS/issues/1741) by **[Vorobeyko](https://github.com/Vorobeyko)** + - Bugfix: If value in config has falsy value then multiple config does not overwrite original value. [#1756](https://github.com/codeceptjs/CodeceptJS/issues/1756) by **[LukoyanovE](https://github.com/LukoyanovE)** +- Fixed hooks broken in 2.1.5 by **[Vorobeyko](https://github.com/Vorobeyko)** +- Fix references to support objects when using Dependency Injection. Fix by **[johnyb](https://github.com/johnyb)**. See [#1701](https://github.com/codeceptjs/CodeceptJS/issues/1701) +- Fix dynamic config applied for multiple helpers by **[VikalpP](https://github.com/VikalpP)** [#1743](https://github.com/codeceptjs/CodeceptJS/issues/1743) ## 2.1.5 -* **EXPERIMENTAL** [Wix Detox support](https://github.com/codeceptjs/detox-helper) introduced as standalone helper. Provides a faster alternative to Appium for mobile testing. -* Saving successful commands inside interactive pause into `_output/cli-history` file. By **[hubidu](https://github.com/hubidu)** -* Fixed hanging error handler inside scenario. See [#1721](https://github.com/codeceptjs/CodeceptJS/issues/1721) by **[haily-lgc](https://github.com/haily-lgc)**. -* Fixed by **[Vorobeyko](https://github.com/Vorobeyko)**: tests did not fail when an exception was raised in async bootstrap. -* **[WebDriver]** Added window control methods by **[emmonspired](https://github.com/emmonspired)** - * `grabAllWindowHandles` returns all window handles - * `grabCurrentWindowHandle` returns current window handle - * `switchToWindow` switched to window by its handle -* **[Appium]** Fixed using `host` as configuration by **[trinhpham](https://github.com/trinhpham)** -* Fixed `run-multiple` command when `tests` config option is undefined (in Gherkin scenarios). By **[gkushang](https://github.com/gkushang)**. -* German translation introduced by **[hubidu](https://github.com/hubidu)** +- **EXPERIMENTAL** [Wix Detox support](https://github.com/codeceptjs/detox-helper) introduced as standalone helper. Provides a faster alternative to Appium for mobile testing. +- Saving successful commands inside interactive pause into `_output/cli-history` file. By **[hubidu](https://github.com/hubidu)** +- Fixed hanging error handler inside scenario. See [#1721](https://github.com/codeceptjs/CodeceptJS/issues/1721) by **[haily-lgc](https://github.com/haily-lgc)**. +- Fixed by **[Vorobeyko](https://github.com/Vorobeyko)**: tests did not fail when an exception was raised in async bootstrap. +- **[WebDriver]** Added window control methods by **[emmonspired](https://github.com/emmonspired)** + - `grabAllWindowHandles` returns all window handles + - `grabCurrentWindowHandle` returns current window handle + - `switchToWindow` switched to window by its handle +- **[Appium]** Fixed using `host` as configuration by **[trinhpham](https://github.com/trinhpham)** +- Fixed `run-multiple` command when `tests` config option is undefined (in Gherkin scenarios). By **[gkushang](https://github.com/gkushang)**. +- German translation introduced by **[hubidu](https://github.com/hubidu)** ## 2.1.4 -* [WebDriver][Puppeteer][Protractor][Nightmare] A11y locator support introduced by **[Holorium](https://github.com/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](https://github.com/seta-tuha)**. -* Fixed 'ERROR: ENAMETOOLONG' creating directory names in `run-multiple` with long config. By **[artvinn](https://github.com/artvinn)** -* **[REST]** Fixed url autocompletion combining base and relative paths by **[LukoyanovE](https://github.com/LukoyanovE)** -* [Nightmare][Protractor] `uncheckOption` method introduced by **[PeterNgTr](https://github.com/PeterNgTr)** -* [autoLogin plugin] Enable to use without `await` by **[tsuemura](https://github.com/tsuemura)** -* **[Puppeteer]** Fixed `UnhandledPromiseRejectionWarning: "Execution context was destroyed...` by **[adrielcodeco](https://github.com/adrielcodeco)** -* **[WebDriver]** Keep browser window dimensions when starting a new session by **[spiroid](https://github.com/spiroid)** -* Replace Ghekrin plceholders with values in files that combine a scenerio outline and table by **[medtoure18](https://github.com/medtoure18)**. -* Added Documentation to [locate elements in React Native](https://codecept.io/mobile-react-native-locators) apps. By **[DimGun](https://github.com/DimGun)**. -* Adding optional `path` parameter to `bdd:snippets` command to append snippets to a specific file. By **[cthorsen31](https://github.com/cthorsen31)**. -* Added optional `output` parameter to `def` command by **[LukoyanovE](https://github.com/LukoyanovE)**. -* **[Puppeteer]** Added `grabDataFromPerformanceTiming` by **[PeterNgTr](https://github.com/PeterNgTr)**. -* axios updated to `0.19.0` by **[SteveShaffer](https://github.com/SteveShaffer)** -* TypeScript defitions updated by **[LukoyanovE](https://github.com/LukoyanovE)**. Added `secret` and `inject` function. +- [WebDriver][Puppeteer][Protractor][Nightmare] A11y locator support introduced by **[Holorium](https://github.com/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](https://github.com/seta-tuha)**. +- Fixed 'ERROR: ENAMETOOLONG' creating directory names in `run-multiple` with long config. By **[artvinn](https://github.com/artvinn)** +- **[REST]** Fixed url autocompletion combining base and relative paths by **[LukoyanovE](https://github.com/LukoyanovE)** +- [Nightmare][Protractor] `uncheckOption` method introduced by **[PeterNgTr](https://github.com/PeterNgTr)** +- [autoLogin plugin] Enable to use without `await` by **[tsuemura](https://github.com/tsuemura)** +- **[Puppeteer]** Fixed `UnhandledPromiseRejectionWarning: "Execution context was destroyed...` by **[adrielcodeco](https://github.com/adrielcodeco)** +- **[WebDriver]** Keep browser window dimensions when starting a new session by **[spiroid](https://github.com/spiroid)** +- Replace Ghekrin plceholders with values in files that combine a scenerio outline and table by **[medtoure18](https://github.com/medtoure18)**. +- Added Documentation to [locate elements in React Native](https://codecept.io/mobile-react-native-locators) apps. By **[DimGun](https://github.com/DimGun)**. +- Adding optional `path` parameter to `bdd:snippets` command to append snippets to a specific file. By **[cthorsen31](https://github.com/cthorsen31)**. +- Added optional `output` parameter to `def` command by **[LukoyanovE](https://github.com/LukoyanovE)**. +- **[Puppeteer]** Added `grabDataFromPerformanceTiming` by **[PeterNgTr](https://github.com/PeterNgTr)**. +- axios updated to `0.19.0` by **[SteveShaffer](https://github.com/SteveShaffer)** +- TypeScript defitions updated by **[LukoyanovE](https://github.com/LukoyanovE)**. Added `secret` and `inject` function. ## 2.1.3 -* Fixed autoLogin plugin to inject `login` function -* Fixed using `toString()` in DataTablewhen it is defined by **[tsuemura](https://github.com/tsuemura)** +- Fixed autoLogin plugin to inject `login` function +- Fixed using `toString()` in DataTablewhen it is defined by **[tsuemura](https://github.com/tsuemura)** ## 2.1.2 -* Fixed `inject` to load objects recursively. -* Fixed TypeScript definitions for locators by **[LukoyanovE](https://github.com/LukoyanovE)** -* **EXPERIMENTAL** **[WebDriver]** ReactJS locators support with webdriverio v5.8+: +- Fixed `inject` to load objects recursively. +- Fixed TypeScript definitions for locators by **[LukoyanovE](https://github.com/LukoyanovE)** +- **EXPERIMENTAL** **[WebDriver]** ReactJS locators support with webdriverio v5.8+: ```js // locating React element by name, prop, state -I.click({ react: 'component-name', props: {}, state: {} }); -I.seeElement({ react: 'component-name', props: {}, state: {} }); +I.click({ react: 'component-name', props: {}, state: {} }) +I.seeElement({ react: 'component-name', props: {}, state: {} }) ``` ## 2.1.1 -* Do not retry `within` and `session` calls inside `retryFailedStep` plugin. Fix by **[tsuemura](https://github.com/tsuemura)** +- Do not retry `within` and `session` calls inside `retryFailedStep` plugin. Fix by **[tsuemura](https://github.com/tsuemura)** ## 2.1.0 -* Added global `inject()` function to require actor and page objects using dependency injection. Recommended to use in page objects, step definition files, support objects: +- Added global `inject()` function to require actor and page objects using dependency injection. Recommended to use in page objects, step definition files, support objects: ```js // old way -const I = actor(); -const myPage = require('../page/myPage'); +const I = actor() +const myPage = require('../page/myPage') // new way -const { I, myPage } = inject(); +const { I, myPage } = inject() ``` -* Added global `secret` function to fill in sensitive data. By **[RohanHart](https://github.com/RohanHart)**: +- Added global `secret` function to fill in sensitive data. By **[RohanHart](https://github.com/RohanHart)**: ```js -I.fillField('password', secret('123456')); -``` - -* [wdioPlugin](https://codecept.io/plugins/#wdio) Added a plugin to **support webdriverio services** including *selenium-standalone*, *sauce*, *browserstack*, etc. **Sponsored by **[GSasu](https://github.com/GSasu)**** -* **[Appium]** Fixed `swipe*` methods by **[PeterNgTr](https://github.com/PeterNgTr)** -* BDD Gherkin Improvements: - * Implemented `run-multiple` for feature files. **Sponsored by **[GSasu](https://github.com/GSasu)**** - * Added `--features` and `--tests` options to `run-multiple`. **Sponsored by **[GSasu](https://github.com/GSasu)**** - * Implemented `Before` and `After` hooks in [step definitions](https://codecept.io/bdd#before) -* Fixed running tests by absolute path. By **[batalov](https://github.com/batalov)**. -* Enabled the adding screenshot to failed test for moch-junit-reporter by **[PeterNgTr](https://github.com/PeterNgTr)**. -* **[Puppeteer]** Implemented `uncheckOption` and fixed behavior of `checkOption` by **[aml2610](https://github.com/aml2610)** -* **[WebDriver]** Fixed `seeTextEquals` on empty strings by **[PeterNgTr](https://github.com/PeterNgTr)** -* **[Puppeteer]** Fixed launch with `browserWSEndpoint` config by **[ngadiyak](https://github.com/ngadiyak)**. -* **[Puppeteer]** Fixed switching back to main window in multi-session mode by **[davertmik](https://github.com/davertmik)**. -* **[autoLoginPlugin]** Fixed using async functions for auto login by **[nitschSB](https://github.com/nitschSB)** +I.fillField('password', secret('123456')) +``` + +- [wdioPlugin](https://codecept.io/plugins/#wdio) Added a plugin to **support webdriverio services** including _selenium-standalone_, _sauce_, _browserstack_, etc. **Sponsored by **[GSasu](https://github.com/GSasu)\*\*\*\* +- **[Appium]** Fixed `swipe*` methods by **[PeterNgTr](https://github.com/PeterNgTr)** +- BDD Gherkin Improvements: + - Implemented `run-multiple` for feature files. **Sponsored by **[GSasu](https://github.com/GSasu)\*\*\*\* + - Added `--features` and `--tests` options to `run-multiple`. **Sponsored by **[GSasu](https://github.com/GSasu)\*\*\*\* + - Implemented `Before` and `After` hooks in [step definitions](https://codecept.io/bdd#before) +- Fixed running tests by absolute path. By **[batalov](https://github.com/batalov)**. +- Enabled the adding screenshot to failed test for moch-junit-reporter by **[PeterNgTr](https://github.com/PeterNgTr)**. +- **[Puppeteer]** Implemented `uncheckOption` and fixed behavior of `checkOption` by **[aml2610](https://github.com/aml2610)** +- **[WebDriver]** Fixed `seeTextEquals` on empty strings by **[PeterNgTr](https://github.com/PeterNgTr)** +- **[Puppeteer]** Fixed launch with `browserWSEndpoint` config by **[ngadiyak](https://github.com/ngadiyak)**. +- **[Puppeteer]** Fixed switching back to main window in multi-session mode by **[davertmik](https://github.com/davertmik)**. +- **[autoLoginPlugin]** Fixed using async functions for auto login by **[nitschSB](https://github.com/nitschSB)** > This release was partly sponsored by **[GSasu](https://github.com/GSasu)**. Thanks for the support! -Do you want to improve this project? [Learn more about sponsorin CodeceptJS - +> Do you want to improve this project? [Learn more about sponsorin CodeceptJS ## 2.0.8 -* **[Puppeteer]** Added `downloadFile` action by **[PeterNgTr](https://github.com/PeterNgTr)**. +- **[Puppeteer]** Added `downloadFile` action by **[PeterNgTr](https://github.com/PeterNgTr)**. Use it with `FileSystem` helper to test availability of a file: + ```js - const fileName = await I.downloadFile('a.file-link'); - I.amInPath('output'); - I.seeFile(fileName); +const fileName = await I.downloadFile('a.file-link') +I.amInPath('output') +I.seeFile(fileName) ``` + > Actions `amInPath` and `seeFile` are taken from [FileSystem](https://codecept.io/helpers/FileSystem) helper -* **[Puppeteer]** Fixed `autoLogin` plugin with Puppeteer by **[davertmik](https://github.com/davertmik)** -* **[WebDriver]** `seeInField` should throw error if element has no value attrubite. By **[PeterNgTr](https://github.com/PeterNgTr)** -* **[WebDriver]** Fixed `seeTextEquals` passes for any string if element is empty by **[PeterNgTr](https://github.com/PeterNgTr)**. -* **[WebDriver]** Internal refctoring to use `el.isDisplayed` to match latest webdriverio implementation. Thanks to **[LukoyanovE](https://github.com/LukoyanovE)** -* [allure plugin] Add ability enable [screenshotDiff plugin](https://github.com/allure-framework/allure2/blob/master/plugins/screen-diff-plugin/README.md) by **[Vorobeyko](https://github.com/Vorobeyko)** -* **[Appium]** Fixed `locator.stringify` call by **[LukoyanovE](https://github.com/LukoyanovE)** +- **[Puppeteer]** Fixed `autoLogin` plugin with Puppeteer by **[davertmik](https://github.com/davertmik)** +- **[WebDriver]** `seeInField` should throw error if element has no value attrubite. By **[PeterNgTr](https://github.com/PeterNgTr)** +- **[WebDriver]** Fixed `seeTextEquals` passes for any string if element is empty by **[PeterNgTr](https://github.com/PeterNgTr)**. +- **[WebDriver]** Internal refctoring to use `el.isDisplayed` to match latest webdriverio implementation. Thanks to **[LukoyanovE](https://github.com/LukoyanovE)** +- [allure plugin] Add ability enable [screenshotDiff plugin](https://github.com/allure-framework/allure2/blob/master/plugins/screen-diff-plugin/README.md) by **[Vorobeyko](https://github.com/Vorobeyko)** +- **[Appium]** Fixed `locator.stringify` call by **[LukoyanovE](https://github.com/LukoyanovE)** ## 2.0.7 -* [WebDriver][Protractor][Nightmare] `rightClick` method implemented (fixed) in a standard way. By **[davertmik](https://github.com/davertmik)** -* **[WebDriver]** Updated WebDriver API calls in helper. By **[PeterNgTr](https://github.com/PeterNgTr)** -* **[stepByStepReportPlugin]** Added `screenshotsForAllureReport` config options to automatically attach screenshots to allure reports. By **[PeterNgTr](https://github.com/PeterNgTr)** -* **[allurePlugin]** Added `addLabel` method by **[Vorobeyko](https://github.com/Vorobeyko)** -* Locator Builder: fixed `withChild` and `withDescendant` to match deep nested siblings by **[Vorobeyko](https://github.com/Vorobeyko)**. +- [WebDriver][Protractor][Nightmare] `rightClick` method implemented (fixed) in a standard way. By **[davertmik](https://github.com/davertmik)** +- **[WebDriver]** Updated WebDriver API calls in helper. By **[PeterNgTr](https://github.com/PeterNgTr)** +- **[stepByStepReportPlugin]** Added `screenshotsForAllureReport` config options to automatically attach screenshots to allure reports. By **[PeterNgTr](https://github.com/PeterNgTr)** +- **[allurePlugin]** Added `addLabel` method by **[Vorobeyko](https://github.com/Vorobeyko)** +- Locator Builder: fixed `withChild` and `withDescendant` to match deep nested siblings by **[Vorobeyko](https://github.com/Vorobeyko)**. ## 2.0.6 -* Introduced [Custom Locator Strategies](https://codecept.io/locators#custom-locators). -* Added [Visual Testing Guide](https://codecept.io/visual) by **[puneet0191](https://github.com/puneet0191)** and **[MitkoTschimev](https://github.com/MitkoTschimev)**. -* **[Puppeteer]** [`puppeteerCoverage`](https://codecept.io/plugins#puppeteercoverage) plugin added to collect code coverage in JS. By **[dvillarama](https://github.com/dvillarama)** -* Make override option in `run-multiple` to respect the generated overridden config by **[kinyat](https://github.com/kinyat)** -* Fixed deep merge for `container.append()`. Introduced `lodash.merge()`. By **[Vorobeyko](https://github.com/Vorobeyko)** -* Fixed saving screenshot on Windows by -* Fix errors on using interactive shell with Allure plugin by tsuemura -* Fixed using dynamic injections with `Scenario().injectDependencies` by **[tsemura](https://github.com/tsemura)** -* [WebDriver][Puppeteer][Nightmare][Protractor] Fixed url protocol detection for non-http urls by **[LukoyanovE](https://github.com/LukoyanovE)** -* **[WebDriver]** Enabled compatibility with `stepByStepReport` by **[tsuemura](https://github.com/tsuemura)** -* **[WebDriver]** Fixed `grabHTMLFrom` to return innerHTML value by **[Holorium](https://github.com/Holorium)**. Fixed compatibility with WebDriverIO. -* **[WebDriver]** `grabHTMLFrom` to return one HTML vlaue for one element matched, array if multiple elements found by **[davertmik](https://github.com/davertmik)**. -* **[Nightmare]** Added `grabHTMLFrom` by **[davertmik](https://github.com/davertmik)** -* Fixed `bootstrapAll` and `teardownAll` launch with path as argument by **[LukoyanovE](https://github.com/LukoyanovE)** -* Fixed `bootstrapAll` and `teardownAll` calls from exported object by **[LukoyanovE](https://github.com/LukoyanovE)** -* **[WebDriver]** Added possibility to define conditional checks interval for `waitUntil` by **[LukoyanovE](https://github.com/LukoyanovE)** -* Fixed storing current data in data driven tests in a test object. By **[Vorobeyko](https://github.com/Vorobeyko)** -* **[WebDriver]** Fixed `hostname` config option overwrite when setting a cloud provider. By **[LukoyanovE](https://github.com/LukoyanovE)** -* **[WebDriver]** `dragSlider` method implemented by **[DavertMik](https://github.com/DavertMik)** -* **[WebDrover]** Fixed `scrollTo` to use new webdriverio API by **[PeterNgTr](https://github.com/PeterNgTr)** -* Added Japanese translation file by **[tsemura](https://github.com/tsemura)** -* Added `Locator.withDescendant()` method to find an element which contains a descendant (child, grandchild) by **[Vorobeyko](https://github.com/Vorobeyko)** -* **[WebDriver]** Fixed configuring capabilities for Selenoid and IE by **[Vorobeyko](https://github.com/Vorobeyko)** -* **[WebDriver]** Restore original window size when taking full size screenshot by **[tsuemura](https://github.com/tsuemura)** -* Enabled `throws()`,` fails()`, `retry()`, `timeout()`, `config()` functions for data driven tests. By **[jjm409](https://github.com/jjm409)** +- Introduced [Custom Locator Strategies](https://codecept.io/locators#custom-locators). +- Added [Visual Testing Guide](https://codecept.io/visual) by **[puneet0191](https://github.com/puneet0191)** and **[MitkoTschimev](https://github.com/MitkoTschimev)**. +- **[Puppeteer]** [`puppeteerCoverage`](https://codecept.io/plugins#puppeteercoverage) plugin added to collect code coverage in JS. By **[dvillarama](https://github.com/dvillarama)** +- Make override option in `run-multiple` to respect the generated overridden config by **[kinyat](https://github.com/kinyat)** +- Fixed deep merge for `container.append()`. Introduced `lodash.merge()`. By **[Vorobeyko](https://github.com/Vorobeyko)** +- Fixed saving screenshot on Windows by +- Fix errors on using interactive shell with Allure plugin by tsuemura +- Fixed using dynamic injections with `Scenario().injectDependencies` by **[tsemura](https://github.com/tsemura)** +- [WebDriver][Puppeteer][Nightmare][Protractor] Fixed url protocol detection for non-http urls by **[LukoyanovE](https://github.com/LukoyanovE)** +- **[WebDriver]** Enabled compatibility with `stepByStepReport` by **[tsuemura](https://github.com/tsuemura)** +- **[WebDriver]** Fixed `grabHTMLFrom` to return innerHTML value by **[Holorium](https://github.com/Holorium)**. Fixed compatibility with WebDriverIO. +- **[WebDriver]** `grabHTMLFrom` to return one HTML vlaue for one element matched, array if multiple elements found by **[davertmik](https://github.com/davertmik)**. +- **[Nightmare]** Added `grabHTMLFrom` by **[davertmik](https://github.com/davertmik)** +- Fixed `bootstrapAll` and `teardownAll` launch with path as argument by **[LukoyanovE](https://github.com/LukoyanovE)** +- Fixed `bootstrapAll` and `teardownAll` calls from exported object by **[LukoyanovE](https://github.com/LukoyanovE)** +- **[WebDriver]** Added possibility to define conditional checks interval for `waitUntil` by **[LukoyanovE](https://github.com/LukoyanovE)** +- Fixed storing current data in data driven tests in a test object. By **[Vorobeyko](https://github.com/Vorobeyko)** +- **[WebDriver]** Fixed `hostname` config option overwrite when setting a cloud provider. By **[LukoyanovE](https://github.com/LukoyanovE)** +- **[WebDriver]** `dragSlider` method implemented by **[DavertMik](https://github.com/DavertMik)** +- **[WebDrover]** Fixed `scrollTo` to use new webdriverio API by **[PeterNgTr](https://github.com/PeterNgTr)** +- Added Japanese translation file by **[tsemura](https://github.com/tsemura)** +- Added `Locator.withDescendant()` method to find an element which contains a descendant (child, grandchild) by **[Vorobeyko](https://github.com/Vorobeyko)** +- **[WebDriver]** Fixed configuring capabilities for Selenoid and IE by **[Vorobeyko](https://github.com/Vorobeyko)** +- **[WebDriver]** Restore original window size when taking full size screenshot by **[tsuemura](https://github.com/tsuemura)** +- Enabled `throws()`,` fails()`, `retry()`, `timeout()`, `config()` functions for data driven tests. By **[jjm409](https://github.com/jjm409)** ## 2.0.5 @@ -2908,60 +3418,58 @@ Use it with `FileSystem` helper to test availability of a file: ## 2.0.4 -* [WebDriver][Protractor][Nightmare][Puppeteer] `grabAttributeFrom` returns an array when multiple elements matched. By **[PeterNgTr](https://github.com/PeterNgTr)** -* [autoLogin plugin] Fixed merging users config by **[nealfennimore](https://github.com/nealfennimore)** -* [autoDelay plugin] Added WebDriver to list of supported helpers by **[mattin4d](https://github.com/mattin4d)** -* **[Appium]** Fixed using locators in `waitForElement`, `waitForVisible`, `waitForInvisible`. By **[eduardofinotti](https://github.com/eduardofinotti)** -* [allure plugin] Add tags to allure reports by **[Vorobeyko](https://github.com/Vorobeyko)** -* [allure plugin] Add skipped tests to allure reports by **[Vorobeyko](https://github.com/Vorobeyko)** -* Fixed `Logged Test name | [object Object]` when used Data().Scenario(). By **[Vorobeyko](https://github.com/Vorobeyko)** -* Fixed Data().only.Scenario() to run for all datasets. By **[Vorobeyko](https://github.com/Vorobeyko)** -* **[WebDriver]** `attachFile` to work with hidden elements. Fixed in [#1460](https://github.com/codeceptjs/CodeceptJS/issues/1460) by **[tsuemura](https://github.com/tsuemura)** - - +- [WebDriver][Protractor][Nightmare][Puppeteer] `grabAttributeFrom` returns an array when multiple elements matched. By **[PeterNgTr](https://github.com/PeterNgTr)** +- [autoLogin plugin] Fixed merging users config by **[nealfennimore](https://github.com/nealfennimore)** +- [autoDelay plugin] Added WebDriver to list of supported helpers by **[mattin4d](https://github.com/mattin4d)** +- **[Appium]** Fixed using locators in `waitForElement`, `waitForVisible`, `waitForInvisible`. By **[eduardofinotti](https://github.com/eduardofinotti)** +- [allure plugin] Add tags to allure reports by **[Vorobeyko](https://github.com/Vorobeyko)** +- [allure plugin] Add skipped tests to allure reports by **[Vorobeyko](https://github.com/Vorobeyko)** +- Fixed `Logged Test name | [object Object]` when used Data().Scenario(). By **[Vorobeyko](https://github.com/Vorobeyko)** +- Fixed Data().only.Scenario() to run for all datasets. By **[Vorobeyko](https://github.com/Vorobeyko)** +- **[WebDriver]** `attachFile` to work with hidden elements. Fixed in [#1460](https://github.com/codeceptjs/CodeceptJS/issues/1460) by **[tsuemura](https://github.com/tsuemura)** ## 2.0.3 -* [**autoLogin plugin**](https://codecept.io/plugins#autologin) added. Allows to log in once and reuse browser session. When session expires - automatically logs in again. Can persist session between runs by saving cookies to file. -* Fixed `Maximum stack trace` issue in `retryFailedStep` plugin. -* Added `locate()` function into the interactive shell. -* **[WebDriver]** Disabled smartWait for interactive shell. -* **[Appium]** Updated methods to use for mobile locators - * `waitForElement` - * `waitForVisible` - * `waitForInvisible` -* Helper and page object generators no longer update config automatically. Please add your page objects and helpers manually. +- [**autoLogin plugin**](https://codecept.io/plugins#autologin) added. Allows to log in once and reuse browser session. When session expires - automatically logs in again. Can persist session between runs by saving cookies to file. +- Fixed `Maximum stack trace` issue in `retryFailedStep` plugin. +- Added `locate()` function into the interactive shell. +- **[WebDriver]** Disabled smartWait for interactive shell. +- **[Appium]** Updated methods to use for mobile locators + - `waitForElement` + - `waitForVisible` + - `waitForInvisible` +- Helper and page object generators no longer update config automatically. Please add your page objects and helpers manually. ## 2.0.2 -* **[Puppeteer]** Improved handling of connection with remote browser using Puppeteer by **[martomo](https://github.com/martomo)** -* **[WebDriver]** Updated to webdriverio 5.2.2 by **[martomo](https://github.com/martomo)** -* Interactive pause improvements by **[davertmik](https://github.com/davertmik)** - * Disable retryFailedStep plugin in in interactive mode - * Removes `Interface: parseInput` while in interactive pause -* **[ApiDataFactory]** Improvements - * added `fetchId` config option to override id retrieval from payload - * added `onRequest` config option to update request in realtime - * added `returnId` config option to return ids of created items instead of items themvelves - * added `headers` config option to override default headers. - * added a new chapter into [DataManagement](https://codecept.io/data#api-requests-using-browser-session) -* **[REST]** Added `onRequest` config option - +- **[Puppeteer]** Improved handling of connection with remote browser using Puppeteer by **[martomo](https://github.com/martomo)** +- **[WebDriver]** Updated to webdriverio 5.2.2 by **[martomo](https://github.com/martomo)** +- Interactive pause improvements by **[davertmik](https://github.com/davertmik)** + - Disable retryFailedStep plugin in in interactive mode + - Removes `Interface: parseInput` while in interactive pause +- **[ApiDataFactory]** Improvements + - added `fetchId` config option to override id retrieval from payload + - added `onRequest` config option to update request in realtime + - added `returnId` config option to return ids of created items instead of items themvelves + - added `headers` config option to override default headers. + - added a new chapter into [DataManagement](https://codecept.io/data#api-requests-using-browser-session) +- **[REST]** Added `onRequest` config option ## 2.0.1 -* Fixed creating project with `codecept init`. -* Fixed error while installing webdriverio@5. -* Added code beautifier for generated configs. -* **[WebDriver]** Updated to webdriverio 5.1.0 +- Fixed creating project with `codecept init`. +- Fixed error while installing webdriverio@5. +- Added code beautifier for generated configs. +- **[WebDriver]** Updated to webdriverio 5.1.0 ## 2.0.0 -* **[WebDriver]** **Breaking Change.** Updated to webdriverio v5. New helper **WebDriver** helper introduced. +- **[WebDriver]** **Breaking Change.** Updated to webdriverio v5. New helper **WebDriver** helper introduced. - * **Upgrade plan**: + - **Upgrade plan**: 1. Install latest webdriverio + ``` npm install webdriverio@5 --save ``` @@ -2972,138 +3480,139 @@ Use it with `FileSystem` helper to test availability of a file: > If you face issues using webdriverio v5 you can still use webdriverio 4.x and WebDriverIO helper. Make sure you have `webdriverio: ^4.0` installed. - * Known issues: `attachFile` doesn't work with proxy server. + - Known issues: `attachFile` doesn't work with proxy server. -* **[Appium]** **Breaking Change.** Updated to use webdriverio v5 as well. See upgrade plan ↑ -* **[REST]** **Breaking Change.** Replaced `unirest` library with `axios`. +- **[Appium]** **Breaking Change.** Updated to use webdriverio v5 as well. See upgrade plan ↑ +- **[REST]** **Breaking Change.** Replaced `unirest` library with `axios`. - * **Upgrade plan**: + - **Upgrade plan**: 1. Refer to [axios API](https://github.com/axios/axios). 2. If you were using `unirest` requests/responses in your tests change them to axios format. -* **Breaking Change.** Generators support in tests removed. Use `async/await` in your tests -* **Using `codecept.conf.js` as default configuration format** -* Fixed "enametoolong" error when saving screenshots for data driven tests by **[PeterNgTr](https://github.com/PeterNgTr)** -* Updated NodeJS to 10 in Docker image -* **[Pupeteer]** Add support to use WSEndpoint. Allows to execute tests remotely. [See [#1350](https://github.com/codeceptjs/CodeceptJS/issues/1350)] by **[gabrielcaires](https://github.com/gabrielcaires)** (https://github.com/codeceptjs/CodeceptJS/pull/1350) -* In interactive shell **[Enter]** goes to next step. Improvement by **[PeterNgTr](https://github.com/PeterNgTr)**. -* `I.say` accepts second parameter as color to print colorful comments. Improvement by **[PeterNgTr](https://github.com/PeterNgTr)**. + +- **Breaking Change.** Generators support in tests removed. Use `async/await` in your tests +- **Using `codecept.conf.js` as default configuration format** +- Fixed "enametoolong" error when saving screenshots for data driven tests by **[PeterNgTr](https://github.com/PeterNgTr)** +- Updated NodeJS to 10 in Docker image +- **[Pupeteer]** Add support to use WSEndpoint. Allows to execute tests remotely. [See [#1350](https://github.com/codeceptjs/CodeceptJS/issues/1350)] by **[gabrielcaires](https://github.com/gabrielcaires)** (https://github.com/codeceptjs/CodeceptJS/pull/1350) +- In interactive shell **[Enter]** goes to next step. Improvement by **[PeterNgTr](https://github.com/PeterNgTr)**. +- `I.say` accepts second parameter as color to print colorful comments. Improvement by **[PeterNgTr](https://github.com/PeterNgTr)**. ```js -I.say('This is red', 'red'); //red is used -I.say('This is blue', 'blue'); //blue is used -I.say('This is by default'); //cyan is used +I.say('This is red', 'red') //red is used +I.say('This is blue', 'blue') //blue is used +I.say('This is by default') //cyan is used ``` -* Fixed allure reports for multi session testing by **[PeterNgTr](https://github.com/PeterNgTr)** -* Fixed allure reports for hooks by **[PeterNgTr](https://github.com/PeterNgTr)** + +- Fixed allure reports for multi session testing by **[PeterNgTr](https://github.com/PeterNgTr)** +- Fixed allure reports for hooks by **[PeterNgTr](https://github.com/PeterNgTr)** ## 1.4.6 -* **[Puppeteer]** `dragSlider` action added by **[PeterNgTr](https://github.com/PeterNgTr)** -* **[Puppeteer]** Fixed opening browser in shell mode by **[allenhwkim](https://github.com/allenhwkim)** -* **[Puppeteer]** Fixed making screenshot on additional sessions by **[PeterNgTr](https://github.com/PeterNgTr)**. Fixes [#1266](https://github.com/codeceptjs/CodeceptJS/issues/1266) -* Added `--invert` option to `run-multiple` command by **[LukoyanovE](https://github.com/LukoyanovE)** -* Fixed steps in Allure reports by **[PeterNgTr](https://github.com/PeterNgTr)** -* Add option `output` to customize output directory in [stepByStepReport plugin](https://codecept.io/plugins/#stepbystepreport). By **[fpsthirty](https://github.com/fpsthirty)** -* Changed type definition of PageObjects to get auto completion by **[rhicu](https://github.com/rhicu)** -* Fixed steps output for async/arrow functions in CLI by **[LukoyanovE](https://github.com/LukoyanovE)**. See [#1329](https://github.com/codeceptjs/CodeceptJS/issues/1329) +- **[Puppeteer]** `dragSlider` action added by **[PeterNgTr](https://github.com/PeterNgTr)** +- **[Puppeteer]** Fixed opening browser in shell mode by **[allenhwkim](https://github.com/allenhwkim)** +- **[Puppeteer]** Fixed making screenshot on additional sessions by **[PeterNgTr](https://github.com/PeterNgTr)**. Fixes [#1266](https://github.com/codeceptjs/CodeceptJS/issues/1266) +- Added `--invert` option to `run-multiple` command by **[LukoyanovE](https://github.com/LukoyanovE)** +- Fixed steps in Allure reports by **[PeterNgTr](https://github.com/PeterNgTr)** +- Add option `output` to customize output directory in [stepByStepReport plugin](https://codecept.io/plugins/#stepbystepreport). By **[fpsthirty](https://github.com/fpsthirty)** +- Changed type definition of PageObjects to get auto completion by **[rhicu](https://github.com/rhicu)** +- Fixed steps output for async/arrow functions in CLI by **[LukoyanovE](https://github.com/LukoyanovE)**. See [#1329](https://github.com/codeceptjs/CodeceptJS/issues/1329) ## 1.4.5 -* Add **require** param to main config. Allows to require Node modules before executing tests. By **[LukoyanovE](https://github.com/LukoyanovE)**. For example: - * Use `ts-node/register` to register TypeScript parser - * Use `should` to register should-style assertions +- Add **require** param to main config. Allows to require Node modules before executing tests. By **[LukoyanovE](https://github.com/LukoyanovE)**. For example: + - Use `ts-node/register` to register TypeScript parser + - Use `should` to register should-style assertions ```js "require": ["ts-node/register", "should"] ``` -* **[WebDriverIO]** Fix timeouts definition to be compatible with W3C drivers. By **[LukoyanovE](https://github.com/LukoyanovE)** -* Fixed: exception in Before block w/ Mocha causes test not to report failure. See [#1292](https://github.com/codeceptjs/CodeceptJS/issues/1292) by **[PeterNgTr](https://github.com/PeterNgTr)** -* Command `run-parallel` now accepts `--override` flag. Thanks to **[ClemCB](https://github.com/ClemCB)** -* Fixed Allure report with Before/BeforeSuite/After/AfterSuite steps. By **[PeterNgTr](https://github.com/PeterNgTr)** -* Added `RUN_MULTIPLE` env variable to [Docker config](https://codecept.io/docker/). Allows to run tests in parallel inside a container. Thanks to **[PeterNgTr](https://github.com/PeterNgTr)** -* **[Mochawesome]** Fixed showing screenshot on failure. Fix by **[PeterNgTr](https://github.com/PeterNgTr)** -* Fixed running tests filtering by tag names defined via `Scenario.tag()` +- **[WebDriverIO]** Fix timeouts definition to be compatible with W3C drivers. By **[LukoyanovE](https://github.com/LukoyanovE)** +- Fixed: exception in Before block w/ Mocha causes test not to report failure. See [#1292](https://github.com/codeceptjs/CodeceptJS/issues/1292) by **[PeterNgTr](https://github.com/PeterNgTr)** +- Command `run-parallel` now accepts `--override` flag. Thanks to **[ClemCB](https://github.com/ClemCB)** +- Fixed Allure report with Before/BeforeSuite/After/AfterSuite steps. By **[PeterNgTr](https://github.com/PeterNgTr)** +- Added `RUN_MULTIPLE` env variable to [Docker config](https://codecept.io/docker/). Allows to run tests in parallel inside a container. Thanks to **[PeterNgTr](https://github.com/PeterNgTr)** +- **[Mochawesome]** Fixed showing screenshot on failure. Fix by **[PeterNgTr](https://github.com/PeterNgTr)** +- Fixed running tests filtering by tag names defined via `Scenario.tag()` ## 1.4.4 -* [autoDelay plugin](https://codecept.io/plugins/#autoDelay) added. Adds tiny delay before and after an action so the page could react to actions performed. -* **[Puppeteer]** improvements by **[luismanuel001](https://github.com/luismanuel001)** - * `click` no longer waits for navigation - * `clickLink` method added. Performs a click and waits for navigation. -* Bootstrap scripts to be started only for `run` command and ignored on `list`, `def`, etc. Fix by **[LukoyanovE](https://github.com/LukoyanovE)** - +- [autoDelay plugin](https://codecept.io/plugins/#autoDelay) added. Adds tiny delay before and after an action so the page could react to actions performed. +- **[Puppeteer]** improvements by **[luismanuel001](https://github.com/luismanuel001)** + - `click` no longer waits for navigation + - `clickLink` method added. Performs a click and waits for navigation. +- Bootstrap scripts to be started only for `run` command and ignored on `list`, `def`, etc. Fix by **[LukoyanovE](https://github.com/LukoyanovE)** ## 1.4.3 -* Groups renamed to Tags for compatibility with BDD layer -* Test and suite objects to contain tags property which can be accessed from internal API -* Fixed adding tags for Scenario Outline in BDD -* Added `tag()` method to ScenarioConfig and FeatureConfig: +- Groups renamed to Tags for compatibility with BDD layer +- Test and suite objects to contain tags property which can be accessed from internal API +- Fixed adding tags for Scenario Outline in BDD +- Added `tag()` method to ScenarioConfig and FeatureConfig: ```js Scenario('update user profile', () => { // test goes here -}).tag('@slow'); +}).tag('@slow') ``` -* Fixed attaching Allure screenshot on exception. Fix by **[DevinWatson](https://github.com/DevinWatson)** -* Improved type definitions for custom steps. By **[Akxe](https://github.com/Akxe)** -* Fixed setting `multiple.parallel.chunks` as environment variable in config. See [#1238](https://github.com/codeceptjs/CodeceptJS/issues/1238) by **[ngadiyak](https://github.com/ngadiyak)** +- Fixed attaching Allure screenshot on exception. Fix by **[DevinWatson](https://github.com/DevinWatson)** +- Improved type definitions for custom steps. By **[Akxe](https://github.com/Akxe)** +- Fixed setting `multiple.parallel.chunks` as environment variable in config. See [#1238](https://github.com/codeceptjs/CodeceptJS/issues/1238) by **[ngadiyak](https://github.com/ngadiyak)** ## 1.4.2 -* Fixed setting config for plugins (inclunding setting `outputDir` for allure) by **[jplegoff](https://github.com/jplegoff)** +- Fixed setting config for plugins (inclunding setting `outputDir` for allure) by **[jplegoff](https://github.com/jplegoff)** ## 1.4.1 -* Added `plugins` option to `run-multiple` -* Minor output fixes -* Added Type Definition for Helper class by **[Akxe](https://github.com/Akxe)** -* Fixed extracing devault extension in generators by **[Akxe](https://github.com/Akxe)** +- Added `plugins` option to `run-multiple` +- Minor output fixes +- Added Type Definition for Helper class by **[Akxe](https://github.com/Akxe)** +- Fixed extracing devault extension in generators by **[Akxe](https://github.com/Akxe)** ## 1.4.0 -* [**Allure Reporter Integration**](https://codecept.io/reports/#allure). Full inegration with Allure Server. Get nicely looking UI for tests,including steps, nested steps, and screenshots. Thanks **Natarajan Krishnamurthy **[krish](https://github.com/krish)**** for sponsoring this feature. -* [Plugins API introduced](https://codecept.io/hooks/#plugins). Create custom plugins for CodeceptJS by hooking into event dispatcher, and using promise recorder. -* **Official [CodeceptJS plugins](https://codecept.io/plugins) added**: - * **`stepByStepReport` - creates nicely looking report to see test execution as a slideshow**. Use this plugin to debug tests in headless environment without recording a video. - * `allure` - Allure reporter added as plugin. - * `screenshotOnFail` - saves screenshot on fail. Replaces similar functionality from helpers. - * `retryFailedStep` - to rerun each failed step. -* **[Puppeteer]** Fix `executeAsyncScript` unexpected token by **[jonathanz](https://github.com/jonathanz)** -* Added `override` option to `run-multiple` command by **[svarlet](https://github.com/svarlet)** +- [**Allure Reporter Integration**](https://codecept.io/reports/#allure). Full inegration with Allure Server. Get nicely looking UI for tests,including steps, nested steps, and screenshots. Thanks **Natarajan Krishnamurthy **[krish](https://github.com/krish)\*\*\*\* for sponsoring this feature. +- [Plugins API introduced](https://codecept.io/hooks/#plugins). Create custom plugins for CodeceptJS by hooking into event dispatcher, and using promise recorder. +- **Official [CodeceptJS plugins](https://codecept.io/plugins) added**: + - **`stepByStepReport` - creates nicely looking report to see test execution as a slideshow**. Use this plugin to debug tests in headless environment without recording a video. + - `allure` - Allure reporter added as plugin. + - `screenshotOnFail` - saves screenshot on fail. Replaces similar functionality from helpers. + - `retryFailedStep` - to rerun each failed step. +- **[Puppeteer]** Fix `executeAsyncScript` unexpected token by **[jonathanz](https://github.com/jonathanz)** +- Added `override` option to `run-multiple` command by **[svarlet](https://github.com/svarlet)** ## 1.3.3 -* Added `initGlobals()` function to API of [custom runner](https://codecept.io/hooks/#custom-runner). +- Added `initGlobals()` function to API of [custom runner](https://codecept.io/hooks/#custom-runner). ## 1.3.2 -* Interactve Shell improvements for `pause()` - * Added `next` command for **step-by-step debug** when using `pause()`. - * Use `After(pause);` in a to start interactive console after last step. -* **[Puppeteer]** Updated to Puppeteer 1.6.0 - * Added `waitForRequest` to wait for network request. - * Added `waitForResponse` to wait for network response. -* Improved TypeScript definitions to support custom steps and page objects. By **[xt1](https://github.com/xt1)** -* Fixed XPath detection to accept XPath which starts with `./` by **[BenoitZugmeyer](https://github.com/BenoitZugmeyer)** +- Interactve Shell improvements for `pause()` + - Added `next` command for **step-by-step debug** when using `pause()`. + - Use `After(pause);` in a to start interactive console after last step. +- **[Puppeteer]** Updated to Puppeteer 1.6.0 + - Added `waitForRequest` to wait for network request. + - Added `waitForResponse` to wait for network response. +- Improved TypeScript definitions to support custom steps and page objects. By **[xt1](https://github.com/xt1)** +- Fixed XPath detection to accept XPath which starts with `./` by **[BenoitZugmeyer](https://github.com/BenoitZugmeyer)** ## 1.3.1 -* BDD-Gherkin: Fixed running async steps. -* **[Puppeteer]** Fixed process hanging for 30 seconds. Page loading timeout default via `getPageTimeout` set 0 seconds. -* **[Puppeteer]** Improved displaying client-side console messages in debug mode. -* **[Puppeteer]** Fixed closing sessions in `restart:false` mode for multi-session mode. -* **[Protractor]** Fixed `grabPopupText` to not throw error popup is not opened. -* **[Protractor]** Added info on using 'direct' Protractor driver to helper documentation by **[xt1](https://github.com/xt1)**. -* **[WebDriverIO]** Added a list of all special keys to WebDriverIO helper by **[davertmik](https://github.com/davertmik)** and **[xt1](https://github.com/xt1)**. -* Improved TypeScript definitions generator by **[xt1](https://github.com/xt1)** +- BDD-Gherkin: Fixed running async steps. +- **[Puppeteer]** Fixed process hanging for 30 seconds. Page loading timeout default via `getPageTimeout` set 0 seconds. +- **[Puppeteer]** Improved displaying client-side console messages in debug mode. +- **[Puppeteer]** Fixed closing sessions in `restart:false` mode for multi-session mode. +- **[Protractor]** Fixed `grabPopupText` to not throw error popup is not opened. +- **[Protractor]** Added info on using 'direct' Protractor driver to helper documentation by **[xt1](https://github.com/xt1)**. +- **[WebDriverIO]** Added a list of all special keys to WebDriverIO helper by **[davertmik](https://github.com/davertmik)** and **[xt1](https://github.com/xt1)**. +- Improved TypeScript definitions generator by **[xt1](https://github.com/xt1)** ## 1.3.0 -* **Cucumber-style BDD. Introduced [Gherkin support](https://codecept.io/bdd). Thanks to [David Vins](https://github.com/dvins) and [Omedym](https://www.omedym.com) for sponsoring this feature**. +- **Cucumber-style BDD. Introduced [Gherkin support](https://codecept.io/bdd). Thanks to [David Vins](https://github.com/dvins) and [Omedym](https://www.omedym.com) for sponsoring this feature**. Basic feature file: @@ -3120,11 +3629,11 @@ Feature: Business rules Step definition: ```js -const I = actor(); +const I = actor() Given('I need to open Google', () => { - I.amOnPage('https://google.com'); -}); + I.amOnPage('https://google.com') +}) ``` Run it with `--features --steps` flag: @@ -3135,66 +3644,68 @@ codeceptjs run --steps --features --- -* **Brekaing Chnage** `run` command now uses relative path + test name to run exactly one test file. +- **Brekaing Chnage** `run` command now uses relative path + test name to run exactly one test file. Previous behavior (removed): + ``` codeceptjs run basic_test.js ``` + Current behavior (relative path to config + a test name) ``` codeceptjs run tests/basic_test.js ``` + This change allows using auto-completion when running a specific test. --- -* Nested steps output enabled for page objects. - * to see high-level steps only run tests with `--steps` flag. - * to see PageObjects implementation run tests with `--debug`. -* PageObjects simplified to remove `_init()` extra method. Try updated generators and see [updated guide](https://codecept.io/pageobjects/#pageobject). -* **[Puppeteer]** [Multiple sessions](https://codecept.io/acceptance/#multiple-sessions) enabled. Requires Puppeteer >= 1.5 -* **[Puppeteer]** Stability improvement. Waits for for `load` event on page load. This strategy can be changed in config: - * `waitForNavigation` config option introduced. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions) - * `getPageTimeout` config option to set maximum navigation time in milliseconds. Default is 30 seconds. - * `waitForNavigation` method added. Explicitly waits for navigation to be finished. -* [WebDriverIO][Protractor][Puppeteer][Nightmare] **Possible BC** `grabTextFrom` unified. Return a text for single matched element and an array of texts for multiple elements. -* [Puppeteer]Fixed `resizeWindow` by **[sergejkaravajnij](https://github.com/sergejkaravajnij)** -* [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForFunction` added. Waits for client-side JavaScript function to return true by **[GREENpoint](https://github.com/GREENpoint)**. -* **[Puppeteer]** `waitUntil` deprecated in favor of `waitForFunction`. -* Added `filter` function to DataTable. -* Send non-nested array of files to custom parallel execution chunking by **[mikecbrant](https://github.com/mikecbrant)**. -* Fixed invalid output directory path for run-multiple by **[mikecbrant](https://github.com/mikecbrant)**. -* **[WebDriverIO]** `waitUntil` timeout accepts time in seconds (as all other wait* functions). Fix by **[truesrc](https://github.com/truesrc)**. -* **[Nightmare]** Fixed `grabNumberOfVisibleElements` to work similarly to `seeElement`. Thx to **[stefanschenk](https://github.com/stefanschenk)** and Jinbo Jinboson. -* **[Protractor]** Fixed alert handling error with message 'no such alert' by **[truesrc](https://github.com/truesrc)**. - +- Nested steps output enabled for page objects. + - to see high-level steps only run tests with `--steps` flag. + - to see PageObjects implementation run tests with `--debug`. +- PageObjects simplified to remove `_init()` extra method. Try updated generators and see [updated guide](https://codecept.io/pageobjects/#pageobject). +- **[Puppeteer]** [Multiple sessions](https://codecept.io/acceptance/#multiple-sessions) enabled. Requires Puppeteer >= 1.5 +- **[Puppeteer]** Stability improvement. Waits for for `load` event on page load. This strategy can be changed in config: + - `waitForNavigation` config option introduced. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions) + - `getPageTimeout` config option to set maximum navigation time in milliseconds. Default is 30 seconds. + - `waitForNavigation` method added. Explicitly waits for navigation to be finished. +- [WebDriverIO][Protractor][Puppeteer][Nightmare] **Possible BC** `grabTextFrom` unified. Return a text for single matched element and an array of texts for multiple elements. +- [Puppeteer]Fixed `resizeWindow` by **[sergejkaravajnij](https://github.com/sergejkaravajnij)** +- [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForFunction` added. Waits for client-side JavaScript function to return true by **[GREENpoint](https://github.com/GREENpoint)**. +- **[Puppeteer]** `waitUntil` deprecated in favor of `waitForFunction`. +- Added `filter` function to DataTable. +- Send non-nested array of files to custom parallel execution chunking by **[mikecbrant](https://github.com/mikecbrant)**. +- Fixed invalid output directory path for run-multiple by **[mikecbrant](https://github.com/mikecbrant)**. +- **[WebDriverIO]** `waitUntil` timeout accepts time in seconds (as all other wait\* functions). Fix by **[truesrc](https://github.com/truesrc)**. +- **[Nightmare]** Fixed `grabNumberOfVisibleElements` to work similarly to `seeElement`. Thx to **[stefanschenk](https://github.com/stefanschenk)** and Jinbo Jinboson. +- **[Protractor]** Fixed alert handling error with message 'no such alert' by **[truesrc](https://github.com/truesrc)**. ## 1.2.1 -* Fixed running `I.retry()` on multiple steps. -* Fixed parallel execution wih chunks. -* **[Puppeteer]** Fixed `grabNumberOfVisibleElements` to return `0` instead of throwing error if no elements are found. +- Fixed running `I.retry()` on multiple steps. +- Fixed parallel execution wih chunks. +- **[Puppeteer]** Fixed `grabNumberOfVisibleElements` to return `0` instead of throwing error if no elements are found. ## 1.2.0 -* [WebDriverIO][Protractor][Multiple Sessions](https://codecept.io/acceptance/#multiple-sessions). Run several browser sessions in one test. Introduced `session` command, which opens additional browser window and closes it after a test. +- [WebDriverIO][Protractor][Multiple Sessions](https://codecept.io/acceptance/#multiple-sessions). Run several browser sessions in one test. Introduced `session` command, which opens additional browser window and closes it after a test. ```js -Scenario('run in different browsers', (I) => { - I.amOnPage('/hello'); - I.see('Hello!'); +Scenario('run in different browsers', I => { + I.amOnPage('/hello') + I.see('Hello!') session('john', () => { - I.amOnPage('/bye'); - I.dontSee('Hello'); - I.see('Bye'); - }); - I.see('Hello'); -}); + I.amOnPage('/bye') + I.dontSee('Hello') + I.see('Bye') + }) + I.see('Hello') +}) ``` -* [Parallel Execution](https://codecept.io/advanced/#parallel-execution) by **[sveneisenschmidt](https://github.com/sveneisenschmidt)**. Run tests in parallel specifying number of chunks: +- [Parallel Execution](https://codecept.io/advanced/#parallel-execution) by **[sveneisenschmidt](https://github.com/sveneisenschmidt)**. Run tests in parallel specifying number of chunks: ```js "multiple": { @@ -3207,244 +3718,239 @@ Scenario('run in different browsers', (I) => { } ``` -* [Locator Builder](https://codecept.io/locators). Write complex locators with simplest API combining CSS and XPath: +- [Locator Builder](https://codecept.io/locators). Write complex locators with simplest API combining CSS and XPath: ```js // select 'Edit' link inside 2nd row of a table -locate('//table') - .find('tr') - .at(2) - .find('a') - .withText('Edit'); +locate('//table').find('tr').at(2).find('a').withText('Edit') ``` -* [Dynamic configuration](https://codecept.io/advanced/#dynamic-configuration) to update helpers config per test or per suite. -* Added `event.test.finished` which fires synchronously for both failed and passed tests. -* [WebDriverIO][Protractor][Nightmare][Puppeteer] Full page screenshots on failure disabled by default. See [issue[#1600](https://github.com/codeceptjs/CodeceptJS/issues/1600). You can enabled them with `fullPageScreenshots: true`, however they may work unstable in Selenium. -* `within` blocks can return values. See [updated documentation](https://codecept.io/basics/#within). -* Removed doublt call to `_init` in helpers. Fixes issue [#1036](https://github.com/codeceptjs/CodeceptJS/issues/1036) -* Added scenario and feature configuration via fluent API: +- [Dynamic configuration](https://codecept.io/advanced/#dynamic-configuration) to update helpers config per test or per suite. +- Added `event.test.finished` which fires synchronously for both failed and passed tests. +- [WebDriverIO][Protractor][Nightmare][Puppeteer] Full page screenshots on failure disabled by default. See [issue[#1600](https://github.com/codeceptjs/CodeceptJS/issues/1600). You can enabled them with `fullPageScreenshots: true`, however they may work unstable in Selenium. +- `within` blocks can return values. See [updated documentation](https://codecept.io/basics/#within). +- Removed doublt call to `_init` in helpers. Fixes issue [#1036](https://github.com/codeceptjs/CodeceptJS/issues/1036) +- Added scenario and feature configuration via fluent API: ```js -Feature('checkout') - .timeout(3000) - .retry(2); +Feature('checkout').timeout(3000).retry(2) -Scenario('user can order in firefox', (I) => { +Scenario('user can order in firefox', I => { // see dynamic configuration -}).config({ browser: 'firefox' }) - .timeout(20000); +}) + .config({ browser: 'firefox' }) + .timeout(20000) -Scenario('this test should throw error', (I) => { +Scenario('this test should throw error', I => { // I.amOnPage -}).throws(new Error); +}).throws(new Error()) ``` ## 1.1.8 -* Fixed generating TypeScript definitions with `codeceptjs def`. -* Added Chinese translation ("zh-CN" and "zh-TW") by **[TechQuery](https://github.com/TechQuery)**. -* Fixed running tests from a different folder specified by `-c` option. -* **[Puppeteer]** Added support for hash handling in URL by **[gavoja](https://github.com/gavoja)**. -* **[Puppeteer]** Fixed setting viewport size by **[gavoja](https://github.com/gavoja)**. See [Puppeteer issue](https://github.com/GoogleChrome/puppeteer/issues/1183) - +- Fixed generating TypeScript definitions with `codeceptjs def`. +- Added Chinese translation ("zh-CN" and "zh-TW") by **[TechQuery](https://github.com/TechQuery)**. +- Fixed running tests from a different folder specified by `-c` option. +- **[Puppeteer]** Added support for hash handling in URL by **[gavoja](https://github.com/gavoja)**. +- **[Puppeteer]** Fixed setting viewport size by **[gavoja](https://github.com/gavoja)**. See [Puppeteer issue](https://github.com/GoogleChrome/puppeteer/issues/1183) ## 1.1.7 -* Docker Image updateed. [See updated reference](https://codecept.io/docker/): - * codeceptjs package is mounted as `/codecept` insde container - * tests directory is expected to be mounted as `/tests` - * `codeceptjs` global runner added (symlink to `/codecept/bin/codecept.js`) -* **[Protractor]** Functions added by **[reubenmiller](https://github.com/reubenmiller)**: - * `_locateCheckable (only available from other helpers)` - * `_locateClickable (only available from other helpers)` - * `_locateFields (only available from other helpers)` - * `acceptPopup` - * `cancelPopup` - * `dragAndDrop` - * `grabBrowserLogs` - * `grabCssPropertyFrom` - * `grabHTMLFrom` - * `grabNumberOfVisibleElements` - * `grabPageScrollPosition (new)` - * `rightClick` - * `scrollPageToBottom` - * `scrollPageToTop` - * `scrollTo` - * `seeAttributesOnElements` - * `seeCssPropertiesOnElements` - * `seeInPopup` - * `seeNumberOfVisibleElements` - * `switchTo` - * `waitForEnabled` - * `waitForValue` - * `waitInUrl` - * `waitNumberOfVisibleElements` - * `waitToHide` - * `waitUntil` - * `waitUrlEquals` -* **[Nightmare]** added: - * `grabPageScrollPosition` (new) - * `seeNumberOfVisibleElements` - * `waitToHide` -* **[Puppeteer]** added: - * `grabPageScrollPosition` (new) -* **[WebDriverIO]** added" - * `grabPageScrollPosition` (new) -* **[Puppeteer]** Fixed running wait* functions without setting `sec` parameter. -* [Puppeteer][Protractor] Fixed bug with I.click when using an object selector with the xpath property. By **[reubenmiller](https://github.com/reubenmiller)** -* [WebDriverIO][Protractor][Nightmare][Puppeteer] Fixed I.switchTo(0) and I.scrollTo(100, 100) api inconsistencies between helpers. -* **[Protractor]** Fixing bug when `seeAttributesOnElements` and `seeCssPropertiesOnElement` were incorrectly passing when the attributes/properties did not match by **[reubenmiller](https://github.com/reubenmiller)** -* **[WebDriverIO]** Use inbuilt dragAndDrop function (still doesn't work in Firefox). By **[reubenmiller](https://github.com/reubenmiller)** -* Support for Nightmare 3.0 -* Enable glob patterns in `config.test` / `Codecept.loadTests` by **[sveneisenschmidt](https://github.com/sveneisenschmidt)** -* Enable overriding of `config.tests` for `run-multiple` by **[sveneisenschmidt](https://github.com/sveneisenschmidt)** - +- Docker Image updateed. [See updated reference](https://codecept.io/docker/): + - codeceptjs package is mounted as `/codecept` insde container + - tests directory is expected to be mounted as `/tests` + - `codeceptjs` global runner added (symlink to `/codecept/bin/codecept.js`) +- **[Protractor]** Functions added by **[reubenmiller](https://github.com/reubenmiller)**: + - `_locateCheckable (only available from other helpers)` + - `_locateClickable (only available from other helpers)` + - `_locateFields (only available from other helpers)` + - `acceptPopup` + - `cancelPopup` + - `dragAndDrop` + - `grabBrowserLogs` + - `grabCssPropertyFrom` + - `grabHTMLFrom` + - `grabNumberOfVisibleElements` + - `grabPageScrollPosition (new)` + - `rightClick` + - `scrollPageToBottom` + - `scrollPageToTop` + - `scrollTo` + - `seeAttributesOnElements` + - `seeCssPropertiesOnElements` + - `seeInPopup` + - `seeNumberOfVisibleElements` + - `switchTo` + - `waitForEnabled` + - `waitForValue` + - `waitInUrl` + - `waitNumberOfVisibleElements` + - `waitToHide` + - `waitUntil` + - `waitUrlEquals` +- **[Nightmare]** added: + - `grabPageScrollPosition` (new) + - `seeNumberOfVisibleElements` + - `waitToHide` +- **[Puppeteer]** added: + - `grabPageScrollPosition` (new) +- **[WebDriverIO]** added" + - `grabPageScrollPosition` (new) +- **[Puppeteer]** Fixed running wait\* functions without setting `sec` parameter. +- [Puppeteer][Protractor] Fixed bug with I.click when using an object selector with the xpath property. By **[reubenmiller](https://github.com/reubenmiller)** +- [WebDriverIO][Protractor][Nightmare][Puppeteer] Fixed I.switchTo(0) and I.scrollTo(100, 100) api inconsistencies between helpers. +- **[Protractor]** Fixing bug when `seeAttributesOnElements` and `seeCssPropertiesOnElement` were incorrectly passing when the attributes/properties did not match by **[reubenmiller](https://github.com/reubenmiller)** +- **[WebDriverIO]** Use inbuilt dragAndDrop function (still doesn't work in Firefox). By **[reubenmiller](https://github.com/reubenmiller)** +- Support for Nightmare 3.0 +- Enable glob patterns in `config.test` / `Codecept.loadTests` by **[sveneisenschmidt](https://github.com/sveneisenschmidt)** +- Enable overriding of `config.tests` for `run-multiple` by **[sveneisenschmidt](https://github.com/sveneisenschmidt)** ## 1.1.6 -* Added support for `async I =>` functions syntax in Scenario by **[APshenkin](https://github.com/APshenkin)** -* [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForInvisible` waits for element to hide or to be removed from page. By **[reubenmiller](https://github.com/reubenmiller)** -* [Protractor][Puppeteer][Nightmare] Added `grabCurrentUrl` function. By **[reubenmiller](https://github.com/reubenmiller)** -* **[WebDriverIO]** `grabBrowserUrl` deprecated in favor of `grabCurrentUrl` to unify the API. -* **[Nightmare]** Improved element visibility detection by **[reubenmiller](https://github.com/reubenmiller)** -* **[Puppeteer]** Fixing function calls when clearing the cookies and localstorage. By **[reubenmiller](https://github.com/reubenmiller)** -* **[Puppeteer]** Added `waitForEnabled`, `waitForValue` and `waitNumberOfVisibleElements` methods by **[reubenmiller](https://github.com/reubenmiller)** -* **[WebDriverIO]** Fixed `grabNumberOfVisibleElements` to return 0 when no visible elements are on page. By **[michaltrunek](https://github.com/michaltrunek)** -* Helpers API improvements (by **[reubenmiller](https://github.com/reubenmiller)**) - * `_passed` hook runs after a test passed successfully - * `_failed` hook runs on a failed test -* Hooks API. New events added by **[reubenmiller](https://github.com/reubenmiller)**: - * `event.all.before` - executed before all tests - * `event.all.after` - executed after all tests - * `event.multiple.before` - executed before all processes in run-multiple - * `event.multiple.after` - executed after all processes in run-multiple -* Multiple execution -* Allow `AfterSuite` and `After` test hooks to be defined after the first Scenario. By **[reubenmiller](https://github.com/reubenmiller)** -* **[Nightmare]** Prevent `I.amOnpage` navigation if the browser is already at the given url -* Multiple-Run: Added new `bootstrapAll` and `teardownAll` hooks to be executed before and after all processes -* `codeceptjs def` command accepts `--config` option. By **[reubenmiller](https://github.com/reubenmiller)** +- Added support for `async I =>` functions syntax in Scenario by **[APshenkin](https://github.com/APshenkin)** +- [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForInvisible` waits for element to hide or to be removed from page. By **[reubenmiller](https://github.com/reubenmiller)** +- [Protractor][Puppeteer][Nightmare] Added `grabCurrentUrl` function. By **[reubenmiller](https://github.com/reubenmiller)** +- **[WebDriverIO]** `grabBrowserUrl` deprecated in favor of `grabCurrentUrl` to unify the API. +- **[Nightmare]** Improved element visibility detection by **[reubenmiller](https://github.com/reubenmiller)** +- **[Puppeteer]** Fixing function calls when clearing the cookies and localstorage. By **[reubenmiller](https://github.com/reubenmiller)** +- **[Puppeteer]** Added `waitForEnabled`, `waitForValue` and `waitNumberOfVisibleElements` methods by **[reubenmiller](https://github.com/reubenmiller)** +- **[WebDriverIO]** Fixed `grabNumberOfVisibleElements` to return 0 when no visible elements are on page. By **[michaltrunek](https://github.com/michaltrunek)** +- Helpers API improvements (by **[reubenmiller](https://github.com/reubenmiller)**) + - `_passed` hook runs after a test passed successfully + - `_failed` hook runs on a failed test +- Hooks API. New events added by **[reubenmiller](https://github.com/reubenmiller)**: + - `event.all.before` - executed before all tests + - `event.all.after` - executed after all tests + - `event.multiple.before` - executed before all processes in run-multiple + - `event.multiple.after` - executed after all processes in run-multiple +- Multiple execution +- Allow `AfterSuite` and `After` test hooks to be defined after the first Scenario. By **[reubenmiller](https://github.com/reubenmiller)** +- **[Nightmare]** Prevent `I.amOnpage` navigation if the browser is already at the given url +- Multiple-Run: Added new `bootstrapAll` and `teardownAll` hooks to be executed before and after all processes +- `codeceptjs def` command accepts `--config` option. By **[reubenmiller](https://github.com/reubenmiller)** ## 1.1.5 -* **[Puppeteer]** Rerun steps failed due to "Cannot find context with specified id" Error. -* Added syntax to retry a single step: +- **[Puppeteer]** Rerun steps failed due to "Cannot find context with specified id" Error. +- Added syntax to retry a single step: ```js // retry action once on failure -I.retry().see('Hello'); +I.retry().see('Hello') // retry action 3 times on failure -I.retry(3).see('Hello'); +I.retry(3).see('Hello') // retry action 3 times waiting for 0.1 second before next try -I.retry({ retries: 3, minTimeout: 100 }).see('Hello'); +I.retry({ retries: 3, minTimeout: 100 }).see('Hello') // retry action 3 times waiting no more than 3 seconds for last retry -I.retry({ retries: 3, maxTimeout: 3000 }).see('Hello'); +I.retry({ retries: 3, maxTimeout: 3000 }).see('Hello') // retry 2 times if error with message 'Node not visible' happens I.retry({ retries: 2, - when: err => err.message === 'Node not visible' -}).seeElement('#user'); -``` - -* `Scenario().injectDependencies` added to dynamically add objects into DI container by **[Apshenkin](https://github.com/Apshenkin)**. See [Dependency Injection section in PageObjects](https://codecept.io/pageobjects/#dependency-injection). -* Fixed using async/await functions inside `within` -* [WebDriverIO][Protractor][Puppeteer][Nightmare] **`waitUntilExists` deprecated** in favor of `waitForElement` -* [WebDriverIO][Protractor] **`waitForStalenessOf` deprecated** in favor of `waitForDetached` -* [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForDetached` added -* **[Nightmare]** Added `I.seeNumberOfElements()` by **[pmoncadaisla](https://github.com/pmoncadaisla)** -* **[Nightmare]** Load blank page when starting nightmare so that the .evaluate function will work if _failed/saveScreenshot is triggered by **[reubenmiller](https://github.com/reubenmiller)** -* Fixed using plain arrays for data driven tests by **[reubenmiller](https://github.com/reubenmiller)** -* **[Puppeteer]** Use default tab instead of opening a new tab when starting the browser by **[reubenmiller](https://github.com/reubenmiller)** -* **[Puppeteer]** Added `grabNumberOfTabs` function by **[reubenmiller](https://github.com/reubenmiller)** -* **[Puppeteer]** Add ability to set user-agent by **[abidhahmed](https://github.com/abidhahmed)** -* **[Puppeteer]** Add keepCookies and keepBrowserState **[abidhahmed](https://github.com/abidhahmed)** -* **[Puppeteer]** Clear value attribute instead of innerhtml for TEXTAREA by **[reubenmiller](https://github.com/reubenmiller)** -* **[REST]** fixed sending string payload by **[michaltrunek](https://github.com/michaltrunek)** -* Fixed unhandled rejection in async/await tests by **[APshenkin](https://github.com/APshenkin)** - + when: err => err.message === 'Node not visible', +}).seeElement('#user') +``` + +- `Scenario().injectDependencies` added to dynamically add objects into DI container by **[Apshenkin](https://github.com/Apshenkin)**. See [Dependency Injection section in PageObjects](https://codecept.io/pageobjects/#dependency-injection). +- Fixed using async/await functions inside `within` +- [WebDriverIO][Protractor][Puppeteer][Nightmare] **`waitUntilExists` deprecated** in favor of `waitForElement` +- [WebDriverIO][Protractor] **`waitForStalenessOf` deprecated** in favor of `waitForDetached` +- [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForDetached` added +- **[Nightmare]** Added `I.seeNumberOfElements()` by **[pmoncadaisla](https://github.com/pmoncadaisla)** +- **[Nightmare]** Load blank page when starting nightmare so that the .evaluate function will work if \_failed/saveScreenshot is triggered by **[reubenmiller](https://github.com/reubenmiller)** +- Fixed using plain arrays for data driven tests by **[reubenmiller](https://github.com/reubenmiller)** +- **[Puppeteer]** Use default tab instead of opening a new tab when starting the browser by **[reubenmiller](https://github.com/reubenmiller)** +- **[Puppeteer]** Added `grabNumberOfTabs` function by **[reubenmiller](https://github.com/reubenmiller)** +- **[Puppeteer]** Add ability to set user-agent by **[abidhahmed](https://github.com/abidhahmed)** +- **[Puppeteer]** Add keepCookies and keepBrowserState **[abidhahmed](https://github.com/abidhahmed)** +- **[Puppeteer]** Clear value attribute instead of innerhtml for TEXTAREA by **[reubenmiller](https://github.com/reubenmiller)** +- **[REST]** fixed sending string payload by **[michaltrunek](https://github.com/michaltrunek)** +- Fixed unhandled rejection in async/await tests by **[APshenkin](https://github.com/APshenkin)** ## 1.1.4 -* Removed `yarn` call in package.json -* Fixed `console.log` in Puppeteer by **[othree](https://github.com/othree)** -* **[Appium]** `runOnAndroid` and `runOnIOS` can receive a function to check capabilities dynamically: +- Removed `yarn` call in package.json +- Fixed `console.log` in Puppeteer by **[othree](https://github.com/othree)** +- **[Appium]** `runOnAndroid` and `runOnIOS` can receive a function to check capabilities dynamically: ```js -I.runOnAndroid(caps => caps.platformVersion >= 7, () => { - // run code only on Android 7+ -}); +I.runOnAndroid( + caps => caps.platformVersion >= 7, + () => { + // run code only on Android 7+ + }, +) ``` ## 1.1.3 -* **[Puppeteer]** +25 Functions added by **[reubenmiller](https://github.com/reubenmiller)** - * `_locateCheckable` - * `_locateClickable` - * `_locateFields` - * `closeOtherTabs` - * `dragAndDrop` - * `grabBrowserLogs` - * `grabCssPropertyFrom` - * `grabHTMLFrom` - * `grabNumberOfVisibleElements` - * `grabSource` - * `rightClick` - * `scrollPageToBottom` - * `scrollPageToTop` - * `scrollTo` - * `seeAttributesOnElements` - * `seeCssPropertiesOnElements` - * `seeInField` - * `seeNumberOfElements` - * `seeNumberOfVisibleElements` - * `seeTextEquals` - * `seeTitleEquals` - * `switchTo` - * `waitForInvisible` - * `waitInUrl` - * `waitUrlEquals` -* **[Protractor]** +8 functions added by **[reubenmiller](https://github.com/reubenmiller)** - * `closeCurrentTab` - * `grabSource` - * `openNewTab` - * `seeNumberOfElements` - * `seeTextEquals` - * `seeTitleEquals` - * `switchToNextTab` - * `switchToPreviousTab` -* **[Nightmare]** `waitForInvisible` added by **[reubenmiller](https://github.com/reubenmiller)** -* **[Puppeteer]** Printing console.log information in debug mode. -* **[Nightmare]** Integrated with `nightmare-har-plugin` by mingfang. Added `enableHAR` option. Added HAR functions: - * `grabHAR` - * `saveHAR` - * `resetHAR` -* **[WebDriverIO]** Fixed execution stability for parallel requests with Chromedriver -* **[WebDriverIO]** Fixed resizeWindow when resizing to 'maximize' by **[reubenmiller](https://github.com/reubenmiller)** -* **[WebDriverIO]** Fixing resizing window to full screen when taking a screenshot by **[reubenmiller](https://github.com/reubenmiller)** +- **[Puppeteer]** +25 Functions added by **[reubenmiller](https://github.com/reubenmiller)** + - `_locateCheckable` + - `_locateClickable` + - `_locateFields` + - `closeOtherTabs` + - `dragAndDrop` + - `grabBrowserLogs` + - `grabCssPropertyFrom` + - `grabHTMLFrom` + - `grabNumberOfVisibleElements` + - `grabSource` + - `rightClick` + - `scrollPageToBottom` + - `scrollPageToTop` + - `scrollTo` + - `seeAttributesOnElements` + - `seeCssPropertiesOnElements` + - `seeInField` + - `seeNumberOfElements` + - `seeNumberOfVisibleElements` + - `seeTextEquals` + - `seeTitleEquals` + - `switchTo` + - `waitForInvisible` + - `waitInUrl` + - `waitUrlEquals` +- **[Protractor]** +8 functions added by **[reubenmiller](https://github.com/reubenmiller)** + - `closeCurrentTab` + - `grabSource` + - `openNewTab` + - `seeNumberOfElements` + - `seeTextEquals` + - `seeTitleEquals` + - `switchToNextTab` + - `switchToPreviousTab` +- **[Nightmare]** `waitForInvisible` added by **[reubenmiller](https://github.com/reubenmiller)** +- **[Puppeteer]** Printing console.log information in debug mode. +- **[Nightmare]** Integrated with `nightmare-har-plugin` by mingfang. Added `enableHAR` option. Added HAR functions: + - `grabHAR` + - `saveHAR` + - `resetHAR` +- **[WebDriverIO]** Fixed execution stability for parallel requests with Chromedriver +- **[WebDriverIO]** Fixed resizeWindow when resizing to 'maximize' by **[reubenmiller](https://github.com/reubenmiller)** +- **[WebDriverIO]** Fixing resizing window to full screen when taking a screenshot by **[reubenmiller](https://github.com/reubenmiller)** ## 1.1.2 -* **[Puppeteer]** Upgraded to Puppeteer 1.0 -* Added `grep` option to config to set default matching pattern for tests. -* **[Puppeteer]** Added `acceptPopup`, `cancelPopup`, `seeInPopup` and `grabPopupText` functions by **[reubenmiller](https://github.com/reubenmiller)** -* **[Puppeteer]** `within` iframe and nested iframe support added by **[reubenmiller](https://github.com/reubenmiller)** -* **[REST]** Added support for JSON objects since payload (as a JSON) was automatically converted into "URL query" type of parameter by **[Kalostrinho](https://github.com/Kalostrinho)** -* **[REST]** Added `resetRequestHeaders` method by **[Kalostrinho](https://github.com/Kalostrinho)** -* **[REST]** Added `followRedirect` option and `amFollowingRequestRedirects`/`amNotFollowingRequestRedirects` methods by **[Kalostrinho](https://github.com/Kalostrinho)** -* **[WebDriverIO]** `uncheckOption` implemented by **[brunobg](https://github.com/brunobg)** -* **[WebDriverIO]** Added `grabBrowserUrl` by **[Kalostrinho](https://github.com/Kalostrinho)** -* Add ability to require helpers from node_modules by **[APshenkin](https://github.com/APshenkin)** -* Added `--profile` option to `run-multiple` command by **[jamie-beck](https://github.com/jamie-beck)** -* Custom output name for multiple browser run by **[tfiwm](https://github.com/tfiwm)** -* Fixed passing data to scenarios by **[KennyRules](https://github.com/KennyRules)** +- **[Puppeteer]** Upgraded to Puppeteer 1.0 +- Added `grep` option to config to set default matching pattern for tests. +- **[Puppeteer]** Added `acceptPopup`, `cancelPopup`, `seeInPopup` and `grabPopupText` functions by **[reubenmiller](https://github.com/reubenmiller)** +- **[Puppeteer]** `within` iframe and nested iframe support added by **[reubenmiller](https://github.com/reubenmiller)** +- **[REST]** Added support for JSON objects since payload (as a JSON) was automatically converted into "URL query" type of parameter by **[Kalostrinho](https://github.com/Kalostrinho)** +- **[REST]** Added `resetRequestHeaders` method by **[Kalostrinho](https://github.com/Kalostrinho)** +- **[REST]** Added `followRedirect` option and `amFollowingRequestRedirects`/`amNotFollowingRequestRedirects` methods by **[Kalostrinho](https://github.com/Kalostrinho)** +- **[WebDriverIO]** `uncheckOption` implemented by **[brunobg](https://github.com/brunobg)** +- **[WebDriverIO]** Added `grabBrowserUrl` by **[Kalostrinho](https://github.com/Kalostrinho)** +- Add ability to require helpers from node_modules by **[APshenkin](https://github.com/APshenkin)** +- Added `--profile` option to `run-multiple` command by **[jamie-beck](https://github.com/jamie-beck)** +- Custom output name for multiple browser run by **[tfiwm](https://github.com/tfiwm)** +- Fixed passing data to scenarios by **[KennyRules](https://github.com/KennyRules)** ## 1.1.1 -* **[WebDriverIO]** fixed `waitForInvisible` by **[Kporal](https://github.com/Kporal)** +- **[WebDriverIO]** fixed `waitForInvisible` by **[Kporal](https://github.com/Kporal)** ## 1.1.0 @@ -3452,10 +3958,10 @@ Major update to CodeceptJS. **NodeJS v 8.9.1** is now minimal Node version requi This brings native async-await support to CodeceptJS. It is recommended to start using await for tests instead of generators: ```js -async () => { - I.amOnPage('/page'); - const url = await I.grabTextFrom('.nextPage'); - I.amOnPage(url); +;async () => { + I.amOnPage('/page') + const url = await I.grabTextFrom('.nextPage') + I.amOnPage(url) } ``` @@ -3463,9 +3969,9 @@ Thanks to [@Apshenkin](https://github.com/apshenkin) for implementation. Also, m We also introduced strict ESLint policies for our codebase. Thanks to [@Galkin](https://github.com/galkin) for that. -* **[Puppeteer] Helper introduced**. [Learn how to run tests headlessly with Google Chrome's Puppeteer](http://codecept.io/puppeteer/). -* **[SeleniumWebdriver]** Helper is deprecated, it is recommended to use Protractor with config option `angular: false` instead. -* **[WebDriverIO]** nested iframe support in the within block by **[reubenmiller](https://github.com/reubenmiller)**. Example: +- **[Puppeteer] Helper introduced**. [Learn how to run tests headlessly with Google Chrome's Puppeteer](http://codecept.io/puppeteer/). +- **[SeleniumWebdriver]** Helper is deprecated, it is recommended to use Protractor with config option `angular: false` instead. +- **[WebDriverIO]** nested iframe support in the within block by **[reubenmiller](https://github.com/reubenmiller)**. Example: ```js within({frame: ['#wrapperId', '[name=content]']}, () => { @@ -3476,66 +3982,63 @@ I.see('Nested Iframe test'); I.dontSee('Email Address'); }); ``` -* **[WebDriverIO]** Support for `~` locator to find elements by `aria-label`. This behavior is similar as it is in Appium and helps testing cross-platform React apps. Example: + +- **[WebDriverIO]** Support for `~` locator to find elements by `aria-label`. This behavior is similar as it is in Appium and helps testing cross-platform React apps. Example: ```html - - CodeceptJS is awesome - + CodeceptJS is awesome ``` -↑ This element can be located with `~foobar` in WebDriverIO and Appium helpers. Thanks to **[flyskywhy](https://github.com/flyskywhy)** - -* Allow providing arbitrary objects in config includes by **[rlewan](https://github.com/rlewan)** -* **[REST]** Prevent from mutating default headers by **[alexashley](https://github.com/alexashley)**. See [#789](https://github.com/codeceptjs/CodeceptJS/issues/789) -* **[REST]** Fixed sending empty helpers with `haveRequestHeaders` in `sendPostRequest`. By **[petrisorionel](https://github.com/petrisorionel)** -* Fixed displaying undefined args in output by **[APshenkin](https://github.com/APshenkin)** -* Fixed NaN instead of seconds in output by **[APshenkin](https://github.com/APshenkin)** -* Add browser name to report file for `multiple-run` by **[trollr](https://github.com/trollr)** -* Mocha updated to 4.x +↑ This element can be located with `~foobar` in WebDriverIO and Appium helpers. Thanks to **[flyskywhy](https://github.com/flyskywhy)** +- Allow providing arbitrary objects in config includes by **[rlewan](https://github.com/rlewan)** +- **[REST]** Prevent from mutating default headers by **[alexashley](https://github.com/alexashley)**. See [#789](https://github.com/codeceptjs/CodeceptJS/issues/789) +- **[REST]** Fixed sending empty helpers with `haveRequestHeaders` in `sendPostRequest`. By **[petrisorionel](https://github.com/petrisorionel)** +- Fixed displaying undefined args in output by **[APshenkin](https://github.com/APshenkin)** +- Fixed NaN instead of seconds in output by **[APshenkin](https://github.com/APshenkin)** +- Add browser name to report file for `multiple-run` by **[trollr](https://github.com/trollr)** +- Mocha updated to 4.x ## 1.0.3 -* [WebDriverIO][Protractor][Nightmare] method `waitUntilExists` implemented by **[sabau](https://github.com/sabau)** -* Absolute path can be set for `output` dir by **[APshenkin](https://github.com/APshenkin)**. Fix [#571](https://github.com/codeceptjs/CodeceptJS/issues/571)* Data table rows can be ignored by using `xadd`. By **[APhenkin](https://github.com/APhenkin)** -* Added `Data(table).only.Scenario` to give ability to launch only Data tests. By **[APhenkin](https://github.com/APhenkin)** -* Implemented `ElementNotFound` error by **[BorisOsipov](https://github.com/BorisOsipov)**. -* Added TypeScript compiler / configs to check the JavaScript by **[KennyRules](https://github.com/KennyRules)** -* **[Nightmare]** fix executeScript return value by **[jploskonka](https://github.com/jploskonka)** -* **[Nightmare]** fixed: err.indexOf not a function when waitForText times out in nightmare by **[joeypedicini92](https://github.com/joeypedicini92)** -* Fixed: Retries not working when using .only. By **[APhenkin](https://github.com/APhenkin)** - +- [WebDriverIO][Protractor][Nightmare] method `waitUntilExists` implemented by **[sabau](https://github.com/sabau)** +- Absolute path can be set for `output` dir by **[APshenkin](https://github.com/APshenkin)**. Fix [#571](https://github.com/codeceptjs/CodeceptJS/issues/571)\* Data table rows can be ignored by using `xadd`. By **[APhenkin](https://github.com/APhenkin)** +- Added `Data(table).only.Scenario` to give ability to launch only Data tests. By **[APhenkin](https://github.com/APhenkin)** +- Implemented `ElementNotFound` error by **[BorisOsipov](https://github.com/BorisOsipov)**. +- Added TypeScript compiler / configs to check the JavaScript by **[KennyRules](https://github.com/KennyRules)** +- **[Nightmare]** fix executeScript return value by **[jploskonka](https://github.com/jploskonka)** +- **[Nightmare]** fixed: err.indexOf not a function when waitForText times out in nightmare by **[joeypedicini92](https://github.com/joeypedicini92)** +- Fixed: Retries not working when using .only. By **[APhenkin](https://github.com/APhenkin)** ## 1.0.2 -* Introduced generators support in scenario hooks for `BeforeSuite`/`Before`/`AfterSuite`/`After` -* **[ApiDataFactory]** Fixed loading helper; `requireg` package included. -* Fix [#485](https://github.com/codeceptjs/CodeceptJS/issues/485)`run-multiple`: the first browser-resolution combination was be used in all configurations -* Fixed unique test names: - * Fixed [#447](https://github.com/codeceptjs/CodeceptJS/issues/447) tests failed silently if they have the same name as other tests. - * Use uuid in screenshot names when `uniqueScreenshotNames: true` -* **[Protractor]** Fixed testing non-angular application. `amOutsideAngularApp` is executed before each step. Fixes [#458](https://github.com/codeceptjs/CodeceptJS/issues/458)* Added output for steps in hooks when they fail +- Introduced generators support in scenario hooks for `BeforeSuite`/`Before`/`AfterSuite`/`After` +- **[ApiDataFactory]** Fixed loading helper; `requireg` package included. +- Fix [#485](https://github.com/codeceptjs/CodeceptJS/issues/485)`run-multiple`: the first browser-resolution combination was be used in all configurations +- Fixed unique test names: + - Fixed [#447](https://github.com/codeceptjs/CodeceptJS/issues/447) tests failed silently if they have the same name as other tests. + - Use uuid in screenshot names when `uniqueScreenshotNames: true` +- **[Protractor]** Fixed testing non-angular application. `amOutsideAngularApp` is executed before each step. Fixes [#458](https://github.com/codeceptjs/CodeceptJS/issues/458)\* Added output for steps in hooks when they fail ## 1.0.1 -* Reporters improvements: - * Allows to execute [multiple reporters](http://codecept.io/advanced/#Multi-Reports) - * Added [Mochawesome](http://codecept.io/helpers/Mochawesome/) helper - * `addMochawesomeContext` method to add custom data to mochawesome reports - * Fixed Mochawesome context for failed screenshots. -* **[WebDriverIO]** improved click on context to match clickable element with a text inside. Fixes [#647](https://github.com/codeceptjs/CodeceptJS/issues/647)* **[Nightmare]** Added `refresh` function by **[awhanks](https://github.com/awhanks)** -* fixed `Unhandled promise rejection (rejection id: 1): Error: Unknown wait type: pageLoad` -* support for tests with retries in html report -* be sure that change window size and timeouts completes before test -* **[Nightmare]** Fixed `[Wrapped Error] "codeceptjs is not defined"`; Reinjectiing client scripts to a webpage on changes. -* **[Nightmare]** Added more detailed error messages for `Wait*` methods -* **[Nightmare]** Fixed adding screenshots to Mochawesome -* **[Nightmare]** Fix unique screenshots names in Nightmare -* Fixed CodeceptJS work with hooks in helpers to finish codeceptJS correctly if errors appears in helpers hooks -* Create a new session for next test If selenium grid error received -* Create screenshots for failed hooks from a Feature file -* Fixed `retries` option +- Reporters improvements: + - Allows to execute [multiple reporters](http://codecept.io/advanced/#Multi-Reports) + - Added [Mochawesome](http://codecept.io/helpers/Mochawesome/) helper + - `addMochawesomeContext` method to add custom data to mochawesome reports + - Fixed Mochawesome context for failed screenshots. +- **[WebDriverIO]** improved click on context to match clickable element with a text inside. Fixes [#647](https://github.com/codeceptjs/CodeceptJS/issues/647)\* **[Nightmare]** Added `refresh` function by **[awhanks](https://github.com/awhanks)** +- fixed `Unhandled promise rejection (rejection id: 1): Error: Unknown wait type: pageLoad` +- support for tests with retries in html report +- be sure that change window size and timeouts completes before test +- **[Nightmare]** Fixed `[Wrapped Error] "codeceptjs is not defined"`; Reinjectiing client scripts to a webpage on changes. +- **[Nightmare]** Added more detailed error messages for `Wait*` methods +- **[Nightmare]** Fixed adding screenshots to Mochawesome +- **[Nightmare]** Fix unique screenshots names in Nightmare +- Fixed CodeceptJS work with hooks in helpers to finish codeceptJS correctly if errors appears in helpers hooks +- Create a new session for next test If selenium grid error received +- Create screenshots for failed hooks from a Feature file +- Fixed `retries` option ## 1.0 @@ -3552,8 +4055,8 @@ I.clearField('~email of the customer')); I.dontSee('Nothing special', '~email of the customer')); ``` -* Read [the Mobile Testing guide](http://codecept.io/mobile). -* Discover [Appium Helper](http://codecept.io/helpers/Appium/) +- Read [the Mobile Testing guide](http://codecept.io/mobile). +- Discover [Appium Helper](http://codecept.io/helpers/Appium/) --- @@ -3564,116 +4067,117 @@ Sample test ```js // create a user using data factories and REST API -I.have('user', { name: 'davert', password: '123456' }); +I.have('user', { name: 'davert', password: '123456' }) // use it to login -I.amOnPage('/login'); -I.fillField('login', 'davert'); -I.fillField('password', '123456'); -I.click('Login'); -I.see('Hello, davert'); +I.amOnPage('/login') +I.fillField('login', 'davert') +I.fillField('password', '123456') +I.click('Login') +I.see('Hello, davert') // user will be removed after the test ``` -* Read [Data Management guide](http://codecept.io/data) -* [REST Helper](http://codecept.io/helpers/REST) -* [ApiDataFactory](http://codecept.io/helpers/ApiDataFactory/) +- Read [Data Management guide](http://codecept.io/data) +- [REST Helper](http://codecept.io/helpers/REST) +- [ApiDataFactory](http://codecept.io/helpers/ApiDataFactory/) --- Next notable feature is **[SmartWait](http://codecept.io/acceptance/#smartwait)** for WebDriverIO, Protractor, SeleniumWebdriver. When `smartwait` option is set, script will wait for extra milliseconds to locate an element before failing. This feature uses implicit waits of Selenium but turns them on only in applicable pieces. For instance, implicit waits are enabled for `seeElement` but disabled for `dontSeeElement` -* Read more about [SmartWait](http://codecept.io/acceptance/#smartwait) +- Read more about [SmartWait](http://codecept.io/acceptance/#smartwait) ##### Changelog -* Minimal NodeJS version is 6.11.1 LTS -* Use `within` command with generators. -* [Data Driven Tests](http://codecept.io/advanced/#data-driven-tests) introduced. -* Print execution time per step in `--debug` mode. [#591](https://github.com/codeceptjs/CodeceptJS/issues/591) by **[APshenkin](https://github.com/APshenkin)** -* [WebDriverIO][Protractor][Nightmare] Added `disableScreenshots` option to disable screenshots on fail by **[Apshenkin](https://github.com/Apshenkin)** -* [WebDriverIO][Protractor][Nightmare] Added `uniqueScreenshotNames` option to generate unique names for screenshots on failure by **[Apshenkin](https://github.com/Apshenkin)** -* [WebDriverIO][Nightmare] Fixed click on context; `click('text', '#el')` will throw exception if text is not found inside `#el`. -* [WebDriverIO][Protractor][SeleniumWebdriver] [SmartWait introduced](http://codecept.io/acceptance/#smartwait). -* [WebDriverIO][Protractor][Nightmare]Fixed `saveScreenshot` for PhantomJS, `fullPageScreenshots` option introduced by **[HughZurname](https://github.com/HughZurname)** [#549](https://github.com/codeceptjs/CodeceptJS/issues/549) -* **[Appium]** helper introduced by **[APshenkin](https://github.com/APshenkin)** -* **[REST]** helper introduced by **[atrevino](https://github.com/atrevino)** in [#504](https://github.com/codeceptjs/CodeceptJS/issues/504) -* [WebDriverIO][SeleniumWebdriver] Fixed "windowSize": "maximize" for Chrome 59+ version [#560](https://github.com/codeceptjs/CodeceptJS/issues/560) by **[APshenkin](https://github.com/APshenkin)** -* **[Nightmare]** Fixed restarting by **[APshenkin](https://github.com/APshenkin)** [#581](https://github.com/codeceptjs/CodeceptJS/issues/581) -* **[WebDriverIO]** Methods added by **[APshenkin](https://github.com/APshenkin)**: - * [grabCssPropertyFrom](http://codecept.io/helpers/WebDriverIO/#grabcsspropertyfrom) - * [seeTitleEquals](http://codecept.io/helpers/WebDriverIO/#seetitleequals) - * [seeTextEquals](http://codecept.io/helpers/WebDriverIO/#seetextequals) - * [seeCssPropertiesOnElements](http://codecept.io/helpers/WebDriverIO/#seecsspropertiesonelements) - * [seeAttributesOnElements](http://codecept.io/helpers/WebDriverIO/#seeattributesonelements) - * [grabNumberOfVisibleElements](http://codecept.io/helpers/WebDriverIO/#grabnumberofvisibleelements) - * [waitInUrl](http://codecept.io/helpers/WebDriverIO/#waitinurl) - * [waitUrlEquals](http://codecept.io/helpers/WebDriverIO/#waiturlequals) - * [waitForValue](http://codecept.io/helpers/WebDriverIO/#waitforvalue) - * [waitNumberOfVisibleElements](http://codecept.io/helpers/WebDriverIO/#waitnumberofvisibleelements) - * [switchToNextTab](http://codecept.io/helpers/WebDriverIO/#switchtonexttab) - * [switchToPreviousTab](http://codecept.io/helpers/WebDriverIO/#switchtoprevioustab) - * [closeCurrentTab](http://codecept.io/helpers/WebDriverIO/#closecurrenttab) - * [openNewTab](http://codecept.io/helpers/WebDriverIO/#opennewtab) - * [refreshPage](http://codecept.io/helpers/WebDriverIO/#refreshpage) - * [scrollPageToBottom](http://codecept.io/helpers/WebDriverIO/#scrollpagetobottom) - * [scrollPageToTop](http://codecept.io/helpers/WebDriverIO/#scrollpagetotop) - * [grabBrowserLogs](http://codecept.io/helpers/WebDriverIO/#grabbrowserlogs) -* Use mkdirp to create output directory. [#592](https://github.com/codeceptjs/CodeceptJS/issues/592) by **[vkramskikh](https://github.com/vkramskikh)** -* **[WebDriverIO]** Fixed `seeNumberOfVisibleElements` by **[BorisOsipov](https://github.com/BorisOsipov)** [#574](https://github.com/codeceptjs/CodeceptJS/issues/574) -* Lots of fixes for promise chain by **[APshenkin](https://github.com/APshenkin)** [#568](https://github.com/codeceptjs/CodeceptJS/issues/568) - * Fix [#543](https://github.com/codeceptjs/CodeceptJS/issues/543)- After block not properly executed if Scenario fails - * Expected behavior in promise chains: `_beforeSuite` hooks from helpers -> `BeforeSuite` from test -> `_before` hooks from helpers -> `Before` from test - > Test steps -> `_failed` hooks from helpers (if test failed) -> `After` from test -> `_after` hooks from helpers -> `AfterSuite` from test -> `_afterSuite` hook from helpers. - * if during test we got errors from any hook (in test or in helper) - stop complete this suite and go to another - * if during test we got error from Selenium server - stop complete this suite and go to another - * [WebDriverIO][Protractor] if `restart` option is false - close all tabs expect one in `_after`. - * Complete `_after`, `_afterSuite` hooks even After/AfterSuite from test was failed - * Don't close browser between suites, when `restart` option is false. We should start browser only one time and close it only after all tests. - * Close tabs and clear local storage, if `keepCookies` flag is enabled -* Fix TypeError when using babel-node or ts-node on node.js 7+ [#586](https://github.com/codeceptjs/CodeceptJS/issues/586) by **[vkramskikh](https://github.com/vkramskikh)** -* **[Nightmare]** fixed usage of `_locate` +- Minimal NodeJS version is 6.11.1 LTS +- Use `within` command with generators. +- [Data Driven Tests](http://codecept.io/advanced/#data-driven-tests) introduced. +- Print execution time per step in `--debug` mode. [#591](https://github.com/codeceptjs/CodeceptJS/issues/591) by **[APshenkin](https://github.com/APshenkin)** +- [WebDriverIO][Protractor][Nightmare] Added `disableScreenshots` option to disable screenshots on fail by **[Apshenkin](https://github.com/Apshenkin)** +- [WebDriverIO][Protractor][Nightmare] Added `uniqueScreenshotNames` option to generate unique names for screenshots on failure by **[Apshenkin](https://github.com/Apshenkin)** +- [WebDriverIO][Nightmare] Fixed click on context; `click('text', '#el')` will throw exception if text is not found inside `#el`. +- [WebDriverIO][Protractor][SeleniumWebdriver] [SmartWait introduced](http://codecept.io/acceptance/#smartwait). +- [WebDriverIO][Protractor][Nightmare]Fixed `saveScreenshot` for PhantomJS, `fullPageScreenshots` option introduced by **[HughZurname](https://github.com/HughZurname)** [#549](https://github.com/codeceptjs/CodeceptJS/issues/549) +- **[Appium]** helper introduced by **[APshenkin](https://github.com/APshenkin)** +- **[REST]** helper introduced by **[atrevino](https://github.com/atrevino)** in [#504](https://github.com/codeceptjs/CodeceptJS/issues/504) +- [WebDriverIO][SeleniumWebdriver] Fixed "windowSize": "maximize" for Chrome 59+ version [#560](https://github.com/codeceptjs/CodeceptJS/issues/560) by **[APshenkin](https://github.com/APshenkin)** +- **[Nightmare]** Fixed restarting by **[APshenkin](https://github.com/APshenkin)** [#581](https://github.com/codeceptjs/CodeceptJS/issues/581) +- **[WebDriverIO]** Methods added by **[APshenkin](https://github.com/APshenkin)**: + - [grabCssPropertyFrom](http://codecept.io/helpers/WebDriverIO/#grabcsspropertyfrom) + - [seeTitleEquals](http://codecept.io/helpers/WebDriverIO/#seetitleequals) + - [seeTextEquals](http://codecept.io/helpers/WebDriverIO/#seetextequals) + - [seeCssPropertiesOnElements](http://codecept.io/helpers/WebDriverIO/#seecsspropertiesonelements) + - [seeAttributesOnElements](http://codecept.io/helpers/WebDriverIO/#seeattributesonelements) + - [grabNumberOfVisibleElements](http://codecept.io/helpers/WebDriverIO/#grabnumberofvisibleelements) + - [waitInUrl](http://codecept.io/helpers/WebDriverIO/#waitinurl) + - [waitUrlEquals](http://codecept.io/helpers/WebDriverIO/#waiturlequals) + - [waitForValue](http://codecept.io/helpers/WebDriverIO/#waitforvalue) + - [waitNumberOfVisibleElements](http://codecept.io/helpers/WebDriverIO/#waitnumberofvisibleelements) + - [switchToNextTab](http://codecept.io/helpers/WebDriverIO/#switchtonexttab) + - [switchToPreviousTab](http://codecept.io/helpers/WebDriverIO/#switchtoprevioustab) + - [closeCurrentTab](http://codecept.io/helpers/WebDriverIO/#closecurrenttab) + - [openNewTab](http://codecept.io/helpers/WebDriverIO/#opennewtab) + - [refreshPage](http://codecept.io/helpers/WebDriverIO/#refreshpage) + - [scrollPageToBottom](http://codecept.io/helpers/WebDriverIO/#scrollpagetobottom) + - [scrollPageToTop](http://codecept.io/helpers/WebDriverIO/#scrollpagetotop) + - [grabBrowserLogs](http://codecept.io/helpers/WebDriverIO/#grabbrowserlogs) +- Use mkdirp to create output directory. [#592](https://github.com/codeceptjs/CodeceptJS/issues/592) by **[vkramskikh](https://github.com/vkramskikh)** +- **[WebDriverIO]** Fixed `seeNumberOfVisibleElements` by **[BorisOsipov](https://github.com/BorisOsipov)** [#574](https://github.com/codeceptjs/CodeceptJS/issues/574) +- Lots of fixes for promise chain by **[APshenkin](https://github.com/APshenkin)** [#568](https://github.com/codeceptjs/CodeceptJS/issues/568) + - Fix [#543](https://github.com/codeceptjs/CodeceptJS/issues/543)- After block not properly executed if Scenario fails + - Expected behavior in promise chains: `_beforeSuite` hooks from helpers -> `BeforeSuite` from test -> `_before` hooks from helpers -> `Before` from test - > Test steps -> `_failed` hooks from helpers (if test failed) -> `After` from test -> `_after` hooks from helpers -> `AfterSuite` from test -> `_afterSuite` hook from helpers. + - if during test we got errors from any hook (in test or in helper) - stop complete this suite and go to another + - if during test we got error from Selenium server - stop complete this suite and go to another + - [WebDriverIO][Protractor] if `restart` option is false - close all tabs expect one in `_after`. + - Complete `_after`, `_afterSuite` hooks even After/AfterSuite from test was failed + - Don't close browser between suites, when `restart` option is false. We should start browser only one time and close it only after all tests. + - Close tabs and clear local storage, if `keepCookies` flag is enabled +- Fix TypeError when using babel-node or ts-node on node.js 7+ [#586](https://github.com/codeceptjs/CodeceptJS/issues/586) by **[vkramskikh](https://github.com/vkramskikh)** +- **[Nightmare]** fixed usage of `_locate` Special thanks to **Andrey Pshenkin** for his work on this release and the major improvements. ## 0.6.3 -* Errors are printed in non-verbose mode. Shows "Selenium not started" and other important errors. -* Allowed to set custom test options: +- Errors are printed in non-verbose mode. Shows "Selenium not started" and other important errors. +- Allowed to set custom test options: ```js Scenario('My scenario', { build_id: 123, type: 'slow' }, function (I) ``` + those options can be accessed as `opts` property inside a `test` object. Can be used in custom listeners. -* Added `docs` directory to a package. -* [WebDriverIO][Protractor][SeleniumWebdriver] Bugfix: cleaning session when `restart: false` by **[tfiwm](https://github.com/tfiwm)** [#519](https://github.com/codeceptjs/CodeceptJS/issues/519) -* [WebDriverIO][Protractor][Nightmare] Added second parameter to `saveScreenshot` to allow a full page screenshot. By **[HughZurname](https://github.com/HughZurname)** -* Added suite object to `suite.before` and `suite.after` events by **[implico](https://github.com/implico)**. [#496](https://github.com/codeceptjs/CodeceptJS/issues/496) +- Added `docs` directory to a package. +- [WebDriverIO][Protractor][SeleniumWebdriver] Bugfix: cleaning session when `restart: false` by **[tfiwm](https://github.com/tfiwm)** [#519](https://github.com/codeceptjs/CodeceptJS/issues/519) +- [WebDriverIO][Protractor][Nightmare] Added second parameter to `saveScreenshot` to allow a full page screenshot. By **[HughZurname](https://github.com/HughZurname)** +- Added suite object to `suite.before` and `suite.after` events by **[implico](https://github.com/implico)**. [#496](https://github.com/codeceptjs/CodeceptJS/issues/496) ## 0.6.2 -* Added `config` object to [public API](http://codecept.io/hooks/#api) -* Extended `index.js` to include `actor` and `helpers`, so they could be required: +- Added `config` object to [public API](http://codecept.io/hooks/#api) +- Extended `index.js` to include `actor` and `helpers`, so they could be required: ```js -const actor = require('codeceptjs').actor; +const actor = require('codeceptjs').actor ``` -* Added [example for creating custom runner](http://codecept.io/hooks/#custom-runner) with public API. -* run command to create `output` directory if it doesn't exist -* **[Protractor]** fixed loading globally installed Protractor -* run-multiple command improvements: - * create output directories for each process - * print process ids in output +- Added [example for creating custom runner](http://codecept.io/hooks/#custom-runner) with public API. +- run command to create `output` directory if it doesn't exist +- **[Protractor]** fixed loading globally installed Protractor +- run-multiple command improvements: + - create output directories for each process + - print process ids in output ## 0.6.1 -* Fixed loading hooks +- Fixed loading hooks ## 0.6.0 Major release with extension API and parallel execution. -* **Breaking** Removed path argument from `run`. To specify path other than current directory use `--config` or `-c` option: +- **Breaking** Removed path argument from `run`. To specify path other than current directory use `--config` or `-c` option: Instead of: `codeceptjs run tests` use: @@ -3688,51 +4192,50 @@ codeceptjs run -c tests/codecept.json codeceptjs run users_test.js -c tests ``` -* **Command `multiple-run` added**, to execute tests in several browsers in parallel by **[APshenkin](https://github.com/APshenkin)** and **[davertmik](https://github.com/davertmik)**. [See documentation](http://codecept.io/advanced/#multiple-execution). -* **Hooks API added to extend CodeceptJS** with custom listeners and plugins. [See documentation](http://codecept.io/hooks/#hooks_1). -* [Nightmare][WebDriverIO] `within` can work with iframes by **[imvetri](https://github.com/imvetri)**. [See documentation](http://codecept.io/acceptance/#iframes). -* [WebDriverIO][SeleniumWebdriver][Protractor] Default browser changed to `chrome` -* **[Nightmare]** Fixed globally locating `nightmare-upload`. -* **[WebDriverIO]** added `seeNumberOfVisibleElements` method by **[elarouche](https://github.com/elarouche)**. -* Exit with non-zero code if init throws an error by **[rincedd](https://github.com/rincedd)** -* New guides published: - * [Installation](http://codecept.io/installation/) - * [Hooks](http://codecept.io/hooks/) - * [Advanced Usage](http://codecept.io/advanced/) -* Meta packages published: - * [codecept-webdriverio](https://www.npmjs.com/package/codecept-webdriverio) - * [codecept-protractor](https://www.npmjs.com/package/codecept-protractor) - * [codecept-nightmare](https://www.npmjs.com/package/codecept-nightmare) - +- **Command `multiple-run` added**, to execute tests in several browsers in parallel by **[APshenkin](https://github.com/APshenkin)** and **[davertmik](https://github.com/davertmik)**. [See documentation](http://codecept.io/advanced/#multiple-execution). +- **Hooks API added to extend CodeceptJS** with custom listeners and plugins. [See documentation](http://codecept.io/hooks/#hooks_1). +- [Nightmare][WebDriverIO] `within` can work with iframes by **[imvetri](https://github.com/imvetri)**. [See documentation](http://codecept.io/acceptance/#iframes). +- [WebDriverIO][SeleniumWebdriver][Protractor] Default browser changed to `chrome` +- **[Nightmare]** Fixed globally locating `nightmare-upload`. +- **[WebDriverIO]** added `seeNumberOfVisibleElements` method by **[elarouche](https://github.com/elarouche)**. +- Exit with non-zero code if init throws an error by **[rincedd](https://github.com/rincedd)** +- New guides published: + - [Installation](http://codecept.io/installation/) + - [Hooks](http://codecept.io/hooks/) + - [Advanced Usage](http://codecept.io/advanced/) +- Meta packages published: + - [codecept-webdriverio](https://www.npmjs.com/package/codecept-webdriverio) + - [codecept-protractor](https://www.npmjs.com/package/codecept-protractor) + - [codecept-nightmare](https://www.npmjs.com/package/codecept-nightmare) ## 0.5.1 -* [Polish translation](http://codecept.io/translation/#polish) added by **[limes](https://github.com/limes)**. -* Update process exit code so that mocha saves reports before exit by **[romanovma](https://github.com/romanovma)**. -* **[Nightmare]** fixed `getAttributeFrom` for custom attributes by **[robrkerr](https://github.com/robrkerr)** -* **[Nightmare]** Fixed *UnhandledPromiseRejectionWarning error* when selecting the dropdown using `selectOption` by **[robrkerr](https://github.com/robrkerr)**. [Se PR. -* **[Protractor]** fixed `pressKey` method by **[romanovma](https://github.com/romanovma)** +- [Polish translation](http://codecept.io/translation/#polish) added by **[limes](https://github.com/limes)**. +- Update process exit code so that mocha saves reports before exit by **[romanovma](https://github.com/romanovma)**. +- **[Nightmare]** fixed `getAttributeFrom` for custom attributes by **[robrkerr](https://github.com/robrkerr)** +- **[Nightmare]** Fixed _UnhandledPromiseRejectionWarning error_ when selecting the dropdown using `selectOption` by **[robrkerr](https://github.com/robrkerr)**. [Se PR. +- **[Protractor]** fixed `pressKey` method by **[romanovma](https://github.com/romanovma)** ## 0.5.0 -* Protractor ^5.0.0 support (while keeping ^4.0.9 compatibility) -* Fix 'fullTitle() is not a function' in exit.js by **[hubidu](https://github.com/hubidu)**. See [#388](https://github.com/codeceptjs/CodeceptJS/issues/388). -* **[Nightmare]** Fix for `waitTimeout` by **[HughZurname](https://github.com/HughZurname)**. See [#391](https://github.com/codeceptjs/CodeceptJS/issues/391). Resolves [#236](https://github.com/codeceptjs/CodeceptJS/issues/236)* Dockerized CodeceptJS setup by **[artiomnist](https://github.com/artiomnist)**. [See reference](https://github.com/codeceptjs/CodeceptJS/blob/master/docker/README.md) +- Protractor ^5.0.0 support (while keeping ^4.0.9 compatibility) +- Fix 'fullTitle() is not a function' in exit.js by **[hubidu](https://github.com/hubidu)**. See [#388](https://github.com/codeceptjs/CodeceptJS/issues/388). +- **[Nightmare]** Fix for `waitTimeout` by **[HughZurname](https://github.com/HughZurname)**. See [#391](https://github.com/codeceptjs/CodeceptJS/issues/391). Resolves [#236](https://github.com/codeceptjs/CodeceptJS/issues/236)\* Dockerized CodeceptJS setup by **[artiomnist](https://github.com/artiomnist)**. [See reference](https://github.com/codeceptjs/CodeceptJS/blob/master/docker/README.md) ## 0.4.16 -* Fixed steps output synchronization (regression since 0.4.14). -* [WebDriverIO][Protractor][SeleniumWebdriver][Nightmare] added `keepCookies` option to keep cookies between tests with `restart: false`. -* **[Protractor]** added `waitForTimeout` config option to set default waiting time for all wait* functions. -* Fixed `_test` hook for helpers by **[cjhille](https://github.com/cjhille)**. +- Fixed steps output synchronization (regression since 0.4.14). +- [WebDriverIO][Protractor][SeleniumWebdriver][Nightmare] added `keepCookies` option to keep cookies between tests with `restart: false`. +- **[Protractor]** added `waitForTimeout` config option to set default waiting time for all wait\* functions. +- Fixed `_test` hook for helpers by **[cjhille](https://github.com/cjhille)**. ## 0.4.15 -* Fixed regression in recorder sessions: `oldpromise is not defined`. +- Fixed regression in recorder sessions: `oldpromise is not defined`. ## 0.4.14 -* `_beforeStep` and `_afterStep` hooks in helpers are synchronized. Allows to perform additional actions between steps. +- `_beforeStep` and `_afterStep` hooks in helpers are synchronized. Allows to perform additional actions between steps. Example: fail if JS error occur in custom helper using WebdriverIO: @@ -3762,130 +4265,128 @@ _afterStep() { } ``` -* Fixed `codecept list` and `codecept def` commands. -* Added `I.say` method to print arbitrary comments. +- Fixed `codecept list` and `codecept def` commands. +- Added `I.say` method to print arbitrary comments. ```js -I.say('I am going to publish post'); -I.say('I enter title and body'); -I.say('I expect post is visible on site'); +I.say('I am going to publish post') +I.say('I enter title and body') +I.say('I expect post is visible on site') ``` -* **[Nightmare]** `restart` option added. `restart: false` allows to run all tests in a single window, disabled by default. By **[nairvijays99](https://github.com/nairvijays99)** -* **[Nightmare]** Fixed `resizeWindow` command. -* [Protractor][SeleniumWebdriver] added `windowSize` config option to resize window on start. -* Fixed "Scenario.skip causes 'Cannot read property retries of undefined'" by **[MasterOfPoppets](https://github.com/MasterOfPoppets)** -* Fixed providing absolute paths for tests in config by **[lennym](https://github.com/lennym)** +- **[Nightmare]** `restart` option added. `restart: false` allows to run all tests in a single window, disabled by default. By **[nairvijays99](https://github.com/nairvijays99)** +- **[Nightmare]** Fixed `resizeWindow` command. +- [Protractor][SeleniumWebdriver] added `windowSize` config option to resize window on start. +- Fixed "Scenario.skip causes 'Cannot read property retries of undefined'" by **[MasterOfPoppets](https://github.com/MasterOfPoppets)** +- Fixed providing absolute paths for tests in config by **[lennym](https://github.com/lennym)** ## 0.4.13 -* Added **retries** option `Feature` and `Scenario` to rerun fragile tests: +- Added **retries** option `Feature` and `Scenario` to rerun fragile tests: ```js -Feature('Complex JS Stuff', {retries: 3}); +Feature('Complex JS Stuff', { retries: 3 }) -Scenario('Not that complex', {retries: 1}, (I) => { +Scenario('Not that complex', { retries: 1 }, I => { // test goes here -}); +}) ``` -* Added **timeout** option `Feature` and `Scenario` to specify timeout. +- Added **timeout** option `Feature` and `Scenario` to specify timeout. ```js -Feature('Complex JS Stuff', {timeout: 5000}); +Feature('Complex JS Stuff', { timeout: 5000 }) -Scenario('Not that complex', {timeout: 1000}, (I) => { +Scenario('Not that complex', { timeout: 1000 }, I => { // test goes here -}); +}) ``` -* **[WebDriverIO]** Added `uniqueScreenshotNames` option to set unique screenshot names for failed tests. By **[APshenkin](https://github.com/APshenkin)**. See [#299](https://github.com/codeceptjs/CodeceptJS/issues/299) -* **[WebDriverIO]** `clearField` method improved to accept name/label locators and throw errors. -* [Nightmare][SeleniumWebdriver][Protractor] `clearField` method added. -* **[Nightmare]** Fixed `waitForElement`, and `waitForVisible` methods. -* **[Nightmare]** Fixed `resizeWindow` by **[norisk-it](https://github.com/norisk-it)** -* Added italian [translation](http://codecept.io/translation/#italian). +- **[WebDriverIO]** Added `uniqueScreenshotNames` option to set unique screenshot names for failed tests. By **[APshenkin](https://github.com/APshenkin)**. See [#299](https://github.com/codeceptjs/CodeceptJS/issues/299) +- **[WebDriverIO]** `clearField` method improved to accept name/label locators and throw errors. +- [Nightmare][SeleniumWebdriver][Protractor] `clearField` method added. +- **[Nightmare]** Fixed `waitForElement`, and `waitForVisible` methods. +- **[Nightmare]** Fixed `resizeWindow` by **[norisk-it](https://github.com/norisk-it)** +- Added italian [translation](http://codecept.io/translation/#italian). ## 0.4.12 -* Bootstrap / Teardown improved with [Hooks](http://codecept.io/configuration/#hooks). Various options for setup/teardown provided. -* Added `--override` or `-o` option for runner to dynamically override configs. Valid JSON should be passed: +- Bootstrap / Teardown improved with [Hooks](http://codecept.io/configuration/#hooks). Various options for setup/teardown provided. +- Added `--override` or `-o` option for runner to dynamically override configs. Valid JSON should be passed: ``` codeceptjs run -o '{ "bootstrap": "bootstrap.js"}' codeceptjs run -o '{ "helpers": {"WebDriverIO": {"browser": "chrome"}}}' ``` -* Added [regression tests](https://github.com/codeceptjs/CodeceptJS/tree/master/test/runner) for codeceptjs tests runner. +- Added [regression tests](https://github.com/codeceptjs/CodeceptJS/tree/master/test/runner) for codeceptjs tests runner. ## 0.4.11 -* Fixed regression in 0.4.10 -* Added `bootstrap`/`teardown` config options to accept functions as parameters by **[pscanf](https://github.com/pscanf)**. See updated [config reference](http://codecept.io/configuration/) [#319](https://github.com/codeceptjs/CodeceptJS/issues/319) +- Fixed regression in 0.4.10 +- Added `bootstrap`/`teardown` config options to accept functions as parameters by **[pscanf](https://github.com/pscanf)**. See updated [config reference](http://codecept.io/configuration/) [#319](https://github.com/codeceptjs/CodeceptJS/issues/319) ## 0.4.10 -* **[Protractor]** Protrctor 4.0.12+ support. -* Enabled async bootstrap file by **[abachar](https://github.com/abachar)**. Use inside `bootstrap.js`: +- **[Protractor]** Protrctor 4.0.12+ support. +- Enabled async bootstrap file by **[abachar](https://github.com/abachar)**. Use inside `bootstrap.js`: ```js -module.exports = function(done) { +module.exports = function (done) { // async instructions // call done() to continue execution // otherwise call done('error description') } ``` -* Changed 'pending' to 'skipped' in reports by **[timja-kainos](https://github.com/timja-kainos)**. See [#315](https://github.com/codeceptjs/CodeceptJS/issues/315) +- Changed 'pending' to 'skipped' in reports by **[timja-kainos](https://github.com/timja-kainos)**. See [#315](https://github.com/codeceptjs/CodeceptJS/issues/315) ## 0.4.9 -* [SeleniumWebdriver][Protractor][WebDriverIO][Nightmare] fixed `executeScript`, `executeAsyncScript` to work and return values. -* [Protractor][SeleniumWebdriver][WebDriverIO] Added `waitForInvisible` and `waitForStalenessOf` methods by **[Nighthawk14](https://github.com/Nighthawk14)**. -* Added `--config` option to `codeceptjs run` to manually specify config file by **[cnworks](https://github.com/cnworks)** -* **[Protractor]** Simplified behavior of `amOutsideAngularApp` by using `ignoreSynchronization`. Fixes [#278](https://github.com/codeceptjs/CodeceptJS/issues/278) -* Set exit code to 1 when test fails at `Before`/`After` hooks. Fixes [#279](https://github.com/codeceptjs/CodeceptJS/issues/279) - +- [SeleniumWebdriver][Protractor][WebDriverIO][Nightmare] fixed `executeScript`, `executeAsyncScript` to work and return values. +- [Protractor][SeleniumWebdriver][WebDriverIO] Added `waitForInvisible` and `waitForStalenessOf` methods by **[Nighthawk14](https://github.com/Nighthawk14)**. +- Added `--config` option to `codeceptjs run` to manually specify config file by **[cnworks](https://github.com/cnworks)** +- **[Protractor]** Simplified behavior of `amOutsideAngularApp` by using `ignoreSynchronization`. Fixes [#278](https://github.com/codeceptjs/CodeceptJS/issues/278) +- Set exit code to 1 when test fails at `Before`/`After` hooks. Fixes [#279](https://github.com/codeceptjs/CodeceptJS/issues/279) ## 0.4.8 -* [Protractor][SeleniumWebdriver][Nightmare] added `moveCursorTo` method. -* [Protractor][SeleniumWebdriver][WebDriverIO] Added `manualStart` option to start browser manually in the beginning of test. By **[cnworks](https://github.com/cnworks)**. [PR[#250](https://github.com/codeceptjs/CodeceptJS/issues/250) -* Fixed `codeceptjs init` to work with nested directories and file masks. -* Fixed `codeceptjs gt` to generate test with proper file name suffix. By **[Zougi](https://github.com/Zougi)**. -* **[Nightmare]** Fixed: Error is thrown when clicking on element which can't be locate. By **[davetmik](https://github.com/davetmik)** -* **[WebDriverIO]** Fixed `attachFile` for file upload. By **[giuband](https://github.com/giuband)** and **[davetmik](https://github.com/davetmik)** -* **[WebDriverIO]** Add support for timeouts in config and with `defineTimeouts` method. By **[easternbloc](https://github.com/easternbloc)** [#258](https://github.com/codeceptjs/CodeceptJS/issues/258) and [#267](https://github.com/codeceptjs/CodeceptJS/issues/267) by **[davetmik](https://github.com/davetmik)** -* Fixed hanging of CodeceptJS when error is thrown by event dispatcher. Fix by **[Zougi](https://github.com/Zougi)** and **[davetmik](https://github.com/davetmik)** - +- [Protractor][SeleniumWebdriver][Nightmare] added `moveCursorTo` method. +- [Protractor][SeleniumWebdriver][WebDriverIO] Added `manualStart` option to start browser manually in the beginning of test. By **[cnworks](https://github.com/cnworks)**. [PR[#250](https://github.com/codeceptjs/CodeceptJS/issues/250) +- Fixed `codeceptjs init` to work with nested directories and file masks. +- Fixed `codeceptjs gt` to generate test with proper file name suffix. By **[Zougi](https://github.com/Zougi)**. +- **[Nightmare]** Fixed: Error is thrown when clicking on element which can't be locate. By **[davetmik](https://github.com/davetmik)** +- **[WebDriverIO]** Fixed `attachFile` for file upload. By **[giuband](https://github.com/giuband)** and **[davetmik](https://github.com/davetmik)** +- **[WebDriverIO]** Add support for timeouts in config and with `defineTimeouts` method. By **[easternbloc](https://github.com/easternbloc)** [#258](https://github.com/codeceptjs/CodeceptJS/issues/258) and [#267](https://github.com/codeceptjs/CodeceptJS/issues/267) by **[davetmik](https://github.com/davetmik)** +- Fixed hanging of CodeceptJS when error is thrown by event dispatcher. Fix by **[Zougi](https://github.com/Zougi)** and **[davetmik](https://github.com/davetmik)** ## 0.4.7 -* Improved docs for `BeforeSuite`; fixed its usage with `restart: false` option by **[APshenkin](https://github.com/APshenkin)**. -* Added `Nightmare` to list of available helpers on `init`. -* **[Nightmare]** Removed double `resizeWindow` implementation. +- Improved docs for `BeforeSuite`; fixed its usage with `restart: false` option by **[APshenkin](https://github.com/APshenkin)**. +- Added `Nightmare` to list of available helpers on `init`. +- **[Nightmare]** Removed double `resizeWindow` implementation. ## 0.4.6 -* Added `BeforeSuite` and `AfterSuite` hooks to scenario by **[APshenkin](https://github.com/APshenkin)**. See [updated documentation](http://codecept.io/basics/#beforesuite) +- Added `BeforeSuite` and `AfterSuite` hooks to scenario by **[APshenkin](https://github.com/APshenkin)**. See [updated documentation](http://codecept.io/basics/#beforesuite) ## 0.4.5 -* Fixed running `codecept def` command by **[jankaspar](https://github.com/jankaspar)** -* [Protractor][SeleniumWebdriver] Added support for special keys in `pressKey` method. Fixes [#216](https://github.com/codeceptjs/CodeceptJS/issues/216) +- Fixed running `codecept def` command by **[jankaspar](https://github.com/jankaspar)** +- [Protractor][SeleniumWebdriver] Added support for special keys in `pressKey` method. Fixes [#216](https://github.com/codeceptjs/CodeceptJS/issues/216) ## 0.4.4 -* Interactive shell fixed. Start it by running `codeceptjs shell` -* Added `--profile` option to `shell` command to use dynamic configuration. -* Added `--verbose` option to `shell` command for most complete output. +- Interactive shell fixed. Start it by running `codeceptjs shell` +- Added `--profile` option to `shell` command to use dynamic configuration. +- Added `--verbose` option to `shell` command for most complete output. ## 0.4.3 -* **[Protractor]** Regression fixed to ^4.0.0 support -* Translations included into package. -* `teardown` option added to config (opposite to `bootstrap`), expects a JS file to be executed after tests stop. -* [Configuration](http://codecept.io/configuration/) can be set via JavaScript file `codecept.conf.js` instead of `codecept.json`. It should export `config` object: +- **[Protractor]** Regression fixed to ^4.0.0 support +- Translations included into package. +- `teardown` option added to config (opposite to `bootstrap`), expects a JS file to be executed after tests stop. +- [Configuration](http://codecept.io/configuration/) can be set via JavaScript file `codecept.conf.js` instead of `codecept.json`. It should export `config` object: ```js // inside codecept.conf.js @@ -3893,39 +4394,40 @@ exports.config = { // contents of codecept.js } ``` -* Added `--profile` option to pass its value to `codecept.conf.js` as `process.profile` for [dynamic configuration](http://codecept.io/configuration#dynamic-configuration). -* Documentation for [StepObjects, PageFragments](http://codecept.io/pageobjects#PageFragments) updated. -* Documentation for [Configuration](http://codecept.io/configuration/) added. + +- Added `--profile` option to pass its value to `codecept.conf.js` as `process.profile` for [dynamic configuration](http://codecept.io/configuration#dynamic-configuration). +- Documentation for [StepObjects, PageFragments](http://codecept.io/pageobjects#PageFragments) updated. +- Documentation for [Configuration](http://codecept.io/configuration/) added. ## 0.4.2 -* Added ability to localize tests with translation [#189](https://github.com/codeceptjs/CodeceptJS/issues/189). Thanks to **[abner](https://github.com/abner)** - * **[Translation]** ru-RU translation added. - * **[Translation]** pt-BR translation added. -* **[Protractor]** Protractor 4.0.4 compatibility. -* [WebDriverIO][SeleniumWebdriver][Protractor] Fixed single browser session mode for `restart: false` -* Fixed using of 3rd party reporters (xunit, mocha-junit-reporter, mochawesome). Added guide. -* Documentation for [Translation](http://codecept.io/translation/) added. -* Documentation for [Reports](http://codecept.io/reports/) added. +- Added ability to localize tests with translation [#189](https://github.com/codeceptjs/CodeceptJS/issues/189). Thanks to **[abner](https://github.com/abner)** + - **[Translation]** ru-RU translation added. + - **[Translation]** pt-BR translation added. +- **[Protractor]** Protractor 4.0.4 compatibility. +- [WebDriverIO][SeleniumWebdriver][Protractor] Fixed single browser session mode for `restart: false` +- Fixed using of 3rd party reporters (xunit, mocha-junit-reporter, mochawesome). Added guide. +- Documentation for [Translation](http://codecept.io/translation/) added. +- Documentation for [Reports](http://codecept.io/reports/) added. ## 0.4.1 -* Added custom steps to step definition list. See [#174](https://github.com/codeceptjs/CodeceptJS/issues/174) by **[jayS-de](https://github.com/jayS-de)** -* **[WebDriverIO]** Fixed using `waitForTimeout` option by **[stephane-ruhlmann](https://github.com/stephane-ruhlmann)**. See [#178](https://github.com/codeceptjs/CodeceptJS/issues/178) +- Added custom steps to step definition list. See [#174](https://github.com/codeceptjs/CodeceptJS/issues/174) by **[jayS-de](https://github.com/jayS-de)** +- **[WebDriverIO]** Fixed using `waitForTimeout` option by **[stephane-ruhlmann](https://github.com/stephane-ruhlmann)**. See [#178](https://github.com/codeceptjs/CodeceptJS/issues/178) ## 0.4.0 -* **[Nightmare](http://codecept.io/nightmare) Helper** added for faster web testing. -* [Protractor][SeleniumWebdriver][WebDriverIO] added `restart: false` option to reuse one browser between tests (improves speed). -* **Protractor 4.0** compatibility. Please upgrade Protractor library. -* Added `--verbose` option for `run` command to log and print global promise and events. -* Fixed errors with shutting down and cleanup. -* Fixed starting interactive shell with `codeceptjs shell`. -* Fixed handling of failures inside within block +- **[Nightmare](http://codecept.io/nightmare) Helper** added for faster web testing. +- [Protractor][SeleniumWebdriver][WebDriverIO] added `restart: false` option to reuse one browser between tests (improves speed). +- **Protractor 4.0** compatibility. Please upgrade Protractor library. +- Added `--verbose` option for `run` command to log and print global promise and events. +- Fixed errors with shutting down and cleanup. +- Fixed starting interactive shell with `codeceptjs shell`. +- Fixed handling of failures inside within block ## 0.3.5 -* Introduced IDE autocompletion support for Visual Studio Code and others. Added command for generating TypeScript definitions for `I` object. Use it as +- Introduced IDE autocompletion support for Visual Studio Code and others. Added command for generating TypeScript definitions for `I` object. Use it as ``` codeceptjs def @@ -3935,9 +4437,9 @@ to generate steps definition file and include it into tests by reference. By **[ ## 0.3.4 -* **[Protractor]** version 3.3.0 comptaibility, NPM 3 compatibility. Please update Protractor! -* allows using absolute path for helpers, output, in config and in command line. By **[denis-sokolov](https://github.com/denis-sokolov)** -* Fixes 'Cannot read property '1' of null in generate.js:44' by **[seethislight](https://github.com/seethislight)** +- **[Protractor]** version 3.3.0 comptaibility, NPM 3 compatibility. Please update Protractor! +- allows using absolute path for helpers, output, in config and in command line. By **[denis-sokolov](https://github.com/denis-sokolov)** +- Fixes 'Cannot read property '1' of null in generate.js:44' by **[seethislight](https://github.com/seethislight)** ## 0.3.3 @@ -3947,63 +4449,62 @@ Depending on installation type additional modules (webdriverio, protractor, ...) ## 0.3.2 -* Added `codeceptjs list` command which shows all available methods of `I` object. -* [Protractor][SeleniumWebdriver] fixed closing browser instances -* [Protractor][SeleniumWebdriver] `doubleClick` method added -* [WebDriverIO][Protractor][SeleniumWebdriver] `doubleClick` method to locate clickable elements by text, `context` option added. -* Fixed using assert in generator without yields [#89](https://github.com/codeceptjs/CodeceptJS/issues/89) +- Added `codeceptjs list` command which shows all available methods of `I` object. +- [Protractor][SeleniumWebdriver] fixed closing browser instances +- [Protractor][SeleniumWebdriver] `doubleClick` method added +- [WebDriverIO][Protractor][SeleniumWebdriver] `doubleClick` method to locate clickable elements by text, `context` option added. +- Fixed using assert in generator without yields [#89](https://github.com/codeceptjs/CodeceptJS/issues/89) ## 0.3.1 -* Fixed `init` command +- Fixed `init` command ## 0.3.0 **Breaking Change**: webdriverio package removed from dependencies list. You will need to install it manually after the upgrade. Starting from 0.3.0 webdriverio is not the only backend for running selenium tests, so you are free to choose between Protractor, SeleniumWebdriver, and webdriverio and install them. -* **[Protractor] helper added**. Now you can test AngularJS applications by using its official library within the unigied CodeceptJS API! -* **[SeleniumWebdriver] helper added**. You can switch to official JS bindings for Selenium. -* **[WebDriverIO]** **updated to webdriverio v 4.0** -* **[WebDriverIO]** `clearField` method added by **[fabioel](https://github.com/fabioel)** -* **[WebDriverIO]** added `dragAndDrop` by **[fabioel](https://github.com/fabioel)** -* **[WebDriverIO]** fixed `scrollTo` method by **[sensone](https://github.com/sensone)** -* **[WebDriverIO]** fixed `windowSize: maximize` option in config -* **[WebDriverIO]** `seeElement` and `dontSeeElement` check element for visibility by **[fabioel](https://github.com/fabioel)** and **[davertmik](https://github.com/davertmik)** -* **[WebDriverIO]** `seeElementInDOM`, `dontSeeElementInDOM` added to check element exists on page. -* **[WebDriverIO]** fixed saving screenshots on failure. Fixes [#70](https://github.com/codeceptjs/CodeceptJS/issues/70) -* fixed `within` block doesn't end in output not [#79](https://github.com/codeceptjs/CodeceptJS/issues/79) - +- **[Protractor] helper added**. Now you can test AngularJS applications by using its official library within the unigied CodeceptJS API! +- **[SeleniumWebdriver] helper added**. You can switch to official JS bindings for Selenium. +- **[WebDriverIO]** **updated to webdriverio v 4.0** +- **[WebDriverIO]** `clearField` method added by **[fabioel](https://github.com/fabioel)** +- **[WebDriverIO]** added `dragAndDrop` by **[fabioel](https://github.com/fabioel)** +- **[WebDriverIO]** fixed `scrollTo` method by **[sensone](https://github.com/sensone)** +- **[WebDriverIO]** fixed `windowSize: maximize` option in config +- **[WebDriverIO]** `seeElement` and `dontSeeElement` check element for visibility by **[fabioel](https://github.com/fabioel)** and **[davertmik](https://github.com/davertmik)** +- **[WebDriverIO]** `seeElementInDOM`, `dontSeeElementInDOM` added to check element exists on page. +- **[WebDriverIO]** fixed saving screenshots on failure. Fixes [#70](https://github.com/codeceptjs/CodeceptJS/issues/70) +- fixed `within` block doesn't end in output not [#79](https://github.com/codeceptjs/CodeceptJS/issues/79) ## 0.2.8 -* **[WebDriverIO]** added `seeNumberOfElements` by **[fabioel](https://github.com/fabioel)** +- **[WebDriverIO]** added `seeNumberOfElements` by **[fabioel](https://github.com/fabioel)** ## 0.2.7 -* process ends with exit code 1 on error or failure [#49](https://github.com/codeceptjs/CodeceptJS/issues/49) -* fixed registereing global Helper [#57](https://github.com/codeceptjs/CodeceptJS/issues/57) -* fixed handling error in within block [#50](https://github.com/codeceptjs/CodeceptJS/issues/50) +- process ends with exit code 1 on error or failure [#49](https://github.com/codeceptjs/CodeceptJS/issues/49) +- fixed registereing global Helper [#57](https://github.com/codeceptjs/CodeceptJS/issues/57) +- fixed handling error in within block [#50](https://github.com/codeceptjs/CodeceptJS/issues/50) ## 0.2.6 -* Fixed `done() was called multiple times` -* **[WebDriverIO]** added `waitToHide` method by **[fabioel](https://github.com/fabioel)** -* Added global `Helper` (alias `codecept_helper)`, object use for writing custom Helpers. Generator updated. Changes to [#48](https://github.com/codeceptjs/CodeceptJS/issues/48) +- Fixed `done() was called multiple times` +- **[WebDriverIO]** added `waitToHide` method by **[fabioel](https://github.com/fabioel)** +- Added global `Helper` (alias `codecept_helper)`, object use for writing custom Helpers. Generator updated. Changes to [#48](https://github.com/codeceptjs/CodeceptJS/issues/48) ## 0.2.5 -* Fixed issues with using yield inside a test [#45](https://github.com/codeceptjs/CodeceptJS/issues/45) [#47](https://github.com/codeceptjs/CodeceptJS/issues/47) [#43](https://github.com/codeceptjs/CodeceptJS/issues/43) -* Fixed generating a custom helper. Helper class is now accessible with `codecept_helper` var. Fixes [#48](https://github.com/codeceptjs/CodeceptJS/issues/48) +- Fixed issues with using yield inside a test [#45](https://github.com/codeceptjs/CodeceptJS/issues/45) [#47](https://github.com/codeceptjs/CodeceptJS/issues/47) [#43](https://github.com/codeceptjs/CodeceptJS/issues/43) +- Fixed generating a custom helper. Helper class is now accessible with `codecept_helper` var. Fixes [#48](https://github.com/codeceptjs/CodeceptJS/issues/48) ## 0.2.4 -* Fixed accessing helpers from custom helper by **[pim](https://github.com/pim)**. +- Fixed accessing helpers from custom helper by **[pim](https://github.com/pim)**. ## 0.2.3 -* **[WebDriverIO]** fixed `seeInField` to work with single value elements like: input[type=text], textareas, and multiple: select, input[type=radio], input[type=checkbox] -* **[WebDriverIO]** fixed `pressKey`, key modifeiers (Control, Command, Alt, Shift) are released after the action +- **[WebDriverIO]** fixed `seeInField` to work with single value elements like: input[type=text], textareas, and multiple: select, input[type=radio], input[type=checkbox] +- **[WebDriverIO]** fixed `pressKey`, key modifeiers (Control, Command, Alt, Shift) are released after the action ## 0.2.2 @@ -4013,9 +4514,9 @@ Whenever you need to create `I` object (in page objects, custom steps, but not i ## 0.2.0 -* **within** context hook added -* `--reporter` option supported -* **[WebDriverIO]** added features and methods: +- **within** context hook added +- `--reporter` option supported +- **[WebDriverIO]** added features and methods: - elements: `seeElement`, ... - popups: `acceptPopup`, `cancelPopup`, `seeInPopup`,... - navigation: `moveCursorTo`, `scrollTo` @@ -4025,9 +4526,8 @@ Whenever you need to create `I` object (in page objects, custom steps, but not i - form: `seeCheckboxIsChecked`, `selectOption` to support multiple selects - keyboard: `appendField`, `pressKey` - mouse: `rightClick` -* tests added -* **[WebDriverIO]** proxy configuration added by **[petehouston](https://github.com/petehouston)** -* **[WebDriverIO]** fixed `waitForText` method by **[roadhump](https://github.com/roadhump)**. Fixes [#11](https://github.com/codeceptjs/CodeceptJS/issues/11) -* Fixed creating output dir when it already exists on init by **[alfirin](https://github.com/alfirin)** -* Fixed loading of custom helpers - +- tests added +- **[WebDriverIO]** proxy configuration added by **[petehouston](https://github.com/petehouston)** +- **[WebDriverIO]** fixed `waitForText` method by **[roadhump](https://github.com/roadhump)**. Fixes [#11](https://github.com/codeceptjs/CodeceptJS/issues/11) +- Fixed creating output dir when it already exists on init by **[alfirin](https://github.com/alfirin)** +- Fixed loading of custom helpers diff --git a/docs/configuration.md b/docs/configuration.md index 2d07bd58a..0736c86a0 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -9,33 +9,34 @@ CodeceptJS configuration is set in `codecept.conf.js` file. After running `codeceptjs init` it should be saved in test root. -| Name | Type | Description | -| :------ | :------ | :------ | -| `bootstrap?` | (() => `Promise`<`void`\>) \| `boolean` \| `string` | [Execute code before](https://codecept.io/bootstrap/) tests are run. Can be either JS module file or async function: ```bootstrap: async () => server.launch(), ``` or ```bootstrap: 'bootstrap.js', ``` | -| `bootstrapAll?` | (() => `Promise`<`void`\>) \| `boolean` \| `string` | [Execute code before launching tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall) | -| `gherkin?` | { `features`: `string` \| `string`[] ; `steps`: `string`[] } | Enable [BDD features](https://codecept.io/bdd/#configuration). Sample configuration: ```gherkin: { features: "./features/*.feature", steps: ["./step_definitions/steps.js"] } ``` | -| `gherkin.features` | `string` \| `string`[] | load feature files by pattern. Multiple patterns can be specified as array | -| `gherkin.steps` | `string`[] | load step definitions from JS files | -| `grep?` | `string` | Pattern to filter tests by name. This option is useful if you plan to use multiple configs for different environments. To execute only tests with @firefox tag use ```grep: '@firefox' ``` | -| `helpers?` | {} | Enable and configure helpers: ```helpers: { Playwright: { url: 'https://mysite.com', browser: 'firefox' } } ``` | -| `include?` | `any` | Include page objects to access them via dependency injection ```I: "./custom_steps.js", loginPage: "./pages/Login.js", User: "./pages/User.js", ``` Configured modules can be injected by name in a Scenario: ```Scenario('test', { I, loginPage, User }) ``` | -| `mocha?` | `any` | [Mocha test runner options](https://mochajs.org/#configuring-mocha-nodejs), additional [reporters](https://codecept.io/reports/#xml) can be configured here. Example: ```mocha: { "mocha-junit-reporter": { stdout: "./output/console.log", options: { mochaFile: "./output/result.xml", attachments: true //add screenshot for a failed test } } } ``` | -| `noGlobals?` | `boolean` | Disable registering global functions (Before, Scenario, etc). Not recommended | -| `output` | `string` | Where to store failure screenshots, artifacts, etc ```output: './output' ``` | -| `plugins?` | `any` | Enable CodeceptJS plugins. Example: ```plugins: { autoDelay: { enabled: true } } ``` | -| `require?` | `string`[] | [Require additional JS modules](https://codecept.io/configuration/#require) Example: ``` require: ["should"] ``` | -| `teardown?` | (() => `Promise`<`void`\>) \| `boolean` \| `string` | [Execute code after tests](https://codecept.io/bootstrap/) finished. Can be either JS module file or async function: ```teardown: async () => server.stop(), ``` or ```teardown: 'teardown.js', ``` | -| `teardownAll?` | (() => `Promise`<`void`\>) \| `boolean` \| `string` | [Execute JS code after finishing tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall) | -| `tests` | `string` | Pattern to locate CodeceptJS tests. Allows to enter glob pattern or an Array of patterns to match tests / test file names. For tests in JavaScript: ```tests: 'tests/**.test.js' ``` For tests in TypeScript: ```tests: 'tests/**.test.ts' ``` | -| `timeout?` | `number` | Set default tests timeout in seconds. Tests will be killed on no response after timeout. ```timeout: 20, ``` | -| `translation?` | `string` | Enable [localized test commands](https://codecept.io/translation/) | - +| Name | Type | Description | +| :------------------- | :----------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `bootstrap?` | (() => `Promise`<`void`\>) \| `boolean` \| `string` | [Execute code before](https://codecept.io/bootstrap/) tests are run. Can be either JS module file or async function: `bootstrap: async () => server.launch(), ` or `bootstrap: 'bootstrap.js', ` | +| `bootstrapAll?` | (() => `Promise`<`void`\>) \| `boolean` \| `string` | [Execute code before launching tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall) | +| `gherkin?` | { `features`: `string` \| `string`[] ; `steps`: `string`[] } | Enable [BDD features](https://codecept.io/bdd/#configuration). Sample configuration: `gherkin: { features: "./features/*.feature", steps: ["./step_definitions/steps.js"] } ` | +| `gherkin.features` | `string` \| `string`[] | load feature files by pattern. Multiple patterns can be specified as array | +| `gherkin.steps` | `string`[] | load step definitions from JS files | +| `grep?` | `string` | Pattern to filter tests by name. This option is useful if you plan to use multiple configs for different environments. To execute only tests with @firefox tag use `grep: '@firefox' ` | +| `helpers?` | {} | Enable and configure helpers: `helpers: { Playwright: { url: 'https://mysite.com', browser: 'firefox' } } ` | +| `include?` | `any` | Include page objects to access them via dependency injection `I: "./custom_steps.js", loginPage: "./pages/Login.js", User: "./pages/User.js", ` Configured modules can be injected by name in a Scenario: `Scenario('test', { I, loginPage, User }) ` | +| `mocha?` | `any` | [Mocha test runner options](https://mochajs.org/#configuring-mocha-nodejs), additional [reporters](https://codecept.io/reports/#xml) can be configured here. Example: `mocha: { "mocha-junit-reporter": { stdout: "./output/console.log", options: { mochaFile: "./output/result.xml", attachments: true //add screenshot for a failed test } } } ` | +| `noGlobals?` | `boolean` | Disable registering global functions (Before, Scenario, etc). Not recommended | +| `output` | `string` | Where to store failure screenshots, artifacts, etc `output: './output' ` | +| `plugins?` | `any` | Enable CodeceptJS plugins. Example: `plugins: { autoDelay: { enabled: true } } ` | +| `require?` | `string`[] | [Require additional JS modules](https://codecept.io/configuration/#require) Example: `require: ["should"]` | +| `teardown?` | (() => `Promise`<`void`\>) \| `boolean` \| `string` | [Execute code after tests](https://codecept.io/bootstrap/) finished. Can be either JS module file or async function: `teardown: async () => server.stop(), ` or `teardown: 'teardown.js', ` | +| `teardownAll?` | (() => `Promise`<`void`\>) \| `boolean` \| `string` | [Execute JS code after finishing tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall) | +| `tests` | `string` | Pattern to locate CodeceptJS tests. Allows to enter glob pattern or an Array of patterns to match tests / test file names. For tests in JavaScript: `tests: 'tests/**.test.js' ` For tests in TypeScript: `tests: 'tests/**.test.ts' ` | +| `timeout?` | `number` | Set default tests timeout in seconds. Tests will be killed on no response after timeout. `timeout: 20, ` | +| `translation?` | `string` | Enable [localized test commands](https://codecept.io/translation/) | +| `maskSensitiveData?` | `boolean` | Enable to mask Sensitive Data in console. | ## Require Requires described module before run. This option is useful for assertion libraries, so you may `--require should` instead of manually invoking `require('should')` within each test file. It can be used with relative paths, e.g. `"require": ["/lib/somemodule"]`, and installed packages. You can register ts-node, so you can use Typescript in tests with ts-node package + ```js exports.config = { tests: './*_test.js', @@ -46,13 +47,15 @@ exports.config = { bootstrap: false, mocha: {}, // require modules - require: ["ts-node/register", "should"] + require: ['ts-node/register', 'should'], } ``` + For array of test pattern + ```js exports.config = { - tests: ['./*_test.js','./sampleTest.js'], + tests: ['./*_test.js', './sampleTest.js'], timeout: 10000, output: '', helpers: {}, @@ -60,21 +63,22 @@ exports.config = { bootstrap: false, mocha: {}, // require modules - require: ["ts-node/register", "should"] + require: ['ts-node/register', 'should'], } ``` + ## Dynamic Configuration - By default `codecept.json` is used for configuration. You can override its values in runtime by using `--override` or `-o` option in command line, passing valid JSON as a value: +By default `codecept.json` is used for configuration. You can override its values in runtime by using `--override` or `-o` option in command line, passing valid JSON as a value: ```sh codeceptjs run -o '{ "helpers": {"WebDriver": {"browser": "firefox"}}}' ``` - You can also switch to JS configuration format for more dynamic options. - Create `codecept.conf.js` file and make it export `config` property. +You can also switch to JS configuration format for more dynamic options. +Create `codecept.conf.js` file and make it export `config` property. - See the config example: +See the config example: ```js exports.config = { @@ -87,8 +91,8 @@ exports.config = { key: process.env.CLOUDSERVICE_KEY, coloredLogs: true, - waitForTimeout: 10000 - } + waitForTimeout: 10000, + }, }, // don't build monolithic configs @@ -96,12 +100,12 @@ exports.config = { include: { I: './src/steps_file.js', loginPage: './src/pages/login_page', - dashboardPage: new DashboardPage() - } + dashboardPage: new DashboardPage(), + }, // here goes config as it was in codecept.conf.ts // .... -}; +} ``` (Don't copy-paste this config, it's just demo) @@ -121,10 +125,10 @@ codeceptjs run --config=./path/to/my/config.js Install it and enable to easily switch to headless/window mode, change window size, etc. ```js -const { setHeadlessWhen, setWindowSize } = require('@codeceptjs/configure'); +const { setHeadlessWhen, setWindowSize } = require('@codeceptjs/configure') -setHeadlessWhen(process.env.CI); -setWindowSize(1600, 1200); +setHeadlessWhen(process.env.CI) +setWindowSize(1600, 1200) exports.config = { // ... @@ -149,9 +153,8 @@ exports.config = { WebDriver: { url: 'http://localhost:3000', // load value from `profile` - browser: process.env.profile || 'firefox' - - } - } -}; + browser: process.env.profile || 'firefox', + }, + }, +} ``` diff --git a/docs/data.md b/docs/data.md index 6c8bc4288..f1e876a8a 100644 --- a/docs/data.md +++ b/docs/data.md @@ -5,7 +5,7 @@ title: Data Management # Data Management -> This chapter describes data management for external sources. If you are looking for using Data Sets in tests, see [Data Driven Tests](https://codecept.io/advanced/#data-drivern-tests) section* +> This chapter describes data management for external sources. If you are looking for using Data Sets in tests, see [Data Driven Tests](https://codecept.io/advanced/#data-drivern-tests) section\* Managing data for tests is always a tricky issue. How isolate data between tests, how to prepare data for different tests, etc. There are different approaches to solve it: @@ -62,30 +62,30 @@ As well as a method for setting headers: `haveRequestHeaders`. Here is a usage example: ```js -let postId = null; +let postId = null -Scenario('check post page', async ({ I }) => { +Scenario('check post page', async ({ I }) => { // valid access token - I.haveRequestHeaders({auth: '1111111'}); + I.haveRequestHeaders({ auth: '1111111' }) // get the first user - let user = await I.sendGetRequest('/api/users/1'); + let user = await I.sendGetRequest('/api/users/1') // create a post and save its Id - postId = await I.sendPostRequest('/api/posts', { author: user.id, body: 'some text' }); + postId = await I.sendPostRequest('/api/posts', { author: user.id, body: 'some text' }) // open browser page of new post - I.amOnPage('/posts/2.html'); - I.see('some text', 'p.body'); -}); + I.amOnPage('/posts/2.html') + I.see('some text', 'p.body') +}) // cleanup created data After(({ I }) => { - I.sendDeleteRequest('/api/posts/'+postId); -}); + I.sendDeleteRequest('/api/posts/' + postId) +}) ``` This can also be used to emulate Ajax requests: ```js -I.sendPostRequest('/update-status', {}, { http_x_requested_with: 'xmlhttprequest' }); +I.sendPostRequest('/update-status', {}, { http_x_requested_with: 'xmlhttprequest' }) ``` > See complete reference on [REST](https://codecept.io/helpers/REST) helper @@ -129,37 +129,31 @@ As well as a method for setting headers: `haveRequestHeaders`. Here is a usage example: ```js -let postData = null; +let postData = null -Scenario('check post page', async ({ I }) => { +Scenario('check post page', async ({ I }) => { // valid access token - I.haveRequestHeaders({auth: '1111111'}); + I.haveRequestHeaders({ auth: '1111111' }) // get the first user - let response = await I.sendQuery('{ user(id:1) { id }}'); - let user = response.data; + let response = await I.sendQuery('{ user(id:1) { id }}') + let user = response.data // create a post and save its Id - response = await I.sendMutation( - 'mutation createPost($input: PostInput!) { createPost(input: $input) { id }}', - { - input : { - author: user.data.id, - body: 'some text', - } + response = await I.sendMutation('mutation createPost($input: PostInput!) { createPost(input: $input) { id }}', { + input: { + author: user.data.id, + body: 'some text', }, - ); - postData = response.data.data['createPost']; + }) + postData = response.data.data['createPost'] // open browser page of new post - I.amOnPage(`/posts/${postData.slug}.html`); - I.see(postData.body, 'p.body'); -}); + I.amOnPage(`/posts/${postData.slug}.html`) + I.see(postData.body, 'p.body') +}) // cleanup created data After(({ I }) => { - I.sendMutation( - 'mutation deletePost($id: ID!) { deletePost(id: $id) }', - { id: postData.id}, - ); -}); + I.sendMutation('mutation deletePost($id: ID!) { deletePost(id: $id) }', { id: postData.id }) +}) ``` > See complete reference on [GraphQL](https://codecept.io/helpers/GraphQL) helper @@ -167,6 +161,7 @@ After(({ I }) => { ## Data Generation with Factories This concept is extended by: + - [ApiDataFactory](https://codecept.io/helpers/ApiDataFactory/) helper, and, - [GraphQLDataFactory](https://codecept.io/helpers/GraphQLDataFactory/) helper. @@ -197,8 +192,8 @@ The way for setting data for a test is as simple as writing: ```js // inside async function -let post = await I.have('post'); -I.haveMultiple('comment', 5, { postId: post.id}); +let post = await I.have('post') +I.haveMultiple('comment', 5, { postId: post.id }) ``` After completing the preparations under 'Data Generation with Factories', create a factory module which will export a factory. @@ -207,12 +202,10 @@ See the example providing a factory for User generation: ```js // factories/post.js -var Factory = require('rosie').Factory; -var faker = require('@faker-js/faker'); +var Factory = require('rosie').Factory +var faker = require('@faker-js/faker') -module.exports = new Factory() - .attr('name', () => faker.person.findName()) - .attr('email', () => faker.internet.email()); +module.exports = new Factory().attr('name', () => faker.person.findName()).attr('email', () => faker.internet.email()) ``` Next is to configure helper to match factories with API: @@ -249,12 +242,10 @@ This way for setting data for a test is as simple as writing: ```js // inside async function -let post = await I.mutateData('createPost'); -I.mutateMultiple('createComment', 5, { postId: post.id}); +let post = await I.mutateData('createPost') +I.mutateMultiple('createComment', 5, { postId: post.id }) ``` - - After completing the preparations under 'Data Generation with Factories', create a factory module which will export a factory. The object built by the factory is sent as the variables object along with the mutation. So make sure it matches the argument type as detailed in the GraphQL schema. You may want to pass a constructor to the factory to achieve that. @@ -263,8 +254,8 @@ See the example providing a factory for User generation: ```js // factories/post.js -var Factory = require('rosie').Factory; -var faker = require('@faker-js/faker'); +var Factory = require('rosie').Factory +var faker = require('@faker-js/faker') module.exports = new Factory((buildObj) => { return { @@ -272,7 +263,7 @@ module.exports = new Factory((buildObj) => { } }) .attr('name', () => faker.person.findName()) - .attr('email', () => faker.internet.email()); + .attr('email', () => faker.internet.email()) ``` Next is to configure helper to match factories with API: @@ -326,10 +317,10 @@ Import `setSharedCookies` function and call it inside a config: ```js // in codecept.conf.js -const { setSharedCookies } = require('@codeceptjs/configure'); +const { setSharedCookies } = require('@codeceptjs/configure') // share cookies between browser helpers and REST/GraphQL -setSharedCookies(); +setSharedCookies() exports.config = {} ``` diff --git a/docs/effects.md b/docs/effects.md new file mode 100644 index 000000000..bf6d39a2d --- /dev/null +++ b/docs/effects.md @@ -0,0 +1,101 @@ +# Effects + +Effects are functions that can modify scenario flow. They provide ways to handle conditional steps, retries, and test flow control. + +## Installation + +Effects can be imported directly from CodeceptJS: + +```js +const { tryTo, retryTo, within } = require('codeceptjs/effects') +``` + +> 📝 Note: Prior to v3.7, `tryTo` and `retryTo` were available globally via plugins. This behavior is deprecated and will be removed in v4.0. + +## tryTo + +The `tryTo` effect allows you to attempt steps that may fail without stopping test execution. It's useful for handling optional steps or conditions that aren't critical for the test flow. + +```js +const { tryTo } = require('codeceptjs/effects') + +// inside a test +const success = await tryTo(() => { + // These steps may fail but won't stop the test + I.see('Cookie banner') + I.click('Accept cookies') +}) + +if (!success) { + I.say('Cookie banner was not found') +} +``` + +If the steps inside `tryTo` fail: + +- The test will continue execution +- The failure will be logged in debug output +- `tryTo` returns `false` +- Auto-retries are disabled inside `tryTo` blocks + +## retryTo + +The `retryTo` effect allows you to retry a set of steps multiple times until they succeed. This is useful for handling flaky elements or conditions that may need multiple attempts. + +```js +const { retryTo } = require('codeceptjs/effects') + +// Retry up to 5 times with 200ms between attempts +await retryTo(() => { + I.switchTo('#editor-frame') + I.fillField('textarea', 'Hello world') +}, 5) +``` + +Parameters: + +- `callback` - Function containing steps to retry +- `maxTries` - Maximum number of retry attempts +- `pollInterval` - (optional) Delay between retries in milliseconds (default: 200ms) + +The callback receives the current retry count as an argument: + +```js +const { retryTo } = require('codeceptjs/effects') + +// inside a test... +await retryTo(tries => { + I.say(`Attempt ${tries}`) + I.click('Submit') + I.see('Success') +}, 3) +``` + +## within + +The `within` effect allows you to perform multiple steps within a specific context (like an iframe or modal): + +```js +const { within } = require('codeceptjs/effects') + +// inside a test... + +within('.modal', () => { + I.see('Modal title') + I.click('Close') +}) +``` + +## Usage with TypeScript + +Effects are fully typed and work well with TypeScript: + +```ts +import { tryTo, retryTo, within } from 'codeceptjs/effects' + +const success = await tryTo(async () => { + await I.see('Element') +}) +``` + +This documentation covers the main effects functionality while providing practical examples and important notes about deprecation and future changes. Let me know if you'd like me to expand any section or add more examples! diff --git a/docs/els.md b/docs/els.md new file mode 100644 index 000000000..91acc10f3 --- /dev/null +++ b/docs/els.md @@ -0,0 +1,289 @@ +## Element Access + +The `els` module provides low-level element manipulation functions for CodeceptJS tests, allowing for more granular control over element interactions and assertions. However, because element representation differs between frameworks, tests using element functions are not portable between helpers. So if you set to use Playwright you won't be able to witch to WebDriver with one config change in CodeceptJS. + +### Usage + +Import the els functions in your test file: + +```js +const { element, eachElement, expectElement, expectAnyElement, expectAllElements } = require('codeceptjs/els'); +``` + +## element + +The `element` function allows you to perform custom operations on the first matching element found by a locator. It provides a low-level way to interact with elements when the built-in helper methods aren't sufficient. + +### Syntax + +```js +element(purpose, locator, fn); +// or +element(locator, fn); +``` + +### Parameters + +- `purpose` (optional) - A string describing the operation being performed. If omitted, a default purpose will be generated from the function. +- `locator` - A locator string/object to find the element(s). +- `fn` - An async function that receives the element as its argument and performs the desired operation. `el` argument represents an element of an underlying engine used: Playwright, WebDriver, or Puppeteer. + +### Returns + +Returns the result of the provided async function executed on the first matching element. + +### Example + +```js +Scenario('my test', async ({ I }) => { + // combine element function with standard steps: + I.amOnPage('/cart'); + + // but use await every time you use element function + await element( + // with explicit purpose + 'check custom attribute', + '.button', + async el => await el.getAttribute('data-test'), + ); + + // or simply + await element('.button', async el => { + return await el.isEnabled(); + }); +}); +``` + +### Notes + +- Only works with helpers that implement the `_locate` method +- The function will only operate on the first element found, even if multiple elements match the locator +- The provided callback must be an async function +- Throws an error if no helper with `_locate` method is enabled + +## eachElement + +The `eachElement` function allows you to perform operations on each element that matches a locator. It's useful for iterating through multiple elements and performing the same operation on each one. + +### Syntax + +```js +eachElement(purpose, locator, fn); +// or +eachElement(locator, fn); +``` + +### Parameters + +- `purpose` (optional) - A string describing the operation being performed. If omitted, a default purpose will be generated from the function. +- `locator` - A locator string/object to find the element(s). +- `fn` - An async function that receives two arguments: + - `el` - The current element being processed + - `index` - The index of the current element in the collection + +### Returns + +Returns a promise that resolves when all elements have been processed. If any element operation fails, the function will throw the first encountered error. + +### Example + +```js +Scenario('my test', async ({ I }) => { + // combine element function with standard steps: + I.click('/hotels'); + + // iterate over elements but don't forget to put await + await eachElement( + 'validate list items', // explain your actions for future review + '.list-item', // locator + async (el, index) => { + const text = await el.getText(); + console.log(`Item ${index}: ${text}`); + }, + ); + + // Or simply check if all checkboxes are checked + await eachElement('input[type="checkbox"]', async el => { + const isChecked = await el.isSelected(); + if (!isChecked) { + throw new Error('Found unchecked checkbox'); + } + }); +}); +``` + +### Notes + +- Only works with helpers that implement the `_locate` method +- The function will process all elements that match the locator +- The provided callback must be an async function +- If an operation fails on any element, the error is logged and the function continues processing remaining elements +- After all elements are processed, if any errors occurred, the first error is thrown +- Throws an error if no helper with `_locate` method is enabled + +## expectElement + +The `expectElement` function allows you to perform assertions on the first element that matches a locator. It's designed for validating element properties or states and will throw an assertion error if the condition is not met. + +### Syntax + +```js +expectElement(locator, fn); +``` + +### Parameters + +- `locator` - A locator string/object to find the element(s). +- `fn` - An async function that receives the element as its argument and should return a boolean value: + - `true` - The assertion passed + - `false` - The assertion failed + +### Returns + +Returns a promise that resolves when the assertion is complete. Throws an assertion error if the condition is not met. + +### Example + +```js +// Check if a button is enabled +await expectElement('.submit-button', async el => { + return await el.isEnabled(); +}); + +// Verify element has specific text content +await expectElement('.header', async el => { + const text = await el.getText(); + return text === 'Welcome'; +}); + +// Check for specific attribute value +await expectElement('#user-profile', async el => { + const role = await el.getAttribute('role'); + return role === 'button'; +}); +``` + +### Notes + +- Only works with helpers that implement the `_locate` method +- The function will only check the first element found, even if multiple elements match the locator +- The provided callback must be an async function that returns a boolean +- The assertion message will include both the locator and the function used for validation +- Throws an error if no helper with `_locate` method is enabled + +## expectAnyElement + +The `expectAnyElement` function allows you to perform assertions where at least one element from a collection should satisfy the condition. It's useful when you need to verify that at least one element among many matches your criteria. + +### Syntax + +```js +expectAnyElement(locator, fn); +``` + +### Parameters + +- `locator` - A locator string/object to find the element(s). +- `fn` - An async function that receives the element as its argument and should return a boolean value: + - `true` - The assertion passed for this element + - `false` - The assertion failed for this element + +### Returns + +Returns a promise that resolves when the assertion is complete. Throws an assertion error if no elements satisfy the condition. + +### Example + +```js +Scenario('validate any element matches criteria', async ({ I }) => { + // Navigate to the page + I.amOnPage('/products'); + + // Check if any product is marked as "in stock" + await expectAnyElement('.product-item', async el => { + const status = await el.getAttribute('data-status'); + return status === 'in-stock'; + }); + + // Verify at least one price is below $100 + await expectAnyElement('.price-tag', async el => { + const price = await el.getText(); + return parseFloat(price.replace('$', '')) < 100; + }); + + // Check if any button in the list is enabled + await expectAnyElement('.action-button', async el => { + return await el.isEnabled(); + }); +}); +``` + +### Notes + +- Only works with helpers that implement the `_locate` method +- The function will check all matching elements until it finds one that satisfies the condition +- Stops checking elements once the first matching condition is found +- The provided callback must be an async function that returns a boolean +- Throws an assertion error if no elements satisfy the condition +- Throws an error if no helper with `_locate` method is enabled + +## expectAllElements + +The `expectAllElements` function verifies that every element matching the locator satisfies the given condition. It's useful when you need to ensure that all elements in a collection meet specific criteria. + +### Syntax + +```js +expectAllElements(locator, fn); +``` + +### Parameters + +- `locator` - A locator string/object to find the element(s). +- `fn` - An async function that receives the element as its argument and should return a boolean value: + - `true` - The assertion passed for this element + - `false` - The assertion failed for this element + +### Returns + +Returns a promise that resolves when all assertions are complete. Throws an assertion error as soon as any element fails the condition. + +### Example + +```js +Scenario('validate all elements meet criteria', async ({ I }) => { + // Navigate to the page + I.amOnPage('/dashboard'); + + // Verify all required fields have the required attribute + await expectAllElements('.required-field', async el => { + const required = await el.getAttribute('required'); + return required !== null; + }); + + // Check if all checkboxes in a form are checked + await expectAllElements('input[type="checkbox"]', async el => { + return await el.isSelected(); + }); + + // Verify all items in a list have non-empty text + await expectAllElements('.list-item', async el => { + const text = await el.getText(); + return text.trim().length > 0; + }); + + // Ensure all buttons in a section are enabled + await expectAllElements('#action-section button', async el => { + return await el.isEnabled(); + }); +}); +``` + +### Notes + +- Only works with helpers that implement the `_locate` method +- The function checks every element that matches the locator +- Fails fast: stops checking elements as soon as one fails the condition +- The provided callback must be an async function that returns a boolean +- The assertion message will include which element number failed (e.g., "element #2 of...") +- Throws an error if no helper with `_locate` method is enabled diff --git a/docs/email.md b/docs/email.md index db8ee3297..2618f1b72 100644 --- a/docs/email.md +++ b/docs/email.md @@ -47,24 +47,24 @@ To create a mailbox use `I.haveNewMailbox()` command: ```js // inside async/await function -const mailbox = await I.haveNewMailbox(); +const mailbox = await I.haveNewMailbox() ``` mailbox object contains: -* `id` - which is used in next commands -* `emailAddress` - randomly generated address of a created mailbox. +- `id` - which is used in next commands +- `emailAddress` - randomly generated address of a created mailbox. > See [MailSlurp's guide](https://www.mailslurp.com/guides/getting-started/#create-email-addresses) for details. Mailbox is opened on creation. If you need more than one mailbox and you want to switch between them use `openMailbox` method: ```js -const mailbox1 = await I.haveNewMailbox(); -const mailbox2 = await I.haveNewMailbox(); +const mailbox1 = await I.haveNewMailbox() +const mailbox2 = await I.haveNewMailbox() // mailbox2 is now default mailbox // switch back to mailbox1 -I.openMailbox(mailbox1); +I.openMailbox(mailbox1) ``` ## Receiving An Email @@ -78,54 +78,55 @@ Use `waitForLatestEmail` function to return the first email from a mailbox: ```js // to wait for default time (10 secs by default) -I.waitForLatestEmail(); +I.waitForLatestEmail() // or specify number of time to wait -I.waitForLatestEmail(30); +I.waitForLatestEmail(30) ``` To specify the exact email to match use `waitForEmailMatching` function: ```js // wait for an email with partial match in subject -I.waitForEmailMatching({ subject: 'Restore password' }); +I.waitForEmailMatching({ subject: 'Restore password' }) // wait 30 seconds for email with exact subject -I.waitForEmailMatching({ subject: '=Forgot password' }, 30); +I.waitForEmailMatching({ subject: '=Forgot password' }, 30) // wait a last email from any address @mysite.com I.waitForEmailMatching({ - from: '@mysite.com', // find anything from mysite - subject: 'Restore password', // with Restore password in subject -}); + from: '@mysite.com', // find anything from mysite + subject: 'Restore password', // with Restore password in subject +}) ``` ## Opening An Email -All wait* functions return a matched email as a result. So you can use it in a test: +All wait\* functions return a matched email as a result. So you can use it in a test: ```js -const email = await I.waitForLatestEmail(); +const email = await I.waitForLatestEmail() ``` + > Please note, that we use `await` to assign email. This should be declared inside async function An `email` object contains the following fields: -* `subject` -* `for` -* `to` -* `body` +- `subject` +- `for` +- `to` +- `body` So you can analyze them inside a test. For instance, you can extract an URL from email body and open it. This is how we can emulate "click on this link" behavior in email: ```js // clicking a link in email -const email = await I.waitForLatestEmail(); +const email = await I.waitForLatestEmail() // extract a link by RegExp -const url = email.body.match(/http(s):\/\/(.*?)\s/)[0]; +const url = email.body.match(/http(s):\/\/(.*?)\s/)[0] // open URL -I.amOnPage(url); +I.amOnPage(url) ``` ## Assertions @@ -133,31 +134,31 @@ I.amOnPage(url); Assertions are performed on the currently opened email. Email is opened on `waitFor` email call, however, you can open an exact email by using `openEmail` function. ```js -const email1 = await I.waitForLatestEmail(); +const email1 = await I.waitForLatestEmail() // test proceeds... -const email2 = await I.waitForLatestEmail(); -I.openEmail(email1); // open previous email +const email2 = await I.waitForLatestEmail() +I.openEmail(email1) // open previous email ``` After opening an email assertion methods are available. -* `seeInEmailSubject` -* `seeEmailIsFrom` -* `seeInEmailBody` -* `dontSeeInEmailBody` -* `seeNumberOfEmailAttachments` -* `seeEmailAttachment` +- `seeInEmailSubject` +- `seeEmailIsFrom` +- `seeInEmailBody` +- `dontSeeInEmailBody` +- `seeNumberOfEmailAttachments` +- `seeEmailAttachment` And here is an example of their usage: ```js I.waitForLatestEmail() -I.seeEmailIsFrom('@mysite.com'); -I.seeInEmailSubject('Awesome Proposal!'); -I.seeInEmailBody('To unsubscribe click here'); -I.seeNumberOfEmailAttachments(2); -I.seeEmailAttachment('Attachment_1.pdf'); // Regular expression. Escape special characters like '(' or ')' in filename. -I.seeEmailAttachment('Attachment_2.pdf'); +I.seeEmailIsFrom('@mysite.com') +I.seeInEmailSubject('Awesome Proposal!') +I.seeInEmailBody('To unsubscribe click here') +I.seeNumberOfEmailAttachments(2) +I.seeEmailAttachment('Attachment_1.pdf') // Regular expression. Escape special characters like '(' or ')' in filename. +I.seeEmailAttachment('Attachment_2.pdf') ``` > More methods are listed in [helper's API reference](https://github.com/codeceptjs/mailslurp-helper/blob/master/README.md#api) @@ -167,7 +168,7 @@ I.seeEmailAttachment('Attachment_2.pdf'); Use `grabAllEmailsFromMailbox` to get all emails from a current mailbox: ```js -const emails = await I.grabAllEmailsFromMailbox(); +const emails = await I.grabAllEmailsFromMailbox() ``` ## Sending an Email @@ -178,6 +179,6 @@ You can also send an email from an active mailbox: I.sendEmail({ to: ['user@site.com'], subject: 'Hello', - body: 'World' -}); + body: 'World', +}) ``` diff --git a/docs/examples.md b/docs/examples.md index 73edfd231..aece3c686 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -7,7 +7,9 @@ editLink: false --- # Examples + > Add your own examples to our [Wiki Page](https://github.com/codeceptjs/CodeceptJS/wiki/Examples) + ## [TodoMVC Examples](https://github.com/codecept-js/examples) ![](https://github.com/codecept-js/examples/raw/master/todo.png) @@ -16,13 +18,13 @@ Playground repository where you can run tests in different helpers on a basic si Tests repository demonstrate usage of -* Playwright helper -* Puppeteer helper -* WebDriver helper -* TestCafe plugin -* Toggle headless mode with env variables -* PageObjects -* Cucumber syntax +- Playwright helper +- 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) @@ -33,27 +35,27 @@ Our team uses it to test new features and run simple scenarios. 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 +- 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) +Complex testing solution by [Gen3](https://github.com/uc-cdis/gen3-qa) -Includes +Includes -* classical CodeceptJS tests -* BDD tests -* Jenkins integration -* Complex Before/BeforeSuite scripts and more +- classical CodeceptJS tests +- BDD tests +- Jenkins integration +- Complex Before/BeforeSuite scripts and more ## [Testing Single Page Application](https://github.com/bugiratracker/codeceptjs-demo) @@ -61,20 +63,20 @@ 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 +- 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**. +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 +- dynamic config with profiles +- testing WYSIWYG editor +- GitLab CI ## [Amazon Tests v2](https://gitlab.com/thanhnguyendh/codeceptjs-wdio-services) @@ -82,11 +84,11 @@ Testing Amazon website using Selenium WebDriver. This repository demonstrates usage of: -* WebDriver helper -* Page Objects -* wdio services (selenium-standalone) -* Parallel execution -* GitLab CI setup +- WebDriver helper +- Page Objects +- wdio services (selenium-standalone) +- Parallel execution +- GitLab CI setup ## [Tests with Docker Compose](https://github.com/mathesouza/codeceptjs-docker-compose) @@ -94,10 +96,9 @@ Running CodeceptJS tests with Docker Compose This repository demonstrates usage of: -* CodeceptJS Docker image -* WebDriver helper -* Allure plugin - +- CodeceptJS Docker image +- WebDriver helper +- Allure plugin ## [AngularJS Example Tests](https://github.com/armno/angular-e2e-codeceptjs-example) @@ -105,51 +106,57 @@ Based on [Setting up End-to-End Testing in Angular Project with CodeceptJS](http This repository demonstrates usage of -* Puppeteer helper -* Working with Angular CLI -* Reports with Mochawesome helper +- 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 +- 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 +- 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 +- 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. + +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 +- 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 ## [Playwright fun with CodeceptJS](https://github.com/PeterNgTr/codeceptjs-playwright-fun) -* Tests are written in TS -* CI/CD with Github Actions -* Page Object Model is applied -* ReportPortal Integration \ No newline at end of file + +- Tests are written in TS +- CI/CD with Github Actions +- Page Object Model is applied +- ReportPortal Integration + +## How to + +- Create a plugin with TS [link](https://github.com/reutenkoivan/codeceptjs-plugins/tree/main/packages/html-snapshot-on-fail) diff --git a/docs/helpers/Appium.md b/docs/helpers/Appium.md index 7b9fdab62..5354d0c34 100644 --- a/docs/helpers/Appium.md +++ b/docs/helpers/Appium.md @@ -32,7 +32,7 @@ Launch the daemon: `appium` This helper should be configured in codecept.conf.ts or codecept.conf.js -* `appiumV2`: set this to true if you want to run tests with AppiumV2. See more how to setup [here][3] +* `appiumV2`: by default is true, set this to false if you want to run tests with AppiumV1. See more how to setup [here][3] * `app`: Application path. Local path or remote URL to an .ipa or .apk file, or a .zip containing one of these. Alias to desiredCapabilities.appPackage * `host`: (default: 'localhost') Appium host * `port`: (default: '4723') Appium port @@ -112,7 +112,7 @@ Example Android App using AppiumV2 on BrowserStack: { helpers: { Appium: { - appiumV2: true, + appiumV2: true, // By default is true, set to false if you want to run against Appium v1 host: "hub-cloud.browserstack.com", port: 4444, user: process.env.BROWSERSTACK_USER, @@ -550,19 +550,10 @@ Hide the keyboard. ```js // taps outside to hide keyboard per default I.hideDeviceKeyboard(); -I.hideDeviceKeyboard('tapOutside'); - -// or by pressing key -I.hideDeviceKeyboard('pressKey', 'Done'); ``` Appium: support Android and iOS -#### Parameters - -* `strategy` **(`"tapOutside"` | `"pressKey"`)?** Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’) -* `key` **[string][5]?** Optional key - ### sendDeviceKeyEvent Send a key event to the device. diff --git a/docs/helpers/ExpectHelper.md b/docs/helpers/ExpectHelper.md index 3a0659b29..3a437f48e 100644 --- a/docs/helpers/ExpectHelper.md +++ b/docs/helpers/ExpectHelper.md @@ -31,33 +31,33 @@ Zero-configuration when paired with other helpers like REST, Playwright: #### Parameters -* `targetData` **any** -* `aboveThan` **any** -* `customErrorMsg` **any?** +- `targetData` **any** +- `aboveThan` **any** +- `customErrorMsg` **any?** ### expectBelow #### Parameters -* `targetData` **any** -* `belowThan` **any** -* `customErrorMsg` **any?** +- `targetData` **any** +- `belowThan` **any** +- `customErrorMsg` **any?** ### expectContain #### Parameters -* `actualValue` **any** -* `expectedValueToContain` **any** -* `customErrorMsg` **any?** +- `actualValue` **any** +- `expectedValueToContain` **any** +- `customErrorMsg` **any?** ### expectDeepEqual #### Parameters -* `actualValue` **any** -* `expectedValue` **any** -* `customErrorMsg` **any?** +- `actualValue` **any** +- `expectedValue` **any** +- `customErrorMsg` **any?** ### expectDeepEqualExcluding @@ -65,10 +65,10 @@ expects members of two JSON objects are deeply equal excluding some properties #### Parameters -* `actualValue` **any** -* `expectedValue` **any** -* `fieldsToExclude` **any** -* `customErrorMsg` **any?** +- `actualValue` **any** +- `expectedValue` **any** +- `fieldsToExclude` **any** +- `customErrorMsg` **any?** ### expectDeepIncludeMembers @@ -76,9 +76,9 @@ expects an array to be a superset of another array #### Parameters -* `superset` **any** -* `set` **any** -* `customErrorMsg` **any?** +- `superset` **any** +- `set` **any** +- `customErrorMsg` **any?** ### expectDeepMembers @@ -86,104 +86,104 @@ expects members of two arrays are deeply equal #### Parameters -* `actualValue` **any** -* `expectedValue` **any** -* `customErrorMsg` **any?** +- `actualValue` **any** +- `expectedValue` **any** +- `customErrorMsg` **any?** ### expectEmpty #### Parameters -* `targetData` **any** -* `customErrorMsg` **any?** +- `targetData` **any** +- `customErrorMsg` **any?** ### expectEndsWith #### Parameters -* `actualValue` **any** -* `expectedValueToEndWith` **any** -* `customErrorMsg` **any?** +- `actualValue` **any** +- `expectedValueToEndWith` **any** +- `customErrorMsg` **any?** ### expectEqual #### Parameters -* `actualValue` **any** -* `expectedValue` **any** -* `customErrorMsg` **any?** +- `actualValue` **any** +- `expectedValue` **any** +- `customErrorMsg` **any?** ### expectEqualIgnoreCase #### Parameters -* `actualValue` **any** -* `expectedValue` **any** -* `customErrorMsg` **any?** +- `actualValue` **any** +- `expectedValue` **any** +- `customErrorMsg` **any?** ### expectFalse #### Parameters -* `targetData` **any** -* `customErrorMsg` **any?** +- `targetData` **any** +- `customErrorMsg` **any?** ### expectHasAProperty #### Parameters -* `targetData` **any** -* `propertyName` **any** -* `customErrorMsg` **any?** +- `targetData` **any** +- `propertyName` **any** +- `customErrorMsg` **any?** ### expectHasProperty #### Parameters -* `targetData` **any** -* `propertyName` **any** -* `customErrorMsg` **any?** +- `targetData` **any** +- `propertyName` **any** +- `customErrorMsg` **any?** ### expectJsonSchema #### Parameters -* `targetData` **any** -* `jsonSchema` **any** -* `customErrorMsg` **any?** +- `targetData` **any** +- `jsonSchema` **any** +- `customErrorMsg` **any?** ### expectJsonSchemaUsingAJV #### Parameters -* `targetData` **any** -* `jsonSchema` **any** -* `customErrorMsg` **any?** -* `ajvOptions` **any?** Pass AJV options +- `targetData` **any** +- `jsonSchema` **any** +- `customErrorMsg` **any?** +- `ajvOptions` **any?** Pass AJV options ### expectLengthAboveThan #### Parameters -* `targetData` **any** -* `lengthAboveThan` **any** -* `customErrorMsg` **any?** +- `targetData` **any** +- `lengthAboveThan` **any** +- `customErrorMsg` **any?** ### expectLengthBelowThan #### Parameters -* `targetData` **any** -* `lengthBelowThan` **any** -* `customErrorMsg` **any?** +- `targetData` **any** +- `lengthBelowThan` **any** +- `customErrorMsg` **any?** ### expectLengthOf #### Parameters -* `targetData` **any** -* `length` **any** -* `customErrorMsg` **any?** +- `targetData` **any** +- `length` **any** +- `customErrorMsg` **any?** ### expectMatchesPattern @@ -191,85 +191,85 @@ expects a JSON object matches a provided pattern #### Parameters -* `actualValue` **any** -* `expectedPattern` **any** -* `customErrorMsg` **any?** +- `actualValue` **any** +- `expectedPattern` **any** +- `customErrorMsg` **any?** ### expectMatchRegex #### Parameters -* `targetData` **any** -* `regex` **any** -* `customErrorMsg` **any?** +- `targetData` **any** +- `regex` **any** +- `customErrorMsg` **any?** ### expectNotContain #### Parameters -* `actualValue` **any** -* `expectedValueToNotContain` **any** -* `customErrorMsg` **any?** +- `actualValue` **any** +- `expectedValueToNotContain` **any** +- `customErrorMsg` **any?** ### expectNotDeepEqual #### Parameters -* `actualValue` **any** -* `expectedValue` **any** -* `customErrorMsg` **any?** +- `actualValue` **any** +- `expectedValue` **any** +- `customErrorMsg` **any?** ### expectNotEndsWith #### Parameters -* `actualValue` **any** -* `expectedValueToNotEndWith` **any** -* `customErrorMsg` **any?** +- `actualValue` **any** +- `expectedValueToNotEndWith` **any** +- `customErrorMsg` **any?** ### expectNotEqual #### Parameters -* `actualValue` **any** -* `expectedValue` **any** -* `customErrorMsg` **any?** +- `actualValue` **any** +- `expectedValue` **any** +- `customErrorMsg` **any?** ### expectNotStartsWith #### Parameters -* `actualValue` **any** -* `expectedValueToNotStartWith` **any** -* `customErrorMsg` **any?** +- `actualValue` **any** +- `expectedValueToNotStartWith` **any** +- `customErrorMsg` **any?** ### expectStartsWith #### Parameters -* `actualValue` **any** -* `expectedValueToStartWith` **any** -* `customErrorMsg` **any?** +- `actualValue` **any** +- `expectedValueToStartWith` **any** +- `customErrorMsg` **any?** ### expectToBeA #### Parameters -* `targetData` **any** -* `type` **any** -* `customErrorMsg` **any?** +- `targetData` **any** +- `type` **any** +- `customErrorMsg` **any?** ### expectToBeAn #### Parameters -* `targetData` **any** -* `type` **any** -* `customErrorMsg` **any?** +- `targetData` **any** +- `type` **any** +- `customErrorMsg` **any?** ### expectTrue #### Parameters -* `targetData` **any** -* `customErrorMsg` **any?** +- `targetData` **any** +- `customErrorMsg` **any?** diff --git a/docs/helpers/JSONResponse.md b/docs/helpers/JSONResponse.md index 8cc350f6a..e9c12ca9c 100644 --- a/docs/helpers/JSONResponse.md +++ b/docs/helpers/JSONResponse.md @@ -227,13 +227,14 @@ I.seeResponseMatchesJsonSchema(joi.object({ ### seeResponseValidByCallback -Executes a callback function passing in `response` object and chai assertions with `expect` +Executes a callback function passing in `response` object and assert Use it to perform custom checks of response data ```js -I.seeResponseValidByCallback(({ data, status, expect }) => { - expect(status).to.eql(200); - expect(data).keys.to.include(['user', 'company']); +I.seeResponseValidByCallback(({ data, status }) => { + assert.strictEqual(status, 200); + assert('user' in data); + assert('company' in data); }); ``` diff --git a/docs/helpers/Nightmare.md b/docs/helpers/Nightmare.md index ce1deb302..12727861e 100644 --- a/docs/helpers/Nightmare.md +++ b/docs/helpers/Nightmare.md @@ -148,7 +148,7 @@ if none provided clears all cookies. ```js I.clearCookie(); -I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name +I.clearCookie('test'); ``` #### Parameters diff --git a/docs/helpers/Playwright.md b/docs/helpers/Playwright.md index 9f7c9da4f..396349107 100644 --- a/docs/helpers/Playwright.md +++ b/docs/helpers/Playwright.md @@ -546,11 +546,12 @@ if none provided clears all cookies. ```js I.clearCookie(); -I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name +I.clearCookie('test'); ``` #### Parameters +* `cookieName` * `cookie` **[string][9]?** (optional, `null` by default) cookie name ### clearField diff --git a/docs/helpers/Protractor.md b/docs/helpers/Protractor.md index f70d2893d..f7847d683 100644 --- a/docs/helpers/Protractor.md +++ b/docs/helpers/Protractor.md @@ -267,7 +267,7 @@ if none provided clears all cookies. ```js I.clearCookie(); -I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name +I.clearCookie('test'); ``` #### Parameters diff --git a/docs/helpers/Puppeteer.md b/docs/helpers/Puppeteer.md index ea7a3e161..3a7702dde 100644 --- a/docs/helpers/Puppeteer.md +++ b/docs/helpers/Puppeteer.md @@ -398,7 +398,7 @@ if none provided clears all cookies. ```js I.clearCookie(); -I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name +I.clearCookie('test'); ``` #### Parameters diff --git a/docs/helpers/SoftExpectHelper.md b/docs/helpers/SoftExpectHelper.md index 68f7ef1c8..698a3d173 100644 --- a/docs/helpers/SoftExpectHelper.md +++ b/docs/helpers/SoftExpectHelper.md @@ -42,7 +42,7 @@ I.flushSoftAssertions() // Throws an error if any soft assertions have failed. T Throws an error if any soft assertions have failed. The error message contains all the accumulated failures. -* Throws **[Error][1]** If there are any soft assertion failures. +- Throws **[Error][1]** If there are any soft assertion failures. ### softAssert @@ -51,8 +51,8 @@ If the assertion fails, the error is caught and stored without halting the execu #### Parameters -* `assertionFn` **[Function][2]** The assertion function to execute. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `assertionFn` **[Function][2]** The assertion function to execute. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectAbove @@ -60,9 +60,9 @@ Softly asserts that the target data is above a specified value. #### Parameters -* `targetData` **any** The data to check. -* `aboveThan` **any** The value that the target data should be above. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `targetData` **any** The data to check. +- `aboveThan` **any** The value that the target data should be above. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectBelow @@ -70,9 +70,9 @@ Softly asserts that the target data is below a specified value. #### Parameters -* `targetData` **any** The data to check. -* `belowThan` **any** The value that the target data should be below. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `targetData` **any** The data to check. +- `belowThan` **any** The value that the target data should be below. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectContain @@ -80,9 +80,9 @@ Softly asserts that a value contains the expected value. #### Parameters -* `actualValue` **any** The actual value. -* `expectedValueToContain` **any** The value that should be contained within the actual value. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `actualValue` **any** The actual value. +- `expectedValueToContain` **any** The value that should be contained within the actual value. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectDeepEqual @@ -90,9 +90,9 @@ Softly asserts that two values are deeply equal. #### Parameters -* `actualValue` **any** The actual value. -* `expectedValue` **any** The expected value. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `actualValue` **any** The actual value. +- `expectedValue` **any** The expected value. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectDeepEqualExcluding @@ -100,10 +100,10 @@ Softly asserts that two objects are deeply equal, excluding specified fields. #### Parameters -* `actualValue` **[Object][4]** The actual object. -* `expectedValue` **[Object][4]** The expected object. -* `fieldsToExclude` **[Array][5]<[string][3]>** The fields to exclude from the comparison. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `actualValue` **[Object][4]** The actual object. +- `expectedValue` **[Object][4]** The expected object. +- `fieldsToExclude` **[Array][5]<[string][3]>** The fields to exclude from the comparison. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectDeepIncludeMembers @@ -111,9 +111,9 @@ Softly asserts that an array (superset) deeply includes all members of another a #### Parameters -* `superset` **[Array][5]** The array that should contain the expected members. -* `set` **[Array][5]** The array with members that should be included. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `superset` **[Array][5]** The array that should contain the expected members. +- `set` **[Array][5]** The array with members that should be included. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectDeepMembers @@ -121,9 +121,9 @@ Softly asserts that two arrays have deep equality, considering members in any or #### Parameters -* `actualValue` **[Array][5]** The actual array. -* `expectedValue` **[Array][5]** The expected array. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `actualValue` **[Array][5]** The actual array. +- `expectedValue` **[Array][5]** The expected array. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectEmpty @@ -131,8 +131,8 @@ Softly asserts that the target data is empty. #### Parameters -* `targetData` **any** The data to check. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `targetData` **any** The data to check. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectEndsWith @@ -140,9 +140,9 @@ Softly asserts that a value ends with the expected value. #### Parameters -* `actualValue` **any** The actual value. -* `expectedValueToEndWith` **any** The value that the actual value should end with. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `actualValue` **any** The actual value. +- `expectedValueToEndWith` **any** The value that the actual value should end with. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectEqual @@ -150,9 +150,9 @@ Softly asserts that two values are equal. #### Parameters -* `actualValue` **any** The actual value. -* `expectedValue` **any** The expected value. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `actualValue` **any** The actual value. +- `expectedValue` **any** The expected value. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectEqualIgnoreCase @@ -160,9 +160,9 @@ Softly asserts that two values are equal, ignoring case. #### Parameters -* `actualValue` **[string][3]** The actual string value. -* `expectedValue` **[string][3]** The expected string value. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `actualValue` **[string][3]** The actual string value. +- `expectedValue` **[string][3]** The expected string value. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectFalse @@ -170,8 +170,8 @@ Softly asserts that the target data is false. #### Parameters -* `targetData` **any** The data to check. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `targetData` **any** The data to check. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectHasAProperty @@ -179,9 +179,9 @@ Softly asserts that the target data has a property with the specified name. #### Parameters -* `targetData` **any** The data to check. -* `propertyName` **[string][3]** The property name to check for. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `targetData` **any** The data to check. +- `propertyName` **[string][3]** The property name to check for. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectHasProperty @@ -189,10 +189,10 @@ Softly asserts that the target data has the specified property. #### Parameters -* `targetData` **any** The data to check. -* `propertyName` **[string][3]** The property name to check for. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion - fails. +- `targetData` **any** The data to check. +- `propertyName` **[string][3]** The property name to check for. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion + fails. ### softExpectJsonSchema @@ -200,9 +200,9 @@ Softly asserts that the target data matches the given JSON schema. #### Parameters -* `targetData` **any** The data to validate. -* `jsonSchema` **[Object][4]** The JSON schema to validate against. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `targetData` **any** The data to validate. +- `jsonSchema` **[Object][4]** The JSON schema to validate against. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectJsonSchemaUsingAJV @@ -210,10 +210,10 @@ Softly asserts that the target data matches the given JSON schema using AJV. #### Parameters -* `targetData` **any** The data to validate. -* `jsonSchema` **[Object][4]** The JSON schema to validate against. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. -* `ajvOptions` **[Object][4]** Options to pass to AJV. +- `targetData` **any** The data to validate. +- `jsonSchema` **[Object][4]** The JSON schema to validate against. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `ajvOptions` **[Object][4]** Options to pass to AJV. ### softExpectLengthAboveThan @@ -221,9 +221,9 @@ Softly asserts that the length of the target data is above a specified value. #### Parameters -* `targetData` **any** The data to check. -* `lengthAboveThan` **[number][6]** The length that the target data should be above. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `targetData` **any** The data to check. +- `lengthAboveThan` **[number][6]** The length that the target data should be above. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectLengthBelowThan @@ -231,9 +231,9 @@ Softly asserts that the length of the target data is below a specified value. #### Parameters -* `targetData` **any** The data to check. -* `lengthBelowThan` **[number][6]** The length that the target data should be below. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `targetData` **any** The data to check. +- `lengthBelowThan` **[number][6]** The length that the target data should be below. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectLengthOf @@ -241,9 +241,9 @@ Softly asserts that the target data has a specified length. #### Parameters -* `targetData` **any** The data to check. -* `length` **[number][6]** The expected length. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `targetData` **any** The data to check. +- `length` **[number][6]** The expected length. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectMatchesPattern @@ -251,9 +251,9 @@ Softly asserts that a value matches the expected pattern. #### Parameters -* `actualValue` **any** The actual value. -* `expectedPattern` **any** The pattern the value should match. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `actualValue` **any** The actual value. +- `expectedPattern` **any** The pattern the value should match. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectNotContain @@ -261,9 +261,9 @@ Softly asserts that a value does not contain the expected value. #### Parameters -* `actualValue` **any** The actual value. -* `expectedValueToNotContain` **any** The value that should not be contained within the actual value. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `actualValue` **any** The actual value. +- `expectedValueToNotContain` **any** The value that should not be contained within the actual value. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectNotDeepEqual @@ -271,9 +271,9 @@ Softly asserts that two values are not deeply equal. #### Parameters -* `actualValue` **any** The actual value. -* `expectedValue` **any** The expected value. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `actualValue` **any** The actual value. +- `expectedValue` **any** The expected value. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectNotEndsWith @@ -281,9 +281,9 @@ Softly asserts that a value does not end with the expected value. #### Parameters -* `actualValue` **any** The actual value. -* `expectedValueToNotEndWith` **any** The value that the actual value should not end with. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `actualValue` **any** The actual value. +- `expectedValueToNotEndWith` **any** The value that the actual value should not end with. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectNotEqual @@ -291,9 +291,9 @@ Softly asserts that two values are not equal. #### Parameters -* `actualValue` **any** The actual value. -* `expectedValue` **any** The expected value. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `actualValue` **any** The actual value. +- `expectedValue` **any** The expected value. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectNotStartsWith @@ -301,9 +301,9 @@ Softly asserts that a value does not start with the expected value. #### Parameters -* `actualValue` **any** The actual value. -* `expectedValueToNotStartWith` **any** The value that the actual value should not start with. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `actualValue` **any** The actual value. +- `expectedValueToNotStartWith` **any** The value that the actual value should not start with. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectStartsWith @@ -311,9 +311,9 @@ Softly asserts that a value starts with the expected value. #### Parameters -* `actualValue` **any** The actual value. -* `expectedValueToStartWith` **any** The value that the actual value should start with. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `actualValue` **any** The actual value. +- `expectedValueToStartWith` **any** The value that the actual value should start with. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectToBeA @@ -321,9 +321,9 @@ Softly asserts that the target data is of a specific type. #### Parameters -* `targetData` **any** The data to check. -* `type` **[string][3]** The expected type (e.g., 'string', 'number'). -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `targetData` **any** The data to check. +- `type` **[string][3]** The expected type (e.g., 'string', 'number'). +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectToBeAn @@ -331,9 +331,9 @@ Softly asserts that the target data is of a specific type (alternative for artic #### Parameters -* `targetData` **any** The data to check. -* `type` **[string][3]** The expected type (e.g., 'string', 'number'). -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `targetData` **any** The data to check. +- `type` **[string][3]** The expected type (e.g., 'string', 'number'). +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. ### softExpectTrue @@ -341,17 +341,12 @@ Softly asserts that the target data is true. #### Parameters -* `targetData` **any** The data to check. -* `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. +- `targetData` **any** The data to check. +- `customErrorMsg` **[string][3]** A custom error message to display if the assertion fails. [1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error - [2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function - [3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array - [6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number diff --git a/docs/helpers/TestCafe.md b/docs/helpers/TestCafe.md index d75af3f59..fe1191408 100644 --- a/docs/helpers/TestCafe.md +++ b/docs/helpers/TestCafe.md @@ -198,7 +198,7 @@ if none provided clears all cookies. ```js I.clearCookie(); -I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name +I.clearCookie('test'); ``` #### Parameters diff --git a/docs/helpers/WebDriver.md b/docs/helpers/WebDriver.md index 54a47ca40..7e9b42a1e 100644 --- a/docs/helpers/WebDriver.md +++ b/docs/helpers/WebDriver.md @@ -35,13 +35,14 @@ Type: [object][17] * `url` **[string][18]** base url of website to be tested. * `browser` **[string][18]** Browser in which to perform testing. +* `bidiProtocol` **[boolean][33]?** WebDriver Bidi Protocol. Default: false. More info: [https://webdriver.io/docs/api/webdriverBidi/][37] * `basicAuth` **[string][18]?** (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'} * `host` **[string][18]?** WebDriver host to connect. * `port` **[number][23]?** WebDriver port to connect. * `protocol` **[string][18]?** protocol for WebDriver server. * `path` **[string][18]?** path to WebDriver server. * `restart` **[boolean][33]?** restart browser between tests. -* `smartWait` **([boolean][33] | [number][23])?** **enables [SmartWait][37]**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000. +* `smartWait` **([boolean][33] | [number][23])?** **enables [SmartWait][38]**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000. * `disableScreenshots` **[boolean][33]?** don't save screenshots on failure. * `fullPageScreenshots` **[boolean][33]?** (optional - make full page screenshots on failure. * `uniqueScreenshotNames` **[boolean][33]?** option to prevent screenshot override if you have scenarios with the same name in different suites. @@ -51,9 +52,9 @@ Type: [object][17] * `waitForTimeout` **[number][23]?** sets default wait time in *ms* for all `wait*` functions. * `desiredCapabilities` **[object][17]?** Selenium's [desired capabilities][7]. * `manualStart` **[boolean][33]?** do not start browser before a test, start it manually inside a helper with `this.helpers["WebDriver"]._startBrowser()`. -* `timeouts` **[object][17]?** [WebDriver timeouts][38] defined as hash. +* `timeouts` **[object][17]?** [WebDriver timeouts][39] defined as hash. * `highlightElement` **[boolean][33]?** highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose). -* `logLevel` **[string][18]?** level of logging verbosity. Default: silent. Options: trace | debug | info | warn | error | silent. More info: [https://webdriver.io/docs/configuration/#loglevel][39] +* `logLevel` **[string][18]?** level of logging verbosity. Default: silent. Options: trace | debug | info | warn | error | silent. More info: [https://webdriver.io/docs/configuration/#loglevel][40] @@ -604,7 +605,7 @@ if none provided clears all cookies. ```js I.clearCookie(); -I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name +I.clearCookie('test'); ``` #### Parameters @@ -2519,8 +2520,10 @@ Returns **void** automatically synchronized promise through #recorder [36]: https://webdriver.io/docs/api.html -[37]: http://codecept.io/acceptance/#smartwait +[37]: https://webdriver.io/docs/api/webdriverBidi/ -[38]: http://webdriver.io/docs/timeouts.html +[38]: http://codecept.io/acceptance/#smartwait -[39]: https://webdriver.io/docs/configuration/#loglevel +[39]: http://webdriver.io/docs/timeouts.html + +[40]: https://webdriver.io/docs/configuration/#loglevel diff --git a/docs/plugins.md b/docs/plugins.md index e3a460621..b2f967ae9 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -1,53 +1,69 @@ --- permalink: plugins -sidebarDepth: +sidebarDepth: sidebar: auto title: Plugins --- -## autoDelay +## analyze -Sometimes it takes some time for a page to respond to user's actions. -Depending on app's performance this can be either slow or fast. +Uses AI to analyze test failures and provide insights -For instance, if you click a button and nothing happens - probably JS event is not attached to this button yet -Also, if you fill field and input validation doesn't accept your input - maybe because you typed value too fast. +This plugin analyzes failed tests using AI to provide detailed explanations and group similar failures. +When enabled with --ai flag, it generates reports after test execution. -This plugin allows to slow down tests execution when a test running too fast. -It puts a tiny delay for before and after action commands. - -Commands affected (by default): - -* `click` -* `fillField` -* `checkOption` -* `pressKey` -* `doubleClick` -* `rightClick` - -#### Configuration +#### Usage ```js -plugins: { - autoDelay: { - enabled: true - } +// in codecept.conf.js +exports.config = { + plugins: { + analyze: { + enabled: true, + clusterize: 5, + analyze: 2, + vision: false, + }, + }, } ``` -Possible config options: +#### Configuration -* `methods`: list of affected commands. Can be overridden -* `delayBefore`: put a delay before a command. 100ms by default -* `delayAfter`: put a delay after a command. 200ms by default +- `clusterize` (number) - minimum number of failures to trigger clustering analysis. Default: 5 +- `analyze` (number) - maximum number of individual test failures to analyze in detail. Default: 2 +- `vision` (boolean) - enables visual analysis of test screenshots. Default: false +- `categories` (array) - list of failure categories for classification. Defaults to: + - Browser connection error / browser crash + - Network errors (server error, timeout, etc) + - HTML / page elements (not found, not visible, etc) + - Navigation errors (404, etc) + - Code errors (syntax error, JS errors, etc) + - Library & framework errors + - Data errors (password incorrect, invalid format, etc) + - Assertion failures + - Other errors +- `prompts` (object) - customize AI prompts for analysis + - `clusterize` - prompt for clustering analysis + - `analyze` - prompt for individual test analysis + +#### Features + +- Groups similar failures when number of failures >= clusterize value +- Provides detailed analysis of individual failures +- Analyzes screenshots if vision=true and screenshots are available +- Classifies failures into predefined categories +- Suggests possible causes and solutions ### Parameters -* `config` +- `config` **[Object][1]** Plugin configuration (optional, default `{}`) -## autoLogin +Returns **void** + +## auth Logs user in for the first test and reuses session for next tests. Works by saving cookies into memory or file. @@ -65,28 +81,28 @@ If a session expires automatically logs in again. ```js // inside a test file // use login to inject auto-login function -Feature('Login'); +Feature('Login') Before(({ login }) => { - login('user'); // login using user session -}); + login('user') // login using user session +}) // Alternatively log in for one scenario. -Scenario('log me in', ( { I, login } ) => { - login('admin'); - I.see('I am logged in'); -}); +Scenario('log me in', ({ I, login }) => { + login('admin') + I.see('I am logged in') +}) ``` #### Configuration -* `saveToFile` (default: false) - save cookies to file. Allows to reuse session between execution. -* `inject` (default: `login`) - name of the login function to use -* `users` - an array containing different session names and functions to: - * `login` - sign in into the system - * `check` - check that user is logged in - * `fetch` - to get current cookies (by default `I.grabCookie()`) - * `restore` - to set cookies (by default `I.amOnPage('/'); I.setCookie(cookie)`) +- `saveToFile` (default: false) - save cookies to file. Allows to reuse session between execution. +- `inject` (default: `login`) - name of the login function to use +- `users` - an array containing different session names and functions to: + - `login` - sign in into the system + - `check` - check that user is logged in + - `fetch` - to get current cookies (by default `I.grabCookie()`) + - `restore` - to set cookies (by default `I.amOnPage('/'); I.setCookie(cookie)`) #### How It Works @@ -99,7 +115,7 @@ Scenario('log me in', ( { I, login } ) => { #### Example: Simple login ```js -autoLogin: { +auth: { enabled: true, saveToFile: true, inject: 'login', @@ -120,7 +136,7 @@ autoLogin: { #### Example: Multiple users ```js -autoLogin: { +auth: { enabled: true, saveToFile: true, inject: 'loginAs', // use `loginAs` instead of login @@ -167,7 +183,7 @@ helpers: { } }, plugins: { - autoLogin: { + auth: { users: { admin: { login: (I) => { @@ -194,7 +210,7 @@ If your session is stored in local storage instead of cookies you still can obta ```js plugins: { - autoLogin: { + auth: { admin: { login: (I) => I.loginAsAdmin(), check: (I) => I.see('Admin', '.navbar'), @@ -210,18 +226,18 @@ plugins: { } ``` -#### Tips: Using async function in the autoLogin +#### Tips: Using async function in the auth -If you use async functions in the autoLogin plugin, login function should be used with `await` keyword. +If you use async functions in the auth plugin, login function should be used with `await` keyword. ```js -autoLogin: { +auth: { enabled: true, saveToFile: true, inject: 'login', users: { admin: { - login: async (I) => { // If you use async function in the autoLogin plugin + login: async (I) => { // If you use async function in the auth plugin const phrase = await I.grabTextFrom('#phrase') I.fillField('username', 'admin'), I.fillField('password', 'password') @@ -237,7 +253,7 @@ autoLogin: { ``` ```js -Scenario('login', async ( {I, login} ) => { +Scenario('login', async ({ I, login }) => { await login('admin') // you should use `await` }) ``` @@ -247,13 +263,13 @@ Scenario('login', async ( {I, login} ) => { Instead of asserting on page elements for the current user in `check`, you can use the `session` you saved in `fetch` ```js -autoLogin: { +auth: { enabled: true, saveToFile: true, inject: 'login', users: { admin: { - login: async (I) => { // If you use async function in the autoLogin plugin + login: async (I) => { // If you use async function in the auth plugin const phrase = await I.grabTextFrom('#phrase') I.fillField('username', 'admin'), I.fillField('password', 'password') @@ -271,30 +287,72 @@ autoLogin: { ``` ```js -Scenario('login', async ( {I, login} ) => { +Scenario('login', async ({ I, login }) => { await login('admin') // you should use `await` }) ``` ### Parameters -* `config` +- `config` + +## autoDelay + +Sometimes it takes some time for a page to respond to user's actions. +Depending on app's performance this can be either slow or fast. + +For instance, if you click a button and nothing happens - probably JS event is not attached to this button yet +Also, if you fill field and input validation doesn't accept your input - maybe because you typed value too fast. + +This plugin allows to slow down tests execution when a test running too fast. +It puts a tiny delay for before and after action commands. + +Commands affected (by default): + +- `click` +- `fillField` +- `checkOption` +- `pressKey` +- `doubleClick` +- `rightClick` + +#### Configuration + +```js +plugins: { + autoDelay: { + enabled: true + } +} +``` + +Possible config options: + +- `methods`: list of affected commands. Can be overridden +- `delayBefore`: put a delay before a command. 100ms by default +- `delayAfter`: put a delay after a command. 200ms by default + +### Parameters + +- `config` ## commentStep +This plugin is **deprecated**, use `Section` instead. + Add descriptive nested steps for your tests: ```js -Scenario('project update test', async (I) => { - __`Given`; - const projectId = await I.have('project'); +Scenario('project update test', async I => { + __`Given` + const projectId = await I.have('project') - __`When`; - projectPage.update(projectId, { title: 'new title' }); + __`When` + projectPage.update(projectId, { title: 'new title' }) - __`Then`; - projectPage.open(projectId); - I.see('new title', 'h1'); + __`Then` + projectPage.open(projectId) + I.see('new title', 'h1') }) ``` @@ -314,8 +372,8 @@ This plugin can be used ### Config -* `enabled` - (default: false) enable a plugin -* `registerGlobal` - (default: false) register `__` template literal function globally. You can override function global name by providing a name as a value. +- `enabled` - (default: false) enable a plugin +- `registerGlobal` - (default: false) register `__` template literal function globally. You can override function global name by providing a name as a value. ### Examples @@ -356,11 +414,11 @@ For instance, you can prepare Given/When/Then functions to use them inside tests ```js // inside a test -const step = codeceptjs.container.plugins('commentStep'); +const step = codeceptjs.container.plugins('commentStep') -const Given = () => step`Given`; -const When = () => step`When`; -const Then = () => step`Then`; +const Given = () => step`Given` +const When = () => step`When` +const Then = () => step`Then` ``` Scenario('project update test', async (I) => { @@ -376,11 +434,12 @@ I.see('new title', 'h1'); }); ``` + ``` ### Parameters -* `config` +- `config` ## coverage @@ -399,21 +458,21 @@ plugins: { } ``` -Possible config options, More could be found at [monocart-coverage-reports][1] +Possible config options, More could be found at [monocart-coverage-reports][2] -* `debug`: debug info. By default, false. -* `name`: coverage report name. -* `outputDir`: path to coverage report. -* `sourceFilter`: filter the source files. -* `sourcePath`: option to resolve a custom path. +- `debug`: debug info. By default, false. +- `name`: coverage report name. +- `outputDir`: path to coverage report. +- `sourceFilter`: filter the source files. +- `sourcePath`: option to resolve a custom path. ### Parameters -* `config` +- `config` ## customLocator -Creates a [custom locator][2] by using special attributes in HTML. +Creates a [custom locator][3] by using special attributes in HTML. If you have a convention to use `data-test-id` or `data-qa` attributes to mark active elements for e2e tests, you can enable this plugin to simplify matching elements with these attributes: @@ -429,11 +488,11 @@ This plugin will create a valid XPath locator for you. #### Configuration -* `enabled` (default: `false`) should a locator be enabled -* `prefix` (default: `$`) sets a prefix for a custom locator. -* `attribute` (default: `data-test-id`) to set an attribute to be matched. -* `strategy` (default: `xpath`) actual locator strategy to use in query (`css` or `xpath`). -* `showActual` (default: false) show in the output actually produced XPath or CSS locator. By default shows custom locator value. +- `enabled` (default: `false`) should a locator be enabled +- `prefix` (default: `$`) sets a prefix for a custom locator. +- `attribute` (default: `data-test-id`) to set an attribute to be matched. +- `strategy` (default: `xpath`) actual locator strategy to use in query (`css` or `xpath`). +- `showActual` (default: false) show in the output actually produced XPath or CSS locator. By default shows custom locator value. #### Examples: @@ -452,8 +511,8 @@ plugins: { In a test: ```js -I.seeElement('$user'); // matches => [data-test=user] -I.click('$sign-up'); // matches => [data-test=sign-up] +I.seeElement('$user') // matches => [data-test=user] +I.click('$sign-up') // matches => [data-test=sign-up] ``` Using `data-qa` attribute with `=` prefix: @@ -472,8 +531,8 @@ plugins: { In a test: ```js -I.seeElement('=user'); // matches => [data-qa=user] -I.click('=sign-up'); // matches => [data-qa=sign-up] +I.seeElement('=user') // matches => [data-qa=user] +I.click('=sign-up') // matches => [data-qa=sign-up] ``` Using `data-qa` OR `data-test` attribute with `=` prefix: @@ -493,8 +552,8 @@ plugins: { In a test: ```js -I.seeElement('=user'); // matches => //*[@data-qa=user or @data-test=user] -I.click('=sign-up'); // matches => //*[data-qa=sign-up or @data-test=sign-up] +I.seeElement('=user') // matches => //*[@data-qa=user or @data-test=user] +I.click('=sign-up') // matches => //*[data-qa=sign-up or @data-test=sign-up] ``` ```js @@ -512,37 +571,21 @@ plugins: { In a test: ```js -I.seeElement('=user'); // matches => [data-qa=user],[data-test=user] -I.click('=sign-up'); // matches => [data-qa=sign-up],[data-test=sign-up] +I.seeElement('=user') // matches => [data-qa=user],[data-test=user] +I.click('=sign-up') // matches => [data-qa=sign-up],[data-test=sign-up] ``` ### Parameters -* `config` - -## debugErrors - -Prints errors found in HTML code after each failed test. - -It scans HTML and searches for elements with error classes. -If an element found prints a text from it to console and adds as artifact to the test. - -Enable this plugin in config: - -```js -plugins: { - debugErrors: { - enabled: true, -} -``` +- `config` -Additional config options: +## customReporter -* `errorClasses` - list of classes to search for errors (default: `['error', 'warning', 'alert', 'danger']`) +Sample custom reporter for CodeceptJS. ### Parameters -* `config` (optional, default `{}`) +- `config` ## eachElement @@ -550,17 +593,17 @@ Provides `eachElement` global function to iterate over found elements to perform `eachElement` takes following args: -* `purpose` - the goal of an action. A comment text that will be displayed in output. -* `locator` - a CSS/XPath locator to match elements -* `fn(element, index)` - **asynchronous** function which will be executed for each matched element. +- `purpose` - the goal of an action. A comment text that will be displayed in output. +- `locator` - a CSS/XPath locator to match elements +- `fn(element, index)` - **asynchronous** function which will be executed for each matched element. Example of usage: ```js // this example works with Playwright and Puppeteer helper -await eachElement('click all checkboxes', 'form input[type=checkbox]', async (el) => { - await el.click(); -}); +await eachElement('click all checkboxes', 'form input[type=checkbox]', async el => { + await el.click() +}) ``` Click odd elements: @@ -568,18 +611,18 @@ Click odd elements: ```js // this example works with Playwright and Puppeteer helper await eachElement('click odd buttons', '.button-select', async (el, index) => { - if (index % 2) await el.click(); -}); + if (index % 2) await el.click() +}) ``` Check all elements for visibility: ```js // this example works with Playwright and Puppeteer helper -const assert = require('assert'); -await eachElement('check all items are visible', '.item', async (el) => { - assert(await el.isVisible()); -}); +const assert = require('assert') +await eachElement('check all items are visible', '.item', async el => { + assert(await el.isVisible()) +}) ``` This method works with WebDriver, Playwright, Puppeteer, Appium helpers. @@ -587,27 +630,27 @@ This method works with WebDriver, Playwright, Puppeteer, Appium helpers. Function parameter `el` represents a matched element. Depending on a helper API of `el` can be different. Refer to API of corresponding browser testing engine for a complete API list: -* [Playwright ElementHandle][3] -* [Puppeteer][4] -* [webdriverio element][5] +- [Playwright ElementHandle][4] +- [Puppeteer][5] +- [webdriverio element][6] #### Configuration -* `registerGlobal` - to register `eachElement` function globally, true by default +- `registerGlobal` - to register `eachElement` function globally, true by default If `registerGlobal` is false you can use eachElement from the plugin: ```js -const eachElement = codeceptjs.container.plugins('eachElement'); +const eachElement = codeceptjs.container.plugins('eachElement') ``` ### Parameters -* `purpose` **[string][6]** -* `locator` **CodeceptJS.LocatorOrString** -* `fn` **[Function][7]** +- `purpose` **[string][7]** +- `locator` **CodeceptJS.LocatorOrString** +- `fn` **[Function][8]** -Returns **([Promise][8]\ | [undefined][9])** +Returns **([Promise][9]\ | [undefined][10])** ## fakerTransform @@ -627,9 +670,9 @@ Add this plugin to config file: ```js plugins: { - fakerTransform: { - enabled: true - } + fakerTransform: { + enabled: true + } } ``` @@ -647,13 +690,13 @@ Scenario Outline: ... ### Parameters -* `config` +- `config` ## heal Self-healing tests with AI. -Read more about heaking in [Self-Healing Tests][10] +Read more about heaking in [Self-Healing Tests][11] ```js plugins: { @@ -665,15 +708,41 @@ plugins: { More config options are available: -* `healLimit` - how many steps can be healed in a single test (default: 2) +- `healLimit` - how many steps can be healed in a single test (default: 2) ### Parameters -* `config` (optional, default `{}`) +- `config` (optional, default `{}`) + +## pageInfo + +Collects information from web page after each failed test and adds it to the test as an artifact. +It is suggested to enable this plugin if you run tests on CI and you need to debug failed tests. +This plugin can be paired with `analyze` plugin to provide more context. + +It collects URL, HTML errors (by classes), and browser logs. + +Enable this plugin in config: + +```js +plugins: { + pageInfo: { + enabled: true, +} +``` + +Additional config options: + +- `errorClasses` - list of classes to search for errors (default: `['error', 'warning', 'alert', 'danger']`) +- `browserLogs` - list of types of errors to search for in browser logs (default: `['error']`) + +### Parameters + +- `config` (optional, default `{}`) ## pauseOnFail -Automatically launches [interactive pause][11] when a test fails. +Automatically launches [interactive pause][12] when a test fails. Useful for debugging flaky tests on local environment. Add this plugin to config file: @@ -697,9 +766,9 @@ Add this plugin to config file: ```js plugins: { - retryFailedStep: { - enabled: true - } + retryFailedStep: { + enabled: true + } } ``` @@ -709,22 +778,22 @@ Run tests with plugin enabled: #### Configuration: -* `retries` - number of retries (by default 3), -* `when` - function, when to perform a retry (accepts error as parameter) -* `factor` - The exponential factor to use. Default is 1.5. -* `minTimeout` - The number of milliseconds before starting the first retry. Default is 1000. -* `maxTimeout` - The maximum number of milliseconds between two retries. Default is Infinity. -* `randomize` - Randomizes the timeouts by multiplying with a factor from 1 to 2. Default is false. -* `defaultIgnoredSteps` - an array of steps to be ignored for retry. Includes: - * `amOnPage` - * `wait*` - * `send*` - * `execute*` - * `run*` - * `have*` -* `ignoredSteps` - an array for custom steps to ignore on retry. Use it to append custom steps to ignored list. - You can use step names or step prefixes ending with `*`. As such, `wait*` will match all steps starting with `wait`. - To append your own steps to ignore list - copy and paste a default steps list. Regexp values are accepted as well. +- `retries` - number of retries (by default 3), +- `when` - function, when to perform a retry (accepts error as parameter) +- `factor` - The exponential factor to use. Default is 1.5. +- `minTimeout` - The number of milliseconds before starting the first retry. Default is 1000. +- `maxTimeout` - The maximum number of milliseconds between two retries. Default is Infinity. +- `randomize` - Randomizes the timeouts by multiplying with a factor from 1 to 2. Default is false. +- `defaultIgnoredSteps` - an array of steps to be ignored for retry. Includes: + - `amOnPage` + - `wait*` + - `send*` + - `execute*` + - `run*` + - `have*` +- `ignoredSteps` - an array for custom steps to ignore on retry. Use it to append custom steps to ignored list. + You can use step names or step prefixes ending with `*`. As such, `wait*` will match all steps starting with `wait`. + To append your own steps to ignore list - copy and paste a default steps list. Regexp values are accepted as well. #### Example @@ -747,83 +816,14 @@ This plugin can be disabled per test. In this case you will need to stet `I.retr Use scenario configuration to disable plugin for a test ```js -Scenario('scenario tite', () => { - // test goes here -}).config(test => test.disableRetryFailedStep = true) -``` - -### Parameters - -* `config` - -## retryTo - -Adds global `retryTo` which retries steps a few times before failing. - -Enable this plugin in `codecept.conf.js` (enabled by default for new setups): - -```js -plugins: { - retryTo: { - enabled: true - } -} -``` - -Use it in your tests: - -```js -// retry these steps 5 times before failing -await retryTo((tryNum) => { - I.switchTo('#editor frame'); - I.click('Open'); - I.see('Opened') -}, 5); -``` - -Set polling interval as 3rd argument (200ms by default): - -```js -// retry these steps 5 times before failing -await retryTo((tryNum) => { - I.switchTo('#editor frame'); - I.click('Open'); - I.see('Opened') -}, 5, 100); -``` - -Default polling interval can be changed in a config: - -```js -plugins: { - retryTo: { - enabled: true, - pollInterval: 500, - } -} -``` - -Disables retryFailedStep plugin for steps inside a block; - -Use this plugin if: - -* you need repeat a set of actions in flaky tests -* iframe was not rendered and you need to retry switching to it - -#### Configuration - -* `pollInterval` - default interval between retries in ms. 200 by default. -* `registerGlobal` - to register `retryTo` function globally, true by default - -If `registerGlobal` is false you can use retryTo from the plugin: - -```js -const retryTo = codeceptjs.container.plugins('retryTo'); +Scenario('scenario tite', { disableRetryFailedStep: true }, () => { + // test goes here +}) ``` ### Parameters -* `config` +- `config` ## screenshotOnFail @@ -839,31 +839,31 @@ Configuration can either be taken from a corresponding helper (deprecated) or a ```js plugins: { - screenshotOnFail: { - enabled: true - } + screenshotOnFail: { + enabled: true + } } ``` Possible config options: -* `uniqueScreenshotNames`: use unique names for screenshot. Default: false. -* `fullPageScreenshots`: make full page screenshots. Default: false. +- `uniqueScreenshotNames`: use unique names for screenshot. Default: false. +- `fullPageScreenshots`: make full page screenshots. Default: false. ### Parameters -* `config` +- `config` ## selenoid -[Selenoid][12] plugin automatically starts browsers and video recording. +[Selenoid][13] plugin automatically starts browsers and video recording. Works with WebDriver helper. ### Prerequisite This plugin **requires Docker** to be installed. -> If you have issues starting Selenoid with this plugin consider using the official [Configuration Manager][13] tool from Selenoid +> If you have issues starting Selenoid with this plugin consider using the official [Configuration Manager][14] tool from Selenoid ### Usage @@ -892,7 +892,7 @@ plugins: { } ``` -When `autoCreate` is enabled it will pull the [latest Selenoid from DockerHub][14] and start Selenoid automatically. +When `autoCreate` is enabled it will pull the [latest Selenoid from DockerHub][15] and start Selenoid automatically. It will also create `browsers.json` file required by Selenoid. In automatic mode the latest version of browser will be used for tests. It is recommended to specify exact version of each browser inside `browsers.json` file. @@ -904,12 +904,12 @@ In automatic mode the latest version of browser will be used for tests. It is re While this plugin can create containers for you for better control it is recommended to create and launch containers manually. This is especially useful for Continous Integration server as you can configure scaling for Selenoid containers. -> Use [Selenoid Configuration Manager][13] to create and start containers semi-automatically. +> Use [Selenoid Configuration Manager][14] to create and start containers semi-automatically. 1. Create `browsers.json` file in the same directory `codecept.conf.js` is located - [Refer to Selenoid documentation][15] to know more about browsers.json. + [Refer to Selenoid documentation][16] to know more about browsers.json. -*Sample browsers.json* +_Sample browsers.json_ ```js { @@ -932,7 +932,7 @@ This is especially useful for Continous Integration server as you can configure 2. Create Selenoid container -Run the following command to create a container. To know more [refer here][16] +Run the following command to create a container. To know more [refer here][17] ```bash docker create \ @@ -965,15 +965,15 @@ When `allure` plugin is enabled a video is attached to report automatically. | enableVideo | Enable video recording and use `video` folder of output (default: false) | | enableLog | Enable log recording and use `logs` folder of output (default: false) | | deletePassed | Delete video and logs of passed tests (default : true) | -| additionalParams | example: `additionalParams: '--env TEST=test'` [Refer here][17] to know more | +| additionalParams | example: `additionalParams: '--env TEST=test'` [Refer here][18] to know more | ### Parameters -* `config` +- `config` ## stepByStepReport -![step-by-step-report][18] +![step-by-step-report][19] Generates step by step report for a test. After each step in a test a screenshot is created. After test executed screenshots are combined into slideshow. @@ -995,17 +995,17 @@ Run tests with plugin enabled: Possible config options: -* `deleteSuccessful`: do not save screenshots for successfully executed tests. Default: true. -* `animateSlides`: should animation for slides to be used. Default: true. -* `ignoreSteps`: steps to ignore in report. Array of RegExps is expected. Recommended to skip `grab*` and `wait*` steps. -* `fullPageScreenshots`: should full page screenshots be used. Default: false. -* `output`: a directory where reports should be stored. Default: `output`. -* `screenshotsForAllureReport`: If Allure plugin is enabled this plugin attaches each saved screenshot to allure report. Default: false. -* \`disableScreenshotOnFail : Disables the capturing of screeshots after the failed step. Default: true. +- `deleteSuccessful`: do not save screenshots for successfully executed tests. Default: true. +- `animateSlides`: should animation for slides to be used. Default: true. +- `ignoreSteps`: steps to ignore in report. Array of RegExps is expected. Recommended to skip `grab*` and `wait*` steps. +- `fullPageScreenshots`: should full page screenshots be used. Default: false. +- `output`: a directory where reports should be stored. Default: `output`. +- `screenshotsForAllureReport`: If Allure plugin is enabled this plugin attaches each saved screenshot to allure report. Default: false. +- \`disableScreenshotOnFail : Disables the capturing of screeshots after the failed step. Default: true. ### Parameters -* `config` **any** +- `config` **any** ## stepTimeout @@ -1015,9 +1015,9 @@ Add this plugin to config file: ```js plugins: { - stepTimeout: { - enabled: true - } + stepTimeout: { + enabled: true + } } ``` @@ -1027,19 +1027,19 @@ Run tests with plugin enabled: #### Configuration: -* `timeout` - global step timeout, default 150 seconds +- `timeout` - global step timeout, default 150 seconds -* `overrideStepLimits` - whether to use timeouts set in plugin config to override step timeouts set in code with I.limitTime(x).action(...), default false +- `overrideStepLimits` - whether to use timeouts set in plugin config to override step timeouts set in code with I.limitTime(x).action(...), default false -* `noTimeoutSteps` - an array of steps with no timeout. Default: +- `noTimeoutSteps` - an array of steps with no timeout. Default: - * `amOnPage` - * `wait*` + - `amOnPage` + - `wait*` - you could set your own noTimeoutSteps which would replace the default one. + you could set your own noTimeoutSteps which would replace the default one. -* `customTimeoutSteps` - an array of step actions with custom timeout. Use it to override or extend noTimeoutSteps. - You can use step names or step prefixes ending with `*`. As such, `wait*` will match all steps starting with `wait`. +- `customTimeoutSteps` - an array of step actions with custom timeout. Use it to override or extend noTimeoutSteps. + You can use step names or step prefixes ending with `*`. As such, `wait*` will match all steps starting with `wait`. #### Example @@ -1062,7 +1062,7 @@ plugins: { ### Parameters -* `config` +- `config` ## subtitles @@ -1072,95 +1072,25 @@ Automatically captures steps as subtitle, and saves it as an artifact when a vid ```js plugins: { - subtitles: { - enabled: true - } -} -``` - -## tryTo - -Adds global `tryTo` function in which all failed steps won't fail a test but will return true/false. - -Enable this plugin in `codecept.conf.js` (enabled by default for new setups): - -```js -plugins: { - tryTo: { + subtitles: { enabled: true } } ``` -Use it in your tests: - -```js -const result = await tryTo(() => I.see('Welcome')); - -// if text "Welcome" is on page, result => true -// if text "Welcome" is not on page, result => false -``` - -Disables retryFailedStep plugin for steps inside a block; - -Use this plugin if: - -* you need to perform multiple assertions inside a test -* there is A/B testing on a website you test -* there is "Accept Cookie" banner which may surprisingly appear on a page. - -#### Usage - -#### Multiple Conditional Assertions - -````js - -Add assert requires first: -```js -const assert = require('assert'); -```` - -Then use the assertion: -const result1 = await tryTo(() => I.see('Hello, user')); -const result2 = await tryTo(() => I.seeElement('.welcome')); -assert.ok(result1 && result2, 'Assertions were not succesful'); - -```` - -##### Optional click - -```js -I.amOnPage('/'); -tryTo(() => I.click('Agree', '.cookies')); -```` - -#### Configuration - -* `registerGlobal` - to register `tryTo` function globally, true by default - -If `registerGlobal` is false you can use tryTo from the plugin: - -```js -const tryTo = codeceptjs.container.plugins('tryTo'); -``` - -### Parameters - -* `config` - ## wdio Webdriverio services runner. This plugin allows to run webdriverio services like: -* selenium-standalone -* sauce -* testingbot -* browserstack -* appium +- selenium-standalone +- sauce +- testingbot +- browserstack +- appium -A complete list of all available services can be found on [webdriverio website][19]. +A complete list of all available services can be found on [webdriverio website][20]. #### Setup @@ -1172,7 +1102,7 @@ See examples below: #### Selenium Standalone Service -Install ` @wdio/selenium-standalone-service` package, as [described here][20]. +Install ` @wdio/selenium-standalone-service` package, as [described here][21]. It is important to make sure it is compatible with current webdriverio version. Enable `wdio` plugin in plugins list and add `selenium-standalone` service: @@ -1189,7 +1119,7 @@ plugins: { #### Sauce Service -Install `@wdio/sauce-service` package, as [described here][21]. +Install `@wdio/sauce-service` package, as [described here][22]. It is important to make sure it is compatible with current webdriverio version. Enable `wdio` plugin in plugins list and add `sauce` service: @@ -1206,57 +1136,38 @@ plugins: { } ``` -*** +--- In the same manner additional services from webdriverio can be installed, enabled, and configured. #### Configuration -* `services` - list of enabled services -* ... - additional configuration passed into services. +- `services` - list of enabled services +- ... - additional configuration passed into services. ### Parameters -* `config` - -[1]: https://github.com/cenfun/monocart-coverage-reports?tab=readme-ov-file#default-options - -[2]: https://codecept.io/locators#custom-locators - -[3]: https://playwright.dev/docs/api/class-elementhandle - -[4]: https://pptr.dev/#?product=Puppeteer&show=api-class-elementhandle - -[5]: https://webdriver.io/docs/api - -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function - -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise - -[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined - -[10]: https://codecept.io/heal/ - -[11]: /basics/#pause - -[12]: https://aerokube.com/selenoid/ - -[13]: https://aerokube.com/cm/latest/ - -[14]: https://hub.docker.com/u/selenoid - -[15]: https://aerokube.com/selenoid/latest/#_prepare_configuration - -[16]: https://aerokube.com/selenoid/latest/#_option_2_start_selenoid_container - -[17]: https://docs.docker.com/engine/reference/commandline/create/ - -[18]: https://codecept.io/img/codeceptjs-slideshow.gif - -[19]: https://webdriver.io - -[20]: https://webdriver.io/docs/selenium-standalone-service.html - -[21]: https://webdriver.io/docs/sauce-service.html +- `config` + +[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[2]: https://github.com/cenfun/monocart-coverage-reports?tab=readme-ov-file#default-options +[3]: https://codecept.io/locators#custom-locators +[4]: https://playwright.dev/docs/api/class-elementhandle +[5]: https://pptr.dev/#?product=Puppeteer&show=api-class-elementhandle +[6]: https://webdriver.io/docs/api +[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String +[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function +[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise +[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined +[11]: https://codecept.io/heal/ +[12]: /basics/#pause +[13]: https://aerokube.com/selenoid/ +[14]: https://aerokube.com/cm/latest/ +[15]: https://hub.docker.com/u/selenoid +[16]: https://aerokube.com/selenoid/latest/#_prepare_configuration +[17]: https://aerokube.com/selenoid/latest/#_option_2_start_selenoid_container +[18]: https://docs.docker.com/engine/reference/commandline/create/ +[19]: https://codecept.io/img/codeceptjs-slideshow.gif +[20]: https://webdriver.io +[21]: https://webdriver.io/docs/selenium-standalone-service.html +[22]: https://webdriver.io/docs/sauce-service.html diff --git a/docs/webapi/clearCookie.mustache b/docs/webapi/clearCookie.mustache index e7f52b84a..4820c0fa0 100644 --- a/docs/webapi/clearCookie.mustache +++ b/docs/webapi/clearCookie.mustache @@ -3,7 +3,7 @@ if none provided clears all cookies. ```js I.clearCookie(); -I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name +I.clearCookie('test'); ``` @param {?string} [cookie=null] (optional, `null` by default) cookie name diff --git a/eslint.config.mjs b/eslint.config.mjs index 9884b4975..6fba66b27 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -1,81 +1,85 @@ -import globals from "globals"; -import path from "node:path"; -import {fileURLToPath} from "node:url"; -import js from "@eslint/js"; -import {FlatCompat} from "@eslint/eslintrc"; +import globals from 'globals' +import path from 'node:path' +import { fileURLToPath } from 'node:url' +import js from '@eslint/js' +import { FlatCompat } from '@eslint/eslintrc' -const __filename = fileURLToPath(import.meta.url); -const __dirname = path.dirname(__filename); +const __filename = fileURLToPath(import.meta.url) +const __dirname = path.dirname(__filename) const compat = new FlatCompat({ baseDirectory: __dirname, recommendedConfig: js.configs.recommended, - allConfig: js.configs.all -}); + allConfig: js.configs.all, +}) -export default [{ - ignores: ["test/data/output", "lib/css2xpath/*"], -}, ...compat.extends("airbnb-base"), { - languageOptions: { - globals: { - ...globals.node, - }, - - ecmaVersion: 2020, - sourceType: "commonjs", +export default [ + { + ignores: ['test/data/output', 'lib/css2xpath/*'], }, + { + languageOptions: { + globals: { + ...globals.node, + }, - rules: { - "func-names": 0, - "no-use-before-define": 0, - "no-unused-vars": 0, - "no-underscore-dangle": 0, - "no-undef": 0, - "prefer-destructuring": 0, - "no-param-reassign": 0, - "max-len": 0, - camelcase: 0, - "no-shadow": 0, - "consistent-return": 0, - "no-console": 0, - "global-require": 0, - "class-methods-use-this": 0, - "no-plusplus": 0, - "no-return-assign": 0, - "prefer-rest-params": 0, - "no-useless-escape": 0, - "no-restricted-syntax": 0, - "no-unused-expressions": 0, - "guard-for-in": 0, - "no-multi-assign": 0, - "require-yield": 0, - "prefer-spread": 0, - "import/no-dynamic-require": 0, - "no-continue": 0, - "no-mixed-operators": 0, - "default-case": 0, - "import/no-extraneous-dependencies": 0, - "no-cond-assign": 0, - "import/no-unresolved": 0, - "no-await-in-loop": 0, - "arrow-body-style": 0, - "no-loop-func": 0, - "arrow-parens": 0, - "default-param-last": 0, - semi: 0, - "operator-linebreak": 0, - "nonblock-statement-body-position": 0, - curly: 0, - "implicit-arrow-linebreak": 0, - indent: 0, - "object-curly-newline": 0, - "semi-style": 0, - "function-paren-newline": 0, - "prefer-template": 0, - "newline-per-chained-call": 0, - "prefer-arrow-callback": 0, - "no-bitwise": 0, - "prefer-const": 0, - "no-extra-semi": 0, - "max-classes-per-file": 0 + ecmaVersion: 2020, + sourceType: 'module', + }, + + rules: { + 'func-names': 0, + 'no-use-before-define': 0, + 'no-unused-vars': 0, + 'no-underscore-dangle': 0, + 'no-undef': 0, + 'prefer-destructuring': 0, + 'no-param-reassign': 0, + 'max-len': 0, + camelcase: 0, + 'no-shadow': 0, + 'consistent-return': 0, + 'no-console': 0, + 'global-require': 0, + 'class-methods-use-this': 0, + 'no-plusplus': 0, + 'no-return-assign': 0, + 'prefer-rest-params': 0, + 'no-useless-escape': 0, + 'no-restricted-syntax': 0, + 'no-unused-expressions': 0, + 'guard-for-in': 0, + 'no-multi-assign': 0, + 'require-yield': 0, + 'prefer-spread': 0, + 'import/no-dynamic-require': 0, + 'no-continue': 0, + 'no-mixed-operators': 0, + 'default-case': 0, + 'import/no-extraneous-dependencies': 0, + 'no-cond-assign': 0, + 'import/no-unresolved': 0, + 'no-await-in-loop': 0, + 'arrow-body-style': 0, + 'no-loop-func': 0, + 'arrow-parens': 0, + 'default-param-last': 0, + semi: 0, + 'operator-linebreak': 0, + 'nonblock-statement-body-position': 0, + curly: 0, + 'implicit-arrow-linebreak': 0, + indent: 0, + 'object-curly-newline': 0, + 'semi-style': 0, + 'function-paren-newline': 0, + 'prefer-template': 0, + 'newline-per-chained-call': 0, + 'prefer-arrow-callback': 0, + 'no-bitwise': 0, + 'prefer-const': 0, + 'no-extra-semi': 0, + 'max-classes-per-file': 0, + 'no-return-await': 0, + }, }, -}]; +] diff --git a/examples/codecept.config.js b/examples/codecept.config.js index 2f4b03d64..ceac01db0 100644 --- a/examples/codecept.config.js +++ b/examples/codecept.config.js @@ -1,4 +1,4 @@ -require('./heal_recipes'); +require('./heal_recipes') exports.config = { output: './output', @@ -34,22 +34,21 @@ exports.config = { }, gherkin: { features: './features/*.feature', - steps: [ - './step_definitions/steps.js', - ], + steps: ['./step_definitions/steps.js'], }, plugins: { - tryTo: { - enabled: true, - }, - heal: { + analyze: { enabled: true, }, + // heal: { + // enabled: true, + // }, + // customReporter: { + // enabled: true, + // }, wdio: { enabled: false, - services: [ - 'selenium-standalone', - ], + services: ['selenium-standalone'], }, stepByStepReport: {}, autoDelay: { @@ -61,10 +60,8 @@ exports.config = { subtitles: { enabled: true, }, - retryTo: { - enabled: true, - }, }, + tests: './*_test.js', // timeout: 100, multiple: { @@ -73,11 +70,8 @@ exports.config = { }, default: { grep: 'signin', - browsers: [ - 'chrome', - 'firefox', - ], + browsers: ['chrome', 'firefox'], }, }, name: 'tests', -}; +} diff --git a/examples/fragments/Signin.js b/examples/fragments/Signin.js index 7d7b018f0..150d8c312 100644 --- a/examples/fragments/Signin.js +++ b/examples/fragments/Signin.js @@ -1,7 +1,6 @@ let I; module.exports = { - _init() { I = actor(); }, diff --git a/examples/github_test.js b/examples/github_test.js index e8f274c21..a2c66fa18 100644 --- a/examples/github_test.js +++ b/examples/github_test.js @@ -1,36 +1,36 @@ // / -Feature('GitHub'); +Feature('GitHub') Before(({ I }) => { - I.amOnPage('https://github.com'); -}); + I.amOnPage('https://github.com') + I.see('GitLab') +}) xScenario('test ai features', ({ I }) => { - I.amOnPage('https://getbootstrap.com/docs/5.1/examples/checkout/'); - pause(); -}); + I.amOnPage('https://getbootstrap.com/docs/5.1/examples/checkout/') +}) Scenario('Incorrect search for Codeceptjs', ({ I }) => { - I.fillField('.search-input', 'CodeceptJS'); - I.pressKey('Enter'); - I.waitForElement('[data-testid=search-sub-header]', 10); - I.see('Supercharged End 2 End Testing'); -}); + I.fillField('.search-input', 'CodeceptJS') + I.pressKey('Enter') + I.waitForElement('[data-testid=search-sub-header]', 10) + I.see('Supercharged End 2 End Testing') +}) Scenario('Visit Home Page @retry', async ({ I }) => { // .retry({ retries: 3, minTimeout: 1000 }) - I.retry(2).see('GitHub'); - I.retry(3).see('ALL'); - I.retry(2).see('IMAGES'); -}); + I.retry(2).see('GitHub') + I.retry(3).see('ALL') + I.retry(2).see('IMAGES') +}) Scenario('search @grop', { timeout: 6 }, ({ I }) => { - I.amOnPage('https://github.com/search'); + I.amOnPage('https://github.com/search') const a = { b: { c: 'asdasdasd', }, - }; + } const b = { users: { admin: { @@ -42,35 +42,38 @@ Scenario('search @grop', { timeout: 6 }, ({ I }) => { other: (world = '') => `Hello ${world}`, }, urls: {}, - }; - I.fillField('Search GitHub', 'CodeceptJS'); + } + I.fillField('Search GitHub', 'CodeceptJS') // pause({ a, b }); - I.pressKey('Enter'); - I.wait(3); + I.pressKey('Enter') + I.wait(3) // pause(); - I.see('Codeception/CodeceptJS', locate('.repo-list .repo-list-item').first()); -}); + I.see('Codeception/CodeceptJS', locate('.repo-list .repo-list-item').first()) +}) Scenario('signin @sign', { timeout: 6 }, ({ I, loginPage }) => { - I.say('it should not enter'); - loginPage.login('something@totest.com', '123456'); - I.see('Incorrect username or password.', '.flash-error'); -}).tag('normal').tag('important').tag('@slow'); + I.say('it should not enter') + loginPage.login('something@totest.com', '123456') + I.see('Incorrect username or password.', '.flash-error') +}) + .tag('normal') + .tag('important') + .tag('@slow') Scenario('signin2', { timeout: 1 }, ({ I, Smth }) => { - Smth.openAndLogin(); - I.see('Incorrect username or password.', '.flash-error'); -}); + Smth.openAndLogin() + I.see('Incorrect username or password.', '.flash-error') +}) Scenario('register', ({ I }) => { within('.js-signup-form', () => { - I.fillField('user[login]', 'User'); - I.fillField('user[email]', 'user@user.com'); - I.fillField('user[password]', 'user@user.com'); - I.fillField('q', 'aaa'); - I.click('button'); - }); - I.see('There were problems creating your account.'); - I.click('Explore'); - I.seeInCurrentUrl('/explore'); -}); + I.fillField('user[login]', 'User') + I.fillField('user[email]', 'user@user.com') + I.fillField('user[password]', 'user@user.com') + I.fillField('q', 'aaa') + I.click('button') + }) + I.see('There were problems creating your account.') + I.click('Explore') + I.seeInCurrentUrl('/explore') +}) diff --git a/examples/pages/Admin.js b/examples/pages/Admin.js index 7d7b018f0..150d8c312 100644 --- a/examples/pages/Admin.js +++ b/examples/pages/Admin.js @@ -1,7 +1,6 @@ let I; module.exports = { - _init() { I = actor(); }, diff --git a/examples/selenoid-example/browsers.json b/examples/selenoid-example/browsers.json deleted file mode 100644 index d715f44cc..000000000 --- a/examples/selenoid-example/browsers.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "chrome": { - "default": "latest", - "versions": { - "latest": { - "image": "selenoid/chrome:latest", - "port": "4444", - "path": "/" - } - } - }, - "firefox": { - "default": "latest", - "versions": { - "latest": { - "image": "selenoid/firefox:latest", - "port": "4444", - "path": "/wd/hub" - } - } - } -} \ No newline at end of file diff --git a/examples/selenoid-example/codecept.conf.js b/examples/selenoid-example/codecept.conf.js deleted file mode 100644 index 59666c7e1..000000000 --- a/examples/selenoid-example/codecept.conf.js +++ /dev/null @@ -1,29 +0,0 @@ -exports.config = { - tests: './*_test.js', - output: './output', - helpers: { - WebDriver: { - url: 'http://localhost', - browser: 'chrome', - }, - }, - - plugins: { - selenoid: { - enabled: true, - deletePassed: true, - autoCreate: true, - autoStart: true, - sessionTimeout: '30m', - enableVideo: true, - enableLog: true, - }, - allure: { - enabled: false, - }, - }, - include: {}, - bootstrap: null, - mocha: {}, - name: 'example', -}; diff --git a/examples/selenoid-example/git_test.js b/examples/selenoid-example/git_test.js deleted file mode 100644 index 1727c1bdc..000000000 --- a/examples/selenoid-example/git_test.js +++ /dev/null @@ -1,16 +0,0 @@ -Feature('Git'); - -Scenario('Demo Test Github', ({ I }) => { - I.amOnPage('https://github.com/login'); - I.see('GitHub'); - I.fillField('login', 'randomuser_kmk'); - I.fillField('password', 'randomuser_kmk'); - I.click('Sign in'); - I.see('Repositories'); -}); - -Scenario('Demo Test GitLab', ({ I }) => { - I.amOnPage('https://gitlab.com'); - I.dontSee('GitHub'); - I.see('GitLab'); -}); diff --git a/lib/actor.js b/lib/actor.js index a53a03fe4..081dae75e 100644 --- a/lib/actor.js +++ b/lib/actor.js @@ -1,11 +1,12 @@ -const Step = require('./step'); -const { MetaStep } = require('./step'); -const container = require('./container'); -const { methodsOfObject } = require('./utils'); -const recorder = require('./recorder'); -const event = require('./event'); -const store = require('./store'); -const output = require('./output'); +const Step = require('./step') +const MetaStep = require('./step/meta') +const recordStep = require('./step/record') +const container = require('./container') +const { methodsOfObject } = require('./utils') +const { TIMEOUT_ORDER } = require('./timeout') +const event = require('./event') +const store = require('./store') +const output = require('./output') /** * @interface @@ -21,13 +22,13 @@ class Actor { * ⚠ī¸ returns a promise which is synchronized internally by recorder */ async say(msg, color = 'cyan') { - const step = new Step('say', 'say'); - step.status = 'passed'; + const step = new Step('say', 'say') + step.status = 'passed' return recordStep(step, [msg]).then(() => { // this is backward compatibility as this event may be used somewhere - event.emit(event.step.comment, msg); - output.say(msg, `${color}`); - }); + event.emit(event.step.comment, msg) + output.say(msg, `${color}`) + }) } /** @@ -38,14 +39,16 @@ class Actor { * @inner */ limitTime(timeout) { - if (!store.timeouts) return this; + if (!store.timeouts) return this - event.dispatcher.prependOnceListener(event.step.before, (step) => { - output.log(`Timeout to ${step}: ${timeout}s`); - step.setTimeout(timeout * 1000, Step.TIMEOUT_ORDER.codeLimitTime); - }); + console.log('I.limitTime() is deprecated, use step.timeout() instead') - return this; + event.dispatcher.prependOnceListener(event.step.before, step => { + output.log(`Timeout to ${step}: ${timeout}s`) + step.setTimeout(timeout * 1000, TIMEOUT_ORDER.codeLimitTime) + }) + + return this } /** @@ -55,11 +58,10 @@ class Actor { * @inner */ retry(opts) { - if (opts === undefined) opts = 1; - recorder.retry(opts); - // remove retry once the step passed - recorder.add(() => event.dispatcher.once(event.step.finished, () => recorder.retries.pop())); - return this; + console.log('I.retry() is deprecated, use step.retry() instead') + const retryStep = require('./step/retry') + retryStep(opts) + return this } } @@ -70,92 +72,54 @@ class Actor { * @ignore */ module.exports = function (obj = {}) { - if (!store.actor) { - store.actor = new Actor(); - } - const actor = store.actor; - - const translation = container.translation(); - - if (Object.keys(obj).length > 0) { - Object.keys(obj) - .forEach(action => { - const actionAlias = translation.actionAliasFor(action); + const actor = container.actor() || new Actor() - const currentMethod = obj[action]; - const ms = new MetaStep('I', action); - if (translation.loaded) { - ms.name = actionAlias; - ms.actor = translation.I; - } - ms.setContext(actor); - actor[action] = actor[actionAlias] = ms.run.bind(ms, currentMethod); - }); - } - - const helpers = container.helpers(); + // load all helpers once container initialized + container.started(() => { + const translation = container.translation() + const helpers = container.helpers() - // add methods from enabled helpers - Object.values(helpers) - .forEach((helper) => { + // add methods from enabled helpers + Object.values(helpers).forEach(helper => { methodsOfObject(helper, 'Helper') .filter(method => method !== 'constructor' && method[0] !== '_') - .forEach((action) => { - const actionAlias = translation.actionAliasFor(action); + .forEach(action => { + const actionAlias = translation.actionAliasFor(action) if (!actor[action]) { actor[action] = actor[actionAlias] = function () { - const step = new Step(helper, action); + const step = new Step(helper, action) if (translation.loaded) { - step.name = actionAlias; - step.actor = translation.I; + step.name = actionAlias + step.actor = translation.I } // add methods to promise chain - return recordStep(step, Array.from(arguments)); - }; + return recordStep(step, Array.from(arguments)) + } } - }); - }); - - return actor; -}; - -function recordStep(step, args) { - step.status = 'queued'; - step.setArguments(args); - - // run async before step hooks - event.emit(event.step.before, step); - - const task = `${step.name}: ${step.humanizeArgs()}`; - let val; - - // run step inside promise - recorder.add(task, () => { - if (!step.startTime) { // step can be retries - event.emit(event.step.started, step); - step.startTime = Date.now(); - } - return val = step.run(...args); - }, false, undefined, step.getTimeout()); - - event.emit(event.step.after, step); - - recorder.add('step passed', () => { - step.endTime = Date.now(); - event.emit(event.step.passed, step, val); - event.emit(event.step.finished, step); - }); - - recorder.catchWithoutStop((err) => { - step.status = 'failed'; - step.endTime = Date.now(); - event.emit(event.step.failed, step); - event.emit(event.step.finished, step); - throw err; - }); - - recorder.add('return result', () => val); - // run async after step hooks - - return recorder.promise(); + }) + }) + + // add translated custom steps from actor + Object.keys(obj).forEach(key => { + const actionAlias = translation.actionAliasFor(key) + if (!actor[actionAlias]) { + actor[actionAlias] = actor[key] + } + }) + + container.append({ + support: { + I: actor, + }, + }) + }) + // store.actor = actor; + // add custom steps from actor + Object.keys(obj).forEach(key => { + const ms = new MetaStep('I', key) + ms.setContext(actor) + actor[key] = ms.run.bind(ms, obj[key]) + }) + + return actor } diff --git a/lib/ai.js b/lib/ai.js index 86dffcd3b..2104dafec 100644 --- a/lib/ai.js +++ b/lib/ai.js @@ -1,40 +1,44 @@ -const debug = require('debug')('codeceptjs:ai'); -const output = require('./output'); -const event = require('./event'); -const { removeNonInteractiveElements, minifyHtml, splitByChunks } = require('./html'); +const debug = require('debug')('codeceptjs:ai') +const output = require('./output') +const event = require('./event') +const { removeNonInteractiveElements, minifyHtml, splitByChunks } = require('./html') const defaultHtmlConfig = { maxLength: 50000, simplify: true, minify: true, html: {}, -}; +} const defaultPrompts = { - writeStep: (html, input) => [{ - role: 'user', - content: `I am test engineer writing test in CodeceptJS + writeStep: (html, input) => [ + { + role: 'user', + content: `I am test engineer writing test in CodeceptJS I have opened web page and I want to use CodeceptJS to ${input} on this page Provide me valid CodeceptJS code to accomplish it Use only locators from this HTML: \n\n${html}`, - }, + }, ], healStep: (html, { step, error, prevSteps }) => { - return [{ - role: 'user', - content: `As a test automation engineer I am testing web application using CodeceptJS. + return [ + { + role: 'user', + content: `As a test automation engineer I am testing web application using CodeceptJS. I want to heal a test that fails. Here is the list of executed steps: ${prevSteps.map(s => s.toString()).join(', ')} Propose how to adjust ${step.toCode()} step to fix the test. Use locators in order of preference: semantic locator by text, CSS, XPath. Use codeblocks marked with \`\`\` Here is the error message: ${error.message} Here is HTML code of a page where the failure has happened: \n\n${html}`, - }]; + }, + ] }, - generatePageObject: (html, extraPrompt = '', rootLocator = null) => [{ - role: 'user', - content: `As a test automation engineer I am creating a Page Object for a web application using CodeceptJS. + generatePageObject: (html, extraPrompt = '', rootLocator = null) => [ + { + role: 'user', + content: `As a test automation engineer I am creating a Page Object for a web application using CodeceptJS. Here is an sample page object: const { I } = inject(); @@ -60,72 +64,73 @@ module.exports = { ${extraPrompt} ${rootLocator ? `All provided elements are inside '${rootLocator}'. Declare it as root variable and for every locator use locate(...).inside(root)` : ''} Add only locators from this HTML: \n\n${html}`, - }], -}; + }, + ], +} class AiAssistant { constructor() { - this.totalTime = 0; - this.numTokens = 0; + this.totalTime = 0 + this.numTokens = 0 - this.reset(); - this.connectToEvents(); + this.reset() + this.connectToEvents() } enable(config = {}) { - debug('Enabling AI assistant'); - this.isEnabled = true; + debug('Enabling AI assistant') + this.isEnabled = true - const { html, prompts, ...aiConfig } = config; + const { html, prompts, ...aiConfig } = config - this.config = Object.assign(this.config, aiConfig); - this.htmlConfig = Object.assign(defaultHtmlConfig, html); - this.prompts = Object.assign(defaultPrompts, prompts); + this.config = Object.assign(this.config, aiConfig) + this.htmlConfig = Object.assign(defaultHtmlConfig, html) + this.prompts = Object.assign(defaultPrompts, prompts) - debug('Config', this.config); + debug('Config', this.config) } reset() { - this.numTokens = 0; - this.isEnabled = false; + this.numTokens = 0 + this.isEnabled = false this.config = { maxTokens: 1000000, request: null, response: parseCodeBlocks, // lets limit token usage to 1M - }; - this.minifiedHtml = null; - this.response = null; - this.totalTime = 0; + } + this.minifiedHtml = null + this.response = null + this.totalTime = 0 } disable() { - this.isEnabled = false; + this.isEnabled = false } connectToEvents() { event.dispatcher.on(event.all.result, () => { if (this.isEnabled && this.numTokens > 0) { - const numTokensK = Math.ceil(this.numTokens / 1000); - const maxTokensK = Math.ceil(this.config.maxTokens / 1000); - output.print(`AI assistant took ${this.totalTime}s and used ~${numTokensK}K input tokens. Tokens limit: ${maxTokensK}K`); + const numTokensK = Math.ceil(this.numTokens / 1000) + const maxTokensK = Math.ceil(this.config.maxTokens / 1000) + output.print(`AI assistant took ${this.totalTime}s and used ~${numTokensK}K input tokens. Tokens limit: ${maxTokensK}K`) } - }); + }) } checkRequestFn() { if (!this.isEnabled) { - debug('AI assistant is disabled'); - return; + debug('AI assistant is disabled') + return } - if (this.config.request) return; + if (this.config.request) return const noRequestErrorMessage = ` - No request function is set for AI assistant. - Please implement your own request function and set it in the config. + No request function is set for AI assistant. - [!] AI request was decoupled from CodeceptJS. To connect to OpenAI or other AI service, please implement your own request function and set it in the config. + [!] AI request was decoupled from CodeceptJS. To connect to OpenAI or other AI service. + Please implement your own request function and set it in the config. Example (connect to OpenAI): @@ -134,82 +139,80 @@ class AiAssistant { const OpenAI = require('openai'); const openai = new OpenAI({ apiKey: process.env['OPENAI_API_KEY'] }) const response = await openai.chat.completions.create({ - model: 'gpt-3.5-turbo-0125', + model: 'gpt-4o-mini', messages, }); return response?.data?.choices[0]?.message?.content; } } - `.trim(); + `.trim() - throw new Error(noRequestErrorMessage); + throw new Error(noRequestErrorMessage) } async setHtmlContext(html) { - let processedHTML = html; + let processedHTML = html if (this.htmlConfig.simplify) { - processedHTML = removeNonInteractiveElements(processedHTML, this.htmlConfig); + processedHTML = removeNonInteractiveElements(processedHTML, this.htmlConfig) } - if (this.htmlConfig.minify) processedHTML = await minifyHtml(processedHTML); - if (this.htmlConfig.maxLength) processedHTML = splitByChunks(processedHTML, this.htmlConfig.maxLength)[0]; + if (this.htmlConfig.minify) processedHTML = await minifyHtml(processedHTML) + if (this.htmlConfig.maxLength) processedHTML = splitByChunks(processedHTML, this.htmlConfig.maxLength)[0] - this.minifiedHtml = processedHTML; + this.minifiedHtml = processedHTML } getResponse() { - return this.response || ''; + return this.response || '' } async createCompletion(messages) { - if (!this.isEnabled) return ''; - - debug('Request', messages); - - this.checkRequestFn(); - - this.response = null; - - this.calculateTokens(messages); + if (!this.isEnabled) return '' try { - const startTime = process.hrtime(); - this.response = await this.config.request(messages); - const endTime = process.hrtime(startTime); - const executionTimeInSeconds = endTime[0] + endTime[1] / 1e9; - - this.totalTime += Math.round(executionTimeInSeconds); - debug('AI response time', executionTimeInSeconds); - debug('Response', this.response); - this.stopWhenReachingTokensLimit(); - return this.response; + this.checkRequestFn() + debug('Request', messages) + + this.response = null + + this.calculateTokens(messages) + const startTime = process.hrtime() + this.response = await this.config.request(messages) + const endTime = process.hrtime(startTime) + const executionTimeInSeconds = endTime[0] + endTime[1] / 1e9 + + this.totalTime += Math.round(executionTimeInSeconds) + debug('AI response time', executionTimeInSeconds) + debug('Response', this.response) + this.stopWhenReachingTokensLimit() + return this.response } catch (err) { - debug(err.response); - output.print(''); - output.error(`AI service error: ${err.message}`); - if (err?.response?.data?.error?.code) output.error(err?.response?.data?.error?.code); - if (err?.response?.data?.error?.message) output.error(err?.response?.data?.error?.message); - this.stopWhenReachingTokensLimit(); - return ''; + debug(err.response) + output.print('') + output.error(`AI service error: ${err.message}`) + if (err?.response?.data?.error?.code) output.error(err?.response?.data?.error?.code) + if (err?.response?.data?.error?.message) output.error(err?.response?.data?.error?.message) + this.stopWhenReachingTokensLimit() + return '' } } async healFailedStep(failureContext) { - if (!this.isEnabled) return []; - if (!failureContext.html) throw new Error('No HTML context provided'); + if (!this.isEnabled) return [] + if (!failureContext.html) throw new Error('No HTML context provided') - await this.setHtmlContext(failureContext.html); + await this.setHtmlContext(failureContext.html) if (!this.minifiedHtml) { - debug('HTML context is empty after removing non-interactive elements & minification'); - return []; + debug('HTML context is empty after removing non-interactive elements & minification') + return [] } - const response = await this.createCompletion(this.prompts.healStep(this.minifiedHtml, failureContext)); - if (!response) return []; + const response = await this.createCompletion(this.prompts.healStep(this.minifiedHtml, failureContext)) + if (!response) return [] - return this.config.response(response); + return this.config.response(response) } /** @@ -219,13 +222,13 @@ class AiAssistant { * @returns */ async generatePageObject(extraPrompt = null, locator = null) { - if (!this.isEnabled) return []; - if (!this.minifiedHtml) throw new Error('No HTML context provided'); + if (!this.isEnabled) return [] + if (!this.minifiedHtml) throw new Error('No HTML context provided') - const response = await this.createCompletion(this.prompts.generatePageObject(this.minifiedHtml, locator, extraPrompt)); - if (!response) return []; + const response = await this.createCompletion(this.prompts.generatePageObject(this.minifiedHtml, locator, extraPrompt)) + if (!response) return [] - return this.config.response(response); + return this.config.response(response) } calculateTokens(messages) { @@ -233,66 +236,72 @@ class AiAssistant { // this approach was tested via https://platform.openai.com/tokenizer // we need it to display current tokens usage so users could analyze effectiveness of AI - const inputString = messages.map(m => m.content).join(' ').trim(); - const numWords = (inputString.match(/[^\s\-:=]+/g) || []).length; + const inputString = messages + .map(m => m.content) + .join(' ') + .trim() + const numWords = (inputString.match(/[^\s\-:=]+/g) || []).length // 2.5 token is constant for average HTML input - const tokens = numWords * 2.5; + const tokens = numWords * 2.5 - this.numTokens += tokens; + this.numTokens += tokens - return tokens; + return tokens } stopWhenReachingTokensLimit() { - if (this.numTokens < this.config.maxTokens) return; + if (this.numTokens < this.config.maxTokens) return - output.print(`AI assistant has reached the limit of ${this.config.maxTokens} tokens in this session. It will be disabled now`); - this.disable(); + output.print(`AI assistant has reached the limit of ${this.config.maxTokens} tokens in this session. It will be disabled now`) + this.disable() } async writeSteps(input) { - if (!this.isEnabled) return; - if (!this.minifiedHtml) throw new Error('No HTML context provided'); + if (!this.isEnabled) return + if (!this.minifiedHtml) throw new Error('No HTML context provided') - const snippets = []; + const snippets = [] - const response = await this.createCompletion(this.prompts.writeStep(this.minifiedHtml, input)); - if (!response) return; - snippets.push(...this.config.response(response)); + const response = await this.createCompletion(this.prompts.writeStep(this.minifiedHtml, input)) + if (!response) return + snippets.push(...this.config.response(response)) - debug(snippets[0]); + debug(snippets[0]) - return snippets[0]; + return snippets[0] } } function parseCodeBlocks(response) { // Regular expression pattern to match code snippets - const codeSnippetPattern = /```(?:javascript|js|typescript|ts)?\n([\s\S]+?)\n```/g; + const codeSnippetPattern = /```(?:javascript|js|typescript|ts)?\n([\s\S]+?)\n```/g // Array to store extracted code snippets - const codeSnippets = []; + const codeSnippets = [] - response = response.split('\n').map(line => line.trim()).join('\n'); + response = response + .split('\n') + .map(line => line.trim()) + .join('\n') // Iterate over matches and extract code snippets - let match; + let match while ((match = codeSnippetPattern.exec(response)) !== null) { - codeSnippets.push(match[1]); + codeSnippets.push(match[1]) } // Remove "Scenario", "Feature", and "require()" lines const modifiedSnippets = codeSnippets.map(snippet => { - const lines = snippet.split('\n'); + const lines = snippet.split('\n') - const filteredLines = lines.filter(line => !line.includes('I.amOnPage') && !line.startsWith('Scenario') && !line.startsWith('Feature') && !line.includes('= require(')); + const filteredLines = lines.filter(line => !line.includes('I.amOnPage') && !line.startsWith('Scenario') && !line.startsWith('Feature') && !line.includes('= require(')) - return filteredLines.join('\n'); + return filteredLines.join('\n') // remove snippets that move from current url - }); // .filter(snippet => !line.includes('I.amOnPage')); + }) // .filter(snippet => !line.includes('I.amOnPage')); - return modifiedSnippets.filter(snippet => !!snippet); + return modifiedSnippets.filter(snippet => !!snippet) } -module.exports = new AiAssistant(); +module.exports = new AiAssistant() diff --git a/lib/assert/empty.js b/lib/assert/empty.js index 859bcbfa7..5f79cd878 100644 --- a/lib/assert/empty.js +++ b/lib/assert/empty.js @@ -5,7 +5,7 @@ const output = require('../output') class EmptinessAssertion extends Assertion { constructor(params) { - super((value) => { + super(value => { if (Array.isArray(value)) { return value.length === 0 } @@ -22,9 +22,7 @@ class EmptinessAssertion extends Assertion { const err = new AssertionFailedError(this.params, "{{customMessage}}expected {{subject}} '{{value}}' {{type}}") err.cliMessage = () => { - const msg = err.template - .replace('{{value}}', output.colors.bold('{{value}}')) - .replace('{{subject}}', output.colors.bold('{{subject}}')) + const msg = err.template.replace('{{value}}', output.colors.bold('{{value}}')).replace('{{subject}}', output.colors.bold('{{subject}}')) return template(msg, this.params) } return err @@ -39,5 +37,5 @@ class EmptinessAssertion extends Assertion { module.exports = { Assertion: EmptinessAssertion, - empty: (subject) => new EmptinessAssertion({ subject }), + empty: subject => new EmptinessAssertion({ subject }), } diff --git a/lib/assert/equal.js b/lib/assert/equal.js index f8ef0a9d9..c5b5f03d3 100644 --- a/lib/assert/equal.js +++ b/lib/assert/equal.js @@ -18,10 +18,7 @@ class EqualityAssertion extends Assertion { getException() { const params = this.params params.jar = template(params.jar, params) - const err = new AssertionFailedError( - params, - '{{customMessage}}expected {{jar}} "{{expected}}" {{type}} "{{actual}}"', - ) + const err = new AssertionFailedError(params, '{{customMessage}}expected {{jar}} "{{expected}}" {{type}} "{{actual}}"') err.showDiff = false if (typeof err.cliMessage === 'function') { err.message = err.cliMessage() @@ -42,8 +39,8 @@ class EqualityAssertion extends Assertion { module.exports = { Assertion: EqualityAssertion, - equals: (jar) => new EqualityAssertion({ jar }), - urlEquals: (baseUrl) => { + equals: jar => new EqualityAssertion({ jar }), + urlEquals: baseUrl => { const assert = new EqualityAssertion({ jar: 'url of current page' }) assert.comparator = function (expected, actual) { if (expected.indexOf('http') !== 0) { @@ -53,5 +50,5 @@ module.exports = { } return assert }, - fileEquals: (file) => new EqualityAssertion({ file, jar: 'contents of {{file}}' }), + fileEquals: file => new EqualityAssertion({ file, jar: 'contents of {{file}}' }), } diff --git a/lib/assert/include.js b/lib/assert/include.js index 3899f4ca0..4e910c777 100644 --- a/lib/assert/include.js +++ b/lib/assert/include.js @@ -10,7 +10,7 @@ class InclusionAssertion extends Assertion { params.jar = params.jar || 'string' const comparator = function (needle, haystack) { if (Array.isArray(haystack)) { - return haystack.filter((part) => part.indexOf(needle) >= 0).length > 0 + return haystack.filter(part => part.indexOf(needle) >= 0).length > 0 } return haystack.indexOf(needle) >= 0 } @@ -28,9 +28,7 @@ class InclusionAssertion extends Assertion { this.params.haystack = this.params.haystack.join('\n___(next element)___\n') } err.cliMessage = function () { - const msg = this.template - .replace('{{jar}}', output.colors.bold('{{jar}}')) - .replace('{{needle}}', output.colors.bold('{{needle}}')) + const msg = this.template.replace('{{jar}}', output.colors.bold('{{jar}}')).replace('{{needle}}', output.colors.bold('{{needle}}')) return template(msg, this.params) } return err @@ -66,11 +64,11 @@ class InclusionAssertion extends Assertion { module.exports = { Assertion: InclusionAssertion, - includes: (needleType) => { + includes: needleType => { needleType = needleType || 'string' return new InclusionAssertion({ jar: needleType }) }, - fileIncludes: (file) => new InclusionAssertion({ file, jar: 'file {{file}}' }), + fileIncludes: file => new InclusionAssertion({ file, jar: 'file {{file}}' }), } function escapeRegExp(str) { diff --git a/lib/assert/throws.js b/lib/assert/throws.js index c0e92276c..0bdf938df 100644 --- a/lib/assert/throws.js +++ b/lib/assert/throws.js @@ -11,10 +11,8 @@ function errorThrown(actual, expected) { throw new Error(`Expected error to be thrown with message ${expected} while '${msg}' caught`) } if (typeof expected === 'object') { - if (actual.constructor.name !== expected.constructor.name) - throw new Error(`Expected ${expected} error to be thrown but ${actual} was caught`) - if (expected.message && expected.message !== msg) - throw new Error(`Expected error to be thrown with message ${expected.message} while '${msg}' caught`) + if (actual.constructor.name !== expected.constructor.name) throw new Error(`Expected ${expected} error to be thrown but ${actual} was caught`) + if (expected.message && expected.message !== msg) throw new Error(`Expected error to be thrown with message ${expected.message} while '${msg}' caught`) } return null } diff --git a/lib/assert/truth.js b/lib/assert/truth.js index 51dbe2def..cc70965b5 100644 --- a/lib/assert/truth.js +++ b/lib/assert/truth.js @@ -5,9 +5,9 @@ const output = require('../output') class TruthAssertion extends Assertion { constructor(params) { - super((value) => { + super(value => { if (Array.isArray(value)) { - return value.filter((val) => !!val).length > 0 + return value.filter(val => !!val).length > 0 } return !!value }, params) diff --git a/lib/cli.js b/lib/cli.js deleted file mode 100644 index 0d02c7765..000000000 --- a/lib/cli.js +++ /dev/null @@ -1,257 +0,0 @@ -const { reporters: { Base } } = require('mocha'); -const ms = require('ms'); -const event = require('./event'); -const AssertionFailedError = require('./assert/error'); -const output = require('./output'); -const { MetaStep } = require('./step'); - -const cursor = Base.cursor; -let currentMetaStep = []; -let codeceptjsEventDispatchersRegistered = false; - -class Cli extends Base { - constructor(runner, opts) { - super(runner); - let level = 0; - this.loadedTests = []; - opts = opts.reporterOptions || opts; - if (opts.steps) level = 1; - if (opts.debug) level = 2; - if (opts.verbose) level = 3; - output.level(level); - output.print(`CodeceptJS v${require('./codecept').version()} ${output.standWithUkraine()}`); - output.print(`Using test root "${global.codecept_dir}"`); - - const showSteps = level >= 1; - - if (level >= 2) { - const Containter = require('./container'); - output.print(output.styles.debug(`Helpers: ${Object.keys(Containter.helpers()).join(', ')}`)); - output.print(output.styles.debug(`Plugins: ${Object.keys(Containter.plugins()).join(', ')}`)); - } - - runner.on('start', () => { - console.log(); - }); - - runner.on('suite', (suite) => { - output.suite.started(suite); - }); - - runner.on('fail', (test) => { - if (test.ctx.currentTest) { - this.loadedTests.push(test.ctx.currentTest.uid); - } - if (showSteps && test.steps) { - return output.scenario.failed(test); - } - cursor.CR(); - output.test.failed(test); - }); - - runner.on('pending', (test) => { - if (test.parent && test.parent.pending) { - const suite = test.parent; - const skipInfo = suite.opts.skipInfo || {}; - skipTestConfig(test, skipInfo.message); - } else { - skipTestConfig(test, null); - } - this.loadedTests.push(test.uid); - cursor.CR(); - output.test.skipped(test); - }); - - runner.on('pass', (test) => { - if (showSteps && test.steps) { - return output.scenario.passed(test); - } - cursor.CR(); - output.test.passed(test); - }); - - if (showSteps) { - runner.on('test', (test) => { - currentMetaStep = []; - if (test.steps) { - output.test.started(test); - } - }); - - if (!codeceptjsEventDispatchersRegistered) { - codeceptjsEventDispatchersRegistered = true; - - event.dispatcher.on(event.bddStep.started, (step) => { - output.stepShift = 2; - output.step(step); - }); - - event.dispatcher.on(event.step.started, (step) => { - let processingStep = step; - const metaSteps = []; - while (processingStep.metaStep) { - metaSteps.unshift(processingStep.metaStep); - processingStep = processingStep.metaStep; - } - const shift = metaSteps.length; - - for (let i = 0; i < Math.max(currentMetaStep.length, metaSteps.length); i++) { - if (currentMetaStep[i] !== metaSteps[i]) { - output.stepShift = 3 + 2 * i; - if (!metaSteps[i]) continue; - // bdd steps are handled by bddStep.started - if (metaSteps[i].isBDD()) continue; - output.step(metaSteps[i]); - } - } - currentMetaStep = metaSteps; - output.stepShift = 3 + 2 * shift; - if (step.helper.constructor.name !== 'ExpectHelper') { - output.step(step); - } - }); - - event.dispatcher.on(event.step.finished, () => { - output.stepShift = 0; - }); - } - } - - runner.on('suite end', suite => { - let skippedCount = 0; - const grep = runner._grep; - for (const test of suite.tests) { - if (!test.state && !this.loadedTests.includes(test.uid)) { - if (matchTest(grep, test.title)) { - if (!test.opts) { - test.opts = {}; - } - if (!test.opts.skipInfo) { - test.opts.skipInfo = {}; - } - skipTestConfig(test, 'Skipped due to failure in \'before\' hook'); - output.test.skipped(test); - skippedCount += 1; - } - } - } - - this.stats.pending += skippedCount; - this.stats.tests += skippedCount; - }); - - runner.on('end', this.result.bind(this)); - } - - result() { - const stats = this.stats; - stats.failedHooks = 0; - console.log(); - - // passes - if (stats.failures) { - output.print(output.styles.bold('-- FAILURES:')); - } - - const failuresLog = []; - - // failures - if (stats.failures) { - // append step traces - this.failures.map((test) => { - const err = test.err; - - let log = ''; - - if (err instanceof AssertionFailedError) { - err.message = err.inspect(); - } - - const steps = test.steps || (test.ctx && test.ctx.test.steps); - - if (steps && steps.length) { - let scenarioTrace = ''; - steps.reverse().forEach((step) => { - const line = `- ${step.toCode()} ${step.line()}`; - // if (step.status === 'failed') line = '' + line; - scenarioTrace += `\n${line}`; - }); - log += `${output.styles.bold('Scenario Steps')}:${scenarioTrace}\n`; - } - - // display artifacts in debug mode - if (test?.artifacts && Object.keys(test.artifacts).length) { - log += `\n${output.styles.bold('Artifacts:')}`; - for (const artifact of Object.keys(test.artifacts)) { - log += `\n- ${artifact}: ${test.artifacts[artifact]}`; - } - } - - try { - let stack = err.stack ? err.stack.split('\n') : []; - if (stack[0] && stack[0].includes(err.message)) { - stack.shift(); - } - - if (output.level() < 3) { - stack = stack.slice(0, 3); - } - - err.stack = `${stack.join('\n')}\n\n${output.colors.blue(log)}`; - - // clone err object so stack trace adjustments won't affect test other reports - test.err = err; - return test; - } catch (e) { - throw Error(e); - } - }); - - const originalLog = Base.consoleLog; - Base.consoleLog = (...data) => { - failuresLog.push([...data]); - originalLog(...data); - }; - Base.list(this.failures); - Base.consoleLog = originalLog; - console.log(); - } - - this.failures.forEach((failure) => { - if (failure.constructor.name === 'Hook') { - stats.failures -= stats.failures - stats.failedHooks += 1 - } - }) - event.emit(event.all.failures, { failuresLog, stats }); - output.result(stats.passes, stats.failures, stats.pending, ms(stats.duration), stats.failedHooks); - - if (stats.failures && output.level() < 3) { - output.print(output.styles.debug('Run with --verbose flag to see complete NodeJS stacktrace')); - } - } -} - -function matchTest(grep, test) { - if (grep) { - return grep.test(test); - } - return true; -} - -function skipTestConfig(test, message) { - if (!test.opts) { - test.opts = {}; - } - if (!test.opts.skipInfo) { - test.opts.skipInfo = {}; - } - test.opts.skipInfo.message = test.opts.skipInfo.message || message; - test.opts.skipInfo.isFastSkipped = true; - event.emit(event.test.skipped, test); - test.state = 'skipped'; -} - -module.exports = function (runner, opts) { - return new Cli(runner, opts); -}; diff --git a/lib/codecept.js b/lib/codecept.js index 47e0bbe5d..7953b20a0 100644 --- a/lib/codecept.js +++ b/lib/codecept.js @@ -1,14 +1,14 @@ -const { existsSync, readFileSync } = require('fs'); -const glob = require('glob'); -const fsPath = require('path'); -const { resolve } = require('path'); - -const container = require('./container'); -const Config = require('./config'); -const event = require('./event'); -const runHook = require('./hooks'); -const output = require('./output'); -const { emptyFolder } = require('./utils'); +const { existsSync, readFileSync } = require('fs') +const { globSync } = require('glob') +const fsPath = require('path') +const { resolve } = require('path') + +const container = require('./container') +const Config = require('./config') +const event = require('./event') +const runHook = require('./hooks') +const output = require('./output') +const { emptyFolder } = require('./utils') /** * CodeceptJS runner @@ -22,10 +22,10 @@ class Codecept { * @param {*} opts */ constructor(config, opts) { - this.config = Config.create(config); - this.opts = opts; - this.testFiles = new Array(0); - this.requireModules(config.require); + this.config = Config.create(config) + this.opts = opts + this.testFiles = new Array(0) + this.requireModules(config.require) } /** @@ -35,13 +35,13 @@ class Codecept { */ requireModules(requiringModules) { if (requiringModules) { - requiringModules.forEach((requiredModule) => { - const isLocalFile = existsSync(requiredModule) || existsSync(`${requiredModule}.js`); + requiringModules.forEach(requiredModule => { + const isLocalFile = existsSync(requiredModule) || existsSync(`${requiredModule}.js`) if (isLocalFile) { - requiredModule = resolve(requiredModule); + requiredModule = resolve(requiredModule) } - require(requiredModule); - }); + require(requiredModule) + }) } } @@ -52,10 +52,10 @@ class Codecept { * @param {string} dir */ init(dir) { - this.initGlobals(dir); + this.initGlobals(dir) // initializing listeners - container.create(this.config, this.opts); - this.runHooks(); + container.create(this.config, this.opts) + this.runHooks() } /** @@ -64,37 +64,37 @@ class Codecept { * @param {string} dir */ initGlobals(dir) { - global.codecept_dir = dir; - global.output_dir = fsPath.resolve(dir, this.config.output); + global.codecept_dir = dir + global.output_dir = fsPath.resolve(dir, this.config.output) - if (this.config.emptyOutputFolder) emptyFolder(global.output_dir); + if (this.config.emptyOutputFolder) emptyFolder(global.output_dir) if (!this.config.noGlobals) { - global.Helper = global.codecept_helper = require('@codeceptjs/helper'); - global.actor = global.codecept_actor = require('./actor'); - global.pause = require('./pause'); - global.within = require('./within'); - global.session = require('./session'); - global.DataTable = require('./data/table'); - global.locate = locator => require('./locator').build(locator); - global.inject = container.support; - global.share = container.share; - global.secret = require('./secret').secret; - global.codecept_debug = output.debug; - global.codeceptjs = require('./index'); // load all objects + global.Helper = global.codecept_helper = require('@codeceptjs/helper') + global.actor = global.codecept_actor = require('./actor') + global.pause = require('./pause') + global.within = require('./within') + global.session = require('./session') + global.DataTable = require('./data/table') + global.locate = locator => require('./locator').build(locator) + global.inject = container.support + global.share = container.share + global.secret = require('./secret').secret + global.codecept_debug = output.debug + global.codeceptjs = require('./index') // load all objects // BDD - const stepDefinitions = require('./interfaces/bdd'); - global.Given = stepDefinitions.Given; - global.When = stepDefinitions.When; - global.Then = stepDefinitions.Then; - global.DefineParameterType = stepDefinitions.defineParameterType; + const stepDefinitions = require('./mocha/bdd') + global.Given = stepDefinitions.Given + global.When = stepDefinitions.When + global.Then = stepDefinitions.Then + global.DefineParameterType = stepDefinitions.defineParameterType // debug mode - global.debugMode = false; + global.debugMode = false // mask sensitive data - global.maskSensitiveData = this.config.maskSensitiveData || false; + global.maskSensitiveData = this.config.maskSensitiveData || false } } @@ -103,16 +103,18 @@ class Codecept { */ runHooks() { // default hooks - runHook(require('./listener/steps')); - runHook(require('./listener/artifacts')); - runHook(require('./listener/config')); - runHook(require('./listener/helpers')); - runHook(require('./listener/retry')); - runHook(require('./listener/timeout')); - runHook(require('./listener/exit')); + runHook(require('./listener/store')) + runHook(require('./listener/steps')) + runHook(require('./listener/config')) + runHook(require('./listener/result')) + runHook(require('./listener/helpers')) + runHook(require('./listener/globalTimeout')) + runHook(require('./listener/globalRetry')) + runHook(require('./listener/exit')) + runHook(require('./listener/emptyRun')) // custom hooks (previous iteration of plugins) - this.config.hooks.forEach(hook => runHook(hook)); + this.config.hooks.forEach(hook => runHook(hook)) } /** @@ -120,7 +122,7 @@ class Codecept { * */ async bootstrap() { - return runHook(this.config.bootstrap, 'bootstrap'); + return runHook(this.config.bootstrap, 'bootstrap') } /** @@ -128,7 +130,7 @@ class Codecept { */ async teardown() { - return runHook(this.config.teardown, 'teardown'); + return runHook(this.config.teardown, 'teardown') } /** @@ -139,42 +141,44 @@ class Codecept { loadTests(pattern) { const options = { cwd: global.codecept_dir, - }; + } - let patterns = [pattern]; + let patterns = [pattern] if (!pattern) { - patterns = []; + patterns = [] // If the user wants to test a specific set of test files as an array or string. if (this.config.tests && !this.opts.features) { if (Array.isArray(this.config.tests)) { - patterns.push(...this.config.tests); + patterns.push(...this.config.tests) } else { - patterns.push(this.config.tests); + patterns.push(this.config.tests) } } if (this.config.gherkin.features && !this.opts.tests) { if (Array.isArray(this.config.gherkin.features)) { this.config.gherkin.features.forEach(feature => { - patterns.push(feature); - }); + patterns.push(feature) + }) } else { - patterns.push(this.config.gherkin.features); + patterns.push(this.config.gherkin.features) } } } for (pattern of patterns) { - glob.sync(pattern, options).forEach((file) => { - if (file.includes('node_modules')) return; - if (!fsPath.isAbsolute(file)) { - file = fsPath.join(global.codecept_dir, file); - } - if (!this.testFiles.includes(fsPath.resolve(file))) { - this.testFiles.push(fsPath.resolve(file)); - } - }); + if (pattern) { + globSync(pattern, options).forEach(file => { + if (file.includes('node_modules')) return + if (!fsPath.isAbsolute(file)) { + file = fsPath.join(global.codecept_dir, file) + } + if (!this.testFiles.includes(fsPath.resolve(file))) { + this.testFiles.push(fsPath.resolve(file)) + } + }) + } } } @@ -185,34 +189,36 @@ class Codecept { * @returns {Promise} */ async run(test) { + await container.started() + return new Promise((resolve, reject) => { - const mocha = container.mocha(); - mocha.files = this.testFiles; + const mocha = container.mocha() + mocha.files = this.testFiles if (test) { if (!fsPath.isAbsolute(test)) { - test = fsPath.join(global.codecept_dir, test); + test = fsPath.join(global.codecept_dir, test) } - mocha.files = mocha.files.filter(t => fsPath.basename(t, '.js') === test || t === test); + mocha.files = mocha.files.filter(t => fsPath.basename(t, '.js') === test || t === test) } const done = () => { - event.emit(event.all.result, this); - event.emit(event.all.after, this); - resolve(); - }; + event.emit(event.all.result, container.result()) + event.emit(event.all.after, this) + resolve() + } try { - event.emit(event.all.before, this); - mocha.run(() => done()); + event.emit(event.all.before, this) + mocha.run(() => done()) } catch (e) { - output.error(e.stack); - reject(e); + output.error(e.stack) + reject(e) } - }); + }) } static version() { - return JSON.parse(readFileSync(`${__dirname}/../package.json`, 'utf8')).version; + return JSON.parse(readFileSync(`${__dirname}/../package.json`, 'utf8')).version } } -module.exports = Codecept; +module.exports = Codecept diff --git a/lib/command/check.js b/lib/command/check.js new file mode 100644 index 000000000..de9aa3c8c --- /dev/null +++ b/lib/command/check.js @@ -0,0 +1,201 @@ +const { getConfig, getTestRoot } = require('./utils') +const Codecept = require('../codecept') +const output = require('../output') +const store = require('../store') +const container = require('../container') +const figures = require('figures') +const chalk = require('chalk') +const { createTest } = require('../mocha/test') +const { getMachineInfo } = require('./info') +const definitions = require('./definitions') + +module.exports = async function (options) { + const configFile = options.config + + setTimeout(() => { + output.error("Something went wrong. Checks didn't pass and timed out. Please check your config and helpers.") + process.exit(1) + }, options.timeout || 50000) + + const checks = { + config: false, + container: false, + pageObjects: false, + plugins: false, + ai: true, // we don't need to check AI + helpers: false, + setup: false, + teardown: false, + tests: false, + def: false, + } + + const testRoot = getTestRoot(configFile) + let config = getConfig(configFile) + + try { + config = getConfig(configFile) + checks['config'] = true + } catch (err) { + checks['config'] = err + } + + printCheck('config', checks['config'], config.name) + + let codecept + try { + codecept = new Codecept(config, options) + codecept.init(testRoot) + await container.started() + checks.container = true + } catch (err) { + checks.container = err + } + + const standardActingHelpers = container.STANDARD_ACTING_HELPERS + + printCheck('container', checks['container']) + + if (codecept) { + try { + if (options.bootstrap) await codecept.bootstrap() + checks.bootstrap = true + } catch (err) { + checks.bootstrap = err + } + printCheck('bootstrap', checks['bootstrap'], options.bootstrap ? 'Bootstrap was executed' : 'No bootstrap command') + } + + let numTests = 0 + if (codecept) { + try { + codecept.loadTests() + const mocha = container.mocha() + mocha.files = codecept.testFiles + mocha.loadFiles() + mocha.suite.suites.forEach(suite => { + numTests += suite.tests.length + }) + if (numTests > 0) { + checks.tests = true + } else { + throw new Error('No tests found') + } + } catch (err) { + checks.tests = err + } + } + + if (config?.ai?.request) { + checks.ai = true + printCheck('ai', checks['ai'], 'Configuration is enabled, request function is set') + } else { + printCheck('ai', checks['ai'], 'Disabled') + } + + printCheck('tests', checks['tests'], `Total: ${numTests} tests`) + + store.dryRun = true + + const helpers = container.helpers() + + try { + if (!Object.keys(helpers).length) throw new Error('No helpers found') + // load helpers + for (const helper of Object.values(helpers)) { + if (helper._init) helper._init() + } + checks.helpers = true + } catch (err) { + checks.helpers = err + } + + printCheck('helpers', checks['helpers'], `${Object.keys(helpers).join(', ')}`) + + const pageObjects = container.support() + + try { + if (Object.keys(pageObjects).length) { + for (const pageObject of Object.values(pageObjects)) { + pageObject.name + } + } + checks.pageObjects = true + } catch (err) { + checks.pageObjects = err + } + printCheck('page objects', checks['pageObjects'], `Total: ${Object.keys(pageObjects).length} support objects`) + + checks.plugins = true // how to check plugins? + printCheck('plugins', checks['plugins'], Object.keys(container.plugins()).join(', ')) + + if (Object.keys(helpers).length) { + const suite = container.mocha().suite + const test = createTest('test', () => {}) + checks.setup = true + for (const helper of Object.values(helpers)) { + try { + if (helper._beforeSuite) await helper._beforeSuite(suite) + if (helper._before) await helper._before(test) + } catch (err) { + err.message = `${helper.constructor.name} helper: ${err.message}` + if (checks.setup instanceof Error) err.message = `${err.message}\n\n${checks.setup?.message || ''}`.trim() + checks.setup = err + } + } + + printCheck('Helpers Before', checks['setup'], standardActingHelpers.some(h => Object.keys(helpers).includes(h)) ? 'Initializing browser' : '') + + checks.teardown = true + for (const helper of Object.values(helpers).reverse()) { + try { + if (helper._passed) await helper._passed(test) + if (helper._after) await helper._after(test) + if (helper._finishTest) await helper._finishTest(suite) + if (helper._afterSuite) await helper._afterSuite(suite) + } catch (err) { + err.message = `${helper.constructor.name} helper: ${err.message}` + if (checks.teardown instanceof Error) err.message = `${err.message}\n\n${checks.teardown?.message || ''}`.trim() + checks.teardown = err + } + } + + printCheck('Helpers After', checks['teardown'], standardActingHelpers.some(h => Object.keys(helpers).includes(h)) ? 'Closing browser' : '') + } + + try { + definitions(configFile, { dryRun: true }) + checks.def = true + } catch (err) { + checks.def = err + } + + printCheck('TypeScript Definitions', checks['def']) + + output.print('') + + if (!Object.values(checks).every(check => check === true)) { + output.error("Something went wrong. Checks didn't pass.") + output.print() + await getMachineInfo() + process.exit(1) + } + + output.print(output.styles.success('All checks passed'.toUpperCase()), 'Ready to run your tests 🚀') + process.exit(0) +} + +function printCheck(name, value, comment = '') { + let status = '' + if (value == true) { + status += chalk.bold.green(figures.tick) + } else { + status += chalk.bold.red(figures.cross) + } + + if (value instanceof Error) { + comment = `${comment} ${chalk.red(value.message)}`.trim() + } + + output.print(status, name.toUpperCase(), chalk.dim(comment)) +} diff --git a/lib/command/configMigrate.js b/lib/command/configMigrate.js index 0101c9cc2..bf63d7d79 100644 --- a/lib/command/configMigrate.js +++ b/lib/command/configMigrate.js @@ -14,9 +14,7 @@ module.exports = function (initPath) { print() print(` Welcome to ${colors.magenta.bold('CodeceptJS')} configuration migration tool`) - print( - ` It will help you switch from ${colors.cyan.bold('.json')} to ${colors.magenta.bold('.js')} config format at ease`, - ) + print(` It will help you switch from ${colors.cyan.bold('.json')} to ${colors.magenta.bold('.js')} config format at ease`) print() if (!path) { @@ -53,7 +51,7 @@ module.exports = function (initPath) { default: true, }, ]) - .then((result) => { + .then(result => { if (result.configFile) { const jsonConfigFile = path.join(testsPath, 'codecept.js') const config = JSON.parse(fs.readFileSync(jsonConfigFile, 'utf8')) diff --git a/lib/command/definitions.js b/lib/command/definitions.js index cfa4ae459..e0e0efcd1 100644 --- a/lib/command/definitions.js +++ b/lib/command/definitions.js @@ -5,7 +5,7 @@ const { getConfig, getTestRoot } = require('./utils') const Codecept = require('../codecept') const container = require('../container') const output = require('../output') -const actingHelpers = [...require('../plugin/standardActingHelpers'), 'REST'] +const actingHelpers = [...container.STANDARD_ACTING_HELPERS, 'REST'] /** * Prepare data and generate content of definitions file @@ -21,14 +21,7 @@ const actingHelpers = [...require('../plugin/standardActingHelpers'), 'REST'] * * @returns {string} */ -const getDefinitionsFileContent = ({ - hasCustomHelper, - hasCustomStepsFile, - helperNames, - supportObject, - importPaths, - translations, -}) => { +const getDefinitionsFileContent = ({ hasCustomHelper, hasCustomStepsFile, helperNames, supportObject, importPaths, translations }) => { const getHelperListFragment = ({ hasCustomHelper, hasCustomStepsFile }) => { if (hasCustomHelper && hasCustomStepsFile) { return `${['ReturnType', 'WithTranslation'].join(', ')}` @@ -73,13 +66,7 @@ const getDefinitionsFileContent = ({ * * @returns {string} */ -const generateDefinitionsContent = ({ - importPathsFragment, - supportObjectsTypeFragment, - methodsTypeFragment, - helpersListFragment, - translatedActionsFragment, -}) => { +const generateDefinitionsContent = ({ importPathsFragment, supportObjectsTypeFragment, methodsTypeFragment, helpersListFragment, translatedActionsFragment }) => { return `/// ${importPathsFragment} @@ -185,15 +172,12 @@ module.exports = function (genPath, options) { namespaceTranslationAliases.push(`interface ${translations.vocabulary.I} extends WithTranslation {}`) namespaceTranslationAliases.push(' namespace Translation {') - definitionsFileContent = definitionsFileContent.replace( - 'namespace Translation {', - namespaceTranslationAliases.join('\n'), - ) + definitionsFileContent = definitionsFileContent.replace('namespace Translation {', namespaceTranslationAliases.join('\n')) const translationAliases = [] if (translations.vocabulary.contexts) { - Object.keys(translations.vocabulary.contexts).forEach((k) => { + Object.keys(translations.vocabulary.contexts).forEach(k => { translationAliases.push(`declare const ${translations.vocabulary.contexts[k]}: typeof ${k};`) }) } @@ -201,6 +185,8 @@ module.exports = function (genPath, options) { definitionsFileContent += `\n${translationAliases.join('\n')}` } + if (options.dryRun) return + fs.writeFileSync(path.join(targetFolderPath, 'steps.d.ts'), definitionsFileContent) output.print('TypeScript Definitions provide autocompletion in Visual Studio Code and other IDEs') output.print('Definitions were generated in steps.d.ts') @@ -222,11 +208,7 @@ function getPath(originalPath, targetFolderPath, testsPath) { if (!parsedPath.dir.startsWith('.')) return path.posix.join(parsedPath.dir, parsedPath.base) const relativePath = path.posix.relative( targetFolderPath.split(path.sep).join(path.posix.sep), - path.posix.join( - testsPath.split(path.sep).join(path.posix.sep), - parsedPath.dir.split(path.sep).join(path.posix.sep), - parsedPath.base.split(path.sep).join(path.posix.sep), - ), + path.posix.join(testsPath.split(path.sep).join(path.posix.sep), parsedPath.dir.split(path.sep).join(path.posix.sep), parsedPath.base.split(path.sep).join(path.posix.sep)), ) return relativePath.startsWith('.') ? relativePath : `./${relativePath}` diff --git a/lib/command/generate.js b/lib/command/generate.js index 914b11bca..87e85fb70 100644 --- a/lib/command/generate.js +++ b/lib/command/generate.js @@ -35,7 +35,7 @@ module.exports.test = function (genPath) { type: 'input', name: 'feature', message: 'Feature which is being tested (ex: account, login, etc)', - validate: (val) => !!val, + validate: val => !!val, }, { type: 'input', @@ -46,7 +46,7 @@ module.exports.test = function (genPath) { }, }, ]) - .then((result) => { + .then(result => { const testFilePath = path.dirname(path.join(testsPath, config.tests)).replace(/\*\*$/, '') let testFile = path.join(testFilePath, result.filename) const ext = path.extname(testFile) @@ -63,9 +63,7 @@ module.exports.test = function (genPath) { testContent = testContent.replace('{{actor}}', container.translation().I) if (vocabulary.contexts.Feature) testContent = testContent.replace('Feature', vocabulary.contexts.Feature) if (vocabulary.contexts.Scenario) testContent = testContent.replace('Scenario', vocabulary.contexts.Scenario) - output.print( - `Test was created in ${colors.bold(config.translation)} localization. See: https://codecept.io/translation/`, - ) + output.print(`Test was created in ${colors.bold(config.translation)} localization. See: https://codecept.io/translation/`) } else { testContent = testContent.replace('{{actor}}', 'I') } @@ -128,13 +126,13 @@ module.exports.pageObject = function (genPath, opts) { type: 'input', name: 'name', message: `Name of a ${kind} object`, - validate: (val) => !!val, + validate: val => !!val, }, { type: 'input', name: 'filename', message: 'Where should it be stored', - default: (answers) => `./${kind}s/${answers.name}.${extension}`, + default: answers => `./${kind}s/${answers.name}.${extension}`, }, { type: 'list', @@ -144,7 +142,7 @@ module.exports.pageObject = function (genPath, opts) { default: 'module', }, ]) - .then((result) => { + .then(result => { const pageObjectFile = path.join(testsPath, result.filename) const dir = path.dirname(pageObjectFile) if (!fileExists(dir)) fs.mkdirSync(dir) @@ -194,9 +192,7 @@ module.exports.pageObject = function (genPath, opts) { try { generateDefinitions(testsPath, {}) } catch (_err) { - output.print( - `Run ${colors.green('npx codeceptjs def')} to update your types to get auto-completion for object.`, - ) + output.print(`Run ${colors.green('npx codeceptjs def')} to update your types to get auto-completion for object.`) } }) } @@ -241,16 +237,16 @@ module.exports.helper = function (genPath) { type: 'input', name: 'name', message: 'Name of a Helper', - validate: (val) => !!val, + validate: val => !!val, }, { type: 'input', name: 'filename', message: 'Where should it be stored', - default: (answers) => `./${answers.name.toLowerCase()}_helper.${extension}`, + default: answers => `./${answers.name.toLowerCase()}_helper.${extension}`, }, ]) - .then((result) => { + .then(result => { const name = ucfirst(result.name) const helperFile = path.join(testsPath, result.filename) const dir = path.dirname(helperFile) diff --git a/lib/command/gherkin/snippets.js b/lib/command/gherkin/snippets.js index c26236916..01b55d74c 100644 --- a/lib/command/gherkin/snippets.js +++ b/lib/command/gherkin/snippets.js @@ -1,132 +1,134 @@ -const escapeStringRegexp = require('escape-string-regexp'); -const fs = require('fs'); -const Gherkin = require('@cucumber/gherkin'); -const Messages = require('@cucumber/messages'); -const glob = require('glob'); -const fsPath = require('path'); +const escapeStringRegexp = require('escape-string-regexp') +const fs = require('fs') +const Gherkin = require('@cucumber/gherkin') +const Messages = require('@cucumber/messages') +const { globSync } = require('glob') +const fsPath = require('path') -const { getConfig, getTestRoot } = require('../utils'); -const Codecept = require('../../codecept'); -const output = require('../../output'); -const { matchStep } = require('../../interfaces/bdd'); +const { getConfig, getTestRoot } = require('../utils') +const Codecept = require('../../codecept') +const output = require('../../output') +const { matchStep } = require('../../mocha/bdd') -const uuidFn = Messages.IdGenerator.uuid(); -const builder = new Gherkin.AstBuilder(uuidFn); -const matcher = new Gherkin.GherkinClassicTokenMatcher(); -const parser = new Gherkin.Parser(builder, matcher); -parser.stopAtFirstError = false; +const uuidFn = Messages.IdGenerator.uuid() +const builder = new Gherkin.AstBuilder(uuidFn) +const matcher = new Gherkin.GherkinClassicTokenMatcher() +const parser = new Gherkin.Parser(builder, matcher) +parser.stopAtFirstError = false module.exports = function (genPath, options) { - const configFile = options.config || genPath; - const testsPath = getTestRoot(configFile); - const config = getConfig(configFile); - if (!config) return; + const configFile = options.config || genPath + const testsPath = getTestRoot(configFile) + const config = getConfig(configFile) + if (!config) return - const codecept = new Codecept(config, {}); - codecept.init(testsPath); + const codecept = new Codecept(config, {}) + codecept.init(testsPath) if (!config.gherkin) { - output.error('Gherkin is not enabled in config. Run `codecept gherkin:init` to enable it'); - process.exit(1); + output.error('Gherkin is not enabled in config. Run `codecept gherkin:init` to enable it') + process.exit(1) } if (!config.gherkin.steps || !config.gherkin.steps[0]) { - output.error('No gherkin steps defined in config. Exiting'); - process.exit(1); + output.error('No gherkin steps defined in config. Exiting') + process.exit(1) } if (!options.feature && !config.gherkin.features) { - output.error('No gherkin features defined in config. Exiting'); - process.exit(1); + output.error('No gherkin features defined in config. Exiting') + process.exit(1) } if (options.path && !config.gherkin.steps.includes(options.path)) { - output.error(`You must include ${options.path} to the gherkin steps in your config file`); - process.exit(1); + output.error(`You must include ${options.path} to the gherkin steps in your config file`) + process.exit(1) } - const files = []; - glob.sync(options.feature || config.gherkin.features, { cwd: options.feature ? '.' : global.codecept_dir }).forEach((file) => { + const files = [] + globSync(options.feature || config.gherkin.features, { cwd: options.feature ? '.' : global.codecept_dir }).forEach(file => { if (!fsPath.isAbsolute(file)) { - file = fsPath.join(global.codecept_dir, file); + file = fsPath.join(global.codecept_dir, file) } - files.push(fsPath.resolve(file)); - }); - output.print(`Loaded ${files.length} files`); + files.push(fsPath.resolve(file)) + }) + output.print(`Loaded ${files.length} files`) - const newSteps = new Map(); + const newSteps = new Map() - const parseSteps = (steps) => { - const newSteps = []; - let currentKeyword = ''; + const parseSteps = steps => { + const newSteps = [] + let currentKeyword = '' for (const step of steps) { if (step.keyword.trim() === 'And') { - if (!currentKeyword) throw new Error(`There is no active keyword for step '${step.text}'`); - step.keyword = currentKeyword; + if (!currentKeyword) throw new Error(`There is no active keyword for step '${step.text}'`) + step.keyword = currentKeyword } - currentKeyword = step.keyword; + currentKeyword = step.keyword try { - matchStep(step.text); + matchStep(step.text) } catch (err) { - let stepLine; + let stepLine if (/[{}()/]/.test(step.text)) { stepLine = escapeStringRegexp(step.text) .replace(/\//g, '\\/') .replace(/\"(.*?)\"/g, '"(.*?)"') .replace(/(\d+\\\.\d+)/, '(\\d+\\.\\d+)') - .replace(/ (\d+) /, ' (\\d+) '); - stepLine = Object.assign(stepLine, { type: step.keyword.trim(), location: step.location, regexp: true }); + .replace(/ (\d+) /, ' (\\d+) ') + stepLine = Object.assign(stepLine, { type: step.keyword.trim(), location: step.location, regexp: true }) } else { stepLine = step.text .replace(/\"(.*?)\"/g, '{string}') .replace(/(\d+\.\d+)/, '{float}') - .replace(/ (\d+) /, ' {int} '); - stepLine = Object.assign(stepLine, { type: step.keyword.trim(), location: step.location, regexp: false }); + .replace(/ (\d+) /, ' {int} ') + stepLine = Object.assign(stepLine, { type: step.keyword.trim(), location: step.location, regexp: false }) } - newSteps.push(stepLine); + newSteps.push(stepLine) } } - return newSteps; - }; + return newSteps + } - const parseFile = (file) => { - const ast = parser.parse(fs.readFileSync(file).toString()); + const parseFile = file => { + const ast = parser.parse(fs.readFileSync(file).toString()) for (const child of ast.feature.children) { - if (child.scenario.keyword === 'Scenario Outline') continue; // skip scenario outline - parseSteps(child.scenario.steps).map((step) => { - return Object.assign(step, { file: file.replace(global.codecept_dir, '').slice(1) }); - }).map((step) => newSteps.set(`${step.type}(${step})`, step)); + if (child.scenario.keyword === 'Scenario Outline') continue // skip scenario outline + parseSteps(child.scenario.steps) + .map(step => { + return Object.assign(step, { file: file.replace(global.codecept_dir, '').slice(1) }) + }) + .map(step => newSteps.set(`${step.type}(${step})`, step)) } - }; + } - files.forEach(file => parseFile(file)); + files.forEach(file => parseFile(file)) - let stepFile = options.path || config.gherkin.steps[0]; + let stepFile = options.path || config.gherkin.steps[0] if (!fs.existsSync(stepFile)) { - output.error(`Please enter a valid step file path ${stepFile}`); - process.exit(1); + output.error(`Please enter a valid step file path ${stepFile}`) + process.exit(1) } if (!fsPath.isAbsolute(stepFile)) { - stepFile = fsPath.join(global.codecept_dir, stepFile); + stepFile = fsPath.join(global.codecept_dir, stepFile) } const snippets = [...newSteps.values()] .filter((value, index, self) => self.indexOf(value) === index) - .map((step) => { + .map(step => { return ` ${step.type}(${step.regexp ? '/^' : "'"}${step}${step.regexp ? '$/' : "'"}, () => { // From "${step.file}" ${JSON.stringify(step.location)} throw new Error('Not implemented yet'); -});`; - }); +});` + }) if (!snippets.length) { - output.print('No new snippets found'); - return; + output.print('No new snippets found') + return } - output.success(`Snippets generated: ${snippets.length}`); - output.print(snippets.join('\n')); + output.success(`Snippets generated: ${snippets.length}`) + output.print(snippets.join('\n')) if (!options.dryRun) { - output.success(`Snippets added to ${output.colors.bold(stepFile)}`); - fs.writeFileSync(stepFile, fs.readFileSync(stepFile).toString() + snippets.join('\n') + '\n'); + output.success(`Snippets added to ${output.colors.bold(stepFile)}`) + fs.writeFileSync(stepFile, fs.readFileSync(stepFile).toString() + snippets.join('\n') + '\n') } -}; +} diff --git a/lib/command/gherkin/steps.js b/lib/command/gherkin/steps.js index ee149eb5b..a100ed6a7 100644 --- a/lib/command/gherkin/steps.js +++ b/lib/command/gherkin/steps.js @@ -1,7 +1,7 @@ const { getConfig, getTestRoot } = require('../utils'); const Codecept = require('../../codecept'); const output = require('../../output'); -const { getSteps } = require('../../interfaces/bdd'); +const { getSteps } = require('../../mocha/bdd'); module.exports = function (genPath, options) { const configFile = options.config || genPath; diff --git a/lib/command/info.js b/lib/command/info.js index 55f9856c3..05dff5bf9 100644 --- a/lib/command/info.js +++ b/lib/command/info.js @@ -3,6 +3,42 @@ const envinfo = require('envinfo') const { getConfig, getTestRoot } = require('./utils') const Codecept = require('../codecept') const output = require('../output') +const { execSync } = require('child_process') + +async function getPlaywrightBrowsers() { + try { + const regex = /(chromium|firefox|webkit)\s+version\s+([\d.]+)/gi + let versions = [] + + const info = execSync('npx playwright install --dry-run').toString().trim() + + const matches = [...info.matchAll(regex)] + + matches.forEach(match => { + const browser = match[1] + const version = match[2] + versions.push(`${browser}: ${version}`) + }) + + return versions.join(', ') + } catch (err) { + return 'Playwright not installed' + } +} + +async function getOsBrowsers() { + const chromeInfo = await envinfo.helpers.getChromeInfo() + const edgeInfo = await envinfo.helpers.getEdgeInfo() + const firefoxInfo = await envinfo.helpers.getFirefoxInfo() + const safariInfo = await envinfo.helpers.getSafariInfo() + + return [ + `chrome: ${chromeInfo ? chromeInfo[1] : 'not installed'}`, + `edge: ${edgeInfo ? edgeInfo[1] : 'not installed'}`, + `firefox: ${firefoxInfo ? firefoxInfo[1] : 'not installed'}`, + `safari: ${safariInfo ? safariInfo[1] : 'not installed'}`, + ].join(', ') +} module.exports = async function (path) { const testsPath = getTestRoot(path) @@ -10,16 +46,15 @@ module.exports = async function (path) { const codecept = new Codecept(config, {}) codecept.init(testsPath) - output.print('\n Environment information:-\n') + output.print('\n Environment information: \n') const info = {} info.codeceptVersion = Codecept.version() info.nodeInfo = await envinfo.helpers.getNodeInfo() info.osInfo = await envinfo.helpers.getOSInfo() info.cpuInfo = await envinfo.helpers.getCPUInfo() - info.chromeInfo = await envinfo.helpers.getChromeInfo() - info.edgeInfo = await envinfo.helpers.getEdgeInfo() - info.firefoxInfo = await envinfo.helpers.getFirefoxInfo() - info.safariInfo = await envinfo.helpers.getSafariInfo() + info.osBrowsers = await getOsBrowsers() + info.playwrightBrowsers = await getPlaywrightBrowsers() + const { helpers, plugins } = config info.helpers = helpers || "You don't use any helpers" info.plugins = plugins || "You don't have any enabled plugins" @@ -34,9 +69,7 @@ module.exports = async function (path) { output.print('***************************************') output.print('If you have questions ask them in our Slack: http://bit.ly/chat-codeceptjs') output.print('Or ask them on our discussion board: https://codecept.discourse.group/') - output.print( - 'Please copy environment info when you report issues on GitHub: https://github.com/Codeception/CodeceptJS/issues', - ) + output.print('Please copy environment info when you report issues on GitHub: https://github.com/Codeception/CodeceptJS/issues') output.print('***************************************') } @@ -49,6 +82,7 @@ module.exports.getMachineInfo = async () => { edgeInfo: await envinfo.helpers.getEdgeInfo(), firefoxInfo: await envinfo.helpers.getFirefoxInfo(), safariInfo: await envinfo.helpers.getSafariInfo(), + playwrightBrowsers: await getPlaywrightBrowsers(), } output.print('***************************************') diff --git a/lib/command/init.js b/lib/command/init.js index dc7027a77..735e16c23 100644 --- a/lib/command/init.js +++ b/lib/command/init.js @@ -117,7 +117,7 @@ module.exports = function (initPath) { { name: 'tests', type: 'input', - default: (answers) => `./*_test.${answers.typescript ? 'ts' : 'js'}`, + default: answers => `./*_test.${answers.typescript ? 'ts' : 'js'}`, message: 'Where are your tests located?', }, { @@ -132,7 +132,7 @@ module.exports = function (initPath) { type: 'confirm', default: true, message: 'Do you want to use JSONResponse helper for assertions on JSON responses? http://bit.ly/3ASVPy9', - when: (answers) => ['GraphQL', 'REST'].includes(answers.helper) === true, + when: answers => ['GraphQL', 'REST'].includes(answers.helper) === true, }, { name: 'output', @@ -146,7 +146,7 @@ module.exports = function (initPath) { choices: translations, }, ]) - .then((result) => { + .then(result => { if (result.typescript === true) { isTypeScript = true extension = isTypeScript === true ? 'ts' : 'js' @@ -189,7 +189,7 @@ module.exports = function (initPath) { if (!Helper._config()) return helperConfigs = helperConfigs.concat( - Helper._config().map((config) => { + Helper._config().map(config => { config.message = `[${helperName}] ${config.message}` config.name = `${helperName}_${config.name}` config.type = config.type || 'input' @@ -225,9 +225,7 @@ module.exports = function (initPath) { fs.writeFileSync(typeScriptconfigFile, configSource, 'utf-8') print(`Config created at ${typeScriptconfigFile}`) } else { - configSource = beautify( - `/** @type {CodeceptJS.MainConfig} */\nexports.config = ${inspect(config, false, 4, false)}`, - ) + configSource = beautify(`/** @type {CodeceptJS.MainConfig} */\nexports.config = ${inspect(config, false, 4, false)}`) if (hasConfigure) configSource = requireCodeceptConfigure + configHeader + configSource @@ -286,9 +284,7 @@ module.exports = function (initPath) { } } - const generateDefinitionsManually = colors.bold( - `To get auto-completion support, please generate type definitions: ${colors.green('npx codeceptjs def')}`, - ) + const generateDefinitionsManually = colors.bold(`To get auto-completion support, please generate type definitions: ${colors.green('npx codeceptjs def')}`) if (packages) { try { @@ -330,7 +326,7 @@ module.exports = function (initPath) { } print('Configure helpers...') - inquirer.prompt(helperConfigs).then(async (helperResult) => { + inquirer.prompt(helperConfigs).then(async helperResult => { if (helperResult.Playwright_browser === 'electron') { delete helperResult.Playwright_url delete helperResult.Playwright_show @@ -341,7 +337,7 @@ module.exports = function (initPath) { } } - Object.keys(helperResult).forEach((key) => { + Object.keys(helperResult).forEach(key => { const parts = key.split('_') const helperName = parts[0] const configName = parts[1] diff --git a/lib/command/interactive.js b/lib/command/interactive.js index 7f92cbec8..4cacb7a70 100644 --- a/lib/command/interactive.js +++ b/lib/command/interactive.js @@ -4,7 +4,7 @@ const Codecept = require('../codecept') const Container = require('../container') const event = require('../event') const output = require('../output') -const webHelpers = require('../plugin/standardActingHelpers') +const webHelpers = Container.STANDARD_ACTING_HELPERS module.exports = async function (path, options) { // Backward compatibility for --profile @@ -23,15 +23,23 @@ module.exports = async function (path, options) { if (options.verbose) output.level(3) + let addGlobalRetries + + if (config.retry) { + addGlobalRetries = function retries() {} + } + output.print('Starting interactive shell for current suite...') recorder.start() event.emit(event.suite.before, { fullTitle: () => 'Interactive Shell', tests: [], + retries: addGlobalRetries, }) event.emit(event.test.before, { title: '', artifacts: {}, + retries: addGlobalRetries, }) const enabledHelpers = Container.helpers() @@ -39,7 +47,7 @@ module.exports = async function (path, options) { if (webHelpers.includes(helperName)) { const I = enabledHelpers[helperName] recorder.add(() => I.amOnPage('/')) - recorder.catchWithoutStop((e) => output.print(`Error while loading home page: ${e.message}}`)) + recorder.catchWithoutStop(e => output.print(`Error while loading home page: ${e.message}}`)) break } } diff --git a/lib/command/list.js b/lib/command/list.js index 47a1047c9..55fd48d0b 100644 --- a/lib/command/list.js +++ b/lib/command/list.js @@ -17,7 +17,7 @@ module.exports = function (path) { const actions = [] for (const name in helpers) { const helper = helpers[name] - methodsOfObject(helper).forEach((action) => { + methodsOfObject(helper).forEach(action => { const params = getParamsToString(helper[action]) actions[action] = 1 output.print(` ${output.colors.grey(name)} I.${output.colors.bold(action)}(${params})`) diff --git a/lib/command/run-multiple.js b/lib/command/run-multiple.js index 0600b4372..23b6b6982 100644 --- a/lib/command/run-multiple.js +++ b/lib/command/run-multiple.js @@ -11,20 +11,7 @@ const { getConfig, getTestRoot, fail } = require('./utils') const runner = path.join(__dirname, '/../../bin/codecept') let config const childOpts = {} -const copyOptions = [ - 'override', - 'steps', - 'reporter', - 'verbose', - 'config', - 'reporter-options', - 'grep', - 'fgrep', - 'invert', - 'debug', - 'plugins', - 'colors', -] +const copyOptions = ['override', 'steps', 'reporter', 'verbose', 'config', 'reporter-options', 'grep', 'fgrep', 'invert', 'debug', 'plugins', 'colors'] let overrides = {} // codeceptjs run-multiple smoke:chrome regression:firefox - will launch smoke run in chrome and regression in firefox @@ -49,8 +36,8 @@ module.exports = async function (selectedRuns, options) { // copy opts to run Object.keys(options) - .filter((key) => copyOptions.indexOf(key) > -1) - .forEach((key) => { + .filter(key => copyOptions.indexOf(key) > -1) + .forEach(key => { childOpts[key] = options[key] }) @@ -96,12 +83,12 @@ module.exports = async function (selectedRuns, options) { config.gherkin.features = '' } - const childProcessesPromise = new Promise((resolve) => { + const childProcessesPromise = new Promise(resolve => { processesDone = resolve }) const runsToExecute = [] - collection.createRuns(selectedRuns, config).forEach((run) => { + collection.createRuns(selectedRuns, config).forEach(run => { const runName = run.getOriginalName() || run.getName() const runConfig = run.getConfig() runsToExecute.push(executeRun(runName, runConfig)) @@ -113,7 +100,7 @@ module.exports = async function (selectedRuns, options) { // Execute all forks totalSubprocessCount = runsToExecute.length - runsToExecute.forEach((runToExecute) => runToExecute.call(this)) + runsToExecute.forEach(runToExecute => runToExecute.call(this)) return childProcessesPromise.then(async () => { // fire hook @@ -149,11 +136,7 @@ function executeRun(runName, runConfig) { // tweaking default output directories and for mochawesome overriddenConfig = replaceValueDeep(overriddenConfig, 'output', path.join(config.output, outputDir)) overriddenConfig = replaceValueDeep(overriddenConfig, 'reportDir', path.join(config.output, outputDir)) - overriddenConfig = replaceValueDeep( - overriddenConfig, - 'mochaFile', - path.join(config.output, outputDir, `${browserName}_report.xml`), - ) + overriddenConfig = replaceValueDeep(overriddenConfig, 'mochaFile', path.join(config.output, outputDir, `${browserName}_report.xml`)) // override tests configuration if (overriddenConfig.tests) { @@ -165,15 +148,9 @@ function executeRun(runName, runConfig) { } // override grep param and collect all params - const params = [ - 'run', - '--child', - `${runId++}.${runName}:${browserName}`, - '--override', - JSON.stringify(overriddenConfig), - ] - - Object.keys(childOpts).forEach((key) => { + const params = ['run', '--child', `${runId++}.${runName}:${browserName}`, '--override', JSON.stringify(overriddenConfig)] + + Object.keys(childOpts).forEach(key => { params.push(`--${key}`) if (childOpts[key] !== true) params.push(childOpts[key]) }) @@ -183,7 +160,7 @@ function executeRun(runName, runConfig) { params.push(runConfig.grep) } - const onProcessEnd = (errorCode) => { + const onProcessEnd = errorCode => { if (errorCode !== 0) { process.exitCode = errorCode } @@ -197,7 +174,7 @@ function executeRun(runName, runConfig) { // Return function of fork for later execution return () => fork(runner, params, { stdio: [0, 1, 2, 'ipc'] }) - .on('exit', (code) => { + .on('exit', code => { return onProcessEnd(code) }) .on('error', () => { diff --git a/lib/command/run-multiple/chunk.js b/lib/command/run-multiple/chunk.js index d57fcafe4..a4e3f660e 100644 --- a/lib/command/run-multiple/chunk.js +++ b/lib/command/run-multiple/chunk.js @@ -1,60 +1,60 @@ -const glob = require('glob'); -const path = require('path'); -const fs = require('fs'); +const { globSync } = require('glob') +const path = require('path') +const fs = require('fs') /** * Splits a list to (n) parts, defined via the size argument. */ const splitFiles = (list, size) => { - const sets = []; - const chunks = list.length / size; - let i = 0; + const sets = [] + const chunks = list.length / size + let i = 0 while (i < chunks) { - sets[i] = list.splice(0, size); - i++; + sets[i] = list.splice(0, size) + i++ } - return sets; -}; + return sets +} /** * Executes a glob pattern and pushes the results to a list. */ -const findFiles = (pattern) => { - const files = []; +const findFiles = pattern => { + const files = [] - glob.sync(pattern).forEach((file) => { - files.push(path.resolve(file)); - }); + globSync(pattern).forEach(file => { + files.push(path.resolve(file)) + }) - return files; -}; + return files +} /** * Joins a list of files to a valid glob pattern */ -const flattenFiles = (list) => { - const pattern = list.join(','); - return pattern.indexOf(',') > -1 ? `{${pattern}}` : pattern; -}; +const flattenFiles = list => { + const pattern = list.join(',') + return pattern.indexOf(',') > -1 ? `{${pattern}}` : pattern +} /** * Greps a file by its content, checks if Scenario or Feature text' * matches the grep text. */ const grepFile = (file, grep) => { - const contents = fs.readFileSync(file, 'utf8'); - const pattern = new RegExp(`((Scenario|Feature)\(.*${grep}.*\))`, 'g'); // <- How future proof/solid is this? - return !!pattern.exec(contents); -}; + const contents = fs.readFileSync(file, 'utf8') + const pattern = new RegExp(`((Scenario|Feature)\(.*${grep}.*\))`, 'g') // <- How future proof/solid is this? + return !!pattern.exec(contents) +} -const mapFileFormats = (files) => { +const mapFileFormats = files => { return { gherkin: files.filter(file => file.match(/\.feature$/)), js: files.filter(file => file.match(/\.t|js$/)), - }; -}; + } +} /** * Creates a list of chunks incl. configuration by either dividing a list of scenario @@ -62,30 +62,33 @@ const mapFileFormats = (files) => { * the splitting. */ const createChunks = (config, patterns = []) => { - const files = patterns.filter(pattern => !!pattern).map((pattern) => { - return findFiles(pattern).filter((file) => { - return config.grep ? grepFile(file, config.grep) : true; - }); - }).reduce((acc, val) => acc.concat(val), []); + const files = patterns + .filter(pattern => !!pattern) + .map(pattern => { + return findFiles(pattern).filter(file => { + return config.grep ? grepFile(file, config.grep) : true + }) + }) + .reduce((acc, val) => acc.concat(val), []) - let chunks = []; + let chunks = [] if (typeof config.chunks === 'function') { - chunks = config.chunks.call(this, files); + chunks = config.chunks.call(this, files) } else if (typeof config.chunks === 'number' || typeof config.chunks === 'string') { - chunks = splitFiles(files, Math.ceil(files.length / config.chunks)); + chunks = splitFiles(files, Math.ceil(files.length / config.chunks)) } else { - throw new Error('chunks is neither a finite number or a valid function'); + throw new Error('chunks is neither a finite number or a valid function') } - const chunkConfig = { ...config }; - delete chunkConfig.chunks; + const chunkConfig = { ...config } + delete chunkConfig.chunks - return chunks.map((chunkFiles) => { - const { js, gherkin } = mapFileFormats(chunkFiles); - return { ...chunkConfig, tests: flattenFiles(js), gherkin: { features: flattenFiles(gherkin) } }; - }); -}; + return chunks.map(chunkFiles => { + const { js, gherkin } = mapFileFormats(chunkFiles) + return { ...chunkConfig, tests: flattenFiles(js), gherkin: { features: flattenFiles(gherkin) } } + }) +} module.exports = { createChunks, -}; +} diff --git a/lib/command/run-workers.js b/lib/command/run-workers.js index caae6f6cd..20a26e2c8 100644 --- a/lib/command/run-workers.js +++ b/lib/command/run-workers.js @@ -8,12 +8,6 @@ const Workers = require('../workers') module.exports = async function (workerCount, selectedRuns, options) { process.env.profile = options.profile - const suiteArr = [] - const passedTestArr = [] - const failedTestArr = [] - const skippedTestArr = [] - const stepArr = [] - const { config: testConfig, override = '' } = options const overrideConfigs = tryOrDefault(() => JSON.parse(override), {}) const by = options.suites ? 'suite' : 'test' @@ -30,69 +24,24 @@ module.exports = async function (workerCount, selectedRuns, options) { output.print(`CodeceptJS v${require('../codecept').version()} ${output.standWithUkraine()}`) output.print(`Running tests in ${output.styles.bold(numberOfWorkers)} workers...`) output.print() + store.hasWorkers = true const workers = new Workers(numberOfWorkers, config) workers.overrideConfig(overrideConfigs) - workers.on(event.suite.before, (suite) => { - suiteArr.push(suite) - }) - - workers.on(event.step.passed, (step) => { - stepArr.push(step) - }) - - workers.on(event.step.failed, (step) => { - stepArr.push(step) - }) - - workers.on(event.test.failed, (test) => { - failedTestArr.push(test) + workers.on(event.test.failed, test => { output.test.failed(test) }) - workers.on(event.test.passed, (test) => { - passedTestArr.push(test) + workers.on(event.test.passed, test => { output.test.passed(test) }) - workers.on(event.test.skipped, (test) => { - skippedTestArr.push(test) + workers.on(event.test.skipped, test => { output.test.skipped(test) }) - workers.on(event.all.result, () => { - // expose test stats after all workers finished their execution - function addStepsToTest(test, stepArr) { - stepArr.test.steps.forEach((step) => { - if (test.steps.length === 0) { - test.steps.push(step) - } - }) - } - - stepArr.forEach((step) => { - passedTestArr.forEach((test) => { - if (step.test.title === test.title) { - addStepsToTest(test, step) - } - }) - - failedTestArr.forEach((test) => { - if (step.test.title === test.title) { - addStepsToTest(test, step) - } - }) - }) - - event.dispatcher.emit(event.workers.result, { - suites: suiteArr, - tests: { - passed: passedTestArr, - failed: failedTestArr, - skipped: skippedTestArr, - }, - }) + workers.on(event.all.result, result => { workers.printResults() }) @@ -100,7 +49,6 @@ module.exports = async function (workerCount, selectedRuns, options) { if (options.verbose || options.debug) store.debugMode = true if (options.verbose) { - global.debugMode = true const { getMachineInfo } = require('./info') await getMachineInfo() } diff --git a/lib/command/utils.js b/lib/command/utils.js index cb5620b79..1fb1b9600 100644 --- a/lib/command/utils.js +++ b/lib/command/utils.js @@ -29,8 +29,7 @@ module.exports.readConfig = function (configFile) { function getTestRoot(currentPath) { if (!currentPath) currentPath = '.' if (!path.isAbsolute(currentPath)) currentPath = path.join(process.cwd(), currentPath) - currentPath = - fs.lstatSync(currentPath).isDirectory() || !path.extname(currentPath) ? currentPath : path.dirname(currentPath) + currentPath = fs.lstatSync(currentPath).isDirectory() || !path.extname(currentPath) ? currentPath : path.dirname(currentPath) return currentPath } module.exports.getTestRoot = getTestRoot @@ -71,7 +70,7 @@ function safeFileWrite(file, contents) { module.exports.safeFileWrite = safeFileWrite -module.exports.captureStream = (stream) => { +module.exports.captureStream = stream => { let oldStream let buffer = '' @@ -79,7 +78,7 @@ module.exports.captureStream = (stream) => { startCapture() { buffer = '' oldStream = stream.write.bind(stream) - stream.write = (chunk) => (buffer += chunk) + stream.write = chunk => (buffer += chunk) }, stopCapture() { if (oldStream !== undefined) stream.write = oldStream @@ -88,7 +87,7 @@ module.exports.captureStream = (stream) => { } } -module.exports.printError = (err) => { +module.exports.printError = err => { output.print('') output.error(err.message) output.print('') @@ -106,7 +105,7 @@ module.exports.createOutputDir = (config, testRoot) => { } } -module.exports.findConfigFile = (testsPath) => { +module.exports.findConfigFile = testsPath => { const extensions = ['js', 'ts'] for (const ext of extensions) { const configFile = path.join(testsPath, `codecept.conf.${ext}`) diff --git a/lib/command/workers/runTests.js b/lib/command/workers/runTests.js index 0ab4af468..d6222575a 100644 --- a/lib/command/workers/runTests.js +++ b/lib/command/workers/runTests.js @@ -1,291 +1,127 @@ -const tty = require('tty'); +const tty = require('tty') if (!tty.getWindowSize) { // this is really old method, long removed from Node, but Mocha // reporters fall back on it if they cannot use `process.stdout.getWindowSize` // we need to polyfill it. - tty.getWindowSize = () => [40, 80]; + tty.getWindowSize = () => [40, 80] } -const { parentPort, workerData } = require('worker_threads'); -const event = require('../../event'); -const container = require('../../container'); -const { getConfig } = require('../utils'); -const { tryOrDefault, deepMerge } = require('../../utils'); +const { parentPort, workerData } = require('worker_threads') +const event = require('../../event') +const container = require('../../container') +const { getConfig } = require('../utils') +const { tryOrDefault, deepMerge } = require('../../utils') -let stdout = ''; +let stdout = '' -const stderr = ''; +const stderr = '' // Requiring of Codecept need to be after tty.getWindowSize is available. -const Codecept = require(process.env.CODECEPT_CLASS_PATH || '../../codecept'); +const Codecept = require(process.env.CODECEPT_CLASS_PATH || '../../codecept') -const { - options, tests, testRoot, workerIndex, -} = workerData; +const { options, tests, testRoot, workerIndex } = workerData // hide worker output -if (!options.debug && !options.verbose) process.stdout.write = (string) => { stdout += string; return true; }; +if (!options.debug && !options.verbose) + process.stdout.write = string => { + stdout += string + return true + } -const overrideConfigs = tryOrDefault(() => JSON.parse(options.override), {}); +const overrideConfigs = tryOrDefault(() => JSON.parse(options.override), {}) // important deep merge so dynamic things e.g. functions on config are not overridden -const config = deepMerge(getConfig(options.config || testRoot), overrideConfigs); +const config = deepMerge(getConfig(options.config || testRoot), overrideConfigs) // Load test and run -const codecept = new Codecept(config, options); -codecept.init(testRoot); -codecept.loadTests(); -const mocha = container.mocha(); -filterTests(); - -(async function () { +const codecept = new Codecept(config, options) +codecept.init(testRoot) +codecept.loadTests() +const mocha = container.mocha() +filterTests() + +// run tests +;(async function () { if (mocha.suite.total()) { - await runTests(); + await runTests() } -}()); +})() async function runTests() { try { - await codecept.bootstrap(); + await codecept.bootstrap() } catch (err) { - throw new Error(`Error while running bootstrap file :${err}`); + throw new Error(`Error while running bootstrap file :${err}`) } - listenToParentThread(); - initializeListeners(); - disablePause(); + listenToParentThread() + initializeListeners() + disablePause() try { - await codecept.run(); + await codecept.run() } finally { - await codecept.teardown(); + await codecept.teardown() } } function filterTests() { - const files = codecept.testFiles; - mocha.files = files; - mocha.loadFiles(); + const files = codecept.testFiles + mocha.files = files + mocha.loadFiles() for (const suite of mocha.suite.suites) { - suite.tests = suite.tests.filter(test => tests.indexOf(test.uid) >= 0); + suite.tests = suite.tests.filter(test => tests.indexOf(test.uid) >= 0) } } function initializeListeners() { - function simplifyError(error) { - if (error) { - const { - stack, - uncaught, - message, - actual, - expected, - } = error; - - return { - stack, - uncaught, - message, - actual, - expected, - }; - } - - return null; - } - function simplifyTest(test, err = null) { - test = { ...test }; - - if (test.start && !test.duration) { - const end = new Date(); - test.duration = end - test.start; - } - - if (test.err) { - err = simplifyError(test.err); - test.status = 'failed'; - } else if (err) { - err = simplifyError(err); - test.status = 'failed'; - } - const parent = {}; - if (test.parent) { - parent.title = test.parent.title; - } - - if (test.opts) { - Object.keys(test.opts).forEach(k => { - if (typeof test.opts[k] === 'object') delete test.opts[k]; - if (typeof test.opts[k] === 'function') delete test.opts[k]; - }); - } - - return { - opts: test.opts || {}, - tags: test.tags || [], - uid: test.uid, - workerIndex, - retries: test._retries, - title: test.title, - status: test.status, - duration: test.duration || 0, - err, - parent, - steps: test.steps && test.steps.length > 0 ? simplifyStepsInTestObject(test.steps, err) : [], - }; - } - - function simplifyStepsInTestObject(steps, err) { - steps = [...steps]; - const _steps = []; - - for (step of steps) { - const _args = []; - - if (step.args) { - for (const arg of step.args) { - // check if arg is a JOI object - if (arg && arg.$_root) { - _args.push(JSON.stringify(arg).slice(0, 300)); - // check if arg is a function - } else if (arg && typeof arg === 'function') { - _args.push(arg.name); - } else { - _args.push(arg); - } - } - } - - _steps.push({ - actor: step.actor, - name: step.name, - status: step.status, - args: JSON.stringify(_args), - startedAt: step.startedAt, - startTime: step.startTime, - endTime: step.endTime, - finishedAt: step.finishedAt, - duration: step.duration, - err, - }); - } - - return _steps; - } - - function simplifyStep(step, err = null) { - step = { ...step }; - - if (step.startTime && !step.duration) { - const end = new Date(); - step.duration = end - step.startTime; - } - - if (step.err) { - err = simplifyError(step.err); - step.status = 'failed'; - } else if (err) { - err = simplifyError(err); - step.status = 'failed'; - } - - const parent = {}; - if (step.metaStep) { - parent.title = step.metaStep.actor; - } - - if (step.opts) { - Object.keys(step.opts).forEach(k => { - if (typeof step.opts[k] === 'object') delete step.opts[k]; - if (typeof step.opts[k] === 'function') delete step.opts[k]; - }); - } - - return { - opts: step.opts || {}, - workerIndex, - title: step.name, - status: step.status, - duration: step.duration || 0, - err, - parent, - test: simplifyTest(step.test), - }; - } - - collectStats(); // suite - event.dispatcher.on(event.suite.before, suite => sendToParentThread({ event: event.suite.before, workerIndex, data: simplifyTest(suite) })); - event.dispatcher.on(event.suite.after, suite => sendToParentThread({ event: event.suite.after, workerIndex, data: simplifyTest(suite) })); + event.dispatcher.on(event.suite.before, suite => sendToParentThread({ event: event.suite.before, workerIndex, data: suite.simplify() })) + event.dispatcher.on(event.suite.after, suite => sendToParentThread({ event: event.suite.after, workerIndex, data: suite.simplify() })) // calculate duration - event.dispatcher.on(event.test.started, test => test.start = new Date()); + event.dispatcher.on(event.test.started, test => (test.start = new Date())) // tests - event.dispatcher.on(event.test.before, test => sendToParentThread({ event: event.test.before, workerIndex, data: simplifyTest(test) })); - event.dispatcher.on(event.test.after, test => sendToParentThread({ event: event.test.after, workerIndex, data: simplifyTest(test) })); + event.dispatcher.on(event.test.before, test => sendToParentThread({ event: event.test.before, workerIndex, data: test.simplify() })) + event.dispatcher.on(event.test.after, test => sendToParentThread({ event: event.test.after, workerIndex, data: test.simplify() })) // we should force-send correct errors to prevent race condition - event.dispatcher.on(event.test.finished, (test, err) => sendToParentThread({ event: event.test.finished, workerIndex, data: simplifyTest(test, err) })); - event.dispatcher.on(event.test.failed, (test, err) => sendToParentThread({ event: event.test.failed, workerIndex, data: simplifyTest(test, err) })); - event.dispatcher.on(event.test.passed, (test, err) => sendToParentThread({ event: event.test.passed, workerIndex, data: simplifyTest(test, err) })); - event.dispatcher.on(event.test.started, test => sendToParentThread({ event: event.test.started, workerIndex, data: simplifyTest(test) })); - event.dispatcher.on(event.test.skipped, test => sendToParentThread({ event: event.test.skipped, workerIndex, data: simplifyTest(test) })); + event.dispatcher.on(event.test.finished, (test, err) => sendToParentThread({ event: event.test.finished, workerIndex, data: { ...test.simplify(), err } })) + event.dispatcher.on(event.test.failed, (test, err) => sendToParentThread({ event: event.test.failed, workerIndex, data: { ...test.simplify(), err } })) + event.dispatcher.on(event.test.passed, (test, err) => sendToParentThread({ event: event.test.passed, workerIndex, data: { ...test.simplify(), err } })) + event.dispatcher.on(event.test.started, test => sendToParentThread({ event: event.test.started, workerIndex, data: test.simplify() })) + event.dispatcher.on(event.test.skipped, test => sendToParentThread({ event: event.test.skipped, workerIndex, data: test.simplify() })) // steps - event.dispatcher.on(event.step.finished, step => sendToParentThread({ event: event.step.finished, workerIndex, data: simplifyStep(step) })); - event.dispatcher.on(event.step.started, step => sendToParentThread({ event: event.step.started, workerIndex, data: simplifyStep(step) })); - event.dispatcher.on(event.step.passed, step => sendToParentThread({ event: event.step.passed, workerIndex, data: simplifyStep(step) })); - event.dispatcher.on(event.step.failed, step => sendToParentThread({ event: event.step.failed, workerIndex, data: simplifyStep(step) })); + event.dispatcher.on(event.step.finished, step => sendToParentThread({ event: event.step.finished, workerIndex, data: step.simplify() })) + event.dispatcher.on(event.step.started, step => sendToParentThread({ event: event.step.started, workerIndex, data: step.simplify() })) + event.dispatcher.on(event.step.passed, step => sendToParentThread({ event: event.step.passed, workerIndex, data: step.simplify() })) + event.dispatcher.on(event.step.failed, step => sendToParentThread({ event: event.step.failed, workerIndex, data: step.simplify() })) - event.dispatcher.on(event.hook.failed, (test, err) => sendToParentThread({ event: event.hook.failed, workerIndex, data: simplifyTest(test, err) })); - event.dispatcher.on(event.hook.passed, (test, err) => sendToParentThread({ event: event.hook.passed, workerIndex, data: simplifyTest(test, err) })); - event.dispatcher.on(event.all.failures, (data) => sendToParentThread({ event: event.all.failures, workerIndex, data })); + event.dispatcher.on(event.hook.failed, (hook, err) => sendToParentThread({ event: event.hook.failed, workerIndex, data: { ...hook.simplify(), err } })) + event.dispatcher.on(event.hook.passed, hook => sendToParentThread({ event: event.hook.passed, workerIndex, data: hook.simplify() })) + event.dispatcher.on(event.hook.finished, hook => sendToParentThread({ event: event.hook.finished, workerIndex, data: hook.simplify() })) + event.dispatcher.once(event.all.after, () => { + sendToParentThread({ event: event.all.after, workerIndex, data: container.result().simplify() }) + }) // all - event.dispatcher.once(event.all.result, () => parentPort.close()); + event.dispatcher.once(event.all.result, () => { + sendToParentThread({ event: event.all.result, workerIndex, data: container.result().simplify() }) + parentPort?.close() + }) } function disablePause() { - global.pause = () => {}; -} - -function collectStats() { - const stats = { - passes: 0, - failures: 0, - skipped: 0, - tests: 0, - pending: 0, - }; - event.dispatcher.on(event.test.skipped, () => { - stats.skipped++; - }); - event.dispatcher.on(event.test.passed, () => { - stats.passes++; - }); - event.dispatcher.on(event.test.failed, (test) => { - if (test.ctx._runnable.title.includes('hook: AfterSuite')) { - stats.failedHooks += 1; - } - stats.failures++; - }); - event.dispatcher.on(event.test.skipped, () => { - stats.pending++; - }); - event.dispatcher.on(event.test.finished, () => { - stats.tests++; - }); - event.dispatcher.once(event.all.after, () => { - sendToParentThread({ event: event.all.after, data: stats }); - }); + global.pause = () => {} } function sendToParentThread(data) { - parentPort.postMessage(data); + parentPort?.postMessage(data) } function listenToParentThread() { - parentPort.on('message', (eventData) => { - container.append({ support: eventData.data }); - }); + parentPort?.on('message', eventData => { + container.append({ support: eventData.data }) + }) } diff --git a/lib/container.js b/lib/container.js index 2307b94e8..68b26ecce 100644 --- a/lib/container.js +++ b/lib/container.js @@ -1,31 +1,46 @@ -const glob = require('glob'); -const path = require('path'); -const { MetaStep } = require('./step'); -const { fileExists, isFunction, isAsyncFunction } = require('./utils'); -const Translation = require('./translation'); -const MochaFactory = require('./mochaFactory'); -const recorder = require('./recorder'); -const event = require('./event'); -const WorkerStorage = require('./workerStorage'); -const store = require('./store'); -const ai = require('./ai'); +const { globSync } = require('glob') +const path = require('path') +const debug = require('debug')('codeceptjs:container') +const { MetaStep } = require('./step') +const { methodsOfObject, fileExists, isFunction, isAsyncFunction, installedLocally } = require('./utils') +const Translation = require('./translation') +const MochaFactory = require('./mocha/factory') +const recorder = require('./recorder') +const event = require('./event') +const WorkerStorage = require('./workerStorage') +const store = require('./store') +const Result = require('./result') +const ai = require('./ai') + +let asyncHelperPromise let container = { helpers: {}, support: {}, + proxySupport: {}, plugins: {}, + actor: null, /** * @type {Mocha | {}} * @ignore */ mocha: {}, translation: {}, -}; + /** @type {Result | null} */ + result: null, +} /** * Dependency Injection Container */ class Container { + /** + * Get the standard acting helpers of CodeceptJS Container + * + */ + static get STANDARD_ACTING_HELPERS() { + return ['Playwright', 'WebDriver', 'Puppeteer', 'Appium', 'TestCafe'] + } /** * Create container with all required helpers and support objects * @@ -34,21 +49,32 @@ class Container { * @param {*} opts */ static create(config, opts) { - const mochaConfig = config.mocha || {}; - if (config.grep && !opts.grep) { - mochaConfig.grep = config.grep; - } - this.createMocha = () => { - container.mocha = MochaFactory.create(mochaConfig, opts || {}); - }; - this.createMocha(); - container.helpers = createHelpers(config.helpers || {}); - container.translation = loadTranslation(config.translation || null, config.vocabularies || []); - container.support = createSupportObjects(config.include || {}); - container.plugins = createPlugins(config.plugins || {}, opts); - if (opts && opts.ai) ai.enable(config.ai); // enable AI Assistant - if (config.gherkin) loadGherkinSteps(config.gherkin.steps || []); - if (opts && typeof opts.timeouts === 'boolean') store.timeouts = opts.timeouts; + debug('creating container') + asyncHelperPromise = Promise.resolve() + + // dynamically create mocha instance + const mochaConfig = config.mocha || {} + if (config.grep && !opts.grep) mochaConfig.grep = config.grep + this.createMocha = () => (container.mocha = MochaFactory.create(mochaConfig, opts || {})) + this.createMocha() + + // create support objects + container.support = {} + container.helpers = createHelpers(config.helpers || {}) + container.translation = loadTranslation(config.translation || null, config.vocabularies || []) + container.proxySupport = createSupportObjects(config.include || {}) + container.plugins = createPlugins(config.plugins || {}, opts) + container.result = new Result() + + createActor(config.include?.I) + + if (opts && opts.ai) ai.enable(config.ai) // enable AI Assistant + if (config.gherkin) loadGherkinSteps(config.gherkin.steps || []) + if (opts && typeof opts.timeouts === 'boolean') store.timeouts = opts.timeouts + } + + static actor() { + return container.support.I } /** @@ -60,9 +86,9 @@ class Container { */ static plugins(name) { if (!name) { - return container.plugins; + return container.plugins } - return container.plugins[name]; + return container.plugins[name] } /** @@ -74,9 +100,9 @@ class Container { */ static support(name) { if (!name) { - return container.support; + return container.proxySupport } - return container.support[name]; + return container.support[name] || container.proxySupport[name] } /** @@ -88,9 +114,9 @@ class Container { */ static helpers(name) { if (!name) { - return container.helpers; + return container.helpers } - return container.helpers[name]; + return container.helpers[name] } /** @@ -99,7 +125,7 @@ class Container { * @api */ static translation() { - return container.translation; + return container.translation } /** @@ -109,7 +135,19 @@ class Container { * @returns { * } */ static mocha() { - return container.mocha; + return container.mocha + } + + /** + * Get result + * + * @returns {Result} + */ + static result() { + if (!container.result) { + container.result = new Result() + } + return container.result } /** @@ -119,8 +157,9 @@ class Container { * @param {Object} newContainer */ static append(newContainer) { - const deepMerge = require('./utils').deepMerge; - container = deepMerge(container, newContainer); + const deepMerge = require('./utils').deepMerge + container = deepMerge(container, newContainer) + debug('appended', JSON.stringify(newContainer).slice(0, 300)) } /** @@ -130,11 +169,25 @@ class Container { * @param {Object} newSupport * @param {Object} newPlugins */ - static clear(newHelpers, newSupport, newPlugins) { - container.helpers = newHelpers || {}; - container.support = newSupport || {}; - container.plugins = newPlugins || {}; - container.translation = loadTranslation(); + static clear(newHelpers = {}, newSupport = {}, newPlugins = {}) { + container.helpers = newHelpers + container.translation = loadTranslation() + container.proxySupport = createSupportObjects(newSupport) + container.plugins = newPlugins + asyncHelperPromise = Promise.resolve() + store.actor = null + debug('container cleared') + } + + /** + * @param {Function|null} fn + * @returns {Promise} + */ + static async started(fn = null) { + if (fn) { + asyncHelperPromise = asyncHelperPromise.then(fn) + } + return asyncHelperPromise } /** @@ -144,299 +197,381 @@ class Container { * @param {Object} options - set {local: true} to not share among workers */ static share(data, options = {}) { - Container.append({ support: data }); + Container.append({ support: data }) if (!options.local) { - WorkerStorage.share(data); + WorkerStorage.share(data) } } + + static createMocha(config = {}, opts = {}) { + const mochaConfig = config?.mocha || {} + if (config?.grep && !opts?.grep) { + mochaConfig.grep = config.grep + } + container.mocha = MochaFactory.create(mochaConfig, opts || {}) + } } -module.exports = Container; +module.exports = Container function createHelpers(config) { - const helpers = {}; - let moduleName; - for (const helperName in config) { + const helpers = {} + for (let helperName in config) { try { - if (config[helperName].require) { - if (config[helperName].require.startsWith('.')) { - moduleName = path.resolve(global.codecept_dir, config[helperName].require); // custom helper - } else { - moduleName = config[helperName].require; // plugin helper - } - } else { - moduleName = `./helper/${helperName}`; // built-in helper + let HelperClass + + // ESM import + if (helperName?.constructor === Function && helperName.prototype) { + HelperClass = helperName + helperName = HelperClass.constructor.name } - // @ts-ignore - let HelperClass; - // check if the helper is the built-in, use the require() syntax. - if (moduleName.startsWith('./helper/')) { - HelperClass = require(moduleName); - } else { - // check if the new syntax export default HelperName is used and loads the Helper, otherwise loads the module that used old syntax export = HelperName. - HelperClass = require(moduleName).default || require(moduleName); + // classical require + if (!HelperClass) { + HelperClass = requireHelperFromModule(helperName, config) } - if (HelperClass._checkRequirements) { - const requirements = HelperClass._checkRequirements(); - if (requirements) { - let install; - if (require('./utils').installedLocally()) { - install = `npm install --save-dev ${requirements.join(' ')}`; - } else { - console.log('WARNING: CodeceptJS is not installed locally. It is recommended to switch to local installation'); - install = `[sudo] npm install -g ${requirements.join(' ')}`; - } - throw new Error(`Required modules are not installed.\n\nRUN: ${install}`); - } + // handle async CJS modules that use dynamic import + if (isAsyncFunction(HelperClass)) { + helpers[helperName] = {} + + asyncHelperPromise = asyncHelperPromise + .then(() => HelperClass()) + .then(ResolvedHelperClass => { + // Check if ResolvedHelperClass is a constructor function + if (typeof ResolvedHelperClass?.constructor !== 'function') { + throw new Error(`Helper class from module '${helperName}' is not a class. Use CJS async module syntax.`) + } + + debug(`helper ${helperName} async initialized`) + + helpers[helperName] = new ResolvedHelperClass(config[helperName]) + }) + + continue } - helpers[helperName] = new HelperClass(config[helperName]); + + checkHelperRequirements(HelperClass) + + helpers[helperName] = new HelperClass(config[helperName]) + debug(`helper ${helperName} initialized`) } catch (err) { - throw new Error(`Could not load helper ${helperName} from module '${moduleName}':\n${err.message}\n${err.stack}`); + throw new Error(`Could not load helper ${helperName} (${err.message})`) } } for (const name in helpers) { - if (helpers[name]._init) helpers[name]._init(); + if (helpers[name]._init) helpers[name]._init() } - return helpers; + return helpers } -function createSupportObjects(config) { - const objects = {}; - - for (const name in config) { - objects[name] = {}; // placeholders - } - - if (!config.I) { - objects.I = require('./actor')(); - - if (container.translation.I !== 'I') { - objects[container.translation.I] = objects.I; +function checkHelperRequirements(HelperClass) { + if (HelperClass._checkRequirements) { + const requirements = HelperClass._checkRequirements() + if (requirements) { + let install + if (installedLocally()) { + install = `npm install --save-dev ${requirements.join(' ')}` + } else { + console.log('WARNING: CodeceptJS is not installed locally. It is recommended to switch to local installation') + install = `[sudo] npm install -g ${requirements.join(' ')}` + } + throw new Error(`Required modules are not installed.\n\nRUN: ${install}`) } } +} - container.support = objects; - - function lazyLoad(name) { - let newObj = getSupportObject(config, name); +function requireHelperFromModule(helperName, config, HelperClass) { + const moduleName = getHelperModuleName(helperName, config) + if (moduleName.startsWith('./helper/')) { + HelperClass = require(moduleName) + } else { + // check if the new syntax export default HelperName is used and loads the Helper, otherwise loads the module that used old syntax export = HelperName. try { - if (typeof newObj === 'function') { - newObj = newObj(); - } else if (newObj._init) { - newObj._init(); + const mod = require(moduleName) + if (!mod && !mod.default) { + throw new Error(`Helper module '${moduleName}' was not found. Make sure you have installed the package correctly.`) } + HelperClass = mod.default || mod } catch (err) { - throw new Error(`Initialization failed for ${name}: ${newObj}\n${err.message}\n${err.stack}`); + if (err.code === 'MODULE_NOT_FOUND') { + throw new Error(`Helper module '${moduleName}' was not found. Make sure you have installed the package correctly.`) + } + throw err } - return newObj; } + return HelperClass +} +function createSupportObjects(config) { const asyncWrapper = function (f) { return function () { - return f.apply(this, arguments).catch((e) => { - recorder.saveFirstAsyncError(e); - throw e; - }); - }; - }; - - Object.keys(objects).forEach((object) => { - const currentObject = objects[object]; - Object.keys(currentObject).forEach((method) => { - const currentMethod = currentObject[method]; - if (currentMethod && currentMethod[Symbol.toStringTag] === 'AsyncFunction') { - objects[object][method] = asyncWrapper(currentMethod); - } - }); - }); + return f.apply(this, arguments).catch(e => { + recorder.saveFirstAsyncError(e) + throw e + }) + } + } - return new Proxy({}, { - has(target, key) { - return key in config; - }, - ownKeys() { - return Reflect.ownKeys(config); - }, - get(target, key) { - // configured but not in support object, yet: load the module - if (key in objects && !(key in target)) { - // load default I - if (key in objects && !(key in config)) { - return target[key] = objects[key]; - } + function lazyLoad(name) { + return new Proxy( + {}, + { + get(target, prop) { + // behavr like array or + if (prop === 'length') return Object.keys(config).length + if (prop === Symbol.iterator) { + return function* () { + for (let i = 0; i < Object.keys(config).length; i++) { + yield target[i] + } + } + } - // load new object - const object = lazyLoad(key); - // check that object is a real object and not an array - if (Object.prototype.toString.call(object) === '[object Object]') { - return target[key] = Object.assign(objects[key], object); + // load actual name from vocabulary + if (container.translation.name) { + name = container.translation.name + } + + if (name === 'I') { + const actor = createActor(config.I) + methodsOfObject(actor) + return actor[prop] + } + + if (!container.support[name] && typeof config[name] === 'object') { + container.support[name] = config[name] + } + + if (!container.support[name]) { + // Load object on first access + const supportObject = loadSupportObject(config[name]) + container.support[name] = supportObject + try { + if (container.support[name]._init) { + container.support[name]._init() + } + debug(`support object ${name} initialized`) + } catch (err) { + throw new Error(`Initialization failed for ${name}: ${container.support[name]}\n${err.message}\n${err.stack}`) + } + } + + const currentObject = container.support[name] + let currentValue = currentObject[prop] + + if (isFunction(currentValue) || isAsyncFunction(currentValue)) { + const ms = new MetaStep(name, prop) + ms.setContext(currentObject) + if (isAsyncFunction(currentValue)) currentValue = asyncWrapper(currentValue) + debug(`metastep is created for ${name}.${prop.toString()}()`) + return ms.run.bind(ms, currentValue) + } + + return currentValue + }, + has(target, prop) { + container.support[name] = container.support[name] || loadSupportObject(config[name]) + return prop in container.support[name] + }, + getOwnPropertyDescriptor(target, prop) { + container.support[name] = container.support[name] || loadSupportObject(config[name]) + return { + enumerable: true, + configurable: true, + value: this.get(target, prop), + } + }, + ownKeys() { + container.support[name] = container.support[name] || loadSupportObject(config[name]) + return Reflect.ownKeys(container.support[name]) + }, + }, + ) + } + + const keys = Reflect.ownKeys(config) + return new Proxy( + {}, + { + has(target, key) { + return keys.includes(key) + }, + ownKeys() { + return keys + }, + getOwnPropertyDescriptor(target, prop) { + return { + enumerable: true, + configurable: true, + value: this.get(target, prop), } - target[key] = object; - } - return target[key]; + }, + get(target, key) { + return lazyLoad(key) + }, }, - }); + ) +} + +function createActor(actorPath) { + if (container.support.I) return container.support.I + + if (actorPath) { + container.support.I = loadSupportObject(actorPath) + } else { + const actor = require('./actor') + container.support.I = actor() + } + + return container.support.I } function createPlugins(config, options = {}) { - const plugins = {}; + const plugins = {} - const enabledPluginsByOptions = (options.plugins || '').split(','); + const enabledPluginsByOptions = (options.plugins || '').split(',') for (const pluginName in config) { - if (!config[pluginName]) config[pluginName] = {}; - if (!config[pluginName].enabled && (enabledPluginsByOptions.indexOf(pluginName) < 0)) { - continue; // plugin is disabled + if (!config[pluginName]) config[pluginName] = {} + if (!config[pluginName].enabled && enabledPluginsByOptions.indexOf(pluginName) < 0) { + continue // plugin is disabled } - let module; + let module try { if (config[pluginName].require) { - module = config[pluginName].require; - if (module.startsWith('.')) { // local - module = path.resolve(global.codecept_dir, module); // custom plugin + module = config[pluginName].require + if (module.startsWith('.')) { + // local + module = path.resolve(global.codecept_dir, module) // custom plugin } } else { - module = `./plugin/${pluginName}`; + module = `./plugin/${pluginName}` } - plugins[pluginName] = require(module)(config[pluginName]); + plugins[pluginName] = require(module)(config[pluginName]) } catch (err) { - throw new Error(`Could not load plugin ${pluginName} from module '${module}':\n${err.message}\n${err.stack}`); + throw new Error(`Could not load plugin ${pluginName} from module '${module}':\n${err.message}\n${err.stack}`) } } - return plugins; -} - -function getSupportObject(config, name) { - const module = config[name]; - if (typeof module === 'string') { - return loadSupportObject(module, name); - } - return module; + return plugins } function loadGherkinSteps(paths) { - global.Before = fn => event.dispatcher.on(event.test.started, fn); - global.After = fn => event.dispatcher.on(event.test.finished, fn); - global.Fail = fn => event.dispatcher.on(event.test.failed, fn); + global.Before = fn => event.dispatcher.on(event.test.started, fn) + global.After = fn => event.dispatcher.on(event.test.finished, fn) + global.Fail = fn => event.dispatcher.on(event.test.failed, fn) // If gherkin.steps is string, then this will iterate through that folder and send all step def js files to loadSupportObject // If gherkin.steps is Array, it will go the old way // This is done so that we need not enter all Step Definition files under config.gherkin.steps if (Array.isArray(paths)) { for (const path of paths) { - loadSupportObject(path, `Step Definition from ${path}`); + loadSupportObject(path, `Step Definition from ${path}`) } } else { - const folderPath = paths.startsWith('.') ? path.join(global.codecept_dir, paths) : ''; + const folderPath = paths.startsWith('.') ? normalizeAndJoin(global.codecept_dir, paths) : '' if (folderPath !== '') { - glob.sync(folderPath).forEach((file) => { - loadSupportObject(file, `Step Definition from ${file}`); - }); + globSync(folderPath).forEach(file => { + loadSupportObject(file, `Step Definition from ${file}`) + }) } } - delete global.Before; - delete global.After; - delete global.Fail; + delete global.Before + delete global.After + delete global.Fail } function loadSupportObject(modulePath, supportObjectName) { + if (!modulePath) { + throw new Error(`Support object "${supportObjectName}" is not defined`) + } if (modulePath.charAt(0) === '.') { - modulePath = path.join(global.codecept_dir, modulePath); + modulePath = path.join(global.codecept_dir, modulePath) } try { - const obj = require(modulePath); + const obj = require(modulePath) + // Handle different types of imports if (typeof obj === 'function') { - const fobj = obj(); - - if (fobj.constructor.name === 'Actor') { - const methods = getObjectMethods(fobj); - Object.keys(methods) - .forEach(key => { - fobj[key] = methods[key]; - }); - - return methods; + // If it's a class (constructor function) + if (obj.prototype && obj.prototype.constructor === obj) { + const ClassName = obj + return new ClassName() } + // If it's a regular function + return obj() } - if (typeof obj !== 'function' - && Object.getPrototypeOf(obj) !== Object.prototype - && !Array.isArray(obj) - ) { - const methods = getObjectMethods(obj); - Object.keys(methods) - .filter(key => !key.startsWith('_')) - .forEach(key => { - const currentMethod = methods[key]; - if (isFunction(currentMethod) || isAsyncFunction(currentMethod)) { - const ms = new MetaStep(supportObjectName, key); - ms.setContext(methods); - methods[key] = ms.run.bind(ms, currentMethod); - } - }); - return methods; + + if (obj && Array.isArray(obj)) { + return obj } - if (!Array.isArray(obj)) { - Object.keys(obj) - .filter(key => !key.startsWith('_')) - .forEach(key => { - const currentMethod = obj[key]; - if (isFunction(currentMethod) || isAsyncFunction(currentMethod)) { - const ms = new MetaStep(supportObjectName, key); - ms.setContext(obj); - obj[key] = ms.run.bind(ms, currentMethod); - } - }); + + // If it's a plain object + if (obj && typeof obj === 'object') { + return obj } - return obj; + throw new Error(`Support object "${supportObjectName}" should be an object, class, or function, but got ${typeof obj}`) } catch (err) { - throw new Error(`Could not include object ${supportObjectName} from module '${modulePath}'\n${err.message}\n${err.stack}`); + throw new Error(`Could not include object ${supportObjectName} from module '${modulePath}'\n${err.message}\n${err.stack}`) } } /** * Method collect own property and prototype */ -function getObjectMethods(obj) { - const methodsSet = new Set(); - let protoObj = Reflect.getPrototypeOf(obj); - do { - if (protoObj.constructor.prototype !== Object.prototype) { - const keys = Reflect.ownKeys(protoObj); - keys.forEach(k => methodsSet.add(k)); - } - } while (protoObj = Reflect.getPrototypeOf(protoObj)); - Reflect.ownKeys(obj).forEach(k => methodsSet.add(k)); - const methods = {}; - for (const key of methodsSet.keys()) { - if (key !== 'constructor') methods[key] = obj[key]; - } - return methods; -} function loadTranslation(locale, vocabularies) { if (!locale) { - return Translation.createEmpty(); + return Translation.createEmpty() } - let translation; + let translation // check if it is a known translation if (Translation.langs[locale]) { - translation = new Translation(Translation.langs[locale]); + translation = new Translation(Translation.langs[locale]) } else if (fileExists(path.join(global.codecept_dir, locale))) { // get from a provided file instead - translation = Translation.createDefault(); - translation.loadVocabulary(locale); + translation = Translation.createDefault() + translation.loadVocabulary(locale) } else { - translation = Translation.createDefault(); + translation = Translation.createDefault() + } + + vocabularies.forEach(v => translation.loadVocabulary(v)) + + return translation +} + +function getHelperModuleName(helperName, config) { + // classical require + if (config[helperName].require) { + if (config[helperName].require.startsWith('.')) { + return path.resolve(global.codecept_dir, config[helperName].require) // custom helper + } + return config[helperName].require // plugin helper + } + + // built-in helpers + if (helperName.startsWith('@codeceptjs/')) { + return helperName } - vocabularies.forEach(v => translation.loadVocabulary(v)); + // built-in helpers + return `./helper/${helperName}` +} +function normalizeAndJoin(basePath, subPath) { + // Normalize and convert slashes to forward slashes in one step + const normalizedBase = path.posix.normalize(basePath.replace(/\\/g, '/')) + const normalizedSub = path.posix.normalize(subPath.replace(/\\/g, '/')) + + // If subPath is absolute (starts with "/"), return it as the final path + if (normalizedSub.startsWith('/')) { + return normalizedSub + } - return translation; + // Join the paths using POSIX-style + return path.posix.join(normalizedBase, normalizedSub) } diff --git a/lib/data/context.js b/lib/data/context.js index 82f3897f8..01adc2456 100644 --- a/lib/data/context.js +++ b/lib/data/context.js @@ -13,8 +13,8 @@ module.exports = function (context) { fn = opts opts = {} } - opts.data = data.map((dataRow) => dataRow.data) - data.forEach((dataRow) => { + opts.data = data.map(dataRow => dataRow.data) + data.forEach(dataRow => { const dataTitle = replaceTitle(title, dataRow) if (dataRow.skip) { context.xScenario(dataTitle) @@ -32,8 +32,8 @@ module.exports = function (context) { fn = opts opts = {} } - opts.data = data.map((dataRow) => dataRow.data) - data.forEach((dataRow) => { + opts.data = data.map(dataRow => dataRow.data) + data.forEach(dataRow => { const dataTitle = replaceTitle(title, dataRow) if (dataRow.skip) { context.xScenario(dataTitle) @@ -51,8 +51,8 @@ module.exports = function (context) { context.xData = function (dataTable) { const data = detectDataType(dataTable) return { - Scenario: (title) => { - data.forEach((dataRow) => { + Scenario: title => { + data.forEach(dataRow => { const dataTitle = replaceTitle(title, dataRow) context.xScenario(dataTitle) }) @@ -69,10 +69,7 @@ function replaceTitle(title, dataRow) { // if `dataRow` is object and has own `toString()` method, // it should be printed - if ( - Object.prototype.toString.call(dataRow.data) === Object().toString() && - dataRow.data.toString() !== Object().toString() - ) { + if (Object.prototype.toString.call(dataRow.data) === Object().toString() && dataRow.data.toString() !== Object().toString()) { return `${title} | ${dataRow.data}` } @@ -102,7 +99,7 @@ function detectDataType(dataTable) { return dataTable() } if (Array.isArray(dataTable)) { - return dataTable.map((item) => { + return dataTable.map(item => { if (isTableDataRow(item)) { return item } @@ -117,10 +114,10 @@ function detectDataType(dataTable) { } function maskSecretInTitle(scenarios) { - scenarios.forEach((scenario) => { + scenarios.forEach(scenario => { const res = [] - scenario.test.title.split(',').forEach((item) => { + scenario.test.title.split(',').forEach(item => { res.push(item.replace(/{"_secret":"(.*)"}/, '"*****"')) }) diff --git a/lib/data/dataScenarioConfig.js b/lib/data/dataScenarioConfig.js index 9d6977819..74c2a519e 100644 --- a/lib/data/dataScenarioConfig.js +++ b/lib/data/dataScenarioConfig.js @@ -10,7 +10,7 @@ class DataScenarioConfig { * @param {*} err */ throws(err) { - this.scenarios.forEach((scenario) => scenario.throws(err)) + this.scenarios.forEach(scenario => scenario.throws(err)) return this } @@ -21,7 +21,7 @@ class DataScenarioConfig { * */ fails() { - this.scenarios.forEach((scenario) => scenario.fails()) + this.scenarios.forEach(scenario => scenario.fails()) return this } @@ -31,7 +31,7 @@ class DataScenarioConfig { * @param {*} retries */ retry(retries) { - this.scenarios.forEach((scenario) => scenario.retry(retries)) + this.scenarios.forEach(scenario => scenario.retry(retries)) return this } @@ -40,7 +40,7 @@ class DataScenarioConfig { * @param {*} timeout */ timeout(timeout) { - this.scenarios.forEach((scenario) => scenario.timeout(timeout)) + this.scenarios.forEach(scenario => scenario.timeout(timeout)) return this } @@ -49,7 +49,7 @@ class DataScenarioConfig { * Helper name can be omitted and values will be applied to first helper. */ config(helper, obj) { - this.scenarios.forEach((scenario) => scenario.config(helper, obj)) + this.scenarios.forEach(scenario => scenario.config(helper, obj)) return this } @@ -58,7 +58,7 @@ class DataScenarioConfig { * @param {*} tagName */ tag(tagName) { - this.scenarios.forEach((scenario) => scenario.tag(tagName)) + this.scenarios.forEach(scenario => scenario.tag(tagName)) return this } @@ -67,7 +67,7 @@ class DataScenarioConfig { * @param {*} obj */ inject(obj) { - this.scenarios.forEach((scenario) => scenario.inject(obj)) + this.scenarios.forEach(scenario => scenario.inject(obj)) return this } @@ -76,7 +76,7 @@ class DataScenarioConfig { * @param {*} dependencies */ injectDependencies(dependencies) { - this.scenarios.forEach((scenario) => scenario.injectDependencies(dependencies)) + this.scenarios.forEach(scenario => scenario.injectDependencies(dependencies)) return this } } diff --git a/lib/data/dataTableArgument.js b/lib/data/dataTableArgument.js index 7d1a72d32..8f21b0375 100644 --- a/lib/data/dataTableArgument.js +++ b/lib/data/dataTableArgument.js @@ -5,8 +5,8 @@ class DataTableArgument { /** @param {*} gherkinDataTable */ constructor(gherkinDataTable) { - this.rawData = gherkinDataTable.rows.map((row) => { - return row.cells.map((cell) => { + this.rawData = gherkinDataTable.rows.map(row => { + return row.cells.map(cell => { return cell.value }) }) @@ -34,7 +34,7 @@ class DataTableArgument { hashes() { const copy = this.raw() const header = copy.shift() - return copy.map((row) => { + return copy.map(row => { const r = {} row.forEach((cell, index) => (r[header[index]] = cell)) return r @@ -47,19 +47,19 @@ class DataTableArgument { */ rowsHash() { const rows = this.raw() - const everyRowHasTwoColumns = rows.every((row) => row.length === 2) + const everyRowHasTwoColumns = rows.every(row => row.length === 2) if (!everyRowHasTwoColumns) { throw new Error('rowsHash can only be called on a data table where all rows have exactly two columns') } /** @type {Record} */ const result = {} - rows.forEach((x) => (result[x[0]] = x[1])) + rows.forEach(x => (result[x[0]] = x[1])) return result } /** Transposed the data */ transpose() { - this.rawData = this.rawData[0].map((x, i) => this.rawData.map((y) => y[i])) + this.rawData = this.rawData[0].map((x, i) => this.rawData.map(y => y[i])) } } diff --git a/lib/data/table.js b/lib/data/table.js index 841e444dc..65a399875 100644 --- a/lib/data/table.js +++ b/lib/data/table.js @@ -10,13 +10,10 @@ class DataTable { /** @param {Array<*>} array */ add(array) { - if (array.length !== this.array.length) - throw new Error( - `There is too many elements in given data array. Please provide data in this format: ${this.array}`, - ) + if (array.length !== this.array.length) throw new Error(`There is too many elements in given data array. Please provide data in this format: ${this.array}`) const tempObj = {} let arrayCounter = 0 - this.array.forEach((elem) => { + this.array.forEach(elem => { tempObj[elem] = array[arrayCounter] tempObj.toString = () => JSON.stringify(tempObj) arrayCounter++ @@ -26,13 +23,10 @@ class DataTable { /** @param {Array<*>} array */ xadd(array) { - if (array.length !== this.array.length) - throw new Error( - `There is too many elements in given data array. Please provide data in this format: ${this.array}`, - ) + if (array.length !== this.array.length) throw new Error(`There is too many elements in given data array. Please provide data in this format: ${this.array}`) const tempObj = {} let arrayCounter = 0 - this.array.forEach((elem) => { + this.array.forEach(elem => { tempObj[elem] = array[arrayCounter] tempObj.toString = () => JSON.stringify(tempObj) arrayCounter++ @@ -42,7 +36,7 @@ class DataTable { /** @param {Function} func */ filter(func) { - return this.rows.filter((row) => func(row.data)) + return this.rows.filter(row => func(row.data)) } } diff --git a/lib/effects.js b/lib/effects.js new file mode 100644 index 000000000..5416e9d06 --- /dev/null +++ b/lib/effects.js @@ -0,0 +1,223 @@ +const recorder = require('./recorder') +const { debug } = require('./output') +const store = require('./store') +const event = require('./event') +const within = require('./within') + +/** + * A utility function for CodeceptJS tests that acts as a soft assertion. + * Executes a callback within a recorded session, ensuring errors are handled gracefully without failing the test immediately. + * + * @async + * @function hopeThat + * @param {Function} callback - The callback function containing the logic to validate. + * This function should perform the desired assertion or condition check. + * @returns {Promise} A promise resolving to `true` if the assertion or condition was successful, + * or `false` if an error occurred. + * + * @description + * - Designed for use in CodeceptJS tests as a "soft assertion." + * Unlike standard assertions, it does not stop the test execution on failure. + * - Starts a new recorder session named 'hopeThat' and manages state restoration. + * - Logs errors and attaches them as notes to the test, enabling post-test reporting of soft assertion failures. + * - Resets the `store.hopeThat` flag after the execution, ensuring clean state for subsequent operations. + * + * @example + * const { hopeThat } = require('codeceptjs/effects') + * await hopeThat(() => { + * I.see('Welcome'); // Perform a soft assertion + * }); + * + * @throws Will handle errors that occur during the callback execution. Errors are logged and attached as notes to the test. + */ +async function hopeThat(callback) { + if (store.dryRun) return + const sessionName = 'hopeThat' + + let result = false + return recorder.add( + 'hopeThat', + () => { + recorder.session.start(sessionName) + store.hopeThat = true + callback() + recorder.add(() => { + result = true + recorder.session.restore(sessionName) + return result + }) + recorder.session.catch(err => { + result = false + const msg = err.inspect ? err.inspect() : err.toString() + debug(`Unsuccessful assertion > ${msg}`) + event.dispatcher.once(event.test.finished, test => { + test.notes.push({ type: 'conditionalError', text: msg }) + }) + recorder.session.restore(sessionName) + return result + }) + return recorder.add( + 'result', + () => { + store.hopeThat = undefined + return result + }, + true, + false, + ) + }, + false, + false, + ) +} + +/** + * A CodeceptJS utility function to retry a step or callback multiple times with a specified polling interval. + * + * @async + * @function retryTo + * @param {Function} callback - The function to execute, which will be retried upon failure. + * Receives the current retry count as an argument. + * @param {number} maxTries - The maximum number of attempts to retry the callback. + * @param {number} [pollInterval=200] - The delay (in milliseconds) between retry attempts. + * @returns {Promise} A promise that resolves when the callback executes successfully, or rejects after reaching the maximum retries. + * + * @description + * - This function is designed for use in CodeceptJS tests to handle intermittent or flaky test steps. + * - Starts a new recorder session for each retry attempt, ensuring proper state management and error handling. + * - Logs errors and retries the callback until it either succeeds or the maximum number of attempts is reached. + * - Restores the session state after each attempt, whether successful or not. + * + * @example + * const { hopeThat } = require('codeceptjs/effects') + * await retryTo((tries) => { + * if (tries < 3) { + * I.see('Non-existent element'); // Simulates a failure + * } else { + * I.see('Welcome'); // Succeeds on the 3rd attempt + * } + * }, 5, 300); // Retry up to 5 times, with a 300ms interval + * + * @throws Will reject with the last error encountered if the maximum retries are exceeded. + */ +async function retryTo(callback, maxTries, pollInterval = 200) { + const sessionName = 'retryTo' + + return new Promise((done, reject) => { + let tries = 1 + + function handleRetryException(err) { + recorder.throw(err) + reject(err) + } + + const tryBlock = async () => { + tries++ + recorder.session.start(`${sessionName} ${tries}`) + try { + await callback(tries) + } catch (err) { + handleRetryException(err) + } + + // Call done if no errors + recorder.add(() => { + recorder.session.restore(`${sessionName} ${tries}`) + done(null) + }) + + // Catch errors and retry + recorder.session.catch(err => { + recorder.session.restore(`${sessionName} ${tries}`) + if (tries <= maxTries) { + debug(`Error ${err}... Retrying`) + recorder.add(`${sessionName} ${tries}`, () => setTimeout(tryBlock, pollInterval)) + } else { + // if maxTries reached + handleRetryException(err) + } + }) + } + + recorder.add(sessionName, tryBlock).catch(err => { + console.error('An error occurred:', err) + done(null) + }) + }) +} + +/** + * A CodeceptJS utility function to attempt a step or callback without failing the test. + * If the step fails, the test continues execution without interruption, and the result is logged. + * + * @async + * @function tryTo + * @param {Function} callback - The function to execute, which may succeed or fail. + * This function contains the logic to be attempted. + * @returns {Promise} A promise resolving to `true` if the step succeeds, or `false` if it fails. + * + * @description + * - Useful for scenarios where certain steps are optional or their failure should not interrupt the test flow. + * - Starts a new recorder session named 'tryTo' for isolation and error handling. + * - Captures errors during execution and logs them for debugging purposes. + * - Ensures the `store.tryTo` flag is reset after execution to maintain a clean state. + * + * @example + * const { tryTo } = require('codeceptjs/effects') + * const wasSuccessful = await tryTo(() => { + * I.see('Welcome'); // Attempt to find an element on the page + * }); + * + * if (!wasSuccessful) { + * I.say('Optional step failed, but test continues.'); + * } + * + * @throws Will handle errors internally, logging them and returning `false` as the result. + */ +async function tryTo(callback) { + if (store.dryRun) return + const sessionName = 'tryTo' + + let result = false + let isAutoRetriesEnabled = store.autoRetries + return recorder.add( + sessionName, + () => { + recorder.session.start(sessionName) + isAutoRetriesEnabled = store.autoRetries + if (isAutoRetriesEnabled) debug('Auto retries disabled inside tryTo effect') + store.autoRetries = false + callback() + recorder.add(() => { + result = true + recorder.session.restore(sessionName) + return result + }) + recorder.session.catch(err => { + result = false + const msg = err.inspect ? err.inspect() : err.toString() + debug(`Unsuccessful try > ${msg}`) + recorder.session.restore(sessionName) + return result + }) + return recorder.add( + 'result', + () => { + store.autoRetries = isAutoRetriesEnabled + return result + }, + true, + false, + ) + }, + false, + false, + ) +} + +module.exports = { + hopeThat, + retryTo, + tryTo, + within, +} diff --git a/lib/els.js b/lib/els.js new file mode 100644 index 000000000..1f319df63 --- /dev/null +++ b/lib/els.js @@ -0,0 +1,158 @@ +const output = require('./output') +const store = require('./store') +const container = require('./container') +const StepConfig = require('./step/config') +const recordStep = require('./step/record') +const FuncStep = require('./step/func') +const { truth } = require('./assert/truth') +const { isAsyncFunction, humanizeFunction } = require('./utils') + +function element(purpose, locator, fn) { + let stepConfig + if (arguments[arguments.length - 1] instanceof StepConfig) { + stepConfig = arguments[arguments.length - 1] + } + + if (!fn || fn === stepConfig) { + fn = locator + locator = purpose + purpose = 'first element' + } + + const step = prepareStep(purpose, locator, fn) + if (!step) return + + return executeStep( + step, + async () => { + const els = await step.helper._locate(locator) + output.debug(`Found ${els.length} elements, using first element`) + + return fn(els[0]) + }, + stepConfig, + ) +} + +function eachElement(purpose, locator, fn) { + if (!fn) { + fn = locator + locator = purpose + purpose = 'for each element' + } + + const step = prepareStep(purpose, locator, fn) + if (!step) return + + return executeStep(step, async () => { + const els = await step.helper._locate(locator) + output.debug(`Found ${els.length} elements for each elements to iterate`) + + const errs = [] + let i = 0 + for (const el of els) { + try { + await fn(el, i) + } catch (err) { + output.error(`eachElement: failed operation on element #${i} ${el}`) + errs.push(err) + } + i++ + } + + if (errs.length) { + throw errs[0] + } + }) +} + +function expectElement(locator, fn) { + const step = prepareStep('expect element to be', locator, fn) + if (!step) return + + return executeStep(step, async () => { + const els = await step.helper._locate(locator) + output.debug(`Found ${els.length} elements, first will be used for assertion`) + + const result = await fn(els[0]) + const assertion = truth(`element (${locator})`, fn.toString()) + assertion.assert(result) + }) +} + +function expectAnyElement(locator, fn) { + const step = prepareStep('expect any element to be', locator, fn) + if (!step) return + + return executeStep(step, async () => { + const els = await step.helper._locate(locator) + output.debug(`Found ${els.length} elements, at least one should pass the assertion`) + + const assertion = truth(`any element of (${locator})`, fn.toString()) + + let found = false + for (const el of els) { + const result = await fn(el) + if (result) { + found = true + break + } + } + if (!found) throw assertion.getException() + }) +} + +function expectAllElements(locator, fn) { + const step = prepareStep('expect all elements', locator, fn) + if (!step) return + + return executeStep(step, async () => { + const els = await step.helper._locate(locator) + output.debug(`Found ${els.length} elements, all should pass the assertion`) + + let i = 1 + for (const el of els) { + output.debug(`checking element #${i}: ${el}`) + const result = await fn(el) + const assertion = truth(`element #${i} of (${locator})`, humanizeFunction(fn)) + assertion.assert(result) + i++ + } + }) +} + +module.exports = { + element, + eachElement, + expectElement, + expectAnyElement, + expectAllElements, +} + +function prepareStep(purpose, locator, fn) { + if (store.dryRun) return + const helpers = Object.values(container.helpers()) + + const helper = helpers.filter(h => !!h._locate)[0] + + if (!helper) { + throw new Error('No helper enabled with _locate method with returns a list of elements.') + } + + if (!isAsyncFunction(fn)) { + throw new Error('Async function should be passed into each element') + } + + const isAssertion = purpose.startsWith('expect') + + const step = new FuncStep(`${purpose} within "${locator}" ${isAssertion ? 'to be' : 'to'}`) + step.setHelper(helper) + step.setArguments([humanizeFunction(fn)]) // user defined function is a passed argument + + return step +} + +async function executeStep(step, action, stepConfig = {}) { + step.setCallable(action) + return recordStep(step, [stepConfig]) +} diff --git a/lib/event.js b/lib/event.js index 676354be7..1791f742f 100644 --- a/lib/event.js +++ b/lib/event.js @@ -1,10 +1,10 @@ -const debug = require('debug')('codeceptjs:event'); -const events = require('events'); -const { error } = require('./output'); +const debug = require('debug')('codeceptjs:event') +const events = require('events') +const { error } = require('./output') -const dispatcher = new events.EventEmitter(); +const dispatcher = new events.EventEmitter() -dispatcher.setMaxListeners(50); +dispatcher.setMaxListeners(50) /** * @namespace * @alias event @@ -54,12 +54,16 @@ module.exports = { * @inner * @property {'hook.start'} started * @property {'hook.passed'} passed + * @property {'hook.failed'} failed + * @property {'hook.finished'} finished */ hook: { started: 'hook.start', passed: 'hook.passed', failed: 'hook.failed', + finished: 'hook.finished', }, + /** * @type {object} * @constant @@ -140,33 +144,33 @@ module.exports = { * @param {*} [param] */ emit(event, param) { - let msg = `Emitted | ${event}`; + let msg = `Emitted | ${event}` if (param && param.toString()) { - msg += ` (${param.toString()})`; + msg += ` (${param.toString()})` } - debug(msg); + debug(msg) try { - this.dispatcher.emit.apply(this.dispatcher, arguments); + this.dispatcher.emit.apply(this.dispatcher, arguments) } catch (err) { - error(`Error processing ${event} event:`); - error(err.stack); + error(`Error processing ${event} event:`) + error(err.stack) } }, /** for testing only! */ cleanDispatcher: () => { - let event; + let event for (event in this.test) { - this.dispatcher.removeAllListeners(this.test[event]); + this.dispatcher.removeAllListeners(this.test[event]) } for (event in this.suite) { - this.dispatcher.removeAllListeners(this.test[event]); + this.dispatcher.removeAllListeners(this.test[event]) } for (event in this.step) { - this.dispatcher.removeAllListeners(this.test[event]); + this.dispatcher.removeAllListeners(this.test[event]) } for (event in this.all) { - this.dispatcher.removeAllListeners(this.test[event]); + this.dispatcher.removeAllListeners(this.test[event]) } }, -}; +} diff --git a/lib/heal.js b/lib/heal.js index e1a3ce51d..f1d24b6df 100644 --- a/lib/heal.js +++ b/lib/heal.js @@ -1,122 +1,125 @@ -const debug = require('debug')('codeceptjs:heal'); -const colors = require('chalk'); -const Container = require('./container'); -const recorder = require('./recorder'); -const output = require('./output'); -const event = require('./event'); +const debug = require('debug')('codeceptjs:heal') +const colors = require('chalk') +const Container = require('./container') +const recorder = require('./recorder') +const output = require('./output') +const event = require('./event') /** * @class */ class Heal { constructor() { - this.recipes = {}; - this.fixes = []; - this.prepareFns = []; - this.contextName = null; - this.numHealed = 0; + this.recipes = {} + this.fixes = [] + this.prepareFns = [] + this.contextName = null + this.numHealed = 0 } clear() { - this.recipes = {}; - this.fixes = []; - this.prepareFns = []; - this.contextName = null; - this.numHealed = 0; + this.recipes = {} + this.fixes = [] + this.prepareFns = [] + this.contextName = null + this.numHealed = 0 } addRecipe(name, opts = {}) { - if (!opts.priority) opts.priority = 0; + if (!opts.priority) opts.priority = 0 - if (!opts.fn) throw new Error(`Recipe ${name} should have a function 'fn' to execute`); + if (!opts.fn) throw new Error(`Recipe ${name} should have a function 'fn' to execute`) - this.recipes[name] = opts; + this.recipes[name] = opts } connectToEvents() { - event.dispatcher.on(event.suite.before, (suite) => { - this.contextName = suite.title; - }); + event.dispatcher.on(event.suite.before, suite => { + this.contextName = suite.title + }) - event.dispatcher.on(event.test.started, (test) => { - this.contextName = test.fullTitle(); - }); + event.dispatcher.on(event.test.started, test => { + this.contextName = test.fullTitle() + }) event.dispatcher.on(event.test.finished, () => { - this.contextName = null; - }); + this.contextName = null + }) } hasCorrespondingRecipes(step) { - return matchRecipes(this.recipes, this.contextName) - .filter(r => !r.steps || r.steps.includes(step.name)) - .length > 0; + return matchRecipes(this.recipes, this.contextName).filter(r => !r.steps || r.steps.includes(step.name)).length > 0 } async getCodeSuggestions(context) { - const suggestions = []; - const recipes = matchRecipes(this.recipes, this.contextName); + const suggestions = [] + const recipes = matchRecipes(this.recipes, this.contextName) - debug('Recipes', recipes); + debug('Recipes', recipes) - const currentOutputLevel = output.level(); - output.level(0); + const currentOutputLevel = output.level() + output.level(0) - for (const [property, prepareFn] of Object.entries(recipes.map(r => r.prepare).filter(p => !!p).reduce((acc, obj) => ({ ...acc, ...obj }), {}))) { - if (!prepareFn) continue; + for (const [property, prepareFn] of Object.entries( + recipes + .map(r => r.prepare) + .filter(p => !!p) + .reduce((acc, obj) => ({ ...acc, ...obj }), {}), + )) { + if (!prepareFn) continue - if (context[property]) continue; - context[property] = await prepareFn(Container.support()); + if (context[property]) continue + context[property] = await prepareFn(Container.support()) } - output.level(currentOutputLevel); + output.level(currentOutputLevel) for (const recipe of recipes) { - let snippets = await recipe.fn(context); - if (!Array.isArray(snippets)) snippets = [snippets]; + let snippets = await recipe.fn(context) + if (!Array.isArray(snippets)) snippets = [snippets] suggestions.push({ name: recipe.name, snippets, - }); + }) } - return suggestions.filter(s => !isBlank(s.snippets)); + return suggestions.filter(s => !isBlank(s.snippets)) } async healStep(failedStep, error, failureContext = {}) { - output.debug(`Trying to heal ${failedStep.toCode()} step`); + output.debug(`Trying to heal ${failedStep.toCode()} step`) Object.assign(failureContext, { error, step: failedStep, prevSteps: failureContext?.test?.steps?.slice(0, -1) || [], - }); + }) - const suggestions = await this.getCodeSuggestions(failureContext); + const suggestions = await this.getCodeSuggestions(failureContext) if (suggestions.length === 0) { - debug('No healing suggestions found'); - throw error; + debug('No healing suggestions found') + throw error } - output.debug(`Received ${suggestions.length} suggestion${suggestions.length === 1 ? '' : 's'}`); + output.debug(`Received ${suggestions.length} suggestion${suggestions.length === 1 ? '' : 's'}`) - debug(suggestions); + debug(suggestions) for (const suggestion of suggestions) { for (const codeSnippet of suggestion.snippets) { try { - debug('Executing', codeSnippet); - recorder.catch((e) => { - debug(e); - }); + debug('Executing', codeSnippet) + recorder.catch(e => { + debug(e) + }) if (typeof codeSnippet === 'string') { - const I = Container.support('I'); - await eval(codeSnippet); // eslint-disable-line + const I = Container.support('I') + await eval(codeSnippet) } else if (typeof codeSnippet === 'function') { - await codeSnippet(Container.support()); + await codeSnippet(Container.support()) } this.fixes.push({ @@ -124,49 +127,54 @@ class Heal { test: failureContext?.test, step: failedStep, snippet: codeSnippet, - }); + }) + + if (failureContext?.test) { + const test = failureContext.test + let note = `This test was healed by '${suggestion.name}'` + note += `\n\nReplace the failed code:\n\n` + note += colors.red(`- ${failedStep.toCode()}\n`) + note += colors.green(`+ ${codeSnippet}\n`) + test.addNote('heal', note) + test.meta.healed = true + } - recorder.add('healed', () => output.print(colors.bold.green(` Code healed successfully by ${suggestion.name}`), colors.gray('(no errors thrown)'))); - this.numHealed++; + recorder.add('healed', () => output.print(colors.bold.green(` Code healed successfully by ${suggestion.name}`), colors.gray('(no errors thrown)'))) + this.numHealed++ // recorder.session.restore(); - return; + return } catch (err) { - debug('Failed to execute code', err); - recorder.ignoreErr(err); // healing did not help - recorder.catchWithoutStop(err); - await recorder.promise(); // wait for all promises to resolve + debug('Failed to execute code', err) + recorder.ignoreErr(err) // healing did not help + recorder.catchWithoutStop(err) + await recorder.promise() // wait for all promises to resolve } } } - output.debug(`Couldn't heal the code for ${failedStep.toCode()}`); - recorder.throw(error); + output.debug(`Couldn't heal the code for ${failedStep.toCode()}`) + recorder.throw(error) } static setDefaultHealers() { - require('./template/heal'); + require('./template/heal') } } -const heal = new Heal(); +const heal = new Heal() -module.exports = heal; +module.exports = heal function matchRecipes(recipes, contextName) { return Object.entries(recipes) .filter(([, recipe]) => !contextName || !recipe.grep || new RegExp(recipe.grep).test(contextName)) .sort(([, a], [, b]) => a.priority - b.priority) .map(([name, recipe]) => { - recipe.name = name; - return recipe; + recipe.name = name + return recipe }) - .filter(r => !!r.fn); + .filter(r => !!r.fn) } function isBlank(value) { - return ( - value == null - || (Array.isArray(value) && value.length === 0) - || (typeof value === 'object' && Object.keys(value).length === 0) - || (typeof value === 'string' && value.trim() === '') - ); + return value == null || (Array.isArray(value) && value.length === 0) || (typeof value === 'object' && Object.keys(value).length === 0) || (typeof value === 'string' && value.trim() === '') } diff --git a/lib/helper/AI.js b/lib/helper/AI.js index 4b2d75978..4627f5612 100644 --- a/lib/helper/AI.js +++ b/lib/helper/AI.js @@ -3,13 +3,14 @@ const ora = require('ora-classic') const fs = require('fs') const path = require('path') const ai = require('../ai') -const standardActingHelpers = require('../plugin/standardActingHelpers') const Container = require('../container') const { splitByChunks, minifyHtml } = require('../html') const { beautify } = require('../utils') const output = require('../output') const { registerVariable } = require('../pause') +const standardActingHelpers = Container.STANDARD_ACTING_HELPERS + const gtpRole = { user: 'user', } diff --git a/lib/helper/ApiDataFactory.js b/lib/helper/ApiDataFactory.js index 7026a6c62..51fc2e700 100644 --- a/lib/helper/ApiDataFactory.js +++ b/lib/helper/ApiDataFactory.js @@ -217,7 +217,7 @@ class ApiDataFactory extends Helper { } this.created = {} - Object.keys(this.factories).forEach((f) => (this.created[f] = [])) + Object.keys(this.factories).forEach(f => (this.created[f] = [])) } static _checkRequirements() { @@ -357,7 +357,7 @@ Current file error: ${err.message}`) request.baseURL = this.config.endpoint - return this.restHelper._executeRequest(request).then((resp) => { + return this.restHelper._executeRequest(request).then(resp => { const id = this._fetchId(resp.data, factory) this.created[factory].push(id) this.debugSection('Created', `Id: ${id}`) @@ -391,10 +391,7 @@ Current file error: ${err.message}`) request.baseURL = this.config.endpoint if (request.url.match(/^undefined/)) { - return this.debugSection( - 'Please configure the delete request in your ApiDataFactory helper', - "delete: () => ({ method: 'DELETE', url: '/api/users' })", - ) + return this.debugSection('Please configure the delete request in your ApiDataFactory helper', "delete: () => ({ method: 'DELETE', url: '/api/users' })") } return this.restHelper._executeRequest(request).then(() => { diff --git a/lib/helper/Appium.js b/lib/helper/Appium.js index 9c476cc56..fcb304263 100644 --- a/lib/helper/Appium.js +++ b/lib/helper/Appium.js @@ -44,7 +44,7 @@ const vendorPrefix = { * * This helper should be configured in codecept.conf.ts or codecept.conf.js * - * * `appiumV2`: set this to true if you want to run tests with AppiumV2. See more how to setup [here](https://codecept.io/mobile/#setting-up) + * * `appiumV2`: by default is true, set this to false if you want to run tests with AppiumV1. See more how to setup [here](https://codecept.io/mobile/#setting-up) * * `app`: Application path. Local path or remote URL to an .ipa or .apk file, or a .zip containing one of these. Alias to desiredCapabilities.appPackage * * `host`: (default: 'localhost') Appium host * * `port`: (default: '4723') Appium port @@ -124,7 +124,7 @@ const vendorPrefix = { * { * helpers: { * Appium: { - * appiumV2: true, + * appiumV2: true, // By default is true, set to false if you want to run against Appium v1 * host: "hub-cloud.browserstack.com", * port: 4444, * user: process.env.BROWSERSTACK_USER, @@ -178,16 +178,12 @@ class Appium extends Webdriver { super(config) this.isRunning = false - if (config.appiumV2 === true) { - this.appiumV2 = true - } + this.appiumV2 = config.appiumV2 || true this.axios = axios.create() webdriverio = require('webdriverio') if (!config.appiumV2) { - console.log( - 'The Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. Please migrating to Appium 2.x by adding appiumV2: true to your config.', - ) + console.log('The Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. Appium 2.x is used by default.') console.log('More info: https://bit.ly/appium-v2-migration') console.log('This Appium 1.x support will be removed in next major release.') } @@ -234,20 +230,14 @@ class Appium extends Webdriver { config.baseUrl = config.url || config.baseUrl if (config.desiredCapabilities && Object.keys(config.desiredCapabilities).length) { - config.capabilities = - this.appiumV2 === true ? this._convertAppiumV2Caps(config.desiredCapabilities) : config.desiredCapabilities + config.capabilities = this.appiumV2 === true ? this._convertAppiumV2Caps(config.desiredCapabilities) : config.desiredCapabilities } if (this.appiumV2) { - config.capabilities[`${vendorPrefix.appium}:deviceName`] = - config[`${vendorPrefix.appium}:device`] || config.capabilities[`${vendorPrefix.appium}:deviceName`] - config.capabilities[`${vendorPrefix.appium}:browserName`] = - config[`${vendorPrefix.appium}:browser`] || config.capabilities[`${vendorPrefix.appium}:browserName`] - config.capabilities[`${vendorPrefix.appium}:app`] = - config[`${vendorPrefix.appium}:app`] || config.capabilities[`${vendorPrefix.appium}:app`] - config.capabilities[`${vendorPrefix.appium}:tunnelIdentifier`] = - config[`${vendorPrefix.appium}:tunnelIdentifier`] || - config.capabilities[`${vendorPrefix.appium}:tunnelIdentifier`] // Adding the code to connect to sauce labs via sauce tunnel + config.capabilities[`${vendorPrefix.appium}:deviceName`] = config[`${vendorPrefix.appium}:device`] || config.capabilities[`${vendorPrefix.appium}:deviceName`] + config.capabilities[`${vendorPrefix.appium}:browserName`] = config[`${vendorPrefix.appium}:browser`] || config.capabilities[`${vendorPrefix.appium}:browserName`] + config.capabilities[`${vendorPrefix.appium}:app`] = config[`${vendorPrefix.appium}:app`] || config.capabilities[`${vendorPrefix.appium}:app`] + config.capabilities[`${vendorPrefix.appium}:tunnelIdentifier`] = config[`${vendorPrefix.appium}:tunnelIdentifier`] || config.capabilities[`${vendorPrefix.appium}:tunnelIdentifier`] // Adding the code to connect to sauce labs via sauce tunnel } else { config.capabilities.deviceName = config.device || config.capabilities.deviceName config.capabilities.browserName = config.browser || config.capabilities.browserName @@ -393,8 +383,10 @@ class Appium extends Webdriver { _buildAppiumEndpoint() { const { protocol, port, hostname, path } = this.browser.options + // Ensure path does NOT end with a slash to prevent double slashes + const normalizedPath = path.replace(/\/$/, '') // Build path to Appium REST API endpoint - return `${protocol}://${hostname}:${port}${path}` + return `${protocol}://${hostname}:${port}${normalizedPath}/session/${this.browser.sessionId}` } /** @@ -610,7 +602,7 @@ class Appium extends Webdriver { return this.axios({ method: 'post', - url: `${this._buildAppiumEndpoint()}/session/${this.browser.sessionId}/appium/device/remove_app`, + url: `${this._buildAppiumEndpoint()}/appium/device/remove_app`, data: { appId, bundleId }, }) } @@ -627,7 +619,7 @@ class Appium extends Webdriver { onlyForApps.call(this) return this.axios({ method: 'post', - url: `${this._buildAppiumEndpoint()}/session/${this.browser.sessionId}/appium/app/reset`, + url: `${this._buildAppiumEndpoint()}/appium/app/reset`, }) } @@ -701,7 +693,7 @@ class Appium extends Webdriver { const res = await this.axios({ method: 'get', - url: `${this._buildAppiumEndpoint()}/session/${this.browser.sessionId}/orientation`, + url: `${this._buildAppiumEndpoint()}/orientation`, }) const currentOrientation = res.data.value @@ -725,7 +717,7 @@ class Appium extends Webdriver { return this.axios({ method: 'post', - url: `${this._buildAppiumEndpoint()}/session/${this.browser.sessionId}/orientation`, + url: `${this._buildAppiumEndpoint()}/orientation`, data: { orientation }, }) } @@ -964,21 +956,19 @@ class Appium extends Webdriver { * ```js * // taps outside to hide keyboard per default * I.hideDeviceKeyboard(); - * I.hideDeviceKeyboard('tapOutside'); - * - * // or by pressing key - * I.hideDeviceKeyboard('pressKey', 'Done'); * ``` * * Appium: support Android and iOS * - * @param {'tapOutside' | 'pressKey'} [strategy] Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’) - * @param {string} [key] Optional key */ - async hideDeviceKeyboard(strategy, key) { + async hideDeviceKeyboard() { onlyForApps.call(this) - strategy = strategy || 'tapOutside' - return this.browser.hideKeyboard(strategy, key) + + return this.axios({ + method: 'post', + url: `${this._buildAppiumEndpoint()}/appium/device/hide_keyboard`, + data: {}, + }) } /** @@ -1054,7 +1044,13 @@ class Appium extends Webdriver { * @param {*} locator */ async tap(locator) { - return this.makeTouchAction(locator, 'tap') + const { elementId } = await this.browser.$(parseLocator.call(this, locator)) + + return this.axios({ + method: 'post', + url: `${this._buildAppiumEndpoint()}/element/${elementId}/click`, + data: {}, + }) } /** @@ -1304,14 +1300,14 @@ class Appium extends Webdriver { } return browser .$$(parseLocator.call(this, searchableLocator)) - .then((els) => els.length && els[0].isDisplayed()) - .then((res) => { + .then(els => els.length && els[0].isDisplayed()) + .then(res => { if (res) { return true } return this[direction](scrollLocator, offset, speed) .getSource() - .then((source) => { + .then(source => { if (source === currentSource) { err = true } else { @@ -1324,12 +1320,9 @@ class Appium extends Webdriver { timeout * 1000, errorMsg, ) - .catch((e) => { + .catch(e => { if (e.message.indexOf('timeout') && e.type !== 'NoSuchElement') { - throw new AssertionFailedError( - { customMessage: `Scroll to the end and element ${searchableLocator} was not found` }, - '', - ) + throw new AssertionFailedError({ customMessage: `Scroll to the end and element ${searchableLocator} was not found` }, '') } else { throw e } @@ -1386,8 +1379,8 @@ class Appium extends Webdriver { */ async pullFile(path, dest) { onlyForApps.call(this) - return this.browser.pullFile(path).then((res) => - fs.writeFile(dest, Buffer.from(res, 'base64'), (err) => { + return this.browser.pullFile(path).then(res => + fs.writeFile(dest, Buffer.from(res, 'base64'), err => { if (err) { return false } @@ -1504,7 +1497,14 @@ class Appium extends Webdriver { */ async click(locator, context) { if (this.isWeb) return super.click(locator, context) - return super.click(parseLocator.call(this, locator), parseLocator.call(this, context)) + + const { elementId } = await this.browser.$(parseLocator.call(this, locator), parseLocator.call(this, context)) + + return this.axios({ + method: 'post', + url: `${this._buildAppiumEndpoint()}/element/${elementId}/click`, + data: {}, + }) } /** @@ -1759,12 +1759,8 @@ function parseLocator(locator) { } locator = new Locator(locator, 'xpath') - if (locator.type === 'css' && !this.isWeb) - throw new Error( - 'Unable to use css locators in apps. Locator strategies for this request: xpath, id, class name or accessibility id', - ) - if (locator.type === 'name' && !this.isWeb) - throw new Error("Can't locate element by name in Native context. Use either ID, class name or accessibility id") + if (locator.type === 'css' && !this.isWeb) throw new Error('Unable to use css locators in apps. Locator strategies for this request: xpath, id, class name or accessibility id') + if (locator.type === 'name' && !this.isWeb) throw new Error("Can't locate element by name in Native context. Use either ID, class name or accessibility id") if (locator.type === 'id' && !this.isWeb && this.platform === 'android') return `//*[@resource-id='${locator.value}']` return locator.simplify() } diff --git a/lib/helper/ExpectHelper.js b/lib/helper/ExpectHelper.js deleted file mode 100644 index 8d891e0ac..000000000 --- a/lib/helper/ExpectHelper.js +++ /dev/null @@ -1,391 +0,0 @@ -const output = require('../output') - -let expect - -import('chai').then((chai) => { - expect = chai.expect - chai.use(require('chai-string')) - // @ts-ignore - chai.use(require('chai-exclude')) - chai.use(require('chai-match-pattern')) - chai.use(require('chai-json-schema')) -}) - -/** - * This helper allows performing assertions based on Chai. - * - * ### Examples - * - * Zero-configuration when paired with other helpers like REST, Playwright: - * - * ```js - * // inside codecept.conf.js - *{ - * helpers: { - * Playwright: {...}, - * ExpectHelper: {}, - * } - *} - * ``` - * - * ## Methods - */ -class ExpectHelper { - /** - * - * @param {*} actualValue - * @param {*} expectedValue - * @param {*} [customErrorMsg] - */ - expectEqual(actualValue, expectedValue, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(actualValue)}" to equal "${JSON.stringify(expectedValue)}"`) - return expect(actualValue, customErrorMsg).to.equal(expectedValue) - } - - /** - * - * @param {*} actualValue - * @param {*} expectedValue - * @param {*} [customErrorMsg] - */ - expectNotEqual(actualValue, expectedValue, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(actualValue)}" to not equal "${JSON.stringify(expectedValue)}"`) - return expect(actualValue, customErrorMsg).not.to.equal(expectedValue) - } - - /** - * - * @param {*} actualValue - * @param {*} expectedValue - * @param {*} [customErrorMsg] - - */ - expectDeepEqual(actualValue, expectedValue, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(actualValue)}" to deep equal "${JSON.stringify(expectedValue)}"`) - return expect(actualValue, customErrorMsg).to.deep.equal(expectedValue) - } - - /** - * - * @param {*} actualValue - * @param {*} expectedValue - * @param {*} [customErrorMsg] - */ - expectNotDeepEqual(actualValue, expectedValue, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(actualValue)}" to not deep equal "${JSON.stringify(expectedValue)}"`) - return expect(actualValue, customErrorMsg).to.not.deep.equal(expectedValue) - } - - /** - * - * @param {*} actualValue - * @param {*} expectedValueToContain - * @param {*} [customErrorMsg] - */ - expectContain(actualValue, expectedValueToContain, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(actualValue)}" to contain "${JSON.stringify(expectedValueToContain)}"`) - return expect(actualValue, customErrorMsg).to.contain(expectedValueToContain) - } - - /** - * - * @param {*} actualValue - * @param {*} expectedValueToNotContain - * @param {*} [customErrorMsg] - */ - expectNotContain(actualValue, expectedValueToNotContain, customErrorMsg = '') { - // @ts-ignore - output.step( - `I expect "${JSON.stringify(actualValue)}" to not contain "${JSON.stringify(expectedValueToNotContain)}"`, - ) - return expect(actualValue, customErrorMsg).not.to.contain(expectedValueToNotContain) - } - - /** - * - * @param {*} actualValue - * @param {*} expectedValueToStartWith - * @param {*} [customErrorMsg] - */ - expectStartsWith(actualValue, expectedValueToStartWith, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(actualValue)}" to start with "${JSON.stringify(expectedValueToStartWith)}"`) - return expect(actualValue, customErrorMsg).to.startsWith(expectedValueToStartWith) - } - - /** - * - * @param {*} actualValue - * @param {*} expectedValueToNotStartWith - * @param {*} [customErrorMsg] - */ - expectNotStartsWith(actualValue, expectedValueToNotStartWith, customErrorMsg = '') { - // @ts-ignore - output.step( - `I expect "${JSON.stringify(actualValue)}" to not start with "${JSON.stringify(expectedValueToNotStartWith)}"`, - ) - return expect(actualValue, customErrorMsg).not.to.startsWith(expectedValueToNotStartWith) - } - - /** - * @param {*} actualValue - * @param {*} expectedValueToEndWith - * @param {*} [customErrorMsg] - */ - expectEndsWith(actualValue, expectedValueToEndWith, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(actualValue)}" to end with "${JSON.stringify(expectedValueToEndWith)}"`) - return expect(actualValue, customErrorMsg).to.endsWith(expectedValueToEndWith) - } - - /** - * @param {*} actualValue - * @param {*} expectedValueToNotEndWith - * @param {*} [customErrorMsg] - */ - expectNotEndsWith(actualValue, expectedValueToNotEndWith, customErrorMsg = '') { - // @ts-ignore - output.step( - `I expect "${JSON.stringify(actualValue)}" to not end with "${JSON.stringify(expectedValueToNotEndWith)}"`, - ) - return expect(actualValue, customErrorMsg).not.to.endsWith(expectedValueToNotEndWith) - } - - /** - * @param {*} targetData - * @param {*} jsonSchema - * @param {*} [customErrorMsg] - */ - expectJsonSchema(targetData, jsonSchema, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(targetData)}" to match this JSON schema "${JSON.stringify(jsonSchema)}"`) - - return expect(targetData, customErrorMsg).to.be.jsonSchema(jsonSchema) - } - - /** - * @param {*} targetData - * @param {*} jsonSchema - * @param {*} [customErrorMsg] - * @param {*} [ajvOptions] Pass AJV options - */ - expectJsonSchemaUsingAJV(targetData, jsonSchema, customErrorMsg = '', ajvOptions = { allErrors: true }) { - // @ts-ignore - output.step( - `I expect "${JSON.stringify(targetData)}" to match this JSON schema using AJV "${JSON.stringify(jsonSchema)}"`, - ) - chai.use(require('chai-json-schema-ajv').create(ajvOptions)) - return expect(targetData, customErrorMsg).to.be.jsonSchema(jsonSchema) - } - - /** - * @param {*} targetData - * @param {*} propertyName - * @param {*} [customErrorMsg] - */ - expectHasProperty(targetData, propertyName, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(targetData)}" to have property: "${JSON.stringify(propertyName)}"`) - return expect(targetData, customErrorMsg).to.have.property(propertyName) - } - - /** - * @param {*} targetData - * @param {*} propertyName - * @param {*} [customErrorMsg] - */ - expectHasAProperty(targetData, propertyName, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(targetData)}" to have a property: "${JSON.stringify(propertyName)}"`) - return expect(targetData, customErrorMsg).to.have.a.property(propertyName) - } - - /** - * @param {*} targetData - * @param {*} type - * @param {*} [customErrorMsg] - */ - expectToBeA(targetData, type, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(targetData)}" to be a "${JSON.stringify(type)}"`) - return expect(targetData, customErrorMsg).to.be.a(type) - } - - /** - * @param {*} targetData - * @param {*} type - * @param {*} [customErrorMsg] - */ - expectToBeAn(targetData, type, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(targetData)}" to be an "${JSON.stringify(type)}"`) - return expect(targetData, customErrorMsg).to.be.an(type) - } - - /** - * @param {*} targetData - * @param {*} regex - * @param {*} [customErrorMsg] - */ - expectMatchRegex(targetData, regex, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(targetData)}" to match the regex "${JSON.stringify(regex)}"`) - return expect(targetData, customErrorMsg).to.match(regex) - } - - /** - * @param {*} targetData - * @param {*} length - * @param {*} [customErrorMsg] - */ - expectLengthOf(targetData, length, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(targetData)}" to have length of "${JSON.stringify(length)}"`) - return expect(targetData, customErrorMsg).to.have.lengthOf(length) - } - - /** - * @param {*} targetData - * @param {*} [customErrorMsg] - */ - expectEmpty(targetData, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(targetData)}" to be empty`) - return expect(targetData, customErrorMsg).to.be.empty - } - - /** - * @param {*} targetData - * @param {*} [customErrorMsg] - */ - expectTrue(targetData, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(targetData)}" to be true`) - return expect(targetData, customErrorMsg).to.be.true - } - - /** - * @param {*} targetData - * @param {*} [customErrorMsg] - */ - expectFalse(targetData, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(targetData)}" to be false`) - return expect(targetData, customErrorMsg).to.be.false - } - - /** - * @param {*} targetData - * @param {*} aboveThan - * @param {*} [customErrorMsg] - */ - expectAbove(targetData, aboveThan, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(targetData)}" to be above ${JSON.stringify(aboveThan)}`) - return expect(targetData, customErrorMsg).to.be.above(aboveThan) - } - - /** - * @param {*} targetData - * @param {*} belowThan - * @param {*} [customErrorMsg] - */ - expectBelow(targetData, belowThan, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(targetData)}" to be below ${JSON.stringify(belowThan)}`) - return expect(targetData, customErrorMsg).to.be.below(belowThan) - } - - /** - * @param {*} targetData - * @param {*} lengthAboveThan - * @param {*} [customErrorMsg] - */ - expectLengthAboveThan(targetData, lengthAboveThan, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(targetData)}" to have length of above ${JSON.stringify(lengthAboveThan)}`) - return expect(targetData, customErrorMsg).to.have.lengthOf.above(lengthAboveThan) - } - - /** - * @param {*} targetData - * @param {*} lengthBelowThan - * @param {*} [customErrorMsg] - */ - expectLengthBelowThan(targetData, lengthBelowThan, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(targetData)}" to have length of below ${JSON.stringify(lengthBelowThan)}`) - return expect(targetData, customErrorMsg).to.have.lengthOf.below(lengthBelowThan) - } - - /** - * @param {*} actualValue - * @param {*} expectedValue - * @param {*} [customErrorMsg] - */ - expectEqualIgnoreCase(actualValue, expectedValue, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect and ingore case "${JSON.stringify(actualValue)}" to equal "${JSON.stringify(expectedValue)}"`) - return expect(actualValue, customErrorMsg).to.equalIgnoreCase(expectedValue) - } - - /** - * expects members of two arrays are deeply equal - * @param {*} actualValue - * @param {*} expectedValue - * @param {*} [customErrorMsg] - */ - expectDeepMembers(actualValue, expectedValue, customErrorMsg = '') { - // @ts-ignore - output.step( - `I expect members of "${JSON.stringify(actualValue)}" and "${JSON.stringify(expectedValue)}" arrays are deeply equal`, - ) - return expect(actualValue, customErrorMsg).to.have.deep.members(expectedValue) - } - - /** - * expects an array to be a superset of another array - * @param {*} superset - * @param {*} set - * @param {*} [customErrorMsg] - */ - expectDeepIncludeMembers(superset, set, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(superset)}" array to be a superset of "${JSON.stringify(set)}" array`) - return expect(superset, customErrorMsg).to.deep.include.members(set) - } - - /** - * expects members of two JSON objects are deeply equal excluding some properties - * @param {*} actualValue - * @param {*} expectedValue - * @param {*} fieldsToExclude - * @param {*} [customErrorMsg] - */ - expectDeepEqualExcluding(actualValue, expectedValue, fieldsToExclude, customErrorMsg = '') { - // @ts-ignore - output.step( - `I expect members of "${JSON.stringify(actualValue)}" and "${JSON.stringify(expectedValue)}" JSON objects are deeply equal excluding properties: ${JSON.stringify(fieldsToExclude)}`, - ) - return expect(actualValue, customErrorMsg).excludingEvery(fieldsToExclude).to.deep.equal(expectedValue) - } - - /** - * expects a JSON object matches a provided pattern - * @param {*} actualValue - * @param {*} expectedPattern - * @param {*} [customErrorMsg] - */ - expectMatchesPattern(actualValue, expectedPattern, customErrorMsg = '') { - // @ts-ignore - output.step(`I expect "${JSON.stringify(actualValue)}" to match the ${JSON.stringify(expectedPattern)} pattern`) - return expect(actualValue, customErrorMsg).to.matchPattern(expectedPattern) - } -} - -module.exports = ExpectHelper diff --git a/lib/helper/FileSystem.js b/lib/helper/FileSystem.js index 68d6d645d..1f71863ea 100644 --- a/lib/helper/FileSystem.js +++ b/lib/helper/FileSystem.js @@ -105,7 +105,7 @@ class FileSystem extends Helper { */ seeFileNameMatching(text) { assert.ok( - this.grabFileNames().some((file) => file.includes(text)), + this.grabFileNames().some(file => file.includes(text)), `File name which contains ${text} not found in ${this.dir}`, ) } @@ -175,7 +175,7 @@ class FileSystem extends Helper { * ``` */ grabFileNames() { - return fs.readdirSync(this.dir).filter((item) => !fs.lstatSync(path.join(this.dir, item)).isDirectory()) + return fs.readdirSync(this.dir).filter(item => !fs.lstatSync(path.join(this.dir, item)).isDirectory()) } } @@ -216,7 +216,7 @@ function isFileExists(file, timeout) { } }) - fs.access(file, fs.constants.R_OK, (err) => { + fs.access(file, fs.constants.R_OK, err => { if (!err) { clearTimeout(timer) watcher.close() diff --git a/lib/helper/GraphQLDataFactory.js b/lib/helper/GraphQLDataFactory.js index d6453b7b3..de002992e 100644 --- a/lib/helper/GraphQLDataFactory.js +++ b/lib/helper/GraphQLDataFactory.js @@ -170,7 +170,7 @@ class GraphQLDataFactory extends Helper { this.factories = this.config.factories this.created = {} - Object.keys(this.factories).forEach((f) => (this.created[f] = [])) + Object.keys(this.factories).forEach(f => (this.created[f] = [])) } static _checkRequirements() { @@ -278,7 +278,7 @@ class GraphQLDataFactory extends Helper { */ _requestCreate(operation, variables) { const { query } = this.factories[operation] - return this.graphqlHelper.sendMutation(query, variables).then((response) => { + return this.graphqlHelper.sendMutation(query, variables).then(response => { const data = response.data.data[operation] this.created[operation].push(data) this.debugSection('Created', `record: ${data}`) @@ -297,7 +297,7 @@ class GraphQLDataFactory extends Helper { const deleteOperation = this.factories[operation].revert(data) const { query, variables } = deleteOperation - return this.graphqlHelper.sendMutation(query, variables).then((response) => { + return this.graphqlHelper.sendMutation(query, variables).then(response => { const idx = this.created[operation].indexOf(data) this.debugSection('Deleted', `record: ${response.data.data}`) this.created[operation].splice(idx, 1) diff --git a/lib/helper/JSONResponse.js b/lib/helper/JSONResponse.js index 765b37fa9..b45859dd9 100644 --- a/lib/helper/JSONResponse.js +++ b/lib/helper/JSONResponse.js @@ -1,12 +1,5 @@ const Helper = require('@codeceptjs/helper') - -let expect - -import('chai').then((chai) => { - expect = chai.expect - chai.use(require('chai-deep-match')) -}) - +const assert = require('assert') const joi = require('joi') /** @@ -77,12 +70,10 @@ class JSONResponse extends Helper { _beforeSuite() { this.response = null if (!this.helpers[this.options.requestHelper]) { - throw new Error( - `Error setting JSONResponse, helper ${this.options.requestHelper} is not enabled in config, helpers: ${Object.keys(this.helpers)}`, - ) + throw new Error(`Error setting JSONResponse, helper ${this.options.requestHelper} is not enabled in config, helpers: ${Object.keys(this.helpers)}`) } // connect to REST helper - this.helpers[this.options.requestHelper].config.onResponse = (response) => { + this.helpers[this.options.requestHelper].config.onResponse = response => { this.response = response } } @@ -110,7 +101,7 @@ class JSONResponse extends Helper { */ seeResponseCodeIs(code) { this._checkResponseReady() - expect(this.response.status).to.eql(code, 'Response code is not the same as expected') + assert.strictEqual(this.response.status, code, 'Response code is not the same as expected') } /** @@ -124,7 +115,7 @@ class JSONResponse extends Helper { */ dontSeeResponseCodeIs(code) { this._checkResponseReady() - expect(this.response.status).not.to.eql(code) + assert.notStrictEqual(this.response.status, code) } /** @@ -132,8 +123,7 @@ class JSONResponse extends Helper { */ seeResponseCodeIsClientError() { this._checkResponseReady() - expect(this.response.status).to.be.gte(400) - expect(this.response.status).to.be.lt(500) + assert(this.response.status >= 400 && this.response.status < 500) } /** @@ -141,8 +131,7 @@ class JSONResponse extends Helper { */ seeResponseCodeIsRedirection() { this._checkResponseReady() - expect(this.response.status).to.be.gte(300) - expect(this.response.status).to.be.lt(400) + assert(this.response.status >= 300 && this.response.status < 400) } /** @@ -150,8 +139,7 @@ class JSONResponse extends Helper { */ seeResponseCodeIsServerError() { this._checkResponseReady() - expect(this.response.status).to.be.gte(500) - expect(this.response.status).to.be.lt(600) + assert(this.response.status >= 500 && this.response.status < 600) } /** @@ -164,8 +152,7 @@ class JSONResponse extends Helper { */ seeResponseCodeIsSuccessful() { this._checkResponseReady() - expect(this.response.status).to.be.gte(200) - expect(this.response.status).to.be.lt(300) + assert(this.response.status >= 200 && this.response.status < 300) } /** @@ -188,17 +175,19 @@ class JSONResponse extends Helper { seeResponseContainsJson(json = {}) { this._checkResponseReady() if (Array.isArray(this.response.data)) { - let fails = 0 + let found = false for (const el of this.response.data) { try { - expect(el).to.deep.match(json) + this._assertContains(el, json) + found = true + break } catch (err) { - fails++ + continue } } - expect(fails < this.response.data.length, `No elements in array matched ${JSON.stringify(json)}`).to.be.true + assert(found, `No elements in array matched ${JSON.stringify(json)}`) } else { - expect(this.response.data).to.deep.match(json) + this._assertContains(this.response.data, json) } } @@ -222,9 +211,22 @@ class JSONResponse extends Helper { dontSeeResponseContainsJson(json = {}) { this._checkResponseReady() if (Array.isArray(this.response.data)) { - this.response.data.forEach((data) => expect(data).not.to.deep.match(json)) + for (const data of this.response.data) { + try { + this._assertContains(data, json) + assert.fail(`Found matching element: ${JSON.stringify(data)}`) + } catch (err) { + // expected to fail + continue + } + } } else { - expect(this.response.data).not.to.deep.match(json) + try { + this._assertContains(this.response.data, json) + assert.fail('Response contains the JSON') + } catch (err) { + // expected to fail + } } } @@ -250,20 +252,27 @@ class JSONResponse extends Helper { seeResponseContainsKeys(keys = []) { this._checkResponseReady() if (Array.isArray(this.response.data)) { - this.response.data.forEach((data) => expect(data).to.include.keys(keys)) + for (const data of this.response.data) { + for (const key of keys) { + assert(key in data, `Key "${key}" is not found in ${JSON.stringify(data)}`) + } + } } else { - expect(this.response.data).to.include.keys(keys) + for (const key of keys) { + assert(key in this.response.data, `Key "${key}" is not found in ${JSON.stringify(this.response.data)}`) + } } } /** - * Executes a callback function passing in `response` object and chai assertions with `expect` + * Executes a callback function passing in `response` object and assert * Use it to perform custom checks of response data * * ```js - * I.seeResponseValidByCallback(({ data, status, expect }) => { - * expect(status).to.eql(200); - * expect(data).keys.to.include(['user', 'company']); + * I.seeResponseValidByCallback(({ data, status }) => { + * assert.strictEqual(status, 200); + * assert('user' in data); + * assert('company' in data); * }); * ``` * @@ -271,7 +280,7 @@ class JSONResponse extends Helper { */ seeResponseValidByCallback(fn) { this._checkResponseReady() - fn({ ...this.response, expect }) + fn({ ...this.response, assert }) const body = fn.toString() fn.toString = () => `${body.split('\n')[1]}...` } @@ -288,7 +297,7 @@ class JSONResponse extends Helper { */ seeResponseEquals(resp) { this._checkResponseReady() - expect(this.response.data).to.deep.equal(resp) + assert.deepStrictEqual(this.response.data, resp) } /** @@ -335,6 +344,17 @@ class JSONResponse extends Helper { _checkResponseReady() { if (!this.response) throw new Error('Response is not available') } + + _assertContains(actual, expected) { + for (const key in expected) { + assert(key in actual, `Key "${key}" not found in ${JSON.stringify(actual)}`) + if (typeof expected[key] === 'object' && expected[key] !== null) { + this._assertContains(actual[key], expected[key]) + } else { + assert.deepStrictEqual(actual[key], expected[key], `Values for key "${key}" don't match`) + } + } + } } module.exports = JSONResponse diff --git a/lib/helper/Mochawesome.js b/lib/helper/Mochawesome.js index abc143af4..0f45ff723 100644 --- a/lib/helper/Mochawesome.js +++ b/lib/helper/Mochawesome.js @@ -1,9 +1,9 @@ -let addMochawesomeContext let currentTest let currentSuite const Helper = require('@codeceptjs/helper') const { clearString } = require('../utils') +const { testToFileName } = require('../mocha/test') class Mochawesome extends Helper { constructor(config) { @@ -15,7 +15,8 @@ class Mochawesome extends Helper { disableScreenshots: false, } - addMochawesomeContext = require('mochawesome/addContext') + this._addContext = require('mochawesome/addContext') + this._createConfig(config) } @@ -43,28 +44,27 @@ class Mochawesome extends Helper { if (this.options.disableScreenshots) return let fileName // Get proper name if we are fail on hook - if (test.ctx.test.type === 'hook') { + if (test.ctx?.test?.type === 'hook') { currentTest = { test: test.ctx.test } // ignore retries if we are in hook test._retries = -1 fileName = clearString(`${test.title}_${currentTest.test.title}`) } else { currentTest = { test } - fileName = clearString(test.title) + fileName = testToFileName(test) } if (this.options.uniqueScreenshotNames) { - const uuid = test.uuid || test.ctx.test.uuid - fileName = `${fileName.substring(0, 10)}_${uuid}` + fileName = testToFileName(test, { unique: true }) } if (test._retries < 1 || test._retries === test.retryNum) { fileName = `${fileName}.failed.png` - return addMochawesomeContext(currentTest, fileName) + return this._addContext(currentTest, fileName) } } addMochawesomeContext(context) { if (currentTest === '') currentTest = { test: currentSuite.ctx.test } - return addMochawesomeContext(currentTest, context) + return this._addContext(currentTest, context) } } diff --git a/lib/helper/Nightmare.js b/lib/helper/Nightmare.js index 1a6e90692..534204c3c 100644 --- a/lib/helper/Nightmare.js +++ b/lib/helper/Nightmare.js @@ -111,13 +111,7 @@ class Nightmare extends Helper { const by = Object.keys(locator)[0] const value = locator[by] - this.evaluate_now( - (by, locator, contextEl) => window.codeceptjs.findAndStoreElements(by, locator, contextEl), - done, - by, - value, - contextEl, - ) + this.evaluate_now((by, locator, contextEl) => window.codeceptjs.findAndStoreElements(by, locator, contextEl), done, by, value, contextEl) }) this.Nightmare.action('findElement', function (locator, contextEl, done) { @@ -244,7 +238,7 @@ class Nightmare extends Helper { nodeId: queryResult.nodeId, files: pathsToUpload, }, - (err) => { + err => { if (Object.keys(err).length > 0) { parent.emit('log', 'problem setting input', err) return done(err) @@ -351,7 +345,7 @@ class Nightmare extends Helper { const outputFile = path.join(global.output_dir, fileName) this.debug(`HAR is saving to ${outputFile}`) - await this.browser.getHAR().then((har) => { + await this.browser.getHAR().then(har => { require('fs').writeFileSync(outputFile, JSON.stringify({ log: har })) }) } @@ -361,7 +355,7 @@ class Nightmare extends Helper { } async _stopBrowser() { - return this.browser.end().catch((error) => { + return this.browser.end().catch(error => { this.debugSection('Error on End', error) }) } @@ -445,7 +439,7 @@ class Nightmare extends Helper { // navigating to the same url will cause an error in nightmare, so don't do it return } - return this.browser.goto(url, headers).then((res) => { + return this.browser.goto(url, headers).then(res => { this.debugSection('URL', res.url) this.debugSection('Code', res.code) this.debugSection('Headers', JSON.stringify(res.headers)) @@ -535,7 +529,7 @@ class Nightmare extends Helper { locator = new Locator(locator, 'css') const num = await this.browser.evaluate( (by, locator) => { - return window.codeceptjs.findElements(by, locator).filter((e) => e.offsetWidth > 0 && e.offsetHeight > 0).length + return window.codeceptjs.findElements(by, locator).filter(e => e.offsetWidth > 0 && e.offsetHeight > 0).length }, locator.type, locator.value, @@ -551,7 +545,7 @@ class Nightmare extends Helper { locator = new Locator(locator, 'css') const num = await this.browser.evaluate( (by, locator) => { - return window.codeceptjs.findElements(by, locator).filter((e) => e.offsetWidth > 0 && e.offsetHeight > 0).length + return window.codeceptjs.findElements(by, locator).filter(e => e.offsetWidth > 0 && e.offsetHeight > 0).length }, locator.type, locator.value, @@ -598,9 +592,7 @@ class Nightmare extends Helper { */ async seeNumberOfElements(locator, num) { const elements = await this._locate(locator) - return equals( - `expected number of elements (${new Locator(locator)}) is ${num}, but found ${elements.length}`, - ).assert(elements.length, num) + return equals(`expected number of elements (${new Locator(locator)}) is ${num}, but found ${elements.length}`).assert(elements.length, num) } /** @@ -608,10 +600,7 @@ class Nightmare extends Helper { */ async seeNumberOfVisibleElements(locator, num) { const res = await this.grabNumberOfVisibleElements(locator) - return equals(`expected number of visible elements (${new Locator(locator)}) is ${num}, but found ${res}`).assert( - res, - num, - ) + return equals(`expected number of visible elements (${new Locator(locator)}) is ${num}, but found ${res}`).assert(res, num) } /** @@ -622,7 +611,7 @@ class Nightmare extends Helper { const num = await this.browser.evaluate( (by, locator) => { - return window.codeceptjs.findElements(by, locator).filter((e) => e.offsetWidth > 0 && e.offsetHeight > 0).length + return window.codeceptjs.findElements(by, locator).filter(e => e.offsetWidth > 0 && e.offsetHeight > 0).length }, locator.type, locator.value, @@ -637,7 +626,7 @@ class Nightmare extends Helper { async click(locator, context = null) { const el = await findClickable.call(this, locator, context) assertElementExists(el, locator, 'Clickable') - return this.browser.evaluate((el) => window.codeceptjs.clickEl(el), el).wait(this.options.waitForAction) + return this.browser.evaluate(el => window.codeceptjs.clickEl(el), el).wait(this.options.waitForAction) } /** @@ -646,7 +635,7 @@ class Nightmare extends Helper { async doubleClick(locator, context = null) { const el = await findClickable.call(this, locator, context) assertElementExists(el, locator, 'Clickable') - return this.browser.evaluate((el) => window.codeceptjs.doubleClickEl(el), el).wait(this.options.waitForAction) + return this.browser.evaluate(el => window.codeceptjs.doubleClickEl(el), el).wait(this.options.waitForAction) } /** @@ -655,7 +644,7 @@ class Nightmare extends Helper { async rightClick(locator, context = null) { const el = await findClickable.call(this, locator, context) assertElementExists(el, locator, 'Clickable') - return this.browser.evaluate((el) => window.codeceptjs.rightClickEl(el), el).wait(this.options.waitForAction) + return this.browser.evaluate(el => window.codeceptjs.rightClickEl(el), el).wait(this.options.waitForAction) } /** @@ -665,9 +654,7 @@ class Nightmare extends Helper { locator = new Locator(locator, 'css') const el = await this.browser.findElement(locator.toStrict()) assertElementExists(el, locator) - return this.browser - .evaluate((el, x, y) => window.codeceptjs.hoverEl(el, x, y), el, offsetX, offsetY) - .wait(this.options.waitForAction) // wait for hover event to happen + return this.browser.evaluate((el, x, y) => window.codeceptjs.hoverEl(el, x, y), el, offsetX, offsetY).wait(this.options.waitForAction) // wait for hover event to happen } /** @@ -676,7 +663,7 @@ class Nightmare extends Helper { * Wrapper for synchronous [evaluate](https://github.com/segmentio/nightmare#evaluatefn-arg1-arg2) */ async executeScript(...args) { - return this.browser.evaluate.apply(this.browser, args).catch((err) => err) // Nightmare's first argument is error :( + return this.browser.evaluate.apply(this.browser, args).catch(err => err) // Nightmare's first argument is error :( } /** @@ -686,7 +673,7 @@ class Nightmare extends Helper { * Unlike NightmareJS implementation calling `done` will return its first argument. */ async executeAsyncScript(...args) { - return this.browser.evaluate.apply(this.browser, args).catch((err) => err) // Nightmare's first argument is error :( + return this.browser.evaluate.apply(this.browser, args).catch(err => err) // Nightmare's first argument is error :( } /** @@ -705,7 +692,7 @@ class Nightmare extends Helper { async checkOption(field, context = null) { const els = await findCheckable.call(this, field, context) assertElementExists(els[0], field, 'Checkbox or radio') - return this.browser.evaluate((els) => window.codeceptjs.checkEl(els[0]), els).wait(this.options.waitForAction) + return this.browser.evaluate(els => window.codeceptjs.checkEl(els[0]), els).wait(this.options.waitForAction) } /** @@ -714,7 +701,7 @@ class Nightmare extends Helper { async uncheckOption(field, context = null) { const els = await findCheckable.call(this, field, context) assertElementExists(els[0], field, 'Checkbox or radio') - return this.browser.evaluate((els) => window.codeceptjs.unCheckEl(els[0]), els).wait(this.options.waitForAction) + return this.browser.evaluate(els => window.codeceptjs.unCheckEl(els[0]), els).wait(this.options.waitForAction) } /** @@ -826,7 +813,7 @@ class Nightmare extends Helper { locator = new Locator(locator, 'css') const els = await this.browser.findElements(locator.toStrict()) const texts = [] - const getText = (el) => window.codeceptjs.fetchElement(el).innerText + const getText = el => window.codeceptjs.fetchElement(el).innerText for (const el of els) { texts.push(await this.browser.evaluate(getText, el)) } @@ -855,7 +842,7 @@ class Nightmare extends Helper { locator = new Locator(locator, 'css') const els = await this.browser.findElements(locator.toStrict()) const values = [] - const getValues = (el) => window.codeceptjs.fetchElement(el).value + const getValues = el => window.codeceptjs.fetchElement(el).value for (const el of els) { values.push(await this.browser.evaluate(getValues, el)) } @@ -887,9 +874,7 @@ class Nightmare extends Helper { for (let index = 0; index < els.length; index++) { const el = els[index] - array.push( - await this.browser.evaluate((el, attr) => window.codeceptjs.fetchElement(el).getAttribute(attr), el, attr), - ) + array.push(await this.browser.evaluate((el, attr) => window.codeceptjs.fetchElement(el).getAttribute(attr), el, attr)) } return array @@ -921,7 +906,7 @@ class Nightmare extends Helper { for (let index = 0; index < els.length; index++) { const el = els[index] - array.push(await this.browser.evaluate((el) => window.codeceptjs.fetchElement(el).innerHTML, el)) + array.push(await this.browser.evaluate(el => window.codeceptjs.fetchElement(el).innerHTML, el)) } this.debugSection('GrabHTML', array) @@ -953,7 +938,7 @@ class Nightmare extends Helper { const getCssPropForElement = async (el, prop) => { return ( - await this.browser.evaluate((el) => { + await this.browser.evaluate(el => { return window.getComputedStyle(window.codeceptjs.fetchElement(el)) }, el) )[toCamelCase(prop)] @@ -1083,7 +1068,7 @@ class Nightmare extends Helper { * {{> wait }} */ async wait(sec) { - return new Promise((done) => { + return new Promise(done => { setTimeout(done, sec * 1000) }) } @@ -1106,7 +1091,7 @@ class Nightmare extends Helper { locator.value, text, ) - .catch((err) => { + .catch(err => { if (err.message.indexOf('Cannot read property') > -1) { throw new Error(`element (${JSON.stringify(context)}) is not in DOM. Unable to wait text.`) } else if (err.message && err.message.indexOf('.wait() timed out after') > -1) { @@ -1132,7 +1117,7 @@ class Nightmare extends Helper { locator.type, locator.value, ) - .catch((err) => { + .catch(err => { if (err.message && err.message.indexOf('.wait() timed out after') > -1) { throw new Error(`element (${JSON.stringify(locator)}) still not visible on page after ${sec} sec`) } else throw err @@ -1163,7 +1148,7 @@ class Nightmare extends Helper { locator.type, locator.value, ) - .catch((err) => { + .catch(err => { if (err.message && err.message.indexOf('.wait() timed out after') > -1) { throw new Error(`element (${JSON.stringify(locator)}) still visible after ${sec} sec`) } else throw err @@ -1179,7 +1164,7 @@ class Nightmare extends Helper { return this.browser .wait((by, locator) => window.codeceptjs.findElement(by, locator) !== null, locator.type, locator.value) - .catch((err) => { + .catch(err => { if (err.message && err.message.indexOf('.wait() timed out after') > -1) { throw new Error(`element (${JSON.stringify(locator)}) still not present on page after ${sec} sec`) } else throw err @@ -1203,7 +1188,7 @@ class Nightmare extends Helper { return this.browser .wait((by, locator) => window.codeceptjs.findElement(by, locator) === null, locator.type, locator.value) - .catch((err) => { + .catch(err => { if (err.message && err.message.indexOf('.wait() timed out after') > -1) { throw new Error(`element (${JSON.stringify(locator)}) still on page after ${sec} sec`) } else throw err @@ -1348,10 +1333,7 @@ class Nightmare extends Helper { return this.executeScript(function () { const body = document.body const html = document.documentElement - window.scrollTo( - 0, - Math.max(body.scrollHeight, body.offsetHeight, html.clientHeight, html.scrollHeight, html.offsetHeight), - ) + window.scrollTo(0, Math.max(body.scrollHeight, body.offsetHeight, html.clientHeight, html.scrollHeight, html.offsetHeight)) }) } @@ -1390,7 +1372,7 @@ async function proceedSee(assertType, text, context) { const texts = await this.browser.evaluate( (by, locator) => { - return window.codeceptjs.findElements(by, locator).map((el) => el.innerText) + return window.codeceptjs.findElements(by, locator).map(el => el.innerText) }, locator.type, locator.value, @@ -1402,8 +1384,8 @@ async function proceedSee(assertType, text, context) { async function proceedSeeInField(assertType, field, value) { const el = await findField.call(this, field) assertElementExists(el, field, 'Field') - const tag = await this.browser.evaluate((el) => window.codeceptjs.fetchElement(el).tagName, el) - const fieldVal = await this.browser.evaluate((el) => window.codeceptjs.fetchElement(el).value, el) + const tag = await this.browser.evaluate(el => window.codeceptjs.fetchElement(el).tagName, el) + const fieldVal = await this.browser.evaluate(el => window.codeceptjs.fetchElement(el).value, el) if (tag === 'select') { // locate option by values and check them const text = await this.browser.evaluate( @@ -1421,8 +1403,8 @@ async function proceedSeeInField(assertType, field, value) { async function proceedIsChecked(assertType, option) { const els = await findCheckable.call(this, option) assertElementExists(els, option, 'Checkable') - const selected = await this.browser.evaluate((els) => { - return els.map((el) => window.codeceptjs.fetchElement(el).checked).reduce((prev, cur) => prev || cur) + const selected = await this.browser.evaluate(els => { + return els.map(el => window.codeceptjs.fetchElement(el).checked).reduce((prev, cur) => prev || cur) }, els) return truth(`checkable ${option}`, 'to be checked')[assertType](selected) } diff --git a/lib/helper/Playwright.js b/lib/helper/Playwright.js index 37c23dd35..194a17d16 100644 --- a/lib/helper/Playwright.js +++ b/lib/helper/Playwright.js @@ -7,6 +7,7 @@ const assert = require('assert') const promiseRetry = require('promise-retry') const Locator = require('../locator') const recorder = require('../recorder') +const store = require('../store') const stringIncludes = require('../assert/include').includes const { urlEquals } = require('../assert/equal') const { equals } = require('../assert/equal') @@ -24,6 +25,7 @@ const { clearString, requireWithFallback, normalizeSpacesInString, + relativeDir, } = require('../utils') const { isColorProperty, convertColorToRGBA } = require('../colorUtils') const ElementNotFound = require('./errors/ElementNotFound') @@ -40,26 +42,10 @@ const popupStore = new Popup() const consoleLogStore = new Console() const availableBrowsers = ['chromium', 'webkit', 'firefox', 'electron'] -const { - setRestartStrategy, - restartsSession, - restartsContext, - restartsBrowser, -} = require('./extras/PlaywrightRestartOpts') +const { setRestartStrategy, restartsSession, restartsContext, restartsBrowser } = require('./extras/PlaywrightRestartOpts') const { createValueEngine, createDisabledEngine } = require('./extras/PlaywrightPropEngine') -const { - seeElementError, - dontSeeElementError, - dontSeeElementInDOMError, - seeElementInDOMError, -} = require('./errors/ElementAssertion') -const { - dontSeeTraffic, - seeTraffic, - grabRecordedNetworkTraffics, - stopRecordingTraffic, - flushNetworkTraffics, -} = require('./network/actions') +const { seeElementError, dontSeeElementError, dontSeeElementInDOMError, seeElementInDOMError } = require('./errors/ElementAssertion') +const { dontSeeTraffic, seeTraffic, grabRecordedNetworkTraffics, stopRecordingTraffic, flushNetworkTraffics } = require('./network/actions') const pathSeparator = path.sep @@ -392,9 +378,7 @@ class Playwright extends Helper { config = Object.assign(defaults, config) if (availableBrowsers.indexOf(config.browser) < 0) { - throw new Error( - `Invalid config. Can't use browser "${config.browser}". Accepted values: ${availableBrowsers.join(', ')}`, - ) + throw new Error(`Invalid config. Can't use browser "${config.browser}". Accepted values: ${availableBrowsers.join(', ')}`) } return config @@ -440,9 +424,7 @@ class Playwright extends Helper { } this.isRemoteBrowser = !!this.playwrightOptions.browserWSEndpoint this.isElectron = this.options.browser === 'electron' - this.userDataDir = this.playwrightOptions.userDataDir - ? `${this.playwrightOptions.userDataDir}_${Date.now().toString()}` - : undefined + this.userDataDir = this.playwrightOptions.userDataDir ? `${this.playwrightOptions.userDataDir}_${Date.now().toString()}` : undefined this.isCDPConnection = this.playwrightOptions.cdpConnection popupStore.defaultAction = this.options.defaultPopupAction } @@ -458,14 +440,14 @@ class Playwright extends Helper { name: 'url', message: 'Base url of site to be tested', default: 'http://localhost', - when: (answers) => answers.Playwright_browser !== 'electron', + when: answers => answers.Playwright_browser !== 'electron', }, { name: 'show', message: 'Show browser window', default: true, type: 'confirm', - when: (answers) => answers.Playwright_browser !== 'electron', + when: answers => answers.Playwright_browser !== 'electron', }, ] } @@ -500,9 +482,10 @@ class Playwright extends Helper { async _before(test) { this.currentRunningTest = test + recorder.retry({ - retries: process.env.FAILED_STEP_RETRIES || 3, - when: (err) => { + retries: test?.opts?.conditionalRetries || 3, + when: err => { if (!err || typeof err.message !== 'string') { return false } @@ -540,12 +523,17 @@ class Playwright extends Helper { this.currentRunningTest.artifacts.har = fileName contextOptions.recordHar = this.options.recordHar } + + // load pre-saved cookies + if (test?.opts?.cookies) contextOptions.storageState = { cookies: test.opts.cookies } + if (this.storageState) contextOptions.storageState = this.storageState if (this.options.userAgent) contextOptions.userAgent = this.options.userAgent if (this.options.locale) contextOptions.locale = this.options.locale if (this.options.colorScheme) contextOptions.colorScheme = this.options.colorScheme this.contextOptions = contextOptions if (!this.browserContext || !restartsSession()) { + this.debugSection('New Session', JSON.stringify(this.contextOptions)) this.browserContext = await this.browser.newContext(this.contextOptions) // Adding the HTTPSError ignore in the context so that we can ignore those errors } } @@ -559,10 +547,7 @@ class Playwright extends Helper { mainPage = existingPages[0] || (await this.browserContext.newPage()) } catch (e) { if (this.playwrightOptions.userDataDir) { - this.browser = await playwright[this.options.browser].launchPersistentContext( - this.userDataDir, - this.playwrightOptions, - ) + this.browser = await playwright[this.options.browser].launchPersistentContext(this.userDataDir, this.playwrightOptions) this.browserContext = this.browser const existingPages = await this.browserContext.pages() mainPage = existingPages[0] @@ -573,6 +558,15 @@ class Playwright extends Helper { await this._setPage(mainPage) + try { + // set metadata for reporting + test.meta.browser = this.browser.browserType().name() + test.meta.browserVersion = this.browser.version() + test.meta.windowSize = `${this.page.viewportSize().width}x${this.page.viewportSize().height}` + } catch (e) { + this.debug('Failed to set metadata for reporting') + } + if (this.options.trace) await this.browserContext.tracing.start({ screenshots: true, snapshots: true }) return this.browser @@ -583,7 +577,7 @@ class Playwright extends Helper { if (this.isElectron) { this.browser.close() - this.electronSessions.forEach((session) => session.close()) + this.electronSessions.forEach(session => session.close()) return } @@ -605,7 +599,7 @@ class Playwright extends Helper { this.storageState = await currentContext.storageState() } - await Promise.all(contexts.map((c) => c.close())) + await Promise.all(contexts.map(c => c.close())) } } catch (e) { console.log(e) @@ -641,10 +635,7 @@ class Playwright extends Helper { page = await browserContext.newPage() } catch (e) { if (this.playwrightOptions.userDataDir) { - browserContext = await playwright[this.options.browser].launchPersistentContext( - `${this.userDataDir}_${this.activeSessionName}`, - this.playwrightOptions, - ) + browserContext = await playwright[this.options.browser].launchPersistentContext(`${this.userDataDir}_${this.activeSessionName}`, this.playwrightOptions) this.browser = browserContext page = await browserContext.pages()[0] } @@ -660,7 +651,7 @@ class Playwright extends Helper { stop: async () => { // is closed by _after }, - loadVars: async (context) => { + loadVars: async context => { if (context) { this.browserContext = context const existingPages = await context.pages() @@ -668,7 +659,7 @@ class Playwright extends Helper { return this._setPage(this.sessionPages[this.activeSessionName]) } }, - restoreVars: async (session) => { + restoreVars: async session => { this.withinLocator = null this.browserContext = defaultContext @@ -793,7 +784,7 @@ class Playwright extends Helper { return } page.removeAllListeners('dialog') - page.on('dialog', async (dialog) => { + page.on('dialog', async dialog => { popupStore.popup = dialog const action = popupStore.actionType || this.options.defaultPopupAction await this._waitForAction() @@ -856,16 +847,13 @@ class Playwright extends Helper { throw err } } else if (this.playwrightOptions.userDataDir) { - this.browser = await playwright[this.options.browser].launchPersistentContext( - this.userDataDir, - this.playwrightOptions, - ) + this.browser = await playwright[this.options.browser].launchPersistentContext(this.userDataDir, this.playwrightOptions) } else { this.browser = await playwright[this.options.browser].launch(this.playwrightOptions) } // works only for Chromium - this.browser.on('targetchanged', (target) => { + this.browser.on('targetchanged', target => { this.debugSection('Url', target.url()) }) @@ -940,7 +928,7 @@ class Playwright extends Helper { const navigationStart = timing.navigationStart const extractedData = {} - dataNames.forEach((name) => { + dataNames.forEach(name => { extractedData[name] = timing[name] - navigationStart }) @@ -955,7 +943,8 @@ class Playwright extends Helper { throw new Error('Cannot open pages inside an Electron container') } if (!/^\w+\:(\/\/|.+)/.test(url)) { - url = this.options.url + (url.startsWith('/') ? url : `/${url}`) + url = this.options.url + (!this.options.url.endsWith('/') && url.startsWith('/') ? url : `/${url}`) + this.debug(`Changed URL to base url + relative path: ${url}`) } if (this.options.basicAuth && this.isAuthenticated !== true) { @@ -969,13 +958,7 @@ class Playwright extends Helper { const performanceTiming = JSON.parse(await this.page.evaluate(() => JSON.stringify(window.performance.timing))) - perfTiming = this._extractDataFromPerformanceTiming( - performanceTiming, - 'responseEnd', - 'domInteractive', - 'domContentLoadedEventEnd', - 'loadEventEnd', - ) + perfTiming = this._extractDataFromPerformanceTiming(performanceTiming, 'responseEnd', 'domInteractive', 'domContentLoadedEventEnd', 'loadEventEnd') return this._waitForAction() } @@ -1197,10 +1180,7 @@ class Playwright extends Helper { return this.executeScript(() => { const body = document.body const html = document.documentElement - window.scrollTo( - 0, - Math.max(body.scrollHeight, body.offsetHeight, html.clientHeight, html.scrollHeight, html.offsetHeight), - ) + window.scrollTo(0, Math.max(body.scrollHeight, body.offsetHeight, html.clientHeight, html.scrollHeight, html.offsetHeight)) }) } @@ -1287,7 +1267,22 @@ class Playwright extends Helper { if (this.frame) return findElements(this.frame, locator) - return findElements(context, locator) + const els = await findElements(context, locator) + + if (store.debugMode) { + const previewElements = els.slice(0, 3) + let htmls = await Promise.all(previewElements.map(el => elToString(el, previewElements.length))) + if (els.length > 3) htmls.push('...') + if (els.length > 1) { + this.debugSection(`Elements (${els.length})`, htmls.join('|').trim()) + } else if (els.length === 1) { + this.debugSection('Element', htmls.join('|').trim()) + } else { + this.debug(`No elements found by ${JSON.stringify(locator).slice(0, 50)}....`) + } + } + + return els } /** @@ -1437,10 +1432,10 @@ class Playwright extends Helper { */ async closeOtherTabs() { const pages = await this.browserContext.pages() - const otherPages = pages.filter((page) => page !== this.page) + const otherPages = pages.filter(page => page !== this.page) if (otherPages.length) { this.debug(`Closing ${otherPages.length} tabs`) - return Promise.all(otherPages.map((p) => p.close())) + return Promise.all(otherPages.map(p => p.close())) } return Promise.resolve() } @@ -1483,9 +1478,9 @@ class Playwright extends Helper { */ async seeElement(locator) { let els = await this._locate(locator) - els = await Promise.all(els.map((el) => el.isVisible())) + els = await Promise.all(els.map(el => el.isVisible())) try { - return empty('visible elements').negate(els.filter((v) => v).fill('ELEMENT')) + return empty('visible elements').negate(els.filter(v => v).fill('ELEMENT')) } catch (e) { dontSeeElementError(locator) } @@ -1497,9 +1492,9 @@ class Playwright extends Helper { */ async dontSeeElement(locator) { let els = await this._locate(locator) - els = await Promise.all(els.map((el) => el.isVisible())) + els = await Promise.all(els.map(el => el.isVisible())) try { - return empty('visible elements').assert(els.filter((v) => v).fill('ELEMENT')) + return empty('visible elements').assert(els.filter(v => v).fill('ELEMENT')) } catch (e) { seeElementError(locator) } @@ -1511,7 +1506,7 @@ class Playwright extends Helper { async seeElementInDOM(locator) { const els = await this._locate(locator) try { - return empty('elements on page').negate(els.filter((v) => v).fill('ELEMENT')) + return empty('elements on page').negate(els.filter(v => v).fill('ELEMENT')) } catch (e) { dontSeeElementInDOMError(locator) } @@ -1523,7 +1518,7 @@ class Playwright extends Helper { async dontSeeElementInDOM(locator) { const els = await this._locate(locator) try { - return empty('elements on a page').assert(els.filter((v) => v).fill('ELEMENT')) + return empty('elements on a page').assert(els.filter(v => v).fill('ELEMENT')) } catch (e) { seeElementInDOMError(locator) } @@ -1547,7 +1542,7 @@ class Playwright extends Helper { * @return {Promise} */ async handleDownloads(fileName) { - this.page.waitForEvent('download').then(async (download) => { + this.page.waitForEvent('download').then(async download => { const filePath = await download.path() fileName = fileName || `downloads/${path.basename(filePath)}` @@ -1741,6 +1736,7 @@ class Playwright extends Helper { const el = els[0] await el.clear() + if (store.debugMode) this.debugSection('Focused', await elToString(el, 1)) await highlightActiveElement.call(this, el) @@ -1852,8 +1848,8 @@ class Playwright extends Helper { */ async grabNumberOfVisibleElements(locator) { let els = await this._locate(locator) - els = await Promise.all(els.map((el) => el.isVisible())) - return els.filter((v) => v).length + els = await Promise.all(els.map(el => el.isVisible())) + return els.filter(v => v).length } /** @@ -1963,9 +1959,7 @@ class Playwright extends Helper { */ async seeNumberOfElements(locator, num) { const elements = await this._locate(locator) - return equals( - `expected number of elements (${new Locator(locator)}) is ${num}, but found ${elements.length}`, - ).assert(elements.length, num) + return equals(`expected number of elements (${new Locator(locator)}) is ${num}, but found ${elements.length}`).assert(elements.length, num) } /** @@ -1975,10 +1969,7 @@ class Playwright extends Helper { */ async seeNumberOfVisibleElements(locator, num) { const res = await this.grabNumberOfVisibleElements(locator) - return equals(`expected number of visible elements (${new Locator(locator)}) is ${num}, but found ${res}`).assert( - res, - num, - ) + return equals(`expected number of visible elements (${new Locator(locator)}) is ${num}, but found ${res}`).assert(res, num) } /** @@ -1997,7 +1988,7 @@ class Playwright extends Helper { */ async seeCookie(name) { const cookies = await this.browserContext.cookies() - empty(`cookie ${name} to be set`).negate(cookies.filter((c) => c.name === name)) + empty(`cookie ${name} to be set`).negate(cookies.filter(c => c.name === name)) } /** @@ -2005,7 +1996,7 @@ class Playwright extends Helper { */ async dontSeeCookie(name) { const cookies = await this.browserContext.cookies() - empty(`cookie ${name} not to be set`).assert(cookies.filter((c) => c.name === name)) + empty(`cookie ${name} not to be set`).assert(cookies.filter(c => c.name === name)) } /** @@ -2016,17 +2007,18 @@ class Playwright extends Helper { async grabCookie(name) { const cookies = await this.browserContext.cookies() if (!name) return cookies - const cookie = cookies.filter((c) => c.name === name) + const cookie = cookies.filter(c => c.name === name) if (cookie[0]) return cookie[0] } /** * {{> clearCookie }} */ - async clearCookie() { - // Playwright currently doesn't support to delete a certain cookie - // https://github.com/microsoft/playwright/blob/main/docs/src/api/class-browsercontext.md#async-method-browsercontextclearcookies + async clearCookie(cookieName) { if (!this.browserContext) return + if (cookieName) { + return this.browserContext.clearCookies({ name: cookieName }) + } return this.browserContext.clearCookies() } @@ -2098,7 +2090,7 @@ class Playwright extends Helper { const els = await this._locate(locator) const texts = [] for (const el of els) { - texts.push(await await el.innerText()) + texts.push(await el.innerText()) } this.debug(`Matched ${els.length} elements`) return texts @@ -2120,7 +2112,7 @@ class Playwright extends Helper { async grabValueFromAll(locator) { const els = await findFields.call(this, locator) this.debug(`Matched ${els.length} elements`) - return Promise.all(els.map((el) => el.inputValue())) + return Promise.all(els.map(el => el.inputValue())) } /** @@ -2139,7 +2131,7 @@ class Playwright extends Helper { async grabHTMLFromAll(locator) { const els = await this._locate(locator) this.debug(`Matched ${els.length} elements`) - return Promise.all(els.map((el) => el.innerHTML())) + return Promise.all(els.map(el => el.innerHTML())) } /** @@ -2160,11 +2152,7 @@ class Playwright extends Helper { async grabCssPropertyFromAll(locator, cssProperty) { const els = await this._locate(locator) this.debug(`Matched ${els.length} elements`) - const cssValues = await Promise.all( - els.map((el) => - el.evaluate((el, cssProperty) => getComputedStyle(el).getPropertyValue(cssProperty), cssProperty), - ), - ) + const cssValues = await Promise.all(els.map(el => el.evaluate((el, cssProperty) => getComputedStyle(el).getPropertyValue(cssProperty), cssProperty))) return cssValues } @@ -2192,19 +2180,16 @@ class Playwright extends Helper { } } - const values = Object.keys(cssPropertiesCamelCase).map((key) => cssPropertiesCamelCase[key]) + const values = Object.keys(cssPropertiesCamelCase).map(key => cssPropertiesCamelCase[key]) if (!Array.isArray(props)) props = [props] let chunked = chunkArray(props, values.length) - chunked = chunked.filter((val) => { + chunked = chunked.filter(val => { for (let i = 0; i < val.length; ++i) { - // eslint-disable-next-line eqeqeq if (val[i] != values[i]) return false } return true }) - return equals( - `all elements (${new Locator(locator)}) to have CSS property ${JSON.stringify(cssProperties)}`, - ).assert(chunked.length, elemAmount) + return equals(`all elements (${new Locator(locator)}) to have CSS property ${JSON.stringify(cssProperties)}`).assert(chunked.length, elemAmount) } /** @@ -2217,16 +2202,16 @@ class Playwright extends Helper { const elemAmount = res.length const commands = [] - res.forEach((el) => { - Object.keys(attributes).forEach((prop) => { + res.forEach(el => { + Object.keys(attributes).forEach(prop => { commands.push(el.evaluate((el, attr) => el[attr] || el.getAttribute(attr), prop)) }) }) let attrs = await Promise.all(commands) - const values = Object.keys(attributes).map((key) => attributes[key]) + const values = Object.keys(attributes).map(key => attributes[key]) if (!Array.isArray(attrs)) attrs = [attrs] let chunked = chunkArray(attrs, values.length) - chunked = chunked.filter((val) => { + chunked = chunked.filter(val => { for (let i = 0; i < val.length; ++i) { // the attribute could be a boolean if (typeof val[i] === 'boolean') return val[i] === values[i] @@ -2235,10 +2220,7 @@ class Playwright extends Helper { } return true }) - return equals(`all elements (${new Locator(locator)}) to have attributes ${JSON.stringify(attributes)}`).assert( - chunked.length, - elemAmount, - ) + return equals(`all elements (${new Locator(locator)}) to have attributes ${JSON.stringify(attributes)}`).assert(chunked.length, elemAmount) } /** @@ -2311,7 +2293,7 @@ class Playwright extends Helper { const fullPageOption = fullPage || this.options.fullPageScreenshots let outputFile = screenshotOutputFolder(fileName) - this.debug(`Screenshot is saving to ${outputFile}`) + this.debugSection('Screenshot', relativeDir(outputFile)) await this.page.screenshot({ path: outputFile, @@ -2324,7 +2306,7 @@ class Playwright extends Helper { const activeSessionPage = this.sessionPages[sessionName] outputFile = screenshotOutputFolder(`${sessionName}_${fileName}`) - this.debug(`${sessionName} - Screenshot is saving to ${outputFile}`) + this.debugSection('Screenshot', `${sessionName} - ${relativeDir(outputFile)}`) if (activeSessionPage) { await activeSessionPage.screenshot({ @@ -2358,9 +2340,7 @@ class Playwright extends Helper { method = method.toLowerCase() const allowedMethods = ['get', 'post', 'patch', 'head', 'fetch', 'delete'] if (!allowedMethods.includes(method)) { - throw new Error( - `Method ${method} is not allowed, use the one from a list ${allowedMethods} or switch to using REST helper`, - ) + throw new Error(`Method ${method} is not allowed, use the one from a list ${allowedMethods} or switch to using REST helper`) } if (url.startsWith('/')) { @@ -2397,10 +2377,7 @@ class Playwright extends Helper { if (this.options.recordVideo && this.page && this.page.video()) { test.artifacts.video = saveVideoForPage(this.page, `${test.title}.failed`) for (const sessionName in this.sessionPages) { - test.artifacts[`video_${sessionName}`] = saveVideoForPage( - this.sessionPages[sessionName], - `${test.title}_${sessionName}.failed`, - ) + test.artifacts[`video_${sessionName}`] = saveVideoForPage(this.sessionPages[sessionName], `${test.title}_${sessionName}.failed`) } } @@ -2408,10 +2385,7 @@ class Playwright extends Helper { test.artifacts.trace = await saveTraceForContext(this.browserContext, `${test.title}.failed`) for (const sessionName in this.sessionPages) { if (!this.sessionPages[sessionName].context) continue - test.artifacts[`trace_${sessionName}`] = await saveTraceForContext( - this.sessionPages[sessionName].context, - `${test.title}_${sessionName}.failed`, - ) + test.artifacts[`trace_${sessionName}`] = await saveTraceForContext(this.sessionPages[sessionName].context, `${test.title}_${sessionName}.failed`) } } @@ -2425,16 +2399,13 @@ class Playwright extends Helper { if (this.options.keepVideoForPassedTests) { test.artifacts.video = saveVideoForPage(this.page, `${test.title}.passed`) for (const sessionName of Object.keys(this.sessionPages)) { - test.artifacts[`video_${sessionName}`] = saveVideoForPage( - this.sessionPages[sessionName], - `${test.title}_${sessionName}.passed`, - ) + test.artifacts[`video_${sessionName}`] = saveVideoForPage(this.sessionPages[sessionName], `${test.title}_${sessionName}.passed`) } } else { this.page .video() .delete() - .catch((e) => {}) + .catch(e => {}) } } @@ -2444,10 +2415,7 @@ class Playwright extends Helper { test.artifacts.trace = await saveTraceForContext(this.browserContext, `${test.title}.passed`) for (const sessionName in this.sessionPages) { if (!this.sessionPages[sessionName].context) continue - test.artifacts[`trace_${sessionName}`] = await saveTraceForContext( - this.sessionPages[sessionName].context, - `${test.title}_${sessionName}.passed`, - ) + test.artifacts[`trace_${sessionName}`] = await saveTraceForContext(this.sessionPages[sessionName].context, `${test.title}_${sessionName}.passed`) } } } else { @@ -2464,7 +2432,7 @@ class Playwright extends Helper { * {{> wait }} */ async wait(sec) { - return new Promise((done) => { + return new Promise(done => { setTimeout(done, sec * 1000) }) } @@ -2480,20 +2448,18 @@ class Playwright extends Helper { const context = await this._getContext() if (!locator.isXPath()) { const valueFn = function ([locator]) { - return Array.from(document.querySelectorAll(locator)).filter((el) => !el.disabled).length > 0 + return Array.from(document.querySelectorAll(locator)).filter(el => !el.disabled).length > 0 } waiter = context.waitForFunction(valueFn, [locator.value], { timeout: waitTimeout }) } else { const enabledFn = function ([locator, $XPath]) { - eval($XPath) // eslint-disable-line no-eval - return $XPath(null, locator).filter((el) => !el.disabled).length > 0 + eval($XPath) + return $XPath(null, locator).filter(el => !el.disabled).length > 0 } waiter = context.waitForFunction(enabledFn, [locator.value, $XPath.toString()], { timeout: waitTimeout }) } - return waiter.catch((err) => { - throw new Error( - `element (${locator.toString()}) still not enabled after ${waitTimeout / 1000} sec\n${err.message}`, - ) + return waiter.catch(err => { + throw new Error(`element (${locator.toString()}) still not enabled after ${waitTimeout / 1000} sec\n${err.message}`) }) } @@ -2508,20 +2474,18 @@ class Playwright extends Helper { const context = await this._getContext() if (!locator.isXPath()) { const valueFn = function ([locator]) { - return Array.from(document.querySelectorAll(locator)).filter((el) => el.disabled).length > 0 + return Array.from(document.querySelectorAll(locator)).filter(el => el.disabled).length > 0 } waiter = context.waitForFunction(valueFn, [locator.value], { timeout: waitTimeout }) } else { const disabledFn = function ([locator, $XPath]) { - eval($XPath) // eslint-disable-line no-eval - return $XPath(null, locator).filter((el) => el.disabled).length > 0 + eval($XPath) + return $XPath(null, locator).filter(el => el.disabled).length > 0 } waiter = context.waitForFunction(disabledFn, [locator.value, $XPath.toString()], { timeout: waitTimeout }) } - return waiter.catch((err) => { - throw new Error( - `element (${locator.toString()}) is still enabled after ${waitTimeout / 1000} sec\n${err.message}`, - ) + return waiter.catch(err => { + throw new Error(`element (${locator.toString()}) is still enabled after ${waitTimeout / 1000} sec\n${err.message}`) }) } @@ -2536,26 +2500,21 @@ class Playwright extends Helper { const context = await this._getContext() if (!locator.isXPath()) { const valueFn = function ([locator, value]) { - return ( - Array.from(document.querySelectorAll(locator)).filter((el) => (el.value || '').indexOf(value) !== -1).length > - 0 - ) + return Array.from(document.querySelectorAll(locator)).filter(el => (el.value || '').indexOf(value) !== -1).length > 0 } waiter = context.waitForFunction(valueFn, [locator.value, value], { timeout: waitTimeout }) } else { const valueFn = function ([locator, $XPath, value]) { - eval($XPath) // eslint-disable-line no-eval - return $XPath(null, locator).filter((el) => (el.value || '').indexOf(value) !== -1).length > 0 + eval($XPath) + return $XPath(null, locator).filter(el => (el.value || '').indexOf(value) !== -1).length > 0 } waiter = context.waitForFunction(valueFn, [locator.value, $XPath.toString(), value], { timeout: waitTimeout, }) } - return waiter.catch((err) => { + return waiter.catch(err => { const loc = locator.toString() - throw new Error( - `element (${loc}) is not in DOM or there is no element(${loc}) with value "${value}" after ${waitTimeout / 1000} sec\n${err.message}`, - ) + throw new Error(`element (${loc}) is not in DOM or there is no element(${loc}) with value "${value}" after ${waitTimeout / 1000} sec\n${err.message}`) }) } @@ -2575,22 +2534,20 @@ class Playwright extends Helper { if (!els || els.length === 0) { return false } - return Array.prototype.filter.call(els, (el) => el.offsetParent !== null).length === num + return Array.prototype.filter.call(els, el => el.offsetParent !== null).length === num } waiter = context.waitForFunction(visibleFn, [locator.value, num], { timeout: waitTimeout }) } else { const visibleFn = function ([locator, $XPath, num]) { - eval($XPath) // eslint-disable-line no-eval - return $XPath(null, locator).filter((el) => el.offsetParent !== null).length === num + eval($XPath) + return $XPath(null, locator).filter(el => el.offsetParent !== null).length === num } waiter = context.waitForFunction(visibleFn, [locator.value, $XPath.toString(), num], { timeout: waitTimeout, }) } - return waiter.catch((err) => { - throw new Error( - `The number of elements (${locator.toString()}) is not ${num} after ${waitTimeout / 1000} sec\n${err.message}`, - ) + return waiter.catch(err => { + throw new Error(`The number of elements (${locator.toString()}) is not ${num} after ${waitTimeout / 1000} sec\n${err.message}`) }) } @@ -2598,9 +2555,7 @@ class Playwright extends Helper { * {{> waitForClickable }} */ async waitForClickable(locator, waitTimeout) { - console.log( - 'I.waitForClickable is DEPRECATED: This is no longer needed, Playwright automatically waits for element to be clickable', - ) + console.log('I.waitForClickable is DEPRECATED: This is no longer needed, Playwright automatically waits for element to be clickable') console.log('Remove usage of this function') } @@ -2616,9 +2571,7 @@ class Playwright extends Helper { try { await context.locator(buildLocatorString(locator)).first().waitFor({ timeout: waitTimeout, state: 'attached' }) } catch (e) { - throw new Error( - `element (${locator.toString()}) still not present on page after ${waitTimeout / 1000} sec\n${e.message}`, - ) + throw new Error(`element (${locator.toString()}) still not present on page after ${waitTimeout / 1000} sec\n${e.message}`) } } @@ -2710,10 +2663,8 @@ class Playwright extends Helper { .locator(buildLocatorString(locator)) .first() .waitFor({ timeout: waitTimeout, state: 'hidden' }) - .catch((err) => { - throw new Error( - `element (${locator.toString()}) still not hidden after ${waitTimeout / 1000} sec\n${err.message}`, - ) + .catch(err => { + throw new Error(`element (${locator.toString()}) still not hidden after ${waitTimeout / 1000} sec\n${err.message}`) }) } @@ -2739,6 +2690,9 @@ class Playwright extends Helper { if ((this.context && this.context.constructor.name === 'FrameLocator') || this.context) { return this.context } + if (this.frame) { + return this.frame + } return this.page } @@ -2750,14 +2704,14 @@ class Playwright extends Helper { return this.page .waitForFunction( - (urlPart) => { + urlPart => { const currUrl = decodeURIComponent(decodeURIComponent(decodeURIComponent(window.location.href))) return currUrl.indexOf(urlPart) > -1 }, urlPart, { timeout: waitTimeout }, ) - .catch(async (e) => { + .catch(async e => { const currUrl = await this._getPageUrl() // Required because the waitForFunction can't return data. if (/Timeout/i.test(e.message)) { throw new Error(`expected url to include ${urlPart}, but found ${currUrl}`) @@ -2780,14 +2734,14 @@ class Playwright extends Helper { return this.page .waitForFunction( - (urlPart) => { + urlPart => { const currUrl = decodeURIComponent(decodeURIComponent(decodeURIComponent(window.location.href))) return currUrl.indexOf(urlPart) > -1 }, urlPart, { timeout: waitTimeout }, ) - .catch(async (e) => { + .catch(async e => { const currUrl = await this._getPageUrl() // Required because the waitForFunction can't return data. if (/Timeout/i.test(e.message)) { throw new Error(`expected url to be ${urlPart}, but found ${currUrl}`) @@ -2803,28 +2757,23 @@ class Playwright extends Helper { async waitForText(text, sec = null, context = null) { const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout const errorMessage = `Text "${text}" was not found on page after ${waitTimeout / 1000} sec.` - let waiter const contextObject = await this._getContext() if (context) { const locator = new Locator(context, 'css') - if (!locator.isXPath()) { - try { - await contextObject + try { + if (!locator.isXPath()) { + return contextObject .locator(`${locator.isCustom() ? `${locator.type}=${locator.value}` : locator.simplify()} >> text=${text}`) .first() .waitFor({ timeout: waitTimeout, state: 'visible' }) - } catch (e) { - throw new Error(`${errorMessage}\n${e.message}`) } - } - if (locator.isXPath()) { - try { - await contextObject.waitForFunction( + if (locator.isXPath()) { + return contextObject.waitForFunction( ([locator, text, $XPath]) => { - eval($XPath) // eslint-disable-line no-eval + eval($XPath) const el = $XPath(null, locator) if (!el.length) return false return el[0].innerText.indexOf(text) > -1 @@ -2832,27 +2781,34 @@ class Playwright extends Helper { [locator.value, text, $XPath.toString()], { timeout: waitTimeout }, ) - } catch (e) { - throw new Error(`${errorMessage}\n${e.message}`) } + } catch (e) { + throw new Error(`${errorMessage}\n${e.message}`) } - } else { - // we have this as https://github.com/microsoft/playwright/issues/26829 is not yet implemented - - const _contextObject = this.frame ? this.frame : contextObject - let count = 0 - do { - waiter = await _contextObject - .locator(`:has-text(${JSON.stringify(text)})`) - .first() - .isVisible() - if (waiter) break - await this.wait(1) - count += 1000 - } while (count <= waitTimeout) - - if (!waiter) throw new Error(`${errorMessage}`) } + + const timeoutGap = waitTimeout + 1000 + + // We add basic timeout to make sure we don't wait forever + // We apply 2 strategies here: wait for text as innert text on page (wide strategy) - older + // or we use native Playwright matcher to wait for text in element (narrow strategy) - newer + // If a user waits for text on a page they are mostly expect it to be there, so wide strategy can be helpful even PW strategy is available + return Promise.race([ + new Promise((_, reject) => { + setTimeout(() => reject(errorMessage), waitTimeout) + }), + this.page.waitForFunction(text => document.body && document.body.innerText.indexOf(text) > -1, text, { timeout: timeoutGap }), + promiseRetry( + async retry => { + const textPresent = await contextObject + .locator(`:has-text(${JSON.stringify(text)})`) + .first() + .isVisible() + if (!textPresent) retry(errorMessage) + }, + { retries: 1000, minTimeout: 500, maxTimeout: 500, factor: 1 }, + ), + ]) } /** @@ -3021,11 +2977,11 @@ class Playwright extends Helper { } } else { const visibleFn = function ([locator, $XPath]) { - eval($XPath) // eslint-disable-line no-eval + eval($XPath) return $XPath(null, locator).length === 0 } waiter = context.waitForFunction(visibleFn, [locator.value, $XPath.toString()], { timeout: waitTimeout }) - return waiter.catch((err) => { + return waiter.catch(err => { throw new Error(`element (${locator.toString()}) still on page after ${waitTimeout / 1000} sec\n${err.message}`) }) } @@ -3047,9 +3003,9 @@ class Playwright extends Helper { return promiseRetry( async (retry, number) => { - const _grabCookie = async (name) => { + const _grabCookie = async name => { const cookies = await this.browserContext.cookies() - const cookie = cookies.filter((c) => c.name === name) + const cookie = cookies.filter(c => c.name === name) if (cookie.length === 0) throw Error(`Cookie ${name} is not found after ${retries}s`) } @@ -3128,7 +3084,7 @@ class Playwright extends Helper { this.recording = true this.recordedAtLeastOnce = true - this.page.on('requestfinished', async (request) => { + this.page.on('requestfinished', async request => { const information = { url: request.url(), method: request.method(), @@ -3167,20 +3123,20 @@ class Playwright extends Helper { */ blockTraffic(urls) { if (Array.isArray(urls)) { - urls.forEach((url) => { - this.page.route(url, (route) => { + urls.forEach(url => { + this.page.route(url, route => { route .abort() // Sometimes it happens that browser has been closed in the meantime. It is ok to ignore error then. - .catch((e) => {}) + .catch(e => {}) }) }) } else { - this.page.route(urls, (route) => { + this.page.route(urls, route => { route .abort() // Sometimes it happens that browser has been closed in the meantime. It is ok to ignore error then. - .catch((e) => {}) + .catch(e => {}) }) } } @@ -3209,8 +3165,8 @@ class Playwright extends Helper { urls = [urls] } - urls.forEach((url) => { - this.page.route(url, (route) => { + urls.forEach(url => { + this.page.route(url, route => { if (this.page.isClosed()) { // Sometimes it happens that browser has been closed in the meantime. // In this case we just don't fulfill to prevent error in test scenario. @@ -3256,13 +3212,10 @@ class Playwright extends Helper { */ grabTrafficUrl(urlMatch) { if (!this.recordedAtLeastOnce) { - throw new Error( - 'Failure in test automation. You use "I.grabTrafficUrl", but "I.startRecordingTraffic" was never called before.', - ) + throw new Error('Failure in test automation. You use "I.grabTrafficUrl", but "I.startRecordingTraffic" was never called before.') } for (const i in this.requests) { - // eslint-disable-next-line no-prototype-builtins if (this.requests.hasOwnProperty(i)) { const request = this.requests[i] @@ -3312,15 +3265,15 @@ class Playwright extends Helper { await this.cdpSession.send('Network.enable') await this.cdpSession.send('Page.enable') - this.cdpSession.on('Network.webSocketFrameReceived', (payload) => { + this.cdpSession.on('Network.webSocketFrameReceived', payload => { this._logWebsocketMessages(this._getWebSocketLog('RECEIVED', payload)) }) - this.cdpSession.on('Network.webSocketFrameSent', (payload) => { + this.cdpSession.on('Network.webSocketFrameSent', payload => { this._logWebsocketMessages(this._getWebSocketLog('SENT', payload)) }) - this.cdpSession.on('Network.webSocketFrameError', (payload) => { + this.cdpSession.on('Network.webSocketFrameError', payload => { this._logWebsocketMessages(this._getWebSocketLog('ERROR', payload)) }) } @@ -3344,9 +3297,7 @@ class Playwright extends Helper { grabWebSocketMessages() { if (!this.recordingWebSocketMessages) { if (!this.recordedWebSocketMessagesAtLeastOnce) { - throw new Error( - 'Failure in test automation. You use "I.grabWebSocketMessages", but "I.startRecordingWebSocketMessages" was never called before.', - ) + throw new Error('Failure in test automation. You use "I.grabWebSocketMessages", but "I.startRecordingWebSocketMessages" was never called before.') } } return this.webSocketMessages @@ -3493,17 +3444,13 @@ async function proceedClick(locator, context = null, options = {}) { } const els = await findClickable.call(this, matcher, locator) if (context) { - assertElementExists( - els, - locator, - 'Clickable element', - `was not found inside element ${new Locator(context).toString()}`, - ) + assertElementExists(els, locator, 'Clickable element', `was not found inside element ${new Locator(context).toString()}`) } else { assertElementExists(els, locator, 'Clickable element') } await highlightActiveElement.call(this, els[0]) + if (store.debugMode) this.debugSection('Clicked', await elToString(els[0], 1)) /* using the force true options itself but instead dispatching a click @@ -3565,16 +3512,18 @@ async function proceedSee(assertType, text, context, strict = false) { description = `element ${locator.toString()}` const els = await this._locate(locator) assertElementExists(els, locator.toString()) - allText = await Promise.all(els.map((el) => el.innerText())) + allText = await Promise.all(els.map(el => el.innerText())) + } + + if (store?.currentStep?.opts?.ignoreCase === true) { + text = text.toLowerCase() + allText = allText.map(elText => elText.toLowerCase()) } if (strict) { - return allText.map((elText) => equals(description)[assertType](text, elText)) + return allText.map(elText => equals(description)[assertType](text, elText)) } - return stringIncludes(description)[assertType]( - normalizeSpacesInString(text), - normalizeSpacesInString(allText.join(' | ')), - ) + return stringIncludes(description)[assertType](normalizeSpacesInString(text), normalizeSpacesInString(allText.join(' | '))) } async function findCheckable(locator, context) { @@ -3604,7 +3553,7 @@ async function findCheckable(locator, context) { async function proceedIsChecked(assertType, option) { let els = await findCheckable.call(this, option) assertElementExists(els, option, 'Checkable') - els = await Promise.all(els.map((el) => el.isChecked())) + els = await Promise.all(els.map(el => el.isChecked())) const selected = els.reduce((prev, cur) => prev || cur) return truth(`checkable ${option}`, 'to be checked')[assertType](selected) } @@ -3636,10 +3585,10 @@ async function proceedSeeInField(assertType, field, value) { const els = await findFields.call(this, field) assertElementExists(els, field, 'Field') const el = els[0] - const tag = await el.evaluate((e) => e.tagName) + const tag = await el.evaluate(e => e.tagName) const fieldType = await el.getAttribute('type') - const proceedMultiple = async (elements) => { + const proceedMultiple = async elements => { const fields = Array.isArray(elements) ? elements : [elements] const elementValues = [] @@ -3653,7 +3602,7 @@ async function proceedSeeInField(assertType, field, value) { if (assertType === 'assert') { equals(`select option by ${field}`)[assertType](true, elementValues.length > 0) } - elementValues.forEach((val) => stringIncludes(`fields by ${field}`)[assertType](value, val)) + elementValues.forEach(val => stringIncludes(`fields by ${field}`)[assertType](value, val)) } } @@ -3740,6 +3689,8 @@ function isFrameLocator(locator) { } function assertElementExists(res, locator, prefix, suffix) { + // if element text is an empty string, just exit this check + if (typeof res === 'string' && res === '') return if (!res || res.length === 0) { throw new ElementNotFound(locator, prefix, suffix) } @@ -3776,12 +3727,9 @@ async function targetCreatedHandler(page) { this.contextLocator = null }) }) - page.on('console', (msg) => { + page.on('console', msg => { if (!consoleLogStore.includes(msg) && this.options.ignoreLog && !this.options.ignoreLog.includes(msg.type())) { - this.debugSection( - `Browser:${ucfirst(msg.type())}`, - ((msg.text && msg.text()) || msg._text || '') + msg.args().join(' '), - ) + this.debugSection(`Browser:${ucfirst(msg.type())}`, ((msg.text && msg.text()) || msg._text || '') + msg.args().join(' ')) } consoleLogStore.add(msg) }) @@ -3889,7 +3837,7 @@ async function refreshContextSession() { const contexts = await this.browser.contexts() contexts.shift() - await Promise.all(contexts.map((c) => c.close())) + await Promise.all(contexts.map(c => c.close())) } catch (e) { console.log(e) } @@ -3908,10 +3856,10 @@ async function refreshContextSession() { const currentUrl = await this.grabCurrentUrl() if (currentUrl.startsWith('http')) { - await this.executeScript('localStorage.clear();').catch((err) => { + await this.executeScript('localStorage.clear();').catch(err => { if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err }) - await this.executeScript('sessionStorage.clear();').catch((err) => { + await this.executeScript('sessionStorage.clear();').catch(err => { if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err }) } @@ -3941,11 +3889,22 @@ async function saveTraceForContext(context, name) { } async function highlightActiveElement(element) { - if (this.options.highlightElement && global.debugMode) { - await element.evaluate((el) => { + if ((this.options.highlightElement || store.onPause) && store.debugMode) { + await element.evaluate(el => { const prevStyle = el.style.boxShadow - el.style.boxShadow = '0px 0px 4px 3px rgba(255, 0, 0, 0.7)' + el.style.boxShadow = '0px 0px 4px 3px rgba(147, 51, 234, 0.8)' // Bright purple that works on both dark/light modes setTimeout(() => (el.style.boxShadow = prevStyle), 2000) }) } } + +async function elToString(el, numberOfElements) { + const html = await el.evaluate(node => node.outerHTML) + return ( + html + .replace(/\n/g, '') + .replace(/\s+/g, ' ') + .substring(0, 100 / numberOfElements) + .trim() + '...' + ) +} diff --git a/lib/helper/Protractor.js b/lib/helper/Protractor.js index 0fab33d11..d547ff62e 100644 --- a/lib/helper/Protractor.js +++ b/lib/helper/Protractor.js @@ -117,9 +117,7 @@ class Protractor extends Helper { this.isRunning = false this._setConfig(config) - console.log( - 'Protractor helper is deprecated as well as Protractor itself.\nThis helper will be removed in next major release', - ) + console.log('Protractor helper is deprecated as well as Protractor itself.\nThis helper will be removed in next major release') } _validateConfig(config) { @@ -152,7 +150,7 @@ class Protractor extends Helper { } async _init() { - process.on('unhandledRejection', (reason) => { + process.on('unhandledRejection', reason => { if (reason.message.indexOf('ECONNREFUSED') > 0) { this.browser = null } @@ -288,9 +286,7 @@ class Protractor extends Helper { if (frame) { if (Array.isArray(frame)) { withinStore.frame = frame.join('>') - return this.switchTo(null).then(() => - frame.reduce((p, frameLocator) => p.then(() => this.switchTo(frameLocator)), Promise.resolve()), - ) + return this.switchTo(null).then(() => frame.reduce((p, frameLocator) => p.then(() => this.switchTo(frameLocator)), Promise.resolve())) } withinStore.frame = frame return this.switchTo(locator) @@ -300,8 +296,8 @@ class Protractor extends Helper { const context = await global.element(guessLocator(locator) || global.by.css(locator)) if (!context) throw new ElementNotFound(locator) - this.browser.findElement = (l) => (l ? context.element(l).getWebElement() : context.getWebElement()) - this.browser.findElements = (l) => context.all(l).getWebElements() + this.browser.findElement = l => (l ? context.element(l).getWebElement() : context.getWebElement()) + this.browser.findElements = l => context.all(l).getWebElements() return context } @@ -320,7 +316,7 @@ class Protractor extends Helper { _session() { const defaultSession = this.browser return { - start: async (opts) => { + start: async opts => { opts = this._validateConfig(Object.assign(this.options, opts)) this.debugSection('New Browser', JSON.stringify(opts)) const runner = new Runner(opts) @@ -331,10 +327,10 @@ class Protractor extends Helper { await browser.manage().window().setSize(parseInt(res[0], 10), parseInt(res[1], 10)) return browser.ready }, - stop: async (browser) => { + stop: async browser => { return browser.close() }, - loadVars: async (browser) => { + loadVars: async browser => { if (isWithin()) throw new Error("Can't start session inside within block") this.browser = browser loadGlobals(this.browser) @@ -573,7 +569,7 @@ class Protractor extends Helper { if (!els.length) { els = await field.findElements(global.by.xpath(Locator.select.byValue(opt))) } - els.forEach((el) => promises.push(el.click())) + els.forEach(el => promises.push(el.click())) } return Promise.all(promises) @@ -740,7 +736,7 @@ class Protractor extends Helper { const els = await this._locate(locator) const html = await Promise.all( - els.map((el) => { + els.map(el => { return this.browser.executeScript('return arguments[0].innerHTML;', el) }), ) @@ -766,7 +762,7 @@ class Protractor extends Helper { */ async grabValueFromAll(locator) { const els = await findFields(this.browser, locator) - const values = await Promise.all(els.map((el) => el.getAttribute('value'))) + const values = await Promise.all(els.map(el => el.getAttribute('value'))) return values } @@ -789,7 +785,7 @@ class Protractor extends Helper { */ async grabCssPropertyFromAll(locator, cssProperty) { const els = await this._locate(locator, true) - const values = await Promise.all(els.map((el) => el.getCssValue(cssProperty))) + const values = await Promise.all(els.map(el => el.getCssValue(cssProperty))) return values } @@ -839,7 +835,7 @@ class Protractor extends Helper { * {{> seeInTitle }} */ async seeInTitle(text) { - return this.browser.getTitle().then((title) => stringIncludes('web page title').assert(text, title)) + return this.browser.getTitle().then(title => stringIncludes('web page title').assert(text, title)) } /** @@ -854,14 +850,14 @@ class Protractor extends Helper { * {{> dontSeeInTitle }} */ async dontSeeInTitle(text) { - return this.browser.getTitle().then((title) => stringIncludes('web page title').negate(text, title)) + return this.browser.getTitle().then(title => stringIncludes('web page title').negate(text, title)) } /** * {{> grabTitle }} */ async grabTitle() { - return this.browser.getTitle().then((title) => { + return this.browser.getTitle().then(title => { this.debugSection('Title', title) return title }) @@ -872,8 +868,8 @@ class Protractor extends Helper { */ async seeElement(locator) { let els = await this._locate(locator, true) - els = await Promise.all(els.map((el) => el.isDisplayed())) - return empty('elements').negate(els.filter((v) => v).fill('ELEMENT')) + els = await Promise.all(els.map(el => el.isDisplayed())) + return empty('elements').negate(els.filter(v => v).fill('ELEMENT')) } /** @@ -881,33 +877,29 @@ class Protractor extends Helper { */ async dontSeeElement(locator) { let els = await this._locate(locator, false) - els = await Promise.all(els.map((el) => el.isDisplayed())) - return empty('elements').assert(els.filter((v) => v).fill('ELEMENT')) + els = await Promise.all(els.map(el => el.isDisplayed())) + return empty('elements').assert(els.filter(v => v).fill('ELEMENT')) } /** * {{> seeElementInDOM }} */ async seeElementInDOM(locator) { - return this.browser - .findElements(guessLocator(locator) || global.by.css(locator)) - .then((els) => empty('elements').negate(els.fill('ELEMENT'))) + return this.browser.findElements(guessLocator(locator) || global.by.css(locator)).then(els => empty('elements').negate(els.fill('ELEMENT'))) } /** * {{> dontSeeElementInDOM }} */ async dontSeeElementInDOM(locator) { - return this.browser - .findElements(guessLocator(locator) || global.by.css(locator)) - .then((els) => empty('elements').assert(els.fill('ELEMENT'))) + return this.browser.findElements(guessLocator(locator) || global.by.css(locator)).then(els => empty('elements').assert(els.fill('ELEMENT'))) } /** * {{> seeInSource }} */ async seeInSource(text) { - return this.browser.getPageSource().then((source) => stringIncludes('HTML source of a page').assert(text, source)) + return this.browser.getPageSource().then(source => stringIncludes('HTML source of a page').assert(text, source)) } /** @@ -921,7 +913,7 @@ class Protractor extends Helper { * {{> dontSeeInSource }} */ async dontSeeInSource(text) { - return this.browser.getPageSource().then((source) => stringIncludes('HTML source of a page').negate(text, source)) + return this.browser.getPageSource().then(source => stringIncludes('HTML source of a page').negate(text, source)) } /** @@ -929,9 +921,7 @@ class Protractor extends Helper { */ async seeNumberOfElements(locator, num) { const elements = await this._locate(locator) - return equals( - `expected number of elements (${new Locator(locator)}) is ${num}, but found ${elements.length}`, - ).assert(elements.length, num) + return equals(`expected number of elements (${new Locator(locator)}) is ${num}, but found ${elements.length}`).assert(elements.length, num) } /** @@ -939,10 +929,7 @@ class Protractor extends Helper { */ async seeNumberOfVisibleElements(locator, num) { const res = await this.grabNumberOfVisibleElements(locator) - return equals(`expected number of visible elements (${new Locator(locator)}) is ${num}, but found ${res}`).assert( - res, - num, - ) + return equals(`expected number of visible elements (${new Locator(locator)}) is ${num}, but found ${res}`).assert(res, num) } /** @@ -950,7 +937,7 @@ class Protractor extends Helper { */ async grabNumberOfVisibleElements(locator) { let els = await this._locate(locator) - els = await Promise.all(els.map((el) => el.isDisplayed())) + els = await Promise.all(els.map(el => el.isDisplayed())) return els.length } @@ -964,11 +951,11 @@ class Protractor extends Helper { const cssPropertiesCamelCase = convertCssPropertiesToCamelCase(cssProperties) const attributeNames = Object.keys(cssPropertiesCamelCase) - const expectedValues = attributeNames.map((name) => cssPropertiesCamelCase[name]) + const expectedValues = attributeNames.map(name => cssPropertiesCamelCase[name]) const missingAttributes = [] for (const el of els) { - const attributeValues = await Promise.all(attributeNames.map((attr) => el.getCssValue(attr))) + const attributeValues = await Promise.all(attributeNames.map(attr => el.getCssValue(attr))) const missing = attributeValues.filter((actual, i) => { const prop = attributeNames[i] @@ -982,9 +969,7 @@ class Protractor extends Helper { missingAttributes.push(...missing) } } - return equals( - `all elements (${new Locator(locator)}) to have CSS property ${JSON.stringify(cssProperties)}`, - ).assert(missingAttributes.length, 0) + return equals(`all elements (${new Locator(locator)}) to have CSS property ${JSON.stringify(cssProperties)}`).assert(missingAttributes.length, 0) } /** @@ -995,11 +980,11 @@ class Protractor extends Helper { assertElementExists(els, locator) const attributeNames = Object.keys(attributes) - const expectedValues = attributeNames.map((name) => attributes[name]) + const expectedValues = attributeNames.map(name => attributes[name]) const missingAttributes = [] for (const el of els) { - const attributeValues = await Promise.all(attributeNames.map((attr) => el.getAttribute(attr))) + const attributeValues = await Promise.all(attributeNames.map(attr => el.getAttribute(attr))) const missing = attributeValues.filter((actual, i) => { if (expectedValues[i] instanceof RegExp) { return expectedValues[i].test(actual) @@ -1011,10 +996,7 @@ class Protractor extends Helper { } } - return equals(`all elements (${new Locator(locator)}) to have attributes ${JSON.stringify(attributes)}`).assert( - missingAttributes.length, - 0, - ) + return equals(`all elements (${new Locator(locator)}) to have attributes ${JSON.stringify(attributes)}`).assert(missingAttributes.length, 0) } /** @@ -1036,28 +1018,28 @@ class Protractor extends Helper { * {{> seeInCurrentUrl }} */ async seeInCurrentUrl(url) { - return this.browser.getCurrentUrl().then((currentUrl) => stringIncludes('url').assert(url, currentUrl)) + return this.browser.getCurrentUrl().then(currentUrl => stringIncludes('url').assert(url, currentUrl)) } /** * {{> dontSeeInCurrentUrl }} */ async dontSeeInCurrentUrl(url) { - return this.browser.getCurrentUrl().then((currentUrl) => stringIncludes('url').negate(url, currentUrl)) + return this.browser.getCurrentUrl().then(currentUrl => stringIncludes('url').negate(url, currentUrl)) } /** * {{> seeCurrentUrlEquals }} */ async seeCurrentUrlEquals(url) { - return this.browser.getCurrentUrl().then((currentUrl) => urlEquals(this.options.url).assert(url, currentUrl)) + return this.browser.getCurrentUrl().then(currentUrl => urlEquals(this.options.url).assert(url, currentUrl)) } /** * {{> dontSeeCurrentUrlEquals }} */ async dontSeeCurrentUrlEquals(url) { - return this.browser.getCurrentUrl().then((currentUrl) => urlEquals(this.options.url).negate(url, currentUrl)) + return this.browser.getCurrentUrl().then(currentUrl => urlEquals(this.options.url).negate(url, currentUrl)) } /** @@ -1072,7 +1054,7 @@ class Protractor extends Helper { const stream = fs.createWriteStream(outputFile) stream.write(Buffer.from(png, 'base64')) stream.end() - return new Promise((resolve) => stream.on('finish', resolve)) // eslint-disable-line no-promise-executor-return + return new Promise(resolve => stream.on('finish', resolve)) } const res = await this._locate(locator) @@ -1095,7 +1077,7 @@ class Protractor extends Helper { const stream = fs.createWriteStream(outputFile) stream.write(Buffer.from(png, 'base64')) stream.end() - return new Promise((resolve) => stream.on('finish', resolve)) // eslint-disable-line no-promise-executor-return + return new Promise(resolve => stream.on('finish', resolve)) } if (!fullPage) { @@ -1134,7 +1116,7 @@ class Protractor extends Helper { return this.browser .manage() .getCookie(name) - .then((res) => truth(`cookie ${name}`, 'to be set').assert(res)) + .then(res => truth(`cookie ${name}`, 'to be set').assert(res)) } /** @@ -1144,7 +1126,7 @@ class Protractor extends Helper { return this.browser .manage() .getCookie(name) - .then((res) => truth(`cookie ${name}`, 'to be set').negate(res)) + .then(res => truth(`cookie ${name}`, 'to be set').negate(res)) } /** @@ -1242,11 +1224,11 @@ class Protractor extends Helper { const handles = await client.getAllWindowHandles() const currentHandle = await client.getWindowHandle() - const otherHandles = handles.filter((handle) => handle !== currentHandle) + const otherHandles = handles.filter(handle => handle !== currentHandle) if (!otherHandles || !otherHandles.length) return let p = Promise.resolve() - otherHandles.forEach((handle) => { + otherHandles.forEach(handle => { p = p.then(() => client .switchTo() @@ -1393,7 +1375,7 @@ class Protractor extends Helper { async waitForDetached(locator, sec = null) { const aSec = sec || this.options.waitForTimeoutInSeconds const el = global.element(guessLocator(locator) || global.by.css(locator)) - return this.browser.wait(EC.not(EC.presenceOf(el)), aSec * 1000).catch((err) => { + return this.browser.wait(EC.not(EC.presenceOf(el)), aSec * 1000).catch(err => { if (err.message && err.message.indexOf('Wait timed out after') > -1) { throw new Error(`element (${JSON.stringify(locator)}) still on page after ${sec} sec`) } else throw err @@ -1453,9 +1435,9 @@ class Protractor extends Helper { return function () { return global.element .all(loc) - .filter((el) => el.isDisplayed()) + .filter(el => el.isDisplayed()) .count() - .then((count) => count === expectedCount) + .then(count => count === expectedCount) } } @@ -1485,22 +1467,20 @@ class Protractor extends Helper { async waitForValue(field, value, sec = null) { const aSec = sec || this.options.waitForTimeoutInSeconds - const valueToBeInElementValue = (loc) => { + const valueToBeInElementValue = loc => { return async () => { const els = await findFields(this.browser, loc) if (!els) { return false } - const values = await Promise.all(els.map((el) => el.getAttribute('value'))) - return values.filter((part) => part.indexOf(value) >= 0).length > 0 + const values = await Promise.all(els.map(el => el.getAttribute('value'))) + return values.filter(part => part.indexOf(value) >= 0).length > 0 } } return this.browser.wait(valueToBeInElementValue(field, value), aSec * 1000).catch(() => { - throw Error( - `element (${field}) is not in DOM or there is no element(${field}) with value "${value}" after ${aSec} sec`, - ) + throw Error(`element (${field}) is not in DOM or there is no element(${field}) with value "${value}" after ${aSec} sec`) }) } @@ -1528,7 +1508,7 @@ class Protractor extends Helper { const aSec = sec || this.options.waitForTimeoutInSeconds const waitTimeout = aSec * 1000 - return this.browser.wait(EC.urlContains(urlPart), waitTimeout).catch(async (e) => { + return this.browser.wait(EC.urlContains(urlPart), waitTimeout).catch(async e => { const currUrl = await this.browser.getCurrentUrl() if (/wait timed out after/i.test(e.message)) { throw new Error(`expected url to include ${urlPart}, but found ${currUrl}`) @@ -1549,7 +1529,7 @@ class Protractor extends Helper { urlPart = baseUrl + urlPart } - return this.browser.wait(EC.urlIs(urlPart), waitTimeout).catch(async (e) => { + return this.browser.wait(EC.urlIs(urlPart), waitTimeout).catch(async e => { const currUrl = await this.browser.getCurrentUrl() if (/wait timed out after/i.test(e.message)) { throw new Error(`expected url to be ${urlPart}, but found ${currUrl}`) @@ -1645,10 +1625,7 @@ class Protractor extends Helper { return this.executeScript(function () { const body = document.body const html = document.documentElement - window.scrollTo( - 0, - Math.max(body.scrollHeight, body.offsetHeight, html.clientHeight, html.scrollHeight, html.offsetHeight), - ) + window.scrollTo(0, Math.max(body.scrollHeight, body.offsetHeight, html.clientHeight, html.scrollHeight, html.offsetHeight)) }) } @@ -1778,7 +1755,7 @@ async function proceedSee(assertType, text, context) { const els = await this._smartWait(() => this.browser.findElements(locator), enableSmartWait) const promises = [] let source = '' - els.forEach((el) => promises.push(el.getText().then((elText) => (source += `| ${elText}`)))) + els.forEach(el => promises.push(el.getText().then(elText => (source += `| ${elText}`)))) await Promise.all(promises) return stringIncludes(description)[assertType](text, source) } @@ -1803,7 +1780,7 @@ async function proceedIsChecked(assertType, option) { const els = await findCheckable(this.browser, option) assertElementExists(els, option, 'Option') const elsSelected = [] - els.forEach((el) => elsSelected.push(el.isSelected())) + els.forEach(el => elsSelected.push(el.isSelected())) const values = await Promise.all(elsSelected) const selected = values.reduce((prev, cur) => prev || cur) return truth(`checkable ${option}`, 'to be checked')[assertType](selected) diff --git a/lib/helper/Puppeteer.js b/lib/helper/Puppeteer.js index 77cbf3587..c023bc84a 100644 --- a/lib/helper/Puppeteer.js +++ b/lib/helper/Puppeteer.js @@ -36,19 +36,8 @@ const Popup = require('./extras/Popup') const Console = require('./extras/Console') const { highlightElement } = require('./scripts/highlightElement') const { blurElement } = require('./scripts/blurElement') -const { - dontSeeElementError, - seeElementError, - dontSeeElementInDOMError, - seeElementInDOMError, -} = require('./errors/ElementAssertion') -const { - dontSeeTraffic, - seeTraffic, - grabRecordedNetworkTraffics, - stopRecordingTraffic, - flushNetworkTraffics, -} = require('./network/actions') +const { dontSeeElementError, seeElementError, dontSeeElementInDOMError, seeElementInDOMError } = require('./errors/ElementAssertion') +const { dontSeeTraffic, seeTraffic, grabRecordedNetworkTraffics, stopRecordingTraffic, flushNetworkTraffics } = require('./network/actions') let puppeteer let perfTiming @@ -271,9 +260,7 @@ class Puppeteer extends Helper { } _getOptions(config) { - return config.browser === 'firefox' - ? Object.assign(this.options.firefox, { product: 'firefox' }) - : this.options.chrome + return config.browser === 'firefox' ? Object.assign(this.options.firefox, { product: 'firefox' }) : this.options.chrome } _setConfig(config) { @@ -325,8 +312,8 @@ class Puppeteer extends Helper { this.sessionPages = {} this.currentRunningTest = test recorder.retry({ - retries: process.env.FAILED_STEP_RETRIES || 3, - when: (err) => { + retries: test?.opts?.conditionalRetries || 3, + when: err => { if (!err || typeof err.message !== 'string') { return false } @@ -346,7 +333,7 @@ class Puppeteer extends Helper { const contexts = this.browser.browserContexts() const defaultCtx = contexts.shift() - await Promise.all(contexts.map((c) => c.close())) + await Promise.all(contexts.map(c => c.close())) if (this.options.restart) { this.isRunning = false @@ -355,7 +342,7 @@ class Puppeteer extends Helper { // ensure this.page is from default context if (this.page) { - const existingPages = defaultCtx.targets().filter((t) => t.type() === 'page') + const existingPages = defaultCtx.targets().filter(t => t.type() === 'page') await this._setPage(await existingPages[0].page()) } @@ -368,10 +355,10 @@ class Puppeteer extends Helper { const currentUrl = await this.grabCurrentUrl() if (currentUrl.startsWith('http')) { - await this.executeScript('localStorage.clear();').catch((err) => { + await this.executeScript('localStorage.clear();').catch(err => { if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err }) - await this.executeScript('sessionStorage.clear();').catch((err) => { + await this.executeScript('sessionStorage.clear();').catch(err => { if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err }) } @@ -400,12 +387,12 @@ class Puppeteer extends Helper { stop: async () => { // is closed by _after }, - loadVars: async (context) => { - const existingPages = context.targets().filter((t) => t.type() === 'page') + loadVars: async context => { + const existingPages = context.targets().filter(t => t.type() === 'page') this.sessionPages[this.activeSessionName] = await existingPages[0].page() return this._setPage(this.sessionPages[this.activeSessionName]) }, - restoreVars: async (session) => { + restoreVars: async session => { this.withinLocator = null if (!session) { @@ -414,7 +401,7 @@ class Puppeteer extends Helper { this.activeSessionName = session } const defaultCtx = this.browser.defaultBrowserContext() - const existingPages = defaultCtx.targets().filter((t) => t.type() === 'page') + const existingPages = defaultCtx.targets().filter(t => t.type() === 'page') await this._setPage(await existingPages[0].page()) return this._waitForAction() @@ -517,7 +504,7 @@ class Puppeteer extends Helper { if (!page) { return } - page.on('error', async (error) => { + page.on('error', async error => { console.error('Puppeteer page error', error) }) } @@ -533,7 +520,7 @@ class Puppeteer extends Helper { if (!page) { return } - page.on('dialog', async (dialog) => { + page.on('dialog', async dialog => { popupStore.popup = dialog const action = popupStore.actionType || this.options.defaultPopupAction await this._waitForAction() @@ -588,15 +575,15 @@ class Puppeteer extends Helper { this.browser = await puppeteer.launch(this.puppeteerOptions) } - this.browser.on('targetcreated', (target) => + this.browser.on('targetcreated', target => target .page() - .then((page) => targetCreatedHandler.call(this, page)) - .catch((e) => { + .then(page => targetCreatedHandler.call(this, page)) + .catch(e => { console.error('Puppeteer page error', e) }), ) - this.browser.on('targetchanged', (target) => { + this.browser.on('targetchanged', target => { this.debugSection('Url', target.url()) }) @@ -639,9 +626,7 @@ class Puppeteer extends Helper { if (frame) { if (Array.isArray(frame)) { - return this.switchTo(null).then(() => - frame.reduce((p, frameLocator) => p.then(() => this.switchTo(frameLocator)), Promise.resolve()), - ) + return this.switchTo(null).then(() => frame.reduce((p, frameLocator) => p.then(() => this.switchTo(frameLocator)), Promise.resolve())) } await this.switchTo(frame) this.withinLocator = new Locator(frame) @@ -664,7 +649,7 @@ class Puppeteer extends Helper { const navigationStart = timing.navigationStart const extractedData = {} - dataNames.forEach((name) => { + dataNames.forEach(name => { extractedData[name] = timing[name] - navigationStart }) @@ -698,13 +683,7 @@ class Puppeteer extends Helper { const performanceTiming = JSON.parse(await this.page.evaluate(() => JSON.stringify(window.performance.timing))) - perfTiming = this._extractDataFromPerformanceTiming( - performanceTiming, - 'responseEnd', - 'domInteractive', - 'domContentLoadedEventEnd', - 'loadEventEnd', - ) + perfTiming = this._extractDataFromPerformanceTiming(performanceTiming, 'responseEnd', 'domInteractive', 'domContentLoadedEventEnd', 'loadEventEnd') return this._waitForAction() } @@ -815,10 +794,7 @@ class Puppeteer extends Helper { return this.executeScript(() => { const body = document.body const html = document.documentElement - window.scrollTo( - 0, - Math.max(body.scrollHeight, body.offsetHeight, html.clientHeight, html.scrollHeight, html.offsetHeight), - ) + window.scrollTo(0, Math.max(body.scrollHeight, body.offsetHeight, html.clientHeight, html.scrollHeight, html.offsetHeight)) }) } @@ -836,13 +812,9 @@ class Puppeteer extends Helper { const els = await this._locate(locator) assertElementExists(els, locator, 'Element') const el = els[0] - await el.evaluate((el) => el.scrollIntoView()) + await el.evaluate(el => el.scrollIntoView()) const elementCoordinates = await getClickablePoint(els[0]) - await this.executeScript( - (x, y) => window.scrollBy(x, y), - elementCoordinates.x + offsetX, - elementCoordinates.y + offsetY, - ) + await this.executeScript((x, y) => window.scrollBy(x, y), elementCoordinates.x + offsetX, elementCoordinates.y + offsetY) } else { await this.executeScript((x, y) => window.scrollTo(x, y), offsetX, offsetY) } @@ -1025,10 +997,10 @@ class Puppeteer extends Helper { */ async closeOtherTabs() { const pages = await this.browser.pages() - const otherPages = pages.filter((page) => page !== this.page) + const otherPages = pages.filter(page => page !== this.page) let p = Promise.resolve() - otherPages.forEach((page) => { + otherPages.forEach(page => { p = p.then(() => page.close()) }) await p @@ -1061,19 +1033,11 @@ class Puppeteer extends Helper { */ async seeElement(locator) { let els = await this._locate(locator) - els = (await Promise.all(els.map((el) => el.boundingBox() && el))).filter((v) => v) + els = (await Promise.all(els.map(el => el.boundingBox() && el))).filter(v => v) // Puppeteer visibility was ignored? | Remove when Puppeteer is fixed - els = await Promise.all( - els.map( - async (el) => - (await el.evaluate( - (node) => - window.getComputedStyle(node).visibility !== 'hidden' && window.getComputedStyle(node).display !== 'none', - )) && el, - ), - ) + els = await Promise.all(els.map(async el => (await el.evaluate(node => window.getComputedStyle(node).visibility !== 'hidden' && window.getComputedStyle(node).display !== 'none')) && el)) try { - return empty('visible elements').negate(els.filter((v) => v).fill('ELEMENT')) + return empty('visible elements').negate(els.filter(v => v).fill('ELEMENT')) } catch (e) { dontSeeElementError(locator) } @@ -1085,19 +1049,11 @@ class Puppeteer extends Helper { */ async dontSeeElement(locator) { let els = await this._locate(locator) - els = (await Promise.all(els.map((el) => el.boundingBox() && el))).filter((v) => v) + els = (await Promise.all(els.map(el => el.boundingBox() && el))).filter(v => v) // Puppeteer visibility was ignored? | Remove when Puppeteer is fixed - els = await Promise.all( - els.map( - async (el) => - (await el.evaluate( - (node) => - window.getComputedStyle(node).visibility !== 'hidden' && window.getComputedStyle(node).display !== 'none', - )) && el, - ), - ) + els = await Promise.all(els.map(async el => (await el.evaluate(node => window.getComputedStyle(node).visibility !== 'hidden' && window.getComputedStyle(node).display !== 'none')) && el)) try { - return empty('visible elements').assert(els.filter((v) => v).fill('ELEMENT')) + return empty('visible elements').assert(els.filter(v => v).fill('ELEMENT')) } catch (e) { seeElementError(locator) } @@ -1109,7 +1065,7 @@ class Puppeteer extends Helper { async seeElementInDOM(locator) { const els = await this._locate(locator) try { - return empty('elements on page').negate(els.filter((v) => v).fill('ELEMENT')) + return empty('elements on page').negate(els.filter(v => v).fill('ELEMENT')) } catch (e) { dontSeeElementInDOMError(locator) } @@ -1121,7 +1077,7 @@ class Puppeteer extends Helper { async dontSeeElementInDOM(locator) { const els = await this._locate(locator) try { - return empty('elements on a page').assert(els.filter((v) => v).fill('ELEMENT')) + return empty('elements on a page').assert(els.filter(v => v).fill('ELEMENT')) } catch (e) { seeElementInDOMError(locator) } @@ -1151,17 +1107,12 @@ class Puppeteer extends Helper { const els = await findClickable.call(this, matcher, locator) if (context) { - assertElementExists( - els, - locator, - 'Clickable element', - `was not found inside element ${new Locator(context).toString()}`, - ) + assertElementExists(els, locator, 'Clickable element', `was not found inside element ${new Locator(context).toString()}`) } else { assertElementExists(els, locator, 'Clickable element') } const elem = els[0] - return this.executeScript((el) => { + return this.executeScript(el => { if (document.activeElement instanceof HTMLElement) { document.activeElement.blur() } @@ -1220,8 +1171,8 @@ class Puppeteer extends Helper { let fileName await this.page.setRequestInterception(true) - const xRequest = await new Promise((resolve) => { - this.page.on('request', (request) => { + const xRequest = await new Promise(resolve => { + this.page.on('request', request => { console.log('rq', request, customName) const grabbedFileName = request.url().split('/')[request.url().split('/').length - 1] const fileExtension = request.url().split('/')[request.url().split('/').length - 1].split('.')[1] @@ -1248,7 +1199,7 @@ class Puppeteer extends Helper { } const cookies = await this.page.cookies() - options.headers.Cookie = cookies.map((ck) => `${ck.name}=${ck.value}`).join(';') + options.headers.Cookie = cookies.map(ck => `${ck.name}=${ck.value}`).join(';') const response = await axios({ method: options.method, @@ -1302,7 +1253,7 @@ class Puppeteer extends Helper { */ async checkOption(field, context = null) { const elm = await this._locateCheckable(field, context) - const curentlyChecked = await elm.getProperty('checked').then((checkedProperty) => checkedProperty.jsonValue()) + const curentlyChecked = await elm.getProperty('checked').then(checkedProperty => checkedProperty.jsonValue()) // Only check if NOT currently checked if (!curentlyChecked) { await elm.click() @@ -1315,7 +1266,7 @@ class Puppeteer extends Helper { */ async uncheckOption(field, context = null) { const elm = await this._locateCheckable(field, context) - const curentlyChecked = await elm.getProperty('checked').then((checkedProperty) => checkedProperty.jsonValue()) + const curentlyChecked = await elm.getProperty('checked').then(checkedProperty => checkedProperty.jsonValue()) // Only uncheck if currently checked if (curentlyChecked) { await elm.click() @@ -1408,12 +1359,12 @@ class Puppeteer extends Helper { const els = await findVisibleFields.call(this, field) assertElementExists(els, field, 'Field') const el = els[0] - const tag = await el.getProperty('tagName').then((el) => el.jsonValue()) - const editable = await el.getProperty('contenteditable').then((el) => el.jsonValue()) + const tag = await el.getProperty('tagName').then(el => el.jsonValue()) + const editable = await el.getProperty('contenteditable').then(el => el.jsonValue()) if (tag === 'INPUT' || tag === 'TEXTAREA') { - await this._evaluateHandeInContext((el) => (el.value = ''), el) + await this._evaluateHandeInContext(el => (el.value = ''), el) } else if (editable) { - await this._evaluateHandeInContext((el) => (el.innerHTML = ''), el) + await this._evaluateHandeInContext(el => (el.innerHTML = ''), el) } highlightActiveElement.call(this, el, await this._getContext()) @@ -1483,7 +1434,7 @@ class Puppeteer extends Helper { const els = await findVisibleFields.call(this, select) assertElementExists(els, select, 'Selectable field') const el = els[0] - if ((await el.getProperty('tagName').then((t) => t.jsonValue())) !== 'SELECT') { + if ((await el.getProperty('tagName').then(t => t.jsonValue())) !== 'SELECT') { throw new Error('Element is not