Skip to content
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

Chore/more docs updates #125

Merged
merged 5 commits into from
Oct 31, 2024
Merged

Chore/more docs updates #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0dfecfe
More documentation
haraprasadj Oct 30, 2024
2d43fa7
fix typo
haraprasadj Oct 30, 2024
c0d6c7a
add user.yaml
haraprasadj Oct 30, 2024
f0d817c
fix typo
haraprasadj Oct 31, 2024
5c3cebe
remove kayako
haraprasadj Oct 31, 2024
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
11 changes: 9 additions & 2 deletions gen3-integration-tests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,21 @@ The test users required to run the tests are listed [here](test_data/test_setup/

The API keys for these users must be saved to `~/.gen3` directory before running tests. Please find the instructions for each GEN3_INSTANCE_TYPE [here](docs/howto/generate_api_keys_for_test_users/)

## Run tests and reviewing results
### Set up test user permissions
User permissions required for the tests to pass are documented [here](test_data/test_setup/user.yaml). The tests attempt to run usersync before starting, so if usersync is correctly set up with this configuration there is nothing more to do. If that is not the case please make sure to run usersync or useryaml with this configuration before running the tests.

### Set up test data
#### Guppy
We run guppy tests with fixed ES data to enable data validation consistently. Before running guppy tests we must ensure the indices are created with the required data. We can use one of the setup scripts located [here](test_data/test_setup/guppy_es) depending on the type of Gen3 instance being tested.

## Run tests and review results
Read these [docs](docs/howto/run_tests/) for specific information on how to run tests for each GEN3_INSTANCE_TYPE.

The report can be viewed by running `allure serve allure-results`

`-n auto` comes from [python-xdist](https://pypi.org/project/pytest-xdist/). `auto` distributes tests across all available CPUs. We can set to to a smaller value to use only some of the cores.

Test classes / suties run in parallel using the `--dist loadscope`. We implemented custom scheduling for grouping tests across test suites which is explained [here](docs/reference/custom_scheduling.md)
Test classes / suites run in parallel using the `--dist loadscope`. We implemented custom scheduling for grouping tests across test suites which is explained [here](docs/reference/custom_scheduling.md)

Markers and `-m` flag can be used to specify what tests should or should not run. For example, `-m wip` selects only tests with marker `wip` and `-m not wip` skips tests with marker `wip`.

Expand Down
Loading
Loading