scplan: make schedule ID output deterministic in tests

Release note: None

Author: rafiss

pkg/sql/GEMINI.md

@@ -365,6 +365,7 @@ object RowLevelTTL
 RowLevelTTL :  TableID
 RowLevelTTL :  RowLevelTTL
 RowLevelTTL :  TTLExpr
+RowLevelTTL :  SeqNum
 
 object Schema
 

pkg/sql/schemachanger/scpb/uml/table.puml

@@ -50,6 +50,7 @@ go_test(
         ":scplan",
         "//pkg/base",
         "//pkg/ccl",
+        "//pkg/jobs/jobspb",
         "//pkg/security/securityassets",
         "//pkg/security/securitytest",
         "//pkg/server",

pkg/sql/schemachanger/scplan/BUILD.bazel

@@ -15,6 +15,7 @@ import (
 
 	"github.com/cockroachdb/cockroach/pkg/base"
 	"github.com/cockroachdb/cockroach/pkg/ccl"
+	"github.com/cockroachdb/cockroach/pkg/jobs/jobspb"
 	"github.com/cockroachdb/cockroach/pkg/sql"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/descpb"
 	"github.com/cockroachdb/cockroach/pkg/sql/parser"
@@ -200,9 +201,28 @@ func marshalDeps(t *testing.T, plan *scplan.Plan) string {
 	return stages.String()
 }
 
+// normalizeScheduleID maps non-deterministic schedule IDs to deterministic
+// sequential values for test output stability. Each unique non-zero schedule
+// ID gets mapped to the next available placeholder value (1, 2, 3, ...).
+func normalizeScheduleID(
+	scheduleIDMap map[jobspb.ScheduleID]jobspb.ScheduleID, id jobspb.ScheduleID,
+) jobspb.ScheduleID {
+	if id == 0 {
+		return 0
+	}
+	if mapped, ok := scheduleIDMap[id]; ok {
+		return mapped
+	}
+	nextID := jobspb.ScheduleID(len(scheduleIDMap) + 1)
+	scheduleIDMap[id] = nextID
+	return nextID
+}
+
 // marshalOps marshals operations in scplan.Plan to a string.
 func marshalOps(t *testing.T, ts scpb.TargetState, stages []scstage.Stage) string {
 	var sb strings.Builder
+	// Map non-deterministic schedule IDs to deterministic sequential values.
+	scheduleIDMap := make(map[jobspb.ScheduleID]jobspb.ScheduleID)
 	for _, stage := range stages {
 		sb.WriteString(stage.String())
 		sb.WriteString("\n  transitions:\n")
@@ -235,6 +255,18 @@ func marshalOps(t *testing.T, ts scpb.TargetState, stages []scstage.Stage) strin
 				clone.State = scpb.DescriptorState{}
 				op = &clone
 			}
+			if upsertTTLOp, ok := op.(*scop.UpsertRowLevelTTL); ok {
+				// Normalize the ScheduleID since it is non-deterministic.
+				clone := *upsertTTLOp
+				clone.RowLevelTTL.ScheduleID = normalizeScheduleID(scheduleIDMap, clone.RowLevelTTL.ScheduleID)
+				op = &clone
+			}
+			if updateCronOp, ok := op.(*scop.UpdateTTLScheduleCron); ok {
+				// Normalize the ScheduleID since it is non-deterministic.
+				clone := *updateCronOp
+				clone.ScheduleID = normalizeScheduleID(scheduleIDMap, clone.ScheduleID)
+				op = &clone
+			}
 			opMap, err := scgraphviz.ToMap(op)
 			require.NoError(t, err)
 			data, err := yaml.Marshal(opMap)

pkg/sql/schemachanger/scplan/plan_test.go

@@ -232,7 +232,7 @@ StatementPhase stage 1 of 1 with 1 MutationType op
     *scop.UpsertRowLevelTTL
       RowLevelTTL:
         ExpirationExpr: ts
-        ScheduleID: 1131801715215400961
+        ScheduleID: 1
         SelectRateLimit: 10
       TTLExpr:
         expr: ts
@@ -254,7 +254,7 @@ PreCommitPhase stage 2 of 2 with 1 MutationType op
     *scop.UpsertRowLevelTTL
       RowLevelTTL:
         ExpirationExpr: ts
-        ScheduleID: 1131801715215400961
+        ScheduleID: 1
         SelectRateLimit: 10
       TTLExpr:
         expr: ts
@@ -263,7 +263,7 @@ PreCommitPhase stage 2 of 2 with 1 MutationType op
       TableID: 107
 
 ops
-ALTER TABLE ttl_table SET (ttl_job_cron = '0 0 * * *');
+ALTER TABLE ttl_table SET (ttl_select_rate_limit = 10, ttl_job_cron = '0 0 * * *');
 ----
 StatementPhase stage 1 of 1 with 1 MutationType op
   transitions:
@@ -274,7 +274,8 @@ StatementPhase stage 1 of 1 with 1 MutationType op
       RowLevelTTL:
         DeletionCron: 0 0 * * *
         ExpirationExpr: ts
-        ScheduleID: 1131801715215400961
+        ScheduleID: 1
+        SelectRateLimit: 10
       TTLExpr:
         expr: ts
         referencedColumnIds:
@@ -296,13 +297,14 @@ PreCommitPhase stage 2 of 2 with 2 MutationType ops
       RowLevelTTL:
         DeletionCron: 0 0 * * *
         ExpirationExpr: ts
-        ScheduleID: 1131801715215400961
+        ScheduleID: 1
+        SelectRateLimit: 10
       TTLExpr:
         expr: ts
         referencedColumnIds:
         - 2
       TableID: 107
     *scop.UpdateTTLScheduleCron
       NewCronExpr: 0 0 * * *
-      ScheduleID: 1131801715215400961
+      ScheduleID: 1
       TableID: 107

pkg/sql/schemachanger/scplan/testdata/alter_table_set_storage_param

@@ -254,6 +254,8 @@ func checkExplainDiagrams(
 		require.NoError(t, err)
 		out, err := fn()
 		require.NoError(t, err)
+		// Normalize non-deterministic values in the explain output.
+		out = replaceNonDeterministicOutput(out)
 		_, err = io.WriteString(file, out)
 		require.NoError(t, err)
 	}
@@ -296,12 +298,21 @@ func checkExplainDiagrams(
 // scheduleIDRegexp captures either `scheduleId: 384784` or `scheduleId: "374764"`.
 var scheduleIDRegexp = regexp.MustCompile(`scheduleId: "?[0-9]+"?`)
 
+// scheduleIDJSONRegexp captures `"ScheduleID":1234567890` in JSON output.
+var scheduleIDJSONRegexp = regexp.MustCompile(`"ScheduleID":[0-9]+`)
+
+// scheduleIDLogRegexp captures `#1234567890` schedule IDs in log output like
+// "update ttl schedule cron #1234567890 to ...".
+var scheduleIDLogRegexp = regexp.MustCompile(`(update ttl schedule cron )#[0-9]+`)
+
 // dropTimeRegexp captures either `dropTime: \"time\"`.
 var dropTimeRegexp = regexp.MustCompile("dropTime: \"[0-9]+")
 
 func replaceNonDeterministicOutput(text string) string {
 	// scheduleIDs change based on execution time, so redact the output.
 	nextString := scheduleIDRegexp.ReplaceAllString(text, "scheduleId: <redacted>")
+	nextString = scheduleIDJSONRegexp.ReplaceAllString(nextString, `"ScheduleID":<redacted>`)
+	nextString = scheduleIDLogRegexp.ReplaceAllString(nextString, "${1}#<redacted>")
 	return dropTimeRegexp.ReplaceAllString(nextString, "dropTime: <redacted>")
 }