blob: d1e0c9714f6b1a5a1c105c2e9cb56732ec2f4046 [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
Shawn O. Pearced63bbf42009-04-21 08:05:27 -070040 dir = '/tmp'
41 if not os.path.exists(dir):
42 dir = tempfile.gettempdir()
Shawn O. Pearcefb231612009-04-10 18:53:46 -070043 _ssh_sock_path = os.path.join(
Shawn O. Pearced63bbf42009-04-21 08:05:27 -070044 tempfile.mkdtemp('', 'ssh-', 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(
91 map(lambda x: int(x),
92 ver_str[len('git version '):].strip().split('.')[0:3]
93 ))
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:
113 need = '.'.join(map(lambda x: str(x), min_version))
114 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
135 for e in [REPO_TRACE,
136 GIT_DIR,
137 'GIT_ALTERNATE_OBJECT_DIRECTORIES',
138 'GIT_OBJECT_DIRECTORY',
139 'GIT_WORK_TREE',
140 'GIT_GRAFT_FILE',
141 'GIT_INDEX_FILE']:
142 if e in env:
143 del env[e]
144
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())
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700150
151 if project:
152 if not cwd:
153 cwd = project.worktree
154 if not gitdir:
155 gitdir = project.gitdir
156
157 command = [GIT]
158 if bare:
159 if gitdir:
Shawn O. Pearcef18cb762010-12-07 11:41:05 -0800160 _setenv(env, GIT_DIR, gitdir)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700161 cwd = None
162 command.extend(cmdv)
163
164 if provide_stdin:
165 stdin = subprocess.PIPE
166 else:
167 stdin = None
168
169 if capture_stdout:
170 stdout = subprocess.PIPE
171 else:
172 stdout = None
173
174 if capture_stderr:
175 stderr = subprocess.PIPE
176 else:
177 stderr = None
178
Shawn O. Pearcead3193a2009-04-18 09:54:51 -0700179 if IsTrace():
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700180 global LAST_CWD
181 global LAST_GITDIR
182
183 dbg = ''
184
185 if cwd and LAST_CWD != cwd:
186 if LAST_GITDIR or LAST_CWD:
187 dbg += '\n'
188 dbg += ': cd %s\n' % cwd
189 LAST_CWD = cwd
190
191 if GIT_DIR in env and LAST_GITDIR != env[GIT_DIR]:
192 if LAST_GITDIR or LAST_CWD:
193 dbg += '\n'
194 dbg += ': export GIT_DIR=%s\n' % env[GIT_DIR]
195 LAST_GITDIR = env[GIT_DIR]
196
197 dbg += ': '
198 dbg += ' '.join(command)
199 if stdin == subprocess.PIPE:
200 dbg += ' 0<|'
201 if stdout == subprocess.PIPE:
202 dbg += ' 1>|'
203 if stderr == subprocess.PIPE:
204 dbg += ' 2>|'
Shawn O. Pearcead3193a2009-04-18 09:54:51 -0700205 Trace('%s', dbg)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700206
207 try:
208 p = subprocess.Popen(command,
209 cwd = cwd,
210 env = env,
211 stdin = stdin,
212 stdout = stdout,
213 stderr = stderr)
214 except Exception, e:
215 raise GitError('%s: %s' % (command[1], e))
216
Shawn O. Pearceca8c32c2010-05-11 18:21:33 -0700217 if ssh_proxy:
218 _add_ssh_client(p)
219
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700220 self.process = p
221 self.stdin = p.stdin
222
223 def Wait(self):
224 p = self.process
225
226 if p.stdin:
227 p.stdin.close()
228 self.stdin = None
229
230 if p.stdout:
231 self.stdout = p.stdout.read()
232 p.stdout.close()
233 else:
234 p.stdout = None
235
236 if p.stderr:
237 self.stderr = p.stderr.read()
238 p.stderr.close()
239 else:
240 p.stderr = None
241
Shawn O. Pearceca8c32c2010-05-11 18:21:33 -0700242 try:
243 rc = p.wait()
244 finally:
245 _remove_ssh_client(p)
246 return rc