Check language task and set language (requires additional app) feature.

Paulina Strychacz · Paulina Strychacz · commit 42512528b70a · 2019-11-27T11:56:00.000+01:00
diff --git a/src/main/kotlin/TestDeviceManagerExtension.kt b/src/main/kotlin/TestDeviceManagerExtension.kt
@@ -5,5 +5,6 @@ open class TestDeviceManagerExtension {
     var pin: String = ""
     var password: String = ""
     var wifi: String = ""
+    var language: String = ""
 }
 
diff --git a/src/main/kotlin/internal/Constants.kt b/src/main/kotlin/internal/Constants.kt
@@ -1,5 +1,6 @@
 package internal
 
+import internal.External.CHANGE_LANGUAGE_APP
 import org.gradle.api.GradleException
 
 object ShellCommands {
@@ -16,6 +17,15 @@ object ShellCommands {
     const val SETTINGS_GET_STAY_ON = "settings get global stay_on_while_plugged_in"
     const val SETTINGS_PUT_GLOBAL = "settings put global"
     const val SETTINGS_GET_GLOBAL = "settings get global"
+    const val CHANGE_LANGUAGE_VIA_APP ="am start -n $CHANGE_LANGUAGE_APP/.AdbChangeLanguage -e language "
+}
+
+object SystemProperties {
+    const val LOCALE = "persist.sys.locale"
+}
+
+object External {
+    const val CHANGE_LANGUAGE_APP= "net.sanapeli.adbchangelanguage"
 }
 
 object TaskInfo {
diff --git a/src/main/kotlin/internal/DeviceWrapper.kt b/src/main/kotlin/internal/DeviceWrapper.kt
@@ -1,7 +1,10 @@
 package internal
 
 import com.android.ddmlib.IDevice
+import com.android.ddmlib.IDevice.*
+import internal.External.CHANGE_LANGUAGE_APP
 import internal.GradleException.noDevicesConnected
+import internal.ShellCommands.CHANGE_LANGUAGE_VIA_APP
 import internal.ShellCommands.DUMPSYS_INPUT_METHOD
 import internal.ShellCommands.DUMPSYS_WIFI
 import internal.ShellCommands.DUMPSYS_WINDOW
@@ -11,6 +14,7 @@ import internal.ShellCommands.SETTINGS_GET_STAY_ON
 import internal.ShellCommands.SETTINGS_PUT_GLOBAL
 import internal.ShellCommands.SETTINGS_PUT_STAY_ON
 import internal.ShellOutput.noDeviceError
+import internal.SystemProperties.LOCALE
 import org.gradle.api.GradleException
 import java.util.regex.Matcher
 
@@ -22,9 +26,9 @@ class DeviceWrapper(val device: IDevice, val outputReceiverProvider: OutputRecei
     }
 
     fun getDetails(): String {
-        return "${device.getProperty("ro.product.model")} " +
-                "- Android ${device.getProperty("ro.build.version.release")} " +
-                "(API level: ${device.getProperty("ro.build.version.sdk")})"
+        return "${device.getProperty(PROP_DEVICE_MODEL)} " +
+                "- Android ${device.getProperty(PROP_BUILD_VERSION)} " +
+                "(API level: ${device.getProperty(PROP_BUILD_API_LEVEL)})"
     }
 
     fun getDeviceScreenResolution(): ScreenResolution {
@@ -56,6 +60,26 @@ class DeviceWrapper(val device: IDevice, val outputReceiverProvider: OutputRecei
         executeShellCommandWithOutput("$SETTINGS_PUT_STAY_ON ${status.value}")
     }
 
+    fun getLanguage(): String {
+        return device.getProperty(LOCALE)
+    }
+
+    fun setLanguage(locale: String) {
+        if (checkChangeLanguageAppIsInstalled() ) {
+            executeShellCommandWithOutput("pm grant $CHANGE_LANGUAGE_APP android.permission.CHANGE_CONFIGURATION ")
+            executeShellCommandWithOutput("$CHANGE_LANGUAGE_VIA_APP $locale")
+        }
+        else {
+           throw GradleException("missing the external app ADB Change Language ($CHANGE_LANGUAGE_APP) " +
+                    "- you can install it from the Play Store")
+        }
+    }
+
+    private fun checkChangeLanguageAppIsInstalled(): Boolean {
+        val output = executeShellCommandWithOutput("pm list packages $CHANGE_LANGUAGE_APP")
+        return output.trim() == "package:$CHANGE_LANGUAGE_APP"
+    }
+
     fun getAndroidId(): String {
         val output = executeShellCommandWithOutput(SETTINGS_GET_ANDROID_ID)
         return output.trim()
diff --git a/src/main/kotlin/internal/TaskCreator.kt b/src/main/kotlin/internal/TaskCreator.kt
@@ -3,8 +3,10 @@ package internal
 import TestDeviceManagerExtension
 import internal.TaskNames.ANIMATIONS_DISABLE_TASK_NAME
 import internal.TaskNames.ANIMATIONS_ENABLE_TASK_NAME
+import internal.TaskNames.CHECK_LANGUAGE_TASK_NAME
 import internal.TaskNames.CHECK_WIFI_TASK_NAME
 import internal.TaskNames.LOCK_TASK_NAME
+import internal.TaskNames.SET_LANGUAGE_TASK_NAME
 import internal.TaskNames.STAY_AWAKE_DISABLE_TASK_NAME
 import internal.TaskNames.STAY_AWAKE_ENABLE_TASK_NAME
 import internal.TaskNames.UNLOCK_TASK_NAME
@@ -13,6 +15,7 @@ import org.gradle.api.Project
 import org.gradle.api.Task
 import tasks.*
 import tasks.internal.AnimationScalesSwitch
+import tasks.internal.DefaultPluginTask
 
 object TaskNames {
     const val UNLOCK_TASK_NAME = "connectedDeviceUnlock"
@@ -22,6 +25,8 @@ object TaskNames {
     const val STAY_AWAKE_ENABLE_TASK_NAME = "connectedStayAwakeEnable"
     const val STAY_AWAKE_DISABLE_TASK_NAME = "connectedStayAwakeDisable"
     const val CHECK_WIFI_TASK_NAME = "connectedCheckWifi"
+    const val CHECK_LANGUAGE_TASK_NAME = "connectedCheckLanguage"
+    const val SET_LANGUAGE_TASK_NAME = "connectedSetLanguage"
 }
 
 sealed class Tasks<T : Task>(var name: String, var type: Class<T>) {
@@ -36,6 +41,8 @@ sealed class Tasks<T : Task>(var name: String, var type: Class<T>) {
                                                             DisableStayAwakeTask::class.java)
 
     object CHECK_WIFI_CONNECTION : Tasks<CheckWifiTask>(CHECK_WIFI_TASK_NAME, CheckWifiTask::class.java)
+    object CHECK_LANGUAGE : Tasks<CheckLanguageTask>(CHECK_LANGUAGE_TASK_NAME, CheckLanguageTask::class.java)
+    object SET_LANGUAGE : Tasks<SetLanguageTask>(SET_LANGUAGE_TASK_NAME, SetLanguageTask::class.java)
 }
 
 class TaskCreator(
@@ -47,40 +54,41 @@ class TaskCreator(
 ) {
 
     fun createTasks() {
-        project.tasks.create(UNLOCK.name, UNLOCK.type) {
-            it.communicator = communicator
+        createTask(UNLOCK) {
             it.unlockBy = extension.unlockBy
             it.pin = extension.pin
             it.password = extension.password
         }
 
-        project.tasks.create(LOCK.name, LOCK.type) {
-            it.communicator = communicator
-        }
-
-        project.tasks.create(ANIMATION_DISABLE.name, ANIMATION_DISABLE.type) {
-            it.communicator = communicator
+        createTask(LOCK)
+        createTask(ANIMATION_DISABLE) {
             it.persistenceHelper = animationScalesPersistenceHelper
             it.animationScalesSwitch = animationScalesSwitch
         }
 
-        project.tasks.create(ANIMATION_ENABLE.name, ANIMATION_ENABLE.type) {
-            it.communicator = communicator
+        createTask(ANIMATION_ENABLE) {
             it.persistenceHelper = animationScalesPersistenceHelper
             it.animationScalesSwitch = animationScalesSwitch
         }
 
-        project.tasks.create(STAY_AWAKE_ENABLE.name, STAY_AWAKE_ENABLE.type) {
-            it.communicator = communicator
+        createTask(STAY_AWAKE_ENABLE)
+        createTask(STAY_AWAKE_DISABLE)
+        createTask(CHECK_WIFI_CONNECTION) {
+            it.wifi = extension.wifi
         }
 
-        project.tasks.create(STAY_AWAKE_DISABLE.name, STAY_AWAKE_DISABLE.type) {
-            it.communicator = communicator
+        createTask(CHECK_LANGUAGE) {
+            it.language = extension.language
         }
+        createTask(SET_LANGUAGE) {
+            it.language = extension.language
+        }
+    }
 
-        project.tasks.create(CHECK_WIFI_CONNECTION.name, CHECK_WIFI_CONNECTION.type) {
+    private fun <T : DefaultPluginTask> createTask(task: Tasks<T>, configuration: ((T) -> Unit)? = null) {
+        project.tasks.create(task.name, task.type)  {
             it.communicator = communicator
-            it.wifi = extension.wifi
+            configuration?.invoke(it as T)
         }
     }
 }
diff --git a/src/main/kotlin/tasks/CheckLanguageTask.kt b/src/main/kotlin/tasks/CheckLanguageTask.kt
@@ -0,0 +1,12 @@
+package tasks
+
+import tasks.internal.LanguageTask
+
+
+open class CheckLanguageTask : LanguageTask() {
+
+    init {
+        description = "check if specific locale is set as current language"
+    }
+
+}
diff --git a/src/main/kotlin/tasks/SetLanguageTask.kt b/src/main/kotlin/tasks/SetLanguageTask.kt
@@ -0,0 +1,35 @@
+package tasks
+
+import com.android.ddmlib.IDevice
+import internal.DeviceWrapper
+import org.gradle.api.GradleException
+import tasks.internal.LanguageCheckException
+import tasks.internal.LanguageTask
+
+
+open class SetLanguageTask : LanguageTask() {
+
+    init {
+        description = "check if specific locale is set. if not tries to set it using the external app"
+    }
+
+    override fun runTask2(device: IDevice) {
+        try {
+            super.runTask2(device)
+        }
+        catch (e: LanguageCheckException) {
+            val deviceWrapper = DeviceWrapper(device, outputReceiverProvider)
+            println("Device ${deviceWrapper.getDetails()} setting language to $language.")
+            deviceWrapper.setLanguage(language)
+
+            Thread.sleep(1000) //external app changes language via UI, so we need to wait for it
+
+            val languageAfterChange = deviceWrapper.getLanguage()
+            if (languageAfterChange != language) {
+                throw GradleException("Different language set on ${deviceWrapper.getDetails()}. " +
+                        "It's $languageAfterChange, while $language was expected.")
+            }
+            println("Device ${deviceWrapper.getDetails()} has locale set to $language.")
+        }
+    }
+}
diff --git a/src/main/kotlin/tasks/internal/LanguageTask.kt b/src/main/kotlin/tasks/internal/LanguageTask.kt
@@ -0,0 +1,31 @@
+package tasks.internal
+
+import com.android.ddmlib.IDevice
+import internal.DeviceWrapper
+import org.gradle.api.GradleException
+import org.gradle.api.tasks.Input
+
+open class LanguageTask : DefaultPluginTask() {
+    @Input
+    lateinit var language: String
+
+    override fun runTask1() {
+        if (language.isBlank()) {
+            throw GradleException("No language provided in build script.")
+        }
+    }
+
+    override fun runTask2(device: IDevice) {
+        val deviceWrapper = DeviceWrapper(device, outputReceiverProvider)
+        val currentLanguage = deviceWrapper.getLanguage()
+        if (currentLanguage != language) {
+            throw LanguageCheckException("Different language set on ${deviceWrapper.getDetails()}. " +
+                    "It's $currentLanguage, while $language was expected.")
+        }
+        println("Device ${deviceWrapper.getDetails()} has locale set to $currentLanguage.")
+    }
+
+    override fun runTask3() {}
+}
+
+class LanguageCheckException(msg: String) : GradleException(msg)

Original file line number	Diff line number	Diff line change
`@@ -5,5 +5,6 @@ open class TestDeviceManagerExtension {`
`5`	`5`	`var pin: String = ""`
`6`	`6`	`var password: String = ""`
`7`	`7`	`var wifi: String = ""`
	`8`	`+ var language: String = ""`
`8`	`9`	`}`
`9`	`10`