[pyramid] test suite refactoring

Author: Emanuele Palazzetti

tests/contrib/pyramid/app/__init__.py

@@ -0,0 +1 @@
+from .web import create_app  # noqa

tests/contrib/pyramid/app/web.py

@@ -0,0 +1,71 @@
+from ddtrace.contrib.pyramid import trace_pyramid
+
+from pyramid.response import Response
+from pyramid.config import Configurator
+from pyramid.renderers import render_to_response
+from pyramid.httpexceptions import (
+    HTTPInternalServerError,
+    HTTPFound,
+    HTTPNotFound,
+    HTTPException,
+    HTTPNoContent,
+)
+
+
+def create_app(settings, instrument):
+    """Return a pyramid wsgi app"""
+
+    def index(request):
+        return Response('idx')
+
+    def error(request):
+        raise HTTPInternalServerError("oh no")
+
+    def exception(request):
+        1 / 0
+
+    def json(request):
+        return {'a': 1}
+
+    def renderer(request):
+        return render_to_response('template.pt', {'foo': 'bar'}, request=request)
+
+    def raise_redirect(request):
+        raise HTTPFound()
+
+    def raise_no_content(request):
+        raise HTTPNoContent()
+
+    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()
+
+    config = Configurator(settings=settings)
+    config.add_route('index', '/')
+    config.add_route('error', '/error')
+    config.add_route('exception', '/exception')
+    config.add_route('json', '/json')
+    config.add_route('renderer', '/renderer')
+    config.add_route('raise_redirect', '/redirect')
+    config.add_route('raise_no_content', '/nocontent')
+    config.add_view(index, route_name='index')
+    config.add_view(error, route_name='error')
+    config.add_view(exception, route_name='exception')
+    config.add_view(json, route_name='json', renderer='json')
+    config.add_view(renderer, route_name='renderer', renderer='template.pt')
+    config.add_view(raise_redirect, route_name='raise_redirect')
+    config.add_view(raise_no_content, route_name='raise_no_content')
+    # required to reproduce a regression test
+    config.add_notfound_view(custom_exception_view)
+    # required for rendering tests
+    renderer = config.testing_add_renderer('template.pt')
+
+    if instrument:
+        trace_pyramid(config)
+
+    return config.make_wsgi_app(), renderer

tests/contrib/pyramid/test_pyramid.py

@@ -1,30 +1,42 @@
-# stdlib
 import json
-
-# 3p
-from pyramid.response import Response
-from pyramid.config import Configurator
-from pyramid.renderers import render_to_response
-from pyramid.httpexceptions import (
-    HTTPInternalServerError,
-    HTTPFound,
-    HTTPNotFound,
-    HTTPException,
-    HTTPNoContent,
-)
 import webtest
+
 from nose.tools import eq_, assert_raises
 
 # project
 from ddtrace import compat
-from ddtrace.contrib.pyramid import trace_pyramid
 from ddtrace.contrib.pyramid.patch import insert_tween_if_needed
 
+from pyramid.httpexceptions import HTTPException
+
+from .app import create_app
+
 from ...test_tracer import get_dummy_tracer
 from ...util import override_global_tracer
 
 
 class PyramidBase(object):
+    instrument = False
+
+    def setUp(self):
+        self.tracer = get_dummy_tracer()
+        self.create_app()
+
+    def create_app(self, settings=None):
+        # get default settings or use what is provided
+        settings = settings or self.get_settings()
+        # always set the dummy tracer as a default tracer
+        settings.update({'datadog_tracer': self.tracer})
+
+        app, renderer = create_app(settings, self.instrument)
+        self.app = webtest.TestApp(app)
+        self.renderer = renderer
+
+    def get_settings(self):
+        return {}
+
+    def override_settings(self, settings):
+        self.create_app(settings)
 
     def test_200(self):
         res = self.app.get('/', status=200)
@@ -157,9 +169,9 @@ def test_json(self):
 
     def test_renderer(self):
         self.app.get('/renderer', status=200)
-        assert self.rend._received['request'] is not None
+        assert self.renderer._received['request'] is not None
 
-        self.rend.assert_(foo='bar')
+        self.renderer.assert_(foo='bar')
         writer = self.tracer.writer
         spans = writer.pop()
         eq_(len(spans), 2)
@@ -195,134 +207,59 @@ def test_http_exception_response(self):
         eq_(s.meta.get('http.status_code'), '404')
         eq_(s.meta.get('http.url'), '/404/raise_exception')
 
+    def test_insert_tween_if_needed_already_set(self):
+        settings = {'pyramid.tweens': 'ddtrace.contrib.pyramid:trace_tween_factory'}
+        insert_tween_if_needed(settings)
+        eq_(settings['pyramid.tweens'], 'ddtrace.contrib.pyramid:trace_tween_factory')
+
+    def test_insert_tween_if_needed_none(self):
+        settings = {'pyramid.tweens': ''}
+        insert_tween_if_needed(settings)
+        eq_(settings['pyramid.tweens'], '')
+
+    def test_insert_tween_if_needed_excview(self):
+        settings = {'pyramid.tweens': 'pyramid.tweens.excview_tween_factory'}
+        insert_tween_if_needed(settings)
+        eq_(settings['pyramid.tweens'], 'ddtrace.contrib.pyramid:trace_tween_factory\npyramid.tweens.excview_tween_factory')
+
+    def test_insert_tween_if_needed_excview_and_other(self):
+        settings = {'pyramid.tweens': 'a.first.tween\npyramid.tweens.excview_tween_factory\na.last.tween\n'}
+        insert_tween_if_needed(settings)
+        eq_(settings['pyramid.tweens'],
+            'a.first.tween\n'
+            'ddtrace.contrib.pyramid:trace_tween_factory\n'
+            'pyramid.tweens.excview_tween_factory\n'
+            'a.last.tween\n')
+
+    def test_insert_tween_if_needed_others(self):
+        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 test_include_conflicts(self):
+        # test that includes do not create conflicts
+        self.override_settings({'pyramid.includes': 'tests.contrib.pyramid.test_pyramid'})
+        self.app.get('/404', status=404)
+        spans = self.tracer.writer.pop()
+        eq_(len(spans), 1)
+
 
 def includeme(config):
     pass
 
-def test_include_conflicts():
-    """ Test that includes do not create conflicts """
-    tracer = get_dummy_tracer()
-    with override_global_tracer(tracer):
-        config = Configurator(settings={'pyramid.includes': 'tests.contrib.pyramid.test_pyramid'})
-        trace_pyramid(config)
-        app = webtest.TestApp(config.make_wsgi_app())
-        app.get('/', status=404)
-        spans = tracer.writer.pop()
-        assert spans
-        eq_(len(spans), 1)
-
-def test_tween_overriden():
-    """ In case our tween is overriden by the user config we should not log
-    rendering """
-    tracer = get_dummy_tracer()
-    with override_global_tracer(tracer):
-        config = Configurator(settings={'pyramid.tweens': 'pyramid.tweens.excview_tween_factory'})
-        trace_pyramid(config)
-
-        def json(request):
-            return {'a': 1}
-        config.add_route('json', '/json')
-        config.add_view(json, route_name='json', renderer='json')
-        app = webtest.TestApp(config.make_wsgi_app())
-        app.get('/json', status=200)
-        spans = tracer.writer.pop()
-        assert not spans
-
-def test_insert_tween_if_needed_already_set():
-    settings = {'pyramid.tweens': 'ddtrace.contrib.pyramid:trace_tween_factory'}
-    insert_tween_if_needed(settings)
-    eq_(settings['pyramid.tweens'], 'ddtrace.contrib.pyramid:trace_tween_factory')
-
-def test_insert_tween_if_needed_none():
-    settings = {'pyramid.tweens': ''}
-    insert_tween_if_needed(settings)
-    eq_(settings['pyramid.tweens'], '')
-
-def test_insert_tween_if_needed_excview():
-    settings = {'pyramid.tweens': 'pyramid.tweens.excview_tween_factory'}
-    insert_tween_if_needed(settings)
-    eq_(settings['pyramid.tweens'], 'ddtrace.contrib.pyramid:trace_tween_factory\npyramid.tweens.excview_tween_factory')
-
-def test_insert_tween_if_needed_excview_and_other():
-    settings = {'pyramid.tweens': 'a.first.tween\npyramid.tweens.excview_tween_factory\na.last.tween\n'}
-    insert_tween_if_needed(settings)
-    eq_(settings['pyramid.tweens'],
-        'a.first.tween\n'
-        'ddtrace.contrib.pyramid:trace_tween_factory\n'
-        '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. """
-
-    def index(request):
-        return Response('idx')
-
-    def error(request):
-        raise HTTPInternalServerError("oh no")
-
-    def exception(request):
-        1 / 0
-
-    def json(request):
-        return {'a': 1}
-
-    def renderer(request):
-        return render_to_response('template.pt', {'foo': 'bar'}, request=request)
-
-    def raise_redirect(request):
-        raise HTTPFound()
-
-    def raise_no_content(request):
-        raise HTTPNoContent()
-
-    config.add_route('index', '/')
-    config.add_route('error', '/error')
-    config.add_route('exception', '/exception')
-    config.add_route('json', '/json')
-    config.add_route('renderer', '/renderer')
-    config.add_route('raise_redirect', '/redirect')
-    config.add_route('raise_no_content', '/nocontent')
-    config.add_view(index, route_name='index')
-    config.add_view(error, route_name='error')
-    config.add_view(exception, route_name='exception')
-    config.add_view(json, route_name='json', renderer='json')
-    config.add_view(renderer, route_name='renderer', renderer='template.pt')
-    config.add_view(raise_redirect, route_name='raise_redirect')
-    config.add_view(raise_no_content, route_name='raise_no_content')
-    return config.make_wsgi_app()
-
-
-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 = {
+    instrument = True
+
+    def get_settings(self):
+        return {
             '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)
+    def test_tween_overridden(self):
+        # in case our tween is overriden by the user config we should
+        # not log rendering
+        self.override_settings({'pyramid.tweens': 'pyramid.tweens.excview_tween_factory'})
+        self.app.get('/json', status=200)
+        spans = self.tracer.writer.pop()
+        eq_(len(spans), 0)

tests/contrib/pyramid/test_pyramid_autopatch.py

@@ -13,59 +13,29 @@
 from ...test_tracer import get_dummy_tracer
 from ...util import override_global_tracer
 
-from .test_pyramid import PyramidBase, get_app, custom_exception_view
+#from .test_pyramid import PyramidBase, get_app, custom_exception_view
+from .test_pyramid import PyramidBase
 
 
 class TestPyramidAutopatch(PyramidBase):
-    def setUp(self):
-        self.tracer = get_dummy_tracer()
-        ddtrace.tracer = self.tracer
-
-        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)
+    instrument = False
 
 
 class TestPyramidExplicitTweens(PyramidBase):
-    def setUp(self):
-        self.tracer = get_dummy_tracer()
-        ddtrace.tracer = self.tracer
+    instrument = False
 
-        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)
+    def get_settings(self):
+        return {
+            'pyramid.tweens': 'pyramid.tweens.excview_tween_factory\n',
+        }
 
 
 def _include_me(config):
     pass
 
 
-def includeme(config):
-    pass
-
-
 def test_config_include():
     """ This test makes sure that relative imports still work when the
     application is run with ddtrace-run """
     config = Configurator()
     config.include('._include_me')
-
-
-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_autopatch'})
-        app = webtest.TestApp(config.make_wsgi_app())
-        app.get('/', status=404)
-        spans = tracer.writer.pop()
-        assert spans
-        eq_(len(spans), 1)