test: Gracefully shutdown operator in integration test (#544)

Signed-off-by: Daniel Pacak <pacak.daniel@gmail.com>

cmd/starboard-operator/main.go

@@ -6,6 +6,7 @@ import (
 	"github.com/aquasecurity/starboard/pkg/operator"
 	"github.com/aquasecurity/starboard/pkg/operator/etc"
 	"github.com/aquasecurity/starboard/pkg/starboard"
+	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 )
@@ -44,5 +45,5 @@ func run() error {
 
 	setupLog.Info("Starting operator", "buildInfo", buildInfo)
 
-	return operator.Run(buildInfo, operatorConfig)
+	return operator.Start(ctrl.SetupSignalHandler(), buildInfo, operatorConfig)
 }

itest/helper/helper.go

@@ -10,6 +10,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/labels"
+	"k8s.io/apimachinery/pkg/util/rand"
 	"k8s.io/utils/pointer"
 )
 
@@ -77,6 +78,10 @@ func (b *DeploymentBuilder) WithName(name string) *DeploymentBuilder {
 	return b
 }
 
+func (b *DeploymentBuilder) WithRandomName(prefix string) *DeploymentBuilder {
+	return b.WithName(prefix + "-" + rand.String(5))
+}
+
 func (b *DeploymentBuilder) WithNamespace(namespace string) *DeploymentBuilder {
 	b.namespace = namespace
 	return b

itest/starboard-operator/starboard_operator_test.go

@@ -20,7 +20,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/labels"
 	"k8s.io/apimachinery/pkg/types"
-	"k8s.io/apimachinery/pkg/util/rand"
 	"k8s.io/apimachinery/pkg/util/wait"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
@@ -71,7 +70,7 @@ var _ = Describe("Starboard Operator", func() {
 		BeforeEach(func() {
 			ctx = context.Background()
 			deploy = helper.NewDeployment().
-				WithName(baseDeploymentName+"-"+rand.String(5)).
+				WithRandomName(baseDeploymentName).
 				WithNamespace(namespaceName).
 				WithContainer("wordpress", "wordpress:4.9").
 				Build()
@@ -105,7 +104,7 @@ var _ = Describe("Starboard Operator", func() {
 			By("Creating Deployment wordpress")
 			ctx = context.Background()
 			deploy = helper.NewDeployment().
-				WithName(baseDeploymentName+"-"+rand.String(5)).
+				WithRandomName(baseDeploymentName).
 				WithNamespace(namespaceName).
 				WithContainer("wordpress", "wordpress:4.9").
 				Build()
@@ -221,7 +220,7 @@ var _ = Describe("Starboard Operator", func() {
 			By("Creating Deployment wordpress")
 			ctx = context.Background()
 			deploy = helper.NewDeployment().
-				WithName(baseDeploymentName+"-"+rand.String(5)).
+				WithRandomName(baseDeploymentName).
 				WithNamespace(namespaceName).
 				WithContainer("wordpress", "wordpress:4.9").
 				Build()

itest/starboard-operator/suite_test.go

@@ -4,6 +4,7 @@ import (
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 
+	"context"
 	"path/filepath"
 	"testing"
 
@@ -21,7 +22,11 @@ import (
 )
 
 var (
-	buildInfo = starboard.BuildInfo{Version: "dev", Commit: "none", Date: "unknown"}
+	buildInfo = starboard.BuildInfo{
+		Version: "dev",
+		Commit:  "none",
+		Date:    "unknown",
+	}
 )
 
 var (
@@ -31,6 +36,8 @@ var (
 var (
 	scheme     *runtime.Scheme
 	kubeClient client.Client
+	startCtx   context.Context
+	stopFunc   context.CancelFunc
 )
 
 var (
@@ -45,11 +52,11 @@ func TestStarboardOperator(t *testing.T) {
 	RunSpecs(t, "Starboard Operator")
 }
 
-var _ = BeforeSuite(func(done Done) {
+var _ = BeforeSuite(func() {
 	operatorConfig, err := etc.GetOperatorConfig()
 	Expect(err).ToNot(HaveOccurred())
 
-	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(operatorConfig.LogDevMode)))
 
 	kubeConfig, err := ctrl.GetConfig()
 	Expect(err).ToNot(HaveOccurred())
@@ -68,20 +75,25 @@ var _ = BeforeSuite(func(done Done) {
 		CRDDirectoryPaths:  []string{filepath.Join("..", "..", "deploy", "crd")},
 	}
 
+	By("Starting Kubernetes test environment")
 	_, err = testEnv.Start()
 	Expect(err).ToNot(HaveOccurred())
 
+	startCtx, stopFunc = context.WithCancel(context.Background())
+
 	go func() {
 		defer GinkgoRecover()
-
-		err = operator.Run(buildInfo, operatorConfig)
+		By("Starting Starboard operator")
+		err = operator.Start(startCtx, buildInfo, operatorConfig)
 		Expect(err).ToNot(HaveOccurred())
 	}()
 
-	close(done)
-}, 60)
+})
 
 var _ = AfterSuite(func() {
+	By("Stopping Starboard operator")
+	stopFunc()
+	By("Stopping Kubernetes test environment")
 	err := testEnv.Stop()
 	Expect(err).ToNot(HaveOccurred())
 })

pkg/operator/etc/config.go

@@ -8,6 +8,7 @@ import (
 	"github.com/caarlos0/env/v6"
 )
 
+// Config defines parameters for running the operator.
 type Config struct {
 	Namespace                     string        `env:"OPERATOR_NAMESPACE"`
 	TargetNamespaces              string        `env:"OPERATOR_TARGET_NAMESPACES"`
@@ -27,6 +28,7 @@ type Config struct {
 	BatchDeleteDelay              time.Duration `env:"OPERATOR_BATCH_DELETE_DELAY" envDefault:"10s"`
 }
 
+// GetOperatorConfig loads Config from environment variables.
 func GetOperatorConfig() (Config, error) {
 	var config Config
 	err := env.Parse(&config)

pkg/operator/operator.go

@@ -25,7 +25,9 @@ var (
 	setupLog = log.Log.WithName("operator")
 )
 
-func Run(buildInfo starboard.BuildInfo, operatorConfig etc.Config) error {
+// Start starts all registered reconcilers and blocks until the context is cancelled.
+// Returns an error if there is an error starting any reconciler.
+func Start(ctx context.Context, buildInfo starboard.BuildInfo, operatorConfig etc.Config) error {
 	installMode, operatorNamespace, targetNamespaces, err := operatorConfig.ResolveInstallMode()
 	if err != nil {
 		return fmt.Errorf("resolving install mode: %w", err)
@@ -205,7 +207,7 @@ func Run(buildInfo starboard.BuildInfo, operatorConfig etc.Config) error {
 	}
 
 	setupLog.Info("Starting controllers manager")
-	if err := mgr.Start(ctrl.SetupSignalHandler()); err != nil {
+	if err := mgr.Start(ctx); err != nil {
 		return fmt.Errorf("starting controllers manager: %w", err)
 	}