From 73ee819b02f5bb4b184a38372ff81da14cd4b06e Mon Sep 17 00:00:00 2001
From: Nate Sales <nate@natesales.net>
Date: Mon, 2 Sep 2024 17:34:31 -0400
Subject: [PATCH] docs: add matrix test docs

---
 tests/suite/README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 tests/suite/README.md

diff --git a/tests/suite/README.md b/tests/suite/README.md
new file mode 100644
index 00000000..eed481f7
--- /dev/null
+++ 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