libretic
/
etherpad-lite
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
etherpad-lite/tests/backend/specs/api/pad.js

464 lines
14 KiB
JavaScript
Raw Normal View History

make internal note of which endpoints need testing
2014-11-26 02:11:42 +01:00
var assert = require('assert')
path issues for supertitties
2014-11-26 23:10:56 +01:00
supertest = require(__dirname+'/../../../../src/node_modules/supertest'),
make internal note of which endpoints need testing
2014-11-26 02:11:42 +01:00
fs = require('fs'),
basic test runner
2014-11-25 23:47:22 +01:00
api = supertest('http://localhost:9001');
make internal note of which endpoints need testing
2014-11-26 02:11:42 +01:00
path = require('path');
basic test runner
2014-11-25 23:47:22 +01:00
tidy up and re-organize
2014-11-26 20:28:49 +01:00
var filePath = path.join(__dirname, '../../../../APIKEY.txt');
make internal note of which endpoints need testing
2014-11-26 02:11:42 +01:00
var apiKey = fs.readFileSync(filePath, {encoding: 'utf-8'});
remove trailing enter from apikey
2014-12-27 14:19:31 +01:00
apiKey = apiKey.replace(/\n$/, "");
make internal note of which endpoints need testing
2014-11-26 02:11:42 +01:00
var apiVersion = 1;
var testPadId = makeid();
mowah pad tests, tea time
2014-11-26 20:44:38 +01:00
var lastEdited = "";
better test coverage for longer pad data
2014-12-29 21:13:07 +01:00
var text = generateLongText();
fix ul tests
2015-01-19 16:37:29 +01:00
var ULhtml = '<!DOCTYPE html><html><body><ul class="bullet"><li>one</li><li>2</li></ul><br><ul><ul class="bullet"><li>UL2</li></ul></ul></body></html>';
basic test runner
2014-11-25 23:47:22 +01:00
describe('Connectivity', function(){
it('errors if can not connect', function(done) {
api.get('/api/')
make internal note of which endpoints need testing
2014-11-26 02:11:42 +01:00
.expect('Content-Type', /json/)
basic test runner
2014-11-25 23:47:22 +01:00
.expect(200, done)
});
})
make internal note of which endpoints need testing
2014-11-26 02:11:42 +01:00
describe('API Versioning', function(){
it('errors if can not connect', 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)
});
})
basic test runner
2014-11-25 23:47:22 +01:00
make internal note of which endpoints need testing
2014-11-26 02:11:42 +01:00
describe('Permission', function(){
it('errors if can connect without correct 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
handle auth fails
2014-11-26 18:34:44 +01:00
var permErrorURL = '/api/'+apiVersion+'/createPad?apikey=password&padID=test';
api.get(permErrorURL)
.expect(401, done)
make internal note of which endpoints need testing
2014-11-26 02:11:42 +01:00
});
})
basic test runner
2014-11-25 23:47:22 +01:00
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
/* Pad Tests Order of execution
-> deletePad -- This gives us a guaranteed clear environment
-> createPad
mowah pad tests, tea time
2014-11-26 20:44:38 +01:00
-> getRevisions -- Should be 0
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
-> 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?
-> padUsersCount -- Should be 0
-> getReadOnlyId -- Should be a value
mowah pad tests, tea time
2014-11-26 20:44:38 +01:00
-> listAuthorsOfPad(padID) -- should be empty array?
-> getLastEdited(padID) -- Should be when pad was made
-> setText(padId)
-> getLastEdited(padID) -- Should be when setText was performed
test for pad users
2014-12-24 05:01:18 +01:00
-> padUsers(padID) -- Should be when setText was performed
move pad tests - still need to do copy pad and some other functionality IE force
2014-12-29 15:08:30 +01:00
-> setText(padId, "hello world")
-> getLastEdited(padID) -- Should be when pad was made
-> getText(padId) -- Should be "hello world"
-> movePad(padID, newPadId) -- Should provide consistant pad data
-> getText(newPadId) -- Should be "hello world"
-> movePad(newPadID, originalPadId) -- Should provide consistant pad data
-> getText(originalPadId) -- Should be "hello world"
-> getLastEdited(padID) -- Should not be 0
bumpage
2015-01-19 03:51:32 +01:00
-> setHTML(padID) -- Should fail on invalid HTML
-> setHTML(padID) *3 -- Should fail on invalid HTML
-> getHTML(padID) -- Should return HTML close to posted HTML
move pad tests - still need to do copy pad and some other functionality IE force
2014-12-29 15:08:30 +01:00
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
*/
describe('deletePad', function(){
it('deletes a Pad', function(done) {
api.get(endPoint('deletePad')+"&padID="+testPadId)
.expect('Content-Type', /json/)
.expect(200, done)
});
})
make internal note of which endpoints need testing
2014-11-26 02:11:42 +01:00
describe('createPad', function(){
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
it('creates a new Pad', function(done) {
make internal note of which endpoints need testing
2014-11-26 02:11:42 +01:00
api.get(endPoint('createPad')+"&padID="+testPadId)
all pad tests with content
2014-11-26 20:25:09 +01:00
.expect(function(res){
if(res.body.code !== 0) throw new Error("Unable to create new Pad");
})
make internal note of which endpoints need testing
2014-11-26 02:11:42 +01:00
.expect('Content-Type', /json/)
.expect(200, done)
basic test runner
2014-11-25 23:47:22 +01:00
});
make internal note of which endpoints need testing
2014-11-26 02:11:42 +01:00
})
all pad tests with content
2014-11-26 20:25:09 +01:00
describe('getRevisionsCount', function(){
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
it('gets revision count of Pad', function(done) {
all pad tests with content
2014-11-26 20:25:09 +01:00
api.get(endPoint('getRevisionsCount')+"&padID="+testPadId)
.expect(function(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");
})
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
.expect('Content-Type', /json/)
.expect(200, done)
});
})
describe('getHTML', function(){
it('get the HTML of Pad', function(done) {
api.get(endPoint('getHTML')+"&padID="+testPadId)
all pad tests with content
2014-11-26 20:25:09 +01:00
.expect(function(res){
if(res.body.data.html.length <= 1) throw new Error("Unable to get Revision Count");
})
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
.expect('Content-Type', /json/)
.expect(200, done)
});
})
describe('deletePad', function(){
it('deletes a Pad', function(done) {
api.get(endPoint('deletePad')+"&padID="+testPadId)
all pad tests with content
2014-11-26 20:25:09 +01:00
.expect(function(res){
if(res.body.code !== 0) throw new Error("Pad Deletion failed")
})
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
.expect('Content-Type', /json/)
.expect(200, done)
});
})
describe('getHTML', function(){
all pad tests with content
2014-11-26 20:25:09 +01:00
it('get the HTML of a Pad -- Should return a failure', function(done) {
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
api.get(endPoint('getHTML')+"&padID="+testPadId)
all pad tests with content
2014-11-26 20:25:09 +01:00
.expect(function(res){
if(res.body.code !== 1) throw new Error("Pad deletion failed")
})
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
.expect('Content-Type', /json/)
.expect(200, done)
});
})
describe('createPad', function(){
it('creates a new Pad with text', function(done) {
all pad tests with content
2014-11-26 20:25:09 +01:00
api.get(endPoint('createPad')+"&padID="+testPadId+"&text=testText")
.expect(function(res){
if(res.body.code !== 0) throw new Error("Pad Creation failed")
})
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
.expect('Content-Type', /json/)
.expect(200, done)
});
})
describe('getText', function(){
all pad tests with content
2014-11-26 20:25:09 +01:00
it('gets the Pad text and expect it to be testText with \n which is a line break', function(done) {
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
api.get(endPoint('getText')+"&padID="+testPadId)
all pad tests with content
2014-11-26 20:25:09 +01:00
.expect(function(res){
if(res.body.data.text !== "testText\n") throw new Error("Pad Creation with text")
})
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
.expect('Content-Type', /json/)
.expect(200, done)
});
})
describe('setText', function(){
it('creates a new Pad with text', function(done) {
all pad tests with content
2014-11-26 20:25:09 +01:00
api.get(endPoint('setText')+"&padID="+testPadId+"&text=testTextTwo")
.expect(function(res){
if(res.body.code !== 0) throw new Error("Pad setting text failed");
})
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
.expect('Content-Type', /json/)
.expect(200, done)
});
})
describe('getText', function(){
it('gets the Pad text', function(done) {
api.get(endPoint('getText')+"&padID="+testPadId)
all pad tests with content
2014-11-26 20:25:09 +01:00
.expect(function(res){
if(res.body.data.text !== "testTextTwo\n") throw new Error("Setting Text")
})
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
.expect('Content-Type', /json/)
.expect(200, done)
});
})
all pad tests with content
2014-11-26 20:25:09 +01:00
describe('getRevisionsCount', function(){
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
it('gets Revision Coutn of a Pad', function(done) {
all pad tests with content
2014-11-26 20:25:09 +01:00
api.get(endPoint('getRevisionsCount')+"&padID="+testPadId)
.expect(function(res){
if(res.body.data.revisions !== 1) throw new Error("Unable to set text revision count")
})
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
.expect('Content-Type', /json/)
.expect(200, done)
});
})
describe('padUsersCount', function(){
mowah pad tests, tea time
2014-11-26 20:44:38 +01:00
it('gets User Count of a Pad', function(done) {
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
api.get(endPoint('padUsersCount')+"&padID="+testPadId)
all pad tests with content
2014-11-26 20:25:09 +01:00
.expect(function(res){
if(res.body.data.padUsersCount !== 0) throw new Error("Incorrect Pad User count")
})
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
.expect('Content-Type', /json/)
.expect(200, done)
});
})
all pad tests with content
2014-11-26 20:25:09 +01:00
describe('getReadOnlyID', function(){
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
it('Gets the Read Only ID of a Pad', function(done) {
all pad tests with content
2014-11-26 20:25:09 +01:00
api.get(endPoint('getReadOnlyID')+"&padID="+testPadId)
.expect(function(res){
if(!res.body.data.readOnlyID) throw new Error("No Read Only ID for Pad")
})
basic pad tests without test logic yet
2014-11-26 18:53:31 +01:00
.expect('Content-Type', /json/)
.expect(200, done)
});
})
mowah pad tests, tea time
2014-11-26 20:44:38 +01:00
describe('listAuthorsOfPad', function(){
it('Get Authors of the Pad', function(done) {
api.get(endPoint('listAuthorsOfPad')+"&padID="+testPadId)
.expect(function(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(function(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.get(endPoint('setText')+"&padID="+testPadId+"&text=testTextTwo")
.expect(function(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(function(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)
});
})
test for pad users
2014-12-24 05:01:18 +01:00
describe('padUsers', function(){
it('gets User Count of a Pad', function(done) {
api.get(endPoint('padUsers')+"&padID="+testPadId)
.expect(function(res){
if(res.body.data.padUsers.length !== 0) throw new Error("Incorrect Pad Users")
})
.expect('Content-Type', /json/)
.expect(200, done)
});
})
move pad tests - still need to do copy pad and some other functionality IE force
2014-12-29 15:08:30 +01:00
describe('deletePad', function(){
it('deletes a Pad', function(done) {
api.get(endPoint('deletePad')+"&padID="+testPadId)
.expect(function(res){
if(res.body.code !== 0) throw new Error("Pad Deletion failed")
})
.expect('Content-Type', /json/)
.expect(200, done)
});
})
var originalPadId = testPadId;
var newPadId = makeid();
describe('createPad', function(){
it('creates a new Pad with text', function(done) {
api.get(endPoint('createPad')+"&padID="+testPadId)
.expect(function(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) {
better test coverage for longer pad data
2014-12-29 21:13:07 +01:00
api.get(endPoint('setText')+"&padID="+testPadId+"&text="+text)
move pad tests - still need to do copy pad and some other functionality IE force
2014-12-29 15:08:30 +01:00
.expect(function(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(function(res){
if(res.body.code !== 0) throw new Error("Pad Get Text failed")
better test coverage for longer pad data
2014-12-29 21:13:07 +01:00
if(res.body.data.text !== text+"\n") throw new Error("Pad Text not set properly");
move pad tests - still need to do copy pad and some other functionality IE force
2014-12-29 15:08:30 +01:00
})
.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(function(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(function(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(function(res){
better test coverage for longer pad data
2014-12-29 21:13:07 +01:00
if(res.body.data.text !== text+"\n") throw new Error("Pad Get Text failed")
move pad tests - still need to do copy pad and some other functionality IE force
2014-12-29 15:08:30 +01:00
})
.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(function(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(function(res){
better test coverage for longer pad data
2014-12-29 21:13:07 +01:00
if(res.body.data.text !== text+"\n") throw new Error("Pad Get Text failed")
move pad tests - still need to do copy pad and some other functionality IE force
2014-12-29 15:08:30 +01:00
})
.expect('Content-Type', /json/)
.expect(200, done)
});
})
test for pad users
2014-12-24 05:01:18 +01:00
move pad tests - still need to do copy pad and some other functionality IE force
2014-12-29 15:08:30 +01:00
describe('getLastEdited', function(){
it('Gets when pad was last edited', function(done) {
api.get(endPoint('getLastEdited')+"&padID="+testPadId)
.expect(function(res){
if(res.body.lastEdited === 0) throw new Error("Get Last Edited Failed")
})
.expect('Content-Type', /json/)
.expect(200, done)
});
})
bumpage
2015-01-19 03:51:32 +01:00
describe('setHTML', function(){
it('Sets the HTML of a Pad attempting to pass ugly HTML', function(done) {
var html = "<div><b>Hello HTML</title></head></div>";
api.get(endPoint('setHTML')+"&padID="+testPadId+"&html="+html)
.expect(function(res){
remove pointless comments
2015-01-19 16:44:16 +01:00
console.log(res.body.code);
bumpage
2015-01-19 03:51:32 +01:00
if(res.body.code !== 1) throw new Error("Allowing crappy HTML to be imported")
})
.expect('Content-Type', /json/)
.expect(200, done)
});
})
describe('setHTML', function(){
it('Sets the HTML of a Pad with a bunch of weird unordered lists inserted', function(done) {
nearly fully working
2015-01-19 04:02:34 +01:00
api.get(endPoint('setHTML')+"&padID="+testPadId+"&html="+ULhtml)
bumpage
2015-01-19 03:51:32 +01:00
.expect(function(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 the HTML of a Pad with a bunch of weird unordered lists inserted', function(done) {
nearly fully working
2015-01-19 04:02:34 +01:00
api.get(endPoint('getHTML')+"&padID="+testPadId)
bumpage
2015-01-19 03:51:32 +01:00
.expect(function(res){
fix ul tests
2015-01-19 16:37:29 +01:00
var ehtml = res.body.data.html.replace("<br></body>", "</body>").toLowerCase();
var uhtml = ULhtml.toLowerCase();
if(ehtml !== uhtml) throw new Error("Imported HTML does not match served HTML")
bumpage
2015-01-19 03:51:32 +01:00
})
.expect('Content-Type', /json/)
.expect(200, done)
});
})
move pad tests - still need to do copy pad and some other functionality IE force
2014-12-29 15:08:30 +01:00
/*
-> movePadForce Test
*/
mowah pad tests, tea time
2014-11-26 20:44:38 +01:00
make internal note of which endpoints need testing
2014-11-26 02:11:42 +01:00
var endPoint = function(point){
return '/api/'+apiVersion+'/'+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;
}
better test coverage for longer pad data
2014-12-29 21:13:07 +01:00
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;
}