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/workflows/acceptance-tests.yml b/.github/workflows/acceptance-tests.yml index 63107de63..92315d047 100644 --- a/.github/workflows/acceptance-tests.yml +++ b/.github/workflows/acceptance-tests.yml @@ -29,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..7be5a9a37 --- /dev/null +++ b/.github/workflows/appium_Android.yml @@ -0,0 +1,46 @@ +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 + timeout-minutes: 30 + + 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: 'timeout 900 bash -c "npm run test:appium-${{ matrix.test-suite }}"' + timeout-minutes: 20 diff --git a/.github/workflows/appiumV2_iOS.yml b/.github/workflows/appium_iOS.yml similarity index 50% rename from .github/workflows/appiumV2_iOS.yml rename to .github/workflows/appium_iOS.yml index 64ae5e12a..d638b454e 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,10 +9,14 @@ 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 + timeout-minutes: 30 strategy: matrix: @@ -29,8 +33,13 @@ 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: 'timeout 900 bash -c "npm run test:ios:appium-${{ matrix.test-suite }}"' + timeout-minutes: 20 diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index 237f17b0c..bba6560b4 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -4,17 +4,26 @@ 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_REPOSITORY }} steps: - - name: Check out the repo with the latest code + - name: Checkout code uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Get version from package.json + id: get_version + run: | + VERSION=$(jq -r .version package.json) + echo "VERSION=$VERSION" >> $GITHUB_ENV + echo "version=$VERSION" >> $GITHUB_OUTPUT - name: Set up Docker Buildx uses: docker/setup-buildx-action@v3 @@ -25,15 +34,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 on Docker Hub + id: tag_check + run: | + STATUS_CODE=$(curl -s -o /dev/null -w "%{http_code}" \ + https://hub.docker.com/v2/repositories/${{ env.DOCKER_REPO }}/tags/${{ steps.get_version.outputs.version }}/) + echo "status_code=$STATUS_CODE" >> $GITHUB_OUTPUT - name: Build and push Docker image + if: steps.tag_check.outputs.status_code != '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.VERSION }} \ No newline at end of file diff --git a/.github/workflows/playwright.yml b/.github/workflows/playwright.yml index 1f8dc9769..e6cc05f11 100644 --- a/.github/workflows/playwright.yml +++ b/.github/workflows/playwright.yml @@ -15,40 +15,54 @@ env: jobs: build: - runs-on: ubuntu-latest + timeout-minutes: 30 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 }} - - 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' + timeout-minutes: 2 + - name: start a server + run: 'php -S 127.0.0.1:8000 -t test/data/app &' + - name: run chromium unit tests + run: ./node_modules/.bin/mocha test/helper/Playwright_test.js --timeout 5000 --reporter @testomatio/reporter/mocha + timeout-minutes: 5 + - name: run chromium tests + run: 'timeout 600 bash -c "unset BROWSER && BROWSER=chromium ./bin/codecept.js run -c test/acceptance/codecept.Playwright.js --grep @Playwright --debug"' + timeout-minutes: 12 + - name: run chromium with restart==browser tests + run: 'timeout 600 bash -c "unset BROWSER && BROWSER_RESTART=browser ./bin/codecept.js run -c test/acceptance/codecept.Playwright.js --grep @Playwright --debug"' + timeout-minutes: 12 + - name: run chromium with restart==session tests + run: 'timeout 600 bash -c "unset BROWSER && BROWSER_RESTART=session ./bin/codecept.js run -c test/acceptance/codecept.Playwright.js --grep @Playwright --debug"' + timeout-minutes: 12 + - name: run firefox tests + run: 'timeout 600 bash -c "unset BROWSER && BROWSER=firefox node ./bin/codecept.js run -c test/acceptance/codecept.Playwright.js --grep @Playwright --debug"' + timeout-minutes: 12 + - name: run webkit tests + run: 'timeout 600 bash -c "unset BROWSER && BROWSER=webkit node ./bin/codecept.js run -c test/acceptance/codecept.Playwright.js --grep @Playwright --debug"' + timeout-minutes: 12 + env: + GH_PAT: ${{ github.token }} diff --git a/.github/workflows/plugin.yml b/.github/workflows/plugin.yml index ec456fa7f..32707bf6c 100644 --- a/.github/workflows/plugin.yml +++ b/.github/workflows/plugin.yml @@ -15,30 +15,33 @@ env: jobs: build: - runs-on: ubuntu-22.04 + timeout-minutes: 20 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 }} - - 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/puppeteer.yml b/.github/workflows/puppeteer.yml index 0d040fdee..04b2c7786 100644 --- a/.github/workflows/puppeteer.yml +++ b/.github/workflows/puppeteer.yml @@ -15,32 +15,36 @@ env: jobs: build: - runs-on: ubuntu-22.04 + timeout-minutes: 25 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 }} - - uses: shivammathur/setup-php@v2 - with: - php-version: 7.4 - - name: npm install - run: | - npm i --force && npm i puppeteer --force - env: - PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: true - - name: start a server - run: "php -S 127.0.0.1:8000 -t test/data/app &" - - uses: browser-actions/setup-chrome@v1 - - run: chrome --version - - name: run tests - run: "./bin/codecept.js run-workers 2 -c test/acceptance/codecept.Puppeteer.js --grep @Puppeteer --debug" - - name: run unit tests - run: ./node_modules/.bin/mocha test/helper/Puppeteer_test.js + - 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 && npm i puppeteer --force + env: + PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: true + - name: start a server + run: 'php -S 127.0.0.1:8000 -t test/data/app &' + - uses: browser-actions/setup-chrome@v1 + - run: chrome --version + - name: run unit tests + run: ./node_modules/.bin/mocha test/helper/Puppeteer_test.js --reporter @testomatio/reporter/mocha + timeout-minutes: 5 + - name: run tests + run: 'timeout 600 bash -c "./bin/codecept.js run-workers 2 -c test/acceptance/codecept.Puppeteer.js --grep @Puppeteer --debug"' + timeout-minutes: 12 + env: + GH_PAT: ${{ github.token }} diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index ae84f5304..4b6dddac1 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -9,27 +9,50 @@ on: - '**' jobs: - build: + unit-tests: + name: Unit tests + runs-on: ubuntu-22.04 + timeout-minutes: 15 + + strategy: + matrix: + node-version: [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 + timeout-minutes: 10 + env: + GH_PAT: ${{ github.token }} + runner-tests: + name: Runner tests runs-on: ubuntu-22.04 + timeout-minutes: 15 strategy: matrix: - node-version: [20.x] + node-version: [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 + timeout-minutes: 10 + env: + GH_PAT: ${{ github.token }} diff --git a/.github/workflows/testcafe.yml b/.github/workflows/testcafe.yml index c6b8844cf..eb6849c78 100644 --- a/.github/workflows/testcafe.yml +++ b/.github/workflows/testcafe.yml @@ -13,32 +13,34 @@ env: # Force terminal colors. @see https://www.npmjs.com/package/colors FORCE_COLOR: 1 - jobs: build: - runs-on: ubuntu-22.04 + timeout-minutes: 20 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 }} - - uses: shivammathur/setup-php@v2 - with: - php-version: 7.4 - - 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: xvfb-run --server-args="-screen 0 1280x720x24" ./node_modules/.bin/mocha test/helper/TestCafe_test.js + - 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: + 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: xvfb-run --server-args="-screen 0 1280x720x24" ./node_modules/.bin/mocha test/helper/TestCafe_test.js --reporter @testomatio/reporter/mocha + timeout-minutes: 10 + env: + GH_PAT: ${{ github.token }} diff --git a/.github/workflows/webdriver.yml b/.github/workflows/webdriver.yml index 603dba1ab..e44048407 100644 --- a/.github/workflows/webdriver.yml +++ b/.github/workflows/webdriver.yml @@ -15,34 +15,38 @@ env: jobs: build: - runs-on: ubuntu-latest + timeout-minutes: 25 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: run unit tests + run: ./node_modules/.bin/mocha test/helper/WebDriver_test.js --exit --reporter @testomatio/reporter/mocha + timeout-minutes: 5 + - name: check + run: './bin/codecept.js check -c test/acceptance/codecept.WebDriver.js' + timeout-minutes: 2 + env: + GH_PAT: ${{ github.token }} + - name: run tests + run: 'timeout 600 bash -c "./bin/codecept.js run -c test/acceptance/codecept.WebDriver.js --grep @WebDriver --debug"' + timeout-minutes: 12 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/.mocharc.cjs b/.mocharc.cjs new file mode 100644 index 000000000..d292f9a90 --- /dev/null +++ b/.mocharc.cjs @@ -0,0 +1,6 @@ +const path = require('path'); + +module.exports = { + require: [path.join(__dirname, 'test', 'support', 'setup.cjs')], + extension: ['js', 'mjs'], +}; diff --git a/.mocharc.js b/.mocharc.js deleted file mode 100644 index 03529fe60..000000000 --- a/.mocharc.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = { - "require": "./test/support/setup.js" -} diff --git a/CHANGELOG.md b/CHANGELOG.md index 91ef4e214..e3ec87265 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,393 @@ +## 4.0 + +- **feat: ESM (ECMAScript Modules) support** - Full migration to ESM format with backward compatibility + +📖 _Documentation_ + +- **[ESM Migration Guide](docs/esm-migration.md)** - Comprehensive guide for migrating to ESM format, including information about execution order changes in `session()` and `within()` blocks + +## 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! ❤️ @@ -99,7 +489,6 @@ I.flushSoftAssertions() // Throws an error if any soft assertions have failed. T ``` - 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) @@ -362,7 +751,6 @@ heal.addRecipe('reloadPageIfModalIsNotVisisble', { ``` - **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 @@ -373,7 +761,6 @@ heal.addRecipe('reloadPageIfModalIsNotVisisble', { - `OpenAI` helper renamed to `AI` - feat(puppeteer): network traffic manipulation. See #4263 by @KobeNguyenT - - `startRecordingTraffic` - `grabRecordedNetworkTraffics` - `flushNetworkTraffics` @@ -1714,7 +2101,6 @@ await I.seeTraffic({ - **🪄 [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 @@ -1725,7 +2111,6 @@ await I.seeTraffic({ ![](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 @@ -2442,7 +2827,7 @@ Read changelog to learn more about version 👇 ```ts const psp = wd.grabPageScrollPosition() // $ExpectType Promise -psp.then((result) => { +psp.then(result => { result.x // $ExpectType number result.y // $ExpectType number }) @@ -3137,9 +3522,7 @@ I.seeFile(fileName) ## 2.0.0 - [WebDriver] **Breaking Change.** Updated to webdriverio v5. New helper **WebDriver** helper introduced. - - **Upgrade plan**: - 1. Install latest webdriverio ``` @@ -3156,9 +3539,7 @@ I.seeFile(fileName) - [Appium] **Breaking Change.** Updated to use webdriverio v5 as well. See upgrade plan ↑ - [REST] **Breaking Change.** Replaced `unirest` library with `axios`. - - **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. @@ -3365,7 +3746,7 @@ This change allows using auto-completion when running a specific 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) => { +Scenario('run in different browsers', I => { I.amOnPage('/hello') I.see('Hello!') session('john', () => { @@ -3407,13 +3788,13 @@ locate('//table').find('tr').at(2).find('a').withText('Edit') ```js 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) -Scenario('this test should throw error', (I) => { +Scenario('this test should throw error', I => { // I.amOnPage }).throws(new Error()) ``` @@ -3522,7 +3903,7 @@ 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', + when: err => err.message === 'Node not visible', }).seeElement('#user') ``` @@ -3550,7 +3931,7 @@ I.retry({ ```js I.runOnAndroid( - (caps) => caps.platformVersion >= 7, + caps => caps.platformVersion >= 7, () => { // run code only on Android 7+ }, @@ -3959,7 +4340,7 @@ I.say('I expect post is visible on site') ```js Feature('Complex JS Stuff', { retries: 3 }) -Scenario('Not that complex', { retries: 1 }, (I) => { +Scenario('Not that complex', { retries: 1 }, I => { // test goes here }) ``` @@ -3969,7 +4350,7 @@ Scenario('Not that complex', { retries: 1 }, (I) => { ```js Feature('Complex JS Stuff', { timeout: 5000 }) -Scenario('Not that complex', { timeout: 1000 }, (I) => { +Scenario('Not that complex', { timeout: 1000 }, I => { // test goes here }) ``` diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 000000000..f547e9f72 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,268 @@ +# CodeceptJS ESM Migration Plan + +## Executive Summary + +Migrating CodeceptJS to ESM will require a phased approach due to: + +- **900+ require() statements** across the codebase +- Complex dynamic module loading system in `container.js` +- Extensive plugin architecture with runtime module resolution +- Heavy use of conditional requires and try-catch patterns + +## Analysis Results + +### Total Count of require() Statements + +- **850 require() statements** found in the `/lib` directory alone +- Additional requires in `/bin`, `/translations`, and root files +- **Total estimated across codebase: ~900+ require() statements** + +### Files with Most require() Statements + +1. `/lib/codecept.js` - 30 requires +2. `/lib/helper/Playwright.js` - 28 requires +3. `/lib/helper/Puppeteer.js` - 26 requires +4. `/lib/helper/WebDriver.js` - 24 requires +5. `/lib/helper/Protractor.js` - 22 requires +6. `/lib/workers.js` - 20 requires +7. `/lib/index.js` - 19 requires +8. `/lib/container.js` - 19 requires +9. `/lib/command/init.js` - 19 requires +10. `/lib/helper/TestCafe.js` - 17 requires + +### Problematic Patterns Requiring Special Handling + +#### 1. Dynamic require() Statements (Most Critical) + +- **Template-based requires**: `/lib/command/generate.js` line 158: `actor = require('${actorPath}')` +- **Conditional module loading**: `/lib/command/init.js` line 287: `require(\`../helper/\${helperName}\`)` +- **Plugin loading**: Multiple files use `require(module)` where module is a variable + +#### 2. Conditional require() Statements (High Impact) + +Found **75+ files** with conditional requires using `if` statements: + +- `/lib/container.js`: Module loading with fallback logic +- `/lib/config.js`: TypeScript support with `require('ts-node/register')` +- `/lib/codecept.js`: Global object loading based on configuration +- Helper files: Conditional loading of browser automation libraries + +#### 3. Try-catch require() Patterns (High Impact) + +Found **57+ files** with try-catch require patterns: + +- `/lib/utils.js`: `requireWithFallback()` function for graceful fallbacks +- `/lib/plugin/wdio.js`: `safeRequire()` function +- `/lib/helper/REST.js`: Dependency checking +- `/lib/container.js`: Module loading with error handling + +#### 4. require.resolve() Usage (Medium Impact) + +Found **5 files** using `require.resolve()`: + +- `/lib/utils.js`: Package existence checking in `requireWithFallback()` +- `/lib/helper/Puppeteer.js`: Module resolution +- `/lib/helper/extras/React.js`: Path resolution +- `/lib/helper/ApiDataFactory.js` and `/lib/helper/GraphQLDataFactory.js`: Dependency checking + +#### 5. \_\_dirname Usage (Medium Impact) + +Found **9 files** using `__dirname`: + +- `/lib/codecept.js`: Package.json path resolution +- `/lib/utils.js`: Local installation detection +- `/lib/workers.js`: Worker script path resolution +- `/lib/command/generate.js`: Template file paths +- `/lib/command/run-multiple.js`: Executable paths +- `/lib/helper/Nightmare.js`: Client script injection +- `/lib/helper/REST.js`: Certificate file paths (in documentation) +- `/lib/mocha/factory.js`: UI module paths +- `/lib/helper/testcafe/testcafe-utils.js`: Directory resolution + +## Migration Plan + +### Phase 1: Foundation (Estimated 2-3 weeks) + +#### 1.1 Update package.json + +```json +{ + "type": "module", + "exports": { + ".": "./lib/index.js", + "./lib/*": "./lib/*.js" + }, + "engines": { + "node": ">=14.13.1" + } +} +``` + +#### 1.2 Create ESM compatibility layer + +- Create `lib/compat/moduleLoader.js` for dynamic imports +- Convert `__dirname`/`__filename` to `import.meta.url` +- Replace `require.resolve()` with `import.meta.resolve()` + +#### 1.3 Convert bin/ entry points + +- `bin/codecept.js` → ESM imports +- Update shebang and command structure + +### Phase 2: Core Infrastructure (Estimated 3-4 weeks) + +#### 2.1 Convert container.js (CRITICAL) + +Key changes needed in `lib/container.js:285-305`: + +```javascript +// Current problematic code: +const mod = require(moduleName) +HelperClass = mod.default || mod + +// ESM replacement: +const mod = await import(moduleName) +HelperClass = mod.default || mod +``` + +#### 2.2 Update dynamic loading functions + +- `requireHelperFromModule()` → `importHelperFromModule()` +- `loadSupportObject()` → async with dynamic imports +- `createPlugins()` → async plugin loading + +#### 2.3 Convert core files + +Priority order: + +1. `lib/utils.js` (19 requires) +2. `lib/index.js` (19 requires) +3. `lib/codecept.js` (30 requires) +4. `lib/config.js` (13 requires) + +### Phase 3: Helper System (Estimated 4-5 weeks) + +#### 3.1 Convert browser automation helpers + +High-impact files: + +- `lib/helper/Playwright.js` (28 requires) +- `lib/helper/Puppeteer.js` (26 requires) +- `lib/helper/WebDriver.js` (24 requires) +- `lib/helper/TestCafe.js` (17 requires) + +#### 3.2 Handle conditional dependencies + +Convert try-catch patterns: + +```javascript +// Current: +try { + const puppeteer = require('puppeteer') +} catch (e) { + // fallback +} + +// ESM: +let puppeteer +try { + puppeteer = await import('puppeteer') +} catch (e) { + // fallback +} +``` + +### Phase 4: Commands & Plugins (Estimated 2-3 weeks) + +#### 4.1 Convert command files + +- `lib/command/init.js` (19 requires) +- `lib/command/generate.js` (template loading) +- `lib/command/run*.js` files + +#### 4.2 Update plugin system + +- Support both CJS and ESM plugins +- Async plugin initialization +- Plugin discovery mechanism + +### Phase 5: Testing & Validation (Estimated 2-3 weeks) + +#### 5.1 Test compatibility + +- All existing tests must pass +- Plugin ecosystem compatibility +- Helper loading in various configurations + +#### 5.2 Documentation updates + +- Migration guide for users +- Plugin development guidelines +- Breaking changes documentation + +## Critical Migration Challenges + +### 1. Dynamic Module Loading + +The biggest challenge is in `container.js` where modules are loaded dynamically based on configuration. This requires converting synchronous `require()` to asynchronous `import()`. + +**Solution**: Make container creation async and update all callers. + +### 2. Plugin Ecosystem + +Many plugins may still use CommonJS. + +**Solution**: Support both formats during transition period. + +### 3. Global Object Injection + +`codecept.js` conditionally adds globals based on config. + +**Solution**: Maintain compatibility layer for existing configurations. + +### 4. File Path Resolution + +Extensive use of `__dirname` for path resolution. + +**Solution**: Create utility functions using `import.meta.url`. + +## Compatibility Strategy + +### Dual Package Approach (Recommended) + +1. Maintain CommonJS build for compatibility +2. Provide ESM build for modern usage +3. Use `package.json` exports field to serve appropriate version + +### Breaking Changes + +- Drop Node.js < 14.13.1 support +- Async container initialization +- Some plugin APIs may need updates + +## Timeline Summary + +- **Total estimated time**: 13-18 weeks +- **Critical path**: Container.js and dynamic loading +- **Risk areas**: Plugin compatibility, helper loading + +## Next Steps + +1. Start with Phase 1 foundation work +2. Create comprehensive test suite for migration validation +3. Engage with plugin maintainers early +4. Consider feature freeze during migration +5. Plan gradual rollout strategy + +## Testing Commands + +To test the project: + +- `npm run lint` - Run linting +- `npm run test:unit` - Run unit tests +- `npm run test:runner` - Run runner tests +- `npm run test` - Run both unit and runner tests + +## Current Migration Status + +Starting with creating example-esm project for iterative testing and validation. diff --git a/Dockerfile b/Dockerfile index 7d4f6bc9d..d637da4b5 100644 --- a/Dockerfile +++ b/Dockerfile @@ -2,6 +2,8 @@ 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 \ diff --git a/README.md b/README.md index adfa551a4..992f36f4c 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,15 @@ [](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: +## Build Status -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) - -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) @@ -290,183 +289,12 @@ When using Typescript, replace `module.exports` with `export` for autocompletion ## Contributors - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - DavertMik
- DavertMik - -		 - - kobenguyent
- kobenguyent - -		 - - Vorobeyko
- Vorobeyko - -		 - - reubenmiller
- reubenmiller - -
- - Arhell
- Arhell - -		 - - APshenkin
- APshenkin - -		 - - fabioel
- fabioel - -		 - - pablopaul
- pablopaul - -
- - mirao
- mirao - -		 - - Georgegriff
- Georgegriff - -		 - - KMKoushik
- KMKoushik - -		 - - nikocanvacom
- nikocanvacom - -
- - elukoyanov
- elukoyanov - -		 - - thomashohn
- thomashohn - -		 - - gkushang
- gkushang - -		 - - tsuemura
- tsuemura - -
- - EgorBodnar
- EgorBodnar - -		 - - VikalpP
- VikalpP - -		 - - elaichenkov
- elaichenkov - -		 - - BorisOsipov
- BorisOsipov - -
- - ngraf
- ngraf - -		 - - nitschSB
- nitschSB - -		 - - hubidu
- hubidu - -		 - - jploskonka
- jploskonka - -
- - maojunxyz
- maojunxyz - -		 - - abhimanyupandian
- abhimanyupandian - -		 - - martomo
- martomo - -		 - - hatufacci
- hatufacci - -
+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..11b18b971 100755 --- a/bin/codecept.js +++ b/bin/codecept.js @@ -1,8 +1,10 @@ #!/usr/bin/env node -const program = require('commander') -const Codecept = require('../lib/codecept') -const { print, error } = require('../lib/output') -const { printError } = require('../lib/command/utils') +import { Command } from 'commander' +const program = new Command() +import Codecept from '../lib/codecept.js' +import output from '../lib/output.js' +const { print, error } = output +import { printError } from '../lib/command/utils.js' const commandFlags = { ai: { @@ -32,7 +34,7 @@ const commandFlags = { } const errorHandler = - (fn) => + fn => async (...args) => { try { await fn(...args) @@ -42,6 +44,23 @@ const errorHandler = } } +const dynamicImport = async modulePath => { + const module = await import(modulePath) + return module.default || module +} + +const commandHandler = modulePath => + errorHandler(async (...args) => { + const handler = await dynamicImport(modulePath) + return handler(...args) + }) + +const commandHandlerWithProperty = (modulePath, property) => + errorHandler(async (...args) => { + const module = await dynamicImport(modulePath) + return module[property](...args) + }) + if (process.versions.node && process.versions.node.split('.') && process.versions.node.split('.')[0] < 12) { error('NodeJS >= 12 is required to run.') print() @@ -53,15 +72,16 @@ if (process.versions.node && process.versions.node.split('.') && process.version program.usage(' [options]') program.version(Codecept.version()) -program - .command('init [path]') - .description('Creates dummy config in current dir or [path]') - .action(errorHandler(require('../lib/command/init'))) +program.command('init [path]').description('Creates dummy config in current dir or [path]').action(commandHandler('../lib/command/init.js')) program - .command('migrate [path]') - .description('Migrate json config to js config in current dir or [path]') - .action(errorHandler(require('../lib/command/configMigrate'))) + .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(commandHandler('../lib/command/check.js')) + +program.command('migrate [path]').description('Migrate json config to js config in current dir or [path]').action(commandHandler('../lib/command/configMigrate.js')) program .command('shell [path]') @@ -71,34 +91,30 @@ program .option(commandFlags.profile.flag, commandFlags.profile.description) .option(commandFlags.ai.flag, commandFlags.ai.description) .option(commandFlags.config.flag, commandFlags.config.description) - .action(errorHandler(require('../lib/command/interactive'))) + .action(commandHandler('../lib/command/interactive.js')) -program - .command('list [path]') - .alias('l') - .description('List all actions for I.') - .action(errorHandler(require('../lib/command/list'))) +program.command('list [path]').alias('l').description('List all actions for I.').action(commandHandler('../lib/command/list.js')) program .command('def [path]') .description('Generates TypeScript definitions for all I actions.') .option(commandFlags.config.flag, commandFlags.config.description) .option('-o, --output [folder]', 'target folder to paste definitions') - .action(errorHandler(require('../lib/command/definitions'))) + .action(commandHandler('../lib/command/definitions.js')) program .command('gherkin:init [path]') .alias('bdd:init') .description('Prepare CodeceptJS to run feature files.') .option(commandFlags.config.flag, commandFlags.config.description) - .action(errorHandler(require('../lib/command/gherkin/init'))) + .action(commandHandler('../lib/command/gherkin/init.js')) program .command('gherkin:steps [path]') .alias('bdd:steps') .description('Prints all defined gherkin steps.') .option(commandFlags.config.flag, commandFlags.config.description) - .action(errorHandler(require('../lib/command/gherkin/steps'))) + .action(commandHandler('../lib/command/gherkin/steps.js')) program .command('gherkin:snippets [path]') @@ -108,38 +124,22 @@ program .option(commandFlags.config.flag, commandFlags.config.description) .option('--feature [file]', 'feature files(s) to scan') .option('--path [file]', 'file in which to place the new snippets') - .action(errorHandler(require('../lib/command/gherkin/snippets'))) + .action(commandHandler('../lib/command/gherkin/snippets.js')) -program - .command('generate:test [path]') - .alias('gt') - .description('Generates an empty test') - .action(errorHandler(require('../lib/command/generate').test)) +program.command('generate:test [path]').alias('gt').description('Generates an empty test').action(commandHandlerWithProperty('../lib/command/generate.js', 'test')) -program - .command('generate:pageobject [path]') - .alias('gpo') - .description('Generates an empty page object') - .action(errorHandler(require('../lib/command/generate').pageObject)) +program.command('generate:pageobject [path]').alias('gpo').description('Generates an empty page object').action(commandHandlerWithProperty('../lib/command/generate.js', 'pageObject')) program .command('generate:object [path]') .alias('go') .option('--type, -t [kind]', 'type of object to be created') .description('Generates an empty support object (page/step/fragment)') - .action(errorHandler(require('../lib/command/generate').pageObject)) + .action(commandHandlerWithProperty('../lib/command/generate.js', 'pageObject')) -program - .command('generate:helper [path]') - .alias('gh') - .description('Generates a new helper') - .action(errorHandler(require('../lib/command/generate').helper)) +program.command('generate:helper [path]').alias('gh').description('Generates a new helper').action(commandHandlerWithProperty('../lib/command/generate.js', 'helper')) -program - .command('generate:heal [path]') - .alias('gr') - .description('Generates basic heal recipes') - .action(errorHandler(require('../lib/command/generate').heal)) +program.command('generate:heal [path]').alias('gr').description('Generates basic heal recipes').action(commandHandlerWithProperty('../lib/command/generate.js', 'heal')) program .command('run [test]') @@ -178,7 +178,7 @@ program .option('--recursive', 'include sub directories') .option('--trace', 'trace function calls') .option('--child ', 'option for child processes') - .action(errorHandler(require('../lib/command/run'))) + .action(commandHandler('../lib/command/run.js')) program .command('run-workers [selectedRuns...]') @@ -197,7 +197,7 @@ program .option('-p, --plugins ', 'enable plugins, comma-separated') .option('-O, --reporter-options ', 'reporter-specific options') .option('-R, --reporter ', 'specify the reporter to use') - .action(errorHandler(require('../lib/command/run-workers'))) + .action(commandHandler('../lib/command/run-workers.js')) program .command('run-multiple [suites...]') @@ -223,13 +223,9 @@ program // mocha options .option('--colors', 'force enabling of colors') - .action(errorHandler(require('../lib/command/run-multiple'))) + .action(commandHandler('../lib/command/run-multiple.js')) -program - .command('info [path]') - .description('Print debugging information concerning the local environment') - .option('-c, --config', 'your config file path') - .action(errorHandler(require('../lib/command/info'))) +program.command('info [path]').description('Print debugging information concerning the local environment').option('-c, --config', 'your config file path').action(commandHandler('../lib/command/info.js')) program .command('dry-run [test]') @@ -246,7 +242,7 @@ program .option(commandFlags.steps.flag, commandFlags.steps.description) .option(commandFlags.verbose.flag, commandFlags.verbose.description) .option(commandFlags.debug.flag, commandFlags.debug.description) - .action(errorHandler(require('../lib/command/dryRun'))) + .action(commandHandler('../lib/command/dryRun.js')) program .command('run-rerun [test]') @@ -284,9 +280,12 @@ program .option('--trace', 'trace function calls') .option('--child ', 'option for child processes') - .action(require('../lib/command/run-rerun')) + .action(async (...args) => { + const runRerun = await dynamicImport('../lib/command/run-rerun.js') + return runRerun(...args) + }) -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/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/esm-migration.md b/docs/esm-migration.md new file mode 100644 index 000000000..71cee12ac --- /dev/null +++ b/docs/esm-migration.md @@ -0,0 +1,238 @@ +# ESM Migration Guide + +This guide covers the migration to ECMAScript Modules (ESM) format in CodeceptJS v4.x, including important changes in execution behavior and how to adapt your tests. + +## Overview + +CodeceptJS v4.x introduces support for ECMAScript Modules (ESM), which brings modern JavaScript module syntax and better compatibility with the Node.js ecosystem. While most tests will continue working without changes, there are some behavioral differences to be aware of. + +## Quick Migration + +For most users, migrating to ESM is straightforward: + +1. **Add `"type": "module"` to your `package.json`:** + +```json +{ + "name": "your-project", + "type": "module", + "dependencies": { + "codeceptjs": "^4.0.0" + } +} +``` + +2. **Update import syntax in configuration files:** + +```js +// Before (CommonJS) +const { setHeadlessWhen, setCommonPlugins } = require('@codeceptjs/configure') + +// After (ESM) +import { setHeadlessWhen, setCommonPlugins } from '@codeceptjs/configure' +``` + +3. **Update helper imports:** + +```js +// Before (CommonJS) +const Helper = require('@codeceptjs/helper') + +// After (ESM) +import Helper from '@codeceptjs/helper' +``` + +## Known Changes + +### Session and Within Block Execution Order + +**⚠️ Important:** ESM migration has changed the execution timing of `session()` and `within()` blocks. + +#### What Changed + +In CommonJS, session and within blocks executed synchronously, interleaved with main test steps: + +```js +// CommonJS execution order +Scenario('test', ({ I }) => { + I.do('step1') // ← Executes first + session('user', () => { + I.do('session-step') // ← Executes second + }) + I.do('step2') // ← Executes third +}) +``` + +In ESM, session and within blocks execute after the main flow completes: + +```js +// ESM execution order +Scenario('test', ({ I }) => { + I.do('step1') // ← Executes first + session('user', () => { + I.do('session-step') // ← Executes third (after step2) + }) + I.do('step2') // ← Executes second +}) +``` + +#### Impact on Your Tests + +**✅ No Impact (99% of cases):** Most tests will continue working correctly because: + +- All steps still execute completely +- Browser interactions work as expected +- Session isolation is maintained +- Test assertions pass/fail correctly +- Final test state is identical + +**⚠️ Potential Issues (rare edge cases):** + +1. **Cross-session dependencies on immediate state:** + +```js +// POTENTIALLY PROBLEMATIC +I.createUser('alice') +session('alice', () => { + I.login('alice') // May execute before user creation completes +}) +``` + +2. **Within blocks depending on immediate DOM changes:** + +```js +// POTENTIALLY PROBLEMATIC +I.click('Show Advanced Form') +within('.advanced-form', () => { + I.fillField('setting', 'value') // May execute before form appears +}) +``` + +#### Migration Solutions + +If you encounter timing-related issues in edge cases: + +1. **Use explicit waits for dependent operations:** + +```js +// RECOMMENDED FIX +I.createUser('alice') +session('alice', () => { + I.waitForElement('.login-form') // Ensure UI is ready + I.login('alice') +}) +``` + +2. **Add explicit synchronization:** + +```js +// RECOMMENDED FIX +I.click('Show Advanced Form') +I.waitForElement('.advanced-form') // Wait for form to appear +within('.advanced-form', () => { + I.fillField('setting', 'value') +}) +``` + +3. **Use async/await for complex flows:** + +```js +// RECOMMENDED FIX +await I.createUser('alice') +await session('alice', async () => { + await I.login('alice') +}) +``` + +## Best Practices for ESM + +### 1. File Extensions + +Use `.js` extension for ESM files (not `.mjs` unless specifically needed): + +```js +// codecept.conf.js (ESM format) +export default { + tests: './*_test.js', + // ... +} +``` + +### 2. Dynamic Imports + +For conditional imports, use dynamic import syntax: + +```js +// Instead of require() conditions +let helper +if (condition) { + helper = await import('./CustomHelper.js') +} +``` + +### 3. Configuration Export + +Use default export for configuration: + +```js +// codecept.conf.js +export default { + tests: './*_test.js', + output: './output', + helpers: { + Playwright: { + url: 'http://localhost', + }, + }, +} +``` + +### 4. Helper Classes + +Export helper classes as default: + +```js +// CustomHelper.js +import { Helper } from 'codeceptjs' + +class CustomHelper extends Helper { + // helper methods +} + +export default CustomHelper +``` + +## Troubleshooting + +### Common Issues + +1. **Module not found errors:** + - Ensure `"type": "module"` is in package.json + - Use complete file paths with extensions: `import './helper.js'` + +2. **Configuration not loading:** + - Check that config uses `export default {}` + - Verify all imports use ESM syntax + +3. **Timing issues in sessions/within:** + - Add explicit waits as shown in the migration solutions above + - Consider using async/await for complex flows + +4. **Plugin compatibility:** + - Ensure all plugins support ESM + - Update plugin imports to use ESM syntax + +### Getting Help + +If you encounter issues during ESM migration: + +1. Check the [example-esm](../example-esm/) directory for working examples +2. Review error messages for import/export syntax issues +3. Consider the execution order changes for session/within blocks +4. Join the [CodeceptJS community](https://codecept.io/community/) for support + +## Conclusion + +ESM migration brings CodeceptJS into alignment with modern JavaScript standards while maintaining backward compatibility for most use cases. The execution order changes in sessions and within blocks represent internal timing adjustments that rarely affect real-world test functionality. + +The vast majority of CodeceptJS users will experience seamless migration with no functional differences in their tests. 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..c4b54bb0b 100644 --- a/docs/helpers/Appium.md +++ b/docs/helpers/Appium.md @@ -1,10 +1,3 @@ ---- -permalink: /helpers/Appium -editLink: false -sidebar: auto -title: Appium ---- - ## Appium @@ -32,20 +25,20 @@ 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] -* `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 -* `platform`: (Android or IOS), which mobile OS to use; alias to desiredCapabilities.platformName -* `restart`: restart browser or app between tests (default: true), if set to false cookies will be cleaned but browser window will be kept and for apps nothing will be changed. -* `desiredCapabilities`: \[], Appium capabilities, see below - * `platformName` - Which mobile OS platform to use - * `appPackage` - Java package of the Android app you want to run - * `appActivity` - Activity name for the Android activity you want to launch from your package. - * `deviceName`: The kind of mobile device or emulator to use - * `platformVersion`: Mobile OS version - * `app` - The absolute local path or remote http URL to an .ipa or .apk file, or a .zip containing one of these. Appium will attempt to install this app binary on the appropriate device first. - * `browserName`: Name of mobile web browser to automate. Should be an empty string if automating an app instead. +- `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 +- `platform`: (Android or IOS), which mobile OS to use; alias to desiredCapabilities.platformName +- `restart`: restart browser or app between tests (default: true), if set to false cookies will be cleaned but browser window will be kept and for apps nothing will be changed. +- `desiredCapabilities`: [], Appium capabilities, see below + - `platformName` - Which mobile OS platform to use + - `appPackage` - Java package of the Android app you want to run + - `appActivity` - Activity name for the Android activity you want to launch from your package. + - `deviceName`: The kind of mobile device or emulator to use + - `platformVersion`: Mobile OS version + - `app` - The absolute local path or remote http URL to an .ipa or .apk file, or a .zip containing one of these. Appium will attempt to install this app binary on the appropriate device first. + - `browserName`: Name of mobile web browser to automate. Should be an empty string if automating an app instead. Example Android App: @@ -112,7 +105,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, @@ -157,259 +150,251 @@ let browser = this.helpers['Appium'].browser ### Parameters -* `config` +- `config` -### runOnIOS +### appendField -Execute code only on iOS +Appends text to a input field or textarea. +Field is located by name, label, CSS or XPath ```js -I.runOnIOS(() => { - I.click('//UIAApplication[1]/UIAWindow[1]/UIAButton[1]'); - I.see('Hi, IOS', '~welcome'); -}); +I.appendField('#myTextField', 'appended') +// typing secret +I.appendField('password', secret('123456')) ``` -Additional filter can be applied by checking for capabilities. -For instance, this code will be executed only on iPhone 5s: +#### Parameters -```js -I.runOnIOS({deviceName: 'iPhone 5s'},() => { - // ... -}); -``` +- `field` **([string][5] | [object][6])** located by label|name|CSS|XPath|strict locator +- `value` **[string][5]** text value to append. -Also capabilities can be checked by a function. +Returns **void** automatically synchronized promise through #recorder + +### checkIfAppIsInstalled + +Returns app installation status. ```js -I.runOnAndroid((caps) => { - // caps is current config of desiredCapabiliites - return caps.platformVersion >= 6 -},() => { - // ... -}); +I.checkIfAppIsInstalled('com.example.android.apis') ``` #### Parameters -* `caps` **any** -* `fn` **any** - -### runOnAndroid - -Execute code only on Android +- `bundleId` **[string][5]** String ID of bundled app -```js -I.runOnAndroid(() => { - I.click('io.selendroid.testapp:id/buttonTest'); -}); -``` +Returns **[Promise][7]<[boolean][8]>** Appium: support only Android -Additional filter can be applied by checking for capabilities. -For instance, this code will be executed only on Android 6.0: +### checkOption -```js -I.runOnAndroid({platformVersion: '6.0'},() => { - // ... -}); -``` +Selects a checkbox or radio button. +Element is located by label or name or CSS or XPath. -Also capabilities can be checked by a function. -In this case, code will be executed only on Android >= 6. +The second parameter is a context (CSS or XPath locator) to narrow the search. ```js -I.runOnAndroid((caps) => { - // caps is current config of desiredCapabiliites - return caps.platformVersion >= 6 -},() => { - // ... -}); +I.checkOption('#agree') +I.checkOption('I Agree to Terms and Conditions') +I.checkOption('agree', '//form') ``` #### Parameters -* `caps` **any** -* `fn` **any** +- `field` **([string][5] | [object][6])** checkbox located by label | name | CSS | XPath | strict locator. +- `context` **([string][5]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator. -### runInWeb - -Execute code only in Web mode. +Returns **void** automatically synchronized promise through #recorder -```js -I.runInWeb(() => { - I.waitForElement('#data'); - I.seeInCurrentUrl('/data'); -}); -``` +### click -### checkIfAppIsInstalled +Perform a click on a link or a button, given by a locator. +If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string. +For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched. +For images, the "alt" attribute and inner text of any parent links are searched. -Returns app installation status. +The second parameter is a context (CSS or XPath locator) to narrow the search. ```js -I.checkIfAppIsInstalled("com.example.android.apis"); +// simple link +I.click('Logout') +// button of form +I.click('Submit') +// CSS button +I.click('#form input[type=submit]') +// XPath +I.click('//form/*[@type=submit]') +// link in context +I.click('Logout', '#nav') +// using strict locator +I.click({ css: 'nav a.login' }) ``` #### Parameters -* `bundleId` **[string][5]** String ID of bundled app +- `locator` **([string][5] | [object][6])** clickable link or button located by text, or any element located by CSS|XPath|strict locator. +- `context` **([string][5]? | [object][6] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator. -Returns **[Promise][6]<[boolean][7]>** Appium: support only Android +Returns **void** automatically synchronized promise through #recorder -### seeAppIsInstalled +### closeApp -Check if an app is installed. +Close the given application. ```js -I.seeAppIsInstalled("com.example.android.apis"); +I.closeApp() ``` -#### Parameters - -* `bundleId` **[string][5]** String ID of bundled app +Returns **[Promise][7]** Appium: support both Android and iOS -Returns **[Promise][6]\** Appium: support only Android - -### seeAppIsNotInstalled +### dontSee -Check if an app is not installed. +Opposite to `see`. Checks that a text is not present on a page. +Use context parameter to narrow down the search. ```js -I.seeAppIsNotInstalled("com.example.android.apis"); +I.dontSee('Login') // assume we are already logged in. +I.dontSee('Login', '.nav') // no login inside .nav element ``` #### Parameters -* `bundleId` **[string][5]** String ID of bundled app +- `text` **[string][5]** which is not present. +- `context` **([string][5] | [object][6])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search. -Returns **[Promise][6]\** Appium: support only Android +Returns **void** automatically synchronized promise through #recorder -### installApp +### dontSeeCheckboxIsChecked -Install an app on device. +Verifies that the specified checkbox is not checked. ```js -I.installApp('/path/to/file.apk'); +I.dontSeeCheckboxIsChecked('#agree') // located by ID +I.dontSeeCheckboxIsChecked('I agree to terms') // located by label +I.dontSeeCheckboxIsChecked('agree') // located by name ``` #### Parameters -* `path` **[string][5]** path to apk file +- `field` **([string][5] | [object][6])** located by label|name|CSS|XPath|strict locator. -Returns **[Promise][6]\** Appium: support only Android +Returns **void** automatically synchronized promise through #recorder -### removeApp +### dontSeeElement -Remove an app from the device. +Opposite to `seeElement`. Checks that element is not visible (or in DOM) ```js -I.removeApp('appName', 'com.example.android.apis'); +I.dontSeeElement('.modal') // modal is not shown ``` -Appium: support only Android - #### Parameters -* `appId` **[string][5]** -* `bundleId` **[string][5]?** ID of bundle - -### resetApp - -Reset the currently running app for current session. +- `locator` **([string][5] | [object][6])** located by CSS|XPath|Strict locator. -```js -I.resetApp(); -``` +Returns **void** automatically synchronized promise through #recorder -### seeCurrentActivityIs +### dontSeeInField -Check current activity on an Android device. +Checks that value of input field or textarea doesn't equal to given value +Opposite to `seeInField`. ```js -I.seeCurrentActivityIs(".HomeScreenActivity") +I.dontSeeInField('email', 'user@user.com') // field by name +I.dontSeeInField({ css: 'form input.email' }, 'user@user.com') // field by CSS ``` #### Parameters -* `currentActivity` **[string][5]** +- `field` **([string][5] | [object][6])** located by label|name|CSS|XPath|strict locator. +- `value` **([string][5] | [object][6])** value to check. -Returns **[Promise][6]\** Appium: support only Android +Returns **void** automatically synchronized promise through #recorder -### seeDeviceIsLocked +### fillField -Check whether the device is locked. +Fills a text field or textarea, after clearing its value, with the given string. +Field is located by name, label, CSS, or XPath. ```js -I.seeDeviceIsLocked(); +// by label +I.fillField('Email', 'hello@world.com') +// by name +I.fillField('password', secret('123456')) +// by CSS +I.fillField('form#login input[name=username]', 'John') +// or by strict locator +I.fillField({ css: 'form#login input[name=username]' }, 'John') ``` -Returns **[Promise][6]\** Appium: support only Android +#### Parameters -### seeDeviceIsUnlocked +- `field` **([string][5] | [object][6])** located by label|name|CSS|XPath|strict locator. +- `value` **([string][5] | [object][6])** text value to fill. -Check whether the device is not locked. +Returns **void** automatically synchronized promise through #recorder -```js -I.seeDeviceIsUnlocked(); -``` +### grabAllContexts + +Get list of all available contexts -Returns **[Promise][6]\** Appium: support only Android + let contexts = await I.grabAllContexts(); -### seeOrientationIs +Returns **[Promise][7]<[Array][9]<[string][5]>>** Appium: support Android and iOS -Check the device orientation +### grabAttributeFrom + +Can be used for apps only with several values ("contentDescription", "text", "className", "resourceId") + +Retrieves an attribute from an element located by CSS or XPath and returns it to test. +Resumes test execution, so **should be used inside async with `await`** operator. +If more than one element is found - attribute of first element is returned. ```js -I.seeOrientationIs('PORTRAIT'); -I.seeOrientationIs('LANDSCAPE') +let hint = await I.grabAttributeFrom('#tooltip', 'title') ``` #### Parameters -* `orientation` **(`"LANDSCAPE"` | `"PORTRAIT"`)** LANDSCAPE or PORTRAITAppium: support Android and iOS +- `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator. +- `attr` **[string][5]** attribute name. -Returns **[Promise][6]\** +Returns **[Promise][7]<[string][5]>** attribute value -### setOrientation +### grabAttributeFromAll -Set a device orientation. Will fail, if app will not set orientation +Can be used for apps only with several values ("contentDescription", "text", "className", "resourceId") +Retrieves an array of attributes from elements located by CSS or XPath and returns it to test. +Resumes test execution, so **should be used inside async with `await`** operator. ```js -I.setOrientation('PORTRAIT'); -I.setOrientation('LANDSCAPE') +let hints = await I.grabAttributeFromAll('.tooltip', 'title') ``` #### Parameters -* `orientation` **(`"LANDSCAPE"` | `"PORTRAIT"`)** LANDSCAPE or PORTRAITAppium: support Android and iOS - -### grabAllContexts - -Get list of all available contexts - - let contexts = await I.grabAllContexts(); +- `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator. +- `attr` **[string][5]** attribute name. -Returns **[Promise][6]<[Array][8]<[string][5]>>** Appium: support Android and iOS +Returns **[Promise][7]<[Array][9]<[string][5]>>** attribute value ### grabContext Retrieve current context ```js -let context = await I.grabContext(); +let context = await I.grabContext() ``` -Returns **[Promise][6]<([string][5] | null)>** Appium: support Android and iOS +Returns **[Promise][7]<([string][5] | null)>** Appium: support Android and iOS ### grabCurrentActivity Get current device activity. ```js -let activity = await I.grabCurrentActivity(); +let activity = await I.grabCurrentActivity() ``` -Returns **[Promise][6]<[string][5]>** Appium: support only Android +Returns **[Promise][7]<[string][5]>** Appium: support only Android ### grabNetworkConnection @@ -418,130 +403,108 @@ The actual server value will be a number. However WebdriverIO additional properties to the response object to allow easier assertions. ```js -let con = await I.grabNetworkConnection(); +let con = await I.grabNetworkConnection() ``` -Returns **[Promise][6]<{}>** Appium: support only Android +Returns **[Promise][7]<{}>** Appium: support only Android -### grabOrientation +### grabNumberOfVisibleElements -Get current orientation. +Grab number of visible elements by locator. +Resumes test execution, so **should be used inside async function with `await`** operator. ```js -let orientation = await I.grabOrientation(); +let numOfElements = await I.grabNumberOfVisibleElements('p') ``` -Returns **[Promise][6]<[string][5]>** Appium: support Android and iOS - -### grabSettings - -Get all the currently specified settings. +#### Parameters -```js -let settings = await I.grabSettings(); -``` +- `locator` **([string][5] | [object][6])** located by CSS|XPath|strict locator. -Returns **[Promise][6]<[string][5]>** Appium: support Android and iOS +Returns **[Promise][7]<[number][10]>** number of visible elements -### switchToContext +### grabOrientation -Switch to the specified context. +Get current orientation. -#### Parameters +```js +let orientation = await I.grabOrientation() +``` -* `context` **any** the context to switch to +Returns **[Promise][7]<[string][5]>** Appium: support Android and iOS -### switchToWeb +### grabSettings -Switches to web context. -If no context is provided switches to the first detected web context +Get all the currently specified settings. ```js -// switch to first web context -I.switchToWeb(); - -// or set the context explicitly -I.switchToWeb('WEBVIEW_io.selendroid.testapp'); +let settings = await I.grabSettings() ``` -#### Parameters - -* `context` **[string][5]?** +Returns **[Promise][7]<[string][5]>** Appium: support Android and iOS -Returns **[Promise][6]\** - -### switchToNative +### grabTextFrom -Switches to native context. -By default switches to NATIVE\_APP context unless other specified. +Retrieves a text from an element located by CSS or XPath and returns it to test. +Resumes test execution, so **should be used inside async with `await`** operator. ```js -I.switchToNative(); - -// or set context explicitly -I.switchToNative('SOME_OTHER_CONTEXT'); +let pin = await I.grabTextFrom('#pin') ``` +If multiple elements found returns first element. + #### Parameters -* `context` **any?** (optional, default `null`) +- `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator. -Returns **[Promise][6]\** +Returns **[Promise][7]<[string][5]>** attribute value -### startActivity +### grabTextFromAll -Start an arbitrary Android activity during a session. +Retrieves all texts from an element located by CSS or XPath and returns it to test. +Resumes test execution, so **should be used inside async with `await`** operator. ```js -I.startActivity('io.selendroid.testapp', '.RegisterUserActivity'); +let pins = await I.grabTextFromAll('#pin li') ``` -Appium: support only Android - #### Parameters -* `appPackage` **[string][5]** -* `appActivity` **[string][5]** - -Returns **[Promise][6]\** +- `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator. -### setNetworkConnection +Returns **[Promise][7]<[Array][9]<[string][5]>>** attribute value -Set network connection mode. +### grabValueFrom -* airplane mode -* wifi mode -* data data +Retrieves a value from a form element located by CSS or XPath and returns it to test. +Resumes test execution, so **should be used inside async function with `await`** operator. +If more than one element is found - value of first element is returned. ```js -I.setNetworkConnection(0) // airplane mode off, wifi off, data off -I.setNetworkConnection(1) // airplane mode on, wifi off, data off -I.setNetworkConnection(2) // airplane mode off, wifi on, data off -I.setNetworkConnection(4) // airplane mode off, wifi off, data on -I.setNetworkConnection(6) // airplane mode off, wifi on, data on +let email = await I.grabValueFrom('input[name=email]') ``` -See corresponding [webdriverio reference][9]. - -Appium: support only Android - #### Parameters -* `value` **[number][10]** The network connection mode bitmask +- `locator` **([string][5] | [object][6])** field located by label|name|CSS|XPath|strict locator. -Returns **[Promise][6]<[number][10]>** +Returns **[Promise][7]<[string][5]>** attribute value -### setSettings +### grabValueFromAll -Update the current setting on the device +Retrieves an array of value from a form located by CSS or XPath and returns it to test. +Resumes test execution, so **should be used inside async function with `await`** operator. ```js -I.setSettings({cyberdelia: 'open'}); +let inputs = await I.grabValueFromAll('//form/input') ``` #### Parameters -* `settings` **[object][11]** objectAppium: support Android and iOS +- `locator` **([string][5] | [object][6])** field located by label|name|CSS|XPath|strict locator. + +Returns **[Promise][7]<[Array][9]<[string][5]>>** attribute value ### hideDeviceKeyboard @@ -549,730 +512,763 @@ Hide the keyboard. ```js // taps outside to hide keyboard per default -I.hideDeviceKeyboard(); -I.hideDeviceKeyboard('tapOutside'); - -// or by pressing key -I.hideDeviceKeyboard('pressKey', 'Done'); +I.hideDeviceKeyboard() ``` Appium: support Android and iOS +### installApp + +Install an app on device. + +```js +I.installApp('/path/to/file.apk') +``` + #### Parameters -* `strategy` **(`"tapOutside"` | `"pressKey"`)?** Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’) -* `key` **[string][5]?** Optional key +- `path` **[string][5]** path to apk file -### sendDeviceKeyEvent +Returns **[Promise][7]** Appium: support only Android -Send a key event to the device. -List of keys: [https://developer.android.com/reference/android/view/KeyEvent.html][12] +### makeTouchAction + +The Touch Action API provides the basis of all gestures that can be +automated in Appium. At its core is the ability to chain together ad hoc +individual actions, which will then be applied to an element in the +application on the device. +[See complete documentation][11] ```js -I.sendDeviceKeyEvent(3); +I.makeTouchAction('~buttonStartWebviewCD', 'tap') ``` #### Parameters -* `keyValue` **[number][10]** Device specific key value +- `locator` +- `action` -Returns **[Promise][6]\** Appium: support only Android +Returns **[Promise][7]** Appium: support Android and iOS ### openNotifications Open the notifications panel on the device. ```js -I.openNotifications(); +I.openNotifications() ``` -Returns **[Promise][6]\** Appium: support only Android +Returns **[Promise][7]** Appium: support only Android -### makeTouchAction +### performSwipe -The Touch Action API provides the basis of all gestures that can be -automated in Appium. At its core is the ability to chain together ad hoc -individual actions, which will then be applied to an element in the -application on the device. -[See complete documentation][13] +Perform a swipe on the screen. ```js -I.makeTouchAction("~buttonStartWebviewCD", 'tap'); +I.performSwipe({ x: 300, y: 100 }, { x: 200, y: 100 }) ``` #### Parameters -* `locator` -* `action` - -Returns **[Promise][6]\** Appium: support Android and iOS +- `from` **[object][6]** +- `to` **[object][6]** Appium: support Android and iOS -### tap +### pullFile -Taps on element. +Pulls a file from the device. ```js -I.tap("~buttonStartWebviewCD"); +I.pullFile('/storage/emulated/0/DCIM/logo.png', 'my/path') +// save file to output dir +I.pullFile('/storage/emulated/0/DCIM/logo.png', output_dir) ``` -Shortcut for `makeTouchAction` - #### Parameters -* `locator` **any** +- `path` **[string][5]** +- `dest` **[string][5]** -Returns **[Promise][6]\** +Returns **[Promise][7]<[string][5]>** Appium: support Android and iOS -### swipe +### removeApp -Perform a swipe on the screen or an element. +Remove an app from the device. ```js -let locator = "#io.selendroid.testapp:id/LinearLayout1"; -I.swipe(locator, 800, 1200, 1000); +I.removeApp('appName', 'com.example.android.apis') ``` -[See complete reference][14] +Appium: support only Android #### Parameters -* `locator` **([string][5] | [object][11])** -* `xoffset` **[number][10]** -* `yoffset` **[number][10]** -* `speed` **[number][10]** (optional), 1000 by default (optional, default `1000`) +- `appId` **[string][5]** +- `bundleId` **[string][5]?** ID of bundle -Returns **[Promise][6]\** Appium: support Android and iOS - -### performSwipe +### resetApp -Perform a swipe on the screen. +Reset the currently running app for current session. ```js -I.performSwipe({ x: 300, y: 100 }, { x: 200, y: 100 }); +I.resetApp() ``` -#### Parameters - -* `from` **[object][11]** -* `to` **[object][11]** Appium: support Android and iOS - -### swipeDown +### rotate -Perform a swipe down on an element. +Perform a rotation gesture centered on the specified element. ```js -let locator = "#io.selendroid.testapp:id/LinearLayout1"; -I.swipeDown(locator); // simple swipe -I.swipeDown(locator, 500); // set speed -I.swipeDown(locator, 1200, 1000); // set offset and speed +I.rotate(120, 120) ``` +See corresponding [webdriverio reference][12]. + #### Parameters -* `locator` **([string][5] | [object][11])** -* `yoffset` **[number][10]?** (optional) (optional, default `1000`) -* `speed` **[number][10]** (optional), 1000 by default (optional, default `1000`) +- `x` +- `y` +- `duration` +- `radius` +- `rotation` +- `touchCount` -Returns **[Promise][6]\** Appium: support Android and iOS +Returns **[Promise][7]** Appium: support only iOS -### swipeLeft +### runInWeb -Perform a swipe left on an element. +Execute code only in Web mode. ```js -let locator = "#io.selendroid.testapp:id/LinearLayout1"; -I.swipeLeft(locator); // simple swipe -I.swipeLeft(locator, 500); // set speed -I.swipeLeft(locator, 1200, 1000); // set offset and speed +I.runInWeb(() => { + I.waitForElement('#data') + I.seeInCurrentUrl('/data') +}) ``` -#### Parameters +### runOnAndroid -* `locator` **([string][5] | [object][11])** -* `xoffset` **[number][10]?** (optional) (optional, default `1000`) -* `speed` **[number][10]** (optional), 1000 by default (optional, default `1000`) +Execute code only on Android -Returns **[Promise][6]\** Appium: support Android and iOS +```js +I.runOnAndroid(() => { + I.click('io.selendroid.testapp:id/buttonTest') +}) +``` -### swipeRight +Additional filter can be applied by checking for capabilities. +For instance, this code will be executed only on Android 6.0: -Perform a swipe right on an element. +```js +I.runOnAndroid({ platformVersion: '6.0' }, () => { + // ... +}) +``` + +Also capabilities can be checked by a function. +In this case, code will be executed only on Android >= 6. ```js -let locator = "#io.selendroid.testapp:id/LinearLayout1"; -I.swipeRight(locator); // simple swipe -I.swipeRight(locator, 500); // set speed -I.swipeRight(locator, 1200, 1000); // set offset and speed +I.runOnAndroid( + caps => { + // caps is current config of desiredCapabiliites + return caps.platformVersion >= 6 + }, + () => { + // ... + }, +) ``` #### Parameters -* `locator` **([string][5] | [object][11])** -* `xoffset` **[number][10]?** (optional) (optional, default `1000`) -* `speed` **[number][10]** (optional), 1000 by default (optional, default `1000`) +- `caps` **any** +- `fn` **any** -Returns **[Promise][6]\** Appium: support Android and iOS +### runOnIOS -### swipeUp +Execute code only on iOS -Perform a swipe up on an element. +```js +I.runOnIOS(() => { + I.click('//UIAApplication[1]/UIAWindow[1]/UIAButton[1]') + I.see('Hi, IOS', '~welcome') +}) +``` + +Additional filter can be applied by checking for capabilities. +For instance, this code will be executed only on iPhone 5s: ```js -let locator = "#io.selendroid.testapp:id/LinearLayout1"; -I.swipeUp(locator); // simple swipe -I.swipeUp(locator, 500); // set speed -I.swipeUp(locator, 1200, 1000); // set offset and speed +I.runOnIOS({ deviceName: 'iPhone 5s' }, () => { + // ... +}) ``` -#### Parameters +Also capabilities can be checked by a function. -* `locator` **([string][5] | [object][11])** -* `yoffset` **[number][10]?** (optional) (optional, default `1000`) -* `speed` **[number][10]** (optional), 1000 by default (optional, default `1000`) +```js +I.runOnAndroid( + caps => { + // caps is current config of desiredCapabiliites + return caps.platformVersion >= 6 + }, + () => { + // ... + }, +) +``` -Returns **[Promise][6]\** Appium: support Android and iOS +#### Parameters -### swipeTo +- `caps` **any** +- `fn` **any** -Perform a swipe in selected direction on an element to searchable element. +### saveScreenshot + +Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js). +Filename is relative to output folder. ```js -I.swipeTo( - "android.widget.CheckBox", // searchable element - "//android.widget.ScrollView/android.widget.LinearLayout", // scroll element - "up", // direction - 30, - 100, - 500); +I.saveScreenshot('debug.png') ``` #### Parameters -* `searchableLocator` **[string][5]** -* `scrollLocator` **[string][5]** -* `direction` **[string][5]** -* `timeout` **[number][10]** -* `offset` **[number][10]** -* `speed` **[number][10]** +- `fileName` **[string][5]** file name to save. -Returns **[Promise][6]\** Appium: support Android and iOS +Returns **[Promise][7]** -### touchPerform +### scrollIntoView -Performs a specific touch action. -The action object need to contain the action name, x/y coordinates +Scroll element into viewport. ```js -I.touchPerform([{ - action: 'press', - options: { - x: 100, - y: 200 - } -}, {action: 'release'}]) - -I.touchPerform([{ - action: 'tap', - options: { - element: '1', // json web element was queried before - x: 10, // x offset - y: 20, // y offset - count: 1 // number of touches - } -}]); +I.scrollIntoView('#submit') +I.scrollIntoView('#submit', true) +I.scrollIntoView('#submit', { behavior: 'smooth', block: 'center', inline: 'center' }) ``` -Appium: support Android and iOS - #### Parameters -* `actions` **[Array][8]** Array of touch actions +- `locator` **([string][5] | [object][6])** located by CSS|XPath|strict locator. +- `scrollIntoViewOptions` **(ScrollIntoViewOptions | [boolean][8])** either alignToTop=true|false or scrollIntoViewOptions. See [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][13]. -### pullFile +Returns **void** automatically synchronized promise through #recorderSupported only for web testing -Pulls a file from the device. +### see + +Checks that a page contains a visible text. +Use context parameter to narrow down the search. ```js -I.pullFile('/storage/emulated/0/DCIM/logo.png', 'my/path'); -// save file to output dir -I.pullFile('/storage/emulated/0/DCIM/logo.png', output_dir); +I.see('Welcome') // text welcome on a page +I.see('Welcome', '.content') // text inside .content div +I.see('Register', { css: 'form.register' }) // use strict locator ``` #### Parameters -* `path` **[string][5]** -* `dest` **[string][5]** +- `text` **[string][5]** expected on page. +- `context` **([string][5]? | [object][6])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text. -Returns **[Promise][6]<[string][5]>** Appium: support Android and iOS +Returns **void** automatically synchronized promise through #recorder -### shakeDevice +### seeAppIsInstalled -Perform a shake action on the device. +Check if an app is installed. ```js -I.shakeDevice(); +I.seeAppIsInstalled('com.example.android.apis') ``` -Returns **[Promise][6]\** Appium: support only iOS +#### Parameters -### rotate +- `bundleId` **[string][5]** String ID of bundled app -Perform a rotation gesture centered on the specified element. +Returns **[Promise][7]** Appium: support only Android + +### seeAppIsNotInstalled + +Check if an app is not installed. ```js -I.rotate(120, 120) +I.seeAppIsNotInstalled('com.example.android.apis') ``` -See corresponding [webdriverio reference][15]. - #### Parameters -* `x` -* `y` -* `duration` -* `radius` -* `rotation` -* `touchCount` +- `bundleId` **[string][5]** String ID of bundled app -Returns **[Promise][6]\** Appium: support only iOS +Returns **[Promise][7]** Appium: support only Android -### setImmediateValue +### seeCheckboxIsChecked -Set immediate value in app. +Verifies that the specified checkbox is checked. -See corresponding [webdriverio reference][16]. +```js +I.seeCheckboxIsChecked('Agree') +I.seeCheckboxIsChecked('#agree') // I suppose user agreed to terms +I.seeCheckboxIsChecked({ css: '#signup_form input[type=checkbox]' }) +``` #### Parameters -* `id` -* `value` +- `field` **([string][5] | [object][6])** located by label|name|CSS|XPath|strict locator. -Returns **[Promise][6]\** Appium: support only iOS +Returns **void** automatically synchronized promise through #recorder -### simulateTouchId +### seeCurrentActivityIs -Simulate Touch ID with either valid (match == true) or invalid (match == false) fingerprint. +Check current activity on an Android device. ```js -I.touchId(); // simulates valid fingerprint -I.touchId(true); // simulates valid fingerprint -I.touchId(false); // simulates invalid fingerprint +I.seeCurrentActivityIs('.HomeScreenActivity') ``` #### Parameters -* `match` +- `currentActivity` **[string][5]** -Returns **[Promise][6]\** Appium: support only iOS -TODO: not tested +Returns **[Promise][7]** Appium: support only Android -### closeApp +### seeDeviceIsLocked -Close the given application. +Check whether the device is locked. ```js -I.closeApp(); +I.seeDeviceIsLocked() ``` -Returns **[Promise][6]\** Appium: support both Android and iOS +Returns **[Promise][7]** Appium: support only Android -### appendField +### seeDeviceIsUnlocked -Appends text to a input field or textarea. -Field is located by name, label, CSS or XPath +Check whether the device is not locked. ```js -I.appendField('#myTextField', 'appended'); -// typing secret -I.appendField('password', secret('123456')); +I.seeDeviceIsUnlocked() ``` -#### Parameters - -* `field` **([string][5] | [object][11])** located by label|name|CSS|XPath|strict locator -* `value` **[string][5]** text value to append. - -Returns **void** automatically synchronized promise through #recorder - -### checkOption +Returns **[Promise][7]** Appium: support only Android -Selects a checkbox or radio button. -Element is located by label or name or CSS or XPath. +### seeElement -The second parameter is a context (CSS or XPath locator) to narrow the search. +Checks that a given Element is visible +Element is located by CSS or XPath. ```js -I.checkOption('#agree'); -I.checkOption('I Agree to Terms and Conditions'); -I.checkOption('agree', '//form'); +I.seeElement('#modal') ``` #### Parameters -* `field` **([string][5] | [object][11])** checkbox located by label | name | CSS | XPath | strict locator. -* `context` **([string][5]? | [object][11])** (optional, `null` by default) element located by CSS | XPath | strict locator. (optional, default `null`) +- `locator` **([string][5] | [object][6])** located by CSS|XPath|strict locator. Returns **void** automatically synchronized promise through #recorder -### click - -Perform a click on a link or a button, given by a locator. -If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string. -For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched. -For images, the "alt" attribute and inner text of any parent links are searched. +### seeInField -The second parameter is a context (CSS or XPath locator) to narrow the search. +Checks that the given input field or textarea equals to given value. +For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath. ```js -// simple link -I.click('Logout'); -// button of form -I.click('Submit'); -// CSS button -I.click('#form input[type=submit]'); -// XPath -I.click('//form/*[@type=submit]'); -// link in context -I.click('Logout', '#nav'); -// using strict locator -I.click({css: 'nav a.login'}); +I.seeInField('Username', 'davert') +I.seeInField({ css: 'form textarea' }, 'Type your comment here') +I.seeInField('form input[type=hidden]', 'hidden_value') +I.seeInField('#searchform input', 'Search') ``` #### Parameters -* `locator` **([string][5] | [object][11])** clickable link or button located by text, or any element located by CSS|XPath|strict locator. -* `context` **([string][5]? | [object][11] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator. (optional, default `null`) +- `field` **([string][5] | [object][6])** located by label|name|CSS|XPath|strict locator. +- `value` **([string][5] | [object][6])** value to check. Returns **void** automatically synchronized promise through #recorder -### dontSeeCheckboxIsChecked +### seeOrientationIs -Verifies that the specified checkbox is not checked. +Check the device orientation ```js -I.dontSeeCheckboxIsChecked('#agree'); // located by ID -I.dontSeeCheckboxIsChecked('I agree to terms'); // located by label -I.dontSeeCheckboxIsChecked('agree'); // located by name +I.seeOrientationIs('PORTRAIT') +I.seeOrientationIs('LANDSCAPE') ``` #### Parameters -* `field` **([string][5] | [object][11])** located by label|name|CSS|XPath|strict locator. +- `orientation` **(`"LANDSCAPE"` | `"PORTRAIT"`)** LANDSCAPE or PORTRAITAppium: support Android and iOS -Returns **void** automatically synchronized promise through #recorder +Returns **[Promise][7]** -### dontSeeElement +### selectOption -Opposite to `seeElement`. Checks that element is not visible (or in DOM) +Selects an option in a drop-down select. +Field is searched by label | name | CSS | XPath. +Option is selected by visible text or by value. + +```js +I.selectOption('Choose Plan', 'Monthly') // select by label +I.selectOption('subscription', 'Monthly') // match option by text +I.selectOption('subscription', '0') // or by value +I.selectOption('//form/select[@name=account]', 'Premium') +I.selectOption('form select[name=account]', 'Premium') +I.selectOption({ css: 'form select[name=account]' }, 'Premium') +``` + +Provide an array for the second argument to select multiple options. ```js -I.dontSeeElement('.modal'); // modal is not shown +I.selectOption('Which OS do you use?', ['Android', 'iOS']) ``` #### Parameters -* `locator` **([string][5] | [object][11])** located by CSS|XPath|Strict locator. +- `select` **([string][5] | [object][6])** field located by label|name|CSS|XPath|strict locator. +- `option` **([string][5] | [Array][9])** visible text or value of option. -Returns **void** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorderSupported only for web testing -### dontSeeInField +### sendDeviceKeyEvent -Checks that value of input field or textarea doesn't equal to given value -Opposite to `seeInField`. +Send a key event to the device. +List of keys: [https://developer.android.com/reference/android/view/KeyEvent.html][14] ```js -I.dontSeeInField('email', 'user@user.com'); // field by name -I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS +I.sendDeviceKeyEvent(3) ``` #### Parameters -* `field` **([string][5] | [object][11])** located by label|name|CSS|XPath|strict locator. -* `value` **([string][5] | [object][11])** value to check. +- `keyValue` **[number][10]** Device specific key value -Returns **void** automatically synchronized promise through #recorder +Returns **[Promise][7]** Appium: support only Android -### dontSee +### setImmediateValue -Opposite to `see`. Checks that a text is not present on a page. -Use context parameter to narrow down the search. +Set immediate value in app. -```js -I.dontSee('Login'); // assume we are already logged in. -I.dontSee('Login', '.nav'); // no login inside .nav element -``` +See corresponding [webdriverio reference][15]. #### Parameters -* `text` **[string][5]** which is not present. -* `context` **([string][5] | [object][11])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search. (optional, default `null`) +- `id` +- `value` -Returns **void** automatically synchronized promise through #recorder +Returns **[Promise][7]** Appium: support only iOS -### fillField +### setNetworkConnection -Fills a text field or textarea, after clearing its value, with the given string. -Field is located by name, label, CSS, or XPath. +Set network connection mode. + +- airplane mode +- wifi mode +- data data ```js -// by label -I.fillField('Email', 'hello@world.com'); -// by name -I.fillField('password', secret('123456')); -// by CSS -I.fillField('form#login input[name=username]', 'John'); -// or by strict locator -I.fillField({css: 'form#login input[name=username]'}, 'John'); +I.setNetworkConnection(0) // airplane mode off, wifi off, data off +I.setNetworkConnection(1) // airplane mode on, wifi off, data off +I.setNetworkConnection(2) // airplane mode off, wifi on, data off +I.setNetworkConnection(4) // airplane mode off, wifi off, data on +I.setNetworkConnection(6) // airplane mode off, wifi on, data on ``` +See corresponding [webdriverio reference][16]. + +Appium: support only Android + #### Parameters -* `field` **([string][5] | [object][11])** located by label|name|CSS|XPath|strict locator. -* `value` **([string][5] | [object][11])** text value to fill. +- `value` **[number][10]** The network connection mode bitmask -Returns **void** automatically synchronized promise through #recorder +Returns **[Promise][7]<[number][10]>** -### grabTextFromAll +### setOrientation -Retrieves all texts from an element located by CSS or XPath and returns it to test. -Resumes test execution, so **should be used inside async with `await`** operator. +Set a device orientation. Will fail, if app will not set orientation ```js -let pins = await I.grabTextFromAll('#pin li'); +I.setOrientation('PORTRAIT') +I.setOrientation('LANDSCAPE') ``` #### Parameters -* `locator` **([string][5] | [object][11])** element located by CSS|XPath|strict locator. - -Returns **[Promise][6]<[Array][8]<[string][5]>>** attribute value +- `orientation` **(`"LANDSCAPE"` | `"PORTRAIT"`)** LANDSCAPE or PORTRAITAppium: support Android and iOS -### grabTextFrom +### setSettings -Retrieves a text from an element located by CSS or XPath and returns it to test. -Resumes test execution, so **should be used inside async with `await`** operator. +Update the current setting on the device ```js -let pin = await I.grabTextFrom('#pin'); +I.setSettings({ cyberdelia: 'open' }) ``` -If multiple elements found returns first element. - #### Parameters -* `locator` **([string][5] | [object][11])** element located by CSS|XPath|strict locator. +- `settings` **[object][6]** objectAppium: support Android and iOS -Returns **[Promise][6]<[string][5]>** attribute value +### shakeDevice -### grabNumberOfVisibleElements +Perform a shake action on the device. -Grab number of visible elements by locator. -Resumes test execution, so **should be used inside async function with `await`** operator. +```js +I.shakeDevice() +``` + +Returns **[Promise][7]** Appium: support only iOS + +### simulateTouchId + +Simulate Touch ID with either valid (match == true) or invalid (match == false) fingerprint. ```js -let numOfElements = await I.grabNumberOfVisibleElements('p'); +I.touchId() // simulates valid fingerprint +I.touchId(true) // simulates valid fingerprint +I.touchId(false) // simulates invalid fingerprint ``` #### Parameters -* `locator` **([string][5] | [object][11])** located by CSS|XPath|strict locator. +- `match` -Returns **[Promise][6]<[number][10]>** number of visible elements - -### grabAttributeFrom +Returns **[Promise][7]** Appium: support only iOS +TODO: not tested -Can be used for apps only with several values ("contentDescription", "text", "className", "resourceId") +### startActivity -Retrieves an attribute from an element located by CSS or XPath and returns it to test. -Resumes test execution, so **should be used inside async with `await`** operator. -If more than one element is found - attribute of first element is returned. +Start an arbitrary Android activity during a session. ```js -let hint = await I.grabAttributeFrom('#tooltip', 'title'); +I.startActivity('io.selendroid.testapp', '.RegisterUserActivity') ``` +Appium: support only Android + #### Parameters -* `locator` **([string][5] | [object][11])** element located by CSS|XPath|strict locator. -* `attr` **[string][5]** attribute name. +- `appPackage` **[string][5]** +- `appActivity` **[string][5]** -Returns **[Promise][6]<[string][5]>** attribute value +Returns **[Promise][7]** -### grabAttributeFromAll +### swipe -Can be used for apps only with several values ("contentDescription", "text", "className", "resourceId") -Retrieves an array of attributes from elements located by CSS or XPath and returns it to test. -Resumes test execution, so **should be used inside async with `await`** operator. +Perform a swipe on the screen or an element. ```js -let hints = await I.grabAttributeFromAll('.tooltip', 'title'); +let locator = '#io.selendroid.testapp:id/LinearLayout1' +I.swipe(locator, 800, 1200, 1000) ``` +[See complete reference][17] + #### Parameters -* `locator` **([string][5] | [object][11])** element located by CSS|XPath|strict locator. -* `attr` **[string][5]** attribute name. +- `locator` **([string][5] | [object][6])** +- `xoffset` **[number][10]** +- `yoffset` **[number][10]** +- `speed` **[number][10]** (optional), 1000 by default -Returns **[Promise][6]<[Array][8]<[string][5]>>** attribute value +Returns **[Promise][7]** Appium: support Android and iOS -### grabValueFromAll +### swipeDown -Retrieves an array of value from a form located by CSS or XPath and returns it to test. -Resumes test execution, so **should be used inside async function with `await`** operator. +Perform a swipe down on an element. ```js -let inputs = await I.grabValueFromAll('//form/input'); +let locator = '#io.selendroid.testapp:id/LinearLayout1' +I.swipeDown(locator) // simple swipe +I.swipeDown(locator, 500) // set speed +I.swipeDown(locator, 1200, 1000) // set offset and speed ``` #### Parameters -* `locator` **([string][5] | [object][11])** field located by label|name|CSS|XPath|strict locator. +- `locator` **([string][5] | [object][6])** +- `yoffset` **[number][10]?** (optional) +- `speed` **[number][10]** (optional), 1000 by default -Returns **[Promise][6]<[Array][8]<[string][5]>>** attribute value +Returns **[Promise][7]** Appium: support Android and iOS -### grabValueFrom +### swipeLeft -Retrieves a value from a form element located by CSS or XPath and returns it to test. -Resumes test execution, so **should be used inside async function with `await`** operator. -If more than one element is found - value of first element is returned. +Perform a swipe left on an element. ```js -let email = await I.grabValueFrom('input[name=email]'); +let locator = '#io.selendroid.testapp:id/LinearLayout1' +I.swipeLeft(locator) // simple swipe +I.swipeLeft(locator, 500) // set speed +I.swipeLeft(locator, 1200, 1000) // set offset and speed ``` #### Parameters -* `locator` **([string][5] | [object][11])** field located by label|name|CSS|XPath|strict locator. +- `locator` **([string][5] | [object][6])** +- `xoffset` **[number][10]?** (optional) +- `speed` **[number][10]** (optional), 1000 by default -Returns **[Promise][6]<[string][5]>** attribute value +Returns **[Promise][7]** Appium: support Android and iOS -### saveScreenshot +### swipeRight -Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js). -Filename is relative to output folder. +Perform a swipe right on an element. ```js -I.saveScreenshot('debug.png'); +let locator = '#io.selendroid.testapp:id/LinearLayout1' +I.swipeRight(locator) // simple swipe +I.swipeRight(locator, 500) // set speed +I.swipeRight(locator, 1200, 1000) // set offset and speed ``` #### Parameters -* `fileName` **[string][5]** file name to save. +- `locator` **([string][5] | [object][6])** +- `xoffset` **[number][10]?** (optional) +- `speed` **[number][10]** (optional), 1000 by default -Returns **[Promise][6]\** +Returns **[Promise][7]** Appium: support Android and iOS -### scrollIntoView +### swipeTo -Scroll element into viewport. +Perform a swipe in selected direction on an element to searchable element. ```js -I.scrollIntoView('#submit'); -I.scrollIntoView('#submit', true); -I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "center" }); +I.swipeTo( + 'android.widget.CheckBox', // searchable element + '//android.widget.ScrollView/android.widget.LinearLayout', // scroll element + 'up', // direction + 30, + 100, + 500, +) ``` #### Parameters -* `locator` **([string][5] | [object][11])** located by CSS|XPath|strict locator. -* `scrollIntoViewOptions` **(ScrollIntoViewOptions | [boolean][7])** either alignToTop=true|false or scrollIntoViewOptions. See [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][17]. +- `searchableLocator` **[string][5]** +- `scrollLocator` **[string][5]** +- `direction` **[string][5]** +- `timeout` **[number][10]** +- `offset` **[number][10]** +- `speed` **[number][10]** -Returns **void** automatically synchronized promise through #recorderSupported only for web testing +Returns **[Promise][7]** Appium: support Android and iOS -### seeCheckboxIsChecked +### swipeUp -Verifies that the specified checkbox is checked. +Perform a swipe up on an element. ```js -I.seeCheckboxIsChecked('Agree'); -I.seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms -I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'}); +let locator = '#io.selendroid.testapp:id/LinearLayout1' +I.swipeUp(locator) // simple swipe +I.swipeUp(locator, 500) // set speed +I.swipeUp(locator, 1200, 1000) // set offset and speed ``` #### Parameters -* `field` **([string][5] | [object][11])** located by label|name|CSS|XPath|strict locator. +- `locator` **([string][5] | [object][6])** +- `yoffset` **[number][10]?** (optional) +- `speed` **[number][10]** (optional), 1000 by default -Returns **void** automatically synchronized promise through #recorder +Returns **[Promise][7]** Appium: support Android and iOS -### seeElement +### switchToContext -Checks that a given Element is visible -Element is located by CSS or XPath. +Switch to the specified context. + +#### Parameters + +- `context` **any** the context to switch to + +### switchToNative + +Switches to native context. +By default switches to NATIVE_APP context unless other specified. ```js -I.seeElement('#modal'); +I.switchToNative() + +// or set context explicitly +I.switchToNative('SOME_OTHER_CONTEXT') ``` #### Parameters -* `locator` **([string][5] | [object][11])** located by CSS|XPath|strict locator. +- `context` **any?** -Returns **void** automatically synchronized promise through #recorder +Returns **[Promise][7]** -### seeInField +### switchToWeb -Checks that the given input field or textarea equals to given value. -For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath. +Switches to web context. +If no context is provided switches to the first detected web context ```js -I.seeInField('Username', 'davert'); -I.seeInField({css: 'form textarea'},'Type your comment here'); -I.seeInField('form input[type=hidden]','hidden_value'); -I.seeInField('#searchform input','Search'); +// switch to first web context +I.switchToWeb() + +// or set the context explicitly +I.switchToWeb('WEBVIEW_io.selendroid.testapp') ``` #### Parameters -* `field` **([string][5] | [object][11])** located by label|name|CSS|XPath|strict locator. -* `value` **([string][5] | [object][11])** value to check. +- `context` **[string][5]?** -Returns **void** automatically synchronized promise through #recorder +Returns **[Promise][7]** -### see +### tap -Checks that a page contains a visible text. -Use context parameter to narrow down the search. +Taps on element. ```js -I.see('Welcome'); // text welcome on a page -I.see('Welcome', '.content'); // text inside .content div -I.see('Register', {css: 'form.register'}); // use strict locator +I.tap('~buttonStartWebviewCD') ``` +Shortcut for `makeTouchAction` + #### Parameters -* `text` **[string][5]** expected on page. -* `context` **([string][5]? | [object][11])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text. (optional, default `null`) +- `locator` **any** -Returns **void** automatically synchronized promise through #recorder +Returns **[Promise][7]** -### selectOption +### touchPerform -Selects an option in a drop-down select. -Field is searched by label | name | CSS | XPath. -Option is selected by visible text or by value. +Performs a specific touch action. +The action object need to contain the action name, x/y coordinates ```js -I.selectOption('Choose Plan', 'Monthly'); // select by label -I.selectOption('subscription', 'Monthly'); // match option by text -I.selectOption('subscription', '0'); // or by value -I.selectOption('//form/select[@name=account]','Premium'); -I.selectOption('form select[name=account]', 'Premium'); -I.selectOption({css: 'form select[name=account]'}, 'Premium'); +I.touchPerform([ + { + action: 'press', + options: { + x: 100, + y: 200, + }, + }, + { action: 'release' }, +]) + +I.touchPerform([ + { + action: 'tap', + options: { + element: '1', // json web element was queried before + x: 10, // x offset + y: 20, // y offset + count: 1, // number of touches + }, + }, +]) ``` -Provide an array for the second argument to select multiple options. - -```js -I.selectOption('Which OS do you use?', ['Android', 'iOS']); -``` +Appium: support Android and iOS #### Parameters -* `select` **([string][5] | [object][11])** field located by label|name|CSS|XPath|strict locator. -* `option` **([string][5] | [Array][8]\)** visible text or value of option. - -Returns **void** automatically synchronized promise through #recorderSupported only for web testing +- `actions` **[Array][9]** Array of touch actions ### waitForElement @@ -1280,98 +1276,82 @@ Waits for element to be present on page (by default waits for 1sec). Element can be located by CSS or XPath. ```js -I.waitForElement('.btn.continue'); -I.waitForElement('.btn.continue', 5); // wait for 5 secs +I.waitForElement('.btn.continue') +I.waitForElement('.btn.continue', 5) // wait for 5 secs ``` #### Parameters -* `locator` **([string][5] | [object][11])** element located by CSS|XPath|strict locator. -* `sec` **[number][10]?** (optional, `1` by default) time in seconds to wait (optional, default `null`) +- `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator. +- `sec` **[number][10]?** (optional, `1` by default) time in seconds to wait Returns **void** automatically synchronized promise through #recorder -### waitForVisible +### waitForInvisible -Waits for an element to become visible on a page (by default waits for 1sec). +Waits for an element to be removed or become invisible on a page (by default waits for 1sec). Element can be located by CSS or XPath. ```js -I.waitForVisible('#popup'); +I.waitForInvisible('#popup') ``` #### Parameters -* `locator` **([string][5] | [object][11])** element located by CSS|XPath|strict locator. -* `sec` **[number][10]** (optional, `1` by default) time in seconds to wait (optional, default `1`) +- `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator. +- `sec` **[number][10]** (optional, `1` by default) time in seconds to wait Returns **void** automatically synchronized promise through #recorder -### waitForInvisible +### waitForText -Waits for an element to be removed or become invisible on a page (by default waits for 1sec). +Waits for a text to appear (by default waits for 1sec). Element can be located by CSS or XPath. +Narrow down search results by providing context. ```js -I.waitForInvisible('#popup'); +I.waitForText('Thank you, form has been submitted') +I.waitForText('Thank you, form has been submitted', 5, '#modal') ``` #### Parameters -* `locator` **([string][5] | [object][11])** element located by CSS|XPath|strict locator. -* `sec` **[number][10]** (optional, `1` by default) time in seconds to wait (optional, default `1`) +- `text` **[string][5]** to wait for. +- `sec` **[number][10]** (optional, `1` by default) time in seconds to wait +- `context` **([string][5] | [object][6])?** (optional) element located by CSS|XPath|strict locator. Returns **void** automatically synchronized promise through #recorder -### waitForText +### waitForVisible -Waits for a text to appear (by default waits for 1sec). +Waits for an element to become visible on a page (by default waits for 1sec). Element can be located by CSS or XPath. -Narrow down search results by providing context. ```js -I.waitForText('Thank you, form has been submitted'); -I.waitForText('Thank you, form has been submitted', 5, '#modal'); +I.waitForVisible('#popup') ``` #### Parameters -* `text` **[string][5]** to wait for. -* `sec` **[number][10]** (optional, `1` by default) time in seconds to wait (optional, default `1`) -* `context` **([string][5] | [object][11])?** (optional) element located by CSS|XPath|strict locator. (optional, default `null`) +- `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator. +- `sec` **[number][10]** (optional, `1` by default) time in seconds to wait Returns **void** automatically synchronized promise through #recorder [1]: http://codecept.io/helpers/WebDriver/ - [2]: https://appium.io/docs/en/2.1/ - [3]: https://codecept.io/mobile/#setting-up - [4]: https://github.com/appium/appium/blob/master/packages/appium/docs/en/guides/caps.md - [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise - -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array - -[9]: https://webdriver.io/docs/api/chromium/#setnetworkconnection - +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise +[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean +[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array [10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number - -[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[12]: https://developer.android.com/reference/android/view/KeyEvent.html - -[13]: http://webdriver.io/api/mobile/touchAction.html - -[14]: http://webdriver.io/api/mobile/swipe.html - -[15]: http://webdriver.io/api/mobile/rotate.html - -[16]: http://webdriver.io/api/mobile/setImmediateValue.html - -[17]: https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView +[11]: http://webdriver.io/api/mobile/touchAction.html +[12]: http://webdriver.io/api/mobile/rotate.html +[13]: https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView +[14]: https://developer.android.com/reference/android/view/KeyEvent.html +[15]: http://webdriver.io/api/mobile/setImmediateValue.html +[16]: https://webdriver.io/docs/api/chromium/#setnetworkconnection +[17]: http://webdriver.io/api/mobile/swipe.html 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/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/installation.md b/docs/installation.md index f5ece2ac7..de9098aa7 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -38,7 +38,7 @@ If you plan to use CodeceptJS for **API testing** only proceed to standard insta ## Standard Installation Open a directory where you want to install CodeceptJS tests. -If it is an empty directory - create a new NPM package with +If it is an empty directory - create a new NPM package with ``` npm init -y @@ -50,12 +50,21 @@ Install CodeceptJS with NPM: npx codeceptjs init ``` -After choosing default helper (Playwright, Puppeteer, WebDriver, etc) a corresponding package should be installed automatically. +After choosing default helper (Playwright, Puppeteer, WebDriver, etc) a corresponding package should be installed automatically. > If you face issues installing additional packages while running `npx codeceptjs init` command, install required packages manually using npm Unless you are using WebDriver - CodeceptJS is ready to go! -For WebDriver installation Selenium Server is required 👇 +For WebDriver installation Selenium Server is required 👇 + +## ESM Support + +CodeceptJS v4.x supports ECMAScript Modules (ESM) format. To use ESM: + +1. Add `"type": "module"` to your `package.json` +2. Update import syntax in configuration files to use ESM format + +For detailed migration instructions and important behavioral changes, see the **[ESM Migration Guide](esm-migration.md)**. ## WebDriver @@ -65,7 +74,6 @@ We recommend to install them manually or use NPM packages: [Selenium Standalone](https://www.npmjs.com/package/selenium-standalone) to install and run Selenium, ChromeDriver, Firefox Driver with one package. - Alternatively, you can execute headless Selenium in [Docker](https://github.com/SeleniumHQ/docker-selenium) for headless browser testing. Launch Selenium with Chrome browser inside a Docker container: diff --git a/docs/plugins.md b/docs/plugins.md index 30e3b5e69..6ef3ca83b 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -1,53 +1,69 @@ --- permalink: plugins -sidebarDepth: +sidebarDepth: sidebar: auto title: Plugins --- -## 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. +## analyze -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. +Uses AI to analyze test failures and provide insights -Commands affected (by default): +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. -- `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,117 +287,54 @@ autoLogin: { ``` ```js -Scenario('login', async ({ I, login }) => { +Scenario('login', async ( {I, login} ) => { await login('admin') // you should use `await` }) ``` ### Parameters -- `config` - -## commentStep - -Add descriptive nested steps for your tests: - -```js -Scenario('project update test', async (I) => { - __`Given` - const projectId = await I.have('project') - - __`When` - projectPage.update(projectId, { title: 'new title' }) +* `config` - __`Then` - projectPage.open(projectId) - I.see('new title', 'h1') -}) -``` - -Steps prefixed with `__` will be printed as nested steps in `--steps` output: - - Given - I have "project" - When - projectPage update - Then - projectPage open - I see "new title", "h1" - -Also those steps will be exported to allure reports. - -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. +## autoDelay -### Examples +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. -Registering `__` globally: +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. -```js -plugins: { - commentStep: { - enabled: true, - registerGlobal: true - } -} -``` +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. -Registering `Step` globally: +Commands affected (by default): -```js -plugins: { - commentStep: { - enabled: true, - registerGlobal: 'Step' - } -} -``` +* `click` +* `fillField` +* `checkOption` +* `pressKey` +* `doubleClick` +* `rightClick` -Using only local function names: +#### Configuration ```js plugins: { - commentStep: { - enabled: true - } + autoDelay: { + enabled: true + } } ``` -Then inside a test import a comment function from a plugin. -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 Given = () => step`Given` -const When = () => step`When` -const Then = () => step`Then` -``` - -Scenario('project update test', async (I) => { -Given(); -const projectId = await I.have('project'); - -When(); -projectPage.update(projectId, { title: 'new title' }); - -Then(); -projectPage.open(projectId); -I.see('new title', 'h1'); -}); - -``` +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` +* `config` ## coverage @@ -400,21 +353,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: @@ -430,11 +383,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: @@ -453,8 +406,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: @@ -473,8 +426,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: @@ -494,8 +447,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 @@ -513,168 +466,73 @@ 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] -``` - -### 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, -} +I.seeElement('=user'); // matches => [data-qa=user],[data-test=user] +I.click('=sign-up'); // matches => [data-qa=sign-up],[data-test=sign-up] ``` -Additional config options: - -- `errorClasses` - list of classes to search for errors (default: `['error', 'warning', 'alert', 'danger']`) - ### Parameters -- `config` (optional, default `{}`) - -## eachElement - -Provides `eachElement` global function to iterate over found elements to perform actions on them. - -`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. - -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() -}) -``` - -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() -}) -``` +* `config` -Check all elements for visibility: +## customReporter -```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()) -}) -``` - -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] - -#### Configuration - -- `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') -``` +Sample custom reporter for CodeceptJS. ### Parameters -- `purpose` **[string][6]** -- `locator` **CodeceptJS.LocatorOrString** -- `fn` **[Function][7]** - -Returns **([Promise][8]\ | [undefined][9])** - -## fakerTransform - -Use the `@faker-js/faker` package to generate fake data inside examples on your gherkin tests - -#### Usage - -To start please install `@faker-js/faker` package +* `config` - npm install -D @faker-js/faker +## heal - +Self-healing tests with AI. - yarn add -D @faker-js/faker - -Add this plugin to config file: +Read more about heaking in [Self-Healing Tests][4] ```js plugins: { - fakerTransform: { - enabled: true + heal: { + enabled: true, } } ``` -Add the faker API using a mustache string format inside examples tables in your gherkin scenario outline +More config options are available: -```feature -Scenario Outline: ... - Given ... - When ... - Then ... - Examples: - | productName | customer | email | anythingMore | - | {{commerce.product}} | Dr. {{name.findName}} | {{internet.email}} | staticData | -``` +* `healLimit` - how many steps can be healed in a single test (default: 2) ### Parameters -- `config` +* `config` (optional, default `{}`) -## heal +## pageInfo -Self-healing tests with AI. +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. -Read more about heaking in [Self-Healing Tests][10] +It collects URL, HTML errors (by classes), and browser logs. + +Enable this plugin in config: ```js plugins: { - heal: { - enabled: true, - } + pageInfo: { + enabled: true, } ``` -More config options are available: +Additional config options: -- `healLimit` - how many steps can be healed in a single test (default: 2) +* `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 `{}`) +* `config` (optional, default `{}`) ## pauseOnFail -Automatically launches [interactive pause][11] when a test fails. +Automatically launches [interactive pause][5] when a test fails. Useful for debugging flaky tests on local environment. Add this plugin to config file: @@ -698,9 +556,9 @@ Add this plugin to config file: ```js plugins: { - retryFailedStep: { - enabled: true - } + retryFailedStep: { + enabled: true + } } ``` @@ -710,22 +568,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 @@ -748,87 +606,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 @@ -844,141 +629,24 @@ Configuration can either be taken from a corresponding helper (deprecated) or a ```js plugins: { - screenshotOnFail: { - enabled: true - } -} -``` - -Possible config options: - -- `uniqueScreenshotNames`: use unique names for screenshot. Default: false. -- `fullPageScreenshots`: make full page screenshots. Default: false. - -### Parameters - -- `config` - -## selenoid - -[Selenoid][12] 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 - -### Usage - -Selenoid plugin can be started in two ways: - -1. **Automatic** - this plugin will create and manage selenoid container for you. -2. **Manual** - you create the conatainer and configure it with a plugin (recommended). - -#### Automatic - -If you are new to Selenoid and you want plug and play setup use automatic mode. - -Add plugin configuration in `codecept.conf.js`: - -```js -plugins: { - selenoid: { - enabled: true, - deletePassed: true, - autoCreate: true, - autoStart: true, - sessionTimeout: '30m', - enableVideo: true, - enableLog: true, - }, - } -``` - -When `autoCreate` is enabled it will pull the [latest Selenoid from DockerHub][14] 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. - -> **If you are using Windows machine or if `autoCreate` does not work properly, create container manually** - -#### Manual - -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. - -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. - -_Sample browsers.json_ - -```js -{ - "chrome": { - "default": "latest", - "versions": { - "latest": { - "image": "selenoid/chrome:latest", - "port": "4444", - "path": "/" - } + screenshotOnFail: { + enabled: true } - } } ``` -> It is recommended to use specific versions of browsers in `browsers.json` instead of latest. This will prevent tests fail when browsers will be updated. - -**⚠ At first launch selenoid plugin takes extra time to download all Docker images before tests starts**. - -2. Create Selenoid container - -Run the following command to create a container. To know more [refer here][16] - -```bash -docker create \ ---name selenoid \ --p 4444:4444 \ --v /var/run/docker.sock:/var/run/docker.sock \ --v `pwd`/:/etc/selenoid/:ro \ --v `pwd`/output/video/:/opt/selenoid/video/ \ --e OVERRIDE_VIDEO_OUTPUT_DIR=`pwd`/output/video/ \ -aerokube/selenoid:latest-release -``` - -### Video Recording - -This plugin allows to record and save video per each executed tests. - -When `enableVideo` is `true` this plugin saves video in `output/videos` directory with each test by name -To save space videos for all succesful tests are deleted. This can be changed by `deletePassed` option. - -When `allure` plugin is enabled a video is attached to report automatically. - -### Options: +Possible config options: -| Param | Description | -| ---------------- | ------------------------------------------------------------------------------ | -| name | Name of the container (default : selenoid) | -| port | Port of selenium server (default : 4444) | -| autoCreate | Will automatically create container (Linux only) (default : true) | -| autoStart | If disabled start the container manually before running tests (default : true) | -| 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 | +* `uniqueScreenshotNames`: use unique names for screenshot. Default: false. +* `fullPageScreenshots`: make full page screenshots. Default: false. ### Parameters -- `config` +* `config` ## stepByStepReport -![step-by-step-report][18] +![step-by-step-report][6] 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. @@ -1000,17 +668,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 @@ -1020,9 +688,9 @@ Add this plugin to config file: ```js plugins: { - stepTimeout: { - enabled: true - } + stepTimeout: { + enabled: true + } } ``` @@ -1032,19 +700,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 @@ -1067,7 +735,7 @@ plugins: { ### Parameters -- `config` +* `config` ## subtitles @@ -1077,171 +745,20 @@ 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: { - 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 - -A complete list of all available services can be found on [webdriverio website][19]. - -#### Setup - -1. Install a webdriverio service -2. Enable `wdio` plugin in config -3. Add service name to `services` array inside wdio plugin config. - -See examples below: - -#### Selenium Standalone Service - -Install ` @wdio/selenium-standalone-service` package, as [described here][20]. -It is important to make sure it is compatible with current webdriverio version. - -Enable `wdio` plugin in plugins list and add `selenium-standalone` service: - -```js -plugins: { - wdio: { - enabled: true, - services: ['selenium-standalone'] - // additional config for service can be passed here - } -} -``` - -#### Sauce Service - -Install `@wdio/sauce-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 `sauce` service: - -```js -plugins: { - wdio: { - enabled: true, - services: ['sauce'], - user: ... ,// saucelabs username - key: ... // saucelabs api key - // additional config, from sauce service - } + subtitles: { + enabled: true + } } ``` ---- +[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -In the same manner additional services from webdriverio can be installed, enabled, and configured. +[2]: https://github.com/cenfun/monocart-coverage-reports?tab=readme-ov-file#default-options -#### Configuration +[3]: https://codecept.io/locators#custom-locators -- `services` - list of enabled services -- ... - additional configuration passed into services. +[4]: https://codecept.io/heal/ -### Parameters +[5]: /basics/#pause -- `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 +[6]: https://codecept.io/img/codeceptjs-slideshow.gif 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 dc64917f1..c57e51615 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -16,15 +16,14 @@ export default [ { ignores: ['test/data/output', 'lib/css2xpath/*'], }, - ...compat.extends('airbnb-base'), { languageOptions: { globals: { ...globals.node, }, - ecmaVersion: 2020, - sourceType: 'commonjs', + ecmaVersion: 2022, + sourceType: 'module', }, rules: { @@ -80,6 +79,7 @@ export default [ 'prefer-const': 0, 'no-extra-semi': 0, 'max-classes-per-file': 0, + 'no-return-await': 0, }, }, ] diff --git a/example-esm/.gitignore b/example-esm/.gitignore new file mode 100644 index 000000000..0f528ef91 --- /dev/null +++ b/example-esm/.gitignore @@ -0,0 +1,3 @@ +node_modules/ +output/ +package-lock.json \ No newline at end of file diff --git a/example-esm/README.md b/example-esm/README.md new file mode 100644 index 000000000..818c49a93 --- /dev/null +++ b/example-esm/README.md @@ -0,0 +1,83 @@ +# CodeceptJS ESM Example + +This directory contains a working example of CodeceptJS using ECMAScript Modules (ESM) format. + +## Setup + +This project demonstrates the ESM format with: + +- `"type": "module"` in package.json +- ESM import/export syntax in configuration +- ESM-compatible test execution + +## Running Tests + +```bash +# Install dependencies +npm install + +# Run tests +npm test + +# Run with debug output +npm run test:debug + +# Run with verbose output +npm run test:verbose +``` + +## Key ESM Features Demonstrated + +### 1. Package Configuration + +```json +{ + "type": "module", + "engines": { + "node": ">=16.0.0" + } +} +``` + +### 2. Configuration Export + +The `codecept.conf.js` uses ESM default export: + +```js +export default { + tests: './*_test.js', + // ... configuration +} +``` + +### 3. Test Files + +Test files can use modern JavaScript features including async/await: + +```js +Feature('Basic ESM Test') + +Scenario('demonstrates ESM capabilities', ({ I }) => { + // Basic functionality test + const message = 'Hello ESM World!' + const result = message.includes('ESM') + + if (!result) { + throw new Error('ESM test failed') + } +}) + +Scenario('demonstrates async/await', async ({ I }) => { + const delay = ms => new Promise(resolve => setTimeout(resolve, ms)) + await delay(10) + // Test passes if async/await works correctly +}) +``` + +## Migration from CommonJS + +If migrating from CommonJS format, see the [ESM Migration Guide](../docs/esm-migration.md) for detailed instructions and important behavioral changes. + +## Node.js Version + +ESM support requires Node.js 16.0.0 or higher. This is specified in the `engines` field of package.json. diff --git a/example-esm/basic_test.js b/example-esm/basic_test.js new file mode 100644 index 000000000..1f6c89047 --- /dev/null +++ b/example-esm/basic_test.js @@ -0,0 +1,26 @@ +Feature('Basic ESM Tests') + +Scenario('Demonstrates ESM syntax loading', ({ I }) => { + // This test simply demonstrates that ESM loading works + // The test passes if CodeceptJS can load and execute ESM format files + + // Basic JavaScript to verify execution + const message = 'Hello ESM World!' + const result = message.includes('ESM') + + if (!result) { + throw new Error('ESM test failed') + } +}) + +Scenario('Demonstrates async/await with ESM', async ({ I }) => { + // Demonstrate async functionality works in ESM + const delay = ms => new Promise(resolve => setTimeout(resolve, ms)) + + await delay(10) // Small delay to test async + + const timestamp = new Date().toISOString() + if (!timestamp.includes('T')) { + throw new Error('Timestamp test failed') + } +}) diff --git a/example-esm/codecept.conf.js b/example-esm/codecept.conf.js new file mode 100644 index 000000000..151fac8f0 --- /dev/null +++ b/example-esm/codecept.conf.js @@ -0,0 +1,15 @@ +export default { + tests: './*_test.js', + output: './output', + helpers: { + CustomHelper: { + require: './helpers/CustomHelper.js', + }, + FileSystem: {}, + REST: { + endpoint: 'https://jsonplaceholder.typicode.com', + prettyPrintJson: true, + }, + }, + name: 'codeceptjs-esm-example', +} diff --git a/example-esm/helpers/CustomHelper.js b/example-esm/helpers/CustomHelper.js new file mode 100644 index 000000000..89eb2f20b --- /dev/null +++ b/example-esm/helpers/CustomHelper.js @@ -0,0 +1,89 @@ +import Helper from '@codeceptjs/helper' +import assert from 'assert' + +class CustomHelper extends Helper { + // Basic assertion methods + assertEqual(actual, expected, message) { + assert.strictEqual(actual, expected, message || `Expected ${actual} to equal ${expected}`) + } + + assertNotEqual(actual, expected, message) { + assert.notStrictEqual(actual, expected, message || `Expected ${actual} to not equal ${expected}`) + } + + assertTrue(value, message) { + assert.strictEqual(value, true, message || `Expected ${value} to be true`) + } + + assertFalse(value, message) { + assert.strictEqual(value, false, message || `Expected ${value} to be false`) + } + + assertExists(value, message) { + assert.ok(value, message || `Expected ${value} to exist`) + } + + assertNotExists(value, message) { + assert.ok(!value, message || `Expected ${value} to not exist`) + } + + assertContains(haystack, needle, message) { + if (Array.isArray(haystack)) { + assert.ok(haystack.includes(needle), message || `Expected ${JSON.stringify(haystack)} to contain ${needle}`) + } else if (typeof haystack === 'string') { + assert.ok(haystack.includes(needle), message || `Expected "${haystack}" to contain "${needle}"`) + } else { + throw new Error('assertContains requires array or string as first argument') + } + } + + assertNotContains(haystack, needle, message) { + if (Array.isArray(haystack)) { + assert.ok(!haystack.includes(needle), message || `Expected ${JSON.stringify(haystack)} to not contain ${needle}`) + } else if (typeof haystack === 'string') { + assert.ok(!haystack.includes(needle), message || `Expected "${haystack}" to not contain "${needle}"`) + } else { + throw new Error('assertNotContains requires array or string as first argument') + } + } + + assertGreaterThan(actual, expected, message) { + assert.ok(actual > expected, message || `Expected ${actual} to be greater than ${expected}`) + } + + assertLessThan(actual, expected, message) { + assert.ok(actual < expected, message || `Expected ${actual} to be less than ${expected}`) + } + + assertThrows(fn, message) { + assert.throws(fn, message || 'Expected function to throw') + } + + assertDoesNotThrow(fn, message) { + assert.doesNotThrow(fn, message || 'Expected function to not throw') + } + + // Utility methods + log(message) { + console.log(`[CustomHelper] ${message}`) + } + + sleep(ms) { + return new Promise(resolve => setTimeout(resolve, ms)) + } + + getCurrentTimestamp() { + return new Date().toISOString() + } + + generateRandomString(length = 10) { + const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789' + let result = '' + for (let i = 0; i < length; i++) { + result += chars.charAt(Math.floor(Math.random() * chars.length)) + } + return result + } +} + +export default CustomHelper diff --git a/example-esm/package.json b/example-esm/package.json new file mode 100644 index 000000000..ed356bcf4 --- /dev/null +++ b/example-esm/package.json @@ -0,0 +1,20 @@ +{ + "name": "codeceptjs-esm-example", + "version": "1.0.0", + "type": "module", + "description": "Example project for testing CodeceptJS ESM migration", + "scripts": { + "test": "codeceptjs run", + "test:debug": "codeceptjs run --debug", + "test:verbose": "codeceptjs run --verbose" + }, + "dependencies": { + "codeceptjs": "file:..", + "axios": "^1.6.0", + "joi": "^17.11.0" + }, + "devDependencies": {}, + "engines": { + "node": ">=16.0.0" + } +} diff --git a/example-esm/steps.d.ts b/example-esm/steps.d.ts new file mode 100644 index 000000000..d5d62ecc0 --- /dev/null +++ b/example-esm/steps.d.ts @@ -0,0 +1,13 @@ +/// + +declare namespace CodeceptJS { + interface SupportObject { + I: I + current: any + } + + interface I extends WithTranslation {} + namespace Translation { + interface Actions {} + } +} diff --git a/examples/codecept.config.js b/examples/codecept.config.js index 2f4b03d64..6d42ad9c4 100644 --- a/examples/codecept.config.js +++ b/examples/codecept.config.js @@ -1,6 +1,6 @@ -require('./heal_recipes'); +import './heal_recipes.js' -exports.config = { +export const config = { output: './output', helpers: { Playwright: { @@ -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/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/heal_recipes.js b/examples/heal_recipes.js index 7a8120461..dcc293c85 100644 --- a/examples/heal_recipes.js +++ b/examples/heal_recipes.js @@ -1,22 +1,19 @@ -const { heal } = require('../lib/index'); +import { heal } from '../lib/index.js' heal.addRecipe('clickAndType', { priority: 1, - steps: [ - 'fillField', - 'appendField', - ], + steps: ['fillField', 'appendField'], fn: async ({ step }) => { - const locator = step.args[0]; - const text = step.args[1]; + const locator = step.args[0] + const text = step.args[1] return ({ I }) => { - I.click(locator); - I.wait(1); // to open modal or something - I.type(text); - }; + I.click(locator) + I.wait(1) // to open modal or something + I.type(text) + } }, -}); +}) // if error X -> send request to service // if cached -> send request to invalidate cache 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 63b5067fe..ab2238c32 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'); +import Step, { MetaStep } from './step.js' +import recordStep from './step/record.js' +import retryStep from './step/retry.js' +import { methodsOfObject } from './utils.js' +import { TIMEOUT_ORDER } from './timeout.js' +import event from './event.js' +import store from './store.js' +import output from './output.js' +import Container from './container.js' /** * @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 + + console.log('I.limitTime() is deprecated, use step.timeout() instead') event.dispatcher.prependOnceListener(event.step.before, step => { - output.log(`Timeout to ${step}: ${timeout}s`); - step.setTimeout(timeout * 1000, Step.TIMEOUT_ORDER.codeLimitTime); - }); + output.log(`Timeout to ${step}: ${timeout}s`) + step.setTimeout(timeout * 1000, TIMEOUT_ORDER.codeLimitTime) + }) - return this; + return this } /** @@ -55,11 +58,9 @@ 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') + retryStep(opts) + return this } } @@ -69,103 +70,60 @@ class Actor { * Wraps helper methods into promises. * @ignore */ -module.exports = function (obj = {}) { - const actor = container.actor() || new Actor(); +export default function (obj = {}, container) { + // Use global container if none provided + if (!container) { + container = Container + } + + const actor = container.actor() || new Actor() // load all helpers once container initialized container.started(() => { - const translation = container.translation(); - const helpers = container.helpers(); + const translation = container.translation() + const helpers = container.helpers() // 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); + 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)) + } } - }); - }); + }) + }) // add translated custom steps from actor Object.keys(obj).forEach(key => { - const actionAlias = translation.actionAliasFor(key); + const actionAlias = translation.actionAliasFor(key) if (!actor[actionAlias]) { - actor[actionAlias] = actor[key]; + 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; -}; - -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 + const ms = new MetaStep('I', key) + ms.setContext(actor) + actor[key] = ms.run.bind(ms, obj[key]) + }) - return recorder.promise(); + return actor } diff --git a/lib/ai.js b/lib/ai.js index 86dffcd3b..8c7beb1f3 100644 --- a/lib/ai.js +++ b/lib/ai.js @@ -1,40 +1,45 @@ -const debug = require('debug')('codeceptjs:ai'); -const output = require('./output'); -const event = require('./event'); -const { removeNonInteractiveElements, minifyHtml, splitByChunks } = require('./html'); +import debugModule from 'debug' +const debug = debugModule('codeceptjs:ai') +import output from './output.js' +import event from './event.js' +import { removeNonInteractiveElements, minifyHtml, splitByChunks } from './html.js' 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 +65,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 +140,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 +223,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 +237,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(); +export default new AiAssistant() diff --git a/lib/assert.js b/lib/assert.js index 7e2cbc46d..db65f1367 100644 --- a/lib/assert.js +++ b/lib/assert.js @@ -1,4 +1,4 @@ -const AssertionFailedError = require('./assert/error'); +import AssertionFailedError from './assert/error.js' /** * Abstract assertion class introduced for more verbose and customizable messages. @@ -22,9 +22,9 @@ const AssertionFailedError = require('./assert/error'); */ class Assertion { constructor(comparator, params) { - this.comparator = comparator; - this.params = params || {}; - this.params.customMessage = ''; + this.comparator = comparator + this.params = params || {} + this.params.customMessage = '' } /** @@ -32,10 +32,10 @@ class Assertion { * Fails if comparator function with provided arguments returns false */ assert() { - this.addAssertParams.apply(this, arguments); - const result = this.comparator.apply(this.params, arguments); - if (result) return; // should increase global assertion counter - throw this.getFailedAssertion(); + this.addAssertParams.apply(this, arguments) + const result = this.comparator.apply(this.params, arguments) + if (result) return // should increase global assertion counter + throw this.getFailedAssertion() } /** @@ -43,10 +43,10 @@ class Assertion { * Fails if comparator function with provided arguments returns true */ negate() { - this.addAssertParams.apply(this, arguments); - const result = this.comparator.apply(this.params, arguments); - if (!result) return; // should increase global assertion counter - throw this.getFailedNegation(); + this.addAssertParams.apply(this, arguments) + const result = this.comparator.apply(this.params, arguments) + if (!result) return // should increase global assertion counter + throw this.getFailedNegation() } /** @@ -55,18 +55,18 @@ class Assertion { addAssertParams() {} getException() { - return new AssertionFailedError(this.params, ''); + return new AssertionFailedError(this.params, '') } getFailedNegation() { - const err = this.getException(); - err.params.type = `not ${err.params.type}`; - return err; + const err = this.getException() + err.params.type = `not ${err.params.type}` + return err } getFailedAssertion() { - return this.getException(); + return this.getException() } } -module.exports = Assertion; +export default Assertion diff --git a/lib/assert/empty.js b/lib/assert/empty.js index 859bcbfa7..5c0e816ff 100644 --- a/lib/assert/empty.js +++ b/lib/assert/empty.js @@ -1,11 +1,13 @@ -const Assertion = require('../assert') -const AssertionFailedError = require('./error') -const { template } = require('../utils') -const output = require('../output') +import assertionModule from '../assert.js' +const Assertion = assertionModule.default || assertionModule +import AssertionFailedError from './error.js' +import { template } from '../utils.js' +import outputModule from '../output.js' +const output = outputModule.default || outputModule class EmptinessAssertion extends Assertion { constructor(params) { - super((value) => { + super(value => { if (Array.isArray(value)) { return value.length === 0 } @@ -22,9 +24,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 @@ -37,7 +37,6 @@ class EmptinessAssertion extends Assertion { } } -module.exports = { - Assertion: EmptinessAssertion, - empty: (subject) => new EmptinessAssertion({ subject }), -} +export { EmptinessAssertion as Assertion } + +export const empty = subject => new EmptinessAssertion({ subject }) diff --git a/lib/assert/equal.js b/lib/assert/equal.js index f8ef0a9d9..9280de62e 100644 --- a/lib/assert/equal.js +++ b/lib/assert/equal.js @@ -1,7 +1,7 @@ -const Assertion = require('../assert') -const AssertionFailedError = require('./error') -const { template } = require('../utils') -const output = require('../output') +import Assertion from '../assert.js' +import AssertionFailedError from './error.js' +import { template } from '../utils.js' +import output from '../output.js' class EqualityAssertion extends Assertion { constructor(params) { @@ -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() @@ -40,18 +37,16 @@ class EqualityAssertion extends Assertion { } } -module.exports = { - Assertion: EqualityAssertion, - 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) { - actual = actual.slice(actual.indexOf(baseUrl) + baseUrl.length) - } - return actual === expected +export { EqualityAssertion as Assertion } +export const equals = jar => new EqualityAssertion({ jar }) +export const urlEquals = baseUrl => { + const assert = new EqualityAssertion({ jar: 'url of current page' }) + assert.comparator = function (expected, actual) { + if (expected.indexOf('http') !== 0) { + actual = actual.slice(actual.indexOf(baseUrl) + baseUrl.length) } - return assert - }, - fileEquals: (file) => new EqualityAssertion({ file, jar: 'contents of {{file}}' }), + return actual === expected + } + return assert } +export const fileEquals = file => new EqualityAssertion({ file, jar: 'contents of {{file}}' }) diff --git a/lib/assert/error.js b/lib/assert/error.js index ed72233ec..1b11b10a4 100644 --- a/lib/assert/error.js +++ b/lib/assert/error.js @@ -1,4 +1,4 @@ -const subs = require('../utils').template +import { template as subs } from '../utils.js' /** * Assertion errors, can provide a detailed error messages. @@ -29,4 +29,4 @@ function AssertionFailedError(params, template) { AssertionFailedError.prototype = Object.create(Error.prototype) AssertionFailedError.constructor = AssertionFailedError -module.exports = AssertionFailedError +export default AssertionFailedError diff --git a/lib/assert/include.js b/lib/assert/include.js index 3899f4ca0..227b79b55 100644 --- a/lib/assert/include.js +++ b/lib/assert/include.js @@ -1,7 +1,7 @@ -const Assertion = require('../assert') -const AssertionFailedError = require('./error') -const { template } = require('../utils') -const output = require('../output') +import Assertion from '../assert.js' +import AssertionFailedError from './error.js' +import { template } from '../utils.js' +import output from '../output.js' const MAX_LINES = 10 @@ -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 @@ -64,14 +62,12 @@ class InclusionAssertion extends Assertion { } } -module.exports = { - Assertion: InclusionAssertion, - includes: (needleType) => { - needleType = needleType || 'string' - return new InclusionAssertion({ jar: needleType }) - }, - fileIncludes: (file) => new InclusionAssertion({ file, jar: 'file {{file}}' }), +export { InclusionAssertion as Assertion } +export const includes = needleType => { + needleType = needleType || 'string' + return new InclusionAssertion({ jar: needleType }) } +export const fileIncludes = file => new InclusionAssertion({ file, jar: 'file {{file}}' }) function escapeRegExp(str) { return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, '\\$&') diff --git a/lib/assert/throws.js b/lib/assert/throws.js index c0e92276c..7c217c7f2 100644 --- a/lib/assert/throws.js +++ b/lib/assert/throws.js @@ -11,12 +11,10 @@ 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 } -module.exports = errorThrown +export default errorThrown diff --git a/lib/assert/truth.js b/lib/assert/truth.js index 51dbe2def..e2c108b71 100644 --- a/lib/assert/truth.js +++ b/lib/assert/truth.js @@ -1,13 +1,13 @@ -const Assertion = require('../assert') -const AssertionFailedError = require('./error') -const { template } = require('../utils') -const output = require('../output') +import Assertion from '../assert.js' +import AssertionFailedError from './error.js' +import { template } from '../utils.js' +import output from '../output.js' 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) @@ -30,7 +30,10 @@ class TruthAssertion extends Assertion { } } -module.exports = { +export { TruthAssertion as Assertion } +export const truth = (subject, type) => new TruthAssertion({ subject, type }) + +export default { Assertion: TruthAssertion, truth: (subject, type) => new TruthAssertion({ subject, type }), } diff --git a/lib/cli.js b/lib/cli.js deleted file mode 100644 index a408fe1c1..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 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.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 1367f5e48..b88f5d296 100644 --- a/lib/codecept.js +++ b/lib/codecept.js @@ -1,14 +1,34 @@ -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'); +import { existsSync, readFileSync } from 'fs' +import { globSync } from 'glob' +import fsPath from 'path' +import { resolve } from 'path' +import { fileURLToPath } from 'url' +import { dirname } from 'path' +import { createRequire } from 'module' + +const __filename = fileURLToPath(import.meta.url) +const __dirname = dirname(__filename) +const require = createRequire(import.meta.url) + +import Helper from '@codeceptjs/helper'; +import container from './container.js' +import Config from './config.js' +import event from './event.js' +import runHook from './hooks.js' +import ActorFactory from './actor.js' +import output from './output.js' +import { emptyFolder } from './utils.js' +import { initCodeceptGlobals } from './globals.js' + +import storeListener from './listener/store.js' +import stepsListener from './listener/steps.js' +import configListener from './listener/config.js' +import resultListener from './listener/result.js' +import helpersListener from './listener/helpers.js' +import globalTimeoutListener from './listener/globalTimeout.js' +import globalRetryListener from './listener/globalRetry.js' +import exitListener from './listener/exit.js' +import emptyRunListener from './listener/emptyRun.js' /** * CodeceptJS runner @@ -22,10 +42,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) } /** @@ -36,12 +56,12 @@ class Codecept { requireModules(requiringModules) { if (requiringModules) { requiringModules.forEach(requiredModule => { - const isLocalFile = existsSync(requiredModule) || existsSync(`${requiredModule}.js`); + const isLocalFile = existsSync(requiredModule) || existsSync(`${requiredModule}.js`) if (isLocalFile) { - requiredModule = resolve(requiredModule); + requiredModule = resolve(requiredModule) } - require(requiredModule); - }); + require(requiredModule) + }) } } @@ -51,11 +71,13 @@ class Codecept { * * @param {string} dir */ - init(dir) { - this.initGlobals(dir); + async init(dir) { + await this.initGlobals(dir) // initializing listeners - container.create(this.config, this.opts); - this.runHooks(); + await container.create(this.config, this.opts) + // Store container globally for easy access + global.container = container + await this.runHooks() } /** @@ -63,64 +85,35 @@ class Codecept { * * @param {string} dir */ - initGlobals(dir) { - global.codecept_dir = dir; - global.output_dir = fsPath.resolve(dir, this.config.output); - - 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 - - // BDD - const stepDefinitions = require('./interfaces/bdd'); - global.Given = stepDefinitions.Given; - global.When = stepDefinitions.When; - global.Then = stepDefinitions.Then; - global.DefineParameterType = stepDefinitions.defineParameterType; - - // debug mode - global.debugMode = false; - - // mask sensitive data - global.maskSensitiveData = this.config.maskSensitiveData || false; - } + async initGlobals(dir) { + await initCodeceptGlobals(dir, this.config, container) } /** * Executes hooks. */ - 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')); - - // custom hooks (previous iteration of plugins) - this.config.hooks.forEach(hook => runHook(hook)); - } + async runHooks() { + // default hooks + runHook(storeListener) + runHook(stepsListener) + runHook(configListener) + runHook(resultListener) + runHook(helpersListener) + runHook(globalTimeoutListener) + runHook(globalRetryListener) + runHook(exitListener) + runHook(emptyRunListener) + + // custom hooks (previous iteration of plugins) + this.config.hooks.forEach(hook => runHook(hook)) + } /** * Executes bootstrap. * */ async bootstrap() { - return runHook(this.config.bootstrap, 'bootstrap'); + return runHook(this.config.bootstrap, 'bootstrap') } /** @@ -128,7 +121,7 @@ class Codecept { */ async teardown() { - return runHook(this.config.teardown, 'teardown'); + return runHook(this.config.teardown, 'teardown') } /** @@ -139,42 +132,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 (this.config.gherkin && 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,36 +180,44 @@ class Codecept { * @returns {Promise} */ async run(test) { - await container.started(); + await container.started() + + // Ensure translations are loaded for Gherkin features + try { + const { loadTranslations } = await import('./mocha/gherkin.js') + await loadTranslations() + } catch (e) { + // Ignore if gherkin module not available + } 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; +export default Codecept diff --git a/lib/colorUtils.js b/lib/colorUtils.js index ce1f6465a..88fb522f1 100644 --- a/lib/colorUtils.js +++ b/lib/colorUtils.js @@ -144,14 +144,14 @@ function convertColorNameToHex(color) { whitesmoke: '#f5f5f5', yellow: '#ffff00', yellowgreen: '#9acd32', - }; + } - const cColor = `${color}`.toLowerCase(); + const cColor = `${color}`.toLowerCase() if (typeof colors[cColor] !== 'undefined') { - return colors[cColor]; + return colors[cColor] } - return color; + return color } /** @@ -160,23 +160,23 @@ function convertColorNameToHex(color) { */ function convertHexColorToRgba(hex) { // Expand shorthand form (e.g. "#03F") to full form (e.g. "#0033FF") - const shorthandRegex = /^#([a-f\d])([a-f\d])([a-f\d])$/i; + const shorthandRegex = /^#([a-f\d])([a-f\d])([a-f\d])$/i const hexFull = `${hex}`.replace(shorthandRegex, (m, r, g, b) => { - return r + r + g + g + b + b; - }); + return r + r + g + g + b + b + }) - const result = /^#([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hexFull); + const result = /^#([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hexFull) if (!result) { // Return untouched if not a hex code - return hex; + return hex } - const r = parseInt(result[1], 16); - const g = parseInt(result[2], 16); - const b = parseInt(result[3], 16); - const a = 1; + const r = parseInt(result[1], 16) + const g = parseInt(result[2], 16) + const b = parseInt(result[3], 16) + const a = 1 - return `rgba(${r}, ${g}, ${b}, ${a})`; + return `rgba(${r}, ${g}, ${b}, ${a})` } /** @@ -190,29 +190,29 @@ function convertHexColorToRgba(hex) { * @param {string} color Color as a string, i.e. rgb(85,0,0) */ function convertColorToRGBA(color) { - const cstr = `${color}`.toLowerCase().trim() || ''; + const cstr = `${color}`.toLowerCase().trim() || '' if (!/^rgba?\(.+?\)$/.test(cstr)) { // Convert both color names and hex colors to rgba - const hexColor = convertColorNameToHex(color); - return convertHexColorToRgba(hexColor); + const hexColor = convertColorNameToHex(color) + return convertHexColorToRgba(hexColor) } // Convert rgb to rgba - const channels = cstr.match(/([\-0-9.]+)/g) || []; + const channels = cstr.match(/([\-0-9.]+)/g) || [] switch (channels.length) { case 3: // Convert rgb to rgba - return `rgba(${channels.join(', ')}, 1)`; + return `rgba(${channels.join(', ')}, 1)` case 4: // Format rgba - return `rgba(${channels.join(', ')})`; + return `rgba(${channels.join(', ')})` default: // Unexpected color format. Leave it untouched (let the user handle it) - return color; + return color } } @@ -222,34 +222,32 @@ function convertColorToRGBA(color) { * @param {string} prop CSS Property name */ function isColorProperty(prop) { - return [ - 'color', - 'background', - 'backgroundColor', - 'background-color', - 'borderColor', - 'border-color', - 'borderBottomColor', - 'border-bottom-color', - 'borderLeftColor', - 'border-left-color', - 'borderRightColor', - 'borderTopColor', - 'caretColor', - 'columnRuleColor', - 'outlineColor', - 'textDecorationColor', - 'border-right-color', - 'border-top-color', - 'caret-color', - 'column-rule-color', - 'outline-color', - 'text-decoration-color', - ].indexOf(prop) > -1; + return ( + [ + 'color', + 'background', + 'backgroundColor', + 'background-color', + 'borderColor', + 'border-color', + 'borderBottomColor', + 'border-bottom-color', + 'borderLeftColor', + 'border-left-color', + 'borderRightColor', + 'borderTopColor', + 'caretColor', + 'columnRuleColor', + 'outlineColor', + 'textDecorationColor', + 'border-right-color', + 'border-top-color', + 'caret-color', + 'column-rule-color', + 'outline-color', + 'text-decoration-color', + ].indexOf(prop) > -1 + ) } -module.exports = { - isColorProperty, - convertColorToRGBA, - convertColorNameToHex, -}; +export { isColorProperty, convertColorToRGBA, convertColorNameToHex } diff --git a/lib/command/check.js b/lib/command/check.js new file mode 100644 index 000000000..c07a1f5f3 --- /dev/null +++ b/lib/command/check.js @@ -0,0 +1,206 @@ +import { getConfig, getTestRoot } from './utils.js' +import Codecept from '../codecept.js' +import output from '../output.js' +import store from '../store.js' +import Container from '../container.js' +import figures from 'figures' +import chalk from 'chalk' +import { createTest } from '../mocha/test.js' +import { getMachineInfo } from './info.js' +import definitions from './definitions.js' + +export default 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 = await getConfig(configFile) + + try { + config = await getConfig(configFile) + checks['config'] = true + } catch (err) { + checks['config'] = err + } + + printCheck('config', checks['config'], config.name) + + let codecept + try { + codecept = new Codecept(config, options) + await 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 files = codecept.testFiles + const mocha = Container.mocha() + mocha.files = files + mocha.loadFiles() + + for (const suite of mocha.suite.suites) { + if (suite && suite.tests) { + 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) await 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..fbff8095d 100644 --- a/lib/command/configMigrate.js +++ b/lib/command/configMigrate.js @@ -1,22 +1,21 @@ -const colors = require('chalk') -const fs = require('fs') -const inquirer = require('inquirer') -const mkdirp = require('mkdirp') -const path = require('path') -const util = require('util') +import colors from 'chalk' +import fs from 'fs' +import inquirer from 'inquirer' +import { mkdirp } from 'mkdirp' +import path from 'path' +import util from 'util' -const { print, success, error } = require('../output') -const { fileExists } = require('../utils') -const { getTestRoot } = require('./utils') +import output from '../output.js' +const { print, success, error } = output +import { fileExists } from '../utils.js' +import { getTestRoot } from './utils.js' -module.exports = function (initPath) { +export default function (initPath) { const testsPath = getTestRoot(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 +52,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..81bc83e02 100644 --- a/lib/command/definitions.js +++ b/lib/command/definitions.js @@ -1,11 +1,11 @@ -const fs = require('fs') -const path = require('path') +import fs from 'fs' +import path from 'path' -const { getConfig, getTestRoot } = require('./utils') -const Codecept = require('../codecept') -const container = require('../container') -const output = require('../output') -const actingHelpers = [...require('../plugin/standardActingHelpers'), 'REST'] +import { getConfig, getTestRoot } from './utils.js' +import Codecept from '../codecept.js' +import container from '../container.js' +import output from '../output.js' +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} @@ -99,11 +86,11 @@ const helperNames = [] /** @type {Array} */ const customHelpers = [] -module.exports = function (genPath, options) { +export default async function (genPath, options) { const configFile = options.config || genPath /** @type {string} */ const testsPath = getTestRoot(configFile) - const config = getConfig(configFile) + const config = await getConfig(configFile) if (!config) return /** @type {Object} */ @@ -119,7 +106,8 @@ module.exports = function (genPath, options) { const targetFolderPath = (options.output && getTestRoot(options.output)) || testsPath const codecept = new Codecept(config, {}) - codecept.init(testsPath) + await codecept.init(testsPath) + await container.started() const helpers = container.helpers() const translations = container.translation() @@ -185,15 +173,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 +186,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 +209,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}` @@ -247,7 +230,12 @@ function getImportString(testsPath, targetFolderPath, pathsToType, pathsToValue) for (const name in pathsToType) { const relativePath = getPath(pathsToType[name], targetFolderPath, testsPath) - importStrings.push(`type ${name} = typeof import('${relativePath}');`) + // For ESM modules with default exports, we need to access the default export type + if (relativePath.endsWith('.js')) { + importStrings.push(`type ${name} = typeof import('${relativePath}')['default'];`) + } else { + importStrings.push(`type ${name} = typeof import('${relativePath}');`) + } } for (const name in pathsToValue) { diff --git a/lib/command/dryRun.js b/lib/command/dryRun.js index 75734185f..207483764 100644 --- a/lib/command/dryRun.js +++ b/lib/command/dryRun.js @@ -1,18 +1,18 @@ -const { getConfig, getTestRoot } = require('./utils') -const Config = require('../config') -const Codecept = require('../codecept') -const output = require('../output') -const event = require('../event') -const store = require('../store') -const Container = require('../container') - -module.exports = async function (test, options) { +import { getConfig, getTestRoot } from './utils.js' +import Config from '../config.js' +import Codecept from '../codecept.js' +import output from '../output.js' +import event from '../event.js' +import store from '../store.js' +import Container from '../container.js' + +export default async function (test, options) { if (options.grep) process.env.grep = options.grep const configFile = options.config let codecept const testRoot = getTestRoot(configFile) - let config = getConfig(configFile) + let config = await getConfig(configFile) if (options.override) { config = Config.append(JSON.parse(options.override)) } @@ -27,7 +27,7 @@ module.exports = async function (test, options) { try { codecept = new Codecept(config, options) - codecept.init(testRoot) + await codecept.init(testRoot) if (options.bootstrap) await codecept.bootstrap() @@ -35,20 +35,20 @@ module.exports = async function (test, options) { store.dryRun = true if (!options.steps && !options.verbose && !options.debug) { - printTests(codecept.testFiles) + await printTests(codecept.testFiles) return } event.dispatcher.on(event.all.result, printFooter) - codecept.run(test) + await codecept.run(test) } catch (err) { console.error(err) process.exit(1) } } -function printTests(files) { - const figures = require('figures') - const colors = require('chalk') +async function printTests(files) { + const { default: figures } = await import('figures') + const { default: colors } = await import('chalk') output.print(output.styles.debug(`Tests from ${global.codecept_dir}:`)) output.print() diff --git a/lib/command/generate.js b/lib/command/generate.js index 914b11bca..ac80b49f2 100644 --- a/lib/command/generate.js +++ b/lib/command/generate.js @@ -1,12 +1,12 @@ -const colors = require('chalk') -const fs = require('fs') -const inquirer = require('inquirer') -const mkdirp = require('mkdirp') -const path = require('path') -const { fileExists, ucfirst, lcfirst, beautify } = require('../utils') -const output = require('../output') -const generateDefinitions = require('./definitions') -const { getConfig, getTestRoot, safeFileWrite, readConfig } = require('./utils') +import colors from 'chalk' +import fs from 'fs' +import inquirer from 'inquirer' +import { mkdirp } from 'mkdirp' +import path from 'path' +import { fileExists, ucfirst, lcfirst, beautify } from '../utils.js' +import output from '../output.js' +import generateDefinitions from './definitions.js' +import { getConfig, getTestRoot, safeFileWrite, readConfig } from './utils.js' let extension = 'js' @@ -18,10 +18,10 @@ Scenario('test something', async ({ {{actor}} }) => { ` // generates empty test -module.exports.test = function (genPath) { +export async function test(genPath) { const testsPath = getTestRoot(genPath) global.codecept_dir = testsPath - const config = getConfig(testsPath) + const config = await getConfig(testsPath) if (!config) return output.print('Creating a new test...') @@ -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(async result => { const testFilePath = path.dirname(path.join(testsPath, config.tests)).replace(/\*\*$/, '') let testFile = path.join(testFilePath, result.filename) const ext = path.extname(testFile) @@ -55,17 +55,16 @@ module.exports.test = function (genPath) { if (!fileExists(dir)) mkdirp.sync(dir) let testContent = testTemplate.replace('{{feature}}', result.feature) - const container = require('../container') - container.create(config, {}) + const containerModule = await import('../container.js') + const container = containerModule.default || containerModule + await container.create(config, {}) // translate scenario test if (container.translation().loaded) { const vocabulary = container.translation().vocabulary 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') } @@ -78,7 +77,7 @@ module.exports.test = function (genPath) { const pageObjectTemplate = `const { I } = inject(); -module.exports = { +export default { // insert your locators and methods here } @@ -103,13 +102,13 @@ class {{name}} { } // For inheritance -module.exports = new {{name}}(); -export = {{name}}; +export default new {{name}}(); +export { {{name}} }; ` -module.exports.pageObject = function (genPath, opts) { +export async function pageObject(genPath, opts) { const testsPath = getTestRoot(genPath) - const config = getConfig(testsPath) + const config = await getConfig(testsPath) const kind = opts.T || 'page' if (!config) return @@ -128,13 +127,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 +143,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) @@ -157,7 +156,7 @@ module.exports.pageObject = function (genPath, opts) { // relative path actorPath = path.relative(dir, path.dirname(path.join(testsPath, actorPath))) + actorPath.substring(1) // get an upper level } - actor = `require('${actorPath}')` + actor = `import('${actorPath}')` } const name = lcfirst(result.name) + ucfirst(kind) @@ -194,14 +193,12 @@ 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.`) } }) } -const helperTemplate = `const Helper = require('@codeceptjs/helper'); +const helperTemplate = `import Helper from '@codeceptjs/helper'; class {{name}} extends Helper { @@ -226,10 +223,10 @@ class {{name}} extends Helper { } -module.exports = {{name}}; +export default {{name}}; ` -module.exports.helper = function (genPath) { +export async function helper(genPath) { const testsPath = getTestRoot(genPath) output.print('Creating a new helper') @@ -241,16 +238,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) @@ -269,9 +266,11 @@ helpers: { }) } +import { fileURLToPath } from 'url' +const __dirname = path.dirname(fileURLToPath(import.meta.url)) const healTemplate = fs.readFileSync(path.join(__dirname, '../template/heal.js'), 'utf8').toString() -module.exports.heal = function (genPath) { +export async function heal(genPath) { const testsPath = getTestRoot(genPath) let configFile = path.join(testsPath, `codecept.conf.${extension}`) @@ -286,9 +285,9 @@ module.exports.heal = function (genPath) { output.print('Require this file in the config file and enable heal plugin:') output.print('--------------------------') output.print(` -require('./heal') +import './heal.js' -exports.config = { +export const config = { // ... plugins: { heal: { diff --git a/lib/command/gherkin/init.js b/lib/command/gherkin/init.js index a909c27bb..a645b5f45 100644 --- a/lib/command/gherkin/init.js +++ b/lib/command/gherkin/init.js @@ -1,11 +1,9 @@ -const path = require('path'); -const mkdirp = require('mkdirp'); +import path from 'path' +import { mkdirp } from 'mkdirp' -const output = require('../../output'); -const { fileExists } = require('../../utils'); -const { - getConfig, getTestRoot, updateConfig, safeFileWrite, findConfigFile, -} = require('../utils'); +import output from '../../output.js' +import { fileExists } from '../../utils.js' +import { getConfig, getTestRoot, updateConfig, safeFileWrite, findConfigFile } from '../utils.js' const featureFile = `Feature: Business rules In order to achieve my goals @@ -14,7 +12,7 @@ const featureFile = `Feature: Business rules Scenario: do something Given I have a defined step -`; +` const stepsFile = `const { I } = inject(); // Add in your custom step files @@ -22,60 +20,60 @@ const stepsFile = `const { I } = inject(); Given('I have a defined step', () => { // TODO: replace with your own step }); -`; +` -module.exports = function (genPath) { - const testsPath = getTestRoot(genPath); - const configFile = findConfigFile(testsPath); +export default async function (genPath) { + const testsPath = getTestRoot(genPath) + const configFile = findConfigFile(testsPath) if (!configFile) { - output.error( - "Can't initialize Gherkin. This command must be run in an already initialized project.", - ); - process.exit(1); + output.error("Can't initialize Gherkin. This command must be run in an already initialized project.") + process.exit(1) } - const config = getConfig(testsPath); - const extension = path.extname(configFile).substring(1); + const config = await getConfig(testsPath) + const extension = path.extname(configFile).substring(1) - output.print('Initializing Gherkin (Cucumber BDD) for CodeceptJS'); - output.print('--------------------------'); + output.print('Initializing Gherkin (Cucumber BDD) for CodeceptJS') + output.print('--------------------------') if (config.gherkin && config.gherkin.steps) { - output.error('Gherkin is already initialized in this project. See `gherkin` section in the config'); - process.exit(1); + output.error('Gherkin is already initialized in this project. See `gherkin` section in the config') + process.exit(1) } - let dir; - dir = path.join(testsPath, 'features'); + let dir + dir = path.join(testsPath, 'features') if (!fileExists(dir)) { - mkdirp.sync(dir); - output.success(`Created ${dir}, place your *.feature files in it`); + mkdirp.sync(dir) + // Use relative path for output + const relativeDir = path.relative(process.cwd(), dir) + output.success(`Created ${relativeDir}, place your *.feature files in it`) } if (safeFileWrite(path.join(dir, 'basic.feature'), featureFile)) { - output.success('Created sample feature file: features/basic.feature'); + output.success('Created sample feature file: features/basic.feature') } - dir = path.join(testsPath, 'step_definitions'); + dir = path.join(testsPath, 'step_definitions') if (!fileExists(dir)) { - mkdirp.sync(dir); - output.success(`Created ${dir}, place step definitions into it`); + mkdirp.sync(dir) + // Use relative path for output + const relativeDir = path.relative(process.cwd(), dir) + output.success(`Created ${relativeDir}, place step definitions into it`) } if (safeFileWrite(path.join(dir, `steps.${extension}`), stepsFile)) { - output.success( - `Created sample steps file: step_definitions/steps.${extension}`, - ); + output.success(`Created sample steps file: step_definitions/steps.${extension}`) } config.gherkin = { features: './features/*.feature', steps: [`./step_definitions/steps.${extension}`], - }; + } - updateConfig(testsPath, config, extension); + updateConfig(testsPath, config, extension) - output.success('Gherkin setup is done.'); - output.success('Start writing feature files and implement corresponding steps.'); -}; + output.success('Gherkin setup is done.') + output.success('Start writing feature files and implement corresponding steps.') +} diff --git a/lib/command/gherkin/snippets.js b/lib/command/gherkin/snippets.js index e34a62e96..612cb5cd5 100644 --- a/lib/command/gherkin/snippets.js +++ b/lib/command/gherkin/snippets.js @@ -1,113 +1,113 @@ -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'); +import escapeStringRegexp from 'escape-string-regexp' +import fs from 'fs' +import Gherkin from '@cucumber/gherkin' +import { IdGenerator } from '@cucumber/messages' +import { globSync } from 'glob' +import fsPath from 'path' -const { getConfig, getTestRoot } = require('../utils'); -const Codecept = require('../../codecept'); -const output = require('../../output'); -const { matchStep } = require('../../interfaces/bdd'); +import { getConfig, getTestRoot } from '../utils.js' +import Codecept from '../../codecept.js' +import output from '../../output.js' +import { matchStep } from '../../mocha/bdd.js' -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 = 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; +export default async function (genPath, options) { + const configFile = options.config || genPath + const testsPath = getTestRoot(configFile) + const config = await getConfig(configFile) + if (!config) return - const codecept = new Codecept(config, {}); - codecept.init(testsPath); + const codecept = new Codecept(config, {}) + await 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 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 ast = parser.parse(fs.readFileSync(file).toString()) for (const child of ast.feature.children) { - if (child.scenario.keyword === 'Scenario Outline') continue; // skip scenario outline + 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) }); + return Object.assign(step, { file: file.replace(global.codecept_dir, '').slice(1) }) }) - .map(step => newSteps.set(`${step.type}(${step})`, step)); + .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()] @@ -117,18 +117,18 @@ module.exports = function (genPath, options) { ${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..9034b5537 100644 --- a/lib/command/gherkin/steps.js +++ b/lib/command/gherkin/steps.js @@ -1,25 +1,28 @@ -const { getConfig, getTestRoot } = require('../utils'); -const Codecept = require('../../codecept'); -const output = require('../../output'); -const { getSteps } = require('../../interfaces/bdd'); +import { getConfig, getTestRoot } from '../utils.js' +import Codecept from '../../codecept.js' +import output from '../../output.js' +import { getSteps, clearSteps } from '../../mocha/bdd.js' -module.exports = function (genPath, options) { - const configFile = options.config || genPath; - const testsPath = getTestRoot(configFile); - const config = getConfig(configFile); - if (!config) return; +export default async function (genPath, options) { + const configFile = options.config || genPath + const testsPath = getTestRoot(configFile) + const config = await getConfig(configFile) + if (!config) return - const codecept = new Codecept(config, {}); - codecept.init(testsPath); + // Clear any previously loaded steps + clearSteps() + + const codecept = new Codecept(config, {}) + await codecept.init(testsPath) - output.print('Gherkin Step Definitions:'); - output.print(); - const steps = getSteps(); + output.print('Gherkin Step Definitions:') + output.print() + const steps = getSteps() for (const step of Object.keys(steps)) { - output.print(` ${output.colors.bold(step)} ${output.colors.green(steps[step].line || '')}`); + output.print(` ${output.colors.bold(step)} ${output.colors.green(steps[step].line || '')}`) } - output.print(); + output.print() if (!Object.keys(steps).length) { - output.error('No Gherkin steps defined'); + output.error('No Gherkin steps defined') } -}; +} diff --git a/lib/command/info.js b/lib/command/info.js index 55f9856c3..2ba406edc 100644 --- a/lib/command/info.js +++ b/lib/command/info.js @@ -1,25 +1,60 @@ -const envinfo = require('envinfo') +import envinfo from 'envinfo' -const { getConfig, getTestRoot } = require('./utils') -const Codecept = require('../codecept') -const output = require('../output') +import { getConfig, getTestRoot } from './utils.js' +import Codecept from '../codecept.js' +import output from '../output.js' +import { execSync } from 'child_process' -module.exports = async function (path) { +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(', ') +} + +export default async function (path) { const testsPath = getTestRoot(path) - const config = getConfig(testsPath) + const config = await getConfig(testsPath) 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,13 +69,11 @@ 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('***************************************') } -module.exports.getMachineInfo = async () => { +export const getMachineInfo = async () => { const info = { nodeInfo: await envinfo.helpers.getNodeInfo(), osInfo: await envinfo.helpers.getOSInfo(), @@ -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..7a2d9ad2a 100644 --- a/lib/command/init.js +++ b/lib/command/init.js @@ -1,17 +1,18 @@ -const colors = require('chalk') -const fs = require('fs') -const inquirer = require('inquirer') -const mkdirp = require('mkdirp') -const path = require('path') -const { inspect } = require('util') -const spawn = require('cross-spawn') - -const { print, success, error } = require('../output') -const { fileExists, beautify, installedLocally } = require('../utils') -const { getTestRoot } = require('./utils') -const generateDefinitions = require('./definitions') -const { test: generateTest } = require('./generate') -const isLocal = require('../utils').installedLocally() +import colors from 'chalk' +import fs from 'fs' +import inquirer from 'inquirer' +import { mkdirp } from 'mkdirp' +import path from 'path' +import { inspect } from 'util' +import spawn from 'cross-spawn' + +import output from '../output.js' +const { print, success, error } = output +import { fileExists, beautify, installedLocally } from '../utils.js' +import { getTestRoot } from './utils.js' +import generateDefinitions from './definitions.js' +import { test as generateTest } from './generate.js' +const isLocal = installedLocally() const defaultConfig = { tests: './*_test.js', @@ -21,10 +22,14 @@ const defaultConfig = { } const helpers = ['Playwright', 'WebDriver', 'Puppeteer', 'REST', 'GraphQL', 'Appium', 'TestCafe'] -const translations = Object.keys(require('../../translations')) - const noTranslation = 'English (no localization)' -translations.unshift(noTranslation) + +async function getTranslations() { + const translationsModule = await import('../../translations/index.js') + const translations = Object.keys(translationsModule.default || translationsModule) + translations.unshift(noTranslation) + return translations +} const packages = [] let isTypeScript = false @@ -45,7 +50,7 @@ setCommonPlugins(); const defaultActor = `// in this file you can append custom step methods to 'I' object -module.exports = function() { +export default function() { return actor({ // Define custom steps here, use 'this' to access default methods of I. @@ -67,8 +72,9 @@ export = function() { } ` -module.exports = function (initPath) { +export default async function (initPath) { const testsPath = getTestRoot(initPath) + const translations = await getTranslations() print() print(` Welcome to ${colors.magenta.bold('CodeceptJS')} initialization tool`) @@ -117,7 +123,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 +138,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 +152,7 @@ module.exports = function (initPath) { choices: translations, }, ]) - .then((result) => { + .then(async result => { if (result.typescript === true) { isTypeScript = true extension = isTypeScript === true ? 'ts' : 'js' @@ -182,14 +188,15 @@ module.exports = function (initPath) { let helperConfigs = [] try { - const Helper = require(`../helper/${helperName}`) + const HelperModule = await import(`../helper/${helperName}.js`) + const Helper = HelperModule.default || HelperModule if (Helper._checkRequirements) { packages.concat(Helper._checkRequirements()) } 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' @@ -207,9 +214,9 @@ module.exports = function (initPath) { fs.writeFileSync(path.join(testsPath, stepFile), extension === 'ts' ? defaultActorTs : defaultActor) if (isTypeScript) { - config.include = _actorTranslation('./steps_file', config.translation) + config.include = await _actorTranslation('./steps_file', config.translation, translations) } else { - config.include = _actorTranslation(stepFile, config.translation) + config.include = await _actorTranslation(stepFile, config.translation, translations) } print(`Steps file created at ${stepFile}`) @@ -225,9 +232,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 +291,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 +333,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 +344,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] @@ -394,7 +397,7 @@ function install(dependencies) { return true } -function _actorTranslation(stepFile, translationSelected) { +async function _actorTranslation(stepFile, translationSelected, translations) { let actor for (const translationAvailable of translations) { @@ -403,7 +406,8 @@ function _actorTranslation(stepFile, translationSelected) { } if (translationSelected === translationAvailable) { - const nameOfActor = require('../../translations')[translationAvailable].I + const translationsModule = await import('../../translations/index.js') + const nameOfActor = (translationsModule.default || translationsModule)[translationAvailable].I actor = { [nameOfActor]: stepFile, diff --git a/lib/command/interactive.js b/lib/command/interactive.js index 7f92cbec8..a86f44518 100644 --- a/lib/command/interactive.js +++ b/lib/command/interactive.js @@ -1,18 +1,19 @@ -const { getConfig, getTestRoot } = require('./utils') -const recorder = require('../recorder') -const Codecept = require('../codecept') -const Container = require('../container') -const event = require('../event') -const output = require('../output') -const webHelpers = require('../plugin/standardActingHelpers') - -module.exports = async function (path, options) { +import { getConfig, getTestRoot } from './utils.js' +import recorder from '../recorder.js' +import Codecept from '../codecept.js' +import Container from '../container.js' +import event from '../event.js' +import pause from '../pause.js' +import output from '../output.js' +const webHelpers = Container.STANDARD_ACTING_HELPERS + +export default async function (path, options) { // Backward compatibility for --profile process.profile = options.profile process.env.profile = options.profile const configFile = options.config - const config = getConfig(configFile) + const config = await getConfig(configFile) const testsPath = getTestRoot(configFile) const codecept = new Codecept(config, options) @@ -23,15 +24,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,11 +48,11 @@ 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 } } - require('../pause')() + pause() // recorder.catchWithoutStop((err) => console.log(err.stack)); recorder.add(() => event.emit(event.test.after, {})) recorder.add(() => event.emit(event.suite.after, {})) diff --git a/lib/command/list.js b/lib/command/list.js index 47a1047c9..7ef966cbf 100644 --- a/lib/command/list.js +++ b/lib/command/list.js @@ -1,15 +1,16 @@ -const { getConfig, getTestRoot } = require('./utils') -const Codecept = require('../codecept') -const container = require('../container') -const { getParamsToString } = require('../parser') -const { methodsOfObject } = require('../utils') -const output = require('../output') +import { getConfig, getTestRoot } from './utils.js' +import Codecept from '../codecept.js' +import container from '../container.js' +import { getParamsToString } from '../parser.js' +import { methodsOfObject } from '../utils.js' +import output from '../output.js' -module.exports = function (path) { +export default async function (path) { const testsPath = getTestRoot(path) - const config = getConfig(testsPath) + const config = await getConfig(testsPath) const codecept = new Codecept(config, {}) - codecept.init(testsPath) + await codecept.init(testsPath) + await container.started() output.print('List of test actions: -- ') const helpers = container.helpers() @@ -17,7 +18,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..ce71744d0 100644 --- a/lib/command/run-multiple.js +++ b/lib/command/run-multiple.js @@ -1,30 +1,20 @@ -const { fork } = require('child_process') -const path = require('path') -const crypto = require('crypto') - -const runHook = require('../hooks') -const event = require('../event') -const collection = require('./run-multiple/collection') -const { clearString, replaceValueDeep } = require('../utils') -const { getConfig, getTestRoot, fail } = require('./utils') - +import { fork } from 'child_process' +import path from 'path' +import crypto from 'crypto' +import { fileURLToPath } from 'url' + +import runHook from '../hooks.js' +import event from '../event.js' +import { createRuns } from './run-multiple/collection.js' +import { clearString, replaceValueDeep } from '../utils.js' +import { getConfig, getTestRoot, fail } from './utils.js' + +const __filename = fileURLToPath(import.meta.url) +const __dirname = path.dirname(__filename) 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 @@ -37,7 +27,7 @@ let subprocessCount = 0 let totalSubprocessCount = 0 let processesDone -module.exports = async function (selectedRuns, options) { +export default async function (selectedRuns, options) { // registering options globally to use in config if (options.profile) { process.env.profile = options.profile @@ -49,8 +39,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] }) @@ -62,7 +52,7 @@ module.exports = async function (selectedRuns, options) { } config = { - ...getConfig(configFile), + ...(await getConfig(configFile)), ...overrides, } @@ -96,12 +86,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) => { + createRuns(selectedRuns, config).forEach(run => { const runName = run.getOriginalName() || run.getName() const runConfig = run.getConfig() runsToExecute.push(executeRun(runName, runConfig)) @@ -113,7 +103,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 +139,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 +151,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 +163,7 @@ function executeRun(runName, runConfig) { params.push(runConfig.grep) } - const onProcessEnd = (errorCode) => { + const onProcessEnd = errorCode => { if (errorCode !== 0) { process.exitCode = errorCode } @@ -197,7 +177,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..8c44013f6 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'); +import { globSync } from 'glob' +import path from 'path' +import fs from '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, -}; +export { + createChunks +} diff --git a/lib/command/run-multiple/collection.js b/lib/command/run-multiple/collection.js index a533029d3..c66884d79 100644 --- a/lib/command/run-multiple/collection.js +++ b/lib/command/run-multiple/collection.js @@ -1,5 +1,5 @@ -const { createChunks } = require('./chunk'); -const { createRun } = require('./run'); +import { createChunks } from './chunk.js' +import { createRun } from './run.js' /** * Bootstraps a collection of runs, it combines user defined selection of runs @@ -190,6 +190,6 @@ function guessBrowser(config) { return [config.helpers[firstHelper].browser]; } -module.exports = { - createRuns, -}; +export { + createRuns +} diff --git a/lib/command/run-multiple/run.js b/lib/command/run-multiple/run.js index ea06309df..c4869b06b 100644 --- a/lib/command/run-multiple/run.js +++ b/lib/command/run-multiple/run.js @@ -25,6 +25,6 @@ const createRun = (name, config) => { return new Run(name, config); }; -module.exports = { - createRun, -}; +export { + createRun +} diff --git a/lib/command/run-rerun.js b/lib/command/run-rerun.js index ccb18bcfd..34f948c8c 100644 --- a/lib/command/run-rerun.js +++ b/lib/command/run-rerun.js @@ -1,16 +1,15 @@ -const { getConfig, getTestRoot } = require('./utils') -const { printError, createOutputDir } = require('./utils') -const Config = require('../config') -const Codecept = require('../rerun') +import { getConfig, getTestRoot, printError, createOutputDir } from './utils.js' +import Config from '../config.js' +import Codecept from '../rerun.js' -module.exports = async function (test, options) { +export default async function (test, options) { // registering options globally to use in config // Backward compatibility for --profile process.profile = options.profile process.env.profile = options.profile const configFile = options.config - let config = getConfig(configFile) + let config = await getConfig(configFile) if (options.override) { config = Config.append(JSON.parse(options.override)) } @@ -20,7 +19,7 @@ module.exports = async function (test, options) { const codecept = new Codecept(config, options) try { - codecept.init(testRoot) + await codecept.init(testRoot) await codecept.bootstrap() codecept.loadTests(test) diff --git a/lib/command/run-workers.js b/lib/command/run-workers.js index caae6f6cd..c4eec70b4 100644 --- a/lib/command/run-workers.js +++ b/lib/command/run-workers.js @@ -1,19 +1,15 @@ // For Node version >=10.5.0, have to use experimental flag -const { tryOrDefault } = require('../utils') -const output = require('../output') -const store = require('../store') -const event = require('../event') -const Workers = require('../workers') - -module.exports = async function (workerCount, selectedRuns, options) { +import { tryOrDefault } from '../utils.js' +import output from '../output.js' +import store from '../store.js' +import event from '../event.js' +import Workers from '../workers.js' +import Codecept from '../codecept.js' +import { getMachineInfo } from './info.js' + +export default 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' @@ -27,72 +23,27 @@ module.exports = async function (workerCount, selectedRuns, options) { const numberOfWorkers = parseInt(workerCount, 10) - output.print(`CodeceptJS v${require('../codecept').version()} ${output.standWithUkraine()}`) + output.print(`CodeceptJS v${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,8 +51,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() } await workers.bootstrapAll() diff --git a/lib/command/run.js b/lib/command/run.js index e76257404..648c38b5a 100644 --- a/lib/command/run.js +++ b/lib/command/run.js @@ -1,9 +1,9 @@ -const { getConfig, printError, getTestRoot, createOutputDir } = require('./utils') -const Config = require('../config') -const store = require('../store') -const Codecept = require('../codecept') +import { getConfig, printError, getTestRoot, createOutputDir } from './utils.js' +import Config from '../config.js' +import store from '../store.js' +import Codecept from '../codecept.js' -module.exports = async function (test, options) { +export default async function (test, options) { // registering options globally to use in config // Backward compatibility for --profile // TODO: remove in CodeceptJS 4 @@ -16,7 +16,7 @@ module.exports = async function (test, options) { const configFile = options.config - let config = getConfig(configFile) + let config = await getConfig(configFile) if (options.override) { config = Config.append(JSON.parse(options.override)) } @@ -26,13 +26,13 @@ module.exports = async function (test, options) { const codecept = new Codecept(config, options) try { - codecept.init(testRoot) + await codecept.init(testRoot) await codecept.bootstrap() codecept.loadTests(test) if (options.verbose) { global.debugMode = true - const { getMachineInfo } = require('./info') + const { getMachineInfo } = await import('./info.js') await getMachineInfo() } diff --git a/lib/command/utils.js b/lib/command/utils.js index cb5620b79..dfcce4d1c 100644 --- a/lib/command/utils.js +++ b/lib/command/utils.js @@ -1,23 +1,25 @@ -const fs = require('fs') -const path = require('path') -const util = require('util') -const mkdirp = require('mkdirp') +import fs from 'fs' +import path from 'path' +import util from 'util' +import { mkdirp } from 'mkdirp' -const output = require('../output') -const { fileExists, beautify } = require('../utils') +import output from '../output.js' +import { fileExists, beautify, deepMerge } from '../utils.js' // alias to deep merge -module.exports.deepMerge = require('../utils').deepMerge +export { deepMerge } -module.exports.getConfig = function (configFile) { +export async function getConfig(configFile) { try { - return require('../config').load(configFile) + const configModule = await import('../config.js') + const config = configModule.default || configModule + return await config.load(configFile) } catch (err) { fail(err.stack) } } -module.exports.readConfig = function (configFile) { +export function readConfig(configFile) { try { const data = fs.readFileSync(configFile, 'utf8') return data @@ -29,18 +31,17 @@ 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 +export { getTestRoot } function fail(msg) { output.error(msg) process.exit(1) } -module.exports.fail = fail +export { fail } function updateConfig(testsPath, config, extension) { const configFile = path.join(testsPath, `codecept.conf.${extension}`) @@ -58,7 +59,7 @@ function updateConfig(testsPath, config, extension) { return fs.writeFileSync(configFile, beautify(`exports.config = ${util.inspect(config, false, 4, false)}`), 'utf-8') } -module.exports.updateConfig = updateConfig +export { updateConfig } function safeFileWrite(file, contents) { if (fileExists(file)) { @@ -69,9 +70,9 @@ function safeFileWrite(file, contents) { return true } -module.exports.safeFileWrite = safeFileWrite +export { safeFileWrite } -module.exports.captureStream = (stream) => { +export const captureStream = stream => { let oldStream let buffer = '' @@ -79,7 +80,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,14 +89,14 @@ module.exports.captureStream = (stream) => { } } -module.exports.printError = (err) => { +export const printError = err => { output.print('') output.error(err.message) output.print('') output.print(output.colors.grey(err.stack.replace(err.message, ''))) } -module.exports.createOutputDir = (config, testRoot) => { +export const createOutputDir = (config, testRoot) => { let outputDir if (path.isAbsolute(config.output)) outputDir = config.output else outputDir = path.join(testRoot, config.output) @@ -106,7 +107,7 @@ module.exports.createOutputDir = (config, testRoot) => { } } -module.exports.findConfigFile = (testsPath) => { +export const 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 9331007d2..dcc69cb78 100644 --- a/lib/command/workers/runTests.js +++ b/lib/command/workers/runTests.js @@ -1,288 +1,128 @@ -const tty = require('tty'); +import tty from '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'); +import { parentPort, workerData } from 'worker_threads' +import event from '../../event.js' +import container from '../../container.js' +import { getConfig } from '../utils.js' +import { tryOrDefault, deepMerge } from '../../utils.js' -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'); +// Importing of Codecept need to be after tty.getWindowSize is available. +import Codecept from '../../codecept.js' -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; - }; + 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(); - -// run tests -(async function () { - if (mocha.suite.total()) { - await runTests(); - } -})(); - -async function runTests() { - try { - await codecept.bootstrap(); - } catch (err) { - throw new Error(`Error while running bootstrap file :${err}`); - } - listenToParentThread(); - initializeListeners(); - disablePause(); - try { - await codecept.run(); - } finally { - await codecept.teardown(); - } -} - -function filterTests() { - 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); - } -} - -function initializeListeners() { - function simplifyError(error) { - if (error) { - const { stack, uncaught, message, actual, expected } = error; - - return { - stack, - uncaught, - message, - actual, - expected, - }; +;(async function () { + const codecept = new Codecept(config, options) + await codecept.init(testRoot) + codecept.loadTests() + const mocha = container.mocha() + + function filterTests() { + 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) } - - return null; } - function simplifyTest(test, err = null) { - test = { ...test }; - if (test.start && !test.duration) { - const end = new Date(); - test.duration = end - test.start; + async function runTests() { + try { + await codecept.bootstrap() + } catch (err) { + throw new Error(`Error while running bootstrap file :${err}`) } - - if (test.err) { - err = simplifyError(test.err); - test.status = 'failed'; - } else if (err) { - err = simplifyError(err); - test.status = 'failed'; + listenToParentThread() + initializeListeners() + disablePause() + try { + await codecept.run() + } finally { + await codecept.teardown() } - 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 = []; + filterTests() - 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), - }; + // run tests + if (mocha.suite.total()) { + await runTests() } +})() - collectStats(); +function initializeListeners() { // 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/config.js b/lib/config.js index 3eaa49e55..fbc6fc27f 100644 --- a/lib/config.js +++ b/lib/config.js @@ -1,11 +1,7 @@ -const fs = require('fs'); -const path = require('path'); -const { - fileExists, - isFile, - deepMerge, - deepClone, -} = require('./utils'); +import fs from 'fs' +import path from 'path' +import { createRequire } from 'module' +import { fileExists, isFile, deepMerge, deepClone } from './utils.js' const defaultConfig = { output: './_output', @@ -33,18 +29,12 @@ const defaultConfig = { timeout: 0, }, ], -}; +} -let hooks = []; -let config = {}; +let hooks = [] +let config = {} -const configFileNames = [ - 'codecept.config.js', - 'codecept.conf.js', - 'codecept.js', - 'codecept.config.ts', - 'codecept.conf.ts', -]; +const configFileNames = ['codecept.config.js', 'codecept.conf.js', 'codecept.js', 'codecept.config.ts', 'codecept.conf.ts'] /** * Current configuration @@ -57,9 +47,9 @@ class Config { * @return {Object} */ static create(newConfig) { - config = deepMerge(deepClone(defaultConfig), newConfig); - hooks.forEach(f => f(config)); - return config; + config = deepMerge(deepClone(defaultConfig), newConfig) + hooks.forEach(f => f(config)) + return config } /** @@ -75,34 +65,34 @@ class Config { * @param {string} configFile * @return {*} */ - static load(configFile) { - configFile = path.resolve(configFile || '.'); + static async load(configFile) { + configFile = path.resolve(configFile || '.') if (!fileExists(configFile)) { - configFile = configFile.replace('.js', '.ts'); + configFile = configFile.replace('.js', '.ts') if (!fileExists(configFile)) { - throw new Error(`Config file ${configFile} does not exist. Execute 'codeceptjs init' to create config`); + throw new Error(`Config file ${configFile} does not exist. Execute 'codeceptjs init' to create config`) } } // is config file if (isFile(configFile)) { - return loadConfigFile(configFile); + return await loadConfigFile(configFile) } for (const name of configFileNames) { // is path to directory - const jsConfig = path.join(configFile, name); + const jsConfig = path.join(configFile, name) if (isFile(jsConfig)) { - return loadConfigFile(jsConfig); + return await loadConfigFile(jsConfig) } } - const configPaths = configFileNames.map(name => path.join(configFile, name)).join(' or '); + const configPaths = configFileNames.map(name => path.join(configFile, name)).join(' or ') - throw new Error(`Can not load config from ${configPaths}\nCodeceptJS is not initialized in this dir. Execute 'codeceptjs init' to start`); + throw new Error(`Can not load config from ${configPaths}\nCodeceptJS is not initialized in this dir. Execute 'codeceptjs init' to start`) } /** @@ -113,13 +103,13 @@ class Config { */ static get(key, val) { if (key) { - return config[key] || val; + return config[key] || val } - return config; + return config } static addHook(fn) { - hooks.push(fn); + hooks.push(fn) } /** @@ -129,7 +119,7 @@ class Config { * @return {Object} */ static append(additionalConfig) { - return config = deepMerge(config, additionalConfig); + return (config = deepMerge(config, additionalConfig)) } /** @@ -137,33 +127,105 @@ class Config { * @return {Object} */ static reset() { - hooks = []; - return config = { ...defaultConfig }; + hooks = [] + return (config = { ...defaultConfig }) } } -module.exports = Config; +export default Config -function loadConfigFile(configFile) { - const extensionName = path.extname(configFile); +async function loadConfigFile(configFile) { + const require = createRequire(import.meta.url) + const extensionName = path.extname(configFile) - if (extensionName === '.ts') { + // .conf.js config file + if (extensionName === '.js' || extensionName === '.ts' || extensionName === '.cjs') { + let configModule try { - require('ts-node/register'); - } catch (err) { - console.log('ts-node package is required to parse codecept.conf.ts config correctly'); + // For .ts files, try to compile and load as JavaScript + if (extensionName === '.ts') { + try { + // Try to load ts-node and compile the file + const { transpile } = require('typescript') + const tsContent = fs.readFileSync(configFile, 'utf8') + + // Transpile TypeScript to JavaScript with ES module output + const jsContent = transpile(tsContent, { + module: 99, // ModuleKind.ESNext + target: 99, // ScriptTarget.ESNext + esModuleInterop: true, + allowSyntheticDefaultImports: true, + }) + + // Create a temporary JS file with .mjs extension to force ES module treatment + const tempJsFile = configFile.replace('.ts', '.temp.mjs') + fs.writeFileSync(tempJsFile, jsContent) + + try { + configModule = await import(tempJsFile) + // Clean up temp file + fs.unlinkSync(tempJsFile) + } catch (err) { + // Clean up temp file even on error + if (fs.existsSync(tempJsFile)) { + fs.unlinkSync(tempJsFile) + } + throw err + } + } catch (tsError) { + // If TypeScript compilation fails, fallback to ts-node + try { + require('ts-node/register') + configModule = require(configFile) + } catch (tsNodeError) { + throw new Error(`Failed to load TypeScript config: ${tsError.message}`) + } + } + } else { + // Try ESM import first for JS files + configModule = await import(configFile) + } + } catch (importError) { + try { + // Fall back to CommonJS require for .js/.cjs files + if (extensionName !== '.ts') { + configModule = require(configFile) + } else { + throw importError + } + } catch (requireError) { + throw new Error(`Failed to load config file ${configFile}: ${importError.message}`) + } } - } - // .conf.js config file - if (extensionName === '.js' || extensionName === '.ts' || extensionName === '.cjs') { - return Config.create(require(configFile).config); + const rawConfig = configModule.config || configModule.default?.config || configModule + + // Process helpers to extract imported classes + if (rawConfig.helpers) { + const processedHelpers = {} + for (const [helperName, helperConfig] of Object.entries(rawConfig.helpers)) { + // Check if the helper name itself is a class (ESM import) + if (typeof helperName === 'function' && helperName.prototype) { + // This is an imported class, use its constructor name + const className = helperName.name + processedHelpers[className] = { + ...helperConfig, + _helperClass: helperName, + } + } else { + processedHelpers[helperName] = helperConfig + } + } + rawConfig.helpers = processedHelpers + } + + return Config.create(rawConfig) } // json config provided if (extensionName === '.json') { - return Config.create(JSON.parse(fs.readFileSync(configFile, 'utf8'))); + return Config.create(JSON.parse(fs.readFileSync(configFile, 'utf8'))) } - throw new Error(`Config file ${configFile} can't be loaded`); + throw new Error(`Config file ${configFile} can't be loaded`) } diff --git a/lib/container.js b/lib/container.js index 34a0058de..bcb840a08 100644 --- a/lib/container.js +++ b/lib/container.js @@ -1,16 +1,20 @@ -const glob = require('glob'); -const path = require('path'); -const { MetaStep } = require('./step'); -const { methodsOfObject, fileExists, isFunction, isAsyncFunction, installedLocally } = 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'); - -let asyncHelperPromise; +import { globSync } from 'glob' +import path from 'path' +import debugModule from 'debug' +const debug = debugModule('codeceptjs:container') +import { MetaStep } from './step.js' +import { methodsOfObject, fileExists, isFunction, isAsyncFunction, installedLocally, deepMerge } from './utils.js' +import Translation from './translation.js' +import MochaFactory from './mocha/factory.js' +import recorder from './recorder.js' +import event from './event.js' +import WorkerStorage from './workerStorage.js' +import store from './store.js' +import Result from './result.js' +import ai from './ai.js' +import actorFactory from './actor.js' + +let asyncHelperPromise let container = { helpers: {}, @@ -24,12 +28,21 @@ let container = { */ 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 * @@ -37,31 +50,70 @@ class Container { * @param {*} config * @param {*} opts */ - static create(config, opts) { - asyncHelperPromise = Promise.resolve(); + static async create(config, opts) { + 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(); + 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.support = {} + container.helpers = await createHelpers(config.helpers || {}) + container.translation = await loadTranslation(config.translation || null, config.vocabularies || []) + container.proxySupport = createSupportObjects(config.include || {}) + container.plugins = await createPlugins(config.plugins || {}, opts) + container.result = new Result() + + // Preload includes (so proxies can expose real objects synchronously) + const includes = config.include || {} + + // Ensure I is available for DI modules at import time + if (Object.prototype.hasOwnProperty.call(includes, 'I')) { + try { + const mod = includes.I + if (typeof mod === 'string') { + container.support.I = await loadSupportObject(mod, 'I') + } else if (typeof mod === 'function') { + container.support.I = await loadSupportObject(mod, 'I') + } else if (mod && typeof mod === 'object') { + container.support.I = mod + } + } catch (e) { + throw new Error(`Could not include object I: ${e.message}`) + } + } else { + // Create default actor if not provided via includes + createActor() + } - createActor(config.include?.I); + // Load remaining includes except I + for (const [name, mod] of Object.entries(includes)) { + if (name === 'I') continue + try { + if (typeof mod === 'string') { + container.support[name] = await loadSupportObject(mod, name) + } else if (typeof mod === 'function') { + // function or class + container.support[name] = await loadSupportObject(mod, name) + } else if (mod && typeof mod === 'object') { + container.support[name] = mod + } + } catch (e) { + throw new Error(`Could not include object ${name}: ${e.message}`) + } + } - 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; + if (opts && opts.ai) ai.enable(config.ai) // enable AI Assistant + if (config.gherkin) await loadGherkinStepsAsync(config.gherkin.steps || []) + if (opts && typeof opts.timeouts === 'boolean') store.timeouts = opts.timeouts } static actor() { - return container.support.I; + return container.support.I } /** @@ -73,9 +125,9 @@ class Container { */ static plugins(name) { if (!name) { - return container.plugins; + return container.plugins } - return container.plugins[name]; + return container.plugins[name] } /** @@ -87,9 +139,9 @@ class Container { */ static support(name) { if (!name) { - return container.proxySupport; + return container.proxySupport } - return container.support[name] || container.proxySupport[name]; + return container.support[name] || container.proxySupport[name] } /** @@ -101,9 +153,9 @@ class Container { */ static helpers(name) { if (!name) { - return container.helpers; + return container.helpers } - return container.helpers[name]; + return container.helpers[name] } /** @@ -112,7 +164,7 @@ class Container { * @api */ static translation() { - return container.translation; + return container.translation } /** @@ -122,7 +174,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 } /** @@ -132,8 +196,8 @@ class Container { * @param {Object} newContainer */ static append(newContainer) { - const deepMerge = require('./utils').deepMerge; - container = deepMerge(container, newContainer); + container = deepMerge(container, newContainer) + debug('appended', JSON.stringify(newContainer).slice(0, 300)) } /** @@ -143,20 +207,25 @@ class Container { * @param {Object} newSupport * @param {Object} newPlugins */ - static clear(newHelpers, newSupport, newPlugins) { - container.helpers = newHelpers || {}; - container.translation = loadTranslation(); - container.proxySupport = createSupportObjects(newSupport || {}); - container.plugins = newPlugins || {}; - asyncHelperPromise = Promise.resolve(); - store.actor = null; + static async clear(newHelpers = {}, newSupport = {}, newPlugins = {}) { + container.helpers = newHelpers + container.translation = await 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); + asyncHelperPromise = asyncHelperPromise.then(fn) } - return asyncHelperPromise; + return asyncHelperPromise } /** @@ -166,119 +235,175 @@ 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 || {}; + const mochaConfig = config?.mocha || {} if (config?.grep && !opts?.grep) { - mochaConfig.grep = config.grep; + mochaConfig.grep = config.grep } - container.mocha = MochaFactory.create(mochaConfig, opts || {}); + container.mocha = MochaFactory.create(mochaConfig, opts || {}) } } -module.exports = Container; +export default Container -function createHelpers(config) { - const helpers = {}; +async function createHelpers(config) { + const helpers = {} for (let helperName in config) { try { - let HelperClass; + let HelperClass + + // Check if helper class was stored in config during ESM import processing + if (config[helperName]._helperClass) { + HelperClass = config[helperName]._helperClass + debug(`helper ${helperName} loaded from ESM import`) + } - // ESM import - if (helperName?.constructor === Function && helperName.prototype) { - HelperClass = helperName; - helperName = HelperClass.constructor.name; + // ESM import (legacy check) + if (!HelperClass && typeof helperName === 'function' && helperName.prototype) { + HelperClass = helperName + helperName = HelperClass.constructor.name } - // classical require + // classical require - may be async for ESM modules if (!HelperClass) { - HelperClass = requireHelperFromModule(helperName, config); + const helperResult = requireHelperFromModule(helperName, config) + if (helperResult instanceof Promise) { + // Handle async ESM loading + helpers[helperName] = {} + asyncHelperPromise = asyncHelperPromise + .then(() => helperResult) + .then(async ResolvedHelperClass => { + debug(`helper ${helperName} resolved type: ${typeof ResolvedHelperClass}`, ResolvedHelperClass) + + // Extract default export from ESM module wrapper if needed + if (ResolvedHelperClass && ResolvedHelperClass.__esModule && ResolvedHelperClass.default) { + ResolvedHelperClass = ResolvedHelperClass.default + debug(`extracted default export for ${helperName}, new type: ${typeof ResolvedHelperClass}`) + } + + if (typeof ResolvedHelperClass !== 'function') { + throw new Error(`Helper '${helperName}' is not a class. Got: ${typeof ResolvedHelperClass}`) + } + + checkHelperRequirements(ResolvedHelperClass) + helpers[helperName] = new ResolvedHelperClass(config[helperName]) + if (helpers[helperName]._init) await helpers[helperName]._init() + debug(`helper ${helperName} async initialized`) + }) + continue + } else { + HelperClass = helperResult + } } // handle async CJS modules that use dynamic import if (isAsyncFunction(HelperClass)) { - helpers[helperName] = {}; + 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.`); + throw new Error(`Helper class from module '${helperName}' is not a class. Use CJS async module syntax.`) } - helpers[helperName] = new ResolvedHelperClass(config[helperName]); - }); + debug(`helper ${helperName} async initialized`) + + helpers[helperName] = new ResolvedHelperClass(config[helperName]) + }) - continue; + continue } - checkHelperRequirements(HelperClass); + checkHelperRequirements(HelperClass) - helpers[helperName] = new HelperClass(config[helperName]); + helpers[helperName] = new HelperClass(config[helperName]) + debug(`helper ${helperName} initialized`) } catch (err) { - throw new Error(`Could not load helper ${helperName} (${err.message})`); + 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) await helpers[name]._init() } - return helpers; + return helpers } function checkHelperRequirements(HelperClass) { if (HelperClass._checkRequirements) { - const requirements = HelperClass._checkRequirements(); + const requirements = HelperClass._checkRequirements() if (requirements) { - let install; + let install if (installedLocally()) { - install = `npm install --save-dev ${requirements.join(' ')}`; + 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(' ')}`; + 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}`); + throw new Error(`Required modules are not installed.\n\nRUN: ${install}`) } } } -function requireHelperFromModule(helperName, config, HelperClass) { - const moduleName = getHelperModuleName(helperName, config); +async function requireHelperFromModule(helperName, config, HelperClass) { + const moduleName = getHelperModuleName(helperName, config) if (moduleName.startsWith('./helper/')) { - HelperClass = require(moduleName); + try { + // For built-in helpers, use direct relative import with .js extension + const helperPath = `${moduleName}.js` + const mod = await import(helperPath) + HelperClass = mod.default || mod + } catch (err) { + throw err + } } 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 { - const mod = require(moduleName); + // Try dynamic import for both CommonJS and ESM modules + const mod = await import(moduleName) if (!mod && !mod.default) { - throw new Error(`Helper module '${moduleName}' was not found. Make sure you have installed the package correctly.`); + throw new Error(`Helper module '${moduleName}' was not found. Make sure you have installed the package correctly.`) } - HelperClass = mod.default || mod; + HelperClass = mod.default || mod } catch (err) { - if (err.code === 'MODULE_NOT_FOUND') { - throw new Error(`Helper module '${moduleName}' was not found. Make sure you have installed the package correctly.`); + if (err.code === 'ERR_REQUIRE_ESM' || (err.message && err.message.includes('ES module'))) { + // This is an ESM module, use dynamic import + try { + const pathModule = await import('path') + const absolutePath = pathModule.default.resolve(moduleName) + const mod = await import(absolutePath) + HelperClass = mod.default || mod + debug(`helper ${helperName} loaded via ESM import`) + } catch (importErr) { + throw new Error(`Helper module '${moduleName}' could not be imported as ESM: ${importErr.message}`) + } + } else if (err.code === 'MODULE_NOT_FOUND') { + throw new Error(`Helper module '${moduleName}' was not found. Make sure you have installed the package correctly.`) + } else { + throw err } - throw err; } } - return HelperClass; + return HelperClass } function createSupportObjects(config) { const asyncWrapper = function (f) { return function () { return f.apply(this, arguments).catch(e => { - recorder.saveFirstAsyncError(e); - throw e; - }); - }; - }; + recorder.saveFirstAsyncError(e) + throw e + }) + } + } function lazyLoad(name) { return new Proxy( @@ -286,243 +411,369 @@ function createSupportObjects(config) { { get(target, prop) { // behavr like array or - if (prop === 'length') return Object.keys(config).length; + 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]; + yield target[i] } - }; + } } // load actual name from vocabulary - if (container.translation.name) { - name = container.translation.name; + if (container.translation && container.translation.I && name === 'I') { + // Use translated name for I + const actualName = container.translation.I + if (actualName !== 'I') { + name = actualName + } } if (name === 'I') { - const actor = createActor(config.I); - methodsOfObject(actor); - return actor[prop]; + if (!container.support.I) { + // Actor will be created during container.create() + return undefined + } + methodsOfObject(container.support.I) + return container.support.I[prop] } if (!container.support[name] && typeof config[name] === 'object') { - container.support[name] = config[name]; + 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(); - } - } catch (err) { - throw new Error(`Initialization failed for ${name}: ${container.support[name]}\n${err.message}\n${err.stack}`); - } + // Cannot load object synchronously in proxy getter + // Return undefined and log warning - object should be pre-loaded during container creation + debug(`Support object ${name} not pre-loaded, returning undefined`) + return undefined } - const currentObject = container.support[name]; - let currentValue = currentObject[prop]; + 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); - return ms.run.bind(ms, 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; + return currentValue }, has(target, prop) { - container.support[name] = container.support[name] || loadSupportObject(config[name]); - return prop in container.support[name]; + if (!container.support[name]) { + // Note: This is sync, so we can't use async loadSupportObject here + // The object will be loaded lazily on first property access + return false + } + return prop in container.support[name] }, getOwnPropertyDescriptor(target, prop) { - container.support[name] = container.support[name] || loadSupportObject(config[name]); + if (!container.support[name]) { + // Object will be loaded on property access + return { + enumerable: true, + configurable: true, + value: undefined, + } + } return { enumerable: true, configurable: true, - value: this.get(target, prop), - }; + value: container.support[name][prop], + } }, ownKeys() { - container.support[name] = container.support[name] || loadSupportObject(config[name]); - return Reflect.ownKeys(container.support[name]); + if (!container.support[name]) { + return [] + } + return Reflect.ownKeys(container.support[name]) }, }, - ); + ) } - const keys = Reflect.ownKeys(config); + const keys = Reflect.ownKeys(config) return new Proxy( {}, { has(target, key) { - return keys.includes(key); + return keys.includes(key) }, ownKeys() { - return keys; + return keys }, getOwnPropertyDescriptor(target, prop) { return { enumerable: true, configurable: true, - value: this.get(target, prop), - }; + value: target[prop], + } }, get(target, key) { - return lazyLoad(key); + if (typeof key === 'symbol') { + // safely ignore symbol-based meta properties used by tooling + return undefined + } + // Allow special I even if not declared in includes + if (key === 'I') { + return lazyLoad('I') + } + if (!keys.includes(key)) { + throw new Error(`Support object "${String(key)}" is not defined`) + } + return lazyLoad(key) }, }, - ); + ) } function createActor(actorPath) { - if (container.support.I) return container.support.I; + if (container.support.I) return container.support.I - if (actorPath) { - container.support.I = loadSupportObject(actorPath); - } else { - const actor = require('./actor'); - container.support.I = actor(); + // Default actor + container.support.I = actorFactory({}, Container) + + return container.support.I +} + +async function loadPluginAsync(modulePath, config) { + let pluginMod + try { + // Try dynamic import first (works for both ESM and CJS) + pluginMod = await import(modulePath) + } catch (err) { + throw new Error(`Could not load plugin from '${modulePath}': ${err.message}`) + } + + const pluginFactory = pluginMod.default || pluginMod + if (typeof pluginFactory !== 'function') { + throw new Error(`Plugin '${modulePath}' is not a function. Expected a plugin factory function.`) } - return container.support.I; + return pluginFactory(config) +} + +async function loadPluginFallback(modulePath, config) { + // This function is kept for backwards compatibility but now uses dynamic import + return await loadPluginAsync(modulePath, config) } -function createPlugins(config, options = {}) { - const plugins = {}; +async function createPlugins(config, options = {}) { + 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]) config[pluginName] = {} if (!config[pluginName].enabled && enabledPluginsByOptions.indexOf(pluginName) < 0) { - continue; // plugin is disabled + continue // plugin is disabled } - let module; + let module try { if (config[pluginName].require) { - module = config[pluginName].require; + module = config[pluginName].require if (module.startsWith('.')) { // local - module = path.resolve(global.codecept_dir, module); // custom plugin + module = path.resolve(global.codecept_dir, module) // custom plugin } } else { - module = `./plugin/${pluginName}`; + module = `./plugin/${pluginName}.js` } - plugins[pluginName] = require(module)(config[pluginName]); + + // Use async loading for all plugins (ESM and CJS) + plugins[pluginName] = await loadPluginAsync(module, config[pluginName]) + debug(`plugin ${pluginName} loaded via async import`) } 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; + 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); +async function loadGherkinStepsAsync(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) + + // Import BDD module to access step file tracking functions + const bddModule = await import('./mocha/bdd.js') // 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}`); + // Set context for step definition file location tracking + bddModule.setCurrentStepFile(path) + await loadSupportObject(path, `Step Definition from ${path}`) + bddModule.clearCurrentStepFile() } } 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}`); - }); + const files = globSync(folderPath) + for (const file of files) { + // Set context for step definition file location tracking + bddModule.setCurrentStepFile(file) + await loadSupportObject(file, `Step Definition from ${file}`) + bddModule.clearCurrentStepFile() + } } } - delete global.Before; - delete global.After; - delete global.Fail; + delete global.Before + delete global.After + delete global.Fail } -function loadSupportObject(modulePath, supportObjectName) { +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) + + // Gherkin step loading must be handled asynchronously + throw new Error('Gherkin step loading must be converted to async. Use loadGherkinStepsAsync() instead.') + + delete global.Before + delete global.After + delete global.Fail +} + +async function loadSupportObject(modulePath, supportObjectName) { if (!modulePath) { - throw new Error(`Support object "${supportObjectName}" is not defined`); + throw new Error(`Support object "${supportObjectName}" is not defined`) } - if (modulePath.charAt(0) === '.') { - modulePath = path.join(global.codecept_dir, modulePath); + // If function/class provided directly + if (typeof modulePath === 'function') { + try { + // class constructor + if (modulePath.prototype && modulePath.prototype.constructor === modulePath) { + return new modulePath() + } + // plain function factory + return modulePath() + } catch (err) { + throw new Error(`Could not include object ${supportObjectName} from function: ${err.message}`) + } + } + if (typeof modulePath === 'string' && modulePath.charAt(0) === '.') { + modulePath = path.join(global.codecept_dir, modulePath) } try { - const obj = require(modulePath); + // Use dynamic import for both ESM and CJS modules + let importPath = modulePath + // Append .js if no extension provided (ESM resolution requires it) + if (typeof importPath === 'string') { + const ext = path.extname(importPath) + if (!ext) importPath = `${importPath}.js` + } + const obj = await import(importPath) + + // Handle ESM module wrapper + let actualObj = obj + if (obj && obj.__esModule && obj.default) { + actualObj = obj.default + } else if (obj.default) { + actualObj = obj.default + } // Handle different types of imports - if (typeof obj === 'function') { + if (typeof actualObj === 'function') { // If it's a class (constructor function) - if (obj.prototype && obj.prototype.constructor === obj) { - const ClassName = obj; - return new ClassName(); + if (actualObj.prototype && actualObj.prototype.constructor === actualObj) { + const ClassName = actualObj + return new ClassName() } // If it's a regular function - return obj(); + return actualObj() } - if (obj && Array.isArray(obj)) { - return obj; + if (actualObj && Array.isArray(actualObj)) { + return actualObj } // If it's a plain object - if (obj && typeof obj === 'object') { - return obj; + if (actualObj && typeof actualObj === 'object') { + // Call _init if it exists (for page objects) + if (actualObj._init && typeof actualObj._init === 'function') { + actualObj._init() + } + return actualObj } - throw new Error(`Support object "${supportObjectName}" should be an object, class, or function, but got ${typeof obj}`); + throw new Error(`Support object "${supportObjectName}" should be an object, class, or function, but got ${typeof actualObj}`) } 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}`) } } +// Backwards compatibility function that throws an error for sync usage +function loadSupportObjectSync(modulePath, supportObjectName) { + throw new Error(`loadSupportObjectSync is deprecated. Support object "${supportObjectName || 'undefined'}" from '${modulePath}' must be loaded asynchronously. Use loadSupportObject() instead.`) +} + /** * Method collect own property and prototype */ -function loadTranslation(locale, vocabularies) { +async 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]); + const langs = await Translation.getLangs() + if (langs[locale]) { + translation = new 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)); + vocabularies.forEach(v => translation.loadVocabulary(v)) - return translation; + 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 + let helperPath = path.resolve(global.codecept_dir, config[helperName].require) + // Add .js extension if not present for ESM compatibility + if (!path.extname(helperPath)) { + helperPath += '.js' + } + return helperPath // custom helper } - return config[helperName].require; // plugin helper + return config[helperName].require // plugin helper } // built-in helpers if (helperName.startsWith('@codeceptjs/')) { - return helperName; + return helperName } // built-in helpers - return `./helper/${helperName}`; + 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 + } + + // 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..c2e0bc2e4 100644 --- a/lib/data/context.js +++ b/lib/data/context.js @@ -1,9 +1,10 @@ -const { isGenerator } = require('../utils') -const DataTable = require('./table') -const DataScenarioConfig = require('./dataScenarioConfig') -const Secret = require('../secret') +import { isGenerator } from '../utils.js' +import DataTable from './table.js' +import DataScenarioConfig from './dataScenarioConfig.js' +import secretModule from '../secret.js' +const Secret = secretModule.default || secretModule -module.exports = function (context) { +export default function (context) { context.Data = function (dataTable) { const data = detectDataType(dataTable) return { @@ -13,8 +14,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 +33,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 +52,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 +70,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 +100,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 +115,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..5e639a657 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,9 +76,9 @@ class DataScenarioConfig { * @param {*} dependencies */ injectDependencies(dependencies) { - this.scenarios.forEach((scenario) => scenario.injectDependencies(dependencies)) + this.scenarios.forEach(scenario => scenario.injectDependencies(dependencies)) return this } } -module.exports = DataScenarioConfig +export default DataScenarioConfig diff --git a/lib/data/dataTableArgument.js b/lib/data/dataTableArgument.js index 7d1a72d32..919932b0f 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,20 +47,20 @@ 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])) } } -module.exports = DataTableArgument +export default DataTableArgument diff --git a/lib/data/table.js b/lib/data/table.js index 841e444dc..ccb051738 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,8 +36,8 @@ class DataTable { /** @param {Function} func */ filter(func) { - return this.rows.filter((row) => func(row.data)) + return this.rows.filter(row => func(row.data)) } } -module.exports = DataTable +export default DataTable diff --git a/lib/effects.js b/lib/effects.js new file mode 100644 index 000000000..967af70ee --- /dev/null +++ b/lib/effects.js @@ -0,0 +1,307 @@ +import recorder from './recorder.js' +import output from './output.js' +import store from './store.js' +import event from './event.js' +import container from './container.js' +import MetaStep from './step/meta.js' +import { isAsyncFunction } from './utils.js' + +/** + * @param {CodeceptJS.LocatorOrString} context + * @param {Function} fn + * @return {Promise<*> | undefined} + */ +function within(context, fn) { + const helpers = store.dryRun ? {} : container.helpers() + const locator = typeof context === 'object' ? JSON.stringify(context) : context + + return recorder.add( + 'register within wrapper', + () => { + const metaStep = new WithinStep(locator, fn) + const defineMetaStep = step => (step.metaStep = metaStep) + recorder.session.start('within') + + event.dispatcher.prependListener(event.step.before, defineMetaStep) + + Object.keys(helpers).forEach(helper => { + if (helpers[helper]._withinBegin) recorder.add(`[${helper}] start within`, () => helpers[helper]._withinBegin(context)) + }) + + const finalize = () => { + event.dispatcher.removeListener(event.step.before, defineMetaStep) + recorder.add('Finalize session within session', () => { + output.stepShift = 1 + recorder.session.restore('within') + }) + } + const finishHelpers = () => { + Object.keys(helpers).forEach(helper => { + if (helpers[helper]._withinEnd) recorder.add(`[${helper}] finish within`, () => helpers[helper]._withinEnd()) + }) + } + + if (isAsyncFunction(fn)) { + return fn() + .then(res => { + finishHelpers() + finalize() + return recorder.promise().then(() => res) + }) + .catch(e => { + finalize() + recorder.throw(e) + }) + } + + let res + try { + res = fn() + } catch (err) { + recorder.throw(err) + } finally { + finishHelpers() + recorder.catch(err => { + output.stepShift = 1 + throw err + }) + } + finalize() + return recorder.promise().then(() => res) + }, + false, + false, + ) +} + +class WithinStep extends MetaStep { + constructor(locator, fn) { + super('Within') + this.args = [locator] + } + + toString() { + return `${this.prefix}Within ${this.humanizeArgs()}${this.suffix}` + } +} + +/** + * 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() + output.debug(`Unsuccessful assertion > ${msg}`) + event.dispatcher.once(event.test.finished, test => { + if (!test.notes) test.notes = [] + 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) { + output.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) output.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() + output.debug(`Unsuccessful try > ${msg}`) + recorder.session.restore(sessionName) + return result + }) + return recorder.add( + 'result', + () => { + store.autoRetries = isAutoRetriesEnabled + return result + }, + true, + false, + ) + }, + false, + false, + ) +} + +export { hopeThat, retryTo, tryTo, within } + +export default { + hopeThat, + retryTo, + tryTo, + within, +} diff --git a/lib/els.js b/lib/els.js new file mode 100644 index 000000000..107cc303b --- /dev/null +++ b/lib/els.js @@ -0,0 +1,160 @@ +import output from './output.js' +import store from './store.js' +import container from './container.js' +import StepConfig from './step/config.js' +import recordStep from './step/record.js' +import FuncStep from './step/func.js' +import { truth } from './assert/truth.js' +import { isAsyncFunction, humanizeFunction } from './utils.js' + +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++ + } + }) +} + +export { element, eachElement, expectElement, expectAnyElement, expectAllElements } + +export default { + 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..6a889b7f2 100644 --- a/lib/event.js +++ b/lib/event.js @@ -1,15 +1,16 @@ -const debug = require('debug')('codeceptjs:event'); -const events = require('events'); -const { error } = require('./output'); +import debugModule from 'debug' +const debug = debugModule('codeceptjs:event') +import events from 'events' +import output from './output.js' -const dispatcher = new events.EventEmitter(); +const dispatcher = new events.EventEmitter() -dispatcher.setMaxListeners(50); +dispatcher.setMaxListeners(50) /** * @namespace * @alias event */ -module.exports = { +export default { /** * @type {NodeJS.EventEmitter} * @constant @@ -54,12 +55,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 +145,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); + output.error(`Error processing ${event} event:`) + output.error(err.stack) } }, /** for testing only! */ - cleanDispatcher: () => { - let event; + cleanDispatcher() { + 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.suite[event]) } for (event in this.step) { - this.dispatcher.removeAllListeners(this.test[event]); + this.dispatcher.removeAllListeners(this.step[event]) } for (event in this.all) { - this.dispatcher.removeAllListeners(this.test[event]); + this.dispatcher.removeAllListeners(this.all[event]) } }, -}; +} diff --git a/lib/globals.js b/lib/globals.js new file mode 100644 index 000000000..cfbbdff26 --- /dev/null +++ b/lib/globals.js @@ -0,0 +1,141 @@ +/** + * Global variables initialization module + * + * Centralizes all global variable setup for CodeceptJS from codecept.js and mocha/ui.js + */ + +import fsPath from 'path' +import ActorFactory from './actor.js' +import output from './output.js' +import locator from './locator.js' + +/** + * Initialize CodeceptJS core globals + * Called from Codecept.initGlobals() + */ +export async function initCodeceptGlobals(dir, config, container) { + global.codecept_dir = dir + global.output_dir = fsPath.resolve(dir, config.output) + + if (config.noGlobals) return; + // Set up actor global - will use container when available + global.actor = global.codecept_actor = (obj) => { + return ActorFactory(obj, global.container || container) + } + global.Actor = global.actor + + // Use dynamic imports for modules to avoid circular dependencies + global.pause = async (...args) => { + const pauseModule = await import('./pause.js') + return (pauseModule.default || pauseModule)(...args) + } + + global.within = async (...args) => { + return (await import('./effects.js')).within(...args) + } + + global.session = async (...args) => { + const sessionModule = await import('./session.js') + return (sessionModule.default || sessionModule)(...args) + } + + const dataTableModule = await import('./data/table.js') + global.DataTable = dataTableModule.default || dataTableModule + + global.locate = locatorQuery => { + return locator.build(locatorQuery) + } + + global.inject = () => container.support() + global.share = container.share + + const secretModule = await import('./secret.js') + global.secret = secretModule.secret || (secretModule.default && secretModule.default.secret) + + global.codecept_debug = output.debug + + const codeceptjsModule = await import('./index.js') // load all objects + global.codeceptjs = codeceptjsModule.default || codeceptjsModule + + // BDD step definitions + const stepDefinitionsModule = await import('./mocha/bdd.js') + const stepDefinitions = stepDefinitionsModule.default || stepDefinitionsModule + global.Given = stepDefinitions.Given + global.When = stepDefinitions.When + global.Then = stepDefinitions.Then + global.DefineParameterType = stepDefinitions.defineParameterType + + // debug mode + global.debugMode = false + + // mask sensitive data + global.maskSensitiveData = config.maskSensitiveData || false + +} + +/** + * Initialize Mocha test framework globals (Feature, Scenario, etc.) + * Called from mocha/ui.js pre-require event + */ +export function initMochaGlobals(context) { + // Mocha test framework globals + global.BeforeAll = context.BeforeAll + global.AfterAll = context.AfterAll + global.Feature = context.Feature + global.xFeature = context.xFeature + global.BeforeSuite = context.BeforeSuite + global.AfterSuite = context.AfterSuite + global.Background = context.Background + global.Before = context.Before + global.After = context.After + global.Scenario = context.Scenario + global.xScenario = context.xScenario +} + +/** + * Clear all CodeceptJS globals (useful for testing/cleanup) + */ +export function clearGlobals() { + getGlobalNames().forEach(name => delete global[name]); +} + +/** + * Get list of all CodeceptJS global variable names + */ +export function getGlobalNames() { + return [ + 'codecept_dir', + 'output_dir', + 'actor', + 'codecept_actor', + 'Actor', + 'pause', + 'within', + 'session', + 'DataTable', + 'locate', + 'inject', + 'share', + 'secret', + 'codecept_debug', + 'codeceptjs', + 'Given', + 'When', + 'Then', + 'DefineParameterType', + 'debugMode', + 'maskSensitiveData', + 'BeforeAll', + 'AfterAll', + 'Feature', + 'xFeature', + 'BeforeSuite', + 'AfterSuite', + 'Background', + 'Before', + 'After', + 'Scenario', + 'xScenario', + 'container' + ] +} diff --git a/lib/heal.js b/lib/heal.js index 7c21a47f8..0d8816705 100644 --- a/lib/heal.js +++ b/lib/heal.js @@ -1,64 +1,64 @@ -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'); +import debugModule from 'debug' +const debug = debugModule('codeceptjs:heal') +import colors from 'chalk' +import recorder from './recorder.js' +import output from './output.js' +import event from './event.js' /** * @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; - }); + this.contextName = suite.title + }) event.dispatcher.on(event.test.started, test => { - this.contextName = test.fullTitle(); - }); + 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 @@ -66,60 +66,60 @@ class Heal { .filter(p => !!p) .reduce((acc, obj) => ({ ...acc, ...obj }), {}), )) { - if (!prepareFn) continue; + if (!prepareFn) continue - if (context[property]) continue; - context[property] = await prepareFn(Container.support()); + if (context[property]) continue + context[property] = await prepareFn(global.inject()) } - 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); + debug('Executing', codeSnippet) recorder.catch(e => { - debug(e); - }); + debug(e) + }) if (typeof codeSnippet === 'string') { - const I = Container.support('I'); - await eval(codeSnippet); // eslint-disable-line + const I = global.container.support('I') + await eval(codeSnippet) } else if (typeof codeSnippet === 'function') { - await codeSnippet(Container.support()); + await codeSnippet(global.container.support()) } this.fixes.push({ @@ -127,44 +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'); + static async setDefaultHealers() { + await import('./template/heal.js') } } -const heal = new Heal(); +const heal = new Heal() -module.exports = heal; +export default 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.js b/lib/helper.js index 3919046d1..c0a4471f0 100644 --- a/lib/helper.js +++ b/lib/helper.js @@ -1,2 +1,3 @@ // helper class was moved out from this repository to allow extending from base class -module.exports = require('@codeceptjs/helper'); +import Helper from '@codeceptjs/helper' +export default Helper diff --git a/lib/helper/AI.js b/lib/helper/AI.js index 4b2d75978..be5a2a290 100644 --- a/lib/helper/AI.js +++ b/lib/helper/AI.js @@ -1,15 +1,16 @@ -const Helper = require('@codeceptjs/helper') +const HelperModule = require('@codeceptjs/helper') 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..0ab61280f 100644 --- a/lib/helper/ApiDataFactory.js +++ b/lib/helper/ApiDataFactory.js @@ -1,7 +1,6 @@ -const path = require('path') - -const Helper = require('@codeceptjs/helper') -const REST = require('./REST') +import path from 'path' +import Helper from '@codeceptjs/helper' +import REST from './REST.js' /** * Helper for managing remote data using REST API. @@ -217,15 +216,16 @@ 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() { try { - require('axios') - require('rosie') + // In ESM, dependencies are already imported at the top + // The import will fail at module load time if dependencies are missing + return null } catch (e) { - return ['axios', 'rosie'] + return ['axios'] } } @@ -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(() => { @@ -405,7 +402,7 @@ Current file error: ${err.message}`) } } -module.exports = ApiDataFactory +export { ApiDataFactory as default } function createRequestFromFunction(param, data) { if (typeof param !== 'function') return 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/FileSystem.js b/lib/helper/FileSystem.js index 68d6d645d..6aff1d2b7 100644 --- a/lib/helper/FileSystem.js +++ b/lib/helper/FileSystem.js @@ -1,11 +1,11 @@ -const assert = require('assert') -const path = require('path') -const fs = require('fs') +import assert from 'assert' +import path from 'path' +import fs from 'fs' -const Helper = require('@codeceptjs/helper') -const { fileExists } = require('../utils') -const { fileIncludes } = require('../assert/include') -const { fileEquals } = require('../assert/equal') +import Helper from '@codeceptjs/helper' +import { fileExists } from '../utils.js' +import { fileIncludes } from '../assert/include.js' +import { fileEquals } from '../assert/equal.js' /** * Helper for testing filesystem. @@ -38,7 +38,12 @@ class FileSystem extends Helper { } _before() { - this.debugSection('Dir', this.dir) + try { + this.debugSection('Dir', this.dir) + } catch (e) { + // Fallback debug for ESM transition + console.log(`[Dir] ${this.dir}`) + } } /** @@ -48,7 +53,12 @@ class FileSystem extends Helper { */ amInPath(openPath) { this.dir = path.join(global.codecept_dir, openPath) - this.debugSection('Dir', this.dir) + try { + this.debugSection('Dir', this.dir) + } catch (e) { + // Fallback debug for ESM transition + console.log(`[Dir] ${this.dir}`) + } } /** @@ -66,7 +76,12 @@ class FileSystem extends Helper { */ seeFile(name) { this.file = path.join(this.dir, name) - this.debugSection('File', this.file) + try { + this.debugSection('File', this.file) + } catch (e) { + // Fallback debug for ESM transition + console.log(`[File] ${this.file}`) + } assert.ok(fileExists(this.file), `File ${name} not found in ${this.dir}`) } @@ -86,7 +101,12 @@ class FileSystem extends Helper { if (sec === 0) assert.fail('Use `seeFile` instead of waiting 0 seconds!') const waitTimeout = sec * 1000 this.file = path.join(this.dir, name) - this.debugSection('File', this.file) + try { + this.debugSection('File', this.file) + } catch (e) { + // Fallback debug for ESM transition + console.log(`[File] ${this.file}`) + } return isFileExists(this.file, waitTimeout).catch(() => { throw new Error(`file (${name}) still not present in directory ${this.dir} after ${waitTimeout / 1000} sec`) }) @@ -105,7 +125,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,11 +195,11 @@ 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()) } } -module.exports = FileSystem +export { FileSystem as default } /** * @param {string} file @@ -216,7 +236,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/GraphQL.js b/lib/helper/GraphQL.js index 4a5f39c29..f688df8f3 100644 --- a/lib/helper/GraphQL.js +++ b/lib/helper/GraphQL.js @@ -1,5 +1,5 @@ const axios = require('axios').default -const Helper = require('@codeceptjs/helper') +const HelperModule = require('@codeceptjs/helper') /** * GraphQL helper allows to send additional requests to a GraphQl endpoint during acceptance tests. diff --git a/lib/helper/GraphQLDataFactory.js b/lib/helper/GraphQLDataFactory.js index d6453b7b3..158f9bd0d 100644 --- a/lib/helper/GraphQLDataFactory.js +++ b/lib/helper/GraphQLDataFactory.js @@ -1,6 +1,6 @@ const path = require('path') -const Helper = require('@codeceptjs/helper') +const HelperModule = require('@codeceptjs/helper') const GraphQL = require('./GraphQL') /** @@ -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 2e3adcc06..08f2be8b9 100644 --- a/lib/helper/JSONResponse.js +++ b/lib/helper/JSONResponse.js @@ -1,6 +1,6 @@ -const Helper = require('@codeceptjs/helper'); -const assert = require('assert'); -const joi = require('joi'); +import Helper from '@codeceptjs/helper' +import assert from 'assert' +import joi from 'joi' /** * This helper allows performing assertions on JSON responses paired with following helpers: @@ -60,33 +60,40 @@ const joi = require('joi'); */ class JSONResponse extends Helper { constructor(config = {}) { - super(config); + super(config) this.options = { requestHelper: 'REST', - }; - this.options = { ...this.options, ...config }; + } + this.options = { ...this.options, ...config } } _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)}`); + this.response = null + try { + 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)}`) + } + // connect to REST helper + this.helpers[this.options.requestHelper].config.onResponse = response => { + this.response = response + } + } catch (e) { + // Temporary workaround for ESM transition - helpers access issue + console.log('[JSONResponse] Warning: Could not connect to REST helper during ESM transition:', e.message) } - // connect to REST helper - this.helpers[this.options.requestHelper].config.onResponse = response => { - this.response = response; - }; } _before() { - this.response = null; + this.response = null } static _checkRequirements() { try { - require('joi'); + // In ESM, joi is already imported at the top + // The import will fail at module load time if joi is missing + return null } catch (e) { - return ['joi']; + return ['joi'] } } @@ -100,8 +107,8 @@ class JSONResponse extends Helper { * @param {number} code */ seeResponseCodeIs(code) { - this._checkResponseReady(); - assert.strictEqual(this.response.status, code, 'Response code is not the same as expected'); + this._checkResponseReady() + assert.strictEqual(this.response.status, code, 'Response code is not the same as expected') } /** @@ -114,32 +121,32 @@ class JSONResponse extends Helper { * @param {number} code */ dontSeeResponseCodeIs(code) { - this._checkResponseReady(); - assert.notStrictEqual(this.response.status, code); + this._checkResponseReady() + assert.notStrictEqual(this.response.status, code) } /** * Checks that the response code is 4xx */ seeResponseCodeIsClientError() { - this._checkResponseReady(); - assert(this.response.status >= 400 && this.response.status < 500); + this._checkResponseReady() + assert(this.response.status >= 400 && this.response.status < 500) } /** * Checks that the response code is 3xx */ seeResponseCodeIsRedirection() { - this._checkResponseReady(); - assert(this.response.status >= 300 && this.response.status < 400); + this._checkResponseReady() + assert(this.response.status >= 300 && this.response.status < 400) } /** * Checks that the response code is 5xx */ seeResponseCodeIsServerError() { - this._checkResponseReady(); - assert(this.response.status >= 500 && this.response.status < 600); + this._checkResponseReady() + assert(this.response.status >= 500 && this.response.status < 600) } /** @@ -151,8 +158,8 @@ class JSONResponse extends Helper { * ``` */ seeResponseCodeIsSuccessful() { - this._checkResponseReady(); - assert(this.response.status >= 200 && this.response.status < 300); + this._checkResponseReady() + assert(this.response.status >= 200 && this.response.status < 300) } /** @@ -173,21 +180,21 @@ class JSONResponse extends Helper { * @param {object} json */ seeResponseContainsJson(json = {}) { - this._checkResponseReady(); + this._checkResponseReady() if (Array.isArray(this.response.data)) { - let found = false; + let found = false for (const el of this.response.data) { try { - this._assertContains(el, json); - found = true; - break; + this._assertContains(el, json) + found = true + break } catch (err) { - continue; + continue } } - assert(found, `No elements in array matched ${JSON.stringify(json)}`); + assert(found, `No elements in array matched ${JSON.stringify(json)}`) } else { - this._assertContains(this.response.data, json); + this._assertContains(this.response.data, json) } } @@ -209,21 +216,21 @@ class JSONResponse extends Helper { * @param {object} json */ dontSeeResponseContainsJson(json = {}) { - this._checkResponseReady(); + this._checkResponseReady() if (Array.isArray(this.response.data)) { for (const data of this.response.data) { try { - this._assertContains(data, json); - assert.fail(`Found matching element: ${JSON.stringify(data)}`); + this._assertContains(data, json) + assert.fail(`Found matching element: ${JSON.stringify(data)}`) } catch (err) { // expected to fail - continue; + continue } } } else { try { - this._assertContains(this.response.data, json); - assert.fail('Response contains the JSON'); + this._assertContains(this.response.data, json) + assert.fail('Response contains the JSON') } catch (err) { // expected to fail } @@ -250,16 +257,16 @@ class JSONResponse extends Helper { * @param {array} keys */ seeResponseContainsKeys(keys = []) { - this._checkResponseReady(); + this._checkResponseReady() if (Array.isArray(this.response.data)) { 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)}`); + assert(key in data, `Key "${key}" is not found in ${JSON.stringify(data)}`) } } } else { for (const key of keys) { - assert(key in this.response.data, `Key "${key}" is not found in ${JSON.stringify(this.response.data)}`); + assert(key in this.response.data, `Key "${key}" is not found in ${JSON.stringify(this.response.data)}`) } } } @@ -279,10 +286,10 @@ class JSONResponse extends Helper { * @param {function} fn */ seeResponseValidByCallback(fn) { - this._checkResponseReady(); - fn({ ...this.response, assert }); - const body = fn.toString(); - fn.toString = () => `${body.split('\n')[1]}...`; + this._checkResponseReady() + fn({ ...this.response, assert }) + const body = fn.toString() + fn.toString = () => `${body.split('\n')[1]}...` } /** @@ -296,8 +303,8 @@ class JSONResponse extends Helper { * @param {object} resp */ seeResponseEquals(resp) { - this._checkResponseReady(); - assert.deepStrictEqual(this.response.data, resp); + this._checkResponseReady() + assert.deepStrictEqual(this.response.data, resp) } /** @@ -328,33 +335,33 @@ class JSONResponse extends Helper { * @param {any} fnOrSchema */ seeResponseMatchesJsonSchema(fnOrSchema) { - this._checkResponseReady(); - let schema = fnOrSchema; + this._checkResponseReady() + let schema = fnOrSchema if (typeof fnOrSchema === 'function') { - schema = fnOrSchema(joi); - const body = fnOrSchema.toString(); - fnOrSchema.toString = () => `${body.split('\n')[1]}...`; + schema = fnOrSchema(joi) + const body = fnOrSchema.toString() + fnOrSchema.toString = () => `${body.split('\n')[1]}...` } - if (!schema) throw new Error('Empty Joi schema provided, see https://joi.dev/ for details'); - if (!joi.isSchema(schema)) throw new Error('Invalid Joi schema provided, see https://joi.dev/ for details'); - schema.toString = () => schema.describe(); - joi.assert(this.response.data, schema); + if (!schema) throw new Error('Empty Joi schema provided, see https://joi.dev/ for details') + if (!joi.isSchema(schema)) throw new Error('Invalid Joi schema provided, see https://joi.dev/ for details') + schema.toString = () => schema.describe() + joi.assert(this.response.data, schema) } _checkResponseReady() { - if (!this.response) throw new Error('Response is not available'); + 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)}`); + 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]); + this._assertContains(actual[key], expected[key]) } else { - assert.deepStrictEqual(actual[key], expected[key], `Values for key "${key}" don't match`); + assert.deepStrictEqual(actual[key], expected[key], `Values for key "${key}" don't match`) } } } } -module.exports = JSONResponse; +export { JSONResponse as default } diff --git a/lib/helper/Mochawesome.js b/lib/helper/Mochawesome.js index abc143af4..5168c0eb1 100644 --- a/lib/helper/Mochawesome.js +++ b/lib/helper/Mochawesome.js @@ -1,9 +1,10 @@ -let addMochawesomeContext let currentTest let currentSuite -const Helper = require('@codeceptjs/helper') -const { clearString } = require('../utils') +import Helper from '@codeceptjs/helper' +import { createRequire } from 'module' +import { clearString } from '../utils.js' +import { testToFileName } from '../mocha/test.js' class Mochawesome extends Helper { constructor(config) { @@ -15,7 +16,10 @@ class Mochawesome extends Helper { disableScreenshots: false, } - addMochawesomeContext = require('mochawesome/addContext') + // ESM-compatible require for CommonJS module + const require = createRequire(import.meta.url) + this._addContext = require('mochawesome/addContext') + this._createConfig(config) } @@ -43,29 +47,28 @@ 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) } } -module.exports = Mochawesome +export default Mochawesome diff --git a/lib/helper/Nightmare.js b/lib/helper/Nightmare.js deleted file mode 100644 index 1a6e90692..000000000 --- a/lib/helper/Nightmare.js +++ /dev/null @@ -1,1504 +0,0 @@ -const path = require('path') - -const urlResolve = require('url').resolve - -const Helper = require('@codeceptjs/helper') -const { includes: stringIncludes } = require('../assert/include') -const { urlEquals } = require('../assert/equal') -const { equals } = require('../assert/equal') -const { empty } = require('../assert/empty') -const { truth } = require('../assert/truth') -const Locator = require('../locator') -const ElementNotFound = require('./errors/ElementNotFound') -const { xpathLocator, fileExists, screenshotOutputFolder, toCamelCase } = require('../utils') - -const specialKeys = { - Backspace: '\u0008', - Enter: '\u000d', - Delete: '\u007f', -} - -let withinStatus = false - -/** - * Nightmare helper wraps [Nightmare](https://github.com/segmentio/nightmare) library to provide - * fastest headless testing using Electron engine. Unlike Selenium-based drivers this uses - * Chromium-based browser with Electron with lots of client side scripts, thus should be less stable and - * less trusted. - * - * Requires `nightmare` package to be installed. - * - * ## Configuration - * - * This helper should be configured in codecept.conf.ts or codecept.conf.js - * - * * `url` - base url of website to be tested - * * `restart` (optional, default: true) - restart browser between tests. - * * `disableScreenshots` (optional, default: false) - don't save screenshot on failure. - * * `uniqueScreenshotNames` (optional, default: false) - option to prevent screenshot override if you have scenarios with the same name in different suites. - * * `fullPageScreenshots` (optional, default: false) - make full page screenshots on failure. - * * `keepBrowserState` (optional, default: false) - keep browser state between tests when `restart` set to false. - * * `keepCookies` (optional, default: false) - keep cookies between tests when `restart` set to false. - * * `waitForAction`: (optional) how long to wait after click, doubleClick or PressKey actions in ms. Default: 500. - * * `waitForTimeout`: (optional) default wait* timeout in ms. Default: 1000. - * * `windowSize`: (optional) default window size. Set a dimension like `640x480`. - * - * + options from [Nightmare configuration](https://github.com/segmentio/nightmare#api) - * - * ## Methods - */ -class Nightmare extends Helper { - constructor(config) { - super(config) - - this.isRunning = false - - // override defaults with config - this._setConfig(config) - } - - _validateConfig(config) { - const defaults = { - waitForAction: 500, - waitForTimeout: 1000, - fullPageScreenshots: false, - disableScreenshots: false, - uniqueScreenshotNames: false, - rootElement: 'body', - restart: true, - keepBrowserState: false, - keepCookies: false, - js_errors: null, - enableHAR: false, - } - - return Object.assign(defaults, config) - } - - static _config() { - return [ - { name: 'url', message: 'Base url of site to be tested', default: 'http://localhost' }, - { - name: 'show', - message: 'Show browser window', - default: true, - type: 'confirm', - }, - ] - } - - static _checkRequirements() { - try { - require('nightmare') - } catch (e) { - return ['nightmare'] - } - } - - async _init() { - this.Nightmare = require('nightmare') - - if (this.options.enableHAR) { - require('nightmare-har-plugin').install(this.Nightmare) - } - - this.Nightmare.action('findElements', function (locator, contextEl, done) { - if (!done) { - done = contextEl - contextEl = null - } - - 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.Nightmare.action('findElement', function (locator, contextEl, done) { - if (!done) { - done = contextEl - contextEl = null - } - - const by = Object.keys(locator)[0] - const value = locator[by] - - this.evaluate_now( - (by, locator, contextEl) => { - const res = window.codeceptjs.findAndStoreElement(by, locator, contextEl) - if (res === null) { - throw new Error(`Element ${new Locator(locator)} couldn't be located by ${by}`) - } - return res - }, - done, - by, - value, - contextEl, - ) - }) - - this.Nightmare.action('asyncScript', function () { - let args = Array.prototype.slice.call(arguments) - const done = args.pop() - args = args.splice(1, 0, done) - this.evaluate_now.apply(this, args) - }) - - this.Nightmare.action('enterText', function (el, text, clean, done) { - const child = this.child - const typeFn = () => child.call('type', text, done) - - this.evaluate_now( - (el, clean) => { - const element = window.codeceptjs.fetchElement(el) - if (clean) element.value = '' - element.focus() - }, - () => { - if (clean) return typeFn() - child.call('pressKey', 'End', typeFn) // type End before - }, - el, - clean, - ) - }) - - this.Nightmare.action( - 'pressKey', - (ns, options, parent, win, renderer, done) => { - parent.respondTo('pressKey', (ch, done) => { - win.webContents.sendInputEvent({ - type: 'keyDown', - keyCode: ch, - }) - - win.webContents.sendInputEvent({ - type: 'char', - keyCode: ch, - }) - - win.webContents.sendInputEvent({ - type: 'keyUp', - keyCode: ch, - }) - done() - }) - done() - }, - function (key, done) { - this.child.call('pressKey', key, done) - }, - ) - - this.Nightmare.action( - 'triggerMouseEvent', - (ns, options, parent, win, renderer, done) => { - parent.respondTo('triggerMouseEvent', (evt, done) => { - win.webContents.sendInputEvent(evt) - done() - }) - done() - }, - function (event, done) { - this.child.call('triggerMouseEvent', event, done) - }, - ) - - this.Nightmare.action( - 'upload', - (ns, options, parent, win, renderer, done) => { - parent.respondTo('upload', (selector, pathsToUpload, done) => { - parent.emit('log', 'paths', pathsToUpload) - try { - // attach the debugger - // NOTE: this will fail if devtools is open - win.webContents.debugger.attach('1.1') - } catch (e) { - parent.emit('log', 'problem attaching', e) - return done(e) - } - - win.webContents.debugger.sendCommand('DOM.getDocument', {}, (err, domDocument) => { - win.webContents.debugger.sendCommand( - 'DOM.querySelector', - { - nodeId: domDocument.root.nodeId, - selector, - }, - (err, queryResult) => { - // HACK: chromium errors appear to be unpopulated objects? - if (Object.keys(err).length > 0) { - parent.emit('log', 'problem selecting', err) - return done(err) - } - win.webContents.debugger.sendCommand( - 'DOM.setFileInputFiles', - { - nodeId: queryResult.nodeId, - files: pathsToUpload, - }, - (err) => { - if (Object.keys(err).length > 0) { - parent.emit('log', 'problem setting input', err) - return done(err) - } - win.webContents.debugger.detach() - done(null, pathsToUpload) - }, - ) - }, - ) - }) - }) - done() - }, - function (selector, pathsToUpload, done) { - if (!Array.isArray(pathsToUpload)) { - pathsToUpload = [pathsToUpload] - } - this.child.call('upload', selector, pathsToUpload, (err, stuff) => { - done(err, stuff) - }) - }, - ) - - return Promise.resolve() - } - - async _beforeSuite() { - if (!this.options.restart && !this.isRunning) { - this.debugSection('Session', 'Starting singleton browser session') - return this._startBrowser() - } - } - - async _before() { - if (this.options.restart) return this._startBrowser() - if (!this.isRunning) return this._startBrowser() - return this.browser - } - - async _after() { - if (!this.isRunning) return - if (this.options.restart) { - this.isRunning = false - return this._stopBrowser() - } - if (this.options.enableHAR) { - await this.browser.resetHAR() - } - if (this.options.keepBrowserState) return - if (this.options.keepCookies) { - await this.browser.cookies.clearAll() - } - this.debugSection('Session', 'cleaning up') - return this.executeScript(() => localStorage.clear()) - } - - _afterSuite() {} - - _finishTest() { - if (!this.options.restart && this.isRunning) { - this._stopBrowser() - } - } - - async _startBrowser() { - this.context = this.options.rootElement - if (this.options.enableHAR) { - this.browser = this.Nightmare(Object.assign(require('nightmare-har-plugin').getDevtoolsOptions(), this.options)) - await this.browser - await this.browser.waitForDevtools() - } else { - this.browser = this.Nightmare(this.options) - await this.browser - } - await this.browser.goto('about:blank') // Load a blank page so .saveScreenshot (/evaluate) will work - this.isRunning = true - this.browser.on('dom-ready', () => this._injectClientScripts()) - this.browser.on('did-start-loading', () => this._injectClientScripts()) - this.browser.on('will-navigate', () => this._injectClientScripts()) - this.browser.on('console', (type, message) => { - this.debug(`${type}: ${message}`) - }) - - if (this.options.windowSize) { - const size = this.options.windowSize.split('x') - return this.browser.viewport(parseInt(size[0], 10), parseInt(size[1], 10)) - } - } - - /** - * Get HAR - * - * ```js - * let har = await I.grabHAR(); - * fs.writeFileSync('sample.har', JSON.stringify({log: har})); - * ``` - */ - async grabHAR() { - return this.browser.getHAR() - } - - async saveHAR(fileName) { - const outputFile = path.join(global.output_dir, fileName) - this.debug(`HAR is saving to ${outputFile}`) - - await this.browser.getHAR().then((har) => { - require('fs').writeFileSync(outputFile, JSON.stringify({ log: har })) - }) - } - - async resetHAR() { - await this.browser.resetHAR() - } - - async _stopBrowser() { - return this.browser.end().catch((error) => { - this.debugSection('Error on End', error) - }) - } - - async _withinBegin(locator) { - this.context = locator - locator = new Locator(locator, 'css') - withinStatus = true - return this.browser.evaluate( - (by, locator) => { - const el = window.codeceptjs.findElement(by, locator) - if (!el) throw new Error(`Element by ${by}: ${locator} not found`) - window.codeceptjs.within = el - }, - locator.type, - locator.value, - ) - } - - _withinEnd() { - this.context = this.options.rootElement - withinStatus = false - return this.browser.evaluate(() => { - window.codeceptjs.within = null - }) - } - - /** - * Locate elements by different locator types, including strict locator. - * Should be used in custom helpers. - * - * This method return promise with array of IDs of found elements. - * Actual elements can be accessed inside `evaluate` by using `codeceptjs.fetchElement()` - * client-side function: - * - * ```js - * // get an inner text of an element - * - * let browser = this.helpers['Nightmare'].browser; - * let value = this.helpers['Nightmare']._locate({name: 'password'}).then(function(els) { - * return browser.evaluate(function(el) { - * return codeceptjs.fetchElement(el).value; - * }, els[0]); - * }); - * ``` - */ - _locate(locator) { - locator = new Locator(locator, 'css') - return this.browser.evaluate( - (by, locator) => { - return window.codeceptjs.findAndStoreElements(by, locator) - }, - locator.type, - locator.value, - ) - } - - /** - * Add a header override for all HTTP requests. If header is undefined, the header overrides will be reset. - * - * ```js - * I.haveHeader('x-my-custom-header', 'some value'); - * I.haveHeader(); // clear headers - * ``` - */ - haveHeader(header, value) { - return this.browser.header(header, value) - } - - /** - * {{> amOnPage }} - * @param {?object} headers list of request headers can be passed - * - */ - async amOnPage(url, headers = null) { - if (!/^\w+\:\/\//.test(url)) { - url = urlResolve(this.options.url, url) - } - const currentUrl = await this.browser.url() - if (url === currentUrl) { - // 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) => { - this.debugSection('URL', res.url) - this.debugSection('Code', res.code) - this.debugSection('Headers', JSON.stringify(res.headers)) - }) - } - - /** - * {{> seeInTitle }} - */ - async seeInTitle(text) { - const title = await this.browser.title() - stringIncludes('web page title').assert(text, title) - } - - /** - * {{> dontSeeInTitle }} - */ - async dontSeeInTitle(text) { - const title = await this.browser.title() - stringIncludes('web page title').negate(text, title) - } - - /** - * {{> grabTitle }} - */ - async grabTitle() { - return this.browser.title() - } - - /** - * {{> grabCurrentUrl }} - */ - async grabCurrentUrl() { - return this.browser.url() - } - - /** - * {{> seeInCurrentUrl }} - */ - async seeInCurrentUrl(url) { - const currentUrl = await this.browser.url() - stringIncludes('url').assert(url, currentUrl) - } - - /** - * {{> dontSeeInCurrentUrl }} - */ - async dontSeeInCurrentUrl(url) { - const currentUrl = await this.browser.url() - stringIncludes('url').negate(url, currentUrl) - } - - /** - * {{> seeCurrentUrlEquals }} - */ - async seeCurrentUrlEquals(url) { - const currentUrl = await this.browser.url() - urlEquals(this.options.url).assert(url, currentUrl) - } - - /** - * {{> dontSeeCurrentUrlEquals }} - */ - async dontSeeCurrentUrlEquals(url) { - const currentUrl = await this.browser.url() - urlEquals(this.options.url).negate(url, currentUrl) - } - - /** - * {{> see }} - */ - async see(text, context = null) { - return proceedSee.call(this, 'assert', text, context) - } - - /** - * {{> dontSee }} - */ - dontSee(text, context = null) { - return proceedSee.call(this, 'negate', text, context) - } - - /** - * {{> seeElement }} - */ - async seeElement(locator) { - 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 - }, - locator.type, - locator.value, - ) - equals('number of elements on a page').negate(0, num) - } - - /** - * {{> dontSeeElement }} - */ - async dontSeeElement(locator) { - locator = new Locator(locator, 'css') - 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 - }, - locator.type, - locator.value, - ) - equals('number of elements on a page').assert(0, num) - } - - /** - * {{> seeElementInDOM }} - */ - async seeElementInDOM(locator) { - locator = new Locator(locator, 'css') - const els = await this.browser.findElements(locator.toStrict()) - empty('elements').negate(els.fill('ELEMENT')) - } - - /** - * {{> dontSeeElementInDOM }} - */ - async dontSeeElementInDOM(locator) { - locator = new Locator(locator, 'css') - const els = await this.browser.findElements(locator.toStrict()) - empty('elements').assert(els.fill('ELEMENT')) - } - - /** - * {{> seeInSource }} - */ - async seeInSource(text) { - const source = await this.browser.evaluate(() => document.documentElement.outerHTML) - stringIncludes('HTML source of a page').assert(text, source) - } - - /** - * {{> dontSeeInSource }} - */ - async dontSeeInSource(text) { - const source = await this.browser.evaluate(() => document.documentElement.outerHTML) - stringIncludes('HTML source of a page').negate(text, source) - } - - /** - * {{> seeNumberOfElements }} - */ - 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) - } - - /** - * {{> seeNumberOfVisibleElements }} - */ - 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, - ) - } - - /** - * {{> grabNumberOfVisibleElements }} - */ - async grabNumberOfVisibleElements(locator) { - 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 - }, - locator.type, - locator.value, - ) - - return num - } - - /** - * {{> click }} - */ - 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) - } - - /** - * {{> doubleClick }} - */ - 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) - } - - /** - * {{> rightClick }} - */ - 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) - } - - /** - * {{> moveCursorTo }} - */ - async moveCursorTo(locator, offsetX = 0, offsetY = 0) { - 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 - } - - /** - * {{> executeScript }} - * - * 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 :( - } - - /** - * {{> executeAsyncScript }} - * - * Wrapper for asynchronous [evaluate](https://github.com/segmentio/nightmare#evaluatefn-arg1-arg2). - * 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 :( - } - - /** - * {{> resizeWindow }} - */ - async resizeWindow(width, height) { - if (width === 'maximize') { - throw new Error("Nightmare doesn't support resizeWindow to maximum!") - } - return this.browser.viewport(width, height).wait(this.options.waitForAction) - } - - /** - * {{> checkOption }} - */ - 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) - } - - /** - * {{> uncheckOption }} - */ - 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) - } - - /** - * {{> fillField }} - */ - async fillField(field, value) { - const el = await findField.call(this, field) - assertElementExists(el, field, 'Field') - return this.browser.enterText(el, value.toString(), true).wait(this.options.waitForAction) - } - - /** - * {{> clearField }} - */ - async clearField(field) { - return this.fillField(field, '') - } - - /** - * {{> appendField }} - */ - async appendField(field, value) { - const el = await findField.call(this, field) - assertElementExists(el, field, 'Field') - return this.browser.enterText(el, value.toString(), false).wait(this.options.waitForAction) - } - - /** - * {{> seeInField }} - */ - async seeInField(field, value) { - const _value = typeof value === 'boolean' ? value : value.toString() - return proceedSeeInField.call(this, 'assert', field, _value) - } - - /** - * {{> dontSeeInField }} - */ - async dontSeeInField(field, value) { - const _value = typeof value === 'boolean' ? value : value.toString() - return proceedSeeInField.call(this, 'negate', field, _value) - } - - /** - * Sends [input event](http://electron.atom.io/docs/api/web-contents/#webcontentssendinputeventevent) on a page. - * Can submit special keys like 'Enter', 'Backspace', etc - */ - async pressKey(key) { - if (Array.isArray(key)) { - key = key.join('+') // should work with accelerators... - } - if (Object.keys(specialKeys).indexOf(key) >= 0) { - key = specialKeys[key] - } - return this.browser.pressKey(key).wait(this.options.waitForAction) - } - - /** - * Sends [input event](http://electron.atom.io/docs/api/web-contents/#contentssendinputeventevent) on a page. - * Should be a mouse event like: - * { - type: 'mouseDown', - x: args.x, - y: args.y, - button: "left" - } - */ - async triggerMouseEvent(event) { - return this.browser.triggerMouseEvent(event).wait(this.options.waitForAction) - } - - /** - * {{> seeCheckboxIsChecked }} - */ - async seeCheckboxIsChecked(field) { - return proceedIsChecked.call(this, 'assert', field) - } - - /** - * {{> dontSeeCheckboxIsChecked }} - */ - async dontSeeCheckboxIsChecked(field) { - return proceedIsChecked.call(this, 'negate', field) - } - - /** - * {{> attachFile }} - * - * Doesn't work if the Chromium DevTools panel is open (as Chromium allows only one attachment to the debugger at a time. [See more](https://github.com/rosshinkley/nightmare-upload#important-note-about-setting-file-upload-inputs)) - */ - async attachFile(locator, pathToFile) { - const file = path.join(global.codecept_dir, pathToFile) - - locator = new Locator(locator, 'css') - if (!locator.isCSS()) { - throw new Error('Only CSS locator allowed for attachFile in Nightmare helper') - } - - if (!fileExists(file)) { - throw new Error(`File at ${file} can not be found on local system`) - } - return this.browser.upload(locator.value, file) - } - - /** - * {{> grabTextFromAll }} - */ - async grabTextFromAll(locator) { - locator = new Locator(locator, 'css') - const els = await this.browser.findElements(locator.toStrict()) - const texts = [] - const getText = (el) => window.codeceptjs.fetchElement(el).innerText - for (const el of els) { - texts.push(await this.browser.evaluate(getText, el)) - } - return texts - } - - /** - * {{> grabTextFrom }} - */ - async grabTextFrom(locator) { - locator = new Locator(locator, 'css') - const els = await this.browser.findElement(locator.toStrict()) - assertElementExists(els, locator) - const texts = await this.grabTextFromAll(locator) - if (texts.length > 1) { - this.debugSection('GrabText', `Using first element out of ${texts.length}`) - } - - return texts[0] - } - - /** - * {{> grabValueFromAll }} - */ - async grabValueFromAll(locator) { - locator = new Locator(locator, 'css') - const els = await this.browser.findElements(locator.toStrict()) - const values = [] - const getValues = (el) => window.codeceptjs.fetchElement(el).value - for (const el of els) { - values.push(await this.browser.evaluate(getValues, el)) - } - - return values - } - - /** - * {{> grabValueFrom }} - */ - async grabValueFrom(locator) { - const el = await findField.call(this, locator) - assertElementExists(el, locator, 'Field') - const values = await this.grabValueFromAll(locator) - if (values.length > 1) { - this.debugSection('GrabValue', `Using first element out of ${values.length}`) - } - - return values[0] - } - - /** - * {{> grabAttributeFromAll }} - */ - async grabAttributeFromAll(locator, attr) { - locator = new Locator(locator, 'css') - const els = await this.browser.findElements(locator.toStrict()) - const array = [] - - 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), - ) - } - - return array - } - - /** - * {{> grabAttributeFrom }} - */ - async grabAttributeFrom(locator, attr) { - locator = new Locator(locator, 'css') - const els = await this.browser.findElement(locator.toStrict()) - assertElementExists(els, locator) - - const attrs = await this.grabAttributeFromAll(locator, attr) - if (attrs.length > 1) { - this.debugSection('GrabAttribute', `Using first element out of ${attrs.length}`) - } - - return attrs[0] - } - - /** - * {{> grabHTMLFromAll }} - */ - async grabHTMLFromAll(locator) { - locator = new Locator(locator, 'css') - const els = await this.browser.findElements(locator.toStrict()) - const array = [] - - 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)) - } - this.debugSection('GrabHTML', array) - - return array - } - - /** - * {{> grabHTMLFrom }} - */ - async grabHTMLFrom(locator) { - locator = new Locator(locator, 'css') - const els = await this.browser.findElement(locator.toStrict()) - assertElementExists(els, locator) - const html = await this.grabHTMLFromAll(locator) - if (html.length > 1) { - this.debugSection('GrabHTML', `Using first element out of ${html.length}`) - } - - return html[0] - } - - /** - * {{> grabCssPropertyFrom }} - */ - async grabCssPropertyFrom(locator, cssProperty) { - locator = new Locator(locator, 'css') - const els = await this.browser.findElements(locator.toStrict()) - const array = [] - - const getCssPropForElement = async (el, prop) => { - return ( - await this.browser.evaluate((el) => { - return window.getComputedStyle(window.codeceptjs.fetchElement(el)) - }, el) - )[toCamelCase(prop)] - } - - for (const el of els) { - assertElementExists(el, locator) - const cssValue = await getCssPropForElement(el, cssProperty) - array.push(cssValue) - } - this.debugSection('HTML', array) - - return array.length > 1 ? array : array[0] - } - - _injectClientScripts() { - return this.browser.inject('js', path.join(__dirname, 'clientscripts', 'nightmare.js')) - } - - /** - * {{> selectOption }} - */ - async selectOption(select, option) { - const fetchAndCheckOption = function (el, locator) { - el = window.codeceptjs.fetchElement(el) - const found = document.evaluate(locator, el, null, 5, null) - let current = null - const items = [] - while ((current = found.iterateNext())) { - items.push(current) - } - for (let i = 0; i < items.length; i++) { - current = items[i] - if (current instanceof HTMLOptionElement) { - current.selected = true - if (!el.multiple) el.value = current.value - } - const event = document.createEvent('HTMLEvents') - event.initEvent('change', true, true) - el.dispatchEvent(event) - } - return !!current - } - - const el = await findField.call(this, select) - assertElementExists(el, select, 'Selectable field') - if (!Array.isArray(option)) { - option = [option] - } - - for (const key in option) { - const opt = xpathLocator.literal(option[key]) - const checked = await this.browser.evaluate(fetchAndCheckOption, el, Locator.select.byVisibleText(opt)) - - if (!checked) { - await this.browser.evaluate(fetchAndCheckOption, el, Locator.select.byValue(opt)) - } - } - return this.browser.wait(this.options.waitForAction) - } - - /** - * {{> setCookie }} - * - * Wrapper for `.cookies.set(cookie)`. - * [See more](https://github.com/segmentio/nightmare/blob/master/Readme.md#cookiessetcookie) - */ - async setCookie(cookie) { - return this.browser.cookies.set(cookie) - } - - /** - * {{> seeCookie }} - * - */ - async seeCookie(name) { - const res = await this.browser.cookies.get(name) - truth(`cookie ${name}`, 'to be set').assert(res) - } - - /** - * {{> dontSeeCookie }} - */ - async dontSeeCookie(name) { - const res = await this.browser.cookies.get(name) - truth(`cookie ${name}`, 'to be set').negate(res) - } - - /** - * {{> grabCookie }} - * - * Cookie in JSON format. If name not passed returns all cookies for this domain. - * - * Multiple cookies can be received by passing query object `I.grabCookie({ secure: true});`. If you'd like get all cookies for all urls, use: `.grabCookie({ url: null }).` - */ - async grabCookie(name) { - return this.browser.cookies.get(name) - } - - /** - * {{> clearCookie }} - */ - async clearCookie(cookie) { - if (!cookie) { - return this.browser.cookies.clearAll() - } - return this.browser.cookies.clear(cookie) - } - - /** - * {{> waitForFunction }} - */ - async waitForFunction(fn, argsOrSec = null, sec = null) { - let args = [] - if (argsOrSec) { - if (Array.isArray(argsOrSec)) { - args = argsOrSec - } else if (typeof argsOrSec === 'number') { - sec = argsOrSec - } - } - this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout - return this.browser.wait(fn, ...args) - } - - /** - * {{> wait }} - */ - async wait(sec) { - return new Promise((done) => { - setTimeout(done, sec * 1000) - }) - } - - /** - * {{> waitForText }} - */ - async waitForText(text, sec, context = null) { - if (!context) { - context = this.context - } - const locator = new Locator(context, 'css') - this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout - return this.browser - .wait( - (by, locator, text) => { - return window.codeceptjs.findElement(by, locator).innerText.indexOf(text) > -1 - }, - locator.type, - locator.value, - text, - ) - .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) { - throw new Error(`there is no element(${JSON.stringify(context)}) with text "${text}" after ${sec} sec`) - } else throw err - }) - } - - /** - * {{> waitForVisible }} - */ - waitForVisible(locator, sec) { - this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout - locator = new Locator(locator, 'css') - - return this.browser - .wait( - (by, locator) => { - const el = window.codeceptjs.findElement(by, locator) - if (!el) return false - return el.offsetWidth > 0 && el.offsetHeight > 0 - }, - locator.type, - locator.value, - ) - .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 - }) - } - - /** - * {{> waitToHide }} - */ - async waitToHide(locator, sec = null) { - return this.waitForInvisible(locator, sec) - } - - /** - * {{> waitForInvisible }} - */ - waitForInvisible(locator, sec) { - this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout - locator = new Locator(locator, 'css') - - return this.browser - .wait( - (by, locator) => { - const el = window.codeceptjs.findElement(by, locator) - if (!el) return true - return !(el.offsetWidth > 0 && el.offsetHeight > 0) - }, - locator.type, - locator.value, - ) - .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 - }) - } - - /** - * {{> waitForElement }} - */ - async waitForElement(locator, sec) { - this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout - locator = new Locator(locator, 'css') - - return this.browser - .wait((by, locator) => window.codeceptjs.findElement(by, locator) !== null, locator.type, locator.value) - .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 - }) - } - - async waitUntilExists(locator, sec) { - console.log(`waitUntilExists deprecated: - * use 'waitForElement' to wait for element to be attached - * use 'waitForDetached to wait for element to be removed'`) - return this.waitForDetached(locator, sec) - } - - /** - * {{> waitForDetached }} - */ - async waitForDetached(locator, sec) { - this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout - sec = this.browser.options.waitForTimeout / 1000 - locator = new Locator(locator, 'css') - - return this.browser - .wait((by, locator) => window.codeceptjs.findElement(by, locator) === null, locator.type, locator.value) - .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 - }) - } - - /** - * {{> refreshPage }} - */ - async refreshPage() { - return this.browser.refresh() - } - - /** - * Reload the page - */ - refresh() { - console.log('Deprecated in favor of refreshPage') - return this.browser.refresh() - } - - /** - * {{> saveElementScreenshot }} - * - */ - async saveElementScreenshot(locator, fileName) { - const outputFile = screenshotOutputFolder(fileName) - - const rect = await this.grabElementBoundingRect(locator) - - const button_clip = { - x: Math.floor(rect.x), - y: Math.floor(rect.y), - width: Math.floor(rect.width), - height: Math.floor(rect.height), - } - - this.debug(`Screenshot of ${new Locator(locator)} element has been saved to ${outputFile}`) - // take the screenshot - await this.browser.screenshot(outputFile, button_clip) - } - - /** - * {{> grabElementBoundingRect }} - */ - async grabElementBoundingRect(locator, prop) { - locator = new Locator(locator, 'css') - - const rect = await this.browser.evaluate( - async (by, locator) => { - // store the button in a variable - - const build_cluster_btn = await window.codeceptjs.findElement(by, locator) - - // use the getClientRects() function on the button to determine - // the size and location - const rect = build_cluster_btn.getBoundingClientRect() - - // convert the rectangle to a clip object and return it - return { - x: rect.left, - y: rect.top, - width: rect.width, - height: rect.height, - } - }, - locator.type, - locator.value, - ) - - if (prop) return rect[prop] - return rect - } - - /** - * {{> saveScreenshot }} - */ - async saveScreenshot(fileName, fullPage = this.options.fullPageScreenshots) { - const outputFile = screenshotOutputFolder(fileName) - - this.debug(`Screenshot is saving to ${outputFile}`) - - if (!fullPage) { - return this.browser.screenshot(outputFile) - } - const { height, width } = await this.browser.evaluate(() => { - return { height: document.body.scrollHeight, width: document.body.scrollWidth } - }) - await this.browser.viewport(width, height) - return this.browser.screenshot(outputFile) - } - - async _failed() { - if (withinStatus !== false) await this._withinEnd() - } - - /** - * {{> scrollTo }} - */ - async scrollTo(locator, offsetX = 0, offsetY = 0) { - if (typeof locator === 'number' && typeof offsetX === 'number') { - offsetY = offsetX - offsetX = locator - locator = null - } - if (locator) { - locator = new Locator(locator, 'css') - return this.browser.evaluate( - (by, locator, offsetX, offsetY) => { - const el = window.codeceptjs.findElement(by, locator) - if (!el) throw new Error(`Element not found ${by}: ${locator}`) - const rect = el.getBoundingClientRect() - window.scrollTo(rect.left + offsetX, rect.top + offsetY) - }, - locator.type, - locator.value, - offsetX, - offsetY, - ) - } - - return this.executeScript( - function (x, y) { - return window.scrollTo(x, y) - }, - offsetX, - offsetY, - ) - } - - /** - * {{> scrollPageToTop }} - */ - async scrollPageToTop() { - return this.executeScript(() => window.scrollTo(0, 0)) - } - - /** - * {{> scrollPageToBottom }} - */ - async scrollPageToBottom() { - 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), - ) - }) - } - - /** - * {{> grabPageScrollPosition }} - */ - async grabPageScrollPosition() { - function getScrollPosition() { - return { - x: window.pageXOffset, - y: window.pageYOffset, - } - } - - return this.executeScript(getScrollPosition) - } -} - -module.exports = Nightmare - -async function proceedSee(assertType, text, context) { - let description - let locator - if (!context) { - if (this.context === this.options.rootElement) { - locator = new Locator(this.context, 'css') - description = 'web application' - } else { - description = `current context ${this.context}` - locator = new Locator({ xpath: './/*' }) - } - } else { - locator = new Locator(context, 'css') - description = `element ${locator.toString()}` - } - - const texts = await this.browser.evaluate( - (by, locator) => { - return window.codeceptjs.findElements(by, locator).map((el) => el.innerText) - }, - locator.type, - locator.value, - ) - const allText = texts.join(' | ') - return stringIncludes(description)[assertType](text, allText) -} - -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) - if (tag === 'select') { - // locate option by values and check them - const text = await this.browser.evaluate( - (el, val) => { - return el.querySelector(`option[value="${val}"]`).innerText - }, - el, - xpathLocator.literal(fieldVal), - ) - return equals(`select option by ${field}`)[assertType](value, text) - } - return stringIncludes(`field by ${field}`)[assertType](value, fieldVal) -} - -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) - }, els) - return truth(`checkable ${option}`, 'to be checked')[assertType](selected) -} - -async function findCheckable(locator, context) { - let contextEl = null - if (context) { - contextEl = await this.browser.findElement(new Locator(context, 'css').toStrict()) - } - - const matchedLocator = new Locator(locator) - if (!matchedLocator.isFuzzy()) { - return this.browser.findElements(matchedLocator.toStrict(), contextEl) - } - - const literal = xpathLocator.literal(locator) - let els = await this.browser.findElements({ xpath: Locator.checkable.byText(literal) }, contextEl) - if (els.length) { - return els - } - els = await this.browser.findElements({ xpath: Locator.checkable.byName(literal) }, contextEl) - if (els.length) { - return els - } - return this.browser.findElements({ css: locator }, contextEl) -} - -async function findClickable(locator, context) { - let contextEl = null - if (context) { - contextEl = await this.browser.findElement(new Locator(context, 'css').toStrict()) - } - - const matchedLocator = new Locator(locator) - if (!matchedLocator.isFuzzy()) { - return this.browser.findElement(matchedLocator.toStrict(), contextEl) - } - - const literal = xpathLocator.literal(locator) - - let els = await this.browser.findElements({ xpath: Locator.clickable.narrow(literal) }, contextEl) - if (els.length) { - return els[0] - } - - els = await this.browser.findElements({ xpath: Locator.clickable.wide(literal) }, contextEl) - if (els.length) { - return els[0] - } - - return this.browser.findElement({ css: locator }, contextEl) -} - -async function findField(locator) { - const matchedLocator = new Locator(locator) - if (!matchedLocator.isFuzzy()) { - return this.browser.findElements(matchedLocator.toStrict()) - } - const literal = xpathLocator.literal(locator) - - let els = await this.browser.findElements({ xpath: Locator.field.labelEquals(literal) }) - if (els.length) { - return els[0] - } - - els = await this.browser.findElements({ xpath: Locator.field.labelContains(literal) }) - if (els.length) { - return els[0] - } - els = await this.browser.findElements({ xpath: Locator.field.byName(literal) }) - if (els.length) { - return els[0] - } - return this.browser.findElement({ css: locator }) -} - -function assertElementExists(el, locator, prefix, suffix) { - if (el === null) throw new ElementNotFound(locator, prefix, suffix) -} diff --git a/lib/helper/Playwright.js b/lib/helper/Playwright.js index 774aa50a0..741d93e0b 100644 --- a/lib/helper/Playwright.js +++ b/lib/helper/Playwright.js @@ -1,18 +1,17 @@ -const path = require('path') -const fs = require('fs') - -const Helper = require('@codeceptjs/helper') -const { v4: uuidv4 } = require('uuid') -const assert = require('assert') -const promiseRetry = require('promise-retry') -const Locator = require('../locator') -const recorder = require('../recorder') -const stringIncludes = require('../assert/include').includes -const { urlEquals } = require('../assert/equal') -const { equals } = require('../assert/equal') -const { empty } = require('../assert/empty') -const { truth } = require('../assert/truth') -const { +import path from 'path' +import fs from 'fs' +import Helper from '@codeceptjs/helper' +import { v4 as uuidv4 } from 'uuid' +import assert from 'assert' +import promiseRetry from 'promise-retry' +import Locator from '../locator.js' +import recorder from '../recorder.js' +import store from '../store.js' +import { includes as stringIncludes } from '../assert/include.js' +import { urlEquals, equals } from '../assert/equal.js' +import { empty } from '../assert/empty.js' +import { truth } from '../assert/truth.js' +import { xpathLocator, ucfirst, fileExists, @@ -24,13 +23,14 @@ const { clearString, requireWithFallback, normalizeSpacesInString, -} = require('../utils') -const { isColorProperty, convertColorToRGBA } = require('../colorUtils') -const ElementNotFound = require('./errors/ElementNotFound') -const RemoteBrowserConnectionRefused = require('./errors/RemoteBrowserConnectionRefused') -const Popup = require('./extras/Popup') -const Console = require('./extras/Console') -const { findReact, findVue, findByPlaywrightLocator } = require('./extras/PlaywrightReactVueLocator') + relativeDir, +} from '../utils.js' +import { isColorProperty, convertColorToRGBA } from '../colorUtils.js' +import ElementNotFound from './errors/ElementNotFound.js' +import RemoteBrowserConnectionRefused from './errors/RemoteBrowserConnectionRefused.js' +import Popup from './extras/Popup.js' +import Console from './extras/Console.js' +import { findReact, findVue, findByPlaywrightLocator } from './extras/PlaywrightReactVueLocator.js' let playwright let perfTiming @@ -40,26 +40,10 @@ const popupStore = new Popup() const consoleLogStore = new Console() const availableBrowsers = ['chromium', 'webkit', 'firefox', 'electron'] -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') +import { setRestartStrategy, restartsSession, restartsContext, restartsBrowser } from './extras/PlaywrightRestartOpts.js' +import { createValueEngine, createDisabledEngine } from './extras/PlaywrightPropEngine.js' +import { seeElementError, dontSeeElementError, dontSeeElementInDOMError, seeElementInDOMError } from './errors/ElementAssertion.js' +import { dontSeeTraffic, seeTraffic, grabRecordedNetworkTraffics, stopRecordingTraffic, flushNetworkTraffics } from './network/actions.js' const pathSeparator = path.sep @@ -334,7 +318,7 @@ class Playwright extends Helper { constructor(config) { super(config) - playwright = requireWithFallback('playwright', 'playwright-core') + // playwright will be loaded dynamically in _init method // set defaults this.isRemoteBrowser = false @@ -358,6 +342,10 @@ class Playwright extends Helper { this.recordedWebSocketMessagesAtLeastOnce = false this.cdpSession = null + // Add test failure tracking to prevent false positives + this.testFailures = [] + this.hasCleanupError = false + // override defaults with config this._setConfig(config) } @@ -392,9 +380,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 +426,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,27 +442,44 @@ 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', }, ] } static _checkRequirements() { try { - requireWithFallback('playwright', 'playwright-core') + // In ESM, playwright will be checked via dynamic import in constructor + // The import will fail at module load time if playwright is missing + return null } catch (e) { return ['playwright@^1.18'] } } async _init() { + // Load playwright dynamically with fallback + if (!playwright) { + try { + playwright = await import('playwright') + playwright = playwright.default || playwright + } catch (e) { + try { + playwright = await import('playwright-core') + playwright = playwright.default || playwright + } catch (e2) { + throw new Error('Neither playwright nor playwright-core could be loaded. Please install one of them.') + } + } + } + // register an internal selector engine for reading value property of elements in a selector if (defaultSelectorEnginesInitialized) return defaultSelectorEnginesInitialized = true @@ -500,9 +501,14 @@ class Playwright extends Helper { async _before(test) { this.currentRunningTest = test + + // Reset failure tracking for each test to prevent false positives + this.hasCleanupError = false + this.testFailures = [] + 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 +546,25 @@ 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()) { + if (!this.browser) { + if (this.options.manualStart) { + this.debugSection('Manual Start', 'Browser not started - skipping context creation') + return // Skip context creation when manualStart is true + } else { + throw new Error('Browser not started. This should not happen.') + } + } + 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 +578,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 +589,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 @@ -582,8 +607,12 @@ class Playwright extends Helper { if (!this.isRunning) return if (this.isElectron) { - this.browser.close() - this.electronSessions.forEach((session) => session.close()) + try { + this.browser.close() + this.electronSessions.forEach(session => session.close()) + } catch (e) { + console.warn('Warning during electron cleanup:', e.message) + } return } @@ -596,29 +625,140 @@ class Playwright extends Helper { return this._stopBrowser() } - // close other sessions + // close other sessions with timeout protection try { - if ((await this.browser)._type === 'Browser') { - const contexts = await this.browser.contexts() + if ((await this.browser)?._type === 'Browser') { + const contexts = await Promise.race([ + this.browser.contexts(), + new Promise((_, reject) => setTimeout(() => reject(new Error('Get contexts timeout')), 3000)) + ]) const currentContext = contexts[0] if (currentContext && (this.options.keepCookies || this.options.keepBrowserState)) { - this.storageState = await currentContext.storageState() + try { + this.storageState = await currentContext.storageState() + } catch (e) { + console.warn('Warning during storage state save:', e.message) + } } - await Promise.all(contexts.map((c) => c.close())) + await Promise.race([ + Promise.all(contexts.map(c => c.close())), + new Promise((_, reject) => setTimeout(() => reject(new Error('Close contexts timeout')), 5000)) + ]) } } catch (e) { - console.log(e) + console.warn('Warning during context cleanup in _after:', e.message) } - // await this.closeOtherTabs(); return this.browser } - _afterSuite() {} + async _afterSuite() { + // Ensure proper browser cleanup after test suite + if (this.isRunning) { + try { + await Promise.race([ + this._stopBrowser(), + new Promise((_, reject) => setTimeout(() => reject(new Error('Browser stop timeout')), 15000)) + ]) + } catch (e) { + console.warn('Warning during suite cleanup:', e.message) + // Track suite cleanup failures + this.hasCleanupError = true + this.testFailures.push(`Suite cleanup failed: ${e.message}`) + } finally { + this.isRunning = false + } + } + + // Force cleanup of any remaining browser processes + try { + if (this.browser && (!this.browser.isConnected || this.browser)) { + await Promise.race([ + Promise.resolve(), + new Promise(resolve => setTimeout(resolve, 1000)) + ]) + } + } catch (e) { + console.warn('Final cleanup warning:', e.message) + this.hasCleanupError = true + this.testFailures.push(`Final cleanup failed: ${e.message}`) + } + + // Clean up session pages explicitly to prevent hanging references + try { + if (this.sessionPages && Object.keys(this.sessionPages).length > 0) { + for (const sessionName in this.sessionPages) { + const sessionPage = this.sessionPages[sessionName] + if (sessionPage && !sessionPage.isClosed()) { + try { + // Remove any remaining event listeners from session pages + sessionPage.removeAllListeners('dialog') + sessionPage.removeAllListeners('crash') + sessionPage.removeAllListeners('close') + sessionPage.removeAllListeners('error') + await sessionPage.close() + } catch (e) { + console.warn(`Warning closing session page ${sessionName}:`, e.message) + } + } + } + this.sessionPages = {} // Clear the session pages object + this.activeSessionName = '' // Reset active session name + } + } catch (e) { + console.warn('Session pages cleanup warning:', e.message) + this.hasCleanupError = true + this.testFailures.push(`Session cleanup failed: ${e.message}`) + } + + // Clear any lingering DOM timeouts by executing cleanup in browser context + try { + if (this.page && !this.page.isClosed()) { + await this.page.evaluate(() => { + // Clear any running highlight timeouts by clearing a range of timeout IDs + for (let i = 1; i <= 1000; i++) { + clearTimeout(i) + } + }) + } + } catch (e) { + console.warn('DOM timeout cleanup warning:', e.message) + this.hasCleanupError = true + this.testFailures.push(`DOM cleanup failed: ${e.message}`) + } + + // If we have cleanup errors, throw to fail the test suite + if (this.hasCleanupError && this.testFailures.length > 0) { + const errorMessage = `Test suite cleanup failed: ${this.testFailures.join('; ')}` + console.error(errorMessage) + throw new Error(errorMessage) + } + } async _finishTest() { - if ((restartsSession() || restartsContext()) && this.isRunning) return this._stopBrowser() + if ((restartsSession() || restartsContext()) && this.isRunning) { + try { + await Promise.race([ + this._stopBrowser(), + new Promise((_, reject) => setTimeout(() => reject(new Error('Test finish timeout')), 10000)) + ]) + } catch (e) { + console.warn('Warning during test finish cleanup:', e.message) + // Track cleanup failures to prevent false positives + this.hasCleanupError = true + this.testFailures.push(`Test finish cleanup failed: ${e.message}`) + + this.isRunning = false + // Set flags to prevent further operations after cleanup failure + this.page = null + this.browserContext = null + this.browser = null + + // Propagate the error to fail the test properly + throw new Error(`Test cleanup failed: ${e.message}`) + } + } } _session() { @@ -637,16 +777,26 @@ class Playwright extends Helper { page = await browser.firstWindow() } else { try { - browserContext = await this.browser.newContext(Object.assign(this.contextOptions, config)) - page = await browserContext.newPage() + // Check if browser is still available before creating context + if (!this.browser) { + throw new Error('Browser is not available for session context creation') + } + browserContext = await Promise.race([ + this.browser.newContext(Object.assign(this.contextOptions, config)), + new Promise((_, reject) => setTimeout(() => reject(new Error('New context timeout')), 10000)) + ]) + page = await Promise.race([ + browserContext.newPage(), + new Promise((_, reject) => setTimeout(() => reject(new Error('New page timeout')), 5000)) + ]) } catch (e) { + console.warn('Warning during context creation:', e.message) 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] + } else { + throw e } } } @@ -660,7 +810,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 +818,7 @@ class Playwright extends Helper { return this._setPage(this.sessionPages[this.activeSessionName]) } }, - restoreVars: async (session) => { + restoreVars: async session => { this.withinLocator = null this.browserContext = defaultContext @@ -677,8 +827,24 @@ class Playwright extends Helper { } else { this.activeSessionName = session } - const existingPages = await this.browserContext.pages() - await this._setPage(existingPages[0]) + + // Safety check: ensure browserContext exists before calling pages() + if (!this.browserContext) { + this.debug('Cannot restore session vars: browserContext is undefined') + return + } + + try { + const existingPages = await this.browserContext.pages() + if (existingPages && existingPages.length > 0) { + await this._setPage(existingPages[0]) + } else { + this.debug('Cannot restore session vars: no pages available') + } + } catch (err) { + this.debug(`Failed to restore session vars: ${err.message}`) + return + } return this._waitForAction() }, @@ -764,21 +930,43 @@ class Playwright extends Helper { * @param {object} page page to set */ async _setPage(page) { + // Clean up previous page event listeners + if (this.page && this.page !== page) { + try { + this.page.removeAllListeners('crash') + this.page.removeAllListeners('dialog') + } catch (e) { + console.warn('Warning cleaning previous page listeners:', e.message) + } + } + page = await page this._addPopupListener(page) this.page = page if (!page) return - this.browserContext.setDefaultTimeout(0) - page.setDefaultNavigationTimeout(this.options.getPageTimeout) - page.setDefaultTimeout(this.options.timeout) + + try { + this.browserContext.setDefaultTimeout(0) + page.setDefaultNavigationTimeout(this.options.getPageTimeout) + page.setDefaultTimeout(this.options.timeout) - page.on('crash', async () => { - console.log('ERROR: Page has crashed, closing page!') - await page.close() - }) - this.context = await this.page - this.contextLocator = null - await page.bringToFront() + page.on('crash', async () => { + console.log('ERROR: Page has crashed, closing page!') + try { + await page.close() + } catch (e) { + console.warn('Warning during crashed page cleanup:', e.message) + } + }) + + this.context = await this.page + this.contextLocator = null + await page.bringToFront() + } catch (e) { + console.warn('Warning during page setup:', e.message) + this.context = await this.page + this.contextLocator = null + } } /** @@ -793,7 +981,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 +1044,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()) }) @@ -879,6 +1064,9 @@ class Playwright extends Helper { * @param {object} [contextOptions] See https://playwright.dev/docs/api/class-browser#browser-new-context */ async _createContextPage(contextOptions) { + if (!this.browser) { + throw new Error('Browser not started. Call _startBrowser() first or disable manualStart option.') + } this.browserContext = await this.browser.newContext(contextOptions) const page = await this.browserContext.newPage() targetCreatedHandler.call(this, page) @@ -895,8 +1083,55 @@ class Playwright extends Helper { this.context = null this.frame = null popupStore.clear() - if (this.options.recordHar) await this.browserContext.close() - await this.browser.close() + + // Clean up event listeners to prevent hanging + try { + if (this.browser) { + this.browser.removeAllListeners('targetchanged') + if (this.browserContext) { + // Clean up any page event listeners in the context + const pages = this.browserContext.pages() + for (const page of pages) { + try { + page.removeAllListeners('crash') + page.removeAllListeners('dialog') + } catch (e) { + console.warn('Warning cleaning page listeners:', e.message) + } + } + } + } + } catch (e) { + console.warn('Warning cleaning event listeners:', e.message) + } + + try { + if (this.options.recordHar && this.browserContext) { + await Promise.race([ + this.browserContext.close(), + new Promise((_, reject) => setTimeout(() => reject(new Error('Context close timeout')), 5000)) + ]) + } + } catch (error) { + console.warn('Failed to close browser context:', error.message) + } + + try { + if (this.browser) { + await Promise.race([ + this.browser.close(), + new Promise((_, reject) => setTimeout(() => reject(new Error('Browser close timeout')), 10000)) + ]) + } + } catch (error) { + console.warn('Failed to close browser:', error.message) + } + + // Ensure cleanup is complete + this.browser = null + this.browserContext = null + this.page = null + this.isRunning = false } async _evaluateHandeInContext(...args) { @@ -940,7 +1175,7 @@ class Playwright extends Helper { const navigationStart = timing.navigationStart const extractedData = {} - dataNames.forEach((name) => { + dataNames.forEach(name => { extractedData[name] = timing[name] - navigationStart }) @@ -954,8 +1189,15 @@ class Playwright extends Helper { if (this.isElectron) { throw new Error('Cannot open pages inside an Electron container') } + + // Prevent navigation attempts when browser is being torn down + if (!this.isRunning && (!this.browser || !this.browserContext || !this.page)) { + throw new Error('Cannot navigate: browser is not running or has been closed') + } + 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) { @@ -965,17 +1207,82 @@ class Playwright extends Helper { } } - await this.page.goto(url, { waitUntil: this.options.waitForNavigation }) + // Ensure browser is initialized before page operations + if (!this.page) { + this.debugSection('Auto-initializing', `Browser not started properly. page=${!!this.page}, isRunning=${this.isRunning}, browser=${!!this.browser}, browserContext=${!!this.browserContext}`) + + if (!this.browser) { + await this._startBrowser() + } + + // Create browser context and page (simplified version of _before logic) + if (!this.browserContext) { + if (!this.browser) { + throw new Error('Browser is not available for context creation. Browser may have been closed.') + } + const contextOptions = { + ignoreHTTPSErrors: this.options.ignoreHTTPSErrors, + acceptDownloads: true, + ...this.options.emulate, + } + this.browserContext = await this.browser.newContext(contextOptions) + } + + let pages + let mainPage + try { + pages = await this.browserContext.pages() + mainPage = pages[0] || (await this.browserContext.newPage()) + } catch (e) { + if (e.message.includes('Target page, context or browser has been closed') || + e.message.includes('Browser has been closed')) { + throw new Error('Cannot create page: browser context has been closed') + } + throw e + } + await this._setPage(mainPage) + + this.debugSection('Auto-initializing', `Completed. page=${!!this.page}, browserContext=${!!this.browserContext}`) + } + + // Additional safety check + if (!this.page) { + throw new Error(`Page is not initialized after auto-initialization. this.page=${this.page}, this.isRunning=${this.isRunning}, this.browser=${!!this.browser}, this.browserContext=${!!this.browserContext}`) + } + + try { + // Additional validation before navigation + if (this.page && this.page.isClosed && this.page.isClosed()) { + throw new Error('Cannot navigate: page has been closed') + } + + if (this.browserContext) { + // Try to check if context is still valid + try { + await Promise.race([ + this.browserContext.pages(), + new Promise((_, reject) => setTimeout(() => reject(new Error('Context check timeout')), 1000)) + ]) + } catch (contextError) { + throw new Error('Cannot navigate: browser context is invalid or closed') + } + } + + await this.page.goto(url, { waitUntil: this.options.waitForNavigation }) + } catch (err) { + // Handle terminal navigation errors that shouldn't be retried + if (err.message && (err.message.includes('ERR_ABORTED') || err.message.includes('frame was detached') || err.message.includes('Target page, context or browser has been closed') || err.message.includes('Cannot navigate'))) { + // Mark this as a terminal error to prevent retries + const terminalError = new Error(err.message) + terminalError.isTerminal = true + throw terminalError + } + throw err + } 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 +1504,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 +1591,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 +1756,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 +1802,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 +1816,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 +1830,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 +1842,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 +1866,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 +2060,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 +2172,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 +2283,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 +2293,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 +2312,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 +2320,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)) } /** @@ -2014,19 +2329,32 @@ class Playwright extends Helper { * {{> grabCookie }} */ async grabCookie(name) { - const cookies = await this.browserContext.cookies() - if (!name) return cookies - const cookie = cookies.filter((c) => c.name === name) - if (cookie[0]) return cookie[0] + if (!this.browserContext) { + throw new Error('Browser context is not available for grabCookie') + } + + try { + const cookies = await this.browserContext.cookies() + if (!name) return cookies + const cookie = cookies.filter(c => c.name === name) + if (cookie[0]) return cookie[0] + } catch (err) { + if (err.message.includes('Target page, context or browser has been closed') || + err.message.includes('Browser has been closed')) { + throw new Error('Cannot grab cookies: browser context has been closed') + } + throw err + } } /** * {{> 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() } @@ -2120,7 +2448,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 +2467,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 +2488,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 +2516,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 +2538,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 +2556,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) } /** @@ -2297,11 +2615,16 @@ class Playwright extends Helper { async saveElementScreenshot(locator, fileName) { const outputFile = screenshotOutputFolder(fileName) - const res = await this._locateElement(locator) - assertElementExists(res, locator) - const elem = res - this.debug(`Screenshot of ${new Locator(locator)} element has been saved to ${outputFile}`) - return elem.screenshot({ path: outputFile, type: 'png' }) + try { + const res = await this._locateElement(locator) + assertElementExists(res, locator) + const elem = res + this.debug(`Screenshot of ${new Locator(locator)} element has been saved to ${outputFile}`) + return elem.screenshot({ path: outputFile, type: 'png' }) + } catch (err) { + this.debug(`Failed to take element screenshot: ${err.message}`) + throw err + } } /** @@ -2311,27 +2634,98 @@ 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, - fullPage: fullPageOption, - type: 'png', - }) + // Multiple layers of checking before attempting screenshot + if (!this.page) { + this.debug('Cannot take screenshot: page object is undefined') + return + } - if (this.activeSessionName) { + if (!this.browser) { + this.debug('Cannot take screenshot: browser object is undefined') + return + } + + if (!this.browserContext) { + this.debug('Cannot take screenshot: browser context is undefined') + return + } + + try { + // Check if page is still accessible before taking screenshot + if (this.page.isClosed && this.page.isClosed()) { + this.debug('Cannot take screenshot: page is closed') + return + } + + // Additional check - try to access page properties to ensure it's alive + await Promise.race([ + this.page.url(), + new Promise((_, reject) => setTimeout(() => reject(new Error('Page URL check timeout')), 1000)) + ]) + + // Take screenshot with timeout protection + await Promise.race([ + this.page.screenshot({ + path: outputFile, + fullPage: fullPageOption, + type: 'png', + }), + new Promise((_, reject) => setTimeout(() => reject(new Error('Screenshot timeout')), 5000)) + ]) + } catch (err) { + this.debug(`Failed to take screenshot: ${err.message}`) + + // Track screenshot failures that could affect test results + this.hasCleanupError = true + this.testFailures.push(`Screenshot failed: ${err.message}`) + + if (err.message.includes('Target page, context or browser has been closed') || + err.message.includes('Page has been closed') || + err.message.includes('Browser has been closed') || + err.message.includes('Protocol error') || + err.message.includes('Connection closed') || + err.message.includes('timeout')) { + this.debug('Screenshot failed due to browser/page closure or timeout, continuing...') + return + } + throw err + } + + // Handle session screenshots for ALL sessions, not just active one + if (this.sessionPages && Object.keys(this.sessionPages).length > 0) { for (const sessionName in this.sessionPages) { - const activeSessionPage = this.sessionPages[sessionName] + const sessionPage = 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({ - path: outputFile, - fullPage: fullPageOption, - type: 'png', - }) + try { + // Add timeout protection for session screenshots + await Promise.race([ + (async () => { + if (sessionPage && !sessionPage.isClosed()) { + await sessionPage.screenshot({ + path: outputFile, + fullPage: fullPageOption, + type: 'png', + }) + } else { + this.debug(`Cannot take session screenshot: session page for '${sessionName}' is closed or undefined`) + } + })(), + new Promise((_, reject) => setTimeout(() => reject(new Error('Session screenshot timeout')), 3000)) + ]) + } catch (err) { + this.debug(`Failed to take session screenshot for '${sessionName}': ${err.message}`) + + // Track session screenshot failures + this.hasCleanupError = true + this.testFailures.push(`Session screenshot failed for '${sessionName}': ${err.message}`) + + // Don't throw here - main screenshot was successful and we don't want to hang + // Just log and continue } } } @@ -2358,9 +2752,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 +2789,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 +2797,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 +2811,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 +2827,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 +2844,7 @@ class Playwright extends Helper { * {{> wait }} */ async wait(sec) { - return new Promise((done) => { + return new Promise(done => { setTimeout(done, sec * 1000) }) } @@ -2480,20 +2860,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 +2886,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 +2912,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 +2946,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 +2967,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 +2983,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 +3075,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 +3102,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 +3116,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 +3146,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 +3169,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 +3193,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 }, + ), + ]) } /** @@ -2902,8 +3270,16 @@ class Playwright extends Helper { } if (locator >= 0 && locator < childFrames.length) { - this.context = await this.page.frameLocator('iframe').nth(locator) - this.contextLocator = locator + try { + this.context = await Promise.race([ + this.page.frameLocator('iframe').nth(locator), + new Promise((_, reject) => setTimeout(() => reject(new Error('Frame locator timeout')), 5000)) + ]) + this.contextLocator = locator + } catch (e) { + console.warn('Warning during frame selection:', e.message) + throw new Error('Element #invalidIframeSelector was not found by text|CSS|XPath') + } } else { throw new Error('Element #invalidIframeSelector was not found by text|CSS|XPath') } @@ -2919,16 +3295,37 @@ class Playwright extends Helper { // iframe by selector locator = buildLocatorString(new Locator(locator, 'css')) - const frame = await this._locateElement(locator) + + let frame + try { + frame = await Promise.race([ + this._locateElement(locator), + new Promise((_, reject) => setTimeout(() => reject(new Error('Locate frame timeout')), 5000)) + ]) + } catch (e) { + console.warn('Warning during frame location:', e.message) + frame = null + } if (!frame) { throw new Error(`Frame ${JSON.stringify(locator)} was not found by text|CSS|XPath`) } - if (this.frame) { - this.frame = await this.frame.frameLocator(locator) - } else { - this.frame = await this.page.frameLocator(locator) + try { + if (this.frame) { + this.frame = await Promise.race([ + this.frame.frameLocator(locator), + new Promise((_, reject) => setTimeout(() => reject(new Error('Child frame locator timeout')), 5000)) + ]) + } else { + this.frame = await Promise.race([ + this.page.frameLocator(locator), + new Promise((_, reject) => setTimeout(() => reject(new Error('Page frame locator timeout')), 5000)) + ]) + } + } catch (e) { + console.warn('Warning during frame locator creation:', e.message) + throw new Error(`Frame ${JSON.stringify(locator)} could not be accessed`) } const contentFrame = this.frame @@ -2937,8 +3334,14 @@ class Playwright extends Helper { this.context = contentFrame this.contextLocator = null } else { - this.context = this.page.frame(this.page.frames()[1].name()) - this.contextLocator = locator + try { + this.context = this.page.frame(this.page.frames()[1].name()) + this.contextLocator = locator + } catch (e) { + console.warn('Warning during frame context setup:', e.message) + this.context = this.page + this.contextLocator = null + } } } @@ -3021,11 +3424,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 +3450,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 +3531,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 +3570,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 +3612,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 +3659,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 +3712,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 +3744,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 @@ -3441,7 +3839,7 @@ class Playwright extends Helper { } } -module.exports = Playwright +export default Playwright function buildLocatorString(locator) { if (locator.isCustom()) { @@ -3493,17 +3891,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 +3959,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 +4000,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 +4032,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 +4049,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 +4136,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 +4174,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) }) @@ -3884,36 +4279,73 @@ async function clickablePoint(el) { } async function refreshContextSession() { - // close other sessions + // close other sessions with timeout protection, but preserve active session contexts try { - const contexts = await this.browser.contexts() - contexts.shift() - - await Promise.all(contexts.map((c) => c.close())) + const contexts = await Promise.race([ + this.browser.contexts(), + new Promise((_, reject) => setTimeout(() => reject(new Error('Get contexts timeout')), 3000)) + ]) + + // Keep the first context (default) and any contexts that belong to active sessions + const defaultContext = contexts.shift() + const activeSessionContexts = new Set() + + // Identify contexts that are still in use by active sessions + if (this.sessionPages) { + for (const sessionName in this.sessionPages) { + const sessionPage = this.sessionPages[sessionName] + if (sessionPage && sessionPage.context) { + activeSessionContexts.add(sessionPage.context) + } + } + } + + // Only close contexts that are not in use by active sessions + const contextsToClose = contexts.filter(context => !activeSessionContexts.has(context)) + + if (contextsToClose.length > 0) { + await Promise.race([ + Promise.all(contextsToClose.map(c => c.close())), + new Promise((_, reject) => setTimeout(() => reject(new Error('Close contexts timeout')), 5000)) + ]) + } } catch (e) { - console.log(e) + console.warn('Warning during context cleanup:', e.message) } if (this.page) { - const existingPages = await this.browserContext.pages() - await this._setPage(existingPages[0]) + try { + const existingPages = await this.browserContext.pages() + await this._setPage(existingPages[0]) + } catch (e) { + console.warn('Warning during page setup:', e.message) + } } if (this.options.keepBrowserState) return if (!this.options.keepCookies) { this.debugSection('Session', 'cleaning cookies and localStorage') - await this.clearCookie() + try { + await this.clearCookie() + } catch (e) { + console.warn('Warning during cookie cleanup:', e.message) + } } - const currentUrl = await this.grabCurrentUrl() + + try { + const currentUrl = await this.grabCurrentUrl() - if (currentUrl.startsWith('http')) { - 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) => { - if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err - }) + if (currentUrl.startsWith('http')) { + 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 => { + if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err + }) + } + } catch (e) { + console.warn('Warning during storage cleanup:', e.message) } } @@ -3941,11 +4373,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 deleted file mode 100644 index 0fab33d11..000000000 --- a/lib/helper/Protractor.js +++ /dev/null @@ -1,1863 +0,0 @@ -let EC -let Key -let Button -let ProtractorBy -let ProtractorExpectedConditions - -const path = require('path') - -const Helper = require('@codeceptjs/helper') -const stringIncludes = require('../assert/include').includes -const { urlEquals, equals } = require('../assert/equal') -const { empty } = require('../assert/empty') -const { truth } = require('../assert/truth') -const { xpathLocator, fileExists, convertCssPropertiesToCamelCase, screenshotOutputFolder } = require('../utils') -const { isColorProperty, convertColorToRGBA } = require('../colorUtils') -const ElementNotFound = require('./errors/ElementNotFound') -const ConnectionRefused = require('./errors/ConnectionRefused') -const Locator = require('../locator') - -let withinStore = {} -let Runner - -/** - * Protractor helper is based on [Protractor library](http://www.protractortest.org) and used for testing web applications. - * - * Protractor requires [Selenium Server and ChromeDriver/GeckoDriver to be installed](http://codecept.io/quickstart/#prepare-selenium-server). - * To test non-Angular applications please make sure you have `angular: false` in configuration file. - * - * ### Configuration - * - * This helper should be configured in codecept.conf.ts or codecept.conf.js - * - * * `url` - base url of website to be tested - * * `browser` - browser in which perform testing - * * `angular` (optional, default: true): disable this option to run tests for non-Angular applications. - * * `driver` - which protractor driver to use (local, direct, session, hosted, sauce, browserstack). By default set to 'hosted' which requires selenium server to be started. - * * `restart` (optional, default: true) - restart browser between tests. - * * `smartWait`: (optional) **enables [SmartWait](http://codecept.io/acceptance/#smartwait)**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000 - * * `disableScreenshots` (optional, default: false) - don't save screenshot on failure - * * `fullPageScreenshots` (optional, default: false) - make full page screenshots on failure. - * * `uniqueScreenshotNames` (optional, default: false) - option to prevent screenshot override if you have scenarios with the same name in different suites - * * `keepBrowserState` (optional, default: false) - keep browser state between tests when `restart` set to false. - * * `seleniumAddress` - Selenium address to connect (default: http://localhost:4444/wd/hub) - * * `rootElement` - Root element of AngularJS application (default: body) - * * `getPageTimeout` (optional) sets default timeout for a page to be loaded. 10000 by default. - * * `waitForTimeout`: (optional) sets default wait time in _ms_ for all `wait*` functions. 1000 by default. - * * `scriptsTimeout`: (optional) timeout in milliseconds for each script run on the browser, 10000 by default. - * * `windowSize`: (optional) default window size. Set to `maximize` or a dimension in the format `640x480`. - * * `manualStart` (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers.WebDriver._startBrowser()` - * * `capabilities`: {} - list of [Desired Capabilities](https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities) - * * `proxy`: set proxy settings - * - * other options are the same as in [Protractor config](https://github.com/angular/protractor/blob/master/docs/referenceConf.js). - * - * #### Sample Config - * - * ```json - * { - * "helpers": { - * "Protractor" : { - * "url": "http://localhost", - * "browser": "chrome", - * "smartWait": 5000, - * "restart": false - * } - * } - * } - * ``` - * - * #### Config for Non-Angular application: - * - * ```json - * { - * "helpers": { - * "Protractor" : { - * "url": "http://localhost", - * "browser": "chrome", - * "angular": false - * } - * } - * } - * ``` - * - * #### Config for Headless Chrome - * - * ```json - * { - * "helpers": { - * "Protractor" : { - * "url": "http://localhost", - * "browser": "chrome", - * "capabilities": { - * "chromeOptions": { - * "args": [ "--headless", "--disable-gpu", "--no-sandbox" ] - * } - * } - * } - * } - * } - * ``` - * - * ## Access From Helpers - * - * Receive a WebDriverIO client from a custom helper by accessing `browser` property: - * - * ```js - * this.helpers['Protractor'].browser - * ``` - * - * ## Methods - */ -class Protractor extends Helper { - constructor(config) { - // process.env.SELENIUM_PROMISE_MANAGER = false; // eslint-disable-line - super(config) - - 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', - ) - } - - _validateConfig(config) { - const defaults = { - browser: 'chrome', - url: 'http://localhost', - seleniumAddress: 'http://localhost:4444/wd/hub', - fullPageScreenshots: false, - rootElement: 'body', - allScriptsTimeout: 10000, - scriptTimeout: 10000, - waitForTimeout: 1000, // ms - windowSize: null, - getPageTimeout: 10000, - driver: 'hosted', - capabilities: {}, - angular: true, - restart: true, - } - - config = Object.assign(defaults, config) - - if (!config.allScriptsTimeout) config.allScriptsTimeout = config.scriptsTimeout - if (!config.scriptTimeout) config.scriptTimeout = config.scriptsTimeout - if (config.proxy) config.capabilities.proxy = config.proxy - if (config.browser) config.capabilities.browserName = config.browser - - config.waitForTimeoutInSeconds = config.waitForTimeout / 1000 // convert to seconds - return config - } - - async _init() { - process.on('unhandledRejection', (reason) => { - if (reason.message.indexOf('ECONNREFUSED') > 0) { - this.browser = null - } - }) - - Runner = require('protractor/built/runner').Runner - ProtractorBy = require('protractor').ProtractorBy - Key = require('protractor').Key - Button = require('protractor').Button - ProtractorExpectedConditions = require('protractor').ProtractorExpectedConditions - - return Promise.resolve() - } - - static _checkRequirements() { - try { - require('protractor') - require('assert').ok(require('protractor/built/runner').Runner) - } catch (e) { - return ['protractor@^5.3.0'] - } - } - - static _config() { - return [ - { name: 'url', message: 'Base url of site to be tested', default: 'http://localhost' }, - { - name: 'driver', - message: 'Protractor driver (local, direct, session, hosted, sauce, browserstack)', - default: 'hosted', - }, - { name: 'browser', message: 'Browser in which testing will be performed', default: 'chrome' }, - { name: 'rootElement', message: 'Root element of AngularJS application', default: 'body' }, - { - name: 'angular', - message: 'Enable AngularJS synchronization', - default: false, - type: 'confirm', - }, - ] - } - - async _beforeStep() { - if (!this.insideAngular) { - return this.amOutsideAngularApp() - } - } - - async _beforeSuite() { - if (!this.options.restart && !this.options.manualStart && !this.isRunning) { - this.debugSection('Session', 'Starting singleton browser session') - return this._startBrowser() - } - } - - async _startBrowser() { - try { - const runner = new Runner(this.options) - this.browser = runner.createBrowser() - await this.browser.ready - } catch (err) { - if (err.toString().indexOf('ECONNREFUSED')) { - throw new ConnectionRefused(err) - } - throw err - } - if (this.options.angular) { - await this.amInsideAngularApp() - } else { - await this.amOutsideAngularApp() - } - - loadGlobals(this.browser) - - if (this.options.windowSize === 'maximize') { - await this.resizeWindow(this.options.windowSize) - } else if (this.options.windowSize) { - const size = this.options.windowSize.split('x') - await this.resizeWindow(parseInt(size[0], 10), parseInt(size[1], 10)) - } - this.context = this.options.rootElement - this.isRunning = true - return this.browser.ready - } - - async _before() { - if (this.options.restart && !this.options.manualStart) return this._startBrowser() - if (!this.isRunning && !this.options.manualStart) return this._startBrowser() - } - - async _after() { - if (!this.browser) return - if (!this.isRunning) return - if (this.options.restart) { - this.isRunning = false - return this.browser.quit() - } - if (this.options.keepBrowserState) return - - const dialog = await this.grabPopupText() - if (dialog) { - await this.cancelPopup() - } - if (!this.options.keepCookies) { - await this.browser.manage().deleteAllCookies() - } - let url - try { - url = await this.browser.getCurrentUrl() - } catch (err) { - // Ignore, as above will throw if no webpage has been loaded - } - if (url && !/data:,/i.test(url)) { - await this.browser.executeScript('localStorage.clear();') - } - return this.closeOtherTabs() - } - - async _failed() { - await this._withinEnd() - } - - async _finishTest() { - if (!this.options.restart && this.isRunning) return this.browser.quit() - } - - async _withinBegin(locator) { - withinStore.elFn = this.browser.findElement - withinStore.elsFn = this.browser.findElements - - const frame = isFrameLocator(locator) - - 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()), - ) - } - withinStore.frame = frame - return this.switchTo(locator) - } - - this.context = locator - 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() - return context - } - - async _withinEnd() { - if (!isWithin()) return - if (withinStore.frame) { - withinStore = {} - return this.switchTo(null) - } - this.browser.findElement = withinStore.elFn - this.browser.findElements = withinStore.elsFn - withinStore = {} - this.context = this.options.rootElement - } - - _session() { - const defaultSession = this.browser - return { - start: async (opts) => { - opts = this._validateConfig(Object.assign(this.options, opts)) - this.debugSection('New Browser', JSON.stringify(opts)) - const runner = new Runner(opts) - const res = await this.browser.executeScript('return [window.outerWidth, window.outerHeight]') - const browser = runner.createBrowser(null, this.browser) - await browser.ready - await browser.waitForAngularEnabled(this.insideAngular) - await browser.manage().window().setSize(parseInt(res[0], 10), parseInt(res[1], 10)) - return browser.ready - }, - stop: async (browser) => { - return browser.close() - }, - loadVars: async (browser) => { - if (isWithin()) throw new Error("Can't start session inside within block") - this.browser = browser - loadGlobals(this.browser) - }, - restoreVars: async () => { - if (isWithin()) await this._withinEnd() - this.browser = defaultSession - loadGlobals(this.browser) - }, - } - } - - /** - * Use [Protractor](https://www.protractortest.org/#/api) API inside a test. - * - * First argument is a description of an action. - * Second argument is async function that gets this helper as parameter. - * - * { [`browser`](https://www.protractortest.org/#/api?view=ProtractorBrowser)) } object from Protractor API is available. - * - * ```js - * I.useProtractorTo('change url via in-page navigation', async ({ browser }) { - * await browser.setLocation('api'); - * }); - * ``` - * - * @param {string} description used to show in logs. - * @param {function} fn async functuion that executed with Protractor helper as argument - */ - useProtractorTo(description, fn) { - return this._useTo(...arguments) - } - - /** - * Switch to non-Angular mode, - * start using WebDriver instead of Protractor in this session - */ - async amOutsideAngularApp() { - if (!this.browser) return - await this.browser.waitForAngularEnabled(false) - return Promise.resolve((this.insideAngular = false)) - } - - /** - * Enters Angular mode (switched on by default) - * Should be used after "amOutsideAngularApp" - */ - async amInsideAngularApp() { - await this.browser.waitForAngularEnabled(true) - return Promise.resolve((this.insideAngular = true)) - } - - /** - * Get elements by different locator types, including strict locator - * Should be used in custom helpers: - * - * ```js - * this.helpers['Protractor']._locate({name: 'password'}).then //... - * ``` - * To use SmartWait and wait for element to appear on a page, add `true` as second arg: - * - * ```js - * this.helpers['Protractor']._locate({name: 'password'}, true).then //... - * ``` - * - */ - async _locate(locator, smartWait = false) { - return this._smartWait(() => this.browser.findElements(guessLocator(locator) || global.by.css(locator)), smartWait) - } - - async _smartWait(fn, enabled = true) { - if (!this.options.smartWait || !enabled) return fn() - await this.browser.manage().timeouts().implicitlyWait(this.options.smartWait) - const res = await fn() - await this.browser.manage().timeouts().implicitlyWait(0) - return res - } - - /** - * Find a checkbox by providing human readable text: - * - * ```js - * this.helpers['Protractor']._locateCheckable('I agree with terms and conditions').then // ... - * ``` - */ - async _locateCheckable(locator) { - return findCheckable.call(this, this.browser, locator) - } - - /** - * Find a clickable element by providing human readable text: - * - * ```js - * this.helpers['Protractor']._locateClickable('Next page').then // ... - * ``` - */ - async _locateClickable(locator) { - return findClickable.call(this, this.browser, locator) - } - - /** - * Find field elements by providing human readable text: - * - * ```js - * this.helpers['Protractor']._locateFields('Your email').then // ... - * ``` - */ - async _locateFields(locator) { - return findFields.call(this, this.browser, locator) - } - - /** - * {{> amOnPage }} - */ - async amOnPage(url) { - if (!/^\w+\:\/\//.test(url)) { - url = this.options.url + url - } - const res = await this.browser.get(url) - this.debug(`Visited ${url}`) - return res - } - - /** - * {{> click }} - */ - async click(locator, context = null) { - let matcher = this.browser - if (context) { - const els = await this._locate(context, true) - assertElementExists(els, context) - matcher = els[0] - } - const el = await findClickable.call(this, matcher, locator) - return el.click() - } - - /** - * {{> doubleClick }} - */ - async doubleClick(locator, context = null) { - let matcher = this.browser - if (context) { - const els = await this._locate(context, true) - assertElementExists(els, context) - matcher = els[0] - } - const el = await findClickable.call(this, matcher, locator) - return this.browser.actions().doubleClick(el).perform() - } - - /** - * {{> rightClick }} - */ - async rightClick(locator, context = null) { - /** - * just press button if no selector is given - */ - if (locator === undefined) { - return this.browser.actions().click(Button.RIGHT).perform() - } - let matcher = this.browser - if (context) { - const els = await this._locate(context, true) - assertElementExists(els, context) - matcher = els[0] - } - const el = await findClickable.call(this, matcher, locator) - - await this.browser.actions().mouseMove(el).perform() - return this.browser.actions().click(Button.RIGHT).perform() - } - - /** - * {{> moveCursorTo }} - */ - async moveCursorTo(locator, offsetX = null, offsetY = null) { - let offset = null - if (offsetX !== null || offsetY !== null) { - offset = { x: offsetX, y: offsetY } - } - const els = await this._locate(locator, true) - assertElementExists(els, locator) - return this.browser.actions().mouseMove(els[0], offset).perform() - } - - /** - * {{> see }} - */ - async see(text, context = null) { - return proceedSee.call(this, 'assert', text, context) - } - - /** - * {{> seeTextEquals }} - */ - async seeTextEquals(text, context = null) { - return proceedSee.call(this, 'assert', text, context, true) - } - - /** - * {{> dontSee }} - */ - dontSee(text, context = null) { - return proceedSee.call(this, 'negate', text, context) - } - - /** - * {{> grabBrowserLogs }} - */ - async grabBrowserLogs() { - return this.browser.manage().logs().get('browser') - } - - /** - * {{> grabCurrentUrl }} - */ - async grabCurrentUrl() { - return this.browser.getCurrentUrl() - } - - /** - * {{> selectOption }} - */ - async selectOption(select, option) { - const fields = await findFields(this.browser, select) - assertElementExists(fields, select, 'Selectable field') - if (!Array.isArray(option)) { - option = [option] - } - const field = fields[0] - const promises = [] - for (const key in option) { - const opt = xpathLocator.literal(option[key]) - let els = await field.findElements(global.by.xpath(Locator.select.byVisibleText(opt))) - if (!els.length) { - els = await field.findElements(global.by.xpath(Locator.select.byValue(opt))) - } - els.forEach((el) => promises.push(el.click())) - } - - return Promise.all(promises) - } - - /** - * {{> fillField }} - */ - async fillField(field, value) { - const els = await findFields(this.browser, field) - await els[0].clear() - return els[0].sendKeys(value.toString()) - } - - /** - * {{> pressKey }} - * {{ keys }} - */ - async pressKey(key) { - let modifier - if (Array.isArray(key) && ~['Control', 'Command', 'Shift', 'Alt'].indexOf(key[0])) { - modifier = Key[key[0].toUpperCase()] - key = key[1] - } - - // guess special key in Selenium Webdriver list - if (Key[key.toUpperCase()]) { - key = Key[key.toUpperCase()] - } - - const action = this.browser.actions() - if (modifier) action.keyDown(modifier) - action.sendKeys(key) - if (modifier) action.keyUp(modifier) - return action.perform() - } - - /** - * {{> attachFile }} - */ - async attachFile(locator, pathToFile) { - const file = path.join(global.codecept_dir, pathToFile) - if (!fileExists(file)) { - throw new Error(`File at ${file} can not be found on local system`) - } - const els = await findFields(this.browser, locator) - assertElementExists(els, locator, 'Field') - if (this.options.browser !== 'phantomjs') { - const remote = require('selenium-webdriver/remote') - this.browser.setFileDetector(new remote.FileDetector()) - } - return els[0].sendKeys(file) - } - - /** - * {{> seeInField }} - */ - async seeInField(field, value) { - const _value = typeof value === 'boolean' ? value : value.toString() - return proceedSeeInField.call(this, 'assert', field, _value) - } - - /** - * {{> dontSeeInField }} - */ - async dontSeeInField(field, value) { - const _value = typeof value === 'boolean' ? value : value.toString() - return proceedSeeInField.call(this, 'negate', field, _value) - } - - /** - * {{> appendField }} - */ - async appendField(field, value) { - const els = await findFields(this.browser, field) - assertElementExists(els, field, 'Field') - return els[0].sendKeys(value.toString()) - } - - /** - * {{> clearField }} - */ - async clearField(field) { - const els = await findFields(this.browser, field) - assertElementExists(els, field, 'Field') - return els[0].clear() - } - - /** - * {{> checkOption }} - */ - async checkOption(field, context = null) { - let matcher = this.browser - if (context) { - const els = await this._locate(context, true) - assertElementExists(els, context) - matcher = els[0] - } - const els = await findCheckable(matcher, field) - assertElementExists(els, field, 'Checkbox or radio') - const isSelected = await els[0].isSelected() - if (!isSelected) return els[0].click() - } - - /** - * {{> uncheckOption }} - */ - async uncheckOption(field, context = null) { - let matcher = this.browser - if (context) { - const els = await this._locate(context, true) - assertElementExists(els, context) - matcher = els[0] - } - const els = await findCheckable(matcher, field) - assertElementExists(els, field, 'Checkbox or radio') - const isSelected = await els[0].isSelected() - if (isSelected) return els[0].click() - } - - /** - * {{> seeCheckboxIsChecked }} - */ - async seeCheckboxIsChecked(field) { - return proceedIsChecked.call(this, 'assert', field) - } - - /** - * {{> dontSeeCheckboxIsChecked }} - */ - async dontSeeCheckboxIsChecked(field) { - return proceedIsChecked.call(this, 'negate', field) - } - - /** - * {{> grabTextFromAll }} - */ - async grabTextFromAll(locator) { - const els = await this._locate(locator) - const texts = [] - for (const el of els) { - texts.push(await el.getText()) - } - return texts - } - - /** - * {{> grabTextFrom }} - */ - async grabTextFrom(locator) { - const texts = await this.grabTextFromAll(locator) - assertElementExists(texts, locator) - if (texts.length > 1) { - this.debugSection('GrabText', `Using first element out of ${texts.length}`) - } - - return texts[0] - } - - /** - * {{> grabHTMLFromAll }} - */ - async grabHTMLFromAll(locator) { - const els = await this._locate(locator) - - const html = await Promise.all( - els.map((el) => { - return this.browser.executeScript('return arguments[0].innerHTML;', el) - }), - ) - - return html - } - - /** - * {{> grabHTMLFrom }} - */ - async grabHTMLFrom(locator) { - const html = await this.grabHTMLFromAll(locator) - assertElementExists(html, locator) - if (html.length > 1) { - this.debugSection('GrabHTMl', `Using first element out of ${html.length}`) - } - - return html[0] - } - - /** - * {{> grabValueFromAll }} - */ - async grabValueFromAll(locator) { - const els = await findFields(this.browser, locator) - const values = await Promise.all(els.map((el) => el.getAttribute('value'))) - - return values - } - - /** - * {{> grabValueFrom }} - */ - async grabValueFrom(locator) { - const values = await this.grabValueFromAll(locator) - assertElementExists(values, locator, 'Field') - if (values.length > 1) { - this.debugSection('GrabValue', `Using first element out of ${values.length}`) - } - - return values[0] - } - - /** - * {{> grabCssPropertyFromAll }} - */ - async grabCssPropertyFromAll(locator, cssProperty) { - const els = await this._locate(locator, true) - const values = await Promise.all(els.map((el) => el.getCssValue(cssProperty))) - - return values - } - - /** - * {{> grabCssPropertyFrom }} - */ - async grabCssPropertyFrom(locator, cssProperty) { - const cssValues = await this.grabCssPropertyFromAll(locator, cssProperty) - assertElementExists(cssValues, locator) - - if (cssValues.length > 1) { - this.debugSection('GrabCSS', `Using first element out of ${cssValues.length}`) - } - - return cssValues[0] - } - - /** - * {{> grabAttributeFromAll }} - */ - async grabAttributeFromAll(locator, attr) { - const els = await this._locate(locator) - const array = [] - - for (let index = 0; index < els.length; index++) { - const el = els[index] - array.push(await el.getAttribute(attr)) - } - return array - } - - /** - * {{> grabAttributeFrom }} - */ - async grabAttributeFrom(locator, attr) { - const attrs = await this.grabAttributeFromAll(locator, attr) - assertElementExists(attrs, locator) - if (attrs.length > 1) { - this.debugSection('GrabAttribute', `Using first element out of ${attrs.length}`) - } - - return attrs[0] - } - - /** - * {{> seeInTitle }} - */ - async seeInTitle(text) { - return this.browser.getTitle().then((title) => stringIncludes('web page title').assert(text, title)) - } - - /** - * {{> seeTitleEquals }} - */ - async seeTitleEquals(text) { - const title = await this.browser.getTitle() - return equals('web page title').assert(title, text) - } - - /** - * {{> dontSeeInTitle }} - */ - async dontSeeInTitle(text) { - return this.browser.getTitle().then((title) => stringIncludes('web page title').negate(text, title)) - } - - /** - * {{> grabTitle }} - */ - async grabTitle() { - return this.browser.getTitle().then((title) => { - this.debugSection('Title', title) - return title - }) - } - - /** - * {{> seeElement }} - */ - 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')) - } - - /** - * {{> dontSeeElement }} - */ - 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')) - } - - /** - * {{> seeElementInDOM }} - */ - async seeElementInDOM(locator) { - 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'))) - } - - /** - * {{> seeInSource }} - */ - async seeInSource(text) { - return this.browser.getPageSource().then((source) => stringIncludes('HTML source of a page').assert(text, source)) - } - - /** - * {{> grabSource }} - */ - async grabSource() { - return this.browser.getPageSource() - } - - /** - * {{> dontSeeInSource }} - */ - async dontSeeInSource(text) { - return this.browser.getPageSource().then((source) => stringIncludes('HTML source of a page').negate(text, source)) - } - - /** - * {{> seeNumberOfElements }} - */ - 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) - } - - /** - * {{> seeNumberOfVisibleElements }} - */ - 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, - ) - } - - /** - * {{> grabNumberOfVisibleElements }} - */ - async grabNumberOfVisibleElements(locator) { - let els = await this._locate(locator) - els = await Promise.all(els.map((el) => el.isDisplayed())) - return els.length - } - - /** - * {{> seeCssPropertiesOnElements }} - */ - async seeCssPropertiesOnElements(locator, cssProperties) { - const els = await this._locate(locator) - assertElementExists(els, locator) - - const cssPropertiesCamelCase = convertCssPropertiesToCamelCase(cssProperties) - - const attributeNames = Object.keys(cssPropertiesCamelCase) - 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 missing = attributeValues.filter((actual, i) => { - const prop = attributeNames[i] - let propValue = actual - if (isColorProperty(prop) && propValue) { - propValue = convertColorToRGBA(propValue) - } - return propValue !== expectedValues[i] - }) - if (missing.length) { - missingAttributes.push(...missing) - } - } - return equals( - `all elements (${new Locator(locator)}) to have CSS property ${JSON.stringify(cssProperties)}`, - ).assert(missingAttributes.length, 0) - } - - /** - * {{> seeAttributesOnElements }} - */ - async seeAttributesOnElements(locator, attributes) { - const els = await this._locate(locator) - assertElementExists(els, locator) - - const attributeNames = Object.keys(attributes) - 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 missing = attributeValues.filter((actual, i) => { - if (expectedValues[i] instanceof RegExp) { - return expectedValues[i].test(actual) - } - return actual !== expectedValues[i] - }) - if (missing.length) { - missingAttributes.push(...missing) - } - } - - return equals(`all elements (${new Locator(locator)}) to have attributes ${JSON.stringify(attributes)}`).assert( - missingAttributes.length, - 0, - ) - } - - /** - * {{> executeScript }} - */ - async executeScript() { - return this.browser.executeScript.apply(this.browser, arguments) - } - - /** - * {{> executeAsyncScript }} - */ - async executeAsyncScript() { - this.browser.manage().timeouts().setScriptTimeout(this.options.scriptTimeout) - return this.browser.executeAsyncScript.apply(this.browser, arguments) - } - - /** - * {{> seeInCurrentUrl }} - */ - async seeInCurrentUrl(url) { - 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)) - } - - /** - * {{> seeCurrentUrlEquals }} - */ - async seeCurrentUrlEquals(url) { - 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)) - } - - /** - * {{> saveElementScreenshot }} - * - */ - async saveElementScreenshot(locator, fileName) { - const outputFile = screenshotOutputFolder(fileName) - - const writeFile = (png, outputFile) => { - const fs = require('fs') - 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 - } - - const res = await this._locate(locator) - assertElementExists(res, locator) - if (res.length > 1) this.debug(`[Elements] Using first element out of ${res.length}`) - const elem = res[0] - this.debug(`Screenshot of ${new Locator(locator)} element has been saved to ${outputFile}`) - const png = await elem.takeScreenshot() - return writeFile(png, outputFile) - } - - /** - * {{> saveScreenshot }} - */ - async saveScreenshot(fileName, fullPage = false) { - const outputFile = screenshotOutputFolder(fileName) - - const writeFile = (png, outputFile) => { - const fs = require('fs') - 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 - } - - if (!fullPage) { - this.debug(`Screenshot has been saved to ${outputFile}`) - const png = await this.browser.takeScreenshot() - return writeFile(png, outputFile) - } - - let { width, height } = await this.browser.executeScript(() => ({ - height: document.body.scrollHeight, - width: document.body.scrollWidth, - })) - - if (height < 100) height = 500 - - await this.browser.manage().window().setSize(width, height) - this.debug(`Screenshot has been saved to ${outputFile}, size: ${width}x${height}`) - const png = await this.browser.takeScreenshot() - return writeFile(png, outputFile) - } - - /** - * {{> clearCookie }} - */ - async clearCookie(cookie = null) { - if (!cookie) { - return this.browser.manage().deleteAllCookies() - } - return this.browser.manage().deleteCookie(cookie) - } - - /** - * {{> seeCookie }} - */ - async seeCookie(name) { - return this.browser - .manage() - .getCookie(name) - .then((res) => truth(`cookie ${name}`, 'to be set').assert(res)) - } - - /** - * {{> dontSeeCookie }} - */ - async dontSeeCookie(name) { - return this.browser - .manage() - .getCookie(name) - .then((res) => truth(`cookie ${name}`, 'to be set').negate(res)) - } - - /** - * {{> grabCookie }} - * - * Returns cookie in JSON [format](https://code.google.com/p/selenium/wiki/JsonWireProtocol#Cookie_JSON_Object). - */ - async grabCookie(name) { - if (!name) return this.browser.manage().getCookies() - return this.browser.manage().getCookie(name) - } - - /** - * Accepts the active JavaScript native popup window, as created by window.alert|window.confirm|window.prompt. - * Don't confuse popups with modal windows, as created by [various - * libraries](http://jster.net/category/windows-modals-popups). Appium: support only web testing - */ - async acceptPopup() { - return this.browser.switchTo().alert().accept() - } - - /** - * Dismisses the active JavaScript popup, as created by window.alert|window.confirm|window.prompt. - */ - async cancelPopup() { - return this.browser.switchTo().alert().dismiss() - } - - /** - * {{> seeInPopup }} - */ - async seeInPopup(text) { - const popupAlert = await this.browser.switchTo().alert() - const res = await popupAlert.getText() - if (res === null) { - throw new Error('Popup is not opened') - } - stringIncludes('text in popup').assert(text, res) - } - - /** - * Grab the text within the popup. If no popup is visible then it will return null - * - * ```js - * await I.grabPopupText(); - * ``` - */ - async grabPopupText() { - try { - const dialog = await this.browser.switchTo().alert() - - if (dialog) { - return dialog.getText() - } - } catch (e) { - if (e.message.match(/no.*?(alert|modal)/i)) { - // Don't throw an error - return null - } - throw e - } - } - - /** - * {{> resizeWindow }} - */ - async resizeWindow(width, height) { - if (width === 'maximize') { - const res = await this.browser.executeScript('return [screen.width, screen.height]') - return this.browser.manage().window().setSize(parseInt(res[0], 10), parseInt(res[1], 10)) - } - return this.browser.manage().window().setSize(parseInt(width, 10), parseInt(height, 10)) - } - - /** - * {{> dragAndDrop }} - */ - async dragAndDrop(srcElement, destElement) { - const srcEl = await this._locate(srcElement, true) - const destEl = await this._locate(destElement, true) - assertElementExists(srcEl, srcElement) - assertElementExists(destEl, destElement) - return this.browser.actions().dragAndDrop(srcEl[0], destEl[0]).perform() - } - - /** - * Close all tabs except for the current one. - * - * ```js - * I.closeOtherTabs(); - * ``` - */ - async closeOtherTabs() { - const client = this.browser - - const handles = await client.getAllWindowHandles() - const currentHandle = await client.getWindowHandle() - const otherHandles = handles.filter((handle) => handle !== currentHandle) - - if (!otherHandles || !otherHandles.length) return - let p = Promise.resolve() - otherHandles.forEach((handle) => { - p = p.then(() => - client - .switchTo() - .window(handle) - .then(() => client.close()), - ) - }) - p = p.then(() => client.switchTo().window(currentHandle)) - return p - } - - /** - * Close current tab - * - * ```js - * I.closeCurrentTab(); - * ``` - */ - async closeCurrentTab() { - const client = this.browser - - const currentHandle = await client.getWindowHandle() - const nextHandle = await this._getWindowHandle(-1) - - await client.switchTo().window(currentHandle) - await client.close() - return client.switchTo().window(nextHandle) - } - - /** - * Get the window handle relative to the current handle. i.e. the next handle or the previous. - * @param {Number} offset Offset from current handle index. i.e. offset < 0 will go to the previous handle and positive number will go to the next window handle in sequence. - */ - async _getWindowHandle(offset = 0) { - const client = this.browser - const handles = await client.getAllWindowHandles() - const index = handles.indexOf(await client.getWindowHandle()) - const nextIndex = index + offset - - return handles[nextIndex] - // return handles[(index + offset) % handles.length]; - } - - /** - * Open new tab and switch to it - * - * ```js - * I.openNewTab(); - * ``` - */ - async openNewTab() { - const client = this.browser - await this.executeScript('window.open("about:blank")') - const handles = await client.getAllWindowHandles() - await client.switchTo().window(handles[handles.length - 1]) - } - - /** - * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab - * - * ```js - * I.switchToNextTab(); - * I.switchToNextTab(2); - * ``` - */ - async switchToNextTab(num = 1) { - const client = this.browser - const newHandle = await this._getWindowHandle(num) - - if (!newHandle) { - throw new Error(`There is no ability to switch to next tab with offset ${num}`) - } - return client.switchTo().window(newHandle) - } - - /** - * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab - * - * ```js - * I.switchToPreviousTab(); - * I.switchToPreviousTab(2); - * ``` - */ - async switchToPreviousTab(num = 1) { - const client = this.browser - const newHandle = await this._getWindowHandle(-1 * num) - - if (!newHandle) { - throw new Error(`There is no ability to switch to previous tab with offset ${num}`) - } - return client.switchTo().window(newHandle) - } - - /** - * {{> grabNumberOfOpenTabs }} - */ - async grabNumberOfOpenTabs() { - const pages = await this.browser.getAllWindowHandles() - return pages.length - } - - /** - * {{> switchTo }} - */ - async switchTo(locator) { - if (Number.isInteger(locator)) { - return this.browser.switchTo().frame(locator) - } - if (!locator) { - return this.browser.switchTo().frame(null) - } - - const els = await this._locate(withStrictLocator.call(this, locator), true) - assertElementExists(els, locator) - return this.browser.switchTo().frame(els[0]) - } - - /** - * {{> wait }} - */ - wait(sec) { - return this.browser.sleep(sec * 1000) - } - - /** - * {{> waitForElement }} - */ - async waitForElement(locator, sec = null) { - const aSec = sec || this.options.waitForTimeoutInSeconds - const el = global.element(guessLocator(locator) || global.by.css(locator)) - return this.browser.wait(EC.presenceOf(el), aSec * 1000) - } - - async waitUntilExists(locator, sec = null) { - console.log(`waitUntilExists deprecated: - * use 'waitForElement' to wait for element to be attached - * use 'waitForDetached to wait for element to be removed'`) - return this.waitForDetached(locator, sec) - } - - /** - * {{> waitForDetached }} - */ - 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) => { - 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 - }) - } - - /** - * Waits for element to become clickable for number of seconds. - * - * ```js - * I.waitForClickable('#link'); - * ``` - */ - async waitForClickable(locator, sec = null) { - const aSec = sec || this.options.waitForTimeoutInSeconds - const el = global.element(guessLocator(locator) || global.by.css(locator)) - return this.browser.wait(EC.elementToBeClickable(el), aSec * 1000) - } - - /** - * {{> waitForVisible }} - */ - async waitForVisible(locator, sec = null) { - const aSec = sec || this.options.waitForTimeoutInSeconds - const el = global.element(guessLocator(locator) || global.by.css(locator)) - return this.browser.wait(EC.visibilityOf(el), aSec * 1000) - } - - /** - * {{> waitToHide }} - */ - async waitToHide(locator, sec = null) { - return this.waitForInvisible(locator, sec) - } - - /** - * {{> waitForInvisible }} - */ - async waitForInvisible(locator, sec = null) { - const aSec = sec || this.options.waitForTimeoutInSeconds - const el = global.element(guessLocator(locator) || global.by.css(locator)) - return this.browser.wait(EC.invisibilityOf(el), aSec * 1000) - } - - async waitForStalenessOf(locator, sec = null) { - console.log(`waitForStalenessOf deprecated. - * Use waitForDetached to wait for element to be removed from page - * Use waitForInvisible to wait for element to be hidden on page`) - return this.waitForInvisible(locator, sec) - } - - /** - * {{> waitNumberOfVisibleElements }} - */ - async waitNumberOfVisibleElements(locator, num, sec = null) { - function visibilityCountOf(loc, expectedCount) { - return function () { - return global.element - .all(loc) - .filter((el) => el.isDisplayed()) - .count() - .then((count) => count === expectedCount) - } - } - - const aSec = sec || this.options.waitForTimeoutInSeconds - const guessLoc = guessLocator(locator) || global.by.css(locator) - - return this.browser.wait(visibilityCountOf(guessLoc, num), aSec * 1000).catch(() => { - throw Error(`The number of elements (${new Locator(locator)}) is not ${num} after ${aSec} sec`) - }) - } - - /** - * {{> waitForEnabled }} - */ - async waitForEnabled(locator, sec = null) { - const aSec = sec || this.options.waitForTimeoutInSeconds - const el = global.element(guessLocator(locator) || global.by.css(locator)) - - return this.browser.wait(EC.elementToBeClickable(el), aSec * 1000).catch(() => { - throw Error(`element (${new Locator(locator)}) still not enabled after ${aSec} sec`) - }) - } - - /** - * {{> waitForValue }} - */ - async waitForValue(field, value, sec = null) { - const aSec = sec || this.options.waitForTimeoutInSeconds - - 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 - } - } - - 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`, - ) - }) - } - - /** - * {{> waitForFunction }} - */ - async waitForFunction(fn, argsOrSec = null, sec = null) { - let args = [] - if (argsOrSec) { - if (Array.isArray(argsOrSec)) { - args = argsOrSec - } else if (typeof argsOrSec === 'number') { - sec = argsOrSec - } - } - - const aSec = sec || this.options.waitForTimeoutInSeconds - return this.browser.wait(() => this.browser.executeScript.call(this.browser, fn, ...args), aSec * 1000) - } - - /** - * {{> waitInUrl }} - */ - async waitInUrl(urlPart, sec = null) { - const aSec = sec || this.options.waitForTimeoutInSeconds - const waitTimeout = aSec * 1000 - - 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}`) - } else { - throw e - } - }) - } - - /** - * {{> waitUrlEquals }} - */ - async waitUrlEquals(urlPart, sec = null) { - const aSec = sec || this.options.waitForTimeoutInSeconds - const waitTimeout = aSec * 1000 - const baseUrl = this.options.url - if (urlPart.indexOf('http') < 0) { - urlPart = baseUrl + urlPart - } - - 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}`) - } else { - throw e - } - }) - } - - /** - * {{> waitForText }} - */ - async waitForText(text, sec = null, context = null) { - if (!context) { - context = this.context - } - const el = global.element(guessLocator(context) || global.by.css(context)) - const aSec = sec || this.options.waitForTimeoutInSeconds - return this.browser.wait(EC.textToBePresentInElement(el, text), aSec * 1000) - } - - // ANGULAR SPECIFIC - - /** - * Moves to url - */ - moveTo(path) { - return this.browser.setLocation(path) - } - - /** - * {{> refreshPage }} - */ - refreshPage() { - return this.browser.refresh() - } - - /** - * Reloads page - */ - refresh() { - console.log('Deprecated in favor of refreshPage') - return this.browser.refresh() - } - - /** - * {{> scrollTo }} - */ - async scrollTo(locator, offsetX = 0, offsetY = 0) { - if (typeof locator === 'number' && typeof offsetX === 'number') { - offsetY = offsetX - offsetX = locator - locator = null - } - - if (locator) { - const res = await this._locate(locator, true) - if (!res || res.length === 0) { - return truth(`elements of ${new Locator(locator)}`, 'to be seen').assert(false) - } - const elem = res[0] - const location = await elem.getLocation() - - return this.executeScript( - function (x, y) { - return window.scrollTo(x, y) - }, - location.x + offsetX, - location.y + offsetY, - ) - } - - return this.executeScript( - function (x, y) { - return window.scrollTo(x, y) - }, - offsetX, - offsetY, - ) - } - - /** - * {{> scrollPageToTop }} - */ - async scrollPageToTop() { - return this.executeScript('window.scrollTo(0, 0);') - } - - /** - * {{> scrollPageToBottom }} - */ - async scrollPageToBottom() { - 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), - ) - }) - } - - /** - * {{> grabPageScrollPosition }} - */ - async grabPageScrollPosition() { - function getScrollPosition() { - return { - x: window.pageXOffset, - y: window.pageYOffset, - } - } - - return this.executeScript(getScrollPosition) - } - - /** - * Injects Angular module. - * - * ```js - * I.haveModule('modName', function() { - * angular.module('modName', []).value('foo', 'bar'); - * }); - * ``` - */ - haveModule(modName, fn) { - return this.browser.addMockModule(modName, fn) - } - - /** - * Removes mocked Angular module. If modName not specified - clears all mock modules. - * - * ```js - * I.resetModule(); // clears all - * I.resetModule('modName'); - * ``` - */ - resetModule(modName) { - if (!modName) { - return this.browser.clearMockModules() - } - return this.browser.removeMockModule(modName) - } - - /** - * {{> setCookie }} - */ - setCookie(cookie) { - return this.browser.manage().addCookie(cookie) - } -} - -module.exports = Protractor - -async function findCheckable(client, locator) { - const matchedLocator = guessLocator(locator) - if (matchedLocator) { - return client.findElements(matchedLocator) - } - const literal = xpathLocator.literal(locator) - let els = await client.findElements(global.by.xpath(Locator.checkable.byText(literal))) - if (els.length) { - return els - } - els = await client.findElements(global.by.xpath(Locator.checkable.byName(literal))) - if (els.length) { - return els - } - return client.findElements(global.by.css(locator)) -} - -function withStrictLocator(locator) { - locator = new Locator(locator) - if (locator.isAccessibilityId()) return withAccessiblitiyLocator.call(this, locator.value) - return locator.simplify() -} - -function withAccessiblitiyLocator(locator) { - if (this.isWeb === false) { - return `accessibility id:${locator.slice(1)}` - } - return `[aria-label="${locator.slice(1)}"]` - // hook before webdriverio supports native ~ locators in web -} - -async function findFields(client, locator) { - const matchedLocator = guessLocator(locator) - if (matchedLocator) { - return client.findElements(matchedLocator) - } - const literal = xpathLocator.literal(locator) - - let els = await client.findElements(global.by.xpath(Locator.field.labelEquals(literal))) - if (els.length) { - return els - } - - els = await client.findElements(global.by.xpath(Locator.field.labelContains(literal))) - if (els.length) { - return els - } - els = await client.findElements(global.by.xpath(Locator.field.byName(literal))) - if (els.length) { - return els - } - return client.findElements(global.by.css(locator)) -} - -async function proceedSee(assertType, text, context) { - let description - let locator - if (!context) { - if (this.context === this.options.rootElement) { - locator = guessLocator(this.context) || global.by.css(this.context) - description = 'web application' - } else { - // inside within block - locator = global.by.xpath('.//*') - description = `current context ${new Locator(context).toString()}` - } - } else { - locator = guessLocator(context) || global.by.css(context) - description = `element ${new Locator(context).toString()}` - } - const enableSmartWait = !!this.context && assertType === 'assert' - 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}`)))) - await Promise.all(promises) - return stringIncludes(description)[assertType](text, source) -} - -async function proceedSeeInField(assertType, field, value) { - const els = await findFields(this.browser, field) - assertElementExists(els, field, 'Field') - const el = els[0] - const tag = await el.getTagName() - const fieldVal = await el.getAttribute('value') - if (tag === 'select') { - // locate option by values and check them - const literal = xpathLocator.literal(fieldVal) - const textEl = await el.findElement(global.by.xpath(Locator.select.byValue(literal))) - const text = await textEl.getText() - return equals(`select option by ${field}`)[assertType](value, text) - } - return stringIncludes(`field by ${field}`)[assertType](value, fieldVal) -} - -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())) - const values = await Promise.all(elsSelected) - const selected = values.reduce((prev, cur) => prev || cur) - return truth(`checkable ${option}`, 'to be checked')[assertType](selected) -} - -async function findClickable(matcher, locator) { - locator = new Locator(locator) - if (!locator.isFuzzy()) { - const els = await this._locate(locator, true) - assertElementExists(els, locator.value) - return els[0] - } - const literal = xpathLocator.literal(locator.value) - const narrowLocator = Locator.clickable.narrow(literal) - let els = await matcher.findElements(global.by.xpath(narrowLocator)) - if (els.length) { - return els[0] - } - - els = await matcher.findElements(global.by.xpath(Locator.clickable.wide(literal))) - if (els.length) { - return els[0] - } - return matcher.findElement(global.by.css(locator.value)) -} - -function guessLocator(locator) { - const l = new Locator(locator) - if (l.isFuzzy()) return false - if (l.type) return global.by[l.type](l.value) - return false -} - -function assertElementExists(res, locator, prefix, suffix) { - if (!res.length) { - throw new ElementNotFound(locator, prefix, suffix) - } -} - -function isFrameLocator(locator) { - locator = new Locator(locator) - if (locator.isFrame()) return locator.value - return false -} - -function isWithin() { - return Object.keys(withinStore).length !== 0 -} - -function loadGlobals(browser) { - global.browser = browser - global.$ = browser.$ - global.$$ = browser.$$ - global.element = browser.element - global.by = global.By = new ProtractorBy() - global.ExpectedConditions = EC = new ProtractorExpectedConditions(browser) -} diff --git a/lib/helper/Puppeteer.js b/lib/helper/Puppeteer.js index 77cbf3587..9ac40edaa 100644 --- a/lib/helper/Puppeteer.js +++ b/lib/helper/Puppeteer.js @@ -1,21 +1,19 @@ -const axios = require('axios') -const fs = require('fs') -const fsExtra = require('fs-extra') -const path = require('path') - -const Helper = require('@codeceptjs/helper') -const { v4: uuidv4 } = require('uuid') -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') -const { empty } = require('../assert/empty') -const { truth } = require('../assert/truth') -const isElementClickable = require('./scripts/isElementClickable') -const { +import axios from 'axios' +import fs from 'fs' +import fsExtra from 'fs-extra' +import path from 'path' +import Helper from '@codeceptjs/helper' +import { v4 as uuidv4 } from 'uuid' +import promiseRetry from 'promise-retry' +import Locator from '../locator.js' +import recorder from '../recorder.js' +import store from '../store.js' +import { includes as stringIncludes } from '../assert/include.js' +import { urlEquals, equals } from '../assert/equal.js' +import { empty } from '../assert/empty.js' +import { truth } from '../assert/truth.js' +import isElementClickable from './scripts/isElementClickable.js' +import { xpathLocator, ucfirst, fileExists, @@ -28,27 +26,16 @@ const { isModifierKey, requireWithFallback, normalizeSpacesInString, -} = require('../utils') -const { isColorProperty, convertColorToRGBA } = require('../colorUtils') -const ElementNotFound = require('./errors/ElementNotFound') -const RemoteBrowserConnectionRefused = require('./errors/RemoteBrowserConnectionRefused') -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') +} from '../utils.js' +import { isColorProperty, convertColorToRGBA } from '../colorUtils.js' +import ElementNotFound from './errors/ElementNotFound.js' +import RemoteBrowserConnectionRefused from './errors/RemoteBrowserConnectionRefused.js' +import Popup from './extras/Popup.js' +import Console from './extras/Console.js' +import { highlightElement } from './scripts/highlightElement.js' +import { blurElement } from './scripts/blurElement.js' +import { dontSeeElementError, seeElementError, dontSeeElementInDOMError, seeElementInDOMError } from './errors/ElementAssertion.js' +import { dontSeeTraffic, seeTraffic, grabRecordedNetworkTraffics, stopRecordingTraffic, flushNetworkTraffics } from './network/actions.js' let puppeteer let perfTiming @@ -224,7 +211,7 @@ class Puppeteer extends Helper { constructor(config) { super(config) - puppeteer = requireWithFallback('puppeteer', 'puppeteer-core') + // puppeteer will be loaded dynamically in _init method // set defaults this.isRemoteBrowser = false this.isRunning = false @@ -271,9 +258,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) { @@ -306,13 +291,34 @@ class Puppeteer extends Helper { static _checkRequirements() { try { - requireWithFallback('puppeteer', 'puppeteer-core') + // In ESM, puppeteer will be checked via dynamic import in _init + // The import will fail at module load time if puppeteer is missing + return null } catch (e) { return ['puppeteer'] } } - _init() {} + async _init() { + // Load puppeteer dynamically with fallback + if (!puppeteer) { + try { + const puppeteerModule = await import('puppeteer') + puppeteer = puppeteerModule.default || puppeteerModule + this.debugSection('Puppeteer', `Loaded puppeteer successfully, launch available: ${!!puppeteer.launch}`) + } catch (e) { + try { + const puppeteerModule = await import('puppeteer-core') + puppeteer = puppeteerModule.default || puppeteerModule + this.debugSection('Puppeteer', `Loaded puppeteer-core successfully, launch available: ${!!puppeteer.launch}`) + } catch (e2) { + throw new Error('Neither puppeteer nor puppeteer-core could be loaded. Please install one of them.') + } + } + } else { + this.debugSection('Puppeteer', `Puppeteer already loaded, launch available: ${!!puppeteer.launch}`) + } + } _beforeSuite() { if (!this.options.restart && !this.options.manualStart && !this.isRunning) { @@ -325,8 +331,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 +352,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 +361,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 +374,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 +406,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 +420,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 +523,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 +539,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() @@ -575,6 +581,12 @@ class Puppeteer extends Helper { } async _startBrowser() { + this.debugSection('Puppeteer', `Starting browser. Puppeteer available: ${!!puppeteer}, launch available: ${!!puppeteer?.launch}`) + + if (!puppeteer) { + throw new Error('Puppeteer is not loaded. Make sure _init() was called before _startBrowser()') + } + if (this.isRemoteBrowser) { try { this.browser = await puppeteer.connect(this.puppeteerOptions) @@ -588,15 +600,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 +651,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 +674,7 @@ class Puppeteer extends Helper { const navigationStart = timing.navigationStart const extractedData = {} - dataNames.forEach((name) => { + dataNames.forEach(name => { extractedData[name] = timing[name] - navigationStart }) @@ -694,17 +704,25 @@ class Puppeteer extends Helper { this.currentRunningTest.artifacts.trace = fileName } - await this.page.goto(url, { waitUntil: this.options.waitForNavigation }) + try { + await this.page.goto(url, { waitUntil: this.options.waitForNavigation }) + } catch (err) { + // Handle terminal navigation errors that shouldn't be retried + if ( + err.message && + (err.message.includes('ERR_ABORTED') || err.message.includes('frame was detached') || err.message.includes('Target page, context or browser has been closed') || err.message.includes('Navigation timeout')) + ) { + // Mark this as a terminal error to prevent retries + const terminalError = new Error(err.message) + terminalError.isTerminal = true + throw terminalError + } + throw err + } 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 +833,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 +851,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 +1036,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 +1072,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 +1088,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 +1104,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 +1116,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 +1146,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 +1210,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 +1238,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 +1292,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 +1305,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 +1398,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 +1473,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