compose Reporter interface of smaller ones

Author: Tofel

wasp/benchspy/loki.go

@@ -14,16 +14,16 @@ import (
 	"golang.org/x/sync/errgroup"
 )
 
-func NewLokiQuery(queries map[string]string, lokiConfig *wasp.LokiConfig) *LokiQuery {
-	return &LokiQuery{
+func NewLokiQueryExecutor(queries map[string]string, lokiConfig *wasp.LokiConfig) *LokiQueryExecutor {
+	return &LokiQueryExecutor{
 		Kind:         "loki",
 		Queries:      queries,
 		LokiConfig:   lokiConfig,
 		QueryResults: make(map[string][]string),
 	}
 }
 
-type LokiQuery struct {
+type LokiQueryExecutor struct {
 	Kind string `json:"kind"`
 	// Test metrics
 	StartTime time.Time `json:"start_time"`
@@ -35,27 +35,27 @@ type LokiQuery struct {
 	// Performance queries results
 	// can be anything, avg RPS, amount of errors, 95th percentile of CPU utilization, etc
 	QueryResults map[string][]string `json:"query_results"`
-	// In case something went wrong
+	// In case something went wrong, but sure we need it
 	Errors []error `json:"errors"`
 
 	LokiConfig *wasp.LokiConfig `json:"-"`
 }
 
-func (l *LokiQuery) Results() map[string][]string {
+func (l *LokiQueryExecutor) Results() map[string][]string {
 	return l.QueryResults
 }
 
-func (l *LokiQuery) IsComparable(otherQueryExecutor QueryExecutor) error {
+func (l *LokiQueryExecutor) IsComparable(otherQueryExecutor QueryExecutor) error {
 	otherType := reflect.TypeOf(otherQueryExecutor)
 
 	if otherType != reflect.TypeOf(l) {
 		return fmt.Errorf("expected type %s, got %s", reflect.TypeOf(l), otherType)
 	}
 
-	return l.compareLokiQueries(otherQueryExecutor.(*LokiQuery).Queries)
+	return l.compareLokiQueries(otherQueryExecutor.(*LokiQueryExecutor).Queries)
 }
 
-func (l *LokiQuery) Validate() error {
+func (l *LokiQueryExecutor) Validate() error {
 	if len(l.Queries) == 0 {
 		return errors.New("there are no Loki queries, there's nothing to fetch. Please set them and try again")
 	}
@@ -66,7 +66,7 @@ func (l *LokiQuery) Validate() error {
 	return nil
 }
 
-func (l *LokiQuery) Execute(ctx context.Context) error {
+func (l *LokiQueryExecutor) Execute(ctx context.Context) error {
 	splitAuth := strings.Split(l.LokiConfig.BasicAuth, ":")
 	var basicAuth client.LokiBasicAuth
 	if len(splitAuth) == 2 {
@@ -130,7 +130,7 @@ func (l *LokiQuery) Execute(ctx context.Context) error {
 	return nil
 }
 
-func (l *LokiQuery) compareLokiQueries(other map[string]string) error {
+func (l *LokiQueryExecutor) compareLokiQueries(other map[string]string) error {
 	this := l.Queries
 	if len(this) != len(other) {
 		return fmt.Errorf("queries count is different. Expected %d, got %d", len(this), len(other))
@@ -155,7 +155,7 @@ func (l *LokiQuery) compareLokiQueries(other map[string]string) error {
 	return nil
 }
 
-func (l *LokiQuery) TimeRange(start, end time.Time) {
+func (l *LokiQueryExecutor) TimeRange(start, end time.Time) {
 	l.StartTime = start
 	l.EndTime = end
 }

wasp/benchspy/report.go

@@ -11,17 +11,17 @@ import (
 // StandardReport is a report that contains all the necessary data for a performance test
 type StandardReport struct {
 	BasicData
-	LocalReportStorage
+	LocalStorage
 	ResourceReporter
 	QueryExecutors []QueryExecutor `json:"query_executors"`
 }
 
 func (b *StandardReport) Store() (string, error) {
-	return b.LocalReportStorage.Store(b.TestName, b.CommitOrTag, b)
+	return b.LocalStorage.Store(b.TestName, b.CommitOrTag, b)
 }
 
 func (b *StandardReport) Load() error {
-	return b.LocalReportStorage.Load(b.TestName, b.CommitOrTag, b)
+	return b.LocalStorage.Load(b.TestName, b.CommitOrTag, b)
 }
 
 func (b *StandardReport) Fetch(ctx context.Context) error {
@@ -107,7 +107,7 @@ func (s *StandardReport) UnmarshalJSON(data []byte) error {
 		var executor QueryExecutor
 		switch typeIndicator.Kind {
 		case "loki":
-			executor = &LokiQuery{}
+			executor = &LokiQueryExecutor{}
 		default:
 			return fmt.Errorf("unknown query executor type: %s", typeIndicator.Kind)
 		}

wasp/benchspy/storage.go

@@ -16,17 +16,17 @@ import (
 
 const DEFAULT_DIRECTORY = "performance_reports"
 
-type LocalReportStorage struct {
+type LocalStorage struct {
 	Directory string `json:"directory"`
 }
 
-func (l *LocalReportStorage) defaultDirectoryIfEmpty() {
+func (l *LocalStorage) defaultDirectoryIfEmpty() {
 	if l.Directory == "" {
 		l.Directory = DEFAULT_DIRECTORY
 	}
 }
 
-func (l *LocalReportStorage) Store(testName, commitOrTag string, report interface{}) (string, error) {
+func (l *LocalStorage) Store(testName, commitOrTag string, report interface{}) (string, error) {
 	l.defaultDirectoryIfEmpty()
 	asJson, err := json.MarshalIndent(report, "", " ")
 	if err != nil {
@@ -60,7 +60,7 @@ func (l *LocalReportStorage) Store(testName, commitOrTag string, report interfac
 	return abs, nil
 }
 
-func (l *LocalReportStorage) Load(testName, commitOrTag string, report interface{}) error {
+func (l *LocalStorage) Load(testName, commitOrTag string, report interface{}) error {
 	l.defaultDirectoryIfEmpty()
 	if testName == "" {
 		return errors.New("test name is empty. Please set it and try again")

wasp/benchspy/types.go

@@ -5,15 +5,27 @@ import (
 	"time"
 )
 
-type Report interface {
+type Storer interface {
 	// Store stores the report in a persistent storage and returns the path to it, or an error
 	Store() (string, error)
 	// Load loads the report from a persistent storage and returns it, or an error
 	Load() error
+}
+
+type Fetcher interface {
 	// Fetch populates the report with the data from the test
 	Fetch() error
+}
+
+type Comparator interface {
 	// IsComparable checks whether both reports can be compared (e.g. test config is the same, app's resources are the same, queries or metrics used are the same, etc.), and an error if any difference is found
-	IsComparable(otherReport Report) error
+	IsComparable(otherReport Reporter) error
+}
+
+type Reporter interface {
+	Storer
+	Fetcher
+	Comparator
 }
 
 type QueryExecutor interface {

wasp/benchspy_test.go

@@ -52,7 +52,7 @@ func TestBenchSpyWithLokiQuery(t *testing.T) {
 		},
 	}
 
-	lokiQueryExecutor := benchspy.NewLokiQuery(
+	lokiQueryExecutor := benchspy.NewLokiQueryExecutor(
 		map[string]string{
 			"vu_over_time": fmt.Sprintf("max_over_time({branch=~\"%s\", commit=~\"%s\", go_test_name=~\"%s\", test_data_type=~\"stats\", gen_name=~\"%s\"} | json | unwrap current_instances [10s]) by (node_id, go_test_name, gen_name)", label, label, t.Name(), gen.Cfg.GenName),
 		},
@@ -77,7 +77,7 @@ func TestBenchSpyWithLokiQuery(t *testing.T) {
 			TestName:    t.Name(),
 			CommitOrTag: "e7fc5826a572c09f8b93df3b9f674113372ce924",
 		},
-		LocalReportStorage: benchspy.LocalReportStorage{
+		LocalStorage: benchspy.LocalStorage{
 			Directory: "test_performance_reports",
 		},
 	}
@@ -154,7 +154,7 @@ func TestBenchSpyWithTwoLokiQueries(t *testing.T) {
 		},
 	}
 
-	lokiQueryExecutor := benchspy.NewLokiQuery(
+	lokiQueryExecutor := benchspy.NewLokiQueryExecutor(
 		map[string]string{
 			"vu_over_time":        fmt.Sprintf("max_over_time({branch=~\"%s\", commit=~\"%s\", go_test_name=~\"%s\", test_data_type=~\"stats\", gen_name=~\"%s\"} | json | unwrap current_instances [10s]) by (node_id, go_test_name, gen_name)", label, label, t.Name(), gen.Cfg.GenName),
 			"responses_over_time": fmt.Sprintf("sum(count_over_time({branch=~\"%s\", commit=~\"%s\", go_test_name=~\"%s\", test_data_type=~\"responses\", gen_name=~\"%s\"} [1s])) by (node_id, go_test_name, gen_name)", label, label, t.Name(), gen.Cfg.GenName),
@@ -180,7 +180,7 @@ func TestBenchSpyWithTwoLokiQueries(t *testing.T) {
 			TestName:    t.Name(),
 			CommitOrTag: "e7fc5826a572c09f8b93df3b9f674113372ce924",
 		},
-		LocalReportStorage: benchspy.LocalReportStorage{
+		LocalStorage: benchspy.LocalStorage{
 			Directory: "test_performance_reports",
 		},
 	}