Test rule that disables animations and softkeyboard before any test. Easy access function to control demo modus on API 23 and up devices

AndroidManifest.xml

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
          package="be.rijckaert.tim.disableanimations">
    <!-- Place this permission in your debug folder -->
    <uses-permission android:name="android.permission.SET_ANIMATION_SCALE"/>

</manifest>

BetterActivityTestRule.kt

package be.rijckaert.tim.disableanimations

import android.app.Activity
import android.content.Context
import android.content.pm.PackageManager
import android.support.test.InstrumentationRegistry.getInstrumentation
import android.support.test.rule.ActivityTestRule
import android.support.test.uiautomator.UiDevice
import android.view.ViewGroup
import android.view.WindowManager
import android.view.inputmethod.InputMethodManager
import org.junit.runner.Description
import org.junit.runners.model.Statement


/**
 * Created by TimR.
 */
class BetterActivityTestRule<T : Activity>(activityClass: Class<T>) : ActivityTestRule<T>(activityClass) {

    companion object {
        private val ANIMATION_SCALE_PERMISSION = "android.permission.SET_ANIMATION_SCALE"
    }

    lateinit var launchActivity: Activity
    var device: UiDevice? = null

    override fun apply(userTest: Statement, description: Description): Statement {
        return object : Statement() {
            override fun evaluate() {
                device = UiDevice.getInstance(getInstrumentation())
                deviceWakeUp()

                launchActivity = launchActivity(activityIntent)
                installWakeLock()

                grantScalePermission()

                runTest(userTest)
            }
        }
    }

    private fun runTest(base: Statement) {
        setInTestMode(true)
        try {
            base.evaluate()
        } finally {
            setInTestMode(false)
            deviceSleep()
        }
    }

    //<editor-fold desc="Helper Function">
    private fun setInTestMode(isInTestMode: Boolean) {
        toggleSoftKeyboard(!isInTestMode)
        toggleAnimations(!isInTestMode)
        setDemoMode(isInTestMode)
    }

    private fun toggleSoftKeyboard(isEnabled: Boolean) {
        //Disable hardware keyboard (useful for emulators)
        //http://www.drewhannay.com/2016/04/how-to-hide-android-soft-keyboard-in.html
        device?.executeShellCommand("settings put secure show_ime_with_hard_keyboard " + booleanToInt(isEnabled))

        //hacky! But Android does not have a good way to check whether the keyboard was shown
        val viewGroup = (launchActivity.findViewById(android.R.id.content) as ViewGroup).getChildAt(0) as ViewGroup
        viewGroup.viewTreeObserver.addOnGlobalLayoutListener {
            val isShowingKeyboard = device?.executeShellCommand("dumpsys window InputMethod")?.contains("mHasSurface=true")
            if (isShowingKeyboard == true) {
                val view = launchActivity.currentFocus
                if (view != null) {
                    val imm = launchActivity.getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
                    imm.hideSoftInputFromWindow(view.windowToken, 0)
                }
            }
        }
    }

    private fun toggleAnimations(isEnabled: Boolean) {
        val permStatus = launchActivity.checkCallingOrSelfPermission(ANIMATION_SCALE_PERMISSION)
        if (permStatus == PackageManager.PERMISSION_GRANTED) {
            AnimationType.values().forEach {
                device?.executeShellCommand(it.shellCommand + booleanToInt(isEnabled))
            }
        } else {
            throw RuntimeException("You did not declare the permission")
        }
    }

    private fun booleanToInt(isEnabled: Boolean): Int = if (isEnabled) 1 else 0

    private fun deviceSleep() {
        device?.sleep()
    }

    private fun deviceWakeUp() {
        device?.let {
            if (it.isScreenOn) {
                it.wakeUp()
            }
        }
    }

    /**
     * Bypasses the activity to run on top of the lockscreen
     */
    private fun installWakeLock() {
        this.runOnUiThread {
            launchActivity.window.addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON or
                    WindowManager.LayoutParams.FLAG_DISMISS_KEYGUARD or
                    WindowManager.LayoutParams.FLAG_SHOW_WHEN_LOCKED or
                    WindowManager.LayoutParams.FLAG_TURN_SCREEN_ON)

        }
    }

    /**
     *
     * You should define the following permission in your AndroidManifest.xml
     * <uses-permission android:name="android.permission.SET_ANIMATION_SCALE"/>
     * Be sure you exclude this permission in release builds
     *
     * Either via gradle script or using different AndroidManifest files
     * for different flavors
     *
     */
    private fun grantScalePermission() {
        device?.executeShellCommand("pm grant ${launchActivity.packageName} $ANIMATION_SCALE_PERMISSION")
    }

    enum class AnimationType(val shellCommand: String) {
        WINDOW_ANIMATION_SCALE("settings put global window_animation_scale "),
        TRANSITION_ANIMATION_SCALE("settings put global transition_animation_scale "),
        ANIMATOR_DURATION_SCALE("settings put global animator_duration_scale ")
    }
    //</editor-fold>

    //<editor-fold desc="Demo Mode">
    private fun setDemoMode(inDemoMode: Boolean) {
        val currentApiVersion = android.os.Build.VERSION.SDK_INT
        if (currentApiVersion >= android.os.Build.VERSION_CODES.M) {
            device?.executeShellCommand("settings put global sysui_demo_allowed" + booleanToInt(inDemoMode))

            val command = "am broadcast -a com.android.systemui.demo -e command" + if (inDemoMode) "enter" else "exit"
            device?.executeShellCommand(command)
        }
    }

    fun setClock(hhmm: String = "0700") {
        device?.executeShellCommand("am broadcast -a com.android.systemui.demo -e command clock -e hhmm $hhmm")
    }

    fun setWifiLevel(wifiLevel: WifiLevel) {
        device?.executeShellCommand("am broadcast -a com.android.systemui.demo -e command network -e wifi show -e level ${wifiLevel.level}")
    }

    fun hideNotifications(isNotificationVisible: Boolean) {
        device?.executeShellCommand("am broadcast -a com.android.systemui.demo -e command notifications -e visible $isNotificationVisible")
    }

    fun setBatteryLevel(batterLevelPercentage: Int, isPlugged: Boolean) {
        if (batterLevelPercentage > 100 || batterLevelPercentage < 0) {
            throw IllegalArgumentException("Dude, seriously?!")
        }
        device?.executeShellCommand("am broadcast -a com.android.systemui.demo -e command battery -e batterLevelPercentage $batterLevelPercentage -e plugged $isPlugged")
    }

    enum class WifiLevel(val level: String) {
        LEVEL_1("1"),
        LEVEL_2("2"),
        LEVEL_3("3"),
        LEVEL_4("4")
    }
    //</editor-fold>
}