Tablier

KO | EN

gitlite — search

#react #llm #go #golang #rust #macos #java #awesome #kubernetes #awesome-list #security #pytorch #ios #openai

(★ 35)

A micro-framework for Table Driven Tests.

Tablier Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Tablier

[![Build Status](https://travis-ci.com/akkyie/Tablier.svg?branch=master)](https://travis-ci.com/akkyie/Tablier)
[![codecov](https://codecov.io/gh/akkyie/Tablier/branch/master/graph/badge.svg)](https://codecov.io/gh/akkyie/Tablier)
![Swift 5](https://img.shields.io/badge/swift-5-orange.svg)
![CocoaPods compatible](https://img.shields.io/cocoapods/v/Tablier.svg)
![Carthage compatible](https://img.shields.io/badge/carthage-compatible-brightgreen.svg)
![SPM compatible](https://img.shields.io/badge/SPM-Compatible-brightgreen.svg)
![Supports iOS, macOS, tvOS and Linux](https://img.shields.io/badge/platform-iOS%20%7C%20macOS%20%7C%20tvOS%20%7C%20linux-lightgrey.svg)
![MIT License](https://img.shields.io/badge/license-MIT-brightgreen.svg)

A micro-framework for [_Table Driven Tests_](https://github.com/golang/go/wiki/TableDrivenTests).

![A screenshot to see how it works](https://user-images.githubusercontent.com/1528813/59867231-9b508b00-93c8-11e9-8489-127d441c2a5b.png)

## Features

- ☑️ Dead simple syntax
- ☑️ Run sync and async tests in parallel
- ☑️ No additional dependency aside from XCTest
- ☑️ Use with [Quick](https://github.com/Quick/Quick), or any other XCTest-based testing frameworks
- ☑️ Fully tested itself

## Installation

### Swift Package Manager

```swift
.package(url: "https://github.com/akkyie/Tablier", from: <#version#>)
```

### Cocoapods

```ruby
target 'YourTests' do
    inherit! :search_paths
    pod 'Tablier'
end
```

## Usage

### Synchronous Recipe

You can define a _test recipe_ to test your classes, structs or functions.

```swift
final class MyParseTests: XCTestCase {
    func testMyParse() {
        let recipe = Recipe<String, Int>(sync: { input in
            // `myParse` here is what you want to test
            let output: Int = try myParse(input) // it fails if an error is thrown
            return output
        })
...
```

Then you can list inputs and expected outputs for the recipe, to run the actual test for it.

```swift
...
        recipe.assert(with: self) {
            $0.when("1").expect(1)
            $0.when("1234567890").expect(1234567890)
            $0.when("-0x42").expect(-0x42)
        }
    }
}
```

### Asynchronous Recipe

Defining a recipe with an asynchronous completion is also supported.

```swift
let recipe = Recipe<String, Int>(async: { input, complete in
    myComplexAndSlowParse(input) { (result: Int?, error: Error?) in
        complete(result, error)
    }
})
```

Since Swift 5.5, you can use `AsyncRecipe` to define asynchronous recipes with async/await syntax:

```swift
let recipe = AsyncRecipe<String, Int> { input in
    try await myComplexAndSlowParse(input)
}
```

#### Note

> **Note**
>
> When an error is thrown in the sync initalizer or the completion handler is called with an error, the test case is considered as failed for now.
> Testing errors will be supported in the future.

## Examples

- [SyncExample.swift](/Examples/Tests/ExampleTests/SyncExample.swift): A simple example with a sync function.
- [AsyncExample.swift](/Examples/Tests/ExampleTests/AsyncExample.swift): An example with an async function.
- [RxTestExample.swift](/Examples/Tests/ExampleTests/RxTestExample.swift): A more real-world-ish example. Test a view model, with RxSwift and RxTest.
- [QuickExample.swift](/Examples/Tests/ExampleTests/QuickExample.swift): An example to show Tablier works in a QuickSpec with no hassle.

## License

MIT. See LICENSE.

Tablier

Tablier Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Tablier

Tablier Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README