ice_validator/tests/test_servers_have_optional_metadata.py

   1 # -*- coding: utf8 -*-
   2 # ============LICENSE_START=======================================================
   3 # org.onap.vvp/validation-scripts
   4 # ===================================================================
   5 # Copyright © 2018 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 import pytest
  43
  44
  45 def test_servers_have_optional_metadata(yaml_file):
  46     '''
  47     Check that if optional metadata is included in the metadata
  48     for nova servers, they are specified in parameters
  49     '''
  50     with open(yaml_file) as fh:
  51         yml = yaml.load(fh)
  52
  53     # skip if parameters are not defined
  54     if "parameters" not in yml:
  55         pytest.skip("No parameters specified in the heat template")
  56
  57     # Check if the param vm_role is defined
  58     if "resources" not in yml:
  59         pytest.skip("No resources specified in the heat template")
  60
  61     optional_metadata = ["vf_module_name", "vf_module_index"]
  62     specified_optional_metadata = [k
  63                                    for k in yml["parameters"].keys()
  64                                    if k in optional_metadata]
  65
  66     need_optional_metadata = []
  67     for v in yml["resources"].values():
  68         keys = []
  69         if v.get("type") == "OS::Nova::Server":
  70             if 'properties' not in v:
  71                 continue
  72             if 'metadata' not in v['properties']:
  73                 continue
  74
  75             keys = v["properties"]["metadata"].keys()
  76         elif v.get("type") == "OS::Heat::ResourceGroup":
  77             if 'resource_def' not in v:
  78                 continue
  79             if 'properties' not in v['resource_def']:
  80                 continue
  81
  82             keys = v["resource_def"]["properties"].keys()
  83
  84         for key in keys:
  85             if key in optional_metadata:
  86                 need_optional_metadata.append(key)
  87
  88     if not need_optional_metadata:
  89         pytest.skip("No optional metadata is specified in the heat template")
  90
  91     # Check that if optional metadata is included in the metadata
  92     # for nova servers, they are specified in parameters
  93     assert set(specified_optional_metadata) == set(need_optional_metadata)