SGNLA/CrashProbe

Introduction

CrashProbe provides a set of test crashes that can be used to test crash reporting SDKs and symbolication implementations on iOS and OS X.

The project has been developed using Xcode 5.1.1 and has been tested with OS X 10.9.2 and iOS 7.1.1.

Setup

Clone this repository.
Open the project in Xcode.
Integrate your crash reporting SDK into the required platform target (CrashProbe for OS X and CrashProbeiOS for iOS).
Build the app using the Release build configuration and install it on a device.

Either use Archive or Build for Profiling and copy the app bundle onto the device. Using Debug build configuration will result in different results due to disabled compiler optimizations.
Start the app without the debugger being attached.
Choose a crash and trigger it.
Start the app again, the integrated SDK should now upload the crash report to its server.
Go back to step 5. and process the next crash. Otherwise continue with step 9.
Symbolicate the crash report(s).
Compare the symbolicated crash report(s) with the data available on the CrashProbe website.

Tool Implementations

HockeyApp: Default version: 4.1.6 , Official tutorial website

Make sure you have HockeyApp SDK, the default one is inside the CrashProbe/Vender/HockeyApp-SDK-iOS-4.1.6
Make sure the Project Navigator in xcode is visible (⌘+1).
Drag the HockeySDK.embeddedframework/HockeySDK.framework from Finder to the Vendor/HockeyApp in Project Navigator.
Set the checkmark for your target, in this case, the CrashProbeiOS.
Open the CrashProbe/CrashProbe iOS/CRLAppDelegate.m file.
Uncomment the define HOCKEY_APP in line 29.
Update the APP_ID in line 53.
Update Bundle Identifier for CrashProbeiOS.
Build ipa and start test.

MobileCenter: Default version: 0.11.2 , Official tutorial website

Make sure you have MobileCenter SDK, the default one is inside the CrashProbe/Vender/MobileCenter-SDK-iOS-0.11.2
Make sure the Project Navigator in xcode is visible (⌘+1).
Drag the MobileCenter.framework, MobileCenterAnalytics.framework, and MobileCenterCrashes.framework from Finder to the Vendor/MobileCenter in Project Navigator.
Set the checkmark for your target, in this case, the CrashProbeiOS.
Open the CrashProbe/CrashProbe iOS/CRLAppDelegate.m file.
Uncomment the define MOBILE_CENTER in line 30.
Update the APP_SECRET in line 60.
Build ipa and start test.

Crashlytics: Default version: 3.8.5 , Official tutorial website

Make sure you have HockeyApp SDK, the default one is inside the CrashProbe/Vender/Crashlytics-SDK-iOS-3.8.5
Make sure the Project Navigator in xcode is visible (⌘+1).
Drag the Crashlytics.framework and Fabric.framework from Finder to the Vendor/Crashlytics in Project Navigator.
Set the checkmark for your target, in this case, the CrashProbeiOS.
Open the CrashProbe/CrashProbe iOS/CRLAppDelegate.m file.
Uncomment the define CRASHLYTICS in line 31.
Click CrashProbe in Project Navigator and select CrashProbeiOS in TARGETS.
Select Build Phrases and add a New Run Build Phase.
Add following sentence into Shell:

"${PROJECT_DIR}/Vendor/Crashlytics/Fabric.framework/run" API_KEY BUILD_SECRET

Update API_KEY and BUILD_SECRET.
Add following setting into CrashProbe/CrashProbe iOS/Supporting Files/CrashProbe iOS-Info.plist

<key>Fabric</key>
<dict>
    <key>APIKey</key>
    <string>API_KEY</string>
    <key>Kits</key>
    <array>
        <dict>
            <key>KitInfo</key>
            <dict/>
            <key>KitName</key>
            <string>Crashlytics</string>
        </dict>
    </array>
</dict>

Update API_KEY
Update Bundle Identifier for CrashProbeiOS.
Build ipa and start test.

Disclaimer

The suite of tests was developed by Bit Stadium GmbH for the HockeyApp service.

Contributing

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Contributor License

You must sign a Contributor License Agreement before submitting your pull request. To complete the Contributor License Agreement (CLA), you will need to submit a request via the form and then electronically sign the CLA when you receive the email containing the link to the document. You need to sign the CLA only once to cover submission to any Microsoft OSS project.

License

This project is released under the MIT license.

SGNLA / CrashProbe