Add common Github actions (#11)

.codespellignore

@@ -0,0 +1,4 @@
+capi
+proxmox
+capmox
+decorder

.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/codespell.yml

@@ -0,0 +1,15 @@
+# Helps catch spelling errors
+name: Codespell
+on: [ pull_request ]
+
+jobs:
+  codespell:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@e2f20e631ae6d7dd3b768f56a5d2af784dd54791 # v2.5.0
+      - uses: codespell-project/actions-codespell@22ff5a2e4b591290baf82d47c9feadac31c65441 # v1.0
+        with:
+          skip: .git,_artifacts,*.sum
+          ignore_words_file: .codespellignore
+          check_filenames: true
+          check_hidden: true

.github/workflows/lint.yml

@@ -0,0 +1,16 @@
+name: Lint
+on: [ pull_request ]
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '1.19'
+      - name: golangci-lint
+        uses: golangci/[email protected]
+        with:
+          version: v1.54

.github/workflows/test.yml

@@ -0,0 +1,12 @@
+name: Test
+on: [ pull_request ]
+
+jobs:
+  go_test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '1.19'
+      - run: "make test"

.golangci.yml

@@ -0,0 +1,131 @@
+linters:
+  disable-all: true
+  enable:
+    - asciicheck
+    - bodyclose
+    - dogsled
+    - errcheck
+    - exportloopref
+    - goconst
+    - gocritic
+    - gocyclo
+    - godot
+    - gofmt
+    - goimports
+    - goprintffuncname
+    - gosec
+    - gosimple
+    - govet
+    - importas
+    - ineffassign
+    - misspell
+    - nakedret
+    - nilerr
+    - nolintlint
+    - prealloc
+    - revive
+    - staticcheck
+    - stylecheck
+    - typecheck
+    - unconvert
+    - unparam
+    - unused
+    - whitespace
+
+linters-settings:
+  ifshort:
+    # Maximum length of variable declaration measured in number of characters, after which linter won't suggest using short syntax.
+    max-decl-chars: 50
+  importas:
+    no-unaliased: true
+    alias:
+      # Kubernetes
+      - pkg: k8s.io/api/core/v1
+        alias: corev1
+      - pkg: k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1
+        alias: apiextensionsv1
+      - pkg: k8s.io/apimachinery/pkg/apis/meta/v1
+        alias: metav1
+      - pkg: k8s.io/apimachinery/pkg/api/errors
+        alias: apierrors
+      - pkg: k8s.io/apimachinery/pkg/util/errors
+        alias: kerrors
+      # Controller Runtime
+      - pkg: sigs.k8s.io/controller-runtime
+        alias: ctrl
+      - pkg: sigs.k8s.io/cluster-api/api/v1beta1
+        alias: clusterv1
+  staticcheck:
+    go: "1.19"
+  stylecheck:
+    go: "1.19"
+
+issues:
+  max-same-issues: 0
+  max-issues-per-linter: 0
+  # 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
+  # List of regexps of issue texts to exclude, empty list by default.
+  exclude:
+    # The following are being worked on to remove their exclusion. This list should be reduced or go away all together over time.
+    # If it is decided they will not be addressed they should be moved above this comment.
+    - Subprocess launch(ed with variable|ing should be audited)
+    - (Expect directory permissions to be 0750 or less|Expect file permissions to be 0600 or less)
+    - (G104|G307)
+  exclude-rules:
+    - linters:
+        - gosec
+      text: "G108: Profiling endpoint is automatically exposed on /debug/pprof"
+    - 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
+    # With Go 1.16, the new embed directive can be used with an un-named import,
+    # revive (previously, golint) only allows these to be imported in a main.go, which wouldn't work for us.
+    # This directive allows the embed package to be imported with an underscore everywhere.
+    - linters:
+        - revive
+      source: _ "embed"
+    # Exclude some packages or code to require comments, for example test code, or fake clients.
+    - linters:
+        - revive
+      text: exported (method|function|type|const) (.+) should have comment or be unexported
+      source: (func|type).*Fake.*
+    - linters:
+        - revive
+      text: exported (method|function|type|const) (.+) should have comment or be unexported
+      path: fake_\.go
+    - linters:
+        - revive
+      text: exported (method|function|type|const) (.+) should have comment or be unexported
+      path: "(framework|e2e|infrastructure/docker)/.*.go"
+    # Disable unparam "always receives" which might not be really
+    # useful when building libraries.
+    - linters:
+        - unparam
+      text: always receives
+    # Dot imports for gomega or ginkgo are allowed
+    # within test files.
+    - path: _test\.go
+      text: should not use dot imports
+    - path: (framework|e2e)/.*.go
+      text: should not use dot imports
+    - path: _test\.go
+      text: cyclomatic complexity
+    # Append should be able to assign to a different var/slice.
+    - linters:
+        - gocritic
+      text: "appendAssign: append result not assigned to the same slice"
+
+
+run:
+  timeout: 10m
+  skip-files:
+    - "zz_generated.*\\.go$"
+    - ".*conversion.*\\.go$"
+  skip-dirs:
+    - mock*
+  allow-parallel-runners: true

Makefile

@@ -54,6 +54,10 @@ fmt: ## Run go fmt against code.
 vet: ## Run go vet against code.
 	go vet ./...
 
+.PHONY: lint
+lint: ## Run lint.
+	go run -modfile ./hack/tools/go.mod github.com/golangci/golangci-lint/cmd/golangci-lint run --timeout 5m -c .golangci.yml
+
 .PHONY: test
 test: manifests generate fmt vet envtest ## Run tests.
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out

api/v1alpha1/conditions_consts.go

@@ -9,6 +9,7 @@ const (
 	// VMProvisionFailedReason used for failures during instance provisioning.
 	VMProvisionFailedReason = "VMProvisionFailed"
 
+	// VMTerminatedReason used when vm is being terminated.
 	VMTerminatedReason = "VMTerminated"
 
 	// WaitingForClusterInfrastructureReason (Severity=Info) documents a ProxmoxMachine waiting for the cluster
@@ -65,8 +66,8 @@ const (
 	// NotFoundReason (Severity=Warning) documents the ProxmoxVM not found.
 	NotFoundReason = "NotFound"
 
-	// UnkownReason (Severity=Warning) documents the ProxmoxVM Unkown.
-	UnkownReason = "Unkown"
+	// UnknownReason (Severity=Warning) documents the ProxmoxVM Unknown.
+	UnknownReason = "Unknown"
 )
 
 const (

api/v1alpha1/groupversion_info.go

@@ -25,10 +25,10 @@ import (
 )
 
 var (
-	// GroupVersion is group version used to register these objects
+	// GroupVersion is group version used to register these objects.
 	GroupVersion = schema.GroupVersion{Group: "infrastructure.cluster.x-k8s.io", 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.

api/v1alpha1/proxmoxcluster_types.go

@@ -22,13 +22,14 @@ import (
 )
 
 const (
+	// ProxmoxClusterKind the ProxmoxCluster kind.
 	ProxmoxClusterKind = "ProxmoxCluster"
 	// ClusterFinalizer allows cleaning up resources associated with
 	// ProxmoxCluster before removing it from the apiserver.
 	ClusterFinalizer = "proxmoxcluster.infrastructure.cluster.x-k8s.io"
 )
 
-// ProxmoxClusterSpec defines the desired state of ProxmoxCluster
+// ProxmoxClusterSpec defines the desired state of ProxmoxCluster.
 type ProxmoxClusterSpec struct {
 	// ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.
 	// +optional
@@ -38,7 +39,7 @@ type ProxmoxClusterSpec struct {
 	Node *string `json:"node,omitempty"`
 }
 
-// ProxmoxClusterStatus defines the observed state of ProxmoxCluster
+// ProxmoxClusterStatus defines the observed state of ProxmoxCluster.
 type ProxmoxClusterStatus struct {
 	// Ready indicates that the cluster is ready.
 	// +optional
@@ -57,7 +58,7 @@ type ProxmoxClusterStatus struct {
 //+kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.ready",description="Cluster infrastructure is ready"
 //+kubebuilder:printcolumn:name="Endpoint",type="string",JSONPath=".spec.controlPlaneEndpoint",description="API Endpoint"
 
-// ProxmoxCluster is the Schema for the proxmoxclusters API
+// ProxmoxCluster is the Schema for the proxmoxclusters API.
 type ProxmoxCluster struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -68,17 +69,19 @@ type ProxmoxCluster struct {
 
 //+kubebuilder:object:root=true
 
-// ProxmoxClusterList contains a list of ProxmoxCluster
+// ProxmoxClusterList contains a list of ProxmoxCluster.
 type ProxmoxClusterList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []ProxmoxCluster `json:"items"`
 }
 
+// GetConditions returns the observations of the operational state of the ProxmoxCluster resource.
 func (c *ProxmoxCluster) GetConditions() clusterv1.Conditions {
 	return c.Status.Conditions
 }
 
+// SetConditions sets the underlying service state of the ProxmoxCluster to the predescribed clusterv1.Conditions.
 func (c *ProxmoxCluster) SetConditions(conditions clusterv1.Conditions) {
 	c.Status.Conditions = conditions
 }

api/v1alpha1/proxmoxmachine_types.go

@@ -25,6 +25,7 @@ import (
 )
 
 const (
+	// ProxmoxMachineKind the ProxmoxMachine kind.
 	ProxmoxMachineKind = "ProxmoxMachine"
 
 	// MachineFinalizer allows cleaning up resources associated with
@@ -35,21 +36,23 @@ const (
 	DefaultReconcilerRequeue = 10 * time.Second
 )
 
-// ProxmoxMachineSpec defines the desired state of ProxmoxMachine
+// ProxmoxMachineSpec defines the desired state of ProxmoxMachine.
 type ProxmoxMachineSpec struct {
 	VirtualMachineCloneSpec `json:",inline"`
 
-	// ProviderID is the virtual machine's BIOS UUID formated as
-	// proxmox://12345678-1234-1234-1234-123456789abc
+	// ProviderID is the virtual machine's VM ID formatted as
+	// proxmox://node/100
 	// +optional
 	ProviderID *string `json:"providerID,omitempty"`
 
 	// VirtualMachineID is the Proxmox identifier for the ProxmoxMachine instance.
 	VirtualMachineID *int64 `json:"virtualMachineID,omitempty"`
 }
 
+// TargetFileStorageFormat the target format of the cloned disk.
 type TargetFileStorageFormat string
 
+// Supported disk formats.
 const (
 	TargetStorageFormatRaw   TargetFileStorageFormat = "raw"
 	TargetStorageFormatQcow2 TargetFileStorageFormat = "qcow2"
@@ -99,7 +102,7 @@ type VirtualMachineCloneSpec struct {
 	Target *string `json:"target,omitempty"`
 }
 
-// ProxmoxMachineStatus defines the observed state of ProxmoxMachine
+// ProxmoxMachineStatus defines the observed state of ProxmoxMachine.
 type ProxmoxMachineStatus struct {
 	// Ready indicates the docker infrastructure has been provisioned and is ready
 	// +optional
@@ -184,7 +187,7 @@ type ProxmoxMachineStatus struct {
 // +kubebuilder:printcolumn:name="InstanceID",type="string",JSONPath=".spec.providerID",description="VM ID"
 // +kubebuilder:printcolumn:name="Machine",type="string",JSONPath=".metadata.ownerReferences[?(@.kind==\"Machine\")].name",description="Machine object which owns with this ProxmoxMachine"
 
-// ProxmoxMachine is the Schema for the proxmoxmachines API
+// ProxmoxMachine is the Schema for the proxmoxmachines API.
 type ProxmoxMachine struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -195,7 +198,7 @@ type ProxmoxMachine struct {
 
 //+kubebuilder:object:root=true
 
-// ProxmoxMachineList contains a list of ProxmoxMachine
+// ProxmoxMachineList contains a list of ProxmoxMachine.
 type ProxmoxMachineList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
@@ -212,7 +215,7 @@ func (r *ProxmoxMachine) SetConditions(conditions clusterv1.Conditions) {
 	r.Status.Conditions = conditions
 }
 
-// GetNode get the proxmox node used to provision this machine
+// GetNode get the proxmox node used to provision this machine.
 func (r *ProxmoxMachine) GetNode() string {
 	return r.Spec.Node
 }