ice_validator/tests/test_base_template_names.py

   1 # -*- coding: utf8 -*-
   2 # ============LICENSE_START====================================================
   3 # org.onap.vvp/validation-scripts
   4 # ===================================================================
   5 # Copyright © 2019 AT&T Intellectual Property. All rights reserved.
   6 # ===================================================================
   7 #
   8 # Unless otherwise specified, all software contained herein is licensed
   9 # under the Apache License, Version 2.0 (the "License");
  10 # you may not use this software except in compliance with the License.
  11 # You may obtain a copy of the License at
  12 #
  13 #             http://www.apache.org/licenses/LICENSE-2.0
  14 #
  15 # Unless required by applicable law or agreed to in writing, software
  16 # distributed under the License is distributed on an "AS IS" BASIS,
  17 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18 # See the License for the specific language governing permissions and
  19 # limitations under the License.
  20 #
  21 #
  22 #
  23 # Unless otherwise specified, all documentation contained herein is licensed
  24 # under the Creative Commons License, Attribution 4.0 Intl. (the "License");
  25 # you may not use this documentation except in compliance with the License.
  26 # You may obtain a copy of the License at
  27 #
  28 #             https://creativecommons.org/licenses/by/4.0/
  29 #
  30 # Unless required by applicable law or agreed to in writing, documentation
  31 # distributed under the License is distributed on an "AS IS" BASIS,
  32 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  33 # See the License for the specific language governing permissions and
  34 # limitations under the License.
  35 #
  36 # ============LICENSE_END============================================
  37 #
  38 #
  39
  40 from os import listdir
  41 from os import path
  42 import re
  43
  44 from .helpers import check_basename_ending
  45 from .helpers import validates
  46
  47
  48 RE_BASE = re.compile(r"(^base$)|(^base_)|(_base_)|(_base$)")
  49
  50
  51 @validates("R-37028", "R-87485", "R-81339", "R-87247", "R-76057")
  52 def test_base_template_names(template_dir):
  53     """
  54     Check all base templates have a filename that includes "_base_".
  55     """
  56     filenames = [
  57         f
  58         for f in listdir(template_dir)
  59         if path.isfile(path.join(template_dir, f))
  60         and path.splitext(f)[-1] in [".yaml", ".yml"]
  61     ]
  62
  63     base_modules = []
  64     for filename in filenames:
  65         basename = path.splitext(filename)[0]
  66
  67         # volume templates are tied to their parent naming wise
  68         if check_basename_ending("volume", basename):
  69             continue
  70
  71         if RE_BASE.search(basename.lower()):
  72             base_modules.append(filename)
  73
  74     if not base_modules:
  75         msg = (
  76             "No base module detected in the following files "
  77             "from the template directory: {}"
  78         ).format(", ".join(filenames))
  79     elif len(base_modules) > 1:
  80         msg = (
  81             "Multiple base modules detected in the template "
  82             "directory, but only one is allowed: {}"
  83         ).format(", ".join(base_modules))
  84     else:
  85         msg = ""
  86
  87     assert len(base_modules) == 1, msg