[build-script] Separate SwiftTestinMacros from SwiftTesting product

Also, build them for all hosts including cross compiling host.

Author: rintaro

utils/build-presets.ini

@@ -384,6 +384,7 @@ sourcekit-lsp
 swiftsyntax
 swiftformat
 swift-testing
+swift-testing-macros
 
 skstresstester
 
@@ -408,6 +409,7 @@ install-swift-driver
 install-swiftsyntax
 install-swiftformat
 install-swift-testing
+install-swift-testing-macros
 
 [preset: buildbot_incremental,tools=RA,stdlib=RA,apple_silicon]
 mixin-preset=buildbot_incremental,tools=RA,stdlib=RA
@@ -842,6 +844,7 @@ llbuild
 swiftpm
 swift-driver
 swift-testing
+swift-testing-macros
 xctest
 swiftdocc
 swiftformat
@@ -856,6 +859,7 @@ install-swiftpm
 install-swift-driver
 install-swiftsyntax
 install-swift-testing
+install-swift-testing-macros
 install-xctest
 install-prefix=/usr
 install-sourcekit-lsp
@@ -1185,6 +1189,7 @@ swiftpm
 swift-driver
 xctest
 swift-testing
+swift-testing-macros
 foundation
 libdispatch
 swiftsyntax
@@ -1203,6 +1208,7 @@ install-foundation
 install-libdispatch
 install-xctest
 install-swift-testing
+install-swift-testing-macros
 install-swiftformat
 
 [preset: buildbot_incremental_linux,long_test]
@@ -1327,6 +1333,7 @@ swift-driver
 # swift-inspect
 swiftsyntax
 swift-testing
+swift-testing-macros
 swiftformat
 playgroundsupport
 indexstore-db
@@ -1372,6 +1379,7 @@ install-swiftpm
 install-swift-driver
 install-swiftsyntax
 install-swift-testing
+install-swift-testing-macros
 install-playgroundsupport
 install-sourcekit-lsp
 install-swiftformat
@@ -1696,6 +1704,7 @@ swiftpm
 swift-driver
 swiftsyntax
 swift-testing
+swift-testing-macros
 swiftformat
 swiftdocc
 
@@ -1716,6 +1725,7 @@ install-swiftpm
 install-swift-driver
 install-swiftsyntax
 install-swift-testing
+install-swift-testing-macros
 install-swiftdocc
 install-swiftformat
 

utils/build_swift/build_swift/driver_arguments.py

@@ -813,6 +813,11 @@ def create_argument_parser():
            help='build Swift Testing')
     option('--install-swift-testing', toggle_true('install_swift_testing'),
            help='install Swift Testing')
+    option('--swift-testing-macros', toggle_true('build_swift_testing_macros'),
+           help='build Swift Testing macro plugin')
+    option('--install-swift-testing-macros',
+           toggle_true('install_swift_testing_macros'),
+           help='install Swift Testing macro plugin')
 
     option('--xctest', toggle_true('build_xctest'),
            help='build xctest')

utils/build_swift/tests/expected_options.py

@@ -96,6 +96,7 @@
     'build_swift_driver': False,
     'build_swift_libexec': True,
     'build_swift_testing': False,
+    'build_swift_testing_macros': False,
     'build_early_swift_driver': True,
     'build_early_swiftsyntax': True,
     'build_swiftsyntax': False,
@@ -113,6 +114,7 @@
     'install_swiftpm': False,
     'install_swiftsyntax': False,
     'install_swift_testing': False,
+    'install_swift_testing_macros': False,
     'install_swift_driver': False,
     'install_swiftdocc': False,
     'swiftsyntax_verify_generated_files': False,
@@ -569,6 +571,7 @@ class BuildScriptImplOption(_BaseOption):
     SetTrueOption('--swift-driver', dest='build_swift_driver'),
     SetTrueOption('--swiftsyntax', dest='build_swiftsyntax'),
     SetTrueOption('--swift-testing', dest='build_swift_testing'),
+    SetTrueOption('--swift-testing-macros', dest='build_swift_testing_macros'),
     SetTrueOption('--skstresstester', dest='build_skstresstester'),
     SetTrueOption('--swiftformat', dest='build_swiftformat'),
     SetTrueOption('--swiftdocc', dest='build_swiftdocc'),
@@ -650,6 +653,8 @@ class BuildScriptImplOption(_BaseOption):
     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('--install-swift-testing-macros',
+                 dest='install_swift_testing_macros'),
     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.SwiftTestingMacros,
+                            is_enabled=self.args.build_swift_testing_macros)
         builder.add_product(products.SwiftTesting,
                             is_enabled=self.args.build_swift_testing)
         builder.add_product(products.SwiftFormat,

utils/swift_build_support/swift_build_support/products/__init__.py

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

utils/swift_build_support/swift_build_support/products/product.py

@@ -293,7 +293,7 @@ def target_for_platform(self, platform, arch, include_version=True):
                 arch, self.args.darwin_deployment_version_xros)
         return target
 
-    def generate_darwin_toolchain_file(self, platform, arch):
+    def generate_darwin_toolchain_file(self, platform, arch, version=None):
         """
         Generates a new CMake tolchain file that specifies Darwin as a target
         platform.
@@ -306,9 +306,14 @@ def generate_darwin_toolchain_file(self, platform, arch):
 
         cmake_osx_sysroot = xcrun.sdk_path(platform)
 
-        target = self.target_for_platform(platform, arch)
-        if not target:
-            raise RuntimeError('Unhandled platform {}?!'.format(platform))
+        if platform == 'macosx':
+            if version is None:
+                version = self.args.darwin_deployment_version_osx
+            target = '{}-apple-macosx{}'.format(arch, version)
+        else:
+            target = self.target_for_platform(platform, arch)
+            if not target:
+                raise RuntimeError('Unhandled platform {}?!'.format(platform))
 
         toolchain_args = {}
 
@@ -429,7 +434,8 @@ def generate_linux_toolchain_file(self, platform, arch):
 
         return toolchain_file
 
-    def generate_toolchain_file_for_darwin_or_linux(self, host_target):
+    def generate_toolchain_file_for_darwin_or_linux(
+            self, host_target, override_deployment_version=None):
         """
         Checks `host_target` platform and generates a new CMake tolchain file
         appropriate for that target platform (either Darwin or Linux). Defines
@@ -448,7 +454,8 @@ def generate_toolchain_file_for_darwin_or_linux(self, host_target):
 
         toolchain_file = None
         if self.is_darwin_host(host_target):
-            toolchain_file = self.generate_darwin_toolchain_file(platform, arch)
+            toolchain_file = self.generate_darwin_toolchain_file(
+                platform, arch, version=override_deployment_version)
             self.cmake_options.define('CMAKE_TOOLCHAIN_FILE:PATH', toolchain_file)
         elif platform == "linux":
             toolchain_file = self.generate_linux_toolchain_file(platform, arch)

utils/swift_build_support/swift_build_support/products/swift_testing.py

@@ -13,10 +13,11 @@
 import os
 
 from . import cmake_product
+from . import product
 from . import swift
 
 
-class SwiftTesting(cmake_product.CMakeProduct):
+class SwiftTesting(product.Product):
     @classmethod
     def is_build_script_impl_product(cls):
         return False
@@ -36,7 +37,57 @@ def get_dependencies(cls):
     def should_build(self, host_target):
         return True
 
+    def should_test(self, host_target):
+        return False
+
+    def should_install(self, host_target):
+        return self.args.install_swift_testing_macros
+
+    def _impl_product(self, host_target):
+        build_root = os.path.dirname(self.build_dir)
+        build_dir = os.path.join(
+            build_root, '%s-%s' % (self.product_name(), host_target))
+
+        return SwiftTestingImpl(
+            args=self.args,
+            toolchain=self.toolchain,
+            source_dir=self.source_dir,
+            build_dir=build_dir)
+
+    def _build_impl(self, host_target):
+        self._impl_product(host_target).build(host_target)
+
+    def build(self, host_target):
+        self._build_impl(host_target)
+
+        # For Darwin host, 'build' is only called for the builder.
+        # Manually iterate tor the cross compile hosts.
+        if self.has_cross_compile_hosts() and self.is_darwin_host(host_target):
+            for target in self.args.cross_compile_hosts:
+                self._build_impl(target)
+
+        # FIXME: build testing library for 'stdlib_deployment_targets'?
+        pass
+
+    def _install_impl(self, host_target):
+        self._impl_product(host_target).install(host_target)
+
+    def install(self, host_target):
+        self._install_impl(host_target)
+
+        # For Darwin host, 'install' is only called for the builder.
+        # Manually iterate tor the cross compile hosts.
+        if self.has_cross_compile_hosts() and self.is_darwin_host(host_target):
+            for target in self.args.cross_compile_hosts:
+                self._install_impl(target)
+
+
+class SwiftTestingImpl(cmake_product.CMakeProduct):
     def build(self, host_target):
+        override_version = None
+        if host_target.startswith('macosx'):
+            override_version = '10.15'
+
         self.cmake_options.define('BUILD_SHARED_LIBS', 'YES')
 
         # Use empty CMake install prefix, since the `DESTDIR` env var is set by
@@ -45,21 +96,105 @@ def build(self, host_target):
 
         self.cmake_options.define('CMAKE_BUILD_TYPE', self.args.build_variant)
 
-        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)
+        # FIXME: If we build macros for the builder, specify the path.
+        self.cmake_options.define('SwiftTesting_MACRO', 'NO')
 
+        self.generate_toolchain_file_for_darwin_or_linux(
+            host_target, override_deployment_version=override_version)
         self.build_with_cmake([], self.args.build_variant, [],
                               prefer_native_toolchain=True)
 
+    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)
+
+
+class SwiftTestingMacros(product.Product):
+    @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/Sources/TestingMacros"
+
+    @classmethod
+    def get_dependencies(cls):
+        return [swift.Swift]
+
+    def should_build(self, host_target):
+        return True
+
     def should_test(self, host_target):
-        # TODO
         return False
 
     def should_install(self, host_target):
-        return self.args.install_swift_testing
+        return self.args.install_swift_testing_macros
+
+    def _impl_product(self, host_target):
+        build_root = os.path.dirname(self.build_dir)
+        build_dir = os.path.join(
+            build_root, '%s-%s' % (self.product_name(), host_target))
+
+        return SwiftTestingMacrosImpl(
+            args=self.args,
+            toolchain=self.toolchain,
+            source_dir=self.source_dir,
+            build_dir=build_dir)
+
+    def _build_impl(self, host_target):
+        self._impl_product(host_target).build(host_target)
+
+    def build(self, host_target):
+        self._build_impl(host_target)
+
+        # For Darwin host, 'build' is only called for the builder.
+        # Manually iterate tor the cross compile hosts.
+        if self.has_cross_compile_hosts() and self.is_darwin_host(host_target):
+            for target in self.args.cross_compile_hosts:
+                self._build_impl(target)
+
+    def _install_impl(self, host_target):
+        self._impl_product(host_target).install(host_target)
+
+    def install(self, host_target):
+        self._install_impl(host_target)
+
+        # For Darwin host, 'install' is only called for the builder.
+        # Manually iterate tor the cross compile hosts.
+        if self.has_cross_compile_hosts() and self.is_darwin_host(host_target):
+            for target in self.args.cross_compile_hosts:
+                self._install_impl(target)
+
+
+class SwiftTestingMacrosImpl(cmake_product.CMakeProduct):
+    def build(self, host_target):
+        override_version = None
+        if host_target.startswith('macosx'):
+            override_version = '10.15'
+
+        # 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', '')
+
+        self.cmake_options.define('CMAKE_BUILD_TYPE', self.args.build_variant)
+
+        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.generate_toolchain_file_for_darwin_or_linux(
+            host_target, override_deployment_version=override_version)
+        self.build_with_cmake([], self.args.build_variant, [],
+                              prefer_native_toolchain=True)
 
     def install(self, host_target):
         install_destdir = self.host_install_destdir(host_target)