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