refactor: remove unnecessary abstraction

Author: clambin

Diff for: go.mod

@@ -10,7 +10,7 @@ require (
 	github.com/gosimple/slug v1.14.0
 	github.com/grafana/grafana-api-golang-client v0.27.0
 	github.com/grafana/grafana-operator/v5 v5.9.2
-	github.com/spf13/cobra v1.8.0
+	github.com/spf13/cobra v1.8.1
 	github.com/spf13/viper v1.19.0
 	github.com/stretchr/testify v1.9.0
 	gopkg.in/yaml.v3 v3.0.1
@@ -19,6 +19,7 @@ require (
 require (
 	github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 // indirect
 	github.com/blang/semver v3.5.1+incompatible // indirect
+	github.com/clambin/go-common/testutils v0.1.0 // indirect
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/fsnotify/fsnotify v1.7.0 // indirect
 	github.com/go-logr/logr v1.4.2 // indirect

Diff for: go.sum

@@ -9,6 +9,7 @@ github.com/clambin/go-common/set v0.4.3/go.mod h1:Q5GpBoM7B7abNV2Wzys+wQMInBHMoH
 github.com/clambin/go-common/testutils v0.1.0 h1:/nGWaOCIhW+Ew1c2NU7GLY/YPb8dp9SV8+MTgWksAgk=
 github.com/clambin/go-common/testutils v0.1.0/go.mod h1:bV0j8D4zhNkleCeluFKLBeLQ0L/dqkxbaR/joLn8kzg=
 github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM=
@@ -125,6 +126,8 @@ github.com/spf13/cast v1.6.0 h1:GEiTHELF+vaR5dhz3VqZfFSzZjYbgeKDpBxQVS4GYJ0=
 github.com/spf13/cast v1.6.0/go.mod h1:ancEpBxwJDODSW/UG4rDrAqiKolqNNh2DX3mk86cAdo=
 github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0=
 github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho=
+github.com/spf13/cobra v1.8.1 h1:e5/vxKd/rZsfSJMUX1agtjeTDf+qv1/JdBF8gg5k9ZM=
+github.com/spf13/cobra v1.8.1/go.mod h1:wHxEcudfqmLYa8iTfL+OuZPbBZkmvliBWKIezN3kD9Y=
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
 github.com/spf13/viper v1.19.0 h1:RWq5SEjt8o25SROyN3z2OrDB9l7RPd3lwTWU8EcEdcI=

Diff for: internal/exporter.go

@@ -33,7 +33,7 @@ func makeExporter(v *viper.Viper, l *slog.Logger) (exporter, error) {
 	return exporter{
 		logger: l,
 		client: c,
-		formatter: OperatorFormatter{
+		formatter: Formatter{
 			Namespace:         stringOrDefault(v.GetString("namespace"), "default"),
 			GrafanaLabelName:  stringOrDefault(v.GetString("grafana.operator.label.name"), "dashboards"),
 			GrafanaLabelValue: stringOrDefault(v.GetString("grafana.operator.label.value"), "grafana"),

Diff for: internal/cli_test.go renamed to internal/exporter_test.go

@@ -23,29 +23,23 @@ type Dashboard struct {
 	Model  map[string]any
 }
 
-func FetchDashboards(c DashboardClient, logger *slog.Logger, shouldExport func(dashboard gapi.FolderDashboardSearchResponse) bool) (Dashboards, error) {
+func FetchDashboards(c DashboardClient, logger *slog.Logger, shouldExport func(gapi.FolderDashboardSearchResponse) bool) (Dashboards, error) {
 	foundBoards, err := c.Dashboards()
 	if err != nil {
 		return nil, fmt.Errorf("grafana search: %w", err)
 	}
 
 	dashboards := make(Dashboards, 0, len(foundBoards))
 	for _, board := range foundBoards {
-		logger.Debug("dashboard found",
-			slog.String("title", board.Title),
-			slog.String("type", board.Type),
-			slog.String("folder", board.FolderTitle),
-		)
+		logger.Debug("dashboard found", "data", folderDashboard(board))
 
 		// Only process dashboards, not folders
 		// Only export if the dashboard meets the criteria
 		if board.Type == "dash-db" && shouldExport(board) {
-			// Get the dashboard model
 			rawBoard, err := c.DashboardByUID(board.UID)
 			if err != nil {
 				return nil, fmt.Errorf("grafana get board: %w", err)
 			}
-
 			dashboards = append(dashboards, Dashboard{
 				Folder: board.FolderTitle,
 				Title:  board.Title,
@@ -56,3 +50,14 @@ func FetchDashboards(c DashboardClient, logger *slog.Logger, shouldExport func(d
 
 	return dashboards, nil
 }
+
+var _ slog.LogValuer = folderDashboard{}
+
+type folderDashboard gapi.FolderDashboardSearchResponse
+
+func (d folderDashboard) LogValue() slog.Value {
+	return slog.GroupValue(slog.String("title", d.Title),
+		slog.String("type", d.Type),
+		slog.String("folder", d.FolderTitle),
+	)
+}

Diff for: internal/fetcher.go

@@ -0,0 +1,20 @@
+package internal
+
+import (
+	"bytes"
+	"github.com/clambin/go-common/testutils"
+	gapi "github.com/grafana/grafana-api-golang-client"
+	"github.com/stretchr/testify/assert"
+	"log/slog"
+	"testing"
+)
+
+func Test_folderDashboard_LogValue(t *testing.T) {
+	dashboard := gapi.FolderDashboardSearchResponse{FolderTitle: "folder", Title: "dashboard", Type: "db"}
+
+	var output bytes.Buffer
+	l := testutils.NewTextLogger(&output, slog.LevelInfo)
+	l.Info("dashboard found", "dashboard", folderDashboard(dashboard))
+	assert.Equal(t, `level=INFO msg="dashboard found" dashboard.title=dashboard dashboard.type=db dashboard.folder=folder
+`, output.String())
+}

Diff for: internal/fetcher_test.go

@@ -11,14 +11,7 @@ import (
 	"io"
 )
 
-type Formatter interface {
-	FormatDashboard(w io.Writer, dashboard Dashboard) error
-	FormatDataSources(w io.Writer, sources []*gapi.DataSource) error
-}
-
-var _ Formatter = OperatorFormatter{}
-
-type OperatorFormatter struct {
+type Formatter struct {
 	Namespace         string
 	GrafanaLabelName  string
 	GrafanaLabelValue string
@@ -49,7 +42,7 @@ type instanceSelector struct {
 	MatchLabels map[string]string `yaml:"matchLabels"`
 }
 
-func (o OperatorFormatter) FormatDashboard(w io.Writer, dashboard Dashboard) error {
+func (f Formatter) FormatDashboard(w io.Writer, dashboard Dashboard) error {
 	var encodedDashboard bytes.Buffer
 	jEnc := json.NewEncoder(&encodedDashboard)
 	jEnc.SetIndent("", "  ")
@@ -62,13 +55,13 @@ func (o OperatorFormatter) FormatDashboard(w io.Writer, dashboard Dashboard) err
 		Kind:       "GrafanaDashboard",
 		Metadata: metadata{
 			Name:      slug.Make(dashboard.Title),
-			Namespace: o.Namespace,
+			Namespace: f.Namespace,
 		},
 		Spec: grafanaOperatorCustomResourceSpec{
 			AllowCrossNamespaceImport: true,
 			InstanceSelector: instanceSelector{
 				MatchLabels: map[string]string{
-					o.GrafanaLabelName: o.GrafanaLabelValue,
+					f.GrafanaLabelName: f.GrafanaLabelValue,
 				},
 			},
 			Folder: dashboard.Folder,
@@ -81,19 +74,19 @@ func (o OperatorFormatter) FormatDashboard(w io.Writer, dashboard Dashboard) err
 	return yEnc.Encode(dashboardCR)
 }
 
-func (o OperatorFormatter) FormatDataSources(w io.Writer, dataSources []*gapi.DataSource) error {
+func (f Formatter) FormatDataSources(w io.Writer, dataSources []*gapi.DataSource) error {
 	for _, dataSource := range dataSources {
 		cr := grafanaOperatorCustomResource{
 			APIVersion: grafanav1beta1.GroupVersion.String(),
 			Kind:       "GrafanaDataSource",
 			Metadata: metadata{
 				Name:      "datasource-" + slug.Make(dataSource.Name),
-				Namespace: o.Namespace,
+				Namespace: f.Namespace,
 			},
 			Spec: grafanaOperatorCustomResourceSpec{
 				InstanceSelector: instanceSelector{
 					MatchLabels: map[string]string{
-						o.GrafanaLabelName: o.GrafanaLabelValue,
+						f.GrafanaLabelName: f.GrafanaLabelValue,
 					},
 				},
 				DataSource: dataSource,