com.palantir.baseline.plugins.BaselineClassUniquenessPlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-baseline-java Show documentation
A Gradle plugin for applying Baseline-recommended build and IDE settings
There is a newer version: 5.68.0
/*
 * (c) Copyright 2018 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.baseline.plugins;

import com.palantir.baseline.services.JarClassHasher;
import com.palantir.baseline.tasks.CheckClassUniquenessLockTask;
import org.gradle.api.Project;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.plugins.JavaPlugin;
import org.gradle.api.provider.Provider;
import org.gradle.api.tasks.TaskProvider;
import org.gradle.language.base.plugins.LifecycleBasePlugin;

/**
 * This plugin is similar to https://github.com/nebula-plugins/gradle-lint-plugin/wiki/Duplicate-Classes-Rule but goes
 * one step further and actually hashes any identically named classfiles to figure out if they're completely
 * identical (and therefore safely interchangeable).
 *
 * The task only fails if it finds classes which have the same name but different implementations.
 */
public class BaselineClassUniquenessPlugin extends AbstractBaselinePlugin {
    @Override
    public final void apply(Project project) {
        Provider jarClassHasher = project.getGradle()
                .getSharedServices()
                .registerIfAbsent("jarClassHasher", JarClassHasher.class, _spec -> {});
        TaskProvider checkClassUniqueness = project.getTasks()
                .register("checkClassUniqueness", CheckClassUniquenessLockTask.class, task -> {
                    task.jarClassHasher.set(jarClassHasher);
                    task.shouldFix.convention(
                            project.getGradle().getStartParameter().isWriteDependencyLocks());
                    task.usesService(jarClassHasher);
                });
        project.getPlugins().apply(LifecycleBasePlugin.class);
        project.getTasks().named(LifecycleBasePlugin.CHECK_TASK_NAME).configure(t -> t.dependsOn(checkClassUniqueness));

        project.getPlugins().withId("java", plugin -> {
            checkClassUniqueness.configure(t -> {
                Configuration runtimeClasspath =
                        project.getConfigurations().getByName(JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME);
                t.configurations.add(runtimeClasspath);

                // runtimeClasspath might contain jars which are 'builtBy' other tasks, for example conjure-generated
                // objects. This dependsOn ensures that all those pre-requisite tasks get invoked first, otherwise
                // we see log.info warnings about missing jars e.g. 'Skipping non-existent jar foo-api-objects.jar'
                t.dependsOn(runtimeClasspath);
            });
        });
    }
}