ice_validator/tests/test_port_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 .helpers import validates
  45 from .utils.vm_types import get_vm_type_for_nova_server
  46 from .utils.network_roles import (
  47     get_network_role_from_port,
  48     get_network_type_from_port,
  49     property_uses_get_resource,
  50 )
  51
  52
  53 @validates(
  54     "R-29865",
  55     "R-69014",
  56     "R-05201",
  57     "R-68936",
  58     "R-32025",
  59     "R-11168",
  60     "R-84322",
  61     "R-96983",
  62     "R-26506",
  63     "R-20453",
  64     "R-26351",
  65 )
  66 def test_port_resource_ids(heat_template):
  67     """
  68     Check that all resource ids for ports follow the right
  69     naming convention to include the {vm_type} of the
  70     nova server it is associated to and also contains the
  71     {network_role} of the network it is associated with
  72     """
  73     with open(heat_template) as fh:
  74         yml = yaml.load(fh)
  75
  76     # skip if resources are not defined
  77     if "resources" not in yml:
  78         pytest.skip("No resources specified in the heat template")
  79
  80     port_patterns = {
  81         "internal": re.compile(r"(.+?)_\d+_int_(.+?)_port_\d+"),
  82         "external": re.compile(r"(.+?)_\d+_(.+?)_port_\d+"),
  83     }
  84     resources = yml["resources"]
  85
  86     invalid_ports = []
  87     for k, v in resources.items():
  88         if not isinstance(v, dict):
  89             continue
  90         if "type" not in v:
  91             continue
  92         if v["type"] not in "OS::Nova::Server":
  93             continue
  94         if "properties" not in v:
  95             continue
  96         if "networks" not in v["properties"]:
  97             continue
  98
  99         has_vm_type = False
 100         has_network_role = True
 101         port_resource = None
 102
 103         vm_type = get_vm_type_for_nova_server(v)
 104         if not vm_type:
 105             continue
 106         vm_type = vm_type.lower()
 107
 108         # get all ports associated with the nova server
 109         properties = v["properties"]
 110         for v2 in properties["networks"]:
 111             for k3, v3 in v2.items():
 112                 if k3 != "port":
 113                     continue
 114                 if not isinstance(v3, dict):
 115                     continue
 116
 117                 if "get_param" in v3:
 118                     continue
 119                 elif "get_resource" in v3:
 120                     port_id = v3["get_resource"]
 121                     if not resources[port_id]:
 122                         continue
 123                     port_resource = resources[port_id]
 124                     port_id = port_id.lower()
 125                 else:
 126                     continue
 127
 128                 has_vm_type = vm_type + "_" in port_id
 129                 has_network_role = False
 130
 131                 if port_resource:
 132                     if property_uses_get_resource(v, "network"):
 133                         continue
 134                     network_role = get_network_role_from_port(port_resource)
 135                     if not network_role:
 136                         continue
 137                     network_role = network_role.lower()
 138
 139                     network_type = get_network_type_from_port(port_resource)
 140                     if not network_type:
 141                         continue
 142
 143                     if port_patterns[network_type].match(port_id):
 144                         has_network_role = True
 145                 else:
 146                     # match the assumed naming convention for ports
 147                     # if the specified port is provided via get_param
 148                     network_type = "external"
 149                     if "int_" in port_id:
 150                         network_type = "internal"
 151                     if port_patterns[network_type].match(port_id):
 152                         has_network_role = True
 153
 154                 if has_vm_type and has_network_role:
 155                     continue
 156                 invalid_ports.append(port_id)
 157
 158     assert not set(invalid_ports)