Skip to content

Commit

Permalink
README.md: expand requirements for running system tests
Browse files Browse the repository at this point in the history
- Note that cf cli v8 is now required
- Note that external apps must be cloned to the local environment
- Clean up formatting slightly

[#184260867](https://www.pivotaltracker.com/story/show/184260867)

Co-authored-by: Andrew Garner <[email protected]>
Co-authored-by: Kim Bassett <[email protected]>
  • Loading branch information
abg and kimago committed Jul 24, 2023
1 parent c9f0fb1 commit 258c567
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions system_tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,23 @@ System tests are end-to-end tests that validate specific broker behaviours by us

Running the tests:
- Locally
- These tests require cf cli v6, tests may fail under newer cli versions.
- These are time-consuming and should be run locally only when making changes on a specific
- You should first claim a bosh-lite environment by running:
- These tests require cf cli v8, tests may fail under older cli versions.
- The system tests require a cf-redis-example-app is cloned locally in ~/workspace/cf-redis-example-app.
- The system tests require a cf-kafka-example-app is cloned locally in ~/workspace/cf-kafka-example-app.
- Running these tests are time-consuming, and it may be prudent to only run the system tests relevant to the feature you are working on.
- You should first claim a bosh-lite environment maintained by your CI environment, perhaps with the following commands:

```
claim-lite
target-lite <env-name>
```
```
$ claim-lite
$ target-lite <env-name>
```


- From the `on-demand-service-broker` repo run

```
./system_tests/run_system_tests_bosh_lite.sh <test-name>
```
```
./system_tests/run_system_tests_bosh_lite.sh <test-name>
```

- In CI

These tests are run on bosh-lites on every commit in the [ODB pipeline](https://dedicated-mysql.ci.cf-app.com/teams/main/pipelines/odb).
In CI, these tests are run on bosh-lites on every commit in the [ODB pipeline](https://dedicated-mysql.ci.cf-app.com/teams/main/pipelines/odb).

0 comments on commit 258c567

Please sign in to comment.