pad.libre-service.eu-etherpad/tests/backend/specs/api/importexport.js

'use strict';
/*
 * ACHTUNG: there is a copied & modified version of this file in
 * <basedir>/tests/container/spacs/api/pad.js
 *
 * TODO: unify those two files, and merge in a single one.
 */

/* eslint-disable max-len */

const common = require('../../common');
const supertest = require(`${__dirname}/../../../../src/node_modules/supertest`);
const settings = require(`${__dirname}/../../../../tests/container/loadSettings.js`).loadSettings();
const api = supertest(`http://${settings.ip}:${settings.port}`);

const apiKey = common.apiKey;
const apiVersion = 1;

const testImports = {
  'malformed': {
    input: '<html><body><li>wtf</ul></body></html>',
    expectedHTML: '<!DOCTYPE HTML><html><body>wtf<br><br></body></html>',
    expectedText: 'wtf\n\n',
  },
  'nonelistiteminlist #3620': {
    input: '<html><body><ul>test<li>FOO</li></ul></body></html>',
    expectedHTML: '<!DOCTYPE HTML><html><body><ul class="bullet">test<li>FOO</ul><br></body></html>',
    expectedText: '\ttest\n\t* FOO\n\n',
  },
  'whitespaceinlist #3620': {
    input: '<html><body><ul> <li>FOO</li></ul></body></html>',
    expectedHTML: '<!DOCTYPE HTML><html><body><ul class="bullet"><li>FOO</ul><br></body></html>',
    expectedText: '\t* FOO\n\n',
  },
  'prefixcorrectlinenumber': {
    input: '<html><body><ol><li>should be 1</li><li>should be 2</li></ol></body></html>',
    expectedHTML: '<!DOCTYPE HTML><html><body><ol start="1" class="number"><li>should be 1</li><li>should be 2</ol><br></body></html>',
    expectedText: '\t1. should be 1\n\t2. should be 2\n\n',
  },
  'prefixcorrectlinenumbernested': {
    input: '<html><body><ol><li>should be 1</li><ol><li>foo</li></ol><li>should be 2</li></ol></body></html>',
    expectedHTML: '<!DOCTYPE HTML><html><body><ol start="1" class="number"><li>should be 1<ol start="2" class="number"><li>foo</ol><li>should be 2</ol><br></body></html>',
    expectedText: '\t1. should be 1\n\t\t1.1. foo\n\t2. should be 2\n\n',
  },

  /*
  "prefixcorrectlinenumber when introduced none list item - currently not supported see #3450":{
    input: '<html><body><ol><li>should be 1</li>test<li>should be 2</li></ol></body></html>',
    expectedHTML: '<!DOCTYPE HTML><html><body><ol start="1" class="number"><li>should be 1</li>test<li>should be 2</li></ol><br></body></html>',
    expectedText: '\t1. should be 1\n\ttest\n\t2. should be 2\n\n'
  }
  ,
  "newlinesshouldntresetlinenumber #2194":{
    input: '<html><body><ol><li>should be 1</li>test<li>should be 2</li></ol></body></html>',
    expectedHTML: '<!DOCTYPE HTML><html><body><ol class="number"><li>should be 1</li>test<li>should be 2</li></ol><br></body></html>',
    expectedText: '\t1. should be 1\n\ttest\n\t2. should be 2\n\n'
  }
  */
  'ignoreAnyTagsOutsideBody': {
    description: 'Content outside body should be ignored',
    input: '<html><head><title>title</title><style></style></head><body>empty<br></body></html>',
    expectedHTML: '<!DOCTYPE HTML><html><body>empty<br><br></body></html>',
    expectedText: 'empty\n\n',
  },
  'indentedListsAreNotBullets': {
    description: 'Indented lists are represented with tabs and without bullets',
    input: '<html><body><ul class="indent"><li>indent</li><li>indent</ul></body></html>',
    expectedHTML: '<!DOCTYPE HTML><html><body><ul class="indent"><li>indent</li><li>indent</ul><br></body></html>',
    expectedText: '\tindent\n\tindent\n\n'
  }
};

describe(__filename, function () {
  Object.keys(testImports).forEach((testName) => {
    const testPadId = makeid();
    const test = testImports[testName];
    if (test.disabled) {
      return xit(`DISABLED: ${testName}`, function (done) {
        done();
      });
    }
    describe(`createPad ${testName}`, 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(`setHTML ${testName}`, function () {
      it('Sets the HTML', function (done) {
        api.get(`${endPoint('setHTML')}&padID=${testPadId}&html=${encodeURIComponent(test.input)}`)
            .expect((res) => {
              if (res.body.code !== 0) throw new Error(`Error:${testName}`);
            })
            .expect('Content-Type', /json/)
            .expect(200, done);
      });
    });

    describe(`getHTML ${testName}`, function () {
      it('Gets back the HTML of a Pad', function (done) {
        api.get(`${endPoint('getHTML')}&padID=${testPadId}`)
            .expect((res) => {
              const receivedHtml = res.body.data.html;
              if (receivedHtml !== test.expectedHTML) {
                throw new Error(`HTML received from export is not the one we were expecting.
             Test Name:
             ${testName}

             Received:
             ${JSON.stringify(receivedHtml)}

             Expected:
             ${JSON.stringify(test.expectedHTML)}

             Which is a different version of the originally imported one:
             ${test.input}`);
              }
            })
            .expect('Content-Type', /json/)
            .expect(200, done);
      });
    });

    describe(`getText ${testName}`, function () {
      it('Gets back the Text of a Pad', function (done) {
        api.get(`${endPoint('getText')}&padID=${testPadId}`)
            .expect((res) => {
              const receivedText = res.body.data.text;
              if (receivedText !== test.expectedText) {
                throw new Error(`Text received from export is not the one we were expecting.
             Test Name:
             ${testName}

             Received:
             ${JSON.stringify(receivedText)}

             Expected:
             ${JSON.stringify(test.expectedText)}

             Which is a different version of the originally imported one:
             ${test.input}`);
              }
            })
            .expect('Content-Type', /json/)
            .expect(200, done);
      });
    });
  });
});


function endPoint(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;
}
fix accidental write to global variable properly show pending tests log test name in suite better log output for received/expected strings 2020-12-18 06:30:03 +01:00			`'use strict';`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00			`/*`
			`* ACHTUNG: there is a copied & modified version of this file in`
			`* <basedir>/tests/container/spacs/api/pad.js`
			`*`
			`* TODO: unify those two files, and merge in a single one.`
			`*/`

fix accidental write to global variable properly show pending tests log test name in suite better log output for received/expected strings 2020-12-18 06:30:03 +01:00			`/* eslint-disable max-len */`

tests: Simplify API key reading Also delete unused imports. 2020-10-08 07:37:17 +02:00			`const common = require('../../common');`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			const supertest = require(`${__dirname}/../../../../src/node_modules/supertest`);
			const settings = require(`${__dirname}/../../../../tests/container/loadSettings.js`).loadSettings();
			const api = supertest(`http://${settings.ip}:${settings.port}`);
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00
tests: Simplify API key reading Also delete unused imports. 2020-10-08 07:37:17 +02:00			`const apiKey = common.apiKey;`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`const apiVersion = 1;`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`const testImports = {`
			`'malformed': {`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00			`input: '<html><body><li>wtf</ul></body></html>',`
			`expectedHTML: '<!DOCTYPE HTML><html><body>wtf<br><br></body></html>',`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`expectedText: 'wtf\n\n',`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00			`},`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`'nonelistiteminlist #3620': {`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00			`input: '<html><body><ul>test<li>FOO</li></ul></body></html>',`
			`expectedHTML: '<!DOCTYPE HTML><html><body><ul class="bullet">test<li>FOO</ul><br></body></html>',`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`expectedText: '\ttest\n\t* FOO\n\n',`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00			`},`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`'whitespaceinlist #3620': {`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00			`input: '<html><body><ul> <li>FOO</li></ul></body></html>',`
			`expectedHTML: '<!DOCTYPE HTML><html><body><ul class="bullet"><li>FOO</ul><br></body></html>',`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`expectedText: '\t* FOO\n\n',`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00			`},`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`'prefixcorrectlinenumber': {`
export: txt import include correct OL prefix (#4086) Includes test coverage Final part of solving https://github.com/ether/etherpad-lite/issues/3447 2020-06-06 15:30:13 +02:00			`input: '<html><body><ol><li>should be 1</li><li>should be 2</li></ol></body></html>',`
			`expectedHTML: '<!DOCTYPE HTML><html><body><ol start="1" class="number"><li>should be 1</li><li>should be 2</ol><br></body></html>',`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`expectedText: '\t1. should be 1\n\t2. should be 2\n\n',`
export: txt import include correct OL prefix (#4086) Includes test coverage Final part of solving https://github.com/ether/etherpad-lite/issues/3447 2020-06-06 15:30:13 +02:00			`},`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`'prefixcorrectlinenumbernested': {`
export: txt import include correct OL prefix (#4086) Includes test coverage Final part of solving https://github.com/ether/etherpad-lite/issues/3447 2020-06-06 15:30:13 +02:00			`input: '<html><body><ol><li>should be 1</li><ol><li>foo</li></ol><li>should be 2</li></ol></body></html>',`
			`expectedHTML: '<!DOCTYPE HTML><html><body><ol start="1" class="number"><li>should be 1<ol start="2" class="number"><li>foo</ol><li>should be 2</ol><br></body></html>',`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`expectedText: '\t1. should be 1\n\t\t1.1. foo\n\t2. should be 2\n\n',`
export: txt import include correct OL prefix (#4086) Includes test coverage Final part of solving https://github.com/ether/etherpad-lite/issues/3447 2020-06-06 15:30:13 +02:00			`},`

tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00			`/*`
export: txt import include correct OL prefix (#4086) Includes test coverage Final part of solving https://github.com/ether/etherpad-lite/issues/3447 2020-06-06 15:30:13 +02:00			`"prefixcorrectlinenumber when introduced none list item - currently not supported see #3450":{`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00			`input: '<html><body><ol><li>should be 1</li>test<li>should be 2</li></ol></body></html>',`
			`expectedHTML: '<!DOCTYPE HTML><html><body><ol start="1" class="number"><li>should be 1</li>test<li>should be 2</li></ol><br></body></html>',`
			`expectedText: '\t1. should be 1\n\ttest\n\t2. should be 2\n\n'`
			`}`
			`,`
			`"newlinesshouldntresetlinenumber #2194":{`
			`input: '<html><body><ol><li>should be 1</li>test<li>should be 2</li></ol></body></html>',`
			`expectedHTML: '<!DOCTYPE HTML><html><body><ol class="number"><li>should be 1</li>test<li>should be 2</li></ol><br></body></html>',`
			`expectedText: '\t1. should be 1\n\ttest\n\t2. should be 2\n\n'`
			`}`
			`*/`
tests: Ignore head tag on import / improved contentcollector tests * fix accidental write to global variable properly show pending tests log test name in suite better log output for received/expected strings * cc tests: enable second nestedOL test * ignore the head tag on import 2020-12-18 10:37:37 +01:00			`'ignoreAnyTagsOutsideBody': {`
			`description: 'Content outside body should be ignored',`
			`input: '<html><head><title>title</title><style></style></head><body>empty<br></body></html>',`
			`expectedHTML: '<!DOCTYPE HTML><html><body>empty<br><br></body></html>',`
			`expectedText: 'empty\n\n',`
			`},`
add list-style:none for ul.indents in exported HTML (#4586) * add list-style:none for ul.indents in exported HTML * use list-style-type not list-style 2020-12-20 07:00:18 +01:00			`'indentedListsAreNotBullets': {`
			`description: 'Indented lists are represented with tabs and without bullets',`
			`input: '<html><body><ul class="indent"><li>indent</li><li>indent</ul></body></html>',`
			`expectedHTML: '<!DOCTYPE HTML><html><body><ul class="indent"><li>indent</li><li>indent</ul><br></body></html>',`
			`expectedText: '\tindent\n\tindent\n\n'`
			`}`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`};`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`describe(__filename, function () {`
			`Object.keys(testImports).forEach((testName) => {`
			`const testPadId = makeid();`
fix accidental write to global variable properly show pending tests log test name in suite better log output for received/expected strings 2020-12-18 06:30:03 +01:00			`const test = testImports[testName];`
			`if (test.disabled) {`
			return xit(`DISABLED: ${testName}`, function (done) {
			`done();`
			`});`
			`}`
			describe(`createPad ${testName}`, function () {
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`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');`
tests: Include the filename in the test output Also some minor consistency cleanups. 2020-10-10 00:19:46 +02:00			`})`
			`.expect('Content-Type', /json/)`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`.expect(200, done);`
tests: Include the filename in the test output Also some minor consistency cleanups. 2020-10-10 00:19:46 +02:00			`});`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`});`
tests: Include the filename in the test output Also some minor consistency cleanups. 2020-10-10 00:19:46 +02:00
fix accidental write to global variable properly show pending tests log test name in suite better log output for received/expected strings 2020-12-18 06:30:03 +01:00			describe(`setHTML ${testName}`, function () {
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`it('Sets the HTML', function (done) {`
fix accidental write to global variable properly show pending tests log test name in suite better log output for received/expected strings 2020-12-18 06:30:03 +01:00			api.get(`${endPoint('setHTML')}&padID=${testPadId}&html=${encodeURIComponent(test.input)}`)
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`.expect((res) => {`
			if (res.body.code !== 0) throw new Error(`Error:${testName}`);
tests: Include the filename in the test output Also some minor consistency cleanups. 2020-10-10 00:19:46 +02:00			`})`
			`.expect('Content-Type', /json/)`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`.expect(200, done);`
tests: Include the filename in the test output Also some minor consistency cleanups. 2020-10-10 00:19:46 +02:00			`});`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`});`
tests: Include the filename in the test output Also some minor consistency cleanups. 2020-10-10 00:19:46 +02:00
fix accidental write to global variable properly show pending tests log test name in suite better log output for received/expected strings 2020-12-18 06:30:03 +01:00			describe(`getHTML ${testName}`, function () {
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`it('Gets back the HTML of a Pad', function (done) {`
			api.get(`${endPoint('getHTML')}&padID=${testPadId}`)
			`.expect((res) => {`
			`const receivedHtml = res.body.data.html;`
tests: Include the filename in the test output Also some minor consistency cleanups. 2020-10-10 00:19:46 +02:00			`if (receivedHtml !== test.expectedHTML) {`
			throw new Error(`HTML received from export is not the one we were expecting.
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00			`Test Name:`
			`${testName}`

			`Received:`
fix accidental write to global variable properly show pending tests log test name in suite better log output for received/expected strings 2020-12-18 06:30:03 +01:00			`${JSON.stringify(receivedHtml)}`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00
			`Expected:`
fix accidental write to global variable properly show pending tests log test name in suite better log output for received/expected strings 2020-12-18 06:30:03 +01:00			`${JSON.stringify(test.expectedHTML)}`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00
			`Which is a different version of the originally imported one:`
			${test.input}`);
tests: Include the filename in the test output Also some minor consistency cleanups. 2020-10-10 00:19:46 +02:00			`}`
			`})`
			`.expect('Content-Type', /json/)`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`.expect(200, done);`
tests: Include the filename in the test output Also some minor consistency cleanups. 2020-10-10 00:19:46 +02:00			`});`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`});`
tests: Include the filename in the test output Also some minor consistency cleanups. 2020-10-10 00:19:46 +02:00
fix accidental write to global variable properly show pending tests log test name in suite better log output for received/expected strings 2020-12-18 06:30:03 +01:00			describe(`getText ${testName}`, function () {
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`it('Gets back the Text of a Pad', function (done) {`
			api.get(`${endPoint('getText')}&padID=${testPadId}`)
			`.expect((res) => {`
			`const receivedText = res.body.data.text;`
tests: Include the filename in the test output Also some minor consistency cleanups. 2020-10-10 00:19:46 +02:00			`if (receivedText !== test.expectedText) {`
			throw new Error(`Text received from export is not the one we were expecting.
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00			`Test Name:`
			`${testName}`

			`Received:`
fix accidental write to global variable properly show pending tests log test name in suite better log output for received/expected strings 2020-12-18 06:30:03 +01:00			`${JSON.stringify(receivedText)}`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00
			`Expected:`
fix accidental write to global variable properly show pending tests log test name in suite better log output for received/expected strings 2020-12-18 06:30:03 +01:00			`${JSON.stringify(test.expectedText)}`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00
			`Which is a different version of the originally imported one:`
			${test.input}`);
tests: Include the filename in the test output Also some minor consistency cleanups. 2020-10-10 00:19:46 +02:00			`}`
			`})`
			`.expect('Content-Type', /json/)`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`.expect(200, done);`
tests: Include the filename in the test output Also some minor consistency cleanups. 2020-10-10 00:19:46 +02:00			`});`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`});`
tests: Include the filename in the test output Also some minor consistency cleanups. 2020-10-10 00:19:46 +02:00			`});`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00			`});`


fix accidental write to global variable properly show pending tests log test name in suite better log output for received/expected strings 2020-12-18 06:30:03 +01:00			`function endPoint(point, version) {`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00			`version = version \|\| apiVersion;`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			return `/api/${version}/${point}?apikey=${apiKey}`;
			`};`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00
lint: Put opening brace on same line as `function` Normally I would let `eslint --fix` do this for me, but there's a bug that causes: const x = function () { // ... }; to become: const x = () => { // ... }; which ESLint thinks is a syntax error. (It probably is; I don't know enough about the automatic semicolon insertion rules to be confident.) 2020-11-21 19:37:57 +01:00			`function makeid() {`
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`let text = '';`
			`const possible = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00
lint: Run `eslint --fix` on `bin/` and `tests/` 2020-11-23 19:21:51 +01:00			`for (let i = 0; i < 5; i++) {`
tests: OL/UL further testing. 2020-06-05 23:18:58 +02:00			`text += possible.charAt(Math.floor(Math.random() * possible.length));`
			`}`
			`return text;`
			`}`