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: 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 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:   yield removeCacheFile();
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: () => {},
michael@0:     oneshotTimer: (callback, timeout, thisObj, name) => gTimerScheduleOffset = timeout,
michael@0:   });
michael@0: });
michael@0: 
michael@0: function checkExperimentListsEqual(list, list2) {
michael@0:   Assert.equal(list.length, list2.length, "Lists should have the same length.")
michael@0: 
michael@0:   for (let i=0; i<list.length; ++i) {
michael@0:     for (let k of Object.keys(list[i])) {
michael@0:       Assert.equal(list[i][k], list2[i][k],
michael@0:                    "Field '" + k + "' should match for list entry " + i + ".");
michael@0:     }
michael@0:   }
michael@0: }
michael@0: 
michael@0: function checkExperimentSerializations(experimentEntryIterator) {
michael@0:   for (let experiment of experimentEntryIterator) {
michael@0:     let experiment2 = new Experiments.ExperimentEntry(gPolicy);
michael@0:     let jsonStr = JSON.stringify(experiment.toJSON());
michael@0:     Assert.ok(experiment2.initFromCacheData(JSON.parse(jsonStr)),
michael@0:               "Should have initialized successfully from JSON serialization.");
michael@0:     Assert.equal(JSON.stringify(experiment), JSON.stringify(experiment2),
michael@0:                  "Object stringifications should match.");
michael@0:   }
michael@0: }
michael@0: 
michael@0: // Set up an experiments instance and check if it is properly restored from cache.
michael@0: 
michael@0: add_task(function* test_cache() {
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:         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:         maxActiveSeconds: 10 * SEC_IN_ONE_DAY,
michael@0:         appName:          ["XPCShell"],
michael@0:         channel:          ["nightly"],
michael@0:       },
michael@0:       {
michael@0:         id:               EXPERIMENT3_ID,
michael@0:         xpiURL:           "https://inval.id/foo.xpi",
michael@0:         xpiHash:          "sha1:0000000000000000000000000000000000000000",
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:   // Setup dates for the experiments.
michael@0: 
michael@0:   let baseDate   = new Date(2014, 5, 1, 12);
michael@0:   let startDates = [];
michael@0:   let endDates   = [];
michael@0: 
michael@0:   for (let i=0; i<gManifestObject.experiments.length; ++i) {
michael@0:     let experiment = gManifestObject.experiments[i];
michael@0:     startDates.push(futureDate(baseDate, (50 + (150 * i)) * MS_IN_ONE_DAY));
michael@0:     endDates  .push(futureDate(startDates[i], 50 * MS_IN_ONE_DAY));
michael@0:     experiment.startTime = dateToSeconds(startDates[i]);
michael@0:     experiment.endTime   = dateToSeconds(endDates[i]);
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:   // Trigger update & re-init, clock set to before any activation.
michael@0: 
michael@0:   let now = baseDate;
michael@0:   defineNow(gPolicy, now);
michael@0: 
michael@0:   let experiments = new Experiments.Experiments(gPolicy);
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:   checkExperimentSerializations(experiments._experiments.values());
michael@0: 
michael@0:   yield experiments.uninit();
michael@0:   experiments = new Experiments.Experiments(gPolicy);
michael@0: 
michael@0:   yield experiments._run();
michael@0:   list = yield experiments.getExperiments();
michael@0:   Assert.equal(list.length, 0, "Experiment list should be empty.");
michael@0:   checkExperimentSerializations(experiments._experiments.values());
michael@0: 
michael@0:   // Re-init, clock set for experiment 1 to start.
michael@0: 
michael@0:   now = futureDate(startDates[0], 5 * MS_IN_ONE_DAY);
michael@0:   defineNow(gPolicy, now);
michael@0: 
michael@0:   yield experiments.uninit();
michael@0:   experiments = new Experiments.Experiments(gPolicy);
michael@0:   yield experiments._run();
michael@0: 
michael@0:   list = yield experiments.getExperiments();
michael@0:   Assert.equal(list.length, 1, "Experiment list should have 1 entry now.");
michael@0: 
michael@0:   experimentListData[1].active = true;
michael@0:   experimentListData[1].endDate = now.getTime() + 10 * MS_IN_ONE_DAY;
michael@0:   checkExperimentListsEqual(experimentListData.slice(1), list);
michael@0:   checkExperimentSerializations(experiments._experiments.values());
michael@0: 
michael@0:   let branch = yield experiments.getExperimentBranch(EXPERIMENT1_ID);
michael@0:   Assert.strictEqual(branch, null);
michael@0: 
michael@0:   yield experiments.setExperimentBranch(EXPERIMENT1_ID, "testbranch");
michael@0:   branch = yield experiments.getExperimentBranch(EXPERIMENT1_ID);
michael@0:   Assert.strictEqual(branch, "testbranch");
michael@0: 
michael@0:   // Re-init, clock set for experiment 1 to stop.
michael@0: 
michael@0:   now = futureDate(now, 20 * MS_IN_ONE_DAY);
michael@0:   defineNow(gPolicy, now);
michael@0: 
michael@0:   yield experiments.uninit();
michael@0:   experiments = new Experiments.Experiments(gPolicy);
michael@0:   yield experiments._run();
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:   experimentListData[1].active = false;
michael@0:   experimentListData[1].endDate = now.getTime();
michael@0:   checkExperimentListsEqual(experimentListData.slice(1), list);
michael@0:   checkExperimentSerializations(experiments._experiments.values());
michael@0: 
michael@0:   branch = yield experiments.getExperimentBranch(EXPERIMENT1_ID);
michael@0:   Assert.strictEqual(branch, "testbranch");
michael@0: 
michael@0:   // Re-init, clock set for experiment 2 to start.
michael@0: 
michael@0:   now = futureDate(startDates[1], 20 * MS_IN_ONE_DAY);
michael@0:   defineNow(gPolicy, now);
michael@0: 
michael@0:   yield experiments.uninit();
michael@0:   experiments = new Experiments.Experiments(gPolicy);
michael@0:   yield experiments._run();
michael@0: 
michael@0:   list = yield experiments.getExperiments();
michael@0:   Assert.equal(list.length, 2, "Experiment list should have 2 entries.");
michael@0: 
michael@0:   experimentListData[0].active = true;
michael@0:   experimentListData[0].endDate = now.getTime() + 10 * MS_IN_ONE_DAY;
michael@0:   checkExperimentListsEqual(experimentListData, list);
michael@0:   checkExperimentSerializations(experiments._experiments.values());
michael@0: 
michael@0:   // Re-init, 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: 
michael@0:   yield experiments.uninit();
michael@0:   experiments = new Experiments.Experiments(gPolicy);
michael@0:   yield experiments._run();
michael@0: 
michael@0:   list = yield experiments.getExperiments();
michael@0:   Assert.equal(list.length, 2, "Experiment list should have 2 entries.");
michael@0: 
michael@0:   experimentListData[0].active = false;
michael@0:   experimentListData[0].endDate = now.getTime();
michael@0:   checkExperimentListsEqual(experimentListData, list);
michael@0:   checkExperimentSerializations(experiments._experiments.values());
michael@0: 
michael@0:   // Cleanup.
michael@0: 
michael@0:   yield experiments._toggleExperimentsEnabled(false);
michael@0:   yield experiments.uninit();
michael@0:   yield removeCacheFile();
michael@0: });