kubernetes/test/e2e
Patrick Ohly 136f89dfc5 e2e: use error wrapping with %w
The recently introduced failure handling in ExpectNoError depends on error
wrapping: if an error prefix gets added with `fmt.Errorf("foo: %v", err)`, then
ExpectNoError cannot detect that the root cause is an assertion failure and
then will add another useless "unexpected error" prefix and will not dump the
additional failure information (currently the backtrace inside the E2E
framework).

Instead of manually deciding on a case-by-case basis where %w is needed, all
error wrapping was updated automatically with

    sed -i "s/fmt.Errorf\(.*\): '*\(%s\|%v\)'*\",\(.* err)\)/fmt.Errorf\1: %w\",\3/" $(git grep -l 'fmt.Errorf' test/e2e*)

This may be unnecessary in some cases, but it's not wrong.
2023-02-06 15:39:13 +01:00
..
apimachinery e2e: use error wrapping with %w 2023-02-06 15:39:13 +01:00
apps e2e: use error wrapping with %w 2023-02-06 15:39:13 +01:00
architecture e2e: use Ginkgo context 2022-12-16 20:14:04 +01:00
auth e2e: use error wrapping with %w 2023-02-06 15:39:13 +01:00
autoscaling e2e: use error wrapping with %w 2023-02-06 15:39:13 +01:00
chaosmonkey e2e: use Ginkgo context 2022-12-16 20:14:04 +01:00
cloud e2e: use error wrapping with %w 2023-02-06 15:39:13 +01:00
common e2e: use error wrapping with %w 2023-02-06 15:39:13 +01:00
dra e2e: use error wrapping with %w 2023-02-06 15:39:13 +01:00
framework e2e: use error wrapping with %w 2023-02-06 15:39:13 +01:00
instrumentation e2e: use error wrapping with %w 2023-02-06 15:39:13 +01:00
kubectl e2e: use error wrapping with %w 2023-02-06 15:39:13 +01:00
lifecycle e2e: use Ginkgo context 2022-12-16 20:14:04 +01:00
network e2e: use error wrapping with %w 2023-02-06 15:39:13 +01:00
node Don't explicitly set image version in tests 2023-02-02 19:06:00 +01:00
perftype hack/update-bazel.sh 2021-02-28 15:17:29 -08:00
reporters e2e: comment the known limitation of the ProgressReporter 2022-12-23 18:43:49 +08:00
scheduling e2e: use error wrapping with %w 2023-02-06 15:39:13 +01:00
storage e2e: use error wrapping with %w 2023-02-06 15:39:13 +01:00
testing-manifests Updating pause image refernces to 3.9 2022-11-14 10:24:54 -08:00
upgrades e2e: use error wrapping with %w 2023-02-06 15:39:13 +01:00
windows e2e: use error wrapping with %w 2023-02-06 15:39:13 +01:00
e2e_test.go Merge pull request #114417 from chendave/ginkgo_fix_spec 2023-01-12 03:28:56 -08:00
e2e-example-config.json
e2e.go e2e: remove unused label filter from WaitForPodsRunningReady 2023-02-06 15:39:12 +01:00
README.md e2e: accept context from Ginkgo 2022-12-10 19:50:18 +01:00
suites.go e2e: use error wrapping with %w 2023-02-06 15:39:13 +01:00

test/e2e

This is home to e2e tests used for presubmit, periodic, and postsubmit jobs.

Some of these jobs are merge-blocking, some are release-blocking.

e2e test ownership

All e2e tests must adhere to the following policies:

  • the test must be owned by one and only one SIG
  • the test must live in/underneath a sig-owned package matching pattern: test/e2e/[{subpath}/]{sig}/..., e.g.
    • test/e2e/auth - all tests owned by sig-auth
    • test/e2e/common/storage - all tests common to cluster-level and node-level e2e tests, owned by sig-node
    • test/e2e/upgrade/apps - all tests used in upgrade testing, owned by sig-apps
  • each sig-owned package should have an OWNERS file defining relevant approvers and labels for the owning sig, e.g.
# test/e2e/node/OWNERS
# See the OWNERS docs at https://go.k8s.io/owners

approvers:
- alice
- bob
- cynthia
emeritus_approvers:
- dave
reviewers:
- sig-node-reviewers
labels:
- sig/node
  • packages that use {subpath} should have an imports.go file importing sig-owned packages (for ginkgo's benefit), e.g.
// test/e2e/common/imports.go
package common

import (
	// ensure these packages are scanned by ginkgo for e2e tests
	_ "k8s.io/kubernetes/test/e2e/common/network"
	_ "k8s.io/kubernetes/test/e2e/common/node"
	_ "k8s.io/kubernetes/test/e2e/common/storage"
)
  • test ownership must be declared via a top-level SIGDescribe call defined in the sig-owned package, e.g.
// test/e2e/lifecycle/framework.go
package lifecycle

import "github.com/onsi/ginkgo"

// SIGDescribe annotates the test with the SIG label.
func SIGDescribe(text string, body func()) bool {
	return ginkgo.Describe("[sig-cluster-lifecycle] "+text, body)
}
// test/e2e/lifecycle/bootstrap/bootstrap_signer.go

package bootstrap

import (
	"github.com/onsi/ginkgo"
	"k8s.io/kubernetes/test/e2e/lifecycle"
)
var _ = lifecycle.SIGDescribe("[Feature:BootstrapTokens]", func() {
  /* ... */
  ginkgo.It("should sign the new added bootstrap tokens", func(ctx context.Context) {
    /* ... */
  })
  /* etc */
})

These polices are enforced:

  • via the merge-blocking presubmit job pull-kubernetes-verify
  • which ends up running hack/verify-e2e-test-ownership.sh
  • which can also be run via make verify WHAT=e2e-test-ownership

more info

See kubernetes/community/.../e2e-tests.md