Maven Archetype

<requiredProperty> <defaultValue> not correctly filtered

Details

  • Type: Bug Bug
  • Status: Open Open
  • Priority: Minor Minor
  • Resolution: Unresolved
  • Affects Version/s: 2.0-alpha-5
  • Fix Version/s: 2.x
  • Component/s: Generator
  • Labels:
    None
  • Number of attachments :
    1

Description

In our archetype-metadata.xml we´ve defined a <requiredProperty> with a default value like this:

<requiredProperty key="subArtifactId">
    <defaultValue>${artifactId}.itest1</defaultValue>
</requiredProperty>

When we call "archetype:generate" and enter the parameters in interactive mode everything works fine. But when we try to set the parameter "subArtifactId" on the command line (mvn archetype:generate -DsubArtifactId=xyz) or from an "archetype.properties" file, the value is ignored. In the generated pom.xml the variable $

{subArtifactId}

is always replaced with "$

{artifactId}

.itest1".

Issue Links

relates to

Bug - A problem which impairs or prevents the functions of the product. ARCHETYPE-247 Maven properties are not filtered correctly

  • Major - Major loss of function.
  • Open - The issue is open and ready for the assignee to start work on it.

Wish - General wishlist item ARCHETYPE-255 custom variable filtered in created resources

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Krzysztof Cislo added a comment -

It would be perfect if we can used not only pure variable but also other Velocity syntax (as far as archetype is somehow based on Velocity).

E.g.: I want to set module name to generate exampled module with a class. I set property wit h value "test" which is used for package name but for class name I have to set "Test" so first letter has to be changed to upper case. Of course I can use two properties but it is much easier for somebody who use my archetype to set only one.

Show
Krzysztof Cislo added a comment - It would be perfect if we can used not only pure variable but also other Velocity syntax (as far as archetype is somehow based on Velocity). E.g.: I want to set module name to generate exampled module with a class. I set property wit h value "test" which is used for package name but for class name I have to set "Test" so first letter has to be changed to upper case. Of course I can use two properties but it is much easier for somebody who use my archetype to set only one.
Hide
Permalink
Tuomas Kiviaho added a comment -

This patch unifies interactive and batch mode behavior. Replacement of required properties now fails if transitive properties are not resolved. I noticed in the code that in order for $

{foobar}

to be replaced with foobars actual value, foobar must be a required property, but that another story. There also an oddity with groupId, artifactId, version (and package). They are forced as required properties in the new configuration as well so declaring of artifactId for instance without requiring will only lead to two properties with the same name of which one is optional and the (forced) one is still required.

Show
Tuomas Kiviaho added a comment - This patch unifies interactive and batch mode behavior. Replacement of required properties now fails if transitive properties are not resolved. I noticed in the code that in order for $ {foobar} to be replaced with foobars actual value, foobar must be a required property, but that another story. There also an oddity with groupId, artifactId, version (and package). They are forced as required properties in the new configuration as well so declaring of artifactId for instance without requiring will only lead to two properties with the same name of which one is optional and the (forced) one is still required.
Hide
Permalink
Herve Boutemy added a comment -

Tuomas,

from the description, there seems to be some improvements that could be useful
but I don't really understand your explanations ("transitive properties"?)
and the actual patch is missing tests to better show the new features

If you're ready to work with me, we can probably improve things in next Archetype plugin version

Show
Herve Boutemy added a comment - Tuomas, from the description, there seems to be some improvements that could be useful but I don't really understand your explanations ("transitive properties"?) and the actual patch is missing tests to better show the new features If you're ready to work with me, we can probably improve things in next Archetype plugin version
Hide
Permalink
Tuomas Kiviaho added a comment -

>This patch unifies interactive and batch mode behavior.
filtering is done only in part of the code that get's executed when interactive mode is used. Batch mode has completely separate handling. I merged these two execution paths together so that the only real difference is that required user input in interactive mode is replaced with default values in batch mode

>Replacement of required properties now fails if transitive properties are not resolved.
code seems to call as property values containing references to other properties (like $

{artifactId}

.itest1) as 'transitive properties'. If property references can't be resolved the build fails.

>There (is) also an oddity...
Codebase seems to treat groupId, artifactId, version (and package) a bit differently than other properties. Properties with same name can't be configured for instance as optional because what you'd only be generating duplicate properties with same name. This is just something that caught my eye.

There wasn't existing test cases to begin with so I only could test with my own code and while trying to keep the number of changed lines in minimum.

Show
Tuomas Kiviaho added a comment - >This patch unifies interactive and batch mode behavior. filtering is done only in part of the code that get's executed when interactive mode is used. Batch mode has completely separate handling. I merged these two execution paths together so that the only real difference is that required user input in interactive mode is replaced with default values in batch mode >Replacement of required properties now fails if transitive properties are not resolved. code seems to call as property values containing references to other properties (like $ {artifactId} .itest1) as 'transitive properties'. If property references can't be resolved the build fails. >There (is) also an oddity... Codebase seems to treat groupId, artifactId, version (and package) a bit differently than other properties. Properties with same name can't be configured for instance as optional because what you'd only be generating duplicate properties with same name. This is just something that caught my eye. There wasn't existing test cases to begin with so I only could test with my own code and while trying to keep the number of changed lines in minimum.
Hide
Permalink
Tuomas Kiviaho added a comment -

I see that there is a property-setting-cli that could be converted to batch mode test quite easily. The required property in the declaration is a good permutation to begin with and both cli and batch mode should contain also more deeply nested property referencing scenarios. (a=$

{b}

,b=$

{c}

,c=foobar).

Show
Tuomas Kiviaho added a comment - I see that there is a property-setting-cli that could be converted to batch mode test quite easily. The required property in the declaration is a good permutation to begin with and both cli and batch mode should contain also more deeply nested property referencing scenarios. (a=$ {b} ,b=$ {c} ,c=foobar).
Hide
Permalink
Herve Boutemy added a comment -

yeah, I worked on IT additions since it was absolutely necessary before thinking at changing any feature
please see how you can improve the actual ones: I'm going to do a release in a few days
if you can provide something before, it can be in the release

Show
Herve Boutemy added a comment - yeah, I worked on IT additions since it was absolutely necessary before thinking at changing any feature please see how you can improve the actual ones: I'm going to do a release in a few days if you can provide something before, it can be in the release

People

  • Assignee:
    Unassigned
    Reporter:
    Jochen Ehret
Vote (4)
Watch (6)

Dates

  • Created:
    Updated: