// Copyright 2023 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.webapps;
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.ViewMatchers.isDisplayed;
import static androidx.test.espresso.matcher.ViewMatchers.isEnabled;
import static androidx.test.espresso.matcher.ViewMatchers.isNotEnabled;
import static androidx.test.espresso.matcher.ViewMatchers.withId;
import static androidx.test.espresso.matcher.ViewMatchers.withText;
import static org.chromium.ui.test.util.ViewUtils.onViewWaiting;
import android.view.ViewGroup;
import android.widget.CheckBox;
import androidx.test.espresso.Espresso;
import androidx.test.filters.SmallTest;
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.chromium.base.Log;
import org.chromium.base.shared_preferences.SharedPreferencesManager;
import org.chromium.base.test.util.CommandLineFlags;
import org.chromium.base.test.util.DoNotBatch;
import org.chromium.base.test.util.Feature;
import org.chromium.base.test.util.Features.DisableFeatures;
import org.chromium.base.test.util.Features.EnableFeatures;
import org.chromium.chrome.browser.PwaRestoreBottomSheetTestUtils;
import org.chromium.chrome.browser.firstrun.FirstRunStatus;
import org.chromium.chrome.browser.flags.ChromeFeatureList;
import org.chromium.chrome.browser.flags.ChromeSwitches;
import org.chromium.chrome.browser.preferences.ChromePreferenceKeys;
import org.chromium.chrome.browser.preferences.ChromeSharedPreferences;
import org.chromium.chrome.browser.webapps.PwaRestorePromoUtils.DisplayStage;
import org.chromium.chrome.test.ChromeJUnit4ClassRunner;
import org.chromium.chrome.test.ChromeTabbedActivityTestRule;
import org.chromium.components.webapps.R;
import org.chromium.content_public.browser.test.NativeLibraryTestUtils;
import org.chromium.net.test.EmbeddedTestServer;
/** Test the showing of the PWA Restore Bottom Sheet dialog. */
@RunWith(ChromeJUnit4ClassRunner.class)
@DoNotBatch(reason = "Function getURL for EmbeddedTestServer fails when batching")
@EnableFeatures({
ChromeFeatureList.PWA_RESTORE_UI,
ChromeFeatureList.WEB_APK_BACKUP_AND_RESTORE_BACKEND
})
@CommandLineFlags.Add({ChromeSwitches.DISABLE_FIRST_RUN_EXPERIENCE})
public class PwaRestoreBottomSheetIntegrationTest {
@Rule
public final ChromeTabbedActivityTestRule mActivityTestRule =
new ChromeTabbedActivityTestRule();
private static @DisplayStage int sFlagValueMissing = DisplayStage.UNKNOWN_STATUS;
private static final String ICON_URL1 = "/chrome/test/data/banners/256x256-green.png";
private static final String ICON_URL2 = "/chrome/test/data/banners/256x256-red.png";
private static String[][] sDefaultApps = {
{"https://example.com/app1/", "App 1", ICON_URL1},
{"https://example.com/app2/", "App 2", ICON_URL2},
{"https://example.com/app3/", "App 3", ICON_URL1}
};
private static int[] sDefaultLastUsed = {1, 2, 3};
private static final String TAG = "PwaRestoreIntegrTest";
private SharedPreferencesManager mPreferences;
private EmbeddedTestServer mTestServer;
@Before
public void setUp() throws Exception {
NativeLibraryTestUtils.loadNativeLibraryNoBrowserProcess();
mPreferences = ChromeSharedPreferences.getInstance();
mTestServer = mActivityTestRule.getTestServer();
// Promos only run *after* the first run experience has completed, so we need to make sure
// the testing environment reflects that. Note that individual tests below can set whether
// the first run experience completed just now or in a previous launch.
FirstRunStatus.setFirstRunFlowComplete(true);
// The first run sequence always suppresses all promos during the first launch, so we must
// do the same to make sure the testing environment reflects what happens during normal
// startup.
mPreferences.writeBoolean(ChromePreferenceKeys.PROMOS_SKIPPED_ON_FIRST_START, true);
}
private boolean setTestAppsForRestoring(String[][] appList, int[] lastUsed) {
Assert.assertEquals(appList.length, lastUsed.length);
for (String[] app : appList) {
app[2] = mTestServer.getURL(app[2]);
}
try {
PwaRestoreBottomSheetTestUtils.waitForWebApkDatabaseInitialization();
PwaRestoreBottomSheetTestUtils.setAppListForRestoring(appList, lastUsed);
return true;
} catch (Exception e) {
Log.e(TAG, "setTestAppsForRestoring failed " + e);
return false;
}
}
@After
public void tearDown() {
// Clean up the pref we created.
mPreferences.removeKeySync(ChromePreferenceKeys.PWA_RESTORE_PROMO_STAGE);
mPreferences.removeKeySync(ChromePreferenceKeys.PROMOS_SKIPPED_ON_FIRST_START);
}
@Test
@SmallTest
@Feature({"PwaRestore"})
public void testInitialLaunchOnNewProfile() {
// This test simulates the very first launch of Chrome on a new device. The test makes sure
// that once the first run experience is triggered, the PwaRestore promo gets notified about
// it, but the promo is not shown.
// To do this, we need to set the FirstRunStatus to simulate that the first run
// experience has been triggered during this launch.
FirstRunStatus.setFirstRunTriggeredForTesting(true);
// At the beginning, there should be no signal, but at the end we should be ready to show
// the promo during the next launch (see `testSecondLaunchAfterBeingNotified`).
assertCurrentFlag(sFlagValueMissing);
mActivityTestRule.startMainActivityFromLauncher();
assertDialogShown(false);
assertCurrentFlag(DisplayStage.SHOW_PROMO);
}
@Test
@SmallTest
@Feature({"PwaRestore"})
public void testSecondLaunchAfterBeingNotified() {
// This test makes sure that on the subsequent launch -- after getting notified about the
// first run experience having triggered already -- the promo dialog is showing and the
// right pref has been written (`ALREADY_LAUNCHED`) to make sure we don't show again.
setAppsAvailableAndPromoStage(true, DisplayStage.SHOW_PROMO);
assertCurrentFlag(DisplayStage.SHOW_PROMO);
mActivityTestRule.startMainActivityFromLauncher();
assertDialogShown(true);
assertCurrentFlag(DisplayStage.ALREADY_LAUNCHED);
}
@Test
@SmallTest
@Feature({"PwaRestore"})
public void testSecondLaunchAfterBeingNotifiedButNoApps() {
// This test makes sure that if we get notified to show, but no apps are available to
// restore,
// that we don't show the promo and suppress it from showing in the future.
setAppsAvailableAndPromoStage(false, DisplayStage.SHOW_PROMO);
assertCurrentFlag(DisplayStage.SHOW_PROMO);
mActivityTestRule.startMainActivityFromLauncher();
assertDialogShown(false);
assertCurrentFlag(DisplayStage.NO_APPS_AVAILABLE);
}
@Test
@SmallTest
@Feature({"PwaRestore"})
public void testEveryLaunchAfterShowing() {
// This test makes sure that after showing the dialog once, the flag remains set and the
// dialog is not shown again.
setAppsAvailableAndPromoStage(true, DisplayStage.ALREADY_LAUNCHED);
assertCurrentFlag(DisplayStage.ALREADY_LAUNCHED);
mActivityTestRule.startMainActivityFromLauncher();
assertDialogShown(false);
assertCurrentFlag(DisplayStage.ALREADY_LAUNCHED);
}
@Test
@SmallTest
@Feature({"PwaRestore"})
public void testInitialLaunchOnPreexistingProfile() {
// This test makes sure that, if the first run experience was completed in the past
// (simulated by not calling `setFirstRunTriggeredForTesting(true)`), that it is treated
// as if the profile is pre-existing, and we don't show the promo (ever).
mPreferences.writeBoolean(ChromePreferenceKeys.PWA_RESTORE_APPS_AVAILABLE, true);
assertCurrentFlag(sFlagValueMissing);
mActivityTestRule.startMainActivityFromLauncher();
assertDialogShown(false);
assertCurrentFlag(DisplayStage.PRE_EXISTING_PROFILE);
}
@Test
@SmallTest
@Feature({"PwaRestore"})
public void testEveryLaunchAfterDetectingNoShow() {
// This test makes sure that after determining the profile is too old to show the promo, the
// flag remains set and the dialog is not shown.
setAppsAvailableAndPromoStage(true, DisplayStage.PRE_EXISTING_PROFILE);
assertCurrentFlag(DisplayStage.PRE_EXISTING_PROFILE);
mActivityTestRule.startMainActivityFromLauncher();
assertDialogShown(false);
assertCurrentFlag(DisplayStage.PRE_EXISTING_PROFILE);
}
@Test
@SmallTest
@Feature({"PwaRestore"})
public void testBackButton() {
// This test opens the dialog, clicks the Review button to expand the bottom sheet dialog
// and then presses the Back in the OS twice to see what happens (first click should
// navigate back to the initial dialog state, second click closes the dialog).
Assert.assertTrue(setTestAppsForRestoring(sDefaultApps, sDefaultLastUsed));
// Ensure the promo dialog shows.
setAppsAvailableAndPromoStage(true, DisplayStage.SHOW_PROMO);
mActivityTestRule.startMainActivityFromLauncher();
// Verify we're in initial state for the dialog.
assertDialogShown(true);
onViewWaiting(withText("Restore your web apps")).check(matches(isDisplayed()));
// Go to PWA list mode.
onView(withId(R.id.review_button)).perform(click());
onViewWaiting(withText("Web apps used in the last month")).check(matches(isDisplayed()));
// Pressing the Back button in Android once should bring us to the initial dialog state.
Espresso.pressBack();
onViewWaiting(withText("Restore your web apps")).check(matches(isDisplayed()));
// Pressing the Back button again should close the bottom sheet.
Espresso.pressBack();
assertDialogShown(false);
}
@Test
@SmallTest
@Feature({"PwaRestore"})
public void testClickForwarding() {
Assert.assertTrue(setTestAppsForRestoring(sDefaultApps, sDefaultLastUsed));
// Ensure the promo dialog shows.
setAppsAvailableAndPromoStage(true, DisplayStage.SHOW_PROMO);
mActivityTestRule.startMainActivityFromLauncher();
assertDialogShown(true);
onView(withId(R.id.review_button)).perform(click());
assertIsComboCheckedAtIndex(1, true);
onView(withText("App 1")).check(matches(isDisplayed()));
onView(withText("App 1")).perform(click());
assertIsComboCheckedAtIndex(1, false);
}
@Test
@SmallTest
@Feature({"PwaRestore"})
public void testButtonsInitiallyDisabled() throws Exception {
// Ensure the promo dialog shows.
setAppsAvailableAndPromoStage(true, DisplayStage.SHOW_PROMO);
mActivityTestRule.startMainActivityFromLauncher();
assertDialogShown(true);
onView(withId(R.id.review_button)).perform(click());
// Deselect and Restore buttons should now be disabled (nothing to act on).
onView(withId(R.id.deselect_button)).check(matches(isNotEnabled()));
onView(withId(R.id.restore_button)).check(matches(isNotEnabled()));
}
@Test
@SmallTest
@Feature({"PwaRestore"})
public void testDeselectAll() throws Exception {
Assert.assertTrue(setTestAppsForRestoring(sDefaultApps, sDefaultLastUsed));
// Ensure the promo dialog shows.
setAppsAvailableAndPromoStage(true, DisplayStage.SHOW_PROMO);
mActivityTestRule.startMainActivityFromLauncher();
assertDialogShown(true);
onView(withId(R.id.review_button)).perform(click());
assertIsComboCheckedAtIndex(0, true);
assertIsComboCheckedAtIndex(1, true);
assertIsComboCheckedAtIndex(2, true);
// Deselect and Restore buttons should start in enabled state.
onView(withId(R.id.deselect_button)).check(matches(isEnabled()));
onView(withId(R.id.restore_button)).check(matches(isEnabled()));
// Now verify the Deselect function leaves everything in unchecked state.
onView(withId(R.id.deselect_button)).check(matches(isDisplayed()));
onView(withId(R.id.deselect_button)).perform(click());
assertIsComboCheckedAtIndex(0, false);
assertIsComboCheckedAtIndex(1, false);
assertIsComboCheckedAtIndex(2, false);
// Deselect and Restore buttons should now be disabled (nothing to act on).
onView(withId(R.id.deselect_button)).check(matches(isNotEnabled()));
onView(withId(R.id.restore_button)).check(matches(isNotEnabled()));
// Ensure one entry gets checked.
onView(withText("App 1")).check(matches(isDisplayed()));
onView(withText("App 1")).perform(click());
assertIsComboCheckedAtIndex(1, true);
// Deselect and Restore buttons become enabled since we have something to act on.
onView(withId(R.id.deselect_button)).check(matches(isEnabled()));
onView(withId(R.id.restore_button)).check(matches(isEnabled()));
// Ensure same entry gets unchecked again.
onView(withText("App 1")).perform(click());
assertIsComboCheckedAtIndex(1, false);
// Deselect and Restore buttons become disabled since no item remains selected.
onView(withId(R.id.deselect_button)).check(matches(isNotEnabled()));
onView(withId(R.id.restore_button)).check(matches(isNotEnabled()));
}
@Test
@SmallTest
@Feature({"PwaRestore"})
public void testRestoreClosesUi() throws Exception {
Assert.assertTrue(setTestAppsForRestoring(sDefaultApps, sDefaultLastUsed));
// Ensure the promo dialog shows.
setAppsAvailableAndPromoStage(true, DisplayStage.SHOW_PROMO);
mActivityTestRule.startMainActivityFromLauncher();
onViewWaiting(withText("Restore your web apps")).check(matches(isDisplayed()));
onView(withId(R.id.review_button)).perform(click());
onViewWaiting(withText("Web apps used in the last month")).check(matches(isDisplayed()));
onView(withId(R.id.restore_button)).perform(click());
onView(withText("Restore your web apps")).check(doesNotExist());
onView(withText("Web apps used in the last month")).check(doesNotExist());
}
@Test
@SmallTest
@Feature({"PwaRestore"})
@DisableFeatures({ChromeFeatureList.PWA_RESTORE_UI_AT_STARTUP})
public void testForceFlagOff() throws Exception {
mActivityTestRule.startMainActivityFromLauncher();
assertDialogShown(false);
}
@Test
@SmallTest
@Feature({"PwaRestore"})
@EnableFeatures({ChromeFeatureList.PWA_RESTORE_UI_AT_STARTUP})
public void testForceFlagOn() throws Exception {
mActivityTestRule.startMainActivityFromLauncher();
assertDialogShown(true);
}
private void setAppsAvailableAndPromoStage(boolean appsAvailable, @DisplayStage int value) {
mPreferences.writeInt(ChromePreferenceKeys.PWA_RESTORE_PROMO_STAGE, value);
mPreferences.writeBoolean(ChromePreferenceKeys.PWA_RESTORE_APPS_AVAILABLE, appsAvailable);
}
// A helper function to check whether a particular combo box in the PWA list ScrollView is
// checked.
private void assertIsComboCheckedAtIndex(int index, boolean checked) {
onView(withId(R.id.scroll_view_content))
.check(
(view, e) -> {
ViewGroup appList = (ViewGroup) view;
Assert.assertTrue(appList != null);
// The app list contains mostly appviews, but also generic views that
// are separators, for example. For our purposes, we want to skip the
// views that are not checkboxes.
int checkboxCount = 0;
for (int i = 0; i < appList.getChildCount(); ++i) {
CheckBox checkBox =
appList.getChildAt(i).findViewById(R.id.checkbox);
if (checkBox != null) {
if (index == checkboxCount) {
Assert.assertEquals(checked, checkBox.isChecked());
return;
}
checkboxCount += 1;
}
}
});
}
private void assertCurrentFlag(@DisplayStage int value) {
Assert.assertEquals(
value,
mPreferences.readInt(
ChromePreferenceKeys.PWA_RESTORE_PROMO_STAGE, DisplayStage.UNKNOWN_STATUS));
}
private void assertDialogShown(boolean expectShowing) {
if (expectShowing) {
onViewWaiting(withText("Restore your web apps")).check(matches(isDisplayed()));
} else {
// Since the dialog is shown asynchronously, this check might miss when the dialog is
// showing (when it shouldn't), since the check fires before the dialog is shown. But,
// the flipside is that it might catch it some of the time, if not deterministicly.
onView(withText("Restore your web apps")).check(doesNotExist());
}
}
}
Codebase Browser
chromium