Android UI 測試指南之 Espresso

關於 Espresso

• Espresso 是一個簡單好用的 Android UI 測試框架

• Espresso 主要由以下三個基礎部分組成：

  • ViewMatchers - 在當前View層級去匹配指定的View .
  • ViewActions - 執行Views的某些行為，如點選事件 .
  • ViewAssertions - 檢查Views的某些狀態，如是否顯示 .

• Espresso 使用示例

  onView(ViewMatcher) //1.匹配View
        .perform(ViewAction) //2.執行View行為
             .check(ViewAssertion); //3.驗證View
  複製程式碼

準備

第一步. build.gradle 新增如下依賴：

androidTestImplementation 'com.android.support.test.espresso:espresso-core:latest.version'
androidTestImplementation 'com.android.support.test:runner:latest.version'
androidTestImplementation 'com.android.support.test:rules:latest.version'
複製程式碼

第二步. android.defaultConfig 新增如下配置

testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
複製程式碼

基礎用法

獲得View

• withId方式

onView(withId(R.id.my_view))
複製程式碼

• withText方式

onView(withText("Hello World!"))
複製程式碼

執行View行為

• 點選

onView(...).perform(click());
複製程式碼

• 文字內容輸入

onView(...).perform(typeText("Hello"), click());
複製程式碼

• scrollTo 滑動

onView(...).perform(scrollTo(), click());
複製程式碼

檢驗View

• 檢驗View的文字內容

onView(...).check(matches(withText("Hello!")));
複製程式碼

• 檢驗View的顯示狀態

onView(...).check(matches(isDisplayed()));
複製程式碼

示例場景：

簡單的登陸場景測試

@RunWith(AndroidJUnit4.class)
public class LoginUITest {

    @Rule
    public ActivityTestRule<LoginActivity> rule=new ActivityTestRule<LoginActivity>(LogingActivity.class,true);

    @Test
    public void login(){
        //login
        onView(withId(R.id.userName)).perform(typeText("Jack"),closeSoftKeyboard());
        onView(withId(R.id.password)).perform(typeText("1234"),closeSoftKeyboard());
        onView(withText("登入")).perform(click());

        //verify
        onView(withId(R.id.content)).check(matches(isDisplayed()));
    }

}
複製程式碼

進階用法

1. 使用IdlingResource

通常，我們實際的應用當中會有很多非同步任務，例如網路請求，圖片載入等，但是Espresso並不知道你的非同步任務什麼時候結束，所以需要藉助於IdlingResource .

這裡需要注意的是，如果你是通過AsyncTask或者AsyncTaskCompat方式的非同步任務，Espresso已經處理好，並不需要去額外的處理。

第一步：新增依賴庫

compile 'com.android.support.test.espresso:espresso-idling-resource:latest.version'
複製程式碼

第二步：定義一個 IdlingResource 介面 .

public interface IdlingResource {

  /**
   * 用來標識 IdlingResource 名稱
   */
  public String getName();

  /**
   * 當前 IdlingResource 是否空閒 .
   */
  public boolean isIdleNow();

  /**
   註冊一個空閒狀態變換的ResourceCallback回撥
   */
  public void registerIdleTransitionCallback(ResourceCallback callback);

  /**
   * 通知Espresso當前IdlingResource狀態變換為空閒的回撥介面
   */
  public interface ResourceCallback {
    /**
     * 當前狀態轉變為空閒時，呼叫該方法告訴Espresso
     */
    public void onTransitionToIdle();
  }
}
複製程式碼

下面我們以一個示例來說明： 場景：假設當前我們需要測試使用者的頭像的是否正常顯示。

Activity程式碼

public class AvatarActivity extends AppCompatActivity{

    private ImageView mAvatar;

    public static SimpleIdlingResource sIdlingResource=new SimpleIdlingResource();

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_idling_resource);

        mAvatar= (ImageView) findViewById(R.id.avatar);

        //App 開始進入忙碌狀態 ，等待通知
        sIdlingResource.increment();
        //開始載入頭像圖片
        Glide.with(this).load("https://avatars2.githubusercontent.com/u/2297803?v=3&s=460").into(new GlideDrawableImageViewTarget(mAvatar) {
            @Override
            public void onResourceReady(GlideDrawable resource,
                                        GlideAnimation<? super GlideDrawable> animation) {
                super.onResourceReady(resource, animation);
                //載入完畢後，將App設定成空閒狀態
                sIdlingResource.decrement();
            }
        });
    }
}
複製程式碼

SimpleIdlingResource程式碼

public final class SimpleIdlingResource implements IdlingResource {

    private final AtomicInteger counter = new AtomicInteger(0);

    private volatile ResourceCallback resourceCallback;

    @Override
    public String getName() {
        return "SimpleIdlingResource";
    }

    /**
     * 如果counter的值等於0，說明當前是空閒狀態
     */    
    @Override
    public boolean isIdleNow() {
        return counter.get() == 0;
    }

    @Override
    public void registerIdleTransitionCallback(ResourceCallback resourceCallback) {
        this.resourceCallback = resourceCallback;
    }

    /**
     * counter的值增長方法
     */
    public void increment() {
        counter.getAndIncrement();
    }

    /**
     *counter的值減少方法
     */
    public void decrement() {
        int counterVal = counter.decrementAndGet();
        if (counterVal == 0) {
            // 執行onTransitionToIdle()方法，告訴Espresso，當前是空閒狀態。
            if (null != resourceCallback) {
                resourceCallback.onTransitionToIdle();
            }
        }

        if (counterVal < 0) {
            throw new IllegalArgumentException("Counter has been corrupted!");
        }
    }
}
複製程式碼

IdlingResourceTest程式碼

@RunWith(AndroidJUnit4.class)
public class IdlingResourceTest {

    @Rule
    public ActivityTestRule<AvatarActivity> rule=new ActivityTestRule<>(AvatarActivity.class,true);

    @Before
    public void registerIdlingResource(){
        Espresso.registerIdlingResources(rule.getActivity().sIdlingResource);
    }

    @Test
    public void avatarDisplayed(){
        onView(withId(R.id.avatar)).check(matches(isDisplayed()));
    }

    @After
    public void unregisterIdlingResource() {
        Espresso.unregisterIdlingResources(
                rule.getActivity().sIdlingResource);
    }

}
複製程式碼

另外，Espresso 提供了一個實現好的CountingIdlingResource類，所以如果沒有特別需求的話，直接使用CountingIdlingResource即可。

2.建立一個自定義 Espresso matcher

目前Espresso提供的方法基本上可以滿足你的測試需求，如下圖所示：

如果你需要對自定義的View中某個自定義屬性進行測試的話，你可以建立一個自定義的Matcher

    public static Matcher<View> isMoved() {
        return new TypeSafeMatcher<View>() {
            @Override
            public void describeTo(Description description) {
                description.appendText("is moved");
            }

            @Override
            public boolean matchesSafely(View view) {
                return ((CustomView)view).isMoved();
            }
        };
    }
複製程式碼

3.如何處理動畫

• 系統動畫： 為了避免動畫執行緒執行期間對Espresso測試產生的影響，官方強烈建議關閉系統動畫。如圖所示：

• 自定義動畫： 對於自定義動畫，開發者可以藉助以下程式碼去控制動畫的開和關。

該方法可以監聽系統動畫的開關事件，這是一個值得推薦的做法，不僅僅是在Espresso測試中。

    boolean animationEnabled=true;

    if (Build.VERSION.SDK_INT>=Build.VERSION_CODES.JELLY_BEAN_MR1){
        try {
            if (Settings.Global.getFloat(getContentResolver(),Settings.Global.ANIMATOR_DURATION_SCALE)==0.0f){
                animationEnabled=false;
            }
        } catch (Settings.SettingNotFoundException e) {
            e.printStackTrace();
        }
    }

複製程式碼

4.優雅的 IntentTest

• 普通的方式

    @Rule
    public ActivityTestRule<MainActivity> rule=new ActivityTestRule<MainActivity>(MainActivity.class){

        @Override
        protected Intent getActivityIntent() {
            Intent result=new Intent(...);
            result.putExtra(...)
            return result;
        }
    };
複製程式碼

如果使用普通的方式，那麼該單元測試類下的所有測試都是基於該Intent啟動的Activity，這樣顯然不夠靈活。

• 優雅的方式

    @Rule
    public ActivityTestRule<MainActivity> rule=new ActivityTestRule<MainActivity>(MainActivity.class,true,false);//第三個引數為是否自動執行Activity

    public void myTest(){
        Intent result=new Intent(...);
        result.putExtra(...);
        rule.launchActivity(result);
    }
複製程式碼

5.保證測試的獨立性

通常使用Espresso進行UI測試的時候，你並不期望去測試網路或者遠端的服務相關的東西，所以，你可以藉助於Espresso Intent，Mockito for mocking，以及依賴注射、Dagger2。 總之，儘量去分離那些不屬於UI層面的內容。

例如：你需要某個按鈕的點選事件進行測試，但是該按鈕的點選後，會跳轉到別的Activity，可是你不希望去測試別的Activity，那麼這裡就可以通過攔截Intent來解決。

首先你需要新增IntentTest依賴庫：

androidTestCompile 'com.android.support.test.espresso:espresso-intents:2.2.2'
複製程式碼

InterceptIntentTest示例程式碼

@RunWith(AndroidJUnit4.class)
public class InterceptIntentTest {

    @Rule
    public IntentsTestRule<MainActivity> rule=new IntentsTestRule<>(MainActivity.class);

    @Before
    public void stubCameraIntent(){
        // 模擬一個ActivityResult
        Instrumentation.ActivityResult result = createImageCaptureActivityResultStub();
        //攔截MediaStore.ACTION_IMAGE_CAPTURE，並返回模擬後的result
        intending(hasAction(MediaStore.ACTION_IMAGE_CAPTURE)).respondWith(result);
    }

    @Test
    public void takePhoto_cameraIsLaunched(){
        onView(withId(R.id.button_take_photo)).perform(click());
        intended(hasAction(MediaStore.ACTION_IMAGE_CAPTURE));
        ...
    }

    private Instrumentation.ActivityResult createImageCaptureActivityResultStub() {
        // Create the ActivityResult, with a null Intent since we do not want to return any data
        // back to the Activity.
        return new Instrumentation.ActivityResult(Activity.RESULT_OK, null);
    }

}
複製程式碼

6.避免直接複製貼上test程式碼

舉個簡單的例子。

onData(allOf(is(instanceOf(Map.class)),hasEntry(equalTo("STR"),is("item:50")))).perform(click());
複製程式碼

以上這段程式碼是匹配列表中符合條件的item，並執行執行點選事件，測試也正常，同樣這段程式碼也被複制到了其他的測試方法中使用， 這時，設想一下，如果你的adapter中的資料來源改成了cursor或者其他，於是悲催了，你需要修改很多地方，顯然，這不是一個合格的CV戰士。

所以，我們需要對之前那行程式碼進行改裝：

    @Test
    public void myTest(){
        onData(withItemContent("item:50")).perform(click());
    }

    public static Matcher<? extends Object> withItemContent(String expectedText) {
        ....
    }

複製程式碼

很簡單，只需將可能變化的部分抽出來即可。

7.如何測試View的位置

如圖所示：

8.自定義錯誤日誌

預設的錯誤日誌列印資訊比較多，如圖：

如果你只想顯示你關心的日誌資訊，你可以自定義FailureHandler：

private static class CustomFailureHandler implements FailureHandler {
    private final FailureHandler delegate;

    public CustomFailureHandler(Context targetContext) {
        delegate = new DefaultFailureHandler(targetContext);
    }

    @Override
    public void handle(Throwable error, Matcher<View> viewMatcher) {
        try {
            delegate.handle(error, viewMatcher);
        } catch (NoMatchingViewException e) {
            throw new MySpecialException(e);
        }
    }
}
複製程式碼

@Override
public void setUp() throws Exception {
    super.setUp();
    getActivity();
    setFailureHandler(new CustomFailureHandler(getInstrumentation()
                                              .getTargetContext()));
}
複製程式碼

關於我