Skip to content

Commit 1b0f2ef

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 7277c27 commit 1b0f2ef

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

19991999
// TestServerless runs the integration tests defined in testing/integration/serverless
2000-
func (Integration) TestServerless(ctx context.Context) error {
2000+
func (i Integration) TestServerless(ctx context.Context) error {
2001+
return i.testServerless(ctx, false, "")
2002+
}
2003+
2004+
// TestServerlessSingle runs a single integration test defined in testing/integration/serverless
2005+
func (i Integration) TestServerlessSingle(ctx context.Context, testName string) error {
2006+
return i.testServerless(ctx, false, testName)
2007+
}
2008+
2009+
func (i Integration) testServerless(ctx context.Context, matrix bool, testName string) error {
20012010
err := os.Setenv("STACK_PROVISIONER", "serverless")
20022011
if err != nil {
20032012
return fmt.Errorf("error setting serverless stack env var: %w", err)
20042013
}
20052014

2006-
return integRunner(ctx, "testing/integration/serverless", false, "")
2015+
return integRunner(ctx, "testing/integration/serverless", matrix, testName)
20072016
}
20082017

2009-
// TestKubernetes runs kubernetes integration tests
2010-
func (Integration) TestKubernetes(ctx context.Context) error {
2011-
mg.Deps(Integration.BuildKubernetesTestData)
2012-
// invoke integration tests
2013-
if err := os.Setenv("TEST_GROUPS", "kubernetes"); err != nil {
2014-
return err
2015-
}
2016-
2017-
return integRunner(ctx, "testing/integration/k8s", false, "")
2018+
// TestKubernetes runs the integration tests defined in testing/integration/k8s
2019+
func (i Integration) TestKubernetes(ctx context.Context) error {
2020+
return i.testKubernetes(ctx, false, "")
20182021
}
20192022

2020-
// TestKubernetesSingle runs single k8s integration test
2021-
func (Integration) TestKubernetesSingle(ctx context.Context, testName string) error {
2022-
mg.Deps(Integration.BuildKubernetesTestData)
2023-
// invoke integration tests
2024-
if err := os.Setenv("TEST_GROUPS", "kubernetes"); err != nil {
2025-
return err
2026-
}
2023+
// TestKubernetesSingle runs a single integration test defined in testing/integration/k8s
2024+
func (i Integration) TestKubernetesSingle(ctx context.Context, testName string) error {
2025+
return i.testKubernetes(ctx, false, testName)
2026+
}
20272027

2028-
return integRunner(ctx, "testing/integration/k8s", false, testName)
2028+
// TestKubernetesMatrix runs a matrix of integration tests defined in testing/integration/k8s
2029+
func (i Integration) TestKubernetesMatrix(ctx context.Context) error {
2030+
return i.testKubernetes(ctx, true, "")
20292031
}
20302032

2031-
// TestKubernetesMatrix runs a matrix of kubernetes integration tests
2032-
func (Integration) TestKubernetesMatrix(ctx context.Context) error {
2033+
func (i Integration) testKubernetes(ctx context.Context, matrix bool, testName string) error {
20332034
mg.Deps(Integration.BuildKubernetesTestData)
20342035
// invoke integration tests
20352036
if err := os.Setenv("TEST_GROUPS", "kubernetes"); err != nil {
20362037
return err
20372038
}
20382039

2039-
return integRunner(ctx, "testing/integration/k8s", true, "")
2040+
return integRunner(ctx, "testing/integration/k8s", matrix, testName)
20402041
}
20412042

20422043
// BuildKubernetesTestData builds the test data required to run k8s integration tests
@@ -2570,9 +2571,18 @@ func (Integration) TestBeatServerless(ctx context.Context, beatname string) erro
25702571
return integRunner(ctx, "testing/integration/beats/serverless", false, "TestBeatsServerless")
25712572
}
25722573

2573-
// TestForResourceLeaks runs tests that check for resource leaks
2574-
func (Integration) TestForResourceLeaks(ctx context.Context) error {
2575-
return integRunner(ctx, "testing/integration/leak", false, "TestLongRunningAgentForLeaks")
2574+
// TestForResourceLeaks runs the integration tests defined in testing/integration/leak
2575+
func (i Integration) TestForResourceLeaks(ctx context.Context) error {
2576+
return i.testForResourceLeaks(ctx, false, "")
2577+
}
2578+
2579+
// TestForResourceLeaksSingle runs a single integration test defined in testing/integration/leak
2580+
func (i Integration) TestForResourceLeaksSingle(ctx context.Context, testName string) error {
2581+
return i.testForResourceLeaks(ctx, false, testName)
2582+
}
2583+
2584+
func (i Integration) testForResourceLeaks(ctx context.Context, matrix bool, testName string) error {
2585+
return integRunner(ctx, "testing/integration/leak", matrix, testName)
25762586
}
25772587

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

0 commit comments

Comments
 (0)