[Android, Kotlin] android에서 Junit으로 테스트 코드 작성하기

 

이번에 정리할 내용은 테스트 코드이다.

다들 테스트 코드라는 말을 들어본 적은 있어도 사용법을 몰라서 사용하지 않았던 경우도 있었을 것이고,

장점에 대해서는 들었지만 확 와닿지 않았기 때문에 사용하지 않았을 수도 있을 것이다.

필자의 경우에는 2가지 모두 해당사항이었다 ㅎㅎ

 

하지만 이번에 친구들이랑 하는 대형 프로젝트에서 파트별 개발을 하던 중 내가 코드를 잘 작성하고 있는 걸까?라는 의문이 들어 테스트 코드에 대해 공부하고 이번 기회에 포스팅으로 남겨볼까 한다.

 

그러면 바로 테스트 코드에 대해 간단히 알아보고 코드 예제로 같이 확인해 보도록 하자.

 

1. 테스트 코드를 작성하는 이유?

테스트 코드는 안드로이드 앱을 개발하면서 특정 로직을 테스트하면서 기능의 문제나 오류를 찾아내 주는 코드를 뜻한다.

테스트 코드를 작성하지 않았던 사람들은 테스트를 이렇게 진행했을 것이다.

1. 앱 실행
2. 오류 발생
3. 로그를 찍어 오류 파악
4. 다시 수정 후 앱 실행

이 과정을 반복하면서 오류를 해결했을 것이다.

작은 프로젝트를 하고 있다면 크게 상관없는 부분이지만, 규모가 큰 프로젝트를 하면 앱의 build 시간도 오래 걸리고 ui 작업을 수행하는 시간도 있기에 테스트하기가 점점 어려워질 것이다.

따라서 전체 앱을 일일이 빌드하는 작업은 비효율적인 작업이 될 것이다.

 

이 문제를 테스트 코드를 작성해 해결해 줄 수 있다.

테스트 코드로 특정 부분의 코드를 개발자가 의도한 대로 작동하는지 확인이 가능하기에 효율적으로 작업을 할 수 있게 된다.

 

테스트 코드의 종류는 2가지가 있으며, unit test와 ui test이다.

unit test는 간단히 말해서 로직을 테스트 하는 코드이고, ui test는 ui의 동작을 테스트 할 수 있다.

 

이제 테스트 코드가 필요한 이유를 알았으니 코드를 통해 테스트 코드를 작성하는 방법에 대해 알아보자.

필자는 unit test 코드 작성 코드만 다루겠다. ui test에 관한 내용은 추후에 다루도록 하겠다.

 

2. unit test 코드 작성

안드로이드 프로젝트에서 unit test를 작성하기 위해서는 안드로이드 프로젝트의 기본으로 생성되는 app 모듈 안에 패키지가 3개 있을 건데, 그중에 test라고 적힌 패키지 안에 파일을 작성해 주면 된다.

test 패키지 안에 ExampleUnitTest라는 샘플 코드가 있을 것이다.

원래는 각각 코드 파트마다 테스트 코드 파일을 만들어 주어야 하는데 필자는 테스트 코드 연습을 하고 있기 때문에 ExampleUnitTest 파일 안에서 작업해 주도록 하겠다.

 

기본적인 ExampleUnitTest.kt은 파일을 생성하면 다음과 같이 기본적인 테스트 코드가 생긴다.

class ExampleUnitTest {
    @Test
    fun addition_isCorrect() {
        assertEquals(4, 2 + 2)
    }
}

addition_isCorrect 함수에 Test 어노테이션을 달아서 테스트 함수를 만들 수 있다.

그리고 assertEquals()를 통해 4와 2+2가 같은지 확인하는 테스트 코드라는 것을 알 수 있다.

assertEquals() 함수는 junit 라이브러리를 추가하면 사용할 수 있는데, 처음에 안드로이드 프로젝트를 생성하면 자동으로 추가되니까 따로 라이브러리를 찾아서 추가해줄 필요는 없다.

 

추가되는 junit 라이브러리는 다음과 같다.

testImplementation("junit:junit:4.13.2")
androidTestImplementation("androidx.test.ext:junit:1.1.5")

 

junit 라이브러리에서 사용 가능한 assert 함수들에 대해 자세히 알아보자.

assert 함수들을 사용해서 테스트 성공 실패 여부를 판단할 수 있다.

assert를 작성하면 다양하게 assert 함수들이 나오는데 그것들을 상황에 맞게 사용하면 될 듯하다.(state가 true일 때가 성공이면 assertTrue()를, api에서 받아온 response body가 null이 아닐 때가 성공이라면 assertNotNull()을 사용하면 된다.)

다양한 assert 함수들

 

이제 test function을 만드는 방법과 assert 함수들이 테스트 성공, 실패 여부를 판단한다는 것을 알았기 때문에 바로 필자가 작성했던 예제 테스트 코드를 확인해보자.

필자는 api 호출이 정상적으로 완료되었는지 확인하는 테스트 코드를 작성하였다.

private var exchangeRateApi: ExchangeRateApi? = null

@Before
fun setUp() {
    val okhttp = OkHttpClient.Builder()
        .build()

    val retrofit = Retrofit.Builder()
        .baseUrl(BuildConfig.BASE_URL)
        .client(okhttp)
        .addConverterFactory(GsonConverterFactory.create())
        .build()

    exchangeRateApi = retrofit.create(ExchangeRateApi::class.java)
}

@Test
fun getExchangeRateListApiTest() {
    val call = exchangeRateApi?.getExchangeRate(type = "usd", date = "2023-09-08")?.execute()

    assertTrue(call!!.isSuccessful)
    assertNotNull(call.body())
}

코드를 보면 처음 보는 어노테이션이 있는데 @Before 어노테이션이다.

@Before 어노테이션은 테스트를 수행하기 전에 실행되어야 할 동작을 작성하는 부분에 사용할 수 있다.(변수 초기화 같은 과정)

또한 위의 코드에서 언급되지는 않았지만 @After라는 어노테이션도 있는데, after 어노테이션은 테스트를 수행하고 난 후에 실행돼야 할 로직들을 작성하는 함수에 추가하면 된다.

 

필자의 경우에는 after 어노테이션이 필요하지 않아서 사용하지 않았고, before 어노테이션이 사용된 함수 안에서 retrofit service 변수를 초기화해주는 작업을 했다.

 

마지막으로 @Test 어노테이션 함수 내부를 보면, call 변수에 api를 호출하였다.

그다음 call이 성공하였는지, call의 body가 null이 아닌지 확인하는 assert 함수를 작성해 주었다.

 

이게 끝이다. 생각보다 간단하지 않은가?

 

정리

---

 

• 이번에 대형 프로젝트에 참여하면서 테스트 코드의 필요성을 느껴 테스트 코드를 작성해 보았는데 공부하고 나니까 훨씬 타 블로그에 언급되었던 장점들이 확 와닿는 느낌이 들었다.
• 테스트 코드 라이브러리인 junit에서 테스트 결과를 바로 알 수 있게 해 주었기에 생각보다 공부하는데 오랜 시간이 걸리지 않았던 것 같다.(처음에는 개발자가 직접 에러가 발생 시 에러를 thorw 하는 코드도 같이 작성하는 걸로 알고 있었다;;)
• 이번에 테스트 코드를 공부하면서 기본적인 것만 알아보았는데 나중에는 ui test와 junit 말고도 다른 테스트 코드 라이브러리인 Mockito도 공부해보려고 한다.

잘못된 부분이나 다른 유용한 지식을 가지고 계신 분들의 피드백 댓글은 적극 환영입니다!

 

참고한 글

https://yoon-dailylife.tistory.com/114

Android) 테스트 코드 왜 작성 해야 할까? 예제로 알아보자

https://youngest-programming.tistory.com/492

[안드로이드] Android UnitTest 정리