[pyramid] add regression test to catch HTTPException responses

Author: Emanuele Palazzetti

ddtrace/contrib/pyramid/trace.py

@@ -68,7 +68,9 @@ def trace_tween(request):
                     # If the exception is a pyramid HTTPException,
                     # that's still valuable information that isn't necessarily
                     # a 500. For instance, HTTPFound is a 302.
-                    response = e  # Pyramid exceptions are all valid response types
+                    # As described in docs, Pyramid exceptions are all valid
+                    # response types
+                    response = e
                     raise
                 except BaseException:
                     span.set_tag(http.STATUS_CODE, 500)

tests/contrib/pyramid/test_pyramid.py

@@ -11,17 +11,23 @@
 from pyramid.httpexceptions import (
     HTTPInternalServerError,
     HTTPFound,
-    HTTPNoContent
+    HTTPNotFound,
+    HTTPException,
+    HTTPNoContent,
 )
 import webtest
-from nose.tools import eq_
+from nose.tools import eq_, assert_raises
 
 # project
 import ddtrace
 from ddtrace import compat
 from ddtrace.contrib.pyramid import trace_pyramid
 from ddtrace.contrib.pyramid.patch import insert_tween_if_needed
 
+from ...test_tracer import get_dummy_tracer
+from ...util import override_global_tracer
+
+
 class PyramidBase(object):
 
     def test_200(self):
@@ -176,29 +182,28 @@ def test_renderer(self):
         eq_(s.error, 0)
         eq_(s.span_type, 'template')
 
-class TestPyramid(PyramidBase):
-    def setUp(self):
-        from tests.test_tracer import get_dummy_tracer
-        self.tracer = get_dummy_tracer()
+    def test_http_exception_response(self):
+        with assert_raises(HTTPException):
+            self.app.get('/404/raise_exception', status=404)
 
-        settings = {
-            'datadog_trace_service': 'foobar',
-            'datadog_tracer': self.tracer
-        }
-        config = Configurator(settings=settings)
-        self.rend = config.testing_add_renderer('template.pt')
-        trace_pyramid(config)
+        writer = self.tracer.writer
+        spans = writer.pop()
+        eq_(len(spans), 1)
+        s = spans[0]
+        eq_(s.service, 'foobar')
+        eq_(s.resource, '404')
+        eq_(s.error, 1)
+        eq_(s.span_type, 'http')
+        eq_(s.meta.get('http.method'), 'GET')
+        eq_(s.meta.get('http.status_code'), '404')
+        eq_(s.meta.get('http.url'), '/404/raise_exception')
 
-        app = get_app(config)
-        self.app = webtest.TestApp(app)
 
 def includeme(config):
     pass
 
 def test_include_conflicts():
     """ Test that includes do not create conflicts """
-    from ...test_tracer import get_dummy_tracer
-    from ...util import override_global_tracer
     tracer = get_dummy_tracer()
     with override_global_tracer(tracer):
         config = Configurator(settings={'pyramid.includes': 'tests.contrib.pyramid.test_pyramid'})
@@ -212,8 +217,6 @@ def test_include_conflicts():
 def test_tween_overriden():
     """ In case our tween is overriden by the user config we should not log
     rendering """
-    from ...test_tracer import get_dummy_tracer
-    from ...util import override_global_tracer
     tracer = get_dummy_tracer()
     with override_global_tracer(tracer):
         config = Configurator(settings={'pyramid.tweens': 'pyramid.tweens.excview_tween_factory'})
@@ -252,11 +255,13 @@ def test_insert_tween_if_needed_excview_and_other():
         'pyramid.tweens.excview_tween_factory\n'
         'a.last.tween\n')
 
+
 def test_insert_tween_if_needed_others():
     settings = {'pyramid.tweens': 'a.random.tween\nand.another.one'}
     insert_tween_if_needed(settings)
     eq_(settings['pyramid.tweens'], 'a.random.tween\nand.another.one\nddtrace.contrib.pyramid:trace_tween_factory')
 
+
 def get_app(config):
     """ return a pyramid wsgi app with various urls. """
 
@@ -276,10 +281,10 @@ def renderer(request):
         return render_to_response('template.pt', {'foo': 'bar'}, request=request)
 
     def raise_redirect(request):
-        raise HTTPFound
+        raise HTTPFound()
 
     def raise_no_content(request):
-        raise HTTPNoContent
+        raise HTTPNoContent()
 
     config.add_route('index', '/')
     config.add_route('error', '/error')
@@ -298,17 +303,29 @@ def raise_no_content(request):
     return config.make_wsgi_app()
 
 
-if __name__ == '__main__':
-    logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)
-    ddtrace.tracer.debug_logging = True
-    settings = {
-        'datadog_trace_service': 'foobar',
-        'datadog_tracer': ddtrace.tracer
-    }
-    config = Configurator(settings=settings)
-    trace_pyramid(config)
-    app = get_app(config)
-    port = 8080
-    server = make_server('0.0.0.0', port, app)
-    print('running on %s' % port)
-    server.serve_forever()
+def custom_exception_view(context, request):
+    """Custom view that forces a HTTPException when no views
+    are found to handle given request
+    """
+    if 'raise_exception' in request.url:
+        raise HTTPNotFound()
+    else:
+        return HTTPNotFound()
+
+
+class TestPyramid(PyramidBase):
+    def setUp(self):
+        self.tracer = get_dummy_tracer()
+        settings = {
+            'datadog_trace_service': 'foobar',
+            'datadog_tracer': self.tracer,
+        }
+
+        config = Configurator(settings=settings)
+        self.rend = config.testing_add_renderer('template.pt')
+        # required to reproduce a regression test
+        config.add_notfound_view(custom_exception_view)
+        trace_pyramid(config)
+
+        app = get_app(config)
+        self.app = webtest.TestApp(app)

tests/contrib/pyramid/test_pyramid_autopatch.py

@@ -10,7 +10,7 @@
 
 # project
 import ddtrace
-from .test_pyramid import PyramidBase, get_app
+from .test_pyramid import PyramidBase, get_app, custom_exception_view
 
 class TestPyramidAutopatch(PyramidBase):
     def setUp(self):
@@ -20,6 +20,8 @@ def setUp(self):
 
         config = Configurator()
         self.rend = config.testing_add_renderer('template.pt')
+        # required to reproduce a regression test
+        config.add_notfound_view(custom_exception_view)
         app = get_app(config)
         self.app = webtest.TestApp(app)
 
@@ -31,6 +33,8 @@ def setUp(self):
 
         config = Configurator(settings={'pyramid.tweens': 'pyramid.tweens.excview_tween_factory\n'})
         self.rend = config.testing_add_renderer('template.pt')
+        # required to reproduce a regression test
+        config.add_notfound_view(custom_exception_view)
         app = get_app(config)
         self.app = webtest.TestApp(app)