Skip to content

Commit

Permalink
Add registry to system tests docs
Browse files Browse the repository at this point in the history
Issue-Id: #354
  • Loading branch information
windsource committed Aug 28, 2024
1 parent 8b6fafd commit 41e904b
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions doc/docs/development/system-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The [Robot test framework](https://robotframework.org/), often referred to as ju

## System tests structure

```bash
```text
ankaios # Ankaios root
|--tests # Location for system tests and their resources
| |--resources # Location for test resources
Expand All @@ -44,7 +44,6 @@ ankaios # Ankaios root
| | | |--list_workloads.robot # A test suite testing "list workloads"
| | | |--... <---------------- # Add more tests related to "workloads" here!
| | |... <--------------------- # Add test subject focus here!

```

## System test creation
Expand Down Expand Up @@ -112,6 +111,11 @@ Test Ankaios CLI get workloads
[Teardown] Clean up Ankaios
```

!!! note

For Ankaios manifests that are used for system tests, only images from ghcr.io should be used.
A lot of other registries (docker.io, quay.io) apply rate limits which might cause failures when executing the system tests.

### Run long-runtime system tests upon merge into main

To keep the pull request status check runtime short, system tests with a longer runtime (> 30-40 seconds) shall be excluded from the pull request CI/CD verification by assigning the tag "non_execution_during_pull_request_verification" directly to the test case. When the pull request is merged into the main branch, the system test is executed. A contributor shall check the test results of those system tests afterwards.
Expand Down

0 comments on commit 41e904b

Please sign in to comment.