Code Monkey home page Code Monkey logo

xctestbeauty's Introduction

XCTestBeauty

XCTestBeauty is a Swift library that provides a set of convenient wrappers for XCTContext.runActivity(). These wrappers help improve the readability of your XCTest cases by allowing you to use "GIVEN," "AND," "WHEN," and "THEN" prefixes for the descriptions of your test activities.

Installation

You can install XCTestBeauty using CocoaPods. Add the following line to your Podfile:

pod 'XCTestBeauty'

Then, run the following command:

pod install

Usage

Import XCTestBeauty

import XCTestBeauty

Example Usage

class YourTestCase: XCTestCase, XCTestBeauty {
    func testExample() {
        given("a precondition") {
            // Your setup code here
        }

        and("an additional condition") {
            // Additional setup code
        }

        when("performing an action") {
            // Your action code here
        }

        then("the expected result should be achieved") {
            // Your assertion code here
        }
    }
}

API Documentation

given, and, when, then These functions are wrappers for XCTContext.runActivity() and provide a more descriptive structure for your test cases. They take a description and a closure with the test activity.

func given<Result>(_ description: String, _ block: () throws -> Result) rethrows -> Result
func given<Result>(_ description: String, _ block: (XCTActivity) throws -> Result) rethrows -> Result

func and<Result>(_ description: String, _ block: () throws -> Result) rethrows -> Result
func and<Result>(_ description: String, _ block: (XCTActivity) throws -> Result) rethrows -> Result

func when<Result>(_ description: String, _ block: () throws -> Result) rethrows -> Result
func when<Result>(_ description: String, _ block: (XCTActivity) throws -> Result) rethrows -> Result

func then<Result>(_ description: String, _ block: () throws -> Result) rethrows -> Result
func then<Result>(_ description: String, _ block: (XCTActivity) throws -> Result) rethrows -> Result

Contributing

If you find any issues or have suggestions for improvements, feel free to open an issue or submit a pull request.

License

This library is released under the MIT License. See LICENSE for details.

xctestbeauty's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.