net.corda.plugins.ApiScanner Maven / Gradle / Ivy

Go to download
package net.corda.plugins;

import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.artifacts.ConfigurationContainer;
import org.gradle.api.file.FileCollection;
import org.gradle.api.tasks.TaskCollection;
import org.gradle.jvm.tasks.Jar;

import javax.annotation.Nonnull;

public class ApiScanner implements Plugin {

    /**
     * Identify the Gradle Jar tasks creating jars
     * without Maven classifiers, and generate API
     * documentation for them.
     * @param p Current project.
     */
    @Override
    public void apply(@Nonnull Project p) {
        p.getLogger().info("Applying API scanner to {}", p.getName());

        ScannerExtension extension = p.getExtensions().create("scanApi", ScannerExtension.class);

        p.afterEvaluate(project -> {
            TaskCollection jarTasks = project.getTasks()
                .withType(Jar.class)
                .matching(jarTask -> jarTask.getClassifier().isEmpty() && jarTask.isEnabled());
            if (jarTasks.isEmpty()) {
                return;
            }

            project.getLogger().info("Adding scanApi task to {}", project.getName());
            project.getTasks().create("scanApi", ScanApi.class, scanTask -> {
                scanTask.setClasspath(compilationClasspath(project.getConfigurations()));
                // Automatically creates a dependency on jar tasks.
                scanTask.setSources(project.files(jarTasks));
                scanTask.setExcludeClasses(extension.getExcludeClasses());
                scanTask.setVerbose(extension.isVerbose());
                scanTask.setEnabled(extension.isEnabled());

                // Declare this ScanApi task to be a dependency of any
                // GenerateApi tasks belonging to any of our ancestors.
                project.getRootProject().getTasks()
                    .withType(GenerateApi.class)
                    .matching(generateTask -> isAncestorOf(generateTask.getProject(), project))
                    .forEach(generateTask -> generateTask.dependsOn(scanTask));
            });
        });
    }

    /*
     * Recurse through a child project's parents until we reach the root,
     * and return true iff we find our target project along the way.
     */
    private static boolean isAncestorOf(Project target, Project child) {
        Project p = child;
        while (p != null) {
            if (p == target) {
                return true;
            }
            p = p.getParent();
        }
        return false;
    }

    private static FileCollection compilationClasspath(ConfigurationContainer configurations) {
        return configurations.getByName("compile")
                .plus(configurations.getByName("compileOnly"));
    }
}