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) or len(self.variables[k]) == 0:
350 self.variables[k] = v
352 e = self.variables[k]
353 if e[0] == '"' and e[-1] == '"':
354 self.variables[k] = '"%s %s"' % (e[1:-1], v)
356 self.variables[k] = '%s %s' % (e, v)
358 def variables_string(self, escaped_quotes=False):
360 for k, v in self.variables.iteritems():
362 v = v.replace('"', '\\"')
363 e += '%s=%s ' % (k, v)
368 rmtree(self.directory)
374 class WindowsTarget(Target):
375 def __init__(self, bits, directory=None):
376 super(WindowsTarget, self).__init__('windows', directory)
379 self.windows_prefix = '%s/%d' % (config.get('windows_environment_prefix'), self.bits)
380 if not os.path.exists(self.windows_prefix):
381 raise Error('windows prefix %s does not exist' % self.windows_prefix)
384 self.mingw_name = 'i686'
386 self.mingw_name = 'x86_64'
388 self.mingw_path = '%s/%d/bin' % (config.get('mingw_prefix'), self.bits)
389 self.mingw_prefixes = ['/%s/%d' % (config.get('mingw_prefix'), self.bits), '%s/%d/%s-w64-mingw32' % (config.get('mingw_prefix'), bits, self.mingw_name)]
391 self.set('PKG_CONFIG_LIBDIR', '%s/lib/pkgconfig' % self.windows_prefix)
392 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/bin/pkgconfig' % (self.directory, self.directory))
393 self.set('PATH', '%s/bin:%s:%s' % (self.windows_prefix, self.mingw_path, os.environ['PATH']))
394 self.set('CC', '%s-w64-mingw32-gcc' % self.mingw_name)
395 self.set('CXX', '%s-w64-mingw32-g++' % self.mingw_name)
396 self.set('LD', '%s-w64-mingw32-ld' % self.mingw_name)
397 self.set('RANLIB', '%s-w64-mingw32-ranlib' % self.mingw_name)
398 self.set('WINRC', '%s-w64-mingw32-windres' % self.mingw_name)
399 cxx = '-I%s/include -I%s/include' % (self.windows_prefix, self.directory)
400 link = '-L%s/lib -L%s/lib' % (self.windows_prefix, self.directory)
401 for p in self.mingw_prefixes:
402 cxx += ' -I%s/include' % p
403 link += ' -L%s/lib' % p
404 self.set('CXXFLAGS', '"%s"' % cxx)
405 self.set('CPPFLAGS', '')
406 self.set('LINKFLAGS', '"%s"' % link)
408 def command(self, c):
409 log('host -> %s' % c)
410 command('%s %s' % (self.variables_string(), c))
416 class LinuxTarget(Target):
417 def __init__(self, distro, version, bits, directory=None):
418 super(LinuxTarget, self).__init__('linux', directory)
420 self.version = version
422 # e.g. ubuntu-14.04-64
423 if self.version is not None and self.bits is not None:
424 self.chroot = '%s-%s-%d' % (self.distro, self.version, self.bits)
426 self.chroot = self.distro
427 # e.g. /home/carl/Environments/ubuntu-14.04-64
428 self.chroot_prefix = '%s/%s' % (config.get('linux_chroot_prefix'), self.chroot)
430 self.set('CXXFLAGS', '-I%s/include' % self.directory)
431 self.set('CPPFLAGS', '')
432 self.set('LINKFLAGS', '-L%s/lib' % self.directory)
433 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:/usr/local/lib/pkgconfig' % self.directory)
434 self.set('PATH', '/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin')
436 def command(self, c):
437 command('%s schroot -c %s -p -- %s' % (self.variables_string(), self.chroot, c))
443 class OSXTarget(Target):
444 def __init__(self, directory=None):
445 super(OSXTarget, self).__init__('osx', directory)
447 def command(self, c):
448 command('%s %s' % (self.variables_string(False), c))
451 class OSXSingleTarget(OSXTarget):
452 def __init__(self, bits, directory=None):
453 super(OSXSingleTarget, self).__init__(directory)
461 flags = '-isysroot %s/MacOSX%s.sdk -arch %s' % (config.get('osx_sdk_prefix'), config.get('osx_sdk'), arch)
462 enviro = '%s/%d' % (config.get('osx_environment_prefix'), bits)
464 # Environment variables
465 self.set('CFLAGS', '"-I%s/include -I%s/include %s"' % (self.directory, enviro, flags))
466 self.set('CPPFLAGS', '')
467 self.set('CXXFLAGS', '"-I%s/include -I%s/include %s"' % (self.directory, enviro, flags))
468 self.set('LDFLAGS', '"-L%s/lib -L%s/lib %s"' % (self.directory, enviro, flags))
469 self.set('LINKFLAGS', '"-L%s/lib -L%s/lib %s"' % (self.directory, enviro, flags))
470 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/lib/pkgconfig:/usr/lib/pkgconfig' % (self.directory, enviro))
471 self.set('PATH', '$PATH:/usr/bin:/sbin:/usr/local/bin:%s/bin' % enviro)
472 self.set('MACOSX_DEPLOYMENT_TARGET', config.get('osx_sdk'))
474 def package(self, project, checkout):
475 raise Error('cannot package non-universal OS X versions')
478 class OSXUniversalTarget(OSXTarget):
479 def __init__(self, directory=None):
480 super(OSXUniversalTarget, self).__init__(directory)
482 def package(self, project, checkout):
485 target = OSXSingleTarget(b, os.path.join(self.directory, '%d' % b))
486 tree = globals.trees.get(project, checkout, target)
487 tree.build_dependencies()
490 tree = globals.trees.get(project, checkout, self)
491 with TreeDirectory(tree):
492 return tree.call('package', tree.version), tree.git_commit
498 class SourceTarget(Target):
500 super(SourceTarget, self).__init__('source')
502 def command(self, c):
503 log('host -> %s' % c)
504 command('%s %s' % (self.variables_string(), c))
507 rmtree(self.directory)
509 def package(self, project, checkout):
510 tree = globals.trees.get(project, checkout, self)
511 with TreeDirectory(tree):
512 name = read_wscript_variable(os.getcwd(), 'APPNAME')
513 command('./waf dist')
514 return os.path.abspath('%s-%s.tar.bz2' % (name, tree.version)), tree.git_commit
517 # @param s Target string:
519 # or ubuntu-version-{32,64}
520 # or debian-version-{32,64}
521 # or centos-version-{32,64}
524 # @param debug True to build with debugging symbols (where possible)
525 def target_factory(s, debug, work):
527 if s.startswith('windows-'):
528 target = WindowsTarget(int(s.split('-')[1]), work)
529 elif s.startswith('ubuntu-') or s.startswith('debian-') or s.startswith('centos-'):
532 print >>sys.stderr,"Bad Linux target name `%s'; must be something like ubuntu-12.04-32 (i.e. distro-version-bits)" % s
534 target = LinuxTarget(p[0], p[1], int(p[2]), work)
535 elif s == 'raspbian':
536 target = LinuxTarget(s, None, None, work)
537 elif s.startswith('osx-'):
538 target = OSXSingleTarget(int(s.split('-')[1]), work)
540 if globals.command == 'build':
541 target = OSXSingleTarget(64, work)
543 target = OSXUniversalTarget(work)
545 target = SourceTarget()
547 if target is not None:
558 """Description of a tree, which is a checkout of a project,
559 possibly built. This class is never exposed to cscripts.
561 name -- name of git repository (without the .git)
562 specifier -- git tag or revision to use
563 target --- target object that we are using
564 version --- version from the wscript (if one is present)
565 git_commit -- git revision that is actually being used
566 built --- true if the tree has been built yet in this run
569 def __init__(self, name, specifier, target):
571 self.specifier = specifier
574 self.git_commit = None
583 redirect = '>/dev/null'
584 command('git clone %s %s/%s.git %s/src/%s' % (flags, config.get('git_prefix'), self.name, target.directory, self.name))
585 os.chdir('%s/src/%s' % (target.directory, self.name))
587 spec = self.specifier
591 command('git checkout %s %s %s' % (flags, spec, redirect))
592 self.git_commit = command_and_read('git rev-parse --short=7 HEAD').readline().strip()
593 command('git submodule init --quiet')
594 command('git submodule update --quiet')
596 proj = '%s/src/%s' % (target.directory, self.name)
599 execfile('%s/cscript' % proj, self.cscript)
601 if os.path.exists('%s/wscript' % proj):
602 v = read_wscript_variable(proj, "VERSION");
604 self.version = Version(v)
608 def call(self, function, *args):
609 with TreeDirectory(self):
610 return self.cscript[function](self.target, *args)
612 def build_dependencies(self):
613 if 'dependencies' in self.cscript:
614 for d in self.cscript['dependencies'](self.target):
615 log('Building dependency %s %s of %s' % (d[0], d[1], self.name))
616 dep = globals.trees.get(d[0], d[1], self.target)
617 dep.build_dependencies()
619 # Make the options to pass in from the option_defaults of the thing
620 # we are building and any options specified by the parent.
622 if 'option_defaults' in dep.cscript:
623 options = dep.cscript['option_defaults']()
625 for k, v in d[2].iteritems():
630 def build(self, options=None):
634 variables = copy.copy(self.target.variables)
636 if len(inspect.getargspec(self.cscript['build']).args) == 2:
637 self.call('build', options)
641 self.target.variables = variables
645 # Command-line parser
651 "build": "build project",
652 "package": "package and build project",
653 "release": "release a project using its next version number (changing wscript and tagging)",
654 "pot": "build the project's .pot files",
655 "changelog": "generate a simple HTML changelog",
656 "manual": "build the project's manual",
657 "doxygen": "build the project's Doxygen documentation",
658 "latest": "print out the latest version",
659 "test": "run the project's unit tests",
660 "shell": "build the project then start a shell in its chroot",
661 "checkout": "check out the project",
662 "revision": "print the head git revision number"
665 one_of = "Command is one of:\n"
667 for k, v in commands.iteritems():
668 one_of += "\t%s\t%s\n" % (k, v)
671 parser = argparse.ArgumentParser()
672 parser.add_argument('command', help=summary)
673 parser.add_argument('-p', '--project', help='project name')
674 parser.add_argument('--minor', help='minor version number bump', action='store_true')
675 parser.add_argument('--micro', help='micro version number bump', action='store_true')
676 parser.add_argument('--major', help='major version to return with latest', type=int)
677 parser.add_argument('-c', '--checkout', help='string to pass to git for checkout')
678 parser.add_argument('-o', '--output', help='output directory', default='.')
679 parser.add_argument('-q', '--quiet', help='be quiet', action='store_true')
680 parser.add_argument('-t', '--target', help='target')
681 parser.add_argument('-k', '--keep', help='keep working tree', action='store_true')
682 parser.add_argument('--debug', help='build with debugging symbols where possible', action='store_true')
683 parser.add_argument('-w', '--work', help='override default work directory')
684 parser.add_argument('-g', '--git-prefix', help='override configured git prefix')
685 args = parser.parse_args()
687 # Override configured stuff
688 if args.git_prefix is not None:
689 config.set('git_prefix', args.git_prefix)
691 if args.output.find(':') == -1:
692 # This isn't of the form host:path so make it absolute
693 args.output = os.path.abspath(args.output) + '/'
695 if args.output[-1] != ':' and args.output[-1] != '/':
698 # Now, args.output is 'host:', 'host:path/' or 'path/'
700 if args.work is not None:
701 args.work = os.path.abspath(args.work)
703 if args.project is None and args.command != 'shell':
704 raise Error('you must specify -p or --project')
706 globals.quiet = args.quiet
707 globals.command = args.command
709 if not globals.command in commands:
710 e = 'command must be one of:\n' + one_of
711 raise Error('command must be one of:\n%s' % one_of)
713 if globals.command == 'build':
714 if args.target is None:
715 raise Error('you must specify -t or --target')
717 target = target_factory(args.target, args.debug, args.work)
718 tree = globals.trees.get(args.project, args.checkout, target)
719 tree.build_dependencies()
724 elif globals.command == 'package':
725 if args.target is None:
726 raise Error('you must specify -t or --target')
728 target = target_factory(args.target, args.debug, args.work)
729 packages, git_commit = target.package(args.project, args.checkout)
730 if hasattr(packages, 'strip') or (not hasattr(packages, '__getitem__') and not hasattr(packages, '__iter__')):
731 packages = [packages]
733 if target.platform == 'linux':
734 out = '%s%s-%s-%d' % (args.output, target.distro, target.version, target.bits)
740 copyfile(p, '%s/%s' % (out, os.path.basename(devel_to_git(git_commit, p))))
743 makedirs(args.output)
747 copyfile(p, '%s%s' % (args.output, os.path.basename(devel_to_git(git_commit, p))))
752 elif globals.command == 'release':
753 if args.minor is False and args.micro is False:
754 raise Error('you must specify --minor or --micro')
756 target = SourceTarget()
757 tree = globals.trees.get(args.project, args.checkout, target)
759 version = tree.version
766 set_version_in_wscript(version)
767 append_version_to_changelog(version)
768 append_version_to_debian_changelog(version)
770 command('git commit -a -m "Bump version"')
771 command('git tag -m "v%s" v%s' % (version, version))
774 set_version_in_wscript(version)
775 command('git commit -a -m "Bump version"')
777 command('git push --tags')
781 elif globals.command == 'pot':
782 target = SourceTarget()
783 tree = globals.trees.get(args.project, args.checkout, target)
785 pots = tree.call('make_pot')
787 copyfile(p, '%s%s' % (args.output, os.path.basename(p)))
791 elif globals.command == 'changelog':
792 target = SourceTarget()
793 tree = globals.trees.get(args.project, args.checkout, target)
795 with TreeDirectory(tree):
796 text = open('ChangeLog', 'r')
798 html = tempfile.NamedTemporaryFile()
809 if len(l) > 0 and l[0] == "\t":
811 if len(s) == 4 and s[1] == "Version" and s[3] == "released.":
814 if last is not None and len(changes) > 0:
815 print >>html,"<h2>Changes between version %s and %s</h2>" % (s[2], last)
818 print >>html,"<li>%s" % c
829 changes.append(c[2:])
831 changes[-1] += " " + c
833 copyfile(html.file, '%schangelog.html' % args.output)
837 elif globals.command == 'manual':
838 target = SourceTarget()
839 tree = globals.trees.get(args.project, args.checkout, target)
841 outs = tree.call('make_manual')
843 if os.path.isfile(o):
844 copyfile(o, '%s%s' % (args.output, os.path.basename(o)))
846 copytree(o, '%s%s' % (args.output, os.path.basename(o)))
850 elif globals.command == 'doxygen':
851 target = SourceTarget()
852 tree = globals.trees.get(args.project, args.checkout, target)
854 dirs = tree.call('make_doxygen')
855 if hasattr(dirs, 'strip') or (not hasattr(dirs, '__getitem__') and not hasattr(dirs, '__iter__')):
859 copytree(d, args.output)
863 elif globals.command == 'latest':
864 target = SourceTarget()
865 tree = globals.trees.get(args.project, args.checkout, target)
867 with TreeDirectory(tree):
868 f = command_and_read('git log --tags --simplify-by-decoration --pretty="%d"')
870 while latest is None:
872 m = re.compile(".*\((.*)\).*").match(t)
874 tags = m.group(1).split(', ')
879 if len(t) > 0 and t[0] == 'v':
881 if args.major is None or v.major == args.major:
887 elif globals.command == 'test':
888 if args.target is None:
889 raise Error('you must specify -t or --target')
893 target = target_factory(args.target, args.debug, args.work)
894 tree = globals.trees.get(args.project, args.checkout, target)
895 with TreeDirectory(tree):
898 if target is not None:
902 if target is not None:
905 elif globals.command == 'shell':
906 if args.target is None:
907 raise Error('you must specify -t or --target')
909 target = target_factory(args.target, args.debug, args.work)
910 target.command('bash')
912 elif globals.command == 'revision':
914 target = SourceTarget()
915 tree = globals.trees.get(args.project, args.checkout, target)
916 with TreeDirectory(tree):
917 print command_and_read('git rev-parse HEAD').readline().strip()[:7]
920 elif globals.command == 'checkout':
922 if args.output is None:
923 raise Error('you must specify -o or --output')
925 target = SourceTarget()
926 tree = globals.trees.get(args.project, args.checkout, target)
927 with TreeDirectory(tree):
928 shutil.copytree('.', args.output)
932 raise Error('invalid command %s' % globals.command)
937 print >>sys.stderr,'cdist: %s' % str(e)