From 429fe175bf8e740abfd74a43643896c759e5ec64 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Charles-Edouard=20Br=C3=A9t=C3=A9ch=C3=A9?= Date: Tue, 6 Sep 2022 10:02:41 +0200 Subject: [PATCH] chore: add unit tests for pkg/utils/wildcard (#4510) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * chore: add unit tests for pkg/utils/wildcard Signed-off-by: Charles-Edouard Brétéché * testify Signed-off-by: Charles-Edouard Brétéché Signed-off-by: Charles-Edouard Brétéché --- pkg/engine/loadtargets.go | 3 +- pkg/engine/wildcards/wildcards.go | 5 +- pkg/utils/kube/wildcard.go | 4 +- pkg/utils/wildcard/match_test.go | 8 +- .../{string/wildcard.go => wildcard/utils.go} | 2 +- pkg/utils/wildcard/utils_test.go | 89 +++++++++++++++++++ 6 files changed, 99 insertions(+), 12 deletions(-) rename pkg/utils/{string/wildcard.go => wildcard/utils.go} (87%) create mode 100644 pkg/utils/wildcard/utils_test.go diff --git a/pkg/engine/loadtargets.go b/pkg/engine/loadtargets.go index c5b23eafec..d6ccc3fd45 100644 --- a/pkg/engine/loadtargets.go +++ b/pkg/engine/loadtargets.go @@ -6,7 +6,6 @@ import ( "github.com/go-logr/logr" kyvernov1 "github.com/kyverno/kyverno/api/kyverno/v1" "github.com/kyverno/kyverno/pkg/engine/variables" - stringutils "github.com/kyverno/kyverno/pkg/utils/string" "github.com/kyverno/kyverno/pkg/utils/wildcard" "go.uber.org/multierr" "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" @@ -70,7 +69,7 @@ func getTargets(target kyvernov1.ResourceSpec, ctx *PolicyContext, logger logr.L name := target.Name if namespace != "" && name != "" && - !stringutils.ContainsWildcard(namespace) && !stringutils.ContainsWildcard(name) { + !wildcard.ContainsWildcard(namespace) && !wildcard.ContainsWildcard(name) { obj, err := ctx.Client.GetResource(target.APIVersion, target.Kind, namespace, name) if err != nil { return nil, fmt.Errorf("failed to get target %s/%s %s/%s : %v", target.APIVersion, target.Kind, namespace, name, err) diff --git a/pkg/engine/wildcards/wildcards.go b/pkg/engine/wildcards/wildcards.go index 14eae36cc7..1919a01c1e 100644 --- a/pkg/engine/wildcards/wildcards.go +++ b/pkg/engine/wildcards/wildcards.go @@ -4,7 +4,6 @@ import ( "strings" commonAnchor "github.com/kyverno/kyverno/pkg/engine/anchor" - stringutils "github.com/kyverno/kyverno/pkg/utils/string" wildcard "github.com/kyverno/kyverno/pkg/utils/wildcard" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" ) @@ -21,7 +20,7 @@ func ReplaceInSelector(labelSelector *metav1.LabelSelector, resourceLabels map[s func replaceWildcardsInMapKeyValues(patternMap map[string]string, resourceMap map[string]string) map[string]string { result := map[string]string{} for k, v := range patternMap { - if stringutils.ContainsWildcard(k) || stringutils.ContainsWildcard(v) { + if wildcard.ContainsWildcard(k) || wildcard.ContainsWildcard(v) { matchK, matchV := expandWildcards(k, v, resourceMap, true, true) result[matchK] = matchV } else { @@ -140,7 +139,7 @@ func getValueAsStringMap(key string, data interface{}) (string, map[string]strin func replaceWildcardsInMapKeys(patternData, resourceData map[string]string) map[string]interface{} { results := map[string]interface{}{} for k, v := range patternData { - if stringutils.ContainsWildcard(k) { + if wildcard.ContainsWildcard(k) { anchorFreeKey, anchorPrefix := commonAnchor.RemoveAnchor(k) matchK, _ := expandWildcards(anchorFreeKey, v, resourceData, false, false) if anchorPrefix != "" { diff --git a/pkg/utils/kube/wildcard.go b/pkg/utils/kube/wildcard.go index 5565292d40..cb6849bfc4 100644 --- a/pkg/utils/kube/wildcard.go +++ b/pkg/utils/kube/wildcard.go @@ -1,13 +1,13 @@ package kube import ( - stringutils "github.com/kyverno/kyverno/pkg/utils/string" + "github.com/kyverno/kyverno/pkg/utils/wildcard" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" ) func LabelSelectorContainsWildcard(v *metav1.LabelSelector) bool { for k, v := range v.MatchLabels { - if stringutils.ContainsWildcard(k) || stringutils.ContainsWildcard(v) { + if wildcard.ContainsWildcard(k) || wildcard.ContainsWildcard(v) { return true } } diff --git a/pkg/utils/wildcard/match_test.go b/pkg/utils/wildcard/match_test.go index abb1f5f099..3bd285eb3a 100644 --- a/pkg/utils/wildcard/match_test.go +++ b/pkg/utils/wildcard/match_test.go @@ -2,6 +2,8 @@ package wildcard import ( "testing" + + "github.com/stretchr/testify/assert" ) func TestMatch(t *testing.T) { @@ -347,10 +349,8 @@ func TestMatch(t *testing.T) { }, } // Iterating over the test cases, call the function under test and asert the output. - for i, testCase := range testCases { + for _, testCase := range testCases { actualResult := Match(testCase.pattern, testCase.text) - if testCase.matched != actualResult { - t.Errorf("Test %d: Expected the result to be `%v`, but instead found it to be `%v`", i+1, testCase.matched, actualResult) - } + assert.Equal(t, testCase.matched, actualResult) } } diff --git a/pkg/utils/string/wildcard.go b/pkg/utils/wildcard/utils.go similarity index 87% rename from pkg/utils/string/wildcard.go rename to pkg/utils/wildcard/utils.go index 4d4112241e..c0a3d44c73 100644 --- a/pkg/utils/string/wildcard.go +++ b/pkg/utils/wildcard/utils.go @@ -1,4 +1,4 @@ -package string +package wildcard import "strings" diff --git a/pkg/utils/wildcard/utils_test.go b/pkg/utils/wildcard/utils_test.go new file mode 100644 index 0000000000..1caf90156a --- /dev/null +++ b/pkg/utils/wildcard/utils_test.go @@ -0,0 +1,89 @@ +package wildcard + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestContainsWildcard(t *testing.T) { + type args struct { + v string + } + tests := []struct { + name string + args args + want bool + }{{ + name: "no wildcard", + args: args{ + v: "name", + }, + want: false, + }, { + name: "empty string", + args: args{ + v: "", + }, + want: false, + }, { + name: "contains * at the end", + args: args{ + v: "name*", + }, + want: true, + }, { + name: "contains * at the beginning", + args: args{ + v: "*name", + }, + want: true, + }, { + name: "contains * in the middle", + args: args{ + v: "start*end", + }, + want: true, + }, { + name: "only *", + args: args{ + v: "*", + }, + want: true, + }, { + name: "contains ? at the end", + args: args{ + v: "name?", + }, + want: true, + }, { + name: "contains ? at the beginning", + args: args{ + v: "?name", + }, + want: true, + }, { + name: "contains ? in the middle", + args: args{ + v: "start?end", + }, + want: true, + }, { + name: "only ?", + args: args{ + v: "?", + }, + want: true, + }, { + name: "both * and ?", + args: args{ + v: "*name?", + }, + want: true, + }} + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + assert.Equal(t, tt.want, ContainsWildcard(tt.args.v)) + }) + } +}