overleaf/services/clsi/test/unit/js/CompileControllerTests.js

446 lines
13 KiB
JavaScript
Raw Normal View History

/* eslint-disable
no-return-assign,
no-unused-vars,
*/
// TODO: This file was created by bulk-decaffeinate.
// Fix any style issues and re-enable lint.
/*
* decaffeinate suggestions:
* DS102: Remove unnecessary code created because of implicit returns
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
*/
const SandboxedModule = require('sandboxed-module')
const sinon = require('sinon')
const { expect } = require('chai')
const modulePath = require('path').join(
__dirname,
'../../../app/js/CompileController'
)
const tk = require('timekeeper')
function tryImageNameValidation(method, imageNameField) {
describe('when allowedImages is set', function () {
beforeEach(function () {
this.Settings.clsi = { docker: {} }
this.Settings.clsi.docker.allowedImages = [
'repo/image:tag1',
2021-07-13 07:04:48 -04:00
'repo/image:tag2',
]
this.res.send = sinon.stub()
this.res.status = sinon.stub().returns({ send: this.res.send })
this.CompileManager[method].reset()
})
describe('with an invalid image', function () {
beforeEach(function () {
this.req.query[imageNameField] = 'something/evil:1337'
this.CompileController[method](this.req, this.res, this.next)
})
it('should return a 400', function () {
expect(this.res.status.calledWith(400)).to.equal(true)
})
it('should not run the query', function () {
expect(this.CompileManager[method].called).to.equal(false)
})
})
describe('with a valid image', function () {
beforeEach(function () {
this.req.query[imageNameField] = 'repo/image:tag1'
this.CompileController[method](this.req, this.res, this.next)
})
it('should not return a 400', function () {
expect(this.res.status.calledWith(400)).to.equal(false)
})
it('should run the query', function () {
expect(this.CompileManager[method].called).to.equal(true)
})
})
})
}
2020-08-10 12:01:11 -04:00
describe('CompileController', function () {
beforeEach(function () {
this.CompileController = SandboxedModule.require(modulePath, {
requires: {
'./CompileManager': (this.CompileManager = {}),
'./RequestParser': (this.RequestParser = {}),
'@overleaf/settings': (this.Settings = {
apis: {
clsi: {
outputUrl: 'http://clsi.example.com',
2021-07-13 07:04:48 -04:00
},
},
}),
2021-07-13 07:04:48 -04:00
'./ProjectPersistenceManager': (this.ProjectPersistenceManager = {}),
},
})
this.Settings.externalUrl = 'http://www.example.com'
this.req = {}
this.res = {}
return (this.next = sinon.stub())
})
2020-08-10 12:01:11 -04:00
describe('compile', function () {
beforeEach(function () {
this.req.body = {
2021-07-13 07:04:48 -04:00
compile: 'mock-body',
}
this.req.params = { project_id: (this.project_id = 'project-id-123') }
this.request = {
2021-07-13 07:04:48 -04:00
compile: 'mock-parsed-request',
}
this.request_with_project_id = {
compile: this.request.compile,
2021-07-13 07:04:48 -04:00
project_id: this.project_id,
}
this.output_files = [
{
path: 'output.pdf',
type: 'pdf',
size: 1337,
2021-07-13 07:04:48 -04:00
build: 1234,
},
{
path: 'output.log',
type: 'log',
2021-07-13 07:04:48 -04:00
build: 1234,
},
]
this.RequestParser.parse = sinon
.stub()
.callsArgWith(1, null, this.request)
this.ProjectPersistenceManager.markProjectAsJustAccessed = sinon
.stub()
.callsArg(1)
this.stats = { foo: 1 }
this.timings = { bar: 2 }
this.res.status = sinon.stub().returnsThis()
return (this.res.send = sinon.stub())
})
2020-08-10 12:01:11 -04:00
describe('successfully', function () {
beforeEach(function () {
this.CompileManager.doCompileWithLock = sinon
.stub()
.yields(null, this.output_files, this.stats, this.timings)
return this.CompileController.compile(this.req, this.res)
})
2020-08-10 12:01:11 -04:00
it('should parse the request', function () {
return this.RequestParser.parse
.calledWith(this.req.body)
.should.equal(true)
})
2020-08-10 12:01:11 -04:00
it('should run the compile for the specified project', function () {
return this.CompileManager.doCompileWithLock
.calledWith(this.request_with_project_id)
.should.equal(true)
})
2020-08-10 12:01:11 -04:00
it('should mark the project as accessed', function () {
return this.ProjectPersistenceManager.markProjectAsJustAccessed
.calledWith(this.project_id)
.should.equal(true)
})
2020-08-10 12:01:11 -04:00
return it('should return the JSON response', function () {
this.res.status.calledWith(200).should.equal(true)
return this.res.send
.calledWith({
compile: {
status: 'success',
error: null,
stats: this.stats,
timings: this.timings,
2021-07-13 07:04:48 -04:00
outputFiles: this.output_files.map(file => {
return {
url: `${this.Settings.apis.clsi.outputUrl}/project/${this.project_id}/build/${file.build}/output/${file.path}`,
2021-07-13 07:04:48 -04:00
...file,
}
2021-07-13 07:04:48 -04:00
}),
},
})
.should.equal(true)
})
})
describe('with user provided fake_output.pdf', function () {
beforeEach(function () {
this.output_files = [
{
path: 'fake_output.pdf',
type: 'pdf',
2021-07-13 07:04:48 -04:00
build: 1234,
},
{
path: 'output.log',
type: 'log',
2021-07-13 07:04:48 -04:00
build: 1234,
},
]
this.CompileManager.doCompileWithLock = sinon
.stub()
.yields(null, this.output_files, this.stats, this.timings)
this.CompileController.compile(this.req, this.res)
})
it('should return the JSON response with status failure', function () {
this.res.status.calledWith(200).should.equal(true)
this.res.send
.calledWith({
compile: {
status: 'failure',
error: null,
stats: this.stats,
timings: this.timings,
2021-07-13 07:04:48 -04:00
outputFiles: this.output_files.map(file => {
return {
url: `${this.Settings.apis.clsi.outputUrl}/project/${this.project_id}/build/${file.build}/output/${file.path}`,
2021-07-13 07:04:48 -04:00
...file,
}
2021-07-13 07:04:48 -04:00
}),
},
})
.should.equal(true)
})
})
describe('with an empty output.pdf', function () {
beforeEach(function () {
this.output_files = [
{
path: 'output.pdf',
type: 'pdf',
size: 0,
2021-07-13 07:04:48 -04:00
build: 1234,
},
{
path: 'output.log',
type: 'log',
2021-07-13 07:04:48 -04:00
build: 1234,
},
]
this.CompileManager.doCompileWithLock = sinon
.stub()
.yields(null, this.output_files, this.stats, this.timings)
this.CompileController.compile(this.req, this.res)
})
it('should return the JSON response with status failure', function () {
this.res.status.calledWith(200).should.equal(true)
this.res.send
.calledWith({
compile: {
status: 'failure',
error: null,
stats: this.stats,
timings: this.timings,
2021-07-13 07:04:48 -04:00
outputFiles: this.output_files.map(file => {
return {
url: `${this.Settings.apis.clsi.outputUrl}/project/${this.project_id}/build/${file.build}/output/${file.path}`,
2021-07-13 07:04:48 -04:00
...file,
}
2021-07-13 07:04:48 -04:00
}),
},
})
.should.equal(true)
})
})
2020-08-10 12:01:11 -04:00
describe('with an error', function () {
beforeEach(function () {
this.CompileManager.doCompileWithLock = sinon
.stub()
.callsArgWith(1, new Error((this.message = 'error message')), null)
return this.CompileController.compile(this.req, this.res)
})
2014-05-19 07:18:57 -04:00
2020-08-10 12:01:11 -04:00
return it('should return the JSON response with the error', function () {
this.res.status.calledWith(500).should.equal(true)
return this.res.send
.calledWith({
compile: {
status: 'error',
error: this.message,
outputFiles: [],
// JSON.stringify will omit these
stats: undefined,
2021-07-13 07:04:48 -04:00
timings: undefined,
},
})
.should.equal(true)
})
})
2020-08-10 12:01:11 -04:00
describe('when the request times out', function () {
beforeEach(function () {
this.error = new Error((this.message = 'container timed out'))
this.error.timedout = true
this.CompileManager.doCompileWithLock = sinon
.stub()
.callsArgWith(1, this.error, null)
return this.CompileController.compile(this.req, this.res)
})
2020-08-10 12:01:11 -04:00
return it('should return the JSON response with the timeout status', function () {
this.res.status.calledWith(200).should.equal(true)
return this.res.send
.calledWith({
compile: {
status: 'timedout',
error: this.message,
outputFiles: [],
// JSON.stringify will omit these
stats: undefined,
2021-07-13 07:04:48 -04:00
timings: undefined,
},
})
.should.equal(true)
})
})
2020-08-10 12:01:11 -04:00
return describe('when the request returns no output files', function () {
beforeEach(function () {
this.CompileManager.doCompileWithLock = sinon
.stub()
.callsArgWith(1, null, [])
return this.CompileController.compile(this.req, this.res)
})
2020-08-10 12:01:11 -04:00
return it('should return the JSON response with the failure status', function () {
this.res.status.calledWith(200).should.equal(true)
return this.res.send
.calledWith({
compile: {
error: null,
status: 'failure',
outputFiles: [],
// JSON.stringify will omit these
stats: undefined,
2021-07-13 07:04:48 -04:00
timings: undefined,
},
})
.should.equal(true)
})
})
})
2020-08-10 12:01:11 -04:00
describe('syncFromCode', function () {
beforeEach(function () {
this.file = 'main.tex'
this.line = 42
this.column = 5
this.project_id = 'mock-project-id'
this.req.params = { project_id: this.project_id }
this.req.query = {
file: this.file,
line: this.line.toString(),
2021-07-13 07:04:48 -04:00
column: this.column.toString(),
}
this.res.json = sinon.stub()
this.CompileManager.syncFromCode = sinon
.stub()
.yields(null, (this.pdfPositions = ['mock-positions']))
return this.CompileController.syncFromCode(this.req, this.res, this.next)
})
2020-08-10 12:01:11 -04:00
it('should find the corresponding location in the PDF', function () {
return this.CompileManager.syncFromCode
.calledWith(
this.project_id,
undefined,
this.file,
this.line,
this.column
)
.should.equal(true)
})
it('should return the positions', function () {
return this.res.json
.calledWith({
2021-07-13 07:04:48 -04:00
pdf: this.pdfPositions,
})
.should.equal(true)
})
tryImageNameValidation('syncFromCode', 'imageName')
})
2020-08-10 12:01:11 -04:00
describe('syncFromPdf', function () {
beforeEach(function () {
this.page = 5
this.h = 100.23
this.v = 45.67
this.project_id = 'mock-project-id'
this.req.params = { project_id: this.project_id }
this.req.query = {
page: this.page.toString(),
h: this.h.toString(),
2021-07-13 07:04:48 -04:00
v: this.v.toString(),
}
this.res.json = sinon.stub()
this.CompileManager.syncFromPdf = sinon
.stub()
.yields(null, (this.codePositions = ['mock-positions']))
return this.CompileController.syncFromPdf(this.req, this.res, this.next)
})
2020-08-10 12:01:11 -04:00
it('should find the corresponding location in the code', function () {
return this.CompileManager.syncFromPdf
.calledWith(this.project_id, undefined, this.page, this.h, this.v)
.should.equal(true)
})
it('should return the positions', function () {
return this.res.json
.calledWith({
2021-07-13 07:04:48 -04:00
code: this.codePositions,
})
.should.equal(true)
})
tryImageNameValidation('syncFromPdf', 'imageName')
})
2020-08-10 12:01:11 -04:00
return describe('wordcount', function () {
beforeEach(function () {
this.file = 'main.tex'
this.project_id = 'mock-project-id'
this.req.params = { project_id: this.project_id }
this.req.query = {
file: this.file,
2021-07-13 07:04:48 -04:00
image: (this.image = 'example.com/image'),
}
this.res.json = sinon.stub()
this.CompileManager.wordcount = sinon
.stub()
.callsArgWith(4, null, (this.texcount = ['mock-texcount']))
})
2020-08-10 12:01:11 -04:00
it('should return the word count of a file', function () {
this.CompileController.wordcount(this.req, this.res, this.next)
return this.CompileManager.wordcount
.calledWith(this.project_id, undefined, this.file, this.image)
.should.equal(true)
})
2020-08-10 12:01:11 -04:00
it('should return the texcount info', function () {
this.CompileController.wordcount(this.req, this.res, this.next)
return this.res.json
.calledWith({
2021-07-13 07:04:48 -04:00
texcount: this.texcount,
})
.should.equal(true)
})
tryImageNameValidation('wordcount', 'image')
})
})