[VVP] Added new three new reports

Resolves VVP-81 by introducing three new reports to the validation
script output.

Each report is written to the output directory under ice_validator.

* mapping_errors.csv - each row represents an issue where a test is
                       mapped to a requirement that does not exist
                       in the requirement.json file
* traceability.csv   - Shows a mapping between all test cases and
                       requirements.  Rows will also be shown
                       where a requirement does not have a tests, and
                       where tests are not mapped to a requirement
* report.{html|csv|xlsx} - Formatted error report that shows each
                           failure that was detected and maps it to
                           a the file name, requirement(s) violated if
                           known, possible resolution steps, error
                           message, and raw output from pytest.  The
                           report can be written in html, csv, or Excel
                           format

Other minor changes:
* Replaced smart quotes with regular quotes to resolve issues with py3
* Updated copyright of modified files
* Fixed Flake-8 errors

Issue-ID: VVP-81

Change-Id: I659836cb20262ae44652c03639281a817dd051ae
Signed-off-by: Lovett, Trevor (tl2972) <tl2972@att.com>

1 files changed, 105 insertions, 71 deletions

diff --git a/ice_validator/tests/utils/ports.py b/ice_validator/tests/utils/ports.py
index c9d4be9..e479201 100644
--- a/ice_validator/tests/utils/ports.py
+++ b/ice_validator/tests/utils/ports.py
@@ -44,53 +44,93 @@ import re
 
 
 def is_valid_ip_address(ip_address, vm_type, network_role, port_property):
-    '''
+    """
     Check the ip_address to make sure it is properly formatted and
     also contains {vm_type} and {network_role}
-    '''
+    """
 
     allowed_formats = [
-                      ["allowed_address_pairs", "string", "internal",
-                       re.compile(r'(.+?)_int_(.+?)_floating_v6_ip')],
-                      ["allowed_address_pairs", "string", "internal",
-                       re.compile(r'(.+?)_int_(.+?)_floating_ip')],
-                      ["allowed_address_pairs", "string", "external",
-                       re.compile(r'(.+?)_floating_v6_ip')],
-                      ["allowed_address_pairs", "string", "external",
-                       re.compile(r'(.+?)_floating_ip')],
-                      ["allowed_address_pairs", "string", "internal",
-                       re.compile(r'(.+?)_int_(.+?)_v6_ip_\d+')],
-                      ["allowed_address_pairs", "string", "internal",
-                       re.compile(r'(.+?)_int_(.+?)_ip_\d+')],
-                      ["allowed_address_pairs", "string", "external",
-                       re.compile(r'(.+?)_v6_ip_\d+')],
-                      ["allowed_address_pairs", "string", "external",
-                       re.compile(r'(.+?)_ip_\d+')],
-                      ["allowed_address_pairs", "comma_delimited_list",
-                       "internal", re.compile(r'(.+?)_int_(.+?)_v6_ips')],
-                      ["allowed_address_pairs", "comma_delimited_list",
-                       "internal", re.compile(r'(.+?)_int_(.+?)_ips')],
-                      ["allowed_address_pairs", "comma_delimited_list",
-                       "external", re.compile(r'(.+?)_v6_ips')],
-                      ["allowed_address_pairs", "comma_delimited_list",
-                       "external", re.compile(r'(.+?)_ips')],
-                      ["fixed_ips", "string", "internal",
-                       re.compile(r'(.+?)_int_(.+?)_v6_ip_\d+')],
-                      ["fixed_ips", "string", "internal",
-                       re.compile(r'(.+?)_int_(.+?)_ip_\d+')],
-                      ["fixed_ips", "string", "external",
-                       re.compile(r'(.+?)_v6_ip_\d+')],
-                      ["fixed_ips", "string", "external",
-                       re.compile(r'(.+?)_ip_\d+')],
-                      ["fixed_ips", "comma_delimited_list", "internal",
-                       re.compile(r'(.+?)_int_(.+?)_v6_ips')],
-                      ["fixed_ips", "comma_delimited_list", "internal",
-                       re.compile(r'(.+?)_int_(.+?)_ips')],
-                      ["fixed_ips", "comma_delimited_list", "external",
-                       re.compile(r'(.+?)_v6_ips')],
-                      ["fixed_ips", "comma_delimited_list", "external",
-                       re.compile(r'(.+?)_ips')],
-                      ]
+        [
+            "allowed_address_pairs",
+            "string",
+            "internal",
+            re.compile(r"(.+?)_int_(.+?)_floating_v6_ip"),
+        ],
+        [
+            "allowed_address_pairs",
+            "string",
+            "internal",
+            re.compile(r"(.+?)_int_(.+?)_floating_ip"),
+        ],
+        [
+            "allowed_address_pairs",
+            "string",
+            "external",
+            re.compile(r"(.+?)_floating_v6_ip"),
+        ],
+        [
+            "allowed_address_pairs",
+            "string",
+            "external",
+            re.compile(r"(.+?)_floating_ip"),
+        ],
+        [
+            "allowed_address_pairs",
+            "string",
+            "internal",
+            re.compile(r"(.+?)_int_(.+?)_v6_ip_\d+"),
+        ],
+        [
+            "allowed_address_pairs",
+            "string",
+            "internal",
+            re.compile(r"(.+?)_int_(.+?)_ip_\d+"),
+        ],
+        ["allowed_address_pairs", "string", "external", re.compile(r"(.+?)_v6_ip_\d+")],
+        ["allowed_address_pairs", "string", "external", re.compile(r"(.+?)_ip_\d+")],
+        [
+            "allowed_address_pairs",
+            "comma_delimited_list",
+            "internal",
+            re.compile(r"(.+?)_int_(.+?)_v6_ips"),
+        ],
+        [
+            "allowed_address_pairs",
+            "comma_delimited_list",
+            "internal",
+            re.compile(r"(.+?)_int_(.+?)_ips"),
+        ],
+        [
+            "allowed_address_pairs",
+            "comma_delimited_list",
+            "external",
+            re.compile(r"(.+?)_v6_ips"),
+        ],
+        [
+            "allowed_address_pairs",
+            "comma_delimited_list",
+            "external",
+            re.compile(r"(.+?)_ips"),
+        ],
+        ["fixed_ips", "string", "internal", re.compile(r"(.+?)_int_(.+?)_v6_ip_\d+")],
+        ["fixed_ips", "string", "internal", re.compile(r"(.+?)_int_(.+?)_ip_\d+")],
+        ["fixed_ips", "string", "external", re.compile(r"(.+?)_v6_ip_\d+")],
+        ["fixed_ips", "string", "external", re.compile(r"(.+?)_ip_\d+")],
+        [
+            "fixed_ips",
+            "comma_delimited_list",
+            "internal",
+            re.compile(r"(.+?)_int_(.+?)_v6_ips"),
+        ],
+        [
+            "fixed_ips",
+            "comma_delimited_list",
+            "internal",
+            re.compile(r"(.+?)_int_(.+?)_ips"),
+        ],
+        ["fixed_ips", "comma_delimited_list", "external", re.compile(r"(.+?)_v6_ips")],
+        ["fixed_ips", "comma_delimited_list", "external", re.compile(r"(.+?)_ips")],
+    ]
 
     for v3 in allowed_formats:
         if v3[0] != port_property:
@@ -98,33 +138,30 @@ def is_valid_ip_address(ip_address, vm_type, network_role, port_property):
         # check if pattern matches
         m = v3[3].match(ip_address)
         if m:
-            if (v3[2] == "internal" and
-                    len(m.groups()) > 1):
-                    return m.group(1) == vm_type and\
-                        m.group(2) == network_role
-            elif (v3[2] == "external" and
-                  len(m.groups()) > 0):
+            if v3[2] == "internal" and len(m.groups()) > 1:
+                return m.group(1) == vm_type and m.group(2) == network_role
+            elif v3[2] == "external" and len(m.groups()) > 0:
                 return m.group(1) == vm_type + "_" + network_role
 
     return False
 
 
 def get_invalid_ip_addresses(resources, port_property):
-    '''
+    """
     Get a list of valid ip addresses for a heat resources section
-    '''
+    """
     invalid_ip_addresses = []
 
     for k, v in resources.items():
         if not isinstance(v, dict):
             continue
-        if 'type' not in v:
+        if "type" not in v:
             continue
-        if v['type'] not in 'OS::Nova::Server':
+        if v["type"] not in "OS::Nova::Server":
             continue
-        if 'properties' not in v:
+        if "properties" not in v:
             continue
-        if 'networks' not in v['properties']:
+        if "networks" not in v["properties"]:
             continue
 
         port_resource = None
@@ -134,16 +171,16 @@ def get_invalid_ip_addresses(resources, port_property):
             continue
 
         # get all ports associated with the nova server
-        properties = v['properties']
-        for network in properties['networks']:
+        properties = v["properties"]
+        for network in properties["networks"]:
             for k3, v3 in network.items():
-                if k3 != 'port':
+                if k3 != "port":
                     continue
                 if not isinstance(v3, dict):
                     continue
 
-                if 'get_resource' in v3:
-                    port_id = v3['get_resource']
+                if "get_resource" in v3:
+                    port_id = v3["get_resource"]
                     if not resources[port_id]:
                         continue
                     port_resource = resources[port_id]
@@ -168,10 +205,9 @@ def get_invalid_ip_addresses(resources, port_property):
                         if isinstance(ip_address, list):
                             ip_address = ip_address[0]
 
-                        valid_ip_address = is_valid_ip_address(ip_address,
-                                                               vm_type,
-                                                               network_role,
-                                                               port_property)
+                        valid_ip_address = is_valid_ip_address(
+                            ip_address, vm_type, network_role, port_property
+                        )
 
                         if not valid_ip_address:
                             invalid_ip_addresses.append(ip_address)
@@ -180,16 +216,14 @@ def get_invalid_ip_addresses(resources, port_property):
 
 
 def is_reserved_port(port_id):
-    '''
+    """
     Checks to see if the resource id for a port follows
     the reserve port concept
-    '''
+    """
     formats = [
-            ["port_id",
-             re.compile(r'reserve_port_(.+?)_floating_ip_\d+')],
-            ["port_id",
-             re.compile(r'reserve_port_(.+?)_floating_v6_ip_\d+')],
-            ]
+        ["port_id", re.compile(r"reserve_port_(.+?)_floating_ip_\d+")],
+        ["port_id", re.compile(r"reserve_port_(.+?)_floating_v6_ip_\d+")],
+    ]
     for f in formats:
         m = f[1].match(port_id.lower())
         if m and m.group(1):