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.

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

Jump to bottom

Add -Aversion command-line option; fixes #3381 #3464

Merged
merged 14 commits into from
Jul 20, 2020
Merged

Add -Aversion command-line option; fixes #3381 #3464

Changes from 10 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
5624d27
Merge pull request #1 from typetools/master
PRITI1999 Jul 10, 2020
c3f119d
Add version option and extract release properties
PRITI1999 Jul 10, 2020
f6839fa
Add version and extract relese properties
PRITI1999 Jul 10, 2020
22e5c0b
Merge branch 'master' of https://github.com/priti1999/checker-framewo…
PRITI1999 Jul 10, 2020
23d3c46
Adding functionality for -Aversion option
PRITI1999 Jul 11, 2020
26c69df
Remove unnecessary change
PRITI1999 Jul 11, 2020
8a83316
Improve comment
PRITI1999 Jul 11, 2020
74985e7
Improve naming and code
PRITI1999 Jul 12, 2020
7c6584f
improve fixes
PRITI1999 Jul 12, 2020
cef0d29
Improve documentation
PRITI1999 Jul 14, 2020
5addc49
Add requested changes to code
PRITI1999 Jul 15, 2020
2d29f7d
Remove unnecessary exception
PRITI1999 Jul 15, 2020
71a4d3f
Add documentation for the -Aversion option
PRITI1999 Jul 15, 2020
c865585
No need to document BugInCF condition
mernst Jul 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
34 changes: 34 additions & 0 deletions framework/src/main/java/org/checkerframework/framework/source/SourceChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,8 @@

/// Amount of detail in messages

// Print the version of the Checker Framework
"version",
mernst marked this conversation as resolved.
Show resolved Hide resolved
// Print info about git repository from which the Checker Framework was compiled
"printGitProperties",

Expand Down Expand Up @@ -781,6 +783,9 @@ public void run() {
}
});
}
if (hasOption("version")) {
messager.printMessage(Kind.NOTE, "Checker Framework " + getCheckerVersion());
}
} catch (UserError ce) {
logUserError(ce);
} catch (TypeSystemError ce) {
Expand Down Expand Up @@ -2530,4 +2535,33 @@ private void printGitProperties() {
System.out.println("IOException while reading git.properties: " + e.getMessage());
}
}

/**
* Extract the version of the Checker Framework
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: end sentences with punctuation (in this case, a period).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you use "Extract", say from where. Even better, I would leave implementation details like that out of the specification and just use "Returns".

*
* @throws IOException if unable to read docs/developer/release/release.properties or
* docs/examples/MavenExample/pom.xml file
* @throws NullPointerException if tag present in release.properties for Checker Framework
* version is not found in docs/examples/MavenExample/pom.xml
* @return Checker Framework version {@link String}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is usually not necessary to state the type, which is already stated nearby in the source code and in the generated API documentation.

*/
private String getCheckerVersion() throws IOException {
String version = null;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this variable needed?

String RLS_FILE = "/docs/developer/release/release.properties";
Properties releaseProperties = getProperties(getClass(), RLS_FILE);
String startTag = releaseProperties.getProperty("checkers.ver.0");
String endTag = releaseProperties.getProperty("checkers.ver.1");
String XML_FILE = "/docs/examples/MavenExample/pom.xml";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this work? It crashed for me when I tried to run it, because neither of the two files is not available in checker.jar.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could use git.properties instead. See method printGitProperties.

InputStream in = getClass().getResourceAsStream(XML_FILE);
BufferedReader reader = new BufferedReader(new InputStreamReader(in));
String line = null;
while ((line = reader.readLine()) != null) {
if (line.split(startTag).length > 1) {
version = line.split(startTag)[1].split(endTag)[0];
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line can be combined with the following one.

return version;
}
}
throw new NullPointerException(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an odd choice of exception. Why not use BugInCF?

"Could not find the version tag as mentioned in release.properties");
}
}