Merge branch 'main' of https://github.com/kubernetes-sigs/cluster-api-provider-cloudstack into add-unit-tests

Author: Pearl1594

.gitignore

@@ -29,6 +29,9 @@ cluster-api
 # Ignore output of Makefile sed operations created when generating manifests.
 config/default/manager_image_patch_edited.yaml
 
+# Ignore output of e2e kustomization of templates.
+test/e2e/data/infrastructure-cloudstack/v1beta*/*yaml
+
 # Test binary, build with `go test -c`
 *.test
 

Makefile

@@ -63,11 +63,16 @@ config/.flag.mk: bin/controller-gen $(MANIFEST_GEN_INPUTS)
 .PHONY: release-manifests
 RELEASE_MANIFEST_TARGETS=$(RELEASE_DIR)/infrastructure-components.yaml $(RELEASE_DIR)/metadata.yaml
 RELEASE_MANIFEST_INPUTS=bin/kustomize config/.flag.mk $(shell find config)
+RELEASE_MANIFEST_SOURCE_BASE ?= config/default
 release-manifests: $(RELEASE_MANIFEST_TARGETS) ## Create kustomized release manifest in $RELEASE_DIR (defaults to out).
 $(RELEASE_DIR)/%: $(RELEASE_MANIFEST_INPUTS)
 	@mkdir -p $(RELEASE_DIR)
 	cp metadata.yaml $(RELEASE_DIR)/metadata.yaml
-	kustomize build config/default > $(RELEASE_DIR)/infrastructure-components.yaml
+	kustomize build $(RELEASE_MANIFEST_SOURCE_BASE) > $(RELEASE_DIR)/infrastructure-components.yaml
+
+.PHONY: release-manifests-metrics-port
+release-manifests-metrics-port:
+	make release-manifests RELEASE_MANIFEST_SOURCE_BASE=config/default-with-metrics-port
 
 DEEPCOPY_GEN_TARGETS=$(shell find api -type d -name "v*" -exec echo {}\/zz_generated.deepcopy.go \;)
 DEEPCOPY_GEN_INPUTS=$(shell find ./api -name "*test*" -prune -o -name "*zz_generated*" -prune -o -type f -print)
@@ -76,6 +81,14 @@ generate-deepcopy: $(DEEPCOPY_GEN_TARGETS) ## Generate code containing DeepCopy,
 api/%/zz_generated.deepcopy.go: bin/controller-gen $(DEEPCOPY_GEN_INPUTS)
 	controller-gen object:headerFile="hack/boilerplate.go.txt" paths="./..."
 
+CONVERSION_GEN_TARGET=$(shell find api -type d -name "v*1" -exec echo {}\/zz_generated.conversion.go \;)
+CONVERSION_GEN_INPUTS=$(shell find ./api -name "*test*" -prune -o -name "*zz_generated*" -prune -o -type f -print)
+.PHONY: generate-conversion
+generate-conversion: $(CONVERSION_GEN_TARGET) ## Generate code to convert api/v1beta1 to api/v1beta2
+api/%/zz_generated.conversion.go: bin/conversion-gen $(CONVERSION_GEN_INPUTS)
+	conversion-gen --go-header-file "./hack/boilerplate.go.txt" --input-dirs "./api/v1beta1" \
+	--output-base "." --output-file-base="zz_generated.conversion" --skip-unsafe=true
+
 ##@ Build
 
 MANAGER_BIN_INPUTS=$(shell find ./controllers ./api ./pkg -name "*mock*" -prune -o -name "*test*" -prune -o -type f -print) main.go go.mod go.sum
@@ -92,13 +105,13 @@ bin/manager-linux-amd64: $(MANAGER_BIN_INPUTS)
     	-o bin/manager-linux-amd64 main.go
 
 .PHONY: run
-run: generate-deepcopy ## Run a controller from your host.
+run: generate-deepcopy generate-conversion ## Run a controller from your host.
 	go run ./main.go
 
 # Using a flag file here as docker build doesn't produce a target file.
 DOCKER_BUILD_INPUTS=$(MANAGER_BIN_INPUTS) Dockerfile
 .PHONY: docker-build
-docker-build: generate-deepcopy build-for-docker .dockerflag.mk ## Build docker image containing the controller manager.
+docker-build: generate-deepcopy generate-conversion build-for-docker .dockerflag.mk ## Build docker image containing the controller manager.
 .dockerflag.mk: $(DOCKER_BUILD_INPUTS)
 	docker build -t ${IMG} .
 	@touch .dockerflag.mk
@@ -132,7 +145,7 @@ lint: bin/golangci-lint bin/staticcheck generate-mocks ## Run linting for the pr
 ##@ Deployment
 
 .PHONY: deploy
-deploy: generate-deepcopy manifests bin/kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.
+deploy: generate-deepcopy generate-conversion manifests bin/kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.
 	cd config/manager && kustomize edit set image controller=${IMG}
 	kustomize build config/default | kubectl apply -f -
 
@@ -142,9 +155,11 @@ undeploy: bin/kustomize ## Undeploy controller from the K8s cluster specified in
 ##@ Binaries
 
 .PHONY: binaries
-binaries: bin/controller-gen bin/kustomize bin/ginkgo bin/golangci-lint bin/staticcheck bin/mockgen bin/kubectl ## Locally install all needed bins.
+binaries: bin/controller-gen bin/conversion-gen bin/kustomize bin/ginkgo bin/golangci-lint bin/staticcheck bin/mockgen bin/kubectl ## Locally install all needed bins.
 bin/controller-gen: ## Install controller-gen to bin.
 	GOBIN=$(PROJECT_DIR)/bin go install sigs.k8s.io/controller-tools/cmd/[email protected]
+bin/conversion-gen: ## Install conversion-gen to bin.
+	GOBIN=$(PROJECT_DIR)/bin go install k8s.io/code-generator/cmd/[email protected]
 bin/golangci-lint: ## Install golangci-lint to bin.
 	GOBIN=$(PROJECT_DIR)/bin go install github.com/golangci/golangci-lint/cmd/[email protected]
 bin/staticcheck: ## Install staticcheck to bin.
@@ -173,6 +188,7 @@ clean: ## Clean.
 	rm -rf $(RELEASE_DIR)
 	rm -rf bin
 	rm -rf cluster-api
+	rm -rf test/e2e/data/infrastructure-cloudstack/*/*yaml
 
 ##@ Testing
 
@@ -181,6 +197,7 @@ export KUBEBUILDER_ASSETS=$(PROJECT_DIR)/bin
 
 .PHONY: test
 test: generate-mocks lint bin/ginkgo bin/kubectl bin/kube-apiserver bin/etcd ## Run tests. At the moment this is only unit tests.
+	@./hack/testing_ginkgo_recover_statements.sh --add # Add ginkgo.GinkgoRecover() statements to controllers.
 	@# The following is a slightly funky way to make sure the ginkgo statements are removed regardless the test results.
 	@ginkgo_v2 --label-filter="!integ" --cover -coverprofile cover.out --covermode=atomic -v ./api/... ./controllers/... ./pkg/...; EXIT_STATUS=$$?;\
 		./hack/testing_ginkgo_recover_statements.sh --remove; exit $$EXIT_STATUS
@@ -193,8 +210,8 @@ pkg/mocks/mock%.go: $(shell find ./pkg/cloud -type f -name "*test*" -prune -o -p
 ##@ Tilt
 
 .PHONY: tilt-up
-tilt-up: cluster-api kind-cluster cluster-api/tilt-settings.json manifests cloud-config ## Setup and run tilt for development.
-	export CLOUDSTACK_B64ENCODED_SECRET=$$(base64 -w0 -i cloud-config 2>/dev/null || base64 -b 0 -i cloud-config) && cd cluster-api && tilt up
+tilt-up: cluster-api kind-cluster cluster-api/tilt-settings.json manifests ## Setup and run tilt for development.
+	cd cluster-api && tilt up
 
 .PHONY: kind-cluster
 kind-cluster: cluster-api ## Create a kind cluster with a local Docker repository.
@@ -207,8 +224,7 @@ cluster-api/tilt-settings.json: hack/tilt-settings.json cluster-api
 	cp ./hack/tilt-settings.json cluster-api
 
 ##@ End-to-End Testing
-
-CLUSTER_TEMPLATES_INPUT_FILES=$(shell find test/e2e/data/infrastructure-cloudstack/*/cluster-template*/* test/e2e/data/infrastructure-cloudstack/*/bases/* -type f)
+CLUSTER_TEMPLATES_INPUT_FILES=$(shell find test/e2e/data/infrastructure-cloudstack/v1beta*/*/cluster-template* test/e2e/data/infrastructure-cloudstack/*/bases/* -type f)
 CLUSTER_TEMPLATES_OUTPUT_FILES=$(shell find test/e2e/data/infrastructure-cloudstack -type d -name "cluster-template*" -exec echo {}.yaml \;)
 .PHONY: e2e-cluster-templates
 e2e-cluster-templates: $(CLUSTER_TEMPLATES_OUTPUT_FILES) ## Generate cluster template files for e2e testing.
@@ -220,6 +236,7 @@ e2e-essentials: bin/ginkgo_v1 e2e-cluster-templates kind-cluster ## Fulfill esse
 
 JOB ?= .*
 run-e2e: e2e-essentials ## Run e2e testing. JOB is an optional REGEXP to select certainn test cases to run. e.g. JOB=PR-Blocking, JOB=Conformance
+	kubectl apply -f cloud-config.yaml && \
 	cd test/e2e && \
 	ginkgo_v1 -v -trace -tags=e2e -focus=$(JOB) -skip=Conformance -nodes=1 -noColor=false ./... -- \
 	    -e2e.artifacts-folder=${PROJECT_DIR}/_artifacts \

PROJECT

@@ -77,4 +77,12 @@ resources:
   kind: CloudStackMachineStateChecker
   path: sigs.k8s.io/cluster-api-provider-cloudstack/api/v1beta1
   version: v1beta1
+- api:
+    crdVersion: v1
+    namespaced: true
+  domain: cluster.x-k8s.io
+  group: infrastructure
+  kind: CloudStackFailureDomain
+  path: sigs.k8s.io/cluster-api-provider-cloudstack/api/v1beta2
+  version: v1beta2
 version: "3"

api/v1beta1/cloudstackaffinitygroup_conversion.go

@@ -0,0 +1,32 @@
+/*
+Copyright 2022 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 v1beta1
+
+import (
+	"sigs.k8s.io/cluster-api-provider-cloudstack/api/v1beta2"
+	"sigs.k8s.io/controller-runtime/pkg/conversion"
+)
+
+func (src *CloudStackAffinityGroup) ConvertTo(dstRaw conversion.Hub) error { // nolint
+	dst := dstRaw.(*v1beta2.CloudStackAffinityGroup)
+	return Convert_v1beta1_CloudStackAffinityGroup_To_v1beta2_CloudStackAffinityGroup(src, dst, nil)
+}
+
+func (dst *CloudStackAffinityGroup) ConvertFrom(srcRaw conversion.Hub) error { // nolint
+	src := srcRaw.(*v1beta2.CloudStackAffinityGroup)
+	return Convert_v1beta2_CloudStackAffinityGroup_To_v1beta1_CloudStackAffinityGroup(src, dst, nil)
+}

api/v1beta1/cloudstackcluster_conversion.go

@@ -0,0 +1,34 @@
+/*
+Copyright 2022 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 v1beta1
+
+import (
+	"sigs.k8s.io/cluster-api-provider-cloudstack/api/v1beta2"
+	"sigs.k8s.io/controller-runtime/pkg/conversion"
+)
+
+func (src *CloudStackCluster) ConvertTo(dstRaw conversion.Hub) error { // nolint
+	dst := dstRaw.(*v1beta2.CloudStackCluster)
+
+	return Convert_v1beta1_CloudStackCluster_To_v1beta2_CloudStackCluster(src, dst, nil)
+}
+
+func (dst *CloudStackCluster) ConvertFrom(srcRaw conversion.Hub) error { // nolint
+	src := srcRaw.(*v1beta2.CloudStackCluster)
+
+	return Convert_v1beta2_CloudStackCluster_To_v1beta1_CloudStackCluster(src, dst, nil)
+}

api/v1beta1/cloudstackcluster_types.go

@@ -25,7 +25,6 @@ import (
 
 const (
 	ClusterFinalizer           = "cloudstackcluster.infrastructure.cluster.x-k8s.io"
-	defaultIdentityRefKind     = "Secret"
 	CloudStackClusterLabelName = "cloudstackcluster.infrastructure.cluster.x-k8s.io/name"
 	NetworkTypeIsolated        = "Isolated"
 	NetworkTypeShared          = "Shared"
@@ -49,7 +48,7 @@ type Network struct {
 	ID string `json:"id,omitempty"`
 
 	// Cloudstack Network Type the cluster is built in.
-	// + optional
+	// +optional
 	Type string `json:"type,omitempty"`
 
 	// Cloudstack Network Name the cluster is built in.
@@ -61,11 +60,11 @@ type ZoneStatusMap map[string]Zone
 
 type Zone struct {
 	// Name.
-	//+optional
+	// +optional
 	Name string `json:"name,omitempty"`
 
 	// ID.
-	//+optional
+	// +optional
 	ID string `json:"id,omitempty"`
 
 	// The network within the Zone to use.
@@ -82,6 +81,7 @@ func (z *Zone) MetaName() string {
 	return strings.ToLower(s)
 }
 
+//+k8s:conversion-gen=false
 // CloudStackClusterSpec defines the desired state of CloudStackCluster.
 type CloudStackClusterSpec struct {
 	Zones []Zone `json:"zones"`
@@ -98,10 +98,10 @@ type CloudStackClusterSpec struct {
 	Domain string `json:"domain,omitempty"`
 
 	// +optional
-	// +k8s:conversion-gen=false
 	IdentityRef *CloudStackIdentityReference `json:"identityRef,omitempty"`
 }
 
+//+k8s:conversion-gen=false
 // The status of the abstract CS k8s (not an actual Cloudstack Cluster) cluster.
 type CloudStackClusterStatus struct {
 
@@ -132,7 +132,7 @@ type CloudStackClusterStatus struct {
 
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
-
+//+k8s:conversion-gen=false
 // CloudStackCluster is the Schema for the cloudstackclusters API
 type CloudStackCluster struct {
 	metav1.TypeMeta   `json:",inline"`
@@ -145,7 +145,7 @@ type CloudStackCluster struct {
 }
 
 //+kubebuilder:object:root=true
-
+//+k8s:conversion-gen=false
 // CloudStackClusterList contains a list of CloudStackCluster
 type CloudStackClusterList struct {
 	metav1.TypeMeta `json:",inline"`

api/v1beta1/cloudstackisolatednetwork_conversion.go

@@ -0,0 +1,32 @@
+/*
+Copyright 2022 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 v1beta1
+
+import (
+	"sigs.k8s.io/cluster-api-provider-cloudstack/api/v1beta2"
+	"sigs.k8s.io/controller-runtime/pkg/conversion"
+)
+
+func (src *CloudStackIsolatedNetwork) ConvertTo(dstRaw conversion.Hub) error { // nolint
+	dst := dstRaw.(*v1beta2.CloudStackIsolatedNetwork)
+	return Convert_v1beta1_CloudStackIsolatedNetwork_To_v1beta2_CloudStackIsolatedNetwork(src, dst, nil)
+}
+
+func (dst *CloudStackIsolatedNetwork) ConvertFrom(srcRaw conversion.Hub) error { // nolint
+	src := srcRaw.(*v1beta2.CloudStackIsolatedNetwork)
+	return Convert_v1beta2_CloudStackIsolatedNetwork_To_v1beta1_CloudStackIsolatedNetwork(src, dst, nil)
+}

api/v1beta1/cloudstackmachine_conversion.go

@@ -0,0 +1,32 @@
+/*
+Copyright 2022 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 v1beta1
+
+import (
+	"sigs.k8s.io/cluster-api-provider-cloudstack/api/v1beta2"
+	"sigs.k8s.io/controller-runtime/pkg/conversion"
+)
+
+func (src *CloudStackMachine) ConvertTo(dstRaw conversion.Hub) error { // nolint
+	dst := dstRaw.(*v1beta2.CloudStackMachine)
+	return Convert_v1beta1_CloudStackMachine_To_v1beta2_CloudStackMachine(src, dst, nil)
+}
+
+func (dst *CloudStackMachine) ConvertFrom(srcRaw conversion.Hub) error { // nolint
+	src := srcRaw.(*v1beta2.CloudStackMachine)
+	return Convert_v1beta2_CloudStackMachine_To_v1beta1_CloudStackMachine(src, dst, nil)
+}

api/v1beta1/cloudstackmachine_types.go

@@ -17,9 +17,10 @@ limitations under the License.
 package v1beta1
 
 import (
+	"time"
+
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"time"
 )
 
 const (
@@ -79,12 +80,14 @@ type CloudStackMachineSpec struct {
 	ProviderID *string `json:"providerID,omitempty"`
 
 	// Optionally settable Zone ID to land the machine in.
+	// +k8s:conversion-gen=false
 	ZoneID string `json:"zoneID,omitempty"`
 
+	// +k8s:conversion-gen=false
 	// Optionally settable Zone Name to land the machine in.
 	ZoneName string `json:"zoneName,omitempty"`
 
-	// IdentityRef is a reference to a identity to be used when reconciling this cluster
+	// IdentityRef is a reference to an identity to be used when reconciling this cluster
 	// +optional
 	// +k8s:conversion-gen=false
 	IdentityRef *CloudStackIdentityReference `json:"identityRef,omitempty"`
@@ -122,6 +125,7 @@ type InstanceState string
 type CloudStackMachineStatus struct {
 	// Zone ID is used so that the zone can be computed once per reconcile and then propagate.
 	// +optional
+	// +k8s:conversion-gen=false
 	ZoneID string `json:"zoneID,omitempty"`
 
 	// Addresses contains a CloudStack VM instance's IP addresses.
@@ -150,7 +154,6 @@ func (s *CloudStackMachineStatus) TimeSinceLastStateChange() time.Duration {
 
 // +kubebuilder:object:root=true
 // +kubebuilder:resource:path=cloudstackmachines,scope=Namespaced,categories=cluster-api,shortName=csm
-// +kubebuilder:storageversion
 // +kubebuilder:subresource:status
 // +kubebuilder:printcolumn:name="Cluster",type="string",JSONPath=".metadata.labels.cluster\\.x-k8s\\.io/cluster-name",description="Cluster to which this CloudStackMachine belongs"
 // +kubebuilder:printcolumn:name="InstanceState",type="string",JSONPath=".status.instanceState",description="CloudStack instance state"