VIVO-29 Obtain revisión info from Git
Subversion is no longer relevant.
This commit is contained in:
j2blake
parent
e2b5c71874
commit
dcda958d8d
2 changed files with 253 additions and 353 deletions
|
|
@ -1,123 +0,0 @@
|
|||
/* $This file is distributed under the terms of the license in /doc/license.txt$ */
|
||||
|
||||
package edu.cornell.mannlib.vitro.utilities.revisioninfo;
|
||||
|
||||
import java.util.regex.Matcher;
|
||||
import java.util.regex.Pattern;
|
||||
|
||||
/**
|
||||
* Parse the response that we got from SVN info.
|
||||
*
|
||||
* Not thread-safe.
|
||||
*/
|
||||
public class InfoResponseParser {
|
||||
private static final Pattern URL_PATTERN = Pattern.compile("URL: (\\S+)");
|
||||
private static final Pattern ROOT_PATTERN = Pattern
|
||||
.compile("Repository Root: (\\S+)");
|
||||
|
||||
private static final String TRUNK_PREFIX = "/trunk";
|
||||
private static final String TAGS_PREFIX = "/tags/";
|
||||
private static final String BRANCHES_PREFIX = "/branches/";
|
||||
|
||||
private final String infoResponse;
|
||||
private String path;
|
||||
|
||||
public InfoResponseParser(String infoResponse) {
|
||||
this.infoResponse = infoResponse;
|
||||
}
|
||||
|
||||
public String parse() {
|
||||
try {
|
||||
path = figurePath();
|
||||
|
||||
if (isTrunkPath()) {
|
||||
return "trunk";
|
||||
} else if (isTagPath()) {
|
||||
return "tag " + getTagName();
|
||||
} else if (isBranchPath()) {
|
||||
return "branch " + getBranchName();
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
} catch (Exception e) {
|
||||
System.err.println(e);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
private String figurePath() throws Exception {
|
||||
if (infoResponse == null) {
|
||||
throw new Exception("infoResponse is null.");
|
||||
}
|
||||
|
||||
String url = getUrlFromResponse();
|
||||
String root = getRootFromResponse();
|
||||
|
||||
if (!url.startsWith(root)) {
|
||||
throw new Exception("url doesn't start with root.");
|
||||
}
|
||||
|
||||
return url.substring(root.length());
|
||||
}
|
||||
|
||||
private String getUrlFromResponse() throws Exception {
|
||||
return findNonEmptyMatch(URL_PATTERN, 1);
|
||||
}
|
||||
|
||||
private String getRootFromResponse() throws Exception {
|
||||
return findNonEmptyMatch(ROOT_PATTERN, 1);
|
||||
}
|
||||
|
||||
private String findNonEmptyMatch(Pattern pattern, int groupIndex)
|
||||
throws Exception {
|
||||
Matcher matcher = pattern.matcher(infoResponse);
|
||||
if (!matcher.find()) {
|
||||
throw new Exception("no match with '" + pattern + "'. Is your Subversion client out of date?");
|
||||
}
|
||||
|
||||
String value = matcher.group(groupIndex);
|
||||
if ((value == null) || (value.isEmpty())) {
|
||||
throw new Exception("match with '" + pattern + "' is empty.");
|
||||
}
|
||||
|
||||
return value;
|
||||
}
|
||||
|
||||
private boolean isTrunkPath() {
|
||||
return path.startsWith(TRUNK_PREFIX);
|
||||
}
|
||||
|
||||
private boolean isTagPath() {
|
||||
return path.startsWith(TAGS_PREFIX);
|
||||
}
|
||||
|
||||
private String getTagName() {
|
||||
return getFirstLevel(discardPrefix(path, TAGS_PREFIX));
|
||||
}
|
||||
|
||||
private boolean isBranchPath() {
|
||||
return path.startsWith(BRANCHES_PREFIX);
|
||||
}
|
||||
|
||||
private String getBranchName() {
|
||||
return getFirstLevel(discardPrefix(path, BRANCHES_PREFIX));
|
||||
}
|
||||
|
||||
private String discardPrefix(String string, String prefix) {
|
||||
if (string.length() < prefix.length()) {
|
||||
return "";
|
||||
} else {
|
||||
return string.substring(prefix.length());
|
||||
}
|
||||
}
|
||||
|
||||
private String getFirstLevel(String string) {
|
||||
int slashHere = string.indexOf('/');
|
||||
if (slashHere == -1) {
|
||||
return string;
|
||||
} else {
|
||||
return string.substring(0, slashHere);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -1,230 +1,253 @@
|
|||
/* $This file is distributed under the terms of the license in /doc/license.txt$ */
|
||||
|
||||
package edu.cornell.mannlib.vitro.utilities.revisioninfo;
|
||||
|
||||
import java.io.BufferedReader;
|
||||
import java.io.EOFException;
|
||||
import java.io.File;
|
||||
import java.io.FileReader;
|
||||
import java.io.FileWriter;
|
||||
import java.io.IOException;
|
||||
import java.io.Writer;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
|
||||
import edu.cornell.mannlib.vitro.utilities.revisioninfo.ProcessRunner.ProcessException;
|
||||
|
||||
/**
|
||||
* Get release and revision information to display on screen. Put this
|
||||
* information into a single line and append it to the specified file.
|
||||
*
|
||||
* Ask Subversion for the information. If Subversion is available, and if this
|
||||
* is a working directory, then we can build the info from the responses we get
|
||||
* from "svn info" and "svnversion".
|
||||
*
|
||||
* If that doesn't work, read the information from the "revisionInfo" file in
|
||||
* the product directory. Presumably, that file was created when the source was
|
||||
* exported from Subversion.
|
||||
*
|
||||
* If that doesn't work either, return something like this:
|
||||
* "productName ~ unknown ~ unknown"
|
||||
*/
|
||||
public class RevisionInfoBuilder {
|
||||
|
||||
/**
|
||||
* Indicates a problem with the command-line arguments.
|
||||
*/
|
||||
private static class UsageException extends Exception {
|
||||
UsageException(String message) {
|
||||
super(message);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* An object that holds the revision information and a message about how we
|
||||
* obtained it.
|
||||
*/
|
||||
private static class Results {
|
||||
final String message;
|
||||
final String infoLine;
|
||||
|
||||
Results(String message, String infoLine) {
|
||||
this.message = message;
|
||||
this.infoLine = infoLine;
|
||||
}
|
||||
|
||||
public String toString() {
|
||||
return message + ": " + infoLine;
|
||||
}
|
||||
}
|
||||
|
||||
private static final String SVN_DIRECTORY_NAME = ".svn";
|
||||
private static final String[] SVNVERSION_COMMAND = { "svnversion", "." };
|
||||
private static final String[] SVN_INFO_COMMAND = { "svn", "info" };
|
||||
private static final String INFO_LINE_DELIMITER = " ~ ";
|
||||
private static final String REVISION_INFO_FILENAME = "revisionInfo";
|
||||
|
||||
private final String productName;
|
||||
private final File productDirectory;
|
||||
private final File resultFile;
|
||||
|
||||
private Results results;
|
||||
|
||||
public RevisionInfoBuilder(String[] args) throws UsageException {
|
||||
if (args.length != 3) {
|
||||
throw new UsageException(
|
||||
"RevisionInfoBuilder requires 3 arguments, not "
|
||||
+ args.length);
|
||||
}
|
||||
|
||||
productName = args[0];
|
||||
productDirectory = new File(args[1]);
|
||||
resultFile = new File(args[2]);
|
||||
|
||||
if (!productDirectory.isDirectory()) {
|
||||
throw new UsageException("Directory '"
|
||||
+ productDirectory.getAbsolutePath() + "' does not exist.");
|
||||
}
|
||||
|
||||
if (!resultFile.getParentFile().exists()) {
|
||||
throw new UsageException("Result file '"
|
||||
+ resultFile.getAbsolutePath()
|
||||
+ "' does not exist, and we can't create it "
|
||||
+ "because it's parent directory doesn't exist either.");
|
||||
}
|
||||
}
|
||||
|
||||
private void buildInfo() {
|
||||
results = buildInfoFromSubversion();
|
||||
if (results == null) {
|
||||
results = buildInfoFromFile();
|
||||
}
|
||||
if (results == null) {
|
||||
results = buildDummyInfo();
|
||||
}
|
||||
}
|
||||
|
||||
private Results buildInfoFromSubversion() {
|
||||
if (!isThisASubversionWorkspace()) {
|
||||
System.out.println("Not a Subversion workspace");
|
||||
return null;
|
||||
}
|
||||
|
||||
String release = assembleReleaseNameFromSubversion();
|
||||
if (release == null) {
|
||||
System.out.println("Couldn't get release name from Subversion");
|
||||
return null;
|
||||
}
|
||||
|
||||
String revision = obtainRevisionLevelFromSubversion();
|
||||
if (revision == null) {
|
||||
System.out.println("Couldn't get revision level from Subversion");
|
||||
return null;
|
||||
}
|
||||
|
||||
return new Results("Info from Subversion", buildLine(release, revision));
|
||||
}
|
||||
|
||||
private boolean isThisASubversionWorkspace() {
|
||||
File svnDirectory = new File(productDirectory, SVN_DIRECTORY_NAME);
|
||||
return svnDirectory.isDirectory();
|
||||
}
|
||||
|
||||
private String assembleReleaseNameFromSubversion() {
|
||||
String infoResponse = runSubProcess(SVN_INFO_COMMAND);
|
||||
return new InfoResponseParser(infoResponse).parse();
|
||||
}
|
||||
|
||||
private String obtainRevisionLevelFromSubversion() {
|
||||
String response = runSubProcess(SVNVERSION_COMMAND);
|
||||
return (response == null) ? null : response.trim();
|
||||
}
|
||||
|
||||
private String runSubProcess(String[] cmdArray) {
|
||||
List<String> command = Arrays.asList(cmdArray);
|
||||
try {
|
||||
ProcessRunner runner = new ProcessRunner();
|
||||
runner.setWorkingDirectory(productDirectory);
|
||||
|
||||
runner.run(command);
|
||||
|
||||
int rc = runner.getReturnCode();
|
||||
if (rc != 0) {
|
||||
throw new ProcessRunner.ProcessException("Return code from "
|
||||
+ command + " was " + rc);
|
||||
}
|
||||
|
||||
String output = runner.getStdOut();
|
||||
// System.err.println(command + " response was '" + output + "'");
|
||||
return output;
|
||||
} catch (ProcessException e) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
private Results buildInfoFromFile() {
|
||||
try {
|
||||
File revisionInfoFile = new File(productDirectory,
|
||||
REVISION_INFO_FILENAME);
|
||||
BufferedReader reader = new BufferedReader(new FileReader(
|
||||
revisionInfoFile));
|
||||
|
||||
String release = reader.readLine();
|
||||
if (release == null) {
|
||||
throw new EOFException("No release line in file.");
|
||||
}
|
||||
|
||||
String revision = reader.readLine();
|
||||
if (revision == null) {
|
||||
throw new EOFException("No revision line in file.");
|
||||
}
|
||||
|
||||
return new Results("Info from file", buildLine(release, revision));
|
||||
} catch (IOException e) {
|
||||
System.out.println("No information from file: " + e);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
private Results buildDummyInfo() {
|
||||
String line = buildLine(null, null);
|
||||
return new Results("Using dummy info", line);
|
||||
}
|
||||
|
||||
private String buildLine(String release, String revision) {
|
||||
if (release == null) {
|
||||
release = "unknown";
|
||||
}
|
||||
if (revision == null) {
|
||||
revision = "unknown";
|
||||
}
|
||||
return productName + INFO_LINE_DELIMITER + release.trim()
|
||||
+ INFO_LINE_DELIMITER + revision.trim();
|
||||
}
|
||||
|
||||
private void writeLine() throws IOException {
|
||||
Writer writer = null;
|
||||
writer = new FileWriter(resultFile, true);
|
||||
writer.write(results.infoLine + "\n");
|
||||
writer.close();
|
||||
|
||||
System.out.println(results);
|
||||
}
|
||||
|
||||
public static void main(String[] args) {
|
||||
try {
|
||||
RevisionInfoBuilder builder = new RevisionInfoBuilder(args);
|
||||
builder.buildInfo();
|
||||
builder.writeLine();
|
||||
} catch (UsageException e) {
|
||||
System.err.println(e);
|
||||
System.err.println("usage: RevisionInfoBuilder [product_name] "
|
||||
+ "[product_directory] [output_file]");
|
||||
System.exit(1);
|
||||
} catch (Exception e) {
|
||||
e.printStackTrace();
|
||||
System.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
/* $This file is distributed under the terms of the license in /doc/license.txt$ */
|
||||
|
||||
package edu.cornell.mannlib.vitro.utilities.revisioninfo;
|
||||
|
||||
import java.io.BufferedReader;
|
||||
import java.io.EOFException;
|
||||
import java.io.File;
|
||||
import java.io.FileReader;
|
||||
import java.io.FileWriter;
|
||||
import java.io.IOException;
|
||||
import java.io.Writer;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
|
||||
import edu.cornell.mannlib.vitro.utilities.revisioninfo.ProcessRunner.ProcessException;
|
||||
|
||||
/**
|
||||
* Get release and revision information to display on screen. Put this
|
||||
* information into a single line and append it to the specified file.
|
||||
*
|
||||
* Ask Git for the information. If Git is available, and if this is a working
|
||||
* directory, then we can build the info from the responses we get from
|
||||
* "git describe", "git symbolic-ref" and "git log".
|
||||
*
|
||||
* If that doesn't work, read the information from the "revisionInfo" file in
|
||||
* the product directory. Presumably, that file was created when the source was
|
||||
* exported from Git.
|
||||
*
|
||||
* If that doesn't work either, return something like this:
|
||||
* "productName ~ unknown ~ unknown"
|
||||
*/
|
||||
public class RevisionInfoBuilder {
|
||||
|
||||
/**
|
||||
* Indicates a problem with the command-line arguments.
|
||||
*/
|
||||
private static class UsageException extends Exception {
|
||||
UsageException(String message) {
|
||||
super(message);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* An object that holds the revision information and a message about how we
|
||||
* obtained it.
|
||||
*/
|
||||
private static class Results {
|
||||
final String message;
|
||||
final String infoLine;
|
||||
|
||||
Results(String message, String infoLine) {
|
||||
this.message = message;
|
||||
this.infoLine = infoLine;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return message + ": " + infoLine;
|
||||
}
|
||||
}
|
||||
|
||||
private static final String GIT_DIRECTORY_NAME = ".git";
|
||||
private static final String[] GIT_DESCRIBE_COMMAND = { "git", "describe" };
|
||||
private static final String[] GIT_SREF_COMMAND = { "git", "symbolic-ref",
|
||||
"HEAD" };
|
||||
private static final String[] GIT_LOG_COMMAND = { "git", "log",
|
||||
"--pretty=format:%h", "-1" };
|
||||
private static final String INFO_LINE_DELIMITER = " ~ ";
|
||||
private static final String REVISION_INFO_FILENAME = "revisionInfo";
|
||||
|
||||
private final String productName;
|
||||
private final File productDirectory;
|
||||
private final File resultFile;
|
||||
|
||||
private Results results;
|
||||
|
||||
public RevisionInfoBuilder(String[] args) throws UsageException {
|
||||
if (args.length != 3) {
|
||||
throw new UsageException(
|
||||
"RevisionInfoBuilder requires 3 arguments, not "
|
||||
+ args.length);
|
||||
}
|
||||
|
||||
productName = args[0];
|
||||
productDirectory = new File(args[1]);
|
||||
resultFile = new File(args[2]);
|
||||
|
||||
if (!productDirectory.isDirectory()) {
|
||||
throw new UsageException("Directory '"
|
||||
+ productDirectory.getAbsolutePath() + "' does not exist.");
|
||||
}
|
||||
|
||||
if (!resultFile.getParentFile().exists()) {
|
||||
throw new UsageException("Result file '"
|
||||
+ resultFile.getAbsolutePath()
|
||||
+ "' does not exist, and we can't create it "
|
||||
+ "because it's parent directory doesn't exist either.");
|
||||
}
|
||||
}
|
||||
|
||||
private void buildInfo() {
|
||||
results = buildInfoFromGit();
|
||||
if (results == null) {
|
||||
results = buildInfoFromFile();
|
||||
}
|
||||
if (results == null) {
|
||||
results = buildDummyInfo();
|
||||
}
|
||||
}
|
||||
|
||||
private Results buildInfoFromGit() {
|
||||
if (!isThisAGitWorkspace()) {
|
||||
System.out.println("Not a git workspace");
|
||||
return null;
|
||||
}
|
||||
|
||||
String release = assembleReleaseNameFromGit();
|
||||
if (release == null) {
|
||||
System.out.println("Couldn't get release name from Git");
|
||||
}
|
||||
|
||||
String revision = obtainCommitIdFromGit();
|
||||
if (revision == null) {
|
||||
System.out.println("Couldn't get commit ID from Git");
|
||||
}
|
||||
|
||||
if ((revision == null) && (release == null)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return new Results("Info from Git", buildLine(release, revision));
|
||||
}
|
||||
|
||||
private boolean isThisAGitWorkspace() {
|
||||
File gitDirectory = new File(productDirectory, GIT_DIRECTORY_NAME);
|
||||
return gitDirectory.isDirectory();
|
||||
}
|
||||
|
||||
private String assembleReleaseNameFromGit() {
|
||||
String describeResponse = runSubProcess(GIT_DESCRIBE_COMMAND);
|
||||
String srefResponse = runSubProcess(GIT_SREF_COMMAND);
|
||||
return parseReleaseName(describeResponse, srefResponse);
|
||||
}
|
||||
|
||||
private String obtainCommitIdFromGit() {
|
||||
String logResponse = runSubProcess(GIT_LOG_COMMAND);
|
||||
return parseLogResponse(logResponse);
|
||||
}
|
||||
|
||||
private String parseReleaseName(String describeResponse, String srefResponse) {
|
||||
if (describeResponse != null) {
|
||||
return describeResponse.trim() + " tag";
|
||||
} else if (srefResponse != null) {
|
||||
return srefResponse.substring(srefResponse.lastIndexOf('/') + 1)
|
||||
.trim() + " branch";
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
private String parseLogResponse(String logResponse) {
|
||||
return logResponse;
|
||||
}
|
||||
|
||||
private String runSubProcess(String[] cmdArray) {
|
||||
List<String> command = Arrays.asList(cmdArray);
|
||||
try {
|
||||
ProcessRunner runner = new ProcessRunner();
|
||||
runner.setWorkingDirectory(productDirectory);
|
||||
|
||||
runner.run(command);
|
||||
|
||||
int rc = runner.getReturnCode();
|
||||
if (rc != 0) {
|
||||
throw new ProcessRunner.ProcessException("Return code from "
|
||||
+ command + " was " + rc);
|
||||
}
|
||||
|
||||
String output = runner.getStdOut();
|
||||
// System.err.println(command + " response was '" + output + "'");
|
||||
return output;
|
||||
} catch (ProcessException e) {
|
||||
// System.out.println(e);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
private Results buildInfoFromFile() {
|
||||
try {
|
||||
File revisionInfoFile = new File(productDirectory,
|
||||
REVISION_INFO_FILENAME);
|
||||
BufferedReader reader = new BufferedReader(new FileReader(
|
||||
revisionInfoFile));
|
||||
|
||||
String release = reader.readLine();
|
||||
if (release == null) {
|
||||
throw new EOFException("No release line in file.");
|
||||
}
|
||||
|
||||
String revision = reader.readLine();
|
||||
if (revision == null) {
|
||||
throw new EOFException("No revision line in file.");
|
||||
}
|
||||
|
||||
return new Results("Info from file", buildLine(release, revision));
|
||||
} catch (IOException e) {
|
||||
System.out.println("No information from file: " + e);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
private Results buildDummyInfo() {
|
||||
String line = buildLine(null, null);
|
||||
return new Results("Using dummy info", line);
|
||||
}
|
||||
|
||||
private String buildLine(String release, String revision) {
|
||||
if (release == null) {
|
||||
release = "unknown";
|
||||
}
|
||||
if (revision == null) {
|
||||
revision = "unknown";
|
||||
}
|
||||
return productName + INFO_LINE_DELIMITER + release.trim()
|
||||
+ INFO_LINE_DELIMITER + revision.trim();
|
||||
}
|
||||
|
||||
private void writeLine() throws IOException {
|
||||
Writer writer = null;
|
||||
writer = new FileWriter(resultFile, true);
|
||||
writer.write(results.infoLine + "\n");
|
||||
writer.close();
|
||||
|
||||
System.out.println(results);
|
||||
}
|
||||
|
||||
public static void main(String[] args) {
|
||||
try {
|
||||
RevisionInfoBuilder builder = new RevisionInfoBuilder(args);
|
||||
builder.buildInfo();
|
||||
builder.writeLine();
|
||||
} catch (UsageException e) {
|
||||
System.err.println(e);
|
||||
System.err.println("usage: RevisionInfoBuilder [product_name] "
|
||||
+ "[product_directory] [output_file]");
|
||||
System.exit(1);
|
||||
} catch (Exception e) {
|
||||
e.printStackTrace();
|
||||
System.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue