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://gre/modules/TelemetryLog.jsm"); michael@0: let bsp = Cu.import("resource:///modules/experiments/Experiments.jsm"); michael@0: 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: 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: michael@0: const TLOG = bsp.TELEMETRY_LOG; michael@0: michael@0: let gGlobalScope = this; michael@0: function loadAddonManager() { michael@0: let ns = {}; michael@0: Cu.import("resource://gre/modules/Services.jsm", ns); michael@0: let head = "../../../../toolkit/mozapps/extensions/test/xpcshell/head_addons.js"; michael@0: let file = do_get_file(head); michael@0: let uri = ns.Services.io.newFileURI(file); michael@0: ns.Services.scriptloader.loadSubScript(uri.spec, gGlobalScope); michael@0: createAppInfo("xpcshell@tests.mozilla.org", "XPCShell", "1", "1.9.2"); michael@0: startupManager(); michael@0: } michael@0: michael@0: function checkEvent(event, id, data) michael@0: { michael@0: do_print("Checking message " + id); michael@0: Assert.equal(event[0], id, "id should match"); michael@0: Assert.ok(event[1] > 0, "timestamp should be greater than 0"); michael@0: michael@0: if (data === undefined) { michael@0: Assert.equal(event.length, 2, "event array should have 2 entries"); michael@0: } else { michael@0: Assert.equal(event.length, data.length + 2, "event entry count should match expected count"); michael@0: for (var i = 0; i < data.length; ++i) { michael@0: Assert.equal(typeof(event[i + 2]), "string", "event entry should be a string"); michael@0: Assert.equal(event[i + 2], data[i], "event entry should match expected entry"); michael@0: } 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: let dummyTimer = { cancel: () => {}, clear: () => {} }; michael@0: patchPolicy(gPolicy, { michael@0: updatechannel: () => "nightly", michael@0: healthReportPayload: () => Promise.resolve(payload), michael@0: oneshotTimer: (callback, timeout, thisObj, name) => dummyTimer, michael@0: }); michael@0: michael@0: yield removeCacheFile(); michael@0: }); michael@0: michael@0: // Test basic starting and stopping of experiments. michael@0: michael@0: add_task(function* test_telemetryBasics() { michael@0: // Check TelemetryLog instead of TelemetryPing.getPayload().log because michael@0: // TelemetryPing gets Experiments.instance() and side-effects log entries. michael@0: michael@0: const OBSERVER_TOPIC = "experiments-changed"; michael@0: let observerFireCount = 0; michael@0: let expectedLogLength = 0; 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: 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: 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: }; 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: defineNow(gPolicy, now); michael@0: michael@0: yield experiments.updateManifest(); michael@0: let list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 0, "Experiment list should be empty."); michael@0: michael@0: expectedLogLength += 2; michael@0: let log = TelemetryLog.entries(); michael@0: Assert.equal(log.length, expectedLogLength, "Telemetry log should have " + expectedLogLength + " entries."); michael@0: checkEvent(log[log.length-2], TLOG.ACTIVATION_KEY, michael@0: [TLOG.ACTIVATION.REJECTED, EXPERIMENT1_ID, "startTime"]); michael@0: checkEvent(log[log.length-1], TLOG.ACTIVATION_KEY, michael@0: [TLOG.ACTIVATION.REJECTED, EXPERIMENT2_ID, "startTime"]); 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: defineNow(gPolicy, now); michael@0: michael@0: yield experiments.updateManifest(); michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry now."); michael@0: michael@0: expectedLogLength += 1; michael@0: log = TelemetryLog.entries(); michael@0: Assert.equal(log.length, expectedLogLength, "Telemetry log should have " + expectedLogLength + " entries. Got " + log.toSource()); michael@0: checkEvent(log[log.length-1], TLOG.ACTIVATION_KEY, michael@0: [TLOG.ACTIVATION.ACTIVATED, EXPERIMENT1_ID]); michael@0: michael@0: // Trigger update, clock set for experiment 1 to stop. michael@0: michael@0: now = futureDate(endDate1, 1000); michael@0: defineNow(gPolicy, now); michael@0: michael@0: yield experiments.updateManifest(); michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entry."); michael@0: michael@0: expectedLogLength += 2; michael@0: log = TelemetryLog.entries(); michael@0: Assert.equal(log.length, expectedLogLength, "Telemetry log should have " + expectedLogLength + " entries."); michael@0: checkEvent(log[log.length-2], TLOG.TERMINATION_KEY, michael@0: [TLOG.TERMINATION.EXPIRED, EXPERIMENT1_ID]); michael@0: checkEvent(log[log.length-1], TLOG.ACTIVATION_KEY, michael@0: [TLOG.ACTIVATION.REJECTED, EXPERIMENT2_ID, "startTime"]); michael@0: michael@0: // Trigger update, clock set for experiment 2 to start with invalid hash. michael@0: michael@0: now = startDate2; michael@0: defineNow(gPolicy, now); michael@0: gManifestObject.experiments[1].xpiHash = "sha1:0000000000000000000000000000000000000000"; michael@0: michael@0: yield experiments.updateManifest(); michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 1, "Experiment list should have 1 entries."); michael@0: michael@0: expectedLogLength += 1; michael@0: log = TelemetryLog.entries(); michael@0: Assert.equal(log.length, expectedLogLength, "Telemetry log should have " + expectedLogLength + " entries."); michael@0: checkEvent(log[log.length-1], TLOG.ACTIVATION_KEY, michael@0: [TLOG.ACTIVATION.INSTALL_FAILURE, EXPERIMENT2_ID]); michael@0: michael@0: // Trigger update, clock set for experiment 2 to properly start now. michael@0: michael@0: now = futureDate(now, MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: gManifestObject.experiments[1].xpiHash = EXPERIMENT2_XPI_SHA1; michael@0: michael@0: yield experiments.updateManifest(); michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 2, "Experiment list should have 2 entries."); michael@0: michael@0: expectedLogLength += 1; michael@0: log = TelemetryLog.entries(); michael@0: Assert.equal(log.length, expectedLogLength, "Telemetry log should have " + expectedLogLength + " entries."); michael@0: checkEvent(log[log.length-1], TLOG.ACTIVATION_KEY, michael@0: [TLOG.ACTIVATION.ACTIVATED, EXPERIMENT2_ID]); michael@0: michael@0: // Fake user uninstall of experiment via add-on manager. michael@0: michael@0: now = futureDate(now, MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: michael@0: yield experiments.disableExperiment(TLOG.TERMINATION.ADDON_UNINSTALLED); michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 2, "Experiment list should have 2 entries."); michael@0: michael@0: expectedLogLength += 1; michael@0: log = TelemetryLog.entries(); michael@0: Assert.equal(log.length, expectedLogLength, "Telemetry log should have " + expectedLogLength + " entries."); michael@0: checkEvent(log[log.length-1], TLOG.TERMINATION_KEY, michael@0: [TLOG.TERMINATION.ADDON_UNINSTALLED, EXPERIMENT2_ID]); michael@0: michael@0: // Trigger update with experiment 1a ready to start. michael@0: michael@0: now = futureDate(now, MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: gManifestObject.experiments[0].id = EXPERIMENT3_ID; michael@0: gManifestObject.experiments[0].endTime = dateToSeconds(futureDate(now, 50 * MS_IN_ONE_DAY)); michael@0: michael@0: yield experiments.updateManifest(); michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 3, "Experiment list should have 3 entries."); michael@0: michael@0: expectedLogLength += 1; michael@0: log = TelemetryLog.entries(); michael@0: Assert.equal(log.length, expectedLogLength, "Telemetry log should have " + expectedLogLength + " entries."); michael@0: checkEvent(log[log.length-1], TLOG.ACTIVATION_KEY, michael@0: [TLOG.ACTIVATION.ACTIVATED, EXPERIMENT3_ID]); michael@0: michael@0: // Trigger disable of an experiment via the API. michael@0: michael@0: now = futureDate(now, MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: michael@0: yield experiments.disableExperiment(TLOG.TERMINATION.FROM_API); michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 3, "Experiment list should have 3 entries."); michael@0: michael@0: expectedLogLength += 1; michael@0: log = TelemetryLog.entries(); michael@0: Assert.equal(log.length, expectedLogLength, "Telemetry log should have " + expectedLogLength + " entries."); michael@0: checkEvent(log[log.length-1], TLOG.TERMINATION_KEY, michael@0: [TLOG.TERMINATION.FROM_API, EXPERIMENT3_ID]); michael@0: michael@0: // Trigger update with experiment 1a ready to start. michael@0: michael@0: now = futureDate(now, MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: gManifestObject.experiments[0].id = EXPERIMENT4_ID; michael@0: gManifestObject.experiments[0].endTime = dateToSeconds(futureDate(now, 50 * MS_IN_ONE_DAY)); michael@0: michael@0: yield experiments.updateManifest(); michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 4, "Experiment list should have 4 entries."); michael@0: michael@0: expectedLogLength += 1; michael@0: log = TelemetryLog.entries(); michael@0: Assert.equal(log.length, expectedLogLength, "Telemetry log should have " + expectedLogLength + " entries."); michael@0: checkEvent(log[log.length-1], TLOG.ACTIVATION_KEY, michael@0: [TLOG.ACTIVATION.ACTIVATED, EXPERIMENT4_ID]); michael@0: michael@0: // Trigger experiment termination by something other than expiry via the manifest. michael@0: michael@0: now = futureDate(now, MS_IN_ONE_DAY); michael@0: defineNow(gPolicy, now); michael@0: gManifestObject.experiments[0].os = "Plan9"; michael@0: michael@0: yield experiments.updateManifest(); michael@0: list = yield experiments.getExperiments(); michael@0: Assert.equal(list.length, 4, "Experiment list should have 4 entries."); michael@0: michael@0: expectedLogLength += 1; michael@0: log = TelemetryLog.entries(); michael@0: Assert.equal(log.length, expectedLogLength, "Telemetry log should have " + expectedLogLength + " entries."); michael@0: checkEvent(log[log.length-1], TLOG.TERMINATION_KEY, michael@0: [TLOG.TERMINATION.RECHECK, EXPERIMENT4_ID, "os"]); michael@0: michael@0: // Cleanup. michael@0: michael@0: yield experiments.uninit(); michael@0: yield removeCacheFile(); michael@0: });