diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..bb70059a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# How to Contribute + +We'd love to accept your patches and contributions to this project. There are +just a few small guidelines you need to follow. + +## Contributor License Agreement + +Contributions to this project must be accompanied by a Contributor License +Agreement. You (or your employer) retain the copyright to your contribution, +this simply gives us permission to use and redistribute your contributions as +part of the project. Head over to to see +your current agreements on file or to sign a new one. + +You generally only need to submit a CLA once, so if you've already submitted one +(even if it was for a different project), you probably don't need to do it +again. + +## Code reviews + +All submissions, including submissions by project members, require review. We +use GitHub pull requests for this purpose. Consult +[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more +information on using pull requests. + +## Community Guidelines + +This project follows [Google's Open Source Community +Guidelines](https://opensource.google.com/conduct/). diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..7a4a3ea2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..20f0085e --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Strict Version Matcher Gradle Plugin + +This plugin scans a subset of Google Play services and Firebase dependencies +during the Bradle build. It raises an error when version resolution is specified +in the POM file but not honored by the Gradle build system. This can happen when +Gradle's default dependency resolution strategy is used because it uses the +highest referenced version even if it crossed the major version boundary. + +## To use + +In your app's build.gradle: + +``` +apply plugin: 'com.google.android.gms.strict-version-matcher-plugin' +``` + +In order to use this plugin, you will also need to add the following to your +buildscript classpath, obtained from Google’s +[Maven repository](//developer.android.com/studio/build/dependencies#google-maven): + +``` +classpath 'com.google.android.gms:strict-version-matcher-plugin:1.0.2' +``` + +These instructions are also documented +[online](//developers.google.com/android/guides/versioning) diff --git a/build.gradle b/build.gradle new file mode 100644 index 00000000..29d38d9d --- /dev/null +++ b/build.gradle @@ -0,0 +1,33 @@ +buildscript { + repositories { + jcenter() + } + dependencies { + } +} + +project.ext.group = 'com.google.android.gms' +project.ext.archivesBaseName = 'strict-version-matcher-plugin' +project.ext.version = '1.0.2' +project.ext.pomDesc = 'Gradle plug-in to enforce version ranges for Google Play services and Firebase dependencies.' + +apply plugin: 'groovy' + +repositories { + jcenter() +} + +dependencies { + compile gradleApi() + testCompile 'junit:junit:4.12' + testCompile "com.google.truth:truth:0.39" +} + +apply from: 'publish.gradle' + +if (project.has('bintrayUser') && project.has('bintrayKey')) { + apply from: 'bintray.gradle' +} + +sourceCompatibility = 1.7 +targetCompatibility = 1.7 diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 00000000..66412108 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,21 @@ +# Project-wide Gradle settings. + +# IDE (e.g. Android Studio) users: +# Gradle settings configured through the IDE *will override* +# any settings specified in this file. + +# For more details on how to configure your build environment visit +# http://www.gradle.org/docs/current/userguide/build_environment.html + +# Specifies the JVM arguments used for the daemon process. +# The setting is particularly useful for tweaking memory settings. +# Default value: -Xmx10248m -XX:MaxPermSize=256m +org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8 +org.gradle.java.home=/usr/local/buildtools/java/jdk8/ + +# When configured, Gradle will run in incubating parallel mode. +# This option should only be used with decoupled projects. More details, visit +# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects +org.gradle.parallel=true + +org.gradle.daemon=true diff --git a/src/main/groovy/com/google/android/gms/StrictVersionMatcherPlugin.groovy b/src/main/groovy/com/google/android/gms/StrictVersionMatcherPlugin.groovy new file mode 100644 index 00000000..bf575353 --- /dev/null +++ b/src/main/groovy/com/google/android/gms/StrictVersionMatcherPlugin.groovy @@ -0,0 +1,189 @@ +/** + * Copyright 2018 Google LLC + * + * 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 + * + * https://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. + */ + +package com.google.android.gms + +import java.util.HashSet +import java.util.HashMap +import java.util.SortedSet +import java.util.TreeSet +import java.util.regex.Matcher +import java.util.regex.Pattern +import org.gradle.BuildListener +import org.gradle.BuildResult +import org.gradle.api.artifacts.Configuration +import org.gradle.api.artifacts.Dependency +import org.gradle.api.artifacts.DependencyResolutionListener +import org.gradle.api.artifacts.ProjectDependency +import org.gradle.api.artifacts.ResolvableDependencies +import org.gradle.api.initialization.Settings +import org.gradle.api.internal.artifacts.dependencies.DefaultProjectDependency +import org.gradle.api.invocation.Gradle +import org.gradle.api.GradleException +import org.gradle.api.Plugin +import org.gradle.api.Project + +class StrictVersionMatcherPlugin implements Plugin { + // Some example of things that match this pattern are: + // "[1]" + // "[10]" + // "[10.3.234]" + // And here is an example with the capture group 1 in + // [<1.2.3.4>] + public static final Pattern VERSION_RANGE_PATTERN = ~/\[(\d+(\.\d+)*)\]/ + + public static HashMap>> versionsByGroupAndName = new HashMap<>(); + + @Override + void apply(Project project) { + failOnVersionConflictForGroup(project, "com.google.android.gms") + failOnVersionConflictForGroup(project, "com.google.firebase") + } + + static int versionCompare(String str1, String str2) { + String[] vals1 = str1.split("\\."); + String[] vals2 = str2.split("\\."); + int i = 0; + while (i < vals1.length && i < vals2.length && vals1[i].equals(vals2[i])) { + i++; + } + if (i < vals1.length && i < vals2.length) { + int diff = Integer.valueOf(vals1[i]).compareTo(Integer.valueOf(vals2[i])); + return Integer.signum(diff); + } + return Integer.signum(vals1.length - vals2.length); + } + + /** + * Adds two hooks to the build project, the first is when every dependency + * is resolved, if it matches the group prefix its requested version is + * parsed and stored. The second is hooked in right before compilation, and + * checks the resolved dependencies to ensure they match the requested ranges + * stored earlier. If a mismatch occurs, a GradleException is thrown. + */ + static void failOnVersionConflictForGroup(Project project, String groupPrefix) { + versionsByGroupAndName = new HashMap<>(); + project.configurations.all { + resolutionStrategy.eachDependency { details -> + String group = details.requested.group + String name = details.requested.name + String version = details.requested.version + if (group == null || name == null || version == null) { + return + } + if (group.startsWith(groupPrefix)) { + if(!versionsByGroupAndName.containsKey(group)) { + versionsByGroupAndName.put(group, new HashMap<>()) + } + if(!versionsByGroupAndName.get(group).containsKey(name)) { + versionsByGroupAndName.get(group).put(name, new HashSet<>()) + } + VersionRange versionRange = VersionRange.fromString(version) + if (versionRange != null) { + versionsByGroupAndName.get(group).get(name).add(versionRange) + } + } + } + } + project.getGradle().addListener(new DependencyResolutionListener() { + @Override + void beforeResolve(ResolvableDependencies resolvableDependencies) { + } + + @Override + void afterResolve(ResolvableDependencies resolvableDependencies) { + resolvableDependencies.getResolutionResult().allComponents {artifact -> + String group = artifact.moduleVersion.group + String name = artifact.moduleVersion.name + Version version = Version.fromString(artifact.moduleVersion.version) + if (group == null || name == null || version == null) { + return + } + if (group.startsWith(groupPrefix)) { + HashSet ranges = versionsByGroupAndName + .getOrDefault(group, new HashMap()) + .getOrDefault(name, new HashSet()) + for (VersionRange range : ranges) { + if (!range.versionInRange(version)) { + throw new GradleException("The library $group:$name is being requested by " + + "various other libraries at $ranges, but resolves to $version.rawVersion. " + + "Disable the plugin and check your dependencies tree using ./gradlew :app:dependencies.") + } + } + } + } + } + }) + } + + @groovy.transform.Immutable static class Version { + String rawVersion, trimmedVersion + public static Version fromString(String version) { + if (version == null) { + return null + } + return new Version(version, version.split("-")[0]) + } + } + @groovy.transform.Immutable static class VersionRange { + boolean closedStart + boolean closedEnd + Version rangeStart + Version rangeEnd + + public static VersionRange fromString(String versionRange) { + Matcher versionRangeMatcher = VERSION_RANGE_PATTERN.matcher(versionRange) + if (versionRangeMatcher.matches()) { + Version version = Version.fromString(versionRangeMatcher.group(1)) + return new VersionRange( + true, + true, + version, + version) + } + return null + } + + boolean versionInRange(Version version) { + if (closedStart) { + if (versionCompare(rangeStart.trimmedVersion, version.trimmedVersion) > 0) { + return false; + } + } else { + if (versionCompare(rangeStart.trimmedVersion, version.trimmedVersion) >= 0) { + return false; + } + } + if (closedEnd) { + if (versionCompare(rangeEnd.trimmedVersion, version.trimmedVersion) < 0) { + return false; + } + } else { + if (versionCompare(rangeEnd.trimmedVersion, version.trimmedVersion) <= 0) { + return false; + } + } + return true; + } + + public String toString() { + return ((closedStart ? "[" : "(") + + rangeStart.trimmedVersion + "," + + rangeEnd.trimmedVersion + + (closedEnd ? "]" : ")")) + } + } +} diff --git a/src/main/resources/META-INF/gradle-plugins/com.google.android.gms.strict-version-matcher-plugin.properties b/src/main/resources/META-INF/gradle-plugins/com.google.android.gms.strict-version-matcher-plugin.properties new file mode 100644 index 00000000..a341484b --- /dev/null +++ b/src/main/resources/META-INF/gradle-plugins/com.google.android.gms.strict-version-matcher-plugin.properties @@ -0,0 +1 @@ +implementation-class=com.google.android.gms.StrictVersionMatcherPlugin diff --git a/src/test/java/com/google/android/gms/StrictVersionMatcherPluginTest.java b/src/test/java/com/google/android/gms/StrictVersionMatcherPluginTest.java new file mode 100644 index 00000000..59a6d2e5 --- /dev/null +++ b/src/test/java/com/google/android/gms/StrictVersionMatcherPluginTest.java @@ -0,0 +1,47 @@ +/** + * Copyright 2018 Google LLC + * + * 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 + * + * https://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. + */ + +package com.google.android.gms; + +import static com.google.common.truth.Truth.assertThat; + +import com.google.android.gms.StrictVersionMatcherPlugin.Version; +import com.google.android.gms.StrictVersionMatcherPlugin.VersionRange; +import java.util.ArrayList; +import java.util.List; +import java.util.HashMap; +import java.util.stream.Collectors; +import org.gradle.api.GradleException; +import org.junit.Test; + +public class StrictVersionMatcherPluginTest { + + @Test + public void testVersionCompare() { + assertThat(StrictVersionMatcherPlugin.versionCompare("1.0.0", "2.0.0")).isLessThan(0); + assertThat(StrictVersionMatcherPlugin.versionCompare("1.10.1", "1.9.0")).isGreaterThan(0); + assertThat(StrictVersionMatcherPlugin.versionCompare("1.0.0", "1.0.0")).isEqualTo(0); + } + + @Test + public void closedNonRangeVersionRangeTest() { + VersionRange range = VersionRange.fromString("[1.2.3]"); + Version version = Version.fromString("1.2.3-SNAPSHOT"); + Version highVersion = Version.fromString("5.3.2"); + assertThat(range.versionInRange(version)).isTrue(); + assertThat(range.versionInRange(highVersion)).isFalse(); + } +}