Druid Refactor to Address Multiple Controller Conflicts

.ci/hack/doc.go

@@ -1,16 +1,6 @@
-// Copyright 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
+// SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and Gardener contributors
 //
-// 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.
+// SPDX-License-Identifier: Apache-2.0
 
-// This package imports CI related scripts - it is to force `go mod` to see them as dependencies.
+// Package ci imports CI related scripts - it is to force `go mod` to see them as dependencies.
 package ci

.ci/hack/prepare_release

@@ -1,18 +1,7 @@
 #!/usr/bin/env sh
+# SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and Gardener contributors
 #
-# Copyright 2019 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
-#
-# 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.
+# SPDX-License-Identifier: Apache-2.0
 
 set -e
 

.ci/hack/set_dependency_version

@@ -1,18 +1,7 @@
 #!/usr/bin/env python3
+# SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and Gardener contributors
 #
-# Copyright 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
-#
-# 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.
+# SPDX-License-Identifier: Apache-2.0
 
 import json
 import pathlib

.dockerignore

@@ -10,6 +10,8 @@
 !controllers/
 !pkg/
 !test/
+!internal/
+!vendor/
 !.golangci.yaml
 !go.mod
 !go.sum

.github/dependabot.yml

@@ -1,16 +1,6 @@
-# Copyright 2023 SAP SE or an SAP affiliate company
+# SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and Gardener contributors
 #
-# 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.
+# SPDX-License-Identifier: Apache-2.0
 
 # To get started with Dependabot version updates, you'll need to specify which
 # package ecosystems to update and where the package manifests are located.

.golangci.yaml

@@ -1,15 +1,13 @@
 run:
   concurrency: 4
-  deadline: 10m
-
-  skip-files:
-    - "zz_generated\\..*\\.go$"
+  timeout: 10m
 
 linters:
   disable:
     - unused
   enable:
     - revive
+    - loggercheck
 
 issues:
   exclude-use-default: false
@@ -32,3 +30,20 @@ issues:
     - linters:
         - staticcheck
       text: "SA1019:" # Excludes messages where deprecated variables are used
+
+  exclude-files:
+    - "zz_generated\\..*\\.go$"
+
+linters-settings:
+  revive:
+    rules:
+      - name: duplicated-imports
+      - name: unused-parameter
+      - name: unreachable-code
+      - name: context-as-argument
+      - name: early-return
+      - name: exported
+  loggercheck:
+    no-printf-like: true
+    logr: true
+    zap: true

Makefile

@@ -22,93 +22,76 @@ IMG ?= ${IMAGE_REPOSITORY}:${IMAGE_BUILD_TAG}
 #########################################
 
 TOOLS_DIR := $(HACK_DIR)/tools
-include $(HACK_DIR)/tools.mk
 include $(GARDENER_HACK_DIR)/tools.mk
+include $(HACK_DIR)/tools.mk
+
+#####################################################################
+# Rules for verification, formatting, linting, testing and cleaning #
+#####################################################################
 
 .PHONY: tidy
 tidy:
 	@env GO111MODULE=on go mod tidy
 	@GARDENER_HACK_DIR=$(GARDENER_HACK_DIR) bash $(HACK_DIR)/update-github-templates.sh
 	@cp $(GARDENER_HACK_DIR)/cherry-pick-pull.sh $(HACK_DIR)/cherry-pick-pull.sh && chmod +xw $(HACK_DIR)/cherry-pick-pull.sh
 
-kind-up kind-down ci-e2e-kind deploy-localstack test-e2e: export KUBECONFIG = $(KUBECONFIG_PATH)
-
-all: druid
-
-# Build manager binary
-.PHONY: druid
-druid: fmt check
-	@env GO111MODULE=on go build -o bin/druid main.go
-
-# Run against the configured Kubernetes cluster in ~/.kube/config
-.PHONY: run
-run: fmt check
-	go run ./main.go
-
-# Install CRDs into a cluster
-.PHONY: install
-install: manifests
-	kubectl apply -f config/crd/bases
-
-# Deploy controller in the configured Kubernetes cluster in ~/.kube/config
-.PHONY: deploy-via-kustomize
-deploy-via-kustomize: manifests $(KUSTOMIZE)
-	kubectl apply -f config/crd/bases
-	kustomize build config/default | kubectl apply -f -
+.PHONY: clean
+clean:
+	@bash $(GARDENER_HACK_DIR)/clean.sh ./api/... ./internal/...
 
-# Deploy controller to the Kubernetes cluster specified in the environment variable KUBECONFIG
-# Modify the Helm template located at charts/druid/templates if any changes are required
-.PHONY: deploy
-deploy: $(SKAFFOLD) $(HELM)
-	$(SKAFFOLD) run -m etcd-druid --kubeconfig=$(KUBECONFIG_PATH)
+.PHONY: update-dependencies
+update-dependencies:
+	@env GO111MODULE=on go get -u
+	@make tidy
 
-# Generate manifests e.g. CRD, RBAC etc.
-.PHONY: manifests
-manifests: $(VGOPATH) $(CONTROLLER_GEN)
-	@GARDENER_HACK_DIR=$(GARDENER_HACK_DIR) VGOPATH=$(VGOPATH) go generate ./config/crd/bases
-	@find "$(REPO_ROOT)/config/crd/bases" -name "*.yaml" -exec cp '{}' "$(REPO_ROOT)/charts/druid/charts/crds/templates/" \;
-	@controller-gen rbac:roleName=manager-role paths="./controllers/..."
+.PHONY: add-license-headers
+add-license-headers: $(GO_ADD_LICENSE)
+	@bash $(HACK_DIR)/addlicenseheaders.sh ${YEAR}
 
 # Run go fmt against code
 .PHONY: fmt
 fmt:
 	@env GO111MODULE=on go fmt ./...
 
-.PHONY: clean
-clean:
-	@bash $(GARDENER_HACK_DIR)/clean.sh ./api/... ./controllers/... ./pkg/...
-
 # Check packages
 .PHONY: check
 check: $(GOLANGCI_LINT) $(GOIMPORTS) fmt manifests
-	@REPO_ROOT=$(REPO_ROOT) bash $(GARDENER_HACK_DIR)/check.sh --golangci-lint-config=./.golangci.yaml ./api/... ./pkg/... ./controllers/...
+	@REPO_ROOT=$(REPO_ROOT) bash $(GARDENER_HACK_DIR)/check.sh --golangci-lint-config=./.golangci.yaml ./api/... ./internal/...
 
 .PHONY: check-generate
 check-generate:
 	@bash $(GARDENER_HACK_DIR)/check-generate.sh "$(REPO_ROOT)"
 
+# Generate manifests e.g. CRD, RBAC etc.
+.PHONY: manifests
+manifests: $(VGOPATH) $(CONTROLLER_GEN)
+	@HACK_DIR=$(HACK_DIR) VGOPATH=$(VGOPATH) go generate ./config/crd/bases
+	@find "$(REPO_ROOT)/config/crd/bases" -name "*.yaml" -exec cp '{}' "$(REPO_ROOT)/charts/druid/charts/crds/templates/" \;
+	@controller-gen rbac:roleName=manager-role paths="./internal/controller/..."
+
 # Generate code
 .PHONY: generate
 generate: manifests $(CONTROLLER_GEN) $(GOIMPORTS) $(MOCKGEN)
-	@go generate "$(REPO_ROOT)/pkg/..."
-	@bash $(HACK_DIR)/update-codegen.sh
-
-# Build the docker image
-.PHONY: docker-build
-docker-build:
-	docker build . -t ${IMG} --rm
-	@echo "updating kustomize image patch file for manager resource"
-	sed -i'' -e 's@image: .*@image: '"${IMG}"'@' ./config/default/manager_image_patch.yaml
-
-# Push the docker image
-.PHONY: docker-push
-docker-push:
-	docker push ${IMG}
+	@go generate "$(REPO_ROOT)/internal/..."
+	@"$(HACK_DIR)/update-codegen.sh"
 
 # Run tests
 .PHONY: test
-test: $(GINKGO) $(SETUP_ENVTEST)
-	@bash $(HACK_DIR)/test.sh ./api/... ./controllers/... ./pkg/...
+test: $(GINKGO) $(GOTESTFMT)
+	# run ginkgo unit tests. These will be ported to golang native tests over a period of time.
+	@"$(HACK_DIR)/test.sh" ./internal/controller/etcdcopybackupstask/... \
+	./internal/controller/predicate/... \
+	./internal/controller/secret/... \
+	./internal/controller/utils/... \
+	./internal/mapper/... \
+	./internal/metrics/...
+	# run the golang native unit tests.
+	@TEST_COV="true" "$(HACK_DIR)/test-go.sh" ./api/... ./internal/controller/etcd/... ./internal/controller/compaction/... ./internal/component/... ./internal/utils/... ./internal/webhook/...
+
+.PHONY: test-integration
+test-integration: $(GINKGO) $(SETUP_ENVTEST) $(GOTESTFMT)
+	@SETUP_ENVTEST="true" "$(HACK_DIR)/test.sh" ./test/integration/...
+	@SETUP_ENVTEST="true" "$(HACK_DIR)/test-go.sh" ./test/it/...
 
 .PHONY: test-cov
 test-cov: $(GINKGO) $(SETUP_ENVTEST)
@@ -118,22 +101,32 @@ test-cov: $(GINKGO) $(SETUP_ENVTEST)
 test-cov-clean:
 	@bash $(GARDENER_HACK_DIR)/test-cover-clean.sh
 
-.PHONY: test-e2e
-test-e2e: $(KUBECTL) $(HELM) $(SKAFFOLD) $(KUSTOMIZE)
-	@bash $(HACK_DIR)/e2e-test/run-e2e-test.sh $(PROVIDERS)
+#################################################################
+# Rules related to binary build, Docker image build and release #
+#################################################################
 
-.PHONY: test-integration
-test-integration: $(GINKGO) $(SETUP_ENVTEST)
-	@bash $(HACK_DIR)/test.sh ./test/integration/...
+# Build manager binary
+.PHONY: druid
+druid: fmt check
+	@env GO111MODULE=on go build -o bin/druid main.go
 
-.PHONY: update-dependencies
-update-dependencies:
-	@env GO111MODULE=on go get -u
-	@make tidy
+# Build the docker image
+.PHONY: docker-build
+docker-build:
+	docker build . -t ${IMG} --rm
+	@echo "updating kustomize image patch file for manager resource"
+	sed -i'' -e 's@image: .*@image: '"${IMG}"'@' ./config/default/manager_image_patch.yaml
 
-.PHONY: add-license-headers
-add-license-headers: $(GO_ADD_LICENSE)
-	@bash $(HACK_DIR)/addlicenseheaders.sh ${YEAR}
+# Push the docker image
+.PHONY: docker-push
+docker-push:
+	docker push ${IMG}
+
+#####################################################################
+# Rules for local environment                                       #
+#####################################################################
+
+kind-up kind-down ci-e2e-kind deploy-localstack test-e2e deploy deploy-dev deploy-debug undeploy: export KUBECONFIG = $(KUBECONFIG_PATH)
 
 .PHONY: kind-up
 kind-up: $(KIND)
@@ -144,10 +137,48 @@ kind-up: $(KIND)
 kind-down: $(KIND)
 	$(KIND) delete cluster --name etcd-druid-e2e
 
+# Install CRDs into a cluster
+.PHONY: install
+install: manifests
+	kubectl apply -f config/crd/bases
+
+# Run against the configured Kubernetes cluster in ~/.kube/config or specified by environment variable KUBECONFIG
+.PHONY: run
+run:
+	go run ./main.go
+
+# Deploy controller in the configured Kubernetes cluster in ~/.kube/config
+.PHONY: deploy-via-kustomize
+deploy-via-kustomize: manifests $(KUSTOMIZE)
+	kubectl apply -f config/crd/bases
+	kustomize build config/default | kubectl apply -f -
+
+# Deploy controller to the Kubernetes cluster specified in the environment variable KUBECONFIG
+# Modify the Helm template located at charts/druid/templates if any changes are required
+.PHONY: deploy
+deploy: $(SKAFFOLD) $(HELM)
+	$(SKAFFOLD) run -m etcd-druid
+
+.PHONY: deploy-dev
+deploy-dev: $(SKAFFOLD) $(HELM)
+	$(SKAFFOLD) dev --cleanup=false -m etcd-druid --trigger='manual'
+
+.PHONY: deploy-debug
+deploy-debug: $(SKAFFOLD) $(HELM)
+	$(SKAFFOLD) debug --cleanup=false -m etcd-druid
+
+.PHONY: undeploy
+undeploy: $(SKAFFOLD) $(HELM)
+	$(SKAFFOLD) delete -m etcd-druid
+
 .PHONY: deploy-localstack
 deploy-localstack: $(KUBECTL)
 	@bash $(HACK_DIR)/deploy-localstack.sh
 
+.PHONY: test-e2e
+test-e2e: $(KUBECTL) $(HELM) $(SKAFFOLD) $(KUSTOMIZE)
+	@bash $(HACK_DIR)/e2e-test/run-e2e-test.sh $(PROVIDERS)
+
 .PHONY: ci-e2e-kind
 ci-e2e-kind:
 	@BUCKET_NAME=$(BUCKET_NAME) bash $(HACK_DIR)/ci-e2e-kind.sh

api/v1alpha1/types_common.go → api/v1alpha1/conditions.go

@@ -5,30 +5,10 @@
 package v1alpha1
 
 import (
-	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// StorageProvider defines the type of object store provider for storing backups.
-type StorageProvider string
-
-// StoreSpec defines parameters related to ObjectStore persisting backups
-type StoreSpec struct {
-	// Container is the name of the container the backup is stored at.
-	// +optional
-	Container *string `json:"container,omitempty"`
-	// Prefix is the prefix used for the store.
-	// +required
-	Prefix string `json:"prefix"`
-	// Provider is the name of the backup provider.
-	// +optional
-	Provider *StorageProvider `json:"provider,omitempty"`
-	// SecretRef is the reference to the secret which used to connect to the backup store.
-	// +optional
-	SecretRef *corev1.SecretReference `json:"secretRef,omitempty"`
-}
-
-// ConditionType is the type of a condition.
+// ConditionType is the type of condition.
 type ConditionType string
 
 // ConditionStatus is the status of a condition.
@@ -60,6 +40,6 @@ type Condition struct {
 	LastUpdateTime metav1.Time `json:"lastUpdateTime"`
 	// The reason for the condition's last transition.
 	Reason string `json:"reason"`
-	// A human readable message indicating details about the transition.
+	// A human-readable message indicating details about the transition.
 	Message string `json:"message"`
 }