Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 1.79 KB

build_test_update.md

File metadata and controls

51 lines (37 loc) · 1.79 KB
Raw

Updating TestGrid

If you need to add a new test that you want TestGrid to display, see TestGrid Configuration.

If you're looking to develop for TestGrid, welcome! Note that most of the inner workings of TestGrid are not open source. This is a known issue.

YAML configuration and config.proto

While TestGrid configuration is located in YAML files, TestGrid doesn't natively read YAML. Instead, it expects configuration data in config.proto. This file is commented, and should be treated as the authoritative "input" schema to TestGrid.

config.proto is generated primarily with Configurator. Updates to the testgrid.k8s.io config are automatically Configurated when a change is merged.

You can convert a yaml file to the config proto with:

go run ./testgrid/cmd/configurator \
  --yaml=testgrid/config.yaml \
  --print-text \
  --oneshot \
  --output=/tmp/config.pb \
  # Or push to gcs
  # --output=gs://my-bucket/config
  # --gcp-service-account=/path/to/foo.json

For our production instance of TestGrid (https://testgrid.k8s.io), this file is read to a Google Cloud Storage (GCS) location, and read from there.

Changing a .proto file

If you modify a .proto file, you'll also need to generate and check in the .pb.go files.

Run make update-protos to generate, and make run verify-protos to verify.

Testing

Run go test ./testgrid to run all unit tests in TestGrid. Note that this does not validate the testgrid.k8s.io config; those tests are in go test ./config/tests/testgrids

Run make test for repository-wide testing, such as ensuring that every job in our CI system appears somewhere in testgrid, etc.