[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, 30 insertions, 34 deletions

diff --git a/ice_validator/tests/test_environment_file_structure.py b/ice_validator/tests/test_environment_file_structure.py
index b50629e..34d3b48 100644
--- a/ice_validator/tests/test_environment_file_structure.py
+++ b/ice_validator/tests/test_environment_file_structure.py
@@ -46,68 +46,64 @@ import pytest
 
 from .helpers import validates
 
-VERSION = '1.0.0'
+VERSION = "1.0.0"
 
 # pylint: disable=invalid-name
 
 
 def test_environment_structure(env_file):
-    '''
+    """
     Check that all environments files only have the allowed sections
-    '''
-    key_values = ["parameters", "event_sinks", "encrypted_parameters",
-                  "parameter_merge_strategies"]
+    """
+    key_values = [
+        "parameters",
+        "event_sinks",
+        "encrypted_parameters",
+        "parameter_merge_strategies",
+    ]
 
     with open(env_file) as fh:
         yml = yaml.load(fh)
-    assert [k for k in key_values if k in yml], (
-            '%s missing any of %s' % (
-                    env_file,
-                    key_values))
+    assert [k for k in key_values if k in yml], "%s missing any of %s" % (
+        env_file,
+        key_values,
+    )
 
 
-@validates('R-03324')
+@validates("R-03324")
 def test_environment_file_contains_required_sections(env_file):
-    '''
+    """
     Check that all environments files only have the allowed sections
-    '''
+    """
     required_keys = ["parameters"]
 
     with open(env_file) as fh:
         yml = yaml.load(fh)
     missing_keys = [v for v in required_keys if v not in yml]
-    assert not missing_keys, '%s missing %s' % (env_file, missing_keys)
+    assert not missing_keys, "%s missing %s" % (env_file, missing_keys)
 
 
 def test_environment_file_sections_have_the_right_format(env_file):
-    '''
+    """
     Check that all environment files have sections of the right format.
     Do note that it only tests for dicts or not dicts currently.
-    '''
-    dict_keys = [
-            "parameters",
-            "encrypted_parameters",
-            "parameter_merge_strategies"]
-    not_dict_keys = [
-            "event_sinks"]
+    """
+    dict_keys = ["parameters", "encrypted_parameters", "parameter_merge_strategies"]
+    not_dict_keys = ["event_sinks"]
 
     with open(env_file) as fh:
         yml = yaml.load(fh)
 
     if not [k for k in dict_keys + not_dict_keys if k in yml]:
-        pytest.skip('The fixture is not applicable for this test')
-
-    bad_dict_keys = [k for k in dict_keys
-                     if k in yml
-                     and not isinstance(yml[k], dict)]
-    bad_not_dict_keys = [k for k in not_dict_keys
-                         if k in yml
-                         and isinstance(yml[k], dict)]
+        pytest.skip("The fixture is not applicable for this test")
+
+    bad_dict_keys = [k for k in dict_keys if k in yml and not isinstance(yml[k], dict)]
+    bad_not_dict_keys = [
+        k for k in not_dict_keys if k in yml and isinstance(yml[k], dict)
+    ]
     errors = []
     if bad_dict_keys:
-        errors.append('must be dict %s' % bad_dict_keys)
+        errors.append("must be dict %s" % bad_dict_keys)
     if bad_not_dict_keys:
-        errors.append('must not be dict %s' % bad_not_dict_keys)
-    assert not errors, '%s errors:\n    %s' % (
-            env_file,
-            '\n    '.join(errors))
+        errors.append("must not be dict %s" % bad_not_dict_keys)
+    assert not errors, "%s errors:\n    %s" % (env_file, "\n    ".join(errors))