From fe6cca6453ecf2318c2f0caad2cc04d6ca3d4c9d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20GOUIN?= Date: Thu, 20 Jun 2019 10:07:22 +0200 Subject: [PATCH] app default endpoints --- package-lock.json | 5 ++ package.json | 1 + src/app.js | 52 ++++++++++++++++++-- src/config.default.json | 26 +++++----- test/app.test.js | 100 ++++++++++++++++++++++++++++++++++++--- test/file_walker.test.js | 38 +++++---------- test/test_utils.js | 19 ++++++++ 7 files changed, 193 insertions(+), 48 deletions(-) create mode 100644 test/test_utils.js diff --git a/package-lock.json b/package-lock.json index 27426e9..7967736 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2869,6 +2869,11 @@ "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", "integrity": "sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0=" }, + "ejs": { + "version": "2.6.2", + "resolved": "https://registry.npmjs.org/ejs/-/ejs-2.6.2.tgz", + "integrity": "sha512-PcW2a0tyTuPHz3tWyYqtK6r1fZ3gp+3Sop8Ph+ZYN81Ob5rwmbHEzaqs10N3BEsaGTkh/ooniXK+WwszGlc2+Q==" + }, "electron-to-chromium": { "version": "1.3.165", "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.165.tgz", diff --git a/package.json b/package.json index 4f8859b..7ca4d39 100644 --- a/package.json +++ b/package.json @@ -5,6 +5,7 @@ "description": "A static blog using Markdown pulled from your git repository.", "main": "src/server.js", "dependencies": { + "ejs": "^2.6.2", "express": "^4.17.1", "ncp": "^2.0.0", "showdown": "^1.9.0", diff --git a/src/app.js b/src/app.js index 3ff4815..06308eb 100644 --- a/src/app.js +++ b/src/app.js @@ -1,5 +1,7 @@ const express = require('express'); const app = express(); +const fs = require('fs'); +const path = require('path'); const cons = { ok: '\x1b[32m✔\x1b[0m %s', @@ -10,8 +12,17 @@ const cons = { module.exports = (config) => { const fw = require('./file_walker')(config); + app.set('view engine', config['view_engine']); + app.set('views', path.join(__dirname, '..')); + const articles = []; + const log = (status, msg) => { + if (config['test']) + return; + console.log(status, msg); + }; + const reload = (callback) => { fw.fetchArticles((err, list) => { if (err) { @@ -20,22 +31,55 @@ module.exports = (config) => { } articles.splice(0, articles.length, ...list); if (articles.length > 0) - console.log(cons.ok, `loaded ${articles.length} article${articles.length > 1 ? 's' : ''}`); + log(cons.ok, `loaded ${articles.length} article${articles.length > 1 ? 's' : ''}`); else - console.log(cons.warn, `no articles loaded, check your configuration`); + log(cons.warn, `no articles loaded, check your configuration`); callback(true); }); }; + const render = (res, path, data, code = 200) => { + res.render(path, data, (err, html) => { + if (err) { + res.sendStatus(500); + log(cons.error, `failed to render ${path} : ${err}`); + } else + res.status(code).send(html); + }); + }; + + const showError = (path, code, res) => { + const errorPath = `${config['data_dir']}/${config['home']['error']}`; + if (fs.existsSync(errorPath)) + render(res, errorPath, {error: code, path: path}, code); + else + res.sendStatus(code); + }; + app.get('/', (req, res) => { - res.status(200).send('Hello World!'); + const homePath = `${config['data_dir']}/${config['home']['index']}`; + if (fs.existsSync(homePath)) + render(res, homePath, {articles: articles}); + else { + showError(req.path, 404, res); + } + }); + + app.get('*', express.static(config['data_dir'])); + + app.get('*', (req, res) => { + showError(req.path, 404, res); + }); + + app.all('*', (req, res) => { + res.status(400).send('bad request'); }); app.start = () => { reload((res) => { if (res) app.listen(config['node_port'], () => { - console.log(cons.ok, `gitblog.md server listening on port ${config['node_port']}`); + log(cons.ok, `gitblog.md server listening on port ${config['node_port']}`); }); }); }; diff --git a/src/config.default.json b/src/config.default.json index 2ee6f02..7427b2c 100644 --- a/src/config.default.json +++ b/src/config.default.json @@ -1,25 +1,27 @@ { "node_port": 3000, "data_dir": "data", - "modules" : { - "plantuml" : false, + "view_engine": "ejs", + "modules": { + "plantuml": false, "rss": true, "webhook": true }, - "home" : { - "index" : "index.ejs" + "home": { + "index": "index.ejs", + "error": "error.ejs" }, - "article" : { - "index" : "index.md", - "thumbnail_tag" : "thumbnail", + "article": { + "index": "index.md", + "thumbnail_tag": "thumbnail", "default_title": "Untitled", - "default_thumbnail" : null + "default_thumbnail": null }, - "rss" : { - "endpoint" : "/rss", - "length" : 10 + "rss": { + "endpoint": "/rss", + "length": 10 }, - "webhook" : { + "webhook": { "endpoint": "/webhook", "secretFile": "git_secret" } diff --git a/test/app.test.js b/test/app.test.js index 8e33e19..03cf8a3 100644 --- a/test/app.test.js +++ b/test/app.test.js @@ -1,15 +1,103 @@ /* jshint -W117 */ const request = require('supertest'); -const app = require('../src/app')({ +const fs = require('fs'); +const utils = require('./test_utils'); +const dataDir = './test_data'; +const testIndex = 'testindex.ejs'; +const testError = 'testerror.ejs'; + +const config = { + 'test': true, + 'data_dir': dataDir, + 'view_engine': 'ejs', + 'home': { + 'index': testIndex, + 'error': testError + } +}; + +const app = require('../src/app')(config); + +beforeEach(() => { + utils.deleteFolderSync(dataDir); + fs.mkdirSync(dataDir); +}); + +afterAll(() => { + if (fs.existsSync(dataDir)) { + utils.deleteFolderSync(dataDir); + } }); describe('Test root path', () => { - test('GET / 200', done => { - request(app).get('/').then(response => { - expect(response.statusCode).toBe(200); - done(); - }); + test('404 no index no error', done => { + request(app).get('/').then(response => { + expect(response.statusCode).toBe(404); + done(); + }); + }); + test('404 no index but error page', done => { + fs.writeFileSync(`${dataDir}/${testError}`, 'error <%= error %> at <%= path %>'); + request(app).get('/').then(response => { + expect(response.statusCode).toBe(404); + expect(response.text).toBe('error 404 at /'); + done(); + }); + }); + test('200 index page', done => { + fs.writeFileSync(`${dataDir}/${testIndex}`, 'hello there'); + request(app).get('/').then(response => { + expect(response.statusCode).toBe(200); + expect(response.text).toBe('hello there'); + done(); + }); + }); + //TODO test articles list +}); + +describe('Test static files', () => { + test('404 invalid file no error page', done => { + request(app).get('/somefile.txt').then(response => { + expect(response.statusCode).toBe(404); + done(); + }); + }); + test('404 invalid file but error page', done => { + fs.writeFileSync(`${dataDir}/${testError}`, 'error <%= error %> at <%= path %>'); + request(app).get('/somefile.txt').then(response => { + expect(response.statusCode).toBe(404); + expect(response.text).toBe('error 404 at /somefile.txt'); + done(); + }); + }); + test('200 valid file', done => { + fs.writeFileSync(`${dataDir}/somefile.txt`, 'filecontent'); + request(app).get('/somefile.txt').then(response => { + expect(response.statusCode).toBe(200); + expect(response.text).toBe('filecontent'); + done(); + }); }); }); +describe('Test other requests', () => { + test('400 POST', done => { + request(app).post('/').then(response => { + expect(response.statusCode).toBe(400); + done(); + }); + }); + test('400 PUT', done => { + request(app).put('/').then(response => { + expect(response.statusCode).toBe(400); + done(); + }); + }); + test('400 DELETE', done => { + request(app).delete('/').then(response => { + expect(response.statusCode).toBe(400); + done(); + }); + }); +}); diff --git a/test/file_walker.test.js b/test/file_walker.test.js index e1a1c1a..4500d87 100644 --- a/test/file_walker.test.js +++ b/test/file_walker.test.js @@ -1,5 +1,6 @@ /* jshint -W117 */ const fs = require('fs'); +const utils = require('./test_utils'); const dataDir = './test_data'; const testIndex = 'testindex.md'; @@ -17,32 +18,17 @@ const config = { const fw = require('../src/file_walker')(config); -const deleteFolderSync = (path) => { - if (!fs.existsSync(path)) - return; - fs.readdirSync(path, {withFileTypes: true}).forEach((item) => { - if (item.isDirectory()) - deleteFolderSync(`${path}/${item.name}`); - else - fs.unlinkSync(`${path}/${item.name}`); - }); - fs.rmdirSync(path); -}; - beforeEach(() => { - deleteFolderSync(dataDir); + utils.deleteFolderSync(dataDir); fs.mkdirSync(dataDir); }); afterAll(() => { if (fs.existsSync(dataDir)) { - deleteFolderSync(dataDir); + utils.deleteFolderSync(dataDir); } }); -const createEmptyDirs = list => list.forEach(path => fs.mkdirSync(path, {recursive: true})); -const createEmptyFiles = list => list.forEach(file => fs.writeFileSync(file, '')); - describe('Test function fileTree', () => { test('empty root', (done) => { fw.fileTree(dataDir, (err, list) => { @@ -53,7 +39,7 @@ describe('Test function fileTree', () => { }); }); test('empty folders', (done) => { - createEmptyDirs([ + utils.createEmptyDirs([ `${dataDir}/test/test`, `${dataDir}/test/test2`, `${dataDir}/test2` @@ -70,7 +56,7 @@ describe('Test function fileTree', () => { `${dataDir}/f1.txt`, `${dataDir}/f2.txt` ]; - createEmptyFiles(fileList); + utils.createEmptyFiles(fileList); fw.fileTree(dataDir, (err, list) => { expect(err).toBeNull(); expect(list).toBeDefined(); @@ -80,7 +66,7 @@ describe('Test function fileTree', () => { }); }); test('nested files', (done) => { - createEmptyDirs([ + utils.createEmptyDirs([ `${dataDir}/test/test`, `${dataDir}/test2` ]); @@ -90,7 +76,7 @@ describe('Test function fileTree', () => { `${dataDir}/test/test/f3.txt`, `${dataDir}/test2/f4.txt` ]; - createEmptyFiles(fileList); + utils.createEmptyFiles(fileList); fw.fileTree(dataDir, (err, list) => { expect(err).toBeNull(); expect(list).toBeDefined(); @@ -212,11 +198,11 @@ describe('Test article fetching', () => { }); }); test('misplaced index file', (done) => { - createEmptyDirs([ + utils.createEmptyDirs([ `${dataDir}/test/test`, `${dataDir}/2019/05/05`, ]); - createEmptyFiles([ + utils.createEmptyFiles([ `${dataDir}/${testIndex}`, `${dataDir}/test/test/${testIndex}`, `${dataDir}/2019/05/${testIndex}`, @@ -229,11 +215,11 @@ describe('Test article fetching', () => { }); }); test('empty index file', (done) => { - createEmptyDirs([ + utils.createEmptyDirs([ `${dataDir}/2019/05/05`, ]); const file = `${dataDir}/2019/05/05/${testIndex}`; - createEmptyFiles([file]); + utils.createEmptyFiles([file]); fw.fetchArticles((err, list) => { expect(err).toBeNull(); expect(list).toBeDefined(); @@ -250,7 +236,7 @@ describe('Test article fetching', () => { }); }); test('correct index file', (done) => { - createEmptyDirs([ + utils.createEmptyDirs([ `${dataDir}/2019/05/05`, ]); const file = `${dataDir}/2019/05/05/${testIndex}`; diff --git a/test/test_utils.js b/test/test_utils.js new file mode 100644 index 0000000..e03ef7a --- /dev/null +++ b/test/test_utils.js @@ -0,0 +1,19 @@ +const fs = require('fs'); + +const deleteFolderSync = (path) => { + if (!fs.existsSync(path)) + return; + fs.readdirSync(path, {withFileTypes: true}).forEach((item) => { + if (item.isDirectory()) + deleteFolderSync(`${path}/${item.name}`); + else + fs.unlinkSync(`${path}/${item.name}`); + }); + fs.rmdirSync(path); +}; + +module.exports = { + deleteFolderSync: deleteFolderSync, + createEmptyDirs: list => list.forEach(path => fs.mkdirSync(path, {recursive: true})), + createEmptyFiles: list => list.forEach(file => fs.writeFileSync(file, '')), +}; \ No newline at end of file