Merge pull request #141 from shrikster/feature/form-data

Added support for sending form data

README.md

@@ -378,7 +378,24 @@ requests:
         expect: "<$ '2019-10-10' | date('YYYY') $>"
 ```
 
+## Sending files and form data
+Sending files and form data is easy, use params type in the postData prop.
+```yaml
+version: 2
+requests:
+  postwithfile:
+    request:
+      url: https://postman-echo.com/post
+      method: POST
+      postData:
+        mimeType: multipart/form-data
+        params:
+          - name: userId
+            value: "1"
+          - name: avatar
+            value: <$ file("tests/strest.png") $>
 
+```
 ## Response Validation
 
 The immediate response is stored in [HAR Format](http://www.softwareishard.com/blog/har-12-spec/#response)

package.json

@@ -23,6 +23,7 @@
     "commander": "^2.17.1",
     "deep-eql": "4.0.0",
     "faker": "^4.1.0",
+    "form-data": "^2.3.3",
     "get-line-from-pos": "1.0.0",
     "joi": "^13.6.0",
     "js-yaml": "^3.12.0",
@@ -54,6 +55,7 @@
   "devDependencies": {
     "@types/commander": "^2.12.2",
     "@types/faker": "^4.1.3",
+    "@types/form-data": "^2.2.1",
     "@types/jest": "^23.3.2",
     "@types/joi": "^13.4.4",
     "@types/js-yaml": "^3.11.2",

src/configSchema.ts

@@ -141,7 +141,6 @@ interface paramsObjectSchema {
   name: string,
   value: string,
 }
-
 interface postDataObjectSchema {
   mimeType: string,
   params: Array<paramsObjectSchema>,

src/test.ts

@@ -13,6 +13,8 @@ import * as jsonfile  from 'jsonfile'
 import * as path from 'path';
 import * as Ajv from 'ajv';
 import * as nunjucksDate from 'nunjucks-date';
+import * as fs from 'fs';
+import * as FormData from 'form-data';
 
 var deepEql = require("deep-eql");
 var lineNumber = require('line-number');
@@ -44,6 +46,10 @@ nunjucksEnv.addGlobal('Env', function (envi: string) {
   return environ;
 })
 
+nunjucksEnv.addGlobal('file', function (filePath: string)  {
+  const key = `sendFile:${path.resolve(filePath)}`;
+  return key;
+});
 /**
  * All Data that any request returns, will be stored here. After that it can be used in the following methods
  */
@@ -405,10 +411,29 @@ const performRequest = async (requestObject: requestsObjectSchema, requestName:
     if (requestObject.request.postData.text) {
       axiosObject.data = requestObject.request.postData.text;
     }
+
     if (requestObject.request.postData.params) {
-      const searchParams = new URLSearchParams()
-      requestObject.request.postData.params.forEach(item=>{searchParams.append(item.name,item.value)})
-      axiosObject.data = searchParams.toString();
+      if(requestObject.request.postData.mimeType && requestObject.request.postData.mimeType.toLowerCase()=='application/x-www-form-urlencoded')
+      {
+        const searchParams = new URLSearchParams()
+        requestObject.request.postData.params.forEach(item=>{searchParams.append(item.name,item.value)})
+        axiosObject.data = searchParams.toString();
+      }
+      else{
+        const form: FormData = new FormData();
+        requestObject.request.postData.params.forEach(item=>{
+          if(item.value.startsWith('sendFile:')){
+            const filePath = item.value.replace('sendFile:','');
+            const fileStream = fs.createReadStream(filePath);
+            form.append(item.name, fileStream, { filepath:filePath });
+          }
+          else{
+            form.append(item.name, item.value);
+          }
+        });   
+        axiosObject.data  = form;
+        axiosObject.headers = {...axiosObject.headers,...form.getHeaders()};
+      }
     }
   }
 

tests/success/formdata/file.strest.yml

@@ -0,0 +1,27 @@
+version: 2
+requests:
+  postwithfile:
+    request:
+      # url: https://postman-echo.com/post
+      # url: http://localhost:3000/post
+      # url: http://jkorpela.fi/cgi-bin/echoraw.cgi
+      url: http://httpbin.org/post
+      method: POST
+      postData:
+        mimeType: multipart/form-data
+        params:
+          - name: title
+            value: foo
+          - name: body
+            value: bar
+          - name: userId
+            value: "1"
+          - name: avatar
+            value: <$ file("tests/strest.png") $>
+          - name: avatar1
+            value: <$ file("tests/strest.png") $>
+    validate:
+      - jsonpath: content.form.title
+        expect: foo
+      - jsonpath: content.files["avatar"]
+        type: [string]

tests/success/formdata/simple.strest.yml

@@ -0,0 +1,19 @@
+version: 2
+
+requests:
+  simpleformdata:
+    request:
+      url: https://postman-echo.com/post
+      method: POST
+      postData:
+        mimeType: application/x-www-form-urlencoded
+        params:
+          - name: title
+            value: foo
+          - name: body
+            value: bar
+          - name: userId
+            value: "1"
+    validate:
+      - jsonpath: content.form.title
+        expect: foo