Merge pull request #12 from raghuhit/buildVariantsSupport

Build variants support

Author: raghuhit

.gitignore

@@ -4,3 +4,6 @@ build/
 .classpath
 .settings/
 bin/
+.idea/
+out/
+espresso-browserstack/

README.md

@@ -4,24 +4,58 @@ This repository contains the source code for BrowserStack's Gradle plugin.
 
 <br/>
 
->Note: For now this plugin supports Espresso tests.
+## PURPOSE
 
-## Espresso
+This plugin consists of two types of tasks:
 
-Add to build.gradle:
+1. Builds, uploads and starts Espresso tests on BrowserStack AppAutomate.
+2. Builds and uploads apk to BrowserStack AppLive for manual testing.
 
-    plugins {
-        id: com.browserstack.gradle
-    }
+## USAGE
 
-    runDebugBuildOnBrowserstack {
-        username = "<username>"
-        accessKey = "<accessKey>"
-        devices = ['Google Pixel-7.1']
-    }
+### Add to build.gradle
 
+#### Add plugin dependency to module's build.gradle
 
-Supported parameters:
+```
+plugins {
+    id "com.browserstack.gradle" version "2.3.0"
+}
+```
+
+#### Add browserStackConfig parameters to module's build.gradle
+
+```
+browserStackConfig {
+    username = "<browserstack_username>"
+    accessKey = "<browserstack_access_key>"
+    devices = ['Google Pixel-7.1']
+}
+```
+
+### Tasks
+
+#### Espresso test task
+Builds, uploads and start Espresso tests on BrowserStack AppAutomate.
+
+##### Gradle command
+
+gradle clean execute${buildVariantName}TestsOnBrowserstack
+
+For running tests on a project with no variants, you can simply run following command for uploading and running tests on debug apk:
+
+```
+gradle clean executeDebugTestsOnBrowserstack
+```
+
+And for projects with productFlavors, replace ${buildVariantName} with your build variant name, for example if your productFlavor name is "phone" and you want to test debug build type of this variant then command will be
+
+```
+gradle clean executePhoneDebugTestsOnBrowserstack
+
+```
+
+##### Supported browserStackConfig parameters
 
     username: String
     accessKey: String
@@ -39,45 +73,51 @@ Supported parameters:
     callbackURL: String
     networkProfile: String
 
+> Note: username, accessKey and devices are mandatory parameters. Visit https://www.browserstack.com/app-automate/espresso/get-started to get started with Espresso Tests on BrowserStack and also to know more about the above mentioned parameters.
 
-> Note: username, accessKey and devices are compulsory parameters. Visit https://www.browserstack.com/app-automate/espresso/get-started to get started with Espresso Tests on BrowserStack and also to know more about the above mentioned parameters.
-
-> Note: List of supported devices and be found [here](https://api.browserstack.com/app-automate/espresso/devices.json) (basic auth required).
-
-To run an Espresso test on BrowserStack using this plugin, use the following command:
+> Note: List of supported devices and be found [here](https://api.browserstack.com/app-automate/espresso/devices.json) (basic auth required). For example :``` curl -u "$BROWSERSTACK_USERNAME:$BROWSERSTACK_ACCESS_KEY" https://api-cloud.browserstack.com/app-automate/devices.json ```
 
-    gradle runDebugBuildOnBrowserstack
+> Note: You can also set the values of username and accessKey in environment variables with names BROWSERSTACK_USERNAME and BROWSERSTACK_ACCESS_KEY, respectively. If you do this, then there is no need to set this parameters in browserStackConfig block.
 
-This will execute the following:
+##### Internal steps
 
- 1. Build debug and test apks, as dependencies are declared on `assembleDebug` and `assembleDebugAndroidTest` tasks.
+ 1. Build debug and test apks, as dependencies are declared on `assemble${buildvariantName}` and `assemble${buildvariantName}AndroidTest` tasks.
  2. Find the latest apks in the app directory recursively.
- 3. Upload both the apks on BrowserStack platform.
+ 3. Upload both the apks on BrowserStack AppAutomate platform.
  4. Execute Espresso test using the uploaded apps on the devices mentioned.
 
-### Using this plugin in android studio
+#### Upload to AppLive task
 
-Add this plugin to your `buildscript`:
+##### Gradle command
 
-```
-buildscript {
-  repositories {
-    maven {
-      url "https://plugins.gradle.org/m2/"
-    }
-  }
-  dependencies {
-    classpath 'com.browserstack.gradle:com.browserstack.gradle.gradle.plugin:2.2.0'
-  }
-}
-```
+gradle clean upload${buildVariantName}ToBrowserstackAppLive
 
-and apply it in your module build.gradle 
+For running tests on a project with no variants, you can simply run following command for uploading debug apk:
 
 ```
-apply plugin: 'com.browserstack.gradle'
+gradle clean uploadDebugToBrowserstackAppLive 
 ```
 
+And for projects with productFlavors, replace ${buildVariantName} with your build variant name, for example if your productFlavor name is "phone" and you want to upload debug build type of this variant then command will be gradle clean uploadPhoneDebugToBrowserstackAppLive.
+
+##### Supported browserStackConfig parameters
+
+    username: String
+    accessKey: String
+
+> Note: username and accessKey are mandatory parameters.
+
+##### Internal steps
+
+ 1. Build debug and test apks, as dependencies are declared on `assemble${buildvariantName}` .
+ 2. Find the latest apk in the app directory recursively.
+ 3. Upload the apk on BrowserStack AppLive platform.
+ 
+
+> Note: You can also set the values of username and accessKey in environment variables with names BROWSERSTACK_USERNAME and BROWSERSTACK_ACCESS_KEY, respectively. If you do this, then there is no need to set these parameters in browserStackConfig block.
+
+> Note: You can also see all possible tasks by running "gradle tasks -all"
+
 ### Development
 
 Build the plugin

build.gradle

@@ -3,7 +3,7 @@ plugins {
     id 'com.gradle.plugin-publish' version '0.9.10'
 }
 
-version '2.2.0'
+version '2.3.0'
 
 pluginBundle {
     website = 'https://www.browserstack.com'
@@ -19,3 +19,12 @@ pluginBundle {
         }
     }
 }
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    // https://mvnrepository.com/artifact/com.android.tools.build/gradle
+    compile group: 'com.android.tools.build', name: 'gradle', version: '2.3.0'
+}

src/main/java/com/browserstack/gradle/AppUploadTask.java

@@ -7,7 +7,7 @@
 
 public class AppUploadTask extends BrowserStackTask {
 
-  private void displayTestURL(String app_url){
+  private void displayTestURL(String app_url) {
     String app_hashed_id = app_url.substring(5);
     System.out.println("Start testing at " + Constants.APP_LIVE_HOST + "/#app_hashed_id=" + app_hashed_id);
   }

src/main/java/com/browserstack/gradle/BrowserStackConfigExtension.java

@@ -0,0 +1,154 @@
+package com.browserstack.gradle;
+
+// This class is for getting browserstack configuration from gradle file.
+public class BrowserStackConfigExtension {
+
+  private String username = System.getenv("BROWSERSTACK_USERNAME");
+  private String accessKey = System.getenv("BROWSERSTACK_ACCESS_KEY");
+
+  private String[] classes, annotations, packages, sizes, otherApps;
+
+  private boolean video = Constants.DEFAULT_VIDEO;
+  private boolean deviceLogs = Constants.DEFAULT_DEVICE_LOGS;
+  private boolean local = Constants.DEFAULT_LOCAL;
+  private boolean networkLogs = Constants.DEFAULT_NETWORK_LOGS;
+
+  String[] devices;
+
+  private String callbackURL, localIdentifier, networkProfile;
+
+  public String getUsername() {
+    return username;
+  }
+
+  public String getAccessKey() {
+    return accessKey;
+  }
+
+  public String[] getClasses() {
+    if (classes == null) {
+      classes = new String[0];
+    }
+    return classes;
+  }
+
+  public String[] getAnnotations() {
+    if (annotations == null) {
+      annotations = new String[0];
+    }
+    return annotations;
+  }
+
+  public String[] getPackages() {
+    if (packages == null) {
+      packages = new String[0];
+    }
+    return packages;
+  }
+
+  public String[] getSizes() {
+    if (sizes == null) {
+      sizes = new String[0];
+    }
+    return sizes;
+  }
+
+  public String[] getOtherApps() {
+    if (otherApps == null) {
+      otherApps = new String[0];
+    }
+    return otherApps;
+  }
+
+  public boolean isVideo() {
+    return video;
+  }
+
+  public boolean isDeviceLogs() {
+    return deviceLogs;
+  }
+
+  public boolean isLocal() {
+    return local;
+  }
+
+  public boolean isNetworkLogs() {
+    return networkLogs;
+  }
+
+  public String[] getDevices() {
+    return devices;
+  }
+
+  public String getCallbackURL() {
+    return callbackURL;
+  }
+
+  public String getLocalIdentifier() {
+    return localIdentifier;
+  }
+
+  public String getNetworkProfile() {
+    return networkProfile;
+  }
+
+  public void setUsername(String username) {
+    this.username = username;
+  }
+
+  public void setAccessKey(String accessKey) {
+    this.accessKey = accessKey;
+  }
+
+  public void setClasses(String[] classes) {
+    this.classes = classes;
+  }
+
+  public void setAnnotations(String[] annotations) {
+    this.annotations = annotations;
+  }
+
+  public void setPackages(String[] packages) {
+    this.packages = packages;
+  }
+
+  public void setSizes(String[] sizes) {
+    this.sizes = sizes;
+  }
+
+  public void setOtherApps(String[] otherApps) {
+    this.otherApps = otherApps;
+  }
+
+  public void setVideo(boolean video) {
+    this.video = video;
+  }
+
+  public void setDeviceLogs(boolean deviceLogs) {
+    this.deviceLogs = deviceLogs;
+  }
+
+  public void setLocal(boolean local) {
+    this.local = local;
+  }
+
+  public void setNetworkLogs(boolean networkLogs) {
+    this.networkLogs = networkLogs;
+  }
+
+  public void setDevices(String[] devices) {
+    this.devices = devices;
+  }
+
+  public void setCallbackURL(String callbackURL) {
+    this.callbackURL = callbackURL;
+  }
+
+  public void setLocalIdentifier(String localIdentifier) {
+    this.localIdentifier = localIdentifier;
+  }
+
+  public void setNetworkProfile(String networkProfile) {
+    this.networkProfile = networkProfile;
+  }
+}