#!/usr/bin/env node /** * marked tests * Copyright (c) 2011-2013, Christopher Jeffrey. (MIT Licensed) * https://github.com/chjj/marked */ /** * Modules */ var fs = require('fs'), path = require('path'), fm = require('front-matter'), g2r = require('glob-to-regexp'), marked = require('../'), markedMin = require('../marked.min.js'); /** * Load Tests */ function load(options) { var dir = path.join(__dirname, 'compiled_tests'), files = {}, list, file, name, content, glob = g2r(options.glob || '*', { extended: true }), i, l; list = fs .readdirSync(dir) .filter(function(file) { return path.extname(file) === '.md'; }) .sort(); l = list.length; for (i = 0; i < l; i++) { name = path.basename(list[i], '.md'); if (glob.test(name)) { file = path.join(dir, list[i]); content = fm(fs.readFileSync(file, 'utf8')); files[name] = { options: content.attributes, text: content.body, html: fs.readFileSync(file.replace(/[^.]+$/, 'html'), 'utf8') }; } } if (options.bench || options.time) { if (!options.glob) { // Change certain tests to allow // comparison to older benchmark times. fs.readdirSync(path.join(__dirname, 'new')).forEach(function(name) { if (path.extname(name) === '.html') return; if (name === 'main.md') return; delete files[name]; }); } if (files['backslash_escapes.md']) { files['backslash_escapes.md'] = { text: 'hello world \\[how](are you) today' }; } if (files['main.md']) { files['main.md'].text = files['main.md'].text.replace('* * *\n\n', ''); } } return files; } /** * Test Runner */ function runTests(engine, options) { if (typeof engine !== 'function') { options = engine; engine = null; } engine = engine || marked; options = options || {}; var succeeded = 0, failed = 0, files = options.files || load(options), filenames = Object.keys(files), len = filenames.length, success, i, filename, file; if (options.marked) { marked.setOptions(options.marked); } for (i = 0; i < len; i++) { filename = filenames[i]; file = files[filename]; success = testFile(engine, file, filename, i + 1); if (success) { succeeded++; } else { failed++; if (options.stop) { break; } } } console.log('%d/%d tests completed successfully.', succeeded, len); if (failed) console.log('%d/%d tests failed.', failed, len); return !failed; } /** * Test a file */ function testFile(engine, file, filename, index) { var opts = Object.keys(file.options), text, html, j, l; if (marked._original) { marked.defaults = marked._original; delete marked._original; } if (opts.length) { marked._original = marked.defaults; marked.defaults = {}; Object.keys(marked._original).forEach(function(key) { marked.defaults[key] = marked._original[key]; }); opts.forEach(function(key) { if (marked.defaults.hasOwnProperty(key)) { marked.defaults[key] = file.options[key]; } }); } try { text = engine(file.text).replace(/\s/g, ''); html = file.html.replace(/\s/g, ''); } catch (e) { console.log('%s failed.', filename); throw e; } l = html.length; for (j = 0; j < l; j++) { if (text[j] !== html[j]) { text = text.substring( Math.max(j - 30, 0), Math.min(j + 30, text.length)); html = html.substring( Math.max(j - 30, 0), Math.min(j + 30, l)); console.log( '\n#%d. %s failed at offset %d. Near: "%s".\n', index, filename, j, text); console.log('\nGot:\n%s\n', text.trim() || text); console.log('\nExpected:\n%s\n', html.trim() || html); return false; } } console.log('#%d. %s completed.', index, filename); return true } /** * Benchmark a function */ function bench(name, files, func) { var start = Date.now(), times = 1000, keys = Object.keys(files), i, l = keys.length, filename, file; while (times--) { for (i = 0; i < l; i++) { filename = keys[i]; file = files[filename]; func(file.text); } } console.log('%s completed in %dms.', name, Date.now() - start); } /** * Benchmark all engines */ function runBench(options) { options = options || {}; var files = load(options); // Non-GFM, Non-pedantic marked.setOptions({ gfm: false, tables: false, breaks: false, pedantic: false, sanitize: false, smartLists: false }); if (options.marked) { marked.setOptions(options.marked); } bench('marked', files, marked); // GFM marked.setOptions({ gfm: true, tables: false, breaks: false, pedantic: false, sanitize: false, smartLists: false }); if (options.marked) { marked.setOptions(options.marked); } bench('marked (gfm)', files, marked); // Pedantic marked.setOptions({ gfm: false, tables: false, breaks: false, pedantic: true, sanitize: false, smartLists: false }); if (options.marked) { marked.setOptions(options.marked); } bench('marked (pedantic)', files, marked); // showdown try { bench('showdown (reuse converter)', files, (function() { var Showdown = require('showdown'); var convert = new Showdown.Converter(); return function(text) { return convert.makeHtml(text); }; })()); bench('showdown (new converter)', files, (function() { var Showdown = require('showdown'); return function(text) { var convert = new Showdown.Converter(); return convert.makeHtml(text); }; })()); } catch (e) { console.log('Could not bench showdown. (Error: %s)', e.message); } // markdown-it try { bench('markdown-it', files, (function() { var MarkdownIt = require('markdown-it'); var md = new MarkdownIt(); return function(text) { return md.render(text); }; })()); } catch (e) { console.log('Could not bench markdown-it. (Error: %s)', e.message); } // markdown.js try { bench('markdown.js', files, (function() { var markdown = require('markdown').markdown; return function(text) { return markdown.toHTML(text); }; })()); } catch (e) { console.log('Could not bench markdown.js. (Error: %s)', e.message); } return true; } /** * A simple one-time benchmark */ function time(options) { options = options || {}; var files = load(options); if (options.marked) { marked.setOptions(options.marked); } bench('marked', files, marked); return true; } /** * Markdown Test Suite Fixer * This function is responsible for "fixing" * the markdown test suite. There are * certain aspects of the suite that * are strange or might make tests * fail for reasons unrelated to * conformance. */ function fix() { ['compiled_tests', 'original', 'new'].forEach(function(dir) { try { fs.mkdirSync(path.resolve(__dirname, dir), 0o755); } catch (e) { ; } }); // rm -rf tests fs.readdirSync(path.resolve(__dirname, 'compiled_tests')).forEach(function(file) { fs.unlinkSync(path.resolve(__dirname, 'compiled_tests', file)); }); // cp -r original tests fs.readdirSync(path.resolve(__dirname, 'original')).forEach(function(file) { var text = fs.readFileSync(path.resolve(__dirname, 'original', file)); if (path.extname(file) === '.md') { text = '---\ngfm: false\n---\n' + text; } fs.writeFileSync(path.resolve(__dirname, 'compiled_tests', file), text); }); // node fix.js var dir = path.join(__dirname, 'compiled_tests'); fs.readdirSync(dir).filter(function(file) { return path.extname(file) === '.html'; }).forEach(function(file) { file = path.join(dir, file); var html = fs.readFileSync(file, 'utf8'); // fix unencoded quotes html = html .replace(/='([^\n']*)'(?=[^<>\n]*>)/g, '=&__APOS__;$1&__APOS__;') .replace(/="([^\n"]*)"(?=[^<>\n]*>)/g, '=&__QUOT__;$1&__QUOT__;') .replace(/"/g, '"') .replace(/'/g, ''') .replace(/&__QUOT__;/g, '"') .replace(/&__APOS__;/g, '\''); // add heading id's html = html.replace(/<(h[1-6])>([^<]+)<\/\1>/g, function(s, h, text) { var id = text .replace(/'/g, '\'') .replace(/"/g, '"') .replace(/>/g, '>') .replace(/</g, '<') .replace(/&/g, '&'); id = id.toLowerCase().replace(/[^\w]+/g, '-'); return '<' + h + ' id="' + id + '">' + text + '' + h + '>'; }); fs.writeFileSync(file, html); }); // turn