org.gradle.api.internal.AbstractNamedDomainObjectCollectionSpec.groovy Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 5.6 API redistribution.
There is a newer version: 8.6
/*
 * Copyright 2018 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.api.internal

import org.gradle.api.NamedDomainObjectCollection
import org.gradle.internal.Actions
import spock.lang.Unroll

abstract class AbstractNamedDomainObjectCollectionSpec extends AbstractDomainObjectCollectionSpec {
    abstract NamedDomainObjectCollection getContainer()

    @Override
    protected Map getQueryMethods() {
        return super.getQueryMethods() + [
            "getByName(String)": { container.getByName("a") },
        ]
    }

    @Override
    protected Map getMutatingMethods() {
        return super.getMutatingMethods() + [
            "getByName(String, Action)": { container.getByName("a", Actions.doNothing()) }
        ]
    }

    @Unroll
    def "disallow mutating from named actions using #mutatingMethods.key"() {
        setupContainerDefaults()
        container.add(a)
        String methodUnderTest = mutatingMethods.key
        Closure method = bind(mutatingMethods.value)

        when:
        container.named("a").configure(method)
        then:
        def ex = thrown(Throwable)
        assertDoesNotAllowMethod(ex, methodUnderTest)

        when:
        container.named("a", method)
        then:
        ex = thrown(Throwable)
        assertDoesNotAllowMethod(ex, methodUnderTest)

        when:
        container.named("a", getType(), method)
        then:
        ex = thrown(Throwable)
        assertDoesNotAllowMethod(ex, methodUnderTest)

        when:
        container.withType(container.type).named("a").configure(method)
        then:
        ex = thrown(Throwable)
        assertDoesNotAllowMethod(ex, methodUnderTest)

        when:
        container.withType(container.type).named("a", method)
        then:
        ex = thrown(Throwable)
        assertDoesNotAllowMethod(ex, methodUnderTest)

        when:
        container.withType(container.type).named("a", getType(), method)
        then:
        ex = thrown(Throwable)
        assertDoesNotAllowMethod(ex, methodUnderTest)

        when:
        container.matching({ it in container.type }).named("a").configure(method)
        then:
        ex = thrown(Throwable)
        assertDoesNotAllowMethod(ex, methodUnderTest)

        when:
        container.matching({ it in container.type }).named("a", method)
        then:
        ex = thrown(Throwable)
        assertDoesNotAllowMethod(ex, methodUnderTest)

        when:
        container.matching({ it in container.type }).named("a", getType(), method)
        then:
        ex = thrown(Throwable)
        assertDoesNotAllowMethod(ex, methodUnderTest)

        where:
        mutatingMethods << getMutatingMethods()
    }

    @Unroll
    def "allow query methods from named using #queryMethods.key"() {
        setupContainerDefaults()
        container.add(a)
        String methodUnderTest = queryMethods.key
        Closure method = bind(queryMethods.value)

        when:
        container.named("a").configure(method)
        then:
        noExceptionThrown()

        when:
        container.named("a", method)
        then:
        noExceptionThrown()

        when:
        container.named("a", getType(), method)
        then:
        noExceptionThrown()

        when:
        container.withType(container.type).named("a").configure(method)
        then:
        noExceptionThrown()

        when:
        container.withType(container.type).named("a", method)
        then:
        noExceptionThrown()

        when:
        container.withType(container.type).named("a", getType(), method)
        then:
        noExceptionThrown()

        when:
        container.matching({ it in container.type }).named("a").configure(method)
        then:
        noExceptionThrown()

        when:
        container.matching({ it in container.type }).named("a", method)
        then:
        noExceptionThrown()

        when:
        container.matching({ it in container.type }).named("a", getType(), method)
        then:
        noExceptionThrown()

        where:
        queryMethods << getQueryMethods()
    }

    @Unroll
    def "allow common querying and mutating methods when #methods.key within getByName configuration action"() {
        setupContainerDefaults()
        container.add(a)
        Closure method = bind(methods.value)

        when:
        container.getByName("a", noReentry(method))
        then:
        noExceptionThrown()

        where:
        methods << getQueryMethods() + getMutatingMethods()
    }

    @Unroll
    def "allow common querying and mutating methods when #methods.key within getByName configuration action on filtered container by type"() {
        setupContainerDefaults()
        container.add(a)
        Closure method = bind(methods.value)

        when:
        container.withType(container.type).getByName("a", noReentry(method))
        then:
        noExceptionThrown()

        where:
        methods << getQueryMethods() + getMutatingMethods()
    }

    @Unroll
    def "allow common querying and mutating methods when #methods.key within getByName configuration action on filtered container by spec"() {
        setupContainerDefaults()
        container.add(a)
        Closure method = bind(methods.value)

        when:
        container.matching({ it in container.type }).getByName("a", noReentry(method))
        then:
        noExceptionThrown()

        where:
        methods << getQueryMethods() + getMutatingMethods()
    }
}