org.jfrog.build.client.ArtifactoryBuildInfoClient Maven / Gradle / Ivy
/*
* Copyright (C) 2011 JFrog Ltd.
*
* Licensed 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.jfrog.build.client;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import org.apache.commons.lang.StringUtils;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.StatusLine;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.entity.FileEntity;
import org.apache.http.entity.StringEntity;
import org.apache.http.protocol.HTTP;
import org.codehaus.jackson.JsonFactory;
import org.codehaus.jackson.JsonGenerator;
import org.codehaus.jackson.JsonNode;
import org.codehaus.jackson.JsonParser;
import org.jfrog.build.api.Build;
import org.jfrog.build.api.release.Promotion;
import org.jfrog.build.api.util.FileChecksumCalculator;
import org.jfrog.build.api.util.Log;
import java.io.IOException;
import java.io.InputStream;
import java.io.StringWriter;
import java.io.UnsupportedEncodingException;
import java.security.NoSuchAlgorithmException;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import static org.jfrog.build.client.ArtifactoryHttpClient.*;
/**
* Artifactory client to perform build info related tasks.
*
* @author Yossi Shaul
*/
public class ArtifactoryBuildInfoClient {
private final Log log;
private static final String LOCAL_REPOS_REST_URL = "/api/repositories?type=local";
private static final String VIRTUAL_REPOS_REST_URL = "/api/repositories?type=virtual";
private static final String BUILD_REST_URL = "/api/build";
private static final int CHECKSUM_DEPLOY_MIN_FILE_SIZE = 10240; // Try checksum deploy of files greater than 10KB
/**
* The http client used for deploying artifacts and build info. Created and cached on the first deploy request.
*/
private ArtifactoryHttpClient httpClient;
private String artifactoryUrl;
/**
* Version of Artifactory we work with.
*/
private ArtifactoryVersion artifactoryVersion;
/**
* Creates a new client for the given Artifactory url.
*
* @param artifactoryUrl Artifactory url in the form of: protocol://host[:port]/contextPath
*/
public ArtifactoryBuildInfoClient(String artifactoryUrl, Log log) {
this(artifactoryUrl, null, null, log);
}
/**
* Creates a new client for the given Artifactory url.
*
* @param artifactoryUrl Artifactory url in the form of: protocol://host[:port]/contextPath
* @param username Authentication username
* @param password Authentication password
*/
public ArtifactoryBuildInfoClient(String artifactoryUrl, String username, String password, Log log) {
this.artifactoryUrl = StringUtils.stripEnd(artifactoryUrl, "/");
httpClient = new ArtifactoryHttpClient(this.artifactoryUrl, username, password, log);
this.log = log;
}
/**
* Network timeout in seconds to use both for connection establishment and for unanswered requests.
*
* @param connectionTimeout Timeout in seconds.
*/
public void setConnectionTimeout(int connectionTimeout) {
httpClient.setConnectionTimeout(connectionTimeout);
}
/**
* Sets the proxy host and port.
*
* @param host Proxy host
* @param port Proxy port
*/
public void setProxyConfiguration(String host, int port) {
httpClient.setProxyConfiguration(host, port, null, null);
}
/**
* Sets the proxy details.
*
* @param host Proxy host
* @param port Proxy port
* @param username Username to authenticate with the proxy
* @param password Password to authenticate with the proxy
*/
public void setProxyConfiguration(String host, int port, String username, String password) {
httpClient.setProxyConfiguration(host, port, username, password);
}
/**
* @return A list of local repositories available for deployment.
* @throws IOException On any connection error
*/
public List getLocalRepositoriesKeys() throws IOException {
List repositories = new ArrayList();
PreemptiveHttpClient client = httpClient.getHttpClient();
String localReposUrl = artifactoryUrl + LOCAL_REPOS_REST_URL;
log.debug("Requesting local repositories list from: " + localReposUrl);
HttpGet httpget = new HttpGet(localReposUrl);
HttpResponse response = client.execute(httpget);
StatusLine statusLine = response.getStatusLine();
HttpEntity entity = response.getEntity();
if (statusLine.getStatusCode() != HttpStatus.SC_OK) {
if (entity != null) {
entity.consumeContent();
}
throwHttpIOException("Failed to obtain list of repositories:", statusLine);
} else {
if (entity != null) {
repositories = new ArrayList();
InputStream content = entity.getContent();
JsonParser parser;
try {
parser = httpClient.createJsonParser(content);
JsonNode result = parser.readValueAsTree();
log.debug("Repositories result = " + result);
for (JsonNode jsonNode : result) {
String repositoryKey = jsonNode.get("key").getTextValue();
repositories.add(repositoryKey);
}
} finally {
if (content != null) {
content.close();
}
}
}
}
return repositories;
}
/**
* @return A list of local repositories available for deployment.
* @throws IOException On any connection error
*/
public List getVirtualRepositoryKeys() throws IOException {
List repositories = new ArrayList();
PreemptiveHttpClient client = httpClient.getHttpClient();
String localReposUrl = artifactoryUrl + VIRTUAL_REPOS_REST_URL;
log.debug("Requesting local repositories list from: " + localReposUrl);
HttpGet httpget = new HttpGet(localReposUrl);
HttpResponse response = client.execute(httpget);
StatusLine statusLine = response.getStatusLine();
HttpEntity entity = response.getEntity();
if (statusLine.getStatusCode() != HttpStatus.SC_OK) {
if (entity != null) {
entity.consumeContent();
}
throwHttpIOException("Failed to obtain list of repositories:", statusLine);
} else {
if (entity != null) {
repositories = new ArrayList();
InputStream content = entity.getContent();
JsonParser parser;
try {
parser = httpClient.createJsonParser(content);
JsonNode result = parser.readValueAsTree();
log.debug("Repositories result = " + result);
for (JsonNode jsonNode : result) {
String repositoryKey = jsonNode.get("key").getTextValue();
repositories.add(repositoryKey);
}
} finally {
if (content != null) {
content.close();
}
}
}
}
return repositories;
}
public void sendBuildInfo(String buildInfoJson) throws IOException {
String url = artifactoryUrl + BUILD_REST_URL;
HttpPut httpPut = new HttpPut(url);
StringEntity stringEntity = new StringEntity(buildInfoJson, "UTF-8");
stringEntity.setContentType("application/vnd.org.jfrog.artifactory+json");
httpPut.setEntity(stringEntity);
log.info("Deploying build info to: " + url);
HttpResponse response = httpClient.getHttpClient().execute(httpPut);
if (response.getEntity() != null) {
response.getEntity().consumeContent();
}
StatusLine statusLine = response.getStatusLine();
if (statusLine.getStatusCode() != HttpStatus.SC_NO_CONTENT) {
throwHttpIOException("Failed to send build info:", statusLine);
}
}
/**
* Sends build info to Artifactory.
*
* @param buildInfo The build info to send
* @throws IOException On any connection error
*/
public void sendBuildInfo(Build buildInfo) throws IOException {
try {
sendBuildInfo( buildInfoToJsonString( buildInfo ));
} catch (Exception e) {
log.error("Could not build the build-info object.", e);
throw new IOException("Could not publish build-info: " + e.getMessage());
}
}
public String getItemLastModified(String path) throws IOException, ParseException {
String url = artifactoryUrl + "/api/storage/" + path + "?lastModified&deep=1";
HttpGet get = new HttpGet(url);
HttpResponse response = httpClient.getHttpClient().execute(get);
StatusLine statusLine = response.getStatusLine();
if (statusLine.getStatusCode() != HttpStatus.SC_OK) {
HttpEntity entity = response.getEntity();
if (entity != null) {
entity.consumeContent();
}
throwHttpIOException("Failed to obtain item info:", statusLine);
} else {
HttpEntity entity = response.getEntity();
if (entity != null) {
InputStream content = entity.getContent();
JsonParser parser;
try {
parser = httpClient.createJsonParser(content);
JsonNode result = parser.readValueAsTree();
return result.get("lastModified").getTextValue();
} finally {
if (content != null) {
content.close();
}
entity.consumeContent();
}
}
}
return null;
}
/**
* Deploys the artifact to the destination repository.
*
* @param details Details about the deployed artifact
* @throws IOException On any connection error
*/
public void deployArtifact(DeployDetails details) throws IOException {
StringBuilder deploymentPathBuilder = new StringBuilder(artifactoryUrl);
deploymentPathBuilder.append("/").append(details.getTargetRepository());
if (!details.artifactPath.startsWith("/")) {
deploymentPathBuilder.append("/");
}
deploymentPathBuilder.append(details.artifactPath);
String deploymentPath = deploymentPathBuilder.toString();
log.info("Deploying artifact: " + deploymentPath);
deploymentPath = httpClient.encodeUrl(deploymentPath);
uploadFile(details, deploymentPath);
// Artifactory 2.3.2+ will take the checksum from the headers of the put request for the file
if (!getArtifactoryVersion().isAtLeast(new ArtifactoryVersion("2.3.2"))) {
uploadChecksums(details, deploymentPath);
}
}
/**
* @return Artifactory version if working against a compatible version of Artifactory
* @throws IOException If server not found or it doesn't answer to the version query or it is too old
*/
public ArtifactoryVersion verifyCompatibleArtifactoryVersion() throws VersionException {
ArtifactoryVersion version;
try {
version = httpClient.getVersion();
} catch (IOException e) {
throw new VersionException("Error occurred while requesting version information: " + e.getMessage(), e,
VersionCompatibilityType.NOT_FOUND);
}
if (version.isNotFound()) {
throw new VersionException(
"There is either an incompatible or no instance of Artifactory at the provided URL.",
VersionCompatibilityType.NOT_FOUND);
}
boolean isCompatibleArtifactory = version.isAtLeast(MINIMAL_ARTIFACTORY_VERSION);
if (!isCompatibleArtifactory) {
throw new VersionException("This plugin is compatible with version " + MINIMAL_ARTIFACTORY_VERSION +
" of Artifactory and above. Please upgrade your Artifactory server!",
VersionCompatibilityType.INCOMPATIBLE);
}
return version;
}
public HttpResponse stageBuild(String buildName, String buildNumber, Promotion promotion) throws IOException {
if (StringUtils.isBlank(buildName)) {
throw new IllegalArgumentException("Build name is required for promotion.");
}
if (StringUtils.isBlank(buildNumber)) {
throw new IllegalArgumentException("Build number is required for promotion.");
}
StringBuilder urlBuilder = new StringBuilder(artifactoryUrl).append(BUILD_REST_URL).append("/promote/").
append(httpClient.encodeUrl(buildName)).append("/").append(httpClient.encodeUrl(buildNumber));
String promotionJson = toJsonString(promotion);
HttpPost httpPost = new HttpPost(urlBuilder.toString());
StringEntity stringEntity = new StringEntity(promotionJson);
stringEntity.setContentType("application/vnd.org.jfrog.artifactory.build.PromotionRequest+json");
httpPost.setEntity(stringEntity);
log.info("Promoting build " + buildName + ", #" + buildNumber);
return httpClient.getHttpClient().execute(httpPost);
}
public Map> getUserPluginInfo() throws IOException {
String url = new StringBuilder(artifactoryUrl).append("/api/plugins").toString();
HttpGet getPlugins = new HttpGet(url);
HttpResponse getResponse = httpClient.getHttpClient().execute(getPlugins);
StatusLine statusLine = getResponse.getStatusLine();
HttpEntity responseEntity = getResponse.getEntity();
if (statusLine.getStatusCode() != HttpStatus.SC_OK) {
if (responseEntity != null) {
responseEntity.consumeContent();
}
throwHttpIOException("Failed to obtain user plugin information:", statusLine);
} else {
if (responseEntity != null) {
InputStream content = responseEntity.getContent();
JsonParser parser;
try {
parser = httpClient.createJsonParser(content);
return parser.readValueAs(Map.class);
} finally {
if (content != null) {
content.close();
}
}
}
}
return Maps.newHashMap();
}
public HttpResponse executeUserPlugin(String executionName, Map requestParams) throws IOException {
StringBuilder urlBuilder = new StringBuilder(artifactoryUrl).append("/api/plugins/execute/")
.append(executionName).append("?");
appendParamsToUrl(requestParams, urlBuilder);
HttpPost postRequest = new HttpPost(urlBuilder.toString());
return httpClient.getHttpClient().execute(postRequest);
}
public Map getStagingStrategy(String strategyName, String buildName, Map requestParams)
throws IOException {
StringBuilder urlBuilder = new StringBuilder(artifactoryUrl).append("/api/plugins/build/staging/")
.append(httpClient.encodeUrl(strategyName)).append("?buildName=")
.append(httpClient.encodeUrl(buildName)).append("&");
appendParamsToUrl(requestParams, urlBuilder);
HttpGet getRequest = new HttpGet(urlBuilder.toString());
HttpResponse response = httpClient.getHttpClient().execute(getRequest);
StatusLine statusLine = response.getStatusLine();
HttpEntity responseEntity = response.getEntity();
if (statusLine.getStatusCode() != HttpStatus.SC_OK) {
if (responseEntity != null) {
responseEntity.consumeContent();
}
throwHttpIOException("Failed to obtain staging strategy:", statusLine);
} else {
if (responseEntity != null) {
InputStream content = responseEntity.getContent();
JsonParser parser;
try {
parser = httpClient.createJsonParser(content);
return parser.readValueAs(Map.class);
} finally {
if (content != null) {
content.close();
}
}
}
}
return Maps.newHashMap();
}
public HttpResponse executePromotionUserPlugin(String promotionName, String buildName, String buildNumber,
Map requestParams) throws IOException {
StringBuilder urlBuilder = new StringBuilder(artifactoryUrl).append("/api/plugins/build/promote/")
.append(promotionName).append("/").append(httpClient.encodeUrl(buildName)).append("/")
.append(httpClient.encodeUrl(buildNumber)).append("?");
appendParamsToUrl(requestParams, urlBuilder);
HttpPost postRequest = new HttpPost(urlBuilder.toString());
return httpClient.getHttpClient().execute(postRequest);
}
/**
* Release all connection and cleanup resources.
*/
public void shutdown() {
if (httpClient != null) {
httpClient.shutdown();
}
}
private void appendParamsToUrl(Map requestParams, StringBuilder urlBuilder)
throws UnsupportedEncodingException {
if ((requestParams != null) && !requestParams.isEmpty()) {
urlBuilder.append("params=");
Iterator> paramEntryIterator = requestParams.entrySet().iterator();
String encodedPipe = httpClient.encodeUrl("|");
while (paramEntryIterator.hasNext()) {
Map.Entry paramEntry = paramEntryIterator.next();
urlBuilder.append(httpClient.encodeUrl(paramEntry.getKey()));
String paramValue = paramEntry.getValue();
if (StringUtils.isNotBlank(paramValue)) {
urlBuilder.append("=").append(httpClient.encodeUrl(paramValue));
}
if (paramEntryIterator.hasNext()) {
urlBuilder.append(encodedPipe);
}
}
}
}
public String buildInfoToJsonString(Build buildInfo) throws Exception {
ArtifactoryVersion version = verifyCompatibleArtifactoryVersion();
//From Artifactory 2.2.3 we do not need to discard new properties in order to avoid a server side exception on
//JSON parsing. Our JSON writer is configured to discard null values.
if (!version.isAtLeast(UNKNOWN_PROPERTIES_TOLERANT_ARTIFACTORY_VERSION)) {
buildInfo.setBuildAgent(null);
buildInfo.setParentName(null);
buildInfo.setParentNumber(null);
buildInfo.setVcsRevision(null);
}
//From Artifactory 2.2.4 we also handle non-numeric build numbers
if (!version.isAtLeast(NON_NUMERIC_BUILD_NUMBERS_TOLERANT_ARTIFACTORY_VERSION)) {
String buildNumber = buildInfo.getNumber();
verifyNonNumericBuildNumber(buildNumber);
String parentBuildNumber = buildInfo.getParentNumber();
verifyNonNumericBuildNumber(parentBuildNumber);
}
return toJsonString(buildInfo);
}
String toJsonString(Object object) throws IOException {
JsonFactory jsonFactory = httpClient.createJsonFactory();
StringWriter writer = new StringWriter();
JsonGenerator jsonGenerator = jsonFactory.createJsonGenerator(writer);
jsonGenerator.useDefaultPrettyPrinter();
jsonGenerator.writeObject(object);
String result = writer.getBuffer().toString();
return result;
}
private void verifyNonNumericBuildNumber(String buildNumber) {
if (buildNumber != null) {
try {
Long.parseLong(buildNumber);
} catch (NumberFormatException e) {
throw new IllegalArgumentException(
"Cannot handle build/parent build number: " + buildNumber +
". Non-numeric build numbers are supported by Artifactory version " +
NON_NUMERIC_BUILD_NUMBERS_TOLERANT_ARTIFACTORY_VERSION +
" and above. Please upgrade your Artifactory or use numeric build numbers.");
}
}
}
private void uploadFile(DeployDetails details, String uploadUrl) throws IOException {
if (tryChecksumDeploy(details, uploadUrl)) {
return;
}
HttpPut httpPut = createHttpPutMethod(details, uploadUrl);
// add the 100 continue directive
httpPut.addHeader(HTTP.EXPECT_DIRECTIVE, HTTP.EXPECT_CONTINUE);
FileEntity fileEntity = new FileEntity(details.file, "binary/octet-stream");
StatusLine statusLine = httpClient.upload(httpPut, fileEntity);
int statusCode = statusLine.getStatusCode();
//Accept both 200, and 201 for backwards-compatibility reasons
if ((statusCode != HttpStatus.SC_CREATED) && (statusCode != HttpStatus.SC_OK)) {
throwHttpIOException("Failed to deploy file:", statusLine);
}
}
private boolean tryChecksumDeploy(DeployDetails details, String uploadUrl) throws UnsupportedEncodingException {
// Try checksum deploy only on file size greater than CHECKSUM_DEPLOY_MIN_FILE_SIZE
long fileLength = details.file.length();
if (fileLength < CHECKSUM_DEPLOY_MIN_FILE_SIZE) {
log.debug("Skipping checksum deploy of file size " + fileLength + " , falling back to regular deployment.");
return false;
}
// Artifactory 2.5.1+ has efficient checksum deployment (checks if the artifact already exists by it's checksum)
if (!getArtifactoryVersion().isAtLeast(new ArtifactoryVersion("2.5.1"))) {
return false;
}
HttpPut httpPut = createHttpPutMethod(details, uploadUrl);
// activate checksum deploy
httpPut.addHeader("X-Checksum-Deploy", "true");
String fileAbsolutePath = details.file.getAbsolutePath();
try {
StatusLine statusLine = httpClient.execute(httpPut);
int statusCode = statusLine.getStatusCode();
//Accept both 200, and 201 for backwards-compatibility reasons
if ((statusCode == HttpStatus.SC_CREATED) || (statusCode == HttpStatus.SC_OK)) {
log.debug("Successfully performed checksum deploy of file " + fileAbsolutePath + " : " + details.sha1);
return true;
} else {
log.debug("Failed checksum deploy of checksum '" + details.sha1 + "' with statusCode: " + statusCode);
}
} catch (IOException e) {
log.debug("Failed artifact checksum deploy of file " + fileAbsolutePath + " : " + details.sha1);
}
return false;
}
private HttpPut createHttpPutMethod(DeployDetails details, String uploadUrl) throws UnsupportedEncodingException {
StringBuilder deploymentPathBuilder = new StringBuilder().append(uploadUrl);
deploymentPathBuilder.append(buildMatrixParamsString(details.properties));
HttpPut httpPut = new HttpPut(deploymentPathBuilder.toString());
httpPut.addHeader("X-Checksum-Sha1", details.sha1);
httpPut.addHeader("X-Checksum-Md5", details.md5);
return httpPut;
}
public void uploadChecksums(DeployDetails details, String uploadUrl) throws IOException {
Map checksums = getChecksumMap(details);
String fileAbsolutePath = details.file.getAbsolutePath();
String sha1 = checksums.get("SHA1");
if (StringUtils.isNotBlank(sha1)) {
log.debug("Uploading SHA1 for file " + fileAbsolutePath + " : " + sha1);
String sha1Url = uploadUrl + ".sha1" + buildMatrixParamsString(details.properties);
HttpPut putSha1 = new HttpPut(sha1Url);
StringEntity sha1StringEntity = new StringEntity(sha1);
StatusLine sha1StatusLine = httpClient.upload(putSha1, sha1StringEntity);
int sha1StatusCode = sha1StatusLine.getStatusCode();
//Accept both 200, and 201 for backwards-compatibility reasons
if ((sha1StatusCode != HttpStatus.SC_CREATED) && (sha1StatusCode != HttpStatus.SC_OK)) {
throwHttpIOException("Failed to deploy SHA1 checksum:", sha1StatusLine);
}
}
String md5 = checksums.get("MD5");
if (StringUtils.isNotBlank(md5)) {
log.debug("Uploading MD5 for file " + fileAbsolutePath + " : " + md5);
String md5Url = uploadUrl + ".md5" + buildMatrixParamsString(details.properties);
HttpPut putMd5 = new HttpPut(md5Url);
StringEntity md5StringEntity = new StringEntity(md5);
StatusLine md5StatusLine = httpClient.upload(putMd5, md5StringEntity);
int md5StatusCode = md5StatusLine.getStatusCode();
//Accept both 200, and 201 for backwards-compatibility reasons
if ((md5StatusCode != HttpStatus.SC_CREATED) && (md5StatusCode != HttpStatus.SC_OK)) {
throwHttpIOException("Failed to deploy MD5 checksum:", md5StatusLine);
}
}
}
private String buildMatrixParamsString(Map matrixParams) throws UnsupportedEncodingException {
StringBuilder matrix = new StringBuilder();
if (matrixParams != null && !matrixParams.isEmpty()) {
for (Map.Entry property : matrixParams.entrySet()) {
matrix.append(";").append(httpClient.encodeUrl(property.getKey()))
.append("=").append(httpClient.encodeUrl(property.getValue()));
}
}
return matrix.toString();
}
private Map getChecksumMap(DeployDetails details) throws IOException {
Map checksums = Maps.newHashMap();
List checksumTypeList = Lists.newArrayList();
if (StringUtils.isBlank(details.md5)) {
checksumTypeList.add("MD5");
} else {
checksums.put("MD5", details.md5);
}
if (StringUtils.isBlank(details.sha1)) {
checksumTypeList.add("SHA1");
} else {
checksums.put("SHA1", details.sha1);
}
if (!checksumTypeList.isEmpty()) {
try {
checksums.putAll(FileChecksumCalculator.calculateChecksums(details.file,
checksumTypeList.toArray(new String[checksumTypeList.size()])));
} catch (NoSuchAlgorithmException e) {
throw new RuntimeException(e);
}
}
return checksums;
}
private void throwHttpIOException(String message, StatusLine statusLine) throws IOException {
String errorMessage = new StringBuilder(message).append(" HTTP response code: ").
append(statusLine.getStatusCode()).append(". HTTP response message: ").
append(statusLine.getReasonPhrase()).toString();
throw new IOException(errorMessage);
}
private ArtifactoryVersion getArtifactoryVersion() {
if (artifactoryVersion == null) {
try {
artifactoryVersion = httpClient.getVersion();
} catch (IOException e) {
artifactoryVersion = ArtifactoryVersion.NOT_FOUND;
}
}
return artifactoryVersion;
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy