Merge pull request #14 from Bowenislandsong/resolvingCycDependency

Removing olm dependency

Author: ecordell

go.mod

@@ -30,14 +30,12 @@ replace (
 require (
 	github.com/blang/semver v3.5.1+incompatible
 	github.com/ghodss/yaml v1.0.0
-	github.com/golang/groupcache v0.0.0-20191027212112-611e8accdfc9 // indirect
-	github.com/hashicorp/golang-lru v0.5.3 // indirect
-	github.com/operator-framework/operator-lifecycle-manager v0.0.0-20191115003340-16619cd27fa5
 	github.com/operator-framework/operator-registry v1.5.3
 	github.com/pkg/errors v0.8.1
 	github.com/sirupsen/logrus v1.4.2
 	github.com/spf13/cobra v0.0.5
 	github.com/stretchr/testify v1.4.0
+	k8s.io/api v0.0.0
 	k8s.io/apiextensions-apiserver v0.0.0
 	k8s.io/apimachinery v0.0.0
 	k8s.io/client-go v8.0.0+incompatible

go.sum

@@ -4,7 +4,7 @@ import (
 	"encoding/json"
 
 	"github.com/blang/semver"
-	operatorsv1alpha1 "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
+	operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
 	"github.com/operator-framework/operator-registry/pkg/registry"
 	"github.com/operator-framework/operator-registry/pkg/sqlite"
 	"github.com/pkg/errors"

pkg/internal/bundle.go

@@ -0,0 +1,67 @@
+package version
+
+import (
+	"encoding/json"
+
+	"github.com/blang/semver"
+)
+
+// +k8s:openapi-gen=true
+// OperatorVersion is a wrapper around semver.Version which supports correct
+// marshaling to YAML and JSON.
+// +kubebuilder:validation:Type=string
+type OperatorVersion struct {
+	semver.Version `json:"-"`
+}
+
+// DeepCopyInto creates a deep-copy of the Version value.
+func (v *OperatorVersion) DeepCopyInto(out *OperatorVersion) {
+	out.Major = v.Major
+	out.Minor = v.Minor
+	out.Patch = v.Patch
+
+	if v.Pre != nil {
+		pre := make([]semver.PRVersion, len(v.Pre))
+		copy(pre, v.Pre)
+		out.Pre = pre
+	}
+
+	if v.Build != nil {
+		build := make([]string, len(v.Build))
+		copy(build, v.Build)
+		out.Build = build
+	}
+}
+
+// MarshalJSON implements the encoding/json.Marshaler interface.
+func (v OperatorVersion) MarshalJSON() ([]byte, error) {
+	return json.Marshal(v.String())
+}
+
+// UnmarshalJSON implements the encoding/json.Unmarshaler interface.
+func (v *OperatorVersion) UnmarshalJSON(data []byte) (err error) {
+	var versionString string
+
+	if err = json.Unmarshal(data, &versionString); err != nil {
+		return
+	}
+
+	version := semver.Version{}
+	version, err = semver.ParseTolerant(versionString)
+	if err != nil {
+		return err
+	}
+	v.Version = version
+	return
+}
+
+// OpenAPISchemaType is used by the kube-openapi generator when constructing
+// the OpenAPI spec of this type.
+//
+// See: https://github.com/kubernetes/kube-openapi/tree/master/pkg/generators
+func (_ OperatorVersion) OpenAPISchemaType() []string { return []string{"string"} }
+
+// OpenAPISchemaFormat is used by the kube-openapi generator when constructing
+// the OpenAPI spec of this type.
+// "semver" is not a standard openapi format but tooling may use the value regardless
+func (_ OperatorVersion) OpenAPISchemaFormat() string { return "semver" }

pkg/lib/version/version.go

@@ -0,0 +1,77 @@
+package version
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/blang/semver"
+	"github.com/stretchr/testify/require"
+)
+
+func TestOperatorVersionMarshal(t *testing.T) {
+	tests := []struct {
+		name string
+		in   OperatorVersion
+		out  []byte
+		err  error
+	}{
+		{
+			name: "MMP",
+			in:   OperatorVersion{semver.MustParse("1.2.3")},
+			out:  []byte(`"1.2.3"`),
+		},
+		{
+			name: "empty",
+			in:   OperatorVersion{semver.Version{}},
+			out:  []byte(`"0.0.0"`),
+		},
+		{
+			name: "with-timestamp",
+			in:   OperatorVersion{semver.MustParse("1.2.3-1556715351")},
+			out:  []byte(`"1.2.3-1556715351"`),
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			m, err := tt.in.MarshalJSON()
+			require.Equal(t, tt.out, m, string(m))
+			require.Equal(t, tt.err, err)
+		})
+	}
+}
+
+func TestOperatorVersionUnmarshal(t *testing.T) {
+	type TestStruct struct {
+		Version OperatorVersion `json:"v"`
+	}
+	tests := []struct {
+		name string
+		in   []byte
+		out  TestStruct
+		err  error
+	}{
+		{
+			name: "MMP",
+			in:   []byte(`{"v": "1.2.3"}`),
+			out:  TestStruct{Version: OperatorVersion{semver.MustParse("1.2.3")}},
+		},
+		{
+			name: "empty",
+			in:   []byte(`{"v": "0.0.0"}`),
+			out:  TestStruct{Version: OperatorVersion{semver.Version{Major: 0, Minor: 0, Patch: 0}}},
+		},
+		{
+			name: "with-timestamp",
+			in:   []byte(`{"v": "1.2.3-1556715351"}`),
+			out:  TestStruct{OperatorVersion{semver.MustParse("1.2.3-1556715351")}},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			s := TestStruct{}
+			err := json.Unmarshal(tt.in, &s)
+			require.Equal(t, tt.out, s)
+			require.Equal(t, tt.err, err)
+		})
+	}
+}

pkg/lib/version/version_test.go

@@ -0,0 +1,142 @@
+package operators
+
+import (
+	"fmt"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/types"
+)
+
+// CatalogSourceKind is the PascalCase name of a CatalogSource's kind.
+const CatalogSourceKind = "CatalogSource"
+
+// SourceType indicates the type of backing store for a CatalogSource
+type SourceType string
+
+const (
+	// SourceTypeInternal (deprecated) specifies a CatalogSource of type SourceTypeConfigmap
+	SourceTypeInternal SourceType = "internal"
+
+	// SourceTypeConfigmap specifies a CatalogSource that generates a configmap-server registry
+	SourceTypeConfigmap SourceType = "configmap"
+
+	// SourceTypeGrpc specifies a CatalogSource that can use an operator registry image to generate a
+	// registry-server or connect to a pre-existing registry at an address.
+	SourceTypeGrpc SourceType = "grpc"
+)
+
+type CatalogSourceSpec struct {
+	// SourceType is the type of source
+	SourceType SourceType
+
+	// ConfigMap is the name of the ConfigMap to be used to back a configmap-server registry.
+	// Only used when SourceType = SourceTypeConfigmap or SourceTypeInternal.
+	// +Optional
+	ConfigMap string
+
+	// Address is a host that OLM can use to connect to a pre-existing registry.
+	// Format: <registry-host or ip>:<port>
+	// Only used when SourceType = SourceTypeGrpc.
+	// Ignored when the Image field is set.
+	// +Optional
+	Address string
+
+	// Image is an operator-registry container image to instantiate a registry-server with.
+	// Only used when SourceType = SourceTypeGrpc.
+	// If present, the address field is ignored.
+	// +Optional
+	Image string
+
+	// UpdateStrategy defines how updated catalog source images can be discovered
+	// Consists of an interval that defines polling duration and an embedded strategy type
+	// +Optional
+	UpdateStrategy *UpdateStrategy
+
+	// Secrets represent set of secrets that can be used to access the contents of the catalog.
+	// It is best to keep this list small, since each will need to be tried for every catalog entry.
+	// +Optional
+	Secrets []string
+
+	// Metadata
+	DisplayName string
+	Description string
+	Publisher   string
+	Icon        Icon
+}
+
+// UpdateStrategy holds all the different types of catalog source update strategies
+// Currently only registry polling strategy is implemented
+type UpdateStrategy struct {
+	*RegistryPoll
+}
+
+type RegistryPoll struct {
+	// Interval is used to determine the time interval between checks of the latest catalog source version.
+	// The catalog operator polls to see if a new version of the catalog source is available.
+	// If available, the latest image is pulled and gRPC traffic is directed to the latest catalog source.
+	Interval *metav1.Duration
+}
+
+type RegistryServiceStatus struct {
+	Protocol         string
+	ServiceName      string
+	ServiceNamespace string
+	Port             string
+	CreatedAt        metav1.Time
+}
+
+type GRPCConnectionState struct {
+	Address           string
+	LastObservedState string
+	LastConnectTime   metav1.Time
+}
+
+func (s *RegistryServiceStatus) Address() string {
+	return fmt.Sprintf("%s.%s.svc:%s", s.ServiceName, s.ServiceNamespace, s.Port)
+}
+
+type CatalogSourceStatus struct {
+	Message                 string          `json:"message,omitempty"`
+	Reason                  ConditionReason `json:"reason,omitempty"`
+	ConfigMapResource       *ConfigMapResourceReference
+	RegistryServiceStatus   *RegistryServiceStatus
+	GRPCConnectionState     *GRPCConnectionState
+	LatestImageRegistryPoll *metav1.Time
+}
+
+type ConfigMapResourceReference struct {
+	Name            string
+	Namespace       string
+	UID             types.UID
+	ResourceVersion string
+	LastUpdateTime  metav1.Time
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +genclient
+
+// CatalogSource is a repository of CSVs, CRDs, and operator packages.
+type CatalogSource struct {
+	metav1.TypeMeta
+	metav1.ObjectMeta
+
+	Spec   CatalogSourceSpec
+	Status CatalogSourceStatus
+}
+
+func (c *CatalogSource) Address() string {
+	if c.Spec.Address != "" {
+		return c.Spec.Address
+	}
+	return c.Status.RegistryServiceStatus.Address()
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// CatalogSourceList is a list of CatalogSource resources.
+type CatalogSourceList struct {
+	metav1.TypeMeta
+	metav1.ListMeta
+
+	Items []CatalogSource
+}