1 files changed, 442 insertions, 0 deletions
diff --git a/services/sync/tests/unit/test_service_sync_updateEnabledEngines.js b/services/sync/tests/unit/test_service_sync_updateEnabledEngines.js
new file mode 100644
index 000000000..ee1800fd3
--- /dev/null
+++ b/services/sync/tests/unit/test_service_sync_updateEnabledEngines.js
@@ -0,0 +1,442 @@
+/* Any copyright is dedicated to the Public Domain.
+   http://creativecommons.org/publicdomain/zero/1.0/ */
+
+Cu.import("resource://services-sync/constants.js");
+Cu.import("resource://services-sync/engines.js");
+Cu.import("resource://services-sync/engines/clients.js");
+Cu.import("resource://services-sync/record.js");
+Cu.import("resource://services-sync/service.js");
+Cu.import("resource://services-sync/util.js");
+Cu.import("resource://testing-common/services/sync/utils.js");
+
+initTestLogging();
+Service.engineManager.clear();
+
+function QuietStore() {
+  Store.call("Quiet");
+}
+QuietStore.prototype = {
+  getAllIDs: function getAllIDs() {
+    return [];
+  }
+}
+
+function SteamEngine() {
+  SyncEngine.call(this, "Steam", Service);
+}
+SteamEngine.prototype = {
+  __proto__: SyncEngine.prototype,
+  // We're not interested in engine sync but what the service does.
+  _storeObj: QuietStore,
+
+  _sync: function _sync() {
+    this._syncStartup();
+  }
+};
+Service.engineManager.register(SteamEngine);
+
+function StirlingEngine() {
+  SyncEngine.call(this, "Stirling", Service);
+}
+StirlingEngine.prototype = {
+  __proto__: SteamEngine.prototype,
+  // This engine's enabled state is the same as the SteamEngine's.
+  get prefName() {
+    return "steam";
+  }
+};
+Service.engineManager.register(StirlingEngine);
+
+// Tracking info/collections.
+var collectionsHelper = track_collections_helper();
+var upd = collectionsHelper.with_updated_collection;
+
+function sync_httpd_setup(handlers) {
+
+  handlers["/1.1/johndoe/info/collections"] = collectionsHelper.handler;
+  delete collectionsHelper.collections.crypto;
+  delete collectionsHelper.collections.meta;
+
+  let cr = new ServerWBO("keys");
+  handlers["/1.1/johndoe/storage/crypto/keys"] =
+    upd("crypto", cr.handler());
+
+  let cl = new ServerCollection();
+  handlers["/1.1/johndoe/storage/clients"] =
+    upd("clients", cl.handler());
+
+  return httpd_setup(handlers);
+}
+
+function setUp(server) {
+  new SyncTestingInfrastructure(server, "johndoe", "ilovejane",
+                                "abcdeabcdeabcdeabcdeabcdea");
+  // Ensure that the server has valid keys so that logging in will work and not
+  // result in a server wipe, rendering many of these tests useless.
+  generateNewKeys(Service.collectionKeys);
+  let serverKeys = Service.collectionKeys.asWBO("crypto", "keys");
+  serverKeys.encrypt(Service.identity.syncKeyBundle);
+  return serverKeys.upload(Service.resource(Service.cryptoKeysURL)).success;
+}
+
+const PAYLOAD = 42;
+
+
+function run_test() {
+  initTestLogging("Trace");
+  Log.repository.getLogger("Sync.Service").level = Log.Level.Trace;
+  Log.repository.getLogger("Sync.ErrorHandler").level = Log.Level.Trace;
+  validate_all_future_pings();
+
+  run_next_test();
+}
+
+add_test(function test_newAccount() {
+  _("Test: New account does not disable locally enabled engines.");
+  let engine = Service.engineManager.get("steam");
+  let server = sync_httpd_setup({
+    "/1.1/johndoe/storage/meta/global": new ServerWBO("global", {}).handler(),
+    "/1.1/johndoe/storage/steam": new ServerWBO("steam", {}).handler()
+  });
+  setUp(server);
+
+  try {
+    _("Engine is enabled from the beginning.");
+    Service._ignorePrefObserver = true;
+    engine.enabled = true;
+    Service._ignorePrefObserver = false;
+
+    _("Sync.");
+    Service.sync();
+
+    _("Engine continues to be enabled.");
+    do_check_true(engine.enabled);
+  } finally {
+    Service.startOver();
+    server.stop(run_next_test);
+  }
+});
+
+add_test(function test_enabledLocally() {
+  _("Test: Engine is disabled on remote clients and enabled locally");
+  Service.syncID = "abcdefghij";
+  let engine = Service.engineManager.get("steam");
+  let metaWBO = new ServerWBO("global", {syncID: Service.syncID,
+                                         storageVersion: STORAGE_VERSION,
+                                         engines: {}});
+  let server = sync_httpd_setup({
+    "/1.1/johndoe/storage/meta/global": metaWBO.handler(),
+    "/1.1/johndoe/storage/steam": new ServerWBO("steam", {}).handler()
+  });
+  setUp(server);
+
+  try {
+    _("Enable engine locally.");
+    engine.enabled = true;
+
+    _("Sync.");
+    Service.sync();
+
+    _("Meta record now contains the new engine.");
+    do_check_true(!!metaWBO.data.engines.steam);
+
+    _("Engine continues to be enabled.");
+    do_check_true(engine.enabled);
+  } finally {
+    Service.startOver();
+    server.stop(run_next_test);
+  }
+});
+
+add_test(function test_disabledLocally() {
+  _("Test: Engine is enabled on remote clients and disabled locally");
+  Service.syncID = "abcdefghij";
+  let engine = Service.engineManager.get("steam");
+  let metaWBO = new ServerWBO("global", {
+    syncID: Service.syncID,
+    storageVersion: STORAGE_VERSION,
+    engines: {steam: {syncID: engine.syncID,
+                      version: engine.version}}
+  });
+  let steamCollection = new ServerWBO("steam", PAYLOAD);
+
+  let server = sync_httpd_setup({
+    "/1.1/johndoe/storage/meta/global": metaWBO.handler(),
+    "/1.1/johndoe/storage/steam": steamCollection.handler()
+  });
+  setUp(server);
+
+  try {
+    _("Disable engine locally.");
+    Service._ignorePrefObserver = true;
+    engine.enabled = true;
+    Service._ignorePrefObserver = false;
+    engine.enabled = false;
+
+    _("Sync.");
+    Service.sync();
+
+    _("Meta record no longer contains engine.");
+    do_check_false(!!metaWBO.data.engines.steam);
+
+    _("Server records are wiped.");
+    do_check_eq(steamCollection.payload, undefined);
+
+    _("Engine continues to be disabled.");
+    do_check_false(engine.enabled);
+  } finally {
+    Service.startOver();
+    server.stop(run_next_test);
+  }
+});
+
+add_test(function test_disabledLocally_wipe503() {
+  _("Test: Engine is enabled on remote clients and disabled locally");
+  Service.syncID = "abcdefghij";
+  let engine = Service.engineManager.get("steam");
+  let metaWBO = new ServerWBO("global", {
+    syncID: Service.syncID,
+    storageVersion: STORAGE_VERSION,
+    engines: {steam: {syncID: engine.syncID,
+                      version: engine.version}}
+  });
+  let steamCollection = new ServerWBO("steam", PAYLOAD);
+
+  function service_unavailable(request, response) {
+    let body = "Service Unavailable";
+    response.setStatusLine(request.httpVersion, 503, "Service Unavailable");
+    response.setHeader("Retry-After", "23");
+    response.bodyOutputStream.write(body, body.length);
+  }
+
+  let server = sync_httpd_setup({
+    "/1.1/johndoe/storage/meta/global": metaWBO.handler(),
+    "/1.1/johndoe/storage/steam": service_unavailable
+  });
+  setUp(server);
+
+  _("Disable engine locally.");
+  Service._ignorePrefObserver = true;
+  engine.enabled = true;
+  Service._ignorePrefObserver = false;
+  engine.enabled = false;
+
+  Svc.Obs.add("weave:ui:sync:error", function onSyncError() {
+    Svc.Obs.remove("weave:ui:sync:error", onSyncError);
+
+    do_check_eq(Service.status.sync, SERVER_MAINTENANCE);
+
+    Service.startOver();
+    server.stop(run_next_test);
+  });
+
+  _("Sync.");
+  Service.errorHandler.syncAndReportErrors();
+});
+
+add_test(function test_enabledRemotely() {
+  _("Test: Engine is disabled locally and enabled on a remote client");
+  Service.syncID = "abcdefghij";
+  let engine = Service.engineManager.get("steam");
+  let metaWBO = new ServerWBO("global", {
+    syncID: Service.syncID,
+    storageVersion: STORAGE_VERSION,
+    engines: {steam: {syncID: engine.syncID,
+                      version: engine.version}}
+  });
+  let server = sync_httpd_setup({
+    "/1.1/johndoe/storage/meta/global":
+    upd("meta", metaWBO.handler()),
+
+    "/1.1/johndoe/storage/steam":
+    upd("steam", new ServerWBO("steam", {}).handler())
+  });
+  setUp(server);
+
+  // We need to be very careful how we do this, so that we don't trigger a
+  // fresh start!
+  try {
+    _("Upload some keys to avoid a fresh start.");
+    let wbo = Service.collectionKeys.generateNewKeysWBO();
+    wbo.encrypt(Service.identity.syncKeyBundle);
+    do_check_eq(200, wbo.upload(Service.resource(Service.cryptoKeysURL)).status);
+
+    _("Engine is disabled.");
+    do_check_false(engine.enabled);
+
+    _("Sync.");
+    Service.sync();
+
+    _("Engine is enabled.");
+    do_check_true(engine.enabled);
+
+    _("Meta record still present.");
+    do_check_eq(metaWBO.data.engines.steam.syncID, engine.syncID);
+  } finally {
+    Service.startOver();
+    server.stop(run_next_test);
+  }
+});
+
+add_test(function test_disabledRemotelyTwoClients() {
+  _("Test: Engine is enabled locally and disabled on a remote client... with two clients.");
+  Service.syncID = "abcdefghij";
+  let engine = Service.engineManager.get("steam");
+  let metaWBO = new ServerWBO("global", {syncID: Service.syncID,
+                                         storageVersion: STORAGE_VERSION,
+                                         engines: {}});
+  let server = sync_httpd_setup({
+    "/1.1/johndoe/storage/meta/global":
+    upd("meta", metaWBO.handler()),
+
+    "/1.1/johndoe/storage/steam":
+    upd("steam", new ServerWBO("steam", {}).handler())
+  });
+  setUp(server);
+
+  try {
+    _("Enable engine locally.");
+    Service._ignorePrefObserver = true;
+    engine.enabled = true;
+    Service._ignorePrefObserver = false;
+
+    _("Sync.");
+    Service.sync();
+
+    _("Disable engine by deleting from meta/global.");
+    let d = metaWBO.data;
+    delete d.engines["steam"];
+    metaWBO.payload = JSON.stringify(d);
+    metaWBO.modified = Date.now() / 1000;
+
+    _("Add a second client and verify that the local pref is changed.");
+    Service.clientsEngine._store._remoteClients["foobar"] = {name: "foobar", type: "desktop"};
+    Service.sync();
+
+    _("Engine is disabled.");
+    do_check_false(engine.enabled);
+
+  } finally {
+    Service.startOver();
+    server.stop(run_next_test);
+  }
+});
+
+add_test(function test_disabledRemotely() {
+  _("Test: Engine is enabled locally and disabled on a remote client");
+  Service.syncID = "abcdefghij";
+  let engine = Service.engineManager.get("steam");
+  let metaWBO = new ServerWBO("global", {syncID: Service.syncID,
+                                         storageVersion: STORAGE_VERSION,
+                                         engines: {}});
+  let server = sync_httpd_setup({
+    "/1.1/johndoe/storage/meta/global": metaWBO.handler(),
+    "/1.1/johndoe/storage/steam": new ServerWBO("steam", {}).handler()
+  });
+  setUp(server);
+
+  try {
+    _("Enable engine locally.");
+    Service._ignorePrefObserver = true;
+    engine.enabled = true;
+    Service._ignorePrefObserver = false;
+
+    _("Sync.");
+    Service.sync();
+
+    _("Engine is not disabled: only one client.");
+    do_check_true(engine.enabled);
+
+  } finally {
+    Service.startOver();
+    server.stop(run_next_test);
+  }
+});
+
+add_test(function test_dependentEnginesEnabledLocally() {
+  _("Test: Engine is disabled on remote clients and enabled locally");
+  Service.syncID = "abcdefghij";
+  let steamEngine = Service.engineManager.get("steam");
+  let stirlingEngine = Service.engineManager.get("stirling");
+  let metaWBO = new ServerWBO("global", {syncID: Service.syncID,
+                                         storageVersion: STORAGE_VERSION,
+                                         engines: {}});
+  let server = sync_httpd_setup({
+    "/1.1/johndoe/storage/meta/global": metaWBO.handler(),
+    "/1.1/johndoe/storage/steam": new ServerWBO("steam", {}).handler(),
+    "/1.1/johndoe/storage/stirling": new ServerWBO("stirling", {}).handler()
+  });
+  setUp(server);
+
+  try {
+    _("Enable engine locally. Doing it on one is enough.");
+    steamEngine.enabled = true;
+
+    _("Sync.");
+    Service.sync();
+
+    _("Meta record now contains the new engines.");
+    do_check_true(!!metaWBO.data.engines.steam);
+    do_check_true(!!metaWBO.data.engines.stirling);
+
+    _("Engines continue to be enabled.");
+    do_check_true(steamEngine.enabled);
+    do_check_true(stirlingEngine.enabled);
+  } finally {
+    Service.startOver();
+    server.stop(run_next_test);
+  }
+});
+
+add_test(function test_dependentEnginesDisabledLocally() {
+  _("Test: Two dependent engines are enabled on remote clients and disabled locally");
+  Service.syncID = "abcdefghij";
+  let steamEngine = Service.engineManager.get("steam");
+  let stirlingEngine = Service.engineManager.get("stirling");
+  let metaWBO = new ServerWBO("global", {
+    syncID: Service.syncID,
+    storageVersion: STORAGE_VERSION,
+    engines: {steam: {syncID: steamEngine.syncID,
+                      version: steamEngine.version},
+              stirling: {syncID: stirlingEngine.syncID,
+                         version: stirlingEngine.version}}
+  });
+
+  let steamCollection = new ServerWBO("steam", PAYLOAD);
+  let stirlingCollection = new ServerWBO("stirling", PAYLOAD);
+
+  let server = sync_httpd_setup({
+    "/1.1/johndoe/storage/meta/global":     metaWBO.handler(),
+    "/1.1/johndoe/storage/steam":           steamCollection.handler(),
+    "/1.1/johndoe/storage/stirling":        stirlingCollection.handler()
+  });
+  setUp(server);
+
+  try {
+    _("Disable engines locally. Doing it on one is enough.");
+    Service._ignorePrefObserver = true;
+    steamEngine.enabled = true;
+    do_check_true(stirlingEngine.enabled);
+    Service._ignorePrefObserver = false;
+    steamEngine.enabled = false;
+    do_check_false(stirlingEngine.enabled);
+
+    _("Sync.");
+    Service.sync();
+
+    _("Meta record no longer contains engines.");
+    do_check_false(!!metaWBO.data.engines.steam);
+    do_check_false(!!metaWBO.data.engines.stirling);
+
+    _("Server records are wiped.");
+    do_check_eq(steamCollection.payload, undefined);
+    do_check_eq(stirlingCollection.payload, undefined);
+
+    _("Engines continue to be disabled.");
+    do_check_false(steamEngine.enabled);
+    do_check_false(stirlingEngine.enabled);
+  } finally {
+    Service.startOver();
+    server.stop(run_next_test);
+  }
+});