FINERACT-2315: Fix SMS Status Reports Error

fineract-provider/src/main/java/org/apache/fineract/infrastructure/sms/api/SmsApiResource.java

@@ -91,16 +91,18 @@ public class SmsApiResource {
     public Page<SmsData> retrieveAllSmsByStatus(@PathParam("campaignId") final Long campaignId,
             @BeanParam SmsRequestParam smsRequestParam) {
         context.authenticatedUser().validateHasReadPermission(RESOURCE_NAME_FOR_PERMISSIONS);
-        final SearchParameters searchParameters = SearchParameters.builder().limit(smsRequestParam.limit()).offset(smsRequestParam.offset())
-                .orderBy(smsRequestParam.orderBy()).sortOrder(smsRequestParam.sortOrder()).build();
+        final SearchParameters searchParameters = SearchParameters.builder().limit(smsRequestParam.getLimit())
+                .offset(smsRequestParam.getOffset()).orderBy(smsRequestParam.getOrderBy()).sortOrder(smsRequestParam.getSortOrder())
+                .build();
 
-        final DateFormat dateFormat = Optional.ofNullable(smsRequestParam.rawDateFormat()).map(DateFormat::new).orElse(null);
-        final LocalDate fromDate = Optional.ofNullable(smsRequestParam.fromDate())
-                .map(fromDateParam -> fromDateParam.getDate(FROM_DATE_PARAM, dateFormat, smsRequestParam.locale())).orElse(null);
-        final LocalDate toDate = Optional.ofNullable(smsRequestParam.toDate())
-                .map(toDateParam -> toDateParam.getDate(TO_DATE_PARAM, dateFormat, smsRequestParam.locale())).orElse(null);
+        final DateFormat dateFormat = Optional.ofNullable(smsRequestParam.getRawDateFormat()).map(DateFormat::new).orElse(null);
+        final LocalDate fromDate = Optional.ofNullable(smsRequestParam.getFromDate())
+                .map(fromDateParam -> fromDateParam.getDate(FROM_DATE_PARAM, dateFormat, smsRequestParam.getLocale())).orElse(null);
+        final LocalDate toDate = Optional.ofNullable(smsRequestParam.getToDate())
+                .map(toDateParam -> toDateParam.getDate(TO_DATE_PARAM, dateFormat, smsRequestParam.getLocale())).orElse(null);
 
-        return readPlatformService.retrieveSmsByStatus(campaignId, searchParameters, smsRequestParam.status().intValue(), fromDate, toDate);
+        return readPlatformService.retrieveSmsByStatus(campaignId, searchParameters, smsRequestParam.getStatus().intValue(), fromDate,
+                toDate);
     }
 
     @PUT

fineract-provider/src/main/java/org/apache/fineract/infrastructure/sms/param/SmsRequestParam.java

@@ -18,8 +18,39 @@
  */
 package org.apache.fineract.infrastructure.sms.param;
 
+import jakarta.ws.rs.QueryParam;
+import lombok.Data;
+import lombok.NoArgsConstructor;
 import org.apache.fineract.infrastructure.core.api.DateParam;
 
-public record SmsRequestParam(Long status, DateParam fromDate, DateParam toDate, String locale, String rawDateFormat, Integer offset,
-        Integer limit, String orderBy, String sortOrder) {
+@Data
+@NoArgsConstructor
+public class SmsRequestParam {
+
+    @QueryParam("status")
+    private Long status;
+
+    @QueryParam("fromDate")
+    private DateParam fromDate;
+
+    @QueryParam("toDate")
+    private DateParam toDate;
+
+    @QueryParam("locale")
+    private String locale;
+
+    @QueryParam("dateFormat")
+    private String rawDateFormat;
+
+    @QueryParam("offset")
+    private Integer offset;
+
+    @QueryParam("limit")
+    private Integer limit;
+
+    @QueryParam("orderBy")
+    private String orderBy;
+
+    @QueryParam("sortOrder")
+    private String sortOrder;
 }

integration-tests/src/test/java/org/apache/fineract/integrationtests/SmsApiResourceIntegrationTest.java

@@ -0,0 +1,133 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.fineract.integrationtests;
+
+import static org.hamcrest.Matchers.hasItem;
+import static org.hamcrest.Matchers.notNullValue;
+
+import io.restassured.builder.RequestSpecBuilder;
+import io.restassured.builder.ResponseSpecBuilder;
+import io.restassured.http.ContentType;
+import io.restassured.specification.RequestSpecification;
+import io.restassured.specification.ResponseSpecification;
+import org.apache.fineract.integrationtests.common.ClientHelper;
+import org.apache.fineract.integrationtests.common.Utils;
+import org.apache.fineract.integrationtests.common.organisation.CampaignsHelper;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockserver.integration.ClientAndServer;
+import org.mockserver.junit.jupiter.MockServerExtension;
+import org.mockserver.junit.jupiter.MockServerSettings;
+import org.mockserver.model.HttpRequest;
+import org.mockserver.model.HttpResponse;
+import org.mockserver.model.MediaType;
+
+/**
+ * Integration tests for the retrieveAllSmsByStatus endpoint in SmsApiResource. Ensures correct retrieval of SMS
+ * messages by campaign and status.
+ */
+@ExtendWith(MockServerExtension.class)
+@MockServerSettings(ports = { 9191 })
+public class SmsApiResourceIntegrationTest {
+
+    private RequestSpecification requestSpec;
+    private ResponseSpecification responseSpec;
+    private CampaignsHelper campaignsHelper;
+    private final ClientAndServer client;
+
+    public SmsApiResourceIntegrationTest(ClientAndServer client) {
+        this.client = client;
+        this.client.when(HttpRequest.request().withMethod("GET").withPath("/smsbridges"))
+                .respond(HttpResponse.response().withContentType(MediaType.APPLICATION_JSON).withBody(
+                        "[{\"id\":1,\"tenantId\":1,\"phoneNo\":\"+1234567890\",\"providerName\":\"Dummy SMS Provider - Testing\",\"providerDescription\":\"Dummy, just for testing\"}]"));
+    }
+
+    @BeforeEach
+    public void setup() {
+        Utils.initializeRESTAssured();
+        this.requestSpec = new RequestSpecBuilder().setContentType(ContentType.JSON).build();
+        this.requestSpec.header("Authorization", "Basic " + Utils.loginIntoServerAndGetBase64EncodedAuthenticationKey());
+        this.requestSpec.header("Fineract-Platform-TenantId", "default");
+        this.responseSpec = new ResponseSpecBuilder().expectStatusCode(200).build();
+        this.campaignsHelper = new CampaignsHelper(this.requestSpec, this.responseSpec);
+    }
+
+    /**
+     * Test retrieving SMS messages by status for a valid campaign.
+     */
+    @Test
+    public void testRetrieveAllSmsByStatus_validStatus() {
+        String reportName = "Prospective Clients";
+        int triggerType = 1;
+        Integer campaignId = campaignsHelper.createCampaign(reportName, triggerType);
+        campaignsHelper.verifyCampaignCreatedOnServer(requestSpec, responseSpec, campaignId);
+        campaignsHelper.performActionsOnCampaign(requestSpec, responseSpec, campaignId, "activate");
+
+        Integer clientId = ClientHelper.createClientAsPerson(requestSpec, responseSpec);
+
+        String smsJson = String.format(
+                "{\"groupId\":null,\"clientId\":%d,\"staffId\":null,\"message\":\"Integration test message\",\"campaignId\":%d}", clientId,
+                campaignId);
+        io.restassured.RestAssured.given().spec(requestSpec).body(smsJson).when().post("/fineract-provider/api/v1/sms").then()
+                .statusCode(200).body("resourceId", notNullValue());
+
+        io.restassured.response.Response allSmsResponse = io.restassured.RestAssured.given().spec(requestSpec).when()
+                .get("/fineract-provider/api/v1/sms");
+        java.util.List<java.util.Map<String, Object>> allSms = allSmsResponse.jsonPath().getList("");
+        Integer status = null;
+        for (java.util.Map<String, Object> sms : allSms) {
+            Object smsClientId = sms.get("clientId");
+            Object smsCampaignName = sms.get("campaignName");
+            if (smsClientId != null && smsCampaignName != null && smsClientId.equals(clientId)
+                    && smsCampaignName.equals("Campaign_Name_" + Integer.toHexString(campaignId).toUpperCase())) {
+                java.util.Map<String, Object> statusObj = (java.util.Map<String, Object>) sms.get("status");
+                if (statusObj != null) {
+                    status = ((Number) statusObj.get("id")).intValue();
+                    break;
+                }
+            }
+        }
+        if (status == null) {
+            status = 100;
+        }
+        int limit = 10;
+        io.restassured.RestAssured.given().spec(requestSpec).queryParam("status", status).queryParam("limit", limit).when()
+                .get("/fineract-provider/api/v1/sms/" + campaignId + "/messageByStatus").then().spec(responseSpec)
+                .body("pageItems", notNullValue()).body("pageItems.clientId", hasItem(clientId));
+    }
+
+    /**
+     * Test retrieving SMS messages by status for an invalid status value.
+     */
+    @Test
+    public void testRetrieveAllSmsByStatus_invalidStatus() {
+        String reportName = "Prospective Clients";
+        int triggerType = 1;
+        Integer campaignId = campaignsHelper.createCampaign(reportName, triggerType);
+        campaignsHelper.verifyCampaignCreatedOnServer(requestSpec, responseSpec, campaignId);
+        campaignsHelper.performActionsOnCampaign(requestSpec, responseSpec, campaignId, "activate");
+
+        int invalidStatus = 9999;
+        int limit = 10;
+        io.restassured.RestAssured.given().spec(requestSpec).queryParam("status", invalidStatus).queryParam("limit", limit).when()
+                .get("/fineract-provider/api/v1/sms/" + campaignId + "/messageByStatus").then().spec(responseSpec)
+                .body("pageItems", notNullValue());
+    }
+}