root
/
grafana
mirror of https://github.com/grafana/grafana.git
1
0
Fork 0
Code Issues Actions 150 Packages Projects Releases Wiki Activity

Replace remaining calls to testing.Short where possible. (#110765) 

* Replace remaining calls to testing.Short where possible.
* Update style guide.
* Revert change in TestAlertmanager_ExtraDedupStage, as it doesn't work.
* Make TestAlertRulePostExport into integration test.
This commit is contained in:
Peter Štibraný 2025-09-09 10:16:12 +02:00 committed by GitHub
parent ffcc0e8de0
commit c32650e9d8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
16 changed files with 76 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
contribute/backend/style-guide.md
View File

@ -60,13 +60,12 @@ You only need to define `TestMain` in one `_test.go` file within each package.
We run unit and integration tests separately, to help keep our CI pipeline running smoothly and provide a better developer experience.
To properly mark a test as being an integration test, you must format your test function definition as follows, with the function name starting with `TestIntegration` and the check for `testing.Short()`:
To properly mark a test as being an integration test, you must format your test function definition as follows, with the function name starting with `TestIntegration` and the check for running in Short mode by using `testutil.SkipIntegrationTestInShortMode(t)` function:
```go
func TestIntegrationFoo(t *testing.T) {
if testing.Short() {
t.Skip("skipping integration test")
}
testutil.SkipIntegrationTestInShortMode(t)
// function body
}
```

83
pkg/cmd/grafana-cli/commands/install_command_test.go
View File

@ -4,11 +4,13 @@ import (
"fmt"
"testing"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
"github.com/grafana/grafana/pkg/cmd/grafana-cli/commands/commandstest"
"github.com/grafana/grafana/pkg/cmd/grafana-cli/utils"
"github.com/grafana/grafana/pkg/tests/testinfra"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
"github.com/grafana/grafana/pkg/util/testutil"
)
func TestValidateInput(t *testing.T) {
@ -81,6 +83,43 @@ func TestValidateInput(t *testing.T) {
}
}
func TestIntegrationPluginRepoConfig(t *testing.T) {
testutil.SkipIntegrationTestInShortMode(t)
t.Run("Should use config parameter if it is set", func(t *testing.T) {
grafDir, cfgPath := testinfra.CreateGrafDir(t, testinfra.GrafanaOpts{
GrafanaComAPIURL: "https://grafana-dev.com",
GrafanaComSSOAPIToken: "token3",
})
c, err := commandstest.NewCliContext(map[string]string{
"config": cfgPath,
"homepath": grafDir,
})
require.NoError(t, err)
repoURL := c.PluginRepoURL()
require.Equal(t, "https://grafana-dev.com/plugins", repoURL)
token := c.GcomToken()
require.Equal(t, "token3", token)
})
t.Run("Should use config overrides parameter if it is set alongside config parameter", func(t *testing.T) {
// GrafanaComApiUrl is set to the default path https://grafana.com/api
grafDir, cfgPath := testinfra.CreateGrafDir(t, testinfra.GrafanaOpts{})
// overriding the GrafanaComApiUrl to https://grafana-dev.com
c, err := commandstest.NewCliContext(map[string]string{
"config": cfgPath,
"homepath": grafDir,
"configOverrides": "cfg:grafana_com.api_url=https://grafana-dev.com",
})
require.NoError(t, err)
repoURL := c.PluginRepoURL()
require.Equal(t, "https://grafana-dev.com/plugins", repoURL)
})
}
func TestValidatePluginRepoConfig(t *testing.T) {
t.Run("Should use provided repo parameter for installation", func(t *testing.T) {
c, err := commandstest.NewCliContext(map[string]string{
@ -100,44 +139,4 @@ func TestValidatePluginRepoConfig(t *testing.T) {
require.NoError(t, err)
require.Equal(t, "https://example.com", c.PluginRepoURL())
})
t.Run("Should use config parameter if it is set", func(t *testing.T) {
if testing.Short() {
t.Skip("skipping integration test")
}
grafDir, cfgPath := testinfra.CreateGrafDir(t, testinfra.GrafanaOpts{
GrafanaComAPIURL: "https://grafana-dev.com",
GrafanaComSSOAPIToken: "token3",
})
c, err := commandstest.NewCliContext(map[string]string{
"config": cfgPath,
"homepath": grafDir,
})
require.NoError(t, err)
repoURL := c.PluginRepoURL()
require.Equal(t, "https://grafana-dev.com/plugins", repoURL)
token := c.GcomToken()
require.Equal(t, "token3", token)
})
t.Run("Should use config overrides parameter if it is set alongside config parameter", func(t *testing.T) {
if testing.Short() {
t.Skip("skipping integration test")
}
// GrafanaComApiUrl is set to the default path https://grafana.com/api
grafDir, cfgPath := testinfra.CreateGrafDir(t, testinfra.GrafanaOpts{})
// overriding the GrafanaComApiUrl to https://grafana-dev.com
c, err := commandstest.NewCliContext(map[string]string{
"config": cfgPath,
"homepath": grafDir,
"configOverrides": "cfg:grafana_com.api_url=https://grafana-dev.com",
})
require.NoError(t, err)
repoURL := c.PluginRepoURL()
require.Equal(t, "https://grafana-dev.com/plugins", repoURL)
})
}

6
pkg/registry/apis/iam/resourcepermission/sql_test.go
View File

@ -206,10 +206,8 @@ func TestIntegration_ResourcePermSqlBackend_getResourcePermission(t *testing.T)
}
}
func TestResourcePermSqlBackend_deleteResourcePermission(t *testing.T) {
if testing.Short() {
t.Skip("skipping integration test in short mode")
}
func TestIntegrationResourcePermSqlBackend_deleteResourcePermission(t *testing.T) {
testutil.SkipIntegrationTestInShortMode(t)
backend := setupBackend(t)
sql, err := backend.dbProvider(context.Background())

4
pkg/registry/apis/iam/resourcepermission/storage_backend_test.go
View File

@ -330,10 +330,6 @@ func TestWriteEvent_Add(t *testing.T) {
}
func TestWriteEvent_Delete(t *testing.T) {
if testing.Short() {
t.Skip("skipping integration test in short mode")
}
backend := setupBackend(t)
sql, err := backend.dbProvider(context.Background())
require.NoError(t, err)

4
pkg/services/accesscontrol/resourcepermissions/store_test.go
View File

@ -753,10 +753,6 @@ func retrievePermissionsHelper(store *store, t *testing.T) []orgPermission {
}
func TestStore_StoreActionSet(t *testing.T) {
if testing.Short() {
t.Skip("skipping integration test")
}
type actionSetTest struct {
desc string
resource string

3
pkg/services/annotations/annotationsimpl/loki/historian_store_test.go
View File

@ -10,11 +10,12 @@ import (
"testing"
"time"
"github.com/grafana/grafana/pkg/services/ngalert/lokiclient"
"github.com/prometheus/client_golang/prometheus"
"github.com/stretchr/testify/require"
"golang.org/x/exp/maps"
"github.com/grafana/grafana/pkg/services/ngalert/lokiclient"
"github.com/grafana/grafana/pkg/components/simplejson"
"github.com/grafana/grafana/pkg/infra/db"
"github.com/grafana/grafana/pkg/infra/log"

6
pkg/services/ngalert/store/provisioning_store_test.go
View File

@ -156,10 +156,8 @@ func TestIntegrationProvisioningStore(t *testing.T) {
}
}
func TestSetProvenance_DeadlockScenarios(t *testing.T) {
if testing.Short() {
t.Skip("skipping integration test")
}
func TestIntegrationSetProvenance_DeadlockScenarios(t *testing.T) {
testutil.SkipIntegrationTestInShortMode(t)
ng, dbStore := tests.SetupTestEnv(t, testAlertingIntervalSeconds)
dbStore.FeatureToggles = featuremgmt.WithFeatures(featuremgmt.FlagAlertingProvenanceLockWrites)

1
pkg/tests/alertmanager/alertmanager_test.go
View File

@ -8,6 +8,7 @@ import (
)
func TestAlertmanager_ExtraDedupStage(t *testing.T) {
// TODO: rename test and call testutil.SkipIntegrationTestInShortMode(t)
if testing.Short() {
t.Skip("skipping integration test")
}

2
pkg/tests/api/alerting/api_ruler_test.go
View File

@ -711,7 +711,7 @@ func TestIntegrationAlertRuleNestedPermissions(t *testing.T) {
})
}
func TestAlertRulePostExport(t *testing.T) {
func TestIntegrationAlertRulePostExport(t *testing.T) {
testinfra.SQLiteIntegrationTest(t)
// Setup Grafana and its Database

10
pkg/tests/api/folders/api_folders_test.go
View File

@ -8,6 +8,7 @@ import (
"github.com/grafana/grafana-openapi-client-go/client/folders"
"github.com/grafana/grafana-openapi-client-go/models"
"github.com/grafana/grafana/pkg/services/accesscontrol/resourcepermissions"
"github.com/grafana/grafana/pkg/services/featuremgmt"
"github.com/grafana/grafana/pkg/services/folder"
@ -17,6 +18,8 @@ import (
"github.com/grafana/grafana/pkg/tests/testinfra"
"github.com/grafana/grafana/pkg/tests/testsuite"
"github.com/grafana/grafana/pkg/util/retryer"
"github.com/grafana/grafana/pkg/util/testutil"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
@ -25,10 +28,9 @@ func TestMain(m *testing.M) {
testsuite.Run(m)
}
func TestGetFolders(t *testing.T) {
if testing.Short() {
t.Skip("skipping integration test")
}
func TestIntegrationGetFolders(t *testing.T) {
testutil.SkipIntegrationTestInShortMode(t)
// Setup Grafana and its Database
dir, p := testinfra.CreateGrafDir(t, testinfra.GrafanaOpts{
DisableLegacyAlerting: true,

6
pkg/tests/apis/iam/service_account_integration_test.go
View File

@ -15,6 +15,8 @@ import (
"github.com/grafana/grafana/pkg/setting"
"github.com/grafana/grafana/pkg/tests/apis"
"github.com/grafana/grafana/pkg/tests/testinfra"
"github.com/grafana/grafana/pkg/util/testutil"
"github.com/stretchr/testify/require"
"k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/runtime/schema"
@ -27,9 +29,7 @@ var gvrServiceAccounts = schema.GroupVersionResource{
}
func TestIntegrationServiceAccounts(t *testing.T) {
if testing.Short() {
t.Skip("skipping integration test")
}
testutil.SkipIntegrationTestInShortMode(t)
// TODO: Figure out why rest.Mode4 is failing
modes := []rest.DualWriterMode{rest.Mode0, rest.Mode1, rest.Mode2, rest.Mode3}

8
pkg/tests/apis/plugins/discovery_test.go
View File

@ -4,12 +4,12 @@ import (
"testing"
"github.com/stretchr/testify/require"
"github.com/grafana/grafana/pkg/util/testutil"
)
func TestPluginsIntegrationDiscovery(t *testing.T) {
if testing.Short() {
t.Skip("skipping integration test")
}
func TestIntegrationPluginsIntegrationDiscovery(t *testing.T) {
testutil.SkipIntegrationTestInShortMode(t)
t.Run("discovery", func(t *testing.T) {
helper := setupHelper(t)

6
pkg/tests/apis/provisioning/exportjob_test.go
View File

@ -16,10 +16,8 @@ import (
"github.com/grafana/grafana/pkg/util/testutil"
)
func TestProvisioning_ExportUnifiedToRepository(t *testing.T) {
if testing.Short() {
t.Skip("skipping integration test")
}
func TestIntegrationProvisioning_ExportUnifiedToRepository(t *testing.T) {
testutil.SkipIntegrationTestInShortMode(t)
helper := runGrafana(t)
ctx := context.Background()

11
pkg/tests/testinfra/testinfra.go
View File

@ -12,14 +12,16 @@ import (
"testing"
"time"
"github.com/grafana/grafana/pkg/configprovider"
"github.com/grafana/grafana/pkg/services/featuremgmt"
"github.com/grafana/grafana/pkg/services/sqlstore/sqlutil"
"github.com/prometheus/client_golang/prometheus"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"gopkg.in/ini.v1"
"github.com/grafana/grafana/pkg/configprovider"
"github.com/grafana/grafana/pkg/services/featuremgmt"
"github.com/grafana/grafana/pkg/services/sqlstore/sqlutil"
"github.com/grafana/grafana/pkg/util/testutil"
"github.com/grafana/dskit/kv"
"github.com/grafana/grafana/pkg/api"
@ -570,8 +572,9 @@ func CreateGrafDir(t *testing.T, opts GrafanaOpts) (string, string) {
func SQLiteIntegrationTest(t *testing.T) {
t.Helper()
testutil.SkipIntegrationTestInShortMode(t)
if testing.Short() || !db.IsTestDbSQLite() {
if !db.IsTestDbSQLite() {
t.Skip("skipping integration test")
}
}

2
pkg/tsdb/influxdb/fsql/fsql_test.go
View File

@ -55,7 +55,7 @@ func (suite *FSQLTestSuite) AfterTest(suiteName, testName string) {
suite.server.Shutdown()
}
func TestFSQLTestSuite(t *testing.T) {
func TestIntegrationFSQLTestSuite(t *testing.T) {
if testing.Short() {
t.Skip("skipping integration test in short mode")
}

5
pkg/tsdb/mysql/mysql_snapshot_test.go
View File

@ -36,11 +36,8 @@ func TestIntegrationMySQLSnapshots(t *testing.T) {
if testing.Short() {
t.Skip("skipping integration test in short mode")
}
shouldRunTest := func() bool {
if testing.Short() {
return false
}
shouldRunTest := func() bool {
testDbName, present := os.LookupEnv("GRAFANA_TEST_DB")
if present && testDbName == "mysql" {