Deprecate software model based APIs in dependency management (#34631)

big-guy · web-flow · commit f3f918555b5f · 2025-08-13T20:03:43.000Z
diff --git a/platforms/documentation/docs/src/docs/userguide/releases/upgrading/upgrading_version_9.adoc b/platforms/documentation/docs/src/docs/userguide/releases/upgrading/upgrading_version_9.adoc
@@ -37,9 +37,7 @@ The previous step will help you identify potential problems by issuing deprecati
 . Try to run the project and debug any errors using the <<troubleshooting.adoc#troubleshooting, Troubleshooting Guide>>.
 
 [[changes_9.2]]
-== Upgrading from 9.1 and earlier
-
-=== Deprecations
+== Upgrading from 9.1.0 and earlier
 
 === Potential breaking changes
 
@@ -48,6 +46,22 @@ The previous step will help you identify potential problems by issuing deprecati
 The incubating `ObjectFactory#dependencyCollector()` method has been removed.
 DependencyCollectors can still be instantiated within Gradle <<properties_providers.adoc#managed_types, managed types>>.
 
+=== Deprecations
+
+[[dependency_management_rules]]
+==== RuleSource-based dependency management APIs have been deprecated
+
+The link:{javadocPath}/org/gradle/model/RuleSource.html[`RuleSource`]-based dependency management APIs have been deprecated and will be removed in Gradle 10.0.0.
+
+These APIs include:
+
+- link:{javadocPath}/org/gradle/api/artifacts/dsl/ComponentMetadataHandler.html#all(java.lang.Object)[`ComponentMetadataHandler.all(Object)`]
+- link:{javadocPath}/org/gradle/api/artifacts/dsl/ComponentMetadataHandler.html#all(java.lang.Object)[`ComponentMetadataHandler.withModule(Object,Object)`]
+- link:{javadocPath}/org/gradle/api/artifacts/ComponentSelectionRules.html#all(java.lang.Object)[`ComponentSelectionRules.all(Object)`]
+- link:{javadocPath}/org/gradle/api/artifacts/ComponentSelectionRules.html#withModule(java.lang.Object,java.lang.Object)[`ComponentSelectionRules.withModule(Object,Object)`]
+
+Instead of using these APIs, you should use the alternative methods that take a `ComponentMetadataRule` class or an `Action`.
+
 [[changes_9.1.0]]
 == Upgrading from 9.0.0 and earlier
 
diff --git a/platforms/software/dependency-management/src/integTest/groovy/org/gradle/integtests/resolve/ivy/ComponentSelectionRulesErrorHandlingIntegTest.groovy b/platforms/software/dependency-management/src/integTest/groovy/org/gradle/integtests/resolve/ivy/ComponentSelectionRulesErrorHandlingIntegTest.groovy
@@ -176,6 +176,7 @@ class ComponentSelectionRulesErrorHandlingIntegTest extends AbstractComponentSel
         """
 
         expect:
+        executer.expectDocumentedDeprecationWarning("The ComponentSelectionRules.all(Object) method has been deprecated. This is scheduled to be removed in Gradle 10. Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_9.html#dependency_management_rules")
         fails ':checkDeps'
         failureDescriptionStartsWith("A problem occurred evaluating root project")
         failure.assertHasFileName("Build file '$buildFile.path'")
@@ -219,6 +220,7 @@ class ComponentSelectionRulesErrorHandlingIntegTest extends AbstractComponentSel
         }
 
         then:
+        executer.expectDocumentedDeprecationWarning("The ComponentSelectionRules.all(Object) method has been deprecated. This is scheduled to be removed in Gradle 10. Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_9.html#dependency_management_rules")
         fails ':checkDeps'
         GradleContextualExecuter.configCache || failure.assertHasDescription("Execution failed for task ':checkDeps'.")
         failure.assertHasFileName("Build file '$buildFile.path'")
diff --git a/platforms/software/dependency-management/src/integTest/groovy/org/gradle/integtests/resolve/ivy/ComponentSelectionRulesProcessingIntegTest.groovy b/platforms/software/dependency-management/src/integTest/groovy/org/gradle/integtests/resolve/ivy/ComponentSelectionRulesProcessingIntegTest.groovy
@@ -474,7 +474,7 @@ class ComponentSelectionRulesProcessingIntegTest extends AbstractComponentSelect
     }
 
     @ToBeFixedForConfigurationCache(because = "task uses Configuration API")
-    def "can provide component selection rule as rule source"() {
+    def "can provide component selection all rule as rule source"() {
         buildFile << """
 
             dependencies {
@@ -522,7 +522,60 @@ class ComponentSelectionRulesProcessingIntegTest extends AbstractComponentSelect
         }
 
         then:
+        executer.expectDocumentedDeprecationWarning("The ComponentSelectionRules.all(Object) method has been deprecated. This is scheduled to be removed in Gradle 10. Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_9.html#dependency_management_rules")
         checkDependencies()
+    }
+
+    @ToBeFixedForConfigurationCache(because = "task uses Configuration API")
+    def "can provide component selection withModule rule as rule source"() {
+        buildFile << """
 
+            dependencies {
+                conf "org.utils:api:1.+"
+            }
+
+            def ruleSource = new Select11()
+
+            configurations.all {
+                resolutionStrategy {
+                    componentSelection {
+                        withModule("org.utils:api", ruleSource)
+                    }
+                }
+            }
+
+            checkDeps.doLast {
+                def artifacts = configurations.conf.incoming.artifacts.artifacts
+                assert artifacts.size() == 1
+                assert artifacts[0].id.componentIdentifier.version == '1.1'
+                assert ruleSource.candidates == ['1.2', '1.1']
+            }
+
+            class Select11 {
+                def candidates = []
+
+                @Mutate
+                void select(ComponentSelection selection) {
+                    if (selection.candidate.version != '1.1') {
+                        selection.reject("not 1.1")
+                    }
+                    candidates << selection.candidate.version
+                }
+            }
+        """
+
+        when:
+        repositoryInteractions {
+            'org.utils:api' {
+                expectVersionListing()
+                '1.1' {
+                    expectResolve()
+                }
+            }
+        }
+
+        then:
+        executer.expectDocumentedDeprecationWarning("The ComponentSelectionRules.withModule(Object,Object) method has been deprecated. This is scheduled to be removed in Gradle 10. Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_9.html#dependency_management_rules")
+        checkDependencies()
     }
 }
diff --git a/platforms/software/dependency-management/src/integTest/groovy/org/gradle/integtests/resolve/rules/ComponentMetadataRulesErrorHandlingIntegrationTest.groovy b/platforms/software/dependency-management/src/integTest/groovy/org/gradle/integtests/resolve/rules/ComponentMetadataRulesErrorHandlingIntegrationTest.groovy
@@ -155,6 +155,7 @@ class ComponentMetadataRulesErrorHandlingIntegrationTest extends AbstractHttpDep
         """
 
         expect:
+        executer.expectDocumentedDeprecationWarning("The ComponentMetadataHandler.all(Object) method has been deprecated. This is scheduled to be removed in Gradle 10. Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_9.html#dependency_management_rules")
         fails 'checkDeps'
         failureDescriptionStartsWith("A problem occurred evaluating root project")
         failure.assertHasFileName("Build file '$buildFile.path'")
@@ -184,6 +185,7 @@ class ComponentMetadataRulesErrorHandlingIntegrationTest extends AbstractHttpDep
         """
 
         expect:
+        executer.expectDocumentedDeprecationWarning("The ComponentMetadataHandler.all(Object) method has been deprecated. This is scheduled to be removed in Gradle 10. Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_9.html#dependency_management_rules")
         fails 'checkDeps'
         resolve.assertFailurePresent(failure)
         failure.assertHasFileName("Build file '$buildFile.path'")
diff --git a/platforms/software/dependency-management/src/integTest/groovy/org/gradle/integtests/resolve/rules/ComponentMetadataRulesIntegrationTest.groovy b/platforms/software/dependency-management/src/integTest/groovy/org/gradle/integtests/resolve/rules/ComponentMetadataRulesIntegrationTest.groovy
@@ -317,6 +317,7 @@ dependencies {
         }
 
         then:
+        executer.expectDocumentedDeprecationWarning("The ComponentMetadataHandler.all(Object) method has been deprecated. This is scheduled to be removed in Gradle 10. Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_9.html#dependency_management_rules")
         succeeds 'resolve'
     }
 
@@ -400,6 +401,9 @@ dependencies {
         }
 
         then:
+        executer.expectDocumentedDeprecationWarning("The ComponentMetadataHandler.withModule(Object,Object) method has been deprecated. This is scheduled to be removed in Gradle 10. Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_9.html#dependency_management_rules")
+        executer.expectDocumentedDeprecationWarning("The ComponentMetadataHandler.withModule(Object,Object) method has been deprecated. This is scheduled to be removed in Gradle 10. Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_9.html#dependency_management_rules")
+
         succeeds 'resolve'
     }
 
@@ -418,9 +422,11 @@ dependencies {
         """
 
         when:
+        executer.expectDocumentedDeprecationWarning("The ComponentMetadataHandler.all(Object) method has been deprecated. This is scheduled to be removed in Gradle 10. Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_9.html#dependency_management_rules")
         fails "resolve"
 
         then:
+        executer.expectDocumentedDeprecationWarning("The ComponentMetadataHandler.all(Object) method has been deprecated. This is scheduled to be removed in Gradle 10. Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_9.html#dependency_management_rules")
         fails 'resolveConf'
         failureDescriptionStartsWith("A problem occurred evaluating root project")
         failure.assertHasCause("""Type BadRuleSource is not a valid rule source:
diff --git a/platforms/software/dependency-management/src/main/java/org/gradle/api/internal/artifacts/dsl/DefaultComponentMetadataHandler.java b/platforms/software/dependency-management/src/main/java/org/gradle/api/internal/artifacts/dsl/DefaultComponentMetadataHandler.java
@@ -46,6 +46,7 @@
 import org.gradle.internal.action.ConfigurableRule;
 import org.gradle.internal.action.DefaultConfigurableRule;
 import org.gradle.internal.component.external.model.VariantDerivationStrategy;
+import org.gradle.internal.deprecation.DeprecationLogger;
 import org.gradle.internal.isolation.IsolatableFactory;
 import org.gradle.internal.management.DependencyResolutionManagementInternal;
 import org.gradle.internal.reflect.Instantiator;
@@ -173,7 +174,12 @@ public ComponentMetadataHandler all(Closure<?> rule) {
     }
 
     @Override
+    @Deprecated
     public ComponentMetadataHandler all(Object ruleSource) {
+        DeprecationLogger.deprecateMethod(ComponentMetadataHandler.class, "all(Object)")
+            .willBeRemovedInGradle10()
+            .withUpgradeGuideSection(9, "dependency_management_rules")
+            .nagUser();
         return addRule(createAllSpecRuleAction(ruleActionAdapter.createFromRuleSource(ComponentMetadataDetails.class, ruleSource)));
     }
 
@@ -188,7 +194,12 @@ public ComponentMetadataHandler withModule(Object id, Closure<?> rule) {
     }
 
     @Override
+    @Deprecated
     public ComponentMetadataHandler withModule(Object id, Object ruleSource) {
+        DeprecationLogger.deprecateMethod(ComponentMetadataHandler.class, "withModule(Object,Object)")
+            .willBeRemovedInGradle10()
+            .withUpgradeGuideSection(9, "dependency_management_rules")
+            .nagUser();
         return addRule(createSpecRuleActionForModule(id, ruleActionAdapter.createFromRuleSource(ComponentMetadataDetails.class, ruleSource)));
     }
 
diff --git a/platforms/software/dependency-management/src/main/java/org/gradle/api/internal/artifacts/ivyservice/resolutionstrategy/DefaultComponentSelectionRules.java b/platforms/software/dependency-management/src/main/java/org/gradle/api/internal/artifacts/ivyservice/resolutionstrategy/DefaultComponentSelectionRules.java
@@ -28,6 +28,7 @@
 import org.gradle.api.internal.notations.ModuleIdentifierNotationConverter;
 import org.gradle.api.specs.Spec;
 import org.gradle.api.specs.Specs;
+import org.gradle.internal.deprecation.DeprecationLogger;
 import org.gradle.internal.rules.DefaultRuleActionAdapter;
 import org.gradle.internal.rules.DefaultRuleActionValidator;
 import org.gradle.internal.rules.RuleAction;
@@ -94,7 +95,12 @@ public ComponentSelectionRules all(Closure<?> closure) {
     }
 
     @Override
+    @Deprecated
     public ComponentSelectionRules all(Object ruleSource) {
+        DeprecationLogger.deprecateMethod(ComponentSelectionRules.class, "all(Object)")
+            .willBeRemovedInGradle10()
+            .withUpgradeGuideSection(9, "dependency_management_rules")
+            .nagUser();
         return addRule(createAllSpecRulesAction(ruleActionAdapter.createFromRuleSource(ComponentSelection.class, ruleSource)));
     }
 
@@ -109,7 +115,12 @@ public ComponentSelectionRules withModule(Object id, Closure<?> closure) {
     }
 
     @Override
+    @Deprecated
     public ComponentSelectionRules withModule(Object id, Object ruleSource) {
+        DeprecationLogger.deprecateMethod(ComponentSelectionRules.class, "withModule(Object,Object)")
+            .willBeRemovedInGradle10()
+            .withUpgradeGuideSection(9, "dependency_management_rules")
+            .nagUser();
         return addRule(createSpecRuleActionFromId(id, ruleActionAdapter.createFromRuleSource(ComponentSelection.class, ruleSource)));
     }
 
diff --git a/platforms/software/dependency-management/src/main/java/org/gradle/internal/management/DefaultDependencyResolutionManagement.java b/platforms/software/dependency-management/src/main/java/org/gradle/internal/management/DefaultDependencyResolutionManagement.java
@@ -238,6 +238,7 @@ public ComponentMetadataHandler all(Closure<?> rule) {
         }
 
         @Override
+        @Deprecated
         public ComponentMetadataHandler all(Object ruleSource) {
             components(h -> h.all(ruleSource));
             return this;
@@ -268,6 +269,7 @@ public ComponentMetadataHandler withModule(Object id, Closure<?> rule) {
         }
 
         @Override
+        @Deprecated
         public ComponentMetadataHandler withModule(Object id, Object ruleSource) {
             components(h -> h.withModule(id, ruleSource));
             return this;
diff --git a/platforms/software/dependency-management/src/main/java/org/gradle/internal/rules/DefaultRuleActionAdapter.java b/platforms/software/dependency-management/src/main/java/org/gradle/internal/rules/DefaultRuleActionAdapter.java
@@ -53,6 +53,7 @@ public <T> RuleAction<? super T> createFromAction(Action<? super T> action) {
     }
 
     @Override
+    @Deprecated
     public <T> RuleAction<? super T> createFromRuleSource(Class<T> subjectType, Object ruleSource) {
         try {
             return ruleActionValidator.validate(RuleSourceBackedRuleAction.create(ModelType.of(subjectType), ruleSource));
diff --git a/platforms/software/dependency-management/src/main/java/org/gradle/internal/rules/RuleActionAdapter.java b/platforms/software/dependency-management/src/main/java/org/gradle/internal/rules/RuleActionAdapter.java
@@ -24,5 +24,6 @@ public interface RuleActionAdapter {
 
     <T> RuleAction<? super T> createFromAction(Action<? super T> action);
 
+    @Deprecated
     <T> RuleAction<? super T> createFromRuleSource(Class<T> subjectType, Object ruleSource);
 }
diff --git a/platforms/software/dependency-management/src/test/groovy/org/gradle/api/internal/artifacts/dsl/DefaultComponentMetadataHandlerTest.groovy b/platforms/software/dependency-management/src/test/groovy/org/gradle/api/internal/artifacts/dsl/DefaultComponentMetadataHandlerTest.groovy
@@ -110,23 +110,6 @@ class DefaultComponentMetadataHandlerTest extends Specification {
         ruleWrapper.rule.spec == Specs.satisfyAll()
     }
 
-    def "add rule source rule that applies to all components"() {
-        def ruleSource = new Object()
-
-        when:
-        mockedHandler.all(ruleSource)
-
-        then:
-        1 * adapter.createFromRuleSource(ComponentMetadataDetails, ruleSource) >> ruleAction
-
-        and:
-        !mockedHandler.metadataRuleContainer.isEmpty()
-        def ruleWrapper = mockedHandler.metadataRuleContainer.iterator().next()
-        !ruleWrapper.classBased
-        ruleWrapper.rule.action == (ruleAction)
-        ruleWrapper.rule.spec == Specs.satisfyAll()
-    }
-
     def "add class rule that applies to all components"() {
         when:
         handler.all(TestComponentMetadataRule)
@@ -197,24 +180,6 @@ class DefaultComponentMetadataHandlerTest extends Specification {
         ruleWrapper.rule.spec.target == DefaultModuleIdentifier.newId(GROUP, MODULE)
     }
 
-    def "add rule source rule that applies to module"() {
-        def ruleSource = new Object()
-        String notation = "${GROUP}:${MODULE}"
-
-        when:
-        mockedHandler.withModule(notation, ruleSource)
-
-        then:
-        1 * adapter.createFromRuleSource(ComponentMetadataDetails, ruleSource) >> ruleAction
-
-        and:
-        !mockedHandler.metadataRuleContainer.isEmpty()
-        def ruleWrapper = mockedHandler.metadataRuleContainer.iterator().next()
-        !ruleWrapper.classBased
-        ruleWrapper.rule.action == (ruleAction)
-        ruleWrapper.rule.spec.target == DefaultModuleIdentifier.newId(GROUP, MODULE)
-    }
-
     def "add class rule that applies to module"() {
         String notation = "${GROUP}:${MODULE}"
 
@@ -276,18 +241,6 @@ class DefaultComponentMetadataHandlerTest extends Specification {
         1 * adapter.createFromAction(action) >> { throw new InvalidUserCodeException("bad action") }
     }
 
-    def "propagates error creating rule for rule source"() {
-        when:
-        mockedHandler.all(new Object())
-
-        then:
-        def e = thrown(InvalidUserCodeException)
-        e.message == "bad rule source"
-
-        and:
-        1 * adapter.createFromRuleSource(ComponentMetadataDetails, _) >> { throw new InvalidUserCodeException("bad rule source") }
-    }
-
     def "produces sensible error when rule action throws an exception"() {
         def failure = new Exception("from test")
         def metadata = ivyMetadata()
diff --git a/platforms/software/dependency-management/src/test/groovy/org/gradle/api/internal/artifacts/ivyservice/resolutionstrategy/DefaultComponentSelectionRulesTest.groovy b/platforms/software/dependency-management/src/test/groovy/org/gradle/api/internal/artifacts/ivyservice/resolutionstrategy/DefaultComponentSelectionRulesTest.groovy
diff --git a/subprojects/core-api/src/main/java/org/gradle/api/artifacts/ComponentSelectionRules.java b/subprojects/core-api/src/main/java/org/gradle/api/artifacts/ComponentSelectionRules.java
diff --git a/subprojects/core-api/src/main/java/org/gradle/api/artifacts/dsl/ComponentMetadataHandler.java b/subprojects/core-api/src/main/java/org/gradle/api/artifacts/dsl/ComponentMetadataHandler.java

Original file line number	Diff line number	Diff line change
`@@ -317,6 +317,7 @@ dependencies {`
`317`	`317`	`}`
`318`	`318`
`319`	`319`	`then:`
	`320`	`+ executer.expectDocumentedDeprecationWarning("The ComponentMetadataHandler.all(Object) method has been deprecated. This is scheduled to be removed in Gradle 10. Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_9.html#dependency_management_rules")`
`320`	`321`	`succeeds 'resolve'`
`321`	`322`	`}`
`322`	`323`
`@@ -400,6 +401,9 @@ dependencies {`
`400`	`401`	`}`
`401`	`402`
`402`	`403`	`then:`
	`404`	`+ executer.expectDocumentedDeprecationWarning("The ComponentMetadataHandler.withModule(Object,Object) method has been deprecated. This is scheduled to be removed in Gradle 10. Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_9.html#dependency_management_rules")`
	`405`	`+ executer.expectDocumentedDeprecationWarning("The ComponentMetadataHandler.withModule(Object,Object) method has been deprecated. This is scheduled to be removed in Gradle 10. Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_9.html#dependency_management_rules")`
	`406`	`+`
`403`	`407`	`succeeds 'resolve'`
`404`	`408`	`}`
`405`	`409`
`@@ -418,9 +422,11 @@ dependencies {`
`418`	`422`	`"""`
`419`	`423`
`420`	`424`	`when:`
	`425`	`+ executer.expectDocumentedDeprecationWarning("The ComponentMetadataHandler.all(Object) method has been deprecated. This is scheduled to be removed in Gradle 10. Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_9.html#dependency_management_rules")`
`421`	`426`	`fails "resolve"`
`422`	`427`
`423`	`428`	`then:`
	`429`	`+ executer.expectDocumentedDeprecationWarning("The ComponentMetadataHandler.all(Object) method has been deprecated. This is scheduled to be removed in Gradle 10. Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_9.html#dependency_management_rules")`
`424`	`430`	`fails 'resolveConf'`
`425`	`431`	`failureDescriptionStartsWith("A problem occurred evaluating root project")`
`426`	`432`	`failure.assertHasCause("""Type BadRuleSource is not a valid rule source:`
Original file line number	Diff line number	Diff line change
`@@ -238,6 +238,7 @@ public ComponentMetadataHandler all(Closure<?> rule) {`
`238`	`238`	`}`
`239`	`239`
`240`	`240`	`@Override`
	`241`	`+ @Deprecated`
`241`	`242`	`public ComponentMetadataHandler all(Object ruleSource) {`
`242`	`243`	`components(h -> h.all(ruleSource));`
`243`	`244`	`return this;`
`@@ -268,6 +269,7 @@ public ComponentMetadataHandler withModule(Object id, Closure<?> rule) {`
`268`	`269`	`}`
`269`	`270`
`270`	`271`	`@Override`
	`272`	`+ @Deprecated`
`271`	`273`	`public ComponentMetadataHandler withModule(Object id, Object ruleSource) {`
`272`	`274`	`components(h -> h.withModule(id, ruleSource));`
`273`	`275`	`return this;`
Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,7 @@ public <T> RuleAction<? super T> createFromAction(Action<? super T> action) {`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`@Override`
	`56`	`+ @Deprecated`
`56`	`57`	`public <T> RuleAction<? super T> createFromRuleSource(Class<T> subjectType, Object ruleSource) {`
`57`	`58`	`try {`
`58`	`59`	`return ruleActionValidator.validate(RuleSourceBackedRuleAction.create(ModelType.of(subjectType), ruleSource));`
Original file line number	Diff line number	Diff line change
`@@ -24,5 +24,6 @@ public interface RuleActionAdapter {`
`24`	`24`
`25`	`25`	`<T> RuleAction<? super T> createFromAction(Action<? super T> action);`
`26`	`26`
	`27`	`+ @Deprecated`
`27`	`28`	`<T> RuleAction<? super T> createFromRuleSource(Class<T> subjectType, Object ruleSource);`
`28`	`29`	`}`