@getjones/test-infra 2.1.2 → 2.1.4

package/package.json

@@ -1,29 +1,29 @@
-{
-  "name": "@getjones/test-infra",
-  "version": "2.1.2",
-  "description": "Providing internal and openapi interface",
-  "main": "src/index.js",
-  "scripts": {
-    "test": "mocha  \"./tests/**/*.test.js\" --slow 3000 --timeout 10000 --exit --inlineDiffs --bail",
-    "eslint-fix": "eslint \"./src/**/*.js\" --fix"
-  },
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "axios": "^0.21.1",
-    "axios-file": "^1.0.17",
-    "chai": "^4.3.4",
-    "dotenv": "^8.2.0",
-    "enum": "^3.0.4",
-    "mocha": "^8.3.2"
-  },
-  "devDependencies": {
-    "babel-eslint": "^10.0.3",
-    "eslint": "^6.8.0",
-    "eslint-plugin-import": "^2.19.1",
-    "mocha-spec-json-output-reporter": "^1.1.7"
-  },
-  "directories": {
-    "test": "tests"
-  }
-}
+{
+  "name": "@getjones/test-infra",
+  "version": "2.1.4",
+  "description": "Providing internal and openapi interface",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "mocha  \"./tests/**/*.test.js\" --slow 3000 --timeout 10000 --exit --inlineDiffs --bail",
+    "eslint-fix": "eslint \"./src/**/*.js\" --fix"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^0.21.1",
+    "axios-file": "^1.0.17",
+    "chai": "^4.3.4",
+    "dotenv": "^8.2.0",
+    "enum": "^3.0.4",
+    "mocha": "^8.3.2"
+  },
+  "devDependencies": {
+    "babel-eslint": "^10.0.3",
+    "eslint": "^6.8.0",
+    "eslint-plugin-import": "^2.19.1",
+    "mocha-spec-json-output-reporter": "^1.1.7"
+  },
+  "directories": {
+    "test": "tests"
+  }
+}

package/src/common/commonFlows/index.js

@@ -1,3 +1,3 @@
-const records = require('./records/records');
-
-module.exports = { records };
+const records = require('./records/records');
+
+module.exports = { records };

package/src/common/commonFlows/records/records.js

@@ -1,71 +1,71 @@
-const { expect } = require('chai');
-
-const threadScheduler = require('../../../saas/internal-api/thread-scheduler/runner');
-const timeUtils = require('../../utils/timeUtils');
-const httpResponseStatusCodes = require('../../../common/httpResponseStatusCodes.json');
-const contractors = require('../../../saas/internal-api/contractors');
-
-const makeRecordNotResponsive = async function(recordId, context, { isTenant } = {}) {
-	const dates = isTenant ?
-		timeUtils.getInvitationDatesForNotResponsiveTenant() :
-		timeUtils.getInvitationDatesForNotResponsiveVendor();
-
-	for (const date of dates) {
-		await updateInviteDate(recordId, date, context);
-	}
-};
-
-const updateInviteDate = async function(recordId, inviteDate, context) {
-	const updateResponse = await contractors.services.updateInviteDate(recordId, inviteDate, context);
-
-	if (updateResponse.status !== httpResponseStatusCodes.NO_CONTENT) {
-		throw new Error('Record invite date could not be updated', updateResponse);
-	}
-
-	const threadSchedulerResponse = await threadScheduler.runThreadScheduler({ contractorIds: [recordId] });
-
-	if (threadSchedulerResponse.status !== httpResponseStatusCodes.OK) {
-		throw new Error('Thread scheduler has failed to run', threadSchedulerResponse);
-	}
-
-	await timeUtils.waitFor(2.5).seconds; // calls for the same records can override each other
-};
-
-const runOverAllRenewalDatesForRecord = async function(recordId, policyName) {
-	const dates = timeUtils.getAutomaticRenewalsExpirationDates();
-
-	for (const date of dates) {
-		await updatePolicyExpiryDateForRecord(recordId, date, policyName);
-	}
-};
-
-const updatePolicyExpiryDateForRecord = async function(recordId, expiryDate, policyName) {
-	const updateResponse = await contractors.services.updateExpiryDate(recordId, expiryDate, policyName);
-
-	if (updateResponse.status !== httpResponseStatusCodes.NO_CONTENT) {
-		throw new Error('Record expiry date could not be updated', updateResponse);
-	}
-
-	const threadSchedulerResponse = await threadScheduler.runThreadScheduler({ contractorIds: [recordId] });
-
-	if (threadSchedulerResponse.status !== httpResponseStatusCodes.OK) {
-		throw new Error('Thread scheduler has failed to run', threadSchedulerResponse);
-	}
-
-	await timeUtils.waitFor(2.5).seconds; // calls for the same records can override each other
-};
-
-const getHistoryEvents = async function(recordId, context) {
-	const recordHistory = await contractors.services.getRecordHistory(recordId, context);
-	expect(recordHistory.status, 'Expected record history response status to equal 200.').to.equal(httpResponseStatusCodes.OK);
-
-	return recordHistory.data.map(item => item.itemTitle).reverse();
-};
-
-module.exports = {
-	makeRecordNotResponsive,
-	runOverAllRenewalDatesForRecord,
-	updateInviteDate,
-	updatePolicyExpiryDateForRecord,
-	getHistoryEvents
-};
+const { expect } = require('chai');
+
+const threadScheduler = require('../../../saas/internal-api/thread-scheduler/runner');
+const timeUtils = require('../../utils/timeUtils');
+const httpResponseStatusCodes = require('../../../common/httpResponseStatusCodes.json');
+const contractors = require('../../../saas/internal-api/contractors');
+
+const makeRecordNotResponsive = async function(recordId, context, { isTenant } = {}) {
+	const dates = isTenant ?
+		timeUtils.getInvitationDatesForNotResponsiveTenant() :
+		timeUtils.getInvitationDatesForNotResponsiveVendor();
+
+	for (const date of dates) {
+		await updateInviteDate(recordId, date, context);
+	}
+};
+
+const updateInviteDate = async function(recordId, inviteDate, context) {
+	const updateResponse = await contractors.services.updateInviteDate(recordId, inviteDate, context);
+
+	if (updateResponse.status !== httpResponseStatusCodes.NO_CONTENT) {
+		throw new Error('Record invite date could not be updated', updateResponse);
+	}
+
+	const threadSchedulerResponse = await threadScheduler.runThreadScheduler({ contractorIds: [recordId] });
+
+	if (threadSchedulerResponse.status !== httpResponseStatusCodes.OK) {
+		throw new Error('Thread scheduler has failed to run', threadSchedulerResponse);
+	}
+
+	await timeUtils.waitFor(2.5).seconds; // calls for the same records can override each other
+};
+
+const runOverAllRenewalDatesForRecord = async function(recordId, policyName) {
+	const dates = timeUtils.getAutomaticRenewalsExpirationDates();
+
+	for (const date of dates) {
+		await updatePolicyExpiryDateForRecord(recordId, date, policyName);
+	}
+};
+
+const updatePolicyExpiryDateForRecord = async function(recordId, expiryDate, policyName) {
+	const updateResponse = await contractors.services.updateExpiryDate(recordId, expiryDate, policyName);
+
+	if (updateResponse.status !== httpResponseStatusCodes.NO_CONTENT) {
+		throw new Error('Record expiry date could not be updated', updateResponse);
+	}
+
+	const threadSchedulerResponse = await threadScheduler.runThreadScheduler({ contractorIds: [recordId] });
+
+	if (threadSchedulerResponse.status !== httpResponseStatusCodes.OK) {
+		throw new Error('Thread scheduler has failed to run', threadSchedulerResponse);
+	}
+
+	await timeUtils.waitFor(2.5).seconds; // calls for the same records can override each other
+};
+
+const getHistoryEvents = async function(recordId, context) {
+	const recordHistory = await contractors.services.getRecordHistory(recordId, context);
+	expect(recordHistory.status, 'Expected record history response status to equal 200.').to.equal(httpResponseStatusCodes.OK);
+
+	return recordHistory.data.map(item => item.itemTitle).reverse();
+};
+
+module.exports = {
+	makeRecordNotResponsive,
+	runOverAllRenewalDatesForRecord,
+	updateInviteDate,
+	updatePolicyExpiryDateForRecord,
+	getHistoryEvents
+};

package/src/common/httpResponseStatusCodes.json

@@ -1,12 +1,12 @@
-{
-    "OK": 200,
-    "NO_CONTENT": 204,
-    "IM_USED": 226,
-    "BAD_REQUEST": 400,
-    "UNAUTHORIZED": 401,
-    "FORBIDDEN": 403,
-    "NOT_FOUND": 404,
-    "CONFLICT": 409,
-    "TOO_MANY_REQUESTS": 429,
-    "CLIENT_CLOSED_REQUEST": 499
+{
+    "OK": 200,
+    "NO_CONTENT": 204,
+    "IM_USED": 226,
+    "BAD_REQUEST": 400,
+    "UNAUTHORIZED": 401,
+    "FORBIDDEN": 403,
+    "NOT_FOUND": 404,
+    "CONFLICT": 409,
+    "TOO_MANY_REQUESTS": 429,
+    "CLIENT_CLOSED_REQUEST": 499
 }

package/src/common/requests/apiKeyAuth/requests.js

@@ -1,38 +1,38 @@
-const requestHandler = require('./../requestHandlers');
-
-const getRequestHandler = (url, apiKey, params = {}, headers = {}) => {
-	enrichApiKey(headers, apiKey);
-	return requestHandler.getRequestHandler(url, headers, params);
-};
-
-const postRequestHandler = (url, apiKey, body, headers = {}, params = {}) => {
-	enrichApiKey(headers, apiKey);
-	return requestHandler.postRequestHandler(url, body, headers, params);
-};
-
-const putRequestHandler = (url, apiKey, body, headers = {}, params = {}) => {
-	enrichApiKey(headers, apiKey);
-	return requestHandler.putRequestHandler(url, body, headers, params);
-};
-
-const patchRequestHandler = (url, apiKey, body, headers = {}) => {
-	enrichApiKey(headers, apiKey);
-	return requestHandler.patchRequestHandler(url, body, headers);
-};
-
-const deleteRequestHandler = (url, apiKey, headers = {}, params = {}, data = {}) => {
-	enrichApiKey(headers, apiKey);
-	return requestHandler.deleteRequestHandler(url, headers, params, data);
-};
-
-const enrichApiKey = (headers, apiKey) => {
-	headers['x-api-key'] = apiKey;
-};
-
-module.exports = {
-	getRequestHandler,
-	postRequestHandler,
-	putRequestHandler,
-	patchRequestHandler,
-	deleteRequestHandler
-};
+const requestHandler = require('./../requestHandlers');
+
+const getRequestHandler = (url, apiKey, params = {}, headers = {}) => {
+	enrichApiKey(headers, apiKey);
+	return requestHandler.getRequestHandler(url, headers, params);
+};
+
+const postRequestHandler = (url, apiKey, body, headers = {}, params = {}) => {
+	enrichApiKey(headers, apiKey);
+	return requestHandler.postRequestHandler(url, body, headers, params);
+};
+
+const putRequestHandler = (url, apiKey, body, headers = {}, params = {}) => {
+	enrichApiKey(headers, apiKey);
+	return requestHandler.putRequestHandler(url, body, headers, params);
+};
+
+const patchRequestHandler = (url, apiKey, body, headers = {}) => {
+	enrichApiKey(headers, apiKey);
+	return requestHandler.patchRequestHandler(url, body, headers);
+};
+
+const deleteRequestHandler = (url, apiKey, headers = {}, params = {}, data = {}) => {
+	enrichApiKey(headers, apiKey);
+	return requestHandler.deleteRequestHandler(url, headers, params, data);
+};
+
+const enrichApiKey = (headers, apiKey) => {
+	headers['x-api-key'] = apiKey;
+};
+
+module.exports = {
+	getRequestHandler,
+	postRequestHandler,
+	putRequestHandler,
+	patchRequestHandler,
+	deleteRequestHandler
+};

package/src/common/requests/cookieAuth/requests.js

@@ -1,40 +1,40 @@
-const requestHandler = require('./../requestHandlers');
-
-const getRequestHandler = (url, params = {}, context = null, headers = {}) => {
-	enrichCookie(headers, context);
-	return requestHandler.getRequestHandler(url, headers, params);
-};
-
-const postRequestHandler = (url, body, context = null, headers = {}, params = {}) => {
-	enrichCookie(headers, context);
-	return requestHandler.postRequestHandler(url, body, headers, params);
-};
-
-const putRequestHandler = (url, body, context = null, headers = {}, params = {}) => {
-	enrichCookie(headers, context);
-	return requestHandler.putRequestHandler(url, body, headers, params);
-};
-
-const patchRequestHandler = (url, context, body, headers = {}) => {
-	enrichCookie(headers, context);
-	return requestHandler.patchRequestHandler(url, body, headers);
-};
-
-const deleteRequestHandler = (url, context = null, headers = {}, params = {}, data = {}) => {
-	enrichCookie(headers, context);
-	return requestHandler.deleteRequestHandler(url, headers, params, data);
-};
-
-const enrichCookie = (headers, context) => {
-	if (context) {
-		headers.Cookie = context;
-	}
-};
-
-module.exports = {
-	getRequestHandler,
-	postRequestHandler,
-	putRequestHandler,
-	patchRequestHandler,
-	deleteRequestHandler
-};
+const requestHandler = require('./../requestHandlers');
+
+const getRequestHandler = (url, params = {}, context = null, headers = {}) => {
+	enrichCookie(headers, context);
+	return requestHandler.getRequestHandler(url, headers, params);
+};
+
+const postRequestHandler = (url, body, context = null, headers = {}, params = {}) => {
+	enrichCookie(headers, context);
+	return requestHandler.postRequestHandler(url, body, headers, params);
+};
+
+const putRequestHandler = (url, body, context = null, headers = {}, params = {}) => {
+	enrichCookie(headers, context);
+	return requestHandler.putRequestHandler(url, body, headers, params);
+};
+
+const patchRequestHandler = (url, context, body, headers = {}) => {
+	enrichCookie(headers, context);
+	return requestHandler.patchRequestHandler(url, body, headers);
+};
+
+const deleteRequestHandler = (url, context = null, headers = {}, params = {}, data = {}) => {
+	enrichCookie(headers, context);
+	return requestHandler.deleteRequestHandler(url, headers, params, data);
+};
+
+const enrichCookie = (headers, context) => {
+	if (context) {
+		headers.Cookie = context;
+	}
+};
+
+module.exports = {
+	getRequestHandler,
+	postRequestHandler,
+	putRequestHandler,
+	patchRequestHandler,
+	deleteRequestHandler
+};

package/src/common/requests/requestHandlers.js

@@ -1,60 +1,60 @@
-const axios = require('axios');
-const errorValidation = require('../validations/errorValidation');
-
-const getRequestHandler = async (url, headers = {}, params = {}) => {
-	try {
-		const response = await axios.get(url, { params, headers });
-		return response;
-	} catch (error) {
-		errorValidation.validateClientErrorResponseStatus(error);
-		return error.response;
-	}
-};
-
-const postRequestHandler = async (url, body, headers = {}, params = {}) => {
-	try {
-		const response = await axios.post(url, body, { headers, params });
-		return response;
-	} catch (error) {
-		errorValidation.validateClientErrorResponseStatus(error);
-		return error.response;
-	}
-};
-
-const putRequestHandler = async (url, body, headers = {}, params = {}) => {
-	try {
-		const response = await axios.put(url, body, { headers, params });
-		return response;
-	} catch (error) {
-		errorValidation.validateClientErrorResponseStatus(error);
-		return error.response;
-	}
-};
-
-const patchRequestHandler = async (url, body, headers = {}) => {
-	try {
-		const response = await axios.patch(url, body, { headers });
-		return response;
-	} catch (error) {
-		errorValidation.validateClientErrorResponseStatus(error);
-		return error.response;
-	}
-};
-
-const deleteRequestHandler = async (url, headers = {}, params = {}, data = {}) => {
-	try {
-		const response = await axios.delete(url, { params, headers, data });
-		return response;
-	} catch (error) {
-		errorValidation.validateClientErrorResponseStatus(error);
-		return error.response;
-	}
-};
-
-module.exports = {
-	getRequestHandler,
-	postRequestHandler,
-	putRequestHandler,
-	patchRequestHandler,
-	deleteRequestHandler
-};
+const axios = require('axios');
+const errorValidation = require('../validations/errorValidation');
+
+const getRequestHandler = async (url, headers = {}, params = {}) => {
+	try {
+		const response = await axios.get(url, { params, headers });
+		return response;
+	} catch (error) {
+		errorValidation.validateClientErrorResponseStatus(error);
+		return error.response;
+	}
+};
+
+const postRequestHandler = async (url, body, headers = {}, params = {}) => {
+	try {
+		const response = await axios.post(url, body, { headers, params });
+		return response;
+	} catch (error) {
+		errorValidation.validateClientErrorResponseStatus(error);
+		return error.response;
+	}
+};
+
+const putRequestHandler = async (url, body, headers = {}, params = {}) => {
+	try {
+		const response = await axios.put(url, body, { headers, params });
+		return response;
+	} catch (error) {
+		errorValidation.validateClientErrorResponseStatus(error);
+		return error.response;
+	}
+};
+
+const patchRequestHandler = async (url, body, headers = {}) => {
+	try {
+		const response = await axios.patch(url, body, { headers });
+		return response;
+	} catch (error) {
+		errorValidation.validateClientErrorResponseStatus(error);
+		return error.response;
+	}
+};
+
+const deleteRequestHandler = async (url, headers = {}, params = {}, data = {}) => {
+	try {
+		const response = await axios.delete(url, { params, headers, data });
+		return response;
+	} catch (error) {
+		errorValidation.validateClientErrorResponseStatus(error);
+		return error.response;
+	}
+};
+
+module.exports = {
+	getRequestHandler,
+	postRequestHandler,
+	putRequestHandler,
+	patchRequestHandler,
+	deleteRequestHandler
+};

package/src/common/utils/dataTypeUtils.js

@@ -0,0 +1,41 @@
+const dataTypes = Object.freeze({
+	object: 'object',
+	boolean: 'boolean',
+	string: 'string',
+	number: 'number'
+});
+
+const validateValueDataType = (value, type) => {
+	return value !== null
+		&& value !== undefined
+		&& typeof value === type;
+};
+
+const isObject = value => {
+	return validateValueDataType(value, dataTypes.object)
+		&& !isArray(value);
+};
+
+const isArray = value => {
+	return Array.isArray(value);
+};
+
+const isBoolean = value => {
+	return validateValueDataType(value, dataTypes.boolean);
+};
+
+const isString = value => {
+	return validateValueDataType(value, dataTypes.string) || value instanceof String;
+};
+
+const isNumber = value => {
+	return validateValueDataType(value, dataTypes.number) && Number.isFinite(value);
+};
+
+module.exports = {
+	isObject,
+	isArray,
+	isBoolean,
+	isString,
+	isNumber
+};

package/src/common/utils/numberUtils.js

@@ -1,22 +1,22 @@
-const { v4: uuidv4 } = require('uuid');
-
-const getRandomNumberInRange = (min, max) => {
-	min = Math.ceil(min);
-	max = Math.floor(max);
-	return Math.floor(Math.random() * (max - min + 1)) + min;
-};
-
-const getCapitalLetterUnicodeValueList = ({ listLength = 26 }) => {
-	//This code number represent the letter A
-	const firstLetterUnicodeValue = 65;
-	//Return list of unicodes values for all alphabet letters.
-	//The index value will be in the ranges between 1-26  (The English alphabet has 26 letters)
-	//In case listLength will be bigger then 26, index will start the cycle again respectively to the ranges
-	return Array.from(Array(listLength)).map((_, index) => (index % 26) + firstLetterUnicodeValue);
-};
-
-const getUniqueNumber = () => {
-	return uuidv4();
-};
-
-module.exports = { getRandomNumberInRange, getCapitalLetterUnicodeValueList, getUniqueNumber };
+const { v4: uuidv4 } = require('uuid');
+
+const getRandomNumberInRange = (min, max) => {
+	min = Math.ceil(min);
+	max = Math.floor(max);
+	return Math.floor(Math.random() * (max - min + 1)) + min;
+};
+
+const getCapitalLetterUnicodeValueList = ({ listLength = 26 }) => {
+	//This code number represent the letter A
+	const firstLetterUnicodeValue = 65;
+	//Return list of unicodes values for all alphabet letters.
+	//The index value will be in the ranges between 1-26  (The English alphabet has 26 letters)
+	//In case listLength will be bigger then 26, index will start the cycle again respectively to the ranges
+	return Array.from(Array(listLength)).map((_, index) => (index % 26) + firstLetterUnicodeValue);
+};
+
+const getUniqueNumber = () => {
+	return uuidv4();
+};
+
+module.exports = { getRandomNumberInRange, getCapitalLetterUnicodeValueList, getUniqueNumber };