org.apache.maven.plugin.cxx.XUnitMojo.java Source code

Introduction

Here is the source code for org.apache.maven.plugin.cxx.XUnitMojo.java

Source

package org.apache.maven.plugin.cxx;

/*
 * Copyright (C) 2011-2016, Neticoa SAS France - Tous droits rservs.
 * Author(s) : Franck Bonin, Neticoa SAS France
 *
 * 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.
 *
 */

import java.io.DataOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.Properties;

import org.apache.commons.exec.CommandLine;
import org.apache.commons.exec.Executor;
import org.apache.maven.plugin.MojoExecutionException;

import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

/**
 * Goal which launch unit test using a custom command.
 * This mojo just tell programmer where to produce xUnit reports
 *
 * @author Franck Bonin 
 */
@Mojo(name = "xunit", defaultPhase = LifecyclePhase.TEST)
public class XUnitMojo extends LaunchMojo {
    /**
     * The Report OutputFile Location.
     * 
     * @since 0.0.4
     */
    @Parameter(property = "xunit.reportsfilePath", defaultValue = "xunit-reports")
    private File reportsfileDir;

    @Override
    protected void preExecute(Executor exec, CommandLine commandLine, Properties enviro)
            throws MojoExecutionException {
        // this
        String outputReportDir = new String();
        if (reportsfileDir.isAbsolute()) {
            outputReportDir = reportsfileDir.getAbsolutePath();
        } else {
            outputReportDir = basedir.getAbsolutePath() + "/" + reportsfileDir.getPath();
        }
        new File(outputReportDir).mkdirs();
        getLog().info("You shall produce a xUnit report called \"" + outputReportDir + File.separator
                + "xunit-result-*.xml\" within this xunit goal");
        File file = new File(outputReportDir + "/Readme.txt");
        try {
            DataOutputStream out = new DataOutputStream(new FileOutputStream(file));
            out.writeBytes(
                    "You shall produce xUnit reports called \"xunit-result-*.xml\" within this directory.\n");
        } catch (IOException e) {
            getLog().info("Could not write to " + outputReportDir + File.separator + "Readme.txt");
        }
    }

    /**
     * The Xunit Legacy Skip feature.
     * 
     * @since 0.0.5
     */
    @Parameter(property = "xunit.skiptests", defaultValue = "false")
    private boolean skiptests;

    /**
     * Set this to "true" to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite
     * convenient on occasion.
     *
     * @since 0.0.5
     */
    @Parameter(property = "skipTests", defaultValue = "false")
    protected boolean skipTests;

    /**
     * Set this to "true" to bypass unit tests entirely. Its use is NOT RECOMMENDED, especially if you enable
     * it using the "maven.test.skip" property, because maven.test.skip shall disables both running the tests
     * and compiling the tests. Consider using the <code>skipTests</code> parameter instead.
     *
     * @since 0.0.5
     */
    @Parameter(property = "maven.test.skip", defaultValue = "false")
    protected boolean skip;

    protected boolean isSkip() {
        return super.isSkip() || skiptests || skipTests || skip;
    }
}