class PostExceptionTests(TestCase):
def setUp(self):
self.agent = mock.Mock(Agent)
self.observer = AirbrakeLogObserver("API-KEY", environment="testing", agent=self.agent)
self.agent.request.return_value = succeed(None)
def test_postsToDefaultHost(self):
"""
Sends a POST request to the default URL.
"""
d = self.observer._postException("<not-real-xml />")
self.successResultOf(d)
self.agent.request.assert_called_once_with(
"POST", "http://api.airbrake.io/notifier_api/v2/notices", headers=mock.ANY, bodyProducer=mock.ANY
)
def test_postsWithTextXMLContentType(self):
"""
Sends a text/xml content-type header.
"""
d = self.observer._postException("<not-real-xml />")
self.successResultOf(d)
self.assertEqual(self.agent.request.call_count, 1)
(name, args, kwargs) = self.agent.request.mock_calls[0]
self.assertEqual(kwargs["headers"].getRawHeaders("content-type"), ["text/xml"])
@mock.patch("txairbrake.observers.FileBodyProducer")
def test_postsFileBodyProducer(self, FileBodyProducer):
"""
Calls request with a FileBodyProducer that has the xml as the value
value of a StringIO.
"""
d = self.observer._postException("<not-real-xml />")
self.successResultOf(d)
self.assertEqual(self.agent.request.call_count, 1)
(name, args, kwargs) = self.agent.request.mock_calls[0]
self.assertEqual(kwargs["bodyProducer"], FileBodyProducer.return_value)
(name, args, kwargs) = FileBodyProducer.mock_calls[0]
self.assertEqual(args[0].getvalue(), "<not-real-xml />")
def test_restartAfterError(self, _postException):
"""
When _postException fails we restart the observer after handling it.
"""
logModule = mock.Mock()
postFailure = deep_failure()
_postException.return_value = fail(postFailure)
observer = AirbrakeLogObserver("API-KEY", _logModule=logModule)
observer.emit({"isError": True, "failure": deep_failure()})
logModule.removeObserver.assert_called_once_with(observer.emit)
logModule.addObserver.assert_called_once_with(observer.emit)
logModule.err.assert_called_once_with(
postFailure, "Unhandled error logging exception to http://api.airbrake.io/notifier_api/v2/notices"
)
def setUp(self):
self.observer = AirbrakeLogObserver("API-KEY", environment="testing")
self.failure = deep_failure()
self.eventDict = {"failure": self.failure, "why": "Test why."}
self.root = self.observer._eventDictToTree(self.eventDict)
class XMLTests(TestCase):
def setUp(self):
self.observer = AirbrakeLogObserver("API-KEY", environment="testing")
self.failure = deep_failure()
self.eventDict = {"failure": self.failure, "why": "Test why."}
self.root = self.observer._eventDictToTree(self.eventDict)
def test_noticeVersion(self):
"""
notice tag with version 2.0 attribute.
"""
self.assertEqual(self.root.tag, "notice")
self.assertEqual(self.root.get("version"), "2.0")
def test_noticeApiKey(self):
"""
notice tag includes an api-key child that wraps the api key argument
to AirbrakeLogObserver.
"""
api_key = self.root.find("api-key")
self.assertEqual(api_key.text, "API-KEY")
def test_environmentName(self):
"""
notice includes environment argument at
server-environment/environment-name
"""
environment_name = self.root.find("server-environment/environment-name")
self.assertEqual(environment_name.text, "testing")
def test_notifier(self):
"""
notice includes notifier name, version, and url.
"""
self.assertEqual(self.root.find("notifier/name").text, "txairbrake")
self.assertNotIdentical(self.root.find("notifier/url"), None)
self.assertNotIdentical(self.root.find("notifier/version"), None)
def test_error(self):
"""
notice includes an error tag.
"""
self.assertNotIdentical(self.root.find("error"), None)
def test_errorClass(self):
"""
error/class is a fully qualified exception class name.
"""
error_class = self.root.find("error/class")
self.assertEqual(error_class.text, "TestException")
def test_errorMessage(self):
"""
error/message is a string message of the failure.
"""
error_message = self.root.find("error/message")
self.assertEqual(error_message.text, "TestException: this is a test exception")
def test_errorBacktrace(self):
"""
error/backtrace has a number of line children with file, line number,
method.
The values in this test will need to change if it moves or if the
fail_with_traceback function moves.
"""
lines = self.root.findall("error/backtrace/line")
self.assertNotEqual(len(lines), 0)
last_line = lines[-1]
self.assertTrue(last_line.get("file").endswith("txairbrake/tests/test_observer.py"))
self.assertEqual(
last_line.get("method"), 'fail_with_traceback: raise TestException("this is a test exception")'
)
self.assertEqual(last_line.get("number"), "26")
def test_deepBacktrace(self):
"""
error/backtrace includes lines above where the exception was caught and
logged. This makes makes _tracebackToTree equalvent to
failure.printTraceback with defualt arguments.
"""
lines = self.root.findall("error/backtrace/line")
self.assertEqual(lines[-2].get("method"), "deep_failure: return fail_with_traceback()")
def setUp(self):
self.agent = mock.Mock(Agent)
self.observer = AirbrakeLogObserver("API-KEY", environment="testing", agent=self.agent)
self.agent.request.return_value = succeed(None)
