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: 
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) => {},
michael@0:   });
michael@0: });
michael@0: 
michael@0: // Test disabling the feature stops current and future experiments.
michael@0: 
michael@0: add_task(function* test_disableExperiments() {
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:   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:   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:   let addons = yield getExperimentAddons();
michael@0:   Assert.equal(addons.length, 0, "Precondition: No experiment add-ons are installed.");
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:   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].active, true, "Experiment should be active.");
michael@0:   addons = yield getExperimentAddons();
michael@0:   Assert.equal(addons.length, 1, "An experiment add-on was installed.");
michael@0: 
michael@0:   // Disable the experiments feature. Check that we stop the running experiment.
michael@0: 
michael@0:   Services.prefs.setBoolPref(PREF_EXPERIMENTS_ENABLED, false);
michael@0:   yield experiments._mainTask;
michael@0: 
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.");
michael@0:   Assert.equal(list[0].active, false, "Experiment entry should not be active.");
michael@0:   addons = yield getExperimentAddons();
michael@0:   Assert.equal(addons.length, 0, "The experiment add-on should be uninstalled.");
michael@0: 
michael@0:   // Trigger update, clock set for experiment 2 to start. Verify we don't start it.
michael@0: 
michael@0:   now = startDate2;
michael@0:   defineNow(gPolicy, now);
michael@0: 
michael@0:   try {
michael@0:     yield experiments.updateManifest();
michael@0:   } catch (e if e.message == "experiments are disabled") {
michael@0:     // This exception is expected.
michael@0:   }
michael@0: 
michael@0:   experiments.notify();
michael@0:   yield experiments._mainTask;
michael@0: 
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 still have 1 entry.");
michael@0:   Assert.equal(list[0].active, false, "Experiment entry should not be active.");
michael@0:   addons = yield getExperimentAddons();
michael@0:   Assert.equal(addons.length, 0, "There should still be no experiment add-on installed.");
michael@0: 
michael@0:   // Cleanup.
michael@0: 
michael@0:   Services.obs.removeObserver(observer, OBSERVER_TOPIC);
michael@0:   yield experiments.uninit();
michael@0:   yield removeCacheFile();
michael@0: });