Merge pull request #301607 from taoxu0903/patch-22

AppCAT 7 GA

Author: JamesJBarnett

articles/migrate/appcat/TOC.yml

@@ -1,23 +1,39 @@
 items:
-- name: Azure Migrate application and code assessment
-  href: index.yml
-- name: Overview
-  expanded: true
-  items: 
+  - name: Azure Migrate application and code assessment
+    href: index.yml
   - name: Overview
     href: overview.md
   - name: Assess Java applications and code
-    href: java.md
-  - name: Assess Java applications and code version 7 (Preview)
-    href: java-preview.md
+    expanded: true
+    items:
+      - name: Assess Java applications and code version 7
+        expanded: true
+        items:
+          - name: Overview
+            href: java.md
+          - name: Release notes
+            href: appcat-7-release-notes.md
+          - name: "Quickstart: Assess a Java project"
+            href: appcat-7-quickstart.md
+          - name: Interpret the report
+            href: appcat-7-interpret-report.md
+          - name: CLI guide
+            href: appcat-7-cli-guide.md
+          - name: Rule development guide
+            href: appcat-7-rule-guide.md
+      - name: Assess Java applications and code version 6 (not recommended)
+        expanded: true
+        items:
+          - name: Assess Java applications and code
+            href: java-6.md
+          - name: CLI usage guide
+            href: https://azure.github.io/appcat-docs/cli/
+          - name: Rules development guide
+            href: https://azure.github.io/appcat-docs/rules-development-guide/
   - name: Assess .NET applications and code
     href: dotnet.md
-- name: Resources
-  expanded: true
-  items:
-  - name: FAQ
-    href: faq.yml
-  - name: CLI usage guide
-    href: https://azure.github.io/appcat-docs/cli/
-  - name: Rules development guide
-    href: https://azure.github.io/appcat-docs/rules-development-guide/
+  - name: Resources
+    expanded: true
+    items:
+      - name: FAQ
+        href: faq.yml

articles/migrate/appcat/appcat-7-cli-guide.md

@@ -0,0 +1,85 @@
+---
+title: Interpret the AppCAT 7 Report
+description: Learn how to interpret the AppCAT report.
+author: KarlErickson
+ms.author: karler
+ms.reviewer: brborges
+ms.service: azure
+ms.custom: devx-track-java, build-2025
+ms.topic: overview
+ms.date: 06/27/2025
+#customer intent: As a developer, I want to assess my Java application so that I can understand its readiness for migration to Azure.
+---
+
+# Interpret the AppCAT 7 report
+
+This article guides you through the AppCAT report to help you understand it for assessing the readiness of your Java application for migration to Azure. The report provides a comprehensive overview of the application and its components. You can use this report to gain insights into the structure and dependencies of the application and to determine its suitability for replatforming and modernization.
+
+## Application list view
+
+The landing page of the report presents an overall view of all analyzed applications. From here, you can navigate to individual application reports to explore detailed findings.
+
+:::image type="content" source="media/java/appcat-7-report-app-list.png" alt-text="Screenshot of the AppCAT assessment report Applications list." lightbox="media/java/appcat-7-report-app-list.png":::
+
+## Application view
+
+The application report consists of the following three sections:
+
+- **Application Information**: reveals the basic information of your application including Java version, framework, build tool, and so on.
+- **Issue Summary**: shows the issue overview for three domains with percentages for issue criticality.
+- The detail report is organized into the following four subsections:
+  - **Issues**: Provides a concise summary of all issues that require attention.
+  - **Dependencies**: Displays all Java-packaged dependencies found within the application.
+  - **Technologies**: Displays all embedded libraries grouped by functionality, enabling you to quickly view the technologies used in the application.
+  - **Insights**: Displays file details and information to help you understand the detected technologies.
+
+:::image type="content" source="media/java/appcat-7-report-app.png" alt-text="Screenshot of the AppCAT assessment report." lightbox="media/java/appcat-7-report-app.png":::
+
+### Issues
+
+Access this part by selecting the **Issues** tab. This tab provides a categorized issues list of various aspects of Azure readiness, cloud native, and Java modernization that you need to address to successfully migrate the application to Azure. The following tables describe the **Domain** and **Criticality** values:
+
+| Domain             | Description                                                                                     |
+|--------------------|-------------------------------------------------------------------------------------------------|
+| Azure readiness    | Identifies app dependencies and suggests equivalent Azure solutions.                            |
+| cloud native       | Assesses how well the app follows cloud-native practices like scalability and containerization. |
+| Java modernization | Identifies JDK and framework issues for version upgrade.                                        |
+
+| Criticality | Description                                                 |
+|-------------|-------------------------------------------------------------|
+| Mandatory   | Issues that must be fixed for migration to Azure.           |
+| Potential   | Issues that might impact migration and need review.         |
+| Optional    | Low-impact issues. Fixing them is recommended but optional. |
+
+:::image type="content" source="media/java/appcat-7-report-issues.png" alt-text="Screenshot of the AppCAT assessment report Issues tab." lightbox="media/java/appcat-7-report-issues.png":::
+
+For more information, you can expand each reported issue by selecting the title. The report provides the following information:
+
+- A list of files where the incidents occurred, along with the number of code lines impacted. If the file is a Java source file, then selecting the filename directs you to the corresponding source report.
+- A detailed description of the issue. This description outlines the problem, provides any known solutions, and references supporting documentation regarding either the issue or resolution.
+
+:::image type="content" source="media/java/appcat-7-report-issue-detail.png" alt-text="Screenshot of the AppCAT assessment report issue details." lightbox="media/java/appcat-7-report-issue-detail.png":::
+
+:::image type="content" source="media/java/appcat-7-report-issue-code.png" alt-text="Screenshot of the AppCAT assessment issue code report." lightbox="media/java/appcat-7-report-issue-code.png":::
+
+### Technologies
+
+Access this part by selecting the **Technologies** tab. The report lists the occurrences of technologies, grouped by function, in the analyzed application. This report is an overview of the technologies found in the application, and is designed to assist you in quickly understanding each application's purpose.
+
+:::image type="content" source="media/java/appcat-7-report-technologies.png" alt-text="Screenshot of the AppCAT assessment report Technologies tab." lightbox="media/java/appcat-7-report-technologies.png":::
+
+### Dependencies
+
+Access this part by selecting the **Dependencies** tab. Displays all Java-packaged dependencies found within the application.
+
+:::image type="content" source="media/java/appcat-7-report-dependencies.png" alt-text="Screenshot of the AppCAT assessment report Dependencies tab." lightbox="media/java/appcat-7-report-dependencies.png":::
+
+### Insights
+
+Access this part by selecting the **Insights** tab. Displays file details and information to help you understand the detected technologies.
+
+:::image type="content" source="media/java/appcat-7-report-insights.png" alt-text="Screenshot of the AppCAT assessment report Insights tab." lightbox="media/java/appcat-7-report-insights.png":::
+
+## Next steps
+
+- [CLI Command Guide for AppCAT 7](appcat-7-cli-guide.md)

articles/migrate/appcat/appcat-7-interpret-report.md

@@ -0,0 +1,121 @@
+---
+title: "Quickstart: Assess a Java Project using AppCAT 7"
+description: Learn how to assess a Java project using AppCAT 7.
+author: KarlErickson
+ms.author: karler
+ms.reviewer: brborges
+ms.service: azure
+ms.custom: devx-track-java, build-2025
+ms.topic: overview
+ms.date: 06/27/2025
+#customer intent: As a developer, I want to assess my Java application so that I can understand its readiness for migration to Azure.
+---
+
+# Quickstart: Assess a java project using AppCAT 7
+
+This quickstart shows you how to download, install, and run AppCAT 7 against a sample Java project.
+
+## Prerequisites
+
+Before downloading AppCAT, be sure the JDK is installed and configured correctly.
+
+- [The Microsoft Build of OpenJDK 17](/java/openjdk/install). Ensure that the `JAVA_HOME` environment variable is set.
+
+## Download and install
+
+To use the `appcat` CLI, you must download the package specific to your environment, and have the required dependencies in your environment. The `appcat` CLI runs on any environment such as Windows, Linux, or Mac, using Intel, Arm, or Apple Silicon hardware. For the JDK requirement, we recommend you use the [Microsoft Build of OpenJDK](/java/openjdk).
+
+| OS      | Architecture    | Download Link  | Other files              |
+|---------|-----------------|----------------|--------------------------|
+| *x64*
+| Windows | x64             | [Download][13] | [sha256][14] / [sig][15] |
+| macOS   | x64             | [Download][7]  | [sha256][8] / [sig][9]   |
+| Linux   | x64             | [Download][1]  | [sha256][2] / [sig][3]   |
+| *AArch64*
+| Windows | AArch64 / ARM64 | [Download][16] | [sha256][17] / [sig][18] |
+| macOS   | Apple Silicon   | [Download][10] | [sha256][11] / [sig][12] |
+| Linux   | AArch64 / ARM64 | [Download][4]  | [sha256][5] / [sig][6]   |
+
+[1]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-linux-amd64.tar.gz
+[2]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-linux-amd64.tar.gz.sha256sum.txt
+[3]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-linux-amd64.tar.gz.sig
+[4]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-linux-arm64.tar.gz
+[5]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-linux-arm64.tar.gz.sha256sum.txt
+[6]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-linux-arm64.tar.gz.sig
+[7]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-macos-amd64.tar.gz
+[8]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-macos-amd64.tar.gz.sha256sum.txt
+[9]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-macos-amd64.tar.gz.sig
+[10]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-macos-arm64.tar.gz
+[11]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-macos-arm64.tar.gz.sha256sum.txt
+[12]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-macos-arm64.tar.gz.sig
+[13]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-windows-amd64.zip
+[14]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-windows-amd64.zip.sha256sum.txt
+[15]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-windows-amd64.zip.sig
+[16]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-windows-arm64.zip
+[17]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-windows-arm64.zip.sha256sum.txt
+[18]: https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-windows-arm64.zip.sig
+
+To install `appcat`, download the appropriate zip file for your platform. After you download the file, depending on your operating system, you should find either a **.tar.gz** (Linux/macOS) or **.zip** file (Windows).
+
+Extract the binary from the downloaded file. You should see the following folder structure:
+
+```
+/azure-migrate-appcat-for-java-cli-<OS>-<architecture>-<release-version>/
+├── appcat.exe (Windows) / appcat (Linux/macOS)
+├── samples/
+├── fernflower.jar
+├── LICENSE
+├── NOTICE.txt
+├── maven.default.index
+├── jdtls/
+├── static-report/
+├── rulesets/
+├── readme.md
+└── readme.html
+```
+
+## Run AppCAT against a sample Java project
+
+In following steps, you do an application assessment using AppCAT against [Airsonic-Advanced](https://github.com/airsonic-advanced/airsonic-advanced) - a community-driven, web-based media streamer that enables you to access and share your music collection.
+
+1. To run `appcat` from any location in your terminal, extract the archive to your desired location. Then, update the `PATH` environment variable to include the directory where you extracted the archive.
+
+   > [!NOTE]
+   > When the `appcat` binary is called, it first looks for its dependencies in the executable folder specified in the `PATH` environment variable. If the dependencies aren't found, it falls back to the user's home directory - **~/.appcat** on Linux/Mac or **%USERPROFILE%\\.appcat** on Windows.
+
+1. Clone the application repository to a local folder using the following command:
+
+   ```sh
+   git clone https://github.com/airsonic-advanced/airsonic-advanced.git
+   ```
+
+1. Run the assessment scripts in the samples folder of the downloaded AppCAT release package by providing the path to the cloned folder from the previous step. Depending on your operating system, run the appropriate script, as shown in the following example. The reports are automatically generated and opened in your web browser. You can find the reports under **../samples/report-\*** (Linux/macOS) or **..\samples\report-\*** (Windows).
+
+   ### [Linux / macOS](#tab/linux)
+
+   ```bash
+   ./samples/run-assessment <path-to-airsonic-advanced>
+   ```
+
+   ### [Windows](#tab/windows)
+
+   ```cmd
+   .\samples\run-assessment.bat <path-to-airsonic-advanced>
+   ```
+
+> [!NOTE]
+> Ensure that the file permissions for scripts in the extracted folder are set to allow execution.
+
+In the **samples** directory, you can find the following scripts to run different types of analysis:
+
+- **run-assessment**: Provides a report with code assessment and steps for migrating Airsonic to Azure App Service on Tomcat.
+- **run-assessment-transform-rules**: Converts Windup XML rules to analyzer-lsp-compatible YAML rules.
+- **run-assessment-custom-rules**: Provides a code assessment report using custom rules *transform XML to YAML*.
+- **run-assessment-openjdk21**: Generates a report with code assessment and steps for migrating Airsonic to OpenJDK 21.
+- **run-assessment-package-only**: Produces a report by assessing specific packages.
+
+## Next steps
+
+- [Interpret the AppCAT 7 report](appcat-7-interpret-report.md)
+- [CLI command guide for AppCAT 7](appcat-7-cli-guide.md)
+- [Rules development guide for AppCAT 7](appcat-7-rule-guide.md)