https://github.com/gfx/android-power-assert-plugin

Power Assert for Android
https://github.com/gfx/android-power-assert-plugin

Last synced: 2 months ago
JSON representation

Power Assert for Android

• Host: GitHub
• URL: https://github.com/gfx/android-power-assert-plugin
• Owner: gfx
• License: mit
• Created: 2014-05-05T02:40:17.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2016-11-16T07:26:31.000Z (over 7 years ago)
• Last Synced: 2024-01-27T10:32:26.910Z (5 months ago)
• Language: Groovy
• Homepage:
• Size: 1.29 MB
• Stars: 47
• Watchers: 8
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Lists

• awesome-android-testing - android-power-assert-plugin

README

        
# Power Assert for Android [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.gfx.android.powerassert/plugin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.gfx.android.powerassert/plugin) [![Circle CI](https://circleci.com/gh/gfx/android-power-assert-plugin.svg?style=svg&branch=master)](https://circleci.com/gh/gfx/android-power-assert-plugin)

**Power Assert** is a language extension which adds extra information when assertions fail.

This feature has been invented in Groovy and being spread around other programming languages,

and is becoming a fundamental feature for debugging and testing, especially in unit tests: you

no longer need to learn a bunch of test matchers such as

[assertEquals()](http://developer.android.com/reference/junit/framework/Assert.html).

This is a Gradle plugin to provide Android with power asserts by modifying Java class files

in compilation phases. To use power assert, all you have to do is to depend on

`android-power-assert-plugin` and apply `android-power-assert` plugin in `build.gradle`,

which automatically enables `assert` statements unless you makes `release` build. Thus you can use

 [assert statements](http://docs.oracle.com/javase/8/docs/technotes/guides/language/assert.html)

 both in applications and unit tests.

# Usage

This plugin uses `assert` statements in Java by applying this plugin in `build.gradle`.

```groovy

// in the root build.gradle

buildscript {

    repositories {

        mavenCentral() // or jcenter()

    }

    dependencies {

        classpath 'com.android.tools.build:gradle:1.5.2'

        classpath 'com.github.gfx.android.powerassert:plugin:1.5.2'

    }

}

```

```groovy

// in a build.gradle of a module

apply plugin: 'android'

apply plugin: 'com.github.gfx.android.powerassert'

```

Then, use `assert` in your program:

```java

// in example's MainActivity.java

void onButton2Click() {

    assert findViewById(android.R.id.list).getVisibility() == View.VISIBLE;

}

```

This shows the following output when `findViewById()` returns null:

```

java.lang.NullPointerException:

25:     void onButton2Click() {

26>         assert findViewById(android.R.id.list).getVisibility() == View.VISIBLE;

26:     }

com.github.gfx.powerassert.example.MainActivity.findViewById()=

(...stacktrace...)

```

# Logging

`POWERASSERT_VERBOSE=1` shows debug logs including how the plugin spends time in bytecode modification.

`POWERASSERT_VERBOSE=2` shows all the extra source code so it might be useful to debug this plugin.

# Compatibility

The minor version of this plugin should match with the minor version of Android Gradle Plugin.

That is, android-power-assert-plugin v0.10.x is compatible with Android Gradle Plugin v0.10.x,

as well as android-power-assert-plugin v1.1.x is compatible with Android Gradle Plugin v1.1.x.

# Author And License

Copyright 2014, FUJI Goro (gfx) . All rights reserved.

This library may be copied only under the terms of the MIT License.

# See Also

- [Groovy 1.7 Power Assert (Posted on December 11, 2009)](https://dontmindthelanguage.wordpress.com/2009/12/11/groovy-1-7-power-assert/)

- [Power Assert in JavaScript](https://github.com/power-assert-js/power-assert)