From 436a439ed2aa8a1dfd36555b4cbaf22019619314 Mon Sep 17 00:00:00 2001
From: Owen Williams <owen.williams@grafana.com>
Date: Fri, 23 Aug 2024 14:13:41 -0400
Subject: [PATCH] fix(utf8): fix config logic for name validation

We should only overwrite the ScrapeConfig if it is empty.

Added tests

part of https://github.com/prometheus/prometheus/issues/13095

Signed-off-by: Owen Williams <owen.williams@grafana.com>
---
 config/config.go                              |  4 +-
 config/config_test.go                         | 50 +++++++++++++++++++
 .../scrape_config_default_validation_mode.yml |  2 +
 .../scrape_config_global_validation_mode.yml  |  4 ++
 ...pe_config_local_global_validation_mode.yml |  5 ++
 .../scrape_config_local_validation_mode.yml   |  3 ++
 6 files changed, 67 insertions(+), 1 deletion(-)
 create mode 100644 config/testdata/scrape_config_default_validation_mode.yml
 create mode 100644 config/testdata/scrape_config_global_validation_mode.yml
 create mode 100644 config/testdata/scrape_config_local_global_validation_mode.yml
 create mode 100644 config/testdata/scrape_config_local_validation_mode.yml

diff --git a/config/config.go b/config/config.go
index 4326b0a99..d1e463d86 100644
--- a/config/config.go
+++ b/config/config.go
@@ -781,7 +781,9 @@ func (c *ScrapeConfig) Validate(globalConfig GlobalConfig) error {
 	default:
 		return fmt.Errorf("unknown name validation method specified, must be either 'legacy' or 'utf8', got %s", globalConfig.MetricNameValidationScheme)
 	}
-	c.MetricNameValidationScheme = globalConfig.MetricNameValidationScheme
+	if c.MetricNameValidationScheme == "" {
+		c.MetricNameValidationScheme = globalConfig.MetricNameValidationScheme
+	}
 
 	return nil
 }
diff --git a/config/config_test.go b/config/config_test.go
index 9b074bef1..774aba1e2 100644
--- a/config/config_test.go
+++ b/config/config_test.go
@@ -16,6 +16,7 @@ package config
 import (
 	"crypto/tls"
 	"encoding/json"
+	"fmt"
 	"net/url"
 	"os"
 	"path/filepath"
@@ -2300,3 +2301,52 @@ func TestScrapeConfigDisableCompression(t *testing.T) {
 
 	require.False(t, got.ScrapeConfigs[0].EnableCompression)
 }
+
+func TestScrapeConfigNameValidationSettings(t *testing.T) {
+	model.NameValidationScheme = model.UTF8Validation
+	defer func() {
+		model.NameValidationScheme = model.LegacyValidation
+	}()
+
+	tests := []struct {
+		name         string
+		inputFile    string
+		expectScheme string
+	}{
+		{
+			name:         "blank config implies default",
+			inputFile:    "scrape_config_default_validation_mode",
+			expectScheme: "",
+		},
+		{
+			name:         "global setting implies local settings",
+			inputFile:    "scrape_config_global_validation_mode",
+			expectScheme: "utf8",
+		},
+		{
+			name:         "local setting",
+			inputFile:    "scrape_config_local_validation_mode",
+			expectScheme: "utf8",
+		},
+		{
+			name:         "local setting overrides global setting",
+			inputFile:    "scrape_config_local_global_validation_mode",
+			expectScheme: "legacy",
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			want, err := LoadFile(fmt.Sprintf("testdata/%s.yml", tc.inputFile), false, false, log.NewNopLogger())
+			require.NoError(t, err)
+
+			out, err := yaml.Marshal(want)
+
+			require.NoError(t, err)
+			got := &Config{}
+			require.NoError(t, yaml.UnmarshalStrict(out, got))
+
+			require.Equal(t, tc.expectScheme, got.ScrapeConfigs[0].MetricNameValidationScheme)
+		})
+	}
+}
diff --git a/config/testdata/scrape_config_default_validation_mode.yml b/config/testdata/scrape_config_default_validation_mode.yml
new file mode 100644
index 000000000..96680d643
--- /dev/null
+++ b/config/testdata/scrape_config_default_validation_mode.yml
@@ -0,0 +1,2 @@
+scrape_configs:
+  - job_name: prometheus
diff --git a/config/testdata/scrape_config_global_validation_mode.yml b/config/testdata/scrape_config_global_validation_mode.yml
new file mode 100644
index 000000000..154855439
--- /dev/null
+++ b/config/testdata/scrape_config_global_validation_mode.yml
@@ -0,0 +1,4 @@
+global:
+  metric_name_validation_scheme: utf8
+scrape_configs:
+  - job_name: prometheus
diff --git a/config/testdata/scrape_config_local_global_validation_mode.yml b/config/testdata/scrape_config_local_global_validation_mode.yml
new file mode 100644
index 000000000..d13605e21
--- /dev/null
+++ b/config/testdata/scrape_config_local_global_validation_mode.yml
@@ -0,0 +1,5 @@
+global:
+  metric_name_validation_scheme: utf8
+scrape_configs:
+  - job_name: prometheus
+    metric_name_validation_scheme: legacy
diff --git a/config/testdata/scrape_config_local_validation_mode.yml b/config/testdata/scrape_config_local_validation_mode.yml
new file mode 100644
index 000000000..fad423580
--- /dev/null
+++ b/config/testdata/scrape_config_local_validation_mode.yml
@@ -0,0 +1,3 @@
+scrape_configs:
+  - job_name: prometheus
+    metric_name_validation_scheme: utf8