Discussion

- (void)testPerformanceOfMyFunction {

        [self measureBlock:^{
        // Do that thing you want to measure.
        MyFunction();
    }];
}

• @param block A block whose performance to measure.

Discussion

- (void)testMyFunction2_WallClockTime {
    [self measureMetrics:[[self class] defaultPerformanceMetrics] automaticallyStartMeasuring:NO forBlock:^{

        // Do setup work that needs to be done for every iteration but you don't want to measure before the call to -startMeasuring
        SetupSomething();
        [self startMeasuring];

        // Do that thing you want to measure.
        MyFunction();
        [self stopMeasuring];

        // Do teardown work that needs to be done for every iteration but you don't want to measure after the call to stopMeasuring
        TeardownSomething();
    }];
}

• Caveats:
• • If YES was passed for automaticallyStartMeasuring and startMeasuring is called
• anyway, the test will fail.
• • If NO was passed for automaticallyStartMeasuring then startMeasuring must be
• called once and only once before the end of the block or the test will fail.
• • If stopMeasuring is called multiple times during the block the test will fail. *
• @param metrics An array of NSStrings (XCTPerformanceMetrics) to measure. Providing an unrecognized string is a test failure. *
• @param automaticallyStartMeasuring If NO, XCTestCase will not take any measurements until startMeasuring is called. *
• @param block A block whose performance to measure.

Discussion

@param description This string will be displayed in the test log to help diagnose failures.

@discussion Creates and returns an expectation associated with the test case.

Discussion

@param timeout The amount of time within which all expectations must be fulfilled.

@param handler If provided, the handler will be invoked both on timeout or fulfillment of all expectations. Timeout is always treated as a test failure.

@discussion -waitForExpectationsWithTimeout:handler: creates a point of synchronization in the flow of a test. Only one -waitForExpectationsWithTimeout:handler: can be active at any given time, but multiple discrete sequences of { expectations -> wait } can be chained together.

-waitForExpectationsWithTimeout:handler: runs the run loop while handling events until all expectations are fulfilled or the timeout is reached. Clients should not manipulate the run loop while using this API.

Discussion

@discussion A convenience method for asynchronous tests that use Key Value Observing to detect changes to values on an object. This variant takes an expected value and observes changes on the object until the keyPath’s value matches the expected value using [NSObject isEqual:]. If other comparisions are needed, use the variant below that takes a handler block.

@param objectToObserve The object to observe.

@param keyPath The key path to observe.

@param expectedValue Expected value of the keyPath for the object. The expectation will fulfill itself when the keyPath is equal, as tested using [NSObject isEqual:]. If nil, the expectation will be fulfilled by the first change to the key path of the observed object.

@return Creates and returns an expectation associated with the test case.

Discussion

@discussion Variant of the convenience for tests that use Key Value Observing. Takes a handler block instead of an expected value. Every KVO change will run the handler block until it returns YES (or the wait times out). Returning YES from the block will fulfill the expectation. XCTAssert and related APIs can be used in the block to report a failure.

@param objectToObserve The object to observe.

@param keyPath The key path to observe.

@param handler Optional handler, /see XCKeyValueObservingExpectationHandler. If not provided, the expectation will be fulfilled by the first change to the key path of the observed object.

@return Creates and returns an expectation associated with the test case.

Discussion

@discussion A convenience method for asynchronous tests that observe NSNotifications.

@param notificationName The notification to register for.

@param objectToObserve The object to observe.

@param handler Optional handler, /see XCNotificationExpectationHandler. If not provided, the expectation will be fulfilled by the first notification matching the specified name from the observed object.

@return Creates and returns an expectation associated with the test case.