Merge lp:~tcole/wsgi-oops/generic-oops-api into lp:wsgi-oops

[Tim Cole]

Introduce a generic OOPS API not tied to WSGI.

Introduce a generic OOPS API not tied to WSGI.

[Martin Albisetti (beuno)]

review: Approve

[Philip Fibiger (pfibiger)]

review: Approve

=== added file 'canonical/oops/reporter.py'
--- canonical/oops/reporter.py	1970-01-01 00:00:00 +0000
+++ canonical/oops/reporter.py	2011-05-06 23:23:22 +0000
@@ -0,0 +1,97 @@
+# Copyright 2009-2011 Canonical Ltd.
+#
+# This file is part of wsgi-oops.
+#
+# wsgi-oops is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3
+# as published by the Free Software Foundation.
+#
+# wsgi-oops is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with wsgi-oops.  If not, see <http://www.gnu.org/licenses/>.
+
+""" General oops request lifetime stuff, abstracted from WSGI things
+
+"""
+
+__all__ = ["OOPSReporter", "DEFAULT_SERIALIZER_FACTORY"]
+
+import sys
+import logging
+
+from storm.tracer import install_tracer, remove_tracer_type
+
+from canonical.oops import serializer
+from canonical.oops.oops import OOPS, OOPSLog, OOPSLoggingHandler
+from canonical.oops.stormtracer import OOPSStorm, OOPSStormTracer
+
+DEFAULT_SERIALIZER_FACTORY = 'canonical.oops.serializer.OOPSBz2Serializer'
+
+
+class OOPSReporter(object):
+   """An object encapsulating OOPS reporting and oops allocation."""
+
+   def __init__(self, oops_dir,
+                serializer_factory_name=DEFAULT_SERIALIZER_FACTORY,
+                debug=False, key="appserver"):
+        """Install tracers and set up the oops serializer."""
+        # Add the oops to the storm tracing
+        remove_tracer_type(OOPSStormTracer)
+        install_tracer(OOPSStormTracer())
+        # Add the oops to the standard logging
+        root_logger = logging.getLogger()
+        for handler in root_logger.handlers:
+            if isinstance(handler, OOPSLoggingHandler):
+                break
+        else:
+            root_logger.addHandler(OOPSLoggingHandler())
+        fh = debug and sys.stderr or None
+        self.serializer = serializer.create(serializer_factory_name,
+                                            key, oops_dir, fh=fh)
+
+   def open_request(self):
+       """Create a new OOPS context manager for a single request."""
+       return OOPSRequest(self.serializer)
+
+
+class OOPSRequest(object):
+    """A context manager embodying the life cycle of a request."""
+
+    def __init__(self, serializer):
+        """Create and retain an OOPS instance."""
+        self.serializer = serializer
+        self.oops = OOPS(self.serializer.get_next_oops_id)
+        self.oops.add(OOPSStorm(thread_local=True))
+        self.oops.add(OOPSLog(thread_local=True))
+
+    def __enter__(self):
+        """Enter the context, returning the context's OOPS instance."""
+        return self.oops
+
+    def __exit__(self, ex_type, ex_value, ex_tb):
+        """Leave the context, reporting the OOPS if appropriate."""
+        root_logger = logging.getLogger()
+
+        if ex_type is not None:
+            self.oops.keep()
+            message = "Unhandled application exception " \
+                      "(OOPS %s)" % (self.oops.id,)
+            exc_info = (ex_type, ex_value, ex_tb)
+            root_logger.error(message, exc_info=exc_info)
+
+        if self.oops.wanted:
+            try:
+                self.serializer.dump(self.oops)
+            except:
+                exc_info = sys.exc_info()
+                try:
+                    message = "Error when dumping OOPS %s" % self.oops.id
+                    root_logger.error(message, exc_info=exc_info)
+                finally:
+                    exc_info = None
+
+        return False

=== added file 'canonical/oops/tests/test_reporter.py'
--- canonical/oops/tests/test_reporter.py	1970-01-01 00:00:00 +0000
+++ canonical/oops/tests/test_reporter.py	2011-05-06 23:23:22 +0000
@@ -0,0 +1,71 @@
+# Copyright 2009-2011 Canonical Ltd.
+#
+# This file is part of wsgi-oops.
+#
+# wsgi-oops is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3
+# as published by the Free Software Foundation.
+#
+# wsgi-oops is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with wsgi-oops.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Tests for canoncal.oops.reporter."""
+import os
+import unittest
+
+from canonical.oops.tests import testcase
+from canonical.oops.oops import OOPS
+from canonical.oops.reporter import OOPSReporter
+
+
+class ReporterTests(testcase.OopsTestCase):
+    """ simple test of wsgi oops just test for all ok and error """
+
+    def setUp(self):
+        """Set up an OOPSReporter instance."""
+        super(ReporterTests, self).setUp()
+        self.reporter = OOPSReporter(self.tmp_dir)
+
+    def test_reporter_context(self):
+        """Test that we can open a reporter context."""
+        with self.reporter.open_request():
+            pass
+
+    def test_reporter_context_oops(self):
+        """Test that we can access the oops in the context."""
+        with self.reporter.open_request() as oops:
+            self.assertEqual(type(oops), OOPS)
+
+    def test_oops_no_error(self):
+        """Test that we don't want the oops if no error in the context."""
+
+        def run_with_context():
+            """Run in the context and return the oops."""
+            with self.reporter.open_request() as oops:
+                return oops
+
+        oops = run_with_context()
+        self.assert_(not oops.wanted)
+
+    def test_oops_with_error(self):
+        """Test what happens when we raise an error within a context."""
+
+
+        class UniqueException(Exception):
+            """A unique exception class for this test."""
+
+            def __init__(self, oops):
+                """Save the oops."""
+                self.oops = oops
+
+
+        try:
+            with self.reporter.open_request() as oops:
+                raise UniqueException(oops)
+        except UniqueException, e:
+            self.assert_(e.oops.wanted)

=== modified file 'canonical/oops/tests/testcase.py'
--- canonical/oops/tests/testcase.py	2011-01-18 09:50:00 +0000
+++ canonical/oops/tests/testcase.py	2011-05-06 23:23:22 +0000
@@ -1,4 +1,4 @@
-# Copyright 2009 Canonical Ltd.
+# Copyright 2009-2011 Canonical Ltd.
 #
 # This file is part of wsgi-oops.
 #
@@ -42,7 +42,34 @@
         return self.app(environ, start_response)
 
 
-class WSGIOopsTestCase(unittest.TestCase):
+class OopsTestCase(unittest.TestCase):
+    """Test case that creates a temp directory for oops serialization."""
+
+    def setUp(self):
+        """Set up temp directory."""
+        super(OopsTestCase, self).setUp()
+        self.test_root_dir = None
+        self.tmp_dir = self._make_tmp_dir()
+
+    def _make_tmp_dir(self):
+        """Create and return a temp dir for the current test method."""
+        if getattr(self, 'test_root_dir', None) is None:
+            self.test_root_dir = tempfile.mkdtemp('', 'wsgi_oops')
+        return os.path.join(self.test_root_dir, self._testMethodName)
+
+    def tearDown(self):
+        """Clean up the temporary directory."""
+        super(OopsTestCase, self).tearDown()
+        self.rm_tmp_dir()
+
+    def rm_tmp_dir(self):
+        """Do the actual cleanup of the temporary directory."""
+        root_dir = getattr(self, 'test_root_dir', None)
+        if root_dir and os.path.exists(root_dir):
+            shutil.rmtree(root_dir)
+
+
+class WSGIOopsTestCase(OopsTestCase):
     """ base test case for WSGI oops related tests
 
     Provides some utilities to ease the writting of tests.
@@ -56,28 +83,10 @@
 
     def setUp(self):
         super(WSGIOopsTestCase, self).setUp()
-        self.test_root_dir = None
-        self.tmp_dir = self._make_tmp_dir()
         self.oops_ware_interceptor = OopsWareInterceptor(self.create_test_app())
         self.app = wsgi.OopsWare(self.oops_ware_interceptor, self.tmp_dir)
         self.testapp = TestApp(self.app)
 
-    def _make_tmp_dir(self):
-        """ creates and returns safe temp dir for the current test method """
-        if getattr(self, 'test_root_dir', None) is None:
-            self.test_root_dir = tempfile.mkdtemp('', 'wsgi_oops')
-        return os.path.join(self.test_root_dir, self._testMethodName)
-
-    def tearDown(self):
-        super(WSGIOopsTestCase, self).tearDown()
-        self.rm_tmp_dir()
-
-    def rm_tmp_dir(self):
-        """ clean up the temp dir """
-        root_dir = getattr(self, 'test_root_dir', None)
-        if root_dir and os.path.exists(root_dir):
-            shutil.rmtree(root_dir)
-
     def create_test_app(self):
         """ return a simple wsgi app """
         return SimpleApplication()

=== modified file 'canonical/oops/wsgi.py'
--- canonical/oops/wsgi.py	2011-03-05 00:24:31 +0000
+++ canonical/oops/wsgi.py	2011-05-06 23:23:22 +0000
@@ -31,15 +31,10 @@
 import time
 import logging
 
-from storm.tracer import install_tracer, remove_tracer_type
-
-from canonical.oops import serializer
-from canonical.oops.oops        import (
-    OOPS, OOPSLog, OOPSMetaData, OOPSLoggingHandler )
+from canonical.oops.oops import OOPSMetaData
 from canonical.oops.utils import resolve_name
-from canonical.oops.stormtracer import OOPSStorm, OOPSStormTracer
+from canonical.oops.reporter import OOPSReporter, DEFAULT_SERIALIZER_FACTORY
 
-DEFAULT_SERIALIZER_FACTORY = 'canonical.oops.serializer.OOPSBz2Serializer'
 DEFAULT_COMPLETION_TRACKER = 'canonical.oops.wsgi.track_iterator_completion'
 
 def track_iterator_completion(body, on_completion):
@@ -81,19 +76,10 @@
         self.app = app
         self.hide_meta = hide_meta
         self.oops_on_404 = oops_on_404
-        # Add the oops to the storm tracing
-        remove_tracer_type(OOPSStormTracer)
-        install_tracer(OOPSStormTracer())
-        # Add the oops to the standard logging
-        root_logger = logging.getLogger()
-        for handler in root_logger.handlers:
-            if isinstance(handler, OOPSLoggingHandler):
-                break
-        else:
-            root_logger.addHandler(OOPSLoggingHandler())
-        fh = debug and sys.stderr or None
-        self.serial = serializer.create(serializer_factory_name,
-                                        key, oops_dir, fh=fh)
+        self.reporter = OOPSReporter(oops_dir=oops_dir,
+                                     serializer_factory_name=
+                                     serializer_factory_name,
+                                     debug=debug, key=key)
         self.track_completion = resolve_name(completion_tracker_name)
 
     def __call__(self, environ, start_response):
@@ -104,9 +90,8 @@
         root_logger = logging.getLogger()
 
         # Request start, record the time and create oops tracking object
-        oops = OOPS(self.serial.get_next_oops_id)
-        oops.add(OOPSStorm(thread_local=True))
-        oops.add(OOPSLog(thread_local=True))
+        context = self.reporter.open_request()
+        oops = context.__enter__()
 
         metadata = OOPSMetaData(environ)
         if not self.hide_meta:
@@ -151,26 +136,10 @@
 
         def on_completion(ex_type, ex_value, ex_tb):
             """Handle request completion."""
-            exc_info = None
-            if ex_type is not None:
-                oops.keep()
-                message = "Unhandled WSGI application exception " \
-                          "(OOPS %s)" % (oops.id,)
-                exc_info = (ex_type, ex_value, ex_tb)
-                root_logger.error(message, exc_info=exc_info)
-
             metadata["request-end"] = time.time()
-
-            if environ.has_key('dump-oops') or oops.wanted:
-                try:
-                    self.serial.dump(oops)
-                except:
-                    exc_info = sys.exc_info()
-                    try:
-                        message = "Error when dumping OOPS %s" % oops.id
-                        root_logger.error(message, exc_info=exc_info)
-                    finally:
-                        exc_info = None
+            if environ.has_key('dump-oops'):
+                oops.keep()
+            context.__exit__(ex_type, ex_value, ex_tb)
 
         try:
             body = self.app(environ, trap_response)