如何在 Android 中將單元測試設置為片段

Question

我想對一個 Android Fragment 類進行單元測試。

我可以使用 AndroidTestCase 設置測試還是需要使用 ApplicationTestCase？

是否有任何有用的示例說明如何使用這兩個測試用例？ 開發人員站點上的測試示例很少，似乎只專注於測試活動。

我在其他地方找到的只是擴展了 AndroidTestCase 類的示例，但是所有測試的都是將兩個數字相加，或者如果使用了 Context，它只是進行簡單的獲取並測試某些內容不為空！

據我了解，片段必須存在於活動中。 那么我可以創建一個模擬 Activity，或者讓 Application 或 Context 提供一個我可以在其中測試我的 Fragment 的 Activity 嗎？

我是否需要創建自己的 Activity 然后使用 ActivityUnitTestCase？

Answer 1

我在同一個問題上苦苦掙扎。 特別是，由於大多數代碼示例已經過時 + Android Studio/SDK 正在改進，所以舊的答案有時不再相關。

因此，首先要做的事情是：您需要確定是要使用Instrumental測試還是簡單的JUnit測試。

SD在這里精美地描述了它們之間的區別； 簡而言之：JUnit 測試更輕量級，不需要模擬器來運行，Instrumental - 為您提供最接近實際設備的可能體驗（傳感器、gps、與其他應用程序的交互等）。 另請閱讀有關在 Android 中進行測試的更多信息。

1.片段的JUnit測試

假設您不需要繁重的儀器測試，簡單的 junit 測試就足夠了。 為此，我使用了不錯的框架Robolectric 。

在 gradle 中添加：

dependencies {
    .....
    testImplementation('junit:junit:4.12')
    testImplementation('org.robolectric:robolectric:3.0')
    testImplementation("org.mockito:mockito-core:1.10.8")
    testImplementation('com.squareup.assertj:assertj-android:1.0.0') {
    exclude module: 'support-annotations'
    }
    .....
}

Mockito、AsserJ 是可選的，但我發現它們非常有用，所以我強烈建議也包括它們。

然后在Build Variants中將Unit Tests指定為Test Artifact ：

現在是時候編寫一些真正的測試了 :-) 作為示例，讓我們以標准的“帶有片段的空白活動”示例項目為例。

我添加了一些代碼行，以實際測試一些東西：

import android.os.Bundle;
import android.support.v4.app.Fragment;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import java.util.ArrayList;
import java.util.List;

public class MainActivityFragment extends Fragment {

    private List<Cow> cows;
    public MainActivityFragment() {}

    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {   
        cows = new ArrayList<>();
        cows.add(new Cow("Burka", 10));
        cows.add(new Cow("Zorka", 9));
        cows.add(new Cow("Kruzenshtern", 15));

        return inflater.inflate(R.layout.fragment_main, container, false);
    }

    int calculateYoungCows(int maxAge) {
        if (cows == null) {
            throw new IllegalStateException("onCreateView hasn't been called");
        }

        if (getActivity() == null) {
            throw new IllegalStateException("Activity is null");
        }

        if (getView() == null) {
            throw new IllegalStateException("View is null");
        }

        int result = 0;
        for (Cow cow : cows) {
            if (cow.age <= maxAge) {
                result++;
            }
        }

        return result;
    }
}

和類牛：

public class Cow {
    public String name;
    public int age;

    public Cow(String name, int age) {
        this.name = name;
        this.age = age;
    }
}

Robolectic 的測試集看起來像：

import android.app.Application;
import android.support.v4.app.Fragment;
import android.support.v4.app.FragmentManager;
import android.support.v4.app.FragmentTransaction;
import android.test.ApplicationTestCase;

import junit.framework.Assert;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.Robolectric;
import org.robolectric.RobolectricGradleTestRunner;
import org.robolectric.annotation.Config;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

@RunWith(RobolectricGradleTestRunner.class)
@Config(constants = BuildConfig.class, sdk=21)
public class MainActivityFragmentTest extends ApplicationTestCase<Application> {

    public MainActivityFragmentTest() {
        super(Application.class);
    }

    MainActivity mainActivity;
    MainActivityFragment mainActivityFragment;

    @Before
    public void setUp() {
        mainActivity = Robolectric.setupActivity(MainActivity.class);
        mainActivityFragment = new MainActivityFragment();
        startFragment(mainActivityFragment);
    }

    @Test
    public void testMainActivity() {
        Assert.assertNotNull(mainActivity);
    }

    @Test
    public void testCowsCounter() {
        assertThat(mainActivityFragment.calculateYoungCows(10)).isEqualTo(2);
        assertThat(mainActivityFragment.calculateYoungCows(99)).isEqualTo(3);
    }

    private void startFragment( Fragment fragment ) {
        FragmentManager fragmentManager = mainActivity.getSupportFragmentManager();
        FragmentTransaction fragmentTransaction = fragmentManager.beginTransaction();
        fragmentTransaction.add(fragment, null );
        fragmentTransaction.commit();
    }
}

即，我們通過Robolectric.setupActivity創建活動，這是測試類的 setUp() 中的新片段。 或者，您可以立即從 setUp() 啟動片段，也可以直接從測試中啟動。

注意！ 我沒有花太多時間在上面，但看起來幾乎不可能將它與 Dagger 綁定在一起（我不知道使用 Dagger2 是否更容易），因為您無法使用模擬注入設置自定義測試應用程序。

2. 碎片的儀器測試

這種方法的復雜性很大程度上取決於您是否在要測試的應用程序中使用 Dagger/Dependency 注入。

在Build Variants中，將Android Instrumental Tests指定為Test Artifact ：

在 Gradle 中，我添加了這些依賴項：

dependencies {
    .....
    androidTestCompile "com.google.dexmaker:dexmaker:1.1"
    androidTestCompile "com.google.dexmaker:dexmaker-mockito:1.1"
    androidTestCompile 'com.squareup.assertj:assertj-android:1.0.0'
    androidTestCompile "org.mockito:mockito-core:1.10.8"
    }
    .....
}

（同樣，幾乎所有這些都是可選的，但它們可以讓你的生活更輕松）

- 如果你沒有匕首

這是一條幸福的道路。 與上述 Robolectric 的區別僅在於小細節。

准備步驟 1 ：如果您要使用 Mockito，您必須使用此 hack 使其能夠在設備和模擬器上運行：

public class TestUtils {
    private static final String CACHE_DIRECTORY = "/data/data/" + BuildConfig.APPLICATION_ID + "/cache";
    public static final String DEXMAKER_CACHE_PROPERTY = "dexmaker.dexcache";

    public static void enableMockitoOnDevicesAndEmulators() {
        if (System.getProperty(DEXMAKER_CACHE_PROPERTY) == null || System.getProperty(DEXMAKER_CACHE_PROPERTY).isEmpty()) {
            File file = new File(CACHE_DIRECTORY);
            if (!file.exists()) {
                final boolean success = file.mkdirs();
                if (!success) {
                    fail("Unable to create cache directory required for Mockito");
                }
            }

            System.setProperty(DEXMAKER_CACHE_PROPERTY, file.getPath());
        }
    }
}

MainActivityFragment 保持不變，如上。 所以測試集看起來像：

package com.klogi.myapplication;

import android.support.v4.app.Fragment;
import android.support.v4.app.FragmentManager;
import android.support.v4.app.FragmentTransaction;
import android.test.ActivityInstrumentationTestCase2;

import junit.framework.Assert;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

public class MainActivityFragmentTest extends ActivityInstrumentationTestCase2<MainActivity> {

    public MainActivityFragmentTest() {
        super(MainActivity.class);
    }

    MainActivity mainActivity;
    MainActivityFragment mainActivityFragment;

    @Override
    protected void setUp() throws Exception {
        TestUtils.enableMockitoOnDevicesAndEmulators();
        mainActivity = getActivity();
        mainActivityFragment = new MainActivityFragment();
    }

    public void testMainActivity() {
        Assert.assertNotNull(mainActivity);
    }

    public void testCowsCounter() {
        startFragment(mainActivityFragment);
        assertThat(mainActivityFragment.calculateYoungCows(10)).isEqualTo(2);
        assertThat(mainActivityFragment.calculateYoungCows(99)).isEqualTo(3);
    }

    private void startFragment( Fragment fragment ) {
        FragmentManager fragmentManager = mainActivity.getSupportFragmentManager();
        FragmentTransaction fragmentTransaction = fragmentManager.beginTransaction();
        fragmentTransaction.add(fragment, null);
        fragmentTransaction.commit();

        getActivity().runOnUiThread(new Runnable() {
            @Override
            public void run() {
                getActivity().getSupportFragmentManager().executePendingTransactions();
            }
        });

        getInstrumentation().waitForIdleSync();
    }

}

如您所見，Test 類是ActivityInstrumentationTestCase2類的擴展。 此外，注意startFragment方法非常重要，它與 JUnit 示例相比發生了變化：默認情況下，測試不在 UI 線程上運行，我們需要顯式調用執行掛起的 FragmentManager 的事務。

- 如果你有匕首

這里的事情變得越來越嚴重:-)

首先，我們正在擺脫ActivityInstrumentationTestCase2以支持ActivityUnitTestCase類，作為所有片段測試類的基類。

像往常一樣，它不是那么簡單，並且有幾個陷阱（ 這是示例之一）。 所以我們需要將我們的AcitivityUnitTestCase 拉到ActivityUnitTestCaseOverride

在這里完整發布有點太長了，所以我將它的完整版上傳到github ；

public abstract class ActivityUnitTestCaseOverride<T extends Activity>
        extends ActivityUnitTestCase<T> {

    ........
    private Class<T> mActivityClass;

    private Context mActivityContext;
    private Application mApplication;
    private MockParent mMockParent;

    private boolean mAttached = false;
    private boolean mCreated = false;

    public ActivityUnitTestCaseOverride(Class<T> activityClass) {
        super(activityClass);
        mActivityClass = activityClass;
    }

    @Override
    public T getActivity() {
        return (T) super.getActivity();
    }

    @Override
    protected void setUp() throws Exception {
        super.setUp();

        // default value for target context, as a default
        mActivityContext = getInstrumentation().getTargetContext();
    }

    /**
     * Start the activity under test, in the same way as if it was started by
     * {@link android.content.Context#startActivity Context.startActivity()}, providing the
     * arguments it supplied.  When you use this method to start the activity, it will automatically
     * be stopped by {@link #tearDown}.
     * <p/>
     * <p>This method will call onCreate(), but if you wish to further exercise Activity life
     * cycle methods, you must call them yourself from your test case.
     * <p/>
     * <p><i>Do not call from your setUp() method.  You must call this method from each of your
     * test methods.</i>
     *
     * @param intent                       The Intent as if supplied to {@link android.content.Context#startActivity}.
     * @param savedInstanceState           The instance state, if you are simulating this part of the life
     *                                     cycle.  Typically null.
     * @param lastNonConfigurationInstance This Object will be available to the
     *                                     Activity if it calls {@link android.app.Activity#getLastNonConfigurationInstance()}.
     *                                     Typically null.
     * @return Returns the Activity that was created
     */
    protected T startActivity(Intent intent, Bundle savedInstanceState,
                              Object lastNonConfigurationInstance) {
        assertFalse("Activity already created", mCreated);

        if (!mAttached) {
            assertNotNull(mActivityClass);
            setActivity(null);
            T newActivity = null;
            try {
                IBinder token = null;
                if (mApplication == null) {
                    setApplication(new MockApplication());
                }
                ComponentName cn = new ComponentName(getInstrumentation().getTargetContext(), mActivityClass.getName());
                intent.setComponent(cn);
                ActivityInfo info = new ActivityInfo();
                CharSequence title = mActivityClass.getName();
                mMockParent = new MockParent();
                String id = null;

                newActivity = (T) getInstrumentation().newActivity(mActivityClass, mActivityContext,
                        token, mApplication, intent, info, title, mMockParent, id,
                        lastNonConfigurationInstance);
            } catch (Exception e) {
                assertNotNull(newActivity);
            }

            assertNotNull(newActivity);
            setActivity(newActivity);

            mAttached = true;
        }

        T result = getActivity();
        if (result != null) {
            getInstrumentation().callActivityOnCreate(getActivity(), savedInstanceState);
            mCreated = true;
        }
        return result;
    }

    protected Class<T> getActivityClass() {
        return mActivityClass;
    }

    @Override
    protected void tearDown() throws Exception {

        setActivity(null);

        // Scrub out members - protects against memory leaks in the case where someone
        // creates a non-static inner class (thus referencing the test case) and gives it to
        // someone else to hold onto
        scrubClass(ActivityInstrumentationTestCase.class);

        super.tearDown();
    }

    /**
     * Set the application for use during the test.  You must call this function before calling
     * {@link #startActivity}.  If your test does not call this method,
     *
     * @param application The Application object that will be injected into the Activity under test.
     */
    public void setApplication(Application application) {
        mApplication = application;
    }
    .......
}

為所有片段測試創建一個抽象 AbstractFragmentTest：

import android.app.Activity;
import android.content.Intent;
import android.content.pm.ActivityInfo;
import android.content.res.Configuration;
import android.support.v4.app.Fragment;
import android.support.v4.app.FragmentManager;
import android.support.v4.app.FragmentTransaction;

/**
 * Common base class for {@link Fragment} tests.
 */
public abstract class AbstractFragmentTest<TFragment extends Fragment, TActivity extends FragmentActivity> extends ActivityUnitTestCaseOverride<TActivity> {

    private TFragment fragment;
    protected MockInjectionRegistration mocks;

    protected AbstractFragmentTest(TFragment fragment, Class<TActivity> activityType) {
        super(activityType);
        this.fragment = parameterIsNotNull(fragment);
    }

    @Override
    protected void setActivity(Activity testActivity) {
        if (testActivity != null) {
            testActivity.setTheme(R.style.AppCompatTheme);
        }

        super.setActivity(testActivity);
    }

    /**
     * Get the {@link Fragment} under test.
     */
    protected TFragment getFragment() {
        return fragment;
    }

    protected void setUpActivityAndFragment() {
        createMockApplication();

        final Intent intent = new Intent(getInstrumentation().getTargetContext(),
                getActivityClass());
        startActivity(intent, null, null);
        startFragment(getFragment());

        getInstrumentation().callActivityOnStart(getActivity());
        getInstrumentation().callActivityOnResume(getActivity());
    }

    private void createMockApplication() {
        TestUtils.enableMockitoOnDevicesAndEmulators();

        mocks = new MockInjectionRegistration();
        TestApplication testApplication = new TestApplication(getInstrumentation().getTargetContext());
        testApplication.setModules(mocks);
        testApplication.onCreate();
        setApplication(testApplication);
    }

    private void startFragment(Fragment fragment) {
        FragmentManager fragmentManager = getActivity().getSupportFragmentManager();
        FragmentTransaction fragmentTransaction = fragmentManager.beginTransaction();
        fragmentTransaction.add(fragment, null);
        fragmentTransaction.commit();
    }
}

這里有幾件重要的事情。

1)我們重寫setActivity()方法將 AppCompact 主題設置為活動。 沒有它，測試服就會崩潰。

2) setUpActivityAndFragment() 方法：

I.創建活動（ => getActivity() 開始在測試和正在測試的應用程序中返回非空值）

1. onCreate() 調用的活動；

2. onStart() 調用的活動；

3. onResume() 調用的活動；

二、 附加並啟動片段到活動

1. 片段的 onAttach() 被調用；

2. 片段的 onCreateView() 被調用；

3. 片段的 onStart() 被調用；

4. 片段的 onResume() 被調用；

3) createMockApplication() 方法：與非匕首版本一樣，在第一步中，我們在設備和模擬器上啟用模擬。

然后我們用我們自定義的 TestApplication 替換普通應用程序的注入！

MockInjectionRegistration看起來像：

....
import javax.inject.Singleton;

import dagger.Module;
import dagger.Provides;
import de.greenrobot.event.EventBus;

import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

@Module(
        injects = {

                ....
                MainActivity.class,
                MyWorkFragment.class,
                HomeFragment.class,
                ProfileFragment.class,
                ....
        },
        addsTo = DelveMobileInjectionRegistration.class,
        overrides = true
)
public final class MockInjectionRegistration {

    .....
    public DataSource dataSource;
    public EventBus eventBus;
    public MixpanelAPI mixpanel;
    .....

    public MockInjectionRegistration() {
        .....
        dataSource = mock(DataSource.class);
        eventBus = mock(EventBus.class);
        mixpanel = mock(MixpanelAPI.class);
        MixpanelAPI.People mixpanelPeople = mock(MixpanelAPI.People.class);
        when(mixpanel.getPeople()).thenReturn(mixpanelPeople);
        .....
    }
...........
    @Provides
    @Singleton
    @SuppressWarnings("unused")
        // invoked by Dagger
    DataSource provideDataSource() {
        Guard.valueIsNotNull(dataSource);
        return dataSource;
    }

    @Provides
    @Singleton
    @SuppressWarnings("unused")
        // invoked by Dagger
    EventBus provideEventBus() {
        Guard.valueIsNotNull(eventBus);
        return eventBus;
    }

    @Provides
    @Singleton
    @SuppressWarnings("unused")
        // invoked by Dagger
    MixpanelAPI provideMixpanelAPI() {
        Guard.valueIsNotNull(mixpanel);
        return mixpanel;
    }
.........
}

即，我們向片段提供它們的模擬版本，而不是真正的類。 （易於追蹤，允許配置方法調用的結果等）。

而TestApplication只是你自定義的Application擴展，應該支持設置模塊和初始化ObjectGraph。

這些是開始編寫測試的前置步驟 :)現在是簡單的部分，真正的測試：

public class SearchFragmentTest extends AbstractFragmentTest<SearchFragment, MainActivity> {
    
    public SearchFragmentTest() {
        super(new SearchFragment(), MainActivity.class);
    }

    @UiThreadTest
    public void testOnCreateView() throws Exception {
        setUpActivityAndFragment();

        SearchFragment searchFragment = getFragment();
        assertNotNull(searchFragment.adapter);
        assertNotNull(SearchFragment.getSearchAdapter());
        assertNotNull(SearchFragment.getSearchSignalLogger());
    }

    @UiThreadTest
    public void testOnPause() throws Exception {
        setUpActivityAndFragment();

        SearchFragment searchFragment = getFragment();
        assertTrue(Strings.isNullOrEmpty(SharedPreferencesTools.getString(getActivity(), SearchFragment.SEARCH_STATE_BUNDLE_ARGUMENT)));

        searchFragment.searchBoxRef.setCurrentConstraint("abs");
        searchFragment.onPause();

        assertEquals(searchFragment.searchBoxRef.getCurrentConstraint(), SharedPreferencesTools.getString(getActivity(), SearchFragment.SEARCH_STATE_BUNDLE_ARGUMENT));
    }

    @UiThreadTest
    public void testOnQueryTextChange() throws Exception {
        setUpActivityAndFragment();
        reset(mocks.eventBus);

        getFragment().onQueryTextChange("Donald");
        Thread.sleep(300);

        // Should be one cached, one uncached event
        verify(mocks.eventBus, times(2)).post(isA(SearchRequest.class));
        verify(mocks.eventBus).post(isA(SearchLoadingIndicatorEvent.class));
    }

    @UiThreadTest
    public void testOnQueryUpdateEventWithDifferentConstraint() throws Exception {
        setUpActivityAndFragment();

        reset(mocks.eventBus);

        getFragment().onEventMainThread(new SearchResponse(new ArrayList<>(), "Donald", false));

        verifyNoMoreInteractions(mocks.eventBus);
    }
    ....
}

而已！ 現在你已經為你的 Fragments 啟用了 Instrumental/JUnit 測試。

我真誠地希望這篇文章對某人有所幫助。

Answer 2

假設您有一個名為“MyFragmentActivity”的 FragmentActivity 類，其中使用 FragmentTransaction 添加了一個名為“MyFragment”的公共 Fragment 類。 只需在您的測試項目中創建一個擴展 ActivityInstrumentationTestCase2 的“JUnit 測試用例”類。 然后只需調用 getActivity() 並訪問 MyFragment 對象及其公共成員以編寫測試用例。

參考下面的代碼片段：

// TARGET CLASS
public class MyFragmentActivity extends FragmentActivity {
    public MyFragment myFragment;

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

        FragmentTransaction fragmentTransaction = getSupportFragmentManager().beginTransaction();
        myFragment = new MyFragment();
        fragmentTransaction.add(R.id.mainFragmentContainer, myFragment);
        fragmentTransaction.commit();
    }
}

// TEST CLASS
public class MyFragmentActivityTest extends android.test.ActivityInstrumentationTestCase2<MyFragmentActivity> {
    MyFragmentActivity myFragmentActivity;
    MyFragment myFragment;

    public MyFragmentActivityTest() {
        super(MyFragmentActivity.class);
    }

    @Override
    protected void setUp() throws Exception {
        super.setUp();
        myFragmentActivity = (MyFragmentActivity) getActivity();
        myFragment = myFragmentActivity.myFragment;
    }

    public void testPreConditions() {
        assertNotNull(myFragmentActivity);
        assertNotNull(myFragment);
    }

    public void testAnythingFromMyFragment() {
        // access any public members of myFragment to test
    }
}

我希望這有幫助。 如果您覺得這很有用，請接受我的回答。 謝謝。

Answer 3

添加到@abhijit.mitkar 的答案。

假設您的片段不是被測活動中的公共成員。

protected void setUp() {
   mActivity = getActivity();
   mFragment = new TheTargetFragment();

   FragmentTransaction transaction = mActivity.getSupportFragmentManager().beginTransaction();
   transaction.add(R.id.fragment_container, mFragment, "FRAGMENT_TAG");
   transaction.commit();
}

上面代碼的目的是用我們可以訪問的新片段對象替換片段。

下面的代碼將允許您訪問片段 UI 成員。

TextView randomTextView= (TextView) mFragment.getView().findViewById(R.id.textViewRandom);

從活動中獲取 UI不會給您預期的結果。

TextView randomTextView= (TextView) mActivity.findViewById(R.id.textViewRandom);

最后，如果您希望在 UI 中進行一些更改。 就像一個優秀的 android 開發者在主線程中做的那樣。

mActivity.runOnUiThread(new Runnable() {
    @Override
    public void run() {
        // set text view's value
    }
});

注意：您可能希望在每次測試結束時給它一個 Thread.sleep() 。 為避免鎖定，getInstrumentation().waitForIdleSync(); 似乎並不總是有效。

因為我在做功能測試，所以我使用了ActivityInstrumentationTestCase2 。

Answer 4

我很確定你可以做你所說的，創建一個模擬 Activity 並從那里測試片段。 您只需在主項目中導出兼容性庫，就可以訪問測試項目中的片段。 我將創建一個示例項目並在此處測試代碼，並將根據我的發現更新我的答案。

有關如何導出兼容性庫的更多詳細信息，請查看此處。