From 3f9be48cbd502fb6371dda373b0ba1bed5d9450a Mon Sep 17 00:00:00 2001
From: Dan Puttick <dputtick@users.noreply.github.com>
Date: Wed, 5 Jul 2017 18:09:10 -0400
Subject: [PATCH] Initial version of individual file test harness

* Parametrized test for normal and dangerous files
* Still needs a way to handle "complex" files (ones that require a full groomer
due to having temporary folders), as well as a way to read .expect test description
files
---
 tests/test_filecheck.py        | 124 ++++++++++++++++++++++-----------
 tests/{logging.py => utils.py} |  10 +++
 2 files changed, 95 insertions(+), 39 deletions(-)
 rename tests/{logging.py => utils.py} (84%)

diff --git a/tests/test_filecheck.py b/tests/test_filecheck.py
index 77a7887..4701220 100644
--- a/tests/test_filecheck.py
+++ b/tests/test_filecheck.py
@@ -6,53 +6,99 @@ import shutil
 
 import pytest
 
-from tests.logging import save_logs
+from tests.utils import save_logs, SampleFile
 try:
-    from bin.filecheck import KittenGroomerFileCheck, File, main
+    from bin.filecheck import KittenGroomerFileCheck, File, GroomerLogger
     NODEPS = False
 except ImportError:
     NODEPS = True
 
+
 fixture = pytest.fixture
 skip = pytest.mark.skip
-skipif_nodeps = pytest.mark.skipif(NODEPS,
-                                   reason="Dependencies aren't installed")
+parametrize = pytest.mark.parametrize
+pytestmark = pytest.mark.skipif(NODEPS, reason="Dependencies aren't installed")
 
 
-@skipif_nodeps
-class TestSystem:
-
-    @fixture
-    def valid_groomer(self):
-        src_path = os.path.join(os.getcwd(), 'tests/normal')
-        dst_path = self.make_dst_dir_path(src_path)
-        return KittenGroomerFileCheck(src_path, dst_path, debug=True)
-
-    @fixture
-    def invalid_groomer(self):
-        src_path = os.path.join(os.getcwd(), 'tests/dangerous')
-        dst_path = self.make_dst_dir_path(src_path)
-        return KittenGroomerFileCheck(src_path, dst_path, debug=True)
-
-    def make_dst_dir_path(self, src_dir_path):
-        dst_path = src_dir_path + '_dst'
-        shutil.rmtree(dst_path, ignore_errors=True)
-        os.makedirs(dst_path, exist_ok=True)
-        return dst_path
-
-    def test_filecheck_src_valid(self, valid_groomer):
-        valid_groomer.run()
-        test_description = "filecheck_valid"
-        save_logs(valid_groomer, test_description)
-
-    def test_filecheck_src_invalid(self, invalid_groomer):
-        invalid_groomer.run()
-        test_description = "filecheck_invalid"
-        save_logs(invalid_groomer, test_description)
+NORMAL_FILES_PATH = 'tests/normal/'
+DANGEROUS_FILES_PATH = 'tests/dangerous/'
 
 
-class TestFileHandling:
-    def test_autorun(self):
-        # Run on a single autorun file, confirm that it gets flagged as dangerous
-        # TODO: build out these and other methods for individual file cases
-        pass
+def gather_sample_files():
+    normal_paths = list_files(NORMAL_FILES_PATH)
+    dangerous_paths = list_files(DANGEROUS_FILES_PATH)
+    normal_files = construct_sample_files(normal_paths, expect_dangerous=False)
+    dangerous_files = construct_sample_files(dangerous_paths, expect_dangerous=True)
+    return normal_files + dangerous_files
+
+
+def list_files(dir_path):
+    full_dir_path = os.path.abspath(dir_path)
+    files = []
+    for file_path in os.listdir(full_dir_path):
+        full_file_path = os.path.join(full_dir_path, file_path)
+        _, ext = os.path.splitext(full_file_path)
+        if os.path.isfile(full_file_path) and ext is not '.expect':
+            files.append(full_file_path)
+    return files
+
+
+def construct_sample_files(file_paths, expect_dangerous):
+    complex_exts = {'.gif', '.jpg', '.png', '.svg', '.rar', '.zip'}
+    files = []
+    for path in file_paths:
+        newfile = SampleFile(path, expect_dangerous)
+        _, extension = os.path.splitext(path)
+        if extension in complex_exts:
+            newfile.groomer_needed = True
+        else:
+            newfile.groomer_needed = False
+        files.append(newfile)
+    return files
+
+
+def filename(argvalue):
+    return os.path.basname(argvalue)
+
+
+@parametrize(argnames="sample_file", argvalues=gather_sample_files())
+def test_sample_files(sample_file):
+    if not sample_file.groomer_needed:
+        file = File(sample_file.path, '', GroomerLogger)
+        file.check()
+        assert file.is_dangerous is sample_file.expect_dangerous
+
+
+@fixture
+def valid_groomer():
+    src_path = os.path.join(os.getcwd(), 'tests/normal')
+    dst_path = make_dst_dir_path(src_path)
+    return KittenGroomerFileCheck(src_path, dst_path, debug=True)
+
+
+@fixture
+def invalid_groomer():
+    src_path = os.path.join(os.getcwd(), 'tests/dangerous')
+    dst_path = make_dst_dir_path(src_path)
+    return KittenGroomerFileCheck(src_path, dst_path, debug=True)
+
+
+def make_dst_dir_path(src_dir_path):
+    dst_path = src_dir_path + '_dst'
+    shutil.rmtree(dst_path, ignore_errors=True)
+    os.makedirs(dst_path, exist_ok=True)
+    return dst_path
+
+
+@skip
+def test_filecheck_src_valid(valid_groomer):
+    valid_groomer.run()
+    test_description = "filecheck_valid"
+    save_logs(valid_groomer, test_description)
+
+
+@skip
+def test_filecheck_src_invalid(invalid_groomer):
+    invalid_groomer.run()
+    test_description = "filecheck_invalid"
+    save_logs(invalid_groomer, test_description)
diff --git a/tests/logging.py b/tests/utils.py
similarity index 84%
rename from tests/logging.py
rename to tests/utils.py
index e705231..42bdd72 100644
--- a/tests/logging.py
+++ b/tests/utils.py
@@ -26,3 +26,13 @@ def save_logs(groomer, test_description):
             with open(groomer.logger.log_debug_out, 'rb') as debug_out:
                 out = debug_out.read()
                 test_log.write(out)
+
+
+class SampleFile():
+    def __init__(self, path, expect_dangerous):
+        self.path = path
+        self.expect_dangerous = expect_dangerous
+
+    def parse_expect(self, expect_path):
+        # parse expect here, add to own params
+        pass