Android自动化测试

时间 2021-02-20

标签 java android git github web 编程 json 设计模式 api 架构栏目 Android 繁體版

原文原文链接

Android自动化测试

测试金字塔

沿着金字塔逐级向上，从小型测试到大型测试，各种测试的保真度逐级提升，但维护和调试工做所需的执行时间和工做量也逐级增长。所以，您编写的单元测试应多于集成测试，集成测试应多于端到端测试。虽然各种测试的比例可能会因应用的用例不一样而异，但咱们一般建议各种测试所占比例以下：小型测试占70%，中型测试占20%，大型测试占10%。java

单元测试（小型测试）

用于验证应用的行为，一次验证一个类。android

原则（F.I.R.S.T）git

Fast(快)，单元测试要运行的足够快，单个测试方法通常要当即（一秒以内）给出结果。
Idependent(独立)，测试方法之间不要有依赖（先执行某个测试方法，再执行另外一个测试方法才能经过）。
Repeatable（重复），能够在本地或 CI 不一样环境（机器上）上反复执行，不会出现不稳定的状况。
Self-Validating（自验证），单元测试必须包含足够多的断言进行自我验证。
Timely（及时），理想状况下应测试先行，至少保证单元测试应该和实现代码一块儿及时完成并提交。github

除此以外，测试代码应该具有最好的可读性和最少的维护代价，绝大多数状况下写测试应该就像用领域特定语言描述一个事实，甚至不用通过仔细地思考。web

构建本地单元测试

当须要更快地运行测试而不须要与在真实设备上运行测试关联的保真度和置信度时，可使用本地单元测试来验证应用的逻辑。编程

若是测试对Android框架有依赖性（特别是与框架创建复杂交互的测试），则最好使用 Robolectric添加框架依赖项。json

例：待测试的类同时依赖 Context、 Intent、 Bundle、 Application等 Android Framework中的类时，此时咱们能够引入 Robolectric框架进行本地单元测试的编写。
若是测试对Android框架的依赖性极小，或者若是测试仅取决于咱们本身应用的对象，则可使用诸如Mockito之类的模拟框架添加模拟依赖项。(BasicUnitAndroidTest)设计模式

例：待测试的类只依赖 java api（最理想的状况）,此时对于待测试类所依赖的其余类咱们就能够利用 Mockito框架mock其依赖类，再进行当前类的单元测试编写。( EmailValidatorTest)
例：待测试的类除了依赖java api外仅依赖Android Framework中Context这个类,此时咱们就能够利用Mockito框架mock Context类，再进行当前类的单元测试编写。(SharedPreferencesHelperTest)api

设置测试环境

在Android Studio项目中，本地单元测试的源文件存储在module-name/src/test/java/中。架构

在模块的顶级build.gradle文件中，将如下库指定为依赖项：

dependencies {
        // Required -- JUnit 4 framework
        testImplementation "junit:junit:$junitVersion"
        // Optional -- Mockito framework
        testImplementation "org.mockito:mockito-core:$mockitoCoreVersion"
        
        // Optional -- Robolectric environment
       testImplementation "androidx.test:core:$xcoreVersion"
       testImplementation "androidx.test.ext:junit:$extJunitVersion"
       testImplementation "org.robolectric:robolectric:$robolectricVersion"
    }

若是单元测试依赖于资源，须要在module的build.gradle文件中启用includeAndroidResources选项。而后，单元测试能够访问编译版本的资源，从而使测试更快速且更准确地运行。

android {
        // ...

        testOptions {
            unitTests {
                includeAndroidResources = true
            }
        }
    }

@RunWith(AndroidJUnit4::class)
@Config(manifest = Config.NONE)
class PeopleDaoTest {
    private lateinit var database: PeopleDatabase

    private lateinit var peopleDao: PeopleDao

    @Before
    fun `create db`() {
        database = Room.inMemoryDatabaseBuilder(
            ApplicationProvider.getApplicationContext(),
            PeopleDatabase::class.java
        ).allowMainThreadQueries().build()

        peopleDao = database.peopleDao()
    }

    @Test
    fun `should return empty list when getPeople without inserted data`() {
        val result = peopleDao.getPeople(pageId = 1)

        assertThat(result).isNotNull()
        assertThat(result).isEmpty()
    }

若是单元测试包含异步操做时，可使用awaitility库进行测试；当使用RxJava响应式编程库时，能够自定义rule：

class RxJavaRule : TestWatcher() {
    override fun starting(description: Description?) {
        super.starting(description)

        RxJavaPlugins.setIoSchedulerHandler {
            Schedulers.trampoline()
        }
        RxJavaPlugins.setNewThreadSchedulerHandler {
            Schedulers.trampoline()
        }
        RxJavaPlugins.setComputationSchedulerHandler {
            Schedulers.trampoline()
        }

        RxAndroidPlugins.setMainThreadSchedulerHandler {
            Schedulers.trampoline()
        }
        RxAndroidPlugins.setInitMainThreadSchedulerHandler {
            Schedulers.trampoline()
        }
    }

    override fun finished(description: Description?) {
        super.finished(description)

        RxJavaPlugins.reset()

        RxAndroidPlugins.reset()
    }
}

TestScheduler中triggerActions的使用。

@RunWith(JUnit4::class)
class FilmViewModelTest {
    @get:Rule
    val instantTaskExecutorRule = InstantTaskExecutorRule()
    @get:Rule
    val rxJavaRule = RxJavaRule()

    private val repository = mock(Repository::class.java)

    private val testScheduler = TestScheduler()

    private lateinit var viewModel: FilmViewModel

    @Before
    fun init() {
        viewModel = FilmViewModel(repository)
    }

    @Test
    fun `should return true when loadFilms is loading`() {
        `when`(repository.getPopularFilms(1)).thenReturn(
            Single.just(emptyList<Film>())
                .subscribeOn(testScheduler)
        )

        viewModel.loadFilms(0)

        assertThat(getValue(viewModel.isLoading)).isTrue()
        testScheduler.triggerActions()
        assertThat(getValue(viewModel.isLoading)).isFalse()
    }

    @Test
    fun `should return films list when loadFilms successful`() {
        `when`(repository.getPopularFilms(1)).thenReturn(
            Single.just(
                listOf(
                    Film(123, "", "", "", "", "", "", 1)
                )
            ).subscribeOn(testScheduler)
        )

        viewModel.loadFilms(0)

        assertThat(getValue(viewModel.films)).isNull()
        testScheduler.triggerActions()
        assertThat(getValue(viewModel.films)).isNotNull()
        assertThat(getValue(viewModel.films).size).isEqualTo(1)
    }
}

TestSubscriber的使用。

@RunWith(JUnit4::class)
class WebServiceTest {
    private lateinit var webService: WebService

    private lateinit var mockWebServer: MockWebServer

    @get:Rule
    val instantExecutorRule = InstantTaskExecutorRule()

    @Before
    fun `start service`() {
        mockWebServer = MockWebServer()

        webService = Retrofit.Builder()
            .baseUrl(mockWebServer.url("/"))
            .addConverterFactory(GsonConverterFactory.create())
            .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
            .build()
            .create(WebService::class.java)
    }

    @Test
    fun `should return fim list when getFilms successful`() {
        assertThat(webService).isNotNull()

        enqueueResponse("popular_films.json")

        val testObserver = webService.getPopularFilms(page = 1)
            .map {
                it.data
            }.test()

        testObserver.assertNoErrors()
        testObserver.assertValueCount(1)
        testObserver.assertValue {
            assertThat(it).isNotEmpty()
            assertThat(it[0].id).isEqualTo(297761)
            assertThat(it[1].id).isEqualTo(324668)
            it.size == 2
        }
        testObserver.assertComplete()
        testObserver.dispose()
    }

    @After
    fun `stop service`() {
        mockWebServer.shutdown()
    }

    private fun enqueueResponse(fileName: String) {
        val inputStream = javaClass.classLoader?.getResourceAsStream("api-response/$fileName")
            ?: return
        val source = inputStream.source().buffer()
        val mockResponse = MockResponse()
        mockWebServer.enqueue(
            mockResponse
                .setBody(source.readString(Charsets.UTF_8))
        )
    }
}

构建插桩单元测试

插桩单元测试是在物理设备和模拟器上运行的测试，此类测试能够利用Android框架API。插桩测试提供的保真度比本地单元测试要高，但运行速度要慢得多。所以，咱们建议只有在必须针对真实设备的行为进行测试时才使用插桩单元测试。

设置测试环境

在Android Studio项目中，插桩测试的源文件存储在module-name/src/androidTest/java/。

在模块的顶级build.gradle文件中，将如下库指定为依赖项：

android {
        defaultConfig {
            testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
        }
    }

dependencies {
        androidTestImplementation "androidx.test.ext:junit:$extJunitVersion"
        androidTestImplementation "androidx.test:core:$xcoreVersion"
        androidTestImplementation "androidx.test:rules:$rulesVersion"
        // Optional -- Truth library
        androidTestImplementation "androidx.test.ext:truth:$androidxtruthVersion"
        androidTestImplementation "org.mockito:mockito-core:$mockitoCoreVersion"
        androidTestImplementation "org.mockito:mockito-android:$mockitoAndroidVersion"
    }

@RunWith(AndroidJUnit4::class)
@SmallTest
class FilmDaoTest {
    @get:Rule
    var instantTaskExecutorRule = InstantTaskExecutorRule()

    private lateinit var database: FilmDatabase

    private lateinit var filmDao: FilmDao

    @Before
    fun initDb() {
        database = Room.inMemoryDatabaseBuilder(
            ApplicationProvider.getApplicationContext(),
            FilmDatabase::class.java
        ).build()

        filmDao = database.filmData()
    }

    @Test
    fun should_return_film_list_when_getFilms_with_inserted_film_list() {
        filmDao.insert(
            Film(100, "", "", "", "", "", "", 1)
        )
        filmDao.insert(
            Film(101, "", "", "", "", "", "", 1)
        )

        val result = filmDao.getFilms(1)

        assertThat(result).isNotNull()
        assertThat(result).isNotEmpty()
        assertThat(result.size).isEqualTo(2)
        assertThat(result[0].id).isEqualTo(100)
        assertThat(result[0].page).isEqualTo(1)
        assertThat(result[1].id).isEqualTo(101)
    }

    @Test
    fun should_return_film_list_with_size_1_when_getFilms_with_inserted_2_same_film() {
        filmDao.insert(
            Film(100, "", "", "", "", "", "", 1)
        )
        filmDao.insert(
            Film(100, "1223", "111", "", "", "", "", 1)
        )

        val result = filmDao.getFilms(1)

        assertThat(result).isNotNull()
        assertThat(result).isNotEmpty()
        assertThat(result.size).isEqualTo(1)
        assertThat(result[0].id).isEqualTo(100)
        assertThat(result[0].page).isEqualTo(1)
    }

    @Test
    fun should_return_empty_list_when_getFilms_with_deleteAll_called() {
        filmDao.insert(
            Film(100, "", "", "", "", "", "", 1)
        )
        filmDao.deleteAll()

        val newResult = filmDao.getFilms(1)

        assertThat(newResult).isNotNull()
        assertThat(newResult).isEmpty()
    }

    @After
    fun closeDb() = database.close()
}

总结：

基于目前流行的MVP、MVVM架构设计模式，MVP中Model层和Presenter层尽可能不依赖Android Framework，MVVM中Model层和ViewModel层尽可能不依赖Android Framework。
类的设计作到单一职责原则,依赖其余类时提供方便mock的方式（例如做为构造方法参数传递），某一个方法依赖其余对象时，小重构该对象做为方法参数传入。
方法尽可能短小（方法太长时能够利用重构手法在方法中再提取方法）。
只覆盖public方法单元测试，privite方法能够间接测试。
当依赖Android Framework API很是少时，能够采用Mock Android api的方式。
当严重依赖Android Framework API时，引入Robolectric库模拟Android环境或者放入AndroidTest目录做为插桩单元测试在物理设备上跑。
使用Robolectric库写本地单元测试时，依赖的某些类的方法调用出问题致使测试failed时，可使用shadow类提供默认实现。
每条测试采用Given、When、Then的方式进行区分.

@Test
public void should_do_something_if_some_condition_fulfills() {
    // Given 设置前置条件

    // When 执行被测方法

    // Then 验证方法结果
}

集成测试（中型测试）

用于验证模块内堆栈级别之间的交互或相关模块之间的交互

若是应用使用了用户不直接与之交互的组件（如Service或ContentProvider），应验证这些组件在应用中的行为是否正确。

设置测试环境

参考插桩单元测试环境设置

Service测试

利用ServiceTestRule，可在单元测试方法运行以前启动服务，并在测试完成后关闭服务。
ServiceTestRule类不支持测试IntentService对象。若是须要测试IntentService对象，能够应将逻辑封装在一个单独的类中，并建立相应的单元测试。

@MediumTest
@RunWith(AndroidJUnit4.class)
public class LocalServiceTest {
    @Rule
    public final ServiceTestRule mServiceRule = new ServiceTestRule();

    @Test
    public void testWithBoundService() throws TimeoutException {
        // Create the service Intent.
        Intent serviceIntent =
                new Intent(getApplicationContext(), LocalService.class);

        // Data can be passed to the service via the Intent.
        serviceIntent.putExtra(LocalService.SEED_KEY, 42L);

        // Bind the service and grab a reference to the binder.
        IBinder binder = mServiceRule.bindService(serviceIntent);

        // Get the reference to the service, or you can call public methods on the binder directly.
        LocalService service = ((LocalService.LocalBinder) binder).getService();

        // Verify that the service is working correctly.
        assertThat(service.getRandomInt(), is(any(Integer.class)));
    }
}

ContentProvider的测试

使用ProviderTestRule

@Rule
 public ProviderTestRule mProviderRule =
     new ProviderTestRule.Builder(MyContentProvider.class, MyContentProvider.AUTHORITY).build();

 @Test
 public void verifyContentProviderContractWorks() {
     ContentResolver resolver = mProviderRule.getResolver();
     // perform some database (or other) operations
     Uri uri = resolver.insert(testUrl, testContentValues);
     // perform some assertions on the resulting URI
     assertNotNull(uri);
 }

@Rule
 public ProviderTestRule mProviderRule =
     new ProviderTestRule.Builder(MyContentProvider.class, MyContentProvider.AUTHORITY)
         .setDatabaseCommands(DATABASE_NAME, INSERT_ONE_ENTRY_CMD, INSERT_ANOTHER_ENTRY_CMD)
         .build();

 @Test
 public void verifyTwoEntriesInserted() {
     ContentResolver mResolver = mProviderRule.getResolver();
     // two entries are already inserted by rule, we can directly perform assertions to verify
     Cursor c = null;
     try {
       c = mResolver.query(URI_TO_QUERY_ALL, null, null, null, null);
       assertNotNull(c);
       assertEquals(2, c.getCount());
     } finally {
       if (c != null && !c.isClosed()) {
         c.close();
       }
     }
 }

Android没有为BroadcastReceiver提供单独的测试用例类。要验证 BroadcastReceiver是否正确响应，能够测试向其发送Intent对象的组件。或者，能够经过调用ApplicationProvider.getApplicationContext()来建立BroadcastReceiver的实例，而后调用要测试的BroadcastReceiver方法（一般，这是onReceive()方法）

端到端测试（大型测试）

用于验证跨越了应用的多个模块的用户操做流程

界面测试的一种方法是直接让测试人员对目标应用执行一系列用户操做，并验证其行为是否正常。不过，这种人工方法会很是耗时、繁琐且容易出错。一种更高效的方法是编写界面测试，以便以自动化方式执行用户操做。自动化方法能够以可重复的方式快速可靠地运行测试。

设置测试环境

dependencies {
        androidTestImplementation "androidx.test.ext:junit:$extJunitVersion"
        androidTestImplementation "androidx.test:core:$xcoreVersion"
        androidTestImplementation "androidx.test:rules:$rulesVersion"
        // Optional -- Truth library
        androidTestImplementation "androidx.test.ext:truth:$androidxtruthVersion"
        androidTestImplementation "org.mockito:mockito-core:$mockitoCoreVersion"
        androidTestImplementation "org.mockito:mockito-android:$mockitoAndroidVersion"
         // Optional -- UI testing with Espresso
        androidTestImplementation "androidx.test.espresso:espresso-core:$espressoVersion"
        androidTestImplementation "androidx.test.espresso:espresso-intents:$espressoVersion"
        // Optional -- UI testing with UI Automator
        androidTestImplementation "androidx.test.uiautomator:uiautomator:$uiautomatorVersion"
    }

涵盖单个应用的界面测试：这种类型的测试可验证目标应用在用户执行特定操做或在其 Activity 中输入特定内容时的行为是否符合预期。它可以让您检查目标应用是否返回正确的界面输出来响应应用 Activity 中的用户交互。诸如 Espresso 之类的界面测试框架可以让您以编程方式模拟用户操做，并测试复杂的应用内用户交互。(espresso测试单个应用的界面例子)
涵盖多个应用的界面测试：这种类型的测试可验证不一样用户应用之间交互或用户应用与系统应用之间交互的正确行为。例如，您可能想要测试相机应用是否可以与第三方社交媒体应用或默认的 Android 相册应用正确分享图片。支持跨应用交互的界面测试框架（如 UI Automator）可以让您针对此类场景建立测试。（uiautomator测试多个应用的界面）

参考例子testing-samples