# test-infra

**Repository Path**: mirrors_harlowja/test-infra

## Basic Information

- **Project Name**: test-infra
- **Description**: Test infrastructure for the Kubernetes project.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-01-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Kubernetes Test Infrastructure

[![Build Status](https://travis-ci.org/kubernetes/test-infra.svg?branch=master)](https://travis-ci.org/kubernetes/test-infra)  [![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes/test-infra)](https://goreportcard.com/report/github.com/kubernetes/test-infra)  [![GoDoc](https://godoc.org/github.com/kubernetes/test-infra?status.svg)](https://godoc.org/github.com/kubernetes/test-infra)

The test-infra repository contains a collection of tools for testing Kubernetes
and displaying Kubernetes tests results. See also [CONTRIBUTING.md](CONTRIBUTING.md).

See the [architecture diagram](docs/architecture.svg) for an overview of how
the different services interact.

## Viewing test results

* The [Kubernetes TestGrid](https://k8s-testgrid.appspot.com/) shows historical test results
  - Configure your own testgrid dashboard at [testgrid/config.yaml](testgrid/config.yaml)
  - [Gubernator](https://k8s-gubernator.appspot.com/) formats the output of each run
* [PR Dashboard](https://k8s-gubernator.appspot.com/pr) finds PRs that need your attention
* [Prow](https://prow.k8s.io) schedules testing and updates issues
  - Prow responds to GitHub events, timers and [manual commands](https://go.k8s.io/bot-commands)
    given in GitHub comments.
  - The [prow dashboard](https://prow.k8s.io/) shows what it is currently testing
  - Configure prow to run new tests at [prow/config.yaml](prow/config.yaml)
* [Triage Dashboard](https://go.k8s.io/triage) aggregates failures
  - Triage clusters together similar failures
  - Search for test failures across jobs
  - Filter down failures in a specific regex of tests and/or jobs
* [Velodrome metrics](http://velodrome.k8s.io/dashboard/db/bigquery-metrics?orgId=1) track job and test health.
  - [Kettle](kettle) does collection, [metrics](metrics) does reporting, and [velodrome](velodrome) is the frontend.

## Automated testing

Test anything with the following pattern:

```
git clone https://github.com/kubernetes/test-infra
test-infra/jenkins/bootstrap.py --job=J --repo=R --service-account=S.json --upload=gs://B
```

The `--job=J` flag specifies what test job to run.
The `--repo=R` (or `--bare`) flag controls what we check out from git.

Anyone can reconfigure our CI system with a test-infra PR that updates the
appropriate files. Detailed instructions follow:

### E2E Testing

Our e2e testing uses [kubetest](/kubetest) to build/deploy/test kubernetes
clusters on various providers. Please see those documents for additional details
about this tool as well as e2e testing generally.

### Create a new job

Create a PR in this repo to add/update/remove a job or suite. Specifically
you'll need to do the following:
* Create an entry in [`jobs/config.json`] for the job
  - If this is a kubetest job create the corresponding `jobs/env/FOO.env` file
  - It will pick a free project from [boskos](/boskos) pool by default, or
  - You can also set --gcp-project=foo in [`jobs/config.json`] for a dedicated project, make sure the project has the right [IAM grants](jenkins/check_projects.py)
* Add the job name to the `test_groups` list in [`testgrid/config.yaml`](testgrid/config.yaml)
  - Also the group to at least one `dashboard_tab`
* Add the job to the appropriate section in [`prow/config.yaml`](prow/config.yaml)
  - Presubmit jobs run on unmerged code in PRs
  - Postsubmit jobs run after merging code
  - Periodic job run on a timed basis

The configs need to be sorted and kubernetes must be in sync with the security repo, or else presubmit will fail.
You can run the script below to keep them valid:
```
hack/update-config.sh
```

NOTE: `kubernetes/kubernetes` and `kubernetes-security/kubernetes` must have matching presubmits.

Please test the job on your local workstation before creating a PR:
```
mkdir /tmp/whatever && cd /tmp/whatever
$GOPATH/src/k8s.io/test-infra/jenkins/bootstrap.py \
  --job=J \  # aka your new job
  --repo=R1 --repo=R2 \  # what repos to check out
  --service-account ~/S.json  # the service account to use to launch GCE/GKE clusters
# Note: create a service account at the cloud console for the project J uses
```

#### Release branch jobs & Image validation jobs

Release branch jobs and image validation jobs are defined in [test_config.yaml](experiment/test_config.yaml).
We test different master/node image versions against multiple k8s branches on different features.

Those jobs are using channel based versions, current supported testing map is:
- k8s-dev : master
- k8s-beta : release-1.11
- k8s-stable1 : release-1.10
- k8s-stable2 : release-1.9
- k8s-stable3 : release-1.8

Our build job will generate a ci/(channel-name) file pointer in gcs.

After you update [test_config.yaml](experiment/test_config.yaml), please run

```
bazel run //experiment:generate_tests -- --yaml-config-path=experiment/test_config.yaml --json-config-path=jobs/config.json  --prow-config-path=prow/config.yaml && bazel run //jobs:config_sort
```

to regenerate the job configs.

We are moving towards making more jobs to fit into the generated config.


Presubmit will tell you if you forget to do any of this correctly.

Merge your PR and [@k8s-ci-robot] will deploy your change automatically.

### Update an existing job

Largely similar to creating a new job, except you can just modify the existing
entries rather than adding new ones.

Update what a job does by editing its definition in [`jobs/config.json`]. For
the kubetest jobs this typically means editing the `jobs/FOO.env` files it uses.

Update when a job runs by changing its definition in [`prow/config.yaml`].
The [test-infra oncall] must push prow changes (`make -C prow update-config`).

Update where the job appears on testgrid by changing [`testgrid/config.yaml`].

### Delete a job

The reverse of creating a new job: delete the appropriate entries in
[`jobs/config.json`], [`prow/config.yaml`] and [`testgrid/config.yaml`].

Merge your PR and [@k8s-ci-robot] will deploy your change automatically.

## Building and testing the test-infra

We use [Bazel](https://www.bazel.io/) to build and test the code in this repo.
The commands `bazel build //...` and `bazel test //...` should be all you need
for most cases. If you modify Go code, run `./hack/update-bazel.sh` to keep
`BUILD.bazel` files up-to-date.

## Contributing Test Results

The Kubernetes project encourages organizations to contribute execution of e2e
test jobs for a variety of platforms (e.g., Azure, rktnetes). For information about
how to contribute test results, see [Contributing Test Results](docs/contributing-test-results.md).

## Other Docs

* [kubernetes/test-infra dependency management](docs/dep.md)


[`jobs/config.json`]: /jobs/config.json
[`prow/config.yaml`]: /prow/config.yaml
[`testgrid/config.yaml`]: /testgrid/config.yaml
[test-infra oncall]: https://go.k8s.io/oncall
[@k8s-ci-robot]: (https://github.com/k8s-ci-robot)