Skip to content
  • Sponsor codeceptjs/CodeceptJS

  • Notifications You must be signed in to change notification settings
  • Fork 742
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: codeceptjs/CodeceptJS
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 3.5.10
Choose a base ref
...
head repository: codeceptjs/CodeceptJS
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 3.x
Choose a head ref

Commits on Dec 8, 2023

  1. update changelog

    kobenguyent committed Dec 8, 2023
    Copy the full SHA
    d8c688e View commit details

Commits on Dec 11, 2023

  1. chore(deps): bump actions/stale from 8 to 9 (#4059)

    Bumps [actions/stale](https://github.com/actions/stale) from 8 to 9.
    - [Release notes](https://github.com/actions/stale/releases)
    - [Changelog](https://github.com/actions/stale/blob/main/CHANGELOG.md)
    - [Commits](actions/stale@v8...v9)
    
    ---
    updated-dependencies:
    - dependency-name: actions/stale
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Dec 11, 2023
    Copy the full SHA
    8eceaf6 View commit details
  2. fix: expect docs (#4058)

    kobenguyent authored Dec 11, 2023
    Copy the full SHA
    25637ba View commit details
  3. chore(deps): bump @xmldom/xmldom from 0.7.7 to 0.8.10 (#4060)

    Bumps [@xmldom/xmldom](https://github.com/xmldom/xmldom) from 0.7.7 to 0.8.10.
    - [Release notes](https://github.com/xmldom/xmldom/releases)
    - [Changelog](https://github.com/xmldom/xmldom/blob/master/CHANGELOG.md)
    - [Commits](xmldom/xmldom@0.7.7...0.8.10)
    
    ---
    updated-dependencies:
    - dependency-name: "@xmldom/xmldom"
      dependency-type: direct:production
      update-type: version-update:semver-minor
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Dec 11, 2023
    Copy the full SHA
    cba856c View commit details

Commits on Dec 12, 2023

  1. Copy the full SHA
    0d1d86b View commit details
  2. chore(deps-dev): bump typedoc-plugin-markdown from 3.13.4 to 3.17.1 (#…

    …4064)
    
    Bumps [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown) from 3.13.4 to 3.17.1.
    - [Release notes](https://github.com/tgreyuk/typedoc-plugin-markdown/releases)
    - [Changelog](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/typedoc-plugin-markdown/CHANGELOG.md)
    - [Commits](https://github.com/tgreyuk/typedoc-plugin-markdown/commits/typedoc-plugin-markdown@3.17.1/packages/typedoc-plugin-markdown)
    
    ---
    updated-dependencies:
    - dependency-name: typedoc-plugin-markdown
      dependency-type: direct:development
      update-type: version-update:semver-minor
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Dec 12, 2023
    Copy the full SHA
    af49335 View commit details

Commits on Dec 14, 2023

  1. Copy the full SHA
    7912198 View commit details

Commits on Dec 17, 2023

  1. Update CONTRIBUTING.md

    kobenguyent authored Dec 17, 2023
    Copy the full SHA
    ce7a342 View commit details
  2. Update CONTRIBUTING.md

    kobenguyent authored Dec 17, 2023
    Copy the full SHA
    edec18c View commit details

Commits on Dec 18, 2023

  1. Copy the full SHA
    bed67e0 View commit details
  2. Copy the full SHA
    0f135d0 View commit details
  3. Copy the full SHA
    815da18 View commit details
  4. Copy the full SHA
    e8ce81c View commit details
  5. Copy the full SHA
    52cf527 View commit details

Commits on Dec 19, 2023

  1. fix: docs format (#4076)

    kobenguyent authored Dec 19, 2023
    Copy the full SHA
    6c57921 View commit details

Commits on Dec 20, 2023

  1. Copy the full SHA
    51f7eb2 View commit details

Commits on Dec 21, 2023

  1. Copy the full SHA
    0341547 View commit details

Commits on Dec 22, 2023

  1. Copy the full SHA
    b4b6dd8 View commit details

Commits on Dec 23, 2023

  1. Copy the full SHA
    0de0783 View commit details

Commits on Dec 27, 2023

  1. chore(deps-dev): bump ts-node from 10.9.1 to 10.9.2 (#4089)

    Bumps [ts-node](https://github.com/TypeStrong/ts-node) from 10.9.1 to 10.9.2.
    - [Release notes](https://github.com/TypeStrong/ts-node/releases)
    - [Changelog](https://github.com/TypeStrong/ts-node/blob/main/development-docs/release-template.md)
    - [Commits](TypeStrong/ts-node@v10.9.1...v10.9.2)
    
    ---
    updated-dependencies:
    - dependency-name: ts-node
      dependency-type: direct:development
      update-type: version-update:semver-patch
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Dec 27, 2023
    Copy the full SHA
    0e7b6ed View commit details
  2. chore(deps-dev): bump typescript from 5.2.2 to 5.3.3 (#4088)

    Bumps [typescript](https://github.com/Microsoft/TypeScript) from 5.2.2 to 5.3.3.
    - [Release notes](https://github.com/Microsoft/TypeScript/releases)
    - [Commits](microsoft/TypeScript@v5.2.2...v5.3.3)
    
    ---
    updated-dependencies:
    - dependency-name: typescript
      dependency-type: direct:development
      update-type: version-update:semver-minor
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Dec 27, 2023
    Copy the full SHA
    b1037dd View commit details

Commits on Dec 28, 2023

  1. Copy the full SHA
    78309b1 View commit details

Commits on Dec 30, 2023

  1. Copy the full SHA
    474b5e1 View commit details
  2. fix: step arg is a function (#4092)

    * fix: step arg is a function
    kobenguyent authored Dec 30, 2023
    Copy the full SHA
    10df8b2 View commit details

Commits on Jan 1, 2024

  1. Copy the full SHA
    3bc9e5b View commit details
  2. Copy the full SHA
    bd08cb5 View commit details
  3. Copy the full SHA
    9169a1b View commit details
  4. Copy the full SHA
    5bcc8b7 View commit details
  5. Copy the full SHA
    79d9897 View commit details
  6. release 3.5.11 (#4098)

    kobenguyent authored Jan 1, 2024
    Copy the full SHA
    1a9f3be View commit details

Commits on Jan 2, 2024

  1. Copy the full SHA
    0d2ef39 View commit details

Commits on Jan 3, 2024

  1. Add a locator builder method withTextEquals() (#4100)

    * Add a locator builder method withTextEquals()
    
    * Fixed docs
    
    * Add a locator builder method withTextEquals() #4100
    
    Refactored withText() and withTextEquals() to use csstoxpath
    
    ---------
    
    Co-authored-by: kobenguyent <kobenguyent@gmail.com>
    mirao and kobenguyent authored Jan 3, 2024
    Copy the full SHA
    b8b0e33 View commit details
  2. Copy the full SHA
    69fc1bf View commit details
  3. Copy the full SHA
    dca0c2c View commit details

Commits on Jan 5, 2024

  1. Copy the full SHA
    f28d314 View commit details

Commits on Jan 6, 2024

  1. Copy the full SHA
    889ddb3 View commit details

Commits on Jan 8, 2024

  1. Copy the full SHA
    6b4b96b View commit details

Commits on Jan 9, 2024

  1. Copy the full SHA
    9a730e7 View commit details
  2. Copy the full SHA
    9a05c17 View commit details

Commits on Jan 10, 2024

  1. Copy the full SHA
    17e0919 View commit details
  2. Copy the full SHA
    7c3ee50 View commit details

Commits on Jan 11, 2024

  1. Copy the full SHA
    49b411a View commit details

Commits on Jan 12, 2024

  1. Copy the full SHA
    2bfe7d1 View commit details
  2. Copy the full SHA
    b42190f View commit details

Commits on Jan 13, 2024

  1. Copy the full SHA
    eb619d2 View commit details
  2. Copy the full SHA
    8ceb8be View commit details

Commits on Jan 14, 2024

  1. Copy the full SHA
    bf4952c View commit details

Commits on Jan 15, 2024

  1. Copy the full SHA
    f41ac5a View commit details
  2. Copy the full SHA
    3c8cde8 View commit details
  3. chore(deps-dev): bump typedoc from 0.25.4 to 0.25.7 (#4136)

    Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.25.4 to 0.25.7.
    - [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
    - [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
    - [Commits](TypeStrong/typedoc@v0.25.4...v0.25.7)
    
    ---
    updated-dependencies:
    - dependency-name: typedoc
      dependency-type: direct:development
      update-type: version-update:semver-patch
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Jan 15, 2024
    Copy the full SHA
    8b92b18 View commit details
Showing 427 changed files with 45,721 additions and 33,949 deletions.
5 changes: 0 additions & 5 deletions .circleci/build.sh

This file was deleted.

48 changes: 0 additions & 48 deletions .circleci/config.yml

This file was deleted.

10 changes: 0 additions & 10 deletions .circleci/test.sh

This file was deleted.

1 change: 0 additions & 1 deletion .eslintignore

This file was deleted.

47 changes: 0 additions & 47 deletions .eslintrc.json

This file was deleted.

48 changes: 38 additions & 10 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 install --legacy-peer-deps --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.
@@ -132,6 +132,31 @@ Documentation parts can be shared across helpers. Those parts are located in `do
}
```

_Note:_ Due to the (lib)[https://documentation.js.org/] that we are using to generate docs, the fast and cheap way to fix format issue that text after the mustache template is appended without formatting is moving the texts to above the mustache template.

```js
/**
* // Before
* Click action
* {{> click }}
* Click action
*/
click() {
// ...
}
```

```js
/**
* // After
* Click action
* {{> click }}
*/
click() {
// ...
}
```

## Typings

Typings are generated in `typings/` directory via `jsdoc`
@@ -186,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
@@ -210,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
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -33,6 +33,7 @@ Applicable plugins:
- [ ] :fire: Breaking changes
- [ ] :rocket: New functionality
- [ ] :bug: Bug fix
- [ ] 🧹 Chore
- [ ] :clipboard: Documentation changes/updates
- [ ] :hotsprings: Hot fix
- [ ] :hammer: Markdown files fix - not related to source code
23 changes: 10 additions & 13 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,17 @@
version: 2
updates:
# github-actions
- package-ecosystem: "github-actions"
directory: "/"
- package-ecosystem: 'github-actions'
directory: '/'
schedule:
interval: "weekly"
target-branch: "3.x"
interval: 'weekly'
target-branch: '3.x'
# npm
- package-ecosystem: "npm"
directory: "/"
- package-ecosystem: 'npm'
directory: '/'
schedule:
interval: "weekly"
target-branch: "3.x"
interval: 'weekly'
target-branch: '3.x'
ignore:
- dependency-name: "escape-string-regexp"
versions: [">=5.0"]
- dependency-name: "apollo-server-express"
versions: [">=3.0"]

- dependency-name: 'escape-string-regexp'
versions: ['>=5.0']
48 changes: 48 additions & 0 deletions .github/workflows/acceptance-tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Acceptance Tests using docker compose

on:
push:
branches:
- '3.x'
pull_request:
branches:
- '**'

env:
CI: true
# Force terminal colors. @see https://www.npmjs.com/package/colors
FORCE_COLOR: 1

jobs:
build:
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [20.x]

steps:
# Checkout the repository
- name: Checkout Repository
uses: actions/checkout@v4

# Install Docker Compose
- name: Install Docker Compose
run: |
sudo apt-get update --allow-releaseinfo-change
sudo apt-get install -y docker-compose
# Run rest tests using docker-compose
- name: Run REST Tests
run: docker-compose run --rm test-rest
working-directory: test

# Run WebDriverIO acceptance tests using docker-compose
- 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
58 changes: 0 additions & 58 deletions .github/workflows/appiumV2_Android.yml

This file was deleted.

Loading