The Tor Browser: browser/experiments/test/xpcshell/test_disableExperiments.js@6474c204b198 (annotated)

browser/experiments/test/xpcshell/test_disableExperiments.js@6474c204b198 (annotated)

browser/experiments/test/xpcshell/test_disableExperiments.js

Wed, 31 Dec 2014 06:09:35 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Wed, 31 Dec 2014 06:09:35 +0100
changeset 0: 6474c204b198
permissions: -rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

 /* Any copyright is dedicated to the Public Domain.
  * http://creativecommons.org/publicdomain/zero/1.0/ */
 "use strict";
 Cu.import("resource://testing-common/httpd.js");
 Cu.import("resource://testing-common/AddonManagerTesting.jsm");
 XPCOMUtils.defineLazyModuleGetter(this, "Experiments",
   "resource:///modules/experiments/Experiments.jsm");
 const FILE_MANIFEST            = "experiments.manifest";
 const MANIFEST_HANDLER         = "manifests/handler";
 const SEC_IN_ONE_DAY  = 24 * 60 * 60;
 const MS_IN_ONE_DAY   = SEC_IN_ONE_DAY * 1000;
 let gProfileDir          = null;
 let gHttpServer          = null;
 let gHttpRoot            = null;
 let gDataRoot            = null;
 let gReporter            = null;
 let gPolicy              = null;
 let gManifestObject      = null;
 let gManifestHandlerURI  = null;
 function run_test() {
   run_next_test();
 }
 add_task(function* test_setup() {
   loadAddonManager();
   gProfileDir = do_get_profile();
   gHttpServer = new HttpServer();
   gHttpServer.start(-1);
   let port = gHttpServer.identity.primaryPort;
   gHttpRoot = "http://localhost:" + port + "/";
   gDataRoot = gHttpRoot + "data/";
   gManifestHandlerURI = gHttpRoot + MANIFEST_HANDLER;
   gHttpServer.registerDirectory("/data/", do_get_cwd());
   gHttpServer.registerPathHandler("/" + MANIFEST_HANDLER, (request, response) => {
     response.setStatusLine(null, 200, "OK");
     response.write(JSON.stringify(gManifestObject));
     response.processAsync();
     response.finish();
   });
   do_register_cleanup(() => gHttpServer.stop(() => {}));
   disableCertificateChecks();
   Services.prefs.setBoolPref(PREF_EXPERIMENTS_ENABLED, true);
   Services.prefs.setIntPref(PREF_LOGGING_LEVEL, 0);
   Services.prefs.setBoolPref(PREF_LOGGING_DUMP, true);
   Services.prefs.setCharPref(PREF_MANIFEST_URI, gManifestHandlerURI);
   Services.prefs.setIntPref(PREF_FETCHINTERVAL, 0);
   gReporter = yield getReporter("json_payload_simple");
   yield gReporter.collectMeasurements();
   let payload = yield gReporter.getJSONPayload(true);
   do_register_cleanup(() => gReporter._shutdown());
   gPolicy = new Experiments.Policy();
   patchPolicy(gPolicy, {
     updatechannel: () => "nightly",
     healthReportPayload: () => Promise.resolve(payload),
     oneshotTimer: (callback, timeout, thisObj, name) => {},
   });
 });
 // Test disabling the feature stops current and future experiments.
 add_task(function* test_disableExperiments() {
   const OBSERVER_TOPIC = "experiments-changed";
   let observerFireCount = 0;
   let expectedObserverFireCount = 0;
   let observer = () => ++observerFireCount;
   Services.obs.addObserver(observer, OBSERVER_TOPIC, false);
   // Dates the following tests are based on.
   let baseDate   = new Date(2014, 5, 1, 12);
   let startDate1 = futureDate(baseDate,  50 * MS_IN_ONE_DAY);
   let endDate1   = futureDate(baseDate, 100 * MS_IN_ONE_DAY);
   let startDate2 = futureDate(baseDate, 150 * MS_IN_ONE_DAY);
   let endDate2   = futureDate(baseDate, 200 * MS_IN_ONE_DAY);
   // The manifest data we test with.
   gManifestObject = {
     "version": 1,
     experiments: [
       {
         id:               EXPERIMENT2_ID,
         xpiURL:           gDataRoot + EXPERIMENT2_XPI_NAME,
         xpiHash:          EXPERIMENT2_XPI_SHA1,
         startTime:        dateToSeconds(startDate2),
         endTime:          dateToSeconds(endDate2),
         maxActiveSeconds: 10 * SEC_IN_ONE_DAY,
         appName:          ["XPCShell"],
         channel:          ["nightly"],
       },
       {
         id:               EXPERIMENT1_ID,
         xpiURL:           gDataRoot + EXPERIMENT1_XPI_NAME,
         xpiHash:          EXPERIMENT1_XPI_SHA1,
         startTime:        dateToSeconds(startDate1),
         endTime:          dateToSeconds(endDate1),
         maxActiveSeconds: 10 * SEC_IN_ONE_DAY,
         appName:          ["XPCShell"],
         channel:          ["nightly"],
       },
     ],
   };
   let experiments = new Experiments.Experiments(gPolicy);
   // Trigger update, clock set to before any activation.
   // Use updateManifest() to provide for coverage of that path.
   let now = baseDate;
   defineNow(gPolicy, now);
   yield experiments.updateManifest();
   Assert.equal(observerFireCount, ++expectedObserverFireCount,
                "Experiments observer should have been called.");
   let list = yield experiments.getExperiments();
   Assert.equal(list.length, 0, "Experiment list should be empty.");
   let addons = yield getExperimentAddons();
   Assert.equal(addons.length, 0, "Precondition: No experiment add-ons are installed.");
   // Trigger update, clock set for experiment 1 to start.
   now = futureDate(startDate1, 5 * MS_IN_ONE_DAY);
   defineNow(gPolicy, now);
   yield experiments.updateManifest();
   Assert.equal(observerFireCount, ++expectedObserverFireCount,
                "Experiments observer should have been called.");
   list = yield experiments.getExperiments();
   Assert.equal(list.length, 1, "Experiment list should have 1 entry now.");
   Assert.equal(list[0].active, true, "Experiment should be active.");
   addons = yield getExperimentAddons();
   Assert.equal(addons.length, 1, "An experiment add-on was installed.");
   // Disable the experiments feature. Check that we stop the running experiment.
   Services.prefs.setBoolPref(PREF_EXPERIMENTS_ENABLED, false);
   yield experiments._mainTask;
   Assert.equal(observerFireCount, ++expectedObserverFireCount,
                "Experiments observer should have been called.");
   list = yield experiments.getExperiments();
   Assert.equal(list.length, 1, "Experiment list should have 1 entry.");
   Assert.equal(list[0].active, false, "Experiment entry should not be active.");
   addons = yield getExperimentAddons();
   Assert.equal(addons.length, 0, "The experiment add-on should be uninstalled.");
   // Trigger update, clock set for experiment 2 to start. Verify we don't start it.
   now = startDate2;
   defineNow(gPolicy, now);
   try {
     yield experiments.updateManifest();
   } catch (e if e.message == "experiments are disabled") {
     // This exception is expected.
   }
   experiments.notify();
   yield experiments._mainTask;
   Assert.equal(observerFireCount, expectedObserverFireCount,
                "Experiments observer should not have been called.");
   list = yield experiments.getExperiments();
   Assert.equal(list.length, 1, "Experiment list should still have 1 entry.");
   Assert.equal(list[0].active, false, "Experiment entry should not be active.");
   addons = yield getExperimentAddons();
   Assert.equal(addons.length, 0, "There should still be no experiment add-on installed.");
   // Cleanup.
   Services.obs.removeObserver(observer, OBSERVER_TOPIC);
   yield experiments.uninit();
   yield removeCacheFile();
 });