ice_validator/tests/helpers.py

   1 # -*- coding: utf8 -*-
   2 # ============LICENSE_START=======================================================
   3 # org.onap.vvp/validation-scripts
   4 # ===================================================================
   5 # Copyright © 2017 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 # ECOMP is a trademark and service mark of AT&T Intellectual Property.
  39 #
  40
  41 import yaml
  42 from boltons import funcutils
  43
  44
  45 def check_basename_ending(template_type, basename):
  46     '''
  47     return True/False if the template type is matching
  48     the filename
  49     '''
  50     if not template_type:
  51         return True
  52     elif template_type == 'volume':
  53         return basename.endswith('_volume')
  54     else:
  55         return not basename.endswith('_volume')
  56
  57
  58 def get_parsed_yml_for_yaml_files(yaml_files, sections=None):
  59     '''
  60     get the parsed yaml for a list of yaml files
  61     '''
  62     sections = [] if sections is None else sections
  63     parsed_yml_list = []
  64     for yaml_file in yaml_files:
  65         yml = ''
  66
  67         try:
  68             with open(yaml_file) as fh:
  69                 yml = yaml.load(fh)
  70         except Exception as e:
  71             print('Error in %s: %s' % (yaml_file, e))
  72             continue
  73         if yml:
  74             if sections:
  75                 for k in yml.keys():
  76                     if k not in sections:
  77                         del yml[k]
  78             parsed_yml_list.append(yml)
  79
  80     return parsed_yml_list
  81
  82
  83 def validates(*requirement_ids):
  84     """Decorator that tags the test function with one or more requirement IDs.
  85
  86     Example:
  87         >>> @validates('R-12345', 'R-12346')
  88         ... def test_something():
  89         ...     pass
  90         >>> assert test_something.requirement_ids == ['R-12345', 'R-12346']
  91     """
  92     def decorator(func):
  93         # NOTE: We use a utility here to ensure that function signatures are
  94         # maintained because pytest inspects function signatures to inject
  95         # fixtures.  I experimented with a few options, but this is the only
  96         # library that worked. Other libraries dynamically generated a
  97         # function at run-time, and then lost the requirement_ids attribute
  98         @funcutils.wraps(func)
  99         def wrapper(*args, **kw):
 100             return func(*args, **kw)
 101         wrapper.requirement_ids = requirement_ids
 102         return wrapper
 103     decorator.requirement_ids = requirement_ids
 104     return decorator