svn-support: Fix tests for subversion support.

Pass authentication realm to render function instead of retrieving it inside.

rhodecode/svn_support/tests/test_mod_dav_svn_config.py

@@ -1,151 +1,97 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2016-2016  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 codecs
 import mock
+import pytest
 import re
-import shutil
-import tempfile
 
 from pyramid import testing
 
-from rhodecode.svn_support import config_keys, utils
+from rhodecode.svn_support import utils
 
 
 class TestModDavSvnConfig(object):
 
     @classmethod
     def setup_class(cls):
         # Make mako renderer available in tests.
         config = testing.setUp()
         config.include('pyramid_mako')
 
-        # Temporary directory holding the generated config files.
-        cls.tempdir = tempfile.mkdtemp(suffix='pytest-mod-dav-svn')
-
         cls.location_root = u'/location/root/çµäö'
         cls.parent_path_root = u'/parent/path/çµäö'
-        cls._dummy_realm = u'Dummy Realm (äöüçµ)'
+        cls.realm = u'Dummy Realm (äöüçµ)'
 
     @classmethod
-    def teardown_class(cls):
-        testing.tearDown()
-        shutil.rmtree(cls.tempdir, ignore_errors=True)
-
-    @classmethod
-    def get_settings(cls):
-        config_file_path = tempfile.mkstemp(
-            suffix='mod-dav-svn.conf', dir=cls.tempdir)[1]
-        return {
-            config_keys.config_file_path: config_file_path,
-            config_keys.location_root: cls.location_root,
-            config_keys.list_parent_path: True,
-        }
-
-    @classmethod
-    def get_repo_groups(cls, count=1):
+    def get_repo_group_mocks(cls, count=1):
         repo_groups = []
         for num in range(0, count):
             full_path = u'/path/to/RepöGröúp-°µ {}'.format(num)
             repo_group_mock = mock.MagicMock()
             repo_group_mock.full_path = full_path
             repo_group_mock.full_path_splitted = full_path.split('/')
             repo_groups.append(repo_group_mock)
         return repo_groups
 
     def assert_root_location_directive(self, config):
         pattern = u'<Location "{location}">'.format(
             location=self.location_root)
         assert len(re.findall(pattern, config)) == 1
 
     def assert_group_location_directive(self, config, group_path):
         pattern = u'<Location "{location}{group_path}">'.format(
             location=self.location_root, group_path=group_path)
         assert len(re.findall(pattern, config)) == 1
 
-    @mock.patch('rhodecode.svn_support.utils.get_rhodecode_realm')
-    @mock.patch('rhodecode.svn_support.utils.RepoGroup')
-    def test_generate_mod_dav_svn_config(self, RepoGroupMock, GetRealmMock):
-        # Setup mock objects.
-        GetRealmMock.return_value = self._dummy_realm
-        num_groups = 3
-        RepoGroupMock.get_all_repo_groups.return_value = self.get_repo_groups(
-            count=num_groups)
-
-        # Execute the method under test.
-        settings = self.get_settings()
-        utils.generate_mod_dav_svn_config(
-            settings=settings, parent_path_root=self.parent_path_root)
-
-        # Read generated file.
-        path = settings[config_keys.config_file_path]
-        with codecs.open(path, 'r', encoding='utf-8') as f:
-            content = f.read()
-
+    def test_render_mod_dav_svn_config(self):
+        repo_groups = self.get_repo_group_mocks(count=10)
+        generated_config = utils._render_mod_dav_svn_config(
+            parent_path_root=self.parent_path_root,
+            list_parent_path=True,
+            location_root=self.location_root,
+            repo_groups=repo_groups,
+            realm=self.realm
+        )
         # Assert that one location directive exists for each repository group.
-        for group in self.get_repo_groups(count=num_groups):
-            self.assert_group_location_directive(content, group.full_path)
+        for group in repo_groups:
+            self.assert_group_location_directive(
+                generated_config, group.full_path)
 
         # Assert that the root location directive exists.
-        self.assert_root_location_directive(content)
-
-    @mock.patch('rhodecode.svn_support.utils.get_rhodecode_realm')
-    @mock.patch('rhodecode.svn_support.utils.RepoGroup')
-    def test_list_parent_path_on(self, RepoGroupMock, GetRealmMock):
-        # Setup mock objects.
-        GetRealmMock.return_value = self._dummy_realm
-        RepoGroupMock.get_all_repo_groups.return_value = self.get_repo_groups()
-
-        # Execute the method under test.
-        settings = self.get_settings()
-        settings[config_keys.list_parent_path] = True
-        utils.generate_mod_dav_svn_config(
-            settings=settings, parent_path_root=self.parent_path_root)
-
-        # Read generated file.
-        path = settings[config_keys.config_file_path]
-        with codecs.open(path, 'r', encoding='utf-8') as f:
-            content = f.read()
+        self.assert_root_location_directive(generated_config)
 
-        # Make assertions.
-        assert not re.search('SVNListParentPath\s+Off', content)
-        assert re.search('SVNListParentPath\s+On', content)
-
-    @mock.patch('rhodecode.svn_support.utils.get_rhodecode_realm')
-    @mock.patch('rhodecode.svn_support.utils.RepoGroup')
-    def test_list_parent_path_off(self, RepoGroupMock, GetRealmMock):
-        # Setup mock objects.
-        GetRealmMock.return_value = self._dummy_realm
-        RepoGroupMock.get_all_repo_groups.return_value = self.get_repo_groups()
+    @pytest.mark.parametrize('list_parent_path', [True, False])
+    def test_list_parent_path(self, list_parent_path):
+        generated_config = utils._render_mod_dav_svn_config(
+            parent_path_root=self.parent_path_root,
+            list_parent_path=list_parent_path,
+            location_root=self.location_root,
+            repo_groups=self.get_repo_group_mocks(count=10),
+            realm=self.realm
+        )
 
-        # Execute the method under test.
-        settings = self.get_settings()
-        settings[config_keys.list_parent_path] = False
-        utils.generate_mod_dav_svn_config(
-            settings=settings, parent_path_root=self.parent_path_root)
-
-        # Read generated file.
-        with open(settings[config_keys.config_file_path], 'r') as file_:
-            content = file_.read()
-
-        # Make assertions.
-        assert re.search('SVNListParentPath\s+Off', content)
-        assert not re.search('SVNListParentPath\s+On', content)
+        # Assert that correct configuration directive is present.
+        if list_parent_path:
+            assert not re.search('SVNListParentPath\s+Off', generated_config)
+            assert re.search('SVNListParentPath\s+On', generated_config)
+        else:
+            assert re.search('SVNListParentPath\s+Off', generated_config)
+            assert not re.search('SVNListParentPath\s+On', generated_config)

rhodecode/svn_support/utils.py

@@ -1,86 +1,87 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2016-2016  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 codecs
 import logging
 import os
 from pyramid.renderers import render
 
 from rhodecode.events import trigger
 from rhodecode.lib.utils import get_rhodecode_realm, get_rhodecode_base_path
 from rhodecode.model.db import RepoGroup
 
 from . import config_keys
 from .events import ModDavSvnConfigChange
 
 
 log = logging.getLogger(__name__)
 
 
 def generate_mod_dav_svn_config(registry):
     """
     Generate the configuration file for use with subversion's mod_dav_svn
     module. The configuration has to contain a <Location> block for each
     available repository group because the mod_dav_svn module does not support
     repositories organized in sub folders.
     """
     settings = registry.settings
     config = _render_mod_dav_svn_config(
         parent_path_root=get_rhodecode_base_path(),
         list_parent_path=settings[config_keys.list_parent_path],
         location_root=settings[config_keys.location_root],
-        repo_groups=RepoGroup.get_all_repo_groups())
+        repo_groups=RepoGroup.get_all_repo_groups(),
+        realm=get_rhodecode_realm())
     _write_mod_dav_svn_config(config, settings[config_keys.config_file_path])
 
     # Trigger an event on mod dav svn configuration change.
     trigger(ModDavSvnConfigChange(), registry)
 
 
 def _render_mod_dav_svn_config(
-        parent_path_root, list_parent_path, location_root, repo_groups):
+        parent_path_root, list_parent_path, location_root, repo_groups, realm):
     """
     Render mod_dav_svn configuration to string.
     """
     repo_group_paths = []
     for repo_group in repo_groups:
         group_path = repo_group.full_path_splitted
         location = os.path.join(location_root, *group_path)
         parent_path = os.path.join(parent_path_root, *group_path)
         repo_group_paths.append((location, parent_path))
 
     context = {
         'location_root': location_root,
         'parent_path_root': parent_path_root,
         'repo_group_paths': repo_group_paths,
         'svn_list_parent_path': list_parent_path,
-        'rhodecode_realm': get_rhodecode_realm(),
+        'rhodecode_realm': realm,
     }
 
     # Render the configuration template to string.
     template = 'rhodecode:svn_support/templates/mod-dav-svn.conf.mako'
     return render(template, context)
 
 
 def _write_mod_dav_svn_config(config, filepath):
     """
     Write mod_dav_svn config to file.
     """
     with codecs.open(filepath, 'w', encoding='utf-8') as f:
         f.write(config)