Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 3.37 KB

README.md

File metadata and controls

65 lines (46 loc) · 3.37 KB
Raw

Koin example for Android (nbl-survey)

One-feature-Android-application as an example of how to setup Koin 2.0.1 for AndroidX: from Unit Test to Integration Test.

This is a demo application, based on Nimble's API, demonstrate how a good covering test can help you in writing less error-prone code.

App has only one feature: make Http requests to the API to get the list of surveys from the endpoint and render on a vertical viewpager. If the token is expired, refresh the token before retrying the request.

The most challenging thing is to set up Koin DI: when running test cases, Retrofit should be pointed to the mockWebServer endpoint instead of real API. And cycle dependency arose when reuse retrofit to refresh a new token.

Tools

  • DI: Koin (should stick back to Dagger2..explain below)
  • Viewpager2
  • Circle indicator
  • Android Architecture Components (LiveData, Viewmodel)
  • Retrofit, OkHttp, Glide
  • RxJava, RxBinding, RxAndroid
  • Leak canavary (for auto detecting leaks)
  • Customactivityoncrash (let's give user a bug when their app crash instead of boring messages)
  • Toasty (more fancy Toast)
  • KProgressHUD

Test

  • AndroidX
  • Espresso
  • Robolectric
  • Specially thanks to: Kluent and Barista - the guy who serve great Espresso saved me from nightmare of Hamcrest

Technical issues

Koin

Works pretty well, add and wire dependencies smooth and intuitive at first sight. When come to writing test, everything just collapses suddenly. Can not figure out how to override some dependency in test environment plus with lacking and ambiguous documents makes me feel regret about choosing it over Dagger2. loadKoinModule with (override = true) can be used to alter existing dependency tree for testing purpose.

The most disadvantaged: Dagger2 detect dependency errors and notify at compile-time if there are any, but Koin only throws errors at runtime. With Koin, you need to check your app more carefully.

And circular dependency seems a problem. I used a Holder as a workaround. Lazy initialization works well and simplifies the code.

KProgressHUD

More beautiful and easier to implement compared to Shimmer. BUT, makes all the UI test fail continuously. Maybe it still left on the screen after the dismiss function called. I have to use CoutingIdlingResource. And...don't sure whether it need to test the dialog? What's best way to do?

Viewpager2

Now you can use RecyclerView.Adapter for Viewpager. Awesome. Google should have shipped this feature with Viewpager on early days.

AndroidX Test

At last, unified API between unit test and UI test (integration-test). Test codes (unit & UI) can be put in a shared folder now. Robolectric works out of the box. Nitrogen project is worth waiting for. BUT, ScenarioActivity.onActivity{} callback never called in my test, the test just keep running forever. Googled give no clues, may I the only one? I have to use a static variable to hold a Weak Reference to MainActivy for testing, which could be abused using...

Espresso

Boring and tricky as usual.

MockWebServer

Reliable and unstable at the same time. Lol.

FAQ

  • Where is license part?
    • What is the license?
  • Open issues and pull request?
    • You are welcome. I love so.