Merge pull request #169 from wxtim/do_not_cleanup_failed_functional_t…

…ests

functional tests only cleanup if succeeded

tests/functional/test_ROSE_ORIG_HOST.py

@@ -84,7 +84,7 @@ def monkeymodule():
 
 
 @pytest.fixture(scope='module')
-def fixture_provide_flow(tmp_path_factory):
+def fixture_provide_flow(tmp_path_factory, request):
     """Provide a cylc workflow based on the contents of a folder which can
     be either validated or installed.
     """
@@ -99,8 +99,9 @@ def fixture_provide_flow(tmp_path_factory):
         'flowpath': flowpath,
         'srcpath': srcpath
     }
-    shutil.rmtree(srcpath)
-    shutil.rmtree(flowpath)
+    if not request.session.testsfailed:
+        shutil.rmtree(srcpath)
+        shutil.rmtree(flowpath)
 
 
 @pytest.fixture(scope='module')

tests/functional/test_reinstall.py

@@ -53,7 +53,7 @@ def monkeymodule():
 
 
 @pytest.fixture(scope='module')
-def fixture_provide_flow(tmp_path_factory):
+def fixture_provide_flow(tmp_path_factory, request):
     """Provide a cylc workflow based on the contents of a folder which can
     be either validated or installed.
     """
@@ -71,8 +71,9 @@ def fixture_provide_flow(tmp_path_factory):
         'flowpath': flowpath,
         'srcpath': srcpath
     }
-    shutil.rmtree(srcpath)
-    shutil.rmtree(flowpath)
+    if not request.session.testsfailed:
+        shutil.rmtree(srcpath)
+        shutil.rmtree(flowpath)
 
 
 @pytest.fixture(scope='module')
@@ -251,7 +252,7 @@ def test_cylc_reinstall_files2(fixture_reinstall_flow2, file_, expect):
     assert (fpath / file_).read_text() == expect
 
 
-def test_cylc_reinstall_fail_on_clashing_template_vars(tmp_path):
+def test_cylc_reinstall_fail_on_clashing_template_vars(tmp_path, request):
     """If you re-install with a different templating engine in suite.rc
     reinstall should fail.
     """
@@ -282,4 +283,5 @@ def test_cylc_reinstall_fail_on_clashing_template_vars(tmp_path):
         in reinstall.stderr.decode()
     )
     # Clean up run dir:
-    shutil.rmtree(get_workflow_run_dir(test_flow_name))
+    if not request.session.testsfailed:
+        shutil.rmtree(get_workflow_run_dir(test_flow_name))

tests/functional/test_reinstall_clean.py

@@ -53,7 +53,7 @@ def monkeymodule():
 
 
 @pytest.fixture(scope='module')
-def fixture_provide_flow(tmp_path_factory):
+def fixture_provide_flow(tmp_path_factory, request):
     """Provide a cylc workflow based on the contents of a folder which can
     be either validated or installed.
     """
@@ -71,8 +71,9 @@ def fixture_provide_flow(tmp_path_factory):
         'flowpath': flowpath,
         'srcpath': srcpath
     }
-    shutil.rmtree(srcpath)
-    shutil.rmtree(flowpath)
+    if not request.session.testsfailed:
+        shutil.rmtree(srcpath)
+        shutil.rmtree(flowpath)
 
 
 @pytest.fixture(scope='module')

tests/functional/test_reinstall_fileinstall.py

@@ -32,7 +32,7 @@
 
 
 @pytest.fixture(scope='module')
-def fixture_provide_flow(tmp_path_factory):
+def fixture_provide_flow(tmp_path_factory, request):
     """Provide a cylc workflow based on the contents of a folder which can
     be either validated or installed.
     """
@@ -46,8 +46,9 @@ def fixture_provide_flow(tmp_path_factory):
         'flowpath': flowpath,
         'srcpath': srcpath
     }
-    shutil.rmtree(srcpath)
-    shutil.rmtree(flowpath)
+    if not request.session.testsfailed:
+        shutil.rmtree(srcpath)
+        shutil.rmtree(flowpath)
 
 
 def test_install_flow(fixture_provide_flow):

tests/functional/test_rose_fileinstall.py

@@ -58,7 +58,7 @@ def fixture_provide_flow(tmp_path):
 
 
 @pytest.fixture
-def fixture_install_flow(fixture_provide_flow):
+def fixture_install_flow(fixture_provide_flow, request):
     srcpath, datapath, flow_name = fixture_provide_flow
     result = subprocess.run(
         ['cylc', 'install', '--workflow-name', flow_name, f'{str(srcpath)}'],
@@ -67,8 +67,8 @@ def fixture_install_flow(fixture_provide_flow):
     destpath = Path(get_workflow_run_dir(flow_name))
 
     yield srcpath, datapath, flow_name, result, destpath
-
-    shutil.rmtree(destpath)
+    if not request.session.testsfailed:
+        shutil.rmtree(destpath)
 
 
 def test_rose_fileinstall_validate(fixture_provide_flow):
@@ -94,7 +94,7 @@ def test_rose_fileinstall_subfolders(fixture_install_flow):
 
 
 def test_rose_fileinstall_concatenation(fixture_install_flow):
-    """Multiple files concatenated on install (source contained wildcard):
+    """Multiple files concatenated on install(source contained wildcard):
     """
     _, datapath, _, _, destpath = fixture_install_flow
     assert ((destpath / 'runN/data').read_text() ==

tests/functional/test_rose_stem.py

@@ -173,10 +173,7 @@ def setup_stem_repo(tmp_path_factory, monkeymodule, request):
         'suite_install_dir': suite_install_dir
     }
     # Only clean up if all went well.
-    if all([
-        i.outcome == 'passed' or i.outcome == 'skipped'
-        for i in request.node.obj._module_outcomes.values()
-    ]):
+    if not request.session.testsfailed:
         shutil.rmtree(suite_install_dir)
 
 

tests/unit/test_rose_opts.py

@@ -59,7 +59,7 @@ def fixture_provide_flow(tmp_path_factory):
 
 
 @pytest.fixture(scope='module')
-def fixture_install_flow(fixture_provide_flow):
+def fixture_install_flow(fixture_provide_flow, request):
     srcpath, datapath, flow_name = fixture_provide_flow
     cmd = shlex.split(
         f'cylc install --workflow-name {flow_name} {str(srcpath)} '
@@ -72,8 +72,8 @@ def fixture_install_flow(fixture_provide_flow):
     destpath = Path(get_workflow_run_dir(flow_name))
 
     yield srcpath, datapath, flow_name, result, destpath
-
-    shutil.rmtree(destpath)
+    if not request.session.testsfailed:
+        shutil.rmtree(destpath)
 
 
 def test_rose_fileinstall_validate(fixture_provide_flow):