[VVP-171] R-84123 and R-76160 test update

R-84123 and R-76160
test_neutron_port_internal_fixed_ips
should only be checking incremental modules

Change-Id: I7ef3cd4aa2b01273c2592f0b17751c5cb79c002b
Issue-ID: VVP-171
Signed-off-by: stark, steven <steven.stark@att.com>

1 files changed, 293 insertions, 0 deletions

diff --git a/ice_validator/tests/test_neutron_port_fixed_ips_subnet.py b/ice_validator/tests/test_neutron_port_fixed_ips_subnet.py
new file mode 100644
index 0000000..7b9bf3b
--- /dev/null
+++ b/ice_validator/tests/test_neutron_port_fixed_ips_subnet.py
@@ -0,0 +1,293 @@
+# -*- coding: utf8 -*-
+# ============LICENSE_START====================================================
+# org.onap.vvp/validation-scripts
+# ===================================================================
+# Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+# ===================================================================
+#
+# Unless otherwise specified, all software contained herein is licensed
+# under the Apache License, Version 2.0 (the "License");
+# you may not use this software except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#             http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+#
+#
+# Unless otherwise specified, all documentation contained herein is licensed
+# under the Creative Commons License, Attribution 4.0 Intl. (the "License");
+# you may not use this documentation except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#             https://creativecommons.org/licenses/by/4.0/
+#
+# Unless required by applicable law or agreed to in writing, documentation
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# ============LICENSE_END============================================
+#
+#
+
+"""
+resources:
+{vm-type}_{vm-type_index}_{network-role}_port_{port-index}:
+  type: OS::Neutron::Port
+  properties:
+    network: { get_param: ...}
+    fixed_ips: [ { "ipaddress": { get_param: ... } } ]
+    binding:vnic_type: direct           #only SR-IOV ports, not OVS ports
+    value_specs: {
+      vlan_filter: { get_param: ... },  #all NC ports
+      public_vlans: { get_param: ... }, #all NC ports
+      private_vlans: { get_param: ... },#all NC ports
+      guest_vlans: { get_param: ... },  #SR-IOV Trunk Port only
+      vlan_mirror: { get_param: ... },  #SRIOV Trunk Port
+                                        # Receiving Mirrored Traffic only
+     ATT_FABRIC_CONFIGURATION_REQUIRED: true #all NC ports
+    }
+  metadata:
+    port_type: SR-IOV_Trunk             #SR-IOV Trunk Port
+    port_type: SR-IOV_Non_Trunk         #SR-IOV Non Trunk Port
+    port_type: OVS                      #OVS Port
+    port_type: SR-IOV_Mirrored_Trunk    #SR-IOV Trunk Port
+                                        # Receiving Mirrored Traffic
+"""
+import re
+
+import pytest
+
+from .structures import Heat
+from .helpers import validates, get_base_template_from_yaml_file
+
+VERSION = "1.3.0"
+
+RE_BASE = re.compile(r"(^base$)|(^base_)|(_base_)|(_base$)")  # search pattern
+
+RE_EXTERNAL_PARAM_SUBNET = re.compile(  # match pattern
+    r"(?P<network_role>.+)(_v6)?_subnet_id$"
+)
+
+RE_INTERNAL_PARAM_SUBNET = re.compile(  # match pattern
+    r"int_(?P<network_role>.+)(_v6)?_subnet_id$"
+)
+
+
+def get_base(base_template_filepath):
+    """Return the base template's Heat instance.
+    """
+    if base_template_filepath is None:
+        pytest.skip("No base template found")
+    base_template = Heat(filepath=base_template_filepath)
+    return base_template
+
+
+def run_test(heat_template, validate, validator=None):
+    """call validate for each fixed_ips
+    """
+    heat = Heat(filepath=heat_template)
+    base_template = get_base_template_from_yaml_file(heat_template)
+    if not heat.resources:
+        pytest.skip("No resources found")
+
+    neutron_ports = heat.neutron_port_resources
+    if not neutron_ports:
+        pytest.skip("No OS::Neutron::Port resources found")
+
+    bad = {}
+    for rid, resource in neutron_ports.items():
+        fixed_ips = heat.nested_get(resource, "properties", "fixed_ips")
+        if fixed_ips is None:
+            continue
+        if not isinstance(fixed_ips, list):
+            bad[rid] = "properties.fixed_ips must be a list."
+            continue
+        for fixed_ip in fixed_ips:
+            error = validate(heat, fixed_ip, base_template, validator)
+            if error:
+                bad[rid] = error
+                break
+    if bad:
+        # raise RuntimeError(
+        raise AssertionError(
+            "%s"
+            % (",   ".join("%s: %s" % (rid, error) for rid, error in bad.items()))
+        )
+
+
+def validate_external_fixed_ip_subnet(heat, fixed_ip, base_template, validator):
+    """ensure fixed_ip subnet for external network
+    match the pattern.
+    Returns error message string or None.
+    """
+    subnet = heat.nested_get(fixed_ip, "subnet", "get_param")
+    if subnet:
+        error = validator(subnet, RE_EXTERNAL_PARAM_SUBNET)
+    else:
+        error = None
+    return error
+
+
+def validate_external_subnet_parameter_format(subnet, regx):
+    """ensure subnet matches template.
+    Returns error message string or None.
+    """
+    if subnet and not subnet.startswith("int_") and regx.match(subnet) is None:
+        return (
+            'fixed_ip subnet parameter "%s" does not match '
+            "{network-role}_subnet_id or {network-role}_v6_subnet_id" % (subnet)
+        )
+    return None
+
+
+def validate_internal_fixed_ip_subnet(heat, fixed_ip, base_template, validator):
+    """ensure fixed_ip subnet for internal network
+    match the pattern.
+    Returns error message string or None.
+    """
+    base_module = get_base(base_template)
+    subnet = heat.nested_get(fixed_ip, "subnet", "get_param")
+    if subnet:
+        error = validator(heat, base_module, subnet, RE_INTERNAL_PARAM_SUBNET)
+    else:
+        error = None
+    return error
+
+
+def validate_internal_subnet_parameter_format(heat, base_module, subnet, regx):
+    """ensure if subnet matches template then its parameter exists.
+    Returns error message string or None.
+    """
+    if subnet and subnet.startswith("int_") and regx.match(subnet) is None:
+        return (
+            'fixed_ip subnet parameter "%s" does not match '
+            "int_{network-role}_subnet_id or int_{network-role}_v6_subnet_id" % (subnet)
+        )
+    return None
+
+
+def validate_internal_subnet_exists_in_base_output(heat, base_module, subnet, regx):
+    """ensure if subnet matches template then its parameter exists.
+    Returns error message string or None.
+    """
+    if (
+        subnet
+        and subnet.startswith("int_")
+        and regx.match(subnet)
+        and heat.nested_get(base_module.outputs, subnet) is None
+    ):
+        return 'fixed_ip subnet(_id) parameter "%s" not in base outputs"' % (subnet)
+    return None
+
+
+def validate_fixed_ip_subnet(heat, fixed_ip, base_template, validator):
+    """ensure fixed_ip has proper parameters
+    Returns error message string or None.
+    """
+    subnet = heat.nested_get(fixed_ip, "subnet", "get_param")
+    if subnet and heat.nested_get(heat.parameters, subnet, "type") != "string":
+        error = 'subnet parameter "%s" must be type "string"' % subnet
+    else:
+        error = None
+    return error
+
+
+@validates("R-38236")
+def test_neutron_port_fixed_ips_subnet(yaml_file):
+    """
+    The VNF's Heat Orchestration Template's
+    resource ``OS::Neutron::Port`` property ``fixed_ips``
+    map property ``subnet``/``subnet_id`` parameter
+    **MUST** be declared type ``string``.
+    """
+    run_test(yaml_file, validate_fixed_ip_subnet)
+
+
+@validates("R-62802", "R-15287")
+def test_neutron_port_external_fixed_ips_subnet(yaml_file):
+    """
+    When the VNF's Heat Orchestration Template's
+    resource ``OS::Neutron::Port`` is attaching
+    to an external network,
+    and an IPv4 address is being cloud assigned by OpenStack's DHCP Service
+    and the external network IPv4 subnet is to be specified
+    using the property ``fixed_ips``
+    map property ``subnet``/``subnet_id``, the parameter
+    **MUST** follow the naming convention
+
+      * ``{network-role}_subnet_id``
+    and the external network IPv6 subnet is to be specified
+      * ``{network-role}_v6_subnet_id``
+    """
+    run_test(
+        yaml_file,
+        validate_external_fixed_ip_subnet,
+        validate_external_subnet_parameter_format,
+    )
+
+
+@validates("R-84123", "R-76160")
+def test_neutron_port_internal_fixed_ips_subnet(yaml_file):
+    """
+    When
+
+      * the VNF's Heat Orchestration Template's
+        resource ``OS::Neutron::Port`` in an Incremental Module is attaching
+        to an internal network
+        that is created in the Base Module, AND
+      * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND
+      * the internal network IPv4 subnet is to be specified
+        using the property ``fixed_ips`` map property ``subnet``/``subnet_id``,
+
+    the parameter **MUST** follow the naming convention
+
+      * ``int_{network-role}_subnet_id``
+    an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND
+      * ``int_{network-role}_v6_subnet_id``
+
+    """
+    run_test(
+        yaml_file,
+        validate_internal_fixed_ip_subnet,
+        validate_internal_subnet_parameter_format,
+    )
+
+
+@validates("R-84123", "R-76160")
+def test_neutron_port_internal_fixed_ips_subnet_in_base(heat_template):
+    """
+    Only check parent incremental modules, because nested file parameter
+    name may have been changed.
+
+    When
+
+      * the VNF's Heat Orchestration Template's
+        resource ``OS::Neutron::Port`` in an Incremental Module is attaching
+        to an internal network
+        that is created in the Base Module, AND
+      * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND
+      * the internal network IPv4 subnet is to be specified
+        using the property ``fixed_ips`` map property ``subnet``/``subnet_id``,
+
+    the parameter **MUST** follow the naming convention
+
+      * ``int_{network-role}_subnet_id``
+    an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND
+      * ``int_{network-role}_v6_subnet_id``
+
+    Note that the parameter MUST be defined as an output parameter in
+    the base module.
+    """
+    run_test(
+        heat_template,
+        validate_internal_fixed_ip_subnet,
+        validate_internal_subnet_exists_in_base_output,
+    )