Craftadoc/clsi
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Initial open source commit

Browse Source
This commit is contained in:
James Allen
2014-02-12 17:27:43 +00:00
commit c83b03e93f
95 changed files with 16218 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
test/acceptance/coffee/BrokenLatexFileTests.coffee Normal file
View File

@@ -0,0 +1,46 @@
Client = require "./helpers/Client"
request = require "request"
require("chai").should()
describe "Broken LaTeX file", ->
before ->
@broken_request =
resources: [
path: "main.tex"
content: '''
\\documentclass{articl % :(
\\begin{documen % :(
Broken
\\end{documen % :(
'''
]
@correct_request =
resources: [
path: "main.tex"
content: '''
\\documentclass{article}
\\begin{document}
Hello world
\\end{document}
'''
]
describe "on first run", ->
before (done) ->
@project_id = Client.randomId()
Client.compile @project_id, @broken_request, (@error, @res, @body) => done()
it "should return a failure status", ->
@body.compile.status.should.equal "failure"
describe "on second run", ->
before (done) ->
@project_id = Client.randomId()
Client.compile @project_id, @correct_request, () =>
Client.compile @project_id, @broken_request, (@error, @res, @body) =>
done()
it "should return a failure status", ->
@body.compile.status.should.equal "failure"

34
test/acceptance/coffee/DeleteOldFilesTest.coffee Normal file
View File

@@ -0,0 +1,34 @@
Client = require "./helpers/Client"
request = require "request"
require("chai").should()
describe "Deleting Old Files", ->
before ->
@request =
resources: [
path: "main.tex"
content: '''
\\documentclass{article}
\\begin{document}
Hello world
\\end{document}
'''
]
describe "on first run", ->
before (done) ->
@project_id = Client.randomId()
Client.compile @project_id, @request, (@error, @res, @body) => done()
it "should return a success status", ->
@body.compile.status.should.equal "success"
describe "after file has been deleted", ->
before (done) ->
@request.resources = []
Client.compile @project_id, @request, (@error, @res, @body) =>
done()
it "should return a failure status", ->
@body.compile.status.should.equal "failure"

79
test/acceptance/coffee/ExampleDocumentTests.coffee Normal file
View File

@@ -0,0 +1,79 @@
Client = require "./helpers/Client"
request = require "request"
require("chai").should()
fs = require "fs"
ChildProcess = require "child_process"
fixturePath = (path) -> __dirname + "/../fixtures/" + path
convertToPng = (pdfPath, pngPath, callback = (error) ->) ->
convert = ChildProcess.exec "convert #{fixturePath(pdfPath)} #{fixturePath(pngPath)}"
convert.on "exit", () ->
callback()
compare = (originalPath, generatedPath, callback = (error, same) ->) ->
proc = ChildProcess.exec "compare -metric mae #{fixturePath(originalPath)} #{fixturePath(generatedPath)} #{fixturePath("tmp/diff.png")}"
stderr = ""
proc.stderr.on "data", (chunk) -> stderr += chunk
proc.on "exit", () ->
if stderr.trim() == "0 (0)"
callback null, true
else
console.log stderr
callback null, false
compareMultiplePages = (project_id, callback = (error) ->) ->
compareNext = (page_no, callback) ->
path = "tmp/#{project_id}-source-#{page_no}.png"
fs.stat fixturePath(path), (error, stat) ->
if error?
callback()
else
compare "tmp/#{project_id}-source-#{page_no}.png", "tmp/#{project_id}-generated-#{page_no}.png", (error, same) =>
throw error if error?
same.should.equal true
compareNext page_no + 1, callback
compareNext 0, callback
downloadAndComparePdf = (project_id, example_dir, url, callback = (error) ->) ->
writeStream = fs.createWriteStream(fixturePath("tmp/#{project_id}.pdf"))
request.get(url).pipe(writeStream)
writeStream.on "close", () =>
convertToPng "tmp/#{project_id}.pdf", "tmp/#{project_id}-generated.png", (error) =>
throw error if error?
convertToPng "examples/#{example_dir}/output.pdf", "tmp/#{project_id}-source.png", (error) =>
throw error if error?
fs.stat fixturePath("tmp/#{project_id}-source-0.png"), (error, stat) =>
if error?
compare "tmp/#{project_id}-source.png", "tmp/#{project_id}-generated.png", (error, same) =>
throw error if error?
same.should.equal true
callback()
else
compareMultiplePages project_id, (error) ->
throw error if error?
callback()
Client.runServer(4242, fixturePath("examples"))
describe "Example Documents", ->
before (done) ->
ChildProcess.exec("rm test/acceptance/fixtures/tmp/*").on "exit", () -> done()
for example_dir in fs.readdirSync fixturePath("examples")
do (example_dir) ->
describe example_dir, ->
before ->
@project_id = Client.randomId()
it "should generate the correct pdf", (done) ->
Client.compileDirectory @project_id, fixturePath("examples"), example_dir, 4242, (error, res, body) =>
pdf = Client.getOutputFile body, "pdf"
downloadAndComparePdf(@project_id, example_dir, pdf.url, done)
it "should generate the correct pdf on the second run as well", (done) ->
Client.compileDirectory @project_id, fixturePath("examples"), example_dir, 4242, (error, res, body) =>
pdf = Client.getOutputFile body, "pdf"
downloadAndComparePdf(@project_id, example_dir, pdf.url, done)

39
test/acceptance/coffee/SimpleLatexFileTests.coffee Normal file
View File

@@ -0,0 +1,39 @@
Client = require "./helpers/Client"
request = require "request"
require("chai").should()
describe "Simple LaTeX file", ->
before (done) ->
@project_id = Client.randomId()
@request =
resources: [
path: "main.tex"
content: '''
\\documentclass{article}
\\begin{document}
Hello world
\\end{document}
'''
]
Client.compile @project_id, @request, (@error, @res, @body) => done()
it "should return the PDF", ->
pdf = Client.getOutputFile(@body, "pdf")
pdf.type.should.equal "pdf"
it "should return the log", ->
log = Client.getOutputFile(@body, "log")
log.type.should.equal "log"
it "should provide the pdf for download", (done) ->
pdf = Client.getOutputFile(@body, "pdf")
request.get pdf.url, (error, res, body) ->
res.statusCode.should.equal 200
done()
it "should provide the log for download", (done) ->
log = Client.getOutputFile(@body, "pdf")
request.get log.url, (error, res, body) ->
res.statusCode.should.equal 200
done()

27
test/acceptance/coffee/TimeoutTests.coffee Normal file
View File

@@ -0,0 +1,27 @@
Client = require "./helpers/Client"
request = require "request"
require("chai").should()
describe "Timed out compile", ->
before (done) ->
@request =
options:
timeout: 0.01 #seconds
resources: [
path: "main.tex"
content: '''
\\documentclass{article}
\\begin{document}
Hello world
\\end{document}
'''
]
@project_id = Client.randomId()
Client.compile @project_id, @request, (@error, @res, @body) => done()
it "should return a timeout error", ->
@body.compile.error.should.equal "container timed out"
it "should return a failure status", ->
@body.compile.status.should.equal "failure"

220
test/acceptance/coffee/UrlCachingTests.coffee Normal file
View File

@@ -0,0 +1,220 @@
Client = require "./helpers/Client"
request = require "request"
require("chai").should()
sinon = require "sinon"
host = "localhost"
Server =
run: () ->
express = require "express"
app = express()
staticServer = express.static __dirname + "/../fixtures/"
app.get "/:random_id/*", (req, res, next) =>
@getFile(req.url)
req.url = "/" + req.params[0]
staticServer(req, res, next)
app.listen 31415, host
getFile: () ->
randomId: () ->
Math.random().toString(16).slice(2)
Server.run()
describe "Url Caching", ->
describe "Downloading an image for the first time", ->
before (done) ->
@project_id = Client.randomId()
@file = "#{Server.randomId()}/lion.png"
@request =
resources: [{
path: "main.tex"
content: '''
\\documentclass{article}
\\usepackage{graphicx}
\\begin{document}
\\includegraphics{lion.png}
\\end{document}
'''
}, {
path: "lion.png"
url: "http://#{host}:31415/#{@file}"
}]
sinon.spy Server, "getFile"
Client.compile @project_id, @request, (@error, @res, @body) => done()
afterEach ->
Server.getFile.restore()
it "should download the image", ->
Server.getFile
.calledWith("/" + @file)
.should.equal true
describe "When an image is in the cache and the last modified date is unchanged", ->
before (done) ->
@project_id = Client.randomId()
@file = "#{Server.randomId()}/lion.png"
@request =
resources: [{
path: "main.tex"
content: '''
\\documentclass{article}
\\usepackage{graphicx}
\\begin{document}
\\includegraphics{lion.png}
\\end{document}
'''
}, @image_resource = {
path: "lion.png"
url: "http://#{host}:31415/#{@file}"
modified: Date.now()
}]
Client.compile @project_id, @request, (@error, @res, @body) =>
sinon.spy Server, "getFile"
Client.compile @project_id, @request, (@error, @res, @body) =>
done()
after ->
Server.getFile.restore()
it "should not download the image again", ->
Server.getFile.called.should.equal false
describe "When an image is in the cache and the last modified date is advanced", ->
before (done) ->
@project_id = Client.randomId()
@file = "#{Server.randomId()}/lion.png"
@request =
resources: [{
path: "main.tex"
content: '''
\\documentclass{article}
\\usepackage{graphicx}
\\begin{document}
\\includegraphics{lion.png}
\\end{document}
'''
}, @image_resource = {
path: "lion.png"
url: "http://#{host}:31415/#{@file}"
modified: @last_modified = Date.now()
}]
Client.compile @project_id, @request, (@error, @res, @body) =>
sinon.spy Server, "getFile"
@image_resource.modified = new Date(@last_modified + 3000)
Client.compile @project_id, @request, (@error, @res, @body) =>
done()
afterEach ->
Server.getFile.restore()
it "should download the image again", ->
Server.getFile.called.should.equal true
describe "When an image is in the cache and the last modified date is further in the past", ->
before (done) ->
@project_id = Client.randomId()
@file = "#{Server.randomId()}/lion.png"
@request =
resources: [{
path: "main.tex"
content: '''
\\documentclass{article}
\\usepackage{graphicx}
\\begin{document}
\\includegraphics{lion.png}
\\end{document}
'''
}, @image_resource = {
path: "lion.png"
url: "http://#{host}:31415/#{@file}"
modified: @last_modified = Date.now()
}]
Client.compile @project_id, @request, (@error, @res, @body) =>
sinon.spy Server, "getFile"
@image_resource.modified = new Date(@last_modified - 3000)
Client.compile @project_id, @request, (@error, @res, @body) =>
done()
afterEach ->
Server.getFile.restore()
it "should not download the image again", ->
Server.getFile.called.should.equal false
describe "When an image is in the cache and the last modified date is not specified", ->
before (done) ->
@project_id = Client.randomId()
@file = "#{Server.randomId()}/lion.png"
@request =
resources: [{
path: "main.tex"
content: '''
\\documentclass{article}
\\usepackage{graphicx}
\\begin{document}
\\includegraphics{lion.png}
\\end{document}
'''
}, @image_resource = {
path: "lion.png"
url: "http://#{host}:31415/#{@file}"
modified: @last_modified = Date.now()
}]
Client.compile @project_id, @request, (@error, @res, @body) =>
sinon.spy Server, "getFile"
delete @image_resource.modified
Client.compile @project_id, @request, (@error, @res, @body) =>
done()
afterEach ->
Server.getFile.restore()
it "should download the image again", ->
Server.getFile.called.should.equal true
describe "After clearing the cache", ->
before (done) ->
@project_id = Client.randomId()
@file = "#{Server.randomId()}/lion.png"
@request =
resources: [{
path: "main.tex"
content: '''
\\documentclass{article}
\\usepackage{graphicx}
\\begin{document}
\\includegraphics{lion.png}
\\end{document}
'''
}, @image_resource = {
path: "lion.png"
url: "http://#{host}:31415/#{@file}"
modified: @last_modified = Date.now()
}]
Client.compile @project_id, @request, (error) =>
throw error if error?
Client.clearCache @project_id, (error, res, body) =>
throw error if error?
sinon.spy Server, "getFile"
Client.compile @project_id, @request, (@error, @res, @body) =>
done()
afterEach ->
Server.getFile.restore()
it "should download the image again", ->
Server.getFile.called.should.equal true

69
test/acceptance/coffee/helpers/Client.coffee Normal file
View File

@@ -0,0 +1,69 @@
request = require "request"
fs = require "fs"
Settings = require "../../../../app/js/Settings"
host = "localhost"
module.exports = Client =
host: Settings.externalUrl
randomId: () ->
Math.random().toString(16).slice(2)
compile: (project_id, data, callback = (error, res, body) ->) ->
request.post {
url: "#{@host}/project/#{project_id}/compile"
json:
compile: data
}, callback
clearCache: (project_id, callback = (error, res, body) ->) ->
request.del "#{@host}/project/#{project_id}", callback
getOutputFile: (response, type) ->
for file in response.compile.outputFiles
if file.type == type
return file
return null
runServer: (port, directory) ->
express = require("express")
app = express()
app.use express.static(directory)
app.listen(port, host)
compileDirectory: (project_id, baseDirectory, directory, serverPort, callback = (error, res, body) ->) ->
resources = []
entities = fs.readdirSync("#{baseDirectory}/#{directory}")
rootResourcePath = "main.tex"
while (entities.length > 0)
entity = entities.pop()
stat = fs.statSync("#{baseDirectory}/#{directory}/#{entity}")
if stat.isDirectory()
entities = entities.concat fs.readdirSync("#{baseDirectory}/#{directory}/#{entity}").map (subEntity) ->
if subEntity == "main.tex"
rootResourcePath = "#{entity}/#{subEntity}"
return "#{entity}/#{subEntity}"
else if stat.isFile() and entity != "output.pdf"
extension = entity.split(".").pop()
if ["tex", "bib", "cls", "sty", "pdf_tex", "Rtex"].indexOf(extension) > -1
resources.push
path: entity
content: fs.readFileSync("#{baseDirectory}/#{directory}/#{entity}").toString()
else if ["eps", "ttf", "png", "jpg", "pdf", "jpeg"].indexOf(extension) > -1
resources.push
path: entity
url: "http://#{host}:#{serverPort}/#{directory}/#{entity}"
modified: stat.mtime
fs.readFile "#{baseDirectory}/#{directory}/options.json", (error, body) =>
req =
resources: resources
rootResourcePath: rootResourcePath
if !error?
body = JSON.parse body
req.options = body
@compile project_id, req, callback

9
test/acceptance/fixtures/examples/biber_bibliography/bibliography.bib Normal file
View File

@@ -0,0 +1,9 @@
@book{DouglasAdams,
title={The Hitchhiker's Guide to the Galaxy},
author={Adams, Douglas},
isbn={9781417642595},
url={http://books.google.com/books?id=W-xMPgAACAAJ},
year={1995},
publisher={San Val}
}

12
test/acceptance/fixtures/examples/biber_bibliography/main.tex Normal file
View File

@@ -0,0 +1,12 @@
\documentclass{article}
\usepackage[backend=biber]{biblatex}
\addbibresource{bibliography.bib}
\begin{document}
The meaning of life, the universe and everything is 42 \cite{DouglasAdams}
\printbibliography
\end{document}

48
test/acceptance/fixtures/examples/biber_bibliography/output.bbl Normal file
View File

@@ -0,0 +1,48 @@
% $ biblatex auxiliary file $
% $ biblatex version 1.5 $
% $ biber version 0.9.3 $
% Do not modify the above lines!
%
% This is an auxiliary file used by the 'biblatex' package.
% This file may safely be deleted. It will be recreated by
% biber or bibtex as required.
%
\begingroup
\makeatletter
\@ifundefined{ver@biblatex.sty}
{\@latex@error
{Missing 'biblatex' package}
{The bibliography requires the 'biblatex' package.}
\aftergroup\endinput}
{}
\endgroup
\refsection{0}
\entry{DouglasAdams}{book}{}
\name{labelname}{1}{}{%
{{}{Adams}{A\bibinitperiod}{Douglas}{D\bibinitperiod}{}{}{}{}}%
}
\name{author}{1}{}{%
{{}{Adams}{A\bibinitperiod}{Douglas}{D\bibinitperiod}{}{}{}{}}%
}
\list{publisher}{1}{%
{San Val}%
}
\strng{namehash}{AD1}
\strng{fullhash}{AD1}
\field{sortinit}{A}
\field{isbn}{9781417642595}
\field{title}{The Hitchhiker's Guide to the Galaxy}
\field{year}{1995}
\verb{url}
\verb http://books.google.com/books?id=W-xMPgAACAAJ
\endverb
\endentry
\lossort
\endlossort
\endrefsection
\endinput

BIN
test/acceptance/fixtures/examples/biber_bibliography/output.pdf Normal file
View File

Binary file not shown.

84
test/acceptance/fixtures/examples/biber_bibliography/output.run.xml Normal file
View File

@@ -0,0 +1,84 @@
<?xml version="1.0" standalone="yes"?>
<!-- logreq request file -->
<!-- logreq version 1.0 / dtd version 1.0 -->
<!-- Do not edit this file! -->
<!DOCTYPE requests [
<!ELEMENT requests (internal | external)*>
<!ELEMENT internal (generic, (provides | requires)*)>
<!ELEMENT external (generic, cmdline?, input?, output?, (provides | requires)*)>
<!ELEMENT cmdline (binary, (option | infile | outfile)*)>
<!ELEMENT input (file)+>
<!ELEMENT output (file)+>
<!ELEMENT provides (file)+>
<!ELEMENT requires (file)+>
<!ELEMENT generic (#PCDATA)>
<!ELEMENT binary (#PCDATA)>
<!ELEMENT option (#PCDATA)>
<!ELEMENT infile (#PCDATA)>
<!ELEMENT outfile (#PCDATA)>
<!ELEMENT file (#PCDATA)>
<!ATTLIST requests
version CDATA #REQUIRED
>
<!ATTLIST internal
package CDATA #REQUIRED
priority (9) #REQUIRED
active (0 | 1) #REQUIRED
>
<!ATTLIST external
package CDATA #REQUIRED
priority (1 | 2 | 3 | 4 | 5 | 6 | 7 | 8) #REQUIRED
active (0 | 1) #REQUIRED
>
<!ATTLIST provides
type (static | dynamic | editable) #REQUIRED
>
<!ATTLIST requires
type (static | dynamic | editable) #REQUIRED
>
<!ATTLIST file
type CDATA #IMPLIED
>
]>
<requests version="1.0">
<internal package="biblatex" priority="9" active="0">
<generic>latex</generic>
<provides type="dynamic">
<file>output.bcf</file>
</provides>
<requires type="dynamic">
<file>output.bbl</file>
</requires>
<requires type="static">
<file>blx-compat.def</file>
<file>biblatex.def</file>
<file>numeric.bbx</file>
<file>standard.bbx</file>
<file>numeric.cbx</file>
<file>biblatex.cfg</file>
<file>english.lbx</file>
</requires>
</internal>
<external package="biblatex" priority="5" active="0">
<generic>biber</generic>
<cmdline>
<binary>biber</binary>
<infile>output</infile>
</cmdline>
<input>
<file>output.bcf</file>
</input>
<output>
<file>output.bbl</file>
</output>
<provides type="dynamic">
<file>output.bbl</file>
</provides>
<requires type="dynamic">
<file>output.bcf</file>
</requires>
<requires type="editable">
<file>bibliography.bib</file>
</requires>
</external>
</requests>

BIN
test/acceptance/fixtures/examples/epstopdf/image-eps-converted-to.pdf Normal file
View File

Binary file not shown.

6673
test/acceptance/fixtures/examples/epstopdf/image.eps Normal file
View File

File diff suppressed because it is too large Load Diff

10
test/acceptance/fixtures/examples/epstopdf/main.tex Normal file
View File

@@ -0,0 +1,10 @@
\documentclass{article}
\usepackage{graphicx}
\usepackage{epstopdf}
\begin{document}
\includegraphics[width=\textwidth]{image}
\end{document}

BIN
test/acceptance/fixtures/examples/epstopdf/output.pdf Normal file
View File

Binary file not shown.

28
test/acceptance/fixtures/examples/feynmf/main.tex Normal file
View File

@@ -0,0 +1,28 @@
\documentclass[a4paper]{article}
\usepackage{feynmf}
\begin{document}
\setlength{\unitlength}{1mm}
\begin{fmffile}{diagram}
\begin{center}
\begin{fmfgraph*}(41,17)
\fmfleftn{i}{2}
\fmfrightn{o}{2}
\fmflabel{$g_2$}{i1}
\fmflabel{$g_1$}{i2}
\fmflabel{$p_2$}{o1}
\fmflabel{$p_1$}{o2}
\fmf{quark}{i1,v1}
\fmf{quark}{i2,v1}
\fmfblob{.35w}{v1}
\fmf{quark}{v1,o1}
\fmf{quark}{v1,o2}
\end{fmfgraph*}
\end{center}
\end{fmffile}
\end{document}

BIN
test/acceptance/fixtures/examples/feynmf/output.pdf Normal file
View File

Binary file not shown.

28
test/acceptance/fixtures/examples/feynmp/main.tex Normal file
View File

@@ -0,0 +1,28 @@
\documentclass[a4paper]{article}
\usepackage{feynmp}
\begin{document}
\setlength{\unitlength}{1mm}
\begin{fmffile}{diagram}
\begin{center}
\begin{fmfgraph*}(41,17)
\fmfleftn{i}{2}
\fmfrightn{o}{2}
\fmflabel{$g_2$}{i1}
\fmflabel{$g_1$}{i2}
\fmflabel{$p_2$}{o1}
\fmflabel{$p_1$}{o2}
\fmf{quark}{i1,v1}
\fmf{quark}{i2,v1}
\fmfblob{.35w}{v1}
\fmf{quark}{v1,o1}
\fmf{quark}{v1,o2}
\end{fmfgraph*}
\end{center}
\end{fmffile}
\end{document}

3
test/acceptance/fixtures/examples/feynmp/options.json Normal file
View File

@@ -0,0 +1,3 @@
{
"compiler": "latex"
}

BIN
test/acceptance/fixtures/examples/feynmp/output.pdf Normal file
View File

Binary file not shown.

17
test/acceptance/fixtures/examples/glossaries/main.tex Normal file
View File

@@ -0,0 +1,17 @@
\documentclass{article}
\usepackage{glossaries}
\makeglossaries
\newglossaryentry{Physics}{
name=Physics,
description={is the study of stuff}
}
\begin{document}
To solve various problems in \Gls{Physics} it can useful to express any arbitrary piecewise-smooth function as a Fourier Series composed of multiple sine and cosine funcions.
\printglossaries
\end{document}

7
test/acceptance/fixtures/examples/glossaries/output.glg Normal file
View File

@@ -0,0 +1,7 @@
This is makeindex, version 2.15 [TeX Live 2011] (kpathsea + Thai support).
Scanning style file ./output.ist...........................done (27 attributes redefined, 0 ignored).
Scanning input file output.glo....done (1 entries accepted, 0 rejected).
Sorting entries...done (0 comparisons).
Generating output file output.gls....done (6 lines written, 0 warnings).
Output written in output.gls.
Transcript written in output.glg.

1
test/acceptance/fixtures/examples/glossaries/output.glo Normal file
View File

@@ -0,0 +1 @@
\glossaryentry{Physics?\glossaryentryfield{Physics}{\glsnamefont{Physics}}{is the study of stuff}{\relax }|setentrycounter[]{page}\glsnumberformat}{1}

6
test/acceptance/fixtures/examples/glossaries/output.gls Normal file
View File

@@ -0,0 +1,6 @@
\glossarysection[\glossarytoctitle]{\glossarytitle}\glossarypreamble
\begin{theglossary}\glossaryheader
\glsgroupheading{P}\relax \glsresetentrylist %
\glossaryentryfield{Physics}{\glsnamefont{Physics}}{is the study of stuff}{\relax }{\glossaryentrynumbers{\relax
\setentrycounter[]{page}\glsnumberformat{1}}}%
\end{theglossary}\glossarypostamble

29
test/acceptance/fixtures/examples/glossaries/output.ist Normal file
View File

@@ -0,0 +1,29 @@
% makeindex style file created by the glossaries package
% for document 'output' on 2013-7-28
actual '?'
encap '|'
level '!'
quote '"'
keyword "\\glossaryentry"
preamble "\\glossarysection[\\glossarytoctitle]{\\glossarytitle}\\glossarypreamble\n\\begin{theglossary}\\glossaryheader\n"
postamble "\%\n\\end{theglossary}\\glossarypostamble\n"
group_skip "\\glsgroupskip\n"
item_0 "\%\n"
item_1 "\%\n"
item_2 "\%\n"
item_01 "\%\n"
item_x1 "\\relax \\glsresetentrylist\n"
item_12 "\%\n"
item_x2 "\\relax \\glsresetentrylist\n"
delim_0 "\{\\glossaryentrynumbers\{\\relax "
delim_1 "\{\\glossaryentrynumbers\{\\relax "
delim_2 "\{\\glossaryentrynumbers\{\\relax "
delim_t "\}\}"
delim_n "\\delimN "
delim_r "\\delimR "
headings_flag 1
heading_prefix "\\glsgroupheading\{"
heading_suffix "\}\\relax \\glsresetentrylist "
symhead_positive "glssymbols"
numhead_positive "glsnumbers"
page_compositor "."

BIN
test/acceptance/fixtures/examples/glossaries/output.pdf Normal file
View File

Binary file not shown.

26
test/acceptance/fixtures/examples/gnuplot/main.tex Normal file
View File

@@ -0,0 +1,26 @@
\documentclass{article}
\usepackage{pgfplots}
\usepackage{nopageno}
\pgfplotsset{compat=newest}
\begin{document}
\begin{tikzpicture}
\begin{axis}
\addplot +[no markers,
raw gnuplot,
thick,
empty line = jump
] gnuplot {
set contour base;
set cntrparam levels discrete 0.003;
unset surface;
set view map;
set isosamples 500;
splot x**3-3*x+3-y**2;
};
\end{axis}
\end{tikzpicture}
\end{document}

BIN
test/acceptance/fixtures/examples/gnuplot/output.pdf Normal file
View File

Binary file not shown.

13
test/acceptance/fixtures/examples/knitr/main.Rtex Normal file
View File

@@ -0,0 +1,13 @@
\documentclass{article}
\begin{document}
Hello world $x^2 = 0$.
%% chunk options: cache this chunk
%% begin.rcode my-cache, cache=TRUE
% set.seed(123)
% x = runif(10)
% sd(x) # standard deviation
%% end.rcode
\end{document}

BIN
test/acceptance/fixtures/examples/knitr/output.pdf Normal file
View File

Binary file not shown.

6673
test/acceptance/fixtures/examples/latex_compiler/image.eps Normal file
View File

File diff suppressed because it is too large Load Diff

9
test/acceptance/fixtures/examples/latex_compiler/main.tex Normal file
View File

@@ -0,0 +1,9 @@
\documentclass{article}
\usepackage{graphicx}
\begin{document}
\includegraphics[width=\textwidth]{image.eps}
\end{document}

3
test/acceptance/fixtures/examples/latex_compiler/options.json Normal file
View File

@@ -0,0 +1,3 @@
{
"compiler": "latex"
}

BIN
test/acceptance/fixtures/examples/latex_compiler/output.dvi Normal file
View File

Binary file not shown.

BIN
test/acceptance/fixtures/examples/latex_compiler/output.pdf Normal file
View File

Binary file not shown.

8
test/acceptance/fixtures/examples/lualatex_compiler/main.tex Normal file
View File

@@ -0,0 +1,8 @@
\documentclass{article}
\usepackage{luacode}
\begin{document}
\begin{luacode}
tex.print("Hello world")
\end{luacode}
\end{document}

3
test/acceptance/fixtures/examples/lualatex_compiler/options.json Normal file
View File

@@ -0,0 +1,3 @@
{
"compiler": "lualatex"
}

BIN
test/acceptance/fixtures/examples/lualatex_compiler/output.pdf Normal file
View File

Binary file not shown.

12
test/acceptance/fixtures/examples/makeindex/main.tex Normal file
View File

@@ -0,0 +1,12 @@
\documentclass{article}
\usepackage{makeidx}
\makeindex
\begin{document}
To solve various problems in Physics \index{Physics} it can useful to express any arbitrary piecewise-smooth function as a Fourier Series \index{Fourier Series} composed of multiple sine and cosine funcions.
\printindex
\end{document}

BIN
test/acceptance/fixtures/examples/makeindex/output.pdf Normal file
View File

Binary file not shown.

10
test/acceptance/fixtures/examples/minted/main.tex Normal file
View File

@@ -0,0 +1,10 @@
\documentclass{article}
\usepackage{minted}
\begin{document}
\begin{minted}{c}
int main() {
printf("hello, world");
return 0;
}
\end{minted}
\end{document}

BIN
test/acceptance/fixtures/examples/minted/output.pdf Normal file
View File

Binary file not shown.

15
test/acceptance/fixtures/examples/multibib_bibliography/bibliography.bib Normal file
View File

@@ -0,0 +1,15 @@
@book{DouglasAdams,
title={The Hitchhiker's Guide to the Galaxy},
author={Adams, Douglas},
isbn={9781417642595},
url={http://books.google.com/books?id=W-xMPgAACAAJ},
year={1995},
publisher={San Val}
}
@book{Tolkien,
title={The Hobbit},
author={Tolkien, J. R. R.},
year={1904?}
}

23
test/acceptance/fixtures/examples/multibib_bibliography/main.tex Normal file
View File

@@ -0,0 +1,23 @@
\documentclass{report}
\usepackage{multibib}
\newcites{one}{First references}
\begin{document}
\chapter{First chapter}
The answer to life the universe and everything is 42 \citeone{DouglasAdams}
\bibliographystyleone{plain}
\bibliographyone{bibliography}
\chapter{Second chapter}
All that glitters is not gold \cite{Tolkien}
\bibliographystyle{plain}
\bibliography{bibliography}
\end{document}

8
test/acceptance/fixtures/examples/multibib_bibliography/one.bbl Normal file
View File

@@ -0,0 +1,8 @@
\begin{thebibliography}{1}
\bibitem{DouglasAdams}
Douglas Adams.
\newblock {\em The Hitchhiker's Guide to the Galaxy}.
\newblock San Val, 1995.
\end{thebibliography}

8
test/acceptance/fixtures/examples/multibib_bibliography/output.bbl Normal file
View File

@@ -0,0 +1,8 @@
\begin{thebibliography}{1}
\bibitem{Tolkien}
J.~R.~R. Tolkien.
\newblock {\em The Hobbit}.
\newblock 1904?
\end{thebibliography}

BIN
test/acceptance/fixtures/examples/multibib_bibliography/output.pdf Normal file
View File

Binary file not shown.

1
test/acceptance/fixtures/examples/references_in_include/chapter1.tex Normal file
View File

@@ -0,0 +1 @@
\ref{two}

2
test/acceptance/fixtures/examples/references_in_include/chapter2.tex Normal file
View File

@@ -0,0 +1,2 @@
\section{Two}
\label{two}

8
test/acceptance/fixtures/examples/references_in_include/main.tex Normal file
View File

@@ -0,0 +1,8 @@
\documentclass{article}
\begin{document}
\include{chapter1}
\include{chapter2}
\end{document}

BIN
test/acceptance/fixtures/examples/references_in_include/output.pdf Normal file
View File

Binary file not shown.

9
test/acceptance/fixtures/examples/simple_bibliography/bibliography.bib Normal file
View File

@@ -0,0 +1,9 @@
@book{DouglasAdams,
title={The Hitchhiker's Guide to the Galaxy},
author={Adams, Douglas},
isbn={9781417642595},
url={http://books.google.com/books?id=W-xMPgAACAAJ},
year={1995},
publisher={San Val}
}

10
test/acceptance/fixtures/examples/simple_bibliography/main.tex Normal file
View File

@@ -0,0 +1,10 @@
\documentclass{article}
\begin{document}
The meaning of life, the universe and everything is 42 \cite{DouglasAdams}
\bibliographystyle{plain}
\bibliography{bibliography}
\end{document}

8
test/acceptance/fixtures/examples/simple_bibliography/output.bbl Normal file
View File

@@ -0,0 +1,8 @@
\begin{thebibliography}{1}
\bibitem{DouglasAdams}
Douglas Adams.
\newblock {\em The Hitchhiker's Guide to the Galaxy}.
\newblock San Val, 1995.
\end{thebibliography}

BIN
test/acceptance/fixtures/examples/simple_bibliography/output.pdf Normal file
View File

Binary file not shown.

1
test/acceptance/fixtures/examples/subdirectories/chapter2.tex Normal file
View File

@@ -0,0 +1 @@
This is chapter2.tex, included from main.tex. It's not in the same directory but can still be found.

BIN
test/acceptance/fixtures/examples/subdirectories/output.pdf Normal file
View File

Binary file not shown.

10
test/acceptance/fixtures/examples/subdirectories/subdirectory/bibliography.bib Normal file
View File

@@ -0,0 +1,10 @@
@book{DouglasAdams,
title={The Hitchhiker's Guide to the Galaxy},
author={Adams, Douglas},
isbn={9781417642595},
url={http://books.google.com/books?id=W-xMPgAACAAJ},
year={1995},
publisher={San Val}
}

1
test/acceptance/fixtures/examples/subdirectories/subdirectory/chapter1.tex Normal file
View File

@@ -0,0 +1 @@
This is chapter1.tex, included from main.tex

BIN
test/acceptance/fixtures/examples/subdirectories/subdirectory/image.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 10 KiB

19
test/acceptance/fixtures/examples/subdirectories/subdirectory/main.tex Normal file
View File

@@ -0,0 +1,19 @@
\documentclass{article}
\usepackage{graphicx}
\begin{document}
Hello world, I'm in a subdirectory \cite{DouglasAdams}
\input{chapter1.tex}
\input{chapter2.tex}
\begin{centering}
\includegraphics[width=0.5\textwidth]{image.png}
\end{centering}
\bibliographystyle{plain}
\bibliography{bibliography}
\end{document}

BIN
test/acceptance/fixtures/examples/xelatex_compiler/Zapfino.ttf Normal file
View File

Binary file not shown.

7
test/acceptance/fixtures/examples/xelatex_compiler/main.tex Normal file
View File

@@ -0,0 +1,7 @@
\documentclass[11pt]{article}
\usepackage{fontspec}
\setmainfont[Ligatures=TeX]{Zapfino.ttf}
\begin{document}
The quick brown fox jumps over the lazy dog
\end{document}

3
test/acceptance/fixtures/examples/xelatex_compiler/options.json Normal file
View File

@@ -0,0 +1,3 @@
{
"compiler": "xelatex"
}

BIN
test/acceptance/fixtures/examples/xelatex_compiler/output.pdf Normal file
View File

Binary file not shown.

BIN
test/acceptance/fixtures/lion.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.3 KiB

35
test/smoke/coffee/SmokeTests.coffee Normal file
View File

@@ -0,0 +1,35 @@
chai = require("chai")
chai.should()
expect = chai.expect
request = require "request"
Settings = require "../../../app/js/Settings"
buildUrl = (path) -> "http://localhost:#{Settings.listen.port}/#{path}"
describe "Running a compile", ->
before (done) ->
request.post {
url: buildUrl("project/smoketest/compile")
json:
compile:
resources: [
path: "main.tex"
content: """
\\documentclass{article}
\\begin{document}
Hello world
\\end{document}
"""
]
}, (@error, @response, @body) =>
done()
it "should return the pdf", ->
for file in @body.compile.outputFiles
return if file.type == "pdf"
throw new Error("no pdf returned")
it "should return the log", ->
for file in @body.compile.outputFiles
return if file.type == "log"
throw new Error("no log returned")

64
test/smoke/js/SmokeTests.js Normal file
View File

@@ -0,0 +1,64 @@
(function() {
var Settings, buildUrl, chai, expect, request;
chai = require("chai");
chai.should();
expect = chai.expect;
request = require("request");
Settings = require("../../../app/js/Settings");
buildUrl = function(path) {
return "http://localhost:" + Settings.listen.port + "/" + path;
};
describe("Running a compile", function() {
before(function(done) {
var _this = this;
return request.post({
url: buildUrl("project/smoketest/compile"),
json: {
compile: {
resources: [
{
path: "main.tex",
content: "\\documentclass{article}\n\\begin{document}\nHello world\n\\end{document}"
}
]
}
}
}, function(error, response, body) {
_this.error = error;
_this.response = response;
_this.body = body;
return done();
});
});
it("should return the pdf", function() {
var file, _i, _len, _ref;
_ref = this.body.compile.outputFiles;
for (_i = 0, _len = _ref.length; _i < _len; _i++) {
file = _ref[_i];
if (file.type === "pdf") {
return;
}
}
throw new Error("no pdf returned");
});
return it("should return the log", function() {
var file, _i, _len, _ref;
_ref = this.body.compile.outputFiles;
for (_i = 0, _len = _ref.length; _i < _len; _i++) {
file = _ref[_i];
if (file.type === "log") {
return;
}
}
throw new Error("no log returned");
});
});
}).call(this);

92
test/unit/coffee/CompileControllerTests.coffee Normal file
View File

@@ -0,0 +1,92 @@
SandboxedModule = require('sandboxed-module')
sinon = require('sinon')
require('chai').should()
modulePath = require('path').join __dirname, '../../../app/js/CompileController'
tk = require("timekeeper")
describe "CompileController", ->
beforeEach ->
@CompileController = SandboxedModule.require modulePath, requires:
"./CompileManager": @CompileManager = {}
"./RequestParser": @RequestParser = {}
"settings-sharelatex": @Settings =
apis:
clsi:
url: "http://clsi.example.com"
"./ProjectPersistenceManager": @ProjectPersistenceManager = {}
"logger-sharelatex": @logger = { log: sinon.stub(), error: sinon.stub() }
@Settings.externalUrl = "http://www.example.com"
@req = {}
@res = {}
describe "compile", ->
beforeEach ->
@req.body = {
compile: "mock-body"
}
@req.params =
project_id: @project_id = "project-id-123"
@request = {
compile: "mock-parsed-request"
}
@request_with_project_id =
compile: @request.compile
project_id: @project_id
@output_files = [{
path: "output.pdf"
type: "pdf"
}, {
path: "output.log"
type: "log"
}]
@RequestParser.parse = sinon.stub().callsArgWith(1, null, @request)
@ProjectPersistenceManager.markProjectAsJustAccessed = sinon.stub().callsArg(1)
@res.send = sinon.stub()
describe "successfully", ->
beforeEach ->
@CompileManager.doCompile = sinon.stub().callsArgWith(1, null, @output_files)
@CompileController.compile @req, @res
it "should parse the request", ->
@RequestParser.parse
.calledWith(@req.body)
.should.equal true
it "should run the compile for the specified project", ->
@CompileManager.doCompile
.calledWith(@request_with_project_id)
.should.equal true
it "should mark the project as accessed", ->
@ProjectPersistenceManager.markProjectAsJustAccessed
.calledWith(@project_id)
.should.equal true
it "should return the JSON response", ->
@res.send
.calledWith(JSON.stringify
compile:
status: "success"
error: null
outputFiles: @output_files.map (file) =>
url: "#{@Settings.apis.clsi.url}/project/#{@project_id}/output/#{file.path}"
type: file.type
)
.should.equal true
describe "with an error", ->
beforeEach ->
@CompileManager.doCompile = sinon.stub().callsArgWith(1, new Error(@message = "error message"), null)
@CompileController.compile @req, @res
it "should return the JSON response with the error", ->
@res.send
.calledWith(JSON.stringify
compile:
status: "failure"
error: @message
outputFiles: []
)
.should.equal true

73
test/unit/coffee/CompileManagerTests.coffee Normal file
View File

@@ -0,0 +1,73 @@
SandboxedModule = require('sandboxed-module')
sinon = require('sinon')
require('chai').should()
modulePath = require('path').join __dirname, '../../../app/js/CompileManager'
tk = require("timekeeper")
describe "CompileManager", ->
beforeEach ->
@CompileManager = SandboxedModule.require modulePath, requires:
"./LatexRunner": @LatexRunner = {}
"./ResourceWriter": @ResourceWriter = {}
"./OutputFileFinder": @OutputFileFinder = {}
"settings-sharelatex": @Settings = { path: compilesDir: "/compiles/dir" }
"logger-sharelatex": @logger = { log: sinon.stub() }
"rimraf": @rimraf = sinon.stub().callsArg(1)
@callback = sinon.stub()
describe "doCompile", ->
beforeEach ->
@output_files = [{
path: "output.log"
type: "log"
}, {
path: "output.pdf"
type: "pdf"
}]
@request =
resources: @resources = "mock-resources"
rootResourcePath: @rootResourcePath = "main.tex"
project_id: @project_id = "project-id-123"
compiler: @compiler = "pdflatex"
timeout: @timeout = 42000
@Settings.compileDir = "compiles"
@compileDir = "#{@Settings.path.compilesDir}/#{@project_id}"
@ResourceWriter.syncResourcesToDisk = sinon.stub().callsArg(3)
@LatexRunner.runLatex = sinon.stub().callsArg(2)
@OutputFileFinder.findOutputFiles = sinon.stub().callsArgWith(2, null, @output_files)
@CompileManager.doCompile @request, @callback
it "should write the resources to disk", ->
@ResourceWriter.syncResourcesToDisk
.calledWith(@project_id, @resources, @compileDir)
.should.equal true
it "should run LaTeX", ->
@LatexRunner.runLatex
.calledWith(@project_id, {
directory: @compileDir
mainFile: @rootResourcePath
compiler: @compiler
timeout: @timeout
})
.should.equal true
it "should find the output files", ->
@OutputFileFinder.findOutputFiles
.calledWith(@resources, @compileDir)
.should.equal true
it "should return the output files", ->
@callback.calledWith(null, @output_files).should.equal true
describe "clearProject", ->
beforeEach ->
@Settings.compileDir = "compiles"
@CompileManager.clearProject @project_id, @callback
it "should remove the project directory", ->
@rimraf.calledWith("#{@Settings.compileDir}/#{@project_id}")
.should.equal true
it "should call the callback", ->
@callback.called.should.equal true

56
test/unit/coffee/LatexRunnerTests.coffee Normal file
View File

@@ -0,0 +1,56 @@
SandboxedModule = require('sandboxed-module')
sinon = require('sinon')
require('chai').should()
modulePath = require('path').join __dirname, '../../../app/js/LatexRunner'
Path = require "path"
describe "LatexRunner", ->
beforeEach ->
@LatexRunner = SandboxedModule.require modulePath, requires:
"settings-sharelatex": @Settings =
docker:
socketPath: "/var/run/docker.sock"
"logger-sharelatex": @logger = { log: sinon.stub(), error: sinon.stub() }
"./Metrics":
Timer: class Timer
done: () ->
"./CommandRunner": @CommandRunner = {}
@directory = "/local/compile/directory"
@mainFile = "main-file.tex"
@compiler = "pdflatex"
@callback = sinon.stub()
@project_id = "project-id-123"
describe "runLatex", ->
beforeEach ->
@CommandRunner.run = sinon.stub().callsArg(4)
describe "normally", ->
beforeEach ->
@LatexRunner.runLatex @project_id,
directory: @directory
mainFile: @mainFile
compiler: @compiler
timeout: @timeout = 42000
@callback
it "should run the latex command", ->
@CommandRunner.run
.calledWith(@project_id, sinon.match.any, @directory, @timeout)
.should.equal true
describe "with an .Rtex main file", ->
beforeEach ->
@LatexRunner.runLatex @project_id,
directory: @directory
mainFile: "main-file.Rtex"
compiler: @compiler
timeout: @timeout = 42000
@callback
it "should run the latex command on the equivalent .tex file", ->
command = @CommandRunner.run.args[0][1]
mainFile = command.slice(-1)[0]
mainFile.should.equal "$COMPILE_DIR/main-file.tex"

41
test/unit/coffee/OutputFileFinderTests.coffee Normal file
View File

@@ -0,0 +1,41 @@
SandboxedModule = require('sandboxed-module')
sinon = require('sinon')
require('chai').should()
modulePath = require('path').join __dirname, '../../../app/js/OutputFileFinder'
path = require "path"
expect = require("chai").expect
describe "OutputFileFinder", ->
beforeEach ->
@OutputFileFinder = SandboxedModule.require modulePath, requires:
"fs": @fs = {}
"wrench": @wrench = {}
@directory = "/test/dir"
@callback = sinon.stub()
describe "findOutputFiles", ->
beforeEach ->
@resource_path = "resource/path.tex"
@output_paths = ["output.pdf", "extra", "extra/file.tex"]
@resources = [
path: @resource_path = "resource/path.tex"
]
@OutputFileFinder._isDirectory = (dirPath, callback = (error, directory) ->) =>
callback null, dirPath == path.join(@directory, "extra")
@wrench.readdirRecursive = (dir, callback) =>
callback(null, [@resource_path].concat(@output_paths))
callback(null, null)
sinon.spy @wrench, "readdirRecursive"
@OutputFileFinder.findOutputFiles @resources, @directory, (error, @outputFiles) =>
it "should only return the output files, not directories or resource paths", ->
expect(@outputFiles).to.deep.equal [{
path: "output.pdf"
type: "pdf"
}, {
path: "extra/file.tex",
type: "tex"
}]

60
test/unit/coffee/ProjectPersistenceManagerTests.coffee Normal file
View File

@@ -0,0 +1,60 @@
SandboxedModule = require('sandboxed-module')
sinon = require('sinon')
require('chai').should()
modulePath = require('path').join __dirname, '../../../app/js/ProjectPersistenceManager'
tk = require("timekeeper")
describe "ProjectPersistenceManager", ->
beforeEach ->
@ProjectPersistenceManager = SandboxedModule.require modulePath, requires:
"./UrlCache": @UrlCache = {}
"./CompileManager": @CompileManager = {}
"logger-sharelatex": @logger = { log: sinon.stub() }
"./db": @db = {}
@callback = sinon.stub()
@project_id = "project-id-123"
describe "clearExpiredProjects", ->
beforeEach ->
@project_ids = [
"project-id-1"
"project-id-2"
]
@ProjectPersistenceManager._findExpiredProjectIds = sinon.stub().callsArgWith(0, null, @project_ids)
@ProjectPersistenceManager.clearProject = sinon.stub().callsArg(1)
@ProjectPersistenceManager.clearExpiredProjects @callback
it "should clear each expired project", ->
for project_id in @project_ids
@ProjectPersistenceManager.clearProject
.calledWith(project_id)
.should.equal true
it "should call the callback", ->
@callback.called.should.equal true
describe "clearProject", ->
beforeEach ->
@ProjectPersistenceManager._clearProjectFromDatabase = sinon.stub().callsArg(1)
@UrlCache.clearProject = sinon.stub().callsArg(1)
@CompileManager.clearProject = sinon.stub().callsArg(1)
@ProjectPersistenceManager.clearProject @project_id, @callback
it "should clear the project from the database", ->
@ProjectPersistenceManager._clearProjectFromDatabase
.calledWith(@project_id)
.should.equal true
it "should clear all the cached Urls for the project", ->
@UrlCache.clearProject
.calledWith(@project_id)
.should.equal true
it "should clear the project compile folder", ->
@CompileManager.clearProject
.calledWith(@project_id)
.should.equal true
it "should call the callback", ->
@callback.called.should.equal true

209
test/unit/coffee/RequestParserTests.coffee Normal file
View File

@@ -0,0 +1,209 @@
SandboxedModule = require('sandboxed-module')
sinon = require('sinon')
require('chai').should()
modulePath = require('path').join __dirname, '../../../app/js/RequestParser'
tk = require("timekeeper")
describe "RequestParser", ->
beforeEach ->
tk.freeze()
@callback = sinon.stub()
@validResource =
path: "main.tex"
date: "12:00 01/02/03"
content: "Hello world"
@validRequest =
compile:
token: "token-123"
options:
compiler: "pdflatex"
timeout: 42
resources: []
@RequestParser = SandboxedModule.require modulePath
afterEach ->
tk.reset()
describe "without a top level object", ->
beforeEach ->
@RequestParser.parse [], @callback
it "should return an error", ->
@callback.calledWith("top level object should have a compile attribute")
.should.equal true
describe "without a compile attribute", ->
beforeEach ->
@RequestParser.parse {}, @callback
it "should return an error", ->
@callback.calledWith("top level object should have a compile attribute")
.should.equal true
describe "without a valid compiler", ->
beforeEach ->
@validRequest.compile.options.compiler = "not-a-compiler"
@RequestParser.parse @validRequest, @callback
it "should return an error", ->
@callback.calledWith("compiler attribute should be one of: pdflatex, latex, xelatex, lualatex")
.should.equal true
describe "without a compiler specified", ->
beforeEach ->
delete @validRequest.compile.options.compiler
@RequestParser.parse @validRequest, (error, @data) =>
it "should set the compiler to pdflatex by default", ->
@data.compiler.should.equal "pdflatex"
describe "without a timeout specified", ->
beforeEach ->
delete @validRequest.compile.options.timeout
@RequestParser.parse @validRequest, (error, @data) =>
it "should set the timeout to MAX_TIMEOUT", ->
@data.timeout.should.equal @RequestParser.MAX_TIMEOUT * 1000
describe "with a timeout larger than the maximum", ->
beforeEach ->
@validRequest.compile.options.timeout = @RequestParser.MAX_TIMEOUT + 1
@RequestParser.parse @validRequest, (error, @data) =>
it "should set the timeout to MAX_TIMEOUT", ->
@data.timeout.should.equal @RequestParser.MAX_TIMEOUT * 1000
describe "with a timeout", ->
beforeEach ->
@RequestParser.parse @validRequest, (error, @data) =>
it "should set the timeout (in milliseconds)", ->
@data.timeout.should.equal @validRequest.compile.options.timeout * 1000
describe "with a resource without a path", ->
beforeEach ->
delete @validResource.path
@validRequest.compile.resources.push @validResource
@RequestParser.parse @validRequest, @callback
it "should return an error", ->
@callback.calledWith("all resources should have a path attribute")
.should.equal true
describe "with a resource with a path", ->
beforeEach ->
@validResource.path = @path = "test.tex"
@validRequest.compile.resources.push @validResource
@RequestParser.parse @validRequest, @callback
@data = @callback.args[0][1]
it "should return the path in the parsed response", ->
@data.resources[0].path.should.equal @path
describe "with a resource with a malformed modified date", ->
beforeEach ->
@validResource.modified = "not-a-date"
@validRequest.compile.resources.push @validResource
@RequestParser.parse @validRequest, @callback
it "should return an error", ->
@callback
.calledWith(
"resource modified date could not be understood: "+
@validResource.modified
)
.should.equal true
describe "with a resource with a valid date", ->
beforeEach ->
@date = "12:00 01/02/03"
@validResource.modified = @date
@validRequest.compile.resources.push @validResource
@RequestParser.parse @validRequest, @callback
@data = @callback.args[0][1]
it "should return the date as a Javascript Date object", ->
(@data.resources[0].modified instanceof Date).should.equal true
@data.resources[0].modified.getTime().should.equal Date.parse(@date)
describe "with a resource without either a content or URL attribute", ->
beforeEach ->
delete @validResource.url
delete @validResource.content
@validRequest.compile.resources.push @validResource
@RequestParser.parse @validRequest, @callback
it "should return an error", ->
@callback.calledWith("all resources should have either a url or content attribute")
.should.equal true
describe "with a resource where the content is not a string", ->
beforeEach ->
@validResource.content = []
@validRequest.compile.resources.push @validResource
@RequestParser.parse (@validRequest), @callback
it "should return an error", ->
@callback.calledWith("content attribute should be a string")
.should.equal true
describe "with a resource where the url is not a string", ->
beforeEach ->
@validResource.url = []
@validRequest.compile.resources.push @validResource
@RequestParser.parse (@validRequest), @callback
it "should return an error", ->
@callback.calledWith("url attribute should be a string")
.should.equal true
describe "with a resource with a url", ->
beforeEach ->
@validResource.url = @url = "www.example.com"
@validRequest.compile.resources.push @validResource
@RequestParser.parse (@validRequest), @callback
@data = @callback.args[0][1]
it "should return the url in the parsed response", ->
@data.resources[0].url.should.equal @url
describe "with a resource with a content attribute", ->
beforeEach ->
@validResource.content = @content = "Hello world"
@validRequest.compile.resources.push @validResource
@RequestParser.parse (@validRequest), @callback
@data = @callback.args[0][1]
it "should return the content in the parsed response", ->
@data.resources[0].content.should.equal @content
describe "without a root resource path", ->
beforeEach ->
delete @validRequest.compile.rootResourcePath
@RequestParser.parse (@validRequest), @callback
@data = @callback.args[0][1]
it "should set the root resource path to 'main.tex' by default", ->
@data.rootResourcePath.should.equal "main.tex"
describe "with a root resource path", ->
beforeEach ->
@validRequest.compile.rootResourcePath = @path = "test.tex"
@RequestParser.parse (@validRequest), @callback
@data = @callback.args[0][1]
it "should return the root resource path in the parsed response", ->
@data.rootResourcePath.should.equal @path
describe "with a root resource path that is not a string", ->
beforeEach ->
@validRequest.compile.rootResourcePath = []
@RequestParser.parse (@validRequest), @callback
it "should return an error", ->
@callback.calledWith("rootResourcePath attribute should be a string")
.should.equal true

152
test/unit/coffee/ResourceWriterTests.coffee Normal file
View File

@@ -0,0 +1,152 @@
SandboxedModule = require('sandboxed-module')
sinon = require('sinon')
require('chai').should()
modulePath = require('path').join __dirname, '../../../app/js/ResourceWriter'
path = require "path"
describe "ResourceWriter", ->
beforeEach ->
@ResourceWriter = SandboxedModule.require modulePath, requires:
"fs": @fs = {}
"wrench": @wrench = {}
"./UrlCache" : @UrlCache = {}
"mkdirp" : @mkdirp = sinon.stub().callsArg(1)
"./OutputFileFinder": @OutputFileFinder = {}
"./Metrics": @Metrics =
Timer: class Timer
done: sinon.stub()
@project_id = "project-id-123"
@basePath = "/path/to/write/files/to"
@callback = sinon.stub()
describe "syncResourcesToDisk", ->
beforeEach ->
@resources = [
"resource-1-mock"
"resource-2-mock"
"resource-3-mock"
]
@ResourceWriter._writeResourceToDisk = sinon.stub().callsArg(3)
@ResourceWriter._removeExtraneousFiles = sinon.stub().callsArg(2)
@ResourceWriter.syncResourcesToDisk(@project_id, @resources, @basePath, @callback)
it "should remove old files", ->
@ResourceWriter._removeExtraneousFiles
.calledWith(@resources, @basePath)
.should.equal true
it "should write each resource to disk", ->
for resource in @resources
@ResourceWriter._writeResourceToDisk
.calledWith(@project_id, resource, @basePath)
.should.equal true
it "should call the callback", ->
@callback.called.should.equal true
describe "_removeExtraneousFiles", ->
beforeEach ->
@output_files = [{
path: "output.pdf"
type: "pdf"
}, {
path: "extra/file.tex"
type: "tex"
}, {
path: "extra.aux"
type: "aux"
}]
@resources = "mock-resources"
@OutputFileFinder.findOutputFiles = sinon.stub().callsArgWith(2, null, @output_files)
@ResourceWriter._deleteFileIfNotDirectory = sinon.stub().callsArg(1)
@ResourceWriter._removeExtraneousFiles(@resources, @basePath, @callback)
it "should find the existing output files", ->
@OutputFileFinder.findOutputFiles
.calledWith(@resources, @basePath)
.should.equal true
it "should delete the output files", ->
@ResourceWriter._deleteFileIfNotDirectory
.calledWith(path.join(@basePath, "output.pdf"))
.should.equal true
it "should delete the extra files", ->
@ResourceWriter._deleteFileIfNotDirectory
.calledWith(path.join(@basePath, "extra/file.tex"))
.should.equal true
it "should not delete the extra aux files", ->
@ResourceWriter._deleteFileIfNotDirectory
.calledWith(path.join(@basePath, "extra.aux"))
.should.equal false
it "should call the callback", ->
@callback.called.should.equal true
it "should time the request", ->
@Metrics.Timer::done.called.should.equal true
describe "_writeResourceToDisk", ->
describe "with a url based resource", ->
beforeEach ->
@resource =
path: "main.tex"
url: "http://www.example.com/main.tex"
modified: Date.now()
@UrlCache.downloadUrlToFile = sinon.stub().callsArg(4)
@ResourceWriter._writeResourceToDisk(@project_id, @resource, @basePath, @callback)
it "should ensure the directory exists", ->
@mkdirp
.calledWith(path.dirname(path.join(@basePath, @resource.path)))
.should.equal true
it "should write the URL from the cache", ->
@UrlCache.downloadUrlToFile
.calledWith(@project_id, @resource.url, path.join(@basePath, @resource.path), @resource.modified)
.should.equal true
it "should call the callback", ->
@callback.called.should.equal true
describe "with a content based resource", ->
beforeEach ->
@resource =
path: "main.tex"
content: "Hello world"
@fs.writeFile = sinon.stub().callsArg(2)
@ResourceWriter._writeResourceToDisk(@project_id, @resource, @basePath, @callback)
it "should ensure the directory exists", ->
@mkdirp
.calledWith(path.dirname(path.join(@basePath, @resource.path)))
.should.equal true
it "should write the contents to disk", ->
@fs.writeFile
.calledWith(path.join(@basePath, @resource.path), @resource.content)
.should.equal true
it "should call the callback", ->
@callback.called.should.equal true
describe "with a file path that breaks out of the root folder", ->
beforeEach ->
@resource =
path: "../../main.tex"
content: "Hello world"
@fs.writeFile = sinon.stub().callsArg(2)
@ResourceWriter._writeResourceToDisk(@project_id, @resource, @basePath, @callback)
it "should not write to disk", ->
@fs.writeFile.called.should.equal false
it "should return an error", ->
@callback
.calledWith(new Error("resource path is outside root directory"))
.should.equal true

200
test/unit/coffee/UrlCacheTests.coffee Normal file
View File

@@ -0,0 +1,200 @@
SandboxedModule = require('sandboxed-module')
sinon = require('sinon')
require('chai').should()
modulePath = require('path').join __dirname, '../../../app/js/UrlCache'
EventEmitter = require("events").EventEmitter
describe "UrlCache", ->
beforeEach ->
@callback = sinon.stub()
@url = "www.example.com/file"
@project_id = "project-id-123"
@UrlCache = SandboxedModule.require modulePath, requires:
"./db" : {}
"./UrlFetcher" : @UrlFetcher = {}
"logger-sharelatex": @logger = {log: sinon.stub()}
"settings-sharelatex": @Settings = { path: clsiCacheDir: "/cache/dir" }
"fs": @fs = {}
describe "_doesUrlNeedDownloading", ->
beforeEach ->
@lastModified = new Date()
@lastModifiedRoundedToSeconds = new Date(Math.floor(@lastModified.getTime() / 1000) * 1000)
describe "when URL does not exist in cache", ->
beforeEach ->
@UrlCache._findUrlDetails = sinon.stub().callsArgWith(2, null, null)
@UrlCache._doesUrlNeedDownloading(@project_id, @url, @lastModified, @callback)
it "should return the callback with true", ->
@callback.calledWith(null, true).should.equal true
describe "when URL does exist in cache", ->
beforeEach ->
@urlDetails = {}
@UrlCache._findUrlDetails = sinon.stub().callsArgWith(2, null, @urlDetails)
describe "when the modified date is more recent than the cached modified date", ->
beforeEach ->
@urlDetails.lastModified = new Date(@lastModified.getTime() - 1000)
@UrlCache._doesUrlNeedDownloading(@project_id, @url, @lastModified, @callback)
it "should get the url details", ->
@UrlCache._findUrlDetails
.calledWith(@project_id, @url)
.should.equal true
it "should return the callback with true", ->
@callback.calledWith(null, true).should.equal true
describe "when the cached modified date is more recent than the modified date", ->
beforeEach ->
@urlDetails.lastModified = new Date(@lastModified.getTime() + 1000)
@UrlCache._doesUrlNeedDownloading(@project_id, @url, @lastModified, @callback)
it "should return the callback with false", ->
@callback.calledWith(null, false).should.equal true
describe "when the cached modified date is equal to the modified date", ->
beforeEach ->
@urlDetails.lastModified = @lastModified
@UrlCache._doesUrlNeedDownloading(@project_id, @url, @lastModified, @callback)
it "should return the callback with false", ->
@callback.calledWith(null, false).should.equal true
describe "when the provided modified date does not exist", ->
beforeEach ->
@lastModified = null
@UrlCache._doesUrlNeedDownloading(@project_id, @url, @lastModified, @callback)
it "should return the callback with true", ->
@callback.calledWith(null, true).should.equal true
describe "when the URL does not have a modified date", ->
beforeEach ->
@urlDetails.lastModified = null
@UrlCache._doesUrlNeedDownloading(@project_id, @url, @lastModified, @callback)
it "should return the callback with true", ->
@callback.calledWith(null, true).should.equal true
describe "_ensureUrlIsInCache", ->
beforeEach ->
@UrlFetcher.pipeUrlToFile = sinon.stub().callsArg(2)
@UrlCache._updateOrCreateUrlDetails = sinon.stub().callsArg(3)
describe "when the URL needs updating", ->
beforeEach ->
@UrlCache._doesUrlNeedDownloading = sinon.stub().callsArgWith(3, null, true)
@UrlCache._ensureUrlIsInCache(@project_id, @url, @lastModified, @callback)
it "should check that the url needs downloading", ->
@UrlCache._doesUrlNeedDownloading
.calledWith(@project_id, @url, @lastModifiedRoundedToSeconds)
.should.equal true
it "should download the URL to the cache file", ->
@UrlFetcher.pipeUrlToFile
.calledWith(@url, @UrlCache._cacheFilePathForUrl(@project_id, @url))
.should.equal true
it "should update the database entry", ->
@UrlCache._updateOrCreateUrlDetails
.calledWith(@project_id, @url, @lastModifiedRoundedToSeconds)
.should.equal true
it "should return the callback with the cache file path", ->
@callback
.calledWith(null, @UrlCache._cacheFilePathForUrl(@project_id, @url))
.should.equal true
describe "when the URL does not need updating", ->
beforeEach ->
@UrlCache._doesUrlNeedDownloading = sinon.stub().callsArgWith(3, null, false)
@UrlCache._ensureUrlIsInCache(@project_id, @url, @lastModified, @callback)
it "should not download the URL to the cache file", ->
@UrlFetcher.pipeUrlToFile
.called.should.equal false
it "should return the callback with the cache file path", ->
@callback
.calledWith(null, @UrlCache._cacheFilePathForUrl(@project_id, @url))
.should.equal true
describe "downloadUrlToFile", ->
beforeEach ->
@cachePath = "path/to/cached/url"
@destPath = "path/to/destination"
@UrlCache._copyFile = sinon.stub().callsArg(2)
@UrlCache._ensureUrlIsInCache = sinon.stub().callsArgWith(3, null, @cachePath)
@UrlCache.downloadUrlToFile(@project_id, @url, @destPath, @lastModified, @callback)
it "should ensure the URL is downloaded and updated in the cache", ->
@UrlCache._ensureUrlIsInCache
.calledWith(@project_id, @url, @lastModified)
.should.equal true
it "should copy the file to the new location", ->
@UrlCache._copyFile
.calledWith(@cachePath, @destPath)
.should.equal true
it "should call the callback", ->
@callback.called.should.equal true
describe "_deleteUrlCacheFromDisk", ->
beforeEach ->
@fs.unlink = sinon.stub().callsArg(1)
@UrlCache._deleteUrlCacheFromDisk(@project_id, @url, @callback)
it "should delete the cache file", ->
@fs.unlink
.calledWith(@UrlCache._cacheFilePathForUrl(@project_id, @url))
.should.equal true
it "should call the callback", ->
@callback.called.should.equal true
describe "_clearUrlFromCache", ->
beforeEach ->
@UrlCache._deleteUrlCacheFromDisk = sinon.stub().callsArg(2)
@UrlCache._clearUrlDetails = sinon.stub().callsArg(2)
@UrlCache._clearUrlFromCache @project_id, @url, @callback
it "should delete the file on disk", ->
@UrlCache._deleteUrlCacheFromDisk
.calledWith(@project_id, @url)
.should.equal true
it "should clear the entry in the database", ->
@UrlCache._clearUrlDetails
.calledWith(@project_id, @url)
.should.equal true
it "should call the callback", ->
@callback.called.should.equal true
describe "clearProject", ->
beforeEach ->
@urls = [
"www.example.com/file1"
"www.example.com/file2"
]
@UrlCache._findAllUrlsInProject = sinon.stub().callsArgWith(1, null, @urls)
@UrlCache._clearUrlFromCache = sinon.stub().callsArg(2)
@UrlCache.clearProject @project_id, @callback
it "should clear the cache for each url in the project", ->
for url in @urls
@UrlCache._clearUrlFromCache
.calledWith(@project_id, url)
.should.equal true
it "should call the callback", ->
@callback.called.should.equal true

74
test/unit/coffee/UrlFetcherTests.coffee Normal file
View File

@@ -0,0 +1,74 @@
SandboxedModule = require('sandboxed-module')
sinon = require('sinon')
require('chai').should()
modulePath = require('path').join __dirname, '../../../app/js/UrlFetcher'
EventEmitter = require("events").EventEmitter
describe "UrlFetcher", ->
beforeEach ->
@callback = sinon.stub()
@url = "www.example.com/file"
@UrlFetcher = SandboxedModule.require modulePath, requires:
request: defaults: @defaults = sinon.stub().returns(@request = {})
fs: @fs = {}
it "should turn off the cookie jar in request", ->
@defaults.calledWith(jar: false)
.should.equal true
describe "_pipeUrlToFile", ->
beforeEach ->
@path = "/path/to/file/on/disk"
@request.get = sinon.stub().returns(@urlStream = new EventEmitter)
@urlStream.pipe = sinon.stub()
@fs.createWriteStream = sinon.stub().returns(@fileStream = "write-stream-stub")
@UrlFetcher.pipeUrlToFile(@url, @path, @callback)
it "should request the URL", ->
@request.get
.calledWith(@url)
.should.equal true
it "should open the file for writing", ->
@fs.createWriteStream
.calledWith(@path)
.should.equal true
describe "successfully", ->
beforeEach ->
@res = statusCode: 200
@urlStream.emit "response", @res
@urlStream.emit "end"
it "should pipe the URL to the file", ->
@urlStream.pipe
.calledWith(@fileStream)
.should.equal true
it "should call the callback", ->
@callback.called.should.equal true
describe "with non success status code", ->
beforeEach ->
@res = statusCode: 404
@urlStream.emit "response", @res
@urlStream.emit "end"
it "should call the callback with an error", ->
@callback
.calledWith(new Error("URL returned non-success status code: 404"))
.should.equal true
describe "with error", ->
beforeEach ->
@urlStream.emit "error", @error = new Error("something went wrong")
it "should call the callback with the error", ->
@callback
.calledWith(@error)
.should.equal true
it "should only call the callback once, even if end is called", ->
@urlStream.emit "end"
@callback.calledOnce.should.equal true