Photo Picker dialog: Add a test.

chrome/android/javatests/src/org/chromium/chrome/browser/photo_picker/PhotoPickerDialogTest.java

+// Copyright 2017 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.photo_picker;
+
+import android.support.test.filters.LargeTest;
+import android.support.v7.widget.RecyclerView;
+import android.view.View;
+import android.widget.Button;
+
+import org.chromium.base.ThreadUtils;
+import org.chromium.base.test.util.CallbackHelper;
+import org.chromium.base.test.util.RetryOnFailure;
+import org.chromium.chrome.R;
+import org.chromium.chrome.browser.ChromeActivity;
+import org.chromium.chrome.browser.widget.selection.SelectionDelegate;
+import org.chromium.chrome.browser.widget.selection.SelectionDelegate.SelectionObserver;
+import org.chromium.chrome.test.ChromeActivityTestCaseBase;
+import org.chromium.chrome.test.util.browser.RecyclerViewTestUtils;
+import org.chromium.content.browser.test.util.TouchCommon;
+import org.chromium.ui.PhotoPickerListener;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.concurrent.Callable;
+
+/**
+ * Tests for the PhotoPickerDialog class.
+ */
+@RetryOnFailure
+public class PhotoPickerDialogTest extends ChromeActivityTestCaseBase<ChromeActivity>
+        implements PhotoPickerListener, SelectionObserver<PickerBitmap> {
+    // The dialog we are testing.
+    private PhotoPickerDialog mDialog;
+
+    // The data to show in the dialog (A map of filepath to last-modified time).
+    // Map<String, Long> mTestFiles;
+    private List<PickerBitmap> mTestFiles;
+
+    // The last action recorded in the dialog (e.g. photo selected).
+    private Action mLastActionRecorded;
+
+    // The final set of photos picked by the dialog. Can be an empty array, if
+    // nothing was selected.
+    private String[] mLastSelectedPhotos;
+
+    // The list of currently selected photos (built piecemeal).
+    private List<PickerBitmap> mCurrentPhotoSelection;
+
+    // A callback that fires when something is selected in the dialog.
+    public final CallbackHelper onSelectionCallback = new CallbackHelper();
+
+    // A callback that fires when an action is taken in the dialog (cancel/done etc).
+    public final CallbackHelper onActionCallback = new CallbackHelper();
+
+    public PhotoPickerDialogTest() {
+        super(ChromeActivity.class);
+    }
+
+    // ChromeActivityTestCaseBase:
+
+    @Override
+    protected void setUp() throws Exception {
+        super.setUp();
+
+        mTestFiles = new ArrayList<>();
+        mTestFiles.add(new PickerBitmap("a", 5L, PickerBitmap.PICTURE));
+        mTestFiles.add(new PickerBitmap("b", 4L, PickerBitmap.PICTURE));
+        mTestFiles.add(new PickerBitmap("c", 3L, PickerBitmap.PICTURE));
+        mTestFiles.add(new PickerBitmap("d", 2L, PickerBitmap.PICTURE));
+        mTestFiles.add(new PickerBitmap("e", 1L, PickerBitmap.PICTURE));
+        mTestFiles.add(new PickerBitmap("f", 0L, PickerBitmap.PICTURE));
+        PickerCategoryView.setTestFiles(mTestFiles);
+    }
+
+    @Override
+    public void startMainActivity() throws InterruptedException {
+        startMainActivityOnBlankPage();
+    }
+
+    // PhotoPickerDialog.PhotoPickerListener:
+
+    @Override
+    public void onPickerUserAction(Action action, String[] photos) {
+        mLastActionRecorded = action;
+        mLastSelectedPhotos = photos != null ? photos.clone() : null;
+        if (mLastSelectedPhotos != null) Arrays.sort(mLastSelectedPhotos);
+        onActionCallback.notifyCalled();
+    }
+
+    // SelectionObserver:
+
+    @Override
+    public void onSelectionStateChange(List<PickerBitmap> photosSelected) {
+        mCurrentPhotoSelection = new ArrayList<>(photosSelected);
+        onSelectionCallback.notifyCalled();
+    }
+
+    private RecyclerView recyclerView() {

[Theresa, 2017/05/23 15:10:29]

nit: getRecyclerView()?

[Finnur, 2017/05/23 15:57:46]

Done.

+        return (RecyclerView) mDialog.findViewById(R.id.recycler_view);
+    }
+
+    private PhotoPickerDialog createDialog(final boolean multiselect) {
+        final PhotoPickerDialog dialog =
+                ThreadUtils.runOnUiThreadBlockingNoException(new Callable<PhotoPickerDialog>() {

[Theresa, 2017/05/23 15:10:30]

Typically I see ThreadUtils.runOnUiThreadBlocking() rather than the NoException
flavor. Is there a benefit to the NoException in this application?

[Finnur, 2017/05/23 15:57:46]

Hmm... no. Probably just copied from somewhere.

+                    @Override
+                    public PhotoPickerDialog call() {
+                        final PhotoPickerDialog dialog = new PhotoPickerDialog(
+                                getActivity(), PhotoPickerDialogTest.this, multiselect);
+                        dialog.show();
+                        return dialog;
+                    }
+                });
+
+        SelectionDelegate<PickerBitmap> selectionDelegate =
+                dialog.getCategoryViewForTesting().getSelectionDelegateForTesting();
+        if (!multiselect) selectionDelegate.setSingleSelectionMode();
+        selectionDelegate.addObserver(this);
+        mDialog = dialog;
+
+        return dialog;
+    }
+
+    public void clickView(final int position, final int expectedSelectionCount) throws Exception {

[Theresa, 2017/05/23 15:10:29]

nit: can this method be private? Same for the other click* methods.

[Finnur, 2017/05/23 15:57:46]

Done.

+        RecyclerView recyclerView = recyclerView();
+        final PickerBitmapViewHolder holder =

[Theresa, 2017/05/23 15:10:29]

I believe findbugs is complaining about this line being a deadstore.

[Finnur, 2017/05/23 15:57:46]

Done.

+                (PickerBitmapViewHolder) RecyclerViewTestUtils.waitForView(recyclerView, position);
+
+        int callCount = onSelectionCallback.getCallCount();
+        TouchCommon.singleClickView(
+                recyclerView.findViewHolderForAdapterPosition(position).itemView);
+        onSelectionCallback.waitForCallback(callCount, 1);
+
+        // Validate the correct selection took place.
+        assertEquals(expectedSelectionCount, mCurrentPhotoSelection.size());
+        int i = 0;

[Theresa, 2017/05/23 15:10:29]

nit: put the i = 0 inside the for loop since it's not needed outside the for
loop.

for (int i = 0; i < ...)

[Finnur, 2017/05/23 15:57:46]

Yes, I moved it out because it was being used, but it no longer is. Forgot to
move back. :)

+        for (; i < mCurrentPhotoSelection.size(); ++i) {
+            if (mCurrentPhotoSelection.get(i).getFilePath().equals(
+                        mTestFiles.get(position).getFilePath())) {

[Theresa, 2017/05/23 15:10:29]

SelectionDelegate has an #isItemSelected() method that may be helpful for
asserting that the item that was just clicked is now selected.

[Finnur, 2017/05/23 15:57:46]

Ah, right! Of course. Done.

+                return;
+            }
+        }
+        // NOTREACHED.
+        assertTrue(false);
+    }
+
+    public void clickDone() throws Exception {
+        mLastActionRecorded = null;
+
+        PhotoPickerToolbar toolbar = (PhotoPickerToolbar) mDialog.findViewById(R.id.action_bar);
+        Button done = (Button) toolbar.findViewById(R.id.done);
+        int callCount = onActionCallback.getCallCount();
+        TouchCommon.singleClickView(done);
+        onActionCallback.waitForCallback(callCount, 1);
+        assertEquals(PhotoPickerListener.Action.PHOTOS_SELECTED, mLastActionRecorded);
+    }
+
+    public void clickCancel() throws Exception {
+        mLastActionRecorded = null;
+
+        PickerCategoryView categoryView = mDialog.getCategoryViewForTesting();
+        View cancel = new View(getActivity());
+        int callCount = onActionCallback.getCallCount();
+        categoryView.onClick(cancel);
+        onActionCallback.waitForCallback(callCount, 1);
+        assertEquals(PhotoPickerListener.Action.CANCEL, mLastActionRecorded);
+    }
+
+    @LargeTest
+    public void testNoSelection() throws Throwable {
+        createDialog(false); // Multi-select = false.
+        assertTrue(mDialog.isShowing());
+
+        int expectedSelectionCount = 1;
+        clickView(0, expectedSelectionCount);
+        clickCancel();
+
+        assertEquals(null, mLastSelectedPhotos);
+        assertEquals(PhotoPickerListener.Action.CANCEL, mLastActionRecorded);
+
+        mDialog.dismiss();
+    }
+
+    @LargeTest
+    public void testSingleSelectionPhoto() throws Throwable {
+        createDialog(false); // Multi-select = false.
+        assertTrue(mDialog.isShowing());
+
+        // Expected selection count is 1 because clicking on a new view unselects other.
+        int expectedSelectionCount = 1;
+        clickView(0, expectedSelectionCount);
+        clickView(1, expectedSelectionCount);
+        clickDone();
+
+        assertEquals(1, mLastSelectedPhotos.length);
+        assertEquals(PhotoPickerListener.Action.PHOTOS_SELECTED, mLastActionRecorded);
+        assertEquals(mTestFiles.get(1).getFilePath(), mLastSelectedPhotos[0]);
+
+        mDialog.dismiss();
+    }
+
+    @LargeTest
+    public void testMultiSelectionPhoto() throws Throwable {
+        createDialog(true); // Multi-select = true.
+        assertTrue(mDialog.isShowing());
+
+        // Multi-selection is enabled, so each click is counted.
+        int expectedSelectionCount = 1;
+        clickView(0, expectedSelectionCount++);
+        clickView(2, expectedSelectionCount++);
+        clickView(4, expectedSelectionCount++);
+        clickDone();
+
+        assertEquals(3, mLastSelectedPhotos.length);
+        assertEquals(PhotoPickerListener.Action.PHOTOS_SELECTED, mLastActionRecorded);
+        assertEquals(mTestFiles.get(0).getFilePath(), mLastSelectedPhotos[0]);
+        assertEquals(mTestFiles.get(2).getFilePath(), mLastSelectedPhotos[1]);
+        assertEquals(mTestFiles.get(4).getFilePath(), mLastSelectedPhotos[2]);
+
+        mDialog.dismiss();
+    }
+}