settings/panel/PanelFragmentTest.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.settings.panel;

import static com.android.settings.panel.PanelContent.VIEW_TYPE_SLIDER;
import static com.android.settings.panel.PanelContent.VIEW_TYPE_SLIDER_LARGE_ICON;

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

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import android.app.settings.SettingsEnums;
import android.content.Context;
import android.net.Uri;
import android.os.Bundle;
import android.view.LayoutInflater;
import android.view.View;
import android.widget.Button;
import android.widget.LinearLayout;
import android.widget.TextView;

import androidx.core.graphics.drawable.IconCompat;

import com.android.settings.R;
import com.android.settings.testutils.FakeFeatureFactory;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.ArgumentCaptor;
import org.robolectric.Robolectric;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.RuntimeEnvironment;
import org.robolectric.android.controller.ActivityController;

import java.util.Objects;

@RunWith(RobolectricTestRunner.class)
public class PanelFragmentTest {

    private static final String TITLE = "title";
    private static final String TITLE2 = "title2";
    private static final String SUBTITLE = "subtitle";
    private static final String SUBTITLE2 = "subtitle2";

    private Context mContext;
    private PanelFragment mPanelFragment;
    private FakeSettingsPanelActivity mActivity;
    private FakeFeatureFactory mFakeFeatureFactory;
    private PanelFeatureProvider mPanelFeatureProvider;
    private FakePanelContent mFakePanelContent;
    private ArgumentCaptor<PanelContentCallback> mPanelContentCbs = ArgumentCaptor.forClass(
            PanelContentCallback.class);

    private final String FAKE_EXTRA = "fake_extra";

    @Before
    public void setUp() {
        mContext = RuntimeEnvironment.application;

        mPanelFeatureProvider = spy(new PanelFeatureProviderImpl());
        mFakeFeatureFactory = FakeFeatureFactory.setupForTest();
        mFakeFeatureFactory.panelFeatureProvider = mPanelFeatureProvider;
        mFakePanelContent = spy(new FakePanelContent());
        doReturn(mFakePanelContent).when(mPanelFeatureProvider).getPanel(any(), any());
    }

    private void initFakeActivity() {
        mActivity = spy(Robolectric.buildActivity(FakeSettingsPanelActivity.class).setup().get());

        mPanelFragment =
                spy((PanelFragment)
                        mActivity.getSupportFragmentManager().findFragmentById(R.id.main_content));
        doReturn(mActivity).when(mPanelFragment).getActivity();

        final Bundle bundle = new Bundle();
        bundle.putString(SettingsPanelActivity.KEY_PANEL_TYPE_ARGUMENT, FAKE_EXTRA);
        doReturn(bundle).when(mPanelFragment).getArguments();
    }

    @Test
    public void onCreateView_countdownLatch_setup() {
        initFakeActivity();
        mPanelFragment.onCreateView(LayoutInflater.from(mContext),
                new LinearLayout(mContext), null);
        PanelSlicesLoaderCountdownLatch countdownLatch =
                mPanelFragment.mPanelSlicesLoaderCountdownLatch;
        for (Uri sliecUri : mFakePanelContent.getSlices()) {
            countdownLatch.markSliceLoaded(sliecUri);
        }

        assertThat(countdownLatch.isPanelReadyToLoad()).isTrue();
    }

    @Test
    public void onCreate_logsOpenEvent() {
        initFakeActivity();
        verify(mFakeFeatureFactory.metricsFeatureProvider).action(
                0,
                SettingsEnums.PAGE_VISIBLE,
                mFakePanelContent.getMetricsCategory(),
                null,
                0);
    }

    @Test
    public void onDestroy_logCloseEvent() {
        initFakeActivity();
        mPanelFragment.onDestroyView();
        verify(mFakeFeatureFactory.metricsFeatureProvider).action(
                0,
                SettingsEnums.PAGE_HIDE,
                mFakePanelContent.getMetricsCategory(),
                PanelLoggingContract.PanelClosedKeys.KEY_OTHERS,
                0);
    }

    @Test
    public void panelSeeMoreClick_logsCloseEvent() {
        initFakeActivity();
        final View.OnClickListener listener = mPanelFragment.getSeeMoreListener();
        listener.onClick(null);
        verify(mActivity).finish();

        mPanelFragment.onDestroyView();
        verify(mFakeFeatureFactory.metricsFeatureProvider).action(
                0,
                SettingsEnums.PAGE_HIDE,
                mFakePanelContent.getMetricsCategory(),
                PanelLoggingContract.PanelClosedKeys.KEY_SEE_MORE,
                0
        );
    }

    @Test
    public void panelDoneClick_logsCloseEvent() {
        initFakeActivity();
        final View.OnClickListener listener = mPanelFragment.getCloseListener();
        listener.onClick(null);
        verify(mActivity).finish();

        mPanelFragment.onDestroyView();
        verify(mFakeFeatureFactory.metricsFeatureProvider).action(
                0,
                SettingsEnums.PAGE_HIDE,
                mFakePanelContent.getMetricsCategory(),
                PanelLoggingContract.PanelClosedKeys.KEY_DONE,
                0
        );
    }

    @Test
    public void supportIcon_displayIconHeaderLayout() {
        final IconCompat icon = IconCompat.createWithResource(mContext, R.drawable.ic_android);
        mFakePanelContent.setIcon(icon);
        mFakePanelContent.setSubTitle(SUBTITLE);
        final ActivityController<FakeSettingsPanelActivity> activityController =
                Robolectric.buildActivity(FakeSettingsPanelActivity.class);
        activityController.setup();
        final PanelFragment panelFragment = (PanelFragment)
                Objects.requireNonNull(activityController
                        .get()
                        .getSupportFragmentManager()
                        .findFragmentById(R.id.main_content));
        final View titleView = panelFragment.mLayoutView.findViewById(R.id.panel_title);
        final LinearLayout panelHeader = panelFragment.mLayoutView.findViewById(R.id.panel_header);
        final TextView headerTitle = panelFragment.mLayoutView.findViewById(R.id.header_title);
        final TextView headerSubtitle = panelFragment.mLayoutView.findViewById(
                R.id.header_subtitle);
        // Check visibility
        assertThat(panelHeader.getVisibility()).isEqualTo(View.VISIBLE);
        assertThat(titleView.getVisibility()).isEqualTo(View.GONE);
        // Check content
        assertThat(headerTitle.getText()).isEqualTo(FakePanelContent.TITLE);
        assertThat(headerSubtitle.getText()).isEqualTo(SUBTITLE);
    }

    @Test
    public void notSupportIcon_displayDefaultHeaderLayout() {
        final ActivityController<FakeSettingsPanelActivity> activityController =
                Robolectric.buildActivity(FakeSettingsPanelActivity.class);
        activityController.setup();
        final PanelFragment panelFragment = (PanelFragment)
                Objects.requireNonNull(activityController
                        .get()
                        .getSupportFragmentManager()
                        .findFragmentById(R.id.main_content));

        final View titleView = panelFragment.mLayoutView.findViewById(R.id.panel_title);
        final View panelHeader = panelFragment.mLayoutView.findViewById(R.id.panel_header);

        assertThat(panelHeader.getVisibility()).isEqualTo(View.GONE);
        assertThat(titleView.getVisibility()).isEqualTo(View.VISIBLE);
    }

    @Test
    public void sliderLargeIconPanelType_displayFooterDivider() {
        mFakePanelContent.setViewType(VIEW_TYPE_SLIDER_LARGE_ICON);
        final ActivityController<FakeSettingsPanelActivity> activityController =
                Robolectric.buildActivity(FakeSettingsPanelActivity.class);
        activityController.setup();
        final PanelFragment panelFragment = (PanelFragment)
                Objects.requireNonNull(activityController
                        .get()
                        .getSupportFragmentManager()
                        .findFragmentById(R.id.main_content));
        final View footerDivider = panelFragment.mLayoutView.findViewById(R.id.footer_divider);
        // Check visibility
        assertThat(footerDivider.getVisibility()).isEqualTo(View.VISIBLE);
    }

    @Test
    public void sliderPanelType_notDisplayFooterDivider() {
        mFakePanelContent.setViewType(VIEW_TYPE_SLIDER);
        final ActivityController<FakeSettingsPanelActivity> activityController =
                Robolectric.buildActivity(FakeSettingsPanelActivity.class);
        activityController.setup();
        final PanelFragment panelFragment = (PanelFragment)
                Objects.requireNonNull(activityController
                        .get()
                        .getSupportFragmentManager()
                        .findFragmentById(R.id.main_content));
        final View footerDivider = panelFragment.mLayoutView.findViewById(R.id.footer_divider);
        // Check visibility
        assertThat(footerDivider.getVisibility()).isEqualTo(View.GONE);
    }

    @Test
    public void defaultPanelType_notDisplayFooterDivider() {
        mFakePanelContent.setViewType(0 /* viewType */);
        final ActivityController<FakeSettingsPanelActivity> activityController =
                Robolectric.buildActivity(FakeSettingsPanelActivity.class);
        activityController.setup();
        final PanelFragment panelFragment = (PanelFragment)
                Objects.requireNonNull(activityController
                        .get()
                        .getSupportFragmentManager()
                        .findFragmentById(R.id.main_content));
        final View footerDivider = panelFragment.mLayoutView.findViewById(R.id.footer_divider);
        // Check visibility
        assertThat(footerDivider.getVisibility()).isEqualTo(View.GONE);
    }

    @Test
    public void onHeaderChanged_updateHeader_verifyTitle() {
        mFakePanelContent.setIcon(IconCompat.createWithResource(mContext, R.drawable.ic_android));
        mFakePanelContent.setTitle(TITLE);
        mFakePanelContent.setSubTitle(SUBTITLE);
        final ActivityController<FakeSettingsPanelActivity> activityController =
                Robolectric.buildActivity(FakeSettingsPanelActivity.class);
        activityController.setup();
        final PanelFragment panelFragment = (PanelFragment)
                Objects.requireNonNull(activityController
                        .get()
                        .getSupportFragmentManager()
                        .findFragmentById(R.id.main_content));
        final TextView headerTitle = panelFragment.mLayoutView.findViewById(R.id.header_title);
        final TextView headerSubtitle = panelFragment.mLayoutView.findViewById(
                R.id.header_subtitle);

        assertThat(headerTitle.getText()).isEqualTo(TITLE);
        assertThat(headerSubtitle.getText()).isEqualTo(SUBTITLE);

        mFakePanelContent.setTitle(TITLE2);
        mFakePanelContent.setSubTitle(SUBTITLE2);
        verify(mFakePanelContent).registerCallback(mPanelContentCbs.capture());
        final PanelContentCallback panelContentCallbacks = mPanelContentCbs.getValue();
        panelContentCallbacks.onHeaderChanged();

        assertThat(headerTitle.getText()).isEqualTo(TITLE2);
        assertThat(headerSubtitle.getText()).isEqualTo(SUBTITLE2);
    }

    @Test
    public void forceClose_verifyFinish() {
        initFakeActivity();
        verify(mFakePanelContent).registerCallback(mPanelContentCbs.capture());
        final PanelContentCallback panelContentCallbacks = spy(mPanelContentCbs.getValue());
        when(((PanelFragment.LocalPanelCallback) panelContentCallbacks).getFragmentActivity())
                .thenReturn(mActivity);

        panelContentCallbacks.forceClose();

        verify(mActivity).finish();
    }

    @Test
    public void onCustomizedButtonStateChanged_isCustomized_showCustomizedTitle() {
        final ActivityController<FakeSettingsPanelActivity> activityController =
                Robolectric.buildActivity(FakeSettingsPanelActivity.class);
        activityController.setup();
        final PanelFragment panelFragment = (PanelFragment)
                Objects.requireNonNull(activityController
                        .get()
                        .getSupportFragmentManager()
                        .findFragmentById(R.id.main_content));

        final Button seeMoreButton = panelFragment.mLayoutView.findViewById(R.id.see_more);

        mFakePanelContent.setIsCustomizedButtonUsed(true);
        mFakePanelContent.setCustomizedButtonTitle("test_title");
        verify(mFakePanelContent).registerCallback(mPanelContentCbs.capture());
        final PanelContentCallback panelContentCallbacks = mPanelContentCbs.getValue();
        panelContentCallbacks.onCustomizedButtonStateChanged();

        assertThat(seeMoreButton.getVisibility()).isEqualTo(View.VISIBLE);
        assertThat(seeMoreButton.getText()).isEqualTo("test_title");
    }
}