-
Notifications
You must be signed in to change notification settings - Fork 386
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
🌱 add missing unit tests for the pathannotation admission plugin #2535
Merged
openshift-merge-robot
merged 2 commits into
kcp-dev:main
from
p0lyn0mial:path-annotation-ut
Jan 5, 2023
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
318 changes: 318 additions & 0 deletions
318
pkg/admission/pathannotation/pathannotation_admission_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,318 @@ | ||
| /* | ||
| Copyright 2023 The KCP Authors. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package pathannotation | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "testing" | ||
|
|
||
| "github.com/kcp-dev/logicalcluster/v3" | ||
|
|
||
| "k8s.io/apimachinery/pkg/api/meta" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/runtime" | ||
| "k8s.io/apimachinery/pkg/runtime/schema" | ||
| "k8s.io/apiserver/pkg/admission" | ||
| "k8s.io/apiserver/pkg/endpoints/request" | ||
|
|
||
| apisv1alpha1 "github.com/kcp-dev/kcp/pkg/apis/apis/v1alpha1" | ||
| "github.com/kcp-dev/kcp/pkg/apis/core" | ||
| corev1alpha1 "github.com/kcp-dev/kcp/pkg/apis/core/v1alpha1" | ||
| schedulingv1alpha1 "github.com/kcp-dev/kcp/pkg/apis/scheduling/v1alpha1" | ||
| tenancyv1alpha1 "github.com/kcp-dev/kcp/pkg/apis/tenancy/v1alpha1" | ||
| ) | ||
|
|
||
| func TestPathAnnotationAdmit(t *testing.T) { | ||
| scenarios := []struct { | ||
| name string | ||
| admissionObject runtime.Object | ||
| admissionResource schema.GroupVersionResource | ||
| admissionVerb admission.Operation | ||
| admissionOptions runtime.Object | ||
| admissionContext context.Context | ||
| getLogicalCluster func(clusterName logicalcluster.Name, name string) (*corev1alpha1.LogicalCluster, error) | ||
|
|
||
| expectError bool | ||
| validateAdmissionObject func(t *testing.T, obj runtime.Object) | ||
| }{ | ||
| { | ||
| name: "error when no cluster in the context", | ||
| admissionContext: context.TODO(), | ||
| expectError: true, | ||
| }, | ||
| { | ||
| name: "admission is not applied to logicalclusters", | ||
| admissionContext: admissionContextFor("foo"), | ||
| admissionResource: corev1alpha1.SchemeGroupVersion.WithResource("logicalclusters"), | ||
| admissionObject: &corev1alpha1.LogicalCluster{}, | ||
| validateAdmissionObject: objectWithoutPathAnnotation, | ||
| }, | ||
| { | ||
| name: "admission is not applied to a resource that undergoes a deletion", | ||
| admissionContext: admissionContextFor("foo"), | ||
| admissionResource: apisv1alpha1.SchemeGroupVersion.WithResource("apiexports"), | ||
| admissionVerb: admission.Delete, | ||
| admissionObject: &apisv1alpha1.APIExport{}, | ||
| validateAdmissionObject: objectWithoutPathAnnotation, | ||
| }, | ||
| { | ||
| name: "admission is not applied to an unsupported resource", | ||
| admissionContext: admissionContextFor("foo"), | ||
| admissionResource: apisv1alpha1.SchemeGroupVersion.WithResource("apiresourceschemas"), | ||
| admissionVerb: admission.Create, | ||
| admissionObject: &apisv1alpha1.APIResourceSchema{}, | ||
| getLogicalCluster: getCluster("foo"), | ||
| validateAdmissionObject: func(t *testing.T, obj runtime.Object) { | ||
| objMeta, err := meta.Accessor(obj) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| if _, has := objMeta.GetAnnotations()[core.LogicalClusterPathAnnotationKey]; has { | ||
| t.Fatalf("the %q annotation cannot be automatically set on an APIResourceSchema resource", core.LogicalClusterPathAnnotationKey) | ||
| } | ||
| }, | ||
| }, | ||
| { | ||
| name: "admission is applied to an unsupported resource if it has the path annotation present", | ||
| admissionContext: admissionContextFor("foo"), | ||
| admissionResource: apisv1alpha1.SchemeGroupVersion.WithResource("apiresourceschemas"), | ||
| admissionVerb: admission.Create, | ||
| admissionObject: &apisv1alpha1.APIResourceSchema{ObjectMeta: metav1.ObjectMeta{Annotations: map[string]string{core.LogicalClusterPathAnnotationKey: ""}}}, | ||
| getLogicalCluster: getCluster("foo"), | ||
| validateAdmissionObject: objectHasPathAnnotation("root:foo"), | ||
| }, | ||
| { | ||
| name: "a path is derived from the LogicalCluster object if it doesn't have the path annotation", | ||
| admissionContext: admissionContextFor("foo"), | ||
| admissionVerb: admission.Create, | ||
| admissionResource: apisv1alpha1.SchemeGroupVersion.WithResource("apiexports"), | ||
| admissionObject: &apisv1alpha1.APIExport{}, | ||
| getLogicalCluster: getCluster("foo"), | ||
| validateAdmissionObject: objectHasPathAnnotation("root:foo"), | ||
| }, | ||
| { | ||
| name: "a path is updated when is different from the one applied to the LogicalCluster resource", | ||
| admissionVerb: admission.Create, | ||
| admissionResource: apisv1alpha1.SchemeGroupVersion.WithResource("apiexports"), | ||
| admissionObject: &apisv1alpha1.APIExport{ObjectMeta: metav1.ObjectMeta{Annotations: map[string]string{core.LogicalClusterPathAnnotationKey: "bar:foo"}}}, | ||
| admissionContext: admissionContextFor("foo"), | ||
| getLogicalCluster: getCluster("foo"), | ||
| validateAdmissionObject: objectHasPathAnnotation("root:foo"), | ||
| }, | ||
| { | ||
| name: "happy path: an APIExport is annotated with a path", | ||
| admissionVerb: admission.Create, | ||
| admissionResource: apisv1alpha1.SchemeGroupVersion.WithResource("apiexports"), | ||
| admissionObject: &apisv1alpha1.APIExport{}, | ||
| admissionContext: admissionContextFor("foo"), | ||
| getLogicalCluster: getCluster("foo"), | ||
| validateAdmissionObject: objectHasPathAnnotation("root:foo"), | ||
| }, | ||
|
|
||
| { | ||
| name: "happy path: a Location is annotated with a path", | ||
| admissionVerb: admission.Create, | ||
| admissionResource: schedulingv1alpha1.SchemeGroupVersion.WithResource("locations"), | ||
| admissionObject: &schedulingv1alpha1.Location{}, | ||
| admissionContext: admissionContextFor("foo"), | ||
| getLogicalCluster: getCluster("foo"), | ||
| validateAdmissionObject: objectHasPathAnnotation("root:foo"), | ||
| }, | ||
|
|
||
| { | ||
| name: "happy path: a WorkspaceType is annotated with a path", | ||
| admissionVerb: admission.Create, | ||
| admissionResource: tenancyv1alpha1.SchemeGroupVersion.WithResource("workspacetypes"), | ||
| admissionObject: &tenancyv1alpha1.WorkspaceType{}, | ||
| admissionContext: admissionContextFor("foo"), | ||
| getLogicalCluster: getCluster("foo"), | ||
| validateAdmissionObject: objectHasPathAnnotation("root:foo"), | ||
| }, | ||
| } | ||
|
|
||
| for _, scenario := range scenarios { | ||
| t.Run(scenario.name, func(t *testing.T) { | ||
| target := &pathAnnotationPlugin{getLogicalCluster: scenario.getLogicalCluster} | ||
| attr := admission.NewAttributesRecord( | ||
| scenario.admissionObject, | ||
| nil, | ||
| schema.GroupVersionKind{}, | ||
| "", | ||
| "", | ||
| scenario.admissionResource, | ||
| "", | ||
| scenario.admissionVerb, | ||
| scenario.admissionOptions, | ||
| false, | ||
| nil, | ||
| ) | ||
|
|
||
| err := target.Admit(scenario.admissionContext, attr, nil) | ||
|
|
||
| if scenario.expectError && err == nil { | ||
| t.Errorf("expected to get an error") | ||
| } | ||
| if !scenario.expectError && err != nil { | ||
| t.Errorf("unexpected error: %v", err) | ||
| } | ||
| if scenario.validateAdmissionObject != nil { | ||
| scenario.validateAdmissionObject(t, scenario.admissionObject) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestPathAnnotationValidate(t *testing.T) { | ||
| scenarios := []struct { | ||
| name string | ||
| admissionObject runtime.Object | ||
| admissionResource schema.GroupVersionResource | ||
| admissionVerb admission.Operation | ||
| admissionOptions runtime.Object | ||
| admissionContext context.Context | ||
| getLogicalCluster func(clusterName logicalcluster.Name, name string) (*corev1alpha1.LogicalCluster, error) | ||
|
|
||
| expectError bool | ||
| }{ | ||
| { | ||
| name: "error when no cluster in the context", | ||
| admissionContext: context.TODO(), | ||
| expectError: true, | ||
| }, | ||
| { | ||
| name: "admission is not applied to logicalclusters", | ||
| admissionContext: admissionContextFor("foo"), | ||
| admissionResource: corev1alpha1.SchemeGroupVersion.WithResource("logicalclusters"), | ||
| }, | ||
| { | ||
| name: "admission is not applied to a resource that undergoes a deletion", | ||
| admissionContext: admissionContextFor("foo"), | ||
| admissionResource: apisv1alpha1.SchemeGroupVersion.WithResource("apiexports"), | ||
| admissionVerb: admission.Delete, | ||
| }, | ||
| { | ||
| name: "admission is not applied to an unsupported resource", | ||
| admissionContext: admissionContextFor("foo"), | ||
| admissionResource: apisv1alpha1.SchemeGroupVersion.WithResource("apiresourceschemas"), | ||
| admissionVerb: admission.Create, | ||
| admissionObject: &apisv1alpha1.APIResourceSchema{}, | ||
| getLogicalCluster: getCluster("foo"), | ||
| }, | ||
| { | ||
| name: "an APIExport with incorrect path annotation is NOT admitted", | ||
| admissionVerb: admission.Create, | ||
| admissionResource: apisv1alpha1.SchemeGroupVersion.WithResource("apiexports"), | ||
| admissionObject: &apisv1alpha1.APIExport{ObjectMeta: metav1.ObjectMeta{Annotations: map[string]string{core.LogicalClusterPathAnnotationKey: "universe:milky-way"}}}, | ||
| admissionContext: admissionContextFor("foo"), | ||
| getLogicalCluster: getCluster("foo"), | ||
| expectError: true, | ||
| }, | ||
| { | ||
| name: "an APIExport without the path annotation is NOT admitted", | ||
| admissionVerb: admission.Create, | ||
| admissionResource: apisv1alpha1.SchemeGroupVersion.WithResource("apiexports"), | ||
| admissionObject: &apisv1alpha1.APIExport{}, | ||
| admissionContext: admissionContextFor("foo"), | ||
| getLogicalCluster: getCluster("foo"), | ||
| expectError: true, | ||
| }, | ||
| { | ||
| name: "happy path: an APIExport with the path annotation is admitted", | ||
| admissionVerb: admission.Create, | ||
| admissionResource: apisv1alpha1.SchemeGroupVersion.WithResource("apiexports"), | ||
| admissionObject: &apisv1alpha1.APIExport{ObjectMeta: metav1.ObjectMeta{Annotations: map[string]string{core.LogicalClusterPathAnnotationKey: "root:foo"}}}, | ||
| admissionContext: admissionContextFor("foo"), | ||
| getLogicalCluster: getCluster("foo"), | ||
| }, | ||
| } | ||
|
|
||
| for _, scenario := range scenarios { | ||
| t.Run(scenario.name, func(t *testing.T) { | ||
| target := &pathAnnotationPlugin{getLogicalCluster: scenario.getLogicalCluster} | ||
| attr := admission.NewAttributesRecord( | ||
| scenario.admissionObject, | ||
| nil, | ||
| schema.GroupVersionKind{}, | ||
| "", | ||
| "", | ||
| scenario.admissionResource, | ||
| "", | ||
| scenario.admissionVerb, | ||
| scenario.admissionOptions, | ||
| false, | ||
| nil, | ||
| ) | ||
|
|
||
| err := target.Validate(scenario.admissionContext, attr, nil) | ||
|
|
||
| if scenario.expectError && err == nil { | ||
| t.Errorf("expected to get an error") | ||
| } | ||
| if !scenario.expectError && err != nil { | ||
| t.Errorf("unexpected error: %v", err) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func getCluster(expectedClusterName string) func(clusterName logicalcluster.Name, name string) (*corev1alpha1.LogicalCluster, error) { | ||
| return func(clusterName logicalcluster.Name, name string) (*corev1alpha1.LogicalCluster, error) { | ||
| if clusterName.String() != expectedClusterName { | ||
| return nil, fmt.Errorf("unexpected clusterName = %q, expected = %q", clusterName, expectedClusterName) | ||
| } | ||
| if name != corev1alpha1.LogicalClusterName { | ||
| return nil, fmt.Errorf("unexpected name = %q, expected = %q", clusterName, corev1alpha1.LogicalClusterName) | ||
| } | ||
| return &corev1alpha1.LogicalCluster{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: corev1alpha1.LogicalClusterName, | ||
| Annotations: map[string]string{ | ||
| core.LogicalClusterPathAnnotationKey: "root:foo", | ||
| }, | ||
| }, | ||
| }, nil | ||
| } | ||
| } | ||
|
|
||
| func objectHasPathAnnotation(expectedPathAnnotation string) func(t *testing.T, obj runtime.Object) { | ||
| return func(t *testing.T, obj runtime.Object) { | ||
| objMeta, err := meta.Accessor(obj) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| pathAnnotation := objMeta.GetAnnotations()[core.LogicalClusterPathAnnotationKey] | ||
| if pathAnnotation == "" || pathAnnotation != expectedPathAnnotation { | ||
| t.Fatalf("unexpected value = %q, in the %q annotation, expected = %q", pathAnnotation, core.LogicalClusterPathAnnotationKey, expectedPathAnnotation) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func objectWithoutPathAnnotation(t *testing.T, obj runtime.Object) { | ||
| objMeta, err := meta.Accessor(obj) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| _, has := objMeta.GetAnnotations()[core.LogicalClusterPathAnnotationKey] | ||
| if has { | ||
| t.Fatalf("object = %v should not have %q annotation set", objMeta.GetName(), core.LogicalClusterPathAnnotationKey) | ||
| } | ||
| } | ||
|
|
||
| func admissionContextFor(clusterName string) context.Context { | ||
| return request.WithCluster(context.Background(), request.Cluster{Name: logicalcluster.Name(clusterName)}) | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no need for
name