better command error logging

Author: Vladimir Kotal

tools/sync/command.py

@@ -277,3 +277,13 @@ def getstate(self):
 
     def getpid(self):
         return self.pid
+
+    def log_error(self, msg):
+        if self.state is Command.FINISHED:
+            self.logger.error("{}: command {} in directory {} exited with {}".
+                              format(msg, self.cmd, self.work_dir,
+                                     self.getretcode()))
+        else:
+            self.logger.error("{}: command {} in directory {} ended with "
+                              "invalid state".
+                              format(msg, self.cmd, self.work_dir, self.state))

tools/sync/cvs.py

@@ -47,8 +47,9 @@ def reposync(self):
         cmd.execute()
         self.logger.info(cmd.getoutputstr())
         if cmd.getretcode() != 0 or cmd.getstate() != Command.FINISHED:
-            self.logger.error("failed to perform update for {}".
-                              format(self.path))
+            self.logger.error("failed to perform update: command {}"
+                              "in directory {} exited with {}".
+                              format(hg_command, self.path, cmd.getretcode()))
             return 1
 
         return 0

tools/sync/git.py

@@ -47,8 +47,7 @@ def reposync(self):
         cmd.execute()
         self.logger.info(cmd.getoutputstr())
         if cmd.getretcode() != 0 or cmd.getstate() != Command.FINISHED:
-            self.logger.error("failed to perform pull for {}".
-                              format(self.path))
+            cmd.log_error("failed to perform pull")
             return 1
 
         return 0

tools/sync/mercurial.py

@@ -45,15 +45,18 @@ def get_branch(self):
         cmd = self.getCommand(hg_command, work_dir=self.path,
                               env_vars=self.env, logger=self.logger)
         cmd.execute()
-        if cmd.getstate() != Command.FINISHED:
-            self.logger.debug(cmd.getoutput())
-            self.logger.error("failed to get branch for {}".
-                              format(self.path))
+        self.logger.info(cmd.getoutputstr())
+        if cmd.getretcode() != 0 or cmd.getstate() != Command.FINISHED:
+            cmd.log_error("failed to get branch")
             return None
         else:
             if not cmd.getoutput():
+                self.logger.error("no output from {}".
+                                  format(hg_command))
                 return None
             if len(cmd.getoutput()) == 0:
+                self.logger.error("empty output from {}".
+                                  format(hg_command))
                 return None
             return cmd.getoutput()[0].strip()
 
@@ -75,8 +78,8 @@ def reposync(self):
         # 'hg incoming' will return 1 if there are no incoming changesets,
         # so do not check the return value.
         #
-        if cmd.getstate() != Command.FINISHED:
-            self.logger.error("failed to run 'hg incoming'")
+        if cmd.getretcode() != 0 or cmd.getstate() != Command.FINISHED:
+            cmd.log_error("failed to get incoming changesets")
             return 1
 
         hg_command = [self.command, "pull"]
@@ -88,7 +91,7 @@ def reposync(self):
         cmd.execute()
         self.logger.info(cmd.getoutputstr())
         if cmd.getretcode() != 0 or cmd.getstate() != Command.FINISHED:
-            self.logger.error("failed to perform pull")
+            cmd.log_error("failed to perform pull")
             return 1
 
         hg_command = [self.command, "update"]
@@ -101,7 +104,7 @@ def reposync(self):
         cmd.execute()
         self.logger.info(cmd.getoutputstr())
         if cmd.getretcode() != 0 or cmd.getstate() != Command.FINISHED:
-            self.logger.error("failed to perform pull and update")
+            cmd.log_error("failed to perform pull and update")
             return 1
 
         return 0

tools/sync/svn.py

@@ -72,8 +72,7 @@ def reposync(self):
         cmd.execute()
         self.logger.info(cmd.getoutputstr())
         if cmd.getretcode() != 0 or cmd.getstate() != Command.FINISHED:
-            self.logger.error("failed to perform update for {}".
-                              format(self.path))
+            cmd.log_error("failed to perform update")
             return 1
 
         return 0

tools/sync/teamware.py

@@ -74,8 +74,7 @@ def reposync(self):
         cmd.execute()
         self.logger.info(cmd.getoutputstr())
         if cmd.getretcode() != 0 or cmd.getstate() != Command.FINISHED:
-            self.logger.error("failed to perform bringover for {}".
-                              format(self.path))
+            cmd.log_error("failed to perform bringover")
             return 1
 
         return 0