summaryrefslogtreecommitdiff
path: root/test/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/README.md')
-rw-r--r--test/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/test/README.md b/test/README.md
new file mode 100644
index 0000000000..e5339acc62
--- /dev/null
+++ b/test/README.md
@@ -0,0 +1,28 @@
+Ansible Test System
+===================
+
+Folders
+
+unit
+----
+
+Unit tests that test small pieces of code not suited for the integration test layer, usually very API based, and should leverage
+mock interfaces rather than producing side effects.
+
+Playbook engine code is better suited for integration tests.
+
+integration
+-----------
+
+Integration test layer, constructed using playbooks.
+
+Some tests may require cloud credentials, others will not, and destructive tests are seperated from non-destructive so a subset
+can be run on development machines.
+
+learn more
+----------
+
+hop into a subdirectory and see the associated README.md for more info.
+
+
+