Merge lp:~danilo/landscape-client/mock-tests-sysinfo-deployment into lp:~landscape/landscape-client/trunk

[Данило Шеган]

Migrate landscape/sysinfo/tests/test_deployment.py from mocker to mock.

Migrate landscape/sysinfo/tests/test_deployment.py from mocker to mock.

The trickier one was test_output_is_only_displayed_once_deferred_fires.

[🤖 Landscape Builder (landscape-builder)]

review: Abstain (executing tests)

[🤖 Landscape Builder (landscape-builder)]

Command: TRIAL_ARGS=-j4 make check
Result: Fail
Revno: 848
Branch: lp:~danilo/landscape-client/mock-tests-sysinfo-deployment
Jenkins: https://ci.lscape.net/job/latch-test/5081/

review: Needs Fixing (test results)

[🤖 Landscape Builder (landscape-builder)]

review: Abstain (executing tests)

[🤖 Landscape Builder (landscape-builder)]

Command: TRIAL_ARGS=-j4 make check
Result: Success
Revno: 848
Branch: lp:~danilo/landscape-client/mock-tests-sysinfo-deployment
Jenkins: https://ci.lscape.net/job/latch-test/5088/

review: Approve (test results)

[Adam Collard (adam-collard)]

Small nit inline

review: Approve

[Benji York (benji)]

This looks good.

review: Approve

[🤖 Landscape Builder (landscape-builder)]

The attempt to merge lp:~danilo/landscape-client/mock-tests-sysinfo-deployment into lp:landscape-client failed. Below is the output from the failed tests.

python setup.py build_ext -i
running build_ext
Running 2170 tests.
landscape.broker.tests.test_amp
  RemoteBrokerTest
    test_call_if_accepted ... [OK]
    test_fire_event ... [OK]
    test_get_accepted_message_types ... [OK]
    test_call_if_accepted_with_not_accepted ... [OK]
    test_is_message_pending ... [OK]
    test_listen_events ... [OK]
    test_get_server_uuid ... [OK]
    test_ping ... [OK]
    test_method_call_error ... [OK]
    test_register_client ... [OK]
    test_register ... [OK]
    test_register_client_accepted_message_type ... [OK]
    test_reload_configuration ... [OK]
    test_send_message ... [OK]
    test_send_message_with_urgent ... [OK]
    test_stop_clients ... [OK]
  RemoteClientTest
    test_exit ... [OK]
    test_fire_event ... [OK]
    test_message ... [OK]
    test_method_call_error ... [OK]
    test_ping ... [OK]
landscape.broker.tests.test_client
  BrokerClientTest
    test_add ... [OK]
    test_dispatch_message ... [OK]
    test_dispatch_message_with_exception ... [OK]
    test_dispatch_message_with_no_handler ... [OK]
    test_exchange ... [OK]
    test_exchange_logs_errors_and_continues ... [OK]
    test_exchange_on_plugin_without_exchange_method ... [OK]
    test_exit ... [OK]
    test_fire_event ... [OK]
    test_fire_event_with_acceptance_changed ... [OK]
    test_fire_event_with_arguments ... [OK]
    test_fire_event_with_mixed_results ... [OK]
    test_get_named_plugin ... [OK]
    test_get_plugins_returns_a_copy ... [OK]
    test_get_plugins ... ...

[🤖 Landscape Builder (landscape-builder)]

No approved revision specified.

[🤖 Landscape Builder (landscape-builder)]

review: Abstain (executing tests)

[🤖 Landscape Builder (landscape-builder)]

Command: TRIAL_ARGS=-j4 make check
Result: Success
Revno: 849
Branch: lp:~danilo/landscape-client/mock-tests-sysinfo-deployment
Jenkins: https://ci.lscape.net/job/latch-test/5093/

review: Approve (test results)

=== modified file 'landscape/sysinfo/tests/test_deployment.py'
--- landscape/sysinfo/tests/test_deployment.py	2014-03-27 13:52:48 +0000
+++ landscape/sysinfo/tests/test_deployment.py	2016-06-16 15:42:59 +0000
@@ -1,3 +1,4 @@
+import mock
 import os
 
 from logging.handlers import RotatingFileHandler
@@ -15,7 +16,6 @@
 from landscape.sysinfo.load import Load
 
 from landscape.tests.helpers import LandscapeTest, StandardIOHelper
-from landscape.tests.mocker import ARGS, KWARGS
 
 
 class DeploymentTest(LandscapeTest):
@@ -109,38 +109,41 @@
         self.assertEqual(sysinfo.get_notes(), ["Test note"])
         self.assertEqual(sysinfo.get_footnotes(), ["Test footnote"])
 
-    def test_format_sysinfo_gets_correct_information(self):
-        format_sysinfo = self.mocker.replace("landscape.sysinfo.sysinfo."
-                                             "format_sysinfo")
-        format_sysinfo([("Test header", "Test value")],
-                       ["Test note"], ["Test footnote"],
-                       indent="  ")
-        format_sysinfo(ARGS, KWARGS)
-        self.mocker.count(0)
-        self.mocker.replay()
-
+    @mock.patch("landscape.sysinfo.deployment.format_sysinfo")
+    def test_format_sysinfo_gets_correct_information(self, format_sysinfo):
         run(["--sysinfo-plugins", "TestPlugin"])
+        format_sysinfo.assert_called_once_with(
+            [("Test header", "Test value")],
+            ["Test note"], ["Test footnote"],
+            indent="  ")
 
     def test_format_sysinfo_output_is_printed(self):
-        format_sysinfo = self.mocker.replace("landscape.sysinfo.sysinfo."
-                                             "format_sysinfo")
-        format_sysinfo(ARGS, KWARGS)
-        self.mocker.result("Hello there!")
-        self.mocker.replay()
-
-        run(["--sysinfo-plugins", "TestPlugin"])
-
+        with mock.patch(
+                "landscape.sysinfo.deployment.format_sysinfo",
+                return_value="Hello there!") as format_sysinfo:
+            run(["--sysinfo-plugins", "TestPlugin"])
+
+        self.assertTrue(format_sysinfo.called)
         self.assertEqual(self.stdout.getvalue(), "Hello there!\n")
 
     def test_output_is_only_displayed_once_deferred_fires(self):
         deferred = Deferred()
-        sysinfo = self.mocker.patch(SysInfoPluginRegistry)
-        sysinfo.run()
-        self.mocker.passthrough()
-        self.mocker.result(deferred)
-        self.mocker.replay()
-
-        run(["--sysinfo-plugins", "TestPlugin"])
+
+        # We mock the sysinfo.run() to return a Deferred but still
+        # run the actual sysinfo.run() to gather the results from all
+        # the plugins.  We cannot easily combine return_value and
+        # side_effect because side_effect operates on the return_value,
+        # thus firing the callback and writing sysinfo out to stdout.
+        sysinfo = SysInfoPluginRegistry()
+        original_sysinfo_run = sysinfo.run
+        def wrapped_sysinfo_run(*args, **kwargs):
+            original_sysinfo_run(*args, **kwargs)
+            return deferred
+        sysinfo.run = mock.Mock(side_effect=wrapped_sysinfo_run)
+
+        run(["--sysinfo-plugins", "TestPlugin"], sysinfo=sysinfo)
+
+        sysinfo.run.assert_called_once_with()
 
         self.assertNotIn("Test note", self.stdout.getvalue())
         deferred.callback(None)
@@ -226,11 +229,10 @@
         If landscape-sysinfo is running as a privileged user, then the logs
         should be stored in the system-wide log directory.
         """
-        uid_mock = self.mocker.replace("os.getuid")
-        uid_mock()
-        self.mocker.result(0)
-        self.mocker.replay()
-        self.assertEqual(get_landscape_log_directory(), "/var/log/landscape")
+        with mock.patch("os.getuid", return_value=0) as uid_mock:
+            self.assertEqual(
+                get_landscape_log_directory(), "/var/log/landscape")
+            uid_mock.assert_called_once_with()
 
     def test_wb_logging_setup(self):
         """
@@ -250,28 +252,24 @@
         self.assertFalse(logger.propagate)
 
     def test_setup_logging_logs_to_var_log_if_run_as_root(self):
-        mock_os = self.mocker.replace("os")
-        mock_os.getuid()
-        self.mocker.result(0)
-
-        # Ugh, sorry
-        mock_os.path.isdir("/var/log/landscape")
-        self.mocker.result(False)
-        mock_os.mkdir("/var/log/landscape")
-
-        self.mocker.replace("__builtin__.open", passthrough=False)(
-            "/var/log/landscape/sysinfo.log", "a")
-
-        self.mocker.replay()
-
-        logger = getLogger("landscape-sysinfo")
-        self.assertEqual(logger.handlers, [])
-
-        setup_logging()
-        handler = logger.handlers[0]
-        self.assertTrue(isinstance(handler, RotatingFileHandler))
-        self.assertEqual(handler.baseFilename,
-                         "/var/log/landscape/sysinfo.log")
+        with mock.patch.object(os, "getuid", return_value=0) as mock_getuid, \
+             mock.patch.object(
+                 os.path, "isdir", return_value=False) as mock_isdir, \
+             mock.patch.object(os, "mkdir") as mock_mkdir, \
+             mock.patch("__builtin__.open") as mock_open:
+            logger = getLogger("landscape-sysinfo")
+            self.assertEqual(logger.handlers, [])
+
+            setup_logging()
+            mock_getuid.assert_called_with()
+            mock_isdir.assert_called_with("/var/log/landscape")
+            mock_mkdir.assert_called_with("/var/log/landscape")
+            mock_open.assert_called_with("/var/log/landscape/sysinfo.log", "a")
+
+            handler = logger.handlers[0]
+            self.assertTrue(isinstance(handler, RotatingFileHandler))
+            self.assertEqual(handler.baseFilename,
+                             "/var/log/landscape/sysinfo.log")
 
     def test_create_log_dir(self):
         log_dir = self.makeFile()
@@ -280,20 +278,18 @@
         self.assertTrue(os.path.exists(log_dir))
 
     def test_run_sets_up_logging(self):
-        setup_logging_mock = self.mocker.replace(
-            "landscape.sysinfo.deployment.setup_logging")
-        setup_logging_mock()
-        self.mocker.replay()
-
-        run(["--sysinfo-plugins", "TestPlugin"])
+        with mock.patch(
+                "landscape.sysinfo.deployment"
+                ".setup_logging") as setup_logging_mock:
+            run(["--sysinfo-plugins", "TestPlugin"])
+        setup_logging_mock.assert_called_once_with()
 
     def test_run_setup_logging_exits_gracefully(self):
-        setup_logging_mock = self.mocker.replace(
-            "landscape.sysinfo.deployment.setup_logging")
-        setup_logging_mock()
-        self.mocker.throw(IOError("Read-only filesystem."))
-        self.mocker.replay()
-        error = self.assertRaises(SystemExit, run,
-                                  ["--sysinfo-plugins", "TestPlugin"])
-        self.assertEqual(error.message,
-                         "Unable to setup logging. Read-only filesystem.")
+        io_error = IOError("Read-only filesystem.")
+        with mock.patch(
+                "landscape.sysinfo.deployment.setup_logging",
+                side_effect=io_error) as setup_logging_mock:
+            error = self.assertRaises(
+                SystemExit, run, ["--sysinfo-plugins", "TestPlugin"])
+        self.assertEqual(
+            error.message, "Unable to setup logging. Read-only filesystem.")