metrics: update integration test for rbac creation

Author: chrischdi

pkg/metrics/generate_integration_test.go

@@ -17,9 +17,11 @@ package metrics
 
 import (
 	"bytes"
+	"fmt"
 	"io"
 	"os"
 	"path"
+	"strings"
 	"testing"
 
 	"github.com/google/go-cmp/cmp"
@@ -65,24 +67,41 @@ func Test_Generate(t *testing.T) {
 	if err := gen.Generate(generationContext); err != nil {
 		t.Error(err)
 	}
-	output := out.buf.String()
 
-	t.Log("Comparing output to testdata to check for regressions")
+	foo := out.buf.String()
+	fmt.Println("<<>>")
+	fmt.Println(foo)
+	fmt.Println("<<>>")
+	output := strings.Split(out.buf.String(), "\n---\n")
 
-	expectedFile, err := os.ReadFile(path.Clean(path.Join(cwd, "testdata", "foo-config.yaml")))
-	if err != nil {
-		t.Error(err)
+	if len(output) != 2 {
+		t.Error("Expected two output files, metrics configuration followed by rbac.")
 	}
 
-	diff := cmp.Diff(string(expectedFile), output)
-	if diff != "" {
-		t.Log("output:")
-		t.Log(output)
-		t.Log("diff:")
-		t.Log(diff)
-		t.Log("Expected output to match file `testdata/foo-config.yaml` but it does not.")
-		t.Log("If the change is intended, use `go generate ./pkg/customresourcestate/generate/generator/testdata` to regenerate the `testdata/foo-config.yaml` file.")
-		t.Error("Detected a diff between the output of the integration test and the file `testdata/foo-config.yaml`.")
+	t.Log("Comparing output to testdata to check for regressions")
+
+	for i, golden := range []string{"metrics.yaml", "rbac.yaml"} {
+		generatedRaw := strings.TrimSpace(output[i])
+
+		expectedRaw, err := os.ReadFile(path.Clean(path.Join(cwd, "testdata", golden)))
+		if err != nil {
+			t.Error(err)
+		}
+
+		// Remove leading `---` and trim newlines
+		generated := strings.TrimSpace(strings.TrimPrefix(generatedRaw, "---"))
+		expected := strings.TrimSpace(strings.TrimPrefix(string(expectedRaw), "---"))
+
+		diff := cmp.Diff(expected, generated)
+		if diff != "" {
+			t.Log("generated:")
+			t.Log(generated)
+			t.Log("diff:")
+			t.Log(diff)
+			t.Logf("Expected output to match file `testdata/%s` but it does not.", golden)
+			t.Logf("If the change is intended, use `go generate ./pkg/metrics/testdata` to regenerate the `testdata/%s` file.", golden)
+			t.Errorf("Detected a diff between the output of the integration test and the file `testdata/%s`.", golden)
+		}
 	}
 }
 

pkg/metrics/testdata/foo_types.go

@@ -19,7 +19,7 @@ limitations under the License.
 // The below marker can be used to regenerate the `foo-config.yaml` file by running
 // the following command:
 // $ go generate ./pkg/customresourcestate/generate/generator/testdata
-//go:generate sh -c "go run ../../../../../ generate ./... > foo-config.yaml"
+//go:generate sh -c "go run ../../../cmd/controller-gen metrics output:metrics:dir=. paths=./"
 //go:generate sh -c "controller-gen crd paths=./ output:stdout > foo-crd.yaml"
 
 // +groupName=bar.example.com

pkg/metrics/testdata/foo-config.yaml renamed to pkg/metrics/testdata/metrics.yaml

@@ -19,7 +19,6 @@ spec:
     metrics:
     - each:
         gauge:
-          labelFromKey: ""
           nilIsZero: false
           path:
           - metadata
@@ -30,7 +29,6 @@ spec:
       name: created
     - each:
         info:
-          labelFromKey: ""
           labelsFromPath:
             owner_is_controller:
             - controller
@@ -66,7 +64,6 @@ spec:
       name: status_condition
     - each:
         gauge:
-          labelFromKey: ""
           labelsFromPath:
             status:
             - status

pkg/metrics/testdata/rbac.yaml

@@ -0,0 +1,16 @@
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  labels:
+    kube-state-metrics/aggregate-to-manager: "true"
+  name: manager-metrics-role
+rules:
+- apiGroups:
+  - bar.example.com
+  resources:
+  - foos
+  verbs:
+  - get
+  - list
+  - watch