fix tests execution when building debian packages after changes from 05abfb07 and bb4aea9f:

  - move django settings for tests in new swh.web.settings.tests module
  - set DJANGO_SETTINGS_MODULE environment variable value to that module in debian/rules

debian/rules

@@ -2,6 +2,7 @@
 
 export PYBUILD_NAME=swh.web
 export PYBUILD_TEST_ARGS=--with-doctest -sv -a !db,!fs
+export DJANGO_SETTINGS_MODULE=swh.web.settings.tests
 
 %:
 	dh $@ --with python3 --buildsystem=pybuild

swh/web/api/views/__init__.py

-# Copyright (C) 2015-2017  The Software Heritage developers
-# See the AUTHORS file at the top-level directory of this distribution
-# License: GNU Affero General Public License version 3, or any later version
-# See top-level LICENSE file for more information
-
-from rest_framework.response import Response
-from rest_framework.decorators import api_view
-
-from types import GeneratorType
-
-from swh.web.common.exc import NotFoundExc
-from swh.web.api.apiurls import APIUrls, api_route
-
-# canned doc string snippets that are used in several doc strings
-_doc_arg_content_id = """A "[hash_type:]hash" content identifier, where
-   hash_type is one of "sha1" (the default), "sha1_git", "sha256", and hash is
-   a checksum obtained with the hash_type hashing algorithm."""
-_doc_arg_last_elt = 'element to start listing from, for pagination purposes'
-_doc_arg_per_page = 'number of elements to list, for pagination purposes'
-
-_doc_exc_bad_id = 'syntax error in the given identifier(s)'
-_doc_exc_id_not_found = 'no object matching the given criteria could be found'
-
-_doc_ret_revision_meta = 'metadata of the revision identified by sha1_git'
-_doc_ret_revision_log = """list of dictionaries representing the metadata of
-    each revision found in the commit log heading to revision sha1_git.
-    For each commit at least the following information are returned:
-    author/committer, authoring/commit timestamps, revision id, commit message,
-    parent (i.e., immediately preceding) commits, "root" directory id."""
-
-_doc_header_link = """indicates that a subsequent result page is available,
-    pointing to it"""
-
-
-def _api_lookup(lookup_fn, *args,
-                notfound_msg='Object not found',
-                enrich_fn=lambda x: x):
-    """Capture a redundant behavior of:
-    - looking up the backend with a criteria (be it an identifier or checksum)
-    passed to the function lookup_fn
-    - if nothing is found, raise an NotFoundExc exception with error
-    message notfound_msg.
-    - Otherwise if something is returned:
-        - either as list, map or generator, map the enrich_fn function to it
-        and return the resulting data structure as list.
-        - either as dict and pass to enrich_fn and return the dict enriched.
-
-    Args:
-        - criteria: discriminating criteria to lookup
-        - lookup_fn: function expects one criteria and optional supplementary
-        *args.
-        - notfound_msg: if nothing matching the criteria is found,
-        raise NotFoundExc with this error message.
-        - enrich_fn: Function to use to enrich the result returned by
-        lookup_fn. Default to the identity function if not provided.
-        - *args: supplementary arguments to pass to lookup_fn.
-
-    Raises:
-        NotFoundExp or whatever `lookup_fn` raises.
-
-    """
-    res = lookup_fn(*args)
-    if not res:
-        raise NotFoundExc(notfound_msg)
-    if isinstance(res, (map, list, GeneratorType)):
-        return [enrich_fn(x) for x in res]
-    return enrich_fn(res)
-
-
-@api_view(['GET', 'HEAD'])
-def api_home(request):
-    return Response({}, template_name='api.html')
-
-
-APIUrls.add_url_pattern(r'^$', api_home, view_name='api_homepage')
-
-
-@api_route(r'/', 'endpoints')
-def api_endpoints(request):
-    """Display the list of opened api endpoints.
-
-    """
-    routes = APIUrls.get_app_endpoints().copy()
-    for route, doc in routes.items():
-        doc['doc_intro'] = doc['docstring'].split('\n\n')[0]
-    # Return a list of routes with consistent ordering
-    env = {
-        'doc_routes': sorted(routes.items())
-    }
-    return Response(env, template_name="api-endpoints.html")

swh/web/api/views/content.py

@@ -13,7 +13,7 @@ from swh.web.common.exc import NotFoundExc, ForbiddenExc
 from swh.web.api import apidoc as api_doc
 from swh.web.api import utils
 from swh.web.api.apiurls import api_route
-from swh.web.api.views import (
+from swh.web.api.views.utils import (
     _api_lookup, _doc_exc_id_not_found, _doc_header_link,
     _doc_arg_last_elt, _doc_arg_per_page, _doc_exc_bad_id,
     _doc_arg_content_id

swh/web/api/views/directory.py

@@ -7,7 +7,7 @@ from swh.web.common import service
 from swh.web.api import utils
 from swh.web.api import apidoc as api_doc
 from swh.web.api.apiurls import api_route
-from swh.web.api.views import (
+from swh.web.api.views.utils import (
     _api_lookup, _doc_exc_id_not_found,
     _doc_exc_bad_id,
 )

swh/web/api/views/entity.py

@@ -7,7 +7,7 @@ from swh.web.common import service
 from swh.web.api import utils
 from swh.web.api import apidoc as api_doc
 from swh.web.api.apiurls import api_route
-from swh.web.api.views import (
+from swh.web.api.views.utils import (
     _api_lookup, _doc_exc_id_not_found,
     _doc_exc_bad_id
 )

swh/web/api/views/origin.py

@@ -9,7 +9,7 @@ from swh.web.common.utils import reverse
 from swh.web.api import utils
 from swh.web.api import apidoc as api_doc
 from swh.web.api.apiurls import api_route
-from swh.web.api.views import (
+from swh.web.api.views.utils import (
     _api_lookup, _doc_exc_id_not_found, _doc_header_link,
     _doc_arg_last_elt, _doc_arg_per_page
 )

swh/web/api/views/person.py

@@ -6,7 +6,7 @@
 from swh.web.common import service
 from swh.web.api import apidoc as api_doc
 from swh.web.api.apiurls import api_route
-from swh.web.api.views import (
+from swh.web.api.views.utils import (
     _api_lookup, _doc_exc_id_not_found,
 )
 

swh/web/api/views/release.py

@@ -7,7 +7,7 @@ from swh.web.common import service
 from swh.web.api import utils
 from swh.web.api import apidoc as api_doc
 from swh.web.api.apiurls import api_route
-from swh.web.api.views import (
+from swh.web.api.views.utils import (
     _api_lookup, _doc_exc_id_not_found, _doc_exc_bad_id
 )
 

swh/web/api/views/revision.py

@@ -11,7 +11,7 @@ from swh.web.common.utils import parse_timestamp
 from swh.web.api import utils
 from swh.web.api import apidoc as api_doc
 from swh.web.api.apiurls import api_route
-from swh.web.api.views import (
+from swh.web.api.views.utils import (
     _api_lookup, _doc_exc_id_not_found, _doc_header_link,
     _doc_arg_per_page, _doc_exc_bad_id,
     _doc_ret_revision_log, _doc_ret_revision_meta

swh/web/api/views/utils.py

+# Copyright (C) 2015-2017  The Software Heritage developers
+# See the AUTHORS file at the top-level directory of this distribution
+# License: GNU Affero General Public License version 3, or any later version
+# See top-level LICENSE file for more information
+
+from rest_framework.response import Response
+from rest_framework.decorators import api_view
+
+from types import GeneratorType
+
+from swh.web.common.exc import NotFoundExc
+from swh.web.api.apiurls import APIUrls, api_route
+
+# canned doc string snippets that are used in several doc strings
+_doc_arg_content_id = """A "[hash_type:]hash" content identifier, where
+   hash_type is one of "sha1" (the default), "sha1_git", "sha256", and hash is
+   a checksum obtained with the hash_type hashing algorithm."""
+_doc_arg_last_elt = 'element to start listing from, for pagination purposes'
+_doc_arg_per_page = 'number of elements to list, for pagination purposes'
+
+_doc_exc_bad_id = 'syntax error in the given identifier(s)'
+_doc_exc_id_not_found = 'no object matching the given criteria could be found'
+
+_doc_ret_revision_meta = 'metadata of the revision identified by sha1_git'
+_doc_ret_revision_log = """list of dictionaries representing the metadata of
+    each revision found in the commit log heading to revision sha1_git.
+    For each commit at least the following information are returned:
+    author/committer, authoring/commit timestamps, revision id, commit message,
+    parent (i.e., immediately preceding) commits, "root" directory id."""
+
+_doc_header_link = """indicates that a subsequent result page is available,
+    pointing to it"""
+
+
+def _api_lookup(lookup_fn, *args,
+                notfound_msg='Object not found',
+                enrich_fn=lambda x: x):
+    """Capture a redundant behavior of:
+    - looking up the backend with a criteria (be it an identifier or checksum)
+    passed to the function lookup_fn
+    - if nothing is found, raise an NotFoundExc exception with error
+    message notfound_msg.
+    - Otherwise if something is returned:
+        - either as list, map or generator, map the enrich_fn function to it
+        and return the resulting data structure as list.
+        - either as dict and pass to enrich_fn and return the dict enriched.
+
+    Args:
+        - criteria: discriminating criteria to lookup
+        - lookup_fn: function expects one criteria and optional supplementary
+        *args.
+        - notfound_msg: if nothing matching the criteria is found,
+        raise NotFoundExc with this error message.
+        - enrich_fn: Function to use to enrich the result returned by
+        lookup_fn. Default to the identity function if not provided.
+        - *args: supplementary arguments to pass to lookup_fn.
+
+    Raises:
+        NotFoundExp or whatever `lookup_fn` raises.
+
+    """
+    res = lookup_fn(*args)
+    if not res:
+        raise NotFoundExc(notfound_msg)
+    if isinstance(res, (map, list, GeneratorType)):
+        return [enrich_fn(x) for x in res]
+    return enrich_fn(res)
+
+
+@api_view(['GET', 'HEAD'])
+def api_home(request):
+    return Response({}, template_name='api.html')
+
+
+APIUrls.add_url_pattern(r'^$', api_home, view_name='api_homepage')
+
+
+@api_route(r'/', 'endpoints')
+def api_endpoints(request):
+    """Display the list of opened api endpoints.
+
+    """
+    routes = APIUrls.get_app_endpoints().copy()
+    for route, doc in routes.items():
+        doc['doc_intro'] = doc['docstring'].split('\n\n')[0]
+    # Return a list of routes with consistent ordering
+    env = {
+        'doc_routes': sorted(routes.items())
+    }
+    return Response(env, template_name="api-endpoints.html")

swh/web/settings/tests.py

+# Copyright (C) 2017  The Software Heritage developers
+# See the AUTHORS file at the top-level directory of this distribution
+# License: GNU General Public License version 3, or any later version
+# See top-level LICENSE file for more information
+
+# flake8: noqa
+
+from swh.web.config import get_config
+
+scope1_limiter_rate = 3
+scope2_limiter_rate = 5
+
+swh_web_config = get_config()
+
+swh_web_config.update({
+    'debug': True,
+    'secret_key': 'test',
+    'throttling': {
+        'cache_uri': None,
+        'scopes': {
+            'swh_api': {
+                'limiter_rate': '60/min',
+                'exempted_networks': ['127.0.0.0/8']
+            },
+            'scope1': {
+                'limiter_rate': '%s/min' % scope1_limiter_rate
+            },
+            'scope2': {
+                'limiter_rate': '%s/min' % scope2_limiter_rate,
+                'exempted_networks': ['127.0.0.0/8']
+            }
+        }
+    }
+})
+
+from .common import *
\ No newline at end of file

swh/web/tests/__init__.py

@@ -3,36 +3,11 @@
 # License: GNU General Public License version 3, or any later version
 # See top-level LICENSE file for more information
 
-import os
-import django
-
-from swh.web.config import get_config
-
-swh_web_config = get_config()
+# this configuration is needed to successfully run the tests locally
+# when calling 'make test'
 
-swh_web_config.update({
-    'debug': True,
-    'secret_key': 'test',
-    'throttling': {
-        'cache_uri': None,
-        'scopes': {
-            'swh_api': {
-                'limiter_rate': '60/min',
-                'exempted_networks': ['127.0.0.0/8']
-            },
-            'scope1': {
-                'limiter_rate': '3/min'
-            },
-            'scope2': {
-                'limiter_rate': '5/min',
-                'exempted_networks': ['127.0.0.0/8']
-            }
-        }
-    }
-})
+import django
+import os
 
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "swh.web.settings.development")
+os.environ["DJANGO_SETTINGS_MODULE"] = "swh.web.settings.tests"
 django.setup()
-
-scope1_limiter_rate = 3
-scope2_limiter_rate = 5

swh/web/tests/api/test_api_lookup.py

@@ -7,7 +7,7 @@ from nose.tools import istest
 
 from .swh_api_testcase import SWHApiTestCase
 from swh.web.common.exc import NotFoundExc
-from swh.web.api import views
+from swh.web.api.views import utils
 
 
 class ApiLookupTestCase(SWHApiTestCase):
@@ -22,7 +22,7 @@ class ApiLookupTestCase(SWHApiTestCase):
 
         # when
         with self.assertRaises(NotFoundExc) as cm:
-            views._api_lookup(
+            utils._api_lookup(
                 test_generic_lookup_fn, 'sha1', 'unused_arg',
                 notfound_msg='This will be raised because None is returned.')
 
@@ -37,7 +37,7 @@ class ApiLookupTestCase(SWHApiTestCase):
             return map(lambda x: x + 1, [1, 2, 3])
 
         # when
-        actual_result = views._api_lookup(
+        actual_result = utils._api_lookup(
             test_generic_lookup_fn_1, 'something', 'some param 0',
             'some param 1',
             notfound_msg=('This is not the error message you are looking for. '
@@ -54,7 +54,7 @@ class ApiLookupTestCase(SWHApiTestCase):
             return ['a', 'b', 'c']
 
         # when
-        actual_result = views._api_lookup(
+        actual_result = utils._api_lookup(
             test_generic_lookup_fn_2, 'something',
             notfound_msg=('Not the error message you are looking for, it is. '
                           'Along, you move!'),
@@ -70,7 +70,7 @@ class ApiLookupTestCase(SWHApiTestCase):
             return (i for i in [4, 5, 6])
 
         # when
-        actual_result = views._api_lookup(
+        actual_result = utils._api_lookup(
             test_generic_lookup_fn_3, 'crit',
             notfound_msg='Move!',
             enrich_fn=lambda x: x - 1)
@@ -89,7 +89,7 @@ class ApiLookupTestCase(SWHApiTestCase):
             return x
 
         # when
-        actual_result = views._api_lookup(
+        actual_result = utils._api_lookup(
             test_generic_lookup_fn_4, '123',
             notfound_msg='Nothing to do',
             enrich_fn=test_enrich_data)
@@ -100,7 +100,7 @@ class ApiLookupTestCase(SWHApiTestCase):
     def api_lookup_not_found(self):
         # when
         with self.assertRaises(NotFoundExc) as e:
-            views._api_lookup(
+            utils._api_lookup(
                 lambda x: None, 'something',
                 notfound_msg='this is the error message raised as it is None')
 
@@ -110,7 +110,7 @@ class ApiLookupTestCase(SWHApiTestCase):
     @istest
     def api_lookup_with_result(self):
         # when
-        actual_result = views._api_lookup(
+        actual_result = utils._api_lookup(
             lambda x: x + '!', 'something',
             notfound_msg='this is the error which won\'t be used here')
 
@@ -119,7 +119,7 @@ class ApiLookupTestCase(SWHApiTestCase):
     @istest
     def api_lookup_with_result_as_map(self):
         # when
-        actual_result = views._api_lookup(
+        actual_result = utils._api_lookup(
             lambda x: map(lambda y: y+1, x), [1, 2, 3],
             notfound_msg='this is the error which won\'t be used here')
 

swh/web/tests/common/test_throttling.py

@@ -3,7 +3,7 @@
 # License: GNU General Public License version 3, or any later version
 # See top-level LICENSE file for more information
 
-from swh.web.tests import (
+from swh.web.settings.tests import (
     scope1_limiter_rate, scope2_limiter_rate
 )