Codegen for registry API changes

Signed-off-by: Vu Dinh <[email protected]>

Author: dinhxuanvu

docs/design/operator-bundle.md

@@ -76,10 +76,9 @@ An example of a `dependencies.yaml` that specifies Prometheus operator and etcd
 ```
 dependencies:
   - type: olm.package
-    name: prometheus
+    packgeName: prometheus
     version: >0.27.0
   - type: olm.gvk
-    name: etcdclusters.etcd.database.coreos.com
     group: etcd.database.coreos.com
     kind: EtcdCluster
     version: v1beta2

pkg/api/grpc_health_v1/health.pb.go

@@ -96,6 +96,14 @@ func (EmptyQuery) GetCurrentCSVNameForChannel(ctx context.Context, pkgName, chan
 	return "", errors.New("empty querier: cannot get csv name for package and channel")
 }
 
+func (EmptyQuery) ListBundles(ctx context.Context) ([]*api.Bundle, error) {
+	return nil, errors.New("empty querier: cannot list bundles")
+}
+
+func (EmptyQuery) GetDependenciesForBundle(ctx context.Context, name, version, path string) (dependencies []*api.Dependency, err error) {
+	return nil, errors.New("empty querier: cannot get dependencies for bundle")
+}
+
 var _ Query = &EmptyQuery{}
 
 func NewEmptyQuerier() *EmptyQuery {

pkg/api/registry.pb.go

@@ -16,6 +16,10 @@ import (
 	"github.com/operator-framework/operator-registry/pkg/image"
 )
 
+const (
+	DependenciesFileName = "dependencies.yaml"
+)
+
 // DirectoryPopulator loads an unpacked operator bundle from a directory into the database.
 type DirectoryPopulator struct {
 	loader      Load
@@ -46,30 +50,41 @@ func (i *DirectoryPopulator) Populate(mode Mode) error {
 		return fmt.Errorf("unable to read directory %s: %s", metadata, err)
 	}
 
-	// Look for the metadata and manifests sub-directories to find the annotations.yaml file that will inform how the
-	// manifests of the bundle should be loaded into the database.
+	// Look for the metadata and manifests sub-directories to find the annotations.yaml
+	// file that will inform how the manifests of the bundle should be loaded into the database.
+	// If dependencies.yaml which contains operator dependencies in metadata directory
+	// exists, parse and load it into the DB
 	annotationsFile := &AnnotationsFile{}
+	dependenciesFile := &DependenciesFile{}
 	for _, f := range files {
 		err = decodeFile(filepath.Join(metadata, f.Name()), annotationsFile)
 		if err != nil || *annotationsFile == (AnnotationsFile{}) {
+			log.Info("found annotations file searching for csv")
 			continue
 		}
-		log.Info("found annotations file searching for csv")
+		if f.Name() == DependenciesFileName {
+			err = decodeFile(filepath.Join(metadata, f.Name()), dependenciesFile)
+			if err != nil {
+				log.Info("found dependencies file searching for csv")
+			} else {
+				log.Info("unable to parse dependencies.yaml file")
+			}
+		}
 	}
 
 	if *annotationsFile == (AnnotationsFile{}) {
 		return fmt.Errorf("Could not find annotations.yaml file")
 	}
 
-	err = i.loadManifests(manifests, annotationsFile, mode)
+	err = i.loadManifests(manifests, annotationsFile, dependenciesFile, mode)
 	if err != nil {
 		return err
 	}
 
 	return nil
 }
 
-func (i *DirectoryPopulator) loadManifests(manifests string, annotationsFile *AnnotationsFile, mode Mode) error {
+func (i *DirectoryPopulator) loadManifests(manifests string, annotationsFile *AnnotationsFile, dependenciesFile *DependenciesFile, mode Mode) error {
 	log := logrus.WithFields(logrus.Fields{"dir": i.from, "file": manifests, "load": "bundle"})
 
 	csv, err := i.findCSV(manifests)
@@ -96,6 +111,8 @@ func (i *DirectoryPopulator) loadManifests(manifests string, annotationsFile *An
 
 	// set the bundleimage on the bundle
 	bundle.BundleImage = i.to.String()
+	// set the dependencies on the bundle
+	bundle.Dependencies = dependenciesFile.Dependencies
 
 	bundle.Name = csvName
 	bundle.Package = annotationsFile.Annotations.PackageName

pkg/registry/empty.go

@@ -126,14 +126,14 @@ type Dependency struct {
 	// dependency or `olm.gvk` for gvk based dependency. This field is required.
 	Type string `json:"type" yaml:"type"`
 
-	// The name of dependency such as 'etcd'. This field is required.
-	Name string `json:"name" yaml:"name"`
+	// The name of dependency such as 'etcd'
+	Name string `json:"name" yaml:"packgeName"`
 
-	// The group of GVK based dependency.
-	Group string `json:"group,omitempty" yaml:"group"`
+	// The group of GVK based dependency
+	Group string `json:"group" yaml:"group"`
 
-	// The kind of GVK based dependency.
-	Kind string `json:"kind,omitempty" yaml:"kind"`
+	// The kind of GVK based dependency
+	Kind string `json:"kind" yaml:"kind"`
 
 	// The version of dependency in semver format
 	Version string `json:"version" yaml:"version"`

pkg/registry/populator.go

@@ -763,7 +763,7 @@ func (s *SQLLoader) addDependencies(tx *sql.Tx, bundle *registry.Bundle) error {
 		tx.Rollback()
 	}()
 
-	addDep, err := tx.Prepare("insert into dependencies_list(type, package_name, group_name, version, kind, operatorbundle_name, operatorbundle_version, operatorbundle_path) values(?, ?, ?, ?, ?, ?, ?, ?)")
+	addDep, err := tx.Prepare("insert into dependencies(type, package_name, group_name, version, kind, operatorbundle_name, operatorbundle_version, operatorbundle_path) values(?, ?, ?, ?, ?, ?, ?, ?)")
 	if err != nil {
 		return err
 	}

pkg/registry/types.go

@@ -688,7 +688,7 @@ func (s *SQLQuerier) GetBundlePathsForPackage(ctx context.Context, pkgName strin
 }
 
 func (s *SQLQuerier) GetBundlesForPackage(ctx context.Context, pkgName string) (map[registry.BundleKey]struct{}, error) {
-	query := `SELECT DISTINCT name, bundlepath, version FROM operatorbundle 
+	query := `SELECT DISTINCT name, bundlepath, version FROM operatorbundle
 	INNER JOIN channel_entry ON operatorbundle.name=channel_entry.operatorbundle_name
 	WHERE channel_entry.package_name=?`
 	rows, err := s.db.QueryContext(ctx, query, pkgName)
@@ -850,7 +850,7 @@ func (s *SQLQuerier) GetDependenciesForBundle(ctx context.Context, name, version
 
 	rows, err := s.db.QueryContext(ctx, depQuery, name, version, path)
 	if err != nil {
-		return nil, nil, err
+		return nil, err
 	}
 	dependencies = []*api.Dependency{}
 	for rows.Next() {