Merge lp:~oops-tools-dev/wsgi-oops/sanitize_690604 into lp:wsgi-oops

[Danny Tamez]

Added optional keyword so meta information can be excluded from the oops report.
Fixed condition involving env var dump-oops and oops.wanted that was preventing oops reports from being generated.

[Tim Cole (tcole)]

Looks reasonable.

review: Approve

=== modified file 'canonical/oops/tests/test_wsgi.py'
--- canonical/oops/tests/test_wsgi.py	2010-12-21 03:13:00 +0000
+++ canonical/oops/tests/test_wsgi.py	2011-01-06 19:50:08 +0000
@@ -15,6 +15,7 @@
 # along with wsgi-oops.  If not, see <http://www.gnu.org/licenses/>.
 
 """ test for canonical.oops.wsgi """
+import os
 import unittest
 
 from canonical.oops.tests import testcase
@@ -42,6 +43,54 @@
         self.assertNotEquals(None, self.oops.id)
         self.assertFalse(self.oops.wanted)
 
+    def test_hide_meta_false(self):
+        """hide_meta is False by default so our query string param will be
+        captured"""
+        res = self.testapp.get('?error=forced_error',
+                    status=500,
+                    expect_errors=True)
+        self.assertNotEquals(None, self.oops.id)
+        self.assertTrue(self.oops.wanted)
+        self.assertTrue('metadata' in self.oops.get_dump_data().keys())
+        meta = self.oops.get_dump_data()['metadata']
+        self.assertEquals('error=forced_error', meta['QUERY_STRING'])
+
+    def test_hide_meta_true(self):
+        """with hide_meta set to True our query string param will not be
+        captured"""
+        self.testapp.app.hide_meta = True
+        res = self.testapp.get('?error=forced_error',
+                    status=500,
+                    expect_errors=True)
+        self.assertNotEquals(None, self.oops.id)
+        self.assertTrue(self.oops.wanted)
+        self.assertFalse('metadata' in self.oops.get_dump_data().keys())
+
+    def test_dump_oops_and_want_oops(self):
+        """An oops serialization should occur for either dump_oops or want_oops
+        variables being set"""
+        # no dump but wanted +1
+        res = self.testapp.get('?error=forced_error',
+                    status=500,
+                    expect_errors=True)
+        inner_dir = os.listdir(self.tmp_dir)[0]
+        reports = os.listdir(os.path.join(self.tmp_dir, inner_dir))
+        self.assertEqual(1, len(reports))
+
+        # dump but not wanted +1
+        res = self.testapp.get('?ok=all_ok',
+                    status=200,
+                    expect_errors=False,
+                               extra_environ={'dump-oops' : 'whatever'})
+        reports = os.listdir(os.path.join(self.tmp_dir, inner_dir))
+        self.assertEqual(2, len(reports))
+
+        # neither dump nor wanted +0
+        res = self.testapp.get('?ok=all_ok',
+                    status=200,
+                    expect_errors=False)
+        reports = os.listdir(os.path.join(self.tmp_dir, inner_dir))
+        self.assertEqual(2, len(reports))
 
 def track_completion(body, on_completion):
     """Prove that we've been called by adding to the body."""

=== modified file 'canonical/oops/wsgi.py'
--- canonical/oops/wsgi.py	2010-12-21 00:51:42 +0000
+++ canonical/oops/wsgi.py	2011-01-06 19:50:08 +0000
@@ -73,11 +73,12 @@
     def __init__(self, app, oops_dir,
                  serializer_factory_name=DEFAULT_SERIALIZER_FACTORY,
                  completion_tracker_name=DEFAULT_COMPLETION_TRACKER,
-                 debug=False, key="appserver"):
+                 debug=False, key="appserver", hide_meta=False):
         """
         Initialise the middleware for oops.
         """
         self.app = app
+        self.hide_meta = hide_meta
         # Add the oops to the storm tracing
         remove_tracer_type(OOPSStormTracer)
         install_tracer(OOPSStormTracer())
@@ -106,7 +107,8 @@
         oops.add(OOPSLog(thread_local=True))
 
         metadata = OOPSMetaData(environ)
-        oops.add(metadata)
+        if not self.hide_meta:
+            oops.add(metadata)
 
         environ['OOPSID'] = oops.assign_id()
 
@@ -114,7 +116,7 @@
             """
             Wrapper for start_response which traps the response code and
             related exception, if any.
-            """ 
+            """
             status_code = status[0:3]
 
             metadata["http-code"] = status_code
@@ -146,6 +148,7 @@
 
         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 " \
@@ -154,7 +157,8 @@
                 root_logger.error(message, exc_info=exc_info)
 
             metadata["request-end"] = time.time()
-            if environ.has_key('dump-oops') and not oops.wanted:
+
+            if environ.has_key('dump-oops') or oops.wanted:
                 try:
                     self.serial.dump(oops)
                 except: