Skip to content

release-25.4: backup: improve datadriven test cleanup #155113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 10, 2025
Merged

release-25.4: backup: improve datadriven test cleanup #155113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 24 additions & 15 deletions pkg/backup/datadriven_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ import (
"github.com/cockroachdb/cockroach/pkg/testutils/serverutils"
"github.com/cockroachdb/cockroach/pkg/testutils/skip"
"github.com/cockroachdb/cockroach/pkg/testutils/sqlutils"
"github.com/cockroachdb/cockroach/pkg/util/ctxgroup"
"github.com/cockroachdb/datadriven"
"github.com/cockroachdb/errors"
"github.com/lib/pq"
Expand Down Expand Up @@ -91,10 +92,9 @@ type sqlDBKey struct {

type datadrivenTestState struct {
// cluster maps the user defined cluster name to its cluster
clusters map[string]serverutils.TestClusterInterface
clusters map[string]serverutils.TestClusterInterface
clusterCleanup []func()

// firstNode maps the cluster name to the first node in the cluster
firstNode map[string]serverutils.TestServerInterface
dataDirs map[string]string
sqlDBs map[sqlDBKey]*gosql.DB
jobTags map[string]jobspb.JobID
Expand All @@ -107,7 +107,6 @@ type datadrivenTestState struct {
func newDatadrivenTestState() datadrivenTestState {
return datadrivenTestState{
clusters: make(map[string]serverutils.TestClusterInterface),
firstNode: make(map[string]serverutils.TestServerInterface),
dataDirs: make(map[string]string),
sqlDBs: make(map[sqlDBKey]*gosql.DB),
jobTags: make(map[string]jobspb.JobID),
Expand All @@ -120,16 +119,27 @@ func (d *datadrivenTestState) cleanup(ctx context.Context, t *testing.T) {
// While the testCluster cleanupFns would close the dbConn and clusters, close
// them manually to ensure all queries finish on tests that share these
// resources.
for _, f := range d.cleanupFns {
f()
}

for _, db := range d.sqlDBs {
backuptestutils.CheckForInvalidDescriptors(t, db)
db.Close()
}
for _, s := range d.firstNode {
s.Stopper().Stop(ctx)
}
for _, f := range d.cleanupFns {
f()

// Clean up the clusters in parallel so that if one gets stuck we don't see
// goroutines for running clusters mixed in with goroutines for the stuck
// cluster.
group := ctxgroup.WithContext(ctx)
for _, cleanup := range d.clusterCleanup {
group.Go(func() error {
cleanup()
return nil
})
}
require.NoError(t, group.Wait())

d.noticeBuffer = nil
}

Expand Down Expand Up @@ -223,9 +233,8 @@ func (d *datadrivenTestState) addCluster(t *testing.T, cfg clusterCfg) error {
var cleanup func()
tc, _, cfg.iodir, cleanup = backuptestutils.StartBackupRestoreTestCluster(t, clusterSize, opts...)
d.clusters[cfg.name] = tc
d.firstNode[cfg.name] = tc.Server(0)
d.dataDirs[cfg.name] = cfg.iodir
d.cleanupFns = append(d.cleanupFns, cleanup)
d.clusterCleanup = append(d.clusterCleanup, cleanup)

return nil
}
Expand Down Expand Up @@ -262,15 +271,15 @@ func (d *datadrivenTestState) getSQLDBForVC(
serverutils.User(user),
}

s := d.firstNode[name].ApplicationLayer()
s := d.clusters[name].ApplicationLayer(0)
switch vc {
case "default":
// Nothing to do.
case "system":
// We use the system layer since in the case of
// external SQL server's the application layer can't
// route to the system tenant.
s = d.firstNode[name].SystemLayer()
s = d.clusters[name].SystemLayer(0)
default:
opts = append(opts, serverutils.DBName("cluster:"+vc))
}
Expand Down Expand Up @@ -956,7 +965,7 @@ func runTestDataDriven(t *testing.T, testFilePathFromWorkspace string) {
return ""

case "create-dummy-system-table":
al := ds.firstNode[lastCreatedCluster].ApplicationLayer()
al := ds.clusters[lastCreatedCluster].ApplicationLayer(0)
db := al.DB()
execCfg := al.ExecutorConfig().(sql.ExecutorConfig)
codec := execCfg.Codec
Expand Down Expand Up @@ -1037,7 +1046,7 @@ func handleKVRequest(
},
UseRangeTombstone: true,
}
if _, err := kv.SendWrapped(ctx, ds.firstNode[cluster].SystemLayer().DistSenderI().(*kvcoord.DistSender), &dr); err != nil {
if _, err := kv.SendWrapped(ctx, ds.clusters[cluster].SystemLayer(0).DistSenderI().(*kvcoord.DistSender), &dr); err != nil {
t.Fatal(err)
}
} else {
Expand Down