feat: introduce model package (#1664)

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>
kyverno · Jul 18, 2024 · c2ff8bb · c2ff8bb
1 parent 83562ff
commit c2ff8bb
Show file tree

Hide file tree

Showing 17 changed files with 139 additions and 122 deletions.
diff --git a/pkg/discovery/discovery_test.go b/pkg/discovery/discovery_test.go
@@ -5,6 +5,7 @@ import (
 	"testing"
 
 	"github.com/kyverno/chainsaw/pkg/apis/v1alpha1"
+	"github.com/kyverno/chainsaw/pkg/model"
 	"github.com/stretchr/testify/assert"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
@@ -22,7 +23,7 @@ func TestDiscoverTests(t *testing.T) {
 		paths:    []string{"../../testdata/discovery/test"},
 		want: []Test{{
 			BasePath: "../../testdata/discovery/test",
-			Test: &v1alpha1.Test{
+			Test: &model.Test{
 				TypeMeta: metav1.TypeMeta{
 					APIVersion: "chainsaw.kyverno.io/v1alpha1",
 					Kind:       "Test",
@@ -68,7 +69,7 @@ func TestDiscoverTests(t *testing.T) {
 		paths:    []string{"../../testdata/discovery/manifests"},
 		want: []Test{{
 			BasePath: "../../testdata/discovery/manifests",
-			Test: &v1alpha1.Test{
+			Test: &model.Test{
 				TypeMeta: metav1.TypeMeta{
 					APIVersion: "chainsaw.kyverno.io/v1alpha1",
 					Kind:       "Test",

diff --git a/pkg/discovery/load_test.go b/pkg/discovery/load_test.go
@@ -6,6 +6,7 @@ import (
 	"testing"
 
 	"github.com/kyverno/chainsaw/pkg/apis/v1alpha1"
+	"github.com/kyverno/chainsaw/pkg/model"
 	"github.com/stretchr/testify/assert"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
@@ -36,7 +37,7 @@ func TestLoadTest(t *testing.T) {
 		path:     filepath.Join(basePath, "test"),
 		want: []Test{{
 			BasePath: "../../testdata/discovery/test",
-			Test: &v1alpha1.Test{
+			Test: &model.Test{
 				TypeMeta: metav1.TypeMeta{
 					APIVersion: "chainsaw.kyverno.io/v1alpha1",
 					Kind:       "Test",
@@ -84,7 +85,7 @@ func TestLoadTest(t *testing.T) {
 		path:     filepath.Join(basePath, "test"),
 		want: []Test{{
 			BasePath: "../../testdata/discovery/test",
-			Test: &v1alpha1.Test{
+			Test: &model.Test{
 				TypeMeta: metav1.TypeMeta{
 					APIVersion: "chainsaw.kyverno.io/v1alpha1",
 					Kind:       "Test",
@@ -132,7 +133,7 @@ func TestLoadTest(t *testing.T) {
 		path:     filepath.Join(basePath, "test-yml"),
 		want: []Test{{
 			BasePath: "../../testdata/discovery/test-yml",
-			Test: &v1alpha1.Test{
+			Test: &model.Test{
 				TypeMeta: metav1.TypeMeta{
 					APIVersion: "chainsaw.kyverno.io/v1alpha1",
 					Kind:       "Test",
@@ -180,7 +181,7 @@ func TestLoadTest(t *testing.T) {
 		path:     filepath.Join(basePath, "manifests"),
 		want: []Test{{
 			BasePath: "../../testdata/discovery/manifests",
-			Test: &v1alpha1.Test{
+			Test: &model.Test{
 				TypeMeta: metav1.TypeMeta{
 					APIVersion: "chainsaw.kyverno.io/v1alpha1",
 					Kind:       "Test",
@@ -235,7 +236,7 @@ func TestLoadTest(t *testing.T) {
 		path:     filepath.Join(basePath, "multiple-tests"),
 		want: []Test{{
 			BasePath: "../../testdata/discovery/multiple-tests",
-			Test: &v1alpha1.Test{
+			Test: &model.Test{
 				TypeMeta: metav1.TypeMeta{
 					APIVersion: "chainsaw.kyverno.io/v1alpha1",
 					Kind:       "Test",
@@ -277,7 +278,7 @@ func TestLoadTest(t *testing.T) {
 			},
 		}, {
 			BasePath: "../../testdata/discovery/multiple-tests",
-			Test: &v1alpha1.Test{
+			Test: &model.Test{
 				TypeMeta: metav1.TypeMeta{
 					APIVersion: "chainsaw.kyverno.io/v1alpha1",
 					Kind:       "Test",

diff --git a/pkg/discovery/test.go b/pkg/discovery/test.go
@@ -1,11 +1,11 @@
 package discovery
 
 import (
-	"github.com/kyverno/chainsaw/pkg/apis/v1alpha1"
+	"github.com/kyverno/chainsaw/pkg/model"
 )
 
 type Test struct {
-	Test     *v1alpha1.Test
+	Test     *model.Test
 	BasePath string
 	Err      error
 }
diff --git a/pkg/model/model.go b/pkg/model/model.go
@@ -0,0 +1,11 @@
+package model
+
+import (
+	"github.com/kyverno/chainsaw/pkg/apis/v1alpha1"
+	"github.com/kyverno/chainsaw/pkg/apis/v1alpha2"
+)
+
+type (
+	Configuration = v1alpha2.ConfigurationSpec
+	Test          = v1alpha1.Test
+)
diff --git a/pkg/runner/flags/flags.go b/pkg/runner/flags/flags.go
@@ -3,10 +3,10 @@ package flags
 import (
 	"strconv"
 
-	"github.com/kyverno/chainsaw/pkg/apis/v1alpha2"
+	"github.com/kyverno/chainsaw/pkg/model"
 )
 
-func GetFlags(config v1alpha2.ConfigurationSpec) map[string]string {
+func GetFlags(config model.Configuration) map[string]string {
 	flags := map[string]string{
 		"test.v":            "true",
 		"test.paniconexit0": "true",

diff --git a/pkg/runner/flags/flags_test.go b/pkg/runner/flags/flags_test.go
@@ -4,18 +4,19 @@ import (
 	"testing"
 
 	"github.com/kyverno/chainsaw/pkg/apis/v1alpha2"
+	"github.com/kyverno/chainsaw/pkg/model"
 	"github.com/stretchr/testify/assert"
 	"k8s.io/utils/ptr"
 )
 
 func TestGetFlags(t *testing.T) {
 	tests := []struct {
 		name   string
-		config v1alpha2.ConfigurationSpec
+		config model.Configuration
 		want   map[string]string
 	}{{
 		name:   "default",
-		config: v1alpha2.ConfigurationSpec{},
+		config: model.Configuration{},
 		want: map[string]string{
 			"test.v":            "true",
 			"test.paniconexit0": "true",
@@ -25,7 +26,7 @@ func TestGetFlags(t *testing.T) {
 		},
 	}, {
 		name: "include",
-		config: v1alpha2.ConfigurationSpec{
+		config: model.Configuration{
 			Discovery: v1alpha2.DiscoveryOptions{
 				IncludeTestRegex: "^.*$",
 			},
@@ -39,7 +40,7 @@ func TestGetFlags(t *testing.T) {
 		},
 	}, {
 		name: "exclude",
-		config: v1alpha2.ConfigurationSpec{
+		config: model.Configuration{
 			Discovery: v1alpha2.DiscoveryOptions{
 				ExcludeTestRegex: "^.*$",
 			},
@@ -53,7 +54,7 @@ func TestGetFlags(t *testing.T) {
 		},
 	}, {
 		name: "parallel",
-		config: v1alpha2.ConfigurationSpec{
+		config: model.Configuration{
 			Execution: v1alpha2.ExecutionOptions{
 				Parallel: ptr.To(10),
 			},
@@ -68,7 +69,7 @@ func TestGetFlags(t *testing.T) {
 		},
 	}, {
 		name: "repeat count",
-		config: v1alpha2.ConfigurationSpec{
+		config: model.Configuration{
 			Execution: v1alpha2.ExecutionOptions{
 				RepeatCount: ptr.To(10),
 			},

diff --git a/pkg/runner/internal/flags.go b/pkg/runner/internal/flags.go
@@ -4,11 +4,11 @@ import (
 	"flag"
 	"testing"
 
-	"github.com/kyverno/chainsaw/pkg/apis/v1alpha2"
+	"github.com/kyverno/chainsaw/pkg/model"
 	"github.com/kyverno/chainsaw/pkg/runner/flags"
 )
 
-func SetupFlags(config v1alpha2.ConfigurationSpec) error {
+func SetupFlags(config model.Configuration) error {
 	testing.Init()
 	for k, v := range flags.GetFlags(config) {
 		if err := flag.Set(k, v); err != nil {

diff --git a/pkg/runner/names/test.go b/pkg/runner/names/test.go
@@ -6,8 +6,8 @@ import (
 	"os"
 	"path/filepath"
 
-	"github.com/kyverno/chainsaw/pkg/apis/v1alpha2"
 	"github.com/kyverno/chainsaw/pkg/discovery"
+	"github.com/kyverno/chainsaw/pkg/model"
 )
 
 type (
@@ -16,7 +16,7 @@ type (
 	relativePathInterface = func(string, string) (string, error)
 )
 
-func Test(config v1alpha2.ConfigurationSpec, test discovery.Test) (string, error) {
+func Test(config model.Configuration, test discovery.Test) (string, error) {
 	if test.Test == nil {
 		return "", errors.New("test must not be nil")
 	}

diff --git a/pkg/runner/names/test_test.go b/pkg/runner/names/test_test.go
@@ -6,9 +6,9 @@ import (
 	"path/filepath"
 	"testing"
 
-	"github.com/kyverno/chainsaw/pkg/apis/v1alpha1"
 	"github.com/kyverno/chainsaw/pkg/apis/v1alpha2"
 	"github.com/kyverno/chainsaw/pkg/discovery"
+	"github.com/kyverno/chainsaw/pkg/model"
 	"github.com/stretchr/testify/assert"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
@@ -18,13 +18,13 @@ func TestTest(t *testing.T) {
 	assert.NoError(t, err)
 	tests := []struct {
 		name    string
-		config  v1alpha2.ConfigurationSpec
+		config  model.Configuration
 		test    discovery.Test
 		want    string
 		wantErr bool
 	}{{
 		name: "nil test",
-		config: v1alpha2.ConfigurationSpec{
+		config: model.Configuration{
 			Discovery: v1alpha2.DiscoveryOptions{
 				FullName: false,
 			},
@@ -36,14 +36,14 @@ func TestTest(t *testing.T) {
 		wantErr: true,
 	}, {
 		name: "no full name",
-		config: v1alpha2.ConfigurationSpec{
+		config: model.Configuration{
 			Discovery: v1alpha2.DiscoveryOptions{
 				FullName: false,
 			},
 		},
 		test: discovery.Test{
 			BasePath: cwd,
-			Test: &v1alpha1.Test{
+			Test: &model.Test{
 				ObjectMeta: metav1.ObjectMeta{
 					Name: "foo",
 				},
@@ -53,14 +53,14 @@ func TestTest(t *testing.T) {
 		want:    "foo",
 	}, {
 		name: "full name",
-		config: v1alpha2.ConfigurationSpec{
+		config: model.Configuration{
 			Discovery: v1alpha2.DiscoveryOptions{
 				FullName: true,
 			},
 		},
 		test: discovery.Test{
 			BasePath: cwd,
-			Test: &v1alpha1.Test{
+			Test: &model.Test{
 				ObjectMeta: metav1.ObjectMeta{
 					Name: "foo",
 				},
@@ -70,14 +70,14 @@ func TestTest(t *testing.T) {
 		want:    ".[foo]",
 	}, {
 		name: "full name",
-		config: v1alpha2.ConfigurationSpec{
+		config: model.Configuration{
 			Discovery: v1alpha2.DiscoveryOptions{
 				FullName: true,
 			},
 		},
 		test: discovery.Test{
 			BasePath: filepath.Join(cwd, "..", "dir", "dir"),
-			Test: &v1alpha1.Test{
+			Test: &model.Test{
 				ObjectMeta: metav1.ObjectMeta{
 					Name: "foo",
 				},
@@ -87,14 +87,14 @@ func TestTest(t *testing.T) {
 		want:    "../dir/dir[foo]",
 	}, {
 		name: "full name",
-		config: v1alpha2.ConfigurationSpec{
+		config: model.Configuration{
 			Discovery: v1alpha2.DiscoveryOptions{
 				FullName: true,
 			},
 		},
 		test: discovery.Test{
 			BasePath: filepath.Join(cwd, "dir", "dir"),
-			Test: &v1alpha1.Test{
+			Test: &model.Test{
 				ObjectMeta: metav1.ObjectMeta{
 					Name: "foo",
 				},
@@ -147,7 +147,7 @@ func TestHelpTest(t *testing.T) {
 		t.Run(tc.name, func(t *testing.T) {
 			test := discovery.Test{
 				BasePath: "/some/path",
-				Test: &v1alpha1.Test{
+				Test: &model.Test{
 					ObjectMeta: metav1.ObjectMeta{
 						Name: "foo",
 					},

diff --git a/pkg/runner/processors/step.go b/pkg/runner/processors/step.go
@@ -9,10 +9,10 @@ import (
 
 	"github.com/jmespath-community/go-jmespath/pkg/binding"
 	"github.com/kyverno/chainsaw/pkg/apis/v1alpha1"
-	"github.com/kyverno/chainsaw/pkg/apis/v1alpha2"
 	"github.com/kyverno/chainsaw/pkg/client"
 	"github.com/kyverno/chainsaw/pkg/discovery"
 	"github.com/kyverno/chainsaw/pkg/loaders/resource"
+	"github.com/kyverno/chainsaw/pkg/model"
 	"github.com/kyverno/chainsaw/pkg/report"
 	apibindings "github.com/kyverno/chainsaw/pkg/runner/bindings"
 	"github.com/kyverno/chainsaw/pkg/runner/cleanup"
@@ -50,7 +50,7 @@ type StepProcessor interface {
 }
 
 func NewStepProcessor(
-	config v1alpha2.ConfigurationSpec,
+	config model.Configuration,
 	clusters clusters.Registry,
 	namespacer namespacer.Namespacer,
 	clock clock.PassiveClock,
@@ -71,7 +71,7 @@ func NewStepProcessor(
 }
 
 type stepProcessor struct {
-	config     v1alpha2.ConfigurationSpec
+	config     model.Configuration
 	clusters   clusters.Registry
 	namespacer namespacer.Namespacer
 	clock      clock.PassiveClock