PT-429: input scripting

README.md

@@ -1,10 +1,12 @@
-# gradle-android-command-plugin 
+gradle-android-command-plugin
+=============================
 [![](https://ci.novoda.com/buildStatus/icon?job=gradle-android-command-plugin)](https://ci.novoda.com/job/gradle-android-command-plugin/lastSuccessfulBuild/console) [![](https://raw.githubusercontent.com/novoda/novoda/master/assets/btn_apache_lisence.png)](LICENSE.txt) [![Bintray](https://api.bintray.com/packages/novoda/maven/gradle-android-command-plugin/images/download.svg) ](https://bintray.com/novoda/maven/gradle-android-command-plugin/_latestVersion)
 
 Use gradle tasks to run specific `adb` commands.
 
 
-## Description
+Description
+-----------
 
 You can use this plugin to do things such as:
 
@@ -18,7 +20,8 @@ You can use this plugin to do things such as:
 This is particularly useful for CI servers but could be used to speed up development as well.
 
 
-## Adding to your project
+Adding to your project
+----------------------
 
 To start using this library, add these lines to the `build.gradle` of your project:
 
@@ -37,7 +40,8 @@ buildscript {
 ```
 
 
-## Simple usage
+Simple usage
+------------
 
 The plugin creates new tasks that you can use:
 
@@ -53,7 +57,53 @@ The plugin creates new tasks that you can use:
 
 For advanced usage please take a look into the sample project [build.gradle](sample/app/build.gradle) file.
 
-## Links
+Configuration
+-------------
+
+### Input Scripting
+
+The plugin has a extension called `script` which allows you to do simple scripting automation in a connected device.
+Here is an example called `autoLogin` which will input the test username and password into the sample app.
+
+```groovy
+scripts {
+    autoLogin {
+        execute {
+          2.times {
+              text 'bob'
+              enter()
+          }
+          enter()
+        }
+    }
+}
+```
+
+This config will create a gradle task called `autoLogin`. Running `./gradlew autoLogin` will try to input `bob` then press `enter`. This will be done 2 times and then another `enter` will be pressed.
+
+You may have a custom groovy closure to do scripting as you like. The following input methods are available:
+
+```
+text(String value)
+tap(int x, int y)
+swipe(int startX, int startY, int endX, int endY)
+key(int code)
+home()
+back()
+up()
+down()
+left()
+right()
+clear()
+tab()
+enter()
+power()
+unlock()
+```
+
+
+Links
+-----
 
 Here are a list of useful links:
 

plugin/src/main/groovy/com/novoda/gradle/command/AndroidCommandPlugin.groovy

@@ -26,6 +26,8 @@ public class AndroidCommandPlugin implements Plugin<Project> {
             conventionMapping.monkey = { extension.monkey }
         }
 
+        configureInputScripts(extension, project)
+
         defaultTask (project, 'enableSystemAnimations', 'enables system animations on the connected device', SystemAnimations) {
             enable = true
         }
@@ -38,7 +40,17 @@ public class AndroidCommandPlugin implements Plugin<Project> {
         }
     }
 
-    static def defaultTask(Project project, String taskName, String description, Class<? extends AdbTask> taskType, Closure configuration) {
+    private configureInputScripts(AndroidCommandPluginExtension extension, Project project) {
+        extension.scripts.all { input ->
+            project.tasks.create(input.name, Input) {
+                group = 'adb script'
+                description = "Runs $input.name script on the specified device"
+                inputSpec = input
+            }
+        }
+    }
+
+    static defaultTask(Project project, String taskName, String description, Class<? extends AdbTask> taskType, Closure configuration) {
         AdbTask task = project.tasks.create(taskName, taskType)
         task.configure configuration
         task.group = TASK_GROUP

plugin/src/main/groovy/com/novoda/gradle/command/AndroidCommandPluginExtension.groovy

@@ -2,6 +2,7 @@ package com.novoda.gradle.command
 
 import groovy.transform.Memoized
 import org.gradle.api.Action
+import org.gradle.api.NamedDomainObjectContainer
 import org.gradle.api.Project
 
 public class AndroidCommandPluginExtension {
@@ -14,6 +15,7 @@ public class AndroidCommandPluginExtension {
     private final Project project
     private final String androidHome
     private final MonkeySpec monkey
+    private final NamedDomainObjectContainer<InputSpec> scripts
 
     AndroidCommandPluginExtension(Project project) {
         this(project, findAndroidHomeFrom(project.android))
@@ -23,6 +25,7 @@ public class AndroidCommandPluginExtension {
         this.project = project
         this.androidHome = androidHome
         this.monkey = new MonkeySpec()
+        this.scripts = project.container(InputSpec)
     }
 
     def task(String name, Class<? extends AdbTask> type, Closure configuration) {
@@ -83,6 +86,14 @@ public class AndroidCommandPluginExtension {
         monkey
     }
 
+    void scripts(Closure script) {
+        scripts.configure(script)
+    }
+
+    NamedDomainObjectContainer<InputSpec> getScripts() {
+        scripts
+    }
+
     void attachDefaults(AdbTask task) {
         task.conventionMapping.adb = { getAdb() }
         task.conventionMapping.aapt = { getAapt() }

plugin/src/main/groovy/com/novoda/gradle/command/Input.groovy

@@ -4,7 +4,23 @@ import org.gradle.api.tasks.TaskAction
 
 class Input extends AdbTask {
 
-    Closure script
+    InputSpec inputSpec
+
+    /**
+     * Manual creation of Input task is deprecated.
+     * Please refer to scripting documentation for details:
+     * https://github.com/novoda/gradle-android-command-plugin#input-scripting
+     */
+    @Deprecated
+    void setScript(Closure script) {
+        logger.warn """\
+                       Manual creation of Input task is deprecated.
+                       Please refer to scripting documentation to modify your task '$name'
+                       https://github.com/novoda/gradle-android-command-plugin#input-scripting
+                       """.stripIndent()
+        inputSpec = new InputSpec()
+        inputSpec.script = script
+    }
 
     void text(String value) {
         input('text', "$value")
@@ -21,11 +37,11 @@ class Input extends AdbTask {
     void key(int code) {
         input('keyevent', code)
     }
-    
+
     void home() {
         key 3
     }
-    
+
     void back() {
         key 4
     }
@@ -37,7 +53,7 @@ class Input extends AdbTask {
     void down() {
         key 20
     }
-    
+
     void left() {
         key 21
     }
@@ -49,15 +65,15 @@ class Input extends AdbTask {
     void power() {
         key 26
     }
-    
+
     void clear() {
         key 28
     }
 
     void tab() {
         key 61
     }
-    
+
     void enter() {
         key 66
     }
@@ -67,14 +83,13 @@ class Input extends AdbTask {
     }
 
     private input(... values) {
-        def command = ["shell", "input"]
-        command.addAll(values)
-        runCommand(command)
+        runCommand(['shell', 'input', *values])
     }
 
     @TaskAction
     void exec() {
         assertDeviceConnected()
-        script.call()
+        inputSpec.script.delegate = this
+        inputSpec.script.call()
     }
 }

plugin/src/main/groovy/com/novoda/gradle/command/InputSpec.groovy

@@ -0,0 +1,16 @@
+package com.novoda.gradle.command
+
+class InputSpec {
+
+    String name
+    Closure script
+
+    InputSpec(name) {
+        this.name = name
+    }
+
+    void execute(script) {
+        this.script = script
+    }
+
+}

sample/app/build.gradle

@@ -99,13 +99,19 @@ android {
             }
         }
 
-        task autoLogin(type: com.novoda.gradle.command.Input) {
-            script {
-                2.times {
-                    text 'bob'
+        scripts {
+            autoLogin {
+                execute {
+                    2.times {
+                        text 'bob'
+                        enter()
+                    }
                     enter()
                 }
-                enter()
+            }
+
+            pressBack.execute {
+                back()
             }
         }