[VVP] Improved message on test_base_template_name
[vvp/validation-scripts.git] / ice_validator / tests / test_base_template_names.py
index 3553a10..9bbf165 100644 (file)
@@ -2,7 +2,7 @@
 # ============LICENSE_START====================================================
 # org.onap.vvp/validation-scripts
 # ===================================================================
-# Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+# Copyright © 2019 AT&T Intellectual Property. All rights reserved.
 # ===================================================================
 #
 # Unless otherwise specified, all software contained herein is licensed
@@ -37,9 +37,6 @@
 #
 #
 
-"""base template names
-"""
-
 from os import listdir
 from os import path
 import re
@@ -47,9 +44,7 @@ import re
 from .helpers import check_basename_ending
 from .helpers import validates
 
-VERSION = "1.2.0"
 
-# is 'base', starts with 'base_', contains '_base_', ends with '_base'
 RE_BASE = re.compile(r"(^base$)|(^base_)|(_base_)|(_base$)")
 
 
@@ -58,23 +53,35 @@ def test_base_template_names(template_dir):
     """
     Check all base templates have a filename that includes "_base_".
     """
-    base_template_count = 0
     filenames = [
         f
         for f in listdir(template_dir)
         if path.isfile(path.join(template_dir, f))
         and path.splitext(f)[-1] in [".yaml", ".yml"]
     ]
+
+    base_modules = []
     for filename in filenames:
-        filename = path.splitext(filename)[0]
+        basename = path.splitext(filename)[0]
 
         # volume templates are tied to their parent naming wise
-        if check_basename_ending("volume", filename):
+        if check_basename_ending("volume", basename):
             continue
 
-        if RE_BASE.search(filename.lower()):
-            base_template_count += 1
-    assert base_template_count == 1, 'must be 1 "*_base_*" in %s not %d' % (
-        filenames,
-        base_template_count,
-    )
+        if RE_BASE.search(basename.lower()):
+            base_modules.append(filename)
+
+    if not base_modules:
+        msg = (
+            "No base module detected in the following files "
+            "from the template directory: {}"
+        ).format(", ".join(filenames))
+    elif len(base_modules) > 1:
+        msg = (
+            "Multiple base modules detected in the template "
+            "directory, but only one is allowed: {}"
+        ).format(", ".join(base_modules))
+    else:
+        msg = ""
+
+    assert len(base_modules) == 1, msg