From f64779cba784c4ea573d8cd7ff42a5850a57ce30 Mon Sep 17 00:00:00 2001 From: Ryan Richard Date: Fri, 18 Mar 2022 14:27:33 -0700 Subject: [PATCH 1/2] small updates to CONTRIBUTING.md --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ddef26d0..1351b6b5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -79,6 +79,13 @@ a Pull Request. For questions about the CLA process, see the [FAQ](https://cla.vmware.com/faq) or submit a question through the GitHub issue tracker. +## Learning about Pinniped + +New to Pinniped? +- Start here to learn how to install and use Pinniped: [Learn to use Pinniped for federated authentication to Kubernetes clusters](https://pinniped.dev/docs/tutorials/concierge-and-supervisor-demo/) +- Start here to learn how to navigate the source code: [Code Walk-through](https://pinniped.dev/docs/reference/code-walkthrough/) +- Other more detailed documentation can be found at: [Pinniped Docs](https://pinniped.dev/docs/) + ## Building The [Dockerfile](Dockerfile) at the root of the repo can be used to build and @@ -139,7 +146,7 @@ go build -o pinniped ./cmd/pinniped 1. Run the Pinniped integration tests: ```bash - source /tmp/integration-test-env && go test -v -count 1 -timeout 0 ./test/integration + ulimit -n 512 && source /tmp/integration-test-env && go test -v -count 1 -timeout 0 ./test/integration ``` 1. After making production code changes, recompile, redeploy, and run tests again by repeating the same From b1310877d8eceab8d34f21ccbc754126243c63b5 Mon Sep 17 00:00:00 2001 From: Ryan Richard Date: Mon, 21 Mar 2022 09:33:26 -0700 Subject: [PATCH 2/2] Add docs for how to run specific integration test(s) to CONTRIBUTING.md --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1351b6b5..73f93f3c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -149,6 +149,11 @@ go build -o pinniped ./cmd/pinniped ulimit -n 512 && source /tmp/integration-test-env && go test -v -count 1 -timeout 0 ./test/integration ``` + To run specific integration tests, add the `-run` flag to the above command to specify a regexp for the test names. + Use a leading `/` on the regexp because the Pinniped integration tests are automatically nested under several parent tests + (see [integration/main_test.go](https://github.com/vmware-tanzu/pinniped/blob/main/test/integration/main_test.go)). + For example, to run an integration test called `TestE2E`, add `-run /TestE2E` to the command shown above. + 1. After making production code changes, recompile, redeploy, and run tests again by repeating the same commands described above. If there are only test code changes, then simply run the tests again.