Skip to content

Add Swift Testing Compatibility #310

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add Swift Testing Compatibility #310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50cbf41
Fix Swift 6 concurrency errors.
toastersocks May 26, 2025
6aaf586
Add compatibility with Swift Testing (swift-testing)
toastersocks May 26, 2025
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
2 changes: 1 addition & 1 deletion Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// swift-tools-version:5.2
// swift-tools-version:6.0

import PackageDescription

Expand Down
23 changes: 23 additions & 0 deletions Package@swift-5.2.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// swift-tools-version:5.2

import PackageDescription

let package = Package(
name: "SwiftCheck",
products: [
.library(
name: "SwiftCheck",
targets: ["SwiftCheck"]),
],
dependencies: [
.package(url: "https://github.com/llvm-swift/FileCheck.git", from: "0.1.0")
],
targets: [
.target(
name: "SwiftCheck"),
.testTarget(
name: "SwiftCheckTests",
dependencies: ["SwiftCheck", "FileCheck"]),
]
)

52 changes: 45 additions & 7 deletions Sources/SwiftCheck/Check.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,12 +161,31 @@ infix operator <-
/// Binds a Testable value to a property.
public func <- (checker : AssertiveQuickCheck, test : @autoclosure @escaping () -> Testable) {
switch quickCheckWithResult(checker.args, test()) {
case let .failure(_, _, seed, sz, reason, _, _):
XCTFail(reason + "; Replay with \(seed) and size \(sz)", file: checker.file, line: checker.line)
case let .failure(_, _, seed, sz, reason, _, _):
let message = "\(reason); Replay with \(seed) and size \(sz)"

XCTFail(message, file: checker.file, line: checker.line)
Issue.record("\(message)",
sourceLocation: SourceLocation(fileID: String(describing: checker.file),
filePath: String(describing: checker.file),
line: Int(checker.line), column: 1)
)
case let .noExpectedFailure(_, seed, sz, _, _):
XCTFail("Expected property to fail but it didn't. Replay with \(seed) and size \(sz)", file: checker.file, line: checker.line)
let message = "Expected property to fail but it didn't. Replay with \(seed) and size \(sz)"
XCTFail(message, file: checker.file, line: checker.line)
Issue.record("\(message)",
sourceLocation: SourceLocation(fileID: String(describing: checker.file),
filePath: String(describing: checker.file),
line: Int(checker.line), column: 1)
)
case let .insufficientCoverage(_, seed, sz, _, _):
XCTFail("Property coverage insufficient. Replay with \(seed) and size \(sz)", file: checker.file, line: checker.line)
let message = "Property coverage insufficient. Replay with \(seed) and size \(sz)"
XCTFail(message, file: checker.file, line: checker.line)
Issue.record("\(message)",
sourceLocation: SourceLocation(fileID: String(describing: checker.file),
filePath: String(describing: checker.file),
line: Int(checker.line), column: 1)
)
default: ()
}
}
Expand All @@ -175,11 +194,29 @@ public func <- (checker : AssertiveQuickCheck, test : @autoclosure @escaping ()
public func <- (checker : AssertiveQuickCheck, test : () -> Testable) {
switch quickCheckWithResult(checker.args, test()) {
case let .failure(_, _, seed, sz, reason, _, _):
XCTFail(reason + "; Replay with \(seed) and size \(sz)", file: checker.file, line: checker.line)
let message = "\(reason); Replay with \(seed) and size \(sz)"
XCTFail(message, file: checker.file, line: checker.line)
Issue.record("\(message)",
sourceLocation: SourceLocation(fileID: String(describing: checker.file),
filePath: String(describing: checker.file),
line: Int(checker.line), column: 1)
)
case let .noExpectedFailure(_, seed, sz, _, _):
XCTFail("Expected property to fail but it didn't. Replay with \(seed) and size \(sz)", file: checker.file, line: checker.line)
let message = "Expected property to fail but it didn't. Replay with \(seed) and size \(sz)"
XCTFail(message, file: checker.file, line: checker.line)
Issue.record("\(message)",
sourceLocation: SourceLocation(fileID: String(describing: checker.file),
filePath: String(describing: checker.file),
line: Int(checker.line), column: 1)
)
case let .insufficientCoverage(_, seed, sz, _, _):
XCTFail("Property coverage insufficient. Replay with \(seed) and size \(sz)", file: checker.file, line: checker.line)
let message = "Property coverage insufficient. Replay with \(seed) and size \(sz)"
XCTFail(message, file: checker.file, line: checker.line)
Issue.record("\(message)",
sourceLocation: SourceLocation(fileID: String(describing: checker.file),
filePath: String(describing: checker.file),
line: Int(checker.line), column: 1)
)
default: ()
}
}
Expand Down Expand Up @@ -356,3 +393,4 @@ public func ^||^ (p1 : Testable, p2 : Testable) -> Property {
}

import XCTest
import Testing
9 changes: 6 additions & 3 deletions Sources/SwiftCheck/Random.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,15 @@ extension StdGen : Equatable, CustomStringConvertible {
}
}

private var theStdGen : StdGen = mkStdRNG(0)
private actor TheStdGen {
static var shared : StdGen = mkStdRNG(0)

}

/// A library-provided standard random number generator.
public func newStdGen() -> StdGen {
let (left, right) = theStdGen.split
theStdGen = left
let (left, right) = TheStdGen.shared.split
TheStdGen.shared = left
return right
}

Expand Down
16 changes: 8 additions & 8 deletions Tests/SwiftCheckTests/ComplexSpec.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ import XCTest
import FileCheck
#endif

let upper : Gen<Character> = Gen<Character>.fromElements(in: "A"..."Z")
let lower : Gen<Character> = Gen<Character>.fromElements(in: "a"..."z")
let numeric : Gen<Character> = Gen<Character>.fromElements(in: "0"..."9")
let special : Gen<Character> = Gen<Character>.fromElements(of: ["!", "#", "$", "%", "&", "'", "*", "+", "-", "/", "=", "?", "^", "_", "`", "{", "|", "}", "~", "."])
let hexDigits = Gen<Character>.one(of: [
Gen<Character>.fromElements(in: "A"..."F"),
numeric,
])

class ComplexSpec : XCTestCase {
let upper : Gen<Character> = Gen<Character>.fromElements(in: "A"..."Z")
let lower : Gen<Character> = Gen<Character>.fromElements(in: "a"..."z")
let numeric : Gen<Character> = Gen<Character>.fromElements(in: "0"..."9")
let special : Gen<Character> = Gen<Character>.fromElements(of: ["!", "#", "$", "%", "&", "'", "*", "+", "-", "/", "=", "?", "^", "_", "`", "{", "|", "}", "~", "."])
lazy var hexDigits = Gen<Character>.one(of: [
Gen<Character>.fromElements(in: "A"..."F"),
numeric,
])
func testEmailAddressProperties() {
XCTAssert(fileCheckOutput(withPrefixes: ["CHECKEMAIL"]) {
let localEmail = Gen<Character>.one(of: [
Expand Down
40 changes: 20 additions & 20 deletions Tests/SwiftCheckTests/SimpleSpec.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,28 +120,28 @@ extension ArbitraryLargeFoo : Arbitrary {
}
}

let composedArbitraryLargeFoo = Gen<ArbitraryLargeFoo>.compose { c in
let evenInt16 = Int16.arbitrary.suchThat { $0 % 2 == 0 }
return ArbitraryLargeFoo(
a: c.generate(),
b: c.generate(using: evenInt16),
c: c.generate(),
d: c.generate(),
e: c.generate(),
f: c.generate(),
g: c.generate(),
h: c.generate(),
i: c.generate(),
j: c.generate(),
k: c.generate(),
l: (c.generate(), c.generate()),
m: (c.generate(), c.generate(), c.generate()),
n: (c.generate(), c.generate(), c.generate(), c.generate())
)
}

class SimpleSpec : XCTestCase {
func testAll() {
let composedArbitraryLargeFoo = Gen<ArbitraryLargeFoo>.compose { c in
let evenInt16 = Int16.arbitrary.suchThat { $0 % 2 == 0 }
return ArbitraryLargeFoo(
a: c.generate(),
b: c.generate(using: evenInt16),
c: c.generate(),
d: c.generate(),
e: c.generate(),
f: c.generate(),
g: c.generate(),
h: c.generate(),
i: c.generate(),
j: c.generate(),
k: c.generate(),
l: (c.generate(), c.generate()),
m: (c.generate(), c.generate(), c.generate()),
n: (c.generate(), c.generate(), c.generate(), c.generate())
)
}

XCTAssert(fileCheckOutput {
// CHECK: *** Passed 100 tests
// CHECK-NEXT: .
Expand Down