com.palantir.gradle.jdks.GradleJdksConfigs Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-jdks Show documentation
Download specific JDKs versions automatically
There is a newer version: 0.59.0
/*
 * (c) Copyright 2024 Palantir Technologies Inc. All rights reserved.
 *
 * 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 com.palantir.gradle.jdks;

import com.palantir.gradle.jdks.setup.common.CurrentArch;
import com.palantir.gradle.jdks.setup.common.CurrentOs;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.concurrent.atomic.AtomicBoolean;
import org.gradle.api.DefaultTask;
import org.gradle.api.file.Directory;
import org.gradle.api.provider.MapProperty;
import org.gradle.api.provider.Property;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.Nested;
import org.gradle.api.tasks.TaskAction;
import org.gradle.jvm.toolchain.JavaLanguageVersion;

/**
 * Abstracts the actions that need to be applied on the generated `gradle/` files.
 * The two tasks {@link CheckGradleJdksConfigsTask} and {@link GenerateGradleJdksConfigsTask} need to either check the
 * validity of the already generated gradle files or generate the gradle files.
 */
public abstract class GradleJdksConfigs extends DefaultTask {

    public static final String GRADLE_JDKS_SETUP_JAR = "gradle-jdks-setup.jar";
    public static final String GRADLE_JDKS_SETUP_SCRIPT = "gradle-jdks-setup.sh";
    public static final String GRADLE_JDKS_FUNCTIONS_SCRIPT = "gradle-jdks-functions.sh";

    @Nested
    public abstract MapProperty> getJavaVersionToJdkDistros();

    @Input
    public abstract Property getDaemonJavaVersion();

    @Input
    public abstract MapProperty getCaCerts();

    abstract Directory gradleDirectory();

    protected abstract void applyGradleJdkFileAction(
            Path downloadUrlPath, Path localUrlPath, JdkDistributionConfig jdkDistributionConfig);

    protected abstract void applyGradleJdkDaemonVersionAction(Path gradleJdkDaemonVersion);

    protected abstract void applyGradleJdkJarAction(File gradleJdkJarFile, String resourceName);

    protected abstract void applyGradleJdkScriptAction(File gradleJdkScriptFile, String resourceName);

    protected abstract void maybePrepareForAction(List targetPaths);

    @TaskAction
    public final void action() {
        Path gradleJdksDir = gradleDirectory().dir("jdks").getAsFile().toPath();
        Path gradleJdksSetupJar =
                gradleDirectory().file(GRADLE_JDKS_SETUP_JAR).getAsFile().toPath();
        Path gradleJdksFunctionsScript =
                gradleDirectory().file(GRADLE_JDKS_FUNCTIONS_SCRIPT).getAsFile().toPath();
        Path gradleJdksSetupScript =
                gradleDirectory().file(GRADLE_JDKS_SETUP_SCRIPT).getAsFile().toPath();
        // Older versions of `gradle.jdks` would also populate the `certs/` directory
        // TODO(crogoz): Remove this once everyone is on the newer `com.palantir.jdks`
        Path certsDir = gradleDirectory().dir("certs").getAsFile().toPath();
        maybePrepareForAction(
                List.of(gradleJdksDir, gradleJdksSetupJar, gradleJdksFunctionsScript, gradleJdksSetupScript, certsDir));
        AtomicBoolean jdksDirectoryConfigured = new AtomicBoolean(false);
        getJavaVersionToJdkDistros().get().forEach((javaVersion, jdkDistros) -> {
            jdkDistros.forEach(jdkDistribution -> {
                Path outputDir = gradleJdksDir
                        .resolve(javaVersion.toString())
                        .resolve(jdkDistribution.getOs().get().uiName())
                        .resolve(jdkDistribution.getArch().get().uiName());
                Path downloadUrlPath = outputDir.resolve("download-url");
                Path localPath = outputDir.resolve("local-path");
                applyGradleJdkFileAction(downloadUrlPath, localPath, jdkDistribution);
                jdksDirectoryConfigured.set(true);
            });
        });
        if (!jdksDirectoryConfigured.get()) {
            throw new RuntimeException(
                    "No JDKs were configured for the gradle setup. Please run `./gradlew setupJdks` to generate the"
                            + " JDKs and ensure that you have configured JDKs properly for gradle-jdks as per"
                            + " the readme: https://github.com/palantir/gradle-jdks#usage");
        }

        String gradleJdkDaemonVersion = getDaemonJavaVersion().get().toString();
        String os = CurrentOs.get().toString();
        String arch = CurrentArch.get().toString();
        Path expectedJdkDir =
                gradleJdksDir.resolve(gradleJdkDaemonVersion).resolve(os).resolve(arch);
        if (!Files.exists(expectedJdkDir)) {
            throw new RuntimeException(String.format(
                    "Gradle daemon JDK version is `%s` but no JDK configured for that version. Please ensure that you"
                            + " have configured JDKs properly for gradle-jdks as per the readme:"
                            + " https://github.com/palantir/gradle-jdks#usage and the gradle daemon version specified "
                            + "in the jdks#daemonTarget extension is correctly set",
                    gradleJdkDaemonVersion));
        }
        applyGradleJdkDaemonVersionAction(gradleDirectory().getAsFile().toPath().resolve("gradle-daemon-jdk-version"));

        applyGradleJdkJarAction(gradleJdksSetupJar.toFile(), GRADLE_JDKS_SETUP_JAR);
        applyGradleJdkScriptAction(gradleJdksFunctionsScript.toFile(), GRADLE_JDKS_FUNCTIONS_SCRIPT);
        applyGradleJdkScriptAction(gradleJdksSetupScript.toFile(), GRADLE_JDKS_SETUP_SCRIPT);
    }
}