Change NowcastWorker mock to pytest fixture

Test suite maintenance. re: issue #81

Author: douglatornell

nowcast/workers/download_wwatch3_results.py

@@ -50,6 +50,7 @@ def main():
         help="Date of the run to download results files from.",
     )
     worker.run(download_wwatch3_results, success, failure)
+    return worker
 
 
 def success(parsed_args):

nowcast/workers/launch_remote_worker.py

@@ -42,6 +42,7 @@ def main():
         help="Quoted string of arguments to launch the remote worker with",
     )
     worker.run(launch_remote_worker, success, failure)
+    return worker
 
 
 def success(parsed_args):

nowcast/workers/make_feeds.py

@@ -58,6 +58,7 @@ def main():
         help="Date of the run to create feeds for.",
     )
     worker.run(make_feeds, success, failure)
+    return worker
 
 
 def success(parsed_args):

nowcast/workers/make_runoff_file.py

@@ -48,6 +48,7 @@ def main():
         help="Date of the run to produce runoff file for.",
     )
     worker.run(make_runoff_file, success, failure)
+    return worker
 
 
 def success(parsed_args):

nowcast/workers/make_turbidity_file.py

@@ -49,6 +49,7 @@ def main():
         help="Date of the run to produce turbidity file for.",
     )
     worker.run(make_turbidity_file, success, failure)
+    return worker
 
 
 def success(parsed_args):

nowcast/workers/make_ww3_current_file.py

@@ -16,7 +16,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 
-"""Salish Sea WaveWatch3 forecast worker that produces the hourly
+"""SalishSeaCast WaveWatch3 forecast worker that produces the hourly
 ocean currents forcing file for a prelim-forecast or forecast run
 """
 import logging
@@ -60,6 +60,7 @@ def main():
         help="Start date of run to create the currents file for.",
     )
     worker.run(make_ww3_current_file, success, failure)
+    return worker
 
 
 def success(parsed_args):

nowcast/workers/make_ww3_wind_file.py

@@ -53,6 +53,7 @@ def main():
         help="Start date of run to create the wind file for.",
     )
     worker.run(make_ww3_wind_file, success, failure)
+    return worker
 
 
 def success(parsed_args):

nowcast/workers/run_NEMO.py

@@ -60,6 +60,7 @@ def main():
         help="Date to execute the run for.",
     )
     worker.run(run_NEMO, success, failure)
+    return worker
 
 
 def success(parsed_args):

nowcast/workers/run_NEMO_agrif.py

@@ -12,7 +12,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
-"""SalishSeaCast worker that repares the YAML run description file and
+"""SalishSeaCast worker that prepares the YAML run description file and
 bash run script for a NEMO SMELT AGRIF run on an HPC cluster that uses the
 TORQUE/MOAB scheduler, and queues the run.
 """
@@ -55,6 +55,7 @@ def main():
         help="Date to execute the run for.",
     )
     worker.run(run_NEMO_agrif, success, failure)
+    return worker
 
 
 def success(parsed_args):

nowcast/workers/run_NEMO_hindcast.py

@@ -64,6 +64,7 @@ def main():
         """,
     )
     worker.run(run_NEMO_hindcast, success, failure)
+    return worker
 
 
 def success(parsed_args):

nowcast/workers/watch_NEMO.py

@@ -12,8 +12,8 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
-"""SalishSeaCast worker that monitors and reports on the
-progress of a run on the ONC cloud computing facility or salish.
+"""SalishSeaCast worker that monitors and reports on the progress of a run on the cloud
+computing facility or salish.
 """
 import logging
 import os
@@ -52,6 +52,7 @@ def main():
         """,
     )
     worker.run(watch_NEMO, success, failure)
+    return worker
 
 
 def success(parsed_args):

nowcast/workers/watch_NEMO_agrif.py

@@ -12,8 +12,8 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
-"""SalishSeaCast worker that monitors and reports on the progress of a
-NEMO AGRIF run on an HPC cluster that uses the TORQUE/MOAB scheduler.
+"""SalishSeaCast worker that monitors and reports on the progress of a NEMO AGRIF run
+on an HPC cluster that uses the TORQUE/MOAB scheduler.
 """
 import logging
 import os
@@ -42,6 +42,7 @@ def main():
     worker.cli.add_argument("host_name", help="Name of the host to monitor the run on")
     worker.cli.add_argument("job_id", help="Job identifier of the job to monitor")
     worker.run(watch_NEMO_agrif, success, failure)
+    return worker
 
 
 def success(parsed_args):

nowcast/workers/watch_NEMO_hindcast.py

@@ -12,8 +12,8 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
-"""SalishSeaCast worker that monitors and reports on the progress of a
-NEMO hindcast run on an HPC cluster that uses the SLURM scheduler.
+"""SalishSeaCast worker that monitors and reports on the progress of a NEMO hindcast run
+on an HPC cluster that uses the SLURM scheduler.
 """
 import logging
 import os
@@ -42,6 +42,7 @@ def main():
     worker.cli.add_argument("host_name", help="Name of the host to monitor the run on")
     worker.cli.add_argument("--run-id", help="Run id to watch; e.g. 01dec14hindcast")
     worker.run(watch_NEMO_hindcast, success, failure)
+    return worker
 
 
 def success(parsed_args):

tests/workers/test_download_wwatch3_results.py

@@ -20,6 +20,7 @@
 from unittest.mock import Mock, patch
 
 import arrow
+import nemo_nowcast
 import pytest
 
 from nowcast.workers import download_wwatch3_results
@@ -31,56 +32,44 @@ def config(base_config):
     return base_config
 
 
-@patch("nowcast.workers.download_wwatch3_results.NowcastWorker", spec=True)
+@pytest.fixture
+def mock_worker(mock_nowcast_worker, monkeypatch):
+    monkeypatch.setattr(download_wwatch3_results, "NowcastWorker", mock_nowcast_worker)
+
+
 class TestMain:
     """Unit tests for main() function."""
 
-    def test_instantiate_worker(self, m_worker):
-        m_worker().cli = Mock(name="cli")
-        download_wwatch3_results.main()
-        args, kwargs = m_worker.call_args
-        assert args == ("download_wwatch3_results",)
-        assert list(kwargs.keys()) == ["description"]
-
-    def test_init_cli(self, m_worker):
-        m_worker().cli = Mock(name="cli")
-        download_wwatch3_results.main()
-        m_worker().init_cli.assert_called_once_with()
-
-    def test_add_host_name_arg(self, m_worker):
-        m_worker().cli = Mock(name="cli")
-        download_wwatch3_results.main()
-        args, kwargs = m_worker().cli.add_argument.call_args_list[0]
-        assert args == ("host_name",)
-        assert "help" in kwargs
-
-    def test_add_run_type_arg(self, m_worker):
-        m_worker().cli = Mock(name="cli")
-        download_wwatch3_results.main()
-        args, kwargs = m_worker().cli.add_argument.call_args_list[1]
-        assert args == ("run_type",)
-        expected = {"nowcast", "forecast", "forecast2"}
-        assert kwargs["choices"] == expected
-        assert "help" in kwargs
-
-    def test_add_run_date_arg(self, m_worker):
-        m_worker().cli = Mock(name="cli")
-        download_wwatch3_results.main()
-        args, kwargs = m_worker().cli.add_date_option.call_args_list[0]
-        assert args == ("--run-date",)
-        assert kwargs["default"] == arrow.now().floor("day")
-        assert "help" in kwargs
-
-    def test_run_worker(self, m_worker):
-        m_worker().cli = Mock(name="cli")
-        download_wwatch3_results.main()
-        args, kwargs = m_worker().run.call_args
-        assert args == (
-            download_wwatch3_results.download_wwatch3_results,
-            download_wwatch3_results.success,
-            download_wwatch3_results.failure,
+    def test_instantiate_worker(self, mock_worker):
+        worker = download_wwatch3_results.main()
+        assert worker.name == "download_wwatch3_results"
+        assert worker.description.startswith(
+            "SalishSeaCast system worker that downloads the results files\nfrom a WaveWatch3 run"
         )
 
+    def test_add_host_name_arg(self, mock_worker):
+        worker = download_wwatch3_results.main()
+        assert worker.cli.parser._actions[3].dest == "host_name"
+        assert worker.cli.parser._actions[3].help
+
+    def test_add_run_type_arg(self, mock_worker):
+        worker = download_wwatch3_results.main()
+        assert worker.cli.parser._actions[4].dest == "run_type"
+        assert worker.cli.parser._actions[4].choices == {
+            "nowcast",
+            "forecast",
+            "forecast2",
+        }
+        assert worker.cli.parser._actions[4].help
+
+    def test_add_run_date_option(self, mock_worker):
+        worker = download_wwatch3_results.main()
+        assert worker.cli.parser._actions[5].dest == "run_date"
+        expected = nemo_nowcast.cli.CommandLineInterface.arrow_date
+        assert worker.cli.parser._actions[5].type == expected
+        assert worker.cli.parser._actions[5].default == arrow.now().floor("day")
+        assert worker.cli.parser._actions[5].help
+
 
 @pytest.mark.parametrize(
     "run_type, host_name",

tests/workers/test_launch_remote_worker.py

@@ -18,7 +18,7 @@
 
 """Unit tests for SalishSeaCast launch_remote_worker worker."""
 from types import SimpleNamespace
-from unittest.mock import Mock, patch
+from unittest.mock import patch
 
 import pytest
 
@@ -31,53 +31,36 @@ def config(base_config):
     return base_config
 
 
-@patch("nowcast.workers.launch_remote_worker.NowcastWorker", spec=True)
+@pytest.fixture
+def mock_worker(mock_nowcast_worker, monkeypatch):
+    monkeypatch.setattr(launch_remote_worker, "NowcastWorker", mock_nowcast_worker)
+
+
 class TestMain:
     """Unit tests for main() function."""
 
-    def test_instantiate_worker(self, m_worker):
-        m_worker().cli = Mock(name="cli")
-        launch_remote_worker.main()
-        args, kwargs = m_worker.call_args
-        assert args == ("launch_remote_worker",)
-        assert list(kwargs.keys()) == ["description"]
-
-    def test_init_cli(self, m_worker):
-        m_worker().cli = Mock(name="cli")
-        launch_remote_worker.main()
-        m_worker().init_cli.assert_called_once_with()
-
-    def test_add_host_name_arg(self, m_worker):
-        m_worker().cli = Mock(name="cli")
-        launch_remote_worker.main()
-        args, kwargs = m_worker().cli.add_argument.call_args_list[0]
-        assert args == ("host_name",)
-        assert "help" in kwargs
-
-    def test_add_remote_worker_arg(self, m_worker):
-        m_worker().cli = Mock(name="cli")
-        launch_remote_worker.main()
-        args, kwargs = m_worker().cli.add_argument.call_args_list[1]
-        assert args == ("remote_worker",)
-        assert "help" in kwargs
-
-    def test_add_worker_args_arg(self, m_worker):
-        m_worker().cli = Mock(name="cli")
-        launch_remote_worker.main()
-        args, kwargs = m_worker().cli.add_argument.call_args_list[2]
-        assert args == ("worker_args",)
-        assert "help" in kwargs
-
-    def test_run_worker(self, m_worker):
-        m_worker().cli = Mock(name="cli")
-        launch_remote_worker.main()
-        args, kwargs = m_worker().run.call_args
-        assert args == (
-            launch_remote_worker.launch_remote_worker,
-            launch_remote_worker.success,
-            launch_remote_worker.failure,
+    def test_init_cli(self, mock_worker):
+        worker = launch_remote_worker.main()
+        assert worker.name == "launch_remote_worker"
+        assert worker.description.startswith(
+            "SalishSeaCast worker that launches a specified worker on a remote host."
         )
 
+    def test_add_host_name_arg(self, mock_worker):
+        worker = launch_remote_worker.main()
+        assert worker.cli.parser._actions[3].dest == "host_name"
+        assert worker.cli.parser._actions[3].help
+
+    def test_add_remote_worker_arg(self, mock_worker):
+        worker = launch_remote_worker.main()
+        assert worker.cli.parser._actions[4].dest == "remote_worker"
+        assert worker.cli.parser._actions[4].help
+
+    def test_add_worker_args_arg(self, mock_worker):
+        worker = launch_remote_worker.main()
+        assert worker.cli.parser._actions[5].dest == "worker_args"
+        assert worker.cli.parser._actions[5].help
+
 
 class TestConfig:
     """Unit tests for production YAML config file elements related to worker."""