serverutils: clean up some interfaces

In this commit:

- `TestTenantInterface` renamed to `ApplicationLayerInterface`.

- `TestServerInterface` split into:

  - `StorageLayerInterface` containing most of the methods previously
    in `TestServerInterface`.

  - `TenantControlInterface` with just the methods relating to
    starting the service for secondary tenants.

- Relevant methods moved from `TestServerInterface` to
  `ApplicationLayerInterface`:

  - `ServingSQLAddr()` - renamed to `AdvSQLAddr()`
  - `RPCAddr()`
  - `LeaseManager()`
  - `DistSenderI()`
  - `MigrationServer()`
  - `SetDistSQLSpanResolver()`
  - `CollectionFactory()`
  - `SystemTableIDResolver()`

- Removed `HostSQLAddr()` - use `.SystemLayer().AdvSQLAddr()` instead.

- `AdvSQLAddr()` (previously `ServingSQLAddr()`) was
  simplified to always return the advertised SQL address for the
  current layer.

- Updated comments/docstrings for the interfaces.

Release note: None

Author: knz

pkg/bench/foreachdb.go

@@ -88,7 +88,7 @@ func benchmarkSharedProcessTenantCockroach(b *testing.B, f BenchmarkFn) {
 	require.NoError(b, db.QueryRow(`SELECT id FROM [SHOW TENANT benchtenant]`).Scan(&tenantID))
 
 	err = testutils.SucceedsSoonError(func() error {
-		capabilities, found := s.(*server.TestServer).Server.TenantCapabilitiesReader().GetCapabilities(roachpb.MustMakeTenantID(tenantID))
+		capabilities, found := s.StorageLayer().TenantCapabilitiesReader().GetCapabilities(roachpb.MustMakeTenantID(tenantID))
 		if !found {
 			return errors.Newf("capabilities not yet ready")
 		}

pkg/ccl/auditloggingccl/audit_logging_test.go

@@ -122,7 +122,7 @@ func TestSingleRoleAuditLogging(t *testing.T) {
 	defer s.Stopper().Stop(context.Background())
 
 	testUserURL, cleanupFn := sqlutils.PGUrl(t,
-		s.ServingSQLAddr(), t.Name(), url.User(username.TestUser))
+		s.ApplicationLayer().ServingSQLAddr(), t.Name(), url.User(username.TestUser))
 	defer cleanupFn()
 
 	testUserDb, err := gosql.Open("postgres", testUserURL.String())
@@ -254,7 +254,7 @@ func TestMultiRoleAuditLogging(t *testing.T) {
 	defer s.Stopper().Stop(context.Background())
 
 	testUserURL, cleanupFn := sqlutils.PGUrl(t,
-		s.ServingSQLAddr(), t.Name(), url.User(username.TestUser))
+		s.ApplicationLayer().ServingSQLAddr(), t.Name(), url.User(username.TestUser))
 	defer cleanupFn()
 
 	testUserDb, err := gosql.Open("postgres", testUserURL.String())
@@ -375,7 +375,7 @@ func TestReducedAuditConfig(t *testing.T) {
 	})
 
 	testUserURL, cleanupFn := sqlutils.PGUrl(t,
-		s.ServingSQLAddr(), t.Name(), url.User(username.TestUser))
+		s.ApplicationLayer().ServingSQLAddr(), t.Name(), url.User(username.TestUser))
 	defer cleanupFn()
 
 	testUserDb, err := gosql.Open("postgres", testUserURL.String())

pkg/ccl/backupccl/backup_test.go

@@ -1813,7 +1813,7 @@ func TestBackupRestoreResume(t *testing.T) {
 	const numAccounts = 1000
 	tc, outerDB, dir, cleanupFn := backupRestoreTestSetupWithParams(t, multiNode, numAccounts, InitManualReplication, params)
 	defer cleanupFn()
-	srv := tc.TenantOrServer(0)
+	srv := tc.ApplicationLayer(0)
 	codec := keys.MakeSQLCodec(srv.RPCContext().TenantID)
 	clusterID := srv.RPCContext().LogicalClusterID.Get()
 	backupTableDesc := desctestutils.TestingGetPublicTableDescriptor(tc.Servers[0].DB(), codec, "data", "bank")
@@ -1896,7 +1896,7 @@ func TestBackupRestoreResume(t *testing.T) {
 		sqlDB.Exec(t, `BACKUP DATABASE DATA TO $1`, restoreDir)
 		sqlDB.Exec(t, `CREATE DATABASE restoredb`)
 		restoreDatabaseID := sqlutils.QueryDatabaseID(t, sqlDB.DB, "restoredb")
-		restoreTableID, err := tc.TenantOrServer(0).ExecutorConfig().(sql.ExecutorConfig).DescIDGenerator.GenerateUniqueDescID(ctx)
+		restoreTableID, err := tc.ApplicationLayer(0).ExecutorConfig().(sql.ExecutorConfig).DescIDGenerator.GenerateUniqueDescID(ctx)
 		if err != nil {
 			t.Fatal(err)
 		}
@@ -5441,7 +5441,7 @@ func TestBackupRestoreSequenceOwnership(t *testing.T) {
 	origDB.Exec(t, `BACKUP DATABASE d TO $1`, backupLoc)
 
 	getTableDescriptorFromTestCluster := func(tc *testcluster.TestCluster, database string, table string) catalog.TableDescriptor {
-		srv := tc.TenantOrServer(0)
+		srv := tc.ApplicationLayer(0)
 		return desctestutils.TestingGetPublicTableDescriptor(srv.DB(), srv.Codec(), database, table)
 	}
 
@@ -5844,7 +5844,7 @@ func TestBatchedInsertStats(t *testing.T) {
 	}}
 	server, db, _ := serverutils.StartServer(t, params)
 	defer server.Stopper().Stop(context.Background())
-	s := server.TenantOrServer()
+	s := server.ApplicationLayer()
 	sqlDB := sqlutils.MakeSQLRunner(db)
 	ctx := context.Background()
 	execCfg := s.ExecutorConfig().(sql.ExecutorConfig)
@@ -6393,7 +6393,7 @@ func TestRestoreErrorPropagates(t *testing.T) {
 	runner := sqlutils.MakeSQLRunner(db)
 
 	jobsTableKey.Lock()
-	jobsTableKey.key = tc.TenantOrServer(0).Codec().TablePrefix(uint32(systemschema.JobsTable.GetID()))
+	jobsTableKey.key = tc.ApplicationLayer(0).Codec().TablePrefix(uint32(systemschema.JobsTable.GetID()))
 	jobsTableKey.Unlock()
 
 	runner.Exec(t, `SET CLUSTER SETTING jobs.metrics.interval.poll = '30s'`)
@@ -7513,7 +7513,7 @@ func TestClientDisconnect(t *testing.T) {
 			// Make credentials for the new connection.
 			sqlDB.Exec(t, `CREATE USER testuser`)
 			sqlDB.Exec(t, `GRANT admin TO testuser`)
-			pgURL, cleanup := sqlutils.PGUrl(t, tc.Server(0).ServingSQLAddr(),
+			pgURL, cleanup := sqlutils.PGUrl(t, tc.ApplicationLayer(0).ServingSQLAddr(),
 				"TestClientDisconnect-testuser", url.User("testuser"))
 			defer cleanup()
 
@@ -8620,7 +8620,7 @@ func TestRestoreJobEventLogging(t *testing.T) {
 
 	var forceFailure bool
 	for i := range tc.Servers {
-		tc.TenantOrServer(i).JobRegistry().(*jobs.Registry).TestingWrapResumerConstructor(
+		tc.ApplicationLayer(i).JobRegistry().(*jobs.Registry).TestingWrapResumerConstructor(
 			jobspb.TypeRestore,
 			func(raw jobs.Resumer) jobs.Resumer {
 				r := raw.(*restoreResumer)
@@ -8733,7 +8733,7 @@ func TestBackupOnlyPublicIndexes(t *testing.T) {
 	)
 	defer cleanupFn()
 	kvDB := tc.Server(0).DB()
-	codec := tc.TenantOrServer(0).ExecutorConfig().(sql.ExecutorConfig).Codec
+	codec := tc.ApplicationLayer(0).ExecutorConfig().(sql.ExecutorConfig).Codec
 
 	locationToDir := func(location string) string {
 		return strings.Replace(location, localFoo, filepath.Join(rawDir, "foo"), 1)
@@ -10225,7 +10225,7 @@ func TestBackupNoOverwriteCheckpoint(t *testing.T) {
 
 	// List all the BACKUP-CHECKPOINTS in the progress directory and see
 	// if there are as many as we'd expect if none got overwritten.
-	execCfg := tc.TenantOrServer(0).ExecutorConfig().(sql.ExecutorConfig)
+	execCfg := tc.ApplicationLayer(0).ExecutorConfig().(sql.ExecutorConfig)
 	ctx := context.Background()
 	store, err := execCfg.DistSQLSrv.ExternalStorageFromURI(ctx, "userfile:///a", username.RootUserName())
 	require.NoError(t, err)
@@ -10454,7 +10454,7 @@ func TestBackupRestoreTelemetryEvents(t *testing.T) {
 
 	var forceFailure bool
 	for i := range tc.Servers {
-		tc.TenantOrServer(i).JobRegistry().(*jobs.Registry).TestingWrapResumerConstructor(
+		tc.ApplicationLayer(i).JobRegistry().(*jobs.Registry).TestingWrapResumerConstructor(
 			jobspb.TypeRestore,
 			func(raw jobs.Resumer) jobs.Resumer {
 				r := raw.(*restoreResumer)

pkg/ccl/backupccl/create_scheduled_backup_test.go

@@ -971,7 +971,7 @@ func TestCreateBackupScheduleRequiresAdminRole(t *testing.T) {
 
 	th.sqlDB.Exec(t, `CREATE USER testuser`)
 	pgURL, cleanupFunc := sqlutils.PGUrl(
-		t, th.server.ServingSQLAddr(),
+		t, th.server.ApplicationLayer().ServingSQLAddr(),
 		"TestCreateSchedule-testuser", url.User("testuser"),
 	)
 	defer cleanupFunc()

pkg/ccl/backupccl/datadriven_test.go

@@ -230,7 +230,7 @@ func (d *datadrivenTestState) getSQLDB(t *testing.T, name string, user string) *
 	if db, ok := d.sqlDBs[key]; ok {
 		return db
 	}
-	addr := d.firstNode[name].ServingSQLAddr()
+	addr := d.firstNode[name].ApplicationLayer().ServingSQLAddr()
 	pgURL, cleanup := sqlutils.PGUrl(t, addr, "TestBackupRestoreDataDriven", url.User(user))
 	d.cleanupFns = append(d.cleanupFns, cleanup)
 

pkg/ccl/backupccl/restore_mid_schema_change_test.go

@@ -139,7 +139,7 @@ func validateTable(
 	tableName string,
 	isSchemaOnly bool,
 ) {
-	srv := tc.TenantOrServer(0)
+	srv := tc.ApplicationLayer(0)
 	desc := desctestutils.TestingGetPublicTableDescriptor(srv.DB(), srv.Codec(), dbName, tableName)
 	// There should be no mutations on these table descriptors at this point.
 	require.Equal(t, 0, len(desc.TableDesc().Mutations))

pkg/ccl/backupccl/show_test.go

@@ -681,7 +681,7 @@ func TestShowBackupPrivileges(t *testing.T) {
 	sqlDB.Exec(t, `CREATE USER testuser`)
 	sqlDB.Exec(t, `CREATE TABLE privs (a INT)`)
 
-	pgURL, cleanup := sqlutils.PGUrl(t, srv.ServingSQLAddr(),
+	pgURL, cleanup := sqlutils.PGUrl(t, srv.ApplicationLayer().ServingSQLAddr(),
 		"TestShowBackupPrivileges-testuser", url.User("testuser"))
 	defer cleanup()
 	testuser, err := gosql.Open("postgres", pgURL.String())

pkg/ccl/changefeedccl/alter_changefeed_test.go

@@ -662,7 +662,7 @@ func TestAlterChangefeedPersistSinkURI(t *testing.T) {
 
 	s, rawSQLDB, _ := serverutils.StartServer(t, base.TestServerArgs{})
 	sqlDB := sqlutils.MakeSQLRunner(rawSQLDB)
-	registry := s.TenantOrServer().JobRegistry().(*jobs.Registry)
+	registry := s.ApplicationLayer().JobRegistry().(*jobs.Registry)
 	ctx := context.Background()
 	defer s.Stopper().Stop(ctx)
 

pkg/ccl/changefeedccl/changefeed_test.go

@@ -4345,7 +4345,7 @@ func TestChangefeedSchemaTTL(t *testing.T) {
 	}
 
 	// TODO(samiskin): tenant tests skipped because of forceTableGC not working
-	// with a TestTenantInterface
+	// with a ApplicationLayerInterface
 	cdcTestWithSystem(t, testFn, feedTestNoTenants)
 }
 

pkg/ccl/changefeedccl/helpers_test.go

@@ -472,7 +472,7 @@ func startTestCluster(t testing.TB) (serverutils.TestClusterInterface, *gosql.DB
 }
 
 func waitForTenantPodsActive(
-	t testing.TB, tenantServer serverutils.TestTenantInterface, numPods int,
+	t testing.TB, tenantServer serverutils.ApplicationLayerInterface, numPods int,
 ) {
 	testutils.SucceedsWithin(t, func() error {
 		status := tenantServer.StatusServer().(serverpb.SQLStatusServer)
@@ -490,7 +490,7 @@ func waitForTenantPodsActive(
 
 func startTestTenant(
 	t testing.TB, systemServer serverutils.TestServerInterface, options feedTestOptions,
-) (roachpb.TenantID, serverutils.TestTenantInterface, *gosql.DB, func()) {
+) (roachpb.TenantID, serverutils.ApplicationLayerInterface, *gosql.DB, func()) {
 	knobs := base.TestingKnobs{
 		DistSQL:          &execinfra.TestingKnobs{Changefeed: &TestingKnobs{}},
 		JobsTestingKnobs: jobs.NewTestingKnobsWithShortIntervals(),
@@ -666,7 +666,9 @@ func serverArgsRegion(args base.TestServerArgs) string {
 // expectNotice creates a pretty crude database connection that doesn't involve
 // a lot of cdc test framework, use with caution. Driver-agnostic tools don't
 // have clean ways of inspecting incoming notices.
-func expectNotice(t *testing.T, s serverutils.TestTenantInterface, sql string, expected string) {
+func expectNotice(
+	t *testing.T, s serverutils.ApplicationLayerInterface, sql string, expected string,
+) {
 	url, cleanup := sqlutils.PGUrl(t, s.SQLAddr(), t.Name(), url.User(username.RootUser))
 	defer cleanup()
 	base, err := pq.NewConnector(url.String())
@@ -762,7 +764,7 @@ func closeFeedIgnoreError(t testing.TB, f cdctest.TestFeed) {
 // of a test running as the system tenant or a secondary tenant
 type TestServer struct {
 	DB           *gosql.DB
-	Server       serverutils.TestTenantInterface
+	Server       serverutils.ApplicationLayerInterface
 	Codec        keys.SQLCodec
 	TestingKnobs base.TestingKnobs
 }
@@ -912,7 +914,7 @@ func addCloudStorageOptions(t *testing.T, options *feedTestOptions) (cleanup fun
 func makeFeedFactory(
 	t *testing.T,
 	sinkType string,
-	s serverutils.TestTenantInterface,
+	s serverutils.ApplicationLayerInterface,
 	db *gosql.DB,
 	testOpts ...feedTestOption,
 ) (factory cdctest.TestFeedFactory, sinkCleanup func()) {
@@ -924,9 +926,9 @@ func makeFeedFactoryWithOptions(
 	t *testing.T, sinkType string, srvOrCluster interface{}, db *gosql.DB, options feedTestOptions,
 ) (factory cdctest.TestFeedFactory, sinkCleanup func()) {
 	t.Logf("making %s feed factory", sinkType)
-	s := func() serverutils.TestTenantInterface {
+	s := func() serverutils.ApplicationLayerInterface {
 		switch s := srvOrCluster.(type) {
-		case serverutils.TestTenantInterface:
+		case serverutils.ApplicationLayerInterface:
 			return s
 		case serverutils.TestClusterInterface:
 			return s.Server(0)
@@ -1007,7 +1009,7 @@ func makeFeedFactoryWithOptions(
 }
 
 func getInitialDBForEnterpriseFactory(
-	t *testing.T, s serverutils.TestTenantInterface, rootDB *gosql.DB, opts feedTestOptions,
+	t *testing.T, s serverutils.ApplicationLayerInterface, rootDB *gosql.DB, opts feedTestOptions,
 ) (*gosql.DB, func()) {
 	// Instead of creating enterprise changefeeds on the root connection, we may
 	// choose to create them on a test user connection. This user should have the