gecko/extensions/metrics/test/unit/test_event_item.js

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the Metrics Service.
 *
 * The Initial Developer of the Original Code is Google Inc.
 * Portions created by the Initial Developer are Copyright (C) 2006
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *  Brian Ryner <bryner@brianryner.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

// Unit test for the MetricsEventItem object

function run_test () {
  for (var i = 0; i < tests.length && tests[i][0]; ++i) {
    if (!tests[i][0].call()) {
      do_throw(tests[i][1]);
    }
  }
}

var tests = [
  [ test_create, "createEventItem failed" ],
  [ test_properties, "properties set/get failed" ],
  [ test_append_count, "appendChild/childCount failed" ],
  [ test_childat, "childAt failed" ],
  [ test_indexof, "indexOf failed" ],
  [ test_insert, "insertChildAt failed" ],
  [ test_remove, "removeChildAt failed" ],
  [ test_replace, "replaceChildAt failed" ],
  [ test_clear, "clearChildren failed" ],
  [ null ]
];

function test_create() {
  var item = createEventItem(EventNS, "test");
  do_check_neq(item, null);

  do_check_eq(item.itemNamespace, EventNS);
  do_check_eq(item.itemName, "test");
  do_check_eq(item.properties, null);
  do_check_eq(item.childCount, 0);
  return true;
}

function test_properties() {
  var item = createEventItem(EventNS, "test");
  var properties = {
    month: "April",
    year: 2006,
    QueryInterface: function(iid) {
      if (iid.equals(Components.interfaces.nsIPropertyBag) ||
          iid.equals(Components.interfaces.nsISupports)) {
        return this;
      }
    }
  };
  item.properties = properties;

  // XPConnect has created a PropertyBag wrapper for us, so we can't
  // actually check equality between properties and item.properties.

  var month = item.properties.getProperty("month");
  do_check_eq(typeof(month), "string");
  do_check_eq(month, "April");

  var year = item.properties.getProperty("year");
  do_check_eq(typeof(year), "number");
  do_check_eq(year, 2006);

  var day = item.properties.getProperty("day");
  do_check_eq(day, undefined);

  return true;
}

function test_append_count() {
  var item = createEventItem(EventNS, "test");
  var children = buildItemChildren(item);
  do_check_eq(item.childCount, children.length);

  // test input validation
  try {
    item.appendChild(null);
    do_throw("appendChild(null) should fail");
  } catch (e) {}

  do_check_eq(item.childCount, children.length);
  return true;
}

function test_childat() {
  var item = createEventItem(EventNS, "test");
  var children = buildItemChildren(item);

  // test all of the valid children with chilAt().
  compareItemChildren(item, children);

  // test input validation
  try {
    item.childAt(-1);
    do_throw("childAt(-1)");
  } catch (e) {}
  try {
    item.childAt(children.length);
    do_throw("childAt(children.length)");
  } catch (e) {}

  return true;
}

function test_indexof() {
  var item = createEventItem(EventNS, "test");
  var children = buildItemChildren(item);
  for (var i = 0; i < children.length; ++i) {
    do_check_eq(item.indexOf(children[i]), i);
  }

  do_check_eq(item.indexOf(createEventItem(EventNS, "nothere")), -1);
  do_check_eq(item.indexOf(null), -1);

  return true;
}

function test_insert() {
  var item = createEventItem(EventNS, "test");
  var children = buildItemChildren(item);
  var i;

  var newChild = createEventItem(EventNS, "newchild");
  item.insertChildAt(newChild, 1);
  children.splice(1, 0, newChild);
  compareItemChildren(item, children);

  // test inserting at the end
  newChild = createEventItem(EventNS, "newchild2");
  item.insertChildAt(newChild, item.childCount);
  children.push(newChild);
  compareItemChildren(item, children);

  // test input validation
  try {
    item.insertChildAt(newChild, -1);
    do_throw("insertChildAt(-1)");
  } catch (e) {}
  compareItemChildren(item, children);

  try {
    item.insertChildAt(newChild, item.childCount + 1);
    do_throw("insertChildAt past end");
  } catch (e) {}
  compareItemChildren(item, children);

  try {
    item.insertChildAt(null, item.childCount);
    do_throw("insertChildAt(null) should fail");
  } catch (e) {}
  compareItemChildren(item, children);

  return true;
}

function test_remove() {
  var item = createEventItem(EventNS, "test");
  var children = buildItemChildren(item);

  item.removeChildAt(3);
  children.splice(3, 1);
  compareItemChildren(item, children);

  // test input validation
  try {
    item.removeChildAt(-1);
    do_throw("removeChildAt(-1)");
  } catch (e) {}
  compareItemChildren(item, children);

  try {
    item.removeChildAt(item.childCount);
    do_throw("removeChildAt past end");
  } catch (e) {}
  compareItemChildren(item, children);

  return true;
}

function test_replace() {
  var item = createEventItem(EventNS, "test");
  var children = buildItemChildren(item);

  var newChild = createEventItem(EventNS, "newchild");
  item.replaceChildAt(newChild, 6);
  children[6] = newChild;
  compareItemChildren(item, children);

  // test input validation
  try {
    item.replaceChildAt(newChild, -1);
    do_throw("replaceChildAt(-1)");
  } catch (e) {}
  compareItemChildren(item, children);

  try {
    item.replaceChildAt(newChild, item.childCount);
    do_throw("replaceChildAt past end");
  } catch (e) {}
  compareItemChildren(item, children);

  return true;
}

function test_clear() {
  var item = createEventItem(EventNS, "test");
  buildItemChildren(item);

  item.clearChildren();
  compareItemChildren(item, []);

  item.clearChildren();
  compareItemChildren(item, []);

  return true;
}