michael@0: /**
michael@0:  * This script is used for testing XUL templates. Call test_template within
michael@0:  * a load event handler.
michael@0:  *
michael@0:  * A test should have a root node with the datasources attribute with the
michael@0:  * id 'root', and a few global variables defined in the test's XUL file:
michael@0:  *
michael@0:  *  testid: the testid, used when outputting test results
michael@0:  *  expectedOutput: e4x data containing the expected output. It can optionally
michael@0:  *                  be enclosed in an <output> element as most tests generate
michael@0:  *                  more than one node of output.
michael@0:  *  isTreeBuilder: true for dont-build-content trees, false otherwise
michael@0:  *  queryType: 'rdf', 'xml', etc.
michael@0:  *  needsOpen: true for menu tests where the root menu must be opened before
michael@0:  *             comparing results
michael@0:  *  notWorkingYet: true if this test isn't working yet, outputs todo results
michael@0:  *  notWorkingYetDynamic: true if the dynamic changes portion of the test
michael@0:  *                        isn't working yet, outputs todo results
michael@0:  *  changes: an array of functions to perform in sequence to test dynamic changes
michael@0:  *           to the datasource.
michael@0:  *
michael@0:  * If the <output> element has an unordered attribute set to true, the
michael@0:  * children within it must all appear to match, but may appear in any order.
michael@0:  * If the unordered attribute is not set, the children must appear in the same
michael@0:  * order.
michael@0:  *
michael@0:  * If the 'changes' array is used, it should be an array of functions. Each
michael@0:  * function will be called in order and a comparison of the output will be
michael@0:  * performed. This allows changes to be made to the datasource to ensure that
michael@0:  * the generated template output has been updated. Within the expected output
michael@0:  * XML, the step attribute may be set to a number on an element to indicate
michael@0:  * that an element only applies before or after a particular change. If step
michael@0:  * is set to a positive number, that element will only exist after that step in
michael@0:  * the list of changes made. If step is set to a negative number, that element
michael@0:  * will only exist until that step. Steps are numbered starting at 1. For
michael@0:  * example:
michael@0:  *   <label value="Cat"/>
michael@0:  *   <label step="2" value="Dog"/>
michael@0:  *   <label step="-5" value="Mouse"/>
michael@0:  * The first element will always exist. The second element will only appear
michael@0:  * after the second change is made. The third element will only appear until
michael@0:  * the fifth change and it will no longer be present at later steps.
michael@0:  *
michael@0:  * If the anyid attribute is set to true on an element in the expected output,
michael@0:  * then the value of the id attribute on that element is not compared for a
michael@0:  * match. This is used, for example, for xml datasources, where the ids set on
michael@0:  * the generated output are pseudo-random.
michael@0:  */
michael@0: 
michael@0: const ZOO_NS = "http://www.some-fictitious-zoo.com/";
michael@0: const XUL_NS = "http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul";
michael@0: const debug = false;
michael@0: 
michael@0: var expectedConsoleMessages = [];
michael@0: var expectLoggedMessages = null;
michael@0: 
michael@0: try {
michael@0:   const RDF = Components.classes["@mozilla.org/rdf/rdf-service;1"].
michael@0:                 getService(Components.interfaces.nsIRDFService);
michael@0:   const ContainerUtils = Components.classes["@mozilla.org/rdf/container-utils;1"].
michael@0:                            getService(Components.interfaces.nsIRDFContainerUtils);
michael@0: } catch(ex) { }
michael@0: 
michael@0: var xmlDoc;
michael@0: 
michael@0: function test_template()
michael@0: {
michael@0:   var root = document.getElementById("root");
michael@0: 
michael@0:   var ds;
michael@0:   if (queryType == "rdf" && RDF) {
michael@0:     var ioService = Components.classes["@mozilla.org/network/io-service;1"].
michael@0:                       getService(Components.interfaces.nsIIOService);
michael@0: 
michael@0:     var src = window.location.href.replace(/test_tmpl.*xul/, "animals.rdf");
michael@0:     ds = RDF.GetDataSourceBlocking(src);
michael@0: 
michael@0:     if (expectLoggedMessages) {
michael@0:       Components.classes["@mozilla.org/consoleservice;1"].
michael@0:                  getService(Components.interfaces.nsIConsoleService).reset();
michael@0:     }
michael@0: 
michael@0:     if (root.getAttribute("datasources") == "rdf:null")
michael@0:       root.setAttribute("datasources", "animals.rdf");
michael@0:   }
michael@0:   else if (queryType == "xml") {
michael@0:     var src = window.location.href.replace(/test_tmpl.*xul/, "animals.xml");
michael@0:     xmlDoc = new XMLHttpRequest();
michael@0:     xmlDoc.open("get", src, false);
michael@0:     xmlDoc.send(null);
michael@0:   }
michael@0: 
michael@0:   // open menus if necessary
michael@0:   if (needsOpen)
michael@0:     root.open = true;
michael@0: 
michael@0:   if (expectLoggedMessages)
michael@0:     expectLoggedMessages();
michael@0: 
michael@0:   checkResults(root, 0);
michael@0: 
michael@0:   if (changes.length) {
michael@0:     var usedds = ds;
michael@0:     // within these chrome tests, RDF datasources won't be modifiable unless
michael@0:     // an in-memory datasource is used instead. Call copyRDFDataSource to
michael@0:     // copy the datasource.
michael@0:     if (queryType == "rdf")
michael@0:       usedds = copyRDFDataSource(root, ds);
michael@0:     if (needsOpen)
michael@0:       root.open = true;
michael@0:     setTimeout(iterateChanged, 0, root, usedds);
michael@0:   }
michael@0:   else {
michael@0:     if (needsOpen)
michael@0:       root.open = false;
michael@0:     if (expectedConsoleMessages.length)
michael@0:       compareConsoleMessages();
michael@0:     SimpleTest.finish();
michael@0:   }
michael@0: }
michael@0: 
michael@0: function iterateChanged(root, ds)
michael@0: {
michael@0:   Components.classes["@mozilla.org/consoleservice;1"].
michael@0:              getService(Components.interfaces.nsIConsoleService).reset();
michael@0: 
michael@0:   for (var c = 0; c < changes.length; c++) {
michael@0:     changes[c](ds, root);
michael@0:     checkResults(root, c + 1);
michael@0:   }
michael@0: 
michael@0:   if (needsOpen)
michael@0:     root.open = false;
michael@0:   if (expectedConsoleMessages.length)
michael@0:     compareConsoleMessages();
michael@0:   SimpleTest.finish();
michael@0: }
michael@0: 
michael@0: function checkResults(root, step)
michael@0: {
michael@0:   var output = expectedOutput.cloneNode(true);
michael@0:   setForCurrentStep(output, step);
michael@0: 
michael@0:   var error;
michael@0:   var actualoutput = root;
michael@0:   if (isTreeBuilder) {
michael@0:     // convert the tree's view data into the equivalent DOM structure
michael@0:     // for easier comparison
michael@0:     actualoutput = treeViewToDOM(root);
michael@0:     var treechildrenElements = [e for (e of output.children) if (e.localName === "treechildren")];
michael@0:     error = compareOutput(actualoutput, treechildrenElements[0], false);
michael@0:   }
michael@0:   else {
michael@0:     error = compareOutput(actualoutput, output, true);
michael@0:   }
michael@0: 
michael@0:   var adjtestid = testid;
michael@0:   if (step > 0)
michael@0:     adjtestid += " dynamic step " + step;
michael@0: 
michael@0:   var stilltodo = ((step == 0 && notWorkingYet) || (step > 0 && notWorkingYetDynamic));
michael@0:   if (stilltodo)
michael@0:     todo(false, adjtestid);
michael@0:   else
michael@0:     ok(!error, adjtestid);
michael@0: 
michael@0:   if ((!stilltodo && error) || debug) {
michael@0:     // for debugging, serialize the XML output
michael@0:     var serializedXML = "";
michael@0:     var rootNodes = actualoutput.childNodes;
michael@0:     for (var n = 0; n < rootNodes.length; n++) {
michael@0:       var node = rootNodes[n];
michael@0:       if (node.localName != "template")
michael@0:         serializedXML += ((new XMLSerializer()).serializeToString(node));
michael@0:     }
michael@0: 
michael@0:     // remove the XUL namespace declarations to make the output more readable
michael@0:     const nsrepl = new RegExp("xmlns=\"" + XUL_NS + "\" ", "g");
michael@0:     serializedXML = serializedXML.replace(nsrepl, "");
michael@0:     if (debug)
michael@0:       dump("-------- " + adjtestid + "  " + error + ":\n" + serializedXML + "\n");
michael@0:     if (!stilltodo && error)
michael@0:       is(serializedXML, "Same", "Error is: " + error);
michael@0:   }
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Adjust the expected output to acccount for any step attributes.
michael@0:  */
michael@0: function setForCurrentStep(content, currentStep)
michael@0: {
michael@0:   var todelete = [];
michael@0:   for (var child of content.childNodes) {
michael@0:     if (child.nodeType === Node.ELEMENT_NODE) {
michael@0:       var stepstr = child.getAttribute("step") || "";
michael@0:       var stepsarr = stepstr.split(",");
michael@0:       for (var s = 0; s < stepsarr.length; s++) {
michael@0:         var step = parseInt(stepsarr[s]);
michael@0:         if ((step > 0 && step > currentStep) ||
michael@0:             (step < 0 && -step <= currentStep)) {
michael@0:           todelete.push(child);
michael@0:         }
michael@0:       }
michael@0:     } else if (child.nodeType === Node.TEXT_NODE) {
michael@0:       // Drop empty text nodes.
michael@0:       if (child.nodeValue.trim() === "")
michael@0:         todelete.push(child);
michael@0:     }
michael@0:   }
michael@0: 
michael@0:   for (var e of todelete)
michael@0:     content.removeChild(e);
michael@0: 
michael@0:   for (var child of content.children) {
michael@0:     child.removeAttribute("step");
michael@0:     setForCurrentStep(child, currentStep);
michael@0:   }
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Compares the 'actual' DOM output with the 'expected' output. This function
michael@0:  * is called recursively, with isroot true if actual refers to the root of the
michael@0:  * template. Returns a null string if they are equal and an error string if
michael@0:  * they are not equal. This function is called recursively as it iterates
michael@0:  * through each node in the DOM tree.
michael@0:  */
michael@0: function compareOutput(actual, expected, isroot)
michael@0: {
michael@0:   if (isroot && expected.localName != "data")
michael@0:     return "expected must be a <data> element";
michael@0: 
michael@0:   var t;
michael@0: 
michael@0:   // compare text nodes
michael@0:   if (expected.nodeType == Node.TEXT_NODE) {
michael@0:     if (actual.nodeValue !== expected.nodeValue.trim())
michael@0:       return "Text " + actual.nodeValue + " doesn't match " + expected.nodeValue;
michael@0:     return "";
michael@0:   }
michael@0: 
michael@0:   if (!isroot) {
michael@0:     var anyid = false;
michael@0:     // make sure that the tags match
michael@0:     if (actual.localName != expected.localName)
michael@0:       return "Tag name " + expected.localName + " not found";
michael@0: 
michael@0:     // loop through the attributes in the expected node and compare their
michael@0:     // values with the corresponding attribute on the actual node
michael@0: 
michael@0:     var expectedAttrs = expected.attributes;
michael@0:     for (var a = 0; a < expectedAttrs.length; a++) {
michael@0:       var attr = expectedAttrs[a];
michael@0:       var expectval = attr.value;
michael@0:       // skip checking the id when anyid="true", however make sure to
michael@0:       // ensure that the id is actually present.
michael@0:       if (attr.name == "anyid" && expectval == "true") {
michael@0:         anyid = true;
michael@0:         if (!actual.hasAttribute("id"))
michael@0:           return "expected id attribute";
michael@0:       }
michael@0:       else if (actual.getAttribute(attr.name) != expectval) {
michael@0:         return "attribute " + attr.name + " is '" +
michael@0:                actual.getAttribute(attr.name) + "' instead of '" + expectval + "'";
michael@0:       }
michael@0:     }
michael@0: 
michael@0:     // now loop through the actual attributes and make sure that there aren't
michael@0:     // any extra attributes that weren't expected
michael@0:     var length = actual.attributes.length;
michael@0:     for (t = 0; t < length; t++) {
michael@0:       var aattr = actual.attributes[t];
michael@0:       var expectval = expected.getAttribute(aattr.name);
michael@0:       // ignore some attributes that don't matter
michael@0:       if (expectval != actual.getAttribute(aattr.name) &&
michael@0:           aattr.name != "staticHint" && aattr.name != "xmlns" &&
michael@0:           (aattr.name != "id" || !anyid))
michael@0:         return "extra attribute " + aattr.name;
michael@0:     }
michael@0:   }
michael@0: 
michael@0:   // ensure that the node has the right number of children. Subtract one for
michael@0:   // the root node to account for the <template> node.
michael@0:   length = actual.childNodes.length - (isroot ? 1 : 0);
michael@0:   if (length != expected.childNodes.length)
michael@0:     return "incorrect child node count of " + actual.localName + " " + length +
michael@0:            " expected " + expected.childNodes.length;
michael@0: 
michael@0:   // if <data unordered="true"> is used, then the child nodes may be in any order
michael@0:   var unordered = (expected.localName == "data" && expected.getAttribute("unordered") == "true");
michael@0: 
michael@0:   // next, loop over the children and call compareOutput recursively on each one
michael@0:   var adj = 0;
michael@0:   for (t = 0; t < actual.childNodes.length; t++) {
michael@0:     var actualnode = actual.childNodes[t];
michael@0:     // skip the <template> element, and add one to the indices when looking
michael@0:     // at the later nodes to account for it
michael@0:     if (isroot && actualnode.localName == "template") {
michael@0:       adj++;
michael@0:     }
michael@0:     else {
michael@0:       var output = "unexpected";
michael@0:       if (unordered) {
michael@0:         var expectedChildren = expected.childNodes;
michael@0:         for (var e = 0; e < expectedChildren.length; e++) {
michael@0:           output = compareOutput(actualnode, expectedChildren[e], false);
michael@0:           if (!output)
michael@0:             break;
michael@0:         }
michael@0:       }
michael@0:       else {
michael@0:         output = compareOutput(actualnode, expected.childNodes[t - adj], false);
michael@0:       }
michael@0: 
michael@0:       // an error was returned, so return early
michael@0:       if (output)
michael@0:         return output;
michael@0:     }
michael@0:   }
michael@0: 
michael@0:   return "";
michael@0: }
michael@0: 
michael@0: /*
michael@0:  * copy the datasource into an in-memory datasource so that it can be modified
michael@0:  */
michael@0: function copyRDFDataSource(root, sourceds)
michael@0: {
michael@0:   var dsourcesArr = [];
michael@0:   var composite = root.database;
michael@0:   var dsources = composite.GetDataSources();
michael@0:   while (dsources.hasMoreElements()) {
michael@0:     sourceds = dsources.getNext().QueryInterface(Components.interfaces.nsIRDFDataSource);
michael@0:     dsourcesArr.push(sourceds);
michael@0:   }
michael@0: 
michael@0:   for (var d = 0; d < dsourcesArr.length; d++)
michael@0:     composite.RemoveDataSource(dsourcesArr[d]);
michael@0: 
michael@0:   var newds = Components.classes["@mozilla.org/rdf/datasource;1?name=in-memory-datasource"].
michael@0:                 createInstance(Components.interfaces.nsIRDFDataSource);
michael@0: 
michael@0:   var sourcelist = sourceds.GetAllResources();
michael@0:   while (sourcelist.hasMoreElements()) {
michael@0:     var source = sourcelist.getNext();
michael@0:     var props = sourceds.ArcLabelsOut(source);
michael@0:     while (props.hasMoreElements()) {
michael@0:       var prop = props.getNext();
michael@0:       if (prop instanceof Components.interfaces.nsIRDFResource) {
michael@0:         var targets = sourceds.GetTargets(source, prop, true);
michael@0:         while (targets.hasMoreElements())
michael@0:           newds.Assert(source, prop, targets.getNext(), true);
michael@0:       }
michael@0:     }
michael@0:   }
michael@0: 
michael@0:   composite.AddDataSource(newds);
michael@0:   root.builder.rebuild();
michael@0: 
michael@0:   return newds;
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Converts a tree view (nsITreeView) into the equivalent DOM tree.
michael@0:  * Returns the treechildren
michael@0:  */
michael@0: function treeViewToDOM(tree)
michael@0: {
michael@0:   var treechildren = document.createElement("treechildren");
michael@0: 
michael@0:   if (tree.view)
michael@0:     treeViewToDOMInner(tree.columns, treechildren, tree.view, tree.builder, 0, 0);
michael@0: 
michael@0:   return treechildren;
michael@0: }
michael@0: 
michael@0: function treeViewToDOMInner(columns, treechildren, view, builder, start, level)
michael@0: {
michael@0:   var end = view.rowCount;
michael@0: 
michael@0:   for (var i = start; i < end; i++) {
michael@0:     if (view.getLevel(i) < level)
michael@0:       return i - 1;
michael@0: 
michael@0:     var id = builder ? builder.getResourceAtIndex(i).Value : "id" + i;
michael@0:     var item = document.createElement("treeitem");
michael@0:     item.setAttribute("id", id);
michael@0:     treechildren.appendChild(item);
michael@0: 
michael@0:     var row = document.createElement("treerow");
michael@0:     item.appendChild(row);
michael@0: 
michael@0:     for (var c = 0; c < columns.length; c++) {
michael@0:       var cell = document.createElement("treecell");
michael@0:       var label = view.getCellText(i, columns[c]);
michael@0:       if (label)
michael@0:         cell.setAttribute("label", label);
michael@0:       row.appendChild(cell);
michael@0:     }
michael@0: 
michael@0:     if (view.isContainer(i)) {
michael@0:       item.setAttribute("container", "true");
michael@0:       item.setAttribute("empty", view.isContainerEmpty(i) ? "true" : "false");
michael@0: 
michael@0:       if (!view.isContainerEmpty(i) && view.isContainerOpen(i)) {
michael@0:         item.setAttribute("open", "true");
michael@0: 
michael@0:         var innertreechildren = document.createElement("treechildren");
michael@0:         item.appendChild(innertreechildren);
michael@0: 
michael@0:         i = treeViewToDOMInner(columns, innertreechildren, view, builder, i + 1, level + 1);
michael@0:       }
michael@0:     }
michael@0:   }
michael@0: 
michael@0:   return i;
michael@0: }
michael@0: 
michael@0: function expectConsoleMessage(ref, id, isNew, isActive, extra)
michael@0: {
michael@0:   var message = "In template with id root" +
michael@0:                 (ref ? " using ref " + ref : "") + "\n    " +
michael@0:                 (isNew ? "New " : "Removed ") + (isActive ? "active" : "inactive") +
michael@0:                 " result for query " + extra + ": " + id;
michael@0:   expectedConsoleMessages.push(message);
michael@0: }
michael@0: 
michael@0: function compareConsoleMessages()
michael@0: {
michael@0:   var consoleService = Components.classes["@mozilla.org/consoleservice;1"].
michael@0:                          getService(Components.interfaces.nsIConsoleService);
michael@0:   var messages = consoleService.getMessageArray() || [];
michael@0:   messages = messages.map(function (m) m.message);
michael@0:   // Copy to avoid modifying expectedConsoleMessages
michael@0:   var expect = expectedConsoleMessages.concat();
michael@0:   for (var m = 0; m < messages.length; m++) {
michael@0:     if (messages[m] == expect[0]) {
michael@0:       ok(true, "found message " + expect.shift());
michael@0:     }
michael@0:   }
michael@0:   if (expect.length != 0) {
michael@0:     ok(false, "failed to find expected console messages: " + expect);
michael@0:   }
michael@0: }
michael@0: 
michael@0: function copyToProfile(filename)
michael@0: {
michael@0:   if (Cc === undefined) {
michael@0:     var Cc = Components.classes;
michael@0:     var Ci = Components.interfaces;
michael@0:   }
michael@0: 
michael@0:   var loader = Cc["@mozilla.org/moz/jssubscript-loader;1"]
michael@0:                          .getService(Ci.mozIJSSubScriptLoader);
michael@0:   loader.loadSubScript("chrome://mochikit/content/chrome-harness.js");
michael@0: 
michael@0:   var file = Cc["@mozilla.org/file/directory_service;1"]
michael@0:                        .getService(Ci.nsIProperties)
michael@0:                        .get("ProfD", Ci.nsIFile);
michael@0:   file.append(filename);
michael@0: 
michael@0:   var parentURI = getResolvedURI(getRootDirectory(window.location.href));
michael@0:   if (parentURI.JARFile) {
michael@0:     parentURI = extractJarToTmp(parentURI);
michael@0:   } else {
michael@0:     var fileHandler = Cc["@mozilla.org/network/protocol;1?name=file"].
michael@0:                       getService(Ci.nsIFileProtocolHandler);
michael@0:     parentURI = fileHandler.getFileFromURLSpec(parentURI.spec);
michael@0:   }
michael@0: 
michael@0:   parentURI = parentURI.QueryInterface(Ci.nsILocalFile);
michael@0:   parentURI.append(filename);
michael@0:   try {
michael@0:     var retVal = parentURI.copyToFollowingLinks(file.parent, filename);
michael@0:   } catch (ex) {
michael@0:     //ignore this error as the file could exist already
michael@0:   }
michael@0: }