Add some test coverage (#4)

Author: anmazzotti

.github/workflows/codeql.yml

@@ -0,0 +1,74 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '18 2 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'go' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/unit-tests.yaml

@@ -0,0 +1,24 @@
+name: Unit tests
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+concurrency:
+  group: tests-${{ github.head_ref || github.ref }}-${{ github.repository }}
+  cancel-in-progress: true
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install Go
+      uses: actions/setup-go@v3
+      with:
+        go-version-file: go.mod
+    - name: Run tests
+      run: make test
+    - name: Codecov
+      uses: codecov/codecov-action@v3
+      with:
+        file: ./coverage.out

Dockerfile

@@ -1,5 +1,5 @@
 # Build the manager binary
-FROM golang:1.20 as builder
+FROM golang:1.21 as builder
 ARG TARGETOS
 ARG TARGETARCH
 

Dockerfile.agent

@@ -1,5 +1,5 @@
 # Build the manager binary
-FROM golang:1.20 as builder
+FROM golang:1.21 as builder
 ARG TARGETOS
 ARG TARGETARCH
 
@@ -35,7 +35,6 @@ RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build \
 FROM opensuse/tumbleweed:latest
 
 RUN zypper install -y systemd
-#RUN zypper install -y fuse-overlayfs
 
 COPY --from=builder /workspace/agent /usr/local/sbin/elemental-agent
 COPY test/test-agent-config.yaml /etc/elemental/agent/config.yaml

Makefile

@@ -1,6 +1,7 @@
 GIT_COMMIT?=$(shell git rev-parse HEAD)
 GIT_COMMIT_SHORT?=$(shell git rev-parse --short HEAD)
 GIT_TAG?=$(shell git describe --abbrev=0 --tags 2>/dev/null || echo "v0.0.0" )
+GIT_COMMIT_DATE?=$(shell git show -s --format='%cI' HEAD)
 # Image URL to use all building/pushing image targets
 IMG_NAME ?= ghcr.io/rancher-sandbox/cluster-api-provider-elemental
 IMG_TAG ?= latest
@@ -29,7 +30,17 @@ SHELL = /usr/bin/env bash -o pipefail
 LDFLAGS := -w -s
 LDFLAGS += -X "github.com/rancher-sandbox/cluster-api-provider-elemental/internal/version.Version=${GIT_TAG}"
 LDFLAGS += -X "github.com/rancher-sandbox/cluster-api-provider-elemental/internal/version.Commit=${GIT_COMMIT}"
-LDFLAGS += -X "github.com/rancher-sandbox/cluster-api-provider-elemental/internal/version.CommitDate=${COMMITDATE}"
+LDFLAGS += -X "github.com/rancher-sandbox/cluster-api-provider-elemental/internal/version.CommitDate=${GIT_COMMIT_DATE}"
+
+ABS_TOOLS_DIR :=  $(abspath bin/)
+GO_INSTALL := ./test/scripts/go_install.sh
+
+GINKGO_VER := v2.13.0
+GINKGO := $(ABS_TOOLS_DIR)/ginkgo-$(GINKGO_VER)
+GINKGO_PKG := github.com/onsi/ginkgo/v2/ginkgo
+
+$(GINKGO):
+	GOBIN=$(ABS_TOOLS_DIR) $(GO_INSTALL) $(GINKGO_PKG) ginkgo $(GINKGO_VER)
 
 .PHONY: all
 all: build-provider
@@ -60,6 +71,7 @@ manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and Cust
 .PHONY: generate
 generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
 	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
+	./test/scripts/generate_mocks.sh
 
 .PHONY: openapi
 openapi: ## Generate Elemental OpenAPI specs
@@ -74,8 +86,8 @@ vet: ## Run go vet against code.
 	go vet ./...
 
 .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
+test: manifests generate fmt vet envtest $(GINKGO) ## Run tests.
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" $(GINKGO) -v -r --trace --race --covermode=atomic --coverprofile=coverage.out --coverpkg=github.com/rancher-sandbox/cluster-api-provider-elemental/... ./internal/... ./cmd/...
 
 ##@ Build
 
@@ -104,15 +116,15 @@ docker-build: test ## Build docker image with the manager.
 	$(CONTAINER_TOOL) build \
 		--build-arg "TAG=${GIT_TAG}" \
 		--build-arg "COMMIT=${GIT_COMMIT}" \
-		--build-arg "COMMITDATE=${COMMITDATE}" \
+		--build-arg "COMMITDATE=${GIT_COMMIT_DATE}" \
 		-t ${IMG} .
 
 .PHONY: docker-build-agent
 docker-build-agent: test ## Build docker image with the manager.
 	$(CONTAINER_TOOL) build \
 		--build-arg "TAG=${GIT_TAG}" \
 		--build-arg "COMMIT=${GIT_COMMIT}" \
-		--build-arg "COMMITDATE=${COMMITDATE}" \
+		--build-arg "COMMITDATE=${GIT_COMMIT_DATE}" \
 		-t agent:latest -f Dockerfile.agent .
 
 .PHONY: docker-push

api/v1beta1/elementalregistration_types.go

@@ -33,7 +33,7 @@ type ElementalRegistrationSpec struct {
 	HostAnnotations map[string]string `json:"hostAnnotations,omitempty"`
 	// Config points to Elemental machine configuration.
 	// +optional
-	Config *Config `json:"config,omitempty"`
+	Config Config `json:"config,omitempty"`
 }
 
 // ElementalRegistrationStatus defines the observed state of ElementalRegistration.

api/v1beta1/zz_generated.deepcopy.go

@@ -24,8 +24,6 @@ import (
 const (
 	configPathDefault     = "/etc/elemental/agent/config.yaml"
 	bootstrapSentinelFile = "/run/cluster-api/bootstrap-success.complete"
-	installerUnmanaged    = "unmanaged"
-	installerElemental    = "elemental"
 )
 
 // Flags.
@@ -41,31 +39,37 @@ var (
 	configPath string
 )
 
-// Errors.
 var (
-	ErrUnknownInstaller = errors.New("unknown installer")
+	ErrIncorrectArguments = errors.New("incorrect arguments, run 'elemental-agent --help' for usage")
 )
 
 func main() {
 	fs := vfs.OSFS
-	cmd := newCommand(fs)
+	installerSelector := host.NewInstallerSelector()
+	hostnameManager := hostname.NewManager()
+	client := client.NewClient()
+	cmd := newCommand(fs, installerSelector, hostnameManager, client)
 	if err := cmd.Execute(); err != nil {
 		log.Error(err, "running elemental-agent")
 		os.Exit(1)
 	}
 }
 
-func newCommand(fs vfs.FS) *cobra.Command {
+func newCommand(fs vfs.FS, installerSelector host.InstallerSelector, hostnameManager hostname.Manager, client client.Client) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "elemental-agent",
 		Short: "Elemental Agent command",
 		Long:  "elemental-agent registers a node with the elemental-operator via a config file",
 		RunE: func(_ *cobra.Command, args []string) error {
 			// Display version
 			if versionFlag {
-				log.Infof("Register version %s, commit %s, commit date %s", version.Version, version.Commit, version.CommitDate)
+				log.Infof("Agent version %s, commit %s, commit date %s", version.Version, version.Commit, version.CommitDate)
 				return nil
 			}
+			// Sanity checks
+			if installFlag && resetFlag {
+				return fmt.Errorf("--install and --reset are mutually exclusive: %w", ErrIncorrectArguments)
+			}
 			// Parse config file
 			conf, err := getConfig(fs)
 			if err != nil {
@@ -76,43 +80,31 @@ func newCommand(fs vfs.FS) *cobra.Command {
 				log.EnableDebug()
 				log.Debug("Debug logging enabled")
 			}
-			// Sanity checks
-			if installFlag && resetFlag {
-				log.Info("--install and --reset are mutually exclusive")
-				return nil
-			}
+
 			// Initialize WorkDir
 			if err := utils.CreateDirectory(fs, conf.Agent.WorkDir); err != nil {
 				return fmt.Errorf("creating work directory '%s': %w", conf.Agent.WorkDir, err)
 			}
 			// Initialize Elemental API Client
-			client, err := client.NewClient(fs, conf)
-			if err != nil {
+			if err := client.Init(fs, conf); err != nil {
 				return fmt.Errorf("initializing Elemental API client: %w", err)
 			}
 			// Get current hostname
-			currentHostname, err := hostname.GetCurrentHostname()
+			currentHostname, err := hostnameManager.GetCurrentHostname()
 			if err != nil {
 				return fmt.Errorf("getting current hostname: %w", err)
 			}
 			// Initialize installer
 			log.Info("Initializing Installer")
-			var installer host.Installer
-			switch conf.Agent.Installer {
-			case installerUnmanaged:
-				log.Info("Using Unmanaged OS Installer")
-				installer = host.NewUnmanagedInstaller(fs, configPath, conf.Agent.WorkDir)
-			case installerElemental:
-				log.Info("Using Elemental Installer")
-				installer = host.NewElementalInstaller(fs)
-			default:
-				return fmt.Errorf("parsing installer '%s': %w", conf.Agent.Installer, ErrUnknownInstaller)
+			installer, err := installerSelector.GetInstaller(fs, configPath, conf)
+			if err != nil {
+				return fmt.Errorf("initializing installer: %w", err)
 			}
 
 			// Install
 			if installFlag {
 				log.Info("Installing Elemental")
-				handleInstall(client, installer, conf.Agent.Reconciliation)
+				handleInstall(client, hostnameManager, installer, conf.Agent.Reconciliation)
 				log.Info("Installation successful")
 				return nil
 			}
@@ -194,7 +186,7 @@ func getConfig(fs vfs.FS) (config.Config, error) {
 // This could introduce a new --register flag, leaving the --install as optional (for unmanaged OS for example).
 // However, consider that setting the hostname must be part of the registration workflow,
 // so maybe decoupling would not be possible without a state/cache file where to store the hostname-to-be-set.
-func handleInstall(client client.Client, installer host.Installer, installationRecoveryPeriod time.Duration) {
+func handleInstall(client client.Client, hostnameManager hostname.Manager, installer host.Installer, installationRecoveryPeriod time.Duration) {
 	alreadyRegistered := false
 	installationError := false
 	var newHostname string
@@ -214,7 +206,7 @@ func handleInstall(client client.Client, installer host.Installer, installationR
 		}
 		// Pick the new hostname if not done yet
 		if len(newHostname) == 0 {
-			newHostname, err = hostname.PickHostname(registration.Config.Elemental.Agent.Hostname)
+			newHostname, err = hostnameManager.PickHostname(registration.Config.Elemental.Agent.Hostname)
 			log.Debugf("Selected hostname: %s", newHostname)
 			if err != nil {
 				log.Error(err, "picking new hostname")