Graphite: Backend health-check (#110518)
* Add lint rules * Backend decoupling - Add standalone files - Add graphite query type - Add logger to Service - Create logger in the ProvideService method - Use a pointer for the HTTP client provider - Update logger usage everywhere - Update tracer type - Replace simplejson with json - Add dummy CallResource and CheckHealth methods - Update tests * Update ConfigEditor imports * Update types imports * Update datasource - Switch to using semver package - Update imports * Update store imports * Update helper imports and notification creation * Update context import * Update version numbers and logic * Copy array_move from core * Test updates * Add required files and update plugin.json * Update core references and packages * Remove commented code * Update wire * Lint * Fix import * Copy null type * More lint * Update snapshot * Refactor backend - Split query logic into separate file - Move utils to separate file * Add health-check logic - Support backend healthcheck if the FF is enabled * Remove query import support as unneeded * Add test * Add tests * Review * Review * Fix packages * Fix merge issues
This commit is contained in:
Andreas Christou
@@ -1,244 +0,0 @@
|
||||
package graphite
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"reflect"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/grafana/grafana-plugin-sdk-go/backend"
|
||||
"github.com/grafana/grafana-plugin-sdk-go/backend/httpclient"
|
||||
"github.com/grafana/grafana-plugin-sdk-go/data"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"go.opentelemetry.io/otel/trace/noop"
|
||||
)
|
||||
|
||||
func TestFixIntervalFormat(t *testing.T) {
|
||||
testCases := []struct {
|
||||
name string
|
||||
target string
|
||||
expected string
|
||||
}{
|
||||
{
|
||||
name: "should transform 1m to graphite unit (1min) when used as interval string",
|
||||
target: "aliasByNode(hitcount(averageSeries(app.grafana.*.dashboards.views.count), '1m'), 4)",
|
||||
expected: "aliasByNode(hitcount(averageSeries(app.grafana.*.dashboards.views.count), '1min'), 4)",
|
||||
},
|
||||
{
|
||||
name: "should transform 1M to graphite unit (1mon) when used as interval string",
|
||||
target: "aliasByNode(hitcount(averageSeries(app.grafana.*.dashboards.views.count), '1M'), 4)",
|
||||
expected: "aliasByNode(hitcount(averageSeries(app.grafana.*.dashboards.views.count), '1mon'), 4)",
|
||||
},
|
||||
{
|
||||
name: "should not transform 1m when not used as interval string",
|
||||
target: "app.grafana.*.dashboards.views.1m.count",
|
||||
expected: "app.grafana.*.dashboards.views.1m.count",
|
||||
},
|
||||
{
|
||||
name: "should not transform 1M when not used as interval string",
|
||||
target: "app.grafana.*.dashboards.views.1M.count",
|
||||
expected: "app.grafana.*.dashboards.views.1M.count",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
tr := fixIntervalFormat(tc.target)
|
||||
assert.Equal(t, tc.expected, tr)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestProcessQuery(t *testing.T) {
|
||||
service := &Service{
|
||||
logger: backend.Logger,
|
||||
}
|
||||
t.Run("Parses single valid query", func(t *testing.T) {
|
||||
queries := []backend.DataQuery{
|
||||
{
|
||||
RefID: "A",
|
||||
JSON: []byte(`{
|
||||
"target": "app.grafana.*.dashboards.views.1M.count"
|
||||
}`),
|
||||
},
|
||||
}
|
||||
target, jsonModel, err := service.processQuery(queries[0])
|
||||
assert.NoError(t, err)
|
||||
assert.Nil(t, jsonModel)
|
||||
assert.Equal(t, "app.grafana.*.dashboards.views.1M.count", target)
|
||||
})
|
||||
|
||||
t.Run("Returns if target is empty", func(t *testing.T) {
|
||||
queries := []backend.DataQuery{
|
||||
{
|
||||
RefID: "A",
|
||||
JSON: []byte(`{
|
||||
"target": ""
|
||||
}`),
|
||||
},
|
||||
}
|
||||
emptyQuery := GraphiteQuery{Target: ""}
|
||||
target, jsonModel, err := service.processQuery(queries[0])
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, &emptyQuery, jsonModel)
|
||||
assert.Equal(t, "", target)
|
||||
})
|
||||
|
||||
t.Run("QueryData with no valid queries returns bad request response", func(t *testing.T) {
|
||||
queries := []backend.DataQuery{
|
||||
{
|
||||
RefID: "A",
|
||||
JSON: []byte(`{
|
||||
"query": "app.grafana.*.dashboards.views.1M.count"
|
||||
}`),
|
||||
},
|
||||
{
|
||||
RefID: "B",
|
||||
JSON: []byte(`{
|
||||
"query": "app.grafana.*.dashboards.views.1M.count"
|
||||
}`),
|
||||
},
|
||||
}
|
||||
|
||||
service := ProvideService(httpclient.NewProvider(), noop.NewTracerProvider().Tracer("graphite-tests"))
|
||||
|
||||
rsp, err := service.QueryData(context.Background(), &backend.QueryDataRequest{
|
||||
PluginContext: backend.PluginContext{
|
||||
DataSourceInstanceSettings: &backend.DataSourceInstanceSettings{
|
||||
ID: 0,
|
||||
URL: "http://localhost",
|
||||
},
|
||||
},
|
||||
Queries: queries,
|
||||
})
|
||||
assert.NoError(t, err)
|
||||
expectedResponse := backend.ErrDataResponseWithSource(400, backend.ErrorSourceDownstream, "no query target found for the alert rule")
|
||||
assert.Equal(t, expectedResponse, rsp.Responses["A"])
|
||||
})
|
||||
|
||||
t.Run("QueryData with no queries returns an error", func(t *testing.T) {
|
||||
service := &Service{
|
||||
logger: backend.Logger,
|
||||
}
|
||||
|
||||
rsp, err := service.QueryData(context.Background(), &backend.QueryDataRequest{})
|
||||
assert.Nil(t, rsp)
|
||||
assert.Error(t, err)
|
||||
})
|
||||
|
||||
t.Run("QueryData happy path with service provider and plugin context", func(t *testing.T) {
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = w.Write([]byte(`[
|
||||
{
|
||||
"target": "target A",
|
||||
"tags": { "fooTag": "fooValue", "barTag": "barValue", "int": 100, "float": 3.14 },
|
||||
"datapoints": [[50, 1], [null, 2], [100, 3]]
|
||||
}
|
||||
]`))
|
||||
}))
|
||||
t.Cleanup(server.Close)
|
||||
|
||||
service := ProvideService(httpclient.NewProvider(), noop.NewTracerProvider().Tracer("graphite-tests"))
|
||||
|
||||
queries := []backend.DataQuery{
|
||||
{
|
||||
RefID: "A",
|
||||
JSON: []byte(`{
|
||||
"target": "app.grafana.*.dashboards.views.1M.count"
|
||||
}`),
|
||||
},
|
||||
{
|
||||
RefID: "B",
|
||||
JSON: []byte(`{
|
||||
"query": "app.grafana.*.dashboards.views.1M.count"
|
||||
}`),
|
||||
},
|
||||
}
|
||||
|
||||
rsp, err := service.QueryData(context.Background(), &backend.QueryDataRequest{
|
||||
PluginContext: backend.PluginContext{
|
||||
DataSourceInstanceSettings: &backend.DataSourceInstanceSettings{
|
||||
ID: 0,
|
||||
URL: server.URL,
|
||||
},
|
||||
},
|
||||
Queries: queries,
|
||||
})
|
||||
assert.NoError(t, err)
|
||||
assert.NotNil(t, rsp)
|
||||
})
|
||||
}
|
||||
|
||||
func TestConvertResponses(t *testing.T) {
|
||||
service := &Service{
|
||||
logger: backend.Logger,
|
||||
}
|
||||
|
||||
t.Run("Converts response without tags to data frames", func(*testing.T) {
|
||||
body := `
|
||||
[
|
||||
{
|
||||
"target": "target",
|
||||
"datapoints": [[50, 1], [null, 2], [100, 3]]
|
||||
}
|
||||
]`
|
||||
a := 50.0
|
||||
b := 100.0
|
||||
refId := "A"
|
||||
expectedFrame := data.NewFrame("A",
|
||||
data.NewField("time", nil, []time.Time{time.Unix(1, 0).UTC(), time.Unix(2, 0).UTC(), time.Unix(3, 0).UTC()}),
|
||||
data.NewField("value", data.Labels{}, []*float64{&a, nil, &b}).SetConfig(&data.FieldConfig{DisplayNameFromDS: "target"}),
|
||||
).SetMeta(&data.FrameMeta{Type: data.FrameTypeTimeSeriesMulti})
|
||||
expectedFrames := data.Frames{expectedFrame}
|
||||
|
||||
httpResponse := &http.Response{StatusCode: 200, Body: io.NopCloser(strings.NewReader(body))}
|
||||
dataFrames, err := service.toDataFrames(httpResponse, refId)
|
||||
|
||||
require.NoError(t, err)
|
||||
if !reflect.DeepEqual(expectedFrames, dataFrames) {
|
||||
expectedFramesJSON, _ := json.Marshal(expectedFrames)
|
||||
dataFramesJSON, _ := json.Marshal(dataFrames)
|
||||
t.Errorf("Data frames should have been equal but was, expected:\n%s\nactual:\n%s", expectedFramesJSON, dataFramesJSON)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("Converts response with tags to data frames", func(*testing.T) {
|
||||
body := `
|
||||
[
|
||||
{
|
||||
"target": "target",
|
||||
"tags": { "fooTag": "fooValue", "barTag": "barValue", "int": 100, "float": 3.14 },
|
||||
"datapoints": [[50, 1], [null, 2], [100, 3]]
|
||||
}
|
||||
]`
|
||||
a := 50.0
|
||||
b := 100.0
|
||||
refId := "A"
|
||||
expectedFrame := data.NewFrame("A",
|
||||
data.NewField("time", nil, []time.Time{time.Unix(1, 0).UTC(), time.Unix(2, 0).UTC(), time.Unix(3, 0).UTC()}),
|
||||
data.NewField("value", data.Labels{
|
||||
"fooTag": "fooValue",
|
||||
"barTag": "barValue",
|
||||
"int": "100",
|
||||
"float": "3.14",
|
||||
}, []*float64{&a, nil, &b}).SetConfig(&data.FieldConfig{DisplayNameFromDS: "target"}),
|
||||
).SetMeta(&data.FrameMeta{Type: data.FrameTypeTimeSeriesMulti})
|
||||
expectedFrames := data.Frames{expectedFrame}
|
||||
|
||||
httpResponse := &http.Response{StatusCode: 200, Body: io.NopCloser(strings.NewReader(body))}
|
||||
dataFrames, err := service.toDataFrames(httpResponse, refId)
|
||||
|
||||
require.NoError(t, err)
|
||||
if !reflect.DeepEqual(expectedFrames, dataFrames) {
|
||||
expectedFramesJSON, _ := json.Marshal(expectedFrames)
|
||||
dataFramesJSON, _ := json.Marshal(dataFrames)
|
||||
t.Errorf("Data frames should have been equal but was, expected:\n%s\nactual:\n%s", expectedFramesJSON, dataFramesJSON)
|
||||
}
|
||||
})
|
||||
}
|
||||
Reference in New Issue
Block a user