chore(pkg): make more like a kube-style go package

Author: ecordell

Dockerfile

@@ -4,9 +4,9 @@ RUN apk update && apk add sqlite build-base
 WORKDIR /go/src/github.com/operator-framework/operator-registry
 
 COPY vendor vendor
-COPY init init
-COPY store store
-RUN go build --tags json1 -o ./initializer ./init/...
+COPY cmd cmd
+COPY pkg pkg
+RUN go build --tags json1 -o ./initializer ./cmd/init/...
 
 COPY manifests manifests
 RUN ./initializer

init/main.go cmd/init/main.go

@@ -1,7 +1,7 @@
 package main
 
 import (
-	"github.com/operator-framework/operator-registry/store"
+	"github.com/operator-framework/operator-registry/pkg/sqlite"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
@@ -43,13 +43,13 @@ func runCmdFunc(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	dbLoader, err := store.NewSQLLiteLoader(outFilename)
+	dbLoader, err := sqlite.NewSQLLiteLoader(outFilename)
 	if err != nil {
 		logrus.Fatal(err)
 	}
 	defer dbLoader.Close()
 
-	loader := store.NewSQLLoaderForDirectory(dbLoader, manifestDir)
+	loader := sqlite.NewSQLLoaderForDirectory(dbLoader, manifestDir)
 	if err := loader.Populate(); err != nil {
 		logrus.Fatal(err)
 	}

init.sql

@@ -0,0 +1,30 @@
+package registry
+
+import (
+	"context"
+
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+)
+
+type Load interface {
+	AddOperatorBundle(bundleObjs []*unstructured.Unstructured) error
+	AddPackageChannels(manifest PackageManifest) error
+	AddProvidedApis() error
+}
+
+type Query interface {
+	ListPackages(context context.Context) ([]string, error)
+	GetPackage(context context.Context, name string) (*PackageManifest, error)
+	GetBundleForChannel(context context.Context, pkgName string, channelName string) (string, error)
+	GetBundleForName(context context.Context, name string) (string, error)
+	// Get all channel entries that say they replace this one
+	GetChannelEntriesThatReplace(context context.Context, name string) (entries []ChannelEntry, err error)
+	// Get the bundle in a package/channel that replace this one
+	GetBundleThatReplaces(context context.Context, name, pkgName, channelName string) (string, error)
+	// Get all channel entries that provide an api
+	GetChannelEntriesThatProvide(context context.Context, groupOrName, version, kind string) (entries []ChannelEntry, err error)
+	// Get latest channel entries that provide an api
+	GetLatestChannelEntriesThatProvide(context context.Context, groupOrName, version, kind string) (entries []ChannelEntry, err error)
+	// Get the the latest bundle that provides the API in a default channel
+	GetBundleThatProvides(context context.Context, groupOrName, version, kind string) (string, error)
+}

pkg/registry/interface.go

@@ -0,0 +1,52 @@
+package registry
+
+// PackageManifest holds information about a package, which is a reference to one (or more)
+// channels under a single package.
+type PackageManifest struct {
+	// PackageName is the name of the overall package, ala `etcd`.
+	PackageName string `json:"packageName"`
+
+	// Channels are the declared channels for the package, ala `stable` or `alpha`.
+	Channels []PackageChannel `json:"channels"`
+
+	// DefaultChannelName is, if specified, the name of the default channel for the package. The
+	// default channel will be installed if no other channel is explicitly given. If the package
+	// has a single channel, then that channel is implicitly the default.
+	DefaultChannelName string `json:"defaultChannel"`
+}
+
+// GetDefaultChannel gets the default channel or returns the only one if there's only one. returns empty string if it
+// can't determine the default
+func (m PackageManifest) GetDefaultChannel() string {
+	if m.DefaultChannelName != "" {
+		return m.DefaultChannelName
+	}
+	if len(m.Channels) == 1 {
+		return m.Channels[0].Name
+	}
+	return ""
+}
+
+// PackageChannel defines a single channel under a package, pointing to a version of that
+// package.
+type PackageChannel struct {
+	// Name is the name of the channel, e.g. `alpha` or `stable`
+	Name string `json:"name"`
+
+	// CurrentCSVName defines a reference to the CSV holding the version of this package currently
+	// for the channel.
+	CurrentCSVName string `json:"currentCSV"`
+}
+
+// IsDefaultChannel returns true if the PackageChennel is the default for the PackageManifest
+func (pc PackageChannel) IsDefaultChannel(pm PackageManifest) bool {
+	return pc.Name == pm.DefaultChannelName || len(pm.Channels) == 1
+}
+
+// ChannelEntry is a denormalized node in a channel graph
+type ChannelEntry struct {
+	PackageName string
+	ChannelName string
+	BundleName string
+	Replaces string
+}

pkg/registry/types.go

@@ -1,4 +1,4 @@
-package store
+package sqlite
 
 import (
 	"fmt"
@@ -8,7 +8,6 @@ import (
 	"strings"
 
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
-	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry"
 	"github.com/sirupsen/logrus"
 	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
 	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
@@ -17,6 +16,7 @@ import (
 	"k8s.io/apimachinery/pkg/runtime/serializer"
 	"k8s.io/apimachinery/pkg/util/yaml"
 	"k8s.io/client-go/kubernetes/scheme"
+	"github.com/operator-framework/operator-registry/pkg/registry"
 )
 
 // Scheme is the default instance of runtime.Scheme to which types in the Kubernetes API are already registered.
@@ -54,13 +54,13 @@ type APIKey struct {
 // files ending in `.clusterserviceversion.yaml` will be parsed as CSVs
 // files ending in `.package.yaml` will be parsed as Packages
 type DirectoryLoader struct {
-	store     Load
+	store     registry.Load
 	directory string
 }
 
 var _ SQLPopulator = &DirectoryLoader{}
 
-func NewSQLLoaderForDirectory(store Load, directory string) *DirectoryLoader {
+func NewSQLLoaderForDirectory(store registry.Load, directory string) *DirectoryLoader {
 	return &DirectoryLoader{
 		store:     store,
 		directory: directory,

store/directory.go pkg/sqlite/directory.go

@@ -1,27 +1,22 @@
-package store
+package sqlite
 
 import (
 	"database/sql"
 	"encoding/json"
 	"fmt"
 
 	_ "github.com/mattn/go-sqlite3"
-	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry"
+	"github.com/operator-framework/operator-registry/pkg/registry"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime"
 )
 
-type Load interface {
-	AddOperatorBundle(bundleObjs []*unstructured.Unstructured) error
-	AddPackageChannels(manifest registry.PackageManifest) error
-	AddProvidedApis() error
-}
 
 type SQLLoader struct {
 	db *sql.DB
 }
 
-var _ Load = &SQLLoader{}
+var _ registry.Load = &SQLLoader{}
 
 func NewSQLLiteLoader(outFilename string) (*SQLLoader, error) {
 	db, err := sql.Open("sqlite3", outFilename) // TODO: ?immutable=true

store/load.go pkg/sqlite/load.go

@@ -1,43 +1,20 @@
-package store
+package sqlite
 
 import (
 	"context"
 	"database/sql"
 	"fmt"
 
 	_ "github.com/mattn/go-sqlite3"
-	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry"
+	"github.com/operator-framework/operator-registry/pkg/registry"
 )
 
-type ChannelEntry struct {
-	packageName string
-	channelName string
-	bundleName string
-	replaces string
-}
-
-type Query interface {
-	ListPackages(context context.Context) ([]string, error)
-	GetPackage(context context.Context, name string) (*registry.PackageManifest, error)
-	GetBundleForChannel(context context.Context, pkgName string, channelName string) (string, error)
-	GetBundleForName(context context.Context, name string) (string, error)
-	// Get all channel entries that say they replace this one
-	GetChannelEntriesThatReplace(context context.Context, name string) (entries []ChannelEntry, err error)
-	// Get the bundle in a package/channel that replace this one
-	GetBundleThatReplaces(context context.Context, name, pkgName, channelName string) (string, error)
-	// Get all channel entries that provide an api
-	GetChannelEntriesThatProvide(context context.Context, groupOrName, version, kind string) (entries []ChannelEntry, err error)
-	// Get latest channel entries that provide an api
-	GetLatestChannelEntriesThatProvide(context context.Context, groupOrName, version, kind string) (entries []ChannelEntry, err error)
-	// Get the the latest bundle that provides the API in a default channel
-	GetBundleThatProvides(context context.Context, groupOrName, version, kind string) (string, error)
-}
 
 type SQLQuerier struct {
 	db *sql.DB
 }
 
-var _ Query = &SQLQuerier{}
+var _ registry.Query = &SQLQuerier{}
 
 func NewSQLLiteQuerier(dbFilename string) (*SQLQuerier, error) {
 	db, err := sql.Open("sqlite3", "file:" + dbFilename + "?immutable=true")
@@ -145,7 +122,7 @@ func (s *SQLQuerier) GetBundleForName(context context.Context, name string) (str
 	return bundle.String, nil
 }
 
-func (s *SQLQuerier) GetChannelEntriesThatReplace(context context.Context, name string) (entries []ChannelEntry, err error) {
+func (s *SQLQuerier) GetChannelEntriesThatReplace(context context.Context, name string) (entries []registry.ChannelEntry, err error) {
 	query := `SELECT DISTINCT channel_entry.package_name, channel_entry.channel_name, channel_entry.operatorbundle_name
 			  FROM channel_entry
 			  LEFT OUTER JOIN channel_entry replaces ON channel_entry.replaces = replaces.entry_id
@@ -155,7 +132,7 @@ func (s *SQLQuerier) GetChannelEntriesThatReplace(context context.Context, name
 		return
 	}
 
-	entries = []ChannelEntry{}
+	entries = []registry.ChannelEntry{}
 
 	for rows.Next() {
 		var pkgNameSQL sql.NullString
@@ -165,12 +142,11 @@ func (s *SQLQuerier) GetChannelEntriesThatReplace(context context.Context, name
 		if err = rows.Scan(&pkgNameSQL, &channelNameSQL, &bundleNameSQL); err != nil {
 			return
 		}
-
-		entries = append(entries, ChannelEntry{
-			packageName: pkgNameSQL.String,
-			channelName: channelNameSQL.String,
-			bundleName:  bundleNameSQL.String,
-			replaces:    name,
+		entries = append(entries, registry.ChannelEntry{
+			PackageName: pkgNameSQL.String,
+			ChannelName: channelNameSQL.String,
+			BundleName:  bundleNameSQL.String,
+			Replaces:    name,
 		})
 	}
 	if len(entries) == 0 {
@@ -201,7 +177,7 @@ func (s *SQLQuerier) GetBundleThatReplaces(context context.Context, name, pkgNam
 	return bundle.String, nil
 }
 
-func (s *SQLQuerier) GetChannelEntriesThatProvide(context context.Context, groupOrName, version, kind string) (entries []ChannelEntry, err error) {
+func (s *SQLQuerier) GetChannelEntriesThatProvide(context context.Context, groupOrName, version, kind string) (entries []registry.ChannelEntry, err error) {
 	query := `SELECT DISTINCT channel_entry.package_name, channel_entry.channel_name, channel_entry.operatorbundle_name, replaces.operatorbundle_name
           FROM channel_entry
           INNER JOIN api_provider ON channel_entry.entry_id = api_provider.channel_entry_id
@@ -213,7 +189,7 @@ func (s *SQLQuerier) GetChannelEntriesThatProvide(context context.Context, group
 		return
 	}
 
-	entries = []ChannelEntry{}
+	entries = []registry.ChannelEntry{}
 
 	for rows.Next() {
 		var pkgNameSQL sql.NullString
@@ -224,11 +200,11 @@ func (s *SQLQuerier) GetChannelEntriesThatProvide(context context.Context, group
 			return
 		}
 
-		entries = append(entries, ChannelEntry{
-			packageName: pkgNameSQL.String,
-			channelName: channelNameSQL.String,
-			bundleName:  bundleNameSQL.String,
-			replaces:    replacesSQL.String,
+		entries = append(entries, registry.ChannelEntry{
+			PackageName: pkgNameSQL.String,
+			ChannelName: channelNameSQL.String,
+			BundleName:  bundleNameSQL.String,
+			Replaces:    replacesSQL.String,
 		})
 	}
 	if len(entries) == 0 {
@@ -239,7 +215,7 @@ func (s *SQLQuerier) GetChannelEntriesThatProvide(context context.Context, group
 }
 
 // Get latest channel entries that provide an api
-func (s *SQLQuerier) GetLatestChannelEntriesThatProvide(context context.Context, groupOrName, version, kind string) (entries []ChannelEntry, err error) {
+func (s *SQLQuerier) GetLatestChannelEntriesThatProvide(context context.Context, groupOrName, version, kind string) (entries []registry.ChannelEntry, err error) {
 	query := `SELECT DISTINCT channel_entry.package_name, channel_entry.channel_name, channel_entry.operatorbundle_name, replaces.operatorbundle_name, MIN(channel_entry.depth)
           FROM channel_entry
           INNER JOIN api_provider ON channel_entry.entry_id = api_provider.channel_entry_id
@@ -251,7 +227,7 @@ func (s *SQLQuerier) GetLatestChannelEntriesThatProvide(context context.Context,
 		return nil, err
 	}
 
-	entries = []ChannelEntry{}
+	entries = []registry.ChannelEntry{}
 
 	for rows.Next() {
 		var pkgNameSQL sql.NullString
@@ -263,11 +239,11 @@ func (s *SQLQuerier) GetLatestChannelEntriesThatProvide(context context.Context,
 			return nil, err
 		}
 
-		entries = append(entries, ChannelEntry{
-			packageName: pkgNameSQL.String,
-			channelName: channelNameSQL.String,
-			bundleName:  bundleNameSQL.String,
-			replaces:    replacesSQL.String,
+		entries = append(entries, registry.ChannelEntry{
+			PackageName: pkgNameSQL.String,
+			ChannelName: channelNameSQL.String,
+			BundleName:  bundleNameSQL.String,
+			Replaces:    replacesSQL.String,
 		})
 	}
 	if len(entries) == 0 {

store/query.go pkg/sqlite/query.go

@@ -1,19 +1,19 @@
-package store
+package sqlite
 
 import (
 	"context"
 	"os"
 	"testing"
 
 	"github.com/stretchr/testify/require"
-	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry"
+	"github.com/operator-framework/operator-registry/pkg/registry"
 )
 
 func TestLoader(t *testing.T) {
 	store, err := NewSQLLiteLoader("test.db")
 	require.NoError(t, err)
 
-	loader := NewSQLLoaderForDirectory(store, "../manifests")
+	loader := NewSQLLoaderForDirectory(store, "../../manifests")
 	require.NoError(t, loader.Populate())
 }
 
@@ -50,21 +50,21 @@ func TestQuerier(t *testing.T) {
 
 	etcdChannelEntries, err := store.GetChannelEntriesThatReplace(context.TODO(), "etcdoperator.v0.9.0")
 	require.NoError(t, err)
-	require.ElementsMatch(t, []ChannelEntry{{"etcd", "alpha", "etcdoperator.v0.9.2", "etcdoperator.v0.9.0"}}, etcdChannelEntries)
+	require.ElementsMatch(t, []registry.ChannelEntry{{"etcd", "alpha", "etcdoperator.v0.9.2", "etcdoperator.v0.9.0"}}, etcdChannelEntries)
 
 	etcdBundleByReplaces, err := store.GetBundleThatReplaces(context.TODO(), "etcdoperator.v0.9.0", "etcd", "alpha")
 	require.NoError(t, err)
 	require.EqualValues(t, expectedBundle, etcdBundleByReplaces)
 
 	etcdChannelEntriesThatProvide, err := store.GetChannelEntriesThatProvide(context.TODO(), "etcdclusters.etcd.database.coreos.com", "v1beta2", "EtcdCluster")
-	require.ElementsMatch(t, []ChannelEntry{
+	require.ElementsMatch(t, []registry.ChannelEntry{
 		{"etcd", "alpha", "etcdoperator.v0.6.1", ""},
 		{"etcd", "alpha", "etcdoperator.v0.9.0", "etcdoperator.v0.6.1"},
 		{"etcd", "alpha", "etcdoperator.v0.9.2", "etcdoperator.v0.9.0"}}, etcdChannelEntriesThatProvide)
 
 	etcdLatestChannelEntriesThatProvide, err := store.GetLatestChannelEntriesThatProvide(context.TODO(), "etcdclusters.etcd.database.coreos.com", "v1beta2", "EtcdCluster")
 	require.NoError(t, err)
-	require.ElementsMatch(t, []ChannelEntry{{"etcd", "alpha", "etcdoperator.v0.9.2", "etcdoperator.v0.9.0"}}, etcdLatestChannelEntriesThatProvide)
+	require.ElementsMatch(t, []registry.ChannelEntry{{"etcd", "alpha", "etcdoperator.v0.9.2", "etcdoperator.v0.9.0"}}, etcdLatestChannelEntriesThatProvide)
 
 	etcdBundleByProvides, err := store.GetBundleThatProvides(context.TODO(), "etcdclusters.etcd.database.coreos.com", "v1beta2", "EtcdCluster")
 	require.NoError(t, err)