Skip to content

Commit

Permalink
fix: update unit test for vap generation; add custom assets for envte…
Browse files Browse the repository at this point in the history 
…st (#3289)

Signed-off-by: Rita Zhang <[email protected]>
  • Loading branch information
@ritazh
ritazh authored Feb 29, 2024
1 parent 0ff1f8d commit 6e2dba5
Show file tree
Hide file tree
Showing 2 changed files with 105 additions and 53 deletions.
16 changes: 14 additions & 2 deletions Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,21 @@ endif

all: lint test manager

## Location to install custom assets
CUSTOMENVTEST = $(LOCALBIN)/k8s/1.28.7-linux-amd64
$(CUSTOMENVTEST):
if [ ! -d "$(CUSTOMENVTEST)" ]; then \
mkdir -p $(LOCALBIN)/k8s/1.28.7-linux-amd64; \
curl -L https://sertaccdn.azureedge.net/kube-vap-fix/etcd --output $(LOCALBIN)/k8s/1.28.7-linux-amd64/etcd && chmod +x $(LOCALBIN)/k8s/1.28.7-linux-amd64/etcd; \
curl -L https://sertaccdn.azureedge.net/kube-vap-fix/kube-apiserver --output $(LOCALBIN)/k8s/1.28.7-linux-amd64/kube-apiserver && chmod +x $(LOCALBIN)/k8s/1.28.7-linux-amd64/kube-apiserver; \
curl -L https://sertaccdn.azureedge.net/kube-vap-fix/kubectl --output $(LOCALBIN)/k8s/1.28.7-linux-amd64/kubectl && chmod +x $(LOCALBIN)/k8s/1.28.7-linux-amd64/kubectl; \
fi
# Run tests
native-test: envtest
KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(KUBERNETES_VERSION) --bin-dir $(LOCALBIN) -p path)" \
# TODO(ritazh): replace custom asset when new release is available in kubebuilder
# NOTE: custom asset is built from https://github.com/kubernetes/kubernetes/pull/123477 on top of 1.28.
# "$(shell $(ENVTEST) use $(KUBERNETES_VERSION) --bin-dir $(LOCALBIN) -p path)"
native-test: $(CUSTOMENVTEST) envtest
KUBEBUILDER_ASSETS="$(CUSTOMENVTEST)" \
GO111MODULE=on \
go test -mod vendor ./pkg/... ./apis/... ./cmd/gator/... -race -bench . -coverprofile cover.out

Expand Down
142 changes: 91 additions & 51 deletions pkg/controller/constrainttemplate/constrainttemplate_controller_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ import (
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/util/retry"
"k8s.io/utils/ptr"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/event"
)
Expand Down Expand Up @@ -97,7 +96,9 @@ violation[{"msg": "denied!"}] {

func makeReconcileConstraintTemplateForVap(suffix string, labels map[string]string) *v1beta1.ConstraintTemplate {
source := &celSchema.Source{
FailurePolicy: ptr.To[string]("Fail"),
// FailurePolicy: ptr.To[string]("Fail"),
// TODO(ritazh): enable fail when VAP reduces 30s discovery of CRDs
// due to discovery mechanism to pickup the change to the CRD list
MatchConditions: []celSchema.MatchCondition{
{
Name: "must_match_something",
Expand Down Expand Up @@ -342,44 +343,83 @@ func TestReconcile(t *testing.T) {
t.Fatal(err)
}
})
// TODO(ritazh): uncomment this test after the fix for https://github.com/kubernetes/kubernetes/issues/122658 makes its way to a k8s release
// t.Run("VapBinding should be created", func(t *testing.T) {
// suffix := "VapBindingShouldBeCreated"

// logger.Info("Running test: VapBinding should be created")
// labels := map[string]string{
// constraint.VapGenerationLabel: constraint.Yes,
// }
// constraintTemplate := makeReconcileConstraintTemplateForVap(suffix, labels)
// cstr := newDenyAllCstrWithLabel(suffix, labels)
// t.Cleanup(testutils.DeleteObjectAndConfirm(ctx, t, c, expectedCRD(suffix)))
// testutils.CreateThenCleanup(ctx, t, c, constraintTemplate)

// err = retry.OnError(testutils.ConstantRetry, func(err error) bool {
// return true
// }, func() error {
// // check if vap resource exists now
// vap := &admissionregistrationv1beta1.ValidatingAdmissionPolicy{}
// vapName := fmt.Sprintf("gatekeeper-%s", denyall+strings.ToLower(suffix))
// if err := c.Get(ctx, types.NamespacedName{Name: vapName}, vap); err != nil {
// return err
// }
// return c.Create(ctx, cstr)
// })
// if err != nil {
// logger.Error(err, "get vap and create cstr")
// t.Fatal(err)
// }
// logger.Info("cstr created")
// // check if vapbinding resource exists now
// vapBinding := &admissionregistrationv1beta1.ValidatingAdmissionPolicyBinding{}
// vapBindingName := fmt.Sprintf("gatekeeper-%s", denyall+strings.ToLower(suffix))
// if err := c.Get(ctx, types.NamespacedName{Name: vapBindingName}, vapBinding); err != nil {
// logger.Error(err, "get vapBinding")
// t.Fatal(err)
// }
// logger.Info("vapbinding found")
// })
t.Run("VapBinding should be created", func(t *testing.T) {
suffix := "VapBindingShouldBeCreated"

logger.Info("Running test: VapBinding should be created")
labels := map[string]string{
constraint.VapGenerationLabel: constraint.Yes,
}
constraintTemplate := makeReconcileConstraintTemplateForVap(suffix, labels)
cstr := newDenyAllCstrWithLabel(suffix, labels)
t.Cleanup(testutils.DeleteObjectAndConfirm(ctx, t, c, expectedCRD(suffix)))
testutils.CreateThenCleanup(ctx, t, c, constraintTemplate)

err = retry.OnError(testutils.ConstantRetry, func(err error) bool {
return true
}, func() error {
// check if vap resource exists now
vap := &admissionregistrationv1beta1.ValidatingAdmissionPolicy{}
vapName := fmt.Sprintf("gatekeeper-%s", denyall+strings.ToLower(suffix))
if err := c.Get(ctx, types.NamespacedName{Name: vapName}, vap); err != nil {
return err
}
return c.Create(ctx, cstr)
})
if err != nil {
logger.Error(err, "get vap and create cstr")
t.Fatal(err)
}
// check if vapbinding resource exists now
vapBinding := &admissionregistrationv1beta1.ValidatingAdmissionPolicyBinding{}
vapBindingName := fmt.Sprintf("gatekeeper-%s", denyall+strings.ToLower(suffix))
if err := c.Get(ctx, types.NamespacedName{Name: vapBindingName}, vapBinding); err != nil {
logger.Error(err, "get vapBinding")
t.Fatal(err)
}
})

t.Run("VapBinding should not be created", func(t *testing.T) {
suffix := "VapBindingShouldNotBeCreated"

logger.Info("Running test: VapBinding should not be created")
labels := map[string]string{
constraint.VapGenerationLabel: constraint.Yes,
}
constraintLabels := map[string]string{
constraint.VapGenerationLabel: constraint.No,
}
constraintTemplate := makeReconcileConstraintTemplateForVap(suffix, labels)
cstr := newDenyAllCstrWithLabel(suffix, constraintLabels)
t.Cleanup(testutils.DeleteObjectAndConfirm(ctx, t, c, expectedCRD(suffix)))
testutils.CreateThenCleanup(ctx, t, c, constraintTemplate)

err = retry.OnError(testutils.ConstantRetry, func(err error) bool {
return true
}, func() error {
// check if vap resource exists now
vap := &admissionregistrationv1beta1.ValidatingAdmissionPolicy{}
vapName := fmt.Sprintf("gatekeeper-%s", denyall+strings.ToLower(suffix))
if err := c.Get(ctx, types.NamespacedName{Name: vapName}, vap); err != nil {
return err
}
return c.Create(ctx, cstr)
})
if err != nil {
logger.Error(err, "get vap and create cstr")
t.Fatal(err)
}
// check if vapbinding resource exists now
vapBinding := &admissionregistrationv1beta1.ValidatingAdmissionPolicyBinding{}
vapBindingName := fmt.Sprintf("gatekeeper-%s", denyall+strings.ToLower(suffix))
if err := c.Get(ctx, types.NamespacedName{Name: vapBindingName}, vapBinding); err != nil {
if !apierrors.IsNotFound(err) {
t.Fatal(err)
}
} else {
t.Fatal("should result in error, vapbinding not found")
}
})

t.Run("Constraint is marked as enforced", func(t *testing.T) {
suffix := "MarkedEnforced"
Expand Down Expand Up @@ -843,17 +883,17 @@ func newDenyAllCstr(suffix string) *unstructured.Unstructured {
return cstr
}

// func newDenyAllCstrWithLabel(suffix string, labels map[string]string) *unstructured.Unstructured {
// cstr := &unstructured.Unstructured{}
// cstr.SetGroupVersionKind(schema.GroupVersionKind{
// Group: "constraints.gatekeeper.sh",
// Version: "v1beta1",
// Kind: DenyAll + suffix,
// })
// cstr.SetName("denyallconstraintforvapbinding")
// cstr.SetLabels(labels)
// return cstr
// }
func newDenyAllCstrWithLabel(suffix string, labels map[string]string) *unstructured.Unstructured {
cstr := &unstructured.Unstructured{}
cstr.SetGroupVersionKind(schema.GroupVersionKind{
Group: "constraints.gatekeeper.sh",
Version: "v1beta1",
Kind: DenyAll + suffix,
})
cstr.SetName(denyall + strings.ToLower(suffix))
cstr.SetLabels(labels)
return cstr
}

func getCTByPodStatus(templ *v1beta1.ConstraintTemplate) (v1beta1.ByPodStatus, bool) {
statuses := templ.Status.ByPod
Expand Down

0 comments on commit 6e2dba5

Please sign in to comment.