lint-junit-rule


Source link: https://github.com/a11n/lint-junit-rule

lint-junit-rule

A JUnit rule which allows unit testing of custom Lint rules.

If you want to learn more about custom Lint rules please check this reference guide. If you want to write your own custom Lint rule you could use this custom Lint rule template. If you are still looking for more details you are welcome to check this workshop on custom Lint rules.

Motivation

Fortunately, with the release of the lint-tests library version 24.3.0 at the end of July 2015 [1] there is now official test support available for custom Lint rules. Unfortunately there are still some drawbacks:

  1. You have to use the JUnit 3 approach of extending LintDetectorTest.
  2. The assertion options are poor, all you get is one String.
  3. There is an issue when loading your test resources [2].

Therefore the objective of this library is to take you one step further:

  1. It provides JUnit 4 support by wrapping the official test support into a dedicated JUnit rule.
  2. Furthermore it exposes the internal Lint Warnings for you which allows powerful assertions.
  3. Last but not least it fixes the aforementioned issue for you which gives you a convenient way to place your test resources in test/res.

Usage

Import the dependency in your build.gradle. It's available via JCenter:

dependencies{

...
testCompile 'de.ad:lint-junit-rule:0.3.0'

//optional
testCompile 'de.ad:lint-assertj:0.3.0'
testCompile 'de.ad:lint-hamcrest:0.3.0' 
}

Apply the rule in your test class and specify the Detector as well as the Issues under test. Next provide the files to analyze. Finally do your assertions on the populated Warnings:

  @Rule public Lint lint = new Lint(new MyCustomRule(), MyCustomRule.ISSUE);

 @Test
public void test() throws Exception {

  List<Warning> lintResult = lint.files("AndroidManifest.xml", "res/values/strings.xml");

//AssertJ
  assertThat(lintResult)

 .hasWarnings(2)

 .in("AndroidManifest.xml", "strings.xml")

 .atLine(8, 14)

 .withMessage("MyCustomRule warning message.",

  "MyCustomRule warning message.");

//Hamcrest
  assertThat(lintResult,

  hasWarnings(

 in("AndroidManifest.xml", "strings.xml"),

 atLine(8, 14),

 withMessage("MyCustomRule warning message.",

 "MyCustomRule warning message.")));

}

Note: Test resources are looked-up in test/res.

References

  1. https://bintray.com/android/android-tools/com.android.tools.lint.lint-tests/24.3.0/view
  2. https://code.google.com/p/android/issues/detail?id=182195

Resources

A Barcode scanning library for Android. Uses the Google Play Services' mobile vision api for barcode detection.

Provide diagonal cut on view with awesome customization.

An automated cookies manager library for android. It allows to handle HTTP request with cookies.

Blaze provides a view for Moving Image and Zooming Image. Easy to create continuously moving background.

Log to a sql database for debugging. View the logs in-app with the LogViewerActivity.

RxComprehensions is a library to reduce boilerplate and simplify your Observable chains.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes