You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2021/01/31 20:36:55 UTC
[maven-javadoc-plugin] 06/06: (doc) misc tests improvements /
AssertJ / Java 16
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch next
in repository https://gitbox.apache.org/repos/asf/maven-javadoc-plugin.git
commit 907b2b82b32712128df5fa195f69bb97770b4790
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Sun Jan 31 21:36:13 2021 +0100
(doc) misc tests improvements / AssertJ / Java 16
---
pom.xml | 6 ++
.../plugins/javadoc/AbstractJavadocMojoTest.java | 3 +-
.../maven/plugins/javadoc/JavadocJarTest.java | 35 +++++------
.../maven/plugins/javadoc/JavadocReportTest.java | 3 +-
.../maven/plugins/javadoc/JavadocUtilTest.java | 71 +++++++++++-----------
.../maven/plugins/javadoc/JavadocVersionTest.java | 41 +++++++------
.../io/xpp3/JavadocOptionsXpp3ReaderTest.java | 16 ++---
7 files changed, 87 insertions(+), 88 deletions(-)
diff --git a/pom.xml b/pom.xml
index 5cb55f9..37af96f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -352,6 +352,12 @@ under the License.
<classifier>shaded</classifier>
<scope>test</scope>
</dependency>
+ <dependency>
+ <groupId>org.assertj</groupId>
+ <artifactId>assertj-core</artifactId>
+ <version>2.9.1</version>
+ <scope>test</scope>
+ </dependency>
</dependencies>
<build>
diff --git a/src/test/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojoTest.java b/src/test/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojoTest.java
index 1432492..c9b88ec 100644
--- a/src/test/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojoTest.java
+++ b/src/test/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojoTest.java
@@ -19,7 +19,7 @@ package org.apache.maven.plugins.javadoc;
* under the License.
*/
-import static org.mockito.Matchers.anyString;
+import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
@@ -31,7 +31,6 @@ import java.io.File;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.logging.Log;
-import org.apache.maven.plugins.javadoc.AbstractJavadocMojo;
import junit.framework.TestCase;
diff --git a/src/test/java/org/apache/maven/plugins/javadoc/JavadocJarTest.java b/src/test/java/org/apache/maven/plugins/javadoc/JavadocJarTest.java
index 900851c..eb46b6c 100644
--- a/src/test/java/org/apache/maven/plugins/javadoc/JavadocJarTest.java
+++ b/src/test/java/org/apache/maven/plugins/javadoc/JavadocJarTest.java
@@ -21,10 +21,8 @@ package org.apache.maven.plugins.javadoc;
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;
@@ -35,7 +33,8 @@ 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;
+
+import static org.assertj.core.api.Assertions.assertThat;
/**
* @author <a href="mailto:oching@apache.org">Maria Odea Ching</a>
@@ -79,7 +78,7 @@ public class JavadocJarTest
//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() ) );
+ assertThat( generatedFile ).exists();
Set<String> set = new HashSet<>();
@@ -131,11 +130,11 @@ public class JavadocJarTest
//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() ) );
+ assertThat(generatedFile).exists();
generatedFile = new File( getBasedir(),
"target/test/unit/javadocjar-default/target/site/apidocs/javadocjar/def/AppSample.html" );
- assertTrue( FileUtils.fileExists( generatedFile.getAbsolutePath() ) );
+ assertThat( generatedFile ).exists();
}
/**
@@ -154,7 +153,7 @@ public class JavadocJarTest
//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() ) );
+ assertThat( generatedFile ).doesNotExist();
}
public void testContinueIfFailOnErrorIsFalse() throws Exception
@@ -167,7 +166,7 @@ public class JavadocJarTest
//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() ) );
+ assertThat( generatedFile ).exists();
}
public void testIncludeMavenDescriptorWhenExplicitlyConfigured() throws Exception
@@ -180,7 +179,7 @@ public class JavadocJarTest
//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() ) );
+ assertThat( generatedFile ).exists();
//validate contents of jar file
ZipFile jar = new ZipFile( generatedFile );
@@ -192,16 +191,12 @@ public class JavadocJarTest
}
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));
- }
+ assertThat( set ).contains(
+ "META-INF/",
+ "META-INF/maven/",
+ "META-INF/maven/org.apache.maven.plugins.maven-javadoc-plugin.unit/",
+ "META-INF/maven/org.apache.maven.plugins.maven-javadoc-plugin.unit/javadocjar-archive-config/",
+ "META-INF/maven/org.apache.maven.plugins.maven-javadoc-plugin.unit/javadocjar-archive-config/pom.xml",
+ "META-INF/maven/org.apache.maven.plugins.maven-javadoc-plugin.unit/javadocjar-archive-config/pom.properties" );
}
}
diff --git a/src/test/java/org/apache/maven/plugins/javadoc/JavadocReportTest.java b/src/test/java/org/apache/maven/plugins/javadoc/JavadocReportTest.java
index 393e66e..de5073d 100644
--- a/src/test/java/org/apache/maven/plugins/javadoc/JavadocReportTest.java
+++ b/src/test/java/org/apache/maven/plugins/javadoc/JavadocReportTest.java
@@ -56,6 +56,7 @@ import org.apache.maven.settings.Settings;
import org.codehaus.plexus.languages.java.version.JavaVersion;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.StringUtils;
+import org.hamcrest.MatcherAssert;
import org.junit.AssumptionViolatedException;
import org.junit.Ignore;
import org.sonatype.aether.impl.internal.SimpleLocalRepositoryManager;
@@ -261,7 +262,7 @@ public class JavadocReportTest
assumeThat( connection.getURL().toString(), is( url ) );
// https://bugs.openjdk.java.net/browse/JDK-8216497
- assertThat( url + " available, but " + appHtml + " is missing link to java.lang.Object",
+ MatcherAssert.assertThat( url + " available, but " + appHtml + " is missing link to java.lang.Object",
FileUtils.fileRead( generatedFile, "UTF-8" ),
anyOf( containsString( "/docs/api/java/lang/Object.html" ),
containsString( "/docs/api/java.base/java/lang/Object.html" ) ) );
diff --git a/src/test/java/org/apache/maven/plugins/javadoc/JavadocUtilTest.java b/src/test/java/org/apache/maven/plugins/javadoc/JavadocUtilTest.java
index e3a00d1..55238ab 100644
--- a/src/test/java/org/apache/maven/plugins/javadoc/JavadocUtilTest.java
+++ b/src/test/java/org/apache/maven/plugins/javadoc/JavadocUtilTest.java
@@ -1,7 +1,5 @@
package org.apache.maven.plugins.javadoc;
-import static org.junit.Assert.assertArrayEquals;
-
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
@@ -43,7 +41,6 @@ import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
-import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.maven.plugin.testing.stubs.MavenProjectStub;
import org.apache.maven.plugins.javadoc.ProxyServer.AuthAsyncProxyServlet;
import org.apache.maven.settings.Proxy;
@@ -55,6 +52,8 @@ import org.mortbay.jetty.handler.AbstractHandler;
import org.mortbay.jetty.handler.MovedContextHandler;
import org.mortbay.util.ByteArrayISO8859Writer;
+import static org.assertj.core.api.Assertions.assertThat;
+
/**
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
*/
@@ -632,26 +631,30 @@ public class JavadocUtilTest
assertTrue( output.mkdirs() );
JavadocUtil.copyJavadocResources( output, input, null );
+ List<File> expectedFiles = new ArrayList<>();
+ expectedFiles.add( Paths.get( "test", "doc-files", "excluded-dir1", "sample-excluded1.gif" ).toFile() );
+ expectedFiles.add( Paths.get( "test", "doc-files", "excluded-dir2", "sample-excluded2.gif" ).toFile() );
+ expectedFiles.add( Paths.get( "test", "doc-files", "included-dir1", "sample-included1.gif" ).toFile() );
+ expectedFiles.add( Paths.get( "test", "doc-files", "included-dir2", "sample-included2.gif" ).toFile() );
+
+ assertEquals( expectedFiles, FileUtils.getFiles( output, null, null, false ) );
+ expectedFiles = new ArrayList<>();
+ expectedFiles.add( Paths.get( "test", "doc-files", "excluded-dir1", "sample-excluded1.gif" ).toFile() );
+ expectedFiles.add(
+ Paths.get( "test", "doc-files" + File.separator + "excluded-dir2", "sample-excluded2.gif" ).toFile() );
+ expectedFiles.add(
+ Paths.get( "test", "doc-files" + File.separator + "included-dir1", "sample-included1.gif" ).toFile() );
+ expectedFiles.add(
+ Paths.get( "test", "doc-files" + File.separator + "included-dir2", "sample-included2.gif" ).toFile() );
+ assertEquals( expectedFiles, FileUtils.getFiles( output, null, null, false ) );
List<String> expected = new ArrayList<>();
- expected.add( "test" + File.separator + "doc-files" + File.separator + "excluded-dir1" + File.separator
- + "sample-excluded1.gif" );
- expected.add( "test" + File.separator + "doc-files" + File.separator + "excluded-dir2" + File.separator
- + "sample-excluded2.gif" );
- expected.add( "test" + File.separator + "doc-files" + File.separator + "included-dir1" + File.separator
- + "sample-included1.gif" );
- expected.add( "test" + File.separator + "doc-files" + File.separator + "included-dir2" + File.separator
- + "sample-included2.gif" );
- assertTrue( EqualsBuilder.reflectionEquals( expected, FileUtils.getFiles( output, null, null, false ) ) );
- expected = new ArrayList<>();
expected.add( "" );
- expected.add( "test" + File.separator + "doc-files" + File.separator + "excluded-dir1" );
- expected.add( "test" + File.separator + "doc-files" + File.separator + "excluded-dir1" );
- expected.add( "test" + File.separator + "doc-files" + File.separator + "included-dir1" );
- expected.add( "test" + File.separator + "doc-files" + File.separator + "included-dir2" );
- assertTrue( EqualsBuilder.reflectionEquals( expected,
- FileUtils.getDirectoryNames( new File( output,
- "test/doc-files" ),
- null, null, false ) ) );
+ expected.add( "excluded-dir1" );
+ expected.add( "excluded-dir2" );
+ expected.add( "included-dir1" );
+ expected.add( "included-dir2" );
+ assertEquals( expected,
+ FileUtils.getDirectoryNames( new File( output, "test/doc-files" ), null, null, false ) );
input = new File( getBasedir(), "src/test/resources/unit/docfiles-test/docfiles/" );
assertTrue( input.exists() );
@@ -664,20 +667,16 @@ public class JavadocUtilTest
assertTrue( output.mkdirs() );
JavadocUtil.copyJavadocResources( output, input, "excluded-dir1:excluded-dir2" );
- expected = new ArrayList<>();
- expected.add( "test" + File.separator + "doc-files" + File.separator + "included-dir1" + File.separator
- + "sample-included1.gif" );
- expected.add( "test" + File.separator + "doc-files" + File.separator + "included-dir2" + File.separator
- + "sample-included2.gif" );
- assertTrue( EqualsBuilder.reflectionEquals( expected, FileUtils.getFiles( output, null, null, false ) ) );
+ expectedFiles = new ArrayList<>();
+ expectedFiles.add( Paths.get( "test", "doc-files", "included-dir1", "sample-included1.gif" ).toFile() );
+ expectedFiles.add( Paths.get( "test", "doc-files", "included-dir2", "sample-included2.gif" ).toFile() );
+ assertEquals( expectedFiles, FileUtils.getFiles( output, null, null, false ) );
expected = new ArrayList<>();
expected.add( "" );
- expected.add( "test" + File.separator + "doc-files" + File.separator + "included-dir1" );
- expected.add( "test" + File.separator + "doc-files" + File.separator + "included-dir2" );
- assertTrue( EqualsBuilder.reflectionEquals( expected,
- FileUtils.getDirectoryNames( new File( output,
- "test/doc-files" ),
- null, null, false ) ) );
+ expected.add( "included-dir1" );
+ expected.add( "included-dir2" );
+ assertEquals( expected,
+ FileUtils.getDirectoryNames( new File( output, "test/doc-files" ), null, null, false ) );
}
/**
@@ -704,10 +703,8 @@ public class JavadocUtilTest
/**
* Method to test unifyPathSeparator()
*
- * @throws Exception if any
*/
public void testUnifyPathSeparator()
- throws Exception
{
assertNull( JavadocUtil.unifyPathSeparator( null ) );
@@ -736,7 +733,7 @@ public class JavadocUtilTest
}
- public void testGetIncludedFiles() throws Exception
+ public void testGetIncludedFiles()
{
File sourceDirectory = new File("target/it").getAbsoluteFile();
String[] fileList = new String[] { "Main.java" };
@@ -744,7 +741,7 @@ public class JavadocUtilTest
List<String> includedFiles = JavadocUtil.getIncludedFiles( sourceDirectory, fileList, excludePackages );
- assertArrayEquals( fileList, includedFiles.toArray( new String[0] ) );
+ assertThat( includedFiles.toArray( new String[0] ) ).isEqualTo( fileList );
}
private void stopSilently( Server server )
diff --git a/src/test/java/org/apache/maven/plugins/javadoc/JavadocVersionTest.java b/src/test/java/org/apache/maven/plugins/javadoc/JavadocVersionTest.java
index 0f0bc23..ac63c24 100644
--- a/src/test/java/org/apache/maven/plugins/javadoc/JavadocVersionTest.java
+++ b/src/test/java/org/apache/maven/plugins/javadoc/JavadocVersionTest.java
@@ -19,50 +19,51 @@ package org.apache.maven.plugins.javadoc;
* under the License.
*/
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertTrue;
-
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.junit.Test;
+import static org.assertj.core.api.Assertions.assertThat;
+
public class JavadocVersionTest
{
/**
* Parsing is lazy, only triggered when comparing
*
- * @throws Exception
+ * @noinspection deprecation
*/
@Test
- public void testParse() throws Exception
+ public void testParse()
{
- assertTrue( JavadocVersion.parse( "1.4" ).compareTo( JavadocVersion.parse( "1.4.2" ) ) < 0 );
- assertTrue( JavadocVersion.parse( "1.4" ).compareTo( JavadocVersion.parse( "1.5" ) ) < 0 );
- assertTrue( JavadocVersion.parse( "1.8" ).compareTo( JavadocVersion.parse( "9" ) ) < 0 );
+ assertThat( JavadocVersion.parse( "1.4" ) )
+ .isLessThan( JavadocVersion.parse( "1.4.2" ) )
+ .isLessThan( JavadocVersion.parse( "1.5" ) );
+
+ assertThat( JavadocVersion.parse( "1.8" ) ).isLessThan( JavadocVersion.parse( "9" ) );
- assertEquals( 0, JavadocVersion.parse( "1.4" ).compareTo( JavadocVersion.parse( "1.4" ) ) );
- assertEquals( 0, JavadocVersion.parse( "1.4.2" ).compareTo( JavadocVersion.parse( "1.4.2" ) ) );
- assertEquals( 0, JavadocVersion.parse( "9" ).compareTo( JavadocVersion.parse( "9" ) ) );
+ assertThat( JavadocVersion.parse( "1.4" ) ).isEqualByComparingTo( JavadocVersion.parse( "1.4" ) );
+ assertThat( JavadocVersion.parse( "1.4.2" ) ).isEqualByComparingTo( JavadocVersion.parse( "1.4.2" ) );
+ assertThat( JavadocVersion.parse( "9" ) ).isEqualByComparingTo( JavadocVersion.parse( "9" ) );
- assertTrue( JavadocVersion.parse( "1.4.2" ).compareTo( JavadocVersion.parse( "1.4" ) ) > 0 );
- assertTrue( JavadocVersion.parse( "1.5" ).compareTo( JavadocVersion.parse( "1.4" ) ) > 0 );
- assertTrue( JavadocVersion.parse( "9" ).compareTo( JavadocVersion.parse( "1.8" ) ) > 0 );
+ assertThat( JavadocVersion.parse( "1.4.2" ) ).isGreaterThan( JavadocVersion.parse( "1.4" ) );
+ assertThat( JavadocVersion.parse( "1.5" ) ).isGreaterThan( JavadocVersion.parse( "1.4" ) );
+ assertThat( JavadocVersion.parse( "9" ) ).isGreaterThan( JavadocVersion.parse( "1.8" ) );
}
@Test
public void testApiVersion() {
Pattern p = Pattern.compile( "(1\\.\\d|\\d\\d*)" );
Matcher m = p.matcher( "9" );
- assertTrue(m.find());
- assertEquals( "9", m.group( 1 ));
+ assertThat( m.find() ).isTrue();
+ assertThat( m.group( 1 ) ).isEqualTo( "9" );
m = p.matcher( "1.4" );
- assertTrue(m.find());
- assertEquals( "1.4", m.group( 1 ));
+ assertThat( m.find() ).isTrue();
+ assertThat( m.group( 1 ) ).isEqualTo( "1.4" );
m = p.matcher( "1.4.2" );
- assertTrue(m.find());
- assertEquals( "1.4", m.group( 1 ));
+ assertThat( m.find() ).isTrue();
+ assertThat( m.group( 1 ) ).isEqualTo( "1.4" );
}
}
diff --git a/src/test/java/org/apache/maven/plugins/javadoc/options/io/xpp3/JavadocOptionsXpp3ReaderTest.java b/src/test/java/org/apache/maven/plugins/javadoc/options/io/xpp3/JavadocOptionsXpp3ReaderTest.java
index 1966492..118b26a 100644
--- a/src/test/java/org/apache/maven/plugins/javadoc/options/io/xpp3/JavadocOptionsXpp3ReaderTest.java
+++ b/src/test/java/org/apache/maven/plugins/javadoc/options/io/xpp3/JavadocOptionsXpp3ReaderTest.java
@@ -19,14 +19,14 @@ package org.apache.maven.plugins.javadoc.options.io.xpp3;
* under the License.
*/
-import static org.junit.Assert.assertEquals;
-
import java.io.StringReader;
import org.apache.maven.plugins.javadoc.options.JavadocOptions;
import org.apache.maven.plugins.javadoc.options.Tag;
import org.junit.Test;
+import static org.assertj.core.api.Assertions.assertThat;
+
public class JavadocOptionsXpp3ReaderTest
{
@@ -37,10 +37,10 @@ public class JavadocOptionsXpp3ReaderTest
StringReader reader = new StringReader(testString);
JavadocOptions options = parser.read(reader);
- assertEquals(1, options.getTags().size());
+ assertThat( options.getTags().size() ).isEqualTo( 1 );
Tag tag = options.getTags().get(0);
- assertEquals("foo", tag.getName());
- assertEquals("bar", tag.getHead());
+ assertThat( tag.getName() ).isEqualTo( "foo" );
+ assertThat( tag.getHead() ).isEqualTo( "bar" );
}
@Test
@@ -50,10 +50,10 @@ public class JavadocOptionsXpp3ReaderTest
StringReader reader = new StringReader(testString);
JavadocOptions options = parser.read(reader);
- assertEquals(1, options.getTags().size());
+ assertThat( options.getTags().size() ).isEqualTo( 1 );
Tag tag = options.getTags().get(0);
- assertEquals("foo", tag.getName());
- assertEquals("Xaoptcmf", tag.getPlacement());
+ assertThat( tag.getName() ).isEqualTo( "foo" );
+ assertThat( tag.getPlacement() ).isEqualTo( "Xaoptcmf" );
}
}