Skip to content

docs: Add documentation to run the RATS on you CF on KIND setup #81

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

Open
ZPascal wants to merge 2 commits into
base: main
Choose a base branch
from
+9 −3
Open

docs: Add documentation to run the RATS on you CF on KIND setup #81

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2768a92
docs: Add documentation to run the RATS on you CF on KIND setup
ZPascal Mar 21, 2026
91f3043
docs: Update the documentation
ZPascal Mar 25, 2026
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
12 changes: 9 additions & 3 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ git clone https://github.com/cloudfoundry/routing-release.git --recursive
cd routing-release
```

Running Tests
Running Unit and Integration Tests
---------------

> [!TIP]
Expand All @@ -58,7 +58,7 @@ script can be used for interactive development with a long running container.
- `./scripts/test-in-docker.bash`: Create docker container and run all tests and setup in a single script.
- `./scripts/test-in-docker.bash <package> <sub-package>`: For running tests under a specific package and/or sub-package

When inside docker container:
When inside a docker container:

- `/repo/scripts/docker/build-binaries.bash`: (REQUIRED) This will build required binaries for running tests.
- `/repo/scripts/docker/test.bash`: This will run all tests in this repo.
Expand All @@ -68,4 +68,10 @@ When inside docker container:
- `/repo/scripts/docker/lint.bash`: This will run required linters.

> [!IMPORTANT]
> If you are about to submit a PR, please make sure to run `./scripts/test-in-docker.bash` for MySQL and Postgres to ensure everything is tested in clean container. If you are developing, you can create create a docker container first, then the only required script to run before testing your specific component is `build-binaries.bash`.
> If you are about to submit a PR, please make sure to run `DB=mysql ./scripts/test-in-docker.bash` (for MySQL) or `DB=postgres ./scripts/test-in-docker.bash` (for Postgres) to ensure everything is tested in a clean environment. If you are developing, you can create a docker container first. In this case, the script `build-binaries.bash` must be executed before testing your specific component.

Running Routing Acceptance Tests (RATS)
---------------

For detailed documentation on how to run Routing Acceptance Tests (RATS) on your local machine, see the [Guide to Running Routing Acceptance Tests (RATS)](https://github.com/cloudfoundry/routing-release/tree/develop/src/code.cloudfoundry.org/routing-acceptance-tests/docs/running-acceptance-tests.md). There you will find detailed instructions for local testing with CF-on-Kind.