Slide 1

Slide 1 text

Re-architecture Ragunath Jawahar • @ragunathjawahar I assume there are tests edition

Slide 2

Slide 2 text

? • Started out as a Minimum Viable Product • Workarounds and fighting the framework • Overcome limitations • Accidental complexity (RxJava) • Open-Source (funded by a non-profit) • Painful tests (1:8)

Slide 3

Slide 3 text

Where do we start?

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

No content

Slide 6

Slide 6 text

No content

Slide 7

Slide 7 text

No content

Slide 8

Slide 8 text

BOUNDARIES! (Large surface area)

Slide 9

Slide 9 text

System Boundaries • Network • File System / Database / Persistence • Hardware • UI • 3rd Party Integrations

Slide 10

Slide 10 text

No content

Slide 11

Slide 11 text

No content

Slide 12

Slide 12 text

Network

Slide 13

Slide 13 text

Network

Slide 14

Slide 14 text

Network Database

Slide 15

Slide 15 text

Network Database

Slide 16

Slide 16 text

Network Database User Interface

Slide 17

Slide 17 text

+ - Network Database User Interface

Slide 18

Slide 18 text

+ - Network Database User Interface Inputs

Slide 19

Slide 19 text

+ -

Slide 20

Slide 20 text

+ - 0.0v

Slide 21

Slide 21 text

+ - 0.5v Network

Slide 22

Slide 22 text

+ - 1.0v Database

Slide 23

Slide 23 text

+ - 1.5v User Interface

Slide 24

Slide 24 text

+ - 2.0v Network User Interface

Slide 25

Slide 25 text

+ -

Slide 26

Slide 26 text

+ - Re-architect

Slide 27

Slide 27 text

+ - + - Re-architect

Slide 28

Slide 28 text

Approach 1: Cloning Tests

Slide 29

Slide 29 text

Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt

Slide 30

Slide 30 text

Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt

Slide 31

Slide 31 text

Different package Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt

Slide 32

Slide 32 text

Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt

Slide 33

Slide 33 text

Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt

Slide 34

Slide 34 text

Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt

Slide 35

Slide 35 text

Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt

Slide 36

Slide 36 text

Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt

Slide 37

Slide 37 text

Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt

Slide 38

Slide 38 text

Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt

Slide 39

Slide 39 text

Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt

Slide 40

Slide 40 text

Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt

Slide 41

Slide 41 text

No content

Slide 42

Slide 42 text

ff27cb1

Slide 43

Slide 43 text

Pros • Provides a fallback if things go wrong • Little refactoring experience • Allows complementing asymmetric/low-confidence tests with manual testing • “Works” even if you don’t have enough tests

Slide 44

Slide 44 text

Cons • All or nothing • Hard to accommodate incoming feature requests • Duplicate tests and features • Reviewing pull requests can be difficult • Easy to miss functionality that is not covered by tests • Cleaning up old code after feature stabilisation

Slide 45

Slide 45 text

Approach 2: Strangulation

Slide 46

Slide 46 text

+ - + - Re-architect

Slide 47

Slide 47 text

No content

Slide 48

Slide 48 text

Network Database User Interface

Slide 49

Slide 49 text

+ - Inputs

Slide 50

Slide 50 text

+ -

Slide 51

Slide 51 text

+ -

Slide 52

Slide 52 text

+ -

Slide 53

Slide 53 text

+ -

Slide 54

Slide 54 text

+ -

Slide 55

Slide 55 text

+ -

Slide 56

Slide 56 text

+ -

Slide 57

Slide 57 text

+ -

Slide 58

Slide 58 text

Setup Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt

Slide 59

Slide 59 text

Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt Setup

Slide 60

Slide 60 text

Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt Setup

Slide 61

Slide 61 text

Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt Setup

Slide 62

Slide 62 text

Tear down Test 1 Test 2 Test 3 Test 4 LoginControllerTest.kt Setup

Slide 63

Slide 63 text

Peek: Tests

Slide 64

Slide 64 text

No content

Slide 65

Slide 65 text

No content

Slide 66

Slide 66 text

No content

Slide 67

Slide 67 text

No content

Slide 68

Slide 68 text

Peek: Migration

Slide 69

Slide 69 text

@Test !// TODO: Migrate to Mobius fun `when save is clicked then user input should be validated`() { whenever(patientRepository.ongoingEntry()).thenReturn(Single.just(OngoingNewPatientEntry())) with(uiEvents) { onNext(FullNameChanged("")) onNext(PhoneNumberChanged("")) onNext(DateOfBirthChanged("")) onNext(AgeChanged("")) onNext(GenderChanged(None)) onNext(ColonyOrVillageChanged("")) onNext(DistrictChanged("")) onNext(StateChanged("")) onNext(SaveClicked) } with(uiEvents) { onNext(DateOfBirthChanged("33/33/3333")) onNext(SaveClicked) } with(uiEvents) { onNext(AgeChanged(" ")) onNext(DateOfBirthChanged("")) onNext(SaveClicked) } with(uiEvents) { onNext(DateOfBirthChanged("16/07/2018")) onNext(SaveClicked) } with(uiEvents) { onNext(PhoneNumberChanged("1234")) onNext(SaveClicked) } with(uiEvents) { onNext(PhoneNumberChanged("1234567890987654")) onNext(SaveClicked) } verify(ui, atLeastOnce()).showEmptyFullNameError(true) verify(ui, atLeastOnce()).showEmptyDateOfBirthAndAgeError(true) verify(ui, atLeastOnce()).showInvalidDateOfBirthError(true) verify(ui, atLeastOnce()).showMissingGenderError(true) verify(ui, atLeastOnce()).showEmptyColonyOrVillageError(true) verify(ui, atLeastOnce()).showEmptyDistrictError(true) verify(ui, atLeastOnce()).showEmptyStateError(true) verify(ui, atLeastOnce()).showLengthTooShortPhoneNumberError(true) verify(ui, atLeastOnce()).showLengthTooLongPhoneNumberError(true) }

Slide 70

Slide 70 text

No content

Slide 71

Slide 71 text

@Test !// TODO: Migrate to Mobius fun `when save is clicked then user input should be validated`() { whenever(patientRepository.ongoingEntry()).thenReturn(Single.just(OngoingNewPatientEntry())) with(uiEvents) { onNext(FullNameChanged("")) onNext(PhoneNumberChanged("")) onNext(DateOfBirthChanged("")) onNext(AgeChanged("")) onNext(GenderChanged(None)) onNext(ColonyOrVillageChanged("")) onNext(DistrictChanged("")) onNext(StateChanged("")) onNext(SaveClicked) } with(uiEvents) { onNext(DateOfBirthChanged("33/33/3333")) onNext(SaveClicked) } with(uiEvents) { onNext(AgeChanged(" ")) onNext(DateOfBirthChanged("")) onNext(SaveClicked) } with(uiEvents) { onNext(DateOfBirthChanged("16/07/2018")) onNext(SaveClicked) } with(uiEvents) { onNext(PhoneNumberChanged("1234")) onNext(SaveClicked) } with(uiEvents) { onNext(PhoneNumberChanged("1234567890987654")) onNext(SaveClicked) } verify(ui, atLeastOnce()).showEmptyFullNameError(true) verify(ui, atLeastOnce()).showEmptyDateOfBirthAndAgeError(true) verify(ui, atLeastOnce()).showInvalidDateOfBirthError(true) verify(ui, atLeastOnce()).showMissingGenderError(true) verify(ui, atLeastOnce()).showEmptyColonyOrVillageError(true) verify(ui, atLeastOnce()).showEmptyDistrictError(true) verify(ui, atLeastOnce()).showEmptyStateError(true) verify(ui, atLeastOnce()).showLengthTooShortPhoneNumberError(true) verify(ui, atLeastOnce()).showLengthTooLongPhoneNumberError(true) }

Slide 72

Slide 72 text

@Test !// TODO: Migrate to Mobius fun `when save is clicked then user input should be validated`() { whenever(patientRepository.ongoingEntry()).thenReturn(Single.just(OngoingNewPatientEntry())) with(uiEvents) { onNext(FullNameChanged("")) onNext(PhoneNumberChanged("")) onNext(DateOfBirthChanged("")) onNext(AgeChanged("")) onNext(GenderChanged(None)) onNext(ColonyOrVillageChanged("")) onNext(DistrictChanged("")) onNext(StateChanged("")) onNext(SaveClicked) } with(uiEvents) { onNext(DateOfBirthChanged("33/33/3333")) onNext(SaveClicked) } with(uiEvents) { onNext(AgeChanged(" ")) onNext(DateOfBirthChanged("")) onNext(SaveClicked) } with(uiEvents) { onNext(DateOfBirthChanged("16/07/2018")) onNext(SaveClicked) } with(uiEvents) { onNext(PhoneNumberChanged("1234")) onNext(SaveClicked) } with(uiEvents) { onNext(PhoneNumberChanged("1234567890987654")) onNext(SaveClicked) } verify(ui, atLeastOnce()).showEmptyFullNameError(true) verify(ui, atLeastOnce()).showEmptyDateOfBirthAndAgeError(true) verify(ui, atLeastOnce()).showInvalidDateOfBirthError(true) verify(ui, atLeastOnce()).showMissingGenderError(true) verify(ui, atLeastOnce()).showEmptyColonyOrVillageError(true) verify(ui, atLeastOnce()).showEmptyDistrictError(true) verify(ui, atLeastOnce()).showEmptyStateError(true) verify(ui, atLeastOnce()).showLengthTooShortPhoneNumberError(true) verify(ui, atLeastOnce()).showLengthTooLongPhoneNumberError(true) }

Slide 73

Slide 73 text

@Test !// TODO: Migrate to Mobius fun `when save is clicked then user input should be validated`() { whenever(patientRepository.ongoingEntry()).thenReturn(Single.just(OngoingNewPatientEntry())) with(uiEvents) { onNext(FullNameChanged("")) onNext(PhoneNumberChanged("")) onNext(DateOfBirthChanged("")) onNext(AgeChanged("")) onNext(GenderChanged(None)) onNext(ColonyOrVillageChanged("")) onNext(DistrictChanged("")) onNext(StateChanged("")) onNext(SaveClicked) } with(uiEvents) { onNext(DateOfBirthChanged("33/33/3333")) onNext(SaveClicked) } with(uiEvents) { onNext(AgeChanged(" ")) onNext(DateOfBirthChanged("")) onNext(SaveClicked) } with(uiEvents) { onNext(DateOfBirthChanged("16/07/2018")) onNext(SaveClicked) } with(uiEvents) { onNext(PhoneNumberChanged("1234")) onNext(SaveClicked) } with(uiEvents) { onNext(PhoneNumberChanged("1234567890987654")) onNext(SaveClicked) } }

Slide 74

Slide 74 text

No content

Slide 75

Slide 75 text

No content

Slide 76

Slide 76 text

No content

Slide 77

Slide 77 text

No content

Slide 78

Slide 78 text

No content

Slide 79

Slide 79 text

Move functionality to the new architecture and the test would fail indicating a successful port. Next, remove the functionality from the new architecture, now the current test & all other tests should pass.

Slide 80

Slide 80 text

No content

Slide 81

Slide 81 text

No content

Slide 82

Slide 82 text

No content

Slide 83

Slide 83 text

No content

Slide 84

Slide 84 text

Rinse and repeat… Delete the test when you’re done!

Slide 85

Slide 85 text

No content

Slide 86

Slide 86 text

Pros • Pretty low risk, micro changes to the system • System is green and ready to ship all the time • Easy for the reviewer to understand system evolution • Fairly easy to accommodate incoming feature requests • Untested code attracts attention • No duplication

Slide 87

Slide 87 text

Cons • Requires familiarity around testing and refactoring • Requires fast feedback cycles • Requires experimentation • Has the highest pay-off when similar patterns are replicated • May inherit some design decisions from the older architecture

Slide 88

Slide 88 text

References https://github.com/simpledotorg/simple-android Approach 1: a5c8ad1 .. ff27cb1 Approach 2: 0c19381 .. df7788b

Slide 89

Slide 89 text

Questions?