Check initial device state in FlatModeAction and ClosedModeAction and return if the device is already in the requested device mode

PiperOrigin-RevId: 534474498

Author: Paige McAuliffe

espresso/device/java/androidx/test/espresso/device/action/ClosedModeAction.kt

@@ -16,16 +16,30 @@
 
 package androidx.test.espresso.device.action
 
+import android.util.Log
 import androidx.test.espresso.device.context.ActionContext
 import androidx.test.espresso.device.controller.DeviceMode
+import androidx.test.espresso.device.util.executeShellCommand
+import androidx.test.espresso.device.util.getMapOfDeviceStateNamesToIdentifiers
 import androidx.test.platform.device.DeviceController
 import java.util.concurrent.Executor
 
 /** Action to set the test device to be closed. */
 internal class ClosedModeAction(private val mainExecutor: Executor) :
   BaseSingleFoldDeviceAction(DeviceMode.CLOSED, null, mainExecutor) {
   override fun perform(context: ActionContext, deviceController: DeviceController) {
-    // TODO(b/203801760): Check current device mode and return if already in closed mode.
+    val currentDeviceStateIdentifier = executeShellCommand("cmd device_state print-state").trim()
+    if (currentDeviceStateIdentifier == getMapOfDeviceStateNamesToIdentifiers().get("CLOSED")) {
+      if (Log.isLoggable(TAG, Log.DEBUG)) {
+        Log.d(TAG, "Device is already in closed mode.")
+      }
+      return
+    }
+
     super.perform(context, deviceController)
   }
+
+  companion object {
+    private val TAG = ClosedModeAction::class.java.simpleName
+  }
 }

espresso/device/java/androidx/test/espresso/device/action/FlatModeAction.kt

@@ -16,8 +16,11 @@
 
 package androidx.test.espresso.device.action
 
+import android.util.Log
 import androidx.test.espresso.device.context.ActionContext
 import androidx.test.espresso.device.controller.DeviceMode
+import androidx.test.espresso.device.util.executeShellCommand
+import androidx.test.espresso.device.util.getMapOfDeviceStateNamesToIdentifiers
 import androidx.test.platform.device.DeviceController
 import androidx.window.layout.FoldingFeature
 import java.util.concurrent.Executor
@@ -26,7 +29,18 @@ import java.util.concurrent.Executor
 internal class FlatModeAction(private val mainExecutor: Executor) :
   BaseSingleFoldDeviceAction(DeviceMode.FLAT, FoldingFeature.State.FLAT, mainExecutor) {
   override fun perform(context: ActionContext, deviceController: DeviceController) {
-    // TODO(b/203801760): Check current device mode and return if already in flat mode.
+    val currentDeviceStateIdentifier = executeShellCommand("cmd device_state print-state").trim()
+    if (currentDeviceStateIdentifier == getMapOfDeviceStateNamesToIdentifiers().get("OPENED")) {
+      if (Log.isLoggable(TAG, Log.DEBUG)) {
+        Log.d(TAG, "Device is already in flat mode.")
+      }
+      return
+    }
+
     super.perform(context, deviceController)
   }
+
+  companion object {
+    private val TAG = FlatModeAction::class.java.simpleName
+  }
 }

espresso/device/java/androidx/test/espresso/device/util/DeviceUtil.kt

@@ -20,6 +20,7 @@ package androidx.test.espresso.device.util
 
 import android.os.Build
 import androidx.annotation.RestrictTo
+import java.util.regex.Pattern
 
 /** Collection of utility methods for getting information about the test device. */
 
@@ -57,3 +58,56 @@ fun isRobolectricTest(): Boolean {
 fun getDeviceApiLevel(): Int {
   return Build.VERSION.SDK_INT
 }
+
+/**
+ * Maps device state names to identifiers by processing the output of "device_state print-states"
+ *
+ * The output of "cmd device_state print-states" contains names and identifiers of supported device
+ * states, as shown below.
+ * [ DeviceState{identifier=1, name='CLOSED'}, DeviceState{identifier=2, name='HALF_OPENED'}, DeviceState{identifier=3, name='OPENED'}, ]
+ * This method returns a map where the keys are the device state names and the values are the device
+ * state identifiers.
+ *
+ * @hide
+ */
+@RestrictTo(RestrictTo.Scope.LIBRARY)
+fun getMapOfDeviceStateNamesToIdentifiers(): MutableMap<String, String> {
+  if (getDeviceApiLevel() < 24) {
+    // Executing shell commands requires API 24+. There are no foldable devices with API 23 or
+    // below, so return an empty map.
+    return mutableMapOf()
+  }
+  val deviceStateNameToIdentifier: MutableMap<String, String> = mutableMapOf()
+  // Regex pattern that matches supported states, e.g. DeviceState{identifier=1, name='CLOSED',
+  // app_accessible=true}
+  val DEVICE_STATE_PATTERN_EXTRA_PARAMS: Pattern =
+    Pattern.compile("DeviceState\\{identifier=(?<identifier>\\d+), name='(?<name>\\w+?)'.+?\\}")
+  // Regex pattern that matches supported states, e.g. DeviceState{identifier=1, name='CLOSED'}
+  val DEVICE_STATE_PATTERN_NO_EXTRA_PARAMS: Pattern =
+    Pattern.compile("DeviceState\\{identifier=(?<identifier>\\d+), name='(?<name>\\w+?)'\\}")
+  val supportedDeviceStates = listOf("CLOSED", "HALF_OPENED", "OPENED")
+
+  val printedStates = executeShellCommand("cmd device_state print-states")
+  val lines = printedStates.split("\n")
+  for (line in lines) {
+    val matcherExtraParams = DEVICE_STATE_PATTERN_EXTRA_PARAMS.matcher(line)
+    val matcherNoExtraParams = DEVICE_STATE_PATTERN_NO_EXTRA_PARAMS.matcher(line)
+    var deviceStateName: String? = null
+    var deviceStateIdentifier: String? = null
+    if (matcherExtraParams.find()) {
+      deviceStateName = matcherExtraParams.group("name")
+      deviceStateIdentifier = matcherExtraParams.group("identifier")
+    } else if (matcherNoExtraParams.find()) {
+      deviceStateName = matcherNoExtraParams.group("name")
+      deviceStateIdentifier = matcherNoExtraParams.group("identifier")
+    }
+    if (
+      deviceStateName != null &&
+        deviceStateIdentifier != null &&
+        deviceStateName in supportedDeviceStates
+    ) {
+      deviceStateNameToIdentifier.put(deviceStateName, deviceStateIdentifier)
+    }
+  }
+  return deviceStateNameToIdentifier
+}