Move Runner and contained symbols to SPI group ForToolsIntegrationOnly. (#278)

grynspan · web-flow · commit 3a03d648ae22 · 2024-03-11T16:37:38.000-04:00
This PR moves `Runner` as well as contained symbols like `Runner.Plan` to the `ForToolsIntegrationOnly` SPI groups per the SPI policy outlined [here](https://github.com/apple/swift-testing/blob/main/Documentation/SPI.md). ### 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.
diff --git a/Sources/Testing/Events/Event.swift b/Sources/Testing/Events/Event.swift
@@ -16,7 +16,6 @@ public struct Event: Sendable {
     /// A test run started.
     ///
     /// This event is the first event posted after ``Runner/run()`` is called.
-    @_spi(ExperimentalTestRunning)
     case runStarted
 
     /// An iteration of the test run started.
@@ -30,7 +29,6 @@ public struct Event: Sendable {
     /// By default, a test plan runs for one iteration, but the
     /// ``Configuration/repetitionPolicy-swift.property`` property can be set to
     /// allow for more iterations.
-    @_spi(ExperimentalTestRunning)
     indirect case iterationStarted(_ index: Int)
 
     /// A step in the runner plan started.
@@ -42,7 +40,6 @@ public struct Event: Sendable {
     /// ``Runner/Plan/Step``. Processing this step may result in its associated
     /// ``Test`` being run, skipped, or another action, so this event will only
     /// be followed by a ``testStarted`` event if the step's test is run.
-    @_spi(ExperimentalTestRunning)
     indirect case planStepStarted(_ step: Runner.Plan.Step)
 
     /// A test started.
@@ -112,7 +109,6 @@ public struct Event: Sendable {
     ///
     /// This event is posted when a ``Runner`` finishes processing a
     /// ``Runner/Plan/Step``.
-    @_spi(ExperimentalTestRunning)
     indirect case planStepEnded(Runner.Plan.Step)
 
     /// An iteration of the test run ended.
@@ -126,13 +122,11 @@ public struct Event: Sendable {
     /// By default, a test plan runs for one iteration, but the
     /// ``Configuration/repetitionPolicy-swift.property`` property can be set to
     /// allow for more iterations.
-    @_spi(ExperimentalTestRunning)
     indirect case iterationEnded(_ index: Int)
 
     /// A test run ended.
     ///
     /// This event is the last event posted before ``Runner/run()`` returns.
-    @_spi(ExperimentalTestRunning)
     case runEnded
   }
 
@@ -323,7 +317,6 @@ extension Event.Kind {
     /// A test run started.
     ///
     /// This is the first event posted after ``Runner/run()`` is called.
-    @_spi(ExperimentalTestRunning)
     case runStarted
 
     /// An iteration of the test run started.
@@ -337,7 +330,6 @@ extension Event.Kind {
     /// By default, a test plan runs for one iteration, but the
     /// ``Configuration/repetitionPolicy-swift.property`` property can be set to
     /// allow for more iterations.
-    @_spi(ExperimentalTestRunning)
     indirect case iterationStarted(_ index: Int)
 
     /// A step in the runner plan started.
@@ -349,7 +341,6 @@ extension Event.Kind {
     /// ``Runner/Plan/Step``. Processing this step may result in its associated
     /// ``Test`` being run, skipped, or another action, so this event will only
     /// be followed by a ``testStarted`` event if the step's test is run.
-    @_spi(ExperimentalTestRunning)
     case planStepStarted
 
     /// A test started.
@@ -401,7 +392,6 @@ extension Event.Kind {
     ///
     /// This is posted when a ``Runner`` finishes processing a
     /// ``Runner/Plan/Step``.
-    @_spi(ExperimentalTestRunning)
     case planStepEnded
 
     /// An iteration of the test run ended.
@@ -415,13 +405,11 @@ extension Event.Kind {
     /// By default, a test plan runs for one iteration, but the
     /// ``Configuration/repetitionPolicy-swift.property`` property can be set to
     /// allow for more iterations.
-    @_spi(ExperimentalTestRunning)
     indirect case iterationEnded(_ index: Int)
 
     /// A test run ended.
     ///
     /// This is the last event posted before ``Runner/run()`` returns.
-    @_spi(ExperimentalTestRunning)
     case runEnded
 
     /// Snapshots an ``Event.Kind``.
diff --git a/Sources/Testing/Running/Runner.Plan+Dumping.swift b/Sources/Testing/Running/Runner.Plan+Dumping.swift
@@ -8,7 +8,6 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@_spi(ExperimentalTestRunning)
 extension Runner.Plan {
   /// Write a dump of the specified step graph to a stream.
   ///
@@ -105,7 +104,6 @@ extension Runner.Plan {
   ///
   /// - Note: The output of this function is not intended to be machine-readable
   ///   and its format may change over time.
-  @_spi(InternalDiagnostics)
   public func dump(to stream: inout some TextOutputStream, verbose: Bool = false, indent: Int = 2) {
     if verbose {
       Swift.dump(self, to: &stream, indent: indent)
diff --git a/Sources/Testing/Running/Runner.Plan.swift b/Sources/Testing/Running/Runner.Plan.swift
@@ -8,7 +8,6 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@_spi(ExperimentalTestRunning)
 extension Runner {
   /// A type describing a runner plan.
   public struct Plan: Sendable {
@@ -130,7 +129,6 @@ extension Runner {
 
 // MARK: - Constructing a new runner plan
 
-@_spi(ExperimentalTestRunning)
 extension Runner.Plan {
   /// Recursively apply eligible traits from a test suite to its children in a
   /// graph.
diff --git a/Sources/Testing/Running/Runner.swift b/Sources/Testing/Running/Runner.swift
@@ -9,7 +9,7 @@
 //
 
 /// A type that runs tests according to a given configuration.
-@_spi(ExperimentalTestRunning)
+@_spi(ForToolsIntegrationOnly)
 public struct Runner: Sendable {
   /// The plan to follow when running the associated tests.
   public var plan: Plan
@@ -55,7 +55,6 @@ public struct Runner: Sendable {
 
 // MARK: - Running tests
 
-@_spi(ExperimentalTestRunning)
 extension Runner {
   /// Catch errors thrown from a closure and process them as issues instead of
   /// allowing them to propagate to the caller.
diff --git a/Tests/TestingTests/BacktraceTests.swift b/Tests/TestingTests/BacktraceTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@testable @_spi(ForToolsIntegrationOnly) @_spi(ExperimentalTestRunning) import Testing
+@testable @_spi(ForToolsIntegrationOnly) import Testing
 #if canImport(Foundation)
 import Foundation
 #endif
diff --git a/Tests/TestingTests/ConfirmationTests.swift b/Tests/TestingTests/ConfirmationTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@testable @_spi(ForToolsIntegrationOnly) @_spi(ExperimentalTestRunning) import Testing
+@testable @_spi(ForToolsIntegrationOnly) import Testing
 
 @Suite("Confirmation Tests")
 struct ConfirmationTests {
diff --git a/Tests/TestingTests/DumpTests.swift b/Tests/TestingTests/DumpTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@testable @_spi(InternalDiagnostics) @_spi(ExperimentalTestRunning) import Testing
+@testable @_spi(ForToolsIntegrationOnly) import Testing
 private import TestingInternals
 
 // NOTE: The tests in this file are here to exercise Plan.dump(), but they are
diff --git a/Tests/TestingTests/EventRecorderTests.swift b/Tests/TestingTests/EventRecorderTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@testable @_spi(Experimental) @_spi(ForToolsIntegrationOnly) @_spi(ExperimentalTestRunning) import Testing
+@testable @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
 #if !os(Windows)
 import RegexBuilder
 #endif
diff --git a/Tests/TestingTests/IssueTests.swift b/Tests/TestingTests/IssueTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@testable @_spi(Experimental) @_spi(ForToolsIntegrationOnly) @_spi(ExperimentalTestRunning) import Testing
+@testable @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
 private import TestingInternals
 
 #if canImport(XCTest)
diff --git a/Tests/TestingTests/ObjCInteropTests.swift b/Tests/TestingTests/ObjCInteropTests.swift
@@ -9,7 +9,7 @@
  */
 
 import XCTest
-@testable @_spi(ExperimentalTestRunning) @_spi(ForToolsIntegrationOnly) import Testing
+@testable @_spi(ForToolsIntegrationOnly) import Testing
 
 final class NonXCTestCaseClassTests: NSObject {
   @Test("Methods on non-XCTestCase subclasses are supported")
diff --git a/Tests/TestingTests/PlanIterationTests.swift b/Tests/TestingTests/PlanIterationTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@testable @_spi(ExperimentalTestRunning) @_spi(ForToolsIntegrationOnly) import Testing
+@testable @_spi(ForToolsIntegrationOnly) import Testing
 
 @Suite("Configuration.RepetitionPolicy Tests")
 struct PlanIterationTests {
diff --git a/Tests/TestingTests/PlanTests.swift b/Tests/TestingTests/PlanTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
     
-@testable @_spi(ExperimentalTestRunning) @_spi(ForToolsIntegrationOnly) import Testing
+@testable @_spi(ForToolsIntegrationOnly) import Testing
 
 @Suite("Runner.Plan Tests")
 struct PlanTests {
diff --git a/Tests/TestingTests/Runner.Plan.SnapshotTests.swift b/Tests/TestingTests/Runner.Plan.SnapshotTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@testable @_spi(ExperimentalTestRunning) @_spi(ForToolsIntegrationOnly) import Testing
+@testable @_spi(ForToolsIntegrationOnly) import Testing
 
 #if canImport(Foundation)
 import Foundation
diff --git a/Tests/TestingTests/SwiftPMTests.swift b/Tests/TestingTests/SwiftPMTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@testable @_spi(ExperimentalTestRunning) @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
+@testable @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
 #if canImport(Foundation)
 import Foundation
 #endif
diff --git a/Tests/TestingTests/Test.Case.ArgumentTests.swift b/Tests/TestingTests/Test.Case.ArgumentTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@testable @_spi(ForToolsIntegrationOnly) @_spi(ExperimentalTestRunning) @_spi(Experimental) import Testing
+@testable @_spi(ForToolsIntegrationOnly) @_spi(Experimental) import Testing
 
 @Suite("Test.Case.Argument Tests")
 struct Test_Case_ArgumentTests {
diff --git a/Tests/TestingTests/Test.ID.SelectionTests.swift b/Tests/TestingTests/Test.ID.SelectionTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@testable @_spi(ExperimentalTestRunning) import Testing
+@testable import Testing
 
 @Suite("Test.ID.Selection Tests")
 struct Test_ID_SelectionTests {
diff --git a/Tests/TestingTests/TestCaseSelectionTests.swift b/Tests/TestingTests/TestCaseSelectionTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@testable @_spi(ExperimentalTestRunning) @_spi(ForToolsIntegrationOnly) @_spi(Experimental) import Testing
+@testable @_spi(ForToolsIntegrationOnly) @_spi(Experimental) import Testing
 
 @Suite("Test.Case Selection Tests")
 struct TestCaseSelectionTests {
diff --git a/Tests/TestingTests/Traits/CommentTests.swift b/Tests/TestingTests/Traits/CommentTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@testable @_spi(Experimental) @_spi(ExperimentalTestRunning) import Testing
+@testable @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
 
 @Suite("Comment Tests", .tags(.traitRelated))
 struct CommentTests {
diff --git a/Tests/TestingTests/Traits/SerialTraitTests.swift b/Tests/TestingTests/Traits/SerialTraitTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@testable @_spi(Experimental) @_spi(ExperimentalTestRunning) @_spi(ForToolsIntegrationOnly) import Testing
+@testable @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
 
 @Suite("Serial Trait Tests", .tags("trait"))
 struct SerialTraitTests {
diff --git a/Tests/TestingTests/Traits/TagListTests.swift b/Tests/TestingTests/Traits/TagListTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@testable @_spi(ExperimentalTestRunning) @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
+@testable @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
 
 #if canImport(Foundation)
 import Foundation
diff --git a/Tests/TestingTests/Traits/TimeLimitTraitTests.swift b/Tests/TestingTests/Traits/TimeLimitTraitTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@testable @_spi(ExperimentalTestRunning) @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
+@testable @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
 
 @Suite("TimeLimitTrait Tests", .tags(.traitRelated))
 struct TimeLimitTraitTests {
diff --git a/Tests/TestingTests/ZipTests.swift b/Tests/TestingTests/ZipTests.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-@testable @_spi(ExperimentalTestRunning) import Testing
+@testable import Testing
 
 @Suite("zip Tests")
 struct ZipTests {
