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 * @goal failsafe-report-only 35 * @execute phase="validate" lifecycle="surefire" 36 * @since 2.10 37 */ 38 public class FailsafeReportMojo 39 extends AbstractSurefireReportMojo 40 { 41 42 /** 43 * The filename to use for the report. 44 * 45 * @parameter expression="${outputName}" default-value="failsafe-report" 46 * @required 47 * @noinspection UnusedDeclaration 48 */ 49 private String outputName; 50 51 /** 52 * If set to true the failsafe report will be generated even when there are no failsafe result files. 53 * Defaults to <code>false</code> to preserve legacy behaviour pre 2.10 54 * 55 * @parameter expression="${alwaysGenerateFailsafeReport}" default-value="false" 56 * @noinspection UnusedDeclaration 57 * @since 2.11 58 */ 59 private boolean alwaysGenerateFailsafeReport; 60 61 /** 62 * If set to true the failsafe report generation will be skipped. 63 * 64 * @parameter expression="${skipFailsafeReport}" default-value="false" 65 * @noinspection UnusedDeclaration 66 * @since 2.11 67 */ 68 private boolean skipFailsafeReport; 69 70 protected File getSurefireReportsDirectory( MavenProject subProject ) 71 { 72 String buildDir = subProject.getBuild().getDirectory(); 73 return new File( buildDir + "/failsafe-reports" ); 74 } 75 76 public String getOutputName() 77 { 78 return outputName; 79 } 80 81 protected boolean isSkipped() 82 { 83 return skipFailsafeReport; 84 } 85 86 protected boolean isGeneratedWhenNoResults() 87 { 88 return alwaysGenerateFailsafeReport; 89 } 90 91 /** 92 * {@inheritDoc} 93 */ 94 public String getName( Locale locale ) 95 { 96 return getBundle( locale ).getString( "report.failsafe.name" ); 97 } 98 99 /** 100 * {@inheritDoc} 101 */ 102 public String getDescription( Locale locale ) 103 { 104 return getBundle( locale ).getString( "report.failsafe.description" ); 105 } 106 107 108 /* 109 * This is currently a copy of the getBundle() method of the AbstractSurefireReportMojo class, 110 * cause the failsafe report only different in two names for the bundles. 111 */ 112 private ResourceBundle getBundle( Locale locale ) 113 { 114 return ResourceBundle.getBundle( "surefire-report", locale, this.getClass().getClassLoader() ); 115 } 116 }