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

Commit f272aff2 authored by Lee Shombert's avatar Lee Shombert
Browse files

Make setTestMode() a module API 

Publish setTestMode() as a module API so that mainline modules can use
it in their test code.  The API is flagged.

Also, test APIs are now guarded so that they throw if the current
process is not a test.  This behavior is gated by an existing PIC test
flag.

Flag: android.os.ipc_data_cache_test_apis
Flag: android.app.enforce_pic_testmode_protocol
Bug: 396173886
Test: atest
 * FrameworksCoreTests:PropertyInvalidatedCacheTests
 * FrameworksCoreTests:IpcDataCacheTest
 * CtsOsTestCases:IpcDataCacheTest
Change-Id: I1cf9bacb676c12d5821959e4cc672df6339a2d42
parent 85c5b7d8

core/api/module-lib-current.txt

+1 −0
Original line number Diff line number Diff line
@@ -410,6 +410,7 @@ package android.os { 
    method public void invalidateCache();

    method public static void invalidateCache(@NonNull String, @NonNull String);

    method @Nullable public Result query(@NonNull Query);

    method @FlaggedApi("android.os.ipc_data_cache_test_apis") public static void setTestMode(boolean);

    field public static final String MODULE_BLUETOOTH = "bluetooth";

  }

core/api/test-current.txt

+1 −1
Original line number Diff line number Diff line
@@ -2459,7 +2459,7 @@ package android.os { 
    method public static void invalidateCache(@NonNull String, @NonNull String);

    method public final boolean isDisabled();

    method @Nullable public Result query(@NonNull Query);

    method public static void setTestMode(boolean);

    method @FlaggedApi("android.os.ipc_data_cache_test_apis") public static void setTestMode(boolean);

    field public static final String MODULE_BLUETOOTH = "bluetooth";

    field public static final String MODULE_SYSTEM = "system_server";

    field public static final String MODULE_TEST = "test";

core/java/android/app/PropertyInvalidatedCache.java

+36 −1
Original line number Diff line number Diff line
@@ -1417,7 +1417,36 @@ public class PropertyInvalidatedCache<Query, Result> { 
    }



    /**

     * Enable or disable testing.  The protocol requires that the mode toggle: for instance, it is

     * Throw if the current process is not allowed to use test APIs.

     */

    @android.ravenwood.annotation.RavenwoodReplace

    private static void throwIfNotTest() {

        final ActivityThread activityThread = ActivityThread.currentActivityThread();

        if (activityThread == null) {

            // Only tests can reach here.

            return;

        }

        final Instrumentation instrumentation = activityThread.getInstrumentation();

        if (instrumentation == null) {

            // Only tests can reach here.

            return;

        }

        if (instrumentation.isInstrumenting()) {

            return;

        }

        if (Flags.enforcePicTestmodeProtocol()) {

            throw new IllegalStateException("Test-only API called not from a test.");

        }

    }



    /**

     * Do not throw if running under ravenwood.

     */

    private static void throwIfNotTest$ravenwood() {

    }



    /**

     * Enable or disable test mode.  The protocol requires that the mode toggle: for instance, it is

     * illegal to clear the test mode if the test mode is already off.  Enabling test mode puts

     * all caches in the process into test mode; all nonces are initialized to UNSET and

     * subsequent reads and writes are to process memory.  This has the effect of disabling all
@@ -1425,10 +1454,12 @@ public class PropertyInvalidatedCache<Query, Result> { 
     * operation.

     * @param mode The desired test mode.

     * @throws IllegalStateException if the supplied mode is already set.

     * @throws IllegalStateException if the process is not running an instrumentation test.

     * @hide

     */

    @VisibleForTesting

    public static void setTestMode(boolean mode) {

        throwIfNotTest();

        synchronized (sGlobalLock) {

            if (sTestMode == mode) {

                final String msg = "cannot set test mode redundantly: mode=" + mode;
@@ -1464,9 +1495,11 @@ public class PropertyInvalidatedCache<Query, Result> { 
     * for which it would not otherwise have permission.  Caches in test mode do NOT write their

     * values to the system properties.  The effect is local to the current process.  Test mode

     * must be true when this method is called.

     * @throws IllegalStateException if the process is not running an instrumentation test.

     * @hide

     */

    public void testPropertyName() {

        throwIfNotTest();

        synchronized (sGlobalLock) {

            if (sTestMode == false) {

                throw new IllegalStateException("cannot test property name with test mode off");
@@ -1777,10 +1810,12 @@ public class PropertyInvalidatedCache<Query, Result> { 
     * When multiple caches share a single property value, using an instance method on one of

     * the cache objects to invalidate all of the cache objects becomes confusing and you should

     * just use the static version of this function.

     * @throws IllegalStateException if the process is not running an instrumentation test.

     * @hide

     */

    @VisibleForTesting

    public void disableSystemWide() {

        throwIfNotTest();

        disableSystemWide(mPropertyName);

    }

core/java/android/os/IpcDataCache.java

+4 −1
Original line number Diff line number Diff line
@@ -718,7 +718,7 @@ public class IpcDataCache<Query, Result> extends PropertyInvalidatedCache<Query, 
    }



    /**

     * Enable or disable testing.  The protocol requires that the mode toggle: for instance, it is

     * Enable or disable test mode.  The protocol requires that the mode toggle: for instance, it is

     * illegal to clear the test mode if the test mode is already off.  Enabling test mode puts

     * all caches in the process into test mode; all nonces are initialized to UNSET and

     * subsequent reads and writes are to process memory.  This has the effect of disabling all
@@ -726,8 +726,11 @@ public class IpcDataCache<Query, Result> extends PropertyInvalidatedCache<Query, 
     * operation.

     * @param mode The desired test mode.

     * @throws IllegalStateException if the supplied mode is already set.

     * @throws IllegalStateException if the process is not running an instrumentation test.

     * @hide

     */

    @FlaggedApi(android.os.Flags.FLAG_IPC_DATA_CACHE_TEST_APIS)

    @SystemApi(client=SystemApi.Client.MODULE_LIBRARIES)

    @TestApi

    public static void setTestMode(boolean mode) {

        PropertyInvalidatedCache.setTestMode(mode);

core/java/android/os/flags.aconfig

+8 −0
Original line number Diff line number Diff line
@@ -218,6 +218,14 @@ flag { 
    is_exported: true

}



flag {

     name: "ipc_data_cache_test_apis"

     namespace: "system_performance"

     description: "Expose IpcDataCache test apis to mainline modules."

     bug: "396173886"

     is_exported: true

}



flag {

     name: "mainline_vcn_platform_api"

     namespace: "vcn"