Merge pull request #75 from yannh/openapi2jsonschema-tests

Add simple openapi2jsonschema unit tests

.github/workflows/main.yml

@@ -22,9 +22,9 @@ jobs:
       - name: checkout
         uses: actions/checkout@v2
 
-      - name: acceptance-test
+      - name: test
         working-directory: ./scripts
-        run: make docker-acceptance
+        run: make docker-test docker-acceptance
 
   goreleaser:
     runs-on: ubuntu-latest

scripts/Makefile

@@ -2,8 +2,13 @@
 
 # This is really early days
 
+test: build-python-bats docker-test docker-acceptance
+
 build-python-bats:
 	docker build -t python-bats -f Dockerfile.bats .
 
+docker-test: build-python-bats
+	docker run --entrypoint "/usr/local/bin/pytest" -t python-bats openapi2jsonschema.py
+
 docker-acceptance: build-python-bats
 	docker run --entrypoint "/usr/bin/bats" -t python-bats /code/acceptance.bats

scripts/openapi2jsonschema.py

@@ -1,24 +1,26 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 # Derived from https://github.com/instrumenta/openapi2jsonschema
 import yaml
 import json
 import sys
 import os
-import urllib.request
-
-def iteritems(d):
-    if hasattr(dict, "iteritems"):
-        return d.iteritems()
-    else:
-        return iter(d.items())
 
+def test_additional_properties():
+    for test in iter([{
+        "input": {"something": {"properties": {}}},
+        "expect": {'something': {'properties': {}, "additionalProperties": False}}
+    },{
+        "input": {"something": {"somethingelse": {}}},
+        "expect": {'something': {'somethingelse': {}}}
+    }]):
+        assert additional_properties(test["input"]) == test["expect"]
 
 def additional_properties(data):
     "This recreates the behaviour of kubectl at https://github.com/kubernetes/kubernetes/blob/225b9119d6a8f03fcbe3cc3d590c261965d928d0/pkg/kubectl/validation/schema.go#L312"
     new = {}
     try:
-        for k, v in iteritems(data):
+        for k, v in iter(data.items()):
             new_v = v
             if isinstance(v, dict):
                 if "properties" in v:
@@ -32,11 +34,20 @@ def additional_properties(data):
     except AttributeError:
         return data
 
+def test_replace_int_or_string():
+    for test in iter([{
+        "input": {"something": {"format": "int-or-string"}},
+        "expect": {'something': {'oneOf': [{'type': 'string'}, {'type': 'integer'}]}}
+    },{
+        "input": {"something": {"format": "string"}},
+        "expect": {"something": {"format": "string"}},
+    }]):
+        assert replace_int_or_string(test["input"]) == test["expect"]
 
 def replace_int_or_string(data):
     new = {}
     try:
-        for k, v in iteritems(data):
+        for k, v in iter(data.items()):
             new_v = v
             if isinstance(v, dict):
                 if "format" in v and v["format"] == "int-or-string":
@@ -54,11 +65,10 @@ def replace_int_or_string(data):
     except AttributeError:
         return data
 
-
 def allow_null_optional_fields(data, parent=None, grand_parent=None, key=None):
     new = {}
     try:
-        for k, v in iteritems(data):
+        for k, v in iter(data.items()):
             new_v = v
             if isinstance(v, dict):
                 new_v = allow_null_optional_fields(v, data, parent, k)
@@ -103,11 +113,14 @@ def write_schema_file(schema, filename):
     print("JSON schema written to {filename}".format(filename=filename))
 
 
-if len(sys.argv) == 0:
+
+
+if __name__ == "__main__":
+  if len(sys.argv) == 0:
       print("missing file")
       exit(1)
 
-for crdFile in sys.argv[1:]:
+  for crdFile in sys.argv[1:]:
       if crdFile.startswith("http"):
         f = urllib.request.urlopen(crdFile)
       else:
@@ -159,4 +172,4 @@ for crdFile in sys.argv[1:]:
                   schema = y["spec"]["validation"]["openAPIV3Schema"]
                   write_schema_file(schema, filename)
 
-exit(0)
+  exit(0)

scripts/requirements.txt

@@ -1 +1,2 @@
 pyyaml
+pytest