Add optional timeout to android ShellCommand commands in client.

Enabling subprocess timeouts for ATP when running tests - Part 2

PiperOrigin-RevId: 329932433

Author: copybara-androidxtest

services/shellexecutor/java/androidx/test/services/shellexecutor/ShellCommandClient.java

@@ -68,7 +68,8 @@ public static synchronized InputStream execOnServer(
       String command,
       List<String> parameters,
       Map<String, String> shellEnv,
-      boolean executeThroughShell)
+      boolean executeThroughShell,
+      long timeoutMs)
       throws ClientNotConnected, IOException, RemoteException {
 
     if (TextUtils.isEmpty(command)) {
@@ -103,7 +104,14 @@ public static synchronized InputStream execOnServer(
     ParcelFileDescriptor[] pipe = ParcelFileDescriptor.createPipe();
 
     Command commandStub = Stub.asInterface(result.binder);
-    commandStub.execute(command, parameters, shellEnv, executeThroughShell, pipe[1]);
+    // Only use timeout version if timeout is greater than 0
+    if (timeoutMs > 0L) {
+      // NOTICE: this is not be supported on older versions of the Command server.
+      commandStub.executeWithTimeout(
+          command, parameters, shellEnv, executeThroughShell, pipe[1], timeoutMs);
+    } else {
+      commandStub.execute(command, parameters, shellEnv, executeThroughShell, pipe[1]);
+    }
 
     // Closes the write pipe client-side. Server-side to be closed by server.
     pipe[1].close();
@@ -129,10 +137,12 @@ public static synchronized String execOnServerSync(
       String command,
       List<String> parameters,
       Map<String, String> shellEnv,
-      boolean executeThroughShell)
+      boolean executeThroughShell,
+      long timeoutMs)
       throws ClientNotConnected, IOException, RemoteException {
     return inputStreamToString(
-        execOnServer(context, secret, command, parameters, shellEnv, executeThroughShell));
+        execOnServer(
+            context, secret, command, parameters, shellEnv, executeThroughShell, timeoutMs));
   }
 
   private static String inputStreamToString(InputStream inputStream) throws IOException {

services/shellexecutor/java/androidx/test/services/shellexecutor/ShellExecutor.java

@@ -38,7 +38,28 @@ public interface ShellExecutor {
    * @param shellEnv A {@link Map} of shell environment variables to be set
    * @param executeThroughShell If set to true, the command string will be executed through the
    *     shell with parameters given as additional shell arguments.
-   * @return @link{String} representing the contents of the shell output of the command.
+   * @param timeoutMs Optional, destroys the executing subprocess if it runs longer than this
+   *     timeout.
+   * @return {@link String} representing the contents of the shell output of the command.
+   * @throws IOException if cannot execute command on executor service.
+   */
+  String executeShellCommandSync(
+      String command,
+      List<String> parameters,
+      Map<String, String> shellEnv,
+      boolean executeThroughShell,
+      long timeoutMs)
+      throws ClientNotConnected, IOException, RemoteException;
+
+  /**
+   * Execute a command with elevated permissions and block.
+   *
+   * @param command The shell command to be executed.
+   * @param parameters A {@link Map} parameters to be given to the shell command
+   * @param shellEnv A {@link Map} of shell environment variables to be set
+   * @param executeThroughShell If set to true, the command string will be executed through the
+   *     shell with parameters given as additional shell arguments.
+   * @return {@link String} representing the contents of the shell output of the command.
    * @throws IOException if cannot execute command on executor service.
    */
   String executeShellCommandSync(
@@ -56,7 +77,28 @@ String executeShellCommandSync(
    * @param shellEnv A {@link Map} of shell environment variables to be set
    * @param executeThroughShell If set to true, the command string will be executed through the
    *     shell with parameters given as additional shell arguments.
-   * @return @link{java.io.InputStream} representing the shell output of the command.
+   * @param timeoutMs Optional, destroys the executing subprocess if it runs longer than this
+   *     timeout.
+   * @return {@link java.io.InputStream} representing the shell output of the command.
+   * @throws IOException if cannot execute command on executor service.
+   */
+  InputStream executeShellCommand(
+      String command,
+      List<String> parameters,
+      Map<String, String> shellEnv,
+      boolean executeThroughShell,
+      long timeoutMs)
+      throws ClientNotConnected, IOException, RemoteException;
+
+  /**
+   * Execute a command with elevated permissions and return immediately.
+   *
+   * @param command The shell command to be executed.
+   * @param parameters A {@link Map} parameters to be given to the shell command
+   * @param shellEnv A {@link Map} of shell environment variables to be set
+   * @param executeThroughShell If set to true, the command string will be executed through the
+   *     shell with parameters given as additional shell arguments.
+   * @return {@link java.io.InputStream} representing the shell output of the command.
    * @throws IOException if cannot execute command on executor service.
    */
   InputStream executeShellCommand(

services/shellexecutor/java/androidx/test/services/shellexecutor/ShellExecutorImpl.java

@@ -50,11 +50,12 @@ public String executeShellCommandSync(
       String command,
       List<String> parameters,
       Map<String, String> shellEnv,
-      boolean executeThroughShell)
+      boolean executeThroughShell,
+      long timeoutMs)
       throws IOException {
     try {
       return ShellCommandClient.execOnServerSync(
-          context, binderKey, command, parameters, shellEnv, executeThroughShell);
+          context, binderKey, command, parameters, shellEnv, executeThroughShell, timeoutMs);
     } catch (ClientNotConnected e) {
       Log.e(TAG, "ShellCommandClient not connected. Is ShellCommandExecutor service started?", e);
       throw new RuntimeException(e);
@@ -67,15 +68,27 @@ public String executeShellCommandSync(
 
   /** {@inheritDoc} */
   @Override
-  public InputStream executeShellCommand(
+  public String executeShellCommandSync(
       String command,
       List<String> parameters,
       Map<String, String> shellEnv,
       boolean executeThroughShell)
+      throws IOException {
+    return executeShellCommandSync(command, parameters, shellEnv, executeThroughShell, 0L);
+  }
+
+  /** {@inheritDoc} */
+  @Override
+  public InputStream executeShellCommand(
+      String command,
+      List<String> parameters,
+      Map<String, String> shellEnv,
+      boolean executeThroughShell,
+      long timeoutMs)
       throws IOException, RemoteException {
     try {
       return ShellCommandClient.execOnServer(
-          context, binderKey, command, parameters, shellEnv, executeThroughShell);
+          context, binderKey, command, parameters, shellEnv, executeThroughShell, timeoutMs);
     } catch (ClientNotConnected e) {
       Log.e(TAG, "ShellCommandClient not connected. Is ShellCommandExecutor service started?", e);
       throw new RuntimeException(e);
@@ -85,4 +98,15 @@ public InputStream executeShellCommand(
       throw new RuntimeException(e);
     }
   }
+
+  /** {@inheritDoc} */
+  @Override
+  public InputStream executeShellCommand(
+      String command,
+      List<String> parameters,
+      Map<String, String> shellEnv,
+      boolean executeThroughShell)
+      throws IOException, RemoteException {
+    return executeShellCommand(command, parameters, shellEnv, executeThroughShell, 0L);
+  }
 }

services/shellexecutor/javatests/androidx/test/services/shellexecutor/ShellCommandClientTest.java

@@ -35,7 +35,7 @@ public class ShellCommandClientTest {
   public void testBlankCommand()
       throws ClientNotConnected, IOException, RemoteException, InterruptedException {
     try {
-      ShellCommandClient.execOnServer(getTargetContext(), "secret", "", null, null, false);
+      ShellCommandClient.execOnServer(getTargetContext(), "secret", "", null, null, false, 0L);
       fail("Passing blank command should throw IllegalArgumentException");
     } catch (IllegalArgumentException expected) {
       // Pass
@@ -46,7 +46,7 @@ public void testBlankCommand()
   public void testNullCommand()
       throws ClientNotConnected, IOException, RemoteException, InterruptedException {
     try {
-      ShellCommandClient.execOnServer(getTargetContext(), "secret", null, null, null, false);
+      ShellCommandClient.execOnServer(getTargetContext(), "secret", null, null, null, false, 0L);
       fail("Passing null command should throw IllegalArgumentException");
     } catch (IllegalArgumentException expected) {
       // Pass
@@ -57,7 +57,8 @@ public void testNullCommand()
   public void testShellClientNoRunOnMainThread()
       throws ClientNotConnected, IOException, RemoteException, InterruptedException {
     try {
-      ShellCommandClient.execOnServer(getTargetContext(), "secret", "command", null, null, false);
+      ShellCommandClient.execOnServer(
+          getTargetContext(), "secret", "command", null, null, false, 0L);
       fail("Calling execServer on main thread should throw exception");
     } catch (IllegalStateException expected) {
       // Pass

services/shellexecutor/javatests/androidx/test/services/shellexecutor/ShellCommandTest.java

@@ -53,7 +53,8 @@ private static String execShellCommand(
         command,
         params,
         env,
-        executeThroughShell);
+        executeThroughShell,
+        0L);
   }
 
   @Test
@@ -127,7 +128,8 @@ public void testLargeFileDump() throws Exception {
             "dd if=/dev/urandom bs=2048 count=16384",
             null,
             null,
-            true);
+            true,
+            0L);
 
     boolean weReadSomething = false;