browser/browser/src/test/java/androidx/browser/customtabs/CustomTabColorSchemeParamsTest.java

/*
 * Copyright 2019 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 androidx.browser.customtabs;

import static androidx.browser.customtabs.CustomTabsIntent.COLOR_SCHEME_DARK;
import static androidx.browser.customtabs.CustomTabsIntent.COLOR_SCHEME_LIGHT;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;

import android.content.Intent;

import androidx.annotation.Nullable;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.annotation.internal.DoNotInstrument;


/**
 * Tests for color scheme parameters api.
 * In particular, for {@link CustomTabsIntent.Builder#setColorSchemeParams} and
 * {@link CustomTabsIntent#getColorSchemeParams}
 */
@SuppressWarnings("deprecation")
@RunWith(RobolectricTestRunner.class)
@DoNotInstrument
public class CustomTabColorSchemeParamsTest {
    @Test
    public void testParamsProvidedForBothSchemes() {
        // Parameters for both schemes are provided as CustomTabColorSchemeParams.

        CustomTabColorSchemeParams lightParams = new CustomTabColorSchemeParams.Builder()
                .setToolbarColor(0x0000ff)
                .setSecondaryToolbarColor(0x00aaff)
                .setNavigationBarColor(0xaabbcc)
                .setNavigationBarDividerColor(0x00ff00)
                .build();

        CustomTabColorSchemeParams darkParams = new CustomTabColorSchemeParams.Builder()
                .setToolbarColor(0xff0000)
                .setSecondaryToolbarColor(0xff8800)
                .setNavigationBarColor(0x112233)
                .setNavigationBarDividerColor(0xff00ff)
                .build();

        Intent intent = new CustomTabsIntent.Builder()
                .setToolbarColor(0xaaaaaa) // These colors should get overridden.
                .setSecondaryToolbarColor(0x555555)
                .setNavigationBarColor(0x111111)
                .setNavigationBarDividerColor(0xdddddd)
                .setColorSchemeParams(COLOR_SCHEME_LIGHT, lightParams)
                .setColorSchemeParams(COLOR_SCHEME_DARK, darkParams)
                .build()
                .intent;

        CustomTabColorSchemeParams lightParamsFromIntent =
                CustomTabsIntent.getColorSchemeParams(intent, COLOR_SCHEME_LIGHT);

        CustomTabColorSchemeParams darkParamsFromIntent =
                CustomTabsIntent.getColorSchemeParams(intent, COLOR_SCHEME_DARK);

        assertSchemeParamsEqual(lightParams, lightParamsFromIntent);
        assertSchemeParamsEqual(darkParams, darkParamsFromIntent);
    }


    @Test
    public void testWithDefaultsForOneOfSchemes() {
        // Light mode parameters are provided as defaults, i.e. set directly on
        // CustomTabIntent.Builder.

        int defaultToolbarColor = 0x0000ff;
        int defaultSecondaryToolbarColor = 0x00aaff;
        int defaultNavigationBarColor = 0xaabbcc;
        int defaultNavigationBarDividerColor = 0xdddddd;

        CustomTabColorSchemeParams darkParams = new CustomTabColorSchemeParams.Builder()
                .setToolbarColor(0xff0000)
                .setSecondaryToolbarColor(0xff8800)
                .setNavigationBarColor(0x112233)
                .setNavigationBarDividerColor(0xff00ff)
                .build();

        Intent intent = new CustomTabsIntent.Builder()
                .setToolbarColor(defaultToolbarColor)
                .setSecondaryToolbarColor(defaultSecondaryToolbarColor)
                .setNavigationBarColor(defaultNavigationBarColor)
                .setNavigationBarDividerColor(defaultNavigationBarDividerColor)
                .setColorSchemeParams(COLOR_SCHEME_DARK, darkParams)
                .build()
                .intent;

        CustomTabColorSchemeParams lightParamsFromIntent =
                CustomTabsIntent.getColorSchemeParams(intent, COLOR_SCHEME_LIGHT);

        CustomTabColorSchemeParams darkParamsFromIntent =
                CustomTabsIntent.getColorSchemeParams(intent, COLOR_SCHEME_DARK);

        CustomTabColorSchemeParams expectedLightParams = new CustomTabColorSchemeParams.Builder()
                .setToolbarColor(defaultToolbarColor)
                .setSecondaryToolbarColor(defaultSecondaryToolbarColor)
                .setNavigationBarColor(defaultNavigationBarColor)
                .setNavigationBarDividerColor(defaultNavigationBarDividerColor)
                .build();

        assertSchemeParamsEqual(expectedLightParams, lightParamsFromIntent);
        assertSchemeParamsEqual(darkParams, darkParamsFromIntent);
    }

    @Test
    public void testWithCommonParams() {
        // secondaryToolbarColor is common for both schemes and is set directly on
        // CustomTabIntent.Builder, while toolbarColor differs.

        int secondaryToolbarColor = 0x00aaff;

        CustomTabColorSchemeParams lightParams = new CustomTabColorSchemeParams.Builder()
                .setToolbarColor(0x0000ff)
                .build();

        CustomTabColorSchemeParams darkParams = new CustomTabColorSchemeParams.Builder()
                .setToolbarColor(0xff0000)
                .build();

        Intent intent = new CustomTabsIntent.Builder()
                .setSecondaryToolbarColor(secondaryToolbarColor)
                .setColorSchemeParams(COLOR_SCHEME_LIGHT, lightParams)
                .setColorSchemeParams(COLOR_SCHEME_DARK, darkParams)
                .build()
                .intent;

        CustomTabColorSchemeParams lightParamsFromIntent =
                CustomTabsIntent.getColorSchemeParams(intent, COLOR_SCHEME_LIGHT);

        CustomTabColorSchemeParams darkParamsFromIntent =
                CustomTabsIntent.getColorSchemeParams(intent, COLOR_SCHEME_DARK);

        CustomTabColorSchemeParams expectedLightParams = new CustomTabColorSchemeParams.Builder()
                .setToolbarColor(lightParams.toolbarColor)
                .setSecondaryToolbarColor(secondaryToolbarColor)
                .build();

        CustomTabColorSchemeParams expectedDarkParams = new CustomTabColorSchemeParams.Builder()
                .setToolbarColor(darkParams.toolbarColor)
                .setSecondaryToolbarColor(secondaryToolbarColor)
                .build();

        assertSchemeParamsEqual(expectedLightParams, lightParamsFromIntent);
        assertSchemeParamsEqual(expectedDarkParams, darkParamsFromIntent);
    }

    @Test
    public void testBackwardCompatibilityWithOldClients() {
        // Backward compatibility test with a client not using CustomTabColorSchemeParams api,
        // but a browser is using it.

        int toolbarColor = 0x0000ff;
        int secondaryToolbarColor = 0x00aaff;

        Intent intent = new CustomTabsIntent.Builder()
                .setToolbarColor(toolbarColor)
                .setSecondaryToolbarColor(secondaryToolbarColor)
                .build()
                .intent;

        CustomTabColorSchemeParams lightParamsFromIntent =
                CustomTabsIntent.getColorSchemeParams(intent, COLOR_SCHEME_LIGHT);

        CustomTabColorSchemeParams darkParamsFromIntent =
                CustomTabsIntent.getColorSchemeParams(intent, COLOR_SCHEME_DARK);

        CustomTabColorSchemeParams expectedParams = new CustomTabColorSchemeParams.Builder()
                .setToolbarColor(toolbarColor)
                .setSecondaryToolbarColor(secondaryToolbarColor)
                .build();

        assertSchemeParamsEqual(expectedParams, lightParamsFromIntent);
        assertSchemeParamsEqual(expectedParams, darkParamsFromIntent);
    }

    @Test
    public void testBackwardCompatibilityWithOldBrowsers() {
        // Backward compatibility test with a client that uses CustomTabColorSchemeParams api,
        // but a browser is not using it. The client must use CustomTabIntent.Builder methods
        // to ensure this compatibility.

        int defaultToolbarColor = 0x112233;
        int defaultSecondaryToolbarColor = 0x445566;

        CustomTabColorSchemeParams lightParams = new CustomTabColorSchemeParams.Builder()
                .setToolbarColor(0x0000ff)
                .setSecondaryToolbarColor(0x00aaff)
                .build();

        CustomTabColorSchemeParams darkParams = new CustomTabColorSchemeParams.Builder()
                .setToolbarColor(0xff0000)
                .setSecondaryToolbarColor(0xff8800)
                .build();

        Intent intent = new CustomTabsIntent.Builder()
                .setToolbarColor(defaultToolbarColor)
                .setSecondaryToolbarColor(defaultSecondaryToolbarColor)
                .setColorSchemeParams(COLOR_SCHEME_LIGHT, lightParams)
                .setColorSchemeParams(COLOR_SCHEME_DARK, darkParams)
                .build()
                .intent;

        assertColorEquals(defaultToolbarColor,
                intent.getIntExtra(CustomTabsIntent.EXTRA_TOOLBAR_COLOR, 0));
        assertColorEquals(defaultSecondaryToolbarColor,
                intent.getIntExtra(CustomTabsIntent.EXTRA_SECONDARY_TOOLBAR_COLOR, 0));
    }


    private void assertSchemeParamsEqual(CustomTabColorSchemeParams params1,
            CustomTabColorSchemeParams params2) {
        assertColorEquals(params1.toolbarColor, params2.toolbarColor);
        assertColorEquals(params1.secondaryToolbarColor, params2.secondaryToolbarColor);
        assertColorEquals(params1.navigationBarColor, params2.navigationBarColor);
    }

    // Compares colors ignoring alpha
    private void assertColorEquals(@Nullable Integer color1, @Nullable Integer color2) {
        if (color1 == null) {
            assertNull(color2);
        } else {
            assertEquals(color1 & 0xffffff, color2 & 0xffffff);
        }
    }
}