Chapter 4. Testing XML Rules


4.1. Add the Rule to Windup

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.

    Note

    For Windows, this directory would be \Documents and Settings\USER_NAME\.windup\rules\ or \Users\USER_NAME\.windup\rules\

4.2. Test the XML Rule

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
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

4.3. Additional Resources

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat