Small cleanup

native_client_sdk/src/build_tools/buildbot_run.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.
 
-'''Entry point for both build and try bots'''
+'''Entry point for both build and try bots
 
-import build_utils
-import lastchange
+This script is invoked from XXX, usually without arguments
+to package an NNaCl SDK. It automatically determines whether

[noelallen1, 2012/01/31 18:59:07]

NNaCl

[robertm, 2012/01/31 19:06:39]

took out the pnacl references for now.
Will add them to the next CL

On 2012/01/31 18:59:07, noelallen1 wrote:

+this SDK is for mac, win, linux.
+
+If the script is invoked with the single argument 'pnacl'

[noelallen1, 2012/01/31 18:59:07]

This comment does not match the code.

[robertm, 2012/01/31 19:06:39]

dito
On 2012/01/31 18:59:07, noelallen1 wrote:

+an PNaCl SDK is build instead. 

[noelallen1, 2012/01/31 18:59:07]

an?

[robertm, 2012/01/31 19:06:39]

dito
On 2012/01/31 18:59:07, noelallen1 wrote:

+
+The script inspects the following environment variables:
+
+BUILDBOT_BUILDERNAME to determine whether the script is run locally
+and whether it should upload an SDK to file storage (GSTORE)
+'''
+
+# std python includes
 import os
 import subprocess
 import sys
 
+# local includes
+import build_utils
+import lastchange
+
+
 # Create the various paths of interest
 SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__))
 SDK_SRC_DIR = os.path.dirname(SCRIPT_DIR)
 SDK_DIR = os.path.dirname(SDK_SRC_DIR)
 SRC_DIR = os.path.dirname(SDK_DIR)
 NACL_DIR = os.path.join(SRC_DIR, 'native_client')
 OUT_DIR = os.path.join(SRC_DIR, 'out')
 PPAPI_DIR = os.path.join(SRC_DIR, 'ppapi')
 
 
 # Add SDK make tools scripts to the python path.
 sys.path.append(os.path.join(SDK_SRC_DIR, 'tools'))
 sys.path.append(os.path.join(NACL_DIR, 'build'))
 
-
+import getos
 import http_download
-from getos import GetPlatform
 import oshelpers
 
 GSTORE = 'http://commondatastorage.googleapis.com/nativeclient-mirror/nacl/'
 MAKE = 'nacl_sdk/make_3_81/make.exe'
-GSUTIL = '/b/build/scripts/slave/gsutil'
+# For buildbots assume gsutil is stored in the build directory.
+BOT_GSUTIL = '/b/build/scripts/slave/gsutil'
+# For local runs just make sure gsutil is in your PATH.
+LOCAL_GSUTIL = 'gsutil'
 
 def ErrorExit(msg):
-  """Write and error to stderr, then exit with 1 signaling failure."""
+  '''Write and error to stderr, then exit with 1 signaling failure.'''

[noelallen1, 2012/01/31 18:59:07]

Why are you gratuitously changing these?  We do not use ''' more often than """.

[robertm, 2012/01/31 19:06:39]

we should use only one to be style guide compliant.
''' was used in the header and 
""" for function comments.

since we also using single quotes for regular strings
it seems consistent to also use them for multi-line strings.

The change is low risk but if you prefer I can change it to
using """ everywhere.

On 2012/01/31 18:59:07, noelallen1 wrote:

   sys.stderr.write(msg + '\n')
   sys.exit(1)
 
 
 def BuildStep(name):
-  """Annotate a buildbot build step."""
+  '''Annotate a buildbot build step.'''
   sys.stdout.flush()
   print '\n@@@BUILD_STEP %s@@@' % name
   sys.stdout.flush()
 
 
 def Run(args, cwd=None, shell=False):
-  """Start a process with the provided arguments.
+  '''Start a process with the provided arguments.
   
   Starts a process in the provided directory given the provided arguments. If
   shell is not False, the process is launched via the shell to provide shell
   interpretation of the arguments.  Shell behavior can differ between platforms
-  so this should be avoided when not using platform dependent shell scripts."""
+  so this should be avoided when not using platform dependent shell scripts.'''
   print 'Running: ' + ' '.join(args)
   sys.stdout.flush()
   subprocess.check_call(args, cwd=cwd, shell=shell)
   sys.stdout.flush()
 
 
 def Archive(filename):
-  """Upload the given filename to Google Store."""
+  '''Upload the given filename to Google Store.'''
   chrome_version = build_utils.ChromeVersion()
   bucket_path = 'nativeclient-mirror/nacl/nacl_sdk/%s/%s' % (
       chrome_version, filename)
   full_dst = 'gs://%s' % bucket_path
 
   if os.environ.get('BUILDBOT_BUILDERNAME', ''):
-    # For buildbots assume gsutil is stored in the build directory.
-    gsutil = '/b/build/scripts/slave/gsutil'
+    gsutil = BOT_GSUTIL
   else:
-    # For non buildpots, you must have it in your path.
-    gsutil = 'gsutil'
+    gsutil = LOCAL_GSUTIL
 
   subprocess.check_call(
       '%s cp -a public-read %s %s' % (
           gsutil, filename, full_dst), shell=True, cwd=OUT_DIR)
   url = 'https://commondatastorage.googleapis.com/%s' % bucket_path
   print '@@@STEP_LINK@download@%s@@@' % url
   sys.stdout.flush()
 
 
 def AddMakeBat(makepath):
-  """Create a simple batch file to execute Make.
+  '''Create a simple batch file to execute Make.
   
   Creates a simple batch file named make.bat for the Windows platform at the
-  given path, pointing to the Make executable in the SDK.""" 
+  given path, pointing to the Make executable in the SDK.''' 
   fp = open(os.path.join(makepath, 'make.bat'), 'wb')
   fp.write('@..\\..\\tools\\make.exe %*\n')
   fp.close()
 
 
 def CopyDir(src, dst, excludes=['.svn']):
-  """Recursively copy a directory using."""
+  '''Recursively copy a directory using.'''
   args = ['-r', src, dst]
   for exc in excludes:
     args.append('--exclude=' + exc)
   print "cp -r %s %s" % (src, dst)
   oshelpers.Copy(args)
 
 def RemoveDir(dst):
-  """Remove the provided path."""
+  '''Remove the provided path.'''
   print "rm -fr " + dst
   oshelpers.Remove(['-fr', dst])
 
 def MakeDir(dst):
-  """Create the path including all parent directories as needed."""
+  '''Create the path including all parent directories as needed.'''
   print "mkdir -p " + dst
   oshelpers.Mkdir(['-p', dst])
 
 def MoveDir(src, dst):
-  """Move the path src to dst."""
+  '''Move the path src to dst.'''
   print "mv -fr %s %s" % (src, dst)
   oshelpers.Move(['-f', src, dst])
 
 def BuildOutputDir(*paths):
   return os.path.join(OUT_DIR, *paths)
 
 
 def GetGlibcToolchain(platform, arch):
   tcdir = os.path.join(NACL_DIR, 'toolchain', '.tars')
   tcname = 'toolchain_%s_%s.tar.bz2' % (platform, arch)
@@ skipping 28 matching lines @@
 def GetToolchainNaClLib(tcpath, arch, xarch):
   if arch == 'x86':
     if str(xarch) == '32':
       return os.path.join(tcpath, 'x86_64-nacl', 'lib32')
     if str(xarch) == '64':
       return os.path.join(tcpath, 'x86_64-nacl', 'lib')
   ErrorExit('Unknown architecture.')
 
 
 def GetBuildArgs(tcname, tcpath, arch, xarch=None):
-  """Return list of scons build arguments to generate user libraries."""
+  '''Return list of scons build arguments to generate user libraries.'''
   scons = GetScons()
   mode = '--mode=opt-host,nacl'
   arch_name = GetArchName(arch, xarch)
   plat = 'platform=' + arch_name
   bin = ('bindir=' +
          BuildOutputDir('pepper_' + build_utils.ChromeMajorVersion(), 'tools'))
   lib = ('libdir=' +
          os.path.join(GetToolchainNaClLib(tcpath, arch, xarch)))
   args = [scons, mode, plat, bin, lib, '-j10',
           'install_bin', 'install_lib']
@@ skipping 21 matching lines @@
       'nacl_startup.h': 'src/untrusted/nacl/nacl_startup.h',
       'nacl_thread.h': 'src/untrusted/nacl/nacl_thread.h',
       'pnacl.h': 'src/untrusted/nacl/pnacl.h',
       'irt.h': 'src/untrusted/irt/irt.h',
       'irt_ppapi.h': 'src/untrusted/irt/irt_ppapi.h',
   },
 }
 
 
 def InstallHeaders(tc_dst_inc, pepper_ver, tc_name):
-  """Copies NaCl headers to expected locations in the toolchain."""
+  '''Copies NaCl headers to expected locations in the toolchain.'''
   tc_map = header_map[tc_name]
   for filename in tc_map:
     src = os.path.join(NACL_DIR, tc_map[filename])
     dst = os.path.join(tc_dst_inc, filename)
     oshelpers.Copy(['-v', src, dst])
 
   # Clean out per toolchain ppapi directory
   ppapi = os.path.join(tc_dst_inc, 'ppapi')
   RemoveDir(ppapi)
 
@@ skipping 39 matching lines @@
   MakeDir(os.path.join(tc_dst_inc, 'GLES2'))
   CopyDir(os.path.join(PPAPI_DIR,'lib','gl','include','GLES2', '*.h'),
           os.path.join(tc_dst_inc, 'GLES2'))
 
   # Copy the KHR headers
   MakeDir(os.path.join(tc_dst_inc, 'KHR'))
   CopyDir(os.path.join(PPAPI_DIR,'lib','gl','include','KHR', '*.h'),
           os.path.join(tc_dst_inc, 'KHR'))
 
 
-def main():
-  platform = GetPlatform()
+def main(argv):
+  platform = getos.GetPlatform()
   arch = 'x86'
+  # the vars below are intended for debugging
   skip_untar = 0
   skip_build = 0
   skip_tar = 0
   skip_examples = 0
   skip_headers = 0
   skip_make = 0
   force_archive = 0
 
   pepper_ver = build_utils.ChromeMajorVersion()
   clnumber = lastchange.FetchVersionInfo(None).revision
   print 'Building PEPPER %s at %s' % (pepper_ver, clnumber)
 
   BuildStep('Clean Pepper Dir')
   pepperdir = os.path.join(SRC_DIR, 'out', 'pepper_' + pepper_ver)
   if not skip_untar:
     RemoveDir(pepperdir)
     MakeDir(os.path.join(pepperdir, 'toolchain'))
     MakeDir(os.path.join(pepperdir, 'tools'))
 
   BuildStep('Untar Toolchains')
   tmpdir = os.path.join(SRC_DIR, 'out', 'tc_temp')
   tcname = platform + '_' + arch
   tmpdir = os.path.join(SRC_DIR, 'out', 'tc_temp')
   cygtar = os.path.join(NACL_DIR, 'build', 'cygtar.py')
 
-    # Clean out the temporary toolchain untar directory
+  # Clean out the temporary toolchain untar directory
   if not skip_untar:
     RemoveDir(tmpdir)
     MakeDir(tmpdir)
     tcname = platform + '_' + arch
 
     # Untar the newlib toolchains
     tarfile = GetNewlibToolchain(platform, arch)
     Run([sys.executable, cygtar, '-C', tmpdir, '-xf', tarfile], cwd=NACL_DIR)
 
     # Then rename/move it to the pepper toolchain directory
@@ skipping 72 matching lines @@
       if os.path.isfile(makefile):
         if platform == 'win':
           AddMakeBat(dirnode)
         print "\n\nMake: " + dirnode
         Run(['make', 'all', '-j8'], cwd=os.path.abspath(dirnode), shell=True)
 
   return 0
 
 
 if __name__ == '__main__':
-  sys.exit(main())
-
+  sys.exit(main(sys.argv))