tests/robotests/src/com/android/car/settings/location/LocationFooterPreferenceControllerTest.java

/*
 * Copyright (C) 2018 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 com.android.car.settings.location;

import static com.google.common.truth.Truth.assertThat;

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyInt;
import static org.mockito.Mockito.when;

import android.content.Context;
import android.content.Intent;
import android.content.pm.ActivityInfo;
import android.content.pm.ApplicationInfo;
import android.content.pm.PackageManager;
import android.content.pm.ResolveInfo;
import android.content.res.Resources;
import android.location.LocationManager;
import android.os.Bundle;

import androidx.lifecycle.Lifecycle;
import androidx.preference.PreferenceGroup;

import com.android.car.settings.common.LogicalPreferenceGroup;
import com.android.car.settings.common.PreferenceControllerTestHelper;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.RuntimeEnvironment;

import java.util.ArrayList;
import java.util.List;

@RunWith(RobolectricTestRunner.class)
public class LocationFooterPreferenceControllerTest {
    private static final String TEST_TEXT = "sample text";
    private static final int TEST_RES_ID = 1024;

    @Mock
    private PackageManager mPackageManager;
    @Mock
    private Resources mResources;

    private PreferenceControllerTestHelper<LocationFooterPreferenceController> mControllerHelper;
    private PreferenceGroup mGroup;
    private List<ResolveInfo> mResolveInfos;

    @Before
    public void setUp() throws PackageManager.NameNotFoundException {
        MockitoAnnotations.initMocks(this);
        Context context = RuntimeEnvironment.application;
        mGroup = new LogicalPreferenceGroup(context);
        mControllerHelper = new PreferenceControllerTestHelper<>(context,
                LocationFooterPreferenceController.class, mGroup);
        mControllerHelper.getController().setPackageManager(mPackageManager);

        mResolveInfos = new ArrayList<>();
        when(mPackageManager.queryBroadcastReceivers(any(Intent.class), anyInt()))
                .thenReturn(mResolveInfos);
        when(mPackageManager.getResourcesForApplication(any(ApplicationInfo.class)))
                .thenReturn(mResources);
        when(mResources.getString(TEST_RES_ID)).thenReturn(TEST_TEXT);
    }

    // Visibility Tests.
    @Test
    public void footer_isVisibleWhenThereAreValidInjections() {
        mResolveInfos.add(
                getTestResolveInfo(/* isSystemApp= */ true, /* hasRequiredMetadata= */ true));
        mControllerHelper.sendLifecycleEvent(Lifecycle.Event.ON_CREATE);

        assertThat(mGroup.isVisible()).isTrue();
    }

    @Test
    public void footer_isHiddenWhenThereAreNoValidInjections_notSystemApp() {
        mResolveInfos.add(
                getTestResolveInfo(/* isSystemApp= */ false, /* hasRequiredMetadata= */ true));
        mControllerHelper.sendLifecycleEvent(Lifecycle.Event.ON_CREATE);

        assertThat(mGroup.isVisible()).isFalse();
    }

    @Test
    public void footer_isHiddenWhenThereAreNoValidInjections_noMetaData() {
        mResolveInfos.add(
                getTestResolveInfo(/* isSystemApp= */ true, /* hasRequiredMetadata= */ false));
        mControllerHelper.sendLifecycleEvent(Lifecycle.Event.ON_CREATE);

        assertThat(mGroup.isVisible()).isFalse();
    }

    // Correctness Tests.
    @Test
    public void onCreate_addsInjectedFooterToGroup() {
        int numFooters = 3;
        for (int i = 0; i < numFooters; i++) {
            mResolveInfos.add(
                    getTestResolveInfo(/* isSystemApp= */ true, /* hasRequiredMetadata= */ true));
        }
        mControllerHelper.sendLifecycleEvent(Lifecycle.Event.ON_CREATE);

        assertThat(mGroup.getPreferenceCount()).isEqualTo(numFooters);
    }

    @Test
    public void onCreate_injectedFooterHasCorrectText() {
        mResolveInfos.add(
                getTestResolveInfo(/* isSystemApp= */ true, /* hasRequiredMetadata= */ true));
        mControllerHelper.sendLifecycleEvent(Lifecycle.Event.ON_CREATE);

        assertThat(mGroup.getPreference(0).getSummary()).isEqualTo(TEST_TEXT);
    }

    @Test
    public void onCreate_injectedFooterIsNotSelectable() {
        mResolveInfos.add(
                getTestResolveInfo(/* isSystemApp= */ true, /* hasRequiredMetadata= */ true));
        mControllerHelper.sendLifecycleEvent(Lifecycle.Event.ON_CREATE);

        assertThat(mGroup.getPreference(0).isSelectable()).isFalse();
    }

    /**
     * Returns a ResolveInfo object for testing.
     *
     * <p>Injections are only valid if they are both a system app, and have the required METADATA.
     *
     * @param isSystemApp         true if the application is a system app.
     * @param hasRequiredMetaData true if the broadcast receiver has a valid value for
     *                            {@link LocationManager#METADATA_SETTINGS_FOOTER_STRING}
     */
    private ResolveInfo getTestResolveInfo(boolean isSystemApp, boolean hasRequiredMetaData) {
        ResolveInfo testResolveInfo = new ResolveInfo();
        ApplicationInfo testAppInfo = new ApplicationInfo();
        if (isSystemApp) {
            testAppInfo.flags |= ApplicationInfo.FLAG_SYSTEM;
        }
        ActivityInfo testActivityInfo = new ActivityInfo();
        testActivityInfo.name = "TestActivityName";
        testActivityInfo.packageName = "TestPackageName";
        testActivityInfo.applicationInfo = testAppInfo;
        if (hasRequiredMetaData) {
            testActivityInfo.metaData = new Bundle();
            testActivityInfo.metaData.putInt(
                    LocationManager.METADATA_SETTINGS_FOOTER_STRING, TEST_RES_ID);
        }
        testResolveInfo.activityInfo = testActivityInfo;
        return testResolveInfo;
    }
}