[Android] Espresso를 활용한 UI Test

💡 우아한테크코스 과정을 진행하면서 배웠던 UI 테스트에 대하여 다시 한번 돌아보고 학습하는 시간을 가졌습니다 !

 

UI 테스트

• 사용자와 앱 간에 인터페이스가 올바르게 작동하는지 확인하려면 UI 테스트를 진행하는 것이 좋습니다.
• UI 테스트를 작성하면 복잡한 UI 로직이나 기존에 개발되어 있는 인터페이스를 보장합니다.

테스트 코드의 필요성

• 테스트 코드를 작성하면 장애에 관한 신속한 피드백이 가능합니다.
• 개발 주기에서 초기 장애를 감지하고, 더 안전한 코드 리팩터링을 제공합니다.
• 또한 기술적 문제를 최소화하기 때문에 안정적인 개발 속도를 얻을 수 있습니다.

계측 테스트(Instrumentation Test)

• 앱의 실제 디바이스 또는 애뮬레이터에서 동작하는 테스트를 실행하는 데 사용됩니다.
• 애뮬레이터를 켜고 앱을 빌드하여 실행하고 조작하여 결과를 확인하는 방법으로 UI 테스트를 진행할 수 있습니다.
• 하지만 이런 과정은 확인해야 할 사항이 많거나, 번거로울 경우 테스트에 소모되는 시간이 크게 증가합니다.
• 이를 해결하기 위해 UI 테스트를 위한 테스트 코드를 작성할 수 있습니다.

Espresso

• Espresso는 간결하고 신뢰할 수 있는 Android Ui Test를 작성할 수 있는 프레임워크 입니다.
• UI 상호작용을 실행할 때 작업을 동기화된 상태로 유지해 주며, 백그라운드 작업이 존재하는 경우 그 작업이 완료 된 뒤에 테스트를 진행합니다.
• 안정적인 환경에서 UI Test를 할 수 있도록 도와주는 프레임워크입니다.

주요 특징

• 간결하고 직관적인 API를 제공
  • UI 요소와 상호작용하거나 요소 상태를 검증하는 코드를 쉽게 작성할 수 있습니다.
• 동기화 지원
  • Espresso는 애플리케이션의 메인 쓰레드와 자동으로 동기화되어, UI 테스트 중 애플리케이션의 상태가 안정적일 때까지 기다린 후 테스트를 실행합니다.
  • 이를 통해 신뢰성 있는 테스트를 보장합니다.
• 풍부한 Matcher, ViewAction 제공
  • 다양한 Matcher와 View Actions을 제공하여 특정 뷰를 찾거나 뷰에서 동작을 수행할 수 있습니다.
  • onView(withId(R.id.button))와 같이 뷰를 찾고, perform(click())으로 클릭 액션을 수행할 수 있습니다.
• 테스트 코드의 가독성 증가
  • 자연어에 가까운 구문으로 테스트의 의도를 명확히 표현할 수 있습니다.
• 확장성
  • 커스텀 Matcher, ViewAction, IdlingResource 등을 작성하여 Espresso의 기능을 확장할 수 있습니다.

Espresso 준비하기

• Espresso를 사용하기 위해서는 Gradle에 선언해야 합니다.

testImplementation 'junit:junit:4.13.2'
androidTestImplementation 'androidx.test.ext:junit:1.1.5'
androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'

• multiModule 구조라면 UI Test를 진행 할 모듈에 해당 종속 항목을 선언해야 합니다.
• 이 때 주의할 점은 androidx로만 선언해야 하며, 그렇지 않을 경우 build 과정에서 제대로 된 context를 가져오지 못하는 에러가 발생합니다.

onView

• onView는 테스트 대상 UI 요소를 찾는 데 사용되는 함수입니다.
• onView(withId(R.id.text_view))와 같은 형식으로 사용됩니다.
• [withId] : UI 요소를 찾는 데 사용되는 매칭 조건으로 사용할 수 있습니다.

check

• check는 테스트 대상 UI 요소에 대한 검증을 수행하는 데 사용하는 함수입니다.
• check(matches(withText(”Hello World!”)))와 같은 방식으로 사용합니다.
• [matches] : 기대하는 값과 실제 값을 비교하는데 사용되는 매칭 조건입니다.
• [withText] : UI 요소의 텍스트를 비교하는데 사용되는 매칭 조건입니다.

다양한 View Test

EditText 입력하기

• EditText View에 입력값을 넣어줄 수 있습니다.

onView(withId(R.id.edit_text))
    .check(matches(isDisplayed()))
    .perform(typeText("입력 값입니다"))

allOf 활용

• allOf를 활용하여 보다 정확하게 View를 찾을 수 있습니다.

onView(allOf(withId(R.id.text_view), withText("찾는 텍스트")))

View 스크롤 적용

• 아래와 같이 사용자가 뷰를 스크롤 했을 때 동작을 제시할 수 있습니다.

// when: 사용자의 스크롤 동작 수행
onView(withId(R.id.scroll_view))
    .perform(swipeUp())

 // then: 화면에 버튼 표시
onView(withId(R.id.button))
    .check(matches(isDisplayed()))

Assertion

• 조건에 맞는 View를 찾았다면, matches를 통해서 검증과 확인을 할 수 있습니다.

onView(withId(R.id.text_view))
    .check(matches(withText("찾는 텍스트")))

애니메이션으로 테스트가 원할하지 않는 경우

• View에 애니메이션이 적용되어 있는 경우 애니메이션으로 인해 테스트가 실패하는 경우가 발생할 수 있습니다.
• 단독 테스트 시 Pass 되지만 여러 개의 테스트를 진행하면 Fail이 발생하는 경우가 생기는데, 아래와 같은 방법으로 대체할 수 있습니다.

android {
    testOptions {
        animationsDisabled = true
    }
}

테스트 진행

• 이전에 배운 Junit4 학습을 참고하여 실습을 진행하였습니다.
• https://jinudmjournal.tistory.com/189

[Android] AndroidJUnit4

import androidx.test.espresso.Espresso.onView
import androidx.test.espresso.action.ViewActions.*
import androidx.test.espresso.assertion.ViewAssertions.matches
import androidx.test.espresso.matcher.ViewMatchers.*
import androidx.test.ext.junit.rules.ActivityScenarioRule
import androidx.test.ext.junit.runners.AndroidJUnit4
import org.junit.Rule
import org.junit.Test
import org.junit.runner.RunWith

@RunWith(AndroidJUnit4::class)
class LoginActivityTest {

    @get:Rule
    val activityRule = ActivityScenarioRule(LoginActivity::class.java)

    @Test
    fun testLoginSuccess() {
        // 사용자 이름과 비밀번호를 입력
        onView(withId(R.id.username)).perform(typeText("admin"), closeSoftKeyboard())
        onView(withId(R.id.password)).perform(typeText("1234"), closeSoftKeyboard())

        // 로그인 버튼 클릭
        onView(withId(R.id.login_button)).perform(click())

        // 결과 텍스트 확인
        onView(withId(R.id.result_text)).check(matches(withText("Login Success")))
    }

    @Test
    fun testLoginFailed() {
        // 사용자 이름과 비밀번호를 입력
        onView(withId(R.id.username)).perform(typeText("user"), closeSoftKeyboard())
        onView(withId(R.id.password)).perform(typeText("wrongpassword"), closeSoftKeyboard())

        // 로그인 버튼 클릭
        onView(withId(R.id.login_button)).perform(click())

        // 결과 텍스트 확인
        onView(withId(R.id.result_text)).check(matches(withText("Login Failed")))
    }
}

정리

• Espresso는 간단하면서 강력한 UI 테스트 프레임워크로, 다양한 UI 상호작용과 상태를 검증할 수 있습니다.
• 간단한 Test를 검증하였는데, 더 복잡한 시나리오(리스트, 리사이클러뷰 등)에 대한 테스트도 가능하며 다음 학습에서 진행해보려고 합니다 !
• Espresso 요약본으로 한눈에 Espresso 관련 로직을 확인할 수 있습니다.
• https://developer.android.com/training/testing/espresso/cheat-sheet?hl=ko

참고

https://arc.net/l/quote/gvricusx

https://dev.to/wise4rmgod/unit-testing-using-robolectric-in-android-studio-2ibl

https://developer.android.com/training/testing/espresso?hl=ko