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
|
# Copyright (c) 2010 Richard Wall <richard (at) the-moon.net>
"""
Functions and Classes for automating the release of Jarmon
"""
import hashlib
import logging
import os
import shutil
import sys
import httplib
import urllib
from optparse import OptionParser
from subprocess import check_call, PIPE
from tempfile import gettempdir
from urllib2 import urlopen
from zipfile import ZipFile, ZIP_DEFLATED
from lxml.cssselect import CSSSelector
from lxml import html
import pkg_resources
JARMON_PROJECT_TITLE = 'Jarmon'
JARMON_PROJECT_URL = 'http://www.launchpad.net/jarmon'
YUIDOC_URL = 'http://yuilibrary.com/downloads/yuidoc/yuidoc_1.0.0b1.zip'
YUIDOC_MD5 = 'cd5545d2dec8f7afe3d18e793538162c'
YUIDOC_DEPENDENCIES = ['setuptools', 'pygments', 'cheetah']
class BuildError(Exception):
"""
A base Exception for errors in the build system
"""
pass
class BuildCommand(object):
def __init__(self):
self.log = logging.getLogger(
'%s.%s' % (__name__, self.__class__.__name__))
self.workingbranch_dir = os.path.abspath(
os.path.join(os.path.dirname(__file__), '..'))
# setup working dir
self.build_dir = os.path.join(self.workingbranch_dir, 'build')
if not os.path.isdir(self.build_dir):
self.log.debug('Creating build dir: %s' % (self.build_dir,))
os.mkdir(self.build_dir)
else:
self.log.debug('Using build dir: %s' % (self.build_dir,))
class BuildApidocsCommand(BuildCommand):
"""
Download YUI Doc and use it to generate apidocs for jarmon
"""
command_name = 'apidocs'
def main(self, argv):
"""
The main entry point for the build-apidocs command
@param argv: The list of arguments passed to the build-apidocs command
"""
parser = OptionParser(
usage='build [options] %s VERSION' % (self.command_name,))
parser.disable_interspersed_args()
options, args = parser.parse_args(argv)
if len(args) != 1:
parser.error('Wrong number of arguments. This command expects a '
'version number only.')
buildversion = args[0]
tmpdir = gettempdir()
workingbranch_dir = self.workingbranch_dir
build_dir = self.build_dir
# Check for yuidoc dependencies
for r in pkg_resources.parse_requirements(YUIDOC_DEPENDENCIES):
if not pkg_resources.working_set.find(r):
raise BuildError('Unsatisfied yuidoc dependency: %r' % (r,))
# download and cache yuidoc
yuizip_path = os.path.join(tmpdir, os.path.basename(YUIDOC_URL))
if os.path.exists(yuizip_path):
self.log.debug('Using cached YUI doc')
def producer_local():
yield open(yuizip_path).read()
producer = producer_local
else:
self.log.debug('Downloading YUI Doc')
def producer_remote():
with open(yuizip_path, 'w') as yuizip:
download = urlopen(YUIDOC_URL)
while True:
bytes = download.read(1024 * 10)
if not bytes:
break
else:
yuizip.write(bytes)
yield bytes
producer = producer_remote
checksum = hashlib.md5()
for bytes in producer():
checksum.update(bytes)
actual_md5 = checksum.hexdigest()
if actual_md5 != YUIDOC_MD5:
raise BuildError(
'YUI Doc checksum error. File: %s, '
'Expected: %s, '
'Got: %s' % (yuizip_path, YUIDOC_MD5, actual_md5))
else:
self.log.debug('YUI Doc checksum verified')
# Remove any existing apidocs so that we can track removed files
shutil.rmtree(os.path.join(build_dir, 'docs', 'apidocs'), True)
yuidoc_dir = os.path.join(build_dir, 'yuidoc')
# extract yuidoc folder from the downloaded zip file
self.log.debug(
'Extracting YUI Doc from %s to %s' % (yuizip_path, yuidoc_dir))
zip = ZipFile(yuizip_path)
zip.extractall(
build_dir, (m for m in zip.namelist() if m.startswith('yuidoc')))
# Use the yuidoc script that we just extracted to generate new docs
self.log.debug('Running YUI Doc')
check_call((
sys.executable,
os.path.join(yuidoc_dir, 'bin', 'yuidoc.py'),
os.path.join(workingbranch_dir, 'jarmon'),
'--parseroutdir=%s' % (
os.path.join(build_dir, 'docs', 'apidocs'),),
'--outputdir=%s' % (
os.path.join(build_dir, 'docs', 'apidocs'),),
'--template=%s' % (
os.path.join(
workingbranch_dir, 'jarmonbuild', 'yuidoc_template'),),
'--version=%s' % (buildversion,),
'--project=%s' % (JARMON_PROJECT_TITLE,),
'--projecturl=%s' % (JARMON_PROJECT_URL,),
), stdout=PIPE, stderr=PIPE,)
shutil.rmtree(yuidoc_dir)
class BuildReleaseCommand(BuildCommand):
"""
Export all source files, generate apidocs and create a zip archive for
upload to Launchpad.
"""
command_name = 'release'
def main(self, argv):
parser = OptionParser(
usage='build [options] %s VERSION' % (self.command_name,))
parser.disable_interspersed_args()
options, args = parser.parse_args(argv)
if len(args) != 1:
parser.error('Wrong number of arguments. This command expects a '
'version number only.')
buildversion = args[0]
workingbranch_dir = self.workingbranch_dir
build_dir = self.build_dir
self.log.debug('Export versioned files to a build folder')
from bzrlib.commands import main as bzr_main
status = bzr_main(['bzr', 'export', build_dir, workingbranch_dir])
if status != 0:
raise BuildError('bzr export failure. Status: %r' % (status,))
self.log.debug('Record the branch version')
from bzrlib.branch import Branch
from bzrlib.version_info_formats import format_python
v = format_python.PythonVersionInfoBuilder(
Branch.open(workingbranch_dir))
versionfile_path = os.path.join(
build_dir, 'jarmonbuild', '_version.py')
with open(versionfile_path, 'w') as f:
v.generate(f)
self.log.debug('Generate apidocs')
BuildApidocsCommand().main([buildversion])
self.log.debug('Generate archive')
archive_root = 'jarmon-%s' % (buildversion,)
prefix_len = len(build_dir) + 1
z = ZipFile('%s.zip' % (archive_root,), 'w', ZIP_DEFLATED)
try:
for root, dirs, files in os.walk(build_dir):
for file in files:
z.write(
os.path.join(root, file),
os.path.join(archive_root, root[prefix_len:], file),
)
finally:
z.close()
class BuildTestDataCommand(BuildCommand):
"""
Create data for use in unittests
"""
command_name = 'testdata'
def main(self, argv):
"""
Create an RRD file with values 0-9 entered at 1 second intervals from
1980-01-01 00:00:00 (the first date that rrdtool allows)
"""
from datetime import datetime
from pyrrd.rrd import DataSource, RRA, RRD
start = int(datetime(1980, 1, 1, 0, 0).strftime('%s'))
dss = []
rras = []
filename = os.path.join(self.build_dir, 'test.rrd')
rows = 12
step = 10
dss.append(
DataSource(dsName='speed', dsType='GAUGE', heartbeat=2 * step))
rras.append(RRA(cf='AVERAGE', xff=0.5, steps=1, rows=rows))
rras.append(RRA(cf='AVERAGE', xff=0.5, steps=12, rows=rows))
my_rrd = RRD(filename, ds=dss, rra=rras, start=start, step=step)
my_rrd.create()
for i, t in enumerate(
range(start + step, start + step + (rows * step), step)):
self.log.debug(
'DATA: %s %s (%s)' % (t, i, datetime.fromtimestamp(t)))
my_rrd.bufferValue(t, i)
# Add further data 1 second later to demonstrate that the rrd
# lastupdatetime does not necessarily fall on a step boundary
t += 1
i += 1
self.log.debug('DATA: %s %s (%s)' % (t, i, datetime.fromtimestamp(t)))
my_rrd.bufferValue(t, i)
my_rrd.update()
class BuildJavascriptDependenciesCommand(BuildCommand):
"""
Export all source files, generate apidocs and create a zip archive for
upload to Launchpad.
"""
command_name = 'jsdeps'
def main(self, argv):
self.log.debug('Compiling javascript dependencies')
depjs_path = os.path.join(
self.workingbranch_dir,
'docs/examples/assets/js/dependencies.js')
# Get the closure params from the original file
params = []
for line in open(depjs_path):
line = line.strip()
if line.startswith('// @'):
key, val = line.lstrip('/ @').strip().split(None, 1)
params.append((key.strip(), val.strip()))
# Always use the following value for the Content-type header.
headers = { "Content-type": "application/x-www-form-urlencoded" }
conn = httplib.HTTPConnection('closure-compiler.appspot.com')
conn.request('POST', '/compile', urllib.urlencode(params), headers)
response = conn.getresponse()
with open(depjs_path, 'w') as f:
for param in params:
f.write('// @%s %s\n' % param)
while not response.isclosed():
f.write(response.read(1024 * 10))
conn.close
# The available subcommands
SUBCOMMAND_HANDLERS = [
BuildApidocsCommand,
BuildReleaseCommand,
BuildTestDataCommand,
BuildJavascriptDependenciesCommand,
]
def main(argv=sys.argv[1:]):
"""
The root build command which dispatches to various subcommands for eg
building apidocs and release zip files.
"""
build_commands = dict(
(handler.command_name, handler) for handler in SUBCOMMAND_HANDLERS)
parser = OptionParser(
usage='build [options] SUBCOMMAND [options]',
description='Available subcommands are: %r' % (build_commands.keys(),))
parser.add_option(
'-d', '--debug', action='store_true', default=False, dest='debug',
help='Print verbose debug log to stderr')
parser.disable_interspersed_args()
options, args = parser.parse_args(argv)
if len(args) < 1:
parser.error('Please specify a sub command. '
'Available commands: %r' % (build_commands.keys()))
# First argument is the name of a subcommand
command_name = args.pop(0)
command_factory = build_commands.get(command_name)
if not command_factory:
parser.error('Unrecognised subcommand: %r' % (command_name,))
# Setup logging
log = logging.getLogger(__name__)
log.setLevel(logging.INFO)
# create console handler and set level to debug
ch = logging.StreamHandler()
ch.setLevel(logging.INFO)
# create formatter
formatter = logging.Formatter(
'%(asctime)s - %(name)s - %(levelname)s - %(message)s')
# add formatter to ch
ch.setFormatter(formatter)
log.addHandler(ch)
if options.debug:
log.setLevel(logging.DEBUG)
ch.setLevel(logging.DEBUG)
command_factory().main(argv=args)
|