Initial implementation of 'org.mozilla.appservices' Gradle plugin.

I made this a stand-alone Gradle project, rather than a sub-project of
the root Gradle project, because it's rare that Application Services
engineers will want to touch this code; and because I don't want to
mix publishing the plugin in with publishing the mainline feature
modules.
This commit is contained in:
Edouard Oger 2018-12-13 16:09:12 -05:00 коммит произвёл Nick Alexander
Родитель 91098f4407
Коммит 96542d9250
14 изменённых файлов: 1442 добавлений и 0 удалений

Просмотреть файл

@ -0,0 +1,3 @@
# 0.1.0
Initial implementation.

373
gradle-plugin/LICENSE Normal file
Просмотреть файл

@ -0,0 +1,373 @@
Mozilla Public License Version 2.0
==================================
1. Definitions
--------------
1.1. "Contributor"
means each individual or legal entity that creates, contributes to
the creation of, or owns Covered Software.
1.2. "Contributor Version"
means the combination of the Contributions of others (if any) used
by a Contributor and that particular Contributor's Contribution.
1.3. "Contribution"
means Covered Software of a particular Contributor.
1.4. "Covered Software"
means Source Code Form to which the initial Contributor has attached
the notice in Exhibit A, the Executable Form of such Source Code
Form, and Modifications of such Source Code Form, in each case
including portions thereof.
1.5. "Incompatible With Secondary Licenses"
means
(a) that the initial Contributor has attached the notice described
in Exhibit B to the Covered Software; or
(b) that the Covered Software was made available under the terms of
version 1.1 or earlier of the License, but not also under the
terms of a Secondary License.
1.6. "Executable Form"
means any form of the work other than Source Code Form.
1.7. "Larger Work"
means a work that combines Covered Software with other material, in
a separate file or files, that is not Covered Software.
1.8. "License"
means this document.
1.9. "Licensable"
means having the right to grant, to the maximum extent possible,
whether at the time of the initial grant or subsequently, any and
all of the rights conveyed by this License.
1.10. "Modifications"
means any of the following:
(a) any file in Source Code Form that results from an addition to,
deletion from, or modification of the contents of Covered
Software; or
(b) any new file in Source Code Form that contains any Covered
Software.
1.11. "Patent Claims" of a Contributor
means any patent claim(s), including without limitation, method,
process, and apparatus claims, in any patent Licensable by such
Contributor that would be infringed, but for the grant of the
License, by the making, using, selling, offering for sale, having
made, import, or transfer of either its Contributions or its
Contributor Version.
1.12. "Secondary License"
means either the GNU General Public License, Version 2.0, the GNU
Lesser General Public License, Version 2.1, the GNU Affero General
Public License, Version 3.0, or any later versions of those
licenses.
1.13. "Source Code Form"
means the form of the work preferred for making modifications.
1.14. "You" (or "Your")
means an individual or a legal entity exercising rights under this
License. For legal entities, "You" includes any entity that
controls, is controlled by, or is under common control with You. For
purposes of this definition, "control" means (a) the power, direct
or indirect, to cause the direction or management of such entity,
whether by contract or otherwise, or (b) ownership of more than
fifty percent (50%) of the outstanding shares or beneficial
ownership of such entity.
2. License Grants and Conditions
--------------------------------
2.1. Grants
Each Contributor hereby grants You a world-wide, royalty-free,
non-exclusive license:
(a) under intellectual property rights (other than patent or trademark)
Licensable by such Contributor to use, reproduce, make available,
modify, display, perform, distribute, and otherwise exploit its
Contributions, either on an unmodified basis, with Modifications, or
as part of a Larger Work; and
(b) under Patent Claims of such Contributor to make, use, sell, offer
for sale, have made, import, and otherwise transfer either its
Contributions or its Contributor Version.
2.2. Effective Date
The licenses granted in Section 2.1 with respect to any Contribution
become effective for each Contribution on the date the Contributor first
distributes such Contribution.
2.3. Limitations on Grant Scope
The licenses granted in this Section 2 are the only rights granted under
this License. No additional rights or licenses will be implied from the
distribution or licensing of Covered Software under this License.
Notwithstanding Section 2.1(b) above, no patent license is granted by a
Contributor:
(a) for any code that a Contributor has removed from Covered Software;
or
(b) for infringements caused by: (i) Your and any other third party's
modifications of Covered Software, or (ii) the combination of its
Contributions with other software (except as part of its Contributor
Version); or
(c) under Patent Claims infringed by Covered Software in the absence of
its Contributions.
This License does not grant any rights in the trademarks, service marks,
or logos of any Contributor (except as may be necessary to comply with
the notice requirements in Section 3.4).
2.4. Subsequent Licenses
No Contributor makes additional grants as a result of Your choice to
distribute the Covered Software under a subsequent version of this
License (see Section 10.2) or under the terms of a Secondary License (if
permitted under the terms of Section 3.3).
2.5. Representation
Each Contributor represents that the Contributor believes its
Contributions are its original creation(s) or it has sufficient rights
to grant the rights to its Contributions conveyed by this License.
2.6. Fair Use
This License is not intended to limit any rights You have under
applicable copyright doctrines of fair use, fair dealing, or other
equivalents.
2.7. Conditions
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
in Section 2.1.
3. Responsibilities
-------------------
3.1. Distribution of Source Form
All distribution of Covered Software in Source Code Form, including any
Modifications that You create or to which You contribute, must be under
the terms of this License. You must inform recipients that the Source
Code Form of the Covered Software is governed by the terms of this
License, and how they can obtain a copy of this License. You may not
attempt to alter or restrict the recipients' rights in the Source Code
Form.
3.2. Distribution of Executable Form
If You distribute Covered Software in Executable Form then:
(a) such Covered Software must also be made available in Source Code
Form, as described in Section 3.1, and You must inform recipients of
the Executable Form how they can obtain a copy of such Source Code
Form by reasonable means in a timely manner, at a charge no more
than the cost of distribution to the recipient; and
(b) You may distribute such Executable Form under the terms of this
License, or sublicense it under different terms, provided that the
license for the Executable Form does not attempt to limit or alter
the recipients' rights in the Source Code Form under this License.
3.3. Distribution of a Larger Work
You may create and distribute a Larger Work under terms of Your choice,
provided that You also comply with the requirements of this License for
the Covered Software. If the Larger Work is a combination of Covered
Software with a work governed by one or more Secondary Licenses, and the
Covered Software is not Incompatible With Secondary Licenses, this
License permits You to additionally distribute such Covered Software
under the terms of such Secondary License(s), so that the recipient of
the Larger Work may, at their option, further distribute the Covered
Software under the terms of either this License or such Secondary
License(s).
3.4. Notices
You may not remove or alter the substance of any license notices
(including copyright notices, patent notices, disclaimers of warranty,
or limitations of liability) contained within the Source Code Form of
the Covered Software, except that You may alter any license notices to
the extent required to remedy known factual inaccuracies.
3.5. Application of Additional Terms
You may choose to offer, and to charge a fee for, warranty, support,
indemnity or liability obligations to one or more recipients of Covered
Software. However, You may do so only on Your own behalf, and not on
behalf of any Contributor. You must make it absolutely clear that any
such warranty, support, indemnity, or liability obligation is offered by
You alone, and You hereby agree to indemnify every Contributor for any
liability incurred by such Contributor as a result of warranty, support,
indemnity or liability terms You offer. You may include additional
disclaimers of warranty and limitations of liability specific to any
jurisdiction.
4. Inability to Comply Due to Statute or Regulation
---------------------------------------------------
If it is impossible for You to comply with any of the terms of this
License with respect to some or all of the Covered Software due to
statute, judicial order, or regulation then You must: (a) comply with
the terms of this License to the maximum extent possible; and (b)
describe the limitations and the code they affect. Such description must
be placed in a text file included with all distributions of the Covered
Software under this License. Except to the extent prohibited by statute
or regulation, such description must be sufficiently detailed for a
recipient of ordinary skill to be able to understand it.
5. Termination
--------------
5.1. The rights granted under this License will terminate automatically
if You fail to comply with any of its terms. However, if You become
compliant, then the rights granted under this License from a particular
Contributor are reinstated (a) provisionally, unless and until such
Contributor explicitly and finally terminates Your grants, and (b) on an
ongoing basis, if such Contributor fails to notify You of the
non-compliance by some reasonable means prior to 60 days after You have
come back into compliance. Moreover, Your grants from a particular
Contributor are reinstated on an ongoing basis if such Contributor
notifies You of the non-compliance by some reasonable means, this is the
first time You have received notice of non-compliance with this License
from such Contributor, and You become compliant prior to 30 days after
Your receipt of the notice.
5.2. If You initiate litigation against any entity by asserting a patent
infringement claim (excluding declaratory judgment actions,
counter-claims, and cross-claims) alleging that a Contributor Version
directly or indirectly infringes any patent, then the rights granted to
You by any and all Contributors for the Covered Software under Section
2.1 of this License shall terminate.
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
end user license agreements (excluding distributors and resellers) which
have been validly granted by You or Your distributors under this License
prior to termination shall survive termination.
************************************************************************
* *
* 6. Disclaimer of Warranty *
* ------------------------- *
* *
* Covered Software is provided under this License on an "as is" *
* basis, without warranty of any kind, either expressed, implied, or *
* statutory, including, without limitation, warranties that the *
* Covered Software is free of defects, merchantable, fit for a *
* particular purpose or non-infringing. The entire risk as to the *
* quality and performance of the Covered Software is with You. *
* Should any Covered Software prove defective in any respect, You *
* (not any Contributor) assume the cost of any necessary servicing, *
* repair, or correction. This disclaimer of warranty constitutes an *
* essential part of this License. No use of any Covered Software is *
* authorized under this License except under this disclaimer. *
* *
************************************************************************
************************************************************************
* *
* 7. Limitation of Liability *
* -------------------------- *
* *
* Under no circumstances and under no legal theory, whether tort *
* (including negligence), contract, or otherwise, shall any *
* Contributor, or anyone who distributes Covered Software as *
* permitted above, be liable to You for any direct, indirect, *
* special, incidental, or consequential damages of any character *
* including, without limitation, damages for lost profits, loss of *
* goodwill, work stoppage, computer failure or malfunction, or any *
* and all other commercial damages or losses, even if such party *
* shall have been informed of the possibility of such damages. This *
* limitation of liability shall not apply to liability for death or *
* personal injury resulting from such party's negligence to the *
* extent applicable law prohibits such limitation. Some *
* jurisdictions do not allow the exclusion or limitation of *
* incidental or consequential damages, so this exclusion and *
* limitation may not apply to You. *
* *
************************************************************************
8. Litigation
-------------
Any litigation relating to this License may be brought only in the
courts of a jurisdiction where the defendant maintains its principal
place of business and such litigation shall be governed by laws of that
jurisdiction, without reference to its conflict-of-law provisions.
Nothing in this Section shall prevent a party's ability to bring
cross-claims or counter-claims.
9. Miscellaneous
----------------
This License represents the complete agreement concerning the subject
matter hereof. If any provision of this License is held to be
unenforceable, such provision shall be reformed only to the extent
necessary to make it enforceable. Any law or regulation which provides
that the language of a contract shall be construed against the drafter
shall not be used to construe this License against a Contributor.
10. Versions of the License
---------------------------
10.1. New Versions
Mozilla Foundation is the license steward. Except as provided in Section
10.3, no one other than the license steward has the right to modify or
publish new versions of this License. Each version will be given a
distinguishing version number.
10.2. Effect of New Versions
You may distribute the Covered Software under the terms of the version
of the License under which You originally received the Covered Software,
or under the terms of any subsequent version published by the license
steward.
10.3. Modified Versions
If you create software not governed by this License, and you want to
create a new license for such software, you may create and use a
modified version of this License if you rename the license and remove
any references to the name of the license steward (except to note that
such modified license differs from this License).
10.4. Distributing Source Code Form that is Incompatible With Secondary
Licenses
If You choose to distribute Source Code Form that is Incompatible With
Secondary Licenses under the terms of this version of the License, the
notice described in Exhibit B of this License must be attached.
Exhibit A - Source Code Form License Notice
-------------------------------------------
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
If it is not possible or desirable to put the notice in a particular
file, then You may include the notice in a location (such as a LICENSE
file in a relevant directory) where a recipient would be likely to look
for such a notice.
You may add additional accurate notices of copyright ownership.
Exhibit B - "Incompatible With Secondary Licenses" Notice
---------------------------------------------------------
This Source Code Form is "Incompatible With Secondary Licenses", as
defined by the Mozilla Public License, v. 2.0.

226
gradle-plugin/README.md Normal file
Просмотреть файл

@ -0,0 +1,226 @@
# Mozilla Application Services Gradle Plugin
Plugin for consuming Mozilla Application Services megazord native libraries.
<p align="left">
<a alt="Version badge" href="https://plugins.gradle.org/plugin/org.mozilla.appservices.gradle-plugin">
<img src="https://img.shields.io/maven-metadata/v/https/plugins.gradle.org/m2/org/mozilla/appservices/org.mozilla.appservices.gradle.plugin/maven-metadata.xml.svg?label=org.mozilla.appservices&colorB=brightgreen" /></a>
</p>
## Overview
Mozilla Application Services publishes many native (Rust) code libraries that stand alone: each
published Android ARchive (AAR) contains managed code (`classes.jar`) and multiple `.so` library
files (one for each supported architecture). That means consuming multiple such libraries entails
at least two `.so` libraries, and each of those libraries includes the entire Rust standard library
as well as (potentially many) duplicated dependencies. To save space and allow cross-component
native-code Link Time Optimization (LTO, i.e., inlining, dead code elimination, etc) Application
Services also publishes composite libraries -- so called *megazord libraries* or just *megazords* --
that compose multiple Rust components into a single optimized `.so` library file. The managed code
can be easily configured to use such a megazord without additional changes.
The `org.mozilla.appservices` plugin makes it easy to consume such megazord libraries.
## Configuration
```groovy
appservices {
defaultConfig {
// Megazord in all Android variants. The default is to not megazord.
megazord = 'lockbox' // Or 'reference-browser', etc.
enableUnitTests = false // Defaults to true.
}
}
```
You can configure per Android variant, per Android product flavor, or per Android build
type (in order of preference, i.e., a matching variant is preferred to a matching product flavor is
preferred to a matching build type is preferred to the default config).
```groovy
appservices {
variants {
stageDebug {
megazord = 'org.mozilla.appservices.megazord'
enableUnitTests = false // Defaults to true.
}
// Do not megazord or enable unit tests in other variants.
}
// overrides:
productFlavors {
stage {
megazord = 'org.mozilla.appservices.megazord'
}
// Do not megazord or enable unit tests in other product flavors.
}
// overrides:
buildTypes {
debug {
megazord = 'org.mozilla.appservices.megazord'
}
// Do not megazord or enable unit tests in release build type.
}
// overrides defaultConfig.
}
```
### `megazords`
New megazord definitions can be defined, and existing megazord definitions modified, using the
`megazords` block. For example, the existing "lockbox" megazord could be defined like:
```groovy
appservices {
megazords {
lockbox {
moduleIdentifier 'org.mozilla.appservices:lockbox-megazord'
component 'org.mozilla.fxaclient:fxaclient'
component 'org.mozilla.sync15', 'logins'
}
}
}
```
while the existing "reference-browser" megazord could be modified to match the "lockbox" megazord
like:
```groovy
appservices {
megazords {
"reference-browser" {
moduleIdentifier 'org.mozilla.appservices:reference-browser-megazord'
components.clear()
component 'org.mozilla.fxaclient:fxaclient'
component 'org.mozilla.sync15:logins'
}
}
}
```
To reset the known Mozilla megazords:
```groovy
appservices {
// Reset to the default megazord definitions.
setMozillaMegazords()
}
```
## Development
To run the integration tests:
```
./gradlew -p gradle-plugin test
```
To publish locally, for testing against a consuming application:
```
./gradlew -p gradle-plugin publishToMavenLocal
```
Then use `mavenLocal()` in the consuming application to find the updated version.
To publish to the Gradle plugin portal (requires credentials in `$HOME/.gradle/gradle.properties`):
```
./gradlew -p gradle-plugin publishPlugin
```
## Megazord Maven details
The megazord Maven publication is a shell Android ARchive (AAR) that contains a native library and
depends on special `-withoutLibs` versions of the component modules. For example, we have:
```
org.mozilla.sync15/logins.aar
- classes.jar
- libs/liblogins_ffi.so
```
and a `-withoutLibs` version, like:
```
org.mozilla.sync15-withoutLibs/logins-withoutLibs.aar
- classes.jar
```
and then a megazord like:
```
org.mozilla.appservices/lockbox-megazord.aar
- libs/liblockbox.so
```
The `org.mozilla.appservices:lockbox-megazord` Maven publication then depends on
`org.mozilla.sync15-withoutLibs:logins-withoutLibs` so that the JVM code (`classes.jar`) is used but
the component module native library (`libs/liblogins_ffi.so`) is not.
### Pseudo-code details
For each Android variant `variant`, the corresponding Gradle configurations
(`variant.{compileConfiguration,runtimeConfiguration}`) have module substitutions applied, like:
```groovy
// Pseudo-code!
configuration.resolutionStrategy.dependencySubstitution.all { dependency ->
if (dependency.isComponentModule()) {
dependency.useTarget('org.mozilla.appservices:example-megazord:...')
}
}
```
## Application Services Maven repository details
The megazord libraries and dependencies aren't yet published to maven.mozilla.org (see
[issue #252](https://github.com/mozilla/application-services/issues/252)) and for technical reasons
they aren't yet mirrored to jcenter either (see
[this bintray plugin issue](https://github.com/bintray/gradle-bintray-plugin/issues/130)).
That means we need a [non-standard Maven repository](https://bintray.com/ncalexander/application-services):
```groovy
repositories {
maven {
name 'appservices'
url 'https://dl.bintray.com/ncalexander/application-services'
}
}
```
The Gradle plugin adds such needed repositories automatically.
## Unit testing Rust native code
The Application Services Maven publications contain Rust native code targeting Android devices. To
unit test against the provided functionality, we require an additional dependency that packages Rust
native code for use on Desktop hosts and Java Native Access (JNA) internals in a form suitable for
consuming in Robolectric unit tests.
### Pseudo-code details
For unit testing support, for each test variant `variant.unitTestVariant`, the corresponding Gradle
configurations (`variant.unitTestVariant.{compileConfiguration,runtimeConfiguration}`) have
additional dependencies added, like:
```groovy
// Pseudo-code!
dependencies {
configuration.name 'org.mozilla.places:places-forUnitTests:...'
}
```
When a megazord is used, the additional dependencies will be megazord-specific, like:
```groovy
// Pseudo-code!
dependencies {
configuration.name 'org.mozilla.appservices:megazord-forUnitTests:...'
}
```

Просмотреть файл

@ -0,0 +1,83 @@
buildscript {
ext.kotlin_version = '1.3.10'
ext.plugin_version = '0.1.0'
repositories {
google()
jcenter()
maven {
url "https://plugins.gradle.org/m2/"
}
}
dependencies {
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
}
}
plugins {
id 'com.gradle.plugin-publish' version '0.9.10'
}
apply plugin: 'groovy' // For testing.
apply plugin: 'kotlin'
apply plugin: 'java-gradle-plugin'
apply plugin: 'maven-publish'
repositories {
google()
jcenter()
maven {
url "https://plugins.gradle.org/m2/"
}
}
group 'org.mozilla.appservices'
version "$plugin_version"
gradlePlugin {
plugins {
simplePlugin {
id = 'org.mozilla.appservices'
implementationClass = 'mozilla.appservices.AppServicesPlugin'
}
}
}
dependencies {
compileOnly gradleApi()
// This should really be compileOnly, but it's hard to get the Android classpath correct in the tests.
// It will be more robust if it's compileOnly, 'cuz then we should use the version from the
// consuming project's Android plugin.
implementation 'com.android.tools.build:gradle:3.1.4'
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
testCompile('org.spockframework:spock-core:1.1-groovy-2.4') {
exclude module: 'groovy-all'
}
}
compileKotlin {
kotlinOptions.jvmTarget = "1.8"
}
compileTestKotlin {
kotlinOptions.jvmTarget = "1.8"
}
pluginBundle {
website = 'https://github.com/mozilla/application-services/gradle-plugin'
vcsUrl = 'https://github.com/mozilla/application-services.git'
plugins {
appservices {
id = 'org.mozilla.appservices'
displayName = 'Plugin for consuming Mozilla Application Services megazord native libraries'
description = 'A plugin that helps consume multiple Mozilla Application Services native libraries.'
tags = ['rust', 'cargo', 'mozilla', 'appservices', 'android', 'megazord']
}
}
}
wrapper {
distributionType = Wrapper.DistributionType.ALL
}

Двоичные данные
gradle-plugin/gradle/wrapper/gradle-wrapper.jar поставляемый Normal file

Двоичный файл не отображается.

6
gradle-plugin/gradle/wrapper/gradle-wrapper.properties поставляемый Normal file
Просмотреть файл

@ -0,0 +1,6 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionSha256Sum=b7aedd369a26b177147bcb715f8b1fc4fe32b0a6ade0d7fd8ee5ed0c6f731f2c
distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-all.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

172
gradle-plugin/gradlew поставляемый Executable file
Просмотреть файл

@ -0,0 +1,172 @@
#!/usr/bin/env sh
##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null
APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS=""
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"
warn () {
echo "$*"
}
die () {
echo
echo "$*"
echo
exit 1
}
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi
# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi
# For Cygwin, switch paths to Windows format before running java
if $cygwin ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`
# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi
# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=$(save "$@")
# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
cd "$(dirname "$0")"
fi
exec "$JAVACMD" "$@"

84
gradle-plugin/gradlew.bat поставляемый Normal file
Просмотреть файл

@ -0,0 +1,84 @@
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS=
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto init
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto init
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:init
@rem Get command-line arguments, handling Windows variants
if not "%OS%" == "Windows_NT" goto win9xME_args
:win9xME_args
@rem Slurp the command line arguments.
set CMD_LINE_ARGS=
set _SKIP=2
:win9xME_args_slurp
if "x%~1" == "x" goto execute
set CMD_LINE_ARGS=%*
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

Просмотреть файл

@ -0,0 +1,68 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
package mozilla.appservices
import groovy.lang.Closure
import org.gradle.api.NamedDomainObjectContainer
import org.gradle.api.Project
import org.gradle.api.internal.AbstractNamedDomainObjectContainer
import org.gradle.api.internal.artifacts.DefaultModuleIdentifier
import org.gradle.util.ConfigureUtil
// `AppServicesExtension` is documented in README.md.
open class AppServicesExtension(project: Project) {
val megazords: NamedDomainObjectContainer<MegazordDefinition> = project.container(MegazordDefinition::class.java)
fun megazords(configureClosure: Closure<*>): NamedDomainObjectContainer<MegazordDefinition> {
return megazords.configure(configureClosure)
}
fun setMozillaMegazords() {
megazords.clear()
megazords.add(MegazordDefinition("lockbox",
DefaultModuleIdentifier.newId("org.mozilla.appservices.composites", "lockbox"),
setOf(
DefaultModuleIdentifier.newId("org.mozilla.fxaclient", "fxaclient"),
DefaultModuleIdentifier.newId("org.mozilla.sync15", "logins")
)))
megazords.add(MegazordDefinition("reference-browser",
DefaultModuleIdentifier.newId("org.mozilla.appservices.composites", "reference-browser"),
setOf(
DefaultModuleIdentifier.newId("org.mozilla.fxaclient", "fxaclient"),
DefaultModuleIdentifier.newId("org.mozilla.sync15", "logins"),
DefaultModuleIdentifier.newId("org.mozilla.places", "places")
)))
}
init {
setMozillaMegazords()
}
val defaultConfig: VariantConfiguration = VariantConfiguration("defaultConfig")
fun defaultConfig(configureClosure: Closure<*>): VariantConfiguration {
val action = ConfigureUtil.configureUsing<VariantConfiguration>(configureClosure)
action.execute(defaultConfig)
return defaultConfig
}
val buildTypes: NamedDomainObjectContainer<VariantConfiguration> = project.container(VariantConfiguration::class.java)
val productFlavors: NamedDomainObjectContainer<VariantConfiguration> = project.container(VariantConfiguration::class.java)
val variants: NamedDomainObjectContainer<VariantConfiguration> = project.container(VariantConfiguration::class.java)
fun buildTypes(configureClosure: Closure<*>): NamedDomainObjectContainer<VariantConfiguration> {
return buildTypes.configure(configureClosure)
}
fun productFlavors(configureClosure: Closure<*>): NamedDomainObjectContainer<VariantConfiguration> {
return productFlavors.configure(configureClosure)
}
fun variants(configureClosure: Closure<*>): NamedDomainObjectContainer<VariantConfiguration> {
return variants.configure(configureClosure)
}
}

Просмотреть файл

@ -0,0 +1,163 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
package mozilla.appservices
import com.android.build.gradle.AppExtension
import com.android.build.gradle.LibraryExtension
import com.android.build.gradle.api.BaseVariant
import com.android.build.gradle.internal.api.TestedVariant
import org.gradle.api.GradleException
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.artifacts.DependencySubstitutions
import org.gradle.api.artifacts.ModuleIdentifier
import org.gradle.api.artifacts.component.ModuleComponentIdentifier
import org.gradle.api.artifacts.component.ModuleComponentSelector
import org.gradle.api.artifacts.repositories.MavenArtifactRepository
import org.gradle.api.internal.artifacts.DefaultModuleIdentifier
import org.gradle.api.logging.Logger
import org.gradle.api.logging.Logging
import java.net.URI
open class AppServicesPlugin : Plugin<Project> {
internal lateinit var appServicesExtension: AppServicesExtension
/**
* Add substitutions for each component in the megazord.
*/
internal fun DependencySubstitutions.substituteMegazord(megazord: MegazordDefinition, logger: Logger?) {
this.all { dependency ->
val requested = dependency.requested as? ModuleComponentSelector
if (requested == null) {
return@all
}
val identifier = megazord.components.find { it == requested.moduleIdentifier }
if (identifier == null) {
logger?.debug("substitution for '${requested.group}:${requested.module}' not found")
return@all
}
val substitution = "${megazord.moduleIdentifier.group}:${megazord.moduleIdentifier.name}:${requested.version}"
logger?.debug("substituting megazord module '${substitution}' for component module" +
" '${requested.group}:${requested.module}:${requested.version}'")
dependency.useTarget(substitution)
}
}
/**
* Turn "foo:bar" into "foo:bar-forUnitTests".
*/
private fun ModuleIdentifier.forUnitTests(): ModuleIdentifier {
return DefaultModuleIdentifier.newId(group, name + "-forUnitTests")
}
/**
* Find the narrowest config matching the given variant, arbitrarily ordering product flavors ahead of build types.
*/
private fun matchingConfig(variant: BaseVariant): VariantConfiguration {
appServicesExtension.apply {
return variants.filter { it.name == variant.name }
.plus(productFlavors.filter { variant.flavorName == it.name })
.plus(buildTypes.filter { variant.buildType.name == it.name })
.plus(defaultConfig)
.first()
}
}
private fun configureVariant(project: Project, variant: TestedVariant) {
val logger = Logging.getLogger("appservices")
val config = matchingConfig(variant as BaseVariant)
val megazordName = config.megazord
if (megazordName == null) {
logger.info("no megazord for variant ${variant.name}; not megazording")
return
}
val megazord = appServicesExtension.megazords.findByName(megazordName)
if (megazord == null) {
throw GradleException("megazord named ${megazordName} not found configuring Android variant ${variant.name}")
}
listOf(variant.compileConfiguration, variant.runtimeConfiguration,
// You'd think that the unit test variants would inherit from the underlying variants, but at the
// crucial moment below they don't. So we also megazord them. We do this even when unit testing
// is not enabled since that should make it easier to reason about the substitutions.
variant.unitTestVariant.compileConfiguration, variant.unitTestVariant.runtimeConfiguration).forEach { configuration ->
logger.info("substituting megazord ${megazordName} for variant ${variant.name}")
configuration.resolutionStrategy.dependencySubstitution.substituteMegazord(megazord, logger)
}
if (config.unitTestingEnabled) {
listOf(variant.unitTestVariant.compileConfiguration, variant.unitTestVariant.runtimeConfiguration).forEach { configuration ->
// We've applied a megazord. We need to add the corresponding `-forUnitTests` dependency...
// but the versions must agree. To find out the actual version chosen, we need to resolve the
// configuration... but resolving the actual configuration at this time freezes it, which interacts
// badly with many plugins and is generally Not A Good Thing for a plugin to do.
// Therefore, we clone the configuration and resolve the clone to determine the actual megazord version,
// and then use the same version.
val modules: List<ModuleComponentIdentifier> = configuration.copyRecursive().incoming.resolutionResult.allComponents.mapNotNull { it.id as? ModuleComponentIdentifier }
val resolvedMegazord = modules.find { it.group == megazord.moduleIdentifier.group && it.module == megazord.moduleIdentifier.name }
if (resolvedMegazord == null) {
logger.error("megazord substitution requested for variant ${variant.name} but the megazord module" +
" '${megazord.moduleIdentifier.group}:${megazord.moduleIdentifier.name}' failed to resolve" +
" as part of the unit test ${configuration}!")
throw GradleException("megazord substitution for variant ${variant.name} failed to resolve a megazord module")
}
val forUnitTests = megazord.moduleIdentifier.forUnitTests()
val dependency = "${forUnitTests.group}:${forUnitTests.name}:${resolvedMegazord.version}"
logger.info("substituted megazord ${megazordName} for unit test ${configuration};" +
" adding forUnitTests dependency '${dependency}'")
project.dependencies.add(configuration.name, dependency)
}
}
}
override fun apply(project: Project) {
with(project) {
appServicesExtension = extensions.create("appservices", AppServicesExtension::class.java, project)
// This is somewhat temporary: https://github.com/mozilla/application-services isn't publishing to
// maven.mozilla.org yet, so we need a non-standard URL. But we probably want to force
// https://maven.mozilla.org/maven2 in the future anyway... so it's probably not worth making this
// configurable. See https://github.com/mozilla/application-services/issues/252.
val customName = "appservices"
val customURI = URI.create("https://dl.bintray.com/ncalexander/application-services")
// If there's already a Maven repo with the right URL, or even the right name, roll with it.
// The name gives the opportunity to customize, if it helps in the wild.
val existing = project.repositories.find {
(it is MavenArtifactRepository) && (it.url == customURI || it.name == customName)
}
if (existing == null) {
logger.info("adding '${customName}' Maven repository with url '${customURI.toASCIIString()}'")
project.repositories.maven {
it.name = customName
it.url = customURI
}
}
project.pluginManager.withPlugin("com.android.application") {
var android = project.extensions.getByType(AppExtension::class.java)
android.applicationVariants.all { variant ->
configureVariant(project, variant)
}
}
// There's no reason that Android libraries shouldn't consume megazords, and it's helpful to add
// forUnitTests dependencies.
project.pluginManager.withPlugin("com.android.library") {
// var android = project.extensions.getByName("android") as LibraryExtension
var android = project.extensions.getByType(LibraryExtension::class.java)
android.libraryVariants.all { variant ->
configureVariant(project, variant)
}
}
}
}
}

Просмотреть файл

@ -0,0 +1,51 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
package mozilla.appservices
import org.gradle.api.GradleException
import org.gradle.api.artifacts.ModuleIdentifier
import org.gradle.api.internal.artifacts.DefaultModuleIdentifier
/**
* A "megazord" is a named mapping from many component modules to a single megazord module.
*/
data class MegazordDefinition(val name: String, val components: MutableSet<ModuleIdentifier>) {
constructor(name: String) : this(name, mutableSetOf())
constructor(name: String, moduleIdentifier: ModuleIdentifier, components: Collection<ModuleIdentifier>?)
: this(name, components?.toMutableSet() ?: mutableSetOf()) {
this.moduleIdentifier = moduleIdentifier
}
lateinit var moduleIdentifier: ModuleIdentifier
fun contains(component: ModuleIdentifier): Boolean {
return this.components.contains(component)
}
private fun newId(identifier: String): ModuleIdentifier {
val parts = identifier.split(':')
if (parts.size != 2) {
throw GradleException("megazord moduleIdentifier must have 2 colon-separated parts; got: '${identifier}' with ${parts.size} parts")
}
return DefaultModuleIdentifier.newId(parts[0], parts[1])
}
fun moduleIdentifier(identifier: String) {
this.moduleIdentifier = newId(identifier)
}
fun moduleIdentifier(group: String, name: String) {
this.moduleIdentifier = DefaultModuleIdentifier.newId(group, name)
}
fun component(identifier: String) {
this.components.add(newId(identifier))
}
fun component(group: String, name: String) {
this.components.add(DefaultModuleIdentifier.newId(group, name))
}
}

Просмотреть файл

@ -0,0 +1,17 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
package mozilla.appservices
import org.gradle.api.GradleException
import org.gradle.api.artifacts.ModuleIdentifier
import org.gradle.api.internal.artifacts.DefaultModuleIdentifier
/**
* Captures configuration for a particular Android variant.
*/
data class VariantConfiguration(val name: String,
var megazord: String? = null,
var unitTestingEnabled: Boolean = true) {
}

Просмотреть файл

@ -0,0 +1 @@
implementation-class=mozilla.appservices.AppServicesPlugin

Просмотреть файл

@ -0,0 +1,195 @@
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
package mozilla.appservices
import org.gradle.testkit.runner.GradleRunner
import org.junit.Rule
import org.junit.rules.TemporaryFolder
import spock.lang.Specification
class AppServicesExtensionTests extends Specification {
@Rule final TemporaryFolder testProjectDir = new TemporaryFolder()
File buildFile
def setup() {
buildFile = testProjectDir.newFile('build.gradle')
testProjectDir.newFolder('src', 'main')
File manifestFile = testProjectDir.newFile('src/main/AndroidManifest.xml')
manifestFile << """
<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="org.mozilla.appservices.gradle-plugin.test">
</manifest>
"""
def sdkPath = System.getProperty('android.sdk.dir') ?: "/Users/nalexander/.mozbuild/android-sdk-macosx"
File localProperties = testProjectDir.newFile('local.properties')
localProperties << """
sdk.dir=$sdkPath
"""
buildFile << """
buildscript {
repositories {
google()
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:3.1.4'
}
}
plugins {
id 'org.mozilla.appservices'
}
"""
}
def androidLibrary() {
buildFile << """
// It's not possible to use the `plugins` block for the Android plugin yet.
apply plugin: 'com.android.library'
android {
compileSdkVersion 27
defaultConfig {
minSdkVersion 21
targetSdkVersion 27
}
}
repositories {
google()
jcenter()
}
"""
}
def androidApplication() {
buildFile << """
// It's not possible to use the `plugins` block for the Android plugin yet.
apply plugin: 'com.android.application'
android {
compileSdkVersion 27
defaultConfig {
minSdkVersion 21
targetSdkVersion 27
}
}
repositories {
google()
jcenter()
}
"""
}
// def setup() {
// // XXX how to handle this?
// SdkHandler.setTestSdkFolder(new File("/Users/nalexander/.mozbuild/android-sdk-macosx"))
//
// testProjectDir.newFolder('src', 'main')
// manifestFile = testProjectDir.newFile('src/main/AndroidManifest.xml')
// manifestFile << """<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="org.mozilla.appservices.megazord.test"></manifest>"""
//
// project = ProjectBuilder.builder()
// .withProjectDir(testProjectDir.root)
// .build()
//
// project.pluginManager.apply LibraryPlugin
// project.android {
// compileSdkVersion 27
//
// defaultConfig {
// minSdkVersion 21
// targetSdkVersion 27
// }
// }
//
// project.pluginManager.apply AppServicesPlugin
// }
def "megazording a library succeeds"() {
given:
androidLibrary()
buildFile << """
dependencies {
// N.b.: there's a version 0.11.5, so this exercises the unit test version inspection.
// If it was 0.11.5, taking the latest version might succeed by accident.
implementation 'org.mozilla.places:places:0.11.4'
}
appservices {
defaultConfig {
megazord = 'reference-browser'
}
}
"""
when:
def result = GradleRunner.create()
.withProjectDir(testProjectDir.root)
.withDebug(true)
.withArguments('androidDependencies')
.withPluginClasspath()
.build()
def sections = result.output.split("\n\n")
then:
sections.find { it.contains('debugCompileClasspath') }.contains('org.mozilla.appservices.composites:reference-browser:0.11.4@aar')
!sections.find { it.contains('debugCompileClasspath') }.contains('org.mozilla.fxaclient:fxaclient:')
!sections.find { it.contains('debugCompileClasspath') }.contains('org.mozilla.places:places:')
!sections.find { it.contains('debugCompileClasspath') }.contains('org.mozilla.sync15:logins:')
sections.find { it.contains('debugRuntimeClasspath') }.contains('org.mozilla.appservices.composites:reference-browser:0.11.4@aar')
sections.find { it.contains('debugUnitTestCompileClasspath') }.contains('org.mozilla.appservices.composites:reference-browser:0.11.4@jar')
!sections.find { it.contains('debugUnitTestCompileClasspath') }.contains('org.mozilla.fxaclient:fxaclient:')
!sections.find { it.contains('debugUnitTestCompileClasspath') }.contains('org.mozilla.places:places:')
!sections.find { it.contains('debugUnitTestCompileClasspath') }.contains('org.mozilla.sync15:logins:')
sections.find { it.contains('debugUnitTestRuntimeClasspath') }.contains('org.mozilla.appservices.composites:reference-browser:0.11.4@jar')
}
def "megazording an application succeeds"() {
given:
androidApplication()
buildFile << """
dependencies {
// N.b.: there's a version 0.11.5, so this exercises the unit test version inspection.
// If it was 0.11.5, taking the latest version might succeed by accident.
implementation 'org.mozilla.places:places:0.11.4'
}
appservices {
defaultConfig {
megazord = 'reference-browser'
}
}
"""
when:
def result = GradleRunner.create()
.withProjectDir(testProjectDir.root)
.withDebug(true)
.withArguments('androidDependencies')
.withPluginClasspath()
.build()
def sections = result.output.split("\n\n")
then:
sections.find { it.contains('debugCompileClasspath') }.contains('org.mozilla.appservices.composites:reference-browser:0.11.4@aar')
!sections.find { it.contains('debugCompileClasspath') }.contains('org.mozilla.fxaclient:fxaclient:')
!sections.find { it.contains('debugCompileClasspath') }.contains('org.mozilla.places:places:')
!sections.find { it.contains('debugCompileClasspath') }.contains('org.mozilla.sync15:logins:')
sections.find { it.contains('debugRuntimeClasspath') }.contains('org.mozilla.appservices.composites:reference-browser:0.11.4@aar')
sections.find { it.contains('debugUnitTestCompileClasspath') }.contains('org.mozilla.appservices.composites:reference-browser:0.11.4@jar')
!sections.find { it.contains('debugUnitTestCompileClasspath') }.contains('org.mozilla.fxaclient:fxaclient:')
!sections.find { it.contains('debugUnitTestCompileClasspath') }.contains('org.mozilla.places:places:')
!sections.find { it.contains('debugUnitTestCompileClasspath') }.contains('org.mozilla.sync15:logins:')
sections.find { it.contains('debugUnitTestRuntimeClasspath') }.contains('org.mozilla.appservices.composites:reference-browser:0.11.4@jar')
}
}