Refactor sync test

.buildkite/node-db-sync.yml

@@ -0,0 +1,15 @@
+steps:
+  - label: ':drum_with_drumsticks: Node + DB sync :drum_with_drumsticks:'
+    commands:
+      - >
+        nix develop --accept-flake-config .#python --command python
+        -m sync_tests.tests.full_sync_from_clean_state
+        -nv "${node_version}"
+        -dv "${db_sync_version}"
+        -dsa "${db_sync_start_arguments}"
+        -e "${environment}"
+    timeout_in_minutes: 43200
+    agents:
+      system: x86_64-linux
+      queue: "${queue_name:-core-tech-bench}"
+

.pre-commit-config.yaml

@@ -1,3 +1,4 @@
+exclude: ^(cardano-db-sync/|cardano_node_dir/)
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v5.0.0

README.md

@@ -1,4 +1,56 @@
-README for cardano-sync-tests
-=============================
+# cardano-sync-tests
 
-Sync tests for cardano-node and db-sync.
+Sync tests for `cardano-node` and `cardano-db-sync`.
+
+## Main entry point
+
+All sync workflows use a single entry point:
+
+```bash
+python3 sync_tests/tests/full_sync_from_clean_state.py
+```
+
+### Node-only sync
+
+```bash
+python3 sync_tests/tests/full_sync_from_clean_state.py \
+  --node-revision master \
+  --environment preview
+```
+
+### Full sync (node + db-sync)
+
+```bash
+python3 sync_tests/tests/full_sync_from_clean_state.py \
+  --node-revision master \
+  --db-sync-revision master \
+  --environment preview
+```
+
+### Full sync with era override
+
+```bash
+python3 sync_tests/tests/full_sync_from_clean_state.py \
+  --node-revision master \
+  --db-sync-revision master \
+  --environment preview \
+  --db-sync-start-era babbage
+```
+
+### DB-sync only (attach to an existing node)
+
+```bash
+python3 sync_tests/tests/full_sync_from_clean_state.py \
+  --db-sync-revision master \
+  --environment preview \
+  --node-socket-path /path/to/node.socket
+```
+
+If `--node-socket-path` is not provided, the test attempts to use:
+`CARDANO_NODE_SOCKET_PATH`, then `./db/node.socket`, then
+`./test_workdir/db/node.socket`, then `./test_workdir_node_only/db/node.socket`.
+
+## Logs
+
+- Node logs: `test_workdir/logfile.log`
+- DB-sync logs: `test_workdir/db_sync_<env>_logfile.log`