tutorials/Android-Tutorial-Test-ShowCase
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

network description

Browse source
This commit is contained in:
Gergely Hegedus 2021-05-27 12:25:46 +03:00
parent 978b1f6575
commit 392ebc5115
6 changed files with 466 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

292
codekata/networking.instructionset
View file

@ -1 +1,291 @@
TODO
# Starting of networking testing
In this testing instruction set you will learn how to write simple tests with retrofit.
Every system under test will be injected to ensure the
Every test will use a mocked response and verify the requests sent out.
We will also verify how oauth token refreshing can be tested.
I would suggest to open this document in your browser, while working in Android Studio.
## Simple network test
Our system under test will be `org.fnives.test.showcase.network.auth.LoginRemoteSourceImpl` But we will only test the login method. The refresh method is part of sesssion handling, that's why it is internal.
So the login method sends out a retrofit request and parses a response for us, this is what we intend to test.
Let's setup our testClass: CodeKataLoginRemoteSourceTest
### Setup
First since we are using Koin as Service Locator, we should extend KoinTest, thus giving us an easier way to access koin.
```kotlin
class CodeKataLoginRemoteSourceTest : KoinTest {
}
```
Next we need to inject our system under test and setup koin. However we also need to tearDown our setup after every test:
```kotlin
private val sut by inject<LoginRemoteSource>()
private lateinit var mockWebServer : MockWebServer
@BeforeEach
fun setUp() {
mockWebServer = MockWebServer()
mockWebServer.start()
val mockNetworkSessionLocalStorage = mock<NetworkSessionLocalStorage>()
startKoin {
modules(
createNetworkModules(
baseUrl = BaseUrl(mockWebServer.url("mockserver/").toString()),
enableLogging = true,
networkSessionExpirationListenerProvider = mock(),
networkSessionLocalStorageProvider = { mockNetworkSessionLocalStorage }
).toList()
)
}
}
@AfterEach
fun tearDown() {
mockWebServer.shutdown()
stopKoin()
}
```
We use mockwebserver's rul as baseUrl thus every retrofit request we will send out the mockwebserver will capture.
We also need to stop mockwebserver after every test so it doesn't have state sharing between tests.
Koin also needs to be stopped so our LoginRemoteSource is injected every time.
With this setup we are ready to start testing
### 1. `successResponseParsedProperly`
Notice we are starting with `runBlocking` instead of `runBlockingTest`. That's because okhttp / retrofit can have still not finished coroutines which would fail our runBlockingTest.
First we need to setup mockwebserver to respond to our request and the expected value:
```kotlin
mockWebServer.enqueue(MockResponse().setResponseCode(200).setBody(readResourceFile("success_response_login.json")))
val expected = LoginStatusResponses.Success(Session(accessToken = "login-access", refreshToken = "login-refresh"))
```
As you can see we can set the responseCode of the request and a body. here we use a helper function which goes to the resources folder and reads the content of the file.
Usually you will need to create your own files out of the expected responses so please check where the file is located.
Next we declared the expected value, the accessToken and refreshToken come from the ResponseBody (aka the file), this is where it should be parsed from.
We then declare the action
```kotlin
val actual = sut.login(LoginCredentials("a", "b"))
```
And verification
```kotlin
Assertions.assertEquals(expected, actual)
```
Now running this tet you should see logs by OkHttpLoggingInterceptor and see what request was sent out and received.
### 2. `requestProperlySetup`
So far we verified how to parse a response, but what about the validity of the request. This is what we will test next:
First we setup the mockwebserver:
```kotlin
mockWebServer.enqueue(MockResponse().setResponseCode(200).setBody(readResourceFile("success_response_login.json")))
```
Next we call the method, and get the requestData from mockwebserver:
```kotlin
val actual = sut.login(LoginCredentials("a", "b"))
val request = mockWebServer.takeRequest()
```
Now that we have the requestData we can do verifications on it.
In this case we need to verify the method, headers, path, requestBody:
```kotlin
Assertions.assertEquals("POST", request.method)
Assertions.assertEquals("Android", request.getHeader("Platform"))
Assertions.assertEquals(null, request.getHeader("Authorization"))
Assertions.assertEquals("/mockserver/login", request.path)
val loginRequest = """
{
"username": "a",
"password": "b"
}
""".trimIndent()
JSONAssert.assertEquals(loginRequest, request.body.readUtf8(), JSONCompareMode.NON_EXTENSIBLE) // Since the responseBody is json we use a library that can compare json properly
```
With this we can be sure our request contains exactly what we want it to contain.
### 3. `badRequestMeansInvalidCredentials`
Now we take a look at an expected error test:
First we setup or mockwebserver to return 400. This should mean our credentials were invalid.
```kotlin
mockWebServer.enqueue(MockResponse().setResponseCode(400).setBody(""))
val expected = LoginStatusResponses.InvalidCredentials
```
Next we get the actual value and verify it:
```kotlin
val actual = sut.login(LoginCredentials("a", "b"))
Assertions.assertEquals(expected, actual)
```
Notice we expected this error so no exception is thronw.
### 4. `genericErrorMeansNetworkError`
Next let's see if we get an unexpected response code. In such case we actually except a specific exception to be thrown, so it looks like this:
```kotlin
mockWebServer.enqueue(MockResponse().setResponseCode(500).setBody(""))
Assertions.assertThrows(NetworkException::class.java) {
runBlocking { sut.login(LoginCredentials("a", "b")) }
}
```
### 5. `invalidJsonMeansParsingException`
We also need to verify if we get an unexpected json, we handle that case properly:
```kotlin
mockWebServer.enqueue(MockResponse().setResponseCode(200).setBody("[]"))
Assertions.assertThrows(ParsingException::class.java) {
runBlocking { sut.login(LoginCredentials("a", "b")) }
}
```
### 6. `malformedJsonMeansParsingException`
We can also get malformed json from the Backend, we still shouldn't crash:
```kotlin
mockWebServer.enqueue(MockResponse().setResponseCode(200).setBody("{"))
Assertions.assertThrows(ParsingException::class.java) {
runBlocking { sut.login(LoginCredentials("a", "b")) }
}
```
### Conclusion
With these types of responses we should be covered for the generic errors that could happen, but additional tests needs to be adde for every specific HTTP code the client should handle.
## Token Refreshing test
In order to verify ouath token refreshing we need to have a remote source that is session dependent, for this we will use `org.fnives.test.showcase.network.content.ContentRemoteSource`
So what happens with session expiration and token refreshing:
- a request is called that needs authentication
- the server responds with 401 meaning the token is expired
- we need to call refresh token request
- we get a new token and call the request again
- or we get an error and we propagate the error and send a sessionExpiration notice
With that in mind open `CodeKataSessionExpirationTest`
The setup is alreay done since it's equivalent to our LoginRemoteSource tests.
### 1. `successRefreshResultsInRequestRetry`
First we need to setup our mockwebserver with the expected requests:
- 401 content request
- success refresh token response
- success content request with the new token
Also we need to update our `mockNetworkSessionLocalStorage` so it returns a beforeSession and later returns any session that was saved into it.
So together:
```kotlin
mockWebServer.enqueue(MockResponse().setResponseCode(401))
mockWebServer.enqueue(MockResponse().setResponseCode(200).setBody(readResourceFile("success_response_login.json")))
mockWebServer.enqueue(MockResponse().setResponseCode(200).setBody("[]"))
var sessionToReturnByMock: Session? = Session(accessToken = "before-access", refreshToken = "before-refresh") // before session
whenever(mockNetworkSessionLocalStorage.session).doAnswer { sessionToReturnByMock } // whenever requested return the value of sessionToReturnByMock
doAnswer { sessionToReturnByMock = it.arguments[0] as Session? }
.whenever(mockNetworkSessionLocalStorage).session = anyOrNull() // whenever set is called get the argument and save it into the sessionToReturnByMock
```
Now we need to take the action and get the requests to verify:
```kotlin
sut.get()
mockWebServer.takeRequest()
val refreshRequest = mockWebServer.takeRequest()
val retryAfterTokenRefreshRequest = mockWebServer.takeRequest()
```
Next we need to verify
- the refresh request was proper
- the new content request used the updated access token
- no session expiration event was sent and token was saved
```kotlin
Assertions.assertEquals("PUT", refreshRequest.method)
Assertions.assertEquals("/mockserver/login/before-refresh", refreshRequest.path)
Assertions.assertEquals(null, refreshRequest.getHeader("Authorization"))
Assertions.assertEquals("Android", refreshRequest.getHeader("Platform"))
Assertions.assertEquals("", refreshRequest.body.readUtf8())
Assertions.assertEquals("login-access", retryAfterTokenRefreshRequest.getHeader("Authorization"))
verify(mockNetworkSessionLocalStorage, times(1)).session = Session("login-access", "login-refresh")
verifyZeroInteractions(mockNetworkSessionExpirationListener)
```
### 2. `failingRefreshResultsInSessionExpiration`
Now we need to test what if the refresh request fails.
First setup for failuire:
```kotlin
mockWebServer.enqueue(MockResponse().setResponseCode(401))
mockWebServer.enqueue(MockResponse().setResponseCode(400))
whenever(mockNetworkSessionLocalStorage.session).doReturn(Session(accessToken = "before-access", refreshToken = "before-refresh"))
```
Next verify do the action which will throw!
```kotlin
Assertions.assertThrows(NetworkException::class.java) {
runBlocking { sut.get() }
}
```
Lastly verify the session was cleared and session expiration notified:
```kotlin
verify(mockNetworkSessionLocalStorage, times(3)).session
verify(mockNetworkSessionLocalStorage, times(1)).session = null
verifyNoMoreInteractions(mockNetworkSessionLocalStorage)
verify(mockNetworkSessionExpirationListener, times(1)).onSessionExpired()
```
### Conclusion
With these presented tests we can verify:
- our requests send the proper data
- our parsing is proper
- our error handling handles edge cases as well
### Reusability
Now if you wondered around the non-CodeKata Test files, you noticed it uses the mockserver module.
The basic idea with this is that it contains all the response, request jsons and make it easier to setup sepcific scenarios.
This wouldn't make sense if we are only testing networking, however if we want to write instrumentation / feature tests as well, there we also need to mock out the requests.
So this can be a way to do this, but that should be up to you how to handle it.