JPSimulatorHacks

Description

Hack the Simulator in your tests (grant access to photos, contacts, calendar ...).

Did you ever have the problem that your code was wrapping the AddressBook, the EventKit or the ALAssetsLibrary APIs? Running tests can be annoying then. There's this UIAlertView asking the user to grant access to the contacts and photos, which blocks and breaks your tests. Using JPSimulatorHacks you can easily grant this access before running your tests.

If you encounter any problems, please check out the caveats documented below.

Installation

Install JPSimulatorHacks with Cocoapods

pod 'JPSimulatorHacks'

Usage

AddressBook

#import <JPSimulatorHacks/JPSimulatorHacks.h>

@implementation MyAppTests

+ (void)setUp
{
    [super setUp];
    [JPSimulatorHacks grantAccessToAddressBook];
}

@end

This will grant access to the addressbook for the current bundle identifier. There's also an API to specify the bundle identifier, if necessary:

+ (BOOL)grantAccessToAddressBookForBundleIdentifier:(NSString *)bundleIdentifier;

Keyboard

#import <JPSimulatorHacks/JPSimulatorHacks.h>

@implementation MyAppTests

+ (void)setUp
{
    [super setUp];
    [JPSimulatorHacks setDefaultKeyboard:@"en_US@hw=US;sw=QWERTY"];
    [JPSimulatorHacks disableKeyboardHelpers];
}

@end

This will disable all the auto correction helpers and set the keyboard to the default English one.

Note: Unfortunately this only works on iOS Simulator < 8.x. Even if you manually disable the autocorrection feature in the Settings.app in your simulator, it still does apply the autocorrection to the entered text. I consider this a bug in the simulator, so there's not much we can do about it.

Photos

#import <JPSimulatorHacks/JPSimulatorHacks.h>

@implementation MyAppTests

+ (void)setUp
{
    [super setUp];
    [JPSimulatorHacks grantAccessToPhotos];
}

@end

This will grant access to the photos library for the current bundle identifier. There's also an API to specify the bundle identifier, if necessary:

+ (BOOL)grantAccessToPhotosForBundleIdentifier:(NSString *)bundleIdentifier;

You can also add some test images from a given URL. The method will block until the Asset has been stored. This is helpful so your tests will only start after the Asset is available.

[JPSimulatorHacks grantAccessToPhotos];
NSURL *assetURL = [NSURL URLWithString:@"https://raw.githubusercontent.com/plu/JPSimulatorHacks/master/Data/test.png"];
ALAsset *asset = [JPSimulatorHacks addAssetWithURL:assetURL];

Calendar

#import <JPSimulatorHacks/JPSimulatorHacks.h>

@implementation MyAppTests

+ (void)setUp
{
    [super setUp];
    [JPSimulatorHacks grantAccessToCalendar];
}

@end

This will grant access to the calendar for the current bundle identifier. There's also an API to specify the bundle identifier, if necessary:

+ (BOOL)grantAccessToCalendadrForBundleIdentifier:(NSString *)bundleIdentifier;

Timeout

By default it tries to write the necessary entries to the TCC.db within 15 seconds. If that's not enough time, it just gives up and returns NO from the methods. If for any reason that is not enough time, you can change this default timeout via:

+ (void)setUp
{
    [super setUp];
    [JPSimulatorHacks setTimeout:30.0f];
}

Caveats

JPSimulatorHacks only works if unit test suite is run against real application target: Its Host Application is not set to None! See also: http://stackoverflow.com/a/28135995/598057
When using Xcode bots, sometimes the tests run into an timeout.
The method disableKeyboardHelpers only works on iOS < 8.x.

License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

robtimp / jpsimulatorhacks Goto Github PK