1 package org.apache.maven.plugins.surefire.report; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 import java.io.File; 23 import java.util.Locale; 24 import java.util.ResourceBundle; 25 import org.apache.maven.project.MavenProject; 26 27 28 /** 29 * Creates a nicely formatted Failsafe Test Report in html format. 30 * This goal does not run the tests, it only builds the reports. 31 * See <a href="http://jira.codehaus.org/browse/SUREFIRE-257">http://jira.codehaus.org/browse/SUREFIRE-257</a> 32 * 33 * @author Stephen Connolly 34 * @version $Id: FailsafeReportMojo.java 1205604 2011-11-23 21:17:54Z krosenvold $ 35 * @goal failsafe-report-only 36 * @execute phase="validate" lifecycle="surefire" 37 * @since 2.10 38 */ 39 public class FailsafeReportMojo 40 extends AbstractSurefireReportMojo 41 { 42 43 /** 44 * The filename to use for the report. 45 * 46 * @parameter expression="${outputName}" default-value="failsafe-report" 47 * @required 48 * @noinspection UnusedDeclaration 49 */ 50 private String outputName; 51 52 /** 53 * If set to true the failsafe report will be generated even when there are no failsafe result files. 54 * Defaults to <code>false</code> to preserve legacy behaviour pre 2.10 55 * 56 * @parameter expression="${alwaysGenerateFailsafeReport}" default-value="false" 57 * @noinspection UnusedDeclaration 58 * @since 2.11 59 */ 60 private boolean alwaysGenerateFailsafeReport; 61 62 /** 63 * If set to true the failsafe report generation will be skipped. 64 * 65 * @parameter expression="${skipFailsafeReport}" default-value="false" 66 * @noinspection UnusedDeclaration 67 * @since 2.11 68 */ 69 private boolean skipFailsafeReport; 70 71 protected File getSurefireReportsDirectory( MavenProject subProject ) 72 { 73 String buildDir = subProject.getBuild().getDirectory(); 74 return new File( buildDir + "/failsafe-reports" ); 75 } 76 77 public String getOutputName() 78 { 79 return outputName; 80 } 81 82 protected boolean isSkipped() 83 { 84 return skipFailsafeReport; 85 } 86 87 protected boolean isGeneratedWhenNoResults() 88 { 89 return alwaysGenerateFailsafeReport; 90 } 91 92 /** 93 * {@inheritDoc} 94 */ 95 public String getName( Locale locale ) 96 { 97 return getBundle( locale ).getString( "report.failsafe.name" ); 98 } 99 100 /** 101 * {@inheritDoc} 102 */ 103 public String getDescription( Locale locale ) 104 { 105 return getBundle( locale ).getString( "report.failsafe.description" ); 106 } 107 108 109 /* 110 * This is currently a copy of the getBundle() method of the AbstractSurefireReportMojo class, 111 * cause the failsafe report only different in two names for the bundles. 112 */ 113 private ResourceBundle getBundle( Locale locale ) 114 { 115 return ResourceBundle.getBundle( "surefire-report", locale, this.getClass().getClassLoader() ); 116 } 117 }