[Android] MockWebServer

💡우아한테크코스 과정에서 학습한 MockWebServer에 대하여 기록하였습니다.

 

MockWebServer

• MockWebServer는 네트워크 통신을 테스트할 때 가짜 서버를 만들어 HTTP 요청을 처리하고, 미리 정의된 응답을 반환하는 테스트 도구입니다.
• 이 라이브러리는 OkHttp에서 제공하며 Retrofit, OkHttp 등의 네트워크 라이브러리와 함께 단위 테스트를 작성할 때 유용하게 사용됩니다.

https://github.com/square/okhttp/tree/master/mockwebserver

okhttp/mockwebserver at master · square/okhttp

주요 기능

• 가짜 서버 환경 제공
  • 실제 서버 없이도 네트워크 요청에 대해 미리 정의된 응답을 반환하는 서버 환경을 제공합니다.
• 네트워크 요청 검증
  • 테스트 중에 발생한 요청 내용을 확인할 수 있습니다.
• 다양한 응답 시뮬레이션
  • HTTP 응답 코드를 설정하거나, 응답 지연을 시뮬레이션하는 등 다양한 네트워크 상황을 테스트할 수 있습니다.

Gradle

• MockWebServer를 프로젝트에 추가합니다.

dependencies {
    testImplementation 'com.squareup.okhttp3:mockwebserver:4.9.3'
}

MockWebServer 구현

• 우아한테크코스 활동 중에 MockWebServer를 활용한 Service를 구현하였습니다.
• 컴포넌트 Service가 아닌, CRUD를 정의하기 위한 인터페이스를 Service로 네이밍을 작성하였습니다.
• 이를 통해 Retrofit의 인터페이스 기반 네트워크 요청을 테스트 환경으로 구축할 수 있습니다.

interface ProductService {
    fun findAll(): List<Product>

    fun findProductById(productId: Long): Product?

    fun findPagingProducts(
        offset: Int,
        pagingSize: Int,
    ): List<Product>
}

응답 정의

• MockResponse를 활용해서 응답 코드와 응답 데이터를 설정할 수 있습니다.
• setResponseCode(200)으로 HTTP 상태 코드를, setBody()로 응답 본문을 설정합니다.

private fun openServer(
    server: MockWebServer,
    body: String,
) {
    server.enqueue(MockResponse().setBody(body).setResponseCode(200))
}

MockProductService

• MockProductService는 ProductService를 MockWebServer로 구현한 가상 환경입니다.
• Request를 생성해서 Response를 받고, Gson 형식으로 반환하는 코드를 작성하였습니다.
• findPagingProducts()는 현재 데이터 위치와 총 페이지 사이즈를 받아서 데이터를 반환하는 함수입니다.
• ProductDatabase에 있는 데이터를 Retofit 기반으로 요청하는 작업을 테스트할 수 있었습니다.

class MockProductService : ProductService {
    private val client = OkHttpClient()

    override fun findPagingProducts(
        offset: Int,
        pagingSize: Int,
    ): List<Product> {
        val pagingData =
            if (offset >= ProductDatabase.products.size) {
                emptyList()
            } else {
                ProductDatabase.products.drop(offset)
            }.take(pagingSize)
        val body = Gson().toJson(pagingData)
        val serverRequest = makeServerRequest(body, "?offset=$offset&pagingSize=$pagingSize")
        val response: Response = client.newCall(serverRequest).execute()
        val responseBody = response.body?.string() ?: return emptyList()
        val productType = object : TypeToken<List<Product>>() {}.type
        return Gson().fromJson(responseBody, productType)
    }

    private fun makeServerRequest(
        body: String,
        requestUrl: String,
    ): Request {
        val server = MockWebServer()
        openServer(server, body)
        return Request.Builder()
            .url(makeServerUrl(server, requestUrl))
            .build()
    }

    private fun openServer(
        server: MockWebServer,
        body: String,
    ) {
        server.enqueue(MockResponse().setBody(body).setResponseCode(200))
    }

    private fun makeServerUrl(
        server: MockWebServer,
        requestUrl: String,
    ): String {
        val serverUrl = server.url(MOCK_SERVER_PATH).toString()
        return "${serverUrl}$requestUrl"
    }

    private fun makeResponse(serverRequest: Request): Response {
        return client.newCall(serverRequest).execute()
    }

    companion object {
        private const val DEFAULT_URL = ""
        private const val MOCK_SERVER_PATH = "/products"
    }
}

Retrofit 기반 네트워크 요청

• 실제로는 테스트 환경에서 사용되지만, 요청에 대한 Retrofit 기반 응답을 받기 위해 구현하였습니다.

class ProductRepositoryImpl : ProductRepository {
    private val mockProductService: ProductService = MockProductService()

    override fun loadPagingProducts(offset: Int): List<Product> {
        var pagingData: List<Product> = listOf()
        thread {
            pagingData = mockProductService.findPagingProducts(offset, PRODUCT_LOAD_PAGING_SIZE)
        }.join()
        if (pagingData.isEmpty()) throw NoSuchDataException()
        return pagingData
    }
}

정리

• MockWebServer는 안드로이드에서 네트워크 통신 테스트를 위한 매우 유용한 도구입니다.
• 실제 서버 없이도 네트워크 요청을 처리하고, 다양한 응답 시나리오를 테스트할 수 있습니다.
• 이를 통해 Retrofit, OkHttp와 같은 네트워크 라이브러리의 테스트를 더욱 쉽게 수행할 수 있습니다.