Skip to content

[4.0] Update Readme for Api tests #30539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wilsonge merged 10 commits into from
Sep 4, 2020
Merged

[4.0] Update Readme for Api tests #30539

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
522d502
readme api tests
astridx Sep 1, 2020
a0688cd
wip
astridx Sep 1, 2020
ef1ae89
wip
astridx Sep 1, 2020
e0e4d20
wip
astridx Sep 1, 2020
840b825
wip
astridx Sep 1, 2020
76e29f3
Update tests/Codeception/README.md
astridx Sep 1, 2020
9c775e3
Update tests/Codeception/README.md
astridx Sep 1, 2020
282a4d8
wip
astridx Sep 2, 2020
6a295e6
wip
astridx Sep 2, 2020
3430606
Update tests/Codeception/README.md
wilsonge Sep 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions tests/Codeception/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ at the moment
Here are the steps that are needed to setup UI tests execution on `localhost`

#### Linux OS
1) Checkout the Project in your document root folder, and follow the setup guide.
1) Checkout the Project in your document root folder, and follow the [setup guide](https://docs.joomla.org/J4.x:Setting_Up_Your_Local_Environment).
2) Navigate to `tests/Codeception` folder and edit configuration file `acceptance.suite.yml` file.
1) Within the JoomlaBrowser config section change `url` point it to your localhost url
2) update `database host` `database user` & `database password` as per your localhost installed DB,
Expand All @@ -36,14 +36,20 @@ These are the Joomla 4 API (webservices) tests. To run these tests on OSX you wi

### Installation

Run a `composer install` in the joomla root directory copy the file `tests/Codeception/api.suite.dist.yml`
to `tests/Codeception/api.suite.yml`. Then adjust the REST url in the new file and copy the `codeception.yml`
to the Joomla main directory.
1) Checkout the Project in your document root folder, and follow the [setup guide}(https://docs.joomla.org/J4.x:Setting_Up_Your_Local_Environment).
2) Copy the file `tests/Codeception/api.suite.dist.yml` to `tests/Codeception/api.suite.yml`. Then edit the REST url in the new file to point it to your localhost url.
3) Edit the file configuration.php. Set `$secret` = `'tEstValue'` - see [drone-api-run.sh](https://github.com/joomla/joomla-cms/blob/d8930208814fb52c0871853cfd9298f70998fd1f/tests/Codeception/drone-api-run.sh#L59).

>Tests with authentication always use the super user credentials for now.
> Tests with authentication always use the super user credentials for now.

### Running

`vendor/bin/codecept run api`
`libraries/vendor/bin/codecept run api`

You can also run the command with `--debug` to get some extended information.
You can also run the command with

- `--debug` to get some extended information.
- `--steps` to print step-by-step execution.
- `--fail-fast` to stop after first failure.

See [Codeception Console Commands](https://codeception.com/docs/reference/Commands)