Added Unit tests for cloud/scope/machine.go (#180)

--------- Co-authored-by: Khaja Omer <komer@akamai.com>
linode · Mar 12, 2024 · 0256f43 · 0256f43
1 parent 7179513
commit 0256f43
Show file tree

Hide file tree

Showing 5 changed files with 558 additions and 12 deletions.
diff --git a/cloud/scope/cluster.go b/cloud/scope/cluster.go
@@ -23,8 +23,6 @@ import (
 
 	"github.com/linode/linodego"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
-	"sigs.k8s.io/cluster-api/util/patch"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 
 	infrav1alpha1 "github.com/linode/cluster-api-provider-linode/api/v1alpha1"
@@ -37,10 +35,6 @@ type ClusterScopeParams struct {
 	LinodeCluster *infrav1alpha1.LinodeCluster
 }
 
-// var patchNewHelper = patch.NewHelper
-
-type patchHelper func(obj client.Object, crClient client.Client) (*patch.Helper, error)
-
 func validateClusterScopeParams(params ClusterScopeParams) error {
 	if params.Cluster == nil {
 		return errors.New("cluster is required when creating a ClusterScope")
@@ -54,7 +48,7 @@ func validateClusterScopeParams(params ClusterScopeParams) error {
 
 // NewClusterScope creates a new Scope from the supplied parameters.
 // This is meant to be called for each reconcile iteration.
-func NewClusterScope(ctx context.Context, apiKey string, params ClusterScopeParams, patchNewHelper patchHelper) (*ClusterScope, error) {
+func NewClusterScope(ctx context.Context, apiKey string, params ClusterScopeParams, patchNewHelper patchNewHelper) (*ClusterScope, error) {
 	if err := validateClusterScopeParams(params); err != nil {
 		return nil, err
 	}

diff --git a/cloud/scope/common.go b/cloud/scope/common.go
@@ -9,11 +9,14 @@ import (
 	"github.com/linode/linodego"
 	"golang.org/x/oauth2"
 	corev1 "k8s.io/api/core/v1"
+	"sigs.k8s.io/cluster-api/util/patch"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/linode/cluster-api-provider-linode/version"
 )
 
+type patchNewHelper func(obj client.Object, crClient client.Client) (*patch.Helper, error)
+
 func createLinodeClient(apiKey string) (*linodego.Client, error) {
 	if apiKey == "" {
 		return nil, errors.New("missing Linode API key")

diff --git a/cloud/scope/machine.go b/cloud/scope/machine.go
@@ -9,7 +9,6 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/types"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
-	"sigs.k8s.io/cluster-api/util/patch"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 
@@ -25,9 +24,9 @@ type MachineScopeParams struct {
 }
 
 type MachineScope struct {
-	client client.Client
+	client k8sClient
 
-	PatchHelper   *patch.Helper
+	PatchHelper   PatchHelper
 	Cluster       *clusterv1.Cluster
 	Machine       *clusterv1.Machine
 	LinodeClient  *linodego.Client
@@ -52,7 +51,7 @@ func validateMachineScopeParams(params MachineScopeParams) error {
 	return nil
 }
 
-func NewMachineScope(ctx context.Context, apiKey string, params MachineScopeParams) (*MachineScope, error) {
+func NewMachineScope(ctx context.Context, apiKey string, params MachineScopeParams, patchNewHelper patchNewHelper) (*MachineScope, error) {
 	if err := validateMachineScopeParams(params); err != nil {
 		return nil, err
 	}
@@ -89,7 +88,7 @@ func NewMachineScope(ctx context.Context, apiKey string, params MachineScopePara
 		return nil, fmt.Errorf("failed to create linode client: %w", err)
 	}
 
-	helper, err := patch.NewHelper(params.LinodeMachine, params.Client)
+	helper, err := patchNewHelper(params.LinodeMachine, params.Client)
 	if err != nil {
 		return nil, fmt.Errorf("failed to init patch helper: %w", err)
 	}