Bug 1737081: catsrc status should show error

Currently Status of CatalogSource does not show any information to the
user on current state(s). For example, if the registry pod backed by
the CatalogSource is crash looping, the status shows no information.

Add the following fields to Status:
- Message: It will display the error last observed.
- Reason: It will display the reason, for now we have two reasons:
    - ConfigMapError
    - RegistryServerError

Change the sync handler to set the error.

BZ: https://bugzilla.redhat.com/show_bug.cgi?id=1737081
Jira: https://jira.coreos.com/browse/OLM-929

Author: tkashem

Makefile

@@ -75,7 +75,7 @@ $(CMDS):
 $(TCMDS):
 	CGO_ENABLED=0 go test -c $(BUILD_TAGS) $(MOD_FLAGS) -o bin/$(shell basename $@) $@
 
-run-local: build-linux
+run-local: build-linux build-wait
 	rm -rf build
 	. ./scripts/build_local.sh
 	mkdir -p build/resources

pkg/api/apis/operators/catalogsource_types.go

@@ -67,22 +67,30 @@ type RegistryServiceStatus struct {
 	CreatedAt        metav1.Time
 }
 
+type GRPCConnectionState struct {
+	Address           string
+	LastObservedState string
+	LastConnectTime   metav1.Time
+}
+
 func (s *RegistryServiceStatus) Address() string {
 	return fmt.Sprintf("%s.%s.svc.cluster.local:%s", s.ServiceName, s.ServiceNamespace, s.Port)
 }
 
 type CatalogSourceStatus struct {
+	Message               string          `json:"message,omitempty"`
+	Reason                ConditionReason `json:"reason,omitempty"`
 	ConfigMapResource     *ConfigMapResourceReference
 	RegistryServiceStatus *RegistryServiceStatus
-	LastSync              metav1.Time
+	GRPCConnectionState   *GRPCConnectionState
 }
 
 type ConfigMapResourceReference struct {
-	Name      string
-	Namespace string
-
+	Name            string
+	Namespace       string
 	UID             types.UID
 	ResourceVersion string
+	LastUpdateTime  metav1.Time
 }
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

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

@@ -27,6 +27,11 @@ const (
 	SourceTypeGrpc SourceType = "grpc"
 )
 
+const (
+	CatalogSourceConfigMapError      ConditionReason = "ConfigMapError"
+	CatalogSourceRegistryServerError ConditionReason = "RegistryServerError"
+)
+
 type CatalogSourceSpec struct {
 	// SourceType is the type of source
 	SourceType SourceType `json:"sourceType"`
@@ -73,18 +78,35 @@ func (s *RegistryServiceStatus) Address() string {
 	return fmt.Sprintf("%s.%s.svc.cluster.local:%s", s.ServiceName, s.ServiceNamespace, s.Port)
 }
 
+type GRPCConnectionState struct {
+	Address           string      `json:"address,omitempty"`
+	LastObservedState string      `json:"lastObservedState"`
+	LastConnectTime   metav1.Time `json:"lastConnect,omitempty"`
+}
+
 type CatalogSourceStatus struct {
+	// A human readable message indicating details about why the ClusterServiceVersion is in this condition.
+	// +optional
+	Message string `json:"message,omitempty"`
+	// Reason is the reason the Subscription was transitioned to its current state.
+	// +optional
+	Reason ConditionReason `json:"reason,omitempty"`
+
 	ConfigMapResource     *ConfigMapResourceReference `json:"configMapReference,omitempty"`
 	RegistryServiceStatus *RegistryServiceStatus      `json:"registryService,omitempty"`
-	LastSync              metav1.Time                 `json:"lastSync,omitempty"`
+	GRPCConnectionState   *GRPCConnectionState        `json:"connectionState,omitempty"`
 }
 
 type ConfigMapResourceReference struct {
-	Name      string `json:"name"`
-	Namespace string `json:"namespace"`
+	Name            string      `json:"name"`
+	Namespace       string      `json:"namespace"`
+	UID             types.UID   `json:"uid,omitempty"`
+	ResourceVersion string      `json:"resourceVersion,omitempty"`
+	LastUpdateTime  metav1.Time `json:"lastUpdateTime,omitempty"`
+}
 
-	UID             types.UID `json:"uid,omitempty"`
-	ResourceVersion string    `json:"resourceVersion,omitempty"`
+func (r *ConfigMapResourceReference) IsAMatch(object *metav1.ObjectMeta) bool {
+	return r.UID == object.GetUID() && r.ResourceVersion == object.GetResourceVersion()
 }
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
@@ -106,6 +128,14 @@ func (c *CatalogSource) Address() string {
 	return c.Status.RegistryServiceStatus.Address()
 }
 
+func (c *CatalogSource) SetError(reason ConditionReason, err error) {
+	c.Status.Reason = reason
+	c.Status.Message = ""
+	if err != nil {
+		c.Status.Message = err.Error()
+	}
+}
+
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 
 // CatalogSourceList is a repository of CSVs, CRDs, and operator packages.