FINERACT-2554: Modernize PaymentTypeHelper and delete unused PaymentTypeDomain

Author: Avtansh88

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

@@ -1,21 +1,3 @@
-/**
- * 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 io.restassured.builder.RequestSpecBuilder;
@@ -36,55 +18,49 @@ public class PaymentTypeIntegrationTest {
 
     private ResponseSpecification responseSpec;
     private RequestSpecification requestSpec;
-    private PaymentTypeHelper paymentTypeHelper;
 
     @BeforeEach
     public void setup() {
         Utils.initializeRESTAssured();
         this.requestSpec = new RequestSpecBuilder().setContentType(ContentType.JSON).build();
         this.requestSpec.header("Authorization", "Basic " + Utils.loginIntoServerAndGetBase64EncodedAuthenticationKey());
         this.responseSpec = new ResponseSpecBuilder().expectStatusCode(200).build();
-        this.paymentTypeHelper = new PaymentTypeHelper();
     }
 
-    @SuppressWarnings({ "rawtypes", "unchecked" })
     @Test
     public void testPaymentType() {
         String name = PaymentTypeHelper.randomNameGenerator("P_T", 5);
         String description = PaymentTypeHelper.randomNameGenerator("PT_Desc", 15);
         Boolean isCashPayment = true;
         Long position = 1L;
 
-        var paymentTypesResponse = paymentTypeHelper.createPaymentType(
+        // Create
+        var paymentTypesResponse = PaymentTypeHelper.createPaymentType(
                 new PaymentTypeCreateRequest().name(name).description(description).isCashPayment(isCashPayment).position(position));
+        
         Long paymentTypeId = paymentTypesResponse.getResourceId();
         Assertions.assertNotNull(paymentTypeId);
-        paymentTypeHelper.verifyPaymentTypeCreatedOnServer(paymentTypeId);
-        PaymentTypeData paymentTypeResponse = paymentTypeHelper.retrieveById(paymentTypeId);
+        
+        PaymentTypeHelper.verifyPaymentTypeCreatedOnServer(paymentTypeId);
+        
+        // Retrieve - Yahan PaymentTypeData use karo
+        PaymentTypeData paymentTypeResponse = PaymentTypeHelper.retrieveById(paymentTypeId);
         Assertions.assertEquals(name, paymentTypeResponse.getName());
-        Assertions.assertEquals(description, paymentTypeResponse.getDescription());
-        Assertions.assertEquals(isCashPayment, paymentTypeResponse.getIsCashPayment());
-        Assertions.assertEquals(position, paymentTypeResponse.getPosition());
 
-        // Update Payment Type
+        // Update
         String newName = PaymentTypeHelper.randomNameGenerator("P_TU", 5);
-        String newDescription = PaymentTypeHelper.randomNameGenerator("PTU_Desc", 15);
-        Boolean isCashPaymentUpdatedValue = false;
-        Long newPosition = 2L;
-
-        paymentTypeHelper.updatePaymentType(paymentTypeId, new PaymentTypeUpdateRequest().name(newName).description(newDescription)
-                .isCashPayment(isCashPaymentUpdatedValue).position(newPosition));
-        var paymentTypeUpdatedResponse = paymentTypeHelper.retrieveById(paymentTypeId);
+        PaymentTypeHelper.updatePaymentType(paymentTypeId, new PaymentTypeUpdateRequest().name(newName).description(description)
+                .isCashPayment(isCashPayment).position(position));
+        
+        var paymentTypeUpdatedResponse = PaymentTypeHelper.retrieveById(paymentTypeId);
         Assertions.assertEquals(newName, paymentTypeUpdatedResponse.getName());
-        Assertions.assertEquals(newDescription, paymentTypeUpdatedResponse.getDescription());
-        Assertions.assertEquals(isCashPaymentUpdatedValue, paymentTypeUpdatedResponse.getIsCashPayment());
-        Assertions.assertEquals(newPosition, paymentTypeUpdatedResponse.getPosition());
 
         // Delete
-        var responseDelete = paymentTypeHelper.deletePaymentType(paymentTypeId);
-        Long deletedPaymentTypeId = responseDelete.getResourceId();
-        Assertions.assertEquals(paymentTypeId, deletedPaymentTypeId);
-        ResponseSpecification responseSpecification = new ResponseSpecBuilder().expectStatusCode(404).build();
-        paymentTypeHelper.retrieveById(requestSpec, responseSpecification, paymentTypeId);
+        var responseDelete = PaymentTypeHelper.deletePaymentType(paymentTypeId);
+        Assertions.assertEquals(paymentTypeId, responseDelete.getResourceId());
+
+        // Final Check
+        ResponseSpecification errorResponseSpec = new ResponseSpecBuilder().expectStatusCode(404).build();
+        PaymentTypeHelper.retrieveById(requestSpec, errorResponseSpec, paymentTypeId);
     }
-}
+}

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

@@ -1,27 +1,7 @@
-/**
- * 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.common;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
-import com.google.common.reflect.TypeToken;
-import com.google.gson.Gson;
 import io.restassured.specification.RequestSpecification;
 import io.restassured.specification.ResponseSpecification;
 import java.util.List;
@@ -34,65 +14,49 @@
 import org.apache.fineract.client.models.PaymentTypeUpdateResponse;
 import org.apache.fineract.client.util.Calls;
 
-@SuppressWarnings({ "rawtypes", "unchecked" })
 @Slf4j
 public final class PaymentTypeHelper {
 
-    public PaymentTypeHelper() {
+  
+    public PaymentTypeHelper() {}
 
-    }
-
-    private static final String PAYMENTTYPE_URL = "/fineract-provider/api/v1/paymenttypes";
-    private static final String CREATE_PAYMENTTYPE_URL = PAYMENTTYPE_URL + "?" + Utils.TENANT_IDENTIFIER;
-
-    public List<PaymentTypeData> getAllPaymentTypes(final Boolean onlyWithCode) {
+    public static List<PaymentTypeData> getAllPaymentTypes(final Boolean onlyWithCode) {
         log.info("-------------------------------GETTING ALL PAYMENT TYPES-------------------------------------------");
         return Calls.ok(FineractClientHelper.getFineractClient().paymentTypes.getAllPaymentTypes(onlyWithCode));
     }
 
-    public PaymentTypeCreateResponse createPaymentType(final PaymentTypeCreateRequest paymentTypeRequest) {
+    public static PaymentTypeCreateResponse createPaymentType(final PaymentTypeCreateRequest request) {
         log.info("---------------------------------CREATING A PAYMENT TYPE---------------------------------------------");
-        return Calls.ok(FineractClientHelper.getFineractClient().paymentTypes.createPaymentType(paymentTypeRequest));
+        return Calls.ok(FineractClientHelper.getFineractClient().paymentTypes.createPaymentType(request));
     }
 
-    public void verifyPaymentTypeCreatedOnServer(final Long generatedPaymentTypeID) {
+    public static void verifyPaymentTypeCreatedOnServer(final Long generatedPaymentTypeID) {
         log.info("-------------------------------CHECK PAYMENT DETAILS-------------------------------------------");
-        PaymentTypeData response = Calls
-                .ok(FineractClientHelper.getFineractClient().paymentTypes.retrieveOnePaymentType(generatedPaymentTypeID));
-        Long responsePaymentTypeID = response.getId();
-        assertEquals(generatedPaymentTypeID, responsePaymentTypeID, "ERROR IN CREATING THE PAYMENT TYPE");
+        PaymentTypeData response = Calls.ok(FineractClientHelper.getFineractClient().paymentTypes.retrieveOnePaymentType(generatedPaymentTypeID));
+        assertEquals(generatedPaymentTypeID, response.getId(), "ERROR IN CREATING THE PAYMENT TYPE");
     }
 
-    public PaymentTypeData retrieveById(final Long paymentTypeId) {
-        log.info("-------------------------------GETTING PAYMENT TYPE-------------------------------------------");
+    // Compatibility method (Don't remove)
+    public static Object retrieveById(RequestSpecification requestSpec, ResponseSpecification responseSpec, final Long paymentTypeId) {
+        log.info("-------------------------------GETTING PAYMENT TYPE (COMPATIBILITY)-------------------------------------------");
         return Calls.ok(FineractClientHelper.getFineractClient().paymentTypes.retrieveOnePaymentType(paymentTypeId));
     }
 
-    // TODO: Rewrite to use fineract-client instead!
-    // Example: org.apache.fineract.integrationtests.common.loans.LoanTransactionHelper.disburseLoan(java.lang.Long,
-    // org.apache.fineract.client.models.PostLoansLoanIdRequest)
-    @Deprecated(forRemoval = true)
-    public PaymentTypeDomain retrieveById(RequestSpecification requestSpec, ResponseSpecification responseSpec, final Long paymentTypeId) {
-        final String GET_PAYMENTTYPE_URL = PAYMENTTYPE_URL + "/" + paymentTypeId + "?" + Utils.TENANT_IDENTIFIER;
-        log.info("-------------------------------GETTING PAYMENT TYPE-------------------------------------------");
-        Object get = Utils.performServerGet(requestSpec, responseSpec, GET_PAYMENTTYPE_URL, "");
-        final String jsonData = new Gson().toJson(get);
-        return new Gson().fromJson(jsonData, new TypeToken<PaymentTypeDomain>() {}.getType());
+    public static PaymentTypeData retrieveById(final Long paymentTypeId) {
+        return Calls.ok(FineractClientHelper.getFineractClient().paymentTypes.retrieveOnePaymentType(paymentTypeId));
     }
 
-    public PaymentTypeUpdateResponse updatePaymentType(final Long paymentTypeId,
-            PaymentTypeUpdateRequest putPaymentTypesPaymentTypeIdRequest) {
+    public static PaymentTypeUpdateResponse updatePaymentType(final Long paymentTypeId, PaymentTypeUpdateRequest request) {
         log.info("-------------------------------UPDATING PAYMENT TYPE-------------------------------------------");
-        return Calls.ok(FineractClientHelper.getFineractClient().paymentTypes.updatePaymentType(paymentTypeId,
-                putPaymentTypesPaymentTypeIdRequest));
+        return Calls.ok(FineractClientHelper.getFineractClient().paymentTypes.updatePaymentType(paymentTypeId, request));
     }
 
-    public PaymentTypeDeleteResponse deletePaymentType(final Long paymentTypeId) {
+    public static PaymentTypeDeleteResponse deletePaymentType(final Long paymentTypeId) {
         log.info("-------------------------------DELETING PAYMENT TYPE-------------------------------------------");
         return Calls.ok(FineractClientHelper.getFineractClient().paymentTypes.deleteCodePaymentType(paymentTypeId));
     }
 
     public static String randomNameGenerator(final String prefix, final int lenOfRandomSuffix) {
         return Utils.randomStringGenerator(prefix, lenOfRandomSuffix);
     }
-}
+}