From af328fe413b84025864bf557efebc0698e3d8909 Mon Sep 17 00:00:00 2001 From: Justin Chadwell Date: Thu, 1 Jun 2023 11:34:20 +0100 Subject: [PATCH] docs: update CONTRIBUTING.md with specific test notes Signed-off-by: Justin Chadwell --- .github/CONTRIBUTING.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9a3fdfab..b7a79991 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -138,7 +138,13 @@ make test-integration TESTPKGS=./bake make test # run all integration tests with a specific worker -TESTFLAGS="--run=//worker=docker-container -v" make test +TESTFLAGS="--run=//worker=remote -v" make test-integration + +# run a specific integration test +TESTFLAGS="--run /TestBuild/worker=remote/ -v" make test-integration + +# run a selection of integration tests using a regexp +TESTFLAGS="--run /TestBuild.*/worker=remote/ -v" make test-integration ``` > **Note** @@ -147,12 +153,23 @@ TESTFLAGS="--run=//worker=docker-container -v" make test > images in a docker volume if you are repeatedly calling `make test`. This > helps to avoid rate limiting on the remote registry side. +> **Note** +> +> Set `TEST_DOCKERD=1` for the test framework to enable the docker workers, +> specifically the `docker` and `docker-container` drivers. +> +> The docker tests cannot be run in parallel, so require passing `--parallel=1` +> in `TESTFLAGS`. + > **Note** > > If you are working behind a proxy, you can set some of or all > `HTTP_PROXY=http://ip:port`, `HTTPS_PROXY=http://ip:port`, `NO_PROXY=http://ip:port` > for the test framework to specify the proxy build args. + +### Run the helper commands + To enter a demo container environment and experiment, you may run: ```