From 0cda5255d62a83f99e4571c71823a06d9c3b5be5 Mon Sep 17 00:00:00 2001 From: Reto Weiss Date: Fri, 19 Jul 2019 10:25:32 +0200 Subject: [PATCH 1/6] MJAVADOC-617 Normalize module path so that '..' in the path are resolved On line 2403 a path is removed from a map. The given path may not be normalized but the pathes in the map are. This leads to the fact that the project for the given path is not found. And therefore no javadoc for the project is generated. By normalizing the module path on line 2396 the code works event if the module path has '..' in it. --- .../org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java index cb68f865..e782acc0 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java @@ -2393,7 +2393,7 @@ private Set modulesForAggregatedProject( MavenProject aggregatedPr List modulePaths = new LinkedList<>(); for ( String module : aggregatedProject.getModules() ) { - modulePaths.add( new File( aggregatedProject.getBasedir(), module ).toPath() ); + modulePaths.add( new File( aggregatedProject.getBasedir(), module ).toPath().normalize() ); } Set aggregatedModules = new LinkedHashSet<>(); From 5f6d44c48a83b1fcef4013e674fff038b6728487 Mon Sep 17 00:00:00 2001 From: Reto Weiss Date: Mon, 30 Mar 2020 17:19:59 +0200 Subject: [PATCH 2/6] MJAVADOC-617 Add regression test --- .../javadoc/AggregatorJavadocReportTest.java | 36 ++++++-- ...SubFolderProject1TestMavenProjectStub.java | 79 +++++++++++++++++ ...SubFolderProject2TestMavenProjectStub.java | 79 +++++++++++++++++ ...ateNotInSubFolderTestMavenProjectStub.java | 86 +++++++++++++++++++ .../all/pom.xml | 63 ++++++++++++++ .../project1/pom.xml | 31 +++++++ .../project1/src/main/java/test1/Hello.java | 26 ++++++ .../project2/pom.xml | 32 +++++++ .../project2/src/main/java/test2/World.java | 26 ++++++ 9 files changed, 449 insertions(+), 9 deletions(-) create mode 100644 src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject1TestMavenProjectStub.java create mode 100644 src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject2TestMavenProjectStub.java create mode 100644 src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderTestMavenProjectStub.java create mode 100644 src/test/resources/unit/aggregate-modules-not-in-subfolders-test/all/pom.xml create mode 100644 src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/pom.xml create mode 100644 src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/src/main/java/test1/Hello.java create mode 100644 src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/pom.xml create mode 100644 src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/src/main/java/test2/World.java diff --git a/src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java b/src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java index 1bfad67b..4a00affe 100644 --- a/src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java +++ b/src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java @@ -232,15 +232,7 @@ public void testAggregateJavadocResources() File apidocs = new File( getBasedir(), "target/test/unit/aggregate-resources-test/target/site/apidocs" ); // Test overview - File overviewSummary; - if ( JavaVersion.JAVA_SPECIFICATION_VERSION.isBefore( "11" ) ) - { - overviewSummary = new File( apidocs, "overview-summary.html" ); - } - else - { - overviewSummary = new File( apidocs, "index.html" ); - } + File overviewSummary = getOverviewSummary(apidocs); assertTrue( overviewSummary.exists() ); String overview = readFile( overviewSummary ).toLowerCase(); @@ -257,4 +249,30 @@ public void testAggregateJavadocResources() assertTrue( overview.contains( "\"Maven\"" ) ); assertTrue( new File( apidocs, "resources/test/doc-files/maven-feather.png" ).exists() ); } + + public void testAggregateWithModulsNotInSubFolders() throws Exception + { + File testPom = new File( unit, "aggregate-modules-not-in-subfolders-test/all/pom.xml"); + JavadocReport mojo = lookupMojo( testPom ); + mojo.execute(); + + File apidocs = new File( getBasedir(), "target/test/unit/aggregate-modules-not-in-subfolders-test/target/site/apidocs" ); + assertTrue(apidocs.exists()); + assertTrue( getOverviewSummary(apidocs).exists() ); + } + + private File getOverviewSummary(File apidocs) + { + File overviewSummary; + if ( JavaVersion.JAVA_SPECIFICATION_VERSION.isBefore( "11" ) ) + { + overviewSummary = new File( apidocs, "overview-summary.html" ); + } + else + { + overviewSummary = new File( apidocs, "index.html" ); + } + return overviewSummary; + } + } diff --git a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject1TestMavenProjectStub.java b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject1TestMavenProjectStub.java new file mode 100644 index 00000000..2536e5dc --- /dev/null +++ b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject1TestMavenProjectStub.java @@ -0,0 +1,79 @@ +package org.apache.maven.plugins.javadoc.stubs; + +/* + * 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.List; +import java.util.Objects; + +import org.apache.maven.artifact.Artifact; +import org.apache.maven.model.Build; +import org.apache.maven.plugin.testing.stubs.MavenProjectStub; +import org.apache.maven.project.MavenProject; + +/** + * @author Vincent Siveton + */ +public class AggregateNotInSubFolderProject1TestMavenProjectStub + extends MavenProjectStub +{ + public AggregateNotInSubFolderProject1TestMavenProjectStub() + { + readModel( new File( getBasedir(), "pom.xml" ) ); + + setGroupId( Objects.toString( getModel().getGroupId(), getModel().getParent().getGroupId() ) ); + setArtifactId( getModel().getArtifactId() ); + setVersion( Objects.toString( getModel().getVersion(), getModel().getParent().getVersion() ) ); + setName( getModel().getName() ); + setUrl( getModel().getUrl() ); + setPackaging( getModel().getPackaging() ); + + setExecutionRoot( true ); + + Artifact artifact = new JavadocPluginArtifactStub( getGroupId(), getArtifactId(), getVersion(), getPackaging() ); + artifact.setArtifactHandler( new DefaultArtifactHandlerStub() ); + setArtifact( artifact ); + + Build build = new Build(); + build.setFinalName( getModel().getArtifactId() ); + build.setSourceDirectory( getBasedir() + "/src/main/java" ); + build.setDirectory( super.getBasedir() + "/target/test/unit/aggregate-modules-not-in-subfolders-test/project1/target" ); + setBuild( build ); + + List compileSourceRoots = new ArrayList<>(); + compileSourceRoots.add( getBasedir().getAbsolutePath() + "/src/main/java" ); + setCompileSourceRoots( compileSourceRoots ); + } + + /** {@inheritDoc} */ + @Override + public File getBasedir() + { + return new File( super.getBasedir() + "/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1" ); + } + + /** {@inheritDoc} */ + @Override + public MavenProject getExecutionProject() + { + return this; + } +} diff --git a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject2TestMavenProjectStub.java b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject2TestMavenProjectStub.java new file mode 100644 index 00000000..c78ec11b --- /dev/null +++ b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject2TestMavenProjectStub.java @@ -0,0 +1,79 @@ +package org.apache.maven.plugins.javadoc.stubs; + +/* + * 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.List; +import java.util.Objects; + +import org.apache.maven.artifact.Artifact; +import org.apache.maven.model.Build; +import org.apache.maven.plugin.testing.stubs.MavenProjectStub; +import org.apache.maven.project.MavenProject; + +/** + * @author Vincent Siveton + */ +public class AggregateNotInSubFolderProject2TestMavenProjectStub + extends MavenProjectStub +{ + public AggregateNotInSubFolderProject2TestMavenProjectStub() + { + readModel( new File( getBasedir(), "pom.xml" ) ); + + setGroupId( Objects.toString( getModel().getGroupId(), getModel().getParent().getGroupId() ) ); + setArtifactId( getModel().getArtifactId() ); + setVersion( Objects.toString( getModel().getVersion(), getModel().getParent().getVersion() ) ); + setName( getModel().getName() ); + setUrl( getModel().getUrl() ); + setPackaging( getModel().getPackaging() ); + + setExecutionRoot( true ); + + Artifact artifact = new JavadocPluginArtifactStub( getGroupId(), getArtifactId(), getVersion(), getPackaging() ); + artifact.setArtifactHandler( new DefaultArtifactHandlerStub() ); + setArtifact( artifact ); + + Build build = new Build(); + build.setFinalName( getModel().getArtifactId() ); + build.setSourceDirectory( getBasedir() + "/src/main/java" ); + build.setDirectory( super.getBasedir() + "/target/test/unit/aggregate-modules-not-in-subfolders-test/project2/target" ); + setBuild( build ); + + List compileSourceRoots = new ArrayList<>(); + compileSourceRoots.add( getBasedir() + "/src/main/java" ); + setCompileSourceRoots( compileSourceRoots ); + } + + /** {@inheritDoc} */ + @Override + public File getBasedir() + { + return new File( super.getBasedir() + "/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2" ); + } + + /** {@inheritDoc} */ + @Override + public MavenProject getExecutionProject() + { + return this; + } +} diff --git a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderTestMavenProjectStub.java b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderTestMavenProjectStub.java new file mode 100644 index 00000000..1ce32417 --- /dev/null +++ b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderTestMavenProjectStub.java @@ -0,0 +1,86 @@ +package org.apache.maven.plugins.javadoc.stubs; + +/* + * 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.Arrays; +import java.util.Collections; +import java.util.List; +import java.util.Set; + +import org.apache.maven.artifact.Artifact; +import org.apache.maven.model.Build; +import org.apache.maven.plugin.testing.stubs.MavenProjectStub; +import org.apache.maven.project.MavenProject; + +/** + * @author Vincent Siveton + */ +public class AggregateNotInSubFolderTestMavenProjectStub + extends MavenProjectStub +{ + public AggregateNotInSubFolderTestMavenProjectStub() + { + readModel( new File( getBasedir(), "pom.xml" ) ); + + setGroupId( getModel().getGroupId() ); + setArtifactId( getModel().getArtifactId() ); + setVersion( getModel().getVersion() ); + setName( getModel().getName() ); + setUrl( getModel().getUrl() ); + setPackaging( getModel().getPackaging() ); + + setExecutionRoot( true ); + + Build build = new Build(); + build.setFinalName( getModel().getArtifactId() ); + build.setSourceDirectory( getBasedir() + "/src/main/java" ); + build.setDirectory( super.getBasedir() + "/target/test/unit/aggregate-modules-not-in-subfolders-test/target" ); + setBuild( build ); + + List compileSourceRoots = new ArrayList<>(); + setCompileSourceRoots( compileSourceRoots ); + } + + @Override + public File getBasedir() + { + return new File( super.getBasedir() + "/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/all" ); + } + + @Override + public MavenProject getExecutionProject() + { + return this; + } + + @Override + public List getModules() + { + return Arrays.asList( "../project1", "../project2" ); + } + + @Override + public Set getDependencyArtifacts() + { + return Collections.emptySet(); + } +} diff --git a/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/all/pom.xml b/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/all/pom.xml new file mode 100644 index 00000000..6cbef91b --- /dev/null +++ b/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/all/pom.xml @@ -0,0 +1,63 @@ + + + 4.0.0 + + org.apache.maven.plugins.maven-javadoc-plugin.unit + aggregate-modules-not-in-subfolders-test-resources-test + 1.0-SNAPSHOT + pom + + + ../project1 + ../project2 + + + + + org.apache.maven.plugins + maven-javadoc-plugin + + ISO-8859-1 + + ${localRepository} + ${basedir}/target/test/unit/aggregate-modules-not-in-subfolders-test/target/site/apidocs + ${basedir}/target/test/unit/aggregate-modules-not-in-subfolders-test/target/javadoc-bundle-options + Maven Javadoc Plugin aggregate resources 1.0-SNAPSHOT API + + + + + + + protected + + + true + ${basedir}/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/src/main/javadoc + true + true + java + true + + + + + diff --git a/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/pom.xml b/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/pom.xml new file mode 100644 index 00000000..0350abc8 --- /dev/null +++ b/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/pom.xml @@ -0,0 +1,31 @@ + + + 4.0.0 + + org.apache.maven.plugins.maven-javadoc-plugin.unit + aggregate-modules-not-in-subfolders-test-resources-test + 1.0-SNAPSHOT + + org.apache.maven.plugins.maven-javadoc-plugin.unit + aggregate-modules-not-in-subfolders-test-resources-test-project1 + 1.0-SNAPSHOT + jar + diff --git a/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/src/main/java/test1/Hello.java b/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/src/main/java/test1/Hello.java new file mode 100644 index 00000000..03e60cf4 --- /dev/null +++ b/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/src/main/java/test1/Hello.java @@ -0,0 +1,26 @@ +package test1; + +/* + * 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. + */ + +/** + * This is Hello + */ +public class Hello +{} \ No newline at end of file diff --git a/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/pom.xml b/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/pom.xml new file mode 100644 index 00000000..7b847b5a --- /dev/null +++ b/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/pom.xml @@ -0,0 +1,32 @@ + + + 4.0.0 + + + org.apache.maven.plugins.maven-javadoc-plugin.unit + aggregate-modules-not-in-subfolders-test-resources-test + 1.0-SNAPSHOT + + org.apache.maven.plugins.maven-javadoc-plugin.unit + aggregate-modules-not-in-subfolders-test-resources-test-project2 + 1.0-SNAPSHOT + jar + diff --git a/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/src/main/java/test2/World.java b/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/src/main/java/test2/World.java new file mode 100644 index 00000000..55808d81 --- /dev/null +++ b/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/src/main/java/test2/World.java @@ -0,0 +1,26 @@ +package test2; + +/* + * 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. + */ + +/** + * This is World + */ +public class World +{} \ No newline at end of file From 437d736ec0e5ad4e1fb510ff5bbfa312973a32fd Mon Sep 17 00:00:00 2001 From: Reto Weiss Date: Mon, 30 Mar 2020 17:20:50 +0200 Subject: [PATCH 3/6] MJAVADOC-617 Simplify code as suggested by review --- .../plugins/javadoc/AbstractJavadocMojo.java | 83 ++++++++++--------- 1 file changed, 42 insertions(+), 41 deletions(-) diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java index e782acc0..2608345f 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java @@ -1,5 +1,43 @@ package org.apache.maven.plugins.javadoc; +import static org.apache.maven.plugins.javadoc.JavadocUtil.isEmpty; +import static org.apache.maven.plugins.javadoc.JavadocUtil.isNotEmpty; +import static org.apache.maven.plugins.javadoc.JavadocUtil.toList; +import static org.apache.maven.plugins.javadoc.JavadocUtil.toRelative; + +import java.io.File; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.io.InputStream; +import java.io.Writer; +import java.lang.reflect.Method; +import java.net.MalformedURLException; +import java.net.URI; +import java.net.URISyntaxException; +import java.net.URL; +import java.net.URLClassLoader; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.StandardCopyOption; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Calendar; +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.HashSet; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.LinkedList; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Properties; +import java.util.Set; +import java.util.StringTokenizer; + /* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file @@ -61,19 +99,19 @@ import org.apache.maven.reporting.MavenReportException; import org.apache.maven.settings.Proxy; import org.apache.maven.settings.Settings; -import org.apache.maven.shared.transfer.artifact.DefaultArtifactCoordinate; import org.apache.maven.shared.artifact.filter.resolve.AndFilter; import org.apache.maven.shared.artifact.filter.resolve.PatternExclusionsFilter; import org.apache.maven.shared.artifact.filter.resolve.PatternInclusionsFilter; import org.apache.maven.shared.artifact.filter.resolve.ScopeFilter; import org.apache.maven.shared.artifact.filter.resolve.TransformableFilter; +import org.apache.maven.shared.invoker.MavenInvocationException; +import org.apache.maven.shared.transfer.artifact.DefaultArtifactCoordinate; import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver; import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolverException; import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResult; import org.apache.maven.shared.transfer.dependencies.DefaultDependableCoordinate; import org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver; import org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolverException; -import org.apache.maven.shared.invoker.MavenInvocationException; import org.apache.maven.toolchain.Toolchain; import org.apache.maven.toolchain.ToolchainManager; import org.apache.maven.wagon.PathUtils; @@ -101,44 +139,6 @@ import org.codehaus.plexus.util.cli.Commandline; import org.codehaus.plexus.util.xml.Xpp3Dom; -import java.io.File; -import java.io.FileNotFoundException; -import java.io.IOException; -import java.io.InputStream; -import java.io.Writer; -import java.lang.reflect.Method; -import java.net.MalformedURLException; -import java.net.URI; -import java.net.URISyntaxException; -import java.net.URL; -import java.net.URLClassLoader; -import java.nio.charset.StandardCharsets; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.StandardCopyOption; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Calendar; -import java.util.Collection; -import java.util.Collections; -import java.util.HashMap; -import java.util.HashSet; -import java.util.LinkedHashMap; -import java.util.LinkedHashSet; -import java.util.LinkedList; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.Map.Entry; -import java.util.Properties; -import java.util.Set; -import java.util.StringTokenizer; - -import static org.apache.maven.plugins.javadoc.JavadocUtil.toRelative; -import static org.apache.maven.plugins.javadoc.JavadocUtil.toList; -import static org.apache.maven.plugins.javadoc.JavadocUtil.isEmpty; -import static org.apache.maven.plugins.javadoc.JavadocUtil.isNotEmpty; - /** * Base class with majority of Javadoc functionalities. * @@ -2390,10 +2390,11 @@ private Set modulesForAggregatedProject( MavenProject aggregatedPr return Collections.singleton( aggregatedProject ); } + Path basePath = aggregatedProject.getBasedir().toPath(); List modulePaths = new LinkedList<>(); for ( String module : aggregatedProject.getModules() ) { - modulePaths.add( new File( aggregatedProject.getBasedir(), module ).toPath().normalize() ); + modulePaths.add( basePath.resolve(module).normalize() ); } Set aggregatedModules = new LinkedHashSet<>(); From 0faa68960d8fd200331af029ae2a8a7f7bb51500 Mon Sep 17 00:00:00 2001 From: Reto Weiss Date: Mon, 30 Mar 2020 17:31:04 +0200 Subject: [PATCH 4/6] MJAVADOC-617 Fix checkstyle problems --- .../plugins/javadoc/AbstractJavadocMojo.java | 82 +++++++++---------- .../project1/src/main/java/test1/Hello.java | 2 +- .../project2/src/main/java/test2/World.java | 2 +- 3 files changed, 43 insertions(+), 43 deletions(-) diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java index 2608345f..b659ea79 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java @@ -1,43 +1,5 @@ package org.apache.maven.plugins.javadoc; -import static org.apache.maven.plugins.javadoc.JavadocUtil.isEmpty; -import static org.apache.maven.plugins.javadoc.JavadocUtil.isNotEmpty; -import static org.apache.maven.plugins.javadoc.JavadocUtil.toList; -import static org.apache.maven.plugins.javadoc.JavadocUtil.toRelative; - -import java.io.File; -import java.io.FileNotFoundException; -import java.io.IOException; -import java.io.InputStream; -import java.io.Writer; -import java.lang.reflect.Method; -import java.net.MalformedURLException; -import java.net.URI; -import java.net.URISyntaxException; -import java.net.URL; -import java.net.URLClassLoader; -import java.nio.charset.StandardCharsets; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.StandardCopyOption; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Calendar; -import java.util.Collection; -import java.util.Collections; -import java.util.HashMap; -import java.util.HashSet; -import java.util.LinkedHashMap; -import java.util.LinkedHashSet; -import java.util.LinkedList; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.Map.Entry; -import java.util.Properties; -import java.util.Set; -import java.util.StringTokenizer; - /* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file @@ -99,19 +61,19 @@ import org.apache.maven.reporting.MavenReportException; import org.apache.maven.settings.Proxy; import org.apache.maven.settings.Settings; +import org.apache.maven.shared.transfer.artifact.DefaultArtifactCoordinate; import org.apache.maven.shared.artifact.filter.resolve.AndFilter; import org.apache.maven.shared.artifact.filter.resolve.PatternExclusionsFilter; import org.apache.maven.shared.artifact.filter.resolve.PatternInclusionsFilter; import org.apache.maven.shared.artifact.filter.resolve.ScopeFilter; import org.apache.maven.shared.artifact.filter.resolve.TransformableFilter; -import org.apache.maven.shared.invoker.MavenInvocationException; -import org.apache.maven.shared.transfer.artifact.DefaultArtifactCoordinate; import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver; import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolverException; import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResult; import org.apache.maven.shared.transfer.dependencies.DefaultDependableCoordinate; import org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver; import org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolverException; +import org.apache.maven.shared.invoker.MavenInvocationException; import org.apache.maven.toolchain.Toolchain; import org.apache.maven.toolchain.ToolchainManager; import org.apache.maven.wagon.PathUtils; @@ -139,6 +101,44 @@ import org.codehaus.plexus.util.cli.Commandline; import org.codehaus.plexus.util.xml.Xpp3Dom; +import java.io.File; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.io.InputStream; +import java.io.Writer; +import java.lang.reflect.Method; +import java.net.MalformedURLException; +import java.net.URI; +import java.net.URISyntaxException; +import java.net.URL; +import java.net.URLClassLoader; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.StandardCopyOption; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Calendar; +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.HashSet; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.LinkedList; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Properties; +import java.util.Set; +import java.util.StringTokenizer; + +import static org.apache.maven.plugins.javadoc.JavadocUtil.toRelative; +import static org.apache.maven.plugins.javadoc.JavadocUtil.toList; +import static org.apache.maven.plugins.javadoc.JavadocUtil.isEmpty; +import static org.apache.maven.plugins.javadoc.JavadocUtil.isNotEmpty; + /** * Base class with majority of Javadoc functionalities. * @@ -2394,7 +2394,7 @@ private Set modulesForAggregatedProject( MavenProject aggregatedPr List modulePaths = new LinkedList<>(); for ( String module : aggregatedProject.getModules() ) { - modulePaths.add( basePath.resolve(module).normalize() ); + modulePaths.add( basePath.resolve( module ).normalize() ); } Set aggregatedModules = new LinkedHashSet<>(); diff --git a/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/src/main/java/test1/Hello.java b/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/src/main/java/test1/Hello.java index 03e60cf4..646e04da 100644 --- a/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/src/main/java/test1/Hello.java +++ b/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/src/main/java/test1/Hello.java @@ -23,4 +23,4 @@ * This is Hello */ public class Hello -{} \ No newline at end of file +{} diff --git a/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/src/main/java/test2/World.java b/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/src/main/java/test2/World.java index 55808d81..a001109d 100644 --- a/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/src/main/java/test2/World.java +++ b/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/src/main/java/test2/World.java @@ -23,4 +23,4 @@ * This is World */ public class World -{} \ No newline at end of file +{} From 793f6f7be5974c18a142979cbb251026ea0d4768 Mon Sep 17 00:00:00 2001 From: Reto Weiss Date: Wed, 1 Apr 2020 10:26:01 +0200 Subject: [PATCH 5/6] MJAVADOC-617 Refactor duplicated code into abstract sub classes - Refactor duplicated code into common new AbstractAggregateMavenProjectStub and AbstractAggregateChildMavenProjectStub classes - Fix toLowerCase without Locale - Simplify method getOverviewSummary and make it static --- .../javadoc/AggregatorJavadocReportTest.java | 18 ++-- ...bstractAggregateChildMavenProjectStub.java | 82 +++++++++++++++++ .../AbstractAggregateMavenProjectStub.java | 90 +++++++++++++++++++ ...SubFolderProject1TestMavenProjectStub.java | 55 ++---------- ...SubFolderProject2TestMavenProjectStub.java | 55 ++---------- ...ateNotInSubFolderTestMavenProjectStub.java | 64 ++----------- ...ResourcesProject1TestMavenProjectStub.java | 55 ++---------- ...ResourcesProject2TestMavenProjectStub.java | 55 ++---------- ...ggregateResourcesTestMavenProjectStub.java | 64 ++----------- 9 files changed, 213 insertions(+), 325 deletions(-) create mode 100644 src/test/java/org/apache/maven/plugins/javadoc/stubs/AbstractAggregateChildMavenProjectStub.java create mode 100644 src/test/java/org/apache/maven/plugins/javadoc/stubs/AbstractAggregateMavenProjectStub.java diff --git a/src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java b/src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java index 4a00affe..90ac1e18 100644 --- a/src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java +++ b/src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java @@ -24,6 +24,7 @@ import java.io.FileReader; import java.io.IOException; import java.util.List; +import java.util.Locale; import org.apache.maven.execution.MavenSession; import org.apache.maven.model.Plugin; @@ -235,7 +236,7 @@ public void testAggregateJavadocResources() File overviewSummary = getOverviewSummary(apidocs); assertTrue( overviewSummary.exists() ); - String overview = readFile( overviewSummary ).toLowerCase(); + String overview = readFile( overviewSummary ).toLowerCase( Locale.ENGLISH ); assertTrue( overview.contains( "resources.test" ) ); assertTrue( overview.contains( ">blablaresources.test2" ) ); @@ -257,22 +258,17 @@ public void testAggregateWithModulsNotInSubFolders() throws Exception mojo.execute(); File apidocs = new File( getBasedir(), "target/test/unit/aggregate-modules-not-in-subfolders-test/target/site/apidocs" ); - assertTrue(apidocs.exists()); - assertTrue( getOverviewSummary(apidocs).exists() ); + assertTrue( apidocs.exists() ); + assertTrue( getOverviewSummary( apidocs ).exists() ); } - private File getOverviewSummary(File apidocs) + private static File getOverviewSummary(File apidocs) { - File overviewSummary; if ( JavaVersion.JAVA_SPECIFICATION_VERSION.isBefore( "11" ) ) { - overviewSummary = new File( apidocs, "overview-summary.html" ); + return new File( apidocs, "overview-summary.html" ); } - else - { - overviewSummary = new File( apidocs, "index.html" ); - } - return overviewSummary; + return new File( apidocs, "index.html" ); } } diff --git a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AbstractAggregateChildMavenProjectStub.java b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AbstractAggregateChildMavenProjectStub.java new file mode 100644 index 00000000..d384294f --- /dev/null +++ b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AbstractAggregateChildMavenProjectStub.java @@ -0,0 +1,82 @@ +package org.apache.maven.plugins.javadoc.stubs; + +/* + * 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.List; +import java.util.Objects; + +import org.apache.maven.artifact.Artifact; +import org.apache.maven.model.Build; +import org.apache.maven.plugin.testing.stubs.MavenProjectStub; +import org.apache.maven.project.MavenProject; + +/** + * @author Reto Weiss + */ +public class AbstractAggregateChildMavenProjectStub + extends MavenProjectStub +{ + private String baseDir; + + public AbstractAggregateChildMavenProjectStub(String baseDir, String pomFileName, String targetDirectory) + { + this.baseDir = baseDir; + readModel( new File( getBasedir(), pomFileName ) ); + + setGroupId( Objects.toString( getModel().getGroupId(), getModel().getParent().getGroupId() ) ); + setArtifactId( getModel().getArtifactId() ); + setVersion( Objects.toString( getModel().getVersion(), getModel().getParent().getVersion() ) ); + setName( getModel().getName() ); + setUrl( getModel().getUrl() ); + setPackaging( getModel().getPackaging() ); + + setExecutionRoot( true ); + + Artifact artifact = new JavadocPluginArtifactStub( getGroupId(), getArtifactId(), getVersion(), getPackaging() ); + artifact.setArtifactHandler( new DefaultArtifactHandlerStub() ); + setArtifact( artifact ); + + Build build = new Build(); + build.setFinalName( getModel().getArtifactId() ); + build.setSourceDirectory( getBasedir() + "/src/main/java" ); + build.setDirectory( super.getBasedir() + targetDirectory ); + setBuild( build ); + + List compileSourceRoots = new ArrayList<>(); + compileSourceRoots.add( getBasedir().getAbsolutePath() + "/src/main/java" ); + setCompileSourceRoots( compileSourceRoots ); + } + + /** {@inheritDoc} */ + @Override + public File getBasedir() + { + return new File( super.getBasedir() + baseDir ); + } + + /** {@inheritDoc} */ + @Override + public MavenProject getExecutionProject() + { + return this; + } +} diff --git a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AbstractAggregateMavenProjectStub.java b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AbstractAggregateMavenProjectStub.java new file mode 100644 index 00000000..759daaba --- /dev/null +++ b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AbstractAggregateMavenProjectStub.java @@ -0,0 +1,90 @@ +package org.apache.maven.plugins.javadoc.stubs; + +/* + * 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.Arrays; +import java.util.Collections; +import java.util.List; +import java.util.Set; + +import org.apache.maven.artifact.Artifact; +import org.apache.maven.model.Build; +import org.apache.maven.plugin.testing.stubs.MavenProjectStub; +import org.apache.maven.project.MavenProject; + +/** + * @author Reto Weiss + */ +public class AbstractAggregateMavenProjectStub + extends MavenProjectStub +{ + private final String baseDir; + private final String[] projects; + public AbstractAggregateMavenProjectStub(String baseDir, String pomFileName, String targetDirectory, String... projects) + { + this.baseDir = baseDir; + this.projects = projects; + readModel( new File( getBasedir(), pomFileName) ); + + setGroupId( getModel().getGroupId() ); + setArtifactId( getModel().getArtifactId() ); + setVersion( getModel().getVersion() ); + setName( getModel().getName() ); + setUrl( getModel().getUrl() ); + setPackaging( getModel().getPackaging() ); + + setExecutionRoot( true ); + + Build build = new Build(); + build.setFinalName( getModel().getArtifactId() ); + build.setSourceDirectory( getBasedir() + "/src/main/java" ); + build.setDirectory( super.getBasedir() + targetDirectory ); + setBuild( build ); + + List compileSourceRoots = new ArrayList<>(); + setCompileSourceRoots( compileSourceRoots ); + } + + @Override + public File getBasedir() + { + return new File( super.getBasedir() + baseDir); + } + + @Override + public MavenProject getExecutionProject() + { + return this; + } + + @Override + public List getModules() + { + return Arrays.asList( projects ); + } + + @Override + public Set getDependencyArtifacts() + { + return Collections.emptySet(); + } +} diff --git a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject1TestMavenProjectStub.java b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject1TestMavenProjectStub.java index 2536e5dc..2c3be01b 100644 --- a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject1TestMavenProjectStub.java +++ b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject1TestMavenProjectStub.java @@ -19,61 +19,16 @@ * under the License. */ -import java.io.File; -import java.util.ArrayList; -import java.util.List; -import java.util.Objects; - -import org.apache.maven.artifact.Artifact; -import org.apache.maven.model.Build; -import org.apache.maven.plugin.testing.stubs.MavenProjectStub; -import org.apache.maven.project.MavenProject; - /** - * @author Vincent Siveton + * @author Reto Weiss */ public class AggregateNotInSubFolderProject1TestMavenProjectStub - extends MavenProjectStub + extends AbstractAggregateChildMavenProjectStub { public AggregateNotInSubFolderProject1TestMavenProjectStub() { - readModel( new File( getBasedir(), "pom.xml" ) ); - - setGroupId( Objects.toString( getModel().getGroupId(), getModel().getParent().getGroupId() ) ); - setArtifactId( getModel().getArtifactId() ); - setVersion( Objects.toString( getModel().getVersion(), getModel().getParent().getVersion() ) ); - setName( getModel().getName() ); - setUrl( getModel().getUrl() ); - setPackaging( getModel().getPackaging() ); - - setExecutionRoot( true ); - - Artifact artifact = new JavadocPluginArtifactStub( getGroupId(), getArtifactId(), getVersion(), getPackaging() ); - artifact.setArtifactHandler( new DefaultArtifactHandlerStub() ); - setArtifact( artifact ); - - Build build = new Build(); - build.setFinalName( getModel().getArtifactId() ); - build.setSourceDirectory( getBasedir() + "/src/main/java" ); - build.setDirectory( super.getBasedir() + "/target/test/unit/aggregate-modules-not-in-subfolders-test/project1/target" ); - setBuild( build ); - - List compileSourceRoots = new ArrayList<>(); - compileSourceRoots.add( getBasedir().getAbsolutePath() + "/src/main/java" ); - setCompileSourceRoots( compileSourceRoots ); - } - - /** {@inheritDoc} */ - @Override - public File getBasedir() - { - return new File( super.getBasedir() + "/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1" ); - } - - /** {@inheritDoc} */ - @Override - public MavenProject getExecutionProject() - { - return this; + super( "/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1", + "pom.xml", + "/target/test/unit/aggregate-modules-not-in-subfolders-test/project1/target" ); } } diff --git a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject2TestMavenProjectStub.java b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject2TestMavenProjectStub.java index c78ec11b..4a47343c 100644 --- a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject2TestMavenProjectStub.java +++ b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject2TestMavenProjectStub.java @@ -19,61 +19,16 @@ * under the License. */ -import java.io.File; -import java.util.ArrayList; -import java.util.List; -import java.util.Objects; - -import org.apache.maven.artifact.Artifact; -import org.apache.maven.model.Build; -import org.apache.maven.plugin.testing.stubs.MavenProjectStub; -import org.apache.maven.project.MavenProject; - /** - * @author Vincent Siveton + * @author Reto Weiss */ public class AggregateNotInSubFolderProject2TestMavenProjectStub - extends MavenProjectStub + extends AbstractAggregateChildMavenProjectStub { public AggregateNotInSubFolderProject2TestMavenProjectStub() { - readModel( new File( getBasedir(), "pom.xml" ) ); - - setGroupId( Objects.toString( getModel().getGroupId(), getModel().getParent().getGroupId() ) ); - setArtifactId( getModel().getArtifactId() ); - setVersion( Objects.toString( getModel().getVersion(), getModel().getParent().getVersion() ) ); - setName( getModel().getName() ); - setUrl( getModel().getUrl() ); - setPackaging( getModel().getPackaging() ); - - setExecutionRoot( true ); - - Artifact artifact = new JavadocPluginArtifactStub( getGroupId(), getArtifactId(), getVersion(), getPackaging() ); - artifact.setArtifactHandler( new DefaultArtifactHandlerStub() ); - setArtifact( artifact ); - - Build build = new Build(); - build.setFinalName( getModel().getArtifactId() ); - build.setSourceDirectory( getBasedir() + "/src/main/java" ); - build.setDirectory( super.getBasedir() + "/target/test/unit/aggregate-modules-not-in-subfolders-test/project2/target" ); - setBuild( build ); - - List compileSourceRoots = new ArrayList<>(); - compileSourceRoots.add( getBasedir() + "/src/main/java" ); - setCompileSourceRoots( compileSourceRoots ); - } - - /** {@inheritDoc} */ - @Override - public File getBasedir() - { - return new File( super.getBasedir() + "/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2" ); - } - - /** {@inheritDoc} */ - @Override - public MavenProject getExecutionProject() - { - return this; + super( "/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2", + "pom.xml", + "/target/test/unit/aggregate-modules-not-in-subfolders-test/project2/target"); } } diff --git a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderTestMavenProjectStub.java b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderTestMavenProjectStub.java index 1ce32417..1ac9d9be 100644 --- a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderTestMavenProjectStub.java +++ b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderTestMavenProjectStub.java @@ -19,68 +19,18 @@ * under the License. */ -import java.io.File; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.List; -import java.util.Set; - -import org.apache.maven.artifact.Artifact; -import org.apache.maven.model.Build; -import org.apache.maven.plugin.testing.stubs.MavenProjectStub; -import org.apache.maven.project.MavenProject; - /** - * @author Vincent Siveton + * @author Reto Weiss */ public class AggregateNotInSubFolderTestMavenProjectStub - extends MavenProjectStub + extends AbstractAggregateMavenProjectStub { public AggregateNotInSubFolderTestMavenProjectStub() { - readModel( new File( getBasedir(), "pom.xml" ) ); - - setGroupId( getModel().getGroupId() ); - setArtifactId( getModel().getArtifactId() ); - setVersion( getModel().getVersion() ); - setName( getModel().getName() ); - setUrl( getModel().getUrl() ); - setPackaging( getModel().getPackaging() ); - - setExecutionRoot( true ); - - Build build = new Build(); - build.setFinalName( getModel().getArtifactId() ); - build.setSourceDirectory( getBasedir() + "/src/main/java" ); - build.setDirectory( super.getBasedir() + "/target/test/unit/aggregate-modules-not-in-subfolders-test/target" ); - setBuild( build ); - - List compileSourceRoots = new ArrayList<>(); - setCompileSourceRoots( compileSourceRoots ); - } - - @Override - public File getBasedir() - { - return new File( super.getBasedir() + "/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/all" ); - } - - @Override - public MavenProject getExecutionProject() - { - return this; - } - - @Override - public List getModules() - { - return Arrays.asList( "../project1", "../project2" ); - } - - @Override - public Set getDependencyArtifacts() - { - return Collections.emptySet(); + super( "/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/all", + "pom.xml", + "/target/test/unit/aggregate-modules-not-in-subfolders-test/target", + "../project1", + "../project2"); } } diff --git a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateResourcesProject1TestMavenProjectStub.java b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateResourcesProject1TestMavenProjectStub.java index 71657c10..d1e9de72 100644 --- a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateResourcesProject1TestMavenProjectStub.java +++ b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateResourcesProject1TestMavenProjectStub.java @@ -19,61 +19,16 @@ * under the License. */ -import java.io.File; -import java.util.ArrayList; -import java.util.List; -import java.util.Objects; - -import org.apache.maven.artifact.Artifact; -import org.apache.maven.model.Build; -import org.apache.maven.plugin.testing.stubs.MavenProjectStub; -import org.apache.maven.project.MavenProject; - /** - * @author Vincent Siveton + * @author Reto Weiss */ public class AggregateResourcesProject1TestMavenProjectStub - extends MavenProjectStub + extends AbstractAggregateChildMavenProjectStub { public AggregateResourcesProject1TestMavenProjectStub() { - readModel( new File( getBasedir(), "pom.xml" ) ); - - setGroupId( Objects.toString( getModel().getGroupId(), getModel().getParent().getGroupId() ) ); - setArtifactId( getModel().getArtifactId() ); - setVersion( Objects.toString( getModel().getVersion(), getModel().getParent().getVersion() ) ); - setName( getModel().getName() ); - setUrl( getModel().getUrl() ); - setPackaging( getModel().getPackaging() ); - - setExecutionRoot( true ); - - Artifact artifact = new JavadocPluginArtifactStub( getGroupId(), getArtifactId(), getVersion(), getPackaging() ); - artifact.setArtifactHandler( new DefaultArtifactHandlerStub() ); - setArtifact( artifact ); - - Build build = new Build(); - build.setFinalName( getModel().getArtifactId() ); - build.setSourceDirectory( getBasedir() + "/src/main/java" ); - build.setDirectory( super.getBasedir() + "/target/test/unit/aggregate-resources-test/project1/target" ); - setBuild( build ); - - List compileSourceRoots = new ArrayList<>(); - compileSourceRoots.add( getBasedir().getAbsolutePath() + "/src/main/java" ); - setCompileSourceRoots( compileSourceRoots ); - } - - /** {@inheritDoc} */ - @Override - public File getBasedir() - { - return new File( super.getBasedir() + "/src/test/resources/unit/aggregate-resources-test/project1" ); - } - - /** {@inheritDoc} */ - @Override - public MavenProject getExecutionProject() - { - return this; + super( "/src/test/resources/unit/aggregate-resources-test/project1", + "pom.xml", + "/target/test/unit/aggregate-resources-test/project1/target" ); } } diff --git a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateResourcesProject2TestMavenProjectStub.java b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateResourcesProject2TestMavenProjectStub.java index 58a164ce..ee45b9f7 100644 --- a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateResourcesProject2TestMavenProjectStub.java +++ b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateResourcesProject2TestMavenProjectStub.java @@ -19,61 +19,16 @@ * under the License. */ -import java.io.File; -import java.util.ArrayList; -import java.util.List; -import java.util.Objects; - -import org.apache.maven.artifact.Artifact; -import org.apache.maven.model.Build; -import org.apache.maven.plugin.testing.stubs.MavenProjectStub; -import org.apache.maven.project.MavenProject; - /** - * @author Vincent Siveton + * @author Reto Weiss */ public class AggregateResourcesProject2TestMavenProjectStub - extends MavenProjectStub + extends AbstractAggregateChildMavenProjectStub { public AggregateResourcesProject2TestMavenProjectStub() { - readModel( new File( getBasedir(), "pom.xml" ) ); - - setGroupId( Objects.toString( getModel().getGroupId(), getModel().getParent().getGroupId() ) ); - setArtifactId( getModel().getArtifactId() ); - setVersion( Objects.toString( getModel().getVersion(), getModel().getParent().getVersion() ) ); - setName( getModel().getName() ); - setUrl( getModel().getUrl() ); - setPackaging( getModel().getPackaging() ); - - setExecutionRoot( true ); - - Artifact artifact = new JavadocPluginArtifactStub( getGroupId(), getArtifactId(), getVersion(), getPackaging() ); - artifact.setArtifactHandler( new DefaultArtifactHandlerStub() ); - setArtifact( artifact ); - - Build build = new Build(); - build.setFinalName( getModel().getArtifactId() ); - build.setSourceDirectory( getBasedir() + "/src/main/java" ); - build.setDirectory( super.getBasedir() + "/target/test/unit/aggregate-resources-test/project2/target" ); - setBuild( build ); - - List compileSourceRoots = new ArrayList<>(); - compileSourceRoots.add( getBasedir() + "/src/main/java" ); - setCompileSourceRoots( compileSourceRoots ); - } - - /** {@inheritDoc} */ - @Override - public File getBasedir() - { - return new File( super.getBasedir() + "/src/test/resources/unit/aggregate-resources-test/project2" ); - } - - /** {@inheritDoc} */ - @Override - public MavenProject getExecutionProject() - { - return this; + super( "/src/test/resources/unit/aggregate-resources-test/project2", + "pom.xml", + "/target/test/unit/aggregate-resources-test/project2/target" ); } } diff --git a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateResourcesTestMavenProjectStub.java b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateResourcesTestMavenProjectStub.java index 4d1c5e52..db7547a5 100644 --- a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateResourcesTestMavenProjectStub.java +++ b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateResourcesTestMavenProjectStub.java @@ -19,68 +19,18 @@ * under the License. */ -import java.io.File; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.List; -import java.util.Set; - -import org.apache.maven.artifact.Artifact; -import org.apache.maven.model.Build; -import org.apache.maven.plugin.testing.stubs.MavenProjectStub; -import org.apache.maven.project.MavenProject; - /** - * @author Vincent Siveton + * @author Reto Weiss */ public class AggregateResourcesTestMavenProjectStub - extends MavenProjectStub + extends AbstractAggregateMavenProjectStub { public AggregateResourcesTestMavenProjectStub() { - readModel( new File( getBasedir(), "aggregate-resources-test-plugin-config.xml" ) ); - - setGroupId( getModel().getGroupId() ); - setArtifactId( getModel().getArtifactId() ); - setVersion( getModel().getVersion() ); - setName( getModel().getName() ); - setUrl( getModel().getUrl() ); - setPackaging( getModel().getPackaging() ); - - setExecutionRoot( true ); - - Build build = new Build(); - build.setFinalName( getModel().getArtifactId() ); - build.setSourceDirectory( getBasedir() + "/src/main/java" ); - build.setDirectory( super.getBasedir() + "/target/test/unit/aggregate-resources-test/target" ); - setBuild( build ); - - List compileSourceRoots = new ArrayList<>(); - setCompileSourceRoots( compileSourceRoots ); - } - - @Override - public File getBasedir() - { - return new File( super.getBasedir() + "/src/test/resources/unit/aggregate-resources-test" ); - } - - @Override - public MavenProject getExecutionProject() - { - return this; - } - - @Override - public List getModules() - { - return Arrays.asList( "project1", "project2" ); - } - - @Override - public Set getDependencyArtifacts() - { - return Collections.emptySet(); + super( "/src/test/resources/unit/aggregate-resources-test", + "aggregate-resources-test-plugin-config.xml", + "/target/test/unit/aggregate-resources-test/target", + "project1", + "project2" ); } } From cc66703d3a7f9fe70563ef66caf8309ff4b2b467 Mon Sep 17 00:00:00 2001 From: Reto Weiss Date: Wed, 1 Apr 2020 15:02:57 +0200 Subject: [PATCH 6/6] MJAVADOC-617 improve test assertions --- .../maven/plugins/javadoc/AggregatorJavadocReportTest.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java b/src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java index 90ac1e18..f8a4e255 100644 --- a/src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java +++ b/src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java @@ -258,8 +258,8 @@ public void testAggregateWithModulsNotInSubFolders() throws Exception mojo.execute(); File apidocs = new File( getBasedir(), "target/test/unit/aggregate-modules-not-in-subfolders-test/target/site/apidocs" ); - assertTrue( apidocs.exists() ); - assertTrue( getOverviewSummary( apidocs ).exists() ); + assertTrue( apidocs.isDirectory() ); + assertTrue( getOverviewSummary( apidocs ).isFile() ); } private static File getOverviewSummary(File apidocs)