etherpad-lite/tests/backend/specs/api.js

113 lines
3 KiB
JavaScript

var assert = require('assert')
supertest = require('supertest'),
fs = require('fs'),
api = supertest('http://localhost:9001');
path = require('path');
var filePath = path.join(__dirname, '../../../APIKEY.txt');
var apiKey = fs.readFileSync(filePath, {encoding: 'utf-8'});
var apiVersion = 1;
var testPadId = makeid();
describe('Connectivity', function(){
it('errors if can not connect', function(done) {
api.get('/api/')
.expect('Content-Type', /json/)
.expect(200, done)
});
})
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)
});
})
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
throw new Error("Erroring anyway just because the API seems broken here");
api.get('/api/'+apiVersion+'/createPad&apikey=password&padID=test')
.expect('Content-Type', /json/)
.expect(200, done)
});
})
describe('createPad', function(){
it('creates a new pad', function(done) {
api.get(endPoint('createPad')+"&padID="+testPadId)
.expect('Content-Type', /json/)
.expect(200, done)
});
})
/* Endpoints to interact with..
createPad(padID [, text])
getRevisions(padID)
padUsersCount(padID)
deletePad(padID)
getReadOnlyID(padID)
setPublicStatus(padID, publicStatus)
getPublicStatus(padID)
setPassword(padID, password)
isPasswordProtected(padID)
listAuthorsOfPad(padID)
getLastEdited(padID)
getHTML(padID, [rev])
setText(padID, text)
getText(padID, [rev])
listSessionsOfGroup(groupID)
getSessionInfo(sessionID)
deleteSession(sessionID)
createSession(groupID, authorID, validUntil)
listPadsOfAuthor(authorID)
createAuthorIfNotExistsFor(authorMapper [, name])
createAuthor([name])
createGroupPad(groupID, padName [, text])
listPads(groupID)
deleteGroup(groupID)
createGroupIfNotExistsFor(groupMapper)
createGroup()
*/
/*
describe('getRevisionsCount', function(){
it('gets the revision counts of a new pad', function(done) {
// This is broken because Etherpad doesn't handle HTTP codes properly see #2$
// If your APIKey is password you deserve to fail all tests anyway
api.get(endPoint('getRevisionsCount')+"&padID="+testPadId)
.expect('Content-Type', /json/)
.expect(function(res){
console.log(res.body);
})
.expect(200, done)
});
})
*/
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;
}