🏠 Add instrumentation test for Suggestions BottomSheet

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

Index: chrome/android/junit/src/org/chromium/chrome/browser/ntp/cards/ContentSuggestionsTestUtils.java
diff --git a/chrome/android/junit/src/org/chromium/chrome/browser/ntp/cards/ContentSuggestionsTestUtils.java b/chrome/android/junit/src/org/chromium/chrome/browser/ntp/cards/ContentSuggestionsTestUtils.java
deleted file mode 100644
index dc12b67a44b216fa774d2e42457a1b6eda3406df..0000000000000000000000000000000000000000
--- a/chrome/android/junit/src/org/chromium/chrome/browser/ntp/cards/ContentSuggestionsTestUtils.java
+++ /dev/null
@@ -1,232 +0,0 @@
-// 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.mockito.Mockito.mock;
-import static org.mockito.Mockito.when;
-
-import org.chromium.chrome.browser.ntp.snippets.CategoryInt;
-import org.chromium.chrome.browser.ntp.snippets.CategoryStatus;
-import org.chromium.chrome.browser.ntp.snippets.ContentSuggestionsCardLayout;
-import org.chromium.chrome.browser.ntp.snippets.ContentSuggestionsCardLayout.ContentSuggestionsCardLayoutEnum;
-import org.chromium.chrome.browser.ntp.snippets.FakeSuggestionsSource;
-import org.chromium.chrome.browser.ntp.snippets.SectionHeaderViewHolder;
-import org.chromium.chrome.browser.ntp.snippets.SnippetArticle;
-import org.chromium.chrome.browser.ntp.snippets.SnippetArticleViewHolder;
-import org.chromium.chrome.browser.widget.displaystyle.HorizontalDisplayStyle;
-import org.chromium.chrome.browser.widget.displaystyle.UiConfig;
-import org.chromium.chrome.browser.widget.displaystyle.VerticalDisplayStyle;
-
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Locale;
-
-/** Utilities to make testing content suggestions code easier. */
-public final class ContentSuggestionsTestUtils {
-    private ContentSuggestionsTestUtils() {}
-
-    public static List<SnippetArticle> createDummySuggestions(
-            int count, @CategoryInt int category, String prefix) {
-        List<SnippetArticle> suggestions = new ArrayList<>();
-        for (int index = 0; index < count; index++) {
-            suggestions.add(new SnippetArticle(category, "https://site.com/url" + prefix + index,
-                    prefix + "title" + index, "pub" + index, "txt" + index,
-                    "https://site.com/url" + index, 0, 0));
-        }
-        return suggestions;
-    }
-
-    public static List<SnippetArticle> createDummySuggestions(
-            int count, @CategoryInt int category) {
-        return createDummySuggestions(count, category, "");
-    }
-
-    /**
-     * Registers a category according to the provided category info.
-     * @return the suggestions added to the newly registered category.
-     */
-    public static List<SnippetArticle> registerCategory(FakeSuggestionsSource suggestionsSource,
-            @CategoryInt int category, int suggestionCount) {
-        // Important: showIfEmpty flag to true.
-        SuggestionsCategoryInfo categoryInfo =
-                new CategoryInfoBuilder(category).withFetchAction().showIfEmpty().build();
-        return registerCategory(suggestionsSource, categoryInfo, suggestionCount);
-    }
-
-    /**
-     * Registers a category that has a reload action and is shown if empty.
-     * @return the suggestions added to the newly registered category.
-     */
-    public static List<SnippetArticle> registerCategory(FakeSuggestionsSource suggestionsSource,
-            SuggestionsCategoryInfo categoryInfo, int suggestionCount) {
-        // FakeSuggestionSource does not provide suggestions if the category's status is not
-        // AVAILABLE.
-        suggestionsSource.setStatusForCategory(
-                categoryInfo.getCategory(), CategoryStatus.AVAILABLE);
-        suggestionsSource.setInfoForCategory(categoryInfo.getCategory(), categoryInfo);
-
-        List<SnippetArticle> suggestions =
-                createDummySuggestions(suggestionCount, categoryInfo.getCategory());
-        suggestionsSource.setSuggestionsForCategory(categoryInfo.getCategory(), suggestions);
-        return suggestions;
-    }
-
-    public static String viewTypeToString(@ItemViewType int viewType) {
-        switch (viewType) {
-            case ItemViewType.ABOVE_THE_FOLD:
-                return "ABOVE_THE_FOLD";
-            case ItemViewType.HEADER:
-                return "HEADER";
-            case ItemViewType.SNIPPET:
-                return "SNIPPET";
-            case ItemViewType.SPACING:
-                return "SPACING";
-            case ItemViewType.STATUS:
-                return "STATUS";
-            case ItemViewType.PROGRESS:
-                return "PROGRESS";
-            case ItemViewType.ACTION:
-                return "ACTION";
-            case ItemViewType.FOOTER:
-                return "FOOTER";
-            case ItemViewType.PROMO:
-                return "PROMO";
-            case ItemViewType.ALL_DISMISSED:
-                return "ALL_DISMISSED";
-        }
-        throw new AssertionError();
-    }
-
-    /**
-     * Uses the builder pattern to simplify constructing category info objects for tests.
-     */
-    public static class CategoryInfoBuilder {
-        @CategoryInt
-        private final int mCategory;
-        private boolean mHasFetchAction;
-        private boolean mHasViewAllAction;
-        private boolean mShowIfEmpty;
-        private String mTitle = "";
-        private String mNoSuggestionsMessage = "";
-        @ContentSuggestionsCardLayoutEnum
-        private int mCardLayout = ContentSuggestionsCardLayout.FULL_CARD;
-
-        public CategoryInfoBuilder(@CategoryInt int category) {
-            mCategory = category;
-        }
-
-        public CategoryInfoBuilder withFetchAction() {
-            mHasFetchAction = true;
-            return this;
-        }
-
-        public CategoryInfoBuilder withViewAllAction() {
-            mHasViewAllAction = true;
-            return this;
-        }
-
-        public CategoryInfoBuilder showIfEmpty() {
-            mShowIfEmpty = true;
-            return this;
-        }
-
-        public CategoryInfoBuilder withTitle(String title) {
-            mTitle = title;
-            return this;
-        }
-
-        public CategoryInfoBuilder withNoSuggestionsMessage(String message) {
-            mNoSuggestionsMessage = message;
-            return this;
-        }
-
-        public CategoryInfoBuilder withCardLayout(
-                @ContentSuggestionsCardLayoutEnum int cardLayout) {
-            mCardLayout = cardLayout;
-            return this;
-        }
-
-        public SuggestionsCategoryInfo build() {
-            return new SuggestionsCategoryInfo(mCategory, mTitle, mCardLayout, mHasFetchAction,
-                    mHasViewAllAction, mShowIfEmpty, mNoSuggestionsMessage);
-        }
-    }
-
-    public static void bindViewHolders(InnerNode node) {
-        bindViewHolders(node, 0, node.getItemCount());
-    }
-
-    public static void bindViewHolders(InnerNode node, int startIndex, int endIndex) {
-        for (int i = startIndex; i < endIndex; ++i) {
-            node.onBindViewHolder(makeViewHolder(node.getItemViewType(i)), i);
-        }
-    }
-
-    private static NewTabPageViewHolder makeViewHolder(@CategoryInt int viewType) {
-        switch (viewType) {
-            case ItemViewType.SNIPPET:
-                return mock(SnippetArticleViewHolder.class);
-            case ItemViewType.HEADER:
-                return mock(SectionHeaderViewHolder.class);
-            case ItemViewType.STATUS:
-                return mock(StatusCardViewHolder.class);
-            case ItemViewType.ACTION:
-                return mock(ActionItem.ViewHolder.class);
-            case ItemViewType.PROGRESS:
-                return mock(ProgressViewHolder.class);
-            default:
-                return mock(NewTabPageViewHolder.class);
-        }
-    }
-
-    public static UiConfig makeUiConfig(
-            @HorizontalDisplayStyle int horizontal, @VerticalDisplayStyle int vertical) {
-        UiConfig uiConfig = mock(UiConfig.class);
-        when(uiConfig.getCurrentDisplayStyle())
-                .thenReturn(new UiConfig.DisplayStyle(horizontal, vertical));
-        return uiConfig;
-    }
-
-    public static UiConfig makeUiConfig() {
-        return makeUiConfig(HorizontalDisplayStyle.REGULAR, VerticalDisplayStyle.REGULAR);
-    }
-
-    /** Helper method to print the current state of a node. */
-    public static String stringify(TreeNode root) {
-        return explainFailedExpectation(root, -1, ItemViewType.ALL_DISMISSED);
-    }
-
-    /**
-     * Helper method to print the current state of a node, highlighting something that went wrong.
-     * @param root node to print information about.
-     * @param errorIndex index where an unexpected item was found.
-     * @param expectedType item type that was expected at {@code errorIndex}.
-     */
-    public static String explainFailedExpectation(
-            TreeNode root, int errorIndex, @ItemViewType int expectedType) {
-        StringBuilder stringBuilder = new StringBuilder();
-
-        stringBuilder.append("explainFailedExpectation -- START -- \n");
-        for (int i = 0; i < root.getItemCount(); ++i) {
-            if (errorIndex == i) {
-                addLine(stringBuilder, "%d - %s <= expected: %s", i,
-                        viewTypeToString(root.getItemViewType(i)), viewTypeToString(expectedType));
-            } else {
-                addLine(stringBuilder, "%d - %s", i, viewTypeToString(root.getItemViewType(i)));
-            }
-        }
-        if (errorIndex >= root.getItemCount()) {
-            addLine(stringBuilder, "<end of list>");
-            addLine(stringBuilder, "%d - <NONE> <= expected: %s", errorIndex,
-                    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));
-    }
-}