Support Postman files upload (#95)

* Support Postman file uploads

Co-authored-by: Tim Haselaars <>

README.md

@@ -51,7 +51,7 @@ converter, actively maintained and open for new contributions.
 - [x] Variables (at all scopes + dynamic).
 - [x] Data files.
 - [x] Authentication methods (except Hawk).
-- [x] File uploads.
+- [x] File uploads (experimental).
 - [x] `postman.*` interface ([exceptions below](#unsupported-features)).
 - [x] `pm.*` interface ([exceptions below](#unsupported-features)).
 - [x] Support for

lib/generate/Request/analyze.js

@@ -1,10 +1,10 @@
 const aid = require('../../aid');
 const Auth = require('../../auth');
-const dataForm = require('./form');
 const URI = require('urijs');
 const { InheritAuth } = require('../../sym');
 const { readAuth } = require('../../common');
 const { BodyItemType, BodyMode } = require('../../enum');
+const { formDataForm, formDataFile } = require('./form');
 
 function analyze(request, result, block) {
   const feature = {
@@ -82,14 +82,17 @@ function data(request, feature, result) {
       dataRaw(body, feature);
       return;
     case BodyMode.formdata:
-      dataForm(body, feature, result);
+      formDataForm(body, feature, result);
       return;
     case BodyMode.urlencoded:
       dataUrl(body, feature);
       return;
     case BodyMode.graphql:
       dataGraphQL(body, feature);
       return;
+    case BodyMode.file:
+      formDataFile(body, feature, result);
+      return;
     default:
       throw new Error(`Unrecognized body mode: ${mode}`);
   }

lib/generate/Request/form.js

@@ -10,10 +10,19 @@ function dataForm(body, feature, result) {
   feature.data = data;
 }
 
+function dataFile(body, feature, result) {
+  const data = {};
+  const item = body.file;
+  item.type = 'file';
+  convertItem(item, data, result);
+
+  feature.data = data;
+}
+
 function convertItem(item, data, result) {
-  if (!item.key) {
-    throw new Error('Form item missing key');
-  }
+  // if (!item.key) {
+  //   throw new Error('Form item missing key');
+  // }
   switch (item.type) {
     case 'text':
       convertItemText(item, data);
@@ -36,7 +45,8 @@ function convertItemText(item, data) {
 
 function convertItemFile(item, data, result) {
   result.imports.set('http', 'k6/http');
-  const { key } = item;
+  // const { key } = item;
+  const key = 'file';
   const path = extractPath(item);
   result.files.add(path);
   data[key] = {
@@ -55,4 +65,9 @@ function extractPath(item) {
   }
 }
 
-module.exports = dataForm;
+// Module export for multiple functions
+
+module.exports = {
+  formDataForm: dataForm,
+  formDataFile: dataFile
+};

lib/generate/separate/render.js

@@ -4,6 +4,7 @@ const Item = require('../Item/separate');
 const postman = require('postman-collection');
 const prettier = require('prettier');
 const { Auth } = require('./sym');
+const { basename } = require('path');
 
 function render(mapped, result) {
   return location(mapped, 1, null, result);
@@ -58,6 +59,7 @@ function item(node, depth, auth, itemResult) {
 function simplify(result, block) {
   return {
     imports: result.imports,
+    files: result.files,
     effectImports: result.effectImports,
     declares: block.declares,
     logic: block.main.join('\n\n')
@@ -69,6 +71,7 @@ function text(result, depth) {
   const raw = [
     imports(result, false, depth),
     declares(result),
+    files(result),
     result.logic
   ].filter(item => item).join('\n\n');
   return prettier.format(raw, { semi: true, parser: 'babel' });
@@ -82,4 +85,25 @@ function declares(result) {
   }
 }
 
+function files(result) {
+  if (result.files.size) {
+    const items = [];
+    for (const path of result.files) {
+      items.push(fileLoad(path));
+    }
+    return `const files = {};
+${items.join('\n')}`;
+  } else {
+    return null;
+  }
+}
+
+function fileLoad(path) {
+  const name = basename(path);
+  return `files[${JSON.stringify(path)}] = http.file(
+  open(${JSON.stringify(path)}, "b"),
+  ${JSON.stringify(name)}
+);`;
+}
+
 module.exports = render;

package.json

@@ -66,7 +66,6 @@
         "pkginfo": "^0.4.1",
         "postman-collection": "^4.1.0",
         "postman-collection-transformer": "^4.1.3",
-        "prettier": "^1.19.1",
         "spo-gpo": "^1.0.0",
         "strip-json-comments": "^3.1.1",
         "urijs": "^1.19.11",
@@ -84,6 +83,7 @@
         "husky": "^7.0.4",
         "mock-require": "^3.0.3",
         "npm-run-all": "^4.1.5",
+        "prettier": "^1.19.1",
         "sinon": "^7.5.0",
         "snazzy": "^8.0.0",
         "standard": "^14.3.1"

yarn.lock

@@ -3813,11 +3813,9 @@ json-stable-stringify@~0.0.0:
     jsonify "~0.0.0"
 
 json5@^2.1.2:
-  version "2.1.3"
-  resolved "https://registry.npmjs.org/json5/-/json5-2.1.3.tgz"
-  integrity "sha1-ybD3+pIzv+WAf+ZvzzpWF+1ZfUM= sha512-KXPvOm8K9IJKFM0bmdn8QXh7udDh1g/giieX0NLCaMnb4hEiVFqnop2ImTXCc5e0/oHz3LTqmHGtExn5hfMkOA=="
-  dependencies:
-    minimist "^1.2.5"
+  version "2.2.3"
+  resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.3.tgz#78cd6f1a19bdc12b73db5ad0c61efd66c1e29283"
+  integrity "sha1-eM1vGhm9wStz21rQxh79ZsHikoM= sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg=="
 
 jsonfile@^4.0.0:
   version "4.0.0"