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: 
michael@0: Cu.import("resource:///modules/experiments/Experiments.jsm");
michael@0: 
michael@0: const FILE_MANIFEST            = "experiments.manifest";
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 gReporter   = null;
michael@0: let gPolicy     = null;
michael@0: 
michael@0: 
michael@0: function ManifestEntry(data) {
michael@0:   this.id = EXPERIMENT1_ID;
michael@0:   this.xpiURL = "http://localhost:1/dummy.xpi";
michael@0:   this.xpiHash = EXPERIMENT1_XPI_SHA1;
michael@0:   this.startTime = new Date(2010, 0, 1, 12).getTime() / 1000;
michael@0:   this.endTime = new Date(9001, 0, 1, 12).getTime() / 1000;
michael@0:   this.maxActiveSeconds = SEC_IN_ONE_DAY;
michael@0:   this.appName = ["XPCShell"];
michael@0:   this.channel = ["nightly"];
michael@0: 
michael@0:   data = data || {};
michael@0:   for (let k of Object.keys(data)) {
michael@0:     this[k] = data[k];
michael@0:   }
michael@0: 
michael@0:   if (!this.endTime) {
michael@0:     this.endTime = this.startTime + 5 * SEC_IN_ONE_DAY;
michael@0:   }
michael@0: }
michael@0: 
michael@0: function applicableFromManifestData(data, policy) {
michael@0:   let manifestData = new ManifestEntry(data);
michael@0:   let entry = new Experiments.ExperimentEntry(policy);
michael@0:   entry.initFromManifestData(manifestData);
michael@0:   return entry.isApplicable();
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:   createAppInfo();
michael@0:   gProfileDir = do_get_profile();
michael@0:   gPolicy = new Experiments.Policy();
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:   patchPolicy(gPolicy, {
michael@0:     updatechannel: () => "nightly",
michael@0:     locale: () => "en-US",
michael@0:     healthReportPayload: () => Promise.resolve(payload),
michael@0:     random: () => 0.5,
michael@0:   });
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: 
michael@0:   let experiments = new Experiments.Experiments();
michael@0: });
michael@0: 
michael@0: function arraysEqual(a, b) {
michael@0:   if (a.length !== b.length) {
michael@0:     return false;
michael@0:   }
michael@0: 
michael@0:   for (let i=0; i<a.length; ++i) {
michael@0:     if (a[i] !== b[i]) {
michael@0:       return false;
michael@0:     }
michael@0:   }
michael@0: 
michael@0:   return true;
michael@0: }
michael@0: 
michael@0: // This function exists solely to be .toSource()d
michael@0: const sanityFilter = function filter(c) {
michael@0:   if (c.telemetryPayload === undefined) {
michael@0:     throw Error("No .telemetryPayload");
michael@0:   }
michael@0:   if (c.telemetryPayload.simpleMeasurements === undefined) {
michael@0:     throw Error("No .simpleMeasurements");
michael@0:   }
michael@0:   if (c.healthReportPayload === undefined) {
michael@0:     throw Error("No .healthReportPayload");
michael@0:   }
michael@0:   if (c.healthReportPayload.geckoAppInfo == undefined) {
michael@0:     throw Error("No .geckoAppInfo");
michael@0:   }
michael@0:   return true;
michael@0: }
michael@0: 
michael@0: add_task(function* test_simpleFields() {
michael@0:   let testData = [
michael@0:     // "expected applicable?", failure reason or null, manifest data
michael@0: 
michael@0:     // misc. environment
michael@0: 
michael@0:     [false, ["appName"], {appName: []}],
michael@0:     [false, ["appName"], {appName: ["foo", gAppInfo.name + "-invalid"]}],
michael@0:     [true,  null,        {appName: ["not-an-app-name", gAppInfo.name]}],
michael@0: 
michael@0:     [false, ["os"], {os: []}],
michael@0:     [false, ["os"], {os: ["42", "abcdef"]}],
michael@0:     [true,  null,   {os: [gAppInfo.OS, "plan9"]}],
michael@0: 
michael@0:     [false, ["channel"], {channel: []}],
michael@0:     [false, ["channel"], {channel: ["foo", gPolicy.updatechannel() + "-invalid"]}],
michael@0:     [true,  null,        {channel: ["not-a-channel", gPolicy.updatechannel()]}],
michael@0: 
michael@0:     [false, ["locale"], {locale: []}],
michael@0:     [false, ["locale"], {locale: ["foo", gPolicy.locale + "-invalid"]}],
michael@0:     [true,  null,       {locale: ["not-a-locale", gPolicy.locale()]}],
michael@0: 
michael@0:     // version
michael@0: 
michael@0:     [false, ["version"], {version: []}],
michael@0:     [false, ["version"], {version: ["-1", gAppInfo.version + "-invalid", "asdf", "0,4", "99.99", "0.1.1.1"]}],
michael@0:     [true,  null,        {version: ["99999999.999", "-1", gAppInfo.version]}],
michael@0: 
michael@0:     [false, ["minVersion"], {minVersion: "1.0.1"}],
michael@0:     [true,  null,           {minVersion: "1.0b1"}],
michael@0:     [true,  null,           {minVersion: "1.0"}],
michael@0:     [true,  null,           {minVersion: "0.9"}],
michael@0: 
michael@0:     [false, ["maxVersion"], {maxVersion: "0.1"}],
michael@0:     [false, ["maxVersion"], {maxVersion: "0.9.9"}],
michael@0:     [false, ["maxVersion"], {maxVersion: "1.0b1"}],
michael@0:     [true,  ["maxVersion"], {maxVersion: "1.0"}],
michael@0:     [true,  ["maxVersion"], {maxVersion: "1.7pre"}],
michael@0: 
michael@0:     // build id
michael@0: 
michael@0:     [false, ["buildIDs"], {buildIDs: []}],
michael@0:     [false, ["buildIDs"], {buildIDs: ["not-a-build-id", gAppInfo.platformBuildID + "-invalid"]}],
michael@0:     [true,  null,         {buildIDs: ["not-a-build-id", gAppInfo.platformBuildID]}],
michael@0: 
michael@0:     [true,  null,           {minBuildID: "2014060501"}],
michael@0:     [true,  null,           {minBuildID: "2014060601"}],
michael@0:     [false, ["minBuildID"], {minBuildID: "2014060701"}],
michael@0: 
michael@0:     [false, ["maxBuildID"], {maxBuildID: "2014010101"}],
michael@0:     [true,  null,           {maxBuildID: "2014060601"}],
michael@0:     [true,  null,           {maxBuildID: "2014060901"}],
michael@0: 
michael@0:     // sample
michael@0: 
michael@0:     [false, ["sample"], {sample: -1 }],
michael@0:     [false, ["sample"], {sample: 0.0}],
michael@0:     [false, ["sample"], {sample: 0.1}],
michael@0:     [true,  null,       {sample: 0.5}],
michael@0:     [true,  null,       {sample: 0.6}],
michael@0:     [true,  null,       {sample: 1.0}],
michael@0:     [true,  null,       {sample: 0.5}],
michael@0: 
michael@0:     // experiment control
michael@0: 
michael@0:     [false, ["disabled"], {disabled: true}],
michael@0:     [true,  null,         {disabled: false}],
michael@0: 
michael@0:     [false, ["frozen"], {frozen: true}],
michael@0:     [true,  null,       {frozen: false}],
michael@0: 
michael@0:     [false, null, {frozen: true,  disabled: true}],
michael@0:     [false, null, {frozen: true,  disabled: false}],
michael@0:     [false, null, {frozen: false, disabled: true}],
michael@0:     [true,  null, {frozen: false, disabled: false}],
michael@0: 
michael@0:     // jsfilter
michael@0: 
michael@0:     [true,  null, {jsfilter: "function filter(c) { return true; }"}],
michael@0:     [false, ["jsfilter-false"], {jsfilter: "function filter(c) { return false; }"}],
michael@0:     [true,  null, {jsfilter: "function filter(c) { return 123; }"}], // truthy
michael@0:     [false, ["jsfilter-false"], {jsfilter: "function filter(c) { return ''; }"}], // falsy
michael@0:     [false, ["jsfilter-false"], {jsfilter: "function filter(c) { var a = []; }"}], // undefined
michael@0:     [false, ["jsfilter-threw", "some error"], {jsfilter: "function filter(c) { throw new Error('some error'); }"}],
michael@0:     [false, ["jsfilter-evalfailed"], {jsfilter: "123, this won't work"}],
michael@0:     [true,  null, {jsfilter: "var filter = " + sanityFilter.toSource()}],
michael@0:   ];
michael@0: 
michael@0:   for (let i=0; i<testData.length; ++i) {
michael@0:     let entry = testData[i];
michael@0:     let applicable;
michael@0:     let reason = null;
michael@0: 
michael@0:     yield applicableFromManifestData(entry[2], gPolicy).then(
michael@0:       value => applicable = value,
michael@0:       value => {
michael@0:         applicable = false;
michael@0:         reason = value;
michael@0:       }
michael@0:     );
michael@0: 
michael@0:     Assert.equal(applicable, entry[0],
michael@0:       "Experiment entry applicability should match for test "
michael@0:       + i + ": " + JSON.stringify(entry[2]));
michael@0: 
michael@0:     let expectedReason = entry[1];
michael@0:     if (!applicable && expectedReason) {
michael@0:       Assert.ok(arraysEqual(reason, expectedReason),
michael@0:         "Experiment rejection reasons should match for test " + i + ". "
michael@0:         + "Got " + JSON.stringify(reason) + ", expected "
michael@0:         + JSON.stringify(expectedReason));
michael@0:     }
michael@0:   }
michael@0: });
michael@0: 
michael@0: add_task(function* test_times() {
michael@0:   let now = new Date(2014, 5, 6, 12);
michael@0:   let nowSec = now.getTime() / 1000;
michael@0:   let testData = [
michael@0:     // "expected applicable?", rejection reason or null, fake now date, manifest data
michael@0: 
michael@0:     // start time
michael@0: 
michael@0:     [true,  null, now,
michael@0:       {startTime: nowSec -  5 * SEC_IN_ONE_DAY,
michael@0:          endTime: nowSec + 10 * SEC_IN_ONE_DAY}],
michael@0:     [true,  null, now,
michael@0:       {startTime: nowSec ,
michael@0:          endTime: nowSec + 10 * SEC_IN_ONE_DAY}],
michael@0:     [false,  "startTime", now,
michael@0:       {startTime: nowSec +  5 * SEC_IN_ONE_DAY,
michael@0:          endTime: nowSec + 10 * SEC_IN_ONE_DAY}],
michael@0: 
michael@0:     // end time
michael@0: 
michael@0:     [false,  "endTime", now,
michael@0:       {startTime: nowSec -  5 * SEC_IN_ONE_DAY,
michael@0:          endTime: nowSec - 10 * SEC_IN_ONE_DAY}],
michael@0:     [false,  "endTime", now,
michael@0:       {startTime: nowSec -  5 * SEC_IN_ONE_DAY,
michael@0:          endTime: nowSec -  5 * SEC_IN_ONE_DAY}],
michael@0: 
michael@0:     // max start time
michael@0: 
michael@0:     [false,  "maxStartTime", now,
michael@0:       {maxStartTime: nowSec - 15 * SEC_IN_ONE_DAY,
michael@0:           startTime: nowSec - 10 * SEC_IN_ONE_DAY,
michael@0:             endTime: nowSec + 10 * SEC_IN_ONE_DAY}],
michael@0:     [false,  "maxStartTime", now,
michael@0:       {maxStartTime: nowSec -  1 * SEC_IN_ONE_DAY,
michael@0:           startTime: nowSec - 10 * SEC_IN_ONE_DAY,
michael@0:             endTime: nowSec + 10 * SEC_IN_ONE_DAY}],
michael@0:     [false,  "maxStartTime", now,
michael@0:       {maxStartTime: nowSec - 10 * SEC_IN_ONE_DAY,
michael@0:           startTime: nowSec - 10 * SEC_IN_ONE_DAY,
michael@0:             endTime: nowSec + 10 * SEC_IN_ONE_DAY}],
michael@0:     [true,  null, now,
michael@0:       {maxStartTime: nowSec,
michael@0:           startTime: nowSec - 10 * SEC_IN_ONE_DAY,
michael@0:             endTime: nowSec + 10 * SEC_IN_ONE_DAY}],
michael@0:     [true,  null, now,
michael@0:       {maxStartTime: nowSec +  1 * SEC_IN_ONE_DAY,
michael@0:           startTime: nowSec - 10 * SEC_IN_ONE_DAY,
michael@0:             endTime: nowSec + 10 * SEC_IN_ONE_DAY}],
michael@0: 
michael@0:     // max active seconds
michael@0: 
michael@0:     [true,  null, now,
michael@0:       {maxActiveSeconds:           5 * SEC_IN_ONE_DAY,
michael@0:               startTime: nowSec - 10 * SEC_IN_ONE_DAY,
michael@0:                 endTime: nowSec + 10 * SEC_IN_ONE_DAY}],
michael@0:     [true,  null, now,
michael@0:       {maxActiveSeconds:          10 * SEC_IN_ONE_DAY,
michael@0:               startTime: nowSec - 10 * SEC_IN_ONE_DAY,
michael@0:                 endTime: nowSec + 10 * SEC_IN_ONE_DAY}],
michael@0:     [true,  null, now,
michael@0:       {maxActiveSeconds:          15 * SEC_IN_ONE_DAY,
michael@0:               startTime: nowSec - 10 * SEC_IN_ONE_DAY,
michael@0:                 endTime: nowSec + 10 * SEC_IN_ONE_DAY}],
michael@0:     [true,  null, now,
michael@0:       {maxActiveSeconds:          20 * SEC_IN_ONE_DAY,
michael@0:               startTime: nowSec - 10 * SEC_IN_ONE_DAY,
michael@0:                 endTime: nowSec + 10 * SEC_IN_ONE_DAY}],
michael@0:   ];
michael@0: 
michael@0:   for (let i=0; i<testData.length; ++i) {
michael@0:     let entry = testData[i];
michael@0:     let applicable;
michael@0:     let reason = null;
michael@0:     defineNow(gPolicy, entry[2]);
michael@0: 
michael@0:     yield applicableFromManifestData(entry[3], gPolicy).then(
michael@0:       value => applicable = value,
michael@0:       value => {
michael@0:         applicable = false;
michael@0:         reason = value;
michael@0:       }
michael@0:     );
michael@0: 
michael@0:     Assert.equal(applicable, entry[0],
michael@0:       "Experiment entry applicability should match for test "
michael@0:       + i + ": " + JSON.stringify([entry[2], entry[3]]));
michael@0:     if (!applicable && entry[1]) {
michael@0:       Assert.equal(reason, entry[1], "Experiment rejection reason should match for test " + i);
michael@0:     }
michael@0:   }
michael@0: });