Add CustomStringConvertible and CustomDebugStringConvertible to Issue.Snapshot and Issue.Kind.Snapshot (#359)

Make `Issue.Snapshot` and `Issue.Kind.Snapshot` conform to
`CustomStringConvertible` and `CustomDebugStringConvertible` using the
same implementation as their original types.

Resolves rdar://126646993

Author: dennisweissmann

Sources/Testing/Issues/Issue.swift

@@ -405,3 +405,54 @@ extension Issue.Kind {
     }
   }
 }
+
+// MARK: - Snapshot CustomStringConvertible, CustomDebugStringConvertible
+
+extension Issue.Snapshot: CustomStringConvertible, CustomDebugStringConvertible {
+  public var description: String {
+    if comments.isEmpty {
+      return String(describing: kind)
+    }
+    let joinedComments = comments.lazy
+      .map(\.rawValue)
+      .joined(separator: "\n")
+    return "\(kind): \(joinedComments)"
+  }
+
+  public var debugDescription: String {
+    if comments.isEmpty {
+      return "\(kind)\(sourceLocation.map { " at \($0)" } ?? "")"
+    }
+    let joinedComments: String = comments.lazy
+      .map(\.rawValue)
+      .joined(separator: "\n")
+    return "\(kind)\(sourceLocation.map { " at \($0)" } ?? ""): \(joinedComments)"
+  }
+}
+
+extension Issue.Kind.Snapshot: CustomStringConvertible {
+  public var description: String {
+    switch self {
+    case .unconditional:
+      "Unconditionally failed"
+    case let .expectationFailed(expectation):
+      if let mismatchedErrorDescription = expectation.mismatchedErrorDescription {
+        "Expectation failed: \(mismatchedErrorDescription)"
+      } else {
+        "Expectation failed: \(expectation.evaluatedExpression.expandedDescription())"
+      }
+    case let .confirmationMiscounted(actual: actual, expected: expected):
+      "Confirmation was confirmed \(actual.counting("time")), but expected to be confirmed \(expected.counting("time"))"
+    case let .errorCaught(error):
+      "Caught error: \(error)"
+    case let .timeLimitExceeded(timeLimitComponents: timeLimitComponents):
+      "Time limit was exceeded: \(TimeValue(timeLimitComponents))"
+    case .knownIssueNotRecorded:
+      "Known issue was not recorded"
+    case .apiMisused:
+      "An API was misused"
+    case .system:
+      "A system failure occurred"
+    }
+  }
+}

Tests/TestingTests/IssueTests.swift

@@ -1390,22 +1390,26 @@ final class IssueTests: XCTestCase {
 @Suite("Issue Codable Conformance Tests")
 struct IssueCodingTests {
 
+  private static let issueKinds: [Issue.Kind] = [
+    Issue.Kind.apiMisused,
+    Issue.Kind.confirmationMiscounted(actual: 13, expected: 42),
+    Issue.Kind.errorCaught(NSError(domain: "Domain", code: 13, userInfo: ["UserInfoKey": "UserInfoValue"])),
+    Issue.Kind.expectationFailed(Expectation(evaluatedExpression: .__fromSyntaxNode("abc"), isPassing: true, isRequired: true, sourceLocation: SourceLocation())),
+    Issue.Kind.knownIssueNotRecorded,
+    Issue.Kind.system,
+    Issue.Kind.timeLimitExceeded(timeLimitComponents: (13, 42)),
+    Issue.Kind.unconditional,
+  ]
+
   @Test("Codable",
-        arguments: [
-          Issue.Kind.apiMisused,
-          Issue.Kind.confirmationMiscounted(actual: 13, expected: 42),
-          Issue.Kind.errorCaught(NSError(domain: "Domain", code: 13, userInfo: ["UserInfoKey": "UserInfoValue"])),
-          Issue.Kind.expectationFailed(Expectation(evaluatedExpression: .__fromSyntaxNode("abc"), isPassing: true, isRequired: true, sourceLocation: SourceLocation())),
-          Issue.Kind.knownIssueNotRecorded,
-          Issue.Kind.system,
-          Issue.Kind.timeLimitExceeded(timeLimitComponents: (13, 42)),
-          Issue.Kind.unconditional,
-        ]
+    arguments: issueKinds
   )
   func testCodable(issueKind: Issue.Kind) async throws {
-    let issue = Issue(kind: issueKind,
-                      comments: ["Comment"],
-                      sourceContext: SourceContext(backtrace: Backtrace.current(), sourceLocation: SourceLocation()))
+    let issue = Issue(
+      kind: issueKind,
+      comments: ["Comment"],
+      sourceContext: SourceContext(backtrace: Backtrace.current(), sourceLocation: SourceLocation())
+    )
     let issueSnapshot = Issue.Snapshot(snapshotting: issue)
     let decoded = try JSON.encodeAndDecode(issueSnapshot)
 
@@ -1479,4 +1483,19 @@ struct IssueCodingTests {
     #expect(issueSnapshot.sourceLocation == updatedSourceLocation)
     #expect(issueSnapshot.sourceContext.sourceLocation == updatedSourceLocation)
   }
+
+  @Test("Custom descriptions are the same",
+    arguments: issueKinds
+  )
+  func customDescription(issueKind: Issue.Kind) async throws {
+    let issue = Issue(
+      kind: issueKind,
+      comments: ["Comment"],
+      sourceContext: SourceContext(backtrace: Backtrace.current(), sourceLocation: SourceLocation())
+    )
+    let issueSnapshot = Issue.Snapshot(snapshotting: issue)
+
+    #expect(String(describing: issueSnapshot) == String(describing: issue))
+    #expect(String(reflecting: issueSnapshot) == String(reflecting: issue))
+  }
 }