FINERACT-2553: Modernize User and Role helpers with Fineract-Client and backward compatibility

Author: Avtansh88

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

@@ -1,27 +1,6 @@
-/**
- * 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 +13,34 @@
 import org.apache.fineract.client.models.PaymentTypeUpdateResponse;
 import org.apache.fineract.client.util.Calls;
 
-@SuppressWarnings({ "rawtypes", "unchecked" })
 @Slf4j
 public final class 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;
+    private PaymentTypeHelper() {}
 
     public 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 PaymentTypeCreateResponse createPaymentType(final PaymentTypeCreateRequest request) {
         log.info("---------------------------------CREATING A PAYMENT TYPE---------------------------------------------");
-        return Calls.ok(FineractClientHelper.getFineractClient().paymentTypes.createPaymentType(paymentTypeRequest));
-    }
-
-    public 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");
+        return Calls.ok(FineractClientHelper.getFineractClient().paymentTypes.createPaymentType(request));
     }
 
-    public PaymentTypeData retrieveById(final Long paymentTypeId) {
-        log.info("-------------------------------GETTING PAYMENT TYPE-------------------------------------------");
+    
+    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 PaymentTypeUpdateResponse updatePaymentType(final Long paymentTypeId,
-            PaymentTypeUpdateRequest putPaymentTypesPaymentTypeIdRequest) {
+    public 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) {
         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);
-    }
-}
+}

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

@@ -1,152 +1,68 @@
-/**
- * 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.useradministration.roles;
 
-import com.google.gson.Gson;
-import com.google.gson.reflect.TypeToken;
 import io.restassured.specification.RequestSpecification;
 import io.restassured.specification.ResponseSpecification;
-import java.lang.reflect.Type;
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import org.apache.fineract.client.models.CommandProcessingResult;
-import org.apache.fineract.client.models.PutPermissionsRequest;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.fineract.client.models.PostRolesRequest;
+import org.apache.fineract.client.models.PostRolesResponse;
+import org.apache.fineract.client.models.GetRolesRoleIdResponse;
+import org.apache.fineract.client.models.PostRolesRoleIdPermissionsRequest;
+import org.apache.fineract.client.models.PostRolesRoleIdPermissionsResponse;
 import org.apache.fineract.client.util.Calls;
-import org.apache.fineract.client.util.JSON;
 import org.apache.fineract.integrationtests.common.FineractClientHelper;
 import org.apache.fineract.integrationtests.common.Utils;
-import org.apache.fineract.useradministration.data.PermissionData;
 
+@Slf4j
 public final class RolesHelper {
 
-    public static final long SUPER_USER_ROLE_ID = 1L; // This is hardcoded into the initial Liquibase migration
+    public static final long SUPER_USER_ROLE_ID = 1L;
 
-    public RolesHelper() {
+    private RolesHelper() {}
 
-    }
-
-    private static final String CREATE_ROLE_URL = "/fineract-provider/api/v1/roles?" + Utils.TENANT_IDENTIFIER;
-    private static final String ROLE_URL = "/fineract-provider/api/v1/roles";
-    private static final String PERMISSIONS_URL = "/fineract-provider/api/v1/permissions";
-    private static final String DISABLE_ROLE_COMMAND = "disable";
-    private static final String ENABLE_ROLE_COMMAND = "enable";
-
-    private static final Gson GSON = new JSON().getGson();
-
-    // 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 static Integer createRole(final RequestSpecification requestSpec, final ResponseSpecification responseSpec) {
-        return Utils.performServerPost(requestSpec, responseSpec, CREATE_ROLE_URL, getTestCreateRoleAsJSON(), "resourceId");
+        log.info("---------------------------------CREATING A ROLE (COMPATIBILITY)---------------------------------------------");
+        PostRolesRequest request = new PostRolesRequest()
+                .name(Utils.uniqueRandomStringGenerator("Role_", 4))
+                .description("New Role");
+        
+        
+        return Calls.ok(FineractClientHelper.getFineractClient().roles.createRole(request)).getResourceId().intValue();
     }
 
-    // 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 static String getTestCreateRoleAsJSON() {
-        final HashMap<String, String> map = new HashMap<>();
-        map.put("name", Utils.uniqueRandomStringGenerator("Role_Name_", 5));
-        map.put("description", Utils.randomStringGenerator("Role_Description_", 10));
-        return new Gson().toJson(map);
-    }
 
-    // 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 static HashMap<String, Object> getRoleDetails(final RequestSpecification requestSpec, final ResponseSpecification responseSpec,
-            final Integer roleId) {
-        final String GET_ROLE_URL = "/fineract-provider/api/v1/roles/" + roleId + "?" + Utils.TENANT_IDENTIFIER;
-        return Utils.performServerGet(requestSpec, responseSpec, GET_ROLE_URL, "");
+    public static Long createRole() {
+        PostRolesRequest request = new PostRolesRequest()
+                .name(Utils.uniqueRandomStringGenerator("Role_", 4))
+                .description("New Role");
+        return Calls.ok(FineractClientHelper.getFineractClient().roles.createRole(request)).getResourceId();
     }
 
-    // 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 static Integer disableRole(final RequestSpecification requestSpec, final ResponseSpecification responseSpec,
-            final Integer roleId) {
-        return Utils.performServerPost(requestSpec, responseSpec, createRoleOperationURL(DISABLE_ROLE_COMMAND, roleId), "", "resourceId");
+   
+    public static GetRolesRoleIdResponse getRoleDetails(final Long roleId) {
+        return Calls.ok(FineractClientHelper.getFineractClient().roles.retrieveRole(roleId));
     }
 
-    // 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 static Integer enableRole(final RequestSpecification requestSpec, final ResponseSpecification responseSpec,
-            final Integer roleId) {
-        return Utils.performServerPost(requestSpec, responseSpec, createRoleOperationURL(ENABLE_ROLE_COMMAND, roleId), "", "resourceId");
-    }
-
-    // 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 static Integer deleteRole(final RequestSpecification requestSpec, final ResponseSpecification responseSpec,
-            final Integer roleId) {
-        return Utils.performServerDelete(requestSpec, responseSpec, createRoleOperationURL(ENABLE_ROLE_COMMAND, roleId), "resourceId");
-    }
-
-    // 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 static String addPermissionsToRole(final RequestSpecification requestSpec, final ResponseSpecification responseSpec,
             final Integer roleId, final Map<String, Boolean> permissionMap) {
-        return Utils.performServerPut(requestSpec, responseSpec, ROLE_URL + "/" + roleId + "/permissions?" + Utils.TENANT_IDENTIFIER,
-                getAddPermissionsToRoleJSON(permissionMap));
-    }
-
-    // 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 static List<PermissionData> getPermissions(final RequestSpecification requestSpec, final ResponseSpecification responseSpec,
-            boolean makerCheckerable) {
-        String response = Utils.performServerGet(requestSpec, responseSpec,
-                PERMISSIONS_URL + "?" + makerCheckerable + "=" + makerCheckerable);
-        final Type listType = new TypeToken<List<PermissionData>>() {}.getType();
-        return GSON.fromJson(response, listType);
+        PostRolesRoleIdPermissionsRequest request = new PostRolesRoleIdPermissionsRequest().permissions(permissionMap);
+        Calls.ok(FineractClientHelper.getFineractClient().roles.updateRolePermissions(roleId.longValue(), request));
+        return ""; 
     }
 
-    public CommandProcessingResult updatePermissions(PutPermissionsRequest request) {
-        return Calls.ok(FineractClientHelper.getFineractClient().permissions.updatePermissionsDetails(request));
+    
+    public static Integer disableRole(final Long roleId) {
+        return Calls.ok(FineractClientHelper.getFineractClient().roles.disableRole(roleId)).getResourceId().intValue();
     }
 
-    // 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)
-    private static String getAddPermissionsToRoleJSON(Map<String, Boolean> permissionMap) {
-        final HashMap<String, Map<String, Boolean>> map = new HashMap<>();
-        map.put("permissions", permissionMap);
-        return new Gson().toJson(map);
+    public static Integer enableRole(final Long roleId) {
+        return Calls.ok(FineractClientHelper.getFineractClient().roles.enableRole(roleId)).getResourceId().intValue();
     }
 
-    // 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)
-    private static String createRoleOperationURL(final String command, final Integer roleId) {
-        return ROLE_URL + "/" + roleId + "?command=" + command + "&" + Utils.TENANT_IDENTIFIER;
+    public static Integer deleteRole(final Long roleId) {
+        return Calls.ok(FineractClientHelper.getFineractClient().roles.deleteRole(roleId)).getResourceId().intValue();
     }
-}
+}