ceph-csi/vendor/k8s.io/kubernetes/test/e2e/framework
Madhu Rajanna e727bd351e rebase: update kubernetes to 1.30
updating kubernetes to 1.30 release

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2024-05-24 09:27:53 +00:00
..
config rebase: update kubernetes to 1.28.0 in main 2023-08-17 13:43:15 +00:00
debug rebase: update kubernetes to 1.28.0 in main 2023-08-17 13:43:15 +00:00
internal/junit rebase: bump the golang-dependencies group with 1 update 2023-12-21 13:34:39 +00:00
kubectl rebase: update kubernetes to 1.28.0 in main 2023-08-17 13:43:15 +00:00
metrics rebase: bump the golang-dependencies group with 1 update 2023-12-21 13:34:39 +00:00
node rebase: bump the golang-dependencies group with 1 update 2023-12-21 13:34:39 +00:00
pod rebase: update kubernetes to 1.30 2024-05-24 09:27:53 +00:00
pv rebase: bump the golang-dependencies group with 1 update 2023-12-21 13:34:39 +00:00
skipper rebase: update kubernetes to 1.30 2024-05-24 09:27:53 +00:00
ssh rebase: bump the golang-dependencies group with 1 update 2023-12-21 13:34:39 +00:00
testfiles rebase: bump the golang-dependencies group with 3 updates 2024-05-07 10:06:02 +00:00
volume rebase: bump the golang-dependencies group with 1 update 2023-12-21 13:34:39 +00:00
.import-restrictions rebase: bump the golang-dependencies group with 1 update 2023-12-21 13:34:39 +00:00
bugs.go rebase: bump the golang-dependencies group with 1 update 2023-12-21 13:34:39 +00:00
expect.go rebase: update kubernetes to 1.30 2024-05-24 09:27:53 +00:00
flake_reporting_util.go rebase: update kubernetes to v1.25.0 2022-08-25 16:36:35 +00:00
framework.go rebase: update kubernetes to 1.30 2024-05-24 09:27:53 +00:00
get.go rebase: bump github.com/aws/aws-sdk-go from 1.44.281 to 1.44.285 2023-06-20 08:50:10 +00:00
ginkgologger.go rebase: update kubernetes to 1.30 2024-05-24 09:27:53 +00:00
ginkgowrapper.go rebase: update kubernetes to 1.30 2024-05-24 09:27:53 +00:00
log.go rebase: update kubernetes to 1.30 2024-05-24 09:27:53 +00:00
namespacedname.go rebase: bump k8s.io/kubernetes from 1.26.2 to 1.27.2 2023-06-06 12:21:43 +00:00
nodes_util.go rebase: update kubernetes to 1.26.1 2023-02-03 08:55:43 +00:00
OWNERS rebase: bump the golang-dependencies group with 1 update 2023-12-21 13:34:39 +00:00
ports.go rebase: update kubernetes and libraries to v1.22.0 version 2021-08-12 09:55:50 +00:00
provider_less.go rebase: update kubernetes to 1.30 2024-05-24 09:27:53 +00:00
provider.go rebase: bump k8s.io/kubernetes from 1.26.2 to 1.27.2 2023-06-06 12:21:43 +00:00
README.md rebase: bump the golang-dependencies group with 1 update 2023-12-21 13:34:39 +00:00
size.go Update to kube v1.17 2020-01-17 12:06:02 +00:00
test_context.go rebase: update kubernetes to 1.30 2024-05-24 09:27:53 +00:00
timeouts.go rebase: bump the golang-dependencies group with 1 update 2023-12-21 13:34:39 +00:00
util.go rebase: bump the golang-dependencies group with 1 update 2023-12-21 13:34:39 +00:00

Overview

The Kubernetes E2E framework simplifies writing Ginkgo tests suites. It's main usage is for these tests suites in the Kubernetes repository itself:

  • test/e2e: runs as client for a Kubernetes cluster. The e2e.test binary is used for conformance testing.
  • test/e2e_node: runs on the same node as a kubelet instance. Used for testing kubelet.
  • test/e2e_kubeadm: test suite for kubeadm.

Usage of the framework outside of Kubernetes is possible, but not encouraged. Downstream users have to be prepared to deal with API changes.

Code Organization

The core framework is the k8s.io/kubernetes/test/e2e/framework package. It contains functionality that all E2E suites are expected to need:

  • connecting to the apiserver
  • managing per-test namespaces
  • logging (Logf)
  • failure handling (Fail, Failf)
  • writing concise JUnit test results

It also contains a TestContext with settings that can be controlled via command line flags. For historic reasons, this also contains settings for individual tests or packages that are not part of the core framework.

Optional functionality is placed in sub packages like test/e2e/framework/pod. The core framework does not depend on those. Sub packages may depend on the core framework.

The advantages of splitting the code like this are:

  • leaner go doc packages by grouping related functions together
  • not forcing all E2E suites to import all functionality
  • avoiding import cycles

Execution Flow

When a test suite gets invoked, the top-level Describe calls register the callbacks that define individual tests, but does not invoke them yet. After that init phase, command line flags are parsed and the Describe callbacks are invoked. Those then define the actual tests for the test suite. Command line flags can be used to influence the test definitions.

Now Context/BeforeEach/AfterEach/It define code that will be called later when executing a specific test. During this setup phase, f := framework.NewDefaultFramework("some tests") creates a Framework instance for one or more tests. NewDefaultFramework initializes that instance anew for each test with a BeforeEach callback. Starting with Kubernetes 1.26, that instance gets cleaned up after all other code for a test has been invoked, so the following code is correct:

f := framework.NewDefaultFramework("some tests")

ginkgo.AfterEach(func() {
    # Do something with f.ClientSet.
}

ginkgo.It("test something", func(ctx context.Context) {
    # The actual test.
})

Optional functionality can be injected into each test by adding a callback to NewFrameworkExtensions in an init function. NewDefaultFramework will invoke those callbacks as if the corresponding code had been added to each test like this:

f := framework.NewDefaultFramework("some tests")

optional.SomeCallback(f)

SomeCallback then can register additional BeforeEach or AfterEach callbacks that use the test's Framework instance.

When a test runs, callbacks defined for it with BeforeEach and AfterEach are called in first-in-first-out order. Since the migration to ginkgo v2 in Kubernetes 1.25, the AfterEach callback is called also when there has been a test failure. This can be used to run cleanup code for a test reliably. However, ginkgo.DeferCleanup is often a better alternative. Its callbacks are executed in first-in-last-out order.

test/e2e/framework/internal/unittests/cleanup/cleanup.go shows how these different callbacks can be used and in which order they are going to run.