From 91b89bde4742178534aa2a3fea6308fa463a2550 Mon Sep 17 00:00:00 2001 From: Elrond Date: Tue, 4 Oct 2011 01:03:43 +0200 Subject: [PATCH 1/3] 591: Let Testing Middleware check for staticdirect() usage All references to static, shipped content should go via request.staticdirect(). So insert a TestingMiddleware in the chain, which tests for this on all requests/reponses happening in the test suite. It's a simple text search for a bogus usage pattern. --- mediagoblin/middleware/testing.py | 34 ++++++++++++++++++++++++++ mediagoblin/tests/test_mgoblin_app.ini | 2 +- mediagoblin/tests/test_paste.ini | 2 +- mediagoblin/tests/tools.py | 6 +++++ 4 files changed, 42 insertions(+), 2 deletions(-) create mode 100644 mediagoblin/middleware/testing.py diff --git a/mediagoblin/middleware/testing.py b/mediagoblin/middleware/testing.py new file mode 100644 index 00000000..06714769 --- /dev/null +++ b/mediagoblin/middleware/testing.py @@ -0,0 +1,34 @@ +# GNU MediaGoblin -- federated, autonomous media hosting +# Copyright (C) 2011 MediaGoblin contributors. See AUTHORS. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + +class TestingMiddleware(object): + + def __init__(self, mg_app): + self.app = mg_app + + def process_request(self, request): + pass + + def process_response(self, request, response): + if response.content_type != "text/html": + # Get out early + return + if response.text.find("/mgoblin_static/") >= 0: + raise AssertionError( + "Response HTML contains reference to /mgoblin_static/ " + "instead of staticdirect. Request was for: " + + request.full_path) + return diff --git a/mediagoblin/tests/test_mgoblin_app.ini b/mediagoblin/tests/test_mgoblin_app.ini index ab32cccc..f979e810 100644 --- a/mediagoblin/tests/test_mgoblin_app.ini +++ b/mediagoblin/tests/test_mgoblin_app.ini @@ -1,5 +1,5 @@ [mediagoblin] -direct_remote_path = /mgoblin_static/ +direct_remote_path = /test_static/ email_sender_address = "notice@mediagoblin.example.org" email_debug_mode = true db_name = __mediagoblin_tests__ diff --git a/mediagoblin/tests/test_paste.ini b/mediagoblin/tests/test_paste.ini index e7574b7a..bd57994b 100644 --- a/mediagoblin/tests/test_paste.ini +++ b/mediagoblin/tests/test_paste.ini @@ -5,7 +5,7 @@ debug = true use = egg:Paste#urlmap / = mediagoblin /mgoblin_media/ = publicstore_serve -/mgoblin_static/ = mediagoblin_static +/test_static/ = mediagoblin_static [app:mediagoblin] use = egg:mediagoblin#app diff --git a/mediagoblin/tests/tools.py b/mediagoblin/tests/tools.py index cf84da14..e8558240 100644 --- a/mediagoblin/tests/tools.py +++ b/mediagoblin/tests/tools.py @@ -21,7 +21,9 @@ import os, shutil from paste.deploy import loadapp from webtest import TestApp +from mediagoblin import mg_globals from mediagoblin.tools import testing +from mediagoblin.middleware.testing import TestingMiddleware from mediagoblin.init.config import read_mediagoblin_config from mediagoblin.decorators import _make_safe from mediagoblin.db.open import setup_connection_and_db_from_config @@ -103,6 +105,10 @@ def get_test_app(dump_old_app=True): test_app = loadapp( 'config:' + TEST_SERVER_CONFIG) + # Insert the TestingMiddleware, which can do some + # sanity checks on every request/response. + mg_globals.app.middleware.insert(0, TestingMiddleware(mg_globals.app)) + app = TestApp(test_app) MGOBLIN_APP = app From 34b0874d9ad305f4c8d5e892a679bad2f33ed277 Mon Sep 17 00:00:00 2001 From: Elrond Date: Sun, 30 Oct 2011 20:51:55 +0100 Subject: [PATCH 2/3] Some docs for the TestingMiddleware To make the TestingMiddleware actually more useful in the future, start to document it. --- mediagoblin/middleware/testing.py | 25 +++++++++++++++++++++++++ mediagoblin/tests/tools.py | 2 ++ 2 files changed, 27 insertions(+) diff --git a/mediagoblin/middleware/testing.py b/mediagoblin/middleware/testing.py index 06714769..99322661 100644 --- a/mediagoblin/middleware/testing.py +++ b/mediagoblin/middleware/testing.py @@ -15,6 +15,23 @@ # along with this program. If not, see . class TestingMiddleware(object): + """ + Middleware for the Unit tests + + It might make sense to perform some tests on all + requests/responses. Or prepare them in a special + manner. For example all html responses could be tested + for being valid html *after* being rendered. + + This module is getting inserted at the front of the + middleware list, which means: requests are handed here + first, responses last. So this wraps up the "normal" + app. + + If you need to add a test, either add it directly to + the appropiate process_request or process_response, or + create a new method and call it from process_*. + """ def __init__(self, mg_app): self.app = mg_app @@ -23,12 +40,20 @@ class TestingMiddleware(object): pass def process_response(self, request, response): + # All following tests should be for html only! if response.content_type != "text/html": # Get out early return + + # If the template contains a reference to + # /mgoblin_static/ instead of using + # /request.staticdirect(), error out here. + # This could probably be implemented as a grep on + # the shipped templates easier... if response.text.find("/mgoblin_static/") >= 0: raise AssertionError( "Response HTML contains reference to /mgoblin_static/ " "instead of staticdirect. Request was for: " + request.full_path) + return diff --git a/mediagoblin/tests/tools.py b/mediagoblin/tests/tools.py index e8558240..7f20f6e7 100644 --- a/mediagoblin/tests/tools.py +++ b/mediagoblin/tests/tools.py @@ -107,6 +107,8 @@ def get_test_app(dump_old_app=True): # Insert the TestingMiddleware, which can do some # sanity checks on every request/response. + # Doing it this way is probably not the cleanest way. + # We'll fix it, when we have plugins! mg_globals.app.middleware.insert(0, TestingMiddleware(mg_globals.app)) app = TestApp(test_app) From 33d11e995d183f339597715472e4f6ecc81ba557 Mon Sep 17 00:00:00 2001 From: Elrond Date: Sat, 12 Nov 2011 13:21:41 +0100 Subject: [PATCH 3/3] Move TestingMiddleware to tests/tools.py This middleware isn't needed outside of the tests, so let's just put it there. --- mediagoblin/middleware/testing.py | 59 ------------------------------- mediagoblin/tests/tools.py | 46 +++++++++++++++++++++++- 2 files changed, 45 insertions(+), 60 deletions(-) delete mode 100644 mediagoblin/middleware/testing.py diff --git a/mediagoblin/middleware/testing.py b/mediagoblin/middleware/testing.py deleted file mode 100644 index 99322661..00000000 --- a/mediagoblin/middleware/testing.py +++ /dev/null @@ -1,59 +0,0 @@ -# GNU MediaGoblin -- federated, autonomous media hosting -# Copyright (C) 2011 MediaGoblin contributors. See AUTHORS. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# This program 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 Affero General Public License for more details. -# -# You should have received a copy of the GNU Affero General Public License -# along with this program. If not, see . - -class TestingMiddleware(object): - """ - Middleware for the Unit tests - - It might make sense to perform some tests on all - requests/responses. Or prepare them in a special - manner. For example all html responses could be tested - for being valid html *after* being rendered. - - This module is getting inserted at the front of the - middleware list, which means: requests are handed here - first, responses last. So this wraps up the "normal" - app. - - If you need to add a test, either add it directly to - the appropiate process_request or process_response, or - create a new method and call it from process_*. - """ - - def __init__(self, mg_app): - self.app = mg_app - - def process_request(self, request): - pass - - def process_response(self, request, response): - # All following tests should be for html only! - if response.content_type != "text/html": - # Get out early - return - - # If the template contains a reference to - # /mgoblin_static/ instead of using - # /request.staticdirect(), error out here. - # This could probably be implemented as a grep on - # the shipped templates easier... - if response.text.find("/mgoblin_static/") >= 0: - raise AssertionError( - "Response HTML contains reference to /mgoblin_static/ " - "instead of staticdirect. Request was for: " - + request.full_path) - - return diff --git a/mediagoblin/tests/tools.py b/mediagoblin/tests/tools.py index 7f20f6e7..420d9ba8 100644 --- a/mediagoblin/tests/tools.py +++ b/mediagoblin/tests/tools.py @@ -23,7 +23,6 @@ from webtest import TestApp from mediagoblin import mg_globals from mediagoblin.tools import testing -from mediagoblin.middleware.testing import TestingMiddleware from mediagoblin.init.config import read_mediagoblin_config from mediagoblin.decorators import _make_safe from mediagoblin.db.open import setup_connection_and_db_from_config @@ -51,6 +50,51 @@ $ CELERY_CONFIG_MODULE=mediagoblin.init.celery.from_tests ./bin/nosetests""" class BadCeleryEnviron(Exception): pass +class TestingMiddleware(object): + """ + Middleware for the Unit tests + + It might make sense to perform some tests on all + requests/responses. Or prepare them in a special + manner. For example all html responses could be tested + for being valid html *after* being rendered. + + This module is getting inserted at the front of the + middleware list, which means: requests are handed here + first, responses last. So this wraps up the "normal" + app. + + If you need to add a test, either add it directly to + the appropiate process_request or process_response, or + create a new method and call it from process_*. + """ + + def __init__(self, mg_app): + self.app = mg_app + + def process_request(self, request): + pass + + def process_response(self, request, response): + # All following tests should be for html only! + if response.content_type != "text/html": + # Get out early + return + + # If the template contains a reference to + # /mgoblin_static/ instead of using + # /request.staticdirect(), error out here. + # This could probably be implemented as a grep on + # the shipped templates easier... + if response.text.find("/mgoblin_static/") >= 0: + raise AssertionError( + "Response HTML contains reference to /mgoblin_static/ " + "instead of staticdirect. Request was for: " + + request.full_path) + + return + + def suicide_if_bad_celery_environ(): if not os.environ.get('CELERY_CONFIG_MODULE') == \ 'mediagoblin.init.celery.from_tests':