Run forbidden api checks with runtimeJavaVersion #32947
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you 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 org.elasticsearch.gradle.precommit; | ||
|
|
||
| import de.thetaphi.forbiddenapis.cli.CliMain; | ||
| import org.gradle.api.Action; | ||
| import org.gradle.api.DefaultTask; | ||
| import org.gradle.api.JavaVersion; | ||
| 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.SkipWhenEmpty; | ||
| import org.gradle.api.tasks.TaskAction; | ||
| import org.gradle.process.JavaExecSpec; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.nio.file.Files; | ||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.LinkedHashSet; | ||
| import java.util.List; | ||
| import java.util.Set; | ||
|
|
||
| public class ForbiddenApisCliTask extends DefaultTask { | ||
|
|
||
| private FileCollection signaturesFiles; | ||
| private List<String> signatures = new ArrayList<>(); | ||
| private Set<String> bundledSignatures = new LinkedHashSet<>(); | ||
| private Set<String> suppressAnnotations = new LinkedHashSet<>(); | ||
| private JavaVersion targetCompatibility; | ||
| private FileCollection classesDirs; | ||
| private Action<JavaExecSpec> execAction; | ||
|
There was a problem hiding this comment. This avoids inheriting from |
||
|
|
||
| public JavaVersion getTargetCompatibility() { | ||
| return targetCompatibility; | ||
| } | ||
|
|
||
| public void setTargetCompatibility(JavaVersion targetCompatibility) { | ||
| this.targetCompatibility = targetCompatibility; | ||
| } | ||
|
|
||
| public Action<JavaExecSpec> getExecAction() { | ||
| return execAction; | ||
| } | ||
|
|
||
| public void setExecAction(Action<JavaExecSpec> execAction) { | ||
| this.execAction = execAction; | ||
| } | ||
|
|
||
| @OutputFile | ||
| public File getMarkerFile() { | ||
| return new File( | ||
| new File(getProject().getBuildDir(), "precommit"), | ||
| getName() | ||
| ); | ||
| } | ||
|
|
||
| @InputFiles | ||
| @SkipWhenEmpty | ||
| public FileCollection getClassesDirs() { | ||
| return classesDirs.filter(File::exists); | ||
| } | ||
|
|
||
| public void setClassesDirs(FileCollection classesDirs) { | ||
| this.classesDirs = classesDirs; | ||
| } | ||
|
|
||
| @InputFiles | ||
| public FileCollection getSignaturesFiles() { | ||
| return signaturesFiles; | ||
| } | ||
|
|
||
| public void setSignaturesFiles(FileCollection signaturesFiles) { | ||
| this.signaturesFiles = signaturesFiles; | ||
| } | ||
|
|
||
| @Input | ||
| public List<String> getSignatures() { | ||
| return signatures; | ||
| } | ||
|
|
||
| public void setSignatures(List<String> signatures) { | ||
| this.signatures = signatures; | ||
| } | ||
|
|
||
| @Input | ||
| public Set<String> getBundledSignatures() { | ||
| return bundledSignatures; | ||
| } | ||
|
|
||
| public void setBundledSignatures(Set<String> bundledSignatures) { | ||
| this.bundledSignatures = bundledSignatures; | ||
| } | ||
|
|
||
| @Input | ||
| public Set<String> getSuppressAnnotations() { | ||
| return suppressAnnotations; | ||
| } | ||
|
|
||
| public void setSuppressAnnotations(Set<String> suppressAnnotations) { | ||
| this.suppressAnnotations = suppressAnnotations; | ||
| } | ||
|
|
||
| @TaskAction | ||
| public void runForbiddenApisAndWriteMarker() throws IOException { | ||
| getProject().javaexec((JavaExecSpec spec) -> { | ||
| execAction.execute(spec); | ||
| spec.setMain(CliMain.class.getName()); | ||
| // build the command line | ||
| getSignaturesFiles().forEach(file -> spec.args("-f", file.getAbsolutePath())); | ||
| getSuppressAnnotations().forEach(annotation -> spec.args("--suppressannotation", annotation)); | ||
| getBundledSignatures().forEach(bundled -> { | ||
| // there's no option for target compatibility so we have to interpret it | ||
| final String prefix; | ||
| if (bundled.equals("jdk-system-out") || | ||
| bundled.equals("jdk-reflection") || | ||
| bundled.equals("jdk-non-portable")) { | ||
| prefix = ""; | ||
| } else { | ||
| prefix = "-" + ( | ||
| getTargetCompatibility().compareTo(JavaVersion.VERSION_1_9) >= 0 ? | ||
| getTargetCompatibility().getMajorVersion() : | ||
| "1." + getTargetCompatibility().getMajorVersion()) | ||
| ; | ||
| } | ||
| spec.args("-b", bundled + prefix); | ||
| } | ||
| ); | ||
| getClassesDirs().forEach(dir -> | ||
| spec.args("-d", dir) | ||
| ); | ||
| }); | ||
| Files.write(getMarkerFile().toPath(), Collections.emptyList()); | ||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we stick with the dsl of forbidden apis, instead of adding these helpers? I would like us to be able to switch back if/when it supports forking.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It this is the only concern, we can add these helpers with any implementation of the task.
I don't have a strong preference, but do like how these make the build scripts shorter, without involving build resources.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright, that is fine. Can we please name it
setinstead ofreplacethen, to match common naming with other gradle dsl elements?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rjernst
setwill not work, as the task already has that method, so the extension will never be fetched and called, but even with something likesetSignaturesit would be confusing as I don't thinksignatures = ...would work, as it won't call the closure on task extensions but look for a set method on the task instance.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm going to merge and submit a PR for the third party audit as well.
Let me know and I'll make changes to the name if needed,