Gradle Plugin for Android Configuration

To use the DashO™ Gradle Plugin for Android, first add it to your Gradle build and then configure it further in your buildscript.

Adding the Plugin

To apply the DashO Gradle Plugin for Android, you need to include it as a buildscript dependency on your build, which in turn requires you to add the PreEmptive Maven Repository as a buildscript repository:

buildscript {
    repositories {
        maven { url 'https://maven.preemptive.com' }
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.4.0'
        classpath 'com.preemptive.dasho:dasho-android:1.0.+'
    }
}

You will also need to apply the plugin after the appropriate Android plugin (i.e., com.android.application or com.android.library):

apply plugin: 'com.android.application'
apply plugin: 'com.preemptive.dasho.android'

Configuring the Plugin

The plugin can be configured via the dasho closure in your buildscript at any point after the com.preemptive.dasho.android plugin has been applied.

dasho {
    debug false
    doxFilename "project.dox"
    enabledBuildVariants "release"
    excludeFromProtection null
    home "/Applications/PreEmptive Protection DashO x.y/Contents/Java"
    javaOptions "-Xmx128m", "-Xms96m"
    searchVersion "10"
    verbose false
}

The following properties are available for the dasho closure:

The dasho closure is not required if you don't need to set any of its properties, all of which are optional.

Notes:
The DashO Gradle Plugin for Android will use the same version of Java as configured for Gradle when running DashO. This can be configured with the org.gradle.java.home setting.

The DashO Gradle Plugin for Android is not compatible with Instant Run functionality in Android Studio. If you enable DashO to run on debug build variants, you will need to disable Instant Run.

Default DashO Configuration File

If you do not specify a DashO Configuration File with the doxFilename property of the dasho closure, the DashO Gradle Plugin for Android will search for a project file matching the current variant.

As an example, suppose you have the following build flavors and types configured:

android {
    buildTypes {
        debug { }
        release { }
    }
    flavorDimensions 'monetization', 'deviceType'
    productFlavors {
        free { dimension 'monetization' }
        paid { dimension 'monetization' }
        phone { dimension 'deviceType' }
        tablet { dimension 'deviceType' }
    }
}

For the build variant freePhoneDebug, the DashO Gradle Plugin for Android would look for project files in the same directory as the application-level build.gradle, using the first project file found in the following list:

1. freePhoneDebug.dox
2. freePhone.dox
3. free.dox
4. phone.dox
5. debug.dox
6. project.dox

Excluding from Protection

The dasho closure contains an excludeFromProtection property which allows inputs to be excluded from protection by DashO. The setting accepts a regular expression. All inputs whose name contains a match for the expression will be passed to DashO as a dependency. By default nothing is excluded.

For example, if your project has dependencies like:

 dependencies {
     implementation 'androidx.appcompat:appcompat:1.0.2'
     implementation 'androidx.recyclerview:recyclerview:1.0.0'
     implementation project(':library')
 }

...setting excludeFromProtection "androidx" will pass the androidx jars as dependencies to DashO.

This setting can be helpful if you are running a single build from which you distribute both a library (AAR) and an application (APK). You can configure DashO to protect both the library and the application and then set excludeFromProtection ":library" in your application's build.gradle file. If you are only distributing the application, do not protect the library independently; it will be protected with the application so long as you do not exclude it.

Notes:
The regular expression only needs to case-insensitively match part of the name. So view would match 'androidx.recyclerview:recyclerview:1.0.0 and :codeViewerLibrary.

The build will fail if you configure excludeFromProtection to match everything (e.g. excludeFromProtection ".*" or excludeFromProtection "").

Some plugins may corrupt the names making it impossible to match the original names. For example, the Firebase Performance plugin will change the name androidx.annotation:annotation:1.0.0 to something like 0a1124bfce06f9f05e9f92edcabdc725-classes. If you encounter corrupted names, please apply com.preemptive.dasho.android before those plugins (e.g. com.google.firebase.firebase-perf).

Running with the plugin

Once you have applied the plugin it should automatically integrate with the Android plugin. You can run gradlew dashOPluginVersion to display the full version of the plugin.

Supported Properties

The plugin supports the following properties which can be set as a Gradle project property, a Java system property or an environment variable:

• DASHO_HOME - Specifies DashO Home.
• DISABLE_DASHO - DashO will not process the classes if this property exists. No value is needed. All values other than false are interpreted as true.
• GENERATE_DASHO_CONFIG - Tells DashO to generate a default Android Mode configuration file. No value is needed. All values other than false are interpreted as true.
• SHOW_DASHO_CMD - The command line arguments used when launching DashO will be shown if this property exists. No value is needed. All values other than false are interpreted as true.

These properties can be passed on the gradlew command line via -P{name}[={value}] or -D{name}[={value}]

Note: An error will occur when using the GENERATE_DASHO_CONFIG property if the configuration file already exists.