[MENFORCER-363] Unexpected result from requireProperty with regex when the property is not fully resolved

Open
  • Is something wrong?
#476 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
java
Domain
build-system

Research direction

Start with the RequireProperty rule and reproduce the supplied Maven configuration, comparing unresolved properties such as foo and bar. Review the linked MNG-7194 issue because the report identifies it as the cause. Done means unresolved placeholders are handled consistently with Maven's standard behavior and the reported regex checks produce the expected result.

Written by the indexing model from the issue text.

Description

bug priority:major

Bertrand Renuart opened MENFORCER-363 and commented

I was looking for a way to verify a property is defined and is fully resolved. When it cannot resolve a placeholder, Maven usually leave it unchanged. So if property "unknown" is not defined, "<foo>pre-${unknown}</foo>" would not fully resolve and would left asis.

With this in mind, I thought I could use the "requireProperty" with a regex looking for "$" to check if a property is fully resolved or not. 

Consider the following example:

<properties>
  <foo>${unknown}</foo>
  <bar>pre${unknown}</bar>
</properties> 

<plugin>
  <artifactId>maven-enforcer-plugin</artifactId>
  <version>3.0.0-M3</version>
  <executions>
    <execution>
      <goals><goal>enforce</goal></goals>
      <configuration>
        <rules>
          <requireProperty>
            <property>foo</property>
            <regex>[^$]*</regex>
          </requireProperty>
          <requireProperty>
            <property>bar</property>
            <regex>[^$]*</regex>
          </requireProperty>
        </rules>
...

 

Here is what the execution reports:

[WARNING] Rule 0: org.apache.maven.plugins.enforcer.RequireProperty failed with message:
Property "foo" is required for this build.

 

For the first rule, since "foo" refers to an unknown property, I can understand it is "not defined" and that the rule complains about it.

However, I would expect the second rule to fail as well. Let's change its regex to "[0-9]+" to see what happens:

[WARNING] Rule 1: org.apache.maven.plugins.enforcer.RequireProperty failed with message:
Property "bar" evaluates to "prenull".  This does not match the regular expression "[0-9]+"

As we can see, the placeholder "${unknown}" has been resolved into "null" - reason why the rule didn't fail initially...

 

IMHO this behaviour is not intuitive since Maven's standard behaviour is to leave placeholders unchanged when they cannot be resolved.

 

 

Affects: 3.0.0-M3

Issue Links:

  • MNG-7194 PluginParameterExpressionEvaluator incorrectly interpolates unknown subexpression
    ("is caused by")
Dominant language
Java
Stars
162
Forks
188
Avg merge
1d 9h
Merged PRs (30d)
17

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/maven-enforcer

All issues in apache/maven-enforcer

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.