[6.1] Add an overview of test serialization to the XCTest migration guide #965
Conversation
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
…960) Describe test serialization in the article about migrating tests from XCTest. ### Motivation: Because XCTest runs tests in a suite serially by default, tests that people migrate from XCTest may encounter issues if they run in parallel. ### Modifications: Add an example of serializing a test suite to the migration guide, along with links to the docs about test parallelization. ### Result: The documentation on migrating tests from XCTest includes guidance on serializing tests within a suite. ### Checklist: - [X] Code and documentation should follow the style of the [Style Guide](https://github.com/apple/swift-testing/blob/main/Documentation/StyleGuide.md). - [X] If public symbols are renamed or modified, DocC references should be updated.
Fixes a typo in the "before" example of adopting test serialization. ### Motivation: The example of XCTest tests that need to run in series doesn't compile. ### Modifications: Correct the code in the example. ### Result: A documentation change that means the code snippet in the example is correct. ### Checklist: - [X] Code and documentation should follow the style of the [Style Guide](https://github.com/apple/swift-testing/blob/main/Documentation/StyleGuide.md). - [X] If public symbols are renamed or modified, DocC references should be updated.
iamleeg
requested review from
stmontgomery,
grynspan,
dennisweissmann,
briancroom,
SeanROlszewski and
suzannaratcliff
as code owners
briancroom
approved these changes
Feb 19, 2025
grynspan
added
documentation
grynspan
changed the title
iamleeg
deleted the
iamleeg/122918733-cherry-pick-updates-to-test-migration-docs
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updates the article on migrating tests from XCTest to tell developers about test serialization.
Documentation updates.
"Migrating a test from XCTest" does not mention parallel-by-default #863
Add an overview of test serialization to the XCTest migration guide #960 Corrects use of XCTAssertEqual macro in parallelization examples. #963
Purely documentation updates, no risk to the release.
Build documentation and read Migrating a test from XCTest.
@grynspan @stmontgomery