Harshit Bangar

I am going to talk about how to write scalable ui tests and what are the things you can do with it.

Transcript

1. Scalable UI Testing Harshit Bangar Uber
2. Objectives 1. Espresso Basics.
3. Objectives 1. Espresso Basics. 2. Espresso Recipes.
4. Objectives 1. Espresso Basics. 2. Espresso Recipes. 3. Limitations of Espresso.
5. What do we need • Espresso • Gradle build variants • OKHttp • Dagger 2 • UIAutomator • Screenshot test
6. Basics onView(ViewMatcher) .perform(ViewAction) .check(ViewAssertion);
7. Basics • ViewMatcher onView(withId(R.id.hello_world)) .perform(ViewAction) .check(ViewAssertion);
8. Basics • ViewMatcher • ViewActions onView(withId(R.id.hello_world)) .perform(click()) .check(ViewAssertion);
9. Basics • ViewMatcher • ViewAction • ViewAssertion onView(withId(R.id.hello_world)) .perform(click()) .check(matches(not(isEnabled()));
10. UiAutomator Viewer
11. Custom View Matchers public static Matcher<View> withCompoundDrawable(final int resourceId) { return new BoundedMatcher<View, TextView>(TextView.class) { @Override public void describeTo(Description description) { description.appendText("has compound drawable resource " + resourceId); } @Override public boolean matchesSafely(TextView textView) { for (Drawable drawable : textView.getCompoundDrawables()) { if (sameBitmap(textView.getContext(), drawable, resourceId)) { return true; } } return false; } }; }
12. Custom View Matchers public static Matcher<View> withCompoundDrawable(final int resourceId) { return new BoundedMatcher<View, TextView>(TextView.class) { @Override public void describeTo(Description description) { description.appendText("has compound drawable resource " + resourceId); } @Override public boolean matchesSafely(TextView textView) { for (Drawable drawable : textView.getCompoundDrawables()) { if (sameBitmap(textView.getContext(), drawable, resourceId)) { return true; } } return false; } }; }
13. Cheat Sheet Advanced Espresso Espresso Intent Espresso and Lists
14. Espresso Recipes
15. Espresso Recipes • ScreenShot
16. Espresso Recipes • ScreenShot //CustomFailureHandler to listen for test failure. private static class CustomFailureHandler implements FailureHandler { private final FailureHandler delegate; public CustomFailureHandler (Context targetContext) { delegate = new ScreenShotFailureHandler (targetContext); } @Override public void handle(Throwable error, Matcher<View> viewMatcher) { try { delegate. handle(error, viewMatcher); } catch (NoMatchingViewException e) { throw new MySpecialException (e); } } }
17. Espresso Recipes • ScreenShot public static void takeScreenshot (String name, Activity activity) { View scrView = activity.getWindow().getDecorView().getRootView(); scrView.setDrawingCacheEnabled (true); Bitmap bitmap = Bitmap.createBitmap(scrView.getDrawingCache ()); scrView.setDrawingCacheEnabled (false); // Write to file. } @Before public void setUp() throws Exception { setFailureHandler( new CustomFailureHandler(getInstrumentation().getTargetContext())); }
18. Espresso Recipes • ScreenShot public static void takeScreenshot(String name, Activity activity) { View scrView = activity.getWindow().getDecorView().getRootView(); scrView.setDrawingCacheEnabled(true); Bitmap bitmap = Bitmap.createBitmap(scrView.getDrawingCache()); scrView.setDrawingCacheEnabled(false); // Write to file. } @Before public void setUp() throws Exception { setFailureHandler (new CustomFailureHandler (getInstrumentation ().getTargetContext ())); }
19. Build variants • Release • Debug • Test • Mock • Internal
20. Dagger 2 if (BuildConfig.DEBUG) { return new DebugApi(); } else { return new Api(); } @Module public final class DataModule { @Provides @Singleton public Api provideApi() { return new Api(); } } @Module public final class DebugDataModule { @Provides @Singleton Api provideApi() { return new DebugApi(); //Very heavy contains tons of dependecy like STETHO. } }
21. Dagger 2 if (BuildConfig.DEBUG) { return new DebugApi(); } else { return new Api(); } @Module public final class DataModule { @Provides @Singleton public Api provideApi() { return new Api(); } } @Module public final class DebugDataModule { @Provides @Singleton Api provideApi() { return new DebugApi(); //Very heavy contains tons of dependecy like STETHO. } }
22. Dagger 2 if (BuildConfig.DEBUG) { return new DebugApi(); } else { return new Api(); } @Module public final class DataModule { @Provides @Singleton public Api provideApi() { return new Api(); } } @Module public final class DebugDataModule { @Provides @Singleton Api provideApi() { return new DebugApi(); //Very heavy contains tons of dependecy like STETHO. } }
23. Dagger 2 @Singleton @Component(modules = {DataModule.class}) public interface Graph { void inject(BaseActivity activity); public final static class Initializer { public static Graph init(boolean mockMode) { return Dagger_Graph.builder() .build(); } } } @Singleton @Component(modules = {DebugDataModule.class}) public interface Graph { void inject(BaseActivity activity); void inject(InjectedActivityTest test); public final static class Initializer { public static Graph init(boolean mockMode) { return Dagger_Graph.builder() .debugDataModule(new DebugDataModule(mockMode)) .build(); } } }
24. Dagger 2 @Singleton @Component(modules = {DataModule.class}) public interface Graph { void inject(BaseActivity activity); public final static class Initializer { public static Graph init(boolean mockMode) { return Dagger_Graph.builder() .build(); } } } @Singleton @Component(modules = {DebugDataModule.class}) public interface Graph { void inject(BaseActivity activity); void inject(InjectedActivityTest test); public final static class Initializer { public static Graph init(boolean mockMode) { return Dagger_Graph.builder() .debugDataModule(new DebugDataModule(mockMode)) .build(); } } }
25. Espresso Recipes • AB Test
26. Espresso Recipe • A/B Tests. public interface ABTestManager { public void getExperimentTreatment (String experimentName); public void setExperimentTreatment (String experimentName, String treatment); } // Real Implementation populated by network response. // Provided by Mocked dagger injector. public class MockABTestManager implements ABTestManager { public void getExperimentTreatment(String experimentName); public void setExperimentTreatment(String experimentName, String treatment); }
27. Espresso Recipe • A/B Tests. public interface ABTestManager { public void getExperimentTreatment(String experimentName); public void setExperimentTreatment(String experimentName, String treatment); } // Real Implementation populated by network response. // Provided by Mocked dagger injector. public class MockABTestManager implements ABTestManager { public void getExperimentTreatment (String experimentName); public void setExperimentTreatment (String experimentName, String treatment); }
28. Espresso Recipe • A/B Tests. public class ExperimentRule extends TestWatcher { @Inject MockABTestManager mockABTestManager; @Override protected void starting(Description description) { mockABTestManager. clear(); Experiment experiment = description.getAnnotation(Experiment.class); mockABTestManager. put(experiment.getName(), experiment.getTreatment(); } } @Experiment(name="XYZ", treatment="ABC") @Test public void test() { // Test code. }
29. Espresso Recipe • A/B Tests. public class ExperimentRule extends TestWatcher { @Inject MockABTestManager mockABTestManager; @Override protected void starting(Description description) { mockABTestManager.clear(); Experiment experiment = description.getAnnotation(Experiment. class); mockABTestManager.put(experiment.getName(), experiment.getTreatment(); } } @Experiment(name="XYZ", treatment="ABC") @Test public void test() { // Test code. }
30. Espresso Recipe • Network
31. Espresso Recipe • IdlingResource CountingIdlingResource mCountingIdlingResource = new CountingIdlingResource ("Generic"); public void beforeLongTask() { mCountingIdlingResource.increment(); } public void afterLongTask() { mCountingIdlingResource.decrement(); } // Setup Espresso.registerIdlingResources(mCountingIdlingResource);
32. Espresso Recipe • IdlingResource CountingIdlingResource mCountingIdlingResource = new CountingIdlingResource("Generic"); public void beforeLongTask () { mCountingIdlingResource. increment(); } public void afterLongTask() { mCountingIdlingResource.decrement(); } // Setup Espresso.registerIdlingResources(mCountingIdlingResource);
33. Espresso Recipe • IdlingResource CountingIdlingResource mCountingIdlingResource = new CountingIdlingResource("Generic"); public void beforeLongTask() { mCountingIdlingResource.increment(); } public void afterLongTask() { mCountingIdlingResource. decrement(); } // Setup Espresso.registerIdlingResources(mCountingIdlingResource);
34. Espresso Recipe • IdlingResource CountingIdlingResource mCountingIdlingResource = new CountingIdlingResource("Generic"); public void beforeLongTask() { mCountingIdlingResource.increment(); } public void afterLongTask() { mCountingIdlingResource.decrement(); } // Setup Espresso.registerIdlingResources(mCountingIdlingResource);
35. Idling resource • ThreadPoolExectuor class EspressoCountingIdlingResource extends ThreadPoolExecutor implements IdlingResource { @Override public synchronized void execute(Runnable r) { super.execute(r); threadCount++; } @Override protected synchronized void afterExecute(Runnable r, Throwable t) { super.afterExecute(r, t); threadCount--; if (threadCount == 0) { if (null != callback) { callback.onTransitionToIdle(); } } } @Override public void registerIdleTransitionCallback(ResourceCallback callback) { this.callback = callback; } }
36. Idling resource • ThreadPoolExectuor class EspressoCountingIdlingResource extends ThreadPoolExecutor implements IdlingResource { @Override public synchronized void execute(Runnable r) { super.execute(r); threadCount++; } @Override protected synchronized void afterExecute(Runnable r, Throwable t) { super.afterExecute(r, t); threadCount--; if (threadCount == 0) { if (null != callback) { callback.onTransitionToIdle(); } } } @Override public void registerIdleTransitionCallback(ResourceCallback callback) { this.callback = callback; } }
37. Idling resource • ThreadPoolExectuor class EspressoCountingIdlingResource extends ThreadPoolExecutor implements IdlingResource { @Override public synchronized void execute(Runnable r) { super.execute(r); threadCount++; } @Override protected synchronized void afterExecute(Runnable r, Throwable t) { super.afterExecute(r, t); threadCount--; if (threadCount == 0) { if (null != callback) { callback.onTransitionToIdle(); } } } @Override public void registerIdleTransitionCallback(ResourceCallback callback) { this.callback = callback; } }
38. Idling resource • ThreadPoolExectuor class EspressoCountingIdlingResource extends ThreadPoolExecutor implements IdlingResource { @Override public synchronized void execute(Runnable r) { super.execute(r); threadCount++; } @Override protected synchronized void afterExecute(Runnable r, Throwable t) { super.afterExecute(r, t); threadCount--; if (threadCount == 0) { if (null != callback) { callback.onTransitionToIdle(); } } } @Override public void registerIdleTransitionCallback(ResourceCallback callback) { this.callback = callback; } }
39. Espresso Recipe • Network replay/record.
40. Espresso Recipe • Record //OkHttp Record Interceptor class RecordInterceptor implements Interceptor { @Override public Response intercept(Interceptor.Chain chain) throws IOException { Request request = chain. request(); Response response = chain. proceed(request); String filename = request. getUri(); // Serialised and store in file. return response; } } <manifest ...> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> ... </manifest> // adb pull and store it in asset storage adapter.
41. Espresso Recipe • Record //OkHttp Record Interceptor class RecordInterceptor implements Interceptor { @Override public Response intercept(Interceptor.Chain chain) throws IOException { Request request = chain.request(); Response response = chain.proceed(request); String filename = request.getUri(); // Serialised and store in file. return response; } } <manifest ...> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> ... </manifest> // adb pull and store it in asset storage adapter.
42. Espresso Recipe • Replay class ReplayInterceptor implements Interceptor { @Override public Response intercept(Interceptor.Chain chain) throws IOException { Request request = chain. request(); InputStream is = mContext.getResources().getAssets().open("your-file-path" ); BufferedReader br = new BufferedReader (new InputStreamReader (is, "UTF-8")); String line; while ((line = br.readLine()) != null) { //play with each line here // Deserialiser and network response. } if (!TextUtils.isEmpty(response)) { return response; } Response response = chain. proceed(request); return response; } } @Replay(record=true) @Test public void test() { }
43. Espresso Recipe • Replay class ReplayInterceptor implements Interceptor { @Override public Response intercept(Interceptor.Chain chain) throws IOException { Request request = chain.request(); InputStream is = mContext.getResources().getAssets().open("your-file-path"); BufferedReader br = new BufferedReader( new InputStreamReader(is, "UTF-8")); String line; while ((line = br.readLine()) != null) { //play with each line here // Deserialiser and network response. } if (!TextUtils.isEmpty(response)) { return response; } Response response = chain.proceed(request); return response; } } @Replay(record=true) @Test public void test() { }
44. Espresso Recipe • Robot/Layouts
45. Espresso Recipe • Robot onView(withText("4")).perform(click()); onView(withText("4")).perform(click()); onView(withHint("Recipient")).perform(typeText("foo@bar.com")); onView(withText("4")).perform(click()); onView(withText("Success!")).check(visible()); onView(withText("4")).perform(click()); onView(withText("4")).perform(click()); onView(withHint("Recipient")).perform(typeText("foo")); onView(withText("4")).perform(click()); onView(withText("Failed!")).check((visible());
46. Espresso Recipe • Robot onView(withText("4")).perform(click()); onView(withText("4")).perform(click()); onView(withHint("Recipient")).perform(typeText("foo@bar.com")); onView(withText("4")).perform(click()); onView(withText("Success!")).check(visible()); onView(withText("4")).perform(click()); onView(withText("4")).perform(click()); onView(withHint("Recipient")).perform(typeText("foo")); onView(withText("4")).perform(click()); onView(withText("Failed!")).check((visible());
47. Espresso Recipe • Robot class PaymentRobot { PaymentRobot amount(long amount) { ... } PaymentRobot recipient(String recipient) { .. } ResultRobot send() { ... } } class ResultRobot { ResultRobot isSuccess() { ... } } PaymentRobot payment = new PaymentRobot(); ResultRobot result = payment .amount(42_00) .recipient("foo@bar.com") .send(); result.isSuccess();
48. Espresso Recipe • Robot class PaymentRobot { PaymentRobot amount(long amount) { ... } PaymentRobot recipient(String recipient) { .. } ResultRobot send() { ... } } class ResultRobot { ResultRobot isSuccess() { ... } } PaymentRobot payment = new PaymentRobot(); ResultRobot result = payment .amount(42_00) .recipient("foo@bar.com") .send(); result.isSuccess();
49. Espresso Recipes • Performance Testing
50. Espresso Recipes • Performance Testing @Override public View getView(int position, View convertView, ViewGroup parent ) { Contact contact = getItem(position); LayoutInflater inflater = LayoutInflater.from(getContext()); // This line is wrong, we're inflating a new view always instead of only if it's null. // For demonstration purposes, we will leave this here to show the resulting jank. convertView = inflater.inflate(R.layout.item_contact, parent, false); TextView contactName = (TextView) convertView.findViewById(R.id.contact_name); ImageView contactImage = (ImageView) convertView.findViewById(R.id.contact_image); contactName.setText(contact.getName()); // Let's just create another bitmap when we need one. This makes no attempts to re-use // bitmaps that were previously used in rendering past list view elements, causing a large // amount of memory to be consumed as you scroll farther down the list. Bitmap bm = BitmapFactory.decodeResource(convertView.getResources(), R.drawable.bbq); contactImage.setImageBitmap(bm); return convertView; }
51. Espresso Recipes • Performance Testing @Override public View getView(int position, View convertView, ViewGroup parent ) { Contact contact = getItem(position); LayoutInflater inflater = LayoutInflater.from(getContext()); // This line is wrong, we're inflating a new view always instead of only if it's null. // For demonstration purposes, we will leave this here to show the resulting jank. convertView = inflater.inflate(R.layout.item_contact, parent, false); TextView contactName = (TextView) convertView.findViewById(R.id.contact_name); ImageView contactImage = (ImageView) convertView.findViewById(R.id.contact_image); contactName.setText(contact.getName()); // Let's just create another bitmap when we need one. This makes no attempts to re-use // bitmaps that were previously used in rendering past list view elements, causing a large // amount of memory to be consumed as you scroll farther down the list. Bitmap bm = BitmapFactory.decodeResource(convertView.getResources(), R.drawable.bbq); contactImage.setImageBitmap(bm); return convertView; }
52. Espresso Recipes • Performance Testing @Override public View getView(int position, View convertView, ViewGroup parent ) { Contact contact = getItem(position); LayoutInflater inflater = LayoutInflater.from(getContext()); // This line is wrong, we're inflating a new view always instead of only if it's null. // For demonstration purposes, we will leave this here to show the resulting jank. convertView = inflater.inflate(R.layout.item_contact, parent, false); TextView contactName = (TextView) convertView.findViewById(R.id.contact_name); ImageView contactImage = (ImageView) convertView.findViewById(R.id.contact_image); contactName.setText(contact.getName()); // Let's just create another bitmap when we need one. This makes no attempts to re-use // bitmaps that were previously used in rendering past list view elements, causing a large // amount of memory to be consumed as you scroll farther down the list. Bitmap bm = BitmapFactory.decodeResource(convertView.getResources(), R.drawable.bbq); contactImage.setImageBitmap(bm); return convertView; }
53. Espresso Recipes • Performance Testing @Test @PerfTest public void scrollFullList() throws InterruptedException { ListView listView = (ListView) mActivityRule.getActivity().findViewById(android.R.id.list); // Get last position and offset for zero-indexed position tracking. int lastPosition = listView.getAdapter().getCount() - 1; // Espresso method of scrolling to the last item. // onData(anything()).atPosition(lastPosition); // Standard Android method of scrolling to the last position. listView.smoothScrollToPositionFromTop(lastPosition, 0, SCROLL_TIME_IN_MILLIS); // Scrolling is performed asynchronously so we need to periodically loop and detect if // we're finished scrolling yet. This can be delayed by any work being done to display // data items in the ListView. while (listView.getLastVisiblePosition() != lastPosition) { Thread.sleep(300); } } @Rule public EnableTestTracing mEnableTestTracing = new EnableTestTracing(); @Rule public EnablePostTestDumpsys mEnablePostTestDumpsys = new EnablePostTestDumpsys(); @Rule public EnableLogcatDump mEnableLogcatDump = new EnableLogcatDump(); @Rule public EnableNetStatsDump mEnableNetStatsDump = new EnableNetStatsDump();
54. Espresso Recipes • Performance Testing @Test @PerfTest public void scrollFullList() throws InterruptedException { ListView listView = (ListView) mActivityRule.getActivity().findViewById(android.R.id.list); // Get last position and offset for zero-indexed position tracking. int lastPosition = listView.getAdapter().getCount() - 1; // Espresso method of scrolling to the last item. // onData(anything()).atPosition(lastPosition); // Standard Android method of scrolling to the last position. listView.smoothScrollToPositionFromTop(lastPosition, 0, SCROLL_TIME_IN_MILLIS); // Scrolling is performed asynchronously so we need to periodically loop and detect if // we're finished scrolling yet. This can be delayed by any work being done to display // data items in the ListView. while (listView.getLastVisiblePosition() != lastPosition) { Thread.sleep(300); } } @Rule public EnableTestTracing mEnableTestTracing = new EnableTestTracing(); @Rule public EnablePostTestDumpsys mEnablePostTestDumpsys = new EnablePostTestDumpsys(); @Rule public EnableLogcatDump mEnableLogcatDump = new EnableLogcatDump(); @Rule public EnableNetStatsDump mEnableNetStatsDump = new EnableNetStatsDump();
56. Limitations
57. UI Automator
58. UIAutomator private static final String BASIC_SAMPLE_PACKAGE = "com.google.android.youtube" ; private static final int LAUNCH_TIMEOUT = 5000; private UiDevice mDevice; private static double totalTime = 0; public static final String YOUTUBE_BUTTON_ID = "com.google.android.youtube:id/menu_search" ; private long startTime = 0; @Before public void startMainActivityFromHomeScreen() { // Initialize UiDevice instance mDevice = UiDevice.getInstance(InstrumentationRegistry.getInstrumentation()); // Start from the home screen mDevice.pressHome(); // Wait for launcher final String launcherPackage = mDevice.getLauncherPackageName(); assertThat(launcherPackage, notNullValue()); mDevice.wait(Until.hasObject(By.pkg(launcherPackage).depth(0)), LAUNCH_TIMEOUT); // Launch the app Context context = InstrumentationRegistry.getContext(); final Intent intent = context.getPackageManager() .getLaunchIntentForPackage(BASIC_SAMPLE_PACKAGE); // Clear out any previous instances intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK); context.startActivity(intent); // Wait for the app to appear startTime = System.nanoTime(); mDevice.wait(Until.hasObject(By.pkg(BASIC_SAMPLE_PACKAGE).depth(0)), LAUNCH_TIMEOUT); }
59. UIAutomator private static final String BASIC_SAMPLE_PACKAGE = "com.google.android.youtube"; private static final int LAUNCH_TIMEOUT = 5000; private UiDevice mDevice; private static double totalTime = 0; public static final String YOUTUBE_BUTTON_ID = "com.google.android.youtube:id/menu_search"; private long startTime = 0; @Before public void startMainActivityFromHomeScreen () { // Initialize UiDevice instance mDevice = UiDevice. getInstance (InstrumentationRegistry. getInstrumentation ()); // Start from the home screen mDevice. pressHome (); // Wait for launcher final String launcherPackage = mDevice. getLauncherPackageName (); assertThat (launcherPackage, notNullValue ()); mDevice. wait(Until.hasObject (By.pkg(launcherPackage). depth(0)), LAUNCH_TIMEOUT); // Launch the app Context context = InstrumentationRegistry. getContext (); final Intent intent = context. getPackageManager () . getLaunchIntentForPackage (BASIC_SAMPLE_PACKAGE); // Clear out any previous instances intent. addFlags (Intent.FLAG_ACTIVITY_CLEAR_TASK); context. startActivity (intent); // Wait for the app to appear startTime = System. nanoTime (); mDevice. wait(Until.hasObject (By.pkg(BASIC_SAMPLE_PACKAGE). depth(0)), LAUNCH_TIMEOUT); }
60. UIAutomator @Test public void youtubeTest() throws UiObjectNotFoundException, InterruptedException { while (true) { UiObject okButton = mDevice.findObject(new UiSelector() .resourceId(YOUTUBE_BUTTON_ID)); // Simulate a user-click on the OK button, if found. if(okButton.exists() && okButton.isEnabled()) { okButton.click(); totalTime = totalTime + (System.nanoTime() - startTime)/Math.pow(10, 9); i(YoutubeTest.class.getSimpleName(), String.valueOf(totalTime)); break; } else { Thread.sleep(5); } } } @After public void cleanup() throws UiObjectNotFoundException { UiObject app = mDevice.findObject(new UiSelector().packageName(BASIC_SAMPLE_PACKAGE)); app.swipeLeft(100); }
61. UIAutomator @Test public void youtubeTest() throws UiObjectNotFoundException, InterruptedException { while (true) { UiObject okButton = mDevice.findObject(new UiSelector() .resourceId(YOUTUBE_BUTTON_ID)); // Simulate a user-click on the OK button, if found. if(okButton.exists() && okButton.isEnabled()) { okButton.click(); totalTime = totalTime + (System.nanoTime() - startTime)/Math.pow(10, 9); i(YoutubeTest.class.getSimpleName(), String.valueOf(totalTime)); break; } else { Thread.sleep(5); } } } @After public void cleanup() throws UiObjectNotFoundException { UiObject app = mDevice.findObject(new UiSelector().packageName(BASIC_SAMPLE_PACKAGE)); app.swipeLeft(100); }
62. ScreenShot test public void testRendering() throws Throwable { LayoutInflater inflater = LayoutInflater. from(getInstrumentation ().getTargetContext ()); View view = inflater. inflate(R.layout.search_bar, null, false); ViewHelpers. setupView(view) .setExactWidthDp (300) .layout(); Screenshot.snap(view) .record(); } gradle screenshotTests gradle recordMode screenshotTests gradle verifyMode screenshotTests
63. ScreenShot test public void testRendering() throws Throwable { LayoutInflater inflater = LayoutInflater.from(getInstrumentation().getTargetContext()); View view = inflater.inflate(R.layout.search_bar, null, false); ViewHelpers.setupView(view) .setExactWidthDp(300) .layout(); Screenshot.snap(view) .record(); } gradle screenshotTests gradle recordMode screenshotTests gradle verifyMode screenshotTests
64. ScreenShot test
65. QUESTIONS? HIRING THANK YOU!!