diff options
| author | TomSweeneyRedHat <tsweeney@redhat.com> | 2018-06-05 18:27:57 -0400 |
|---|---|---|
| committer | Atomic Bot <atomic-devel@projectatomic.io> | 2018-06-06 18:45:57 +0000 |
| commit | 781eec27b52c842fc83c8b1c97fbf825065f3b0c (patch) | |
| tree | 8900318f4cad2fa6c71897cdda5c351c3fee34cd | |
| parent | dedc7cc3296abc4f340d29effb693572ca2b7521 (diff) | |
| download | podman-781eec27b52c842fc83c8b1c97fbf825065f3b0c.tar.gz podman-781eec27b52c842fc83c8b1c97fbf825065f3b0c.tar.bz2 podman-781eec27b52c842fc83c8b1c97fbf825065f3b0c.zip | |
Add pointers for Integration Tests to docs
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
Closes: #910
Approved by: rhatdan
| -rw-r--r-- | CONTRIBUTING.md | 12 | ||||
| -rw-r--r-- | docs/tutorials/podman_tutorial.md | 6 | ||||
| -rw-r--r-- | test/README.md | 3 |
3 files changed, 19 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 684a2ab6e..8b0e99549 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,4 @@ + # Contributing to Libpod We'd love to have you join the community! Below summarizes the processes @@ -110,6 +111,17 @@ Use your real name (sorry, no pseudonyms or anonymous contributions.) If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with `git commit -s`. +### Integration Tests + +Our primary means of performing integration testing for libpod is with the +[Ginkgo](https://github.com/onsi/ginkgo) BDD testing framework. This allows +us to use native Golang to perform our tests and there is a strong affiliation +between Ginkgo and the Go test framework. Adequate test cases are expected to +be provided with PRs. + +For details on how to run the tests for Podman in your test environment, see the +Integration Tests [README.md](test/README.md). + ## Communications For general questions and discussion, please use the diff --git a/docs/tutorials/podman_tutorial.md b/docs/tutorials/podman_tutorial.md index 9ebab5f69..bde11fd53 100644 --- a/docs/tutorials/podman_tutorial.md +++ b/docs/tutorials/podman_tutorial.md @@ -163,7 +163,11 @@ To remove the httpd container: $ sudo podman rm --latest ``` You can verify the deletion of the container by running *podman ps -a*. + +## Integration Tests +For more information on how to setup and run the integration tests in your environment, checkout the Integration Tests [README.md](../../test/README.md) + ## More information -For more information on Podman and its subcommands, checkout the asciiart demos on the [README](https://github.com/projectatomic/libpod#commands) +For more information on Podman and its subcommands, checkout the asciiart demos on the [README.md](../../README.md#commands) page. diff --git a/test/README.md b/test/README.md index 9e7ae4577..a068bb4f5 100644 --- a/test/README.md +++ b/test/README.md @@ -1,4 +1,5 @@ -# Integration testing + +# Integration Tests Our primary means of performing integration testing for libpod is with the [Ginkgo](https://github.com/onsi/ginkgo) BDD testing framework. This allows |