org.gradle.performance.fixture.GradleInvocationSpec.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
Gradle 6.9.1 API redistribution.
There is a newer version: 8.11.1
/*
 * Copyright 2014 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.performance.fixture

import groovy.transform.CompileStatic
import groovy.transform.EqualsAndHashCode
import org.gradle.initialization.ParallelismBuildOptions
import org.gradle.integtests.fixtures.executer.GradleDistribution
import org.gradle.profiler.BuildAction
import org.gradle.profiler.gradle.RunTasksAction

@CompileStatic
@EqualsAndHashCode
class GradleInvocationSpec implements InvocationSpec {
    final GradleDistribution gradleDistribution
    final File workingDirectory
    final List tasksToRun
    final BuildAction buildAction
    final List args
    /**
     * The JVM arguments for client VM. It's only for CLI invocation and is ignored by TAPI invocation.
     */
    final List clientJvmArguments
    /**
     * The JVM arguments for daemon
     */
    final List jvmArguments
    final List cleanTasks
    final boolean useDaemon
    final boolean useToolingApi
    final boolean useAndroidStudio
    final File studioInstallDir
    final File studioSandboxDir
    /**
     * The special JVM arguments for Android Studio.
     */
    final List studioJvmArgs
    /**
     * The special idea.properties for Android Studio,
     * this can be used to set registry values as well, e.g. `gradle.tooling.models.parallel.fetch=true`.
     */
    final List studioIdeaProperties
    final boolean expectFailure
    final File buildLog

    GradleInvocationSpec(
        GradleDistribution gradleDistribution,
        File workingDirectory,
        List tasksToRun,
        List args,
        List clientJvmArguments,
        List jvmArguments,
        List cleanTasks,
        boolean useDaemon,
        boolean useToolingApi,
        boolean expectFailure,
        BuildAction buildAction,
        File buildLog,
        boolean useAndroidStudio,
        List studioJvmArgs,
        List studioIdeaProperties,
        File studioInstallDir,
        File studioSandboxDir
    ) {
        this.gradleDistribution = gradleDistribution
        this.workingDirectory = workingDirectory
        this.tasksToRun = tasksToRun
        this.args = args
        this.clientJvmArguments = clientJvmArguments
        this.jvmArguments = jvmArguments
        this.cleanTasks = cleanTasks
        this.useDaemon = useDaemon
        this.useToolingApi = useToolingApi
        this.expectFailure = expectFailure
        this.buildAction = buildAction
        this.buildLog = buildLog
        this.useAndroidStudio = useAndroidStudio
        this.studioJvmArgs = studioJvmArgs
        this.studioIdeaProperties = studioIdeaProperties
        this.studioInstallDir = studioInstallDir
        this.studioSandboxDir = studioSandboxDir
    }

    boolean getBuildWillRunInDaemon() {
        return useDaemon || useToolingApi || useAndroidStudio
    }

    static InvocationBuilder builder() {
        return new InvocationBuilder()
    }

    InvocationBuilder withBuilder() {
        InvocationBuilder builder = new InvocationBuilder()
        builder.distribution(gradleDistribution)
        builder.workingDirectory(workingDirectory)
        builder.tasksToRun.addAll(this.tasksToRun)
        builder.args.addAll(args)
        builder.jvmArguments.addAll(jvmArguments)
        builder.cleanTasks.addAll(cleanTasks)
        builder.useDaemon = useDaemon
        builder.useToolingApi = useToolingApi
        builder.expectFailure = expectFailure
        builder.buildLog(buildLog)
        builder.useAndroidStudio = useAndroidStudio
        builder.studioJvmArguments.addAll(studioJvmArgs)
        builder.studioIdeaProperties.addAll(studioIdeaProperties)
        builder.studioInstallDir = studioInstallDir
        builder.studioSandboxDir = studioSandboxDir
        builder
    }

    GradleInvocationSpec withAdditionalJvmOpts(List additionalJvmOpts) {
        InvocationBuilder builder = withBuilder()
        builder.jvmArguments.addAll(additionalJvmOpts)
        return builder.build()
    }

    GradleInvocationSpec withAdditionalArgs(List additionalArgs) {
        InvocationBuilder builder = withBuilder()
        builder.args.addAll(additionalArgs)
        return builder.build()
    }

    static class InvocationBuilder implements Builder {
        GradleDistribution gradleDistribution
        File workingDirectory
        List tasksToRun = []
        BuildAction buildAction
        List args = []
        List jvmArguments = []
        List clientJvmArguments = []
        List cleanTasks = []
        boolean useDaemon = true
        boolean useToolingApi
        boolean useAndroidStudio
        List studioJvmArguments = []
        List studioIdeaProperties = []
        File studioInstallDir
        File studioSandboxDir
        boolean expectFailure
        File buildLog

        InvocationBuilder distribution(GradleDistribution gradleDistribution) {
            this.gradleDistribution = gradleDistribution
            this
        }

        InvocationBuilder workingDirectory(File workingDirectory) {
            this.workingDirectory = workingDirectory
            this
        }

        InvocationBuilder tasksToRun(String... taskToRun) {
            this.tasksToRun.addAll(Arrays.asList(taskToRun))
            this
        }

        InvocationBuilder tasksToRun(Iterable taskToRun) {
            this.tasksToRun.addAll(taskToRun)
            this
        }

        InvocationBuilder buildAction(BuildAction buildAction) {
            this.buildAction = buildAction
            this
        }

        InvocationBuilder args(String... args) {
            this.args.addAll(Arrays.asList(args))
            this
        }

        InvocationBuilder jvmArgs(String... args) {
            this.jvmArguments.addAll(Arrays.asList(args))
            this
        }

        InvocationBuilder jvmArgs(Iterable args) {
            this.jvmArguments.addAll(args)
            this
        }

        InvocationBuilder clientJvmArgs(String... args) {
            this.clientJvmArguments.addAll(Arrays.asList(args))
            this
        }

        InvocationBuilder clientJvmArgs(Iterable args) {
            this.clientJvmArguments.addAll(args)
            this
        }

        InvocationBuilder cleanTasks(String... cleanTasks) {
            this.cleanTasks(Arrays.asList(cleanTasks))
        }

        InvocationBuilder cleanTasks(Iterable cleanTasks) {
            this.cleanTasks.addAll(cleanTasks)
            this
        }

        InvocationBuilder useDaemon(boolean flag) {
            this.useDaemon = flag
            this
        }

        InvocationBuilder useToolingApi() {
            useToolingApi(true)
            this
        }

        InvocationBuilder useToolingApi(boolean flag) {
            this.useToolingApi = flag
            this
        }

        InvocationBuilder useAndroidStudio(boolean flag) {
            this.useAndroidStudio = flag
            this
        }

        InvocationBuilder studioJvmArgs(Iterable studioJvmArgs) {
            this.studioJvmArguments.addAll(studioJvmArgs)
            this
        }

        InvocationBuilder studioIdeaProperties(Iterable studioIdeaProperties) {
            this.studioIdeaProperties.addAll(studioIdeaProperties)
            this
        }

        InvocationBuilder studioInstallDir(File studioInstallDir) {
            this.studioInstallDir = studioInstallDir
            this
        }

        InvocationBuilder studioSandboxDir(File studioSandboxDir) {
            this.studioSandboxDir = studioSandboxDir
            this
        }

        InvocationBuilder disableParallelWorkers() {
            jvmArgs("-D${ParallelismBuildOptions.MaxWorkersOption.GRADLE_PROPERTY}=1")
        }

        InvocationBuilder buildLog(File buildLog) {
            this.buildLog = buildLog
            this
        }

        @Override
        Builder expectFailure() {
            expectFailure = true
            this
        }

        GradleInvocationSpec build() {
            assert gradleDistribution != null
            assert workingDirectory != null

            return new GradleInvocationSpec(
                gradleDistribution,
                workingDirectory,
                tasksToRun.asImmutable(),
                args.asImmutable(),
                clientJvmArguments.asImmutable(),
                jvmArguments.asImmutable(),
                cleanTasks.asImmutable(),
                useDaemon,
                useToolingApi,
                expectFailure,
                buildAction ?: new RunTasksAction(tasksToRun),
                buildLog,
                useAndroidStudio,
                studioJvmArguments,
                studioIdeaProperties,
                studioInstallDir,
                studioSandboxDir
            )
        }

    }
}