Skip to content

Commit f25f108

Browse files
authored
Merge pull request #301164 from haoozhang/haoozhang-rm-airsonic
[AppCAT Java] Replace airsonic war sample application and update report sections
2 parents 4476d45 + fc0d428 commit f25f108

File tree

6 files changed

+27
-20
lines changed

6 files changed

+27
-20
lines changed

articles/migrate/appcat/java-preview.md

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -290,8 +290,6 @@ The `--input` flag should point to a file or directory containing XML rules, and
290290
> [!NOTE]
291291
> Ensure that the file permissions for scripts in the extracted folder are set to allow execution.
292292
293-
In the **samples** folder, you can find a sample web application called **airsonic.war**. Airsonic is a web-based media streamer, providing access to your music and enabling you to share it with friends. To learn more about Airsonic, see [Airsonic](https://github.com/airsonic/airsonic).
294-
295293
In the **samples** directory, you can find the following scripts to run different types of analysis:
296294

297295
- **run-assessment**: Provides a report with code assessment and steps for migrating Airsonic to Azure App Service on Tomcat.
@@ -300,18 +298,29 @@ In the **samples** directory, you can find the following scripts to run differen
300298
- **run-assessment-openjdk21**: Generates a report with code assessment and steps for migrating Airsonic to OpenJDK 21.
301299
- **run-assessment-package-only**: Produces a report by assessing specific packages.
302300

303-
Depending on your operating system, run the appropriate script, as shown in the following example:
301+
These scripts are intended to be used with the [Airsonic-Advanced](https://github.com/airsonic-advanced/airsonic-advanced) sample project - a community-driven, web-based media streamer that enables you to access and share your music collection.
302+
303+
You can clone the application repository manually using the following command:
304+
305+
```sh
306+
git clone https://github.com/airsonic-advanced/airsonic-advanced.git
307+
```
308+
309+
After cloning, provide the path to the cloned folder when running the assessment scripts. Depending on your operating system, run the appropriate script, as shown in the following example:
310+
311+
> [!NOTE]
312+
> Make sure you have cloned the Airsonic Advanced project to a local path before running the scripts.
304313
305314
# [Linux / macOS](#tab/linux)
306315

307316
```bash
308-
./samples/run-assessment
317+
./samples/run-assessment <path-to-airsonic-advanced>
309318
```
310319

311320
# [Windows](#tab/windows)
312321

313322
```cmd
314-
.\samples\run-assessment.bat
323+
.\samples\run-assessment.bat <path-to-airsonic-advanced>
315324
```
316325

317326
---
@@ -320,31 +329,29 @@ The reports are automatically generated and launched. You can find the reports u
320329

321330
### Summary of the analysis
322331

323-
The landing page of the report lists all the technologies that are used in the application. The dashboard provides a summary of the analysis, including the number of transformation incidents, the incidents categories, or the story points.
332+
The landing page of the report presents a summary view of all analyzed applications. From here, you can navigate to individual application reports to explore detailed findings.
324333

325334
:::image type="content" source="media/java/appcat-7-report-summary.png" alt-text="Screenshot of the appcat summary report." lightbox="media/java/appcat-7-report-summary.png":::
326335

327-
When you zoom in on the **Incidents by Category** pie chart, you can see the number of incidents by category: **Mandatory**, **Optional**, and **Potential**.
328-
329-
The dashboard also shows the *story points*. The story points are an abstract metric commonly used in Agile software development to estimate the level of effort needed to implement a feature or change. `appcat` uses story points to express the level of effort needed to migrate a particular application. Story points don't necessarily translate to work hours, but the value should be consistent across tasks.
330-
331-
:::image type="content" source="media/java/appcat-7-report-summary-incident.png" alt-text="Screenshot of the AppCAT summary incident report." lightbox="media/java/appcat-7-report-summary-incident.png":::
336+
The **Ask Copilot** button in the upper-right corner redirects you to the GitHub Copilot App Modernization for Java extension in Visual Studio Code. This extension provides both app assessment and code remediation as its key capabilities for migrating Java applications to Azure - powered by AppCAT and GitHub Copilot's AI capabilities.
332337

333338
### Assessment report
334339

335-
The assessment report gives an overview of the transformation issues that would need to be solved to migrate the application to Azure.
340+
The assessment report provides a categorized issue list of various aspects of Azure readiness, cloud native, and Java modernization that you need to address to successfully migrate the application to Azure.
341+
342+
Each *Issue* is categorized by severity - **Mandatory**, **Optional**, or **Potential** - and includes the number of impacted lines of code.
336343

337-
These *Issues*, also called *Incidents*, have a severity (*Mandatory*, *Optional*, or *Potential*), a level of effort, and a number indicating the story points. The story points are determined by calculating the number of incidents times the effort required to address the issue.
344+
The **Dependencies** and **Technologies** tabs display the libraries and technologies used within the application.
338345

339346
:::image type="content" source="media/java/appcat-7-report-assessment.png" alt-text="Screenshot of the AppCAT assessment report." lightbox="media/java/appcat-7-report-assessment.png":::
340347

341348
### Detailed information for a specific issue
342349

343-
For each incident, you can get more information (the issue detail, the content of the rule, and so on) just by selecting it. You also get the list of all the files affected by this incident.
350+
For each issue, you can get more information (the issue detail, the content of the rule, and so on) just by selecting it. You also get the list of all the files affected by this issue.
344351

345352
:::image type="content" source="media/java/appcat-7-report-assessment-detail.png" alt-text="Screenshot of the AppCAT issue detail report." lightbox="media/java/appcat-7-report-assessment-detail.png":::
346353

347-
Then, for each file or class affected by the incident, you can jump into the source code to highlight the line of code that created the issue.
354+
Then, for each file or class affected by the issue, you can jump into the source code to highlight the line of code that created the issue.
348355

349356
:::image type="content" source="media/java/appcat-7-report-assessment-code.png" alt-text="Screenshot of the AppCAT issue code report." lightbox="media/java/appcat-7-report-assessment-code.png":::
350357

@@ -460,7 +467,7 @@ This release contains the following fixes and includes a set of new rules.
460467

461468
### 6.3.0.8
462469

463-
Previously, a set of targets were enabled by default, making it difficult for certain customers to assess large applications with too many incidents related to less critical issues. To reduce noise in reports, users must now specify multiple targets, with the parameter `--target`, when executing `appcat`, giving them the option to select only the targets that matter.
470+
Previously, a set of targets were enabled by default, making it difficult for certain customers to assess large applications with too many issues related to less critical issues. To reduce noise in reports, users must now specify multiple targets, with the parameter `--target`, when executing `appcat`, giving them the option to select only the targets that matter.
464471

465472
### 6.3.0.7
466473

@@ -495,7 +502,7 @@ GA (Generally Available) release of Azure Migrate application and code assessmen
495502
- Rules issues:
496503
- `azure-system-config-01000`, `http-session-01000` rules aren't being triggered.
497504
- `FileSystem - Java IO` rule isn't being triggered.
498-
- Analyzing WAR files on Windows produces the following error: `Failed to Move Decompiled File`. An error occurs when analyzing WAR files on Windows, which is responsible for a few redundant incidents created on Windows OS.
505+
- Analyzing WAR files on Windows produces the following error: `Failed to Move Decompiled File`. An error occurs when analyzing WAR files on Windows, which is responsible for a few redundant issues created on Windows OS.
499506
- Error in Watcher Error channel on Windows: `Windows system assumed buffer larger than it is, events have likely been missed`. This error message appears on the command line during long-running jobs on Windows.
500507
- <kbd>Ctrl</kbd>+<kbd>C</kbd> fails to stop ongoing analysis. To work around, manually terminate the process by explicitly killing the process.
501508
- In binary analysis reports, the code snippet title shows an incorrect or nonexistent file path.
@@ -506,7 +513,7 @@ GA (Generally Available) release of Azure Migrate application and code assessmen
506513
- Rules issues:
507514
- `azure-system-config-01000`, `http-session-01000` rules aren't being triggered.
508515
- `FileSystem - Java IO` rule isn't being triggered.
509-
- Analyzing WAR files on Windows produces the following error: `Failed to Move Decompiled File`. An error occurs when analyzing WAR files on Windows, which is responsible for a few redundant incidents created on Windows OS.
516+
- Analyzing WAR files on Windows produces the following error: `Failed to Move Decompiled File`. An error occurs when analyzing WAR files on Windows, which is responsible for a few redundant issues created on Windows OS.
510517
- Error in Watcher Error channel on Windows: `Windows system assumed buffer larger than it is, events have likely been missed`. This error message appears on the command line during long-running jobs on Windows.
511518
- <kbd>Ctrl</kbd>+<kbd>C</kbd> fails to stop ongoing analysis. To work around, manually terminate the process by explicitly killing the process.
512519
- In binary analysis reports, the code snippet title shows an incorrect or nonexistent file path.
@@ -517,7 +524,7 @@ GA (Generally Available) release of Azure Migrate application and code assessmen
517524
- Rules issues:
518525
- `azure-system-config-01000`, `http-session-01000`, `java-removals-00150` rules aren't being triggered.
519526
- `FileSystem - Java IO` rule isn't being triggered.
520-
- Analyzing WAR files on Windows produces the following error: `Failed to Move Decompiled File`. An error occurs when analyzing WAR files on Windows, which is responsible for a few redundant incidents created on Windows OS.
527+
- Analyzing WAR files on Windows produces the following error: `Failed to Move Decompiled File`. An error occurs when analyzing WAR files on Windows, which is responsible for a few redundant issues created on Windows OS.
521528
- Error in Watcher Error channel on Windows: `Windows system assumed buffer larger than it is, events have likely been missed`. This error message appears on the command line during long-running jobs on Windows.
522529
- <kbd>Ctrl</kbd>+<kbd>C</kbd> fails to stop ongoing analysis. To work around, manually terminate the process by explicitly killing the process.
523530
- In binary analysis reports, the code snippet title shows an incorrect or nonexistent file path.
@@ -537,7 +544,7 @@ GA (Generally Available) release of Azure Migrate application and code assessmen
537544
- `azure-system-config-01000`, `http-session-01000`, `java-removals-00150` rules aren't being triggered.
538545
- `FileSystem - Java IO` rule isn't being triggered.
539546
- Error `unable to parse all the rules for ruleset` when running analysis. This error occurs during analysis when the tool fails to parse all rules in the ruleset.
540-
- Analyzing WAR files on Windows produces the following error: `Failed to Move Decompiled File`. An error occurs when analyzing WAR files on Windows, which is responsible for a few redundant incidents created on Windows OS.
547+
- Analyzing WAR files on Windows produces the following error: `Failed to Move Decompiled File`. An error occurs when analyzing WAR files on Windows, which is responsible for a few redundant issues created on Windows OS.
541548
- Missing descriptions for some rules on the **Insights** tab. Some tag rules are lacking descriptions, leading to blank titles appearing on the **Insights** tab of the report.
542549
- Error in **Watcher Error** channel on Windows: `Windows system assumed buffer larger than it is, events have likely been missed`. This error message appears on the command line during long-running jobs on Windows.
543550
- This release requires an active internet connection for dependency analysis.
99.2 KB
Loading
64.3 KB
Loading
-30.8 KB
Loading
Binary file not shown.
-39.8 KB
Loading

0 commit comments

Comments
 (0)