Merge pull request #354 from dpursehouse/execute-timeout

Include 'timeout' parameter in Git execute

Author: Byron

git/cmd.py

@@ -14,6 +14,7 @@
 importmmap
 
 fromcontextlibimportcontextmanager
+fromsignalimportSIGKILL
 fromsubprocessimport (
 call,
 Popen,
@@ -41,7 +42,7 @@
 
 execute_kwargs= ('istream', 'with_keep_cwd', 'with_extended_output',
 'with_exceptions', 'as_process', 'stdout_as_string',
-'output_stream', 'with_stdout')
+'output_stream', 'with_stdout', 'kill_after_timeout')
 
 log=logging.getLogger('git.cmd')
 log.addHandler(logging.NullHandler())
@@ -476,6 +477,7 @@ def execute(self, command,
 as_process=False,
 output_stream=None,
 stdout_as_string=True,
+kill_after_timeout=None,
 with_stdout=True,
 **subprocess_kwargs
  ):
@@ -532,6 +534,16 @@ def execute(self, command,
 
  :param with_stdout: If True, default True, we open stdout on the created process
 
+ :param kill_after_timeout:
+ To specify a timeout in seconds for the git command, after which the process
+ should be killed. This will have no effect if as_process is set to True. It is
+ set to None by default and will let the process run until the timeout is
+ explicitly specified. This feature is not supported on Windows. It's also worth
+ noting that kill_after_timeout uses SIGKILL, which can have negative side
+ effects on a repository. For example, stale locks in case of git gc could
+ render the repository incapable of accepting changes until the lock is manually
+ removed.
+
  :return:
  * str(output) if extended_output = False (Default)
  * tuple(int(status), str(stdout), str(stderr)) if extended_output = True
@@ -569,6 +581,8 @@ def execute(self, command,
 
 ifsys.platform=='win32':
 cmd_not_found_exception=WindowsError
+ifkill_after_timeout:
+raiseGitCommandError('"kill_after_timeout" feature is not supported on Windows.')
 else:
 ifsys.version_info[0] >2:
 cmd_not_found_exception=FileNotFoundError# NOQA # this is defined, but flake8 doesn't know
@@ -593,13 +607,48 @@ def execute(self, command,
 ifas_process:
 returnself.AutoInterrupt(proc, command)
 
+def_kill_process(pid):
+""" Callback method to kill a process. """
+p=Popen(['ps', '--ppid', str(pid)], stdout=PIPE)
+child_pids= []
+forlineinp.stdout:
+iflen(line.split()) >0:
+local_pid= (line.split())[0]
+iflocal_pid.isdigit():
+child_pids.append(int(local_pid))
+try:
+os.kill(pid, SIGKILL)
+forchild_pidinchild_pids:
+try:
+os.kill(child_pid, SIGKILL)
+exceptOSError:
+pass
+kill_check.set() # tell the main routine that the process was killed
+exceptOSError:
+# It is possible that the process gets completed in the duration after timeout
+# happens and before we try to kill the process.
+pass
+return
+# end
+
+ifkill_after_timeout:
+kill_check=threading.Event()
+watchdog=threading.Timer(kill_after_timeout, _kill_process, args=(proc.pid, ))
+
 # Wait for the process to return
 status=0
 stdout_value=b''
 stderr_value=b''
 try:
 ifoutput_streamisNone:
+ifkill_after_timeout:
+watchdog.start()
 stdout_value, stderr_value=proc.communicate()
+ifkill_after_timeout:
+watchdog.cancel()
+ifkill_check.isSet():
+stderr_value='Timeout: the command "%s" did not complete in %d ' \
+'secs.'% (" ".join(command), kill_after_timeout)
 # strip trailing "\n"
 ifstdout_value.endswith(b"\n"):
 stdout_value=stdout_value[:-1]