Move packages to internal, fix linter findings (#22)

.golangci.yml

@@ -165,4 +165,11 @@ issues:
   # We are disabling default golangci exclusions because we want to help reviewers to focus on reviewing the most relevant
   # changes in PRs and avoid nitpicking.
   exclude-use-default: false
-  #exclude-rules:
+  # Just synced over some rules from core Cluster API to avoid fixing findings which are ignored there.
+  exclude-rules:
+  - linters:
+    - revive
+    text: "exported: exported method .*\\.(Reconcile|SetupWithManager|SetupWebhookWithManager) should have comment or be unexported"
+  - linters:
+    - errcheck
+    text: Error return value of .((os\.)?std(out|err)\..*|.*Close|.*Flush|os\.Remove(All)?|.*print(f|ln)?|os\.(Un)?Setenv). is not checked

Makefile

@@ -93,11 +93,11 @@ generate-manifests: $(CONTROLLER_GEN) ## Generate manifests e.g. CRD, RBAC etc.
 
 .PHONY: generate-go-deepcopy
 generate-go-deepcopy: $(CONTROLLER_GEN) ## Generate deepcopy go code
-	$(MAKE) clean-generated-deepcopy SRC_DIRS="./api,./pkg/cloud/api"
+	$(MAKE) clean-generated-deepcopy SRC_DIRS="./api,./internal/cloud/api"
 	$(CONTROLLER_GEN) \
 		object:headerFile=./hack/boilerplate/boilerplate.generatego.txt \
 		paths=./api/... \
-        paths=./pkg/cloud/api/...
+        paths=./internal/cloud/api/...
 
 .PHONY: generate-modules
 generate-modules: ## Run go mod tidy to ensure modules are up to date

api/v1alpha1/goofycluster_types.go

@@ -30,12 +30,14 @@ const (
 	ClusterFinalizer = "goofycluster.infrastructure.cluster.x-k8s.io"
 )
 
+// GoofyClusterSpec defines the desired state of the GoofyCluster.
 type GoofyClusterSpec struct {
 	// ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.
 	// +optional
 	ControlPlaneEndpoint APIEndpoint `json:"controlPlaneEndpoint"`
 }
 
+// GoofyClusterStatus defines the observed state of the GoofyCluster.
 type GoofyClusterStatus struct {
 	// Ready denotes that the goofy cluster (infrastructure) is ready.
 	// +optional
@@ -63,6 +65,7 @@ type APIEndpoint struct {
 // +kubebuilder:printcolumn:name="Cluster",type="string",JSONPath=".metadata.labels['cluster\\.x-k8s\\.io/cluster-name']",description="Cluster"
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Time duration since creation of GoofyCluster"
 
+// GoofyCluster is the Schema for the goofy clusters API.
 type GoofyCluster struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

controllers/alias.go

@@ -24,9 +24,9 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller"
 
+	"github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud"
 	goofycontrollers "github.com/fabriziopandini/cluster-api-provider-goofy/internal/controllers"
-	"github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud"
-	"github.com/fabriziopandini/cluster-api-provider-goofy/pkg/server"
+	"github.com/fabriziopandini/cluster-api-provider-goofy/internal/server"
 )
 
 // Following types provides access to reconcilers implemented in internal/controllers, thus

pkg/cloud/alias.go → internal/cloud/alias.go

@@ -19,14 +19,15 @@ package cloud
 import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	cbuilder "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/builder"
-	cclient "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/client"
-	cmanager "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/manager"
+	cbuilder "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/builder"
+	cclient "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/client"
+	cmanager "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/manager"
 )
 
 // Client knows how to perform CRUD operations on resources in a resource group.
 type Client cclient.Client
 
+// Object represents an object.
 type Object client.Object
 
 // Manager initializes shared dependencies such as Caches and Clients, and provides them to Runnables.

pkg/cloud/api/v1alpha1/machine_types.go → internal/cloud/api/v1alpha1/machine_types.go

@@ -20,16 +20,20 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
+// CloudMachineKind is the kind of CloudMachine.
 const CloudMachineKind = "CloudMachine"
 
+// CloudMachineSpec is the spec of CloudMachine.
 type CloudMachineSpec struct {
 }
 
+// CloudMachineStatus is the status of CloudMachine.
 type CloudMachineStatus struct {
 }
 
 // +kubebuilder:object:root=true
 
+// CloudMachine represents a machine in the cloud.
 type CloudMachine struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -40,6 +44,7 @@ type CloudMachine struct {
 
 // +kubebuilder:object:root=true
 
+// CloudMachineList contains a list of CloudMachine.
 type CloudMachineList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

pkg/cloud/runtime/builder/builder.go → internal/cloud/runtime/builder/builder.go

@@ -26,12 +26,12 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
 
-	ccontroller "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/controller"
-	"github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/handler"
-	cmanager "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/manager"
-	cpredicate "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/predicate"
-	creconciler "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/reconcile"
-	csource "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/source"
+	ccontroller "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/controller"
+	"github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/handler"
+	cmanager "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/manager"
+	cpredicate "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/predicate"
+	creconciler "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/reconcile"
+	csource "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/source"
 )
 
 // Builder builds a Controller.

internal/cloud/runtime/builder/doc.go

@@ -0,0 +1,18 @@
+/*
+Copyright 2023 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+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 builder provides a builder to build controllers.
+package builder

pkg/cloud/runtime/builder/options.go → internal/cloud/runtime/builder/options.go

@@ -17,7 +17,7 @@ limitations under the License.
 package builder
 
 import (
-	cpredicate "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/predicate"
+	cpredicate "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/predicate"
 )
 
 // ForOption is some configuration that modifies options for a For request.

pkg/cloud/runtime/cache/cache.go → internal/cloud/runtime/cache/cache.go

@@ -34,6 +34,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
 )
 
+// Cache implements an in-memory cache.
 // TODO: consider if to move to internal.
 type Cache interface {
 	Start(ctx context.Context) error
@@ -52,10 +53,12 @@ type Cache interface {
 	GetInformerForKind(ctx context.Context, gvk schema.GroupVersionKind) (Informer, error)
 }
 
+// Informer forwards events to event handlers.
 type Informer interface {
 	AddEventHandler(handler InformEventHandler) error
 }
 
+// InformEventHandler handle events originated by a source.
 type InformEventHandler interface {
 	OnCreate(resourceGroup string, obj client.Object)
 	OnUpdate(resourceGroup string, oldObj, newObj client.Object)
@@ -110,6 +113,7 @@ func newOwnReferenceFromOwnerReference(namespace string, owner metav1.OwnerRefer
 
 var _ Cache = &cache{}
 
+// NewCache returns a new Cache.
 func NewCache(scheme *runtime.Scheme) Cache {
 	return &cache{
 		scheme:                                   scheme,

pkg/cloud/runtime/cache/cache_test.go → internal/cloud/runtime/cache/cache_test.go

@@ -33,7 +33,7 @@ import (
 	"k8s.io/klog/v2"
 	ctrl "sigs.k8s.io/controller-runtime"
 
-	cloudv1 "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/api/v1alpha1"
+	cloudv1 "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/api/v1alpha1"
 )
 
 var scheme = runtime.NewScheme()
@@ -58,7 +58,6 @@ func Test_cache_scale(t *testing.T) {
 	var listCount uint64
 	var deleteCount uint64
 
-	rand.Seed(time.Now().UnixNano())
 	ctx, cancel := context.WithCancel(context.TODO())
 	defer cancel()
 
@@ -84,8 +83,8 @@ func Test_cache_scale(t *testing.T) {
 			for {
 				select {
 				case <-time.After(wait.Jitter(operationFrequencyForResourceGroup, 1)):
-					operation := rand.Intn(3)
-					item := rand.Intn(objectsForResourceGroups)
+					operation := rand.Intn(3)                   //nolint:gosec // Intentionally using a weak random number generator here.
+					item := rand.Intn(objectsForResourceGroups) //nolint:gosec // Intentionally using a weak random number generator here.
 					switch operation {
 					case 0: // create or get
 						machine := &cloudv1.CloudMachine{

pkg/cloud/runtime/cache/client_test.go → internal/cloud/runtime/cache/client_test.go

@@ -29,7 +29,7 @@ import (
 	"k8s.io/client-go/util/workqueue"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	cloudv1 "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/api/v1alpha1"
+	cloudv1 "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/api/v1alpha1"
 )
 
 func Test_cache_client(t *testing.T) {
@@ -733,7 +733,10 @@ func Test_cache_client(t *testing.T) {
 	})
 }
 
+//nolint:unparam // we want to have resourceGroup as parameter even though we currently always set it to the same value.
 func createMachine(t *testing.T, c *cache, resourceGroup, name string) *cloudv1.CloudMachine {
+	t.Helper()
+
 	g := NewWithT(t)
 
 	obj := &cloudv1.CloudMachine{

pkg/cloud/runtime/cache/gc_test.go → internal/cloud/runtime/cache/gc_test.go

@@ -26,7 +26,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 
-	cloudv1 "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/api/v1alpha1"
+	cloudv1 "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/api/v1alpha1"
 )
 
 func Test_cache_gc(t *testing.T) {

pkg/cloud/runtime/cache/sync_test.go → internal/cloud/runtime/cache/sync_test.go

@@ -25,7 +25,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 
-	cloudv1 "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/api/v1alpha1"
+	cloudv1 "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/api/v1alpha1"
 )
 
 func Test_cache_sync(t *testing.T) {

pkg/cloud/runtime/controller/controller.go → internal/cloud/runtime/controller/controller.go

@@ -27,10 +27,10 @@ import (
 	"k8s.io/client-go/util/workqueue"
 	ctrl "sigs.k8s.io/controller-runtime"
 
-	chandler "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/handler"
-	cpredicate "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/predicate"
-	creconciler "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/reconcile"
-	csource "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/source"
+	chandler "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/handler"
+	cpredicate "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/predicate"
+	creconciler "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/reconcile"
+	csource "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/source"
 )
 
 // Options are the arguments for creating a new Controller.
@@ -39,6 +39,7 @@ type Options struct {
 	Reconciler  creconciler.Reconciler
 }
 
+// Controller represents a controller.
 type Controller interface {
 	Watch(src csource.Source, evthdler chandler.EventHandler, prct ...cpredicate.Predicate) error
 	Start(ctx context.Context) error
@@ -78,6 +79,7 @@ type controller struct {
 	startWatches []watchDescription
 	started      bool
 
+	//nolint:containedctx
 	ctx context.Context
 }
 

pkg/cloud/runtime/controller/controller_test.go → internal/cloud/runtime/controller/controller_test.go

@@ -27,11 +27,11 @@ import (
 	"k8s.io/apimachinery/pkg/types"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	cloudv1 "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/api/v1alpha1"
-	ccache "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/cache"
-	chandler "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/handler"
-	creconciler "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/reconcile"
-	csource "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/source"
+	cloudv1 "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/api/v1alpha1"
+	ccache "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/cache"
+	chandler "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/handler"
+	creconciler "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/reconcile"
+	csource "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/source"
 )
 
 var scheme = runtime.NewScheme()

pkg/cloud/runtime/handler/enqueue_object.go → internal/cloud/runtime/handler/enqueue_object.go

@@ -20,8 +20,8 @@ import (
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/client-go/util/workqueue"
 
-	cevent "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/event"
-	creconciler "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/reconcile"
+	cevent "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/event"
+	creconciler "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/reconcile"
 )
 
 var _ EventHandler = &EnqueueRequestForObject{}

pkg/cloud/runtime/handler/handler.go → internal/cloud/runtime/handler/handler.go

@@ -19,7 +19,7 @@ package handler
 import (
 	"k8s.io/client-go/util/workqueue"
 
-	cevent "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/event"
+	cevent "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/event"
 )
 
 // EventHandler enqueues reconcile.Requests in response to events (e.g. object Create). EventHandlers map an Event

pkg/cloud/runtime/manager/manager.go → internal/cloud/runtime/manager/manager.go

@@ -23,9 +23,9 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 	ctrl "sigs.k8s.io/controller-runtime"
 
-	ccache "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/cache"
-	ccontroller "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/controller"
-	cresourcegroup "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/resourcegroup"
+	ccache "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/cache"
+	ccontroller "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/controller"
+	cresourcegroup "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/resourcegroup"
 )
 
 // Manager initializes shared dependencies such as Caches and Clients, and provides them to Runnables.
@@ -57,6 +57,7 @@ type manager struct {
 	started     bool
 }
 
+// New creates a new manager.
 func New(scheme *runtime.Scheme) Manager {
 	m := &manager{
 		scheme:      scheme,

pkg/cloud/runtime/predicate/predicate.go → internal/cloud/runtime/predicate/predicate.go

@@ -17,7 +17,7 @@ limitations under the License.
 package predicate
 
 import (
-	cevent "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/event"
+	cevent "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/event"
 )
 
 // Predicate filters events before enqueuing the keys.

pkg/cloud/runtime/resourcegroup/cached_resourcegroup.go → internal/cloud/runtime/resourcegroup/cached_resourcegroup.go

@@ -21,8 +21,8 @@ import (
 
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	ccache "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/cache"
-	cclient "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/client"
+	ccache "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/cache"
+	cclient "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/client"
 )
 
 var _ ResourceGroup = &cachedResourceGroup{}
@@ -32,6 +32,7 @@ type cachedResourceGroup struct {
 	cache ccache.Cache
 }
 
+// NewResourceGroup returns a new resource group.
 func NewResourceGroup(name string, cache ccache.Cache) ResourceGroup {
 	return &cachedResourceGroup{
 		name:  name,

pkg/cloud/runtime/resourcegroup/resourcegroup.go → internal/cloud/runtime/resourcegroup/resourcegroup.go

@@ -17,9 +17,10 @@ limitations under the License.
 package resourcegroup
 
 import (
-	cclient "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/client"
+	cclient "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/client"
 )
 
+// ResourceGroup groups resources for a workload cluster.
 type ResourceGroup interface {
 	GetClient() cclient.Client
 }

pkg/cloud/runtime/source/informer_source.go → internal/cloud/runtime/source/informer_source.go

@@ -23,10 +23,10 @@ import (
 	"k8s.io/client-go/util/workqueue"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	ccache "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/cache"
-	cevent "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/event"
-	chandler "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/handler"
-	cpredicate "github.com/fabriziopandini/cluster-api-provider-goofy/pkg/cloud/runtime/predicate"
+	ccache "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/cache"
+	cevent "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/event"
+	chandler "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/handler"
+	cpredicate "github.com/fabriziopandini/cluster-api-provider-goofy/internal/cloud/runtime/predicate"
 )
 
 // Informer is used to provide a source of events originating from CRUD operations inside the resourceGroup (e.g. Resource Create).