这篇文章为《解读Android官方MVP项目单元测试》(以下简称《解读》)的附录部分,行此文的目的有二,其一是这个项目的单元测试齐全,覆盖率很高,有极高的学习价值,笔者希望把每个测试用例都描述一遍,通过这种方式来强迫自己认真的看完。其二,这部分内容难免枯燥,笔者尽力想把它写得可读性高一点点,却发现着实有难度,简直是给自己挖坑,所以从《写点有价值的测试用例》的角度出发,对这篇附录文章稍作修饰。但不管这样,这个MVP项目及其单元测试用例对我们的工作可以带来很多思路,所以不妨速读一遍。
一 什么是有价值的测试用例
以这个项目为例,我觉得对于测试用例的设计,不能离开架构层面和业务层面。
- 架构层面
不同的架构,决定着测试用例的写法不一,比如MVC或者MVP,每一层负责的测试职责是不一样的。 以todo-mvp这个项目为例,笔者在《解读》中已经提到,一个功能的测试需要MVP三层的协作,彼此各司其职,却又互相联系,这里再做一番总结:
- Presenter层:这一层很清晰,我们为它的每个接口方法,以及每个方法里涉及的多个逻辑路径设计相应的测试用例,值得注意的是,这一层我们较少做输入输出的断言,而是验证是否正确覆盖V层和M层的逻辑。
- Model层:同上,我们为它的每个方法设计测试用例,与P层不同,这一层要断言输入输出数据是否准确。
- View层:这一层我们放在业务层面来讲。
- 业务层面
做单元测试,测试业务逻辑是重中之重。View层承担着这一重任,设计这一层的测试用例时,不要想太多,站在我们正常使用功能的角度出发,把交互行为翻译成Espresso的代码。由于View是入口,当一种交互行为发生,Presenter开始调度View和Model层各自执行逻辑,因此从这个角度来讲,View层的测试涵盖了MVP三层的逻辑。
聊完有价值的,我们再来看看什么是没价值的测试用例。比如以下几种:
- 对成熟的工具类进行测试
- 对简单的方法进行测试(比如get、set方法)
- MVP各层重复测试,比如P层去断言输入输出的正确性
接下来笔者将完整的展示这个MVP项目中的所有单元测试用例,分为三个维度,androidTest下的、androidTestMock下的和test下的所有测试用例,如果觉得阅读起来枯燥,可以直接阅读每个测试类开篇的概述部分。
二 androidTest文件下的测试
V层:导航界面测试——AppNavigationTest
概述:该测试用例做导航测试,即对DrawerLayout打开、关闭、点击Item后打开的Activity等功能进行测试。
意义:告诉我们如何对DrawerLayout设计有价值的测试用例。
-
clickOnStatisticsNavigationItem_ShowsStatisticsScreen
打开Left Drawer->点击Statistics按钮->断言StatisticsActivity已经打开 -
clickOnListNavigationItem_ShowsListScreen
打开Left Drawer->点击Statistics按钮->打开Left Drawer->点击TO-DO list按钮->断言TasksActivity已经打开 -
clickOnAndroidHomeIcon_OpensNavigation
验证通过ActionBar的icon进行关闭和打开Left Drawer
V层:任务模块界面测试——TasksScreenTest
概述:该测试用例针对任务列表和任务详情页的界面功能测试,涵盖所有页面上的交互,包括增删改查任务、改变任务状态,过滤任务列表等,除此之外还验证了横竖屏的交互对界面数据状态的影响。
意义:告诉我们如何设计有价值的功能界面测试用例。
-
clickAddTaskButton_opensAddTaskUi
点击添加按钮->断言相应Activity已经打开 -
addTaskToTasksList
添加标题1的TO-DO任务后回到列表页->断言标题1存在 -
editTask
添加标题1的TO-DO任务后回到列表页->点击此Item进入查看页面->点击编辑按钮->修改成标题2->点击保存->断言标题1不存在和标题2存在 -
markTaskAsComplete
添加任务并点击CheckBox设置为已完成->通过过滤器进入All/Active/Completed视图,断言该任务是否存在 -
markTaskAsActive
测试标记任务为Active状态,手法同上一点 -
showAllTasks
添加2个任务->进入All视图->断言两个任务在界面上存在 -
showActiveTasks
添加2个任务->进入Active视图->断言两个任务在界面上存在 -
showCompletedTasks
添加2个任务->标记为已完成->进入Completed视图->断言两个任务在界面上存在 -
clearCompletedTasks
添加2个任务->标记为已完成->点击Clear completed按钮->断言两个任务不存在 -
createOneTask_deleteTask
添加1个任务->点击该任务进入详情页->点击删除->断言该任务不存在 -
createTwoTasks_deleteOneTask
创建2个任务->删除第2个->断言第1个存在且第2个不存在 -
markTaskAsCompleteOnDetailScreen_taskIsCompleteInList
创建1个任务->点击该任务进入详情页->标记为已完成->回到列表页->断言该任务为选中状态 -
markTaskAsActiveOnDetailScreen_taskIsActiveInList
创建1个任务->在列表页标记为已选中->进入详情页标记为未选中->回到列表页->断言该任务未被选中 -
markTaskAsAcompleteAndActiveOnDetailScreen_taskIsActiveInList
创建1个任务->在详情页触发两次checkbox的点击- 回到列表页->断言该任务未被选中 -
markTaskAsActiveAndCompleteOnDetailScreen_taskIsCompleteInList
创建1个任务->标记为已完成->在详情页触发两次checkbox的点击- 回到列表页->断言该任务被选中 -
orientationChange_FilterActivePersists
创建1个任务->标记为已完成->进入Active视图->验证该任务不存在->切换横竖屏->断言该任务状态与之前一致 -
orientationChange_FilterCompletedPersists
创建1个任务->标记为已完成->进入Completed视图->验证该任务存在->切换横竖屏->断言该任务状态与之前一致
M层:本地数据库操作测试——TasksLocalDataSourceTest
概述:对数据库中处理Task的增删改查、改变Task状态等进行测试。
意义:持久层的CRUD往往需要配合起来测试和断言,此例很好的诠释了这一点
saveTask_retrievesTask
- 测试目的:验证保存Task到数据库的逻辑
- 测试用例:实例化Task对象->保存入库->根据ID获取Task->在回调函数中断言与入库的Task一致
completeTask_retrievedTaskIsComplete
- 测试目的:验证将任务设置成完成状态的逻辑
- 测试用例:Task对象保存入库->触发完成任务的逻辑->根据ID获取Task->在回调函数中断言该Task已完成
activateTask_retrievedTaskIsActive
- 测试目的:验证将任务设置为激活状态的逻辑
- 测试用例:mock一个回调对象callback->Task对象保存入库->触发完成任务的逻辑->触发激活任务的逻辑->根据ID获取Task->断言callback执行了onTaskLoaded的逻辑
clearCompletedTask_taskNotRetrievable
- 测试目的:验证清除所有已完成任务的逻辑
- 测试用例:mock三个回调函数对象,分别是callback1到3->保存任务1,任务2和任务3,其中任务1和任务2为completed状态,任务3为active状态->清理所有已完成的任务->根据3个Task的ID分别获取Task->断言callback1和callback2执行了onDataNotAvailable逻辑- >断言callback3执行onTaskLoaded逻辑
deleteAllTasks_emptyListOfRetrievedTask
- 测试目的:验证删除数据库中所有任务的逻辑
- 测试用例:保存任务->mock一个回调函数callback->删除所有任务->获取任务列表->断言callback执行了onDataNotAvailable的逻辑
getTasks_retrieveSavedTasks
- 测试目的:验证获取数据库中所有任务的逻辑
- 测试用例:保存2个任务->获取任务列表->在回调函数中断言这2个任务存在
三 androidTestMock文件下的测试
在《解读》一文中,笔者提到该文件夹主要的作用是对网络请求进行Fake,即不发出网络请求,而是返回事先定义好的数据。
V层:新增编辑任务界面测试——AddEditTaskScreenTest
errorShownOnEmptyTask
- 测试目的:验证保存或编辑任务时,如果输入空标题,会弹出Snackbar提示不能为空
- 测试用例:打开详情页->输入空标题和空描述->点击保存->通过Snackbar的消息内容验证Snackbar已显示
V层:统计界面测试——StatisticsScreenTest
-
Tasks_ShowsNonEmptyMessage
打开统计界面->事先Fake两条任务数据,状态分别为Completed和Active->断言两种统计栏目都已显示
V层:任务详情界面测试——TaskDetailScreenTest
概述:Fake出不同状态的任务并在详情页进行标题、描述和状态的断言。
意义:指导我们如何对网络请求数据进行Fake。
-
activeTaskDetails_DisplayedInUi
Fake一条状态为Active的任务->打开详情页->断言标题、描述、任务状态 -
completedTaskDetails_DisplayedInUi
Fake一条状态为Complete的任务->打开详情页->断言标题、描述、任务状态 -
orientationChange_menuAndTaskPersist
横竖屏的测试手法与TasksScreenTest
中一致,不再赘述。
四 test文件夹下的测试
P层:新增编辑任务测试——AddEditTaskPresenterTest
概述:进入Presenter层的测试后,我们不再去断言输入输出了,取而代之的是,断言是否正确的覆盖了View层和Model层的逻辑。
AddEditTaskPresenter
共有三个方法,分别是createTask
、updateTask
和populateTask
,对应增加、修改、展示任务的功能,其中增加任务涉及到成功和失败的情况,因此有4个测试用例。
意义:这些Presenter层的测试可以教会我们如何Mock,如何verify,如何测试异步回调,以及如何完整的覆盖Presenter层的所有逻辑路径。
-
saveNewTaskToRepository_showsSuccessMessageUi
创建Presenter,执行创建任务的逻辑->断言Model层执行了保存的逻辑->断言View层执行了显示任务列表的逻辑 -
saveTask_emptyTaskShowsErrorUi
创建Presenter,执行创建任务的逻辑,且任务Title为空->断言View层执行了展示error的逻辑 -
saveExistingTaskToRepository_showsSuccessMessageUi
此用例验证的是update任务的逻辑,测试手法同1。 populateTask_callsRepoAndUpdatesView
- 测试目的:验证详情页展示的任务信息是否正确
- 测试用例:presenter执行populateTask()->断言执行了getTask(),且参数正确->断言回调函数执行了正确的逻辑->断言View层展示的是正确的Task数据
P层:统计功能测试——StatisticsPresenterTest
概述:该类的presenter接口比较简单,只有一个入口方法
start
,执行的是加载统计信息的逻辑,执行过程中涉及几个路径:加载空任务列表,加载非空任务列表和数据不可用,分别对应以下1,2,3点。
-
loadEmptyTasksFromRepository_CallViewToDisplay
断言加载空任务列表 -
loadNonEmptyTasksFromRepository_CallViewToDisplay
断言加载非空任务列表 -
loadStatisticsWhenTasksAreUnavailable_CallErrorToDisplay
断言数据不可用
P层:任务详情功能测试——TaskDetailPresenterTest
概述:该Presenter共有5个方法,分别是:
-
start
:展示任务详情,涉及三种路径:展示Active任务、展示Compeled任务和展示非法ID的任务,对应1,2,3的测试用例 -
deleteTask
:删除任务,对应第4个测试用例 -
completeTask
:完成任务,对于第5个 -
activateTask
:激活任务,对应第6个 -
editTask
:编辑任务,对应第7个,编辑非法ID的任务对应的测试用例为第8个
getActiveTaskFromRepositoryAndLoadIntoView
getCompletedTaskFromRepositoryAndLoadIntoView
getUnknownTaskFromRepositoryAndLoadIntoView
deleteTask
completeTask
activateTask
activeTaskIsShownWhenEditing
invalidTaskIsNotShownWhenEditing
P层:任务列表功能测试——TasksPresenterTest
概述,此TasksPresenter的测试与上一点类似,从接口方法出发,此类共有10个接口方法,为此设计了8个测试用例,分别是展示All/Active/Completed的任务列表、点击打开任务详情页、改变任务状态等。
loadAllTasksFromRepositoryAndLoadIntoView
loadActiveTasksFromRepositoryAndLoadIntoView
loadCompletedTasksFromRepositoryAndLoadIntoView
clickOnFab_ShowsAddTaskUi
clickOnTask_ShowsDetailUi
completeTask_ShowsTaskMarkedComplete
activateTask_ShowsTaskMarkedActive
unavailableTasks_ShowsError
M层:数据操作门面类测试——TasksRepositoryTest
概述:该类的测试用例非常齐全,对于如何设计测试用例让数据过期,如何让数据取自本地或者网络等测试技巧都有极高的学习价值。
getTasks_repositoryCachesAfterFirstApiCall
getTasks_requestsAllTasksFromLocalDataSource
saveTask_savesTaskToServiceAPI
completeTask_completesTaskToServiceAPIUpdatesCache
completeTaskId_completesTaskToServiceAPIUpdatesCache
activateTask_activatesTaskToServiceAPIUpdatesCache
activateTaskId_activatesTaskToServiceAPIUpdatesCache
getTask_requestsSingleTaskFromLocalDataSource
deleteCompletedTasks_deleteCompletedTasksToServiceAPIUpdatesCache
deleteAllTasks_deleteTasksToServiceAPIUpdatesCache
deleteTask_deleteTaskToServiceAPIRemovedFromCache
getTasksWithDirtyCache_tasksAreRetrievedFromRemote
getTasksWithLocalDataSourceUnavailable_tasksAreRetrievedFromRemote
getTasksWithBothDataSourcesUnavailable_firesOnDataUnavailable
getTaskWithBothDataSourcesUnavailable_firesOnDataUnavailable
getTasks_refreshesLocalDataSource
网友评论
我最近也在纠结这一点。看官方的todo-mvp的时候,里面的TaskPresenterTest中,
ArgumentCaptor<List> showTasksArgumentCaptor = ArgumentCaptor.forClass(List.class);
verify(mTasksView).showTasks(showTasksArgumentCaptor.capture());
assertTrue(showTasksArgumentCaptor.getValue().size() == 3);
这里是有涉及到断言的。
这要怎么理解呢?
我改成“这一层我们尽量不做输入输出的断言,而是验证是否正确覆盖V层和M层的逻辑。”,会更准确点。
Android TDD 的先驱?
我给 82 分,剩下的分数怎么给,我想,你懂得!