operators/v1alpha1: expose CSV copied logic (openshift#289)

We want to use a partial object metadata query for CSVs to reduce
resource utilization. We still want to ask questions about whether these
CSVs are copied, so we need to refactor this method to take only object
metadata. While it's not a perfect port of the previous logic, it defies
explanation how an object would have all the other markings of being
copied but the wrong status.

Signed-off-by: Steve Kuznetsov <[email protected]>
Upstream-repository: api
Upstream-commit: 409ec70c6c889945acb0447397305aa5c2150ea2
Signed-off-by: Steve Kuznetsov <[email protected]>

Author: stevekuznetsov

pkg/manifests/csv.yaml

@@ -5,7 +5,7 @@ metadata:
   name: packageserver
   namespace: openshift-operator-lifecycle-manager
   labels:
-    olm.version: 0.0.0-7b1fd73aa35a79a5766541029762ec59ef9eab29
+    olm.version: 0.0.0-6e63ad61683d27bae6a357eb473fb3067a4c73e6
     olm.clusteroperator.name: operator-lifecycle-manager-packageserver
   annotations:
     include.release.openshift.io/self-managed-high-availability: "true"
@@ -159,7 +159,7 @@ spec:
                                 - packageserver
                         topologyKey: "kubernetes.io/hostname"
   maturity: alpha
-  version: 0.0.0-7b1fd73aa35a79a5766541029762ec59ef9eab29
+  version: 0.0.0-6e63ad61683d27bae6a357eb473fb3067a4c73e6
   apiservicedefinitions:
     owned:
       - group: packages.operators.coreos.com

staging/api/pkg/operators/v1alpha1/clusterserviceversion.go

@@ -120,12 +120,19 @@ func (c *ClusterServiceVersion) IsObsolete() bool {
 
 // IsCopied returns true if the CSV has been copied and false otherwise.
 func (c *ClusterServiceVersion) IsCopied() bool {
-	operatorNamespace, ok := c.GetAnnotations()[OperatorGroupNamespaceAnnotationKey]
-	if c.Status.Reason == CSVReasonCopied || ok && c.GetNamespace() != operatorNamespace {
-		return true
+	return c.Status.Reason == CSVReasonCopied || IsCopied(c)
+}
+
+func IsCopied(o metav1.Object) bool {
+	annotations := o.GetAnnotations()
+	if annotations != nil {
+		operatorNamespace, ok := annotations[OperatorGroupNamespaceAnnotationKey]
+		if ok && o.GetNamespace() != operatorNamespace {
+			return true
+		}
 	}
 
-	if labels := c.GetLabels(); labels != nil {
+	if labels := o.GetLabels(); labels != nil {
 		if _, ok := labels[CopiedLabelKey]; ok {
 			return true
 		}

staging/api/pkg/operators/v1alpha1/clusterserviceversion_test.go

@@ -430,3 +430,68 @@ func helperNewConditions(count int) []ClusterServiceVersionCondition {
 
 	return conditions
 }
+
+func TestIsCopied(t *testing.T) {
+	var testCases = []struct {
+		name     string
+		input    metav1.Object
+		expected bool
+	}{
+		{
+			name:     "no labels or annotations",
+			input:    &metav1.ObjectMeta{},
+			expected: false,
+		},
+		{
+			name: "no labels, has annotations but missing operatorgroup namespace annotation",
+			input: &metav1.ObjectMeta{
+				Annotations: map[string]string{},
+			},
+			expected: false,
+		},
+		{
+			name: "no labels, has operatorgroup namespace annotation matching self",
+			input: &metav1.ObjectMeta{
+				Namespace: "whatever",
+				Annotations: map[string]string{
+					"olm.operatorNamespace": "whatever",
+				},
+			},
+			expected: false,
+		},
+		{
+			name: "no labels, has operatorgroup namespace annotation not matching self",
+			input: &metav1.ObjectMeta{
+				Namespace: "whatever",
+				Annotations: map[string]string{
+					"olm.operatorNamespace": "other",
+				},
+			},
+			expected: true,
+		},
+		{
+			name: "no annotations, labels missing copied key",
+			input: &metav1.ObjectMeta{
+				Labels: map[string]string{},
+			},
+			expected: false,
+		},
+		{
+			name: "no annotations, labels has copied key",
+			input: &metav1.ObjectMeta{
+				Labels: map[string]string{
+					"olm.copiedFrom": "whatever",
+				},
+			},
+			expected: true,
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.name, func(t *testing.T) {
+			if got, expected := IsCopied(testCase.input), testCase.expected; got != expected {
+				t.Errorf("got %v, expected %v", got, expected)
+			}
+		})
+	}
+}