Use platform-dependent metadata files to allow multiple builds from the same repository

build.py

 # coding: utf-8
 
 # This file is part of the Adblock Plus build tools,
 # Copyright (C) 2006-2012 Eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus is distributed in the hope that it will be useful,
@@ skipping 95 matching lines @@
 
 def usage(scriptName, type, commandName=None):
   if commandName == None:
     global commandsList
     descriptions = []
     for command in commandsList:
       if not command.isSupported(type):
         continue
       commandText = ('%s %s' % (command.name, command.params)).ljust(39)
       descriptionParts = splitByLength(command.shortDescription, 29)
-      descriptions.append('  %s %s %s' % (scriptName, commandText, descriptionParts[0]))
+      descriptions.append('  %s [-t %s] %s %s' % (scriptName, type, commandText, descriptionParts[0]))
       for part in descriptionParts[1:]:
-        descriptions.append('  %s %s %s' % (' ' * len(scriptName), ' ' * len(commandText), part))
+        descriptions.append('  %s     %s  %s %s' % (' ' * len(scriptName), ' ' * len(type), ' ' * len(commandText), part))
     print '''Usage:
 
 %(descriptions)s
 
 For details on a command run:
 
-  %(scriptName)s <command> --help
+  %(scriptName)s [-t %(type)s] <command> --help
 ''' % {
     'scriptName': scriptName,
+    'type': type,
     'descriptions': '\n'.join(descriptions)
   }
   else:
     global commands
     command = commands[commandName]
     description = '\n'.join(map(lambda s: '\n'.join(splitByLength(s, 80)), command.description.split('\n')))
     options = []
     for descr, short, long, value, types in command.options:
       if types != None and type not in types:
         continue
       if short == None:
         shortText = ''
       elif value == None:
         shortText = '-%s' % short
       else:
         shortText = '-%s %s' % (short, value)
       if long == None:
         longText = ''
       elif value == None:
         longText = '--%s' % long
       else:
         longText = '--%s=%s' % (long, value)
       descrParts = splitByLength(descr, 46)
       options.append('  %s %s %s' % (shortText.ljust(11), longText.ljust(19), descrParts[0]))
       for part in descrParts[1:]:
         options.append('  %s %s %s' % (' ' * 11, ' ' * 19, part))
-    print '''%(scriptName)s %(name)s %(params)s
+    print '''%(scriptName)s [-t %(type)s] %(name)s %(params)s
 
 %(description)s
 
 Options:
 %(options)s
 ''' % {
       'scriptName': scriptName,
+      'type': type,
       'name': command.name,
       'params': command.params,
       'description': description,
       'options': '\n'.join(options)
     }
 
 
 def runBuild(baseDir, scriptName, opts, args, type):
   locales = None
   buildNum = None
@@ skipping 178 matching lines @@
 
 def generateDocs(baseDir, scriptName, opts, args, type):
   if len(args) == 0:
     print 'No target directory specified for the documentation'
     usage(scriptName, type, 'docs')
     return
   targetDir = args[0]
 
   toolkit = None
   for option, value in opts:
-    if option in ('-k', '--toolkit'):
+    if option in ('-t', '--toolkit'):
       toolkit = value
 
   if toolkit == None:
     toolkit = os.path.join(baseDir, 'jsdoc-toolkit')
     if not os.path.exists(toolkit):
       subprocess.Popen(['hg', 'clone', 'https://hg.adblockplus.org/jsdoc-toolkit/', toolkit]).communicate()
 
   command = [sys.executable,
              os.path.join(toolkit, 'jsrun.py'),
              '-t=' + os.path.join(toolkit, 'templates', 'jsdoc'),
@@ skipping 100 matching lines @@
 with addCommand(showDescriptions, 'showdesc') as command:
   command.shortDescription = 'Print description strings for all locales'
   command.description = 'Display description strings for all locales as specified in the corresponding meta.properties files.'
   command.addOption('Only include the given locales', short='l', long='locales', value='l1,l2,l3')
   command.params = '[options]'
   command.supportedTypes = ('gecko')
 
 with addCommand(generateDocs, 'docs') as command:
   command.shortDescription = 'Generate documentation'
   command.description = 'Generate documentation files and write them into the specified directory.'
-  command.addOption('JsDoc Toolkit location', short='k', long='toolkit', value='dir')
+  command.addOption('JsDoc Toolkit location', short='t', long='toolkit', value='dir')
   command.params = '[options] <directory>'
   command.supportedTypes = ('gecko')
 
 with addCommand(runReleaseAutomation, 'release') as command:
   command.shortDescription = 'Run release automation'
   command.description = 'Note: If you are not the project owner then you '\
     'probably don\'t want to run this!\n\n'\
     'Runs release automation: creates downloads for the new version, tags '\
     'source code repository as well as downloads and buildtools repository.'
   command.addOption('File containing private key and certificates required to sign the release', short='k', long='key', value='file', types=('gecko'))
   command.addOption('Directory containing downloads repository (if omitted ../downloads is assumed)', short='d', long='downloads', value='dir')
   command.params = '[options] <version>'
   command.supportedTypes = ('gecko')
 
 with addCommand(syncLocales, 'synclocales') as command:
   command.shortDescription = 'Sync locales with a Firefox extension'
   command.description = 'Updates locale files with strings from a Firefox extension corresponding to the entries in [locale_sync] metadata section.'
   command.params = '<firefox_addon_directory>'
   command.supportedTypes = ('chrome')
 
 with addCommand(updatePSL, 'updatepsl') as command:
   command.shortDescription = 'Updates Public Suffix List'
   command.description = 'Downloads Public Suffix List (see http://publicsuffix.org/) and generates lib/publicSuffixList.js from it.'
   command.supportedTypes = ('chrome')
 
-def getType(baseDir, args):
-  # Look for an explicit type parameter
-  for i in range(len(args)):
-    if args[i] == '-t' and i < len(args) - 1:

[Felix Dahlke, 2013/01/25 07:49:43]

While there doesn't seem to be a problem with this code, I think it would be
better to use the same option parsing approach as for the toolkit option.

[Wladimir Palant, 2013/01/25 08:23:10]

Yes, that would be nice indeed. The problem is that getopt isn't too flexible as
far as option parsing goes. But maybe we should really specify that -t has to be
the very first option, even before the command.

-      type = args[i + 1]
-      del args[i + 1]
-      del args[i]
-      if type not in knownTypes:
-        print '''
+def getType(baseDir, scriptName, args):
+  # Look for an explicit type parameter (has to be the first parameter)
+  if len(args) >= 2 and args[0] == '-t':

[Felix Dahlke, 2013/01/25 08:30:49]

Hard coding that -t needs to be the very first parameter isn't great, it would
be more flexible if we would parse options before the command as global options
and those after the command as command-specific options, using getopts for each.
But since we really have just one global option right now, this should be fine.

+    type = args[1]
+    del args[1]
+    del args[0]
+    if type not in knownTypes:
+      print '''
 Unknown type %s specified, supported types are: %s
 ''' % (type, ', '.join(knownTypes))
-        return None
-      else:

[Felix Dahlke, 2013/01/25 07:49:43]

The Mozilla Coding Style says: "Don't put an else right after a return. Delete
the else, it's unnecessary and increases indentation level."

Also happens to be my preference... :)

-        return type
+      return None
+    return type
 
   # Try to guess repository type
   types = []
   for t in knownTypes:
     if os.path.exists(os.path.join(baseDir, 'metadata.%s' % t)):
       types.append(t)
 
   if len(types) == 1:
     return types[0]
   elif len(types) > 1:
     print '''
 Ambiguous repository type, please specify -t parameter explicitly, e.g.
--t %s
-''' % types[0]
+%s -t %s build
+''' % (scriptName, types[0])
     return None
   else:
     print '''
 No metadata file found in this repository, a metadata file like
 metadata.%s is required.
 ''' % knownTypes[0]
     return None
 
 def processArgs(baseDir, args):
   global commands
 
   scriptName = os.path.basename(args[0])
   args = args[1:]
-  type = getType(baseDir, args)
+  type = getType(baseDir, scriptName,   args)

[Felix Dahlke, 2013/01/25 08:30:49]

There's a rogue white space before "args". Utter nit pick, of course :)

[Wladimir Palant, 2013/01/25 10:23:49]

Fixed that before pushing.

   if type == None:
     return
 
   if len(args) == 0:
     args = ['build']
     print '''
 No command given, assuming "build". For a list of commands run:
 
   %s help
 ''' % scriptName
@@ skipping 11 matching lines @@
         if option in ('-h', '--help'):
           usage(scriptName, type, command)
           sys.exit()
       commands[command](baseDir, scriptName, opts, args, type)
     else:
       print 'Command %s is not supported for this application type' % command
       usage(scriptName, type)
   else:
     print 'Command %s is unrecognized' % command
     usage(scriptName, type)