Quick Build Review
Execute Windup (Built from Windup Source)
-These instructions are for Windup core developers who are new to the project and unfamiliar with the procedures to execute Windup.
-
-
-Experienced users may jump to Quick Execute Review for Experienced Windup Users.
-
-
-
-
-
-Note
-
-
-If you used previous versions of Windup, delete the ${user.home}/.forge/addons/ directory. Otherwise you may see errors like the following when you execute Windup:
- Command: windup-migrate-app was not found
-
-
-
-
-
-Unzip the Windup Distribution
-
-
--
-
Follow the procedures to build Windup from source. This creates a windup-distribution-2.0.0-SNAPSHOT-offline.zip file in the Windup source dist/target directory. Note, the version may be different than the one used in these instructions.
-
--
-
Unzip the dist/target/windup-distribution-2.0.0-SNAPSHOT-offline.zip ZIP file.
-
-
-
-
-
-Run Windup
-
-
--
-
Open a terminal and navigate to the unzipped windup-distribution-2.0.0-SNAPSHOT/ directory.
-
--
-
Type the following command to start Windup:
-
-
-For Linux: $ bin/windup
-For Windows: > bin\windup.bat
-
-
-
--
-
You are presented with the following prompt.
-
-
-Using Windup at /home/username/windup/dist/target/windup-distribution-2.0.0-SNAPSHOT
-
- _ ___ __
-| | / (_)___ ____/ /_ ______
-| | /| / / / __ \/ __ / / / / __ \
-| |/ |/ / / / / / /_/ / /_/ / /_/ /
-|__/|__/_/_/ /_/\__,_/\__,_/ .___/
- /_/
-
-JBoss Windup, version [ 2.0.0-SNAPSHOT ] - JBoss, by Red Hat, Inc. [ http://windup.jboss.org ]
-
-[windup-distribution-2.0.0-SNAPSHOT]$
-
-
-
--
-
The syntax to evaluate an application using the Windup tool requires that you specify the location of the input archive or folder, the location of a folder to contain the output reporting information, and the application packages to evaluate. At the prompt, type:
-
-
-windup-migrate-app --input INPUT_ARCHIVE_OR_FOLDER --output OUTPUT_REPORT_DIRECTORY --packages PACKAGE_1 PACKAGE_2 PACKAGE_N
-
-
-
-Where:
+These instructions are for Windup core developers who plan to build Windup from source to test code updates.
-
-
INPUT_ARCHIVE_OR_FOLDER is the fully qualified application archive or source path
+If you are new to the project and not familiar with the procedures to execute Windup, see Execute Windup. It contains complete step-by-step instructions to execute Windup and also provides command line examples.
-
-
OUTPUT_REPORT_DIRECTORY is the fully qualified path to the folder that will contain the the report information produced by Windup.
-
--
-
PACKAGE_1, PACKAGE_2, PACKAGE_N are the packages to be evaluated by Windup.
-
-See Windup Command Examples below for concrete examples of Windup commands using source code directories and archives located in the Windup GitHub repository.
-
-
-
-
-
--
-
You should see the following result upon completion of the command:
-
-
-***SUCCESS*** Windup execution successful!
-
-
-
--
-
To exit Windup, type
-
-
-exit
-
-
-
--
-
Open the OUTPUT_REPORT_DIRECTORY/index.html file in a browser to access the report.
-The following subdirectories in the OUTPUT_REPORT_DIRECTORY contain the supporting information for the report:
-
-
-OUTPUT_REPORT_DIRECTORY
- graph/
- renderedGraph/
- reports/
- stats/
- index.html
-
-
-
--
-
For details on how to evaluate the report data, see Review the Report.
-
-
-
-
-
-Run Windup in Batch Mode (for a shell script)
-
-
--
-
Open a terminal and navigate to the unzipped windup-distribution-2.0.0-SNAPSHOT/ directory.
-
--
-
Type the following command to run Windup in batch mode:
-
-
-For Linux: $ bin/windup --evaluate "windup-migrate-app --input INPUT_ARCHIVE --output OUTPUT_REPORT --packages PACKAGE_1 PACKAGE_2 PACKAGE_N"
-For Windows: > bin\windup.bat --evaluate "windup-migrate-app --input INPUT_ARCHIVE --output OUTPUT_REPORT --packages PACKAGE_1 PACKAGE_2 PACKAGE_N"
-
-
-
-
-
-
-
-Windup Help
-
-To see the list of available parameters for the windup-migrate-app command, execute the following command in the Windup prompt:
-
-
-
-man windup-migrate-app
-
-
-
-
-Windup Command Examples
-
-The following Windup command examples report against applications located in the Windup source test-files directory.
-
-
-Source Code Example
-
-The following command runs against the seam-booking-5.2 application source code. It evaluates all org.jboss.seam packages and creates a folder named 'seam-booking-report' in the /home/username/windup-reports/ directory to contain the reporting output.
-
-
-
-windup-migrate-app --input /home/username/windup-source/test-files/seam-booking-5.2/ --output /home/username/windup-reports/seam-booking-report --packages org.jboss.seam
-
-
-
-
-Archive Example
-
-The following command runs against the jee-example-app-1.0.0.ear EAR archive. It evaluates all com.acme and org.apache packages and creates a folder named 'jee-example-app-1.0.0.ear-report' in the /home/username/windup-reports/ directory to contain the reporting output.
-
-
-
-windup-migrate-app --input /home/username/windup-source/test-files/jee-example-app-1.0.0.ear/ --output /home/username/windup-reports/jee-example-app-1.0.0.ear-report --packages com.acme org.apache
-
-
-
-
-
-Quick Execute Review for Experienced Windup Users
+Experienced users who need a refresher can follow the steps below.
mkdir tmp
@@ -1925,44 +1789,18 @@ Quick Execute Review
## Execute Windup
$ windup-migrate-app --input /home/username/work/Migration/TestApps/_apps/BradApp --output Report --packages org com net
-## Exit forge
+## Exit Windup
$ exit
## View the Report
firefox Report/index.html
+
+
-
-Execute Windup as an Installed Forge Add-on
-
-
-## Install Forge
-wget -O forge.zip https://repository.jboss.org/nexus/service/local/repositories/releases/content/org/jboss/forge/forge-distribution/2.12.0.Final/forge-distribution-2.12.0.Final-offline.zip
-unzip forge.zip
-mv forge-distribution-2.12.0.Final Forge
-
-## Configure Forge and Install Windup
-export FORGE_HOME=./Forge/
-export PATH=$PATH:$FORGE_HOME/bin
-rm -rf ~/.forge/addons/
-forge -b --install org.jboss.windup:ui,2.0.0-SNAPSHOT
-forge -b --install org.jboss.windup.rules.apps:rules-java,2.0.0-SNAPSHOT
-forge -b --install org.jboss.windup.rules.apps:rules-java-ee,2.0.0-SNAPSHOT
-
-## Start Forge
-forge
-
-## Execute Windup
-$ windup-migrate-app --input /home/username/work/Migration/TestApps/_apps/BradApp --output Report --packages org com net
-
-## Exit forge
-$ exit
-
-## View the Report
-firefox Report/index.html
-
-
+
+Unresolved directive in Windup-Core-Development-Guide.adoc - include::Execute-Windup[tabsize=4]
@@ -2357,32 +2195,51 @@ What are Story Points?
How to Estimate Story Points in a Rule
-TODO: TBD.
+Estimating story points for a rule can be tricky. The following are general guidelines or suggestions to use when estimating the level of effort required for a rule.
-
-Estimating story points for a rule can be tricky. The following are 'rules of thumb' or suggestions to use when estimating the level of effort required for a rule.
+
+
+
+
+
+Level of Effort
+Story Points
+Description
+
+
+
+
+Lift and Shift
0
The code or file is standards-based and requires no effort.
+
+Mapped
1- 2 per file
There is a standard mapping algorithm to port the code or file. The number of story points required is small, but dependent on the number of files to port.
+
+Custom
5 - 20 per change or component
+The number of story points required to modify and rewrite code depends on the complexity of the change, the number of unknown imports, the size of the files, and the number of components. The following are examples of how to estimate story points.
-
-
The level of effort required for "Lift and Shift", which basically means the code or file is standards-based and can be ported to the new environment with no changes, would be '0' story points.
-
--
-
Changing a parameter name or value of units might be '2' story points.
-This could contain relative examples like:
-
--
-
Porting a web page (or similar concept) from one web framework to another depends on the complexity and the number of components. You could estimate '20' story points per component.
+Port MyBatis to JPA: '20' story points per query.
-
-
Porting MyBatis to JPA: '20' story points per query.
-
--
-
When you don’t know if it will need a migration: Could depend on number of unknown imports, size
-of the file, …
+Port a web page from one web framework to another depends on the complexity and the number of components involved in the migration. You could estimate '20' story points per component.
-
+
+
+
+
@@ -2784,7 +2641,7 @@ Create a Maven Project
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.7</maven.compiler.source>
<maven.compiler.target>1.7</maven.compiler.target>
- <version.windup>2.0.0.Beta3</version.windup>
+ <version.windup>2.0.0.VERSION</version.windup>
<version.forge>2.12.1.Final</version.forge>
</properties>
@@ -4428,7 +4285,7 @@ Examples of brea
Execute Windup (Built from Windup Source)
These instructions are for Windup core developers who are new to the project and unfamiliar with the procedures to execute Windup.
-Experienced users may jump to Quick Execute Review for Experienced Windup Users.
-|
- Note
- |
-
-If you used previous versions of Windup, delete the ${user.home}/.forge/addons/ directory. Otherwise you may see errors like the following when you execute Windup:
- Command: windup-migrate-app was not found
- |
-
Unzip the Windup Distribution
--
-
-
-
Follow the procedures to build Windup from source. This creates a
-windup-distribution-2.0.0-SNAPSHOT-offline.zipfile in the Windup sourcedist/targetdirectory. Note, the version may be different than the one used in these instructions.
- -
-
Unzip the
-dist/target/windup-distribution-2.0.0-SNAPSHOT-offline.zipZIP file.
-
Run Windup
--
-
-
-
Open a terminal and navigate to the unzipped
-windup-distribution-2.0.0-SNAPSHOT/directory.
- -
-
Type the following command to start Windup:
-----For Linux: $ bin/windup -For Windows: > bin\windup.bat
-
- -
-
You are presented with the following prompt.
-----Using Windup at /home/username/windup/dist/target/windup-distribution-2.0.0-SNAPSHOT - - _ ___ __ -| | / (_)___ ____/ /_ ______ -| | /| / / / __ \/ __ / / / / __ \ -| |/ |/ / / / / / /_/ / /_/ / /_/ / -|__/|__/_/_/ /_/\__,_/\__,_/ .___/ - /_/ - -JBoss Windup, version [ 2.0.0-SNAPSHOT ] - JBoss, by Red Hat, Inc. [ http://windup.jboss.org ] - -[windup-distribution-2.0.0-SNAPSHOT]$
-
- -
-
The syntax to evaluate an application using the Windup tool requires that you specify the location of the input archive or folder, the location of a folder to contain the output reporting information, and the application packages to evaluate. At the prompt, type:
-----windup-migrate-app --input INPUT_ARCHIVE_OR_FOLDER --output OUTPUT_REPORT_DIRECTORY --packages PACKAGE_1 PACKAGE_2 PACKAGE_N
--Where:
+These instructions are for Windup core developers who plan to build Windup from source to test code updates.
--
-
+INPUT_ARCHIVE_OR_FOLDERis the fully qualified application archive or source pathIf you are new to the project and not familiar with the procedures to execute Windup, see Execute Windup. It contains complete step-by-step instructions to execute Windup and also provides command line examples.
-
-
-OUTPUT_REPORT_DIRECTORYis the fully qualified path to the folder that will contain the the report information produced by Windup.
- -
-
-PACKAGE_1,PACKAGE_2,PACKAGE_Nare the packages to be evaluated by Windup.--See Windup Command Examples below for concrete examples of Windup commands using source code directories and archives located in the Windup GitHub repository.
-
-
- -
-
-
-
You should see the following result upon completion of the command:
-----***SUCCESS*** Windup execution successful!
-
- -
-
To exit Windup, type
-----exit
-
- -
-
Open the
-OUTPUT_REPORT_DIRECTORY/index.htmlfile in a browser to access the report. -The following subdirectories in theOUTPUT_REPORT_DIRECTORYcontain the supporting information for the report:----OUTPUT_REPORT_DIRECTORY - graph/ - renderedGraph/ - reports/ - stats/ - index.html
-
- -
-
For details on how to evaluate the report data, see Review the Report.
-
-
Run Windup in Batch Mode (for a shell script)
--
-
-
-
Open a terminal and navigate to the unzipped
-windup-distribution-2.0.0-SNAPSHOT/directory.
- -
-
Type the following command to run Windup in batch mode:
-----For Linux: $ bin/windup --evaluate "windup-migrate-app --input INPUT_ARCHIVE --output OUTPUT_REPORT --packages PACKAGE_1 PACKAGE_2 PACKAGE_N" -For Windows: > bin\windup.bat --evaluate "windup-migrate-app --input INPUT_ARCHIVE --output OUTPUT_REPORT --packages PACKAGE_1 PACKAGE_2 PACKAGE_N"
-
-
Windup Help
-To see the list of available parameters for the windup-migrate-app command, execute the following command in the Windup prompt:
man windup-migrate-app-
Windup Command Examples
-The following Windup command examples report against applications located in the Windup source test-files directory.
-Source Code Example
-The following command runs against the seam-booking-5.2 application source code. It evaluates all org.jboss.seam packages and creates a folder named 'seam-booking-report' in the /home/username/windup-reports/ directory to contain the reporting output.
windup-migrate-app --input /home/username/windup-source/test-files/seam-booking-5.2/ --output /home/username/windup-reports/seam-booking-report --packages org.jboss.seam-
Archive Example
-The following command runs against the jee-example-app-1.0.0.ear EAR archive. It evaluates all com.acme and org.apache packages and creates a folder named 'jee-example-app-1.0.0.ear-report' in the /home/username/windup-reports/ directory to contain the reporting output.
windup-migrate-app --input /home/username/windup-source/test-files/jee-example-app-1.0.0.ear/ --output /home/username/windup-reports/jee-example-app-1.0.0.ear-report --packages com.acme org.apache-
Quick Execute Review for Experienced Windup Users
+Experienced users who need a refresher can follow the steps below.
mkdir tmp @@ -1925,44 +1789,18 @@Quick Execute Review ## Execute Windup $ windup-migrate-app --input /home/username/work/Migration/TestApps/_apps/BradApp --output Report --packages org com net -## Exit forge +## Exit Windup $ exit ## View the Report firefox Report/index.html
Execute Windup as an Installed Forge Add-on
-## Install Forge -wget -O forge.zip https://repository.jboss.org/nexus/service/local/repositories/releases/content/org/jboss/forge/forge-distribution/2.12.0.Final/forge-distribution-2.12.0.Final-offline.zip -unzip forge.zip -mv forge-distribution-2.12.0.Final Forge - -## Configure Forge and Install Windup -export FORGE_HOME=./Forge/ -export PATH=$PATH:$FORGE_HOME/bin -rm -rf ~/.forge/addons/ -forge -b --install org.jboss.windup:ui,2.0.0-SNAPSHOT -forge -b --install org.jboss.windup.rules.apps:rules-java,2.0.0-SNAPSHOT -forge -b --install org.jboss.windup.rules.apps:rules-java-ee,2.0.0-SNAPSHOT - -## Start Forge -forge - -## Execute Windup -$ windup-migrate-app --input /home/username/work/Migration/TestApps/_apps/BradApp --output Report --packages org com net - -## Exit forge -$ exit - -## View the Report -firefox Report/index.html-
Unresolved directive in Windup-Core-Development-Guide.adoc - include::Execute-Windup[tabsize=4]
What are Story Points?
How to Estimate Story Points in a Rule
TODO: TBD.
+Estimating story points for a rule can be tricky. The following are general guidelines or suggestions to use when estimating the level of effort required for a rule.
Estimating story points for a rule can be tricky. The following are 'rules of thumb' or suggestions to use when estimating the level of effort required for a rule.
+| Level of Effort | +Story Points | +Description | +
|---|---|---|
Lift and Shift |
+0 |
+The code or file is standards-based and requires no effort. |
+
Mapped |
+1- 2 per file |
+There is a standard mapping algorithm to port the code or file. The number of story points required is small, but dependent on the number of files to port. |
+
Custom |
+5 - 20 per change or component |
+
+
The number of story points required to modify and rewrite code depends on the complexity of the change, the number of unknown imports, the size of the files, and the number of components. The following are examples of how to estimate story points.
|
+
Create a Maven Project
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.7</maven.compiler.source> <maven.compiler.target>1.7</maven.compiler.target> - <version.windup>2.0.0.Beta3</version.windup> + <version.windup>2.0.0.VERSION</version.windup> <version.forge>2.12.1.Final</version.forge> </properties>Existing operations:
