use __str__ of the Command class for logging consistently (#2999)

fixes #2991

Also fix transposition bug in commandsequence#run() logging

Author: Vladimir Kotal

opengrok-tools/src/main/python/opengrok_tools/utils/command.py

@@ -240,7 +240,7 @@ def close(self):
                 self.logger.debug("working directory = {}".format(os.getcwd()))
             except PermissionError:
                 pass
-            self.logger.debug("command = {}".format(self.cmd))
+            self.logger.debug("command = '{}'".format(self))
             my_args = {'stderr': stderr_dest,
                        'stdout': output_thread}
             if self.env_vars:
@@ -286,7 +286,7 @@ def close(self):
         else:
             self.state = Command.FINISHED
             self.returncode = int(p.returncode)
-            self.logger.debug("{} -> {}".format(self.cmd, self.getretcode()))
+            self.logger.debug("'{}' -> {}".format(self, self.getretcode()))
         finally:
             if self.timeout != 0 and timeout_thread:
                 with time_condition:
@@ -307,8 +307,8 @@ def close(self):
                 self.err = stderr_thread.getoutput()
 
             elapsed_time = time.time() - start_time
-            self.logger.debug("Command {} took {} seconds".
-                              format(self.cmd, int(elapsed_time)))
+            self.logger.debug("Command '{}' took {} seconds".
+                              format(self, int(elapsed_time)))
 
         if orig_work_dir:
             try:

opengrok-tools/src/main/python/opengrok_tools/utils/commandsequence.py

@@ -83,16 +83,10 @@ def __init__(self, base):
         self.logger = logging.getLogger(__name__)
         self.logger.setLevel(base.loglevel)
 
-    def run_command(self, command):
+    def run_command(self, cmd):
         """
         Execute a command and return its return code.
         """
-        command_args = command.get(COMMAND_PROPERTY)
-        cmd = Command(command_args,
-                      env_vars=command.get("env"),
-                      resource_limits=command.get("limits"),
-                      args_subst={PROJECT_SUBST: self.name},
-                      args_append=[self.name], excl_subst=True)
         cmd.execute()
         self.retcodes[str(cmd)] = cmd.getretcode()
         self.outputs[str(cmd)] = cmd.getoutput()
@@ -119,6 +113,12 @@ def run(self):
             if is_web_uri(command.get(COMMAND_PROPERTY)[0]):
                 call_rest_api(command, PROJECT_SUBST, self.name)
             else:
+                command_args = command.get(COMMAND_PROPERTY)
+                command = Command(command_args,
+                                  env_vars=command.get("env"),
+                                  resource_limits=command.get("limits"),
+                                  args_subst={PROJECT_SUBST: self.name},
+                                  args_append=[self.name], excl_subst=True)
                 retcode = self.run_command(command)
 
                 # If a command exits with non-zero return code,
@@ -128,14 +128,14 @@ def run(self):
                         if not self.driveon:
                             self.logger.debug("command '{}' for project {} "
                                               "requested break".
-                                              format(self.name, command))
+                                              format(command, self.name))
                             self.run_cleanup()
                         else:
                             self.logger.debug("command '{}' for project {} "
                                               "requested break however "
                                               "the 'driveon' option is set "
                                               "so driving on.".
-                                              format(self.name, command))
+                                              format(command, self.name))
                             continue
                     else:
                         self.logger.error("command '{}' for project {} failed "
@@ -182,7 +182,7 @@ def check(self, ignore_errors):
         self.logger.debug("Output for project '{}':".format(self.name))
         for cmd in self.outputs.keys():
             if self.outputs[cmd] and len(self.outputs[cmd]) > 0:
-                self.logger.debug("{}: {}".
+                self.logger.debug("'{}': {}".
                                   format(cmd, self.outputs[cmd]))
 
         if self.name in ignore_errors: