Removing mock.Mock() in error reporting.

dhermes · dhermes · commit 80ec376ef1b1 · 2017-03-01T15:26:39.000-08:00
This actually required a much more comprehensive set of unit test changes than expected. Also incorporated a change from googleapis#3057 (which slipped through due to overly broad mocks).
diff --git a/error_reporting/unit_tests/test__gax.py b/error_reporting/unit_tests/test__gax.py
@@ -59,24 +59,34 @@ class Test_ErrorReportingGaxApi(unittest.TestCase):
 
     PROJECT = 'PROJECT'
 
-    def _call_fut(self, gax_api, project):
+    def _make_one(self, gax_api, project):
         from google.cloud.error_reporting._gax import _ErrorReportingGaxApi
 
         return _ErrorReportingGaxApi(gax_api, project)
 
     def test_constructor(self):
-        gax_api = mock.Mock()
-        gax_client_wrapper = self._call_fut(gax_api, self.PROJECT)
+        gax_api = mock.Mock(spec=[])
+        gax_client_wrapper = self._make_one(gax_api, self.PROJECT)
 
         self.assertEqual(gax_client_wrapper._project, self.PROJECT)
         self.assertEqual(gax_client_wrapper._gax_api, gax_api)
 
-    @mock.patch("google.cloud.error_reporting._gax.ParseDict")
-    def test_report_error_event(self, _):
-        gax_api = mock.Mock()
-        gax_client_wrapper = self._call_fut(gax_api, self.PROJECT)
+    def test_report_error_event(self):
+        from google.cloud.proto.devtools.clouderrorreporting.v1beta1 import (
+            report_errors_service_pb2)
 
-        mock_error_report = mock.Mock()
-        gax_client_wrapper.report_error_event(mock_error_report)
-        self.assertTrue(gax_api.report_error_event.called_with,
-                        mock_error_report)
+        gax_api = mock.Mock(spec=['project_path', 'report_error_event'])
+        gax_client_wrapper = self._make_one(gax_api, self.PROJECT)
+
+        error_report = {
+            'message': 'The cabs are here.',
+        }
+        gax_client_wrapper.report_error_event(error_report)
+
+        gax_api.project_path.assert_called_once_with(self.PROJECT)
+        project_name = gax_api.project_path.return_value
+        error_pb = report_errors_service_pb2.ReportedErrorEvent(
+            message=error_report['message'],
+        )
+        gax_api.report_error_event.assert_called_once_with(
+            project_name, error_pb)
diff --git a/error_reporting/unit_tests/test__logging.py b/error_reporting/unit_tests/test__logging.py
@@ -26,28 +26,36 @@ def _make_credentials():
 class Test_ErrorReportingLoggingAPI(unittest.TestCase):
 
     PROJECT = 'PROJECT'
-    SERVICE = 'SERVICE'
-    VERSION = 'myversion'
 
-    def _call_fut(self, project, credentials):
+    def _make_one(self, project, credentials):
         from google.cloud.error_reporting._logging import (
             _ErrorReportingLoggingAPI)
 
         return _ErrorReportingLoggingAPI(project, credentials)
 
     def test_constructor(self):
         credentials = _make_credentials()
-        logger_client = self._call_fut(self.PROJECT, credentials)
+        logging_api = self._make_one(self.PROJECT, credentials)
 
-        self.assertEqual(logger_client.logging_client._connection.credentials,
+        self.assertEqual(logging_api.logging_client._connection.credentials,
                          credentials)
-        self.assertEqual(logger_client.logging_client.project, self.PROJECT)
+        self.assertEqual(logging_api.logging_client.project, self.PROJECT)
 
-    @mock.patch('google.cloud.logging.client')
-    def test_report_error_event(self, _):
+    @mock.patch('google.cloud.logging.client.Client')
+    def test_report_error_event(self, mocked_cls):
         credentials = _make_credentials()
-        logger_client = self._call_fut(self.PROJECT, credentials)
-        payload = mock.Mock()
-        logger_client.report_error_event(payload)
-        logger_mock = mock.Mock()
-        self.assertTrue(logger_mock.log_struct.called_with, payload)
+        logging_api = self._make_one(self.PROJECT, credentials)
+        mocked_cls.assert_called_once_with(self.PROJECT, credentials, None)
+        self.assertIs(logging_api.logging_client, mocked_cls.return_value)
+
+        logger = mock.Mock(spec=['log_struct'])
+        logging_api.logging_client.logger.return_value = logger
+
+        # Actually make the API call.
+        error_report = {
+            'message': 'The cabs are here.',
+        }
+        logging_api.report_error_event(error_report)
+
+        # Check the mocks.
+        logger.log_struct.assert_called_once_with(error_report)
diff --git a/error_reporting/unit_tests/test_client.py b/error_reporting/unit_tests/test_client.py
@@ -44,6 +44,14 @@ def _make_http(self, *args, **kw):
 
         return HTTPContext(*args, **kw)
 
+    def _get_report_payload(self, error_api):
+        self.assertEqual(error_api.report_error_event.call_count, 1)
+        call = error_api.report_error_event.mock_calls[0]
+        _, positional, kwargs = call
+        self.assertEqual(kwargs, {})
+        self.assertEqual(len(positional), 1)
+        return positional[0]
+
     @mock.patch(
         'google.cloud.error_reporting.client._determine_default_project')
     def test_ctor_default(self, default_mock):
@@ -131,7 +139,7 @@ def test_report_exception_with_service_version_in_constructor(
 
         make_api.assert_called_once_with(client)
 
-        payload = error_api.report_error_event.call_args[0][0]
+        payload = self._get_report_payload(error_api)
         self.assertEqual(payload['serviceContext'], {
             'service': service,
             'version': version
@@ -158,8 +166,7 @@ def test_report(self, make_api):
         message = 'this is an error'
         client.report(message)
 
-        payload = error_api.report_error_event.call_args[0][0]
-        make_api.assert_called_once_with(client)
+        payload = self._get_report_payload(error_api)
 
         self.assertEqual(payload['message'], message)
         report_location = payload['context']['reportLocation']
