Group functions in build-script-helper.py

Author: ahoppen

build-script-helper.py

@@ -19,12 +19,92 @@
 import os, platform
 import subprocess
 
-def printerr(message):
+# -----------------------------------------------------------------------------
+# General utilities
+
+def printerr(message: str):
   print(message, file=sys.stderr)
 
-def main(argv_prefix = []):
-  args = parse_args(argv_prefix + sys.argv[1:])
-  run(args)
+def check_call(cmd, verbose, env=os.environ, **kwargs):
+  if verbose:
+    print(' '.join([escape_cmd_arg(arg) for arg in cmd]))
+  return subprocess.check_call(cmd, env=env, stderr=subprocess.STDOUT, **kwargs)
+
+def check_output(cmd, verbose, env=os.environ, capture_stderr=True, **kwargs):
+  if verbose:
+    print(' '.join([escape_cmd_arg(arg) for arg in cmd]))
+  if capture_stderr:
+    stderr = subprocess.STDOUT
+  else:
+    stderr = subprocess.DEVNULL
+  return subprocess.check_output(cmd, env=env, stderr=stderr, encoding='utf-8', **kwargs)
+
+def escape_cmd_arg(arg):
+  if '"' in arg or ' ' in arg:
+    return '"%s"' % arg.replace('"', '\\"')
+  else:
+    return arg
+
+# -----------------------------------------------------------------------------
+# SwiftPM wrappers
+
+def update_swiftpm_dependencies(package_path, swift_exec, build_path, env, verbose):
+  args = [swift_exec, 'package', '--package-path', package_path, '--scratch-path', build_path, 'update']
+  check_call(args, env=env, verbose=verbose)
+
+def invoke_swift(package_path, swift_exec, action, products, build_path, multiroot_data_file, configuration, env, verbose):
+  # Until rdar://53881101 is implemented, we cannot request a build of multiple 
+  # targets simultaneously. For now, just build one product after the other.
+  for product in products:
+    invoke_swift_single_product(package_path, swift_exec, action, product, build_path, multiroot_data_file, configuration, env, verbose)
+
+def get_swiftpm_options(package_path, build_path, multiroot_data_file, configuration, verbose):
+  args = [ 
+    '--package-path', package_path, 
+    '--configuration', configuration, 
+    '--scratch-path', build_path
+  ]
+  if multiroot_data_file:
+    args += ['--multiroot-data-file', multiroot_data_file]
+  if verbose:
+    args += ['--verbose']
+  if platform.system() == 'Darwin':
+    args += [
+        '-Xlinker', '-rpath', '-Xlinker', '/usr/lib/swift',
+        '-Xlinker', '-rpath', '-Xlinker', '@executable_path/../lib/swift/macosx',
+        '-Xlinker', '-rpath', '-Xlinker', '@executable_path/../lib/swift-5.5/macosx',
+    ]
+  return args
+
+def get_swiftpm_environment_variables(no_local_deps):
+  env = dict(os.environ)
+  if not no_local_deps:
+    env['SWIFTCI_USE_LOCAL_DEPS'] = "1"
+  return env
+
+
+def invoke_swift_single_product(package_path, swift_exec, action, product, build_path, multiroot_data_file, configuration, env, verbose):
+  args = [swift_exec, action]
+  args += get_swiftpm_options(package_path, build_path, multiroot_data_file, configuration, verbose)
+  if action == 'test':
+    args += [
+      '--test-product', product,
+      '--disable-testable-imports'
+    ]
+  else:
+    args += ['--product', product]
+
+  check_call(args, env=env, verbose=verbose)
+
+def generate_xcodeproj(package_path, swift_exec, env, verbose):
+  package_name = os.path.basename(package_path)
+  xcodeproj_path = os.path.join(package_path, '%s.xcodeproj' % package_name)
+  args = [swift_exec, 'package', '--package-path', package_path, 'generate-xcodeproj', '--output', xcodeproj_path]
+  check_call(args, env=env, verbose=verbose)
+
+# -----------------------------------------------------------------------------
+# Argument parsing
+
 
 def parse_args(args):
   parser = argparse.ArgumentParser(prog='build-script-helper.py')
@@ -54,6 +134,14 @@ def parse_args(args):
 
   return parsed
 
+def should_run_action(action_name, selected_actions):
+  if action_name in selected_actions:
+    return True
+  elif "all" in selected_actions:
+    return True
+  else:
+    return False
+
 def run(args):
   package_name = os.path.basename(args.package_path)
 
@@ -139,87 +227,9 @@ def run(args):
         cmd = ['rsync', '-a', os.path.join(bin_path, 'swift-format'), os.path.join(prefix, 'bin')]
         check_call(cmd, verbose=args.verbose)
 
-def should_run_action(action_name, selected_actions):
-  if action_name in selected_actions:
-    return True
-  elif "all" in selected_actions:
-    return True
-  else:
-    return False
-
-def update_swiftpm_dependencies(package_path, swift_exec, build_path, env, verbose):
-  args = [swift_exec, 'package', '--package-path', package_path, '--scratch-path', build_path, 'update']
-  check_call(args, env=env, verbose=verbose)
-
-def invoke_swift(package_path, swift_exec, action, products, build_path, multiroot_data_file, configuration, env, verbose):
-  # Until rdar://53881101 is implemented, we cannot request a build of multiple 
-  # targets simultaneously. For now, just build one product after the other.
-  for product in products:
-    invoke_swift_single_product(package_path, swift_exec, action, product, build_path, multiroot_data_file, configuration, env, verbose)
-
-def get_swiftpm_options(package_path, build_path, multiroot_data_file, configuration, verbose):
-  args = [ 
-    '--package-path', package_path, 
-    '--configuration', configuration, 
-    '--scratch-path', build_path
-  ]
-  if multiroot_data_file:
-    args += ['--multiroot-data-file', multiroot_data_file]
-  if verbose:
-    args += ['--verbose']
-  if platform.system() == 'Darwin':
-    args += [
-        '-Xlinker', '-rpath', '-Xlinker', '/usr/lib/swift',
-        '-Xlinker', '-rpath', '-Xlinker', '@executable_path/../lib/swift/macosx',
-        '-Xlinker', '-rpath', '-Xlinker', '@executable_path/../lib/swift-5.5/macosx',
-    ]
-  return args
-
-def get_swiftpm_environment_variables(no_local_deps):
-  env = dict(os.environ)
-  if not no_local_deps:
-    env['SWIFTCI_USE_LOCAL_DEPS'] = "1"
-  return env
-
-
-def invoke_swift_single_product(package_path, swift_exec, action, product, build_path, multiroot_data_file, configuration, env, verbose):
-  args = [swift_exec, action]
-  args += get_swiftpm_options(package_path, build_path, multiroot_data_file, configuration, verbose)
-  if action == 'test':
-    args += [
-      '--test-product', product,
-      '--disable-testable-imports'
-    ]
-  else:
-    args += ['--product', product]
-
-  check_call(args, env=env, verbose=verbose)
-
-def generate_xcodeproj(package_path, swift_exec, env, verbose):
-  package_name = os.path.basename(package_path)
-  xcodeproj_path = os.path.join(package_path, '%s.xcodeproj' % package_name)
-  args = [swift_exec, 'package', '--package-path', package_path, 'generate-xcodeproj', '--output', xcodeproj_path]
-  check_call(args, env=env, verbose=verbose)
-
-def check_call(cmd, verbose, env=os.environ, **kwargs):
-  if verbose:
-    print(' '.join([escape_cmd_arg(arg) for arg in cmd]))
-  return subprocess.check_call(cmd, env=env, stderr=subprocess.STDOUT, **kwargs)
-
-def check_output(cmd, verbose, env=os.environ, capture_stderr=True, **kwargs):
-  if verbose:
-    print(' '.join([escape_cmd_arg(arg) for arg in cmd]))
-  if capture_stderr:
-    stderr = subprocess.STDOUT
-  else:
-    stderr = subprocess.DEVNULL
-  return subprocess.check_output(cmd, env=env, stderr=stderr, encoding='utf-8', **kwargs)
-
-def escape_cmd_arg(arg):
-  if '"' in arg or ' ' in arg:
-    return '"%s"' % arg.replace('"', '\\"')
-  else:
-    return arg
+def main(argv_prefix = []):
+  args = parse_args(argv_prefix + sys.argv[1:])
+  run(args)
 
 if __name__ == '__main__':
-  main()
+  main()