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):
336 tree.build_dependencies()
338 return tree.call('test')
341 self.variables[a] = b
344 del(self.variables[a])
347 return self.variables[a]
349 def append_with_space(self, k, v):
350 if (not k in self.variables) or len(self.variables[k]) == 0:
351 self.variables[k] = '"%s"' % v
353 e = self.variables[k]
354 if e[0] == '"' and e[-1] == '"':
355 self.variables[k] = '"%s %s"' % (e[1:-1], v)
357 self.variables[k] = '"%s %s"' % (e, v)
359 def variables_string(self, escaped_quotes=False):
361 for k, v in self.variables.items():
363 v = v.replace('"', '\\"')
364 e += '%s=%s ' % (k, v)
369 rmtree(self.directory)
375 class WindowsTarget(Target):
376 def __init__(self, bits, directory=None):
377 super(WindowsTarget, self).__init__('windows', directory)
380 self.windows_prefix = '%s/%d' % (config.get('windows_environment_prefix'), self.bits)
381 if not os.path.exists(self.windows_prefix):
382 raise Error('windows prefix %s does not exist' % self.windows_prefix)
385 self.mingw_name = 'i686'
387 self.mingw_name = 'x86_64'
389 self.mingw_path = '%s/%d/bin' % (config.get('mingw_prefix'), self.bits)
390 self.mingw_prefixes = ['/%s/%d' % (config.get('mingw_prefix'), self.bits), '%s/%d/%s-w64-mingw32' % (config.get('mingw_prefix'), bits, self.mingw_name)]
392 self.set('PKG_CONFIG_LIBDIR', '%s/lib/pkgconfig' % self.windows_prefix)
393 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/bin/pkgconfig' % (self.directory, self.directory))
394 self.set('PATH', '%s/bin:%s:%s' % (self.windows_prefix, self.mingw_path, os.environ['PATH']))
395 self.set('CC', '%s-w64-mingw32-gcc' % self.mingw_name)
396 self.set('CXX', '%s-w64-mingw32-g++' % self.mingw_name)
397 self.set('LD', '%s-w64-mingw32-ld' % self.mingw_name)
398 self.set('RANLIB', '%s-w64-mingw32-ranlib' % self.mingw_name)
399 self.set('WINRC', '%s-w64-mingw32-windres' % self.mingw_name)
400 cxx = '-I%s/include -I%s/include' % (self.windows_prefix, self.directory)
401 link = '-L%s/lib -L%s/lib' % (self.windows_prefix, self.directory)
402 for p in self.mingw_prefixes:
403 cxx += ' -I%s/include' % p
404 link += ' -L%s/lib' % p
405 self.set('CXXFLAGS', '"%s"' % cxx)
406 self.set('CPPFLAGS', '')
407 self.set('LINKFLAGS', '"%s"' % link)
408 self.set('LDFLAGS', '"%s"' % link)
410 def command(self, c):
411 log('host -> %s' % c)
412 command('%s %s' % (self.variables_string(), c))
414 class LinuxTarget(Target):
415 """Parent for Linux targets"""
416 def __init__(self, distro, version, bits, directory=None):
417 super(LinuxTarget, self).__init__('linux', directory)
419 self.version = version
422 self.set('CXXFLAGS', '-I%s/include' % self.directory)
423 self.set('CPPFLAGS', '')
424 self.set('LINKFLAGS', '-L%s/lib' % self.directory)
425 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/lib64/pkgconfig:/usr/local/lib/pkgconfig' % (self.directory, self.directory))
426 self.set('PATH', '/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin')
428 class ChrootTarget(LinuxTarget):
429 """Build in a chroot"""
430 def __init__(self, distro, version, bits, directory=None):
431 super(ChrootTarget, self).__init__(distro, version, bits, directory)
432 # e.g. ubuntu-14.04-64
433 if self.version is not None and self.bits is not None:
434 self.chroot = '%s-%s-%d' % (self.distro, self.version, self.bits)
436 self.chroot = self.distro
437 # e.g. /home/carl/Environments/ubuntu-14.04-64
438 self.chroot_prefix = '%s/%s' % (config.get('linux_chroot_prefix'), self.chroot)
440 def command(self, c):
441 command('%s schroot -c %s -p -- %s' % (self.variables_string(), self.chroot, c))
444 class HostTarget(LinuxTarget):
445 """Build directly on the host"""
446 def __init__(self, distro, version, bits, directory=None):
447 super(HostTarget, self).__init__(distro, version, bits, directory)
449 def command(self, c):
450 command('%s %s' % (self.variables_string(), c))
456 class OSXTarget(Target):
457 def __init__(self, directory=None):
458 super(OSXTarget, self).__init__('osx', directory)
459 self.sdk = config.get('osx_sdk')
460 self.sdk_prefix = config.get('osx_sdk_prefix')
462 def command(self, c):
463 command('%s %s' % (self.variables_string(False), c))
466 class OSXSingleTarget(OSXTarget):
467 def __init__(self, bits, directory=None):
468 super(OSXSingleTarget, self).__init__(directory)
476 flags = '-isysroot %s/MacOSX%s.sdk -arch %s' % (self.sdk_prefix, self.sdk, arch)
477 enviro = '%s/%d' % (config.get('osx_environment_prefix'), bits)
479 # Environment variables
480 self.set('CFLAGS', '"-I%s/include -I%s/include %s"' % (self.directory, enviro, flags))
481 self.set('CPPFLAGS', '')
482 self.set('CXXFLAGS', '"-I%s/include -I%s/include %s"' % (self.directory, enviro, flags))
483 self.set('LDFLAGS', '"-L%s/lib -L%s/lib %s"' % (self.directory, enviro, flags))
484 self.set('LINKFLAGS', '"-L%s/lib -L%s/lib %s"' % (self.directory, enviro, flags))
485 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/lib/pkgconfig:/usr/lib/pkgconfig' % (self.directory, enviro))
486 self.set('PATH', '$PATH:/usr/bin:/sbin:/usr/local/bin:%s/bin' % enviro)
487 self.set('MACOSX_DEPLOYMENT_TARGET', config.get('osx_sdk'))
489 def package(self, project, checkout):
490 raise Error('cannot package non-universal OS X versions')
493 class OSXUniversalTarget(OSXTarget):
494 def __init__(self, directory=None):
495 super(OSXUniversalTarget, self).__init__(directory)
497 def package(self, project, checkout):
500 target = OSXSingleTarget(b, os.path.join(self.directory, '%d' % b))
501 tree = globals.trees.get(project, checkout, target)
502 tree.build_dependencies()
505 tree = globals.trees.get(project, checkout, self)
506 with TreeDirectory(tree):
507 return tree.call('package', tree.version), tree.git_commit
509 class SourceTarget(Target):
510 """Build a source .tar.bz2"""
512 super(SourceTarget, self).__init__('source')
514 def command(self, c):
515 log('host -> %s' % c)
516 command('%s %s' % (self.variables_string(), c))
519 rmtree(self.directory)
521 def package(self, project, checkout):
522 tree = globals.trees.get(project, checkout, self)
523 with TreeDirectory(tree):
524 name = read_wscript_variable(os.getcwd(), 'APPNAME')
525 command('./waf dist')
526 return os.path.abspath('%s-%s.tar.bz2' % (name, tree.version)), tree.git_commit
529 # @param s Target string:
531 # or ubuntu-version-{32,64}
532 # or debian-version-{32,64}
533 # or centos-version-{32,64}
536 # @param debug True to build with debugging symbols (where possible)
537 def target_factory(s, debug, work):
539 if s.startswith('windows-'):
540 target = WindowsTarget(int(s.split('-')[1]), work)
541 elif s.startswith('ubuntu-') or s.startswith('debian-') or s.startswith('centos-'):
544 raise Error("Bad Linux target name `%s'; must be something like ubuntu-12.04-32 (i.e. distro-version-bits)" % s)
545 target = ChrootTarget(p[0], p[1], int(p[2]), work)
546 elif s.startswith('arch-'):
549 raise Error("Bad Arch target name `%s'; must be arch-32 or arch-64")
550 target = ChrootTarget(p[0], None, p[1], work)
551 elif s == 'raspbian':
552 target = ChrootTarget(s, None, None, work)
554 if command_and_read('uname -m').read().strip() == 'x86_64':
559 f = open('/etc/fedora-release', 'r')
560 l = f.readline().strip().split()
561 target = HostTarget("fedora", l[2], bits, work)
562 except Exception as e:
563 if os.path.exists('/etc/arch-release'):
564 target = HostTarget("arch", None, bits, work)
566 raise Error("could not identify distribution for `host' target (%s)" % e)
567 elif s.startswith('osx-'):
568 target = OSXSingleTarget(int(s.split('-')[1]), work)
570 if globals.command == 'build':
571 target = OSXSingleTarget(64, work)
573 target = OSXUniversalTarget(work)
575 target = SourceTarget()
578 raise Error("Bad target `%s'" % s)
589 """Description of a tree, which is a checkout of a project,
590 possibly built. This class is never exposed to cscripts.
592 name -- name of git repository (without the .git)
593 specifier -- git tag or revision to use
594 target --- target object that we are using
595 version --- version from the wscript (if one is present)
596 git_commit -- git revision that is actually being used
597 built --- true if the tree has been built yet in this run
600 def __init__(self, name, specifier, target):
602 self.specifier = specifier
605 self.git_commit = None
614 redirect = '>/dev/null'
615 command('git clone %s %s/%s.git %s/src/%s' % (flags, config.get('git_prefix'), self.name, target.directory, self.name))
616 os.chdir('%s/src/%s' % (target.directory, self.name))
618 spec = self.specifier
622 command('git checkout %s %s %s' % (flags, spec, redirect))
623 self.git_commit = command_and_read('git rev-parse --short=7 HEAD').readline().strip()
624 command('git submodule init --quiet')
625 command('git submodule update --quiet')
627 proj = '%s/src/%s' % (target.directory, self.name)
630 exec(open('%s/cscript' % proj).read(), self.cscript)
632 if os.path.exists('%s/wscript' % proj):
633 v = read_wscript_variable(proj, "VERSION");
635 self.version = Version(v)
639 def call(self, function, *args):
640 with TreeDirectory(self):
641 return self.cscript[function](self.target, *args)
643 def build_dependencies(self, options=None):
644 if 'dependencies' in self.cscript:
645 if len(inspect.getargspec(self.cscript['dependencies']).args) == 2:
646 deps = self.call('dependencies', options)
648 deps = self.call('dependencies')
651 log('Building dependency %s %s of %s' % (d[0], d[1], self.name))
652 dep = globals.trees.get(d[0], d[1], self.target)
654 # Make the options to pass in from the option_defaults of the thing
655 # we are building and any options specified by the parent.
657 if 'option_defaults' in dep.cscript:
658 options = dep.cscript['option_defaults']()
660 for k, v in d[2].items():
663 dep.build_dependencies(options)
666 def build(self, options=None):
670 variables = copy.copy(self.target.variables)
672 if len(inspect.getargspec(self.cscript['build']).args) == 2:
673 self.call('build', options)
677 self.target.variables = variables
681 # Command-line parser
687 "build": "build project",
688 "package": "package and build project",
689 "release": "release a project using its next version number (changing wscript and tagging)",
690 "pot": "build the project's .pot files",
691 "changelog": "generate a simple HTML changelog",
692 "manual": "build the project's manual",
693 "doxygen": "build the project's Doxygen documentation",
694 "latest": "print out the latest version",
695 "test": "run the project's unit tests",
696 "shell": "build the project then start a shell in its chroot",
697 "checkout": "check out the project",
698 "revision": "print the head git revision number"
701 one_of = "Command is one of:\n"
703 for k, v in commands.items():
704 one_of += "\t%s\t%s\n" % (k, v)
707 parser = argparse.ArgumentParser()
708 parser.add_argument('command', help=summary)
709 parser.add_argument('-p', '--project', help='project name')
710 parser.add_argument('--minor', help='minor version number bump', action='store_true')
711 parser.add_argument('--micro', help='micro version number bump', action='store_true')
712 parser.add_argument('--major', help='major version to return with latest', type=int)
713 parser.add_argument('-c', '--checkout', help='string to pass to git for checkout')
714 parser.add_argument('-o', '--output', help='output directory', default='.')
715 parser.add_argument('-q', '--quiet', help='be quiet', action='store_true')
716 parser.add_argument('-t', '--target', help='target')
717 parser.add_argument('-k', '--keep', help='keep working tree', action='store_true')
718 parser.add_argument('--debug', help='build with debugging symbols where possible', action='store_true')
719 parser.add_argument('-w', '--work', help='override default work directory')
720 parser.add_argument('-g', '--git-prefix', help='override configured git prefix')
721 args = parser.parse_args()
723 # Override configured stuff
724 if args.git_prefix is not None:
725 config.set('git_prefix', args.git_prefix)
727 if args.output.find(':') == -1:
728 # This isn't of the form host:path so make it absolute
729 args.output = os.path.abspath(args.output) + '/'
731 if args.output[-1] != ':' and args.output[-1] != '/':
734 # Now, args.output is 'host:', 'host:path/' or 'path/'
736 if args.work is not None:
737 args.work = os.path.abspath(args.work)
739 if args.project is None and args.command != 'shell':
740 raise Error('you must specify -p or --project')
742 globals.quiet = args.quiet
743 globals.command = args.command
745 if not globals.command in commands:
746 e = 'command must be one of:\n' + one_of
747 raise Error('command must be one of:\n%s' % one_of)
749 if globals.command == 'build':
750 if args.target is None:
751 raise Error('you must specify -t or --target')
753 target = target_factory(args.target, args.debug, args.work)
754 tree = globals.trees.get(args.project, args.checkout, target)
755 tree.build_dependencies()
760 elif globals.command == 'package':
761 if args.target is None:
762 raise Error('you must specify -t or --target')
764 target = target_factory(args.target, args.debug, args.work)
765 packages, git_commit = target.package(args.project, args.checkout)
766 if hasattr(packages, 'strip') or (not hasattr(packages, '__getitem__') and not hasattr(packages, '__iter__')):
767 packages = [packages]
769 if target.platform == 'linux':
770 out = '%s%s-%s-%d' % (args.output, target.distro, target.version, target.bits)
776 copyfile(p, '%s/%s' % (out, os.path.basename(devel_to_git(git_commit, p))))
779 makedirs(args.output)
783 copyfile(p, '%s%s' % (args.output, os.path.basename(devel_to_git(git_commit, p))))
788 elif globals.command == 'release':
789 if args.minor is False and args.micro is False:
790 raise Error('you must specify --minor or --micro')
792 target = SourceTarget()
793 tree = globals.trees.get(args.project, args.checkout, target)
795 version = tree.version
802 set_version_in_wscript(version)
803 append_version_to_changelog(version)
804 append_version_to_debian_changelog(version)
806 command('git commit -a -m "Bump version"')
807 command('git tag -m "v%s" v%s' % (version, version))
810 set_version_in_wscript(version)
811 command('git commit -a -m "Bump version"')
813 command('git push --tags')
817 elif globals.command == 'pot':
818 target = SourceTarget()
819 tree = globals.trees.get(args.project, args.checkout, target)
821 pots = tree.call('make_pot')
823 copyfile(p, '%s%s' % (args.output, os.path.basename(p)))
827 elif globals.command == 'changelog':
828 target = SourceTarget()
829 tree = globals.trees.get(args.project, args.checkout, target)
831 with TreeDirectory(tree):
832 text = open('ChangeLog', 'r')
834 html = tempfile.NamedTemporaryFile()
845 if len(l) > 0 and l[0] == "\t":
847 if len(s) == 4 and s[1] == "Version" and s[3] == "released.":
850 if last is not None and len(changes) > 0:
851 print("<h2>Changes between version %s and %s</h2>" % (s[2], last), file=html)
852 print("<ul>", file=html)
854 print("<li>%s" % c, file=html)
855 print("</ul>", file=html)
865 changes.append(c[2:])
867 changes[-1] += " " + c
869 copyfile(html.file, '%schangelog.html' % args.output)
873 elif globals.command == 'manual':
874 target = SourceTarget()
875 tree = globals.trees.get(args.project, args.checkout, target)
877 outs = tree.call('make_manual')
879 if os.path.isfile(o):
880 copyfile(o, '%s%s' % (args.output, os.path.basename(o)))
882 copytree(o, '%s%s' % (args.output, os.path.basename(o)))
886 elif globals.command == 'doxygen':
887 target = SourceTarget()
888 tree = globals.trees.get(args.project, args.checkout, target)
890 dirs = tree.call('make_doxygen')
891 if hasattr(dirs, 'strip') or (not hasattr(dirs, '__getitem__') and not hasattr(dirs, '__iter__')):
895 copytree(d, args.output)
899 elif globals.command == 'latest':
900 target = SourceTarget()
901 tree = globals.trees.get(args.project, args.checkout, target)
903 with TreeDirectory(tree):
904 f = command_and_read('git log --tags --simplify-by-decoration --pretty="%d"')
906 while latest is None:
908 m = re.compile(".*\((.*)\).*").match(t)
910 tags = m.group(1).split(', ')
915 if len(t) > 0 and t[0] == 'v':
917 if args.major is None or v.major == args.major:
923 elif globals.command == 'test':
924 if args.target is None:
925 raise Error('you must specify -t or --target')
929 target = target_factory(args.target, args.debug, args.work)
930 tree = globals.trees.get(args.project, args.checkout, target)
931 with TreeDirectory(tree):
934 if target is not None:
938 if target is not None:
941 elif globals.command == 'shell':
942 if args.target is None:
943 raise Error('you must specify -t or --target')
945 target = target_factory(args.target, args.debug, args.work)
946 target.command('bash')
948 elif globals.command == 'revision':
950 target = SourceTarget()
951 tree = globals.trees.get(args.project, args.checkout, target)
952 with TreeDirectory(tree):
953 print(command_and_read('git rev-parse HEAD').readline().strip()[:7])
956 elif globals.command == 'checkout':
958 if args.output is None:
959 raise Error('you must specify -o or --output')
961 target = SourceTarget()
962 tree = globals.trees.get(args.project, args.checkout, target)
963 with TreeDirectory(tree):
964 shutil.copytree('.', args.output)
968 raise Error('invalid command %s' % globals.command)
973 print('cdist: %s' % str(e), file=sys.stderr)