Merge #153688

153688: asim: fix more one-off formatting with rand output r=tbg a=wenyihu6

Rebased on top of #153545. Only the last commit is for this PR. 
Informs: #153572
Release note: none 

----

Previously, some of the rand testing output formats were one-off because "\t"
wasn’t explicitly passed by the caller, and the same string functions were
reused for both random and non-random output. This commit fixes that by
explicitly passing a tag for strings, giving the caller control over the number
of tabs.

Co-authored-by: wenyihu6 <wenyi@cockroachlabs.com>

Author: craig[bot]

pkg/kv/kvserver/asim/gen/event_generator.go

@@ -20,9 +20,9 @@ type EventGen interface {
 	// Generate returns an eventExecutor storing a sorted list of events and
 	// being ready execute events for the simulation execution.
 	Generate(seed int64, settings *config.SimulationSettings) scheduled.EventExecutor
-	// String returns the concise string representation of the event executor,
-	// detailing the number of scheduled events.
-	String() string
+	// StringWithTag returns the concise string representation of the event
+	// executor, detailing the number of scheduled events.
+	StringWithTag(tag string) string
 }
 
 // StaticEvents implements the EventGen interface. For proper initialization,
@@ -85,14 +85,14 @@ func (se StaticEvents) ScheduleMutationWithAssertionEvent(
 
 }
 
-// String returns the concise string representation of the event executor,
-// detailing the number of scheduled events.
-func (se StaticEvents) String() string {
+// StringWithTag returns the concise string representation of the event
+// executor, detailing the number of scheduled events.
+func (se StaticEvents) StringWithTag(tag string) string {
 	if se.eventExecutor == nil {
 		panic("StaticEvents.eventExecutor is a nil interface; " +
 			"use NewStaticEventsWithNoEvents for proper initialization.")
 	}
-	return se.eventExecutor.PrintEventSummary()
+	return se.eventExecutor.PrintEventSummary(tag)
 }
 
 // Generate returns an eventExecutor populated with a sorted list of events. It

pkg/kv/kvserver/asim/gen/generator.go

@@ -31,7 +31,7 @@ type LoadGen interface {
 	// Generate returns a workload generator that is parameterized randomly by
 	// the seed and simulation settings provided.
 	Generate(seed int64, settings *config.SimulationSettings) []workload.Generator
-	String() string
+	StringWithTag(tag string) string
 }
 
 // ClusterGen provides a method to generate the initial cluster state,  given a
@@ -51,7 +51,7 @@ type RangeGen interface {
 	// Generate returns an updated state, given the initial state, seed and
 	// simulation settings provided. In the updated state, ranges will have been
 	// created, replicas and leases assigned to stores in the cluster.
-	Generate(seed int64, settings *config.SimulationSettings, s state.State) (state.State, string)
+	Generate(tag string, seed int64, settings *config.SimulationSettings, s state.State) (state.State, string)
 	String() string
 }
 
@@ -66,10 +66,11 @@ func GenerateSimulation(
 	eventGen EventGen,
 	seed int64,
 	buf *strings.Builder,
+	tag string,
 ) *asim.Simulator {
 	settings := settingsGen.Generate(seed)
 	s := clusterGen.Generate(seed, &settings)
-	s, rangeStateStr := rangeGen.Generate(seed, &settings, s)
+	s, rangeStateStr := rangeGen.Generate(tag, seed, &settings, s)
 	eventExecutor := eventGen.Generate(seed, &settings)
 	generateClusterVisualization(buf, s, loadGen, eventGen, rangeStateStr, settings)
 	return asim.NewSimulator(
@@ -102,10 +103,10 @@ type MultiLoad []BasicLoad
 // BasicLoad.
 var _ LoadGen = MultiLoad{}
 
-func (ml MultiLoad) String() string {
+func (ml MultiLoad) StringWithTag(tag string) string {
 	var buf strings.Builder
 	for i, load := range ml {
-		_, _ = fmt.Fprintf(&buf, "%s", load.String())
+		_, _ = fmt.Fprintf(&buf, "%s", load.StringWithTag(tag))
 		if i != len(ml)-1 {
 			_, _ = fmt.Fprintf(&buf, "\n")
 		}
@@ -135,9 +136,9 @@ type BasicLoad struct {
 
 var _ LoadGen = BasicLoad{}
 
-func (bl BasicLoad) String() string {
+func (bl BasicLoad) StringWithTag(tag string) string {
 	var buf strings.Builder
-	fmt.Fprintf(&buf, "\t[%d,%d): ", bl.MinKey, bl.MaxKey)
+	fmt.Fprintf(&buf, "%s[%d,%d): ", tag, bl.MinKey, bl.MaxKey)
 	if bl.RWRatio == 1 {
 		_, _ = fmt.Fprint(&buf, "read-only")
 	} else if bl.RWRatio == 0 {
@@ -214,7 +215,7 @@ func (lc LoadedCluster) Generate(seed int64, settings *config.SimulationSettings
 }
 
 func (lc LoadedCluster) String() string {
-	return fmt.Sprintf("cluster: %s", lc.Info.String())
+	return fmt.Sprintf("cluster: \n%s", lc.Info.String())
 }
 
 func (lc LoadedCluster) Regions() []state.Region {
@@ -356,6 +357,11 @@ type BaseRanges struct {
 	ReplicaPlacement  state.ReplicaPlacement
 }
 
+func (br BaseRanges) String() string {
+	return fmt.Sprintf("[%d,%d): %d(rf=%d), %dMiB",
+		br.MinKey, br.MaxKey, br.Ranges, br.ReplicationFactor, br.Bytes>>20)
+}
+
 // GetRangesInfo generates and distributes ranges across stores based on
 // PlacementType while using other BaseRanges fields for range configuration.
 func (b BaseRanges) GetRangesInfo(
@@ -404,15 +410,15 @@ func (br BasicRanges) String() string {
 // ranges generated based on the parameters specified in the fields of
 // BasicRanges.
 func (br BasicRanges) Generate(
-	seed int64, settings *config.SimulationSettings, s state.State,
+	tag string, seed int64, settings *config.SimulationSettings, s state.State,
 ) (state.State, string) {
 	if br.PlacementType == Random || br.PlacementType == WeightedRandom {
 		panic("BasicRanges generate only uniform or skewed distributions")
 	}
 	rangesInfo, str := br.GetRangesInfo(br.PlacementType, len(s.Stores()), nil, []float64{})
 	br.LoadRangeInfo(s, rangesInfo)
 	var buf strings.Builder
-	_, _ = fmt.Fprintf(&buf, "\t%s, %s", br, str)
+	_, _ = fmt.Fprintf(&buf, "%s%s, %s", tag, br, str)
 	return s, buf.String()
 }
 
@@ -434,14 +440,14 @@ func (mr MultiRanges) String() string {
 }
 
 func (mr MultiRanges) Generate(
-	seed int64, settings *config.SimulationSettings, s state.State,
+	tag string, seed int64, settings *config.SimulationSettings, s state.State,
 ) (state.State, string) {
 	var rangeInfos []state.RangeInfo
 	var rangeInfoStrings []string
 	for _, ranges := range mr {
 		rangeInfo, rangeInfoStr := ranges.GetRangesInfo(ranges.PlacementType, len(s.Stores()), nil, []float64{})
 		rangeInfos = append(rangeInfos, rangeInfo...)
-		rangeInfoStrings = append(rangeInfoStrings, fmt.Sprintf("\t%s, %s", ranges.String(), rangeInfoStr))
+		rangeInfoStrings = append(rangeInfoStrings, fmt.Sprintf("%s%s, %s", tag, ranges.String(), rangeInfoStr))
 	}
 	state.LoadRangeInfo(s, rangeInfos...)
 	var buf strings.Builder

pkg/kv/kvserver/asim/gen/printer.go

@@ -87,10 +87,10 @@ func generateClusterVisualization(
 		}
 		return s
 	}
-	clusterSetUp := emptyIfBlank(s.NodesString())
+	clusterSetUp := emptyIfBlank(s.NodesStringWithTag("\t"))
 	rangeState := emptyIfBlank(rangeStateStr)
-	event := emptyIfBlank(eventGen.String())
-	workloadSetUp := emptyIfBlank(loadGen.String())
+	event := emptyIfBlank(eventGen.StringWithTag("\t"))
+	workloadSetUp := emptyIfBlank(loadGen.StringWithTag("\t"))
 	settingsChanges := emptyIfBlank(compareSettingsToDefault(settings))
 	_, _ = fmt.Fprintf(buf, "Cluster Set Up\n%s\n", clusterSetUp)
 	_, _ = fmt.Fprintf(buf, "Key Space\n%s\n", rangeState)

pkg/kv/kvserver/asim/scheduled/scheduled_event.go

@@ -39,9 +39,9 @@ type ScheduledEvent struct {
 	TargetEvent event.Event
 }
 
-func (se ScheduledEvent) String() string {
+func (se ScheduledEvent) StringWithTag(tag string) string {
 	buf := strings.Builder{}
-	buf.WriteString(fmt.Sprintf("\t%s", se.TargetEvent.String()))
+	buf.WriteString(fmt.Sprintf("%s%s", tag, se.TargetEvent.String()))
 	if !se.At.Equal(config.DefaultStartTime) {
 		buf.WriteString(fmt.Sprintf(" at %s", se.At.Format("15:04:05")))
 	}

pkg/kv/kvserver/asim/scheduled/scheduled_event_executor.go

@@ -31,7 +31,7 @@ type EventExecutor interface {
 	TickEvents(context.Context, time.Time, state.State, history.History) bool
 	// PrintEventSummary returns a string summarizing the executed mutation and
 	// assertion events.
-	PrintEventSummary() string
+	PrintEventSummary(tag string) string
 	// PrintEventsExecuted returns a detailed string representation of executed
 	// events including details of mutation events, assertion checks, and assertion
 	// results.
@@ -68,16 +68,16 @@ func newExecutorWithNoEvents() *eventExecutor {
 
 // PrintEventSummary returns a string summarizing the executed mutation and
 // assertion events.
-func (e *eventExecutor) PrintEventSummary() string {
+func (e *eventExecutor) PrintEventSummary(tag string) string {
 	mutationEvents, assertionEvents := 0, 0
 	var buf strings.Builder
 	sort.Sort(e.scheduledEvents)
-	for i, event := range e.scheduledEvents {
-		_, _ = fmt.Fprintf(&buf, "%v", event)
+	for i, ev := range e.scheduledEvents {
+		_, _ = fmt.Fprintf(&buf, "%v", ev.StringWithTag(tag))
 		if i != len(e.scheduledEvents)-1 {
 			_, _ = fmt.Fprintf(&buf, "\n")
 		}
-		if event.IsMutationEvent() {
+		if ev.IsMutationEvent() {
 			mutationEvents++
 		} else {
 			assertionEvents++
@@ -110,7 +110,7 @@ func (e *eventExecutor) PrintEventsExecuted() string {
 		buf := strings.Builder{}
 		buf.WriteString(fmt.Sprintf("%d events executed:\n", len(e.scheduledEvents)))
 		for i, event := range e.scheduledEvents {
-			_, _ = fmt.Fprintf(&buf, "%v", event.String())
+			_, _ = fmt.Fprintf(&buf, "%v", event.StringWithTag(""))
 			if i != len(e.scheduledEvents)-1 {
 				_, _ = fmt.Fprintf(&buf, "\n")
 			}

pkg/kv/kvserver/asim/state/config_loader.go

@@ -294,8 +294,7 @@ func (c ClusterInfo) String() (s string) {
 				buf.WriteString(", ")
 			}
 		}
-		buf.WriteString("]")
-		buf.WriteString("\n")
+		buf.WriteString("]\n")
 	}
 	buf.WriteString(fmt.Sprintf("store_disk_capacity=%d bytes, node_cpu_rate_capacity=%d cpu-ns/sec",
 		c.StoreDiskCapacityBytes, c.NodeCPURateCapacityNanos))

pkg/kv/kvserver/asim/state/impl.go

@@ -1425,7 +1425,7 @@ func (s *state) SetSimulationSettings(Key string, Value interface{}) {
 	}
 }
 
-func (s *state) NodesString() string {
+func (s *state) NodesStringWithTag(tag string) string {
 	var buf strings.Builder
 
 	nodes := make([]*node, 0, len(s.nodes))
@@ -1437,7 +1437,7 @@ func (s *state) NodesString() string {
 	})
 
 	for nID, n := range nodes {
-		_, _ = fmt.Fprintf(&buf, "\tn%d(", n.nodeID)
+		_, _ = fmt.Fprintf(&buf, "%sn%d(", tag, n.nodeID)
 		for _, locality := range n.desc.Locality.Tiers {
 			_, _ = fmt.Fprintf(&buf, "%s,", locality.Value)
 		}

pkg/kv/kvserver/asim/state/state.go

@@ -64,7 +64,7 @@ type State interface {
 	// Nodes returns all nodes that exist in this state.
 	Nodes() []Node
 	// NodesString returns a string representation of all nodes.
-	NodesString() string
+	NodesStringWithTag(tag string) string
 	// RangeFor returns the range containing Key in [StartKey, EndKey). This
 	// cannot fail.
 	RangeFor(Key) Range

pkg/kv/kvserver/asim/tests/datadriven_simulation_test.go

@@ -539,7 +539,7 @@ func TestDataDriven(t *testing.T) {
 							}
 							simulator := gen.GenerateSimulation(
 								duration, clusterGen, rangeGen, loadGen,
-								settingsGen, eventGen, seedGen.Int63(), tmpStrB,
+								settingsGen, eventGen, seedGen.Int63(), tmpStrB, "\t",
 							)
 							if stateStrForOnce == "" {
 								stateStrForOnce = tmpStrB.String()

pkg/kv/kvserver/asim/tests/output.go

@@ -150,17 +150,22 @@ func (tr testResultsReport) String() string {
 		if failed || tr.flags.Has(OutputConfigGen) {
 			buf.WriteString(fmt.Sprintf("configurations generated using seed %d\n", output.seed))
 			clusterGenStr, rangeGenStr, loadGenStr, eventGenStr :=
-				output.clusterGen.String(), output.rangeGen.String(), output.loadGen.String(), output.eventGen.String()
-			emptyIfBlank := func(s string) string {
+				output.clusterGen.String(), output.rangeGen.String(), output.loadGen.StringWithTag(""), output.eventGen.StringWithTag("")
+			emptyIfBlank := func(tag string, s string) string {
 				if s == "" {
-					return "empty"
+					return fmt.Sprintf("%s: empty", tag)
 				}
 				return s
 			}
-			buf.WriteString(fmt.Sprintf("\t%v\n", emptyIfBlank(clusterGenStr)))
-			buf.WriteString(fmt.Sprintf("\t%v\n", emptyIfBlank(rangeGenStr)))
-			buf.WriteString(fmt.Sprintf("%v\n", emptyIfBlank(loadGenStr)))
-			buf.WriteString(fmt.Sprintf("\t%v\n", emptyIfBlank(eventGenStr)))
+			buf.WriteString(fmt.Sprintf("\t%v\n", emptyIfBlank("cluster", clusterGenStr)))
+			buf.WriteString(fmt.Sprintf("\t%v\n", emptyIfBlank("range", rangeGenStr)))
+			buf.WriteString(fmt.Sprintf("\t%v\n", emptyIfBlank("load", loadGenStr)))
+			buf.WriteString("\tscheduled_event:\n")
+			if eventGenStr == "" {
+				eventGenStr = "\t\tempty"
+			}
+			buf.WriteString(fmt.Sprintf("%v\n", eventGenStr))
+
 		}
 		if failed || tr.flags.Has(OutputInitialState) {
 			buf.WriteString(fmt.Sprintf("initial state at %s:\n", output.initialTime.Format("2006-01-02 15:04:05")))