Skip to content

Show the number of test cases that ran at the end of a test #972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ extension Event {

/// The number of known issues recorded for the test.
var knownIssueCount = 0

/// The number of test cases for the test.
var testCasesCount: Int = 0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: can omit the explicit type since this isn't a public property, to match prevailing style

Suggested change
var testCasesCount: Int = 0
var testCasesCount = 0

}

/// Data tracked on a per-test basis.
Expand Down Expand Up @@ -281,6 +284,10 @@ extension Event.HumanReadableOutputRecorder {
testData.issueCount[issue.severity] = issueCount + 1
}
context.testData[id] = testData

case .testCaseStarted:
let test = test!
context.testData[test.id.keyPathRepresentation]?.testCasesCount += 1

default:
// These events do not manipulate the context structure.
Expand Down Expand Up @@ -366,18 +373,23 @@ extension Event.HumanReadableOutputRecorder {
let testData = testDataGraph?.value ?? .init(startInstant: instant)
let issues = _issueCounts(in: testDataGraph)
let duration = testData.startInstant.descriptionOfDuration(to: instant)
let testCasesCount = if verbosity >= 2 && test.isParameterized {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stmontgomery What do you think about the required verbosity here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should always include this, and not conditionalize it on verbosity. It's only a few extra words, not adding any additional lines, and I think it's a generally useful enhancement. The current summary text always includes a count of the issues recorded regardless of verbosity, and this isn't all that different.

(We should continue to check test.isParameterized, though.)

" with \(testData.testCasesCount.counting("test case"))"
} else {
""
}
return if issues.errorIssueCount > 0 {
CollectionOfOne(
Message(
symbol: .fail,
stringValue: "\(_capitalizedTitle(for: test)) \(testName) failed after \(duration)\(issues.description)."
stringValue: "\(_capitalizedTitle(for: test)) \(testName)\(testCasesCount) failed after \(duration)\(issues.description)."
)
) + _formattedComments(for: test)
} else {
[
Message(
symbol: .pass(knownIssueCount: issues.knownIssueCount),
stringValue: "\(_capitalizedTitle(for: test)) \(testName) passed after \(duration)\(issues.description)."
stringValue: "\(_capitalizedTitle(for: test)) \(testName)\(testCasesCount) passed after \(duration)\(issues.description)."
)
]
}
Expand Down
43 changes: 43 additions & 0 deletions Tests/TestingTests/EventRecorderTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,44 @@ struct EventRecorderTests {
.first != nil
)
}

@available(_regexAPI, *)
@Test(
"number of arguments based on verbosity level at the end of test run",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The display name of this test can be rephrased now to not mention verbosity. I'd also prefer if we could capitalize the first word to match prevailing style.

arguments: [
("f()", #".* Test f\(\) failed after .*"# , 0),
("f()", #".* Test f\(\) failed after .*"# , 2),
("d(_:)", #".* Test d\(_:\) with .+ test cases passed after.*"# , 2),
("PredictablyFailingTests", #".* Suite PredictablyFailingTests failed after .*"# , 1),
("PredictablyFailingTests", #".* Suite PredictablyFailingTests failed after .*"# , 2),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: whitespace

Suggested change
("f()", #".* Test f\(\) failed after .*"# , 0),
("f()", #".* Test f\(\) failed after .*"# , 2),
("d(_:)", #".* Test d\(_:\) with .+ test cases passed after.*"# , 2),
("PredictablyFailingTests", #".* Suite PredictablyFailingTests failed after .*"# , 1),
("PredictablyFailingTests", #".* Suite PredictablyFailingTests failed after .*"# , 2),
("f()", #".* Test f\(\) failed after .*"#, 0),
("f()", #".* Test f\(\) failed after .*"#, 2),
("d(_:)", #".* Test d\(_:\) with .+ test cases passed after.*"#, 2),
("PredictablyFailingTests", #".* Suite PredictablyFailingTests failed after .*"#, 1),
("PredictablyFailingTests", #".* Suite PredictablyFailingTests failed after .*"#, 2),

]
)
func numberOfArgumentsAtTheEndOfTests(testName: String, expectedPattern: String, verbosity: 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)
}
configuration.verbosity = verbosity

await runTest(for: PredictablyFailingTests.self, configuration: configuration)

let buffer = stream.buffer.rawValue
if testsWithSignificantIOAreEnabled {
print(buffer, terminator: "")
}

let aurgmentRegex = try Regex(expectedPattern)

#expect(
(try buffer
.split(whereSeparator: \.isNewline)
.compactMap(aurgmentRegex.wholeMatch(in:))
.first) != nil
)
}

@available(_regexAPI, *)
@Test(
Expand Down Expand Up @@ -536,6 +574,11 @@ struct EventRecorderTests {
#expect(Bool(false))
}
}

@Test(.hidden, arguments: [1, 2, 3])
func d(_ arg: Int) {
#expect(arg > 0)
}

@Test(.hidden) func g() {
#expect(Bool(false))
Expand Down