Add YAML sanity check
authorBen Nemec <bnemec@redhat.com>
Tue, 15 Sep 2015 19:07:45 +0000 (14:07 -0500)
committerBen Nemec <bnemec@redhat.com>
Tue, 15 Sep 2015 20:31:43 +0000 (15:31 -0500)
Adds a "validate" tox env for basic sanity checking of templates.
Currently it just validates that all of the .yaml files are in fact
valid YAML.  In the future we might want to add more, but this
seemed like a reasonable start.

Change-Id: I8091bbad0003b150e23dae5de4f465053c982229

tools/yaml-validate.py [new file with mode: 0755]
tox.ini

diff --git a/tools/yaml-validate.py b/tools/yaml-validate.py
new file mode 100755 (executable)
index 0000000..cb5669a
--- /dev/null
@@ -0,0 +1,46 @@
+#!/usr/bin/env python
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import os
+import sys
+import traceback
+import yaml
+
+base_path = sys.argv[1]
+exit_val = 0
+failed_files = []
+
+def validate(filename):
+    try:
+        yaml.load(open(filename).read())
+    except Exception:
+        print(traceback.format_exc())
+        return 1
+    return 0
+
+for subdir, dirs, files in os.walk(base_path):
+    for f in files:
+        if f.endswith('.yaml'):
+            file_path = os.path.join(subdir, f)
+            failed = validate(file_path)
+            if failed:
+                failed_files.append(file_path)
+            exit_val |= failed
+
+if failed_files:
+    print('Validation failed on:')
+    for f in failed_files:
+        print(f)
+else:
+    print('Validation successful!')
+sys.exit(exit_val)
diff --git a/tox.ini b/tox.ini
index a7823b1..bc14bda 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -9,3 +9,6 @@ deps = -r{toxinidir}/requirements.txt
 
 [testenv:venv]
 commands = {posargs}
+
+[testenv:validate]
+commands = python ./tools/yaml-validate.py .
\ No newline at end of file