Rename TestingInternals to _TestingInternals. (#404)

grynspan · web-flow · commit 775da90db70c · 2024-05-07T11:49:39.000-04:00
This module is not meant to be accessible outside of swift-testing, however it may be reachable by clients inadvertently. To minimize the likelihood of that, rename the module so it doesn't show up in documentation or Xcode autocomplete contexts. ### 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/Package.swift b/Package.swift
@@ -40,7 +40,7 @@ let package = Package(
     .target(
       name: "Testing",
       dependencies: [
-        "TestingInternals",
+        "_TestingInternals",
         "TestingMacros",
       ],
       cxxSettings: .packageSettings,
@@ -79,7 +79,7 @@ let package = Package(
     // "Support" targets: These contain C family code and are used exclusively
     // by other targets above, not directly included in product libraries.
     .target(
-      name: "TestingInternals",
+      name: "_TestingInternals",
       cxxSettings: .packageSettings
     ),
 
diff --git a/Package@swift-6.0.swift b/Package@swift-6.0.swift
@@ -40,7 +40,7 @@ let package = Package(
     .target(
       name: "Testing",
       dependencies: [
-        "TestingInternals",
+        "_TestingInternals",
         "TestingMacros",
       ],
       cxxSettings: .packageSettings,
@@ -79,7 +79,7 @@ let package = Package(
     // "Support" targets: These contain C family code and are used exclusively
     // by other targets above, not directly included in product libraries.
     .target(
-      name: "TestingInternals",
+      name: "_TestingInternals",
       cxxSettings: .packageSettings
     ),
 
diff --git a/Sources/Testing/EntryPoints/EntryPoint.swift b/Sources/Testing/EntryPoints/EntryPoint.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-private import TestingInternals
+private import _TestingInternals
 
 /// The common implementation of the entry point functions in this file.
 ///
diff --git a/Sources/Testing/EntryPoints/SwiftPMEntryPoint.swift b/Sources/Testing/EntryPoints/SwiftPMEntryPoint.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-private import TestingInternals
+private import _TestingInternals
 
 /// The entry point to the testing library used by Swift Package Manager.
 ///
diff --git a/Sources/Testing/EntryPoints/XCTestScaffold.swift b/Sources/Testing/EntryPoints/XCTestScaffold.swift
@@ -9,7 +9,7 @@
 //
 
 #if !SWT_NO_XCTEST_SCAFFOLDING && canImport(XCTest)
-private import TestingInternals
+private import _TestingInternals
 public import XCTest
 
 #if SWT_TARGET_OS_APPLE
diff --git a/Sources/Testing/Events/Clock.swift b/Sources/Testing/Events/Clock.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-private import TestingInternals
+private import _TestingInternals
 
 @_spi(Experimental) @_spi(ForToolsIntegrationOnly)
 extension Test {
diff --git a/Sources/Testing/Events/TimeValue.swift b/Sources/Testing/Events/TimeValue.swift
@@ -10,7 +10,7 @@
 
 // `internal` because `TimeValue.init(_ timespec:)` below is internal and
 // references a type (`timespec`) which comes from this import.
-internal import TestingInternals
+internal import _TestingInternals
 
 /// A container type representing a time value that is suitable for storage,
 /// conversion, encoding, and decoding.
diff --git a/Sources/Testing/ExitTests/ExitCondition.swift b/Sources/Testing/ExitTests/ExitCondition.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-private import TestingInternals
+private import _TestingInternals
 
 /// An enumeration describing possible conditions under which an exit test will
 /// succeed or fail.
diff --git a/Sources/Testing/ExitTests/ExitTest.swift b/Sources/Testing/ExitTests/ExitTest.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-private import TestingInternals
+private import _TestingInternals
 
 #if !SWT_NO_EXIT_TESTS
 /// A type describing an exit test.
diff --git a/Sources/Testing/ExitTests/WaitFor.swift b/Sources/Testing/ExitTests/WaitFor.swift
@@ -9,7 +9,7 @@
 //
 
 #if !SWT_NO_EXIT_TESTS
-internal import TestingInternals
+internal import _TestingInternals
 
 #if SWT_TARGET_OS_APPLE || os(Linux)
 /// Block the calling thread, wait for the target process to exit, and return
diff --git a/Sources/Testing/SourceAttribution/Backtrace.swift b/Sources/Testing/SourceAttribution/Backtrace.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-private import TestingInternals
+private import _TestingInternals
 
 /// A type representing a backtrace or stack trace.
 public struct Backtrace: Sendable {
diff --git a/Sources/Testing/Support/Additions/CommandLineAdditions.swift b/Sources/Testing/Support/Additions/CommandLineAdditions.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-private import TestingInternals
+private import _TestingInternals
 
 extension CommandLine {
   /// Get the command-line arguments passed to this process.
diff --git a/Sources/Testing/Support/CError.swift b/Sources/Testing/Support/CError.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-internal import TestingInternals
+internal import _TestingInternals
 
 /// A type representing an error from a C function such as `fopen()`.
 ///
@@ -48,7 +48,7 @@ func strerror(_ errorCode: CInt) -> String {
     return strnlen(buffer.baseAddress!, buffer.count)
   }
 #else
-  String(cString: TestingInternals.strerror(errorCode))
+  String(cString: _TestingInternals.strerror(errorCode))
 #endif
 }
 
diff --git a/Sources/Testing/Support/Environment.swift b/Sources/Testing/Support/Environment.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-private import TestingInternals
+private import _TestingInternals
 
 /// A type describing the environment of the current process.
 ///
diff --git a/Sources/Testing/Support/FileHandle.swift b/Sources/Testing/Support/FileHandle.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-internal import TestingInternals
+internal import _TestingInternals
 
 #if !SWT_NO_FILE_IO
 /// A type representing a file handle.
diff --git a/Sources/Testing/Support/Locked.swift b/Sources/Testing/Support/Locked.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-internal import TestingInternals
+internal import _TestingInternals
 
 /// A type that wraps a value requiring access from a synchronous caller during
 /// concurrent execution.
diff --git a/Sources/Testing/Support/Versions.swift b/Sources/Testing/Support/Versions.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-private import TestingInternals
+private import _TestingInternals
 
 /// A human-readable string describing the current operating system's version.
 ///
diff --git a/Sources/Testing/Test+Discovery.swift b/Sources/Testing/Test+Discovery.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-private import TestingInternals
+private import _TestingInternals
 
 /// A protocol describing a type that contains tests.
 ///
diff --git a/Sources/Testing/Traits/Tags/Tag.Color+Loading.swift b/Sources/Testing/Traits/Tags/Tag.Color+Loading.swift
@@ -8,7 +8,7 @@
 // See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 //
 
-private import TestingInternals
+private import _TestingInternals
 
 #if !SWT_NO_FILE_IO
 #if os(macOS) || (os(iOS) && targetEnvironment(macCatalyst)) || os(Linux)
diff --git a/Sources/_TestingInternals/Discovery.cpp b/Sources/_TestingInternals/Discovery.cpp
diff --git a/Sources/_TestingInternals/GetSymbol.cpp b/Sources/_TestingInternals/GetSymbol.cpp
diff --git a/Sources/_TestingInternals/WillThrow.cpp b/Sources/_TestingInternals/WillThrow.cpp
diff --git a/Sources/_TestingInternals/include/Defines.h b/Sources/_TestingInternals/include/Defines.h
diff --git a/Sources/_TestingInternals/include/Discovery.h b/Sources/_TestingInternals/include/Discovery.h
diff --git a/Sources/_TestingInternals/include/GetSymbol.h b/Sources/_TestingInternals/include/GetSymbol.h
diff --git a/Sources/_TestingInternals/include/Includes.h b/Sources/_TestingInternals/include/Includes.h
@@ -19,7 +19,7 @@
 /// into Swift without introducing a module dependency (and because the name of
 /// that module varies on a platform-by-platform basis), we instead include C
 /// standard library headers _à la carte_. Symbols from these headers are then
-/// imported into Swift when a Swift file imports the `TestingInternals` module.
+/// imported into Swift when a Swift file imports the `_TestingInternals` module.
 ///
 /// Also include any platform-specific headers here that are needed by the
 /// testing library.
diff --git a/Sources/_TestingInternals/include/Stubs.h b/Sources/_TestingInternals/include/Stubs.h
diff --git a/Sources/_TestingInternals/include/TestSupport.h b/Sources/_TestingInternals/include/TestSupport.h
diff --git a/Sources/_TestingInternals/include/WillThrow.h b/Sources/_TestingInternals/include/WillThrow.h
diff --git a/Tests/TestingTests/ABIEntryPointTests.swift b/Tests/TestingTests/ABIEntryPointTests.swift
@@ -10,7 +10,7 @@
 
 #if canImport(Foundation) && !SWT_NO_ABI_ENTRY_POINT
 @testable @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
-private import TestingInternals
+private import _TestingInternals
 
 @Suite("ABI entry point tests")
 struct ABIEntryPointTests {
diff --git a/Tests/TestingTests/ClockTests.swift b/Tests/TestingTests/ClockTests.swift
@@ -9,7 +9,7 @@
 //
 
 @testable @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
-private import TestingInternals
+private import _TestingInternals
 
 @Suite("Clock API Tests")
 struct ClockTests {
diff --git a/Tests/TestingTests/DumpTests.swift b/Tests/TestingTests/DumpTests.swift
@@ -9,7 +9,7 @@
 //
 
 @testable @_spi(ForToolsIntegrationOnly) import Testing
-private import TestingInternals
+private import _TestingInternals
 
 // NOTE: The tests in this file are here to exercise Plan.dump(), but they are
 // not intended to actually test that the output is in a particular format since
diff --git a/Tests/TestingTests/EventTests.swift b/Tests/TestingTests/EventTests.swift
@@ -9,7 +9,7 @@
 //
 
 @testable @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
-private import TestingInternals
+private import _TestingInternals
 
 @Suite("Event Tests")
 struct EventTests {
diff --git a/Tests/TestingTests/ExitTestTests.swift b/Tests/TestingTests/ExitTestTests.swift
@@ -9,7 +9,7 @@
 //
 
 @testable @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
-private import TestingInternals
+private import _TestingInternals
 
 #if !SWT_NO_EXIT_TESTS
 @Suite("Exit test tests") struct ExitTestTests {
diff --git a/Tests/TestingTests/IssueTests.swift b/Tests/TestingTests/IssueTests.swift
@@ -9,7 +9,7 @@
 //
 
 @testable @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
-private import TestingInternals
+private import _TestingInternals
 
 #if canImport(XCTest)
 import XCTest
diff --git a/Tests/TestingTests/Support/CErrorTests.swift b/Tests/TestingTests/Support/CErrorTests.swift
@@ -9,7 +9,7 @@
 //
 
 @testable import Testing
-private import TestingInternals
+private import _TestingInternals
 
 @Suite("CError Tests")
 struct CErrorTests {
@@ -38,4 +38,4 @@ struct Win32ErrorTests {
     #expect(expectedMessage == description)
   }
 }
-#endif
+#endif
diff --git a/Tests/TestingTests/Support/EnvironmentTests.swift b/Tests/TestingTests/Support/EnvironmentTests.swift
@@ -9,7 +9,7 @@
 //
 
 @testable @_spi(Experimental) import Testing
-private import TestingInternals
+private import _TestingInternals
 
 @Suite("Environment Tests", .serialized)
 struct EnvironmentTests {
diff --git a/Tests/TestingTests/Support/FileHandleTests.swift b/Tests/TestingTests/Support/FileHandleTests.swift
@@ -9,7 +9,7 @@
 //
 
 @testable import Testing
-private import TestingInternals
+private import _TestingInternals
 
 #if !SWT_NO_FILE_IO
 // NOTE: we don't run these tests on iOS (etc.) because processes on those
diff --git a/Tests/TestingTests/SwiftPMTests.swift b/Tests/TestingTests/SwiftPMTests.swift
@@ -9,7 +9,7 @@
 //
 
 @testable @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
-private import TestingInternals
+private import _TestingInternals
 
 private func configurationForEntryPoint(withArguments args: [String]) throws -> Configuration {
   let args = try parseCommandLineArguments(from: args)
diff --git a/Tests/TestingTests/Traits/TagListTests.swift b/Tests/TestingTests/Traits/TagListTests.swift
@@ -9,7 +9,7 @@
 //
 
 @testable @_spi(Experimental) @_spi(ForToolsIntegrationOnly) import Testing
-private import TestingInternals
+private import _TestingInternals
 
 @Suite("Tag/Tag List Tests", .tags(.traitRelated))
 struct TagListTests {
diff --git a/Tests/TestingTests/TypeInfoTests.swift b/Tests/TestingTests/TypeInfoTests.swift
@@ -9,7 +9,7 @@
 //
 
 @testable @_spi(ForToolsIntegrationOnly) import Testing
-private import TestingInternals
+private import _TestingInternals
 
 @Suite("TypeInfo Tests")
 struct TypeInfoTests {
diff --git a/Tests/TestingTests/VariadicGenericTests.swift b/Tests/TestingTests/VariadicGenericTests.swift
@@ -9,7 +9,7 @@
 //
 
 import Testing
-private import TestingInternals
+private import _TestingInternals
 
 @Test func variadicCStringArguments() async throws {
   #expect(swt_pointersNotEqual2("abc", "123"))
