CI: check the format of the swagger spec...

file as part of the test_style
integration test.

Signed-off-by: Diana Popa <[email protected]>

Author: dianpopa

api_server/swagger/firecracker.yaml

@@ -308,9 +308,9 @@ definitions:
     description:
       Boot source descriptor.
     properties:
-    kernel_image_path:
-            type: string
-            description: Host level path to the kernel image used to boot the guest
+      kernel_image_path:
+        type: string
+        description: Host level path to the kernel image used to boot the guest
       boot_args:
         type: string
         description: Kernel boot arguments

tests/integration_tests/build/test_style.py

@@ -2,7 +2,10 @@
 
 from subprocess import run, PIPE
 
+import os
+
 import pytest
+import yaml
 
 
 SUCCESS_CODE = 0
@@ -76,3 +79,16 @@ def test_python_style():
         shell=True,
         check=True
     )
+
+
+def test_yaml_style():
+    """Fail if our swagger specification is malformed."""
+    yaml_spec = os.path.normpath(
+         os.path.join(os.getcwd(), '../api_server/swagger/firecracker.yaml')
+     )
+    with open(yaml_spec, 'r') as file_stream:
+        try:
+            yaml.safe_load(file_stream)
+        # pylint: disable=broad-except
+        except Exception as exception:
+            print(str(exception))

tests/testrun.sh

@@ -50,6 +50,7 @@ declare -ra PYTHON_DEPS=( \
      retry \
      nsenter \
      pylint pycodestyle pydocstyle \
+     pyyaml \
 )
 
 declare -r RUSTUP_URL=https://sh.rustup.rs