chore/enterpriseportal: split database package (#63425)

As we set up to introduce more tables to Enterprise Portal, I think
it'll be more sustainable for things to get their own subpackages. No
real code changes, just moving things around.

## Test plan

CI

Author: bobheadxi

cmd/enterprise-portal/internal/database/BUILD.bazel

@@ -1,16 +1,17 @@
-load("//dev:go_defs.bzl", "go_test")
 load("@io_bazel_rules_go//go:def.bzl", "go_library")
 
 go_library(
     name = "database",
     srcs = [
         "database.go",
         "migrate.go",
-        "subscriptions.go",
     ],
     importpath = "github.com/sourcegraph/sourcegraph/cmd/enterprise-portal/internal/database",
+    tags = [TAG_INFRA_CORESERVICES],
     visibility = ["//cmd/enterprise-portal:__subpackages__"],
     deps = [
+        "//cmd/enterprise-portal/internal/database/internal/tables",
+        "//cmd/enterprise-portal/internal/database/subscriptions",
         "//lib/errors",
         "//lib/managedservicesplatform/runtime",
         "//lib/redislock",
@@ -21,35 +22,10 @@ go_library(
         "@io_gorm_driver_postgres//:postgres",
         "@io_gorm_gorm//:gorm",
         "@io_gorm_gorm//logger",
-        "@io_gorm_gorm//schema",
         "@io_gorm_plugin_opentelemetry//tracing",
         "@io_opentelemetry_go_otel//:otel",
         "@io_opentelemetry_go_otel//attribute",
         "@io_opentelemetry_go_otel//codes",
         "@io_opentelemetry_go_otel_trace//:trace",
     ],
 )
-
-go_test(
-    name = "database_test",
-    srcs = [
-        "main_test.go",
-        "subscriptions_test.go",
-    ],
-    embed = [":database"],
-    tags = [
-        # Test requires localhost database
-        "requires-network",
-    ],
-    deps = [
-        "//internal/database/dbtest",
-        "@com_github_google_uuid//:uuid",
-        "@com_github_jackc_pgx_v5//:pgx",
-        "@com_github_jackc_pgx_v5//pgxpool",
-        "@com_github_stretchr_testify//assert",
-        "@com_github_stretchr_testify//require",
-        "@io_gorm_driver_postgres//:postgres",
-        "@io_gorm_gorm//:gorm",
-        "@io_gorm_gorm//schema",
-    ],
-)

cmd/enterprise-portal/internal/database/database.go

@@ -9,10 +9,11 @@ import (
 	"github.com/redis/go-redis/v9"
 	"github.com/sourcegraph/log"
 	"go.opentelemetry.io/otel"
-	"gorm.io/gorm/schema"
 
 	"github.com/sourcegraph/sourcegraph/lib/errors"
 	"github.com/sourcegraph/sourcegraph/lib/managedservicesplatform/runtime"
+
+	"github.com/sourcegraph/sourcegraph/cmd/enterprise-portal/internal/database/subscriptions"
 )
 
 var databaseTracer = otel.Tracer("enterprise-portal/internal/database")
@@ -22,13 +23,8 @@ type DB struct {
 	db *pgxpool.Pool
 }
 
-func (db *DB) Subscriptions() *SubscriptionsStore {
-	return newSubscriptionsStore(db.db)
-}
-
-// ⚠️ WARNING: This list is meant to be read-only.
-var allTables = []schema.Tabler{
-	&Subscription{},
+func (db *DB) Subscriptions() *subscriptions.Store {
+	return subscriptions.NewStore(db.db)
 }
 
 func databaseName(msp bool) string {

cmd/enterprise-portal/internal/database/databasetest/BUILD.bazel

@@ -0,0 +1,17 @@
+load("@io_bazel_rules_go//go:def.bzl", "go_library")
+
+go_library(
+    name = "databasetest",
+    srcs = ["databasetest.go"],
+    importpath = "github.com/sourcegraph/sourcegraph/cmd/enterprise-portal/internal/database/databasetest",
+    tags = [TAG_INFRA_CORESERVICES],
+    visibility = ["//cmd/enterprise-portal:__subpackages__"],
+    deps = [
+        "//internal/database/dbtest",
+        "@com_github_jackc_pgx_v5//pgxpool",
+        "@com_github_stretchr_testify//require",
+        "@io_gorm_driver_postgres//:postgres",
+        "@io_gorm_gorm//:gorm",
+        "@io_gorm_gorm//schema",
+    ],
+)

cmd/enterprise-portal/internal/database/main_test.go renamed to cmd/enterprise-portal/internal/database/databasetest/databasetest.go

@@ -1,4 +1,4 @@
-package database
+package databasetest
 
 import (
 	"context"
@@ -17,12 +17,12 @@ import (
 	"github.com/sourcegraph/sourcegraph/internal/database/dbtest"
 )
 
-// newTestDB creates a new test database and initializes the given list of
+// NewTestDB creates a new test database and initializes the given list of
 // tables for the suite. The test database is dropped after testing is completed
 // unless failed.
 //
 // Future: Move to a shared package when more than Enterprise Portal uses it.
-func newTestDB(t testing.TB, system, suite string, tables ...schema.Tabler) *pgxpool.Pool {
+func NewTestDB(t testing.TB, system, suite string, tables ...schema.Tabler) *pgxpool.Pool {
 	if testing.Short() {
 		t.Skip("skipping DB test since -short specified")
 	}
@@ -92,20 +92,25 @@ func newTestDB(t testing.TB, system, suite string, tables ...schema.Tabler) *pgx
 	return testDB
 }
 
-// clearTables removes all rows from the list of tables in the original order.
-// It uses soft-deletion when available and skips deletion when the test suite
-// failed.
+// ClearTablesAfterTest removes all rows from the list of tables in the original
+// order as a t.Cleanup hook. It uses soft-deletion when available and skips
+// deletion when the test suite failed.
 //
 // Future: Move to a shared package when more than Enterprise Portal uses it.
-func clearTables(t *testing.T, db *pgxpool.Pool, tables ...schema.Tabler) error {
-	if t.Failed() {
-		return nil
-	}
+func ClearTablesAfterTest(t *testing.T, db *pgxpool.Pool, tables ...schema.Tabler) {
+	t.Cleanup(func() {
+		if t.Failed() {
+			t.Log("Leaving table data intact after test failure")
+			return
+		}
 
-	tableNames := make([]string, 0, len(tables))
-	for _, t := range tables {
-		tableNames = append(tableNames, t.TableName())
-	}
-	_, err := db.Exec(context.Background(), "TRUNCATE TABLE "+strings.Join(tableNames, ", ")+" RESTART IDENTITY")
-	return err
+		tableNames := make([]string, 0, len(tables))
+		for _, t := range tables {
+			tableNames = append(tableNames, t.TableName())
+		}
+		_, err := db.Exec(context.Background(), "TRUNCATE TABLE "+strings.Join(tableNames, ", ")+" RESTART IDENTITY")
+		if err != nil {
+			t.Errorf("Failed to clear table data: %v", err)
+		}
+	})
 }

cmd/enterprise-portal/internal/database/internal/tables/BUILD.bazel

@@ -0,0 +1,13 @@
+load("@io_bazel_rules_go//go:def.bzl", "go_library")
+
+go_library(
+    name = "tables",
+    srcs = ["tables.go"],
+    importpath = "github.com/sourcegraph/sourcegraph/cmd/enterprise-portal/internal/database/internal/tables",
+    tags = [TAG_INFRA_CORESERVICES],
+    visibility = ["//cmd/enterprise-portal:__subpackages__"],
+    deps = [
+        "//cmd/enterprise-portal/internal/database/subscriptions",
+        "@io_gorm_gorm//schema",
+    ],
+)

cmd/enterprise-portal/internal/database/internal/tables/tables.go

@@ -0,0 +1,16 @@
+package tables
+
+import (
+	"gorm.io/gorm/schema"
+
+	"github.com/sourcegraph/sourcegraph/cmd/enterprise-portal/internal/database/subscriptions"
+)
+
+// All tables provisioned for the Enterprise Portal database are defined here.
+//
+// ⚠️ WARNING: This list is meant to be read-only.
+func All() []schema.Tabler {
+	return []schema.Tabler{
+		&subscriptions.Subscription{},
+	}
+}

cmd/enterprise-portal/internal/database/migrate.go

@@ -19,6 +19,8 @@ import (
 	"github.com/sourcegraph/sourcegraph/lib/errors"
 	"github.com/sourcegraph/sourcegraph/lib/managedservicesplatform/runtime"
 	"github.com/sourcegraph/sourcegraph/lib/redislock"
+
+	"github.com/sourcegraph/sourcegraph/cmd/enterprise-portal/internal/database/internal/tables"
 )
 
 // maybeMigrate runs the auto-migration for the database when needed based on
@@ -96,7 +98,7 @@ func maybeMigrate(ctx context.Context, logger log.Logger, contract runtime.Contr
 				Logger: gormlogger.Default.LogMode(gormlogger.Warn),
 			})
 			// Auto-migrate database table definitions.
-			for _, table := range allTables {
+			for _, table := range tables.All() {
 				err := sess.AutoMigrate(table)
 				if err != nil {
 					return errors.Wrapf(err, "auto migrating table for %s", errors.Safe(fmt.Sprintf("%T", table)))

cmd/enterprise-portal/internal/database/subscriptions/BUILD.bazel

@@ -0,0 +1,33 @@
+load("@io_bazel_rules_go//go:def.bzl", "go_library")
+load("//dev:go_defs.bzl", "go_test")
+
+go_library(
+    name = "subscriptions",
+    srcs = ["subscriptions.go"],
+    importpath = "github.com/sourcegraph/sourcegraph/cmd/enterprise-portal/internal/database/subscriptions",
+    tags = [TAG_INFRA_CORESERVICES],
+    visibility = ["//cmd/enterprise-portal:__subpackages__"],
+    deps = [
+        "//lib/errors",
+        "@com_github_jackc_pgx_v5//:pgx",
+        "@com_github_jackc_pgx_v5//pgxpool",
+    ],
+)
+
+go_test(
+    name = "subscriptions_test",
+    srcs = ["subscriptions_test.go"],
+    tags = [
+        TAG_INFRA_CORESERVICES,
+        "requires-network",
+    ],
+    deps = [
+        ":subscriptions",
+        "//cmd/enterprise-portal/internal/database/databasetest",
+        "//cmd/enterprise-portal/internal/database/internal/tables",
+        "@com_github_google_uuid//:uuid",
+        "@com_github_jackc_pgx_v5//:pgx",
+        "@com_github_stretchr_testify//assert",
+        "@com_github_stretchr_testify//require",
+    ],
+)

cmd/enterprise-portal/internal/database/subscriptions.go renamed to cmd/enterprise-portal/internal/database/subscriptions/subscriptions.go

@@ -1,4 +1,4 @@
-package database
+package subscriptions
 
 import (
 	"context"
@@ -11,7 +11,7 @@ import (
 	"github.com/sourcegraph/sourcegraph/lib/errors"
 )
 
-// Subscription is a product subscription record.
+// Subscription is an Enterprise subscription record.
 type Subscription struct {
 	// ID is the prefixed UUID-format identifier for the subscription.
 	ID string `gorm:"primaryKey"`
@@ -24,13 +24,13 @@ func (s *Subscription) TableName() string {
 	return "enterprise_portal_subscriptions"
 }
 
-// SubscriptionsStore is the storage layer for product subscriptions.
-type SubscriptionsStore struct {
+// Store is the storage layer for product subscriptions.
+type Store struct {
 	db *pgxpool.Pool
 }
 
-func newSubscriptionsStore(db *pgxpool.Pool) *SubscriptionsStore {
-	return &SubscriptionsStore{
+func NewStore(db *pgxpool.Pool) *Store {
+	return &Store{
 		db: db,
 	}
 }
@@ -74,7 +74,7 @@ func (opts ListEnterpriseSubscriptionsOptions) toQueryConditions() (where, limit
 }
 
 // List returns a list of subscriptions based on the given options.
-func (s *SubscriptionsStore) List(ctx context.Context, opts ListEnterpriseSubscriptionsOptions) ([]*Subscription, error) {
+func (s *Store) List(ctx context.Context, opts ListEnterpriseSubscriptionsOptions) ([]*Subscription, error) {
 	where, limit, namedArgs := opts.toQueryConditions()
 	query := fmt.Sprintf(`
 SELECT
@@ -138,7 +138,7 @@ DO UPDATE SET
 }
 
 // Upsert upserts a subscription record based on the given options.
-func (s *SubscriptionsStore) Upsert(ctx context.Context, subscriptionID string, opts UpsertSubscriptionOptions) (*Subscription, error) {
+func (s *Store) Upsert(ctx context.Context, subscriptionID string, opts UpsertSubscriptionOptions) (*Subscription, error) {
 	query, namedArgs := opts.toQuery(subscriptionID)
 	if query != "" {
 		_, err := s.db.Exec(ctx, query, namedArgs)
@@ -151,7 +151,7 @@ func (s *SubscriptionsStore) Upsert(ctx context.Context, subscriptionID string,
 
 // Get returns a subscription record with the given subscription ID. It returns
 // pgx.ErrNoRows if no such subscription exists.
-func (s *SubscriptionsStore) Get(ctx context.Context, subscriptionID string) (*Subscription, error) {
+func (s *Store) Get(ctx context.Context, subscriptionID string) (*Subscription, error) {
 	var subscription Subscription
 	query := `SELECT id, instance_domain FROM enterprise_portal_subscriptions WHERE id = @id`
 	namedArgs := pgx.NamedArgs{"id": subscriptionID}