SQLStore: Introduce new test infra (#101676)

This creates the new testinfra. It is not used anywhere yet.

pkg/services/sqlstore/sqlstore_testinfra_test.go

@@ -0,0 +1,139 @@
+package sqlstore_test
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/grafana/grafana/pkg/registry"
+	"github.com/grafana/grafana/pkg/services/org"
+	"github.com/grafana/grafana/pkg/services/sqlstore"
+	"github.com/grafana/grafana/pkg/services/sqlstore/migrator"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"xorm.io/xorm"
+)
+
+// Ensure that we can get any connection at all.
+// If this test fails, it may be sensible to ignore a lot of other test failures as they may be rooted in this.
+func TestIntegrationTempDatabaseConnect(t *testing.T) {
+	if testing.Short() {
+		t.Skip("skipping integration test")
+	}
+
+	sqlStore := sqlstore.NewTestStore(t, sqlstore.WithoutMigrator())
+	err := sqlStore.WithDbSession(context.Background(), func(sess *sqlstore.DBSession) error {
+		_, err := sess.Exec("SELECT 1")
+		return err
+	})
+	require.NoError(t, err, "failed to execute a SELECT 1")
+}
+
+// Ensure that migrations work on the database.
+// If this test fails, it may be sensible to ignore a lot of other test failures as they may be rooted in this.
+// This only applies OSS migrations, with no feature flags.
+func TestIntegrationTempDatabaseOSSMigrate(t *testing.T) {
+	if testing.Short() {
+		t.Skip("skipping integration test")
+	}
+
+	_ = sqlstore.NewTestStore(t, sqlstore.WithOSSMigrations())
+}
+
+func TestIntegrationUniqueConstraintViolation(t *testing.T) {
+	if testing.Short() {
+		t.Skip("skipping integration test")
+	}
+
+	testCases := []struct {
+		desc string
+		f    func(t *testing.T, sess *sqlstore.DBSession, dialect migrator.Dialect) error
+	}{
+		{
+			desc: "successfully detect primary key violations",
+			f: func(t *testing.T, sess *sqlstore.DBSession, dialect migrator.Dialect) error {
+				// Attempt to insert org with provided ID (primary key) twice
+				now := time.Now()
+				org := org.Org{Name: "test org primary key violation", Created: now, Updated: now, ID: 42}
+				err := sess.InsertId(&org, dialect)
+				require.NoError(t, err)
+
+				// Provide a different name to avoid unique constraint violation
+				org.Name = "test org 2"
+				return sess.InsertId(&org, dialect)
+			},
+		},
+		{
+			desc: "successfully detect unique constrain violations",
+			f: func(t *testing.T, sess *sqlstore.DBSession, dialect migrator.Dialect) error {
+				// Attempt to insert org with reserved name
+				now := time.Now()
+				org := org.Org{Name: "test org unique constrain violation", Created: now, Updated: now, ID: 43}
+				err := sess.InsertId(&org, dialect)
+				require.NoError(t, err)
+
+				// Provide a different ID to avoid primary key violation
+				org.ID = 44
+				return sess.InsertId(&org, dialect)
+			},
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.desc, func(t *testing.T) {
+			store := sqlstore.NewTestStore(t)
+			err := store.WithDbSession(context.Background(), func(sess *sqlstore.DBSession) error {
+				return tc.f(t, sess, store.GetDialect())
+			})
+			require.Error(t, err)
+			assert.True(t, store.GetDialect().IsUniqueConstraintViolation(err))
+		})
+	}
+}
+
+func TestIntegrationTruncateDatabase(t *testing.T) {
+	if testing.Short() {
+		t.Skip("skipping integration test")
+	}
+
+	migrator := &truncateDatabaseSetup{}
+	store := sqlstore.NewTestStore(t, sqlstore.WithMigrator(migrator), sqlstore.WithTruncation())
+
+	var beans []*truncateBean
+	err := store.WithDbSession(context.Background(), func(sess *sqlstore.DBSession) error {
+		return sess.Find(&beans)
+	})
+	require.NoError(t, err, "could not find truncateBeans")
+
+	require.Empty(t, beans, "database should have no truncateBeans")
+}
+
+var (
+	_ registry.DatabaseMigrator = (*truncateDatabaseSetup)(nil)
+	_ migrator.CodeMigration    = (*truncateDatabaseSetup)(nil)
+)
+
+type truncateDatabaseSetup struct {
+	migrator.MigrationBase
+}
+
+func (t *truncateDatabaseSetup) AddMigration(mg *migrator.Migrator) {
+	mg.AddCreateMigration()
+	mg.AddMigration("add_to_truncate_table", t)
+}
+
+func (*truncateDatabaseSetup) SQL(dialect migrator.Dialect) string {
+	return "code migration"
+}
+
+func (t *truncateDatabaseSetup) Exec(sess *xorm.Session, migrator *migrator.Migrator) error {
+	if err := sess.CreateTable(&truncateBean{}); err != nil {
+		return err
+	}
+	_, err := sess.InsertOne(&truncateBean{1234})
+	return err
+}
+
+type truncateBean struct {
+	Value int
+}