Coverage for tests/test_cliCmdRun.py: 100%

1# This file is part of ctrl_mpexec. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (http://www.lsst.org). 

6# See the COPYRIGHT file at the top-level directory of this distribution 

7# for details of code ownership. 

8# 

9# This software is dual licensed under the GNU General Public License and also 

10# under a 3-clause BSD license. Recipients may choose which of these licenses 

11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt, 

12# respectively. If you choose the GPL option then the following text applies 

13# (but note that there is still no warranty even if you opt for BSD instead): 

14# 

15# This program is free software: you can redistribute it and/or modify 

16# it under the terms of the GNU General Public License as published by 

17# the Free Software Foundation, either version 3 of the License, or 

18# (at your option) any later version. 

19# 

20# This program is distributed in the hope that it will be useful, 

21# but WITHOUT ANY WARRANTY; without even the implied warranty of 

22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

23# GNU General Public License for more details. 

24# 

25# You should have received a copy of the GNU General Public License 

26# along with this program. If not, see <http://www.gnu.org/licenses/>. 

27 

28"""Unit tests for the ctrl_mpexec CLI run subcommand.""" 

29 

30import unittest 

31import unittest.mock 

32 

33from lsst.ctrl.mpexec.cli.cmd import commands 

34from lsst.ctrl.mpexec.cli.pipetask import cli as pipetask_cli 

35from lsst.daf.butler.cli.utils import LogCliRunner, clickResultMsg 

36 

37 

38class RunCommandThreadingTest(unittest.TestCase): 

39 """Test implicit threading handling of "pipetask run".""" 

40 

41 def setUp(self): 

42 self.runner = LogCliRunner() 

43 

44 def _invoke_with_mocks(self, args: list[str]) -> tuple: 

45 """Invoke the CLI with the script functions replaced by mocks that 

46 share a common parent so that call order can be checked. 

47 """ 

48 manager = unittest.mock.Mock() 

49 with ( 

50 unittest.mock.patch.object(commands, "disable_implicit_threading", manager.disable), 

51 unittest.mock.patch.object(commands.script, "build", manager.build), 

52 unittest.mock.patch.object(commands.script, "qgraph", manager.qgraph), 

53 unittest.mock.patch.object(commands.script, "run", manager.run), 

54 ): 

55 result = self.runner.invoke(pipetask_cli, args) 

56 return result, manager 

57 

58 def test_disable_before_graph_building(self): 

59 """Implicit threading must be disabled before the pipeline is built 

60 so that thread pools created during task imports and graph generation 

61 are already limited. 

62 """ 

63 result, manager = self._invoke_with_mocks(["run", "-b", "repo"]) 

64 self.assertEqual(result.exit_code, 0, clickResultMsg(result)) 

65 called = [name for name, _, _ in manager.mock_calls] 

66 self.assertIn("disable", called) 

67 self.assertLess(called.index("disable"), called.index("build")) 

68 

69 def test_enable_implicit_threading(self): 

70 """No early disabling when implicit threading is requested.""" 

71 result, manager = self._invoke_with_mocks(["run", "-b", "repo", "--enable-implicit-threading"]) 

72 self.assertEqual(result.exit_code, 0, clickResultMsg(result)) 

73 called = [name for name, _, _ in manager.mock_calls] 

74 self.assertNotIn("disable", called) 

75 

76 

77if __name__ == "__main__": 

78 unittest.main()