add check for commands section of the mirror configuration

Author: Vladimir Kotal

tools/src/main/python/opengrok_tools/scm/repofactory.py

@@ -18,7 +18,7 @@
 #
 
 #
-# Copyright (c) 2018, 2020, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved.
 #
 # Portions Copyright 2020 Robert Williams
 
@@ -32,7 +32,10 @@
 from .svn import SubversionRepository
 from .teamware import TeamwareRepository
 
-logger = logging.getLogger(__name__)
+
+# Note: these have to correspond with get_repository().
+REPO_TYPES = ["mercurial", "hg", "teamware", "sccs", "cvs",
+              "svn", "subversion", "git", "perforce", "repo"]
 
 
 def get_repository(path, repo_type, project,
@@ -49,6 +52,8 @@ def get_repository(path, repo_type, project,
     or None if given repository type cannot be found.
     """
 
+    logger = logging.getLogger(__name__)
+
     repo_lower = repo_type.lower()
 
     logger.debug("Constructing repo object for path {}".format(path))

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

@@ -42,7 +42,7 @@
 from .command import Command
 from .restful import call_rest_api, do_api_call
 
-from ..scm.repofactory import get_repository
+from ..scm.repofactory import get_repository, REPO_TYPES
 from ..scm.repository import RepositoryException
 
 
@@ -574,6 +574,43 @@ def check_project_configuration(multiple_project_config, hookdir=False,
     return True
 
 
+def check_commands(commands):
+    """
+    Validate the commands section of the configuration that allows
+    to override files used for SCM synchronization and incoming check.
+    This should be simple dictionary of string values.
+    :return: True if valid, False otherwise
+    """
+
+    logger = logging.getLogger(__name__)
+
+    if commands is None:
+        return True
+
+    if type(commands) is not dict:
+        logger.error("commands sections is not a dictionary")
+        return False
+
+    for name, value in commands.items():
+        if type(value) is not str:
+            logger.error("value of {} is not string".format(name))
+            return False
+
+        if name not in REPO_TYPES:
+            logger.error("unknown repository type: {}".format(name))
+            return False
+
+        if not os.path.exists(value):
+            logger.error("path for {} does not exist: {}".format(name, value))
+            return False
+
+        if not os.path.isfile(value):
+            logger.error("path for {} is not a file: {}".format(name, value))
+            return False
+
+    return True
+
+
 def check_configuration(config):
     """
     Validate configuration
@@ -604,6 +641,9 @@ def check_configuration(config):
     if disabled_command:
         logger.debug("Disabled command: {}".format(disabled_command))
 
+    if not check_commands(config.get(COMMANDS_PROPERTY)):
+        return False
+
     if not check_project_configuration(config.get(PROJECTS_PROPERTY),
                                        config.get(HOOKDIR_PROPERTY),
                                        config.get(PROXY_PROPERTY)):

tools/src/test/python/test_mirror.py

@@ -47,7 +47,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
+    HOOKDIR_PROPERTY, HOOK_POST_PROPERTY, COMMANDS_PROPERTY
 from opengrok_tools.utils.patterns import COMMAND_PROPERTY, PROJECT_SUBST
 
 
@@ -97,6 +97,41 @@ def test_invalid_project_config_hooknames():
         assert not check_project_configuration(config, hookdir=tmpdir)
 
 
+def test_invalid_configuration_commands_dict():
+    """
+    The value of the commands property has to be a dictionary.
+    """
+    config = {COMMANDS_PROPERTY: "foo"}
+    assert not check_configuration(config)
+
+
+def test_invalid_configuration_commands_scm():
+    """
+    The names in the commands section should be match recognized SCMs.
+    """
+    config = {COMMANDS_PROPERTY: {"foo": "bar"}}
+    assert not check_configuration(config)
+
+
+def test_invalid_configuration_commands_value():
+    """
+    The values in the command section should be strings.
+    """
+    config = {COMMANDS_PROPERTY: {"git": {"foo": "bar"}}}
+    assert not check_configuration(config)
+
+
+def test_invalid_configuration_commands_exists():
+    config = {COMMANDS_PROPERTY: {"git": "/usr/nonexistent/bin/git"}}
+    assert not check_configuration(config)
+
+
+@posix_only
+def test_configuration_commands():
+    config = {COMMANDS_PROPERTY: {"git": "/usr/bin/git"}}
+    assert check_configuration(config)
+
+
 @posix_only
 def test_invalid_project_config_nonexec_hook():
     with tempfile.TemporaryDirectory() as tmpdir: