0xOpenBytes

Testing code with t SPM ๐Ÿ“ฆ

๐Ÿ”— Check out t


git clone git@github.com:0xOpenBytes/t.git

What is t?

t is a simple testing framework using closures and errors. You have the ability to create a suite that has multiple steps, expectations, and asserts. Expectations can be used to expect one or multiple assertions. It can be used to test quickly inside a function to make sure something is working as expected. t can also be used in unit test if wanted.



Creating a Test Suite


Using t.suite(...) you can create a test suite that will return false if any error is thrown. Test suites contains multiple steps, expectations, assertions, and even test suites. All logging will use t.logger, which defaults to print(...).


Example Test Suite


// Create Test Suite
t.suite {
    // Add an expectation that asserting true is true and that 2 is equal to 2
    try t.expect {
        try t.assert(true)
        try t.assert(2, isEqualTo: 2)
    }
    
    // Add an assertion that asserting false is not true
    try t.assert(notTrue: false)
    
    // Add an assertion that "Hello" is not equal to "World"
    try t.assert("Hello", isNotEqualTo: "World")
    
    // Log a message
    t.log("๐Ÿ“ฃ Test Log Message")
    
    // Log a t.error
    t.log(error: t.error(description: "Mock Error"))
    
    // Add an assertion to check if a value is nil
    let someValue: String? = nil
    try t.assert(isNil: someValue)
    
    // Add an assertion to check if a value is not nil
    let someOtherValue: String? = "๐Ÿ’ "
    try t.assert(isNotNil: someOtherValue)
}

Example Test Suite Output



๐Ÿงช Testing Suite
๐Ÿ”˜ Expecting something to be true
๐Ÿ“ฃ Test Log Message
โ—๏ธ Mock Error (
    File: tTests.swift
    Function: testExample()
    Line: 25
)
โœ… Suite Passed!

Making Expectations


Using t.expect(...) we can make an expectation with one or multiple assertions. We can create variables and log messages too. The expectation will be true unless some error is thrown. The error might be thrown by an assertion or can be thrown manually too.


Example Expectation


try t.expect("true is true and that 2 is equal to 2") {
    try t.assert(true)
    try t.assert(2, isEqualTo: 2)
}

Example Expectation Output



๐Ÿ”˜ Expecting true is true and that 2 is equal to 2

Making an Assertion


try t.assert("Hello", isNotEqualTo: "World")

Logging Information


Test suite information is automatically logged using t.logger. The logger is a static variable of type (String) -> Void which has a default value of { print($0) }. Feel free to supply your own logging function. Manual logging should use t.log(String) or t.log(error: Error).


Example Manual Logging


// Log a message
t.log("๐Ÿ“ฃ Test Log Message")

// Log a t.error
t.log(error: t.error(description: "Mock Error"))

// Log any error
struct SomeError: Error { }
t.log(error: SomeError())

Quick Testing


t.suite {
    try t.expect {
        let expectedValue = ...
        let value = function()
        try t.assert(value, isEqualTo: expectedValue)
    }
}

Unit Tests


XCTAssert Test Suite


XCTAssert(
    t.suite {
        // ...
    }
)

XCTAssertNoThrow Expectation


XCTAssertNoThrow(
    try t.expect("true is true and that 2 is equal to 2") {
        try t.assert(true)
        try t.assert(2, isEqualTo: 2)
    }
)

XCTAssertNoThrow Assert


XCTAssertNoThrow(
    try t.assert(true)
)


โฌ†๏ธ Back to the Top

Tagged with: