grafana/pkg/services/searchV2/object/dashboard_test.go

package object

import (
	"bytes"
	"encoding/json"
	"os"
	"path/filepath"
	"strings"
	"testing"

	"github.com/grafana/grafana/pkg/services/searchV2/dslookup"
	"github.com/grafana/grafana/pkg/services/store/object"
	"github.com/stretchr/testify/require"
)

func dsLookup() dslookup.DatasourceLookup {
	return dslookup.CreateDatasourceLookup([]*dslookup.DatasourceQueryResult{
		{
			UID:       "P8045C56BDA891CB2",
			Type:      "cloudwatch",
			Name:      "cloudwatch-name",
			IsDefault: false,
		},
		{
			UID:       "default.uid",
			Type:      "default.type",
			Name:      "default.name",
			IsDefault: true,
		},
	})
}

func TestReadSummaries(t *testing.T) {
	devdash := "../../../../devenv/dev-dashboards/panel-graph/"

	reader := NewDashboardSummaryBuilder(dsLookup())
	failed := make([]string, 0, 10)

	err := filepath.Walk(devdash,
		func(path string, info os.FileInfo, err error) error {
			if err != nil {
				return err
			}

			if !info.IsDir() && strings.HasSuffix(path, ".json") {
				// Ignore gosec warning G304 since it's a test
				// nolint:gosec
				body, err := os.ReadFile(path)
				if err != nil {
					return err
				}

				uid := path[len(devdash):]
				summary, err := reader(&object.RawObject{
					UID:  uid,
					Body: body,
				})
				if err != nil {
					return err
				}

				out, err := json.MarshalIndent(summary, "", "  ")
				if err != nil {
					return err
				}

				gpath := "testdata/gdev-walk-" + strings.ReplaceAll(uid, "/", "-")

				// Ignore gosec warning G304 since it's a test
				// nolint:gosec
				golden, _ := os.ReadFile(gpath)

				if !bytes.Equal(out, golden) {
					failed = append(failed, uid)
					err = os.WriteFile(gpath, out, 0600)
					if err != nil {
						return err
					}
				}
			}
			return nil
		})
	require.NoError(t, err)

	// accumulated in the walk test
	require.Equal(t, []string{}, failed)
}