docs: add matrix test docs

natesales · Sep 2, 2024 · 73ee819 · 73ee819
1 parent b2df829
commit 73ee819
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/tests/suite/README.md b/tests/suite/README.md
@@ -0,0 +1,20 @@
+# Matrix Test Suite
+
+## Session establishment test
+
+- Run BIRD on both router containers
+- Namespaced routing tables, control sockets, and cache directories
+
+### Assertions
+- Session established
+- Route received
+- Route installed in kernel
+- Ping
+
+## Complex config generation test
+
+- Generate with `generate-complex` on different versions of BIRD
+
+## Test Suite
+
+Go test flag to use container test target