com.linkedin.android.testbutler

Class TestButler

java.lang.Object

com.linkedin.android.testbutler.TestButler

public class TestButler
extends java.lang.Object

Main entry point for test code to interface with the Test Butler app running on the emulator.

Contains a number of helper methods for safely communicating with the Test Butler app via RPC.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TestButler.LocationMode
static interface	TestButler.Rotation AOSP has an IntDef for this, but it's hidden, so we create our own here

Constructor Summary

Constructors

Constructor and Description
TestButler()

Method Summary

Modifier and Type	Method and Description
static void	grantPermission(android.content.Context context, java.lang.String permission) A helper method for granting runtime permissions to apps under test on API 23+
static void	setAccessibilityServiceState(boolean enabled) Enable TestButler's dummy accessibility service.
static void	setAlwaysFinishActivities(boolean enabled) Enable or disable always finish activities setting on the emulator
static void	setGsmState(boolean enabled) Enable/disable the GSM connection on the emulator
static void	setImmersiveModeConfirmation(boolean enabled) Enable or disable immersive mode confirmation
static void	setLocale(java.lang.String language, java.lang.String country, android.content.Context context) Set the locale for the application under test.
static void	setLocationMode(int locationMode) Change the location services mode on the emulator
static void	setRotation(int rotation) Change the screen rotation of the emulator
static void	setShowImeWithHardKeyboardState(boolean enabled) Tell the system to prefer the hardware IME This method has no effect on api levels below API 22 You must have your emulator configured with a hardware IME, or this method has no effect
static void	setSpellCheckerState(boolean enabled) Enable or disable the system spell checker
static void	setup(android.content.Context context) Start the remote ButlerService to prepare for running tests
static void	setWifiState(boolean enabled) Enable/disable the Wifi connection on the emulator
static void	teardown(android.content.Context context) Stop the remote ButlerService to indicate the test run has completed.
static void	verifyAnimationsDisabled(android.content.Context context) Validate that all animations have been disabled during the setup(Context) call.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TestButler

public TestButler()

Method Detail

setup

public static void setup(@NonNull
                         android.content.Context context)

Start the remote ButlerService to prepare for running tests

This method should be called from a subclass of Instrumentation.onStart(), BEFORE calling super.onStart(). Often this will be a subclass of AndroidJUnitRunner.

This will handle disabling animations on the device, as well as disabling system popups when apps crash or ANR on the emulator. NOTE: Calling this method will cause the system method ActivityManager.isUserAMonkey() to start returning true. If your code uses this method, you will need to create a helper method for detecting when your code is running under instrumentation testing and not under monkey testing.

Parameters:

context - the "target context"; i.e. Context of the app under test (not the test apk context!)

teardown

public static void teardown(@NonNull
                            android.content.Context context)

Stop the remote ButlerService to indicate the test run has completed.

This method should be called from a subclass of Instrumentation.finish(int, Bundle), BEFORE calling super.finish(). Often this will be a subclass of AndroidJUnitRunner.

This will handle re-enabling animations on the device, as well as allow system popups to be shown when apps crash or ANR on the emulator.

Parameters:

context - the "target context"; i.e. Context of the app under test (not the test apk context!)

verifyAnimationsDisabled

public static void verifyAnimationsDisabled(@NonNull
                                            android.content.Context context)

Validate that all animations have been disabled during the setup(Context) call.

This method will fail with an AssertionFailedError if animations were not disabled by the setup(Context) method. This is useful if you want to immediately halt test execution if animations could not be disabled by Test Butler, rather than failing gracefully and continuing to try and run your tests.

Parameters:

context - the "target context"; i.e. Context of the app under test (not the test apk context!)

setWifiState

public static void setWifiState(boolean enabled)

Enable/disable the Wifi connection on the emulator

Parameters:

enabled - true if wifi should be enabled, false otherwise

setGsmState

public static void setGsmState(boolean enabled)

Enable/disable the GSM connection on the emulator

Parameters:

enabled - true if GSM should be enabled, false otherwise

setLocationMode

public static void setLocationMode(int locationMode)

Change the location services mode on the emulator

Parameters:

locationMode - one of the TestButler.LocationMode IntDef values

setLocale

public static void setLocale(@NonNull
                             java.lang.String language,
                             @NonNull
                             java.lang.String country,
                             @NonNull
                             android.content.Context context)

Set the locale for the application under test. Requires API 17+.

NOTE: this does not change the device locale! Changing the device locale on the emulator has been slow/unreliable and led to flaky tests when the locale setting did not take effect in time. Instead, this method uses the Configuration class to update the locale on the Resources object of the Context from the application under test. As long as apps are checking the current locale from the current Configuration, this approach will be reliable.

Parameters:

language - the language code for the new locale, as expected by Locale(String, String)

country - the country code for the new locale, as expected by Locale(String, String)

context - the "target context"; i.e. Context of the app under test (not the test apk context!)

setRotation

public static void setRotation(int rotation)

Change the screen rotation of the emulator

Parameters:

rotation - one of the TestButler.Rotation IntDef values

setSpellCheckerState

public static void setSpellCheckerState(boolean enabled)

Enable or disable the system spell checker

Parameters:

enabled - What state the spell checker should be set to

setShowImeWithHardKeyboardState

public static void setShowImeWithHardKeyboardState(boolean enabled)

Tell the system to prefer the hardware IME This method has no effect on api levels below API 22 You must have your emulator configured with a hardware IME, or this method has no effect

Parameters:

enabled - Whether to require the hardware keyboard or not

grantPermission

public static void grantPermission(@NonNull
                                   android.content.Context context,
                                   @NonNull
                                   java.lang.String permission)

A helper method for granting runtime permissions to apps under test on API 23+

Note: Before API 23, this method is a no-op

A common use case for this is when running tests from Android Studio where you can't (currently) pass the -g flag to adb install when installing the app to run tests.

Parameters:

context - the "target context"; i.e. Context of the app under test (not the test apk context!)

See Also:

https://code.google.com/p/android/issues/detail?id=198813

setImmersiveModeConfirmation

public static void setImmersiveModeConfirmation(boolean enabled)

Enable or disable immersive mode confirmation

Parameters:

enabled - What state the immersive mode confirmation should be set to

setAlwaysFinishActivities

public static void setAlwaysFinishActivities(boolean enabled)

Enable or disable always finish activities setting on the emulator

Parameters:

enabled - What state the always finish activities setting should be set to

setAccessibilityServiceState

public static void setAccessibilityServiceState(boolean enabled)

Enable TestButler's dummy accessibility service.

Parameters:

enabled - True to enable the accessibility service, false to disable it.