• Stars
    star
    122
  • Rank 292,031 (Top 6 %)
  • Language
    Swift
  • License
    Other
  • Created almost 5 years ago
  • Updated over 4 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

🎏 Function builder BDD testing framework in Swift

Spek

❤️ Support my app ❤️

❤️❤️😇😍🤘❤️❤️

Spek is a lightweight function builder style Behavior Driven Development framework, designed to be used with XCTest

Usage

⚠️Before using any test frameworks, you need to ensure there is XCTest framework in your test target.

import XCTest
@testable import Spek

final class SpekTests: XCTestCase {
    func testExample() {
        var left = 1
        var right = 1

        spec {
            Describe("math") {
                BeforeEach {
                    left = 2
                }

                Describe("basic") {
                    BeforeEach {
                        right = 3
                    }

                    AfterEach {

                    }

                    It("adds correctly") {
                        XCTAssertEqual(left + right, 5)
                    }

                    It("multiplies correctly") {
                        XCTAssertEqual(left * right, 6)
                    }
                }
            }
        }
    }
}

Features

  • Support common BDD parts: Describe, Context, BeforeAll, AfterAll, BeforeEach, AfterEach, It
  • To disable a part, prefix it with X, for example XDescribe, XIt, ...
  • All blocks are throwing function, so are encouraged to do try catch
  • BeforeAll and AfterAll are run before and after all enclosing Describe and It
  • BeforeEach and AfterEach are run before and after all enclosing It
  • Context behaves the same as Describe

How to

Disable a block

When you have an imcomplete block, instead of commenting it out, you can prefix it with X so it won't be executed

Describe("math") {
    It("will be run") {

    }

    XIt("won't be run") {

    }
}

Declare local variables

Spek uses Swift 5.1 function builder so you can only declare block and nested block. To declare local variables in a subspec, you need to use Sub and return Describe explicitly

Describe("math") {
    Describe("advanced") {

    }

    Sub {
        let abc = 1
        let def = 2
        return Describe("extra") {
            It("should add") {
                XCTAssertEqual(abc + def, 2)
            }
        }
    }
}

Generate XCTestCase

By default, spec method runs the test directly, to generate test cases, you need to override makeDescribe.

Subclass SpekTestCase and override makeDescribe method, Spek will convert your Describe descriptions and generate XCTestCase methods. It generates test methods for nested Describe and Sub too.

For example the below test will generate test_math_should_work and test_math_advanced_should_calculate methods

import XCTest
import Spek

class GenerateTestCaseTests: SpekTestCase {
    override class func describe() -> Describe {
        Describe("math") {
            It("should work") {
                XCTAssertTrue(1 + 1 == 2)
            }

            Describe("advanced") {
                It("should calculate") {
                    XCTAssertEqual(2 * 5, 10)
                }
            }
        }
    }
}

Install

Spek is distributed using the Swift Package Manager. To install it into a project, add it as a dependency within your Package.swift manifest:

let package = Package(
    ...
    dependencies: [
        .package(url: "https://github.com/onmyway133/Spek.git", from: "0.5.0")
    ],
    ...
)

Then import Spek in your XCTest

import Spek

Author

Khoa Pham, [email protected]

Credit

  • Quick for testInvocations reference

License

Spek is available under the MIT license. See the LICENSE file for more info.

More Repositories

1

awesome-ios-animation

☔ A collection of iOS animation repos
5,305
star
2

awesome-ios-architecture

🏯 Better ways to structure iOS apps
5,056
star
3

PushNotifications

🐉 A macOS, Linux, Windows app to test push notifications on iOS and Android
JavaScript
2,230
star
4

DeepDiff

🦀Amazingly incredible extraordinary lightning fast diffing in Swift
Swift
2,049
star
5

IconGenerator

🍱 A macOS app to generate app icons
JavaScript
1,403
star
6

RoughSwift

🎃 Create hand-drawn, sketchy, comic shape in Swift
Swift
1,104
star
7

FinderGo

🐢 Open terminal quickly from Finder
Swift
1,084
star
8

Snowflake

❄️ SVG in Swift
Swift
956
star
9

GifCapture

🏇 Gif capture app for macOS
Swift
916
star
10

awesome-machine-learning

🎰 A curated list of machine learning resources, preferably CoreML
794
star
11

Swiftlane

🚀 Build utilities in pure Swift
Swift
692
star
12

blog

🍁 What you don't know is what you haven't learned
666
star
13

awesome-swiftui

🌮 Awesome resources, articles, libraries about SwiftUI
642
star
14

EasyConfetti

🎊 Fancy confetti effects in Swift
Swift
561
star
15

XcodeWay

⛵ An Xcode Source Editor Extension that helps navigating to many places easier
Swift
550
star
16

Smile

😄 Emoji in Swift
Swift
512
star
17

EasyAnchor

⚓️ Declarative, extensible, powerful Auto Layout
Swift
455
star
18

EasyStash

🗳Easy data persistence in Swift
Swift
377
star
19

Scale

🎏 Unit converter in Swift
Swift
323
star
20

EasyDropdown

💧 Fantastic dropdown in Swift
Swift
309
star
21

XcodeColorSense2

🍉 An Xcode source editor extension that shows hex color info
Swift
285
star
22

Arcane

🔱 CommonCrypto in Swift, and more
Swift
283
star
23

awesome-android-animation

💦 A collection of Android animation repos
Java
253
star
24

EasyTheme

👕👚 Theme management in Swift
Swift
241
star
25

awesome-voip

🤙Learning VoIP, RTP, pjsip and SIP
237
star
26

SwiftHash

🍕 MD5 in pure Swift
Swift
215
star
27

EasyClosure

🍩 Unified communication patterns with easy closure in Swift
Swift
201
star
28

Github.swift

:octocat: Unofficial GitHub API client in Swift
Swift
186
star
29

emoji

❤️ List of emojis
Swift
163
star
30

SwiftSnippets

🍮 A collection of Swift snippets to be used in Xcode
Shell
162
star
31

Wave

🌊 Declarative chainable animations in Swift
Swift
127
star
32

awesome-online-earning

💰Ways to earn extra
124
star
33

FontAwesomeSwiftUI

Easy to use FontAwesome 5 in SwiftUI
Swift
97
star
34

Recipes

🍣Making Recipes iOS app
Swift
91
star
35

MathSolver

⌨️Camera calculator with Vision
Swift
87
star
36

XcodeColorSense

🎈 An Xcode plugin that makes working with color easier
Swift
77
star
37

Micro

🏎Fast diffing and type safe SwiftUI style data source for UICollectionView
Swift
76
star
38

Omnia

🗿 Everything your projects need to know
Swift
62
star
39

notes

📔 Issues and solutions I found during development, mostly iOS
62
star
40

Sketch-Action

🔎 A Sketch plugin to simulate Spotlight
Objective-C
59
star
41

MainThreadGuard

💂‍♂️ Tracking UIKit access on main thread
Swift
58
star
42

EasyFake

🤹‍♀️ Fake data generation in Swift
JavaScript
57
star
43

Reindeers

❄️ XML and HTML parser in Swift
Swift
55
star
44

awesome-git-commands

🍴 Indispensable git commands for everyday use
55
star
45

RxLifeCycle

🐹 Easy life cycle observation
Swift
53
star
46

Upstream

⛲️ Adapted Data Source in Swift and a little bit more
Swift
53
star
47

BigBigNumbers

🔢Say the number out loud
Swift
49
star
48

GifMagic

💈 Gif maker and extractor in Swift
Swift
48
star
49

awesome-android-architecture

🏰 Better ways to structure Android apps
45
star
50

AppStoreConnect

🍎 Interact with AppStoreConnect
Swift
45
star
51

TestTarget

🐳 Notes on configuring test targets
Swift
44
star
52

PhotoFeed

🛵 Instagram in Swift 4
Swift
43
star
53

awesome-conference-videos

🎸 Conference videos. Visit http://learntalks.com/
40
star
54

CollectionUpdateExample

🛶 Demo batch update in UITableView and UICollectionView
Swift
38
star
55

Construction

👷 The many ways to construct and configure your entity
Swift
34
star
56

PastePal

PastePal is the best universal clipboard manager for Mac, iPhone and iPad.
31
star
57

github-extended

:octocat: A Chrome extension to discover more repositories
JavaScript
30
star
58

EasyNetworking

🛰Easy networking with async/await
Swift
28
star
59

Runtime-Headers

💿 iOS, macOS runtime headers
Objective-C
28
star
60

UsingPlayground

👶 Demo how to use Playground
Swift
26
star
61

EasySwiftUI

🍰 Extra sugar for SwiftUI
Swift
25
star
62

Farge

🎈Tell the name of hex color
Swift
24
star
63

Avengers

👾Demo how to use CoreML with IBM Watson, Azure Custom Vision, Turi Create
Swift
21
star
64

ISO8601

🎗 Super lightweight ISO8601 Date Formatter in Swift
Swift
21
star
65

SlidingMenu

🎿 Demo how to create sliding menu on Android
Java
20
star
66

Paramount

🗼 Like Flipboard FLEX, but allows custom action
Swift
20
star
67

Codelime

Codelime is a powerful code snippet manager with many dev tools for iOS development.
19
star
68

DynamicTableViewCellHeight

🍟 Demo how to use Autolayout to make varying row height
Objective-C
18
star
69

github-chat

💬 A Chrome extension to enable chat within GitHub
JavaScript
18
star
70

Resolver

🎊 A simple resolver in Swift
Swift
15
star
71

archives

🚣 Only deliberate practice will make you better
Objective-C
14
star
72

ParticlePlayground

🎊 A Swift playground to play with CAEmitterLayer
Swift
14
star
73

json_resolve

🐰Easy resolving deep json using keypath in Dart
Dart
12
star
74

Then

🏃 Promise A+ in Swift
Swift
11
star
75

LighterAppDelegate

🎣 Lighter AppDelegate by dispatching events
Swift
10
star
76

Xkcd

🦄 Simple Xkcd iOS app
Swift
8
star
77

Border

📐 Make border for all views
Swift
8
star
78

Xmas

🎅 🎄 ⛄ Xmas plugin for Xcode
Objective-C
7
star
79

github-changelogs-maker

🍻 Generate changelogs between 2 latest releases
JavaScript
7
star
80

linphone-iphone

Forked from linphone.org
Objective-C
7
star
81

EasyTracker

🕵️ Trackers in Swift
Swift
6
star
82

FantasticDisplay

🎢 Fantastic HUD and toast in Swift
Swift
6
star
83

ComputerScienceSwift

👨‍💻 Practice computer science in Swift
Swift
6
star
84

PushHero

Push Hero is a native macOS application written in pure Swift that allows us to easily test push notifications
6
star
85

onmyway133

What you don't know is what you haven't learned
5
star
86

Minion

🐝 Working with Xcode plugins
Swift
5
star
87

SketchHeaders

💿 Headers from Sketch
Objective-C
4
star
88

homebrew-formulae

🚗 Homebrew formulae
Ruby
3
star
89

chat_webrtc

⌨️ Simple chat application using Node.js and WebRTC Data Channel
JavaScript
3
star
90

DarkSide

🌌 My dark theme based on Atom One Dark
Shell
3
star
91

android-architecture-components-kotlin

🥋 Samples for Android Architecture Components in Kotlin
Kotlin
2
star
92

slackbot-yoda

💍 Slackbot Yoda
JavaScript
2
star
93

onmyway133.github.io

Showcase
HTML
2
star
94

traffic_simulator

🚗 Traffic simulator using enchant.js
JavaScript
2
star
95

rtpproxy

🥂 Forked from http://www.rtpproxy.org/ with IP handover support
C
2
star
96

Shipmunk

Search, bookmark and track keyword rating for your favorite apps
2
star
97

Dust

🚀 Unofficial, simple push notification
Swift
1
star
98

MarqueeTextBlock

🌴 How to make marquee TextBlock on Windows Phone
C#
1
star