Configurable tag columns for build scan reports

yrodiere · yrodiere · commit 6510470df613 · 2024-04-26T12:31:17.000+02:00
diff --git a/README.md b/README.md
@@ -76,6 +76,30 @@ develocity:
     # To have the bot create a GitHub check listing Develocity build scans
     # for every commit that has completed checks related to CI (GitHub Actions or Jenkins)
     addCheck: true
+    # To group tags in a separate column and/or alter/remove some tags,
+    # a list of column rules can be configured:
+    tags:
+       - column: "OS"
+         pattern: "Linux"
+       - column: "OS" # Multiple rules can target the same column
+         pattern: "Windows.*"
+         replacement: "Windows"
+       - column: "Java"
+         pattern: "jdk-(.*)"
+         replacement: "$1"
+       - column: "Backend"
+         pattern: "elasticsearch-(.*)"
+         replacement: "es-$1" # Replacement can refer to capture groups
+       - column: "Backend"
+         pattern: "(.*-)?opensearch-(.*)"
+         replacement: "$1os-$2"
+       - column: "Backend"
+         pattern: "lucene"
+       - column: "DB"
+         pattern: "h2|postgres|postgres(ql)?|mysql|mssql|derby|tidb|cockroach(db)?|oracle.*|db2"
+         replacement: "$0"
+       - pattern: "hibernate.search|elasticsearch|opensearch|main|\\d+.\\d+|PR-\\d+"
+         replacement: "" # Just remove these tags
 ```
 
 ### Altering the infrastructure
diff --git a/src/main/java/org/hibernate/infra/bot/ExtractDevelocityBuildScans.java b/src/main/java/org/hibernate/infra/bot/ExtractDevelocityBuildScans.java
@@ -41,22 +41,26 @@ public class ExtractDevelocityBuildScans {
 	@Inject
 	DevelocityReportFormatter reportFormatter;
 
-	void checkRunRerequested(@CheckRun.Rerequested GHEventPayload.CheckRun payload) {
+	void checkRunRerequested(@CheckRun.Rerequested GHEventPayload.CheckRun payload,
+			@ConfigFile("hibernate-github-bot.yml") RepositoryConfig repositoryConfig) {
 		var repository = payload.getRepository();
 		var checkRun = payload.getCheckRun();
 		if ( !DEVELOCITY_CHECK_RUN_NAME.equals( checkRun.getName() ) ) {
 			return;
 		}
 		String sha = checkRun.getHeadSha();
-		extractCIBuildScans( repository, sha );
+		extractCIBuildScans( repository, repositoryConfig.develocity.buildScan, sha );
 	}
 
 	void checkRunCompleted(@CheckRun.Completed GHEventPayload.CheckRun payload,
 			@ConfigFile("hibernate-github-bot.yml") RepositoryConfig repositoryConfig) {
 		if ( repositoryConfig == null
 				|| repositoryConfig.develocity == null
-				|| repositoryConfig.develocity.buildScan == null
-				|| !repositoryConfig.develocity.buildScan.addCheck ) {
+				|| repositoryConfig.develocity.buildScan == null ) {
+			return;
+		}
+		var buildScanConfig = repositoryConfig.develocity.buildScan;
+		if ( !buildScanConfig.addCheck ) {
 			return;
 		}
 		var repository = payload.getRepository();
@@ -66,10 +70,11 @@ void checkRunCompleted(@CheckRun.Completed GHEventPayload.CheckRun payload,
 			return;
 		}
 		String sha = checkRun.getHeadSha();
-		extractCIBuildScans( repository, sha );
+		extractCIBuildScans( repository, buildScanConfig, sha );
 	}
 
-	private void extractCIBuildScans(GHRepository repository, String sha) {
+	private void extractCIBuildScans(GHRepository repository, RepositoryConfig.Develocity.BuildScan config,
+			String sha) {
 		try {
 			long checkId = createDevelocityCheck( repository, sha );
 			Throwable failure = null;
@@ -105,7 +110,7 @@ private void extractCIBuildScans(GHRepository repository, String sha) {
 			if ( failure != null ) {
 				Log.errorf( failure, "Failed to extract all build scans from commit %s" + sha );
 			}
-			updateDevelocityCheck( repository, checkId, buildScans, failure );
+			updateDevelocityCheck( repository, config, checkId, buildScans, failure );
 		}
 		catch (IOException | RuntimeException e) {
 			Log.errorf( e, "Failed to report build scans from commit %s" + sha );
@@ -184,12 +189,12 @@ private long createDevelocityCheck(GHRepository repository, String sha) throws I
 				.getId();
 	}
 
-	private void updateDevelocityCheck(GHRepository repository, long checkId,
-			List<DevelocityCIBuildScan> buildScans, Throwable failure)
+	private void updateDevelocityCheck(GHRepository repository, RepositoryConfig.Develocity.BuildScan config,
+			long checkId, List<DevelocityCIBuildScan> buildScans, Throwable failure)
 			throws IOException {
 		String formattedBuildScanList = "";
 		try {
-			formattedBuildScanList = reportFormatter.summary( buildScans );
+			formattedBuildScanList = reportFormatter.summary( buildScans, config );
 		}
 		catch (RuntimeException e) {
 			if ( failure == null ) {
diff --git a/src/main/java/org/hibernate/infra/bot/config/RepositoryConfig.java b/src/main/java/org/hibernate/infra/bot/config/RepositoryConfig.java
@@ -1,5 +1,6 @@
 package org.hibernate.infra.bot.config;
 
+import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
@@ -11,7 +12,7 @@ public class RepositoryConfig {
 
 	public JiraConfig jira;
 
-	public DevelocityConfig develocity;
+	public Develocity develocity;
 
 	public static class JiraConfig {
 		private Optional<Pattern> issueKeyPattern = Optional.empty();
@@ -82,18 +83,50 @@ public Pattern getTitlePattern() {
 		}
 
 		public void setTitlePattern(String titlePattern) {
-			this.titlePattern = Pattern.compile( titlePattern );
+			this.titlePattern = Patterns.compile( titlePattern );
 		}
 	}
 
-	public static class DevelocityConfig {
-		public DevelocityBuildScanConfig buildScan;
-	}
+	public static class Develocity {
+		public BuildScan buildScan;
+
+		public static class BuildScan {
+
+			public boolean addCheck = false;
+
+			public List<ColumnRule> tags = new ArrayList<>();
+
+			public BuildScan() {
+			}
 
-	public static class DevelocityBuildScanConfig {
+			public BuildScan(boolean addCheck, List<ColumnRule> tags) {
+				this.addCheck = addCheck;
+				this.tags = tags;
+			}
+		}
+
+		public static class ColumnRule {
+			public String column;
+			private Pattern pattern;
+			public Optional<String> replacement = Optional.empty();
+
+			public ColumnRule() {
+			}
 
-		public boolean addCheck = false;
+			public ColumnRule(String column, Pattern pattern, Optional<String> replacement) {
+				this.column = column;
+				this.pattern = pattern;
+				this.replacement = replacement;
+			}
 
+			public Pattern getPattern() {
+				return pattern;
+			}
+
+			public void setPattern(String pattern) {
+				this.pattern = Patterns.compile( pattern );
+			}
+		}
 	}
 
 }
diff --git a/src/main/java/org/hibernate/infra/bot/develocity/DevelocityReportFormatter.java b/src/main/java/org/hibernate/infra/bot/develocity/DevelocityReportFormatter.java
@@ -1,26 +1,89 @@
 package org.hibernate.infra.bot.develocity;
 
 import java.net.URI;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
+import java.util.LinkedHashSet;
 import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.TreeSet;
 import java.util.stream.Collectors;
 
 import jakarta.enterprise.context.ApplicationScoped;
 
+import org.hibernate.infra.bot.config.RepositoryConfig;
+
 import io.quarkus.qute.CheckedTemplate;
 import io.quarkus.qute.TemplateExtension;
 import io.quarkus.qute.TemplateInstance;
 
 @ApplicationScoped
 public class DevelocityReportFormatter {
 
-	public String summary(List<DevelocityCIBuildScan> buildScans) {
-		return Templates.summary( buildScans )
+	public String summary(List<DevelocityCIBuildScan> buildScans, RepositoryConfig.Develocity.BuildScan config) {
+		Collection<TagColumn> tagColumns = extractTagColumns( buildScans, config );
+		return Templates.summary( buildScans, tagColumns )
 				.render();
 	}
 
+	public record TagColumn(String name, Map<DevelocityCIBuildScan, Set<String>> content) {
+	}
+
+	private Collection<TagColumn> extractTagColumns(List<DevelocityCIBuildScan> buildScans,
+			RepositoryConfig.Develocity.BuildScan config) {
+		Map<String, TagColumn> tagColumns = new LinkedHashMap<>();
+		// Preserve the order in which groups are declared
+		for ( RepositoryConfig.Develocity.ColumnRule rule : config.tags ) {
+			tagColumns.put( rule.column, new TagColumn( rule.column, new HashMap<>() ) );
+		}
+		// Put the default groups last
+		tagColumns.put( null, new TagColumn( null, new HashMap<>() ) );
+
+		for ( DevelocityCIBuildScan buildScan : buildScans ) {
+			for ( String tag : buildScan.tags() ) {
+				boolean matched = false;
+				for ( RepositoryConfig.Develocity.ColumnRule rule : config.tags ) {
+					var matcher = rule.getPattern().matcher( tag );
+					if ( matcher.matches() ) {
+						matched = true;
+						var addedTag = tag;
+						if ( rule.replacement.isPresent() ) {
+							addedTag = matcher.replaceAll( rule.replacement.get() );
+						}
+						if ( !addedTag.isBlank() ) {
+							tagColumns.get( rule.column ).content()
+									.computeIfAbsent( buildScan, ignored -> new TreeSet<>() )
+									.add( addedTag );
+						}
+						break;
+					}
+				}
+				if ( !matched ) {
+					tagColumns.get( null ).content()
+							// Use LinkedHashSet for the default column to preserve tag order
+							.computeIfAbsent( buildScan, ignored -> new LinkedHashSet<>() )
+							.add( tag );
+				}
+			}
+		}
+
+		// Remove empty columns
+		for ( var it = tagColumns.entrySet().iterator(); it.hasNext(); ) {
+			var column = it.next().getValue();
+			if ( column.content.isEmpty() ) {
+				it.remove();
+			}
+		}
+
+		return tagColumns.values();
+	}
+
 	@CheckedTemplate
 	private static class Templates {
-		public static native TemplateInstance summary(List<DevelocityCIBuildScan> buildScans);
+		public static native TemplateInstance summary(List<DevelocityCIBuildScan> buildScans,
+				Collection<TagColumn> tagColumns);
 	}
 
 	@TemplateExtension
@@ -31,13 +94,13 @@ static String backQuoted(String content) {
 			return content == null || content.isBlank() ? null : '`' + content + '`';
 		}
 
-		static List<String> backQuoted(List<String> content) {
+		static List<String> backQuoted(Collection<String> content) {
 			return content.stream()
 					.map( TemplateExtensions::backQuoted )
 					.toList();
 		}
 
-		static String spaceDelimited(List<String> content) {
+		static String spaceDelimited(Collection<String> content) {
 			return content.stream()
 					.filter( s -> s != null && !s.isBlank() )
 					.collect( Collectors.joining( " " ) );
diff --git a/src/main/java/org/hibernate/infra/bot/jackson/ObjectMapperCustomizer.java b/src/main/java/org/hibernate/infra/bot/jackson/ObjectMapperCustomizer.java
@@ -0,0 +1,25 @@
+package org.hibernate.infra.bot.jackson;
+
+import java.util.List;
+
+import jakarta.inject.Inject;
+import jakarta.inject.Singleton;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
+
+import io.quarkiverse.githubapp.runtime.UtilsProducer;
+import io.quarkus.runtime.Startup;
+
+@Singleton
+@Startup
+public class ObjectMapperCustomizer {
+
+	@Inject
+	public void addModules(ObjectMapper jsonMapper, @UtilsProducer.Yaml ObjectMapper yamlMapper) {
+		for ( ObjectMapper mapper : List.of( jsonMapper, yamlMapper ) ) {
+			mapper.registerModule( new Jdk8Module() );
+		}
+	}
+
+}
diff --git a/src/main/resources/templates/DevelocityReportFormatter/summary.md b/src/main/resources/templates/DevelocityReportFormatter/summary.md
@@ -1,12 +1,20 @@
 {#if buildScans == null || buildScans.empty}
 No build scan found for this CI run.
 {#else}
-| Status | Job/Workflow | Tags | Goals | Build Scan | Tests | Logs |
-| :-: | -- | -- | -- | :-: | :-: | :-: |
+| Status | Job/Workflow {!
+!}{#for tagColumn in tagColumns}{!
+!}| {#if tagColumn.name}{tagColumn.name}{#else}{#if tagColumns.size == 1}Tags{#else}Other tags{/if}{/if} {!
+!}{/for}{!
+!}| Goals | Build Scan | Tests | Logs |
+| :-: | -- {!
+!}{#for tagColumn in tagColumns}| -- {/for}{!
+!}| -- | :-: | :-: | :-: |
 {#for buildScan in buildScans}
 |[{buildScan.status.emoji}]({buildScan.statusUri}){!
 !}|{list:create(buildScan.jobOrWorkflow, buildScan.stage).spaceDelimited.backQuoted}{!
-!}|{buildScan.tags.backQuoted.spaceDelimited}{!
+!}{#for tagColumn in tagColumns}{!
+!}|{tagColumn.content.get(buildScan).or(list:create()).backQuoted.spaceDelimited}{!
+!}{/for}{!
 !}|{buildScan.goals.spaceDelimited.backQuoted}{!
 !}|[:mag:]({buildScan.buildScanUri}){!
 !}|[{buildScan.testStatus.emoji}]({buildScan.testsUri}){!
diff --git a/src/test/java/org/hibernate/infra/bot/develocity/DevelocityReportFormatterTest.java b/src/test/java/org/hibernate/infra/bot/develocity/DevelocityReportFormatterTest.java
