Unit test

mtojek · mtojek · commit 157cbe13813f · 2023-10-10T14:15:35.000+02:00
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -345,7 +345,6 @@ func New(options *Options) *API {
 	}
 
 	licenseMetrics, err := prometheusmetrics.NewLicenseMetrics(&prometheusmetrics.LicenseMetricsOptions{
-		Database: options.Database,
 		Logger:   options.Logger,
 		Registry: options.PrometheusRegistry,
 	})
diff --git a/coderd/prometheusmetrics/license.go b/coderd/prometheusmetrics/license.go
@@ -7,16 +7,13 @@ import (
 	"time"
 
 	"github.com/prometheus/client_golang/prometheus"
-	"golang.org/x/xerrors"
 
 	"cdr.dev/slog"
 
-	"github.com/coder/coder/v2/coderd/database"
 	"github.com/coder/coder/v2/codersdk"
 )
 
 type LicenseMetrics struct {
-	db       database.Store
 	interval time.Duration
 	logger   slog.Logger
 	registry *prometheus.Registry
@@ -26,7 +23,6 @@ type LicenseMetrics struct {
 
 type LicenseMetricsOptions struct {
 	Interval time.Duration
-	Database database.Store
 	Logger   slog.Logger
 	Registry *prometheus.Registry
 }
@@ -35,15 +31,11 @@ func NewLicenseMetrics(opts *LicenseMetricsOptions) (*LicenseMetrics, error) {
 	if opts.Interval == 0 {
 		opts.Interval = 1 * time.Minute
 	}
-	if opts.Database == nil {
-		return nil, xerrors.Errorf("database is required")
-	}
 	if opts.Registry == nil {
 		opts.Registry = prometheus.NewRegistry()
 	}
 
 	return &LicenseMetrics{
-		db:       opts.Database,
 		interval: opts.Interval,
 		logger:   opts.Logger,
 		registry: opts.Registry,
diff --git a/coderd/prometheusmetrics/license_test.go b/coderd/prometheusmetrics/license_test.go
@@ -0,0 +1,87 @@
+package prometheusmetrics
+
+import (
+	"context"
+	"encoding/json"
+	"os"
+	"reflect"
+	"testing"
+	"time"
+
+	"github.com/aws/smithy-go/ptr"
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"cdr.dev/slog"
+	"cdr.dev/slog/sloggers/slogtest"
+	"github.com/coder/coder/v2/codersdk"
+	"github.com/coder/coder/v2/testutil"
+)
+
+func TestCollectLicenseMetrics(t *testing.T) {
+	t.Parallel()
+
+	// Given
+	registry := prometheus.NewRegistry()
+	sut, err := NewLicenseMetrics(&LicenseMetricsOptions{
+		Interval: time.Millisecond,
+		Logger:   slogtest.Make(t, nil).Leveled(slog.LevelDebug),
+		Registry: registry,
+	})
+	require.NoError(t, err)
+
+	ctx, cancelFunc := context.WithCancel(context.Background())
+	t.Cleanup(cancelFunc)
+
+	const (
+		actualUsers = 4
+		userLimit   = 7
+	)
+	sut.Entitlements.Store(&codersdk.Entitlements{
+		Features: map[codersdk.FeatureName]codersdk.Feature{
+			codersdk.FeatureUserLimit: {
+				Enabled: true,
+				Actual:  ptr.Int64(actualUsers),
+				Limit:   ptr.Int64(userLimit),
+			},
+		},
+	})
+
+	// When
+	closeFunc, err := sut.Collect(ctx)
+	require.NoError(t, err)
+	t.Cleanup(closeFunc)
+
+	// Then
+	goldenFile, err := os.ReadFile("testdata/license-metrics.json")
+	require.NoError(t, err)
+	golden := map[string]int{}
+	err = json.Unmarshal(goldenFile, &golden)
+	require.NoError(t, err)
+
+	collected := map[string]int{}
+
+	assert.Eventually(t, func() bool {
+		metrics, err := registry.Gather()
+		assert.NoError(t, err)
+
+		if len(metrics) < 1 {
+			return false
+		}
+
+		for _, metric := range metrics {
+			switch metric.GetName() {
+			case "coderd_license_active_users", "coderd_license_user_limit":
+				for _, m := range metric.Metric {
+					collected[m.Label[0].GetValue()+":"+metric.GetName()] = int(m.Gauge.GetValue())
+				}
+			default:
+				require.FailNowf(t, "unexpected metric collected", "metric: %s", metric.GetName())
+			}
+		}
+		return reflect.DeepEqual(golden, collected)
+	}, testutil.WaitShort, testutil.IntervalFast)
+
+	assert.EqualValues(t, golden, collected)
+}
diff --git a/coderd/prometheusmetrics/testdata/license-metrics.json b/coderd/prometheusmetrics/testdata/license-metrics.json
@@ -0,0 +1,4 @@
+{
+  "true:coderd_license_active_users": 4,
+  "true:coderd_license_user_limit": 7
+}

Original file line number	Diff line number	Diff line change
`@@ -345,7 +345,6 @@ func New(options Options) API {`
`345`	`345`	`}`
`346`	`346`
`347`	`347`	`licenseMetrics, err := prometheusmetrics.NewLicenseMetrics(&prometheusmetrics.LicenseMetricsOptions{`
`348`		`- Database: options.Database,`
`349`	`348`	`Logger: options.Logger,`
`350`	`349`	`Registry: options.PrometheusRegistry,`
`351`	`350`	`})`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "true:coderd_license_active_users": 4,
 +  "true:coderd_license_user_limit": 7
 +}