Skip to content
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.

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

Add support for signature file URLs #77

Merged
merged 3 commits into from
Sep 24, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions src/main/java/de/thetaphi/forbiddenapis/Checker.java
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,11 @@ public final void parseSignaturesFile(InputStream in) throws IOException,ParseEx
parseSignaturesFile(in, false);
}

/** Reads a list of API signatures from the given URL. */
public final void parseSignaturesFile(URL url) throws IOException,ParseException {
parseSignaturesFile(url.openStream());
}

/** Reads a list of API signatures from the given file. */
public final void parseSignaturesFile(File f) throws IOException,ParseException {
parseSignaturesFile(new FileInputStream(f));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@

import org.gradle.api.DefaultTask;
import org.gradle.api.GradleException;
import org.gradle.api.Incubating;
import org.gradle.api.InvalidUserDataException;
import org.gradle.api.file.FileCollection;
import org.gradle.api.file.FileTree;
Expand Down Expand Up @@ -163,6 +164,26 @@ public void setSignaturesFiles(FileCollection signaturesFiles) {
data.signaturesFiles = signaturesFiles;
}

/**
* A list of references to URLs, which contain signatures and comments for forbidden API calls.
* The signatures are resolved against {@link #getClasspath()}.
* <p>
* This property is useful to refer to resources in plugin classpath, e.g., using
* {@link Class#getResource(String)}. It is not useful for general gradle builds. Especially,
* don't use it to refer to resources on foreign servers!
*/
@Input
@Optional
@Incubating
public List<URL> getSignaturesURLs() {
return data.signaturesURLs;
}

/** @see #getSignaturesURLs */
public void setSignaturesURLs(List<URL> signaturesURLs) {
data.signaturesURLs = signaturesURLs;
}

/**
* Gives multiple API signatures that are joined with newlines and
* parsed like a single {@link #getSignaturesFiles()}.
Expand Down Expand Up @@ -505,6 +526,11 @@ public void info(String msg) {
log.info("Reading API signatures: " + f);
checker.parseSignaturesFile(f);
}
final List<URL> signaturesURLs = getSignaturesURLs();
if (signaturesURLs != null) for (final URL url : signaturesURLs) {
log.info("Reading API signatures: " + url);
checker.parseSignaturesFile(url);
}
} catch (IOException ioe) {
throw new ResourceException("IO problem while reading files with API signatures.", ioe);
} catch (ParseException pe) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
* limitations under the License.
*/

import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
Expand All @@ -33,6 +34,7 @@ public class CheckForbiddenApisExtension {
/** Fields used for the convention mapping, keep up-to-date with class members! */
static final List<String> PROPS = Arrays.asList(
"signaturesFiles",
"signaturesURLs",
"signatures",
"bundledSignatures",
"suppressAnnotations",
Expand All @@ -44,6 +46,7 @@ public class CheckForbiddenApisExtension {
);

public FileCollection signaturesFiles;
public List<URL> signaturesURLs = new ArrayList<URL>();
public List<String> signatures = new ArrayList<String>(),
bundledSignatures = new ArrayList<String>(),
suppressAnnotations = new ArrayList<String>();
Expand Down