-
Notifications
You must be signed in to change notification settings - Fork 3
/
ZanataFunctions.py
executable file
·469 lines (389 loc) · 14.8 KB
/
ZanataFunctions.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
#!/usr/bin/env python
"""Generic Helper Function"""
from __future__ import (absolute_import, division, print_function)
import codecs
import errno
import logging
import os
import re
import subprocess # nosec
import sys
import urllib2 # noqa: F401 # pylint: disable=import-error
import urlparse # noqa: F401 # pylint: disable=import-error
from contextlib import contextmanager
from distutils.version import LooseVersion
from ZanataArgParser import ZanataArgParser # pylint: disable=import-error
try:
from typing import List, Any # noqa: F401 # pylint: disable=unused-import
except ImportError:
sys.stderr.write("python typing module is not installed" + os.linesep)
SCRIPT_DIR = os.path.dirname(os.path.realpath(__file__))
ZANATA_ENV_FILE = os.path.join(SCRIPT_DIR, 'zanata-env.sh')
BASH_CMD = '/bin/bash'
def read_env(filename):
# type (str) -> dict
"""Read environment variables by sourcing a bash file
Args:
filename (str): Bash file to be read
Returns:
[dict]: Dict whose key is environment variable name,
and value is variable value.
Examples:
>>> read_env('zanata-env.sh')['EXIT_OK']
u'0'
"""
proc = subprocess.Popen( # nosec
[BASH_CMD, '-c',
"source %s && set -o posix && set" % (filename)],
stdout=subprocess.PIPE)
return {kv[0]: kv[1] for kv in [
u.strip().split('=', 1)
for u in codecs.getreader('utf8')(proc.stdout).readlines()
if '=' in u]}
ZANATA_ENV = read_env(ZANATA_ENV_FILE)
if 'WORK_ROOT' in os.environ:
WORK_ROOT = str(os.environ.get('WORK_ROOT'))
elif ZANATA_ENV['WORK_ROOT']:
WORK_ROOT = str(ZANATA_ENV['WORK_ROOT'])
else:
WORK_ROOT = os.getcwd()
class CLIException(Exception):
"""Exception from command line"""
def __init__(self, msg, level='ERROR'):
super(CLIException, self).__init__(type(self))
self.msg = "[%s] %s" % (level, msg)
def __str__(self):
return self.msg
def __unicode__(self):
return self.msg
class GitHelper(object):
"""Git Helper functions"""
GIT_CMD = '/usr/bin/git'
def __init__(
self, user=None, token=None,
url='https://github.com/zanata/zanata-platform.git',
remote='origin'):
# type: (str, str, str, str) -> None
self.user = user
self.token = token
parsed = urlparse.urlsplit(url)
data = list(parsed)
# replace if user is specify
if user:
userrec = user
if token:
userrec += ":" + token
netloc = "%s@%s" % (userrec, parsed.hostname)
data[1] = netloc
self.url = url
self.auth_url = urlparse.urlunparse(data)
self.remote = remote
@classmethod
def init_from_parsed_args(cls, args):
"""Init from command line arguments"""
kwargs = {}
for k in ['user', 'token', 'url', 'remote']:
if hasattr(args, k):
kwargs[k] = getattr(args, k)
return cls(**kwargs)
@staticmethod
def git_check_output(arg_list, **kwargs):
"""Run git command and return stdout as string
This is just a wrapper of subprocess.check_output()
Arguments:
arg_list {LIST[str]} -- git argument lists.
Keyword Arguments:
kwarg {Namespace} -- keyword args for subprocess.check_output
Returns:
str -- stdout output
"""
cmd_list = [GitHelper.GIT_CMD] + arg_list
logging.debug("Running command: %s", " ".join(cmd_list))
return subprocess.check_output(cmd_list, **kwargs).rstrip()
@staticmethod
def branch_get_current():
# type () -> str
"""Return current branch name, or HEAD when detach."""
return GitHelper.git_check_output([
'rev-parse', '--abbrev-ref', 'HEAD'])
def branch_forced_pull(self, branch=None, remote=None):
# type (str, str, str) -> None
"""Withdraw local changes and pull the remote,
which, by default, is self.remote or 'origin'
Note that function does nothing to a detached HEAD"""
if not branch:
branch = self.branch_get_current()
if branch == 'HEAD':
return None
if not remote:
remote = self.remote if self.remote else 'origin'
msg = self.git_check_output(
['fetch', remote, branch])
logging.info(msg)
msg = self.git_check_output([
'reset', '--hard',
"{}/{}".format(remote, branch)])
logging.info(msg)
@staticmethod
def detect_remote_repo_latest_version(
tag_prefix='', remote_repo='.'):
# type (str, str) -> str
"""Get the latest version from remote repo without clone the whole repo
Known Bug: "latest version" does not mean version of latest tag,
but just the biggest version.
For example, if you tag v2.0, then tag v1.8.
The returned verion will be v2.0
Keyword Arguments:
tag_prefix {str} -- prefix of a tag to be strip (default: {''})
remote_repo {str} -- the remote git repo, can be URL, repo name,
'.' for local repository,
or None to use the self.url (default: {None})
Returns:
str -- the latest version
"""
lines = GitHelper.git_check_output([
'ls-remote', '--tags', remote_repo,
'refs/tags/%s*[^^{{}}]' % tag_prefix]).strip().split('\n')
index = len('refs/tags/%s' % tag_prefix)
versions = version_sort([l.split()[1][index:] for l in lines], True)
return versions[0]
class HTTPBasicAuthHandler(urllib2.HTTPBasicAuthHandler):
"""Handle Basic Authentication"""
def http_error_401( # pylint: disable=too-many-arguments,unused-argument
self, req, fp, code, msg, headers):
"""retry with basic auth when facing a 401"""
host = req.get_host()
realm = None
return self.retry_http_basic_auth(host, req, realm)
def http_error_403( # pylint: disable=too-many-arguments,unused-argument
self, req, fp, code, msg, hdrs):
"""retry with basic auth when facing a 403"""
host = req.get_host()
realm = None
return self.retry_http_basic_auth(host, req, realm)
class SshHost(object):
"""SSH/SCP helper functions"""
SCP_CMD = '/usr/bin/scp'
SSH_CMD = '/usr/bin/ssh'
RSYNC_CMD = '/usr/bin/rsync'
RSYNC_OPTIONS = [
'--cvs-exclude', '--recursive', '--verbose', '--links',
'--update', '--compress', '--exclude', '*.core', '--stats',
'--progress', '--archive', '--keep-dirlinks']
def __init__(self, host, ssh_user=None, identity_file=None):
# type (str, str, str) -> None
self.host = host
self.ssh_user = ssh_user
self.identity_file = identity_file
if self.identity_file:
self.opt_list = ['-i', identity_file]
else:
self.opt_list = []
# Produce [user@]hostname
self.user_host = "%s%s" % (
'' if not self.ssh_user else self.ssh_user + '@', self.host)
@classmethod
def add_parser(cls, arg_parser=None):
# type (ZanataArgParser) -> ZanataArgParser
"""Add SshHost parameters to a parser"""
if not arg_parser:
arg_parser = ZanataArgParser(
description=cls.__doc__)
arg_parser.add_common_argument(
'-u', '--ssh-user', type=str,
help='Connect SSH/SCP as this user')
arg_parser.add_common_argument(
'-i', '--identity-file', type=str,
help='SSH/SCP ident-files')
arg_parser.add_common_argument(
'host', type=str,
help='host name')
return arg_parser
@classmethod
def init_from_parsed_args(cls, args):
"""Init from command line arguments"""
kwargs = {'host': args.host}
for k in ['ssh_user', 'identity_file']:
if hasattr(args, k):
kwargs[k] = getattr(args, k)
return cls(**kwargs)
def _run_check(self, command, sudo):
# type (str, bool) -> List[str]
"""Return cmd_list"""
cmd_list = [SshHost.SSH_CMD]
cmd_list += self.opt_list
cmd_list += [self.user_host]
cmd_list += [('sudo ' if sudo else '') + command]
logging.debug(' '.join(cmd_list))
return cmd_list
def run_check_call(self, command, sudo=False):
# type (str, bool) -> None
"""Run command though ssh"""
cmd_list = self._run_check(command, sudo)
subprocess.check_call(cmd_list) # nosec
def run_check_output(self, command, sudo=False):
# type (str, bool) -> str
"""Run command though ssh, return stdout"""
cmd_list = self._run_check(command, sudo)
return subprocess.check_output(cmd_list) # nosec
def run_chown(self, user, group, filename, options=None):
# type (str, bool) -> None
"""Run command though ssh"""
self.run_check_call(
"chown %s %s:%s %s" % (
'' if not options else ' '.join(options),
user, group, filename),
True)
def scp_to_host(
self, source_path, dest_path,
sudo=False, rm_old=False):
# type (str, str, bool, bool) -> None
"""scp to host"""
if rm_old:
self.run_check_call(
"rm -fr %s" % dest_path, sudo)
cmd_list = ['scp', '-p'] + self.opt_list + [
source_path,
"%s:%s" % (self.user_host, dest_path)]
logging.debug(' '.join(cmd_list))
subprocess.check_call(cmd_list) # nosec
def rsync(self, src, dest, options=None):
# type (str, str, List[Str]) -> None
"""Run rsync
Args:
src (str): src file/dir in rsync
dest (str): src file/dir in rsync
options (List[str], optional): Defaults to None.
List of rsync options.
"""
cmd_prefix = [SshHost.RSYNC_CMD] + SshHost.RSYNC_OPTIONS
if self.ssh_user:
ssh_cmd = "ssh -l {} {} {}".format(
self.ssh_user,
"" if not self.identity_file else "-i",
"" if not self.identity_file else self.identity_file)
cmd_prefix += ["-e", ssh_cmd]
if options:
cmd_prefix += options
full_cmd = cmd_prefix + [src, dest]
logging.debug(" ".join(full_cmd))
subprocess.check_call(full_cmd)
class UrlHelper(object):
"""URL helper functions"""
def __init__(self, base_url, user, token):
"""install the authentication handler."""
self.base_url = base_url
auth_handler = HTTPBasicAuthHandler()
auth_handler.add_password(
realm=None,
uri=self.base_url,
user=user,
passwd=token)
opener = urllib2.build_opener(auth_handler)
# install it for all urllib2.urlopen calls
urllib2.install_opener(opener)
@staticmethod
def read(url):
# type (str) -> str
"""Read URL"""
logging.debug("Reading from %s", url)
return urllib2.urlopen(url).read() # nosec
@staticmethod
def download_file(url, dest_file='', download_dir='.'):
# type (str, str, str) -> None
"""Download file"""
target_file = dest_file
if not target_file:
url_parsed = urlparse.urlparse(url)
target_file = os.path.basename(url_parsed.path)
chunk = 128 * 1024 # 128 KiB
target_dir = os.path.abspath(download_dir)
target_path = os.path.join(target_dir, target_file)
try:
os.makedirs(target_dir)
except OSError as exc:
if exc.errno == errno.EEXIST and os.path.isdir(target_dir):
# Dir already exists
pass
else:
raise
logging.info("Downloading to %s from %s", target_path, url)
response = urllib2.urlopen(url) # nosec
chunk_count = 0
with open(target_path, 'wb') as out_file:
while True:
buf = response.read(chunk)
if not buf:
break
out_file.write(buf)
chunk_count += 1
if chunk_count % 100 == 0:
sys.stderr.write('#')
sys.stderr.flush()
elif chunk_count % 10 == 0:
sys.stderr.write('.')
sys.stderr.flush()
return response
def mkdir_p(directory, mode=0o755):
# type(str) -> None
"""Ensure the directory and intermediate directories exists,
just like mkdir -p"""
try:
os.makedirs(directory, mode)
logging.info("Directory %s created", directory)
except OSError as e:
if e.errno != errno.EEXIST or not os.path.isdir(directory):
raise
def version_sort(version_list, reverse=False):
"""Sort the version from list
Args:
version_list (List[str]): version str in a list
reverse (bool, optional): Defaults to False. Desending sort.
Returns:
List[str] -- Sorted list of versions
Examples:
>>> version_list = ['1.0.0', '10.0.0', '2.0.0', '1.0.0-rc-1' ]
>>> version_sort(version_list)
['1.0.0-rc-1', '1.0.0', '2.0.0', '10.0.0']
>>> version_sort(version_list, True)
['10.0.0', '2.0.0', '1.0.0', '1.0.0-rc-1']
"""
# Add -zfinal to final releases, so it can be sorted after rc
sorted_dirty_version = sorted(
[re.sub(
'^([.0-9]+)$', r'\1-zfinal', v) for v in version_list],
key=LooseVersion, reverse=reverse)
return [re.sub('-zfinal', '', v) for v in sorted_dirty_version]
@contextmanager
def working_directory(directory):
# type(str) -> None
"""Context manager for change directory
Usage: with working_directory('~'):
..."""
curr_directory = os.getcwd()
try:
logging.debug("cd to %s", directory)
mkdir_p(directory)
os.chdir(directory)
yield directory
finally:
os.chdir(curr_directory)
def main():
"""Run as command line program"""
parser = ZanataArgParser(__file__)
parser.add_methods_as_sub_commands(GitHelper)
parser.add_sub_command(
'module-help', None,
help='Show Python Module help')
args = parser.parse_all()
if args.sub_command == 'module-help':
help(sys.modules[__name__])
else:
parser.run_sub_command(args)
if __name__ == '__main__':
if os.getenv("PY_DOCTEST", "0") == "1":
import doctest
test_result = doctest.testmod()
print(doctest.testmod(), file=sys.stderr)
sys.exit(0 if test_result.failed == 0 else 1)
main()