add opengrok-mirror tunable to ignore a project (#4061)

Author: vladak

tools/src/main/python/opengrok_tools/utils/mirror.py

@@ -55,6 +55,7 @@
 PROXY_PROPERTY = 'proxy'
 INCOMING_PROPERTY = 'incoming_check'
 IGNORE_ERR_PROPERTY = 'ignore_errors'
+IGNORE_PROPERTY = 'ignore'
 COMMANDS_PROPERTY = 'commands'
 DISABLED_PROPERTY = 'disabled'
 DISABLED_REASON_PROPERTY = 'disabled-reason'
@@ -169,7 +170,7 @@ def get_project_properties(project_config, project_name, hookdir):
     :param project_name: name of the project
     :param hookdir: directory with hooks
     :return: list of properties: prehook, posthook, hook_timeout,
-    command_timeout, use_proxy, ignored_repos, check_changes, strip_outgoing, ignore_errors
+    command_timeout, use_proxy, ignored_repos, check_changes, strip_outgoing, ignore_errors, ignore
     """
 
     prehook = None
@@ -181,6 +182,7 @@ def get_project_properties(project_config, project_name, hookdir):
     check_changes = None
     strip_outgoing = None
     ignore_errors = None
+    ignore = None
 
     logger = logging.getLogger(__name__)
 
@@ -245,11 +247,17 @@ def get_project_properties(project_config, project_name, hookdir):
                                      project_config.get(IGNORE_ERR_PROPERTY))
             logger.debug("ignore errors = {}".format(check_changes))
 
+        if project_config.get(IGNORE_PROPERTY) is not None:
+            ignore = get_bool(logger, ("ignore project {}".
+                                       format(project_name)),
+                              project_config.get(IGNORE_PROPERTY))
+            logger.debug("project ignore = {}".format(check_changes))
+
     if not ignored_repos:
         ignored_repos = []
 
     return prehook, posthook, hook_timeout, command_timeout, \
-        use_proxy, ignored_repos, check_changes, strip_outgoing, ignore_errors
+        use_proxy, ignored_repos, check_changes, strip_outgoing, ignore_errors, ignore
 
 
 def process_hook(hook_ident, hook, source_root, project_name, proxy,
@@ -460,10 +468,10 @@ def mirror_project(config, project_name, check_changes, strip_outgoing, uri,
         ignored_repos, \
         check_changes_proj, \
         strip_outgoing_proj, \
-        ignore_errors_proj = get_project_properties(project_config,
-                                                    project_name,
-                                                    config.
-                                                    get(HOOKDIR_PROPERTY))
+        ignore_errors_proj, \
+        ignore = get_project_properties(project_config,
+                                        project_name,
+                                        config.get(HOOKDIR_PROPERTY))
 
     if not command_timeout:
         command_timeout = config.get(CMD_TIMEOUT_PROPERTY)
@@ -489,6 +497,10 @@ def mirror_project(config, project_name, check_changes, strip_outgoing, uri,
     if use_proxy:
         proxy = config.get(PROXY_PROPERTY)
 
+    if ignore:
+        logger.info(f"Project {project_name} ignored per configuration, no mirror performed.")
+        return SUCCESS_EXITVAL
+
     # We want this to be logged to the log file (if any).
     if project_config and project_config.get(DISABLED_PROPERTY):
         handle_disabled_project(config, project_name,

tools/src/test/python/test_mirror.py

@@ -48,7 +48,7 @@
     PROJECTS_PROPERTY, DISABLED_CMD_PROPERTY, DISABLED_PROPERTY, \
     CMD_TIMEOUT_PROPERTY, HOOK_TIMEOUT_PROPERTY, DISABLED_REASON_PROPERTY, \
     INCOMING_PROPERTY, IGNORE_ERR_PROPERTY, HOOK_PRE_PROPERTY, \
-    HOOKDIR_PROPERTY, HOOK_POST_PROPERTY, COMMANDS_PROPERTY
+    HOOKDIR_PROPERTY, HOOK_POST_PROPERTY, COMMANDS_PROPERTY, IGNORE_PROPERTY
 from opengrok_tools.utils.patterns import COMMAND_PROPERTY, PROJECT_SUBST, CALL_PROPERTY
 
 
@@ -377,6 +377,41 @@ def mock_get_repos(*args, **kwargs):
         unstub()
 
 
+def test_ignore_project():
+    """
+    Test that for ignored projects mirror_project() returns SUCCESS_EXITVAL
+    and does not perform any tasks.
+    """
+
+    project_name = "foo"
+    config = {
+        PROJECTS_PROPERTY: {
+            project_name: {IGNORE_PROPERTY: True}
+        }
+    }
+
+    spy2(opengrok_tools.utils.mirror.get_project_config)
+    spy2(opengrok_tools.utils.mirror.get_project_properties)
+    spy2(opengrok_tools.utils.mirror.get_repos_for_project)
+
+    src_root = "srcroot"
+    assert mirror_project(config, project_name, False, False,
+                          None, src_root) == SUCCESS_EXITVAL
+
+    verify(opengrok_tools.utils.mirror). \
+        get_project_config(ANY, project_name)
+    verify(opengrok_tools.utils.mirror). \
+        get_project_properties(ANY, project_name, ANY)
+    # Assumes that get_repos_for_project() is the first function to be called
+    # in mirror_project() after the project configuration is retrieved.
+    verify(opengrok_tools.utils.mirror, times=0). \
+        get_repos_for_project(project_name, ANY, ANY, ...)
+
+    # Necessary to disable the spies otherwise mockito will
+    # complain about recursive invocation.
+    unstub()
+
+
 def test_disabled_command_run_args():
     """
     Make sure that run_command() calls Command.execute().