Add provider unit tests and small refactor

Signed-off-by: Per G. da Silva <[email protected]>

Author: perdasilva

pkg/controller/registry/resolver/resolver_test.go

@@ -175,14 +175,16 @@ func TestRuntimeConstraints(t *testing.T) {
 	}
 
 	for _, testCase := range testCases {
+		provider, err := runtime_constraints.New(testCase.runtimeConstraints)
+		require.Nil(t, err)
 		satResolver := SatResolver{
 			cache: cache.New(cache.StaticSourceProvider{
 				catalog: &cache.Snapshot{
 					Entries: testCase.snapshotEntries,
 				},
 			}),
 			log:                        logrus.New(),
-			runtimeConstraintsProvider: runtime_constraints.New(testCase.runtimeConstraints),
+			runtimeConstraintsProvider: provider,
 		}
 		operators, err := satResolver.SolveOperators([]string{namespace}, testCase.csvs, testCase.subs)
 
@@ -2229,7 +2231,7 @@ func TestNewDefaultSatResolver_BadClusterRuntimeConstraintsFile(t *testing.T) {
 		}
 	}()
 
-	runtimeConstraintsFilePath := "testdata/bad_runtime_constraints.json"
+	runtimeConstraintsFilePath := "runtime_constraints/testdata/bad_runtime_constraints.json"
 	// set the runtime constraints env var to something that isn't a valid filesystem path
 	require.Nil(t, os.Setenv(runtime_constraints.RuntimeConstraintEnvVarName, runtimeConstraintsFilePath))
 	_ = NewDefaultSatResolver(sourceProvider, catSrcLister, logger)
@@ -2243,7 +2245,7 @@ func TestNewDefaultSatResolver_GoodClusterRuntimeConstraintsFile(t *testing.T) {
 	logger := logrus.New()
 	t.Cleanup(func() { _ = os.Unsetenv(runtime_constraints.RuntimeConstraintEnvVarName) })
 
-	runtimeConstraintsFilePath := "testdata/runtime_constraints.json"
+	runtimeConstraintsFilePath := "runtime_constraints/testdata/runtime_constraints.json"
 	// set the runtime constraints env var to something that isn't a valid filesystem path
 	require.Nil(t, os.Setenv(runtime_constraints.RuntimeConstraintEnvVarName, runtimeConstraintsFilePath))
 	resolver := NewDefaultSatResolver(sourceProvider, catSrcLister, logger)

pkg/controller/registry/resolver/runtime_constraints/provider.go

@@ -11,7 +11,7 @@ import (
 )
 
 const (
-	maxRuntimeConstraints       = 10
+	MaxRuntimeConstraints       = 10
 	RuntimeConstraintEnvVarName = "RUNTIME_CONSTRAINTS"
 )
 
@@ -23,10 +23,14 @@ func (p *RuntimeConstraintsProvider) Constraints() []cache.Predicate {
 	return p.runtimeConstraints
 }
 
-func New(runtimeConstraints []cache.Predicate) *RuntimeConstraintsProvider {
+func New(runtimeConstraints []cache.Predicate) (*RuntimeConstraintsProvider, error) {
+	if len(runtimeConstraints) >= MaxRuntimeConstraints {
+		return nil, errors.Errorf("Too many runtime constraints defined (%d/%d)", len(runtimeConstraints), MaxRuntimeConstraints)
+	}
+
 	return &RuntimeConstraintsProvider{
 		runtimeConstraints: runtimeConstraints,
-	}
+	}, nil
 }
 
 func NewFromEnv() (*RuntimeConstraintsProvider, error) {
@@ -64,12 +68,9 @@ func NewFromFile(runtimeConstraintsFilePath string) (*RuntimeConstraintsProvider
 			}
 			constraints = append(constraints, cache.LabelPredicate(dep.Label))
 		}
-		if len(constraints) >= maxRuntimeConstraints {
-			return nil, errors.Errorf("Too many runtime constraints defined (%d/%d)", len(constraints), maxRuntimeConstraints)
-		}
 	}
 
-	return New(constraints), nil
+	return New(constraints)
 }
 
 func readRuntimeConstraintsYaml(yamlPath string) (*registry.PropertiesFile, error) {

pkg/controller/registry/resolver/runtime_constraints/provider_test.go

@@ -0,0 +1,95 @@
+package runtime_constraints
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver/cache"
+	"github.com/stretchr/testify/require"
+)
+
+func TestNew_HappyPath(t *testing.T) {
+	predicates := []cache.Predicate{
+		cache.PkgPredicate("etcd"),
+		cache.LabelPredicate("something"),
+	}
+	provider, err := New(predicates)
+	require.Nil(t, err)
+	require.Equal(t, predicates, provider.Constraints())
+}
+
+func TestNew_TooManyConstraints(t *testing.T) {
+	predicates := make([]cache.Predicate, MaxRuntimeConstraints+1)
+	for i := 0; i < len(predicates); i++ {
+		predicates[i] = cache.PkgPredicate(fmt.Sprintf("etcd-%d", i))
+	}
+	provider, err := New(predicates)
+	require.NotNil(t, err)
+	require.Nil(t, provider)
+}
+
+func TestNewFromFile_HappyPath(t *testing.T) {
+	provider, err := NewFromFile("testdata/runtime_constraints.json")
+	require.Nil(t, err)
+	require.Len(t, provider.Constraints(), 1)
+	require.Equal(t, provider.Constraints()[0], cache.PkgPredicate("etcd"))
+}
+
+func TestNewFromFile_ErrorOnNotFound(t *testing.T) {
+	provider, err := NewFromFile("testdata/not/a/real/path.json")
+	require.NotNil(t, err)
+	require.Nil(t, provider)
+}
+
+func TestNewFromFile_TooManyConstraints(t *testing.T) {
+	provider, err := NewFromFile("testdata/too_many_constraints.json")
+	require.NotNil(t, err)
+	require.Nil(t, provider)
+}
+
+func TestNewFromEnv_HappyPath(t *testing.T) {
+	require.Nil(t, os.Setenv(RuntimeConstraintEnvVarName, "testdata/runtime_constraints.json"))
+	t.Cleanup(func() { _ = os.Unsetenv(RuntimeConstraintEnvVarName) })
+
+	provider, err := NewFromEnv()
+	require.Nil(t, err)
+	require.Len(t, provider.Constraints(), 1)
+	require.Equal(t, provider.Constraints()[0], cache.PkgPredicate("etcd"))
+}
+
+func TestNewFromEnv_ErrorOnNotFound(t *testing.T) {
+	testCases := []struct {
+		title string
+		value string
+	}{
+		{
+			title: "File not found",
+			value: "testdata/not/a/real/path.json",
+		}, {
+			title: "Bad path",
+			value: "fsdkljflsdk ropweiropw 4434!@#!#",
+		}, {
+			title: "No env var set",
+			value: "nil",
+		},
+	}
+
+	for _, testCase := range testCases {
+		if testCase.value != "nil" {
+			require.Nil(t, os.Setenv(RuntimeConstraintEnvVarName, testCase.value))
+			t.Cleanup(func() { _ = os.Unsetenv(RuntimeConstraintEnvVarName) })
+		}
+		provider, err := NewFromEnv()
+		require.NotNil(t, err)
+		require.Nil(t, provider)
+	}
+}
+
+func TestNewFromEnv_TooManyConstraints(t *testing.T) {
+	require.Nil(t, os.Setenv(RuntimeConstraintEnvVarName, "testdata/too_many_constraints.json"))
+	t.Cleanup(func() { _ = os.Unsetenv(RuntimeConstraintEnvVarName) })
+	provider, err := NewFromEnv()
+	require.NotNil(t, err)
+	require.Nil(t, provider)
+}

pkg/controller/registry/resolver/testdata/bad_runtime_constraints.json renamed to pkg/controller/registry/resolver/runtime_constraints/testdata/bad_runtime_constraints.json

@@ -0,0 +1,77 @@
+{
+  "properties": [
+    {
+      "type": "olm.package",
+      "value": {
+        "packageName": "etcd12",
+        "version": "1.0.0"
+      }
+    }, {
+      "type": "olm.package",
+      "value": {
+        "packageName": "etcd11",
+        "version": "1.0.0"
+      }
+    }, {
+      "type": "olm.package",
+      "value": {
+        "packageName": "etcd10",
+        "version": "1.0.0"
+      }
+    }, {
+      "type": "olm.package",
+      "value": {
+        "packageName": "etcd9",
+        "version": "1.0.0"
+      }
+    }, {
+      "type": "olm.package",
+      "value": {
+        "packageName": "etcd8",
+        "version": "1.0.0"
+      }
+    }, {
+      "type": "olm.package",
+      "value": {
+        "packageName": "etcd7",
+        "version": "1.0.0"
+      }
+    }, {
+      "type": "olm.package",
+      "value": {
+        "packageName": "etcd6",
+        "version": "1.0.0"
+      }
+    }, {
+      "type": "olm.package",
+      "value": {
+        "packageName": "etcd5",
+        "version": "1.0.0"
+      }
+    }, {
+      "type": "olm.package",
+      "value": {
+        "packageName": "etcd4",
+        "version": "1.0.0"
+      }
+    }, {
+      "type": "olm.package",
+      "value": {
+        "packageName": "etcd3",
+        "version": "1.0.0"
+      }
+    }, {
+      "type": "olm.package",
+      "value": {
+        "packageName": "etcd2",
+        "version": "1.0.0"
+      }
+    }, {
+      "type": "olm.package",
+      "value": {
+        "packageName": "etcd1",
+        "version": "1.0.0"
+      }
+    }
+  ]
+}

pkg/controller/registry/resolver/testdata/runtime_constraints.json renamed to pkg/controller/registry/resolver/runtime_constraints/testdata/runtime_constraints.json

@@ -85,7 +85,7 @@ func mustDeployRuntimeConstraintsConfigMap(kubeClient k8scontrollerclient.Client
         |    {
 		|      "type": "olm.package",
         |      "value": {
-        |        "packageName": "",
+        |        "packageName": "etcd",
         |        "version": "1.0.0"
         |      }
         |    }