feat(space-tpl): some fixes before the merge

Author: smileisak

.golangci.yml

@@ -22,6 +22,7 @@ linters-settings:
 linters:
   enable-all: true
   disable:
+    - depguard
     - nestif
     - nonamedreturns
     - exhaustruct

Makefile

@@ -114,7 +114,7 @@ apidoc: apidocs-gen ## Generate CRD Documentation
 
 GOLANGCI_LINT = $(shell pwd)/bin/golangci-lint
 golangci-lint: ## Download golangci-lint locally if necessary.
-	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/cmd/golangci-lint@v1.52.2)
+	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/cmd/golangci-lint@v1.54.2)
 
 # Linting code as PR is expecting
 .PHONY: golint
@@ -193,13 +193,14 @@ undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/confi
 # Helm
 SRC_ROOT = $(shell git rev-parse --show-toplevel)
 
+HELM_DOCS = $(shell pwd)/bin/helm-docs
+.PHONY: helm-docs-ensure
+helm-docs-ensure: ## Download helm-docs locally if necessary.
+	$(call go-install-tool,$(HELM_DOCS),github.com/norwoodj/helm-docs/cmd/[email protected])
 
 .PHONY: helm-docs
-helm-docs: HELMDOCS_VERSION := v1.11.0
-helm-docs: docker ## Run helm-docs within docker.
-	@docker run --rm -v "$(SRC_ROOT):/helm-docs" jnorwood/helm-docs:$(HELMDOCS_VERSION) --chart-search-root /helm-docs
-
-
+helm-docs: helm-docs-ensure ## Run helm-docs.
+	$(HELM_DOCS) --chart-search-root $(shell pwd)/charts
 
 .PHONY: helm-lint
 helm-lint: docker ## Run ct test linter in docker.
@@ -255,3 +256,7 @@ $(CONTROLLER_GEN): $(LOCALBIN)
 envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
 $(ENVTEST): $(LOCALBIN)
 	test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
+
+
+.PHONY: merge-request
+merge-request: manifests installer golint apidoc helm-docs ## Run Local checks before a opening merge request

config/samples/space_with_tpl_ref_overrides.yaml

@@ -12,7 +12,7 @@ spec:
   templateRef:
     group: nauticus.io/v1alpha1
     kind: SpaceTemplate     # Specify the Kind of the referenced resource
-    name: spacetemplate-sample # Name of the SpaceTemplate
+    name: space-tpl-sample # Name of the SpaceTemplate
   owners:
     - name: smile
       kind: User

controllers/space/controller.go

@@ -15,7 +15,7 @@ import (
 	ctrl "sigs.k8s.io/controller-runtime"
 )
 
-// SpaceReconciler reconciles a Space object.
+// Reconciler reconciles a Space object.
 type Reconciler struct {
 	shared.Reconciler
 }

controllers/space/reconciler.go

@@ -127,33 +127,33 @@ func (r *Reconciler) reconcileSpace(ctx context.Context, space *nauticusiov1alph
 
 func (r *Reconciler) reconcileSpaceFromTemplate(ctx context.Context, space *nauticusiov1alpha1.Space) (result reconcile.Result, err error) {
 	// Fetch data from the SpaceTemplate
-	spacetpl, err := r.FetchSpaceTemplate(ctx, space.Spec.TemplateRef.Name)
+	spaceTpl, err := r.FetchSpaceTemplate(ctx, space.Spec.TemplateRef.Name)
 	if err != nil {
 		r.Log.Info("SpaceTemplate:", "SpaceTemplate does not exist", space.Spec.TemplateRef.Name)
 
 		return ctrl.Result{}, err
 	}
 
 	// Merge and override space.ResourceQuota and spacetemplate.ResourceQuota
-	rs, err := MergeResourceQuotas(space, spacetpl)
+	rs, err := MergeResourceQuotas(space, spaceTpl)
 	if err == nil {
 		space.Spec.ResourceQuota = *rs
 	}
 	// Merge and override space.AdditionalRoleBindings and spacetemplate.AdditionalRoleBindings
-	rb, err := MergeRoleBindings(space, spacetpl)
+	rb, err := MergeRoleBindings(space, spaceTpl)
 	if err == nil {
 		space.Spec.AdditionalRoleBindings = rb
 	}
 
 	if reflect.ValueOf(space.Spec.NetworkPolicies).IsZero() {
-		space.Spec.NetworkPolicies = spacetpl.Spec.NetworkPolicies
+		space.Spec.NetworkPolicies = spaceTpl.Spec.NetworkPolicies
 	}
 
 	if reflect.ValueOf(space.Spec.LimitRanges).IsZero() {
-		space.Spec.LimitRanges = spacetpl.Spec.LimitRanges
+		space.Spec.LimitRanges = spaceTpl.Spec.LimitRanges
 	}
 	// Create or update the Space in the cluster
-	r.Log.Info("Reconciling Space from", "SpaceTemplate", spacetpl.Name)
+	r.Log.Info("Reconciling Space from", "SpaceTemplate", spaceTpl.Name)
 
 	return r.reconcileSpace(ctx, space)
 }

controllers/space/utlis_test.go

@@ -4,12 +4,13 @@ package space
 
 import (
 	"errors"
+	"reflect"
+	"testing"
+
 	nauticusiov1alpha1 "github.com/edixos/nauticus/api/v1alpha1"
 	corev1 "k8s.io/api/core/v1"
 	v1 "k8s.io/api/rbac/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
-	"reflect"
-	"testing"
 )
 
 func TestMergeResourceQuotas(t *testing.T) {
@@ -148,11 +149,12 @@ func TestMergeRoleBindings(t *testing.T) {
 			space: &nauticusiov1alpha1.Space{
 				Spec: nauticusiov1alpha1.SpaceSpec{
 					AdditionalRoleBindings: []nauticusiov1alpha1.AdditionalRoleBinding{
-						{RoleRef: v1.RoleRef{
-							APIGroup: "rbac.authorization.k8s.io",
-							Kind:     "ClusterRole",
-							Name:     "editor",
-						},
+						{
+							RoleRef: v1.RoleRef{
+								APIGroup: "rbac.authorization.k8s.io",
+								Kind:     "ClusterRole",
+								Name:     "editor",
+							},
 							Subjects: []v1.Subject{
 								{
 									Name: "bob",
@@ -170,11 +172,12 @@ func TestMergeRoleBindings(t *testing.T) {
 			spaceTemplate: &nauticusiov1alpha1.SpaceTemplate{
 				Spec: nauticusiov1alpha1.SpaceTemplateSpec{
 					AdditionalRoleBindings: []nauticusiov1alpha1.AdditionalRoleBinding{
-						{RoleRef: v1.RoleRef{
-							APIGroup: "rbac.authorization.k8s.io",
-							Kind:     "ClusterRole",
-							Name:     "viewer",
-						},
+						{
+							RoleRef: v1.RoleRef{
+								APIGroup: "rbac.authorization.k8s.io",
+								Kind:     "ClusterRole",
+								Name:     "viewer",
+							},
 							Subjects: []v1.Subject{
 								{
 									Name: "alice",
@@ -233,11 +236,12 @@ func TestMergeRoleBindings(t *testing.T) {
 			spaceTemplate: &nauticusiov1alpha1.SpaceTemplate{
 				Spec: nauticusiov1alpha1.SpaceTemplateSpec{
 					AdditionalRoleBindings: []nauticusiov1alpha1.AdditionalRoleBinding{
-						{RoleRef: v1.RoleRef{
-							APIGroup: "rbac.authorization.k8s.io",
-							Kind:     "ClusterRole",
-							Name:     "viewer",
-						},
+						{
+							RoleRef: v1.RoleRef{
+								APIGroup: "rbac.authorization.k8s.io",
+								Kind:     "ClusterRole",
+								Name:     "viewer",
+							},
 							Subjects: []v1.Subject{
 								{
 									Name: "alice",

docs/tutorials/space-templates-tutorial.md

@@ -31,7 +31,7 @@ In this example, a Space named `space-tpl-ref-override` references a SpaceTempla
 * The `templateRef` references the `space-tpl-sample` SpaceTemplate.
 * This demonstrates the flexibility of SpaceTemplates, allowing Spaces to maintain standard configurations while adjusting specific settings as needed.
 
-    ```yaml title="config/samples/space_wth_tpl_ref_overrides.yaml"
+    ```yaml title="config/samples/space_with_tpl_ref_overrides.yaml"
     {% include "../../config/samples/space_with_tpl_ref_overrides.yaml" %}
     ```
 #### Example: Merging Additional Role Bindings
@@ -41,6 +41,6 @@ In this example, a Space named `space-tpl-ref-merge` references a Space Template
 * The templateRef references the `space-tpl-sample` SpaceTemplate.
 * The Space includes additional role bindings for both `viewer` and `editor` roles, with specific subjects.
 * The merged role bindings enrich the Space's access control settings, ensuring flexibility and control.
-    ```yaml title="config/samples/space_wth_tpl_merge.yaml"
+    ```yaml title="config/samples/space_with_tpl_merge.yaml"
     {% include "../../config/samples/space_with_tpl_merge.yaml" %}
     ```