BI-510 - Add support for usage-report to Artifactory

Author: barbelity

build-info-api/src/main/java/org/jfrog/build/api/Build.java

@@ -560,6 +560,9 @@ public void append(Build other) {
         appendProperties(other);
         appendModules(other);
         appendBuildDependencies(other);
+        if (this.issues == null) {
+            this.issues = new Issues();
+        }
         this.issues.append(other.getIssues());
     }
 

build-info-client/src/main/java/org/jfrog/build/client/ArtifactoryHttpClient.java

@@ -31,7 +31,6 @@
 import org.apache.http.StatusLine;
 import org.apache.http.client.methods.HttpGet;
 import org.apache.http.client.methods.HttpPut;
-import org.apache.http.message.AbstractHttpMessage;
 import org.apache.http.util.EntityUtils;
 import org.jfrog.build.api.util.Log;
 import org.jfrog.build.util.URI;
@@ -214,12 +213,12 @@ private void consumeEntity(HttpResponse response) throws IOException {
 
     public JsonParser createJsonParser(InputStream in) throws IOException {
         JsonFactory jsonFactory = createJsonFactory();
-        return jsonFactory.createJsonParser(in);
+        return jsonFactory.createParser(in);
     }
 
     public JsonParser createJsonParser(String content) throws IOException {
         JsonFactory jsonFactory = createJsonFactory();
-        return jsonFactory.createJsonParser(content);
+        return jsonFactory.createParser(content);
     }
 
     public JsonFactory createJsonFactory() {

build-info-extractor/src/main/java/org/jfrog/build/extractor/BuildInfoExtractorUtils.java

@@ -199,7 +199,7 @@ public static String buildInfoToJsonString(Build buildInfo) throws IOException {
 
     public static Build jsonStringToBuildInfo(String json) throws IOException {
         JsonFactory jsonFactory = createJsonFactory();
-        JsonParser parser = jsonFactory.createJsonParser(new StringReader(json));
+        JsonParser parser = jsonFactory.createParser(new StringReader(json));
         return jsonFactory.getCodec().readValue(parser, Build.class);
     }
 
@@ -217,7 +217,7 @@ public static <T extends Serializable> String buildInfoToJsonString(T buildCompo
 
     public static <T extends Serializable> T jsonStringToGeneric(String json, Class<T> clazz) throws IOException {
         JsonFactory jsonFactory = createJsonFactory();
-        JsonParser parser = jsonFactory.createJsonParser(new StringReader(json));
+        JsonParser parser = jsonFactory.createParser(new StringReader(json));
         return jsonFactory.getCodec().readValue(parser, clazz);
     }
 

build-info-extractor/src/main/java/org/jfrog/build/extractor/clientConfiguration/client/ArtifactoryBaseClient.java

@@ -133,16 +133,13 @@ public boolean isRepoExist(String repo) throws IOException {
         String encodedUrl = ArtifactoryHttpClient.encodeUrl(fullItemUrl);
         HttpRequestBase httpRequest = new HttpGet(encodedUrl);
         HttpResponse httpResponse = null;
-        int connectionRetries = httpClient.getConnectionRetries();
         try {
             httpResponse = httpClient.getHttpClient().execute(httpRequest);
             StatusLine statusLine = httpResponse.getStatusLine();
             if (statusLine.getStatusCode() == HttpStatus.SC_BAD_REQUEST) {
                 return false;
             }
         } finally {
-            // We are using the same client for multiple operations therefore we need to restore the connectionRetries configuration.
-            httpClient.setConnectionRetries(connectionRetries);
             if (httpResponse != null) {
                 EntityUtils.consumeQuietly(httpResponse.getEntity());
             }

build-info-extractor/src/main/java/org/jfrog/build/extractor/clientConfiguration/client/ArtifactoryBuildInfoClient.java

@@ -48,6 +48,8 @@
 import org.jfrog.build.client.bintrayResponse.BintrayResponseFactory;
 import org.jfrog.build.extractor.clientConfiguration.deploy.DeployDetails;
 import org.jfrog.build.extractor.clientConfiguration.util.DeploymentUrlUtils;
+import org.jfrog.build.extractor.clientConfiguration.util.JsonSerializer;
+import org.jfrog.build.extractor.usageReport.UsageReporter;
 import org.jfrog.build.util.VersionCompatibilityType;
 import org.jfrog.build.util.VersionException;
 
@@ -79,6 +81,8 @@ public class ArtifactoryBuildInfoClient extends ArtifactoryBaseClient implements
     public static final String APPLICATION_VND_ORG_JFROG_ARTIFACTORY_JSON = "application/vnd.org.jfrog.artifactory+json";
     public static final String APPLICATION_JSON = "application/json";
     public static final String ITEM_LAST_MODIFIED = "/api/storage/";
+    private static final String USAGE_API = "/api/system/usage";
+    private static final ArtifactoryVersion USAGE_ARTIFACTORY_MIN_VERSION = new ArtifactoryVersion("6.9.0");
 
     /**
      * Creates a new client for the given Artifactory url.
@@ -101,7 +105,7 @@ public ArtifactoryBuildInfoClient(String artifactoryUrl, String username, String
     }
 
     public ArtifactoryBuildInfoClient(String artifactoryUrl, String username, String password, Log log) {
-        super(artifactoryUrl, username, password, StringUtils.EMPTY, log);
+        this(artifactoryUrl, username, password, StringUtils.EMPTY, log);
     }
     /**
      * @return A list of local repositories available for deployment.
@@ -299,22 +303,16 @@ private void sendHttpEntityRequest(HttpEntityEnclosingRequestBase request, Strin
 
     private HttpResponse sendHttpRequest(HttpUriRequest request, int ... httpStatuses) throws IOException {
         HttpResponse httpResponse;
-        int connectionRetries = httpClient.getConnectionRetries();
-        try {
-            httpResponse = httpClient.getHttpClient().execute(request);
-            StatusLine statusLine = httpResponse.getStatusLine();
-            for (int status : httpStatuses) {
-                if (statusLine.getStatusCode() == status) {
-                    return httpResponse;
-                }
+        httpResponse = httpClient.getHttpClient().execute(request);
+        StatusLine statusLine = httpResponse.getStatusLine();
+        for (int status : httpStatuses) {
+            if (statusLine.getStatusCode() == status) {
+                return httpResponse;
             }
-
-            HttpEntity responseEntity = httpResponse.getEntity();
-            throw new IOException(statusLine.getStatusCode() + httpClient.getMessageFromEntity(responseEntity));
-        } finally {
-            // We are using the same client for multiple operations therefore we need to restore the connectionRetries configuration.
-            httpClient.setConnectionRetries(connectionRetries);
         }
+
+        HttpEntity responseEntity = httpResponse.getEntity();
+        throw new IOException(statusLine.getStatusCode() + httpClient.getMessageFromEntity(responseEntity));
     }
 
     public ItemLastModified getItemLastModified(String path) throws IOException {
@@ -468,7 +466,7 @@ private String createJsonRequestBody(BintrayUploadInfoOverride info) throws IOEx
     private BintrayResponse parseResponse(HttpResponse response) throws IOException {
         InputStream content = response.getEntity().getContent();
         int status = response.getStatusLine().getStatusCode();
-        JsonParser parser = httpClient.createJsonFactory().createJsonParser(content);
+        JsonParser parser = httpClient.createJsonFactory().createParser(content);
         BintrayResponse responseObject = BintrayResponseFactory.createResponse(status, parser);
         return responseObject;
     }
@@ -855,5 +853,38 @@ private String getResponseMessage(List<ArtifactoryUploadResponse.Error> errorLis
         }
         return builder.toString();
     }
-}
 
+    public void reportUsage(UsageReporter usageReporter) throws IOException {
+        // Check Artifactory supported version.
+        ArtifactoryVersion version = getArtifactoryVersion();
+        if (version.isNotFound()) {
+            throw new IOException("Could not get Artifactory version.");
+        }
+        if (!version.isAtLeast(USAGE_ARTIFACTORY_MIN_VERSION)) {
+            throw new IOException("Usage report is not supported on targeted Artifactory server.");
+        }
+
+        // Create request.
+        String url = artifactoryUrl + USAGE_API;
+        String encodedUrl = ArtifactoryHttpClient.encodeUrl(url);
+        String requestBody = new JsonSerializer<UsageReporter>().toJSON(usageReporter);
+        StringEntity entity = new StringEntity(requestBody, "UTF-8");
+        entity.setContentType("application/json");
+        HttpPost request = new HttpPost(encodedUrl);
+        request.setEntity(entity);
+
+        // Send request
+        HttpResponse httpResponse = null;
+        try {
+            httpResponse = httpClient.getHttpClient().execute(request);
+            StatusLine statusLine = httpResponse.getStatusLine();
+            if (statusLine.getStatusCode() != HttpStatus.SC_OK) {
+                throw new IOException(String.format("Artifactory response: %s %s", statusLine.getStatusCode(), statusLine.getReasonPhrase()));
+            }
+        } finally {
+            if (httpResponse != null) {
+                EntityUtils.consumeQuietly(httpResponse.getEntity());
+            }
+        }
+    }
+}

build-info-extractor/src/main/java/org/jfrog/build/extractor/clientConfiguration/client/ArtifactoryDependenciesClient.java

@@ -61,6 +61,10 @@ public ArtifactoryDependenciesClient(String artifactoryUrl, String username, Str
         super(artifactoryUrl, username, password, accessToken, logger);
     }
 
+    public ArtifactoryDependenciesClient(String artifactoryUrl, String username, String password, Log logger) {
+        this(artifactoryUrl, username, password, StringUtils.EMPTY, logger);
+    }
+
     public ArtifactoryDependenciesClient(String artifactoryUrl, ArtifactoryHttpClient httpClient, Log logger) {
         super(artifactoryUrl, httpClient, logger);
     }

build-info-extractor/src/main/java/org/jfrog/build/extractor/clientConfiguration/util/JsonSerializer.java

@@ -39,7 +39,7 @@ public String toJSON(T object) throws IOException {
         mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
         jsonFactory.setCodec(mapper);
         StringWriter writer = new StringWriter();
-        JsonGenerator jsonGenerator = jsonFactory.createJsonGenerator(writer);
+        JsonGenerator jsonGenerator = jsonFactory.createGenerator(writer);
         jsonGenerator.useDefaultPrettyPrinter();
         jsonGenerator.writeObject(object);
         return writer.getBuffer().toString();

build-info-extractor/src/main/java/org/jfrog/build/extractor/usageReport/UsageReporter.java

@@ -0,0 +1,57 @@
+package org.jfrog.build.extractor.usageReport;
+
+import org.jfrog.build.api.util.Log;
+import org.jfrog.build.client.ProxyConfiguration;
+import org.jfrog.build.extractor.clientConfiguration.client.ArtifactoryBuildInfoClient;
+
+import java.io.IOException;
+
+/**
+ * Created by Bar Belity on 20/11/2019.
+ */
+public class UsageReporter {
+    private String productId;
+    private FeatureId[] features;
+
+    public UsageReporter(String productId, String[] featureIds) {
+        this.productId = productId;
+        setFeatures(featureIds);
+    }
+
+    public void reportUsage(String artifactoryUrl, String username, String password, String accessToken, ProxyConfiguration proxyConfiguration, Log log) throws IOException {
+        ArtifactoryBuildInfoClient client = new ArtifactoryBuildInfoClient(artifactoryUrl, username, password, accessToken, log);
+        if (proxyConfiguration != null) {
+            client.setProxyConfiguration(proxyConfiguration);
+        }
+        client.reportUsage(this);
+    }
+
+    public String getProductId() {
+        return productId;
+    }
+
+    public FeatureId[] getFeatures() {
+        return features;
+    }
+
+    private void setFeatures(String[] featureIds) {
+        features = new FeatureId[featureIds.length];
+        int featureIndex = 0;
+        for (String featureId : featureIds) {
+            features[featureIndex] = new FeatureId(featureId);
+            featureIndex++;
+        }
+    }
+
+    public class FeatureId {
+        private String featureId;
+
+        public FeatureId (String featureId) {
+            this.featureId = featureId;
+        }
+
+        public String getFeatureId() {
+            return featureId;
+        }
+    }
+}

gradle.properties

@@ -1,4 +1,4 @@
-build-info-extractor-gradle-version=4.9.x-SNAPSHOT
+build-info-extractor-gradle-version=4.11.x-SNAPSHOT
 build-info-extractor-npm-version=2.13.x-SNAPSHOT
 build-info-latest-release-version=2.13.x-SNAPSHOT
 build-info-extractor-ivy-version=2.13.x-SNAPSHOT