michael@0: /* Any copyright is dedicated to the Public Domain. michael@0: * http://creativecommons.org/publicdomain/zero/1.0/ */ michael@0: michael@0: "use strict"; michael@0: michael@0: Cu.import("resource://testing-common/httpd.js"); michael@0: Cu.import("resource://testing-common/AddonManagerTesting.jsm"); michael@0: michael@0: XPCOMUtils.defineLazyModuleGetter(this, "Experiments", michael@0: "resource:///modules/experiments/Experiments.jsm"); michael@0: michael@0: const FILE_MANIFEST = "experiments.manifest"; michael@0: const MANIFEST_HANDLER = "manifests/handler"; michael@0: michael@0: const SEC_IN_ONE_DAY = 24 * 60 * 60; michael@0: const MS_IN_ONE_DAY = SEC_IN_ONE_DAY * 1000; michael@0: michael@0: let gProfileDir = null; michael@0: let gHttpServer = null; michael@0: let gHttpRoot = null; michael@0: let gDataRoot = null; michael@0: let gReporter = null; michael@0: let gPolicy = null; michael@0: let gManifestObject = null; michael@0: let gManifestHandlerURI = null; michael@0: let gTimerScheduleOffset = -1; michael@0: michael@0: function uninstallExperimentAddons() { michael@0: return Task.spawn(function* () { michael@0: let addons = yield getExperimentAddons(); michael@0: for (let a of addons) { michael@0: yield AddonTestUtils.uninstallAddonByID(a.id); michael@0: } michael@0: }); michael@0: } michael@0: michael@0: function testCleanup(experimentsInstance) { michael@0: return Task.spawn(function* () { michael@0: yield experimentsInstance.uninit(); michael@0: yield removeCacheFile(); michael@0: yield uninstallExperimentAddons(); michael@0: restartManager(); michael@0: }); michael@0: } michael@0: michael@0: function run_test() { michael@0: run_next_test(); michael@0: } michael@0: michael@0: add_task(function* test_setup() { michael@0: loadAddonManager(); michael@0: gProfileDir = do_get_profile(); michael@0: michael@0: gHttpServer = new HttpServer(); michael@0: gHttpServer.start(-1); michael@0: let port = gHttpServer.identity.primaryPort; michael@0: gHttpRoot = "http://localhost:" + port + "/"; michael@0: gDataRoot = gHttpRoot + "data/"; michael@0: gManifestHandlerURI = gHttpRoot + MANIFEST_HANDLER; michael@0: gHttpServer.registerDirectory("/data/", do_get_cwd()); michael@0: gHttpServer.registerPathHandler("/" + MANIFEST_HANDLER, (request, response) => { michael@0: response.setStatusLine(null, 200, "OK"); michael@0: response.write(JSON.stringify(gManifestObject)); michael@0: response.processAsync(); michael@0: response.finish(); michael@0: }); michael@0: do_register_cleanup(() => gHttpServer.stop(() => {})); michael@0: michael@0: disableCertificateChecks(); michael@0: michael@0: Services.prefs.setBoolPref(PREF_EXPERIMENTS_ENABLED, true); michael@0: Services.prefs.setIntPref(PREF_LOGGING_LEVEL, 0); michael@0: Services.prefs.setBoolPref(PREF_LOGGING_DUMP, true); michael@0: Services.prefs.setCharPref(PREF_MANIFEST_URI, gManifestHandlerURI); michael@0: Services.prefs.setIntPref(PREF_FETCHINTERVAL, 0); michael@0: michael@0: gReporter = yield getReporter("json_payload_simple"); michael@0: yield gReporter.collectMeasurements(); michael@0: let payload = yield gReporter.getJSONPayload(true); michael@0: do_register_cleanup(() => gReporter._shutdown()); michael@0: michael@0: gPolicy = new Experiments.Policy(); michael@0: patchPolicy(gPolicy, { michael@0: updatechannel: () => "nightly", michael@0: healthReportPayload: () => Promise.resolve(payload), michael@0: oneshotTimer: (callback, timeout, thisObj, name) => gTimerScheduleOffset = timeout, michael@0: }); michael@0: }); michael@0: michael@0: add_task(function* test_contract() { michael@0: Cc["@mozilla.org/browser/experiments-service;1"].getService(); michael@0: }); michael@0: michael@0: // Test basic starting and stopping of experiments. michael@0: michael@0: add_task(function* test_getExperiments() { michael@0: const OBSERVER_TOPIC = "experiments-changed"; michael@0: let observerFireCount = 0; michael@0: let expectedObserverFireCount = 0; michael@0: let observer = () => ++observerFireCount; michael@0: Services.obs.addObserver(observer, OBSERVER_TOPIC, false); michael@0: michael@0: // Dates the following tests are based on. michael@0: michael@0: let baseDate = new Date(2014, 5, 1, 12); michael@0: let startDate1 = futureDate(baseDate, 50 * MS_IN_ONE_DAY); michael@0: let endDate1 = futureDate(baseDate, 100 * MS_IN_ONE_DAY); michael@0: let startDate2 = futureDate(baseDate, 150 * MS_IN_ONE_DAY); michael@0: let endDate2 = futureDate(baseDate, 200 * MS_IN_ONE_DAY); michael@0: michael@0: // The manifest data we test with. michael@0: michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [ michael@0: { michael@0: id: EXPERIMENT2_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT2_XPI_NAME, michael@0: xpiHash: EXPERIMENT2_XPI_SHA1, michael@0: startTime: dateToSeconds(startDate2), michael@0: endTime: dateToSeconds(endDate2), michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT1_XPI_NAME, michael@0: xpiHash: EXPERIMENT1_XPI_SHA1, michael@0: startTime: dateToSeconds(startDate1), michael@0: endTime: dateToSeconds(endDate1), michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: ], michael@0: }; michael@0: michael@0: // Data to compare the result of Experiments.getExperiments() against. michael@0: michael@0: let experimentListData = [ michael@0: { michael@0: id: EXPERIMENT2_ID, michael@0: name: "Test experiment 2", michael@0: description: "And yet another experiment that experiments experimentally.", michael@0: }, michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: name: EXPERIMENT1_NAME, michael@0: description: "Yet another experiment that experiments experimentally.", michael@0: }, michael@0: ]; michael@0: michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: // Trigger update, clock set to before any activation. michael@0: // Use updateManifest() to provide for coverage of that path. michael@0: michael@0: let now = baseDate; michael@0: gTimerScheduleOffset = -1; michael@0: defineNow(gPolicy, now); michael@0: michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: Assert.equal(experiments.getActiveExperimentID(), null, michael@0: "getActiveExperimentID should return null"); michael@0: michael@0: let list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 0, "Experiment list should be empty."); michael@0: let addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 0, "Precondition: No experiment add-ons are installed."); michael@0: michael@0: try { michael@0: let b = yield experiments.getExperimentBranch(); michael@0: Assert.ok(false, "getExperimentBranch should fail with no experiment"); michael@0: } michael@0: catch (e) { michael@0: Assert.ok(true, "getExperimentBranch correctly threw"); michael@0: } michael@0: michael@0: // Trigger update, clock set for experiment 1 to start. michael@0: michael@0: now = futureDate(startDate1, 5 * MS_IN_ONE_DAY); michael@0: gTimerScheduleOffset = -1; michael@0: defineNow(gPolicy, now); michael@0: michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: Assert.equal(experiments.getActiveExperimentID(), EXPERIMENT1_ID, michael@0: "getActiveExperimentID should return the active experiment1"); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 1, "An experiment add-on was installed."); michael@0: michael@0: experimentListData[1].active = true; michael@0: experimentListData[1].endDate = now.getTime() + 10 * MS_IN_ONE_DAY; michael@0: for (let k of Object.keys(experimentListData[1])) { michael@0: Assert.equal(experimentListData[1][k], list[0][k], michael@0: "Property " + k + " should match reference data."); michael@0: } michael@0: michael@0: let b = yield experiments.getExperimentBranch(); michael@0: Assert.strictEqual(b, null, "getExperimentBranch should return null by default"); michael@0: michael@0: b = yield experiments.getExperimentBranch(EXPERIMENT1_ID); michael@0: Assert.strictEqual(b, null, "getExperimentsBranch should return null (with id)"); michael@0: michael@0: yield experiments.setExperimentBranch(EXPERIMENT1_ID, "foo"); michael@0: b = yield experiments.getExperimentBranch(); michael@0: Assert.strictEqual(b, "foo", "getExperimentsBranch should return the set value"); michael@0: michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: Assert.equal(gTimerScheduleOffset, 10 * MS_IN_ONE_DAY, michael@0: "Experiment re-evaluation should have been scheduled correctly."); michael@0: michael@0: // Trigger update, clock set for experiment 1 to stop. michael@0: michael@0: now = futureDate(endDate1, 1000); michael@0: gTimerScheduleOffset = -1; michael@0: defineNow(gPolicy, now); michael@0: michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: Assert.equal(experiments.getActiveExperimentID(), null, michael@0: "getActiveExperimentID should return null again"); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry."); michael@0: addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 0, "The experiment add-on should be uninstalled."); michael@0: michael@0: experimentListData[1].active = false; michael@0: experimentListData[1].endDate = now.getTime(); michael@0: for (let k of Object.keys(experimentListData[1])) { michael@0: Assert.equal(experimentListData[1][k], list[0][k], michael@0: "Property " + k + " should match reference data."); michael@0: } michael@0: michael@0: Assert.equal(gTimerScheduleOffset, startDate2 - now, michael@0: "Experiment re-evaluation should have been scheduled correctly."); michael@0: michael@0: // Trigger update, clock set for experiment 2 to start. michael@0: // Use notify() to provide for coverage of that path. michael@0: michael@0: now = startDate2; michael@0: gTimerScheduleOffset = -1; michael@0: defineNow(gPolicy, now); michael@0: michael@0: yield experiments.notify(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: Assert.equal(experiments.getActiveExperimentID(), EXPERIMENT2_ID, michael@0: "getActiveExperimentID should return the active experiment2"); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 2, "Experiment list should have 2 entries now."); michael@0: addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 1, "An experiment add-on is installed."); michael@0: michael@0: experimentListData[0].active = true; michael@0: experimentListData[0].endDate = now.getTime() + 10 * MS_IN_ONE_DAY; michael@0: for (let i=0; i ++observerFireCount; michael@0: Services.obs.addObserver(observer, OBSERVER_TOPIC, false); michael@0: michael@0: // Dates the following tests are based on. michael@0: michael@0: let baseDate = new Date(2014, 5, 1, 12); michael@0: let startDate = futureDate(baseDate, 100 * MS_IN_ONE_DAY); michael@0: let endDate = futureDate(baseDate, 10000 * MS_IN_ONE_DAY); michael@0: michael@0: // The manifest data we test with. michael@0: michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [ michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT1_XPI_NAME, michael@0: xpiHash: EXPERIMENT1_XPI_SHA1, michael@0: startTime: dateToSeconds(startDate), michael@0: endTime: dateToSeconds(endDate), michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: ], michael@0: }; michael@0: michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: // Trigger update, clock set to before any activation. michael@0: michael@0: let now = baseDate; michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: let list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 0, "Experiment list should be empty."); michael@0: michael@0: // Trigger update, clock set for the experiment to start. michael@0: michael@0: now = futureDate(startDate, 10 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, true, "Experiment 1 should be active."); michael@0: michael@0: let addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 1, "1 add-on is installed."); michael@0: michael@0: // Install conflicting addon. michael@0: michael@0: yield AddonTestUtils.installXPIFromURL(gDataRoot + EXPERIMENT1_XPI_NAME, EXPERIMENT1_XPI_SHA1); michael@0: addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 1, "1 add-on is installed."); michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should still have 1 entry."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, true, "Experiment 1 should be active."); michael@0: michael@0: // Cleanup. michael@0: michael@0: Services.obs.removeObserver(observer, OBSERVER_TOPIC); michael@0: yield testCleanup(experiments); michael@0: }); michael@0: michael@0: add_task(function* test_lastActiveToday() { michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: replaceExperiments(experiments, FAKE_EXPERIMENTS_1); michael@0: michael@0: let e = yield experiments.getExperiments(); michael@0: Assert.equal(e.length, 1, "Monkeypatch successful."); michael@0: Assert.equal(e[0].id, "id1", "ID looks sane"); michael@0: Assert.ok(e[0].active, "Experiment is active."); michael@0: michael@0: let lastActive = yield experiments.lastActiveToday(); michael@0: Assert.equal(e[0], lastActive, "Last active object is expected."); michael@0: michael@0: replaceExperiments(experiments, FAKE_EXPERIMENTS_2); michael@0: e = yield experiments.getExperiments(); michael@0: Assert.equal(e.length, 2, "Monkeypatch successful."); michael@0: michael@0: defineNow(gPolicy, e[0].endDate); michael@0: michael@0: lastActive = yield experiments.lastActiveToday(); michael@0: Assert.ok(lastActive, "Have a last active experiment"); michael@0: Assert.equal(lastActive, e[0], "Last active object is expected."); michael@0: michael@0: yield testCleanup(experiments); michael@0: }); michael@0: michael@0: // Test explicitly disabling experiments. michael@0: michael@0: add_task(function* test_disableExperiment() { michael@0: // Dates this test is based on. michael@0: michael@0: let startDate = new Date(2004, 10, 9, 12); michael@0: let endDate = futureDate(startDate, 100 * MS_IN_ONE_DAY); michael@0: michael@0: // The manifest data we test with. michael@0: michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [ michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT1_XPI_NAME, michael@0: xpiHash: EXPERIMENT1_XPI_SHA1, michael@0: startTime: dateToSeconds(startDate), michael@0: endTime: dateToSeconds(endDate), michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: ], michael@0: }; michael@0: michael@0: // Data to compare the result of Experiments.getExperiments() against. michael@0: michael@0: let experimentInfo = { michael@0: id: EXPERIMENT1_ID, michael@0: name: EXPERIMENT1_NAME, michael@0: description: "Yet another experiment that experiments experimentally.", michael@0: }; michael@0: michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: // Trigger update, clock set for the experiment to start. michael@0: michael@0: let now = futureDate(startDate, 5 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: michael@0: let list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: michael@0: experimentInfo.active = true; michael@0: experimentInfo.endDate = now.getTime() + 10 * MS_IN_ONE_DAY; michael@0: for (let k of Object.keys(experimentInfo)) { michael@0: Assert.equal(experimentInfo[k], list[0][k], michael@0: "Property " + k + " should match reference data."); michael@0: } michael@0: michael@0: // Test disabling the experiment. michael@0: michael@0: now = futureDate(now, 1 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: yield experiments.disableExperiment("foo"); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry."); michael@0: michael@0: experimentInfo.active = false; michael@0: experimentInfo.endDate = now.getTime(); michael@0: for (let k of Object.keys(experimentInfo)) { michael@0: Assert.equal(experimentInfo[k], list[0][k], michael@0: "Property " + k + " should match reference data."); michael@0: } michael@0: michael@0: // Test that updating the list doesn't re-enable it. michael@0: michael@0: now = futureDate(now, 1 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry."); michael@0: michael@0: for (let k of Object.keys(experimentInfo)) { michael@0: Assert.equal(experimentInfo[k], list[0][k], michael@0: "Property " + k + " should match reference data."); michael@0: } michael@0: michael@0: yield testCleanup(experiments); michael@0: }); michael@0: michael@0: add_task(function* test_disableExperimentsFeature() { michael@0: // Dates this test is based on. michael@0: michael@0: let startDate = new Date(2004, 10, 9, 12); michael@0: let endDate = futureDate(startDate, 100 * MS_IN_ONE_DAY); michael@0: michael@0: // The manifest data we test with. michael@0: michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [ michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT1_XPI_NAME, michael@0: xpiHash: EXPERIMENT1_XPI_SHA1, michael@0: startTime: dateToSeconds(startDate), michael@0: endTime: dateToSeconds(endDate), michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: ], michael@0: }; michael@0: michael@0: // Data to compare the result of Experiments.getExperiments() against. michael@0: michael@0: let experimentInfo = { michael@0: id: EXPERIMENT1_ID, michael@0: name: EXPERIMENT1_NAME, michael@0: description: "Yet another experiment that experiments experimentally.", michael@0: }; michael@0: michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: Assert.equal(experiments.enabled, true, "Experiments feature should be enabled."); michael@0: michael@0: // Trigger update, clock set for the experiment to start. michael@0: michael@0: let now = futureDate(startDate, 5 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: michael@0: let list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: michael@0: experimentInfo.active = true; michael@0: experimentInfo.endDate = now.getTime() + 10 * MS_IN_ONE_DAY; michael@0: for (let k of Object.keys(experimentInfo)) { michael@0: Assert.equal(experimentInfo[k], list[0][k], michael@0: "Property " + k + " should match reference data."); michael@0: } michael@0: michael@0: // Test disabling experiments. michael@0: michael@0: experiments._toggleExperimentsEnabled(false); michael@0: yield experiments.notify(); michael@0: Assert.equal(experiments.enabled, false, "Experiments feature should be disabled now."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry."); michael@0: michael@0: experimentInfo.active = false; michael@0: experimentInfo.endDate = now.getTime(); michael@0: for (let k of Object.keys(experimentInfo)) { michael@0: Assert.equal(experimentInfo[k], list[0][k], michael@0: "Property " + k + " should match reference data."); michael@0: } michael@0: michael@0: // Test that updating the list doesn't re-enable it. michael@0: michael@0: now = futureDate(now, 1 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: try { michael@0: yield experiments.updateManifest(); michael@0: } catch (e) { michael@0: // Exception expected, the feature is disabled. michael@0: } michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry."); michael@0: michael@0: for (let k of Object.keys(experimentInfo)) { michael@0: Assert.equal(experimentInfo[k], list[0][k], michael@0: "Property " + k + " should match reference data."); michael@0: } michael@0: michael@0: yield testCleanup(experiments); michael@0: }); michael@0: michael@0: // Test that after a failed experiment install: michael@0: // * the next applicable experiment gets installed michael@0: // * changing the experiments data later triggers re-evaluation michael@0: michael@0: add_task(function* test_installFailure() { michael@0: const OBSERVER_TOPIC = "experiments-changed"; michael@0: let observerFireCount = 0; michael@0: let expectedObserverFireCount = 0; michael@0: let observer = () => ++observerFireCount; michael@0: Services.obs.addObserver(observer, OBSERVER_TOPIC, false); michael@0: michael@0: // Dates the following tests are based on. michael@0: michael@0: let baseDate = new Date(2014, 5, 1, 12); michael@0: let startDate = futureDate(baseDate, 100 * MS_IN_ONE_DAY); michael@0: let endDate = futureDate(baseDate, 10000 * MS_IN_ONE_DAY); michael@0: michael@0: // The manifest data we test with. michael@0: michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [ michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT1_XPI_NAME, michael@0: xpiHash: EXPERIMENT1_XPI_SHA1, michael@0: startTime: dateToSeconds(startDate), michael@0: endTime: dateToSeconds(endDate), michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: { michael@0: id: EXPERIMENT2_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT2_XPI_NAME, michael@0: xpiHash: EXPERIMENT2_XPI_SHA1, michael@0: startTime: dateToSeconds(startDate), michael@0: endTime: dateToSeconds(endDate), michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: ], michael@0: }; michael@0: michael@0: // Data to compare the result of Experiments.getExperiments() against. michael@0: michael@0: let experimentListData = [ michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: name: EXPERIMENT1_NAME, michael@0: description: "Yet another experiment that experiments experimentally.", michael@0: }, michael@0: { michael@0: id: EXPERIMENT2_ID, michael@0: name: "Test experiment 2", michael@0: description: "And yet another experiment that experiments experimentally.", michael@0: }, michael@0: ]; michael@0: michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: // Trigger update, clock set to before any activation. michael@0: michael@0: let now = baseDate; michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: let list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 0, "Experiment list should be empty."); michael@0: michael@0: // Trigger update, clock set for experiment 1 & 2 to start, michael@0: // invalid hash for experiment 1. michael@0: // Order in the manifest matters, so we should start experiment 1, michael@0: // fail to install it & start experiment 2 instead. michael@0: michael@0: now = futureDate(startDate, 10 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: gManifestObject.experiments[0].xpiHash = "sha1:0000000000000000000000000000000000000000"; michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT2_ID, "Experiment 2 should be the sole entry."); michael@0: Assert.equal(list[0].active, true, "Experiment 2 should be active."); michael@0: michael@0: // Trigger update, clock set for experiment 2 to stop. michael@0: michael@0: now = futureDate(now, 20 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: experimentListData[0].active = false; michael@0: experimentListData[0].endDate = now; michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT2_ID, "Experiment 2 should be the sole entry."); michael@0: Assert.equal(list[0].active, false, "Experiment should not be active."); michael@0: michael@0: // Trigger update with a fixed entry for experiment 1, michael@0: // which should get re-evaluated & started now. michael@0: michael@0: now = futureDate(now, 20 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: gManifestObject.experiments[0].xpiHash = EXPERIMENT1_XPI_SHA1; michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: experimentListData[0].active = true; michael@0: experimentListData[0].endDate = now.getTime() + 10 * MS_IN_ONE_DAY; michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 2, "Experiment list should have 2 entries now."); michael@0: michael@0: for (let i=0; i ++observerFireCount; michael@0: Services.obs.addObserver(observer, OBSERVER_TOPIC, false); michael@0: michael@0: // Dates the following tests are based on. michael@0: michael@0: let baseDate = new Date(2014, 5, 1, 12); michael@0: let startDate = futureDate(baseDate, 100 * MS_IN_ONE_DAY); michael@0: let endDate = futureDate(baseDate, 10000 * MS_IN_ONE_DAY); michael@0: michael@0: // The manifest data we test with. michael@0: michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [ michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT1_XPI_NAME, michael@0: xpiHash: EXPERIMENT1_XPI_SHA1, michael@0: startTime: dateToSeconds(startDate), michael@0: endTime: dateToSeconds(endDate), michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: ], michael@0: }; michael@0: michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: // Trigger update, clock set to before any activation. michael@0: michael@0: let now = baseDate; michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: let list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 0, "Experiment list should be empty."); michael@0: michael@0: // Trigger update, clock set for experiment 1 to start. michael@0: michael@0: now = futureDate(startDate, 10 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, true, "Experiment 1 should be active."); michael@0: let todayActive = yield experiments.lastActiveToday(); michael@0: Assert.ok(todayActive, "Last active for today reports a value."); michael@0: Assert.equal(todayActive.id, list[0].id, "The entry is what we expect."); michael@0: michael@0: // Explicitly disable an experiment. michael@0: michael@0: now = futureDate(now, 20 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: yield experiments.disableExperiment("foo"); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, false, "Experiment should not be active anymore."); michael@0: todayActive = yield experiments.lastActiveToday(); michael@0: Assert.ok(todayActive, "Last active for today still returns a value."); michael@0: Assert.equal(todayActive.id, list[0].id, "The ID is still the same."); michael@0: michael@0: // Trigger an update with a faked change for experiment 1. michael@0: michael@0: now = futureDate(now, 20 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: experiments._experiments.get(EXPERIMENT1_ID)._manifestData.xpiHash = michael@0: "sha1:0000000000000000000000000000000000000000"; michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, expectedObserverFireCount, michael@0: "Experiments observer should not have been called."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, false, "Experiment should still be inactive."); michael@0: michael@0: // Cleanup. michael@0: michael@0: Services.obs.removeObserver(observer, OBSERVER_TOPIC); michael@0: yield testCleanup(experiments); michael@0: }); michael@0: michael@0: // Test that changing the hash for an active experiments triggers an michael@0: // update for it. michael@0: michael@0: add_task(function* test_updateActiveExperiment() { michael@0: const OBSERVER_TOPIC = "experiments-changed"; michael@0: let observerFireCount = 0; michael@0: let expectedObserverFireCount = 0; michael@0: let observer = () => ++observerFireCount; michael@0: Services.obs.addObserver(observer, OBSERVER_TOPIC, false); michael@0: michael@0: // Dates the following tests are based on. michael@0: michael@0: let baseDate = new Date(2014, 5, 1, 12); michael@0: let startDate = futureDate(baseDate, 100 * MS_IN_ONE_DAY); michael@0: let endDate = futureDate(baseDate, 10000 * MS_IN_ONE_DAY); michael@0: michael@0: // The manifest data we test with. michael@0: michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [ michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT1_XPI_NAME, michael@0: xpiHash: EXPERIMENT1_XPI_SHA1, michael@0: startTime: dateToSeconds(startDate), michael@0: endTime: dateToSeconds(endDate), michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: ], michael@0: }; michael@0: michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: // Trigger update, clock set to before any activation. michael@0: michael@0: let now = baseDate; michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: let list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 0, "Experiment list should be empty."); michael@0: michael@0: let todayActive = yield experiments.lastActiveToday(); michael@0: Assert.equal(todayActive, null, "No experiment active today."); michael@0: michael@0: // Trigger update, clock set for the experiment to start. michael@0: michael@0: now = futureDate(startDate, 10 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, true, "Experiment 1 should be active."); michael@0: Assert.equal(list[0].name, EXPERIMENT1_NAME, "Experiments name should match."); michael@0: todayActive = yield experiments.lastActiveToday(); michael@0: Assert.ok(todayActive, "todayActive() returns a value."); michael@0: Assert.equal(todayActive.id, list[0].id, "It returns the active experiment."); michael@0: michael@0: // Trigger an update for the active experiment by changing it's hash (and xpi) michael@0: // in the manifest. michael@0: michael@0: now = futureDate(now, 1 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: gManifestObject.experiments[0].xpiHash = EXPERIMENT1A_XPI_SHA1; michael@0: gManifestObject.experiments[0].xpiURL = gDataRoot + EXPERIMENT1A_XPI_NAME; michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, true, "Experiment 1 should still be active."); michael@0: Assert.equal(list[0].name, EXPERIMENT1A_NAME, "Experiments name should have been updated."); michael@0: todayActive = yield experiments.lastActiveToday(); michael@0: Assert.equal(todayActive.id, list[0].id, "last active today is still sane."); michael@0: michael@0: // Cleanup. michael@0: michael@0: Services.obs.removeObserver(observer, OBSERVER_TOPIC); michael@0: yield testCleanup(experiments); michael@0: }); michael@0: michael@0: // Tests that setting the disable flag for an active experiment michael@0: // stops it. michael@0: michael@0: add_task(function* test_disableActiveExperiment() { michael@0: const OBSERVER_TOPIC = "experiments-changed"; michael@0: let observerFireCount = 0; michael@0: let expectedObserverFireCount = 0; michael@0: let observer = () => ++observerFireCount; michael@0: Services.obs.addObserver(observer, OBSERVER_TOPIC, false); michael@0: michael@0: // Dates the following tests are based on. michael@0: michael@0: let baseDate = new Date(2014, 5, 1, 12); michael@0: let startDate = futureDate(baseDate, 100 * MS_IN_ONE_DAY); michael@0: let endDate = futureDate(baseDate, 10000 * MS_IN_ONE_DAY); michael@0: michael@0: // The manifest data we test with. michael@0: michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [ michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT1_XPI_NAME, michael@0: xpiHash: EXPERIMENT1_XPI_SHA1, michael@0: startTime: dateToSeconds(startDate), michael@0: endTime: dateToSeconds(endDate), michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: ], michael@0: }; michael@0: michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: // Trigger update, clock set to before any activation. michael@0: michael@0: let now = baseDate; michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: let list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 0, "Experiment list should be empty."); michael@0: michael@0: // Trigger update, clock set for the experiment to start. michael@0: michael@0: now = futureDate(startDate, 10 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, true, "Experiment 1 should be active."); michael@0: michael@0: // Trigger an update with the experiment being disabled. michael@0: michael@0: now = futureDate(now, 1 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: gManifestObject.experiments[0].disabled = true; michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, false, "Experiment 1 should be disabled."); michael@0: michael@0: // Check that the experiment stays disabled. michael@0: michael@0: now = futureDate(now, 1 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: delete gManifestObject.experiments[0].disabled; michael@0: yield experiments.updateManifest(); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, false, "Experiment 1 should still be disabled."); michael@0: michael@0: // Cleanup. michael@0: michael@0: Services.obs.removeObserver(observer, OBSERVER_TOPIC); michael@0: yield testCleanup(experiments); michael@0: }); michael@0: michael@0: // Test that: michael@0: // * setting the frozen flag for a not-yet-started experiment keeps michael@0: // it from starting michael@0: // * after a removing the frozen flag, the experiment can still start michael@0: michael@0: add_task(function* test_freezePendingExperiment() { michael@0: const OBSERVER_TOPIC = "experiments-changed"; michael@0: let observerFireCount = 0; michael@0: let expectedObserverFireCount = 0; michael@0: let observer = () => ++observerFireCount; michael@0: Services.obs.addObserver(observer, OBSERVER_TOPIC, false); michael@0: michael@0: // Dates the following tests are based on. michael@0: michael@0: let baseDate = new Date(2014, 5, 1, 12); michael@0: let startDate = futureDate(baseDate, 100 * MS_IN_ONE_DAY); michael@0: let endDate = futureDate(baseDate, 10000 * MS_IN_ONE_DAY); michael@0: michael@0: // The manifest data we test with. michael@0: michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [ michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT1_XPI_NAME, michael@0: xpiHash: EXPERIMENT1_XPI_SHA1, michael@0: startTime: dateToSeconds(startDate), michael@0: endTime: dateToSeconds(endDate), michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: ], michael@0: }; michael@0: michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: // Trigger update, clock set to before any activation. michael@0: michael@0: let now = baseDate; michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: let list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 0, "Experiment list should be empty."); michael@0: michael@0: // Trigger update, clock set for the experiment to start but frozen. michael@0: michael@0: now = futureDate(startDate, 10 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: gManifestObject.experiments[0].frozen = true; michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, expectedObserverFireCount, michael@0: "Experiments observer should have not been called."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 0, "Experiment list should have no entries yet."); michael@0: michael@0: // Trigger an update with the experiment not being frozen anymore. michael@0: michael@0: now = futureDate(now, 1 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: delete gManifestObject.experiments[0].frozen; michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, true, "Experiment 1 should be active now."); michael@0: michael@0: // Cleanup. michael@0: michael@0: Services.obs.removeObserver(observer, OBSERVER_TOPIC); michael@0: yield testCleanup(experiments); michael@0: }); michael@0: michael@0: // Test that setting the frozen flag for an active experiment doesn't michael@0: // stop it. michael@0: michael@0: add_task(function* test_freezeActiveExperiment() { michael@0: const OBSERVER_TOPIC = "experiments-changed"; michael@0: let observerFireCount = 0; michael@0: let expectedObserverFireCount = 0; michael@0: let observer = () => ++observerFireCount; michael@0: Services.obs.addObserver(observer, OBSERVER_TOPIC, false); michael@0: michael@0: // Dates the following tests are based on. michael@0: michael@0: let baseDate = new Date(2014, 5, 1, 12); michael@0: let startDate = futureDate(baseDate, 100 * MS_IN_ONE_DAY); michael@0: let endDate = futureDate(baseDate, 10000 * MS_IN_ONE_DAY); michael@0: michael@0: // The manifest data we test with. michael@0: michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [ michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT1_XPI_NAME, michael@0: xpiHash: EXPERIMENT1_XPI_SHA1, michael@0: startTime: dateToSeconds(startDate), michael@0: endTime: dateToSeconds(endDate), michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: ], michael@0: }; michael@0: michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: // Trigger update, clock set to before any activation. michael@0: michael@0: let now = baseDate; michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: let list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 0, "Experiment list should be empty."); michael@0: michael@0: // Trigger update, clock set for the experiment to start. michael@0: michael@0: now = futureDate(startDate, 10 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, true, "Experiment 1 should be active."); michael@0: Assert.equal(list[0].name, EXPERIMENT1_NAME, "Experiments name should match."); michael@0: michael@0: // Trigger an update with the experiment being disabled. michael@0: michael@0: now = futureDate(now, 1 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: gManifestObject.experiments[0].frozen = true; michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, true, "Experiment 1 should still be active."); michael@0: michael@0: // Cleanup. michael@0: michael@0: Services.obs.removeObserver(observer, OBSERVER_TOPIC); michael@0: yield testCleanup(experiments); michael@0: }); michael@0: michael@0: // Test that removing an active experiment from the manifest doesn't michael@0: // stop it. michael@0: michael@0: add_task(function* test_removeActiveExperiment() { michael@0: const OBSERVER_TOPIC = "experiments-changed"; michael@0: let observerFireCount = 0; michael@0: let expectedObserverFireCount = 0; michael@0: let observer = () => ++observerFireCount; michael@0: Services.obs.addObserver(observer, OBSERVER_TOPIC, false); michael@0: michael@0: // Dates the following tests are based on. michael@0: michael@0: let baseDate = new Date(2014, 5, 1, 12); michael@0: let startDate = futureDate(baseDate, 100 * MS_IN_ONE_DAY); michael@0: let endDate = futureDate(baseDate, 10000 * MS_IN_ONE_DAY); michael@0: let startDate2 = futureDate(baseDate, 20000 * MS_IN_ONE_DAY); michael@0: let endDate2 = futureDate(baseDate, 30000 * MS_IN_ONE_DAY); michael@0: michael@0: // The manifest data we test with. michael@0: michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [ michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT1_XPI_NAME, michael@0: xpiHash: EXPERIMENT1_XPI_SHA1, michael@0: startTime: dateToSeconds(startDate), michael@0: endTime: dateToSeconds(endDate), michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: { michael@0: id: EXPERIMENT2_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT1_XPI_NAME, michael@0: xpiHash: EXPERIMENT2_XPI_SHA1, michael@0: startTime: dateToSeconds(startDate2), michael@0: endTime: dateToSeconds(endDate2), michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: ], michael@0: }; michael@0: michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: // Trigger update, clock set to before any activation. michael@0: michael@0: let now = baseDate; michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: let list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 0, "Experiment list should be empty."); michael@0: michael@0: // Trigger update, clock set for the experiment to start. michael@0: michael@0: now = futureDate(startDate, 10 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, true, "Experiment 1 should be active."); michael@0: Assert.equal(list[0].name, EXPERIMENT1_NAME, "Experiments name should match."); michael@0: michael@0: // Trigger an update with experiment 1 missing from the manifest michael@0: michael@0: now = futureDate(now, 1 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: gManifestObject.experiments[0].frozen = true; michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, true, "Experiment 1 should still be active."); michael@0: michael@0: // Cleanup. michael@0: michael@0: Services.obs.removeObserver(observer, OBSERVER_TOPIC); michael@0: yield testCleanup(experiments); michael@0: }); michael@0: michael@0: // Test that we correctly handle experiment start & install failures. michael@0: michael@0: add_task(function* test_invalidUrl() { michael@0: const OBSERVER_TOPIC = "experiments-changed"; michael@0: let observerFireCount = 0; michael@0: let expectedObserverFireCount = 0; michael@0: let observer = () => ++observerFireCount; michael@0: Services.obs.addObserver(observer, OBSERVER_TOPIC, false); michael@0: michael@0: // Dates the following tests are based on. michael@0: michael@0: let baseDate = new Date(2014, 5, 1, 12); michael@0: let startDate = futureDate(baseDate, 100 * MS_IN_ONE_DAY); michael@0: let endDate = futureDate(baseDate, 10000 * MS_IN_ONE_DAY); michael@0: michael@0: // The manifest data we test with. michael@0: michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [ michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT1_XPI_NAME + ".invalid", michael@0: xpiHash: EXPERIMENT1_XPI_SHA1, michael@0: startTime: 0, michael@0: endTime: dateToSeconds(endDate), michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: ], michael@0: }; michael@0: michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: // Trigger update, clock set for the experiment to start. michael@0: michael@0: let now = futureDate(startDate, 10 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: gTimerScheduleOffset = null; michael@0: michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: Assert.equal(gTimerScheduleOffset, null, "No new timer should have been scheduled."); michael@0: michael@0: let list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 0, "Experiment list should be empty."); michael@0: michael@0: // Cleanup. michael@0: michael@0: Services.obs.removeObserver(observer, OBSERVER_TOPIC); michael@0: yield testCleanup(experiments); michael@0: }); michael@0: michael@0: // Test that we handle it properly when active experiment addons are being michael@0: // uninstalled. michael@0: michael@0: add_task(function* test_unexpectedUninstall() { michael@0: const OBSERVER_TOPIC = "experiments-changed"; michael@0: let observerFireCount = 0; michael@0: let expectedObserverFireCount = 0; michael@0: let observer = () => ++observerFireCount; michael@0: Services.obs.addObserver(observer, OBSERVER_TOPIC, false); michael@0: michael@0: // Dates the following tests are based on. michael@0: michael@0: let baseDate = new Date(2014, 5, 1, 12); michael@0: let startDate = futureDate(baseDate, 100 * MS_IN_ONE_DAY); michael@0: let endDate = futureDate(baseDate, 10000 * MS_IN_ONE_DAY); michael@0: michael@0: // The manifest data we test with. michael@0: michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [ michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT1_XPI_NAME, michael@0: xpiHash: EXPERIMENT1_XPI_SHA1, michael@0: startTime: dateToSeconds(startDate), michael@0: endTime: dateToSeconds(endDate), michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: ], michael@0: }; michael@0: michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: // Trigger update, clock set to before any activation. michael@0: michael@0: let now = baseDate; michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: let list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 0, "Experiment list should be empty."); michael@0: michael@0: // Trigger update, clock set for the experiment to start. michael@0: michael@0: now = futureDate(startDate, 10 * MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: yield experiments.updateManifest(); michael@0: Assert.equal(observerFireCount, ++expectedObserverFireCount, michael@0: "Experiments observer should have been called."); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, true, "Experiment 1 should be active."); michael@0: michael@0: // Uninstall the addon through the addon manager instead of stopping it through michael@0: // the experiments API. michael@0: michael@0: yield AddonTestUtils.uninstallAddonByID(EXPERIMENT1_ID); michael@0: yield experiments._mainTask; michael@0: michael@0: yield experiments.notify(); michael@0: michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: Assert.equal(list[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.equal(list[0].active, false, "Experiment 1 should not be active anymore."); michael@0: michael@0: // Cleanup. michael@0: michael@0: Services.obs.removeObserver(observer, OBSERVER_TOPIC); michael@0: yield testCleanup(experiments); michael@0: }); michael@0: michael@0: // If the Addon Manager knows of an experiment that we don't, it should get michael@0: // uninstalled. michael@0: add_task(function* testUnknownExperimentsUninstalled() { michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: let addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 0, "Precondition: No experiment add-ons are present."); michael@0: michael@0: // Simulate us not listening. michael@0: experiments._unregisterWithAddonManager(); michael@0: yield AddonTestUtils.installXPIFromURL(gDataRoot + EXPERIMENT1_XPI_NAME, EXPERIMENT1_XPI_SHA1); michael@0: experiments._registerWithAddonManager(); michael@0: michael@0: addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 1, "Experiment 1 installed via AddonManager"); michael@0: michael@0: // Simulate no known experiments. michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [], michael@0: }; michael@0: michael@0: yield experiments.updateManifest(); michael@0: let fromManifest = yield experiments.getExperiments(); michael@0: Assert.equal(fromManifest.length, 0, "No experiments known in manifest."); michael@0: michael@0: // And the unknown add-on should be gone. michael@0: addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 0, "Experiment 1 was uninstalled."); michael@0: michael@0: yield testCleanup(experiments); michael@0: }); michael@0: michael@0: // If someone else installs an experiment add-on, we detect and stop that. michael@0: add_task(function* testForeignExperimentInstall() { michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [], michael@0: }; michael@0: michael@0: yield experiments.init(); michael@0: michael@0: let addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 0, "Precondition: No experiment add-ons present."); michael@0: michael@0: let failed = false; michael@0: try { michael@0: yield AddonTestUtils.installXPIFromURL(gDataRoot + EXPERIMENT1_XPI_NAME, EXPERIMENT1_XPI_SHA1); michael@0: } catch (ex) { michael@0: failed = true; michael@0: } michael@0: Assert.ok(failed, "Add-on install should not have completed successfully"); michael@0: addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 0, "Add-on install should have been cancelled."); michael@0: michael@0: yield testCleanup(experiments); michael@0: }); michael@0: michael@0: // Experiment add-ons will be disabled after Addon Manager restarts. Ensure michael@0: // we enable them automatically. michael@0: add_task(function* testEnabledAfterRestart() { michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [ michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT1_XPI_NAME, michael@0: xpiHash: EXPERIMENT1_XPI_SHA1, michael@0: startTime: gPolicy.now().getTime() / 1000 - 60, michael@0: endTime: gPolicy.now().getTime() / 1000 + 60, michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: ], michael@0: }; michael@0: michael@0: let addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 0, "Precondition: No experiment add-ons installed."); michael@0: michael@0: yield experiments.updateManifest(); michael@0: let fromManifest = yield experiments.getExperiments(); michael@0: Assert.equal(fromManifest.length, 1, "A single experiment is known."); michael@0: michael@0: addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 1, "A single experiment add-on is installed."); michael@0: Assert.ok(addons[0].isActive, "That experiment is active."); michael@0: michael@0: dump("Restarting Addon Manager\n"); michael@0: experiments._unregisterWithAddonManager(); michael@0: restartManager(); michael@0: experiments._registerWithAddonManager(); michael@0: michael@0: addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 1, "The experiment is still there after restart."); michael@0: Assert.ok(addons[0].userDisabled, "But it is disabled."); michael@0: Assert.equal(addons[0].isActive, false, "And not active."); michael@0: michael@0: yield experiments.updateManifest(); michael@0: Assert.ok(addons[0].isActive, "It activates when the manifest is evaluated."); michael@0: michael@0: yield testCleanup(experiments); michael@0: }); michael@0: michael@0: // Test coverage for an add-on uninstall disabling the experiment and that it stays michael@0: // disabled over restarts. michael@0: add_task(function* test_foreignUninstallAndRestart() { michael@0: let experiments = new Experiments.Experiments(gPolicy); michael@0: michael@0: gManifestObject = { michael@0: "version": 1, michael@0: experiments: [ michael@0: { michael@0: id: EXPERIMENT1_ID, michael@0: xpiURL: gDataRoot + EXPERIMENT1_XPI_NAME, michael@0: xpiHash: EXPERIMENT1_XPI_SHA1, michael@0: startTime: gPolicy.now().getTime() / 1000 - 60, michael@0: endTime: gPolicy.now().getTime() / 1000 + 60, michael@0: maxActiveSeconds: 10 * SEC_IN_ONE_DAY, michael@0: appName: ["XPCShell"], michael@0: channel: ["nightly"], michael@0: }, michael@0: ], michael@0: }; michael@0: michael@0: let addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 0, "Precondition: No experiment add-ons installed."); michael@0: michael@0: yield experiments.updateManifest(); michael@0: let experimentList = yield experiments.getExperiments(); michael@0: Assert.equal(experimentList.length, 1, "A single experiment is known."); michael@0: michael@0: addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 1, "A single experiment add-on is installed."); michael@0: Assert.ok(addons[0].isActive, "That experiment is active."); michael@0: michael@0: yield AddonTestUtils.uninstallAddonByID(EXPERIMENT1_ID); michael@0: yield experiments._mainTask; michael@0: michael@0: let addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 0, "Experiment add-on should have been removed."); michael@0: michael@0: experimentList = yield experiments.getExperiments(); michael@0: Assert.equal(experimentList.length, 1, "A single experiment is known."); michael@0: Assert.equal(experimentList[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.ok(!experimentList[0].active, "Experiment 1 should not be active anymore."); michael@0: michael@0: // Fake restart behaviour. michael@0: experiments.uninit(); michael@0: restartManager(); michael@0: experiments = new Experiments.Experiments(gPolicy); michael@0: yield experiments.updateManifest(); michael@0: michael@0: let addons = yield getExperimentAddons(); michael@0: Assert.equal(addons.length, 0, "No experiment add-ons installed."); michael@0: michael@0: experimentList = yield experiments.getExperiments(); michael@0: Assert.equal(experimentList.length, 1, "A single experiment is known."); michael@0: Assert.equal(experimentList[0].id, EXPERIMENT1_ID, "Experiment 1 should be the sole entry."); michael@0: Assert.ok(!experimentList[0].active, "Experiment 1 should not be active."); michael@0: michael@0: yield testCleanup(experiments); michael@0: });