bluepeople1 / genymotion-gradle-plugin Goto Github PK

#Gradle Plugin for Genymotion

##Gradle Plugin Documentation

Here is a short description on how to use the Gradle plugin for Genymotion into your build.gradle.

###Including the plugin

To use our plugin, you need first to reference our plugin’s repository. Here is what your build.gradle should look like:

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.genymotion:plugin:1.0'
    }
}

Then, apply the plugin. Insert this line into your build.gradle:

apply plugin: "genymotion"

###Using the plugin When this is done you can access to the Genymotion’s Gradle features. You can open a genymotion section and start defining your devices like this:

genymotion {
    devices {
        nexus5 {
            template "Google Nexus 5 - 4.4.4 - API 19 - 1080x1920"
        }
    }
}

This simple example will create and launch a Nexus 5 running KitKat right before the connectedAndroidTest task. But this plugin can do a lot more, read the full documentation for an exhaustive explanation.

##Downloading the plugin's source code

To download the plugin, run:

git clone https://github.com/Genymobile/genymotion-gradle-plugin.git

##Project description

The plugin folder contains the Gradle plugin.

The samples folder contains the example project using the Gradle plugin.

##Compiling the plugin

To compile the plugin, go to the root project folder and run the following command:

./gradlew :plugin:uploadArchives

The build result is a Maven repository. It will be pushed into a new folder: repo

You can now use the plugin as a simple repository. To add it to your project, you must add these lines to your build.gradle file:

buildscript {
    repositories {
        maven { url uri('<path/to/local/repo>') }
    }
    dependencies {
        classpath 'com.genymotion:plugin:+'
    }
}

For more information on how to use the plugin, please refer to the official documentation

Coming soon...

##Give a try

Execute the sample "simple" using this command:

cd samples
../gradlew :simple:genymotionLaunch

This starts a virtual device on your computer.

##Contributing

The Gradle Plugin for Genymotion is an open source project under GPL v3 license.

Pull requests are strongly encouraged.

Before pulling, you need to run the functional tests on the project. You can run it with the command:

./gradlew :plugin:test

Before running the tests you need gmtool, the command line tool for Genymotion.

You also need to fill a few files like follows:

1. Copy the plugin/res/test/default.properties.TEMPLATE file and name it default.properties
2. Fill the new file with your information (genymotion username, password, license) and the path to your local Genymotion installation (genymotionPath).
3. Also, in the file plugin/res/test/android-app/local.properties precise the sdk.dir field with your Android SDK path