Factor out bug report URL boilerplate into a utility function (#1635)

Author: stmontgomery

Sources/Overlays/_Testing_Foundation/Attachments/_AttachableURLWrapper.swift

@@ -53,7 +53,7 @@ public struct _AttachableURLWrapper: Sendable {
   ///   thrown if a file descriptor to `url` or `copyURL` cannot be created.
   init(url: URL, copiedToFileAt copyURL: URL? = nil, isCompressedDirectory: Bool) throws {
     if isCompressedDirectory && copyURL == nil {
-      preconditionFailure("When attaching a directory to a test, the URL to its compressed copy must be supplied. Please file a bug report at https://github.com/swiftlang/swift-testing/issues/new")
+      preconditionFailure("When attaching a directory to a test, the URL to its compressed copy must be supplied. \(fileABugMessage)")
     }
     self.url = url
     self.data = try Data(contentsOf: copyURL ?? url, options: [.mappedIfSafe])

Sources/Testing/ABI/Encoded/ABI.EncodedTest.swift

@@ -135,7 +135,7 @@ extension ABI {
 
     init(encoding testCase: borrowing Test.Case) {
       guard let arguments = testCase.arguments else {
-        preconditionFailure("Attempted to initialize an EncodedTestCase encoding a test case which is not parameterized: \(testCase). Please file a bug report at https://github.com/swiftlang/swift-testing/issues/new")
+        preconditionFailure("Attempted to initialize an EncodedTestCase encoding a test case which is not parameterized: \(testCase). \(fileABugMessage)")
       }
 
       // TODO: define an encodable form of Test.Case.ID

Sources/Testing/Attachments/Attachment.swift

@@ -584,7 +584,7 @@ extension Configuration {
     }
 
     guard case let .valueAttached(attachment) = event.kind else {
-      preconditionFailure("Passed the wrong kind of event to \(#function) (expected valueAttached, got \(event.kind)). Please file a bug report at https://github.com/swiftlang/swift-testing/issues/new")
+      preconditionFailure("Passed the wrong kind of event to \(#function) (expected valueAttached, got \(event.kind)). \(fileABugMessage)")
     }
     if attachment.fileSystemPath != nil {
       // Somebody already saved this attachment. This isn't necessarily a logic

Sources/Testing/CMakeLists.txt

@@ -91,6 +91,7 @@ add_library(Testing
   Support/Additions/TaskAdditions.swift
   Support/Additions/WinSDKAdditions.swift
   Support/Allocated.swift
+  Support/BugReporting.swift
   Support/CartesianProduct.swift
   Support/CError.swift
   Support/CustomIssueRepresentable.swift

Sources/Testing/ExitTests/ExitTest.swift

@@ -294,7 +294,7 @@ extension ExitTest {
 
     // Set ExitTest.current before the test body runs.
     Self._current.withLock { current in
-      precondition(current == nil, "Set the current exit test twice in the same process. Please file a bug report at https://github.com/swiftlang/swift-testing/issues/new")
+      precondition(current == nil, "Set the current exit test twice in the same process. \(fileABugMessage)")
       current = self.unsafeCopy()
     }
 
@@ -1096,7 +1096,7 @@ extension ExitTest {
     }
     let capturedValuesJSON = try fileHandle.readToEnd()
     let capturedValuesJSONLines = capturedValuesJSON.split(whereSeparator: \.isASCIINewline)
-    assert(capturedValues.count == capturedValuesJSONLines.count, "Expected to decode \(capturedValues.count) captured value(s) for the current exit test, but received \(capturedValuesJSONLines.count). Please file a bug report at https://github.com/swiftlang/swift-testing/issues/new")
+    assert(capturedValues.count == capturedValuesJSONLines.count, "Expected to decode \(capturedValues.count) captured value(s) for the current exit test, but received \(capturedValuesJSONLines.count). \(fileABugMessage)")
 
     // Walk the list of captured values' types, map them to their JSON blobs,
     // and decode them.

Sources/Testing/ExitTests/SpawnProcess.swift

@@ -129,7 +129,7 @@ func spawnExecutable(
       func inherit(_ fileHandle: borrowing FileHandle, as standardFD: CInt? = nil) throws {
         try fileHandle.withUnsafePOSIXFileDescriptor { fd in
           guard let fd else {
-            throw SystemError(description: "A child process cannot inherit a file handle without an associated file descriptor. Please file a bug report at https://github.com/swiftlang/swift-testing/issues/new")
+            throw SystemError(description: "A child process cannot inherit a file handle without an associated file descriptor. \(fileABugMessage)")
           }
           if let standardFD, standardFD != fd {
             _ = posix_spawn_file_actions_adddup2(fileActions, fd, standardFD)
@@ -241,7 +241,7 @@ func spawnExecutable(
     func inherit(_ fileHandle: borrowing FileHandle) throws -> HANDLE? {
       try fileHandle.withUnsafeWindowsHANDLE { windowsHANDLE in
         guard let windowsHANDLE else {
-          throw SystemError(description: "A child process cannot inherit a file handle without an associated Windows handle. Please file a bug report at https://github.com/swiftlang/swift-testing/issues/new")
+          throw SystemError(description: "A child process cannot inherit a file handle without an associated Windows handle. \(fileABugMessage)")
         }
 
         // Ensure the file handle can be inherited by the child process.

Sources/Testing/ExitTests/WaitFor.swift

@@ -33,7 +33,7 @@ private func _blockAndWait(for pid: consuming pid_t) throws -> ExitStatus {
       case .init(CLD_KILLED), .init(CLD_DUMPED):
         return .signal(siginfo.si_status)
       default:
-        throw SystemError(description: "Unexpected siginfo_t value. Please file a bug report at https://github.com/swiftlang/swift-testing/issues/new and include this information: \(String(reflecting: siginfo))")
+        throw SystemError(description: "Unexpected siginfo_t value. \(fileABugMessage(context: String(reflecting: siginfo)))")
       }
     } else if case let errorCode = swt_errno(), errorCode != EINTR {
       throw CError(rawValue: errorCode)
@@ -247,7 +247,7 @@ func wait(for pid: consuming pid_t) async throws -> ExitStatus {
       // we add this continuation to the dictionary, then it will simply loop
       // and report the status again.
       let oldContinuation = childProcessContinuations.updateValue(continuation, forKey: pid)
-      assert(oldContinuation == nil, "Unexpected continuation found for PID \(pid). Please file a bug report at https://github.com/swiftlang/swift-testing/issues/new")
+      assert(oldContinuation == nil, "Unexpected continuation found for PID \(pid). \(fileABugMessage)")
 
       // Wake up the waiter thread if it is waiting for more child processes.
       _ = pthread_cond_signal(_waitThreadNoChildrenCondition)

Sources/Testing/Support/Additions/TaskAdditions.swift

@@ -19,7 +19,7 @@ func decorateTaskName(_ taskName: String?, withAction action: String?) -> String
   let prefix = "[Swift Testing]"
   return taskName.map { taskName in
 #if DEBUG
-    precondition(!taskName.hasPrefix(prefix), "Applied prefix '\(prefix)' to task name '\(taskName)' twice. Please file a bug report at https://github.com/swiftlang/swift-testing/issues/new")
+    precondition(!taskName.hasPrefix(prefix), "Applied prefix '\(prefix)' to task name '\(taskName)' twice. \(fileABugMessage)")
 #endif
     let action = action.map { " - \($0)" } ?? ""
     return "\(prefix) \(taskName)\(action)"

Sources/Testing/Support/Additions/WinSDKAdditions.swift

@@ -44,7 +44,7 @@ let STATUS_SIGNAL_CAUGHT_BITS = {
 #if DEBUG
   assert(
     (result & STATUS_CODE_MASK) == 0,
-    "Constructed NTSTATUS mask \(String(result, radix: 16)) encroached on code bits. Please file a bug report at https://github.com/swiftlang/swift-testing/issues/new"
+    "Constructed NTSTATUS mask \(String(result, radix: 16)) encroached on code bits. \(fileABugMessage)"
   )
 #endif
 

Sources/Testing/Support/BugReporting.swift

@@ -0,0 +1,49 @@
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2026 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
+//
+
+/// A standardized message inviting a user to file a bug report at the provided
+/// URL.
+package var fileABugMessage: String {
+  _fileABugMessage(context: "")
+}
+
+/// A standardized message inviting a user to file a bug report at the provided
+/// URL and include the specified contextual information.
+///
+/// - Parameters:
+///   - context: Additional diagnostic information to include with the bug
+///     report message.
+///
+/// - Returns: A string combining a standard request to file a bug report (with
+///   a URL provided) and `context`.
+package func fileABugMessage(context: String) -> String {
+  _fileABugMessage(context: context)
+}
+
+/// Construct a message inviting a user to file a bug report with some optional
+/// context to provide.
+///
+/// - Parameters:
+///   - context: Optional additional diagnostic information to include with the
+///     bug report message.
+///
+/// - Returns: A string combining a standard request to file a bug report (with
+///   a URL provided) and `context`, if provided.
+///
+/// This common implementation function is provided because calling
+/// `fileABugMessage(context:)` directly from the `fileABugMessage` property
+/// getter isn't supported since they have the same base name.
+private func _fileABugMessage(context: String?) -> String {
+  var result = "Please file a bug report at https://github.com/swiftlang/swift-testing/issues/new"
+  if let context {
+    result += " and include this information: \(context)"
+  }
+  return result
+}