Skip to content

Commit

Permalink
Add docs for how to run molecule tests with kind (#1375)
Browse files Browse the repository at this point in the history
- test-local docker scenario was removed in 9a54ae2
  • Loading branch information
rooftopcellist authored Apr 20, 2023
1 parent d914edf commit d0205f4
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Have questions about this document or anything not covered here? Please file a n
```
2. Make your changes.
3. Test your changes according described on the Testing section.
4. If everylooks looks correct, commit your changes.
4. If everything looks correct, commit your changes.
```sh
#> git add <FILES>
#> git commit -m "My message here"
Expand All @@ -56,14 +56,17 @@ Running `molecule test` sets up a clean environment, builds the operator, runs a

If you want to actively develop the operator, use `molecule converge`, which does everything but tear down the environment at the end.

#### Testing in Docker
#### Testing in Kind

Testing with a kind cluster is the recommended way to test the awx-operator locally. First, you need to install kind if you haven't already. Please see these docs for setting that up:
* https://kind.sigs.k8s.io/docs/user/quick-start/

To run the tests, from the root of your checkout, run the following command:

```sh
#> molecule test -s test-local
#> molecule test -s kind
```

This environment is meant for headless testing (e.g. in a CI environment, or when making smaller changes which don't need to be verified through a web interface). It is difficult to test things like AWX's web UI or to connect other applications on your local machine to the services running inside the cluster, since it is inside a Docker container with no static IP address.

#### Testing in Minikube

```sh
Expand Down Expand Up @@ -137,4 +140,4 @@ Applying this template will do it. Once the CatalogSource is in a READY state, t

## Reporting Issues

We welcome your feedback, and encourage you to file an issue when you run into a problem.
We welcome your feedback, and encourage you to file an issue when you run into a problem.

0 comments on commit d0205f4

Please sign in to comment.