Example

Example

Examples, defined with the it function, use assertions to demonstrate how code should behave. These are like "tests" in XCTest.

final public class Example: _ExampleBase

Inheritance

_ExampleBase, _ExampleBase

Properties

isSharedExample

A boolean indicating whether the example is a shared example; i.e.:​ whether it is an example defined with itBehavesLike.

var isSharedExample = false

callsite

The site at which the example is defined. This must be set correctly in order for Xcode to highlight the correct line in red when reporting a failure.

var callsite: Callsite

description

var description: String

name

The example name. A name is a concatenation of the name of the example group the example belongs to, followed by the description of the example itself.

var name: String

The example name is used to generate a test method selector to be displayed in Xcode's test navigator.

Methods

run()

Executes the example closure, as well as all before and after closures defined in the its surrounding example groups.

public func run()

==(lhs:rhs:)

Returns a boolean indicating whether two Example objects are equal. If two examples are defined at the exact same callsite, they must be equal.

@nonobjc public static func ==(lhs: Example, rhs: Example) -> Bool