summaryrefslogtreecommitdiff
path: root/tests/PhotoPicker/src/android/photopicker/cts/util/PhotoPickerUiUtils.java
blob: 89d2f54f89cb5e257aaeb7e9de336c6aaa016ba9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
/*
 * Copyright (C) 2021 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.photopicker.cts.util;

import static com.google.common.truth.Truth.assertWithMessage;

import android.text.format.DateUtils;

import androidx.annotation.NonNull;
import androidx.test.uiautomator.UiDevice;
import androidx.test.uiautomator.UiObject;
import androidx.test.uiautomator.UiObjectNotFoundException;
import androidx.test.uiautomator.UiScrollable;
import androidx.test.uiautomator.UiSelector;

import java.util.ArrayList;
import java.util.List;

/**
 * Photo Picker Utility methods for finding UI elements.
 */
public class PhotoPickerUiUtils {
    public static final long SHORT_TIMEOUT = 5 * DateUtils.SECOND_IN_MILLIS;

    private static final long TIMEOUT = 30 * DateUtils.SECOND_IN_MILLIS;

    public static final String REGEX_PACKAGE_NAME =
            "com(.google)?.android.providers.media(.module)?";

    /**
     * Get the list of items from the photo grid list.
     * @param itemCount if the itemCount is -1, return all matching items. Otherwise, return the
     *                  item list that its size is not greater than the itemCount.
     * @throws Exception
     */
    public static List<UiObject> findItemList(int itemCount) throws Exception {
        final List<UiObject> itemList = new ArrayList<>();
        final UiSelector gridList = new UiSelector().resourceIdMatches(
                REGEX_PACKAGE_NAME + ":id/picker_tab_recyclerview");

        // Wait for the first item to appear
        assertWithMessage("Timed out while waiting for first item to appear")
                .that(new UiObject(gridList.childSelector(new UiSelector())).waitForExists(TIMEOUT))
                .isTrue();

        final UiSelector itemSelector = new UiSelector().resourceIdMatches(
                REGEX_PACKAGE_NAME + ":id/icon_thumbnail");
        final UiScrollable grid = new UiScrollable(gridList);
        final int childCount = grid.getChildCount();
        final int count = itemCount == -1 ? childCount : itemCount;

        for (int i = 0; i < childCount; i++) {
            final UiObject item = grid.getChildByInstance(itemSelector, i);
            if (item.exists()) {
                itemList.add(item);
            }
            if (itemList.size() == count) {
                break;
            }
        }
        return itemList;
    }

    public static UiObject findPreviewAddButton() {
        return new UiObject(new UiSelector().resourceIdMatches(
                REGEX_PACKAGE_NAME + ":id/preview_add_button"));
    }

    public static UiObject findPreviewAddOrSelectButton() {
        return new UiObject(new UiSelector().resourceIdMatches(
                REGEX_PACKAGE_NAME + ":id/preview_add_or_select_button"));
    }

    public static UiObject findAddButton() {
        return new UiObject(new UiSelector().resourceIdMatches(
                REGEX_PACKAGE_NAME + ":id/button_add"));
    }

    public static UiObject findProfileButton() {
        return new UiObject(new UiSelector().resourceIdMatches(
                REGEX_PACKAGE_NAME + ":id/profile_button"));
    }

    public static void findAndClickBrowse(UiDevice uiDevice) throws Exception {
        final UiObject overflowMenu = getOverflowMenuObject(uiDevice);
        clickAndWait(uiDevice, overflowMenu);

        final UiObject browseButton = new UiObject(new UiSelector().textContains("Browse"));
        clickAndWait(uiDevice, browseButton);
    }

    public static UiObject findSettingsOverflowMenuItem(UiDevice uiDevice) throws Exception {
        final UiObject overflowMenu = getOverflowMenuObject(uiDevice);
        clickAndWait(uiDevice, overflowMenu);
        return new UiObject(new UiSelector().textContains("Cloud media app"));
    }

    public static UiObject getOverflowMenuObject(UiDevice uiDevice)  {
        // Wait for overflow menu to appear.
        verifyOverflowMenuExists(uiDevice);
        return new UiObject(new UiSelector().description("More options"));
    }

    public static boolean isPhotoPickerVisible() {
        return new UiObject(new UiSelector().resourceIdMatches(
                PhotoPickerUiUtils.REGEX_PACKAGE_NAME + ":id/bottom_sheet")).waitForExists(TIMEOUT);
    }

    public static void verifySettingsActionBarIsVisible() {
        assertWithMessage("Timed out waiting for action bar to appear")
                .that(new UiObject(new UiSelector()
                        .resourceIdMatches(REGEX_PACKAGE_NAME + ":id/picker_settings_toolbar"))
                        .waitForExists(TIMEOUT))
                .isTrue();
    }

    public static void verifySettingsTitleIsVisible() {
        assertWithMessage("Timed out waiting for settings page title to appear")
                .that(new UiObject(new UiSelector()
                        .resourceIdMatches(REGEX_PACKAGE_NAME + ":id/picker_settings_title"))
                        .waitForExists(TIMEOUT))
                .isTrue();
    }

    public static void verifySettingsDescriptionIsVisible() {
        assertWithMessage("Timed out waiting for settings page description to appear")
                .that(new UiObject(new UiSelector()
                        .resourceIdMatches(REGEX_PACKAGE_NAME + ":id/picker_settings_description"))
                        .waitForExists(TIMEOUT))
                .isTrue();
    }

    /**
     * Verify if the app label of the {@code sTargetPackageName} is visible on the UI.
     */
    public static void verifySettingsCloudProviderOptionIsVisible(@NonNull String cmpLabel) {
        assertWithMessage("Timed out waiting for cloud provider option on settings activity")
                .that(new UiObject(new UiSelector().textContains(cmpLabel))
                        .waitForExists(TIMEOUT))
                .isTrue();
    }

    public static void verifySettingsFragmentContainerExists() {
        assertWithMessage("Timed out waiting for settings fragment container to appear")
                .that(new UiObject(new UiSelector()
                        .resourceIdMatches(REGEX_PACKAGE_NAME + ":id/settings_fragment_container"))
                        .waitForExists(TIMEOUT))
                .isTrue();
    }

    private static void verifyOverflowMenuExists(UiDevice uiDevice) {
        assertWithMessage("Timed out waiting for overflow menu to appear")
                .that(new UiObject(new UiSelector().description("More options"))
                        .waitForExists(TIMEOUT))
                .isTrue();
    }

    public static void verifySettingsActivityIsVisible() {
        // id/settings_activity_root is the root layout in activity_photo_picker_settings.xml
        assertWithMessage("Timed out waiting for settings activity to appear")
                .that(new UiObject(new UiSelector()
                .resourceIdMatches(REGEX_PACKAGE_NAME + ":id/settings_activity_root"))
                .waitForExists(TIMEOUT))
                .isTrue();
    }

    public static void clickAndWait(UiDevice uiDevice, UiObject uiObject) throws Exception {
        uiObject.click();
        uiDevice.waitForIdle();
    }

    /**
     * Verifies whether the selected tab is the one with the provided title
     */
    public static boolean isSelectedTabTitle(
            @NonNull String tabTitle, @NonNull String tabResourceId, UiDevice device)
            throws UiObjectNotFoundException {
        final UiObject tabLayout = findObject(tabResourceId, device);
        final UiObject tab = tabLayout.getChild(new UiSelector().textContains(tabTitle));
        return tab.isSelected();
    }

    /**
     * Returns the UI object corresponding to the specified resourceId
     */
    public static UiObject findObject(@NonNull String resourceId, UiDevice device) {
        return device.findObject(new UiSelector().resourceIdMatches(resourceId));
    }
}