[NaCl SDK] Generate NOTICE file automatically.

native_client_sdk/src/build_tools/build_sdk.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
 
 This script is invoked from XXX, usually without arguments
 to package an SDK. It automatically determines whether
 this SDK is for mac, win, linux.
 
 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)
 """
 
 # pylint: disable=W0621
 
 # std python includes
 import copy
 import datetime
 import generate_make
 import optparse
 import os
+import re
 import subprocess
 import sys
 
 # local includes
 import buildbot_common
 import build_updater
 import build_utils
+import generate_notice
 import manifest_util
 from tests import test_server
 
 # Create the various paths of interest
 SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__))
 SDK_SRC_DIR = os.path.dirname(SCRIPT_DIR)
 SDK_EXAMPLE_DIR = os.path.join(SDK_SRC_DIR, 'examples')
 SDK_LIBRARY_DIR = os.path.join(SDK_SRC_DIR, 'libraries')
 SDK_DIR = os.path.dirname(SDK_SRC_DIR)
 SRC_DIR = os.path.dirname(SDK_DIR)
@@ skipping 118 matching lines @@
   buildbot_common.MakeDir(pepperdir)
 
 
 def BuildStepMakePepperDirs(pepperdir, subdirs):
   for subdir in subdirs:
     buildbot_common.MakeDir(os.path.join(pepperdir, subdir))
 
 
 def BuildStepCopyTextFiles(pepperdir, pepper_ver, revision):
   buildbot_common.BuildStep('Add Text Files')
-  files = ['AUTHORS', 'COPYING', 'LICENSE', 'NOTICE']
+  files = ['AUTHORS', 'COPYING', 'LICENSE']
   files = [os.path.join(SDK_SRC_DIR, filename) for filename in files]
   oshelpers.Copy(['-v'] + files + [pepperdir])
 
   # Replace a few placeholders in README
   readme_text = open(os.path.join(SDK_SRC_DIR, 'README'), 'rt').read()
   readme_text = readme_text.replace('${VERSION}', pepper_ver)
   readme_text = readme_text.replace('${REVISION}', revision)
 
   # Year/Month/Day Hour:Minute:Second
   time_format = '%Y/%m/%d %H:%M:%S'
@@ skipping 523 matching lines @@
       # Clean to remove temporary files but keep the built libraries.
       buildbot_common.Run([make, '-j8', 'clean'],
                           cwd=os.path.abspath(make_dir))
 
 
 def BuildStepBuildLibraries(pepperdir, platform, directory, clean=True):
   BuildStepMakeAll(pepperdir, platform, directory, 'Build Libraries',
       clean=clean)
 
 
+def BuildStepGenerateNotice(pepperdir):
+  # Look for LICENSE files
+  license_filenames_re = re.compile('LICENSE|COPYING')
+
+  license_files = []
+  for root, _, files in os.walk(pepperdir):
+    for filename in files:
+      if license_filenames_re.match(filename):
+        path = os.path.join(root, filename)
+        license_files.append(path)
+  print '\n'.join(license_files)
+
+  notice_filename = os.path.join(pepperdir, 'NOTICE')
+  args = ['--root', pepperdir, '-o', notice_filename]
+  args += license_files
+  generate_notice.main(args)

[Sam Clegg, 2012/10/06 01:05:59]

Seems a little strange to me to construct command line
args and call another script's main() function.. but that
could just be me.

I'd sooner see a generate() function in generate_notice
that takes root=, filename= etc as args, then main() and
this function can both call that.

[binji, 2012/10/08 17:51:48]

Done.

+
+
 def BuildStepTarBundle(pepper_ver, tarfile):
   buildbot_common.BuildStep('Tar Pepper Bundle')
   buildbot_common.MakeDir(os.path.dirname(tarfile))
   buildbot_common.Run([sys.executable, CYGTAR, '-C', OUT_DIR, '-cjf', tarfile,
        'pepper_' + pepper_ver], cwd=NACL_DIR)
 
 
 def GetManifestBundle(pepper_ver, revision, tarfile, archive_url):
   with open(tarfile, 'rb') as tarfile_stream:
     archive_sha1, archive_size = manifest_util.DownloadAndComputeHash(
@@ skipping 231 matching lines @@
     BuildStepCopyTextFiles(pepperdir, pepper_ver, clnumber)
     BuildStepUntarToolchains(pepperdir, platform, arch, toolchains)
     BuildStepBuildToolchains(pepperdir, platform, arch, pepper_ver, toolchains)
     InstallHeaders(os.path.join(pepperdir, 'include'), None, 'libs')
     BuildStepCopyBuildHelpers(pepperdir, platform)
     BuildStepCopyExamples(pepperdir, toolchains, options.build_experimental,
                           True)
 
     # Ship with libraries prebuilt, so run that first.
     BuildStepBuildLibraries(pepperdir, platform, 'src')
+    BuildStepGenerateNotice(pepperdir)
 
     if not options.skip_tar:
       BuildStepTarBundle(pepper_ver, tarfile)
       build_updater.BuildUpdater(OUT_DIR)
 
       # BuildStepTestUpdater downloads the bundle to its own directory. Build
       # the examples and test from this directory instead of the original.
       pepperdir = BuildStepTestUpdater(platform, pepper_ver, clnumber, tarfile)
       BuildStepBuildExamples(pepperdir, platform)
       BuildStepCopyTests(pepperdir, toolchains, options.build_experimental,
                          True)
       BuildStepBuildTests(pepperdir, platform)
       if options.test_examples:
         BuildStepRunPyautoTests(pepperdir, platform, pepper_ver)
 
       # Archive on non-trybots.
       if options.archive or buildbot_common.IsSDKBuilder():
         BuildStepArchiveBundle(pepper_ver, clnumber, tarfile)
         BuildStepArchiveSDKTools()
 
   return 0
 
 
 if __name__ == '__main__':
   sys.exit(main(sys.argv))