-
Notifications
You must be signed in to change notification settings - Fork 97
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation: Update CMake.md to use the ABI entry point #828
Open
ADKaster
wants to merge
4
commits into
swiftlang:main
Choose a base branch
from
ADKaster:cmake-entry-point
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+20
−7
Open
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
5cd77e7
Documentation: Update CMake.md to use the ABI entry point
ADKaster c45c801
Documentation: Update custom entry point to not use SPI symbols
ADKaster c6af86b
Don't forget to import Foundation for exit()
ADKaster 5dfdad4
Revert "Don't forget to import Foundation for exit()"
ADKaster File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -59,21 +59,28 @@ endif() | |||||
## Add an entry point | ||||||
|
||||||
You must include a source file in your test executable target with a | ||||||
`@main` entry point. The following example uses the SwiftPM entry point: | ||||||
`@main` entry point. | ||||||
|
||||||
```swift | ||||||
import Testing | ||||||
import Foundation | ||||||
@_spi(ForToolsIntegrationOnly) import Testing | ||||||
ADKaster marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
@main struct Runner { | ||||||
static func main() async { | ||||||
await Testing.__swiftPMEntryPoint() as Never | ||||||
static func main() async throws { | ||||||
let configurationJSON: UnsafeRawBufferPointer? = nil | ||||||
stmontgomery marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
let recordHandler: @Sendable (UnsafeRawBufferPointer) -> Void = { _ in } | ||||||
|
||||||
if try await ABIv0.entryPoint(configurationJSON, recordHandler) { | ||||||
exit(EXIT_SUCCESS) | ||||||
} else { | ||||||
exit(EXIT_FAILURE) | ||||||
} | ||||||
} | ||||||
} | ||||||
``` | ||||||
|
||||||
> [!WARNING] | ||||||
> The entry point is expected to change to an entry point designed for other | ||||||
> build systems prior to the initial stable release of Swift Testing. | ||||||
For more information on the input configuration and output records of the ABI entry | ||||||
point, refer to the [ABI documentation](ABI/JSON.md) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit
Suggested change
|
||||||
|
||||||
## Integrate with CTest | ||||||
|
||||||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't need this import for the barebones implementation below. Only needed if you want to use
JSONEncoder
/JSONDecoder
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it not needed for
exit(EXIT_SUCCESS)
? Or is there a non-foundation way to do the standard Unix process exit dance.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
exit()
andEXIT_SUCCESS
are defined in the system's C module, which may beDarwin
,Glibc
,ucrt
… uh…Musl
?Foundation reexports the C module for the current system. It seems wrong to me (but I can be convinced otherwise) to tell developers to include a full Foundation dependency just for
exit()
.Depending on the dev's specific requirements, they really just need the process to terminate with zero (the default!) or non-zero. If they're using Swift Argument Parser, it has built-in functionality for this. If they're using just the Swift stdlib and nothing else, they could call
fatalError()
on failure. I don't know what's the best choice for this example code.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Eh.. I'm not sure that I know what the best choice is either. When a test binary is executed by ctest, as in my use case, returning 0 or 1 from main() is important for the test harness to understand whether the test passed or failed. Anything more than that on the ctest side is up to whatever @etcwilde comes up with for https://gitlab.kitware.com/cmake/cmake/-/issues/26452
I feel like adding a
chain to the top of the example would get in the way of what it's actually trying to show that you need 🤷
I'll change it to whatever anyone feels strongly about though, as in theory more comprehensive support for the CMake use case could come soon ™️ to make this example obsolete-ish.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It may be sufficient to just show
exit(EXIT_SUCCESS)
without importing anything. Developers who are going down this path are presumably skilled enough to figure out how to make it compile…? 😇There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure... "compilable example code left as an exercise for the reader" is definitely one approach. Not my first choice, but it's not my library :). I've pushed up that change then.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Again, anybody who's digging down into the CMake scripts is on their own and I have to assume has some esoteric environment—we can't even guarantee Foundation is present! (We can guarantee libc is present because we won't build without it, at least.)