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
|
# 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
from subprocess import check_call
from tempfile import gettempdir
from urllib2 import urlopen
from zipfile import ZipFile
JARMON_VERSION='10.8'
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'
class BuildError(Exception):
"""
A base Exception for errors in the build system
"""
pass
class BuildCommand(object):
def __init__(self, log=None):
if log is not None:
self.log = log
else:
self.log = logging.getLogger()
class BuildApidocsCommand(BuildCommand):
"""
Download YUI Doc and use it to generate apidocs for jarmon
"""
def main(self, argv=sys.argv):
"""
The main entry point for the build-apidocs command
@param argv: The list of arguments passed to the build-apidocs command
"""
tmpdir = gettempdir()
workingbranch_dir = os.path.join(os.path.dirname(__file__), '..')
# setup working dir
build_dir = os.path.join(workingbranch_dir, 'build')
if not os.path.isdir(build_dir):
self.log.debug('Creating working dir: %s' % (build_dir,))
os.mkdir(build_dir)
else:
self.log.debug('Using working dir: %s' % (build_dir,))
# download and cache yuidoc
yuizip_path = os.path.join(tmpdir, os.path.basename(YUIDOC_URL))
if os.path.exists(yuizip_path):
def producer():
self.log.debug('Using cached YUI doc')
yield open(yuizip_path).read()
else:
def producer():
with open(yuizip_path, 'w') as yuizip:
self.log.debug('Downloading YUI Doc')
download = urlopen(YUIDOC_URL)
while True:
bytes = download.read(1024*10)
if not bytes:
break
else:
yuizip.write(bytes)
yield bytes
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'),
workingbranch_dir,
'--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' % (JARMON_VERSION,),
'--project=%s' % (JARMON_PROJECT_TITLE,),
'--projecturl=%s' % (JARMON_PROJECT_URL,)
))
shutil.rmtree(yuidoc_dir)
class BuildSourceArchiveCommand(object):
def main(self, argv=sys.argv):
workingbranch_dir = os.path.join(os.path.dirname(__file__), '..')
# setup working dir
build_dir = os.path.join(workingbranch_dir, 'build')
# Use bzr to export the 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,))
# Generate apidocs
|
