From ab61b168bde5b3922850b07bad9ccc09adf12e9c Mon Sep 17 00:00:00 2001
From: Avgustin Marinov <Avgustin.Marinov@bosch.com>
Date: Mon, 19 Feb 2024 17:23:56 +0200
Subject: [PATCH] [#1650] Expose externalRef via search filters (#1657)

add option to filter actions using _externalref_ property

Signed-off-by: Marinov Avgustin <Avgustin.Marinov@bosch.com>
---
 .../hawkbit/repository/ActionFields.java      | 11 +++--
 .../jpa/rsql/RSQLActionFieldsTest.java        | 13 ++++++
 .../rest/resource/MgmtActionResourceTest.java | 42 +++++++++++++++++++
 3 files changed, 63 insertions(+), 3 deletions(-)

diff --git a/hawkbit-core/src/main/java/org/eclipse/hawkbit/repository/ActionFields.java b/hawkbit-core/src/main/java/org/eclipse/hawkbit/repository/ActionFields.java
index 6cacbe1ea..6692be0aa 100644
--- a/hawkbit-core/src/main/java/org/eclipse/hawkbit/repository/ActionFields.java
+++ b/hawkbit-core/src/main/java/org/eclipse/hawkbit/repository/ActionFields.java
@@ -64,7 +64,13 @@ public enum ActionFields implements FieldNameProvider, FieldValueConverter<Actio
     /**
      * The rollout field
      */
-    ROLLOUTGROUP("rolloutGroup", RolloutGroupFields.ID.getFieldName(), RolloutGroupFields.NAME.getFieldName());
+    ROLLOUTGROUP("rolloutGroup", RolloutGroupFields.ID.getFieldName(), RolloutGroupFields.NAME.getFieldName()),
+
+
+    /**
+     * The weight field.
+     */
+    EXTERNALREF("externalRef");
 
     private static final String ACTIVE = "pending";
     private static final String INACTIVE = "finished";
@@ -119,5 +125,4 @@ public enum ActionFields implements FieldNameProvider, FieldValueConverter<Actio
             return null;
         }
     }
-
-}
+}
\ No newline at end of file
diff --git a/hawkbit-repository/hawkbit-repository-jpa/src/test/java/org/eclipse/hawkbit/repository/jpa/rsql/RSQLActionFieldsTest.java b/hawkbit-repository/hawkbit-repository-jpa/src/test/java/org/eclipse/hawkbit/repository/jpa/rsql/RSQLActionFieldsTest.java
index 9e231e525..de485602e 100644
--- a/hawkbit-repository/hawkbit-repository-jpa/src/test/java/org/eclipse/hawkbit/repository/jpa/rsql/RSQLActionFieldsTest.java
+++ b/hawkbit-repository/hawkbit-repository-jpa/src/test/java/org/eclipse/hawkbit/repository/jpa/rsql/RSQLActionFieldsTest.java
@@ -62,6 +62,11 @@ public class RSQLActionFieldsTest extends AbstractJpaIntegrationTest {
             newAction.setTarget(target);
             newAction.setWeight(45);
             newAction.setInitiatedBy(tenantAware.getCurrentUsername());
+            if ((i % 2) == 0) {
+                newAction.setExternalRef("extRef");
+            } else {
+                newAction.setExternalRef("extRef2");
+            }
             actionRepository.save(newAction);
             target.addAction(newAction);
         }
@@ -100,6 +105,14 @@ public class RSQLActionFieldsTest extends AbstractJpaIntegrationTest {
             fail("Missing expected RSQLParameterUnsupportedFieldException because status cannot be compared with 'true'");
         } catch (final RSQLParameterUnsupportedFieldException e) {
         }
+
+    }
+    @Test
+    @Description("Test action by status")
+    public void testFilterByParameterExtRef() {
+        assertRSQLQuery(ActionFields.EXTERNALREF.name() + "==extRef", 5);
+        assertRSQLQuery(ActionFields.EXTERNALREF.name() + "!=extRef", 6);
+        assertRSQLQuery(ActionFields.EXTERNALREF.name() + "==extRef*", 10);
     }
 
     private void assertRSQLQuery(final String rsqlParam, final long expectedEntities) {
diff --git a/hawkbit-rest/hawkbit-mgmt-resource/src/test/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtActionResourceTest.java b/hawkbit-rest/hawkbit-mgmt-resource/src/test/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtActionResourceTest.java
index 918eb1c87..b396d0767 100644
--- a/hawkbit-rest/hawkbit-mgmt-resource/src/test/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtActionResourceTest.java
+++ b/hawkbit-rest/hawkbit-mgmt-resource/src/test/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtActionResourceTest.java
@@ -128,6 +128,48 @@ class MgmtActionResourceTest extends AbstractManagementApiIntegrationTest {
 
     }
 
+    @Test
+    @Description("Verifies that actions can be filtered based on extRef.")
+    void filterActionsByExternalRef() throws Exception {
+        // prepare test
+        final String knownTargetId = "targetId";
+        final List<Action> actions = generateTargetWithTwoUpdatesWithOneOverride(knownTargetId);
+
+        final Action action0 = actions.get(0);
+        final Action action1 = actions.get(1);
+
+        final List<String> externalRefs = new ArrayList<>(2);
+        externalRefs.add("extRef");
+        externalRefs.add("extRef#123_1");
+        controllerManagement.updateActionExternalRef(action0.getId(), externalRefs.get(0));
+        controllerManagement.updateActionExternalRef(action1.getId(), externalRefs.get(1));
+
+        final String rsqlExtRef = "externalref==extRef";
+        final String rsqlExtRefWildcard = "externalref==extRef*";
+        final String rsqlExtRefNoMatch = "externalref==234extRef";
+
+        // pending status one result
+        mvc.perform(get(MgmtRestConstants.ACTION_V1_REQUEST_MAPPING + "?q=" + rsqlExtRef))
+                .andDo(MockMvcResultPrinter.print())
+                .andExpect(status().isOk()).andExpect(jsonPath("total", equalTo(1)))
+                .andExpect(jsonPath("size", equalTo(1)))
+                .andExpect(jsonPath("content[0].externalRef", equalTo(externalRefs.get(0))));
+
+        // finished status none result
+        mvc.perform(get(MgmtRestConstants.ACTION_V1_REQUEST_MAPPING + "?q=" + rsqlExtRefWildcard))
+                .andDo(MockMvcResultPrinter.print())
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("total", equalTo(2)))
+                .andExpect(jsonPath("size", equalTo(2)));
+
+        // pending or finished status one result
+        mvc.perform(get(MgmtRestConstants.ACTION_V1_REQUEST_MAPPING + "?q=" + rsqlExtRefNoMatch))
+                .andDo(MockMvcResultPrinter.print())
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("total", equalTo(0)))
+                .andExpect(jsonPath("size", equalTo(0)));
+    }
+
     @Test
     @Description("Verifies that actions can be filtered based on the action status code that was reported last.")
     void filterActionsByLastStatusCode() throws Exception {