Inspector

Additional

Language
JavaScript
Version
N/A
Created
May 20, 2015
Updated
Sep 13, 2015 (Retired)
Owner
Jake Ouellette (jakeouellette)
Contributor
Jake Ouellette (jakeouellette)
1
Activity
Badge
Generate
Download
Source code

Advertisement

Inspector

Gradle build inspector, clarifies what's going on inside your Gradle build. Features:

  • Makes it easy to understand your task dependencies by generating a task dependency graph.

  • Makes it easy to know what files have changed on disk by running diff (windows not supported)

  • (incubating) Compare the differences in file changes on disk between two builds by using -PcompareLastBuild

Usage

Easy Setup: Navigate to the the Gradle Plugin Repository. Follow the directions hosted there to set up the latest release.

To install from source: Checkout and install locally:

> ./gradlew install

Then, add the plugin and mavenLocal() to your build:

buildscript {
    repositories {
        mavenLocal()
    }
    dependencies {
        classpath 'com.jakeout:gradle-inspector:+'
    }
}


allprojects {
    apply plugin: 'com.jakeout.gradle-inspector'
}

Features

Understanding Gradle Task graphs can be challenging. Gradle typically outputs a linear view of all of the tasks run during a build, with no sense of time or dependencies.

The Gradle build inspector elucidates the task graph by displaying it as a canvas directed-acyclic-graph using d3 as a rendering engine with dagre as a layout manager. Uses Kotlinx.html to generate html.

Inspector generates a task graph for each app / library it is applied to, and will attempt to link them if you apply it to all projects in a hierarchy.

Each task can be clicked and explored deeper. Tasks are colored "green" if they only have declared changes on disk. Tasks are colored blue if they have unexpected / undeclared side effects. A Gradle clean task deletes things, and therefore their removal is not explicitly declared as part of its output, though, most other gradle tasks are additive and so this can help identify missed side-effects.

Inspector is not intended to be a fast build tool. It shells out to the command line to run diff and outputs a buildProfile folder, caching the build folder after EVERY task runs. This means that it can be slow with large builds.

The shell'd out Diff output is read using Zutubi Diff, and

Diff report features:

  • new / fixed Show non-text files! -- Show files that have been added or deleted by a task. Show images / media content that change

  • Diffs files -- A handful of lines of files are shown, the rest are hidden and can be expanded.

  • Diffs between two builds -- compare the differences (e.g., compare two Gradle builds, before and after Gradle is updated). Currently, only tasks for the second build are shown in the directed acyclic graph.

  • Identify other running tasks and warns when diff may be inaccurate. Diff actions run at the start and end of each task, so if other tasks are running simultaneously, build behavior may produce strange outputs. (turning off parallel is recommended unless profiling this explicitly)

Output rows have red icons of files with questions marks (provided by Font awesome ) if they were not declared by the Gradle task. If the output was declared, but it was a folder, not a file, it has a subtle border splitting it from the child files that were modified within that declared folder.

Optional Properties

Run with -PpropertyName to enable

  • showInspection: to auto-open the web URL.

  • (incubating) compareLastBuild: Generates a report comparing this build's inputs and outputs against the last build you made. These changes are written to the report page for each task (above the normal report.) This can be handy (e.g., if you're trying to figure out what is different about a new version of a Gradle plugin.) This feature is slower and more disk intensive, because of great caching and comparisons being made.