Merge pull request #663 from postmanlabs/curl-short-options

Use short options if that option is selected as far as possible

Author: VShingala

codegens/curl/lib/index.js

@@ -130,33 +130,43 @@ self = module.exports = {
           case 'urlencoded':
             _.forEach(body.urlencoded, function (data) {
               if (!data.disabled) {
-                // Using the long form below without considering the longFormat option,
-                // to generate more accurate and correct snippet
-                snippet += indent + '--data-urlencode';
-                snippet += ` ${quoteType}${sanitize(data.key, trim, quoteType)}=` +
-                  `${sanitize(data.value, trim, quoteType)}${quoteType}`;
+                snippet += indent + (format ? '--data-urlencode' : '-d');
+                snippet += ` ${quoteType}${sanitize(data.key, trim, quoteType, false, true)}=` +
+                  `${sanitize(data.value, trim, quoteType, false, !format)}${quoteType}`;
               }
             });
             break;
-          case 'raw':
-            snippet += indent + `--data-raw ${quoteType}${sanitize(body.raw.toString(), trim, quoteType)}${quoteType}`;
+          case 'raw': {
+            let rawBody = body.raw.toString(),
+              isAsperandPresent = _.includes(rawBody, '@'),
+              // Use the long option if `@` is present in the request body otherwise follow user setting
+              optionName = isAsperandPresent ? '--data-raw' : form('-d', format);
+            snippet += indent + `${optionName} ${quoteType}${sanitize(rawBody, trim, quoteType)}${quoteType}`;
             break;
+          }
 
-          case 'graphql':
+          case 'graphql': {
             // eslint-disable-next-line no-case-declarations
             let query = body.graphql ? body.graphql.query : '',
-              graphqlVariables;
+              graphqlVariables, requestBody, isAsperandPresent, optionName;
             try {
               graphqlVariables = JSON.parse(body.graphql.variables);
             }
             catch (e) {
               graphqlVariables = {};
             }
-            snippet += indent + `--data-raw ${quoteType}${sanitize(JSON.stringify({
+
+            requestBody = JSON.stringify({
               query: query,
               variables: graphqlVariables
-            }), trim, quoteType)}${quoteType}`;
+            });
+
+            isAsperandPresent = _.includes(requestBody, '@');
+            // Use the long option if `@` is present in the request body otherwise follow user setting
+            optionName = isAsperandPresent ? '--data-raw' : form('-d', format);
+            snippet += indent + `${optionName} ${quoteType}${sanitize(requestBody, trim, quoteType)}${quoteType}`;
             break;
+          }
           case 'formdata':
             _.forEach(body.formdata, function (data) {
               if (!(data.disabled)) {
@@ -179,7 +189,7 @@ self = module.exports = {
             });
             break;
           case 'file':
-            snippet += indent + '--data-binary';
+            snippet += indent + form('-d', format);
             snippet += ` ${quoteType}@${sanitize(body[body.mode].src, trim)}${quoteType}`;
             break;
           default:

codegens/curl/lib/util.js

@@ -9,13 +9,18 @@ var self = module.exports = {
      * @param {Boolean} [trim] - indicates whether to trim string or not
      * @param {String} [quoteType] - indicates which quoteType has to be escaped
      * @param {Boolean} [backSlash] - indicates whether to escape backslash(\\)
+     * @param {Boolean} [urlEncode] - indicates whether to url-encode inputString
      * @returns {String}
      */
-  sanitize: function (inputString, trim, quoteType, backSlash) {
+  sanitize: function (inputString, trim, quoteType, backSlash = false, urlEncode = false) {
     if (typeof inputString !== 'string') {
       return '';
     }
 
+    if (urlEncode) {
+      inputString = encodeURIComponent(inputString);
+    }
+
     if (backSlash) {
       inputString = inputString.replace(/\\/g, '\\\\');
     }

codegens/curl/test/newman/newman.test.js

@@ -3,7 +3,7 @@ var runNewmanTest = require('../../../../test/codegen/newman/newmanTestUtil').ru
 
 describe('Convert for different types of request', function () {
   var testConfig = {compileScript: null, runScript: null, fileName: null},
-    options = {
+    options1 = {
       indentCount: 3,
       indentType: 'Space',
       requestTimeout: 200,
@@ -13,7 +13,19 @@ describe('Convert for different types of request', function () {
       silent: true,
       lineContinuationCharacter: '\\',
       quoteType: 'single'
+    },
+    options2 = {
+      indentCount: 3,
+      indentType: 'Space',
+      requestTimeout: 200,
+      multiLine: true,
+      followRedirect: true,
+      longFormat: false,
+      silent: true,
+      lineContinuationCharacter: '\\',
+      quoteType: 'single'
     };
 
-  runNewmanTest(convert, options, testConfig);
+  runNewmanTest(convert, options1, testConfig);
+  runNewmanTest(convert, options2, testConfig);
 });

codegens/curl/test/unit/convert.test.js

@@ -531,6 +531,36 @@ describe('curl convert function', function () {
       });
     });
 
+    it('should longer option for body even if longFormat is disabled if @ character is present', function () {
+      let request = new sdk.Request({
+        'method': 'POST',
+        'header': [],
+        'body': {
+          'mode': 'raw',
+          'raw': '@hello'
+        },
+        'url': {
+          'raw': 'https://postman-echo.com/post',
+          'protocol': 'https',
+          'host': [
+            'postman-echo',
+            'com'
+          ],
+          'path': [
+            'post'
+          ]
+        }
+      });
+
+      convert(request, { longFormat: false }, function (error, snippet) {
+        if (error) {
+          expect.fail(null, null, error);
+        }
+
+        expect(snippet).include('--data-raw');
+      });
+    });
+
     describe('getUrlStringfromUrlObject function', function () {
       var rawUrl, urlObject, outputUrlString;