refactor: rename CloudDriver -> VCenterDriver (#361)

## Issue
N/A

## Description
Routine maintenance to improve naming and tidy code.

---------

Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com>
Co-authored-by: Ahmad Ibrahim <ahm.ibr@hotmail.com>

Author: TylerGillson

api/vcenter/types.go

@@ -1,6 +1,8 @@
 // Package vcenter contains vCenter object types.
 package vcenter
 
+import "net/url"
+
 // Account contains vCenter account details.
 type Account struct {
 	// Insecure controls whether to validate the vCenter server's certificate.
@@ -16,6 +18,11 @@ type Account struct {
 	Host string `json:"host" yaml:"host"`
 }
 
+// Userinfo returns a vCenter account's credentials in Userinfo format.
+func (a Account) Userinfo() *url.Userinfo {
+	return url.UserPassword(a.Username, a.Password)
+}
+
 // Entity represents a vCenter entity, referenceable via govmomi.
 type Entity int
 

build

@@ -95,7 +95,7 @@ func (r *VsphereValidatorReconciler) Reconcile(ctx context.Context, req ctrl.Req
 	// Always update the expected result count in case the validator's rules have changed
 	vr.Spec.ExpectedResults = validator.Spec.ResultCount()
 
-	// Initialize Vsphere driver
+	// Initialize vCenter auth
 	if validator.Spec.Auth.SecretName == "" && validator.Spec.Auth.Account == nil {
 		l.Error(errCredentialsRequired, "failed to reconcile VsphereValidator with empty credentials")
 		return ctrl.Result{}, errCredentialsRequired

internal/controller/vspherevalidator_controller.go

@@ -37,17 +37,17 @@ func Validate(ctx context.Context, spec v1alpha1.VsphereValidatorSpec, log logr.
 		return resp
 	}
 
-	// Create a new vSphere driver
-	driver, err := vsphere.NewVSphereDriver(*spec.Auth.Account, spec.Datacenter, log)
+	// Create a new vCenter driver
+	driver, err := vsphere.NewVCenterDriver(*spec.Auth.Account, spec.Datacenter, log)
 	if err != nil {
-		resp.AddResult(vrr, fmt.Errorf("failed to create vSphere driver: %w", err))
+		resp.AddResult(vrr, fmt.Errorf("failed to create vCenter driver: %w", err))
 		return resp
 	}
 
 	// Get the authorization manager from the driver
 	authManager := object.NewAuthorizationManager(driver.Client.Client)
 	if authManager == nil {
-		resp.AddResult(vrr, errors.New("invalid vSphere driver; failed to get vim25 authorization manager"))
+		resp.AddResult(vrr, errors.New("invalid vCenter driver; failed to get vim25 authorization manager"))
 		return resp
 	}
 
@@ -61,7 +61,7 @@ func Validate(ctx context.Context, spec v1alpha1.VsphereValidatorSpec, log logr.
 	tagsManager := vtags.NewManager(driver.RestClient)
 
 	// Get the current user
-	userName, err := driver.GetCurrentVmwareUser(ctx)
+	userName, err := driver.CurrentUser(ctx)
 	if err != nil {
 		resp.AddResult(vrr, fmt.Errorf("failed to get current user: %w", err))
 		return resp

pkg/validate/validate.go

@@ -36,11 +36,11 @@ var (
 // ValidationService is a service that validates compute resource rules
 type ValidationService struct {
 	log    logr.Logger
-	driver *vsphere.CloudDriver
+	driver *vsphere.VCenterDriver
 }
 
 // NewValidationService creates a new ValidationService
-func NewValidationService(log logr.Logger, driver *vsphere.CloudDriver) *ValidationService {
+func NewValidationService(log logr.Logger, driver *vsphere.VCenterDriver) *ValidationService {
 	return &ValidationService{
 		log:    log,
 		driver: driver,
@@ -105,7 +105,7 @@ type Usage struct {
 }
 
 // ReconcileComputeResourceValidationRule reconciles the compute resource rule
-func (c *ValidationService) ReconcileComputeResourceValidationRule(rule v1alpha1.ComputeResourceRule, finder *find.Finder, driver *vsphere.CloudDriver, seenScopes map[string]bool) (*types.ValidationRuleResult, error) {
+func (c *ValidationService) ReconcileComputeResourceValidationRule(rule v1alpha1.ComputeResourceRule, finder *find.Finder, driver *vsphere.VCenterDriver, seenScopes map[string]bool) (*types.ValidationRuleResult, error) {
 
 	vr := buildValidationResult(rule, constants.ValidationTypeComputeResources)
 
@@ -212,7 +212,7 @@ func hostUsage(ctx context.Context, rule v1alpha1.ComputeResourceRule, finder *f
 	return &res, nil
 }
 
-func resourcePoolUsage(ctx context.Context, rule v1alpha1.ComputeResourceRule, finder *find.Finder, driver *vsphere.CloudDriver) (*Usage, error) {
+func resourcePoolUsage(ctx context.Context, rule v1alpha1.ComputeResourceRule, finder *find.Finder, driver *vsphere.VCenterDriver) (*Usage, error) {
 	var res Usage
 
 	// cpu & memory

pkg/validators/computeresources/computeresources.go

@@ -22,12 +22,12 @@ import (
 // ValidationService is a service that validates NTP rules
 type ValidationService struct {
 	log        logr.Logger
-	driver     *vsphere.CloudDriver
+	driver     *vsphere.VCenterDriver
 	datacenter string
 }
 
 // NewValidationService creates a new ValidationService
-func NewValidationService(log logr.Logger, driver *vsphere.CloudDriver, datacenter string) *ValidationService {
+func NewValidationService(log logr.Logger, driver *vsphere.VCenterDriver, datacenter string) *ValidationService {
 	return &ValidationService{
 		log:        log,
 		driver:     driver,

pkg/validators/ntp/ntp.go

@@ -25,14 +25,14 @@ var errRequiredPrivilegesNotFound = errors.New("one or more required privileges
 // PrivilegeValidationService is a service that validates user privileges
 type PrivilegeValidationService struct {
 	log         logr.Logger
-	driver      *vsphere.CloudDriver
+	driver      *vsphere.VCenterDriver
 	datacenter  string
 	authManager *object.AuthorizationManager
 	userName    string
 }
 
 // NewPrivilegeValidationService creates a new PrivilegeValidationService
-func NewPrivilegeValidationService(log logr.Logger, driver *vsphere.CloudDriver, datacenter string, authManager *object.AuthorizationManager, userName string) *PrivilegeValidationService {
+func NewPrivilegeValidationService(log logr.Logger, driver *vsphere.VCenterDriver, datacenter string, authManager *object.AuthorizationManager, userName string) *PrivilegeValidationService {
 	return &PrivilegeValidationService{
 		log:         log,
 		driver:      driver,
@@ -50,10 +50,7 @@ func (s *PrivilegeValidationService) ReconcilePrivilegeRule(rule v1alpha1.Privil
 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()
 
-	valid, failures, err := s.driver.ValidateUserPrivilegeOnEntities(ctx, s.authManager, s.datacenter, finder, rule)
-	if !valid {
-		vr.Condition.Failures = failures
-	}
+	vr.Condition.Failures, err = s.driver.ValidateUserPrivilegeOnEntities(ctx, s.authManager, s.datacenter, finder, rule)
 
 	if len(vr.Condition.Failures) > 0 {
 		vr.State = util.Ptr(vapi.ValidationFailed)

pkg/validators/privileges/privilege.go

@@ -34,12 +34,12 @@ func TestPrivilegeValidationService_ReconcilePrivilegeRule(t *testing.T) {
 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()
 
-	userName, err := vcSim.Driver.GetCurrentVmwareUser(ctx)
+	username, err := vcSim.Driver.CurrentUser(ctx)
 	if err != nil {
 		t.Fatal("Error in getting current VMware user from username")
 	}
 
-	validationService := NewPrivilegeValidationService(log, vcSim.Driver, "DC0", authManager, userName)
+	validationService := NewPrivilegeValidationService(log, vcSim.Driver, "DC0", authManager, username)
 
 	testCases := []struct {
 		name           string
@@ -51,7 +51,7 @@ func TestPrivilegeValidationService_ReconcilePrivilegeRule(t *testing.T) {
 			name: "All privileges available",
 			rule: v1alpha1.PrivilegeValidationRule{
 				RuleName:    "VirtualMachine.Config.AddExistingDisk",
-				Username:    userName,
+				Username:    username,
 				ClusterName: "DC0_C0",
 				EntityType:  vcenter.Cluster,
 				EntityName:  "DC0_C0",
@@ -62,9 +62,9 @@ func TestPrivilegeValidationService_ReconcilePrivilegeRule(t *testing.T) {
 			expectedResult: types.ValidationRuleResult{Condition: &vapi.ValidationCondition{
 				ValidationType: "vsphere-privileges",
 				ValidationRule: "validation-cluster-DC0_C0",
-				Message:        fmt.Sprintf("All required vsphere-privileges permissions were found for account: %s", userName),
+				Message:        fmt.Sprintf("All required vsphere-privileges permissions were found for account: %s", username),
 				Details:        []string{},
-				Failures:       nil,
+				Failures:       []string{},
 				Status:         corev1.ConditionTrue,
 			},
 				State: util.Ptr(vapi.ValidationSucceeded),
@@ -74,7 +74,7 @@ func TestPrivilegeValidationService_ReconcilePrivilegeRule(t *testing.T) {
 			name: "Certain privilege not available",
 			rule: v1alpha1.PrivilegeValidationRule{
 				RuleName:    "VirtualMachine.Config.AddExistingDisk",
-				Username:    userName,
+				Username:    username,
 				ClusterName: "DC0_C0",
 				EntityType:  vcenter.Cluster,
 				EntityName:  "DC0_C0",
@@ -85,7 +85,7 @@ func TestPrivilegeValidationService_ReconcilePrivilegeRule(t *testing.T) {
 			expectedResult: types.ValidationRuleResult{Condition: &vapi.ValidationCondition{
 				ValidationType: "vsphere-privileges",
 				ValidationRule: "validation-cluster-DC0_C0",
-				Message:        fmt.Sprintf("One or more required privileges was not found, or a condition was not met for account: %s", userName),
+				Message:        fmt.Sprintf("One or more required privileges was not found, or a condition was not met for account: %s", username),
 				Details:        []string{},
 				Failures:       []string{"user: admin2@vsphere.local does not have privilege: VirtualMachine.Config.DestroyExistingDisk on entity type: cluster with name: DC0_C0"},
 				Status:         corev1.ConditionFalse,

pkg/validators/privileges/privilege_test.go

@@ -43,7 +43,7 @@ func NewValidationService(log logr.Logger) *ValidationService {
 }
 
 // ReconcileTagRules reconciles the tag rules
-func (s *ValidationService) ReconcileTagRules(tagsManager *tags.Manager, finder *find.Finder, driver *vsphere.CloudDriver, rule v1alpha1.TagValidationRule) (*vapitypes.ValidationRuleResult, error) {
+func (s *ValidationService) ReconcileTagRules(tagsManager *tags.Manager, finder *find.Finder, driver *vsphere.VCenterDriver, rule v1alpha1.TagValidationRule) (*vapitypes.ValidationRuleResult, error) {
 	vr := buildValidationResult(rule, constants.ValidationTypeTag)
 
 	valid, err := tagIsValid(tagsManager, finder, driver.Datacenter, rule)

pkg/validators/tags/tags.go

@@ -31,7 +31,7 @@ func init() {
 // VCSimulator is used to mock interactions with a vCenter server
 type VCSimulator struct {
 	Account vcenter.Account
-	Driver  *vsphere.CloudDriver
+	Driver  *vsphere.VCenterDriver
 	log     logr.Logger
 }
 
@@ -74,7 +74,7 @@ func (v *VCSimulator) Start() {
 		log.Fatalf("failed to create vCenter simulator: %s", err)
 	}
 
-	v.Driver, err = vsphere.NewVSphereDriver(v.Account, "DC0", v.log)
+	v.Driver, err = vsphere.NewVCenterDriver(v.Account, "DC0", v.log)
 	if err != nil {
 		log.Fatalf("failed to create driver for vCenter simulator: %s", err)
 	}
@@ -165,7 +165,7 @@ func (v *VCSimulator) createVCenterSimulator(model *simulator.Model) (func(), er
 
 	model.Service.RegisterEndpoints = true
 	model.Service.Listen = &url.URL{
-		User: url.UserPassword(v.Account.Username, v.Account.Password),
+		User: v.Account.Userinfo(),
 		Host: host,
 	}
 	model.Service.TLS = new(tls.Config)