vb-android-app-quality

Sample android project using Gradle, with basic quality tools set up.

This project for provide a clean base to any Gradle Android project.

This project also illustrate my articles about Gradle on my website.

Quality

You will find under the directory /config the base configuration to run quality test on the project. The followings tools are used :

• Checkstyle.
• Findbugs.
• PMD.
• Lint.

To run these quality tools and get reports, you need to execute the following gradle command :

 gradle check

Findbugs needs the binaries of the project, so be sure to run at least one time the following command, before launching a check :

  gradle build

You can modify the behaviour of each tool through the quality.gradle file. You can for example set :

• The output format (xml or html).
• Abort the task when a failure is found.

You should refer to this gradle documentation to configure those plugins.

By default, all the reports will be generated in the folder app/build/reports.

Flavor

The project itself is a demo of the flavor system. Flavor are defined in the build.gradle. You need to provide a least a name to the flavor :

productFlavors {
       red {
           packageName 'vb.android.app.quality.red'
       }
       blue {
           packageName 'vb.android.app.quality.blue'
       }
   }

You can define several properties to your flavors. One very useful is the packageName which let you change the package name of your application. This can be used to generate differents flavors of your application and install both of them on the same device (free and paid versions, dev, validation and release versions...).

You can also put specific sources and resources with flavors. As it is in this project, just create a directory under the src folder, name it with the name of your flavor, and put inside java codes and resources.

AAR

Work in progress...

Testing

Work in progress...

To go further

This project is based on these two other projects, which are awesome. Consider take a look at them :

• Quality-Tools-for-Android.
• volley-examples.

License

Copyright 2013 Vincent Brison.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.