-
Notifications
You must be signed in to change notification settings - Fork 1
/
build.py
executable file
·391 lines (289 loc) · 11 KB
/
build.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
#!/usr/bin/env python2
# -*- coding: utf-8 -*-
import os
import sys
import json
import argparse
import shutil
import subprocess
import mimetypes
import re
import git
from datetime import datetime
def say(s, *args):
sys.stderr.write(s.format(*args))
def get_args():
parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument('--release', action='store_true', help='create GitHub release')
parser.add_argument('--deploy', action='store_true', help='deploy extensions')
parser.add_argument('--build-dir', default='./build', metavar='PATH', help='build directory')
parser.add_argument('target', nargs='?', default='all', help='target to build, one of: ' + ', '.join(sorted(TARGETS)))
return parser.parse_args()
def get_head_tag_name(repo):
tag_name = repo.git.describe('--tags')
for tag in repo.tags:
if tag.name == tag_name:
return tag_name
return None
def merge_json(a, b, out):
with open(a, 'r') as f:
ja = json.load(f)
with open(b, 'r') as f:
jb = json.load(f)
ja.update(jb)
with open(out, 'w') as f:
json.dump(ja, f, indent=4)
def copy_source(dest_dir):
if os.path.isdir(dest_dir):
shutil.rmtree(dest_dir)
os.makedirs(dest_dir)
for fname in FILES:
if os.path.isdir(fname):
shutil.copytree(fname, os.path.join(dest_dir, fname))
else:
shutil.copy2(fname, dest_dir)
def parse_changelog(fname):
changelog = []
ok = False
for l in map(str.strip, open(fname, 'r').readlines()):
if ok and (l[:3] == '###' or l[:3] == '---'):
break
if l[:3] == '###':
ok = True
if ok:
changelog.append(l)
matches = re.findall(r'\d{4}-\d{2}-\d{2}', changelog.pop(0))
if not matches:
return None
date = datetime.strptime(matches[0], '%Y-%m-%d').strftime('%B %d, %Y').replace(' 0', ' ')
while not changelog[0]:
changelog.pop(0)
head = '{} — **{}**'.format(date, changelog[0])
body = '\n'.join(changelog[1:]).strip('\n')
return head + '\n\n' + body
def get_browser_dirs(build_dir, browser_name):
browser_dir = os.path.join(build_dir, browser_name)
browser_src_dir = os.path.join(browser_dir, 'src')
return browser_dir, browser_src_dir
def create_browser_dirs(build_dir, browser_name):
bdir, sdir = get_browser_dirs(build_dir, browser_name)
if os.path.isdir(bdir):
shutil.rmtree(bdir)
say('[Build/{}] Copying sources...\r', browser_name)
copy_source(sdir)
say('[Build/{}] Copying sources... done.\n', browser_name)
say('[Build/{}] Merging manifest...\r', browser_name)
merge_json('manifest.json', 'manifest.' + browser_name + '.json', os.path.join(sdir, 'manifest.json'))
say('[Build/{}] Merging manifest... done.\n', browser_name)
return bdir, sdir
def clean_build_dir(build_dir):
for target in filter(lambda k: k != 'all', TARGETS.keys()):
_, sdir = get_browser_dirs(build_dir, target)
if os.path.isdir(sdir):
shutil.rmtree(sdir)
def rename_assets(build_dir):
for target in filter(lambda k: k != 'all', TARGETS.keys()):
bdir = get_browser_dirs(build_dir, target)[0]
if os.path.isdir(bdir):
for fname in filter(lambda f: not os.path.isdir(os.path.join(bdir, f)), os.listdir(bdir)):
ext = fname[fname.rfind('.'):]
clean_name = re.sub(r'([\w_]+-(\d+\.)+\d).*', r'\1', fname)
newfname = clean_name + '-' + target + ext
os.rename(os.path.join(bdir, fname), os.path.join(bdir, newfname))
def get_assets(build_dir):
say('[Release] Gathering assets...\r')
assets = []
for target in filter(lambda k: k != 'all', TARGETS.keys()):
bdir = get_browser_dirs(build_dir, target)[0]
if os.path.isdir(bdir):
for fname in filter(lambda f: not os.path.isdir(os.path.join(bdir, f)), os.listdir(bdir)):
fullname = os.path.join(bdir, fname)
assets.append((fullname, mimetypes.guess_type(fullname)[0]))
if len(assets):
say('[Release] Gathering assets... done ({} found).\n', len(assets))
else:
say('[Release] Gathering assets... no assets found.\n')
return assets
def check_releasable(tag_name):
if not (ENV_GH_TOKEN and ENV_GH_RELEASE_BASENAME and ENV_GH_RELEASE_BRANCH and ENV_TRAVIS_REPO_SLUG and ENV_TRAVIS_BRANCH and ENV_TRAVIS_PR):
say('[Release] Error: missing one or more needed environment variables, aborting.\n')
sys.exit(1)
if ENV_TRAVIS_PR == '1':
say('[Release] Skipping release: this is a pull request.\n')
return False
if ENV_TRAVIS_BRANCH != ENV_GH_RELEASE_BRANCH:
say('[Release] Skipping release: current branch ({}) is not designed release/deploy branch ({}).\n', ENV_TRAVIS_BRANCH, ENV_GH_RELEASE_BRANCH)
return False
if tag_name is None:
say('[Release] Skipping release: HEAD not pointing to a tag.\n')
return False
return True
def check_deployable(tag_name, target, prerelease):
if prerelease:
say('[Deploy] Skipping deploy: pre-release.\n')
return False
if ENV_TRAVIS_PR == '1':
say('[Deploy] Skipping deploy: this is a pull request.\n')
return False
if ENV_TRAVIS_BRANCH != ENV_GH_RELEASE_BRANCH:
say('[Deploy] Skipping deploy: current branch ({}) is not designed release/deploy branch ({}).\n', ENV_TRAVIS_BRANCH, ENV_GH_RELEASE_BRANCH)
return False
if tag_name is None:
say('[Deploy] Skipping deploy: HEAD not pointing to a tag.\n')
return False
if target not in TARGETS.keys():
say('[Deploy] Error: unknown target "{}", aborting.\n', target)
sys.exit(1)
return True
def web_ext_build(bdir, sdir, browser_name):
say('[Build/{}] Running web-ext build...\r', browser_name)
sp = subprocess.Popen(
['web-ext', 'build', '--source-dir=' + sdir, '--artifacts-dir=' + bdir, '--overwrite-dest'],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT
)
out = sp.communicate()[0]
say("[Build/{}] Building extension with 'web-ext build'...\r", browser_name)
if sp.returncode == 0:
say("[Build/{}] Building extension with 'web-ext build'... done\n", browser_name)
else:
say("[Build/{}] Error: 'web-ext build' exited with code {}, aborting.\n\n", browser_name, sp.returncode)
say(out)
sys.exit(1)
say('[Build/{}] Done.\n', browser_name)
def build_chrome(build_dir):
bdir, sdir = create_browser_dirs(build_dir, 'chrome')
web_ext_build(bdir, sdir, 'chrome')
def build_firefox(build_dir):
bdir, sdir = create_browser_dirs(build_dir, 'firefox')
web_ext_build(bdir, sdir, 'firefox')
def deploy_chrome(_):
say("[Deploy/chrome] Unfortunately Google doesn't like automatic deployment :(\n")
say('[Deploy/chrome] Done.\n')
def deploy_firefox(build_dir):
if not (ENV_AMO_JWT_ISSUER and ENV_AMO_JWT_SECRET):
say('[Deploy/firefox] Error: missing one or more needed environment variables, aborting.\n')
sys.exit(1)
bdir, sdir = get_browser_dirs(build_dir, 'firefox')
say("[Deploy/firefox] Signing extension with 'web-ext sign'...\r")
sp = subprocess.Popen(
[
'web-ext', 'sign',
'--api-key=' + ENV_AMO_JWT_ISSUER,
'--api-secret=' + ENV_AMO_JWT_SECRET,
'--source-dir=' + sdir,
'--artifacts-dir=' + bdir
],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT
)
out = sp.communicate()[0].lower()
if sp.returncode == 0:
say("[Deploy/firefox] Signing extension with 'web-ext sign'... done.\n")
elif sp.returncode != 0 and 'version already exists' in out:
say("[Deploy/firefox] Signing extension with 'web-ext sign'... version already signed.\n")
elif sp.returncode != 0 and 'submitted for review' in out and 'passed validation' in out:
say("[Deploy/firefox] Signing extension with 'web-ext sign'... submitted for review, not directly signed.\n")
else:
say("[Deploy/firefox] Error: 'web-ext sign' exited with code {}, aborting.\n\n", sp.returncode)
say(out)
sys.exit(1)
say('[Deploy/firefox] Done.\n')
def build(repo, target, build_dir):
if os.getcwd() == os.path.abspath(build_dir):
say('[Build] Error: cannot build in source directory.\n')
sys.exit(1)
if not os.path.isdir(build_dir):
try:
os.makedirs(build_dir)
except:
say('[Build] Error: unable to create build directory "{}", aborting.\n', build_dir)
sys.exit(1)
tag_name = repo.git.describe('--tags')
if target not in TARGETS.keys():
say('[Build] Error: unknown target "{}", aborting.\n', target)
sys.exit(1)
say('[Build] Target: {}.\n', target)
say('[Build] Building {} ({}).\n', tag_name, repo.head.commit.hexsha)
for builder in TARGETS[target]['build']:
builder(build_dir)
rename_assets(build_dir)
say('[Build] Done.\n')
def release(tag_name, build_dir, prerelease):
import github3
if not check_releasable(tag_name):
return None
user, repo = ENV_TRAVIS_REPO_SLUG.split('/')
release_name = ENV_GH_RELEASE_BASENAME + ' ' + tag_name
release_body = None
release_is_pre = prerelease or any(s in tag_name for s in ('-alpha', '-beta', '-pre'))
say('[Release] Releasing {}.\n', release_name)
if not prerelease:
say('[Release] Parsing changelog...\r')
release_body = parse_changelog('CHANGELOG.md')
if not release_body:
say('[Release] Error: could not correctly parse changelog, aborting.')
sys.exit(1)
say('[Release] Parsing changelog... done.\n')
gh_repo = github3.login(token=ENV_GH_TOKEN).repository(user, repo)
gh_release = None
say('[Release] Creating release...\r')
try:
gh_release = gh_repo.release_from_tag(tag_name)
say('[Release] Creating release... already existing.\n')
except github3.exceptions.NotFoundError:
gh_release = gh_repo.create_release(tag_name, name=release_name, body=release_body, prerelease=release_is_pre)
say('[Release] Creating release... done.\n')
for fname, mimetype in get_assets(build_dir):
say('[Release] Uploading {}...\r', fname)
gh_release.upload_asset(mimetype, os.path.split(fname)[-1], open(fname, 'rb').read())
say('[Release] Uploading {}... done.\n', fname)
say('[Release] Done.\n')
def deploy(tag_name, target, build_dir, prerelease):
if not check_deployable(tag_name, target, prerelease):
return
say('[Deploy] Target: {}.\n', target)
for deployer in TARGETS[target]['deploy']:
deployer(build_dir)
say('[Deploy] Done.\n')
###############################################################
FILES = [
'LICENSE',
'CHANGELOG.md',
'src',
'resources'
]
TARGETS = {
'chrome': {
'build': [build_chrome],
'deploy': [deploy_chrome]
},
'firefox': {
'build': [build_firefox],
'deploy': [deploy_firefox]
},
'all': {
'build': [build_chrome, build_firefox],
'deploy': [deploy_chrome, deploy_firefox]
},
}
if __name__ == '__main__':
ENV_GH_TOKEN = os.getenv('GH_OAUTH_TOKEN')
ENV_GH_RELEASE_BASENAME = os.getenv('GH_RELEASE_BASENAME')
ENV_GH_RELEASE_BRANCH = os.getenv('GH_RELEASE_BRANCH')
ENV_AMO_JWT_ISSUER = os.getenv('AMO_JWT_ISSUER')
ENV_AMO_JWT_SECRET = os.getenv('AMO_JWT_SECRET')
ENV_TRAVIS_BRANCH = os.getenv('TRAVIS_BRANCH')
ENV_TRAVIS_PR = os.getenv('TRAVIS_PULL_REQUEST')
ENV_TRAVIS_REPO_SLUG = os.getenv('TRAVIS_REPO_SLUG')
args = get_args()
git_repo = git.Repo()
gh_release = None
build(git_repo, args.target, args.build_dir)
tag_name = get_head_tag_name(git_repo)
release_is_pre = (tag_name[-4:] == '-pre') if tag_name else False
if args.release:
release(tag_name, args.build_dir, release_is_pre)
if args.deploy:
deploy(tag_name, args.target, args.build_dir, release_is_pre)
clean_build_dir(args.build_dir)