Skip to content

Highlight parallel-by-default test run in case of XCTest migration #1176

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Highlight parallel-by-default test run in case of XCTest migration #1176

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Sources/Testing/Testing.docc/MigratingFromXCTest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ concurrency safety:
For more information about suites and how to declare and customize them, see
<doc:OrganizingTests>.

> Important: While XCTest test cases running sequentially by default, the test execution happens in parallel by default in Swift Testing. See the [Run tests sequentially](#Run-tests-sequentially) section in this document for further information.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence doesn't say anything that isn't already covered in "Run tests sequentially," below. Additionally, the aside's content isn't really relevant to the topic of this section, which is about creating test suites. I'd recommend thinking about the structure of this content differently.

Is there something that "Run tests sequentially" ought to tell developers, but doesn't? If so, add information there.

Is there something that "Convert test classes" ought to tell developers about concurrency, so they know to read "Run tests sequentially"? If so, work that into the prose in this section.

If your goal is to ensure that developers remember to think about concurrency, they should probably also remember to think about some of the other points in this doc. Perhaps you need to expand the Overview, to give developers a list of important points to consider when they migrate tests.


### Convert setup and teardown functions

In XCTest, code can be scheduled to run before and after a test using the
Expand Down