Add support for Prometheus Custom Resources

This commit introduces support for packaging PrometheusRules and
ServiceMonitor CustomResources in a Catalog Bundle. In order to
introduce this change, the following changes were made:

* OLM can now resolve unknown resources stored in the Catalog Bundle
  using the dynamic client. This feature is only enabled for
  PrometheusRule and ServiceMonitor Custom Resources, which are provided
  by the Prometheus Operator.
* The steps of an InstallPlan are now ordered by CSVs, CRDs, and
  finally the remaining resources.

Author: awgreene

go.mod

@@ -29,6 +29,7 @@ require (
 	github.com/stretchr/testify v1.4.0
 	github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5 // indirect
 	github.com/xiang90/probing v0.0.0-20190116061207-43a291ad63a2 // indirect
+	golang.org/x/sys v0.0.0-20191210023423-ac6580df4449 // indirect
 	golang.org/x/time v0.0.0-20191024005414-555d28b269f0
 	gonum.org/v1/gonum v0.0.0-20190710053202-4340aa3071a0 // indirect
 	google.golang.org/grpc v1.24.0

go.sum

@@ -795,6 +795,8 @@ golang.org/x/sys v0.0.0-20190626221950-04f50cda93cb h1:fgwFCsaw9buMuxNd6+DQfAuSF
 golang.org/x/sys v0.0.0-20190626221950-04f50cda93cb/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20191028164358-195ce5e7f934 h1:u/E0NqCIWRDAo9WCFo6Ko49njPFDLSd3z+X1HgWDMpE=
 golang.org/x/sys v0.0.0-20191028164358-195ce5e7f934/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20191210023423-ac6580df4449 h1:gSbV7h1NRL2G1xTg/owz62CST1oJBmxy4QpMMregXVQ=
+golang.org/x/sys v0.0.0-20191210023423-ac6580df4449/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/text v0.0.0-20160726164857-2910a502d2bf/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=

pkg/api/apis/operators/installplan_types.go

@@ -63,10 +63,12 @@ const (
 type StepStatus string
 
 const (
-	StepStatusUnknown    StepStatus = "Unknown"
-	StepStatusNotPresent StepStatus = "NotPresent"
-	StepStatusPresent    StepStatus = "Present"
-	StepStatusCreated    StepStatus = "Created"
+	StepStatusUnknown             StepStatus = "Unknown"
+	StepStatusNotPresent          StepStatus = "NotPresent"
+	StepStatusPresent             StepStatus = "Present"
+	StepStatusCreated             StepStatus = "Created"
+	StepStatusWaitingForAPI       StepStatus = "WaitingForApi"
+	StepStatusUnsupportedResource StepStatus = "UnsupportedResource"
 )
 
 // ErrInvalidInstallPlan is the error returned by functions that operate on
@@ -168,6 +170,8 @@ type BundleLookupConditionType string
 const (
 	// BundleLookupPending describes BundleLookups that are not complete.
 	BundleLookupPending BundleLookupConditionType = "BundleLookupPending"
+
+	crdKind = "CustomResourceDefinition"
 )
 
 type BundleLookupCondition struct {
@@ -248,6 +252,58 @@ func (b *BundleLookup) SetCondition(cond BundleLookupCondition) BundleLookupCond
 	return cond
 }
 
+func OrderSteps(steps []*Step) []*Step {
+	// CSVs must be applied first
+	csvList := []*Step{}
+
+	// CRDs must be applied second
+	crdList := []*Step{}
+
+	// Other resources may be applied in any order
+	remainingResources := []*Step{}
+	for _, step := range steps {
+		switch step.Resource.Kind {
+		case crdKind:
+			crdList = append(crdList, step)
+		case ClusterServiceVersionKind:
+			csvList = append(csvList, step)
+		default:
+			remainingResources = append(remainingResources, step)
+		}
+	}
+
+	result := make([]*Step, len(steps))
+	i := 0
+
+	for j := range csvList {
+		result[i] = csvList[j]
+		i++
+	}
+
+	for j := range crdList {
+		result[i] = crdList[j]
+		i++
+	}
+
+	for j := range remainingResources {
+		result[i] = remainingResources[j]
+		i++
+	}
+
+	return result
+}
+
+func (s InstallPlanStatus) NeedsRequeue() bool {
+	for _, step := range s.Plan {
+		switch step.Status {
+		case StepStatusWaitingForAPI:
+			return true
+		}
+	}
+
+	return false
+}
+
 // ManifestsMatch returns true if the CSV manifests in the StepResources of the given list of steps
 // matches those in the InstallPlanStatus.
 func (s *InstallPlanStatus) CSVManifestsMatch(steps []*Step) bool {

pkg/api/apis/operators/v1alpha1/installplan_test.go

@@ -0,0 +1,64 @@
+package v1alpha1
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestOrderSteps(t *testing.T) {
+	tests := []struct {
+		description string
+		in          []*Step
+	}{
+		{
+			description: "EmptyList",
+			in:          []*Step{},
+		},
+		{
+			description: "csvsRDS",
+			in:          []*Step{step(crdKind), step(ClusterServiceVersionKind), step(crdKind), step(crdKind)},
+		},
+		{
+			description: "csvsCRDSAndRandomKinds",
+			in:          []*Step{step(crdKind), step(ClusterServiceVersionKind), step(crdKind), step(crdKind), step("These"), step("are"), step("random"), step("Kinds")},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.description, func(t *testing.T) {
+			result := OrderSteps(tt.in)
+			require.EqualValues(t, len(result), len(tt.in))
+			require.True(t, isOrdered(result))
+		})
+	}
+}
+
+func step(kind string) *Step {
+	resource := StepResource{}
+	resource.Kind = kind
+
+	result := &Step{}
+	result.Resource = resource
+	return result
+}
+
+func isOrdered(steps []*Step) bool {
+	var crdSeen, otherResourceSeen bool
+	for _, step := range steps {
+		switch step.Resource.Kind {
+		case ClusterServiceVersionKind:
+			if crdSeen || otherResourceSeen {
+				return false
+			}
+		case crdKind:
+			crdSeen = true
+			if otherResourceSeen {
+				return false
+			}
+		default:
+			otherResourceSeen = true
+		}
+	}
+	return true
+}

pkg/api/apis/operators/v1alpha1/installplan_types.go

@@ -65,10 +65,12 @@ const (
 type StepStatus string
 
 const (
-	StepStatusUnknown    StepStatus = "Unknown"
-	StepStatusNotPresent StepStatus = "NotPresent"
-	StepStatusPresent    StepStatus = "Present"
-	StepStatusCreated    StepStatus = "Created"
+	StepStatusUnknown             StepStatus = "Unknown"
+	StepStatusNotPresent          StepStatus = "NotPresent"
+	StepStatusPresent             StepStatus = "Present"
+	StepStatusCreated             StepStatus = "Created"
+	StepStatusWaitingForAPI       StepStatus = "WaitingForApi"
+	StepStatusUnsupportedResource StepStatus = "UnsupportedResource"
 )
 
 // ErrInvalidInstallPlan is the error returned by functions that operate on
@@ -137,6 +139,57 @@ func (s *InstallPlanStatus) SetCondition(cond InstallPlanCondition) InstallPlanC
 	return cond
 }
 
+func OrderSteps(steps []*Step) []*Step {
+	// CSVs must be applied first
+	csvList := []*Step{}
+
+	// CRDs must be applied second
+	crdList := []*Step{}
+
+	// Other resources may be applied in any order
+	remainingResources := []*Step{}
+	for _, step := range steps {
+		switch step.Resource.Kind {
+		case crdKind:
+			crdList = append(crdList, step)
+		case ClusterServiceVersionKind:
+			csvList = append(csvList, step)
+		default:
+			remainingResources = append(remainingResources, step)
+		}
+	}
+
+	result := make([]*Step, len(steps))
+	i := 0
+
+	for j := range csvList {
+		result[i] = csvList[j]
+		i++
+	}
+
+	for j := range crdList {
+		result[i] = crdList[j]
+		i++
+	}
+
+	for j := range remainingResources {
+		result[i] = remainingResources[j]
+		i++
+	}
+
+	return result
+}
+
+func (s InstallPlanStatus) NeedsRequeue() bool {
+	for _, step := range s.Plan {
+		switch step.Status {
+		case StepStatusWaitingForAPI:
+			return true
+		}
+	}
+
+	return false
+}
 func ConditionFailed(cond InstallPlanConditionType, reason InstallPlanConditionReason, message string, now *metav1.Time) InstallPlanCondition {
 	return InstallPlanCondition{
 		Type:               cond,
@@ -170,6 +223,8 @@ type BundleLookupConditionType string
 const (
 	// BundleLookupPending describes BundleLookups that are not complete.
 	BundleLookupPending BundleLookupConditionType = "BundleLookupPending"
+
+	crdKind = "CustomResourceDefinition"
 )
 
 type BundleLookupCondition struct {