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.
19 from __future__ import print_function
32 TEMPORARY_DIRECTORY = '/var/tmp'
34 class Error(Exception):
35 def __init__(self, value):
44 Store for Tree objects which re-uses already-created objects
45 and checks for requests for different versions of the same thing.
51 def get(self, name, specifier, target):
53 if t.name == name and t.specifier == specifier and t.target == target:
55 elif t.name == name and t.specifier != specifier:
56 raise Error('conflicting versions of %s requested (%s and %s)' % (name, specifier, t.specifier))
58 nt = Tree(name, specifier, target)
75 def __init__(self, key, default=None):
79 def offer(self, key, value):
83 class BoolOption(object):
84 def __init__(self, key):
88 def offer(self, key, value):
90 self.value = (value == 'yes' or value == '1' or value == 'true')
94 self.options = [ Option('linux_chroot_prefix'),
95 Option('windows_environment_prefix'),
96 Option('mingw_prefix'),
98 Option('osx_build_host'),
99 Option('osx_environment_prefix'),
100 Option('osx_sdk_prefix'),
102 Option('parallel', 4) ]
105 f = open('%s/.config/cdist' % os.path.expanduser('~'), 'r')
111 if len(l) > 0 and l[0] == '#':
114 s = l.strip().split()
116 for k in self.options:
122 for o in self.options:
126 raise Error('Required setting %s not found' % k)
129 for o in self.options:
139 if not globals.quiet:
140 print('\x1b[33m* %s\x1b[0m' % m)
144 assert(len(s) == 1 or len(s) == 2)
146 return '%s:"\'%s\'"' % (s[0], s[1])
148 return '\"%s\"' % s[0]
151 log('copy %s -> %s' % (scp_escape(b), scp_escape(b)))
152 command('scp -r %s %s' % (scp_escape(a), scp_escape(b)))
155 log('copy %s -> %s' % (scp_escape(a), scp_escape(b)))
156 command('scp %s %s' % (scp_escape(a), scp_escape(b)))
159 if d.find(':') == -1:
163 command('ssh %s -- mkdir -p %s' % (s[0], s[1]))
171 shutil.rmtree(a, ignore_errors=True)
177 raise Error('command %s failed' % c)
179 def command_and_read(c):
181 p = subprocess.Popen(c.split(), stdout=subprocess.PIPE)
182 f = os.fdopen(os.dup(p.stdout.fileno()))
185 def read_wscript_variable(directory, variable):
186 f = open('%s/wscript' % directory, 'r')
193 if len(s) == 3 and s[0] == variable:
200 def set_version_in_wscript(version):
201 f = open('wscript', 'rw')
202 o = open('wscript.tmp', 'w')
209 if len(s) == 3 and s[0] == "VERSION":
210 print("Writing %s" % version)
211 print("VERSION = '%s'" % version, file=o)
213 print(l, file=o, end="")
217 os.rename('wscript.tmp', 'wscript')
219 def append_version_to_changelog(version):
221 f = open('ChangeLog', 'r')
223 log('Could not open ChangeLog')
229 f = open('ChangeLog', 'w')
230 now = datetime.datetime.now()
231 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))
234 def append_version_to_debian_changelog(version):
235 if not os.path.exists('debian'):
236 log('Could not find debian directory')
239 command('dch -b -v %s-1 "New upstream release."' % version)
241 def devel_to_git(git_commit, filename):
242 if git_commit is not None:
243 filename = filename.replace('devel', '-%s' % git_commit)
247 def __init__(self, tree):
250 self.cwd = os.getcwd()
251 os.chdir('%s/src/%s' % (self.tree.target.directory, self.tree.name))
252 def __exit__(self, type, value, traceback):
260 def __init__(self, s):
263 if s.startswith("'"):
268 if s.endswith('devel'):
272 if s.endswith('pre'):
276 self.major = int(p[0])
277 self.minor = int(p[1])
279 self.micro = int(p[2])
283 def bump_minor(self):
287 def bump_micro(self):
293 def to_release(self):
297 s = '%d.%d.%d' % (self.major, self.minor, self.micro)
307 class Target(object):
309 platform -- platform string (e.g. 'windows', 'linux', 'osx')
310 directory -- directory to work in; if None we will use a temporary directory
311 Temporary directories will be removed after use; specified directories will not.
313 def __init__(self, platform, directory=None):
314 self.platform = platform
315 self.parallel = int(config.get('parallel'))
317 # self.directory is the working directory
318 if directory is None:
319 self.directory = tempfile.mkdtemp('', 'tmp', TEMPORARY_DIRECTORY)
322 self.directory = directory
325 # Environment variables that we will use when we call cscripts
329 def package(self, project, checkout):
330 tree = globals.trees.get(project, checkout, self)
331 tree.build_dependencies()
333 return tree.call('package', tree.version), tree.git_commit
335 def test(self, tree, test):
336 """test is the test case to run, or None"""
337 tree.build_dependencies()
339 return tree.call('test', test)
342 self.variables[a] = b
345 del(self.variables[a])
348 return self.variables[a]
350 def append_with_space(self, k, v):
351 if (not k in self.variables) or len(self.variables[k]) == 0:
352 self.variables[k] = '"%s"' % v
354 e = self.variables[k]
355 if e[0] == '"' and e[-1] == '"':
356 self.variables[k] = '"%s %s"' % (e[1:-1], v)
358 self.variables[k] = '"%s %s"' % (e, v)
360 def variables_string(self, escaped_quotes=False):
362 for k, v in self.variables.items():
364 v = v.replace('"', '\\"')
365 e += '%s=%s ' % (k, v)
370 rmtree(self.directory)
376 class WindowsTarget(Target):
377 def __init__(self, version, bits, directory=None):
378 super(WindowsTarget, self).__init__('windows', directory)
379 self.version = version
382 self.windows_prefix = '%s/%d' % (config.get('windows_environment_prefix'), self.bits)
383 if not os.path.exists(self.windows_prefix):
384 raise Error('windows prefix %s does not exist' % self.windows_prefix)
387 self.mingw_name = 'i686'
389 self.mingw_name = 'x86_64'
391 self.mingw_path = '%s/%d/bin' % (config.get('mingw_prefix'), self.bits)
392 self.mingw_prefixes = ['/%s/%d' % (config.get('mingw_prefix'), self.bits), '%s/%d/%s-w64-mingw32' % (config.get('mingw_prefix'), bits, self.mingw_name)]
394 self.set('PKG_CONFIG_LIBDIR', '%s/lib/pkgconfig' % self.windows_prefix)
395 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/bin/pkgconfig' % (self.directory, self.directory))
396 self.set('PATH', '%s/bin:%s:%s' % (self.windows_prefix, self.mingw_path, os.environ['PATH']))
397 self.set('CC', '%s-w64-mingw32-gcc' % self.mingw_name)
398 self.set('CXX', '%s-w64-mingw32-g++' % self.mingw_name)
399 self.set('LD', '%s-w64-mingw32-ld' % self.mingw_name)
400 self.set('RANLIB', '%s-w64-mingw32-ranlib' % self.mingw_name)
401 self.set('WINRC', '%s-w64-mingw32-windres' % self.mingw_name)
402 cxx = '-I%s/include -I%s/include' % (self.windows_prefix, self.directory)
403 link = '-L%s/lib -L%s/lib' % (self.windows_prefix, self.directory)
404 for p in self.mingw_prefixes:
405 cxx += ' -I%s/include' % p
406 link += ' -L%s/lib' % p
407 self.set('CXXFLAGS', '"%s"' % cxx)
408 self.set('CPPFLAGS', '')
409 self.set('LINKFLAGS', '"%s"' % link)
410 self.set('LDFLAGS', '"%s"' % link)
412 def command(self, c):
413 log('host -> %s' % c)
414 command('%s %s' % (self.variables_string(), c))
416 class LinuxTarget(Target):
417 """Parent for Linux targets"""
418 def __init__(self, distro, version, bits, directory=None):
419 super(LinuxTarget, self).__init__('linux', directory)
421 self.version = version
424 self.set('CXXFLAGS', '-I%s/include' % self.directory)
425 self.set('CPPFLAGS', '')
426 self.set('LINKFLAGS', '-L%s/lib' % self.directory)
427 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/lib64/pkgconfig:/usr/local/lib/pkgconfig' % (self.directory, self.directory))
428 self.set('PATH', '/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin')
430 class ChrootTarget(LinuxTarget):
431 """Build in a chroot"""
432 def __init__(self, distro, version, bits, directory=None):
433 super(ChrootTarget, self).__init__(distro, version, bits, directory)
434 # e.g. ubuntu-14.04-64
435 if self.version is not None and self.bits is not None:
436 self.chroot = '%s-%s-%d' % (self.distro, self.version, self.bits)
438 self.chroot = self.distro
439 # e.g. /home/carl/Environments/ubuntu-14.04-64
440 self.chroot_prefix = '%s/%s' % (config.get('linux_chroot_prefix'), self.chroot)
442 def command(self, c):
443 command('%s schroot -c %s -p -- %s' % (self.variables_string(), self.chroot, c))
446 class HostTarget(LinuxTarget):
447 """Build directly on the host"""
448 def __init__(self, distro, version, bits, directory=None):
449 super(HostTarget, self).__init__(distro, version, bits, directory)
451 def command(self, c):
452 command('%s %s' % (self.variables_string(), c))
458 class OSXTarget(Target):
459 def __init__(self, directory=None):
460 super(OSXTarget, self).__init__('osx', directory)
461 self.sdk = config.get('osx_sdk')
462 self.sdk_prefix = config.get('osx_sdk_prefix')
464 def command(self, c):
465 command('%s %s' % (self.variables_string(False), c))
468 class OSXSingleTarget(OSXTarget):
469 def __init__(self, bits, directory=None):
470 super(OSXSingleTarget, self).__init__(directory)
478 flags = '-isysroot %s/MacOSX%s.sdk -arch %s' % (self.sdk_prefix, self.sdk, arch)
479 enviro = '%s/%d' % (config.get('osx_environment_prefix'), bits)
481 # Environment variables
482 self.set('CFLAGS', '"-I%s/include -I%s/include %s"' % (self.directory, enviro, flags))
483 self.set('CPPFLAGS', '')
484 self.set('CXXFLAGS', '"-I%s/include -I%s/include %s"' % (self.directory, enviro, flags))
485 self.set('LDFLAGS', '"-L%s/lib -L%s/lib %s"' % (self.directory, enviro, flags))
486 self.set('LINKFLAGS', '"-L%s/lib -L%s/lib %s"' % (self.directory, enviro, flags))
487 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/lib/pkgconfig:/usr/lib/pkgconfig' % (self.directory, enviro))
488 self.set('PATH', '$PATH:/usr/bin:/sbin:/usr/local/bin:%s/bin' % enviro)
489 self.set('MACOSX_DEPLOYMENT_TARGET', config.get('osx_sdk'))
491 def package(self, project, checkout):
492 raise Error('cannot package non-universal OS X versions')
495 class OSXUniversalTarget(OSXTarget):
496 def __init__(self, directory=None):
497 super(OSXUniversalTarget, self).__init__(directory)
499 def package(self, project, checkout):
502 target = OSXSingleTarget(b, os.path.join(self.directory, '%d' % b))
503 tree = globals.trees.get(project, checkout, target)
504 tree.build_dependencies()
507 tree = globals.trees.get(project, checkout, self)
508 with TreeDirectory(tree):
509 return tree.call('package', tree.version), tree.git_commit
511 class SourceTarget(Target):
512 """Build a source .tar.bz2"""
514 super(SourceTarget, self).__init__('source')
516 def command(self, c):
517 log('host -> %s' % c)
518 command('%s %s' % (self.variables_string(), c))
521 rmtree(self.directory)
523 def package(self, project, checkout):
524 tree = globals.trees.get(project, checkout, self)
525 with TreeDirectory(tree):
526 name = read_wscript_variable(os.getcwd(), 'APPNAME')
527 command('./waf dist')
528 return os.path.abspath('%s-%s.tar.bz2' % (name, tree.version)), tree.git_commit
531 # @param s Target string:
533 # or ubuntu-version-{32,64}
534 # or debian-version-{32,64}
535 # or centos-version-{32,64}
538 # @param debug True to build with debugging symbols (where possible)
539 def target_factory(s, debug, work):
541 if s.startswith('windows-'):
544 target = WindowsTarget(None, int(x[1]), work)
546 target = WindowsTarget(x[1], int(x[2]), work)
548 raise Error("Bad Windows target name `%s'")
549 elif s.startswith('ubuntu-') or s.startswith('debian-') or s.startswith('centos-'):
552 raise Error("Bad Linux target name `%s'; must be something like ubuntu-12.04-32 (i.e. distro-version-bits)" % s)
553 target = ChrootTarget(p[0], p[1], int(p[2]), work)
554 elif s.startswith('arch-'):
557 raise Error("Bad Arch target name `%s'; must be arch-32 or arch-64")
558 target = ChrootTarget(p[0], None, p[1], work)
559 elif s == 'raspbian':
560 target = ChrootTarget(s, None, None, work)
562 if command_and_read('uname -m').read().strip() == 'x86_64':
567 f = open('/etc/fedora-release', 'r')
568 l = f.readline().strip().split()
569 target = HostTarget("fedora", l[2], bits, work)
570 except Exception as e:
571 if os.path.exists('/etc/arch-release'):
572 target = HostTarget("arch", None, bits, work)
574 raise Error("could not identify distribution for `host' target (%s)" % e)
575 elif s.startswith('osx-'):
576 target = OSXSingleTarget(int(s.split('-')[1]), work)
578 if globals.command == 'build':
579 target = OSXSingleTarget(64, work)
581 target = OSXUniversalTarget(work)
583 target = SourceTarget()
586 raise Error("Bad target `%s'" % s)
597 """Description of a tree, which is a checkout of a project,
598 possibly built. This class is never exposed to cscripts.
600 name -- name of git repository (without the .git)
601 specifier -- git tag or revision to use
602 target --- target object that we are using
603 version --- version from the wscript (if one is present)
604 git_commit -- git revision that is actually being used
605 built --- true if the tree has been built yet in this run
608 def __init__(self, name, specifier, target):
610 self.specifier = specifier
613 self.git_commit = None
622 redirect = '>/dev/null'
623 command('git clone %s %s/%s.git %s/src/%s' % (flags, config.get('git_prefix'), self.name, target.directory, self.name))
624 os.chdir('%s/src/%s' % (target.directory, self.name))
626 spec = self.specifier
630 command('git checkout %s %s %s' % (flags, spec, redirect))
631 self.git_commit = command_and_read('git rev-parse --short=7 HEAD').readline().strip()
632 command('git submodule init --quiet')
633 command('git submodule update --quiet')
635 proj = '%s/src/%s' % (target.directory, self.name)
638 exec(open('%s/cscript' % proj).read(), self.cscript)
640 if os.path.exists('%s/wscript' % proj):
641 v = read_wscript_variable(proj, "VERSION");
643 self.version = Version(v)
647 def call(self, function, *args):
648 with TreeDirectory(self):
649 return self.cscript[function](self.target, *args)
651 def build_dependencies(self):
652 if 'dependencies' in self.cscript:
653 for d in self.cscript['dependencies'](self.target):
654 log('Building dependency %s %s of %s' % (d[0], d[1], self.name))
655 dep = globals.trees.get(d[0], d[1], self.target)
656 dep.build_dependencies()
658 # Make the options to pass in from the option_defaults of the thing
659 # we are building and any options specified by the parent.
661 if 'option_defaults' in dep.cscript:
662 options = dep.cscript['option_defaults']()
664 for k, v in d[2].items():
669 def build(self, options=None):
673 variables = copy.copy(self.target.variables)
675 if len(inspect.getargspec(self.cscript['build']).args) == 2:
676 self.call('build', options)
680 self.target.variables = variables
684 # Command-line parser
690 "build": "build project",
691 "package": "package and build project",
692 "release": "release a project using its next version number (changing wscript and tagging)",
693 "pot": "build the project's .pot files",
694 "changelog": "generate a simple HTML changelog",
695 "manual": "build the project's manual",
696 "doxygen": "build the project's Doxygen documentation",
697 "latest": "print out the latest version",
698 "test": "run the project's unit tests",
699 "shell": "build the project then start a shell in its chroot",
700 "checkout": "check out the project",
701 "revision": "print the head git revision number"
704 one_of = "Command is one of:\n"
706 for k, v in commands.items():
707 one_of += "\t%s\t%s\n" % (k, v)
710 parser = argparse.ArgumentParser()
711 parser.add_argument('command', help=summary)
712 parser.add_argument('-p', '--project', help='project name')
713 parser.add_argument('--minor', help='minor version number bump', action='store_true')
714 parser.add_argument('--micro', help='micro version number bump', action='store_true')
715 parser.add_argument('--major', help='major version to return with latest', type=int)
716 parser.add_argument('-c', '--checkout', help='string to pass to git for checkout')
717 parser.add_argument('-o', '--output', help='output directory', default='.')
718 parser.add_argument('-q', '--quiet', help='be quiet', action='store_true')
719 parser.add_argument('-t', '--target', help='target')
720 parser.add_argument('-k', '--keep', help='keep working tree', action='store_true')
721 parser.add_argument('--debug', help='build with debugging symbols where possible', action='store_true')
722 parser.add_argument('-w', '--work', help='override default work directory')
723 parser.add_argument('-g', '--git-prefix', help='override configured git prefix')
724 parser.add_argument('--test', help='name of test to run (with `test''), defaults to all')
725 args = parser.parse_args()
727 # Override configured stuff
728 if args.git_prefix is not None:
729 config.set('git_prefix', args.git_prefix)
731 if args.output.find(':') == -1:
732 # This isn't of the form host:path so make it absolute
733 args.output = os.path.abspath(args.output) + '/'
735 if args.output[-1] != ':' and args.output[-1] != '/':
738 # Now, args.output is 'host:', 'host:path/' or 'path/'
740 if args.work is not None:
741 args.work = os.path.abspath(args.work)
743 if args.project is None and args.command != 'shell':
744 raise Error('you must specify -p or --project')
746 globals.quiet = args.quiet
747 globals.command = args.command
749 if not globals.command in commands:
750 e = 'command must be one of:\n' + one_of
751 raise Error('command must be one of:\n%s' % one_of)
753 if globals.command == 'build':
754 if args.target is None:
755 raise Error('you must specify -t or --target')
757 target = target_factory(args.target, args.debug, args.work)
758 tree = globals.trees.get(args.project, args.checkout, target)
759 tree.build_dependencies()
764 elif globals.command == 'package':
765 if args.target is None:
766 raise Error('you must specify -t or --target')
768 target = target_factory(args.target, args.debug, args.work)
769 packages, git_commit = target.package(args.project, args.checkout)
770 if hasattr(packages, 'strip') or (not hasattr(packages, '__getitem__') and not hasattr(packages, '__iter__')):
771 packages = [packages]
773 if target.platform == 'linux':
774 out = '%s%s-%s-%d' % (args.output, target.distro, target.version, target.bits)
780 copyfile(p, '%s/%s' % (out, os.path.basename(devel_to_git(git_commit, p))))
783 makedirs(args.output)
787 copyfile(p, '%s%s' % (args.output, os.path.basename(devel_to_git(git_commit, p))))
792 elif globals.command == 'release':
793 if args.minor is False and args.micro is False:
794 raise Error('you must specify --minor or --micro')
796 target = SourceTarget()
797 tree = globals.trees.get(args.project, args.checkout, target)
799 version = tree.version
806 set_version_in_wscript(version)
807 append_version_to_changelog(version)
808 append_version_to_debian_changelog(version)
810 command('git commit -a -m "Bump version"')
811 command('git tag -m "v%s" v%s' % (version, version))
814 set_version_in_wscript(version)
815 command('git commit -a -m "Bump version"')
817 command('git push --tags')
821 elif globals.command == 'pot':
822 target = SourceTarget()
823 tree = globals.trees.get(args.project, args.checkout, target)
825 pots = tree.call('make_pot')
827 copyfile(p, '%s%s' % (args.output, os.path.basename(p)))
831 elif globals.command == 'changelog':
832 target = SourceTarget()
833 tree = globals.trees.get(args.project, args.checkout, target)
835 with TreeDirectory(tree):
836 text = open('ChangeLog', 'r')
838 html = tempfile.NamedTemporaryFile()
849 if len(l) > 0 and l[0] == "\t":
851 if len(s) == 4 and s[1] == "Version" and s[3] == "released.":
854 if last is not None and len(changes) > 0:
855 print("<h2>Changes between version %s and %s</h2>" % (s[2], last), file=html)
856 print("<ul>", file=html)
858 print("<li>%s" % c, file=html)
859 print("</ul>", file=html)
869 changes.append(c[2:])
871 changes[-1] += " " + c
873 copyfile(html.file, '%schangelog.html' % args.output)
877 elif globals.command == 'manual':
878 target = SourceTarget()
879 tree = globals.trees.get(args.project, args.checkout, target)
881 outs = tree.call('make_manual')
883 if os.path.isfile(o):
884 copyfile(o, '%s%s' % (args.output, os.path.basename(o)))
886 copytree(o, '%s%s' % (args.output, os.path.basename(o)))
890 elif globals.command == 'doxygen':
891 target = SourceTarget()
892 tree = globals.trees.get(args.project, args.checkout, target)
894 dirs = tree.call('make_doxygen')
895 if hasattr(dirs, 'strip') or (not hasattr(dirs, '__getitem__') and not hasattr(dirs, '__iter__')):
899 copytree(d, args.output)
903 elif globals.command == 'latest':
904 target = SourceTarget()
905 tree = globals.trees.get(args.project, args.checkout, target)
907 with TreeDirectory(tree):
908 f = command_and_read('git log --tags --simplify-by-decoration --pretty="%d"')
910 while latest is None:
912 m = re.compile(".*\((.*)\).*").match(t)
914 tags = m.group(1).split(', ')
919 if len(t) > 0 and t[0] == 'v':
921 if args.major is None or v.major == args.major:
927 elif globals.command == 'test':
928 if args.target is None:
929 raise Error('you must specify -t or --target')
933 target = target_factory(args.target, args.debug, args.work)
934 tree = globals.trees.get(args.project, args.checkout, target)
935 with TreeDirectory(tree):
936 target.test(tree, args.test)
938 if target is not None:
942 if target is not None:
945 elif globals.command == 'shell':
946 if args.target is None:
947 raise Error('you must specify -t or --target')
949 target = target_factory(args.target, args.debug, args.work)
950 target.command('bash')
952 elif globals.command == 'revision':
954 target = SourceTarget()
955 tree = globals.trees.get(args.project, args.checkout, target)
956 with TreeDirectory(tree):
957 print(command_and_read('git rev-parse HEAD').readline().strip()[:7])
960 elif globals.command == 'checkout':
962 if args.output is None:
963 raise Error('you must specify -o or --output')
965 target = SourceTarget()
966 tree = globals.trees.get(args.project, args.checkout, target)
967 with TreeDirectory(tree):
968 shutil.copytree('.', args.output)
972 raise Error('invalid command %s' % globals.command)
977 print('cdist: %s' % str(e), file=sys.stderr)