InstallingQuick.md

Installing Quick

Before starting, check here which versions of Quick and Nimble are compatible with your version of Swift.

Quick provides the syntax to define examples and example groups. Nimble provides the expect(...).to assertion syntax. You may use either one, or both, in your tests.

There are three recommended ways of linking Quick to your tests:

1. Git Submodules
2. CocoaPods
3. Carthage
4. Swift Package Manager

Choose one and follow the instructions below. Once you've completed them, you should be able to import Quick from within files in your test target.

Git Submodules

To link Quick and Nimble using Git submodules:

1. Add submodule for Quick.
2. If you don't already have a .xcworkspace for your project, create one. (Here's how)
3. Add Quick.xcodeproj to your project's .xcworkspace.
4. Add Nimble.xcodeproj to your project's .xcworkspace. It exists in path/to/Quick/Externals/Nimble. By adding Nimble from Quick's dependencies (as opposed to adding directly as a submodule), you'll ensure that you're using the correct version of Nimble for whatever version of Quick you're using.
5. Link Quick.framework and Nimble.framework in your test target's "Link Binary with Libraries" build phase.

First, if you don't already have one, create a directory for your Git submodules. Let's assume you have a directory named Vendor.

Step One: Download Quick and Nimble as Git submodules:

git submodule add [email protected]:Quick/Quick.git Vendor/Quick
git submodule add [email protected]:Quick/Nimble.git Vendor/Nimble
git submodule update --init --recursive

Step Two: Add the Quick.xcodeproj and Nimble.xcodeproj files downloaded above to your project's .xcworkspace. For example, this is Guanaco.xcworkspace, the workspace for a project that is tested using Quick and Nimble:

Step Three: Link the Quick.framework during your test target's Link Binary with Libraries build phase. You should see only one Quick.framework, this supports all platforms Quick supports.

Do the same for the Nimble.framework, and you're done!

Updating the Submodules: If you ever want to update the Quick or Nimble submodules to latest version, enter the Quick directory and pull from the main repository:

cd /path/to/your/project/Vendor/Quick
git checkout main
git pull --rebase origin main

Your Git repository will track changes to submodules. You'll want to commit the fact that you've updated the Quick submodule:

cd /path/to/your/project
git commit -m "Updated Quick submodule"

Cloning a Repository that Includes a Quick Submodule: After other people clone your repository, they'll have to pull down the submodules as well. They can do so by running the git submodule update command:

git submodule update --init --recursive

You can read more about Git submodules here.

CocoaPods

First, update CocoaPods to Version 0.36.0 or newer, which is necessary to install CocoaPods using Swift.

Then, add Quick and Nimble to your Podfile. Additionally, the use_frameworks! line is necessary for using Swift in CocoaPods:

# Podfile

use_frameworks!

def testing_pods
    pod 'Quick'
    pod 'Nimble'
end

target 'MyTests' do
    testing_pods
end

target 'MyUITests' do
    testing_pods
end

Finally, download and link Quick and Nimble to your tests:

pod install

Carthage

As test targets do not have the "Embedded Binaries" section, the frameworks must be added to the target's "Link Binary With Libraries" as well as a "Copy Files" build phase to copy them to the target's Frameworks destination.

As Carthage builds dynamic frameworks, you will need a valid code signing identity set up.

1. Add Quick to your Cartfile.private:

   github "Quick/Quick"
   github "Quick/Nimble"
   

2. Run carthage update.

3. From your Carthage/Build/[platform]/ directory, add both Quick and Nimble to your test target's "Link Binary With Libraries" build phase:

4. For your test target, create a new build phase of type "Copy Files":

5. Set the "Destination" to "Frameworks", then add both frameworks:

This is not "the one and only way" to use Carthage to manage dependencies. For further reference check out the Carthage documentation.

Swift Package Manager

With the advent of the swift.org open-source project, Swift now has an official package manager tool. Notably, this provides the possibility of using Quick on non-Apple platforms for the first time. You can use Swift Package Manager either by using it's integration with Xcode, or by editing your package's Package.swift file.

Xcode Integration

To install Quick via XCode's Swift Package Manager integration, select your .xcodeproj file, then the project tab, then the Package Dependencies tab. Click on the "plus" button at the bottom of the list, then follow the wizard to add Quick to your project. Specify https://github.com/Quick/Quick.git as the url, and be sure to add Quick as a dependency of your unit test target, not your app target.

Package.swift

Add Quick's github url as a dependency of your package, then as a dependency of your test target, like so:

// swift-tools-version:5.5

import PackageDescription

let package = Package(
    name: "MyPackage",
    products: [
    	.library(name: "MyPackage", targets: ["MyPackage"])
    ],
    dependencies: [
        .package(url: "https://github.com/Quick/Quick.git", from: "7.0.0"),
        .package(url: "https://github.com/Quick/Nimble.git", from: "12.0.0"),
    ]
    targets: [
    	.target(name: "MyPackage", dependencies: []),
    	.testTarget(name: "MyPackageTests", dependencies: ["Quick", "Nimble"])
    ]
)

Linux Support

On Linux, you will need to also add a LinuxMain.swift at the root of the Tests subdirectory. This needs to contain a main struct that calls out to QCKMain, like so:

import XCTest
import Quick

@testable import MyPackageTests

@main struct Main {
    static func main() {
        QCKMain(
            [], // list of `QuickSpec` subclasses. to pass in.
            configuration: [], // Optional, list of QuickConfiguration subclasses to pass in. Defaults to empty array.
            testCases: [] // Optional, list of XCTestCase subclasses to pass in. Defaults to empty array.
        )
    }
}

(Not Recommended) Running Quick Specs on a Physical iOS Device

In order to run specs written in Quick on device, you need to add Quick.framework and Nimble.framework as Embedded Binaries to the Host Application of the test target. After adding a framework as an embedded binary, Xcode will automatically link the host app against the framework.