Merge pull request #155 from austinarbor/generate-bom-entry

Generate BOM Entry
austinarbor · Oct 20, 2024 · 2550fa0 · 2550fa0
2 parents c371298 + 5d66f96
commit 2550fa0
Show file tree

Hide file tree

Showing 14 changed files with 56 additions and 2 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -42,6 +42,7 @@ jobs:
         include:
           - gradle-version: "wrapper"
             gradle-command: "./gradlew"
+      fail-fast: false
     steps:
       - uses: actions/checkout@v4
         name: Checkout

diff --git a/README.adoc b/README.adoc
@@ -63,10 +63,11 @@ dependencyResolutionManagement {
         "jackson-bom.version" to "2.16.1", // <4>
         "mockito.version" to versionRef("mockito"), // <5>
       )
+      generateBomEntry = true // <6>
     }
     generate("awsLibs") {
       from(toml("awsBom"))
-      aliasPrefixGenerator = GeneratorConfig.NO_PREFIX // <6>
+      aliasPrefixGenerator = GeneratorConfig.NO_PREFIX // <7>
     }
   }
 }
@@ -76,7 +77,8 @@ dependencyResolutionManagement {
 <3> The name of the bom library in the version catalog
 <4> Optionally override some version properties using a literal value
 <5> Or, you can reference version aliases in the source TOML
-<6> All dependencies in the AWS BOM are for AWS so we can skip the prefix
+<6> Optionally generate an entry in the catalog for the BOM itself
+<7> All dependencies in the AWS BOM are for AWS so we can skip the prefix
 ====
 
 _Lastly, use the dependencies in your build_

diff --git a/plugin/src/docs/asciidoc/detailed-usage.adoc b/plugin/src/docs/asciidoc/detailed-usage.adoc
@@ -2,6 +2,7 @@
 == Detailed Usage
 include::{docdir}/detailed-usage/applying.adoc[]
 include::{docdir}/detailed-usage/sources.adoc[]
+include::{docdir}/detailed-usage/bom-entry.adoc[]
 include::{docdir}/detailed-usage/naming.adoc[]
 include::{docdir}/detailed-usage/overrides.adoc[]
 include::{docdir}/detailed-usage/filtering.adoc[]

diff --git a/plugin/src/docs/asciidoc/detailed-usage/bom-entry.adoc b/plugin/src/docs/asciidoc/detailed-usage/bom-entry.adoc
@@ -0,0 +1,28 @@
+
+=== Including a BOM Entry
+
+Optionally, you can configure the generator to also generate an entry in the catalog for the BOM itself.
+
+.settings.gradle.kts
+[source,kotlin,subs="attributes+",role="primary"]
+----
+generate("springLibs") {
+  from(toml("springBootDependencies"))
+  generateBomEntry = true // <1>
+}
+----
+<1> Set `generateBomEntry` to `true` to include an entry for the BOM in the generated catalog
+
+.settings.gradle
+[source,groovy,subs="attributes+",role="secondary"]
+----
+generator.generate("springLibs") {
+  it.from { from ->
+    from.toml { toml ->
+      toml.libraryAlias = "springBootDependencies"
+    }
+  }
+  it.generateBomEntry = true // <1>
+}
+----
+<1> Set `generateBomEntry` to `true` to include an entry for the BOM in the generated catalog
diff --git a/plugin/src/main/kotlin/dev/aga/gradle/versioncatalogs/Generator.kt b/plugin/src/main/kotlin/dev/aga/gradle/versioncatalogs/Generator.kt
@@ -111,6 +111,16 @@ object Generator {
             val queue = ArrayDeque(listOf(bomDep))
             val container = TomlContainer()
             var rootDep = true
+            if (config.generateBomEntry) {
+                createLibrary(
+                    bomDep,
+                    Version(bomDep.version, bomDep.version, bomDep.version),
+                    config,
+                    true,
+                    container,
+                )
+            }
+
             while (queue.isNotEmpty()) {
                 val dep = queue.removeFirst()
                 val (model, parentModel) = resolver.resolve(dep)

diff --git a/plugin/src/main/kotlin/dev/aga/gradle/versioncatalogs/GeneratorConfig.kt b/plugin/src/main/kotlin/dev/aga/gradle/versioncatalogs/GeneratorConfig.kt
@@ -73,6 +73,9 @@ class GeneratorConfig(val settings: Settings) {
      */
     var excludeNames: String? = null
 
+    /** When true, an entry for the BOM itself will be added to the catalog. */
+    var generateBomEntry: Boolean = false
+
     /**
      * The directory to store our cached TOML file. By default, it will be stored in
      * `build/catalogs` relative to the directory of where the settings file exists. When

diff --git a/plugin/src/test/kotlin/dev/aga/gradle/versioncatalogs/GeneratorTest.kt b/plugin/src/test/kotlin/dev/aga/gradle/versioncatalogs/GeneratorTest.kt
@@ -119,6 +119,7 @@ internal class GeneratorTest {
                 }
                 cacheDirectory = projectDir
                 cacheEnabled = true
+                generateBomEntry = true
             }
 
         val resolver = MockGradleDependencyResolver(resourceRoot.resolve("poms"))

diff --git a/plugin/src/test/kotlin/dev/aga/gradle/versioncatalogs/VersionCatalogGeneratorPluginTest.kt b/plugin/src/test/kotlin/dev/aga/gradle/versioncatalogs/VersionCatalogGeneratorPluginTest.kt
@@ -73,6 +73,7 @@ class VersionCatalogGeneratorPluginTest {
                     GeneratorConfig.caseChange(artifact, net.pearx.kasechange.CaseFormat.LOWER_HYPHEN, net.pearx.kasechange.CaseFormat.LOWER_UNDERSCORE)
                   }
                   cacheEnabled = true
+                  generateBomEntry = true
                 }
                 generate("awsLibs") {
                   from(toml("aws-bom"))
@@ -177,6 +178,7 @@ class VersionCatalogGeneratorPluginTest {
                       DEFAULT_ALIAS_GENERATOR.invoke(prefix,suffix)
                     }
                     it.versionNameGenerator = DEFAULT_VERSION_NAME_GENERATOR
+                    it.generateBomEntry = true
                 }
                 generator.generate("junitLibs") {
                   it.from { from ->

diff --git a/plugin/src/test/resources/expectations/assertj-bom/both-exclusion-test.toml b/plugin/src/test/resources/expectations/assertj-bom/both-exclusion-test.toml
@@ -1,6 +1,7 @@
 [versions]
 
 [libraries]
+assertj-assertjBom = { group = "org.assertj", name = "assertj-bom", version = "3.24.2" }
 assertj-assertjGuava = { group = "org.assertj", name = "assertj-guava", version = "3.24.2" }
 
 [bundles]
diff --git a/plugin/src/test/resources/expectations/assertj-bom/empty.toml b/plugin/src/test/resources/expectations/assertj-bom/empty.toml
@@ -1,5 +1,6 @@
 [versions]
 
 [libraries]
+assertj-assertjBom = { group = "org.assertj", name = "assertj-bom", version = "3.24.2" }
 
 [bundles]
diff --git a/plugin/src/test/resources/expectations/assertj-bom/exclusion-negative-test.toml b/plugin/src/test/resources/expectations/assertj-bom/exclusion-negative-test.toml
@@ -1,6 +1,7 @@
 [versions]
 
 [libraries]
+assertj-assertjBom = { group = "org.assertj", name = "assertj-bom", version = "3.24.2" }
 assertj-assertjCore = { group = "org.assertj", name = "assertj-core", version = "3.24.2" }
 assertj-assertjGuava = { group = "org.assertj", name = "assertj-guava", version = "3.24.2" }
 

diff --git a/plugin/src/test/resources/expectations/assertj-bom/name-exclusion-test.toml b/plugin/src/test/resources/expectations/assertj-bom/name-exclusion-test.toml
@@ -1,6 +1,7 @@
 [versions]
 
 [libraries]
+assertj-assertjBom = { group = "org.assertj", name = "assertj-bom", version = "3.24.2" }
 assertj-assertjCore = { group = "org.assertj", name = "assertj-core", version = "3.24.2" }
 
 [bundles]
diff --git a/plugin/src/test/resources/expectations/spring-boot-dependencies/libs.versions.toml b/plugin/src/test/resources/expectations/spring-boot-dependencies/libs.versions.toml
@@ -21,6 +21,7 @@ awssdk-sqs = { group = "software.amazon.awssdk", name = "sqs", version = "2.21.2
 awssdk-sts = { group = "software.amazon.awssdk", name = "sts", version = "2.21.21" }
 spring-springBoot = { group = "org.springframework.boot", name = "spring-boot", version = "3.1.2" }
 spring-springBootDevtools = { group = "org.springframework.boot", name = "spring-boot-devtools", version = "3.1.2" }
+spring-springBootDependencies = { group = "org.springframework.boot", name = "spring-boot-dependencies", version = "3.1.2" }
 spring-springBootStarterActuator = { group = "org.springframework.boot", name = "spring-boot-starter-actuator", version = "3.1.2" }
 spring-springBootStarterAop = { group = "org.springframework.boot", name = "spring-boot-starter-aop", version = "3.1.2" }
 spring-springBootStarterJdbc = { group = "org.springframework.boot", name = "spring-boot-starter-jdbc", version = "3.1.2" }

diff --git a/plugin/src/test/resources/expectations/spring-boot-dependencies/property-overrides.toml b/plugin/src/test/resources/expectations/spring-boot-dependencies/property-overrides.toml
@@ -20,6 +20,7 @@ awssdk-s3 = { group = "software.amazon.awssdk", name = "s3", version = "2.21.21"
 awssdk-sqs = { group = "software.amazon.awssdk", name = "sqs", version = "2.21.21" }
 awssdk-sts = { group = "software.amazon.awssdk", name = "sts", version = "2.21.21" }
 spring-springBoot = { group = "org.springframework.boot", name = "spring-boot", version = "3.1.2" }
+spring-springBootDependencies = { group = "org.springframework.boot", name = "spring-boot-dependencies", version = "3.1.2" }
 spring-springBootDevtools = { group = "org.springframework.boot", name = "spring-boot-devtools", version = "3.1.2" }
 spring-springBootStarterActuator = { group = "org.springframework.boot", name = "spring-boot-starter-actuator", version = "3.1.2" }
 spring-springBootStarterAop = { group = "org.springframework.boot", name = "spring-boot-starter-aop", version = "3.1.2" }