Taking care of your UI tests

Transcript

TAKING CARE OF
YOUR UI TESTS

View Slide

ESPRESSO

View Slide

Maintainable
Extendable
Readable
Stable

View Slide

@florianmski

View Slide

PAGEOBJECT

View Slide

What?
Wraps screen with an application-speciﬁc API
Allow interacting with screen elements easily
Test code not affected by UI changes

View Slide

Why?
Test code easier to understand
Logic is about the intention of the test
Don’t care about UI details

View Slide

onView(withId(R.id.track_detail_actions_more))
.perform(click());
onView(withId(R.id.bottom_options_recycler_view))
.perform(actionOnItem(hasDescendant(allOf(
withId(R.id.bottom_options_item_title),
withText(R.string.track_detail_action_private))),
click()));
onView(withId(android.R.id.button1)).perform(click());

View Slide

.perform(click());
click()));

View Slide

.perform(click());
click()));

View Slide

trackDetailScreen.showTrackOptions()
.tapOnMakeTrackPrivateOption()
.tapOnConfirmInDialog();

View Slide

SCREENS, INTERACTORS
& ASSERTIONS

View Slide

Screens
public class TrackDetailScreen extends Screen { 
 
private final TrackDetailInteractors interactors; 
 
public TrackDetailScreen() { 
super(R.id.track_detail_container); 
interactors = new TrackDetailInteractors(); 
} 
 
public Options showTrackOptions() { 
interactors.trackActions().perform(click()); 
return goTo(new Options()); 
}
}

View Slide

And part of screens…
public static class Options extends BottomSheetScreen { 
 
public DialogScreen tapOnMakeTrackPrivateOption() { 
return tapOnOptionWithString(R.string.track_detail_action_private).goTo(dialog()); 
} 
 
public DialogScreen tapOnMakeTrackPublicOption() { 
return tapOnOptionWithString(R.string.track_detail_action_public).goTo(dialog()); 
} 
 
public UnknownScreen tapOnPlayTrackOption() { 
return tapOnOptionWithString(R.string.track_detail_action_play)
.goTo(new UnknownScreen()); 
} 
 
}

View Slide

And part of screens…
public static class Options extends BottomSheetScreen { 
 
public DialogScreen tapOnMakeTrackPrivateOption() { 
return tapOnOptionWithString(R.string.track_detail_action_private).goTo(dialog()); 
} 
 
public DialogScreen tapOnMakeTrackPublicOption() { 
return tapOnOptionWithString(R.string.track_detail_action_public).goTo(dialog()); 
} 
 
public UnknownScreen tapOnPlayTrackOption() { 
return tapOnOptionWithString(R.string.track_detail_action_play)
.goTo(new UnknownScreen()); 
} 
 
}

View Slide

As well as dialogs…
public class DialogScreen extends Screen { 
 
public Screen tapOnConfirmInDialog() { 
return tapOnButton(android.R.id.button1); 
} 
 
public Screen tapOnCancelInDialog() { 
return tapOnButton(android.R.id.button2); 
} 
 
protected Screen tapOnButton(@IdRes int buttonId) { 
onView(withId(buttonId)).perform(click()); 
return previousScreen(); 
} 
 
}

View Slide

Interactors
public class TrackDetailInteractors { 
 
BetterViewInteraction trackActions() { 
return BetterViewInteraction.wrap(onView(withId(R.id.track_detail_actions_more))); 
} 
 
BetterViewInteraction privateIndicator() { 
return BetterViewInteraction.wrap(onView(withText(R.string.track_item_private))); 
} 
 
RecyclerViewScreen recyclerView() { 
return new RecyclerViewScreen(allOf( 
withId(R.id.ak_recycler_view), 
isDescendantOfA(withId(R.id.track_detail_container)))); 
}
 
}

View Slide

Assertions
public class TrackDetailAssertions { 
 
private final TrackDetailInteractors interactors; 
 
private TrackDetailAssertions(TrackDetailInteractors interactors) { 
this.interactors = interactors; 
} 
 
public static TrackDetailAssertions assertTrackDetail() { 
return new TrackDetailAssertions(new TrackDetailInteractors()); 
} 
 
public TrackDetailAssertions hasPrivacySetToPrivate() { 
interactors.privateIndicator() 
.check(matches(isDisplayed()), "Track is not displayed as being private."); 
return this; 
}
}

View Slide

@Test 
public void shouldChangeTrackToPrivateInTrackDetails() { 
givenPublicTrackDetail(); 
 
trackDetailScreen.showTrackOptions() 
.tapOnMakeTrackPrivateOption() 
.tapOnConfirmInDialog(); 
 
assertTrackDetail().hasPrivacySetToPrivate(); 
}

View Slide

@Test 
 
 
}

View Slide

@Test 
 
 
}

View Slide

INSTRUMENTATION
TESTING ROBOTS
https://realm.io/news/kau-jake-wharton-testing-robots/

View Slide

CONFIGURING

View Slide

Test classes
Single screen
Event propagation
Navigation

View Slide

Test class “header”
@Rule
public final ActivityTestRule
activityTestRule = new
ActivityTestRule<>(UserPreviewActivity.class, true, false);
@ClassRule
public static final TestRule chain =
RuleChain.outerRule(AccountTestRule.add(POPULAR_CREATOR))
.around(applicationComponentTestRule())
.around(new IdlingResourceTestRule(rxIdlingResource));

View Slide

Test class “header”
@Rule
public final ActivityTestRule
activityTestRule = new
ActivityTestRule<>(UserPreviewActivity.class, true, false);
@ClassRule
public static final TestRule chain =
RuleChain.outerRule(AccountTestRule.add(POPULAR_CREATOR))
.around(applicationComponentTestRule())
.around(new IdlingResourceTestRule(rxIdlingResource));

View Slide

starting account rule
starting application component rule
starting idling resource rule
execute all tests
finished idling resource rule
finished application component rule
finished account rule

execute all tests

execute all tests

execute all tests

execute all tests

execute all tests

execute all tests

LocaleTestRule
@Override 
public Statement apply(final Statement base, Description description) { 
return new Statement() { 
@Override 
public void evaluate() throws Throwable { 
Locale defaultLocale = Locale.getDefault(); 
for (Locale locale : locales) { 
changeLocaleTo(locale); 
base.evaluate(); 
} 
changeLocaleTo(defaultLocale); 
} 
}; 
}

View Slide

LocaleTestRule
@Override 
@Override 
base.evaluate(); 
} 
} 
}; 
}

View Slide

LocaleTestRule
@Override 
@Override 
base.evaluate(); 
} 
} 
}; 
}

View Slide

LocaleTestRule
@Override 
@Override 
base.evaluate(); 
} 
} 
}; 
}

View Slide

AccountTestRule
Add / Remove account from the AccountManager
Test app with popular / normal / empty user
Test Sign-in

View Slide

ApplicationComponentTestRule
Swap dagger graph
Disable crash logs / tracking
Override components

View Slide

By default, Espresso waits for UI events in the current
message queue to be handled and for default AsyncTasks
to complete before it moves on to the next test operation.
There are instances where applications perform
background operations (such as communicating with web
services) via non-standard means; for example: direct
creation and management of threads.
In such cases, you have to use Idling Resources to inform
Espresso of the app’s long-running operations.

View Slide

By default, Espresso waits for UI events in the current
message queue to be handled and for default AsyncTasks
to complete before it moves on to the next test operation.
There are instances where applications perform
background operations (such as communicating with web
services) via non-standard means; for example: direct
creation and management of threads.
In such cases, you have to use Idling Resources to inform
Espresso of the app’s long-running operations.

View Slide

IdlingResourceTestRule
Register / unregister idling resource before / after
test(s)
Used mostly in combination with RxIdlingResource

View Slide

public class ExecutionStrategy implements Observable.Transformer { 
 
private final Scheduler subscribeOnScheduler; 
private final Scheduler observeOnScheduler; 
 
public ExecutionStrategy(Scheduler subscribeOnScheduler, Scheduler
observeOnScheduler) { 
this.subscribeOnScheduler = subscribeOnScheduler; 
this.observeOnScheduler = observeOnScheduler; 
} 
 
@Override 
public Observable call(Observable observable) { 
return observable 
.subscribeOn(subscribeOnScheduler) 
.observeOn(observeOnScheduler); 
} 
 
}

View Slide

public class ExecutionStrategy implements Observable.Transformer { 
 
private final Scheduler subscribeOnScheduler; 
private final Scheduler observeOnScheduler; 
 
public ExecutionStrategy(Scheduler subscribeOnScheduler, Scheduler
observeOnScheduler) { 
this.subscribeOnScheduler = subscribeOnScheduler; 
this.observeOnScheduler = observeOnScheduler; 
} 
 
@Override 
.subscribeOn(subscribeOnScheduler) 
.observeOn(observeOnScheduler); 
} 
 
}

View Slide

RxIdlingResource
public ExecutionStrategy wrap(ExecutionStrategy strategy) { 
 
return new ExecutionStrategy() { 
@Override 
return wrap(executionStrategy.call(observable)); 
} 
};
 
}

View Slide

RxIdlingResource
public ExecutionStrategy wrap(ExecutionStrategy strategy) { 
 
return new ExecutionStrategy() { 
@Override 
return wrap(executionStrategy.call(observable)); 
} 
};
 
}

View Slide

RxIdlingResource
public Observable wrap(final Observable observable) { 
.doOnSubscribe(new Action0() { 
public void call() { 
isIdle.compareAndSet(true, false); 
} 
}) 
.finallyDo(new Action0() { 
if (isIdle.compareAndSet(false, true)) { 
if (resourceCallback != null) { 
resourceCallback.onTransitionToIdle(); 
} 
} 
} 
}); 
}

View Slide

} 
}) 
} 
} 
} 
}); 
}
RxIdlingResource

View Slide

} 
}) 
} 
} 
} 
}); 
}
RxIdlingResource

View Slide

Rules are good for you
Reusable
Unclutter your tests from unnecessary details
Separate conﬁguration and actual tests

View Slide

BETTER FAILURES

View Slide

Making ViewInteraction great again!
Wrap ViewInteraction
Use a FailureHandler to provide a human explanation
of what went wrong

View Slide

Caused by: junit.framework.AssertionFailedError: 'is displayed
on the screen to the user' doesn't match the selected view.
Expected: is displayed on the screen to the user
Got: "ab{id=2131689841, res-name=track_item_private_indicator,
visibility=GONE, width=0, height=0, has-focus=false, has-
focusable=false, has-window-focus=true, is-clickable=false, is-
enabled=true, is-focused=false, is-focusable=false, is-layout-
requested=true, is-selected=false, root-is-layout-
requested=false, has-input-connection=false, x=0.0, y=0.0,
text=Private, input-type=0, ime-target=false, has-links=false}”
[…]

View Slide

public BetterViewInteraction check(ViewAssertion viewAssert,
String failureMessage,
Object... args) { 
viewInteraction.withFailureHandler(new FailureHandler() { 
@Override 
public void handle(Throwable t, Matcher viewMatcher) {
String errorMessage = String.format(failureMessage, args); 
Throwable error = new AssertionFailed(errorMessage, t); 
defaultFailureHandler.handle(error, viewMatcher); 
} 
}).check(viewAssert); 
return this; 
}

View Slide

@Override 
} 
return this; 
}

View Slide

@Override 
} 
return this; 
}

View Slide

com.soundcloud.espresso.EspressoAssertionFailedError: Track is not displayed
as being private.
[…]
Caused by: junit.framework.AssertionFailedError: 'is displayed on the screen
to the user' doesn't match the selected view.
Expected: is displayed on the screen to the user
Got: "ab{id=2131689841, res-name=track_item_private_indicator,
visibility=GONE, width=0, height=0, has-focus=false, has-focusable=false,
has-window-focus=true, is-clickable=false, is-enabled=true, is-focused=false,
is-focusable=false, is-layout-requested=true, is-selected=false, root-is-
layout-requested=false, has-input-connection=false, x=0.0, y=0.0,
text=Private, input-type=0, ime-target=false, has-links=false}”
[…]

View Slide

GOING DEEPER

View Slide

Feature flags
Based on the flavour
Developing continuously
Switching a flag when we want to release the feature

View Slide

GREAT BUT… HOW DO
WE DEAL WITH TESTING
BOTH NEW & OLD
BEHAVIOUR?

View Slide

A CUSTOM TEST RUNNER!
OR, HOW TO SKIP TESTS
BASED ON A PREDICATE

View Slide

@RunWhen(
value = SomePredicate.class,
expected = false) 

View Slide

public final class SomeFeatureFlagEnabled extends Predicate {
 
@Override 
public boolean evaluate() { 
return featureFlags().someFeature(); 
} 
 
@Override 
public String description() { 
return “Some feature flag enabled"; 
}
 
}

View Slide

public class SkippableAndroidJUnit4 extends BlockJUnit4ClassRunner { 
 
@Override 
protected Statement methodBlock(FrameworkMethod testMethod) { 
Statement base = super.methodBlock(testMethod); 
Statement statement = applyRunWhenTo(testMethod.getMethod(), base); 
 
Class> clazz = testMethod.getDeclaringClass(); 
do { 
statement = applyRunWhenTo(clazz, statement); 
} while ((clazz = clazz.getSuperclass()) != null); 
return statement; 
} 
 
private Statement applyRunWhenTo(AnnotatedElement element, final Statement base) { 
RunWhen annotation = element.getAnnotation(RunWhen.class); 
if (annotation == null) { 
return base; 
} 
return new PredicateStatement(base, annotation.value(), annotation.expected()); 
} 
 
}

View Slide

public class SkippableAndroidJUnit4 extends BlockJUnit4ClassRunner { 
 
@Override 
protected Statement methodBlock(FrameworkMethod testMethod) { 
Statement base = super.methodBlock(testMethod); 
Statement statement = applyRunWhenTo(testMethod.getMethod(), base); 
 
Class> clazz = testMethod.getDeclaringClass(); 
do { 
statement = applyRunWhenTo(clazz, statement); 
} while ((clazz = clazz.getSuperclass()) != null); 
return statement; 
} 
 
private Statement applyRunWhenTo(AnnotatedElement element, final Statement base) { 
RunWhen annotation = element.getAnnotation(RunWhen.class); 
if (annotation == null) { 
return base; 
} 
return new PredicateStatement(base, annotation.value(), annotation.expected()); 
} 
 
}

View Slide

class PredicateStatement extends Statement { 
private final Statement base; 
private final Class extends Predicate> predicateClass; 
private final Boolean expected; 
 
public PredicateStatement(Statement base, Class extends Predicate>
predicateClass, Boolean expected) { 
this.base = base; 
this.predicateClass = predicateClass; 
this.expected = expected; 
} 
 
@Override 
Predicate predicate = PredicateBuilder.build(predicateClass); 
assumeThat(predicate.description(), predicate.evaluate(),
Matchers.is(expected)); 
base.evaluate(); 
} 
}

View Slide

class PredicateStatement extends Statement { 
private final Statement base; 
private final Class extends Predicate> predicateClass; 
private final Boolean expected; 
 
public PredicateStatement(Statement base, Class extends Predicate>
predicateClass, Boolean expected) { 
this.base = base; 
this.predicateClass = predicateClass; 
this.expected = expected; 
} 
 
@Override 
Predicate predicate = PredicateBuilder.build(predicateClass); 
assumeThat(predicate.description(), predicate.evaluate(),
Matchers.is(expected)); 
base.evaluate(); 
} 
}

View Slide

GRADLE

View Slide

def unlockAll = project.task('unlockAllDevices') 
 
command.devices().eachWithIndex { device, index -> 
 
def unlocker = project.task("unlockDevice${index}", type: ForceDeviceUnlock) { 
deviceId = device.id 
} 
unlockAll.dependsOn unlocker 
} 
 
project.afterEvaluate { 
project.tasks.findAll { 
it.name.startsWith('connected') && it.name.endsWith('AndroidTest') 
}*.dependsOn(unlockAll) 
}

View Slide

def unlockAll = project.task('unlockAllDevices') 
 
command.devices().eachWithIndex { device, index -> 
 
def unlocker = project.task("unlockDevice${index}", type: ForceDeviceUnlock) { 
deviceId = device.id 
} 
unlockAll.dependsOn unlocker 
} 
 
project.afterEvaluate { 
project.tasks.findAll { 
it.name.startsWith('connected') && it.name.endsWith('AndroidTest') 
}*.dependsOn(unlockAll) 
}

View Slide

class ForceDeviceUnlock extends AdbTask { 
 
@TaskAction 
void unlockDevice() { 
println 'Trying to unlock device using UnlockHelperApp (if installed)' 
def startHelperAppCommand = ['shell', 'am', 'start', '-n', 'io.appium.unlock/.Unlock'] 
assertDeviceAndRunCommand(startHelperAppCommand) 
 
println 'Trying to unlock device using unlock keycode' 
def pressUnlockKey = ['shell', 'input', 'keyevent', '82'] 
assertDeviceAndRunCommand(pressUnlockKey) 
 
println 'Sending "home" keycode to reset the screen' 
def pressHomeKey = ['shell', 'input', 'keyevent', '3'] 
assertDeviceAndRunCommand(pressHomeKey) 
} 
}

Taking care of your UI tests

Taking care of your UI tests

Florian Mierzejewski

More Decks by Florian Mierzejewski

Other Decks in Programming

Featured

Transcript