View Javadoc
1   package org.apache.maven.plugins.invoker;
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 org.apache.maven.plugin.MojoFailureException;
23  import org.apache.maven.plugins.annotations.LifecyclePhase;
24  import org.apache.maven.plugins.annotations.Mojo;
25  import org.apache.maven.plugins.annotations.Parameter;
26  import org.apache.maven.plugins.annotations.ResolutionScope;
27  
28  /**
29   * Searches for integration test Maven projects, and executes each, collecting a log in the project directory, and
30   * outputting the results to the command line.
31   *
32   * @since 1.0
33   * @author <a href="mailto:kenney@apache.org">Kenney Westerhof</a>
34   * @author <a href="mailto:jdcasey@apache.org">John Casey</a>
35   */
36  // CHECKSTYLE_OFF: LineLength
37  @Mojo( name = "run", defaultPhase = LifecyclePhase.INTEGRATION_TEST, requiresDependencyResolution = ResolutionScope.TEST, threadSafe = true )
38  // CHECKSTYLE_ON: LineLength
39  public class InvokerMojo
40      extends AbstractInvokerMojo
41  {
42  
43      /**
44       * A flag controlling whether failures of the sub builds should fail the main build, too. If set to
45       * <code>true</code>, the main build will proceed even if one or more sub builds failed.
46       *
47       * @since 1.3
48       */
49      @Parameter( property = "maven.test.failure.ignore", defaultValue = "false" )
50      private boolean ignoreFailures;
51  
52      /**
53       * Set this to <code>true</code> to cause a failure if there are no projects to invoke.
54       *
55       * @since 1.9
56       */
57      @Parameter( property = "invoker.failIfNoProjects" )
58      private Boolean failIfNoProjects;
59  
60      /**
61       * Set to <code>true</code> to output build.log to mojo log in case of failed jobs.
62       *
63       * @since 3.2.2
64       */
65      @Parameter( property = "invoker.streamLogsOnFailures", defaultValue = "false" )
66      private boolean streamLogsOnFailures;
67  
68      void processResults( InvokerSession invokerSession )
69          throws MojoFailureException
70      {
71          if ( streamLogsOnFailures )
72          {
73              invokerSession.logFailedBuildLog( getLog(), ignoreFailures );
74          }
75  
76          if ( !suppressSummaries )
77          {
78              invokerSession.logSummary( getLog(), ignoreFailures );
79          }
80  
81          invokerSession.handleFailures( getLog(), ignoreFailures );
82      }
83  
84      @Override
85      protected void doFailIfNoProjects()
86          throws MojoFailureException
87      {
88          if ( Boolean.TRUE.equals( failIfNoProjects ) )
89          {
90              throw new MojoFailureException( "No projects to invoke!" );
91          }
92      }
93  
94  }