adding --enable-alpha feature flag

Signed-off-by: Lance Galletti <[email protected]>

Author: gallettilance

cmd/opm/index/add.go

@@ -68,6 +68,10 @@ func addIndexAddCmd(parent *cobra.Command) {
 	if err := indexCmd.Flags().MarkHidden("overwrite-latest"); err != nil {
 		logrus.Panic(err.Error())
 	}
+	indexCmd.Flags().Bool("enable-alpha", false, "enable unsupported alpha features of the OPM CLI")
+	if err := indexCmd.Flags().MarkHidden("enable-alpha"); err != nil {
+		logrus.Panic(err.Error())
+	}
 	if err := indexCmd.Flags().MarkHidden("debug"); err != nil {
 		logrus.Panic(err.Error())
 	}
@@ -129,6 +133,11 @@ func runIndexAddCmdFunc(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	enableAlpha, err := cmd.Flags().GetBool("enable-alpha")
+	if err != nil {
+		return err
+	}
+
 	modeEnum, err := registry.GetModeFromString(mode)
 	if err != nil {
 		return err
@@ -159,6 +168,7 @@ func runIndexAddCmdFunc(cmd *cobra.Command, args []string) error {
 		Mode:              modeEnum,
 		SkipTLS:           skipTLS,
 		Overwrite:         overwrite,
+		EnableAlpha:       enableAlpha,
 	}
 
 	err = indexAdder.AddToIndex(request)

pkg/lib/indexer/indexer.go

@@ -65,6 +65,7 @@ type AddToIndexRequest struct {
 	CaFile            string
 	SkipTLS           bool
 	Overwrite         bool
+	EnableAlpha       bool
 }
 
 // AddToIndex is an aggregate API used to generate a registry index image with additional bundles
@@ -89,6 +90,7 @@ func (i ImageIndexer) AddToIndex(request AddToIndexRequest) error {
 		SkipTLS:       request.SkipTLS,
 		ContainerTool: i.PullTool,
 		Overwrite:     request.Overwrite,
+		EnableAlpha:   request.EnableAlpha,
 	}
 
 	// Add the bundles to the registry

pkg/lib/registry/registry.go

@@ -31,6 +31,7 @@ type AddToRegistryRequest struct {
 	Mode          registry.Mode
 	ContainerTool containertools.ContainerTool
 	Overwrite     bool
+	EnableAlpha   bool
 }
 
 func (r RegistryUpdater) AddToRegistry(request AddToRegistryRequest) error {
@@ -40,10 +41,11 @@ func (r RegistryUpdater) AddToRegistry(request AddToRegistryRequest) error {
 	}
 	defer db.Close()
 
-	dbLoader, err := sqlite.NewSQLLiteLoader(db)
+	dbLoader, err := sqlite.NewSQLLiteLoader(db, sqlite.WithEnableAlpha(request.EnableAlpha))
 	if err != nil {
 		return err
 	}
+
 	if err := dbLoader.Migrate(context.TODO()); err != nil {
 		return err
 	}

pkg/registry/populator_test.go

@@ -2085,7 +2085,7 @@ func TestSubstitutesFor(t *testing.T) {
 			db, cleanup := CreateTestDb(t)
 			defer cleanup()
 
-			load, err := sqlite.NewSQLLiteLoader(db)
+			load, err := sqlite.NewSQLLiteLoader(db, sqlite.WithEnableAlpha(true))
 			require.NoError(t, err)
 			err = load.Migrate(context.TODO())
 			require.NoError(t, err)
@@ -2157,3 +2157,80 @@ func getBundleSubstitution(ctx context.Context, db *sql.DB, name string) (string
 	}
 	return substitutesFor.String, nil
 }
+
+func TestEnableAlpha(t *testing.T) {
+	type args struct {
+		bundles     []string
+		enableAlpha bool
+	}
+	type expected struct {
+		err error
+	}
+	tests := []struct {
+		description string
+		args        args
+		expected    expected
+	}{
+		{
+			description: "SubstitutesForTrue",
+			args: args{
+				bundles: []string{
+					"prometheus.0.22.2",
+					"prometheus.0.14.0",
+					"prometheus.0.15.0",
+					"prometheus.0.15.0.substitutesfor",
+				},
+				enableAlpha: true,
+			},
+			expected: expected{
+				err: nil,
+			},
+		},
+		{
+			description: "SubstitutesForFalse",
+			args: args{
+				bundles: []string{
+					"prometheus.0.22.2",
+					"prometheus.0.14.0",
+					"prometheus.0.15.0",
+					"prometheus.0.15.0.substitutesfor",
+				},
+				enableAlpha: false,
+			},
+			expected: expected{
+				err: errors.NewAggregate([]error{fmt.Errorf("SubstitutesFor is an alpha-only feature. You must enable alpha features with the flag --enable-alpha in order to use this feature.")}),
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.description, func(t *testing.T) {
+			logrus.SetLevel(logrus.DebugLevel)
+			db, cleanup := CreateTestDb(t)
+			defer cleanup()
+
+			load, err := sqlite.NewSQLLiteLoader(db, sqlite.WithEnableAlpha(tt.args.enableAlpha))
+			require.NoError(t, err)
+			err = load.Migrate(context.TODO())
+			require.NoError(t, err)
+			query := sqlite.NewSQLLiteQuerierFromDb(db)
+
+			graphLoader, err := sqlite.NewSQLGraphLoaderFromDB(db)
+			require.NoError(t, err)
+
+			populate := func(names []string) error {
+				refMap := make(map[image.Reference]string, 0)
+				for _, name := range names {
+					refMap[image.SimpleReference("quay.io/test/"+name)] = "../../bundles/" + name
+				}
+				return registry.NewDirectoryPopulator(
+					load,
+					graphLoader,
+					query,
+					refMap,
+					make(map[string]map[image.Reference]string, 0), false).Populate(registry.ReplacesMode)
+			}
+			require.Equal(t, tt.expected.err, populate(tt.args.bundles))
+		})
+	}
+}

pkg/sqlite/db_options.go

@@ -7,13 +7,15 @@ import (
 type DbOptions struct {
 	// MigratorBuilder is a function that returns a migrator instance
 	MigratorBuilder func(*sql.DB) (Migrator, error)
+	EnableAlpha     bool
 }
 
 type DbOption func(*DbOptions)
 
 func defaultDBOptions() *DbOptions {
 	return &DbOptions{
 		MigratorBuilder: NewSQLLiteMigrator,
+		EnableAlpha:     false,
 	}
 }
 
@@ -22,3 +24,9 @@ func WithMigratorBuilder(m func(loader *sql.DB) (Migrator, error)) DbOption {
 		o.MigratorBuilder = m
 	}
 }
+
+func WithEnableAlpha(enableAlpha bool) DbOption {
+	return func(o *DbOptions) {
+		o.EnableAlpha = enableAlpha
+	}
+}

pkg/sqlite/load.go

@@ -16,8 +16,9 @@ import (
 )
 
 type sqlLoader struct {
-	db       *sql.DB
-	migrator Migrator
+	db          *sql.DB
+	migrator    Migrator
+	enableAlpha bool
 }
 
 type MigratableLoader interface {
@@ -42,7 +43,7 @@ func NewSQLLiteLoader(db *sql.DB, opts ...DbOption) (MigratableLoader, error) {
 		return nil, err
 	}
 
-	return &sqlLoader{db: db, migrator: migrator}, nil
+	return &sqlLoader{db: db, migrator: migrator, enableAlpha: options.EnableAlpha}, nil
 }
 
 func (s *sqlLoader) Migrate(ctx context.Context) error {
@@ -111,6 +112,10 @@ func (s *sqlLoader) addOperatorBundle(tx *sql.Tx, bundle *registry.Bundle) error
 		return err
 	}
 
+	if substitutesFor != "" && !s.enableAlpha {
+		return fmt.Errorf("SubstitutesFor is an alpha-only feature. You must enable alpha features with the flag --enable-alpha in order to use this feature.")
+	}
+
 	if _, err := addBundle.Exec(csvName, csvBytes, bundleBytes, bundleImage, version, skiprange, replaces, strings.Join(skips, ","), substitutesFor); err != nil {
 		return err
 	}
@@ -136,9 +141,11 @@ func (s *sqlLoader) addOperatorBundle(tx *sql.Tx, bundle *registry.Bundle) error
 		return err
 	}
 
-	err = s.addSubstitutesFor(tx, bundle)
-	if err != nil {
-		return err
+	if s.enableAlpha {
+		err = s.addSubstitutesFor(tx, bundle)
+		if err != nil {
+			return err
+		}
 	}
 
 	return s.addAPIs(tx, bundle)