ci: use groups of tests in gha (#15018)

* [no ci] use json for grouping packages for testing

* [no ci] able to get packages in group

* [no ci] able to run groups of tests

* [no ci] more

* [no ci] try disable circle unit tests

* ci: use actions/checkout@v3

* ci: rename to quick

* ci: need make dev in mods cache step

* ci: make compile step depend on checks step

* ci: bump consul and vault versions

* ci: need make dev for group tests

* ci: update ci unit testing docs

* docs: spell plumbing correctly

Co-authored-by: Tim Gross <tgross@hashicorp.com>

Co-authored-by: Tim Gross <tgross@hashicorp.com>
This commit is contained in:
Seth Hoenig 2022-10-27 09:02:58 -05:00 committed by GitHub
parent 28cd831085
commit 4f3a1e6f7d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 185 additions and 168 deletions

View File

@ -520,10 +520,6 @@ workflows:
- /^backport/docs-.*/ - /^backport/docs-.*/
- stable-website - stable-website
# Note: comment-out this job in ENT
- build-darwin-binaries:
filters: *backend_check_branches_filter
- test-e2e: - test-e2e:
filters: *backend_check_branches_filter filters: *backend_check_branches_filter
@ -546,51 +542,3 @@ workflows:
- /^backport/docs-.*/ - /^backport/docs-.*/
- /^e2e-.*/ - /^e2e-.*/
- stable-website - stable-website
- test-machine:
name: "test-client"
test_packages: "./client/..."
# test branches are the branches that can impact unit tests
filters: &backend_test_branches_filter
branches:
ignore:
- /^.-ui\b.*/
- /^docs-.*/
- /^backport/docs-.*/
- /^e2e-.*/
- stable-website
- test-machine:
name: "test-nomad"
test_packages: "./nomad/..."
filters: *backend_test_branches_filter
- test-machine:
# API Tests run in a VM rather than container due to the FS tests
# requiring `mount` priviliges.
name: "test-api"
test_module: "api"
filters: *backend_test_branches_filter
enable_race_testing: true
- test-machine:
name: "test-other"
exclude_packages: "./api|./client|./drivers/docker|./drivers/exec|./drivers/shared/executor|./nomad|./e2e"
filters: *backend_test_branches_filter
- test-machine:
name: "test-docker"
test_packages: "./drivers/docker"
executor: go-machine
filters: *backend_test_branches_filter
- test-machine:
name: "test-exec"
test_packages: "./drivers/exec"
filters: *backend_test_branches_filter
- test-machine:
name: "test-shared-exec"
test_packages: "./drivers/shared/executor"
filters: *backend_test_branches_filter
- test-machine:
name: "test-32bit"
# Currently we only explicitly test fingerprinting on 32bit
# architectures.
test_packages: "./client/fingerprint"
goarch: "386"
filters: *backend_test_branches_filter

View File

@ -25,8 +25,8 @@ env:
GO_VERSION: 1.19.1 GO_VERSION: 1.19.1
GOBIN: /usr/local/bin GOBIN: /usr/local/bin
GOTESTARCH: amd64 GOTESTARCH: amd64
CONSUL_VERSION: 1.11.3 CONSUL_VERSION: 1.12.6
VAULT_VERSION: 1.9.3 VAULT_VERSION: 1.12.0
NOMAD_SLOW_TEST: 0 NOMAD_SLOW_TEST: 0
NOMAD_TEST_LOG_LEVEL: OFF NOMAD_TEST_LOG_LEVEL: OFF
jobs: jobs:
@ -48,7 +48,7 @@ jobs:
runs-on: ubuntu-22.04 runs-on: ubuntu-22.04
timeout-minutes: 10 timeout-minutes: 10
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
with: with:
fetch-depth: 0 # needs tags for checkproto fetch-depth: 0 # needs tags for checkproto
- uses: magnetikonline/action-golang-cache@v1 - uses: magnetikonline/action-golang-cache@v1
@ -61,7 +61,7 @@ jobs:
make bootstrap make bootstrap
make check make check
compile: compile:
needs: [mods] needs: [mods, checks]
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
@ -69,7 +69,7 @@ jobs:
runs-on: ${{matrix.os}} runs-on: ${{matrix.os}}
timeout-minutes: 20 timeout-minutes: 20
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: magnetikonline/action-golang-cache@v1 - uses: magnetikonline/action-golang-cache@v1
with: with:
go-version: ${{env.GO_VERSION}} go-version: ${{env.GO_VERSION}}
@ -85,7 +85,7 @@ jobs:
runs-on: ubuntu-22.04 runs-on: ubuntu-22.04
timeout-minutes: 30 timeout-minutes: 30
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: magnetikonline/action-golang-cache@v1 - uses: magnetikonline/action-golang-cache@v1
with: with:
go-version: ${{env.GO_VERSION}} go-version: ${{env.GO_VERSION}}
@ -98,72 +98,34 @@ jobs:
make generate-all make generate-all
sudo sed -i 's!Defaults!#Defaults!g' /etc/sudoers sudo sed -i 's!Defaults!#Defaults!g' /etc/sudoers
sudo -E env "PATH=$PATH" make test-nomad-module sudo -E env "PATH=$PATH" make test-nomad-module
tests-pkgs: tests-groups:
needs: [mods] needs: [mods]
runs-on: ubuntu-22.04 runs-on: ubuntu-22.04
timeout-minutes: 30 timeout-minutes: 30
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
pkg: groups:
- acl/...
- client
- client/allocdir/...
- client/allochealth/...
- client/allocrunner/...
- client/allocwatcher/...
- client/config/...
- client/consul/...
- client/devicemanager/...
- client/dynamicplugins/...
- client/fingerprint/...
- client/interfaces/...
- client/lib/...
- client/logmon/...
- client/pluginmanager/...
- client/servers/...
- client/serviceregistration/...
- client/state/...
- client/stats/...
- client/structs/...
- client/taskenv/...
- command
- command/agent/...
- command/raft_tools/...
- drivers/docker/...
- drivers/exec/...
- drivers/java/...
- drivers/mock/...
- drivers/rawexec/...
- drivers/shared/...
- drivers/qemu/...
- helper/...
- internal/...
- jobspec/...
- lib/...
- nomad - nomad
- nomad/deploymentwatcher/... - client
- nomad/drainer/... - command
- nomad/state/... - drivers
- nomad/stream/... - quick
- nomad/structs/...
- nomad/volumewatcher/...
- plugins/...
- scheduler/...
- testutil/...
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: magnetikonline/action-golang-cache@v1 - uses: magnetikonline/action-golang-cache@v1
with: with:
go-version: ${{env.GO_VERSION}} go-version: ${{env.GO_VERSION}}
cache-key-suffix: -core cache-key-suffix: -core
- name: Run Matrix Tests - name: Run Matrix Tests
env: env:
GOTEST_PKGS: ./${{matrix.pkg}} GOTEST_GROUP: ${{matrix.groups}}
run: | run: |
make bootstrap make bootstrap
make generate-all make generate-all
make dev
sudo hc-install install -version ${{env.VAULT_VERSION}} -path /usr/local/bin vault sudo hc-install install -version ${{env.VAULT_VERSION}} -path /usr/local/bin vault
sudo hc-install install -version ${{env.CONSUL_VERSION}} -path /usr/local/bin consul sudo hc-install install -version ${{env.CONSUL_VERSION}} -path /usr/local/bin consul
sudo sed -i 's!Defaults!#Defaults!g' /etc/sudoers sudo sed -i 's!Defaults!#Defaults!g' /etc/sudoers
sudo -E env "PATH=$PATH" make test-nomad sudo -E env "PATH=$PATH" make test-nomad

3
.gitignore vendored
View File

@ -130,3 +130,6 @@ e2e/remotetasks/input/ecs.vars
# local terraform overrides # local terraform overrides
*.auto.tfvars *.auto.tfvars
# Tools files
tools/missing/missing

View File

@ -32,12 +32,6 @@ ifndef NOMAD_NO_UI
GO_TAGS := ui $(GO_TAGS) GO_TAGS := ui $(GO_TAGS)
endif endif
ifeq ($(origin GOTEST_PKGS_EXCLUDE), undefined)
GOTEST_PKGS ?= "./..."
else
GOTEST_PKGS=$(shell go list ./... | sed 's/github.com\/hashicorp\/nomad/./' | egrep -v "^($(GOTEST_PKGS_EXCLUDE))(/.*)?$$")
endif
# tag corresponding to latest release we maintain backward compatibility with # tag corresponding to latest release we maintain backward compatibility with
PROTO_COMPARE_TAG ?= v1.0.3$(if $(findstring ent,$(GO_TAGS)),+ent,) PROTO_COMPARE_TAG ?= v1.0.3$(if $(findstring ent,$(GO_TAGS)),+ent,)
@ -283,9 +277,11 @@ release: clean $(foreach t,$(ALL_TARGETS),pkg/$(t).zip) ## Build all release pac
@tree --dirsfirst $(PROJECT_ROOT)/pkg @tree --dirsfirst $(PROJECT_ROOT)/pkg
.PHONY: test-nomad .PHONY: test-nomad
test-nomad: dev ## Run Nomad unit tests test-nomad: GOTEST_PKGS=$(shell go run -modfile=tools/go.mod tools/missing/main.go ci/test-core.json $(GOTEST_GROUP))
@echo "==> Running Nomad unit tests $(GOTEST_PKGS)" test-nomad: # dev ## Run Nomad unit tests
gotestsum --format=testname --rerun-fails=3 --packages=$(GOTEST_PKGS) -- \ @echo "==> Running Nomad unit tests $(GOTEST_GROUP)"
@echo "==> with packages $(GOTEST_PKGS)"
gotestsum --format=testname --rerun-fails=3 --packages="$(GOTEST_PKGS)" -- \
-cover \ -cover \
-timeout=20m \ -timeout=20m \
-count=1 \ -count=1 \
@ -407,7 +403,7 @@ endif
.PHONY: missing .PHONY: missing
missing: ## Check for packages not being tested missing: ## Check for packages not being tested
@echo "==> Checking for packages not being tested ..." @echo "==> Checking for packages not being tested ..."
@go run -modfile tools/go.mod tools/missing/main.go .github/workflows/test-core.yaml @go run -modfile tools/go.mod tools/missing/main.go ci/test-core.json
.PHONY: ec2info .PHONY: ec2info
ec2info: ## Generate AWS EC2 CPU specification table ec2info: ## Generate AWS EC2 CPU specification table

34
ci/README.md Normal file
View File

@ -0,0 +1,34 @@
# CI (unit testing)
This README describes how the Core CI Tests Github Actions works, which provides
Nomad with continuous integration unit testing.
## Steps
1. When a branch is pushed, GHA triggers `.github/workflows/test-core.yaml`.
2. The first job is `mods` which creates a pre-cache of Go modules.
- Only useful for the followup jobs on Linux runners
- Is keyed on `hash(go.sum)`, so a cache is re-used until deps are modified.
3. The `checks`, `test-api`, `test-*` jobs are started.
- The checks job runs `make check`
- The test job runs groups of tests, see below
3i. The check step also runs `make missing`
- Invokes `tools/missing` to scan `ci/test-cores.json` && nomad source.
- Fails the build if any packages in Nomad are not covered.
4a. The `test-*` jobs are run.
- Configured as a matrix of "groups"; each group is a set of packages.
- The GHA invokes `test-nomad` with $GOTEST_GROUP for each group.
- The makefile uses `tools/missing` to translate the group into packages
- Package groups are configured in `ci/test-core.json`
4b. The `test-api` job is run.
- Because `api` is a submodule, invokation of test command is special.
- The GHA invokes `test-nomad-module` with the name of the submodule.
5. The `compile` jobs are run
- Waits on checks to complete first
- Runs on each of `linux`, `macos`, `windows`

45
ci/test-core.json Normal file
View File

@ -0,0 +1,45 @@
{
"nomad": ["nomad"],
"client": [
"client",
"client/allocrunner/..."
],
"command": ["command"],
"drivers": ["drivers/..."],
"quick": [
"acl/...",
"client/allocdir/...",
"client/allochealth/...",
"client/allocwatcher/...",
"client/config/...",
"client/consul/...",
"client/devicemanager/...",
"client/dynamicplugins/...",
"client/fingerprint/...",
"client/interfaces/...",
"client/lib/...",
"client/logmon/...",
"client/pluginmanager/...",
"client/servers/...",
"client/serviceregistration/...",
"client/state/...",
"client/stats/...",
"client/structs/...",
"client/taskenv/...",
"command/agent/...",
"command/raft_tools/...",
"helper/...",
"internal/...",
"jobspec/...",
"lib/...",
"nomad/deploymentwatcher/...",
"nomad/drainer/...",
"nomad/state/...",
"nomad/stream/...",
"nomad/structs/...",
"nomad/volumewatcher/...",
"plugins/...",
"scheduler/...",
"testutil/..."
]
}

View File

@ -6,22 +6,25 @@ demonstrating correct functionality.
Each unit test should meet a few criteria: Each unit test should meet a few criteria:
- Use testify - Use [github.com/shoenig/test](https://github.com/shoenig/test)
- Prefer using require.* functions - Prefer using `must.*`` functions
- Use `test.*`` functions when cleanup must happen, etc
- Feel free to refactor testify tests; but consider separate commits / PRs
- Undo any changes to the environment - Undo any changes to the environment
- Set environment variables must be unset - Set environment variables must be unset (use `t.Setenv`)
- Scratch files/dirs must be removed (use t.TempDir) - Scratch files/dirs must be removed (use `t.TempDir`)
- Consumed ports must be freed (e.g. TestServer.Cleanup, freeport.Return) - Consumed ports must be freed (e.g. `TestServer.Cleanup`, `freeport.Return`)
- Able to run in parallel - Able to run in parallel
- All package level Test* functions should start with ci.Parallel - All package level `Test*` functions should start with `ci.Parallel`
- Always use dynamic scratch dirs, files - Always use dynamic scratch dirs, files
- Always get ports from helpers (TestServer, TestClient, TestAgent, freeport.Get) - Always get ports from helpers (`TestServer`, `TestClient`, `TestAgent`, `freeport.Get`)
- Log control - Log control
- Logging must go through the testing.T (use helper/testlog.HCLogger) - Logging must go through the `testing.T` (use `helper/testlog.HCLogger`)
- Avoid excessive logging in test cases - prefer failure messages - Avoid excessive logging in test cases - prefer failure messages
- Annotate failures with `must.Sprint\f` post-scripts
## API tests ## API tests
@ -29,3 +32,9 @@ Testing in the `api` package requires an already-built Nomad
binary. If you're writing `api` tests, you'll need to build a Nomad binary. If you're writing `api` tests, you'll need to build a Nomad
binary (ex. with `make dev`) that includes any changes your API binary (ex. with `make dev`) that includes any changes your API
exercises. exercises.
# CI Plumbing
See [ci/README.md] for details on how the [Core CI Tests](https://github.com/hashicorp/nomad/actions/workflows/test-core.yaml)
Github Action works.

View File

@ -4,13 +4,11 @@ go 1.18
require ( require (
github.com/aws/aws-sdk-go v1.37.26 github.com/aws/aws-sdk-go v1.37.26
github.com/stretchr/testify v1.7.1 github.com/hashicorp/go-set v0.1.6
gopkg.in/yaml.v2 v2.2.8 github.com/shoenig/test v0.4.0
) )
require ( require (
github.com/davecgh/go-spew v1.1.0 // indirect github.com/google/go-cmp v0.5.8 // indirect
github.com/jmespath/go-jmespath v0.4.0 // indirect github.com/jmespath/go-jmespath v0.4.0 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c // indirect
) )

View File

@ -2,6 +2,10 @@ github.com/aws/aws-sdk-go v1.37.26 h1:D9Qvyjlr6xFR0CspZ0imdASc5Y1WE/Sgyte4l+cUp4
github.com/aws/aws-sdk-go v1.37.26/go.mod h1:hcU610XS61/+aQV88ixoOzUoG7v3b31pl2zKMmprdro= github.com/aws/aws-sdk-go v1.37.26/go.mod h1:hcU610XS61/+aQV88ixoOzUoG7v3b31pl2zKMmprdro=
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/google/go-cmp v0.5.8 h1:e6P7q2lk1O+qJJb4BtCQXlK8vWEO8V1ZeuEdJNOqZyg=
github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
github.com/hashicorp/go-set v0.1.6 h1:fj/JG5B97sAOd9OQN4GL880yCE384fz3asNDpGbxkPo=
github.com/hashicorp/go-set v0.1.6/go.mod h1:ELvMcE+1mRHYPVgTFSQiecObIwZRxY5Q11EhbtmM5KQ=
github.com/jmespath/go-jmespath v0.4.0 h1:BEgLn5cpjn8UN1mAw4NjwDrS35OdebyEtFe+9YPoQUg= github.com/jmespath/go-jmespath v0.4.0 h1:BEgLn5cpjn8UN1mAw4NjwDrS35OdebyEtFe+9YPoQUg=
github.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo= github.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo=
github.com/jmespath/go-jmespath/internal/testify v1.5.1 h1:shLQSRRSCCPj3f2gpwzGwWFoC7ycTf1rcQZHOlsJ6N8= github.com/jmespath/go-jmespath/internal/testify v1.5.1 h1:shLQSRRSCCPj3f2gpwzGwWFoC7ycTf1rcQZHOlsJ6N8=
@ -9,9 +13,9 @@ github.com/jmespath/go-jmespath/internal/testify v1.5.1/go.mod h1:L3OGu8Wl2/fWfC
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/shoenig/test v0.4.0 h1:3X4xG/Chx7mzi0h71Sm6Vo38q0EYaQIBZpYFRcA1HVM=
github.com/shoenig/test v0.4.0/go.mod h1:xYtyGBC5Q3kzCNyJg/SjgNpfAa2kvmgA0i5+lQso8x0=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.7.1 h1:5TQK59W5E3v0r2duFAb7P95B6hEeOyEnHRa8MjYSMTY=
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
@ -22,9 +26,6 @@ golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7w
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10= gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10=
gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

View File

@ -1,6 +1,7 @@
package main package main
import ( import (
"encoding/json"
"errors" "errors"
"fmt" "fmt"
"io" "io"
@ -10,7 +11,7 @@ import (
"sort" "sort"
"strings" "strings"
"gopkg.in/yaml.v2" "github.com/hashicorp/go-set"
) )
func main() { func main() {
@ -20,21 +21,28 @@ func main() {
} }
} }
type YamlFile struct { // Manifest represents groupings of packages for testing
Jobs struct { // see: ci/test-core.json
TestPackages struct { type Manifest map[string][]string
Strategy struct {
Matrix struct { func (m Manifest) covers(pkg string) bool {
Packages []string `yaml:"pkg"` for _, list := range m {
} `yaml:"matrix"` if isCovered(list, pkg) {
} `yaml:"strategy"` return true
} `yaml:"tests-pkgs"` }
} `yaml:"jobs"` }
return false
} }
const (
verify = 1
group = 2
)
func run(args []string) error { func run(args []string) error {
if len(args) != 1 { mode := len(args)
return errors.New("requires filename") if !(mode == verify || mode == group) {
return errors.New("usage: [filename] <group>")
} }
f, err := os.Open(args[0]) f, err := os.Open(args[0])
@ -45,11 +53,22 @@ func run(args []string) error {
_ = f.Close() _ = f.Close()
}() }()
coverage, err := inMatrix(f) manifest, err := getManifest(f)
if err != nil { if err != nil {
return err return err
} }
switch mode {
case verify:
return runVerify(manifest)
case group:
return runGroups(manifest, args[1])
default:
panic("oops")
}
}
func runVerify(manifest Manifest) error {
packages, err := inCode(".") packages, err := inCode(".")
if err != nil { if err != nil {
return err return err
@ -57,7 +76,7 @@ func run(args []string) error {
var isMissing []string var isMissing []string
for _, pkg := range packages { for _, pkg := range packages {
if !isCovered(coverage, pkg) { if !manifest.covers(pkg) {
isMissing = append(isMissing, pkg) isMissing = append(isMissing, pkg)
} }
} }
@ -74,7 +93,17 @@ func run(args []string) error {
return nil return nil
} }
// isCovered returns true if pkg is covered by a package in coverage. func runGroups(manifest Manifest, group string) error {
list := manifest[group]
for i := 0; i < len(list); i++ {
list[i] = "./" + list[i]
}
s := strings.Join(list, " ")
fmt.Print(s)
return nil
}
// isCovered returns true if pkg is tested by directory in manifest.
func isCovered(coverage []string, pkg string) bool { func isCovered(coverage []string, pkg string) bool {
for _, p := range coverage { for _, p := range coverage {
if isCoveredOne(p, pkg) { if isCoveredOne(p, pkg) {
@ -101,19 +130,14 @@ func isCoveredOne(p string, pkg string) bool {
return false return false
} }
func inMatrix(r io.Reader) ([]string, error) { func getManifest(r io.Reader) (Manifest, error) {
var yFile YamlFile m := make(Manifest)
if err := yaml.NewDecoder(r).Decode(&yFile); err != nil { if err := json.NewDecoder(r).Decode(&m); err != nil {
return nil, err return nil, err
} }
p := yFile.Jobs.TestPackages.Strategy.Matrix.Packages return m, nil
return p, nil
} }
type nothing struct{}
var null = nothing{}
// uninteresting lists remaining packages that contain Go code but still // uninteresting lists remaining packages that contain Go code but still
// do not need to be covered by test cases. // do not need to be covered by test cases.
var uninteresting = []string{ var uninteresting = []string{
@ -147,7 +171,7 @@ func skip(p string) bool {
} }
func inCode(root string) ([]string, error) { func inCode(root string) ([]string, error) {
m := map[string]nothing{} pkgs := set.New[string](100)
err := filepath.Walk(root, func(path string, info fs.FileInfo, err error) error { err := filepath.Walk(root, func(path string, info fs.FileInfo, err error) error {
if info.IsDir() { if info.IsDir() {
@ -159,7 +183,7 @@ func inCode(root string) ([]string, error) {
} }
if ext := filepath.Ext(path); ext == ".go" { if ext := filepath.Ext(path); ext == ".go" {
m[filepath.Dir(path)] = null pkgs.Insert(filepath.Dir(path))
} }
return nil return nil
@ -168,12 +192,9 @@ func inCode(root string) ([]string, error) {
return nil, err return nil, err
} }
delete(m, ".") // package main pkgs.Remove(".") // main
var packages []string packages := pkgs.List()
for p := range m {
packages = append(packages, p)
}
sort.Strings(packages) sort.Strings(packages)
return packages, nil return packages, nil
} }

View File

@ -3,13 +3,13 @@ package main
import ( import (
"testing" "testing"
"github.com/stretchr/testify/require" "github.com/shoenig/test/must"
) )
func Test_isCoveredOne(t *testing.T) { func Test_isCoveredOne(t *testing.T) {
try := func(p string, exp bool) { try := func(p string, exp bool) {
result := isCoveredOne(p, "foo/bar") result := isCoveredOne(p, "foo/bar")
require.Equal(t, exp, result) must.Eq(t, exp, result)
} }
try("baz", false) try("baz", false)
try("foo", false) try("foo", false)