server/input/KeyboardBacklightControllerTests.kt

/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.server.input

import android.animation.ValueAnimator
import android.content.Context
import android.content.ContextWrapper
import android.content.res.Resources
import android.graphics.Color
import android.hardware.input.IKeyboardBacklightListener
import android.hardware.input.IKeyboardBacklightState
import android.hardware.input.InputManager
import android.hardware.lights.Light
import android.os.SystemProperties
import android.os.test.TestLooper
import android.platform.test.annotations.Presubmit
import android.util.TypedValue
import android.view.InputDevice
import androidx.test.annotation.UiThreadTest
import androidx.test.core.app.ApplicationProvider
import com.android.dx.mockito.inline.extended.ExtendedMockito
import com.android.internal.R
import com.android.modules.utils.testing.ExtendedMockitoRule
import com.android.server.input.KeyboardBacklightController.DEFAULT_BRIGHTNESS_VALUE_FOR_LEVEL
import com.android.server.input.KeyboardBacklightController.MAX_BRIGHTNESS_CHANGE_STEPS
import com.android.test.input.MockInputManagerRule
import org.junit.Assert.assertEquals
import org.junit.Assert.assertNotEquals
import org.junit.Assert.assertNotNull
import org.junit.Assert.assertNull
import org.junit.Assert.assertTrue
import org.junit.Before
import org.junit.Rule
import org.junit.Test
import org.mockito.Mock
import org.mockito.Mockito.any
import org.mockito.Mockito.anyBoolean
import org.mockito.Mockito.anyInt
import org.mockito.Mockito.eq
import org.mockito.Mockito.spy
import org.mockito.Mockito.`when`

private fun createKeyboard(deviceId: Int): InputDevice =
    InputDevice.Builder()
        .setId(deviceId)
        .setName("Device $deviceId")
        .setDescriptor("descriptor $deviceId")
        .setSources(InputDevice.SOURCE_KEYBOARD)
        .setKeyboardType(InputDevice.KEYBOARD_TYPE_ALPHABETIC)
        .setExternal(true)
        .build()

private fun createLight(lightId: Int, lightType: Int): Light = createLight(lightId, lightType, null)

private fun createLight(lightId: Int, lightType: Int, suggestedBrightnessLevels: IntArray?): Light =
    Light(
        lightId,
        "Light $lightId",
        1,
        lightType,
        Light.LIGHT_CAPABILITY_BRIGHTNESS,
        suggestedBrightnessLevels,
    )

/**
 * Tests for {@link KeyboardBacklightController}.
 *
 * Build/Install/Run: atest InputTests:KeyboardBacklightControllerTests
 */
@Presubmit
class KeyboardBacklightControllerTests {
    companion object {
        const val DEVICE_ID = 1
        const val LIGHT_ID = 2
        const val SECOND_LIGHT_ID = 3
        const val MAX_BRIGHTNESS = 255
        const val USER_INACTIVITY_THRESHOLD_MILLIS = 30000
    }

    @get:Rule
    val extendedMockitoRule =
        ExtendedMockitoRule.Builder(this).mockStatic(SystemProperties::class.java).build()!!
    @get:Rule val inputManagerRule = MockInputManagerRule()

    @Mock private lateinit var native: NativeInputManagerService
    @Mock private lateinit var resources: Resources
    private lateinit var keyboardBacklightController: KeyboardBacklightController
    private lateinit var context: Context
    private lateinit var testLooper: TestLooper
    private var lightColorMap: HashMap<Int, Int> = HashMap()
    private var lastBacklightState: KeyboardBacklightState? = null
    private var lastAnimationValues = IntArray(2)

    @Before
    fun setup() {
        context = spy(ContextWrapper(ApplicationProvider.getApplicationContext()))
        `when`(context.resources).thenReturn(resources)
        testLooper = TestLooper()
        setupConfig()
        val inputManager = InputManager(context)
        `when`(context.getSystemService(eq(Context.INPUT_SERVICE))).thenReturn(inputManager)
        `when`(inputManagerRule.mock.inputDeviceIds).thenReturn(intArrayOf(DEVICE_ID))
        `when`(native.setLightColor(anyInt(), anyInt(), anyInt())).then {
            val args = it.arguments
            lightColorMap.put(args[1] as Int, args[2] as Int)
        }
        `when`(native.getLightColor(anyInt(), anyInt())).thenAnswer {
            val args = it.arguments
            lightColorMap.getOrDefault(args[1] as Int, 0)
        }
        lightColorMap.clear()
    }

    private fun setupConfig() {
        val brightnessValues = intArrayOf(100, 200, 0)
        val decreaseThresholds = intArrayOf(-1, 900, 1900)
        val increaseThresholds = intArrayOf(1000, 2000, -1)
        `when`(resources.getIntArray(R.array.config_autoKeyboardBacklightBrightnessValues))
            .thenReturn(brightnessValues)
        `when`(resources.getIntArray(R.array.config_autoKeyboardBacklightDecreaseLuxThreshold))
            .thenReturn(decreaseThresholds)
        `when`(resources.getIntArray(R.array.config_autoKeyboardBacklightIncreaseLuxThreshold))
            .thenReturn(increaseThresholds)
        `when`(resources.getInteger(R.integer.config_keyboardBacklightTimeoutMs))
            .thenReturn(USER_INACTIVITY_THRESHOLD_MILLIS)
        `when`(
                resources.getValue(
                    eq(R.dimen.config_autoKeyboardBrightnessSmoothingConstant),
                    any(TypedValue::class.java),
                    anyBoolean(),
                )
            )
            .then {
                val args = it.arguments
                val outValue = args[1] as TypedValue
                outValue.data = java.lang.Float.floatToRawIntBits(1.0f)
                Unit
            }
    }

    private fun setupController() {
        keyboardBacklightController =
            KeyboardBacklightController(context, native, testLooper.looper, FakeAnimatorFactory())
    }

    @Test
    fun testKeyboardBacklightIncrementDecrement() {
        setupController()
        val keyboardWithBacklight = createKeyboard(DEVICE_ID)
        val keyboardBacklight = createLight(LIGHT_ID, Light.LIGHT_TYPE_KEYBOARD_BACKLIGHT)
        `when`(inputManagerRule.mock.getInputDevice(DEVICE_ID)).thenReturn(keyboardWithBacklight)
        `when`(inputManagerRule.mock.getLights(DEVICE_ID)).thenReturn(listOf(keyboardBacklight))
        keyboardBacklightController.onInputDeviceAdded(DEVICE_ID)

        assertIncrementDecrementForLevels(
            keyboardWithBacklight,
            keyboardBacklight,
            DEFAULT_BRIGHTNESS_VALUE_FOR_LEVEL,
        )
    }

    @Test
    fun testKeyboardWithoutBacklight() {
        setupController()
        val keyboardWithoutBacklight = createKeyboard(DEVICE_ID)
        val keyboardInputLight = createLight(LIGHT_ID, Light.LIGHT_TYPE_INPUT)
        `when`(inputManagerRule.mock.getInputDevice(DEVICE_ID)).thenReturn(keyboardWithoutBacklight)
        `when`(inputManagerRule.mock.getLights(DEVICE_ID)).thenReturn(listOf(keyboardInputLight))
        keyboardBacklightController.onInputDeviceAdded(DEVICE_ID)

        incrementKeyboardBacklight(DEVICE_ID)
        assertTrue("Non Keyboard backlights should not change", lightColorMap.isEmpty())
    }

    @Test
    fun testKeyboardWithMultipleLight() {
        setupController()
        val keyboardWithBacklight = createKeyboard(DEVICE_ID)
        val keyboardBacklight = createLight(LIGHT_ID, Light.LIGHT_TYPE_KEYBOARD_BACKLIGHT)
        val keyboardInputLight = createLight(SECOND_LIGHT_ID, Light.LIGHT_TYPE_INPUT)
        `when`(inputManagerRule.mock.getInputDevice(DEVICE_ID)).thenReturn(keyboardWithBacklight)
        `when`(inputManagerRule.mock.getLights(DEVICE_ID))
            .thenReturn(listOf(keyboardBacklight, keyboardInputLight))
        keyboardBacklightController.onInputDeviceAdded(DEVICE_ID)

        incrementKeyboardBacklight(DEVICE_ID)
        assertEquals("Only keyboard backlights should change", 1, lightColorMap.size)
        assertNotNull("Keyboard backlight should change", lightColorMap[LIGHT_ID])
        assertNull("Input lights should not change", lightColorMap[SECOND_LIGHT_ID])
    }

    @Test
    fun testKeyboardBacklight_registerUnregisterListener() {
        setupController()
        val keyboardWithBacklight = createKeyboard(DEVICE_ID)
        val keyboardBacklight = createLight(LIGHT_ID, Light.LIGHT_TYPE_KEYBOARD_BACKLIGHT)
        val maxLevel = DEFAULT_BRIGHTNESS_VALUE_FOR_LEVEL.size - 1
        `when`(inputManagerRule.mock.getInputDevice(DEVICE_ID)).thenReturn(keyboardWithBacklight)
        `when`(inputManagerRule.mock.getLights(DEVICE_ID)).thenReturn(listOf(keyboardBacklight))
        keyboardBacklightController.onInputDeviceAdded(DEVICE_ID)

        // Register backlight listener
        val listener = KeyboardBacklightListener()
        keyboardBacklightController.registerKeyboardBacklightListener(listener, 0)

        lastBacklightState = null
        keyboardBacklightController.incrementKeyboardBacklight(DEVICE_ID)
        testLooper.dispatchNext()

        assertEquals(
            "Backlight state device Id should be $DEVICE_ID",
            DEVICE_ID,
            lastBacklightState!!.deviceId,
        )
        assertEquals(
            "Backlight state brightnessLevel should be 1",
            1,
            lastBacklightState!!.brightnessLevel,
        )
        assertEquals(
            "Backlight state maxBrightnessLevel should be $maxLevel",
            maxLevel,
            lastBacklightState!!.maxBrightnessLevel,
        )
        assertEquals(
            "Backlight state isTriggeredByKeyPress should be true",
            true,
            lastBacklightState!!.isTriggeredByKeyPress,
        )

        // Unregister listener
        keyboardBacklightController.unregisterKeyboardBacklightListener(listener, 0)

        lastBacklightState = null
        incrementKeyboardBacklight(DEVICE_ID)

        assertNull("Listener should not receive any updates", lastBacklightState)
    }

    @Test
    fun testKeyboardBacklight_userActivity() {
        setupController()
        val keyboardWithBacklight = createKeyboard(DEVICE_ID)
        val keyboardBacklight = createLight(LIGHT_ID, Light.LIGHT_TYPE_KEYBOARD_BACKLIGHT)
        `when`(inputManagerRule.mock.getInputDevice(DEVICE_ID)).thenReturn(keyboardWithBacklight)
        `when`(inputManagerRule.mock.getLights(DEVICE_ID)).thenReturn(listOf(keyboardBacklight))
        keyboardBacklightController.onInputDeviceAdded(DEVICE_ID)
        incrementKeyboardBacklight(DEVICE_ID)
        assertNotEquals(
            "Keyboard backlight level should be incremented to a non-zero value",
            0,
            lightColorMap[LIGHT_ID],
        )

        testLooper.moveTimeForward((USER_INACTIVITY_THRESHOLD_MILLIS + 1000).toLong())
        testLooper.dispatchNext()
        assertEquals(
            "Keyboard backlight level should be turned off after inactivity",
            0,
            lightColorMap[LIGHT_ID],
        )
    }

    @Test
    fun testKeyboardBacklight_displayOnOff() {
        setupController()
        val keyboardWithBacklight = createKeyboard(DEVICE_ID)
        val keyboardBacklight = createLight(LIGHT_ID, Light.LIGHT_TYPE_KEYBOARD_BACKLIGHT)
        `when`(inputManagerRule.mock.getInputDevice(DEVICE_ID)).thenReturn(keyboardWithBacklight)
        `when`(inputManagerRule.mock.getLights(DEVICE_ID)).thenReturn(listOf(keyboardBacklight))
        keyboardBacklightController.onInputDeviceAdded(DEVICE_ID)
        incrementKeyboardBacklight(DEVICE_ID)

        val currentValue = lightColorMap[LIGHT_ID]
        assertNotEquals(
            "Keyboard backlight level should be incremented to a non-zero value",
            0,
            lightColorMap[LIGHT_ID],
        )

        keyboardBacklightController.handleInteractiveStateChange(false /* isDisplayOn */)
        assertEquals(
            "Keyboard backlight level should be turned off after display is turned off",
            0,
            lightColorMap[LIGHT_ID],
        )

        keyboardBacklightController.handleInteractiveStateChange(true /* isDisplayOn */)
        assertEquals(
            "Keyboard backlight level should be turned on after display is turned on",
            currentValue,
            lightColorMap[LIGHT_ID],
        )
    }

    @Test
    @UiThreadTest
    fun testKeyboardBacklightAnimation_onChangeLevels() {
        ExtendedMockito.doReturn("true").`when` {
            SystemProperties.get(eq("persist.input.keyboard.backlight_animation.enabled"))
        }
        setupController()
        val keyboardWithBacklight = createKeyboard(DEVICE_ID)
        val keyboardBacklight = createLight(LIGHT_ID, Light.LIGHT_TYPE_KEYBOARD_BACKLIGHT)
        `when`(inputManagerRule.mock.getInputDevice(DEVICE_ID)).thenReturn(keyboardWithBacklight)
        `when`(inputManagerRule.mock.getLights(DEVICE_ID)).thenReturn(listOf(keyboardBacklight))
        keyboardBacklightController.onInputDeviceAdded(DEVICE_ID)

        incrementKeyboardBacklight(DEVICE_ID)
        assertEquals(
            "Should start animation from level 0",
            DEFAULT_BRIGHTNESS_VALUE_FOR_LEVEL[0],
            lastAnimationValues[0],
        )
        assertEquals(
            "Should start animation to level 1",
            DEFAULT_BRIGHTNESS_VALUE_FOR_LEVEL[1],
            lastAnimationValues[1],
        )
    }

    @Test
    fun testKeyboardBacklightPreferredLevels() {
        setupController()
        val keyboardWithBacklight = createKeyboard(DEVICE_ID)
        val suggestedLevels = intArrayOf(0, 22, 63, 135, 196, 255)
        val keyboardBacklight =
            createLight(LIGHT_ID, Light.LIGHT_TYPE_KEYBOARD_BACKLIGHT, suggestedLevels)
        `when`(inputManagerRule.mock.getInputDevice(DEVICE_ID)).thenReturn(keyboardWithBacklight)
        `when`(inputManagerRule.mock.getLights(DEVICE_ID)).thenReturn(listOf(keyboardBacklight))
        keyboardBacklightController.onInputDeviceAdded(DEVICE_ID)

        assertIncrementDecrementForLevels(keyboardWithBacklight, keyboardBacklight, suggestedLevels)
    }

    @Test
    fun testKeyboardBacklightPreferredLevels_moreThanMax_shouldUseDefault() {
        setupController()
        val keyboardWithBacklight = createKeyboard(DEVICE_ID)
        val suggestedLevels = IntArray(MAX_BRIGHTNESS_CHANGE_STEPS + 1) { 10 * (it + 1) }
        val keyboardBacklight =
            createLight(LIGHT_ID, Light.LIGHT_TYPE_KEYBOARD_BACKLIGHT, suggestedLevels)
        `when`(inputManagerRule.mock.getInputDevice(DEVICE_ID)).thenReturn(keyboardWithBacklight)
        `when`(inputManagerRule.mock.getLights(DEVICE_ID)).thenReturn(listOf(keyboardBacklight))
        keyboardBacklightController.onInputDeviceAdded(DEVICE_ID)

        assertIncrementDecrementForLevels(
            keyboardWithBacklight,
            keyboardBacklight,
            DEFAULT_BRIGHTNESS_VALUE_FOR_LEVEL,
        )
    }

    @Test
    fun testKeyboardBacklightPreferredLevels_mustHaveZeroAndMaxBrightnessAsBounds() {
        setupController()
        val keyboardWithBacklight = createKeyboard(DEVICE_ID)
        val suggestedLevels = intArrayOf(22, 63, 135, 196)
        val keyboardBacklight =
            createLight(LIGHT_ID, Light.LIGHT_TYPE_KEYBOARD_BACKLIGHT, suggestedLevels)
        `when`(inputManagerRule.mock.getInputDevice(DEVICE_ID)).thenReturn(keyboardWithBacklight)
        `when`(inputManagerRule.mock.getLights(DEVICE_ID)).thenReturn(listOf(keyboardBacklight))
        keyboardBacklightController.onInputDeviceAdded(DEVICE_ID)

        // Framework will add the lowest and maximum levels if not provided via config
        assertIncrementDecrementForLevels(
            keyboardWithBacklight,
            keyboardBacklight,
            intArrayOf(0, 22, 63, 135, 196, 255),
        )
    }

    @Test
    fun testKeyboardBacklightPreferredLevels_dropsOutOfBoundsLevels() {
        setupController()
        val keyboardWithBacklight = createKeyboard(DEVICE_ID)
        val suggestedLevels = intArrayOf(22, 63, 135, 400, 196, 1000)
        val keyboardBacklight =
            createLight(LIGHT_ID, Light.LIGHT_TYPE_KEYBOARD_BACKLIGHT, suggestedLevels)
        `when`(inputManagerRule.mock.getInputDevice(DEVICE_ID)).thenReturn(keyboardWithBacklight)
        `when`(inputManagerRule.mock.getLights(DEVICE_ID)).thenReturn(listOf(keyboardBacklight))
        keyboardBacklightController.onInputDeviceAdded(DEVICE_ID)

        // Framework will drop out of bound levels in the config
        assertIncrementDecrementForLevels(
            keyboardWithBacklight,
            keyboardBacklight,
            intArrayOf(0, 22, 63, 135, 196, 255),
        )
    }

    @Test
    fun testAmbientBacklightControl_incrementLevel_afterAmbientChange() {
        setupController()
        val keyboardWithBacklight = createKeyboard(DEVICE_ID)
        val keyboardBacklight = createLight(LIGHT_ID, Light.LIGHT_TYPE_KEYBOARD_BACKLIGHT)
        `when`(inputManagerRule.mock.getInputDevice(DEVICE_ID)).thenReturn(keyboardWithBacklight)
        `when`(inputManagerRule.mock.getLights(DEVICE_ID)).thenReturn(listOf(keyboardBacklight))
        keyboardBacklightController.onInputDeviceAdded(DEVICE_ID)
        sendAmbientBacklightValue(1)
        assertEquals(
            "Light value should be changed to ambient provided value",
            Color.argb(1, 0, 0, 0),
            lightColorMap[LIGHT_ID],
        )

        incrementKeyboardBacklight(DEVICE_ID)

        assertEquals(
            "Light value for level after increment post Ambient change is mismatched",
            Color.argb(DEFAULT_BRIGHTNESS_VALUE_FOR_LEVEL[1], 0, 0, 0),
            lightColorMap[LIGHT_ID],
        )
    }

    @Test
    fun testAmbientBacklightControl_decrementLevel_afterAmbientChange() {
        setupController()
        val keyboardWithBacklight = createKeyboard(DEVICE_ID)
        val keyboardBacklight = createLight(LIGHT_ID, Light.LIGHT_TYPE_KEYBOARD_BACKLIGHT)
        `when`(inputManagerRule.mock.getInputDevice(DEVICE_ID)).thenReturn(keyboardWithBacklight)
        `when`(inputManagerRule.mock.getLights(DEVICE_ID)).thenReturn(listOf(keyboardBacklight))
        keyboardBacklightController.onInputDeviceAdded(DEVICE_ID)
        sendAmbientBacklightValue(254)
        assertEquals(
            "Light value should be changed to ambient provided value",
            Color.argb(254, 0, 0, 0),
            lightColorMap[LIGHT_ID],
        )

        decrementKeyboardBacklight(DEVICE_ID)

        val numLevels = DEFAULT_BRIGHTNESS_VALUE_FOR_LEVEL.size
        assertEquals(
            "Light value for level after decrement post Ambient change is mismatched",
            Color.argb(DEFAULT_BRIGHTNESS_VALUE_FOR_LEVEL[numLevels - 2], 0, 0, 0),
            lightColorMap[LIGHT_ID],
        )
    }

    @Test
    fun testAmbientBacklightControl_ambientChanges_afterManualChange() {
        setupController()
        val keyboardWithBacklight = createKeyboard(DEVICE_ID)
        val keyboardBacklight = createLight(LIGHT_ID, Light.LIGHT_TYPE_KEYBOARD_BACKLIGHT)
        `when`(inputManagerRule.mock.getInputDevice(DEVICE_ID)).thenReturn(keyboardWithBacklight)
        `when`(inputManagerRule.mock.getLights(DEVICE_ID)).thenReturn(listOf(keyboardBacklight))
        keyboardBacklightController.onInputDeviceAdded(DEVICE_ID)
        incrementKeyboardBacklight(DEVICE_ID)
        assertEquals(
            "Light value should be changed to the first level",
            Color.argb(DEFAULT_BRIGHTNESS_VALUE_FOR_LEVEL[1], 0, 0, 0),
            lightColorMap[LIGHT_ID],
        )

        sendAmbientBacklightValue(100)
        assertNotEquals(
            "Light value should not change based on ambient changes after manual changes",
            Color.argb(100, 0, 0, 0),
            lightColorMap[LIGHT_ID],
        )
    }

    private fun assertIncrementDecrementForLevels(
        device: InputDevice,
        light: Light,
        expectedLevels: IntArray,
    ) {
        val deviceId = device.id
        val lightId = light.id
        for (level in 1 until expectedLevels.size) {
            incrementKeyboardBacklight(deviceId)
            assertEquals(
                "Light value for level $level mismatched",
                Color.argb(expectedLevels[level], 0, 0, 0),
                lightColorMap[lightId],
            )
        }

        // Increment above max level
        incrementKeyboardBacklight(deviceId)
        assertEquals(
            "Light value for max level mismatched",
            Color.argb(MAX_BRIGHTNESS, 0, 0, 0),
            lightColorMap[lightId],
        )

        for (level in expectedLevels.size - 2 downTo 0) {
            decrementKeyboardBacklight(deviceId)
            assertEquals(
                "Light value for level $level mismatched",
                Color.argb(expectedLevels[level], 0, 0, 0),
                lightColorMap[lightId],
            )
        }

        // Decrement below min level
        decrementKeyboardBacklight(deviceId)
        assertEquals(
            "Light value for min level mismatched",
            Color.argb(0, 0, 0, 0),
            lightColorMap[lightId],
        )
    }

    inner class KeyboardBacklightListener : IKeyboardBacklightListener.Stub() {
        override fun onBrightnessChanged(
            deviceId: Int,
            state: IKeyboardBacklightState,
            isTriggeredByKeyPress: Boolean,
        ) {
            lastBacklightState =
                KeyboardBacklightState(
                    deviceId,
                    state.brightnessLevel,
                    state.maxBrightnessLevel,
                    isTriggeredByKeyPress,
                )
        }
    }

    private fun incrementKeyboardBacklight(deviceId: Int) {
        keyboardBacklightController.incrementKeyboardBacklight(deviceId)
        keyboardBacklightController.notifyUserActivity()
        testLooper.dispatchAll()
    }

    private fun decrementKeyboardBacklight(deviceId: Int) {
        keyboardBacklightController.decrementKeyboardBacklight(deviceId)
        keyboardBacklightController.notifyUserActivity()
        testLooper.dispatchAll()
    }

    private fun sendAmbientBacklightValue(brightnessValue: Int) {
        keyboardBacklightController.handleAmbientLightValueChanged(brightnessValue)
        keyboardBacklightController.notifyUserActivity()
        testLooper.dispatchAll()
    }

    class KeyboardBacklightState(
        val deviceId: Int,
        val brightnessLevel: Int,
        val maxBrightnessLevel: Int,
        val isTriggeredByKeyPress: Boolean,
    )

    private inner class FakeAnimatorFactory : KeyboardBacklightController.AnimatorFactory {
        override fun makeIntAnimator(from: Int, to: Int): ValueAnimator {
            lastAnimationValues[0] = from
            lastAnimationValues[1] = to
            return ValueAnimator.ofInt(from, to)
        }
    }
}