Skip to content

🌱 Add basic unit test for EKS AWSManagedControlPlaneReconciler #4808

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

Merged
merged 1 commit into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
84 changes: 77 additions & 7 deletions controlplane/eks/controllers/awsmanagedcontrolplane_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ import (
expinfrav1 "sigs.k8s.io/cluster-api-provider-aws/v2/exp/api/v1beta2"
"sigs.k8s.io/cluster-api-provider-aws/v2/feature"
"sigs.k8s.io/cluster-api-provider-aws/v2/pkg/cloud/scope"
"sigs.k8s.io/cluster-api-provider-aws/v2/pkg/cloud/services"
"sigs.k8s.io/cluster-api-provider-aws/v2/pkg/cloud/services/awsnode"
"sigs.k8s.io/cluster-api-provider-aws/v2/pkg/cloud/services/ec2"
"sigs.k8s.io/cluster-api-provider-aws/v2/pkg/cloud/services/eks"
Expand Down Expand Up @@ -87,6 +88,14 @@ type AWSManagedControlPlaneReconciler struct {
Recorder record.EventRecorder
Endpoints []scope.ServiceEndpoint

awsNodeServiceFactory func(scope.AWSNodeScope) services.AWSNodeInterface
ec2ServiceFactory func(scope.EC2Scope) services.EC2Interface
eksServiceFactory func(*scope.ManagedControlPlaneScope) *eks.Service
iamAuthenticatorServiceFactory func(scope.IAMAuthScope, iamauth.BackendType, client.Client) services.IAMAuthenticatorInterface
kubeProxyServiceFactory func(scope.KubeProxyScope) services.KubeProxyInterface
networkServiceFactory func(scope.NetworkScope) services.NetworkInterface
securityGroupServiceFactory func(*scope.ManagedControlPlaneScope) services.SecurityGroupInterface

EnableIAM bool
AllowAdditionalRoles bool
WatchFilterValue string
Expand All @@ -96,6 +105,62 @@ type AWSManagedControlPlaneReconciler struct {
TagUnmanagedNetworkResources bool
}

// getAWSNodeService factory func is added for testing purpose so that we can inject mocked AWSNodeInterface to the AWSManagedControlPlaneReconciler.
func (r *AWSManagedControlPlaneReconciler) getAWSNodeService(scope scope.AWSNodeScope) services.AWSNodeInterface {
if r.awsNodeServiceFactory != nil {
return r.awsNodeServiceFactory(scope)
}
return awsnode.NewService(scope)
}

// getEC2Service factory func is added for testing purpose so that we can inject mocked EC2Service to the AWSManagedControlPlaneReconciler.
func (r *AWSManagedControlPlaneReconciler) getEC2Service(scope scope.EC2Scope) services.EC2Interface {
if r.ec2ServiceFactory != nil {
return r.ec2ServiceFactory(scope)
}
return ec2.NewService(scope)
}

// getEC2Service factory func is added for testing purpose so that we can inject mocked EC2Service to the AWSManagedControlPlaneReconciler.
func (r *AWSManagedControlPlaneReconciler) getEKSService(scope *scope.ManagedControlPlaneScope) *eks.Service {
if r.ec2ServiceFactory != nil {
return r.eksServiceFactory(scope)
}
return eks.NewService(scope)
}

// getIAMAuthenticatorService factory func is added for testing purpose so that we can inject mocked IAMAuthenticatorInterface to the AWSManagedControlPlaneReconciler.
func (r *AWSManagedControlPlaneReconciler) getIAMAuthenticatorService(scope scope.IAMAuthScope, backend iamauth.BackendType, client client.Client) services.IAMAuthenticatorInterface {
if r.iamAuthenticatorServiceFactory != nil {
return r.iamAuthenticatorServiceFactory(scope, backend, client)
}
return iamauth.NewService(scope, backend, client)
}

// getKubeProxyService factory func is added for testing purpose so that we can inject mocked KubeProxyInterface to the AWSManagedControlPlaneReconciler.
func (r *AWSManagedControlPlaneReconciler) getKubeProxyService(scope scope.KubeProxyScope) services.KubeProxyInterface {
if r.kubeProxyServiceFactory != nil {
return r.kubeProxyServiceFactory(scope)
}
return kubeproxy.NewService(scope)
}

// getNetworkService factory func is added for testing purpose so that we can inject mocked NetworkService to the AWSManagedControlPlaneReconciler.
func (r *AWSManagedControlPlaneReconciler) getNetworkService(scope scope.NetworkScope) services.NetworkInterface {
if r.networkServiceFactory != nil {
return r.networkServiceFactory(scope)
}
return network.NewService(scope)
}

// getSecurityGroupService factory func is added for testing purpose so that we can inject mocked SecurityGroupService to the AWSClusterReconciler.
func (r *AWSManagedControlPlaneReconciler) getSecurityGroupService(scope *scope.ManagedControlPlaneScope) services.SecurityGroupInterface {
if r.securityGroupServiceFactory != nil {
return r.securityGroupServiceFactory(scope)
}
return securitygroup.NewService(scope, securityGroupRolesForControlPlane(scope))
}

// SetupWithManager is used to setup the controller.
func (r *AWSManagedControlPlaneReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager, options controller.Options) error {
log := logger.FromContext(ctx)
Expand Down Expand Up @@ -238,6 +303,11 @@ func (r *AWSManagedControlPlaneReconciler) Reconcile(ctx context.Context, req ct
func (r *AWSManagedControlPlaneReconciler) reconcileNormal(ctx context.Context, managedScope *scope.ManagedControlPlaneScope) (res ctrl.Result, reterr error) {
managedScope.Info("Reconciling AWSManagedControlPlane")

if managedScope.Cluster.Spec.InfrastructureRef == nil {
managedScope.Info("InfrastructureRef not set, skipping reconciliation")
return ctrl.Result{}, nil
}

// TODO (richardcase): we can remove the if check here in the future when we have
// allowed enough time for users to move away from using the single kind for
// infrastructureRef and controlplaneRef.
Expand All @@ -257,13 +327,13 @@ func (r *AWSManagedControlPlaneReconciler) reconcileNormal(ctx context.Context,
}
}

ec2Service := ec2.NewService(managedScope)
networkSvc := network.NewService(managedScope)
ekssvc := eks.NewService(managedScope)
sgService := securitygroup.NewService(managedScope, securityGroupRolesForControlPlane(managedScope))
authService := iamauth.NewService(managedScope, iamauth.BackendTypeConfigMap, managedScope.Client)
awsnodeService := awsnode.NewService(managedScope)
kubeproxyService := kubeproxy.NewService(managedScope)
ec2Service := r.getEC2Service(managedScope)
networkSvc := r.getNetworkService(managedScope)
ekssvc := r.getEKSService(managedScope)
sgService := r.getSecurityGroupService(managedScope)
authService := r.getIAMAuthenticatorService(managedScope, iamauth.BackendTypeConfigMap, managedScope.Client)
awsnodeService := r.getAWSNodeService(managedScope)
kubeproxyService := r.getKubeProxyService(managedScope)

if err := networkSvc.ReconcileNetwork(); err != nil {
return reconcile.Result{}, fmt.Errorf("failed to reconcile network for AWSManagedControlPlane %s/%s: %w", awsManagedControlPlane.Namespace, awsManagedControlPlane.Name, err)
Expand Down
Loading