Console output should prefix messages with "Suite" instead of "Test" for suites (#184)

* Console output should prefix messages with "Suite" instead of "Test" for suites

Resolves rdar://120962053

* Change to a free function

Author: stmontgomery

Sources/Testing/Events/Recorder/Event.HumanReadableOutputRecorder.swift

@@ -142,6 +142,19 @@ extension Event.HumanReadableOutputRecorder {
   }
 }
 
+/// Generate a title for the specified test (either "Test" or "Suite"),
+/// capitalized and suitable for use as the leading word of a human-readable
+/// message string.
+///
+/// - Parameters:
+///   - test: The test to generate a description for, if any.
+///
+/// - Returns: A human-readable title for the specified test. Defaults to "Test"
+///   if `test` is `nil`.
+private func _capitalizedTitle(for test: Test?) -> String {
+  test?.isSuite == true ? "Suite" : "Test"
+}
+
 extension Test.Case {
   /// The arguments of this test case, formatted for presentation, prefixed by
   /// their corresponding parameter label when available.
@@ -224,7 +237,7 @@ extension Event.HumanReadableOutputRecorder {
       return [
         Message(
           symbol: .default,
-          stringValue: "Test \(testName) started."
+          stringValue: "\(_capitalizedTitle(for: test)) \(testName) started."
         )
       ]
 
@@ -239,14 +252,14 @@ extension Event.HumanReadableOutputRecorder {
         CollectionOfOne(
           Message(
             symbol: .fail,
-            stringValue: "Test \(testName) failed after \(duration)\(issues.description)."
+            stringValue: "\(_capitalizedTitle(for: test)) \(testName) failed after \(duration)\(issues.description)."
           )
         ) + _formattedComments(for: test)
       } else {
          [
           Message(
             symbol: .pass(knownIssueCount: issues.knownIssueCount),
-            stringValue: "Test \(testName) passed after \(duration)\(issues.description)."
+            stringValue: "\(_capitalizedTitle(for: test)) \(testName) passed after \(duration)\(issues.description)."
           )
         ]
       }
@@ -262,11 +275,11 @@ extension Event.HumanReadableOutputRecorder {
       }
       return if let comment = skipInfo.comment {
         [
-          Message(symbol: .skip, stringValue: "Test \(testName) skipped: \"\(comment.rawValue)\"")
+          Message(symbol: .skip, stringValue: "\(_capitalizedTitle(for: test)) \(testName) skipped: \"\(comment.rawValue)\"")
         ]
       } else {
         [
-          Message(symbol: .skip, stringValue: "Test \(testName) skipped.")
+          Message(symbol: .skip, stringValue: "\(_capitalizedTitle(for: test)) \(testName) skipped.")
         ]
       }
 
@@ -318,12 +331,12 @@ extension Event.HumanReadableOutputRecorder {
       let primaryMessage: Message = if parameterCount == 0 {
         Message(
           symbol: symbol,
-          stringValue: "Test \(testName) recorded a\(known) issue\(atSourceLocation): \(issue.kind)"
+          stringValue: "\(_capitalizedTitle(for: test)) \(testName) recorded a\(known) issue\(atSourceLocation): \(issue.kind)"
         )
       } else {
         Message(
           symbol: symbol,
-          stringValue: "Test \(testName) recorded a\(known) issue with \(parameterCount.counting("argument")) \(labeledArguments)\(atSourceLocation): \(issue.kind)"
+          stringValue: "\(_capitalizedTitle(for: test)) \(testName) recorded a\(known) issue with \(parameterCount.counting("argument")) \(labeledArguments)\(atSourceLocation): \(issue.kind)"
         )
       }
       return CollectionOfOne(primaryMessage) + additionalMessages

Tests/TestingTests/EventRecorderTests.swift

@@ -92,14 +92,14 @@ struct EventRecorderTests {
 #if !os(Windows)
   @available(_regexAPI, *)
   @Test(
-    "Issue counts are summed correctly on test end",
+    "Titles of messages ('Test' vs. 'Suite') are determined correctly",
     arguments: [
-      "f()": (5, 3),
-      "g()": (2, 1),
-      "PredictablyFailingTests": (7, 4)
+      ("f()", false),
+      ("g()", false),
+      ("PredictablyFailingTests", true),
     ]
   )
-  func issueCountSummingAtTestEnd(testName: String, issueCount: (total: Int, expected: Int)) async throws {
+  func messageTitles(testName: String, isSuite: Bool) async throws {
     let stream = Stream()
 
     var configuration = Configuration()
@@ -117,7 +117,44 @@ struct EventRecorderTests {
 
     let testFailureRegex = Regex {
       One(.anyGraphemeCluster)
-      " Test \(testName) failed"
+      " \(isSuite ? "Suite" : "Test") \(testName) started."
+    }
+    #expect(
+      try buffer
+        .split(whereSeparator: \.isNewline)
+        .compactMap(testFailureRegex.wholeMatch(in:))
+        .first != nil
+    )
+  }
+
+  @available(_regexAPI, *)
+  @Test(
+    "Issue counts are summed correctly on test end",
+    arguments: [
+      ("f()", false, (total: 5, expected: 3)),
+      ("g()", false, (total: 2, expected: 1)),
+      ("PredictablyFailingTests", true, (total: 7, expected: 4)),
+    ]
+  )
+  func issueCountSummingAtTestEnd(testName: String, isSuite: Bool, issueCount: (total: Int, expected: Int)) async throws {
+    let stream = Stream()
+
+    var configuration = Configuration()
+    let eventRecorder = Event.ConsoleOutputRecorder(writingUsing: stream.write)
+    configuration.eventHandler = { event, context in
+      eventRecorder.record(event, in: context)
+    }
+
+    await runTest(for: PredictablyFailingTests.self, configuration: configuration)
+
+    let buffer = stream.buffer.wrappedValue
+    if testsWithSignificantIOAreEnabled {
+      print(buffer, terminator: "")
+    }
+
+    let testFailureRegex = Regex {
+      One(.anyGraphemeCluster)
+      " \(isSuite ? "Suite" : "Test") \(testName) failed "
       ZeroOrMore(.any)
       " with "
       Capture { OneOrMore(.digit) } transform: { Int($0) }