🏠 Extract the ContentSuggestionManager interface from NTP

chrome/android/junit/src/org/chromium/chrome/browser/ntp/cards/NewTabPageAdapterTest.java

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // 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.ntp.cards;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotEquals;
 import static org.junit.Assert.assertThat;
@@ skipping 35 matching lines @@
 import org.robolectric.shadows.ShadowResources;
 
 import org.chromium.base.Callback;
 import org.chromium.base.ContextUtils;
 import org.chromium.base.metrics.RecordHistogram;
 import org.chromium.base.metrics.RecordUserAction;
 import org.chromium.base.test.util.Feature;
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.ChromeFeatureList;
 import org.chromium.chrome.browser.EnableFeatures;
+import org.chromium.chrome.browser.ntp.ContextMenuManager;
 import org.chromium.chrome.browser.ntp.NewTabPage.DestructionObserver;
-import org.chromium.chrome.browser.ntp.NewTabPageView.NewTabPageManager;
 import org.chromium.chrome.browser.ntp.cards.ContentSuggestionsTestUtils.CategoryInfoBuilder;
 import org.chromium.chrome.browser.ntp.cards.SignInPromo.SigninObserver;
 import org.chromium.chrome.browser.ntp.snippets.CategoryInt;
 import org.chromium.chrome.browser.ntp.snippets.CategoryStatus;
 import org.chromium.chrome.browser.ntp.snippets.FakeSuggestionsSource;
 import org.chromium.chrome.browser.ntp.snippets.KnownCategories;
 import org.chromium.chrome.browser.ntp.snippets.SnippetArticle;
 import org.chromium.chrome.browser.offlinepages.OfflinePageBridge;
 import org.chromium.chrome.browser.preferences.ChromePreferenceManager;
 import org.chromium.chrome.browser.signin.SigninManager;
 import org.chromium.chrome.browser.signin.SigninManager.SignInAllowedObserver;
 import org.chromium.chrome.browser.signin.SigninManager.SignInStateObserver;
 import org.chromium.chrome.browser.suggestions.SuggestionsMetricsReporter;
+import org.chromium.chrome.browser.suggestions.SuggestionsUiDelegate;
 import org.chromium.testing.local.LocalRobolectricTestRunner;
 
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Locale;
 
 /**
  * Unit tests for {@link NewTabPageAdapter}.
  */
 @RunWith(LocalRobolectricTestRunner.class)
 @Config(manifest = Config.NONE)
 public class NewTabPageAdapterTest {
     @Rule
     public EnableFeatures.Processor mEnableFeatureProcessor = new EnableFeatures.Processor();
 
     private FakeSuggestionsSource mSource;
     private NewTabPageAdapter mAdapter;
     @Mock
     private SigninManager mMockSigninManager;
     @Mock
     private OfflinePageBridge mOfflinePageBridge;
     @Mock
-    private NewTabPageManager mNewTabPageManager;
+    private SuggestionsUiDelegate mUiDelegate;
 
     /**
      * Stores information about a section that should be present in the adapter.
      */
     private static class SectionDescriptor {
         public final int mNumSuggestions;
         public final boolean mStatusCard;
         public boolean mActionButton;
         public boolean mProgressItem;
         public SnippetArticle mFirstItem;
@@ skipping 97 matching lines @@
         RecordHistogram.disableForTests();
         RecordUserAction.disableForTests();
 
         @CategoryInt
         final int category = KnownCategories.ARTICLES;
         mSource = new FakeSuggestionsSource();
         mSource.setStatusForCategory(category, CategoryStatus.INITIALIZING);
         mSource.setInfoForCategory(category,
                 new CategoryInfoBuilder(category).showIfEmpty().build());
 
-        when(mNewTabPageManager.getSuggestionsSource()).thenReturn(mSource);
-        when(mNewTabPageManager.getSuggestionsMetricsReporter())
-                .thenReturn(mock(SuggestionsMetricsReporter.class));
-        when(mNewTabPageManager.isCurrentPage()).thenReturn(true);
+        when(mUiDelegate.getSuggestionsSource()).thenReturn(mSource);
+        when(mUiDelegate.getMetricsReporter()).thenReturn(mock(SuggestionsMetricsReporter.class));
 
         reloadNtp();
     }
 
     @After
     public void tearDown() {
         SigninManager.setInstanceForTesting(null);
         ChromePreferenceManager.getInstance(RuntimeEnvironment.application)
                 .setNewTabPageSigninPromoDismissed(false);
     }
@@ skipping 247 matching lines @@
         @CategoryInt
         final int category = 42;
 
         // Part 1: VisibleIfEmpty = true
         FakeSuggestionsSource suggestionsSource = new FakeSuggestionsSource();
         suggestionsSource.setStatusForCategory(category, CategoryStatus.INITIALIZING);
         suggestionsSource.setInfoForCategory(category,
                 new CategoryInfoBuilder(category).showIfEmpty().build());
 
         // 1.1 - Initial state
-        when(mNewTabPageManager.getSuggestionsSource()).thenReturn(suggestionsSource);
+        when(mUiDelegate.getSuggestionsSource()).thenReturn(suggestionsSource);
         reloadNtp();
         assertItemsFor(sectionWithStatusCard().withProgress());
 
         // 1.2 - With suggestions
         List<SnippetArticle> articles =
                 Collections.unmodifiableList(createDummySuggestions(3, category));
         suggestionsSource.setStatusForCategory(category, CategoryStatus.AVAILABLE);
         suggestionsSource.setSuggestionsForCategory(category, articles);
         assertItemsFor(section(3));
 
         // 1.3 - When all suggestions are dismissed
         SuggestionsSection section42 =
                 mAdapter.getSectionListForTesting().getSectionForTesting(category);
         assertSectionMatches(section(3), section42);
         section42.removeSuggestionById(articles.get(0).mIdWithinCategory);
         section42.removeSuggestionById(articles.get(1).mIdWithinCategory);
         section42.removeSuggestionById(articles.get(2).mIdWithinCategory);
         assertItemsFor(sectionWithStatusCard());
 
         // Part 2: VisibleIfEmpty = false
         suggestionsSource = new FakeSuggestionsSource();
         suggestionsSource.setStatusForCategory(category, CategoryStatus.INITIALIZING);
         suggestionsSource.setInfoForCategory(category, new CategoryInfoBuilder(category).build());
 
         // 2.1 - Initial state
-        when(mNewTabPageManager.getSuggestionsSource()).thenReturn(suggestionsSource);
+        when(mUiDelegate.getSuggestionsSource()).thenReturn(suggestionsSource);
         reloadNtp();
         assertItemsFor();
 
         // 2.2 - With suggestions
         suggestionsSource.setStatusForCategory(category, CategoryStatus.AVAILABLE);
         suggestionsSource.setSuggestionsForCategory(category, articles);
         assertItemsFor();
 
         // 2.3 - When all suggestions are dismissed - N/A, suggestions don't get added.
     }
 
     /**
      * Tests that the more button is shown for sections that declare it.
      */
     @Test
     @Feature({"Ntp"})
     public void testMoreButton() {
         @CategoryInt
         final int category = 42;
 
         // Part 1: With "View All" action
         FakeSuggestionsSource suggestionsSource = new FakeSuggestionsSource();
         suggestionsSource.setStatusForCategory(category, CategoryStatus.INITIALIZING);
         suggestionsSource.setInfoForCategory(category, new CategoryInfoBuilder(category)
                                                                .withViewAllAction()
                                                                .showIfEmpty()
                                                                .build());
 
         // 1.1 - Initial state.
-        when(mNewTabPageManager.getSuggestionsSource()).thenReturn(suggestionsSource);
+        when(mUiDelegate.getSuggestionsSource()).thenReturn(suggestionsSource);
         reloadNtp();
         assertItemsFor(sectionWithStatusCard().withActionButton().withProgress());
 
         // 1.2 - With suggestions.
         List<SnippetArticle> articles =
                 Collections.unmodifiableList(createDummySuggestions(3, category));
         suggestionsSource.setStatusForCategory(category, CategoryStatus.AVAILABLE);
         suggestionsSource.setSuggestionsForCategory(category, articles);
         assertItemsFor(section(3).withActionButton());
 
         // 1.3 - When all suggestions are dismissed.
         SuggestionsSection section42 =
                 mAdapter.getSectionListForTesting().getSectionForTesting(category);
         assertSectionMatches(section(3).withActionButton(), section42);
         section42.removeSuggestionById(articles.get(0).mIdWithinCategory);
         section42.removeSuggestionById(articles.get(1).mIdWithinCategory);
         section42.removeSuggestionById(articles.get(2).mIdWithinCategory);
         assertItemsFor(sectionWithStatusCard().withActionButton());
 
         // Part 1: Without "View All" action
         suggestionsSource = new FakeSuggestionsSource();
         suggestionsSource.setStatusForCategory(category, CategoryStatus.INITIALIZING);
         suggestionsSource.setInfoForCategory(category,
                 new CategoryInfoBuilder(category).showIfEmpty().build());
 
         // 2.1 - Initial state.
-        when(mNewTabPageManager.getSuggestionsSource()).thenReturn(suggestionsSource);
+        when(mUiDelegate.getSuggestionsSource()).thenReturn(suggestionsSource);
         reloadNtp();
         assertItemsFor(sectionWithStatusCard().withProgress());
 
         // 2.2 - With suggestions.
         suggestionsSource.setStatusForCategory(category, CategoryStatus.AVAILABLE);
         suggestionsSource.setSuggestionsForCategory(category, articles);
         assertItemsFor(section(3));
 
         // 2.3 - When all suggestions are dismissed.
         section42 = mAdapter.getSectionListForTesting().getSectionForTesting(category);
@@ skipping 53 matching lines @@
         assertItemsFor(section(3), section(5).withActionButton(), section(11));
     }
 
     /**
      * Tests that the order of the categories is kept.
      */
     @Test
     @Feature({"Ntp"})
     public void testCategoryOrder() {
         FakeSuggestionsSource suggestionsSource = new FakeSuggestionsSource();
-        when(mNewTabPageManager.getSuggestionsSource()).thenReturn(suggestionsSource);
+        when(mUiDelegate.getSuggestionsSource()).thenReturn(suggestionsSource);
         registerCategory(suggestionsSource, KnownCategories.ARTICLES, 0);
         registerCategory(suggestionsSource, KnownCategories.BOOKMARKS, 0);
         registerCategory(suggestionsSource, KnownCategories.PHYSICAL_WEB_PAGES, 0);
         registerCategory(suggestionsSource, KnownCategories.DOWNLOADS, 0);
         reloadNtp();
 
         List<TreeNode> children = mAdapter.getSectionListForTesting().getChildren();
         assertEquals(4, children.size());
         assertEquals(SuggestionsSection.class, children.get(0).getClass());
         assertEquals(KnownCategories.ARTICLES, getCategory(children.get(0)));
         assertEquals(SuggestionsSection.class, children.get(1).getClass());
         assertEquals(KnownCategories.BOOKMARKS, getCategory(children.get(1)));
         assertEquals(SuggestionsSection.class, children.get(2).getClass());
         assertEquals(KnownCategories.PHYSICAL_WEB_PAGES, getCategory(children.get(2)));
         assertEquals(SuggestionsSection.class, children.get(3).getClass());
         assertEquals(KnownCategories.DOWNLOADS, getCategory(children.get(3)));
 
         // With a different order.
         suggestionsSource = new FakeSuggestionsSource();
-        when(mNewTabPageManager.getSuggestionsSource()).thenReturn(suggestionsSource);
+        when(mUiDelegate.getSuggestionsSource()).thenReturn(suggestionsSource);
         registerCategory(suggestionsSource, KnownCategories.ARTICLES, 0);
         registerCategory(suggestionsSource, KnownCategories.PHYSICAL_WEB_PAGES, 0);
         registerCategory(suggestionsSource, KnownCategories.DOWNLOADS, 0);
         registerCategory(suggestionsSource, KnownCategories.BOOKMARKS, 0);
         reloadNtp();
 
         children = mAdapter.getSectionListForTesting().getChildren();
         assertEquals(4, children.size());
         assertEquals(SuggestionsSection.class, children.get(0).getClass());
         assertEquals(KnownCategories.ARTICLES, getCategory(children.get(0)));
         assertEquals(SuggestionsSection.class, children.get(1).getClass());
         assertEquals(KnownCategories.PHYSICAL_WEB_PAGES, getCategory(children.get(1)));
         assertEquals(SuggestionsSection.class, children.get(2).getClass());
         assertEquals(KnownCategories.DOWNLOADS, getCategory(children.get(2)));
         assertEquals(SuggestionsSection.class, children.get(3).getClass());
         assertEquals(KnownCategories.BOOKMARKS, getCategory(children.get(3)));
 
         // With unknown categories.
         suggestionsSource = new FakeSuggestionsSource();
-        when(mNewTabPageManager.getSuggestionsSource()).thenReturn(suggestionsSource);
+        when(mUiDelegate.getSuggestionsSource()).thenReturn(suggestionsSource);
         registerCategory(suggestionsSource, KnownCategories.ARTICLES, 0);
         registerCategory(suggestionsSource, KnownCategories.PHYSICAL_WEB_PAGES, 0);
         registerCategory(suggestionsSource, KnownCategories.DOWNLOADS, 0);
         reloadNtp();
 
         // The adapter is already initialised, it will not accept new categories anymore.
         registerCategory(suggestionsSource, 42, 1);
         registerCategory(suggestionsSource, KnownCategories.BOOKMARKS, 1);
 
         children = mAdapter.getSectionListForTesting().getChildren();
         assertEquals(3, children.size());
         assertEquals(SuggestionsSection.class, children.get(0).getClass());
         assertEquals(KnownCategories.ARTICLES, getCategory(children.get(0)));
         assertEquals(SuggestionsSection.class, children.get(1).getClass());
         assertEquals(KnownCategories.PHYSICAL_WEB_PAGES, getCategory(children.get(1)));
         assertEquals(SuggestionsSection.class, children.get(2).getClass());
         assertEquals(KnownCategories.DOWNLOADS, getCategory(children.get(2)));
     }
 
     @Test
     @Feature({"Ntp"})
     public void testChangeNotifications() {
         FakeSuggestionsSource suggestionsSource = spy(new FakeSuggestionsSource());
         registerCategory(suggestionsSource, KnownCategories.ARTICLES, 3);
-        when(mNewTabPageManager.getSuggestionsSource()).thenReturn(suggestionsSource);
+        when(mUiDelegate.getSuggestionsSource()).thenReturn(suggestionsSource);
 
         @SuppressWarnings("unchecked")
         Callback<String> itemDismissedCallback = mock(Callback.class);
 
         reloadNtp();
         AdapterDataObserver dataObserver = mock(AdapterDataObserver.class);
         mAdapter.registerAdapterDataObserver(dataObserver);
 
         // Adapter content:
         // Idx | Item
@@ skipping 75 matching lines @@
     }
 
     @Test
     @Feature({"Ntp"})
     public void testSigninPromo() {
         when(mMockSigninManager.isSignInAllowed()).thenReturn(true);
         when(mMockSigninManager.isSignedInOnNative()).thenReturn(false);
         ArgumentCaptor<DestructionObserver> observers =
                 ArgumentCaptor.forClass(DestructionObserver.class);
 
-        doNothing().when(mNewTabPageManager).addDestructionObserver(observers.capture());
+        doNothing().when(mUiDelegate).addDestructionObserver(observers.capture());
 
         reloadNtp();
         assertTrue(isSignInPromoVisible());
 
         // Note: As currently implemented, these two variables should point to the same object, a
         // SignInPromo.SigninObserver
         SignInStateObserver signInStateObserver = null;
         SignInAllowedObserver signInAllowedObserver = null;
         for (DestructionObserver observer : observers.getAllValues()) {
             if (observer instanceof SignInStateObserver) {
@@ skipping 48 matching lines @@
         assertFalse(isSignInPromoVisible());
     }
 
     @Test
     @Feature({"Ntp"})
     @EnableFeatures(ChromeFeatureList.NTP_SUGGESTIONS_SECTION_DISMISSAL)
     public void testAllDismissedVisibility() {
         ArgumentCaptor<DestructionObserver> observers =
                 ArgumentCaptor.forClass(DestructionObserver.class);
 
-        verify(mNewTabPageManager, atLeastOnce()).addDestructionObserver(observers.capture());
+        verify(mUiDelegate, atLeastOnce()).addDestructionObserver(observers.capture());
 
         SigninObserver signinObserver = null;
         for (DestructionObserver observer : observers.getAllValues()) {
             if (observer instanceof SigninObserver) {
                 signinObserver = (SigninObserver) observer;
             }
         }
 
         @SuppressWarnings("unchecked")
         Callback<String> itemDismissedCallback = mock(Callback.class);
@@ skipping 157 matching lines @@
     /**
      * To be used with {@link #assertItemsFor(SectionDescriptor...)}, for a section that has no
      * suggestions, but a status card to be displayed.
      * @return A descriptor for the section.
      */
     private SectionDescriptor sectionWithStatusCard() {
         return new SectionDescriptor(0);
     }
 
     private void reloadNtp() {
-        mAdapter = new NewTabPageAdapter(mNewTabPageManager, mock(View.class), null,
-                mOfflinePageBridge);
+        mAdapter = new NewTabPageAdapter(mUiDelegate, mock(View.class), null, mOfflinePageBridge,
+                mock(ContextMenuManager.class));
     }
 
     private void assertArticlesEqual(List<SnippetArticle> articles, int start, int end) {
         assertThat(mAdapter.getItemCount(), greaterThanOrEqualTo(end));
         for (int i = start; i < end; i++) {
             assertEquals(articles.get(i - start), mAdapter.getSuggestionAt(i));
         }
     }
 
     private boolean isSignInPromoVisible() {
@@ skipping 23 matching lines @@
                     viewTypeToString(expectedType));
         }
         addLine(stringBuilder, "explainFailedExpectation -- END --");
         return stringBuilder.toString();
     }
 
     private static void addLine(StringBuilder stringBuilder, String template, Object... args) {
         stringBuilder.append(String.format(Locale.US, template + "\n", args));
     }
 }