Add tests for user metadata in the ingester

pkg/ingester/user_metrics_metadata_test.go

@@ -0,0 +1,113 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+
+package ingester
+
+import (
+	"testing"
+	"time"
+
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/grafana/mimir/pkg/mimirpb"
+	"github.com/grafana/mimir/pkg/util/validation"
+)
+
+func TestUserMetricsMetadata(t *testing.T) {
+	tests := map[string]struct {
+		maxMetadataPerUser    int
+		maxMetadataPerMetric  int
+		metadataToExpectError map[*mimirpb.MetricMetadata]bool
+		expectedMetadata      []*mimirpb.MetricMetadata
+	}{
+		"should succeed for multiple metadata per metric": {
+			metadataToExpectError: map[*mimirpb.MetricMetadata]bool{
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_1", Help: "foo"}: false,
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_1", Help: "bar"}: false,
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_2", Help: "baz"}: false,
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_2", Help: "qux"}: false,
+			},
+			expectedMetadata: []*mimirpb.MetricMetadata{
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_1", Help: "foo"},
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_1", Help: "bar"},
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_2", Help: "baz"},
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_2", Help: "qux"},
+			},
+		},
+		"should fail when metadata per user limit reached": {
+			maxMetadataPerUser: 1,
+			metadataToExpectError: map[*mimirpb.MetricMetadata]bool{
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_1", Help: "foo"}: false,
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_1", Help: "bar"}: false,
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_2", Help: "baz"}: true,
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_2", Help: "qux"}: true,
+			},
+			expectedMetadata: []*mimirpb.MetricMetadata{
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_1", Help: "foo"},
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_1", Help: "bar"},
+			},
+		},
+		"should fail when metadata per metric limit reached": {
+			maxMetadataPerMetric: 1,
+			metadataToExpectError: map[*mimirpb.MetricMetadata]bool{
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_1", Help: "foo"}: false,
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_1", Help: "bar"}: true,
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_2", Help: "baz"}: false,
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_2", Help: "qux"}: true,
+			},
+			expectedMetadata: []*mimirpb.MetricMetadata{
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_1", Help: "foo"},
+				{Type: mimirpb.COUNTER, MetricFamilyName: "test_metric_2", Help: "baz"},
+			},
+		},
+	}
+
+	for testName, testData := range tests {
+		t.Run(testName, func(t *testing.T) {
+			// Mock the ring
+			ring := &ringCountMock{}
+			ring.On("HealthyInstancesCount").Return(1)
+			ring.On("ZonesCount").Return(1)
+
+			// Mock limiter
+			limits, err := validation.NewOverrides(validation.Limits{
+				MaxGlobalMetricsWithMetadataPerUser: testData.maxMetadataPerUser,
+				MaxGlobalMetadataPerMetric:          testData.maxMetadataPerMetric,
+			}, nil)
+			require.NoError(t, err)
+			limiter := NewLimiter(limits, ring, 1, false)
+
+			// Mock metrics
+			metrics := newIngesterMetrics(
+				prometheus.NewPedanticRegistry(),
+				true,
+				func() *InstanceLimits { return defaultInstanceLimits },
+				nil,
+				nil,
+			)
+
+			mm := newMetadataMap(limiter, metrics, "test")
+
+			// Attempt to add all metadata
+			for meta, expectErr := range testData.metadataToExpectError {
+				err := mm.add(meta.MetricFamilyName, meta)
+
+				if expectErr {
+					require.Error(t, err)
+				}
+			}
+
+			// Verify expected elements are stored
+			clientMeta := mm.toClientMetadata()
+			assert.ElementsMatch(t, testData.expectedMetadata, clientMeta)
+
+			// Purge all metadata
+			mm.purge(time.Time{})
+
+			// Verify all metadata purged
+			clientMeta = mm.toClientMetadata()
+			assert.Empty(t, clientMeta)
+		})
+	}
+}