@getjones/test-infra 1.9.0 → 1.11.0

package/package.json

@@ -1,29 +1,29 @@
-{
-  "name": "@getjones/test-infra",
-  "version": "1.9.0",
-  "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": "1.11.0",
+  "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/factory/index.js

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

package/src/common/factory/records/records.js

@@ -0,0 +1,45 @@
+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 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,
+	updateInviteDate,
+	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/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 };

package/src/common/utils/timeUtils.js

@@ -0,0 +1,147 @@
+const moment = require('moment');
+
+const secondsInDay = 86400;
+const millisecondsToSeconds = 1000;
+const formats = {
+	logTimeStampFormat: 'YYYY-MM-DD hh:mm:ss',
+	dayMonthYear: 'DD/MM/YYYY',
+	numericMonthDayYear: 'MM/DD/YYYY',
+	monthDayYear: 'MMM DD, YYYY',
+	monthDayYear_noZeroPrefix: 'MMM D, YYYY',
+	dateTime: 'YYYY/MM/DD-hh:mm:ss',
+	fullMonthDayYear: 'MMMM DD, YYYY',
+	threadScheduler: '', // Passing empty string resolves moment.js format to ISO8601 standard like 2020-04-12T09:49:59Z;
+	monthDayYear12hTime: 'MMM D, YYYY h:mm A',
+	amPmTime: 'h:mm A'
+};
+
+const peroids = {
+	days: 'days',
+	months: 'months',
+	years: 'years'
+};
+
+const getOneYearAgoDate = format => moment().utc().subtract(1, peroids.years).format(format || formats.threadScheduler);
+const getSixMonthAgoDate = format => moment().utc().subtract(6, peroids.months).format(format || formats.threadScheduler);
+const getOneMonthAgoDate = format => moment().utc().subtract(1, peroids.months).format(format || formats.threadScheduler);
+const getFifteenDaysAgoDate = format => moment().utc().subtract(15, peroids.days).format(format || formats.threadScheduler);
+const getTenDaysAgoDate = format => moment().utc().subtract(10, peroids.days).format(format || formats.threadScheduler);
+const getEightDaysAgoDate = format => moment().utc().subtract(8, peroids.days).format(format || formats.threadScheduler);
+const getFiveDaysAgoDate = format => moment().utc().subtract(5, peroids.days).format(format || formats.threadScheduler);
+const getTwoDaysAgoDate = format => moment().utc().subtract(2, peroids.days).format(format || formats.threadScheduler);
+const getOneDayAgoDate = format => moment().utc().subtract(1, peroids.days).format(format || formats.threadScheduler);
+const getThirtyFiveDaysAgoDate = format => moment().utc().subtract(35, peroids.days).format(format || formats.threadScheduler);
+const getCurrentDate = format => moment().utc().format(format || formats.threadScheduler);
+const getDateInOneDay = format => moment().utc().add(1, peroids.days).format(format || formats.threadScheduler);
+const getDateinSixDays = format => moment().utc().add(6, peroids.days).format(format || formats.threadScheduler);
+const getDateinThirteenDays = format => moment().utc().add(13, peroids.days).format(format || formats.threadScheduler);
+const getDateinTwentyNineDays = format => moment().utc().add(29, peroids.days).format(format || formats.threadScheduler);
+
+const getLogTimestamp = () => {
+	return moment().format(formats.logTimeStampFormat);
+};
+
+const getCurrentFormattedDate = () => {
+	return new Date().toISOString();
+};
+
+const getDateWithOffset = (date, offsetInDays) => {
+	date.setDate(date.getDate() + offsetInDays);
+	return date;
+};
+
+const getAuditDateFormat = date => {
+	const year = date.getUTCFullYear();
+	const month = date.getUTCMonth() + 1; //getMonth is zero-based
+	const day = date.getUTCDate();
+
+	return `${month}/${day}/${year}`;
+};
+
+const getYearMonthDayFormat = date => {
+	const year = date.getUTCFullYear();
+	const month = String(date.getUTCMonth() + 1).length === 1 ? `0${(date.getUTCMonth() + 1)}` : (date.getUTCMonth() + 1);
+	const day = String(date.getUTCDate()).length === 1 ? `0${date.getUTCDate()}` : date.getUTCDate();
+
+	return `${year}-${month}-${day}`;
+};
+
+const dateToIsoFormat = date => {
+	return new Date(date).toISOString();
+};
+
+const extractDateFromDateTime = date => {
+	let extractedDate = date;
+
+	if (date != null && date.length > 10) {
+		extractedDate = date.substr(0, 10);
+	}
+
+	return extractedDate;
+};
+
+function waitFor(num) {
+	return {
+		mSeconds: new Promise(resolve => {
+			setTimeout(resolve, num);
+		}),
+		seconds: new Promise(resolve => {
+			setTimeout(resolve, num * 1000);
+		})
+	};
+}
+
+function getDayInMilliseconds() {
+	return secondsInDay * millisecondsToSeconds;
+}
+
+function getPreviousDateByDays(days) {
+	return new Date(new Date().getTime() - getDayInMilliseconds() * days);
+}
+
+const getInvitationDatesForNotResponsiveVendor = function() {
+	const twoDaysAgoUtc = getTwoDaysAgoDate();
+	const fiveDaysAgoUtc = getFiveDaysAgoDate();
+	const eightDaysAgoUtc = getEightDaysAgoDate();
+
+	return [twoDaysAgoUtc, fiveDaysAgoUtc, eightDaysAgoUtc];
+};
+
+const getInvitationDatesForNotResponsiveTenant = function() {
+	const fiveDaysAgoUtc = getFiveDaysAgoDate();
+	const tenDaysAgoUtc = getTenDaysAgoDate();
+	const fifteenDaysAgoUtc = getFifteenDaysAgoDate();
+
+	return [fiveDaysAgoUtc, tenDaysAgoUtc, fifteenDaysAgoUtc];
+};
+
+module.exports = {
+	formats,
+	getOneYearAgoDate,
+	getSixMonthAgoDate,
+	getOneMonthAgoDate,
+	getFifteenDaysAgoDate,
+	getTenDaysAgoDate,
+	getEightDaysAgoDate,
+	getFiveDaysAgoDate,
+	getTwoDaysAgoDate,
+	getOneDayAgoDate,
+	getThirtyFiveDaysAgoDate,
+	getCurrentDate,
+	getDateInOneDay,
+	getDateinSixDays,
+	getDateinThirteenDays,
+	getDateinTwentyNineDays,
+	getInvitationDatesForNotResponsiveVendor,
+	getInvitationDatesForNotResponsiveTenant,
+	getLogTimestamp,
+	getCurrentFormattedDate,
+	getAuditDateFormat,
+	getDateWithOffset,
+	getYearMonthDayFormat,
+	dateToIsoFormat,
+	getDayInMilliseconds,
+	extractDateFromDateTime,
+	getPreviousDateByDays,
+	waitFor
+};

package/src/common/validations/errorValidation.js

@@ -1,16 +1,16 @@
-const httpResponseStatusCodes = require('../httpResponseStatusCodes.json');
-
-const validateClientErrorResponseStatus = error => {
-	if (!error.response || !isResponseStatusClientErrorCode(error.response.status)) {
-		throw error;
-	}
-};
-
-const isResponseStatusClientErrorCode = httpResponseStatusCode => {
-	const minClientErrorCode = httpResponseStatusCodes.BAD_REQUEST;
-	const maxClientErrorCode = httpResponseStatusCodes.CLIENT_CLOSED_REQUEST;
-
-	return httpResponseStatusCode >= minClientErrorCode && httpResponseStatusCode <= maxClientErrorCode;
-};
-
-module.exports = { validateClientErrorResponseStatus };
+const httpResponseStatusCodes = require('../httpResponseStatusCodes.json');
+
+const validateClientErrorResponseStatus = error => {
+	if (!error.response || !isResponseStatusClientErrorCode(error.response.status)) {
+		throw error;
+	}
+};
+
+const isResponseStatusClientErrorCode = httpResponseStatusCode => {
+	const minClientErrorCode = httpResponseStatusCodes.BAD_REQUEST;
+	const maxClientErrorCode = httpResponseStatusCodes.CLIENT_CLOSED_REQUEST;
+
+	return httpResponseStatusCode >= minClientErrorCode && httpResponseStatusCode <= maxClientErrorCode;
+};
+
+module.exports = { validateClientErrorResponseStatus };