Automated bom (#836)

* automated bom * we prefer the variable
Mastercard · Jun 7, 2024 · 0e4d918 · 0e4d918
1 parent 9e85d22
commit 0e4d918
Show file tree

Hide file tree

Showing 6 changed files with 164 additions and 32 deletions.
diff --git a/bom/pom.xml b/bom/pom.xml
@@ -12,7 +12,6 @@
 
 	<dependencyManagement>
 		<dependencies>
-
 			<dependency>
 				<groupId>${project.groupId}</groupId>
 				<artifactId>api</artifactId>
@@ -21,112 +20,123 @@
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>builder</artifactId>
+				<artifactId>assert-core</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>message-core</artifactId>
+				<artifactId>assert-filter</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>message-text</artifactId>
+				<artifactId>assert-junit4</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>message-json</artifactId>
+				<artifactId>assert-junit5</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>message-http</artifactId>
+				<artifactId>builder</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>message-sql</artifactId>
+				<artifactId>coppice</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>message-web</artifactId>
+				<artifactId>duct</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>message-xml</artifactId>
+				<artifactId>message-core</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>model</artifactId>
+				<artifactId>message-http</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>validation-core</artifactId>
+				<artifactId>message-json</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>validation-junit4</artifactId>
+				<artifactId>message-sql</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>validation-junit5</artifactId>
+				<artifactId>message-text</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>coppice</artifactId>
+				<artifactId>message-web</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>report-core</artifactId>
+				<artifactId>message-xml</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>assert-filter</artifactId>
+				<artifactId>model</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>assert-core</artifactId>
+				<artifactId>report-core</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>assert-junit4</artifactId>
+				<artifactId>report-ng</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
 			<dependency>
 				<groupId>${project.groupId}</groupId>
-				<artifactId>assert-junit5</artifactId>
+				<artifactId>validation-core</artifactId>
 				<version>${project.version}</version>
 			</dependency>
 
+			<dependency>
+				<groupId>${project.groupId}</groupId>
+				<artifactId>validation-junit4</artifactId>
+				<version>${project.version}</version>
+			</dependency>
+
+			<dependency>
+				<groupId>${project.groupId}</groupId>
+				<artifactId>validation-junit5</artifactId>
+				<version>${project.version}</version>
+			</dependency>
 		</dependencies>
 	</dependencyManagement>
 </project>
diff --git a/doc/src/test/java/com/mastercard/test/flow/doc/BomTest.java b/doc/src/test/java/com/mastercard/test/flow/doc/BomTest.java
@@ -0,0 +1,95 @@
+package com.mastercard.test.flow.doc;
+
+import static java.util.stream.Collectors.joining;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.Comparator;
+import java.util.List;
+
+import org.junit.jupiter.api.Test;
+
+import com.mastercard.test.flow.doc.PomData.DepData;
+
+/**
+ * Ensures that our Bill of Materials pom contains all of the artifacts in this
+ * project
+ */
+class BomTest {
+
+	@Test
+	void check() {
+		PomData root = new PomData( null, Paths.get( "..", "pom.xml" ) );
+
+		PomData bom = root.modules()
+				.filter( m -> "bom".equals( m.artifactId() ) )
+				.findAny()
+				.orElseThrow( () -> new IllegalStateException( "Failed to find bom" ) );
+
+		List<PomData> artifacts = collectArtifacts( root, new ArrayList<>() );
+
+		// these are not releasable artifacts, so no point in managing them
+		artifacts.removeIf( pom -> pom.groupId().endsWith( "example" )
+				|| "aggregator".equals( pom.artifactId() )
+				|| "doc".equals( pom.artifactId() ) );
+		// no self-reference please
+		artifacts.remove( bom );
+
+		String expected = artifacts.stream()
+				.sorted( Comparator.comparing( PomData::artifactId ) )
+				.map( artifact -> String.format( ""
+						+ "\t\t\t<dependency>\n"
+						+ "\t\t\t\t<groupId>%s</groupId>\n"
+						+ "\t\t\t\t<artifactId>%s</artifactId>\n"
+						+ "\t\t\t\t<version>%s</version>\n"
+						+ "\t\t\t</dependency>",
+						artifact.groupId()
+								.replace( bom.groupId(), "${project.groupId}" ),
+						artifact.artifactId(),
+						artifact.version()
+								.replace( bom.version(), "${project.version}" ) ) )
+				.collect( joining(
+						"\n\n",
+						""
+								+ "\t<dependencyManagement>\n"
+								+ "\t\t<dependencies>\n",
+						""
+								+ "\n"
+								+ "\t\t</dependencies>\n"
+								+ "\t</dependencyManagement>" ) );
+
+		String actual = bom.dependencyManagement()
+				.sorted( Comparator.comparing( DepData::artifactId ) )
+				.map( dep -> String.format( ""
+						+ "\t\t\t<dependency>\n"
+						+ "\t\t\t\t<groupId>%s</groupId>\n"
+						+ "\t\t\t\t<artifactId>%s</artifactId>\n"
+						+ "\t\t\t\t<version>%s</version>\n"
+						+ "\t\t\t</dependency>",
+						dep.groupId()
+								.replace( bom.groupId(), "${project.groupId}" ),
+						dep.artifactId(),
+						dep.version()
+								.replace( bom.version(), "${project.version}" ) ) )
+				.collect( joining(
+						"\n\n",
+						""
+								+ "\t<dependencyManagement>\n"
+								+ "\t\t<dependencies>\n",
+						""
+								+ "\n"
+								+ "\t\t</dependencies>\n"
+								+ "\t</dependencyManagement>" ) );
+
+		assertEquals( expected, actual );
+	}
+
+	private static List<PomData> collectArtifacts( PomData pom, List<PomData> modules ) {
+		if( "jar".equals( pom.packaging() ) ) {
+			modules.add( pom );
+		}
+		pom.modules().forEach( child -> collectArtifacts( child, modules ) );
+		return modules;
+	}
+}
diff --git a/doc/src/test/java/com/mastercard/test/flow/doc/PomData.java b/doc/src/test/java/com/mastercard/test/flow/doc/PomData.java
@@ -30,11 +30,13 @@ class PomData {
 	private final Path dirPath;
 	private final String groupId;
 	private final String artifactId;
+	private final String version;
 	private final String packaging;
 	private final String name;
 	private final String description;
 	private final List<PomData> modules;
 	private final List<DepData> dependencies;
+	private final List<DepData> dependencyManagement;
 
 	/**
 	 * @param parent The parent pom, or <code>null</code>
@@ -54,6 +56,9 @@ class PomData {
 			groupId = Optional.ofNullable( xpath.evaluate( "/project/groupId", doc ) )
 					.filter( s -> !s.isEmpty() )
 					.orElseGet( () -> parent.groupId() );
+			version = Optional.of( xpath.evaluate( "/project/version", doc ) )
+					.filter( s -> !s.isEmpty() )
+					.orElseGet( () -> parent.version() );
 			packaging = xpath.evaluate( "/project/packaging", doc );
 			name = xpath.evaluate( "/project/name", doc );
 			description = xpath.evaluate( "/project/description", doc );
@@ -75,6 +80,14 @@ class PomData {
 			for( int i = 0; i < dnl.getLength(); i++ ) {
 				dependencies.add( new DepData( xpath, dnl.item( i ), this ) );
 			}
+
+			dependencyManagement = new ArrayList<>();
+			NodeList dpnl = (NodeList) xpath.evaluate(
+					"/project/dependencyManagement/dependencies/dependency", doc,
+					XPathConstants.NODESET );
+			for( int i = 0; i < dpnl.getLength(); i++ ) {
+				dependencyManagement.add( new DepData( xpath, dpnl.item( i ), this ) );
+			}
 		}
 		catch( ParserConfigurationException
 				| SAXException
@@ -112,10 +125,17 @@ public String groupId() {
 		return groupId;
 	}
 
+	/**
+	 * @return The project's version string
+	 */
+	public String version() {
+		return version;
+	}
+
 	/**
 	 * @return The project's packaging value
 	 */
-	public String getPackaging() {
+	public String packaging() {
 		return packaging;
 	}
 
@@ -140,6 +160,13 @@ public Stream<DepData> dependencies() {
 		return dependencies.stream();
 	}
 
+	/**
+	 * @return managed dependencies
+	 */
+	public Stream<DepData> dependencyManagement() {
+		return dependencyManagement.stream();
+	}
+
 	/**
 	 * @return Project name
 	 */
@@ -175,6 +202,7 @@ public String toString() {
 	public static class DepData {
 		private final String groupId;
 		private final String artifactId;
+		private final String version;
 		private final String scope;
 		private final boolean optional;
 
@@ -193,6 +221,7 @@ public static class DepData {
 				groupId = gd;
 			}
 			artifactId = xpath.evaluate( "artifactId", n );
+			version = xpath.evaluate( "version", n );
 			scope = Optional.ofNullable( xpath.evaluate( "scope", n ) )
 					.filter( s -> !s.isEmpty() )
 					.orElse( "compile" );
@@ -215,6 +244,13 @@ public String artifactId() {
 			return artifactId;
 		}
 
+		/**
+		 * @return The dependency version string
+		 */
+		public String version() {
+			return version;
+		}
+
 		/**
 		 * @return commbined group and artifact IDs
 		 */

diff --git a/doc/src/test/java/com/mastercard/test/flow/doc/ReadmeInterlinkTest.java b/doc/src/test/java/com/mastercard/test/flow/doc/ReadmeInterlinkTest.java
@@ -80,7 +80,7 @@ private static String parentLink( PomData pom ) {
 			.collect( toSet() );
 
 	private static String javadocBadge( PomData pom ) {
-		if( "jar".equals( pom.getPackaging() ) && !NO_JAVADOC.contains( pom.artifactId() ) ) {
+		if( "jar".equals( pom.packaging() ) && !NO_JAVADOC.contains( pom.artifactId() ) ) {
 			return String.format( ""
 					+ "["
 					+ "![javadoc](https://javadoc.io/badge2/%s/%s/javadoc.svg)"

diff --git a/message/message-core/pom.xml b/message/message-core/pom.xml
@@ -14,6 +14,7 @@
 		<dependency>
 			<groupId>${project.groupId}</groupId>
 			<artifactId>api</artifactId>
+			<version>${project.version}</version>
 		</dependency>
 
 		<dependency>

diff --git a/message/pom.xml b/message/pom.xml
@@ -20,20 +20,10 @@
 		<module>message-xml</module>
 	</modules>
 
-	<dependencyManagement>
-		<dependencies>
-			<dependency>
-				<groupId>${project.groupId}</groupId>
-				<artifactId>api</artifactId>
-				<version>${project.version}</version>
-			</dependency>
-
-		</dependencies>
-	</dependencyManagement>
-
 	<build>
 		<pluginManagement>
 			<plugins>
+
 				<plugin>
 					<!-- provides and enforces formatting -->
 					<groupId>net.revelc.code.formatter</groupId>