SONAR-26689 Upgrade compliance reports module to support levels and nested subcategories

Author: cody-simms-sonarsource

gradle.properties

@@ -6,7 +6,7 @@ version=25.12
 # No change required for patch versions
 versionEOL=2026-06-08
 pdfreportVersion=2.0.0.388
-complianceReportsVersion=0.0.1.2480
+complianceReportsVersion=0.0.1.2515
 pluginApiVersion=13.4.3.4290
 description=Open source platform for continuous inspection of code quality
 projectTitle=SonarQube

server/sonar-server-common/src/it/java/org/sonar/server/rule/index/RuleIndexIT.java

@@ -21,8 +21,9 @@
 
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.Sets;
-import io.sonarcloud.compliancereports.reports.MetadataRules.ComplianceCategoryRules;
-import io.sonarcloud.compliancereports.reports.MetadataRules.RepositoryRuleKey;
+import io.sonarcloud.compliancereports.reports.CategoryTree;
+import io.sonarcloud.compliancereports.reports.ComplianceCategoryRules;
+import io.sonarcloud.compliancereports.reports.RepositoryRuleKey;
 import java.util.ArrayList;
 import java.util.LinkedHashMap;
 import java.util.List;
@@ -207,10 +208,13 @@ void filter_by_compliance_category_rules() {
     RuleDto rule2 = createRule(setRepositoryKey("php"), setRuleKey("S002"));
     createRule(setRepositoryKey("java"), setRuleKey("S002"));
     index();
+    ComplianceCategoryRules complianceCategoryRules = new ComplianceCategoryRules(new CategoryTree.CategoryTreeNode(
+      "key", Set.of("php:S002", ":X001"), Set.of(), null, false, 0
+    ));
 
     // key
     RuleQuery query = new RuleQuery()
-      .setComplianceCategoryRules(List.of(new ComplianceCategoryRules(Set.of(RepositoryRuleKey.of("php:S002")), Set.of("X001"))));
+      .setComplianceCategoryRules(List.of(complianceCategoryRules));
 
     assertThat(underTest.search(query, new SearchOptions()).getUuids())
       .containsOnly(rule.getUuid(), rule1.getUuid(), rule2.getUuid());

server/sonar-server-common/src/main/java/org/sonar/server/rule/index/RuleIndex.java

@@ -25,8 +25,8 @@
 import co.elastic.clients.elasticsearch._types.aggregations.StringTermsBucket;
 import co.elastic.clients.util.NamedValue;
 import com.google.common.base.Joiner;
-import io.sonarcloud.compliancereports.reports.MetadataRules.ComplianceCategoryRules;
-import io.sonarcloud.compliancereports.reports.MetadataRules.RepositoryRuleKey;
+import io.sonarcloud.compliancereports.reports.ComplianceCategoryRules;
+import io.sonarcloud.compliancereports.reports.RepositoryRuleKey;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
@@ -449,11 +449,11 @@ private static void addComplianceCategoriesFilter(Map<String, QueryBuilder> filt
     for (ComplianceCategoryRules rules : rulesCollection) {
       BoolQueryBuilder standardBoolQuery = boolQuery();
 
-      if (!rules.ruleKeys().isEmpty()) {
-        standardBoolQuery.should().add(QueryBuilders.termsQuery(FIELD_RULE_RULE_KEY, rules.ruleKeys()));
+      if (!rules.allRuleKeys().isEmpty()) {
+        standardBoolQuery.should().add(QueryBuilders.termsQuery(FIELD_RULE_RULE_KEY, rules.allRuleKeys()));
       }
-      if (!rules.repoRuleKeys().isEmpty()) {
-        Collection<String> repoRuleKeys = rules.repoRuleKeys().stream().map(RepositoryRuleKey::toString).toList();
+      if (!rules.allRepoRuleKeys().isEmpty()) {
+        Collection<String> repoRuleKeys = rules.allRepoRuleKeys().stream().map(RepositoryRuleKey::toString).toList();
         standardBoolQuery.should().add(QueryBuilders.termsQuery(FIELD_RULE_KEY, repoRuleKeys));
       }
       boolQueryBuilder.must(standardBoolQuery);

server/sonar-server-common/src/main/java/org/sonar/server/rule/index/RuleQuery.java

@@ -20,7 +20,7 @@
 package org.sonar.server.rule.index;
 
 import com.google.common.base.Preconditions;
-import io.sonarcloud.compliancereports.reports.MetadataRules.ComplianceCategoryRules;
+import io.sonarcloud.compliancereports.reports.ComplianceCategoryRules;
 import java.util.Collection;
 import javax.annotation.CheckForNull;
 import javax.annotation.Nullable;

server/sonar-webserver-es/src/main/java/org/sonar/server/issue/index/IssueQueryFactory.java

@@ -22,7 +22,7 @@
 import com.google.common.base.Joiner;
 import com.google.common.collect.ImmutableList;
 import io.sonarcloud.compliancereports.reports.MetadataRules;
-import io.sonarcloud.compliancereports.reports.MetadataRules.ComplianceCategoryRules;
+import io.sonarcloud.compliancereports.reports.ComplianceCategoryRules;
 import io.sonarcloud.compliancereports.reports.ReportKey;
 import java.time.Clock;
 import java.time.DateTimeException;
@@ -206,11 +206,11 @@ private Set<String> getRuleIds(DbSession session, Map<ReportKey, ComplianceCateg
 
     for(Map.Entry<ReportKey, ComplianceCategoryRules> e : rulesByStandard.entrySet()) {
       ComplianceCategoryRules rules = e.getValue();
-      Set<RuleKey> ruleKeys = rules.repoRuleKeys().stream().map(r -> RuleKey.of(r.repository(), r.rule())).collect(Collectors.toSet());
+      Set<RuleKey> ruleKeys = rules.allRepoRuleKeys().stream().map(r -> RuleKey.of(r.repository(), r.rule())).collect(Collectors.toSet());
 
       Set<String> ids = Stream.concat(
         dbClient.ruleDao().selectByKeys(session, ruleKeys).stream(),
-        dbClient.ruleDao().selectByRuleKeys(session, rules.ruleKeys()).stream()
+        dbClient.ruleDao().selectByRuleKeys(session, rules.allRuleKeys()).stream()
       ).map(RuleDto::getUuid).collect(Collectors.toSet());
 
       // standard doesn't exist or it doesn't have any rules associated to it

server/sonar-webserver-webapi/src/it/java/org/sonar/server/rule/ws/RuleQueryFactoryIT.java

@@ -19,10 +19,10 @@
  */
 package org.sonar.server.rule.ws;
 
+import io.sonarcloud.compliancereports.reports.ComplianceCategoryRules;
 import io.sonarcloud.compliancereports.reports.MetadataLoader;
 import io.sonarcloud.compliancereports.reports.MetadataRules;
-import io.sonarcloud.compliancereports.reports.MetadataRules.ComplianceCategoryRules;
-import io.sonarcloud.compliancereports.reports.MetadataRules.RepositoryRuleKey;
+import io.sonarcloud.compliancereports.reports.RepositoryRuleKey;
 import java.util.Set;
 import org.junit.Rule;
 import org.junit.Test;
@@ -147,8 +147,10 @@ public void create_rule_search_query() {
 
     assertResult(result, qualityProfile, compareToQualityProfile);
     assertThat(result.includeExternal()).isFalse();
-    assertThat(result.getComplianceCategoryRules()).containsOnly(
-      new ComplianceCategoryRules(Set.of(RepositoryRuleKey.of("java:S001")), Set.of("S002", "3")));
+    assertThat(result.getComplianceCategoryRules()).hasSize(1);
+    assertThat(result.getComplianceCategoryRules().stream().findFirst().get())
+      .extracting(ComplianceCategoryRules::allRepoRuleKeys, ComplianceCategoryRules::allRuleKeys)
+      .containsOnly(Set.of(RepositoryRuleKey.of("java:S001")), Set.of("S002", "3"));
   }
 
   @Test

server/sonar-webserver-webapi/src/main/java/org/sonar/server/rule/ws/RuleQueryFactory.java

@@ -19,13 +19,15 @@
  */
 package org.sonar.server.rule.ws;
 
+import io.sonarcloud.compliancereports.reports.CategoryTree;
 import io.sonarcloud.compliancereports.reports.MetadataRules;
-import io.sonarcloud.compliancereports.reports.MetadataRules.ComplianceCategoryRules;
+import io.sonarcloud.compliancereports.reports.ComplianceCategoryRules;
 import io.sonarcloud.compliancereports.reports.ReportKey;
 import java.util.Date;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.function.Function;
 import org.sonar.api.rule.RuleStatus;
 import org.sonar.api.server.ServerSide;
 import org.sonar.api.server.ws.Request;
@@ -145,8 +147,10 @@ private void setComplianceFilter(RuleQuery query, Map<ReportKey, Set<String>> ca
   }
 
   private List<ComplianceCategoryRules> getComplianceStandardRules(Map<ReportKey, Set<String>> categoriesByStandard) {
+    var nonExistentComplianceRules = new ComplianceCategoryRules(new CategoryTree.CategoryTreeNode("empty", Set.of(":non-existing-uuid"),
+      Set.of(), null, false, 0));
     return metadataRules.getRulesByStandard(categoriesByStandard).values().stream()
-      .map(e -> e.isEmpty() ? new ComplianceCategoryRules(Set.of(), Set.of("non-existing-uuid")) : e)
+      .map(e -> e.isEmpty() ? nonExistentComplianceRules : e)
       .toList();
   }