@loadmill/core 0.3.38 → 0.3.42

package/src/parameters/parameter-functions/crypto.ts

@@ -0,0 +1,55 @@
+const CryptoJS = require('crypto-js');
+
+import { PresentableError } from '@loadmill/universal/dist/errors';
+
+export const FORMATS = {
+  UTF8:  'utf-8',
+  HEX: 'hex'
+};
+
+export const HASH = {
+  SHA1: 'SHA1',
+  SHA256: 'SHA256',
+};
+
+export const toSha = (secret: string, alg: string, secretFormat: string) => {
+  try {
+    const hashFunction = toHashFunction(alg);
+    const hashed = hashFunction(toCryptoFormat(secret, secretFormat));
+    return hashed.toString(CryptoJS.enc.Hex);
+  } catch (_e) {
+    throw new PresentableError(`Can't digest ${secret}`);
+  }
+};
+
+export const toHMAC = (secret: string, alg: string, secretFormat: string, salt: string) => {
+  try {
+    const converted = toCryptoFormat(secret, secretFormat);
+    const hmaced = CryptoJS.algo.HMAC.create(CryptoJS.algo[(alg || HASH.SHA256)], converted);
+    salt && hmaced.update(salt);
+    const hashed = hmaced.finalize();
+    return hashed.toString(CryptoJS.enc.Hex);
+  } catch (_e) {
+    throw new PresentableError(`Can't digest ${secret}`);
+  }
+};
+
+const toHashFunction = (type) => {
+  switch (type) {
+  case HASH.SHA1:
+    return CryptoJS.SHA1;
+  case HASH.SHA256:
+  default:
+    return CryptoJS.SHA256;
+  }
+};
+
+const toCryptoFormat = (from, base) => {
+  switch (base) {
+  case FORMATS.HEX:
+    return CryptoJS.enc.Hex.parse(from);
+  case FORMATS.UTF8:
+  default:
+    return CryptoJS.enc.Utf8.parse(from);
+  }
+};

package/src/parameters/parameter-functions/textual-parameter-functions.ts

@@ -1,3 +1,9 @@
+import defaultTo = require('lodash/defaultTo');
+import isEmpty = require('lodash/isEmpty');
+import isEqual = require('lodash/isEqual');
+import uniqWith = require('lodash/uniqWith');
+import escapeRegExp = require('lodash/escapeRegExp');
+import isNaN = require('lodash/isNaN');
 
 import { RegexExtractor } from '../extractors/regex-extractor';
 import { CheerioExtractor } from '../extractors/cheerio-extractor';
@@ -9,21 +15,16 @@ import {
   pickRandom,
   RANDOM_SELECT_OPT,
 } from '../value-utils';
-import defaultTo = require('lodash/defaultTo');
-import isEmpty = require('lodash/isEmpty');
-import isEqual = require('lodash/isEqual');
-import uniqWith = require('lodash/uniqWith');
-import escapeRegExp = require('lodash/escapeRegExp');
-import isNaN = require('lodash/isNaN');
 import isUUID from 'validator/lib/isUUID';
 import * as uriUtils from '@loadmill/universal/dist/uri-utils';
 import { PresentableError } from '@loadmill/universal/dist/errors';
 import { nodeBtoa } from '@loadmill/universal/dist/string-utils';
 import { applyJSONSchema } from './json-schema';
+import { toSha, toHMAC, FORMATS, HASH } from './crypto';
 
 const MAX_NOW_LENGTH = 13; // max length UTC until 2286
 
-const nowParameterFunction = new BasicParameterFunction((length) =>{
+const nowParameterFunction = new BasicParameterFunction((length) => {
   const now = Date.now();
   if (length && +length > 0) {
     return ('' + now).substring(0, Math.min(+length, MAX_NOW_LENGTH));
@@ -205,6 +206,30 @@ export const textualParameterFunctions = {
     1
   ),
 
+  __sha1: new BasicParameterFunction(
+    (secret, secretFormat = FORMATS.UTF8) => toSha(secret, HASH.SHA1, secretFormat),
+    1,
+    2
+  ),
+
+  __sha256: new BasicParameterFunction(
+    (secret, secretFormat = FORMATS.UTF8) => toSha(secret, HASH.SHA256, secretFormat),
+    1,
+    2
+  ),
+
+  __hmacSha1: new BasicParameterFunction(
+    (secret, secretFormat = FORMATS.UTF8, salt = '') => toHMAC(secret, HASH.SHA1, secretFormat, salt),
+    1,
+    3
+  ),
+
+  __hmacSha256: new BasicParameterFunction(
+    (secret, secretFormat = FORMATS.UTF8, salt = '') => toHMAC(secret, HASH.SHA256, secretFormat, salt),
+    1,
+    3
+  ),
+
   __split_pick: new BasicParameterFunction(
     (str: string, delim: string, selection = '0') =>
       pick(selection, str.split(delim)),

package/src/request/index.ts

@@ -38,6 +38,7 @@ export class LoadmillRequest implements RequestLike {
   description?: string;
   delay?: number | string;
   postData?: RequestPostData;
+  postFormData?: PostFormData;
   cachePenetration?: CachePenetration;
 
   method: HttpMethod = 'GET';
@@ -77,6 +78,7 @@ export function createRequest(from: RequestLike): LoadmillRequest {
     extract,
     headers,
     postData,
+    postFormData,
     stopBefore,
     skipBefore,
     loop,
@@ -106,6 +108,10 @@ export function createRequest(from: RequestLike): LoadmillRequest {
     request.postData = { text, mimeType };
   }
 
+  if (postFormData) {
+    request.postFormData = postFormData;
+  }
+
   if (delay !== null && delay !== undefined) {
     request.delay = delay;
   }
@@ -346,6 +352,7 @@ export interface RequestLike {
   description?: string;
   delay?: number | string;
   postData?: RequestPostData;
+  postFormData?: PostFormData;
   extract?: Extractions | Extractions[];
   headers?: LoadmillHeaders | LoadmillHeaders[];
   expectedStatus?: HttpResponseStatus;
@@ -370,6 +377,19 @@ export type RequestPostData = {
   text: string;
 };
 
+export type PostFormData = PostFormDataEntry[];
+
+export type PostFormDataEntry = {
+  name: string;
+  value: string;
+  fileName?: string;
+};
+
+export enum BodyTypes {
+  POST_DATA = 'postData',
+  FORM_DATA = 'postFormData',
+}
+
 export type LoadmillHeaders = { [headerName: string]: string };
 
 export type Extractions = { [parameter: string]: Extraction };

package/test/har/is-har.spec.js

@@ -1,4 +1,5 @@
 const { expect } = require('chai');
+const { describe, it } = require('mocha');
 const { isHar } = require('../../dist/har');
 
 describe('har-utils isHar', () => {

package/test/multipart-form-data/form-data-utils.spec.ts

@@ -0,0 +1,121 @@
+const fs = require('fs');
+const path = require('path');
+import { suite, describe, it } from 'mocha';
+import { expect } from 'chai';
+
+import { PostFormData } from '../../src/request/index';
+import { Form, FormEntry, mapToMultipartFormData, multipartFormDataTextToPostFormData } from '../../src/multipart-form-data/form-data-utils';
+const multipartPostDataWithText = JSON.parse(fs.readFileSync(path.join(__dirname, './resources/multipart-form-data-file-text-content.json')));
+
+const { text } = multipartPostDataWithText;
+
+const params: FormEntry[] = [
+  {
+    'name': 'the_name_of_the_thing',
+    'contentType': 'application/vnd.mspowerpoint-sniffing.x-rar-compressed',
+    'fileName': 'some file name.ext',
+    'value': 'the_contents_of_the_file'
+  },
+  {
+    'name': 'entityId',
+    'value': '123456789123456789123456789'
+  },
+  {
+    'name': 'shouldDoStuff',
+    'value': 'true'
+  },
+  {
+    'name': 'content-transfer-encoding',
+    'value': 'quoted-printable'
+  },
+];
+
+suite('form-data-utils - multipart form data', () => {
+  describe('Form Class - manages and manipulates multipart form data', () => {
+    it('to string', () => {
+      const boundary = '------WebKitFormBoundary12345678ASDFGHJ';
+      // eslint-disable-next-line max-len
+      const expectedText = '--------WebKitFormBoundary12345678ASDFGHJ\r\nContent-Disposition: form-data; name="the_name_of_the_thing"; filename="some file name.ext"\r\ncontent-type: application/vnd.mspowerpoint-sniffing.x-rar-compressed\r\n\r\nthe_contents_of_the_file\r\n--------WebKitFormBoundary12345678ASDFGHJ\r\nContent-Disposition: form-data; name="entityId"\r\n\r\n123456789123456789123456789\r\n--------WebKitFormBoundary12345678ASDFGHJ\r\nContent-Disposition: form-data; name="shouldDoStuff"\r\n\r\ntrue\r\n--------WebKitFormBoundary12345678ASDFGHJ\r\nContent-Disposition: form-data; name="content-transfer-encoding"\r\n\r\nquoted-printable\r\n--------WebKitFormBoundary12345678ASDFGHJ--\r\n';
+      const form = new Form(params, boundary);
+      const result = form.toString();
+      expect(result).equals(expectedText);
+    });
+  });
+
+  describe('mapToMultipartFormData', () => {
+    it ('should convert HAR parameters to PostFormData', () => {
+      const requestUnderTest = { postData: { params } } as { postData?: { params?, text?, mimeType? }, postFormData?: PostFormData };
+      const expectedResult = {
+        postFormData: [
+          {
+            name: 'the_name_of_the_thing',
+            value: '',
+            fileName: 'some file name.ext',
+          },
+          {
+            name: 'entityId',
+            value: '123456789123456789123456789'
+          },
+          {
+            name: 'shouldDoStuff',
+            value: 'true'
+          },
+          {
+            name: 'content-transfer-encoding',
+            value: 'quoted-printable'
+          },
+        ]
+      };
+      mapToMultipartFormData(requestUnderTest); // mutate request under test
+      expect(requestUnderTest.postFormData).to.have.deep.ordered.members(expectedResult.postFormData);
+    });
+    it ('should convert HAR multipart/form-data body TEXT to PostFormData', () => {
+      const requestUnderTest = { postData: { text } } as { postData?: { params?, text?, mimeType? }, postFormData?: PostFormData };
+      const expectedResult = {
+        postFormData: [
+          {
+            name: 'file',
+            value: '',
+            fileName: 'silk_sonic.jpeg',
+          },
+        ]
+      };
+      mapToMultipartFormData(requestUnderTest); // mutate request under test
+      expect(requestUnderTest.postFormData).to.have.deep.ordered.members(expectedResult.postFormData);
+    });
+  });
+
+  describe('multipartFormDataTextToPostFormData', () => {
+    it('should return empty array when text is empty', () => {
+      const result = multipartFormDataTextToPostFormData('');
+      expect(result).to.have.deep.ordered.members([]);
+    });
+
+    it('should return name-value', () => {
+      const text = '----10453916712809342873442003634\r\nContent-Disposition: form-data; name="arnon"\r\n\r\npeleg\r\n----10453916712809342873442003634--\r\n';
+      const result = multipartFormDataTextToPostFormData(text);
+      expect(result).to.have.deep.ordered.members([{ name: 'arnon', value: 'peleg' }]);
+    });
+
+    it('should return 2 name-values', () => {
+      // eslint-disable-next-line max-len
+      const text = '----10453916712\r\nContent-Disposition: form-data; name="arnon"\r\n\r\npeleg\r\n----10453916712\r\nContent-Disposition: form-data; name="rivi"\r\n\r\nshimi\r\n----10453916712--\r\n';
+      const result = multipartFormDataTextToPostFormData(text);
+      expect(result).to.have.deep.ordered.members([{ name: 'arnon', value: 'peleg' }, { name: 'rivi', value: 'shimi' }]);
+    });
+
+    it('should return name-value-filename', () => {
+      // eslint-disable-next-line max-len
+      const text = '-----------------------------10453916712809342873442003634\r\nContent-Disposition: form-data; name="file"; filename="silk_sonic.jpeg"\r\nContent-Type: image/jpeg\r\n\r\nXCXCXCXCXCXCXCXCXCXCXCXCXCXC\t\r\n\t \n\n\nXXC101010101010101101010101010\r\n-----------------------------10453916712809342873442003634--\r\n';
+      const result = multipartFormDataTextToPostFormData(text);
+      expect(result).to.have.deep.ordered.members([
+        {
+          name: 'file',
+          value: '',
+          fileName: 'silk_sonic.jpeg'
+        }
+      ]);
+    });
+  });
+
+});

package/test/multipart-form-data/resources/multipart-form-data-file-text-content.json

@@ -0,0 +1,5 @@
+{
+  "mimeType": "multipart/form-data; boundary=---------------------------10453916712809342873442003634",
+  "params": [],
+  "text": "-----------------------------10453916712809342873442003634\r\nContent-Disposition: form-data; name=\"file\"; filename=\"silk_sonic.jpeg\"\r\nContent-Type: image/jpeg\r\n\r\nÿØÿà\u0000\u0010JFIF\u0000\u0001\u0001\u0000\u0000\u0001\u0000\u0001\u0000\u0000ÿÛ\u0000„\u0000\u0005\u0003\u0004\t\t\b\t\t\t\t\t\t\t\t\t\u0005u001c\u0017\t\b\u001a\t\t\u0006\u0018!\u0018\u001a\u001d\u001d\u001f\u001f\u001f\u0007\u000b\"\u0018\"\u001e\u0018\u001c\u001e\u001f\u001e\u0001\u0005\u0005\u0005\b\u0007\b\u000e\b\b\r\u0012\r\u000e\r\u0012\u0012\u0012\u0012\u0012\u0012\u0012\u0012\u0012\u0012\u0012\u0012\u0012\u0012\u0012\u0012\u0012\u0012\u0012\u0012\u0012\u0012R#B?\u00005Ù\r\n-----------------------------10453916712809342873442003634--\r\n"
+}

package/test/parameters/parameter-functions.spec.js

@@ -1,4 +1,6 @@
 const { expect } = require('chai');
+const { describe, it } = require('mocha');
+
 require('../../dist/parameters');
 const { canHaveNullParameterValue } = require('../../dist/parameters/parameter-functions/parameter-functions');
 

package/test/parameters/parameter-utils.spec.js

@@ -1,4 +1,5 @@
 const { expect } = require('chai');
+const { describe, it } = require('mocha');
 
 const { parameterUtils, ParameterError } = require('../../dist/parameters');
 const _ = require('lodash');
@@ -180,4 +181,5 @@ describe('parameter utils', () => {
       expect(res).to.have.ordered.members([]);
     });
   });
+
 });

package/tsconfig.json

@@ -3,7 +3,7 @@
   "compilerOptions": {
     "noEmitHelpers": false,
     "outDir": "dist",
-    "declaration": true,
+    "declaration": true
   },
   "include": ["src"]
 }