add tests

Author: easyCZ

components/usage/cmd/run.go

@@ -9,6 +9,7 @@ import (
 	"github.com/gitpod-io/gitpod/common-go/log"
 	"github.com/gitpod-io/gitpod/usage/pkg/controller"
 	"github.com/spf13/cobra"
+	"time"
 )
 
 func init() {
@@ -27,12 +28,15 @@ func run() *cobra.Command {
 		Run: func(cmd *cobra.Command, args []string) {
 			log.Init(ServiceName, Version, true, verbose)
 
-			ctrl, err := controller.New("@every 1m", controller.ReconcilerFunc(controller.HelloWorldReconciler))
+			ctrl, err := controller.New(1*time.Minute, controller.ReconcilerFunc(controller.HelloWorldReconciler))
 			if err != nil {
 				log.WithError(err).Fatal("Failed to initialize usage controller.")
 			}
 
-			ctrl.Start()
+			err = ctrl.Start()
+			if err != nil {
+				log.WithError(err).Fatal("Failed to start usage controller.")
+			}
 			defer ctrl.Stop()
 
 			srv, err := baseserver.New("usage")

components/usage/pkg/controller/controller.go

@@ -12,32 +12,27 @@ import (
 	"time"
 )
 
-func New(schedule string, reconciler Reconciler) (*Controller, error) {
-	sched, err := cron.Parse(schedule)
-	if err != nil {
-		return nil, fmt.Errorf("failed to parse cron schedule: %w", err)
-	}
-
+func New(schedule time.Duration, reconciler Reconciler) (*Controller, error) {
 	return &Controller{
-		schedule:   sched,
+		schedule:   schedule,
 		reconciler: reconciler,
 		scheduler:  cron.NewWithLocation(time.UTC),
 	}, nil
 }
 
 type Controller struct {
-	schedule   cron.Schedule
+	schedule   time.Duration
 	reconciler Reconciler
 
 	scheduler *cron.Cron
 
 	runningJobs sync.WaitGroup
 }
 
-func (c *Controller) Start() {
+func (c *Controller) Start() error {
 	log.Info("Starting usage controller.")
 
-	c.scheduler.Schedule(c.schedule, cron.FuncJob(func() {
+	err := c.scheduler.AddFunc(fmt.Sprintf("@every %s", c.schedule.String()), cron.FuncJob(func() {
 		log.Info("Starting usage reconciliation.")
 
 		c.runningJobs.Add(1)
@@ -50,8 +45,13 @@ func (c *Controller) Start() {
 			log.Info("Completed usage reconciliation run without errors.")
 		}
 	}))
+	if err != nil {
+		return fmt.Errorf("failed to add function to scheduler: %w", err)
+	}
 
 	c.scheduler.Start()
+
+	return nil
 }
 
 // Stop terminates the Controller and awaits for all running jobs to complete.

components/usage/pkg/controller/controller_test.go

@@ -0,0 +1,37 @@
+// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License-AGPL.txt in the project root for license information.
+
+package controller
+
+import (
+	"github.com/stretchr/testify/require"
+	"testing"
+	"time"
+)
+
+func TestController(t *testing.T) {
+	schedule := time.Second
+	triggered := false
+
+	ctrl, err := New(schedule, ReconcilerFunc(func() error {
+		triggered = true
+		return nil
+	}))
+	require.NoError(t, err)
+
+	require.NoError(t, ctrl.Start())
+	time.Sleep(schedule + 20*time.Millisecond)
+	require.True(t, triggered, "must trigger reconciler function")
+	ctrl.Stop()
+}
+
+func TestController_GracefullyHandlesPanic(t *testing.T) {
+	ctrl, err := New(20*time.Millisecond, ReconcilerFunc(func() error {
+		panic("pls help")
+	}))
+	require.NoError(t, err)
+
+	require.NoError(t, ctrl.Start())
+	ctrl.Stop()
+}