tests: fuzzing, binary imports

src/package.json

@@ -71,6 +71,7 @@
   },
   "devDependencies": {
     "mocha": "7.1.2",
+    "mocha-froth":"0.2.10",
     "nyc": "15.0.1",
     "supertest": "4.0.2",
     "wd": "1.12.1"

tests/backend/fuzzImportTest.js

@@ -0,0 +1,76 @@
+/*
+ * Fuzz testing the import endpoint
+ * Usage: node fuzzImportTest.js
+ */
+const fs = require('fs');
+const settings = require(__dirname+'/loadSettings').loadSettings();
+const host = "http://" + settings.ip + ":" + settings.port;
+const path = require('path');
+const async = require(__dirname+'/../../src/node_modules/async');
+const request = require('request');
+const froth = require('mocha-froth');
+
+var filePath = path.join(__dirname, '/../../APIKEY.txt');
+var apiKey = fs.readFileSync(filePath,  {encoding: 'utf-8'});
+apiKey = apiKey.replace(/\n$/, "");
+var apiVersion = 1;
+var testPadId = "TEST_fuzz" + makeid();
+
+var endPoint = function(point, version){
+  version = version || apiVersion;
+  return '/api/'+version+'/'+point+'?apikey='+apiKey;
+}
+
+console.log("Testing against padID", testPadId);
+console.log("To watch the test live visit " + host + "/p/" + testPadId);
+console.log("Tests will start in 5 seconds, click the URL now!");
+
+setTimeout(function(){
+  for (let i=1; i<1000000; i++) { // 1M runs
+    setTimeout( function timer(){
+      runTest(i);
+    }, i*100 ); // 100 ms
+  }
+},5000); // wait 5 seconds
+
+function runTest(number){
+  request(host + endPoint('createPad') + '&padID=' + testPadId, function(err, res, body){
+    var req = request.post(host + '/p/'+testPadId+'/import', function (err, res, body) {
+      if (err) {
+        throw new Error("FAILURE", err);
+      }else{
+        console.log("Success");
+      }
+    });
+
+    var fN = '/test.txt';
+    var cT = 'text/plain';
+
+    // To be more agressive every other test we mess with Etherpad
+    // We provide a weird file name and also set a weird contentType
+    if (number % 2 == 0) {
+      fN = froth().toString();
+      cT = froth().toString();
+    }
+
+    let form = req.form();
+    form.append('file', froth().toString(), {
+      filename: fN,
+      contentType: cT
+    });
+
+  });
+}
+
+function makeid()
+{
+  var text = "";
+  var possible = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+
+  for( var i=0; i < 5; i++ ){
+    text += possible.charAt(Math.floor(Math.random() * possible.length));
+  }
+  return text;
+}
+
+

tests/backend/specs/api/fuzzImportTest.js

@@ -0,0 +1,75 @@
+/*
+ * Fuzz testing the import endpoint
+ */
+const fs = require('fs');
+const settings = require(__dirname+'/../../loadSettings').loadSettings();
+const host = "http://" + settings.ip + ":" + settings.port;
+const path = require('path');
+const async = require(__dirname+'/../../../../src/node_modules/async');
+const request = require('request');
+const froth = require('mocha-froth');
+
+var filePath = path.join(__dirname, '../../../../APIKEY.txt');
+var apiKey = fs.readFileSync(filePath,  {encoding: 'utf-8'});
+apiKey = apiKey.replace(/\n$/, "");
+var apiVersion = 1;
+var testPadId = "TEST_fuzz" + makeid();
+
+var endPoint = function(point, version){
+  version = version || apiVersion;
+  return '/api/'+version+'/'+point+'?apikey='+apiKey;
+}
+
+console.log("Testing against padID", testPadId);
+console.log("To watch the test live visit " + host + "/p/" + testPadId);
+console.log("Tests will start in 5 seconds, click the URL now!");
+
+setTimeout(function(){
+  for (let i=1; i<1000000; i++) { // 1M runs
+    setTimeout( function timer(){
+      runTest(i);
+    }, i*100 ); // 100 ms
+  }
+},5000); // wait 5 seconds
+
+function runTest(number){
+  request(host + endPoint('createPad') + '&padID=' + testPadId, function(err, res, body){
+    var req = request.post(host + '/p/'+testPadId+'/import', function (err, res, body) {
+      if (err) {
+        throw new Error("FAILURE", err);
+      }else{
+        console.log("Success");
+      }
+    });
+
+    var fN = '/test.txt';
+    var cT = 'text/plain';
+
+    // To be more agressive every other test we mess with Etherpad
+    // We provide a weird file name and also set a weird contentType
+    if (number % 2 == 0) {
+      fN = froth().toString();
+      cT = froth().toString();
+    }
+
+    let form = req.form();
+    form.append('file', froth().toString(), {
+      filename: fN,
+      contentType: cT
+    });
+
+  });
+}
+
+function makeid()
+{
+  var text = "";
+  var possible = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+
+  for( var i=0; i < 5; i++ ){
+    text += possible.charAt(Math.floor(Math.random() * possible.length));
+  }
+  return text;
+}
+
+

tests/backend/specs/api/importexportGetPost.js

@@ -0,0 +1,252 @@
+/*
+ * Import and Export tests for the /p/whateverPadId/import and /p/whateverPadId/export endpoints.
+ * Executed using request.  Designed to find flaws and bugs
+ */
+
+const assert = require('assert');
+const supertest = require(__dirname+'/../../../../src/node_modules/supertest');
+const fs = require('fs');
+const settings = require(__dirname+'/../../loadSettings').loadSettings();
+const host = 'http://127.0.0.1:'+settings.port;
+const api = supertest('http://'+settings.ip+":"+settings.port);
+const path = require('path');
+const async = require(__dirname+'/../../../../src/node_modules/async');
+const request = require('request');
+const padText = fs.readFileSync("../tests/backend/specs/api/test.txt");
+const wordDoc = fs.readFileSync("../tests/backend/specs/api/test.doc");
+var filePath = path.join(__dirname, '../../../../APIKEY.txt');
+
+var apiKey = fs.readFileSync(filePath,  {encoding: 'utf-8'});
+apiKey = apiKey.replace(/\n$/, "");
+var apiVersion = 1;
+var testPadId = makeid();
+var lastEdited = "";
+var text = generateLongText();
+
+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(function(res){
+      apiVersion = res.body.currentVersion;
+      if (!res.body.currentVersion) throw new Error("No version set in API");
+      return;
+    })
+    .expect(200, done)
+  });
+})
+
+/*
+Tests
+-----
+
+Test.
+  / Create a pad
+  / Set pad contents
+  / Try export pad in various formats
+  / Get pad contents and ensure it matches imported contents
+
+Test.
+  / Try to export a pad that doesn't exist // Expect failure
+
+Test.
+  / Try to import an unsupported file to a pad that exists
+
+TODO: Test.
+  / Try to import a file that depends on Abiword / soffice if it exists
+  / Try to export a file that depends on Abiword / soffice if it exists
+
+-- TODO: Test.
+  Try to import to a pad without a session (currently will pass but IMHO in future should fail)
+
+-- TODO: Test.
+  Try to import to a file and abort it half way through
+
+Test.
+  Try to import to files of varying size.
+
+Example Curl command for testing import URI:
+  curl -s -v --form file=@/home/jose/test.txt http://127.0.0.1:9001/p/foo/import
+*/
+
+describe('Imports and Exports', function(){
+
+  it('creates a new Pad, imports content to it, checks that content', function(done) {
+
+    api.get(endPoint('createPad')+"&padID="+testPadId)
+    .expect(function(res){
+      if(res.body.code !== 0) throw new Error("Unable to create new Pad");
+
+      var req = request.post(host + '/p/'+testPadId+'/import', function (err, res, body) {
+        if (err) {
+          throw new Error("Failed to import", err);
+        } else {
+
+          api.get(endPoint('getText')+"&padID="+testPadId)
+          .expect(function(res){
+            if(res.body.data.text === padText.toString()){
+              console.log("yay it matches");
+            }
+          })
+          .expect(200)
+        }
+      });
+
+      let form = req.form();
+
+      form.append('file', padText, {
+        filename: '/test.txt',
+        contentType: 'text/plain'
+      });
+
+    })
+    .expect('Content-Type', /json/)
+    .expect(200, done)
+  });
+
+  it('tries to import to a pad that does not exist', function(done) {
+    var req = request.post(host + '/p/'+testPadId+testPadId+testPadId+'/import', function (err, res, body) {
+      if (res.statusCode === 200) {
+        throw new Error("Was able to import to a pad that doesn't exist");
+      }else{
+          // Wasn't able to write to a pad that doesn't exist, this is expected behavior
+          api.get(endPoint('getText')+"&padID="+testPadId+testPadId+testPadId)
+          .expect(function(res){
+            if(res.body.code !== 1) throw new Error("Pad Exists");
+          })
+          .expect(200, done)
+      }
+
+      let form = req.form();
+
+      form.append('file', padText, {
+        filename: '/test.txt',
+        contentType: 'text/plain'
+      });
+    })
+  });
+
+  it('Tries to import unsupported file type', function(done) {
+    if(settings.allowUnknownFileEnds === true){
+      console.log("allowing unknown file ends so skipping this test");
+      return done();
+    }
+
+    var req = request.post(host + '/p/'+testPadId+'/import', function (err, res, body) {
+      if (err) {
+        throw new Error("Failed to import", err);
+      } else {
+        if(res.body.indexOf("FrameCall('undefined', 'ok');") !== -1){
+          console.log("worked");
+          throw new Error("You shouldn't be able to import this file", testPadId);
+        }
+        return done();
+      }
+    });
+
+    let form = req.form();
+    form.append('file', padText, {
+      filename: '/test.xasdasdxx',
+      contentType: 'weirdness/jobby'
+    });
+  });
+
+  if(!settings.abiword && !settings.soffice){
+    console.warn("Did not test abiword or soffice");
+  }else{
+    it('Tries to import file type that uses soffice or abioffice', function(done) {
+
+      var req = request.post(host + '/p/'+testPadId+'/import', function (err, res, body) {
+        if (err) {
+          throw new Error("Failed to import", err);
+        } else {
+          if(res.body.indexOf("FrameCall('undefined', 'ok');") === -1){
+            throw new Error("Failed Doc import", testPadId);
+          }
+
+          request(host + '/p/'+testPadId+'/export/doc', function (errE, resE, bodyE) {
+            if(resE.body.indexOf("Hello World") === -1) throw new Error("Could not find Hello World in exported contents");
+
+            api.get(endPoint('getText')+"&padID="+testPadId)
+            .expect(function(res){
+              if(res.body.code !== 0) throw new Error("Could not get pad");
+              // Not graceflu but it works
+              console.warn("HERE");
+            })
+            .expect(200, done);
+          });
+        }
+      });
+
+      let form = req.form();
+
+      form.append('file', wordDoc, {
+        filename: '/test.doc',
+        contentType: 'application/msword'
+      });
+
+    });
+  }
+
+
+// end of tests
+})
+
+
+
+
+
+var endPoint = function(point, version){
+  version = version || apiVersion;
+  return '/api/'+version+'/'+point+'?apikey='+apiKey;
+}
+
+function makeid()
+{
+  var text = "";
+  var possible = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+
+  for( var i=0; i < 5; i++ ){
+    text += possible.charAt(Math.floor(Math.random() * possible.length));
+  }
+  return text;
+}
+
+function generateLongText(){
+  var text = "";
+  var possible = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+
+  for( var 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 (var 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;
+}

tests/backend/specs/api/test.txt

@@ -0,0 +1 @@
+This is the contents we insert into pads when testing the import functions.  Thanks for using Etherpad!