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
204
205
206
207
|
/*
* Copyright (C) 2014 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 com.google.android.apps.common.testing.ui.espresso;
import static com.google.android.apps.common.testing.ui.espresso.Espresso.onView;
import static com.google.android.apps.common.testing.ui.espresso.matcher.ViewMatchers.isAssignableFrom;
import static com.google.android.apps.common.testing.ui.espresso.matcher.ViewMatchers.isDescendantOfA;
import static com.google.common.base.Preconditions.checkNotNull;
import static org.hamcrest.Matchers.allOf;
import com.google.android.apps.common.testing.ui.espresso.action.AdapterDataLoaderAction;
import com.google.android.apps.common.testing.ui.espresso.action.AdapterViewProtocol;
import com.google.android.apps.common.testing.ui.espresso.action.AdapterViewProtocol.AdaptedData;
import com.google.android.apps.common.testing.ui.espresso.action.AdapterViewProtocols;
import com.google.android.apps.common.testing.ui.espresso.matcher.RootMatchers;
import com.google.common.base.Optional;
import android.view.View;
import android.view.ViewParent;
import android.widget.Adapter;
import android.widget.AdapterView;
import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeMatcher;
/**
* An interface to interact with data displayed in AdapterViews.
* <p>
* This interface builds on top of {@link ViewInteraction} and should be the preferred way to
* interact with elements displayed inside AdapterViews.
* </p>
* <p>
* This is necessary because an AdapterView may not load all the data held by its Adapter into the
* view hierarchy until a user interaction makes it necessary. Also it is more fluent / less brittle
* to match upon the data object being rendered into the display then the rendering itself.
* </p>
* <p>
* By default, a DataInteraction takes place against any AdapterView found within the current
* screen, if you have multiple AdapterView objects displayed, you will need to narrow the selection
* by using the inAdapterView method.
* </p>
* <p>
* The check and perform method operate on the top level child of the adapter view, if you need to
* operate on a subview (eg: a Button within the list) use the onChildView method before calling
* perform or check.
* </p>
*
*/
public class DataInteraction {
private final Matcher<Object> dataMatcher;
private Matcher<View> adapterMatcher = isAssignableFrom(AdapterView.class);
private Optional<Matcher<View>> childViewMatcher = Optional.absent();
private Optional<Integer> atPosition = Optional.absent();
private AdapterViewProtocol adapterViewProtocol = AdapterViewProtocols.standardProtocol();
private Matcher<Root> rootMatcher = RootMatchers.DEFAULT;
DataInteraction(Matcher<Object> dataMatcher) {
this.dataMatcher = checkNotNull(dataMatcher);
}
/**
* Causes perform and check methods to take place on a specific child view of the view returned
* by Adapter.getView()
*/
public DataInteraction onChildView(Matcher<View> childMatcher) {
this.childViewMatcher = Optional.of(checkNotNull(childMatcher));
return this;
}
/**
* Causes this data interaction to work within the Root specified by the given root matcher.
*/
public DataInteraction inRoot(Matcher<Root> rootMatcher) {
this.rootMatcher = checkNotNull(rootMatcher);
return this;
}
/**
* Selects a particular adapter view to operate on, by default we operate on any adapter view
* on the screen.
*/
public DataInteraction inAdapterView(Matcher<View> adapterMatcher) {
this.adapterMatcher = checkNotNull(adapterMatcher);
return this;
}
/**
* Selects the view which matches the nth position on the adapter
* based on the data matcher.
*/
public DataInteraction atPosition(Integer atPosition) {
this.atPosition = Optional.of(checkNotNull(atPosition));
return this;
}
/**
* Use a different AdapterViewProtocol if the Adapter implementation does not
* satisfy the AdapterView contract like (@code ExpandableListView)
*/
public DataInteraction usingAdapterViewProtocol(AdapterViewProtocol adapterViewProtocol) {
this.adapterViewProtocol = checkNotNull(adapterViewProtocol);
return this;
}
/**
* Performs an action on the view after we force the data to be loaded.
*
* @return an {@link ViewInteraction} for more assertions or actions.
*/
public ViewInteraction perform(ViewAction... actions) {
AdapterDataLoaderAction adapterDataLoaderAction = load();
return onView(makeTargetMatcher(adapterDataLoaderAction))
.inRoot(rootMatcher)
.perform(actions);
}
/**
* Performs an assertion on the state of the view after we force the data to be loaded.
*
* @return an {@link ViewInteraction} for more assertions or actions.
*/
public ViewInteraction check(ViewAssertion assertion) {
AdapterDataLoaderAction adapterDataLoaderAction = load();
return onView(makeTargetMatcher(adapterDataLoaderAction))
.inRoot(rootMatcher)
.check(assertion);
}
private AdapterDataLoaderAction load() {
AdapterDataLoaderAction adapterDataLoaderAction =
new AdapterDataLoaderAction(dataMatcher, atPosition, adapterViewProtocol);
onView(adapterMatcher)
.inRoot(rootMatcher)
.perform(adapterDataLoaderAction);
return adapterDataLoaderAction;
}
@SuppressWarnings("unchecked")
private Matcher<View> makeTargetMatcher(AdapterDataLoaderAction adapterDataLoaderAction) {
Matcher<View> targetView = displayingData(adapterMatcher, dataMatcher, adapterViewProtocol,
adapterDataLoaderAction);
if (childViewMatcher.isPresent()) {
targetView = allOf(childViewMatcher.get(), isDescendantOfA(targetView));
}
return targetView;
}
private Matcher<View> displayingData(
final Matcher<View> adapterMatcher,
final Matcher<Object> dataMatcher,
final AdapterViewProtocol adapterViewProtocol,
final AdapterDataLoaderAction adapterDataLoaderAction) {
checkNotNull(adapterMatcher);
checkNotNull(dataMatcher);
checkNotNull(adapterViewProtocol);
return new TypeSafeMatcher<View>() {
@Override
public void describeTo(Description description) {
description.appendText(" displaying data matching: ");
dataMatcher.describeTo(description);
description.appendText(" within adapter view matching: ");
adapterMatcher.describeTo(description);
}
@SuppressWarnings("unchecked")
@Override
public boolean matchesSafely(View view) {
ViewParent parent = view.getParent();
while (parent != null && !(parent instanceof AdapterView)) {
parent = parent.getParent();
}
if (parent != null && adapterMatcher.matches(parent)) {
Optional<AdaptedData> data = adapterViewProtocol.getDataRenderedByView(
(AdapterView<? extends Adapter>) parent, view);
if (data.isPresent()) {
return adapterDataLoaderAction.getAdaptedData().opaqueToken.equals(
data.get().opaqueToken);
}
}
return false;
}
};
}
}
|
