A standalone Swift version of LLVM’s flexible pattern matching file verifier
Introduction
FileCheck is a utility for verifying the contents of two files match (for example,
one from standard input, and one residing on disk). This implementation of
FileCheck emphasizes its use as a tool for checking output generated by programs
against an expected set of strings that can be specified inline next to the
print statement that generated it.
The primary API in this package is the fileCheckOutput function, which comes
with a number of convenient optional parameters to modify the behavior of the
verification process. For example, here is a self-contained test that verifies
the output of FizzBuzz:
assert(fileCheckOutput(withPrefixes: ["FIZZBUZZ"]) {
for i in (1..<10) {
var out = ""
if i % 3 == 0 {
out += "Fizz"
}
if i % 5 == 0 {
out += "Buzz"
}
if out.isEmpty {
out += "\(i)"
}
// FIZZBUZZ: 1
// FIZZBUZZ-NEXT: 2
// FIZZBUZZ-NEXT: Fizz
// FIZZBUZZ-NEXT: 4
// FIZZBUZZ-NEXT: Buzz
// FIZZBUZZ-NEXT: Fizz
// FIZZBUZZ-NEXT: 7
// FIZZBUZZ-NEXT: 8
// FIZZBUZZ-NEXT: Fizz
print(out)
}
})
Executing this test in any file will cause FileCheck to read it in
from disk and verify the output of the program against the check-strings in the
comments.
Setup
Using The Swift Package Manager
Add FileCheck to your Package.swift file’s dependencies section:
FileCheck
A standalone Swift version of LLVM’s flexible pattern matching file verifier
Introduction
FileCheck is a utility for verifying the contents of two files match (for example, one from standard input, and one residing on disk). This implementation of FileCheck emphasizes its use as a tool for checking output generated by programs against an expected set of strings that can be specified inline next to the
printstatement that generated it.The primary API in this package is the
fileCheckOutputfunction, which comes with a number of convenient optional parameters to modify the behavior of the verification process. For example, here is a self-contained test that verifies the output of FizzBuzz:Executing this test in any file will cause FileCheck to read it in from disk and verify the output of the program against the check-strings in the comments.
Setup
Using The Swift Package Manager
Package.swiftfile’s dependencies section:Authors
License
This project is released under the MIT license, a copy of which is available in this repo.