Mirakle

A Gradle plugin that allows you to move build process from a local machine to a remote one.

Compatible with Gradle 7.0+. Works seamlessly with IntelliJ IDEA and Android Studio.

Why

Remote machine supposed to be much performant than your working machine. Also having a sufficient network bandwidth or small amount of data that your build produce, you gain build speed boost.

Mirakle is designed specially for Gradle build system. It works as seamless as possible. Once plugin installed, you workflow will not be different at all.

(It's a good thing to prank your colleague. Imagine his surprise when one day he gets several times faster build time.)

5 minutes read on Medium by Guillermo Merino Jiménez & David Pastor Herranz

Long read on habr.com in Russian by LuigiVampa

Setup

Put this into USER_HOME/.gradle/init.d/mirakle_init.gradle on local machine

initscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'io.github.adambl4:mirakle:1.6.0'
    }
}
 
apply plugin: Mirakle
 
rootProject {
    mirakle {
        host "your_remote_machine"
    }
}

Usage

> ./gradlew build

Here's Mirakle. All tasks will be executed on a remote machine.
:uploadToRemote
:executeOnRemote
...remote build output...
:downloadFromRemote
 

BUILD SUCCESSFUL
 
Total time : 7.975 secs
Task uploadToRemote took: 2.237 secs
Task executeOnRemote took: 3.706 secs
Task downloadFromRemote took: 1.597 secs

To disable remote execution pass -x mirakle

> ./gradlew build install -x mirakle

Opt-in execution

By default Mirakle is executing everytime unless -x is provided. To reverse this behaviour add if statement to init script:

if (startParameter.taskNames.contains("mirakle")) {
    apply plugin: Mirakle

    rootProject {
        mirakle {
            ...
        }
    }
}

> ./gradlew heavyBuild mirakle

Configuration

mirakle {
    host "true-remote"
    
    //optional
    remoteFolder ".mirakle"
    excludeLocal += ["foo"]
    excludeRemote += ["bar"]
    excludeCommon += ["**/foobar"]
    rsyncToRemoteArgs += ["--stats", "-h"]
    rsyncFromRemoteArgs += ["--compress-level=5", "--stats", "-h"]
    sshArgs += ["-p 22"]
    fallback true
    downloadInParallel true
    downloadInterval 2000
    breakOnTasks = ["install", "package"] // regex pattern
    remoteBashCommand = "echo 'Hello World!'"
}

Parameter	Default value	Description
host	required	Name of remote machine.
remoteFolder	`"~/mirakle"`	Remote folder where mirakle uploads project files.
excludeLocal	`["**/build"]`	Set of exclude patterns of local files for rsync when it uploads files to remote machine.
excludeRemote	`["**/src/"]`	Set of exclude patterns of remote files for rsync when it downloads files from remote machine.
excludeCommon	`[".gradle", ".idea", "/.git/", "/local.properties", "/mirakle.properties", "/mirakle_local.properties"]`	Set of exclude patterns for rsync for both upload and download.
rsyncToRemoteArgs	`["--archive", "--delete"]`	Set of rsync arguments that are used when rsync uploads files to remote machine.
rsyncFromRemoteArgs	`["--archive", "--delete"]`	Set of rsync arguments that are used when rsync downloads files from remote machine.
sshArgs	`[]`	Set of ssh arguments that are used to establish connection with remote machine.
sshClient	`ssh`	Ssh client implementation, for example Teleport ssh.
fallback	`false`	If set true mirakle will execute build on local machine when upload to remote failed.
downloadInParallel	`false`	If set true mirakle will constantly fetch new files from remote machine during "executeOnRemote" phase of build. May result to reduction of total build time.
downloadInterval	`2000`	Download in parallel interval in mills.
breakOnTasks	`[]`	Set of regex patterns of tasks on which remote build should be finished and continued on local machine. May result in speeding up Android builds.
remoteBashCommand	`null`	Additional remote bash command which will be executed before Gradle build

Per-project config

You can configure Mirakle differently for any project. There's two ways:

In USER_HOME/.gradle/init.d/mirakle_init.gradle

initscript { .. }
 
apply plugin: Mirakle
 
rootProject {
    if (name == "My Home Project") {
        mirakle {
            host "my-build-server"
            sshArgs += ["-p 222"]
        }
    } else {
        mirakle {
            host "office-build-server"
        }
    }
}

In PROJECT_DIR/mirakle.gradle. This is useful if you want too add the config to VCS.

mirakle {
    host "my-build-server"
    sshArgs += ["-p 222"]
}

Note: mirakle.gradle is the only Gradle build file in the project dir which is evaluated on local machine. Other build files are ignored for the sake of saving time.

Mainframer config is also supported.

Contributing

License

Copyright 2017 Instamotor, Inc.

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.

skrugly/mirakle