blob: e5e28f3c350402ab7bda0f533272f738e977f72c [file] [log] [blame]
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -07001#
2# Copyright (C) 2008 The Android Open Source Project
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15
16import os
17import sys
18import subprocess
Shawn O. Pearcefb231612009-04-10 18:53:46 -070019import tempfile
Shawn O. Pearceca8c32c2010-05-11 18:21:33 -070020from signal import SIGTERM
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070021from error import GitError
Shawn O. Pearcead3193a2009-04-18 09:54:51 -070022from trace import REPO_TRACE, IsTrace, Trace
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070023
24GIT = 'git'
25MIN_GIT_VERSION = (1, 5, 4)
26GIT_DIR = 'GIT_DIR'
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070027
28LAST_GITDIR = None
29LAST_CWD = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070030
Shawn O. Pearcefb231612009-04-10 18:53:46 -070031_ssh_proxy_path = None
32_ssh_sock_path = None
Shawn O. Pearceca8c32c2010-05-11 18:21:33 -070033_ssh_clients = []
Shawn O. Pearcefb231612009-04-10 18:53:46 -070034
Nico Sallembien1c85f4e2010-04-27 14:35:27 -070035def ssh_sock(create=True):
Shawn O. Pearcefb231612009-04-10 18:53:46 -070036 global _ssh_sock_path
37 if _ssh_sock_path is None:
38 if not create:
39 return None
Mickaël Salaün2f6ab7f2012-09-30 00:37:55 +020040 tmp_dir = '/tmp'
41 if not os.path.exists(tmp_dir):
42 tmp_dir = tempfile.gettempdir()
Shawn O. Pearcefb231612009-04-10 18:53:46 -070043 _ssh_sock_path = os.path.join(
Mickaël Salaün2f6ab7f2012-09-30 00:37:55 +020044 tempfile.mkdtemp('', 'ssh-', tmp_dir),
Shawn O. Pearcefb231612009-04-10 18:53:46 -070045 'master-%r@%h:%p')
46 return _ssh_sock_path
47
48def _ssh_proxy():
49 global _ssh_proxy_path
50 if _ssh_proxy_path is None:
51 _ssh_proxy_path = os.path.join(
52 os.path.dirname(__file__),
53 'git_ssh')
54 return _ssh_proxy_path
55
Shawn O. Pearceca8c32c2010-05-11 18:21:33 -070056def _add_ssh_client(p):
57 _ssh_clients.append(p)
58
59def _remove_ssh_client(p):
60 try:
61 _ssh_clients.remove(p)
62 except ValueError:
63 pass
64
65def terminate_ssh_clients():
66 global _ssh_clients
67 for p in _ssh_clients:
68 try:
69 os.kill(p.pid, SIGTERM)
70 p.wait()
71 except OSError:
72 pass
73 _ssh_clients = []
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070074
Shawn O. Pearce334851e2011-09-19 08:05:31 -070075_git_version = None
76
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070077class _GitCall(object):
78 def version(self):
79 p = GitCommand(None, ['--version'], capture_stdout=True)
80 if p.Wait() == 0:
81 return p.stdout
82 return None
83
Shawn O. Pearce334851e2011-09-19 08:05:31 -070084 def version_tuple(self):
85 global _git_version
86
87 if _git_version is None:
88 ver_str = git.version()
89 if ver_str.startswith('git version '):
90 _git_version = tuple(
David Pursehouse7e6dd2d2012-10-25 12:40:51 +090091 map(int,
Chad Jones2bc7f5c2012-06-28 13:12:13 -070092 ver_str[len('git version '):].strip().split('-')[0].split('.')[0:3]
Shawn O. Pearce334851e2011-09-19 08:05:31 -070093 ))
94 else:
95 print >>sys.stderr, 'fatal: "%s" unsupported' % ver_str
96 sys.exit(1)
97 return _git_version
98
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070099 def __getattr__(self, name):
100 name = name.replace('_','-')
101 def fun(*cmdv):
102 command = [name]
103 command.extend(cmdv)
104 return GitCommand(None, command).Wait() == 0
105 return fun
106git = _GitCall()
107
Shawn O. Pearce2ec00b92009-06-12 09:32:50 -0700108def git_require(min_version, fail=False):
Shawn O. Pearce334851e2011-09-19 08:05:31 -0700109 git_version = git.version_tuple()
110 if min_version <= git_version:
Shawn O. Pearce2ec00b92009-06-12 09:32:50 -0700111 return True
112 if fail:
David Pursehouse7e6dd2d2012-10-25 12:40:51 +0900113 need = '.'.join(map(str, min_version))
Shawn O. Pearce2ec00b92009-06-12 09:32:50 -0700114 print >>sys.stderr, 'fatal: git %s or later required' % need
115 sys.exit(1)
116 return False
117
Shawn O. Pearcef18cb762010-12-07 11:41:05 -0800118def _setenv(env, name, value):
119 env[name] = value.encode()
120
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700121class GitCommand(object):
122 def __init__(self,
123 project,
124 cmdv,
125 bare = False,
126 provide_stdin = False,
127 capture_stdout = False,
128 capture_stderr = False,
129 disable_editor = False,
Shawn O. Pearcefb231612009-04-10 18:53:46 -0700130 ssh_proxy = False,
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700131 cwd = None,
132 gitdir = None):
Shawn O. Pearce727ee982010-12-07 08:46:14 -0800133 env = os.environ.copy()
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700134
David Pursehouse1d947b32012-10-25 12:23:11 +0900135 for key in [REPO_TRACE,
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700136 GIT_DIR,
137 'GIT_ALTERNATE_OBJECT_DIRECTORIES',
138 'GIT_OBJECT_DIRECTORY',
139 'GIT_WORK_TREE',
140 'GIT_GRAFT_FILE',
141 'GIT_INDEX_FILE']:
David Pursehouse1d947b32012-10-25 12:23:11 +0900142 if key in env:
143 del env[key]
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700144
145 if disable_editor:
Shawn O. Pearcef18cb762010-12-07 11:41:05 -0800146 _setenv(env, 'GIT_EDITOR', ':')
Shawn O. Pearcefb231612009-04-10 18:53:46 -0700147 if ssh_proxy:
Shawn O. Pearcef18cb762010-12-07 11:41:05 -0800148 _setenv(env, 'REPO_SSH_SOCK', ssh_sock())
149 _setenv(env, 'GIT_SSH', _ssh_proxy())
Shawn O. Pearce62d0b102012-06-05 15:11:15 -0700150 if 'http_proxy' in env and 'darwin' == sys.platform:
Shawn O. Pearce337aee02012-06-13 10:40:46 -0700151 s = "'http.proxy=%s'" % (env['http_proxy'],)
Shawn O. Pearce62d0b102012-06-05 15:11:15 -0700152 p = env.get('GIT_CONFIG_PARAMETERS')
153 if p is not None:
154 s = p + ' ' + s
155 _setenv(env, 'GIT_CONFIG_PARAMETERS', s)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700156
157 if project:
158 if not cwd:
159 cwd = project.worktree
160 if not gitdir:
161 gitdir = project.gitdir
162
163 command = [GIT]
164 if bare:
165 if gitdir:
Shawn O. Pearcef18cb762010-12-07 11:41:05 -0800166 _setenv(env, GIT_DIR, gitdir)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700167 cwd = None
168 command.extend(cmdv)
169
170 if provide_stdin:
171 stdin = subprocess.PIPE
172 else:
173 stdin = None
174
175 if capture_stdout:
176 stdout = subprocess.PIPE
177 else:
178 stdout = None
179
180 if capture_stderr:
181 stderr = subprocess.PIPE
182 else:
183 stderr = None
184
Shawn O. Pearcead3193a2009-04-18 09:54:51 -0700185 if IsTrace():
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700186 global LAST_CWD
187 global LAST_GITDIR
188
189 dbg = ''
190
191 if cwd and LAST_CWD != cwd:
192 if LAST_GITDIR or LAST_CWD:
193 dbg += '\n'
194 dbg += ': cd %s\n' % cwd
195 LAST_CWD = cwd
196
197 if GIT_DIR in env and LAST_GITDIR != env[GIT_DIR]:
198 if LAST_GITDIR or LAST_CWD:
199 dbg += '\n'
200 dbg += ': export GIT_DIR=%s\n' % env[GIT_DIR]
201 LAST_GITDIR = env[GIT_DIR]
202
203 dbg += ': '
204 dbg += ' '.join(command)
205 if stdin == subprocess.PIPE:
206 dbg += ' 0<|'
207 if stdout == subprocess.PIPE:
208 dbg += ' 1>|'
209 if stderr == subprocess.PIPE:
210 dbg += ' 2>|'
Shawn O. Pearcead3193a2009-04-18 09:54:51 -0700211 Trace('%s', dbg)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700212
213 try:
214 p = subprocess.Popen(command,
215 cwd = cwd,
216 env = env,
217 stdin = stdin,
218 stdout = stdout,
219 stderr = stderr)
Sarah Owensa5be53f2012-09-09 15:37:57 -0700220 except Exception as e:
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700221 raise GitError('%s: %s' % (command[1], e))
222
Shawn O. Pearceca8c32c2010-05-11 18:21:33 -0700223 if ssh_proxy:
224 _add_ssh_client(p)
225
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700226 self.process = p
227 self.stdin = p.stdin
228
229 def Wait(self):
Shawn O. Pearceca8c32c2010-05-11 18:21:33 -0700230 try:
Ulrik Sjölin498fe902011-09-11 22:59:37 +0200231 p = self.process
232 (self.stdout, self.stderr) = p.communicate()
233 rc = p.returncode
Shawn O. Pearceca8c32c2010-05-11 18:21:33 -0700234 finally:
235 _remove_ssh_client(p)
236 return rc