Skip to content

Mark XCTestScaffold to-be-deprecated. #159

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

Merged
merged 1 commit into from
Dec 13, 2023
Merged

Mark XCTestScaffold to-be-deprecated. #159

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
17 changes: 8 additions & 9 deletions Sources/Testing/Running/XCTestScaffold.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,14 @@ extension XCTIssue {
/// A type providing temporary tools for integrating the testing library and
/// the XCTest framework.
///
/// - Warning: This type is provided temporarily to aid in integrating the
/// testing library with existing tools such as Swift Package Manager. It
/// will be removed in a future release.
///
/// ## See Also
///
/// - <doc:TemporaryGettingStarted>
#if SWIFT_PM_SUPPORTS_SWIFT_TESTING
@available(*, deprecated, message: "This version of Swift Package Manager supports running swift-testing tests directly. This type will be removed in a future release.")
#else
@available(swift, deprecated: 100000.0, message: "This type is provided temporarily to aid in integrating the testing library with existing tools such as Swift Package Manager. It will be removed in a future release.")
#endif
public enum XCTestScaffold: Sendable {
/// Run all tests found in the current process and write output to the
/// standard error stream.
Expand All @@ -105,10 +106,6 @@ public enum XCTestScaffold: Sendable {
/// The format of the output is not meant to be machine-readable and is
/// subject to change.
///
/// - Warning: This function is provided temporarily to aid in integrating the
/// testing library with existing tools such as Swift Package Manager. It
/// will be removed in a future release.
///
/// ### Filtering tests
///
/// This function does not support the `--filter` argument passed to
Expand Down Expand Up @@ -167,7 +164,9 @@ public enum XCTestScaffold: Sendable {
///
/// - <doc:TemporaryGettingStarted>
#if SWIFT_PM_SUPPORTS_SWIFT_TESTING
@available(*, deprecated, message: "This version of Swift Package Manager supports running swift-testing tests directly. This function has no effect.")
@available(*, deprecated, message: "This version of Swift Package Manager supports running swift-testing tests directly. This function has no effect and will be removed in a future release.")
#else
@available(swift, deprecated: 100000.0, message: "This function is provided temporarily to aid in integrating the testing library with existing tools such as Swift Package Manager. It will be removed in a future release.")
#endif
public static func runAllTests(hostedBy testCase: XCTestCase) async {
#if SWIFT_PM_SUPPORTS_SWIFT_TESTING
Expand Down