Chapter 4. Identify and Resolve Migration Issues

Follow these steps to use the Windup Eclipse Plugin to identify and resolve migration issues.

  1. Import the project to analyze into Eclipse.

  2. Create a Windup run configuration. From the Issue Explorer, press the Windup button ( Windup button ).

    Select Windup button

    At a minimum, select the project to analyze. Set additional options as needed.

  3. Click Run to execute Windup.
  4. Review Windup issues listed in the Issue Explorer.
  5. Resolve Windup issues by manually updating code or by using quick fixes when available.
  6. Run Windup again as necessary. Use the drop down next to the Run button ( Run button ) to run an existing configuration.

4.1. Create a Windup Run Configuration

Windup run configurations can be created using the Windup button ( Windup button ). A run configuration specifies the project to analyze, migration path, and additional options for the execution. You can create multiple run configurations, and each must have a unique name.

Input

Migration Path
Select a migration path, which determines which Windup rulesets are used. The migration path defaults to Anything to EAP 7, but can be changed to any supported migration path.
Projects
Select one or more projects to analyze. Hold the Ctrl key to select multiple projects in the list.
Packages
Select one or more packages to scan. It is recommended to select only those packages that you need to analyze to reduce the overall Windup execution time. If no packages are selected, all packages in the project will be scanned. Hold the Ctrl key to select multiple packages in the list.

Options

Report
Check the Generate Report checkbox if you want to generate the Windup HTML report. The report will be shown in the Windup Report tab and can be found in the Issue Explorer when you group by File.
Options

Set additional Windup options. Any option that is a boolean flag, such as enableTattletale, should use true as the value.

See the Windup Command-line Arguments section of the Windup User Guide for a description of each Windup argument.

Rules

Custom Rules Repositories
Add a custom rules directory if you have any custom Windup rules.

4.2. Execute Windup

Once a run configuration has been created, you can execute Windup using that configuration in one of the following ways:

  • Select the run configuration from the Run Configurations dialog and click Run.
  • Select a recent run configuration from the drop down next to the Run button ( Run button ).

If the Windup server is not currently running, it will start once a run configuration is executed.

Note

If you do not plan on running Windup in the near future, it is recommended to stop the Windup server to conserve memory on your machine.

Once execution is complete, the Issue Explorer will be populated with Windup issues.

4.3. Review Windup Issues

Use the Issue Explorer to review migration issues identified by Windup. Different icons indicate the issue’s severity and state.

Change how issues are grouped by adjusting the Group By selections: Severity, Migration Rule, and File.

Issue Explorer group by options

Double-click the Windup issue in the Issue Explorer to open the associated line of code in an editor. Right-click and select Issue Details to view information about the Windup issue, including its severity and how to address it.

4.4. Resolve Windup Issues

You can resolve Windup issues by updating the code manually or by applying a quick fix when available.

4.4.1. Resolve an Issue Manually

Review the Windup issue details and additional resources and update the source code as necessary. When you update a line of code marked as a Windup issue, the Windup issue will be marked with the stale icon ( Stale issue icon ) until the next time that Windup is run on the project.

You can also manually mark a Windup issue as fixed, which will mark the issue with the resolved icon ( Resolved issue icon ) until the next time that Windup is run on the project. To mark an issue as fixed, right-click the Windup issue in the Issue Explorer and select Mark as Fixed.

4.4.2. Resolve an Issue Using a Quick Fix

Some Windup issues provide a quick fix, which assists in making the necessary edits to address the issue. See the icon legend to see the icons that indicate the Windup issue has a quick fix available.

Preview a Quick Fix
Right-click the issue and select Preview Quick Fix. This will bring up a window that allows you to preview the change. From here, you can apply the fix or close the window.
Apply a Quick Fix
Right-click the issue and select Apply Quick Fix. This will update the source code as required and will mark the Windup issue as resolved.