Configuration

Configuration

A configuration encapsulates various options you can use to configure Quick's behavior.

final public class Configuration: NSObject

Inheritance

NSObject

Properties

runAllWhenEverythingFiltered

Run all examples if none match the configured filters. True by default.

var runAllWhenEverythingFiltered = true

Methods

include(_:)

Registers an inclusion filter.

public func include(_ filter: @escaping ExampleFilter)

All examples are filtered using all inclusion filters. The remaining examples are run. If no examples remain, all examples are run.

Parameters

• filter: A filter that, given an example, returns a value indicating whether that example should be included in the examples that are run.

exclude(_:)

Registers an exclusion filter.

public func exclude(_ filter: @escaping ExampleFilter)

All examples that remain after being filtered by the inclusion filters are then filtered via all exclusion filters.

Parameters

• filter: A filter that, given an example, returns a value indicating whether that example should be excluded from the examples that are run.

beforeEach(_:)

canImport(Darwin)

@objc(beforeEachWithMetadata) public func beforeEach(_ closure: @escaping BeforeExampleWithMetadataClosure)

beforeEach(_:)

!((canImport(Darwin)))

public func beforeEach(_ closure: @escaping BeforeExampleWithMetadataClosure)

beforeEach(_:)

Like Quick.DSL.beforeEach, this configures Quick to execute the given closure before each example that is run. The closure passed to this method is executed before each example Quick runs, globally across the test suite. You may call this method multiple times across multiple +[QuickConfigure configure:​] methods in order to define several closures to run before each example.

public func beforeEach(_ closure: @escaping BeforeExampleClosure)

Note that, since Quick makes no guarantee as to the order in which +[QuickConfiguration configure:] methods are evaluated, there is no guarantee as to the order in which beforeEach closures are evaluated either. Multiple beforeEach defined on a single configuration, however, will be executed in the order they're defined.

Parameters

• closure: The closure to be executed before each example in the test suite.

afterEach(_:)

canImport(Darwin)

@objc(afterEachWithMetadata) public func afterEach(_ closure: @escaping AfterExampleWithMetadataClosure)

afterEach(_:)

!((canImport(Darwin)))

public func afterEach(_ closure: @escaping AfterExampleWithMetadataClosure)

afterEach(_:)

Like Quick.DSL.afterEach, this configures Quick to execute the given closure after each example that is run. The closure passed to this method is executed after each example Quick runs, globally across the test suite. You may call this method multiple times across multiple +[QuickConfigure configure:​] methods in order to define several closures to run after each example.

public func afterEach(_ closure: @escaping AfterExampleClosure)

Note that, since Quick makes no guarantee as to the order in which +[QuickConfiguration configure:] methods are evaluated, there is no guarantee as to the order in which afterEach closures are evaluated either. Multiple afterEach defined on a single configuration, however, will be executed in the order they're defined.

Parameters

• closure: The closure to be executed before each example in the test suite.

beforeSuite(_:)

Like Quick.DSL.beforeSuite, this configures Quick to execute the given closure prior to any and all examples that are run. The two methods are functionally equivalent.

public func beforeSuite(_ closure: @escaping BeforeSuiteClosure)

afterSuite(_:)

Like Quick.DSL.afterSuite, this configures Quick to execute the given closure after all examples have been run. The two methods are functionally equivalent.

public func afterSuite(_ closure: @escaping AfterSuiteClosure)