pl.project13.maven.git.GitDataProvider Maven / Gradle / Ivy
/*
* This file is part of git-commit-id-plugin by Konrad 'ktoso' Malawski
*
* git-commit-id-plugin is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* git-commit-id-plugin is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with git-commit-id-plugin. If not, see env) throws GitCommitIdExecutionException {
if (runningOnBuildServer(env)) {
return determineBranchNameOnBuildServer(env);
} else {
return getBranchName();
}
}
/**
* Detects if we're running on Jenkins or Hudson, based on expected env variables.
*
* TODO: How can we detect Bamboo, TeamCity etc? Pull requests welcome.
*
* @return true if running
* @see JenkinsSetEnvironmentVariables
* @param env environment settings
*/
private boolean runningOnBuildServer(Map env) {
return env.containsKey("HUDSON_URL") || env.containsKey("JENKINS_URL");
}
/**
* Is "Jenkins aware", and prefers {@code GIT_BRANCH} to getting the branch via git if that environment variable is set.
* The {@code GIT_BRANCH} variable is set by Jenkins/Hudson when put in detached HEAD state, but it still knows which branch was cloned.
*/
protected String determineBranchNameOnBuildServer(Map env) throws GitCommitIdExecutionException {
String environmentBasedBranch = env.get("GIT_BRANCH");
if (isNullOrEmpty(environmentBasedBranch)) {
log.info("Detected that running on CI environment, but using repository branch, no GIT_BRANCH detected.");
return getBranchName();
} else {
log.info("Using environment variable based branch name. GIT_BRANCH = {}", environmentBasedBranch);
return environmentBasedBranch;
}
}
protected SimpleDateFormat getSimpleDateFormatWithTimeZone(){
SimpleDateFormat smf = new SimpleDateFormat(dateFormat);
if (dateFormatTimeZone != null){
smf.setTimeZone(TimeZone.getTimeZone(dateFormatTimeZone));
}
return smf;
}
protected void put(@NotNull Properties properties, String key, String value) {
String keyWithPrefix = prefixDot + key;
log.info("{} {}", keyWithPrefix, value);
PropertyManager.putWithoutPrefix(properties, keyWithPrefix, value);
}
/**
* Regex to check for SCP-style SSH+GIT connection strings such as '[email protected]'
*/
static final Pattern GIT_SCP_FORMAT = Pattern.compile("^([a-zA-Z0-9_.+-])+@(.*)");
/**
* If the git remote value is a URI and contains a user info component, strip the password from it if it exists.
*
* @param gitRemoteString The value of the git remote
* @return
* @throws GitCommitIdExecutionException
*/
protected static String stripCredentialsFromOriginUrl(String gitRemoteString) throws GitCommitIdExecutionException {
// The URL might be null if the repo hasn't set a remote
if (gitRemoteString == null) {
return gitRemoteString;
}
// Remotes using ssh connection strings in the 'git@github' format aren't
// proper URIs and won't parse . Plus since you should be using SSH keys,
// credentials like are not in the URL.
if (GIT_SCP_FORMAT.matcher(gitRemoteString).matches()) {
return gitRemoteString;
}
// At this point, we should have a properly formatted URL
try {
URI original = new URI(gitRemoteString);
String userInfoString = original.getUserInfo();
if (null == userInfoString) {
return gitRemoteString;
}
URIBuilder b = new URIBuilder(gitRemoteString);
String[] userInfo = userInfoString.split(":");
// Build a new URL from the original URL, but nulling out the password
// component of the userinfo. We keep the username so that ssh uris such
// ssh://[email protected] will retain 'git@'.
b.setUserInfo(userInfo[0]);
return b.build().toString();
} catch (URISyntaxException e) {
throw new GitCommitIdExecutionException(e);
}
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy