[tests] Add new full-run clean test case

Adds a new test case that captures a full, unrestricted, sos report and
runs it through `sos clean` to enhance our confidence in `clean`
performance.

This is a StageTwo test as it will temporarily overwrite any existing
default_mapping.

Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>

2 files changed, 86 insertions, 0 deletions

diff --git a/tests/cleaner_tests/full_report_run.py b/tests/cleaner_tests/full_report_run.py
new file mode 100644
index 00000000..21059602
--- /dev/null
+++ b/tests/cleaner_tests/full_report_run.py
@@ -0,0 +1,86 @@
+# This file is part of the sos project: https://github.com/sosreport/sos
+#
+# This copyrighted material is made available to anyone wishing to use,
+# modify, copy, or redistribute it subject to the terms and conditions of
+# version 2 of the GNU General Public License.
+#
+# See the LICENSE file in the source distribution for further information.
+
+import json
+import re
+
+from avocado.utils import process
+from sos_tests import StageTwoReportTest
+
+
+class FullCleanTest(StageTwoReportTest):
+    """Run an unrestricted report execution through sos clean, ensuring that
+    our obfuscation is reliable across arbitrary plugin sets and not just the
+    'main' plugins that tend to collect data needing obfuscation
+
+    :avocado: tags=stagetwo
+    """
+
+    sos_cmd = '-v --clean'
+    sos_timeout = 600
+    # replace with an empty placeholder, make sure that this test case is not
+    # influenced by previous clean runs
+    files = ['/etc/sos/cleaner/default_mapping']
+
+    def _grep_for_content(self, search):
+        """Call out to grep for finding a specific string 'search' in any place
+        in the archive
+        """
+        cmd = "grep -ril '%s' %s" % (search, self.archive_path)
+        try:
+            out = process.run(cmd)
+            rc = out.exit_status
+        except process.CmdError as err:
+            out = err.result
+            rc = err.result.exit_status
+
+        if rc == 1:
+            # grep will return an exit code of 1 if no matches are found,
+            # which is what we want
+            return False
+        else:
+            flist = []
+            for ln in out.stdout.decode('utf-8').splitlines():
+                flist.append(ln.split(self.tmpdir)[-1])
+            return flist
+
+    def test_private_map_was_generated(self):
+        self.assertOutputContains('A mapping of obfuscated elements is available at')
+        map_file = re.findall('/.*sosreport-.*-private_map', self.cmd_output.stdout)[-1]
+        self.assertFileExists(map_file)
+
+    def test_tarball_named_obfuscated(self):
+        self.assertTrue('obfuscated' in self.archive)
+
+    def test_hostname_not_in_any_file(self):
+        host = self.sysinfo['pre']['networking']['hostname']
+        # much faster to just use grep here
+        content = self._grep_for_content(host)
+        if not content:
+            assert True
+        else:
+            self.fail("Hostname appears in files: %s"
+                      % "\n".join(f for f in content))
+
+    def test_no_empty_obfuscations(self):
+        # get the private map file name
+        map_file = re.findall('/.*sosreport-.*-private_map', self.cmd_output.stdout)[-1]
+        with open(map_file, 'r') as mf:
+            map_json = json.load(mf)
+        for mapping in map_json:
+            for key, val in map_json[mapping].items():
+                assert key, "Empty key found in %s" % mapping
+                assert val, "%s mapping for '%s' empty" % (mapping, key)
+
+    def test_ip_not_in_any_file(self):
+        ip = self.sysinfo['pre']['networking']['ip_addr']
+        content = self._grep_for_content(ip)
+        if not content:
+            assert True
+        else:
+            self.fail("IP appears in files: %s" % "\n".join(f for f in content))
diff --git a/tests/test_data/etc/sos/cleaner/default_mapping b/tests/test_data/etc/sos/cleaner/default_mapping
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/tests/test_data/etc/sos/cleaner/default_mapping