Merge pull request #9 from spring-media/feature/check_and_set_language_task

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

Author: paulinabls

README.md

@@ -21,12 +21,16 @@ The following things are handled by the plugin:
 
 - Checking for connection to a specific WLAN - A check for a connection to a specific WLAN will be performed
 
+- checking language set on the device
+
+- setting language on the device - possible only when additional app is installed: AdbChangeLanguage available in Google Play: https://play.google.com/store/apps/details?id=net.sanapeli.adbchangelanguage
+
 # Integration into the project
 ## Groovy
 ### Plugins DSL
 ```
 plugins {
-  id "de.welt.apps.testdevicemanager" version "1.1"
+  id "de.welt.apps.testdevicemanager" version "1.2"
 }
 ```
 ### Legacy plugin application
@@ -38,7 +42,7 @@ buildscript {
     }
   }
   dependencies {
-    classpath "de.welt.apps:testdevicemanager:1.1"
+    classpath "de.welt.apps:testdevicemanager:1.2"
   }
 }
 
@@ -48,7 +52,7 @@ apply plugin: "de.welt.apps.testdevicemanager"
 ### Plugins DSL
 ```
 plugins {
-  id("de.welt.apps.testdevicemanager") version "1.1"
+  id("de.welt.apps.testdevicemanager") version "1.2"
 }
 ```
 ### Legacy plugin application
@@ -74,6 +78,7 @@ testDeviceManager {
     pin = "9999"
     password = "password"
     wifi = "wifi-name"
+    language = "en-US"
 }
 ```
 # Compatibility
@@ -93,9 +98,11 @@ The following tasks will be added to the ```device setup``` section of the gradl
 ```
 -connectedAnimationsDisable
 -connectedAnimationsEnable
+-connectedCheckLanguage
 -connectedCheckWifi
 -connectedDeviceLock
 -connectedDeviceUnlock
+-connectedSetLanguage
 -connectedStayAwakeDisable
 -connectedStayAwakeEnable
 ```

build.gradle

@@ -10,7 +10,7 @@ plugins {
 apply from: 'properties-loader.gradle'
 
 group 'de.welt.apps'
-version '1.1'
+version '1.2'
 
 repositories {
     mavenCentral()

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,5 @@
-#Wed Sep 19 10:24:55 CEST 2018
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.8-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.8-all.zip

src/main/kotlin/TestDeviceManagerExtension.kt

@@ -5,5 +5,6 @@ open class TestDeviceManagerExtension {
     var pin: String = ""
     var password: String = ""
     var wifi: String = ""
+    var language: String = ""
 }
 

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 {

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()

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)
         }
     }
 }

src/main/kotlin/tasks/CheckLanguageTask.kt

@@ -0,0 +1,22 @@
+package tasks
+
+import com.android.ddmlib.IDevice
+import tasks.internal.LanguageCheckException
+import tasks.internal.LanguageTask
+
+
+open class CheckLanguageTask : LanguageTask() {
+
+    init {
+        description = "check if specific locale is set as current language"
+    }
+
+    override fun runTask2(device: IDevice) {
+        if (hasLocaleDifferentThanExpected(device)) {
+            throw LanguageCheckException("Different language set on ${deviceWrapper.getDetails()}. " +
+                    "It's $currentLanguage, while $language was expected.")
+        }
+        println("Device ${deviceWrapper.getDetails()} has locale set to $currentLanguage.")
+    }
+
+}

src/main/kotlin/tasks/SetLanguageTask.kt

@@ -0,0 +1,29 @@
+package tasks
+
+import com.android.ddmlib.IDevice
+import org.gradle.api.GradleException
+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) {
+        if (!hasLocaleDifferentThanExpected(device)) return
+
+        val deviceDetails = deviceWrapper.getDetails()
+        println("Device $deviceDetails 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 $deviceDetails. " +
+                    "It's $languageAfterChange, while $language was expected.")
+        }
+        println("Device $deviceDetails has locale set to $language.")
+    }
+}

src/main/kotlin/tasks/internal/LanguageTask.kt

@@ -0,0 +1,35 @@
+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() {
+    protected lateinit var deviceWrapper: DeviceWrapper
+    protected lateinit var currentLanguage: String
+
+    @Input
+    lateinit var language: String
+
+    override fun runTask1() {
+        if (language.isBlank()) {
+            throw GradleException("No language provided in build script.")
+        }
+    }
+
+    override fun runTask2(device: IDevice) {
+        hasLocaleDifferentThanExpected(device)
+    }
+
+    protected fun hasLocaleDifferentThanExpected(device: IDevice) :Boolean {
+        deviceWrapper = DeviceWrapper(device, outputReceiverProvider)
+        currentLanguage = deviceWrapper.getLanguage()
+
+        return currentLanguage != language
+    }
+
+    override fun runTask3() {}
+}
+
+class LanguageCheckException(msg: String) : GradleException(msg)