ice_validator/tests/test_nova_servers_environment_context.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 """environment context
  42 """
  43
  44 import pytest
  45 from tests import cached_yaml as yaml
  46
  47 from .helpers import validates
  48
  49 VERSION = "1.0.0"
  50
  51
  52 @validates("R-20308")
  53 def test_environment_context(heat_template):
  54     """
  55     A VNF's Heat Orchestration Template's OS::Nova::Server Resource
  56     **MUST**
  57     contain the metadata map value parameter 'environment_context'.
  58
  59     A VNF's Heat Orchestration Template's OS::Nova::Server Resource
  60     metadata map value parameter 'environment_context' **MUST**
  61     be declared as type: 'string'.
  62     """
  63     with open(heat_template) as fh:
  64         yml = yaml.load(fh)
  65
  66     if "parameters" not in yml:
  67         pytest.skip("No parameters specified in the heat template")
  68     if "resources" not in yml:
  69         pytest.skip("No resources specified in the heat template")
  70
  71     for resource, v in yml["resources"].items():
  72         if (
  73             not isinstance(v, dict)
  74             or v.get("type") != "OS::Nova::Server"
  75             or "properties" not in v
  76         ):
  77             continue
  78         metadata = v["properties"].get("metadata")
  79         if not isinstance(metadata, dict):
  80             continue
  81         error = validate_metadata(metadata, yml["parameters"])
  82         if error:
  83             assert False, '%s resource "%s" %s' % (heat_template, resource, error)
  84
  85
  86 def validate_metadata(metadata, parameters):
  87     """validate metatdata.
  88     Ensure metadata references parameter environment_context,
  89     and that it is a string.
  90     Return error message string or None if no errors.
  91     """
  92     for value in metadata.values():
  93         if isinstance(value, dict):
  94             if "get_param" in value:
  95                 if value["get_param"] == "environment_context":
  96                     wc = parameters.get("environment_context", {})
  97                     if wc.get("type") == "string":
  98                         break
  99                     else:
 100                         return (
 101                             'must have parameter "environment_context"'
 102                             ' of type "string"'
 103                         )
 104                     break
 105     else:
 106         return None