View Javadoc
1   package org.apache.maven.plugin.javadoc;
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.artifact.Artifact;
23  import org.apache.maven.artifact.resolver.ArtifactResolutionResult;
24  import org.apache.maven.plugin.javadoc.resolver.SourceResolverConfig;
25  import org.apache.maven.plugins.annotations.LifecyclePhase;
26  import org.apache.maven.plugins.annotations.Mojo;
27  import org.apache.maven.plugins.annotations.Parameter;
28  import org.apache.maven.plugins.annotations.ResolutionScope;
29  import org.apache.maven.project.MavenProject;
30  import org.codehaus.plexus.util.StringUtils;
31  
32  import java.io.File;
33  import java.util.ArrayList;
34  import java.util.Collections;
35  import java.util.List;
36  
37  /**
38   * Bundles the Javadoc documentation for <code>test Java code</code> in an <b>NON aggregator</b> project into
39   * a jar using the standard <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/">Javadoc Tool</a>.
40   *
41   * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
42   * @version $Id: TestJavadocJar.html 922314 2014-09-15 20:18:14Z dennisl $
43   * @since 2.5
44   */
45  @Mojo( name = "test-jar", defaultPhase = LifecyclePhase.PACKAGE, requiresDependencyResolution = ResolutionScope.TEST, threadSafe = true)
46  public class TestJavadocJar
47      extends JavadocJar
48  {
49      // ----------------------------------------------------------------------
50      // Javadoc Options (should be inline with Javadoc options defined in TestJavadocReport)
51      // ----------------------------------------------------------------------
52  
53      /**
54       * Specifies the destination directory where Javadoc saves the generated HTML files.
55       * <br/>
56       * See <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#d">d</a>.
57       * <br/>
58       */
59      @Parameter( defaultValue = "${project.build.directory}/testapidocs", required = true )
60      private File outputDirectory;
61  
62      /**
63       * Specifies the Test title to be placed near the top of the overview summary file.
64       * <br/>
65       * See <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#doctitle">doctitle</a>.
66       * <br/>
67       *
68       * @since 2.5
69       */
70      @Parameter( property = "testDoctitle", alias = "doctitle",
71                  defaultValue = "${project.name} ${project.version} Test API" )
72      private String testDoctitle;
73  
74      /**
75       * Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file
76       * specified by path/filename and place it on the Overview page (overview-summary.html).
77       * <br/>
78       * See <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#overview">overview</a>.
79       * <br/>
80       *
81       * @since 2.5
82       */
83      @Parameter( property = "testOverview", alias = "overview",
84                  defaultValue = "${basedir}/src/test/javadoc/overview.html" )
85      private File testOverview;
86  
87      /**
88       * Specifies the Test title to be placed in the HTML title tag.
89       * <br/>
90       * See <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#windowtitle">windowtitle</a>.
91       * <br/>
92       *
93       * @since 2.5
94       */
95      @Parameter( property = "testWindowtitle", alias = "windowtitle",
96                  defaultValue = "${project.name} ${project.version} Test API" )
97      private String testWindowtitle;
98  
99      // ----------------------------------------------------------------------
100     // Mojo Parameters (should be inline with options defined in TestJavadocReport)
101     // ----------------------------------------------------------------------
102 
103     /**
104      * Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
105      *
106      * @since 2.5
107      */
108     @Parameter( alias = "javadocDirectory", defaultValue = "${basedir}/src/test/javadoc" )
109     private File testJavadocDirectory;
110 
111     /**
112      * @since 2.10
113      */
114     @Parameter( property = "maven.javadoc.testClassifier", defaultValue = "test-javadoc", required = true )
115     private String testClassifier;
116 
117     // ----------------------------------------------------------------------
118     // Protected methods
119     // ----------------------------------------------------------------------
120 
121     @Override
122     protected String getClassifier()
123     {
124         return testClassifier;
125     }
126 
127     // ----------------------------------------------------------------------
128     // Important Note: should be inline with methods defined in TestJavadocReport
129     // ----------------------------------------------------------------------
130 
131     @Override
132     protected String getOutputDirectory()
133     {
134         return outputDirectory.getAbsoluteFile().toString();
135     }
136 
137     @Override
138     protected File getJavadocDirectory()
139     {
140         return testJavadocDirectory;
141     }
142 
143     @Override
144     protected String getDoctitle()
145     {
146         return testDoctitle;
147     }
148 
149     @Override
150     protected File getOverview()
151     {
152         return testOverview;
153     }
154 
155     @Override
156     protected String getWindowtitle()
157     {
158         return testWindowtitle;
159     }
160 
161     @Override
162     protected List<String> getProjectBuildOutputDirs( MavenProject p )
163     {
164         List<String> dirs = new ArrayList<String>();
165         if ( StringUtils.isNotEmpty( p.getBuild().getOutputDirectory() ) )
166         {
167             dirs.add( p.getBuild().getOutputDirectory() );
168         }
169         if ( StringUtils.isNotEmpty( p.getBuild().getTestOutputDirectory() ) )
170         {
171             dirs.add( p.getBuild().getTestOutputDirectory() );
172         }
173 
174         return dirs;
175     }
176 
177     @Override
178     protected List<String> getProjectSourceRoots( MavenProject p )
179     {
180         if ( "pom".equals( p.getPackaging().toLowerCase() ) )
181         {
182             return Collections.emptyList();
183         }
184 
185         return p.getTestCompileSourceRoots();
186     }
187 
188     @Override
189     protected List<String> getExecutionProjectSourceRoots( MavenProject p )
190     {
191         if ( "pom".equals( p.getExecutionProject().getPackaging().toLowerCase() ) )
192         {
193             return Collections.emptyList();
194         }
195 
196         return p.getExecutionProject().getTestCompileSourceRoots();
197     }
198 
199     @Override
200     protected List<Artifact> getProjectArtifacts( MavenProject p )
201     {
202         return p.getTestArtifacts();
203     }
204 
205     @Override
206     protected List<Artifact> getCompileArtifacts( ArtifactResolutionResult result )
207     {
208         return JavadocUtil.getCompileArtifacts( result.getArtifacts(), true );
209     }
210     
211     /**
212      * Overriden to enable the resolution of -test-sources jar files.
213      * 
214      * {@inheritDoc}
215      */
216     @Override
217     protected SourceResolverConfig configureDependencySourceResolution( final SourceResolverConfig config )
218     {
219         return super.configureDependencySourceResolution( config ).withoutCompileSources().withTestSources();
220     }
221 }