/
JavadocJarTest.java
207 lines (177 loc) · 8.59 KB
/
JavadocJarTest.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
package org.apache.maven.plugins.javadoc;
/*
* 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 java.io.File;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import org.apache.maven.model.Plugin;
import org.apache.maven.plugin.MojoExecution;
import org.apache.maven.plugin.testing.AbstractMojoTestCase;
import org.apache.maven.plugin.testing.stubs.MavenProjectStub;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.languages.java.version.JavaVersion;
import org.codehaus.plexus.util.FileUtils;
/**
* @author <a href="mailto:oching@apache.org">Maria Odea Ching</a>
*/
public class JavadocJarTest
extends AbstractMojoTestCase
{
private JavadocJar lookupMojo( File testPom )
throws Exception
{
JavadocJar mojo = (JavadocJar) lookupMojo( "jar", testPom );
MojoExecution mojoExec = new MojoExecution( new Plugin(), "javadoc", null );
setVariableValueToObject( mojo, "mojo", mojoExec );
MavenProject currentProject = new MavenProjectStub();
currentProject.setGroupId( "GROUPID" );
currentProject.setArtifactId( "ARTIFACTID" );
setVariableValueToObject( mojo, "session", newMavenSession( currentProject ) );
return mojo;
}
/**
* Test when default configuration is provided
*
* @throws Exception if any
*/
public void testDefaultConfig()
throws Exception
{
File testPom =
new File( getBasedir(), "src/test/resources/unit/javadocjar-default/javadocjar-default-plugin-config.xml" );
JavadocJar mojo = lookupMojo( testPom );
mojo.execute();
//check if the javadoc jar file was generated
File generatedFile =
new File( getBasedir(), "target/test/unit/javadocjar-default/target/javadocjar-default-javadoc.jar" );
assertTrue( FileUtils.fileExists( generatedFile.getAbsolutePath() ) );
Set<String> set = new HashSet<>();
//validate contents of jar file
try ( ZipFile jar = new ZipFile( generatedFile ) )
{
for( Enumeration<? extends ZipEntry> entries = jar.entries(); entries.hasMoreElements(); )
{
ZipEntry entry = entries.nextElement();
set.add( entry.getName() );
}
}
assertTrue( set.contains( "stylesheet.css" ) );
JavaVersion javadocVersion = (JavaVersion) getVariableValueFromObject( mojo, "javadocRuntimeVersion" );
if ( javadocVersion.isBefore( "1.7" ) )
{
assertTrue( set.contains( "resources/inherit.gif" ) );
}
else if ( javadocVersion.isBefore( "1.8" ) )
{
assertTrue( set.contains( "resources/background.gif" ) /* JDK7 */);
}
else
{
// JDK8 has no resources anymore
assertFalse( set.contains( "resources" ) );
}
assertTrue( set.contains( "javadocjar/def/package-use.html" ) );
assertTrue( set.contains( "javadocjar/def/package-tree.html" ) );
assertTrue( set.contains( "javadocjar/def/package-summary.html" ) );
// package frame not generated anymore since Java 11
if ( JavaVersion.JAVA_SPECIFICATION_VERSION.isBefore( "11" ) )
{
assertTrue( set.contains( "javadocjar/def/package-frame.html" ) );
}
assertTrue( set.contains( "javadocjar/def/class-use/AppSample.html" ) );
assertTrue( set.contains( "index.html" ) );
assertTrue( set.contains( "javadocjar/def/App.html" ) );
assertTrue( set.contains( "javadocjar/def/AppSample.html" ) );
assertTrue( set.contains( "javadocjar/def/class-use/App.html" ) );
assertFalse( set.contains( AbstractJavadocMojo.ARGFILE_FILE_NAME ) );
assertFalse( set.contains( AbstractJavadocMojo.FILES_FILE_NAME ) );
assertFalse( set.contains( AbstractJavadocMojo.OPTIONS_FILE_NAME ) );
assertFalse( set.contains( AbstractJavadocMojo.PACKAGES_FILE_NAME ) );
//check if the javadoc files were created
generatedFile =
new File( getBasedir(), "target/test/unit/javadocjar-default/target/site/apidocs/javadocjar/def/App.html" );
assertTrue( FileUtils.fileExists( generatedFile.getAbsolutePath() ) );
generatedFile = new File( getBasedir(),
"target/test/unit/javadocjar-default/target/site/apidocs/javadocjar/def/AppSample.html" );
assertTrue( FileUtils.fileExists( generatedFile.getAbsolutePath() ) );
}
/**
* Test when the specified destDir parameter has an invalid value
*
* @throws Exception if any
*/
public void testInvalidDestdir()
throws Exception
{
File testPom = new File( getBasedir(),
"src/test/resources/unit/javadocjar-invalid-destdir/javadocjar-invalid-destdir-plugin-config.xml" );
JavadocJar mojo = lookupMojo( testPom );
mojo.execute();
//check if the javadoc jar file was generated
File generatedFile = new File( getBasedir(),
"target/test/unit/javadocjar-invalid-destdir/target/javadocjar-invalid-destdir-javadoc.jar" );
assertFalse( FileUtils.fileExists( generatedFile.getAbsolutePath() ) );
}
public void testContinueIfFailOnErrorIsFalse() throws Exception
{
File testPom =
new File( getBasedir(), "src/test/resources/unit/javadocjar-failonerror/javadocjar-failonerror-plugin-config.xml" );
JavadocJar mojo = lookupMojo( testPom );
mojo.execute();
//check if the javadoc jar file was generated
File generatedFile =
new File( getBasedir(), "target/test/unit/javadocjar-failonerror/target/javadocjar-failonerror-javadoc.jar" );
assertTrue( FileUtils.fileExists( generatedFile.getAbsolutePath() ) );
}
public void testIncludeMavenDescriptorWhenExplicitlyConfigured() throws Exception
{
File testPom =
new File( getBasedir(), "src/test/resources/unit/javadocjar-archive-config/javadocjar-archive-config.xml" );
JavadocJar mojo = lookupMojo( testPom );
mojo.execute();
//check if the javadoc jar file was generated
File generatedFile =
new File( getBasedir(), "target/test/unit/javadocjar-archive-config/target/javadocjar-archive-config-javadoc.jar" );
assertTrue( FileUtils.fileExists( generatedFile.getAbsolutePath() ) );
//validate contents of jar file
ZipFile jar = new ZipFile( generatedFile );
Set<String> set = new HashSet<>();
for (Enumeration<? extends ZipEntry> entries = jar.entries(); entries.hasMoreElements(); )
{
ZipEntry entry = entries.nextElement();
set.add( entry.getName() );
}
jar.close();
List<String> expected = new ArrayList<>();
expected.add( "META-INF/" );
expected.add( "META-INF/maven/" );
expected.add( "META-INF/maven/org.apache.maven.plugins.maven-javadoc-plugin.unit/" );
expected.add( "META-INF/maven/org.apache.maven.plugins.maven-javadoc-plugin.unit/javadocjar-archive-config/" );
expected.add( "META-INF/maven/org.apache.maven.plugins.maven-javadoc-plugin.unit/javadocjar-archive-config/pom.xml" );
expected.add( "META-INF/maven/org.apache.maven.plugins.maven-javadoc-plugin.unit/javadocjar-archive-config/pom.properties" );
for (String entry : expected) {
assertTrue("Expected jar to contain " + entry, set.contains(entry));
}
}
}