From b6251c989425a15fcc2ab375a239b57dbc3f5f33 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Charles-Edouard=20Br=C3=A9t=C3=A9ch=C3=A9?= Date: Mon, 31 Jul 2023 13:53:57 +0200 Subject: [PATCH] chore: organize constants better (#7941) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Charles-Edouard Brétéché --- api/kyverno/constants.go | 16 ++++++++-------- api/kyverno/v1/clusterpolicy_test.go | 2 +- api/kyverno/v1/clusterpolicy_types.go | 2 +- api/kyverno/v1/policy_test.go | 2 +- api/kyverno/v1/policy_types.go | 2 +- api/kyverno/v1/utils.go | 2 +- api/kyverno/v2beta1/clusterpolicy_test.go | 2 +- api/kyverno/v2beta1/clusterpolicy_types.go | 2 +- api/kyverno/v2beta1/policy_test.go | 2 +- api/kyverno/v2beta1/policy_types.go | 2 +- pkg/autogen/autogen.go | 4 ++-- pkg/autogen/autogen_test.go | 8 ++++---- pkg/validation/policy/validate.go | 2 +- 13 files changed, 24 insertions(+), 24 deletions(-) diff --git a/api/kyverno/constants.go b/api/kyverno/constants.go index df45739191..8cd0149b40 100644 --- a/api/kyverno/constants.go +++ b/api/kyverno/constants.go @@ -1,13 +1,13 @@ package kyverno const ( - // PodControllersAnnotation defines the annotation key for Pod-Controllers - PodControllersAnnotation = "pod-policies.kyverno.io/autogen-controllers" - // LabelAppManagedBy defines the label key for managed-by label - LabelAppManagedBy = "app.kubernetes.io/managed-by" - AnnotationPolicyCategory = "policies.kyverno.io/category" - AnnotationPolicySeverity = "policies.kyverno.io/severity" - AnnotationPolicyScored = "policies.kyverno.io/scored" - // ValueKyvernoApp defines the kyverno application value + // Well known labels + LabelAppManagedBy = "app.kubernetes.io/managed-by" + // Well known annotations + AnnotationAutogenControllers = "pod-policies.kyverno.io/autogen-controllers" + AnnotationPolicyCategory = "policies.kyverno.io/category" + AnnotationPolicySeverity = "policies.kyverno.io/severity" + AnnotationPolicyScored = "policies.kyverno.io/scored" + // Well known values ValueKyvernoApp = "kyverno" ) diff --git a/api/kyverno/v1/clusterpolicy_test.go b/api/kyverno/v1/clusterpolicy_test.go index 21c7cc9f69..c9e4722c38 100644 --- a/api/kyverno/v1/clusterpolicy_test.go +++ b/api/kyverno/v1/clusterpolicy_test.go @@ -45,7 +45,7 @@ func Test_ClusterPolicy_Autogen_All(t *testing.T) { ObjectMeta: metav1.ObjectMeta{ Name: "policy", Annotations: map[string]string{ - kyverno.PodControllersAnnotation: "all", + kyverno.AnnotationAutogenControllers: "all", }, }, } diff --git a/api/kyverno/v1/clusterpolicy_types.go b/api/kyverno/v1/clusterpolicy_types.go index 650782d9fd..431080c1a4 100644 --- a/api/kyverno/v1/clusterpolicy_types.go +++ b/api/kyverno/v1/clusterpolicy_types.go @@ -44,7 +44,7 @@ type ClusterPolicy struct { // HasAutoGenAnnotation checks if a policy has auto-gen annotation func (p *ClusterPolicy) HasAutoGenAnnotation() bool { annotations := p.GetAnnotations() - val, ok := annotations[kyverno.PodControllersAnnotation] + val, ok := annotations[kyverno.AnnotationAutogenControllers] if ok && strings.ToLower(val) != "none" { return true } diff --git a/api/kyverno/v1/policy_test.go b/api/kyverno/v1/policy_test.go index f06018af32..ec0b417d12 100644 --- a/api/kyverno/v1/policy_test.go +++ b/api/kyverno/v1/policy_test.go @@ -45,7 +45,7 @@ func Test_Policy_Autogen_All(t *testing.T) { Name: "policy", Namespace: "abcd", Annotations: map[string]string{ - kyverno.PodControllersAnnotation: "all", + kyverno.AnnotationAutogenControllers: "all", }, }, } diff --git a/api/kyverno/v1/policy_types.go b/api/kyverno/v1/policy_types.go index a6d3e0ecee..1ef1ddada5 100644 --- a/api/kyverno/v1/policy_types.go +++ b/api/kyverno/v1/policy_types.go @@ -45,7 +45,7 @@ type Policy struct { // HasAutoGenAnnotation checks if a policy has auto-gen annotation func (p *Policy) HasAutoGenAnnotation() bool { annotations := p.GetAnnotations() - val, ok := annotations[kyverno.PodControllersAnnotation] + val, ok := annotations[kyverno.AnnotationAutogenControllers] if ok && strings.ToLower(val) != "none" { return true } diff --git a/api/kyverno/v1/utils.go b/api/kyverno/v1/utils.go index 5a0596e839..ddf3bab9ce 100755 --- a/api/kyverno/v1/utils.go +++ b/api/kyverno/v1/utils.go @@ -29,7 +29,7 @@ func ToJSON(in apiextensions.JSON) *apiextv1.JSON { // ValidatePolicyName validates policy name func ValidateAutogenAnnotation(path *field.Path, annotations map[string]string) (errs field.ErrorList) { - value, ok := annotations[kyverno.PodControllersAnnotation] + value, ok := annotations[kyverno.AnnotationAutogenControllers] if ok { if value == "all" { errs = append(errs, field.Forbidden(path, "Autogen annotation does not support 'all' anymore, remove the annotation or set it to a valid value")) diff --git a/api/kyverno/v2beta1/clusterpolicy_test.go b/api/kyverno/v2beta1/clusterpolicy_test.go index c3da9f0bdf..8fab6c52a4 100644 --- a/api/kyverno/v2beta1/clusterpolicy_test.go +++ b/api/kyverno/v2beta1/clusterpolicy_test.go @@ -45,7 +45,7 @@ func Test_ClusterPolicy_Autogen_All(t *testing.T) { ObjectMeta: metav1.ObjectMeta{ Name: "policy", Annotations: map[string]string{ - kyverno.PodControllersAnnotation: "all", + kyverno.AnnotationAutogenControllers: "all", }, }, } diff --git a/api/kyverno/v2beta1/clusterpolicy_types.go b/api/kyverno/v2beta1/clusterpolicy_types.go index 3a41988cf3..2cfa7dee3e 100644 --- a/api/kyverno/v2beta1/clusterpolicy_types.go +++ b/api/kyverno/v2beta1/clusterpolicy_types.go @@ -44,7 +44,7 @@ type ClusterPolicy struct { // HasAutoGenAnnotation checks if a policy has auto-gen annotation func (p *ClusterPolicy) HasAutoGenAnnotation() bool { annotations := p.GetAnnotations() - val, ok := annotations[kyverno.PodControllersAnnotation] + val, ok := annotations[kyverno.AnnotationAutogenControllers] if ok && strings.ToLower(val) != "none" { return true } diff --git a/api/kyverno/v2beta1/policy_test.go b/api/kyverno/v2beta1/policy_test.go index dd524d118d..ab0f3706a6 100644 --- a/api/kyverno/v2beta1/policy_test.go +++ b/api/kyverno/v2beta1/policy_test.go @@ -45,7 +45,7 @@ func Test_Policy_Autogen_All(t *testing.T) { Name: "policy", Namespace: "abcd", Annotations: map[string]string{ - kyverno.PodControllersAnnotation: "all", + kyverno.AnnotationAutogenControllers: "all", }, }, } diff --git a/api/kyverno/v2beta1/policy_types.go b/api/kyverno/v2beta1/policy_types.go index 5332f52300..a0acbabe37 100644 --- a/api/kyverno/v2beta1/policy_types.go +++ b/api/kyverno/v2beta1/policy_types.go @@ -44,7 +44,7 @@ type Policy struct { // HasAutoGenAnnotation checks if a policy has auto-gen annotation func (p *Policy) HasAutoGenAnnotation() bool { annotations := p.GetAnnotations() - val, ok := annotations[kyverno.PodControllersAnnotation] + val, ok := annotations[kyverno.AnnotationAutogenControllers] if ok && strings.ToLower(val) != "none" { return true } diff --git a/pkg/autogen/autogen.go b/pkg/autogen/autogen.go index 6677e21416..74e3571d1f 100644 --- a/pkg/autogen/autogen.go +++ b/pkg/autogen/autogen.go @@ -127,7 +127,7 @@ func GetRequestedControllers(meta *metav1.ObjectMeta) []string { if annotations == nil { return nil } - controllers, ok := annotations[kyverno.PodControllersAnnotation] + controllers, ok := annotations[kyverno.AnnotationAutogenControllers] if !ok || controllers == "" { return nil } @@ -251,7 +251,7 @@ func computeRules(p kyvernov1.PolicyInterface) []kyvernov1.Rule { desiredControllers = "none" } ann := p.GetAnnotations() - actualControllers, ok := ann[kyverno.PodControllersAnnotation] + actualControllers, ok := ann[kyverno.AnnotationAutogenControllers] if !ok || !applyAutoGen { actualControllers = desiredControllers } else { diff --git a/pkg/autogen/autogen_test.go b/pkg/autogen/autogen_test.go index 925441e88b..8e80bf562e 100644 --- a/pkg/autogen/autogen_test.go +++ b/pkg/autogen/autogen_test.go @@ -281,22 +281,22 @@ func Test_GetRequestedControllers(t *testing.T) { }, { name: "annotation-empty", - meta: metav1.ObjectMeta{Annotations: map[string]string{kyverno.PodControllersAnnotation: ""}}, + meta: metav1.ObjectMeta{Annotations: map[string]string{kyverno.AnnotationAutogenControllers: ""}}, expectedControllers: nil, }, { name: "annotation-none", - meta: metav1.ObjectMeta{Annotations: map[string]string{kyverno.PodControllersAnnotation: "none"}}, + meta: metav1.ObjectMeta{Annotations: map[string]string{kyverno.AnnotationAutogenControllers: "none"}}, expectedControllers: []string{}, }, { name: "annotation-job", - meta: metav1.ObjectMeta{Annotations: map[string]string{kyverno.PodControllersAnnotation: "Job"}}, + meta: metav1.ObjectMeta{Annotations: map[string]string{kyverno.AnnotationAutogenControllers: "Job"}}, expectedControllers: []string{"Job"}, }, { name: "annotation-job-deployment", - meta: metav1.ObjectMeta{Annotations: map[string]string{kyverno.PodControllersAnnotation: "Job,Deployment"}}, + meta: metav1.ObjectMeta{Annotations: map[string]string{kyverno.AnnotationAutogenControllers: "Job,Deployment"}}, expectedControllers: []string{"Job", "Deployment"}, }, } diff --git a/pkg/validation/policy/validate.go b/pkg/validation/policy/validate.go index 6390a141df..d7452daee4 100644 --- a/pkg/validation/policy/validate.go +++ b/pkg/validation/policy/validate.go @@ -1133,7 +1133,7 @@ func jsonPatchOnPod(rule kyvernov1.Rule) bool { func podControllerAutoGenExclusion(policy kyvernov1.PolicyInterface) bool { annotations := policy.GetAnnotations() - val, ok := annotations[kyverno.PodControllersAnnotation] + val, ok := annotations[kyverno.AnnotationAutogenControllers] if !ok || val == "none" { return false }