feature: Implement retrieving BPNs given BPN group identifier (#1899)

* Create bpn's retrievel given bpn group identifier flow.

* Added some tests

* Fix query syntax

* Small clean up.

* Small readability changes.

* Remove not needed unit test.

* Fix Controller Tests.

* Changes from PR.

* Changes from PR.

* Changes from PR.

Author: bmg13

edc-extensions/bpn-validation/bpn-validation-api/src/main/java/org/eclipse/tractusx/edc/api/bpn/BaseBusinessPartnerGroupApiController.java

@@ -39,21 +39,19 @@
 
 public abstract class BaseBusinessPartnerGroupApiController {
 
-    private final BusinessPartnerStore businessPartnerService;
+    protected final BusinessPartnerStore businessPartnerService;
 
     public BaseBusinessPartnerGroupApiController(BusinessPartnerStore businessPartnerService) {
         this.businessPartnerService = businessPartnerService;
     }
 
     public JsonObject resolve(String bpn) {
-
-        // StoreResult does not support the .map() operator, because it does not override newInstance()
-        var result = businessPartnerService.resolveForBpn(bpn);
-        if (result.succeeded()) {
-            return createObject(bpn, result.getContent());
-        }
-
-        throw new ObjectNotFoundException(List.class, result.getFailureDetail());
+        return businessPartnerService.resolveForBpn(bpn)
+                .map(result -> Json.createObjectBuilder()
+                        .add(ID, bpn)
+                        .add(TX_NAMESPACE + "groups", Json.createArrayBuilder(result))
+                        .build())
+                .orElseThrow(failure -> new ObjectNotFoundException(List.class, failure.getFailureDetail()));
     }
 
     public void deleteEntry(@PathParam("bpn") String bpn) {
@@ -75,13 +73,6 @@ public void createEntry(@RequestBody JsonObject object) {
                 .orElseThrow(f -> new ObjectConflictException(f.getFailureDetail()));
     }
 
-    private JsonObject createObject(String bpn, List<String> list) {
-        return Json.createObjectBuilder()
-                .add(ID, bpn)
-                .add(TX_NAMESPACE + "groups", Json.createArrayBuilder(list))
-                .build();
-    }
-
     private String getBpn(JsonObject object) {
         try {
             return object.getString(ID);

edc-extensions/bpn-validation/bpn-validation-api/src/main/java/org/eclipse/tractusx/edc/api/bpn/v3/BusinessPartnerGroupApiV3.java

@@ -50,6 +50,15 @@ public interface BusinessPartnerGroupApiV3 {
             })
     JsonObject resolveV3(@Parameter(name = "bpn", description = "The business partner number") String bpn);
 
+    @Operation(description = "Resolves all BPNs for a particular BPN group",
+            responses = {
+                    @ApiResponse(responseCode = "200", description = "An object containing an array with the bpns assigned to the group"),
+                    @ApiResponse(responseCode = "404", description = "No entry for the given BPN group was found"),
+                    @ApiResponse(responseCode = "400", description = "Request body was malformed",
+                            content = @Content(array = @ArraySchema(schema = @Schema(implementation = ApiErrorDetail.class))))
+            })
+    JsonObject resolveGroupV3(@Parameter(name = "group", description = "The business partner group") String group);
+
     @Operation(description = "Deletes the entry for a particular BPN",
             responses = {
                     @ApiResponse(responseCode = "204", description = "The object was successfully deleted"),

edc-extensions/bpn-validation/bpn-validation-api/src/main/java/org/eclipse/tractusx/edc/api/bpn/v3/BusinessPartnerGroupApiV3Controller.java

@@ -20,6 +20,7 @@
 package org.eclipse.tractusx.edc.api.bpn.v3;
 
 import io.swagger.v3.oas.annotations.parameters.RequestBody;
+import jakarta.json.Json;
 import jakarta.json.JsonObject;
 import jakarta.ws.rs.Consumes;
 import jakarta.ws.rs.DELETE;
@@ -30,12 +31,18 @@
 import jakarta.ws.rs.PathParam;
 import jakarta.ws.rs.Produces;
 import jakarta.ws.rs.core.MediaType;
+import org.eclipse.edc.web.spi.exception.ObjectNotFoundException;
 import org.eclipse.tractusx.edc.api.bpn.BaseBusinessPartnerGroupApiController;
 import org.eclipse.tractusx.edc.validation.businesspartner.spi.BusinessPartnerStore;
 
+import java.util.List;
 
-@Consumes({MediaType.APPLICATION_JSON})
-@Produces({MediaType.APPLICATION_JSON})
+import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.ID;
+import static org.eclipse.tractusx.edc.edr.spi.CoreConstants.TX_NAMESPACE;
+
+
+@Consumes({ MediaType.APPLICATION_JSON })
+@Produces({ MediaType.APPLICATION_JSON })
 @Path("/v3/business-partner-groups")
 public class BusinessPartnerGroupApiV3Controller extends BaseBusinessPartnerGroupApiController implements BusinessPartnerGroupApiV3 {
 
@@ -50,6 +57,18 @@ public JsonObject resolveV3(@PathParam("bpn") String bpn) {
         return super.resolve(bpn);
     }
 
+    @GET
+    @Path("/group/{group}")
+    @Override
+    public JsonObject resolveGroupV3(@PathParam("group") String group) {
+        return businessPartnerService.resolveForBpnGroup(group)
+                .map(result -> Json.createObjectBuilder()
+                        .add(ID, group)
+                        .add(TX_NAMESPACE + "bpns", Json.createArrayBuilder(result))
+                        .build())
+                .orElseThrow(failure -> new ObjectNotFoundException(List.class, failure.getFailureDetail()));
+    }
+
     @DELETE
     @Path("/{bpn}")
     @Override

edc-extensions/bpn-validation/bpn-validation-api/src/test/java/org/eclipse/tractusx/edc/api/bpn/v3/BusinessPartnerGroupApiV3ControllerTest.java

@@ -21,13 +21,39 @@
 
 import io.restassured.specification.RequestSpecification;
 import org.eclipse.edc.junit.annotations.ApiTest;
+import org.eclipse.edc.spi.result.StoreResult;
 import org.eclipse.tractusx.edc.api.bpn.BaseBusinessPartnerGroupApiControllerTest;
+import org.junit.jupiter.api.Test;
+
+import java.util.List;
 
 import static io.restassured.RestAssured.given;
+import static org.hamcrest.Matchers.notNullValue;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.when;
 
 @ApiTest
 class BusinessPartnerGroupApiV3ControllerTest extends BaseBusinessPartnerGroupApiControllerTest {
 
+    @Test
+    void resolveForBpnGroup_exists() {
+        when(businessPartnerStore.resolveForBpnGroup(any())).thenReturn(StoreResult.success(List.of("bpn1", "bpn2")));
+        baseRequest()
+                .get("/group/test-bpn-group")
+                .then()
+                .statusCode(200)
+                .body(notNullValue());
+    }
+
+    @Test
+    void resolveForBpnGroup_notExists_returns404() {
+        when(businessPartnerStore.resolveForBpnGroup(any())).thenReturn(StoreResult.notFound("test-message"));
+        baseRequest()
+                .get("/group/test-bpn-group-not-exists")
+                .then()
+                .statusCode(404);
+    }
+
     @Override
     protected Object controller() {
         return new BusinessPartnerGroupApiV3Controller(businessPartnerStore);

edc-extensions/bpn-validation/bpn-validation-core/src/main/java/org/eclipse/tractusx/edc/validation/businesspartner/defaults/InMemoryBusinessPartnerStore.java

@@ -25,6 +25,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
 
 public class InMemoryBusinessPartnerStore implements BusinessPartnerStore {
     private final Map<String, List<String>> cache = new HashMap<>();
@@ -37,6 +38,17 @@ public StoreResult<List<String>> resolveForBpn(String businessPartnerNumber) {
                 StoreResult.success(entry);
     }
 
+    @Override
+    public StoreResult<List<String>> resolveForBpnGroup(String businessPartnerGroup) {
+        var bpns = cache.entrySet().stream()
+                .filter(bpn -> bpn.getValue().stream().anyMatch(groups -> groups.contains(businessPartnerGroup)))
+                .map(Map.Entry::getKey)
+                .collect(Collectors.toList());
+        return bpns.isEmpty() ?
+                StoreResult.notFound(NOT_FOUND_TEMPLATE.formatted(businessPartnerGroup)) :
+                StoreResult.success(bpns);
+    }
+
     @Override
     public StoreResult<Void> save(String businessPartnerNumber, List<String> groups) {
         //to maintain behavioural consistency with the SQL store

edc-extensions/bpn-validation/bpn-validation-core/src/testFixtures/java/org/eclipse/tractusx/edc/validation/businesspartner/store/BusinessPartnerStoreTestBase.java

@@ -25,6 +25,8 @@
 import java.util.List;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.InstanceOfAssertFactories.list;
+import static org.eclipse.edc.junit.assertions.AbstractResultAssert.assertThat;
 
 public abstract class BusinessPartnerStoreTestBase {
 
@@ -45,6 +47,24 @@ void resolveForBpn_existsNoGroups() {
         assertThat(getStore().resolveForBpn("test-bpn").getContent()).isNotNull().isEmpty();
     }
 
+    @Test
+    void resolveForBpnGroup_multipleBpns() {
+        getStore().save("test-bpn-0", List.of("group2"));
+        getStore().save("test-bpn-1", List.of("test-bpn-group", "group2", "group3"));
+        getStore().save("test-bpn-2", List.of("test-bpn-group"));
+        getStore().save("test-bpn-3", List.of("test-bpn-group", "group17"));
+
+        assertThat(getStore().resolveForBpnGroup("test-bpn-group"))
+                .isSucceeded()
+                .asInstanceOf(list(String.class))
+                .containsExactly("test-bpn-1", "test-bpn-2", "test-bpn-3");
+    }
+
+    @Test
+    void resolveForBpnGroup_bpnGroupNotExists() {
+        assertThat(getStore().resolveForBpnGroup("group-not-exist")).isFailed();
+    }
+
     @Test
     void save() {
         getStore().save("test-bpn", List.of("group1", "group2", "group3"));

edc-extensions/bpn-validation/bpn-validation-spi/src/main/java/org/eclipse/tractusx/edc/validation/businesspartner/spi/BusinessPartnerStore.java

@@ -31,6 +31,8 @@ public interface BusinessPartnerStore {
 
     StoreResult<List<String>> resolveForBpn(String businessPartnerNumber);
 
+    StoreResult<List<String>> resolveForBpnGroup(String businessPartnerGroup);
+
     StoreResult<Void> save(String businessPartnerNumber, List<String> groups);
 
     StoreResult<Void> delete(String businessPartnerNumber);

edc-extensions/bpn-validation/business-partner-store-sql/src/main/java/org/eclipse/tractusx/edc/validation/businesspartner/store/sql/BusinessPartnerGroupStatements.java

@@ -38,6 +38,8 @@ default String getTable() {
 
     String findByBpnTemplate();
 
+    String findByBpnGroupTemplate();
+
     String insertTemplate();
 
     String deleteTemplate();

edc-extensions/bpn-validation/business-partner-store-sql/src/main/java/org/eclipse/tractusx/edc/validation/businesspartner/store/sql/PostgresBusinessPartnerGroupStatements.java

@@ -33,6 +33,12 @@ public String findByBpnTemplate() {
         return format("SELECT %s from %s WHERE %s = ?", getGroupsColumn(), getTable(), getBpnColumn());
     }
 
+    @Override
+    public String findByBpnGroupTemplate() {
+        return format("SELECT %s from %s WHERE EXISTS (SELECT 1 FROM json_array_elements_text(%s) AS group_element WHERE group_element = ?)",
+                getBpnColumn(), getTable(), getGroupsColumn());
+    }
+
     @Override
     public String insertTemplate() {
         return format("INSERT INTO %s (%s, %s) VALUES (?, ?%s)", getTable(), getBpnColumn(), getGroupsColumn(), getFormatJsonOperator());

edc-extensions/bpn-validation/business-partner-store-sql/src/main/java/org/eclipse/tractusx/edc/validation/businesspartner/store/sql/SqlBusinessPartnerStore.java

@@ -62,6 +62,23 @@ public StoreResult<List<String>> resolveForBpn(String businessPartnerNumber) {
         });
     }
 
+    @Override
+    public StoreResult<List<String>> resolveForBpnGroup(String businessPartnerGroup) {
+        Objects.requireNonNull(businessPartnerGroup);
+        return transactionContext.execute(() -> {
+            try (var connection = getConnection()) {
+                var sql = statements.findByBpnGroupTemplate();
+                var result = queryExecutor.query(connection, true, this::mapGroup, sql, businessPartnerGroup);
+                var bpns = result.toList();
+                return bpns.isEmpty() ?
+                        StoreResult.notFound(NOT_FOUND_TEMPLATE.formatted(businessPartnerGroup)) :
+                        StoreResult.success(bpns);
+            } catch (SQLException e) {
+                throw new EdcPersistenceException(e);
+            }
+        });
+    }
+
     @Override
     public StoreResult<Void> save(String businessPartnerNumber, List<String> groups) {
         Objects.requireNonNull(businessPartnerNumber);
@@ -118,6 +135,10 @@ private List<String> mapJson(ResultSet resultSet) throws SQLException {
         return fromJson(resultSet.getString(statements.getGroupsColumn()), LIST_OF_STRING);
     }
 
+    private String mapGroup(ResultSet resultSet) throws SQLException {
+        return resultSet.getString(statements.getBpnColumn());
+    }
+
     private boolean exists(String businessPartnerNumber, Connection connection) {
         var countQuery = statements.countQuery();
         try (var stream = queryExecutor.query(connection, false, r -> r.getInt("COUNT"), countQuery, businessPartnerNumber)) {