Introduce failOnVersionConflict (#186)

line · Nov 21, 2024 · 597bb9e · 597bb9e
1 parent 04ce7b0
commit 597bb9e
Showing 1 changed file with 34 additions and 0 deletions.
diff --git a/lib/common-dependencies.gradle b/lib/common-dependencies.gradle
@@ -21,6 +21,7 @@ allprojects { p ->
         managedVersions = getManagedVersions(p.rootProject)
         findLibrary = this.&findLibrary.curry(p.rootProject)
         findPlugin = this.&findPlugin.curry(p.rootProject)
+        failOnVersionConflict = this.&failOnVersionConflict.curry(p)
     }
 }
 
@@ -331,3 +332,36 @@ final class GentlePlainTextReporter implements Reporter {
         return delegate.getFileExtension()
     }
 }
+
+/**
+ * A custom version of failOnVersionConflict which can limit which dependencies should be checked for conflict.
+ * Heavily inspired by https://github.com/gradle/gradle/issues/8813.
+ */
+static def failOnVersionConflict(Project project, ProviderConvertible<MinimalExternalModuleDependency> providerConvertible) {
+    return failOnVersionConflict(project, providerConvertible.asProvider())
+}
+
+static def failOnVersionConflict(Project project, Provider<MinimalExternalModuleDependency> dependencyProvider) {
+    if (!dependencyProvider.isPresent()) {
+        return
+    }
+    def targetDependency = dependencyProvider.get()
+    project.configurations.configureEach { config ->
+        incoming.afterResolve {
+            resolutionResult.allComponents {ResolvedComponentResult result ->
+                if (selectionReason.conflictResolution && moduleVersion != null) {
+                    // we don't care if the selected version is the one specified in dependencies.toml
+                    if (targetDependency.module == moduleVersion.module && targetDependency.version != moduleVersion.version) {
+                        def msg = "Project '${project.name}:${config.name}' resolution failed " +
+                                "for '${targetDependency.module}' with '${getSelectionReason()}"
+                        if (project.rootProject.hasProperty('debugDeps')) {
+                            project.logger.lifecycle(msg)
+                        } else {
+                            throw new IllegalStateException(msg)
+                        }
+                    }
+                }
+            }
+        }
+    }
+}