chore(test): added first tests for usage module

Author: n3rdc4ptn

Taskfile.yaml

@@ -14,3 +14,4 @@ includes:
       REPO_URL: "https://github.com/openmcp-project/usage-operator"
       GENERATE_DOCS_INDEX: "true"
       CHART_COMPONENTS: "[]"
+      ENVTEST_REQUIRED: "true"

internal/usage/db_test.go

@@ -0,0 +1,77 @@
+package usage
+
+import (
+	"os"
+	"slices"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	"github.com/openmcp-project/controller-utils/pkg/logging"
+
+	k8s "sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+var _ = Describe("Database Module", func() {
+	BeforeEach(func() {
+		os.Setenv("USAGE_DB_PATH", "")
+	})
+	Context("When getting the Database", func() {
+		It("should return a database entity", func() {
+			_, err := GetDB()
+			Ω(err).Should(Succeed())
+		})
+	})
+	Context("When initializing the database", func() {
+		It("should successfully initialize the database correctly", func(ctx SpecContext) {
+			log, err := logging.GetLogger()
+			Ω(err).Should(Succeed())
+
+			err = InitDB(ctx, &log)
+			Ω(err).Should(Succeed())
+		})
+		It("should have created the tables correctly", func(ctx SpecContext) {
+			db, err := GetDB()
+			Ω(err).Should(Succeed())
+
+			query := "SELECT distinct(table_name) FROM information_schema.tables"
+			rows, err := db.Query(query)
+			Ω(err).Should(Succeed())
+
+			expectedTables := []string{"hourly_usage", "mcp"}
+			for rows.Next() {
+				var tableName string
+				err = rows.Scan(&tableName)
+				Ω(err).Should(Succeed())
+
+				Ω(len(expectedTables)).ShouldNot(Equal(0))
+				expectedTables = slices.DeleteFunc(expectedTables, func(expected string) bool {
+					return expected == tableName
+				})
+			}
+
+			err = db.Close()
+			Ω(err).Should(Succeed())
+		})
+
+	})
+
+	var resourceEntry HourlyUsageEntry
+	var expectedResourceName = "test-project-test-workspace-test-mcp"
+	Context("Database Entities", Ordered, func() {
+		BeforeAll(func() {
+			resourceEntry = HourlyUsageEntry{
+				Project:   "test-project",
+				Workspace: "test-workspace",
+				Name:      "test-mcp",
+			}
+		})
+		It("should return the correct ResourceName", func() {
+			Ω(resourceEntry.ResourceName()).Should(Equal(expectedResourceName))
+		})
+		It("should return the correct ObjectKey", func() {
+			Ω(resourceEntry.ObjectKey()).Should(Equal(k8s.ObjectKey{
+				Name: expectedResourceName,
+			}))
+		})
+	})
+})

internal/usage/helper.go

@@ -10,6 +10,8 @@ type usagePerDay struct {
 const DAY = 24 * time.Hour
 
 func calculateUsage(start time.Time, end time.Time) (result []usagePerDay) {
+	start = start.UTC()
+	end = end.UTC()
 	duration := start.Sub(end).Abs()
 	return _calculateUsage(start, end, duration)
 }

internal/usage/helper_test.go

@@ -0,0 +1,56 @@
+package usage
+
+import (
+	"fmt"
+	"time"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("Helper Module", func() {
+	Context("Usage calculation", func() {
+		It("should calculate the usage for a 1 week span", func() {
+			firstDayDuration := 23*time.Hour + 59*time.Minute + 59*time.Second
+
+			end := time.Now().UTC()
+			endDate := end.Truncate(24 * time.Hour)
+			end = endDate.Add(firstDayDuration)
+
+			start := end.Add(-7 * 24 * time.Hour)
+			start = start.Truncate(24 * time.Hour)
+
+			result := calculateUsage(start, end)
+
+			Ω(len(result)).Should(Equal(8))
+
+			Ω(result[0].date.Equal(endDate)).Should(Equal(true), "first date must equal end date")
+			Ω(result[0].duration).Should(Equal(firstDayDuration), "first day must have the right duration")
+			for _, usage := range result[1:] {
+				Ω(usage.duration).Should(Equal(24 * time.Hour))
+			}
+		})
+
+		It("reversed: should calculate the usage for a 1 week span", func() {
+			firstDayDuration := 23*time.Hour + 59*time.Minute + 59*time.Second
+
+			end := time.Now().UTC()
+			endDate := end.Truncate(24 * time.Hour)
+			end = endDate.Add(firstDayDuration)
+
+			start := end.Add(-7 * 24 * time.Hour)
+			start = start.Truncate(24 * time.Hour)
+
+			result := calculateUsage(end, start)
+
+			Ω(len(result)).Should(Equal(8))
+
+			Ω(result[0].date.Equal(endDate)).Should(Equal(true), "first date must equal end date")
+			Ω(result[0].duration).Should(Equal(firstDayDuration), "first day must have the right duration")
+			for _, usage := range result[1:] {
+				fmt.Println(usage.date, usage.duration)
+				Ω(usage.duration).Should(Equal(24 * time.Hour))
+			}
+		})
+	})
+})

internal/usage/suite_test.go

@@ -0,0 +1,34 @@
+package usage
+
+import (
+	"context"
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	logf "sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/log/zap"
+)
+
+var (
+	ctx    context.Context
+	cancel context.CancelFunc
+)
+
+func TestUsageModule(t *testing.T) {
+	RegisterFailHandler(Fail)
+
+	RunSpecs(t, "Usage Module")
+}
+
+var _ = BeforeSuite(func() {
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
+
+	ctx, cancel = context.WithCancel(context.TODO())
+
+})
+
+var _ = AfterSuite(func() {
+	cancel()
+})