Merge pull request #20 from cqse/ts/43166_option_to_evaluate_threshold_for_sub_path

scharfstein-dev · web-flow · commit 5270c8ab76d2 · 2025-12-09T14:17:52.000+01:00
Option to evaluate findings and threshold for a specific sub path (`--uniform-path`)
diff --git a/README.md b/README.md
@@ -44,6 +44,9 @@ Example: master:1597845930000
 The version control commit revision for which analysis results should be obtained. This is typically the commit that the
 current CI pipeline is building. Can be either a Git SHA1, a SVN revision number or a Team Foundation changeset ID.
 
+**--uniform-path**
+Set this option to filter the location of findings and metric assessments.
+
 **-f**, **--evaluate-findings**  
 If this option is set, findings introduced with the given commit will be evaluated.
 
diff --git a/src/main/java/com/teamscale/buildbreaker/commandline/BuildBreaker.java b/src/main/java/com/teamscale/buildbreaker/commandline/BuildBreaker.java
@@ -90,6 +90,11 @@ public void setTeamscaleServerUrl(String teamscaleServerUrl) {
             description = "The project ID or alias (NOT the project name!) relevant for the analysis.")
     private String project;
 
+    /** To get Metrics and Findings for a subpath of the project */
+    @Option(names = {"--uniform-path"}, defaultValue = "",
+            description = "Uniform path of requested file or directory.")
+    public String uniformPath;
+
     @ArgGroup(multiplicity = "1")
     private CommitOptions commitOptions;
 
@@ -192,17 +197,17 @@ private EvaluationResult evaluateFindings() throws IOException, TooManyCommitsEx
         Pair<List<Finding>, List<Finding>> findingAssessments;
         if (StringUtils.isEmpty(targetBranchAndTimestamp) && StringUtils.isEmpty(baseBranchAndTimestamp)) {
             System.out.println("Evaluating findings for the current commit...");
-            findingAssessments = teamscaleClient.fetchFindingsUsingCommitDetails(currentBranchAndTimestamp);
+            findingAssessments = teamscaleClient.fetchFindingsUsingCommitDetails(currentBranchAndTimestamp, uniformPath);
         } else if (!StringUtils.isEmpty(targetBranchAndTimestamp)) {
             waitForAnalysisToFinish(targetBranchAndTimestamp);
             System.out.println("Evaluating findings by comparing the current commit with target commit '" +
                     targetBranchAndTimestamp + "'...");
-            findingAssessments = teamscaleClient.fetchFindingsUsingBranchMergeDelta(currentBranchAndTimestamp, targetBranchAndTimestamp);
+            findingAssessments = teamscaleClient.fetchFindingsUsingBranchMergeDelta(currentBranchAndTimestamp, targetBranchAndTimestamp, uniformPath);
         } else {
             waitForAnalysisToFinish(baseBranchAndTimestamp);
             System.out.println("Evaluating findings by aggregating the findings from the base commit '" +
                     baseBranchAndTimestamp + "' up to the current commit '" + currentBranchAndTimestamp + "' ...");
-            findingAssessments = teamscaleClient.fetchFindingsUsingLinearDelta(baseBranchAndTimestamp, currentBranchAndTimestamp);
+            findingAssessments = teamscaleClient.fetchFindingsUsingLinearDelta(baseBranchAndTimestamp, currentBranchAndTimestamp, uniformPath);
         }
 
         EvaluationResult findingsResult = new FindingsEvaluator()
@@ -249,7 +254,7 @@ private HttpUrl buildFindingsUiUrl(String targetBranchAndTimestamp, String baseB
     private EvaluationResult evaluateMetrics() throws IOException, HttpRedirectException, HttpStatusCodeException, TooManyCommitsException, CommitCouldNotBeResolvedException, ParserException {
         System.out.println("Evaluating thresholds...");
         String currentBranchAndTimestamp = determineBranchAndTimestamp();
-        List<MetricViolation> metricAssessments = teamscaleClient.fetchMetricAssessments(currentBranchAndTimestamp, thresholdEvalOptions.thresholdConfig);
+        List<MetricViolation> metricAssessments = teamscaleClient.fetchMetricAssessments(currentBranchAndTimestamp, thresholdEvalOptions.thresholdConfig, uniformPath);
         EvaluationResult metricResult =
                 new MetricsEvaluator().evaluate(metricAssessments, thresholdEvalOptions.failOnYellowMetrics);
         System.out.println(metricResult);
diff --git a/src/main/java/com/teamscale/buildbreaker/evaluation/MetricViolation.java b/src/main/java/com/teamscale/buildbreaker/evaluation/MetricViolation.java
@@ -18,6 +18,10 @@ public MetricViolation(String displayName, String yellowThreshold, String redThr
     @Override
     public String toString() {
         return String.format("%s: \n\tThresholds (yellow/red): %s/%s\n\tActual value: %s",
-                displayName, yellowThreshold, redThreshold, formattedTextValue);
+                displayName,
+                yellowThreshold.isEmpty() ? "-" : yellowThreshold,
+                redThreshold.isEmpty() ? "-" : redThreshold,
+                formattedTextValue
+        );
     }
 }
diff --git a/src/main/java/com/teamscale/buildbreaker/teamscale_client/TeamscaleClient.java b/src/main/java/com/teamscale/buildbreaker/teamscale_client/TeamscaleClient.java
@@ -27,12 +27,7 @@
 import org.conqat.lib.commons.string.StringUtils;
 
 import java.io.IOException;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Objects;
-import java.util.Optional;
+import java.util.*;
 import java.util.function.Supplier;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -70,7 +65,7 @@ public TeamscaleClient(OkHttpClient client, HttpUrl teamscaleServerUrl, String u
      * @throws HttpStatusCodeException if an HTTP error code was returned by Teamscale
      * @throws ParserException         if there was an error parsing Teamscale's response
      */
-    public Pair<List<Finding>, List<Finding>> fetchFindingsUsingCommitDetails(String branchAndTimestamp) throws IOException, HttpRedirectException, HttpStatusCodeException, ParserException {
+    public Pair<List<Finding>, List<Finding>> fetchFindingsUsingCommitDetails(String branchAndTimestamp, String uniformPath) throws IOException, HttpRedirectException, HttpStatusCodeException, ParserException {
         HttpUrl.Builder builder =
                 teamscaleServerUrl.newBuilder()
                         .addPathSegment("api")
@@ -82,7 +77,7 @@ public Pair<List<Finding>, List<Finding>> fetchFindingsUsingCommitDetails(String
         HttpUrl url = builder.build();
         Request request = createAuthenticatedGetRequest(url);
         String response = sendRequest(request);
-        return parseCommitFindingResponse(response);
+        return parseCommitFindingResponse(response, uniformPath);
     }
 
     /**
@@ -92,13 +87,13 @@ public Pair<List<Finding>, List<Finding>> fetchFindingsUsingCommitDetails(String
      * @throws ParserException         if there was an error parsing Teamscale's response
      * @implNote The API we use here is not yet a public API (<a href="https://cqse.atlassian.net/browse/TS-44014">TS-44014</a>), so we don't use a versioned endpoint.
      */
-    public Pair<List<Finding>, List<Finding>> fetchFindingsUsingLinearDelta(String startBranchAndTimestamp, String endBranchAndTimestamp) throws IOException, HttpRedirectException, HttpStatusCodeException, ParserException {
+    public Pair<List<Finding>, List<Finding>> fetchFindingsUsingLinearDelta(String startBranchAndTimestamp, String endBranchAndTimestamp, String uniformPath) throws IOException, HttpRedirectException, HttpStatusCodeException, ParserException {
         HttpUrl.Builder builder =
                 teamscaleServerUrl.newBuilder().addPathSegments("api/projects").addPathSegment(project)
                         .addPathSegments("findings/delta")
                         .addQueryParameter("t2", endBranchAndTimestamp)
                         .addQueryParameter("t1", startBranchAndTimestamp)
-                        .addQueryParameter("uniform-path", "");
+                        .addQueryParameter("uniform-path", uniformPath);
 
         HttpUrl url = builder.build();
         Request request = createAuthenticatedGetRequest(url);
@@ -113,7 +108,7 @@ public Pair<List<Finding>, List<Finding>> fetchFindingsUsingLinearDelta(String s
      * @throws ParserException         if there was an error parsing Teamscale's response
      * @implNote The API we use here is not yet a public API (<a href="https://cqse.atlassian.net/browse/TS-44014">TS-44014</a>), so we don't use a versioned endpoint.
      */
-    public Pair<List<Finding>, List<Finding>> fetchFindingsUsingBranchMergeDelta(String sourceBranchAndTimestamp, String targetBranchAndTimestamp) throws IOException, HttpRedirectException, HttpStatusCodeException, ParserException {
+    public Pair<List<Finding>, List<Finding>> fetchFindingsUsingBranchMergeDelta(String sourceBranchAndTimestamp, String targetBranchAndTimestamp, String uniformPath) throws IOException, HttpRedirectException, HttpStatusCodeException, ParserException {
 
         HttpUrl.Builder builder =
                 teamscaleServerUrl.newBuilder()
@@ -122,6 +117,9 @@ public Pair<List<Finding>, List<Finding>> fetchFindingsUsingBranchMergeDelta(Str
                         .addPathSegments("merge-requests/finding-churn")
                         .addQueryParameter("source", sourceBranchAndTimestamp)
                         .addQueryParameter("target", targetBranchAndTimestamp);
+        if(!uniformPath.isEmpty()) {
+            builder.addQueryParameter("included-paths", uniformPath);
+        }
 
         HttpUrl url = builder.build();
         Request request = createAuthenticatedGetRequest(url);
@@ -135,13 +133,13 @@ public Pair<List<Finding>, List<Finding>> fetchFindingsUsingBranchMergeDelta(Str
      * @throws HttpStatusCodeException if an HTTP error code was returned by Teamscale
      * @throws ParserException         if there was an error parsing Teamscale's response
      */
-    public List<MetricViolation> fetchMetricAssessments(String branchAndTimestamp, String thresholdConfig) throws IOException, HttpRedirectException, HttpStatusCodeException, ParserException {
+    public List<MetricViolation> fetchMetricAssessments(String branchAndTimestamp, String thresholdConfig, String uniformPath) throws IOException, HttpRedirectException, HttpStatusCodeException, ParserException {
         HttpUrl.Builder builder =
                 teamscaleServerUrl.newBuilder()
                         .addPathSegments("api/projects")
                         .addPathSegment(project)
                         .addPathSegment("metric-assessments")
-                        .addQueryParameter("uniform-path", "")
+                        .addQueryParameter("uniform-path", uniformPath)
                         .addQueryParameter("t", branchAndTimestamp)
                         .addQueryParameter("configuration-name", thresholdConfig);
         HttpUrl url = builder.build();
@@ -251,14 +249,19 @@ private boolean isAnalysisFinished(String branch, long timestamp) throws IOExcep
         }
     }
 
-    private Pair<List<Finding>, List<Finding>> parseCommitFindingResponse(String response) throws ParserException {
+    private Pair<List<Finding>, List<Finding>> parseCommitFindingResponse(String response, String uniformPath) throws ParserException {
         try {
-            return tryParseFindingsResponse(response, "$.addedFindings.*", "$.findingsInChangedCode.*");
+            Pair<List<Finding>, List<Finding>> result = tryParseFindingsResponse(response, "$.addedFindings.*", "$.findingsInChangedCode.*");
+            return Pair.createPair(filterFindingLocations(result.getFirst(), uniformPath), filterFindingLocations(result.getSecond(), uniformPath));
         } catch (ParserException | PathNotFoundException e) {
             throw new ParserException("Could not parse findings JSON response:\n" + response + "\n\nPlease contact CQSE with an error report.", e);
         }
     }
 
+    private List<Finding> filterFindingLocations(List<Finding> findings, String uniformPath) {
+        return findings.stream().filter(finding -> finding.uniformPath.startsWith(uniformPath)).collect(Collectors.toList());
+    }
+
     /**
      * @implNote The APIs we use in {@link #fetchFindingsUsingBranchMergeDelta} and {@link #fetchFindingsUsingLinearDelta}
      * are not yet public APIs (<a href="https://cqse.atlassian.net/browse/TS-44014">TS-44014</a>).
@@ -353,6 +356,8 @@ private List<MetricViolation> parseMetricResponse(String response) throws Parser
                         assessment.add(ETrafficLightColor.values()[i], mapping[i]);
                     }
                     formattedTextValue = assessment.toFormattedColorDistributionString();
+                } else if ("NUMERIC".equals(schemaEntry.get("valueType"))) {
+                    formattedTextValue = String.format(Locale.ENGLISH, "%.4f", metricViolation.get("value"));
                 } else {
                     formattedTextValue = metricViolation.get("value").toString();
                 }

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,10 @@ public MetricViolation(String displayName, String yellowThreshold, String redThr`
`18`	`18`	`@Override`
`19`	`19`	`public String toString() {`
`20`	`20`	`return String.format("%s: \n\tThresholds (yellow/red): %s/%s\n\tActual value: %s",`
`21`		`- displayName, yellowThreshold, redThreshold, formattedTextValue);`
	`21`	`+ displayName,`
	`22`	`+ yellowThreshold.isEmpty() ? "-" : yellowThreshold,`
	`23`	`+ redThreshold.isEmpty() ? "-" : redThreshold,`
	`24`	`+ formattedTextValue`
	`25`	`+ );`
`22`	`26`	`}`
`23`	`27`	`}`