tests: use common test route generator.

rhodecode/apps/my_account/tests/test_my_account_auth_tokens.py

@@ -1,111 +1,111 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2010-2020 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # 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 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 <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 import pytest
 
 from rhodecode.apps._base import ADMIN_PREFIX
 from rhodecode.model.db import User
 from rhodecode.tests import (
-    TestController, TEST_USER_ADMIN_LOGIN, TEST_USER_ADMIN_PASS,
-    TEST_USER_REGULAR_LOGIN, TEST_USER_REGULAR_PASS, assert_session_flash)
+    TestController, route_path_generator, assert_session_flash)
 from rhodecode.tests.fixture import Fixture
 from rhodecode.tests.utils import AssertResponse
 
 fixture = Fixture()
 
 
-def route_path(name, **kwargs):
-    return {
+def route_path(name, params=None, **kwargs):
+    url_defs = {
         'my_account_auth_tokens':
             ADMIN_PREFIX + '/my_account/auth_tokens',
         'my_account_auth_tokens_add':
             ADMIN_PREFIX + '/my_account/auth_tokens/new',
         'my_account_auth_tokens_delete':
             ADMIN_PREFIX + '/my_account/auth_tokens/delete',
-    }[name].format(**kwargs)
+    }
+    return route_path_generator(url_defs, name=name, params=params, **kwargs)
 
 
 class TestMyAccountAuthTokens(TestController):
 
     def test_my_account_auth_tokens(self):
         usr = self.log_user('test_regular2', 'test12')
         user = User.get(usr['user_id'])
         response = self.app.get(route_path('my_account_auth_tokens'))
         for token in user.auth_tokens:
             response.mustcontain(token[:4])
             response.mustcontain('never')
 
     def test_my_account_add_auth_tokens_wrong_csrf(self, user_util):
         user = user_util.create_user(password='qweqwe')
         self.log_user(user.username, 'qweqwe')
 
         self.app.post(
             route_path('my_account_auth_tokens_add'),
             {'description': 'desc', 'lifetime': -1}, status=403)
 
     @pytest.mark.parametrize("desc, lifetime", [
         ('forever', -1),
         ('5mins', 60*5),
         ('30days', 60*60*24*30),
     ])
     def test_my_account_add_auth_tokens(self, desc, lifetime, user_util):
         user = user_util.create_user(password='qweqwe')
         user_id = user.user_id
         self.log_user(user.username, 'qweqwe')
 
         response = self.app.post(
             route_path('my_account_auth_tokens_add'),
             {'description': desc, 'lifetime': lifetime,
              'csrf_token': self.csrf_token})
         assert_session_flash(response, 'Auth token successfully created')
 
         response = response.follow()
         user = User.get(user_id)
         for auth_token in user.auth_tokens:
             response.mustcontain(auth_token[:4])
 
     def test_my_account_delete_auth_token(self, user_util):
         user = user_util.create_user(password='qweqwe')
         user_id = user.user_id
         self.log_user(user.username, 'qweqwe')
 
         user = User.get(user_id)
         keys = user.get_auth_tokens()
         assert 2 == len(keys)
 
         response = self.app.post(
             route_path('my_account_auth_tokens_add'),
             {'description': 'desc', 'lifetime': -1,
              'csrf_token': self.csrf_token})
         assert_session_flash(response, 'Auth token successfully created')
         response.follow()
 
         user = User.get(user_id)
         keys = user.get_auth_tokens()
         assert 3 == len(keys)
 
         response = self.app.post(
             route_path('my_account_auth_tokens_delete'),
             {'del_auth_token': keys[0].user_api_key_id, 'csrf_token': self.csrf_token})
         assert_session_flash(response, 'Auth token successfully deleted')
 
         user = User.get(user_id)
         keys = user.auth_tokens
         assert 2 == len(keys)

rhodecode/apps/search/tests/test_search.py

@@ -1,202 +1,202 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2010-2020 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # 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 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 <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 import os
 
 import mock
 import pytest
 from whoosh import query
 
 from rhodecode.tests import (
-    TestController, HG_REPO,
+    TestController, route_path_generator, HG_REPO,
     TEST_USER_REGULAR_LOGIN, TEST_USER_REGULAR_PASS)
 from rhodecode.tests.utils import AssertResponse
 
 
-def route_path(name, **kwargs):
+def route_path(name, params=None, **kwargs):
     from rhodecode.apps._base import ADMIN_PREFIX
-    return {
+    url_defs = {
         'search':
             ADMIN_PREFIX + '/search',
         'search_repo':
             '/{repo_name}/search',
-
-    }[name].format(**kwargs)
+    }
+    return route_path_generator(url_defs, name=name, params=params, **kwargs)
 
 
 class TestSearchController(TestController):
 
     def test_index(self):
         self.log_user()
         response = self.app.get(route_path('search'))
         assert_response = response.assert_response()
         assert_response.one_element_exists('input#q')
 
     def test_search_files_empty_search(self):
         if os.path.isdir(self.index_location):
             pytest.skip('skipped due to existing index')
         else:
             self.log_user()
             response = self.app.get(route_path('search'),
                                     {'q': HG_REPO})
             response.mustcontain('There is no index to search in. '
                                  'Please run whoosh indexer')
 
     def test_search_validation(self):
         self.log_user()
         response = self.app.get(route_path('search'),
             {'q': query, 'type': 'content', 'page_limit': 1000})
 
         response.mustcontain(
             'page_limit - 1000 is greater than maximum value 500')
 
     @pytest.mark.parametrize("query, expected_hits, expected_paths", [
         ('todo', 23, [
             'vcs/backends/hg/inmemory.py',
             'vcs/tests/test_git.py']),
         ('extension:rst installation', 6, [
             'docs/index.rst',
             'docs/installation.rst']),
         ('def repo', 87, [
             'vcs/tests/test_git.py',
             'vcs/tests/test_changesets.py']),
         ('repository:%s def test' % HG_REPO, 18, [
             'vcs/tests/test_git.py',
             'vcs/tests/test_changesets.py']),
         ('"def main"', 9, [
             'vcs/__init__.py',
             'vcs/tests/__init__.py',
             'vcs/utils/progressbar.py']),
         ('owner:test_admin', 358, [
             'vcs/tests/base.py',
             'MANIFEST.in',
             'vcs/utils/termcolors.py',
             'docs/theme/ADC/static/documentation.png']),
         ('owner:test_admin def main', 72, [
             'vcs/__init__.py',
             'vcs/tests/test_utils_filesize.py',
             'vcs/tests/test_cli.py']),
         ('owner:michał test', 0, []),
     ])
     def test_search_files(self, query, expected_hits, expected_paths):
         self.log_user()
         response = self.app.get(route_path('search'),
             {'q': query, 'type': 'content', 'page_limit': 500})
 
         response.mustcontain('%s results' % expected_hits)
         for path in expected_paths:
             response.mustcontain(path)
 
     @pytest.mark.parametrize("query, expected_hits, expected_commits", [
         ('bother to ask where to fetch repo during tests', 3, [
             ('hg', 'a00c1b6f5d7a6ae678fd553a8b81d92367f7ecf1'),
             ('git', 'c6eb379775c578a95dad8ddab53f963b80894850'),
             ('svn', '98')]),
         ('michał', 0, []),
         ('changed:tests/utils.py', 36, [
             ('hg', 'a00c1b6f5d7a6ae678fd553a8b81d92367f7ecf1')]),
         ('changed:vcs/utils/archivers.py', 11, [
             ('hg', '25213a5fbb048dff8ba65d21e466a835536e5b70'),
             ('hg', '47aedd538bf616eedcb0e7d630ea476df0e159c7'),
             ('hg', 'f5d23247fad4856a1dabd5838afade1e0eed24fb'),
             ('hg', '04ad456aefd6461aea24f90b63954b6b1ce07b3e'),
             ('git', 'c994f0de03b2a0aa848a04fc2c0d7e737dba31fc'),
             ('git', 'd1f898326327e20524fe22417c22d71064fe54a1'),
             ('git', 'fe568b4081755c12abf6ba673ba777fc02a415f3'),
             ('git', 'bafe786f0d8c2ff7da5c1dcfcfa577de0b5e92f1')]),
         ('added:README.rst', 3, [
             ('hg', '3803844fdbd3b711175fc3da9bdacfcd6d29a6fb'),
             ('git', 'ff7ca51e58c505fec0dd2491de52c622bb7a806b'),
             ('svn', '8')]),
         ('changed:lazy.py', 15, [
             ('hg', 'eaa291c5e6ae6126a203059de9854ccf7b5baa12'),
             ('git', '17438a11f72b93f56d0e08e7d1fa79a378578a82'),
             ('svn', '82'),
             ('svn', '262'),
             ('hg', 'f5d23247fad4856a1dabd5838afade1e0eed24fb'),
             ('git', '33fa3223355104431402a888fa77a4e9956feb3e')
             ]),
         ('author:[e-mail] '
          'commit_id:b986218ba1c9b0d6a259fac9b050b1724ed8e545', 1, [
              ('hg', 'b986218ba1c9b0d6a259fac9b050b1724ed8e545')]),
         ('b986218ba1c9b0d6a259fac9b050b1724ed8e545', 1, [
              ('hg', 'b986218ba1c9b0d6a259fac9b050b1724ed8e545')]),
         ('b986218b', 1, [
              ('hg', 'b986218ba1c9b0d6a259fac9b050b1724ed8e545')]),
     ])
     def test_search_commit_messages(
             self, query, expected_hits, expected_commits, enabled_backends):
         self.log_user()
         response = self.app.get(route_path('search'),
             {'q': query, 'type': 'commit', 'page_limit': 500})
 
         response.mustcontain('%s results' % expected_hits)
         for backend, commit_id in expected_commits:
             if backend in enabled_backends:
                 response.mustcontain(commit_id)
 
     @pytest.mark.parametrize("query, expected_hits, expected_paths", [
         ('readme.rst', 3, []),
         ('test*', 75, []),
         ('*model*', 1, []),
         ('extension:rst', 48, []),
         ('extension:rst api', 24, []),
     ])
     def test_search_file_paths(self, query, expected_hits, expected_paths):
         self.log_user()
         response = self.app.get(route_path('search'),
             {'q': query, 'type': 'path', 'page_limit': 500})
 
         response.mustcontain('%s results' % expected_hits)
         for path in expected_paths:
             response.mustcontain(path)
 
     def test_search_commit_message_specific_repo(self, backend):
         self.log_user()
         response = self.app.get(
             route_path('search_repo',repo_name=backend.repo_name),
             {'q': 'bother to ask where to fetch repo during tests',
              'type': 'commit'})
 
         response.mustcontain('1 results')
 
     def test_filters_are_not_applied_for_admin_user(self):
         self.log_user()
         with mock.patch('whoosh.searching.Searcher.search') as search_mock:
             self.app.get(route_path('search'),
                 {'q': 'test query', 'type': 'commit'})
         assert search_mock.call_count == 1
         _, kwargs = search_mock.call_args
         assert kwargs['filter'] is None
 
     def test_filters_are_applied_for_normal_user(self, enabled_backends):
         self.log_user(TEST_USER_REGULAR_LOGIN, TEST_USER_REGULAR_PASS)
         with mock.patch('whoosh.searching.Searcher.search') as search_mock:
             self.app.get(route_path('search'),
                 {'q': 'test query', 'type': 'commit'})
         assert search_mock.call_count == 1
         _, kwargs = search_mock.call_args
         assert isinstance(kwargs['filter'], query.Or)
         expected_repositories = [
             'vcs_test_{}'.format(b) for b in enabled_backends]
         queried_repositories = [
             name for type_, name in kwargs['filter'].all_terms()]
         for repository in expected_repositories:
             assert repository in queried_repositories

rhodecode/tests/__init__.py

@@ -1,245 +1,255 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2010-2020 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # 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 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 <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 import os
 import time
 import logging
 import datetime
 import hashlib
 import tempfile
 from os.path import join as jn
 
 from tempfile import _RandomNameSequence
 
 import pytest
 
 from rhodecode.model.db import User
 from rhodecode.lib import auth
 from rhodecode.lib import helpers as h
-from rhodecode.lib.helpers import flash, link_to
+from rhodecode.lib.helpers import flash
 from rhodecode.lib.utils2 import safe_str
 
 
 log = logging.getLogger(__name__)
 
 __all__ = [
-    'get_new_dir', 'TestController',
-    'link_to', 'clear_cache_regions',
+    'get_new_dir', 'TestController', 'route_path_generator',
+    'clear_cache_regions',
     'assert_session_flash', 'login_user', 'no_newline_id_generator',
     'TESTS_TMP_PATH', 'HG_REPO', 'GIT_REPO', 'SVN_REPO',
     'NEW_HG_REPO', 'NEW_GIT_REPO',
     'HG_FORK', 'GIT_FORK', 'TEST_USER_ADMIN_LOGIN', 'TEST_USER_ADMIN_PASS',
     'TEST_USER_REGULAR_LOGIN', 'TEST_USER_REGULAR_PASS',
     'TEST_USER_REGULAR_EMAIL', 'TEST_USER_REGULAR2_LOGIN',
     'TEST_USER_REGULAR2_PASS', 'TEST_USER_REGULAR2_EMAIL', 'TEST_HG_REPO',
     'TEST_HG_REPO_CLONE', 'TEST_HG_REPO_PULL', 'TEST_GIT_REPO',
     'TEST_GIT_REPO_CLONE', 'TEST_GIT_REPO_PULL', 'SCM_TESTS',
 ]
 
 
 # SOME GLOBALS FOR TESTS
 TEST_DIR = tempfile.gettempdir()
 
 TESTS_TMP_PATH = jn(TEST_DIR, 'rc_test_%s' % _RandomNameSequence().next())
 TEST_USER_ADMIN_LOGIN = 'test_admin'
 TEST_USER_ADMIN_PASS = 'test12'
 TEST_USER_ADMIN_EMAIL = '[e-mail]'
 
 TEST_USER_REGULAR_LOGIN = 'test_regular'
 TEST_USER_REGULAR_PASS = 'test12'
 TEST_USER_REGULAR_EMAIL = '[e-mail]'
 
 TEST_USER_REGULAR2_LOGIN = 'test_regular2'
 TEST_USER_REGULAR2_PASS = 'test12'
 TEST_USER_REGULAR2_EMAIL = '[e-mail]'
 
 HG_REPO = 'vcs_test_hg'
 GIT_REPO = 'vcs_test_git'
 SVN_REPO = 'vcs_test_svn'
 
 NEW_HG_REPO = 'vcs_test_hg_new'
 NEW_GIT_REPO = 'vcs_test_git_new'
 
 HG_FORK = 'vcs_test_hg_fork'
 GIT_FORK = 'vcs_test_git_fork'
 
 ## VCS
 SCM_TESTS = ['hg', 'git']
 uniq_suffix = str(int(time.mktime(datetime.datetime.now().timetuple())))
 
 TEST_GIT_REPO = jn(TESTS_TMP_PATH, GIT_REPO)
 TEST_GIT_REPO_CLONE = jn(TESTS_TMP_PATH, 'vcsgitclone%s' % uniq_suffix)
 TEST_GIT_REPO_PULL = jn(TESTS_TMP_PATH, 'vcsgitpull%s' % uniq_suffix)
 
 TEST_HG_REPO = jn(TESTS_TMP_PATH, HG_REPO)
 TEST_HG_REPO_CLONE = jn(TESTS_TMP_PATH, 'vcshgclone%s' % uniq_suffix)
 TEST_HG_REPO_PULL = jn(TESTS_TMP_PATH, 'vcshgpull%s' % uniq_suffix)
 
 TEST_REPO_PREFIX = 'vcs-test'
 
 
 def clear_cache_regions(regions=None):
     # dogpile
     from rhodecode.lib.rc_cache import region_meta
     for region_name, region in region_meta.dogpile_cache_regions.items():
         if not regions or region_name in regions:
             region.invalidate()
 
 
 def get_new_dir(title):
     """
     Returns always new directory path.
     """
     from rhodecode.tests.vcs.utils import get_normalized_path
     name_parts = [TEST_REPO_PREFIX]
     if title:
         name_parts.append(title)
     hex_str = hashlib.sha1('%s %s' % (os.getpid(), time.time())).hexdigest()
     name_parts.append(hex_str)
     name = '-'.join(name_parts)
     path = os.path.join(TEST_DIR, name)
     return get_normalized_path(path)
 
 
 def repo_id_generator(name):
     numeric_hash = 0
     for char in name:
         numeric_hash += (ord(char))
     return numeric_hash
 
 
 @pytest.mark.usefixtures('app', 'index_location')
 class TestController(object):
 
     maxDiff = None
 
     def log_user(self, username=TEST_USER_ADMIN_LOGIN,
                  password=TEST_USER_ADMIN_PASS):
         self._logged_username = username
         self._session = login_user_session(self.app, username, password)
         self.csrf_token = auth.get_csrf_token(self._session)
 
         return self._session['rhodecode_user']
 
     def logout_user(self):
         logout_user_session(self.app, auth.get_csrf_token(self._session))
         self.csrf_token = None
         self._logged_username = None
         self._session = None
 
     def _get_logged_user(self):
         return User.get_by_username(self._logged_username)
 
 
 def login_user_session(
         app, username=TEST_USER_ADMIN_LOGIN, password=TEST_USER_ADMIN_PASS):
 
     response = app.post(
         h.route_path('login'),
         {'username': username, 'password': password})
     if 'invalid user name' in response.body:
         pytest.fail('could not login using %s %s' % (username, password))
 
     assert response.status == '302 Found'
     response = response.follow()
     assert response.status == '200 OK'
 
     session = response.get_session_from_response()
     assert 'rhodecode_user' in session
     rc_user = session['rhodecode_user']
     assert rc_user.get('username') == username
     assert rc_user.get('is_authenticated')
 
     return session
 
 
 def logout_user_session(app, csrf_token):
     app.post(h.route_path('logout'), {'csrf_token': csrf_token}, status=302)
 
 
 def login_user(app, username=TEST_USER_ADMIN_LOGIN,
                password=TEST_USER_ADMIN_PASS):
     return login_user_session(app, username, password)['rhodecode_user']
 
 
 def assert_session_flash(response, msg=None, category=None, no_=None):
     """
     Assert on a flash message in the current session.
 
     :param response: Response from give calll, it will contain flash
         messages or bound session with them.
     :param msg: The expected message. Will be evaluated if a
         :class:`LazyString` is passed in.
     :param category: Optional. If passed, the message category will be
         checked as well.
     :param no_: Optional. If passed, the message will be checked to NOT
         be in the flash session
     """
     if msg is None and no_ is None:
         raise ValueError("Parameter msg or no_ is required.")
 
     if msg and no_:
         raise ValueError("Please specify either msg or no_, but not both")
 
     session = response.get_session_from_response()
     messages = flash.pop_messages(session=session)
     msg = _eval_if_lazy(msg)
 
     if no_:
         error_msg = 'unable to detect no_ message `%s` in empty flash list' % no_
     else:
         error_msg = 'unable to find message `%s` in empty flash list' % msg
     assert messages, error_msg
     message = messages[0]
 
     message_text = _eval_if_lazy(message.message) or ''
 
     if no_:
         if no_ in message_text:
             msg = u'msg `%s` found in session flash.' % (no_,)
             pytest.fail(safe_str(msg))
     else:
         if msg not in message_text:
             fail_msg = u'msg `%s` not found in session ' \
                        u'flash: got `%s` (type:%s) instead' % (
                 msg, message_text, type(message_text))
 
             pytest.fail(safe_str(fail_msg))
         if category:
             assert category == message.category
 
 
 def _eval_if_lazy(value):
     return value.eval() if hasattr(value, 'eval') else value
 
 
 def no_newline_id_generator(test_name):
     """
     Generates a test name without spaces or newlines characters. Used for
     nicer output of progress of test
     """
     org_name = test_name
     test_name = safe_str(test_name)\
         .replace('\n', '_N') \
         .replace('\r', '_N') \
         .replace('\t', '_T') \
         .replace(' ', '_S')
 
     return test_name or 'test-with-empty-name'
+
+
+def route_path_generator(url_defs, name, params=None, **kwargs):
+    import urllib
+
+    base_url = url_defs[name].format(**kwargs)
+
+    if params:
+        base_url = '{}?{}'.format(base_url, urllib.urlencode(params))
+    return base_url