Support for upgrading Maven Wrapper beyond version 3.3.0

[breun]

What would you like help with?

I think I found a bug

How are you running Renovate?

Self-hosted

If you're self-hosting Renovate, tell us which platform (GitHub, GitLab, etc) and which version of Renovate.

GitLab, Renovate 37.323.0

Please tell us more about your question or problem

Maven Wrapper 3.3.0 removed the wrapperUrl property from the .mvn/wrapper/maven-wrapper.properties file in projects that use Maven Wrapper.

I believe Renovate uses the wrapperUrl to determine the Maven Wrapper version, so after the upgrade to Maven Wrapper 3.3.0 Renovate will not be able to determine the Maven Wrapper version.

I requested a reliable way to determine the Maven Wrapper version (MWRAPPER-134) and this has been delivered in Maven Wrapper 3.3.1 in the form of a new wrapperVersion property in .mvn/wrapper/maven-wrapper.properties.

I believe the logic to determine the Maven Wrapper will need to be extended to the following to make sure that Renovate will continue to be able to keep Maven Wrapper up-to-date:

1. Check for the wrapperVersion property in .mvn/wrapper/maven-wrapper.properties. Use its value when present. This should cover projects that use Maven Wrapper 3.3.1 and later.
2. If there is no wrapperUrl property, check for the wrapperUrl property in .mvn/wrapper/maven-wrapper.properties and parse the version from that when present. This should cover projects that use Maven Wrapper before version 3.3.0.
3. If neither of the above yield a result, check for the string Apache Maven Wrapper startup batch script, version 3.3.0 in mvnw, or if absent in mvnw.cmd. This should cover projects that use Maven Wrapper 3.3.0.

Logs (if relevant)

No response

[github-actions[bot]]

Hi there,

Get your discussion fixed faster by creating a minimal reproduction. This means a repository dedicated to reproducing this issue with the minimal dependencies and config possible.

Before we start working on your issue we need to know exactly what's causing the current behavior. A minimal reproduction helps us with this. Discussions without reproductions are less likely to be converted to Issues.

To get started, please read our guide on creating a minimal reproduction.

Good luck,

The Renovate team

[rarkins]

Thanks for all the prior work!

Would you be able to create the 3 use cases?

• 3.2.9
• 3.3.0
• 3.3.1

I don't think necessary to duplicate with Windows too unless you want.

Then we can implement your suggested logic and make sure they all work in repos as intended

[breun]

I've created a little script to generate examples for Maven Wrapper 3.2.0, 3.3.0 and 3.3.1: create-examples.sh.zip

Here is an archive of the generated examples: examples.zip

Note that wrapperUrl exists in .mvn/wrapper/maven-wrapper.properties for all Maven Wrapper 3.2.0 examples, but doesn't exist for the only-script examples for Maven Wrapper 3.3.0 and later. Looking for the wrapperUrl property is currently the only method Renovate uses to determine the Maven Wrapper version, but this won't work for projects that use Maven Wrapper 3.3.0 with the only-script type. Also note that only-script was also made the default type in Maven Wrapper 3.3.0.

wrapperVersion exists in .mvn/wrapper/maven-wrapper.properties for all Maven Wrapper 3.3.1 examples. This is the new reliable method to determine the Maven Wrapper version that was introduced in Maven Wrapper 3.3.1. This property doesn't exist in Maven Wrapper 3.3.0 yet, so this can only be used to detect the Maven Wrapper version for projects that use Maven Wrapper 3.3.1 or later. This should become the first strategy for Renovate to detect the Maven Wrapper version. If wrapperVersion is present, the version should be considered found.

That leaves projects that use Maven Wrapper 3.3.0 with the default only-script type. Those will have neither a wrapperVersion nor a wrapperUrl property. In this case the Renovate will need to check for the string Apache Maven Wrapper startup batch script, version 3.3.0 in mvnw, or if mvnw is not present (in a Windows-only project?) in mvnw.cmd.

[trystian1]

I started on a Pull Request to fix these scenario's:

Check for the wrapperVersion property in .mvn/wrapper/maven-wrapper.properties. Use its value when present. This should cover projects that use Maven Wrapper 3.3.1 and later.

If there is no wrapperUrl property, check for the wrapperUrl property in .mvn/wrapper/maven-wrapper.properties and parse the version from that when present. This should cover projects that use Maven Wrapper before version 3.3.0.

#28670

is the following something we want to do?

If neither of the above yield a result, check for the string Apache Maven Wrapper startup batch script, version 3.3.0 in mvnw, or if absent in mvnw.cmd. This should cover projects that use Maven Wrapper 3.3.0.

is that going to effect a lot people?

[breun]

Great, thanks for picking this up!

All projects that used Maven Wrapper 3.2.0 with the then default bin type got upgraded by Renovate to Maven Wrapper 3.3.0 with the new default only-script type when 3.3.0 came out. So yes, I expect that a lot of projects will have been upgraded to this state in which there is neither a wrapperUrl nor a wrapperVersion property.

[breun]

Maybe Renovate should ideally also know which Maven Wrapper type (bin, only-script, script or source) a project is using, so it can suggest an update for the type a project is currently using by passing -Dtype=${type} to the upgrade command.

I think this would currently would require some detection logic in Renovate. Let me check if Maven Wrapper supports a way to upgrade it to a newer version without having to specify the installation type of the existing installation. And if it doesn't, if Maven Wrapper is willing to also expose a property for the installation type, so Renovate doesn't need to 'guess' it (although it could be a pretty reliable guess based on the presence/absence of particular files, but it would be nice if Renovate wouldn't need to contain (and maintain) this logic).