phpunit tests converted to mocha/chai

tests/remote_js/config.js

@@ -0,0 +1,10 @@
+const fs = require('fs');
+
+var config = {};
+
+const data = fs.readFileSync('config.json');
+config = JSON.parse(data);
+config.timeout = 60000;
+config.numOwnedGroups = 3;
+config.numPublicGroups = 2;
+module.exports = config;

tests/remote_js/config.json

@@ -0,0 +1,35 @@
+{
+    "verbose": 1,
+    "syncURLPrefix": "http://dataserver/",
+    "apiURLPrefix": "http://localhost/",
+    "rootUsername": "YtTnrHcWUC0FqP27xuaa",
+    "rootPassword": "esFEIngwxnyp1kuTrUpKpH72gEftHbkiWneoeimV",
+    "awsRegion": "us-east-1",
+    "s3Bucket": "zotero",
+    "awsAccessKey": "",
+    "awsSecretKey": "",
+    "filesystemStorage": 1,
+    "syncVersion": 9,
+
+
+	"userID": 1,
+	"libraryID": 1,
+	"username": "testuser",
+	"password": "letmein",
+	"displayName": "testuser",
+	"emailPrimary": "[email protected]",
+	"emailSecondary": "[email protected]",
+	"ownedPrivateGroupID": 1,
+	"ownedPrivateGroupLibraryID": 1,
+	"ownedPrivateGroupName": "Test Group",
+
+
+	"userID2": 2,
+	"username2": "testuser2",
+	"password2": "letmein2",
+	"displayName2": "testuser2",
+	"ownedPrivateGroupID2": 0,
+	"ownedPrivateGroupLibraryID2": 0
+
+
+}

tests/remote_js/data/bad_string.xml

@@ -0,0 +1,6 @@
+<p> </p>
+<p style="margin-top: 0.18cm; margin-bottom: 0.18cm; line-height: 100%;" lang="es-ES"><br /><br /></p>
+<p style="margin-top: 0.18cm; margin-bottom: 0.18cm; line-height: 100%;" lang="es-ES"><br /><br /></p>
+<table border="1" cellspacing="0" cellpadding="7" width="614">
+<colgroup><col width="598"></col> </colgroup> 
+<p style="margin-top: 0.18cm; margin-bottom: 0.18cm;" lang="en-US"><span style="font-family: Times New Roman,serif;"><span style="font-size: x-large;"><strong>test</strong></span></span></p>

tests/remote_js/groupsSetup.js

@@ -0,0 +1,103 @@
+
+const config = require('./config');
+const API3 = require('./api3.js');
+
+const resetGroups = async () => {
+	let resetGroups = true;
+
+	let response = await API3.superGet(
+		`users/${config.userID}/groups`
+	);
+	let groups = await API3.getJSONFromResponse(response);
+	config.ownedPublicGroupID = null;
+	config.ownedPublicNoAnonymousGroupID = null;
+	config.ownedPrivateGroupID = null;
+	config.ownedPrivateGroupName = 'Private Test Group';
+	config.ownedPrivateGroupID2 = null;
+	let toDelete = [];
+	for (let group of groups) {
+		let data = group.data;
+		let id = data.id;
+		let type = data.type;
+		let owner = data.owner;
+		let libraryReading = data.libraryReading;
+
+		if (resetGroups) {
+			toDelete.push(id);
+			continue;
+		}
+
+		if (!config.ownedPublicGroupID
+			&& type == 'PublicOpen'
+			&& owner == config.userID
+			&& libraryReading == 'all') {
+			config.ownedPublicGroupID = id;
+		}
+		else if (!config.ownedPublicNoAnonymousGroupID
+			&& type == 'PublicClosed'
+			&& owner == config.userID
+			&& libraryReading == 'members') {
+			config.ownedPublicNoAnonymousGroupID = id;
+		}
+		else if (type == 'Private' && owner == config.userID && data.name == config.ownedPrivateGroupName) {
+			config.ownedPrivateGroupID = id;
+		}
+		else if (type == 'Private' && owner == config.userID2) {
+			config.ownedPrivateGroupID2 = id;
+		}
+		else {
+			toDelete.push(id);
+		}
+	}
+
+	if (!config.ownedPublicGroupID) {
+		config.ownedPublicGroupID = await API3.createGroup({
+			owner: config.userID,
+			type: 'PublicOpen',
+			libraryReading: 'all'
+		});
+	}
+	if (!config.ownedPublicNoAnonymousGroupID) {
+		config.ownedPublicNoAnonymousGroupID = await API3.createGroup({
+			owner: config.userID,
+			type: 'PublicClosed',
+			libraryReading: 'members'
+		});
+	}
+	if (!config.ownedPrivateGroupID) {
+		config.ownedPrivateGroupID = await API3.createGroup({
+			owner: config.userID,
+			name: "Private Test Group",
+			type: 'Private',
+			libraryReading: 'members',
+			fileEditing: 'members',
+			members: [
+				config.userID2
+			]
+		});
+	}
+	if (!config.ownedPrivateGroupID2) {
+		config.ownedPrivateGroupID2 = await API3.createGroup({
+			owner: config.userID2,
+			type: 'Private',
+			libraryReading: 'members',
+			fileEditing: 'members'
+		});
+	}
+	for (let groupID of toDelete) {
+		await API3.deleteGroup(groupID);
+	}
+
+	config.numOwnedGroups = 3;
+	config.numPublicGroups = 2;
+
+	for (let group of groups) {
+		if (!toDelete.includes(group.id)) {
+			await API3.groupClear(group.id);
+		}
+	}
+};
+
+module.exports = {
+	resetGroups
+};

tests/remote_js/helpers.js

@@ -0,0 +1,226 @@
+const { JSDOM } = require("jsdom");
+const chai = require('chai');
+const assert = chai.assert;
+const crypto = require('crypto');
+
+class Helpers {
+	static isV3 = false;
+
+	static useV3 = () => {
+		this.isV3 = true;
+	};
+
+	static uniqueToken = () => {
+		const id = crypto.randomBytes(16).toString("hex");
+		const hash = crypto.createHash('md5').update(id).digest('hex');
+		return hash;
+	};
+
+	static uniqueID = (count = 8) => {
+		const chars = ['A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'M', 'N', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Z'];
+		let result = "";
+		for (let i = 0; i < count; i++) {
+			result += chars[crypto.randomInt(chars.length)];
+		}
+		return result;
+	};
+
+	static namespaceResolver = (prefix) => {
+		let ns = {
+			atom: 'http://www.w3.org/2005/Atom',
+			zapi: 'http://zotero.org/ns/api',
+			zxfer: 'http://zotero.org/ns/transfer',
+			html: 'http://www.w3.org/1999/xhtml'
+		};
+		return ns[prefix] || null;
+	};
+
+	static xpathEval = (document, xpath, returnHtml = false, multiple = false, element = null) => {
+		const xpathData = document.evaluate(xpath, (element || document), this.namespaceResolver, 5, null);
+		if (!multiple && xpathData.snapshotLength != 1) {
+			throw new Error("No single xpath value fetched");
+		}
+		var node;
+		var result = [];
+		do {
+			node = xpathData.iterateNext();
+			if (node) {
+				result.push(node);
+			}
+		} while (node);
+
+		if (returnHtml) {
+			return multiple ? result : result[0];
+		}
+
+		return multiple ? result.map(el => el.innerHTML) : result[0].innerHTML;
+	};
+
+	static assertRegExp(exp, val) {
+		if (typeof exp == "string") {
+			exp = new RegExp(exp);
+		}
+		if (!exp.test(val)) {
+			throw new Error(`${val} does not match regular expression`);
+		}
+	}
+
+	static assertXMLEqual = (one, two) => {
+		const contentDom = new JSDOM(one);
+		const expectedDom = new JSDOM(two);
+		assert.equal(contentDom.window.document.innerHTML, expectedDom.window.document.innerHTML);
+	};
+
+	static assertStatusCode = (response, expectedCode, message) => {
+		try {
+			assert.equal(response.status, expectedCode);
+			if (message) {
+				assert.equal(response.data, message);
+			}
+		}
+		catch (e) {
+			console.log(response.data);
+			throw e;
+		}
+	};
+
+	static assertStatusForObject = (response, status, recordId, httpCode, message) => {
+		let body = response;
+		if (response.data) {
+			body = response.data;
+		}
+		try {
+			body = JSON.parse(body);
+		}
+		catch (e) { }
+		assert.include(['unchanged', 'failed', 'success'], status);
+
+		try {
+			//Make sure the recordId is in the right category - unchanged, failed, success
+			assert.property(body[status], recordId);
+			if (httpCode) {
+				assert.equal(body[status][recordId].code, httpCode);
+			}
+			if (message) {
+				assert.equal(body[status][recordId].message, message);
+			}
+		}
+		catch (e) {
+			console.log(response.data);
+			throw e;
+		}
+	};
+
+	static assertNumResults = (response, expectedResults) => {
+		const doc = new JSDOM(response.data, { url: "http://localhost/" });
+		const entries = this.xpathEval(doc.window.document, "//entry", false, true);
+		assert.equal(entries.length, expectedResults);
+	};
+
+	static assertTotalResults = (response, expectedResults) => {
+		const doc = new JSDOM(response.data, { url: "http://localhost/" });
+		const totalResults = this.xpathEval(doc.window.document, "//zapi:totalResults", false, true);
+		assert.equal(parseInt(totalResults[0]), expectedResults);
+	};
+
+	static assertContentType = (response, contentType) => {
+		assert.include(response?.headers['content-type'], contentType.toLowerCase());
+	};
+
+
+	//Assert codes
+	static assert200 = (response) => {
+		this.assertStatusCode(response, 200);
+	};
+
+	static assert201 = (response) => {
+		this.assertStatusCode(response, 201);
+	};
+
+	static assert204 = (response) => {
+		this.assertStatusCode(response, 204);
+	};
+
+	static assert300 = (response) => {
+		this.assertStatusCode(response, 300);
+	};
+
+	static assert302 = (response) => {
+		this.assertStatusCode(response, 302);
+	};
+
+	static assert400 = (response, message) => {
+		this.assertStatusCode(response, 400, message);
+	};
+
+	static assert401 = (response) => {
+		this.assertStatusCode(response, 401);
+	};
+
+	static assert403 = (response) => {
+		this.assertStatusCode(response, 403);
+	};
+
+	static assert412 = (response) => {
+		this.assertStatusCode(response, 412);
+	};
+
+	static assert428 = (response) => {
+		this.assertStatusCode(response, 428);
+	};
+
+	static assert404 = (response) => {
+		this.assertStatusCode(response, 404);
+	};
+
+	static assert405 = (response) => {
+		this.assertStatusCode(response, 405);
+	};
+
+	static assert500 = (response) => {
+		this.assertStatusCode(response, 500);
+	};
+
+	static assert400ForObject = (response, { index = 0, message = null } = {}) => {
+		this.assertStatusForObject(response, 'failed', index, 400, message);
+	};
+
+	static assert200ForObject = (response, { index = 0, message = null } = {}) => {
+		this.assertStatusForObject(response, 'success', index, message);
+	};
+
+	static assert404ForObject = (response, { index = 0, message = null } = {}) => {
+		this.assertStatusForObject(response, 'failed', index, 404, message);
+	};
+
+	static assert409ForObject = (response, { index = 0, message = null } = {}) => {
+		this.assertStatusForObject(response, 'failed', index, 409, message);
+	};
+
+	static assert412ForObject = (response, { index = 0, message = null } = {}) => {
+		this.assertStatusForObject(response, 'failed', index, 412, message);
+	};
+
+	static assert413ForObject = (response, { index = 0, message = null } = {}) => {
+		this.assertStatusForObject(response, 'failed', index, 413, message);
+	};
+
+	static assert428ForObject = (response, { index = 0, message = null } = {}) => {
+		this.assertStatusForObject(response, 'failed', index, 428, message);
+	};
+
+	static assertUnchangedForObject = (response, { index = 0, message = null } = {}) => {
+		this.assertStatusForObject(response, 'unchanged', index, null, message);
+	};
+
+	// Methods to help during conversion
+	static assertEquals = (one, two) => {
+		assert.equal(two, one);
+	};
+
+	static assertCount = (count, object) => {
+		assert.lengthOf(Object.keys(object), count);
+	};
+}
+
+module.exports = Helpers;