COS tools: add .gitignore and a few testing instructions
This clarifies that `bazel` and `mtools` are required to run tests for
the COS tools repo, and that a `python` binary must be available on the
`$PATH`. It also mentions that ~10 K80 GPUs in us-west1 are needed to
successfully execute `./run_tests.sh`; my experience says that 5 is not
enough, but I'm told that 10 is.
The local Docker-build instructions for cos-customizer are also updated
to clarify that it refers to `//:cos_customizer`, not the target in the
same directory as the instructions,
`//src/cmd/cos_customizer:cos_customizer`.
Added a `.gitignore` file, as well, to exclude `bazel-*` directories at
the top level of the project from Git.
BUG=b/229419550
TEST=none; just doc updates
Change-Id: I0dc9065e76f78e5ffe91cdf0aaec0fc4619fa227
Reviewed-on: https://cos-review.googlesource.com/c/cos/tools/+/32100
Reviewed-by: Robert Kolchmeyer <rkolchmeyer@google.com>
Tested-by: Robert Kolchmeyer <rkolchmeyer@google.com>
Reviewed-by: Arnav Kansal <rnv@google.com>
Cloud-Build: GCB Service account <228075978874@cloudbuild.gserviceaccount.com>
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..ac51a05
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+bazel-*
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0edcdac..fc26035 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -38,6 +38,26 @@
The last command not only clones the repository but also adds a git pre-commit
hook that will be explained below in "Making changes".
+### Unit Testing
+
+Install `bazel` and `mtools`, and ensure `python` is an executable in your
+`$PATH`, pointing to a Python 3 binary. The full suite of unit tests can be
+initiated with
+
+```
+bazel test ...
+```
+
+### Integration Testing
+
+Ensure your Google Cloud project has ~10 K80 GPUs in us-west1; the
+`run_tests.sh` script will launch dozens of simultaneous builds in Cloud Build
+under the given project:
+
+```
+./run_tests.sh -p <GCP project name>
+```
+
## Making changes
The typical git workflow applies here. You can use `git checkout -b` to create a
diff --git a/run_tests.sh b/run_tests.sh
index adb961d..5835f13 100755
--- a/run_tests.sh
+++ b/run_tests.sh
@@ -22,7 +22,8 @@
usage() {
cat <<'EOF'
Usage: ./run_tests.sh [OPTION]
-run_tests.sh runs cos-customizer integration tests.
+run_tests.sh runs cos-customizer integration tests (20+ concurrent builds in
+Cloud Build). Minimum quota requirements include ~10 K80s in us-west1.
-p,--project=<project_name> GCP project to run tests in. Required.
EOF
diff --git a/src/cmd/cos_customizer/README.md b/src/cmd/cos_customizer/README.md
index 80d83d3..1ad9f4f 100644
--- a/src/cmd/cos_customizer/README.md
+++ b/src/cmd/cos_customizer/README.md
@@ -32,7 +32,7 @@
Alternatively, it can be built from source using [Bazel](https://bazel.build/).
To build COS customizer and load the image into Docker, run:
- $ bazel run :cos_customizer -- --norun
+ $ bazel run //:cos_customizer -- --norun
The COS Customizer docker image will then be available in Docker as
`bazel:cos_customizer`.
