# -*- coding: utf8 -*-
-# ============LICENSE_START=======================================================
+# ============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
-# under the Apache License, Version 2.0 (the “License”);
+# under the Apache License, Version 2.0 (the "License");
# you may not use this software except in compliance with the License.
# You may obtain a copy of the License at
#
#
#
# Unless otherwise specified, all documentation contained herein is licensed
-# under the Creative Commons License, Attribution 4.0 Intl. (the “License”);
+# under the Creative Commons License, Attribution 4.0 Intl. (the "License");
# you may not use this documentation except in compliance with the License.
# You may obtain a copy of the License at
#
#
# ============LICENSE_END============================================
#
-# ECOMP is a trademark and service mark of AT&T Intellectual Property.
#
from os import listdir
from os import path
+import re
+
from .helpers import check_basename_ending
+from .helpers import validates
+
+
+RE_BASE = re.compile(r"(^base$)|(^base_)|(_base_)|(_base$)")
+@validates("R-37028", "R-87485", "R-81339", "R-87247", "R-76057")
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']]
+ """
+ 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 (filename.endswith("_base") or
- filename.startswith("base_") or
- filename.find("_base_") > 0):
- base_template_count += 1
- assert base_template_count == 1
+ 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