Merge pull request #123 from firebase/v11_SDK_support

Added support of Google Play Services v11 SDK.

Author: unEgor

.travis.yml

@@ -5,22 +5,56 @@ jdk: oraclejdk8
 # killed, so pretend sudo is required so we don't use the container infra.
 # See: https://github.com/travis-ci/travis-ci/issues/5582
 sudo: required
+
+env:
+    matrix:
+        - ANDROID_TARGET=android-16 ANDROID_ABI=armeabi-v7a
+        - ANDROID_TARGET=android-17 ANDROID_ABI=armeabi-v7a
+        - ANDROID_TARGET=android-18 ANDROID_ABI=armeabi-v7a
+        - ANDROID_TARGET=android-19 ANDROID_ABI=armeabi-v7a
+        - ANDROID_TARGET=android-21 ANDROID_ABI=armeabi-v7a
+    global:
+        - ADB_INSTALL_TIMEOUT=10 # Default is 2 minutes, bump to 10
+
 android:
     components:
         - tools
         - platform-tools
-        - build-tools-25.0.0
         - android-25
+        - build-tools-25.0.0
+
         - extra-android-m2repository
         - extra-google-m2repository
 
+        - sys-img-armeabi-v7a-android-16
+        - sys-img-armeabi-v7a-android-17
+        - sys-img-armeabi-v7a-android-18
+        - sys-img-armeabi-v7a-android-19
+        - sys-img-armeabi-v7a-android-21
+
 # "avoid uploading the cache after every build"
 before_cache:
     - rm -f $HOME/.gradle/caches/modules-2/modules-2.lock
     - rm -rf $HOME/.gradle/caches/*/plugin-resolution/
+
 cache:
     directories:
         - $HOME/.gradle/caches/
         - $HOME/.gradle/wrapper/
+        - $HOME/.android/build-cache
+
+before_script:
+    # Print the list of available targets to aid in debugging CI issues
+    - android list targets
+    # Create the AVD (name "test")
+    - echo no | android create avd --force --name test --target $ANDROID_TARGET --abi $ANDROID_ABI
+    # Start the emulator in the background
+    - emulator -avd test -no-skin -no-audio -no-window &
 
-script: ./gradlew jobdispatcher:build testapp:assemble
+script:
+    - android-wait-for-emulator
+    - adb devices
+    # Simulate hitting the menu button
+    - adb shell input keyevent 82 &
+    # Build the library + run unit tests, run device tests, build the test app
+    - ./gradlew jobdispatcher:build testapp:assemble

README.md

@@ -76,23 +76,12 @@ Play services is unavailable.<br>
 
 ### Installation
 
-If you **don't** have a dependency on
-[`com.google.android.gms:play-services-gcm`][gcm], add the following to your
-`build.gradle`'s dependencies section:
+Add the following to your `build.gradle`'s dependencies section:
 
 ```
-compile 'com.firebase:firebase-jobdispatcher:0.6.0'
+compile 'com.firebase:firebase-jobdispatcher:0.7.0'
 ```
 
-Otherwise add the following:
-
-```
-compile 'com.firebase:firebase-jobdispatcher-with-gcm-dep:0.6.0'
-```
-
-NOTE: These variants are a temporary requirement. Work is ongoing to consolidate
-them into the same bulid.
-
 ### Usage
 
 #### Writing a new JobService

common/constants.gradle

@@ -2,7 +2,7 @@
 project.ext {
     projectName = "firebase-jobdispatcher-android"
     group = "com.firebase"
-    version = "0.6.0"
+    version = "0.7.0"
     buildtools = "25.0.0"
     supportLibraryVersion = "25.0.0"
     compileSdk = 25

gcm_defs/build.gradle

@@ -13,9 +13,10 @@ android {
         targetSdkVersion project.ext.compileSdk
         versionCode 1
         versionName project.ext.version
+        testInstrumentationRunner 'android.support.test.runner.AndroidJUnitRunner'
     }
 
-    defaultPublishConfig "noDepRelease"
+    defaultPublishConfig "release"
     publishNonDefault true
 
     buildTypes {
@@ -28,34 +29,32 @@ android {
         }
     }
 
-    productFlavors {
-        withGcmDep
-        noDep
+    sourceSets {
+        // A set of testing helpers that are shared across test types
+        testLib     { java.srcDir("src/main") }
+        test        { java.srcDir("src/testLib") } // Robolectric tests
+        androidTest { java.srcDir("src/testLib") } // Android (e2e) tests
     }
 }
 
 dependencies {
-    testCompile 'junit:junit:4.12'
-    testCompile 'org.robolectric:robolectric:3.1.2'
-    testCompile 'org.mockito:mockito-core:2.2.5'
+    // The main library only depends on the Android support lib
     compile "com.android.support:support-v4:${project.ext.supportLibraryVersion}"
-    // In a perfect world we'd have these dependencies totally handled by the
-    // Android plugin using a combination of "provided" (compile-time only) and
-    // "package" (runtime only) rules:
-    //
-    // noDepCompile project(":gcm_defs")
-    // withGcmDepProvided project(":gcm_defs")
-    //
-    // Unfortunately this doesn't work. We can't import the same project with
-    // different visibility settings because the Android plugin reuses the
-    // same identifier when it creates the necessary backing rules, so we get a
-    // dupe rule error.
-    //
-    // So, instead we mark the gcm_defs as provided (compile-time only) and
-    // manually copy the required classes into the noDep flavor (below).
-    provided project(':gcm_defs')
-    // the withGcmDep version has an explicit dependency on the GCM library.
-    withGcmDepCompile "com.google.android.gms:play-services-gcm:10.0.1"
+
+    def junit = 'junit:junit:4.12'
+    def robolectric = 'org.robolectric:robolectric:3.3.2'
+
+    // The common test library uses JUnit
+    testLibCompile junit
+
+    // The unit tests are written using JUnit, Robolectric, and Mockito
+    testCompile junit
+    testCompile robolectric
+    testCompile 'org.mockito:mockito-core:2.2.5'
+
+    // The Android (e2e) tests are written using JUnit and the test support lib
+    androidTestCompile junit
+    androidTestCompile 'com.android.support.test:runner:0.5'
 }
 
 task javadocs(type: Javadoc) {
@@ -84,22 +83,8 @@ task aar(dependsOn: "assembleRelease") {
 }
 
 // Artifact descriptions (surfaced in JCenter / Maven)
-def noDepDesc = "The Firebase JobDispatcher is a library that provides a common" +
+def artifactDesc = "The Firebase JobDispatcher is a library that provides a common" +
     " interface to scheduling engines on Android."
-def withGcmDepDesc = noDepDesc + " This version should be used by anyone with a" +
-    " dependency on the legacy GCM library (com.google.android.gms:play-services-gcm)."
-
-// Maps flavors to descriptions + artifacts
-def flavorsToPublicationsMap = [
-    noDep: [
-        description: noDepDesc,
-        artifactId: "firebase-jobdispatcher",
-    ],
-    withGcmDep: [
-        description: withGcmDepDesc,
-        artifactId: "firebase-jobdispatcher-with-gcm-dep",
-    ],
-]
 
 publishing {
     repositories {
@@ -111,18 +96,28 @@ publishing {
     }
 
     publications {
-        // Create a new MavenPublication for each of the flavors (noDep, withGcmDep)
-        android.productFlavors.each { flavor ->
-            "dispatcher${flavor.name.capitalize()}Library"(MavenPublication) {
-                artifactId flavorsToPublicationsMap[flavor.name].artifactId
+        // The initial FJD releases had two artifacts; one for users that
+        // already had a dependency on the gcm client library and one for users
+        // that didn't. There's no longer a need for these two variants, but we
+        // continue to produce the -with-gcm-dep version (identical to the
+        // standard artifact) to prevent breaking clients.
+        //
+        // TODO(ciarandowney): add a deprecation notice pointing users to the
+        //                     regular version
+        [
+          standardArtifact: "firebase-jobdispatcher",
+          legacyArtifact: "firebase-jobdispatcher-with-gcm-dep",
+        ].each { key, value ->
+            "dispatcherLibrary${key.capitalize()}"(MavenPublication) {
+                artifactId value
                 groupId project.ext.group
                 version project.ext.version
 
                 // Add the AAR artifact
-                artifact("${buildDir}/outputs/aar/jobdispatcher-${flavor.name}-release.aar") {
+                artifact("${buildDir}/outputs/aar/jobdispatcher-release.aar") {
                     // wrap in a closure because this task isn't defined 'till
                     // the android plugin finishes
-                    builtBy { tasks["bundle${flavor.name.capitalize()}Release"] }
+                    builtBy { tasks["bundleRelease"] }
                 }
                 // Add the sources and javadoc JARs
                 artifact sourcesJar
@@ -132,7 +127,7 @@ publishing {
                 pom.withXml {
                     def n = asNode()
 
-                    n.appendNode("description", flavorsToPublicationsMap[flavor.name].description)
+                    n.appendNode("description", artifactDesc)
                     n.appendNode("inceptionYear", 2016)
 
                     def licensesNode = n.appendNode("licenses")
@@ -168,76 +163,27 @@ publishing {
                         dependencyNode.appendNode('groupId', it.group)
                         dependencyNode.appendNode('artifactId', it.name)
                         dependencyNode.appendNode('version', it.version)
+                        dependencyNode.appendNode('type', 'aar')
                     }
 
                     // add deps that everyone has
                     configurations.compile.allDependencies.each addDep
                     // add config specific deps
-                    configurations["${flavor.name}Compile"].allDependencies.each addDep
+                    configurations["releaseCompile"].allDependencies.each addDep
                 }
             }
         }
     }
 }
 
-// Merges required classes into the resulting AAR (UberJAR style). Without
-// this, the classes from gcm_defs wouldn't be packed into the AAR. We also
-// need to make sure that the withGcmDeps flavor doesn't include the GCM
-// parcelables.
 afterEvaluate {
-    android.productFlavors.each { flavor ->
-        android.buildTypes.each { bt ->
-            def artifactName = "gcm_defs-release"
-            def jarDestDir = "${buildDir}/intermediates/libs/${flavor.name}/${bt.name}/libs"
-            def unpackedDestDir = "${buildDir}/unpacked/${artifactName}"
-
-            def copyLibs = task("copy${flavor.name.capitalize()}${bt.name.capitalize()}Libs",
-                                 type: Copy) {
-                description "Copies gcm_defs aar into the build dir"
-
-                from configurations.provided
-                include "${artifactName}.aar"
-                into jarDestDir
-            }
-
-            def unzipClasses = task("unzip${flavor.name.capitalize()}${bt.name.capitalize()}Libs",
-                                     type: Copy, dependsOn: copyLibs) {
-                description "Unzips the copied gcm_defs aar contents"
-
-                from zipTree("${jarDestDir}/${artifactName}.aar")
-                into unpackedDestDir
-            }
-
-            def syncClasses = task("sync${flavor.name.capitalize()}${bt.name.capitalize()}Libs",
-                                    type: Copy, dependsOn: unzipClasses) {
-                description "Merges the copied gcm_defs classes with the aar classes"
-
-                from(zipTree("${unpackedDestDir}/classes.jar")) {
-                    exclude "**/BuildConfig.class"
-
-                    if (flavor.name == "withGcmDep") {
-                        // Parcelable included unobfuscated in the GCM lib
-                        exclude "**/com/google/android/gms/gcm/PendingCallback*.class"
-
-                        // AIDL-derived IBinder that's obfuscated in the GCM
-                        // lib, so we don't have to (and shouldn't) strip our
-                        // copy because it doesn't conflict.
-                        // exclude "**/com/google/android/gms/gcm/INetworkTaskCallback*.class"
-                    }
-                }
-                into "${buildDir}/intermediates/classes/${flavor.name}/${bt.name}"
-            }
-
-            def jarTask = tasks["process${flavor.name.capitalize()}${bt.name.capitalize()}JavaRes"]
-            jarTask.dependsOn syncClasses
-        }
-    }
-
     bintray {
         user = findProperty("BINTRAY_USER") ?: System.getenv("BINTRAY_USER")
         key = findProperty("BINTRAY_KEY") ?: System.getenv("BINTRAY_KEY")
 
-        publications = ["dispatcherNoDepLibrary", "dispatcherWithGcmDepLibrary"]
+        publications = [
+            "dispatcherLibraryStandardArtifact",
+            "dispatcherLibraryLegacyArtifact"]
 
         pkg {
             userOrg = "firebase"

gcm_defs/src/main/AndroidManifest.xml

@@ -21,16 +21,16 @@ android {
 // ignore these when generating coverage
 def ignoredPrefixes = ['R$', 'R.class', 'BuildConfig.class']
 
-task coverage(type: JacocoReport, dependsOn: ["testNoDepDebugUnitTest"]) {
+task coverage(type: JacocoReport, dependsOn: ["testDebugUnitTest"]) {
     group = "Reports"
     description = "Generate a coverage report"
 
     classDirectories = fileTree(
-        dir: "${project.buildDir}/intermediates/classes/noDep/debug/com/firebase/",
+        dir: "${project.buildDir}/intermediates/classes/debug/com/firebase/",
         exclude: { d -> ignoredPrefixes.any { p -> d.file.name.startsWith(p) } }
     )
     sourceDirectories = files(["src/main/java/com/firebase/"])
-    executionData = files("${project.buildDir}/jacoco/testNoDepDebugUnitTest.exec")
+    executionData = files("${project.buildDir}/jacoco/testDebugUnitTest.exec")
 
     reports {
         xml.enabled = true

jobdispatcher/build.gradle

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+ Copyright 2017 Google 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.
+-->
+<manifest
+    xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.firebase.jobdispatcher">
+
+    <uses-sdk android:minSdkVersion="14" />
+    <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
+
+    <instrumentation
+        android:targetPackage="com.firebase.jobdispatcher"
+        android:name="android.test.InstrumentationTestRunner" />
+
+    <application>
+        <service android:exported="false" android:name=".TestJobService">
+            <intent-filter>
+                <action android:name="com.firebase.jobdispatcher.ACTION_EXECUTE"/>
+            </intent-filter>
+        </service>
+    </application>
+</manifest>