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

Commit b6e915f5 authored by Forrest Dunlap's avatar Forrest Dunlap Committed by Android (Google) Code Review
Browse files

Merge changes from topic "DeviceConfigInterface" 

* changes:
  Remove DeviceConfigInterface from Services & refactor FakeDeviceConfigInterface to use android.provider.DeviceConfigInterface
  Add DeviceConfigInterface.java
  Re-enable DeviceConfig onPropertiesChangedListener tests.
parents c21f7360 5ecbf52e

services/core/java/com/android/server/utils/DeviceConfigInterface.java→core/java/android/provider/DeviceConfigInterface.java

+82 −3
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2019 The Android Open Source Project

 * Copyright (C) 2021 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.
@@ -14,57 +14,103 @@ 
 * limitations under the License.

 */



package com.android.server.utils;

package android.provider;



import static android.provider.Settings.ResetMode;



import android.annotation.NonNull;

import android.annotation.Nullable;

import android.provider.DeviceConfig;

import android.provider.DeviceConfig.BadConfigException;

import android.provider.DeviceConfig.Properties;



import java.util.concurrent.Executor;



/**

 * Abstraction around {@link DeviceConfig} to allow faking device configuration in tests.

 *

 * @hide

 */

public interface DeviceConfigInterface {



    /**

     * @hide

     * @see DeviceConfig#getProperty

     */

    @Nullable

    String getProperty(@NonNull String namespace, @NonNull String name);



    /**

     * @hide

     * @see DeviceConfig#getProperties

     */

    @NonNull

    Properties getProperties(@NonNull String namespace, @NonNull String... names);



    /**

     * @hide

     * @see DeviceConfig#setProperty

     */

    boolean setProperty(@NonNull String namespace, @NonNull String name, @Nullable String value,

            boolean makeDefault);



    /**

     * @hide

     * @see DeviceConfig#setProperties

     */

    boolean setProperties(@NonNull Properties properties) throws BadConfigException;



    /**

     * @hide

     * @see DeviceConfig#deleteProperty

     */

    boolean deleteProperty(@NonNull String namespace, @NonNull String name);



    /**

     * @hide

     * @see DeviceConfig#resetToDefaults

     */

    void resetToDefaults(@ResetMode int resetMode, @Nullable String namespace);



    /**

     * @hide

     * @see DeviceConfig#getString

     */

    @NonNull

    String getString(@NonNull String namespace, @NonNull String name, @NonNull String defaultValue);



    /**

     * @hide

     * @see DeviceConfig#getInt

     */

    int getInt(@NonNull String namespace, @NonNull String name, int defaultValue);



    /**

     * @hide

     * @see DeviceConfig#getLong

     */

    long getLong(@NonNull String namespace, @NonNull String name, long defaultValue);



    /**

     * @hide

     * @see DeviceConfig#getBoolean

     */

    boolean getBoolean(@NonNull String namespace, @NonNull String name, boolean defaultValue);



    /**

     * @hide

     * @see DeviceConfig#getFloat

     */

    float getFloat(@NonNull String namespace, @NonNull String name, float defaultValue);



    /**

     * @hide

     * @see DeviceConfig#addOnPropertiesChangedListener

     */

    void addOnPropertiesChangedListener(@NonNull String namespace, @NonNull Executor executor,

            @NonNull DeviceConfig.OnPropertiesChangedListener listener);



    /**

     * @hide

     * @see DeviceConfig#removeOnPropertiesChangedListener

     */

    void removeOnPropertiesChangedListener(
@@ -72,13 +118,46 @@ public interface DeviceConfigInterface { 


    /**

     * Calls through to the real {@link DeviceConfig}.

     *

     * @hide

     */

    @NonNull

    DeviceConfigInterface REAL = new DeviceConfigInterface() {

        @Override

        public String getProperty(String namespace, String name) {

            return DeviceConfig.getProperty(namespace, name);

        }



        @Override

        public DeviceConfig.Properties getProperties(@NonNull String namespace,

                @NonNull String... names) {

            return DeviceConfig.getProperties(namespace, names);

        }



        @Override

        public boolean setProperty(@NonNull String namespace,

                @NonNull String name,

                @Nullable String value, boolean makeDefault) {

            return DeviceConfig.setProperty(namespace, name, value, makeDefault);

        }



        @Override

        public boolean setProperties(@NonNull Properties properties)

                throws BadConfigException {

            return DeviceConfig.setProperties(properties);

        }



        @Override

        public boolean deleteProperty(@NonNull String namespace,

                @NonNull String name) {

            return DeviceConfig.deleteProperty(namespace, name);

        }



        @Override

        public void resetToDefaults(int resetMode, @Nullable String namespace) {

            DeviceConfig.resetToDefaults(resetMode, namespace);

        }



        @Override

        public String getString(String namespace, String name, String defaultValue) {

            return DeviceConfig.getString(namespace, name, defaultValue);

core/tests/coretests/src/android/provider/DeviceConfigTest.java

+68 −60
Original line number Diff line number Diff line
@@ -22,6 +22,7 @@ import static com.google.common.truth.Truth.assertThat; 


import static org.testng.Assert.assertThrows;



import android.app.ActivityThread;

import android.content.ContentResolver;

import android.os.Bundle;

import android.platform.test.annotations.Presubmit;
@@ -35,6 +36,12 @@ import org.junit.Assert; 
import org.junit.Test;

import org.junit.runner.RunWith;



import java.util.HashMap;

import java.util.Map;

import java.util.Objects;

import java.util.concurrent.CountDownLatch;

import java.util.concurrent.TimeUnit;



/** Tests that ensure appropriate settings are backed up. */

@Presubmit

@RunWith(AndroidJUnit4.class)
@@ -701,66 +708,67 @@ public class DeviceConfigTest { 
        assertThat(result.getString(KEY4, DEFAULT_VALUE)).isEqualTo(DEFAULT_VALUE);

    }



    // TODO(mpape): resolve b/142727848 and re-enable listener tests

//    @Test

//    public void onPropertiesChangedListener_setPropertyCallback() throws InterruptedException {

//        final CountDownLatch countDownLatch = new CountDownLatch(1);

//

//        DeviceConfig.OnPropertiesChangedListener changeListener = (properties) -> {

//            assertThat(properties.getNamespace()).isEqualTo(NAMESPACE);

//            assertThat(properties.getKeyset()).contains(KEY);

//            assertThat(properties.getString(KEY, "default_value")).isEqualTo(VALUE);

//            countDownLatch.countDown();

//        };

//

//        try {

//            DeviceConfig.addOnPropertiesChangedListener(NAMESPACE,

//                    ActivityThread.currentApplication().getMainExecutor(), changeListener);

//            DeviceConfig.setProperty(NAMESPACE, KEY, VALUE, false);

//            assertThat(countDownLatch.await(

//                    WAIT_FOR_PROPERTY_CHANGE_TIMEOUT_MILLIS, TimeUnit.MILLISECONDS)).isTrue();

//        } catch (InterruptedException e) {

//            Assert.fail(e.getMessage());

//        } finally {

//            DeviceConfig.removeOnPropertiesChangedListener(changeListener);

//        }

//    }

//

//    @Test

//    public void onPropertiesChangedListener_setPropertiesCallback() throws InterruptedException {

//        final CountDownLatch countDownLatch = new CountDownLatch(1);

//        DeviceConfig.setProperty(NAMESPACE, KEY, VALUE, false);

//        DeviceConfig.setProperty(NAMESPACE, KEY2, VALUE2, false);

//

//        Map<String, String> keyValues = new HashMap<>(2);

//        keyValues.put(KEY, VALUE2);

//        keyValues.put(KEY3, VALUE3);

//        Properties setProperties = new Properties(NAMESPACE, keyValues);

//

//        DeviceConfig.OnPropertiesChangedListener changeListener = (properties) -> {

//            assertThat(properties.getNamespace()).isEqualTo(NAMESPACE);

//            assertThat(properties.getKeyset()).containsExactly(KEY, KEY2, KEY3);

//            // KEY updated from VALUE to VALUE2

//            assertThat(properties.getString(KEY, "default_value")).isEqualTo(VALUE2);

//            // KEY2 deleted (returns default_value)

//            assertThat(properties.getString(KEY2, "default_value")).isEqualTo("default_value");

//            //KEY3 added with VALUE3

//            assertThat(properties.getString(KEY3, "default_value")).isEqualTo(VALUE3);

//            countDownLatch.countDown();

//        };

//

//        try {

//            DeviceConfig.addOnPropertiesChangedListener(NAMESPACE,

//                    ActivityThread.currentApplication().getMainExecutor(), changeListener);

//            DeviceConfig.setProperties(setProperties);

//            assertThat(countDownLatch.await(

//                    WAIT_FOR_PROPERTY_CHANGE_TIMEOUT_MILLIS, TimeUnit.MILLISECONDS)).isTrue();

//        } catch (InterruptedException e) {

//            Assert.fail(e.getMessage());

//        } finally {

//            DeviceConfig.removeOnPropertiesChangedListener(changeListener);

//        }

//    }

    @Test

    public void onPropertiesChangedListener_setPropertyCallback() throws InterruptedException {

        final CountDownLatch countDownLatch = new CountDownLatch(1);



        DeviceConfig.OnPropertiesChangedListener changeListener = (properties) -> {

            assertThat(properties.getNamespace()).isEqualTo(NAMESPACE);

            assertThat(properties.getKeyset()).contains(KEY);

            assertThat(properties.getString(KEY, "default_value")).isEqualTo(VALUE);

            countDownLatch.countDown();

        };



        try {

            DeviceConfig.addOnPropertiesChangedListener(NAMESPACE,

                    Objects.requireNonNull(ActivityThread.currentApplication()).getMainExecutor(),

                    changeListener);

            DeviceConfig.setProperty(NAMESPACE, KEY, VALUE, false);

            assertThat(countDownLatch.await(

                    WAIT_FOR_PROPERTY_CHANGE_TIMEOUT_MILLIS, TimeUnit.MILLISECONDS)).isTrue();

        } catch (InterruptedException e) {

            Assert.fail(e.getMessage());

        } finally {

            DeviceConfig.removeOnPropertiesChangedListener(changeListener);

        }

    }



    @Test

    public void onPropertiesChangedListener_setPropertiesCallback() {

        final CountDownLatch countDownLatch = new CountDownLatch(1);

        DeviceConfig.setProperty(NAMESPACE, KEY, VALUE, false);

        DeviceConfig.setProperty(NAMESPACE, KEY2, VALUE2, false);



        Map<String, String> keyValues = new HashMap<>(2);

        keyValues.put(KEY, VALUE2);

        keyValues.put(KEY3, VALUE3);

        Properties setProperties = new Properties(NAMESPACE, keyValues);



        DeviceConfig.OnPropertiesChangedListener changeListener = (properties) -> {

            assertThat(properties.getNamespace()).isEqualTo(NAMESPACE);

            assertThat(properties.getKeyset()).containsExactly(KEY, KEY2, KEY3);

            // KEY updated from VALUE to VALUE2

            assertThat(properties.getString(KEY, "default_value")).isEqualTo(VALUE2);

            // KEY2 deleted (returns default_value)

            assertThat(properties.getString(KEY2, "default_value")).isEqualTo("default_value");

            //KEY3 added with VALUE3

            assertThat(properties.getString(KEY3, "default_value")).isEqualTo(VALUE3);

            countDownLatch.countDown();

        };



        try {

            DeviceConfig.addOnPropertiesChangedListener(NAMESPACE,

                    Objects.requireNonNull(ActivityThread.currentApplication()).getMainExecutor(),

                    changeListener);

            DeviceConfig.setProperties(setProperties);

            assertThat(countDownLatch.await(

                    WAIT_FOR_PROPERTY_CHANGE_TIMEOUT_MILLIS, TimeUnit.MILLISECONDS)).isTrue();

        } catch (InterruptedException | DeviceConfig.BadConfigException e) {

            Assert.fail(e.getMessage());

        } finally {

            DeviceConfig.removeOnPropertiesChangedListener(changeListener);

        }

    }



    @Test

    public void syncDisabling() throws Exception {

services/core/Android.bp

+0 −7
Original line number Diff line number Diff line
@@ -207,10 +207,3 @@ prebuilt_etc { 
    name: "protolog.conf.json.gz",

    src: ":services.core.json.gz",

}
 


filegroup {

    name: "services.core-sources-deviceconfig-interface",

    srcs: [

        "java/com/android/server/utils/DeviceConfigInterface.java",

    ],

}

services/core/java/com/android/server/display/DisplayModeDirector.java

+1 −1
Original line number Diff line number Diff line
@@ -41,6 +41,7 @@ import android.os.Message; 
import android.os.SystemClock;

import android.os.UserHandle;

import android.provider.DeviceConfig;

import android.provider.DeviceConfigInterface;

import android.provider.Settings;

import android.text.TextUtils;

import android.util.IndentingPrintWriter;
@@ -61,7 +62,6 @@ import com.android.server.display.utils.AmbientFilterFactory; 
import com.android.server.sensors.SensorManagerInternal;

import com.android.server.sensors.SensorManagerInternal.ProximityActiveListener;

import com.android.server.statusbar.StatusBarManagerInternal;

import com.android.server.utils.DeviceConfigInterface;



import java.io.PrintWriter;

import java.text.SimpleDateFormat;

services/core/java/com/android/server/wm/HighRefreshRateDenylist.java

+1 −1
Original line number Diff line number Diff line
@@ -22,12 +22,12 @@ import android.annotation.NonNull; 
import android.annotation.Nullable;

import android.content.res.Resources;

import android.provider.DeviceConfig;

import android.provider.DeviceConfigInterface;

import android.util.ArraySet;



import com.android.internal.R;

import com.android.internal.annotations.VisibleForTesting;

import com.android.internal.os.BackgroundThread;

import com.android.server.utils.DeviceConfigInterface;



import java.io.PrintWriter;