mirror of
https://github.com/overleaf/overleaf.git
synced 2024-12-01 19:23:57 -05:00
Update PersistenceManagerTests
This commit is contained in:
parent
fb39e37fe0
commit
9ee913be39
4 changed files with 178 additions and 198 deletions
|
@ -39,7 +39,7 @@ module.exports = PersistenceManager =
|
||||||
return callback(new Error("web API response had no doc lines"))
|
return callback(new Error("web API response had no doc lines"))
|
||||||
if !body.version? or not body.version instanceof Number
|
if !body.version? or not body.version instanceof Number
|
||||||
return callback(new Error("web API response had no valid doc version"))
|
return callback(new Error("web API response had no valid doc version"))
|
||||||
return callback null, body.lines, body.track_changes, body.track_changes_entries
|
return callback null, body.lines, body.version, body.track_changes, body.track_changes_entries
|
||||||
else if res.statusCode == 404
|
else if res.statusCode == 404
|
||||||
return callback(new Errors.NotFoundError("doc not not found: #{url}"))
|
return callback(new Errors.NotFoundError("doc not not found: #{url}"))
|
||||||
else
|
else
|
||||||
|
@ -55,13 +55,11 @@ module.exports = PersistenceManager =
|
||||||
request {
|
request {
|
||||||
url: url
|
url: url
|
||||||
method: "POST"
|
method: "POST"
|
||||||
body: JSON.stringify
|
json:
|
||||||
lines: lines
|
lines: lines
|
||||||
track_changes: track_changes
|
track_changes: track_changes
|
||||||
track_changes_entries: track_changes_entries
|
track_changes_entries: track_changes_entries
|
||||||
version: version
|
version: version
|
||||||
headers:
|
|
||||||
"content-type": "application/json"
|
|
||||||
auth:
|
auth:
|
||||||
user: Settings.apis.web.user
|
user: Settings.apis.web.user
|
||||||
pass: Settings.apis.web.pass
|
pass: Settings.apis.web.pass
|
||||||
|
|
|
@ -0,0 +1,176 @@
|
||||||
|
sinon = require('sinon')
|
||||||
|
chai = require('chai')
|
||||||
|
should = chai.should()
|
||||||
|
modulePath = "../../../../app/js/PersistenceManager.js"
|
||||||
|
SandboxedModule = require('sandboxed-module')
|
||||||
|
Errors = require "../../../../app/js/Errors"
|
||||||
|
|
||||||
|
describe "PersistenceManager", ->
|
||||||
|
beforeEach ->
|
||||||
|
@PersistenceManager = SandboxedModule.require modulePath, requires:
|
||||||
|
"request": @request = sinon.stub()
|
||||||
|
"settings-sharelatex": @Settings = {}
|
||||||
|
"./Metrics": @Metrics =
|
||||||
|
Timer: class Timer
|
||||||
|
done: sinon.stub()
|
||||||
|
"logger-sharelatex": @logger = {log: sinon.stub(), err: sinon.stub()}
|
||||||
|
@project_id = "project-id-123"
|
||||||
|
@doc_id = "doc-id-123"
|
||||||
|
@lines = ["one", "two", "three"]
|
||||||
|
@version = 42
|
||||||
|
@callback = sinon.stub()
|
||||||
|
@track_changes_on = true
|
||||||
|
@track_changes_entries = { comments: "mock", entries: "mock" }
|
||||||
|
@Settings.apis =
|
||||||
|
web:
|
||||||
|
url: @url = "www.example.com"
|
||||||
|
user: @user = "sharelatex"
|
||||||
|
pass: @pass = "password"
|
||||||
|
|
||||||
|
describe "getDoc", ->
|
||||||
|
|
||||||
|
describe "with a successful response from the web api", ->
|
||||||
|
beforeEach ->
|
||||||
|
@request.callsArgWith(1, null, {statusCode: 200}, JSON.stringify({
|
||||||
|
lines: @lines,
|
||||||
|
version: @version,
|
||||||
|
track_changes: @track_changes_on,
|
||||||
|
track_changes_entries: @track_changes_entries
|
||||||
|
}))
|
||||||
|
@PersistenceManager.getDoc(@project_id, @doc_id, @callback)
|
||||||
|
|
||||||
|
it "should call the web api", ->
|
||||||
|
@request
|
||||||
|
.calledWith({
|
||||||
|
url: "#{@url}/project/#{@project_id}/doc/#{@doc_id}"
|
||||||
|
method: "GET"
|
||||||
|
headers:
|
||||||
|
"accept": "application/json"
|
||||||
|
auth:
|
||||||
|
user: @user
|
||||||
|
pass: @pass
|
||||||
|
sendImmediately: true
|
||||||
|
jar: false
|
||||||
|
timeout: 5000
|
||||||
|
})
|
||||||
|
.should.equal true
|
||||||
|
|
||||||
|
it "should call the callback with the doc lines, version and track changes state", ->
|
||||||
|
@callback.calledWith(null, @lines, @version, @track_changes_on, @track_changes_entries).should.equal true
|
||||||
|
|
||||||
|
it "should time the execution", ->
|
||||||
|
@Metrics.Timer::done.called.should.equal true
|
||||||
|
|
||||||
|
describe "when request returns an error", ->
|
||||||
|
beforeEach ->
|
||||||
|
@request.callsArgWith(1, @error = new Error("oops"), null, null)
|
||||||
|
@PersistenceManager.getDoc(@project_id, @doc_id, @callback)
|
||||||
|
|
||||||
|
it "should return the error", ->
|
||||||
|
@callback.calledWith(@error).should.equal true
|
||||||
|
|
||||||
|
it "should time the execution", ->
|
||||||
|
@Metrics.Timer::done.called.should.equal true
|
||||||
|
|
||||||
|
describe "when the request returns 404", ->
|
||||||
|
beforeEach ->
|
||||||
|
@request.callsArgWith(1, null, {statusCode: 404}, "")
|
||||||
|
@PersistenceManager.getDoc(@project_id, @doc_id, @callback)
|
||||||
|
|
||||||
|
it "should return a NotFoundError", ->
|
||||||
|
@callback.calledWith(new Errors.NotFoundError("not found")).should.equal true
|
||||||
|
|
||||||
|
it "should time the execution", ->
|
||||||
|
@Metrics.Timer::done.called.should.equal true
|
||||||
|
|
||||||
|
describe "when the request returns an error status code", ->
|
||||||
|
beforeEach ->
|
||||||
|
@request.callsArgWith(1, null, {statusCode: 500}, "")
|
||||||
|
@PersistenceManager.getDoc(@project_id, @doc_id, @callback)
|
||||||
|
|
||||||
|
it "should return an error", ->
|
||||||
|
@callback.calledWith(new Error("web api error")).should.equal true
|
||||||
|
|
||||||
|
it "should time the execution", ->
|
||||||
|
@Metrics.Timer::done.called.should.equal true
|
||||||
|
|
||||||
|
describe "when request returns an doc without lines", ->
|
||||||
|
beforeEach ->
|
||||||
|
@request.callsArgWith(1, null, {statusCode: 200}, JSON.stringify(version: @version))
|
||||||
|
@PersistenceManager.getDoc(@project_id, @doc_id, @callback)
|
||||||
|
|
||||||
|
it "should return and error", ->
|
||||||
|
@callback.calledWith(new Error("web API response had no doc lines")).should.equal true
|
||||||
|
|
||||||
|
describe "when request returns an doc without a version", ->
|
||||||
|
beforeEach ->
|
||||||
|
@request.callsArgWith(1, null, {statusCode: 200}, JSON.stringify(lines: @lines))
|
||||||
|
@PersistenceManager.getDoc(@project_id, @doc_id, @callback)
|
||||||
|
|
||||||
|
it "should return and error", ->
|
||||||
|
@callback.calledWith(new Error("web API response had no valid doc version")).should.equal true
|
||||||
|
|
||||||
|
describe "setDoc", ->
|
||||||
|
describe "with a successful response from the web api", ->
|
||||||
|
beforeEach ->
|
||||||
|
@request.callsArgWith(1, null, {statusCode: 200})
|
||||||
|
@PersistenceManager.setDoc(@project_id, @doc_id, @lines, @version, @track_changes_on, @track_changes_entries, @callback)
|
||||||
|
|
||||||
|
it "should call the web api", ->
|
||||||
|
@request
|
||||||
|
.calledWith({
|
||||||
|
url: "#{@url}/project/#{@project_id}/doc/#{@doc_id}"
|
||||||
|
json:
|
||||||
|
lines: @lines
|
||||||
|
version: @version
|
||||||
|
track_changes: @track_changes_on
|
||||||
|
track_changes_entries: @track_changes_entries
|
||||||
|
method: "POST"
|
||||||
|
auth:
|
||||||
|
user: @user
|
||||||
|
pass: @pass
|
||||||
|
sendImmediately: true
|
||||||
|
jar: false
|
||||||
|
timeout: 5000
|
||||||
|
})
|
||||||
|
.should.equal true
|
||||||
|
|
||||||
|
it "should call the callback without error", ->
|
||||||
|
@callback.calledWith(null).should.equal true
|
||||||
|
|
||||||
|
it "should time the execution", ->
|
||||||
|
@Metrics.Timer::done.called.should.equal true
|
||||||
|
|
||||||
|
describe "when request returns an error", ->
|
||||||
|
beforeEach ->
|
||||||
|
@request.callsArgWith(1, @error = new Error("oops"), null, null)
|
||||||
|
@PersistenceManager.setDoc(@project_id, @doc_id, @lines, @version, @track_changes_on, @track_changes_entries, @callback)
|
||||||
|
|
||||||
|
it "should return the error", ->
|
||||||
|
@callback.calledWith(@error).should.equal true
|
||||||
|
|
||||||
|
it "should time the execution", ->
|
||||||
|
@Metrics.Timer::done.called.should.equal true
|
||||||
|
|
||||||
|
describe "when the request returns 404", ->
|
||||||
|
beforeEach ->
|
||||||
|
@request.callsArgWith(1, null, {statusCode: 404}, "")
|
||||||
|
@PersistenceManager.setDoc(@project_id, @doc_id, @lines, @version, @track_changes_on, @track_changes_entries, @callback)
|
||||||
|
|
||||||
|
it "should return a NotFoundError", ->
|
||||||
|
@callback.calledWith(new Errors.NotFoundError("not found")).should.equal true
|
||||||
|
|
||||||
|
it "should time the execution", ->
|
||||||
|
@Metrics.Timer::done.called.should.equal true
|
||||||
|
|
||||||
|
describe "when the request returns an error status code", ->
|
||||||
|
beforeEach ->
|
||||||
|
@request.callsArgWith(1, null, {statusCode: 500}, "")
|
||||||
|
@PersistenceManager.setDoc(@project_id, @doc_id, @lines, @version, @track_changes_on, @track_changes_entries, @callback)
|
||||||
|
|
||||||
|
it "should return an error", ->
|
||||||
|
@callback.calledWith(new Error("web api error")).should.equal true
|
||||||
|
|
||||||
|
it "should time the execution", ->
|
||||||
|
@Metrics.Timer::done.called.should.equal true
|
||||||
|
|
|
@ -1,104 +0,0 @@
|
||||||
sinon = require('sinon')
|
|
||||||
chai = require('chai')
|
|
||||||
should = chai.should()
|
|
||||||
modulePath = "../../../../app/js/PersistenceManager.js"
|
|
||||||
SandboxedModule = require('sandboxed-module')
|
|
||||||
Errors = require "../../../../app/js/Errors"
|
|
||||||
|
|
||||||
describe "PersistenceManager.getDoc", ->
|
|
||||||
beforeEach ->
|
|
||||||
@PersistenceManager = SandboxedModule.require modulePath, requires:
|
|
||||||
"request": @request = sinon.stub()
|
|
||||||
"settings-sharelatex": @Settings = {}
|
|
||||||
"./Metrics": @Metrics =
|
|
||||||
Timer: class Timer
|
|
||||||
done: sinon.stub()
|
|
||||||
"logger-sharelatex": @logger = {log: sinon.stub(), err: sinon.stub()}
|
|
||||||
@project_id = "project-id-123"
|
|
||||||
@doc_id = "doc-id-123"
|
|
||||||
@lines = ["one", "two", "three"]
|
|
||||||
@version = 42
|
|
||||||
@callback = sinon.stub()
|
|
||||||
@Settings.apis =
|
|
||||||
web:
|
|
||||||
url: @url = "www.example.com"
|
|
||||||
user: @user = "sharelatex"
|
|
||||||
pass: @pass = "password"
|
|
||||||
|
|
||||||
describe "with a successful response from the web api", ->
|
|
||||||
beforeEach ->
|
|
||||||
@request.callsArgWith(1, null, {statusCode: 200}, JSON.stringify(lines: @lines, version: @version))
|
|
||||||
@PersistenceManager.getDoc(@project_id, @doc_id, @callback)
|
|
||||||
|
|
||||||
it "should call the web api", ->
|
|
||||||
@request
|
|
||||||
.calledWith({
|
|
||||||
url: "#{@url}/project/#{@project_id}/doc/#{@doc_id}"
|
|
||||||
method: "GET"
|
|
||||||
headers:
|
|
||||||
"accept": "application/json"
|
|
||||||
auth:
|
|
||||||
user: @user
|
|
||||||
pass: @pass
|
|
||||||
sendImmediately: true
|
|
||||||
jar: false
|
|
||||||
timeout: 5000
|
|
||||||
})
|
|
||||||
.should.equal true
|
|
||||||
|
|
||||||
it "should call the callback with the doc lines and version", ->
|
|
||||||
@callback.calledWith(null, @lines, @version).should.equal true
|
|
||||||
|
|
||||||
it "should time the execution", ->
|
|
||||||
@Metrics.Timer::done.called.should.equal true
|
|
||||||
|
|
||||||
describe "when request returns an error", ->
|
|
||||||
beforeEach ->
|
|
||||||
@request.callsArgWith(1, @error = new Error("oops"), null, null)
|
|
||||||
@PersistenceManager.getDoc(@project_id, @doc_id, @callback)
|
|
||||||
|
|
||||||
it "should return the error", ->
|
|
||||||
@callback.calledWith(@error).should.equal true
|
|
||||||
|
|
||||||
it "should time the execution", ->
|
|
||||||
@Metrics.Timer::done.called.should.equal true
|
|
||||||
|
|
||||||
describe "when the request returns 404", ->
|
|
||||||
beforeEach ->
|
|
||||||
@request.callsArgWith(1, null, {statusCode: 404}, "")
|
|
||||||
@PersistenceManager.getDoc(@project_id, @doc_id, @callback)
|
|
||||||
|
|
||||||
it "should return a NotFoundError", ->
|
|
||||||
@callback.calledWith(new Errors.NotFoundError("not found")).should.equal true
|
|
||||||
|
|
||||||
it "should time the execution", ->
|
|
||||||
@Metrics.Timer::done.called.should.equal true
|
|
||||||
|
|
||||||
describe "when the request returns an error status code", ->
|
|
||||||
beforeEach ->
|
|
||||||
@request.callsArgWith(1, null, {statusCode: 500}, "")
|
|
||||||
@PersistenceManager.getDoc(@project_id, @doc_id, @callback)
|
|
||||||
|
|
||||||
it "should return an error", ->
|
|
||||||
@callback.calledWith(new Error("web api error")).should.equal true
|
|
||||||
|
|
||||||
it "should time the execution", ->
|
|
||||||
@Metrics.Timer::done.called.should.equal true
|
|
||||||
|
|
||||||
describe "when request returns an doc without lines", ->
|
|
||||||
beforeEach ->
|
|
||||||
@request.callsArgWith(1, null, {statusCode: 200}, JSON.stringify(version: @version))
|
|
||||||
@PersistenceManager.getDoc(@project_id, @doc_id, @callback)
|
|
||||||
|
|
||||||
it "should return and error", ->
|
|
||||||
@callback.calledWith(new Error("web API response had no doc lines")).should.equal true
|
|
||||||
|
|
||||||
describe "when request returns an doc without a version", ->
|
|
||||||
beforeEach ->
|
|
||||||
@request.callsArgWith(1, null, {statusCode: 200}, JSON.stringify(lines: @lines))
|
|
||||||
@PersistenceManager.getDoc(@project_id, @doc_id, @callback)
|
|
||||||
|
|
||||||
it "should return and error", ->
|
|
||||||
@callback.calledWith(new Error("web API response had no valid doc version")).should.equal true
|
|
||||||
|
|
||||||
|
|
|
@ -1,90 +0,0 @@
|
||||||
sinon = require('sinon')
|
|
||||||
chai = require('chai')
|
|
||||||
should = chai.should()
|
|
||||||
modulePath = "../../../../app/js/PersistenceManager.js"
|
|
||||||
SandboxedModule = require('sandboxed-module')
|
|
||||||
Errors = require "../../../../app/js/Errors"
|
|
||||||
|
|
||||||
describe "PersistenceManager.setDoc", ->
|
|
||||||
beforeEach ->
|
|
||||||
@PersistenceManager = SandboxedModule.require modulePath, requires:
|
|
||||||
"request": @request = sinon.stub()
|
|
||||||
"settings-sharelatex": @Settings = {}
|
|
||||||
"./Metrics": @Metrics =
|
|
||||||
Timer: class Timer
|
|
||||||
done: sinon.stub()
|
|
||||||
"logger-sharelatex": @logger = {log: sinon.stub(), err: sinon.stub()}
|
|
||||||
@project_id = "project-id-123"
|
|
||||||
@doc_id = "doc-id-123"
|
|
||||||
@lines = ["one", "two", "three"]
|
|
||||||
@version = 42
|
|
||||||
@callback = sinon.stub()
|
|
||||||
@Settings.apis =
|
|
||||||
web:
|
|
||||||
url: @url = "www.example.com"
|
|
||||||
user: @user = "sharelatex"
|
|
||||||
pass: @pass = "password"
|
|
||||||
|
|
||||||
describe "with a successful response from the web api", ->
|
|
||||||
beforeEach ->
|
|
||||||
@request.callsArgWith(1, null, {statusCode: 200}, JSON.stringify(lines: @lines, version: @version))
|
|
||||||
@PersistenceManager.setDoc(@project_id, @doc_id, @lines, @version, @callback)
|
|
||||||
|
|
||||||
it "should call the web api", ->
|
|
||||||
@request
|
|
||||||
.calledWith({
|
|
||||||
url: "#{@url}/project/#{@project_id}/doc/#{@doc_id}"
|
|
||||||
body: JSON.stringify
|
|
||||||
lines: @lines
|
|
||||||
version: @version
|
|
||||||
method: "POST"
|
|
||||||
headers:
|
|
||||||
"content-type": "application/json"
|
|
||||||
auth:
|
|
||||||
user: @user
|
|
||||||
pass: @pass
|
|
||||||
sendImmediately: true
|
|
||||||
jar: false
|
|
||||||
timeout: 5000
|
|
||||||
})
|
|
||||||
.should.equal true
|
|
||||||
|
|
||||||
it "should call the callback without error", ->
|
|
||||||
@callback.calledWith(null).should.equal true
|
|
||||||
|
|
||||||
it "should time the execution", ->
|
|
||||||
@Metrics.Timer::done.called.should.equal true
|
|
||||||
|
|
||||||
describe "when request returns an error", ->
|
|
||||||
beforeEach ->
|
|
||||||
@request.callsArgWith(1, @error = new Error("oops"), null, null)
|
|
||||||
@PersistenceManager.setDoc(@project_id, @doc_id, @lines, @version, @callback)
|
|
||||||
|
|
||||||
it "should return the error", ->
|
|
||||||
@callback.calledWith(@error).should.equal true
|
|
||||||
|
|
||||||
it "should time the execution", ->
|
|
||||||
@Metrics.Timer::done.called.should.equal true
|
|
||||||
|
|
||||||
describe "when the request returns 404", ->
|
|
||||||
beforeEach ->
|
|
||||||
@request.callsArgWith(1, null, {statusCode: 404}, "")
|
|
||||||
@PersistenceManager.setDoc(@project_id, @doc_id, @lines, @version, @callback)
|
|
||||||
|
|
||||||
it "should return a NotFoundError", ->
|
|
||||||
@callback.calledWith(new Errors.NotFoundError("not found")).should.equal true
|
|
||||||
|
|
||||||
it "should time the execution", ->
|
|
||||||
@Metrics.Timer::done.called.should.equal true
|
|
||||||
|
|
||||||
describe "when the request returns an error status code", ->
|
|
||||||
beforeEach ->
|
|
||||||
@request.callsArgWith(1, null, {statusCode: 500}, "")
|
|
||||||
@PersistenceManager.setDoc(@project_id, @doc_id, @lines, @version, @callback)
|
|
||||||
|
|
||||||
it "should return an error", ->
|
|
||||||
@callback.calledWith(new Error("web api error")).should.equal true
|
|
||||||
|
|
||||||
it "should time the execution", ->
|
|
||||||
@Metrics.Timer::done.called.should.equal true
|
|
||||||
|
|
Loading…
Reference in a new issue