Add <$testcase> widget (#7817)

* Initial Commit * Add note to preview build * Fix whitespace and indenting Thanks @pmario * Fix crash with unset $tiddler attribute on <$data> widget Thanks @CodaCodr * Don't duplicate "description" field in test cases * Use different background colours for nested testcase widgets * Extend the testcase widget to run tests * Add testcases to control panel * Add a view template body template to render testcase tiddlers * Test edition should display testcases * Whitespace fixes * Make testcase tiddler tempalte link to itself * Styling tweaks * Docs improvements * Styling tweaks * Run the new tw5.com testcases in the test edition * Update data widget to display its content in JSON * Add testcase convenience procedure * Clearer testcases for data widget, and docs tweaks * Don't expect our intentionally failing test to pass * Extend testcase default template so that the display format can be chosen It is selected by setting the variable "displayFormat" * DataWidget docs typo * Fix data widget not refreshing * Links in testcase output switch to the tab containing that tiddler Thanks to @btheado for the suggestion * Docs update for 648855e8a5 * Wording tweak * Add support for narrative tiddlers in test cases * Documentation improvements * Cleanup comments * Remove obsolete code comments * Simplify template * Docs update * Rename $:/core/ui/testcases/DefaultTemplate/SourceTabs from $:/core/ui/testcases/DefaultTemplate/Source * Use the view template body for failing tests * Don't reference the geospatial plugin * "Test case" should be two words * Fix handling of currentTiddler variable Fixes problem reported by @btheado in https://github.com/Jermolene/TiddlyWiki5/pull/7817#issuecomment-2103704468 * Prepare for merging
2026-09-19 08:10:44 +00:00 · 2024-05-20 11:30:30 +01:00
parent f1299120a6
commit ece8b0ee01
36 changed files with 1109 additions and 131 deletions
@@ -0,0 +1,145 @@
+/*\
+title: $:/core/modules/widgets/data.js
+type: application/javascript
+module-type: widget
+
+Widget to dynamically represent one or more tiddlers
+
+\*/
+(function(){
+
+/*jslint node: true, browser: true */
+/*global $tw: false */
+"use strict";
+
+var Widget = require("$:/core/modules/widgets/widget.js").widget;
+
+var DataWidget = function(parseTreeNode,options) {
+	this.dataWidgetTag = parseTreeNode.type;
+	this.initialise(parseTreeNode,options);
+};
+
+/*
+Inherit from the base widget class
+*/
+DataWidget.prototype = new Widget();
+
+/*
+Render this widget into the DOM
+*/
+DataWidget.prototype.render = function(parent,nextSibling) {
+	this.parentDomNode = parent;
+	this.computeAttributes();
+	this.execute();
+	var jsonPayload = JSON.stringify(this.readDataTiddlerValues(),null,4);
+	var textNode = this.document.createTextNode(jsonPayload);
+	parent.insertBefore(textNode,nextSibling);
+	this.domNodes.push(textNode);
+};
+
+/*
+Compute the internal state of the widget
+*/
+DataWidget.prototype.execute = function() {
+	// Construct the child widgets
+	this.makeChildWidgets();
+};
+
+/*
+Read the tiddler value(s) from a data widget – must be called after the .render() method
+*/
+DataWidget.prototype.readDataTiddlerValues = function() {
+	var self = this;
+	// Start with a blank object
+	var item = Object.create(null);
+	// Read any attributes not prefixed with $
+	$tw.utils.each(this.attributes,function(value,name) {
+		if(name.charAt(0) !== "$") {
+			item[name] = value;	
+		}
+	});
+	item = new $tw.Tiddler(item);
+	// Deal with $tiddler, $filter or $compound-tiddler attributes
+	var tiddlers = [],title;
+	if(this.hasAttribute("$tiddler")) {
+		title = this.getAttribute("$tiddler");
+		if(title) {
+			var tiddler = this.wiki.getTiddler(title);
+			if(tiddler) {
+				tiddlers.push(tiddler);
+			}
+		}
+	}
+	if(this.hasAttribute("$filter")) {
+		var filter = this.getAttribute("$filter");
+		if(filter) {
+			var titles = this.wiki.filterTiddlers(filter);
+			$tw.utils.each(titles,function(title) {
+				var tiddler = self.wiki.getTiddler(title);
+				tiddlers.push(tiddler);
+			});
+		}
+	}
+	if(this.hasAttribute("$compound-tiddler")) {
+		title = this.getAttribute("$compound-tiddler");
+		if(title) {
+			tiddlers.push.apply(tiddlers,this.extractCompoundTiddler(title));
+		}
+	}
+	// Convert the literal item to field strings
+	item = item.getFieldStrings();
+	if(tiddlers.length === 0) {
+		if(Object.keys(item).length > 0 && !!item.title) {
+			return [item];
+		} else {
+			return [];
+		}
+	} else {
+		var results = [];
+		$tw.utils.each(tiddlers,function(tiddler,index) {
+			var fields = tiddler.getFieldStrings();
+			results.push($tw.utils.extend({},fields,item));
+		});
+		return results;	
+	}
+};
+
+/*
+Helper to extract tiddlers from text/vnd.tiddlywiki-multiple tiddlers
+*/
+DataWidget.prototype.extractCompoundTiddler = function(title) {
+	var tiddler = this.wiki.getTiddler(title);
+	if(tiddler && tiddler.fields.type === "text/vnd.tiddlywiki-multiple") {
+		var text = tiddler.fields.text || "",
+			rawTiddlers = text.split(/\r?\n\+\r?\n/),
+			tiddlers = [];
+		$tw.utils.each(rawTiddlers,function(rawTiddler) {
+			var fields = Object.create(null),
+				split = rawTiddler.split(/\r?\n\r?\n/mg);
+			if(split.length >= 1) {
+				fields = $tw.utils.parseFields(split[0],fields);
+			}
+			if(split.length >= 2) {
+				fields.text = split.slice(1).join("\n\n");
+			}
+			tiddlers.push(new $tw.Tiddler(fields));
+		});
+		return tiddlers;
+	} else {
+		return [];
+	}
+};
+
+/*
+Selectively refreshes the widget if needed. Returns true if the widget or any of its children needed re-rendering
+*/
+DataWidget.prototype.refresh = function(changedTiddlers) {
+	// It would be expensive to calculate whether the changedTiddlers impact the filter
+	// identified by the $filter attribute so we just refresh ourselves unconditionally
+	this.refreshSelf();
+	return true;
+};
+
+exports.data = DataWidget;
+
+})();
@@ -0,0 +1,160 @@
+/*\
+title: $:/core/modules/widgets/testcase.js
+type: application/javascript
+module-type: widget
+
+Widget to display a test case
+
+\*/
+(function(){
+
+/*jslint node: true, browser: true */
+/*global $tw: false */
+"use strict";
+
+var Widget = require("$:/core/modules/widgets/widget.js").widget;
+
+var TestCaseWidget = function(parseTreeNode,options) {
+	this.initialise(parseTreeNode,options);
+};
+
+/*
+Inherit from the base widget class
+*/
+TestCaseWidget.prototype = new Widget();
+
+/*
+Render this widget into the DOM
+*/
+TestCaseWidget.prototype.render = function(parent,nextSibling) {
+	var self = this;
+	this.parentDomNode = parent;
+	this.computeAttributes();
+	this.execute();
+	// Create container DOM node
+	var domNode = this.document.createElement("div");
+	this.domNodes.push(domNode);
+	parent.insertBefore(domNode,nextSibling);
+	// Render the children into a hidden DOM node
+	var parser = {
+		tree: [{
+			type: "widget",
+			attributes: {},
+			orderedAttributes: [],
+			children: this.parseTreeNode.children || []
+		}]
+	};
+	this.contentRoot = this.wiki.makeWidget(parser,{
+		document: $tw.fakeDocument,
+		parentWidget: this
+	});
+	this.contentContainer = $tw.fakeDocument.createElement("div");
+	this.contentRoot.render(this.contentContainer,null);
+	// Create a wiki
+	this.testcaseWiki = new $tw.Wiki();
+	// Always load the core plugin
+	var loadTiddler = function(title) {
+		var tiddler = self.wiki.getTiddler(title);
+		if(tiddler) {
+			self.testcaseWiki.addTiddler(tiddler);
+		}
+	}
+	loadTiddler("$:/core");
+	loadTiddler("$:/plugins/tiddlywiki/codemirror");
+	// Load tiddlers from child data widgets
+	var tiddlers = [];
+	this.findChildrenDataWidgets(this.contentRoot.children,"data",function(widget) {
+		Array.prototype.push.apply(tiddlers,widget.readDataTiddlerValues());
+	});
+	var jsonPayload = JSON.stringify(tiddlers);
+	this.testcaseWiki.addTiddlers(tiddlers);
+	// Unpack plugin tiddlers
+	this.testcaseWiki.readPluginInfo();
+	this.testcaseWiki.registerPluginTiddlers("plugin");
+	this.testcaseWiki.unpackPluginTiddlers();
+	this.testcaseWiki.addIndexersToWiki();
+	// Generate a `transclusion` variable that depends on the values of the payload tiddlers so that the template can easily make unique state tiddlers
+	this.setVariable("transclusion",$tw.utils.hashString(jsonPayload));
+	// Generate a `payloadTiddlers` variable that contains the payload in JSON format
+	this.setVariable("payloadTiddlers",jsonPayload);
+	// Render the test rendering if required
+	if(this.testcaseTestOutput && this.testcaseTestExpectedResult) {
+		var testcaseOutputContainer = $tw.fakeDocument.createElement("div");
+		var testcaseOutputWidget = this.testcaseWiki.makeTranscludeWidget(this.testcaseTestOutput,{
+			document: $tw.fakeDocument,
+			parseAsInline: false,
+			parentWidget: this,
+			variables: {
+				currentTiddler: this.testcaseTestOutput
+			}
+		});
+		testcaseOutputWidget.render(testcaseOutputContainer);
+	}
+	// Clear changes queue
+	this.testcaseWiki.clearTiddlerEventQueue();
+	// Run the actions if provided
+	if(this.testcaseWiki.tiddlerExists(this.testcaseTestActions)) {
+		testcaseOutputWidget.invokeActionString(this.testcaseWiki.getTiddlerText(this.testcaseTestActions));
+		testcaseOutputWidget.refresh(this.testcaseWiki.changedTiddlers,testcaseOutputContainer);
+	}
+	// Set up the test result variables
+	var testResult = "",
+		outputHTML = "",
+		expectedHTML = "";
+	if(this.testcaseTestOutput && this.testcaseTestExpectedResult) {
+		outputHTML = testcaseOutputContainer.children[0].innerHTML;
+		expectedHTML = this.testcaseWiki.getTiddlerText(this.testcaseTestExpectedResult);
+		if(outputHTML === expectedHTML) {
+			testResult = "pass";
+		} else {
+			testResult = "fail";
+		}
+		this.setVariable("outputHTML",outputHTML);
+		this.setVariable("expectedHTML",expectedHTML);
+		this.setVariable("testResult",testResult);
+		this.setVariable("currentTiddler",this.testcaseTestOutput);
+	}
+	// Don't display anything if testHideIfPass is "yes" and the tests have passed
+	if(this.testcaseHideIfPass === "yes" && testResult === "pass") {
+		return;
+	}
+	// Render the page root template of the subwiki
+	var rootWidget = this.testcaseWiki.makeTranscludeWidget(this.testcaseTemplate,{
+		document: this.document,
+		parseAsInline: false,
+		parentWidget: this
+	});
+	rootWidget.render(domNode);
+	// Trap changes in the wiki and refresh the rendering
+	this.testcaseWiki.addEventListener("change",function(changes) {
+		rootWidget.refresh(changes,domNode);
+	});
+};
+
+/*
+Compute the internal state of the widget
+*/
+TestCaseWidget.prototype.execute = function() {
+	this.testcaseTemplate = this.getAttribute("template","$:/core/ui/testcases/DefaultTemplate");
+	this.testcaseTestOutput = this.getAttribute("testOutput");
+	this.testcaseTestActions = this.getAttribute("testActions");
+	this.testcaseTestExpectedResult = this.getAttribute("testExpectedResult");
+	this.testcaseHideIfPass = this.getAttribute("testHideIfPass");
+};
+
+/*
+Selectively refreshes the widget if needed. Returns true if the widget or any of its children needed re-rendering
+*/
+TestCaseWidget.prototype.refresh = function(changedTiddlers) {
+	var changedAttributes = this.computeAttributes();
+	if($tw.utils.count(changedAttributes) > 0) {
+		this.refreshSelf();
+		return true;
+	} else {
+		return this.contentRoot.refresh(changedTiddlers);
+	}
+};
+
+exports["testcase"] = TestCaseWidget;
+
+})();
@@ -813,6 +813,21 @@ Widget.prototype.allowActionPropagation = function() {
 	return true;
 };

+/*
+Find child <$data> widgets recursively. The tag name allows aliased versions of the widget to be found too
+*/
+Widget.prototype.findChildrenDataWidgets = function(children,tag,callback) {
+	var self = this;
+	$tw.utils.each(children,function(child) {
+		if(child.dataWidgetTag === tag) {
+			callback(child);
+		}
+		if(child.children) {
+			self.findChildrenDataWidgets(child.children,tag,callback);
+		}
+	});
+};
+
 /*
 Evaluate a variable with parameters. This is a static convenience method that attempts to evaluate a variable as a function, returning an array of strings
 */