base 3 commit

.github/workflows/observability.yml

@@ -21,7 +21,7 @@ jobs:
           go-version-file: "go.mod"
 
       - name: Build
-        run: go build -v ./...
+        run: make build
 
       - name: Unit Tests
-        run: go test -v ./...
+        run: make test

observability-lib/Makefile

@@ -12,4 +12,8 @@ lint:
 
 .PHONY: test
 test:
-	go test -v ./...
+	go test ./...
+
+.PHONY: update
+update:
+	go test ./dashboards/... -update=1

observability-lib/dashboards/atlas-don/component.go

@@ -31,6 +31,9 @@ func NewDashboard(props *Props) (*grafana.Dashboard, error) {
 	}
 
 	props.platformOpts = platformPanelOpts(props.OCRVersion)
+	if props.Tested {
+		props.platformOpts.LabelQuery = ""
+	}
 
 	builder := grafana.NewBuilder(&grafana.BuilderOptions{
 		Name:     props.Name,

observability-lib/dashboards/atlas-don/component_test.go

@@ -1,6 +1,7 @@
 package atlasdon_test
 
 import (
+	"flag"
 	"os"
 	"testing"
 
@@ -11,12 +12,54 @@ import (
 	atlasdon "github.com/goplugin/plugin-common/observability-lib/dashboards/atlas-don"
 )
 
+var update = flag.Bool("update", false, "update golden test files")
+
+const fileOutput = "test-output.json"
+
+func TestGenerateFile(t *testing.T) {
+	if *update == false {
+		t.Skip("skipping test")
+	}
+
+	testDashboard, err := atlasdon.NewDashboard(&atlasdon.Props{
+		Name:              "DON OCR Dashboard",
+		MetricsDataSource: grafana.NewDataSource("Prometheus", "1"),
+		OCRVersion:        "ocr2",
+		Tested:            true,
+	})
+	if err != nil {
+		t.Errorf("Error creating dashboard: %v", err)
+	}
+	json, errJSON := testDashboard.GenerateJSON()
+	if errJSON != nil {
+		t.Errorf("Error generating JSON: %v", errJSON)
+	}
+	if _, errExists := os.Stat(fileOutput); errExists == nil {
+		errRemove := os.Remove(fileOutput)
+		if errRemove != nil {
+			t.Errorf("Error removing file: %v", errRemove)
+		}
+	}
+	file, errFile := os.Create(fileOutput)
+	if errFile != nil {
+		panic(errFile)
+	}
+	writeString, err := file.WriteString(string(json))
+	if err != nil {
+		t.Errorf("Error writing to file: %v", writeString)
+	}
+	t.Cleanup(func() {
+		file.Close()
+	})
+}
+
 func TestNewDashboard(t *testing.T) {
 	t.Run("NewDashboard creates a dashboard", func(t *testing.T) {
 		testDashboard, err := atlasdon.NewDashboard(&atlasdon.Props{
 			Name:              "DON OCR Dashboard",
 			MetricsDataSource: grafana.NewDataSource("Prometheus", "1"),
 			OCRVersion:        "ocr2",
+			Tested:            true,
 		})
 		if err != nil {
 			t.Errorf("Error creating dashboard: %v", err)
@@ -28,11 +71,11 @@ func TestNewDashboard(t *testing.T) {
 			t.Errorf("Error generating JSON: %v", errJSON)
 		}
 
-		jsonCompared, errCompared := os.ReadFile("test-output.json")
+		jsonCompared, errCompared := os.ReadFile(fileOutput)
 		if errCompared != nil {
 			t.Errorf("Error reading file: %v", errCompared)
 		}
 
-		require.ElementsMatch(t, jsonCompared, json)
+		require.JSONEq(t, string(jsonCompared), string(json))
 	})
 }

observability-lib/dashboards/atlas-don/platform.go

@@ -16,6 +16,7 @@ type Props struct {
 	MetricsDataSource *grafana.DataSource // MetricsDataSource is the datasource for querying metrics
 	OCRVersion        string              // OCRVersion is the version of the OCR (ocr, ocr2, ocr3)
 	platformOpts      platformOpts
+	Tested            bool
 }
 
 // PlatformPanelOpts generate different queries depending on params