Add system-wide solver constraint injection

cmd/catalog/main.go

@@ -1,160 +1,9 @@
 package main
 
 import (
-	"context"
-	"flag"
-	"fmt"
-	"net/http"
-	"os"
-	"time"
-
-	configv1client "github.com/openshift/client-go/config/clientset/versioned/typed/config/v1"
-	log "github.com/sirupsen/logrus"
-	utilclock "k8s.io/apimachinery/pkg/util/clock"
-	k8sscheme "k8s.io/client-go/kubernetes/scheme"
-	"k8s.io/client-go/tools/clientcmd"
-
-	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client"
-	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/catalog"
-	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/catalogtemplate"
-	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/operatorclient"
-	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/operatorstatus"
-	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/server"
-	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/signals"
-	"github.com/operator-framework/operator-lifecycle-manager/pkg/metrics"
-	olmversion "github.com/operator-framework/operator-lifecycle-manager/pkg/version"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/cmd/catalog"
 )
 
-const (
-	catalogNamespaceEnvVarName  = "GLOBAL_CATALOG_NAMESPACE"
-	defaultWakeupInterval       = 15 * time.Minute
-	defaultCatalogNamespace     = "openshift-operator-lifecycle-manager"
-	defaultConfigMapServerImage = "quay.io/operator-framework/configmap-operator-registry:latest"
-	defaultOPMImage             = "quay.io/operator-framework/upstream-opm-builder:latest"
-	defaultUtilImage            = "quay.io/operator-framework/olm:latest"
-	defaultOperatorName         = ""
-)
-
-// config flags defined globally so that they appear on the test binary as well
-var (
-	kubeConfigPath = flag.String(
-		"kubeconfig", "", "absolute path to the kubeconfig file")
-
-	wakeupInterval = flag.Duration(
-		"interval", defaultWakeupInterval, "wakeup interval")
-
-	catalogNamespace = flag.String(
-		"namespace", defaultCatalogNamespace, "namespace where catalog will run and install catalog resources")
-
-	configmapServerImage = flag.String(
-		"configmapServerImage", defaultConfigMapServerImage, "the image to use for serving the operator registry api for a configmap")
-
-	opmImage = flag.String(
-		"opmImage", defaultOPMImage, "the image to use for unpacking bundle content with opm")
-
-	utilImage = flag.String(
-		"util-image", defaultUtilImage, "an image containing custom olm utilities")
-
-	writeStatusName = flag.String(
-		"writeStatusName", defaultOperatorName, "ClusterOperator name in which to write status, set to \"\" to disable.")
-
-	debug = flag.Bool(
-		"debug", false, "use debug log level")
-
-	version = flag.Bool("version", false, "displays olm version")
-
-	tlsKeyPath = flag.String(
-		"tls-key", "", "Path to use for private key (requires tls-cert)")
-
-	tlsCertPath = flag.String(
-		"tls-cert", "", "Path to use for certificate key (requires tls-key)")
-
-	profiling = flag.Bool("profiling", false, "deprecated")
-
-	clientCAPath = flag.String("client-ca", "", "path to watch for client ca bundle")
-
-	installPlanTimeout  = flag.Duration("install-plan-retry-timeout", 1*time.Minute, "time since first attempt at which plan execution errors are considered fatal")
-	bundleUnpackTimeout = flag.Duration("bundle-unpack-timeout", 10*time.Minute, "The time limit for bundle unpacking, after which InstallPlan execution is considered to have failed. 0 is considered as having no timeout.")
-)
-
-func init() {
-	metrics.RegisterCatalog()
-}
-
 func main() {
-	// Get exit signal context
-	ctx, cancel := context.WithCancel(signals.Context())
-	defer cancel()
-
-	// Parse the command-line flags.
-	flag.Parse()
-
-	// Check if version flag was set
-	if *version {
-		fmt.Print(olmversion.String())
-
-		// Exit early
-		os.Exit(0)
-	}
-
-	logger := log.New()
-	if *debug {
-		logger.SetLevel(log.DebugLevel)
-	}
-	logger.Infof("log level %s", logger.Level)
-
-	// If the catalogNamespaceEnvVarName environment variable is set, then  update the value of catalogNamespace.
-	if catalogNamespaceEnvVarValue := os.Getenv(catalogNamespaceEnvVarName); catalogNamespaceEnvVarValue != "" {
-		logger.Infof("%s environment variable is set. Updating Global Catalog Namespace to %s", catalogNamespaceEnvVarName, catalogNamespaceEnvVarValue)
-		*catalogNamespace = catalogNamespaceEnvVarValue
-	}
-
-	listenAndServe, err := server.GetListenAndServeFunc(logger, tlsCertPath, tlsKeyPath, clientCAPath)
-	if err != nil {
-		logger.Fatal("Error setting up health/metric/pprof service: %v", err)
-	}
-
-	go func() {
-		if err := listenAndServe(); err != nil && err != http.ErrServerClosed {
-			logger.Error(err)
-		}
-	}()
-
-	// create a config client for operator status
-	config, err := clientcmd.BuildConfigFromFlags("", *kubeConfigPath)
-	if err != nil {
-		log.Fatalf("error configuring client: %s", err.Error())
-	}
-	configClient, err := configv1client.NewForConfig(config)
-	if err != nil {
-		log.Fatalf("error configuring client: %s", err.Error())
-	}
-	opClient := operatorclient.NewClientFromConfig(*kubeConfigPath, logger)
-	crClient, err := client.NewClient(*kubeConfigPath)
-	if err != nil {
-		log.Fatalf("error configuring client: %s", err.Error())
-	}
-
-	// Create a new instance of the operator.
-	op, err := catalog.NewOperator(ctx, *kubeConfigPath, utilclock.RealClock{}, logger, *wakeupInterval, *configmapServerImage, *opmImage, *utilImage, *catalogNamespace, k8sscheme.Scheme, *installPlanTimeout, *bundleUnpackTimeout)
-	if err != nil {
-		log.Panicf("error configuring catalog operator: %s", err.Error())
-	}
-
-	opCatalogTemplate, err := catalogtemplate.NewOperator(ctx, *kubeConfigPath, logger, *wakeupInterval, *catalogNamespace)
-	if err != nil {
-		log.Panicf("error configuring catalog template operator: %s", err.Error())
-	}
-
-	op.Run(ctx)
-	<-op.Ready()
-
-	opCatalogTemplate.Run(ctx)
-	<-opCatalogTemplate.Ready()
-
-	if *writeStatusName != "" {
-		operatorstatus.MonitorClusterStatus(*writeStatusName, op.AtLevel(), op.Done(), opClient, configClient, crClient)
-	}
-
-	<-op.Done()
+	catalog.Exec()
 }

pkg/cmd/catalog/catalog.go

@@ -0,0 +1,183 @@
+package catalog
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"net/http"
+	"os"
+	"sync"
+	"time"
+
+	configv1client "github.com/openshift/client-go/config/clientset/versioned/typed/config/v1"
+	log "github.com/sirupsen/logrus"
+	utilclock "k8s.io/apimachinery/pkg/util/clock"
+	k8sscheme "k8s.io/client-go/kubernetes/scheme"
+	"k8s.io/client-go/tools/clientcmd"
+
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/catalog"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/catalogtemplate"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/operatorclient"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/operatorstatus"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/server"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/signals"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/metrics"
+	olmversion "github.com/operator-framework/operator-lifecycle-manager/pkg/version"
+)
+
+const (
+	catalogNamespaceEnvVarName  = "GLOBAL_CATALOG_NAMESPACE"
+	defaultWakeupInterval       = 15 * time.Minute
+	defaultCatalogNamespace     = "openshift-operator-lifecycle-manager"
+	defaultConfigMapServerImage = "quay.io/operator-framework/configmap-operator-registry:latest"
+	defaultOPMImage             = "quay.io/operator-framework/upstream-opm-builder:latest"
+	defaultUtilImage            = "quay.io/operator-framework/olm:latest"
+	defaultOperatorName         = ""
+)
+
+// config flags defined globally so that they appear on the test binary as well
+var (
+	kubeConfigPath = flag.String(
+		"kubeconfig", "", "absolute path to the kubeconfig file")
+
+	wakeupInterval = flag.Duration(
+		"interval", defaultWakeupInterval, "wakeup interval")
+
+	catalogNamespace = flag.String(
+		"namespace", defaultCatalogNamespace, "namespace where catalog will run and install catalog resources")
+
+	configmapServerImage = flag.String(
+		"configmapServerImage", defaultConfigMapServerImage, "the image to use for serving the operator registry api for a configmap")
+
+	opmImage = flag.String(
+		"opmImage", defaultOPMImage, "the image to use for unpacking bundle content with opm")
+
+	utilImage = flag.String(
+		"util-image", defaultUtilImage, "an image containing custom olm utilities")
+
+	writeStatusName = flag.String(
+		"writeStatusName", defaultOperatorName, "ClusterOperator name in which to write status, set to \"\" to disable.")
+
+	debug = flag.Bool(
+		"debug", false, "use debug log level")
+
+	version = flag.Bool("version", false, "displays olm version")
+
+	tlsKeyPath = flag.String(
+		"tls-key", "", "Path to use for private key (requires tls-cert)")
+
+	tlsCertPath = flag.String(
+		"tls-cert", "", "Path to use for certificate key (requires tls-key)")
+
+	profiling = flag.Bool("profiling", false, "deprecated")
+
+	clientCAPath = flag.String("client-ca", "", "path to watch for client ca bundle")
+
+	installPlanTimeout  = flag.Duration("install-plan-retry-timeout", 1*time.Minute, "time since first attempt at which plan execution errors are considered fatal")
+	bundleUnpackTimeout = flag.Duration("bundle-unpack-timeout", 10*time.Minute, "The time limit for bundle unpacking, after which InstallPlan execution is considered to have failed. 0 is considered as having no timeout.")
+)
+
+func init() {
+	metrics.RegisterCatalog()
+}
+
+type config struct {
+}
+
+type Option func(*config)
+
+func apply(options []Option, to *config) *config {
+	for _, opt := range options {
+		opt(to)
+	}
+
+	return to
+}
+
+var once sync.Once
+
+func Exec(options ...Option) {
+	once.Do(func() {
+		// The command should never be executed more than once
+		exec(apply(options, &config{}))
+	})
+}
+
+func exec(cfg *config) {
+	// Get exit signal context
+	ctx, cancel := context.WithCancel(signals.Context())
+	defer cancel()
+
+	// Parse the command-line flags.
+	flag.Parse()
+
+	// Check if version flag was set
+	if *version {
+		fmt.Print(olmversion.String())
+
+		// Exit early
+		os.Exit(0)
+	}
+
+	logger := log.New()
+	if *debug {
+		logger.SetLevel(log.DebugLevel)
+	}
+	logger.Infof("log level %s", logger.Level)
+
+	// If the catalogNamespaceEnvVarName environment variable is set, then  update the value of catalogNamespace.
+	if catalogNamespaceEnvVarValue := os.Getenv(catalogNamespaceEnvVarName); catalogNamespaceEnvVarValue != "" {
+		logger.Infof("%s environment variable is set. Updating Global Catalog Namespace to %s", catalogNamespaceEnvVarName, catalogNamespaceEnvVarValue)
+		*catalogNamespace = catalogNamespaceEnvVarValue
+	}
+
+	listenAndServe, err := server.GetListenAndServeFunc(logger, tlsCertPath, tlsKeyPath, clientCAPath)
+	if err != nil {
+		logger.Fatal("Error setting up health/metric/pprof service: %v", err)
+	}
+
+	go func() {
+		if err := listenAndServe(); err != nil && err != http.ErrServerClosed {
+			logger.Error(err)
+		}
+	}()
+
+	// create a config client for operator status
+	config, err := clientcmd.BuildConfigFromFlags("", *kubeConfigPath)
+	if err != nil {
+		log.Fatalf("error configuring client: %s", err.Error())
+	}
+	configClient, err := configv1client.NewForConfig(config)
+	if err != nil {
+		log.Fatalf("error configuring client: %s", err.Error())
+	}
+	opClient := operatorclient.NewClientFromConfig(*kubeConfigPath, logger)
+	crClient, err := client.NewClient(*kubeConfigPath)
+	if err != nil {
+		log.Fatalf("error configuring client: %s", err.Error())
+	}
+
+	// Create a new instance of the operator.
+	op, err := catalog.NewOperator(ctx, *kubeConfigPath, utilclock.RealClock{}, logger, *wakeupInterval, *configmapServerImage, *opmImage, *utilImage, *catalogNamespace, k8sscheme.Scheme, *installPlanTimeout, *bundleUnpackTimeout)
+	if err != nil {
+		log.Panicf("error configuring catalog operator: %s", err.Error())
+	}
+
+	opCatalogTemplate, err := catalogtemplate.NewOperator(ctx, *kubeConfigPath, logger, *wakeupInterval, *catalogNamespace)
+	if err != nil {
+		log.Panicf("error configuring catalog template operator: %s", err.Error())
+	}
+
+	op.Run(ctx)
+	<-op.Ready()
+
+	opCatalogTemplate.Run(ctx)
+	<-opCatalogTemplate.Ready()
+
+	if *writeStatusName != "" {
+		operatorstatus.MonitorClusterStatus(*writeStatusName, op.AtLevel(), op.Done(), opClient, configClient, crClient)
+	}
+
+	<-op.Done()
+}