// Copyright 2018 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.keyboard_accessory.sheet_tabs;
import static androidx.test.espresso.matcher.ViewMatchers.assertThat;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.Matchers.equalTo;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.mockito.Mockito.when;
import static org.chromium.chrome.browser.keyboard_accessory.ManualFillingMetricsRecorder.UMA_KEYBOARD_ACCESSORY_ACTION_IMPRESSION;
import static org.chromium.chrome.browser.keyboard_accessory.ManualFillingMetricsRecorder.UMA_KEYBOARD_ACCESSORY_TOGGLE_CLICKED;
import static org.chromium.chrome.browser.keyboard_accessory.ManualFillingMetricsRecorder.UMA_KEYBOARD_ACCESSORY_TOGGLE_IMPRESSION;
import static org.chromium.chrome.browser.keyboard_accessory.sheet_tabs.AccessorySheetTabItemsModel.AccessorySheetDataPiece.Type.FOOTER_COMMAND;
import static org.chromium.chrome.browser.keyboard_accessory.sheet_tabs.AccessorySheetTabItemsModel.AccessorySheetDataPiece.Type.TITLE;
import static org.chromium.chrome.browser.keyboard_accessory.sheet_tabs.AccessorySheetTabItemsModel.AccessorySheetDataPiece.getType;
import android.graphics.drawable.Drawable;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.robolectric.RuntimeEnvironment;
import org.robolectric.annotation.Config;
import org.chromium.base.ContextUtils;
import org.chromium.base.metrics.RecordHistogram;
import org.chromium.base.task.test.CustomShadowAsyncTask;
import org.chromium.base.test.BaseRobolectricTestRunner;
import org.chromium.chrome.browser.keyboard_accessory.AccessoryAction;
import org.chromium.chrome.browser.keyboard_accessory.AccessoryTabType;
import org.chromium.chrome.browser.keyboard_accessory.AccessoryToggleType;
import org.chromium.chrome.browser.keyboard_accessory.data.KeyboardAccessoryData;
import org.chromium.chrome.browser.keyboard_accessory.data.KeyboardAccessoryData.AccessorySheetData;
import org.chromium.chrome.browser.keyboard_accessory.data.KeyboardAccessoryData.FooterCommand;
import org.chromium.chrome.browser.keyboard_accessory.data.KeyboardAccessoryData.OptionToggle;
import org.chromium.chrome.browser.keyboard_accessory.data.PropertyProvider;
import org.chromium.chrome.browser.keyboard_accessory.data.Provider;
import org.chromium.chrome.browser.profiles.Profile;
import org.chromium.chrome.browser.util.ChromeAccessibilityUtil;
import org.chromium.ui.modelutil.ListObservable;
import java.util.concurrent.atomic.AtomicReference;
/** Controller tests for the password accessory sheet. */
@RunWith(BaseRobolectricTestRunner.class)
@Config(
manifest = Config.NONE,
shadows = {CustomShadowAsyncTask.class})
public class PasswordAccessorySheetControllerTest {
@Mock private AccessorySheetTabView mMockView;
@Mock private ListObservable.ListObserver<Void> mMockItemListObserver;
@Mock private Profile mProfile;
private PasswordAccessorySheetCoordinator mCoordinator;
private AccessorySheetTabItemsModel mSheetDataPieces;
@Before
public void setUp() {
MockitoAnnotations.initMocks(this);
when(mMockView.getContext()).thenReturn(ContextUtils.getApplicationContext());
AccessorySheetTabCoordinator.IconProvider.setIconForTesting(mock(Drawable.class));
mCoordinator =
new PasswordAccessorySheetCoordinator(
RuntimeEnvironment.application, mProfile, null);
assertNotNull(mCoordinator);
mSheetDataPieces = mCoordinator.getSheetDataPiecesForTesting();
}
@After
public void tearDown() {
ChromeAccessibilityUtil.get().setAccessibilityEnabledForTesting(false);
}
@Test
public void testCreatesValidTab() {
KeyboardAccessoryData.Tab tab = mCoordinator.getTab();
assertNotNull(tab);
assertNotNull(tab.getIcon());
assertNotNull(tab.getListener());
}
@Test
public void testSetsViewAdapterOnTabCreation() {
when(mMockView.getParent()).thenReturn(mMockView);
KeyboardAccessoryData.Tab tab = mCoordinator.getTab();
assertNotNull(tab);
assertNotNull(tab.getListener());
tab.getListener().onTabCreated(mMockView);
verify(mMockView).setAdapter(any());
}
@Test
public void testRequestDefaultFocus() {
ChromeAccessibilityUtil.get().setAccessibilityEnabledForTesting(true);
when(mMockView.getParent()).thenReturn(mMockView);
KeyboardAccessoryData.Tab tab = mCoordinator.getTab();
tab.getListener().onTabCreated(mMockView);
tab.getListener().onTabShown();
verify(mMockView).requestDefaultA11yFocus();
}
@Test
public void testModelNotifiesAboutTabDataChangedByProvider() {
final PropertyProvider<AccessorySheetData> testProvider = new PropertyProvider<>();
mSheetDataPieces.addObserver(mMockItemListObserver);
mCoordinator.registerDataProvider(testProvider);
// If the coordinator receives a set of initial items, the model should report an insertion.
testProvider.notifyObservers(
new AccessorySheetData(
AccessoryTabType.PASSWORDS,
/* userInfoTitle= */ "Passwords",
/* plusAddressTitle= */ "",
/* warning= */ ""));
verify(mMockItemListObserver).onItemRangeInserted(mSheetDataPieces, 0, 1);
assertThat(mSheetDataPieces.size(), is(1));
// If the coordinator receives a new set of items, the model should report a change.
testProvider.notifyObservers(
new AccessorySheetData(
AccessoryTabType.PASSWORDS,
/* userInfoTitle= */ "Other Passwords",
/* plusAddressTitle= */ "",
/* warning= */ ""));
verify(mMockItemListObserver).onItemRangeChanged(mSheetDataPieces, 0, 1, null);
assertThat(mSheetDataPieces.size(), is(1));
// If the coordinator receives an empty set of items, the model should report a deletion.
testProvider.notifyObservers(null);
verify(mMockItemListObserver).onItemRangeRemoved(mSheetDataPieces, 0, 1);
assertThat(mSheetDataPieces.size(), is(0));
// There should be no notification if no item are reported repeatedly.
testProvider.notifyObservers(null);
verifyNoMoreInteractions(mMockItemListObserver);
}
@Test
public void testUsesTabTitleOnlyForEmptyLists() {
final PropertyProvider<AccessorySheetData> testProvider = new PropertyProvider<>();
final AccessorySheetData testData =
new AccessorySheetData(
AccessoryTabType.PASSWORDS,
/* userInfoTitle= */ "No passwords for this domain",
/* plusAddressTitle= */ "No plus addresses for this domain",
/* warning= */ "");
mCoordinator.registerDataProvider(testProvider);
// Providing only FooterCommands and no User Info shows the title as empty state:
testData.getFooterCommands().add(new FooterCommand("Manage passwords", result -> {}));
testProvider.notifyObservers(testData);
assertThat(mSheetDataPieces.size(), is(3));
assertThat(getType(mSheetDataPieces.get(0)), is(TITLE));
assertThat(
mSheetDataPieces.get(0).getDataPiece(),
is(equalTo("No passwords for this domain")));
assertThat(getType(mSheetDataPieces.get(1)), is(TITLE));
assertThat(
mSheetDataPieces.get(1).getDataPiece(),
is(equalTo("No plus addresses for this domain")));
assertThat(getType(mSheetDataPieces.get(2)), is(FOOTER_COMMAND));
}
@Test
public void testOptionToggleCompoundCallback() {
final PropertyProvider<AccessorySheetData> testProvider = new PropertyProvider<>();
final AccessorySheetData testData =
new AccessorySheetData(
AccessoryTabType.PASSWORDS,
/* userInfoTitle= */ "Passwords",
/* plusAddressTitle= */ "",
/* warning= */ "");
AtomicReference<Boolean> toggleEnabled = new AtomicReference<>();
testData.setOptionToggle(
new OptionToggle(
"Save passwords for this site",
false,
AccessoryAction.TOGGLE_SAVE_PASSWORDS,
toggleEnabled::set));
mCoordinator.registerDataProvider(testProvider);
testProvider.notifyObservers(testData);
// Invoke the callback on the option toggle that was stored in the model. This is not the
// same as the OptionToggle passed above, because the mediator repackages it to include an
// additional method call in the callback.
OptionToggle repackagedToggle = (OptionToggle) mSheetDataPieces.get(0).getDataPiece();
// Pretend to enable the toggle like a click would do.
repackagedToggle.getCallback().onResult(true);
// Check that the original callback was called and that the model was updated with an
// enabled toggle.
assertTrue(toggleEnabled.get());
assertTrue(((OptionToggle) mSheetDataPieces.get(0).getDataPiece()).isEnabled());
}
@Test
public void testToggleChangeDelegateIsCalledWhenToggleIsAdded() {
Provider.Observer<Drawable> mMockObserver = mock(Provider.Observer.class);
mCoordinator.getTab().addIconObserver(mMockObserver);
addToggleToSheet(false);
verify(mMockObserver).onItemAvailable(eq(Provider.Observer.DEFAULT_TYPE), any());
}
@Test
public void testToggleChangeDelegateIsCalledWhenToggleIsChanged() {
Provider.Observer<Drawable> mMockIconObserver = mock(Provider.Observer.class);
mCoordinator.getTab().addIconObserver(mMockIconObserver);
addToggleToSheet(false);
// Invoke the callback on the option toggle that was stored in the model. This is not the
// same as the OptionToggle passed above, because the mediator repackages it to include an
// additional method call in the callback.
OptionToggle repackagedToggle = (OptionToggle) mSheetDataPieces.get(0).getDataPiece();
// Pretend to enable the toggle like a click would do.
repackagedToggle.getCallback().onResult(true);
// Note that the icon observer is called once for initialization and once for the change.
verify(mMockIconObserver, times(2))
.onItemAvailable(eq(Provider.Observer.DEFAULT_TYPE), any());
}
@Test
public void testRecordsActionImpressionsWhenShown() {
assertThat(getActionImpressions(AccessoryAction.MANAGE_PASSWORDS), is(0));
// Assuming that "Manage Passwords" remains a default option, showing means an impression.
mCoordinator.onTabShown();
assertThat(getActionImpressions(AccessoryAction.MANAGE_PASSWORDS), is(1));
}
@Test
public void testRecordsToggleOnImpressionsWhenShown() {
assertThat(getToggleImpressions(AccessoryToggleType.SAVE_PASSWORDS_TOGGLE_ON), is(0));
assertThat(getToggleImpressions(AccessoryToggleType.SAVE_PASSWORDS_TOGGLE_OFF), is(0));
addToggleToSheet(true);
mCoordinator.onTabShown();
assertThat(getToggleImpressions(AccessoryToggleType.SAVE_PASSWORDS_TOGGLE_ON), is(1));
assertThat(getToggleImpressions(AccessoryToggleType.SAVE_PASSWORDS_TOGGLE_OFF), is(0));
}
@Test
public void testRecordsToggleOffImpressionsWhenShown() {
assertThat(getToggleImpressions(AccessoryToggleType.SAVE_PASSWORDS_TOGGLE_ON), is(0));
assertThat(getToggleImpressions(AccessoryToggleType.SAVE_PASSWORDS_TOGGLE_OFF), is(0));
addToggleToSheet(false);
mCoordinator.onTabShown();
assertThat(getToggleImpressions(AccessoryToggleType.SAVE_PASSWORDS_TOGGLE_ON), is(0));
assertThat(getToggleImpressions(AccessoryToggleType.SAVE_PASSWORDS_TOGGLE_OFF), is(1));
}
@Test
public void testRecordsToggleOnClicked() {
assertThat(getToggleClicks(AccessoryToggleType.SAVE_PASSWORDS_TOGGLE_ON), is(0));
assertThat(getToggleClicks(AccessoryToggleType.SAVE_PASSWORDS_TOGGLE_OFF), is(0));
addToggleToSheet(true);
// Invoke the callback on the option toggle that was stored in the model. This is not the
// same as the OptionToggle passed above, because the mediator repackages it to include an
// additional method call in the callback.
OptionToggle repackagedToggle = (OptionToggle) mSheetDataPieces.get(0).getDataPiece();
repackagedToggle.getCallback().onResult(false);
assertThat(getToggleClicks(AccessoryToggleType.SAVE_PASSWORDS_TOGGLE_ON), is(1));
assertThat(getToggleClicks(AccessoryToggleType.SAVE_PASSWORDS_TOGGLE_OFF), is(0));
}
@Test
public void testRecordsToggleOffClicked() {
assertThat(getToggleClicks(AccessoryToggleType.SAVE_PASSWORDS_TOGGLE_ON), is(0));
assertThat(getToggleClicks(AccessoryToggleType.SAVE_PASSWORDS_TOGGLE_OFF), is(0));
addToggleToSheet(false);
// Invoke the callback on the option toggle that was stored in the model. This is not the
// same as the OptionToggle passed above, because the mediator repackages it to include an
// additional method call in the callback.
OptionToggle repackagedToggle = (OptionToggle) mSheetDataPieces.get(0).getDataPiece();
repackagedToggle.getCallback().onResult(true);
assertThat(getToggleClicks(AccessoryToggleType.SAVE_PASSWORDS_TOGGLE_ON), is(0));
assertThat(getToggleClicks(AccessoryToggleType.SAVE_PASSWORDS_TOGGLE_OFF), is(1));
}
private void addToggleToSheet(boolean toggleEnabled) {
final PropertyProvider<AccessorySheetData> testProvider = new PropertyProvider<>();
final AccessorySheetData testData =
new AccessorySheetData(
AccessoryTabType.PASSWORDS,
/* userInfoTitle= */ "Passwords",
/* plusAddressTitle= */ "",
/* warning= */ "");
testData.setOptionToggle(
new OptionToggle(
"Save passwords for this site",
toggleEnabled,
AccessoryAction.TOGGLE_SAVE_PASSWORDS,
(Boolean enabled) -> {}));
mCoordinator.registerDataProvider(testProvider);
testProvider.notifyObservers(testData);
}
private int getActionImpressions(@AccessoryAction int bucket) {
return RecordHistogram.getHistogramValueCountForTesting(
UMA_KEYBOARD_ACCESSORY_ACTION_IMPRESSION, bucket);
}
private int getToggleImpressions(@AccessoryToggleType int bucket) {
return RecordHistogram.getHistogramValueCountForTesting(
UMA_KEYBOARD_ACCESSORY_TOGGLE_IMPRESSION, bucket);
}
private int getToggleClicks(@AccessoryToggleType int bucket) {
return RecordHistogram.getHistogramValueCountForTesting(
UMA_KEYBOARD_ACCESSORY_TOGGLE_CLICKED, bucket);
}
}
Codebase Browser
chromium