1 files changed, 219 insertions, 0 deletions
diff --git a/services/sync/tests/unit/test_engine.js b/services/sync/tests/unit/test_engine.js
new file mode 100644
index 000000000..be637efc8
--- /dev/null
+++ b/services/sync/tests/unit/test_engine.js
@@ -0,0 +1,219 @@
+/* Any copyright is dedicated to the Public Domain.
+   http://creativecommons.org/publicdomain/zero/1.0/ */
+
+Cu.import("resource://services-common/observers.js");
+Cu.import("resource://services-sync/engines.js");
+Cu.import("resource://services-sync/service.js");
+Cu.import("resource://services-sync/util.js");
+
+function SteamStore(engine) {
+  Store.call(this, "Steam", engine);
+  this.wasWiped = false;
+}
+SteamStore.prototype = {
+  __proto__: Store.prototype,
+
+  wipe: function() {
+    this.wasWiped = true;
+  }
+};
+
+function SteamTracker(name, engine) {
+  Tracker.call(this, name || "Steam", engine);
+}
+SteamTracker.prototype = {
+  __proto__: Tracker.prototype
+};
+
+function SteamEngine(name, service) {
+  Engine.call(this, name, service);
+  this.wasReset = false;
+  this.wasSynced = false;
+}
+SteamEngine.prototype = {
+  __proto__: Engine.prototype,
+  _storeObj: SteamStore,
+  _trackerObj: SteamTracker,
+
+  _resetClient: function () {
+    this.wasReset = true;
+  },
+
+  _sync: function () {
+    this.wasSynced = true;
+  }
+};
+
+var engineObserver = {
+  topics: [],
+
+  observe: function(subject, topic, data) {
+    do_check_eq(data, "steam");
+    this.topics.push(topic);
+  },
+
+  reset: function() {
+    this.topics = [];
+  }
+};
+Observers.add("weave:engine:reset-client:start", engineObserver);
+Observers.add("weave:engine:reset-client:finish", engineObserver);
+Observers.add("weave:engine:wipe-client:start", engineObserver);
+Observers.add("weave:engine:wipe-client:finish", engineObserver);
+Observers.add("weave:engine:sync:start", engineObserver);
+Observers.add("weave:engine:sync:finish", engineObserver);
+
+function run_test() {
+  run_next_test();
+}
+
+add_test(function test_members() {
+  _("Engine object members");
+  let engine = new SteamEngine("Steam", Service);
+  do_check_eq(engine.Name, "Steam");
+  do_check_eq(engine.prefName, "steam");
+  do_check_true(engine._store instanceof SteamStore);
+  do_check_true(engine._tracker instanceof SteamTracker);
+  run_next_test();
+});
+
+add_test(function test_score() {
+  _("Engine.score corresponds to tracker.score and is readonly");
+  let engine = new SteamEngine("Steam", Service);
+  do_check_eq(engine.score, 0);
+  engine._tracker.score += 5;
+  do_check_eq(engine.score, 5);
+
+  try {
+    engine.score = 10;
+  } catch(ex) {
+    // Setting an attribute that has a getter produces an error in
+    // Firefox <= 3.6 and is ignored in later versions.  Either way,
+    // the attribute's value won't change.
+  }
+  do_check_eq(engine.score, 5);
+  run_next_test();
+});
+
+add_test(function test_resetClient() {
+  _("Engine.resetClient calls _resetClient");
+  let engine = new SteamEngine("Steam", Service);
+  do_check_false(engine.wasReset);
+
+  engine.resetClient();
+  do_check_true(engine.wasReset);
+  do_check_eq(engineObserver.topics[0], "weave:engine:reset-client:start");
+  do_check_eq(engineObserver.topics[1], "weave:engine:reset-client:finish");
+
+  engine.wasReset = false;
+  engineObserver.reset();
+  run_next_test();
+});
+
+add_test(function test_invalidChangedIDs() {
+  _("Test that invalid changed IDs on disk don't end up live.");
+  let engine = new SteamEngine("Steam", Service);
+  let tracker = engine._tracker;
+  tracker.changedIDs = 5;
+  tracker.saveChangedIDs(function onSaved() {
+      tracker.changedIDs = {placeholder: true};
+      tracker.loadChangedIDs(function onLoaded(json) {
+        do_check_null(json);
+        do_check_true(tracker.changedIDs.placeholder);
+        run_next_test();
+      });
+    });
+});
+
+add_test(function test_wipeClient() {
+  _("Engine.wipeClient calls resetClient, wipes store, clears changed IDs");
+  let engine = new SteamEngine("Steam", Service);
+  do_check_false(engine.wasReset);
+  do_check_false(engine._store.wasWiped);
+  do_check_true(engine._tracker.addChangedID("a-changed-id"));
+  do_check_true("a-changed-id" in engine._tracker.changedIDs);
+
+  engine.wipeClient();
+  do_check_true(engine.wasReset);
+  do_check_true(engine._store.wasWiped);
+  do_check_eq(JSON.stringify(engine._tracker.changedIDs), "{}");
+  do_check_eq(engineObserver.topics[0], "weave:engine:wipe-client:start");
+  do_check_eq(engineObserver.topics[1], "weave:engine:reset-client:start");
+  do_check_eq(engineObserver.topics[2], "weave:engine:reset-client:finish");
+  do_check_eq(engineObserver.topics[3], "weave:engine:wipe-client:finish");
+
+  engine.wasReset = false;
+  engine._store.wasWiped = false;
+  engineObserver.reset();
+  run_next_test();
+});
+
+add_test(function test_enabled() {
+  _("Engine.enabled corresponds to preference");
+  let engine = new SteamEngine("Steam", Service);
+  try {
+    do_check_false(engine.enabled);
+    Svc.Prefs.set("engine.steam", true);
+    do_check_true(engine.enabled);
+
+    engine.enabled = false;
+    do_check_false(Svc.Prefs.get("engine.steam"));
+    run_next_test();
+  } finally {
+    Svc.Prefs.resetBranch("");
+  }
+});
+
+add_test(function test_sync() {
+  let engine = new SteamEngine("Steam", Service);
+  try {
+    _("Engine.sync doesn't call _sync if it's not enabled");
+    do_check_false(engine.enabled);
+    do_check_false(engine.wasSynced);
+    engine.sync();
+
+    do_check_false(engine.wasSynced);
+
+    _("Engine.sync calls _sync if it's enabled");
+    engine.enabled = true;
+
+    engine.sync();
+    do_check_true(engine.wasSynced);
+    do_check_eq(engineObserver.topics[0], "weave:engine:sync:start");
+    do_check_eq(engineObserver.topics[1], "weave:engine:sync:finish");
+    run_next_test();
+  } finally {
+    Svc.Prefs.resetBranch("");
+    engine.wasSynced = false;
+    engineObserver.reset();
+  }
+});
+
+add_test(function test_disabled_no_track() {
+  _("When an engine is disabled, its tracker is not tracking.");
+  let engine = new SteamEngine("Steam", Service);
+  let tracker = engine._tracker;
+  do_check_eq(engine, tracker.engine);
+
+  do_check_false(engine.enabled);
+  do_check_false(tracker._isTracking);
+  do_check_empty(tracker.changedIDs);
+
+  do_check_false(tracker.engineIsEnabled());
+  tracker.observe(null, "weave:engine:start-tracking", null);
+  do_check_false(tracker._isTracking);
+  do_check_empty(tracker.changedIDs);
+
+  engine.enabled = true;
+  tracker.observe(null, "weave:engine:start-tracking", null);
+  do_check_true(tracker._isTracking);
+  do_check_empty(tracker.changedIDs);
+
+  tracker.addChangedID("abcdefghijkl");
+  do_check_true(0 < tracker.changedIDs["abcdefghijkl"]);
+  Svc.Prefs.set("engine." + engine.prefName, false);
+  do_check_false(tracker._isTracking);
+  do_check_empty(tracker.changedIDs);
+
+  run_next_test();
+});