Somehing went wrong + (Error <%= error %>) +
+ It means the resource you're trying to access is unavailable right now.+ We're terribly sorry that you encountered this error.
+ Back to home + <%- include('footer'); %> +
-
+
- Definition list +
- Is something people use sometimes. + +
- Markdown in HTML +
- Does *not* work **very** well. Use HTML tags. +
+ We're terribly sorry that you encountered this error.
+ Back to home + <%- include('footer'); %> +
+ \ No newline at end of file diff --git a/sample_data/home/index.ejs b/sample_data/home/index.ejs new file mode 100644 index 0000000..4c48df3 --- /dev/null +++ b/sample_data/home/index.ejs @@ -0,0 +1,25 @@ + + + + +
GitBlog.md
+ A static blog using Markdown pulled from your git repository +Articles in this blog :
+ <% articles.forEach((article) => { %> +
+ 
` %>
+ <% } %>
+
+ <% }); %>
+ <%- include('footer'); %>
+<%- `${article.title}` %>
+ Published on <%= article.year + '-' + article.month + '-' + article.day %> + <% if(article.thumbnail){ %> + <%- `
+ ↑
+
+ <%= article.title %>
+ Published on <%= article.year + '-' + article.month + '-' + article.day %> +<%- article.content %>
+ + Go to top - Back to home + <%- include('footer'); %> +
` + block + 'Hello
reload'); + done(); + }); + }, fail); + }); + + test('200 other url', (done, fail) => { + utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]); + utils.createEmptyFiles([ + path.join(dataDir, '2019', '05', '05', 'index.md'), + path.join(dataDir, testTemplate) + ]); + app.reload(() => { + request(app).get('/2019/05/05/anything/').then((response) => { + expect(response.statusCode).toBe(200); + done(); + }); + }, fail); + }); + + test('200 other url 2', (done, fail) => { + utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]); + utils.createEmptyFiles([ + path.join(dataDir, '2019', '05', '05', 'index.md'), + path.join(dataDir, testTemplate) + ]); + app.reload(() => { + request(app).get('/2019/05/05/').then((response) => { + expect(response.statusCode).toBe(200); + done(); + }); + }, fail); + }); +}); + + +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(path.join(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('404 hidden file', (done) => { + fs.writeFileSync(path.join(dataDir, 'somefile.test'), ''); + request(app).get('/somefile.test').then((response) => { + expect(response.statusCode).toBe(404); + done(); + }); + }); + test('200 valid file', (done) => { + fs.writeFileSync(path.join(dataDir, 'somefile.txt'), 'filecontent'); + request(app).get('/somefile.txt').then((response) => { + expect(response.statusCode).toBe(200); + expect(response.text).toBe('filecontent'); + done(); + }); + }); + test('200 valid resource of article', (done) => { + utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]); + fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'somefile.txt'), 'filecontent'); + request(app).get('/2019/05/05/title/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/config.test.js b/test/config.test.js new file mode 100644 index 0000000..fa72475 --- /dev/null +++ b/test/config.test.js @@ -0,0 +1,54 @@ +/* jshint -W117 */ +const fs = require('fs'); + +const configFile = 'config.json'; +const tmpConfigFile = 'config.temp.json'; + +beforeAll(() => { + if (fs.existsSync(configFile)) { + fs.renameSync(configFile, tmpConfigFile); + } + expect(fs.existsSync(configFile)).toBeFalsy(); +}); + +afterAll(() => { + if (fs.existsSync(tmpConfigFile)) { + fs.renameSync(tmpConfigFile, configFile); + } else if (fs.existsSync(configFile)) { + fs.unlinkSync(configFile); //remove config file if remaining + } +}); + +test('no config', () => { + if (fs.existsSync(configFile)) + fs.unlinkSync(configFile); + expect(fs.existsSync(configFile)).toBeFalsy(); + const config = require('../src/config')(); + expect(config).toBeDefined(); + expect(config['node_port']).toBe(3000); + expect(config['data_dir']).toBe('data'); +}); + +test('invalid config ignored', () => { + fs.writeFileSync(configFile, 'invalid JSON'); + const config = require('../src/config')(); + expect(config).toBeDefined(); + expect(config['node_port']).toBe(3000); + expect(config['data_dir']).toBe('data'); +}); + +test('good config merged', () => { + fs.writeFileSync(configFile, '{"node_port":5000}'); + const config = require('../src/config')(); + expect(config).toBeDefined(); + expect(config['node_port']).toBe(5000); + expect(config['data_dir']).toBe('data'); +}); + +test('wrong config fixed', () => { + fs.writeFileSync(configFile, '{"node_port":"hello","data_dir":"data2"}'); + const config = require('../src/config')(); + expect(config).toBeDefined(); + expect(config['node_port']).toBe(3000); + expect(config['data_dir']).toBe('data2'); +}); \ No newline at end of file diff --git a/test/config.test.json b/test/config.test.json deleted file mode 100644 index 0e0dcd2..0000000 --- a/test/config.test.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - -} \ No newline at end of file diff --git a/test/file_walker.test.js b/test/file_walker.test.js new file mode 100644 index 0000000..4eb6c2c --- /dev/null +++ b/test/file_walker.test.js @@ -0,0 +1,277 @@ +/* jshint -W117 */ +const fs = require('fs'); +const path = require('path'); +const utils = require('./test_utils'); + +const dataDir = 'test_data'; +const testIndex = 'testindex.md'; + +const joinUrl = (...paths) => path.join(...paths).replace(/\\/g,'/'); + +const config = { + 'test': true, + 'data_dir': dataDir, + 'article': { + 'index': testIndex, + 'default_title': 'Untitled', + 'default_thumbnail': 'default.png', + 'thumbnail_tag': 'thumbnail' + } +}; + +const fw = require('../src/file_walker')(config); + +beforeEach(() => { + utils.deleteFolderSync(dataDir); + fs.mkdirSync(dataDir); +}); + +afterAll(() => { + if (fs.existsSync(dataDir)) { + utils.deleteFolderSync(dataDir); + } +}); + +describe('Test function fileTree', () => { + test('empty root', (done) => { + fw.fileTree(dataDir, (err, list) => { + expect(err).toBeNull(); + expect(list).toBeDefined(); + expect(list.length).toBe(0); + done(); + }); + }); + test('empty folders', (done) => { + utils.createEmptyDirs([ + path.join(dataDir, 'test', 'test'), + path.join(dataDir, 'test', 'test2'), + path.join(dataDir, 'test2') + ]); + fw.fileTree(dataDir, (err, list) => { + expect(err).toBeNull(); + expect(list).toBeDefined(); + expect(list.length).toBe(0); + done(); + }); + }); + test('simple files', (done) => { + const fileList = [ + path.join(dataDir, 'f1.txt'), + path.join(dataDir, 'f2.txt') + ]; + utils.createEmptyFiles(fileList); + fw.fileTree(dataDir, (err, list) => { + expect(err).toBeNull(); + expect(list).toBeDefined(); + expect(list.length).toBe(fileList.length); + expect(list).toEqual(expect.arrayContaining(fileList)); + done(); + }); + }); + test('nested files', (done) => { + utils.createEmptyDirs([ + path.join(dataDir, 'test', 'test'), + path.join(dataDir, 'test2') + ]); + const fileList = [ + path.join(dataDir, 'f1.txt'), + path.join(dataDir, 'test', 'f2.txt'), + path.join(dataDir, 'test', 'test', 'f3.txt'), + path.join(dataDir, 'test2', 'f4.txt') + ]; + utils.createEmptyFiles(fileList); + fw.fileTree(dataDir, (err, list) => { + expect(err).toBeNull(); + expect(list).toBeDefined(); + expect(list.length).toBe(fileList.length); + expect(list).toEqual(expect.arrayContaining(fileList)); + done(); + }); + }); + test('invalid root', (done) => { + fw.fileTree('invalid root', (err, list) => { + expect(err).not.toBeNull(); + expect(list).not.toBeDefined(); + done(); + }); + }); +}); + +describe('Test index article reading', () => { + 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('correct file', (done) => { + fs.writeFileSync(file, ` + # This is an awesome title !?¤ +  + this is some text + `); + fw.readIndexFile(file, 'custom_thumbnail', (err, info) => { + expect(err).toBeNull(); + expect(info).toBeDefined(); + expect(info.title).toBe('This is an awesome title !?¤'); + expect(info.thumbnail).toBe('./thumbnail.jpg'); + done(); + }); + }); + + test('no title', (done) => { + fs.writeFileSync(file, ` + ## This is an awesome title !?¤ +  + ### this is some text + `); + fw.readIndexFile(file, 'custom_thumbnail', (err, info) => { + expect(err).toBeNull(); + expect(info).toBeDefined(); + expect(info.title).not.toBeDefined(); + expect(info.thumbnail).toBe('./thumbnail.jpg'); + done(); + }); + }); + + test('title at beginning', (done) => { + fs.writeFileSync(file, '#title'); + fw.readIndexFile(file, 'custom_thumbnail', (err, info) => { + expect(err).toBeNull(); + expect(info).toBeDefined(); + expect(info.title).toBe('title'); + expect(info.thumbnail).not.toBeDefined(); + done(); + }); + }); + + test('no thumbnail', (done) => { + fs.writeFileSync(file, ` + # This is an awesome title !?¤ +  + this is some text + `); + fw.readIndexFile(file, 'thumbnail', (err, info) => { + expect(err).toBeNull(); + expect(info).toBeDefined(); + expect(info.title).toBe('This is an awesome title !?¤'); + expect(info.thumbnail).not.toBeDefined(); + done(); + }); + }); + + test('multiple thumbnails', (done) => { + fs.writeFileSync(file, ` + # This is an awesome title !?¤ +  + this is some text +  + `); + fw.readIndexFile(file, 'custom_thumbnail', (err, info) => { + expect(err).toBeNull(); + expect(info).toBeDefined(); + expect(info.title).toBe('This is an awesome title !?¤'); + expect(info.thumbnail).toBe('./thumbnail.jpg'); + done(); + }); + }); +}); + +describe('Test article fetching', () => { + test('invalid data dir', (done) => { + config['data_dir'] = 'invalid root'; + fw.fetchArticles((err, list) => { + expect(err).not.toBeNull(); + expect(list).not.toBeDefined(); + config['data_dir'] = dataDir; + done(); + }); + }); + test('empty data dir', (done) => { + fw.fetchArticles((err, dict) => { + expect(err).toBeNull(); + expect(dict).toBeDefined(); + expect(Object.keys(dict).length).toBe(0); + done(); + }); + }); + test('misplaced index file', (done) => { + utils.createEmptyDirs([ + path.join(dataDir, 'test', 'test'), + path.join(dataDir, '2019', '05', '05') + ]); + utils.createEmptyFiles([ + path.join(dataDir, testIndex), + path.join(dataDir, 'test', 'test', testIndex), + path.join(dataDir, '2019', '05', testIndex) + ]); + fw.fetchArticles((err, dict) => { + expect(err).toBeNull(); + expect(dict).toBeDefined(); + expect(Object.keys(dict).length).toBe(0); + done(); + }); + }); + test('empty index file', (done) => { + const dir = path.join(dataDir, '2019', '05', '05'); + const file = path.join(dir, testIndex); + utils.createEmptyDirs([dir]); + utils.createEmptyFiles([file]); + const date = new Date(2019, 5, 5); + date.setUTCHours(0); + fw.fetchArticles((err, dict) => { + expect(err).toBeNull(); + expect(dict).toBeDefined(); + expect(Object.keys(dict).length).toBe(1); + expect(dict[joinUrl('2019', '05', '05')]).toEqual({ + path: joinUrl('2019', '05', '05'), + realPath: dir, + year: 2019, + month: 5, + day: 5, + date: date, + title: 'Untitled', + thumbnail: 'default.png', + escapedTitle: 'untitled', + url: '/' + joinUrl('2019', '05', '05', 'untitled') + '/', + }); + done(); + }); + }); + test('correct index file', (done) => { + const dir = path.join(dataDir, '2019', '05', '05'); + const file = path.join(dir, testIndex); + utils.createEmptyDirs([dir]); + fs.writeFileSync(file, ` + # Title with : info ! +  + this is some text + `); + const date = new Date(2019, 5, 5); + date.setUTCHours(0); + fw.fetchArticles((err, dict) => { + expect(err).toBeNull(); + expect(dict).toBeDefined(); + expect(Object.keys(dict).length).toBe(1); + expect(dict[joinUrl('2019', '05', '05')]).toEqual({ + path: joinUrl('2019', '05', '05'), + realPath: dir, + year: 2019, + month: 5, + day: 5, + date: date, + title: 'Title with : info !', + thumbnail: joinUrl('2019', '05', '05', './thumbnail.jpg'), + escapedTitle: 'title_with___info', + url: '/' + joinUrl('2019', '05', '05', 'title_with___info') + '/', + }); + done(); + }); + }); +}); + diff --git a/test/renderer.test.js b/test/renderer.test.js new file mode 100644 index 0000000..c2912eb --- /dev/null +++ b/test/renderer.test.js @@ -0,0 +1,96 @@ +/* jshint -W117 */ +const fs = require('fs'); +const path = require('path'); +const utils = require('./test_utils'); + +const dataDir = 'test_data'; +const file = path.join(dataDir, 'test.md'); + +const config = { + 'modules': { + 'prism': true, + }, + 'showdown': { + 'simplifiedAutoLink': true, + 'smartIndentationFix': true + } +}; + +const renderer = require('../src/renderer')(config); + +beforeEach(() => { + utils.deleteFolderSync(dataDir); + fs.mkdirSync(dataDir); +}); + +afterAll(() => { + if (fs.existsSync(dataDir)) { + utils.deleteFolderSync(dataDir); + } +}); + +test('invalid file', (done) => { + renderer.render('invalid file', (err, html) => { + expect(err).not.toBeNull(); + expect(html).not.toBeDefined(); + done(); + }); +}); + +test('normal file', (done) => { + fs.writeFileSync(file, `# Hello`); + renderer.render(file, (err, html) => { + expect(err).toBeNull(); + expect(html).toBe('Hello
'); + done(); + }); +}); + +test('custom rules', (done) => { + fs.writeFileSync(file, `www.google.com`); + renderer.render(file, (err, html) => { + expect(err).toBeNull(); + expect(html).toBe(''); + done(); + }); +}); + +test('no prism', (done) => { + config['modules']['prism'] = false; + fs.writeFileSync(file, '```python\nprint("hello")\n```\n\n```python\nprint("hello")\n```'); + renderer.render(file, (err, html) => { + expect(err).toBeNull(); + expect(html).toBe('print("hello")\nprint("hello")\nprint("hello")\n')).toBe(0);
+ done();
+ });
+});
+
+test('prism invalid lang', (done) => {
+ fs.writeFileSync(file, '```pythdon\nprint("hello")\n```');
+ renderer.render(file, (err, html) => {
+ expect(err).toBeNull();
+ expect(html).not.toBe('print("hello")\n
');
+ expect(html.indexOf('')).toBe(0);
+ done();
+ });
+});
+
+test('prism mutliple code blocks', (done) => {
+ fs.writeFileSync(file, '```python\n\n```\n\n```python\n\n```');
+ renderer.render(file, (err, html) => {
+ expect(err).toBeNull();
+ expect(html).toBe('
\n
');
+ done();
+ });
+});
\ No newline at end of file
diff --git a/test/test_utils.js b/test/test_utils.js
new file mode 100644
index 0000000..6b509c5
--- /dev/null
+++ b/test/test_utils.js
@@ -0,0 +1,20 @@
+const fs = require('fs');
+const path = require('path');
+
+const deleteFolderSync = (dir) => {
+ if (!fs.existsSync(dir))
+ return;
+ fs.readdirSync(dir, {withFileTypes: true}).forEach((item) => {
+ if (item.isDirectory())
+ deleteFolderSync(path.join(dir, item.name));
+ else
+ fs.unlinkSync(path.join(dir, item.name));
+ });
+ fs.rmdirSync(dir);
+};
+
+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