package org.apache.maven.plugin.invoker;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.invoker.model.io.xpp3.BuildJobXpp3Reader;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.codehaus.plexus.util.ReaderFactory;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import java.io.File;
import java.io.IOException;
/**
* Checks the results of maven-invoker-plugin based integration tests and fails the build if any tests failed.
*
* @author Olivier Lamy
* @since 1.4
*/
@Mojo( name = "verify", defaultPhase = LifecyclePhase.VERIFY, threadSafe = true )
public class VerifyMojo
extends AbstractMojo
{
/**
* Flag used to suppress certain invocations. This is useful in tailoring the build using profiles.
*
* @since 1.1
*/
@Parameter( property = "invoker.skip", defaultValue = "false" )
private boolean skipInvocation;
/**
* Base directory where all build reports are read from.
*
* @since 1.4
*/
@Parameter( property = "invoker.reportsDirectory", defaultValue = "${project.build.directory}/invoker-reports" )
private File reportsDirectory;
/**
* A flag controlling whether failures of the sub builds should fail the main build, too. If set to
* <code>true</code>, the main build will proceed even if one or more sub builds failed.
*
* @since 1.3
*/
@Parameter( property = "maven.test.failure.ignore", defaultValue = "false" )
private boolean ignoreFailures;
/**
* Flag used to suppress the summary output notifying of successes and failures. If set to <code>true</code>, the
* only indication of the build's success or failure will be the effect it has on the main build (if it fails, the
* main build should fail as well).
*/
@Parameter( defaultValue = "false" )
private boolean suppressSummaries;
/**
* Invokes Maven on the configured test projects.
*
* @throws org.apache.maven.plugin.MojoExecutionException If the goal encountered severe errors.
* @throws org.apache.maven.plugin.MojoFailureException If any of the Maven builds failed.
*/
public void execute()
throws MojoExecutionException, MojoFailureException
{
if ( skipInvocation )
{
getLog().info( "Skipping invocation per configuration."
+ " If this is incorrect, ensure the skipInvocation parameter is not set to true." );
return;
}
File[] reportFiles = ReportUtils.getReportFiles( reportsDirectory );
if ( reportFiles.length <= 0 )
{
getLog().info( "No invoker report files found, nothing to check." );
return;
}
InvokerSession invokerSession = new InvokerSession();
for ( int i = 0, size = reportFiles.length; i < size; i++ )
{
File reportFile = reportFiles[i];
try
{
BuildJobXpp3Reader reader = new BuildJobXpp3Reader();
invokerSession.addJob( reader.read( ReaderFactory.newXmlReader( reportFile ) ) );
}
catch ( XmlPullParserException e )
{
throw new MojoExecutionException( "Failed to parse report file: " + reportFile, e );
}
catch ( IOException e )
{
throw new MojoExecutionException( "Failed to read report file: " + reportFile, e );
}
}
if ( !suppressSummaries )
{
invokerSession.logSummary( getLog(), ignoreFailures );
}
invokerSession.handleFailures( getLog(), ignoreFailures );
}
}