update resource definition and tests based on review

Signed-off-by: perdasilva <[email protected]>

Author: perdasilva

api/v1alpha1/operator_types.go

@@ -31,6 +31,14 @@ type OperatorSpec struct {
 	//+kubebuilder:validation:MaxLength:=64
 	//+kubebuilder:validation:Pattern:=^(\|\||\s+)?([\s~^><=]*)v?(\d+)(\.(\d+))?(\.(\d+))?(\-(.+))?$
 	//+kubebuilder:optional
+	// Version is an optional is semver constraint on the package version. If not specified, the latest version available of the package will be installed.
+	// If specified, the specific version of the package will be installed so long as it is available in any of the content sources available.
+	// Examples:
+	//  - 1.2.3
+	//  - 1.0.0-alpha
+	//  - 1.0.0-rc.1
+	//
+	// For more information on semver, please see https://semver.org/
 	Version string `json:"version,omitempty"`
 }
 

config/crd/bases/operators.operatorframework.io_operators.yaml

@@ -40,6 +40,12 @@ spec:
                 pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
                 type: string
               version:
+                description: "Version is an optional is semver constraint on the package
+                  version. If not specified, the latest version available of the package
+                  will be installed. If specified, the specific version of the package
+                  will be installed so long as it is available in any of the content
+                  sources available. Examples: - 1.2.3 - 1.0.0-alpha - 1.0.0-rc.1
+                  \n For more information on semver, please see https://semver.org/"
                 maxLength: 64
                 pattern: ^(\|\||\s+)?([\s~^><=]*)v?(\d+)(\.(\d+))?(\.(\d+))?(\-(.+))?$
                 type: string

controllers/operator_controller_test.go

@@ -80,7 +80,7 @@ var _ = Describe("Operator Controller Test", func() {
 				Expect(cond.Message).To(Equal(fmt.Sprintf("package '%s' not found", pkgName)))
 			})
 		})
-		When("the operator specifies a version range for which there are no bundles", func() {
+		When("the operator specifies a version that does not exist", func() {
 			var pkgName string
 			BeforeEach(func() {
 				By("initializing cluster state")
@@ -89,7 +89,7 @@ var _ = Describe("Operator Controller Test", func() {
 					ObjectMeta: metav1.ObjectMeta{Name: opKey.Name},
 					Spec: operatorsv1alpha1.OperatorSpec{
 						PackageName: pkgName,
-						Version:     ">=0.50.0",
+						Version:     "0.50.0",
 					},
 				}
 				err := cl.Create(ctx, operator)
@@ -99,7 +99,7 @@ var _ = Describe("Operator Controller Test", func() {
 				By("running reconcile")
 				res, err := reconciler.Reconcile(ctx, ctrl.Request{NamespacedName: opKey})
 				Expect(res).To(Equal(ctrl.Result{}))
-				Expect(err).To(MatchError(fmt.Sprintf("package '%s' in version range '>=0.50.0' not found", pkgName)))
+				Expect(err).To(MatchError(fmt.Sprintf("package '%s' at version '0.50.0' not found", pkgName)))
 
 				By("fetching updated operator after reconcile")
 				Expect(cl.Get(ctx, opKey, operator)).NotTo(HaveOccurred())
@@ -109,7 +109,7 @@ var _ = Describe("Operator Controller Test", func() {
 				Expect(cond).NotTo(BeNil())
 				Expect(cond.Status).To(Equal(metav1.ConditionFalse))
 				Expect(cond.Reason).To(Equal(operatorsv1alpha1.ReasonResolutionFailed))
-				Expect(cond.Message).To(Equal(fmt.Sprintf("package '%s' in version range '>=0.50.0' not found", pkgName)))
+				Expect(cond.Message).To(Equal(fmt.Sprintf("package '%s' at version '0.50.0' not found", pkgName)))
 			})
 		})
 		When("the operator specifies a valid available package", func() {

internal/resolution/variable_sources/required_package/required_package.go

@@ -94,8 +94,12 @@ func (r *RequiredPackageVariableSource) GetVariables(ctx context.Context, entity
 }
 
 func (r *RequiredPackageVariableSource) notFoundError() error {
+	// TODO: update this error message when/if we decide to support version ranges as opposed to fixing the version
+	//  context: we originally wanted to support version ranges and take the highest version that satisfies the range
+	//  during the upstream call on the 2023-04-11 we decided to pin the version instead. But, we'll keep version range
+	//  support under the covers in case we decide to pivot back.
 	if r.versionRange != "" {
-		return fmt.Errorf("package '%s' in version range '%s' not found", r.packageName, r.versionRange)
+		return fmt.Errorf("package '%s' at version '%s' not found", r.packageName, r.versionRange)
 	}
 	return fmt.Errorf("package '%s' not found", r.packageName)
 }