Skip to content

Commit e498a88

Browse files
committed
sql: remove mostly unused return argument from test helper method
`createTestServerParams` previously returned two arguments, but the second one was only used in a handful of places, and this commit removes it. `createTestServerParamsWithCommandFilters` is now called wherever that second return argument is actually used. Additionally, we now inline the calls to `createTestServerParams` wherever possible and remove some stale comments. Release note: None
1 parent 755f098 commit e498a88

35 files changed

+225
-267
lines changed

pkg/sql/as_of_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ func TestAsOfTime(t *testing.T) {
3030
defer log.Scope(t).Close(t)
3131

3232
ctx, cancel := context.WithCancel(context.Background())
33-
params, _ := createTestServerParams()
33+
params := createTestServerParams()
3434
params.Knobs.GCJob = &sql.GCJobTestingKnobs{RunBeforeResume: func(_ jobspb.JobID) error {
3535
<-ctx.Done()
3636
return nil
@@ -263,7 +263,7 @@ func TestAsOfRetry(t *testing.T) {
263263
defer leaktest.AfterTest(t)()
264264
defer log.Scope(t).Close(t)
265265

266-
params, cmdFilters := createTestServerParams()
266+
params, cmdFilters := createTestServerParamsWithCommandFilters()
267267
s, sqlDB, _ := serverutils.StartServer(t, params)
268268
defer s.Stopper().Stop(context.Background())
269269

pkg/sql/comment_on_column_test.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,7 @@ func runCommentOnTestsDeclarativeOnly(t *testing.T, testFunc func(db *gosql.DB))
225225
}
226226

227227
func runOneCommentOnTest(t *testing.T, setupQuery string, testFunc func(db *gosql.DB)) {
228-
params, _ := createTestServerParams()
229-
s, db, _ := serverutils.StartServer(t, params)
228+
s, db, _ := serverutils.StartServer(t, createTestServerParams())
230229
defer s.Stopper().Stop(context.Background())
231230
_, err := db.Exec(setupQuery)
232231
require.NoError(t, err)

pkg/sql/conn_executor_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ func TestSessionFinishRollsBackTxn(t *testing.T) {
7777
defer log.Scope(t).Close(t)
7878
aborter := NewTxnAborter()
7979
defer aborter.Close(t)
80-
params, _ := createTestServerParams()
80+
params := createTestServerParams()
8181
params.Knobs.SQLExecutor = aborter.executorKnobs()
8282
srv, mainDB, _ := serverutils.StartServer(t, params)
8383
defer srv.Stopper().Stop(context.Background())
@@ -369,7 +369,7 @@ func TestHalloweenProblemAvoidance(t *testing.T) {
369369
defer mutations.ResetMaxBatchSizeForTests()
370370
numRows := smallerKvBatchSize + smallerInsertBatchSize + 10
371371

372-
params, _ := createTestServerParams()
372+
params := createTestServerParams()
373373
params.Insecure = true
374374
params.Knobs.DistSQL = &execinfra.TestingKnobs{
375375
TableReaderBatchBytesLimit: 10,
@@ -440,7 +440,7 @@ func TestAppNameStatisticsInitialization(t *testing.T) {
440440
defer leaktest.AfterTest(t)()
441441
defer log.Scope(t).Close(t)
442442

443-
params, _ := createTestServerParams()
443+
params := createTestServerParams()
444444
params.Insecure = true
445445

446446
s := serverutils.StartServerOnly(t, params)

pkg/sql/crdb_internal_test.go

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,7 @@ func TestGetAllNamesInternal(t *testing.T) {
8383
defer log.Scope(t).Close(t)
8484

8585
ctx := context.Background()
86-
params, _ := createTestServerParams()
87-
88-
s, _ /* sqlDB */, kvDB := serverutils.StartServer(t, params)
86+
s, _ /* sqlDB */, kvDB := serverutils.StartServer(t, createTestServerParams())
8987
defer s.Stopper().Stop(ctx)
9088

9189
err := kvDB.Txn(ctx, func(ctx context.Context, txn *kv.Txn) error {
@@ -169,8 +167,7 @@ func TestGossipAlertsTable(t *testing.T) {
169167
defer leaktest.AfterTest(t)()
170168
defer log.Scope(t).Close(t)
171169

172-
params, _ := createTestServerParams()
173-
s := serverutils.StartServerOnly(t, params)
170+
s := serverutils.StartServerOnly(t, createTestServerParams())
174171
defer s.Stop(context.Background())
175172
ctx := context.Background()
176173

@@ -210,8 +207,7 @@ func TestOldBitColumnMetadata(t *testing.T) {
210207
defer log.Scope(t).Close(t)
211208

212209
ctx := context.Background()
213-
params, _ := createTestServerParams()
214-
s, sqlDB, kvDB := serverutils.StartServer(t, params)
210+
s, sqlDB, kvDB := serverutils.StartServer(t, createTestServerParams())
215211
defer s.Stopper().Stop(ctx)
216212

217213
// The descriptor changes made must have an immediate effect
@@ -428,7 +424,7 @@ func TestInvalidObjects(t *testing.T) {
428424
defer log.Scope(t).Close(t)
429425

430426
ctx := context.Background()
431-
params, _ := createTestServerParams()
427+
params := createTestServerParams()
432428
params.Knobs = base.TestingKnobs{
433429
Store: &kvserver.StoreTestingKnobs{
434430
DisableMergeQueue: true,

pkg/sql/create_test.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,8 +244,7 @@ func TestParallelCreateConflictingTables(t *testing.T) {
244244
func TestTableReadErrorsBeforeTableCreation(t *testing.T) {
245245
defer leaktest.AfterTest(t)()
246246
defer log.Scope(t).Close(t)
247-
params, _ := createTestServerParams()
248-
s, sqlDB, _ := serverutils.StartServer(t, params)
247+
s, sqlDB, _ := serverutils.StartServer(t, createTestServerParams())
249248
defer s.Stopper().Stop(context.Background())
250249

251250
if _, err := sqlDB.Exec(`

pkg/sql/delete_preserving_index_test.go

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ import (
5757
func TestDeletePreservingIndexEncoding(t *testing.T) {
5858
defer leaktest.AfterTest(t)()
5959
defer log.Scope(t).Close(t)
60-
params, _ := createTestServerParams()
60+
params := createTestServerParams()
6161
mergeFinished := make(chan struct{})
6262
completeSchemaChange := make(chan struct{})
6363
errorChan := make(chan error, 1)
@@ -246,8 +246,7 @@ func TestDeletePreservingIndexEncodingUsesNormalDeletesInDeleteOnly(t *testing.T
246246
defer leaktest.AfterTest(t)()
247247
defer log.Scope(t).Close(t)
248248

249-
params, _ := createTestServerParams()
250-
server, sqlDB, kvDB := serverutils.StartServer(t, params)
249+
server, sqlDB, kvDB := serverutils.StartServer(t, createTestServerParams())
251250
defer server.Stopper().Stop(context.Background())
252251

253252
// The descriptor changes made must have an immediate effect
@@ -311,8 +310,7 @@ func TestDeletePreservingIndexEncodingWithEmptyValues(t *testing.T) {
311310
defer leaktest.AfterTest(t)()
312311
defer log.Scope(t).Close(t)
313312

314-
params, _ := createTestServerParams()
315-
server, sqlDB, kvDB := serverutils.StartServer(t, params)
313+
server, sqlDB, kvDB := serverutils.StartServer(t, createTestServerParams())
316314
defer server.Stopper().Stop(context.Background())
317315

318316
// The descriptor changes made must have an immediate effect
@@ -515,8 +513,6 @@ func TestMergeProcessor(t *testing.T) {
515513
defer log.Scope(t).Close(t)
516514
ctx := context.Background()
517515

518-
params, _ := createTestServerParams()
519-
520516
type TestCase struct {
521517
name string
522518
setupSQL string
@@ -611,7 +607,7 @@ func TestMergeProcessor(t *testing.T) {
611607
}
612608

613609
run := func(t *testing.T, test TestCase) {
614-
server, tdb, kvDB := serverutils.StartServer(t, params)
610+
server, tdb, kvDB := serverutils.StartServer(t, createTestServerParams())
615611
defer server.Stopper().Stop(context.Background())
616612
defer lease.TestingDisableTableLeases()()
617613

pkg/sql/descriptor_mutation_test.go

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -165,9 +165,7 @@ func TestUpsertWithColumnMutationAndNotNullDefault(t *testing.T) {
165165
// no job associated with the added mutations, those mutations stay on the
166166
// table descriptor but don't do anything, which is what we want.
167167

168-
// Disable external processing of mutations.
169-
params, _ := createTestServerParams()
170-
server, sqlDB, kvDB := serverutils.StartServer(t, params)
168+
server, sqlDB, kvDB := serverutils.StartServer(t, createTestServerParams())
171169
ctx := context.Background()
172170
defer server.Stopper().Stop(ctx)
173171
// The descriptor changes made must have an immediate effect
@@ -227,8 +225,7 @@ func TestOperationsWithColumnMutation(t *testing.T) {
227225

228226
// Disable external processing of mutations.
229227
ctx := context.Background()
230-
params, _ := createTestServerParams()
231-
server, sqlDB, kvDB := serverutils.StartServer(t, params)
228+
server, sqlDB, kvDB := serverutils.StartServer(t, createTestServerParams())
232229
defer server.Stopper().Stop(ctx)
233230
sqlRunner := sqlutils.MakeSQLRunner(sqlDB)
234231

@@ -494,9 +491,7 @@ func TestOperationsWithIndexMutation(t *testing.T) {
494491
// no job associated with the added mutations, those mutations stay on the
495492
// table descriptor but don't do anything, which is what we want.
496493

497-
// Disable external processing of mutations.
498-
params, _ := createTestServerParams()
499-
server, sqlDB, kvDB := serverutils.StartServer(t, params)
494+
server, sqlDB, kvDB := serverutils.StartServer(t, createTestServerParams())
500495
defer server.Stopper().Stop(context.Background())
501496
sqlRunner := sqlutils.MakeSQLRunner(sqlDB)
502497
// The descriptor changes made must have an immediate effect.
@@ -661,8 +656,7 @@ func TestOperationsWithColumnAndIndexMutation(t *testing.T) {
661656
// no job associated with the added mutations, those mutations stay on the
662657
// table descriptor but don't do anything, which is what we want.
663658

664-
params, _ := createTestServerParams()
665-
server, sqlDB, kvDB := serverutils.StartServer(t, params)
659+
server, sqlDB, kvDB := serverutils.StartServer(t, createTestServerParams())
666660
ctx := context.Background()
667661
defer server.Stopper().Stop(ctx)
668662
sqlRunner := sqlutils.MakeSQLRunner(sqlDB)
@@ -877,7 +871,7 @@ func TestSchemaChangeCommandsWithPendingMutations(t *testing.T) {
877871
defer leaktest.AfterTest(t)()
878872
defer log.Scope(t).Close(t)
879873
// Disable external processing of mutations.
880-
params, _ := createTestServerParams()
874+
params := createTestServerParams()
881875
params.Knobs = base.TestingKnobs{
882876
SQLSchemaChanger: &sql.SchemaChangerTestingKnobs{
883877
SchemaChangeJobNoOp: func() bool {
@@ -1101,7 +1095,7 @@ func TestTableMutationQueue(t *testing.T) {
11011095
defer log.Scope(t).Close(t)
11021096
// Disable synchronous and asynchronous schema change processing so that
11031097
// the mutations get queued up.
1104-
params, _ := createTestServerParams()
1098+
params := createTestServerParams()
11051099
params.Knobs = base.TestingKnobs{
11061100
SQLSchemaChanger: &sql.SchemaChangerTestingKnobs{
11071101
SchemaChangeJobNoOp: func() bool {
@@ -1218,8 +1212,7 @@ func TestAddingFKs(t *testing.T) {
12181212
defer leaktest.AfterTest(t)()
12191213
defer log.Scope(t).Close(t)
12201214

1221-
params, _ := createTestServerParams()
1222-
s, sqlDB, kvDB := serverutils.StartServer(t, params)
1215+
s, sqlDB, kvDB := serverutils.StartServer(t, createTestServerParams())
12231216
defer s.Stopper().Stop(context.Background())
12241217

12251218
if _, err := sqlDB.Exec(`

pkg/sql/drop_test.go

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ func descExists(sqlDB *gosql.DB, exists bool, id descpb.ID) error {
101101
func TestDropDatabase(t *testing.T) {
102102
defer leaktest.AfterTest(t)()
103103
defer log.Scope(t).Close(t)
104-
params, _ := createTestServerParams()
104+
params := createTestServerParams()
105105
ctx, cancel := context.WithCancel(context.Background())
106106
params.Knobs.GCJob = &sql.GCJobTestingKnobs{
107107
RunBeforeResume: func(jobID jobspb.JobID) error {
@@ -262,7 +262,7 @@ CREATE DATABASE t;
262262
func TestDropDatabaseDeleteData(t *testing.T) {
263263
defer leaktest.AfterTest(t)()
264264
defer log.Scope(t).Close(t)
265-
params, _ := createTestServerParams()
265+
params := createTestServerParams()
266266
params.DefaultTestTenant = base.TestDoesNotWorkWithSecondaryTenantsButWeDontKnowWhyYet(156127)
267267
// Speed up mvcc queue scan.
268268
params.ScanMaxIdleTime = time.Millisecond
@@ -446,7 +446,7 @@ func TestDropIndex(t *testing.T) {
446446
defer log.Scope(t).Close(t)
447447

448448
const chunkSize = 200
449-
params, _ := createTestServerParams()
449+
params := createTestServerParams()
450450
params.Knobs = base.TestingKnobs{
451451
SQLSchemaChanger: &sql.SchemaChangerTestingKnobs{
452452
BackfillChunkSize: chunkSize,
@@ -561,7 +561,7 @@ func TestDropIndexWithZoneConfigOSS(t *testing.T) {
561561
const chunkSize = 200
562562
const numRows = 2*chunkSize + 1
563563

564-
params, _ := createTestServerParams()
564+
params := createTestServerParams()
565565
params.Knobs = base.TestingKnobs{
566566
SQLSchemaChanger: &sql.SchemaChangerTestingKnobs{BackfillChunkSize: chunkSize},
567567
}
@@ -626,7 +626,7 @@ func TestDropTable(t *testing.T) {
626626
defer leaktest.AfterTest(t)()
627627
defer log.Scope(t).Close(t)
628628

629-
params, _ := createTestServerParams()
629+
params := createTestServerParams()
630630
ctx, cancel := context.WithCancel(context.Background())
631631
params.Knobs.GCJob = &sql.GCJobTestingKnobs{
632632
RunBeforeResume: func(jobID jobspb.JobID) error {
@@ -729,7 +729,8 @@ func TestDropTable(t *testing.T) {
729729
func TestDropTableDeleteData(t *testing.T) {
730730
defer leaktest.AfterTest(t)()
731731
defer log.Scope(t).Close(t)
732-
params, _ := createTestServerParams()
732+
733+
params := createTestServerParams()
733734
// Speed up mvcc queue scan.
734735
params.ScanMaxIdleTime = time.Millisecond
735736

@@ -891,7 +892,7 @@ func TestDropTableWhileUpgradingFormat(t *testing.T) {
891892

892893
ctx := context.Background()
893894

894-
params, _ := createTestServerParams()
895+
params := createTestServerParams()
895896
params.ScanMaxIdleTime = time.Millisecond
896897
srv, sqlDBRaw, kvDB := serverutils.StartServer(t, params)
897898
defer srv.Stopper().Stop(ctx)
@@ -970,8 +971,8 @@ func TestDropTableWhileUpgradingFormat(t *testing.T) {
970971
func TestDropTableInTxn(t *testing.T) {
971972
defer leaktest.AfterTest(t)()
972973
defer log.Scope(t).Close(t)
973-
params, _ := createTestServerParams()
974-
s, sqlDB, _ := serverutils.StartServer(t, params)
974+
975+
s, sqlDB, _ := serverutils.StartServer(t, createTestServerParams())
975976
defer s.Stopper().Stop(context.Background())
976977

977978
if _, err := sqlDB.Exec(`
@@ -1010,7 +1011,7 @@ CREATE TABLE t.kv (k CHAR PRIMARY KEY, v CHAR);
10101011
func TestDropAndCreateTable(t *testing.T) {
10111012
defer leaktest.AfterTest(t)()
10121013
defer log.Scope(t).Close(t)
1013-
params, _ := createTestServerParams()
1014+
params := createTestServerParams()
10141015
params.UseDatabase = "test"
10151016
s, db, _ := serverutils.StartServer(t, params)
10161017
defer s.Stopper().Stop(context.Background())
@@ -1054,7 +1055,7 @@ func TestCommandsWhileTableBeingDropped(t *testing.T) {
10541055
defer leaktest.AfterTest(t)()
10551056
defer log.Scope(t).Close(t)
10561057

1057-
params, _ := createTestServerParams()
1058+
params := createTestServerParams()
10581059
// Block schema changers so that the table we're about to DROP is not
10591060
// actually dropped; it will be left in the "deleted" state.
10601061
params.Knobs = base.TestingKnobs{
@@ -1249,8 +1250,7 @@ func TestDropIndexOnHashShardedIndexWithStoredShardColumn(t *testing.T) {
12491250

12501251
// Start a test server and connect to it with notice handler (so we can get and check notices from running queries).
12511252
ctx := context.Background()
1252-
params, _ := createTestServerParams()
1253-
srv := serverutils.StartServerOnly(t, params)
1253+
srv := serverutils.StartServerOnly(t, createTestServerParams())
12541254
defer srv.Stopper().Stop(ctx)
12551255

12561256
s := srv.ApplicationLayer()
@@ -1333,8 +1333,8 @@ func TestDropIndexOnHashShardedIndexWithStoredShardColumn(t *testing.T) {
13331333
func TestDropDatabaseWithForeignKeys(t *testing.T) {
13341334
defer leaktest.AfterTest(t)()
13351335
defer log.Scope(t).Close(t)
1336-
params, _ := createTestServerParams()
1337-
srv, sqlDB, kvDB := serverutils.StartServer(t, params)
1336+
1337+
srv, sqlDB, kvDB := serverutils.StartServer(t, createTestServerParams())
13381338
defer srv.Stopper().Stop(context.Background())
13391339

13401340
s := srv.ApplicationLayer()
@@ -1393,9 +1393,8 @@ ORDER BY
13931393
func TestDropPhysicalTableGC(t *testing.T) {
13941394
defer leaktest.AfterTest(t)()
13951395
defer log.Scope(t).Close(t)
1396-
params, _ := createTestServerParams()
13971396

1398-
s, sqlDB, kvDB := serverutils.StartServer(t, params)
1397+
s, sqlDB, kvDB := serverutils.StartServer(t, createTestServerParams())
13991398
defer s.Stopper().Stop(context.Background())
14001399
_, err := sqlDB.Exec(`CREATE DATABASE test;`)
14011400
require.NoError(t, err)

pkg/sql/err_count_test.go

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ func TestErrorCounts(t *testing.T) {
2525

2626
telemetry.GetFeatureCounts(telemetry.Raw, telemetry.ResetCounts)
2727

28-
params, _ := createTestServerParams()
29-
s, db, _ := serverutils.StartServer(t, params)
28+
s, db, _ := serverutils.StartServer(t, createTestServerParams())
3029
defer s.Stopper().Stop(context.Background())
3130

3231
count1 := telemetry.GetRawFeatureCounts()["errorcodes."+pgcode.Syntax.String()]
@@ -69,8 +68,7 @@ func TestTransactionRetryErrorCounts(t *testing.T) {
6968
// in pgwire (pgwire.convertToErrWithPGCode). Make sure we're
7069
// reporting errors at a level that allows this code to be recorded.
7170

72-
params, _ := createTestServerParams()
73-
s, db, _ := serverutils.StartServer(t, params)
71+
s, db, _ := serverutils.StartServer(t, createTestServerParams())
7472
defer s.Stopper().Stop(context.Background())
7573

7674
if _, err := db.Exec("CREATE TABLE accounts (id INT8 PRIMARY KEY, balance INT8)"); err != nil {

pkg/sql/explain_test.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -540,8 +540,7 @@ func TestExplainRedact(t *testing.T) {
540540
rng, seed := randutil.NewTestRand()
541541
t.Log("seed:", seed)
542542

543-
params, _ := createTestServerParams()
544-
srv, sqlDB, _ := serverutils.StartServer(t, params)
543+
srv, sqlDB, _ := serverutils.StartServer(t, createTestServerParams())
545544
defer srv.Stopper().Stop(ctx)
546545

547546
conn, err := sqlDB.Conn(ctx)

0 commit comments

Comments
 (0)