Apptimize QA Console for iOS

For more information see the QA Console FAQ page.

Introduction

The Apptimize QA console is a framework that can be integrated into your mobile app. It enables you to preview variants in different combinations from all of your active feature flags and experiments on a simulator or device. This approach of QA works well for customers with large teams that would like to test hands-on while using the app. Integrating the QA console is a simple one-time process. Once the console is in place, it works by overriding your allocations and forcing your selected variants internally.

Note

The QA console is only intended to be integrated into debug/developer-build versions of your app and should not be included in releases to your end-users.

Adding the Framework to your Application

Swift Package

Refer to the official documenation at Adding Package Dependencies to Your App for detailed instructions.

1. Create or open an iOS Application project.
2. Click File —> Add Packages and search for the package URL https://github.com/urbanairship/apptimize-qa-console-ios.
3. Specify the version (or use the main branch) and click Add Package.

CocoaPods

Refer to CocoaPod’s Getting Started Guide for detailed instructions.

1. Add the following to your Podfile to import ApptimizeQAConsole as a dependency.

   pod 'ApptimizeQAConsole'
   

2. Save your Podfile.

3. And then run the following from the command line in your application's directory.

   pod install
   

Integrating in your Application

1. Add the package (see Adding the Framework to your Application).

2. Open the source for the UIApplicationDelegate.

3. Add the following import.

   import ApptimizeQAConsole
   

4. Add the following to your didFinishLaunchingWithOptions method.

   func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    	// ...other application setup code ...
   
      // Use the shake gesture.
      ApptimizeQAConsole.isShakeGestureEnabled = true
   
      // ...or disable the shake gesture and use manual presentation only.
      ApptimizeQAConsole.isShakeGestureEnabled = false
      return true
   }
   

5. Open the Apptimize dashboard, create and then launch your experiment(s).

6. Run your app on a device/emulator.

7. If you are running on device, shake the device to launch the Apptimize QA Console.

8. Alternatively, you can launch the Apptimize QA Console programmatically

   ApptimizeQAConsole.display()
   

Notes

• In order to display Instant Updates while using the QA console to force specific variants, you will need to add the ApptimizeForceVariantsShowWinnersAndInstantUpdates Boolean value to your Info.plist with the value set to YES (or if you call Apptimize.start(withApplicationKey:options:) you should add the ApptimizeForceVariantsShowWinnersAndInstantUpdatesOption with a value of YES to the options dictionary).
• You can automatically refresh your UI whenever the QA Console is hidden if you wish by listening to the notifications NSNotification.Name.ApptimizeQAConsoleWillDisappear and NSNotification.Name.ApptimizeQAConsoleWillAppear.