com.tngtech.jgiven.maven.JGivenReportMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jgiven-maven-plugin Show documentation
JGiven Maven Mojo
There is a newer version: 2.0.1
package com.tngtech.jgiven.maven;

import java.io.File;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;

import com.tngtech.jgiven.report.ReportGenerator;

/**
 * @goal report
 * @phase verify
 */
public class JGivenReportMojo extends AbstractMojo {

    /**
     * Directory where the reports are generated to
     * @parameter expression="${project.build.directory}/jgiven-reports/html"
     */
    private File outputDirectory;

    /**
     * Directory to read the JSON report files from
     * @parameter expression="${project.build.directory}/jgiven-reports/json"
     */
    private File sourceDirectory;

    /**
     * Custom CSS file to customize the HTML report
     * @parameter expression="src/test/resources/jgiven/custom.css"
     */
    private File customCssFile;

    /**
     * Custom JS file to customize the HTML report
     * @parameter expression="src/test/resources/jgiven/custom.js"
     */
    private File customJsFile;

    /**
     * The format of the generated report. Can be html or text
     * @parameter expression="html"
     */
    private String format;

    /**
     * The title of the generated report.
     * @parameter expression="JGiven Report"
     */
    private String title;

    /**
     * Whether or not to exclude empty scenarios, i.e. scenarios without any steps,
     * from the report
     * @parameter expression="false"
     */
    boolean excludeEmptyScenarios;

    @Override
    public void execute() throws MojoExecutionException {
        try {
            if( !outputDirectory.exists() && !outputDirectory.mkdirs() ) {
                throw new MojoExecutionException( "Error while trying to create output directory " + outputDirectory );
            }
            getLog().info( "JGiven HTML report source directory: " + sourceDirectory );
            getLog().info( "JGiven HTML report output directory: " + outputDirectory );
            if( customCssFile != null && customCssFile.exists() ) {
                getLog().info( "JGiven HTML report custom CSS file: " + customCssFile );
            }
            if( customJsFile != null && customJsFile.exists() ) {
                getLog().info( "JGiven HTML report custom JS file: " + customJsFile );
            }
            getLog().info( "Generating HTML reports to " + outputDirectory + "..." );
            ReportGenerator generator = new ReportGenerator();
            generator.setTargetDirectory( outputDirectory );
            generator.setSourceDirectory( sourceDirectory );
            generator.setFormat( ReportGenerator.Format.fromStringOrNull( format ) );
            generator.getConfig().setCustomCssFile( customCssFile );
            generator.getConfig().setCustomJsFile( customJsFile );
            generator.getConfig().setTitle( title );
            generator.getConfig().setExcludeEmptyScenarios( excludeEmptyScenarios );
            generator.generate();
            getLog().info( "-------------------------------------------------------------------" );
            getLog().info( "Generated JGiven HTML reports to directory " + outputDirectory );
            getLog().info( "-------------------------------------------------------------------" );
        } catch( Exception e ) {
            throw new MojoExecutionException( "Error while trying to generate HTML reports", e );
        }
    }
}