Skip to content

Clean up JavadocUtilTest #1210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 1, 2025
Merged

Clean up JavadocUtilTest #1210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7cb2271
Replace always pasing assert with actual assert
elharo Jun 26, 2025
0341b4d
more fixes
elharo Jun 27, 2025
7606305
spotless
elharo Jun 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ public abstract class AbstractFixJavadocMojo extends AbstractMojo {
/**
* The vm line separator
*/
private static final String EOL = System.getProperty("line.separator");
private static final String EOL = System.lineSeparator();

/**
* Tag name for @author *
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -885,9 +885,9 @@ protected static String readFile(final File javaFile, final String encoding) {
* splitPath( "C:/home;C:/tmp" ) = ["C:/home", "C:/tmp"]
* </pre>
*
* @param path which can contain multiple paths separated with a colon (<code>:</code>) or a semi-colon
* @param path which can contain multiple paths separated with a colon (<code>:</code>) or a semicolon
* (<code>;</code>), platform independent. Could be null.
* @return the path split by colon or semi-colon or <code>null</code> if path was <code>null</code>.
* @return the path split by colon or semicolon or <code>null</code> if path was <code>null</code>.
* @since 2.6.1
*/
protected static String[] splitPath(final String path) {
Expand All @@ -912,7 +912,7 @@ protected static String[] splitPath(final String path) {
* unifyPathSeparator( "/home:/tmp" ) = "/home;/tmp" (Windows box)
* </pre>
*
* @param path which can contain multiple paths by separating them with a colon (<code>:</code>) or a semi-colon
* @param path which can contain multiple paths by separating them with a colon (<code>:</code>) or a semicolon
* (<code>;</code>), platform independent. Could be null.
* @return the same path but separated with the current System path separator or <code>null</code> if path was
* <code>null</code>.
Expand Down
2 changes: 1 addition & 1 deletion src/test/java/org/apache/maven/plugins/javadoc/FixJavadocMojoTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
*/
public class FixJavadocMojoTest extends AbstractMojoTestCase {
/** The vm line separator */
private static final String EOL = System.getProperty("line.separator");
private static final String EOL = System.lineSeparator();

/** flag to copy repo only one time */
private static boolean testRepoCreated = false;
Expand Down
79 changes: 37 additions & 42 deletions src/test/java/org/apache/maven/plugins/javadoc/JavadocUtilTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
*/
package org.apache.maven.plugins.javadoc;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

Expand Down Expand Up @@ -113,17 +112,16 @@ public void testParseJavadocVersion() {
assertEquals("1.5.0", JavadocUtil.extractJavadocVersion(version));

// Other tests
version = "java full version \"1.5.0_07-164\"" + System.getProperty("line.separator");
version = "java full version \"1.5.0_07-164\"" + System.lineSeparator();
assertEquals("1.5.0", JavadocUtil.extractJavadocVersion(version));

version = System.getProperty("line.separator") + "java full version \"1.5.0_07-164\"";
version = System.lineSeparator() + "java full version \"1.5.0_07-164\"";
assertEquals("1.5.0", JavadocUtil.extractJavadocVersion(version));

version = System.getProperty("line.separator") + "java full version \"1.5.0_07-164\""
+ System.getProperty("line.separator");
version = System.lineSeparator() + "java full version \"1.5.0_07-164\"" + System.lineSeparator();
assertEquals("1.5.0", JavadocUtil.extractJavadocVersion(version));

version = "java full" + System.getProperty("line.separator") + " version \"1.5.0_07-164\"";
version = "java full" + System.lineSeparator() + " version \"1.5.0_07-164\"";
assertEquals("1.5.0", JavadocUtil.extractJavadocVersion(version));

version = "java full version \"1.99.123-b01\"";
Expand Down Expand Up @@ -186,64 +184,63 @@ public void testParseJavadocMemoryEmpty() {
*/
public void testParseJavadocMemory() {
String memory = "128";
assertEquals(JavadocUtil.parseJavadocMemory(memory), "128m");
assertEquals("128m", JavadocUtil.parseJavadocMemory(memory));

memory = "128k";
assertEquals(JavadocUtil.parseJavadocMemory(memory), "128k");
assertEquals("128k", JavadocUtil.parseJavadocMemory(memory));
memory = "128kb";
assertEquals(JavadocUtil.parseJavadocMemory(memory), "128k");
assertEquals("128k", JavadocUtil.parseJavadocMemory(memory));

memory = "128m";
assertEquals(JavadocUtil.parseJavadocMemory(memory), "128m");
assertEquals("128m", JavadocUtil.parseJavadocMemory(memory));
memory = "128mb";
assertEquals(JavadocUtil.parseJavadocMemory(memory), "128m");
assertEquals("128m", JavadocUtil.parseJavadocMemory(memory));

memory = "1g";
assertEquals(JavadocUtil.parseJavadocMemory(memory), "1024m");
assertEquals("1024m", JavadocUtil.parseJavadocMemory(memory));
memory = "1gb";
assertEquals(JavadocUtil.parseJavadocMemory(memory), "1024m");
assertEquals("1024m", JavadocUtil.parseJavadocMemory(memory));

memory = "1t";
assertEquals(JavadocUtil.parseJavadocMemory(memory), "1048576m");
assertEquals("1048576m", JavadocUtil.parseJavadocMemory(memory));
memory = "1tb";
assertEquals(JavadocUtil.parseJavadocMemory(memory), "1048576m");
assertEquals("1048576m", JavadocUtil.parseJavadocMemory(memory));

memory = System.getProperty("line.separator") + "128m";
assertEquals(JavadocUtil.parseJavadocMemory(memory), "128m");
memory = System.getProperty("line.separator") + "128m" + System.getProperty("line.separator");
assertEquals(JavadocUtil.parseJavadocMemory(memory), "128m");
memory = System.lineSeparator() + "128m";
assertEquals("128m", JavadocUtil.parseJavadocMemory(memory));
memory = System.lineSeparator() + "128m" + System.lineSeparator();
assertEquals("128m", JavadocUtil.parseJavadocMemory(memory));

memory = " 128m";
assertEquals(JavadocUtil.parseJavadocMemory(memory), "128m");
assertEquals("128m", JavadocUtil.parseJavadocMemory(memory));
memory = " 128m ";
assertEquals(JavadocUtil.parseJavadocMemory(memory), "128m");
assertEquals("128m", JavadocUtil.parseJavadocMemory(memory));

memory = "1m28m";
try {
JavadocUtil.parseJavadocMemory(memory);
fail("Not catch wrong pattern");
} catch (IllegalArgumentException e) {
assertTrue(true);
assertNotNull(e.getMessage());
}
memory = "ABC128m";
try {
JavadocUtil.parseJavadocMemory(memory);
fail("Not catch wrong pattern");
} catch (IllegalArgumentException e) {
assertTrue(true);
assertNotNull(e.getMessage());
}
}

/**
* Method to test the validate encoding parsing.
*
*/
public void testValidateEncoding() {
assertFalse("Not catch null", JavadocUtil.validateEncoding(null));
assertTrue("UTF-8 not supported on this plateform", JavadocUtil.validateEncoding("UTF-8"));
assertTrue("ISO-8859-1 not supported on this plateform", JavadocUtil.validateEncoding("ISO-8859-1"));
assertFalse("latin is supported on this plateform???", JavadocUtil.validateEncoding("latin"));
assertFalse("WRONG is supported on this plateform???", JavadocUtil.validateEncoding("WRONG"));
assertTrue("UTF-8 not supported on this platform", JavadocUtil.validateEncoding("UTF-8"));
assertTrue("ISO-8859-1 not supported on this platform", JavadocUtil.validateEncoding("ISO-8859-1"));
assertFalse("latin is supported on this platform???", JavadocUtil.validateEncoding("latin"));
assertFalse("WRONG is supported on this platform???", JavadocUtil.validateEncoding("WRONG"));
}

/**
Expand All @@ -261,7 +258,7 @@ public void testIsValidPackageList() throws Exception {
JavadocUtil.isValidPackageList(url, settings, false);
fail();
} catch (IllegalArgumentException e) {
assertTrue(true);
assertNotNull(e.getMessage());
}

url = new File(getBasedir(), "/pom.xml").toURI().toURL();
Expand All @@ -270,7 +267,7 @@ public void testIsValidPackageList() throws Exception {
try {
assertFalse(JavadocUtil.isValidPackageList(url, settings, true));
} catch (IOException e) {
assertTrue(true);
assertNotNull(e.getMessage());
}

url = this.getClass()
Expand All @@ -287,7 +284,7 @@ public void testIsValidPackageList() throws Exception {
JavadocUtil.isValidPackageList(wrongUrl, settings, false);
fail();
} catch (IOException e) {
assertTrue(true);
assertNotNull(e.getMessage());
}

// real proxy
Expand All @@ -300,7 +297,7 @@ public void testIsValidPackageList() throws Exception {
JavadocUtil.isValidPackageList(wrongUrl, settings, false);
fail();
} catch (IOException e) {
assertTrue(true);
assertNotNull(e.getMessage());
}
}

Expand All @@ -322,7 +319,7 @@ public void testIsValidPackageList() throws Exception {
JavadocUtil.isValidPackageList(url, settings, false);
fail();
} catch (FileNotFoundException e) {
assertTrue(true);
assertNotNull(e.getMessage());
}

// auth proxy
Expand All @@ -346,7 +343,7 @@ public void testIsValidPackageList() throws Exception {
JavadocUtil.isValidPackageList(wrongUrl, settings, false);
fail();
} catch (IOException e) {
assertTrue(true);
assertNotNull(e.getMessage());
}
}

Expand All @@ -368,7 +365,7 @@ public void testIsValidPackageList() throws Exception {
JavadocUtil.isValidPackageList(url, settings, true);
fail();
} catch (SocketTimeoutException e) {
assertTrue(true);
assertNotNull(e.getMessage());
}

// nonProxyHosts
Expand Down Expand Up @@ -412,7 +409,7 @@ public void testGetRedirectUrl() throws Exception {
@Override
public void handle(
String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response)
throws IOException, ServletException {
throws IOException {
response.setStatus(HttpServletResponse.SC_OK);
ByteArrayISO8859Writer writer = new ByteArrayISO8859Writer(100);
writer.write("<html>Hello world</html>");
Expand Down Expand Up @@ -456,7 +453,7 @@ public void testGetRedirectUrlWithNoRedirects() throws Exception {
@Override
public void handle(
String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response)
throws IOException, ServletException {
throws IOException {
response.setStatus(HttpServletResponse.SC_OK);
ByteArrayISO8859Writer writer = new ByteArrayISO8859Writer(100);
writer.write("<html>Hello world</html>");
Expand Down Expand Up @@ -492,7 +489,7 @@ public void testGetRedirectUrlVerifyHeaders() throws Exception {
@Override
public void handle(
String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response)
throws IOException, ServletException {
throws IOException {

if (request.getHeader("Accept") == null) {
response.setStatus(HttpServletResponse.SC_FORBIDDEN);
Expand Down Expand Up @@ -567,7 +564,6 @@ public void testCopyJavadocResources() throws Exception {

/**
* Method to test pruneDirs()
*
*/
public void testPruneDirs() {
List<String> list = new ArrayList<>();
Expand Down Expand Up @@ -612,7 +608,6 @@ public void testPrunePaths() {

/**
* Method to test unifyPathSeparator()
*
*/
public void testUnifyPathSeparator() {
assertNull(JavadocUtil.unifyPathSeparator(null));
Expand Down Expand Up @@ -668,7 +663,7 @@ private void stopSilently(Server server) {
}
}

public void testQuotedArgument() throws Exception {
public void testQuotedArgument() {

String value = " org.apache.uima.analysis_component:\n org.apache.uima.analysis_engine\n";

Expand All @@ -681,7 +676,7 @@ public void testQuotedArgument() throws Exception {
assertEquals("'org.apache.uima.analysis_component:org.apache.uima.analysis_engine'", arg);
}

public void testToList() throws Exception {
public void testToList() {
String value = " *.internal:org.acme.exclude1.*:\n org.acme.exclude2\n ";
List<String> values = JavadocUtil.toList(value);
assertThat(values).containsExactly("*.internal", "org.acme.exclude1.*", "org.acme.exclude2");
Expand Down