org.eclipse.edc.plugins.edcbuild.conventions.MavenArtifactConvention Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of edc-build Show documentation
edc :: edc-build
There is a newer version: 0.9.1
/*
 *  Copyright (c) 2022 - 2023 Microsoft Corporation
 *
 *  This program and the accompanying materials are made available under the
 *  terms of the Apache License, Version 2.0 which is available at
 *  https://www.apache.org/licenses/LICENSE-2.0
 *
 *  SPDX-License-Identifier: Apache-2.0
 *
 *  Contributors:
 *       Microsoft Corporation - initial API and implementation
 *       Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
 *
 */

package org.eclipse.edc.plugins.edcbuild.conventions;

import org.eclipse.edc.plugins.autodoc.AutodocExtension;
import org.eclipse.edc.plugins.edcbuild.extensions.BuildExtension;
import org.eclipse.edc.plugins.edcbuild.extensions.MavenPomExtension;
import org.gradle.api.Action;
import org.gradle.api.Project;
import org.gradle.api.artifacts.ConfigurablePublishArtifact;
import org.gradle.api.publish.PublishingExtension;
import org.gradle.api.publish.maven.MavenPom;
import org.gradle.api.publish.maven.MavenPublication;
import org.jetbrains.annotations.NotNull;

import java.io.File;
import java.nio.file.Path;

import static org.eclipse.edc.plugins.edcbuild.conventions.ConventionFunctions.requireExtension;

/**
 * Configures the Maven POM for each project:
 * 
 *     sets project name, description, license, SCM info etc.
 *     adds an artifact for the documentation manifest ("edc.json")
 * 
 */
class MavenArtifactConvention implements EdcConvention {

    private static final String PROJECT_URL = "https://projects.eclipse.org/projects/technology.edc";

    @Override
    public void apply(Project target) {
        target.afterEvaluate(project -> {
            var pubExt = requireExtension(project, PublishingExtension.class);
            var pomExt = requireExtension(project, BuildExtension.class).getPom();

            pubExt.getPublications().stream()
                    .filter(p -> p instanceof MavenPublication)
                    .map(p -> (MavenPublication) p)
                    .peek(mavenPub -> mavenPub.pom(pom -> setPomInformation(pomExt, target, pom)))
                    .forEach(mavenPub -> {
                        addArtifactIfExist(target, getManifestFile(target), mavenPub, artifact -> {
                            artifact.setClassifier("manifest");
                            artifact.setType("json");
                            artifact.builtBy("autodoc");
                        });

                        var openapiFiles = target.getLayout().getBuildDirectory().getAsFile().get().toPath()
                                .resolve("docs").resolve("openapi").toFile()
                                .listFiles((dir, name) -> name.endsWith(".yaml"));

                        if (openapiFiles != null) {
                            for (var openapiFile : openapiFiles) {
                                addArtifactIfExist(target, openapiFile, mavenPub, artifact -> {
                                    artifact.setClassifier(getFilenameWithoutExtension(openapiFile));
                                    artifact.setType("yaml");
                                    artifact.builtBy("openapi");
                                });
                            }
                        }

                    });
        });
    }

    private String getFilenameWithoutExtension(File openapiFile) {
        return openapiFile.getName().substring(0, openapiFile.getName().lastIndexOf("."));
    }

    private void addArtifactIfExist(Project project, File location, MavenPublication mavenPublication, Action configureAction) {
        if (location.exists()) {
            mavenPublication.getArtifacts()
                    .artifact(project.getArtifacts().add("archives", location, configureAction));
        }
    }

    private static @NotNull File getManifestFile(Project target) {
        var autodocExt = requireExtension(target, AutodocExtension.class);
        var pathToManifest = autodocExt.getOutputDirectory().getOrElse(target.getLayout().getBuildDirectory().getAsFile().get()).getAbsolutePath();
        var manifestFileName = "edc.json";
        return Path.of(pathToManifest, manifestFileName).toFile();
    }

    private static void setPomInformation(MavenPomExtension pomExt, Project project, MavenPom pom) {
        // these properties are mandatory!
        var projectName = pomExt.getProjectName().getOrElse(project.getName());
        var description = pomExt.getDescription().getOrElse("edc :: " + project.getName());
        var projectUrl = pomExt.getProjectUrl().getOrElse(PROJECT_URL);
        pom.getName().set(projectName);
        pom.getDescription().set(description);
        pom.getUrl().set(projectUrl);

        // we'll provide a sane default for these properties
        pom.licenses(l -> l.license(pl -> {
            pl.getName().set(pomExt.getLicenseName().getOrElse("The Apache License, Version 2.0"));
            pl.getUrl().set(pomExt.getLicenseUrl().getOrElse("http://www.apache.org/licenses/LICENSE-2.0.txt"));
        }));

        pom.developers(d -> d.developer(md -> {
            md.getId().set(pomExt.getDeveloperId().getOrElse("mspiekermann"));
            md.getName().set(pomExt.getDeveloperName().getOrElse("Markus Spiekermann"));
            md.getEmail().set(pomExt.getDeveloperEmail().getOrElse("[email protected]"));
        }));

        pom.scm(scm -> {
            scm.getUrl().set(pomExt.getScmUrl());
            scm.getConnection().set(pomExt.getScmConnection());
        });
    }

}