# HG changeset patch
# User Martin Bornhold <martin@rhodecode.com>
# Date 2016-07-12 17:30:37
# Node ID e4f441e2bc6940163e319713f6a8b753db3398f5
# Parent  952323194497e16615912b8366f2ea22f62837d7

tests: Skip test for Pyro4 connection and added doc strings.

diff --git a/rhodecode/tests/vcs/test_hg_vcsserver_cache_invalidation.py b/rhodecode/tests/vcs/test_hg_vcsserver_cache_invalidation.py
--- a/rhodecode/tests/vcs/test_hg_vcsserver_cache_invalidation.py
+++ b/rhodecode/tests/vcs/test_hg_vcsserver_cache_invalidation.py
@@ -26,7 +26,18 @@ from rhodecode.lib.vcs.backends.base imp
 
 
 class TestMercurialRemoteRepoInvalidation(object):
+    """
+    If the VCSServer is running with multiple processes or/and instances.
+    Operations on repositories are potentially handled by different processes
+    in a random fashion. The mercurial repository objects used in the VCSServer
+    are caching the commits of the repo. Therefore we have to invalidate the
+    VCSServer caching of these objects after a writing operation.
+    """
+
+    # Default reference used as a dummy during tests.
     default_ref = Reference('branch', 'default', None)
+
+    # Methods of vcsserver.hg.HgRemote that are "writing" operations.
     writing_methods = [
         'bookmark',
         'commit',
@@ -103,9 +114,18 @@ class TestMercurialRemoteRepoInvalidatio
         return shadow_repo, source_ref, target_ref
 
     @pytest.mark.backends('hg')
-    def test_commit_does_not_exist_error_happens(self, pr_util):
+    def test_commit_does_not_exist_error_happens(self, pr_util, pylonsapp):
+        """
+        This test is somewhat special. It does not really test the system
+        instead it is more or less a precondition for the
+        "test_commit_does_not_exist_error_does_not_happen". It deactivates the
+        cache invalidation and asserts that the error occurs.
+        """
         from rhodecode.lib.vcs.exceptions import CommitDoesNotExistError
 
+        if pylonsapp.config['vcs.server.protocol'] != 'http':
+            pytest.skip('Test is intended for the HTTP protocol only.')
+
         pull_request = pr_util.create_pull_request()
         target_vcs = pull_request.target_repo.scm_instance()
         source_vcs = pull_request.source_repo.scm_instance()
@@ -135,7 +155,17 @@ class TestMercurialRemoteRepoInvalidatio
             shadow_repo.get_commit(source_ref.commit_id)
 
     @pytest.mark.backends('hg')
-    def test_commit_does_not_exist_error_does_not_happen(self, pr_util):
+    def test_commit_does_not_exist_error_does_not_happen(
+            self, pr_util, pylonsapp):
+        """
+        This test simulates a pull request merge in which the pull operations
+        are handled by a different VCSServer process than all other operations.
+        Without correct cache invalidation this leads to an error when
+        retrieving the pulled commits afterwards.
+        """
+        if pylonsapp.config['vcs.server.protocol'] != 'http':
+            pytest.skip('Test is intended for the HTTP protocol only.')
+
         pull_request = pr_util.create_pull_request()
         target_vcs = pull_request.target_repo.scm_instance()
         source_vcs = pull_request.source_repo.scm_instance()