[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, 36 insertions, 46 deletions

diff --git a/ice_validator/tests/utils/network_roles.py b/ice_validator/tests/utils/network_roles.py
index 3f8d6b8..d4b2cce 100644
--- a/ice_validator/tests/utils/network_roles.py
+++ b/ice_validator/tests/utils/network_roles.py
@@ -43,37 +43,31 @@ import socket
 
 
 def get_network_role_from_port(resource):
-    '''
+    """
     get the network role from a neutron port resource
-    '''
+    """
     if not isinstance(resource, dict):
         return None
-    if 'type' not in resource:
+    if "type" not in resource:
         return None
-    if resource['type'] != 'OS::Neutron::Port':
+    if resource["type"] != "OS::Neutron::Port":
         return None
-    if 'properties' not in resource:
+    if "properties" not in resource:
         return None
 
     formats = [
-              ["network", "string", "internal",
-               re.compile(r'int_(.+?)_net_id')],
-              ["network", "string", "internal",
-               re.compile(r'int_(.+?)_net_name')],
-              ["network", "string", "external",
-               re.compile(r'(.+?)_net_id')],
-              ["network", "string", "external",
-               re.compile(r'(.+?)_net_name')],
-              ]
+        ["network", "string", "internal", re.compile(r"int_(.+?)_net_id")],
+        ["network", "string", "internal", re.compile(r"int_(.+?)_net_name")],
+        ["network", "string", "external", re.compile(r"(.+?)_net_id")],
+        ["network", "string", "external", re.compile(r"(.+?)_net_name")],
+    ]
 
     for k1, v1 in resource["properties"].items():
-        if k1 != 'network':
+        if k1 != "network":
             continue
 
         # get the network id or name
-        network = (
-            v1.get('get_param') or
-            v1.get('get_resource'))
+        network = v1.get("get_param") or v1.get("get_resource")
         if not network:
             continue
 
@@ -86,31 +80,27 @@ def get_network_role_from_port(resource):
 
 
 def get_network_type_from_port(resource):
-    '''
+    """
     get the network type from a neutron port resource
-    '''
+    """
     if not isinstance(resource, dict):
         return None
-    if 'type' not in resource:
+    if "type" not in resource:
         return None
-    if resource['type'] != 'OS::Neutron::Port':
+    if resource["type"] != "OS::Neutron::Port":
         return None
-    if 'properties' not in resource:
+    if "properties" not in resource:
         return None
 
     formats = [
-              ["network", "string", "internal",
-               re.compile(r'int_(.+?)_net_id')],
-              ["network", "string", "internal",
-               re.compile(r'int_(.+?)_net_name')],
-              ["network", "string", "external",
-               re.compile(r'(.+?)_net_id')],
-              ["network", "string", "external",
-               re.compile(r'(.+?)_net_name')],
-              ]
+        ["network", "string", "internal", re.compile(r"int_(.+?)_net_id")],
+        ["network", "string", "internal", re.compile(r"int_(.+?)_net_name")],
+        ["network", "string", "external", re.compile(r"(.+?)_net_id")],
+        ["network", "string", "external", re.compile(r"(.+?)_net_name")],
+    ]
 
     for k1, v1 in resource["properties"].items():
-        if k1 != 'network':
+        if k1 != "network":
             continue
         if "get_param" not in v1:
             continue
@@ -122,22 +112,22 @@ def get_network_type_from_port(resource):
     return None
 
 
-def is_valid_ip_address(ip_address, ip_type='ipv4'):
-    '''
+def is_valid_ip_address(ip_address, ip_type="ipv4"):
+    """
     check if an ip address is valid
-    '''
-    if ip_type == 'ipv4':
+    """
+    if ip_type == "ipv4":
         return is_valid_ipv4_address(ip_address)
-    elif ip_type == 'ipv6':
+    elif ip_type == "ipv6":
         return is_valid_ipv6_address(ip_address)
     return False
 
 
 def is_valid_ipv4_address(ip_address):
-    '''
+    """
     check if an ip address of the type ipv4
     is valid
-    '''
+    """
     try:
         socket.inet_pton(socket.AF_INET, ip_address)
     except AttributeError:
@@ -145,17 +135,17 @@ def is_valid_ipv4_address(ip_address):
             socket.inet_aton(ip_address)
         except (OSError, socket.error):
             return False
-        return ip_address.count('.') == 3
+        return ip_address.count(".") == 3
     except (OSError, socket.error):
         return False
     return True
 
 
 def is_valid_ipv6_address(ip_address):
-    '''
+    """
     check if an ip address of the type ipv6
     is valid
-    '''
+    """
     try:
         socket.inet_pton(socket.AF_INET6, ip_address)
     except (OSError, socket.error):
@@ -164,13 +154,13 @@ def is_valid_ipv6_address(ip_address):
 
 
 def property_uses_get_resource(resource, property_name):
-    '''
+    """
     returns true if a port's network property
     uses the get_resource function
-    '''
+    """
     if not isinstance(resource, dict):
         return False
-    if 'properties' not in resource:
+    if "properties" not in resource:
         return False
     for k1, v1 in resource["properties"].items():
         if k1 != property_name: