feature clean alluredir (fixes #175 via #234)

Author: Sup3rGeo

allure-pytest/src/plugin.py

@@ -19,6 +19,11 @@ def pytest_addoption(parser):
                                            default=None,
                                            help="Generate Allure report in the specified directory (may not exist)")
 
+    parser.getgroup("reporting").addoption('--clean-alluredir',
+                                           action="store_true",
+                                           dest="clean_alluredir",
+                                           help="Clean alluredir folder if it exists")
+
     def label_type(type_name, legal_values=set()):
         def a_label_type(string):
             atoms = set(string.split(','))
@@ -97,6 +102,7 @@ def clean_up():
 
 def pytest_configure(config):
     report_dir = config.option.allure_report_dir
+    clean = config.option.clean_alluredir
 
     test_helper = AllureTestHelper(config)
     # TODO: Why helper is present anyway?
@@ -109,7 +115,7 @@ def pytest_configure(config):
         allure_commons.plugin_manager.register(test_listener)
         config.add_cleanup(cleanup_factory(test_listener))
 
-        file_logger = AllureFileLogger(report_dir)
+        file_logger = AllureFileLogger(report_dir, clean)
         allure_commons.plugin_manager.register(file_logger)
         config.add_cleanup(cleanup_factory(file_logger))
 

allure-pytest/test/clean/__init__.py

@@ -0,0 +1,10 @@
+def test_two_runs_clean():
+    """
+    >>> report_fixture = getfixture('allure_report_with_params')
+    >>> allure_report_first_run = report_fixture('--clean-alluredir', cache=False)
+    >>> allure_report_second_run = report_fixture('--clean-alluredir', cache=False)
+    >>> assert_that(allure_report_second_run,
+    ...             has_only_n_test_cases('test_two_runs_clean', 1)
+    ... )
+    """
+    assert True

allure-pytest/test/clean/clean_test.py

@@ -0,0 +1,10 @@
+def test_two_runs_no_clean():
+    """
+    >>> report_fixture = getfixture('allure_report_with_params')
+    >>> allure_report_first_run = report_fixture(cache=False)
+    >>> allure_report_second_run = report_fixture(cache=False)
+    >>> assert_that(allure_report_second_run,
+    ...             has_only_n_test_cases('test_two_runs_no_clean', 2)
+    ... )
+    """
+    assert True

allure-pytest/test/clean/no_clean_test.py

@@ -52,15 +52,17 @@ def allure_report_with_params(request, tmpdir_factory):
     module = request.module.__file__
     tmpdir = tmpdir_factory.mktemp('data')
 
-    def run_with_params(*params):
+    def run_with_params(*params, **kwargs):
+        cache = kwargs.get("cache", True)
         key = _get_hash('{thread}{module}{param}'.format(thread=thread_tag(), module=module, param=''.join(params)))
         if not request.config.cache.get(key, False):
             _runner(tmpdir.strpath, module, *params)
-            request.config.cache.set(key, True)
+            if cache:
+                request.config.cache.set(key, True)
 
-            def clear_cache():
-                request.config.cache.set(key, False)
-            request.addfinalizer(clear_cache)
+                def clear_cache():
+                    request.config.cache.set(key, False)
+                request.addfinalizer(clear_cache)
 
         return AllureReport(tmpdir.strpath)
     return run_with_params

allure-pytest/test/conftest.py

@@ -75,7 +75,7 @@
 from hamcrest import has_item
 from hamcrest import has_entry
 from hamcrest import ends_with
-
+from hamcrest.core.base_matcher import BaseMatcher
 
 if sys.version_info[0] < 3:
     from io import open
@@ -107,3 +107,40 @@ def has_test_case(name, *matchers):
                                         )
                                  )
                         )
+
+
+class ContainsExactly(BaseMatcher):
+
+    def __init__(self, num, matcher):
+        self.matcher = matcher
+        self.count = 0
+        self.num = num
+
+    def _matches(self, item):
+        self.count = 0
+        for subitem in item:
+            if self.matcher.matches(subitem):
+                self.count += 1
+
+        if self.count == self.num:
+            return True
+        else:
+            return False
+
+    def describe_to(self, description):
+        description.append_text('exactly {} item(s) matching '.format(self.num)).append_text(self.matcher)
+
+
+def has_only_n_test_cases(name, num, *matchers):
+    return has_property('test_cases',
+                        ContainsExactly(num,
+                                        all_of(
+                                                any_of(
+                                                        has_entry('fullName', ends_with(name)),
+                                                        has_entry('name', ends_with(name))
+                                                        ),
+                                                *matchers
+                                              )
+                                        )
+                        )
+

allure-python-commons-test/src/report.py

@@ -13,11 +13,16 @@
 
 class AllureFileLogger(object):
 
-    def __init__(self, report_dir):
+    def __init__(self, report_dir, clean=False):
         self._report_dir = report_dir
 
         if not os.path.exists(report_dir):
             os.makedirs(report_dir)
+        elif clean:
+            for f in os.listdir(report_dir):
+                f = os.path.join(report_dir, f)
+                if os.path.isfile(f):
+                    os.unlink(f)
 
     def _report_item(self, item):
         indent = INDENT if os.environ.get("ALLURE_INDENT_OUTPUT") else None