substitute-local-geckoview.gradle

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 // Substitute a local GeckoView AAR into a consuming Gradle project.
   6 //
   7 // To use this, in a consuming Gradle project's `/build.gradle` add a stanza like:
   8 //
   9 // ext.topsrcdir = '/absolute/path/to/mozilla-central'; apply from: "${ext.topsrcdir}/substitute-local-geckoview.gradle"
  10 //
  11 // The object directory will be determined using `mach environment` and will agree with `./mach
  12 // gradle` and Android Studio.  Or, specify the exact object directory with a stanza like:
  13 //
  14 // ext.topsrcdir = '/absolute/path/to/mozilla-central'
  15 // ext.topobjdir = '/absolute/path/to/objdir'
  16 // apply from: "${ext.topsrcdir}/substitute-local-geckoview.gradle"
  17 //
  18 // Substitution works with artifact and non-artifact builds.
  19 //
  20 // If you get errors about .jar files not being found, ensure that the consuming
  21 // application is using a recent Android-Gradle plugin (say, 3.4+).  There were
  22 // issues with Jetifier, and issues with .jar vs. .aar extensions, in older
  23 // versions.
  24
  25 import groovy.json.JsonSlurper
  26
  27 def log(message) {
  28     logger.lifecycle("[substitute-local-geckoview] ${message}")
  29 }
  30
  31 if (!project.ext.has('topsrcdir')) {
  32     throw new GradleException("ext.topsrcdir must be specified to substitute for a local GeckoView")
  33 }
  34
  35 // Cribbed from https://hg.mozilla.org/mozilla-central/file/tip/settings.gradle.  When run in
  36 // topobjdir, `mach environment` correctly finds the mozconfig corresponding to that object
  37 // directory.
  38 def commandLine = ["${topsrcdir}/mach", "environment", "--format", "json", "--verbose"]
  39 def proc = commandLine.execute(null, new File(ext.has('topobjdir') ? ext.get('topobjdir') : topsrcdir))
  40 def standardOutput = new ByteArrayOutputStream()
  41 proc.consumeProcessOutput(standardOutput, standardOutput)
  42 proc.waitFor()
  43
  44 // Only show the output if something went wrong.
  45 if (proc.exitValue() != 0) {
  46     throw new GradleException("Process '${commandLine}' finished with non-zero exit value ${proc.exitValue()}:\n\n${standardOutput.toString()}")
  47 }
  48
  49 def slurper = new JsonSlurper()
  50 def mozconfig = slurper.parseText(standardOutput.toString())
  51
  52 if (topsrcdir != mozconfig.topsrcdir) {
  53     throw new GradleException("Specified topsrcdir ('${topsrcdir}') is not mozconfig topsrcdir ('${mozconfig.topsrcdir}')")
  54 }
  55
  56 if (!ext.has('topobjdir')) {
  57     ext.topobjdir = mozconfig.topobjdir
  58     log("Found topobjdir ${topobjdir} from topsrcdir ${topsrcdir}")
  59 }
  60
  61 if (mozconfig.substs.MOZ_BUILD_APP != 'mobile/android') {
  62     throw new GradleException("Building with Gradle is only supported for Fennec, i.e., MOZ_BUILD_APP == 'mobile/android'.")
  63 }
  64
  65 log("Will substitute GeckoView (geckoview-{nightly,beta}) with local GeckoView (geckoview-default) from ${topobjdir}/gradle/build/mobile/android/geckoview/maven")
  66
  67 if (!mozconfig.substs.COMPILE_ENVIRONMENT) {
  68     log("To update the local GeckoView, run `./mach gradle geckoview:publishWithGeckoBinariesDebugPublicationToMavenRepository` in ${topsrcdir}")
  69 } else {
  70     log("To update the local GeckoView, run `./mach build binaries && ./mach gradle geckoview:publishWithGeckoBinariesDebugPublicationToMavenRepository` in ${topsrcdir}")
  71 }
  72
  73 repositories {
  74     maven {
  75         name "Local GeckoView Maven repository"
  76         url "${topobjdir}/gradle/build/mobile/android/geckoview/maven"
  77     }
  78 }
  79
  80 configurations.all { config ->
  81     // Like `geckoview-nightly` for a multi-architecture fat AAR or
  82     // `geckoview-nightly-armeabi-v7a` for an architecture-specific AAR.
  83     def geckoviewModules = [
  84         'geckoview-nightly',
  85         'geckoview-nightly-armeabi-v7a',
  86         'geckoview-nightly-arm64-v8a',
  87         'geckoview-nightly-x86',
  88         'geckoview-nightly-x86_64',
  89         'geckoview-beta',
  90         'geckoview-beta-armeabi-v7a',
  91         'geckoview-beta-arm64-v8a',
  92         'geckoview-beta-x86',
  93         'geckoview-beta-x86_64',
  94     ]
  95
  96     def geckoviewOmniModules = [
  97         'geckoview-nightly-omni',
  98         'geckoview-nightly-omni-armeabi-v7a',
  99         'geckoview-nightly-omni-arm64-v8a',
 100         'geckoview-nightly-omni-x86',
 101         'geckoview-nightly-omni-x86_64',
 102         'geckoview-beta-omni',
 103         'geckoview-beta-omni-armeabi-v7a',
 104         'geckoview-beta-omni-arm64-v8a',
 105         'geckoview-beta-omni-x86',
 106         'geckoview-beta-omni-x86_64',
 107     ]
 108
 109     if (config.isCanBeResolved()) {
 110         config.resolutionStrategy { strategy ->
 111             dependencySubstitution {
 112                 all { dependency ->
 113                     // We could restrict based on target architecture, but there doesn't seem to
 114                     // be much advantage to doing so right now.
 115
 116                     if (!(dependency.requested instanceof ModuleComponentSelector)) {
 117                         // We can only substitute for a module: we're never going to substitute
 118                         // for a project.
 119                         return
 120                     }
 121
 122                     def group = dependency.requested.group
 123                     def module = dependency.requested.module
 124                     if (group == 'org.mozilla.geckoview'
 125                           && (geckoviewModules.contains(module) || geckoviewOmniModules.contains(module))) {
 126                         def name = ''
 127                         if (geckoviewOmniModules.contains(module)) {
 128                           name = 'geckoview-default-omni'
 129                         } else {
 130                           name = 'geckoview-default'
 131                         }
 132                         log("Substituting ${group}:${dependency.requested.module} with local GeckoView ${group}:${name} in ${config}")
 133
 134                         dependency.useTarget([group: group, name: name, version: '+'])
 135
 136                         // We substitute with a dynamic version ('+').  It seems that Gradle
 137                         // discovers the underlying AAR is out of date correctly based on file
 138                         // timestamp already, but let's try to avoid some class of cache
 139                         // invalidation error while we're here.
 140                         strategy.cacheDynamicVersionsFor 0, 'seconds'
 141                         strategy.cacheChangingModulesFor 0, 'seconds'
 142                     }
 143                 }
 144             }
 145         }
 146     }
 147 }