Merge "Add FeatureFlagUtils"

/*

 * Copyright (C) 2017 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 android.util;

import android.os.SystemProperties;

import android.text.TextUtils;

import java.util.Map;

/**

 * Util class to get feature flag information.

 *

 * @hide

 */

public class FeatureFlagUtils {

    public static final String FFLAG_PREFIX = "sys.fflag.";

    public static final String FFLAG_OVERRIDE_PREFIX = FFLAG_PREFIX + "override.";

    /**

     * Whether or not a flag is enabled.

     *

     * @param feature the flag name

     * @return true if the flag is enabled (either by default in system, or override by user)

     */

    public static boolean isEnabled(String feature) {

        // Tries to get feature flag from system property.

        // Step 1: check if feature flag has any override. Flag name: sys.fflag.override.<feature>

        String value = SystemProperties.get(FFLAG_OVERRIDE_PREFIX + feature);

        if (!TextUtils.isEmpty(value)) {

            return Boolean.parseBoolean(value);

        }

        // Step 2: check if feature flag has any default value. Flag name: sys.fflag.<feature>

        value = SystemProperties.get(FFLAG_PREFIX + feature);

        return Boolean.parseBoolean(value);

    }

    /**

     * Returns all feature flags in their raw form.

     */

    public static Map<String, String> getAllFeatureFlags() {

        return null;

    }

}

LOCAL_PATH:= $(call my-dir)

include $(CLEAR_VARS)

# We only want this apk build for tests.

LOCAL_MODULE_TAGS := tests

# Include all test java files.

LOCAL_SRC_FILES := \

    $(call all-java-files-under, src)

LOCAL_DX_FLAGS := --core-library

LOCAL_STATIC_JAVA_LIBRARIES := android-common frameworks-core-util-lib android-support-test

LOCAL_JAVA_LIBRARIES := android.test.runner

LOCAL_PACKAGE_NAME := FrameworksCoreFeatureFlagTests

LOCAL_CERTIFICATE := platform

LOCAL_COMPATIBILITY_SUITE := device-tests

include $(BUILD_PACKAGE)

<?xml version="1.0" encoding="utf-8"?>

<!--

  Copyright (C) 2017 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.

  -->

<manifest

    xmlns:android="http://schemas.android.com/apk/res/android"

    android:installLocation="internalOnly"

    package="com.android.frameworks.coretests.featureflagtests"

    android:sharedUserId="android.uid.system">

    <application>

        <uses-library android:name="android.test.runner" />

    </application>

    <instrumentation

        android:name="android.support.test.runner.AndroidJUnitRunner"

        android:targetPackage="com.android.frameworks.coretests.featureflagtests"

        android:label="Frameworks FeatureFlagUtils Tests" />

</manifest>

<?xml version="1.0" encoding="utf-8"?>

<!--

  Copyright (C) 2017 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.

  -->

<configuration description="Runs Frameworks Utility Tests.">

    <target_preparer class="com.android.tradefed.targetprep.TestAppInstallSetup">

        <option name="test-file-name" value="FrameworksCoreFeatureFlagTests.apk" />

    </target_preparer>

    <option name="test-suite-tag" value="apct" />

    <option name="test-tag" value="FrameworksCoreFeatureFlagTests" />

    <test class="com.android.tradefed.testtype.AndroidJUnitTest" >

        <option name="package" value="com.android.frameworks.coretests.featureflagtests" />

        <option name="runner" value="android.support.test.runner.AndroidJUnitRunner" />

    </test>

</configuration>

/*

 * Copyright (C) 2017 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 android.util;

import static junit.framework.Assert.assertFalse;

import static junit.framework.Assert.assertTrue;

import android.os.SystemProperties;

import android.support.test.runner.AndroidJUnit4;

import android.test.suitebuilder.annotation.SmallTest;

import org.junit.After;

import org.junit.Before;

import org.junit.Test;

import org.junit.runner.RunWith;

@RunWith(AndroidJUnit4.class)

@SmallTest

public class FeatureFlagUtilsTest {

    private static final String TEST_FEATURE_NAME = "feature_foobar";

    @Before

    public void setUp() {

        cleanup();

    }

    @After

    public void tearDown() {

        cleanup();

    }

    private void cleanup() {

        SystemProperties.set(FeatureFlagUtils.FFLAG_PREFIX + TEST_FEATURE_NAME, "");

        SystemProperties.set(FeatureFlagUtils.FFLAG_OVERRIDE_PREFIX + TEST_FEATURE_NAME, "");

    }

    @Test

    public void testGetFlag_enabled_shouldReturnTrue() {

        SystemProperties.set(FeatureFlagUtils.FFLAG_PREFIX + TEST_FEATURE_NAME, "true");

        assertTrue(FeatureFlagUtils.isEnabled(TEST_FEATURE_NAME));

    }

    @Test

    public void testGetFlag_override_shouldReturnTrue() {

        SystemProperties.set(FeatureFlagUtils.FFLAG_PREFIX + TEST_FEATURE_NAME, "false");

        SystemProperties.set(FeatureFlagUtils.FFLAG_OVERRIDE_PREFIX + TEST_FEATURE_NAME, "true");

        assertTrue(FeatureFlagUtils.isEnabled(TEST_FEATURE_NAME));

    }

    @Test

    public void testGetFlag_notSet_shouldReturnFalse() {

        assertFalse(FeatureFlagUtils.isEnabled(TEST_FEATURE_NAME));

    }

}