public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Chore: Remove bus from health api (#44897)

Browse Source 
* remove bus from health api

* fix health api tests

* use db health query as a method

* use pointer in sqlstore mock
This commit is contained in:
Serge Zaitsev
2022-02-04 14:33:35 +01:00
committed by GitHub
parent 058e3ffc21
commit 61533a3cb4
7 changed files with 16 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/api/health.go
+1 -2
View File
@@ -4,7 +4,6 @@ import (
"context"
"time"
"github.com/grafana/grafana/pkg/bus"
"github.com/grafana/grafana/pkg/models"
)
@@ -15,7 +14,7 @@ func (hs *HTTPServer) databaseHealthy(ctx context.Context) bool {
return cached.(bool)
}
healthy := bus.Dispatch(ctx, &models.GetDBHealthQuery{}) == nil
healthy := hs.SQLStore.GetDBHealthQuery(ctx, &models.GetDBHealthQuery{}) == nil
hs.CacheService.Set(cacheKey, healthy, time.Second*5)
return healthy
pkg/api/health_test.go
+3 -27
View File
@@ -1,16 +1,14 @@
package api
import (
"context"
"errors"
"net/http"
"net/http/httptest"
"testing"
"time"
"github.com/grafana/grafana/pkg/bus"
"github.com/grafana/grafana/pkg/infra/localcache"
"github.com/grafana/grafana/pkg/models"
"github.com/grafana/grafana/pkg/services/sqlstore/mockstore"
"github.com/grafana/grafana/pkg/setting"
"github.com/grafana/grafana/pkg/web"
"github.com/stretchr/testify/require"
@@ -22,10 +20,6 @@ func TestHealthAPI_Version(t *testing.T) {
cfg.BuildCommit = "59906ab1bf"
})
bus.AddHandler("test", func(ctx context.Context, query *models.GetDBHealthQuery) error {
return nil
})
req := httptest.NewRequest(http.MethodGet, "/api/health", nil)
rec := httptest.NewRecorder()
m.ServeHTTP(rec, req)
@@ -45,10 +39,6 @@ func TestHealthAPI_AnonymousHideVersion(t *testing.T) {
m, hs := setupHealthAPITestEnvironment(t)
hs.Cfg.AnonymousHideVersion = true
bus.AddHandler("test", func(ctx context.Context, query *models.GetDBHealthQuery) error {
return nil
})
req := httptest.NewRequest(http.MethodGet, "/api/health", nil)
rec := httptest.NewRecorder()
m.ServeHTTP(rec, req)
@@ -68,10 +58,6 @@ func TestHealthAPI_DatabaseHealthy(t *testing.T) {
m, hs := setupHealthAPITestEnvironment(t)
hs.Cfg.AnonymousHideVersion = true
bus.AddHandler("test", func(ctx context.Context, query *models.GetDBHealthQuery) error {
return nil
})
healthy, found := hs.CacheService.Get(cacheKey)
require.False(t, found)
require.Nil(t, healthy)
@@ -98,10 +84,7 @@ func TestHealthAPI_DatabaseUnhealthy(t *testing.T) {
m, hs := setupHealthAPITestEnvironment(t)
hs.Cfg.AnonymousHideVersion = true
bus.AddHandler("test", func(ctx context.Context, query *models.GetDBHealthQuery) error {
return errors.New("bad")
})
hs.SQLStore.(*mockstore.SQLStoreMock).ExpectedError = errors.New("bad")
healthy, found := hs.CacheService.Get(cacheKey)
require.False(t, found)
@@ -130,11 +113,6 @@ func TestHealthAPI_DatabaseHealthCached(t *testing.T) {
m, hs := setupHealthAPITestEnvironment(t)
hs.Cfg.AnonymousHideVersion = true
// Database is healthy.
bus.AddHandler("test", func(ctx context.Context, query *models.GetDBHealthQuery) error {
return nil
})
// Mock unhealthy database in cache.
hs.CacheService.Set(cacheKey, false, 5*time.Minute)
@@ -171,9 +149,6 @@ func TestHealthAPI_DatabaseHealthCached(t *testing.T) {
func setupHealthAPITestEnvironment(t *testing.T, cbs ...func(*setting.Cfg)) (*web.Mux, *HTTPServer) {
t.Helper()
bus.ClearBusHandlers()
t.Cleanup(bus.ClearBusHandlers)
m := web.New()
cfg := setting.NewCfg()
for _, cb := range cbs {
@@ -182,6 +157,7 @@ func setupHealthAPITestEnvironment(t *testing.T, cbs ...func(*setting.Cfg)) (*we
hs := &HTTPServer{
CacheService: localcache.New(5*time.Minute, 10*time.Minute),
Cfg: cfg,
SQLStore: mockstore.NewSQLStoreMock(),
}
m.Get("/api/health", hs.apiHealthHandler)