artem-zinnatullin / qualitymatters

Android Development Culture

QualityMatters

This app follows all principles of Android Development Culture Document.

What does it have:

• CI (Travis)
• Unit tests (some are Robolectric, some are plain JUnit tests with mocked android.jar).
• Integration tests to see that HTTP, REST, JSON parsing and RxJava work well in composition.
• Functional (UI) tests (Espresso with custom rules, mocked server and Screen-architecture) to check that app works according to the expectations from the user's point of view.
• Static code analysis (FindBugs, PMD, Android Lint, Checkstyle) (see root build.gradle).
• Code coverage
• Developer Settings Menu where you can enable/disable Stetho, LeakCanary, etc. See full list below (feel free to add more tools!).
• Git sha & build time without breaking incremental compilation! (Thanks to Paperwork)
• MVP, RxJava, Dagger 2, Retrofit 2 and so on.

---

Made with ❤️ by Artem Zinnatullin https://twitter.com/artem_zin.

To build the project run sh build.sh (yep, that easy, because it should be easy).

Screenshots:

Tests

Unit tests

Unit tests live mostly in src/unitTests but the app also has debug and release specific code—so there are also debugUnitTests and releaseUnitTests.

Unit tests check classes/methods in isolation from others, all dependencies are mocked.

All unit tests run on the JVM, no emulator or device is required. Mostly, unit tests run with mocked android.jar (built-in feature of Android Gradle Plugin). Some tests require things like Intent, etc. and such tests run using Robolectric.

The app has custom unit test runner which is required in order to override and mock some dependencies using Robolectric, like Analytics. Who needs real Analytics in Unit tests?

Integration tests

Integration tests live in src/integrationTests.

Integration tests check composition of multiple classes, for example OkHttp + Retrofit + Jackson + RxJava == API level, mostly all classes are real and not mocked, but for instance, we mock web server in integration tests.

All integration tests run on the JVM using Robolectric.

Also, you might notice that the app has custom integration test runner. It's required in order to override and mock some dependencies, like Analytics. Again, who needs real Analytics in integration tests?

Functional (UI) tests

The app has functional (UI) tests that live in src/functionalTests.

Functional tests check how the product (Android app) works from user's point of view. Basically, functional tests check app's UI for different use cases.

All functional tests run on connected emulator/device via Instrumentation API.

Also, you might notice that the app has custom functional test runner (yep). It's required to override and change implementation of some dependencies, like Analytics—instead of posting tons of useless data to Analytics during functional tests, we simply output it to the LogCat!

Developer Settings

Tools:

• Stetho — inspect the app via Chromium Developer Tools (network requests, db, preferences and so on). Must-have for developers.
• LeakCanary — detect memory leaks without IDE! Must-have for QAs and developers.
• TinyDancer — see frame rate right on your screen. Must-have for QAs and developers.
• Lynx — see LogCat output right in the app, useful for QAs and developers.

Details of implementation

Developer Settings are present only in debug build type. Libraries and resources used for Developer Settings are compiled into debug build only—main source set knows only little abstractions over Developer Settings just to initialize real implementation in the debug build code. In release build type DeveloperSettingsModule (Dagger) just returns no-op implementation of DeveloperSettingsModel.

Why only debug builds? The answer is simple — dex limit. LeakCanary brings about 3k methods, Stetho brings about 2k and so on. The more tools you add to Developer Settings, the bigger the apk you receive. Situation is even worse if your main code gets near 65k methods. In our production app we had to turn on multidex for debug builds.

Package structure

Many people ask why this app has component-based package structure: presenters, models, etc. instead of the feature-based one: itemslist, developersettings, etc.

With component-based structure of packages, new persons on the project (like those who read the code of this app) can easily find presenters, views, models, etc. within the app. If you read the code and want to quickly move to some class related to the current one you can simply press t right on the GitHub and search for the required file!

qualitymatters's Issues

Upgrade to Butterknife 8.0

https://github.com/JakeWharton/butterknife/blob/master/CHANGELOG.md

Check Retrofit configuration as test instead of doing this in debug builds

Suggested by @adelnizamutdinov in #88

Add TinyDancer to Developer Settings

https://github.com/brianPlummer/TinyDancer

DebugMenu library

Take a look to this repo https://github.com/palaima/DebugDrawer looks great

Add AndroidDevMetrics

I came across this library recently and it looks interesting. Maybe it would be worth adding to the developer settings?

https://github.com/frogermcs/AndroidDevMetrics

Retrofit 2 beta4 + OkHttp 3

^

Process Phoenix for activity restart

Instead of prompting everytime to restart the app we can use process Phoenix https://github.com/JakeWharton/ProcessPhoenix

Add Gradle Versions Plugin

I'm using this one in my apps and it's fantastic!

https://github.com/ben-manes/gradle-versions-plugin

Release not recognized as a valid source set

For some reason the release code and release unit tests are not recognized by my version of Android studio (2.0-Beta7).

This makes it impossible to run the release unit tests. I've noticed that the release build type in the gradle config is missing an id. However adding this back in doesn't solve the problem. Any ideas?

buildTypes { 
    ...
    release {
            signingConfig signingConfigs.qualityMatters
            applicationIdSuffix '.release' // Missing from build.gradle!!
            ...
    }

Repo as "Awesome"

Hey

Also maybe this repo can be renamed to "Awesome android app" or something since its a refined list of tools and settings all inside one app, also may help to give visibility to this.

Check https://github.com/sindresorhus/awesome

And just wanted to share this awesome with cool plugins/tools/things/any for mobile learning and best practices...

https://github.com/MakinGiants/awesome-mobile-dev

Its aligned with quality matters so maybe add it to readme here as reference or an update from you guys it with cool things learned from here or something will be "awesome" (lol).

Get rid of Java in favor of Kotlin

Change level of HTTP logging in the Developer Settings

Write build info: git sha & build time to asset file

This would prevent problems with incremental compilation of source code.

Proguard release build

Idea behind this is to make project as much close to real world one as possible. In my practice release builds are usually proguarded because of code shrinking and performance improvements, let's make this for qualitymatters too?

Also, will be great to run functional tests both for non-proguarded and proguarded build types (this is possible).

// I'm currently very busy so I'll be more than happy if somebody will submit a PR for that, otherwise I'll do it someday.

Take a look at Spring Dependency management plugin

https://github.com/spring-gradle-plugins/dependency-management-plugin

When you want to provide dependency management for multiple modules with the same group and version you should use a dependency set. Using a dependency set removes the need to specify the same group and version multiple times:

dependencyManagement {
     dependencies {
          dependencySet(group:'org.slf4j', version: '1.7.7') {
               entry 'slf4j-api'
               entry 'slf4j-simple'
          }
     }
}

Could be a nicer way to define dependencies especially for things like the android support libraries

Code Quality Tools: PMD

I really do like to use PMD as it catches some stuff that neither Checkstyle nor Findbugs does.

If you want me to, I could also add that one, we'd just then need to agree on some rules as there are quite a lot.

Add LICENSE

Please add missing LICENSE file.

Add shake to send a bug report feature

Should we add this tool when debug https://github.com/stkent/bugshaker-android. It's cool for QA team, especially when we work remotely.

Get rid of Robolectric on DeveloperSettingsTest

As I see we are using Robolectric to test DeveloperSetting class because DeveloperSetting needs an instance of SharedPreferences.

Instead of user Robolectric to get SharedPreferences instance we can use some kind of mock or in memory Shared preferences. In my opinion, It will be better approach than using Robolectric.

Or we can use this instead of SharedPreferences directly on DeveloperSetting class. It will make mocking stuffs easy.

Document Developer Settings

Really liking the debug panel. I noticed it in Wharton's U2020, and was curious if yours is a clone or if you've modified it in some ways. I know there are a couple 3rd party libraries that are similar as well.
Would be nice to update the README to document it in some form.

[Question] Unresponsive/Flaky Roboelectric tests

I'm not sure if this is the correct forum for asking this question but I'll ask it anyway. Hopefully someone has some insight into the problem.

Is anyone else having issues running the unit tests that depend on Roboelectric? For some reason they hang indefinitely on my system.

See the following test screenshot from Android studio:

This problem makes it impossible for me to run unit tests that depend on Android SDK classes.

Switch to Gson with AutoValue-Gson extension

Main reason to use Jackson was the built-in support of builders in Jackson, now we can use Gson which is much smaller (~4x) library with pretty much the same performance.

Change Travis CI to something else, it's slow and flaky

Android emulator runs really bad on Travis, pretty often we see that instrumentation tests are not starting because emulator is not responding.

Personally, I'd go with Circle CI for now.

Add Checkstyle!

ItemVIewHolder click listeners

I see that you have ItemViewHolder as a separate class as opposed to an inner class of the adapter. I was wondering how would you implement a click listener without a reference to the adapter?

Add errorprone

Basically that tool automatically hooks itself up with the build process so even locally while developing you'll get warnings / errors. If it's fatal it'll give you an error during compiling.

Website for more information

If you want, I can also submit a PR for that in the next couple of days.

Gradle sync fails all the time

I'm running sh ci.sh and the project is built successfully.
However, Android Studio keeps showing me the following error message:

Gradle project sync failed. Basic functionality (e.g. editing, debugging) will not work properly

Because whenever I try to sync Gradle project I'm getting the following error:

Error:(4, 0) Cause: hu/supercluster/paperwork/plugin/PaperworkPlugin : Unsupported major.minor version 52.0

I suppose that this may be caused by the incompatibility of bytecode generated by different java compilers. The JAVA_HOME on my system points to the Java 7 installation, the javac -version output is the

javac 1.7.0_80

...and the java -version gives me

java version "1.7.0_80"
Java(TM) SE Runtime Environment (build 1.7.0_80-b15)
Java HotSpot(TM) 64-Bit Server VM (build 24.80-b11, mixed mode)

Where does this error may come from?

Suggestion: use StorIO

Bug with DeveloperSettings

Why needed this checking? It is creating bug, when restart app and in settings stetho was enabled, but Stetho is not initialized.

Use Mosby for the MVP

Is it worth using Mosby to replace the MVP part? any advantages or disadvantages?

Add code coverage status to Readme

It will be great if we have code coverage status of this project. We can use https://coveralls.io or https://codecov.io.

Add Logging level to the Developer Settings

Add info about packaging principle into README

Some amount of people ask why I've used "packaging by type" and not the "packaging by feature", looks like it's worth mentioning in the README.

Try plugin for embedding build info without breaking compilation incrementality

https://github.com/zsoltk/paperwork

Replace ugly runOnUiThreadIfFragmentAlive with Rx chain composition

If View methods return Action1 or probably Observable / Single will be able to compose them on the Presenter side and it'll work as part of initial chain.

Though, I also see some drawbacks, but in general, it's more functional and clear approach -> 👍

// Thanks @pakoito for the input!

Dagger Note

While running the project locally I got that note.

Note: Generating a MembersInjector or Factory for com.artemzin.qualitymatters.QualityMattersApp. Prefer to run the dagger processor over that class instead.

Should we pay attention to this one?

Switch Picasso to OkHttp client

For performance and Stetho!

Add fbinfer!

Add SonarQube

I just read about it here and it does seem pretty neat. Unfortunately setting up might be tricky :/

Add LeakCanary!

Add Suffix to debug build

Why? To allow developers have both debug and release builds on their device.

Unit tests for DeveloperSettings should use mock of SharedPreferences

Currently it's more integration tests rather than a unit. For example, we don't know if it really writes values to SharedPreferences and reads them back or if it stores values just in memory.

Add logging

Probably, Timber.

Code style question

Look at code https://github.com/artem-zinnatullin/qualitymatters/blob/master/app/src/main/java/com/artemzin/qualitymatters/ui/presenters/ItemsPresenter.java#L57

Why you write items error lambda on new line? it is your code style or it has some practical sense? eg in coverage or debug?

But in other code (in your code) I do not found this style of code..

eq https://github.com/artem-zinnatullin/qualitymatters/blob/master/app/src/main/java/com/artemzin/qualitymatters/ui/fragments/ItemsFragment.java#L107

AsyncJob and AsyncJobObserver

Can somebody explain why needed this classes, AsyncJob and AsyncJobObserver?

Http logging interceptor should be compiled only into debug build

Add gitter chat

Will be great to have https://gitter.im for this repo so everyone can ask or discuss best practices

DeveloperSettingsPresenter should not check if previous value of a setting was same

This logic should be moved to the model.

Stop using Retrofit BaseUrl for switching REST api endpoint

See square/retrofit#1652

List tools from Developer Settings in the README

Short description + links.