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