-
Notifications
You must be signed in to change notification settings - Fork 49
OCPCLOUD-2566: tests with VAP msgs #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
Open
miyadav
wants to merge
2
commits into
openshift:main
Choose a base branch
from
miyadav:2566vaptests_latest
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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,298 @@ | ||
| package e2e | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
|
|
||
| . "github.com/onsi/ginkgo/v2" | ||
| . "github.com/onsi/gomega" | ||
| configv1 "github.com/openshift/api/config/v1" | ||
| mapiv1beta1 "github.com/openshift/api/machine/v1beta1" | ||
| mapiframework "github.com/openshift/cluster-api-actuator-pkg/pkg/framework" | ||
| capiframework "github.com/openshift/cluster-capi-operator/e2e/framework" | ||
| corev1 "k8s.io/api/core/v1" | ||
| "k8s.io/apimachinery/pkg/runtime" | ||
| clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| "sigs.k8s.io/controller-runtime/pkg/envtest/komega" | ||
| ) | ||
|
|
||
| // Constants for VAP testing - based on actual VAP: machine-api-machine-vap | ||
| const ( | ||
| // Test values for MAPI machine updates | ||
| testProviderID = "aws:///us-west-2a/i-test123456" | ||
| testTaintValue = "test-taint-value" | ||
| testLabelValue = "test-label-value" | ||
| testInstanceType = "m5.xlarge" | ||
| testAMIID = "ami-test123456" | ||
| testAvailabilityZone = "us-west-2b" | ||
| testSubnetID = "subnet-test123456" | ||
| testSecurityGroupID = "sg-test123456" | ||
| testCapacityReservationID = "cr-test123456" | ||
|
|
||
| // VAP error messages - from actual VAP policy | ||
| vapSpecLockedMessage = "You may only modify spec.authoritativeAPI. Any other change inside .spec is not allowed. This is because status.authoritativeAPI is set to Cluster API." | ||
| vapProtectedLabelMessage = "Cannot add, modify or delete any machine.openshift.io/* or kubernetes.io/* label. This is because status.authoritativeAPI is set to Cluster API." | ||
| vapProtectedAnnotationMessage = "Cannot add, modify or delete any machine.openshift.io/* annotation. This is because status.authoritativeAPI is set to Cluster API." | ||
| ) | ||
|
|
||
| var _ = Describe("[sig-cluster-lifecycle][OCPFeatureGate:MachineAPIMigration] MAPI Machine VAP Tests", Ordered, func() { | ||
| BeforeAll(func() { | ||
| if platform != configv1.AWSPlatformType { | ||
| Skip(fmt.Sprintf("Skipping tests on %s, this is only supported on AWS", platform)) | ||
| } | ||
|
|
||
| if !capiframework.IsMachineAPIMigrationEnabled(ctx, cl) { | ||
| Skip("Skipping, this feature is only supported on MachineAPIMigration enabled clusters") | ||
| } | ||
| }) | ||
|
|
||
| var _ = Describe("VAP: machine-api-machine-vap enforcement", Ordered, func() { | ||
| var testMachineName = "machine-vap-test-capi-auth" | ||
| var testMAPIMachine *mapiv1beta1.Machine | ||
| var testCAPIMachine *clusterv1.Machine | ||
|
|
||
| BeforeAll(func() { | ||
| // Create a MAPI machine with ClusterAPI authority to trigger VAP enforcement | ||
| testMAPIMachine = createMAPIMachineWithAuthority(ctx, cl, testMachineName, mapiv1beta1.MachineAuthorityClusterAPI) | ||
|
|
||
| // The VAP requires a matching CAPI machine as parameter | ||
| testCAPIMachine = capiframework.GetMachine(cl, testMachineName, capiframework.CAPINamespace) | ||
|
|
||
| // Wait until VAP match conditions are met | ||
| Eventually(komega.Object(testMAPIMachine), capiframework.WaitLong, capiframework.RetryMedium).Should( | ||
| WithTransform(func(m *mapiv1beta1.Machine) mapiv1beta1.MachineAuthority { | ||
| return m.Status.AuthoritativeAPI | ||
| }, Equal(mapiv1beta1.MachineAuthorityClusterAPI)), | ||
| "VAP requires status.authoritativeAPI=Cluster API before enforcement", | ||
| ) | ||
|
|
||
| DeferCleanup(func() { | ||
| By("Cleaning up machine resources") | ||
| cleanupMachineResources( | ||
| ctx, | ||
| cl, | ||
| []*clusterv1.Machine{testCAPIMachine}, | ||
| []*mapiv1beta1.Machine{testMAPIMachine}, | ||
| ) | ||
| }) | ||
| }) | ||
|
|
||
| Context("spec field restrictions", func() { | ||
| It("should prevent updating spec.providerID", func() { | ||
| verifyUpdatePrevented(testMAPIMachine, func() { | ||
| providerIDValue := testProviderID | ||
| testMAPIMachine.Spec.ProviderID = &providerIDValue | ||
| }, vapSpecLockedMessage) | ||
| }) | ||
|
|
||
| It("should prevent updating spec.taints", func() { | ||
| verifyUpdatePrevented(testMAPIMachine, func() { | ||
| testMAPIMachine.Spec.Taints = []corev1.Taint{{ | ||
| Key: "test-taint", | ||
| Value: testTaintValue, | ||
| Effect: corev1.TaintEffectNoSchedule, | ||
| }} | ||
| }, vapSpecLockedMessage) | ||
| }) | ||
|
|
||
| It("should prevent updating spec.metadata", func() { | ||
| verifyUpdatePrevented(testMAPIMachine, func() { | ||
| if testMAPIMachine.Spec.ObjectMeta.Labels == nil { | ||
| testMAPIMachine.Spec.ObjectMeta.Labels = make(map[string]string) | ||
| } | ||
| testMAPIMachine.Spec.ObjectMeta.Labels["test-spec-label"] = testLabelValue | ||
| }, vapSpecLockedMessage) | ||
| }) | ||
| }) | ||
|
|
||
| Context("protected label restrictions", func() { | ||
| It("should prevent modifying machine.openshift.io/* labels", func() { | ||
| verifyUpdatePrevented(testMAPIMachine, func() { | ||
| if testMAPIMachine.Labels == nil { | ||
| testMAPIMachine.Labels = make(map[string]string) | ||
| } | ||
| testMAPIMachine.Labels["machine.openshift.io/test-label"] = testLabelValue | ||
| }, vapProtectedLabelMessage) | ||
| }) | ||
|
|
||
| It("should allow modifying non-protected labels", func() { | ||
| verifyUpdateAllowed(testMAPIMachine, func() { | ||
| if testMAPIMachine.Labels == nil { | ||
| testMAPIMachine.Labels = make(map[string]string) | ||
| } | ||
| testMAPIMachine.Labels["test-label"] = "allowed-value" | ||
| }) | ||
| }) | ||
| }) | ||
|
|
||
| Context("protected annotation restrictions", func() { | ||
| It("should prevent modifying machine.openshift.io/* annotations", func() { | ||
| verifyUpdatePrevented(testMAPIMachine, func() { | ||
| if testMAPIMachine.Annotations == nil { | ||
| testMAPIMachine.Annotations = make(map[string]string) | ||
| } | ||
| testMAPIMachine.Annotations["machine.openshift.io/test-annotation"] = "test-value" | ||
| }, vapProtectedAnnotationMessage) | ||
| }) | ||
|
|
||
| It("should allow modifying non-protected annotations", func() { | ||
| verifyUpdateAllowed(testMAPIMachine, func() { | ||
| if testMAPIMachine.Annotations == nil { | ||
| testMAPIMachine.Annotations = make(map[string]string) | ||
| } | ||
| testMAPIMachine.Annotations["test-annotation"] = "allowed-value" | ||
| }) | ||
| }) | ||
| }) | ||
|
|
||
| Context("AWS provider spec field restrictions", func() { | ||
| It("should prevent updating providerSpec.instanceType", func() { | ||
| verifyAWSProviderSpecUpdatePrevented(testMAPIMachine, "instanceType", func(providerSpec *mapiv1beta1.AWSMachineProviderConfig) { | ||
| providerSpec.InstanceType = testInstanceType | ||
| }, vapSpecLockedMessage) | ||
| }) | ||
|
|
||
| It("should prevent updating providerSpec.amiID", func() { | ||
| verifyAWSProviderSpecUpdatePrevented(testMAPIMachine, "amiID", func(providerSpec *mapiv1beta1.AWSMachineProviderConfig) { | ||
| amiID := testAMIID | ||
| if providerSpec.AMI.ID == nil { | ||
| providerSpec.AMI.ID = &amiID | ||
| } else { | ||
| *providerSpec.AMI.ID = amiID | ||
| } | ||
| }, vapSpecLockedMessage) | ||
| }) | ||
|
|
||
| It("should prevent updating providerSpec.availabilityZone", func() { | ||
| verifyAWSProviderSpecUpdatePrevented(testMAPIMachine, "availabilityZone", func(providerSpec *mapiv1beta1.AWSMachineProviderConfig) { | ||
| providerSpec.Placement.AvailabilityZone = testAvailabilityZone | ||
| }, vapSpecLockedMessage) | ||
| }) | ||
|
|
||
| It("should prevent updating providerSpec.subnetID", func() { | ||
| verifyAWSProviderSpecUpdatePrevented(testMAPIMachine, "subnetID", func(providerSpec *mapiv1beta1.AWSMachineProviderConfig) { | ||
| subnetID := testSubnetID | ||
| providerSpec.Subnet = mapiv1beta1.AWSResourceReference{ | ||
| ID: &subnetID, | ||
| } | ||
| }, vapSpecLockedMessage) | ||
| }) | ||
|
|
||
| It("should prevent updating providerSpec.securityGroups", func() { | ||
| verifyAWSProviderSpecUpdatePrevented(testMAPIMachine, "securityGroups", func(providerSpec *mapiv1beta1.AWSMachineProviderConfig) { | ||
| sgID := testSecurityGroupID | ||
| providerSpec.SecurityGroups = []mapiv1beta1.AWSResourceReference{{ | ||
| ID: &sgID, | ||
| }} | ||
| }, vapSpecLockedMessage) | ||
| }) | ||
|
|
||
| It("should prevent updating providerSpec.tags", func() { | ||
| verifyAWSProviderSpecUpdatePrevented(testMAPIMachine, "tags", func(providerSpec *mapiv1beta1.AWSMachineProviderConfig) { | ||
| providerSpec.Tags = []mapiv1beta1.TagSpecification{{ | ||
| Name: "test-key", | ||
| Value: "test-value", | ||
| }} | ||
| }, vapSpecLockedMessage) | ||
| }) | ||
|
|
||
| It("should prevent updating providerSpec.capacityReservationId", func() { | ||
| verifyAWSProviderSpecUpdatePrevented(testMAPIMachine, "capacityReservationId", func(providerSpec *mapiv1beta1.AWSMachineProviderConfig) { | ||
| providerSpec.CapacityReservationID = testCapacityReservationID | ||
| }, vapSpecLockedMessage) | ||
| }) | ||
| }) | ||
|
|
||
| Context("VAP match conditions verification", func() { | ||
| It("should not apply VAP when authoritativeAPI is MachineAPI", func() { | ||
| verifyVAPNotAppliedForMachineAPIAuthority() | ||
| }) | ||
| }) | ||
| }) | ||
| }) | ||
|
|
||
| // verifyUpdatePrevented verifies that a machine update is prevented by VAP | ||
| func verifyUpdatePrevented(machine *mapiv1beta1.Machine, updateFunc func(), expectedError string) { | ||
| By("Verifying that machine update is prevented by VAP") | ||
|
|
||
| Eventually(komega.Update(machine, updateFunc), capiframework.WaitMedium, capiframework.RetryMedium).Should( | ||
| MatchError(ContainSubstring(expectedError)), | ||
| "Expected machine update to be blocked by VAP") | ||
| } | ||
|
|
||
| // verifyUpdateAllowed verifies that a machine update is allowed (not blocked by VAP) | ||
| func verifyUpdateAllowed(machine *mapiv1beta1.Machine, updateFunc func()) { | ||
| By("Verifying that machine update is allowed") | ||
|
|
||
| Eventually(komega.Update(machine, updateFunc), capiframework.WaitMedium, capiframework.RetryMedium).Should(Succeed(), | ||
| "Expected machine update to succeed") | ||
| } | ||
|
|
||
| // updateAWSMachineProviderSpec updates an AWS machine's provider spec using the provided update function | ||
| func updateAWSMachineProviderSpec(machine *mapiv1beta1.Machine, updateFunc func(*mapiv1beta1.AWSMachineProviderConfig)) error { | ||
| providerSpec := getAWSProviderSpecFromMachine(machine) | ||
|
|
||
| updateFunc(providerSpec) | ||
|
|
||
| modifiedRaw, err := json.Marshal(providerSpec) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to marshal modified providerSpec: %v", err) | ||
| } | ||
|
|
||
| machine.Spec.ProviderSpec.Value = &runtime.RawExtension{Raw: modifiedRaw} | ||
| return nil | ||
| } | ||
|
|
||
| // getAWSProviderSpecFromMachine extracts the AWS provider spec from a machine | ||
| func getAWSProviderSpecFromMachine(machine *mapiv1beta1.Machine) *mapiv1beta1.AWSMachineProviderConfig { | ||
| Expect(machine.Spec.ProviderSpec.Value).ToNot(BeNil(), "providerSpec should not be nil") | ||
|
|
||
| providerSpec := &mapiv1beta1.AWSMachineProviderConfig{} | ||
| err := json.Unmarshal(machine.Spec.ProviderSpec.Value.Raw, providerSpec) | ||
| Expect(err).ToNot(HaveOccurred(), "should successfully unmarshal providerSpec") | ||
|
|
||
| return providerSpec | ||
| } | ||
|
|
||
| // verifyAWSProviderSpecUpdatePrevented verifies that AWS providerSpec field updates are prevented by VAP | ||
| func verifyAWSProviderSpecUpdatePrevented(machine *mapiv1beta1.Machine, fieldName string, updateFunc func(*mapiv1beta1.AWSMachineProviderConfig), expectedError string) { | ||
| By(fmt.Sprintf("Verifying that updating AWS providerSpec.%s is prevented by VAP", fieldName)) | ||
|
|
||
| Eventually(func() error { | ||
| // Get fresh copy to avoid conflicts | ||
| freshMachine := &mapiv1beta1.Machine{} | ||
| if err := cl.Get(ctx, client.ObjectKeyFromObject(machine), freshMachine); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if err := updateAWSMachineProviderSpec(freshMachine, updateFunc); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return cl.Update(ctx, freshMachine) | ||
| }, capiframework.WaitMedium, capiframework.RetryMedium).Should( | ||
| MatchError(ContainSubstring(expectedError)), | ||
| "Expected AWS providerSpec.%s update to be blocked by VAP", fieldName) | ||
| } | ||
|
|
||
| // verifyVAPNotAppliedForMachineAPIAuthority verifies that VAP is not applied when authoritativeAPI is MachineAPI | ||
| func verifyVAPNotAppliedForMachineAPIAuthority() { | ||
| By("Verifying that VAP is not applied when authoritativeAPI is MachineAPI") | ||
|
|
||
| // Create a test machine with MachineAPI authority | ||
| testMachine := createMAPIMachineWithAuthority(ctx, cl, "vap-test-mapi-authority", mapiv1beta1.MachineAuthorityMachineAPI) | ||
|
|
||
| DeferCleanup(func() { | ||
| By("Cleaning up test machine") | ||
| mapiframework.DeleteMachines(ctx, cl, testMachine) | ||
| }) | ||
|
|
||
| // Verify we can update spec fields (VAP should not apply) | ||
| Eventually(komega.Update(testMachine, func() { | ||
| // Try to update a spec field - this should be allowed since VAP doesn't apply | ||
| providerIDValue := testProviderID | ||
| testMachine.Spec.ProviderID = &providerIDValue | ||
| }), capiframework.WaitMedium, capiframework.RetryMedium).Should(Succeed(), | ||
| "Expected spec update to succeed when authoritativeAPI is MachineAPI (VAP should not apply)") | ||
| } | ||
coderabbitai[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.