merge packages for common clients

Author: skudasov

.github/workflows/test.yaml

@@ -13,18 +13,18 @@ jobs:
       fail-fast: false
       matrix:
         test:
-          - path: framework
-            vm: ubuntu-latest
-            regex: TestStorageMutations
           - path: framework
             vm: ubuntu-latest
             regex: TestSmoke
-          - path: framework/prometheus
+          - path: framework
             vm: ubuntu-latest
             regex: TestPrometheus
-          - path: framework/loki
+          - path: framework
             vm: ubuntu-latest
             regex: TestLoki
+          - path: framework
+            vm: ubuntu-latest
+            regex: TestStorageMutations
           - path: wasp
             vm: ubuntu22.04-16cores-64GB # ghv-ignore!
             regex: TestSmoke

framework/grafana/grafana.go framework/grafana.goframework/grafana/grafana.go renamed to framework/grafana.go

@@ -7,13 +7,13 @@ import (
 	"github.com/go-resty/resty/v2"
 )
 
-type Client struct {
+type GrafanaClient struct {
 	resty *resty.Client
 }
 
 // NewGrafanaClient initializes a new Grafana client with the specified URL and API key.
-func NewGrafanaClient(url, bearerToken string) *Client {
-	return &Client{
+func NewGrafanaClient(url, bearerToken string) *GrafanaClient {
+	return &GrafanaClient{
 		resty: resty.New().
 			SetBaseURL(url).
 			SetHeader("Authorization", "Bearer "+bearerToken),
@@ -49,7 +49,7 @@ func A(ns, text string, dashboardUIDs []string, from, to *time.Time) Annotation
 }
 
 // Annotate adds annotation to all the dashboards, works for both single point annotation with just StartTime and for ranges with StartTime/EndTime
-func (c *Client) Annotate(annotation Annotation) ([]PostAnnotationResponse, []*resty.Response, error) {
+func (c *GrafanaClient) Annotate(annotation Annotation) ([]PostAnnotationResponse, []*resty.Response, error) {
 	var results []PostAnnotationResponse
 	var responses []*resty.Response
 

framework/grafana/grafana_test.go framework/grafana_test.goframework/grafana/grafana_test.go renamed to framework/grafana_test.go

@@ -1,4 +1,4 @@
-package loki
+package framework
 
 import (
 	"context"
@@ -8,8 +8,6 @@ import (
 	"time"
 
 	"github.com/go-resty/resty/v2"
-
-	"github.com/smartcontractkit/chainlink-testing-framework/framework"
 )
 
 // APIError is a custom error type for handling non-200 responses from the Loki API
@@ -45,8 +43,8 @@ type LogEntry struct {
 	Log       string
 }
 
-// Client represents a client to interact with Loki for querying logs
-type Client struct {
+// LokiClient represents a client to interact with Loki for querying logs
+type LokiClient struct {
 	BaseURL     string
 	TenantID    string
 	BasicAuth   BasicAuth
@@ -62,9 +60,9 @@ type QueryParams struct {
 	Limit     int
 }
 
-// NewQueryClient creates a new Loki client with the given parameters, initializes a logger, and configures Resty with debug mode
-func NewQueryClient(baseURL, tenantID string, auth BasicAuth, queryParams QueryParams) *Client {
-	framework.L.Info().
+// NewLokiQueryClient creates a new Loki client with the given parameters, initializes a logger, and configures Resty with debug mode
+func NewLokiQueryClient(baseURL, tenantID string, auth BasicAuth, queryParams QueryParams) *LokiClient {
+	L.Info().
 		Str("BaseURL", baseURL).
 		Str("TenantID", tenantID).
 		Msg("Initializing Loki Client")
@@ -75,7 +73,7 @@ func NewQueryClient(baseURL, tenantID string, auth BasicAuth, queryParams QueryP
 	restyClient := resty.New().
 		SetDebug(isDebug)
 
-	return &Client{
+	return &LokiClient{
 		BaseURL:     baseURL,
 		TenantID:    tenantID,
 		BasicAuth:   auth,
@@ -85,9 +83,9 @@ func NewQueryClient(baseURL, tenantID string, auth BasicAuth, queryParams QueryP
 }
 
 // QueryRange queries Loki logs based on the query parameters and returns the raw log entries
-func (lc *Client) QueryRange(ctx context.Context) ([]LogEntry, error) {
+func (lc *LokiClient) QueryRange(ctx context.Context) ([]LogEntry, error) {
 	// Log request details
-	framework.L.Info().
+	L.Info().
 		Str("Query", lc.QueryParams.Query).
 		Str("StartTime", lc.QueryParams.StartTime.Format(time.RFC3339Nano)).
 		Str("EndTime", lc.QueryParams.EndTime.Format(time.RFC3339Nano)).
@@ -117,7 +115,7 @@ func (lc *Client) QueryRange(ctx context.Context) ([]LogEntry, error) {
 	duration := time.Since(start)
 
 	if err != nil {
-		framework.L.Error().Err(err).Dur("duration", duration).Msg("Error querying Loki")
+		L.Error().Err(err).Dur("duration", duration).Msg("Error querying Loki")
 		return nil, err
 	}
 
@@ -127,7 +125,7 @@ func (lc *Client) QueryRange(ctx context.Context) ([]LogEntry, error) {
 		if len(bodySnippet) > 200 {
 			bodySnippet = bodySnippet[:200] + "..."
 		}
-		framework.L.Error().
+		L.Error().
 			Int("StatusCode", resp.StatusCode()).
 			Dur("duration", duration).
 			Str("ResponseBody", bodySnippet).
@@ -139,40 +137,40 @@ func (lc *Client) QueryRange(ctx context.Context) ([]LogEntry, error) {
 	}
 
 	// Log successful response
-	framework.L.Info().
+	L.Info().
 		Int("StatusCode", resp.StatusCode()).
 		Dur("duration", duration).
 		Msg("Successfully queried Loki API")
 
 	// Parse the response into the Response struct
 	var lokiResp Response
 	if err := json.Unmarshal(resp.Body(), &lokiResp); err != nil {
-		framework.L.Error().Err(err).Msg("Error decoding response from Loki")
+		L.Error().Err(err).Msg("Error decoding response from Loki")
 		return nil, err
 	}
 
 	// Extract log entries from the response
 	logEntries := lc.extractRawLogEntries(lokiResp)
 
 	// Log the number of entries retrieved
-	framework.L.Info().Int("LogEntries", len(logEntries)).Msg("Successfully retrieved logs from Loki")
+	L.Info().Int("LogEntries", len(logEntries)).Msg("Successfully retrieved logs from Loki")
 
 	return logEntries, nil
 }
 
 // extractRawLogEntries processes the Response and returns raw log entries
-func (lc *Client) extractRawLogEntries(lokiResp Response) []LogEntry {
+func (lc *LokiClient) extractRawLogEntries(lokiResp Response) []LogEntry {
 	var logEntries []LogEntry
 
 	for _, result := range lokiResp.Data.Result {
 		for _, entry := range result.Values {
 			if len(entry) != 2 {
-				framework.L.Error().Interface("Log entry", entry).Msgf("Error parsing log entry. Expected 2 elements, got %d", len(entry))
+				L.Error().Interface("Log entry", entry).Msgf("Error parsing log entry. Expected 2 elements, got %d", len(entry))
 				continue
 			}
 			var timestamp string
 			if entry[0] == nil {
-				framework.L.Error().Msg("Error parsing timestamp. Entry at index 0, that should be a timestamp, is nil")
+				L.Error().Msg("Error parsing timestamp. Entry at index 0, that should be a timestamp, is nil")
 				continue
 			}
 			if timestampString, ok := entry[0].(string); ok {
@@ -182,7 +180,7 @@ func (lc *Client) extractRawLogEntries(lokiResp Response) []LogEntry {
 			} else if timestampFloat, ok := entry[0].(float64); ok {
 				timestamp = fmt.Sprintf("%f", timestampFloat)
 			} else {
-				framework.L.Error().Msgf("Error parsing timestamp. Expected string, int, or float64, got %T", entry[0])
+				L.Error().Msgf("Error parsing timestamp. Expected string, int, or float64, got %T", entry[0])
 				continue
 			}
 			logLine := entry[1].(string)

framework/loki/loki.go framework/loki.goframework/loki/loki.go renamed to framework/loki.go

@@ -1,4 +1,4 @@
-package loki
+package framework
 
 import (
 	"context"
@@ -43,7 +43,7 @@ func TestLokiClient_SuccessfulQuery(t *testing.T) {
 		EndTime:   time.Now(),
 		Limit:     100,
 	}
-	lokiClient := NewQueryClient(mockServer.URL, "test-tenant", auth, queryParams)
+	lokiClient := NewLokiQueryClient(mockServer.URL, "test-tenant", auth, queryParams)
 	logEntries, err := lokiClient.QueryRange(context.Background())
 	assert.NoError(t, err)
 	assert.Len(t, logEntries, 2)
@@ -69,7 +69,7 @@ func TestLokiClient_AuthenticationFailure(t *testing.T) {
 		EndTime:   time.Now(),
 		Limit:     100,
 	}
-	lokiClient := NewQueryClient(mockServer.URL, "test-tenant", auth, queryParams)
+	lokiClient := NewLokiQueryClient(mockServer.URL, "test-tenant", auth, queryParams)
 	logEntries, err := lokiClient.QueryRange(context.Background())
 	assert.Nil(t, logEntries)
 	assert.Error(t, err)
@@ -99,7 +99,7 @@ func TestLokiClient_InternalServerError(t *testing.T) {
 		EndTime:   time.Now(),
 		Limit:     100,
 	}
-	lokiClient := NewQueryClient(mockServer.URL, "test-tenant", auth, queryParams)
+	lokiClient := NewLokiQueryClient(mockServer.URL, "test-tenant", auth, queryParams)
 	logEntries, err := lokiClient.QueryRange(context.Background())
 	assert.Nil(t, logEntries)
 	assert.Error(t, err)
@@ -143,7 +143,7 @@ func TestLokiClient_DebugMode(t *testing.T) {
 		EndTime:   time.Now(),
 		Limit:     100,
 	}
-	lokiClient := NewQueryClient(mockServer.URL, "test-tenant", auth, queryParams)
+	lokiClient := NewLokiQueryClient(mockServer.URL, "test-tenant", auth, queryParams)
 	logEntries, err := lokiClient.QueryRange(context.Background())
 	assert.NoError(t, err)
 	assert.Len(t, logEntries, 2)

framework/loki/loki_test.go framework/loki_test.goframework/loki/loki_test.go renamed to framework/loki_test.go

@@ -1,4 +1,4 @@
-package prometheus
+package framework
 
 import (
 	"encoding/json"
@@ -10,23 +10,23 @@ import (
 	"github.com/go-resty/resty/v2"
 )
 
-// QueryClient is a client for querying Prometheus metrics
-type QueryClient struct {
+// PrometheusQueryClient is a client for querying Prometheus metrics
+type PrometheusQueryClient struct {
 	client  *resty.Client
 	baseURL string
 }
 
-// NewQueryClient creates a new QueryClient
-func NewQueryClient(baseURL string) *QueryClient {
+// NewPrometheusQueryClient creates a new PrometheusQueryClient
+func NewPrometheusQueryClient(baseURL string) *PrometheusQueryClient {
 	isDebug := os.Getenv("RESTY_DEBUG") == "true"
-	return &QueryClient{
+	return &PrometheusQueryClient{
 		client:  resty.New().SetDebug(isDebug),
 		baseURL: strings.TrimSuffix(baseURL, "/"),
 	}
 }
 
-// QueryResponse represents the response from Prometheus API
-type QueryResponse struct {
+// PrometheusQueryResponse represents the response from Prometheus API
+type PrometheusQueryResponse struct {
 	Status string `json:"status"`
 	Data   struct {
 		ResultType string `json:"resultType"`
@@ -58,7 +58,7 @@ type QueryRangeParams struct {
 }
 
 // Query executes an instant query against the Prometheus API
-func (p *QueryClient) Query(query string, timestamp time.Time) (*QueryResponse, error) {
+func (p *PrometheusQueryClient) Query(query string, timestamp time.Time) (*PrometheusQueryResponse, error) {
 	url := fmt.Sprintf("%s/api/v1/query", p.baseURL)
 	resp, err := p.client.R().
 		SetQueryParams(map[string]string{
@@ -72,7 +72,7 @@ func (p *QueryClient) Query(query string, timestamp time.Time) (*QueryResponse,
 	if resp.StatusCode() != 200 {
 		return nil, fmt.Errorf("unexpected status code: %d", resp.StatusCode())
 	}
-	var result QueryResponse
+	var result PrometheusQueryResponse
 	if err := json.Unmarshal(resp.Body(), &result); err != nil {
 		return nil, fmt.Errorf("failed to unmarshal response: %w", err)
 	}
@@ -83,7 +83,7 @@ func (p *QueryClient) Query(query string, timestamp time.Time) (*QueryResponse,
 }
 
 // QueryRange executes a range query against the Prometheus API
-func (p *QueryClient) QueryRange(params QueryRangeParams) (*QueryRangeResponse, error) {
+func (p *PrometheusQueryClient) QueryRange(params QueryRangeParams) (*QueryRangeResponse, error) {
 	url := fmt.Sprintf("%s/api/v1/query_range", p.baseURL)
 	resp, err := p.client.R().
 		SetQueryParams(map[string]string{
@@ -109,9 +109,9 @@ func (p *QueryClient) QueryRange(params QueryRangeParams) (*QueryRangeResponse,
 	return &result, nil
 }
 
-// ToLabelsMap converts QueryResponse.Data.Result into a map where keys are
+// ToLabelsMap converts PrometheusQueryResponse.Data.Result into a map where keys are
 // metric labels in "k:v" format and values are slices of all values with that label
-func ToLabelsMap(response *QueryResponse) map[string][]interface{} {
+func ToLabelsMap(response *PrometheusQueryResponse) map[string][]interface{} {
 	resultMap := make(map[string][]interface{})
 	for _, res := range response.Data.Result {
 		for k, v := range res.Metric {