Unit tests

This optional guide describes how to implement some unit tests that will verify whether your app delegate correctly follows the steps described in our push integration instructions.

If all the tests pass, generally, this means the code-based part of your push setup is functional. If a test fails, this might mean that you incorrectly followed a step, or it may result from a valid customization that doesn’t align precisely with our default instructions.

Either way, this can be a helpful approach to verify you’ve followed the integration steps and to help monitor for any regressions.

Step 1: Creating a unit tests target

Skip this step if your app project in Xcode already contains a Unit Testing Bundle.

In your app project, go to menu File > New > Target and add a new “Unit Testing Bundle”. This bundle can use either Objective-C or Swift and have any name. Set the “Target to be Tested” to your main app target.

Step 2: Add the Braze SDK to your unit tests

Using the same method you used initially to install the Braze SDK, make sure the same SDK installation is also available to your unit tests target. For example, using CocoaPods:

1
2
3
4
5
6
7
target 'YourAppTarget' do
  pod 'Appboy-iOS-SDK'

  target 'YourAppTargetTests' do
    inherit! :search_paths
  end
end

Step 3: Add OCMock to your unit tests

Add OCMock to your test target via CocoaPods, Carthage, or its static library. For example, using CocoaPods:

1
2
3
4
5
6
7
8
target 'YourAppTarget' do
  pod 'Appboy-iOS-SDK'

  target 'YourAppTargetTests' do
    inherit! :search_paths
    pod 'OCMock'
  end
end

Step 4: Finish installing the added libraries

Finish installing the Braze SDK and OCMock. For example, using CocoaPods, navigate to the directory of your Xcode app project within your terminal and run the following command:

1
pod install

At this point, you should be able to open the Xcode project workspace created by CocoaPods.

Step 5: Adding push tests

Create a new Objective-C file in your unit tests target.

If the unit tests target is in Swift, Xcode may ask, “Would you like to configure an Objective-C bridging header?” The bridging header is optional, so you can click Don’t Create and still run these unit tests successfully.

Add the contents of the HelloSwift sample app’s AppboyPushUnitTests.m to the new file.

Step 6: Run test suite

Run your app’s unit tests. This can be a one-time verification step, or you can include this indefinitely in your test suite to help catch any regressions.