Merge pull request swiftlang#71 from benlangmuir/build-script-helper

[build-script] Add build-script-helper.py

Author: benlangmuir

Tests/SKCoreTests/ToolchainRegistryTests.swift

@@ -228,10 +228,9 @@ final class ToolchainRegistryTests: XCTestCase {
     XCTAssertNil(tr.default)
     XCTAssert(tr.toolchains.isEmpty)
 
-    try! setenv("SOURCEKIT_TOOLCHAIN_PATH", value: binPath.parentDirectory.asString)
-    defer { try! setenv("SOURCEKIT_TOOLCHAIN_PATH", value: "") }
+    try! setenv("TEST_SOURCEKIT_TOOLCHAIN_PATH_1", value: binPath.parentDirectory.asString)
 
-    tr.scanForToolchains(fs)
+    tr.scanForToolchains(environmentVariables: ["TEST_SOURCEKIT_TOOLCHAIN_PATH_1"], fs)
 
     guard let tc = tr.toolchains.first(where: { tc in tc.path == binPath.parentDirectory }) else {
       XCTFail("couldn't find expected toolchain")
@@ -256,10 +255,10 @@ final class ToolchainRegistryTests: XCTestCase {
     XCTAssertNil(tr.default)
     XCTAssert(tr.toolchains.isEmpty)
 
-    try! setenv("TEST_ENV_SOURCEKIT_TOOLCHAIN_PATH", value: binPath.parentDirectory.asString)
+    try! setenv("TEST_ENV_SOURCEKIT_TOOLCHAIN_PATH_2", value: binPath.parentDirectory.asString)
 
     tr.scanForToolchains(
-      environmentVariables: ["TEST_ENV_SOURCEKIT_TOOLCHAIN_PATH"],
+      environmentVariables: ["TEST_ENV_SOURCEKIT_TOOLCHAIN_PATH_2"],
       setDefault: false,
       fs)
 

Utilities/build-script-helper.py

@@ -0,0 +1,80 @@
+#!/usr/bin/env python
+
+from __future__ import print_function
+
+import argparse
+import os
+import platform
+import subprocess
+import sys
+
+def swiftpm(action, swift_exec, swiftpm_args, env=None):
+  cmd = [swift_exec, action] + swiftpm_args
+  print(' '.join(cmd))
+  subprocess.check_call(cmd, env=env)
+
+def get_swiftpm_options(args):
+  swiftpm_args = [
+    '--package-path', args.package_path,
+    '--build-path', args.build_path,
+    '--configuration', args.configuration,
+  ]
+
+  if args.verbose:
+    swiftpm_args += ['--verbose']
+
+  if args.configuration == 'release':
+    # Enable running tests that use @testable in release builds.
+    swiftpm_args += ['-Xswiftc', '-enable-testing']
+
+  if platform.system() != 'Darwin':
+    swiftpm_args += [
+      # Dispatch headers
+      '-Xcxx', '-I', '-Xcxx',
+      os.path.join(args.toolchain, 'usr', 'lib', 'swift'),
+    ]
+
+  return swiftpm_args
+
+def main():
+  parser = argparse.ArgumentParser(description='Build along with the Swift build-script.')
+  def add_common_args(parser):
+    parser.add_argument('--package-path', metavar='PATH', help='directory of the package to build', default='.')
+    parser.add_argument('--toolchain', required=True, metavar='PATH', help='build using the toolchain at PATH')
+    parser.add_argument('--build-path', metavar='PATH', default='.build', help='build in the given path')
+    parser.add_argument('--configuration', '-c', default='debug', help='build using configuration (release|debug)')
+    parser.add_argument('--verbose', '-v', action='store_true', help='enable verbose output')
+
+  subparsers = parser.add_subparsers(title='subcommands', dest='action', metavar='action')
+  build_parser = subparsers.add_parser('build', help='build the package')
+  add_common_args(build_parser)
+
+  test_parser = subparsers.add_parser('test', help='test the package')
+  add_common_args(test_parser)
+
+  args = parser.parse_args(sys.argv[1:])
+
+  # Canonicalize paths
+  args.package_path = os.path.abspath(args.package_path)
+  args.build_path = os.path.abspath(args.build_path)
+  args.toolchain = os.path.abspath(args.toolchain)
+
+  if args.toolchain:
+    swift_exec = os.path.join(args.toolchain, 'usr', 'bin', 'swift')
+  else:
+    swift_exec = 'swift'
+
+  swiftpm_args = get_swiftpm_options(args)
+
+  if args.action == 'build':
+    swiftpm('build', swift_exec, swiftpm_args)
+  elif args.action == 'test':
+    # Set the toolchain used in tests at runtime
+    env = os.environ
+    env['SOURCEKIT_TOOLCHAIN_PATH'] = args.toolchain
+    swiftpm('test', swift_exec, swiftpm_args, env)
+  else:
+    assert False, 'unknown action \'{}\''.format(args.action)
+
+if __name__ == '__main__':
+  main()