From ddc8a97d8a15017daa5860153127af2291a55540 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Mon, 7 Jul 2025 19:00:46 +0200 Subject: [PATCH 01/26] ENG-5566 Version bunmp. Added reload status verification when reloading the configuration --- pom.xml | 24 ++++++++-- .../apsadmin/admin/BaseAdminAction.java | 26 +++++++++- .../com/agiletec/apsadmin/admin/baseAdmin.xml | 10 +++- .../admin/reload/ReloadConfigThread.java | 31 ++++++++++++ .../apsadmin/global-messages_en.properties | 4 ++ .../apsadmin/global-messages_it.properties | 4 ++ .../apsadmin/jsp/admin/reloadProgress.jsp | 48 +++++++++++++++++++ src/main/webapp/WEB-INF/apsadmin/tiles.xml | 4 ++ 8 files changed, 145 insertions(+), 6 deletions(-) create mode 100644 src/main/java/com/agiletec/apsadmin/admin/reload/ReloadConfigThread.java create mode 100644 src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadProgress.jsp diff --git a/pom.xml b/pom.xml index 6e6aa67a9..eccea30f0 100644 --- a/pom.xml +++ b/pom.xml @@ -5,11 +5,11 @@ org.entando entando-core-parent - 6.5.0-ENG-5128-PR-156 + 6.5.0 org.entando.entando entando-admin-console - 6.5.2 + 6.5.3 war Entando Core: Administration Console Entando Administration Console: an agile, modern and user-centric open source Portal platform. @@ -88,6 +88,22 @@ + + maven-jar-plugin + + + tests + package + + jar + + + tests + ${project.build.test-classes} + + + + org.apache.maven.plugins maven-release-plugin @@ -212,7 +228,7 @@ org.entando entando-core-bom - 6.5.0-ENG-5128 + 6.5.1 import pom @@ -222,12 +238,14 @@ org.entando.entando entando-engine + 6.5.5-pre.1 org.entando.entando entando-engine test-jar test + 6.5.5-pre.1 org.apache.struts diff --git a/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java b/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java index 601db291e..36f615c34 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java +++ b/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java @@ -13,6 +13,7 @@ */ package com.agiletec.apsadmin.admin; +import com.agiletec.apsadmin.admin.reload.ReloadConfigThread; import java.util.ArrayList; import java.util.Enumeration; import java.util.Iterator; @@ -47,7 +48,7 @@ public class BaseAdminAction extends BaseAction { * Reload the system configuration. * * @return the result code. - */ + *//* public String reloadConfig() { try { ApsWebApplicationUtils.executeSystemRefresh(this.getRequest()); @@ -58,6 +59,29 @@ public String reloadConfig() { this.setReloadingResult(FAILURE_RELOADING_RESULT_CODE); } return SUCCESS; + }*/ + + public String reloadConfig() { + if (!ApsWebApplicationUtils.isReloadInProgress()) { + ReloadConfigThread rct = new ReloadConfigThread(this.getRequest()); + logger.info("Starting reload configuration thread"); + rct.start(); + } else { + logger.info("Reload operation already in progress!"); + } + return SUCCESS; + } + + public String reloadStatus() { + if (ApsWebApplicationUtils.isReloadInProgress()) { + return "inProgress"; + } + this.setReloadingResult(SUCCESS_RELOADING_RESULT_CODE); + return SUCCESS; + } + + public int getReloadProgress() { + return ApsWebApplicationUtils.getReloadProgress(); } /** diff --git a/src/main/java/com/agiletec/apsadmin/admin/baseAdmin.xml b/src/main/java/com/agiletec/apsadmin/admin/baseAdmin.xml index 1764e5b72..1f599dbb7 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/baseAdmin.xml +++ b/src/main/java/com/agiletec/apsadmin/admin/baseAdmin.xml @@ -17,10 +17,16 @@ superuser - admin.BaseAdmin.reloadConfigResult + admin.BaseAdmin.reloadInProgress superuser + + admin.BaseAdmin.reloadConfigResult + admin.BaseAdmin.reloadInProgress + superuser + + admin.BaseAdmin.reloadEntitiesReferencesResult superuser @@ -47,4 +53,4 @@ - \ No newline at end of file + diff --git a/src/main/java/com/agiletec/apsadmin/admin/reload/ReloadConfigThread.java b/src/main/java/com/agiletec/apsadmin/admin/reload/ReloadConfigThread.java new file mode 100644 index 000000000..c2575ad32 --- /dev/null +++ b/src/main/java/com/agiletec/apsadmin/admin/reload/ReloadConfigThread.java @@ -0,0 +1,31 @@ +package com.agiletec.apsadmin.admin.reload; + +import com.agiletec.aps.util.ApsWebApplicationUtils; +import javax.servlet.http.HttpServletRequest; +import org.entando.entando.ent.util.EntLogging.EntLogFactory; +import org.slf4j.Logger; + +public class ReloadConfigThread extends Thread { + Logger log = EntLogFactory.getSanitizedLogger(ReloadConfigThread.class); + + private HttpServletRequest request; + + public ReloadConfigThread(HttpServletRequest request) { + this.request = request; + } + + @Override + public void run() { + try { + ApsWebApplicationUtils.executeSystemRefresh(request); + log.info("ReloadConfigThread completed execution"); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + log.error("Thread interrupted", e); + } catch (Throwable e) { + log.error("unexpected thread error", e); + Thread.currentThread().interrupt(); + } + } + +} diff --git a/src/main/java/com/agiletec/apsadmin/global-messages_en.properties b/src/main/java/com/agiletec/apsadmin/global-messages_en.properties index db9b3bcbb..e2aa6022a 100644 --- a/src/main/java/com/agiletec/apsadmin/global-messages_en.properties +++ b/src/main/java/com/agiletec/apsadmin/global-messages_en.properties @@ -28,6 +28,7 @@ label.preview=Preview label.remove=Delete label.refresh=Refresh label.reload=Reload +label.reload.check=verifica label.swap=Swap label.move=Move label.moveUp=Move up @@ -168,6 +169,8 @@ label.required=Required label.requiredFields=Required Fields label.message.seach=Search for existing label label.reload.confirm=Are you sure you want to reload the configuration? +label.reload.message.check=Click the button to refresh the progress of the configuration reload +label.reload.progress=Overall progress label.chooseYourCategoriesTreeStyle=Choose the style of the Category tree label.fullname=Full name label.bundleId=Bundle Id @@ -291,6 +294,7 @@ menu.languageAdmin.languages=Languages menu.languageAdmin.labels=Labels menu.reload.config=Reload the configuration +menu.reload.verify=Refresh the full status of the configuration reload menu.reload.contents=Reload the contents menu.entityAdmin=Entities diff --git a/src/main/java/com/agiletec/apsadmin/global-messages_it.properties b/src/main/java/com/agiletec/apsadmin/global-messages_it.properties index 704b24ad3..ca587c8fc 100644 --- a/src/main/java/com/agiletec/apsadmin/global-messages_it.properties +++ b/src/main/java/com/agiletec/apsadmin/global-messages_it.properties @@ -29,6 +29,7 @@ label.preview=Anteprima label.remove=Elimina label.refresh=Aggiorna label.reload=Ricarica +label.reload.check=Aggiorna label.swap=Scambia label.move=Sposta @@ -174,6 +175,8 @@ label.required=Obbligatorio label.requiredFields=Campi obbligatori label.message.seach=Cerca per label esistente label.reload.confirm=Si e' sicuri di voler ricaricare la configurazione? +label.reload.message.check=Premere il bottone per visualizzare di avanzamento della ricarica configurazione +label.reload.progress=Percentuale completamento label.chooseYourCategoriesTreeStyle=Scegli lo stile dell''albero delle categorie label.fullname=Nome completo label.bundleId=Bundle Id @@ -299,6 +302,7 @@ menu.languageAdmin.labels=Etichette menu.reload=Ricarica menu.reload.config=Ricarica la configurazione +menu.reload.verify=Verifica stato caricamento menu.reload.contents=Ricarica i contenuti menu.contents.settings=Impostazione Contenuti diff --git a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadProgress.jsp b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadProgress.jsp new file mode 100644 index 000000000..406506a78 --- /dev/null +++ b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadProgress.jsp @@ -0,0 +1,48 @@ +<%@ taglib prefix="s" uri="/struts-tags" %> +<%@ taglib prefix="wp" uri="/aps-core" %> +
    +
    2. +
  2. + "> + + +
    3. +
  3. + +
    4. +
+

+ +

+
+
+
+
+
+ +
+ + +

+

+ +

+
+ " class="btn-primary button-fixed-width"> + + +
+
+

: %

+
+ + +
diff --git a/src/main/webapp/WEB-INF/apsadmin/tiles.xml b/src/main/webapp/WEB-INF/apsadmin/tiles.xml index d8b793879..d067a75e6 100644 --- a/src/main/webapp/WEB-INF/apsadmin/tiles.xml +++ b/src/main/webapp/WEB-INF/apsadmin/tiles.xml @@ -411,6 +411,10 @@ + + + + From 7e29e047940831e662aaa3458111a0736c906471 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Mon, 7 Jul 2025 21:19:24 +0200 Subject: [PATCH 02/26] ENG-5566 Updated pipeline cache versions to v4 --- .github/workflows/ga-publication.yml | 2 +- .github/workflows/pr.yml | 10 +++++----- .github/workflows/publication.yml | 12 ++++++------ 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/workflows/ga-publication.yml b/.github/workflows/ga-publication.yml index fb801c780..8a5260edc 100644 --- a/.github/workflows/ga-publication.yml +++ b/.github/workflows/ga-publication.yml @@ -41,7 +41,7 @@ jobs: --id "CHECKOUT FOR GA PUBLICATION" \ --lcd "$LOCAL_CLONE_DIR" - name: "Cache Maven packages" - uses: actions/cache@v2 + uses: actions/cache@v4 with: path: ~/.m2 key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index f47532c31..1890fa8f8 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -95,7 +95,7 @@ jobs: java-version: 11 #~ MAVEN CACHE - name: "Cache Maven packages" - uses: actions/cache@v2 + uses: actions/cache@v4 with: path: ~/.m2 key: ${{ runner.os }}-m2 @@ -103,13 +103,13 @@ jobs: #~ BUILD CACHE - name: "Cache Build Dir" id: build-cache - uses: actions/cache@v2 + uses: actions/cache@v4 with: path: "${{ env.LOCAL_CLONE_DIR }}/target/" key: ${{ runner.os }}-build-${{ env.BUILD_CACHE_KEY }} #~ SONAR CACHE - name: Cache SonarCloud packages - uses: actions/cache@v1 + uses: actions/cache@v4 with: path: ~/.sonar/cache key: ${{ runner.os }}-sonar @@ -151,7 +151,7 @@ jobs: #~ MAVEN CACHE - name: "Cache Maven packages" id: maven-cache - uses: actions/cache@v2 + uses: actions/cache@v4 with: path: ~/.m2 key: ${{ runner.os }}-m2-matrix-${{ matrix.scan-type }} @@ -162,7 +162,7 @@ jobs: #~ BUILD CACHE - name: "Cache Build Dir" id: build-cache - uses: actions/cache@v2 + uses: actions/cache@v4 with: path: "${{ env.LOCAL_CLONE_DIR}}/target/" key: ${{ runner.os }}-build-${{ env.BUILD_CACHE_KEY }} diff --git a/.github/workflows/publication.yml b/.github/workflows/publication.yml index 07d472be6..7834d68e5 100644 --- a/.github/workflows/publication.yml +++ b/.github/workflows/publication.yml @@ -56,7 +56,7 @@ jobs: java-version: 11 #~ MAVEN CACHE - name: "Cache Maven packages" - uses: actions/cache@v2 + uses: actions/cache@v4 with: path: ~/.m2 key: ${{ runner.os }}-m2 @@ -64,7 +64,7 @@ jobs: #~ BUILD CACHE - name: "Cache Build Dir" id: build-cache - uses: actions/cache@v2 + uses: actions/cache@v4 with: path: "${{ env.LOCAL_CLONE_DIR }}/target/" key: ${{ runner.os }}-build-${{ env.BUILD_CACHE_KEY }} @@ -131,7 +131,7 @@ jobs: java-version: 11 #~ MAVEN CACHE - name: "Cache Maven packages" - uses: actions/cache@v2 + uses: actions/cache@v4 with: path: ~/.m2 key: ${{ runner.os }}-m2 @@ -139,7 +139,7 @@ jobs: #~ BUILD CACHE - name: "Cache Build Dir" id: build-cache - uses: actions/cache@v2 + uses: actions/cache@v4 with: path: "${{ env.LOCAL_CLONE_DIR }}/target/" key: ${{ runner.os }}-build-${{ env.BUILD_CACHE_KEY }} @@ -177,7 +177,7 @@ jobs: java-version: 11 #~ MAVEN CACHE - name: "Cache Maven packages" - uses: actions/cache@v2 + uses: actions/cache@v4 with: path: ~/.m2 key: ${{ runner.os }}-m2 @@ -185,7 +185,7 @@ jobs: #~ BUILD CACHE - name: "Cache Build Dir" id: build-cache - uses: actions/cache@v2 + uses: actions/cache@v4 with: path: "${{ env.LOCAL_CLONE_DIR }}/target/" key: ${{ runner.os }}-build-${{ env.BUILD_CACHE_KEY }} From fccb1877d4acc361390bfaf66ab0a4f6be8d49f6 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Tue, 8 Jul 2025 08:57:35 +0200 Subject: [PATCH 03/26] ENG-5566 Updated entando-engine version to 6.5.5-ENG-5566-PR-340 --- pom.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pom.xml b/pom.xml index eccea30f0..2f86b173c 100644 --- a/pom.xml +++ b/pom.xml @@ -238,14 +238,14 @@ org.entando.entando entando-engine - 6.5.5-pre.1 + 6.5.5-ENG-5566-PR-340 org.entando.entando entando-engine test-jar test - 6.5.5-pre.1 + 6.5.5-ENG-5566-PR-340 org.apache.struts From fba6b55561c002ad2053a0eae3b41be4b082e81e Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Tue, 8 Jul 2025 09:45:02 +0200 Subject: [PATCH 04/26] ENG-5566 Test updated --- .../apsadmin/admin/BaseAdminAction.java | 17 ++++------------- .../apsadmin/admin/TestBaseAdminAction.java | 19 +++++++++++++++++++ .../portal/TestWidgetsViewerAction.java | 2 +- 3 files changed, 24 insertions(+), 14 deletions(-) diff --git a/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java b/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java index 36f615c34..60a680045 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java +++ b/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java @@ -48,19 +48,7 @@ public class BaseAdminAction extends BaseAction { * Reload the system configuration. * * @return the result code. - *//* - public String reloadConfig() { - try { - ApsWebApplicationUtils.executeSystemRefresh(this.getRequest()); - logger.info("Reload config started"); - this.setReloadingResult(SUCCESS_RELOADING_RESULT_CODE); - } catch (Throwable t) { - logger.error("error in reloadConfig", t); - this.setReloadingResult(FAILURE_RELOADING_RESULT_CODE); - } - return SUCCESS; - }*/ - + */ public String reloadConfig() { if (!ApsWebApplicationUtils.isReloadInProgress()) { ReloadConfigThread rct = new ReloadConfigThread(this.getRequest()); @@ -69,11 +57,13 @@ public String reloadConfig() { } else { logger.info("Reload operation already in progress!"); } + this.setReloadingResult(PROGRESS_RELOADING_RESULT_CODE); return SUCCESS; } public String reloadStatus() { if (ApsWebApplicationUtils.isReloadInProgress()) { + this.setReloadingResult(PROGRESS_RELOADING_RESULT_CODE); return "inProgress"; } this.setReloadingResult(SUCCESS_RELOADING_RESULT_CODE); @@ -266,5 +256,6 @@ public String getExternalParamMarker() { public static final int FAILURE_RELOADING_RESULT_CODE = 0; public static final int SUCCESS_RELOADING_RESULT_CODE = 1; + public static final int PROGRESS_RELOADING_RESULT_CODE = 2; } diff --git a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java index 5d5dd395d..29b5816b3 100644 --- a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java +++ b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java @@ -18,6 +18,8 @@ import static org.junit.jupiter.api.Assertions.assertNull; import static org.junit.jupiter.api.Assertions.assertTrue; +import com.agiletec.aps.system.ApsSystemUtils; +import com.agiletec.aps.util.ApsWebApplicationUtils; import java.util.Map; import com.agiletec.aps.system.SystemConstants; @@ -50,6 +52,23 @@ void testReloadConfig() throws Throwable { synchronized (this) { this.wait(3000); } + assertEquals(BaseAdminAction.PROGRESS_RELOADING_RESULT_CODE, ((BaseAdminAction) this.getAction()).getReloadingResult()); + } + + @Test + void testReloadStatus() throws Throwable { + this.setUserOnSession("supervisorCoach"); + this.initAction("/do/BaseAdmin", "reloadStatus"); + String result = this.executeAction(); + assertEquals("userNotAllowed", result); + + this.setUserOnSession("admin"); + this.initAction("/do/BaseAdmin", "reloadStatus"); + result = this.executeAction(); + assertEquals(Action.SUCCESS, result); + synchronized (this) { + this.wait(3000); + } assertEquals(BaseAdminAction.SUCCESS_RELOADING_RESULT_CODE, ((BaseAdminAction) this.getAction()).getReloadingResult()); } diff --git a/src/test/java/com/agiletec/apsadmin/portal/TestWidgetsViewerAction.java b/src/test/java/com/agiletec/apsadmin/portal/TestWidgetsViewerAction.java index e85c93abd..7d815e83f 100644 --- a/src/test/java/com/agiletec/apsadmin/portal/TestWidgetsViewerAction.java +++ b/src/test/java/com/agiletec/apsadmin/portal/TestWidgetsViewerAction.java @@ -71,7 +71,7 @@ void testGetWidgetFlavours() throws Throwable { List customWidgets = widgetFlavours.get(1); assertEquals(2, customWidgets.size()); - SelectItem customType = customWidgets.get(1); + SelectItem customType = customWidgets.get(0); assertEquals(AbstractPortalAction.CUSTOM_WIDGETS_CODE, customType.getOptgroup()); if (currentLang.getCode().equals("it")) { assertEquals("leftmenu", customType.getKey()); From 6c117988d9f5f1357968b214d00715893d9bd9ea Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Tue, 8 Jul 2025 14:56:28 +0200 Subject: [PATCH 05/26] ENG-5566 cosmetic change on test for debugging purposes --- .../agiletec/apsadmin/portal/TestWidgetsViewerAction.java | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/test/java/com/agiletec/apsadmin/portal/TestWidgetsViewerAction.java b/src/test/java/com/agiletec/apsadmin/portal/TestWidgetsViewerAction.java index 7d815e83f..14b5cc020 100644 --- a/src/test/java/com/agiletec/apsadmin/portal/TestWidgetsViewerAction.java +++ b/src/test/java/com/agiletec/apsadmin/portal/TestWidgetsViewerAction.java @@ -73,6 +73,11 @@ void testGetWidgetFlavours() throws Throwable { assertEquals(2, customWidgets.size()); SelectItem customType = customWidgets.get(0); assertEquals(AbstractPortalAction.CUSTOM_WIDGETS_CODE, customType.getOptgroup()); + + System.out.println(">L> " + currentLang.getCode()); + customWidgets.forEach(c -> System.out.println(">!> " + c.getKey() + ": " + c.getValue())); + + if (currentLang.getCode().equals("it")) { assertEquals("leftmenu", customType.getKey()); assertEquals("Menu di navigazione verticale", customType.getValue()); From b4c71ba881602cb1d2bc1c27868c1d3889ac56f3 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Tue, 8 Jul 2025 16:12:13 +0200 Subject: [PATCH 06/26] ENG-5566 Updated test --- .../java/com/agiletec/apsadmin/system/BaseAction.java | 2 +- .../apsadmin/portal/TestWidgetsViewerAction.java | 10 ++-------- 2 files changed, 3 insertions(+), 9 deletions(-) diff --git a/src/main/java/com/agiletec/apsadmin/system/BaseAction.java b/src/main/java/com/agiletec/apsadmin/system/BaseAction.java index 1951a3741..97b67d0f7 100644 --- a/src/main/java/com/agiletec/apsadmin/system/BaseAction.java +++ b/src/main/java/com/agiletec/apsadmin/system/BaseAction.java @@ -138,7 +138,7 @@ protected List getActualAllowedGroupCodes() { /** * Return the current system language used in the back-end interface. If this language does not - * belong to those known by the system the default language is returned. A log line will + * belong to those known by the system, the default language is returned. A log line will * report the problem. * @return The current language. */ diff --git a/src/test/java/com/agiletec/apsadmin/portal/TestWidgetsViewerAction.java b/src/test/java/com/agiletec/apsadmin/portal/TestWidgetsViewerAction.java index 14b5cc020..2848eb056 100644 --- a/src/test/java/com/agiletec/apsadmin/portal/TestWidgetsViewerAction.java +++ b/src/test/java/com/agiletec/apsadmin/portal/TestWidgetsViewerAction.java @@ -56,7 +56,6 @@ void testGetWidgetFlavours() throws Throwable { assertNotNull(widgetFlavours); assertTrue(widgetFlavours.size() >= 3); Lang currentLang = action.getCurrentLang(); - List userWidgets = widgetFlavours.get(0); assertEquals(1, userWidgets.size()); SelectItem userType = userWidgets.get(0); @@ -73,17 +72,12 @@ void testGetWidgetFlavours() throws Throwable { assertEquals(2, customWidgets.size()); SelectItem customType = customWidgets.get(0); assertEquals(AbstractPortalAction.CUSTOM_WIDGETS_CODE, customType.getOptgroup()); - - System.out.println(">L> " + currentLang.getCode()); - customWidgets.forEach(c -> System.out.println(">!> " + c.getKey() + ": " + c.getValue())); - - if (currentLang.getCode().equals("it")) { assertEquals("leftmenu", customType.getKey()); assertEquals("Menu di navigazione verticale", customType.getValue()); } else { - assertEquals("leftmenu", customType.getKey()); - assertEquals("Vertical Navigation Menu", customType.getValue()); + assertEquals("parent_widget", customType.getKey()); + assertEquals("Parent Widget", customType.getValue()); } List stockWidgets = widgetFlavours.get(widgetFlavours.size() - 1); From 209186388758bfebdd24c9119fd643c3f0e95fd7 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Wed, 9 Jul 2025 15:31:43 +0200 Subject: [PATCH 07/26] ENG-5566 Updated test --- .../apsadmin/admin/BaseAdminAction.java | 42 +++--- .../com/agiletec/apsadmin/admin/baseAdmin.xml | 1 + .../apsadmin/admin/TestBaseAdminAction.java | 135 +++++++++++++++++- 3 files changed, 153 insertions(+), 25 deletions(-) diff --git a/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java b/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java index 60a680045..30dcb44aa 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java +++ b/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java @@ -13,17 +13,6 @@ */ package com.agiletec.apsadmin.admin; -import com.agiletec.apsadmin.admin.reload.ReloadConfigThread; -import java.util.ArrayList; -import java.util.Enumeration; -import java.util.Iterator; -import java.util.List; -import java.util.Map; - -import org.entando.entando.ent.util.EntLogging.EntLogger; -import org.entando.entando.ent.util.EntLogging.EntLogFactory; -import org.springframework.web.context.WebApplicationContext; - import com.agiletec.aps.system.SystemConstants; import com.agiletec.aps.system.common.entity.event.ReloadingEntitiesReferencesEvent; import com.agiletec.aps.system.services.baseconfig.ConfigInterface; @@ -32,7 +21,16 @@ import com.agiletec.aps.system.services.page.IPage; import com.agiletec.aps.system.services.page.IPageManager; import com.agiletec.aps.util.ApsWebApplicationUtils; +import com.agiletec.apsadmin.admin.reload.ReloadConfigThread; import com.agiletec.apsadmin.system.BaseAction; +import java.util.ArrayList; +import java.util.Enumeration; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import org.entando.entando.ent.util.EntLogging.EntLogFactory; +import org.entando.entando.ent.util.EntLogging.EntLogger; +import org.springframework.web.context.WebApplicationContext; /** * This base action implements the default actions available for the system @@ -50,14 +48,20 @@ public class BaseAdminAction extends BaseAction { * @return the result code. */ public String reloadConfig() { - if (!ApsWebApplicationUtils.isReloadInProgress()) { - ReloadConfigThread rct = new ReloadConfigThread(this.getRequest()); - logger.info("Starting reload configuration thread"); - rct.start(); - } else { - logger.info("Reload operation already in progress!"); + try { + if (!ApsWebApplicationUtils.isReloadInProgress()) { + ReloadConfigThread rct = new ReloadConfigThread(this.getRequest()); + logger.info("Starting reload configuration thread"); + rct.start(); + } else { + logger.info("Reload operation already in progress!"); + } + this.setReloadingResult(PROGRESS_RELOADING_RESULT_CODE); + } catch (Exception e) { + logger.error("unexpected error while launching system reload", e); + this.setReloadingResult(FAILURE_RELOADING_RESULT_CODE); + return "reloadError"; } - this.setReloadingResult(PROGRESS_RELOADING_RESULT_CODE); return SUCCESS; } @@ -101,7 +105,7 @@ public void setReloadingResult(int reloadingResult) { } /** - * Get the system parameters in order to edit them. + * Get the system parameters to edit them. * * @return the result code. */ diff --git a/src/main/java/com/agiletec/apsadmin/admin/baseAdmin.xml b/src/main/java/com/agiletec/apsadmin/admin/baseAdmin.xml index 1f599dbb7..955508782 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/baseAdmin.xml +++ b/src/main/java/com/agiletec/apsadmin/admin/baseAdmin.xml @@ -18,6 +18,7 @@ admin.BaseAdmin.reloadInProgress + admin.BaseAdmin.reloadConfigResult superuser diff --git a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java index 29b5816b3..36e7e9fa1 100644 --- a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java +++ b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java @@ -17,18 +17,28 @@ import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertNull; import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.anyString; import com.agiletec.aps.system.ApsSystemUtils; import com.agiletec.aps.util.ApsWebApplicationUtils; +import java.util.ArrayList; import java.util.Map; import com.agiletec.aps.system.SystemConstants; import com.agiletec.aps.system.services.baseconfig.ConfigInterface; import com.agiletec.apsadmin.ApsAdminBaseTestCase; import com.opensymphony.xwork2.Action; +import javax.servlet.ServletContext; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.jsp.PageContext; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; +import org.mockito.MockedStatic; +import org.mockito.Mockito; +import org.springframework.web.context.WebApplicationContext; +import org.springframework.web.context.support.WebApplicationContextUtils; /** * @author E.Santoboni @@ -39,7 +49,7 @@ class TestBaseAdminAction extends ApsAdminBaseTestCase { private String oldConfigParam; @Test - void testReloadConfig() throws Throwable { + void testReloadConfig() throws Throwable { this.setUserOnSession("supervisorCoach"); this.initAction("/do/BaseAdmin", "reloadConfig"); String result = this.executeAction(); @@ -55,6 +65,119 @@ void testReloadConfig() throws Throwable { assertEquals(BaseAdminAction.PROGRESS_RELOADING_RESULT_CODE, ((BaseAdminAction) this.getAction()).getReloadingResult()); } + @Test + void testReloadConfigurationError() throws Throwable { + try (MockedStatic mockAWAU = Mockito.mockStatic(ApsWebApplicationUtils.class)) { + mockAWAU.when(ApsWebApplicationUtils::isReloadInProgress) + .thenThrow(new RuntimeException("error needed for testing, ignore me")); + mockAWAU.when(ApsWebApplicationUtils::getReloadProgress).thenReturn(77); + + mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(ServletContext.class))) + .thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(PageContext.class))) + .thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getService(anyString(), any(HttpServletRequest.class))) + .thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getService(anyString(), any(PageContext.class))) + .thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(HttpServletRequest.class))) + .thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(PageContext.class))) + .thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getWebApplicationContext(any(HttpServletRequest.class))) + .thenReturn(WebApplicationContextUtils.getWebApplicationContext( + this.getRequest().getSession().getServletContext())); + mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(HttpServletRequest.class))) + .thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(ServletContext.class))) + .thenCallRealMethod(); + this.setUserOnSession("admin"); + this.initAction("/do/BaseAdmin", "reloadConfig"); + String result = this.executeAction(); + assertEquals("reloadError", result); + + assertEquals(BaseAdminAction.FAILURE_RELOADING_RESULT_CODE, + ((BaseAdminAction) this.getAction()).getReloadingResult()); + } + } + + @Test + void testDoubleReload() throws Throwable { + try (MockedStatic mockAWAU = Mockito.mockStatic(ApsWebApplicationUtils.class)) { + mockAWAU.when(ApsWebApplicationUtils::isReloadInProgress).thenReturn(true); + mockAWAU.when(ApsWebApplicationUtils::getReloadProgress).thenReturn(77); + + mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(ServletContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(PageContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getService(anyString(), any(HttpServletRequest.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getService(anyString(), any(PageContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(HttpServletRequest.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(PageContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getWebApplicationContext(any(HttpServletRequest.class))) + .thenReturn(WebApplicationContextUtils.getWebApplicationContext(this.getRequest().getSession().getServletContext())); + mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(HttpServletRequest.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(ServletContext.class))).thenCallRealMethod(); + + this.setUserOnSession("admin"); + this.initAction("/do/BaseAdmin", "reloadConfig"); + String result = this.executeAction(); + assertEquals(Action.SUCCESS, result); + + assertEquals(BaseAdminAction.PROGRESS_RELOADING_RESULT_CODE, ((BaseAdminAction) this.getAction()).getReloadingResult()); + } + } + + @Test + void testReloadStatusInProgress() throws Throwable { + try (MockedStatic mockAWAU = Mockito.mockStatic(ApsWebApplicationUtils.class)) { + mockAWAU.when(ApsWebApplicationUtils::isReloadInProgress).thenReturn(true); + mockAWAU.when(ApsWebApplicationUtils::getReloadProgress).thenReturn(77); + + mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(ServletContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(PageContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getService(anyString(), any(HttpServletRequest.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getService(anyString(), any(PageContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(HttpServletRequest.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(PageContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getWebApplicationContext(any(HttpServletRequest.class))) + .thenReturn(WebApplicationContextUtils.getWebApplicationContext(this.getRequest().getSession().getServletContext())); + mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(HttpServletRequest.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(ServletContext.class))).thenCallRealMethod(); + + this.setUserOnSession("admin"); + this.initAction("/do/BaseAdmin", "reloadStatus"); + String result = this.executeAction(); + assertEquals("inProgress", result); + + assertEquals(BaseAdminAction.PROGRESS_RELOADING_RESULT_CODE, ((BaseAdminAction) this.getAction()).getReloadingResult()); + } + } + + void testReloadStatusCompleted() throws Throwable { + try (MockedStatic mockAWAU = Mockito.mockStatic(ApsWebApplicationUtils.class)) { + mockAWAU.when(ApsWebApplicationUtils::isReloadInProgress).thenReturn(false); + mockAWAU.when(ApsWebApplicationUtils::getReloadProgress).thenReturn(0); + + mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(ServletContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(PageContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getService(anyString(), any(HttpServletRequest.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getService(anyString(), any(PageContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(HttpServletRequest.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(PageContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getWebApplicationContext(any(HttpServletRequest.class))) + .thenReturn(WebApplicationContextUtils.getWebApplicationContext(this.getRequest().getSession().getServletContext())); + mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(HttpServletRequest.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(ServletContext.class))).thenCallRealMethod(); + + this.setUserOnSession("admin"); + this.initAction("/do/BaseAdmin", "reloadStatus"); + String result = this.executeAction(); + assertEquals(Action.SUCCESS, result); + + assertEquals(BaseAdminAction.SUCCESS_RELOADING_RESULT_CODE, ((BaseAdminAction) this.getAction()).getReloadingResult()); + } + } + @Test void testReloadStatus() throws Throwable { this.setUserOnSession("supervisorCoach"); @@ -73,7 +196,7 @@ void testReloadStatus() throws Throwable { } @Test - void testReloadEntitiesReferences() throws Throwable { + void testReloadEntitiesReferences() throws Throwable { this.setUserOnSession("supervisorCoach"); this.initAction("/do/BaseAdmin", "reloadEntitiesReferences"); String result = this.executeAction(); @@ -90,7 +213,7 @@ void testReloadEntitiesReferences() throws Throwable { } @Test - void testConfigSystemParams() throws Throwable { + void testConfigSystemParams() throws Throwable { this.setUserOnSession("admin"); this.initAction("/do/BaseAdmin", "configSystemParams"); String result = this.executeAction(); @@ -103,7 +226,7 @@ void testConfigSystemParams() throws Throwable { } @Test - void testUpdateConfigParams_1() throws Throwable { + void testUpdateConfigParams_1() throws Throwable { this.setUserOnSession("admin"); this.initAction("/do/BaseAdmin", "updateSystemParams"); this.addParameter(SystemConstants.CONFIG_PARAM_ERROR_PAGE_CODE, "newErrorPageCode"); @@ -116,7 +239,7 @@ void testUpdateConfigParams_1() throws Throwable { } @Test - void testUpdateConfigParams_2() throws Throwable { + void testUpdateConfigParams_2() throws Throwable { assertEquals("homepage", this.configManager.getParam(SystemConstants.CONFIG_PARAM_HOMEPAGE_PAGE_CODE)); assertEquals("errorpage", this.configManager.getParam(SystemConstants.CONFIG_PARAM_ERROR_PAGE_CODE)); @@ -145,7 +268,7 @@ void testUpdateConfigParams_2() throws Throwable { assertNotNull(this.configManager.getParam("newCustomParameter")); assertEquals("parameterValue", this.configManager.getParam("newCustomParameter")); } - + @AfterEach protected void destroy() throws Exception { this.configManager.updateConfigItem(SystemConstants.CONFIG_ITEM_PARAMS, this.oldConfigParam); From 44a3b73f58749e60b903fb119353898e70805e8f Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Wed, 9 Jul 2025 15:39:36 +0200 Subject: [PATCH 08/26] ENG-5566 Updated mockito dependency --- pom.xml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pom.xml b/pom.xml index 2f86b173c..ed95b2ed1 100644 --- a/pom.xml +++ b/pom.xml @@ -291,6 +291,10 @@ org.mockito mockito-junit-jupiter + + org.mockito + mockito-inline + javax.servlet javax.servlet-api From 24fdef2cf014632834101b3e83e5acb9bc86d811 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Wed, 9 Jul 2025 16:54:39 +0200 Subject: [PATCH 09/26] ENG-5566 Code cleaning and test updated --- .../admin/reload/ReloadConfigThread.java | 10 ++- .../apsadmin/ApsAdminBaseTestCase.java | 6 +- .../apsadmin/admin/TestBaseAdminAction.java | 69 ++++++++++++++----- 3 files changed, 60 insertions(+), 25 deletions(-) diff --git a/src/main/java/com/agiletec/apsadmin/admin/reload/ReloadConfigThread.java b/src/main/java/com/agiletec/apsadmin/admin/reload/ReloadConfigThread.java index c2575ad32..eb182d3aa 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/reload/ReloadConfigThread.java +++ b/src/main/java/com/agiletec/apsadmin/admin/reload/ReloadConfigThread.java @@ -1,24 +1,28 @@ package com.agiletec.apsadmin.admin.reload; import com.agiletec.aps.util.ApsWebApplicationUtils; +import java.util.List; import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpSession; import org.entando.entando.ent.util.EntLogging.EntLogFactory; import org.slf4j.Logger; public class ReloadConfigThread extends Thread { + Logger log = EntLogFactory.getSanitizedLogger(ReloadConfigThread.class); - private HttpServletRequest request; + private final HttpServletRequest request; - public ReloadConfigThread(HttpServletRequest request) { + public ReloadConfigThread(final HttpServletRequest request) { this.request = request; } @Override public void run() { try { - ApsWebApplicationUtils.executeSystemRefresh(request); + List result = ApsWebApplicationUtils.executeSystemRefresh(request); log.info("ReloadConfigThread completed execution"); + HttpSession session = request.getSession(); } catch (InterruptedException e) { Thread.currentThread().interrupt(); log.error("Thread interrupted", e); diff --git a/src/test/java/com/agiletec/apsadmin/ApsAdminBaseTestCase.java b/src/test/java/com/agiletec/apsadmin/ApsAdminBaseTestCase.java index 8d8005e40..6f218fa35 100644 --- a/src/test/java/com/agiletec/apsadmin/ApsAdminBaseTestCase.java +++ b/src/test/java/com/agiletec/apsadmin/ApsAdminBaseTestCase.java @@ -30,7 +30,6 @@ import com.opensymphony.xwork2.ActionSupport; import com.opensymphony.xwork2.inject.Container; import com.opensymphony.xwork2.inject.ContainerBuilder; - import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; @@ -41,7 +40,6 @@ import java.util.Properties; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpSession; - import org.apache.struts2.ServletActionContext; import org.apache.struts2.dispatcher.Dispatcher; import org.apache.struts2.dispatcher.HttpParameters; @@ -172,7 +170,7 @@ protected void initAction(String namespace, String name, boolean refreshResponse this.proxy.setExecuteResult(false); // by default, don't pass in any request parameters - // set the actions context to the one which the proxy is using + // set the action context to the one that the proxy is using this.proxy.getInvocation().getInvocationContext().setSession(new HashMap<>()); ServletActionContext.setContext(this.proxy.getInvocation().getInvocationContext()); ServletActionContext.setRequest(this.request); @@ -185,7 +183,7 @@ protected void initAction(String namespace, String name, boolean refreshResponse ServletActionContext.setServletContext(servletContext); this.action = (ActionSupport) this.proxy.getAction(); - //reset previsious params + //reset previous params List paramNames = new ArrayList(this.request.getParameterMap().keySet()); for (int i = 0; i < paramNames.size(); i++) { String paramName = (String) paramNames.get(i); diff --git a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java index 36e7e9fa1..a48eb4e10 100644 --- a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java +++ b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java @@ -20,24 +20,21 @@ import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyString; -import com.agiletec.aps.system.ApsSystemUtils; -import com.agiletec.aps.util.ApsWebApplicationUtils; -import java.util.ArrayList; -import java.util.Map; - import com.agiletec.aps.system.SystemConstants; import com.agiletec.aps.system.services.baseconfig.ConfigInterface; +import com.agiletec.aps.util.ApsWebApplicationUtils; import com.agiletec.apsadmin.ApsAdminBaseTestCase; import com.opensymphony.xwork2.Action; +import java.util.Map; import javax.servlet.ServletContext; import javax.servlet.http.HttpServletRequest; import javax.servlet.jsp.PageContext; +import org.apache.lucene.util.ThreadInterruptedException; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.MockedStatic; import org.mockito.Mockito; -import org.springframework.web.context.WebApplicationContext; import org.springframework.web.context.support.WebApplicationContextUtils; /** @@ -76,10 +73,6 @@ void testReloadConfigurationError() throws Throwable { .thenCallRealMethod(); mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(PageContext.class))) .thenCallRealMethod(); - mockAWAU.when(() -> ApsWebApplicationUtils.getService(anyString(), any(HttpServletRequest.class))) - .thenCallRealMethod(); - mockAWAU.when(() -> ApsWebApplicationUtils.getService(anyString(), any(PageContext.class))) - .thenCallRealMethod(); mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(HttpServletRequest.class))) .thenCallRealMethod(); mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(PageContext.class))) @@ -101,6 +94,51 @@ void testReloadConfigurationError() throws Throwable { } } + @Test + void testReloadConfigurationThreadError() throws Throwable { + try (MockedStatic mockAWAU = Mockito.mockStatic(ApsWebApplicationUtils.class)) { + mockAWAU.when(ApsWebApplicationUtils::isReloadInProgress).thenReturn(false); + mockAWAU.when(ApsWebApplicationUtils::getReloadProgress).thenReturn(0); + + mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(ServletContext.class))) + .thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(PageContext.class))) + .thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(HttpServletRequest.class))) + .thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(PageContext.class))) + .thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getWebApplicationContext(any(HttpServletRequest.class))) + .thenReturn(WebApplicationContextUtils.getWebApplicationContext( + this.getRequest().getSession().getServletContext())); + mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(HttpServletRequest.class))) + .thenThrow(new ThreadInterruptedException(new InterruptedException("Interrupted for testing!"))); + mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(ServletContext.class))) + .thenThrow(new ThreadInterruptedException(new InterruptedException("Interrupted for testing!"))); + this.setUserOnSession("admin"); + this.initAction("/do/BaseAdmin", "reloadConfig"); + String result = this.executeAction(); + assertEquals(Action.SUCCESS, result); + + assertEquals(BaseAdminAction.PROGRESS_RELOADING_RESULT_CODE, + ((BaseAdminAction) this.getAction()).getReloadingResult()); + + + mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(HttpServletRequest.class))) + .thenThrow(new RuntimeException("Exception needed for testing")); + mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(ServletContext.class))) + .thenThrow(new RuntimeException("Exception needed for testing")); + + this.setUserOnSession("admin"); + this.initAction("/do/BaseAdmin", "reloadConfig"); + result = this.executeAction(); + assertEquals(Action.SUCCESS, result); + + assertEquals(BaseAdminAction.PROGRESS_RELOADING_RESULT_CODE, + ((BaseAdminAction) this.getAction()).getReloadingResult()); + } + } + @Test void testDoubleReload() throws Throwable { try (MockedStatic mockAWAU = Mockito.mockStatic(ApsWebApplicationUtils.class)) { @@ -109,8 +147,6 @@ void testDoubleReload() throws Throwable { mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(ServletContext.class))).thenCallRealMethod(); mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(PageContext.class))).thenCallRealMethod(); - mockAWAU.when(() -> ApsWebApplicationUtils.getService(anyString(), any(HttpServletRequest.class))).thenCallRealMethod(); - mockAWAU.when(() -> ApsWebApplicationUtils.getService(anyString(), any(PageContext.class))).thenCallRealMethod(); mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(HttpServletRequest.class))).thenCallRealMethod(); mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(PageContext.class))).thenCallRealMethod(); mockAWAU.when(() -> ApsWebApplicationUtils.getWebApplicationContext(any(HttpServletRequest.class))) @@ -135,8 +171,6 @@ void testReloadStatusInProgress() throws Throwable { mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(ServletContext.class))).thenCallRealMethod(); mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(PageContext.class))).thenCallRealMethod(); - mockAWAU.when(() -> ApsWebApplicationUtils.getService(anyString(), any(HttpServletRequest.class))).thenCallRealMethod(); - mockAWAU.when(() -> ApsWebApplicationUtils.getService(anyString(), any(PageContext.class))).thenCallRealMethod(); mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(HttpServletRequest.class))).thenCallRealMethod(); mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(PageContext.class))).thenCallRealMethod(); mockAWAU.when(() -> ApsWebApplicationUtils.getWebApplicationContext(any(HttpServletRequest.class))) @@ -153,6 +187,7 @@ void testReloadStatusInProgress() throws Throwable { } } + @Test void testReloadStatusCompleted() throws Throwable { try (MockedStatic mockAWAU = Mockito.mockStatic(ApsWebApplicationUtils.class)) { mockAWAU.when(ApsWebApplicationUtils::isReloadInProgress).thenReturn(false); @@ -160,8 +195,6 @@ void testReloadStatusCompleted() throws Throwable { mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(ServletContext.class))).thenCallRealMethod(); mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(PageContext.class))).thenCallRealMethod(); - mockAWAU.when(() -> ApsWebApplicationUtils.getService(anyString(), any(HttpServletRequest.class))).thenCallRealMethod(); - mockAWAU.when(() -> ApsWebApplicationUtils.getService(anyString(), any(PageContext.class))).thenCallRealMethod(); mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(HttpServletRequest.class))).thenCallRealMethod(); mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(PageContext.class))).thenCallRealMethod(); mockAWAU.when(() -> ApsWebApplicationUtils.getWebApplicationContext(any(HttpServletRequest.class))) @@ -270,12 +303,12 @@ void testUpdateConfigParams_2() throws Throwable { } @AfterEach - protected void destroy() throws Exception { + void destroy() throws Exception { this.configManager.updateConfigItem(SystemConstants.CONFIG_ITEM_PARAMS, this.oldConfigParam); } @BeforeEach - private void init() { + void init() { this.configManager = (ConfigInterface) this.getService(SystemConstants.BASE_CONFIG_MANAGER); this.oldConfigParam = this.configManager.getConfigItem(SystemConstants.CONFIG_ITEM_PARAMS); } From 5b32c1707a1469006a175047777ab5199fb34003 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Thu, 10 Jul 2025 10:56:20 +0200 Subject: [PATCH 10/26] ENG-5566 Added reload report, test updated --- .../apsadmin/admin/BaseAdminAction.java | 27 ++++++- .../apsadmin/admin/package_en.properties | 7 ++ .../apsadmin/admin/package_it.properties | 6 ++ .../admin/reload/ReloadConfigThread.java | 12 +-- .../apsadmin/global-messages_en.properties | 1 + .../apsadmin/global-messages_it.properties | 1 + .../agiletec/apsadmin/system/BaseAction.java | 2 +- .../apsadmin/jsp/admin/reloadConfig.jsp | 51 ++++++++++-- .../apsadmin/admin/TestBaseAdminAction.java | 80 ++++++++----------- 9 files changed, 122 insertions(+), 65 deletions(-) diff --git a/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java b/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java index 30dcb44aa..fd2d10203 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java +++ b/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java @@ -13,6 +13,8 @@ */ package com.agiletec.apsadmin.admin; +import static com.agiletec.apsadmin.admin.reload.ReloadConfigThread.RELOAD_THREAD; + import com.agiletec.aps.system.SystemConstants; import com.agiletec.aps.system.common.entity.event.ReloadingEntitiesReferencesEvent; import com.agiletec.aps.system.services.baseconfig.ConfigInterface; @@ -25,9 +27,11 @@ import com.agiletec.apsadmin.system.BaseAction; import java.util.ArrayList; import java.util.Enumeration; +import java.util.HashMap; import java.util.Iterator; import java.util.List; import java.util.Map; +import org.apache.commons.lang3.StringUtils; import org.entando.entando.ent.util.EntLogging.EntLogFactory; import org.entando.entando.ent.util.EntLogging.EntLogger; import org.springframework.web.context.WebApplicationContext; @@ -70,14 +74,31 @@ public String reloadStatus() { this.setReloadingResult(PROGRESS_RELOADING_RESULT_CODE); return "inProgress"; } - this.setReloadingResult(SUCCESS_RELOADING_RESULT_CODE); + if (ApsWebApplicationUtils.getReloadInfo().containsKey(RELOAD_THREAD)) { + this.setReloadingResult(FAILURE_RELOADING_RESULT_CODE); + } else if (isReloadingErrorDetect()) { + this.setReloadingResult(WARNING_RELOADING_RESULT_CODE); + } else { + this.setReloadingResult(SUCCESS_RELOADING_RESULT_CODE); + } return SUCCESS; } + public boolean isReloadingErrorDetect() { + return ApsWebApplicationUtils.getReloadInfo() + .values() + .stream() + .anyMatch(StringUtils::isNotBlank); + } + public int getReloadProgress() { return ApsWebApplicationUtils.getReloadProgress(); } + public Map getReloadInfo() { + return new HashMap<>(ApsWebApplicationUtils.getReloadInfo()); + } + /** * Reload the references of all the existing entities. * @@ -162,7 +183,7 @@ protected String getConfigParameter() { * Refresh the map of parameters with values fetched from the request * * @param keepOldParam when true, when a system parameter is not found in - * request, the previous system parameter will be stored + * the request, the previous system parameter will be stored */ protected void updateLocalParams(boolean keepOldParam) { Iterator paramNames = this.getSystemParams().keySet().iterator(); @@ -258,8 +279,10 @@ public String getExternalParamMarker() { private int _reloadingResult = -1; + public static final int FAILURE_RELOADING_RESULT_CODE = 0; public static final int SUCCESS_RELOADING_RESULT_CODE = 1; public static final int PROGRESS_RELOADING_RESULT_CODE = 2; + public static final int WARNING_RELOADING_RESULT_CODE = 3; } diff --git a/src/main/java/com/agiletec/apsadmin/admin/package_en.properties b/src/main/java/com/agiletec/apsadmin/admin/package_en.properties index 5f78a41e5..08c832a78 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/package_en.properties +++ b/src/main/java/com/agiletec/apsadmin/admin/package_en.properties @@ -9,6 +9,7 @@ name.editor.ckeditor=CKEditor name.editor.hoofed=Hoofed (moo-Entando component) message.reloadConfig.ok=The configuration has been reloaded +message.reloadConfig.warning=Some services reported an error during the reload message.reloadConfig.ko=Something went wrong while reloading the configuration. Try again in a minute. message.reloadEntities.ok=Reloading Entity references message.configSystemParams.ok=The settings have been updated @@ -22,3 +23,9 @@ page.reloadConfig.help=The Reload Configuration section allows you to reload the title.entityManagement = Entities title.entityAdmin.manage = Entities title.entityAdmin.entityManagers.reload = Reload the references + + +reload.table.head.beanId=Service ID +reload.table.head.status=Status +reload.bean.status.ok=Success +reload.bean.status.ko=ERROR diff --git a/src/main/java/com/agiletec/apsadmin/admin/package_it.properties b/src/main/java/com/agiletec/apsadmin/admin/package_it.properties index 15ac32583..8e473bb03 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/package_it.properties +++ b/src/main/java/com/agiletec/apsadmin/admin/package_it.properties @@ -10,6 +10,7 @@ name.editor.ckeditor=CKEditor name.editor.hoofed=Hoofed (fa parte di moo-Entando) message.reloadConfig.ok=La configurazione di sistema è stata ricaricata +message.reloadConfig.warning=Durante il ricaricamento alcuni servizi hanno riportato un errore message.reloadConfig.ko=Non è stato possibile ricaricare la configurazione di sistema message.reloadEntities.ok=Il ricaricamento delle referenze delle Entità è in corso message.configSystemParams.ok=I cambiamenti sono stati salvati @@ -23,3 +24,8 @@ page.reloadConfig.help=Dalla sezione RICARICA CONFIGURAZIONE è possibile title.entityManagement = Entità title.entityAdmin.manage = Entità title.entityAdmin.entityManagers.reload = Ricarica le referenze + +reload.table.head.beanId=ID del servizio +reload.table.head.status=Stato +reload.bean.status.ok=Successo +reload.bean.status.ko=ERRORE diff --git a/src/main/java/com/agiletec/apsadmin/admin/reload/ReloadConfigThread.java b/src/main/java/com/agiletec/apsadmin/admin/reload/ReloadConfigThread.java index eb182d3aa..c684f48f1 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/reload/ReloadConfigThread.java +++ b/src/main/java/com/agiletec/apsadmin/admin/reload/ReloadConfigThread.java @@ -1,16 +1,15 @@ package com.agiletec.apsadmin.admin.reload; import com.agiletec.aps.util.ApsWebApplicationUtils; -import java.util.List; import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpSession; import org.entando.entando.ent.util.EntLogging.EntLogFactory; import org.slf4j.Logger; public class ReloadConfigThread extends Thread { - Logger log = EntLogFactory.getSanitizedLogger(ReloadConfigThread.class); + public static final String RELOAD_THREAD = "RELOAD THREAD"; + private Logger log = EntLogFactory.getSanitizedLogger(ReloadConfigThread.class); private final HttpServletRequest request; public ReloadConfigThread(final HttpServletRequest request) { @@ -20,13 +19,14 @@ public ReloadConfigThread(final HttpServletRequest request) { @Override public void run() { try { - List result = ApsWebApplicationUtils.executeSystemRefresh(request); + ApsWebApplicationUtils.executeSystemRefresh(request); log.info("ReloadConfigThread completed execution"); - HttpSession session = request.getSession(); } catch (InterruptedException e) { - Thread.currentThread().interrupt(); + ApsWebApplicationUtils.getReloadInfo().put(RELOAD_THREAD, e.getMessage()); log.error("Thread interrupted", e); + Thread.currentThread().interrupt(); } catch (Throwable e) { + ApsWebApplicationUtils.getReloadInfo().put(RELOAD_THREAD, e.getMessage()); log.error("unexpected thread error", e); Thread.currentThread().interrupt(); } diff --git a/src/main/java/com/agiletec/apsadmin/global-messages_en.properties b/src/main/java/com/agiletec/apsadmin/global-messages_en.properties index e2aa6022a..338b9c66e 100644 --- a/src/main/java/com/agiletec/apsadmin/global-messages_en.properties +++ b/src/main/java/com/agiletec/apsadmin/global-messages_en.properties @@ -410,6 +410,7 @@ message.title.referencedUsers=Users message.note.resolveReferences=Sorry. You cannot perform this action right now, you must first unlink the following cross-references. messages.error=Error messages.confirm=Success +messages.warning=Warning struts.messages.error.file.too.large=The file is too big. diff --git a/src/main/java/com/agiletec/apsadmin/global-messages_it.properties b/src/main/java/com/agiletec/apsadmin/global-messages_it.properties index ca587c8fc..6acc53528 100644 --- a/src/main/java/com/agiletec/apsadmin/global-messages_it.properties +++ b/src/main/java/com/agiletec/apsadmin/global-messages_it.properties @@ -419,6 +419,7 @@ message.title.referencedUsers=Utenti message.note.resolveReferences=Per poter portare a termine l''operazione richiesta, è necessario prima sciogliere le seguenti associazioni o riferimenti incrociati messages.error=Errore messages.confirm=Conferma +messages.warning=Attenzione struts.messages.error.file.too.large=File eccedente la dimensione massima consentita. diff --git a/src/main/java/com/agiletec/apsadmin/system/BaseAction.java b/src/main/java/com/agiletec/apsadmin/system/BaseAction.java index 97b67d0f7..160cd9907 100644 --- a/src/main/java/com/agiletec/apsadmin/system/BaseAction.java +++ b/src/main/java/com/agiletec/apsadmin/system/BaseAction.java @@ -57,7 +57,7 @@ protected boolean isCurrentUserMemberOf(String groupName) { /** * Check if the current user has the given permission granted. It always returns true if the - * user has the the "superuser" permission set in some role. + * user has the "superuser" permission set in some role. * @param permissionName The name of the permission to check against the current user. * @return true if the user has the permission granted, false otherwise. */ diff --git a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadConfig.jsp b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadConfig.jsp index cfccdd38f..94aadac38 100644 --- a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadConfig.jsp +++ b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadConfig.jsp @@ -29,14 +29,49 @@
- -
- - ! - . -
+ + + +
+ + ! + . +
+ + +
+ + ! + . +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
#
: 
 - +
- + diff --git a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java index a48eb4e10..29707ff68 100644 --- a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java +++ b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java @@ -13,22 +13,32 @@ */ package com.agiletec.apsadmin.admin; +import static com.agiletec.apsadmin.admin.reload.ReloadConfigThread.RELOAD_THREAD; +import static java.lang.Thread.sleep; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertNull; import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyString; +import com.agiletec.aps.system.ApsSystemUtils; import com.agiletec.aps.system.SystemConstants; import com.agiletec.aps.system.services.baseconfig.ConfigInterface; import com.agiletec.aps.util.ApsWebApplicationUtils; import com.agiletec.apsadmin.ApsAdminBaseTestCase; +import com.agiletec.apsadmin.category.CategoryAction; +import com.agiletec.apsadmin.system.BaseAction; import com.opensymphony.xwork2.Action; import java.util.Map; +import java.util.Optional; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; import javax.servlet.ServletContext; import javax.servlet.http.HttpServletRequest; import javax.servlet.jsp.PageContext; +import org.apache.commons.lang3.StringUtils; import org.apache.lucene.util.ThreadInterruptedException; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; @@ -56,10 +66,11 @@ void testReloadConfig() throws Throwable { this.initAction("/do/BaseAdmin", "reloadConfig"); result = this.executeAction(); assertEquals(Action.SUCCESS, result); - synchronized (this) { - this.wait(3000); + while (ApsWebApplicationUtils.isReloadInProgress()) { + Thread.sleep(250); } assertEquals(BaseAdminAction.PROGRESS_RELOADING_RESULT_CODE, ((BaseAdminAction) this.getAction()).getReloadingResult()); + verifySuccessfulReload(); } @Test @@ -87,55 +98,12 @@ void testReloadConfigurationError() throws Throwable { this.setUserOnSession("admin"); this.initAction("/do/BaseAdmin", "reloadConfig"); String result = this.executeAction(); - assertEquals("reloadError", result); + assertEquals("reloadError", result); assertEquals(BaseAdminAction.FAILURE_RELOADING_RESULT_CODE, ((BaseAdminAction) this.getAction()).getReloadingResult()); - } - } - - @Test - void testReloadConfigurationThreadError() throws Throwable { - try (MockedStatic mockAWAU = Mockito.mockStatic(ApsWebApplicationUtils.class)) { - mockAWAU.when(ApsWebApplicationUtils::isReloadInProgress).thenReturn(false); - mockAWAU.when(ApsWebApplicationUtils::getReloadProgress).thenReturn(0); - - mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(ServletContext.class))) - .thenCallRealMethod(); - mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(PageContext.class))) - .thenCallRealMethod(); - mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(HttpServletRequest.class))) - .thenCallRealMethod(); - mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(PageContext.class))) - .thenCallRealMethod(); - mockAWAU.when(() -> ApsWebApplicationUtils.getWebApplicationContext(any(HttpServletRequest.class))) - .thenReturn(WebApplicationContextUtils.getWebApplicationContext( - this.getRequest().getSession().getServletContext())); - mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(HttpServletRequest.class))) - .thenThrow(new ThreadInterruptedException(new InterruptedException("Interrupted for testing!"))); - mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(ServletContext.class))) - .thenThrow(new ThreadInterruptedException(new InterruptedException("Interrupted for testing!"))); - this.setUserOnSession("admin"); - this.initAction("/do/BaseAdmin", "reloadConfig"); - String result = this.executeAction(); - assertEquals(Action.SUCCESS, result); - - assertEquals(BaseAdminAction.PROGRESS_RELOADING_RESULT_CODE, - ((BaseAdminAction) this.getAction()).getReloadingResult()); - - - mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(HttpServletRequest.class))) - .thenThrow(new RuntimeException("Exception needed for testing")); - mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(ServletContext.class))) - .thenThrow(new RuntimeException("Exception needed for testing")); - - this.setUserOnSession("admin"); - this.initAction("/do/BaseAdmin", "reloadConfig"); - result = this.executeAction(); - assertEquals(Action.SUCCESS, result); - - assertEquals(BaseAdminAction.PROGRESS_RELOADING_RESULT_CODE, - ((BaseAdminAction) this.getAction()).getReloadingResult()); + assertFalse(isReloadThreadError()); + assertTrue(ApsWebApplicationUtils.getReloadInfo().isEmpty()); } } @@ -302,6 +270,22 @@ void testUpdateConfigParams_2() throws Throwable { assertEquals("parameterValue", this.configManager.getParam("newCustomParameter")); } + private boolean isReloadThreadError() { + return ApsWebApplicationUtils.getReloadInfo().containsKey(RELOAD_THREAD); + } + + private boolean hasReloadError() { + Optional error = ApsWebApplicationUtils.getReloadInfo().values() + .stream().filter(StringUtils::isNotBlank) + .findFirst(); + return error.isPresent(); + } + + private void verifySuccessfulReload() { + assertFalse(isReloadThreadError()); + assertFalse(hasReloadError()); + } + @AfterEach void destroy() throws Exception { this.configManager.updateConfigItem(SystemConstants.CONFIG_ITEM_PARAMS, this.oldConfigParam); From f0a3efc7d4a96d873f0c62f94ecb63530cba2afb Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Thu, 10 Jul 2025 11:13:29 +0200 Subject: [PATCH 11/26] ENG-5566 Code cleaning --- .../admin/reload/ReloadConfigThread.java | 2 +- .../agiletec/apsadmin/system/BaseAction.java | 13 ++--- .../apsadmin/ApsAdminBaseTestCase.java | 58 +++++++++---------- 3 files changed, 35 insertions(+), 38 deletions(-) diff --git a/src/main/java/com/agiletec/apsadmin/admin/reload/ReloadConfigThread.java b/src/main/java/com/agiletec/apsadmin/admin/reload/ReloadConfigThread.java index c684f48f1..f9049d820 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/reload/ReloadConfigThread.java +++ b/src/main/java/com/agiletec/apsadmin/admin/reload/ReloadConfigThread.java @@ -9,7 +9,7 @@ public class ReloadConfigThread extends Thread { public static final String RELOAD_THREAD = "RELOAD THREAD"; - private Logger log = EntLogFactory.getSanitizedLogger(ReloadConfigThread.class); + private final Logger log = EntLogFactory.getSanitizedLogger(ReloadConfigThread.class); private final HttpServletRequest request; public ReloadConfigThread(final HttpServletRequest request) { diff --git a/src/main/java/com/agiletec/apsadmin/system/BaseAction.java b/src/main/java/com/agiletec/apsadmin/system/BaseAction.java index 160cd9907..80a81250f 100644 --- a/src/main/java/com/agiletec/apsadmin/system/BaseAction.java +++ b/src/main/java/com/agiletec/apsadmin/system/BaseAction.java @@ -120,19 +120,18 @@ protected List getActualAllowedGroups() { } } } - Collections.sort(this._actualAllowedGroups, new BeanComparator("description")); + this._actualAllowedGroups.sort(new BeanComparator<>("description")); return this._actualAllowedGroups; } protected List getActualAllowedGroupCodes() { List codes = new ArrayList<>(); List groups = this.getActualAllowedGroups(); - for (int i = 0; i < groups.size(); i++) { - Group group = groups.get(i); - if (null != group && !codes.contains(group.getName())) { - codes.add(group.getName()); - } - } + for (Group group : groups) { + if (null != group && !codes.contains(group.getName())) { + codes.add(group.getName()); + } + } return codes; } diff --git a/src/test/java/com/agiletec/apsadmin/ApsAdminBaseTestCase.java b/src/test/java/com/agiletec/apsadmin/ApsAdminBaseTestCase.java index 6f218fa35..021bf2dbf 100644 --- a/src/test/java/com/agiletec/apsadmin/ApsAdminBaseTestCase.java +++ b/src/test/java/com/agiletec/apsadmin/ApsAdminBaseTestCase.java @@ -70,7 +70,7 @@ public class ApsAdminBaseTestCase { private static MockHttpServletResponse response; private ActionSupport action; - private Map parameters = new HashMap(); + private final Map parameters = new HashMap<>(); @BeforeAll protected static void setUp() throws Exception { @@ -139,8 +139,7 @@ protected static void waitNotifyingThread() throws InterruptedException { protected static void waitThreads(String threadNamePrefix) throws InterruptedException { Thread[] threads = new Thread[20]; Thread.enumerate(threads); - for (int i = 0; i < threads.length; i++) { - Thread currentThread = threads[i]; + for (Thread currentThread : threads) { if (currentThread != null && currentThread.getName().startsWith(threadNamePrefix)) { currentThread.join(); @@ -163,7 +162,7 @@ protected void initAction(String namespace, String name, boolean refreshResponse // create a proxy class which is just a wrapper around the action call. // The proxy is created by checking the namespace and name against the // struts.xml configuration - ActionProxyFactory proxyFactory = (ActionProxyFactory) this.dispatcher.getContainer().getInstance(ActionProxyFactory.class); + ActionProxyFactory proxyFactory = (ActionProxyFactory) dispatcher.getContainer().getInstance(ActionProxyFactory.class); this.proxy = proxyFactory.createActionProxy(namespace, name, null, null, true, false); // set to true if you want to process Freemarker or JSP results @@ -173,26 +172,25 @@ protected void initAction(String namespace, String name, boolean refreshResponse // set the action context to the one that the proxy is using this.proxy.getInvocation().getInvocationContext().setSession(new HashMap<>()); ServletActionContext.setContext(this.proxy.getInvocation().getInvocationContext()); - ServletActionContext.setRequest(this.request); + ServletActionContext.setRequest(request); if (refreshResponse) { response = new MockHttpServletResponse(); RequestContext reqCtx = (RequestContext) getRequest().getAttribute(RequestContext.REQCTX); reqCtx.setResponse(response); } - ServletActionContext.setResponse(this.response); + ServletActionContext.setResponse(response); ServletActionContext.setServletContext(servletContext); this.action = (ActionSupport) this.proxy.getAction(); //reset previous params - List paramNames = new ArrayList(this.request.getParameterMap().keySet()); - for (int i = 0; i < paramNames.size(); i++) { - String paramName = (String) paramNames.get(i); - this.removeParameter(paramName); + List paramNames = new ArrayList<>(request.getParameterMap().keySet()); + for (String s : paramNames) { + this.removeParameter((String) s); } } /** - * Metodo da estendere in caso che si voglia impiantare un'altro + * Metodo da estendere in caso che si voglia impiantare un altro * struts-config. * * @param params The parameters @@ -213,7 +211,7 @@ protected static void setInitParameters(Properties params) { protected UserDetails getUser(String username, String password) throws Exception { IAuthenticationProviderManager provider = (IAuthenticationProviderManager) this.getService(SystemConstants.AUTHENTICATION_PROVIDER_MANAGER); IUserManager userManager = (IUserManager) this.getService(SystemConstants.USER_MANAGER); - UserDetails user = null; + UserDetails user; if (username.equals(SystemConstants.GUEST_USER_NAME)) { user = userManager.getGuestUser(); } else { @@ -240,19 +238,20 @@ protected void setUserOnSession(String username) throws Exception { return; } UserDetails currentUser = this.getUser(username, username);//nel database di test, username e password sono uguali - HttpSession session = this.request.getSession(); + HttpSession session = request.getSession(); + assert session != null; session.setAttribute(SystemConstants.SESSIONPARAM_CURRENT_USER, currentUser); } - protected void removeUserOnSession() throws Exception { - HttpSession session = this.request.getSession(); + protected void removeUserOnSession() { + HttpSession session = request.getSession(); + assert session != null; session.removeAttribute(SystemConstants.SESSIONPARAM_CURRENT_USER); } protected void addParameters(Map params) { - Iterator iter = params.keySet().iterator(); - while (iter.hasNext()) { - String key = (String) iter.next(); + for (Object o : params.keySet()) { + String key = (String) o; this.addParameter(key, params.get(key).toString()); } } @@ -264,7 +263,7 @@ protected void addParameter(String name, String[] values) { } protected void addParameter(String name, Collection value) { - this.request.removeParameter(name); + request.removeParameter(name); if (null == value) { return; } @@ -273,7 +272,7 @@ protected void addParameter(String name, Collection value) { int i = 0; while (iter.hasNext()) { String stringValue = iter.next(); - this.request.addParameter(name, stringValue); + request.addParameter(name, stringValue); array[i++] = stringValue; } Parameter.Request parameter = new Parameter.Request(name, array); @@ -281,35 +280,34 @@ protected void addParameter(String name, Collection value) { } protected void addParameter(String name, Object value) { - this.request.removeParameter(name); + request.removeParameter(name); if (null == value) { return; } - this.request.addParameter(name, value.toString()); + request.addParameter(name, value.toString()); Parameter.Request parameter = new Parameter.Request(name, value.toString()); this.parameters.put(name, parameter); } protected void addAttribute(String name, Object value) { - this.request.removeAttribute(name); + request.removeAttribute(name); if (null == value) { return; } - this.request.setAttribute(name, value); + request.setAttribute(name, value); } private void removeParameter(String name) { - this.request.removeParameter(name); - this.request.removeAttribute(name); + request.removeParameter(name); + request.removeAttribute(name); this.parameters.remove(name); } protected String executeAction() throws Throwable { ActionContext ac = this.getActionContext(); - ac.setParameters(HttpParameters.create(this.request.getParameterMap()).build()); + ac.setParameters(HttpParameters.create(request.getParameterMap()).build()); ac.getParameters().appendAll(this.parameters); - String result = this.proxy.execute(); - return result; + return this.proxy.execute(); } protected ActionInvocation getActionInvocation() { @@ -337,7 +335,7 @@ protected ActionSupport getAction() { } protected HttpServletRequest getRequest() { - return this.request; + return request; } } From 966470b7ff24120e85a4ab14a05287335934ca73 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Thu, 10 Jul 2025 12:18:48 +0200 Subject: [PATCH 12/26] ENG-5566 Test improved --- .../apsadmin/admin/TestBaseAdminAction.java | 107 ++++++++++++++---- 1 file changed, 88 insertions(+), 19 deletions(-) diff --git a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java index 29707ff68..638789f39 100644 --- a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java +++ b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java @@ -18,28 +18,25 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNotSame; import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertSame; import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyString; -import com.agiletec.aps.system.ApsSystemUtils; import com.agiletec.aps.system.SystemConstants; import com.agiletec.aps.system.services.baseconfig.ConfigInterface; import com.agiletec.aps.util.ApsWebApplicationUtils; import com.agiletec.apsadmin.ApsAdminBaseTestCase; -import com.agiletec.apsadmin.category.CategoryAction; -import com.agiletec.apsadmin.system.BaseAction; import com.opensymphony.xwork2.Action; +import java.util.HashMap; import java.util.Map; import java.util.Optional; -import java.util.concurrent.CountDownLatch; -import java.util.concurrent.TimeUnit; import javax.servlet.ServletContext; import javax.servlet.http.HttpServletRequest; import javax.servlet.jsp.PageContext; import org.apache.commons.lang3.StringUtils; -import org.apache.lucene.util.ThreadInterruptedException; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -169,18 +166,23 @@ void testReloadStatusCompleted() throws Throwable { .thenReturn(WebApplicationContextUtils.getWebApplicationContext(this.getRequest().getSession().getServletContext())); mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(HttpServletRequest.class))).thenCallRealMethod(); mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(ServletContext.class))).thenCallRealMethod(); + mockAWAU.when(ApsWebApplicationUtils::getReloadInfo).thenReturn(mockTestResultOk()); - this.setUserOnSession("admin"); + this.setUserOnSession("admin"); this.initAction("/do/BaseAdmin", "reloadStatus"); String result = this.executeAction(); assertEquals(Action.SUCCESS, result); - + assertFalse(((BaseAdminAction) this.getAction()).isReloadingErrorDetect()); + assertEquals(mockTestResultOk(), ((BaseAdminAction) this.getAction()).getReloadInfo()); + assertNotSame(mockTestResultOk(), ((BaseAdminAction) this.getAction()).getReloadInfo()); assertEquals(BaseAdminAction.SUCCESS_RELOADING_RESULT_CODE, ((BaseAdminAction) this.getAction()).getReloadingResult()); } } @Test - void testReloadStatus() throws Throwable { + void testReloadStatusSuccess() throws Throwable { + assertFalse(ApsWebApplicationUtils.isReloadInProgress()); + this.setUserOnSession("supervisorCoach"); this.initAction("/do/BaseAdmin", "reloadStatus"); String result = this.executeAction(); @@ -190,12 +192,59 @@ void testReloadStatus() throws Throwable { this.initAction("/do/BaseAdmin", "reloadStatus"); result = this.executeAction(); assertEquals(Action.SUCCESS, result); - synchronized (this) { - this.wait(3000); - } assertEquals(BaseAdminAction.SUCCESS_RELOADING_RESULT_CODE, ((BaseAdminAction) this.getAction()).getReloadingResult()); } + @Test + void testReloadStatusCompletedWithWarning() throws Throwable { + try (MockedStatic mockAWAU = Mockito.mockStatic(ApsWebApplicationUtils.class)) { + mockAWAU.when(ApsWebApplicationUtils::isReloadInProgress).thenCallRealMethod(); + mockAWAU.when(ApsWebApplicationUtils::getReloadProgress).thenCallRealMethod(); + + mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(ServletContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(PageContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(HttpServletRequest.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(PageContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getWebApplicationContext(any(HttpServletRequest.class))) + .thenReturn(WebApplicationContextUtils.getWebApplicationContext(this.getRequest().getSession().getServletContext())); + mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(HttpServletRequest.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(ServletContext.class))).thenCallRealMethod(); + mockAWAU.when(ApsWebApplicationUtils::getReloadInfo).thenReturn(mockTestResultWarning()); + + this.setUserOnSession("admin"); + this.initAction("/do/BaseAdmin", "reloadStatus"); + String result = this.executeAction(); + assertEquals(Action.SUCCESS, result); + assertTrue(((BaseAdminAction) this.getAction()).isReloadingErrorDetect()); + assertEquals(BaseAdminAction.WARNING_RELOADING_RESULT_CODE, ((BaseAdminAction) this.getAction()).getReloadingResult()); + } + } + + @Test + void testReloadStatusWithThreadError() throws Throwable { + try (MockedStatic mockAWAU = Mockito.mockStatic(ApsWebApplicationUtils.class)) { + mockAWAU.when(ApsWebApplicationUtils::isReloadInProgress).thenCallRealMethod(); + mockAWAU.when(ApsWebApplicationUtils::getReloadProgress).thenCallRealMethod(); + + mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(ServletContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getResources(anyString(), any(PageContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(HttpServletRequest.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getBean(anyString(), any(PageContext.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.getWebApplicationContext(any(HttpServletRequest.class))) + .thenReturn(WebApplicationContextUtils.getWebApplicationContext(this.getRequest().getSession().getServletContext())); + mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(HttpServletRequest.class))).thenCallRealMethod(); + mockAWAU.when(() -> ApsWebApplicationUtils.executeSystemRefresh(any(ServletContext.class))).thenCallRealMethod(); + mockAWAU.when(ApsWebApplicationUtils::getReloadInfo).thenReturn(mockTestResultThreadError()); + + this.setUserOnSession("admin"); + this.initAction("/do/BaseAdmin", "reloadStatus"); + String result = this.executeAction(); + assertEquals(Action.SUCCESS, result); + assertTrue(((BaseAdminAction) this.getAction()).isReloadingErrorDetect()); + assertEquals(BaseAdminAction.FAILURE_RELOADING_RESULT_CODE, ((BaseAdminAction) this.getAction()).getReloadingResult()); + } + } + @Test void testReloadEntitiesReferences() throws Throwable { this.setUserOnSession("supervisorCoach"); @@ -270,6 +319,18 @@ void testUpdateConfigParams_2() throws Throwable { assertEquals("parameterValue", this.configManager.getParam("newCustomParameter")); } + @AfterEach + void destroy() throws Exception { + this.configManager.updateConfigItem(SystemConstants.CONFIG_ITEM_PARAMS, this.oldConfigParam); + } + + @BeforeEach + void init() { + this.configManager = (ConfigInterface) this.getService(SystemConstants.BASE_CONFIG_MANAGER); + this.oldConfigParam = this.configManager.getConfigItem(SystemConstants.CONFIG_ITEM_PARAMS); + } + + private boolean isReloadThreadError() { return ApsWebApplicationUtils.getReloadInfo().containsKey(RELOAD_THREAD); } @@ -286,15 +347,23 @@ private void verifySuccessfulReload() { assertFalse(hasReloadError()); } - @AfterEach - void destroy() throws Exception { - this.configManager.updateConfigItem(SystemConstants.CONFIG_ITEM_PARAMS, this.oldConfigParam); + private Map mockTestResultOk() { + Map map = new HashMap<>(); + map.put("jacmsSearchEngineManager", ""); + map.put("jacmsResourceManager", ""); + map.put("UserProfileManager", ""); + return map; } - @BeforeEach - void init() { - this.configManager = (ConfigInterface) this.getService(SystemConstants.BASE_CONFIG_MANAGER); - this.oldConfigParam = this.configManager.getConfigItem(SystemConstants.CONFIG_ITEM_PARAMS); + private Map mockTestResultWarning() { + Map map = new HashMap<>(mockTestResultOk()); + map.put("myService", "error message"); + return map; } + private Map mockTestResultThreadError() { + Map map = new HashMap<>(mockTestResultOk()); + map.put(RELOAD_THREAD, "thread error message"); + return map; + } } From 98866683ef8d66d18b8a092fa2b31d2d6ddd555c Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Thu, 10 Jul 2025 12:43:01 +0200 Subject: [PATCH 13/26] ENG-5566 Test improved --- .../com/agiletec/apsadmin/admin/TestBaseAdminAction.java | 5 ----- 1 file changed, 5 deletions(-) diff --git a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java index 638789f39..b9b4fa42c 100644 --- a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java +++ b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java @@ -14,13 +14,11 @@ package com.agiletec.apsadmin.admin; import static com.agiletec.apsadmin.admin.reload.ReloadConfigThread.RELOAD_THREAD; -import static java.lang.Thread.sleep; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertNotSame; import static org.junit.jupiter.api.Assertions.assertNull; -import static org.junit.jupiter.api.Assertions.assertSame; import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyString; @@ -63,9 +61,6 @@ void testReloadConfig() throws Throwable { this.initAction("/do/BaseAdmin", "reloadConfig"); result = this.executeAction(); assertEquals(Action.SUCCESS, result); - while (ApsWebApplicationUtils.isReloadInProgress()) { - Thread.sleep(250); - } assertEquals(BaseAdminAction.PROGRESS_RELOADING_RESULT_CODE, ((BaseAdminAction) this.getAction()).getReloadingResult()); verifySuccessfulReload(); } From 81a2ec90a4a6f8509bfa7afb558eab3e8ddf6593 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Thu, 10 Jul 2025 13:52:12 +0200 Subject: [PATCH 14/26] ENG-5566 Code cleaning (fix code duplication in the JSP) --- .../jsp/admin/inc/reload-menu-intro.jsp | 30 +++++++++++++++++++ .../apsadmin/jsp/admin/reloadConfig.jsp | 28 +---------------- .../apsadmin/jsp/admin/reloadProgress.jsp | 29 ++---------------- 3 files changed, 33 insertions(+), 54 deletions(-) create mode 100644 src/main/webapp/WEB-INF/apsadmin/jsp/admin/inc/reload-menu-intro.jsp diff --git a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/inc/reload-menu-intro.jsp b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/inc/reload-menu-intro.jsp new file mode 100644 index 000000000..717d06c01 --- /dev/null +++ b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/inc/reload-menu-intro.jsp @@ -0,0 +1,30 @@ +<%@ taglib prefix="s" uri="/struts-tags" %> +<%@ taglib prefix="wp" uri="/aps-core" %> + +
    +
    2. +
  2. + "> + + +
    3. +
  3. + +
    4. +
+

+ +

+
+
+
+
+
diff --git a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadConfig.jsp b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadConfig.jsp index 94aadac38..45587ee6e 100644 --- a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadConfig.jsp +++ b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadConfig.jsp @@ -1,33 +1,7 @@ <%@ taglib prefix="s" uri="/struts-tags" %> <%@ taglib prefix="wp" uri="/aps-core" %> -
    -
    2. -
  2. - "> - - -
    3. -
  3. - -
    4. -
-

- -

-
-
-
-
-
+ diff --git a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadProgress.jsp b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadProgress.jsp index 406506a78..56a1776de 100644 --- a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadProgress.jsp +++ b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadProgress.jsp @@ -1,32 +1,7 @@ <%@ taglib prefix="s" uri="/struts-tags" %> <%@ taglib prefix="wp" uri="/aps-core" %> -
    -
    2. -
  2. - "> - - -
    3. -
  3. - -
    4. -
-

- -

-
-
-
-
-
+ +
From d6f4b7b216bd22dd5a29b610d0cdf987bcad1fd1 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Mon, 14 Jul 2025 12:14:16 +0200 Subject: [PATCH 15/26] ENG-5566 Replaced reload link with a POST form to improve request handling --- .../WEB-INF/apsadmin/jsp/admin/reloadChoose.jsp | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadChoose.jsp b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadChoose.jsp index b60b1f44b..0c57c3e4d 100644 --- a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadChoose.jsp +++ b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadChoose.jsp @@ -1,5 +1,7 @@ <%@ taglib prefix="s" uri="/struts-tags" %> <%@ taglib prefix="wp" uri="/aps-core" %> +<%@ taglib prefix="wpsf" uri="/apsadmin-form"%> +
  2. @@ -30,10 +32,15 @@

    -
    - " class="btn-danger button-fixed-width"> - - +
    + + + + +
    +
    From 2ed1403c2c94f1a7024966573269a025174e6aa0 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Mon, 14 Jul 2025 12:41:40 +0200 Subject: [PATCH 16/26] ENG-5566 Fix UI error reported by Sonar --- .../WEB-INF/apsadmin/jsp/admin/inc/reload-menu-intro.jsp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/inc/reload-menu-intro.jsp b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/inc/reload-menu-intro.jsp index 717d06c01..8faf4bd77 100644 --- a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/inc/reload-menu-intro.jsp +++ b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/inc/reload-menu-intro.jsp @@ -17,7 +17,8 @@ " data-placement="left" data-original-title=""> + data-content="" data-placement="left" data-original-title="" + onKeyDown="if(event.key === ' ' || event.key === 'Enter'){ event.preventDefault(); this.click(); }" > From 4dd51c0856487e0ca5a7553e24dc706dbf2bb44d Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Mon, 14 Jul 2025 13:07:27 +0200 Subject: [PATCH 17/26] ENG-5566 Added auto-refresh when reloading progress --- .../apsadmin/jsp/admin/reloadProgress.jsp | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadProgress.jsp b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadProgress.jsp index 56a1776de..9addd44e5 100644 --- a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadProgress.jsp +++ b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadProgress.jsp @@ -11,7 +11,7 @@

    - " class="btn-primary button-fixed-width"> + " class="btn-primary button-fixed-width">
    @@ -21,3 +21,17 @@
+ + From 8d22795ec1f85c2c173a2c82681c02be4de1d672 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Mon, 14 Jul 2025 17:41:12 +0200 Subject: [PATCH 18/26] ENG-5566 Added auto-refresh when reloading the configuration reload is running --- .../apsadmin/admin/BaseAdminAction.java | 23 +++++++---- .../com/agiletec/apsadmin/admin/baseAdmin.xml | 17 ++++++++ .../apsadmin/global-messages_en.properties | 2 +- .../apsadmin/global-messages_it.properties | 2 +- .../apsadmin/jsp/admin/reloadProgress.jsp | 40 ++++++++++++++----- .../apsadmin/admin/TestBaseAdminAction.java | 11 +++++ 6 files changed, 74 insertions(+), 21 deletions(-) diff --git a/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java b/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java index fd2d10203..128f93b4e 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java +++ b/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java @@ -74,13 +74,11 @@ public String reloadStatus() { this.setReloadingResult(PROGRESS_RELOADING_RESULT_CODE); return "inProgress"; } - if (ApsWebApplicationUtils.getReloadInfo().containsKey(RELOAD_THREAD)) { - this.setReloadingResult(FAILURE_RELOADING_RESULT_CODE); - } else if (isReloadingErrorDetect()) { - this.setReloadingResult(WARNING_RELOADING_RESULT_CODE); - } else { - this.setReloadingResult(SUCCESS_RELOADING_RESULT_CODE); - } + updateReloadStatusResult(); + return SUCCESS; + } + + public String reloadStatusJson() { return SUCCESS; } @@ -244,6 +242,16 @@ private void addFreePublicPages(IPage page, List pages) { } } + protected void updateReloadStatusResult() { + if (ApsWebApplicationUtils.getReloadInfo().containsKey(RELOAD_THREAD)) { + this.setReloadingResult(FAILURE_RELOADING_RESULT_CODE); + } else if (isReloadingErrorDetect()) { + this.setReloadingResult(WARNING_RELOADING_RESULT_CODE); + } else { + this.setReloadingResult(SUCCESS_RELOADING_RESULT_CODE); + } + } + protected ConfigInterface getConfigManager() { return _configManager; } @@ -279,7 +287,6 @@ public String getExternalParamMarker() { private int _reloadingResult = -1; - public static final int FAILURE_RELOADING_RESULT_CODE = 0; public static final int SUCCESS_RELOADING_RESULT_CODE = 1; public static final int PROGRESS_RELOADING_RESULT_CODE = 2; diff --git a/src/main/java/com/agiletec/apsadmin/admin/baseAdmin.xml b/src/main/java/com/agiletec/apsadmin/admin/baseAdmin.xml index 955508782..1c3f95674 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/baseAdmin.xml +++ b/src/main/java/com/agiletec/apsadmin/admin/baseAdmin.xml @@ -7,6 +7,15 @@ + + + + + true + + + + admin.BaseAdmin.settings superuser @@ -16,6 +25,7 @@ admin.BaseAdmin.reloadConfigChoose superuser + admin.BaseAdmin.reloadInProgress admin.BaseAdmin.reloadConfigResult @@ -28,6 +38,13 @@ superuser + + + reloadProgress + + superuser + + admin.BaseAdmin.reloadEntitiesReferencesResult superuser diff --git a/src/main/java/com/agiletec/apsadmin/global-messages_en.properties b/src/main/java/com/agiletec/apsadmin/global-messages_en.properties index 338b9c66e..1f9b5ee9a 100644 --- a/src/main/java/com/agiletec/apsadmin/global-messages_en.properties +++ b/src/main/java/com/agiletec/apsadmin/global-messages_en.properties @@ -169,7 +169,7 @@ label.required=Required label.requiredFields=Required Fields label.message.seach=Search for existing label label.reload.confirm=Are you sure you want to reload the configuration? -label.reload.message.check=Click the button to refresh the progress of the configuration reload +label.reload.message.check=If the update does not occur, press the button below label.reload.progress=Overall progress label.chooseYourCategoriesTreeStyle=Choose the style of the Category tree label.fullname=Full name diff --git a/src/main/java/com/agiletec/apsadmin/global-messages_it.properties b/src/main/java/com/agiletec/apsadmin/global-messages_it.properties index 6acc53528..f5b0bb6ed 100644 --- a/src/main/java/com/agiletec/apsadmin/global-messages_it.properties +++ b/src/main/java/com/agiletec/apsadmin/global-messages_it.properties @@ -175,7 +175,7 @@ label.required=Obbligatorio label.requiredFields=Campi obbligatori label.message.seach=Cerca per label esistente label.reload.confirm=Si e' sicuri di voler ricaricare la configurazione? -label.reload.message.check=Premere il bottone per visualizzare di avanzamento della ricarica configurazione +label.reload.message.check=In caso di mancato aggiornamento, premere il bottone sottostante label.reload.progress=Percentuale completamento label.chooseYourCategoriesTreeStyle=Scegli lo stile dell''albero delle categorie label.fullname=Nome completo diff --git a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadProgress.jsp b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadProgress.jsp index 9addd44e5..787c7124f 100644 --- a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadProgress.jsp +++ b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadProgress.jsp @@ -15,23 +15,41 @@ -
-

: %

-
+
+

+ :  + % +

+
diff --git a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java index b9b4fa42c..219a50640 100644 --- a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java +++ b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java @@ -240,6 +240,17 @@ void testReloadStatusWithThreadError() throws Throwable { } } + @Test + void testAjaxCall() throws Throwable { + assertFalse(ApsWebApplicationUtils.isReloadInProgress()); + this.setUserOnSession("admin"); + this.initAction("/do/BaseAdmin", "reloadStatus"); + String result = this.executeAction(); + assertEquals(Action.SUCCESS, result); + final int progress = ((BaseAdminAction)this.getAction()).getReloadProgress(); + assertEquals(-1, progress); + } + @Test void testReloadEntitiesReferences() throws Throwable { this.setUserOnSession("supervisorCoach"); From 099e4dd48d6fb1a072126e6ea60bd74f267d8a12 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Mon, 14 Jul 2025 17:57:08 +0200 Subject: [PATCH 19/26] ENG-5566 Fix test --- .../java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java index 219a50640..e589f025c 100644 --- a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java +++ b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java @@ -244,7 +244,7 @@ void testReloadStatusWithThreadError() throws Throwable { void testAjaxCall() throws Throwable { assertFalse(ApsWebApplicationUtils.isReloadInProgress()); this.setUserOnSession("admin"); - this.initAction("/do/BaseAdmin", "reloadStatus"); + this.initAction("/do/BaseAdmin", "reloadStatusJson"); String result = this.executeAction(); assertEquals(Action.SUCCESS, result); final int progress = ((BaseAdminAction)this.getAction()).getReloadProgress(); From 82714753ea21a7ce837e6d427aadba2d72bee6d1 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Tue, 15 Jul 2025 09:39:26 +0200 Subject: [PATCH 20/26] ENG-5566 Fix UI following quality gate recommendations --- .../apsadmin/jsp/admin/inc/reload-menu-intro.jsp | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/inc/reload-menu-intro.jsp b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/inc/reload-menu-intro.jsp index 8faf4bd77..67119a754 100644 --- a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/inc/reload-menu-intro.jsp +++ b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/inc/reload-menu-intro.jsp @@ -16,11 +16,12 @@ From 2209fa7bb674fad6ab60e241a8119cf27db7deb8 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Mon, 21 Jul 2025 12:19:04 +0200 Subject: [PATCH 21/26] ENG-5566 Added reload message --- .../com/agiletec/apsadmin/admin/package_en.properties | 2 ++ .../com/agiletec/apsadmin/admin/package_it.properties | 2 ++ .../webapp/WEB-INF/apsadmin/jsp/admin/reloadConfig.jsp | 10 +++++++++- 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/src/main/java/com/agiletec/apsadmin/admin/package_en.properties b/src/main/java/com/agiletec/apsadmin/admin/package_en.properties index 08c832a78..62f18435e 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/package_en.properties +++ b/src/main/java/com/agiletec/apsadmin/admin/package_en.properties @@ -29,3 +29,5 @@ reload.table.head.beanId=Service ID reload.table.head.status=Status reload.bean.status.ok=Success reload.bean.status.ko=ERROR + +reload.legend.info=The information displayed depends on how the service was implemented. Any internal errors may not appear on this screen but are visible in the system logs. diff --git a/src/main/java/com/agiletec/apsadmin/admin/package_it.properties b/src/main/java/com/agiletec/apsadmin/admin/package_it.properties index 8e473bb03..08c10413e 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/package_it.properties +++ b/src/main/java/com/agiletec/apsadmin/admin/package_it.properties @@ -29,3 +29,5 @@ reload.table.head.beanId=ID del servizio reload.table.head.status=Stato reload.bean.status.ok=Successo reload.bean.status.ko=ERRORE + +reload.legend.info=le informazioni mostrate dipendono da come il servizio è stato implementato. Eventuali errori interni potrebbero non essere riportati in questa schermata, ma sono visibili solo a livello di log. diff --git a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadConfig.jsp b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadConfig.jsp index 45587ee6e..588c3acbe 100644 --- a/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadConfig.jsp +++ b/src/main/webapp/WEB-INF/apsadmin/jsp/admin/reloadConfig.jsp @@ -3,6 +3,15 @@ +
+
+ + : +
+
+ +
+ @@ -19,7 +28,6 @@ . - From f01fe5b1004f5232794153a58433d7849b2f82d3 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Thu, 9 Oct 2025 10:30:47 +0200 Subject: [PATCH 22/26] ENG-5566 Introduced constants for BaseAdminAction action returns --- .../com/agiletec/apsadmin/admin/BaseAdminAction.java | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java b/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java index 128f93b4e..fdc4f1659 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java +++ b/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java @@ -46,6 +46,10 @@ public class BaseAdminAction extends BaseAction { private static final EntLogger logger = EntLogFactory.getSanitizedLogger(BaseAdminAction.class); + public static final String RELOAD_ERROR = "reloadError"; + public static final String IN_PROGRESS = "inProgress"; + public static final String NEW_PARAM_MARKER = "_newParamMarker"; + /** * Reload the system configuration. * @@ -64,7 +68,7 @@ public String reloadConfig() { } catch (Exception e) { logger.error("unexpected error while launching system reload", e); this.setReloadingResult(FAILURE_RELOADING_RESULT_CODE); - return "reloadError"; + return RELOAD_ERROR; } return SUCCESS; } @@ -72,7 +76,7 @@ public String reloadConfig() { public String reloadStatus() { if (ApsWebApplicationUtils.isReloadInProgress()) { this.setReloadingResult(PROGRESS_RELOADING_RESULT_CODE); - return "inProgress"; + return IN_PROGRESS; } updateReloadStatusResult(); return SUCCESS; @@ -277,7 +281,7 @@ public void setSystemParams(Map systemParams) { } public String getExternalParamMarker() { - return "_newParamMarker"; + return NEW_PARAM_MARKER; } private ConfigInterface _configManager; From b863adb67693ad1372e5a63134ff4a6cb392ba9a Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Thu, 9 Oct 2025 16:55:02 +0200 Subject: [PATCH 23/26] ENG-5566 Update entando-engine dependency to 6.5.5 --- pom.xml | 4 ++-- .../com/agiletec/apsadmin/admin/BaseAdminAction.java | 10 ++++------ 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/pom.xml b/pom.xml index ed95b2ed1..e3d1c8ce5 100644 --- a/pom.xml +++ b/pom.xml @@ -238,14 +238,14 @@ org.entando.entando entando-engine - 6.5.5-ENG-5566-PR-340 + 6.5.5 org.entando.entando entando-engine test-jar test - 6.5.5-ENG-5566-PR-340 + 6.5.5 org.apache.struts diff --git a/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java b/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java index fdc4f1659..76d0fe3e6 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java +++ b/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java @@ -188,11 +188,9 @@ protected String getConfigParameter() { * the request, the previous system parameter will be stored */ protected void updateLocalParams(boolean keepOldParam) { - Iterator paramNames = this.getSystemParams().keySet().iterator(); - while (paramNames.hasNext()) { - String paramName = (String) paramNames.next(); + for (String paramName : this.getSystemParams().keySet()) { String newValue = this.getRequest().getParameter(paramName); - if (null != newValue) { + if (StringUtils.isNotBlank(newValue)) { this.getSystemParams().put(paramName, newValue); } else if (!keepOldParam) { this.getSystemParams().put(paramName, "false"); @@ -240,8 +238,8 @@ private void addFreePublicPages(IPage page, List pages) { pages.add(page); } String[] children = page.getChildrenCodes(); - for (int i = 0; i < children.length; i++) { - IPage child = this.getPageManager().getOnlinePage(children[i]); + for (String s : children) { + IPage child = this.getPageManager().getOnlinePage(s); this.addFreePublicPages(child, pages); } } From a55d112183cebf47a059ba515e7537fa0e92e7b2 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Fri, 10 Oct 2025 16:07:00 +0200 Subject: [PATCH 24/26] ENG-5566 Disabled SNYK --- .github/workflows/pr.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index 1890fa8f8..63369add4 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -177,6 +177,7 @@ jobs: export ENTANDO_OPT_SONAR_PROJECT_KEY="${{ secrets.ENTANDO_OPT_SONAR_PROJECT_KEY }}" ;; MTX-SCAN-SNYK) + exit 0 export SNYK_TOKEN="${{ secrets.SNYK_TOKEN }}" ;; MTX-MVN-POST-DEPLOYMENT-TESTS) From bfebd6df4c856a3195ec9e94937fa1642d6bbfc7 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Fri, 10 Oct 2025 16:25:10 +0200 Subject: [PATCH 25/26] ENG-5566 Temp refactor for test error tracing --- .../com/agiletec/apsadmin/admin/TestBaseAdminAction.java | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java index e589f025c..85d9df81d 100644 --- a/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java +++ b/src/test/java/com/agiletec/apsadmin/admin/TestBaseAdminAction.java @@ -327,7 +327,12 @@ void testUpdateConfigParams_2() throws Throwable { @AfterEach void destroy() throws Exception { - this.configManager.updateConfigItem(SystemConstants.CONFIG_ITEM_PARAMS, this.oldConfigParam); + try { + this.configManager.updateConfigItem(SystemConstants.CONFIG_ITEM_PARAMS, this.oldConfigParam); + } catch (Exception e) { + e.printStackTrace(); + throw e; + } } @BeforeEach From 8759d63094c392ef8f882dc3180db500e2890e58 Mon Sep 17 00:00:00 2001 From: "Matteo E. Minnai" Date: Fri, 10 Oct 2025 16:40:27 +0200 Subject: [PATCH 26/26] ENG-5566 Reverted enhanced for refactor --- .../com/agiletec/apsadmin/admin/BaseAdminAction.java | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java b/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java index 76d0fe3e6..fdc4f1659 100644 --- a/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java +++ b/src/main/java/com/agiletec/apsadmin/admin/BaseAdminAction.java @@ -188,9 +188,11 @@ protected String getConfigParameter() { * the request, the previous system parameter will be stored */ protected void updateLocalParams(boolean keepOldParam) { - for (String paramName : this.getSystemParams().keySet()) { + Iterator paramNames = this.getSystemParams().keySet().iterator(); + while (paramNames.hasNext()) { + String paramName = (String) paramNames.next(); String newValue = this.getRequest().getParameter(paramName); - if (StringUtils.isNotBlank(newValue)) { + if (null != newValue) { this.getSystemParams().put(paramName, newValue); } else if (!keepOldParam) { this.getSystemParams().put(paramName, "false"); @@ -238,8 +240,8 @@ private void addFreePublicPages(IPage page, List pages) { pages.add(page); } String[] children = page.getChildrenCodes(); - for (String s : children) { - IPage child = this.getPageManager().getOnlinePage(s); + for (int i = 0; i < children.length; i++) { + IPage child = this.getPageManager().getOnlinePage(children[i]); this.addFreePublicPages(child, pages); } }