Build script changes to begin building and installing swift-testing into toolchains (on Darwin, so far)

Author: stmontgomery

utils/build-presets.ini

@@ -1319,6 +1319,7 @@ swift-driver
 # Failing to build in CI: rdar://78408440
 # swift-inspect
 swiftsyntax
+swift-testing
 swiftformat
 playgroundsupport
 indexstore-db
@@ -1363,6 +1364,7 @@ install-llbuild
 install-swiftpm
 install-swift-driver
 install-swiftsyntax
+install-swift-testing
 install-playgroundsupport
 install-sourcekit-lsp
 install-swiftformat

utils/build_swift/build_swift/driver_arguments.py

@@ -809,6 +809,11 @@ def create_argument_parser():
     option(['--wasmkit'], toggle_true('build_wasmkit'),
            help='build WasmKit')
 
+    option('--swift-testing', toggle_true('build_swift_testing'),
+           help='build swift-testing')
+    option('--install-swift-testing', toggle_true('install_swift_testing'),
+           help='install swift-testing')
+
     option('--xctest', toggle_true('build_xctest'),
            help='build xctest')
 

utils/build_swift/tests/expected_options.py

@@ -95,6 +95,7 @@
     'build_swiftpm': False,
     'build_swift_driver': False,
     'build_swift_libexec': True,
+    'build_swift_testing': False,
     'build_early_swift_driver': True,
     'build_early_swiftsyntax': True,
     'build_swiftsyntax': False,
@@ -111,6 +112,7 @@
     'install_static_linux_config': False,
     'install_swiftpm': False,
     'install_swiftsyntax': False,
+    'install_swift_testing': False,
     'install_swift_driver': False,
     'install_swiftdocc': False,
     'swiftsyntax_verify_generated_files': False,
@@ -566,6 +568,7 @@ class BuildScriptImplOption(_BaseOption):
     SetTrueOption('--swiftpm', dest='build_swiftpm'),
     SetTrueOption('--swift-driver', dest='build_swift_driver'),
     SetTrueOption('--swiftsyntax', dest='build_swiftsyntax'),
+    SetTrueOption('--swift-testing', dest='build_swift_testing'),
     SetTrueOption('--skstresstester', dest='build_skstresstester'),
     SetTrueOption('--swiftformat', dest='build_swiftformat'),
     SetTrueOption('--swiftdocc', dest='build_swiftdocc'),
@@ -646,6 +649,7 @@ class BuildScriptImplOption(_BaseOption):
     EnableOption('--install-llvm', dest='install_llvm'),
     EnableOption('--install-static-linux-config', dest='install_static_linux_config'),
     EnableOption('--install-swiftsyntax', dest='install_swiftsyntax'),
+    EnableOption('--install-swift-testing', dest='install_swift_testing'),
     EnableOption('--swiftsyntax-verify-generated-files',
                  dest='swiftsyntax_verify_generated_files'),
     EnableOption('--swiftsyntax-enable-rawsyntax-validation',

utils/swift_build_support/swift_build_support/build_script_invocation.py

@@ -678,6 +678,8 @@ def compute_product_pipelines(self):
                             is_enabled=self.args.build_foundation)
         builder.add_product(products.SwiftSyntax,
                             is_enabled=self.args.build_swiftsyntax)
+        builder.add_product(products.SwiftTesting,
+                            is_enabled=self.args.build_swift_testing)
         builder.add_product(products.SwiftFormat,
                             is_enabled=self.args.build_swiftformat)
         builder.add_product(products.SKStressTester,

utils/swift_build_support/swift_build_support/productpipeline_list_builder.py

@@ -101,7 +101,7 @@ def add_product(self, product_cls, is_enabled):
         self.current_pipeline.append(product_cls, is_enabled)
 
     def add_impl_product(self, product_cls, is_enabled):
-        """Add a non-impl product to the current pipeline begin constructed"""
+        """Add an impl product to the current pipeline begin constructed"""
         assert self.current_pipeline is not None
         assert self.is_current_pipeline_impl
         assert product_cls.is_build_script_impl_product()

utils/swift_build_support/swift_build_support/products/__init__.py

@@ -30,6 +30,7 @@
 from .sourcekitlsp import SourceKitLSP
 from .staticswiftlinux import StaticSwiftLinuxConfig
 from .swift import Swift
+from .swift_testing import SwiftTesting
 from .swiftdocc import SwiftDocC
 from .swiftdoccrender import SwiftDocCRender
 from .swiftdriver import SwiftDriver
@@ -68,6 +69,7 @@
     'SwiftInspect',
     'SwiftPM',
     'SwiftDriver',
+    'SwiftTesting',
     'EarlySwiftDriver',
     'XCTest',
     'SwiftSyntax',

utils/swift_build_support/swift_build_support/products/swift_testing.py

@@ -0,0 +1,67 @@
+# swift_build_support/products/xctest.py -------------------------*- python -*-
+#
+# This source file is part of the Swift.org open source project
+#
+# Copyright (c) 2024 Apple Inc. and the Swift project authors
+# Licensed under Apache License v2.0 with Runtime Library Exception
+#
+# See https://swift.org/LICENSE.txt for license information
+# See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+#
+# ----------------------------------------------------------------------------
+
+import os
+
+from . import cmake_product
+from . import swift
+from . import swiftsyntax
+
+class SwiftTesting(cmake_product.CMakeProduct):
+    @classmethod
+    def is_build_script_impl_product(cls):
+        return False
+
+    @classmethod
+    def is_before_build_script_impl_product(cls):
+        return False
+
+    @classmethod
+    def product_source_name(cls):
+        return "swift-testing"
+
+    @classmethod
+    def get_dependencies(cls):
+        return [swift.Swift,
+                swiftsyntax.SwiftSyntax]
+
+    def should_build(self, host_target):
+        return True
+
+    def build(self, host_target):
+        self.cmake_options.define('BUILD_SHARED_LIBS', 'YES')
+
+        # Use empty CMake install prefix, since the `DESTDIR` env var is set by
+        # `install_with_cmake` later which already has the same prefix.
+        self.cmake_options.define('CMAKE_INSTALL_PREFIX', '')
+
+        build_root = os.path.dirname(self.build_dir)
+        swift_build_dir = os.path.join(
+            '..', build_root, '%s-%s' % ('swift', host_target))
+        swift_cmake_dir = os.path.join(swift_build_dir, 'cmake', 'modules')
+        self.cmake_options.define('SwiftSyntax_DIR:PATH', swift_cmake_dir)
+
+        self.build_with_cmake([], self.args.build_variant, [],
+                              prefer_native_toolchain=True)
+
+    def should_test(self, host_target):
+        # TODO
+        return False
+
+    def should_install(self, host_target):
+        return self.args.install_swift_testing
+
+    def install(self, host_target):
+        install_destdir = self.host_install_destdir(host_target)
+        install_prefix = install_destdir + self.args.install_prefix
+
+        self.install_with_cmake(['install'], install_prefix)