Add godot linter and fix issues

Also, add makefile targets for linters
hashicorp · Feb 22, 2022 · 3bfce36 · 3bfce36
1 parent 06ab056
commit 3bfce36
Show file tree

Hide file tree

Showing 62 changed files with 148 additions and 127 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -2,6 +2,7 @@ linters:
   # enables all defaults + the below, `golangci-lint linters` to see the list of active linters.
   enable:
     - gofmt
+    - godot
     # TODO: re-enable things as we have main cleaned up vs the defaults
     #- stylecheck
     #- goconst

diff --git a/Makefile b/Makefile
@@ -39,17 +39,37 @@ control-plane-clean: ## Delete bin and pkg dirs.
 		$(CURDIR)/control-plane/bin \
 		$(CURDIR)/control-plane/pkg
 
+control-plane-lint: ## Run linter in the control-plane directory.
+	cd control-plane; golangci-lint run -c ../.golangci.yml
+
 ctrl-generate: get-controller-gen ## Run CRD code generation.
 	cd control-plane; $(CONTROLLER_GEN) object:headerFile="build-support/controller/boilerplate.go.txt" paths="./..."
 
 
 
 
+# ===========> CLI Targets
+
+cli-lint: ## Run linter in the control-plane directory.
+	cd cli; golangci-lint run -c ../.golangci.yml
+
+
+
+
+# ===========> Acceptance Tests Targets
+
+acceptance-lint: ## Run linter in the control-plane directory.
+	cd acceptance; golangci-lint run -c ../.golangci.yml
+
+
 # ===========> Shared Targets
 
 help: ## Show targets and their descriptions.
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
+lint: ## Run linter in the control-plane, cli, and acceptance directories.
+	for p in control-plane cli acceptance; do cd $$p; golangci-lint run --path-prefix $$p -c ../.golangci.yml; cd ..; done
+
 ctrl-manifests: get-controller-gen ## Generate CRD manifests.
 	cd control-plane; $(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
 	make copy-crds-to-chart

diff --git a/acceptance/framework/consul/cli_cluster.go b/acceptance/framework/consul/cli_cluster.go
@@ -29,7 +29,7 @@ const (
 	CLIReleaseName = "consul"
 )
 
-// CLICluster
+// CLICluster.
 type CLICluster struct {
 	ctx                environment.TestContext
 	namespace          string

diff --git a/acceptance/framework/consul/consul_cluster.go b/acceptance/framework/consul/consul_cluster.go
@@ -26,7 +26,7 @@ import (
 	"k8s.io/client-go/kubernetes"
 )
 
-// Cluster represents a consul cluster object
+// Cluster represents a consul cluster object.
 type Cluster interface {
 	Create(t *testing.T)
 	Destroy(t *testing.T)
@@ -38,7 +38,7 @@ type Cluster interface {
 }
 
 // HelmCluster implements Cluster and uses Helm
-// to create, destroy, and upgrade consul
+// to create, destroy, and upgrade consul.
 type HelmCluster struct {
 	// ACLToken is an optional ACL token that will be used to create
 	// a Consul API client. If not provided, we will attempt to read

diff --git a/acceptance/framework/environment/environment.go b/acceptance/framework/environment/environment.go
@@ -17,7 +17,7 @@ const (
 )
 
 // TestEnvironment represents the infrastructure environment of the test,
-// such as the kubernetes cluster(s) the test is running against
+// such as the kubernetes cluster(s) the test is running against.
 type TestEnvironment interface {
 	DefaultContext(t *testing.T) TestContext
 	Context(t *testing.T, name string) TestContext

diff --git a/acceptance/tests/mesh-gateway/mesh_gateway_test.go b/acceptance/tests/mesh-gateway/mesh_gateway_test.go
@@ -18,7 +18,7 @@ import (
 const staticClientName = "static-client"
 
 // Test that Connect and wan federation over mesh gateways work in a default installation
-// i.e. without ACLs because TLS is required for WAN federation over mesh gateways
+// i.e. without ACLs because TLS is required for WAN federation over mesh gateways.
 func TestMeshGatewayDefault(t *testing.T) {
 	env := suite.Environment()
 	cfg := suite.Config()

diff --git a/cli/common/flag/flag_bool.go b/cli/common/flag/flag_bool.go
@@ -7,7 +7,7 @@ import (
 	"github.com/posener/complete"
 )
 
-// -- BoolVar  and boolValue
+// -- BoolVar  and boolValue.
 type BoolVar struct {
 	Name       string
 	Aliases    []string

diff --git a/cli/common/flag/flag_enum.go b/cli/common/flag/flag_enum.go
@@ -8,7 +8,7 @@ import (
 	"github.com/posener/complete"
 )
 
-// -- EnumVar and enumValue
+// -- EnumVar and enumValue.
 type EnumVar struct {
 	Name       string
 	Aliases    []string

diff --git a/cli/common/flag/flag_enum_single.go b/cli/common/flag/flag_enum_single.go
@@ -8,7 +8,7 @@ import (
 	"github.com/posener/complete"
 )
 
-// -- EnumVar and enumValue
+// -- EnumVar and enumValue.
 type EnumSingleVar struct {
 	Name       string
 	Aliases    []string

diff --git a/cli/common/flag/flag_float.go b/cli/common/flag/flag_float.go
@@ -7,7 +7,7 @@ import (
 	"github.com/posener/complete"
 )
 
-// -- Float64Var and float64Value
+// -- Float64Var and float64Value.
 type Float64Var struct {
 	Name       string
 	Aliases    []string

diff --git a/cli/common/flag/flag_int.go b/cli/common/flag/flag_int.go
@@ -7,7 +7,7 @@ import (
 	"github.com/posener/complete"
 )
 
-// -- IntVar and intValue
+// -- IntVar and intValue.
 type IntVar struct {
 	Name       string
 	Aliases    []string
@@ -79,7 +79,7 @@ func (i *intValue) String() string   { return strconv.Itoa(int(*i.target)) }
 func (i *intValue) Example() string  { return "int" }
 func (i *intValue) Hidden() bool     { return i.hidden }
 
-// -- Int64Var and int64Value
+// -- Int64Var and int64Value.
 type Int64Var struct {
 	Name       string
 	Aliases    []string
@@ -151,7 +151,7 @@ func (i *int64Value) String() string   { return strconv.FormatInt(int64(*i.targe
 func (i *int64Value) Example() string  { return "int" }
 func (i *int64Value) Hidden() bool     { return i.hidden }
 
-// -- UintVar && uintValue
+// -- UintVar && uintValue.
 type UintVar struct {
 	Name       string
 	Aliases    []string
@@ -223,7 +223,7 @@ func (i *uintValue) String() string   { return strconv.FormatUint(uint64(*i.targ
 func (i *uintValue) Example() string  { return "uint" }
 func (i *uintValue) Hidden() bool     { return i.hidden }
 
-// -- Uint64Var and uint64Value
+// -- Uint64Var and uint64Value.
 type Uint64Var struct {
 	Name       string
 	Aliases    []string

diff --git a/cli/common/flag/flag_string.go b/cli/common/flag/flag_string.go
@@ -6,7 +6,7 @@ import (
 	"github.com/posener/complete"
 )
 
-// -- StringVar and stringValue
+// -- StringVar and stringValue.
 type StringVar struct {
 	Name       string
 	Aliases    []string

diff --git a/cli/common/flag/flag_string_map.go b/cli/common/flag/flag_string_map.go
@@ -8,7 +8,7 @@ import (
 	"github.com/posener/complete"
 )
 
-// -- StringMapVar and stringMapValue
+// -- StringMapVar and stringMapValue.
 type StringMapVar struct {
 	Name       string
 	Aliases    []string

diff --git a/cli/common/flag/flag_string_slice.go b/cli/common/flag/flag_string_slice.go
@@ -7,7 +7,7 @@ import (
 	"github.com/posener/complete"
 )
 
-// -- StringSliceVar and stringSliceValue
+// -- StringSliceVar and stringSliceValue.
 type StringSliceVar struct {
 	Name       string
 	Aliases    []string

diff --git a/cli/common/flag/flag_time.go b/cli/common/flag/flag_time.go
@@ -8,7 +8,7 @@ import (
 	"github.com/posener/complete"
 )
 
-// -- DurationVar and durationValue
+// -- DurationVar and durationValue.
 type DurationVar struct {
 	Name       string
 	Aliases    []string

diff --git a/cli/common/flag/flag_var.go b/cli/common/flag/flag_var.go
@@ -8,7 +8,7 @@ import (
 	"github.com/posener/complete"
 )
 
-// -- VarFlag
+// -- VarFlag.
 type VarFlag struct {
 	Name       string
 	Aliases    []string

diff --git a/cli/common/terminal/basic.go b/cli/common/terminal/basic.go
@@ -15,7 +15,7 @@ import (
 	"github.com/mattn/go-isatty"
 )
 
-// basicUI
+// basicUI.
 type basicUI struct {
 	ctx context.Context
 }
@@ -26,7 +26,7 @@ func NewBasicUI(ctx context.Context) *basicUI {
 	}
 }
 
-// Input implements UI
+// Input implements UI.
 func (ui *basicUI) Input(input *Input) (string, error) {
 	var buf bytes.Buffer
 
@@ -67,12 +67,12 @@ func (ui *basicUI) Input(input *Input) (string, error) {
 	}
 }
 
-// Interactive implements UI
+// Interactive implements UI.
 func (ui *basicUI) Interactive() bool {
 	return isatty.IsTerminal(os.Stdin.Fd())
 }
 
-// Output implements UI
+// Output implements UI.
 func (ui *basicUI) Output(msg string, raw ...interface{}) {
 	msg, style, w := Interpret(msg, raw...)
 
@@ -112,7 +112,7 @@ func (ui *basicUI) Output(msg string, raw ...interface{}) {
 	fmt.Fprintln(w, msg)
 }
 
-// NamedValues implements UI
+// NamedValues implements UI.
 func (ui *basicUI) NamedValues(rows []NamedValue, opts ...Option) {
 	cfg := &config{Writer: color.Output}
 	for _, opt := range opts {
@@ -143,7 +143,7 @@ func (ui *basicUI) NamedValues(rows []NamedValue, opts ...Option) {
 	_, _ = colorInfo.Fprintln(cfg.Writer, buf.String())
 }
 
-// OutputWriters implements UI
+// OutputWriters implements UI.
 func (ui *basicUI) OutputWriters() (io.Writer, io.Writer, error) {
 	return os.Stdout, os.Stderr, nil
 }
diff --git a/cli/common/terminal/table.go b/cli/common/terminal/table.go
@@ -39,7 +39,7 @@ func (t *Table) Rich(cols []string, colors []string) {
 	t.Rows = append(t.Rows, row)
 }
 
-// Table implements UI
+// Table implements UI.
 func (u *basicUI) Table(tbl *Table, opts ...Option) {
 	// Build our config and set our options
 	cfg := &config{Writer: color.Output}

diff --git a/cli/common/terminal/ui.go b/cli/common/terminal/ui.go
@@ -11,7 +11,7 @@ import (
 // ErrNonInteractive is returned when Input is called on a non-Interactive UI.
 var ErrNonInteractive = errors.New("noninteractive UI doesn't support this operation")
 
-// Passed to UI.NamedValues to provide a nicely formatted key: value output
+// Passed to UI.NamedValues to provide a nicely formatted key: value output.
 type NamedValue struct {
 	Name  string
 	Value interface{}
@@ -66,7 +66,7 @@ type Input struct {
 	Secret bool
 }
 
-// Interpret decomposes the msg and arguments into the message, style, and writer
+// Interpret decomposes the msg and arguments into the message, style, and writer.
 func Interpret(msg string, raw ...interface{}) (string, string, io.Writer) {
 	// Build our args and options
 	var args []interface{}

diff --git a/control-plane/api/v1alpha1/exportedservices_types.go b/control-plane/api/v1alpha1/exportedservices_types.go
@@ -40,14 +40,14 @@ type ExportedServices struct {
 
 //+kubebuilder:object:root=true
 
-// ExportedServicesList contains a list of ExportedServices
+// ExportedServicesList contains a list of ExportedServices.
 type ExportedServicesList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []ExportedServices `json:"items"`
 }
 
-// ExportedServicesSpec defines the desired state of ExportedServices
+// ExportedServicesSpec defines the desired state of ExportedServices.
 type ExportedServicesSpec struct {
 	// Services is a list of services to be exported and the list of partitions
 	// to expose them to.

diff --git a/control-plane/api/v1alpha1/groupversion_info.go b/control-plane/api/v1alpha1/groupversion_info.go
@@ -11,10 +11,10 @@ import (
 const ConsulHashicorpGroup string = "consul.hashicorp.com"
 
 var (
-	// GroupVersion is group version used to register these objects
+	// GroupVersion is group version used to register these objects.
 	GroupVersion = schema.GroupVersion{Group: "consul.hashicorp.com", Version: "v1alpha1"}
 
-	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
+	// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
 	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
 
 	// AddToScheme adds the types in this group-version to the given scheme.

diff --git a/control-plane/api/v1alpha1/ingressgateway_types.go b/control-plane/api/v1alpha1/ingressgateway_types.go
@@ -43,14 +43,14 @@ type IngressGateway struct {
 
 // +kubebuilder:object:root=true
 
-// IngressGatewayList contains a list of IngressGateway
+// IngressGatewayList contains a list of IngressGateway.
 type IngressGatewayList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []IngressGateway `json:"items"`
 }
 
-// IngressGatewaySpec defines the desired state of IngressGateway
+// IngressGatewaySpec defines the desired state of IngressGateway.
 type IngressGatewaySpec struct {
 	// TLS holds the TLS configuration for this gateway.
 	TLS GatewayTLSConfig `json:"tls,omitempty"`

diff --git a/control-plane/api/v1alpha1/mesh_types.go b/control-plane/api/v1alpha1/mesh_types.go
@@ -34,14 +34,14 @@ type Mesh struct {
 
 //+kubebuilder:object:root=true
 
-// MeshList contains a list of Mesh
+// MeshList contains a list of Mesh.
 type MeshList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []Mesh `json:"items"`
 }
 
-// MeshSpec defines the desired state of Mesh
+// MeshSpec defines the desired state of Mesh.
 type MeshSpec struct {
 	TransparentProxy TransparentProxyMeshConfig `json:"transparentProxy,omitempty"`
 }

diff --git a/control-plane/api/v1alpha1/proxydefaults_types.go b/control-plane/api/v1alpha1/proxydefaults_types.go
@@ -41,7 +41,7 @@ type ProxyDefaults struct {
 
 // +kubebuilder:object:root=true
 
-// ProxyDefaultsList contains a list of ProxyDefaults
+// ProxyDefaultsList contains a list of ProxyDefaults.
 type ProxyDefaultsList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
@@ -50,7 +50,7 @@ type ProxyDefaultsList struct {
 
 // RawMessage for Config based on recommendation here: https://github.com/kubernetes-sigs/controller-tools/issues/294#issuecomment-518380816
 
-// ProxyDefaultsSpec defines the desired state of ProxyDefaults
+// ProxyDefaultsSpec defines the desired state of ProxyDefaults.
 type ProxyDefaultsSpec struct {
 	// Config is an arbitrary map of configuration values used by Connect proxies.
 	// Any values that your proxy allows can be configured globally here.

diff --git a/control-plane/api/v1alpha1/servicedefaults_types.go b/control-plane/api/v1alpha1/servicedefaults_types.go
@@ -39,14 +39,14 @@ type ServiceDefaults struct {
 
 // +kubebuilder:object:root=true
 
-// ServiceDefaultsList contains a list of ServiceDefaults
+// ServiceDefaultsList contains a list of ServiceDefaults.
 type ServiceDefaultsList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []ServiceDefaults `json:"items"`
 }
 
-// ServiceDefaultsSpec defines the desired state of ServiceDefaults
+// ServiceDefaultsSpec defines the desired state of ServiceDefaults.
 type ServiceDefaultsSpec struct {
 	// Protocol sets the protocol of the service. This is used by Connect proxies for
 	// things like observability features and to unlock usage of the