Add pre-processing for realistic scenarios (#5825)

microsoft · Nov 10, 2023 · 7230570 · lemmy · Dec 27, 2023 · achamayou
1 parent 8f6d14c
commit 7230570
Show file tree

Hide file tree

Showing 19 changed files with 46 additions and 15 deletions.
diff --git a/.azure-pipelines-templates/trace_validation.yml b/.azure-pipelines-templates/trace_validation.yml
@@ -10,16 +10,16 @@ steps:
       set -ex
       cd tla/
       parallel 'JSON={} ./tlc.sh consensus/Traceccfraft.tla' ::: \
-      ../build/replicate.ndjson \
-      ../build/election.ndjson \
-      ../build/multi_election.ndjson \
-      ../build/check_quorum.ndjson \
-      ../build/reconnect.ndjson \
-      ../build/reconnect_node.ndjson \
-      ../build/bad_network.ndjson \
-      ../build/fancy_election.1.ndjson \
-      ../build/fancy_election.2.ndjson \
-      ../build/suffix_collision.1.ndjson \
-      ../build/suffix_collision.2.ndjson \
-      ../build/suffix_collision.3.ndjson
+      ../build/replicate_deprecated.ndjson \
+      ../build/election_deprecated.ndjson \
+      ../build/multi_election_deprecated.ndjson \
+      ../build/check_quorum_deprecated.ndjson \
+      ../build/reconnect_deprecated.ndjson \
+      ../build/reconnect_node_deprecated.ndjson \
+      ../build/bad_network_deprecated.ndjson \
+      ../build/fancy_election.1_deprecated.ndjson \
+      ../build/fancy_election.2_deprecated.ndjson \
+      ../build/suffix_collision.1_deprecated.ndjson \
+      ../build/suffix_collision.2_deprecated.ndjson \
+      ../build/suffix_collision.3_deprecated.ndjson
     displayName: "Run trace validation"
diff --git a/tests/raft_scenarios/4582.2 → tests/raft_scenarios/4582.2_deprecated b/tests/raft_scenarios/4582.2 → tests/raft_scenarios/4582.2_deprecated
diff --git a/tests/raft_scenarios/4806 → tests/raft_scenarios/4806_deprecated b/tests/raft_scenarios/4806 → tests/raft_scenarios/4806_deprecated
diff --git a/tests/raft_scenarios/bad_network → tests/raft_scenarios/bad_network_deprecated b/tests/raft_scenarios/bad_network → tests/raft_scenarios/bad_network_deprecated
diff --git a/tests/raft_scenarios/check_quorum → tests/raft_scenarios/check_quorum_deprecated b/tests/raft_scenarios/check_quorum → tests/raft_scenarios/check_quorum_deprecated
diff --git a/tests/raft_scenarios/election → tests/raft_scenarios/election_deprecated b/tests/raft_scenarios/election → tests/raft_scenarios/election_deprecated
diff --git a/..._scenarios/election_while_reconfiguration → ...election_while_reconfiguration_deprecated b/..._scenarios/election_while_reconfiguration → ...election_while_reconfiguration_deprecated
diff --git a/tests/raft_scenarios/fancy_election.1 → ...aft_scenarios/fancy_election.1_deprecated b/tests/raft_scenarios/fancy_election.1 → ...aft_scenarios/fancy_election.1_deprecated
diff --git a/tests/raft_scenarios/fancy_election.2 → ...aft_scenarios/fancy_election.2_deprecated b/tests/raft_scenarios/fancy_election.2 → ...aft_scenarios/fancy_election.2_deprecated
diff --git a/tests/raft_scenarios/multi_election → .../raft_scenarios/multi_election_deprecated b/tests/raft_scenarios/multi_election → .../raft_scenarios/multi_election_deprecated
diff --git a/tests/raft_scenarios/reconfiguration → ...raft_scenarios/reconfiguration_deprecated b/tests/raft_scenarios/reconfiguration → ...raft_scenarios/reconfiguration_deprecated
diff --git a/tests/raft_scenarios/reconnect → tests/raft_scenarios/reconnect_deprecated b/tests/raft_scenarios/reconnect → tests/raft_scenarios/reconnect_deprecated
diff --git a/tests/raft_scenarios/reconnect_node → .../raft_scenarios/reconnect_node_deprecated b/tests/raft_scenarios/reconnect_node → .../raft_scenarios/reconnect_node_deprecated
diff --git a/tests/raft_scenarios/replicate → tests/raft_scenarios/replicate_deprecated b/tests/raft_scenarios/replicate → tests/raft_scenarios/replicate_deprecated
diff --git a/tests/raft_scenarios/soft_rollback → ...s/raft_scenarios/soft_rollback_deprecated b/tests/raft_scenarios/soft_rollback → ...s/raft_scenarios/soft_rollback_deprecated
diff --git a/tests/raft_scenarios/suffix_collision.1 → ...t_scenarios/suffix_collision.1_deprecated b/tests/raft_scenarios/suffix_collision.1 → ...t_scenarios/suffix_collision.1_deprecated
diff --git a/tests/raft_scenarios/suffix_collision.2 → ...t_scenarios/suffix_collision.2_deprecated b/tests/raft_scenarios/suffix_collision.2 → ...t_scenarios/suffix_collision.2_deprecated
diff --git a/tests/raft_scenarios/suffix_collision.3 → ...t_scenarios/suffix_collision.3_deprecated b/tests/raft_scenarios/suffix_collision.3 → ...t_scenarios/suffix_collision.3_deprecated
diff --git a/tests/raft_scenarios_runner.py b/tests/raft_scenarios_runner.py
@@ -3,9 +3,12 @@
 import argparse
 import sys
 import os
+import json
 from subprocess import Popen, PIPE
 from raft_scenarios_gen import generate_scenarios
 from contextlib import contextmanager
+from collections import defaultdict
+from heapq import merge
 
 
 @contextmanager
@@ -33,15 +36,40 @@ def write_error_report(errors=None):
         print("??? success \n")
 
 
-def separate_log_lines(text):
+def remove_reconfiguration_replicates(log):
+    log_by_node = defaultdict(list)
+    for line in log:
+        entry = json.loads(line)
+        node = entry["msg"]["state"]["node_id"]
+        if entry["msg"]["function"] == "add_configuration":
+            removed = log_by_node[node].pop()
+            assert removed["msg"]["function"] in (
+                "replicate",
+                "execute_append_entries_sync",
+            ), removed
+        log_by_node[node].append(entry)
+    return [
+        json.dumps(e)
+        for e in merge(*log_by_node.values(), key=lambda e: int(e["h_ts"]))
+    ]
+
+
+def noop(log):
+    return log
+
+
+def separate_log_lines(text, preprocess):
     mermaid = []
     log = []
     for line in text.split(os.linesep):
         if line.startswith("<RaftDriver>"):
             mermaid.append(line[len("<RaftDriver>") :])
         elif '"raft_trace"' in line:
             log.append(line)
-    return (os.linesep.join(mermaid) + os.linesep, os.linesep.join(log) + os.linesep)
+    return (
+        os.linesep.join(mermaid) + os.linesep,
+        os.linesep.join(preprocess(log)) + os.linesep,
+    )
 
 
 def expand_files(files):
@@ -94,7 +122,10 @@ def expand_files(files):
             with block(ostream, "stderr", 3):
                 ostream.write(err.decode())
 
-        mermaid, log = separate_log_lines(out.decode())
+        mermaid, log = separate_log_lines(
+            out.decode(),
+            noop if "deprecated" in scenario else remove_reconfiguration_replicates,
+        )
 
         with block(ostream, "diagram", 3, "mermaid", ["sequenceDiagram"]):
             ostream.write(mermaid)