🏃 Remove all TODOs in the codebase #555

CecileRobertMichon · 2020-04-20T20:01:54Z

What this PR does / why we need it: Removed all TODOs from the code and either 1) Opened a corresponding issue 2) marked as resolve.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #148

Special notes for your reviewer:

Please confirm that if this PR changes any image versions, then that's the sole change this PR makes.

Release note:

NONE

CecileRobertMichon · 2020-04-20T20:02:27Z

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


Makefile

CecileRobertMichon · 2020-04-20T20:04:39Z

api/v1alpha3/types.go

-	// TODO: Investigate if we should reference resources in other ways
-}
-
-// TODO: Investigate resource filters


resolved: Azure doesn't have resource filters, it's an AWS concept only (Azure has resource groups).

CecileRobertMichon · 2020-04-20T20:05:19Z

api/v1alpha3/types.go

-// TODO: ResourceSpec should be removed once concrete specs have been defined for all Azure resources in use.
-// type ResourceSpec interface{}
-
-// TODO: Write type tests


resolved: there are no testable functions in this file, only type definitions

CecileRobertMichon · 2020-04-20T20:06:05Z

api/v1alpha3/types.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{}


resolved: removed this as it is unused and we have individual specs for the Azure resources used.

CecileRobertMichon · 2020-04-20T20:06:55Z

api/v1alpha3/types.go

-	// ID of resource
-	// +optional
-	ID *string `json:"id,omitempty"`
-	// TODO: Investigate if we should reference resources in other ways


resolved: removed AzureResourceReference as it is unused in the codebase and Azure does not have several ways for referencing resources.

CecileRobertMichon · 2020-04-20T20:07:37Z

api/v1alpha3/types.go

@@ -157,14 +141,6 @@ type SecurityGroup struct {
 	Tags         Tags         `json:"tags,omitempty"`
 }

-/*
-// TODO


resolved: dead code

CecileRobertMichon · 2020-04-20T20:08:13Z

api/v1alpha3/types.go

@@ -197,45 +173,10 @@ type IngressRule struct {
 	Destination *string `json:"destination,omitempty"`
 }

-// TODO


resolved: dead code

CecileRobertMichon · 2020-04-20T20:08:21Z

api/v1alpha3/types.go

 // IngressRules is a slice of Azure ingress rules for security groups.
 type IngressRules []*IngressRule

-// TODO


resolved: dead code

CecileRobertMichon · 2020-04-20T20:09:42Z

api/v1alpha3/types.go

 // PublicIP defines an Azure public IP address.
-// TODO: Remove once load balancer is implemented.


resolved: load balancer is already implemented but we still reference this type in the Network struct for APIServerIP.

CecileRobertMichon · 2020-04-20T20:13:08Z

cloud/services/subnets/subnets.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


CecileRobertMichon · 2020-04-20T20:13:28Z

cloud/services/virtualmachineextensions/virtualmachineextensions.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


resolved: dead code

CecileRobertMichon · 2020-04-20T20:16:08Z

cloud/services/virtualmachines/virtualmachines.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


CecileRobertMichon · 2020-04-20T20:21:44Z

cloud/services/virtualnetworks/virtualnetworks.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


resolved: this is not needed: if the vnet is detected as "managed" then it already has the "owner" tags. If not, then it is probably unmanaged and we shouldn't apply those tags. I don't think "other managed vnet attributes" applies here, I believe this is a leftover copy paste from capa.

CecileRobertMichon · 2020-04-20T20:24:14Z

controllers/azurecluster_controller.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


#486 (comment)

CecileRobertMichon · 2020-04-20T20:29:26Z

controllers/azuremachine_controller.go

@@ -217,7 +217,6 @@ func (r *AzureMachineReconciler) reconcileNormal(ctx context.Context, machineSco
 		return reconcile.Result{}, err
 	}

-	// TODO(ncdc): move this validation logic into a validating webhook


CecileRobertMichon · 2020-04-20T20:30:00Z

controllers/azuremachine_controller.go

-// validateUpdate checks that no immutable fields have been updated and
-// returns a slice of errors representing attempts to change immutable state.
-func (r *AzureMachineReconciler) validateUpdate(spec *infrav1.AzureMachineSpec, i *infrav1.VM) (errs []error) {
-	// TODO: Add comparison logic for immutable fields


CecileRobertMichon · 2020-04-20T20:31:12Z

controllers/azuremachine_controller.go

 	// Make sure Spec.ProviderID is always set.
 	machineScope.SetProviderID(fmt.Sprintf("azure:////%s", vm.ID))

 	// Proceed to reconcile the AzureMachine state.
 	machineScope.SetVMState(vm.State)

-	// TODO(vincepri): Remove this annotation when clusterctl is no longer relevant.


@vincepri is this still relevant?

I don't think we use this any longer, cc @fabriziopandini

clusterctl uses cluster.x-k8s.io/provider label, so AFAIK this annotation can be removed

hmm I removed it and now E2E is failing so maybe it is needed...

CecileRobertMichon · 2020-04-20T20:32:14Z

controllers/azuremachine_reconciler.go

@@ -42,7 +42,6 @@ const (
 )

 // azureMachineService are list of services required by cluster actuator, easy to create a fake
-// TODO: We should decide if we want to keep this


CecileRobertMichon · 2020-04-20T20:32:50Z

hack/tools/go.mod

@@ -24,17 +24,3 @@ require (
 	sigs.k8s.io/kustomize/kustomize/v3 v3.5.4
 	sigs.k8s.io/testing_frameworks v0.1.2
 )
-
-replace (
-	// TODO(vincepri) Remove the following replace directives, needed for golangci-lint until


resolved: golangci/golangci-lint#595 is fixed.

CecileRobertMichon · 2020-04-20T20:33:09Z

scripts/ci-conformance.sh

@@ -133,7 +133,6 @@ run_tests() {
 }

 get_logs() {
-    # TODO collect more logs https://github.com/kubernetes-sigs/cluster-api-provider-azure/issues/474 


CecileRobertMichon · 2020-04-20T20:39:54Z

test/e2e/generators/capi.go

@@ -49,7 +49,6 @@ func (g *ClusterAPI) releaseYAMLPath() string {

 // Manifests return the generated components and any error if there is one.
 func (g *ClusterAPI) Manifests(ctx context.Context) ([]byte, error) {
-	// TODO: this is not very nice


@jadarsie is this still relevant? If so could you please file an issue with what you had in mind

Not my comment actually, it was there in the first iteration of the test framework

kubernetes-sigs/cluster-api@ea48d0c#diff-c4cddf335f3f881e1b942982a3ada01f

thanks, removed those files in #569 because I realized these were duplicates from the ones in the upstream framework.

CecileRobertMichon · 2020-04-20T20:40:12Z

test/e2e/generators/capz.go

@@ -59,6 +59,5 @@ func expandCredVariables(stdout []byte, creds auth.Creds) []byte {
 	os.Setenv("AZURE_CLIENT_SECRET_B64", base64.StdEncoding.EncodeToString([]byte(creds.ClientSecret)))
 	os.Setenv("AZURE_SUBSCRIPTION_ID_B64", base64.StdEncoding.EncodeToString([]byte(creds.SubscriptionID)))
 	os.Setenv("AZURE_TENANT_ID_B64", base64.StdEncoding.EncodeToString([]byte(creds.TenantID)))
-	// TODO Figure out a better way of doing this


@jadarsie same here

I do not remember what I meant. Probably something related to the fact that stdout is turned into string and []byte back and forth a few times.

I think it can be removed

CecileRobertMichon · 2020-04-20T20:41:55Z

test/integration/metacluster_test.go

@@ -47,7 +47,4 @@ var _ = Describe("Metacluster", func() {
 	AfterEach(func() {
 		kindCluster.Teardown()
 	})
-
-	// TODO: validate that the controller-manager is deployed and the


resolved: this test suite is empty and not being used. @justaugustus to confirm there is nothing to do here.

Fine to remove

CecileRobertMichon · 2020-04-20T23:06:04Z

/hold

waiting for a few responses from TODO items owners

CecileRobertMichon · 2020-04-23T16:46:54Z

/hold cancel

CecileRobertMichon · 2020-04-23T16:58:54Z

/retest

CecileRobertMichon · 2020-04-23T16:59:08Z

/hold cancel

CecileRobertMichon · 2020-04-23T18:37:46Z

/retest

justaugustus · 2020-04-24T04:28:18Z

This is a really impressive cleanup, @CecileRobertMichon!
/lgtm
/approve

k8s-ci-robot · 2020-04-24T04:28:26Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: CecileRobertMichon, justaugustus

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [CecileRobertMichon,justaugustus]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot requested review from justaugustus and nader-ziada April 20, 2020 20:02

k8s-ci-robot added area/provider/azure Issues or PRs related to azure provider sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Apr 20, 2020

CecileRobertMichon commented Apr 20, 2020

View reviewed changes

Makefile Outdated Show resolved Hide resolved

CecileRobertMichon commented Apr 20, 2020

View reviewed changes

CecileRobertMichon changed the title ~~[WIP] 🏃 Remove all TODOs in the codebase~~ 🏃 Remove all TODOs in the codebase Apr 20, 2020

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 20, 2020

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 20, 2020

CecileRobertMichon added this to Review in progress in Cluster API Azure Apr 21, 2020

CecileRobertMichon mentioned this pull request Apr 23, 2020

feat: implement AzureMachinePool #483

Merged

3 tasks

CecileRobertMichon force-pushed the sweep-todos branch from efbe06a to 13ca645 Compare April 23, 2020 16:45

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 23, 2020

CecileRobertMichon force-pushed the sweep-todos branch from 8258cb5 to d6b045d Compare April 23, 2020 23:14

🏃 Remove all TODOs in the codebase

9734e9f

CecileRobertMichon force-pushed the sweep-todos branch from d6b045d to 9734e9f Compare April 23, 2020 23:17

k8s-ci-robot assigned justaugustus Apr 24, 2020

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 24, 2020

k8s-ci-robot merged commit 3db249f into kubernetes-sigs:master Apr 24, 2020

Cluster API Azure automation moved this from Review in progress to Done (2020 - Q1) Apr 24, 2020

k8s-ci-robot added this to the v0.5 milestone Apr 24, 2020

CecileRobertMichon deleted the sweep-todos branch September 29, 2020 21:12

		// PublicIP defines an Azure public IP address.
		// TODO: Remove once load balancer is implemented.

🏃 Remove all TODOs in the codebase #555

🏃 Remove all TODOs in the codebase #555

Conversation

CecileRobertMichon commented Apr 20, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CecileRobertMichon commented Apr 20, 2020

CecileRobertMichon commented Apr 23, 2020

CecileRobertMichon commented Apr 23, 2020

CecileRobertMichon commented Apr 23, 2020

CecileRobertMichon commented Apr 23, 2020

justaugustus commented Apr 24, 2020

k8s-ci-robot commented Apr 24, 2020

CecileRobertMichon commented Apr 20, 2020 •

edited