Nutanix ControlPlaneEndpoint IP Validation (#5701)

Add IP Uniqueness validation for ControlPlane Enpoint for Nutanix platform.
aws · Apr 25, 2023 · 5fa0222 · 5fa0222
1 parent 3f698ba
commit 5fa0222
Show file tree

Hide file tree

Showing 6 changed files with 80 additions and 3 deletions.
diff --git a/Makefile b/Makefile
@@ -569,6 +569,7 @@ mocks: ## Generate mocks
 	${MOCKGEN} -destination=pkg/aws/mocks/imds.go -package=mocks -source "pkg/aws/imds.go"
 	${MOCKGEN} -destination=pkg/aws/mocks/snowballdevice.go -package=mocks -source "pkg/aws/snowballdevice.go"
 	${MOCKGEN} -destination=pkg/providers/nutanix/mocks/client.go -package=mocks -source "pkg/providers/nutanix/client.go"
+	${MOCKGEN} -destination=pkg/providers/nutanix/mocks/validator.go -package=mocks -source "pkg/providers/nutanix/validator.go"
 	${MOCKGEN} -destination=pkg/providers/nutanix/mocks/roundtripper.go -package=mocks net/http RoundTripper
 	${MOCKGEN} -destination=pkg/providers/snow/mocks/aws.go -package=mocks -source "pkg/providers/snow/aws.go"
 	${MOCKGEN} -destination=pkg/providers/snow/mocks/defaults.go -package=mocks -source "pkg/providers/snow/defaults.go"

diff --git a/pkg/dependencies/factory.go b/pkg/dependencies/factory.go
@@ -386,7 +386,7 @@ func (f *Factory) WithProvider(clusterConfigFile string, clusterConfig *v1alpha1
 	case v1alpha1.SnowDatacenterKind:
 		f.WithUnAuthKubeClient().WithSnowConfigManager()
 	case v1alpha1.NutanixDatacenterKind:
-		f.WithKubectl().WithNutanixClientCache().WithNutanixDefaulter().WithNutanixValidator()
+		f.WithKubectl().WithNutanixClientCache().WithNutanixDefaulter().WithNutanixValidator().WithIPValidator()
 	}
 
 	f.buildSteps = append(f.buildSteps, func(ctx context.Context) error {
@@ -514,9 +514,11 @@ func (f *Factory) WithProvider(clusterConfigFile string, clusterConfig *v1alpha1
 				f.dependencies.Kubectl,
 				f.dependencies.Writer,
 				f.dependencies.NutanixClientCache,
+				f.dependencies.IPValidator,
 				crypto.NewTlsValidator(),
 				httpClient,
 				time.Now,
+				skipIpCheck,
 			)
 			f.dependencies.Provider = provider
 		default:

diff --git a/pkg/providers/nutanix/mocks/validator.go b/pkg/providers/nutanix/mocks/validator.go
diff --git a/pkg/providers/nutanix/provider.go b/pkg/providers/nutanix/provider.go
@@ -51,6 +51,8 @@ type Provider struct {
 	kubectlClient    ProviderKubectlClient
 	validator        *Validator
 	writer           filewriter.FileWriter
+	ipValidator      IPValidator
+	skipIPCheck      bool
 }
 
 var _ providers.Provider = &Provider{}
@@ -63,9 +65,11 @@ func NewProvider(
 	providerKubectlClient ProviderKubectlClient,
 	writer filewriter.FileWriter,
 	clientCache *ClientCache,
+	ipValidator IPValidator,
 	certValidator crypto.TlsValidator,
 	httpClient *http.Client,
 	now types.NowFunc,
+	skipIPCheck bool,
 ) *Provider {
 	datacenterConfig.SetDefaults()
 	for _, machineConfig := range machineConfigs {
@@ -96,6 +100,8 @@ func NewProvider(
 		kubectlClient:    providerKubectlClient,
 		validator:        nutanixValidator,
 		writer:           writer,
+		ipValidator:      ipValidator,
+		skipIPCheck:      skipIPCheck,
 	}
 }
 
@@ -193,6 +199,14 @@ func (p *Provider) SetupAndValidateCreateCluster(ctx context.Context, clusterSpe
 		return fmt.Errorf("failed to generate ssh key: %v", err)
 	}
 
+	if !p.skipIPCheck {
+		if err := p.ipValidator.ValidateControlPlaneIPUniqueness(clusterSpec.Cluster); err != nil {
+			return err
+		}
+	} else {
+		logger.Info("Skipping check for whether control plane ip is in use")
+	}
+
 	return nil
 }
 

diff --git a/pkg/providers/nutanix/provider_test.go b/pkg/providers/nutanix/provider_test.go
@@ -98,7 +98,10 @@ func testNutanixProvider(t *testing.T, nutanixClient Client, kubectl *executable
 	}
 	clientCache.clients[dcConf.Name] = nutanixClient
 
-	provider := NewProvider(dcConf, workerConfs, clusterConf, kubectl, writer, clientCache, certValidator, httpClient, time.Now)
+	ctrl := gomock.NewController(t)
+	mockIPValidator := mocknutanix.NewMockIPValidator(ctrl)
+	mockIPValidator.EXPECT().ValidateControlPlaneIPUniqueness(gomock.Any()).Return(nil).AnyTimes()
+	provider := NewProvider(dcConf, workerConfs, clusterConf, kubectl, writer, clientCache, mockIPValidator, certValidator, httpClient, time.Now, false)
 	require.NotNil(t, provider)
 	return provider
 }
@@ -111,7 +114,10 @@ func testNutanixProviderWithClusterSpec(t *testing.T, nutanixClient Client, kube
 		clients: make(map[string]Client),
 	}
 	clientCache.clients[clusterSpec.NutanixDatacenter.Name] = nutanixClient
-	provider := NewProvider(clusterSpec.NutanixDatacenter, clusterSpec.NutanixMachineConfigs, clusterSpec.Cluster, kubectl, writer, clientCache, certValidator, httpClient, time.Now)
+	ctrl := gomock.NewController(t)
+	mockIPValidator := mocknutanix.NewMockIPValidator(ctrl)
+	mockIPValidator.EXPECT().ValidateControlPlaneIPUniqueness(gomock.Any()).Return(nil).AnyTimes()
+	provider := NewProvider(clusterSpec.NutanixDatacenter, clusterSpec.NutanixMachineConfigs, clusterSpec.Cluster, kubectl, writer, clientCache, mockIPValidator, certValidator, httpClient, time.Now, false)
 	require.NotNil(t, provider)
 	return provider
 }

diff --git a/pkg/providers/nutanix/validator.go b/pkg/providers/nutanix/validator.go
@@ -27,6 +27,11 @@ const (
 	minNutanixDiskGiB      = 20
 )
 
+// IPValidator is an interface that defines methods to validate the control plane IP.
+type IPValidator interface {
+	ValidateControlPlaneIPUniqueness(cluster *anywherev1.Cluster) error
+}
+
 // Validator is a client to validate nutanix resources.
 type Validator struct {
 	httpClient    *http.Client