From 2c90f35142b0967a7e22e6687ebe8c10cd0087fa Mon Sep 17 00:00:00 2001 From: "A.Arnold" Date: Fri, 14 Mar 2025 14:29:09 +0000 Subject: [PATCH 01/12] MTA-4775: Effort differs between applications depending on whether they can be built or not Signed-off-by: A.Arnold --- docs/cli-guide/master.adoc | 7 +++++-- docs/topics/issues-with-report.adoc | 17 +++++++++++++++++ 2 files changed, 22 insertions(+), 2 deletions(-) create mode 100644 docs/topics/issues-with-report.adoc diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index 0c9b41d6..38685767 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -66,11 +66,11 @@ include::topics/mta-cli-run-single-app.adoc[leveloffset=+3] include::topics/mta-cli-run-multiple-apps.adoc[leveloffset=+3] +include::topics/proc_running-the-containerless-mta-cli.adoc[leveloffset=+3] + // Analyze application source code include::topics/mta-cli-analyze.adoc[leveloffset=+3] -include::topics/proc_running-the-containerless-mta-cli.adoc[leveloffset=+3] - // Transform XML rules to YAML include::topics/mta-cli-transform.adoc[leveloffset=+3] @@ -104,6 +104,9 @@ include::topics/mta-review-reports.adoc[leveloffset=+1] // Optimize {ProductShortName} Performance include::topics/mta-optimize-performance.adoc[leveloffset=+1] +// Issues with reports +include::topics/issues-with-report.adoc[leveloffset=+2] + // Configure {ProductShortName} to Exclude Files and Packages // include::topics/mta-exclude-files-and-packages.adoc[leveloffset=+2] diff --git a/docs/topics/issues-with-report.adoc b/docs/topics/issues-with-report.adoc new file mode 100644 index 00000000..09db58c7 --- /dev/null +++ b/docs/topics/issues-with-report.adoc @@ -0,0 +1,17 @@ +// Module included in the following assemblies: +// +// * docs/cli-guide/master.adoc + +:_content-type: CONCEPT +[id="issues-with-report_{context}"] += Issues with reports + +.Running {ProductShortName} on a project with an inaccessible parent pom.xml file may not result in a full analysis + +Running {ProductFullName} on a project with an inaccessible parent pom.xml file may not result in a full analysis. For example, this issue impacts the link:https://github.com/jboss-developer/jboss-eap-quickstarts/tree/EAP_7.4.0.GA[JBoss EAP Quickstarts], which demonstrate JBoss EAP, Jakarta EE 10, and other additional technologies. They provide small, specific, working examples that can be used as a reference for your project. However, these quickstarts specify a relative path to their parent POM file, which does not exist when the {ProductShortName} container is run. + +Specifying an input path of link:https://github.com/jboss-developer/jboss-eap-quickstarts/tree/EAP_7.4.0.GA/kitchensink[`kitchensink`] mounts the `kitchensink` directory as a volume in the container, but that means that the JDT Language Server (jdtls) is unable to access the parent link:https://github.com/jboss-developer/jboss-eap-quickstarts/blob/EAP_7.4.0.GA/kitchensink/pom.xml[pom.xml] file. + +This causes the jdtls to encounter a `Non-resolvable parent POM for org.jboss.eap.quickstarts:kitchensink:7.4.0.GA error` project build error. This error creates a `.project` file, which is missing the `org.eclipse.jdt.core.javanature`, meaning that jdtls, and subsequently {ProductShortName}, is unable to access details about the Java files. + +If you remove the parent pom.xml file and make the `kitchensink` project completely standalone, there are no issues. From 79ce22da7b4e522480d2a59770b2ccc1362a7174 Mon Sep 17 00:00:00 2001 From: "A.Arnold" Date: Fri, 14 Mar 2025 14:37:25 +0000 Subject: [PATCH 02/12] update Signed-off-by: A.Arnold --- docs/topics/issues-with-report.adoc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/topics/issues-with-report.adoc b/docs/topics/issues-with-report.adoc index 09db58c7..be69a425 100644 --- a/docs/topics/issues-with-report.adoc +++ b/docs/topics/issues-with-report.adoc @@ -6,6 +6,11 @@ [id="issues-with-report_{context}"] = Issues with reports +Analysis precision is lower when the project cannot be built for whatever reasons. This lowering of precision can be caused by a number of factors; + +* The lack of a proper build file, for example, a `pom.xml` or `build.gradle` file +* Compilation errors of one form or another + .Running {ProductShortName} on a project with an inaccessible parent pom.xml file may not result in a full analysis Running {ProductFullName} on a project with an inaccessible parent pom.xml file may not result in a full analysis. For example, this issue impacts the link:https://github.com/jboss-developer/jboss-eap-quickstarts/tree/EAP_7.4.0.GA[JBoss EAP Quickstarts], which demonstrate JBoss EAP, Jakarta EE 10, and other additional technologies. They provide small, specific, working examples that can be used as a reference for your project. However, these quickstarts specify a relative path to their parent POM file, which does not exist when the {ProductShortName} container is run. From 41fa4f30ea91263983dbad21ceeec651d3c44e3d Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 14 Mar 2025 14:46:46 +0000 Subject: [PATCH 03/12] Update docs/topics/issues-with-report.adoc --- docs/topics/issues-with-report.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/issues-with-report.adoc b/docs/topics/issues-with-report.adoc index be69a425..c5aa81dd 100644 --- a/docs/topics/issues-with-report.adoc +++ b/docs/topics/issues-with-report.adoc @@ -17,6 +17,6 @@ Running {ProductFullName} on a project with an inaccessible parent pom.xml file Specifying an input path of link:https://github.com/jboss-developer/jboss-eap-quickstarts/tree/EAP_7.4.0.GA/kitchensink[`kitchensink`] mounts the `kitchensink` directory as a volume in the container, but that means that the JDT Language Server (jdtls) is unable to access the parent link:https://github.com/jboss-developer/jboss-eap-quickstarts/blob/EAP_7.4.0.GA/kitchensink/pom.xml[pom.xml] file. -This causes the jdtls to encounter a `Non-resolvable parent POM for org.jboss.eap.quickstarts:kitchensink:7.4.0.GA error` project build error. This error creates a `.project` file, which is missing the `org.eclipse.jdt.core.javanature`, meaning that jdtls, and subsequently {ProductShortName}, is unable to access details about the Java files. +This causes the jdtls to encounter a `Non-resolvable parent POM` project build error. This error creates a `.project` file, which is missing the `org.eclipse.jdt.core.javanature`, meaning that jdtls, and subsequently {ProductShortName}, is unable to access details about the Java files. If you remove the parent pom.xml file and make the `kitchensink` project completely standalone, there are no issues. From cc4c79bf43102515adb35470f82a289147fe21b1 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 14 Mar 2025 14:52:19 +0000 Subject: [PATCH 04/12] Update docs/cli-guide/master.adoc --- docs/cli-guide/master.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index 38685767..16488d08 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -105,7 +105,7 @@ include::topics/mta-review-reports.adoc[leveloffset=+1] include::topics/mta-optimize-performance.adoc[leveloffset=+1] // Issues with reports -include::topics/issues-with-report.adoc[leveloffset=+2] +include::topics/issues-with-report.adoc[leveloffset=+1] // Configure {ProductShortName} to Exclude Files and Packages // include::topics/mta-exclude-files-and-packages.adoc[leveloffset=+2] From 06d7886abf243dc62e04466564a48a5555ce147c Mon Sep 17 00:00:00 2001 From: "A.Arnold" Date: Fri, 14 Mar 2025 14:54:22 +0000 Subject: [PATCH 05/12] add Signed-off-by: A.Arnold --- docs/cli-guide/master.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index 16488d08..380efaff 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -66,11 +66,11 @@ include::topics/mta-cli-run-single-app.adoc[leveloffset=+3] include::topics/mta-cli-run-multiple-apps.adoc[leveloffset=+3] -include::topics/proc_running-the-containerless-mta-cli.adoc[leveloffset=+3] - // Analyze application source code include::topics/mta-cli-analyze.adoc[leveloffset=+3] +include::topics/proc_running-the-containerless-mta-cli.adoc[leveloffset=+3] + // Transform XML rules to YAML include::topics/mta-cli-transform.adoc[leveloffset=+3] From bfc31ae7c44d850b2cb6683cf75464678c2967ff Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Tue, 18 Mar 2025 15:55:06 +0000 Subject: [PATCH 06/12] Update issues-with-report.adoc --- docs/topics/issues-with-report.adoc | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/docs/topics/issues-with-report.adoc b/docs/topics/issues-with-report.adoc index c5aa81dd..0a492d6d 100644 --- a/docs/topics/issues-with-report.adoc +++ b/docs/topics/issues-with-report.adoc @@ -8,15 +8,5 @@ Analysis precision is lower when the project cannot be built for whatever reasons. This lowering of precision can be caused by a number of factors; -* The lack of a proper build file, for example, a `pom.xml` or `build.gradle` file -* Compilation errors of one form or another - -.Running {ProductShortName} on a project with an inaccessible parent pom.xml file may not result in a full analysis - -Running {ProductFullName} on a project with an inaccessible parent pom.xml file may not result in a full analysis. For example, this issue impacts the link:https://github.com/jboss-developer/jboss-eap-quickstarts/tree/EAP_7.4.0.GA[JBoss EAP Quickstarts], which demonstrate JBoss EAP, Jakarta EE 10, and other additional technologies. They provide small, specific, working examples that can be used as a reference for your project. However, these quickstarts specify a relative path to their parent POM file, which does not exist when the {ProductShortName} container is run. - -Specifying an input path of link:https://github.com/jboss-developer/jboss-eap-quickstarts/tree/EAP_7.4.0.GA/kitchensink[`kitchensink`] mounts the `kitchensink` directory as a volume in the container, but that means that the JDT Language Server (jdtls) is unable to access the parent link:https://github.com/jboss-developer/jboss-eap-quickstarts/blob/EAP_7.4.0.GA/kitchensink/pom.xml[pom.xml] file. - -This causes the jdtls to encounter a `Non-resolvable parent POM` project build error. This error creates a `.project` file, which is missing the `org.eclipse.jdt.core.javanature`, meaning that jdtls, and subsequently {ProductShortName}, is unable to access details about the Java files. - -If you remove the parent pom.xml file and make the `kitchensink` project completely standalone, there are no issues. +* The lack of a proper build file, such as, a `pom.xml` or `build.gradle` file. For example, running {ProductFullName} on a project with an inaccessible parent `pom.xml` file may not result in a full analysis. +* Compilation errors of one form or another. From 903cbff5f31219733688003e5d6df9b4eac95846 Mon Sep 17 00:00:00 2001 From: "A.Arnold" Date: Tue, 18 Mar 2025 16:00:01 +0000 Subject: [PATCH 07/12] update Signed-off-by: A.Arnold --- docs/web-console-guide/master.adoc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/web-console-guide/master.adoc b/docs/web-console-guide/master.adoc index 5798c235..79d6ebb9 100644 --- a/docs/web-console-guide/master.adoc +++ b/docs/web-console-guide/master.adoc @@ -197,6 +197,9 @@ include::topics/mta-web-assessing-apps.adoc[leveloffset=+2] include::topics/mta-web-reviewing-apps.adoc[leveloffset=+2] //include::topics/mta-web-review-tab.adoc[leveloffset=+3] include::topics/mta-web-viewing-an-assessment-report.adoc[leveloffset=+2] + +// Issues with reports +include::topics/issues-with-report.adoc[leveloffset=+3] //include::topics/mta-web-run-assessment.adoc[leveloffset=+4] // include::topics/mta-web-skipping-assessment-of-apps.adoc[leveloffset=+3] From 2c0e713d0ff7b160d0b61ca48bd2135f04118cb8 Mon Sep 17 00:00:00 2001 From: "A.Arnold" Date: Tue, 18 Mar 2025 22:57:25 +0000 Subject: [PATCH 08/12] add Signed-off-by: A.Arnold --- docs/cli-guide/master.adoc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index 380efaff..01470734 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -95,6 +95,9 @@ include::topics/mta-cli-analyze-unsupported-provider.adoc[leveloffset=+3] // Review the Reports include::topics/mta-review-reports.adoc[leveloffset=+1] +// Issues with reports +include::topics/issues-with-report.adoc[leveloffset=+2] + // Export the Report in CSV Format // include::topics/csv-export.adoc[leveloffset=+1] From 5966f1b6a5383aa22876f4e966c22d4831e1e05d Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Tue, 18 Mar 2025 22:58:49 +0000 Subject: [PATCH 09/12] Update docs/cli-guide/master.adoc --- docs/cli-guide/master.adoc | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index 01470734..e9bff958 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -107,9 +107,6 @@ include::topics/issues-with-report.adoc[leveloffset=+2] // Optimize {ProductShortName} Performance include::topics/mta-optimize-performance.adoc[leveloffset=+1] -// Issues with reports -include::topics/issues-with-report.adoc[leveloffset=+1] - // Configure {ProductShortName} to Exclude Files and Packages // include::topics/mta-exclude-files-and-packages.adoc[leveloffset=+2] From 591fcd41723fefdeb4c3000139ccd5d41e8ad001 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Tue, 18 Mar 2025 22:59:47 +0000 Subject: [PATCH 10/12] Update docs/web-console-guide/master.adoc --- docs/web-console-guide/master.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/web-console-guide/master.adoc b/docs/web-console-guide/master.adoc index 79d6ebb9..f97e8556 100644 --- a/docs/web-console-guide/master.adoc +++ b/docs/web-console-guide/master.adoc @@ -200,6 +200,7 @@ include::topics/mta-web-viewing-an-assessment-report.adoc[leveloffset=+2] // Issues with reports include::topics/issues-with-report.adoc[leveloffset=+3] + //include::topics/mta-web-run-assessment.adoc[leveloffset=+4] // include::topics/mta-web-skipping-assessment-of-apps.adoc[leveloffset=+3] From 2b79497e4dfa06052aacd431060a519d50fc5705 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Tue, 18 Mar 2025 23:16:08 +0000 Subject: [PATCH 11/12] Update docs/topics/issues-with-report.adoc --- docs/topics/issues-with-report.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/issues-with-report.adoc b/docs/topics/issues-with-report.adoc index 0a492d6d..580ce7f2 100644 --- a/docs/topics/issues-with-report.adoc +++ b/docs/topics/issues-with-report.adoc @@ -6,7 +6,7 @@ [id="issues-with-report_{context}"] = Issues with reports -Analysis precision is lower when the project cannot be built for whatever reasons. This lowering of precision can be caused by a number of factors; +Analysis precision is lower when the project cannot be built for whatever reasons. This lowering of precision can be caused by several factors; * The lack of a proper build file, such as, a `pom.xml` or `build.gradle` file. For example, running {ProductFullName} on a project with an inaccessible parent `pom.xml` file may not result in a full analysis. * Compilation errors of one form or another. From ad497682630bf8d9a8dc6bcfd60c28ac54c59f89 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Wed, 19 Mar 2025 13:36:51 +0000 Subject: [PATCH 12/12] Update docs/topics/issues-with-report.adoc --- docs/topics/issues-with-report.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/issues-with-report.adoc b/docs/topics/issues-with-report.adoc index 580ce7f2..f82f2470 100644 --- a/docs/topics/issues-with-report.adoc +++ b/docs/topics/issues-with-report.adoc @@ -6,7 +6,7 @@ [id="issues-with-report_{context}"] = Issues with reports -Analysis precision is lower when the project cannot be built for whatever reasons. This lowering of precision can be caused by several factors; +Analysis precision is lower when the project cannot be built for whatever reasons. This lowering of precision can be caused by several factors: * The lack of a proper build file, such as, a `pom.xml` or `build.gradle` file. For example, running {ProductFullName} on a project with an inaccessible parent `pom.xml` file may not result in a full analysis. * Compilation errors of one form or another.