[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, 89 insertions, 47 deletions

diff --git a/ice_validator/tests/test_allowed_address_pair_format.py b/ice_validator/tests/test_allowed_address_pair_format.py
index 721d5c9..816f486 100644
--- a/ice_validator/tests/test_allowed_address_pair_format.py
+++ b/ice_validator/tests/test_allowed_address_pair_format.py
@@ -38,54 +38,91 @@
 # ECOMP is a trademark and service mark of AT&T Intellectual Property.
 #
 
-'''
+"""
 test_allowed_address_pairs_format
-'''
+"""
 
 import re
 
 import pytest
 import yaml
 
-from .utils.network_roles import get_network_role_from_port, \
-    property_uses_get_resource
+from .utils.network_roles import get_network_role_from_port, property_uses_get_resource
 
-VERSION = '1.0.0'
+VERSION = "1.0.0"
 
 # pylint: disable=invalid-name
 
 
 def test_allowed_address_pairs_format(heat_template):
-    '''
+    """
     Make sure all allowed_address_pairs properties follow the allowed
     naming conventions
-    '''
+    """
     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')],
-                      ]
+        [
+            "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"),
+        ],
+    ]
 
     with open(heat_template) as fh:
         yml = yaml.load(fh)
@@ -98,17 +135,18 @@ def test_allowed_address_pairs_format(heat_template):
     invalid_allowed_address_pairs = []
 
     for v1 in yml["resources"].values():
-        if (not isinstance(v1, dict)
-                or "properties" not in v1
-                or v1.get("type") != "OS::Neutron::Port"
-                or property_uses_get_resource(v1, "network")):
+        if (
+            not isinstance(v1, dict) or
+                "properties" not in v1 or
+                v1.get("type") != "OS::Neutron::Port" or
+                property_uses_get_resource(v1, "network")
+        ):
             continue
         network_role = get_network_role_from_port(v1)
 
         v2 = v1["properties"].get("allowed_address_pairs", {})
         for v3 in v2:
-            if ("ip_address" not in v3
-                    or "get_param" not in v3["ip_address"]):
+            if "ip_address" not in v3 or "get_param" not in v3["ip_address"]:
                 continue
 
             param = v3["ip_address"]["get_param"]
@@ -119,17 +157,21 @@ def test_allowed_address_pairs_format(heat_template):
                 # check if pattern matches
                 m = v4[3].match(param)
                 if m:
-                    if (v4[2] == "internal"
-                            and len(m.groups()) > 1
-                            and m.group(2) == network_role):
+                    if (
+                        v4[2] == "internal" and
+                            len(m.groups()) > 1 and
+                            m.group(2) == network_role
+                    ):
                         break
-                    elif (v4[2] == "external"
-                            and len(m.groups()) > 0
-                            and m.group(1).endswith("_" + network_role)):
+                    elif (
+                        v4[2] == "external"
+                        and len(m.groups()) > 0
+                        and m.group(1).endswith("_" + network_role)
+                    ):
                         break
             else:
                 invalid_allowed_address_pairs.append(param)
 
-    assert not set(invalid_allowed_address_pairs), (
-            'invalid_allowed_address_pairs %s' % list(
-                    set(invalid_allowed_address_pairs)))
+    assert not set(
+        invalid_allowed_address_pairs
+    ), "invalid_allowed_address_pairs %s" % list(set(invalid_allowed_address_pairs))