Skip to content

Commit 2959554

Browse files
porridgeporridge
committed
Merge branch 'test-run-labels'
See kudobuilder#483 and kudobuilder/kuttl.dev#69
2 parents f6d64c9 + e7d8400 commit 2959554

File tree

13 files changed

+297
-23
lines changed

13 files changed

+297
-23
lines changed

‎pkg/apis/testharness/v1beta1/test_types.go

+13
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,19 @@ type RestConfig struct {
1313

1414
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
1515

16+
// TestFile contains attributes of a single test file.
17+
type TestFile struct {
18+
// The type meta object, should always be a GVK of kuttl.dev/v1beta1/TestFile.
19+
metav1.TypeMeta `json:",inline"`
20+
// Set labels or the test suite name.
21+
metav1.ObjectMeta `json:"metadata,omitempty"`
22+
23+
// Which test runs should this file be used in. Empty selector matches all test runs.
24+
TestRunSelector *metav1.LabelSelector `json:"testRunSelector,omitempty"`
25+
}
26+
27+
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
28+
1629
// TestSuite configures which tests should be loaded.
1730
type TestSuite struct {
1831
// The type meta object, should always be a GVK of kuttl.dev/v1beta1/TestSuite or kuttl.dev/v1beta1/TestSuite.

‎pkg/apis/testharness/v1beta1/zz_generated.deepcopy.go

+32
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pkg/kuttlctl/cmd/test.go

+3
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ func newTestCmd() *cobra.Command { //nolint:gocyclo
6161
reportName := "kuttl-report"
6262
namespace := ""
6363
suppress := []string{}
64+
var runLabels labelSetValue
6465

6566
options := harness.TestSuite{}
6667

@@ -229,6 +230,7 @@ For more detailed documentation, visit: https://kuttl.dev`,
229230
harness := test.Harness{
230231
TestSuite: options,
231232
T: t,
233+
RunLabels: runLabels.AsLabelSet(),
232234
}
233235

234236
harness.Run()
@@ -257,6 +259,7 @@ For more detailed documentation, visit: https://kuttl.dev`,
257259
testCmd.Flags().StringVar(&reportName, "report-name", "kuttl-report", "Name for the report. Report location determined by --artifacts-dir and report file type determined by --report.")
258260
testCmd.Flags().StringVarP(&namespace, "namespace", "n", "", "Namespace to use for tests. Provided namespaces must exist prior to running tests.")
259261
testCmd.Flags().StringSliceVar(&suppress, "suppress-log", []string{}, "Suppress logging for these kinds of logs (events).")
262+
testCmd.Flags().Var(&runLabels, "test-run-labels", "Labels to use for this test run.")
260263
// This cannot be a global flag because pkg/test/utils.RunTests calls flag.Parse which barfs on unknown top-level flags.
261264
// Putting it here at least does not advertise it on a level where using it is impossible.
262265
test.SetFlags(testCmd.Flags())

‎pkg/kuttlctl/cmd/values.go

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
package cmd
2+
3+
import (
4+
"fmt"
5+
6+
"k8s.io/apimachinery/pkg/labels"
7+
)
8+
9+
type labelSetValue labels.Set
10+
11+
func (v *labelSetValue) String() string {
12+
return labels.Set(*v).String()
13+
}
14+
15+
func (v *labelSetValue) Set(s string) error {
16+
l, err := labels.ConvertSelectorToLabelsMap(s)
17+
if err != nil {
18+
return fmt.Errorf("cannot parse label set: %w", err)
19+
}
20+
*v = labelSetValue(l)
21+
return nil
22+
}
23+
24+
func (v *labelSetValue) Type() string {
25+
return "labelSet"
26+
}
27+
28+
func (v labelSetValue) AsLabelSet() labels.Set {
29+
return labels.Set(v)
30+
}

‎pkg/test/case.go

+10-7
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ import (
1818
eventsbeta1 "k8s.io/api/events/v1beta1"
1919
k8serrors "k8s.io/apimachinery/pkg/api/errors"
2020
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
21+
"k8s.io/apimachinery/pkg/labels"
2122
"k8s.io/apimachinery/pkg/util/wait"
2223
"k8s.io/client-go/discovery"
2324
"sigs.k8s.io/controller-runtime/pkg/client"
@@ -40,6 +41,7 @@ type Case struct {
4041
SkipDelete bool
4142
Timeout int
4243
PreferredNamespace string
44+
RunLabels labels.Set
4345

4446
Client func(forceNew bool) (client.Client, error)
4547
DiscoveryClient func() (discovery.DiscoveryInterface, error)
@@ -458,13 +460,14 @@ func (t *Case) LoadTestSteps() error {
458460

459461
for index, files := range testStepFiles {
460462
testStep := &Step{
461-
Timeout: t.Timeout,
462-
Index: int(index),
463-
SkipDelete: t.SkipDelete,
464-
Dir: t.Dir,
465-
Asserts: []client.Object{},
466-
Apply: []client.Object{},
467-
Errors: []client.Object{},
463+
Timeout: t.Timeout,
464+
Index: int(index),
465+
SkipDelete: t.SkipDelete,
466+
Dir: t.Dir,
467+
TestRunLabels: t.RunLabels,
468+
Asserts: []client.Object{},
469+
Apply: []client.Object{},
470+
Errors: []client.Object{},
468471
}
469472

470473
for _, file := range files {

‎pkg/test/case_test.go

+116-12
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
package test
22

33
import (
4+
"fmt"
45
"testing"
56

67
"github.com/stretchr/testify/assert"
78
corev1 "k8s.io/api/core/v1"
89
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
910
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
11+
"k8s.io/apimachinery/pkg/labels"
1012
"sigs.k8s.io/controller-runtime/pkg/client"
1113

1214
harness "github.com/kudobuilder/kuttl/pkg/apis/testharness/v1beta1"
@@ -18,10 +20,12 @@ import (
1820
func TestLoadTestSteps(t *testing.T) {
1921
for _, tt := range []struct {
2022
path string
23+
runLabels labels.Set
2124
testSteps []Step
2225
}{
2326
{
24-
"test_data/with-overrides/",
27+
"test_data/with-overrides",
28+
labels.Set{},
2529
[]Step{
2630
{
2731
Name: "with-test-step-name-override",
@@ -52,7 +56,8 @@ func TestLoadTestSteps(t *testing.T) {
5256
"qosClass": "BestEffort",
5357
}),
5458
},
55-
Errors: []client.Object{},
59+
Errors: []client.Object{},
60+
TestRunLabels: labels.Set{},
5661
},
5762
{
5863
Name: "test-assert",
@@ -96,7 +101,8 @@ func TestLoadTestSteps(t *testing.T) {
96101
"qosClass": "BestEffort",
97102
}),
98103
},
99-
Errors: []client.Object{},
104+
Errors: []client.Object{},
105+
TestRunLabels: labels.Set{},
100106
},
101107
{
102108
Name: "pod",
@@ -124,7 +130,8 @@ func TestLoadTestSteps(t *testing.T) {
124130
"qosClass": "BestEffort",
125131
}),
126132
},
127-
Errors: []client.Object{},
133+
Errors: []client.Object{},
134+
TestRunLabels: labels.Set{},
128135
},
129136
{
130137
Name: "name-overridden",
@@ -164,12 +171,14 @@ func TestLoadTestSteps(t *testing.T) {
164171
"restartPolicy": "Never",
165172
}),
166173
},
167-
Errors: []client.Object{},
174+
Errors: []client.Object{},
175+
TestRunLabels: labels.Set{},
168176
},
169177
},
170178
},
171179
{
172180
"test_data/list-pods",
181+
labels.Set{},
173182
[]Step{
174183
{
175184
Name: "pod",
@@ -217,15 +226,110 @@ func TestLoadTestSteps(t *testing.T) {
217226
},
218227
},
219228
},
229+
Errors: []client.Object{},
230+
TestRunLabels: labels.Set{},
231+
},
232+
},
233+
},
234+
{
235+
"test_data/test-run-labels",
236+
labels.Set{},
237+
[]Step{
238+
{
239+
Name: "",
240+
Index: 1,
241+
TestRunLabels: labels.Set{},
242+
Apply: []client.Object{},
243+
Asserts: []client.Object{},
244+
Errors: []client.Object{},
245+
},
246+
},
247+
},
248+
{
249+
"test_data/test-run-labels",
250+
labels.Set{"flavor": "a"},
251+
[]Step{
252+
{
253+
Name: "create-a",
254+
Index: 1,
255+
TestRunLabels: labels.Set{"flavor": "a"},
256+
Apply: []client.Object{
257+
&unstructured.Unstructured{
258+
Object: map[string]interface{}{
259+
"apiVersion": "v1",
260+
"kind": "ConfigMap",
261+
"metadata": map[string]interface{}{
262+
"name": "test",
263+
},
264+
"data": map[string]interface{}{
265+
"flavor": "a",
266+
},
267+
},
268+
},
269+
},
270+
Asserts: []client.Object{
271+
&unstructured.Unstructured{
272+
Object: map[string]interface{}{
273+
"apiVersion": "v1",
274+
"kind": "ConfigMap",
275+
"metadata": map[string]interface{}{
276+
"name": "test",
277+
},
278+
"data": map[string]interface{}{
279+
"flavor": "a",
280+
},
281+
},
282+
},
283+
},
284+
Errors: []client.Object{},
285+
},
286+
},
287+
},
288+
{
289+
"test_data/test-run-labels",
290+
labels.Set{"flavor": "b"},
291+
[]Step{
292+
{
293+
Name: "create-b",
294+
Index: 1,
295+
TestRunLabels: labels.Set{"flavor": "b"},
296+
Apply: []client.Object{
297+
&unstructured.Unstructured{
298+
Object: map[string]interface{}{
299+
"apiVersion": "v1",
300+
"kind": "ConfigMap",
301+
"metadata": map[string]interface{}{
302+
"name": "test",
303+
},
304+
"data": map[string]interface{}{
305+
"flavor": "b",
306+
},
307+
},
308+
},
309+
},
310+
Asserts: []client.Object{
311+
&unstructured.Unstructured{
312+
Object: map[string]interface{}{
313+
"apiVersion": "v1",
314+
"kind": "ConfigMap",
315+
"metadata": map[string]interface{}{
316+
"name": "test",
317+
},
318+
"data": map[string]interface{}{
319+
"flavor": "b",
320+
},
321+
},
322+
},
323+
},
220324
Errors: []client.Object{},
221325
},
222326
},
223327
},
224328
} {
225329
tt := tt
226330

227-
t.Run(tt.path, func(t *testing.T) {
228-
test := &Case{Dir: tt.path, Logger: testutils.NewTestLogger(t, tt.path)}
331+
t.Run(fmt.Sprintf("%s/%s", tt.path, tt.runLabels), func(t *testing.T) {
332+
test := &Case{Dir: tt.path, Logger: testutils.NewTestLogger(t, tt.path), RunLabels: tt.runLabels}
229333

230334
err := test.LoadTestSteps()
231335
assert.Nil(t, err)
@@ -238,11 +342,11 @@ func TestLoadTestSteps(t *testing.T) {
238342
assert.Equal(t, len(tt.testSteps), len(testStepsVal))
239343
for index := range tt.testSteps {
240344
tt.testSteps[index].Dir = tt.path
241-
assert.Equal(t, tt.testSteps[index].Apply, testStepsVal[index].Apply)
242-
assert.Equal(t, tt.testSteps[index].Asserts, testStepsVal[index].Asserts)
243-
assert.Equal(t, tt.testSteps[index].Errors, testStepsVal[index].Errors)
244-
assert.Equal(t, tt.testSteps[index].Step, testStepsVal[index].Step)
245-
assert.Equal(t, tt.testSteps[index].Dir, testStepsVal[index].Dir)
345+
assert.Equal(t, tt.testSteps[index].Apply, testStepsVal[index].Apply, "apply objects need to match")
346+
assert.Equal(t, tt.testSteps[index].Asserts, testStepsVal[index].Asserts, "assert objects need to match")
347+
assert.Equal(t, tt.testSteps[index].Errors, testStepsVal[index].Errors, "error objects need to match")
348+
assert.Equal(t, tt.testSteps[index].Step, testStepsVal[index].Step, "step object needs to match")
349+
assert.Equal(t, tt.testSteps[index].Dir, testStepsVal[index].Dir, "dir needs to match")
246350
assert.Equal(t, tt.testSteps[index], testStepsVal[index])
247351
}
248352
})

‎pkg/test/harness.go

+3
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ import (
1818
volumetypes "github.com/docker/docker/api/types/volume"
1919
docker "github.com/docker/docker/client"
2020
"gopkg.in/yaml.v2"
21+
"k8s.io/apimachinery/pkg/labels"
2122
"k8s.io/apimachinery/pkg/runtime"
2223
"k8s.io/client-go/discovery"
2324
"k8s.io/client-go/rest"
@@ -53,6 +54,7 @@ type Harness struct {
5354
stopping bool
5455
bgProcesses []*exec.Cmd
5556
report *report.Testsuites
57+
RunLabels labels.Set
5658
}
5759

5860
// LoadTests loads all of the tests in a given directory.
@@ -85,6 +87,7 @@ func (h *Harness) LoadTests(dir string) ([]*Case, error) {
8587
Dir: filepath.Join(dir, file.Name()),
8688
SkipDelete: h.TestSuite.SkipDelete,
8789
Suppress: h.TestSuite.Suppress,
90+
RunLabels: h.RunLabels,
8891
})
8992
}
9093

0 commit comments

Comments
 (0)