Some cleanup of the tests and use more unittests mock functionalities.

Author: micaeljtoliveira

tests/test_mom6_input.py

@@ -1,7 +1,7 @@
 import pytest
-import filecmp
+from unittest.mock import mock_open, patch
+from pathlib import Path
 
-from test_utils import MockFile
 from access.parsers.mom6_input import Mom6Input, write_mom6_input, read_mom6_input
 
 
@@ -18,22 +18,19 @@ def simple_mom6_input():
 
 
 @pytest.fixture()
-def simple_mom6_input_file(tmp_path):
-    file = tmp_path / "simple_mom6_input_file"
-    mom6_input_str = """BOOL = True
+def simple_mom6_input_file():
+    return """BOOL = True
 DT = 1800.0
 IGNORED_DIRECTIVE = 3
 INCORRECT_DIRECTIVE = 2
 N_SMOOTH = 4
 REGRIDDING_COORDINATE_MODE = 'ZSTAR'
 """
-    return MockFile(file, mom6_input_str)
 
 
 @pytest.fixture()
-def complex_mom6_input_file(tmp_path):
-    file = tmp_path / "complex_mom6_input_file"
-    mom6_input_str = """
+def complex_mom6_input_file():
+    return """
 /* This is a comment
    spanning two lines */
 REGRIDDING_COORDINATE_MODE = Z*
@@ -50,13 +47,11 @@ def complex_mom6_input_file(tmp_path):
 TO_BE_REMOVED = 10.0 
 BOOL = True
 """
-    return MockFile(file, mom6_input_str)
 
 
 @pytest.fixture()
-def modified_mom6_input_file(tmp_path):
-    file = tmp_path / "modified_mom6_input_file"
-    mom6_input_str = """
+def modified_mom6_input_file():
+    return """
 
 
 REGRIDDING_COORDINATE_MODE = Z*
@@ -75,35 +70,40 @@ def modified_mom6_input_file(tmp_path):
 
 ADDED_VAR = 32
 """
-    return MockFile(file, mom6_input_str)
 
 
-def test_read_mom6_input(tmp_path, simple_mom6_input, simple_mom6_input_file):
-    mom6_input_from_file = read_mom6_input(file_name=simple_mom6_input_file.file)
+@patch("pathlib.Path.is_file", new=lambda file: True)
+def test_read_mom6_input(simple_mom6_input, simple_mom6_input_file):
+    with patch("builtins.open", mock_open(read_data=simple_mom6_input_file)) as m:
+        config = read_mom6_input(file_name="simple_mom6_input_file")
 
-    assert mom6_input_from_file == simple_mom6_input
+        assert config == simple_mom6_input
 
 
-def test_write_mom6_input(tmp_path, simple_mom6_input, simple_mom6_input_file):
-    file = tmp_path / "MOM_input"
-    write_mom6_input(simple_mom6_input, file)
+def test_write_mom6_input(simple_mom6_input, simple_mom6_input_file):
+    with patch("pathlib.Path.open", mock_open()) as m:
+        write_mom6_input(simple_mom6_input, Path("config_file"))
 
-    assert filecmp.cmp(file, simple_mom6_input_file.file)
+        assert simple_mom6_input_file == "".join(call.args[0] for call in m().write.mock_calls)
 
 
-def test_round_trip_mom6_input(tmp_path, complex_mom6_input_file, modified_mom6_input_file):
-    mom6_input_from_file = Mom6Input(file_name=complex_mom6_input_file.file)
-    mom6_input_from_file["dt"] = 900.0
-    mom6_input_from_file["ADDED_VAR"] = 1
-    mom6_input_from_file["ADDED_VAR"] = 32
-    del mom6_input_from_file["N_SMOOTH"]
-    mom6_input_from_file["N_SMOOTH"] = 4
-    del mom6_input_from_file["TO_BE_REMOVED"]
+@patch("pathlib.Path.is_file", new=lambda file: True)
+def test_round_trip_mom6_input(complex_mom6_input_file, modified_mom6_input_file):
+    with patch("builtins.open", mock_open(read_data=complex_mom6_input_file)) as m1:
+        config = read_mom6_input(file_name="complex_config_file")
 
-    write_mom6_input(mom6_input_from_file, tmp_path / "MOM_input_new")
+        config["dt"] = 900.0
+        config["ADDED_VAR"] = 1
+        config["ADDED_VAR"] = 32
+        del config["N_SMOOTH"]
+        config["N_SMOOTH"] = 4
+        del config["TO_BE_REMOVED"]
 
-    assert mom6_input_from_file["ADDED_VAR"] == 32
-    assert filecmp.cmp(tmp_path / "MOM_input_new", modified_mom6_input_file.file)
+        with patch("pathlib.Path.open", mock_open()) as m:
+            write_mom6_input(config, Path("some_other_config_file"))
+
+            assert config["ADDED_VAR"] == 32
+            assert modified_mom6_input_file == "".join(call.args[0] for call in m().write.mock_calls)
 
 
 def test_read_missing_mom6_file():

tests/test_nuopc_config.py

@@ -1,7 +1,7 @@
 import pytest
-import filecmp
+from unittest.mock import mock_open, patch
+from pathlib import Path
 
-from test_utils import MockFile
 from access.parsers.nuopc_config import read_nuopc_config, write_nuopc_config
 
 
@@ -30,9 +30,8 @@ def simple_nuopc_config():
 
 
 @pytest.fixture()
-def simple_nuopc_config_file(tmp_path):
-    file = tmp_path / "simple_config_file"
-    resource_file_str = """DRIVER_attributes::
+def simple_nuopc_config_file():
+    return """DRIVER_attributes::
   Verbosity = off
   cime_model = cesm
   logFilePostFix = .log
@@ -53,38 +52,39 @@ def simple_nuopc_config_file(tmp_path):
 ::
 
 """
-    return MockFile(file, resource_file_str)
 
 
 @pytest.fixture()
-def invalid_nuopc_config_file(tmp_path):
-    file = tmp_path / "invalid_config_file"
-    resource_file_str = """DRIVER_attributes::
+def invalid_nuopc_config_file():
+    return """DRIVER_attributes::
   Verbosity: off
   cime_model - cesm
 ::
 
 COMPONENTS::: atm ocn
 """
-    return MockFile(file, resource_file_str)
 
 
-def test_read_nuopc_config(tmp_path, simple_nuopc_config, simple_nuopc_config_file):
-    config_from_file = read_nuopc_config(file_name=simple_nuopc_config_file.file)
+@patch("pathlib.Path.is_file", new=lambda file: True)
+def test_read_nuopc_config(simple_nuopc_config, simple_nuopc_config_file):
+    with patch("builtins.open", mock_open(read_data=simple_nuopc_config_file)) as m:
+        config = read_nuopc_config(file_name="simple_nuopc_config_file")
 
-    assert config_from_file == simple_nuopc_config
+        assert config == simple_nuopc_config
 
 
-def test_write_nuopc_config(tmp_path, simple_nuopc_config, simple_nuopc_config_file):
-    file = tmp_path / "config_file"
-    write_nuopc_config(simple_nuopc_config, file)
+def test_write_nuopc_config(simple_nuopc_config, simple_nuopc_config_file):
+    with patch("builtins.open", mock_open()) as m:
+        write_nuopc_config(simple_nuopc_config, Path("config_file"))
 
-    assert filecmp.cmp(file, simple_nuopc_config_file.file)
+        assert simple_nuopc_config_file == "".join(call.args[0] for call in m().write.mock_calls)
 
 
-def test_read_invalid_nuopc_config_file(tmp_path, invalid_nuopc_config_file):
-    with pytest.raises(ValueError):
-        read_nuopc_config(file_name=invalid_nuopc_config_file.file)
+@patch("pathlib.Path.is_file", new=lambda file: True)
+def test_read_invalid_nuopc_config_file(invalid_nuopc_config_file):
+    with patch("builtins.open", mock_open(read_data=invalid_nuopc_config_file)) as m:
+        with pytest.raises(ValueError):
+            read_nuopc_config(file_name="invalid_nuopc_config_file")
 
 
 def test_read_missing_nuopc_config_file():

tests/test_payu_config_yaml.py

@@ -1,7 +1,7 @@
 import pytest
-import filecmp
+from unittest.mock import mock_open, patch
+from pathlib import Path
 
-from test_utils import MockFile
 from access.parsers.payu_config_yaml import read_payu_config_yaml, write_payu_config_yaml
 
 
@@ -25,9 +25,8 @@ def simple_payu_config():
 
 
 @pytest.fixture()
-def simple_payu_config_file(tmp_path):
-    file = tmp_path / "simple_payu_config_file.yaml"
-    payu_file_str = """project: x77
+def simple_payu_config_file():
+    return """project: x77
 ncpus: 48
 jobfs: 10GB
 mem: 192GB
@@ -40,13 +39,11 @@ def simple_payu_config_file(tmp_path):
 - /some/path/to/inputs/1deg/cice
 - /some/path/to/inputs/1deg/share
 """
-    return MockFile(file, payu_file_str)
 
 
 @pytest.fixture()
-def complex_payu_config_file(tmp_path):
-    file = tmp_path / "complex_payu_config_file.yaml"
-    payu_file_str = """# PBS configuration
+def complex_payu_config_file():
+    return """# PBS configuration
 
 # If submitting to a different project to your default, uncomment line below
 # and change project code as appropriate; also set shortpath below
@@ -71,13 +68,11 @@ def complex_payu_config_file(tmp_path):
     - /some/path/to/inputs/1deg/share # shared inputs
 
 """
-    return MockFile(file, payu_file_str)
 
 
 @pytest.fixture()
-def modified_payu_config_file(tmp_path):
-    file = tmp_path / "modified_payu_config_file.yaml"
-    payu_file_str = """# PBS configuration
+def modified_payu_config_file():
+    return """# PBS configuration
 
 # If submitting to a different project to your default, uncomment line below
 # and change project code as appropriate; also set shortpath below
@@ -102,29 +97,33 @@ def modified_payu_config_file(tmp_path):
 - /some/path/to/inputs/1deg/share     # shared inputs
 
 """
-    return MockFile(file, payu_file_str)
 
 
-def test_read_payu_config(tmp_path, simple_payu_config, simple_payu_config_file):
-    config_from_file = read_payu_config_yaml(file_name=simple_payu_config_file.file)
+@patch("pathlib.Path.is_file", new=lambda file: True)
+def test_read_payu_config(simple_payu_config, simple_payu_config_file):
+    with patch("io.open", mock_open(read_data=simple_payu_config_file)) as m:
+        config = read_payu_config_yaml(file_name="simple_payu_config_file")
 
-    assert config_from_file == simple_payu_config
+        assert config == simple_payu_config
 
 
-def test_write_payu_config(tmp_path, simple_payu_config, simple_payu_config_file):
-    file = tmp_path / "config_file"
-    write_payu_config_yaml(simple_payu_config, file)
+def test_write_payu_config(simple_payu_config, simple_payu_config_file):
+    with patch("io.open", mock_open()) as m:
+        write_payu_config_yaml(simple_payu_config, Path("config_file"))
 
-    assert filecmp.cmp(file, simple_payu_config_file.file)
+        assert simple_payu_config_file == "".join(call.args[0] for call in m().write.mock_calls)
 
 
-def test_round_trip_payu_config(tmp_path, complex_payu_config_file, modified_payu_config_file):
-    config = read_payu_config_yaml(complex_payu_config_file.file)
-    config["ncpus"] = 64
-    config["input"][0] = "/some/other/path/to/inputs/1deg/mom"
-    write_payu_config_yaml(config, tmp_path / "config.yaml")
+@patch("pathlib.Path.is_file", new=lambda file: True)
+def test_round_trip_payu_config(complex_payu_config_file, modified_payu_config_file):
+    with patch("io.open", mock_open(read_data=complex_payu_config_file)) as m:
+        config = read_payu_config_yaml(file_name="complex_config_file")
 
-    assert filecmp.cmp(tmp_path / "config.yaml", modified_payu_config_file.file)
+        config["ncpus"] = 64
+        config["input"][0] = "/some/other/path/to/inputs/1deg/mom"
+        write_payu_config_yaml(config, Path("some_other_config_file"))
+
+        assert modified_payu_config_file == "".join(call.args[0] for call in m().write.mock_calls)
 
 
 def test_read_missing_payu_config():