Skip to content

Commit a12f93e

Browse files
jeffdavjeffdav
authored
[cmake] Build swift-testing with CMake. (swiftlang#387)
1 parent d109ed0 commit a12f93e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+557
-1
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
.DS_Store
22
/.build
3+
/build
34
/Packages
45
/*.xcodeproj
56
xcuserdata/

‎CMakeLists.txt

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# This source file is part of the Swift.org open source project
2+
#
3+
# Copyright (c) 2024 Apple Inc. and the Swift project authors
4+
# Licensed under Apache License v2.0 with Runtime Library Exception
5+
#
6+
# See http://swift.org/LICENSE.txt for license information
7+
# See http://swift.org/CONTRIBUTORS.txt for Swift project authors
8+
9+
cmake_minimum_required(VERSION 3.19.6...3.29)
10+
11+
if(POLICY CMP0157)
12+
cmake_policy(SET CMP0157 NEW)
13+
endif()
14+
15+
project(SwiftTesting
16+
LANGUAGES CXX Swift)
17+
18+
list(APPEND CMAKE_MODULE_PATH
19+
${PROJECT_SOURCE_DIR}/cmake/modules
20+
${PROJECT_SOURCE_DIR}/cmake/modules/shared)
21+
22+
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
23+
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
24+
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
25+
26+
set(CMAKE_MSVC_RUNTIME_LIBRARY MultiThreadedDLL)
27+
set(CMAKE_CXX_STANDARD 20)
28+
set(CMAKE_Swift_MODULE_DIRECTORY ${CMAKE_BINARY_DIR}/swift)
29+
30+
add_subdirectory(Sources)

‎Documentation/CMake.md

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Building with CMake
2+
3+
## Add `swift-testing` to Your Project
4+
5+
Add `swift-testing` with to your project using the standard `FetchContent` or `find_package` mechanism, as appropriate for your project. For example:
6+
7+
```cmake
8+
include(FetchContent)
9+
FetchContent_Declare(SwiftTesting
10+
GIT_REPOSITORY https://github.com/apple/swift-testing.git
11+
GIT_TAG main)
12+
FetchContent_MakeAvailable(SwiftTesting)
13+
```
14+
15+
## Define Your Test Executable
16+
17+
To build a test executable using `swift-testing`, define an executable target
18+
of the form `[YOURPROJECT]PackageTests`, set the executable suffix to be
19+
`.swift-testing`, and link to your project targets with `Testing`.
20+
21+
The following
22+
example shows what this might look like for a hypothetical project called
23+
`Example`:
24+
25+
```cmake
26+
add_executable(ExamplePackageTests
27+
ExampleTests.swift
28+
...)
29+
set_target_properties(ExamplePackageTests PROPERTIES
30+
SUFFIX .swift-testing)
31+
target_link_libraries(ExamplePackageTests PRIVATE
32+
Example
33+
Testing
34+
...)
35+
```
36+
37+
When building the test executable, the code you're testing will need to be built
38+
with `-enable-testing`. This should only be enabled for testing, for example:
39+
40+
```cmake
41+
include(CTest)
42+
if(BUILD_TESTING)
43+
add_compile_options($<$<COMPILE_LANGUAGE:Swift>:-enable-testing>)
44+
endif()
45+
```
46+
47+
## Add an Entry Point
48+
49+
You must define a custom source file with a `@main` entry point. This should be
50+
a separate source file that is included in your test executable's `SOURCES`
51+
list.
52+
53+
The following example uses the SwiftPM entry point:
54+
55+
```swift
56+
import Testing
57+
58+
@main struct Runner {
59+
static func main() async {
60+
await Testing.__swiftPMEntryPoint() as Never
61+
}
62+
}
63+
```
64+
> [!WARNING]
65+
> The entry point is expected to change to an entry point designed for other
66+
> build systems prior to `swift-testing` v1.
67+
68+
69+
## Integrate with CTest
70+
71+
To run your test using CTest, add the test using the appropriate command line.
72+
73+
```cmake
74+
include(CTest)
75+
add_test(NAME ExamplePackageTests
76+
COMMAND ExamplePackageTests)
77+
```

‎Sources/CMakeLists.txt

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# This source file is part of the Swift.org open source project
2+
#
3+
# Copyright (c) 2024 Apple Inc. and the Swift project authors
4+
# Licensed under Apache License v2.0 with Runtime Library Exception
5+
#
6+
# See http://swift.org/LICENSE.txt for license information
7+
# See http://swift.org/CONTRIBUTORS.txt for Swift project authors
8+
9+
# Macros must be built for the build machine, not the host.
10+
include(ExternalProject)
11+
ExternalProject_Add(TestingMacros
12+
PREFIX "tm"
13+
SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/TestingMacros"
14+
INSTALL_COMMAND "")
15+
ExternalProject_Get_Property(TestingMacros BINARY_DIR)
16+
if(CMAKE_HOST_WIN32)
17+
set(TestingMacrosPath "${BINARY_DIR}/TestingMacros.exe#TestingMacros")
18+
else()
19+
set(TestingMacrosPath "${BINARY_DIR}/TestingMacros#TestingMacros")
20+
endif()
21+
22+
include(AvailabilityDefinitions)
23+
include(CompilerSettings)
24+
add_subdirectory(_TestingInternals)
25+
add_subdirectory(Testing)

‎Sources/Testing/CMakeLists.txt

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# This source file is part of the Swift.org open source project
2+
#
3+
# Copyright (c) 2024 Apple Inc. and the Swift project authors
4+
# Licensed under Apache License v2.0 with Runtime Library Exception
5+
#
6+
# See http://swift.org/LICENSE.txt for license information
7+
# See http://swift.org/CONTRIBUTORS.txt for Swift project authors
8+
9+
add_library(Testing
10+
EntryPoints/ABIEntryPoint.swift
11+
EntryPoints/ABIv0/ABIv0.Record.swift
12+
EntryPoints/ABIv0/ABIv0.Record+Streaming.swift
13+
EntryPoints/ABIv0/ABIv0.swift
14+
EntryPoints/ABIv0/Encoded/ABIv0.EncodedEvent.swift
15+
EntryPoints/ABIv0/Encoded/ABIv0.EncodedInstant.swift
16+
EntryPoints/ABIv0/Encoded/ABIv0.EncodedIssue.swift
17+
EntryPoints/ABIv0/Encoded/ABIv0.EncodedMessage.swift
18+
EntryPoints/ABIv0/Encoded/ABIv0.EncodedTest.swift
19+
EntryPoints/EntryPoint.swift
20+
EntryPoints/SwiftPMEntryPoint.swift
21+
EntryPoints/XCTestScaffold.swift
22+
Events/Clock.swift
23+
Events/Event.swift
24+
Events/Recorder/Event.ConsoleOutputRecorder.swift
25+
Events/Recorder/Event.HumanReadableOutputRecorder.swift
26+
Events/Recorder/Event.JUnitXMLRecorder.swift
27+
Events/Recorder/Event.Symbol.swift
28+
Events/TimeValue.swift
29+
ExitTests/ExitCondition.swift
30+
ExitTests/ExitTest.swift
31+
ExitTests/WaitFor.swift
32+
Expectations/Expectation.swift
33+
Expectations/Expectation+Macro.swift
34+
Expectations/ExpectationChecking+Macro.swift
35+
Issues/Confirmation.swift
36+
Issues/ErrorSnapshot.swift
37+
Issues/Issue.swift
38+
Issues/Issue+Recording.swift
39+
Issues/KnownIssue.swift
40+
Parameterization/CustomTestArgumentEncodable.swift
41+
Parameterization/Test.Case.Generator.swift
42+
Parameterization/Test.Case.ID.swift
43+
Parameterization/Test.Case.swift
44+
Parameterization/TypeInfo.swift
45+
Running/Configuration.swift
46+
Running/Configuration.TestFilter.swift
47+
Running/Configuration+EventHandling.swift
48+
Running/Runner.Plan.swift
49+
Running/Runner.Plan+Dumping.swift
50+
Running/Runner.RuntimeState.swift
51+
Running/Runner.swift
52+
Running/SkipInfo.swift
53+
SourceAttribution/Backtrace.swift
54+
SourceAttribution/CustomTestStringConvertible.swift
55+
SourceAttribution/Expression.swift
56+
SourceAttribution/Expression+Macro.swift
57+
SourceAttribution/SourceContext.swift
58+
SourceAttribution/SourceLocation.swift
59+
Support/Additions/ArrayAdditions.swift
60+
Support/Additions/CollectionDifferenceAdditions.swift
61+
Support/Additions/CommandLineAdditions.swift
62+
Support/Additions/NumericAdditions.swift
63+
Support/Additions/ResultAdditions.swift
64+
Support/Additions/StringAdditions.swift
65+
Support/CartesianProduct.swift
66+
Support/CError.swift
67+
Support/Environment.swift
68+
Support/FileHandle.swift
69+
Support/Graph.swift
70+
Support/JSON.swift
71+
Support/Locked.swift
72+
Support/SystemError.swift
73+
Support/UncheckedSendable.swift
74+
Support/Versions.swift
75+
Test.ID.Selection.swift
76+
Test.ID.swift
77+
Test.swift
78+
Test+Discovery.swift
79+
Test+Macro.swift
80+
Traits/Bug.swift
81+
Traits/Comment.swift
82+
Traits/Comment+Macro.swift
83+
Traits/ConditionTrait.swift
84+
Traits/ConditionTrait+Macro.swift
85+
Traits/HiddenTrait.swift
86+
Traits/ParallelizationTrait.swift
87+
Traits/SPIAwareTrait.swift
88+
Traits/Tags/Tag.Color.swift
89+
Traits/Tags/Tag.Color+Loading.swift
90+
Traits/Tags/Tag.List.swift
91+
Traits/Tags/Tag.swift
92+
Traits/Tags/Tag+Macro.swift
93+
Traits/Tags/Tag+Predefined.swift
94+
Traits/TimeLimitTrait.swift
95+
Traits/Trait.swift)
96+
target_link_libraries(Testing PRIVATE
97+
_TestingInternals)
98+
add_dependencies(Testing
99+
TestingMacros)
100+
target_compile_definitions(Testing PRIVATE
101+
SWT_BUILDING_WITH_CMAKE)
102+
target_compile_options(Testing PUBLIC
103+
-load-plugin-executable "${TestingMacrosPath}")
104+
target_compile_options(Testing PRIVATE
105+
-enable-library-evolution)

‎Sources/Testing/EntryPoints/EntryPoint.swift

+4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
99
//
1010

11+
#if SWT_BUILDING_WITH_CMAKE
12+
@_implementationOnly import _TestingInternals
13+
#else
1114
private import _TestingInternals
15+
#endif
1216

1317
/// The common implementation of the entry point functions in this file.
1418
///

‎Sources/Testing/EntryPoints/SwiftPMEntryPoint.swift

+4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
99
//
1010

11+
#if SWT_BUILDING_WITH_CMAKE
12+
@_implementationOnly import _TestingInternals
13+
#else
1114
private import _TestingInternals
15+
#endif
1216

1317
/// The entry point to the testing library used by Swift Package Manager.
1418
///

‎Sources/Testing/EntryPoints/XCTestScaffold.swift

+6
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,13 @@
99
//
1010

1111
#if !SWT_NO_XCTEST_SCAFFOLDING && canImport(XCTest)
12+
13+
#if SWT_BUILDING_WITH_CMAKE
14+
@_implementationOnly import _TestingInternals
15+
#else
1216
private import _TestingInternals
17+
#endif
18+
1319
public import XCTest
1420

1521
#if SWT_TARGET_OS_APPLE

‎Sources/Testing/Events/Clock.swift

+4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
99
//
1010

11+
#if SWT_BUILDING_WITH_CMAKE
12+
@_implementationOnly import _TestingInternals
13+
#else
1114
private import _TestingInternals
15+
#endif
1216

1317
@_spi(Experimental) @_spi(ForToolsIntegrationOnly)
1418
extension Test {

‎Sources/Testing/Events/TimeValue.swift

+4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@
1010

1111
// `internal` because `TimeValue.init(_ timespec:)` below is internal and
1212
// references a type (`timespec`) which comes from this import.
13+
#if SWT_BUILDING_WITH_CMAKE
14+
@_implementationOnly import _TestingInternals
15+
#else
1316
internal import _TestingInternals
17+
#endif
1418

1519
/// A container type representing a time value that is suitable for storage,
1620
/// conversion, encoding, and decoding.

‎Sources/Testing/ExitTests/ExitCondition.swift

+4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
99
//
1010

11+
#if SWT_BUILDING_WITH_CMAKE
12+
@_implementationOnly import _TestingInternals
13+
#else
1114
private import _TestingInternals
15+
#endif
1216

1317
/// An enumeration describing possible conditions under which an exit test will
1418
/// succeed or fail.

‎Sources/Testing/ExitTests/ExitTest.swift

+4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
99
//
1010

11+
#if SWT_BUILDING_WITH_CMAKE
12+
@_implementationOnly import _TestingInternals
13+
#else
1114
private import _TestingInternals
15+
#endif
1216

1317
#if !SWT_NO_EXIT_TESTS
1418
/// A type describing an exit test.

‎Sources/Testing/ExitTests/WaitFor.swift

+5
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@
99
//
1010

1111
#if !SWT_NO_EXIT_TESTS
12+
13+
#if SWT_BUILDING_WITH_CMAKE
14+
@_implementationOnly import _TestingInternals
15+
#else
1216
internal import _TestingInternals
17+
#endif
1318

1419
#if SWT_TARGET_OS_APPLE || os(Linux)
1520
/// Block the calling thread, wait for the target process to exit, and return

‎Sources/Testing/SourceAttribution/Backtrace.swift

+4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
99
//
1010

11+
#if SWT_BUILDING_WITH_CMAKE
12+
@_implementationOnly import _TestingInternals
13+
#else
1114
private import _TestingInternals
15+
#endif
1216

1317
/// A type representing a backtrace or stack trace.
1418
public struct Backtrace: Sendable {

‎Sources/Testing/Support/Additions/CommandLineAdditions.swift

+4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
99
//
1010

11+
#if SWT_BUILDING_WITH_CMAKE
12+
@_implementationOnly import _TestingInternals
13+
#else
1114
private import _TestingInternals
15+
#endif
1216

1317
extension CommandLine {
1418
/// Get the command-line arguments passed to this process.

‎Sources/Testing/Support/Additions/StringAdditions.swift

+4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
99
//
1010

11+
#if SWT_BUILDING_WITH_CMAKE
12+
@_implementationOnly import _TestingInternals
13+
#else
1114
private import _TestingInternals
15+
#endif
1216

1317
extension String {
1418
init?(validatingUTF8CString cString: UnsafePointer<CChar>) {

‎Sources/Testing/Support/CError.swift

+4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
99
//
1010

11+
#if SWT_BUILDING_WITH_CMAKE
12+
@_implementationOnly import _TestingInternals
13+
#else
1114
internal import _TestingInternals
15+
#endif
1216

1317
/// A type representing an error from a C function such as `fopen()`.
1418
///

0 commit comments

Comments
 (0)