XWIKI-22152 In velocity, can't use $macro.myVar with setVariable macro

[Josue-T]

Jira URL

https://jira.xwiki.org/browse/XWIKI-22152

Changes

Description

Add support for variable like $macro.myvar in setVariable velocity macro.

Clarifications

So to fix the described issue, the idea is to improve the setVariable macro to be able to set correctly the value when the caller pass a parameter to set with something like this $macro.xxx.

For this we need the $macro.parent which give access to the $macro dict of the caller. Note that we need to call $macro.parent.parent because $macro.parent return the macro which is calling setVariable and so we want to call the parent of this one.

Executed Tests

To test this we can use this small code

#macro(myChildMacro $return)
  #set($return = $NULL)
  #setVariable("$return" "my new value")
#end

#macro(myParentMacro)
  #myChildMacro($macro.childResult)
  $macro.childResult
#end

#myParentMacro()

Before we have this result

$macro.childResult

After we have this result:

my new value

Expected merging strategy

• Prefers squash: Yes
• Backport on branches: Not needed, as it's a new feature.

[tmortagne]

Would be very interesting to start adding some unit tests for this vmacro in https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-web/xwiki-platform-web-templates/src/test/java/org/xwiki/web/MacrosTest.java.

[Josue-T]

Would be very interesting to start adding some unit tests for this vmacro in https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-web/xwiki-platform-web-templates/src/test/java/org/xwiki/web/MacrosTest.java.

Thanks for the feedback. I added some unit test for this.