org.gradle.integtests.resolve.api.DeprecatedConfigurationsIntegrationTest.groovy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Show all versions of gradle-api Show documentation
Gradle 6.5 API redistribution.
/*
* Copyright 2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.integtests.resolve.api
import org.gradle.integtests.fixtures.AbstractIntegrationSpec
import org.gradle.integtests.fixtures.ToBeFixedForInstantExecution
class DeprecatedConfigurationsIntegrationTest extends AbstractIntegrationSpec {
def setup() {
mavenRepo.module("module", "foo", '1.0').publish()
buildFile << """
repositories {
maven { url "${mavenRepo.uri}" }
}
allprojects {
configurations {
implementation
compile.deprecateForDeclaration("implementation")
compile.deprecateForConsumption("compileElements")
compile.deprecateForResolution("compileClasspath")
compileOnly.deprecateForConsumption("compileElements")
compileOnly.deprecateForResolution("compileClasspath")
apiElements {
canBeConsumed = true
canBeResolved = false
extendsFrom compile
extendsFrom compileOnly
extendsFrom implementation
}
compileClasspath {
canBeConsumed = false
canBeResolved = true
extendsFrom compile
extendsFrom compileOnly
extendsFrom implementation
}
}
}
"""
}
def "warn if a dependency is declared on a deprecated configuration"() {
given:
buildFile << """
dependencies {
compile 'module:foo:1.0'
}
"""
when:
executer.expectDocumentedDeprecationWarning("The compile configuration has been deprecated for dependency declaration. This will fail with an error in Gradle 7.0. " +
"Please use the implementation configuration instead. " +
"Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_5.html#dependencies_should_no_longer_be_declared_using_the_compile_and_runtime_configurations")
then:
succeeds 'help'
}
def "warn if a dependency constraint is declared on a deprecated configuration"() {
given:
buildFile << """
dependencies {
constraints {
compile 'module:foo:1.0'
}
}
"""
when:
executer.expectDocumentedDeprecationWarning("The compile configuration has been deprecated for dependency declaration. This will fail with an error in Gradle 7.0. " +
"Please use the implementation configuration instead. " +
"Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_5.html#dependencies_should_no_longer_be_declared_using_the_compile_and_runtime_configurations")
then:
succeeds 'help'
}
def "warn if an artifact is declared on a configuration that is fully deprecated"() {
given:
buildFile << """
artifacts {
compile file('some.jar')
}
"""
when:
executer.expectDocumentedDeprecationWarning("The compile configuration has been deprecated for artifact declaration. This will fail with an error in Gradle 7.0. " +
"Please use the implementation or compileElements configuration instead. " +
"Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_5.html#dependencies_should_no_longer_be_declared_using_the_compile_and_runtime_configurations")
then:
succeeds 'help'
}
def "warn if a deprecated configuration is resolved"() {
given:
buildFile << """
task resolve {
doLast {
configurations.compileOnly.files
}
}
"""
when:
executer.expectDocumentedDeprecationWarning("The compileOnly configuration has been deprecated for resolution. This will fail with an error in Gradle 7.0. " +
"Please resolve the compileClasspath configuration instead. " +
"Consult the upgrading guide for further information: https://docs.gradle.org/current/userguide/upgrading_version_5.html#dependencies_should_no_longer_be_declared_using_the_compile_and_runtime_configurations")
then:
succeeds 'resolve'
}
def "warn if a deprecated project configuration is consumed"() {
given:
settingsFile << "include 'a', 'b'"
buildFile << """
project(':b') {
dependencies {
implementation project(path: ':a', configuration: 'compileOnly')
}
task resolve {
doLast {
configurations.compileClasspath.files
}
}
}
"""
when:
executer.expectDocumentedDeprecationWarning("The compileOnly configuration has been deprecated for consumption. This will fail with an error in Gradle 7.0. " +
"Please use attributes to consume the compileElements configuration instead. " +
"See https://docs.gradle.org/current/userguide/java_library_plugin.html#sec:java_library_configurations_graph for more details.")
then:
succeeds ':b:resolve'
}
@ToBeFixedForInstantExecution
def "warn if a deprecated project configuration is consumed directly"() {
// this is testing legacy code that we can/should probably get rid of
given:
settingsFile << "include 'a', 'b'"
buildFile << """
project(':b') {
dependencies {
implementation project(path: ':a', configuration: 'compileOnly')
}
task resolve {
doLast {
configurations.implementation.dependencies[0].resolve()
}
}
}
"""
when:
executer.expectDocumentedDeprecationWarning("The compileOnly configuration has been deprecated for consumption. This will fail with an error in Gradle 7.0. " +
"Please use attributes to consume the compileElements configuration instead. " +
"See https://docs.gradle.org/current/userguide/java_library_plugin.html#sec:java_library_configurations_graph for more details.")
then:
succeeds ':b:resolve', ':b:dependencies'
}
}