Refactor ChromeContextMenuPopulator population

chrome/android/javatests/src/org/chromium/chrome/browser/contextmenu/ContextMenuTest.java

 // Copyright 2013 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.contextmenu;
 
 import android.content.ClipData;
 import android.content.ClipboardManager;
 import android.content.Context;
 import android.support.test.filters.LargeTest;
 import android.support.test.filters.MediumTest;
+import android.support.test.filters.SmallTest;
 import android.view.ContextMenu;
 import android.view.KeyEvent;
 
 import org.chromium.base.ThreadUtils;
 import org.chromium.base.test.util.CallbackHelper;
 import org.chromium.base.test.util.CommandLineFlags;
 import org.chromium.base.test.util.Feature;
 import org.chromium.base.test.util.FlakyTest;
 import org.chromium.base.test.util.RetryOnFailure;
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.ChromeSwitches;
 import org.chromium.chrome.browser.compositor.layouts.LayoutManager;
 import org.chromium.chrome.browser.download.DownloadTestBase;
 import org.chromium.chrome.browser.firstrun.FirstRunStatus;
 import org.chromium.chrome.browser.tab.Tab;
 import org.chromium.chrome.browser.tabmodel.EmptyTabModelSelectorObserver;
 import org.chromium.chrome.browser.tabmodel.TabModel;
 import org.chromium.chrome.test.util.browser.contextmenu.ContextMenuUtils;
 import org.chromium.content.browser.test.util.Criteria;
 import org.chromium.content.browser.test.util.CriteriaHelper;
 import org.chromium.content.browser.test.util.DOMUtils;
 import org.chromium.content.browser.test.util.TestTouchUtils;
 import org.chromium.net.test.EmbeddedTestServer;
 
 import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
 import java.util.concurrent.Callable;
 import java.util.concurrent.TimeoutException;
 import java.util.concurrent.atomic.AtomicReference;
 
 /**
  * Context menu related tests
  */
 @CommandLineFlags.Add({
         ChromeSwitches.GOOGLE_BASE_URL + "=http://example.com/",
         ChromeSwitches.HERB_FLAVOR_DISABLED_SWITCH})
@@ skipping 294 matching lines @@
         // Verify that the background tabs were opened in the expected order.
         String newTabUrl = mTestServer.getURL(
                 "/chrome/test/data/android/contextmenu/test_link.html");
         assertEquals(newTabUrl, tabModel.getTabAt(indexOfLinkPage).getUrl());
 
         String imageUrl = mTestServer.getURL(
                 "/chrome/test/data/android/contextmenu/test_link2.html");
         assertEquals(imageUrl, tabModel.getTabAt(indexOfLinkPage2).getUrl());
     }
 
+    @SmallTest
+    @Feature({"Browser", "ContextMenu"})
+    public void testContextMenuRetrievesLinkOptions()
+            throws TimeoutException, InterruptedException {
+        Tab tab = getActivity().getActivityTab();
+        ContextMenu menu = ContextMenuUtils.openContextMenu(this, tab, "testLink");
+
+        List<Integer> expectedItems = new ArrayList<>();
+        Collections.addAll(expectedItems, R.id.contextmenu_open_in_new_tab,
+                R.id.contextmenu_open_in_incognito_tab, R.id.contextmenu_copy_link_address,
+                R.id.contextmenu_copy_link_text, R.id.contextmenu_save_link_as);
+        assertTrue(confirmMenuList(menu, expectedItems));
+    }
+
+    @SmallTest
+    @Feature({"Browser", "ContextMenu"})
+    public void testContextMenuRetrievesImageOptions()
+            throws TimeoutException, InterruptedException {
+        Tab tab = getActivity().getActivityTab();
+        ContextMenu menu = ContextMenuUtils.openContextMenu(this, tab, "testImage");
+
+        List<Integer> expectedItems = new ArrayList<>();
+        Collections.addAll(expectedItems, R.id.contextmenu_save_image,
+                R.id.contextmenu_open_image_in_new_tab, R.id.contextmenu_search_by_image,
+                R.id.contextmenu_share_image);
+        assertTrue(confirmMenuList(menu, expectedItems));
+    }
+
+    @SmallTest
+    @Feature({"Browser", "ContextMenu"})
+    public void testContextMenuRetrievesImageLinkOptions()
+            throws TimeoutException, InterruptedException {
+        Tab tab = getActivity().getActivityTab();
+        ContextMenu menu = ContextMenuUtils.openContextMenu(this, tab, "testImageLink");
+
+        List<Integer> expectedItems = new ArrayList<>();
+        Collections.addAll(expectedItems, R.id.contextmenu_open_in_new_tab,
+                R.id.contextmenu_open_in_incognito_tab, R.id.contextmenu_copy_link_address,
+                R.id.contextmenu_save_link_as, R.id.contextmenu_save_image,
+                R.id.contextmenu_open_image_in_new_tab, R.id.contextmenu_search_by_image,
+                R.id.contextmenu_share_image);
+        assertTrue(confirmMenuList(menu, expectedItems));
+    }
+
+    @SmallTest
+    @Feature({"Browser", "ContextMenu"})
+    public void testContextMenuRetrievesVideoOptions()
+            throws TimeoutException, InterruptedException {
+        Tab tab = getActivity().getActivityTab();
+        DOMUtils.clickNode(this, getActivity().getCurrentContentViewCore(), "videoDOMElement");
+        ContextMenu menu = ContextMenuUtils.openContextMenu(this, tab, "videoDOMElement");
+
+        List<Integer> expectedItems = new ArrayList<>();
+        expectedItems.add(R.id.contextmenu_save_video);
+        assertTrue(confirmMenuList(menu, expectedItems));
+    }
+
+    /**
+     * Takes all the visible items on the menu and compares them to a the list of expected items.
+     * @param menu A context menu that is displaying visible items.
+     * @param expectedItems A list of items that is expected to appear within a context menu.
+     * @return Returns true when all the items in the menu are equal to the expectedItems.
+     */
+    private boolean confirmMenuList(ContextMenu menu, List<Integer> expectedItems) {

[JJ, 2017/02/22 00:57:43]

Preemptive comment! For a while I thought of putting in an assert within this
method. Thinking that an assertEquals would give me some useful data if it
didn't work out. However, I found out pretty quickly that since it's a list of
ids as integers that it actually gives you no useful information as seeing
[211343, 2300342, 32230] doesn't help much. As a result I left it out and just
left it as return true or false.

[David Trainor- moved to gerrit, 2017/02/22 05:36:33]

I see your point.  IMO the (debatable) useful piece of information you'd lose is
whether or not line 426 or line 430 failed.  To that end, if we only expect
something like O(<20) menu items the sort algorithm will be really quick.

[JJ, 2017/02/22 19:09:39]

Interesting! I didn't think of it with line numbers. I'm a little confused by
this comment though, as I feel like it's advocating for both a change to add the
assert back but also that since it's very quick to remove the if line all
together? Unless that's exactly what you're thinking? Adding a single
assertEquals at 430 and remove the if statement?

+        List<Integer> actualItems = new ArrayList<>();
+        for (int i = 0; i < menu.size(); i++) {
+            if (menu.getItem(i).isVisible()) {
+                actualItems.add(menu.getItem(i).getItemId());
+            }
+        }
+        // Leave the O(n logn) sort for when they're the same size
+        if (actualItems.size() != expectedItems.size()) return false;
+
+        Collections.sort(expectedItems);
+        Collections.sort(actualItems);
+        return actualItems.equals(expectedItems);
+    }
+
     private void saveMediaFromContextMenu(String mediaDOMElement, int saveMenuID,
             String expectedFilename) throws InterruptedException, TimeoutException,
             SecurityException, IOException {
         // Select "save [image/video]" in that menu.
         Tab tab = getActivity().getActivityTab();
         int callCount = getChromeDownloadCallCount();
         ContextMenuUtils.selectContextMenuItem(this, tab, mediaDOMElement, saveMenuID);
 
         // Wait for the download to complete and see if we got the right file
         assertTrue(waitForChromeDownloadToFinish(callCount));
@@ skipping 15 matching lines @@
     }
 
     /**
      * Makes sure there are no files with names identical to the ones this test uses in the
      * downloads directory
      */
     private void deleteTestFiles() {
         deleteFilesInDownloadDirectory(TEST_FILES);
     }
 }