Skip to content

🐛 Fix subtests running in same environment and reconciliation bug which was not covered because of that #5048

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.

Sign up for GitHub

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

Merged
k8s-ci-robot merged 1 commit into from
Jul 11, 2024
Merged

🐛 Fix subtests running in same environment and reconciliation bug which was not covered because of that #5048

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 34 additions & 7 deletions exp/controllers/awsmachinepool_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,15 +472,15 @@ func TestAWSMachinePoolReconciler(t *testing.T) {
})

t.Run("ReconcileLaunchTemplate not mocked", func(t *testing.T) {
g := NewWithT(t)
setup(t, g)
reconciler.reconcileServiceFactory = nil // use real implementation, but keep EC2 calls mocked (`ec2ServiceFactory`)
reconSvc = nil // not used
defer teardown(t, g)

launchTemplateIDExisting := "lt-existing"

t.Run("nothing exists, so launch template and ASG must be created", func(t *testing.T) {
g := NewWithT(t)
setup(t, g)
reconciler.reconcileServiceFactory = nil // use real implementation, but keep EC2 calls mocked (`ec2ServiceFactory`)
reconSvc = nil // not used
defer teardown(t, g)

ec2Svc.EXPECT().GetLaunchTemplate(gomock.Eq("test")).Return(nil, "", nil, nil)
ec2Svc.EXPECT().DiscoverLaunchTemplateAMI(gomock.Any()).Return(ptr.To[string]("ami-abcdef123"), nil)
ec2Svc.EXPECT().CreateLaunchTemplate(gomock.Any(), gomock.Eq(ptr.To[string]("ami-abcdef123")), gomock.Eq(userDataSecretKey), gomock.Eq([]byte("shell-script"))).Return("lt-ghijkl456", nil)
Expand All @@ -497,6 +497,12 @@ func TestAWSMachinePoolReconciler(t *testing.T) {
})

t.Run("launch template and ASG exist and need no update", func(t *testing.T) {
g := NewWithT(t)
setup(t, g)
reconciler.reconcileServiceFactory = nil // use real implementation, but keep EC2 calls mocked (`ec2ServiceFactory`)
reconSvc = nil // not used
defer teardown(t, g)

// Latest ID and version already stored, no need to retrieve it
ms.AWSMachinePool.Status.LaunchTemplateID = launchTemplateIDExisting
ms.AWSMachinePool.Status.LaunchTemplateVersion = ptr.To[string]("1")
Expand Down Expand Up @@ -538,6 +544,12 @@ func TestAWSMachinePoolReconciler(t *testing.T) {
})

t.Run("launch template and ASG exist and only AMI ID changed", func(t *testing.T) {
g := NewWithT(t)
setup(t, g)
reconciler.reconcileServiceFactory = nil // use real implementation, but keep EC2 calls mocked (`ec2ServiceFactory`)
reconSvc = nil // not used
defer teardown(t, g)

// Latest ID and version already stored, no need to retrieve it
ms.AWSMachinePool.Status.LaunchTemplateID = launchTemplateIDExisting
ms.AWSMachinePool.Status.LaunchTemplateVersion = ptr.To[string]("1")
Expand Down Expand Up @@ -585,6 +597,12 @@ func TestAWSMachinePoolReconciler(t *testing.T) {
})

t.Run("launch template and ASG exist and only bootstrap data secret name changed", func(t *testing.T) {
g := NewWithT(t)
setup(t, g)
reconciler.reconcileServiceFactory = nil // use real implementation, but keep EC2 calls mocked (`ec2ServiceFactory`)
reconSvc = nil // not used
defer teardown(t, g)

// Latest ID and version already stored, no need to retrieve it
ms.AWSMachinePool.Status.LaunchTemplateID = launchTemplateIDExisting
ms.AWSMachinePool.Status.LaunchTemplateVersion = ptr.To[string]("1")
Expand Down Expand Up @@ -635,6 +653,12 @@ func TestAWSMachinePoolReconciler(t *testing.T) {
})

t.Run("launch template and ASG created from zero, then bootstrap config reference changes", func(t *testing.T) {
g := NewWithT(t)
setup(t, g)
reconciler.reconcileServiceFactory = nil // use real implementation, but keep EC2 calls mocked (`ec2ServiceFactory`)
reconSvc = nil // not used
defer teardown(t, g)

ec2Svc.EXPECT().GetLaunchTemplate(gomock.Eq("test")).Return(nil, "", nil, nil)
ec2Svc.EXPECT().DiscoverLaunchTemplateAMI(gomock.Any()).Return(ptr.To[string]("ami-abcdef123"), nil)
ec2Svc.EXPECT().CreateLaunchTemplate(gomock.Any(), gomock.Eq(ptr.To[string]("ami-abcdef123")), gomock.Eq(userDataSecretKey), gomock.Eq([]byte("shell-script"))).Return("lt-ghijkl456", nil)
Expand All @@ -650,7 +674,6 @@ func TestAWSMachinePoolReconciler(t *testing.T) {
g.Expect(err).To(Succeed())

g.Expect(ms.AWSMachinePool.Status.LaunchTemplateID).ToNot(BeEmpty())
g.Expect(ptr.Deref[string](ms.AWSMachinePool.Status.LaunchTemplateVersion, "")).ToNot(BeEmpty())

// Data secret name changes
newBootstrapSecret := &corev1.Secret{
Expand All @@ -665,6 +688,10 @@ func TestAWSMachinePoolReconciler(t *testing.T) {
g.Expect(testEnv.Create(ctx, newBootstrapSecret)).To(Succeed())
ms.MachinePool.Spec.Template.Spec.Bootstrap.DataSecretName = ptr.To[string](newBootstrapSecret.Name)

// Since `AWSMachinePool.status.launchTemplateVersion` isn't set yet,
// the controller will ask for the current version and then set the status.
ec2Svc.EXPECT().GetLaunchTemplateLatestVersion(gomock.Any()).Return("1", nil)

ec2Svc.EXPECT().GetLaunchTemplate(gomock.Eq("test")).Return(
&expinfrav1.AWSLaunchTemplate{
Name: "test",
Expand Down
4 changes: 3 additions & 1 deletion pkg/cloud/services/ec2/launchtemplate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,9 @@ func (s *Service) ReconcileLaunchTemplate(
return err
}
scope.SetLaunchTemplateLatestVersionStatus(launchTemplateVersion)
return scope.PatchObject()
if err := scope.PatchObject(); err != nil {
return err
}
}

annotation, err := MachinePoolAnnotationJSON(scope, TagsLastAppliedAnnotation)
Expand Down