Skip to content

Commit 2ec9992

Browse files
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
1 parent e629b9e commit 2ec9992

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
@@ -2340,46 +2340,47 @@ func (Integration) Single(ctx context.Context, testName string) error {
23402340
}
23412341

23422342
// TestServerless runs the integration tests defined in testing/integration/serverless
2343-
func (Integration) TestServerless(ctx context.Context) error {
2343+
func (i Integration) TestServerless(ctx context.Context) error {
2344+
return i.testServerless(ctx, false, "")
2345+
}
2346+
2347+
// TestServerlessSingle runs a single integration test defined in testing/integration/serverless
2348+
func (i Integration) TestServerlessSingle(ctx context.Context, testName string) error {
2349+
return i.testServerless(ctx, false, testName)
2350+
}
2351+
2352+
func (i Integration) testServerless(ctx context.Context, matrix bool, testName string) error {
23442353
err := os.Setenv("STACK_PROVISIONER", "serverless")
23452354
if err != nil {
23462355
return fmt.Errorf("error setting serverless stack env var: %w", err)
23472356
}
23482357

2349-
return integRunner(ctx, "testing/integration/serverless", false, "")
2358+
return integRunner(ctx, "testing/integration/serverless", matrix, testName)
23502359
}
23512360

2352-
// TestKubernetes runs kubernetes integration tests
2353-
func (Integration) TestKubernetes(ctx context.Context) error {
2354-
mg.Deps(Integration.BuildKubernetesTestData)
2355-
// invoke integration tests
2356-
if err := os.Setenv("TEST_GROUPS", "kubernetes"); err != nil {
2357-
return err
2358-
}
2359-
2360-
return integRunner(ctx, "testing/integration/k8s", false, "")
2361+
// TestKubernetes runs the integration tests defined in testing/integration/k8s
2362+
func (i Integration) TestKubernetes(ctx context.Context) error {
2363+
return i.testKubernetes(ctx, false, "")
23612364
}
23622365

2363-
// TestKubernetesSingle runs single k8s integration test
2364-
func (Integration) TestKubernetesSingle(ctx context.Context, testName string) error {
2365-
mg.Deps(Integration.BuildKubernetesTestData)
2366-
// invoke integration tests
2367-
if err := os.Setenv("TEST_GROUPS", "kubernetes"); err != nil {
2368-
return err
2369-
}
2366+
// TestKubernetesSingle runs a single integration test defined in testing/integration/k8s
2367+
func (i Integration) TestKubernetesSingle(ctx context.Context, testName string) error {
2368+
return i.testKubernetes(ctx, false, testName)
2369+
}
23702370

2371-
return integRunner(ctx, "testing/integration/k8s", false, testName)
2371+
// TestKubernetesMatrix runs a matrix of integration tests defined in testing/integration/k8s
2372+
func (i Integration) TestKubernetesMatrix(ctx context.Context) error {
2373+
return i.testKubernetes(ctx, true, "")
23722374
}
23732375

2374-
// TestKubernetesMatrix runs a matrix of kubernetes integration tests
2375-
func (Integration) TestKubernetesMatrix(ctx context.Context) error {
2376+
func (i Integration) testKubernetes(ctx context.Context, matrix bool, testName string) error {
23762377
mg.Deps(Integration.BuildKubernetesTestData)
23772378
// invoke integration tests
23782379
if err := os.Setenv("TEST_GROUPS", "kubernetes"); err != nil {
23792380
return err
23802381
}
23812382

2382-
return integRunner(ctx, "testing/integration/k8s", true, "")
2383+
return integRunner(ctx, "testing/integration/k8s", matrix, testName)
23832384
}
23842385

23852386
// BuildKubernetesTestData builds the test data required to run k8s integration tests
@@ -2916,9 +2917,18 @@ func (Integration) TestBeatServerless(ctx context.Context, beatname string) erro
29162917
return integRunner(ctx, "testing/integration/beats/serverless", false, "TestBeatsServerless")
29172918
}
29182919

2919-
// TestForResourceLeaks runs tests that check for resource leaks
2920-
func (Integration) TestForResourceLeaks(ctx context.Context) error {
2921-
return integRunner(ctx, "testing/integration/leak", false, "TestLongRunningAgentForLeaks")
2920+
// TestForResourceLeaks runs the integration tests defined in testing/integration/leak
2921+
func (i Integration) TestForResourceLeaks(ctx context.Context) error {
2922+
return i.testForResourceLeaks(ctx, false, "")
2923+
}
2924+
2925+
// TestForResourceLeaksSingle runs a single integration test defined in testing/integration/leak
2926+
func (i Integration) TestForResourceLeaksSingle(ctx context.Context, testName string) error {
2927+
return i.testForResourceLeaks(ctx, false, testName)
2928+
}
2929+
2930+
func (i Integration) testForResourceLeaks(ctx context.Context, matrix bool, testName string) error {
2931+
return integRunner(ctx, "testing/integration/leak", matrix, testName)
29222932
}
29232933

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

0 commit comments

Comments
 (0)