klemek/GitBlog.md
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

eslint integration

Browse Source
This commit is contained in:
Klemek
2021-03-30 14:53:26 +02:00
parent f6d6f04d59
commit e9d67985a6
17 changed files with 4176 additions and 1538 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.jshintignore → .eslintignore
View File
.eslintrc.js
+39
View File
@@ -0,0 +1,39 @@
module.exports = {
'plugins': ['jest'],
'env': {
'commonjs': true,
'es2021': true,
'node': true,
'jest/globals': true
},
'extends': ['eslint:recommended'],
'parserOptions': {
'ecmaVersion': 12
},
'rules': {
'indent': [
'error',
4
],
'linebreak-style': [
'error',
'unix'
],
'quotes': [
'error',
'single'
],
'semi': [
'error',
'always'
],
'curly': [
'error',
'all'
],
'brace-style': [
'error',
'1tbs'
]
}
};
.jshintrc
-21
View File
@@ -1,21 +0,0 @@
{
"esversion": 6,
"maxerr": 999,
"indent": true,
"camelcase": true,
"eqeqeq": true,
"forin": true,
"immed": true,
"latedef": true,
"noarg": true,
"noempty": true,
"nonew": true,
"undef": true,
"unused": true,
"varstmt": true,
"sub": true,
"quotmark": "single",
"node": true,
"globals": {
}
}
package-lock.json
Generated
+2616 -28
View File
File diff suppressed because it is too large Load Diff
package.json
+4 -1
View File
@@ -19,6 +19,8 @@
}, },
"devDependencies": { "devDependencies": {
"coveralls": "^3.0.4", "coveralls": "^3.0.4",
"eslint": "^7.23.0",
"eslint-plugin-jest": "^24.3.2",
"jest": "^24.8.0", "jest": "^24.8.0",
"superagent": "^5.1.0", "superagent": "^5.1.0",
"supertest": "^4.0.2" "supertest": "^4.0.2"
@@ -26,7 +28,8 @@
"scripts": { "scripts": {
"start": "node src/server.js", "start": "node src/server.js",
"test": "jest --silent -i", "test": "jest --silent -i",
"install": "node src/postinstall.js" "install": "node src/postinstall.js",
"lint": "eslint --fix ."
}, },
"repository": { "repository": {
"type": "git", "type": "git",
src/app.js
+248 -240
View File
@@ -21,19 +21,19 @@ app.use(bodyParser.json());
* @type {{warn: string, ok: string, error: string}} * @type {{warn: string, ok: string, error: string}}
*/ */
const cons = { const cons = {
ok: '\x1b[32m✔\x1b[0m %s', ok: '\x1b[32m✔\x1b[0m %s',
warn: '\x1b[33m⚠\x1b[0m %s', warn: '\x1b[33m⚠\x1b[0m %s',
error: '\x1b[31m✘\x1b[0m %s', error: '\x1b[31m✘\x1b[0m %s',
}; };
module.exports = (config) => { module.exports = (config) => {
/** /**
* Fetch articles from the data folder and send success as a response * Fetch articles from the data folder and send success as a response
* @param success * @param success
* @param error * @param error
*/ */
let reload; let reload;
/** /**
* Render the page with the view engine and catch errors * Render the page with the view engine and catch errors
* @param req * @param req
* @param res * @param res
@@ -41,256 +41,264 @@ module.exports = (config) => {
* @param data - data to pass to the view * @param data - data to pass to the view
* @param code - code to send along the page * @param code - code to send along the page
*/ */
let render; let render;
/** /**
* Show an error with the correct page * Show an error with the correct page
* @param req * @param req
* @param res * @param res
* @param code - error code * @param code - error code
*/ */
let showError; let showError;
const fw = require('./file_walker')(config); const fw = require('./file_walker')(config);
const renderer = require('./renderer')(config); const renderer = require('./renderer')(config);
// set view engine from configuration // set view engine from configuration
app.set('view engine', config['view_engine']); app.set('view engine', config['view_engine']);
// reroute the views folder to the root folder // reroute the views folder to the root folder
app.set('views', path.join(__dirname, '..')); app.set('views', path.join(__dirname, '..'));
const articles = {}; const articles = {};
let lastRSS = ''; let lastRSS = '';
let host = config['host']; let host = config['host'];
reload = (success, error) => { reload = (success, error) => {
fw.fetchArticles((err, dict) => { fw.fetchArticles((err, dict) => {
if (err) {
console.error(cons.error, 'error loading articles : ' + err);
return error ? error() : null;
}
Object.keys(articles).forEach((key) => delete articles[key]);
Object.keys(dict).forEach((key) => articles[key] = dict[key]);
const nb = Object.keys(articles).length;
const dnb = Object.values(articles).filter(a => a.draft).length;
if (nb > 0)
console.log(cons.ok, `loaded ${nb} article${nb > 1 ? 's' : ''} (${dnb} drafted)`);
else
console.log(cons.warn, `no articles loaded, check your configuration`);
lastRSS = '';
success();
});
};
if (config['test'])
app.reload = reload;
render = (req, res, vPath, data, code = 200) => {
data.info = {
title: config['home']['title'],
description: config['home']['description'],
host: host,
version: pjson.version,
request: req,
config: config
};
res.render(vPath, data, (err, html) => {
if (err && vPath !== path.join(config['data_dir'], config['home']['error'])) {
console.log(cons.error, `failed to render page ${vPath} : ${err}`);
showError(req, res, 500);
} else if (err) {
res.sendStatus(500);
console.log(cons.error, `failed to render error page : ${err}`);
} else
res.status(code).send(html);
});
};
showError = (req, res, code) => {
const errorPath = path.join(config['data_dir'], config['home']['error']);
fs.access(errorPath, fs.constants.R_OK, (err) => {
if (err)
res.sendStatus(code);
else
render(req, res, errorPath, {error: code}, code);
});
};
app.use((req, res, next) => {
if (!host) {
host = 'http://' + req.headers.host;
console.log(cons.ok, 'Currently hosted on ' + host);
}
next();
});
//rate limit for safer server
const limiter = rateLimit({
windowMs: 15 * 60 * 1000, // 15 minutes
max: config['rate_limit']
});
app.use(limiter);
//log request at result end
app.use((req, res, next) => {
if (config['access_log']) {
const end = res.end;
res.end = (chunk, encoding) => {
fs.appendFile(config['access_log'],
`${res.statusCode} ${req.method} ${req.url} ${new Date().toUTCString()} ${req.ips.join(' ') || req.ip}\n`,
{encoding: 'UTF-8'}, () => {
res.end = end;
res.end(chunk, encoding);
});
};
}
next();
});
// home endpoint : send the correct index page or error if not existing
app.get('/', (req, res) => {
const homePath = path.join(config['data_dir'], config['home']['index']);
fs.access(homePath, fs.constants.R_OK, (err) => {
if (err)
showError(req, res, 404);
else
render(req, res, homePath,
{
articles: Object.values(articles)
.filter(d => !d.draft).sort((a, b) => ('' + b.path).localeCompare(a.path))
});
});
});
//RSS endpoint
app.get(config['rss']['endpoint'], (req, res) => {
if (config['modules']['rss']) {
if (!lastRSS) {
const feed = new Rss({
'title': config['rss']['title'],
'description': config['rss']['description'],
'feed_url': host + req.url,
'site_url': host
});
Object.values(articles)
.slice(0, config['rss']['length'])
.forEach((article) => {
feed.item({
title: article.title,
url: host + article.url,
date: article.date
});
});
lastRSS = feed.xml();
}
res.type(req.headers['user-agent'].match(/Mozilla/) ? 'text/xml' : 'rss').send(lastRSS);
} else {
showError(req, res, 404);
}
});
//webhook endpoint
app.post(config['webhook']['endpoint'], (req, res) => {
if (config['modules']['webhook']) {
if (config['webhook']['signature_header'] && config['webhook']['secret']) {
const payload = JSON.stringify(req.body) || '';
const hmac = crypto.createHmac('sha1', config['webhook']['secret']);
const digest = 'sha1=' + hmac.update(payload).digest('hex');
const checksum = req.headers[config['webhook']['signature_header']];
if (!checksum || !digest || checksum !== digest) {
return res.sendStatus(403);
}
}
cp.exec(config['webhook']['pull_command'], {cwd: path.join(__dirname, '..', config['data_dir'])}, (err) => {
if (err) {
console.log(cons.error, `command '${config['webhook']['pull_command']}' failed : ${err}`);
return res.sendStatus(500);
}
reload(() => {
res.sendStatus(200);
});
});
} else {
res.sendStatus(400);
}
});
//rewrite urls to hide articles titles : /2019/05/05/sometitle/img.png => /2019/05/05/img.png
app.use((req, res, next) => {
if (/^\/\d{4}\/\d{2}\/\d{2}\//.test(req.url))
req.url = req.url.slice(0, 11) + req.url.slice(req.url.lastIndexOf('/'));
next();
});
// catch all article urls and render them
app.get('*', (req, res, next) => {
if (/^\/\d{4}\/\d{2}\/\d{2}\/$/.test(req.path)) {
const articlePath = req.path.substr(1, 10);
const article = articles[articlePath];
if (!article)
showError(req, res, 404);
else {
renderer.render(article.realPath, (err, html) => {
if (err) {
console.log(cons.error, `failed to render article ${req.path} : ${err}`);
return showError(req, res, 500);
}
article.content = html;
const templatePath = path.join(config['data_dir'], config['article']['template']);
fs.access(templatePath, fs.constants.R_OK, (err) => {
if (err) { if (err) {
console.log(cons.error, `no template found at ${templatePath}`); console.error(cons.error, 'error loading articles : ' + err);
showError(req, res, 500); return error ? error() : null;
} else }
render(req, res, templatePath, {article: article}); Object.keys(articles).forEach((key) => delete articles[key]);
}); Object.keys(dict).forEach((key) => articles[key] = dict[key]);
const nb = Object.keys(articles).length;
const dnb = Object.values(articles).filter(a => a.draft).length;
if (nb > 0) {
console.log(cons.ok, `loaded ${nb} article${nb > 1 ? 's' : ''} (${dnb} drafted)`);
} else {
console.log(cons.warn, 'no articles loaded, check your configuration');
}
lastRSS = '';
success();
}); });
} };
} else { if (config['test']) {
next(); app.reload = reload;
} }
});
// catch all hidden file type and return 404 render = (req, res, vPath, data, code = 200) => {
config['home']['hidden'].forEach(pathMatcher => { data.info = {
app.get(pathMatcher, (req, res) => { title: config['home']['title'],
showError(req, res, 404); description: config['home']['description'],
host: host,
version: pjson.version,
request: req,
config: config
};
res.render(vPath, data, (err, html) => {
if (err && vPath !== path.join(config['data_dir'], config['home']['error'])) {
console.log(cons.error, `failed to render page ${vPath} : ${err}`);
showError(req, res, 500);
} else if (err) {
res.sendStatus(500);
console.log(cons.error, `failed to render error page : ${err}`);
} else {
res.status(code).send(html);
}
});
};
showError = (req, res, code) => {
const errorPath = path.join(config['data_dir'], config['home']['error']);
fs.access(errorPath, fs.constants.R_OK, (err) => {
if (err) {
res.sendStatus(code);
} else {
render(req, res, errorPath, {error: code}, code);
}
});
};
app.use((req, res, next) => {
if (!host) {
host = 'http://' + req.headers.host;
console.log(cons.ok, 'Currently hosted on ' + host);
}
next();
}); });
});
// serve all static files via get //rate limit for safer server
app.get('*', express.static(path.join(__dirname, '..', config['data_dir']))); const limiter = rateLimit({
// catch express.static errors (mostly not found) by displaying 404 windowMs: 15 * 60 * 1000, // 15 minutes
app.get('*', (req, res) => { max: config['rate_limit']
showError(req, res, 404);
});
// catch all other methods and return 400
app.all('*', (req, res) => {
res.status(400).send('bad request');
});
//log all server errors
app.use((err, req, res, next) => {
console.log(cons.error, `error when handling ${req.method} ${req.path} request : ${err}`);
if (!config['error_log'])
next(err);
fs.appendFile(config['error_log'],
`500 ${req.method} ${req.url} ${new Date().toUTCString()} ${req.ips.join(' ') || req.ip}\n${err.stack}\n`,
{encoding: 'UTF-8'}, () => {
next(err);
});
});
// must be use in a server.js to start the server
app.start = () => {
reload(() => {
app.listen(config['node_port'], () => {
console.log(cons.ok, `gitblog.md server listening on port ${config['node_port']}`);
});
}); });
}; app.use(limiter);
return app; //log request at result end
app.use((req, res, next) => {
if (config['access_log']) {
const end = res.end;
res.end = (chunk, encoding) => {
fs.appendFile(config['access_log'],
`${res.statusCode} ${req.method} ${req.url} ${new Date().toUTCString()} ${req.ips.join(' ') || req.ip}\n`,
{encoding: 'UTF-8'}, () => {
res.end = end;
res.end(chunk, encoding);
});
};
}
next();
});
// home endpoint : send the correct index page or error if not existing
app.get('/', (req, res) => {
const homePath = path.join(config['data_dir'], config['home']['index']);
fs.access(homePath, fs.constants.R_OK, (err) => {
if (err) {
showError(req, res, 404);
} else {
render(req, res, homePath,
{
articles: Object.values(articles)
.filter(d => !d.draft).sort((a, b) => ('' + b.path).localeCompare(a.path))
});
}
});
});
//RSS endpoint
app.get(config['rss']['endpoint'], (req, res) => {
if (config['modules']['rss']) {
if (!lastRSS) {
const feed = new Rss({
'title': config['rss']['title'],
'description': config['rss']['description'],
'feed_url': host + req.url,
'site_url': host
});
Object.values(articles)
.slice(0, config['rss']['length'])
.forEach((article) => {
feed.item({
title: article.title,
url: host + article.url,
date: article.date
});
});
lastRSS = feed.xml();
}
res.type(req.headers['user-agent'].match(/Mozilla/) ? 'text/xml' : 'rss').send(lastRSS);
} else {
showError(req, res, 404);
}
});
//webhook endpoint
app.post(config['webhook']['endpoint'], (req, res) => {
if (config['modules']['webhook']) {
if (config['webhook']['signature_header'] && config['webhook']['secret']) {
const payload = JSON.stringify(req.body) || '';
const hmac = crypto.createHmac('sha1', config['webhook']['secret']);
const digest = 'sha1=' + hmac.update(payload).digest('hex');
const checksum = req.headers[config['webhook']['signature_header']];
if (!checksum || !digest || checksum !== digest) {
return res.sendStatus(403);
}
}
cp.exec(config['webhook']['pull_command'], {cwd: path.join(__dirname, '..', config['data_dir'])}, (err) => {
if (err) {
console.log(cons.error, `command '${config['webhook']['pull_command']}' failed : ${err}`);
return res.sendStatus(500);
}
reload(() => {
res.sendStatus(200);
});
});
} else {
res.sendStatus(400);
}
});
//rewrite urls to hide articles titles : /2019/05/05/sometitle/img.png => /2019/05/05/img.png
app.use((req, res, next) => {
if (/^\/\d{4}\/\d{2}\/\d{2}\//.test(req.url)) {
req.url = req.url.slice(0, 11) + req.url.slice(req.url.lastIndexOf('/'));
}
next();
});
// catch all article urls and render them
app.get('*', (req, res, next) => {
if (/^\/\d{4}\/\d{2}\/\d{2}\/$/.test(req.path)) {
const articlePath = req.path.substr(1, 10);
const article = articles[articlePath];
if (!article) {
showError(req, res, 404);
} else {
renderer.render(article.realPath, (err, html) => {
if (err) {
console.log(cons.error, `failed to render article ${req.path} : ${err}`);
return showError(req, res, 500);
}
article.content = html;
const templatePath = path.join(config['data_dir'], config['article']['template']);
fs.access(templatePath, fs.constants.R_OK, (err) => {
if (err) {
console.log(cons.error, `no template found at ${templatePath}`);
showError(req, res, 500);
} else {
render(req, res, templatePath, {article: article});
}
});
});
}
} else {
next();
}
});
// catch all hidden file type and return 404
config['home']['hidden'].forEach(pathMatcher => {
app.get(pathMatcher, (req, res) => {
showError(req, res, 404);
});
});
// serve all static files via get
app.get('*', express.static(path.join(__dirname, '..', config['data_dir'])));
// catch express.static errors (mostly not found) by displaying 404
app.get('*', (req, res) => {
showError(req, res, 404);
});
// catch all other methods and return 400
app.all('*', (req, res) => {
res.status(400).send('bad request');
});
//log all server errors
app.use((err, req, res, next) => {
console.log(cons.error, `error when handling ${req.method} ${req.path} request : ${err}`);
if (!config['error_log']) {
next(err);
}
fs.appendFile(config['error_log'],
`500 ${req.method} ${req.url} ${new Date().toUTCString()} ${req.ips.join(' ') || req.ip}\n${err.stack}\n`,
{encoding: 'UTF-8'}, () => {
next(err);
});
});
// must be use in a server.js to start the server
app.start = () => {
reload(() => {
app.listen(config['node_port'], () => {
console.log(cons.ok, `gitblog.md server listening on port ${config['node_port']}`);
});
});
};
return app;
}; };
src/config.js
+21 -21
View File
@@ -8,28 +8,28 @@ const fs = require('fs');
* @returns {*} * @returns {*}
*/ */
const merge = (ref, src) => { const merge = (ref, src) => {
if (typeof ref !== typeof src) { if (typeof ref !== typeof src) {
return ref; return ref;
} else if (ref.length && !src.length) { } else if (ref.length && !src.length) {
return ref; return ref;
} else if (ref.length && src.length) { } else if (ref.length && src.length) {
return src; return src;
} else if (typeof ref === 'object') { } else if (typeof ref === 'object') {
const out = {}; const out = {};
Object.keys(ref).forEach((key) => out[key] = merge(ref[key], src[key])); Object.keys(ref).forEach((key) => out[key] = merge(ref[key], src[key]));
return out; return out;
} else { } else {
return src; return src;
} }
}; };
module.exports = () => { module.exports = () => {
try { try {
let configData = fs.readFileSync('config.json', {encoding: 'UTF-8'}); let configData = fs.readFileSync('config.json', {encoding: 'UTF-8'});
let config = JSON.parse(configData); let config = JSON.parse(configData);
return merge(refConfig, config); return merge(refConfig, config);
} catch (error) { } catch (error) {
console.log('\x1b[33m⚠\x1b[0m %s', 'Failed to load config.json : ' + error); console.log('\x1b[33m⚠\x1b[0m %s', 'Failed to load config.json : ' + error);
return refConfig; return refConfig;
} }
}; };
src/file_walker.js
+85 -75
View File
@@ -9,29 +9,33 @@ const joinUrl = (...paths) => path.join(...paths).replace(/\\/g, '/');
* @param cb * @param cb
*/ */
const getFileTree = (dir, cb) => { const getFileTree = (dir, cb) => {
let list = []; let list = [];
let remaining = 0; let remaining = 0;
fs.readdir(dir, {withFileTypes: true}, (err, items) => { fs.readdir(dir, {withFileTypes: true}, (err, items) => {
if (err) if (err) {
return cb(err);
items.forEach((item) => {
if (item.isDirectory()) {
remaining++;
getFileTree(path.join(dir, item.name), (err, out) => {
if (err)
return cb(err); return cb(err);
list.push(...out); }
remaining--; items.forEach((item) => {
if (remaining === 0) if (item.isDirectory()) {
cb(null, list); remaining++;
getFileTree(path.join(dir, item.name), (err, out) => {
if (err) {
return cb(err);
}
list.push(...out);
remaining--;
if (remaining === 0) {
cb(null, list);
}
});
} else {
list.push(path.join(dir, item.name));
}
}); });
} else { if (remaining === 0) {
list.push(path.join(dir, item.name)); cb(null, list);
} }
}); });
if (remaining === 0)
cb(null, list);
});
}; };
/** /**
@@ -41,71 +45,77 @@ const getFileTree = (dir, cb) => {
* @param cb * @param cb
*/ */
const readIndexFile = (path, thumbnailTag, cb) => { const readIndexFile = (path, thumbnailTag, cb) => {
fs.readFile(path, {encoding: 'UTF-8'}, (err, data) => { fs.readFile(path, {encoding: 'UTF-8'}, (err, data) => {
if (err) if (err) {
return cb(err); return cb(err);
}
let info = {}; let info = {};
const regRes1 = data.match(/(^|[^#])#([^#\r\n]*)\r?\n?$/m); const regRes1 = data.match(/(^|[^#])#([^#\r\n]*)\r?\n?$/m);
info.title = regRes1 ? regRes1[2].trim() : undefined; info.title = regRes1 ? regRes1[2].trim() : undefined;
const thumbnailRegEx = new RegExp(`!\\[${thumbnailTag}]\\(([^)]*)\\)`, 'i'); const thumbnailRegEx = new RegExp(`!\\[${thumbnailTag}]\\(([^)]*)\\)`, 'i');
const regRes2 = data.match(thumbnailRegEx); const regRes2 = data.match(thumbnailRegEx);
info.thumbnail = regRes2 ? regRes2[1].trim() : undefined; info.thumbnail = regRes2 ? regRes2[1].trim() : undefined;
cb(null, info); cb(null, info);
}); });
}; };
module.exports = (config) => { module.exports = (config) => {
return { return {
fileTree: config['test'] ? getFileTree : undefined, fileTree: config['test'] ? getFileTree : undefined,
readIndexFile: config['test'] ? readIndexFile : undefined, readIndexFile: config['test'] ? readIndexFile : undefined,
/** /**
* find and read all articles inside the data directory * find and read all articles inside the data directory
* @param cb * @param cb
*/ */
fetchArticles: (cb) => { fetchArticles: (cb) => {
getFileTree(config['data_dir'], (err, fileList) => { getFileTree(config['data_dir'], (err, fileList) => {
if (err) if (err) {
return cb(err); return cb(err);
const paths = fileList }
.map((p) => p.substr(config['data_dir'].length + 1).split(path.sep)) const paths = fileList
.filter((p) => p.length === 4 && (p[3] === config['article']['index'] || p[3] === config['article']['draft']) && .map((p) => p.substr(config['data_dir'].length + 1).split(path.sep))
.filter((p) => p.length === 4 && (p[3] === config['article']['index'] || p[3] === config['article']['draft']) &&
/^\d{4}$/.test(p[0]) && /^\d{2}$/.test(p[1]) && /^\d{2}$/.test(p[2])); /^\d{4}$/.test(p[0]) && /^\d{2}$/.test(p[1]) && /^\d{2}$/.test(p[2]));
if (paths.length === 0) if (paths.length === 0) {
cb(null, {}); cb(null, {});
const articles = {}; }
let remaining = 0; const articles = {};
paths.forEach((p) => { let remaining = 0;
const article = { paths.forEach((p) => {
path: joinUrl(p[0], p[1], p[2]), const article = {
draft: p[3] === config['article']['draft'], path: joinUrl(p[0], p[1], p[2]),
realPath: path.join(config['data_dir'], p[0], p[1], p[2], p[3]), draft: p[3] === config['article']['draft'],
year: parseInt(p[0]), realPath: path.join(config['data_dir'], p[0], p[1], p[2], p[3]),
month: parseInt(p[1]), year: parseInt(p[0]),
day: parseInt(p[2]) month: parseInt(p[1]),
}; day: parseInt(p[2])
article.date = new Date(article.year, article.month, article.day); };
article.date.setUTCHours(0); article.date = new Date(article.year, article.month, article.day);
remaining++; article.date.setUTCHours(0);
readIndexFile(article.realPath, config['article']['thumbnail_tag'], (err, info) => { remaining++;
if (err) readIndexFile(article.realPath, config['article']['thumbnail_tag'], (err, info) => {
return cb(err); if (err) {
article.title = info.title || config['article']['default_title']; return cb(err);
article.thumbnail = info.thumbnail ? joinUrl(article.path, info.thumbnail) : config['article']['default_thumbnail']; }
article.escapedTitle = article.title.toLowerCase().replace(/[^\w]/gm, ' ').trim().replace(/ /gm, '_'); article.title = info.title || config['article']['default_title'];
article.url = '/' + joinUrl(article.path, article.escapedTitle) + '/'; article.thumbnail = info.thumbnail ? joinUrl(article.path, info.thumbnail) : config['article']['default_thumbnail'];
if (!articles[article.path] || !article.draft) article.escapedTitle = article.title.toLowerCase().replace(/[^\w]/gm, ' ').trim().replace(/ /gm, '_');
articles[article.path] = article; article.url = '/' + joinUrl(article.path, article.escapedTitle) + '/';
remaining--; if (!articles[article.path] || !article.draft) {
if (remaining === 0) articles[article.path] = article;
cb(null, articles); }
}); remaining--;
}); if (remaining === 0) {
cb(null, articles);
}
});
});
}); });
} }
}; };
}; };
src/postinstall.js
+16 -14
View File
@@ -3,28 +3,30 @@ const path = require('path');
const ncp = require('ncp').ncp; const ncp = require('ncp').ncp;
const copy = (src, dest) => { const copy = (src, dest) => {
ncp(src, dest, function (err) { ncp(src, dest, function (err) {
if (err) if (err) {
console.error(err); console.error(err);
else } else {
console.log(`copied ${src} to ${dest}`); console.log(`copied ${src} to ${dest}`);
}); }
});
}; };
copy(path.join('src', 'config.default.json'), 'config.example.json'); copy(path.join('src', 'config.default.json'), 'config.example.json');
if (!fs.existsSync('data')) { if (!fs.existsSync('data')) {
fs.mkdirSync('data'); fs.mkdirSync('data');
copy(path.join('sample_data', 'home'), 'data'); copy(path.join('sample_data', 'home'), 'data');
const pad0 = (n) => ('0' + n).substr(-2); const pad0 = (n) => ('0' + n).substr(-2);
const datetime = new Date(); const datetime = new Date();
const dir = path.join('data', datetime.getFullYear().toString(), pad0(datetime.getMonth() + 1), pad0(datetime.getDate())); const dir = path.join('data', datetime.getFullYear().toString(), pad0(datetime.getMonth() + 1), pad0(datetime.getDate()));
if (!fs.existsSync(dir)) if (!fs.existsSync(dir)) {
fs.mkdirSync(dir, {recursive: true}); fs.mkdirSync(dir, {recursive: true});
}
copy(path.join('sample_data', 'article'), dir); copy(path.join('sample_data', 'article'), dir);
} }
src/renderer.js
+204 -194
View File
@@ -3,216 +3,226 @@ const path = require('path');
const showdown = require('showdown'); const showdown = require('showdown');
module.exports = (config) => { module.exports = (config) => {
const converter = new showdown.Converter(config['showdown']); const converter = new showdown.Converter(config['showdown']);
/** /**
* get parts outside of codes/scripts * get parts outside of codes/scripts
* @param {string} data * @param {string} data
* @returns {{index:number, end:number, text:string}[]} parts * @returns {{index:number, end:number, text:string}[]} parts
*/ */
const getParts = (data) => { const getParts = (data) => {
let parts = []; let parts = [];
let match; let match;
let i = 0; let i = 0;
while ((match = /```/m.exec(data.slice(i)))) { while ((match = /```/m.exec(data.slice(i)))) {
parts.push({ parts.push({
index: i, index: i,
text: data.slice(i, i + match.index), text: data.slice(i, i + match.index),
}); });
i += match.index + match[0].length; i += match.index + match[0].length;
} }
if (i < data.length) if (i < data.length) {
parts.push({ parts.push({
index: i, index: i,
text: data.slice(i, data.length), text: data.slice(i, data.length),
}); });
parts = parts.filter((p, i) => i % 2 === 0); //filter out code parts
// detect scripts outside of code
parts.forEach((p, pi) => {
let i = 0;
const subParts = [];
while ((match = /(<script>((?:(?!<\/script>)[\s\S])*)<\/script>)/gm.exec(p.text.slice(i)))) {
subParts.push({
index: p.index + i,
text: p.text.slice(i, i + match.index),
});
i += match.index + match[0].length;
}
if (i < p.text.length)
subParts.push({
index: p.index + i,
text: p.text.slice(i, p.text.length),
});
parts.splice(pi, 1, ...subParts);
});
parts.forEach(part => part.end = part.index + part.text.length);
return parts;
};
const renderShowDown = (data, cb) => {
const html = converter.makeHtml(data);
cb(html);
};
let Prism;
if (config['modules']['prism'])
Prism = require('node-prismjs');
const renderPrism = (data, cb) => {
if (!config['modules']['prism'])
return cb(data);
const codeRegex = /```([\w-]+)\r?\n((?:(?!```)[\s\S])*)\r?\n```/m;
let match;
while ((match = codeRegex.exec(data))) {
const lang = match[1].trim();
const code = match[2].trim();
const block = Prism.highlight(code, Prism.languages[lang] || Prism.languages.autoit, lang);
data = data.slice(0, match.index) + `<pre><code class="${lang} language-${lang}">` + block + '</code></pre>' + data.slice(match.index + match[0].length);
}
cb(data);
};
if (config['modules']['plantuml']) {
require('./script_loader')(path.join(__dirname, 'lib', 'plantuml_synchro.js'));
}
const renderPlantUML = (data, cb) => {
if (!config['modules']['plantuml'])
return cb(data);
const parts = getParts(data);
const umlRegex = /@startuml\r?\n((?:(?!@enduml)[\s\S])*)\r?\n@enduml/m;
let match;
parts.forEach(part => {
while ((match = umlRegex.exec(part.text))) {
const code = match[1].trim();
const s = unescape(encodeURIComponent(code)); // jshint ignore:line
const compressed = global['zip_deflate'](s);
const url = `http://www.plantuml.com/plantuml/${config['plantuml']['output_format']}/${encode64(compressed)}`;// jshint ignore:line
part.text = part.text.slice(0, match.index) + `<img alt="generated PlantUML diagram" src="${url}">` + part.text.slice(match.index + match[0].length);
}
data = data.slice(0, part.index) + part.text + data.slice(part.end);
});
cb(data);
};
let mjAPI;
if (config['modules']['mathjax']) {
mjAPI = require('mathjax-node');
mjAPI.config({
MathJax: {
tex2jax: {
inlineMath: [['$', '$']],
displayMath: [['$$', '$$']]
} }
}
});
}
const renderMathJax = (data, cb) => { parts = parts.filter((p, i) => i % 2 === 0); //filter out code parts
if (!config['modules']['mathjax'])
return cb(data);
const parts = getParts(data); // detect scripts outside of code
parts.forEach((p, pi) => {
const doMJ = (match, format, i) => { let i = 0;
const eq = match[1].trim(); const subParts = [];
const output = config['mathjax']['output_format']; while ((match = /(<script>((?:(?!<\/script>)[\s\S])*)<\/script>)/gm.exec(p.text.slice(i)))) {
const mjConf = { subParts.push({
math: eq, index: p.index + i,
format: format, text: p.text.slice(i, i + match.index),
speakText: config['mathjax']['speak_text'] });
}; i += match.index + match[0].length;
mjConf[output] = true; }
mjAPI.typeset(mjConf, (res) => { if (i < p.text.length) {
data = data.slice(0, parts[i].index + match.index) + res[output] + data.slice(parts[i].index + match.index + match[0].length); subParts.push({
renderMathJax(data, (data2) => { index: p.index + i,
cb(data2); text: p.text.slice(i, p.text.length),
});
}
parts.splice(pi, 1, ...subParts);
}); });
});
parts.forEach(part => part.end = part.index + part.text.length);
return parts;
}; };
const eqRegex = /\$\$((?:(?!\$\$)[\s\S])*)\$\$/m; const renderShowDown = (data, cb) => {
const inlineEqRegex = /\$([^$\n]*)\$/; const html = converter.makeHtml(data);
cb(html);
};
for (let i = 0; i < parts.length; i++) { let Prism;
let match; if (config['modules']['prism']) {
if ((match = eqRegex.exec(parts[i].text))) { Prism = require('node-prismjs');
return doMJ(match, 'TeX', i);
} else if ((match = inlineEqRegex.exec(parts[i].text))) {
return doMJ(match, 'inline-TeX', i);
}
} }
cb(data);
};
let faDiagrams; const renderPrism = (data, cb) => {
let toml; if (!config['modules']['prism']) {
if (config['modules']['fa-diagrams']) { return cb(data);
faDiagrams = require('fa-diagrams');
toml = require('@iarna/toml');
}
const renderFaDiagrams = (data, cb) => {
if (!config['modules']['fa-diagrams'])
return cb(data);
const parts = getParts(data);
const diagramsRegex = /@startfad\r?\n((?:(?!@endfad)[\s\S])*)\r?\n@endfad/m;
let match;
parts.forEach(part => {
while ((match = diagramsRegex.exec(part.text))) {
const code = match[1].trim();
let output;
try {
const diagData = toml.parse(code);
const findLineBreaks = (data) => {
Object.keys(data).forEach(key => {
if (typeof data[key] === 'object')
findLineBreaks(data[key]);
else if (typeof data[key] === 'string')
data[key] = data[key].replace(/\\n/gm, '\n');
});
};
findLineBreaks(diagData);
output = faDiagrams.compute(diagData);
} catch (err) {
output = `<b style="color:red">${err.toString()}</b>`;
} }
part.text = part.text.slice(0, match.index) + output + part.text.slice(match.index + match[0].length); const codeRegex = /```([\w-]+)\r?\n((?:(?!```)[\s\S])*)\r?\n```/m;
} let match;
data = data.slice(0, part.index) + part.text + data.slice(part.end); while ((match = codeRegex.exec(data))) {
}); const lang = match[1].trim();
cb(data); const code = match[2].trim();
}; const block = Prism.highlight(code, Prism.languages[lang] || Prism.languages.autoit, lang);
data = data.slice(0, match.index) + `<pre><code class="${lang} language-${lang}">` + block + '</code></pre>' + data.slice(match.index + match[0].length);
}
cb(data);
};
return { if (config['modules']['plantuml']) {
getParts: config['test'] ? getParts : undefined, require('./script_loader')(path.join(__dirname, 'lib', 'plantuml_synchro.js'));
renderShowDown: config['test'] ? renderShowDown : undefined,
renderPrism: config['test'] ? renderPrism : undefined,
renderPlantUML: config['test'] ? renderPlantUML : undefined,
renderMathJax: config['test'] ? renderMathJax : undefined,
renderFaDiagrams: config['test'] ? renderFaDiagrams : undefined,
render: (file, cb) => {
fs.readFile(file, {encoding: 'UTF-8'}, (err, data) => {
if (err)
return cb(err);
renderPlantUML(data, (data) => {
renderFaDiagrams(data, (data) => {
renderMathJax(data, (data) => {
renderPrism(data, (data) => {
renderShowDown(data, (html) => {
cb(null, html);
});
});
});
});
});
});
} }
};
const renderPlantUML = (data, cb) => {
/* global encode64 */
if (!config['modules']['plantuml']) {
return cb(data);
}
const parts = getParts(data);
const umlRegex = /@startuml\r?\n((?:(?!@enduml)[\s\S])*)\r?\n@enduml/m;
let match;
parts.forEach(part => {
while ((match = umlRegex.exec(part.text))) {
const code = match[1].trim();
const s = unescape(encodeURIComponent(code));
const compressed = global['zip_deflate'](s);
const url = `http://www.plantuml.com/plantuml/${config['plantuml']['output_format']}/${encode64(compressed)}`;
part.text = part.text.slice(0, match.index) + `<img alt="generated PlantUML diagram" src="${url}">` + part.text.slice(match.index + match[0].length);
}
data = data.slice(0, part.index) + part.text + data.slice(part.end);
});
cb(data);
};
let mjAPI;
if (config['modules']['mathjax']) {
mjAPI = require('mathjax-node');
mjAPI.config({
MathJax: {
tex2jax: {
inlineMath: [['$', '$']],
displayMath: [['$$', '$$']]
}
}
});
}
const renderMathJax = (data, cb) => {
if (!config['modules']['mathjax']) {
return cb(data);
}
const parts = getParts(data);
const doMJ = (match, format, i) => {
const eq = match[1].trim();
const output = config['mathjax']['output_format'];
const mjConf = {
math: eq,
format: format,
speakText: config['mathjax']['speak_text']
};
mjConf[output] = true;
mjAPI.typeset(mjConf, (res) => {
data = data.slice(0, parts[i].index + match.index) + res[output] + data.slice(parts[i].index + match.index + match[0].length);
renderMathJax(data, (data2) => {
cb(data2);
});
});
};
const eqRegex = /\$\$((?:(?!\$\$)[\s\S])*)\$\$/m;
const inlineEqRegex = /\$([^$\n]*)\$/;
for (let i = 0; i < parts.length; i++) {
let match;
if ((match = eqRegex.exec(parts[i].text))) {
return doMJ(match, 'TeX', i);
} else if ((match = inlineEqRegex.exec(parts[i].text))) {
return doMJ(match, 'inline-TeX', i);
}
}
cb(data);
};
let faDiagrams;
let toml;
if (config['modules']['fa-diagrams']) {
faDiagrams = require('fa-diagrams');
toml = require('@iarna/toml');
}
const renderFaDiagrams = (data, cb) => {
if (!config['modules']['fa-diagrams']) {
return cb(data);
}
const parts = getParts(data);
const diagramsRegex = /@startfad\r?\n((?:(?!@endfad)[\s\S])*)\r?\n@endfad/m;
let match;
parts.forEach(part => {
while ((match = diagramsRegex.exec(part.text))) {
const code = match[1].trim();
let output;
try {
const diagData = toml.parse(code);
const findLineBreaks = (data) => {
Object.keys(data).forEach(key => {
if (typeof data[key] === 'object') {
findLineBreaks(data[key]);
} else if (typeof data[key] === 'string') {
data[key] = data[key].replace(/\\n/gm, '\n');
}
});
};
findLineBreaks(diagData);
output = faDiagrams.compute(diagData);
} catch (err) {
output = `<b style="color:red">${err.toString()}</b>`;
}
part.text = part.text.slice(0, match.index) + output + part.text.slice(match.index + match[0].length);
}
data = data.slice(0, part.index) + part.text + data.slice(part.end);
});
cb(data);
};
return {
getParts: config['test'] ? getParts : undefined,
renderShowDown: config['test'] ? renderShowDown : undefined,
renderPrism: config['test'] ? renderPrism : undefined,
renderPlantUML: config['test'] ? renderPlantUML : undefined,
renderMathJax: config['test'] ? renderMathJax : undefined,
renderFaDiagrams: config['test'] ? renderFaDiagrams : undefined,
render: (file, cb) => {
fs.readFile(file, {encoding: 'UTF-8'}, (err, data) => {
if (err) {
return cb(err);
}
renderPlantUML(data, (data) => {
renderFaDiagrams(data, (data) => {
renderMathJax(data, (data) => {
renderPrism(data, (data) => {
renderShowDown(data, (html) => {
cb(null, html);
});
});
});
});
});
});
}
};
}; };
src/script_loader.js
+1 -1
View File
@@ -5,6 +5,6 @@ const fs = require('fs');
* @param scriptPath * @param scriptPath
*/ */
module.exports = (scriptPath) => { module.exports = (scriptPath) => {
eval.call(global, fs.readFileSync(scriptPath, {encoding: 'UTF-8'})); eval.call(global, fs.readFileSync(scriptPath, {encoding: 'UTF-8'}));
}; };
test/app.test.js
+382 -383
View File
@@ -1,4 +1,3 @@
/* jshint -W117 */
const request = require('supertest'); const request = require('supertest');
const fs = require('fs'); const fs = require('fs');
const path = require('path'); const path = require('path');
@@ -22,453 +21,453 @@ config['article']['template'] = testTemplate;
const app = require('../src/app')(config); const app = require('../src/app')(config);
beforeEach((done, fail) => { beforeEach((done, fail) => {
config['home']['index'] = testIndex; config['home']['index'] = testIndex;
config['data_dir'] = dataDir; config['data_dir'] = dataDir;
config['article']['index'] = 'index.md'; config['article']['index'] = 'index.md';
config['access_log'] = ''; config['access_log'] = '';
config['error_log'] = ''; config['error_log'] = '';
config['modules']['rss'] = true; config['modules']['rss'] = true;
config['modules']['webhook'] = true; config['modules']['webhook'] = true;
utils.deleteFolderSync(dataDir); utils.deleteFolderSync(dataDir);
fs.mkdirSync(dataDir); fs.mkdirSync(dataDir);
app.reload(done, fail); app.reload(done, fail);
}); });
afterAll(() => { afterAll(() => {
if (fs.existsSync(dataDir)) { if (fs.existsSync(dataDir)) {
utils.deleteFolderSync(dataDir); utils.deleteFolderSync(dataDir);
} }
}); });
describe('Test reload', () => { describe('Test reload', () => {
test('reload fail', (done, fail) => { test('reload fail', (done, fail) => {
config['data_dir'] = ''; config['data_dir'] = '';
app.reload(fail, done); app.reload(fail, done);
}); });
}); });
describe('Test request logging', () => { describe('Test request logging', () => {
test('test no log', (done) => { test('no log', (done) => {
request(app).get('/rsstest').then(() => { request(app).get('/rsstest').then(() => {
expect(fs.existsSync(path.join(dataDir, 'access.log'))).toBe(false); expect(fs.existsSync(path.join(dataDir, 'access.log'))).toBe(false);
done(); done();
}); });
}); });
test('test get 200', (done) => { test('get 200', (done) => {
config['access_log'] = path.join(dataDir, 'access.log'); config['access_log'] = path.join(dataDir, 'access.log');
request(app).get('/rsstest').then(() => { request(app).get('/rsstest').then(() => {
fs.readFile(path.join(dataDir, 'access.log'), {encoding: 'UTF-8'}, (err, data) => { fs.readFile(path.join(dataDir, 'access.log'), {encoding: 'UTF-8'}, (err, data) => {
expect(err).toBeNull(); expect(err).toBeNull();
expect(data).toBe('200 GET /rsstest ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\n'); expect(data).toBe('200 GET /rsstest ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\n');
done(); done();
}); });
}); });
}); });
test('test post 400', (done) => { test('post 400', (done) => {
config['access_log'] = path.join(dataDir, 'access.log'); config['access_log'] = path.join(dataDir, 'access.log');
request(app).post('/rsstest').then(() => { request(app).post('/rsstest').then(() => {
fs.readFile(path.join(dataDir, 'access.log'), {encoding: 'UTF-8'}, (err, data) => { fs.readFile(path.join(dataDir, 'access.log'), {encoding: 'UTF-8'}, (err, data) => {
expect(err).toBeNull(); expect(err).toBeNull();
expect(data).toBe('400 POST /rsstest ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\n'); expect(data).toBe('400 POST /rsstest ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\n');
done(); done();
}); });
}); });
}); });
test('test 2 requests', (done) => { test('2 requests', (done) => {
config['access_log'] = path.join(dataDir, 'access.log'); config['access_log'] = path.join(dataDir, 'access.log');
request(app).get('/rss').then(() => { request(app).get('/rss').then(() => {
request(app).post('/rsstest').then(() => { request(app).post('/rsstest').then(() => {
fs.readFile(path.join(dataDir, 'access.log'), {encoding: 'UTF-8'}, (err, data) => { fs.readFile(path.join(dataDir, 'access.log'), {encoding: 'UTF-8'}, (err, data) => {
expect(err).toBeNull(); expect(err).toBeNull();
expect(data).toBe('404 GET /rss ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\n' + expect(data).toBe('404 GET /rss ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\n' +
'400 POST /rsstest ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\n'); '400 POST /rsstest ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\n');
done(); done();
});
});
}); });
});
}); });
});
}); });
describe('Test error logging', () => { describe('Test error logging', () => {
test('test no log', (done) => { test('no log', (done) => {
config['home']['index'] = null; config['home']['index'] = null;
request(app).get('/').then(() => { request(app).get('/').then(() => {
expect(fs.existsSync(path.join(dataDir, 'error.log'))).toBe(false); expect(fs.existsSync(path.join(dataDir, 'error.log'))).toBe(false);
done(); done();
});
}); });
}); test('null error', (done) => {
test('test null error ', (done) => { config['home']['index'] = null;
config['home']['index'] = null; config['error_log'] = path.join(dataDir, 'error.log');
config['error_log'] = path.join(dataDir, 'error.log'); request(app).get('/').then(() => {
request(app).get('/').then(() => { fs.readFile(path.join(dataDir, 'error.log'), {encoding: 'UTF-8'}, (err, data) => {
fs.readFile(path.join(dataDir, 'error.log'), {encoding: 'UTF-8'}, (err, data) => { expect(err).toBeNull();
expect(err).toBeNull(); const start = data.split('\n').slice(0, 2).join('\n');
const start = data.split('\n').slice(0, 2).join('\n'); const expected = '500 GET / ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\nTypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string.';
const expected = '500 GET / ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\nTypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string.'; expect(start.indexOf(expected)).toBe(0);
expect(start.indexOf(expected)).toBe(0); done();
done(); });
}); });
}); });
});
}); });
describe('Test root path', () => { describe('Test root path', () => {
test('404 no index no error', (done) => { test('404 no index no error', (done) => {
request(app).get('/').then((response) => { request(app).get('/').then((response) => {
expect(response.statusCode).toBe(404); expect(response.statusCode).toBe(404);
done(); done();
});
}); });
}); test('404 no index but error page', (done) => {
test('404 no index but error page', (done) => { fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %>');
fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %>'); request(app).get('/').then((response) => {
request(app).get('/').then((response) => { expect(response.statusCode).toBe(404);
expect(response.statusCode).toBe(404); expect(response.text).toBe('error 404');
expect(response.text).toBe('error 404'); done();
done(); });
}); });
}); test('500 render error', (done) => {
test('500 render error', (done) => { fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= null.length %>');
fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= null.length %>'); request(app).get('/').then((response) => {
request(app).get('/').then((response) => { expect(response.statusCode).toBe(500);
expect(response.statusCode).toBe(500); done();
done(); });
}); });
}); test('500 render error with page', (done) => {
test('500 render error with page', (done) => { fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= null.length %>');
fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= null.length %>'); fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %>');
fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %>'); request(app).get('/').then((response) => {
request(app).get('/').then((response) => { expect(response.statusCode).toBe(500);
expect(response.statusCode).toBe(500); expect(response.text).toBe('error 500');
expect(response.text).toBe('error 500'); done();
done(); });
}); });
}); test('500 render error with failing page', (done) => {
test('500 render error with failing page', (done) => { fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= null.length %>');
fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= null.length %>'); fs.writeFileSync(path.join(dataDir, testError), 'error <%= null.error %>');
fs.writeFileSync(path.join(dataDir, testError), 'error <%= null.error %>'); request(app).get('/').then((response) => {
request(app).get('/').then((response) => { expect(response.statusCode).toBe(500);
expect(response.statusCode).toBe(500); done();
done(); });
}); });
}); test('200 no articles', (done) => {
test('200 no articles', (done) => { fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= articles.length %>');
fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= articles.length %>'); request(app).get('/').then((response) => {
request(app).get('/').then((response) => { expect(response.statusCode).toBe(200);
expect(response.statusCode).toBe(200); expect(response.text).toBe('articles 0');
expect(response.text).toBe('articles 0'); done();
done(); });
});
test('200 2 articles 1 drafted', (done, fail) => {
utils.createEmptyDirs([
path.join(dataDir, '2019', '05', '05'),
path.join(dataDir, '2018', '05', '05'),
path.join(dataDir, '2017', '05', '05')
]);
utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'draft.md'),
path.join(dataDir, '2018', '05', '05', 'index.md'),
path.join(dataDir, '2018', '05', '05', 'draft.md'),
path.join(dataDir, '2017', '05', '05', 'index.md'),
]);
fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= articles.length %>');
app.reload(() => {
request(app).get('/').then((response) => {
expect(response.statusCode).toBe(200);
expect(response.text).toBe('articles 2');
done();
});
}, fail);
}); });
});
test('200 2 articles 1 drafted', (done, fail) => {
utils.createEmptyDirs([
path.join(dataDir, '2019', '05', '05'),
path.join(dataDir, '2018', '05', '05'),
path.join(dataDir, '2017', '05', '05')
]);
utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'draft.md'),
path.join(dataDir, '2018', '05', '05', 'index.md'),
path.join(dataDir, '2018', '05', '05', 'draft.md'),
path.join(dataDir, '2017', '05', '05', 'index.md'),
]);
fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= articles.length %>');
app.reload(() => {
request(app).get('/').then((response) => {
expect(response.statusCode).toBe(200);
expect(response.text).toBe('articles 2');
done();
});
}, fail);
});
}); });
describe('Test RSS feed', () => { describe('Test RSS feed', () => {
test('404 rss deactivated', (done) => { test('404 rss deactivated', (done) => {
config['modules']['rss'] = false; config['modules']['rss'] = false;
request(app).get('/rsstest').then((response) => { request(app).get('/rsstest').then((response) => {
expect(response.statusCode).toBe(404); expect(response.statusCode).toBe(404);
done(); done();
});
}); });
}); test('200 empty rss', (done) => {
test('200 empty rss', (done) => { request(app).get('/rsstest').then((response) => {
request(app).get('/rsstest').then((response) => { expect(response.statusCode).toBe(200);
expect(response.statusCode).toBe(200); expect(response.type).toBe('application/rss+xml');
expect(response.type).toBe('application/rss+xml'); expect(response.text.length).toBeGreaterThan(0);
expect(response.text.length).toBeGreaterThan(0); expect(response.text.split('<item>').length).toBe(1);
expect(response.text.split('<item>').length).toBe(1); done();
done(); });
}); });
}); test('200 Mozilla fix', (done) => {
test('200 Mozilla fix', (done) => { request(app).get('/rsstest').set('user-agent', 'Mozilla Firefox 64.0').then((response) => {
request(app).get('/rsstest').set('user-agent', 'Mozilla Firefox 64.0').then((response) => { expect(response.statusCode).toBe(200);
expect(response.statusCode).toBe(200); expect(response.type).toBe('text/xml');
expect(response.type).toBe('text/xml'); done();
done(); });
}); });
}); test('200 rss cache', (done) => {
test('200 rss cache', (done) => { request(app).get('/rsstest').then(() => {
request(app).get('/rsstest').then(() => { request(app).get('/rsstest').then((response) => {
request(app).get('/rsstest').then((response) => { expect(response.statusCode).toBe(200);
expect(response.statusCode).toBe(200); expect(response.text.length).toBeGreaterThan(0);
expect(response.text.length).toBeGreaterThan(0); expect(response.text.split('<item>').length).toBe(1);
expect(response.text.split('<item>').length).toBe(1); done();
done(); });
}); });
});
test('200 2 rss items', (done, fail) => {
utils.createEmptyDirs([
path.join(dataDir, '2019', '05', '05'),
path.join(dataDir, '2018', '05', '05')
]);
utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, '2018', '05', '05', 'index.md')
]);
app.reload(() => {
request(app).get('/rsstest').then((response) => {
expect(response.statusCode).toBe(200);
expect(response.text.length).toBeGreaterThan(0);
expect(response.text.split('<item>').length).toBe(3);
done();
});
}, fail);
});
test('200 max rss items', (done, fail) => {
utils.createEmptyDirs([
path.join(dataDir, '2019', '05', '05'),
path.join(dataDir, '2018', '05', '05'),
path.join(dataDir, '2017', '05', '05')
]);
utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, '2018', '05', '05', 'index.md'),
path.join(dataDir, '2017', '05', '05', 'index.md')
]);
app.reload(() => {
request(app).get('/rsstest').then((response) => {
expect(response.statusCode).toBe(200);
expect(response.text.length).toBeGreaterThan(0);
expect(response.text.split('<item>').length).toBe(3);
done();
});
}, fail);
}); });
});
test('200 2 rss items', (done, fail) => {
utils.createEmptyDirs([
path.join(dataDir, '2019', '05', '05'),
path.join(dataDir, '2018', '05', '05')
]);
utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, '2018', '05', '05', 'index.md')
]);
app.reload(() => {
request(app).get('/rsstest').then((response) => {
expect(response.statusCode).toBe(200);
expect(response.text.length).toBeGreaterThan(0);
expect(response.text.split('<item>').length).toBe(3);
done();
});
}, fail);
});
test('200 max rss items', (done, fail) => {
utils.createEmptyDirs([
path.join(dataDir, '2019', '05', '05'),
path.join(dataDir, '2018', '05', '05'),
path.join(dataDir, '2017', '05', '05')
]);
utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, '2018', '05', '05', 'index.md'),
path.join(dataDir, '2017', '05', '05', 'index.md')
]);
app.reload(() => {
request(app).get('/rsstest').then((response) => {
expect(response.statusCode).toBe(200);
expect(response.text.length).toBeGreaterThan(0);
expect(response.text.split('<item>').length).toBe(3);
done();
});
}, fail);
});
}); });
describe('Test webhook', () => { describe('Test webhook', () => {
test('400 webhook deactivated', (done) => { test('400 webhook deactivated', (done) => {
config['modules']['webhook'] = false; config['modules']['webhook'] = false;
request(app).post('/webhooktest').then((response) => { request(app).post('/webhooktest').then((response) => {
expect(response.statusCode).toBe(400); expect(response.statusCode).toBe(400);
done(); done();
});
}); });
}); test('200 no secret', (done) => {
test('200 no secret', (done) => { utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]); utils.createEmptyFiles([
utils.createEmptyFiles([ path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, '2019', '05', '05', 'index.md'), path.join(dataDir, testTemplate)
path.join(dataDir, testTemplate) ]);
]); config['webhook']['pull_command'] = 'git --help';
config['webhook']['pull_command'] = 'git --help'; request(app).post('/webhooktest').then((response) => {
request(app).post('/webhooktest').then((response) => { expect(response.statusCode).toBe(200);
expect(response.statusCode).toBe(200); request(app).get('/2019/05/05/').then((response) => {
request(app).get('/2019/05/05/').then((response) => { expect(response.statusCode).toBe(200);
expect(response.statusCode).toBe(200); done();
done(); });
}); });
}); });
}); test('500 command failed', (done) => {
test('500 command failed', (done) => { utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]); utils.createEmptyFiles([
utils.createEmptyFiles([ path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, '2019', '05', '05', 'index.md'), path.join(dataDir, testTemplate)
path.join(dataDir, testTemplate) ]);
]); config['webhook']['pull_command'] = 'qzgfqgqz';
config['webhook']['pull_command'] = 'qzgfqgqz'; request(app).post('/webhooktest').then((response) => {
request(app).post('/webhooktest').then((response) => { expect(response.statusCode).toBe(500);
expect(response.statusCode).toBe(500); done();
done(); });
}); });
}); test('403 wrong secret', (done) => {
test('403 wrong secret', (done) => { config['webhook']['signature_header'] = 'testheader';
config['webhook']['signature_header'] = 'testheader'; config['webhook']['secret'] = 'testvalue';
config['webhook']['secret'] = 'testvalue'; request(app).post('/webhooktest').set('testheader', 'sha1=invalid').then((response) => {
request(app).post('/webhooktest').set('testheader', 'sha1=invalid').then((response) => { expect(response.statusCode).toBe(403);
expect(response.statusCode).toBe(403); done();
done(); });
}); });
}); test('200 valid secret', (done) => {
test('200 valid secret', (done) => { config['webhook']['signature_header'] = 'testheader';
config['webhook']['signature_header'] = 'testheader'; config['webhook']['secret'] = 'testvalue';
config['webhook']['secret'] = 'testvalue'; config['webhook']['pull_command'] = 'git --help';
config['webhook']['pull_command'] = 'git --help'; request(app).post('/webhooktest')
request(app).post('/webhooktest') .send({})
.send({}) .set('testheader', 'sha1=d924d5bd4b36faf9d572844ac9c12a09ce3e7134')
.set('testheader', 'sha1=d924d5bd4b36faf9d572844ac9c12a09ce3e7134') .then((response) => {
.then((response) => { expect(response.statusCode).toBe(200);
expect(response.statusCode).toBe(200); done();
done(); });
}); });
});
}); });
describe('Test articles rendering', () => { describe('Test articles rendering', () => {
test('404 article not found', (done) => { test('404 article not found', (done) => {
request(app).get('/2019/05/06/untitled/').then((response) => { request(app).get('/2019/05/06/untitled/').then((response) => {
expect(response.statusCode).toBe(404); expect(response.statusCode).toBe(404);
done(); done();
});
}); });
});
test('500 fail to render', (done, fail) => { test('500 fail to render', (done, fail) => {
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]); utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'index.md'), '# Hello'); fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'index.md'), '# Hello');
fs.writeFileSync(path.join(dataDir, testTemplate), '<%- articl.content %><%- `<a href="${article.url}">reload</a>` %>'); fs.writeFileSync(path.join(dataDir, testTemplate), '<%- articl.content %><%- `<a href="${article.url}">reload</a>` %>');
app.reload(() => { app.reload(() => {
request(app).get('/2019/05/05/hello/').then((response) => { request(app).get('/2019/05/05/hello/').then((response) => {
expect(response.statusCode).toBe(500); expect(response.statusCode).toBe(500);
done(); done();
}); });
}, fail); }, fail);
}); });
test('500 no template', (done, fail) => { test('500 no template', (done, fail) => {
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]); utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'index.md'), '# Hello'); fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'index.md'), '# Hello');
app.reload(() => { app.reload(() => {
request(app).get('/2019/05/05/hello/').then((response) => { request(app).get('/2019/05/05/hello/').then((response) => {
expect(response.statusCode).toBe(500); expect(response.statusCode).toBe(500);
done(); done();
}); });
}, fail); }, fail);
}); });
test('200 rendered article', (done, fail) => { test('200 rendered article', (done, fail) => {
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]); utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'index.md'), '# Hello'); fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'index.md'), '# Hello');
fs.writeFileSync(path.join(dataDir, testTemplate), '<%- article.content %><%- `<a href="${article.url}">reload</a>` %>'); fs.writeFileSync(path.join(dataDir, testTemplate), '<%- article.content %><%- `<a href="${article.url}">reload</a>` %>');
app.reload(() => { app.reload(() => {
request(app).get('/2019/05/05/hello/').then((response) => { request(app).get('/2019/05/05/hello/').then((response) => {
expect(response.statusCode).toBe(200); expect(response.statusCode).toBe(200);
expect(response.text).toBe('<h1 id="hello">Hello</h1><a href="/2019/05/05/hello/">reload</a>'); expect(response.text).toBe('<h1 id="hello">Hello</h1><a href="/2019/05/05/hello/">reload</a>');
done(); done();
}); });
}, fail); }, fail);
}); });
test('200 rendered draft', (done, fail) => { test('200 rendered draft', (done, fail) => {
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]); utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'draft.md'), '# Hello'); fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'draft.md'), '# Hello');
fs.writeFileSync(path.join(dataDir, testTemplate), '<%- article.content %><%- `<a href="${article.url}">reload</a>` %>'); fs.writeFileSync(path.join(dataDir, testTemplate), '<%- article.content %><%- `<a href="${article.url}">reload</a>` %>');
app.reload(() => { app.reload(() => {
request(app).get('/2019/05/05/hello/').then((response) => { request(app).get('/2019/05/05/hello/').then((response) => {
expect(response.statusCode).toBe(200); expect(response.statusCode).toBe(200);
expect(response.text).toBe('<h1 id="hello">Hello</h1><a href="/2019/05/05/hello/">reload</a>'); expect(response.text).toBe('<h1 id="hello">Hello</h1><a href="/2019/05/05/hello/">reload</a>');
done(); done();
}); });
}, fail); }, fail);
}); });
test('200 other url', (done, fail) => { test('200 other url', (done, fail) => {
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]); utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
utils.createEmptyFiles([ utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'index.md'), path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, testTemplate) path.join(dataDir, testTemplate)
]); ]);
app.reload(() => { app.reload(() => {
request(app).get('/2019/05/05/anything/').then((response) => { request(app).get('/2019/05/05/anything/').then((response) => {
expect(response.statusCode).toBe(200); expect(response.statusCode).toBe(200);
done(); done();
}); });
}, fail); }, fail);
}); });
test('200 other url 2', (done, fail) => { test('200 other url 2', (done, fail) => {
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]); utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
utils.createEmptyFiles([ utils.createEmptyFiles([
path.join(dataDir, '2019', '05', '05', 'index.md'), path.join(dataDir, '2019', '05', '05', 'index.md'),
path.join(dataDir, testTemplate) path.join(dataDir, testTemplate)
]); ]);
app.reload(() => { app.reload(() => {
request(app).get('/2019/05/05/').then((response) => { request(app).get('/2019/05/05/').then((response) => {
expect(response.statusCode).toBe(200); expect(response.statusCode).toBe(200);
done(); done();
}); });
}, fail); }, fail);
}); });
}); });
describe('Test static files', () => { describe('Test static files', () => {
test('404 invalid file no error page', (done) => { test('404 invalid file no error page', (done) => {
request(app).get('/somefile.txt').then((response) => { request(app).get('/somefile.txt').then((response) => {
expect(response.statusCode).toBe(404); expect(response.statusCode).toBe(404);
done(); done();
});
}); });
}); test('404 invalid file but error page', (done) => {
test('404 invalid file but error page', (done) => { fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %>');
fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %>'); request(app).get('/somefile.txt').then((response) => {
request(app).get('/somefile.txt').then((response) => { expect(response.statusCode).toBe(404);
expect(response.statusCode).toBe(404); expect(response.text).toBe('error 404');
expect(response.text).toBe('error 404'); done();
done(); });
}); });
}); test('404 hidden file', (done) => {
test('404 hidden file', (done) => { utils.createEmptyDirs([path.join(dataDir, 'tmp')]);
utils.createEmptyDirs([path.join(dataDir, 'tmp')]); fs.writeFileSync(path.join(dataDir, 'tmp', 'somefile.ejs'), '');
fs.writeFileSync(path.join(dataDir, 'tmp', 'somefile.ejs'), ''); request(app).get('/tmp/somefile.ejs').then((response) => {
request(app).get('/tmp/somefile.ejs').then((response) => { expect(response.statusCode).toBe(404);
expect(response.statusCode).toBe(404); done();
done(); });
}); });
}); test('404 hidden folder', (done) => {
test('404 hidden folder', (done) => { utils.createEmptyDirs([path.join(dataDir, '.git')]);
utils.createEmptyDirs([path.join(dataDir, '.git')]); fs.writeFileSync(path.join(dataDir, '.git', 'file.txt'), '');
fs.writeFileSync(path.join(dataDir, '.git', 'file.txt'), ''); request(app).get('/.git/file.txt').then((response) => {
request(app).get('/.git/file.txt').then((response) => { expect(response.statusCode).toBe(404);
expect(response.statusCode).toBe(404); done();
done(); });
}); });
}); test('200 valid file', (done) => {
test('200 valid file', (done) => { fs.writeFileSync(path.join(dataDir, 'somefile.css'), 'filecontent');
fs.writeFileSync(path.join(dataDir, 'somefile.css'), 'filecontent'); request(app).get('/somefile.css').then((response) => {
request(app).get('/somefile.css').then((response) => { expect(response.statusCode).toBe(200);
expect(response.statusCode).toBe(200); expect(response.type).toBe('text/css');
expect(response.type).toBe('text/css'); expect(response.text).toBe('filecontent');
expect(response.text).toBe('filecontent'); done();
done(); });
}); });
}); test('200 valid resource of article', (done) => {
test('200 valid resource of article', (done) => { utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]); fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'somefile.txt'), 'filecontent');
fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'somefile.txt'), 'filecontent'); request(app).get('/2019/05/05/title/somefile.txt').then((response) => {
request(app).get('/2019/05/05/title/somefile.txt').then((response) => { expect(response.statusCode).toBe(200);
expect(response.statusCode).toBe(200); expect(response.text).toBe('filecontent');
expect(response.text).toBe('filecontent'); done();
done(); });
}); });
});
}); });
describe('Test other requests', () => { describe('Test other requests', () => {
test('400 POST', (done) => { test('400 POST', (done) => {
request(app).post('/').then((response) => { request(app).post('/').then((response) => {
expect(response.statusCode).toBe(400); expect(response.statusCode).toBe(400);
done(); done();
});
}); });
}); test('400 PUT', (done) => {
test('400 PUT', (done) => { request(app).put('/').then((response) => {
request(app).put('/').then((response) => { expect(response.statusCode).toBe(400);
expect(response.statusCode).toBe(400); done();
done(); });
}); });
}); test('400 DELETE', (done) => {
test('400 DELETE', (done) => { request(app).delete('/').then((response) => {
request(app).delete('/').then((response) => { expect(response.statusCode).toBe(400);
expect(response.statusCode).toBe(400); done();
done(); });
}); });
});
}); });
test/config.test.js
+50 -49
View File
@@ -1,4 +1,3 @@
/* jshint -W117 */
const fs = require('fs'); const fs = require('fs');
const path = require('path'); const path = require('path');
@@ -6,76 +5,78 @@ const configFile = 'config.json';
const tmpConfigFile = 'config.temp.json'; const tmpConfigFile = 'config.temp.json';
beforeAll(() => { beforeAll(() => {
if (fs.existsSync(configFile)) { if (fs.existsSync(configFile)) {
fs.renameSync(configFile, tmpConfigFile); fs.renameSync(configFile, tmpConfigFile);
} }
expect(fs.existsSync(configFile)).toBeFalsy(); expect(fs.existsSync(configFile)).toBeFalsy();
}); });
afterAll(() => { afterAll(() => {
if (fs.existsSync(tmpConfigFile)) { if (fs.existsSync(tmpConfigFile)) {
fs.renameSync(tmpConfigFile, configFile); fs.renameSync(tmpConfigFile, configFile);
} else if (fs.existsSync(configFile)) { } else if (fs.existsSync(configFile)) {
fs.unlinkSync(configFile); //remove config file if remaining fs.unlinkSync(configFile); //remove config file if remaining
} }
}); });
test('no config', () => { test('no config', () => {
if (fs.existsSync(configFile)) if (fs.existsSync(configFile)) {
fs.unlinkSync(configFile); fs.unlinkSync(configFile);
expect(fs.existsSync(configFile)).toBeFalsy(); }
const config = require('../src/config')(); expect(fs.existsSync(configFile)).toBeFalsy();
expect(config).toBeDefined(); const config = require('../src/config')();
expect(config['node_port']).toBe(3000); expect(config).toBeDefined();
expect(config['data_dir']).toBe('data'); expect(config['node_port']).toBe(3000);
expect(config['data_dir']).toBe('data');
}); });
test('example config', () => { test('example config', () => {
if (fs.existsSync(configFile)) if (fs.existsSync(configFile)) {
fs.unlinkSync(configFile); fs.unlinkSync(configFile);
fs.copyFileSync(path.join('src', 'config.default.json'), configFile); }
const data = fs.readFileSync(configFile, {encoding: 'UTF-8'}); fs.copyFileSync(path.join('src', 'config.default.json'), configFile);
fs.writeFileSync(configFile, data.replace('3000', '3333'), {encoding: 'UTF-8'}); const data = fs.readFileSync(configFile, {encoding: 'UTF-8'});
const config = require('../src/config')(); fs.writeFileSync(configFile, data.replace('3000', '3333'), {encoding: 'UTF-8'});
expect(config).toBeDefined(); const config = require('../src/config')();
expect(config['node_port']).toBe(3333); expect(config).toBeDefined();
expect(config['data_dir']).toBe('data'); expect(config['node_port']).toBe(3333);
expect(config['data_dir']).toBe('data');
}); });
test('invalid config ignored', () => { test('invalid config ignored', () => {
fs.writeFileSync(configFile, 'invalid JSON'); fs.writeFileSync(configFile, 'invalid JSON');
const config = require('../src/config')(); const config = require('../src/config')();
expect(config).toBeDefined(); expect(config).toBeDefined();
expect(config['node_port']).toBe(3000); expect(config['node_port']).toBe(3000);
expect(config['data_dir']).toBe('data'); expect(config['data_dir']).toBe('data');
}); });
test('good config merged', () => { test('good config merged', () => {
fs.writeFileSync(configFile, '{"node_port":5000}'); fs.writeFileSync(configFile, '{"node_port":5000}');
const config = require('../src/config')(); const config = require('../src/config')();
expect(config).toBeDefined(); expect(config).toBeDefined();
expect(config['node_port']).toBe(5000); expect(config['node_port']).toBe(5000);
expect(config['data_dir']).toBe('data'); expect(config['data_dir']).toBe('data');
}); });
test('wrong config fixed', () => { test('wrong config fixed', () => {
fs.writeFileSync(configFile, '{"node_port":"hello","data_dir":"data2"}'); fs.writeFileSync(configFile, '{"node_port":"hello","data_dir":"data2"}');
const config = require('../src/config')(); const config = require('../src/config')();
expect(config).toBeDefined(); expect(config).toBeDefined();
expect(config['node_port']).toBe(3000); expect(config['node_port']).toBe(3000);
expect(config['data_dir']).toBe('data2'); expect(config['data_dir']).toBe('data2');
}); });
test('array parsing', () => { test('array parsing', () => {
fs.writeFileSync(configFile, '{"home":{"hidden":["item1","item2"]}}'); fs.writeFileSync(configFile, '{"home":{"hidden":["item1","item2"]}}');
const config = require('../src/config')(); const config = require('../src/config')();
expect(config).toBeDefined(); expect(config).toBeDefined();
expect(config['home']['hidden']).toEqual(['item1', 'item2']); expect(config['home']['hidden']).toEqual(['item1', 'item2']);
}); });
test('array fix', () => { test('array fix', () => {
fs.writeFileSync(configFile, '{"home":{"hidden":{}}}'); fs.writeFileSync(configFile, '{"home":{"hidden":{}}}');
const config = require('../src/config')(); const config = require('../src/config')();
expect(config).toBeDefined(); expect(config).toBeDefined();
expect(config['home']['hidden']).toEqual(['*.ejs', '/.git*']); expect(config['home']['hidden']).toEqual(['*.ejs', '/.git*']);
}); });
test/file_walker.test.js
+265 -266
View File
@@ -1,4 +1,3 @@
/* jshint -W117 */
const fs = require('fs'); const fs = require('fs');
const path = require('path'); const path = require('path');
const utils = require('./test_utils'); const utils = require('./test_utils');
@@ -9,336 +8,336 @@ const testIndex = 'testindex.md';
const joinUrl = (...paths) => path.join(...paths).replace(/\\/g, '/'); const joinUrl = (...paths) => path.join(...paths).replace(/\\/g, '/');
const config = { const config = {
'test': true, 'test': true,
'data_dir': dataDir, 'data_dir': dataDir,
'article': { 'article': {
'index': testIndex, 'index': testIndex,
'draft': 'draft.md', 'draft': 'draft.md',
'default_title': 'Untitled', 'default_title': 'Untitled',
'default_thumbnail': 'default.png', 'default_thumbnail': 'default.png',
'thumbnail_tag': 'thumbnail' 'thumbnail_tag': 'thumbnail'
} }
}; };
const fw = require('../src/file_walker')(config); const fw = require('../src/file_walker')(config);
beforeEach(() => { beforeEach(() => {
config['data_dir'] = dataDir; config['data_dir'] = dataDir;
utils.deleteFolderSync(dataDir); utils.deleteFolderSync(dataDir);
fs.mkdirSync(dataDir); fs.mkdirSync(dataDir);
}); });
afterAll(() => { afterAll(() => {
if (fs.existsSync(dataDir)) { if (fs.existsSync(dataDir)) {
utils.deleteFolderSync(dataDir); utils.deleteFolderSync(dataDir);
} }
}); });
describe('Test function fileTree', () => { describe('Test function fileTree', () => {
test('empty root', (done) => { test('empty root', (done) => {
fw.fileTree(dataDir, (err, list) => { fw.fileTree(dataDir, (err, list) => {
expect(err).toBeNull(); expect(err).toBeNull();
expect(list).toBeDefined(); expect(list).toBeDefined();
expect(list.length).toBe(0); expect(list.length).toBe(0);
done(); done();
});
}); });
}); test('empty folders', (done) => {
test('empty folders', (done) => { utils.createEmptyDirs([
utils.createEmptyDirs([ path.join(dataDir, 'test', 'test'),
path.join(dataDir, 'test', 'test'), path.join(dataDir, 'test', 'test2'),
path.join(dataDir, 'test', 'test2'), path.join(dataDir, 'test2')
path.join(dataDir, 'test2') ]);
]); fw.fileTree(dataDir, (err, list) => {
fw.fileTree(dataDir, (err, list) => { expect(err).toBeNull();
expect(err).toBeNull(); expect(list).toBeDefined();
expect(list).toBeDefined(); expect(list.length).toBe(0);
expect(list.length).toBe(0); done();
done(); });
}); });
}); test('simple files', (done) => {
test('simple files', (done) => { const fileList = [
const fileList = [ path.join(dataDir, 'f1.txt'),
path.join(dataDir, 'f1.txt'), path.join(dataDir, 'f2.txt')
path.join(dataDir, 'f2.txt') ];
]; utils.createEmptyFiles(fileList);
utils.createEmptyFiles(fileList); fw.fileTree(dataDir, (err, list) => {
fw.fileTree(dataDir, (err, list) => { expect(err).toBeNull();
expect(err).toBeNull(); expect(list).toBeDefined();
expect(list).toBeDefined(); expect(list.length).toBe(fileList.length);
expect(list.length).toBe(fileList.length); expect(list).toEqual(expect.arrayContaining(fileList));
expect(list).toEqual(expect.arrayContaining(fileList)); done();
done(); });
}); });
}); test('nested files', (done) => {
test('nested files', (done) => { utils.createEmptyDirs([
utils.createEmptyDirs([ path.join(dataDir, 'test', 'test'),
path.join(dataDir, 'test', 'test'), path.join(dataDir, 'test2')
path.join(dataDir, 'test2') ]);
]); const fileList = [
const fileList = [ path.join(dataDir, 'f1.txt'),
path.join(dataDir, 'f1.txt'), path.join(dataDir, 'test', 'f2.txt'),
path.join(dataDir, 'test', 'f2.txt'), path.join(dataDir, 'test', 'test', 'f3.txt'),
path.join(dataDir, 'test', 'test', 'f3.txt'), path.join(dataDir, 'test2', 'f4.txt')
path.join(dataDir, 'test2', 'f4.txt') ];
]; utils.createEmptyFiles(fileList);
utils.createEmptyFiles(fileList); fw.fileTree(dataDir, (err, list) => {
fw.fileTree(dataDir, (err, list) => { expect(err).toBeNull();
expect(err).toBeNull(); expect(list).toBeDefined();
expect(list).toBeDefined(); expect(list.length).toBe(fileList.length);
expect(list.length).toBe(fileList.length); expect(list).toEqual(expect.arrayContaining(fileList));
expect(list).toEqual(expect.arrayContaining(fileList)); done();
done(); });
}); });
}); test('invalid root', (done) => {
test('invalid root', (done) => { fw.fileTree('invalid root', (err, list) => {
fw.fileTree('invalid root', (err, list) => { expect(err).not.toBeNull();
expect(err).not.toBeNull(); expect(list).not.toBeDefined();
expect(list).not.toBeDefined(); done();
done(); });
}); });
});
}); });
describe('Test index article reading', () => { describe('Test index article reading', () => {
const file = path.join(dataDir, testIndex); const file = path.join(dataDir, testIndex);
test('invalid file', (done) => {
fw.readIndexFile('invalid file', 'thumbnail', (err, info) => {
expect(err).not.toBeNull();
expect(info).not.toBeDefined();
done();
});
test('invalid file', (done) => {
fw.readIndexFile('invalid file', 'thumbnail', (err, info) => {
expect(err).not.toBeNull();
expect(info).not.toBeDefined();
done();
}); });
}); test('correct file', (done) => {
fs.writeFileSync(file, `
test('correct file', (done) => {
fs.writeFileSync(file, `
# This is an awesome title !?¤ # This is an awesome title !?¤
![custom_thumbnail](./thumbnail.jpg) ![custom_thumbnail](./thumbnail.jpg)
this is some text this is some text
`); `);
fw.readIndexFile(file, 'custom_thumbnail', (err, info) => { fw.readIndexFile(file, 'custom_thumbnail', (err, info) => {
expect(err).toBeNull(); expect(err).toBeNull();
expect(info).toEqual({ expect(info).toEqual({
title: 'This is an awesome title !?¤', title: 'This is an awesome title !?¤',
thumbnail: './thumbnail.jpg' thumbnail: './thumbnail.jpg'
}); });
done(); done();
});
}); });
});
test('no title', (done) => { test('no title', (done) => {
fs.writeFileSync(file, ` fs.writeFileSync(file, `
## This is an awesome title !?¤ ## This is an awesome title !?¤
![custom_thumbnail](./thumbnail.jpg) ![custom_thumbnail](./thumbnail.jpg)
### this is some text ### this is some text
`); `);
fw.readIndexFile(file, 'custom_thumbnail', (err, info) => { fw.readIndexFile(file, 'custom_thumbnail', (err, info) => {
expect(err).toBeNull(); expect(err).toBeNull();
expect(info).toEqual({ expect(info).toEqual({
title: undefined, title: undefined,
thumbnail: './thumbnail.jpg' thumbnail: './thumbnail.jpg'
}); });
done(); done();
});
}); });
});
test('title at beginning', (done) => { test('title at beginning', (done) => {
fs.writeFileSync(file, '#title'); fs.writeFileSync(file, '#title');
fw.readIndexFile(file, 'custom_thumbnail', (err, info) => { fw.readIndexFile(file, 'custom_thumbnail', (err, info) => {
expect(err).toBeNull(); expect(err).toBeNull();
expect(info).toEqual({ expect(info).toEqual({
title: 'title', title: 'title',
thumbnail: undefined thumbnail: undefined
}); });
done(); done();
});
}); });
});
test('no thumbnail', (done) => { test('no thumbnail', (done) => {
fs.writeFileSync(file, ` fs.writeFileSync(file, `
# This is an awesome title !?¤ # This is an awesome title !?¤
![custom_thumbnail](./thumbnail.jpg) ![custom_thumbnail](./thumbnail.jpg)
this is some text this is some text
`); `);
fw.readIndexFile(file, 'thumbnail', (err, info) => { fw.readIndexFile(file, 'thumbnail', (err, info) => {
expect(err).toBeNull(); expect(err).toBeNull();
expect(info).toEqual({ expect(info).toEqual({
title: 'This is an awesome title !?¤', title: 'This is an awesome title !?¤',
thumbnail: undefined thumbnail: undefined
}); });
done(); done();
});
}); });
});
test('multiple thumbnails', (done) => { test('multiple thumbnails', (done) => {
fs.writeFileSync(file, ` fs.writeFileSync(file, `
# This is an awesome title !?¤ # This is an awesome title !?¤
![custom_thumbnail](./thumbnail.jpg) ![custom_thumbnail](./thumbnail.jpg)
this is some text this is some text
![custom_thumbnail](./thumbnail2.jpg) ![custom_thumbnail](./thumbnail2.jpg)
`); `);
fw.readIndexFile(file, 'custom_thumbnail', (err, info) => { fw.readIndexFile(file, 'custom_thumbnail', (err, info) => {
expect(err).toBeNull(); expect(err).toBeNull();
expect(info).toEqual({ expect(info).toEqual({
title: 'This is an awesome title !?¤', title: 'This is an awesome title !?¤',
thumbnail: './thumbnail.jpg' thumbnail: './thumbnail.jpg'
}); });
done(); done();
});
}); });
});
}); });
describe('Test article fetching', () => { describe('Test article fetching', () => {
test('invalid data dir', (done) => { test('invalid data dir', (done) => {
config['data_dir'] = 'invalid root'; config['data_dir'] = 'invalid root';
fw.fetchArticles((err, list) => { fw.fetchArticles((err, list) => {
expect(err).not.toBeNull(); expect(err).not.toBeNull();
expect(list).not.toBeDefined(); expect(list).not.toBeDefined();
done(); done();
});
}); });
}); test('empty data dir', (done) => {
test('empty data dir', (done) => { fw.fetchArticles((err, dict) => {
fw.fetchArticles((err, dict) => { expect(err).toBeNull();
expect(err).toBeNull(); expect(dict).toBeDefined();
expect(dict).toBeDefined(); expect(Object.keys(dict).length).toBe(0);
expect(Object.keys(dict).length).toBe(0); done();
done(); });
}); });
}); test('misplaced index file', (done) => {
test('misplaced index file', (done) => { utils.createEmptyDirs([
utils.createEmptyDirs([ path.join(dataDir, 'test', 'test'),
path.join(dataDir, 'test', 'test'), path.join(dataDir, '2019', '05', '05')
path.join(dataDir, '2019', '05', '05') ]);
]); utils.createEmptyFiles([
utils.createEmptyFiles([ path.join(dataDir, testIndex),
path.join(dataDir, testIndex), path.join(dataDir, 'test', 'test', testIndex),
path.join(dataDir, 'test', 'test', testIndex), path.join(dataDir, '2019', '05', testIndex)
path.join(dataDir, '2019', '05', testIndex) ]);
]); fw.fetchArticles((err, dict) => {
fw.fetchArticles((err, dict) => { expect(err).toBeNull();
expect(err).toBeNull(); expect(dict).toBeDefined();
expect(dict).toBeDefined(); expect(Object.keys(dict).length).toBe(0);
expect(Object.keys(dict).length).toBe(0); done();
done(); });
}); });
}); test('empty index file', (done) => {
test('empty index file', (done) => { const dir = path.join(dataDir, '2019', '05', '05');
const dir = path.join(dataDir, '2019', '05', '05'); const file = path.join(dir, testIndex);
const file = path.join(dir, testIndex); utils.createEmptyDirs([dir]);
utils.createEmptyDirs([dir]); utils.createEmptyFiles([file]);
utils.createEmptyFiles([file]); const date = new Date(2019, 5, 5);
const date = new Date(2019, 5, 5); date.setUTCHours(0);
date.setUTCHours(0); fw.fetchArticles((err, dict) => {
fw.fetchArticles((err, dict) => { expect(err).toBeNull();
expect(err).toBeNull(); expect(dict).toBeDefined();
expect(dict).toBeDefined(); expect(Object.keys(dict).length).toBe(1);
expect(Object.keys(dict).length).toBe(1); expect(dict[joinUrl('2019', '05', '05')]).toEqual({
expect(dict[joinUrl('2019', '05', '05')]).toEqual({ path: joinUrl('2019', '05', '05'),
path: joinUrl('2019', '05', '05'), realPath: file,
realPath: file, year: 2019,
year: 2019, month: 5,
month: 5, draft: false,
draft: false, day: 5,
day: 5, date: date,
date: date, title: 'Untitled',
title: 'Untitled', thumbnail: 'default.png',
thumbnail: 'default.png', escapedTitle: 'untitled',
escapedTitle: 'untitled', url: '/' + joinUrl('2019', '05', '05', 'untitled') + '/',
url: '/' + joinUrl('2019', '05', '05', 'untitled') + '/', });
}); done();
done(); });
}); });
}); test('correct index file', (done) => {
test('correct index file', (done) => { const dir = path.join(dataDir, '2019', '05', '05');
const dir = path.join(dataDir, '2019', '05', '05'); const file = path.join(dir, testIndex);
const file = path.join(dir, testIndex); utils.createEmptyDirs([dir]);
utils.createEmptyDirs([dir]); fs.writeFileSync(file, `
fs.writeFileSync(file, `
# Title with : info ! # Title with : info !
![thumbnail](./thumbnail.jpg) ![thumbnail](./thumbnail.jpg)
this is some text this is some text
`); `);
const date = new Date(2019, 5, 5); const date = new Date(2019, 5, 5);
date.setUTCHours(0); date.setUTCHours(0);
fw.fetchArticles((err, dict) => { fw.fetchArticles((err, dict) => {
expect(err).toBeNull(); expect(err).toBeNull();
expect(dict).toBeDefined(); expect(dict).toBeDefined();
expect(Object.keys(dict).length).toBe(1); expect(Object.keys(dict).length).toBe(1);
expect(dict[joinUrl('2019', '05', '05')]).toEqual({ expect(dict[joinUrl('2019', '05', '05')]).toEqual({
path: joinUrl('2019', '05', '05'), path: joinUrl('2019', '05', '05'),
realPath: file, realPath: file,
year: 2019, year: 2019,
month: 5, month: 5,
day: 5, day: 5,
draft: false, draft: false,
date: date, date: date,
title: 'Title with : info !', title: 'Title with : info !',
thumbnail: joinUrl('2019', '05', '05', './thumbnail.jpg'), thumbnail: joinUrl('2019', '05', '05', './thumbnail.jpg'),
escapedTitle: 'title_with___info', escapedTitle: 'title_with___info',
url: '/' + joinUrl('2019', '05', '05', 'title_with___info') + '/', url: '/' + joinUrl('2019', '05', '05', 'title_with___info') + '/',
}); });
done(); done();
});
}); });
}); test('correct draft file', (done) => {
test('correct draft file', (done) => { const dir = path.join(dataDir, '2019', '05', '05');
const dir = path.join(dataDir, '2019', '05', '05'); const file = path.join(dir, 'draft.md');
const file = path.join(dir, 'draft.md'); utils.createEmptyDirs([dir]);
utils.createEmptyDirs([dir]); fs.writeFileSync(file, `
fs.writeFileSync(file, `
# Title with : info ! # Title with : info !
![thumbnail](./thumbnail.jpg) ![thumbnail](./thumbnail.jpg)
this is some text this is some text
`); `);
const date = new Date(2019, 5, 5); const date = new Date(2019, 5, 5);
date.setUTCHours(0); date.setUTCHours(0);
fw.fetchArticles((err, dict) => { fw.fetchArticles((err, dict) => {
expect(err).toBeNull(); expect(err).toBeNull();
expect(dict).toBeDefined(); expect(dict).toBeDefined();
expect(Object.keys(dict).length).toBe(1); expect(Object.keys(dict).length).toBe(1);
expect(dict[joinUrl('2019', '05', '05')]).toEqual({ expect(dict[joinUrl('2019', '05', '05')]).toEqual({
path: joinUrl('2019', '05', '05'), path: joinUrl('2019', '05', '05'),
realPath: file, realPath: file,
year: 2019, year: 2019,
month: 5, month: 5,
day: 5, day: 5,
draft: true, draft: true,
date: date, date: date,
title: 'Title with : info !', title: 'Title with : info !',
thumbnail: joinUrl('2019', '05', '05', './thumbnail.jpg'), thumbnail: joinUrl('2019', '05', '05', './thumbnail.jpg'),
escapedTitle: 'title_with___info', escapedTitle: 'title_with___info',
url: '/' + joinUrl('2019', '05', '05', 'title_with___info') + '/', url: '/' + joinUrl('2019', '05', '05', 'title_with___info') + '/',
}); });
done(); done();
});
}); });
}); test('index file override draft', (done) => {
test('index file override draft', (done) => { const dir = path.join(dataDir, '2019', '05', '05');
const dir = path.join(dataDir, '2019', '05', '05'); const file = path.join(dir, testIndex);
const file = path.join(dir, testIndex); const file2 = path.join(dir, 'draft.md');
const file2 = path.join(dir, 'draft.md'); utils.createEmptyDirs([dir]);
utils.createEmptyDirs([dir]); utils.createEmptyFiles([file, file2]);
utils.createEmptyFiles([file, file2]); const date = new Date(2019, 5, 5);
const date = new Date(2019, 5, 5); date.setUTCHours(0);
date.setUTCHours(0); fw.fetchArticles((err, dict) => {
fw.fetchArticles((err, dict) => { expect(err).toBeNull();
expect(err).toBeNull(); expect(dict).toBeDefined();
expect(dict).toBeDefined(); expect(Object.keys(dict).length).toBe(1);
expect(Object.keys(dict).length).toBe(1); expect(dict[joinUrl('2019', '05', '05')]).toEqual({
expect(dict[joinUrl('2019', '05', '05')]).toEqual({ path: joinUrl('2019', '05', '05'),
path: joinUrl('2019', '05', '05'), realPath: file,
realPath: file, year: 2019,
year: 2019, month: 5,
month: 5, draft: false,
draft: false, day: 5,
day: 5, date: date,
date: date, title: 'Untitled',
title: 'Untitled', thumbnail: 'default.png',
thumbnail: 'default.png', escapedTitle: 'untitled',
escapedTitle: 'untitled', url: '/' + joinUrl('2019', '05', '05', 'untitled') + '/',
url: '/' + joinUrl('2019', '05', '05', 'untitled') + '/', });
}); done();
done(); });
}); });
});
}); });
test/renderer.test.js
+203 -204
View File
@@ -1,4 +1,3 @@
/* jshint -W117 */
const fs = require('fs'); const fs = require('fs');
const path = require('path'); const path = require('path');
const utils = require('./test_utils'); const utils = require('./test_utils');
@@ -7,283 +6,283 @@ const dataDir = 'test_data';
const file = path.join(dataDir, 'test.md'); const file = path.join(dataDir, 'test.md');
const config = { const config = {
'test': true, 'test': true,
'modules': { 'modules': {
'prism': true, 'prism': true,
'mathjax': true, 'mathjax': true,
'plantuml': true, 'plantuml': true,
'fa-diagrams': true, 'fa-diagrams': true,
}, },
'showdown': { 'showdown': {
'simplifiedAutoLink': true, 'simplifiedAutoLink': true,
'smartIndentationFix': true 'smartIndentationFix': true
}, },
'mathjax': { 'mathjax': {
'output_format': 'html', 'output_format': 'html',
'speak_text': false 'speak_text': false
}, },
'plantuml': { 'plantuml': {
'output_format': 'svg' 'output_format': 'svg'
} }
}; };
const renderer = require('../src/renderer')(config); const renderer = require('../src/renderer')(config);
beforeEach(() => { beforeEach(() => {
config['modules']['prism'] = true; config['modules']['prism'] = true;
config['modules']['mathjax'] = true; config['modules']['mathjax'] = true;
config['modules']['plantuml'] = true; config['modules']['plantuml'] = true;
config['modules']['fa-diagrams'] = true; config['modules']['fa-diagrams'] = true;
utils.deleteFolderSync(dataDir); utils.deleteFolderSync(dataDir);
fs.mkdirSync(dataDir); fs.mkdirSync(dataDir);
}); });
afterAll(() => { afterAll(() => {
if (fs.existsSync(dataDir)) { if (fs.existsSync(dataDir)) {
utils.deleteFolderSync(dataDir); utils.deleteFolderSync(dataDir);
} }
}); });
describe('get parts', () => { describe('get parts', () => {
test('normal', () => { test('normal', () => {
const data = 'Hello\nthere\ngeneral\nkenobi'; const data = 'Hello\nthere\ngeneral\nkenobi';
const parts = renderer.getParts(data); const parts = renderer.getParts(data);
expect(parts.map(p => p.text)).toEqual([ expect(parts.map(p => p.text)).toEqual([
'Hello\nthere\ngeneral\nkenobi' 'Hello\nthere\ngeneral\nkenobi'
]); ]);
}); });
test('lot of stuff', () => { test('lot of stuff', () => {
const data = 'Hello\nthere\n```code```\ngeneral<script>script</script>\n<script>script2</script>\n```<script>script3</script>```kenobi'; const data = 'Hello\nthere\n```code```\ngeneral<script>script</script>\n<script>script2</script>\n```<script>script3</script>```kenobi';
const parts = renderer.getParts(data); const parts = renderer.getParts(data);
expect(parts).toEqual([ expect(parts).toEqual([
{ {
index: 0, index: 0,
end: 12, end: 12,
text: 'Hello\nthere\n' text: 'Hello\nthere\n'
}, },
{ {
index: 22, index: 22,
end: 30, end: 30,
text: '\ngeneral' text: '\ngeneral'
}, },
{ {
index: 53, index: 53,
end: 54, end: 54,
text: '\n' text: '\n'
}, },
{ {
index: 78, index: 78,
end: 79, end: 79,
text: '\n' text: '\n'
}, },
{ {
index: 109, index: 109,
end: 115, end: 115,
text: 'kenobi' text: 'kenobi'
}, },
]); ]);
}); });
}); });
describe('Test Showdown', () => { describe('Test Showdown', () => {
test('normal', (done) => { test('normal', (done) => {
renderer.renderShowDown('# Hello', (html) => { renderer.renderShowDown('# Hello', (html) => {
expect(html).toBe('<h1 id="hello">Hello</h1>'); expect(html).toBe('<h1 id="hello">Hello</h1>');
done(); done();
});
}); });
}); test('custom rules', (done) => {
test('custom rules', (done) => { renderer.renderShowDown('www.google.com', (html) => {
renderer.renderShowDown('www.google.com', (html) => { expect(html).toBe('<p><a href="http://www.google.com">www.google.com</a></p>');
expect(html).toBe('<p><a href="http://www.google.com">www.google.com</a></p>'); done();
done(); });
}); });
}); test('code format', (done) => {
test('code format', (done) => { renderer.renderShowDown('```python\nprint("hello")\n```\n\n```python\nprint("hello")\n```', (html) => {
renderer.renderShowDown('```python\nprint("hello")\n```\n\n```python\nprint("hello")\n```', (html) => { expect(html).toBe('<pre><code class="python language-python">print("hello")\n</code></pre>\n<pre><code class="python language-python">print("hello")\n</code></pre>');
expect(html).toBe('<pre><code class="python language-python">print("hello")\n</code></pre>\n<pre><code class="python language-python">print("hello")\n</code></pre>'); done();
done(); });
}); });
});
}); });
describe('Test Prism', () => { describe('Test Prism', () => {
test('no prism', (done) => { test('no prism', (done) => {
config['modules']['prism'] = false; config['modules']['prism'] = false;
renderer.renderPrism('```python\nprint("hello")\n```\n\n```python\nprint("hello")\n```', (data) => { renderer.renderPrism('```python\nprint("hello")\n```\n\n```python\nprint("hello")\n```', (data) => {
expect(data).toBe('```python\nprint("hello")\n```\n\n```python\nprint("hello")\n```'); expect(data).toBe('```python\nprint("hello")\n```\n\n```python\nprint("hello")\n```');
done(); done();
});
}); });
});
test('prism correct', (done) => { test('prism correct', (done) => {
renderer.renderPrism('```python\nprint("hello")\n```', (data) => { renderer.renderPrism('```python\nprint("hello")\n```', (data) => {
expect(data).not.toBe('<pre><code class="python language-python">print("hello")\n</code></pre>'); expect(data).not.toBe('<pre><code class="python language-python">print("hello")\n</code></pre>');
expect(data.indexOf('<pre><code class="python language-python">')).toBe(0); expect(data.indexOf('<pre><code class="python language-python">')).toBe(0);
done(); done();
});
}); });
});
test('prism invalid lang', (done) => { test('prism invalid lang', (done) => {
renderer.renderPrism('```pythdon\nprint("hello")\n```', (data) => { renderer.renderPrism('```pythdon\nprint("hello")\n```', (data) => {
expect(data).not.toBe('<pre><code class="pythdon language-pythdon">print("hello")\n</code></pre>'); expect(data).not.toBe('<pre><code class="pythdon language-pythdon">print("hello")\n</code></pre>');
expect(data.indexOf('<pre><code class="pythdon language-pythdon">')).toBe(0); expect(data.indexOf('<pre><code class="pythdon language-pythdon">')).toBe(0);
done(); done();
});
}); });
});
test('prism mutliple code blocks', (done) => { test('prism mutliple code blocks', (done) => {
renderer.renderPrism('```python\n\n```\n```python\n\n```', (data) => { renderer.renderPrism('```python\n\n```\n```python\n\n```', (data) => {
expect(data).toBe('<pre><code class="python language-python"></code></pre>\n<pre><code class="python language-python"></code></pre>'); expect(data).toBe('<pre><code class="python language-python"></code></pre>\n<pre><code class="python language-python"></code></pre>');
done(); done();
});
}); });
});
}); });
describe('Test PlantUML', () => { describe('Test PlantUML', () => {
test('no plantuml', (done) => { test('no plantuml', (done) => {
config['modules']['plantuml'] = false; config['modules']['plantuml'] = false;
renderer.renderPlantUML('@startuml\nBob -> Alice : hello\n@enduml', (data) => { renderer.renderPlantUML('@startuml\nBob -> Alice : hello\n@enduml', (data) => {
expect(data).toBe('@startuml\nBob -> Alice : hello\n@enduml'); expect(data).toBe('@startuml\nBob -> Alice : hello\n@enduml');
done(); done();
});
}); });
});
test('plantuml correct', (done) => { test('plantuml correct', (done) => {
renderer.renderPlantUML('@startuml\nBob -> Alice : hello\n@enduml', (data) => { renderer.renderPlantUML('@startuml\nBob -> Alice : hello\n@enduml', (data) => {
expect(data).toBe('<img alt="generated PlantUML diagram" src="http://www.plantuml.com/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000">'); expect(data).toBe('<img alt="generated PlantUML diagram" src="http://www.plantuml.com/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000">');
done(); done();
});
}); });
});
test('plantuml ignored in code', (done) => { test('plantuml ignored in code', (done) => {
renderer.renderPlantUML('code:\n```@startuml\nBob -> Alice : hello\n@enduml```\n ```@startuml``` @enduml', (data) => { renderer.renderPlantUML('code:\n```@startuml\nBob -> Alice : hello\n@enduml```\n ```@startuml``` @enduml', (data) => {
expect(data).toBe('code:\n```@startuml\nBob -> Alice : hello\n@enduml```\n ```@startuml``` @enduml'); expect(data).toBe('code:\n```@startuml\nBob -> Alice : hello\n@enduml```\n ```@startuml``` @enduml');
done(); done();
});
}); });
});
test('plantuml multiple uml', (done) => { test('plantuml multiple uml', (done) => {
renderer.renderPlantUML('@startuml\nBob -> Alice : hello\n@enduml\n@startuml\nBob -> Alice : hello\n@enduml', (data) => { renderer.renderPlantUML('@startuml\nBob -> Alice : hello\n@enduml\n@startuml\nBob -> Alice : hello\n@enduml', (data) => {
expect(data).toBe('<img alt="generated PlantUML diagram" src="http://www.plantuml.com/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000">\n<img alt="generated PlantUML diagram" src="http://www.plantuml.com/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000">'); expect(data).toBe('<img alt="generated PlantUML diagram" src="http://www.plantuml.com/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000">\n<img alt="generated PlantUML diagram" src="http://www.plantuml.com/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000">');
done(); done();
});
}); });
});
}); });
describe('Test MathJax', () => { describe('Test MathJax', () => {
test('no mathjax', (done) => { test('no mathjax', (done) => {
config['modules']['mathjax'] = false; config['modules']['mathjax'] = false;
renderer.renderMathJax('$$\nhello\n$$\ntest$test$', (data) => { renderer.renderMathJax('$$\nhello\n$$\ntest$test$', (data) => {
expect(data).toBe('$$\nhello\n$$\ntest$test$'); expect(data).toBe('$$\nhello\n$$\ntest$test$');
done(); done();
});
}); });
}); test('full eq', (done) => {
test('full eq', (done) => { renderer.renderMathJax('$$\n\nA\n\n$$', (data) => {
renderer.renderMathJax('$$\n\nA\n\n$$', (data) => { expect(data).toBe('<span class="mjx-chtml MJXc-display" style="text-align: center;">' +
expect(data).toBe('<span class=\"mjx-chtml MJXc-display\" style=\"text-align: center;\">' + '<span class="mjx-math"><span class="mjx-mrow"><span class="mjx-mi">' +
'<span class=\"mjx-math\"><span class=\"mjx-mrow\"><span class=\"mjx-mi\">' + '<span class="mjx-char MJXc-TeX-math-I" style="padding-top: 0.519em; padding-bottom: 0.298em;">' +
'<span class=\"mjx-char MJXc-TeX-math-I\" style=\"padding-top: 0.519em; padding-bottom: 0.298em;\">' +
'A' + 'A' +
'</span></span></span></span></span>'); '</span></span></span></span></span>');
done(); done();
});
}); });
}); test('inline eq', (done) => {
test('inline eq', (done) => { renderer.renderMathJax('start $a$ end', (data) => {
renderer.renderMathJax('start $a$ end', (data) => { expect(data).toBe('start ' +
expect(data).toBe('start ' + '<span class="mjx-chtml">' +
'<span class=\"mjx-chtml\">' + '<span class="mjx-math"><span class="mjx-mrow"><span class="mjx-mi">' +
'<span class=\"mjx-math\"><span class=\"mjx-mrow\"><span class=\"mjx-mi\">' + '<span class="mjx-char MJXc-TeX-math-I" style="padding-top: 0.225em; padding-bottom: 0.298em;">' +
'<span class=\"mjx-char MJXc-TeX-math-I\" style=\"padding-top: 0.225em; padding-bottom: 0.298em;\">' +
'a' + 'a' +
'</span></span></span></span></span>' + '</span></span></span></span></span>' +
' end'); ' end');
done(); done();
});
}); });
}); test('fake inline eq', (done) => {
test('fake inline eq', (done) => { renderer.renderMathJax('i have $6\nyou have $5', (data) => {
renderer.renderMathJax('i have $6\nyou have $5', (data) => { expect(data).toBe('i have $6\nyou have $5');
expect(data).toBe('i have $6\nyou have $5'); done();
done(); });
}); });
}); test('no eq in code / script', (done) => {
test('no eq in code / script', (done) => { renderer.renderMathJax('this code is ```start $a$ end $$hello$$``` beautiful <script>$A$</script>\n```$no eq$```', (data) => {
renderer.renderMathJax('this code is ```start $a$ end $$hello$$``` beautiful <script>$A$</script>\n```$no eq$```', (data) => { expect(data).toBe('this code is ```start $a$ end $$hello$$``` beautiful <script>$A$</script>\n```$no eq$```');
expect(data).toBe('this code is ```start $a$ end $$hello$$``` beautiful <script>$A$</script>\n```$no eq$```'); done();
done(); });
}); });
}); test('multiple eq', (done) => {
test('multiple eq', (done) => { renderer.renderMathJax('$$\n\nA\n\n$$\nstart $a$ end\n$$\n\nA\n\n$$', (data) => {
renderer.renderMathJax('$$\n\nA\n\n$$\nstart $a$ end\n$$\n\nA\n\n$$', (data) => { expect(data).toBe('' +
expect(data).toBe('' + '<span class="mjx-chtml MJXc-display" style="text-align: center;">' +
'<span class=\"mjx-chtml MJXc-display\" style=\"text-align: center;\">' + '<span class="mjx-math"><span class="mjx-mrow"><span class="mjx-mi">' +
'<span class=\"mjx-math\"><span class=\"mjx-mrow\"><span class=\"mjx-mi\">' + '<span class="mjx-char MJXc-TeX-math-I" style="padding-top: 0.519em; padding-bottom: 0.298em;">' +
'<span class=\"mjx-char MJXc-TeX-math-I\" style=\"padding-top: 0.519em; padding-bottom: 0.298em;\">' +
'A' + 'A' +
'</span></span></span></span></span>\n' + '</span></span></span></span></span>\n' +
'start ' + 'start ' +
'<span class=\"mjx-chtml\">' + '<span class="mjx-chtml">' +
'<span class=\"mjx-math\"><span class=\"mjx-mrow\"><span class=\"mjx-mi\">' + '<span class="mjx-math"><span class="mjx-mrow"><span class="mjx-mi">' +
'<span class=\"mjx-char MJXc-TeX-math-I\" style=\"padding-top: 0.225em; padding-bottom: 0.298em;\">' + '<span class="mjx-char MJXc-TeX-math-I" style="padding-top: 0.225em; padding-bottom: 0.298em;">' +
'a' + 'a' +
'</span></span></span></span></span>' + '</span></span></span></span></span>' +
' end\n' + ' end\n' +
'<span class=\"mjx-chtml MJXc-display\" style=\"text-align: center;\">' + '<span class="mjx-chtml MJXc-display" style="text-align: center;">' +
'<span class=\"mjx-math\"><span class=\"mjx-mrow\"><span class=\"mjx-mi\">' + '<span class="mjx-math"><span class="mjx-mrow"><span class="mjx-mi">' +
'<span class=\"mjx-char MJXc-TeX-math-I\" style=\"padding-top: 0.519em; padding-bottom: 0.298em;\">' + '<span class="mjx-char MJXc-TeX-math-I" style="padding-top: 0.519em; padding-bottom: 0.298em;">' +
'A' + 'A' +
'</span></span></span></span></span>'); '</span></span></span></span></span>');
done(); done();
});
}); });
});
}); });
describe('Test fa-diagrams', () => { describe('Test fa-diagrams', () => {
test('no fa-diagrams', (done) => { test('no fa-diagrams', (done) => {
config['modules']['fa-diagrams'] = false; config['modules']['fa-diagrams'] = false;
renderer.renderFaDiagrams('@startfad\noptions.rendering.color=\'red\'\n@endfad', (data) => { renderer.renderFaDiagrams('@startfad\noptions.rendering.color=\'red\'\n@endfad', (data) => {
expect(data).toBe('@startfad\noptions.rendering.color=\'red\'\n@endfad'); expect(data).toBe('@startfad\noptions.rendering.color=\'red\'\n@endfad');
done(); done();
});
}); });
}); test('no fa-diagrams in code', (done) => {
test('no fa-diagrams in code', (done) => { renderer.renderFaDiagrams('code:\n```\n@startfad\noptions.rendering.color=\'red\'\n@endfad\n```', (data) => {
renderer.renderFaDiagrams('code:\n```\n@startfad\noptions.rendering.color=\'red\'\n@endfad\n```', (data) => { expect(data).toBe('code:\n```\n@startfad\noptions.rendering.color=\'red\'\n@endfad\n```');
expect(data).toBe('code:\n```\n@startfad\noptions.rendering.color=\'red\'\n@endfad\n```'); done();
done(); });
}); });
}); test('valid fa-diagrams', (done) => {
test('valid fa-diagrams', (done) => { renderer.renderFaDiagrams('before\n@startfad\noptions.rendering.color=\'red\'\n@endfad\nafter', (data) => {
renderer.renderFaDiagrams('before\n@startfad\noptions.rendering.color=\'red\'\n@endfad\nafter', (data) => { expect(data).toBe('before\n<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 0 0" width="0" height="0" font-family="Arial" font-size="15" fill="red" stroke-width="0"></svg>\nafter');
expect(data).toBe('before\n<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 0 0" width="0" height="0" font-family="Arial" font-size="15" fill="red" stroke-width="0"></svg>\nafter'); done();
done(); });
}); });
}); test('invalid toml', (done) => {
test('invalid toml', (done) => { renderer.renderFaDiagrams('before\n@startfad\noptions.rendering.color=red\n@endfad\nafter', (data) => {
renderer.renderFaDiagrams('before\n@startfad\noptions.rendering.color=red\n@endfad\nafter', (data) => { expect(data).toBe('before\n<b style="color:red">TomlError: Unexpected character, expecting string, number, datetime, boolean, inline array or inline table at row 1, col 26, pos 25:\n' +
expect(data).toBe('before\n<b style="color:red">TomlError: Unexpected character, expecting string, number, datetime, boolean, inline array or inline table at row 1, col 26, pos 25:\n' +
'1> options.rendering.color=red\n' + '1> options.rendering.color=red\n' +
' ^\n' + ' ^\n' +
'\n</b>\nafter'); '\n</b>\nafter');
done(); done();
});
}); });
});
}); });
describe('Test render', () => { describe('Test render', () => {
test('invalid file', (done) => { test('invalid file', (done) => {
renderer.render('invalid file', (err, html) => { renderer.render('invalid file', (err, html) => {
expect(err).not.toBeNull(); expect(err).not.toBeNull();
expect(html).not.toBeDefined(); expect(html).not.toBeDefined();
done(); done();
});
}); });
});
test('normal file', (done) => { test('normal file', (done) => {
fs.writeFileSync(file, `# Hello`); fs.writeFileSync(file, '# Hello');
renderer.render(file, (err, html) => { renderer.render(file, (err, html) => {
expect(err).toBeNull(); expect(err).toBeNull();
expect(html).toBe('<h1 id="hello">Hello</h1>'); expect(html).toBe('<h1 id="hello">Hello</h1>');
done(); done();
});
}); });
});
}); });
test/script_loader.test.js
+20 -21
View File
@@ -1,4 +1,3 @@
/* jshint -W117 */
const fs = require('fs'); const fs = require('fs');
const path = require('path'); const path = require('path');
const utils = require('./test_utils'); const utils = require('./test_utils');
@@ -6,46 +5,46 @@ const utils = require('./test_utils');
const dataDir = 'test_data'; const dataDir = 'test_data';
beforeEach(() => { beforeEach(() => {
utils.deleteFolderSync(dataDir); utils.deleteFolderSync(dataDir);
fs.mkdirSync(dataDir); fs.mkdirSync(dataDir);
}); });
afterAll(() => { afterAll(() => {
if (fs.existsSync(dataDir)) { if (fs.existsSync(dataDir)) {
utils.deleteFolderSync(dataDir); utils.deleteFolderSync(dataDir);
} }
}); });
test('load 1 script', () => { test('load 1 script', () => {
const file = path.join(dataDir, 'test.js'); const file = path.join(dataDir, 'test.js');
fs.writeFileSync(file, ` fs.writeFileSync(file, `
var a = 5; var a = 5;
function b(){ function b(){
return a; return a;
}`); }`);
require('../src/script_loader')(file); require('../src/script_loader')(file);
expect(global['b']).toBeDefined(); expect(global['b']).toBeDefined();
expect(global['b']()).toBe(5); expect(global['b']()).toBe(5);
}); });
test('load 2 script', () => { test('load 2 script', () => {
const file1 = path.join(dataDir, 'test.js'); const file1 = path.join(dataDir, 'test.js');
fs.writeFileSync(file1, ` fs.writeFileSync(file1, `
var a = 5; var a = 5;
function b(){ function b(){
return a; return a;
}`); }`);
const file2 = path.join(dataDir, 'test2.js'); const file2 = path.join(dataDir, 'test2.js');
fs.writeFileSync(file2, ` fs.writeFileSync(file2, `
var a = 9; var a = 9;
function b(){ function b(){
return a; return a;
}`); }`);
require('../src/script_loader')(file1); require('../src/script_loader')(file1);
expect(global['b']).toBeDefined(); expect(global['b']).toBeDefined();
expect(global['b']()).toBe(5); expect(global['b']()).toBe(5);
require('../src/script_loader.js')(file2); require('../src/script_loader.js')(file2);
expect(global['b']).toBeDefined(); expect(global['b']).toBeDefined();
expect(global['b']()).toBe(9); expect(global['b']()).toBe(9);
}); });
test/test_utils.js
+22 -20
View File
@@ -2,28 +2,30 @@ const fs = require('fs');
const path = require('path'); const path = require('path');
const deleteFolderSync = (dir) => { const deleteFolderSync = (dir) => {
if (!fs.existsSync(dir)) if (!fs.existsSync(dir)) {
return; return;
let items;
const deleteItem = (item) => {
if (item.isDirectory())
deleteFolderSync(path.join(dir, item.name));
else
fs.unlinkSync(path.join(dir, item.name));
};
do {
items = fs.readdirSync(dir, {withFileTypes: true});
try {
items.forEach(deleteItem);
} catch (e) {
console.error(e);
} }
} while (items.length > 0); let items;
fs.rmdirSync(dir); const deleteItem = (item) => {
if (item.isDirectory()) {
deleteFolderSync(path.join(dir, item.name));
} else {
fs.unlinkSync(path.join(dir, item.name));
}
};
do {
items = fs.readdirSync(dir, {withFileTypes: true});
try {
items.forEach(deleteItem);
} catch (e) {
console.error(e);
}
} while (items.length > 0);
fs.rmdirSync(dir);
}; };
module.exports = { module.exports = {
deleteFolderSync: deleteFolderSync, deleteFolderSync: deleteFolderSync,
createEmptyDirs: (list) => list.forEach((path) => fs.mkdirSync(path, {recursive: true})), createEmptyDirs: (list) => list.forEach((path) => fs.mkdirSync(path, {recursive: true})),
createEmptyFiles: (list) => list.forEach((file) => fs.writeFileSync(file, '')), createEmptyFiles: (list) => list.forEach((file) => fs.writeFileSync(file, '')),
}; };