Merge pull request kubernetes-sigs#555 from CecileRobertMichon/sweep-todos

🏃 Remove all TODOs in the codebase

Author: k8s-ci-robot

Makefile

@@ -177,7 +177,6 @@ generate-go: $(CONTROLLER_GEN) $(MOCKGEN) $(CONVERSION_GEN) ## Runs Go related g
 		paths=./api/... \
 		paths=./$(EXP_DIR)/api/... \
 		object:headerFile=./hack/boilerplate/boilerplate.generatego.txt
-
 	$(CONVERSION_GEN) \
 		--input-dirs=./api/v1alpha2 \
 		--output-file-base=zz_generated.conversion \

README.md

@@ -19,11 +19,7 @@ hybrid deployments of Kubernetes.
 
 Check out the [Cluster API Quick Start][quickstart] to create your first Kubernetes cluster on Azure using Cluster API.
 
-## Features
-
-TODO
-
----
+------
 
 ## Support Policy
 
@@ -47,7 +43,7 @@ Each version of Cluster API for Azure will attempt to support at least two Kuber
 
 **NOTE:** As the versioning for this project is tied to the versioning of Cluster API, future modifications to this policy may be made to more closely align with other providers in the Cluster API ecosystem.
 
----
+------
 
 ## Documentation
 

api/v1alpha2/zz_generated.conversion.go

@@ -23,22 +23,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// // ResourceSpec defines a generic spec that can used to define Azure resources.
-// TODO: ResourceSpec should be removed once concrete specs have been defined for all Azure resources in use.
-// type ResourceSpec interface{}
-
-// TODO: Write type tests
-
-// AzureResourceReference is a reference to a specific Azure resource by ID
-type AzureResourceReference struct {
-	// ID of resource
-	// +optional
-	ID *string `json:"id,omitempty"`
-	// TODO: Investigate if we should reference resources in other ways
-}
-
-// TODO: Investigate resource filters
-
 // AzureMachineProviderConditionType is a valid value for AzureMachineProviderCondition.Type
 type AzureMachineProviderConditionType string
 
@@ -157,14 +141,6 @@ type SecurityGroup struct {
 	Tags         Tags         `json:"tags,omitempty"`
 }
 
-/*
-// TODO
-// String returns a string representation of the security group.
-func (s *SecurityGroup) String() string {
-	return fmt.Sprintf("id=%s/name=%s", s.ID, s.Name)
-}
-*/
-
 // SecurityGroupProtocol defines the protocol type for a security group rule.
 type SecurityGroupProtocol string
 
@@ -197,45 +173,10 @@ type IngressRule struct {
 	Destination *string `json:"destination,omitempty"`
 }
 
-// TODO
-// String returns a string representation of the ingress rule.
-/*
-func (i *IngressRule) String() string {
-	return fmt.Sprintf("protocol=%s/range=[%d-%d]/description=%s", i.Protocol, i.FromPort, i.ToPort, i.Description)
-}
-*/
-
 // IngressRules is a slice of Azure ingress rules for security groups.
 type IngressRules []*IngressRule
 
-// TODO
-// Difference returns the difference between this slice and the other slice.
-/*
-func (i IngressRules) Difference(o IngressRules) (out IngressRules) {
-	for _, x := range i {
-		found := false
-		for _, y := range o {
-			sort.Strings(x.CidrBlocks)
-			sort.Strings(y.CidrBlocks)
-			sort.Strings(x.SourceSecurityGroupIDs)
-			sort.Strings(y.SourceSecurityGroupIDs)
-			if reflect.DeepEqual(x, y) {
-				found = true
-				break
-			}
-		}
-
-		if !found {
-			out = append(out, x)
-		}
-	}
-
-	return
-}
-*/
-
 // PublicIP defines an Azure public IP address.
-// TODO: Remove once load balancer is implemented.
 type PublicIP struct {
 	ID        string `json:"id,omitempty"`
 	Name      string `json:"name,omitempty"`

api/v1alpha3/types.go

@@ -75,7 +75,6 @@ func (s *Service) Reconcile(ctx context.Context, spec interface{}) error {
 		return errors.New("Invalid Subnet Specification")
 	}
 	if subnet, err := s.Get(ctx, subnetSpec); err == nil {
-		// TODO: add validation on existing subnet
 		// subnet already exists, skip creation
 		if subnetSpec.Role == infrav1.SubnetControlPlane {
 			subnet.DeepCopyInto(s.Scope.ControlPlaneSubnet())

api/v1alpha3/zz_generated.deepcopy.go

@@ -78,12 +78,6 @@ func (s *Service) Reconcile(ctx context.Context, spec interface{}) error {
 		return errors.Wrapf(err, "cannot create vm extension")
 	}
 
-	// TODO: review if can remove this code
-	// if *vmExt.ProvisioningState != string(compute.ProvisioningStateSucceeded) {
-	// 	// If the script failed delete it so it can be retried
-	// 	s.Delete(ctx, vmExtSpec)
-	// }
-
 	klog.V(2).Infof("successfully created vm extension %s ", vmExtSpec.Name)
 	return nil
 }

cloud/services/subnets/subnets.go

@@ -275,7 +275,6 @@ func getResourceNameByID(resourceID string) string {
 
 // generateStorageProfile generates a pointer to a compute.StorageProfile which can utilized for VM creation.
 func generateStorageProfile(vmSpec Spec) (*compute.StorageProfile, error) {
-	// TODO: Validate parameters before building storage profile
 	storageProfile := &compute.StorageProfile{
 		OsDisk: &compute.OSDisk{
 			Name:         to.StringPtr(azure.GenerateOSDiskName(vmSpec.Name)),

cloud/services/virtualmachineextensions/virtualmachineextensions.go

@@ -89,7 +89,6 @@ func (s *Service) Reconcile(ctx context.Context, spec interface{}) error {
 			s.Scope.V(2).Info("Working on custom vnet", "vnet-id", vnet.ID)
 		}
 		// vnet already exists, cannot update since it's immutable
-		// TODO: ensure tags & other managed vnet attributes
 		vnet.DeepCopyInto(s.Scope.Vnet())
 		return nil
 	}

cloud/services/virtualmachines/virtualmachines.go

@@ -123,8 +123,6 @@ func (r *AzureClusterReconciler) reconcileNormal(clusterScope *scope.ClusterScop
 		return reconcile.Result{}, errors.Wrap(err, "failed to reconcile cluster services")
 	}
 
-	// TODO: We may need to use azureCluster.Status.Network.APIServerIP.IPAddress
-	//       instead when we look at configuring private clusters.
 	if azureCluster.Status.Network.APIServerIP.DNSName == "" {
 		clusterScope.Info("Waiting for API server endpoint to exist")
 		return reconcile.Result{RequeueAfter: 15 * time.Second}, nil