Add support for correctly discovering async test methods on non-Apple platforms #3844
Conversation
briancroom
requested review from
abertelrud,
friedbunny,
neonichu and
tomerd
as code owners
|
swiftlang/swift-tools-support-core#258 |
|
Note that I haven't seen the new test pass on Linux yet. I tried using one of the "nightly" Docker images, but they're about a week out of date right now and don't have the swift-corelibs-xctest change in place yet. We'll see how CI goes. |
| class AsyncTests: XCTestCase { | ||
|
|
||
| func testAsync() async { | ||
| XCTAssertFalse(Thread.isMainThread) |
There was a problem hiding this comment.
Are we confident that an async, non-@MainActor func is guaranteed to never run on the main thread, even by coincidence? I bet that is true currently and perhaps always will be, although I feel like semantically there is no particular guarantee there
There was a problem hiding this comment.
Yeah, that's fair. The assertion isn't really providing significant value anyway, so I'll just remove it.
|
swiftlang/swift-tools-support-core#258 |
|
swiftlang/swift-tools-support-core#258 |
|
@swift-ci please smoke test |
|
It looks like the “Linux (self hosted)” CI job uses the latest pre-built trunk development toolchain, which unfortunately is a week out of date right now, and is missing the swift-corelibs-xctest changes needed for the integration test to succeed, so we’re effectively blocked on landing this until a newer nightly toolchain can get posted (cc @shahmishal, who I spoke to about this earlier.) |
|
The self-hosted jobs do not gate merging. |
Ah ok, good to know. So you wouldn’t be concerned if this goes in before the toolchain updates to allow that to pass? (Assuming the other, required, Linux job does indeed pass now?) |
Nope, the main reason for the self hosted jobs is to have quicker iteration time than the smoke tests which take hours, they're not really testing anything in addition to the smoke tests. So I think this is good to merge. |
|
Excellent! The primary Linux job passed, and I confirmed in the logs that it indeed ran the new test. That gives me enough confidence to proceed with landing this. Thanks everybody! 🎉 |
|
thanks @briancroom |
This adopts a recent enhancement to swift-corelibs-xctest for supporting
asynctest methods by ensuring the automatic test discovery machinery used on non-Apple platforms generates the correct test manifest code for the harness to run async tests.Modifications:
I have adjusted the code-gen logic used during test discovery to notice async test methods, using the richer IndexStore data provided by swiftlang/swift-tools-support-core#258, and wrap such methods in the
asyncTesthelper from swift-corelibs-xctest so that they can execute correctly.Result:
With this change, it is now possible to transparently run async XCTests on Linux via
swift test.