diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml new file mode 100644 index 000000000..4edd27b5a --- /dev/null +++ b/.github/workflows/static.yml @@ -0,0 +1,43 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Deploy static content to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["develop"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: '.' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 60002337d..1e7455eb6 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,11 +1,7 @@ name: Test on: - push: - branches: - - develop - - master - pull_request: + workflow_dispatch: jobs: Unit-Tests: diff --git a/README.md b/README.md index 18684d8c0..64085df1d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,15 @@ +> [!TIP] +> ### For `curl` to `/tool/fetch` conversion, see this repo's webpage: +> #### https://tikoci.github.io/postman-code-generators +> Source code lives at: https://github.com/tikoci/postman-code-generators/blob/develop/index.html + +> [!IMPORTANT] +> ### Fork of `postman-code-generators` +> #### Supporting Mikrotik RouterOS `/tool/fetch` +> The Mikrotik RouterOS codegen is named `routeros-fetch` in Postman's _lang_-_library_ scheme. +> This forks code support RouterOS is largely within: https://github.com/tikoci/postman-code-generators/tree/develop/codegens/routeros-fetch +
_Manage all of your organization's APIs in Postman, with the industry's most complete API development environment._ diff --git a/codegens/routeros-fetch/.eslintrc b/codegens/routeros-fetch/.eslintrc new file mode 100644 index 000000000..4b6fba213 --- /dev/null +++ b/codegens/routeros-fetch/.eslintrc @@ -0,0 +1,363 @@ +{ + "plugins": [ + "jsdoc", + "security", + "lodash" + ], + "env": { + "node": true, + "es6": true + }, + "parserOptions": { + "ecmaVersion": 2018 + }, + "rules": { + // Possible Errors + "for-direction": "error", + "getter-return": "error", + "no-await-in-loop": "error", + "no-compare-neg-zero": "error", + "no-cond-assign": "error", + "no-console": "off", + "no-constant-condition": "error", + "no-control-regex": "error", + "no-debugger": "error", + "no-dupe-args": "error", + "no-dupe-keys": "error", + "no-duplicate-case": "error", + "no-empty": "error", + "no-empty-character-class": "error", + "no-ex-assign": "error", + "no-extra-boolean-cast": "error", + "no-extra-parens": "off", + "no-extra-semi": "error", + "no-func-assign": "error", + "no-inner-declarations": "off", + "no-invalid-regexp": "error", + "no-irregular-whitespace": "error", + "no-obj-calls": "error", + "no-prototype-builtins": "off", + "no-regex-spaces": "error", + "no-sparse-arrays": "error", + "no-template-curly-in-string": "error", + "no-unexpected-multiline": "error", + "no-unreachable": "error", + "no-unsafe-finally": "error", + "no-unsafe-negation": "error", + "use-isnan": "error", + "valid-jsdoc": "off", + "valid-typeof": "error", + + // Best Practices + "accessor-pairs": "error", + "array-callback-return": "off", + "block-scoped-var": "error", + "class-methods-use-this": "error", + "complexity": "off", + "consistent-return": "warn", + "curly": "error", + "default-case": "error", + "dot-location": ["error", "property"], + "dot-notation": "error", + "eqeqeq": "error", + "guard-for-in": "warn", + "no-alert": "error", + "no-caller": "error", + "no-case-declarations": "error", + "no-div-regex": "error", + "no-else-return": "error", + "no-empty-function": "error", + "no-empty-pattern": "error", + "no-eq-null": "error", + "no-eval": "error", + "no-extend-native": "error", + "no-extra-bind": "error", + "no-extra-label": "error", + "no-fallthrough": "error", + "no-floating-decimal": "error", + "no-global-assign": "error", + "no-implicit-coercion": "error", + "no-implicit-globals": "error", + "no-implied-eval": "error", + "no-invalid-this": "error", + "no-iterator": "error", + "no-labels": "error", + "no-lone-blocks": "error", + "no-loop-func": "error", + "no-magic-numbers": "off", + "no-multi-spaces": "error", + "no-multi-str": "error", + "no-new": "error", + "no-new-func": "error", + "no-new-wrappers": "error", + "no-octal": "error", + "no-octal-escape": "error", + "no-param-reassign": "off", + "no-proto": "error", + "no-redeclare": "error", + "no-restricted-properties": "error", + "no-return-assign": "error", + "no-return-await": "error", + "no-script-url": "error", + "no-self-assign": "error", + "no-self-compare": "error", + "no-sequences": "error", + "no-throw-literal": "error", + "no-unmodified-loop-condition": "error", + "no-unused-expressions": "off", + "no-unused-labels": "error", + "no-useless-call": "error", + "no-useless-concat": "error", + "no-useless-escape": "error", + "no-useless-return": "error", + "no-void": "error", + "no-warning-comments": "off", + "no-with": "error", + "prefer-promise-reject-errors": "error", + "radix": "off", + "require-await": "error", + "vars-on-top": "off", + "wrap-iife": "error", + "yoda": "error", + + // Strict Mode + "strict": "off", + + // Variables + "init-declarations": "off", + "no-catch-shadow": "error", + "no-delete-var": "error", + "no-label-var": "error", + "no-restricted-globals": "error", + "no-shadow": "off", + "no-shadow-restricted-names": "error", + "no-undef": "off", + "no-undef-init": "error", + "no-undefined": "off", + "no-unused-vars": "error", + "no-use-before-define": "error", + + // Node.js and CommonJS + "callback-return": "error", + "global-require": "off", + "handle-callback-err": "error", + "no-buffer-constructor": "error", + "no-mixed-requires": "off", + "no-new-require": "off", + "no-path-concat": "error", + "no-process-env": "error", + "no-process-exit": "off", + "no-restricted-modules": "error", + "no-sync": "off", + + // Stylistic Issues + "array-bracket-newline": "off", + "array-bracket-spacing": "off", + "array-element-newline": "off", + "block-spacing": "error", + "brace-style": [2, "stroustrup", { "allowSingleLine": true }], + "camelcase": "off", + "capitalized-comments": "off", + "comma-dangle": ["error", "never"], + "comma-spacing": [2, { "before": false, "after": true }], + "comma-style": ["error", "last"], + "computed-property-spacing": "error", + "consistent-this": "off", + "eol-last": "error", + "func-call-spacing": "error", + "func-name-matching": "off", + "func-names": "off", + "func-style": "off", + "id-blacklist": "error", + "id-length": "off", + "id-match": "error", + "indent": ["error", 2, { + "VariableDeclarator": { "var": 1, "let": 1, "const": 1 }, + "SwitchCase": 1 + }], + "jsx-quotes": ["error", "prefer-single"], + "key-spacing": "error", + "keyword-spacing": "error", + "line-comment-position": "off", + "linebreak-style": ["error", "unix"], + "lines-around-comment": ["error", { + "beforeBlockComment": true, + "afterBlockComment": false, + "beforeLineComment": false, + "afterLineComment": false, + "allowBlockStart": true, + "allowBlockEnd": false, + "allowObjectStart": true, + "allowObjectEnd": false, + "allowArrayStart": true, + "allowArrayEnd": false + }], + "max-depth": "error", + "max-len": ["error", { + "code": 120 + }], + "max-lines": "off", + "max-nested-callbacks": "error", + "max-params": "off", + "max-statements": "off", + "max-statements-per-line": "off", + "multiline-ternary": "off", + "new-cap": "off", + "new-parens": "error", + "newline-per-chained-call": "off", + "no-array-constructor": "error", + "no-bitwise": "off", + "no-continue": "off", + "no-inline-comments": "off", + "no-lonely-if": "error", + "no-mixed-operators": "off", + "no-mixed-spaces-and-tabs": "error", + "no-multi-assign": "off", + "no-multiple-empty-lines": "error", + "no-negated-condition": "off", + "no-nested-ternary": "off", + "no-new-object": "error", + "no-plusplus": "off", + "no-restricted-syntax": "error", + "no-tabs": "error", + "no-ternary": "off", + "no-trailing-spaces": "error", + "no-underscore-dangle": "off", + "no-unneeded-ternary": "error", + "no-whitespace-before-property": "error", + "nonblock-statement-body-position": "error", + "object-curly-newline": "off", + "object-curly-spacing": "off", + "object-property-newline": "off", + "one-var": ["error", "consecutive"], + "one-var-declaration-per-line": "error", + "operator-assignment": "error", + "operator-linebreak": ["error", "after"], + "padded-blocks": "off", + "padding-line-between-statements": "off", + "quote-props": "off", + "quotes": ["error", "single"], + "require-jsdoc": "warn", + "semi": "error", + "semi-spacing": "error", + "sort-keys": "off", + "sort-vars": "off", + "space-before-blocks": "error", + "space-before-function-paren": "error", + "space-in-parens": "error", + "space-infix-ops": "error", + "space-unary-ops": "error", + "spaced-comment": ["error", "always", { + "block": { + "exceptions": ["!"] + } + }], + "switch-colon-spacing": "error", + "template-tag-spacing": "error", + "unicode-bom": "error", + "wrap-regex": "error", + + // ECMAScript 6 + "arrow-body-style": ["error", "always"], + "arrow-parens": ["error", "always"], + "arrow-spacing": "error", + "constructor-super": "error", + "generator-star-spacing": "error", + "no-class-assign": "error", + "no-confusing-arrow": "error", + "no-const-assign": "error", + "no-dupe-class-members": "error", + "no-duplicate-imports": "error", + "no-new-symbol": "error", + "no-restricted-imports": "error", + "no-this-before-super": "error", + "no-useless-computed-key": "error", + "no-useless-constructor": "off", + "no-var": "off", + "object-shorthand": "off", + "prefer-arrow-callback": "off", + "prefer-const": "off", + "prefer-destructuring": "off", + "prefer-numeric-literals": "off", + "prefer-rest-params": "off", + "prefer-spread": "error", + "prefer-template": "off", + "require-yield": "error", + "rest-spread-spacing": "error", + "sort-imports": "off", + "symbol-description": "off", + "template-curly-spacing": "error", + "yield-star-spacing": "error", + + // Lodash + "lodash/callback-binding": "error", + "lodash/collection-method-value": "warn", + "lodash/collection-return": "error", + "lodash/no-double-unwrap": "error", + "lodash/no-extra-args": "error", + "lodash/no-unbound-this": "error", + "lodash/unwrap": "error", + + "lodash/chain-style": ["error", "as-needed"], + "lodash/chaining": ["error", "always", 3], + "lodash/consistent-compose": ["error", "flow"], + "lodash/identity-shorthand": ["error", "always"], + "lodash/import-scope": "off", + "lodash/matches-prop-shorthand": ["error", "always"], + "lodash/matches-shorthand": ["error", "always", 3], + "lodash/no-commit": "error", + "lodash/path-style": ["error", "as-needed"], + "lodash/prefer-compact": "error", + "lodash/prefer-filter": ["off", 3], + "lodash/prefer-flat-map": "error", + "lodash/prefer-invoke-map": "error", + "lodash/prefer-map": "error", + "lodash/prefer-reject": ["error", 3], + "lodash/prefer-thru": "error", + "lodash/prefer-wrapper-method": "error", + "lodash/preferred-alias": "off", + "lodash/prop-shorthand": ["error", "always"], + + "lodash/prefer-constant": "off", + "lodash/prefer-get": ["warn", 4], + "lodash/prefer-includes": ["error", { "includeNative": true }], + "lodash/prefer-is-nil": "error", + "lodash/prefer-lodash-chain": "error", + "lodash/prefer-lodash-method": "off", + "lodash/prefer-lodash-typecheck": "off", + "lodash/prefer-matches": ["off", 3], + "lodash/prefer-noop": "off", + "lodash/prefer-over-quantifier": "warn", + "lodash/prefer-some": "off", + "lodash/prefer-startswith": "off", + "lodash/prefer-times": "off", + + // JsDoc + "jsdoc/check-param-names": "error", + "jsdoc/check-tag-names": "off", + "jsdoc/check-types": "off", + "jsdoc/newline-after-description": "error", + "jsdoc/require-description-complete-sentence": "off", + "jsdoc/require-example": "off", + "jsdoc/require-hyphen-before-param-description": "off", + "jsdoc/require-param": "error", + "jsdoc/require-param-description": "off", + "jsdoc/require-param-type": "off", + "jsdoc/require-returns-description": "off", + "jsdoc/require-returns-type": "error", + + // Security + "security/detect-unsafe-regex": "off", + "security/detect-buffer-noassert": "error", + "security/detect-child-process": "error", + "security/detect-disable-mustache-escape": "error", + "security/detect-eval-with-expression": "error", + "security/detect-no-csrf-before-method-override": "off", + "security/detect-non-literal-fs-filename": "off", + "security/detect-non-literal-regexp": "warn", + "security/detect-non-literal-require": "off", + "security/detect-object-injection": "off", + "security/detect-possible-timing-attacks": "error", + "security/detect-pseudoRandomBytes": "error" + } +} diff --git a/codegens/routeros-fetch/.gitignore b/codegens/routeros-fetch/.gitignore new file mode 100644 index 000000000..2c7c686e6 --- /dev/null +++ b/codegens/routeros-fetch/.gitignore @@ -0,0 +1,41 @@ +.DS_Store +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Coverage directory used by tools like istanbul +.coverage + +# node-waf configuration +.lock-wscript + + +# Dependency directories +node_modules/ +jspm_packages/ + +# Typescript v1 declaration files +typings/ + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variables file +.env + +out/ diff --git a/codegens/routeros-fetch/.npmignore b/codegens/routeros-fetch/.npmignore new file mode 100644 index 000000000..79ad2ba5f --- /dev/null +++ b/codegens/routeros-fetch/.npmignore @@ -0,0 +1,76 @@ +### NPM Specific: Disregard recursive project files +### =============================================== +/.editorconfig +/.gitmodules +/test + +### Borrowed from .gitignore +### ======================== + +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Prevent IDE stuff +.idea +.vscode +*.sublime-* + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +.coverage + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Bower dependency directory (https://bower.io/) +bower_components + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules/ +jspm_packages/ + +# Typescript v1 declaration files +typings/ + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variables file +.env + +snippet.swift + +out/ diff --git a/codegens/routeros-fetch/README.md b/codegens/routeros-fetch/README.md new file mode 100644 index 000000000..539f90f44 --- /dev/null +++ b/codegens/routeros-fetch/README.md @@ -0,0 +1,102 @@ + +> Converts Postman-SDK Request into code snippet for Mikrotik RouterOS's /tool/fetch CLI command. + +#### Prerequisites +To run Code-Gen, ensure that you have NodeJS >= v8. A copy of the NodeJS installable can be downloaded from https://nodejs.org/en/download/package-manager. + +## Using the Module +The module will expose an object which will have property `convert` which is the function for converting the Postman-SDK request to swift code snippet. + +### convert function +Convert function takes three parameters + +* `request` - Postman-SDK Request Object + +* `options` - options is an object which hsa following properties + * `indentType` - String denoting type of indentation for code snippet. eg: 'Space', 'Tab' + * `indentCount` - The number of indentation characters to add per code level + * `trimRequestBody` - Whether or not request body fields should be trimmed + +* `callback` - callback function with first parameter as error and second parameter as string for code snippet + +##### Example: +```js +var request = new sdk.Request('www.google.com'), //using postman sdk to create request + options = { + indentCount: 3, + indentType: 'Space', + requestTimeout: 200, + trimRequestBody: true + }; +convert(request, options, function(error, snippet) { + if (error) { + // handle error + } + // handle snippet + + request.auth.type == "base" || null +}); +``` +### Guidelines for using generated snippet + +* Since Postman-SDK Request object doesn't provide complete path of the file, it needs to be manually inserted in case of uploading a file. + +* This module doesn't support cookies. + + +### RouterOS /tool/fetch options + +#### Options +- Use VRF (string sets address=) +- Output (enum :global/:local/file sets output=user as-value) +- Check Certificate (enum - sets check-certificate= ) +- Output Path +- X509 +- as-value + +#### Request Process +- http-auth-scheme= +- http-method= +- http-data= +- http-content-encoding= +- http-header-field= +- url= +- user= +- password= + +* address (string; Default: ) IP address of the device to copy file from. Also at the end of the address you can specify "@vrf_name" in order to run fetch on particular VRF. You can skip specifying address and specify only VRF on this parameter, if you use URL parameter. +* as-value (set | not-set; Default: not-set) Store the output in a variable, should be used with the output property. +* ascii (yes | no; Default: no) Can be used with FTP and TFTP +* certificate (string; Default: ) +Certificate that should be used for host verification. Can be used only in HTTPS mode. +* check-certificate (yes | yes-without-crl | no; Default: no) +Enables trust chain validation from local certificate store. yes-without-crl, validates a certificate, not performing CRL check (certificate revocation list). Can be used only in HTTPS mode. +* dst-path (string; Default: ) Destination path. Can be used to download file directly into an external disk, for example. +* duration (time; Default: ) +Time how long fetch should run. +* host (string; Default: ) +A domain name or virtual domain name (if used on a website, from which you want to copy information). For example, +address=wiki.mikrotik.com host=forum.mikrotik.com + +In this example the resolved ip address is the same (66.228.113.27), but hosts are different. +* http-auth-scheme (basic|digest; Default: basic) HTTP authentication scheme +* http-method (delete|get|head|post|put|patch; Default: get) +HTTP method to use +* http-data (string; Default: ) The data, that is going to be sent, when using PUT or POST methods. Data limit is 64Kb. +* http-header-field (string; Default: *empty*) List of all header fields and their values, in the form of http-header-field=h1:fff,h2:yyy +* http-content-encoding (deflate|gzip; Default: *empty*) Encodes the payload using gzip or deflate compression and adds a corresponding Content-Encoding header. Usable for HTTP POST and PUT only. +* idle-timeout (time; Default: 10s) Idle timeout since last read/write action. +* keep-result (yes | no; Default: yes) If yes, creates an input file. +* mode (ftp|http|https|sftp|tftp; Default: http) Choose the protocol of connection - http, https , ftp, sftp or tftp. Mode option is deprecated. To specify a protocol that you wish to use, we advise using "url" parameter instead (for example, like this "url=sftp://your_IP_address"). +* output (none|file|user|user-with-headers; Default: file) Sets where to store the downloaded data. + * none - do not store downloaded data + * file - store downloaded data in a file + * user - store downloaded data in the data variable (variable limit is 64Kb) + * user-with-headers - store downloaded data and headers in the data variable (variable limit is 64Kb (20Kb for downloaded data, 44Kb for headers)) +* password (string; Default: anonymous) Password, which is needed for authentication to the remote device. +* port (integer; Default: ) Connection port. +* src-address (ip address; Default: ) Source address that is used to establish connection. Can be used only HTTP/S and SFTP modes. +* src-path (string; Default: ) Title of the remote file you need to copy. +* upload (yes | no; Default: no) Only (S)FTP modes support upload. If enabled then fetch will be used to upload files to a remote server. Requires src-path and dst-path parameters to be set. +* url (string; Default: ) URL pointing to file. Can be used instead of address and src-path parameters. +* user (string; Default: anonymous) Username, which is needed for authentication to the remote device. diff --git a/codegens/routeros-fetch/index.js b/codegens/routeros-fetch/index.js new file mode 100644 index 000000000..bb0a047c4 --- /dev/null +++ b/codegens/routeros-fetch/index.js @@ -0,0 +1 @@ +module.exports = require('./lib'); diff --git a/codegens/routeros-fetch/lib/index.js b/codegens/routeros-fetch/lib/index.js new file mode 100644 index 000000000..3333d9122 --- /dev/null +++ b/codegens/routeros-fetch/lib/index.js @@ -0,0 +1,206 @@ + +const + utils = require('./utils'), + { Url } = require('postman-collection/lib/collection/url'); + +/** + * Used in order to get additional options for generation of C# code snippet (i.e. Include Boilerplate code) + * + * @module getOptions + * + * @returns {Array} Additional options specific to generation of http code snippet + */ +function getOptions () { + return [ + { + name: 'Snippet output type', + id: 'style', + availableOptions: [ + 'plain', + 'outputToConsole', + 'outputToVariable', + 'outputToVariableWithHeaders', + 'outputToFile'], + type: 'enum', + default: 'outputToConsole', + description: + 'Control the flavor ("style") of generated snippets' + }, + { + name: 'Additional commentary', + id: 'commentary', + availableOptions: ['none', 'errors', 'all'], + type: 'enum', + default: 'all', + description: + 'Enables output of errors and tips' + } + ]; +} + +/** + * Converts a Postman SDK request to HTTP message + * + * @param {Object} request - Postman SDK request + * @param {Object} options - Options for converter + * @param {Function} callback callback + * @returns {Function} returns the snippet with the callback function. + */ +function convert (request, options, callback) { + let attrs = new Map(), + cmd = [], + errors = [], + snippet = ''; + + // handle options + options = utils.sanitizeOptions(options, getOptions()); + if (options.commentary === 'errors') { options.logLevel = 1; } + else if (options.commentary === 'none') { options.logLevel = 0; } + else if (options.commentary === 'all') { options.logLevel = 2; } + else { options.logLevel = 2; } + + // http-method= delete|get|head|post|put|patch + if (['DELETE', 'GET', 'HEAD', 'POST', 'PUT', 'PATCH'].some((method) => { return method === request.method; })) { + attrs.set('http-method', request.method.toLowerCase()); + } + else { + errors.push(`* invalid http method ${request.method} used`); + } + + + // authentication + if (request.url.auth) { + // user= + if (request.url.auth.user) { + attrs.set('user', utils.escapeRouterOSString(request.url.auth.user)); + } + // password= + if (request.url.auth.password) { + attrs.set('password', utils.escapeRouterOSString(request.url.auth.password)); + } + } + + // http-auth-scheme= + if (request.auth && request.auth.type) { + switch (request.auth.type) { + case 'basic': { + attrs.set('http-auth-scheme', request.auth.type); + if (request.auth.has('username')) { + attrs.set('user', utils.escapeRouterOSString(request.auth.get('username'))); + } + if (request.auth.has('password')) { + attrs.set('password', utils.escapeRouterOSString(request.auth.get('password'))); + } + break; + } + case 'digest': { + attrs.set('http-auth-scheme', request.auth.type); + if (request.auth.digest.has('username')) { + attrs.set('user', utils.escapeRouterOSString(request.auth.digest.get('username'))); + } + if (request.auth.digest.has('password')) { + attrs.set('password', utils.escapeRouterOSString(request.auth.digest.get('password'))); + } + break; + } + default: + errors.push(`* unsupported authentication method used: ${request.auth.type}`); + break; + } + } + + + // url= + // var urlnoauth = Url.parse(request.url.toString(true)); + request.url.auth = null; + if (request.url.getHost().startsWith('http')) { + const invalidHost = new Url(request.url.getHost()); + request.url.host = invalidHost.getHost(); + request.url.protocol = invalidHost.protocol; + } + attrs.set('url', utils.escapeRouterOSString(request.url.toString(true))); + + + // http-data= + if (['POST', 'PUT'].some((method) => { return method === request.method; })) { + attrs.set('http-data', utils.escapeRouterOSString(utils.getBody(request, false))); + // http-content-encoding= + if (request.headers.has('Content-Encoding')) { + const contentEncoding = request.headers.get('Content-Encoding'); + if (contentEncoding.startsWith('gzip')) { attrs.set('http-content-encoding', 'gzip'); } + else if (contentEncoding.startsWith('deflate')) { attrs.set('http-content-encoding', 'deflate'); } + } + } + + // http-header-field= + let headers = utils.getHeadersArray(request); + headers = headers.map((header) => { + if (header.includes('%') || header.includes(',')) { + errors.push(`* Special characters in headers have many interpretations, check escaping - ${header} `); + } + return utils.escapeRouterOSString(header); + }); + if (headers.length === 1) { + if (headers[0].includes(',')) { + headers[0] = headers[0].replace(/[,]/g, '\\\\,'); + } + attrs.set('http-header-field', headers[0]); + } + else if (headers.length > 1) { + attrs.set('http-header-field', `(${headers.join(',')})`); + } + + // build the actual raw /tool/fetch command + cmd.push('/tool/fetch'); + attrs.forEach((val, key) => { + const attr = key + '=' + val; + if (attr.length > 4096) { + errors.push(`* '${key}=' may be too long for RouterOS`); + } + cmd.push(attr); + }); + + // map 'options.style' to command forms + let styles = { + plain: cmd.join(' '), + outputToConsole: `:put ([${cmd.join(' ')} as-value output=user]->"data")`, + outputToVariable: `:global resp [${cmd.join(' ')} as-value output=user]`, + outputToVariableWithHeaders: `:global resp [${cmd.join(' ')} as-value output=user-with-headers ]`, + outputToFile: `${cmd.join(' ')} output=file` + }; + + // output errors as comments + if (errors.length > 0 && options.logLevel > 0) { + snippet += '#\t\t*** PROBLEMS ***\r\n'; + snippet += '# Warning: Some conversion errors were found:\r\n'; + errors.forEach((err) => { + snippet += `# ${err}\r\n`; + }); + snippet += '\r\n'; + } + + // if request appears JSON, include tip to use [:deserialize] + if (request.headers.has('Content-Type') && + request.headers.get('Content-Type') === 'application/json' && + options.logLevel > 1) { + snippet += '#\t\t*** TIPS: Parsing JSON ***\r\n'; + snippet += '# Your request may return a JSON response.\r\n'; + snippet += '# RouterOS has support to parse the JSON string data returned into RouterOS array.\r\n'; + snippet += '# For example,\r\n'; + snippet += `#\t${styles.outputToVariable}\r\n`; + snippet += '#\t:global json [:deserialize ($resp->"data") from=json]\r\n'; + snippet += '#\t:put $json\r\n'; + snippet += '\r\n'; + } + + // finally, out the command based on the style + snippet += styles[options.style]; + + // done. errors are not fatal, so 'null', but added as comments in snippet instead + return callback(null, snippet); +} + +module.exports = { + getOptions: getOptions, + convert: convert +}; diff --git a/codegens/routeros-fetch/lib/lodash.js b/codegens/routeros-fetch/lib/lodash.js new file mode 100644 index 000000000..b98df4b3c --- /dev/null +++ b/codegens/routeros-fetch/lib/lodash.js @@ -0,0 +1,456 @@ +/* istanbul ignore next */ +module.exports = { + + /** + * Checks if `value` is an empty object, array or string. + * + * Objects are considered empty if they have no own enumerable string keyed + * properties. + * + * Values such as strings, arrays are considered empty if they have a `length` of `0`. + * + * @param {*} value The value to check. + * @returns {boolean} Returns `true` if `value` is empty, else `false`. + * @example + * + * isEmpty(null) + * // => true + * + * isEmpty(true) + * // => true + * + * isEmpty(1) + * // => true + * + * isEmpty([1, 2, 3]) + * // => false + * + * isEmpty('abc') + * // => false + * + * isEmpty({ 'a': 1 }) + * // => false + */ + isEmpty: function (value) { + // eslint-disable-next-line lodash/prefer-is-nil + if (value === null || value === undefined) { + return true; + } + if (Array.isArray(value) || typeof value === 'string' || typeof value.splice === 'function') { + return !value.length; + } + + for (const key in value) { + if (Object.prototype.hasOwnProperty.call(value, key)) { + return false; + } + } + return true; + }, + + /** + * Checks if `value` is `undefined`. + * + * @param {*} value The value to check. + * @returns {boolean} Returns `true` if `value` is `undefined`, else `false`. + * @example + * + * isUndefined(void 0) + * // => true + * + * isUndefined(null) + * // => false + */ + isUndefined: function (value) { + return value === undefined; + }, + + /** + * Checks if `func` is classified as a `Function` object. + * + * @param {*} func The value to check. + * @returns {boolean} Returns `true` if `func` is a function, else `false`. + * @example + * + * isFunction(self.isEmpty) + * // => true + * + * isFunction(/abc/) + * // => false + */ + isFunction: function (func) { + return typeof func === 'function'; + }, + + /** + * Converts the first character of `string` to upper case and the remaining + * to lower case. + * + * @param {string} [string=''] The string to capitalize. + * @returns {string} Returns the capitalized string. + * @example + * + * capitalize('FRED') + * // => 'Fred' + * + * capitalize('john') + * // => 'John' + */ + + capitalize: function (string) { + return string.charAt(0).toUpperCase() + string.slice(1).toLowerCase(); + }, + + /** + * Reduces `array` to a value which is the accumulated result of running + * each element in `array` thru `iteratee`, where each successive + * invocation is supplied the return value of the previous. If `accumulator` + * is not given, the first element of `array` is used as the initial + * value. The iteratee is invoked with four arguments: + * (accumulator, value, index|key, array). + * + * @param {Array} array The Array to iterate over. + * @param {Function} iteratee The function invoked per iteration. + * @param {*} [accumulator] The initial value. + * @returns {*} Returns the accumulated value. + * @example + * + * reduce([1, 2], (sum, n) => sum + n, 0) + * // => 3 + * + */ + reduce: function (array, iteratee, accumulator) { + return array.reduce(iteratee, accumulator); + }, + + /** + * Iterates over elements of `array`, returning an array of all elements + * `predicate` returns truthy for. The predicate is invoked with three + * arguments: (value, index, array). + * + * @param {Array} array The array to iterate over. + * @param {Function|object} predicate The function/object invoked per iteration. + * @returns {Array} Returns the new filtered array. + * @example + * + * const users = [ + * { 'user': 'barney', 'active': true }, + * { 'user': 'fred', 'active': false } + * ] + * + * filter(users, ({ active }) => active) + * // => object for ['barney'] + */ + filter: function (array, predicate) { + if (typeof predicate === 'function') { + return array.filter(predicate); + } + var key = Object.keys(predicate), + val = predicate[key], + res = []; + array.forEach(function (item) { + if (item[key] && item[key] === val) { + res.push(item); + } + }); + return res; + }, + + /** + * The opposite of `filter` this method returns the elements of `array` + * that `predicate` does **not** return truthy for. + * + * @param {Array} array collection to iterate over. + * @param {String} predicate The String that needs to have truthy value, invoked per iteration. + * @returns {Array} Returns the new filtered array. + * @example + * + * const users = [ + * { 'user': 'barney', 'active': true }, + * { 'user': 'fred', 'active': false } + * ] + * + * reject(users, 'active') + * // => object for ['fred'] + */ + reject: function (array, predicate) { + var res = []; + array.forEach((object) => { + if (!object[predicate]) { + res.push(object); + } + }); + return res; + }, + + /** + * Creates an array of values by running each element of `array` thru `iteratee`. + * The iteratee is invoked with three arguments: (value, index, array). + * + * @param {Array} array The array to iterate over. + * @param {Function} iteratee The function invoked per iteration. + * @returns {Array} Returns the new mapped array. + * @example + * + * function square(n) { + * return n * n + * } + * + * map([4, 8], square) + * // => [16, 64] + */ + map: function (array, iteratee) { + return array.map(iteratee); + }, + + /** + * Iterates over elements of `collection` and invokes `iteratee` for each element. + * The iteratee is invoked with three arguments: (value, index|key, collection). + * + * @param {Array|Object} collection The collection to iterate over. + * @param {Function} iteratee The function invoked per iteration. + * @returns {Array|Object} Returns `collection`. + * @example + * + * forEach([1, 2], value => console.log(value)) + * // => Logs `1` then `2`. + * + * forEach({ 'a': 1, 'b': 2 }, (value, key) => console.log(key)) + * // => Logs 'a' then 'b' + */ + + forEach: function (collection, iteratee) { + if (collection === null) { + return null; + } + + if (Array.isArray(collection)) { + return collection.forEach(iteratee); + } + const iterable = Object(collection), + props = Object.keys(collection); + var index = -1, + key, i; + + for (i = 0; i < props.length; i++) { + key = props[++index]; + iteratee(iterable[key], key, iterable); + } + return collection; + }, + + /** + * Checks if `value` is in `collection`. If `collection` is a string, it's + * checked for a substring of `value`, otherwise it checks if the `value` is present + * as a key in a `collection` object. + * + * @param {Array|Object|string} collection The collection to inspect. + * @param {*} value The value to search for. + * @returns {boolean} Returns `true` if `value` is found, else `false`. + * @example + * + * _.includes([1, 2, 3], 1); + * // => true + * + * _.includes({ 'a': 1, 'b': 2 }, 1); + * // => true + * + * _.includes('abcd', 'bc'); + * // => true + */ + includes: function (collection, value) { + if (Array.isArray(collection) || typeof collection === 'string') { + return collection.includes(value); + } + for (var key in collection) { + if (collection.hasOwnProperty(key)) { + if (collection[key] === value) { + return true; + } + } + } + return false; + }, + + /** + * Gets the size of `collection` by returning its length for array and strings. + * For objects it returns the number of enumerable string keyed + * properties. + * + * @param {Array|Object|string} collection The collection to inspect. + * @returns {number} Returns the collection size. + * @example + * + * size([1, 2, 3]) + * // => 3 + * + * size({ 'a': 1, 'b': 2 }) + * // => 2 + * + * size('pebbles') + * // => 7 + */ + size: function (collection) { + // eslint-disable-next-line lodash/prefer-is-nil + if (collection === null || collection === undefined) { + return 0; + } + if (Array.isArray(collection) || typeof collection === 'string') { + return collection.length; + } + + return Object.keys(collection).length; + }, + + /** + * Converts all elements in `array` into a string separated by `separator`. + * + * @param {Array} array The array to convert. + * @param {string} [separator=','] The element separator. + * @returns {string} Returns the joined string. + * @example + * + * _.join(['a', 'b', 'c'], '~'); + * // => 'a~b~c' + */ + join: function (array, separator) { + if (array === null) { + return ''; + } + return array.join(separator); + }, + + /** + * Removes trailing whitespace or specified characters from `string`. + * + * @param {string} [string=''] The string to trim. + * @param {string} [chars=whitespace] The characters to trim. + * @returns {string} Returns the trimmed string. + * @example + * + * trimEnd(' abc ') + * // => ' abc' + * + * trimEnd('-_-abc-_-', '_-') + * // => '-_-abc' + */ + trimEnd: function (string, chars) { + if (!string) { + return ''; + } + if (string && !chars) { + return string.replace(/\s*$/, ''); + } + chars += '$'; + // eslint-disable-next-line security/detect-non-literal-regexp + return string.replace(new RegExp(chars, 'g'), ''); + }, + + /** + * Returns the index of the first + * element `predicate` returns truthy for. + * + * @param {Array} array The array to inspect. + * @param {Object} predicate The exact object to be searched for in the array. + * @returns {number} Returns the index of the found element, else `-1`. + * @example + * + * var users = [ + * { 'user': 'barney', 'active': false }, + * { 'user': 'fred', 'active': false }, + * { 'user': 'pebbles', 'active': true } + * ]; + * + * _.findIndex(users, { 'user': 'fred', 'active': false }); + * // => 1 + * + * _.findIndex(users, {'active' : false}); + * // => 0 + * + */ + findIndex: function (array, predicate) { + var length = array === null ? 0 : array.length, + index = -1, + keys = Object.keys(predicate), + found, i; + if (!length) { + return -1; + } + for (i = 0; i < array.length; i++) { + found = true; + // eslint-disable-next-line no-loop-func + keys.forEach((key) => { + if (!(array[i][key] && array[i][key] === predicate[key])) { + found = false; + } + }); + if (found) { + index = i; + break; + } + } + return index; + }, + + /** + * Gets the value at `path` of `object`. If the resolved value is + * `undefined`, the `defaultValue` is returned in its place. + * + * @param {Object} object The object to query. + * @param {string} path The path of the property to get. + * @param {*} [defaultValue] The value returned for `undefined` resolved values. + * @returns {*} Returns the resolved value. + * @example + * + * const object = { a: {b : 'c'} } + * + * + * get(object, 'a.b.c', 'default') + * // => 'default' + * + * get(object, 'a.b', 'default') + * // => 'c' + */ + get: function (object, path, defaultValue) { + if (object === null) { + return undefined; + } + var arr = path.split('.'), + res = object, + i; + for (i = 0; i < arr.length; i++) { + res = res[arr[i]]; + if (res === undefined) { + return defaultValue; + } + } + return res; + }, + + /** + * Checks if `predicate` returns truthy for **all** elements of `array`. + * Iteration is stopped once `predicate` returns falsey. The predicate is + * invoked with three arguments: (value, index, array). + * + * @param {Array} array The array to iterate over. + * @param {Function} predicate The function invoked per iteration. + * @returns {boolean} Returns `true` if all elements pass the predicate check, + * else `false`. + * @example + * + * every([true, 1, null, 'yes'], Boolean) + * // => false + */ + every: function (array, predicate) { + var index = -1, + length = array === null ? 0 : array.length; + + while (++index < length) { + if (!predicate(array[index], index, array)) { + return false; + } + } + return true; + } + +}; diff --git a/codegens/routeros-fetch/lib/utils.js b/codegens/routeros-fetch/lib/utils.js new file mode 100644 index 000000000..61434fe8c --- /dev/null +++ b/codegens/routeros-fetch/lib/utils.js @@ -0,0 +1,464 @@ +let _ = require('./lodash'), + path = require('path'); + +const FORM_DATA_BOUNDARY = '----FormDataVariable', + RAW = 'raw', + GRAPHQL = 'graphql', + URL_ENCODED = 'urlencoded', + FORM_DATA = 'formdata', + FILE = 'file'; + +var contentTypeHeaderMap = { + 'aac': 'audio/aac', + 'abw': 'application/x-abiword', + 'arc': 'application/x-freearc', + 'avi': 'video/x-msvideo', + 'azw': 'application/vnd.amazon.ebook', + 'bin': 'application/octet-stream', + 'bmp': 'image/bmp', + 'bz': 'application/x-bzip', + 'bz2': 'application/x-bzip2', + 'csh': 'application/x-csh', + 'css': 'text/css', + 'csv': 'text/csv', + 'doc': 'application/msword', + 'docx': 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', + 'eot': 'application/vnd.ms-fontobject', + 'epub': 'application/epub+zip', + 'gif': 'image/gif', + 'htm': 'text/html', + 'html': 'text/html', + 'ico': 'image/vnd.microsoft.icon', + 'ics': 'text/calendar', + 'jar': 'application/java-archive', + 'jpeg': 'image/jpeg', + 'jpg': 'image/jpeg', + 'js': 'text/javascript', + 'json': 'application/json', + 'jsonld': 'application/ld+json', + 'mid': 'audio/midi', + 'midi': 'audio/midi', + 'mjs': 'text/javascript', + 'mp3': 'audio/mpeg', + 'mpeg': 'video/mpeg', + 'mpkg': 'application/vnd.apple.installer+xml', + 'odp': 'application/vnd.oasis.opendocument.presentation', + 'ods': 'application/vnd.oasis.opendocument.spreadsheet', + 'odt': 'application/vnd.oasis.opendocument.text', + 'oga': 'audio/ogg', + 'ogv': 'video/ogg', + 'ogx': 'application/ogg', + 'otf': 'font/otf', + 'png': 'image/png', + 'pdf': 'application/pdf', + 'ppt': 'application/vnd.ms-powerpoint', + 'pptx': 'application/vnd.openxmlformats-officedocument.presentationml.presentation', + 'rar': 'application/x-rar-compressed', + 'rtf': 'application/rtf', + 'sh': 'application/x-sh', + 'svg': 'image/svg+xml', + 'swf': 'application/x-shockwave-flash', + 'tar': 'application/x-tar', + 'tif': 'image/tiff', + 'tiff': 'image/tiff', + 'ts': 'video/mp2t', + 'ttf': 'font/ttf', + 'txt': 'text/plain', + 'vsd': 'application/vnd.visio', + 'wav': 'audio/wav', + 'weba': 'audio/webm', + 'webm': 'video/webm', + 'webp': 'image/webp', + 'woff': 'font/woff', + 'woff2': 'font/woff2', + 'xhtml': 'application/xhtml+xml', + 'xls': 'application/vnd.ms-excel', + 'xlsx': 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', + 'xml': 'text/xml', + 'xul': 'application/vnd.mozilla.xul+xml', + 'zip': 'application/zip', + '3gp': 'video/3gpp', + '7z': 'application/x-7z-compressed', + '7-zip': 'application/x-7z-compressed' +}; + +/** + * Converts a string into a RouterOS string, including escaping any invalid chars + * + * @param {String} str - input + * @param {Boolean} quote - return surrounded by quotes + */ +function escapeRouterOSString (str, quote = true) { + let escapedStr = ''; + + // convert non-printables or higher high to byte syntax (& preserve escapes like \n) + const toHex = (char) => { + let code = char.charCodeAt(0); + if (code === 10) { return '\\n'; } + if (code === 13) { return '\\r'; } + if (code === 9) { return '\\t'; } + if (code === 7) { return '\\a'; } + if (code === 8) { return '\\b'; } + if (code === 12) { return '\\f'; } + if (code === 11) { return '\\v'; } + return '\\' + ('0' + code.toString(16)).slice(-2).toUpperCase(); + }; + + // loop through string to find chars requiring escaping + for (let i = 0; i < str.length; i++) { + const char = str[i], + code = char.charCodeAt(0); + + // Handle control characters (ASCII 0-31) and high ASCII (ASCII > 127) + if (code < 32 || code > 127) { + escapedStr += toHex(char); + } + // Escape backslashes + else if (char === '\\') { + escapedStr += '\\\\'; + } + // Escape double quotes + else if (char === '"') { + escapedStr += '\\"'; + } + // Escape dollar signs + else if (char === '$') { + escapedStr += '\\$'; + } + // Handle regular characters + else { + escapedStr += char; + } + } + + if (quote) { + return `"${escapedStr}"`; + } + return escapedStr; +} + +/** + * Returns an array of properties in the property list. + * + * @param {Object} propertyList - Postman SDK property list + * @param {Boolean} includeDisabled - Determines whether disabled properties are to be returned + * @returns {Object} List of members + */ +function getMembersOfPropertyList (propertyList, includeDisabled = false) { + /* istanbul ignore else */ + if (!includeDisabled) { + return _.reject(propertyList.members, 'disabled'); + } + return propertyList.members; +} + + +/** + * Url encodes the members of the property list. + * + * @param {Object} propertyList propertyList + * @param {String} joinUsing specify string that should be used to join the list of properties + * @param {Boolean} includeDisabled indicated whether or not to include disabled properties + * @param {Boolean} trimRequestBody indicates whether or not to trim request body + * @returns {String} Stringified and Url encoded property List + */ +function convertPropListToStringUrlEncoded (propertyList, joinUsing, includeDisabled = false, trimRequestBody = false) { + const properties = getMembersOfPropertyList(propertyList, includeDisabled), + keyvalues = []; + + properties.forEach((property) => { + const key = trimRequestBody ? property.key.trim() : property.key, + value = trimRequestBody ? property.value.trim() : property.value, + keyvalue = `${encodeURIComponent(key)}=${encodeURIComponent(value)}`; + + keyvalues.push(keyvalue); + }); + + return keyvalues.join(joinUsing); +} + + +/** + * + * @param {Array} array - form data array + * @param {String} key - key of form data param + * @param {String} type - type of form data param(file/text) + * @param {String} val - value/src property of form data param + * @param {String} disabled - Boolean denoting whether the param is disabled or not + * @param {String} contentType - content type header of the param + * + * Appends a single param to form data array + */ +function addFormParam (array, key, type, val, disabled, contentType) { + if (type === 'file') { + array.push({ + key: key, + type: type, + src: val, + disabled: disabled, + contentType: contentType + }); + } + else { + array.push({ + key: key, + type: type, + value: val, + disabled: disabled, + contentType: contentType + }); + } +} + +/** + * Returns the request headers as a string + * + * @param {Object} request - Postman SDK request + * @returns {Function} calls convertPropertyListToString + */ +function getHeadersArray (request) { + + // always add boundary to header for "formdata" bodies + if (request.headers.has('Content-Type')) { + if (request.headers.get('Content-Type') === 'multipart/form-data' || + (request.body && request.body.mode === 'formdata') && request.body.formdata) { + request.headers.upsert({key: 'Content-Type', value: `multipart/form-data; boundary=${FORM_DATA_BOUNDARY}`}); + } + } + else if (request.body && request.body.mode === 'formdata' && request.body.formdata) { + request.headers.add({key: 'Content-Type', value: `multipart/form-data; boundary=${FORM_DATA_BOUNDARY}`}); + } + + let stringArray = []; + stringArray = request.headers.filter((i) => { return i.disabled !== true; }).map((i) => { return `${i}`; }); + + return stringArray; +} + +/** + * Returns the request body as a string + * + * @param {Object} request - Postman SDK request + * @param {Boolean} trimRequestBody - Determines whether to trim the body + * @returns {String} returns Body of the request + */ +function getBody (request, trimRequestBody) { + // pre-process body to add headers + if (request.body && !request.headers.has('Content-Type')) { + if (request.body.mode === 'file') { + request.addHeader({ + key: 'Content-Type', + value: 'text/plain' + }); + } + else if (request.body.mode === 'graphql') { + request.addHeader({ + key: 'Content-Type', + value: 'application/json' + }); + } + } + + // The following code handles multiple files in the same formdata param. + // It removes the form data params where the src property is an array of filepath strings + // Splits that array into different form data params with src set as a single filepath string + if (request.body && request.body.mode === 'formdata') { + let formdata = request.body.formdata, + formdataArray = []; + formdata.members.forEach((param) => { + let key = param.key, + type = param.type, + disabled = param.disabled, + contentType = param.contentType; + // check if type is file or text + if (type === 'file') { + // if src is not of type string we check for array(multiple files) + if (typeof param.src !== 'string') { + // if src is an array(not empty), iterate over it and add files as separate form fields + if (Array.isArray(param.src) && param.src.length) { + param.src.forEach((filePath) => { + addFormParam(formdataArray, key, param.type, filePath, disabled, contentType); + }); + } + // if src is not an array or string, or is an empty array, add a placeholder for file path(no files case) + else { + addFormParam(formdataArray, key, param.type, '/path/to/file', disabled, contentType); + } + } + // if src is string, directly add the param with src as filepath + else { + addFormParam(formdataArray, key, param.type, param.src, disabled, contentType); + } + } + // if type is text, directly add it to formdata array + else { + addFormParam(formdataArray, key, param.type, param.value, disabled, contentType); + } + }); + request.body.update({ + mode: 'formdata', + formdata: formdataArray + }); + } + + let requestBody = ''; + /* istanbul ignore else */ + if (request.body) { + switch (request.body.mode) { + case RAW: + if (!_.isEmpty(request.body[request.body.mode])) { + requestBody += request.body[request.body.mode].toString(); + } + return trimRequestBody ? requestBody.trim() : requestBody; + + case GRAPHQL: + // eslint-disable-next-line no-case-declarations + let graphql = request.body[request.body.mode], + query = graphql ? graphql.query : '', + graphqlVariables; + try { + graphqlVariables = JSON.parse(graphql ? graphql.variables : '{}'); + } + catch (e) { + graphqlVariables = {}; + } + requestBody += JSON.stringify({ + query: query || '', + variables: graphqlVariables + }); + return trimRequestBody ? requestBody.trim() : requestBody; + case URL_ENCODED: + /* istanbul ignore else */ + if (!_.isEmpty(request.body[request.body.mode])) { + const propertyList = request.body[request.body.mode]; + requestBody += convertPropListToStringUrlEncoded(propertyList, '&', false, trimRequestBody); + } + return trimRequestBody ? requestBody.trim() : requestBody; + + case FORM_DATA: + if (!_.isEmpty(request.body[request.body.mode])) { + let properties = getMembersOfPropertyList(request.body[request.body.mode]), + numberOfProperties = properties.length; + if (numberOfProperties > 1) { + requestBody += `--${FORM_DATA_BOUNDARY}\n`; + } + _.forEach(properties, function (property, index) { + /* istanbul ignore else */ + if (property.type === 'text') { + requestBody += 'Content-Disposition: form-data; name="'; + requestBody += `${(trimRequestBody ? property.key.trim() : property.key)}"\r\n`; + if (property.contentType) { + requestBody += `Content-Type: ${property.contentType}\r\n`; + } + requestBody += `\r\n${(trimRequestBody ? property.value.trim() : property.value)}\r\n`; + } + else if (property.type === 'file') { + var pathArray = property.src.split(path.sep), + fileName = pathArray[pathArray.length - 1], + fileExtension = fileName.split('.')[1]; + requestBody += 'Content-Disposition: form-data; name="'; + requestBody += `${(trimRequestBody ? property.key.trim() : property.key)}"; filename="`; + requestBody += `${fileName}"\r\n`; + if (contentTypeHeaderMap[fileExtension]) { + requestBody += `Content-Type: ${contentTypeHeaderMap[fileExtension]}\r\n\r\n`; + } + else { + requestBody += 'Content-Type: \r\n\r\n'; + } + requestBody += `$[/file get ${fileName} contents]\r\n`; + } + if (index === numberOfProperties - 1) { + requestBody += `--${FORM_DATA_BOUNDARY}--\r\n`; + } + else { + requestBody += `--${FORM_DATA_BOUNDARY}\r\n`; + } + }); + } + return trimRequestBody ? requestBody.trim() : requestBody; + + case FILE: + return '""'; + default: + return requestBody; + } + } + return ''; +} + +/** + * sanitizes input options + * + * @param {Object} options - Options provided by the user + * @param {Array} optionsArray - options array received from getOptions function + * + * @returns {Object} - Sanitized options object + */ +function sanitizeOptions (options, optionsArray) { + var result = {}, + defaultOptions = {}, + id; + optionsArray.forEach((option) => { + defaultOptions[option.id] = { + default: option.default, + type: option.type + }; + if (option.type === 'enum') { + defaultOptions[option.id].availableOptions = option.availableOptions; + } + }); + + for (id in options) { + if (options.hasOwnProperty(id)) { + if (defaultOptions[id] === undefined) { + continue; + } + switch (defaultOptions[id].type) { + case 'boolean': + if (typeof options[id] !== 'boolean') { + result[id] = defaultOptions[id].default; + } + else { + result[id] = options[id]; + } + break; + case 'positiveInteger': + if (typeof options[id] !== 'number' || options[id] < 0) { + result[id] = defaultOptions[id].default; + } + else { + result[id] = options[id]; + } + break; + case 'enum': + if (!defaultOptions[id].availableOptions.includes(options[id])) { + result[id] = defaultOptions[id].default; + } + else { + result[id] = options[id]; + } + break; + default: + result[id] = options[id]; + } + } + } + + for (id in defaultOptions) { + if (defaultOptions.hasOwnProperty(id)) { + if (result[id] === undefined) { + result[id] = defaultOptions[id].default; + } + } + } + return result; +} + +module.exports = { + getHeadersArray: getHeadersArray, + getBody: getBody, + sanitizeOptions: sanitizeOptions, + addFormParam: addFormParam, + escapeRouterOSString: escapeRouterOSString +}; + diff --git a/codegens/routeros-fetch/npm-shrinkwrap.json b/codegens/routeros-fetch/npm-shrinkwrap.json new file mode 100644 index 000000000..58eeb04d8 --- /dev/null +++ b/codegens/routeros-fetch/npm-shrinkwrap.json @@ -0,0 +1,17 @@ +{ + "name": "@postman/codegen-routeros-fetch", + "version": "0.1.1", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "@postman/codegen-routeros-fetch", + "version": "0.1.1", + "license": "Apache-2.0", + "devDependencies": {}, + "engines": { + "node": ">=8" + } + } + } +} diff --git a/codegens/routeros-fetch/npm/test-lint.js b/codegens/routeros-fetch/npm/test-lint.js new file mode 100644 index 000000000..f71abe67c --- /dev/null +++ b/codegens/routeros-fetch/npm/test-lint.js @@ -0,0 +1,58 @@ +#!/usr/bin/env node +var shell = require('shelljs'), + chalk = require('chalk'), + async = require('async'), + ESLintCLIEngine = require('eslint').CLIEngine, + + /** + * The list of source code files / directories to be linted. + * + * @type {Array} + */ + LINT_SOURCE_DIRS = [ + './lib', + // './bin', + './test', + // './examples/*.js', + './npm/*.js', + './index.js' + ]; + +module.exports = function (exit) { + // banner line + console.info(chalk.yellow.bold('\nLinting files using eslint...')); + + async.waterfall([ + + /** + * Instantiates an ESLint CLI engine and runs it in the scope defined within LINT_SOURCE_DIRS. + * + * @param {Function} next - The callback function whose invocation marks the end of the lint test run. + * @returns {*} + */ + function (next) { + next(null, (new ESLintCLIEngine()).executeOnFiles(LINT_SOURCE_DIRS)); + }, + + /** + * Processes a test report from the Lint test runner, and displays meaningful results. + * + * @param {Object} report - The overall test report for the current lint test. + * @param {Object} report.results - The set of test results for the current lint run. + * @param {Function} next - The callback whose invocation marks the completion of the post run tasks. + * @returns {*} + */ + function (report, next) { + var errorReport = ESLintCLIEngine.getErrorResults(report.results); + // log the result to CLI + console.info(ESLintCLIEngine.getFormatter()(report.results)); + // log the success of the parser if it has no errors + (errorReport && !errorReport.length) && console.info(chalk.green('eslint ok!')); + // ensure that the exit code is non zero in case there was an error + next(Number(errorReport && errorReport.length) || 0); + } + ], exit); +}; + +// ensure we run this script exports if this is a direct stdin.tty run +!module.parent && module.exports(shell.exit); diff --git a/codegens/routeros-fetch/npm/test-newman.js b/codegens/routeros-fetch/npm/test-newman.js new file mode 100644 index 000000000..d2f4df7a4 --- /dev/null +++ b/codegens/routeros-fetch/npm/test-newman.js @@ -0,0 +1,60 @@ +#!/usr/bin/env node +/* eslint-env node, es6 */ +// --------------------------------------------------------------------------------------------------------------------- +// This script is intended to execute all unit tests. +// --------------------------------------------------------------------------------------------------------------------- + +var shell = require('shelljs'), + + // set directories and files for test and coverage report + path = require('path'), + + NYC = require('nyc'), + chalk = require('chalk'), + recursive = require('recursive-readdir'), + + COV_REPORT_PATH = '.coverage', + SPEC_SOURCE_DIR = path.join(__dirname, '..', 'test', 'newman'); + +module.exports = function (exit) { + // banner line + console.info(chalk.yellow.bold('Running newman tests using mocha on node...')); + + shell.test('-d', COV_REPORT_PATH) && shell.rm('-rf', COV_REPORT_PATH); + shell.mkdir('-p', COV_REPORT_PATH); + + var Mocha = require('mocha'), + nyc = new NYC({ + reportDir: COV_REPORT_PATH, + tempDirectory: COV_REPORT_PATH, + reporter: ['text', 'lcov', 'text-summary'], + exclude: ['config', 'test'], + hookRunInContext: true, + hookRunInThisContext: true + }); + + nyc.wrap(); + // add all spec files to mocha + recursive(SPEC_SOURCE_DIR, function (err, files) { + if (err) { console.error(err); return exit(1); } + + var mocha = new Mocha({ timeout: 1000 * 60 }); + + files.filter(function (file) { // extract all test files + return (file.substr(-8) === '.test.js'); + }).forEach(mocha.addFile.bind(mocha)); + + mocha.run(function (runError) { + runError && console.error(runError.stack || runError); + + nyc.reset(); + nyc.writeCoverageFile(); + nyc.report(); + exit(runError ? 1 : 0); + }); + return null; + }); +}; + +// ensure we run this script exports if this is a direct stdin.tty run +!module.parent && module.exports(shell.exit); diff --git a/codegens/routeros-fetch/npm/test-unit.js b/codegens/routeros-fetch/npm/test-unit.js new file mode 100644 index 000000000..c5ff535c2 --- /dev/null +++ b/codegens/routeros-fetch/npm/test-unit.js @@ -0,0 +1,55 @@ +#!/usr/bin/env node +var shell = require('shelljs'), + + // set directories and files for test and coverage report + path = require('path'), + + NYC = require('nyc'), + chalk = require('chalk'), + recursive = require('recursive-readdir'), + + COV_REPORT_PATH = '.coverage', + SPEC_SOURCE_DIR = path.join(__dirname, '..', 'test', 'unit'); + +module.exports = function (exit) { + // banner line + console.info(chalk.yellow.bold('Running unit tests using mocha on node...')); + + shell.test('-d', COV_REPORT_PATH) && shell.rm('-rf', COV_REPORT_PATH); + shell.mkdir('-p', COV_REPORT_PATH); + + var Mocha = require('mocha'), + nyc = new NYC({ + reportDir: COV_REPORT_PATH, + tempDirectory: COV_REPORT_PATH, + reporter: ['text', 'lcov', 'text-summary'], + exclude: ['config', 'test'], + hookRunInContext: true, + hookRunInThisContext: true + }); + + nyc.wrap(); + // add all spec files to mocha + recursive(SPEC_SOURCE_DIR, function (err, files) { + if (err) { console.error(err); return exit(1); } + + var mocha = new Mocha({ timeout: 1000 * 60 }); + + files.filter(function (file) { // extract all test files + return (file.substr(-8) === '.test.js'); + }).forEach(mocha.addFile.bind(mocha)); + + mocha.run(function (runError) { + runError && console.error(runError.stack || runError); + + nyc.reset(); + nyc.writeCoverageFile(); + nyc.report(); + exit(runError ? 1 : 0); + }); + return null; + }); +}; + +// ensure we run this script exports if this is a direct stdin.tty run +!module.parent && module.exports(shell.exit); diff --git a/codegens/routeros-fetch/npm/test.js b/codegens/routeros-fetch/npm/test.js new file mode 100644 index 000000000..23e0e4962 --- /dev/null +++ b/codegens/routeros-fetch/npm/test.js @@ -0,0 +1,17 @@ +#!/usr/bin/env node +var chalk = require('chalk'), + exit = require('shelljs').exit, + prettyms = require('pretty-ms'), + startedAt = Date.now(), + name = require('../package.json').name; + +require('async').series([ + require('./test-lint'), + require('./test-unit') + // NOTE: Newman disabled because requires a RouterOS device online via SSH - but works + // require('./test-newman') +], function (code) { + // eslint-disable-next-line max-len + console.info(chalk[code ? 'red' : 'green'](`\n${name}: duration ${prettyms(Date.now() - startedAt)}\n${name}: ${code ? 'not ok' : 'ok'}!`)); + exit(code && (typeof code === 'number' ? code : 1) || 0); +}); diff --git a/codegens/routeros-fetch/package.json b/codegens/routeros-fetch/package.json new file mode 100644 index 000000000..bd068a416 --- /dev/null +++ b/codegens/routeros-fetch/package.json @@ -0,0 +1,34 @@ +{ + "name": "@postman/codegen-routeros-fetch", + "version": "0.1.1", + "description": "Converts Postman SDK Requests to Mikrotik RouterOS syntax using /tool/fetch", + "main": "index.js", + "com_postman_plugin": { + "type": "code_generator", + "lang": "routeros", + "variant": "fetch", + "syntax_mode": "text" + }, + "directories": { + "lib": "lib", + "test": "test" + }, + "scripts": { + "test": "node npm/test.js", + "test-lint": "node npm/test-lint.js", + "test-newman": "node npm/test-newman.js", + "test-unit": "node npm/test-unit.js" + }, + "repository": { + "type": "git", + "url": "" + }, + "author": "Postman Labs ", + "license": "Apache-2.0", + "homepage": "https://github.com/postmanlabs/code-generators/tree/master/codegens/routeros-fetch", + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=8" + } +} diff --git a/codegens/routeros-fetch/routeros-fetch-cmd b/codegens/routeros-fetch/routeros-fetch-cmd new file mode 100644 index 000000000..a40981f76 --- /dev/null +++ b/codegens/routeros-fetch/routeros-fetch-cmd @@ -0,0 +1 @@ +:put ([/tool/fetch http-method=get url="https://postman-echo.com/get" http-header-field=("key: value1","key: value2") as-value output=user]->"data") \ No newline at end of file diff --git a/codegens/routeros-fetch/test/newman/fixtures/basicCollection.json b/codegens/routeros-fetch/test/newman/fixtures/basicCollection.json new file mode 100644 index 000000000..43c61e004 --- /dev/null +++ b/codegens/routeros-fetch/test/newman/fixtures/basicCollection.json @@ -0,0 +1,669 @@ +{ + "info": { + "_postman_id": "b303fb8b-9b21-4429-b00f-33b6a7efa186", + "name": "Basic Collection", + "description": "This collection contains requests that will be used to test validity of plugin created to convert postman request into code snippet of particular language.", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Request Headers (With special Characters)", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "my-sample-header", + "value": "Lorem ipsum dolor sit amet" + }, + { + "key": "TEST", + "value": "@#$%^&*()" + }, + { + "key": "more", + "value": ",./';[]}{\":?><|\\\\" + } + ], + "url": { + "raw": "https://postman-echo.com/headers", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "headers" + ] + }, + "description": "A `GET` request to this endpoint returns the list of all request headers as part of the response JSON.\nIn Postman, sending your own set of headers through the [Headers tab](https://www.getpostman.com/docs/requests#headers?source=echo-collection-app-onboarding) will reveal the headers as part of the response." + }, + "response": [] + }, + { + "name": "Request Headers", + "request": { + "method": "GET", + "header": [ + { + "key": "my-sample-header", + "value": "Lorem ipsum dolor sit amet" + }, + { + "key": "testing", + "value": "'singlequotes'" + }, + { + "key": "TEST", + "value": "\"doublequotes\"" + }, + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "url": { + "raw": "https://postman-echo.com/headers", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "headers" + ] + }, + "description": "A `GET` request to this endpoint returns the list of all request headers as part of the response JSON.\nIn Postman, sending your own set of headers through the [Headers tab](https://www.getpostman.com/docs/requests#headers?source=echo-collection-app-onboarding) will reveal the headers as part of the response." + }, + "response": [] + }, + { + "name": "Request Headers with disabled headers", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "my-sample-header", + "value": "Lorem ipsum dolor sit amet" + }, + { + "key": "not-disabled-header", + "value": "ENABLED" + }, + { + "key": "disabled header", + "value": "DISABLED", + "disabled": true + } + ], + "url": { + "raw": "https://postman-echo.com/headers", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "headers" + ] + }, + "description": "A `GET` request to this endpoint returns the list of all request headers as part of the response JSON.\nIn Postman, sending your own set of headers through the [Headers tab](https://www.getpostman.com/docs/requests#headers?source=echo-collection-app-onboarding) will reveal the headers as part of the response." + }, + "response": [] + }, + { + "name": "GET Request with disabled query", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "https://postman-echo.com/get?test=123&anotherone=232", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "get" + ], + "query": [ + { + "key": "test", + "value": "123" + }, + { + "key": "anotherone", + "value": "232" + }, + { + "key": "anotheroneone", + "value": "sdfsdf", + "disabled": true + } + ] + }, + "description": "The HTTP `GET` request method is meant to retrieve data from a server. The data\nis identified by a unique URI (Uniform Resource Identifier). \n\nA `GET` request can pass parameters to the server using \"Query String \nParameters\". For example, in the following request,\n\n> http://example.com/hi/there?hand=wave\n\nThe parameter \"hand\" has the value \"wave\".\n\nThis endpoint echoes the HTTP headers, request parameters and the complete\nURI requested." + }, + "response": [] + }, + { + "name": "POST Raw Text", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "var responseJSON;", + "", + "try { ", + " responseJSON = JSON.parse(responseBody); ", + " tests['response is valid JSON'] = true;", + "}", + "catch (e) { ", + " responseJSON = {}; ", + " tests['response is valid JSON'] = false;", + "}", + "", + "", + "tests['response has post data'] = _.has(responseJSON, 'data');", + "tests['response matches the data posted'] = (responseJSON.data && responseJSON.data.length === 281);", + "", + "tests[\"content-type equals text/plain\"] = responseJSON && responseJSON.headers && (responseJSON.headers[\"content-type\"] === 'text/plain');" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": { + "mode": "raw", + "raw": "Duis posuere augue vel cursus pharetra. In luctus a ex nec pretium. Praesent neque quam, tincidunt nec leo eget, rutrum vehicula magna.\nMaecenas consequat elementum elit, id semper sem tristique et. Integer pulvinar enim quis consectetur interdum volutpat. !@#$%^&*()_+-=,.<>/?" + }, + "url": { + "raw": "https://postman-echo.com/post", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "post" + ] + }, + "description": "The HTTP `POST` request method is meant to transfer data to a server \n(and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `POST` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following request,\n\n> POST /hi/there?hand=wave\n>\n> \n\nThe parameter \"hand\" has the value \"wave\". The request body can be in multiple\nformats. These formats are defined by the MIME type of the request. The MIME \nType can be set using the ``Content-Type`` HTTP header. The most commonly used \nMIME types are:\n\n* `multipart/form-data`\n* `application/x-www-form-urlencoded`\n* `application/json`\n\nThis endpoint echoes the HTTP headers, request parameters, the contents of\nthe request body and the complete URI requested." + }, + "response": [] + }, + { + "name": "POST json with raw", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"json\": \"Test-Test\"\n}" + }, + "url": { + "raw": "https://postman-echo.com/post", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "post" + ] + }, + "description": "The HTTP `POST` request method is meant to transfer data to a server \n(and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `POST` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following request,\n\n> POST /hi/there?hand=wave\n>\n> \n\nThe parameter \"hand\" has the value \"wave\". The request body can be in multiple\nformats. These formats are defined by the MIME type of the request. The MIME \nType can be set using the ``Content-Type`` HTTP header. The most commonly used \nMIME types are:\n\n* `multipart/form-data`\n* `application/x-www-form-urlencoded`\n* `application/json`\n\nThis endpoint echoes the HTTP headers, request parameters, the contents of\nthe request body and the complete URI requested." + }, + "response": [] + }, + { + "name": "POST graphql body(json) with raw", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "graphql", + "graphql": { + "query": "{\n findScenes(\n filter: {per_page: 0}\n scene_filter: {is_missing: \"performers\"}){\n count\n scenes {\n id\n title\n path\n }\n }\n}", + "variables": "{\n\t\"variable_key\": \"variable_value\"\n}" + } + }, + "url": { + "raw": "https://postman-echo.com/post", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "post" + ] + } + }, + "response": [] + }, + { + "name": "POST javascript with raw", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/javascript" + } + ], + "body": { + "mode": "raw", + "raw": "var val = 6;\nconsole.log(val);console.log('$text\r\n');\n" + }, + "url": { + "raw": "https://postman-echo.com/post", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "post" + ] + }, + "description": "The HTTP `POST` request method is meant to transfer data to a server \n(and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `POST` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following request,\n\n> POST /hi/there?hand=wave\n>\n> \n\nThe parameter \"hand\" has the value \"wave\". The request body can be in multiple\nformats. These formats are defined by the MIME type of the request. The MIME \nType can be set using the ``Content-Type`` HTTP header. The most commonly used \nMIME types are:\n\n* `multipart/form-data`\n* `application/x-www-form-urlencoded`\n* `application/json`\n\nThis endpoint echoes the HTTP headers, request parameters, the contents of\nthe request body and the complete URI requested." + }, + "response": [] + }, + { + "name": "POST text/xml with raw", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "text/xml" + } + ], + "body": { + "mode": "raw", + "raw": "\n\tTest Test\n" + }, + "url": { + "raw": "https://postman-echo.com/post", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "post" + ] + }, + "description": "The HTTP `POST` request method is meant to transfer data to a server \n(and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `POST` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following request,\n\n> POST /hi/there?hand=wave\n>\n> \n\nThe parameter \"hand\" has the value \"wave\". The request body can be in multiple\nformats. These formats are defined by the MIME type of the request. The MIME \nType can be set using the ``Content-Type`` HTTP header. The most commonly used \nMIME types are:\n\n* `multipart/form-data`\n* `application/x-www-form-urlencoded`\n* `application/json`\n\nThis endpoint echoes the HTTP headers, request parameters, the contents of\nthe request body and the complete URI requested." + }, + "response": [] + }, + { + "name": "POST text/html with raw", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "text/html" + } + ], + "body": { + "mode": "raw", + "raw": "\n Test Test\n" + }, + "url": { + "raw": "https://postman-echo.com/post", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "post" + ] + }, + "description": "The HTTP `POST` request method is meant to transfer data to a server \n(and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `POST` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following request,\n\n> POST /hi/there?hand=wave\n>\n> \n\nThe parameter \"hand\" has the value \"wave\". The request body can be in multiple\nformats. These formats are defined by the MIME type of the request. The MIME \nType can be set using the ``Content-Type`` HTTP header. The most commonly used \nMIME types are:\n\n* `multipart/form-data`\n* `application/x-www-form-urlencoded`\n* `application/json`\n\nThis endpoint echoes the HTTP headers, request parameters, the contents of\nthe request body and the complete URI requested." + }, + "response": [] + }, + { + "name": "POST urlencoded data", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/x-www-form-urlencoded" + } + ], + "body": { + "mode": "urlencoded", + "urlencoded": [ + { + "key": "1", + "value": "'a'", + "type": "text" + }, + { + "key": "2", + "value": "\"b\"", + "type": "text" + }, + { + "key": "'3'", + "value": "c", + "type": "text" + }, + { + "key": "\"4\"", + "value": "d", + "type": "text" + }, + { + "key": "Special", + "value": "!@#$%*()^_=`&~ ", + "type": "text" + }, + { + "key": "more", + "value": ",./';[]}{\":?><|\\\\ ", + "type": "text" + }, + { + "key": "non-ascii", + "value": "테스트", + "type": "text" + } + ] + }, + "url": { + "raw": "https://postman-echo.com/post", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "post" + ] + }, + "description": "The HTTP `POST` request method is meant to transfer data to a server \n(and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `POST` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following request,\n\n> POST /hi/there?hand=wave\n>\n> \n\nThe parameter \"hand\" has the value \"wave\". The request body can be in multiple\nformats. These formats are defined by the MIME type of the request. The MIME \nType can be set using the ``Content-Type`` HTTP header. The most commonly used \nMIME types are:\n\n* `multipart/form-data`\n* `application/x-www-form-urlencoded`\n* `application/json`\n\nThis endpoint echoes the HTTP headers, request parameters, the contents of\nthe request body and the complete URI requested." + }, + "response": [] + }, + { + "name": "PUT Request", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "var responseJSON;", + "", + "try { ", + " responseJSON = JSON.parse(responseBody); ", + " tests['response is valid JSON'] = true;", + "}", + "catch (e) { ", + " responseJSON = {}; ", + " tests['response is valid JSON'] = false;", + "}", + "", + "", + "tests['response has PUT data'] = _.has(responseJSON, 'data');", + "tests['response matches the data sent in request'] = (responseJSON.data && responseJSON.data.length === 256);" + ] + } + } + ], + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": { + "mode": "raw", + "raw": "Etiam mi lacus, cursus vitae felis et, blandit pellentesque neque. Vestibulum eget nisi a tortor commodo dignissim.\nQuisque ipsum ligula, faucibus a felis a, commodo elementum nisl. Mauris vulputate sapien et tincidunt viverra. Donec vitae velit nec metus." + }, + "url": { + "raw": "https://postman-echo.com/put", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "put" + ] + }, + "description": "The HTTP `PUT` request method is similar to HTTP `POST`. It too is meant to \ntransfer data to a server (and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `PUT` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following \nraw HTTP request,\n\n> PUT /hi/there?hand=wave\n>\n> \n\n\n" + }, + "response": [] + }, + { + "name": "PATCH Request", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "var responseJSON;", + "", + "try { ", + " responseJSON = JSON.parse(responseBody); ", + " tests['response is valid JSON'] = true;", + "}", + "catch (e) { ", + " responseJSON = {}; ", + " tests['response is valid JSON'] = false;", + "}", + "", + "", + "tests['response has PUT data'] = _.has(responseJSON, 'data');", + "tests['response matches the data sent in request'] = (responseJSON.data && responseJSON.data.length === 256);" + ] + } + } + ], + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": { + "mode": "raw", + "raw": "Curabitur auctor, elit nec pulvinar porttitor, ex augue condimentum enim, eget suscipit urna felis quis neque.\nSuspendisse sit amet luctus massa, nec venenatis mi. Suspendisse tincidunt massa at nibh efficitur fringilla. Nam quis congue mi. Etiam volutpat." + }, + "url": { + "raw": "https://postman-echo.com/patch", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "patch" + ] + }, + "description": "The HTTP `PATCH` method is used to update resources on a server. The exact\nuse of `PATCH` requests depends on the server in question. There are a number\nof server implementations which handle `PATCH` differently. Technically, \n`PATCH` supports both Query String parameters and a Request Body.\n\nThis endpoint accepts an HTTP `PATCH` request and provides debug information\nsuch as the HTTP headers, Query String arguments, and the Request Body." + }, + "response": [] + }, + { + "name": "DELETE Request", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "var responseJSON;", + "", + "try { ", + " responseJSON = JSON.parse(responseBody); ", + " tests['response is valid JSON'] = true;", + "}", + "catch (e) { ", + " responseJSON = {}; ", + " tests['response is valid JSON'] = false;", + "}", + "", + "", + "tests['response has PUT data'] = _.has(responseJSON, 'data');", + "tests['response matches the data sent in request'] = (responseJSON.data && responseJSON.data.length === 256);" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "https://postman-echo.com/delete", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "delete" + ] + }, + "description": "The HTTP `DELETE` method is used to delete resources on a server. The exact\nuse of `DELETE` requests depends on the server implementation. In general, \n`DELETE` requests support both, Query String parameters as well as a Request \nBody.\n\nThis endpoint accepts an HTTP `DELETE` request and provides debug information\nsuch as the HTTP headers, Query String arguments, and the Request Body." + }, + "response": [] + } + ], + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + } + ] +} \ No newline at end of file diff --git a/codegens/routeros-fetch/test/newman/fixtures/emptyFormdataCollection.json b/codegens/routeros-fetch/test/newman/fixtures/emptyFormdataCollection.json new file mode 100644 index 000000000..651456397 --- /dev/null +++ b/codegens/routeros-fetch/test/newman/fixtures/emptyFormdataCollection.json @@ -0,0 +1,33 @@ +{ + "info": { + "_postman_id": "998db352-bd24-4d69-9e7b-6f2e6ea0b7ec", + "name": "Multiple headers with same name", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "POST empty Formdata", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "formdata", + "formdata": [] + }, + "url": { + "raw": "https://postman-echo.com/post", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "post" + ] + } + }, + "response": [] + } + ], + "protocolProfileBehavior": {} +} \ No newline at end of file diff --git a/codegens/routeros-fetch/test/newman/fixtures/formdataCollection.json b/codegens/routeros-fetch/test/newman/fixtures/formdataCollection.json new file mode 100644 index 000000000..5a9923252 --- /dev/null +++ b/codegens/routeros-fetch/test/newman/fixtures/formdataCollection.json @@ -0,0 +1,65 @@ +{ + "info": { + "_postman_id": "7da8f1cd-aeb0-420f-a989-d47db46b44b0", + "name": "Multipart/form-data", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "POST multipart/form-data with text parameters", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "pl", + "value": "'a'", + "type": "text" + }, + { + "key": "qu", + "value": "\"b\"", + "type": "text" + }, + { + "key": "sa", + "value": "d", + "type": "text" + }, + { + "key": "Special", + "value": "!@#$%&*()^_+=`~", + "type": "text" + }, + { + "key": "Not Select", + "value": "Disabled", + "type": "text", + "disabled": true + }, + { + "key": "more", + "value": ",./';[]}{\":?><|\\\\", + "type": "text" + } + ] + }, + "url": { + "raw": "https://postman-echo.com/post", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "post" + ] + } + }, + "response": [] + } + ], + "protocolProfileBehavior": {} +} \ No newline at end of file diff --git a/codegens/routeros-fetch/test/newman/fixtures/formdataFileCollection.json b/codegens/routeros-fetch/test/newman/fixtures/formdataFileCollection.json new file mode 100644 index 000000000..46df5aa28 --- /dev/null +++ b/codegens/routeros-fetch/test/newman/fixtures/formdataFileCollection.json @@ -0,0 +1,76 @@ +{ + "info": { + "_postman_id": "7da8f1cd-aeb0-420f-a989-d47db46b44b0", + "name": "Multipart/form-data FILE", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Single/multiple file upload via form-data", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "single file", + "value": "", + "type": "file", + "src": "/Users/ammo/work/postman-code-generators/dummyFile1.txt" + }, + { + "key": "multiple files", + "value": "", + "type": "file", + "src": [ + "/Users/ammo/work/postman-code-generators/dummyFile2.txt", + "/Users/ammo/work/postman-code-generators/dummyFile3.txt" + ] + } + ] + }, + "url": { + "raw": "https://postman-echo.com/post", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "post" + ] + } + } + }, + { + "name": "Binary file upload via form-data", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "binary file", + "value": "", + "type": "file", + "src": "/Users/ammo/work/postman-code-generators/dummyBinaryFile" + } + ] + }, + "url": { + "raw": "https://postman-echo.com/post", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "post" + ] + } + } + } + ] +} \ No newline at end of file diff --git a/codegens/routeros-fetch/test/newman/fixtures/queryParamsCollection.json b/codegens/routeros-fetch/test/newman/fixtures/queryParamsCollection.json new file mode 100644 index 000000000..87dc6ce64 --- /dev/null +++ b/codegens/routeros-fetch/test/newman/fixtures/queryParamsCollection.json @@ -0,0 +1,31 @@ +{ + "info": { + "_postman_id": "0bb73926-93f7-4ad4-a191-6a5d9e3460ef", + "name": "Query Params Collection", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Query Param with encoded value", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "https://postman-echo.com/query=urn%3Ali%3Afoo%3A62324", + "host": [ + "postman-echo.com" + ], + "path": [ + "get" + ], + "query": [ + { + "key": "query", + "value": "urn%3Ali%3Afoo%3A62324" + } + ] + } + } + } + ] +} \ No newline at end of file diff --git a/codegens/routeros-fetch/test/newman/fixtures/rawBody.json b/codegens/routeros-fetch/test/newman/fixtures/rawBody.json new file mode 100644 index 000000000..754451109 --- /dev/null +++ b/codegens/routeros-fetch/test/newman/fixtures/rawBody.json @@ -0,0 +1,39 @@ +{ + "info": { + "_postman_id": "f52ee07d-6345-4220-89af-e6696b3c0122", + "name": "Basic Collection", + "description": "This collection contains requests that will be used to test validity of plugin created to convert postman request into code snippet of particular language.", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "POST raw with quoted text", + "event": [], + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"Hello\": \"{\\\"hello_world\\\": true}\"\n}" + }, + "url": { + "raw": "https://postman-echo.com/post", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "post" + ] + } + }, + "response": [] + } + ] +} \ No newline at end of file diff --git a/codegens/routeros-fetch/test/newman/fixtures/redirectCollection.json b/codegens/routeros-fetch/test/newman/fixtures/redirectCollection.json new file mode 100644 index 000000000..15a4c15ba --- /dev/null +++ b/codegens/routeros-fetch/test/newman/fixtures/redirectCollection.json @@ -0,0 +1,37 @@ +{ + "info": { + "_postman_id": "17d62db7-ca12-4298-8782-1d6f018c7be2", + "name": "Redirect test", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Follow Redirects", + "protocolProfileBehavior": { + "followRedirects": true + }, + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "https://httpbin.org/redirect-to?url=https://postman-echo.com/get", + "protocol": "https", + "host": [ + "httpbin", + "org" + ], + "path": [ + "redirect-to" + ], + "query": [ + { + "key": "url", + "value": "https://postman-echo.com/get" + } + ] + } + }, + "response": [] + } + ] +} \ No newline at end of file diff --git a/codegens/routeros-fetch/test/newman/fixtures/sameNameHeadersCollection.json b/codegens/routeros-fetch/test/newman/fixtures/sameNameHeadersCollection.json new file mode 100644 index 000000000..2aea01bbb --- /dev/null +++ b/codegens/routeros-fetch/test/newman/fixtures/sameNameHeadersCollection.json @@ -0,0 +1,40 @@ +{ + "info": { + "_postman_id": "998db352-bd24-4d69-9e7b-6f2e6ea0b7ec", + "name": "Multiple headers with same name", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Multiple headers with same name", + "request": { + "method": "GET", + "header": [ + { + "key": "key", + "value": "value1", + "type": "text" + }, + { + "key": "key", + "value": "value2", + "type": "text" + } + ], + "url": { + "raw": "https://postman-echo.com/get", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "get" + ] + } + }, + "response": [] + } + ], + "protocolProfileBehavior": {} +} \ No newline at end of file diff --git a/codegens/routeros-fetch/test/newman/fixtures/unsupportedMethods.json b/codegens/routeros-fetch/test/newman/fixtures/unsupportedMethods.json new file mode 100644 index 000000000..238ef1dec --- /dev/null +++ b/codegens/routeros-fetch/test/newman/fixtures/unsupportedMethods.json @@ -0,0 +1,288 @@ +{ + "info": { + "name": "Code-Gen Test PHP Guzzle", + "_postman_id": "43058ce7-94da-0f0f-366e-22b77d566316", + "description": "This collection contains requests that will be used to test validity of plugin created to convert postman request into code snippet of particular language.", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "LINK request", + "request": { + "method": "LINK", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": { + "mode": "raw", + "raw": "Duis posuere augue vel cursus pharetra. In luctus a ex nec pretium. Praesent neque quam, tincidunt nec leo eget, rutrum vehicula magna.\nMaecenas consequat elementum elit, id semper sem tristique et. Integer pulvinar enim quis consectetur interdum volutpat." + }, + "url": { + "raw": "https://postman-echo.com/request", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "request" + ] + }, + "description": null + }, + "response": [] + }, + { + "name": "UNLINK request", + "request": { + "method": "UNLINK", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": { + "mode": "raw", + "raw": "Duis posuere augue vel cursus pharetra. In luctus a ex nec pretium. Praesent neque quam, tincidunt nec leo eget, rutrum vehicula magna.\nMaecenas consequat elementum elit, id semper sem tristique et. Integer pulvinar enim quis consectetur interdum volutpat." + }, + "url": { + "raw": "https://postman-echo.com/request", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "request" + ] + }, + "description": null + }, + "response": [] + }, + { + "name": "LOCK request", + "request": { + "method": "LOCK", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": { + "mode": "raw", + "raw": "Duis posuere augue vel cursus pharetra. In luctus a ex nec pretium. Praesent neque quam, tincidunt nec leo eget, rutrum vehicula magna.\nMaecenas consequat elementum elit, id semper sem tristique et. Integer pulvinar enim quis consectetur interdum volutpat." + }, + "url": { + "raw": "https://postman-echo.com/request", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "request" + ] + }, + "description": null + }, + "response": [] + }, + { + "name": "UNLOCK request", + "request": { + "method": "UNLOCK", + "header": [], + "body": {}, + "url": { + "raw": "https://postman-echo.com/request", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "request" + ] + }, + "description": null + }, + "response": [] + }, + { + "name": "PROPFIND request", + "request": { + "method": "PROPFIND", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": { + "mode": "raw", + "raw": "Duis posuere augue vel cursus pharetra. In luctus a ex nec pretium. Praesent neque quam, tincidunt nec leo eget, rutrum vehicula magna.\nMaecenas consequat elementum elit, id semper sem tristique et. Integer pulvinar enim quis consectetur interdum volutpat." + }, + "url": { + "raw": "https://postman-echo.com/request", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "request" + ] + }, + "description": null + }, + "response": [] + }, + { + "name": "PURGE Request", + "request": { + "method": "PURGE", + "header": [], + "body": {}, + "url": { + "raw": "https://postman-echo.com", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ] + }, + "description": "" + }, + "response": [] + }, + { + "name": "COPY Request", + "request": { + "method": "COPY", + "header": [], + "body": {}, + "url": { + "raw": "https://postman-echo.com", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ] + }, + "description": "" + }, + "response": [ + { + "id": "47494bfb-6d21-4f1f-ace0-f88e5e1ac05d", + "name": "COPY Request", + "originalRequest": { + "method": "COPY", + "header": [], + "body": {}, + "url": { + "raw": "https://postman-echo.com", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "_postman_previewtype": "text", + "header": [ + { + "key": "Access-Control-Allow-Credentials", + "value": "", + "name": "Access-Control-Allow-Credentials", + "description": "Indicates whether or not the response to the request can be exposed when the credentials flag is true. When used as part of a response to a preflight request, this indicates whether or not the actual request can be made using credentials." + }, + { + "key": "Access-Control-Allow-Headers", + "value": "", + "name": "Access-Control-Allow-Headers", + "description": "Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request." + }, + { + "key": "Access-Control-Allow-Methods", + "value": "", + "name": "Access-Control-Allow-Methods", + "description": "Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request." + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*", + "name": "Access-Control-Allow-Origin", + "description": "Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource." + }, + { + "key": "Access-Control-Expose-Headers", + "value": "", + "name": "Access-Control-Expose-Headers", + "description": "Lets a server whitelist headers that browsers are allowed to access." + }, + { + "key": "Connection", + "value": "keep-alive", + "name": "Connection", + "description": "Options that are desired for the connection" + }, + { + "key": "Content-Encoding", + "value": "gzip", + "name": "Content-Encoding", + "description": "The type of encoding used on the data." + }, + { + "key": "Content-Length", + "value": "59", + "name": "Content-Length", + "description": "The length of the response body in octets (8-bit bytes)" + }, + { + "key": "Content-Type", + "value": "application/json; charset=utf-8", + "name": "Content-Type", + "description": "The mime type of this content" + }, + { + "key": "Date", + "value": "Mon, 05 Feb 2018 07:48:41 GMT", + "name": "Date", + "description": "The date and time that the message was sent" + }, + { + "key": "ETag", + "value": "W/\"af-MmpVeTvfnSW88c4riXD0uw\"", + "name": "ETag", + "description": "An identifier for a specific version of a resource, often a message digest" + }, + { + "key": "Server", + "value": "nginx", + "name": "Server", + "description": "A name for the server" + }, + { + "key": "Vary", + "value": "Accept-Encoding", + "name": "Vary", + "description": "Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server." + } + ], + "cookie": [], + "responseTime": 378, + "body": "{\n \"status\": 200,\n \"method\": \"COPY\"\n}" + } + ] + } + ] +} diff --git a/codegens/routeros-fetch/test/newman/newman.test.js b/codegens/routeros-fetch/test/newman/newman.test.js new file mode 100644 index 000000000..a8251eaf9 --- /dev/null +++ b/codegens/routeros-fetch/test/newman/newman.test.js @@ -0,0 +1,30 @@ +var runNewmanTest = require('../../../../test/codegen/newman/newmanTestUtil').runNewmanTest, + convert = require('../../index').convert; + +describe('RouterOS Fetch Converter', function () { + describe('convert for different request types', function () { + var options = {}, + // eslint-disable-next-line no-unused-vars + testConfigSshParse = { + // filename along with the appropriate version of the file. This file will be used to run the snippet. + fileName: 'routeros-fetch-cmd.rsc', + // Run script required to run the generated code snippet + runScript: 'ssh admin@192.168.88.1 \':delay 2s; [[:parse [/file/get newman.rsc contents]]]\'', + // Compile script required to compile the code snippet + compileScript: 'scp ./routeros-fetch-cmd.rsc admin@192.168.88.1:/newman.rsc; sleep 3', + // Array of name of collections for which newman tests has to be skipped. + skipCollections: ['unsupportedMethods', 'redirectCollection', 'queryParamsCollection'] + }, + testConfig = { + // filename along with the appropriate version of the file. This file will be used to run the snippet. + fileName: '', + // Run script required to run the generated code snippet + runScript: '', + // Compile script required to compile the code snippet + compileScript: '', + // Array of name of collections for which newman tests has to be skipped. + skipCollections: ['unsupportedMethods', 'redirectCollection', 'queryParamsCollection'] + }; + runNewmanTest(convert, options, testConfig); + }); +}); diff --git a/codegens/routeros-fetch/test/resources/error-collection.json b/codegens/routeros-fetch/test/resources/error-collection.json new file mode 100644 index 000000000..a75871b49 --- /dev/null +++ b/codegens/routeros-fetch/test/resources/error-collection.json @@ -0,0 +1,333 @@ +{ + "info": { + "_postman_id": "eadbe479-f684-475d-958a-9c174fa43919", + "name": "Code-Gen Test Cases HTTP", + "description": "This collection contains requests that will be used to test validity of plugin created to convert postman request into code snippet of particular language.", + "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" + }, + "item": [{ + "name": "Error with Request Headers (With special Characters)", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "var responseJSON;", + "try {", + " tests[\"Body contains headers\"] = responseBody.has(\"headers\");", + " responseJSON = JSON.parse(responseBody);", + " tests[\"Header contains host\"] = \"host\" in responseJSON.headers;", + " tests[\"Header contains test parameter sent as part of request header\"] = \"my-sample-header\" in responseJSON.headers;", + "}", + "catch (e) { }", + "", + "", + "", + "" + ] + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "my-sample-header", + "value": "Lorem ipsum dolor sit amet" + }, + { + "key": "TEST", + "value": "@#$%^&*()" + }, + { + "key": "more", + "value": ",./';[]}{\":?><|\\\\" + } + ], + "body": { + "mode": "raw", + "raw": "" + }, + "url": "https://postman-echo.com/headers", + "description": "A `GET` request to this endpoint returns the list of all request headers as part of the response JSON.\nIn Postman, sending your own set of headers through the [Headers tab](https://www.getpostman.com/docs/requests#headers?source=echo-collection-app-onboarding) will reveal the headers as part of the response." + }, + "response": [] + }, + { + "name": "Error with OPTIONS to postman echo", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "var responseJSON;", + "", + "try { ", + " responseJSON = JSON.parse(responseBody); ", + " tests['response is valid JSON'] = true;", + "}", + "catch (e) { ", + " responseJSON = {}; ", + " tests['response is valid JSON'] = false;", + "}", + "", + "", + "tests['response has post data'] = _.has(responseJSON, 'data');", + "tests['response matches the data posted'] = (responseJSON.data && responseJSON.data.length === 256);", + "", + "tests[\"content-type equals text/plain\"] = responseJSON && responseJSON.headers && (responseJSON.headers[\"content-type\"] === 'text/plain');" + ] + } + } + ], + "request": { + "auth": { + "type": "noauth" + }, + "method": "OPTIONS", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": { + "mode": "raw", + "raw": "Duis posuere augue vel cursus pharetra. In luctus a ex nec pretium. Praesent neque quam, tincidunt nec leo eget, rutrum vehicula magna.\nMaecenas consequat elementum elit, id semper sem tristique et. Integer pulvinar enim quis consectetur interdum volutpat." + }, + "url": "https://postman-echo.com/post", + "description": "The HTTP `POST` request method is meant to transfer data to a server \n(and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `POST` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following request,\n\n> POST /hi/there?hand=wave\n>\n> \n\nThe parameter \"hand\" has the value \"wave\". The request body can be in multiple\nformats. These formats are defined by the MIME type of the request. The MIME \nType can be set using the ``Content-Type`` HTTP header. The most commonly used \nMIME types are:\n\n* `multipart/form-data`\n* `application/x-www-form-urlencoded`\n* `application/json`\n\nThis endpoint echoes the HTTP headers, request parameters, the contents of\nthe request body and the complete URI requested." + }, + "response": [] + }, + { + "name": "LINK request", + "request": { + "method": "LINK", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": { + "mode": "raw", + "raw": "Duis posuere augue vel cursus pharetra. In luctus a ex nec pretium. Praesent neque quam, tincidunt nec leo eget, rutrum vehicula magna.\nMaecenas consequat elementum elit, id semper sem tristique et. Integer pulvinar enim quis consectetur interdum volutpat." + }, + "url": "https://postman-echo.com/request" + }, + "response": [] + }, + { + "name": "UNLINK request", + "request": { + "method": "UNLINK", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": { + "mode": "raw", + "raw": "Duis posuere augue vel cursus pharetra. In luctus a ex nec pretium. Praesent neque quam, tincidunt nec leo eget, rutrum vehicula magna.\nMaecenas consequat elementum elit, id semper sem tristique et. Integer pulvinar enim quis consectetur interdum volutpat." + }, + "url": "https://postman-echo.com/request" + }, + "response": [] + }, + { + "name": "LOCK request", + "request": { + "method": "LOCK", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": { + "mode": "raw", + "raw": "Duis posuere augue vel cursus pharetra. In luctus a ex nec pretium. Praesent neque quam, tincidunt nec leo eget, rutrum vehicula magna.\nMaecenas consequat elementum elit, id semper sem tristique et. Integer pulvinar enim quis consectetur interdum volutpat." + }, + "url": "https://postman-echo.com/request" + }, + "response": [] + }, + { + "name": "UNLOCK request", + "request": { + "method": "UNLOCK", + "header": [], + "body": { + "mode": "raw", + "raw": "" + }, + "url": "https://postman-echo.com/request" + }, + "response": [] + }, + { + "name": "PROPFIND request", + "request": { + "method": "PROPFIND", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": { + "mode": "raw", + "raw": "Duis posuere augue vel cursus pharetra. In luctus a ex nec pretium. Praesent neque quam, tincidunt nec leo eget, rutrum vehicula magna.\nMaecenas consequat elementum elit, id semper sem tristique et. Integer pulvinar enim quis consectetur interdum volutpat." + }, + "url": "https://postman-echo.com/request" + }, + "response": [] + }, + { + "name": "VIEW request", + "request": { + "method": "VIEW", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": { + "mode": "raw", + "raw": "Duis posuere augue vel cursus pharetra. In luctus a ex nec pretium. Praesent neque quam, tincidunt nec leo eget, rutrum vehicula magna.\nMaecenas consequat elementum elit, id semper sem tristique et. Integer pulvinar enim quis consectetur interdum volutpat." + }, + "url": "https://postman-echo.com/request" + }, + "response": [] + }, + { + "name": "PURGE Request", + "request": { + "method": "PURGE", + "header": [], + "body": { + "mode": "raw", + "raw": "" + }, + "url": "https://postman-echo.com" + }, + "response": [] + }, + { + "name": "COPY Request", + "request": { + "method": "COPY", + "header": [], + "body": { + "mode": "raw", + "raw": "" + }, + "url": "https://postman-echo.com" + }, + "response": [ + { + "name": "COPY Request", + "originalRequest": { + "method": "COPY", + "header": [], + "body": { + "mode": "raw", + "raw": "" + }, + "url": "https://postman-echo.com" + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Access-Control-Allow-Credentials", + "value": "", + "name": "Access-Control-Allow-Credentials", + "description": "Indicates whether or not the response to the request can be exposed when the credentials flag is true. When used as part of a response to a preflight request, this indicates whether or not the actual request can be made using credentials." + }, + { + "key": "Access-Control-Allow-Headers", + "value": "", + "name": "Access-Control-Allow-Headers", + "description": "Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request." + }, + { + "key": "Access-Control-Allow-Methods", + "value": "", + "name": "Access-Control-Allow-Methods", + "description": "Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request." + }, + { + "key": "Access-Control-Allow-Origin", + "value": "*", + "name": "Access-Control-Allow-Origin", + "description": "Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource." + }, + { + "key": "Access-Control-Expose-Headers", + "value": "", + "name": "Access-Control-Expose-Headers", + "description": "Lets a server whitelist headers that browsers are allowed to access." + }, + { + "key": "Connection", + "value": "keep-alive", + "name": "Connection", + "description": "Options that are desired for the connection" + }, + { + "key": "Content-Encoding", + "value": "gzip", + "name": "Content-Encoding", + "description": "The type of encoding used on the data." + }, + { + "key": "Content-Length", + "value": "59", + "name": "Content-Length", + "description": "The length of the response body in octets (8-bit bytes)" + }, + { + "key": "Content-Type", + "value": "application/json; charset=utf-8", + "name": "Content-Type", + "description": "The mime type of this content" + }, + { + "key": "Date", + "value": "Mon, 05 Feb 2018 07:48:41 GMT", + "name": "Date", + "description": "The date and time that the message was sent" + }, + { + "key": "ETag", + "value": "W/\"af-MmpVeTvfnSW88c4riXD0uw\"", + "name": "ETag", + "description": "An identifier for a specific version of a resource, often a message digest" + }, + { + "key": "Server", + "value": "nginx", + "name": "Server", + "description": "A name for the server" + }, + { + "key": "Vary", + "value": "Accept-Encoding", + "name": "Vary", + "description": "Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server." + } + ], + "cookie": [], + "body": "{\n \"status\": 200,\n \"method\": \"COPY\"\n}" + } + ] + } + ] +} diff --git a/codegens/routeros-fetch/test/resources/expected-http-messages.json b/codegens/routeros-fetch/test/resources/expected-http-messages.json new file mode 100644 index 000000000..6e0cab2ef --- /dev/null +++ b/codegens/routeros-fetch/test/resources/expected-http-messages.json @@ -0,0 +1,23 @@ +{ + "result": [ + "/tool/fetch http-method=get url=\"https://postman-echo.com/headers\" http-header-field=(\"my-sample-header: Lorem ipsum dolor sit amet\",\"testing: 'singlequotes'\",\"TEST: \\\"doublequotes\\\"\")", + "/tool/fetch http-method=get url=\"https://postman-echo.com/headers\" http-header-field=(\"my-sample-header: Lorem ipsum dolor sit amet\",\"not-disabled-header: ENABLED\")", + "/tool/fetch http-method=get url=\"https://postman-echo.com/get?test=123&anotherone=232\"", + "/tool/fetch http-method=post url=\"https://postman-echo.com/post\" http-data=\"------FormDataVariable\\nContent-Disposition: form-data; name=\\\"pl\\\"\\r\\n\\r\\n'a'\\r\\n------FormDataVariable\\r\\nContent-Disposition: form-data; name=\\\"qu\\\"\\r\\n\\r\\n\\\"b\\\"\\r\\n------FormDataVariable\\r\\nContent-Disposition: form-data; name=\\\"hdjkljh\\\"\\r\\n\\r\\nc\\r\\n------FormDataVariable\\r\\nContent-Disposition: form-data; name=\\\"sa\\\"\\r\\n\\r\\nd\\r\\n------FormDataVariable\\r\\nContent-Disposition: form-data; name=\\\"Special\\\"\\r\\n\\r\\n!@#\\$%&*()^_+=`~ \\r\\n------FormDataVariable\\r\\nContent-Disposition: form-data; name=\\\"more\\\"\\r\\n\\r\\n,./';[]}{\\\":?><|\\\\\\\\\\r\\n------FormDataVariable--\\r\\n\" http-header-field=\"Content-Type: multipart/form-data; boundary=----FormDataVariable\"", + "/tool/fetch http-method=post url=\"https://postman-echo.com/post?a=!@\\$^*()_-`%26&b=,./';[]}{\\\":/?><||\" http-data=\"\"", + "/tool/fetch http-method=post url=\"https://postman-echo.com/post\" http-data=\"Duis posuere augue vel cursus pharetra. In luctus a ex nec pretium. Praesent neque quam, tincidunt nec leo eget, rutrum vehicula magna.\\nMaecenas consequat elementum elit, id semper sem tristique et. Integer pulvinar enim quis consectetur interdum volutpat.!@#\\$%^&*()+POL:},'';,[;[;\\n\\n\\n\" http-header-field=\"Content-Type: application/x-www-form-urlencoded\"", + "/tool/fetch http-method=post url=\"https://postman-echo.com/post\" http-data=\"1='a'&2=%22b%22&'3'=c&%224%22=d&Special=!%40%23%24%25%26*()%5E_%3D%60~%20%20%20%20&more=%2C.%2F'%3B%5B%5D%7D%7B%22%3A%3F%3E%3C%7C%5C%5C%20%20%20%20\" http-header-field=\"Content-Type: application/x-www-form-urlencoded\"", + "/tool/fetch http-method=post url=\"https://postman-echo.com/post\" http-data=\"{\\n \\\"json\\\": \\\"Test-Test!@#\\$%^&*()+POL:},'';,[;[;:>\\\"\\n}\" http-header-field=\"Content-Type: application/json\"", + "/tool/fetch http-method=post url=\"https://postman-echo.com/post\" http-data=\"var val = 6;\\nconsole.log(val);\" http-header-field=\"Content-Type: application/javascript\"", + "/tool/fetch http-method=post url=\"https://postman-echo.com/post\" http-data=\"\\n\\tTest Test!@#\\$%^&*()+POL:},'';,[;[;\\n\" http-header-field=\"Content-Type: text/xml\"", + "/tool/fetch http-method=post url=\"https://postman-echo.com/post\" http-data=\"\\n Test Test !@#\\$%^&*()+POL:},'';,[;[;\\n\" http-header-field=\"Content-Type: text/html\"", + "/tool/fetch http-method=post url=\"https://postman-echo.com/post?a=''&b=\\\"\\\"\" http-data=\"\"", + "/tool/fetch http-method=put url=\"https://postman-echo.com/put\" http-data=\"Etiam mi lacus, cursus vitae felis et, blandit pellentesque neque. Vestibulum eget nisi a tortor commodo dignissim.\\nQuisque ipsum ligula, faucibus a felis a, commodo elementum nisl. Mauris vulputate sapien et tincidunt viverra. Donec vitae velit nec metus.\" http-header-field=\"Content-Type: text/plain\"", + "/tool/fetch http-method=patch url=\"https://postman-echo.com/patch\" http-header-field=\"Content-Type: text/plain\"", + "/tool/fetch http-method=delete url=\"https://postman-echo.com/delete\" http-header-field=\"Content-Type: text/plain\"", + "/tool/fetch http-method=post url=\"https://postman-echo.com/post\" http-data=\"Content-Disposition: form-data; name=\\\"file\\\"; filename=\\\"file.txt\\\"\\r\\nContent-Type: text/plain\\r\\n\\r\\n\\$[/file get file.txt contents]\\r\\n------FormDataVariable--\\r\\n\" http-header-field=\"Content-Type: multipart/form-data; boundary=----FormDataVariable\"", + "/tool/fetch http-method=post url=\"https://postman-echo.com/post\" http-data=\"\\\"\\\"\" http-header-field=\"Content-Type: text/plain\"", + "/tool/fetch http-method=get url=\"http://localhost:5050\"", + "/tool/fetch http-method=get url=\"http://localhost:5050/knockknock\"" + ] +} diff --git a/codegens/routeros-fetch/test/resources/test-collection.json b/codegens/routeros-fetch/test/resources/test-collection.json new file mode 100644 index 000000000..1c623da1e --- /dev/null +++ b/codegens/routeros-fetch/test/resources/test-collection.json @@ -0,0 +1,1020 @@ +{ + "info": { + "_postman_id": "eadbe479-f684-475d-958a-9c174fa43919", + "name": "Code-Gen Test Cases HTTP", + "description": "This collection contains requests that will be used to test validity of plugin created to convert postman request into code snippet of particular language.", + "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" + }, + "item": [ + { + "name": "Request Headers", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "var responseJSON;", + "try {", + " tests[\"Body contains headers\"] = responseBody.has(\"headers\");", + " responseJSON = JSON.parse(responseBody);", + " tests[\"Header contains host\"] = \"host\" in responseJSON.headers;", + " tests[\"Header contains test parameter sent as part of request header\"] = \"my-sample-header\" in responseJSON.headers;", + "}", + "catch (e) { }", + "", + "", + "", + "" + ] + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "my-sample-header", + "value": "Lorem ipsum dolor sit amet" + }, + { + "key": "testing", + "value": "'singlequotes'" + }, + { + "key": "TEST", + "value": "\"doublequotes\"" + } + ], + "body": { + "mode": "raw", + "raw": "" + }, + "url": "https://postman-echo.com/headers", + "description": "A `GET` request to this endpoint returns the list of all request headers as part of the response JSON.\nIn Postman, sending your own set of headers through the [Headers tab](https://www.getpostman.com/docs/requests#headers?source=echo-collection-app-onboarding) will reveal the headers as part of the response." + }, + "response": [] + }, + + { + "name": "Request Headers with disabled headers", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "var responseJSON;", + "try {", + " tests[\"Body contains headers\"] = responseBody.has(\"headers\");", + " responseJSON = JSON.parse(responseBody);", + " tests[\"Header contains host\"] = \"host\" in responseJSON.headers;", + " tests[\"Header contains test parameter sent as part of request header\"] = \"my-sample-header\" in responseJSON.headers;", + "}", + "catch (e) { }", + "", + "", + "", + "" + ] + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "my-sample-header", + "value": "Lorem ipsum dolor sit amet" + }, + { + "key": "not-disabled-header", + "value": "ENABLED" + }, + { + "key": "disabled header", + "value": "DISABLED", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "" + }, + "url": "https://postman-echo.com/headers", + "description": "A `GET` request to this endpoint returns the list of all request headers as part of the response JSON.\nIn Postman, sending your own set of headers through the [Headers tab](https://www.getpostman.com/docs/requests#headers?source=echo-collection-app-onboarding) will reveal the headers as part of the response." + }, + "response": [] + }, + { + "name": "GET Request with disabled query", + "event": [ + { + "listen": "test", + "script": { + "id": "1bfe1fc3-c244-4a42-83c5-1a0d94d56ffd", + "exec": [ + "var responseJSON;", + "", + "try { ", + " responseJSON = JSON.parse(responseBody); ", + " tests['response is valid JSON'] = true;", + "}", + "catch (e) { ", + " responseJSON = {}; ", + " tests['response is valid JSON'] = false;", + "}", + "", + "tests['response json contains headers'] = _.has(responseJSON, 'headers');", + "tests['response json contains args'] = _.has(responseJSON, 'args');", + "tests['response json contains url'] = _.has(responseJSON, 'url');", + "", + "tests['args key contains argument passed as url parameter'] = ('test' in responseJSON.args);", + "tests['args passed via request url params has value \"123\"'] = (_.get(responseJSON, 'args.test') === \"123\");" + ], + "type": "text/javascript" + } + } + ], + "protocolProfileBehavior": { + "disableBodyPruning": true + }, + "request": { + "method": "GET", + "header": [], + "body": {}, + "url": { + "raw": "https://postman-echo.com/get?test=123&anotherone=232", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "get" + ], + "query": [ + { + "key": "test", + "value": "123" + }, + { + "key": "anotherone", + "value": "232" + }, + { + "key": "anotheroneone", + "value": "sdfsdf", + "disabled": true + } + ] + }, + "description": "The HTTP `GET` request method is meant to retrieve data from a server. The data\nis identified by a unique URI (Uniform Resource Identifier). \n\nA `GET` request can pass parameters to the server using \"Query String \nParameters\". For example, in the following request,\n\n> http://example.com/hi/there?hand=wave\n\nThe parameter \"hand\" has the value \"wave\".\n\nThis endpoint echoes the HTTP headers, request parameters and the complete\nURI requested." + }, + "response": [] + }, + { + "name": "POST form data with special characters", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "var responseJSON;", + "", + "try { ", + " responseJSON = JSON.parse(responseBody); ", + " tests['response is valid JSON'] = true;", + "}", + "catch (e) { ", + " responseJSON = {}; ", + " tests['response is valid JSON'] = false;", + "}", + "", + "", + "tests['response has post data'] = _.has(responseJSON, 'data');", + "tests['response matches the data posted'] = (responseJSON.data && responseJSON.data.length === 256);", + "", + "tests[\"content-type equals text/plain\"] = responseJSON && responseJSON.headers && (responseJSON.headers[\"content-type\"] === 'text/plain');" + ] + } + } + ], + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "pl", + "value": "'a'", + "type": "text" + }, + { + "key": "qu", + "value": "\"b\"", + "type": "text" + }, + { + "key": "hdjkljh", + "value": "c", + "type": "text" + }, + { + "key": "sa", + "value": "d", + "type": "text" + }, + { + "key": "Special", + "value": "!@#$%&*()^_+=`~ ", + "type": "text" + }, + { + "key": "Not Select", + "value": "Disabled", + "type": "text", + "disabled": true + }, + { + "key": "more", + "value": ",./';[]}{\":?><|\\\\", + "type": "text" + } + ] + }, + "url": "https://postman-echo.com/post", + "description": "The HTTP `POST` request method is meant to transfer data to a server \n(and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `POST` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following request,\n\n> POST /hi/there?hand=wave\n>\n> \n\nThe parameter \"hand\" has the value \"wave\". The request body can be in multiple\nformats. These formats are defined by the MIME type of the request. The MIME \nType can be set using the ``Content-Type`` HTTP header. The most commonly used \nMIME types are:\n\n* `multipart/form-data`\n* `application/x-www-form-urlencoded`\n* `application/json`\n\nThis endpoint echoes the HTTP headers, request parameters, the contents of\nthe request body and the complete URI requested." + }, + "response": [] + }, + { + "name": "Resolve URL (Quotes + Special Characters) Copy", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "" + }, + "url": { + "raw": "https://postman-echo.com/:action?a=!@$^*()_-`%26&b=,./';[]}{\":/?><||", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + ":action" + ], + "query": [ + { + "key": "a", + "value": "!@$^*()_-`%26" + }, + { + "key": "b", + "value": ",./';[]}{\":/?><||" + } + ], + "variable": [ + { + "key": "action", + "value": "post" + } + ] + } + }, + "response": [] + }, + { + "name": "POST Raw Text", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "var responseJSON;", + "", + "try { ", + " responseJSON = JSON.parse(responseBody); ", + " tests['response is valid JSON'] = true;", + "}", + "catch (e) { ", + " responseJSON = {}; ", + " tests['response is valid JSON'] = false;", + "}", + "", + "", + "tests['response has post data'] = _.has(responseJSON, 'data');", + "tests['response matches the data posted'] = (responseJSON.data && responseJSON.data.length === 256);", + "", + "tests[\"content-type equals text/plain\"] = responseJSON && responseJSON.headers && (responseJSON.headers[\"content-type\"] === 'text/plain');" + ] + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/x-www-form-urlencoded" + } + ], + "body": { + "mode": "raw", + "raw": "Duis posuere augue vel cursus pharetra. In luctus a ex nec pretium. Praesent neque quam, tincidunt nec leo eget, rutrum vehicula magna.\nMaecenas consequat elementum elit, id semper sem tristique et. Integer pulvinar enim quis consectetur interdum volutpat.!@#$%^&*()+POL:},'';,[;[;\n\n\n" + }, + "url": "https://postman-echo.com/post", + "description": "The HTTP `POST` request method is meant to transfer data to a server \n(and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `POST` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following request,\n\n> POST /hi/there?hand=wave\n>\n> \n\nThe parameter \"hand\" has the value \"wave\". The request body can be in multiple\nformats. These formats are defined by the MIME type of the request. The MIME \nType can be set using the ``Content-Type`` HTTP header. The most commonly used \nMIME types are:\n\n* `multipart/form-data`\n* `application/x-www-form-urlencoded`\n* `application/json`\n\nThis endpoint echoes the HTTP headers, request parameters, the contents of\nthe request body and the complete URI requested." + }, + "response": [] + }, + { + "name": "POST urlencoded data", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "var responseJSON;", + "", + "try { ", + " responseJSON = JSON.parse(responseBody); ", + " tests['response is valid JSON'] = true;", + "}", + "catch (e) { ", + " responseJSON = {}; ", + " tests['response is valid JSON'] = false;", + "}", + "", + "", + "tests['response has post data'] = _.has(responseJSON, 'data');", + "tests['response matches the data posted'] = (responseJSON.data && responseJSON.data.length === 256);", + "", + "tests[\"content-type equals text/plain\"] = responseJSON && responseJSON.headers && (responseJSON.headers[\"content-type\"] === 'text/plain');" + ] + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/x-www-form-urlencoded" + } + ], + "body": { + "mode": "urlencoded", + "urlencoded": [ + { + "key": "1", + "value": "'a'", + "type": "text" + }, + { + "key": "2", + "value": "\"b\"", + "type": "text" + }, + { + "key": "'3'", + "value": "c", + "type": "text" + }, + { + "key": "\"4\"", + "value": "d", + "type": "text" + }, + { + "key": "Special", + "value": "!@#$%&*()^_=`~ ", + "type": "text" + }, + { + "key": "more", + "value": ",./';[]}{\":?><|\\\\ ", + "type": "text" + } + ] + }, + "url": "https://postman-echo.com/post", + "description": "The HTTP `POST` request method is meant to transfer data to a server \n(and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `POST` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following request,\n\n> POST /hi/there?hand=wave\n>\n> \n\nThe parameter \"hand\" has the value \"wave\". The request body can be in multiple\nformats. These formats are defined by the MIME type of the request. The MIME \nType can be set using the ``Content-Type`` HTTP header. The most commonly used \nMIME types are:\n\n* `multipart/form-data`\n* `application/x-www-form-urlencoded`\n* `application/json`\n\nThis endpoint echoes the HTTP headers, request parameters, the contents of\nthe request body and the complete URI requested." + }, + "response": [] + }, + { + "name": "POST json with raw", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "var responseJSON;", + "", + "try { ", + " responseJSON = JSON.parse(responseBody); ", + " tests['response is valid JSON'] = true;", + "}", + "catch (e) { ", + " responseJSON = {}; ", + " tests['response is valid JSON'] = false;", + "}", + "", + "", + "tests['response has post data'] = _.has(responseJSON, 'data');", + "tests['response matches the data posted'] = (responseJSON.data && responseJSON.data.length === 256);", + "", + "tests[\"content-type equals text/plain\"] = responseJSON && responseJSON.headers && (responseJSON.headers[\"content-type\"] === 'text/plain');" + ] + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"json\": \"Test-Test!@#$%^&*()+POL:},'';,[;[;:>\"\n}" + }, + "url": "https://postman-echo.com/post", + "description": "The HTTP `POST` request method is meant to transfer data to a server \n(and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `POST` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following request,\n\n> POST /hi/there?hand=wave\n>\n> \n\nThe parameter \"hand\" has the value \"wave\". The request body can be in multiple\nformats. These formats are defined by the MIME type of the request. The MIME \nType can be set using the ``Content-Type`` HTTP header. The most commonly used \nMIME types are:\n\n* `multipart/form-data`\n* `application/x-www-form-urlencoded`\n* `application/json`\n\nThis endpoint echoes the HTTP headers, request parameters, the contents of\nthe request body and the complete URI requested." + }, + "response": [ + { + "name": "POST json with raw", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"json\": \"Test-Test\"\n}" + }, + "url": "https://postman-echo.com/post" + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Access-Control-Allow-Credentials", + "value": "", + "name": "Access-Control-Allow-Credentials", + "description": "Indicates whether or not the response to the request can be exposed when the credentials flag is true. When used as part of a response to a preflight request, this indicates whether or not the actual request can be made using credentials." + }, + { + "key": "Access-Control-Allow-Headers", + "value": "", + "name": "Access-Control-Allow-Headers", + "description": "Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request." + }, + { + "key": "Access-Control-Allow-Methods", + "value": "", + "name": "Access-Control-Allow-Methods", + "description": "Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request." + }, + { + "key": "Access-Control-Allow-Origin", + "value": "", + "name": "Access-Control-Allow-Origin", + "description": "Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource." + }, + { + "key": "Access-Control-Expose-Headers", + "value": "", + "name": "Access-Control-Expose-Headers", + "description": "Lets a server whitelist headers that browsers are allowed to access." + }, + { + "key": "Connection", + "value": "keep-alive", + "name": "Connection", + "description": "Options that are desired for the connection" + }, + { + "key": "Content-Encoding", + "value": "gzip", + "name": "Content-Encoding", + "description": "The type of encoding used on the data." + }, + { + "key": "Content-Length", + "value": "385", + "name": "Content-Length", + "description": "The length of the response body in octets (8-bit bytes)" + }, + { + "key": "Content-Type", + "value": "application/json; charset=utf-8", + "name": "Content-Type", + "description": "The mime type of this content" + }, + { + "key": "Date", + "value": "Wed, 07 Feb 2018 10:06:15 GMT", + "name": "Date", + "description": "The date and time that the message was sent" + }, + { + "key": "ETag", + "value": "W/\"215-u7EU1nFtauIn0/aVifjuXA\"", + "name": "ETag", + "description": "An identifier for a specific version of a resource, often a message digest" + }, + { + "key": "Server", + "value": "nginx", + "name": "Server", + "description": "A name for the server" + }, + { + "key": "Vary", + "value": "X-HTTP-Method-Override, Accept-Encoding", + "name": "Vary", + "description": "Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server." + }, + { + "key": "set-cookie", + "value": "sails.sid=s%3AxRBxgrc9M-jKK_l1mX3y3rM_ry8wYLz4.Of4qpOzd9hi6uO0sAQIj%2Bxs2VeppWxYjJa4OpIW3PKg; Path=/; HttpOnly", + "name": "set-cookie", + "description": "an HTTP cookie" + } + ], + "cookie": [ + { + "expires": "Invalid Date", + "httpOnly": true, + "domain": "postman-echo.com", + "path": "/", + "secure": false, + "value": "s%3AxRBxgrc9M-jKK_l1mX3y3rM_ry8wYLz4.Of4qpOzd9hi6uO0sAQIj%2Bxs2VeppWxYjJa4OpIW3PKg", + "key": "sails.sid" + } + ], + "body": "{\"args\":{},\"data\":\"{\\n \\\"json\\\": \\\"Test-Test\\\"\\n}\",\"files\":{},\"form\":{},\"headers\":{\"host\":\"postman-echo.com\",\"content-length\":\"25\",\"accept\":\"*/*\",\"accept-encoding\":\"gzip, deflate\",\"cache-control\":\"no-cache\",\"content-type\":\"text/plain\",\"cookie\":\"sails.sid=s%3AkOgtF1XmXtVFx-Eg3S7-37BKKaMqMDPe.hnwldNwyvsaASUiRR0Y0vcowadkMXO4HMegTeVIPgqo\",\"postman-token\":\"2ced782f-a141-428e-8af6-04ce954a77d5\",\"user-agent\":\"PostmanRuntime/7.1.1\",\"x-forwarded-port\":\"443\",\"x-forwarded-proto\":\"https\"},\"json\":null,\"url\":\"https://postman-echo.com/post\"}" + } + ] + }, + { + "name": "POST javascript with raw", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "var responseJSON;", + "", + "try { ", + " responseJSON = JSON.parse(responseBody); ", + " tests['response is valid JSON'] = true;", + "}", + "catch (e) { ", + " responseJSON = {}; ", + " tests['response is valid JSON'] = false;", + "}", + "", + "", + "tests['response has post data'] = _.has(responseJSON, 'data');", + "tests['response matches the data posted'] = (responseJSON.data && responseJSON.data.length === 256);", + "", + "tests[\"content-type equals text/plain\"] = responseJSON && responseJSON.headers && (responseJSON.headers[\"content-type\"] === 'text/plain');" + ] + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/javascript" + } + ], + "body": { + "mode": "raw", + "raw": "var val = 6;\nconsole.log(val);" + }, + "url": "https://postman-echo.com/post", + "description": "The HTTP `POST` request method is meant to transfer data to a server \n(and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `POST` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following request,\n\n> POST /hi/there?hand=wave\n>\n> \n\nThe parameter \"hand\" has the value \"wave\". The request body can be in multiple\nformats. These formats are defined by the MIME type of the request. The MIME \nType can be set using the ``Content-Type`` HTTP header. The most commonly used \nMIME types are:\n\n* `multipart/form-data`\n* `application/x-www-form-urlencoded`\n* `application/json`\n\nThis endpoint echoes the HTTP headers, request parameters, the contents of\nthe request body and the complete URI requested." + }, + "response": [] + }, + { + "name": "POST text/xml with raw", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "var responseJSON;", + "", + "try { ", + " responseJSON = JSON.parse(responseBody); ", + " tests['response is valid JSON'] = true;", + "}", + "catch (e) { ", + " responseJSON = {}; ", + " tests['response is valid JSON'] = false;", + "}", + "", + "", + "tests['response has post data'] = _.has(responseJSON, 'data');", + "tests['response matches the data posted'] = (responseJSON.data && responseJSON.data.length === 256);", + "", + "tests[\"content-type equals text/plain\"] = responseJSON && responseJSON.headers && (responseJSON.headers[\"content-type\"] === 'text/plain');" + ] + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "text/xml" + } + ], + "body": { + "mode": "raw", + "raw": "\n\tTest Test!@#$%^&*()+POL:},'';,[;[;\n" + }, + "url": "https://postman-echo.com/post", + "description": "The HTTP `POST` request method is meant to transfer data to a server \n(and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `POST` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following request,\n\n> POST /hi/there?hand=wave\n>\n> \n\nThe parameter \"hand\" has the value \"wave\". The request body can be in multiple\nformats. These formats are defined by the MIME type of the request. The MIME \nType can be set using the ``Content-Type`` HTTP header. The most commonly used \nMIME types are:\n\n* `multipart/form-data`\n* `application/x-www-form-urlencoded`\n* `application/json`\n\nThis endpoint echoes the HTTP headers, request parameters, the contents of\nthe request body and the complete URI requested." + }, + "response": [] + }, + { + "name": "POST text/html with raw", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "var responseJSON;", + "", + "try { ", + " responseJSON = JSON.parse(responseBody); ", + " tests['response is valid JSON'] = true;", + "}", + "catch (e) { ", + " responseJSON = {}; ", + " tests['response is valid JSON'] = false;", + "}", + "", + "", + "tests['response has post data'] = _.has(responseJSON, 'data');", + "tests['response matches the data posted'] = (responseJSON.data && responseJSON.data.length === 256);", + "", + "tests[\"content-type equals text/plain\"] = responseJSON && responseJSON.headers && (responseJSON.headers[\"content-type\"] === 'text/plain');" + ] + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "text/html" + } + ], + "body": { + "mode": "raw", + "raw": "\n Test Test !@#$%^&*()+POL:},'';,[;[;\n" + }, + "url": "https://postman-echo.com/post", + "description": "The HTTP `POST` request method is meant to transfer data to a server \n(and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `POST` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following request,\n\n> POST /hi/there?hand=wave\n>\n> \n\nThe parameter \"hand\" has the value \"wave\". The request body can be in multiple\nformats. These formats are defined by the MIME type of the request. The MIME \nType can be set using the ``Content-Type`` HTTP header. The most commonly used \nMIME types are:\n\n* `multipart/form-data`\n* `application/x-www-form-urlencoded`\n* `application/json`\n\nThis endpoint echoes the HTTP headers, request parameters, the contents of\nthe request body and the complete URI requested." + }, + "response": [] + }, + { + "name": "Resolve URL", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "" + }, + "url": { + "raw": "https://postman-echo.com/:action?a=''&b=\"\"", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + ":action" + ], + "query": [ + { + "key": "a", + "value": "''" + }, + { + "key": "b", + "value": "\"\"" + }, + { + "key": "more", + "value": "", + "disabled": true + } + ], + "variable": [ + { + "key": "action", + "value": "post" + } + ] + } + }, + "response": [] + }, + { + "name": "PUT Request", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "var responseJSON;", + "", + "try { ", + " responseJSON = JSON.parse(responseBody); ", + " tests['response is valid JSON'] = true;", + "}", + "catch (e) { ", + " responseJSON = {}; ", + " tests['response is valid JSON'] = false;", + "}", + "", + "", + "tests['response has PUT data'] = _.has(responseJSON, 'data');", + "tests['response matches the data sent in request'] = (responseJSON.data && responseJSON.data.length === 256);" + ] + } + } + ], + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": { + "mode": "raw", + "raw": "Etiam mi lacus, cursus vitae felis et, blandit pellentesque neque. Vestibulum eget nisi a tortor commodo dignissim.\nQuisque ipsum ligula, faucibus a felis a, commodo elementum nisl. Mauris vulputate sapien et tincidunt viverra. Donec vitae velit nec metus." + }, + "url": "https://postman-echo.com/put", + "description": "The HTTP `PUT` request method is similar to HTTP `POST`. It too is meant to \ntransfer data to a server (and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `PUT` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following \nraw HTTP request,\n\n> PUT /hi/there?hand=wave\n>\n> \n\n\n" + }, + "response": [] + }, + { + "name": "PATCH Request", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "var responseJSON;", + "", + "try { ", + " responseJSON = JSON.parse(responseBody); ", + " tests['response is valid JSON'] = true;", + "}", + "catch (e) { ", + " responseJSON = {}; ", + " tests['response is valid JSON'] = false;", + "}", + "", + "", + "tests['response has PUT data'] = _.has(responseJSON, 'data');", + "tests['response matches the data sent in request'] = (responseJSON.data && responseJSON.data.length === 256);" + ] + } + } + ], + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": { + "mode": "raw", + "raw": "Curabitur auctor, elit nec pulvinar porttitor, ex augue condimentum enim, eget suscipit urna felis quis neque.\nSuspendisse sit amet luctus massa, nec venenatis mi. Suspendisse tincidunt massa at nibh efficitur fringilla. Nam quis congue mi. Etiam volutpat." + }, + "url": "https://postman-echo.com/patch", + "description": "The HTTP `PATCH` method is used to update resources on a server. The exact\nuse of `PATCH` requests depends on the server in question. There are a number\nof server implementations which handle `PATCH` differently. Technically, \n`PATCH` supports both Query String parameters and a Request Body.\n\nThis endpoint accepts an HTTP `PATCH` request and provides debug information\nsuch as the HTTP headers, Query String arguments, and the Request Body." + }, + "response": [] + }, + { + "name": "DELETE Request", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "var responseJSON;", + "", + "try { ", + " responseJSON = JSON.parse(responseBody); ", + " tests['response is valid JSON'] = true;", + "}", + "catch (e) { ", + " responseJSON = {}; ", + " tests['response is valid JSON'] = false;", + "}", + "", + "", + "tests['response has PUT data'] = _.has(responseJSON, 'data');", + "tests['response matches the data sent in request'] = (responseJSON.data && responseJSON.data.length === 256);" + ] + } + } + ], + "request": { + "method": "DELETE", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": { + "mode": "raw", + "raw": "Donec fermentum, nisi sed cursus eleifend, nulla tortor ultricies tellus, ut vehicula orci arcu ut velit. In volutpat egestas dapibus.\nMorbi condimentum vestibulum sapien. Etiam dignissim diam quis eros lobortis gravida vel lobortis est. Etiam gravida sed." + }, + "url": "https://postman-echo.com/delete", + "description": "The HTTP `DELETE` method is used to delete resources on a server. The exact\nuse of `DELETE` requests depends on the server implementation. In general, \n`DELETE` requests support both, Query String parameters as well as a Request \nBody.\n\nThis endpoint accepts an HTTP `DELETE` request and provides debug information\nsuch as the HTTP headers, Query String arguments, and the Request Body." + }, + "response": [] + }, + { + "name": "POST File", + "event": [ + { + "listen": "test", + "script": { + "id": "7b0f13b2-d59b-43b4-91a0-e86ab040ac71", + "exec": [ + "" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data", + "type": "text" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "file", + "type": "file", + "src": "/some/path/file.txt" + } + ] + }, + "url": { + "raw": "https://postman-echo.com/post", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "post" + ] + }, + "description": "The HTTP `POST` request method is meant to transfer data to a server \n(and elicit a response). What data is returned depends on the implementation\nof the server.\n\nA `POST` request can pass parameters to the server using \"Query String \nParameters\", as well as the Request Body. For example, in the following request,\n\n> POST /hi/there?hand=wave\n>\n> \n\nThe parameter \"hand\" has the value \"wave\". The request body can be in multiple\nformats. These formats are defined by the MIME type of the request. The MIME \nType can be set using the ``Content-Type`` HTTP header. The most commonly used \nMIME types are:\n\n* `multipart/form-data`\n* `application/x-www-form-urlencoded`\n* `application/json`\n\nThis endpoint echoes the HTTP headers, request parameters, the contents of\nthe request body and the complete URI requested." + }, + "response": [] + }, + { + "name": "Post file in file mode", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "file", + "file": {} + }, + "url": { + "raw": "https://postman-echo.com/post", + "protocol": "https", + "host": [ + "postman-echo", + "com" + ], + "path": [ + "post" + ] + } + }, + "response": [] + }, + { + "name": "Request with Port and without path", + "request": { + "method": "GET", + "header": [], + "body": { + "mode": "raw", + "raw": "" + }, + "url": { + "raw": "localhost:5050", + "host": [ + "localhost" + ], + "port": "5050" + } + }, + "response": [] + }, + { + "name": "GET request with port and path param", + "request": { + "method": "GET", + "header": [], + "body": { + "mode": "raw", + "raw": "" + }, + "url": { + "raw": "localhost:5050/knockknock", + "host": [ + "localhost" + ], + "port": "5050", + "path": [ + "knockknock" + ] + } + }, + "response": [] + } + ], + "event": [ + { + "listen": "prerequest", + "script": { + "id": "e80b6162-6c90-4150-bfa1-7f42f11c8f64", + "type": "text/javascript", + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "id": "538efa04-97ce-456c-a5a1-772c466591d5", + "type": "text/javascript", + "exec": [ + "" + ] + } + } + ] +} \ No newline at end of file diff --git a/codegens/routeros-fetch/test/unit/converter.test.js b/codegens/routeros-fetch/test/unit/converter.test.js new file mode 100644 index 000000000..5f4c2c1f0 --- /dev/null +++ b/codegens/routeros-fetch/test/unit/converter.test.js @@ -0,0 +1,475 @@ +let testCollection = require('../resources/test-collection.json'), + expectedResults = require('../resources/expected-http-messages.json'), + errorCollection = require('../resources/error-collection.json'), + { convert } = require('../../index'), + { expect } = require('chai'), + _ = require('lodash'), + Request = require('postman-collection').Request, + requests = testCollection.item; + +describe('Converter test', function () { + _.forEach(requests, function (r, ind) { + let testRequest = new Request(r.request); + convert( + testRequest, + { style: 'plain', commentary: 'errors' }, + function (err, snippet) { + if (err) { + console.log(`${snippet}`); + console.log(testRequest); + console.log(''); + } + + it(`should generate appropriate http message for: ${r.name}`, function () { + expect(snippet).to.equal(expectedResults.result[ind]); + }); + } + ); + }); + + it('should parse the url correctly even if the host and path are wrong in the url object', function () { + var request = new Request({ + method: 'GET', + body: { + mode: 'raw', + raw: '' + }, + url: { + path: ['hello'], + host: ['https://example.com/path'], + query: [], + variable: [] + } + }); + convert( + request, + { style: 'plain', commentary: 'none' }, + function (error, snippet) { + if (error) { + expect.fail(null, null, error); + } + expect(snippet).to.be.a('string'); + expect(snippet).to.include('http-method=get'); + expect(snippet).to.include('url="https://example.com/hello'); + } + ); + }); + + it('should include graphql body in the snippet', function () { + var request = new Request({ + method: 'POST', + header: [], + body: { + mode: 'graphql', + graphql: { + query: '{ body { graphql } }', + variables: '{"variable_key": "variable_value"}' + } + }, + url: { + raw: 'http://postman-echo.com/post', + protocol: 'http', + host: ['postman-echo', 'com'], + path: ['post'] + } + }); + convert( + request, + { style: 'plain', commentary: 'none' }, + function (error, snippet) { + if (error) { + expect.fail(null, null, error); + } + expect(snippet).to.be.a('string'); + expect(snippet).to.include( + 'http-data="{\\"query\\":\\"{ body { graphql } }\\",' + ); + expect(snippet).to.include( + '\\"variables\\":{\\"variable_key\\":\\"variable_value\\"}}"' + ); + } + ); + }); + + it('should escape commas in one header', function () { + var request = new Request({ + method: 'GET', + header: [ + { + key: 'Commas', + value: 'a,1,2' + } + ], + url: { + raw: 'https://postman-echo.com/get', + protocol: 'https', + host: ['postman-echo', 'com'], + path: ['get'] + } + }); + convert( + request, + { style: 'plain', commentary: 'none' }, + function (error, snippet) { + if (error) { + expect.fail(null, null, error); + } + console.log(snippet); + expect(snippet).to.contain('a\\\\,1\\\\,2'); + } + ); + }); + + it('should NOT escape commas in one header', function () { + var request = new Request({ + method: 'GET', + header: [ + { + key: 'Commas', + value: 'a,1,2' + }, + { + key: 'More', + value: 'x,y,z' + + } + ], + url: { + raw: 'https://postman-echo.com/get', + protocol: 'https', + host: ['postman-echo', 'com'], + path: ['get'] + } + }); + convert( + request, + { style: 'plain', commentary: 'none' }, + function (error, snippet) { + if (error) { + expect.fail(null, null, error); + } + console.log(snippet); + expect(snippet).to.contain('a,1,2'); + expect(snippet).to.contain('x,y,z'); + } + ); + }); + + it('should generate snippets(not error out) for requests with no body', function () { + var request = new Request({ + method: 'GET', + header: [ + { + key: 'Content-Type', + value: 'text/plain' + } + ], + url: { + raw: 'https://postman-echo.com/get', + protocol: 'https', + host: ['postman-echo', 'com'], + path: ['get'] + } + }); + convert( + request, + { style: 'plain', commentary: 'none' }, + function (error, snippet) { + if (error) { + expect.fail(null, null, error); + } + expect(snippet).to.be.a('string'); + } + ); + }); + + it('should generate snippets(not error out) for requests with multiple/no file in formdata', function () { + var request = new Request({ + method: 'POST', + header: [], + body: { + mode: 'formdata', + formdata: [ + { + key: 'no file', + value: '', + type: 'file', + src: [] + }, + { + key: 'single file', + value: '', + type: 'file', + src: '/test1.txt' + }, + { + key: 'multiple files', + value: '', + type: 'file', + src: ['/test2.txt', '/test3.txt'] + }, + { + key: 'no src', + value: '', + type: 'file' + }, + { + key: 'invalid src', + value: '', + type: 'file', + src: {} + } + ] + }, + url: { + raw: 'https://postman-echo.com/post', + protocol: 'https', + host: ['postman-echo', 'com'], + path: ['post'] + } + }); + + convert( + request, + { style: 'plain', commentary: 'none' }, + function (error, snippet) { + if (error) { + expect.fail(null, null, error); + } + expect(snippet).to.be.a('string'); + expect(snippet).to.include('name=\\"single file\\"; filename=\\"test1.txt\\"'); + expect(snippet).to.include( + 'name=\\"multiple files\\"; filename=\\"test2.txt\\"' + ); + expect(snippet).to.include( + 'name=\\"multiple files\\"; filename=\\"test3.txt\\"' + ); + expect(snippet).to.include('name=\\"no file\\"; filename=\\"file\\"'); + expect(snippet).to.include('name=\\"no src\\"; filename=\\"file\\"'); + expect(snippet).to.include('name=\\"invalid src\\"; filename=\\"file\\"'); + } + ); + }); + + it('should generate valid snippet and should include appropriate variable name', function () { + var request = new Request({ + method: 'GET', + header: [], + body: {}, + url: 'https://postman-echo.com/:action' + }); + + convert( + request, + { style: 'plain', commentary: 'none' }, + function (error, snippet) { + if (error) { + expect.fail(null, null, error); + } + expect(snippet).to.be.a('string'); + expect(snippet).to.include(':action'); + } + ); + }); + + it('should generate a valid path even if the url contains unresolved variables', function () { + var request = new Request({ + method: 'GET', + url: { + host: ['{{variable}}'], + path: ['{{path}}'] + } + }); + + convert( + request, + { style: 'plain', commentary: 'none' }, + function (error, snippet) { + if (error) { + expect.fail(null, null, error); + } + expect(snippet).to.be.a('string'); + expect(snippet).to.include('url="http://{{variable}}/{{path}}"'); + } + ); + }); + + it('should add content type if formdata field contains a content-type', function () { + var request = new Request({ + method: 'POST', + body: { + mode: 'formdata', + formdata: [ + { + key: 'json', + value: '{"hello": "world"}', + contentType: 'application/json', + type: 'text' + } + ] + }, + url: { + raw: 'http://postman-echo.com/post', + host: ['postman-echo', 'com'], + path: ['post'] + } + }); + + convert( + request, + { style: 'plain', commentary: 'none' }, + function (error, snippet) { + if (error) { + expect.fail(null, null, error); + } + + expect(snippet).to.be.a('string'); + expect(snippet).to.contain('Content-Type: application/json'); + } + ); + }); + + it('should not add extra newlines if there is no body or header present', function () { + var request = new Request({ + method: 'GET', + url: { + host: ['example', 'com'] + } + }); + + convert( + request, + { style: 'plain', commentary: 'none' }, + function (error, snippet) { + if (error) { + expect.fail(null, null, error); + } + + expect(snippet).to.equal('/tool/fetch http-method=get url="http://example.com"'); + } + ); + }); +}); + +describe('Error request collection tests', function () { + _.forEach(errorCollection.item, function (r) { + let testRequest = new Request(r.request); + convert( + testRequest, + { style: 'plain', commentary: 'errors' }, + function (err, snippet) { + if (err) { + console.log(`${snippet}`); + console.log(testRequest); + console.log(''); + } + + it(`should generate appropriate http message for: ${r.name}`, function () { + expect(snippet).to.contain('PROBLEMS'); + }); + } + ); + }); +}); + + +describe('Verify commentary option', function () { + let testRequest = new Request(requests[7].request); + convert( + testRequest, + { style: 'plain', commentary: 'all' }, + function (err, snippet) { + if (err) { + console.log(`${snippet}`); + console.log(testRequest); + console.log(''); + } + it('should generate tip when commentary=all', function () { + expect(snippet).to.contain('TIP'); + }); + } + ); + convert( + testRequest, + { style: 'plain', commentary: 'errors' }, + function (err, snippet) { + if (err) { + console.log(`${snippet}`); + console.log(testRequest); + console.log(''); + } + it('should NOT generate tip when commentary=errors', function () { + expect(snippet).to.not.contain('TIP'); + }); + } + ); + convert( + testRequest, + { style: 'plain', commentary: 'none' }, + function (err, snippet) { + if (err) { + console.log(`${snippet}`); + console.log(testRequest); + console.log(''); + } + it('should NOT generate tip when commentary=none', function () { + expect(snippet).to.not.contain('TIP'); + }); + } + ); +}); + +describe('Converter test using style options', function () { + let requestModeRaw = requests[6], // request.body.mode: raw + requestModeFormData = requests[4], // request.body.mode: formdata + requestModeUrlEncoded = requests[7], // request.body.mode: urlencoded + testRequestModeRaw = new Request(requestModeRaw.request), + testRequestModeFormData = new Request(requestModeFormData.request), + testRequestModeUrlEncoded = new Request(requestModeUrlEncoded.request); + + [ 'plain', + 'outputToConsole', + 'outputToVariable', + 'outputToVariableWithHeaders', + 'outputToFile' + ].forEach((style) => { + convert( + testRequestModeRaw, + { style: style, commentary: 'all' }, + function (err, snippet) { + if (err) { + console.log('Something went wrong while converting the request'); + } + it('should generate appropriate http message using options.style: ' + + `${style} - ${requestModeRaw.name}`, function () { + expect(snippet).to.contain(expectedResults.result[6]); + }); + } + ); + convert(testRequestModeFormData, { style: style, commentary: 'all' }, function (err, snippet) { + if (err) { + console.log('Something went wrong while converting the request'); + } + it('should generate appropriate http message using options.style: ' + + `${style} - ${requestModeFormData.name}`, function () { + expect(snippet).to.contain(expectedResults.result[4]); + }); + }); + convert( + testRequestModeUrlEncoded, + { style: style, commentary: 'all' }, + function (err, snippet) { + if (err) { + console.log('Something went wrong while converting the request'); + } + it( + `should generate appropriate http message using options.style: ${style} - ` + + `${requestModeUrlEncoded.name}`, + function () { + expect(snippet).to.contain(expectedResults.result[7]); + } + ); + } + ); + }); +}); diff --git a/codegens/routeros-fetch/test/unit/package.test.js b/codegens/routeros-fetch/test/unit/package.test.js new file mode 100644 index 000000000..c02f5a7a6 --- /dev/null +++ b/codegens/routeros-fetch/test/unit/package.test.js @@ -0,0 +1,28 @@ +var expect = require('chai').expect, + path = require('path'), + package = require('../../package.json'); + +describe('package.json', function () { + + it('should have com_postman_plugin object with valid properties', function () { + expect(package).to.have.property('com_postman_plugin'); + expect(package.com_postman_plugin.type).to.equal('code_generator'); + expect(package.com_postman_plugin.lang).to.be.a('string'); + expect(package.com_postman_plugin.variant).to.be.a('string'); + expect(package.com_postman_plugin.syntax_mode).to.be.a('string'); + }); + + it('should have main property with relative path to object with convert property', function () { + var languageModule; expect(package.main).to.be.a('string'); + + try { + languageModule = require(path.resolve('.', package.main)); + } + catch (error) { + console.error(error); + } + expect(languageModule).to.be.a('object'); + expect(languageModule.convert).to.be.a('function'); + }); + +}); diff --git a/index.html b/index.html new file mode 100644 index 000000000..4750e813c --- /dev/null +++ b/index.html @@ -0,0 +1,285 @@ + + + + + + curl2rsc + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ +
+ +
+

Retired

+
+

At least the web interface for "curl2rsc" is being retired. The web-based conversion used a microservice hosted by Glitch. + However Glitch has closed its doors in July 2025, so TIKOCI's cURL to /tool/fetch converter does not work. Code remains, just no backend.

+
+

This page will render, however, no conversion is possible.

+
+
+ + +
+
+ Converts + curl + to a web service call on Mikrotik's RouterOS, via Postman's codegens. +
+

+ Most curl commands line options should work, and be converted to + RouterOS scripting commands. But not everything can be converted, such + as file operations. But a lot can! The tool will attempt to convert as + much as it can, even if not in complete fidelity with curl. So use + this page as guide, not a reference. +

+ + + +
+

+ + + +
+

+ Convert + curl + request to + /tool/fetch +

+ +
+
+ + + + +
+ +
+ +
+ +
+
+
+
+

+ +
+

Known Issues:

+
    +
  • + The backend service may go to "sleep", so an initial request may take up to 30 seconds to appear. + Future conversion requests should happen within a few seconds, as you type. +
    • +
  • While + --json + is valid in [modern] curl, it is not known the parser, so the content type + must be set using + -H 'Content-Type: application/json' + manually. +
    • +
  • RouterOS does not support handling 3xx redirects, so + -L and --location are ignored. +
    • +
+
+ +
+
+
* Disclaimer
+ This site is not affiliated, associated, authorized, endorsed + by, or in any way officially connected with + Mikrotik. All product and company + names are trademarks™ or registered® trademarks of their respective + holders. Use of them does not imply any affiliation with or + endorsement by them. +
+
+ +
+ + + + + + + diff --git a/lib/assets/languageLabels.json b/lib/assets/languageLabels.json index 8078f4d65..db4ba43b6 100644 --- a/lib/assets/languageLabels.json +++ b/lib/assets/languageLabels.json @@ -21,5 +21,6 @@ "shell": "Shell", "dart": "Dart", "r": "R", - "rust": "Rust" + "rust": "Rust", + "routeros": "RouterOS" } diff --git a/package.json b/package.json index cb23c862a..f7a7c9f37 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "postman-code-generators", - "version": "1.13.0", + "version": "1.13.2", "description": "Generates code snippets for a postman collection", "main": "index.js", "directories": { diff --git a/test/codegen/structure.test.js b/test/codegen/structure.test.js index 4553c829f..8ac8481af 100644 --- a/test/codegen/structure.test.js +++ b/test/codegen/structure.test.js @@ -94,6 +94,20 @@ const expectedOptions = { default: 'single', description: 'String denoting the quote type to use (single or double) for URL ' + '(Use double quotes when running curl in cmd.exe and single quotes for the rest)' + }, + style: { + name: 'Snippet output type', + type: 'enum', + default: 'plain', + description: + 'Control the flavor ("style") of generated snippets' + }, + commentary: { + name: 'Additional commentary', + type: 'enum', + default: 'all', + description: + 'Enables output of errors and tips' } }, // Standard array of ids that should be used for options ids. Any new option should be updated here. @@ -116,7 +130,8 @@ const expectedOptions = { 'asyncAwaitEnabled', 'quoteType', 'asyncType', - 'ignoreWarnings' + 'style', + 'commentary' ], CODEGEN_ABS_PATH = `./codegens/${codegen}`; describe('Code-gen repository ' + codegen, function () { @@ -260,7 +275,7 @@ describe('Code-gen repository ' + codegen, function () { }); }); - describe.skip('.eslintrc', function () { + describe('.eslintrc', function () { it('must exist', function (done) { fs.stat(`${CODEGEN_ABS_PATH}/.eslintrc`, done); });