Merge pull request #5045 from codeceptjs/feat/esm

Feat/esm

Author: DavertMik

.circleci/build.sh

@@ -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

.circleci/config.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
@@ -41,8 +41,3 @@ jobs:
       - name: Run WebDriverIO Acceptance Tests
         run: docker-compose run --rm test-acceptance.webdriverio
         working-directory: test
-
-      # Run faker BDD tests using docker-compose
-      - name: Run Faker BDD Tests
-        run: docker-compose run --rm test-bdd.faker
-        working-directory: test

.circleci/test.sh

@@ -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

.github/CONTRIBUTING.md

@@ -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

.github/workflows/acceptance-tests.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 }}
+            ${{ env.DOCKER_REPO }}:latest
+            ${{ env.DOCKER_REPO }}:${{ env.VERSION }}