tests: use monkeypatch to ensure test enviroment changes are undone

Author: rupertnash

tests/test_ext.py

@@ -2,6 +2,7 @@
 import re
 from io import StringIO
 from pathlib import Path
+from typing import Any
 
 import pytest
 
@@ -31,20 +32,14 @@ def test_listing_deep() -> None:
 
 
 @needs_docker
-def test_cwltool_options() -> None:
-    try:
-        opt = os.environ.get("CWLTOOL_OPTIONS")
-        os.environ["CWLTOOL_OPTIONS"] = "--enable-ext"
-        params = [
-            get_data("tests/wf/listing_deep.cwl"),
-            get_data("tests/listing-job.yml"),
-        ]
-        assert main(params) == 0
-    finally:
-        if opt is not None:
-            os.environ["CWLTOOL_OPTIONS"] = opt
-        else:
-            del os.environ["CWLTOOL_OPTIONS"]
+def test_cwltool_options(monkeypatch: Any) -> None:
+    """Check setting options via environment variable."""
+    monkeypatch.setenv("CWLTOOL_OPTIONS", "--enable-ext")
+    params = [
+        get_data("tests/wf/listing_deep.cwl"),
+        get_data("tests/listing-job.yml"),
+    ]
+    assert main(params) == 0
 
 
 @needs_docker

tests/test_procgenerator.py

@@ -1,37 +1,33 @@
 import os
+from typing import Any
 
 from cwltool.main import main
 
 from .util import get_data, windows_needs_docker
 
 
 @windows_needs_docker
-def test_missing_enable_ext() -> None:
-    # Requires --enable-ext and --enable-dev
-    try:
-        opt = os.environ.get("CWLTOOL_OPTIONS")
+def test_missing_enable_ext(monkeypatch: Any) -> None:
+    """Test missing enable-ext option fails.
 
-        if "CWLTOOL_OPTIONS" in os.environ:
-            del os.environ["CWLTOOL_OPTIONS"]
-        assert main([get_data("tests/wf/generator/zing.cwl"), "--zing", "zipper"]) == 1
+    Check that a workflow that needs `--enable-ext` and
+    `--enable-dev` fails without those options and passes with them.
+    """
+    monkeypatch.delenv("CWLTOOL_OPTIONS", raising=False)
+    assert main([get_data("tests/wf/generator/zing.cwl"), "--zing", "zipper"]) == 1
 
-        assert (
-            main(
-                [
-                    "--enable-ext",
-                    "--enable-dev",
-                    get_data("tests/wf/generator/zing.cwl"),
-                    "--zing",
-                    "zipper",
-                ]
-            )
-            == 0
+    assert (
+        main(
+            [
+                "--enable-ext",
+                "--enable-dev",
+                get_data("tests/wf/generator/zing.cwl"),
+                "--zing",
+                "zipper",
+            ]
         )
+        == 0
+    )
 
-        os.environ["CWLTOOL_OPTIONS"] = "--enable-ext --enable-dev"
-        assert main([get_data("tests/wf/generator/zing.cwl"), "--zing", "zipper"]) == 0
-    finally:
-        if opt is not None:
-            os.environ["CWLTOOL_OPTIONS"] = opt
-        elif "CWLTOOL_OPTIONS" in os.environ:
-            del os.environ["CWLTOOL_OPTIONS"]
+    monkeypatch.setenv("CWLTOOL_OPTIONS", "--enable-ext --enable-dev")
+    assert main([get_data("tests/wf/generator/zing.cwl"), "--zing", "zipper"]) == 0

tests/test_rdfprint.py

@@ -1,6 +1,7 @@
 import os
 import subprocess
 import sys
+from typing import Any
 
 from cwltool.main import main
 
@@ -11,21 +12,16 @@ def test_rdf_print() -> None:
     assert main(["--print-rdf", get_data("tests/wf/hello_single_tool.cwl")]) == 0
 
 
-def test_rdf_print_unicode() -> None:
+def test_rdf_print_unicode(monkeypatch: Any) -> None:
     """Force ASCII encoding but load UTF file with --print-rdf."""
-    try:
-        lc_all = os.environ.get("LC_ALL", None)
-        os.environ["LC_ALL"] = "C"
-
-        params = [
-            sys.executable,
-            "-m",
-            "cwltool",
-            "--print-rdf",
-            get_data("tests/utf_doc_example.cwl"),
-        ]
-
-        assert subprocess.check_call(params) == 0
-    finally:
-        if lc_all:
-            os.environ["LC_ALL"] = lc_all
+    monkeypatch.setenv("LC_ALL", "C")
+
+    params = [
+        sys.executable,
+        "-m",
+        "cwltool",
+        "--print-rdf",
+        get_data("tests/utf_doc_example.cwl"),
+    ]
+
+    assert subprocess.check_call(params) == 0