/* * ACHTUNG: there is a copied & modified version of this file in * /src/tests/container/specs/api/pad.js * * TODO: unify those two files, and merge in a single one. */ const async = require('async'); const common = require('../../common'); const settings = require('../../../../node/utils/Settings'); const supertest = require('supertest'); const api = supertest(`http://${settings.ip}:${settings.port}`); const apiKey = common.apiKey; let apiVersion = 1; const testPadId = makeid(); let lastEdited = ''; const text = generateLongText(); /* * Html document with nested lists of different types, to test its import and * verify it is exported back correctly */ const ulHtml = '

one
two
0
1
2
- 3
- 4

item
1. item1
2. item2

'; /* * When exported back, Etherpad produces an html which is not exactly the same * textually, but at least it remains standard compliant and has an equal DOM * structure. */ const expectedHtml = '

one
two
0
1
2
- 3
- 4

item
1. item1
2. item2

'; /* * Html document with space between list items, to test its import and * verify it is exported back correctly */ const ulSpaceHtml = '

one

'; /* * When exported back, Etherpad produces an html which is not exactly the same * textually, but at least it remains standard compliant and has an equal DOM * structure. */ const expectedSpaceHtml = '

one

'; describe(__filename, function () { describe('Connectivity', function () { it('can connect', function (done) { api.get('/api/') .expect('Content-Type', /json/) .expect(200, done); }); }); describe('API Versioning', function () { it('finds the version tag', function (done) { api.get('/api/') .expect((res) => { apiVersion = res.body.currentVersion; if (!res.body.currentVersion) throw new Error('No version set in API'); return; }) .expect(200, done); }); }); describe('Permission', function () { it('errors with invalid APIKey', function (done) { // This is broken because Etherpad doesn't handle HTTP codes properly see #2343 // If your APIKey is password you deserve to fail all tests anyway const permErrorURL = `/api/${apiVersion}/createPad?apikey=password&padID=test`; api.get(permErrorURL) .expect(401, done); }); }); /* Pad Tests Order of execution -> deletePad -- This gives us a guaranteed clear environment -> createPad -> getRevisions -- Should be 0 -> getSavedRevisionsCount(padID) -- Should be 0 -> listSavedRevisions(padID) -- Should be an empty array -> getHTML -- Should be the default pad text in HTML format -> deletePad -- Should just delete a pad -> getHTML -- Should return an error -> createPad(withText) -> getText -- Should have the text specified above as the pad text -> setText -> getText -- Should be the text set before -> getRevisions -- Should be 0 still? -> saveRevision -> getSavedRevisionsCount(padID) -- Should be 0 still? -> listSavedRevisions(padID) -- Should be an empty array still ? -> padUsersCount -- Should be 0 -> getReadOnlyId -- Should be a value -> listAuthorsOfPad(padID) -- should be empty array? -> getLastEdited(padID) -- Should be when pad was made -> setText(padId) -> getLastEdited(padID) -- Should be when setText was performed -> padUsers(padID) -- Should be when setText was performed -> setText(padId, "hello world") -> getLastEdited(padID) -- Should be when pad was made -> getText(padId) -- Should be "hello world" -> movePad(padID, newPadId) -- Should provide consistent pad data -> getText(newPadId) -- Should be "hello world" -> movePad(newPadID, originalPadId) -- Should provide consistent pad data -> getText(originalPadId) -- Should be "hello world" -> getLastEdited(padID) -- Should not be 0 -> appendText(padID, "hello") -> getText(padID) -- Should be "hello worldhello" -> setHTML(padID) -- Should fail on invalid HTML -> setHTML(padID) *3 -- Should fail on invalid HTML -> getHTML(padID) -- Should return HTML close to posted HTML -> createPad -- Tries to create pads with bad url characters */ describe('deletePad', function () { it('deletes a Pad', function (done) { api.get(`${endPoint('deletePad')}&padID=${testPadId}`) .expect('Content-Type', /json/) .expect(200, done); // @TODO: we shouldn't expect 200 here since the pad may not exist }); }); describe('createPad', function () { it('creates a new Pad', function (done) { api.get(`${endPoint('createPad')}&padID=${testPadId}`) .expect((res) => { if (res.body.code !== 0) throw new Error('Unable to create new Pad'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getRevisionsCount', function () { it('gets revision count of Pad', function (done) { api.get(`${endPoint('getRevisionsCount')}&padID=${testPadId}`) .expect((res) => { if (res.body.code !== 0) throw new Error('Unable to get Revision Count'); if (res.body.data.revisions !== 0) throw new Error('Incorrect Revision Count'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getSavedRevisionsCount', function () { it('gets saved revisions count of Pad', function (done) { api.get(`${endPoint('getSavedRevisionsCount')}&padID=${testPadId}`) .expect((res) => { if (res.body.code !== 0) throw new Error('Unable to get Saved Revisions Count'); if (res.body.data.savedRevisions !== 0) throw new Error('Incorrect Saved Revisions Count'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('listSavedRevisions', function () { it('gets saved revision list of Pad', function (done) { api.get(`${endPoint('listSavedRevisions')}&padID=${testPadId}`) .expect((res) => { if (res.body.code !== 0) throw new Error('Unable to get Saved Revisions List'); if (!res.body.data.savedRevisions.equals([])) throw new Error('Incorrect Saved Revisions List'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getHTML', function () { it('get the HTML of Pad', function (done) { api.get(`${endPoint('getHTML')}&padID=${testPadId}`) .expect((res) => { if (res.body.data.html.length <= 1) throw new Error('Unable to get the HTML'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('listAllPads', function () { it('list all pads', function (done) { api.get(endPoint('listAllPads')) .expect((res) => { if (res.body.data.padIDs.includes(testPadId) !== true) { throw new Error('Unable to find pad in pad list'); } }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('deletePad', function () { it('deletes a Pad', function (done) { api.get(`${endPoint('deletePad')}&padID=${testPadId}`) .expect((res) => { if (res.body.code !== 0) throw new Error('Pad Deletion failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('listAllPads', function () { it('list all pads', function (done) { api.get(endPoint('listAllPads')) .expect((res) => { if (res.body.data.padIDs.includes(testPadId) !== false) { throw new Error('Test pad should not be in pads list'); } }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getHTML', function () { it('get the HTML of a Pad -- Should return a failure', function (done) { api.get(`${endPoint('getHTML')}&padID=${testPadId}`) .expect((res) => { if (res.body.code !== 1) throw new Error('Pad deletion failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('createPad', function () { it('creates a new Pad with text', function (done) { api.get(`${endPoint('createPad')}&padID=${testPadId}&text=testText`) .expect((res) => { if (res.body.code !== 0) throw new Error('Pad Creation failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getText', function () { it('gets the Pad text and expect it to be testText with \n which is a line break', function (done) { api.get(`${endPoint('getText')}&padID=${testPadId}`) .expect((res) => { if (res.body.data.text !== 'testText\n') throw new Error('Pad Creation with text'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('setText', function () { it('creates a new Pad with text', function (done) { api.post(endPoint('setText')) .send({ padID: testPadId, text: 'testTextTwo', }) .expect((res) => { if (res.body.code !== 0) throw new Error('Pad setting text failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getText', function () { it('gets the Pad text', function (done) { api.get(`${endPoint('getText')}&padID=${testPadId}`) .expect((res) => { if (res.body.data.text !== 'testTextTwo\n') throw new Error('Setting Text'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getRevisionsCount', function () { it('gets Revision Count of a Pad', function (done) { api.get(`${endPoint('getRevisionsCount')}&padID=${testPadId}`) .expect((res) => { if (res.body.data.revisions !== 1) throw new Error('Unable to get text revision count'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('saveRevision', function () { it('saves Revision', function (done) { api.get(`${endPoint('saveRevision')}&padID=${testPadId}`) .expect((res) => { if (res.body.code !== 0) throw new Error('Unable to save Revision'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getSavedRevisionsCount', function () { it('gets saved revisions count of Pad', function (done) { api.get(`${endPoint('getSavedRevisionsCount')}&padID=${testPadId}`) .expect((res) => { if (res.body.code !== 0) throw new Error('Unable to get Saved Revisions Count'); if (res.body.data.savedRevisions !== 1) throw new Error('Incorrect Saved Revisions Count'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('listSavedRevisions', function () { it('gets saved revision list of Pad', function (done) { api.get(`${endPoint('listSavedRevisions')}&padID=${testPadId}`) .expect((res) => { if (res.body.code !== 0) throw new Error('Unable to get Saved Revisions List'); if (!res.body.data.savedRevisions.equals([1])) throw new Error('Incorrect Saved Revisions List'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('padUsersCount', function () { it('gets User Count of a Pad', function (done) { api.get(`${endPoint('padUsersCount')}&padID=${testPadId}`) .expect((res) => { if (res.body.data.padUsersCount !== 0) throw new Error('Incorrect Pad User count'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getReadOnlyID', function () { it('Gets the Read Only ID of a Pad', function (done) { api.get(`${endPoint('getReadOnlyID')}&padID=${testPadId}`) .expect((res) => { if (!res.body.data.readOnlyID) throw new Error('No Read Only ID for Pad'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('listAuthorsOfPad', function () { it('Get Authors of the Pad', function (done) { api.get(`${endPoint('listAuthorsOfPad')}&padID=${testPadId}`) .expect((res) => { if (res.body.data.authorIDs.length !== 0) throw new Error('# of Authors of pad is not 0'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getLastEdited', function () { it('Get When Pad was left Edited', function (done) { api.get(`${endPoint('getLastEdited')}&padID=${testPadId}`) .expect((res) => { if (!res.body.data.lastEdited) { throw new Error('# of Authors of pad is not 0'); } else { lastEdited = res.body.data.lastEdited; } }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('setText', function () { it('creates a new Pad with text', function (done) { api.post(endPoint('setText')) .send({ padID: testPadId, text: 'testTextTwo', }) .expect((res) => { if (res.body.code !== 0) throw new Error('Pad setting text failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getLastEdited', function () { it('Get When Pad was left Edited', function (done) { api.get(`${endPoint('getLastEdited')}&padID=${testPadId}`) .expect((res) => { if (res.body.data.lastEdited <= lastEdited) { throw new Error('Editing A Pad is not updating when it was last edited'); } }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('padUsers', function () { it('gets User Count of a Pad', function (done) { api.get(`${endPoint('padUsers')}&padID=${testPadId}`) .expect((res) => { if (res.body.data.padUsers.length !== 0) throw new Error('Incorrect Pad Users'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('deletePad', function () { it('deletes a Pad', function (done) { api.get(`${endPoint('deletePad')}&padID=${testPadId}`) .expect((res) => { if (res.body.code !== 0) throw new Error('Pad Deletion failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); const originalPadId = testPadId; const newPadId = makeid(); const copiedPadId = makeid(); describe('createPad', function () { it('creates a new Pad with text', function (done) { api.get(`${endPoint('createPad')}&padID=${testPadId}`) .expect((res) => { if (res.body.code !== 0) throw new Error('Pad Creation failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('setText', function () { it('Sets text on a pad Id', function (done) { api.post(`${endPoint('setText')}&padID=${testPadId}`) .field({text}) .expect((res) => { if (res.body.code !== 0) throw new Error('Pad Set Text failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getText', function () { it('Gets text on a pad Id', function (done) { api.get(`${endPoint('getText')}&padID=${testPadId}`) .expect((res) => { if (res.body.code !== 0) throw new Error('Pad Get Text failed'); if (res.body.data.text !== `${text}\n`) throw new Error('Pad Text not set properly'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('setText', function () { it('Sets text on a pad Id including an explicit newline', function (done) { api.post(`${endPoint('setText')}&padID=${testPadId}`) .field({text: `${text}\n`}) .expect((res) => { if (res.body.code !== 0) throw new Error('Pad Set Text failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getText', function () { it("Gets text on a pad Id and doesn't have an excess newline", function (done) { api.get(`${endPoint('getText')}&padID=${testPadId}`) .expect((res) => { if (res.body.code !== 0) throw new Error('Pad Get Text failed'); if (res.body.data.text !== `${text}\n`) throw new Error('Pad Text not set properly'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getLastEdited', function () { it('Gets when pad was last edited', function (done) { api.get(`${endPoint('getLastEdited')}&padID=${testPadId}`) .expect((res) => { if (res.body.lastEdited === 0) throw new Error('Get Last Edited Failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('movePad', function () { it('Move a Pad to a different Pad ID', function (done) { api.get(`${endPoint('movePad')}&sourceID=${testPadId}&destinationID=${newPadId}&force=true`) .expect((res) => { if (res.body.code !== 0) throw new Error('Moving Pad Failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getText', function () { it('Gets text on a pad Id', function (done) { api.get(`${endPoint('getText')}&padID=${newPadId}`) .expect((res) => { if (res.body.data.text !== `${text}\n`) throw new Error('Pad Get Text failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('movePad', function () { it('Move a Pad to a different Pad ID', function (done) { api.get(`${endPoint('movePad')}&sourceID=${newPadId}&destinationID=${testPadId}&force=false`) .expect((res) => { if (res.body.code !== 0) throw new Error('Moving Pad Failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getText', function () { it('Gets text on a pad Id', function (done) { api.get(`${endPoint('getText')}&padID=${testPadId}`) .expect((res) => { if (res.body.data.text !== `${text}\n`) throw new Error('Pad Get Text failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getLastEdited', function () { it('Gets when pad was last edited', function (done) { api.get(`${endPoint('getLastEdited')}&padID=${testPadId}`) .expect((res) => { if (res.body.lastEdited === 0) throw new Error('Get Last Edited Failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('appendText', function () { it('Append text to a pad Id', function (done) { api.get(`${endPoint('appendText', '1.2.13')}&padID=${testPadId}&text=hello`) .expect((res) => { if (res.body.code !== 0) throw new Error('Pad Append Text failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getText', function () { it('Gets text on a pad Id', function (done) { api.get(`${endPoint('getText')}&padID=${testPadId}`) .expect((res) => { if (res.body.code !== 0) throw new Error('Pad Get Text failed'); if (res.body.data.text !== `${text}hello\n`) throw new Error('Pad Text not set properly'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('setHTML', function () { it('Sets the HTML of a Pad attempting to pass ugly HTML', function (done) { const html = '

Hello HTML

'; api.post(endPoint('setHTML')) .send({ padID: testPadId, html, }) .expect((res) => { if (res.body.code !== 0) throw new Error("Crappy HTML Can't be Imported[we weren't able to sanitize it']"); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('setHTML', function () { it('Sets the HTML of a Pad with complex nested lists of different types', function (done) { api.post(endPoint('setHTML')) .send({ padID: testPadId, html: ulHtml, }) .expect((res) => { if (res.body.code !== 0) throw new Error('List HTML cant be imported'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getHTML', function () { it('Gets back the HTML of a Pad with complex nested lists of different types', function (done) { api.get(`${endPoint('getHTML')}&padID=${testPadId}`) .expect((res) => { const receivedHtml = res.body.data.html.replace('
', '').toLowerCase(); if (receivedHtml !== expectedHtml) { throw new Error(`HTML received from export is not the one we were expecting. Received: ${receivedHtml} Expected: ${expectedHtml} Which is a slightly modified version of the originally imported one: ${ulHtml}`); } }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('setHTML', function () { it('Sets the HTML of a Pad with white space between list items', function (done) { api.get(`${endPoint('setHTML')}&padID=${testPadId}&html=${ulSpaceHtml}`) .expect((res) => { if (res.body.code !== 0) throw new Error('List HTML cant be imported'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('getHTML', function () { it('Gets back the HTML of a Pad with complex nested lists of different types', function (done) { api.get(`${endPoint('getHTML')}&padID=${testPadId}`) .expect((res) => { const receivedHtml = res.body.data.html.replace('
', '').toLowerCase(); if (receivedHtml !== expectedSpaceHtml) { throw new Error(`HTML received from export is not the one we were expecting. Received: ${receivedHtml} Expected: ${expectedSpaceHtml} Which is a slightly modified version of the originally imported one: ${ulSpaceHtml}`); } }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('createPad', function () { it('errors if pad can be created', function (done) { const badUrlChars = ['/', '%23', '%3F', '%26']; async.map( badUrlChars, (badUrlChar, cb) => { api.get(`${endPoint('createPad')}&padID=${badUrlChar}`) .expect((res) => { if (res.body.code !== 1) throw new Error('Pad with bad characters was created'); }) .expect('Content-Type', /json/) .end(cb); }, done); }); }); describe('copyPad', function () { it('copies the content of a existent pad', function (done) { api.get(`${endPoint('copyPad')}&sourceID=${testPadId}&destinationID=${copiedPadId}&force=true`) .expect((res) => { if (res.body.code !== 0) throw new Error('Copy Pad Failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); }); describe('copyPadWithoutHistory', function () { const sourcePadId = makeid(); let newPad; before(function (done) { createNewPadWithHtml(sourcePadId, ulHtml, done); }); beforeEach(function () { newPad = makeid(); }); it('returns a successful response', function (done) { api.get(`${endPoint('copyPadWithoutHistory')}&sourceID=${sourcePadId}&destinationID=${newPad}&force=false`) .expect((res) => { if (res.body.code !== 0) throw new Error('Copy Pad Without History Failed'); }) .expect('Content-Type', /json/) .expect(200, done); }); // this test validates if the source pad's text and attributes are kept it('creates a new pad with the same content as the source pad', function (done) { api.get(`${endPoint('copyPadWithoutHistory')}&sourceID=${sourcePadId}&destinationID=${newPad}&force=false`) .expect((res) => { if (res.body.code !== 0) throw new Error('Copy Pad Without History Failed'); }) .end(() => { api.get(`${endPoint('getHTML')}&padID=${newPad}`) .expect((res) => { const receivedHtml = res.body.data.html.replace('

', '').toLowerCase(); if (receivedHtml !== expectedHtml) { throw new Error(`HTML received from export is not the one we were expecting. Received: ${receivedHtml} Expected: ${expectedHtml} Which is a slightly modified version of the originally imported one: ${ulHtml}`); } }) .expect(200, done); }); }); context('when try copy a pad with a group that does not exist', function () { const padId = makeid(); const padWithNonExistentGroup = `notExistentGroup$${padId}`; it('throws an error', function (done) { api.get(`${endPoint('copyPadWithoutHistory')}&sourceID=${sourcePadId}&destinationID=${padWithNonExistentGroup}&force=true`) .expect((res) => { // code 1, it means an error has happened if (res.body.code !== 1) throw new Error('It should report an error'); }) .expect(200, done); }); }); context('when try copy a pad and destination pad already exist', function () { const padIdExistent = makeid(); before(function (done) { createNewPadWithHtml(padIdExistent, ulHtml, done); }); context('and force is false', function () { it('throws an error', function (done) { api.get(`${endPoint('copyPadWithoutHistory')}&sourceID=${sourcePadId}&destinationID=${padIdExistent}&force=false`) .expect((res) => { // code 1, it means an error has happened if (res.body.code !== 1) throw new Error('It should report an error'); }) .expect(200, done); }); }); context('and force is true', function () { it('returns a successful response', function (done) { api.get(`${endPoint('copyPadWithoutHistory')}&sourceID=${sourcePadId}&destinationID=${padIdExistent}&force=true`) .expect((res) => { // code 1, it means an error has happened if (res.body.code !== 0) throw new Error('Copy pad without history with force true failed'); }) .expect(200, done); }); }); }); }); }); /* -> movePadForce Test */ var createNewPadWithHtml = function (padId, html, cb) { api.get(`${endPoint('createPad')}&padID=${padId}`) .end(() => { api.post(endPoint('setHTML')) .send({ padID: padId, html, }) .end(cb); }); }; var endPoint = function (point, version) { version = version || apiVersion; return `/api/${version}/${point}?apikey=${apiKey}`; }; function makeid() { let text = ''; const possible = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'; for (let i = 0; i < 5; i++) { text += possible.charAt(Math.floor(Math.random() * possible.length)); } return text; } function generateLongText() { let text = ''; const possible = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'; for (let i = 0; i < 80000; i++) { text += possible.charAt(Math.floor(Math.random() * possible.length)); } return text; } // Need this to compare arrays (listSavedRevisions test) Array.prototype.equals = function (array) { // if the other array is a falsy value, return if (!array) return false; // compare lengths - can save a lot of time if (this.length != array.length) return false; for (let i = 0, l = this.length; i < l; i++) { // Check if we have nested arrays if (this[i] instanceof Array && array[i] instanceof Array) { // recurse into the nested arrays if (!this[i].equals(array[i])) return false; } else if (this[i] != array[i]) { // Warning - two different object instances will never be equal: {x:20} != {x:20} return false; } } return true; };