refactor: Extract the rendering into an interface

This commit is contained in:
Jeremy Wall 2024-04-01 09:46:11 -04:00
parent 8841ca71bd
commit d4da1d7dee
3 changed files with 256 additions and 171 deletions

View File

@ -19,6 +19,32 @@
* @license Artistic-2.0 * @license Artistic-2.0
*/ */
/** @implements TapRenderer */
class NodeRenderer {
out(text) {
import('node:process').then(loaded => {;
loaded.stdout.write(text + "\n");
})
}
diag(lines) {
for (var line of lines) {
this.out('# ' + line);
}
}
}
/** @implements TapRenderer */
class BrowserRenderer {
out(text) {
// TODO(jeremy):
}
diag(lines) {
// TODO(jeremy):
}
}
/** /**
* The Tap Test Class helper. * The Tap Test Class helper.
*/ */
@ -31,35 +57,29 @@ class Tap {
passed = 0; passed = 0;
/** @type Number */ /** @type Number */
failed = 0; failed = 0;
/** @type function(TestOutput) */ /** @type TapRenderer */
#renderLine #renderer
/** /**
* Construct a new Tap Suite with a renderLine function. * Construct a new Tap Suite with a renderLine function.
* @param {function(string)} * @param {TapRenderer}
*/ */
constructor(renderFunc) { constructor(renderFunc) {
this.#renderLine = renderFunc; this.#renderer = renderFunc;
} }
static Browser() { static Browser() {
return new Tap(function(text) { return new Tap(new BrowserRenderer());
// TODO(zaphar): Handle output in a Browser context.
});
} }
static Node() { static Node() {
return new Tap(function(text) { return new Tap(new NodeRenderer());
import('node:process').then(loaded => {;
loaded.stdout.write(text + "\n");
})
});
} }
/** Renders output for the test results */ /** Renders output for the test results */
out(text) { out(text) {
this.#renderLine(text); this.#renderer.out(text);
}; };
/** /**
@ -78,18 +98,12 @@ class Tap {
}; };
/** Diagnostic formatter for TAP Output.
*
* @param msg {string}
*/
diag(msg){ diag(msg){
if (!msg) { if(!msg) {
msg = " "; msg = " ";
} }
var lines = msg.split("\n"); var lines = msg.split("\n");
for (var line of lines) { this.#renderer.diag(lines);
this.out('# ' + msg);
}
}; };
/** Render a pass TAP output message. /** Render a pass TAP output message.
@ -241,11 +255,8 @@ class Tap {
var pass = true; var pass = true;
for (var i=1; i<arguments.length; i++) { for (var i=1; i<arguments.length; i++) {
if (typeof(obj[arguments[i]]) != 'function') { if (typeof(obj[arguments[i]]) != 'function') {
//this.diag('TypeOf ' + arguments[i] + ' method is: ' + typeof(obj[arguments[i]]) );
//this.diag('TypeOf prototype is: ' + typeof(obj.prototype) );
if (typeof(obj.prototype) != 'undefined') { if (typeof(obj.prototype) != 'undefined') {
var result = typeof eval('obj.prototype.' + arguments[i]); var result = typeof eval('obj.prototype.' + arguments[i]);
//this.diag('TypeOf prototype method is: ' + result);
if (result == 'undefined') { if (result == 'undefined') {
pass = false; pass = false;
this.diag('Missing ' + arguments[i] + ' method'); this.diag('Missing ' + arguments[i] + ' method');
@ -319,5 +330,59 @@ class Tap {
} }
/**
* Run a test and render a summarization.
*
* @param {Tap} t
* @param {string} testName
* @param {function(Tap)} test
*/
function runTest(t, testName, test) {
t.diag('running ' + testName + ' tests');
try {
test(t);
if (t.planned > t.counter) {
t.diag('looks like you planned ' + t.planned + ' tests but only ran '
+ t.counter + ' tests');
} else if (t.planned < t.counter) {
t.diag('looks like you planned ' + t.planned + ' tests but ran '
+ (t.counter - t.planned) + ' tests extra');
}
t.diag('ran ' + t.counter + ' tests out of ' + t.planned);
t.diag('passed ' + t.passed + ' tests out of ' + t.planned);
t.diag('failed ' + t.failed + ' tests out of ' + t.planned);
}
catch (err) {
t.diag("Test Suite Crashed!!! (" + err + ")");
}
return t;
}
/**
* Runs a set of TAP tests defined by a function.
* Uses the NodeRenderer for the test output.
*
* @param {string} testName
* @param {function(Tap)} test
*/
function runNodeTap(testName, test) {
var t = Tap.Node();
return runTest(t, testName, test);
}
/**
* Runs a set of TAP tests defined by a function.
* Uses the Browser renderer for the test output.
*
* @param {string} testName
* @param {function(Tap)} test
*/
function runBrowserTap(testName, test) {
var t = Tap.Browser();
return runTest(t, testName, test);
}
// TODO(zaphar): The runner interface as well. // TODO(zaphar): The runner interface as well.
export { Tap }; export { Tap, runNodeTap, runBrowserTap };

16
src/Tap.d.js Normal file
View File

@ -0,0 +1,16 @@
/** @interface */
class TapRenderer {
/** Renders output for the test results
* @param {string} text
*/
out(text) {
}
/** Diagnostic formatter for TAP Output.
*
* @param {Array<string>} lines
*/
diag(lines) {
}
}

View File

@ -1,8 +1,10 @@
import('../src/TAP.mjs').then(m => { import('../src/TAP.mjs').then(m => {
var runNodeTap = m.runNodeTap;
function tapSuite(t) {
var out = "nothing yet"; var out = "nothing yet";
var diag = ""; var diag = "";
var t = m.Tap.Node(); t.plan(17);
t.plan(27);
var testCan = function () { var testCan = function () {
// setup fake test object // setup fake test object
@ -147,4 +149,6 @@ import('../src/TAP.mjs').then(m => {
testTodoSkip(); testTodoSkip();
return t; return t;
}
runNodeTap("Tap dogfood test suite", tapSuite);
}); });