Skip to content

Commit b91a3b2

Browse files
pkoutsovasilismergify[bot]
authored andcommitted
feat: singleTest mage target for each integration test package (#8691)
* feat: support running a single test for serverless and resource leak integration tests * doc: update test-framework-dev-guide.md to include the latest mage targets (cherry picked from commit 2ec9992)
1 parent f7c5628 commit b91a3b2

File tree

2 files changed

+61
-31
lines changed

2 files changed

+61
-31
lines changed

docs/test-framework-dev-guide.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,21 +64,41 @@ Go to https://docker-auth.elastic.co/ and authenticate with Okta to receive your
6464

6565
The test are run with mage using the `integration` namespace:
6666

67-
- `mage integration:test` to execute all tests under the `testing/integration`
67+
#### ESS oriented tests
68+
69+
- `mage integration:test` to execute all tests under the `testing/integration/ess`
6870
folder. All tests are executed on remote VMs, including those that set `Local: true`.
6971

7072
- `mage integration:local [testName|all]` to execute only those tests under the
71-
`testing/integration` folder that set `Local: true`. It'll run all the tests if
73+
`testing/integration/ess` folder that set `Local: true`. It'll run all the tests if
7274
`all` is passed as argument, or it'll pass `[testName]` to `go test` as
7375
`--run=[testName]`. These tests are executed on your local machine.
7476

75-
- `mage integration:single [testName]` to execute a single test under the `testing/integration` folder. Only the selected test will be executed on remote VMs.
77+
- `mage integration:single [testName]` to execute a single test under the `testing/integration/ess` folder. Only the selected test will be executed on remote VMs.
78+
79+
- `mage integration:matrix` to run all tests under the `testing/integration/ess` folder on the complete matrix of supported operating systems and architectures of the Elastic Agent.
80+
81+
#### Kubernetes oriented tests
82+
83+
- `mage integration:testKubernetes` to run kubernetes tests under the `testing/integration/k8s` folder for the default image on the default version of kubernetes (all previous commands will not run any kubernetes tests).
84+
85+
- `mage integration:testKubernetesMatrix` to run a matrix of kubernetes tests under the `testing/integration/k8s` folder for all image types and supported versions of kubernetes.
86+
87+
- `mage integration:testKubernetesSingle [testName|all]` to execute a single test under the `testing/integration/k8s` folder. Only the selected test will be executed.
88+
89+
#### Serverless oriented tests
90+
91+
- `mage integration:testServerless` to execute all tests under the `testing/integration/serverless` folder. All tests are executed on remote VMs, including those that set `Local: true`.
92+
93+
- `mage integration:testServerlessSingle [testName|all]` to execute a single test under the `testing/integration/serverless` folder. Only the selected test will be executed on remote VMs.
94+
95+
#### Resource leaks tests
7696

77-
- `mage integration:matrix` to run all tests on the complete matrix of supported operating systems and architectures of the Elastic Agent.
97+
- `mage integration:testForResourceLeaks` to execute all tests under the `testing/integration/leak` folder. All tests are executed on remote VMs.
7898

79-
- `mage integration:testKubernetes` to run kubernetes tests for the default image on the default version of kubernetes (all previous commands will not run any kubernetes tests).
99+
- `mage integration:testForResourceLeaksSingle [testName|all]` to execute a single test under the `testing/integration/leak` folder. Only the selected test will be executed on remote VMs.
80100

81-
- `mage integration:testKubernetesMatrix` to run a matrix of kubernetes tests for all image types and supported versions of kubernetes.
101+
You can list all available mage targets by running `mage -l`
82102

83103
#### Selecting specific platform
84104

magefile.go

Lines changed: 35 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2090,46 +2090,47 @@ func (Integration) Single(ctx context.Context, testName string) error {
20902090
}
20912091

20922092
// TestServerless runs the integration tests defined in testing/integration/serverless
2093-
func (Integration) TestServerless(ctx context.Context) error {
2093+
func (i Integration) TestServerless(ctx context.Context) error {
2094+
return i.testServerless(ctx, false, "")
2095+
}
2096+
2097+
// TestServerlessSingle runs a single integration test defined in testing/integration/serverless
2098+
func (i Integration) TestServerlessSingle(ctx context.Context, testName string) error {
2099+
return i.testServerless(ctx, false, testName)
2100+
}
2101+
2102+
func (i Integration) testServerless(ctx context.Context, matrix bool, testName string) error {
20942103
err := os.Setenv("STACK_PROVISIONER", "serverless")
20952104
if err != nil {
20962105
return fmt.Errorf("error setting serverless stack env var: %w", err)
20972106
}
20982107

2099-
return integRunner(ctx, "testing/integration/serverless", false, "")
2108+
return integRunner(ctx, "testing/integration/serverless", matrix, testName)
21002109
}
21012110

2102-
// TestKubernetes runs kubernetes integration tests
2103-
func (Integration) TestKubernetes(ctx context.Context) error {
2104-
mg.Deps(Integration.BuildKubernetesTestData)
2105-
// invoke integration tests
2106-
if err := os.Setenv("TEST_GROUPS", "kubernetes"); err != nil {
2107-
return err
2108-
}
2109-
2110-
return integRunner(ctx, "testing/integration/k8s", false, "")
2111+
// TestKubernetes runs the integration tests defined in testing/integration/k8s
2112+
func (i Integration) TestKubernetes(ctx context.Context) error {
2113+
return i.testKubernetes(ctx, false, "")
21112114
}
21122115

2113-
// TestKubernetesSingle runs single k8s integration test
2114-
func (Integration) TestKubernetesSingle(ctx context.Context, testName string) error {
2115-
mg.Deps(Integration.BuildKubernetesTestData)
2116-
// invoke integration tests
2117-
if err := os.Setenv("TEST_GROUPS", "kubernetes"); err != nil {
2118-
return err
2119-
}
2116+
// TestKubernetesSingle runs a single integration test defined in testing/integration/k8s
2117+
func (i Integration) TestKubernetesSingle(ctx context.Context, testName string) error {
2118+
return i.testKubernetes(ctx, false, testName)
2119+
}
21202120

2121-
return integRunner(ctx, "testing/integration/k8s", false, testName)
2121+
// TestKubernetesMatrix runs a matrix of integration tests defined in testing/integration/k8s
2122+
func (i Integration) TestKubernetesMatrix(ctx context.Context) error {
2123+
return i.testKubernetes(ctx, true, "")
21222124
}
21232125

2124-
// TestKubernetesMatrix runs a matrix of kubernetes integration tests
2125-
func (Integration) TestKubernetesMatrix(ctx context.Context) error {
2126+
func (i Integration) testKubernetes(ctx context.Context, matrix bool, testName string) error {
21262127
mg.Deps(Integration.BuildKubernetesTestData)
21272128
// invoke integration tests
21282129
if err := os.Setenv("TEST_GROUPS", "kubernetes"); err != nil {
21292130
return err
21302131
}
21312132

2132-
return integRunner(ctx, "testing/integration/k8s", true, "")
2133+
return integRunner(ctx, "testing/integration/k8s", matrix, testName)
21332134
}
21342135

21352136
// BuildKubernetesTestData builds the test data required to run k8s integration tests
@@ -2663,9 +2664,18 @@ func (Integration) TestBeatServerless(ctx context.Context, beatname string) erro
26632664
return integRunner(ctx, "testing/integration/beats/serverless", false, "TestBeatsServerless")
26642665
}
26652666

2666-
// TestForResourceLeaks runs tests that check for resource leaks
2667-
func (Integration) TestForResourceLeaks(ctx context.Context) error {
2668-
return integRunner(ctx, "testing/integration/leak", false, "TestLongRunningAgentForLeaks")
2667+
// TestForResourceLeaks runs the integration tests defined in testing/integration/leak
2668+
func (i Integration) TestForResourceLeaks(ctx context.Context) error {
2669+
return i.testForResourceLeaks(ctx, false, "")
2670+
}
2671+
2672+
// TestForResourceLeaksSingle runs a single integration test defined in testing/integration/leak
2673+
func (i Integration) TestForResourceLeaksSingle(ctx context.Context, testName string) error {
2674+
return i.testForResourceLeaks(ctx, false, testName)
2675+
}
2676+
2677+
func (i Integration) testForResourceLeaks(ctx context.Context, matrix bool, testName string) error {
2678+
return integRunner(ctx, "testing/integration/leak", matrix, testName)
26692679
}
26702680

26712681
// TestOnRemote shouldn't be called locally (called on remote host to perform testing)

0 commit comments

Comments
 (0)