ice_validator/tests/test_volume_resource_ids.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 re
  42 import pytest
  43 import yaml
  44 from .utils.vm_types import get_vm_type_for_nova_server
  45
  46
  47 def test_volume_resource_ids(heat_template):
  48     """
  49     Check that all resource ids for cinder volumes follow the right
  50     naming convention to include the {vm_type} of the
  51     nova server it is associated to
  52     """
  53     with open(heat_template) as fh:
  54         yml = yaml.load(fh)
  55
  56     # skip if resources are not defined
  57     if "resources" not in yml:
  58         pytest.skip("No resources specified in the heat template")
  59
  60     volume_pattern = re.compile(r"(.+?)_volume_id_\d+")
  61     resources = yml["resources"]
  62
  63     invalid_volumes = []
  64     for k, v in resources.items():
  65         if not isinstance(v, dict):
  66             continue
  67         if "type" not in v:
  68             continue
  69         if v["type"] not in ["OS::Nova::Server", "OS::Cinder::VolumeAttachment"]:
  70             continue
  71
  72         if v["type"] == "OS::Nova::Server":
  73             # check block_device_mapping and make sure the right
  74             # {vm_type} is used
  75             if "properties" not in v:
  76                 continue
  77             if "block_device_mapping" not in v["properties"]:
  78                 continue
  79
  80             vm_type = get_vm_type_for_nova_server(v)
  81             if not vm_type:
  82                 continue
  83             vm_type = vm_type.lower()
  84
  85             # get the volume_id from the block_device_mapping
  86             properties = v["properties"]
  87             for v2 in properties["block_device_mapping"]:
  88                 for k3, v3 in v2.items():
  89                     if k3 != "volume_id":
  90                         continue
  91                     if not isinstance(v3, dict):
  92                         continue
  93
  94                     volume_id = v3.get("get_param") or v3.get("get_resource")
  95                     if not volume_id:
  96                         continue
  97                     if isinstance(volume_id, list):
  98                         volume_id = volume_id[0].lower()
  99                     else:
 100                         volume_id = volume_id.lower()
 101
 102                     if vm_type + "_" not in volume_id:
 103                         invalid_volumes.append(volume_id)
 104
 105         elif v["type"] == "OS::Cinder::VolumeAttachment":
 106             # check the volume attachment and the {vm_type}
 107             # of the corresponding nova server
 108             if "properties" not in v:
 109                 continue
 110             if "volume_id" not in v["properties"]:
 111                 continue
 112             if "instance_uuid" not in v["properties"]:
 113                 continue
 114
 115             properties = v["properties"]
 116
 117             # get the instance_uuid and when applicable
 118             # the nova server instance
 119             instance_uuid = None
 120             nova_server = None
 121
 122             if "get_param" in properties["instance_uuid"]:
 123                 continue
 124             elif "get_resource" in properties["instance_uuid"]:
 125                 instance_uuid = properties["instance_uuid"]["get_resource"]
 126                 if not resources[instance_uuid]:
 127                     continue
 128                 nova_server = resources[instance_uuid]
 129                 instance_uuid = instance_uuid.lower()
 130             else:
 131                 continue
 132
 133             # get the volume_id
 134             volume_id = None
 135             volume_id = properties["volume_id"].get("get_param") or properties[
 136                 "volume_id"
 137             ].get("get_resource")
 138             if not volume_id:
 139                 continue
 140             if isinstance(volume_id, list):
 141                 volume_id = volume_id[0].lower()
 142             else:
 143                 volume_id = volume_id.lower()
 144
 145             # do not test the case when the instance_uuid and
 146             # volume_id are not defined
 147             if not instance_uuid and not volume_id:
 148                 continue
 149
 150             if nova_server:
 151                 vm_type = get_vm_type_for_nova_server(nova_server)
 152                 if not vm_type:
 153                     continue
 154                 vm_type = vm_type.lower()
 155                 if vm_type + "_" not in volume_id:
 156                     invalid_volumes.append(volume_id)
 157             else:
 158                 # extract the assumed {vm_type} from volume_id
 159                 m = volume_pattern.match(volume_id)
 160                 if m:
 161                     vm_type = m.group(1).lower()
 162                     if vm_type + "_" not in instance_uuid:
 163                         invalid_volumes.append(volume_id)
 164                 else:
 165                     continue
 166
 167     assert not set(invalid_volumes)