Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 27b68d1e authored by Mohammad Samiul Islam's avatar Mohammad Samiul Islam Committed by Mohammad Islam
Browse files

Simplify flags used to wait for staged session ready 

Staged install by default should wait for staged session to become
ready. The default waiting time can now be altered using a single flag
--staged-ready-timeout. Passing non-positive integer as argument for the
flag turns off the waiting logic, which is equivalent to --no-wait flag
from before.

Tests have been updated accordingly to match the change.

Bug: 162958790
Test: atest StagedInstallInternalTest
Change-Id: I998cf6882a6b38547c2283f6cadc41082c25acb5
Merged-In: I998cf6882a6b38547c2283f6cadc41082c25acb5
(cherry picked from commit 64d542c2)
parent 8fafabfe

services/core/java/com/android/server/pm/PackageManagerShellCommand.java

+26 −44
Original line number Original line Diff line number Diff line
@@ -104,6 +104,7 @@ import android.util.SparseArray; 
import com.android.internal.content.PackageHelper;

import com.android.internal.content.PackageHelper;

import com.android.internal.util.ArrayUtils;

import com.android.internal.util.ArrayUtils;

import com.android.internal.util.IndentingPrintWriter;

import com.android.internal.util.IndentingPrintWriter;

import com.android.internal.util.Preconditions;

import com.android.server.LocalServices;

import com.android.server.LocalServices;

import com.android.server.SystemConfig;

import com.android.server.SystemConfig;

import com.android.server.pm.PackageManagerShellCommandDataLoader.Metadata;

import com.android.server.pm.PackageManagerShellCommandDataLoader.Metadata;
@@ -139,7 +140,7 @@ class PackageManagerShellCommand extends ShellCommand { 
    private static final String STDIN_PATH = "-";

    private static final String STDIN_PATH = "-";

    /** Path where ART profiles snapshots are dumped for the shell user */

    /** Path where ART profiles snapshots are dumped for the shell user */

    private final static String ART_PROFILE_SNAPSHOT_DEBUG_LOCATION = "/data/misc/profman/";

    private final static String ART_PROFILE_SNAPSHOT_DEBUG_LOCATION = "/data/misc/profman/";

    private static final int DEFAULT_WAIT_MS = 60 * 1000;

    private static final int DEFAULT_STAGED_READY_TIMEOUT_MS = 60 * 1000;

    private static final String TAG = "PackageManagerShellCommand";

    private static final String TAG = "PackageManagerShellCommand";





    final IPackageManager mInterface;

    final IPackageManager mInterface;
@@ -1304,11 +1305,12 @@ class PackageManagerShellCommand extends ShellCommand { 
            }

            }

            abandonSession = false;

            abandonSession = false;





            if (!params.sessionParams.isStaged || !params.mWaitForStagedSessionReady) {

            if (params.sessionParams.isStaged && params.stagedReadyTimeoutMs > 0) {

                return doWaitForStagedSessionRead(sessionId, params.stagedReadyTimeoutMs, pw);

            }



            pw.println("Success");

            pw.println("Success");

            return 0;

            return 0;

            }

            return doWaitForStagedSessionRead(sessionId, params.timeoutMs, pw);

        } finally {

        } finally {

            if (abandonSession) {

            if (abandonSession) {

                try {

                try {
@@ -1321,9 +1323,7 @@ class PackageManagerShellCommand extends ShellCommand { 




    private int doWaitForStagedSessionRead(int sessionId, long timeoutMs, PrintWriter pw)

    private int doWaitForStagedSessionRead(int sessionId, long timeoutMs, PrintWriter pw)

              throws RemoteException {

              throws RemoteException {

        if (timeoutMs <= 0) {

        Preconditions.checkArgument(timeoutMs > 0);

            timeoutMs = DEFAULT_WAIT_MS;

        }

        PackageInstaller.SessionInfo si = mInterface.getPackageInstaller()

        PackageInstaller.SessionInfo si = mInterface.getPackageInstaller()

                .getSessionInfo(sessionId);

                .getSessionInfo(sessionId);

        if (si == null) {

        if (si == null) {
@@ -1373,25 +1373,14 @@ class PackageManagerShellCommand extends ShellCommand { 
    private int runInstallCommit() throws RemoteException {

    private int runInstallCommit() throws RemoteException {

        final PrintWriter pw = getOutPrintWriter();

        final PrintWriter pw = getOutPrintWriter();

        String opt;

        String opt;

        boolean waitForStagedSessionReady = true;

        long stagedReadyTimeoutMs = DEFAULT_STAGED_READY_TIMEOUT_MS;

        long timeoutMs = -1;

        while ((opt = getNextOption()) != null) {

        while ((opt = getNextOption()) != null) {

            switch (opt) {

            switch (opt) {

                case "--wait-for-staged-ready":

                case "--staged-ready-timeout":

                    waitForStagedSessionReady = true;

                    stagedReadyTimeoutMs = Long.parseLong(getNextArgRequired());

                    // If there is only one remaining argument, then it represents the sessionId, we

                    // shouldn't try to parse it as timeoutMs.

                    if (getRemainingArgsCount() > 1) {

                        try {

                            timeoutMs = Long.parseLong(peekNextArg());

                            getNextArg();

                        } catch (NumberFormatException ignore) {

                        }

                    }

                    break;

                case "--no-wait":

                    waitForStagedSessionReady = false;

                    break;

                    break;

                default:

                    throw new IllegalArgumentException("Unknown option: " + opt);

            }

            }

        }

        }

        final int sessionId = Integer.parseInt(getNextArg());

        final int sessionId = Integer.parseInt(getNextArg());
@@ -1400,12 +1389,12 @@ class PackageManagerShellCommand extends ShellCommand { 
        }

        }

        final PackageInstaller.SessionInfo si = mInterface.getPackageInstaller()

        final PackageInstaller.SessionInfo si = mInterface.getPackageInstaller()

                .getSessionInfo(sessionId);

                .getSessionInfo(sessionId);

        if (si == null || !si.isStaged() || !waitForStagedSessionReady) {

        if (si != null && si.isStaged() && stagedReadyTimeoutMs > 0) {

            return doWaitForStagedSessionRead(sessionId, stagedReadyTimeoutMs, pw);

        }

        pw.println("Success");

        pw.println("Success");

        return 0;

        return 0;

    }

    }

        return doWaitForStagedSessionRead(sessionId, timeoutMs, pw);

    }





    private int runInstallCreate() throws RemoteException {

    private int runInstallCreate() throws RemoteException {

        final PrintWriter pw = getOutPrintWriter();

        final PrintWriter pw = getOutPrintWriter();
@@ -2735,8 +2724,7 @@ class PackageManagerShellCommand extends ShellCommand { 
        SessionParams sessionParams;

        SessionParams sessionParams;

        String installerPackageName;

        String installerPackageName;

        int userId = UserHandle.USER_ALL;

        int userId = UserHandle.USER_ALL;

        boolean mWaitForStagedSessionReady = true;

        long stagedReadyTimeoutMs = DEFAULT_STAGED_READY_TIMEOUT_MS;

        long timeoutMs = DEFAULT_WAIT_MS;

    }

    }





    private InstallParams makeInstallParams() {

    private InstallParams makeInstallParams() {
@@ -2865,16 +2853,8 @@ class PackageManagerShellCommand extends ShellCommand { 
                    }

                    }

                    sessionParams.installFlags |= PackageManager.INSTALL_ENABLE_ROLLBACK;

                    sessionParams.installFlags |= PackageManager.INSTALL_ENABLE_ROLLBACK;

                    break;

                    break;

                case "--wait-for-staged-ready":

                case "--staged-ready-timeout":

                    params.mWaitForStagedSessionReady = true;

                    params.stagedReadyTimeoutMs = Long.parseLong(getNextArgRequired());

                    try {

                        params.timeoutMs = Long.parseLong(peekNextArg());

                        getNextArg();

                    } catch (NumberFormatException ignore) {

                    }

                    break;

                case "--no-wait":

                    params.mWaitForStagedSessionReady = false;

                    break;

                    break;

                case "--skip-verification":

                case "--skip-verification":

                    sessionParams.installFlags |= PackageManager.INSTALL_DISABLE_VERIFICATION;

                    sessionParams.installFlags |= PackageManager.INSTALL_DISABLE_VERIFICATION;
@@ -3597,7 +3577,7 @@ class PackageManagerShellCommand extends ShellCommand { 
        pw.println("       [--preload] [--instant] [--full] [--dont-kill]");

        pw.println("       [--preload] [--instant] [--full] [--dont-kill]");

        pw.println("       [--enable-rollback]");

        pw.println("       [--enable-rollback]");

        pw.println("       [--force-uuid internal|UUID] [--pkg PACKAGE] [-S BYTES]");

        pw.println("       [--force-uuid internal|UUID] [--pkg PACKAGE] [-S BYTES]");

        pw.println("       [--apex] [--wait-for-staged-ready TIMEOUT]");

        pw.println("       [--apex] [--staged-ready-timeout TIMEOUT]");

        pw.println("       [PATH [SPLIT...]|-]");

        pw.println("       [PATH [SPLIT...]|-]");

        pw.println("    Install an application.  Must provide the apk data to install, either as");

        pw.println("    Install an application.  Must provide the apk data to install, either as");

        pw.println("    file path(s) or '-' to read from stdin.  Options are:");

        pw.println("    file path(s) or '-' to read from stdin.  Options are:");
@@ -3625,9 +3605,11 @@ class PackageManagerShellCommand extends ShellCommand { 
        pw.println("          3=device setup, 4=user request");

        pw.println("          3=device setup, 4=user request");

        pw.println("      --force-uuid: force install on to disk volume with given UUID");

        pw.println("      --force-uuid: force install on to disk volume with given UUID");

        pw.println("      --apex: install an .apex file, not an .apk");

        pw.println("      --apex: install an .apex file, not an .apk");

        pw.println("      --wait-for-staged-ready: when performing staged install, wait TIMEOUT");

        pw.println("      --staged-ready-timeout: By default, staged sessions wait "

        pw.println("          ms for pre-reboot verification to complete. If TIMEOUT is not");

                + DEFAULT_STAGED_READY_TIMEOUT_MS);

        pw.println("          specified it will wait for " + DEFAULT_WAIT_MS + " milliseconds.");

        pw.println("          milliseconds for pre-reboot verification to complete when");

        pw.println("          performing staged install. This flag is used to alter the waiting");

        pw.println("          time. You can skip the waiting time by specifying a TIMEOUT of '0'");

        pw.println("");

        pw.println("");

        pw.println("  install-existing [--user USER_ID|all|current]");

        pw.println("  install-existing [--user USER_ID|all|current]");

        pw.println("       [--instant] [--full] [--wait] [--restrict-permissions] PACKAGE");

        pw.println("       [--instant] [--full] [--wait] [--restrict-permissions] PACKAGE");

tests/StagedInstallTest/src/com/android/tests/stagedinstallinternal/host/StagedInstallInternalTest.java

+32 −15
Original line number Original line Diff line number Diff line
@@ -93,31 +93,48 @@ public class StagedInstallInternalTest extends BaseHostJUnit4Test { 
        runPhase("testSystemServerRestartDoesNotAffectStagedSessions_Verify");

        runPhase("testSystemServerRestartDoesNotAffectStagedSessions_Verify");

    }

    }





    // Test waiting time for staged session to be ready using adb staged install can be altered

    @Test

    @Test

    public void testAdbStagedInstallWaitForReadyFlagWorks() throws Exception {

    public void testAdbStagdReadyTimeoutFlagWorks() throws Exception {

        assumeTrue("Device does not support updating APEX",

        assumeTrue("Device does not support updating APEX",

                mHostUtils.isApexUpdateSupported());

                mHostUtils.isApexUpdateSupported());





        File apexFile = mTestUtils.getTestFile(SHIM_V2);

        final File apexFile = mTestUtils.getTestFile(SHIM_V2);

        String output = getDevice().executeAdbCommand("install", "--staged",

        final String output = getDevice().executeAdbCommand("install", "--staged",

                "--wait-for-staged-ready", "60000", apexFile.getAbsolutePath());

                "--staged-ready-timeout", "60000", apexFile.getAbsolutePath());

        assertThat(output).contains("Reboot device to apply staged session");

        assertThat(output).contains("Reboot device to apply staged session");

        String sessionId = getDevice().executeShellCommand(

        final String sessionId = getDevice().executeShellCommand(

                "pm get-stagedsessions --only-ready --only-parent --only-sessionid").trim();

                "pm get-stagedsessions --only-ready --only-parent --only-sessionid").trim();

        assertThat(sessionId).isNotEmpty();

        assertThat(sessionId).isNotEmpty();

    }

    }





    // Test adb staged installation wait for session to be ready by default

    @Test

    @Test

    public void testAdbStagedInstallNoWaitFlagWorks() throws Exception {

    public void testAdbStagedInstallWaitsTillReadyByDefault() throws Exception {

        assumeTrue("Device does not support updating APEX",

        assumeTrue("Device does not support updating APEX",

                mHostUtils.isApexUpdateSupported());

                mHostUtils.isApexUpdateSupported());





        File apexFile = mTestUtils.getTestFile(SHIM_V2);

        final File apexFile = mTestUtils.getTestFile(SHIM_V2);

        String output = getDevice().executeAdbCommand("install", "--staged",

        final String output = getDevice().executeAdbCommand("install", "--staged",

                "--no-wait", apexFile.getAbsolutePath());

                apexFile.getAbsolutePath());

        assertThat(output).contains("Reboot device to apply staged session");

        final String sessionId = getDevice().executeShellCommand(

                "pm get-stagedsessions --only-ready --only-parent --only-sessionid").trim();

        assertThat(sessionId).isNotEmpty();

    }



    // Test we can skip waiting for staged session to be ready

    @Test

    public void testAdbStagedReadyWaitCanBeSkipped() throws Exception {

        assumeTrue("Device does not support updating APEX",

                mHostUtils.isApexUpdateSupported());



        final File apexFile = mTestUtils.getTestFile(SHIM_V2);

        final String output = getDevice().executeAdbCommand("install", "--staged",

                "--staged-ready-timeout", "0", apexFile.getAbsolutePath());

        assertThat(output).doesNotContain("Reboot device to apply staged session");

        assertThat(output).doesNotContain("Reboot device to apply staged session");

        assertThat(output).contains("Success");

        assertThat(output).contains("Success");

        String sessionId = getDevice().executeShellCommand(

        final String sessionId = getDevice().executeShellCommand(

                "pm get-stagedsessions --only-ready --only-parent --only-sessionid").trim();

                "pm get-stagedsessions --only-ready --only-parent --only-sessionid").trim();

        assertThat(sessionId).isEmpty();

        assertThat(sessionId).isEmpty();

    }

    }
@@ -127,9 +144,9 @@ public class StagedInstallInternalTest extends BaseHostJUnit4Test { 
        assumeTrue("Device does not support updating APEX",

        assumeTrue("Device does not support updating APEX",

                mHostUtils.isApexUpdateSupported());

                mHostUtils.isApexUpdateSupported());





        File apexFile = mTestUtils.getTestFile(SHIM_V2);

        final File apexFile = mTestUtils.getTestFile(SHIM_V2);

        File apkFile = mTestUtils.getTestFile(APK_A);

        final File apkFile = mTestUtils.getTestFile(APK_A);

        String output = getDevice().executeAdbCommand("install-multi-package",

        final String output = getDevice().executeAdbCommand("install-multi-package",

                apexFile.getAbsolutePath(), apkFile.getAbsolutePath());

                apexFile.getAbsolutePath(), apkFile.getAbsolutePath());

        assertThat(output).contains("Created parent session");

        assertThat(output).contains("Created parent session");

        assertThat(output).contains("Created child session");

        assertThat(output).contains("Created child session");
@@ -154,10 +171,10 @@ public class StagedInstallInternalTest extends BaseHostJUnit4Test { 
        getDevice().disableAdbRoot();

        getDevice().disableAdbRoot();





        // Wait for new system server process to start

        // Wait for new system server process to start

        long start = System.currentTimeMillis();

        final long start = System.currentTimeMillis();

        long newStartTime = oldStartTime;

        long newStartTime = oldStartTime;

        while (System.currentTimeMillis() < start + SYSTEM_SERVER_TIMEOUT_MS) {

        while (System.currentTimeMillis() < start + SYSTEM_SERVER_TIMEOUT_MS) {

            ProcessInfo newPs = getDevice().getProcessByName("system_server");

            final ProcessInfo newPs = getDevice().getProcessByName("system_server");

            if (newPs != null) {

            if (newPs != null) {

                newStartTime = newPs.getStartTime();

                newStartTime = newPs.getStartTime();

                if (newStartTime != oldStartTime) {

                if (newStartTime != oldStartTime) {