Skip to content

Update metalava api.txt, fix metalava task. #1049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 10, 2019
Merged

Update metalava api.txt, fix metalava task. #1049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c4a3918
Update metalava api.txt, fix metalava task.
vkryachko Dec 10, 2019
5b60fcd
Update api.txt
vkryachko Dec 10, 2019
98a7733
Cleanup
vkryachko Dec 10, 2019
0220c48
Update buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/Fi…
vkryachko Dec 10, 2019
5cf337b
Address review feedback.
vkryachko Dec 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 76 additions & 48 deletions buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/FirebaseLibraryPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@
import java.nio.file.Paths;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.attributes.Attribute;
import org.gradle.api.file.FileCollection;
import org.gradle.api.tasks.TaskProvider;
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile;

public class FirebaseLibraryPlugin implements Plugin<Project> {
Expand Down Expand Up @@ -101,55 +104,80 @@ private static void setupApiInformationAnalysis(Project project, LibraryExtensio
task -> {
task.setOutputFile(metalavaOutputJarFile);
});
project
.getTasks()
.register(
"apiInformation",
ApiInformationTask.class,
task -> {
task.setApiTxt(project.file("api.txt"));
task.setMetalavaJarPath(metalavaOutputJarFile.getAbsolutePath());
task.setSourceSet(mainSourceSet);
task.setOutputFile(outputFile);
task.setBaselineFile(project.file("baseline.txt"));
task.setOutputApiFile(outputApiFile);
if (project.hasProperty("updateBaseline")) {
task.setUpdateBaseline(true);
} else {
task.setUpdateBaseline(false);
}
task.dependsOn("getMetalavaJar");
});

project
.getTasks()
.register(
"generateApiTxtFile",
GenerateApiTxtFileTask.class,
task -> {
task.setApiTxt(project.file("api.txt"));
task.setMetalavaJarPath(metalavaOutputJarFile.getAbsolutePath());
task.setSourceSet(mainSourceSet);
task.setBaselineFile(project.file("baseline.txt"));
if (project.hasProperty("updateBaseline")) {
task.setUpdateBaseline(true);
} else {
task.setUpdateBaseline(false);
File apiTxt =
project.file("api.txt").exists()
? project.file("api.txt")
: project.file(project.getRootDir() + "/empty-api.txt");
TaskProvider<ApiInformationTask> apiInfo =
project
.getTasks()
.register(
"apiInformation",
ApiInformationTask.class,
task -> {
task.setApiTxt(apiTxt);
task.setMetalavaJarPath(metalavaOutputJarFile.getAbsolutePath());
task.setSourceSet(mainSourceSet);
task.setOutputFile(outputFile);
task.setBaselineFile(project.file("baseline.txt"));
task.setOutputApiFile(outputApiFile);
if (project.hasProperty("updateBaseline")) {
task.setUpdateBaseline(true);
} else {
task.setUpdateBaseline(false);
}
task.dependsOn("getMetalavaJar");
});

TaskProvider<GenerateApiTxtFileTask> generateApiTxt =
project
.getTasks()
.register(
"generateApiTxtFile",
GenerateApiTxtFileTask.class,
task -> {
task.setApiTxt(project.file("api.txt"));
task.setMetalavaJarPath(metalavaOutputJarFile.getAbsolutePath());
task.setSourceSet(mainSourceSet);
task.setBaselineFile(project.file("baseline.txt"));
task.setUpdateBaseline(project.hasProperty("updateBaseline"));
task.dependsOn("getMetalavaJar");
});

TaskProvider<GenerateStubsTask> docStubs =
project
.getTasks()
.register(
"docStubs",
GenerateStubsTask.class,
task -> {
task.setMetalavaJarPath(metalavaOutputJarFile.getAbsolutePath());
task.setOutputDir(new File(project.getBuildDir(), "doc-stubs"));
task.dependsOn("getMetalavaJar");

task.setSourceSet(mainSourceSet);
});

android
.getLibraryVariants()
.all(
v -> {
if (v.getName().equals("release")) {
FileCollection jars =
v.getCompileConfiguration()
.getIncoming()
.artifactView(
config ->
config.attributes(
container ->
container.attribute(
Attribute.of("artifactType", String.class), "jar")))
.getArtifacts()
.getArtifactFiles();
apiInfo.configure(t -> t.setClassPath(jars));
generateApiTxt.configure(t -> t.setClassPath(jars));
docStubs.configure(t -> t.setClassPath(jars));
}
task.dependsOn("getMetalavaJar");
});

project
.getTasks()
.register(
"docStubs",
GenerateStubsTask.class,
task -> {
task.setMetalavaJarPath(metalavaOutputJarFile.getAbsolutePath());
task.setOutputDir(new File(project.getBuildDir(), "doc-stubs"));
task.dependsOn("getMetalavaJar");

task.setSourceSet(mainSourceSet);
});
}

Expand Down
57 changes: 57 additions & 0 deletions buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/SdkUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
// Copyright 2019 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
//
// 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.

package com.google.firebase.gradle.plugins;

import com.android.build.gradle.LibraryExtension;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.Properties;
import org.gradle.api.GradleException;
import org.gradle.api.Project;

public final class SdkUtil {
public static File getSdkDir(Project project) {
Properties properties = new Properties();
File localProperties = project.getRootProject().file("local.properties");
if (localProperties.exists()) {
try (FileInputStream fis = new FileInputStream(localProperties)) {
properties.load(fis);
} catch (IOException ex) {
throw new GradleException("Could not load local.properties", ex);
}
}

String sdkDir = properties.getProperty("sdk.dir");
if (sdkDir != null) {
return project.file(sdkDir);
}
String androidHome = System.getenv("ANDROID_HOME");
if (androidHome == null) {
throw new GradleException("No sdk.dir or ANDROID_HOME set.");
}
return project.file(androidHome);
}

public static File getAndroidJar(Project project) {
LibraryExtension android = project.getExtensions().findByType(LibraryExtension.class);
if (android == null) {
throw new GradleException("Project " + project.getPath() + " is not an android library.");
}
return new File(
getSdkDir(project),
String.format("/platforms/%s/android.jar", android.getCompileSdkVersion()));
}
}
33 changes: 31 additions & 2 deletions buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/apiinfo/ApiInformationTask.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,25 @@
package com.google.firebase.gradle.plugins.apiinfo;

import com.android.build.gradle.api.AndroidSourceSet;
import com.google.firebase.gradle.plugins.SdkUtil;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;

import org.gradle.api.DefaultTask;
import org.gradle.api.GradleException;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.file.FileCollection;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.InputFile;
import org.gradle.api.tasks.InputFiles;
import org.gradle.api.tasks.OutputFile;
import org.gradle.api.tasks.TaskAction;

Expand All @@ -43,6 +51,9 @@ public abstract class ApiInformationTask extends DefaultTask {

abstract AndroidSourceSet getSourceSet();

@InputFiles
abstract FileCollection getClassPath();

@OutputFile
abstract File getBaselineFile();

Expand All @@ -57,6 +68,8 @@ public abstract class ApiInformationTask extends DefaultTask {

public abstract void setSourceSet(AndroidSourceSet value);

public abstract void setClassPath(FileCollection value);

public abstract void setBaselineFile(File value);

public abstract void setUpdateBaseline(boolean value);
Expand All @@ -76,6 +89,19 @@ void execute() {
.filter(File::exists)
.map(File::getAbsolutePath)
.collect(Collectors.joining(":"));
if (sourcePath.isEmpty()) {
getLogger()
.warn(
"Project {} has no sources in main source set, skipping...", getProject().getPath());
return;
}

String classPath =
Stream.concat(
getClassPath().getFiles().stream(), Stream.of(SdkUtil.getAndroidJar(getProject())))
.map(File::getAbsolutePath)
.collect(Collectors.joining(":"));

File outputFileDir = getOutputFile().getParentFile();
if (!outputFileDir.exists()) {
outputFileDir.mkdirs();
Expand All @@ -89,8 +115,11 @@ void execute() {
spec.setArgs(
Arrays.asList(
getMetalavaJarPath(),
"--no-banner",
"--source-path",
sourcePath,
"--classpath",
classPath,
"--api",
getOutputApiFile().getAbsolutePath(),
"--format=v2"));
Expand All @@ -104,13 +133,13 @@ void execute() {
new ArrayList<>(
Arrays.asList(
getMetalavaJarPath(),
"--no-banner",
"--source-files",
getOutputApiFile().getAbsolutePath(),
"--check-compatibility:api:current",
getApiTxt().getAbsolutePath(),
"--format=v2",
"--no-color",
"--delete-empty-baselines"));
"--no-color"));
if (getUpdateBaseline()) {
args.addAll(
Arrays.asList("--update-baseline", getBaselineFile().getAbsolutePath()));
Expand Down
28 changes: 26 additions & 2 deletions ...rc/src/main/groovy/com/google/firebase/gradle/plugins/apiinfo/GenerateApiTxtFileTask.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,19 @@
package com.google.firebase.gradle.plugins.apiinfo;

import com.android.build.gradle.api.AndroidSourceSet;
import com.google.firebase.gradle.plugins.SdkUtil;

import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import org.gradle.api.DefaultTask;
import org.gradle.api.file.FileCollection;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.InputFiles;
import org.gradle.api.tasks.OutputFile;
import org.gradle.api.tasks.TaskAction;

Expand All @@ -35,6 +41,9 @@ public abstract class GenerateApiTxtFileTask extends DefaultTask {

abstract AndroidSourceSet getSourceSet();

@InputFiles
public abstract FileCollection getClassPath();

@OutputFile
abstract File getBaselineFile();

Expand All @@ -43,6 +52,8 @@ public abstract class GenerateApiTxtFileTask extends DefaultTask {

public abstract void setSourceSet(AndroidSourceSet value);

public abstract void setClassPath(FileCollection value);

public abstract void setBaselineFile(File value);

public abstract void setUpdateBaseline(boolean value);
Expand All @@ -58,16 +69,29 @@ void execute() {
.filter(File::exists)
.map(File::getAbsolutePath)
.collect(Collectors.joining(":"));
if (sourcePath.isEmpty()) {
getLogger()
.warn(
"Project {} has no sources in main source set, skipping...", getProject().getPath());
return;
}
String classPath =
Stream.concat(
getClassPath().getFiles().stream(), Stream.of(SdkUtil.getAndroidJar(getProject())))
.map(File::getAbsolutePath)
.collect(Collectors.joining(":"));
List<String> args =
new ArrayList<>(
Arrays.asList(
getMetalavaJarPath(),
"--no-banner",
"--source-path",
sourcePath,
"--classpath",
classPath,
"--api",
getApiTxt().getAbsolutePath(),
"--format=v2",
"--delete-empty-baselines"));
"--format=v2"));

if (getUpdateBaseline()) {
args.addAll(Arrays.asList("--update-baseline", getBaselineFile().getAbsolutePath()));
Expand Down
Loading