Merge "Add UserUtils class" into rvc-dev am: a5a22153c1 am: 29de8489dd am: 77ea2fc89a am: b55ddcffce

Original change: https://googleplex-android-review.googlesource.com/c/platform/platform_testing/+/23694745

Change-Id: Ib7dadcaf1acce5735dfbc4a9abd19e6febbf00e6
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>

1 files changed, 236 insertions, 0 deletions

diff --git a/libraries/sts-common-util/host-side/src/com/android/sts/common/UserUtils.java b/libraries/sts-common-util/host-side/src/com/android/sts/common/UserUtils.java
new file mode 100644
index 000000000..d654e2d58
--- /dev/null
+++ b/libraries/sts-common-util/host-side/src/com/android/sts/common/UserUtils.java
@@ -0,0 +1,236 @@
+/*
+ * Copyright (C) 2023 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.android.sts.common;
+
+import com.android.tradefed.device.ITestDevice;
+
+/** Util to manage secondary user */
+public class UserUtils {
+
+    public static class SecondaryUser {
+        private ITestDevice mDevice;
+        private String mName; // Name of the new user
+        private boolean mIsDemo; // User type : --demo
+        private boolean mIsEphemeral; // User type : --ephemeral
+        private boolean mIsForTesting; // User type : --for-testing
+        private boolean mIsGuest; // User type : --guest
+        private boolean mIsManaged; // User type : --managed
+        private boolean mIsPreCreateOnly; // User type : --pre-created-only
+        private boolean mIsRestricted; // User type : --restricted
+        private boolean mSwitch; // Switch to newly created user
+        private int mProfileOf; // Userid associated with managed user
+        private int mTestUserId;
+
+        /**
+         * Create an instance of secondary user.
+         *
+         * @param device the device {@link ITestDevice} to use.
+         * @throws IllegalArgumentException when {@code device} is null.
+         */
+        public SecondaryUser(ITestDevice device) throws IllegalArgumentException {
+            // Device should not be null
+            if (device == null) {
+                throw new IllegalArgumentException("Device should not be null");
+            }
+
+            mDevice = device;
+            mName = "testUser"; /* Default username */
+
+            // Set default value for all flags as false
+            mIsDemo = false;
+            mIsEphemeral = false;
+            mIsForTesting = false;
+            mIsGuest = false;
+            mIsManaged = false;
+            mIsPreCreateOnly = false;
+            mIsRestricted = false;
+            mSwitch = false;
+        }
+
+        /**
+         * Set the user type as demo.
+         *
+         * @return this object for method chaining.
+         */
+        public SecondaryUser demo() {
+            mIsDemo = true;
+            return this;
+        }
+
+        /**
+         * Set the user type as ephemeral.
+         *
+         * @return this object for method chaining.
+         */
+        public SecondaryUser ephemeral() {
+            mIsEphemeral = true;
+            return this;
+        }
+
+        /**
+         * Set the user type as for-testing.
+         *
+         * @return this object for method chaining.
+         */
+        public SecondaryUser forTesting() {
+            mIsForTesting = true;
+            return this;
+        }
+
+        /**
+         * Set the user type as guest.
+         *
+         * @return this object for method chaining.
+         */
+        public SecondaryUser guest() {
+            mIsGuest = true;
+            return this;
+        }
+
+        /**
+         * Set the user type as managed.
+         *
+         * @param profileOf value is set as the userid associated with managed user.
+         * @return this object for method chaining.
+         */
+        public SecondaryUser managed(int profileOf) {
+            mIsManaged = true;
+            mProfileOf = profileOf;
+            return this;
+        }
+
+        /**
+         * Set the user type as pre-created-only.
+         *
+         * @return this object for method chaining.
+         */
+        public SecondaryUser preCreateOnly() {
+            mIsPreCreateOnly = true;
+            return this;
+        }
+
+        /**
+         * Set the user type as restricted.
+         *
+         * @return this object for method chaining.
+         */
+        public SecondaryUser restricted() {
+            mIsRestricted = true;
+            return this;
+        }
+
+        /**
+         * Set the name of the new user.
+         *
+         * @param name value is set to name of the user.
+         * @return this object for method chaining.
+         * @throws IllegalArgumentException when {@code name} is null.
+         */
+        public SecondaryUser name(String name) throws IllegalArgumentException {
+            // The argument 'name' should not be null
+            if (mName == null) {
+                throw new IllegalArgumentException("The name of the user should not be null");
+            }
+
+            mName = name;
+            return this;
+        }
+
+        /**
+         * Set if switching to newly created user is required.
+         *
+         * @return this object for method chaining.
+         */
+        public SecondaryUser doSwitch() {
+            mSwitch = true;
+            return this;
+        }
+
+        /**
+         * Create a secondary user and if required, switch to it. Returns an Autocloseable that
+         * removes the secondary user.
+         *
+         * @return AutoCloseable that switches back to the caller user if required, and removes the
+         *     secondary user.
+         * @throws Exception
+         */
+        public AutoCloseable withUser() throws Exception {
+            // Fetch the caller's user id
+            final int callerUserId = mDevice.getCurrentUser();
+
+            // Command to create user
+            String command =
+                    "pm create-user "
+                            + (mIsDemo ? "--demo " : "")
+                            + (mIsEphemeral ? "--ephemeral " : "")
+                            + (mIsGuest ? "--guest " : "")
+                            + (mIsManaged ? ("--profileOf " + mProfileOf + " --managed ") : "")
+                            + (mIsPreCreateOnly ? "--pre-create-only " : "")
+                            + (mIsRestricted ? "--restricted " : "")
+                            + (mIsForTesting && mDevice.getApiLevel() >= 34 ? "--for-testing " : "")
+                            + mName;
+
+            // Create a new user
+            final String output = mDevice.executeShellCommand(command);
+            if (output.startsWith("Success")) {
+                try {
+                    mTestUserId =
+                            Integer.parseInt(output.substring(output.lastIndexOf(" ")).trim());
+                } catch (NumberFormatException e) {
+                    throw new IllegalStateException(
+                            String.format("Failed to create user, due to : %s", output));
+                }
+            }
+
+            AutoCloseable asSecondaryUser =
+                    () -> {
+                        // Switch back to the caller user if required and the user type is
+                        // neither managed nor pre-created-only
+                        if (mSwitch && !mIsManaged && !mIsPreCreateOnly) {
+                            mDevice.switchUser(callerUserId);
+                        }
+
+                        // Stop and remove the user if user type is not ephemeral
+                        if (!mIsEphemeral) {
+                            mDevice.stopUser(mTestUserId);
+                            mDevice.removeUser(mTestUserId);
+                        }
+                    };
+
+            // Start the user
+            if (!mDevice.startUser(mTestUserId, true /* waitFlag */)) {
+                // Remove the user
+                asSecondaryUser.close();
+                throw new IllegalStateException(
+                        String.format("Failed to start the user: %s", mTestUserId));
+            }
+
+            // Switch to the user if required and the user type is neither managed nor
+            // pre-created-only
+            if (mSwitch
+                    && !mIsManaged
+                    && !mIsPreCreateOnly
+                    && !mDevice.switchUser(mTestUserId)) {
+                // Stop and remove the user
+                asSecondaryUser.close();
+                throw new IllegalStateException(
+                        String.format("Failed to switch the user: %s", mTestUserId));
+            }
+            return asSecondaryUser;
+        }
+    }
+}