DefaultSearchEngineDialogTest.java | Explore in Territory

// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package org.chromium.chrome.browser.search_engines;

import static androidx.test.espresso.Espresso.onView;
import static androidx.test.espresso.action.ViewActions.click;
import static androidx.test.espresso.assertion.ViewAssertions.doesNotExist;
import static androidx.test.espresso.assertion.ViewAssertions.matches;
import static androidx.test.espresso.matcher.RootMatchers.isDialog;
import static androidx.test.espresso.matcher.ViewMatchers.isDisplayed;
import static androidx.test.espresso.matcher.ViewMatchers.isEnabled;
import static androidx.test.espresso.matcher.ViewMatchers.withId;
import static androidx.test.espresso.matcher.ViewMatchers.withText;

import static org.hamcrest.Matchers.not;
import static org.mockito.Mockito.verify;

import androidx.test.espresso.Espresso;
import androidx.test.filters.LargeTest;
import androidx.test.filters.MediumTest;

import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnit;
import org.mockito.junit.MockitoRule;
import org.mockito.quality.Strictness;

import org.chromium.base.Callback;
import org.chromium.base.ThreadUtils;
import org.chromium.base.test.BaseActivityTestRule;
import org.chromium.base.test.util.Batch;
import org.chromium.base.test.util.CallbackHelper;
import org.chromium.base.test.util.CommandLineFlags;
import org.chromium.base.test.util.UserActionTester;
import org.chromium.chrome.browser.flags.ChromeSwitches;
import org.chromium.chrome.browser.init.ChromeBrowserInitializer;
import org.chromium.chrome.browser.locale.LocaleManager;
import org.chromium.chrome.browser.locale.LocaleManagerDelegate;
import org.chromium.chrome.browser.profiles.ProfileManager;
import org.chromium.chrome.test.ChromeJUnit4ClassRunner;
import org.chromium.components.search_engines.FakeTemplateUrl;
import org.chromium.components.search_engines.TemplateUrl;
import org.chromium.components.search_engines.TemplateUrlService;
import org.chromium.ui.test.util.BlankUiTestActivity;

import java.util.Arrays;
import java.util.List;

/** Integration tests for the {@link DefaultSearchEngineDialogCoordinator}. */
@RunWith(ChromeJUnit4ClassRunner.class)
@CommandLineFlags.Add({ChromeSwitches.DISABLE_FIRST_RUN_EXPERIENCE})
@Batch(Batch.PER_CLASS)
public class DefaultSearchEngineDialogTest {
    @Rule
    public BaseActivityTestRule mActivityTestRule =
            new BaseActivityTestRule(BlankUiTestActivity.class);

    @Rule public MockitoRule mMockitoRule = MockitoJUnit.rule().strictness(Strictness.STRICT_STUBS);

    @Mock private Callback<Boolean> mOnSuccessCallback;

    private final FakeTemplateUrl mEngine1 = new FakeTemplateUrl("EngineOne", "EngineOneKeyword");
    private final FakeTemplateUrl mEngine2 = new FakeTemplateUrl("EngineTwo", "EngineTwoKeyword");

    private UserActionTester mUserActionTester;

    @Before
    public void setUp() throws Exception {
        final CallbackHelper templateUrlServiceInit = new CallbackHelper();
        ThreadUtils.runOnUiThreadBlocking(
                () -> {
                    ChromeBrowserInitializer.getInstance().handleSynchronousStartup();

                    LocaleManagerDelegate fakeDelegate =
                            new LocaleManagerDelegate() {
                                @Override
                                public List<TemplateUrl> getSearchEnginesForPromoDialog(
                                        int promoType) {
                                    return getTemplateUrlService().getTemplateUrls();
                                }
                            };
                    LocaleManager.getInstance().setDelegateForTest(fakeDelegate);

                    getTemplateUrlService()
                            .registerLoadListener(
                                    new TemplateUrlService.LoadListener() {
                                        @Override
                                        public void onTemplateUrlServiceLoaded() {
                                            getTemplateUrlService().unregisterLoadListener(this);
                                            templateUrlServiceInit.notifyCalled();
                                        }
                                    });
                });
        templateUrlServiceInit.waitForOnly();
        mActivityTestRule.launchActivity(null);
        mUserActionTester = new UserActionTester();
    }

    @After
    public void tearDown() {
        mUserActionTester.tearDown();
    }

    @Test
    @MediumTest
    public void testUserActionShowNew() {
        Assert.assertEquals(
                0, mUserActionTester.getActionCount("SearchEnginePromo.NewDevice.Shown.Dialog"));
        Assert.assertEquals(
                0,
                mUserActionTester.getActionCount("SearchEnginePromo.ExistingDevice.Shown.Dialog"));
        showDialog(SearchEnginePromoType.SHOW_NEW);
        onView(withText(R.string.search_engine_dialog_title))
                .inRoot(isDialog())
                .check(matches(isDisplayed()));

        Assert.assertEquals(
                1, mUserActionTester.getActionCount("SearchEnginePromo.NewDevice.Shown.Dialog"));
        Assert.assertEquals(
                0,
                mUserActionTester.getActionCount("SearchEnginePromo.ExistingDevice.Shown.Dialog"));
    }

    @Test
    @MediumTest
    public void testUserActionShowExisting() {
        Assert.assertEquals(
                0, mUserActionTester.getActionCount("SearchEnginePromo.NewDevice.Shown.Dialog"));
        Assert.assertEquals(
                0,
                mUserActionTester.getActionCount("SearchEnginePromo.ExistingDevice.Shown.Dialog"));
        showDialog(SearchEnginePromoType.SHOW_EXISTING);
        onView(withText(R.string.search_engine_dialog_title))
                .inRoot(isDialog())
                .check(matches(isDisplayed()));

        Assert.assertEquals(
                0, mUserActionTester.getActionCount("SearchEnginePromo.NewDevice.Shown.Dialog"));
        Assert.assertEquals(
                1,
                mUserActionTester.getActionCount("SearchEnginePromo.ExistingDevice.Shown.Dialog"));
    }

    @Test
    @LargeTest
    public void testDialogView() {
        showDialog(SearchEnginePromoType.SHOW_EXISTING);

        onView(withText(R.string.search_engine_dialog_title))
                .inRoot(isDialog())
                .check(matches(isDisplayed()));
        onView(withText(mEngine1.getShortName())).inRoot(isDialog()).check(matches(isDisplayed()));
        onView(withText(mEngine2.getShortName())).inRoot(isDialog()).check(matches(isDisplayed()));
        onView(withId(R.id.primary_button)).inRoot(isDialog()).check(matches(not(isEnabled())));
    }

    @Test
    @LargeTest
    public void testButtonClickRunsCallback() {
        showDialog(SearchEnginePromoType.SHOW_EXISTING);
        onView(withText(R.string.search_engine_dialog_title))
                .inRoot(isDialog())
                .check(matches(isDisplayed()));

        onView(withText(mEngine1.getShortName())).inRoot(isDialog()).perform(click());
        onView(withId(R.id.primary_button)).inRoot(isDialog()).perform(click());

        verify(mOnSuccessCallback).onResult(true);
    }

    @Test
    @LargeTest
    public void testButtonClickDismissesDialog() {
        showDialog(SearchEnginePromoType.SHOW_EXISTING);
        onView(withText(R.string.search_engine_dialog_title))
                .inRoot(isDialog())
                .check(matches(isDisplayed()));

        onView(withText(mEngine1.getShortName())).inRoot(isDialog()).perform(click());
        onView(withId(R.id.primary_button)).inRoot(isDialog()).perform(click());

        onView(withText(R.string.search_engine_dialog_title)).check(doesNotExist());
    }

    @Test
    @LargeTest
    public void testBackPressDoesNotDismissDialog() {
        showDialog(SearchEnginePromoType.SHOW_EXISTING);
        onView(withText(R.string.search_engine_dialog_title))
                .inRoot(isDialog())
                .check(matches(isDisplayed()));

        Espresso.pressBack();

        onView(withText(R.string.search_engine_dialog_title))
                .inRoot(isDialog())
                .check(matches(isDisplayed()));
    }

    private void showDialog(@SearchEnginePromoType int promoType) {
        DefaultSearchEngineDialogHelper.Delegate delegate =
                new DefaultSearchEngineDialogHelper.Delegate() {
                    @Override
                    public List<TemplateUrl> getSearchEnginesForPromoDialog(
                            @SearchEnginePromoType int type) {
                        return Arrays.asList(mEngine1, mEngine2);
                    }

                    @Override
                    public void onUserSearchEngineChoice(
                            @SearchEnginePromoType int type,
                            List<String> keywords,
                            String keyword) {}
                };
        ThreadUtils.runOnUiThreadBlocking(
                () -> {
                    new DefaultSearchEngineDialogCoordinator(
                                    mActivityTestRule.getActivity(),
                                    delegate,
                                    promoType,
                                    mOnSuccessCallback)
                            .show();
                });
    }

    private TemplateUrlService getTemplateUrlService() {
        return TemplateUrlServiceFactory.getForProfile(ProfileManager.getLastUsedRegularProfile());
    }
}
chromium/chrome/android/javatests/src/org/chromium/chrome/browser/search_engines/DefaultSearchEngineDialogTest.java
