summaryrefslogtreecommitdiff
path: root/tests/files/README.md
diff options
context:
space:
mode:
authorJohan Fleury <jfleury@arcaik.net>2018-10-08 12:58:12 -0400
committerJohan Fleury <jfleury@arcaik.net>2018-10-08 12:58:12 -0400
commit735c78d3ecb695dd16cb37879880f522c4b29c72 (patch)
tree8bfb2ecbd0f03730efa1540cc65d8490b67e8ddd /tests/files/README.md
Import upstream version 1.7.0
Diffstat (limited to 'tests/files/README.md')
-rw-r--r--tests/files/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/tests/files/README.md b/tests/files/README.md
new file mode 100644
index 0000000..3faa375
--- /dev/null
+++ b/tests/files/README.md
@@ -0,0 +1,34 @@
+# Test files
+
+Test files are divided up into 2 types of tests. They follow a naming schema that follows `(Number)(Type).yaml` Where number is just a ever increasing integer and Type is different depending on the test type. Each type of test should be counted seperatly.
+
+- Successfull tests. Type: 's'
+- Failing tests. Type: 'f'
+
+
+
+# Successfull tests
+
+Files in `success` folder.
+
+Each file should contain a top level dict with the keys `data` and `schema` where the test data should exists.
+
+
+
+# Failing tests
+
+Files in `fail` folder.
+
+Each file should contain a top level dict with the keys `data`, `schema` and `errors` where the test data should exists.
+
+
+
+# cli tests
+
+Simple schema and data files that is used to test input of files via cli.
+
+
+
+# partial schemas
+
+Files used to test partial schema support.