3 # Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
31 TEMPORARY_DIRECTORY = '/tmp'
33 class Error(Exception):
34 def __init__(self, value):
43 Store for Tree objects which re-uses already-created objects
44 and checks for requests for different versions of the same thing.
50 def get(self, name, specifier, target):
52 if t.name == name and t.specifier == specifier and t.target == target:
54 elif t.name == name and t.specifier != specifier:
55 raise Error('conflicting versions of %s requested (%s and %s)' % (name, specifier, t.specifier))
57 nt = Tree(name, specifier, target)
74 def __init__(self, key, default=None):
78 def offer(self, key, value):
82 class BoolOption(object):
83 def __init__(self, key):
87 def offer(self, key, value):
89 self.value = (value == 'yes' or value == '1' or value == 'true')
93 self.options = [ Option('linux_chroot_prefix'),
94 Option('windows_environment_prefix'),
95 Option('mingw_prefix'),
97 Option('osx_build_host'),
98 Option('osx_environment_prefix'),
99 Option('osx_sdk_prefix'),
101 Option('parallel', 4) ]
104 f = open('%s/.config/cdist' % os.path.expanduser('~'), 'r')
110 if len(l) > 0 and l[0] == '#':
113 s = l.strip().split()
115 for k in self.options:
121 for o in self.options:
125 raise Error('Required setting %s not found' % k)
128 for o in self.options:
138 if not globals.quiet:
139 print '\x1b[33m* %s\x1b[0m' % m
143 assert(len(s) == 1 or len(s) == 2)
145 return '%s:"\'%s\'"' % (s[0], s[1])
147 return '\"%s\"' % s[0]
150 log('copy %s -> %s' % (scp_escape(b), scp_escape(b)))
151 command('scp -r %s %s' % (scp_escape(a), scp_escape(b)))
154 log('copy %s -> %s' % (scp_escape(a), scp_escape(b)))
155 command('scp %s %s' % (scp_escape(a), scp_escape(b)))
158 if d.find(':') == -1:
162 command('ssh %s -- mkdir -p %s' % (s[0], s[1]))
170 shutil.rmtree(a, ignore_errors=True)
176 raise Error('command %s failed' % c)
178 def command_and_read(c):
180 p = subprocess.Popen(c.split(), stdout=subprocess.PIPE)
181 f = os.fdopen(os.dup(p.stdout.fileno()))
184 def read_wscript_variable(directory, variable):
185 f = open('%s/wscript' % directory, 'r')
192 if len(s) == 3 and s[0] == variable:
199 def set_version_in_wscript(version):
200 f = open('wscript', 'rw')
201 o = open('wscript.tmp', 'w')
208 if len(s) == 3 and s[0] == "VERSION":
209 print "Writing %s" % version
210 print >>o,"VERSION = '%s'" % version
216 os.rename('wscript.tmp', 'wscript')
218 def append_version_to_changelog(version):
220 f = open('ChangeLog', 'r')
222 log('Could not open ChangeLog')
228 f = open('ChangeLog', 'w')
229 now = datetime.datetime.now()
230 f.write('%d-%02d-%02d Carl Hetherington <cth@carlh.net>\n\n\t* Version %s released.\n\n' % (now.year, now.month, now.day, version))
233 def append_version_to_debian_changelog(version):
234 if not os.path.exists('debian'):
235 log('Could not find debian directory')
238 command('dch -b -v %s-1 "New upstream release."' % version)
240 def devel_to_git(git_commit, filename):
241 if git_commit is not None:
242 filename = filename.replace('devel', '-%s' % git_commit)
246 def __init__(self, tree):
249 self.cwd = os.getcwd()
250 os.chdir('%s/src/%s' % (self.tree.target.directory, self.tree.name))
251 def __exit__(self, type, value, traceback):
259 def __init__(self, s):
262 if s.startswith("'"):
267 if s.endswith('devel'):
271 if s.endswith('pre'):
275 self.major = int(p[0])
276 self.minor = int(p[1])
278 self.micro = int(p[2])
282 def bump_minor(self):
286 def bump_micro(self):
292 def to_release(self):
296 s = '%d.%d.%d' % (self.major, self.minor, self.micro)
306 class Target(object):
308 platform -- platform string (e.g. 'windows', 'linux', 'osx')
309 directory -- directory to work in; if None we will use a temporary directory
310 Temporary directories will be removed after use; specified directories will not.
312 def __init__(self, platform, directory=None):
313 self.platform = platform
314 self.parallel = int(config.get('parallel'))
316 # self.directory is the working directory
317 if directory is None:
318 self.directory = tempfile.mkdtemp('', 'tmp', TEMPORARY_DIRECTORY)
321 self.directory = directory
324 # Environment variables that we will use when we call cscripts
328 def package(self, project, checkout):
329 tree = globals.trees.get(project, checkout, self)
330 tree.build_dependencies()
332 return tree.call('package', tree.version), tree.git_commit
334 def test(self, tree):
335 tree.build_dependencies()
337 return tree.call('test')
340 self.variables[a] = b
343 del(self.variables[a])
346 return self.variables[a]
348 def append_with_space(self, k, v):
349 if not k in self.variables:
350 self.variables[k] = v
352 self.variables[k] = '%s %s' % (self.variables[k], v)
354 def variables_string(self, escaped_quotes=False):
356 for k, v in self.variables.iteritems():
358 v = v.replace('"', '\\"')
359 e += '%s=%s ' % (k, v)
364 rmtree(self.directory)
370 class WindowsTarget(Target):
371 def __init__(self, bits, directory=None):
372 super(WindowsTarget, self).__init__('windows', directory)
375 self.windows_prefix = '%s/%d' % (config.get('windows_environment_prefix'), self.bits)
376 if not os.path.exists(self.windows_prefix):
377 raise Error('windows prefix %s does not exist' % self.windows_prefix)
380 self.mingw_name = 'i686'
382 self.mingw_name = 'x86_64'
384 self.mingw_path = '%s/%d/bin' % (config.get('mingw_prefix'), self.bits)
385 self.mingw_prefixes = ['/%s/%d' % (config.get('mingw_prefix'), self.bits), '%s/%d/%s-w64-mingw32' % (config.get('mingw_prefix'), bits, self.mingw_name)]
387 self.set('PKG_CONFIG_LIBDIR', '%s/lib/pkgconfig' % self.windows_prefix)
388 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/bin/pkgconfig' % (self.directory, self.directory))
389 self.set('PATH', '%s/bin:%s:%s' % (self.windows_prefix, self.mingw_path, os.environ['PATH']))
390 self.set('CC', '%s-w64-mingw32-gcc' % self.mingw_name)
391 self.set('CXX', '%s-w64-mingw32-g++' % self.mingw_name)
392 self.set('LD', '%s-w64-mingw32-ld' % self.mingw_name)
393 self.set('RANLIB', '%s-w64-mingw32-ranlib' % self.mingw_name)
394 self.set('WINRC', '%s-w64-mingw32-windres' % self.mingw_name)
395 cxx = '-I%s/include -I%s/include' % (self.windows_prefix, self.directory)
396 link = '-L%s/lib -L%s/lib' % (self.windows_prefix, self.directory)
397 for p in self.mingw_prefixes:
398 cxx += ' -I%s/include' % p
399 link += ' -L%s/lib' % p
400 self.set('CXXFLAGS', '"%s"' % cxx)
401 self.set('CPPFLAGS', '')
402 self.set('LINKFLAGS', '"%s"' % link)
404 def command(self, c):
405 log('host -> %s' % c)
406 command('%s %s' % (self.variables_string(), c))
412 class LinuxTarget(Target):
413 def __init__(self, distro, version, bits, directory=None):
414 super(LinuxTarget, self).__init__('linux', directory)
416 self.version = version
418 # e.g. ubuntu-14.04-64
419 if self.version is not None and self.bits is not None:
420 self.chroot = '%s-%s-%d' % (self.distro, self.version, self.bits)
422 self.chroot = self.distro
423 # e.g. /home/carl/Environments/ubuntu-14.04-64
424 self.chroot_prefix = '%s/%s' % (config.get('linux_chroot_prefix'), self.chroot)
426 self.set('CXXFLAGS', '-I%s/include' % self.directory)
427 self.set('CPPFLAGS', '')
428 self.set('LINKFLAGS', '-L%s/lib' % self.directory)
429 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:/usr/local/lib/pkgconfig' % self.directory)
430 self.set('PATH', '/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin')
432 def command(self, c):
433 command('%s schroot -c %s -p -- %s' % (self.variables_string(), self.chroot, c))
439 class OSXTarget(Target):
440 def __init__(self, directory=None):
441 super(OSXTarget, self).__init__('osx', directory)
443 def command(self, c):
444 command('%s %s' % (self.variables_string(False), c))
447 class OSXSingleTarget(OSXTarget):
448 def __init__(self, bits, directory=None):
449 super(OSXSingleTarget, self).__init__(directory)
457 flags = '-isysroot %s/MacOSX%s.sdk -arch %s' % (config.get('osx_sdk_prefix'), config.get('osx_sdk'), arch)
458 enviro = '%s/%d' % (config.get('osx_environment_prefix'), bits)
460 # Environment variables
461 self.set('CFLAGS', '"-I%s/include -I%s/include %s"' % (self.directory, enviro, flags))
462 self.set('CPPFLAGS', '')
463 self.set('CXXFLAGS', '"-I%s/include -I%s/include %s"' % (self.directory, enviro, flags))
464 self.set('LDFLAGS', '"-L%s/lib -L%s/lib %s"' % (self.directory, enviro, flags))
465 self.set('LINKFLAGS', '"-L%s/lib -L%s/lib %s"' % (self.directory, enviro, flags))
466 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/lib/pkgconfig:/usr/lib/pkgconfig' % (self.directory, enviro))
467 self.set('PATH', '$PATH:/usr/bin:/sbin:/usr/local/bin:%s/bin' % enviro)
468 self.set('MACOSX_DEPLOYMENT_TARGET', config.get('osx_sdk'))
470 def package(self, project, checkout):
471 raise Error('cannot package non-universal OS X versions')
474 class OSXUniversalTarget(OSXTarget):
475 def __init__(self, directory=None):
476 super(OSXUniversalTarget, self).__init__(directory)
478 def package(self, project, checkout):
481 target = OSXSingleTarget(b, os.path.join(self.directory, '%d' % b))
482 tree = globals.trees.get(project, checkout, target)
483 tree.build_dependencies()
486 tree = globals.trees.get(project, checkout, self)
487 with TreeDirectory(tree):
488 return tree.call('package', tree.version), tree.git_commit
494 class SourceTarget(Target):
496 super(SourceTarget, self).__init__('source')
498 def command(self, c):
499 log('host -> %s' % c)
500 command('%s %s' % (self.variables_string(), c))
503 rmtree(self.directory)
505 def package(self, project, checkout):
506 tree = globals.trees.get(project, checkout, self)
507 with TreeDirectory(tree):
508 name = read_wscript_variable(os.getcwd(), 'APPNAME')
509 command('./waf dist')
510 return os.path.abspath('%s-%s.tar.bz2' % (name, tree.version)), tree.git_commit
513 # @param s Target string:
515 # or ubuntu-version-{32,64}
516 # or debian-version-{32,64}
517 # or centos-version-{32,64}
520 # @param debug True to build with debugging symbols (where possible)
521 def target_factory(s, debug, work):
523 if s.startswith('windows-'):
524 target = WindowsTarget(int(s.split('-')[1]), work)
525 elif s.startswith('ubuntu-') or s.startswith('debian-') or s.startswith('centos-'):
528 print >>sys.stderr,"Bad Linux target name `%s'; must be something like ubuntu-12.04-32 (i.e. distro-version-bits)" % s
530 target = LinuxTarget(p[0], p[1], int(p[2]), work)
531 elif s == 'raspbian':
532 target = LinuxTarget(s, None, None, work)
533 elif s.startswith('osx-'):
534 target = OSXSingleTarget(int(s.split('-')[1]), work)
536 if globals.command == 'build':
537 target = OSXSingleTarget(64, work)
539 target = OSXUniversalTarget(work)
541 target = SourceTarget()
543 if target is not None:
554 """Description of a tree, which is a checkout of a project,
555 possibly built. This class is never exposed to cscripts.
557 name -- name of git repository (without the .git)
558 specifier -- git tag or revision to use
559 target --- target object that we are using
560 version --- version from the wscript (if one is present)
561 git_commit -- git revision that is actually being used
562 built --- true if the tree has been built yet in this run
565 def __init__(self, name, specifier, target):
567 self.specifier = specifier
570 self.git_commit = None
579 redirect = '>/dev/null'
580 command('git clone %s %s/%s.git %s/src/%s' % (flags, config.get('git_prefix'), self.name, target.directory, self.name))
581 os.chdir('%s/src/%s' % (target.directory, self.name))
583 spec = self.specifier
587 command('git checkout %s %s %s' % (flags, spec, redirect))
588 self.git_commit = command_and_read('git rev-parse --short=7 HEAD').readline().strip()
589 command('git submodule init --quiet')
590 command('git submodule update --quiet')
592 proj = '%s/src/%s' % (target.directory, self.name)
595 execfile('%s/cscript' % proj, self.cscript)
597 if os.path.exists('%s/wscript' % proj):
598 v = read_wscript_variable(proj, "VERSION");
600 self.version = Version(v)
604 def call(self, function, *args):
605 with TreeDirectory(self):
606 return self.cscript[function](self.target, *args)
608 def build_dependencies(self):
609 if 'dependencies' in self.cscript:
610 for d in self.cscript['dependencies'](self.target):
611 log('Building dependency %s %s of %s' % (d[0], d[1], self.name))
612 dep = globals.trees.get(d[0], d[1], self.target)
613 dep.build_dependencies()
615 # Make the options to pass in from the option_defaults of the thing
616 # we are building and any options specified by the parent.
618 if 'option_defaults' in dep.cscript:
619 options = dep.cscript['option_defaults']()
621 for k, v in d[2].iteritems():
626 def build(self, options=None):
630 variables = copy.copy(self.target.variables)
632 if len(inspect.getargspec(self.cscript['build']).args) == 2:
633 self.call('build', options)
637 self.target.variables = variables
641 # Command-line parser
647 "build": "build project",
648 "package": "package and build project",
649 "release": "release a project using its next version number (changing wscript and tagging)",
650 "pot": "build the project's .pot files",
651 "changelog": "generate a simple HTML changelog",
652 "manual": "build the project's manual",
653 "doxygen": "build the project's Doxygen documentation",
654 "latest": "print out the latest version",
655 "test": "run the project's unit tests",
656 "shell": "build the project then start a shell in its chroot",
657 "checkout": "check out the project",
658 "revision": "print the head git revision number"
661 one_of = "Command is one of:\n"
663 for k, v in commands.iteritems():
664 one_of += "\t%s\t%s\n" % (k, v)
667 parser = argparse.ArgumentParser()
668 parser.add_argument('command', help=summary)
669 parser.add_argument('-p', '--project', help='project name')
670 parser.add_argument('--minor', help='minor version number bump', action='store_true')
671 parser.add_argument('--micro', help='micro version number bump', action='store_true')
672 parser.add_argument('--major', help='major version to return with latest', type=int)
673 parser.add_argument('-c', '--checkout', help='string to pass to git for checkout')
674 parser.add_argument('-o', '--output', help='output directory', default='.')
675 parser.add_argument('-q', '--quiet', help='be quiet', action='store_true')
676 parser.add_argument('-t', '--target', help='target')
677 parser.add_argument('-k', '--keep', help='keep working tree', action='store_true')
678 parser.add_argument('--debug', help='build with debugging symbols where possible', action='store_true')
679 parser.add_argument('-w', '--work', help='override default work directory')
680 parser.add_argument('-g', '--git-prefix', help='override configured git prefix')
681 args = parser.parse_args()
683 # Override configured stuff
684 if args.git_prefix is not None:
685 config.set('git_prefix', args.git_prefix)
687 if args.output.find(':') == -1:
688 # This isn't of the form host:path so make it absolute
689 args.output = os.path.abspath(args.output) + '/'
691 if args.output[-1] != ':' and args.output[-1] != '/':
694 # Now, args.output is 'host:', 'host:path/' or 'path/'
696 if args.work is not None:
697 args.work = os.path.abspath(args.work)
699 if args.project is None and args.command != 'shell':
700 raise Error('you must specify -p or --project')
702 globals.quiet = args.quiet
703 globals.command = args.command
705 if not globals.command in commands:
706 e = 'command must be one of:\n' + one_of
707 raise Error('command must be one of:\n%s' % one_of)
709 if globals.command == 'build':
710 if args.target is None:
711 raise Error('you must specify -t or --target')
713 target = target_factory(args.target, args.debug, args.work)
714 tree = globals.trees.get(args.project, args.checkout, target)
715 tree.build_dependencies()
720 elif globals.command == 'package':
721 if args.target is None:
722 raise Error('you must specify -t or --target')
724 target = target_factory(args.target, args.debug, args.work)
725 packages, git_commit = target.package(args.project, args.checkout)
726 if hasattr(packages, 'strip') or (not hasattr(packages, '__getitem__') and not hasattr(packages, '__iter__')):
727 packages = [packages]
729 if target.platform == 'linux':
730 out = '%s%s-%s-%d' % (args.output, target.distro, target.version, target.bits)
736 copyfile(p, '%s/%s' % (out, os.path.basename(devel_to_git(git_commit, p))))
739 makedirs(args.output)
743 copyfile(p, '%s%s' % (args.output, os.path.basename(devel_to_git(git_commit, p))))
748 elif globals.command == 'release':
749 if args.minor is False and args.micro is False:
750 raise Error('you must specify --minor or --micro')
752 target = SourceTarget()
753 tree = globals.trees.get(args.project, args.checkout, target)
755 version = tree.version
762 set_version_in_wscript(version)
763 append_version_to_changelog(version)
764 append_version_to_debian_changelog(version)
766 command('git commit -a -m "Bump version"')
767 command('git tag -m "v%s" v%s' % (version, version))
770 set_version_in_wscript(version)
771 command('git commit -a -m "Bump version"')
773 command('git push --tags')
777 elif globals.command == 'pot':
778 target = SourceTarget()
779 tree = globals.trees.get(args.project, args.checkout, target)
781 pots = tree.call('make_pot')
783 copyfile(p, '%s%s' % (args.output, os.path.basename(p)))
787 elif globals.command == 'changelog':
788 target = SourceTarget()
789 tree = globals.trees.get(args.project, args.checkout, target)
791 with TreeDirectory(tree):
792 text = open('ChangeLog', 'r')
794 html = tempfile.NamedTemporaryFile()
805 if len(l) > 0 and l[0] == "\t":
807 if len(s) == 4 and s[1] == "Version" and s[3] == "released.":
810 if last is not None and len(changes) > 0:
811 print >>html,"<h2>Changes between version %s and %s</h2>" % (s[2], last)
814 print >>html,"<li>%s" % c
825 changes.append(c[2:])
827 changes[-1] += " " + c
829 copyfile(html.file, '%schangelog.html' % args.output)
833 elif globals.command == 'manual':
834 target = SourceTarget()
835 tree = globals.trees.get(args.project, args.checkout, target)
837 outs = tree.call('make_manual')
839 if os.path.isfile(o):
840 copyfile(o, '%s%s' % (args.output, os.path.basename(o)))
842 copytree(o, '%s%s' % (args.output, os.path.basename(o)))
846 elif globals.command == 'doxygen':
847 target = SourceTarget()
848 tree = globals.trees.get(args.project, args.checkout, target)
850 dirs = tree.call('make_doxygen')
851 if hasattr(dirs, 'strip') or (not hasattr(dirs, '__getitem__') and not hasattr(dirs, '__iter__')):
855 copytree(d, args.output)
859 elif globals.command == 'latest':
860 target = SourceTarget()
861 tree = globals.trees.get(args.project, args.checkout, target)
863 with TreeDirectory(tree):
864 f = command_and_read('git log --tags --simplify-by-decoration --pretty="%d"')
866 while latest is None:
868 m = re.compile(".*\((.*)\).*").match(t)
870 tags = m.group(1).split(', ')
875 if len(t) > 0 and t[0] == 'v':
877 if args.major is None or v.major == args.major:
883 elif globals.command == 'test':
884 if args.target is None:
885 raise Error('you must specify -t or --target')
889 target = target_factory(args.target, args.debug, args.work)
890 tree = globals.trees.get(args.project, args.checkout, target)
891 with TreeDirectory(tree):
894 if target is not None:
898 if target is not None:
901 elif globals.command == 'shell':
902 if args.target is None:
903 raise Error('you must specify -t or --target')
905 target = target_factory(args.target, args.debug, args.work)
906 target.command('bash')
908 elif globals.command == 'revision':
910 target = SourceTarget()
911 tree = globals.trees.get(args.project, args.checkout, target)
912 with TreeDirectory(tree):
913 print command_and_read('git rev-parse HEAD').readline().strip()[:7]
916 elif globals.command == 'checkout':
918 if args.output is None:
919 raise Error('you must specify -o or --output')
921 target = SourceTarget()
922 tree = globals.trees.get(args.project, args.checkout, target)
923 with TreeDirectory(tree):
924 shutil.copytree('.', args.output)
928 raise Error('invalid command %s' % globals.command)
933 print >>sys.stderr,'cdist: %s' % str(e)