fix(java): 🐛 fixed issues in api form data request (#930)

WasiqB · web-flow · commit 0583e5497e01 · 2024-11-19T23:37:13.000+05:30
diff --git a/core-java/src/main/java/io/github/boykaframework/actions/api/ApiActions.java b/core-java/src/main/java/io/github/boykaframework/actions/api/ApiActions.java
@@ -17,6 +17,7 @@
 package io.github.boykaframework.actions.api;
 
 import static io.github.boykaframework.enums.ContentType.JSON;
+import static io.github.boykaframework.enums.ContentType.OCTET_STREAM;
 import static io.github.boykaframework.enums.ListenerType.API_ACTION;
 import static io.github.boykaframework.enums.Message.AUTH_PASSWORD_REQUIRED;
 import static io.github.boykaframework.enums.Message.BASE_URL_EMPTY;
@@ -28,8 +29,9 @@
 import static io.github.boykaframework.manager.ParallelSession.getSession;
 import static io.github.boykaframework.utils.ErrorHandler.handleAndThrow;
 import static io.github.boykaframework.utils.StringUtils.interpolate;
+import static io.github.boykaframework.utils.StringUtils.isValidPath;
 import static io.github.boykaframework.utils.Validator.requireNonEmpty;
-import static java.lang.String.join;
+import static java.nio.file.Path.of;
 import static java.text.MessageFormat.format;
 import static java.time.Duration.ofSeconds;
 import static java.util.Objects.isNull;
@@ -38,6 +40,7 @@
 import static java.util.Optional.ofNullable;
 import static okhttp3.Credentials.basic;
 import static okhttp3.MediaType.parse;
+import static okhttp3.MultipartBody.FORM;
 import static okhttp3.RequestBody.create;
 import static org.apache.commons.lang3.StringUtils.EMPTY;
 import static org.apache.commons.lang3.StringUtils.isNotEmpty;
@@ -46,7 +49,6 @@
 import java.io.IOException;
 import java.security.KeyManagementException;
 import java.security.NoSuchAlgorithmException;
-import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.function.BiConsumer;
@@ -68,6 +70,7 @@
 import io.github.boykaframework.utils.JsonUtil;
 import okhttp3.HttpUrl;
 import okhttp3.MediaType;
+import okhttp3.MultipartBody;
 import okhttp3.OkHttpClient;
 import okhttp3.Request;
 import okhttp3.RequestBody;
@@ -175,11 +178,19 @@ private ApiActions body (final String body) {
 
     private ApiActions body (final Map<String, String> bodyMap) {
         LOGGER.traceEntry ();
-        final var body = new ArrayList<String> ();
-        bodyMap.forEach ((k, v) -> body.add (format ("{0}={1}", k, v)));
-        if (!body.isEmpty ()) {
-            this.requestBody = create (join ("&", body),
-                requireNonNull (this.mediaType, CONTENT_TYPE_NOT_SET.getMessageText ()));
+        if (!bodyMap.isEmpty ()) {
+            final var formBody = new MultipartBody.Builder ().setType (FORM);
+            bodyMap.forEach ((key, value) -> {
+                LOGGER.debug ("Form Data: {}, {}", key, value);
+                if (isValidPath (value)) {
+                    final var filePath = of (value).toFile ();
+                    formBody.addFormDataPart (key, filePath.getName (),
+                        create (filePath, parse (OCTET_STREAM.getType ())));
+                } else {
+                    formBody.addFormDataPart (key, value);
+                }
+            });
+            this.requestBody = formBody.build ();
         }
         return LOGGER.traceExit (this);
     }
diff --git a/core-java/src/main/java/io/github/boykaframework/builders/ApiRequest.java b/core-java/src/main/java/io/github/boykaframework/builders/ApiRequest.java
@@ -16,6 +16,8 @@
 
 package io.github.boykaframework.builders;
 
+import static io.github.boykaframework.utils.StringUtils.interpolate;
+
 import java.util.Map;
 
 import io.github.boykaframework.enums.ContentType;
@@ -50,4 +52,22 @@ public class ApiRequest {
     @Singular
     private Map<String, String> queryParams;
     private String              userName;
+
+    /**
+     * Gets the authentication password.
+     *
+     * @return password
+     */
+    public String getPassword () {
+        return interpolate (this.password);
+    }
+
+    /**
+     * Gets the authentication username
+     *
+     * @return user name.
+     */
+    public String getUserName () {
+        return interpolate (this.userName);
+    }
 }
diff --git a/core-java/src/main/java/io/github/boykaframework/enums/ContentType.java b/core-java/src/main/java/io/github/boykaframework/enums/ContentType.java
@@ -29,19 +29,23 @@
 @Getter
 public enum ContentType {
     /**
-     * Application/x-www-form-urlencoded.
+     * Application/x-www-form-urlencoded
      */
     FORM_URLENCODED ("application/x-www-form-urlencoded"),
     /**
-     * Application/json.
+     * Application/json
      */
     JSON ("application/json"),
     /**
-     * Multipart/form-data.
+     * Multipart/form-data
      */
     MULTIPART_FORM_DATA ("multipart/form-data"),
     /**
-     * Plain text.
+     * application/octet-stream
+     */
+    OCTET_STREAM ("application/octet-stream"),
+    /**
+     * Plain text
      */
     PLAIN_TEXT ("text/plain");
 
diff --git a/core-java/src/main/java/io/github/boykaframework/utils/StringUtils.java b/core-java/src/main/java/io/github/boykaframework/utils/StringUtils.java
@@ -16,10 +16,12 @@
 
 package io.github.boykaframework.utils;
 
+import static java.nio.file.Path.of;
 import static org.apache.commons.lang3.StringUtils.isNotEmpty;
 import static org.apache.commons.text.StringSubstitutor.createInterpolator;
 import static org.apache.logging.log4j.LogManager.getLogger;
 
+import java.nio.file.InvalidPathException;
 import java.util.Map;
 
 import org.apache.commons.text.StringSubstitutor;
@@ -74,6 +76,22 @@ public static String interpolate (final String value) {
         return result;
     }
 
+    /**
+     * Checks if the string is a valid file path.
+     *
+     * @param path String to test
+     *
+     * @return True if the path is a valid file path, else False.
+     */
+    public static boolean isValidPath (final String path) {
+        try {
+            return of (path).toFile ()
+                .exists ();
+        } catch (final InvalidPathException | NullPointerException ex) {
+            return false;
+        }
+    }
+
     private StringUtils () {
         // Utility class
     }
diff --git a/core-java/src/test/java/io/github/boykaframework/testng/api/postman/ApiPostmanTest.java b/core-java/src/test/java/io/github/boykaframework/testng/api/postman/ApiPostmanTest.java
@@ -17,13 +17,16 @@
 package io.github.boykaframework.testng.api.postman;
 
 import static io.github.boykaframework.actions.api.ApiActions.withRequest;
-import static io.github.boykaframework.builders.ApiRequest.createRequest;
-import static io.github.boykaframework.enums.ContentType.FORM_URLENCODED;
+import static io.github.boykaframework.enums.ContentType.MULTIPART_FORM_DATA;
 import static io.github.boykaframework.enums.PlatformType.API;
 import static io.github.boykaframework.enums.RequestMethod.POST;
 import static io.github.boykaframework.manager.ParallelSession.clearSession;
 import static io.github.boykaframework.manager.ParallelSession.createSession;
+import static java.lang.System.getProperty;
+import static java.nio.file.Path.of;
+import static java.text.MessageFormat.format;
 
+import io.github.boykaframework.builders.ApiRequest;
 import org.testng.annotations.AfterClass;
 import org.testng.annotations.BeforeClass;
 import org.testng.annotations.Test;
@@ -56,15 +59,23 @@ public void tearDownTestClass () {
      */
     @Test (description = "Test Form body POST request")
     public void testFormBodyRequest () {
-        final var request = createRequest ().contentType (FORM_URLENCODED)
+        final var fileName = "test-file.txt";
+        final var request = ApiRequest.createRequest ()
+            .contentType (MULTIPART_FORM_DATA)
             .formBody ("strange", "boom")
             .formBody ("test", "abc")
+            .formBody ("profile", of (getProperty ("user.dir"), "src/test/resources", fileName).toString ())
             .method (POST)
             .path ("/post")
             .create ();
 
         final var response = withRequest (request).execute ();
         response.verifyStatusCode ()
             .isEqualTo (200);
+
+        response.verifyTextField ("form.strange")
+            .isEqualTo ("boom");
+        response.verifyTextField (format ("files[\"{0}\"]", fileName))
+            .isNotEmpty ();
     }
 }
diff --git a/core-java/src/test/resources/boyka-config.json b/core-java/src/test/resources/boyka-config.json
@@ -11,9 +11,9 @@
         "response": true
       },
       "timeout": {
-        "read_timeout": 3,
-        "write_timeout": 3,
-        "connection_timeout": 5
+        "read_timeout": 10,
+        "write_timeout": 10,
+        "connection_timeout": 10
       },
       "schema_path": "schema/"
     }
@@ -93,7 +93,7 @@
         "browser": "REMOTE",
         "base_url": "https://the-internet.herokuapp.com/",
         "target": "LOCAL",
-        "port": "4444",
+        "port": 4444,
         "capabilities": {
           "browserName": "chrome"
         }
@@ -304,8 +304,8 @@
         },
         "device": {
           "os": "ANDROID",
-          "version": "12.0",
-          "name": "Google Pixel 5",
+          "version": "14.0",
+          "name": "Google Pixel 8 Pro",
           "type": "CLOUD",
           "ignore_unimportant_views": true,
           "application": {
@@ -318,7 +318,7 @@
             "projectName": "BrowserStack Android Project",
             "buildName": "Test BrowserStack Build",
             "sessionName": "Test BrowserStack Session",
-            "appiumVersion": "2.0.0",
+            "appiumVersion": "2.6.0",
             "automationVersion": "latest",
             "deviceLogs": true,
             "networkLogs": true,
@@ -348,8 +348,8 @@
           "ignore_unimportant_views": true,
           "capabilities": {
             "platformName": "Android",
-            "deviceName": "Pixel 5",
-            "platformVersion": "11",
+            "deviceName": "Pixel 8 Pro",
+            "platformVersion": "14",
             "app": "AndroidApp",
             "project": "LambdaTest Android Project",
             "build": "Test LambdaTest Build",
@@ -539,7 +539,7 @@
         },
         "device": {
           "os": "IOS",
-          "version": "16",
+          "version": "18",
           "name": "iPhone 14",
           "type": "CLOUD",
           "application": {
@@ -551,7 +551,7 @@
             "projectName": "BrowserStack iOS Project",
             "buildName": "Test BrowserStack Build",
             "sessionName": "Test BrowserStack Session",
-            "appiumVersion": "2.0.0",
+            "appiumVersion": "2.6.0",
             "automationVersion": "latest",
             "deviceLogs": true,
             "networkLogs": true,
@@ -648,7 +648,12 @@
       "base_uri": "https://restful-booker.herokuapp.com"
     },
     "test_postman": {
-      "base_uri": "https://postman-echo.com"
+      "base_uri": "https://postman-echo.com",
+      "timeout": {
+        "connection_timeout": 60,
+        "read_timeout": 60,
+        "write_timeout": 60
+      }
     },
     "test_bad_ssl_wo_verify": {
       "base_uri": "https://expired.badssl.com",
diff --git a/core-java/test-suites/testng-mobile-lt.xml b/core-java/test-suites/testng-mobile-lt.xml
@@ -16,7 +16,7 @@
   -->
 
 <!DOCTYPE suite SYSTEM "https://testng.org/testng-1.0.dtd">
-<suite name="Boyka Framework LambdaTest Mobile Suite" verbose="2" parallel="tests">
+<suite name="Boyka Framework LambdaTest Mobile Suite" verbose="2">
     <listeners>
         <listener class-name="io.github.boykaframework.testng.listeners.TestResultListener"/>
     </listeners>
diff --git a/core-java/test-suites/testng-web-lt.xml b/core-java/test-suites/testng-web-lt.xml
@@ -16,11 +16,11 @@
   -->
 
 <!DOCTYPE suite SYSTEM "https://testng.org/testng-1.0.dtd">
-<suite name="Boyka Framework LambdaTest Web Suite" verbose="2" parallel="tests">
+<suite name="Boyka Framework LambdaTest Web Suite" verbose="2">
     <listeners>
         <listener class-name="io.github.boykaframework.testng.listeners.TestResultListener"/>
     </listeners>
-    <test name="Test web on LambdaTest Browser" parallel="classes">
+    <test name="Test web on LambdaTest Browser">
         <parameter name="platformType" value="WEB"/>
         <parameter name="driverKey" value="test_lambda_test_chrome"/>
         <packages>
diff --git a/package.json b/package.json
@@ -30,17 +30,17 @@
   "license": "MIT",
   "private": true,
   "devDependencies": {
-    "@commitlint/cli": "^19.5.0",
-    "@commitlint/config-conventional": "^19.5.0",
+    "@commitlint/cli": "^19.6.0",
+    "@commitlint/config-conventional": "^19.6.0",
     "@eslint/compat": "^1.2.3",
     "@lerna/child-process": "^7.4.2",
     "@release-it-plugins/lerna-changelog": "^7.0.0",
-    "@stylistic/eslint-plugin-js": "^2.10.1",
-    "@stylistic/eslint-plugin-ts": "^2.10.1",
+    "@stylistic/eslint-plugin-js": "^2.11.0",
+    "@stylistic/eslint-plugin-ts": "^2.11.0",
     "@types/node": "^22.9.0",
-    "@typescript-eslint/eslint-plugin": "^8.14.0",
-    "@typescript-eslint/parser": "^8.14.0",
-    "commitlint": "^19.5.0",
+    "@typescript-eslint/eslint-plugin": "^8.15.0",
+    "@typescript-eslint/parser": "^8.15.0",
+    "commitlint": "^19.6.0",
     "eslint": "^9.15.0",
     "eslint-config-google": "^0.14.0",
     "eslint-config-prettier": "^9.1.0",
@@ -49,7 +49,7 @@
     "eslint-plugin-prettier": "^5.2.1",
     "eslint-plugin-react": "^7.37.2",
     "globals": "^15.12.0",
-    "husky": "^9.1.6",
+    "husky": "^9.1.7",
     "js-yaml": "^4.1.0",
     "lerna": "8.1.9",
     "lerna-changelog": "^2.2.0",
@@ -63,7 +63,7 @@
     "release-it": "^17.10.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.6.3",
-    "typescript-eslint": "^8.14.0"
+    "typescript-eslint": "^8.15.0"
   },
   "scripts": {
     "preinstall": "npx only-allow pnpm",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
