com.csoft.services.BuildLogger Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of licensescan-maven-plugin Show documentation

Maven plugin for analysing the licenses in dependencies and transitive dependencies, asserting compatibility and potentially fail the build if forbidden licenses appear

The newest version!

package com.csoft.services;

import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;

import java.util.List;
import java.util.Map;

/**
 * Class that implements the output shown during the build by the LicenseScan
 * Maven Plugin.
 */
public class BuildLogger {

    private final boolean printLicenses;
    private final Log log;


    public BuildLogger(final boolean printLicenses,
                       final Log log) {
        this.printLicenses = printLicenses;
        this.log = log;
    }

    /**
     * Prints the Header of a LicenseScan log output, showing all details
     * of the {@link MavenProject} in input.
     */
    public void logHeadAnalysis(final MavenProject project) {
        log.info("");
        log.info("---------------< LicenseScan: Project Details >---------------");
        log.info(" - artifactId  : " + project.getArtifactId());
        log.info(" - groupId     : " + project.getGroupId());
        log.info(" - description : " + project.getDescription());
        log.info(" - version     : " + project.getVersion());
        log.info(" - path        : " + project.getFile().getPath());
    }

    /**
     * Prints the Base Dependencies section of a LicenseScan.
     *
     * @param licensesMap Map between artifact GAV label (key) and associated list of licenses (value).
     */
    public void logBaseDeps(final Map> licensesMap) {
        logDeps(licensesMap, "--------------< LicenseScan: Base Dependencies >--------------", printLicenses);
    }

    /**
     * Prints the Transitive Dependencies section of a LicenseScan.
     *
     * @param licensesMap Map between artifact GAV label (key) and associated list of licenses (value).
     */
    public void logTransitiveDeps(final Map> licensesMap) {
        logDeps(licensesMap, "-----------< LicenseScan: Transitive Dependencies >-----------", printLicenses);
    }

    private void logDeps(final Map> licensesMap,
                         final String sectionTitle,
                         final boolean printLicenses) {
        log.info("");
        log.info(sectionTitle);
        for (String gavLabel : licensesMap.keySet()) {
            log.info(" - artifact " + gavLabel);
            if (printLicenses) {
                List licenses = licensesMap.get(gavLabel);
                if (licenses == null || licenses.isEmpty()) {
                    log.info("   with license: n/a");
                } else {
                    for (String license : licenses) {
                        log.info("   with license: " + license);
                    }
                }
            }
        }
    }
}