Android Unit Test 入门

这篇文章主要是讲述一些unit test基本类库中的基本方法，实践下来发现只要掌握这些基本的API，大部分的测试用例都是可以实现的，万变不离其宗。

我们新建项目会自动生成这两个测试目录，androidTest和test，这两个目录的主要区别在于其一个需要连接真机/虚拟机去测试，另一个只需要运行在JVM之上，即使一个空的case放在androidTest也会触发真机运行。另一个区别是相关的库互不相通，test package下不能使用androidTestImplementation引用的库，同样androidTest也不能使用testImplementation引用的库。

Junit

测试基本库，提供了常用的注解和方法。androidTest默认包含该库，不用单独再引用。

testImplementation 'junit:junit:4.12'

• @Test：标记某个方法为测试方法。可以传参数timeout=xx，如果测试方法超过这个数值即为失败。
• @Before: 类中每个case执行前先执行该方法。
• @After: 类中每个case执行后都执行该方法。
• @BeforeClass: 每个测试类执行之前先跑一次
• @AfterClass: 每个测试类所有case执行完跑一次
• Assert相关方法，assertFalse/assertTrue/assertEquals等，也可以直接用kotlin的assert(boolen)方法，不过相比Assert类中的方法failed时不能提供有效的日志信息，所以还是推荐是用Assert类中的方法。

MockK

模拟隔离框架。现在Android开发已经逐渐切换到kotlin，使用之前的mock库例如mockito会碰到一些问题，比如被mock的类要求是非final的，而kotlin的类除非显示声明为open不然默认都是final，比如object/companion/扩展函数/顶层函数的mock。
mockK库的专为kotlin语言，完全包含之前常用的mocktio和powermock的功能。

testImplementation 'io.mockk:mockk:1.9'

• mock
  获取模拟对象，mock的对象主要目的是要模拟该对象的方法，通常和下面要说的every配合使用，如果最终想要模拟的方法时static方法，可以调用mockkStatic()/mockObject()。
  假设有个Student类和一个Library类，我们想要mock学生从图书馆借书的动作，则需要先mock一个图书馆类。

val library = mockk<Library>()

所有mock对象的方法的调用都必须通过every方法提前定义好。

• every
  相当于mocktio中的when(). thenReturn()方法，every { } returns 方法体中添加某个对象的方法，当在测试代码中执行到该方法时并不会真的去执行，而是直接返回returns之后的对象。也可以不加returns而使用every { } just Runs跳过执行。
  我们完善一下上面的例子

class Student(val library: Library) {
   val books = mutableListOf<Book>()
    fun borrowBook() {
          val book = library.borrowBook()
          books.add(book)
    }
}

@Test
fun testStudentBorrowBook() {
     val library = mockk<Library>()
     val student = new Student(libaray)
     
     //需要通过图书馆借书时直接返回一本书
     every {libaray.borrowBook() } returns Book("book name")

     student.borrowBook()
     assertEquals(student.books.list[0].getName(), "book name")
}

如果every里面的方法是suspend方法，需要用coEvery{}去mock.

• Annotation
  也可以通过注解的方式去mock对象，但是需要在before里手动调用下MockKAnnotations.init(this)

class Test {
    @MockK
    lateinit var fragment: TestFragment
    
    @Before
    fun setup() {
        MockKAnnotations.init(this)
    }
}

• verify
  想要验证某个对象的某个方法是否被执行了，可以使用此方法。比如学生要借书时需要刷卡，则可以通过verify方法验证学生有没有刷过卡。

class Student(val library: Library) {
   val books = mutableListOf<Book>()
   val bookCard = BookCard()

    fun borrowBook() {
          library.swipeCard(bookCard)
          val book = library.borrowBook()
          books.add(book)
    }
}

@Test
fun testStudentBorrowBook() {
     val library = mockk<Library>()
     val student = new Student(libaray)
     
     //需要通过图书馆借书时直接返回一本书
     every {libaray.borrowBook() } returns Book("book name")
     every {library.swipeCard(student.bookCard) } just Runs

     student.borrowBook()
     verify {library.swipeCard(student.bookCard) }
}

Robolectric

如果我们想测试一些Android特性的东西，如启动application，获取UI信息等，但是又不想连接设备去测试，这时候就需要Robolectric了。

testImplementation 'org.robolectric:robolectric:4.3.1'

android {
  testOptions {
     unitTests.includeAndroidResources = true
  }
}

下面是一个简单的测试示例

@RunWith(RobolectricTestRunner::class)
@Config(sdk = [Build.VERSION_CODES.P], application = TestApplication::class)
class ExampleUnitTest {
    @Test
    fun testActivity() {
        val activity = Robolectric.buildActivity(MainActivity::class.java).create().start().resume().get()
        val textView = activity.findViewById<TextView>(R.id.main_hello_text_view)
        assertEquals(textView.text, "Hello World!")
    }
}

启动某个activity会先启动Application，正常项目里Application会有很多初始化动作，通常我们为了方便可以在config指定一个TestApplication，config里还可以指定其他一些配置，比如manifest。

• buildActivity
  启动Activity的方法。Robolectric.buildActivity(MainActivity::class.java)该方法会返回ActivityController对象，通过该对象可以方便的控制Activity的生命周期。

• shadowOf()
  每个shadow对象都可以认为是对应控件的测试方法库。
  方法里面可以传入很多常用的控件类型返回相应的shadow对象，比如Application，Activity，ListView，AlertDialog，Theme等。
  比如Activity和ListView提供了以下的方法

@RunWith(RobolectricTestRunner::class)
@Config(sdk = [Build.VERSION_CODES.P], application = TestApplication::class)
class ExampleUnitTest {
    @Test
    fun testActivity() {
        val activity = Robolectric.buildActivity(MainActivity::class.java).create().start().resume().get()
        val textView = activity.findViewById<TextView>(R.id.main_hello_text_view)
        assertEquals(textView.text, "Hello World!")


        val activityShadow = shadowOf(activity)
        //可以动态授权
        activityShadow.grantPermissions(Manifest.permission.READ_SMS)
        //假设点击后会跳转到SecondActivity
        textView.performClick()

        val nextActivityName = activityShadow.nextStartedActivity.component?.className
        //验证点击后跳转的activity是否正确
        assertEquals(nextActivityName, SecondActivity::class.java.simpleName)
    }
}

    @Test
    fun testListView()  {
        val activity = Robolectric.buildActivity(MainActivity::class.java).create().start().resume().get()
        val listView = activity.findViewById<ListView>(R.id.main_hello_text_view)

        val listViewShadow = shadowOf(listView)
        //需要先调populateItems才能正确绘制listView
        listViewShadow.populateItems()
        //点击第一个item
        listViewShadow.clickFirstItemContainingText("First")
    }

具体使用的时候可以查看shadow对象源码了解其提供了哪些方法。

• fragment test
  Robolectric提供了buildFragment(class)的方法
  但是如果我们使用的是androidx的fragment是没办法使用该方法直接创建 fragment的，这时如果我们想简单的启动一个fragment需要另外引入一个支持库

debugImplementation 'androidx.fragment:fragment-testing:1.2.3'
testImplementation "androidx.test:core:1.2.0" 

该库提供了直接启动fragment和activity的方法

//fragment会放入一个emptyActivity之中，并且直接到onResume状态。
val fragment = launchFragment<TestFragment>(themeResId = R.style.AppTheme, factory = FragmentFactory())

//启动一个activity，并且直接到onResume状态
val activityScenario = ActivityScenario.launch(MainActivity::class.java)
activityScenario.onActivity { activity ->

}

这种启动方式的缺点是状态无法控制，直接到resume，如果onCreate等生命周期中有需要mock的对象则难以控制。如果想较为灵活的控制就可以通过Android的API去加载fragment

    @Test
    fun testFragment() {
        val activityController = Robolectric.buildActivity(MainActivity::class.java).create()
        val fragment = TestFragment()
        activityController.get().supportFragmentManager.beginTransaction().add(R.id.fragment_container, fragment).commit()
        
        activityController.start().resume()
    }

Espresso

设备化测试库，可以方便的进行UI操作

• onView
  可以通过id或者文本内容找到相应的view

onView(withId(R.id.bottom)).perform(click())
onView(withText("next")).perform(click())

• perform
  可以模拟各种用户操作，点击、长按、输入文本、滑动等

//输入文本
onView(withId(R.id.bottom)).perform(typeText("Steve"))
//下滑操作
onView(withText("next")).perform(swipeDown())

最后

欢迎点赞或者斧正。