[MNG-5889] .mvn directory should be picked when using --file

[jira-importer]

Daniel Spilker opened MNG-5889 and commented

The .mvn directory is not picked up when using the --file switch to build a project from outside of the multi-module root.

Example:

• the module root is /foo/bar
• .mvn is located at /foo/bar/.mvn
• current directory is /foo
• Maven is invoked with mvn --file bar/module/pom.xml

I would expect the .mvn directory detection to start at the directory of the POM selected by --file and then go through the parent directories.

---

Affects: 3.3.3, 3.3.9

Attachments:

• reproduce_MNG-5889.bash (637 bytes)

Issue Links:

• MNG-6385 Windows mvn.cmd fail with incorrect command syntax.
  ("causes")

• MNG-6256 Maven script can break if "-f" path contains special characters

• MNG-5767 project-specific default jvm options and command line parameters

• MNG-5771 improved user-configurable core extensions mechanism

• MNG-5858 mvn script fails to locate .mvn in current directory

• MNG-6198 mvn script fails to locate .mvn directory when pom location specified with -f

• MNG-6223 mvn -f outputs invalid error when specifying POM directory

Remote Links:

• Page
  
• GitHub Pull Request #33
  
• GitHub Pull Request #59
  
• GitHub Pull Request #74
  
• GitHub Pull Request #436
  
• GitHub Pull Request #38
  
• GitHub Pull Request #8
  
• GitHub Pull Request #93
  
• GitHub Pull Request #94
  

Backported to: 3.5.0-alpha-1

3 votes, 14 watchers

[jira-importer]

Arnaud Heritier commented

Hi Daniel,

It is clearly a bug/limitation of the current implementation and it is really annoying for exemple on CI servers where you can checkout the project in a subdirectory and launch the build with the path to the pom parameter.

I was aware of this bug for few months but I forgot to report it. I described it to the team on IRC few days ago but I had sadly no feedback.

Technically I don't yet know how to fix it. The problem is that it enforces at the .sh/.cmd script level to parte the command line options to find if the -f/--file option is defined. If it is the case we need to extract its value and compute the path of the module directory (AFAIR we can either pass to the option the module directory or the POM file). When the module directory is found we need to find the .mvn directory from this path and not from the local directory. For the shell .sh version I think I may succeed to propose a fix, but for the windows .cmd I'm less confident and I'm clearly against to have a different behaviour based on the OS

[jira-importer]

Daniel Spilker commented

Hi Arnaud,

indeed I was running into this problem when using the Jenkins Maven Plugin.

It should be possible to add a "base directory" setting to that plugin so that the CI can change to the base directory before launching Maven, but I think it would be better to fix the problem at the root.

[jira-importer]

Karl Heinz Marbaise commented

The problem at the moment is that the shell script (mvn / mvn.cmd) is finding the location of the folder....and not Maven itself...

[jira-importer]

Arnaud Heritier commented

Daniel Spilker Yes I discovered the issue within Jenkins too where it is a common need to define the path and to not checkout the project in the root directory of the workspace. Having an option to setup the base directory may be a workaround but I don't find any other usage of it and like you I would prefer to see the problem fixed on Maven side

Karl Heinz Marbaise yes because of JVM options which have to be discovered before launching Maven :(

[jira-importer]

Robert Patrick commented

This is easy enough to fix by scanning the command-line arguments in the shell script. I have a fix working for the sh script...still fighting with Windows to get something equivalent working in the cmd script.

[jira-importer]

Tibor Digana commented

Sorry, I was quite busy this week. I will merge it in a day.

[jira-importer]

Michael Osipov commented

Why can't me move this logic to Java code and let the startup scripts to be as dumb as possible?

[jira-importer]

Hervé Boutemy commented

because .mvn/jvm.config content has to be read before launching the JVM: that's the only cause

[jira-importer]

Stephen Connolly commented

Maven 3.4.0 has been dropped. See this thread for more details.

This issue will need to be re-scheduled for a Maven release in the (hopefully near) future.

[jira-importer]

Jason Young commented

Stephen Connolly Are you saying this issue is not fixed in 3.5.0?

I'm seeing this issue in maven 3.6.0 similarly to how it is described in the OP. Specifically, I define the revision property in root/.mvn/maven.config but see e.g. 'dependencies.dependency.version' for com.blah:blah:jar must be a valid version but is '${revision}' only when building from another directory via the --file=path/to/root/pom.xml arg. I can provide more detail or report this separately if necessary.

[jira-importer]

Karl Heinz Marbaise commented

Using the revision property for dependencies is simply not supported and is unrelated to this issue...

[jira-importer]

Jason Young commented

Karl Heinz Marbaise I have a setup like:

root/pom.xml:

<groupId>blah</groupId>
<artifactId>root</artifactId>
<version>${revision}</version>

root/.mvn/maven.config:

-Drevision=1.2.3

a/pom.xml

<parent>
    <groupId>blah</groupId>
    <artifactId>root</artifactId>
</parent>
<artifactId>a</artifactId>

b/pom.xml

<parent>
    <groupId>blah</groupId>
    <artifactId>root</artifactId>
</parent>
<artifactId>b</artifactId>
<dependencies>
    <groupId>blah</groupId>
    <artifactId>root</artifactId>
    <version>${project.version}</version>
</dependencies>

With this setup, mvn validate works from the root/ directory, but mvn --file=root/pom.xml validate from the parent directory fails. Changing the ${project.version} above to ${revision} yields the same results. Putting the revision property in root/pom.xml instead of root/.mvn/maven.config works around the problem. Based on these cases, Maven appears to support my use of the revision property, but has the same defect as reported in the OP.

Note that I'm using the revision property to set the version of the parent project of all other projects, then making some projects depend on others. Beyond that, I'm not using the revision property for dependencies. Is my use of the revision property supported?

[jira-importer]

Robert Patrick commented

The code to resolve properly locating the .mvn directory is definitely in 3.5.x and 3.6.0 (I just verified by looking at the shell scripts).  If you believe it isn't working with the --file option, try putting some garbage argument that Maven doesn't recognize in root/.mvn/maven.config and run mvn --file=/path/to/root/pom.xml and see what happens.  I would expect Maven to fail to start if this issue is resolved.  For example, I added the -Y option and mvn fails to start:

 

D:\projects>type weblogic-deploy-tooling.mvn\maven.config
-Dunit-test-wlst-dir=/u01/oracle/oracle_common/common/bin
-Y

D:\projects>mvn -v
Apache Maven 3.6.0 (97c98ec; 2018-10-24T13:41:47-05:00)
Maven home: c:\java\apache-maven-3.6.0\bin..
Java version: 1.8.0_191, vendor: Oracle Corporation, runtime: c:\java\jdk1.8.0\jre
Default locale: en_US, platform encoding: Cp1252
OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"

D:\projects>mvn --file=weblogic-deploy-tooling\pom.xml
Unable to parse maven.config: Unrecognized option: -Y

usage: mvn [options] [<goal(s)>] [<phase(s)>]
<snip>

[jira-importer]

Jason Young commented

Robert Patrick Good idea. Checking out an earlier version of my project, before the revision property entered the picture:

$ mvn --file=root/pom.xml validate
... snip ...
[INFO] root ............................................... SUCCESS [ 0.230 s]
[INFO] Something_Else...................................... SUCCESS [ 0.012 s]
[INFO] etc ................................................ SUCCESS [ 0.011 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
$ cd root
$ mvn validate
Unable to parse maven.config: Unrecognized option: -Y

I just tried the same thing with the Maven quickstart archetype, and it is reproducible there as well.

$ mvn -v
Apache Maven 3.6.0 (97c98ec64a1fdfee7767ce5ffb20918da4f719f3; 2018-10-24T13:41:47-05:00)
Maven home: /home/jason/bin/apache-maven-3.6.0
Java version: 1.8.0_191, vendor: Oracle Corporation, runtime: /usr/lib/jvm/java-8-openjdk-amd64/jre
Default locale: en_US, platform encoding: UTF-8
OS name: "linux", version: "4.15.0-43-generic", arch: "amd64", family: "unix"

 

[jira-importer]

Jason Young commented

also reproducible in the maven:latest docker image.