ISSUE-576: Allow complex ADB server commands execution

adb-server/adb-server-command-types/src/main/java/com/kaspersky/adbserver/commandtypes/AdbCommand.kt

@@ -2,4 +2,4 @@ package com.kaspersky.adbserver.commandtypes
 
 import com.kaspersky.adbserver.common.api.Command
 
-data class AdbCommand(override val body: String) : Command(body)
+data class AdbCommand(val command: String) : Command(command)

adb-server/adb-server-command-types/src/main/java/com/kaspersky/adbserver/commandtypes/CmdCommand.kt

@@ -2,4 +2,4 @@ package com.kaspersky.adbserver.commandtypes
 
 import com.kaspersky.adbserver.common.api.Command
 
-data class CmdCommand(override val body: String) : Command(body)
+data class CmdCommand(val command: String) : Command(command)

adb-server/adb-server-command-types/src/main/java/com/kaspersky/adbserver/commandtypes/ComplexAdbCommand.kt

@@ -0,0 +1,5 @@
+package com.kaspersky.adbserver.commandtypes
+
+import com.kaspersky.adbserver.common.api.Command
+
+data class ComplexAdbCommand(override val body: List<String>) : Command(body)

adb-server/adb-server-command-types/src/main/java/com/kaspersky/adbserver/commandtypes/ComplexCmdCommand.kt

@@ -0,0 +1,5 @@
+package com.kaspersky.adbserver.commandtypes
+
+import com.kaspersky.adbserver.common.api.Command
+
+data class ComplexCmdCommand(override val body: List<String>) : Command(body)

adb-server/adb-server-common/src/main/java/com/kaspersky/adbserver/common/api/Command.kt

@@ -5,4 +5,14 @@ import java.io.Serializable
 /**
  * Command to execute by AdbServer
  */
-abstract class Command(open val body: String) : Serializable
+abstract class Command : Serializable {
+    open val body: List<String>
+
+    constructor(body: List<String>) {
+        this.body = body
+    }
+
+    constructor(body: String) {
+        this.body = listOf(body)
+    }
+}

adb-server/adb-server-device/src/main/java/com/kaspersky/adbserver/device/AdbTerminal.kt

@@ -3,6 +3,8 @@ package com.kaspersky.adbserver.device
 import com.kaspersky.adbserver.common.api.CommandResult
 import com.kaspersky.adbserver.commandtypes.AdbCommand
 import com.kaspersky.adbserver.commandtypes.CmdCommand
+import com.kaspersky.adbserver.commandtypes.ComplexAdbCommand
+import com.kaspersky.adbserver.commandtypes.ComplexCmdCommand
 import com.kaspersky.adbserver.common.log.LoggerFactory
 import com.kaspersky.adbserver.common.log.logger.LogLevel
 import com.kaspersky.adbserver.common.log.logger.Logger
@@ -27,10 +29,32 @@ object AdbTerminal {
         AdbCommand(command)
     ) ?: throw IllegalStateException("Please first of all call [connect] method to establish a connection")
 
+    /**
+     * Allows more control over how arguments are parsed. Each list element is a command or an argument used as is.
+     * Refer to the https://docs.oracle.com/javase/8/docs/api/java/lang/ProcessBuilder.html
+     *
+     * @param command the list of the commands and arguments
+     * Please first of all call [connect] method to establish a connection
+     */
+    fun executeAdb(command: List<String>): CommandResult = device?.fulfill(
+        ComplexAdbCommand(command)
+    ) ?: throw IllegalStateException("Please first of all call [connect] method to establish a connection")
+
     /**
      * Please first of all call [connect] method to establish a connection
      */
     fun executeCmd(command: String): CommandResult = device?.fulfill(
         CmdCommand(command)
     ) ?: throw IllegalStateException("Please first of all call [connect] method to establish a connection")
+
+    /**
+     * Allows more control over how arguments are parsed. Each list element is a command or an argument used as is.
+     * Refer to the https://docs.oracle.com/javase/8/docs/api/java/lang/ProcessBuilder.html
+     *
+     * @param command the list of the commands and arguments
+     * Please first of all call [connect] method to establish a connection
+     */
+    fun executeCmd(command: List<String>): CommandResult = device?.fulfill(
+        ComplexCmdCommand(command)
+    ) ?: throw IllegalStateException("Please first of all call [connect] method to establish a connection")
 }

adb-server/adbserver-desktop/src/main/java/com/kaspersky/adbserver/desktop/CmdCommandPerformer.kt

@@ -46,4 +46,39 @@ internal class CmdCommandPerformer(
             process.destroy()
         }
     }
+
+    /**
+     * Be aware it's a synchronous method
+     */
+    fun perform(command: List<String>): CommandResult {
+        val serviceInfo = "The command was executed on desktop=$desktopName"
+        val process = ProcessBuilder(command).start()
+        try {
+            if (process.waitFor(EXECUTION_TIMEOUT_SECONDS, TimeUnit.SECONDS)) {
+                val exitCode = process.exitValue()
+                return if (exitCode != 0) {
+                    val error = "exitCode=$exitCode, message=${process.errorStream.bufferedReader().readText()}"
+                    CommandResult(
+                        status = ExecutorResultStatus.FAILURE,
+                        description = error,
+                        serviceInfo = serviceInfo
+                    )
+                } else {
+                    val success = "exitCode=$exitCode, message=${process.inputStream.bufferedReader().readText()}"
+                    CommandResult(
+                        status = ExecutorResultStatus.SUCCESS,
+                        description = success,
+                        serviceInfo = serviceInfo
+                    )
+                }
+            }
+            return CommandResult(
+                status = ExecutorResultStatus.TIMEOUT,
+                description = "Command execution timeout ($EXECUTION_TIMEOUT_SECONDS sec) overhead",
+                serviceInfo = serviceInfo
+            )
+        } finally {
+            process.destroy()
+        }
+    }
 }

adb-server/adbserver-desktop/src/main/java/com/kaspersky/adbserver/desktop/CommandExecutorImpl.kt

@@ -5,6 +5,8 @@ import com.kaspersky.adbserver.common.api.CommandExecutor
 import com.kaspersky.adbserver.common.api.CommandResult
 import com.kaspersky.adbserver.commandtypes.AdbCommand
 import com.kaspersky.adbserver.commandtypes.CmdCommand
+import com.kaspersky.adbserver.commandtypes.ComplexAdbCommand
+import com.kaspersky.adbserver.commandtypes.ComplexCmdCommand
 import com.kaspersky.adbserver.common.log.logger.Logger
 import java.lang.UnsupportedOperationException
 
@@ -18,12 +20,32 @@ internal class CommandExecutorImpl(
 
     override fun execute(command: Command): CommandResult {
         return when (command) {
-            is CmdCommand -> cmdCommandPerformer.perform(command.body)
+            is CmdCommand -> cmdCommandPerformer.perform(command.command)
+            is ComplexCmdCommand -> cmdCommandPerformer.perform(command.body)
+
             is AdbCommand -> {
-                val adbCommand = "$adbPath ${ adbServerPort?.let { "-P $adbServerPort " } ?: "" }-s $deviceName ${command.body}"
+                val adbCommand = "$adbPath ${adbServerPort?.let { "-P $adbServerPort " } ?: ""}-s $deviceName ${command.command}"
                 logger.d("The created adbCommand=$adbCommand")
                 cmdCommandPerformer.perform(adbCommand)
             }
+
+            is ComplexAdbCommand -> {
+
+                val adbCommand = buildList {
+                    add(adbPath)
+                    adbServerPort?.let {
+                        add("-P")
+                        add(adbServerPort)
+                    }
+                    add("-s")
+                    add(deviceName)
+
+                    addAll(command.body)
+                }
+                logger.d("The created complex adbCommand=$adbCommand")
+                cmdCommandPerformer.perform(adbCommand)
+            }
+
             else -> throw UnsupportedOperationException("The command=$command is unsupported command")
         }
     }

kaspresso/src/main/kotlin/com/kaspersky/kaspresso/device/server/AdbServer.kt

@@ -26,6 +26,20 @@ interface AdbServer {
      */
     fun performCmd(vararg commands: String): List<String>
 
+    /**
+     * Performs shell commands blocking current thread. Allows more control over how arguments are parsed.
+     * Each list element is used as is. Refer to the https://docs.oracle.com/javase/8/docs/api/java/lang/ProcessBuilder.html.
+     *
+     * Please be aware! If any command that is in @param commands failed then AdbServerException will be thrown
+     *
+     * Required Permissions: INTERNET.
+     *
+     * @param commands commands to execute.
+     * @throws AdbServerException if a result status of any command in @param commands is Failed
+     * @return list of answers of commands' execution
+     */
+    fun performCmd(command: List<String>): String
+
     /**
      * Performs adb commands blocking current thread.
      * Please be aware! If any command that is in @param commands failed then AdbServerException will be thrown
@@ -38,6 +52,20 @@ interface AdbServer {
      */
     fun performAdb(vararg commands: String): List<String>
 
+    /**
+     * Performs adb commands blocking current thread. Allows more control over how arguments are parsed.
+     * Each list element is used as is. Refer to the https://docs.oracle.com/javase/8/docs/api/java/lang/ProcessBuilder.html.
+     *
+     * Please be aware! If any command that is in @param commands failed then AdbServerException will be thrown
+     *
+     * Required Permissions: INTERNET.
+     *
+     * @param commands commands to execute.
+     * @throws AdbServerException if a result status of any command in @param commands is Failed
+     * @return list of answers of commands' execution
+     */
+    fun performAdb(command: List<String>): String
+
     /**
      * Performs shell commands blocking current thread.
      * Please be aware! If any command that is in @param commands failed then AdbServerException will be thrown
@@ -50,6 +78,20 @@ interface AdbServer {
      */
     fun performShell(vararg commands: String): List<String>
 
+    /**
+     * Performs shell commands blocking current thread. Allows more control over how arguments are parsed.
+     * Each list element is used as is. Refer to the https://docs.oracle.com/javase/8/docs/api/java/lang/ProcessBuilder.html.
+     *
+     * Please be aware! If any command that is in @param commands failed then AdbServerException will be thrown
+     *
+     * Required Permissions: INTERNET.
+     *
+     * @param commands commands to execute.
+     * @throws AdbServerException if a result status of any command in @param commands is Failed
+     * @return list of answers of commands' execution
+     */
+    fun performShell(command: List<String>): String
+
     /**
      * Disconnect from AdbServer.
      * The method is called by Kaspresso after each test.

kaspresso/src/main/kotlin/com/kaspersky/kaspresso/device/server/AdbServerImpl.kt

@@ -30,58 +30,41 @@ class AdbServerImpl(
             return AdbTerminal
         }
 
-    /**
-     * Executes shell commands blocking current thread.
-     * Please be aware! If any command that is in @param commands failed then AdbServerException will be thrown
-     *
-     * Required Permissions: INTERNET.
-     *
-     * @param commands commands to execute.
-     * @throws AdbServerException if a result status of any command in @param commands is Failed
-     * @return list of answers of commands' execution
-     */
     override fun performCmd(vararg commands: String): List<String> {
         return perform(commands) {
             adbTerminal.executeCmd(it)
         }
     }
 
-    /**
-     * Performs adb commands blocking current thread.
-     * Please be aware! If any command that is in @param commands failed then AdbServerException will be thrown
-     *
-     * Required Permissions: INTERNET.
-     *
-     * @param commands commands to execute.
-     * @throws AdbServerException if a result status of any command in @param commands is Failed
-     * @return list of answers of commands' execution
-     */
+    override fun performCmd(command: List<String>): String {
+        return performComplex(command, adbTerminal::executeCmd)
+    }
+
     override fun performAdb(vararg commands: String): List<String> {
         return perform(commands) {
             adbTerminal.executeAdb(it)
         }
     }
 
-    /**
-     * Performs shell commands blocking current thread.
-     * Please be aware! If any command that is in @param commands failed then AdbServerException will be thrown
-     *
-     * Required Permissions: INTERNET.
-     *
-     * @param commands commands to execute.
-     * @throws AdbServerException if a result status of any command in @param commands is Failed
-     * @return list of answers of commands' execution
-     */
+    override fun performAdb(command: List<String>): String {
+        return performComplex(command, adbTerminal::executeAdb)
+    }
+
     override fun performShell(vararg commands: String): List<String> {
         return perform(commands) {
             adbTerminal.executeAdb("shell $it")
         }
     }
 
-    /**
-     * Disconnect from AdbServer.
-     * The method is called by Kaspresso after each test.
-     */
+    override fun performShell(command: List<String>): String {
+        return performComplex(command) { complexCommand: List<String> ->
+            adbTerminal.executeAdb(buildList {
+                add("shell")
+                addAll(complexCommand)
+            })
+        }
+    }
+
     override fun disconnectServer() {
         if (connected) {
             adbTerminal.disconnect()
@@ -95,16 +78,27 @@ class AdbServerImpl(
                 logger.i("AdbServer. The command to execute=$command")
             }
             .map { command -> command to executor.invoke(command) }
-            .onEach { (command, result) ->
-                logger.i("AdbServer. The command=$command was performed with result=$result")
-            }
-            .onEach { (command, result) ->
-                if (result.status == ExecutorResultStatus.FAILURE) {
-                    throw AdbServerException("AdbServer. The command=$command was performed with failed result=$result")
-                }
-                if (result.status == ExecutorResultStatus.TIMEOUT) {
-                    throw AdbServerException(
-                        """
+            .onEach { (command, result) -> logCommandResult(command, result) }
+            .map { (_, result) -> result.description }
+            .toList()
+    }
+
+    private fun performComplex(command: List<String>, executor: (List<String>) -> CommandResult): String {
+        logger.i("AdbServer. The complex command to execute=$command")
+        val result = executor.invoke(command)
+        logCommandResult(command.toString(), result)
+
+        return result.description
+    }
+
+    private fun logCommandResult(command: String, result: CommandResult) {
+        logger.i("AdbServer. The command=$command was performed with result=$result")
+        if (result.status == ExecutorResultStatus.FAILURE) {
+            throw AdbServerException("AdbServer. The command=$command was performed with failed result=$result")
+        }
+        if (result.status == ExecutorResultStatus.TIMEOUT) {
+            throw AdbServerException(
+                """
 
                             AdbServer. The command=$command was performed with timeout exception.
                             There are two possible reasons:
@@ -122,10 +116,7 @@ class AdbServerImpl(
                                 c. Start 'adbserver-desktop.jar' with the command in Terminal - 'java -jar /Users/yuri.gagarin/Desktop/adbserver-desktop.jar
 
                         """.trimIndent()
-                    )
-                }
-            }
-            .map { (_, result) -> result.description }
-            .toList()
+            )
+        }
     }
 }