org.gradle.test.fixtures.maven.M2Installation.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 2012 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.test.fixtures.maven
import org.gradle.api.Action
import org.gradle.integtests.fixtures.executer.GradleExecuter
import org.gradle.test.fixtures.file.TestDirectoryProvider
import org.gradle.test.fixtures.file.TestFile

class M2Installation implements Action {
    private final TestDirectoryProvider temporaryFolder
    private boolean initialized = false
    private TestFile userHomeDir
    private TestFile userM2Directory
    private TestFile userSettingsFile
    private TestFile globalMavenDirectory
    private TestFile globalSettingsFile
    private TestFile isolatedMavenRepoForLeakageChecks
    private boolean isolateMavenLocal = true

    M2Installation(TestDirectoryProvider temporaryFolder) {
        this.temporaryFolder = temporaryFolder
    }

    private void init() {
        if (!initialized) {
            userHomeDir = temporaryFolder.testDirectory.createDir("maven_home")
            userM2Directory = userHomeDir.createDir(".m2")
            userSettingsFile = userM2Directory.file("settings.xml")
            globalMavenDirectory = userHomeDir.createDir("m2_home")
            globalSettingsFile = globalMavenDirectory.file("conf/settings.xml")
            println "M2 home: " + userHomeDir

            initialized = true
        }
    }

    void assertNoLeftoverState() {
        assert System.getenv("M2_HOME") == null
        assert System.getProperty("maven.repo.local") == null
    }

    void cleanupState() {
        System.clearProperty("maven.repo.local")
    }

    TestFile getUserHomeDir() {
        init()
        return userHomeDir
    }

    TestFile getUserM2Directory() {
        init()
        return userM2Directory
    }

    TestFile getUserSettingsFile() {
        init()
        return userSettingsFile
    }

    TestFile getGlobalMavenDirectory() {
        init()
        return globalMavenDirectory
    }

    TestFile getGlobalSettingsFile() {
        init()
        return globalSettingsFile
    }

    MavenLocalRepository mavenRepo() {
        init()
        new MavenLocalRepository(userM2Directory.file("repository"))
    }

    M2Installation generateUserSettingsFile(MavenLocalRepository userRepository) {
        init()
        userSettingsFile.text = """

    ${userRepository.rootDir.absolutePath}
"""
        return this
    }

    M2Installation generateGlobalSettingsFile(MavenLocalRepository globalRepository = mavenRepo()) {
        init()
        globalSettingsFile.createFile().text = """

    ${globalRepository.rootDir.absolutePath}
"""
        return this
    }

    void execute(GradleExecuter gradleExecuter) {
        init()
        gradleExecuter.withUserHomeDir(userHomeDir)
        // if call `using m2`, then we disable the automatic isolation of m2
        isolateMavenLocal = false
        if (globalMavenDirectory?.exists()) {
            gradleExecuter.withEnvironmentVars(M2_HOME: globalMavenDirectory.absolutePath)
        }
    }

    void isolateMavenLocalRepo(GradleExecuter gradleExecuter) {
        gradleExecuter.beforeExecute {
            if (isolateMavenLocal) {
                isolatedMavenRepoForLeakageChecks = temporaryFolder.testDirectory.createDir("m2-home-should-not-be-filled")
                setMavenLocalLocation(gradleExecuter, isolatedMavenRepoForLeakageChecks)
            }
        }
    }

    private static void setMavenLocalLocation(GradleExecuter gradleExecuter, File destination) {
        gradleExecuter.withArgument("-Dmaven.repo.local=${destination?:''}" )
    }
}