A Swift package for the Test Anything Protocol (v13).
- Swift 5.3+
You can use TAP
as an alternative to XCTest
in executable targets
or as a custom reporter in test targets.
import TAP
try TAP.run([
test(1 + 1 == 2), // passes
test(true == false) // fails
])
// Prints:
/*
TAP version 13
1..2
ok 1
not ok 2
---
file: path/to/File.swift
line: 5
...
*/
Swift Package Manager on Linux
uses swift-corelibs-xctest,
which provides an XCTMain
that
Run the following command on macOS to (re)-generate your main test file:
$ swift test --generate-linuxmain
Open the resulting LinuxMain.swift
file,
add an import statement for the TAP
module
and register XCTestTAPObserver
as a test observer.
In Swift 5.4 and later,
you can update the XCTMain
invocation to include an observers
parameter
with an instance of XCTestTAPObserver
.
#if os(Linux)
import XCTest
import TAP
@testable import TAPTests
#if swift(>=5.4)
XCTMain([
testCase(TAPTests.allTests)
],
arguments: CommandLine.arguments,
observers: [
XCTestTAPObserver()
])
#else
XCTestObservationCenter.shared.addTestObserver(XCTestTAPObserver())
XCTMain([
testCase(TAPTests.allTests)
])
#endif
When you run the swift test
command,
your test suite will be reported in TAP format.
As of Swift 5.3,
it's not possible to configure a custom reporter
when running tests directly through Swift Package Manager.
However, Xcode provides a mechanism for loading custom reports via
XCTestObservationCenter
.
Create a new file named TestObservation.swift
and add it to your test bundle.
Import the TAP
module,
declare a subclass of NSObject
named TestObservation
,
and override its designated initializer
to register XCTestTAPObserver
with the shared XCTestObservationCenter
.
import TAP
final class TestObservation: NSObject {
override init() {
XCTestObservationCenter.shared.addTestObserver(XCTestTAPObserver())
}
}
Add an entry to your test target's Info.plist
file
designating the fully-qualified name of this class as the NSPrincipalClass
.
<key>NSPrincipalClass</key>
<string>YourTestTarget.TestObservation</string>
When you run your test bundle, Xcode will instantiate the principle class first, ensuring that your test observers are registered in time to report the progress of all test runs.
Add the TAP package to your target dependencies in Package.swift
:
import PackageDescription
let package = Package(
name: "YourProject",
dependencies: [
.package(
url: "https://github.com/SwiftDocOrg/TAP",
from: "0.2.0"
),
]
)
Add TAP
as a dependency to your test target(s):
targets: [
.testTarget(
name: "YourTestTarget",
dependencies: ["TAP"]),
MIT
Mattt (@mattt)