CLOUDP-148830: Added CRD versions logic (#812)

igor-karpukhin · web-flow · commit 7c0d2e8205a7 · 2022-12-28T09:41:43.000+01:00
Added CRD versions logic
diff --git a/Dockerfile b/Dockerfile
@@ -19,7 +19,7 @@ COPY config/ config/
 COPY hack/ hack/
 
 ARG VERSION
-ENV PRODUCT_VERSION=${VERSION}
+ENV VERSION=${VERSION}
 ENV TARGET_ARCH=amd64
 ENV TARGET_OS=linux
 
diff --git a/Makefile b/Makefile
@@ -10,7 +10,6 @@ CONTAINER_ENGINE?=docker
 # - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
 # - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
 VERSION ?= $(shell git describe --tags --dirty --broken | cut -c 2-)
-PRODUCT_VERSION ?= $(shell git describe --tags --dirty --broken | cut -c 2-)
 
 # CHANNELS define the bundle channels used in the bundle.
 # Add a new line here if you would like to change its default config. (E.g CHANNELS = "preview,fast,stable")
@@ -107,7 +106,8 @@ e2e-openshift-upgrade:
 
 .PHONY: manager
 manager: generate fmt vet ## Build manager binary
-	 GOOS=$(TARGET_OS) GOARCH=$(TARGET_ARCH) go build -o bin/manager -ldflags="-X main.version=$(PRODUCT_VERSION)" cmd/manager/main.go
+	@echo "Building operator with version $(VERSION)"
+	 GOOS=$(TARGET_OS) GOARCH=$(TARGET_ARCH) go build -o bin/manager -ldflags="-X github.com/mongodb/mongodb-atlas-kubernetes/pkg/version.Version=$(VERSION)" cmd/manager/main.go
 
 .PHONY: run
 run: generate fmt vet manifests ## Run against the configured Kubernetes cluster in ~/.kube/config
@@ -184,8 +184,8 @@ bundle: manifests kustomize ## Generate bundle manifests and metadata, then vali
 	operator-sdk bundle validate ./bundle
 
 .PHONY: image
-image: manager ## Build the operator image
-	$(CONTAINER_ENGINE) build -t $(OPERATOR_IMAGE) .
+image: ## Build the operator image
+	$(CONTAINER_ENGINE) build --build-arg VERSION=$(VERSION) -t $(OPERATOR_IMAGE) .
 	$(CONTAINER_ENGINE) push $(OPERATOR_IMAGE)
 
 .PHONY: bundle-build
diff --git a/cmd/manager/main.go b/cmd/manager/main.go
@@ -25,6 +25,8 @@ import (
 	"strings"
 	"time"
 
+	"github.com/mongodb/mongodb-atlas-kubernetes/pkg/version"
+
 	"go.uber.org/zap/zapcore"
 	ctrzap "sigs.k8s.io/controller-runtime/pkg/log/zap"
 
@@ -43,7 +45,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/predicate"
 
 	mdbv1 "github.com/mongodb/mongodb-atlas-kubernetes/pkg/api/v1"
-	"github.com/mongodb/mongodb-atlas-kubernetes/pkg/controller/atlas"
 	"github.com/mongodb/mongodb-atlas-kubernetes/pkg/controller/atlasdatabaseuser"
 	"github.com/mongodb/mongodb-atlas-kubernetes/pkg/controller/atlasdeployment"
 	"github.com/mongodb/mongodb-atlas-kubernetes/pkg/controller/atlasproject"
@@ -56,18 +57,13 @@ import (
 var (
 	scheme   = runtime.NewScheme()
 	setupLog = ctrl.Log.WithName("setup")
-
-	// Set by the linker during link time.
-	version = "unknown"
 )
 
 func init() {
 	utilruntime.Must(clientgoscheme.AddToScheme(scheme))
 
 	utilruntime.Must(mdbv1.AddToScheme(scheme))
 	// +kubebuilder:scaffold:scheme
-
-	atlas.ProductVersion = version
 }
 
 func main() {
@@ -83,12 +79,10 @@ func main() {
 		os.Exit(1)
 	}
 
-	logger.Info("starting with configuration", zap.Any("config", config), zap.Any("version", atlas.ProductVersion))
+	logger.Info("starting with configuration", zap.Any("config", config), zap.Any("version", version.Version))
 
 	ctrl.SetLogger(zapr.NewLogger(logger))
 
-	logger.Info("MongoDB Atlas Operator version ", zap.String("version", version))
-
 	syncPeriod := time.Hour * 3
 
 	var cacheFunc cache.NewCacheFunc
@@ -223,7 +217,7 @@ func parseConfiguration() Config {
 	flag.Parse()
 
 	if *appVersion {
-		fmt.Println(version)
+		fmt.Println(version.Version)
 		os.Exit(0)
 	}
 
diff --git a/go.mod b/go.mod
@@ -7,6 +7,7 @@ require (
 	github.com/Azure/go-autorest/autorest v0.11.28
 	github.com/Azure/go-autorest/autorest/azure/auth v0.5.11
 	github.com/Azure/go-autorest/autorest/to v0.4.0
+	github.com/Masterminds/semver v1.5.0
 	github.com/aws/aws-sdk-go v1.44.151
 	github.com/fatih/structtag v1.2.0
 	github.com/go-logr/zapr v1.2.3
diff --git a/go.sum b/go.sum
@@ -66,6 +66,8 @@ github.com/Azure/go-autorest/tracing v0.6.0 h1:TYi4+3m5t6K48TGI9AUdb+IzbnSxvnvUM
 github.com/Azure/go-autorest/tracing v0.6.0/go.mod h1:+vhtPC754Xsa23ID7GlGsrdKBpUA79WCAKPPZVC2DeU=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo=
+github.com/Masterminds/semver v1.5.0 h1:H65muMkzWKEuNDnfl9d70GUjFniHKHRbFPGBuZ3QEww=
+github.com/Masterminds/semver v1.5.0/go.mod h1:MB6lktGJrhw8PrUyiEoblNEGEQ+RzHPF078ddwwvV3Y=
 github.com/PuerkitoBio/purell v1.1.1 h1:WEQqlqaGbrPkxLJWfBwQmfEAE1Z7ONdDLqrN38tNFfI=
 github.com/PuerkitoBio/purell v1.1.1/go.mod h1:c11w/QuzBsJSee3cPx9rAFu61PvFxuPbtSwDGJws/X0=
 github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 h1:d+Bc7a5rLufV/sSk/8dngufqelfh6jnri85riMAaF/M=
diff --git a/pkg/api/v1/atlasbackuppolicy_types.go b/pkg/api/v1/atlasbackuppolicy_types.go
@@ -10,6 +10,8 @@ package v1
 
 import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	"github.com/mongodb/mongodb-atlas-kubernetes/pkg/api/v1/status"
 )
 
 // AtlasBackupPolicySpec defines the desired state of AtlasBackupPolicy
@@ -47,6 +49,13 @@ type AtlasBackupPolicy struct {
 	Status AtlasBackupPolicyStatus `json:"status,omitempty"`
 }
 
+func (in *AtlasBackupPolicy) GetStatus() status.Status {
+	return nil
+}
+
+func (in *AtlasBackupPolicy) UpdateStatus(_ []status.Condition, _ ...status.Option) {
+}
+
 type AtlasBackupPolicyStatus struct {
 }
 
diff --git a/pkg/api/v1/atlasbackupschedule_types.go b/pkg/api/v1/atlasbackupschedule_types.go
@@ -11,6 +11,8 @@ package v1
 import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
+	"github.com/mongodb/mongodb-atlas-kubernetes/pkg/api/v1/status"
+
 	"github.com/mongodb/mongodb-atlas-kubernetes/pkg/api/v1/common"
 )
 
@@ -74,6 +76,13 @@ type AtlasBackupSchedule struct {
 	Status AtlasBackupScheduleStatus `json:"status,omitempty"`
 }
 
+func (in *AtlasBackupSchedule) GetStatus() status.Status {
+	return nil
+}
+
+func (in *AtlasBackupSchedule) UpdateStatus(_ []status.Condition, _ ...status.Option) {
+}
+
 type AtlasBackupScheduleStatus struct {
 }
 
diff --git a/pkg/api/v1/atlasproject_types.go b/pkg/api/v1/atlasproject_types.go
@@ -181,6 +181,16 @@ func NewProject(namespace, name, nameInAtlas string) *AtlasProject {
 	}
 }
 
+func (p *AtlasProject) WithLabels(labels map[string]string) *AtlasProject {
+	p.Labels = labels
+	return p
+}
+
+func (p *AtlasProject) WithAnnotations(labels map[string]string) *AtlasProject {
+	p.Labels = labels
+	return p
+}
+
 func (p *AtlasProject) WithName(name string) *AtlasProject {
 	p.Name = name
 	return p
diff --git a/pkg/api/v1/status/condition.go b/pkg/api/v1/status/condition.go
@@ -61,6 +61,11 @@ const (
 	DatabaseUserReadyType ConditionType = "DatabaseUserReady"
 )
 
+// Generic condition type
+const (
+	ResourceVersionStatus ConditionType = "ResourceVersionIsValid"
+)
+
 // Condition describes the state of an Atlas Custom Resource at a certain point.
 type Condition struct {
 	// Type of Atlas Custom Resource condition.
diff --git a/pkg/controller/atlas/client.go b/pkg/controller/atlas/client.go
@@ -5,15 +5,14 @@ import (
 	"net/http"
 	"runtime"
 
+	"github.com/mongodb/mongodb-atlas-kubernetes/pkg/version"
+
 	"go.mongodb.org/atlas/mongodbatlas"
 	"go.uber.org/zap"
 
 	"github.com/mongodb/mongodb-atlas-kubernetes/pkg/util/httputil"
 )
 
-// ProductVersion is used for sending the current Operator version in the User-Agent string
-var ProductVersion = "unknown"
-
 // Client is the central place to create a client for Atlas using specified API keys and a server URL.
 // Note, that the default HTTP transport is reused globally by Go so all caching, keep-alive etc will be in action.
 func Client(atlasDomain string, connection Connection, log *zap.SugaredLogger) (mongodbatlas.Client, error) {
@@ -28,7 +27,7 @@ func Client(atlasDomain string, connection Connection, log *zap.SugaredLogger) (
 	if err != nil {
 		return mongodbatlas.Client{}, err
 	}
-	client.UserAgent = fmt.Sprintf("%s/%s (%s;%s)", "MongoDBAtlasKubernetesOperator", ProductVersion, runtime.GOOS, runtime.GOARCH)
+	client.UserAgent = fmt.Sprintf("%s/%s (%s;%s)", "MongoDBAtlasKubernetesOperator", version.Version, runtime.GOOS, runtime.GOARCH)
 
 	return *client, nil
 }
diff --git a/pkg/controller/atlas/client_test.go b/pkg/controller/atlas/client_test.go
@@ -3,16 +3,17 @@ package atlas_test
 import (
 	"testing"
 
+	"github.com/mongodb/mongodb-atlas-kubernetes/pkg/version"
+
 	"github.com/stretchr/testify/require"
 
 	"github.com/mongodb/mongodb-atlas-kubernetes/pkg/controller/atlas"
 )
 
 func TestClientUserAgent(t *testing.T) {
-	require := require.New(t)
+	r := require.New(t)
 
-	atlas.ProductVersion = "v1.2.3-testing"
 	c, err := atlas.Client("https://cloud.mongodb.com", atlas.Connection{}, nil)
-	require.NoError(err)
-	require.Regexp(`^MongoDBAtlasKubernetesOperator/v1\.2\.3-testing \(\w+;\w+\)$`, c.UserAgent)
+	r.NoError(err)
+	r.Contains(c.UserAgent, version.Version)
 }
diff --git a/pkg/controller/atlasdatabaseuser/atlasdatabaseuser_controller.go b/pkg/controller/atlasdatabaseuser/atlasdatabaseuser_controller.go
@@ -91,6 +91,12 @@ func (r *AtlasDatabaseUserReconciler) Reconcile(context context.Context, req ctr
 	log.Infow("-> Starting AtlasDatabaseUser reconciliation", "spec", databaseUser.Spec, "status", databaseUser.Status)
 	defer statushandler.Update(ctx, r.Client, r.EventRecorder, databaseUser)
 
+	resourceVersionIsValid := customresource.ValidateResourceVersion(ctx, databaseUser, r.Log)
+	if !resourceVersionIsValid.IsOk() {
+		r.Log.Debugf("databaseuser validation result: %v", resourceVersionIsValid)
+		return resourceVersionIsValid.ReconcileResult(), nil
+	}
+
 	if err := validate.DatabaseUser(databaseUser); err != nil {
 		result := workflow.Terminate(workflow.Internal, err.Error())
 		ctx.SetConditionFromResult(status.ValidationSucceeded, result)
diff --git a/pkg/controller/atlasdeployment/atlasdeployment_controller.go b/pkg/controller/atlasdeployment/atlasdeployment_controller.go
@@ -109,6 +109,12 @@ func (r *AtlasDeploymentReconciler) Reconcile(context context.Context, req ctrl.
 	log.Infow("-> Starting AtlasDeployment reconciliation", "spec", deployment.Spec, "status", deployment.Status)
 	defer statushandler.Update(ctx, r.Client, r.EventRecorder, deployment)
 
+	resourceVersionIsValid := customresource.ValidateResourceVersion(ctx, deployment, r.Log)
+	if !resourceVersionIsValid.IsOk() {
+		r.Log.Debugf("deployment validation result: %v", resourceVersionIsValid)
+		return resourceVersionIsValid.ReconcileResult(), nil
+	}
+
 	if err := validate.DeploymentSpec(deployment.Spec); err != nil {
 		result := workflow.Terminate(workflow.Internal, err.Error())
 		ctx.SetConditionFromResult(status.ValidationSucceeded, result)
@@ -267,23 +273,39 @@ func (r *AtlasDeploymentReconciler) handleDeploymentBackupSchedule(ctx *workflow
 
 	resourcesToWatch := []watch.WatchedObject{}
 
-	context := context.Background()
+	requestContext := context.Background()
 	// Process backup schedule
 	bSchedule := &mdbv1.AtlasBackupSchedule{}
 	bKey := types.NamespacedName{Namespace: deployment.Spec.BackupScheduleRef.Namespace, Name: deployment.Spec.BackupScheduleRef.Name}
-	err := r.Client.Get(context, bKey, bSchedule)
+	err := r.Client.Get(requestContext, bKey, bSchedule)
 	if err != nil {
 		return fmt.Errorf("%v backupschedule resource is not found. e: %w", deployment.Spec.BackupScheduleRef, err)
 	}
+
+	resourceVersionIsValid := customresource.ValidateResourceVersion(ctx, bSchedule, r.Log)
+	if !resourceVersionIsValid.IsOk() {
+		errText := fmt.Sprintf("backup schedule validation result: %v", resourceVersionIsValid)
+		r.Log.Debug(errText)
+		return errors.New(errText)
+	}
+
 	resourcesToWatch = append(resourcesToWatch, watch.WatchedObject{ResourceKind: bSchedule.Kind, Resource: bKey})
 
 	// Process backup policy for the schedule
 	bPolicy := &mdbv1.AtlasBackupPolicy{}
 	pKey := types.NamespacedName{Namespace: bSchedule.Spec.PolicyRef.Namespace, Name: bSchedule.Spec.PolicyRef.Name}
-	err = r.Client.Get(context, pKey, bPolicy)
+	err = r.Client.Get(requestContext, pKey, bPolicy)
 	if err != nil {
 		return fmt.Errorf("unable to get backuppolicy resource %s/%s. e: %w", bSchedule.Spec.PolicyRef.Namespace, bSchedule.Spec.PolicyRef.Name, err)
 	}
+
+	resourceVersionIsValid = customresource.ValidateResourceVersion(ctx, bPolicy, r.Log)
+	if !resourceVersionIsValid.IsOk() {
+		errText := fmt.Sprintf("backup policy validation result: %v", resourceVersionIsValid)
+		r.Log.Debug(errText)
+		return errors.New(errText)
+	}
+
 	resourcesToWatch = append(resourcesToWatch, watch.WatchedObject{ResourceKind: bPolicy.Kind, Resource: pKey})
 
 	// Create new backup schedule
@@ -315,7 +337,7 @@ func (r *AtlasDeploymentReconciler) handleDeploymentBackupSchedule(ctx *workflow
 	}
 	apiScheduleRes.Policies = []mongodbatlas.Policy{apiPolicy}
 
-	currentSchedule, response, err := ctx.Client.CloudProviderSnapshotBackupPolicies.Delete(context, projectID, cName)
+	currentSchedule, response, err := ctx.Client.CloudProviderSnapshotBackupPolicies.Delete(requestContext, projectID, cName)
 	if err != nil {
 		errMessage := "unable to delete current backup policy for project"
 		r.Log.Debugf("%s: %s:%s, %v", errMessage, projectID, cName, err)
@@ -333,7 +355,7 @@ func (r *AtlasDeploymentReconciler) handleDeploymentBackupSchedule(ctx *workflow
 	apiScheduleRes.Policies[0].ID = currentSchedule.Policies[0].ID
 
 	r.Log.Debugf("applying backupschedule policy: %v", *apiScheduleRes)
-	if _, _, err := ctx.Client.CloudProviderSnapshotBackupPolicies.Update(context, projectID, cName, apiScheduleRes); err != nil {
+	if _, _, err := ctx.Client.CloudProviderSnapshotBackupPolicies.Update(requestContext, projectID, cName, apiScheduleRes); err != nil {
 		return fmt.Errorf("unable to create backupschedule %v. e: %w", bKey, err)
 	}
 	r.Log.Infof("successfully updated backupschedule for deployment %v", cName)
@@ -500,7 +522,6 @@ func (r *AtlasDeploymentReconciler) SetupWithManager(mgr ctrl.Manager) error {
 
 // Delete implements a handler for the Delete event.
 func (r *AtlasDeploymentReconciler) Delete(e event.DeleteEvent) error {
-	// TODO: Add deletion for AtlasBackupSchedule and AtlasBackupPolicy
 	deployment, ok := e.Object.(*mdbv1.AtlasDeployment)
 	if !ok {
 		r.Log.Errorf("Ignoring malformed Delete() call (expected type %T, got %T)", &mdbv1.AtlasDeployment{}, e.Object)
diff --git a/pkg/controller/atlasproject/atlasproject_controller.go b/pkg/controller/atlasproject/atlasproject_controller.go
@@ -111,6 +111,12 @@ func (r *AtlasProjectReconciler) Reconcile(context context.Context, req ctrl.Req
 	// This update will make sure the status is always updated in case of any errors or successful result
 	defer statushandler.Update(ctx, r.Client, r.EventRecorder, project)
 
+	resourceVersionIsValid := customresource.ValidateResourceVersion(ctx, project, r.Log)
+	if !resourceVersionIsValid.IsOk() {
+		r.Log.Debugf("project validation result: %v", resourceVersionIsValid)
+		return resourceVersionIsValid.ReconcileResult(), nil
+	}
+
 	if err := validate.Project(project); err != nil {
 		result := workflow.Terminate(workflow.Internal, err.Error())
 		setCondition(ctx, status.ValidationSucceeded, result)
diff --git a/pkg/controller/atlasproject/team_reconciler.go b/pkg/controller/atlasproject/team_reconciler.go
@@ -43,6 +43,12 @@ func (r *AtlasProjectReconciler) teamReconcile(
 
 		defer statushandler.Update(teamCtx, r.Client, r.EventRecorder, team)
 
+		resourceVersionIsValid := customresource.ValidateResourceVersion(teamCtx, team, r.Log)
+		if !resourceVersionIsValid.IsOk() {
+			r.Log.Debugf("team validation result: %v", resourceVersionIsValid)
+			return resourceVersionIsValid.ReconcileResult(), nil
+		}
+
 		log.Infow("-> Starting AtlasTeam reconciliation", "spec", team.Spec)
 
 		teamID, result := ensureTeamState(ctx, teamCtx, team)
diff --git a/pkg/controller/customresource/customresource.go b/pkg/controller/customresource/customresource.go
diff --git a/pkg/controller/customresource/customresource_test.go b/pkg/controller/customresource/customresource_test.go
diff --git a/pkg/controller/workflow/reason.go b/pkg/controller/workflow/reason.go
diff --git a/pkg/version/version.go b/pkg/version/version.go
diff --git a/test/int/dbuser_test.go b/test/int/dbuser_test.go
diff --git a/test/int/deployment_test.go b/test/int/deployment_test.go
diff --git a/test/int/project_test.go b/test/int/project_test.go

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@ package v1`
`10`	`10`
`11`	`11`	`import (`
`12`	`12`	`metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"`
	`13`	`+`
	`14`	`+ "github.com/mongodb/mongodb-atlas-kubernetes/pkg/api/v1/status"`
`13`	`15`	`)`
`14`	`16`
`15`	`17`	`// AtlasBackupPolicySpec defines the desired state of AtlasBackupPolicy`
`@@ -47,6 +49,13 @@ type AtlasBackupPolicy struct {`
`47`	`49`	Status AtlasBackupPolicyStatus `json:"status,omitempty"`
`48`	`50`	`}`
`49`	`51`
	`52`	`+func (in *AtlasBackupPolicy) GetStatus() status.Status {`
	`53`	`+ return nil`
	`54`	`+}`
	`55`	`+`
	`56`	`+func (in *AtlasBackupPolicy) UpdateStatus(_ []status.Condition, _ ...status.Option) {`
	`57`	`+}`
	`58`	`+`
`50`	`59`	`type AtlasBackupPolicyStatus struct {`
`51`	`60`	`}`
`52`	`61`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@ package v1`
`11`	`11`	`import (`
`12`	`12`	`metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"`
`13`	`13`
	`14`	`+ "github.com/mongodb/mongodb-atlas-kubernetes/pkg/api/v1/status"`
	`15`	`+`
`14`	`16`	`"github.com/mongodb/mongodb-atlas-kubernetes/pkg/api/v1/common"`
`15`	`17`	`)`
`16`	`18`
`@@ -74,6 +76,13 @@ type AtlasBackupSchedule struct {`
`74`	`76`	Status AtlasBackupScheduleStatus `json:"status,omitempty"`
`75`	`77`	`}`
`76`	`78`
	`79`	`+func (in *AtlasBackupSchedule) GetStatus() status.Status {`
	`80`	`+ return nil`
	`81`	`+}`
	`82`	`+`
	`83`	`+func (in *AtlasBackupSchedule) UpdateStatus(_ []status.Condition, _ ...status.Option) {`
	`84`	`+}`
	`85`	`+`
`77`	`86`	`type AtlasBackupScheduleStatus struct {`
`78`	`87`	`}`
`79`	`88`