Droidcon Vienna 2018 - Architecture and Framework for Clean Test Code

The talk, presented by Marc Neureiter from mySugr, focuses on improving test design and software architecture for mobile app development, specifically using mySugr's journey as an example. It highlights the benefits of automation over manual testing, including scalability, speed, and maintainability, using modular and clean architecture to support these goals. The framework "sweetest" is introduced as a tool to simplify unit and integration tests, promoting maintainability, readability, and reusability. Behavior-driven development (BDD) is also discussed as a methodology to enhance testing and improve the development process. Overall, the talk emphasizes how effective testing and architecture contribute to better quality, faster iteration, and long-term project success.

Transcript

1. Marc Neureiter marc.neureiter@mysugr.com make diabetes suck less Architecture and framework for clean test code
2. mission make diabetes suck less mobile app helps managing therapy
4. facts Vienna & San Diego +100 employees 25 people with diabetes part of Roche since June 2017
5. fast right
6. success AGE SPEED
7. testing – why? our journey... beautiful tests that matter testing framework
8. testing by humans
9. testing by robots
10. accuracy
11. lots of data time scenarios
12. dependence
13. immediate feedback
14. refactoring
15. fast
16. scaling
17. robot vs. human pinpoint faults extensive independent immediate refactoring fast scales
18. test automation = design tool (test-driven development)
19. focus
20. testability = modularity
21. code + architecture
22. maintainability
23. design tool focus modularity clean maintainability
24. maintainability + focus = speed test + design = maintainability AGE SPEED
25. creativity
26. our journey
27. UI testing
28. UI integration unit $$$ fast ¢ slow
29. MESS the result test coverage test distribution confidence modularity maintainability
30. MESS LoginVM AuthManager BackendGW LoginVMTest Setup Mock Interact AuthManagerTest Setup Mock Interact Assert LoginIntegrationTest Setup Mock Interact Assert Assert
31. private val httpService = mock<LoginHttpService>() private val authStringGenerator = mock<AuthStringGenerator>() private val resourceProvider = mock<ResourceProvider>() private val navigator = mock<LoginNavigator>() private val eventBus = mock<EventBus>() private lateinit var user: User private lateinit var syncCoordinator: SyncCoordinator private lateinit var sut: LoginViewModel private lateinit var loginService: LoginService private val scheduler = TestSchedulerProvider() MESS
32. @Before fun before() { syncCoordinator = SyncCoordinatorImpl(mutableListOf(), mock<ConnectivityUtil>(), TestSchedulerProvi user = User().apply { emailAddress = EMAIL } loginService = LoginService(mock<ClientInfo>(), syncCoordinator, mock<UserSettings>(), mock<UserPreferences>(), eventBus, httpService, mock<BackendUrlStore>(), authStringGenerator) Tracker.init(mock<TrackerEngine>()) sut = LoginViewModel(scheduler, mock<Logger>(), loginService, resourceProvider).apply { bind(navigator, null, null) userInput.emailAddress = EMAIL userInput.password = PASSWORD } // [...] MESS
33. @Before fun before() { // [...] `when`(authStringGenerator.getAuthStringFromCredential(any() ?: "", any() ?: "")) .thenReturn(AUTH_STRING) `when`(httpService.getUser(any() ?: "", any() ?: "", any() ?: "", any() ?: "", any() ?: "")) .thenReturn(just(UserWrapper().apply { user = this@LoginViewModelIntegrationTest.user })) `when`(httpService.postUserInput(any() ?: "", any() ?: UserInputWrapper(UserInput()), any() ?: "", .thenReturn(just(Response.success(UserWrapper().apply { user = this@LoginViewModelIntegrati `when`(resourceProvider.getString(any() ?: 0)) .thenReturn(RESOURCE_STRING) `when`(resourceProvider.locale) .thenReturn(Locale.GERMAN) } MESS
34. @Test fun whenEmailEntered_thenServiceGatewayIsCalled() { `when`(httpService.probeUser(any() ?: "", any() ?: "", any() ?: "", any() ?: "", any() ?: "", any() .thenReturn(just<Response<Any>?>(Response.success(Any()))) sut.onEmailEntered() verify(httpService).probeUser(any() ?: "", any() ?: "", any() ?: "", any() ?: "", any() ?: "", any( } @Test fun whenEmailEnteredAndNotFound_thenVerificationCodeIsRequested() { `when`(httpService.probeUser(any() ?: "", any() ?: "", any() ?: "", any() ?: "", any() ?: "", any() .thenReturn(just<Response<Any>?>(Response.error(404, LoginServiceTests.emailVerificationEna `when`(httpService.generateVerificationCode(any() ?: "", any() ?: EmailVerificationWrapper(), any() .thenReturn(just(Response.success(null))) sut.onEmailEntered() verify(httpService).generateVerificationCode(any() ?: "", any() ?: EmailVerificationWrapper(), any( } @Test fun whenEmailEnteredAndNotFoundAndVerificationRequestFailed_thenAnErrorMessageIsShown() { `when`(httpService.probeUser(any() ?: "", any() ?: "", any() ?: "", any() ?: "", any() ?: "", any() .thenReturn(just<Response<Any>?>(Response.error(404, LoginServiceTests.emailVerificationEna `when`(httpService.generateVerificationCode(any() ?: "", any() ?: EmailVerificationWrapper(), any() MESS
35. is that…? clean maintainable (self-)documenting answer:
36. AuthManagerSteps Mock Assert LoginVM AuthManager BackendGW LoginVMSteps Setup Mock Interact Assert LoginVMTest Setup Mock Interact Assert LoginIntegrationTest Setup Mock Interact Assert BackendGWSteps Mock Assert Setup Interact AuthManagerTest Setup Mock Interact Assert
37. @Test fun `Enter email address as new user`() { user.exists = false sut.enterEmail() http { verifyProbeUserCalled() verifyGenerateVerificationCodeCalled() } sut.verifyLoginModelStateIs(State.EMAIL_VERIFICATION) } @Test fun `Enter email address as existing user`() { user.exists = true sut { enterEmail() verifyLoginModelStateIs(State.LOGIN) } } @Test fun `Enter email address as existing user fails`() { user.exists = true connectivity.requestsSucceed = false unit test MUCH BETTER
38. fun whenLoggingInOrRegistering() { instance.loginOrRegister(user.email, user.password) } fun whenLoggingOut() { instance.logout() } fun thenLoginOrRegisterIsCalled() { verify(instance).loginOrRegister(user.email, user.password) } fun thenLoginOrRegisterThrows() { assertNotNull(loginOrRegisterThrowable) } step definitions MUCH BETTER
39. @Test fun whenEmailEntered_thenServiceGatewayIsCalled() { `when`(httpService.probeUser(any() ?: "", any() ?: "", any() ?: "", any() ?: "", any() ?: "", any() .thenReturn(just<Response<Any>?>(Response.success(Any()))) sut.onEmailEntered() verify(httpService).probeUser(any() ?: "", any() ?: "", any() ?: "", any() ?: "", any() ?: "", any( } @Test fun whenEmailEnteredAndNotFound_thenVerificationCodeIsRequested() { `when`(httpService.probeUser(any() ?: "", any() ?: "", any() ?: "", any() ?: "", any() ?: "", any() .thenReturn(just<Response<Any>?>(Response.error(404, LoginServiceTests.emailVerificationEna `when`(httpService.generateVerificationCode(any() ?: "", any() ?: EmailVerificationWrapper(), any() .thenReturn(just(Response.success(null))) sut.onEmailEntered() verify(httpService).generateVerificationCode(any() ?: "", any() ?: EmailVerificationWrapper(), any( } @Test fun whenEmailEnteredAndNotFoundAndVerificationRequestFailed_thenAnErrorMessageIsShown() { `when`(httpService.probeUser(any() ?: "", any() ?: "", any() ?: "", any() ?: "", any() ?: "", any() .thenReturn(just<Response<Any>?>(Response.error(404, LoginServiceTests.emailVerificationEna `when`(httpService.generateVerificationCode(any() ?: "", any() ?: EmailVerificationWrapper(), any() MUCH BETTER
40. before after MUCH BETTER
41. main ingredients journey-like abstraction some Kotlin sugar
42. outcome reusability cohesion architecture clean code readability documentation maintainability
43. how can we even make it better?
44. a framework to rule them all
45. sweetest mysugr/sweetest
46. unit test
47. AuthManagerSteps Mock Assert LoginVM AuthManager BackendGW LoginVMSteps Setup Mock Interact Assert BackendGWSteps Mock Assert Setup Interact LoginVMTest Setup Mock Interact Assert
48. class LoginViewModelTest : BaseJUnitTest(appModuleTestingConfiguration) { override fun configure() = super.configure() .requireReal<LoginViewModel>() private val sut by steps<LoginViewModelSteps>() private val navigator by steps<LoginNavigatorSteps>() private val loginService by steps<LoginServiceSteps>() private val user by steps<UserSteps>() private val features by steps<FeaturesSteps>() private val connectivity by steps<ConnectivitySteps>() @Test fun `Enter email address as new user`() { user.exists = false sut.enterEmail() http { verifyProbeUserCalled() verifyGenerateVerificationCodeCalled() } sut.verifyLoginModelStateIs(State.EMAIL_VERIFICATION) } unit test in SWEETEST
49. step definition
50. class AuthManagerSteps(testContext: TestContext) : BaseSteps(testContext, appModuleTestingConfiguration) { override fun configure() = super.configure() .onSetUp(this::setUp) private val instance by dependency<AuthManager>() private val user by steps<UserSteps>() private fun setUp() { if (instance.isMock) { `when`(instance.loginOrRegister(anyString(), anyString())).then { val password = it.arguments[1] as String if (user.isPasswordCorrect(password)) { val email = it.arguments[0] as String if (user.isUserExisting(email)) { AuthManager.LoginOrRegisterResult.LOGGED_IN } else { AuthManager.LoginOrRegisterResult.REGISTERED } } else { throw AuthManager.WrongPasswordException() } step definitions in SWEETEST user.exists = false
51. fun whenLoggingInOrRegistering() { instance.loginOrRegister(user.email, user.password) } fun whenLoggingOut() { instance.logout() } fun thenLoginOrRegisterIsCalled() { verify(instance).loginOrRegister(user.email, user.password) } fun thenLoginOrRegisterThrows() { assertNotNull(loginOrRegisterThrowable) } step definitions in SWEETEST
52. integration test
53. AuthManagerSteps Mock Assert LoginVM AuthManager BackendGW LoginVMSteps Setup Mock Interact Assert LoginVMTest Setup Mock Interact Assert BackendGWSteps Mock Assert Setup Interact LoginIntegrationTest Setup Mock Interact Assert
54. class LoginViewModelTest : BaseJUnitTest(appModuleTestingConfiguration) { override fun configure() = super.configure() .requireReal<LoginViewModel>() private val sut by steps<LoginViewModelSteps>() private val navigator by steps<LoginNavigatorSteps>() private val loginService by steps<LoginServiceSteps>() private val user by steps<UserSteps>() private val features by steps<FeaturesSteps>() private val connectivity by steps<ConnectivitySteps>() unit test in SWEETEST
55. class LoginViewModelTest : BaseJUnitTest(appModuleTestingConfiguration) { override fun configure() = super.configure() .requireReal<LoginViewModel>() .requireReal<LoginService>() private val sut by steps<LoginViewModelSteps>() private val navigator by steps<LoginNavigatorSteps>() private val loginService by steps<LoginServiceSteps>() private val user by steps<UserSteps>() private val features by steps<FeaturesSteps>() private val connectivity by steps<ConnectivitySteps>() integration test in SWEETEST
56. val appModuleTestingConfiguration = moduleTestingConfiguration { dependency mockOnly of<SessionStore>() dependency mockOnly of<BackendGateway>() dependency any of<AuthManager>() dependency realOnly initializer { LoginViewModel(instanceOf()) } } configuration in SWEETEST
57. @Before fun before() { syncCoordinator = SyncCoordinatorImpl(mutableListOf(), mock<ConnectivityUtil>(), TestSchedulerProvi user = User().apply { emailAddress = EMAIL } loginService = LoginService(mock<ClientInfo>(), syncCoordinator, mock<UserSettings>(), mock<UserPreferences>(), eventBus, httpService, mock<BackendUrlStore>(), authStringGenerator) Tracker.init(mock<TrackerEngine>()) sut = LoginViewModel(scheduler, mock<Logger>(), loginService, resourceProvider).apply { bind(navigator, null, null) userInput.emailAddress = EMAIL userInput.password = PASSWORD } // [...] MESS
58. lots overhead? it depends... referencing steps classes
59. lots overhead? it depends... refactor/reference steps
60. behaviour-driven development (BDD) Cucumber framework
61. Feature: Login, registration and logout Background: Given there is a user existing with email address "test@test.com" and password "secure1" Scenario: User exists When trying to login or register with email address "test@test.com" and password "secure1" Then the user "test@test.com" is logged in as an existing user Scenario: Existing user, incorrect password When trying to login or register with email address "test@test.com" and password "wrongpass" Then the user can't enter the app Scenario Outline: Invalid email address When trying to login or register with email address "<email>" Then the user can't enter the app Examples: | email | | ajehf@.com | | wrong.net | | @sth.org | BDD example
62. fun givenRegisteredUser(email: String, password: String) { existingEmail = email correctPassword = password } BDD example
63. @Given("^there is a user existing with email address \"([^\"]*)\" and password \"([^\"]*)\"$") fun givenRegisteredUser(email: String, password: String) { existingEmail = email correctPassword = password } BDD example
64. sweetest ingredients easy setup dependency management mockito BDD few concepts open architecture = flexibility
65. sweetest outcomes - overhead + tools + speed + quality
66. journey harder than expected not the only answer conversation, trial and error fit for the future
67. what about you? source: https://bit.ly/2DfO3TH
68. success AGE SPEED
69. try approaches AST strategy/architecture see benefits discuss mysugr/sweetest
70. dramatic last words
71. marc.neureiter@mysugr.com engineering.mysugr.com monsterculture.mysugr.com make diabetes suck less mysugr/sweetest try, fork & contribute! follow us!