[NaCl SDK] Nicer display for 'naclsdk list'

native_client_sdk/src/build_tools/sdk_tools/sdk_update_main.py

 #!/usr/bin/env python
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 '''A simple tool to update the Native Client SDK to the latest version'''
 
 import cStringIO
 import cygtar
 import json
@@ skipping 17 matching lines @@
 REVISION = '{REVISION}'
 
 GLOBAL_HELP = '''Usage: naclsdk [options] command [command_options]
 
 naclsdk is a simple utility that updates the Native Client (NaCl)
 Software Developer's Kit (SDK).  Each component is kept as a 'bundle' that
 this utility can download as as subdirectory into the SDK.
 
 Commands:
   help [command] - Get either general or command-specific help
+  info - Displas information about a bundle

[noelallen1, 2012/08/15 21:33:35]

Displays

[binji, 2012/08/15 23:12:44]

Done.

   list - Lists the available bundles
   update/install - Updates/installs bundles in the SDK
   sources - Manage external package sources
 
 Example Usage:
+  naclsdk info pepper_canary
   naclsdk list
   naclsdk update --force pepper_17
   naclsdk install recommended
   naclsdk help update
   naclsdk sources --list'''
 
 CONFIG_FILENAME='naclsdk_config.json'
 MANIFEST_FILENAME='naclsdk_manifest2.json'
 SDK_TOOLS='sdk_tools'  # the name for this tools directory
 USER_DATA_DIR='sdk_cache'
@@ skipping 300 matching lines @@
     # json.dumps sometimes returns trailing whitespace and does not put
     # a newline at the end.  This code fixes these problems.
     pretty_lines = pretty_string.split('\n')
     return '\n'.join([line.rstrip() for line in pretty_lines]) + '\n'
 
 
 #------------------------------------------------------------------------------
 # Commands
 
 
+def Info(options, argv, config):
+  '''Usage: %prof info [options] bundle_names...
+
+  Displays information about a SDK bundle.'''
+
+  DebugPrint("Running List command with: %s, %s" %(options, argv))
+
+  parser = optparse.OptionParser(usage=Info.__doc__)
+  (info_options, args) = parser.parse_args(argv)
+
+  if not args:
+    parser.print_help()
+    return
+
+  manifest = LoadManifestFromURLs([options.manifest_url] + config.GetSources())
+  valid_bundles = [bundle.name for bundle in manifest.GetBundles()]
+  valid_args = set(args) & set(valid_bundles)
+  invalid_args = set(args) - valid_args
+  if invalid_args:
+    InfoPrint('Unknown bundle(s): %s\n' % (', '.join(invalid_args)))
+
+  for bundle_name in args:
+    if bundle_name not in valid_args:
+      continue
+
+    bundle = manifest.GetBundle(bundle_name)
+
+    InfoPrint('%s' % bundle.name)
+    for key, value in bundle.iteritems():
+      if key == manifest_util.ARCHIVES_KEY:
+        archive = bundle.GetHostOSArchive()
+        InfoPrint('  Archive:')
+        for archive_key, archive_value in archive.iteritems():
+          InfoPrint('    %s: %s' % (archive_key, archive_value))
+      elif key not in (manifest_util.ARCHIVES_KEY, manifest_util.NAME_KEY):
+        InfoPrint('  %s: %s' % (key, value))
+    InfoPrint('')
+
+
 def List(options, argv, config):
-  '''Usage: %prog [options] list
+  '''Usage: %prog list [options]
 
   Lists the available SDK bundles that are available for download.'''
-  def PrintBundles(bundles):
-    for bundle in bundles:
-      InfoPrint('  %s' % bundle.name)
-      for key, value in bundle.iteritems():
-        if key not in (manifest_util.ARCHIVES_KEY, manifest_util.NAME_KEY):
-          InfoPrint('    %s: %s' % (key, value))
+
+  def PrintBundle(local_bundle, bundle, needs_update, display_revisions):
+    installed = local_bundle is not None
+    # If bundle is None, there is no longer a remote bundle with this name.
+    if bundle is None:
+      bundle = local_bundle
+
+    if display_revisions:
+      if needs_update:
+        revision = ' (r%s -> r%s)' % (local_bundle.revision, bundle.revision)
+      else:
+        revision = ' (r%s)' % (bundle.revision,)
+    else:
+      revision = ''
+
+    InfoPrint('  %s%s %s (%s)%s' % (
+      'I' if installed else ' ',
+      '*' if needs_update else ' ',
+      bundle.name,
+      bundle.stability,
+      revision))
+
 
   DebugPrint("Running List command with: %s, %s" %(options, argv))
 
   parser = optparse.OptionParser(usage=List.__doc__)
+  parser.add_option(
+      '-r', '--revision', dest='revision',
+      default=False, action='store_true',
+      help='display revision numbers')
   (list_options, args) = parser.parse_args(argv)
+
   manifest = LoadManifestFromURLs([options.manifest_url] + config.GetSources())
-  InfoPrint('Available bundles:')
-  PrintBundles(manifest.GetBundles())
-  # Print the local information.
   manifest_path = os.path.join(options.user_data_dir, options.manifest_filename)
   local_manifest = LoadFromFile(manifest_path, manifest_util.SDKManifest())
-  InfoPrint('\nCurrently installed bundles:')
-  PrintBundles(local_manifest.GetBundles())
+
+  any_bundles_need_update = False
+  InfoPrint('Bundles:')
+  InfoPrint(' I: installed\n *: update available\n')
+  for bundle in manifest.GetBundles():
+    local_bundle = local_manifest.GetBundle(bundle.name)
+    installed = local_bundle is not None
+    needs_update = local_bundle and local_manifest.BundleNeedsUpdate(bundle)
+    if needs_update:
+      any_bundles_need_update = True
+
+    PrintBundle(local_bundle, bundle, needs_update, list_options.revision)
+
+  if not any_bundles_need_update:
+    InfoPrint('\nAll installed bundles are up-to-date.')
+
+  local_only_bundles = set([b.name for b in local_manifest.GetBundles()])
+  local_only_bundles -= set([b.name for b in manifest.GetBundles()])
+  if local_only_bundles:
+    InfoPrint('\nBundles installed locally that are not available remotely:')
+    for bundle_name in local_only_bundles:
+      local_bundle = local_manifest.GetBundle(bundle_name)
+      PrintBundle(local_bundle, None, False, list_options.revision)
 
 
 def Update(options, argv, config):
-  '''Usage: %prog [options] update [target]
+  '''Usage: %prog update [options] [target]

[noelallen1, 2012/08/15 21:33:35]

[global_options] update [options]

[binji, 2012/08/15 23:12:44]

Done.

 
   Updates the Native Client SDK to a specified version.  By default, this
   command updates all the recommended components.  The update process works
   like this:
     1. Fetch the manifest from the mirror.
     2. Load manifest from USER_DATA_DIR - if there is no local manifest file,
        make an empty manifest object.
     3. Update each the bundle:
       for bundle in bundles:
         # Compare bundle versions & revisions.
@@ skipping 91 matching lines @@
                      'Run update with the --force option to overwrite the '
                      'existing directory.\nWarning: This will overwrite any '
                      'modifications you have made within this directory.'
                      % bundle.name)
       else:
         UpdateBundle()
     else:
       InfoPrint('%s is already up-to-date.' % bundle.name)
 
 def Sources(options, argv, config):
-  '''Usage: %prog [options] sources [--list,--add URL,--remove URL]
+  '''Usage: %prog sources [options] [--list,--add URL,--remove URL]
 
   Manage additional package sources.  URL should point to a valid package
   manifest file for download.
   '''
   DebugPrint("Running Sources command with: %s, %s" % (options, argv))
 
   parser = optparse.OptionParser(usage=Sources.__doc__)
   parser.add_option(
       '-a', '--add', dest='url_to_add',
       default=None,
@@ skipping 26 matching lines @@
   if write_config:
     WriteToFile(os.path.join(options.user_data_dir, options.config_filename),
                 config)
 
 #------------------------------------------------------------------------------
 # Command-line interface
 
 
 def main(argv):
   '''Main entry for the sdk_update utility'''
-  parser = optparse.OptionParser(usage=GLOBAL_HELP)
+  parser = optparse.OptionParser(usage=GLOBAL_HELP, add_help_option=False)
   DEFAULT_SDK_ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 
+  # Manually add help options so we can ignore it when auto-updating.
+  parser.add_option(
+      '-h', '--help', dest='help', action='store_true',
+      help='show this help message and exit')
   parser.add_option(
       '-U', '--manifest-url', dest='manifest_url',
       default='https://commondatastorage.googleapis.com/nativeclient-mirror/'
               'nacl/nacl_sdk/%s' % MANIFEST_FILENAME,
       help='override the default URL for the NaCl manifest file')
   parser.add_option(
       '-d', '--debug', dest='debug',
       default=False, action='store_true',
       help='enable displaying debug information to stderr')
   parser.add_option(
@@ skipping 22 matching lines @@
   parser.add_option(
       '-c', '--config', dest='config_filename',
       default=CONFIG_FILENAME,
       help="name of the local config file relative to user-data-dir")
   parser.add_option(
       '--update-sdk-tools', dest='update_sdk_tools',
       default=False, action='store_true')
 
 
   COMMANDS = {
+      'info': Info,
       'list': List,
       'update': Update,
       'install': Update,
       'sources': Sources,
       }
 
   # Separate global options from command-specific options
   global_argv = argv
   command_argv = []
   for index, arg in enumerate(argv):
@@ skipping 23 matching lines @@
 
   if options.show_version:
     print "Native Client SDK Updater, version r%s" % (REVISION,)
     exit(0)
 
 
   if not args:
     print "Need to supply a command"
     PrintHelpAndExit()
 
+  if options.help:
+    PrintHelpAndExit()
+
   def DefaultHandler(unused_options=None, unused_args=None, unused_config=None):
     print "Unknown Command: %s" % args[0]
     PrintHelpAndExit()
 
   def InvokeCommand(args):
     command = COMMANDS.get(args[0], DefaultHandler)
     # Load the config file before running commands
     config = LoadFromFile(os.path.join(options.user_data_dir,
                                        options.config_filename),
                           SDKConfig())
@@ skipping 12 matching lines @@
 
   return 0  # Success
 
 
 if __name__ == '__main__':
   try:
     sys.exit(main(sys.argv[1:]))
   except Error as error:
     print "Error: %s" % error
     sys.exit(1)