[MJAVADOC-617] Normalize module path so that '..' in the path are resolved #27
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a> | ||
|
|
||
| */ | ||
| 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<String> 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; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a> | ||
|
|
||
| */ | ||
| public class AggregateNotInSubFolderProject2TestMavenProjectStub | ||
| extends MavenProjectStub | ||
| { | ||
| public AggregateNotInSubFolderProject2TestMavenProjectStub() | ||
| { | ||
| readModel( new File( getBasedir(), "pom.xml" ) ); | ||
|
There was a problem hiding this comment. There's a lot of duplicate code here that could probably be refactored into a common location. There was a problem hiding this comment. I agree that there is alot of duplicated code. I copied them from older test classes that made the same thing. Will refactor all this code. However, why do I need this stub classes at all? I tried to avoid them but then the test seems not to work correctly? |
||
|
|
||
| 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<String> 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; | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a not a well known class so static imports should probably be avoided.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi Elliotte
Sorry I messed up this commit, because my IDE reorganized the whole import section of this file. I reverted that in my last commit. I could squash the commits to get a clearer history if that is recommended. However I have not introduced this static import in this commit here I only moved it around.
Do I still have to refactor this static import? This will introduce some additional changes to this PR that are not relevant to the issue I try to fix.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I missed that the imports were reorganized. If this is existing code, no need to fix it here. I don't know if maven follows any conventions for import ordering, but absent that it's best not to reorder imports to avoid churn.