overleaf/services/docstore/test/unit/coffee/HttpControllerTests.coffee

328 lines
9.1 KiB
CoffeeScript
Raw Normal View History

SandboxedModule = require('sandboxed-module')
2014-05-20 08:04:33 -04:00
assert = require("chai").assert
sinon = require('sinon')
chai = require('chai')
chai.should()
expect = chai.expect
modulePath = require('path').join __dirname, '../../../app/js/HttpController'
2014-04-30 08:06:12 -04:00
ObjectId = require("mongojs").ObjectId
describe "HttpController", ->
beforeEach ->
@HttpController = SandboxedModule.require modulePath, requires:
"./DocManager": @DocManager = {}
2015-06-02 18:24:45 -04:00
"./DocArchiveManager": @DocArchiveManager = {}
"logger-sharelatex": @logger = { log: sinon.stub(), error: sinon.stub() }
"./HealthChecker": {}
2014-05-20 08:04:33 -04:00
@res = { send: sinon.stub(), json: sinon.stub(), setHeader:sinon.stub() }
@req = { query:{}}
@next = sinon.stub()
@project_id = "mock-project-id"
@doc_id = "mock-doc-id"
@doc = {
_id: @doc_id
2014-05-20 08:04:33 -04:00
lines: ["mock", "lines", " here", "", "", " spaces "]
2014-04-30 08:06:12 -04:00
version: 42
rev: 5
}
@deletedDoc = {
deleted:true
_id: @doc_id
lines: ["mock", "lines", " here", "", "", " spaces "]
version: 42
rev: 5
}
describe "getDoc", ->
describe "without deleted docs", ->
beforeEach ->
@req.params =
project_id: @project_id
doc_id: @doc_id
@DocManager.getDoc = sinon.stub().callsArgWith(3, null, @doc)
@HttpController.getDoc @req, @res, @next
it "should get the document with the version (including deleted)", ->
@DocManager.getDoc
.calledWith(@project_id, @doc_id, {lines: true, rev: true, deleted: true, version: true, ranges: true})
.should.equal true
it "should return the doc as JSON", ->
@res.json
.calledWith({
_id: @doc_id
lines: @doc.lines
rev: @doc.rev
version: @doc.version
})
.should.equal true
describe "which is deleted", ->
beforeEach ->
@req.params =
project_id: @project_id
doc_id: @doc_id
@DocManager.getDoc = sinon.stub().callsArgWith(3, null, @deletedDoc)
it "should get the doc from the doc manager", ->
@HttpController.getDoc @req, @res, @next
@DocManager.getDoc.calledWith(@project_id, @doc_id, {lines: true, rev: true, deleted: true, version: true, ranges: true}).should.equal true
it "should return 404 if the query string delete is not set ", ->
@HttpController.getDoc @req, @res, @next
@res.send.calledWith(404).should.equal true
it "should return the doc as JSON if include_deleted is set to true", ->
@req.query.include_deleted = "true"
@HttpController.getDoc @req, @res, @next
@res.json
.calledWith({
_id: @doc_id
lines: @doc.lines
rev: @doc.rev
deleted: true
version: @doc.version
})
.should.equal true
2014-04-30 08:06:12 -04:00
2014-05-20 08:04:33 -04:00
describe "getRawDoc", ->
beforeEach ->
@req.params =
project_id: @project_id
doc_id: @doc_id
@DocManager.getDoc = sinon.stub().callsArgWith(3, null, @doc)
2014-05-20 08:04:33 -04:00
@HttpController.getRawDoc @req, @res, @next
it "should get the document without the version", ->
2014-05-20 08:04:33 -04:00
@DocManager.getDoc
.calledWith(@project_id, @doc_id, {lines: true})
2014-05-20 08:04:33 -04:00
.should.equal true
it "should set the content type header", ->
@res.setHeader.calledWith('content-type', 'text/plain').should.equal true
it "should send the raw version of the doc", ->
assert.deepEqual @res.send.args[0][0], "#{@doc.lines[0]}\n#{@doc.lines[1]}\n#{@doc.lines[2]}\n#{@doc.lines[3]}\n#{@doc.lines[4]}\n#{@doc.lines[5]}"
2014-04-30 08:06:12 -04:00
describe "getAllDocs", ->
describe "normally", ->
beforeEach ->
@req.params =
project_id: @project_id
@docs = [{
_id: ObjectId()
lines: ["mock", "lines", "one"]
rev: 2
}, {
_id: ObjectId()
lines: ["mock", "lines", "two"]
rev: 4
}]
@DocManager.getAllNonDeletedDocs = sinon.stub().callsArgWith(2, null, @docs)
@HttpController.getAllDocs @req, @res, @next
2014-04-30 08:06:12 -04:00
2016-12-05 11:31:51 -05:00
it "should get all the (non-deleted) docs", ->
@DocManager.getAllNonDeletedDocs
.calledWith(@project_id, {lines: true, rev: true})
.should.equal true
2014-04-30 08:06:12 -04:00
it "should return the doc as JSON", ->
@res.json
.calledWith([{
_id: @docs[0]._id.toString()
lines: @docs[0].lines
rev: @docs[0].rev
}, {
_id: @docs[1]._id.toString()
lines: @docs[1].lines
rev: @docs[1].rev
}])
.should.equal true
describe "with a null doc", ->
beforeEach ->
@req.params =
project_id: @project_id
@docs = [{
_id: ObjectId()
lines: ["mock", "lines", "one"]
rev: 2
},
null,
{
_id: ObjectId()
lines: ["mock", "lines", "two"]
rev: 4
}]
@DocManager.getAllNonDeletedDocs = sinon.stub().callsArgWith(2, null, @docs)
@HttpController.getAllDocs @req, @res, @next
it "should return the non null docs as JSON", ->
@res.json
.calledWith([{
_id: @docs[0]._id.toString()
lines: @docs[0].lines
rev: @docs[0].rev
}, {
_id: @docs[2]._id.toString()
lines: @docs[2].lines
rev: @docs[2].rev
}])
.should.equal true
it "should log out an error", ->
@logger.error
.calledWith(
err: new Error("null doc")
project_id: @project_id
"encountered null doc"
)
.should.equal true
describe "getAllRanges", ->
describe "normally", ->
beforeEach ->
@req.params =
project_id: @project_id
@docs = [{
_id: ObjectId()
ranges: {"mock_ranges": "one"}
}, {
_id: ObjectId()
ranges: {"mock_ranges": "two"}
}]
@DocManager.getAllNonDeletedDocs = sinon.stub().callsArgWith(2, null, @docs)
@HttpController.getAllRanges @req, @res, @next
it "should get all the (non-deleted) doc ranges", ->
@DocManager.getAllNonDeletedDocs
.calledWith(@project_id, {ranges: true})
.should.equal true
it "should return the doc as JSON", ->
@res.json
.calledWith([{
_id: @docs[0]._id.toString()
ranges: @docs[0].ranges
}, {
_id: @docs[1]._id.toString()
ranges: @docs[1].ranges
}])
.should.equal true
describe "updateDoc", ->
beforeEach ->
@req.params =
project_id: @project_id
doc_id: @doc_id
describe "when the doc lines exist and were updated", ->
beforeEach ->
@req.body =
lines: @lines = ["hello", "world"]
version: @version = 42
2016-12-05 09:21:49 -05:00
ranges: @ranges = { changes: "mock" }
@DocManager.updateDoc = sinon.stub().yields(null, true, @rev = 5)
@HttpController.updateDoc @req, @res, @next
it "should update the document", ->
@DocManager.updateDoc
2016-12-05 09:21:49 -05:00
.calledWith(@project_id, @doc_id, @lines, @version, @ranges)
.should.equal true
it "should return a modified status", ->
@res.json
.calledWith(modified: true, rev: @rev)
.should.equal true
describe "when the doc lines exist and were not updated", ->
beforeEach ->
@req.body =
lines: @lines = ["hello", "world"]
version: @version = 42
ranges: {}
@DocManager.updateDoc = sinon.stub().yields(null, false, @rev = 5)
@HttpController.updateDoc @req, @res, @next
it "should return a modified status", ->
@res.json
.calledWith(modified: false, rev: @rev)
.should.equal true
describe "when the doc lines are not provided", ->
beforeEach ->
@req.body = { version: 42, ranges: {} }
@DocManager.updateDoc = sinon.stub().yields(null, false)
@HttpController.updateDoc @req, @res, @next
it "should not update the document", ->
@DocManager.updateDoc.called.should.equal false
it "should return a 400 (bad request) response", ->
@res.send
.calledWith(400)
.should.equal true
describe "when the doc version are not provided", ->
beforeEach ->
@req.body = { version: 42, lines: ["hello world"] }
@DocManager.updateDoc = sinon.stub().yields(null, false)
@HttpController.updateDoc @req, @res, @next
it "should not update the document", ->
@DocManager.updateDoc.called.should.equal false
it "should return a 400 (bad request) response", ->
@res.send
.calledWith(400)
.should.equal true
describe "when the doc ranges is not provided", ->
beforeEach ->
@req.body = { lines : [ "foo" ], version: 42 }
@DocManager.updateDoc = sinon.stub().yields(null, false)
@HttpController.updateDoc @req, @res, @next
it "should not update the document", ->
@DocManager.updateDoc.called.should.equal false
it "should return a 400 (bad request) response", ->
@res.send
.calledWith(400)
.should.equal true
describe "deleteDoc", ->
beforeEach ->
@req.params =
project_id: @project_id
doc_id: @doc_id
@DocManager.deleteDoc = sinon.stub().callsArg(2)
@HttpController.deleteDoc @req, @res, @next
it "should delete the document", ->
@DocManager.deleteDoc
.calledWith(@project_id, @doc_id)
.should.equal true
it "should return a 204 (No Content)", ->
@res.send
.calledWith(204)
.should.equal true
2015-06-02 18:24:45 -04:00
describe "archiveAllDocs", ->
beforeEach ->
@req.params =
project_id: @project_id
@DocArchiveManager.archiveAllDocs = sinon.stub().callsArg(1)
@HttpController.archiveAllDocs @req, @res, @next
it "should archive the project", ->
@DocArchiveManager.archiveAllDocs
.calledWith(@project_id)
.should.equal true
it "should return a 204 (No Content)", ->
@res.send
.calledWith(204)
.should.equal true