Build and install swift-testing in toolchains #75515

rintaro · 2024-07-26T22:33:50Z

(Supersedes #74582)

Include swift-testing to update-checkout's main scheme
(build-script) Add SwiftTesting product to swift_build_support and integrate it to the build pipeline
(build.ps1) Add Build-SwiftTestingMacros and Build-SwiftTesting functions, and integrate it to the pipeline
Testing just-built swift-testing is not implemented in this PR.

Build presets:

For toolchain packaging
- mixin_linux_installation
- mixin_osx_package_base
For CI testing:
- buildbot_all_platforms,tools=RA,stdlib=RA
- buildbot_incremental,tools=RA,stdlib=RA
- buildbot_incremental_linux

Install locations:

macOS (Dedicated directories to precede Testing.framework in the Xcode SDK):

├── usr/lib/swift/macosx/testing
│                        ├── Testing.swiftmodule
│                        │   ├── ${MODULE_TRIPLE}.swiftdoc
│                        │   ├── ${MODULE_TRIPLE}.swiftinterface
│                        │   └── ${MODULE_TRIPLE}.swiftmodule
│                        └── libTesting.dylib
└── usr/lib/swift/host/plugins/testing
                               └── libTestingMacros.dylib

Linux (Following XCTest):

├── usr/lib/swift/linux
│                 ├── Testing.swiftmodule
│                 │   ├── ${MODULE_TRIPLE}.swiftdoc
│                 │   └── ${MODULE_TRIPLE}.swiftmodule
│                 └── libTesting.so
└── usr/lib/swift/host/plugins
                       └── libTestingMacros.so

Windows (Following XCTest scheme + plugin in the toolchain):

├── Platforms/${SDK_VERSION}/Windows.platform/Developer/Library/Testing-{SWIFT_TESTING_VERSION}
│   └─── usr
│        ├─── ${BIN_ARCH} // e.g. 'bin64'
│        │    └── Testing.dll
│        └─── lib/swift/windows
│             ├─── ${LIB_ARCH} // e.g. 'x86_64'
│             │    └── Testing.lib
│             └─── Testing.swiftmodule
│                  ├── ${MODULE_TRIPLE}.swiftdoc
│                  └── ${MODULE_TRIPLE}.swiftmodule
└─── Toolchains/${TOOLCHAIN_VERSION}/usr/bin
     └── TestingMacros.dll

utils/build.ps1

rintaro · 2024-08-05T16:31:06Z

swiftlang/swift-testing#581
swiftlang/swift-package-manager#7840
swiftlang/swift-installer-scripts#317
@swift-ci Please test

edymtt

Looks good to me with regard to the build-script changes.

edymtt · 2024-08-05T19:25:59Z

utils/swift_build_support/swift_build_support/products/swift_testing.py

+
+    @classmethod
+    def get_dependencies(cls):
+        return [swift.Swift]


Thanks for incorporating my feedback from the original PR!

rintaro · 2024-08-05T20:17:10Z

swiftlang/swift-testing#581
swiftlang/swift-package-manager#7840
swiftlang/swift-installer-scripts#317
@swift-ci Please smoke test macOS

rintaro · 2024-08-05T20:49:51Z

swiftlang/swift-testing#581
swiftlang/swift-installer-scripts#317
@swift-ci Please smoke test macOS

rintaro · 2024-08-05T21:20:44Z

@swift-ci Please smoke test

rintaro · 2024-08-05T21:30:51Z

swiftlang/swift-testing#581
swiftlang/swift-installer-scripts#317
@swift-ci Please smoke test macOS

rintaro · 2024-08-05T23:54:23Z

swiftlang/swift-testing#581
swiftlang/swift-installer-scripts#317
@swift-ci Please smoke test Windows

rintaro · 2024-08-05T23:54:29Z

swiftlang/swift-testing#581
swiftlang/swift-installer-scripts#317
@swift-ci Please smoke test Linux

stmontgomery

Looks great! Thank you so much for picking up this effort!

compnerd

The windows build support changes look good modulo minor tweak.

compnerd · 2024-08-06T02:48:34Z

utils/build.ps1

@@ -2358,6 +2418,7 @@ if (-not $ToBatch) {
 }

 if (-not $SkipBuild) {
+  Invoke-BuildStep Build-SwiftTestingMacros $HostArch


Can we move this next to the call to Build-SwiftTesting above?

We can't move this right next to Build-SwiftTesting call because it is for $WindowsSDKArchs not $HostArch. To what line you want to move this exactly?

Wait, why is it being built for each architecture for the SDK? The macros run at compile time, so we should only have to build it for the host that the toolchain is being built for.

Yes, TestingMacros is built for the host only, Testing is built for each SDK arch. That's how I implemented. Am I missing anything?

The macros should be running with the compiler (host) not the SDK environment (target). So, I'm not sure I understand why we are building it in all these cases.

rintaro · 2024-08-06T04:32:17Z

swiftlang/swift-testing#581
swiftlang/swift-installer-scripts#317
@swift-ci Please smoke test

* Remove SwiftSyntax product dependency * Correct CMAKE_BUILD_TYPE

* Basically following XCTest scheme. * Build TestingMacro separately from Testing library and install it to the toolchain's `bin` * Testing swift-testing itself is TODO

utils/build-presets.ini

rintaro · 2024-08-09T04:02:02Z

swiftlang/swift-testing#581
swiftlang/swift-installer-scripts#317
@swift-ci Please build toolchain macOS

rintaro · 2024-08-09T04:27:31Z

swiftlang/swift-testing#581
swiftlang/swift-installer-scripts#317
@swift-ci Please build toolchain macOS

rintaro · 2024-08-09T07:22:59Z

swiftlang/swift-syntax#2793
swiftlang/swift-testing#581
swiftlang/swift-installer-scripts#317
@swift-ci Please build toolchain macOS

rintaro · 2024-08-09T07:23:28Z

swiftlang/swift-syntax#2793
swiftlang/swift-testing#581
swiftlang/swift-installer-scripts#317
@swift-ci Please build toolchain Linux

rintaro · 2024-08-09T07:23:41Z

swiftlang/swift-syntax#2793
swiftlang/swift-testing#581
swiftlang/swift-installer-scripts#317
@swift-ci Please build toolchain Windows

rintaro · 2024-08-09T15:47:58Z

swiftlang/swift-syntax#2795
swiftlang/swift-testing#581
swiftlang/swift-installer-scripts#317
@swift-ci Please build toolchain Linux

rintaro · 2024-08-09T17:12:35Z

utils/swift_build_support/swift_build_support/products/swift_testing.py

+        self._build_impl(host_target)
+
+        # For Darwin host, 'build' is only called for the builder.
+        # Manually iterate tor the cross compile hosts.


Suggested change

# Manually iterate tor the cross compile hosts.

# Manually iterate the cross compile hosts.

and other places

edymtt · 2024-08-09T20:12:49Z

utils/swift_build_support/swift_build_support/products/swift_testing.py

+        self.install_with_cmake(['install'], install_prefix)
+
+
+class SwiftTestingMacros(product.Product):


(Optional) I would suggest to put the classes for SwiftTesting macros in a separate file, to maintain the convention that one file targets one build product.

edymtt · 2024-08-09T20:14:02Z

utils/swift_build_support/swift_build_support/products/swift_testing.py

+                self._install_impl(target)
+
+
+class SwiftTestingMacrosImpl(cmake_product.CMakeProduct):


(Optional) Impl in this and SwiftTestingImpl can suggest this implements a build-script-impl product -- but I cannot think of a better alternative

Suggested change

class SwiftTestingMacrosImpl(cmake_product.CMakeProduct):

class SwiftTestingMacrosCMakeShim(cmake_product.CMakeProduct):

edymtt · 2024-08-09T20:17:18Z

utils/swift_build_support/swift_build_support/products/swift_testing.py

+            for target in self.args.cross_compile_hosts:
+                self._build_impl(target)
+
+    def _install_impl(self, host_target):


(Optional) In this and other places, _impl can suggest this is part of a build-script-impl product

Suggested change

def _install_impl(self, host_target):

def _install_with_cmake(self, host_target):

edymtt · 2024-08-09T20:18:24Z

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):


(Optional) It may make sense to state the intent of the version parameter so not to "overload" it with additional meanings in the future

Suggested change

def generate_darwin_toolchain_file(self, platform, arch, version=None):

def generate_darwin_toolchain_file(self, platform, arch, macos_deployment_version=None):

edymtt · 2024-08-09T20:19:30Z

utils/swift_build_support/swift_build_support/products/product.py

@@ -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):


(optional) override_deployment_version may imply this applies to Linux

Suggested change

self, host_target, override_deployment_version=None):

self, host_target, override_macos_deployment_version=None):

edymtt · 2024-08-09T20:22:11Z

utils/swift_build_support/swift_build_support/products/swift_testing.py

+    def build(self, host_target):
+        override_version = None
+        if host_target.startswith('macosx'):
+            override_version = '10.15'


We may want to override this only if the macOS deployment version is lower than the desired one -- this way if the default changes or the user uses a newer one we are not stuck with an old version

This suggestion is an expedient way to achieve this in this context -- we should likely prefer the functions defined in https://github.com/swiftlang/swift/blob/main/utils/build_swift/build_swift/versions.py

Suggested change

override_version = '10.15'

def version_parse(version_string):

return list(map(lambda x: int(x), version_string.split(".")))

if version_parse(self.args.darwin_deployment_version_osx) < (10, 15):

override_version = '10.15'

Taking a stab using the Version class:

Suggested change

override_version = '10.15'

from build_swift.build_swift.versions import Version

if Version(self.args.darwin_deployment_version_osx) < Version('10.15'):

override_version = '10.15'

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

rintaro · 2024-08-09T21:52:19Z

swiftlang/swift-testing#581
swiftlang/swift-installer-scripts#317
@swift-ci Please test

rintaro commented Jul 26, 2024

View reviewed changes

utils/build.ps1 Outdated Show resolved Hide resolved

utils/build.ps1 Show resolved Hide resolved

rintaro commented Jul 26, 2024

View reviewed changes

utils/build.ps1 Outdated Show resolved Hide resolved

rintaro mentioned this pull request Jul 27, 2024

Configure CMake build to install content into toolchain swiftlang/swift-testing#581

Merged

2 tasks

rintaro force-pushed the add-swift-testing branch 6 times, most recently from 243d971 to b8740cf Compare August 3, 2024 03:00

rintaro mentioned this pull request Aug 3, 2024

[PackageModel] Support swift-testing installed in a toolchain swiftlang/swift-package-manager#7840

Merged

rintaro force-pushed the add-swift-testing branch from b8740cf to f11ef1e Compare August 3, 2024 04:46

rintaro changed the title ~~[WIP] Build and install swift-testing in toolchains~~ Build and install swift-testing in toolchains Aug 3, 2024

rintaro marked this pull request as ready for review August 3, 2024 14:15

rintaro requested a review from shahmishal as a code owner August 3, 2024 14:15

rintaro requested review from compnerd, edymtt and bnbarham August 5, 2024 17:10

edymtt approved these changes Aug 5, 2024

View reviewed changes

rintaro force-pushed the add-swift-testing branch from 04e364a to 74a36f8 Compare August 5, 2024 21:20

rintaro force-pushed the add-swift-testing branch from 74a36f8 to b70f07e Compare August 5, 2024 21:30

stmontgomery approved these changes Aug 6, 2024

View reviewed changes

compnerd approved these changes Aug 6, 2024

View reviewed changes

rintaro added 3 commits August 8, 2024 13:13

[swift-testing] Build tweak

e06d38b

* Remove SwiftSyntax product dependency * Correct CMAKE_BUILD_TYPE

[Windows] Build and install swift-testing in Windows toolchains

f069aec

* Basically following XCTest scheme. * Build TestingMacro separately from Testing library and install it to the toolchain's `bin` * Testing swift-testing itself is TODO

[build-preset] Add swift-testing to incrmental bots

6a38329

rintaro force-pushed the add-swift-testing branch 3 times, most recently from d17634f to 9aa6f06 Compare August 8, 2024 22:44

rintaro commented Aug 8, 2024

View reviewed changes

utils/build-presets.ini Outdated Show resolved Hide resolved

rintaro force-pushed the add-swift-testing branch 2 times, most recently from 45c1be3 to bd5b4b0 Compare August 9, 2024 04:01

rintaro force-pushed the add-swift-testing branch from bd5b4b0 to 9460969 Compare August 9, 2024 04:25

rintaro commented Aug 9, 2024

View reviewed changes

swiftlang deleted a comment from xedin Aug 9, 2024

edymtt reviewed Aug 9, 2024

View reviewed changes

rintaro force-pushed the add-swift-testing branch from 9460969 to 2e6cc34 Compare August 9, 2024 21:40

[build-script] Separate SwiftTestinMacros from SwiftTesting product

e98c5ea

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

rintaro force-pushed the add-swift-testing branch from 2e6cc34 to e98c5ea Compare August 9, 2024 21:43

etcwilde approved these changes Aug 9, 2024

View reviewed changes

bnbarham approved these changes Aug 9, 2024

View reviewed changes

rintaro merged commit 1c6552f into swiftlang:main Aug 10, 2024
5 checks passed

rintaro mentioned this pull request Aug 12, 2024

[6.0] Build and install swift-testing in toolchains #75837

Merged

finagolfin mentioned this pull request Sep 27, 2024

Add support for Testing module finagolfin/swift-android-sdk#174

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Build and install swift-testing in toolchains #75515

Build and install swift-testing in toolchains #75515

rintaro commented Jul 26, 2024 •

edited

Loading

rintaro commented Aug 5, 2024

edymtt left a comment

edymtt Aug 5, 2024

rintaro commented Aug 5, 2024

rintaro commented Aug 5, 2024

rintaro commented Aug 5, 2024

rintaro commented Aug 5, 2024

rintaro commented Aug 5, 2024

rintaro commented Aug 5, 2024

stmontgomery left a comment

compnerd left a comment

compnerd Aug 6, 2024

rintaro Aug 6, 2024

compnerd Aug 6, 2024

rintaro Aug 6, 2024 •

edited

Loading

compnerd Aug 6, 2024

rintaro commented Aug 6, 2024

rintaro commented Aug 9, 2024

rintaro commented Aug 9, 2024

rintaro commented Aug 9, 2024

rintaro commented Aug 9, 2024

rintaro commented Aug 9, 2024

rintaro commented Aug 9, 2024

rintaro Aug 9, 2024 •

edited

Loading

edymtt Aug 9, 2024

edymtt Aug 9, 2024

edymtt Aug 9, 2024

edymtt Aug 9, 2024

edymtt Aug 9, 2024

edymtt Aug 9, 2024

edymtt Aug 9, 2024 •

edited

Loading

rintaro commented Aug 9, 2024

	# Manually iterate tor the cross compile hosts.
	# Manually iterate the cross compile hosts.

		self.install_with_cmake(['install'], install_prefix)


		class SwiftTestingMacros(product.Product):

		self._install_impl(target)


		class SwiftTestingMacrosImpl(cmake_product.CMakeProduct):

	class SwiftTestingMacrosImpl(cmake_product.CMakeProduct):
	class SwiftTestingMacrosCMakeShim(cmake_product.CMakeProduct):

	def _install_impl(self, host_target):
	def _install_with_cmake(self, host_target):

	def generate_darwin_toolchain_file(self, platform, arch, version=None):
	def generate_darwin_toolchain_file(self, platform, arch, macos_deployment_version=None):

	self, host_target, override_deployment_version=None):
	self, host_target, override_macos_deployment_version=None):

-            override_version = '10.15'
+            def version_parse(version_string):
+                return list(map(lambda x: int(x), version_string.split(".")))
+            if version_parse(self.args.darwin_deployment_version_osx) < (10, 15):
+                 override_version = '10.15'

Build and install swift-testing in toolchains #75515

Build and install swift-testing in toolchains #75515

Conversation

rintaro commented Jul 26, 2024 • edited Loading

rintaro commented Aug 5, 2024

edymtt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rintaro commented Aug 5, 2024

rintaro commented Aug 5, 2024

rintaro commented Aug 5, 2024

rintaro commented Aug 5, 2024

rintaro commented Aug 5, 2024

rintaro commented Aug 5, 2024

stmontgomery left a comment

Choose a reason for hiding this comment

compnerd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rintaro Aug 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rintaro commented Aug 6, 2024

rintaro commented Aug 9, 2024

rintaro commented Aug 9, 2024

rintaro commented Aug 9, 2024

rintaro commented Aug 9, 2024

rintaro commented Aug 9, 2024

rintaro commented Aug 9, 2024

rintaro Aug 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

edymtt Aug 9, 2024 • edited Loading

Choose a reason for hiding this comment

rintaro commented Aug 9, 2024

rintaro commented Jul 26, 2024 •

edited

Loading

rintaro Aug 6, 2024 •

edited

Loading

rintaro Aug 9, 2024 •

edited

Loading

edymtt Aug 9, 2024 •

edited

Loading