From 6b91ce18d2aaa8b9442e0f121468a40c23c89471 Mon Sep 17 00:00:00 2001 From: shivdudhani Date: Thu, 13 Jun 2019 12:01:03 -0700 Subject: [PATCH] scan examples folder to build TS --- examples/cli/output/ghost.yaml | 40 +++++++++++++++++++ examples/cli/output/nginx.yaml | 29 ++++++++++++++ examples/cli/testScenarios.yaml | 21 ++++++++++ examples/generate/policy_basic.yaml | 36 +++++++++++++++++ examples/mutate/overlay/output/nginx.yaml | 31 ++++++++++++++ .../mutate/overlay/{ => resources}/nginx.yaml | 2 + examples/mutate/overlay/testScenarios.yaml | 10 +++++ examples/mutate/patches/output/endpoints.yaml | 13 ++++-- examples/mutate/patches/testScenarios.yaml | 8 +++- pkg/testutils/testbundle.go | 17 +++++--- pkg/testutils/testsuite.go | 9 ++--- pkg/testutils/testutils.go | 6 ++- pkg/testutils/testutils_test.go | 28 ++++++++++--- pkg/testutils/utils.go | 10 +---- 14 files changed, 230 insertions(+), 30 deletions(-) create mode 100644 examples/cli/output/ghost.yaml create mode 100644 examples/cli/output/nginx.yaml create mode 100644 examples/cli/testScenarios.yaml create mode 100644 examples/generate/policy_basic.yaml create mode 100644 examples/mutate/overlay/output/nginx.yaml rename examples/mutate/overlay/{ => resources}/nginx.yaml (89%) create mode 100644 examples/mutate/overlay/testScenarios.yaml diff --git a/examples/cli/output/ghost.yaml b/examples/cli/output/ghost.yaml new file mode 100644 index 0000000000..751db9ec4c --- /dev/null +++ b/examples/cli/output/ghost.yaml @@ -0,0 +1,40 @@ +kind: Deployment +apiVersion: apps/v1 +metadata: + name: ghost + creationTimestamp: + labels: + app: nginx_is_mutated + cli: test + isMutated: 'true' + nirmata.io/application.name: ghost + nirmata.io/component: ghost + nirmata.io/deployment.name: ghost +spec: + replicas: 1 + selector: + matchLabels: + nirmata.io/application.name: ghost + nirmata.io/component: ghost + template: + metadata: + creationTimestamp: + labels: + nirmata.io/application.name: ghost + nirmata.io/component: ghost + nirmata.io/deployment.name: ghost + spec: + containers: + - name: ghost + image: nginx:latest + ports: + - containerPort: 8080 + protocol: TCP + resources: {} + strategy: + type: RollingUpdate + rollingUpdate: + maxUnavailable: 0 + maxSurge: 1 + revisionHistoryLimit: 5 +status: {} diff --git a/examples/cli/output/nginx.yaml b/examples/cli/output/nginx.yaml new file mode 100644 index 0000000000..9f4c121341 --- /dev/null +++ b/examples/cli/output/nginx.yaml @@ -0,0 +1,29 @@ +kind: Deployment +apiVersion: apps/v1 +metadata: + name: nginx-deployment + creationTimestamp: + labels: + app: nginx_is_mutated + cli: test + isMutated: 'true' +spec: + replicas: 1 + selector: + matchLabels: + app: nginx + template: + metadata: + creationTimestamp: + labels: + app: nginx + spec: + containers: + - name: nginx + image: nginx:1.7.9 + ports: + - containerPort: 80 + resources: {} + imagePullPolicy: Always + strategy: {} +status: {} diff --git a/examples/cli/testScenarios.yaml b/examples/cli/testScenarios.yaml new file mode 100644 index 0000000000..158c4418bd --- /dev/null +++ b/examples/cli/testScenarios.yaml @@ -0,0 +1,21 @@ +# input +policy: policy-deployment +resource: nginx-deployment +initResources: +# expected +mutation: + mPatchedResource: nginx-deployment + reason: Success +validation: + reason: Success +--- +# input +policy: policy-deployment +resource: ghost +initResources: +# expected +mutation: + mPatchedResource: ghost + reason: Success +validation: + reason: Failed \ No newline at end of file diff --git a/examples/generate/policy_basic.yaml b/examples/generate/policy_basic.yaml new file mode 100644 index 0000000000..79f92ef081 --- /dev/null +++ b/examples/generate/policy_basic.yaml @@ -0,0 +1,36 @@ +apiVersion : kyverno.io/v1alpha1 +kind : Policy +metadata : + name : basic-policy +spec : + rules: + - name: "Basic config generator for all namespaces" + resource: + kinds: + - Namespace + selector: + matchLabels: + LabelForSelector : "namespace2" + generate: + kind: ConfigMap + name: default-config + clone: + namespace: default + name: config-template + - name: "Basic config generator for all namespaces" + resource: + kinds: + - Namespace + selector: + matchLabels: + LabelForSelector : "namespace2" + generate: + kind: Secret + name: mongo-creds + data: + data: + DB_USER: YWJyYWthZGFicmE= + DB_PASSWORD: YXBwc3dvcmQ= + metadata: + labels: + purpose: mongo diff --git a/examples/mutate/overlay/output/nginx.yaml b/examples/mutate/overlay/output/nginx.yaml new file mode 100644 index 0000000000..d59519c5a7 --- /dev/null +++ b/examples/mutate/overlay/output/nginx.yaml @@ -0,0 +1,31 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: nginx-deployment + creationTimestamp: + labels: + app: nginx +spec: + replicas: 1 + selector: + matchLabels: + app: nginx + template: + metadata: + creationTimestamp: + labels: + app: nginx + spec: + containers: + - name: nginx + image: nginx:latest + ports: + - containerPort: 80 + resources: {} + imagePullPolicy: Always + - name: ghost + image: ghost:latest + resources: {} + imagePullPolicy: Always + strategy: {} +status: {} diff --git a/examples/mutate/overlay/nginx.yaml b/examples/mutate/overlay/resources/nginx.yaml similarity index 89% rename from examples/mutate/overlay/nginx.yaml rename to examples/mutate/overlay/resources/nginx.yaml index 20d0713896..bdf22b13cb 100644 --- a/examples/mutate/overlay/nginx.yaml +++ b/examples/mutate/overlay/resources/nginx.yaml @@ -2,6 +2,7 @@ apiVersion: apps/v1 kind: Deployment metadata: name: nginx-deployment + creationTimestamp: labels: app: nginx spec: @@ -11,6 +12,7 @@ spec: app: nginx template: metadata: + creationTimestamp: labels: app: nginx spec: diff --git a/examples/mutate/overlay/testScenarios.yaml b/examples/mutate/overlay/testScenarios.yaml new file mode 100644 index 0000000000..e4012f24bb --- /dev/null +++ b/examples/mutate/overlay/testScenarios.yaml @@ -0,0 +1,10 @@ +# input +policy: set-image-pull-policy +resource: nginx-deployment +initResources: +# expected +mutation: + mPatchedResource: nginx-deployment + reason: Success +validation: + reason: Success \ No newline at end of file diff --git a/examples/mutate/patches/output/endpoints.yaml b/examples/mutate/patches/output/endpoints.yaml index 958d931482..c7ebca73a0 100644 --- a/examples/mutate/patches/output/endpoints.yaml +++ b/examples/mutate/patches/output/endpoints.yaml @@ -1,13 +1,20 @@ -apiVersion: v1 kind: Endpoints +apiVersion: v1 metadata: name: test-endpoint + creationTimestamp: labels: - label : test + label: test subsets: +- addresses: + - ip: 192.168.10.172 + ports: + - name: load-balancer-connection + port: 80 + protocol: UDP - addresses: - ip: 192.168.10.171 ports: - name: secure-connection - port: 443 + port: 9663 protocol: TCP diff --git a/examples/mutate/patches/testScenarios.yaml b/examples/mutate/patches/testScenarios.yaml index 7f0fec053a..df633e58df 100644 --- a/examples/mutate/patches/testScenarios.yaml +++ b/examples/mutate/patches/testScenarios.yaml @@ -9,7 +9,13 @@ mutation: validation: reason: Success --- +# input policy: policy-endpoints resource: test-endpoint initResources: -mPatchedResource: test-endpoint \ No newline at end of file +# expected +mutation: + mPatchedResource: test-endpoint + reason: Success +validation: + reason: Success \ No newline at end of file diff --git a/pkg/testutils/testbundle.go b/pkg/testutils/testbundle.go index b407fa97a0..3d4299902f 100644 --- a/pkg/testutils/testbundle.go +++ b/pkg/testutils/testbundle.go @@ -90,13 +90,14 @@ func loadScenarios(tbPath string, file string) ([]*tScenario, error) { glog.Warningf("Error while decoding YAML object, err: %s", err) continue } - fmt.Println(s.Policy) - fmt.Println(s.Resource) ts = append(ts, s) } return ts, nil } + +// Load test structure folder func (tb *testBundle) load() error { + // scenario file defines the mapping of resources and policies scenarios, err := loadScenarios(tb.path, tScenarioFile) if err != nil { return err @@ -116,8 +117,7 @@ func (tb *testBundle) load() error { } tb.policies[policy.GetName()] = policy } - - // load resources + // load trigger resources loadResources(tb.path, tb.resources, resourcesFolder) // load output resources loadResources(tb.path, tb.output, outputFolder) @@ -144,8 +144,10 @@ type testBundle struct { } func (tb *testBundle) run(t *testing.T, testingapplyTest IApplyTest) { + glog.Infof("Start: test on test bundles %s", tb.path) // run each scenario for _, ts := range tb.scenarios { + fmt.Println(tb.path) // get policy p, ok := tb.policies[ts.Policy] if !ok { @@ -167,6 +169,7 @@ func (tb *testBundle) run(t *testing.T, testingapplyTest IApplyTest) { tb.checkMutationResult(t, ts.Mutation, mPatchedResource, mResult) tb.checkValidationResult(t, ts.Validation, vResult) } + glog.Infof("Done: test on test bundles %s", tb.path) } func (tb *testBundle) checkValidationResult(t *testing.T, expect *tValidation, vResult result.Result) { @@ -191,13 +194,17 @@ func (tb *testBundle) checkMutationResult(t *testing.T, expect *tMutation, pr *r return } // get expected patched resource - er, ok := tb.resources[expect.MPatchedResource] + er, ok := tb.output[expect.MPatchedResource] if !ok { glog.Warningf("Resource %s not found", expect.MPatchedResource) return } // compare patched resources if !checkMutationRPatches(pr, er) { + fmt.Printf("Expected Resource %s \n", string(er.rawResource)) + fmt.Printf("Patched Resource %s \n", string(pr.rawResource)) + + glog.Warningf("Expected resource %s ", string(pr.rawResource)) t.Error("Patched resources not as expected") } // compare result diff --git a/pkg/testutils/testsuite.go b/pkg/testutils/testsuite.go index 7240ace08e..6da009b0fa 100644 --- a/pkg/testutils/testsuite.go +++ b/pkg/testutils/testsuite.go @@ -1,7 +1,6 @@ package testutils import ( - "fmt" "os" "path/filepath" "testing" @@ -41,20 +40,20 @@ type testSuite struct { func (ts *testSuite) buildTestSuite() error { // loading test bundles for test suite - fmt.Println(ts.path) err := filepath.Walk(ts.path, func(path string, info os.FileInfo, err error) error { if info.IsDir() { + glog.Infof("searching for test files at %s", path) // check if there are resources dir and policies yaml tb := NewTestBundle(path) if tb != nil { - // load resources + // try to load the test folder structure err := tb.load() if err != nil { - // glog.Error(err) + glog.Warningf("no supported test structure avaialbe at path %s", path) return nil } + glog.Infof("loading test suite at path %s", path) ts.tb = append(ts.tb, tb) - // fmt.Println(path) } } return nil diff --git a/pkg/testutils/testutils.go b/pkg/testutils/testutils.go index 1d6d104d17..41ce4be588 100644 --- a/pkg/testutils/testutils.go +++ b/pkg/testutils/testutils.go @@ -1,11 +1,12 @@ package testutils import ( - "fmt" "io/ioutil" ospath "path" "path/filepath" "testing" + + "github.com/golang/glog" ) // Load policy & resource files @@ -19,6 +20,7 @@ const outputFolder string = "output" //LoadTestSuite reads the resource, policy and scenario files func LoadTestSuite(t *testing.T, path string) *testSuite { + glog.Infof("loading test suites at %s", path) // gp := os.Getenv("GOPATH") // ap := ospath.Join(gp, "src/github.com/nirmata/kyverno") // build test suite @@ -26,6 +28,7 @@ func LoadTestSuite(t *testing.T, path string) *testSuite { // ts := NewTestSuite(t, ospath.Join(ap, examplesPath)) ts := NewTestSuite(t, path) ts.buildTestSuite() + glog.Infof("done loading test suite at %s", path) return ts } @@ -43,7 +46,6 @@ func getYAMLfiles(path string) (yamls []string) { return nil } for _, file := range fileInfo { - fmt.Println(filepath.Ext(file.Name())) if file.Name() == tScenarioFile { continue } diff --git a/pkg/testutils/testutils_test.go b/pkg/testutils/testutils_test.go index cd0645de4a..fb68597038 100644 --- a/pkg/testutils/testutils_test.go +++ b/pkg/testutils/testutils_test.go @@ -1,20 +1,36 @@ package testutils import ( - "fmt" "testing" + + "github.com/golang/glog" ) -func TestUtils(t *testing.T) { - file := "/Users/shiv/nirmata/code/go/src/github.com/nirmata/kyverno/examples/mutate/patches" - ts := LoadTestSuite(t, file) +func runTest(t *testing.T, path string) { + // Load test suites at specified path + ts := LoadTestSuite(t, path) + // policy application logic tp := &testPolicy{} ts.setApplyTest(tp) + // run the tests for each test bundle ts.runTests() if ts != nil { - fmt.Println("Done building the test bundles") + glog.Infof("Done running the test at %s", path) + } +} + +func TestExamples(t *testing.T) { + // folders := []string{ + // "/Users/shiv/nirmata/code/go/src/github.com/nirmata/kyverno/examples/mutate/patches", + // "/Users/shiv/nirmata/code/go/src/github.com/nirmata/kyverno/examples/mutate/overlay", + // "/Users/shiv/nirmata/code/go/src/github.com/nirmata/kyverno/examples/cli", + // } + folders := []string{ + "/Users/shiv/nirmata/code/go/src/github.com/nirmata/kyverno/examples", + } + for _, folder := range folders { + runTest(t, folder) } - // run the tests against the policy engine } diff --git a/pkg/testutils/utils.go b/pkg/testutils/utils.go index ccf4de6e15..c8819db794 100644 --- a/pkg/testutils/utils.go +++ b/pkg/testutils/utils.go @@ -61,7 +61,7 @@ type resourceInfo struct { func (ri resourceInfo) isSame(other resourceInfo) bool { // compare gvk - if ri.gvk != other.gvk { + if *ri.gvk != *other.gvk { return false } // compare rawResource @@ -69,7 +69,7 @@ func (ri resourceInfo) isSame(other resourceInfo) bool { } func getResourceYAML(d []byte) { - fmt.Println(string(d)) + // fmt.Println(string(d)) // convert json to yaml // print the result for reference // can be used as a dry run the get the expected result @@ -154,20 +154,16 @@ func (tp *testPolicy) applyPolicy(policy *policytypes.Policy, resource *resource err := mResult.ToError() if err == nil && len(mPatches) != 0 { patchedResource, err = engine.ApplyPatches(resource.rawResource, mPatches) - fmt.Println(len(resource.rawResource)) - fmt.Println(len(patchedResource)) if err != nil { return nil, nil, nil, err } // Validate vResult = engine.Validate(*policy, patchedResource, *resource.gvk) - fmt.Println(len(patchedResource)) } // Generate if client == nil { glog.Warning("Client is required to test generate") } - fmt.Println(len(patchedResource)) // transform the patched Resource into resource Info _, ri := extractResourceRaw(patchedResource) @@ -213,8 +209,6 @@ func LoadScenarios(file string) ([]*tScenario, error) { glog.Warningf("Error while decoding YAML object, err: %s", err) continue } - fmt.Println(s.Policy) - fmt.Println(s.Resource) ts = append(ts, s) } return ts, nil