chore: partially apply staticcheck rule ST1000 (#596)

The ST1000 rule has been applied to everything except the `brokerapi`
and `pkg` directories. Those can be updated in a future chore.

Makefile

@@ -129,7 +129,7 @@ vet: ## Runs go vet
 	${GO} vet ./...
 
 staticcheck: ## Runs staticcheck
-	${GO} run honnef.co/go/tools/cmd/staticcheck ./...
+	${GO} list ./... | grep -v 'fakes$$' | xargs ${GO} run honnef.co/go/tools/cmd/staticcheck
 
 ###### Format #################################################################
 

brokerapi/staticcheck.conf

@@ -0,0 +1 @@
+checks = ["all", "-ST1000"]

brokerpaktestframework/brokerpaktestframework.go

@@ -0,0 +1,2 @@
+// Package brokerpaktestframework implements a test framework that can be used by brokerpaks for testing
+package brokerpaktestframework

cmd/cmd.go

@@ -0,0 +1,2 @@
+// Package cmd implements a command line interface using Cobra
+package cmd

dbservice/dbservice.go

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package dbservice implements database setup, connection, and migration
 package dbservice
 
 import (

dbservice/models/db.go

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package models implements database object models for use with GORM
 package models
 
 const (

integrationtest/helper/helper.go

@@ -0,0 +1,2 @@
+// Package helper implements some test helpers for the integration tests
+package helper

internal/brokerpak/platform/platform.go

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package platform is a utility for handling platform data
 package platform
 
 import (

internal/brokerpak/reader/reader.go

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package reader is for reading manifest files
 package reader
 
 import (

internal/createservice/create_service.go

@@ -1,3 +1,4 @@
+// Package createservice is an experimental mimic for the "cf create-service" command
 package createservice
 
 import (

internal/encryption/compoundencryptor/compoundencryptor.go

@@ -1,3 +1,4 @@
+// Package compoundencryptor allows encryptors to be combined
 package compoundencryptor
 
 import "github.com/cloudfoundry/cloud-service-broker/internal/storage"

internal/encryption/encryption.go

@@ -0,0 +1,2 @@
+// Package encryption handles encryption of secrets
+package encryption

internal/encryption/gcmencryptor/gcmencryptor.go

@@ -1,3 +1,4 @@
+// Package gcmencryptor implements AES GCM encryption
 package gcmencryptor
 
 import (

internal/encryption/noopencryptor/noopencryptor.go

@@ -1,3 +1,4 @@
+// Package noopencryptor looks like an encryptor but doesn't do any encryption
 package noopencryptor
 
 func New() NoopEncryptor {

internal/encryption/passwordcombiner/combiner.go

@@ -1,3 +1,4 @@
+// Package passwordcombiner combines passwords with salt to create encryption keys
 package passwordcombiner
 
 import (

internal/encryption/passwordparser/parser.go

@@ -1,3 +1,4 @@
+// Package passwordparser parses password data
 package passwordparser
 
 import (

internal/infohandler/infohandler.go

@@ -1,3 +1,4 @@
+// Package infohandler handles the /info endpoint
 package infohandler
 
 import (

internal/paramparser/paramparser.go

@@ -0,0 +1,2 @@
+// Package paramparser handles the parsing of parameters from brokerapi
+package paramparser

internal/storage/storage.go

@@ -1,3 +1,4 @@
+// Package storage implements a Database Access Object (DAO)
 package storage
 
 import "gorm.io/gorm"

internal/testmatchers/directory_contents_matcher.go

@@ -1,3 +1,4 @@
+// Package testmatchers implements custom test matchers
 package testmatchers
 
 import (

internal/tfproviderfqn/tfproviderfqn.go

@@ -1,3 +1,4 @@
+// Package tfproviderfqn implements fully qualified Terraform provider names
 package tfproviderfqn
 
 import "fmt"

pkg/staticcheck.conf

@@ -0,0 +1 @@
+checks = ["all", "-ST1000"]

staticcheck.conf

@@ -1 +1 @@
-checks = ["all", "-ST1000"]
+checks = ["all"]

utils/correlation/correlation.go

@@ -1,3 +1,4 @@
+// Package correlation reads correlation IDs from the context for logging
 package correlation
 
 import (

utils/freeport/freeport.go

@@ -1,3 +1,4 @@
+// Package freeport identifies a random unused port
 package freeport
 
 import (

utils/request/request_parser.go

@@ -1,3 +1,4 @@
+// Package request decodes the originating identity header
 package request
 
 import (

utils/stream/stream.go

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package stream implements streaming a bit like 'gulp' on nodejs
 package stream
 
 import (

utils/utils.go

@@ -12,6 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package utils contains various utils that do various things.
+// It is deprecated and any future utils should be added as an appropriately named sub-package.
+// Over time this package should be emptied.
 package utils
 
 import (