Add a sample to showcase migrating a legacy Java EE Ant project to a Jakarta EE 10 Maven project (#39)

* Update README

* add execution permisson to shell scripts

Signed-off-by: Jianguo Ma <[email protected]>

* worker doesn't listen to port 8081

Signed-off-by: Jianguo Ma <[email protected]>

* clean before starting web/worker apps

Signed-off-by: Jianguo Ma <[email protected]>

* update readme

Signed-off-by: Jianguo Ma <[email protected]>

* add dev container config

Signed-off-by: Jianguo Ma <[email protected]>

* fix typo in readme

Signed-off-by: Jianguo Ma <[email protected]>

* add diff (#16)

* add formula source (#14)

* migrate rabbitmq to service bus (#18)

* delete the new project and diff file (#19)

* add open liberty sample

* add mybatis, jackson, ServletFilter, cert

* refactor, use ibatis instead of mybatis

* jar location update

* fix dep

* run the app with docker

* use java 17

* the application is working now.

* add spring student home

* remove helloworld servlet

* improve

* add doc

* add description

* update screenshot

* rename project

* clean up

* remove version specification from docker-compose.yml

* update screenshot

* format image display in README.md for better alignment

* adjust image width in README.md for better alignment

* update Java version requirement to 11 in README.md and manual-setup.md

* align image to the left in README.md for better presentation

* Add new sample for Student Web App using Jakarta EE and update description for existing sample

* Rename back.

* Update README.md to correct directory name for Student Web App

* Fix link formatting for Student Web App in README.md

* Refactor README.md and add getting-started.md for clearer migration instructions and setup guidance

* add migration steps

* Proposed edits to README

* Clarify the extension version

* Update README.md to correct VS Code extension version and add commit instruction

* add libs

* rename package name

* Remove CommonHttpServletFilter and MyBatisUtil classes

* Update resource paths in XML configuration files to reflect new package structure

---------

Signed-off-by: Jianguo Ma <[email protected]>
Co-authored-by: Menghua Xiao <[email protected]>
Co-authored-by: Jianguo Ma <[email protected]>
Co-authored-by: Yi Liu <[email protected]>
Co-authored-by: fangjimmy <[email protected]>
Co-authored-by: Haixia Cheng <[email protected]>
Co-authored-by: Ed Burns <[email protected]>

Author: 7 people

README.md

@@ -8,7 +8,9 @@
 
 - [asset manager](https://github.com/Azure-Samples/java-migration-copilot-samples/tree/main/asset-manager) : This is a complete workshop with an end-to-end scenario that migrates an app to Azure using predefined and custom formulas. After the migration, the app will run on Azure Container Apps and interact with Auzure Blob, Azure Service Bus and Azure Database for PostgreSQL.
 
--[Todo Web API with Oracle Database](https://github.com/Azure-Samples/java-migration-copilot-samples/tree/main/todo-web-api-use-oracle-db) A To-do application using Oracle database for storage. It leverages Oracle-specific SQL features and data types, for instance, VARCHAR2. This sample migrates the application to use Azure Database for PostgreSQL instead.
+- [Todo Web API with Oracle Database](https://github.com/Azure-Samples/java-migration-copilot-samples/tree/main/todo-web-api-use-oracle-db) A To-do application using Oracle database for storage. It leverages Oracle-specific SQL features and data types, for instance, VARCHAR2. This sample migrates the application to use Azure Database for PostgreSQL instead.
+
+- [Student Web App - Jakarta EE](jakarta-ee/student-web-app) A Java EE web application running on Open Liberty with a hybrid architecture that supports both traditional servlets and Spring MVC. The application manages student profiles with CRUD operations and demonstrates migrating from Ant to Maven and Java EE to Jakarta EE. 
 
 ## Branches
 

jakarta-ee/student-web-app/.gitignore

@@ -0,0 +1,30 @@
+target/
+build/
+dist/
+*.war
+
+# IDE files
+.idea/
+*.iml
+.vscode/
+/bin/
+.project
+.classpath
+.settings/
+
+# Local configuration files (contain environment-specific paths)
+local.properties
+liberty_config/server.env
+
+# Compile-time dependencies (can be downloaded)
+compile-lib/*.jar
+
+# Docker files
+mysql-connector/
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Log files
+*.log

jakarta-ee/student-web-app/Dockerfile

@@ -0,0 +1,33 @@
+FROM open-liberty:25.0.0.7-kernel-slim-java17-openj9
+
+# Copy Liberty configuration
+COPY --chown=1001:0 liberty_config/server-docker.xml /config/server.xml
+COPY --chown=1001:0 liberty_config/server-docker.env /config/server.env
+
+# Copy application
+COPY --chown=1001:0 dist/OpenLibertyApp.war /config/apps/
+
+# Create directories for libraries
+RUN mkdir -p /opt/ol/wlp/usr/shared/resources/mysql
+
+# Copy MySQL connector for JDBC driver
+COPY --chown=1001:0 mysql-connector/mysql-connector-j-8.0.33.jar /opt/ol/wlp/usr/shared/resources/mysql/
+
+# Configure Liberty features
+RUN features.sh
+
+# Expose ports
+EXPOSE 9080 9443
+
+# Set environment variables for Docker environment
+ENV WLP_USER_DIR=/opt/ol/wlp/usr \
+    SERVER_NAME=defaultServer \
+    MYSQL_LIB_DIR=/opt/ol/wlp/usr/shared/resources/mysql \
+    LIBERTY_SERVER_DIR=/config \
+    KEYSTORE_LOCATION=/config/resources/security/key.p12 \
+    KEYSTORE_PASSWORD=defaultPassword \
+    TRUSTED_KEYSTORE_LOCATION=/config/resources/security/trust.p12 \
+    TRUSTED_KEYSTORE_PASSWORD=defaultPassword \
+    LTPA_KEY_FILE_SFA=/config/resources/security/ltpa.keys \
+    LTPA_KEY_PASSWORD_SFA=defaultPassword \
+    JDBC_DRIVER_CLASS=com.mysql.cj.jdbc.Driver

jakarta-ee/student-web-app/README.md

@@ -0,0 +1,77 @@
+# Migrate a legacy Java EE Ant project to a Jakarta EE 10 Maven project
+
+This workshop guides you through migrating a legacy Java EE Ant project to a Jakarta EE 10 Maven project. After completing the workshop, the project will be fully migrated from Java EE to Jakarta EE 10, upgraded from Spring Framework 5.3.39 to 6.2.x, and ready to build with Maven.
+
+## About this Sample Project
+
+A Java EE web application running on Open Liberty with a hybrid architecture that supports both traditional servlets and Spring MVC. The application manages student profiles with CRUD operations and demonstrates migrating from Ant to Maven and Java EE to Jakarta EE. 
+
+For the project architecture, see [project details](doc/architecture.md).
+For how to start this project, see [getting started](doc/getting-started.md)
+
+## Prerequisites
+
+- **Java 17** or higher
+- **Apache Ant**, tested version: `1.10.14`.
+- **Maven**, tested version: `3.8.7`.
+- **Docker & Docker Compose** (Optional, for running the sample application)
+- [Visual Studio Code](https://code.visualstudio.com/download)
+- [VS Code Extension: GitHub Copilot App Modernization](https://marketplace.visualstudio.com/items?itemName=vscjava.migrate-java-to-azure). Make sure the version is higher than `1.2.1`; if not, switch to a pre-release version.
+  - This extension depends on [VS Code Extension: GitHub Copilot App Modernization – Upgrade for Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-upgrade). Both extensions will be installed automatically when you install **GitHub Copilot App Modernization**.
+
+## Assess the Project
+
+Please follow the steps below to assess and detect the Eclipse/Ant project:
+
+1. Open [student-web-app](jakarta-ee/student-web-app) in VSCode.
+
+1. Click **GitHub Copilot app modernization for Java** from the left side tool bar.
+
+    Click the `Toggle Chat` icon on the top, select `Agent` mode. If the **reload button** (looks like an arrow going counter clockwise) appears at the bottom, click it to reload the tools registration. This is only required the first time you install the extensions.
+
+    ![assessment-start](assets/assessment-start.png)
+
+1. Click **Run Assessment** button from the **Assessment** section on the left side view. It will open GitHub Copilot Chat window at the right side, and start to assess the project with the predefined prompt. 
+
+1. Interact with Copilot in the chat window and select **Continue** to proceed whenever you're ok with the actions suggested by the Copilot.
+
+1. After the assessment is done, an **Assessment Report** will be generated and opened in the editor. From the bottom of the report, you can see **Build Tool (Ant)** in section **Java Modernization**, and associated action **Migrate** to migrate the project to Maven project.
+
+    ![assessment-ant-to-maven-solution](assets/assessment-ant-to-maven-solution.png)
+
+## Convert Ant project to Maven project
+
+Now you can convert the Ant project to Maven project.
+
+1. Select Action **Migrate** associated with **Build Tool (Ant)**, and start the migration with the predefined prompt. We recommend using the LLM model **Claude Sonnet 3.7** for the migration.
+
+    ![convert-ant-to-maven](assets/convert-ant-to-maven.png)
+
+1. Interact with Copilot in the chat window and select **Continue** to proceed whenever you're ok with the actions suggested by the Copilot.
+
+    If you see the request from Copilot to ask you confirm the migration plan, please review and manually confirm the migration plan before proceeding. For example, input `Confirm` in the chat box and click `Send`.
+
+1. After the migration is complete, select **Keep** for changed files.
+
+1. Commit changes if they have not been committed.
+
+## Assess and detect the legacy Java EE and Spring Framework project
+
+Please follow the similar steps before to assess and detect the legacy Java EE and Spring Framework project:
+
+1. Select **GitHub Copilot app modernization for Java** from the left side tool bar.
+1. Select **Run Assessment** from the **Assessment** section. It will open GitHub Copilot Chat window at the right side, and start to assess the project with the predefined prompt. 
+1. Interact with Copilot in the chat window and select **Continue** to proceed whenever you're ok with the actions suggested by the Copilot.
+1. After the assessment is done, an **Assessment Report** will be generated and opened in the editor. From the bottom of the report, you can see **Framework Upgrade (Java EE/Jakarta EE)** and **Framework Upgrade (Spring Framework)** in section **Java Modernization**, and associated action **Upgrade** to upgrade the project.
+
+## Upgrade the Project to Jakarta EE 10 and Spring Framework 6.x
+
+Now you can upgrade the project. In this workshop, you select to upgrade Spring Framework version as it will also upgrade dependent Java EE version.
+
+1. Select Action **Upgrade** associated with **Upgrade Spring Framework Version**, and start the upgrade with the predefined prompt. Recommend to use LLM model **Claude Sonnet 3.7** for the migration.
+1. Interact with Copilot in the chat window and select **Continue** to proceed whenever you're ok with the actions suggested by the Copilot.
+1. After the migration is complete, select **Keep** if there are any changed files.
+
+There is an Upgrade Summary generated, review and do any follow-up actions based on your needs.
+
+

jakarta-ee/student-web-app/WebContent/WEB-INF/applicationContext.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns:context="http://www.springframework.org/schema/context"
+       xsi:schemaLocation="http://www.springframework.org/schema/beans
+                           http://www.springframework.org/schema/beans/spring-beans.xsd
+                           http://www.springframework.org/schema/context
+                           http://www.springframework.org/schema/context/spring-context.xsd">
+
+    <!-- Enable component scanning -->
+    <context:component-scan base-package="org.sample.azure.student.coreft.service"/>
+    <context:component-scan base-package="org.sample.azure.student.coreft.dao"/>
+
+    <!-- Service and DAO beans will be auto-discovered -->
+
+</beans>