Formidable schema test on yml

CHANGELOG.rst

@@ -5,7 +5,7 @@ ChangeLog
 master (unreleased)
 ===================
 
-Nothing here yet.
+- Added tests against the ``formidable.yml`` schema definition of Forms (#295).
 
 Release 1.3.0 (2018-02-14)
 ==========================

docs/setup.cfg

@@ -0,0 +1,3 @@
+[tool:pytest]
+; intentionally left blank
+; it voids the defaults that live in the setup.cfg file at the root of the repository.

docs/tests/__init__.py

@@ -0,0 +1,52 @@
+from os.path import abspath, join, dirname
+import json
+import collections
+
+from jsonschema import Draft4Validator
+import yaml
+
+ROOT_PATH = dirname(abspath(__file__))
+
+
+def yaml2json():
+    """
+    Builds a dictionary of the BuilderForm definition out of the Swagger YAML.
+    """
+    # Setup support for ordered dicts so we do not lose ordering
+    # when importing from YAML
+    _mapping_tag = yaml.resolver.BaseResolver.DEFAULT_MAPPING_TAG
+
+    def dict_representer(dumper, data):
+        return dumper.represent_mapping(_mapping_tag, data.iteritems())
+
+    def dict_constructor(loader, node):
+        return collections.OrderedDict(loader.construct_pairs(node))
+
+    yaml.add_representer(collections.OrderedDict, dict_representer)
+    yaml.add_constructor(_mapping_tag, dict_constructor)
+
+    # Building raw data out of the Swagger Formidable definition
+    swagger_file = join(ROOT_PATH, '..', 'swagger', 'formidable.yml')
+    with open(swagger_file) as fd:
+        data = yaml.load(fd)
+
+    to_exclude = (
+        'BuilderForm', 'InputError', 'BuilderError', 'InputForm', 'InputField'
+    )
+    definitions = (item for item in data['definitions'].items())
+    definitions = filter(lambda item: item[0] not in to_exclude, definitions)
+
+    new_data = {}
+    new_data.update(data['definitions']['BuilderForm'])
+    new_data.update({"definitions": dict(definitions)})
+    return new_data
+
+
+def _load_fixture(path):
+    if not path.startswith('fixtures/'):
+        path = 'fixtures/{}'.format(path)
+    return json.load(open(join(ROOT_PATH, path)))
+
+
+schema = yaml2json()
+validator = Draft4Validator(schema)

docs/tests/fixtures/0000_empty.json

@@ -0,0 +1 @@
+{}

docs/tests/fixtures/0001_just_id.json

@@ -0,0 +1,3 @@
+{
+  "id": 1
+}

docs/tests/fixtures/0002_id_label.json

@@ -0,0 +1,4 @@
+{
+  "id": 1,
+  "label": "This is my form title"
+}

docs/tests/fixtures/0003_id_not_integer.json

@@ -0,0 +1,5 @@
+{
+  "id": "hello",
+  "label": "This is my form title",
+  "description": "Here's the description of my form."
+}

docs/tests/fixtures/0004_id_label_description.json

@@ -0,0 +1,5 @@
+{
+  "id": 1,
+  "label": "This is my form title",
+  "description": "Here's the description of my form."
+}

docs/tests/fixtures/0010_wrong_type_field_dict.json

@@ -0,0 +1,6 @@
+{
+  "id": 1,
+  "label": "This is my form title",
+  "description": "Here's the description of my form.",
+  "fields": {"hello": "world"}
+}

docs/tests/fixtures/0010_wrong_type_field_int.json

@@ -0,0 +1,6 @@
+{
+  "id": 1,
+  "label": "This is my form title",
+  "description": "Here's the description of my form.",
+  "fields": 42
+}

docs/tests/fixtures/0011_empty_fields.json

@@ -0,0 +1,6 @@
+{
+  "id": 1,
+  "label": "This is my form title",
+  "description": "Here's the description of my form.",
+  "fields": []
+}

docs/tests/fixtures/0012_fields_empty_object.json

@@ -0,0 +1,8 @@
+{
+  "id": 1,
+  "label": "This is my form title",
+  "description": "Here's the description of my form.",
+  "fields": [
+      {}
+  ]
+}

docs/tests/fixtures/0012_fields_ok.json

@@ -0,0 +1,15 @@
+{
+  "id": 1,
+  "label": "This is my form title",
+  "description": "Here's the description of my form.",
+  "fields": [
+      {
+        "id": 1,
+        "label": "Name",
+        "slug": "name",
+        "type_id": "text",
+        "description": "please put your name here",
+        "accesses": []
+      }
+  ]
+}

docs/tests/fixtures/0013_fields_placeholder.json

@@ -0,0 +1,16 @@
+{
+  "id": 1,
+  "label": "This is my form title",
+  "description": "Here's the description of my form.",
+  "fields": [
+      {
+        "id": 1,
+        "label": "Name",
+        "slug": "name",
+        "type_id": "text",
+        "description": "please put your name here",
+        "accesses": [],
+        "placeholder": "This is my placeholder"
+      }
+  ]
+}

docs/tests/fixtures/0014_fields_multiple.json

@@ -0,0 +1,17 @@
+{
+  "id": 1,
+  "label": "This is my form title",
+  "description": "Here's the description of my form.",
+  "fields": [
+      {
+        "id": 1,
+        "label": "Name",
+        "slug": "name",
+        "type_id": "text",
+        "description": "please put your name here",
+        "accesses": [],
+        "placeholder": "This is my placeholder",
+        "multiple": true
+      }
+  ]
+}

docs/tests/fixtures/0015_fields_items.json

@@ -0,0 +1,21 @@
+{
+  "id": 1,
+  "label": "This is my form title",
+  "description": "Here's the description of my form.",
+  "fields": [
+      {
+        "id": 1,
+        "label": "Name",
+        "slug": "name",
+        "type_id": "text",
+        "description": "please put your name here",
+        "accesses": [],
+        "placeholder": "This is my placeholder",
+        "multiple": true,
+        "items": [
+            {"label": "first value", "value": "FIRST", "description": "This is my first value"},
+            {"label": "second value", "value": "SECOND", "description": "This is the last value"}
+        ]
+      }
+  ]
+}

docs/tests/fixtures/0016_fields_accesses.json

@@ -0,0 +1,20 @@
+{
+  "id": 1,
+  "label": "This is my form title",
+  "description": "Here's the description of my form.",
+  "fields": [
+      {
+        "id": 1,
+        "label": "Name",
+        "slug": "name",
+        "type_id": "text",
+        "description": "please put your name here",
+        "accesses": [],
+        "placeholder": "This is my placeholder",
+        "accesses": [
+            {"access_id": "JEDI", "level": "REQUIRED"},
+            {"access_id": "PADAWAN", "level": "EDITABLE"}
+        ]
+      }
+  ]
+}

docs/tests/fixtures/0017_fields_validations.json

@@ -0,0 +1,20 @@
+{
+  "id": 1,
+  "label": "This is my form title",
+  "description": "Here's the description of my form.",
+  "fields": [
+      {
+        "id": 1,
+        "label": "Name",
+        "slug": "name",
+        "type_id": "text",
+        "description": "please put your name here",
+        "accesses": [],
+        "placeholder": "This is my placeholder",
+        "validations": [
+            {"type": "MINLENGTH", "value": "5", "message": "Your name is too short"},
+            {"type": "MAXLENGTH", "value": "100", "message": "Your name is too long"}
+        ]
+      }
+  ]
+}

docs/tests/fixtures/0018_fields_defaults.json

@@ -0,0 +1,17 @@
+{
+  "id": 1,
+  "label": "This is my form title",
+  "description": "Here's the description of my form.",
+  "fields": [
+      {
+        "id": 1,
+        "label": "Name",
+        "slug": "name",
+        "type_id": "text",
+        "description": "please put your name here",
+        "accesses": [],
+        "placeholder": "This is my placeholder",
+        "defaults": ["This is your default"]
+      }
+  ]
+}

docs/tests/fixtures/0020_simple_condition.json

@@ -0,0 +1,60 @@
+{
+  "id": 1,
+  "label": "The Game Form",
+  "description": "A form to pick a cool game",
+  "fields": [
+    {
+      "id": 1,
+      "slug": "do-you-want-to-play-games",
+      "label": "Do you want to play games?",
+      "type_id": "checkbox",
+      "description": "",
+      "accesses": []
+    },
+    {
+      "id": 2,
+      "slug": "favorite-game",
+      "label": "Favorite game",
+      "type_id": "dropdown",
+      "description": "",
+      "accesses": [],
+      "items": [
+        {
+          "value": "BORING",
+          "label": "Monopoly"
+        },
+        {
+          "value": "YES",
+          "label": "Magic Maze"
+        }
+      ],
+      "multiple": false
+    },
+    {
+      "id": 3,
+      "slug": "please-explain",
+      "label": "Please, explain...",
+      "type_id": "text",
+      "description": "Please explain why it matters...",
+      "accesses": []
+    }
+  ],
+  "conditions": [
+    {
+      "name": "Jeux",
+      "field_ids": [
+        "favorite-game"
+      ],
+      "action": "display_iff",
+      "tests": [
+        {
+          "field_id": "do-you-want-to-play-games",
+          "operator": "eq",
+          "values": [
+            "true"
+          ]
+        }
+      ]
+    }
+  ]
+}

docs/tests/test_check_schema.py

@@ -0,0 +1,7 @@
+from jsonschema import Draft4Validator
+from . import schema
+
+
+def test_validate_schema():
+    # First, check Schema
+    assert Draft4Validator.check_schema(schema) is None