Chapter 4. Testing XML Rules
4.1. Add the Rule to Windup Copy linkLink copied to clipboard!
A Windup rule is installed simply by copying the rule to the appropriate Windup folder. Windup scans for rules, which are files that end with either *.windup.groovy
or .windup.xml
, in the following locations:
-
Copy the rule to a directory specified by the
--userRulesDirectory
argument on the Windup command line. - Copy the rule to the WINDUP_HOME/rules/ directory. WINDUP_HOME is the directory where you install and run the Windup executable.
Copy the rule to the
${user.home}/.windup/rules/
directory. This directory is created by Windup the first time it is executed and contains rules, add-ons, and the Windup log.NoteFor Windows, this directory would be
\Documents and Settings\USER_NAME\.windup\rules\
or\Users\USER_NAME\.windup\rules\
4.2. Test the XML Rule Copy linkLink copied to clipboard!
Test the XML rule against your application file by running Windup in a terminal.
WINDUP_HOME/bin/windup [--sourceMode] --input INPUT_ARCHIVE_OR_FOLDER --output OUTPUT_REPORT_DIRECTORY --target TARGET_TECHNOLOGY --packages PACKAGE_1 PACKAGE_2 PACKAGE_N
$ WINDUP_HOME/bin/windup [--sourceMode] --input INPUT_ARCHIVE_OR_FOLDER --output OUTPUT_REPORT_DIRECTORY --target TARGET_TECHNOLOGY --packages PACKAGE_1 PACKAGE_2 PACKAGE_N
You should see the following result:
Windup report created: OUTPUT_REPORT_DIRECTORY/index.html Access it at this URL: file:///OUTPUT_REPORT_DIRECTORY/index.html
Windup report created: OUTPUT_REPORT_DIRECTORY/index.html
Access it at this URL: file:///OUTPUT_REPORT_DIRECTORY/index.html
4.3. Additional Resources Copy linkLink copied to clipboard!
- More examples of how to run Windup are located in the Windup User Guide.
- Working examples of XML-based rules can be found in the Windup source code GitHub repository and the Windup quickstarts GitHub repository or latest release ZIP download.