Require comments on exported funcs

Author: mboersma

.golangci.yml

@@ -6,26 +6,37 @@ run:
   - "zz_generated.*\\.go$"
   - ".*conversion.*\\.go$"
 linters:
+  disable-all: true
   enable:
+    - deadcode
+    - goconst
+    - gofmt
     - golint
+    - gosec
     - govet
-    - gofmt
-    - structcheck
-    - varcheck
-    - interfacer
-    - unconvert
     - ineffassign
-    - goconst
-    # - gocyclo
+    - interfacer
     - maligned
     - misspell
     - nakedret
     - prealloc
-    - gosec
-    - deadcode
-  disable-all: true
+    - structcheck
+    - unconvert
+    - varcheck
   # Run with --fast=false for more extensive checks
   fast: true
-issue:
+issues:
+  exclude-rules:
+    - path: internal/test/
+      linters:
+        - golint
+    - path: cloudtest\.go
+      linters:
+        - golint
+    - path: api/v1alpha2/types\.go
+      linters:
+        - golint
+  include:
+  - EXC0002 # include "missing comments" issues from golint
+  max-issues-per-linter: 0
   max-same-issues: 0
-  max-per-linter: 0

Makefile

@@ -58,7 +58,7 @@ CONVERSION_GEN := $(TOOLS_BIN_DIR)/$(CONVERSION_GEN_BIN)-$(CONVERSION_GEN_VER)
 ENVSUBST_BIN := envsubst
 ENVSUBST := $(TOOLS_BIN_DIR)/$(ENVSUBST_BIN)-drone
 
-GOLANGCI_LINT_VER := v1.27.0
+GOLANGCI_LINT_VER := v1.31.0
 GOLANGCI_LINT_BIN := golangci-lint
 GOLANGCI_LINT := $(TOOLS_BIN_DIR)/$(GOLANGCI_LINT_BIN)-$(GOLANGCI_LINT_VER)
 

api/v1alpha3/azurecluster_webhook.go

@@ -26,6 +26,7 @@ import (
 // log is for logging in this package.
 var clusterlog = logf.Log.WithName("azurecluster-resource")
 
+// SetupWebhookWithManager sets up and registers the webhook with the manager.
 func (c *AzureCluster) SetupWebhookWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewWebhookManagedBy(mgr).
 		For(c).

api/v1alpha3/azuremachine_validation.go

@@ -19,6 +19,7 @@ package v1alpha3
 import (
 	"encoding/base64"
 	"fmt"
+
 	"github.com/google/uuid"
 
 	"github.com/Azure/azure-sdk-for-go/services/compute/mgmt/2020-06-01/compute"
@@ -44,7 +45,7 @@ func ValidateSSHKey(sshKey string, fldPath *field.Path) field.ErrorList {
 	return allErrs
 }
 
-// ValidateUserAssignedIdentity validates the user-assigned identities list
+// ValidateSystemAssignedIdentity validates the system-assigned identities list.
 func ValidateSystemAssignedIdentity(identityType VMIdentity, old, new string, fldPath *field.Path) field.ErrorList {
 	allErrs := field.ErrorList{}
 

api/v1alpha3/azuremachine_webhook.go

@@ -28,7 +28,7 @@ import (
 // log is for logging in this package.
 var machinelog = logf.Log.WithName("azuremachine-resource")
 
-// SetupWebhookWithManager will setup and register the webhook with the controller mnager
+// SetupWebhookWithManager sets up and registers the webhook with the manager.
 func (m *AzureMachine) SetupWebhookWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewWebhookManagedBy(mgr).
 		For(m).

api/v1alpha3/azuremachinetemplate_webhook.go

@@ -24,6 +24,7 @@ import (
 // log is for logging in this package.
 var _ = logf.Log.WithName("azuremachinetemplate-resource")
 
+// SetupWebhookWithManager sets up and registers the webhook with the manager.
 func (r *AzureMachineTemplate) SetupWebhookWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewWebhookManagedBy(mgr).
 		For(r).

api/v1alpha3/types.go

@@ -177,7 +177,7 @@ const (
 	SKUStandard = SKU("Standard")
 )
 
-// BackendPool defines a load balancer backend pool
+// BackendPool defines a load balancer backend pool.
 type BackendPool struct {
 	Name string `json:"name,omitempty"`
 	ID   string `json:"id,omitempty"`

cloud/converters/rules.go

@@ -22,6 +22,7 @@ import (
 	infrav1 "sigs.k8s.io/cluster-api-provider-azure/api/v1alpha3"
 )
 
+// IngresstoSecurityRule converts a CAPI ingress rule to an Azure network security rule.
 func IngresstoSecurityRule(ingress infrav1.IngressRule) network.SecurityRule {
 	secRule := network.SecurityRule{
 		Name: to.StringPtr(ingress.Name),
@@ -49,6 +50,7 @@ func IngresstoSecurityRule(ingress infrav1.IngressRule) network.SecurityRule {
 	return secRule
 }
 
+// SecuritytoIngressRule converts an Azure network security rule to a CAPI ingress rule.
 func SecuritytoIngressRule(rule network.SecurityRule) infrav1.IngressRule {
 	ingRule := infrav1.IngressRule{
 		Name:             to.String(rule.Name),

cloud/errors.go

@@ -18,9 +18,11 @@ package azure
 
 import (
 	"errors"
+
 	"github.com/Azure/go-autorest/autorest"
 )
 
+// ErrNotOwned is returned when a resource can't be deleted because it isn't owned.
 var ErrNotOwned = errors.New("resource is not managed and cannot be deleted")
 
 // ResourceNotFound parses the error to check if it's a resource not found error.

cloud/interfaces.go

@@ -76,6 +76,7 @@ type ClusterDescriber interface {
 	AdditionalTags() infrav1.Tags
 }
 
+// ClusterScoper combines the ClusterDescriber and NetworkDescriber interfaces.
 type ClusterScoper interface {
 	ClusterDescriber
 	NetworkDescriber

cloud/scope/machinepool.go

@@ -19,6 +19,7 @@ package scope
 import (
 	"context"
 	"encoding/base64"
+
 	"github.com/Azure/go-autorest/autorest/to"
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
@@ -187,6 +188,7 @@ func (m *MachinePoolScope) PatchObject(ctx context.Context) error {
 	return m.patchHelper.Patch(ctx, m.AzureMachinePool)
 }
 
+// AzureMachineTemplate gets the Azure machine template in this scope.
 func (m *MachinePoolScope) AzureMachineTemplate(ctx context.Context) (*infrav1.AzureMachineTemplate, error) {
 	ref := m.MachinePool.Spec.Template.Spec.InfrastructureRef
 	return getAzureMachineTemplate(ctx, m.client, ref.Name, ref.Namespace)
@@ -225,7 +227,7 @@ func (m *MachinePoolScope) GetBootstrapData(ctx context.Context) (string, error)
 	return base64.StdEncoding.EncodeToString(value), nil
 }
 
-// Pick image from the machine configuration, or use a default one.
+// GetVMImage picks an image from the machine configuration, or uses a default one.
 func (m *MachinePoolScope) GetVMImage() (*infrav1.Image, error) {
 	// Use custom Marketplace image, Image ID or a Shared Image Gallery image if provided
 	if m.AzureMachinePool.Spec.Template.Image != nil {

cloud/scope/managedcontrolplane.go

@@ -97,17 +97,20 @@ type ManagedControlPlaneScope struct {
 	PatchTarget      runtime.Object
 }
 
+// ResourceGroup returns the managed control plane's resource group.
 func (s *ManagedControlPlaneScope) ResourceGroup() string {
 	if s.ControlPlane == nil {
 		return ""
 	}
 	return s.ControlPlane.Spec.ResourceGroup
 }
 
+// ClusterName returns the managed control plane's name.
 func (s *ManagedControlPlaneScope) ClusterName() string {
 	return s.Cluster.Name
 }
 
+// Location returns the managed control plane's Azure location, or an empty string.
 func (s *ManagedControlPlaneScope) Location() string {
 	if s.ControlPlane == nil {
 		return ""

cloud/services/managedclusters/managedclusters.go

@@ -74,6 +74,7 @@ type Spec struct {
 	DNSServiceIP *string
 }
 
+// PoolSpec contains agent pool specification details.
 type PoolSpec struct {
 	Name         string
 	SKU          string

cloud/services/scalesets/client.go

@@ -80,7 +80,7 @@ func newPublicIPsClient(subscriptionID string, baseURI string, authorizer autore
 	return c
 }
 
-// Get retrieves information about the model view of a virtual machine scale set.
+// ListInstances retrieves information about the model views of a virtual machine scale set.
 func (ac *AzureClient) ListInstances(ctx context.Context, resourceGroupName, vmssName string) ([]compute.VirtualMachineScaleSetVM, error) {
 	itr, err := ac.scalesetvms.ListComplete(ctx, resourceGroupName, vmssName, "", "", "")
 	if err != nil {
@@ -98,7 +98,7 @@ func (ac *AzureClient) ListInstances(ctx context.Context, resourceGroupName, vms
 	return instances, nil
 }
 
-// Lists all scale sets in a resource group.
+// List returns all scale sets in a resource group.
 func (ac *AzureClient) List(ctx context.Context, resourceGroupName string) ([]compute.VirtualMachineScaleSet, error) {
 	itr, err := ac.scalesets.ListComplete(ctx, resourceGroupName)
 	var instances []compute.VirtualMachineScaleSet
@@ -160,6 +160,7 @@ func (ac *AzureClient) Delete(ctx context.Context, resourceGroupName, vmssName s
 	return err
 }
 
+// GetPublicIPAddress gets the public IP address for the given public IP name.
 func (ac *AzureClient) GetPublicIPAddress(ctx context.Context, resourceGroupName, publicIPName string) (network.PublicIPAddress, error) {
 	return ac.publicIPs.Get(ctx, resourceGroupName, publicIPName, "true")
 }

cloud/services/scalesets/service.go

@@ -13,10 +13,12 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package scalesets
 
 import (
 	"context"
+
 	"github.com/go-logr/logr"
 	infrav1 "sigs.k8s.io/cluster-api-provider-azure/api/v1alpha3"
 	azure "sigs.k8s.io/cluster-api-provider-azure/cloud"

cloud/services/scalesets/vmss.go

@@ -48,6 +48,7 @@ func (s *Service) getExisting(ctx context.Context, name string) (*infrav1exp.VMS
 	return converters.SDKToVMSS(vmss, vmssInstances), nil
 }
 
+// Reconcile idempotently gets, creates, and updates a scale set.
 func (s *Service) Reconcile(ctx context.Context) error {
 	vmssSpec := s.Scope.ScaleSetSpec()
 
@@ -226,6 +227,7 @@ func (s *Service) Reconcile(ctx context.Context) error {
 	return nil
 }
 
+// Delete deletes a scale set.
 func (s *Service) Delete(ctx context.Context) error {
 	vmssSpec := s.Scope.ScaleSetSpec()
 	s.Scope.V(2).Info("deleting VMSS", "scale set", vmssSpec.Name)

cloud/services/tags/client.go

@@ -18,6 +18,7 @@ package tags
 
 import (
 	"context"
+
 	"github.com/Azure/azure-sdk-for-go/services/resources/mgmt/2019-10-01/resources"
 
 	"github.com/Azure/go-autorest/autorest"
@@ -56,7 +57,7 @@ func (ac *AzureClient) GetAtScope(ctx context.Context, scope string) (resources.
 	return ac.tags.GetAtScope(ctx, scope)
 }
 
-// CreateOrUpdate allows adding or replacing the entire set of tags on the specified resource or subscription.
+// CreateOrUpdateAtScope allows adding or replacing the entire set of tags on the specified resource or subscription.
 func (ac *AzureClient) CreateOrUpdateAtScope(ctx context.Context, scope string, parameters resources.TagsResource) (resources.TagsResource, error) {
 	return ac.tags.CreateOrUpdateAtScope(ctx, scope, parameters)
 }

config/crd/bases/infrastructure.cluster.x-k8s.io_azureclusters.yaml

@@ -715,7 +715,7 @@ spec:
                     description: APIServerLB is the Kubernetes API server load balancer.
                     properties:
                       backendPool:
-                        description: BackendPool defines a load balancer backend pool
+                        description: BackendPool defines a load balancer backend pool.
                         properties:
                           id:
                             type: string

controllers/azurecluster_controller.go

@@ -52,6 +52,7 @@ type AzureClusterReconciler struct {
 	ReconcileTimeout time.Duration
 }
 
+// SetupWithManager initializes this controller with a manager.
 func (r *AzureClusterReconciler) SetupWithManager(mgr ctrl.Manager, options controller.Options) error {
 	log := r.Log.WithValues("controller", "AzureCluster")
 	c, err := ctrl.NewControllerManagedBy(mgr).
@@ -82,6 +83,7 @@ func (r *AzureClusterReconciler) SetupWithManager(mgr ctrl.Manager, options cont
 // +kubebuilder:rbac:groups=cluster.x-k8s.io,resources=clusters;clusters/status,verbs=get;list;watch
 // +kubebuilder:rbac:groups=infrastructure.cluster.x-k8s.io,resources=azuremachinetemplates;azuremachinetemplates/status,verbs=get;list;watch
 
+// Reconcile idempotently gets, creates, and updates a cluster.
 func (r *AzureClusterReconciler) Reconcile(req ctrl.Request) (_ ctrl.Result, reterr error) {
 	ctx, cancel := context.WithTimeout(context.Background(), reconciler.DefaultedLoopTimeout(r.ReconcileTimeout))
 	defer cancel()

controllers/azurejson_machinetemplate_controller.go

@@ -47,7 +47,7 @@ type AzureJSONTemplateReconciler struct {
 	ReconcileTimeout time.Duration
 }
 
-// SetupWithManager initializes this controller with a manager
+// SetupWithManager initializes this controller with a manager.
 func (r *AzureJSONTemplateReconciler) SetupWithManager(mgr ctrl.Manager, options controller.Options) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		WithOptions(options).

controllers/azuremachine_controller.go

@@ -52,6 +52,7 @@ type AzureMachineReconciler struct {
 	ReconcileTimeout time.Duration
 }
 
+// SetupWithManager initializes this controller with a manager.
 func (r *AzureMachineReconciler) SetupWithManager(mgr ctrl.Manager, options controller.Options) error {
 	log := r.Log.WithValues("controller", "AzureMachine")
 	// create mapper to transform incoming AzureClusters into AzureMachine requests
@@ -108,6 +109,7 @@ func (r *AzureMachineReconciler) SetupWithManager(mgr ctrl.Manager, options cont
 // +kubebuilder:rbac:groups="",resources=events,verbs=get;list;watch;create;update;patch
 // +kubebuilder:rbac:groups="",resources=secrets;,verbs=get;list;watch
 
+// Reconcile idempotently gets, creates, and updates a machine.
 func (r *AzureMachineReconciler) Reconcile(req ctrl.Request) (_ ctrl.Result, reterr error) {
 	ctx, cancel := context.WithTimeout(context.Background(), reconciler.DefaultedLoopTimeout(r.ReconcileTimeout))
 	defer cancel()

exp/api/v1alpha3/azuremachinepool_types.go

@@ -24,6 +24,7 @@ import (
 )
 
 type (
+	// AzureMachineTemplate defines the template for an AzureMachine.
 	AzureMachineTemplate struct {
 		// VMSize is the size of the Virtual Machine to build.
 		// See https://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/createorupdate#virtualmachinesizetypes

exp/api/v1alpha3/azuremachinepool_webhook.go

@@ -32,6 +32,7 @@ import (
 // log is for logging in this package.
 var azuremachinepoollog = logf.Log.WithName("azuremachinepool-resource")
 
+// SetupWebhookWithManager sets up and registers the webhook with the manager.
 func (amp *AzureMachinePool) SetupWebhookWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewWebhookManagedBy(mgr).
 		For(amp).

exp/api/v1alpha3/azuremanagedcontrolplane_webhook.go

@@ -36,6 +36,7 @@ var azuremanagedcontrolplanelog = logf.Log.WithName("azuremanagedcontrolplane-re
 
 var kubeSemver = regexp.MustCompile(`^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)([-0-9a-zA-Z_\.+]*)?$`)
 
+// SetupWebhookWithManager sets up and registers the webhook with the manager.
 func (r *AzureManagedControlPlane) SetupWebhookWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewWebhookManagedBy(mgr).
 		For(r).

exp/api/v1alpha3/types.go

@@ -21,6 +21,7 @@ import (
 )
 
 type (
+	// VMSSVM defines a VM in a virtual machine scale set.
 	VMSSVM struct {
 		ID               string          `json:"id,omitempty"`
 		InstanceID       string          `json:"instanceID,omitempty"`
@@ -29,6 +30,7 @@ type (
 		State            infrav1.VMState `json:"vmState,omitempty"`
 	}
 
+	// VMSS defines a virtual machine scale set.
 	VMSS struct {
 		ID        string             `json:"id,omitempty"`
 		Name      string             `json:"name,omitempty"`

exp/controllers/azuremachinepool_controller.go

@@ -65,6 +65,7 @@ type (
 	}
 )
 
+// SetupWithManager initializes this controller with a manager.
 func (r *AzureMachinePoolReconciler) SetupWithManager(mgr ctrl.Manager, options controller.Options) error {
 	log := r.Log.WithValues("controller", "AzureMachinePool")
 	// create mapper to transform incoming AzureClusters into AzureMachinePool requests
@@ -120,6 +121,7 @@ func (r *AzureMachinePoolReconciler) SetupWithManager(mgr ctrl.Manager, options
 // +kubebuilder:rbac:groups="",resources=events,verbs=get;list;watch;create;update;patch
 // +kubebuilder:rbac:groups="",resources=secrets;,verbs=get;list;watch
 
+// Reconcile idempotently gets, creates, and updates a machine pool.
 func (r *AzureMachinePoolReconciler) Reconcile(req ctrl.Request) (_ ctrl.Result, reterr error) {
 	ctx, cancel := context.WithTimeout(context.Background(), reconciler.DefaultedLoopTimeout(r.ReconcileTimeout))
 	defer cancel()

exp/controllers/azuremanagedcluster_controller.go

@@ -49,6 +49,7 @@ type AzureManagedClusterReconciler struct {
 	ReconcileTimeout time.Duration
 }
 
+// SetupWithManager initializes this controller with a manager.
 func (r *AzureManagedClusterReconciler) SetupWithManager(mgr ctrl.Manager, options controller.Options) error {
 	log := r.Log.WithValues("controller", "AzureManagedCluster")
 	azManagedCluster := &infrav1exp.AzureManagedCluster{}
@@ -79,6 +80,7 @@ func (r *AzureManagedClusterReconciler) SetupWithManager(mgr ctrl.Manager, optio
 // +kubebuilder:rbac:groups=cluster.x-k8s.io,resources=clusters;clusters/status,verbs=get;list;watch
 // +kubebuilder:rbac:groups="",resources=secrets,verbs=get;list;watch;create;update;patch;delete
 
+// Reconcile idempotently gets, creates, and updates a managed cluster.
 func (r *AzureManagedClusterReconciler) Reconcile(req ctrl.Request) (_ ctrl.Result, reterr error) {
 	ctx, cancel := context.WithTimeout(context.Background(), reconciler.DefaultedLoopTimeout(r.ReconcileTimeout))
 	defer cancel()