1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* This is a JavaScript module (JSM) to be imported via
* Components.utils.import() and acts as a singleton. Only the following
* listed symbols will exposed on import, and only when and where imported.
*/
var EXPORTED_SYMBOLS = ["ACTIONS", "TPS"];
const {classes: Cc, interfaces: Ci, utils: Cu} = Components;
var module = this;
// Global modules
Cu.import("resource://gre/modules/XPCOMUtils.jsm");
Cu.import("resource://gre/modules/Services.jsm");
Cu.import("resource://services-common/async.js");
Cu.import("resource://services-sync/constants.js");
Cu.import("resource://services-sync/main.js");
Cu.import("resource://services-sync/util.js");
// TPS modules
Cu.import("resource://tps/logger.jsm");
// Module wrappers for tests
Cu.import("resource://tps/modules/addons.jsm");
Cu.import("resource://tps/modules/bookmarks.jsm");
Cu.import("resource://tps/modules/forms.jsm");
Cu.import("resource://tps/modules/history.jsm");
Cu.import("resource://tps/modules/passwords.jsm");
Cu.import("resource://tps/modules/prefs.jsm");
Cu.import("resource://tps/modules/tabs.jsm");
Cu.import("resource://tps/modules/windows.jsm");
var hh = Cc["@mozilla.org/network/protocol;1?name=http"]
.getService(Ci.nsIHttpProtocolHandler);
var prefs = Cc["@mozilla.org/preferences-service;1"]
.getService(Ci.nsIPrefBranch);
var mozmillInit = {};
Cu.import('resource://mozmill/driver/mozmill.js', mozmillInit);
// Options for wiping data during a sync
const SYNC_RESET_CLIENT = "resetClient";
const SYNC_WIPE_CLIENT = "wipeClient";
const SYNC_WIPE_REMOTE = "wipeRemote";
// Actions a test can perform
const ACTION_ADD = "add";
const ACTION_DELETE = "delete";
const ACTION_MODIFY = "modify";
const ACTION_PRIVATE_BROWSING = "private-browsing";
const ACTION_SET_ENABLED = "set-enabled";
const ACTION_SYNC = "sync";
const ACTION_SYNC_RESET_CLIENT = SYNC_RESET_CLIENT;
const ACTION_SYNC_WIPE_CLIENT = SYNC_WIPE_CLIENT;
const ACTION_SYNC_WIPE_REMOTE = SYNC_WIPE_REMOTE;
const ACTION_VERIFY = "verify";
const ACTION_VERIFY_NOT = "verify-not";
const ACTIONS = [
ACTION_ADD,
ACTION_DELETE,
ACTION_MODIFY,
ACTION_PRIVATE_BROWSING,
ACTION_SET_ENABLED,
ACTION_SYNC,
ACTION_SYNC_RESET_CLIENT,
ACTION_SYNC_WIPE_CLIENT,
ACTION_SYNC_WIPE_REMOTE,
ACTION_VERIFY,
ACTION_VERIFY_NOT,
];
const OBSERVER_TOPICS = ["fxaccounts:onlogin",
"fxaccounts:onlogout",
"private-browsing",
"quit-application-requested",
"sessionstore-windows-restored",
"weave:engine:start-tracking",
"weave:engine:stop-tracking",
"weave:service:login:error",
"weave:service:setup-complete",
"weave:service:sync:finish",
"weave:service:sync:delayed",
"weave:service:sync:error",
"weave:service:sync:start"
];
var TPS = {
_currentAction: -1,
_currentPhase: -1,
_enabledEngines: null,
_errors: 0,
_finalPhase: false,
_isTracking: false,
_operations_pending: 0,
_phaseFinished: false,
_phaselist: {},
_setupComplete: false,
_syncActive: false,
_syncErrors: 0,
_syncWipeAction: null,
_tabsAdded: 0,
_tabsFinished: 0,
_test: null,
_triggeredSync: false,
_usSinceEpoch: 0,
_init: function TPS__init() {
// Check if Firefox Accounts is enabled
let service = Cc["@mozilla.org/weave/service;1"]
.getService(Components.interfaces.nsISupports)
.wrappedJSObject;
this.fxaccounts_enabled = service.fxAccountsEnabled;
this.delayAutoSync();
OBSERVER_TOPICS.forEach(function (aTopic) {
Services.obs.addObserver(this, aTopic, true);
}, this);
// Import the appropriate authentication module
if (this.fxaccounts_enabled) {
Cu.import("resource://tps/auth/fxaccounts.jsm", module);
}
else {
Cu.import("resource://tps/auth/sync.jsm", module);
}
},
DumpError: function TPS__DumpError(msg) {
this._errors++;
Logger.logError("[phase" + this._currentPhase + "] " + msg);
this.quit();
},
QueryInterface: XPCOMUtils.generateQI([Ci.nsIObserver,
Ci.nsISupportsWeakReference]),
observe: function TPS__observe(subject, topic, data) {
try {
Logger.logInfo("----------event observed: " + topic);
switch(topic) {
case "private-browsing":
Logger.logInfo("private browsing " + data);
break;
case "quit-application-requested":
// Ensure that we eventually wipe the data on the server
if (this._errors || !this._phaseFinished || this._finalPhase) {
try {
this.WipeServer();
} catch (ex) {}
}
OBSERVER_TOPICS.forEach(function(topic) {
Services.obs.removeObserver(this, topic);
}, this);
Logger.close();
break;
case "sessionstore-windows-restored":
Utils.nextTick(this.RunNextTestAction, this);
break;
case "weave:service:setup-complete":
this._setupComplete = true;
if (this._syncWipeAction) {
Weave.Svc.Prefs.set("firstSync", this._syncWipeAction);
this._syncWipeAction = null;
}
break;
case "weave:service:sync:error":
this._syncActive = false;
this.delayAutoSync();
// If this is the first sync error, retry...
if (this._syncErrors === 0) {
Logger.logInfo("Sync error; retrying...");
this._syncErrors++;
Utils.nextTick(this.RunNextTestAction, this);
}
else {
this._triggeredSync = false;
this.DumpError("Sync error; aborting test");
return;
}
break;
case "weave:service:sync:finish":
this._syncActive = false;
this._syncErrors = 0;
this._triggeredSync = false;
this.delayAutoSync();
// Wait a second before continuing, otherwise we can get
// 'sync not complete' errors.
Utils.namedTimer(function () {
this.FinishAsyncOperation();
}, 1000, this, "postsync");
break;
case "weave:service:sync:start":
// Ensure that the sync operation has been started by TPS
if (!this._triggeredSync) {
this.DumpError("Automatic sync got triggered, which is not allowed.")
}
this._syncActive = true;
break;
case "weave:engine:start-tracking":
this._isTracking = true;
break;
case "weave:engine:stop-tracking":
this._isTracking = false;
break;
}
}
catch (e) {
this.DumpError("Exception caught: " + Utils.exceptionStr(e));
return;
}
},
/**
* Given that we cannot complely disable the automatic sync operations, we
* massively delay the next sync. Sync operations have to only happen when
* directly called via TPS.Sync()!
*/
delayAutoSync: function TPS_delayAutoSync() {
Weave.Svc.Prefs.set("scheduler.eolInterval", 7200);
Weave.Svc.Prefs.set("scheduler.immediateInterval", 7200);
Weave.Svc.Prefs.set("scheduler.idleInterval", 7200);
Weave.Svc.Prefs.set("scheduler.activeInterval", 7200);
Weave.Svc.Prefs.set("syncThreshold", 10000000);
},
StartAsyncOperation: function TPS__StartAsyncOperation() {
this._operations_pending++;
},
FinishAsyncOperation: function TPS__FinishAsyncOperation() {
this._operations_pending--;
if (!this.operations_pending) {
this._currentAction++;
Utils.nextTick(function() {
this.RunNextTestAction();
}, this);
}
},
quit: function TPS__quit() {
this.goQuitApplication();
},
HandleWindows: function (aWindow, action) {
Logger.logInfo("executing action " + action.toUpperCase() +
" on window " + JSON.stringify(aWindow));
switch(action) {
case ACTION_ADD:
BrowserWindows.Add(aWindow.private, function(win) {
Logger.logInfo("window finished loading");
this.FinishAsyncOperation();
}.bind(this));
break;
}
Logger.logPass("executing action " + action.toUpperCase() + " on windows");
},
HandleTabs: function (tabs, action) {
this._tabsAdded = tabs.length;
this._tabsFinished = 0;
for (let tab of tabs) {
Logger.logInfo("executing action " + action.toUpperCase() +
" on tab " + JSON.stringify(tab));
switch(action) {
case ACTION_ADD:
// When adding tabs, we keep track of how many tabs we're adding,
// and wait until we've received that many onload events from our
// new tabs before continuing
let that = this;
let taburi = tab.uri;
BrowserTabs.Add(tab.uri, function() {
that._tabsFinished++;
Logger.logInfo("tab for " + taburi + " finished loading");
if (that._tabsFinished == that._tabsAdded) {
Logger.logInfo("all tabs loaded, continuing...");
// Wait a second before continuing to be sure tabs can be synced,
// otherwise we can get 'error locating tab'
Utils.namedTimer(function () {
that.FinishAsyncOperation();
}, 1000, this, "postTabsOpening");
}
});
break;
case ACTION_VERIFY:
Logger.AssertTrue(typeof(tab.profile) != "undefined",
"profile must be defined when verifying tabs");
Logger.AssertTrue(
BrowserTabs.Find(tab.uri, tab.title, tab.profile), "error locating tab");
break;
case ACTION_VERIFY_NOT:
Logger.AssertTrue(typeof(tab.profile) != "undefined",
"profile must be defined when verifying tabs");
Logger.AssertTrue(
!BrowserTabs.Find(tab.uri, tab.title, tab.profile),
"tab found which was expected to be absent");
break;
default:
Logger.AssertTrue(false, "invalid action: " + action);
}
}
Logger.logPass("executing action " + action.toUpperCase() + " on tabs");
},
HandlePrefs: function (prefs, action) {
for (let pref of prefs) {
Logger.logInfo("executing action " + action.toUpperCase() +
" on pref " + JSON.stringify(pref));
let preference = new Preference(pref);
switch(action) {
case ACTION_MODIFY:
preference.Modify();
break;
case ACTION_VERIFY:
preference.Find();
break;
default:
Logger.AssertTrue(false, "invalid action: " + action);
}
}
Logger.logPass("executing action " + action.toUpperCase() + " on pref");
},
HandleForms: function (data, action) {
for (let datum of data) {
Logger.logInfo("executing action " + action.toUpperCase() +
" on form entry " + JSON.stringify(datum));
let formdata = new FormData(datum, this._usSinceEpoch);
switch(action) {
case ACTION_ADD:
formdata.Create();
break;
case ACTION_DELETE:
formdata.Remove();
break;
case ACTION_VERIFY:
Logger.AssertTrue(formdata.Find(), "form data not found");
break;
case ACTION_VERIFY_NOT:
Logger.AssertTrue(!formdata.Find(),
"form data found, but it shouldn't be present");
break;
default:
Logger.AssertTrue(false, "invalid action: " + action);
}
}
Logger.logPass("executing action " + action.toUpperCase() +
" on formdata");
},
HandleHistory: function (entries, action) {
try {
for (let entry of entries) {
Logger.logInfo("executing action " + action.toUpperCase() +
" on history entry " + JSON.stringify(entry));
switch(action) {
case ACTION_ADD:
HistoryEntry.Add(entry, this._usSinceEpoch);
break;
case ACTION_DELETE:
HistoryEntry.Delete(entry, this._usSinceEpoch);
break;
case ACTION_VERIFY:
Logger.AssertTrue(HistoryEntry.Find(entry, this._usSinceEpoch),
"Uri visits not found in history database");
break;
case ACTION_VERIFY_NOT:
Logger.AssertTrue(!HistoryEntry.Find(entry, this._usSinceEpoch),
"Uri visits found in history database, but they shouldn't be");
break;
default:
Logger.AssertTrue(false, "invalid action: " + action);
}
}
Logger.logPass("executing action " + action.toUpperCase() +
" on history");
}
catch(e) {
DumpHistory();
throw(e);
}
},
HandlePasswords: function (passwords, action) {
try {
for (let password of passwords) {
let password_id = -1;
Logger.logInfo("executing action " + action.toUpperCase() +
" on password " + JSON.stringify(password));
var password = new Password(password);
switch (action) {
case ACTION_ADD:
Logger.AssertTrue(password.Create() > -1, "error adding password");
break;
case ACTION_VERIFY:
Logger.AssertTrue(password.Find() != -1, "password not found");
break;
case ACTION_VERIFY_NOT:
Logger.AssertTrue(password.Find() == -1,
"password found, but it shouldn't exist");
break;
case ACTION_DELETE:
Logger.AssertTrue(password.Find() != -1, "password not found");
password.Remove();
break;
case ACTION_MODIFY:
if (password.updateProps != null) {
Logger.AssertTrue(password.Find() != -1, "password not found");
password.Update();
}
break;
default:
Logger.AssertTrue(false, "invalid action: " + action);
}
}
Logger.logPass("executing action " + action.toUpperCase() +
" on passwords");
}
catch(e) {
DumpPasswords();
throw(e);
}
},
HandleAddons: function (addons, action, state) {
for (let entry of addons) {
Logger.logInfo("executing action " + action.toUpperCase() +
" on addon " + JSON.stringify(entry));
let addon = new Addon(this, entry);
switch(action) {
case ACTION_ADD:
addon.install();
break;
case ACTION_DELETE:
addon.uninstall();
break;
case ACTION_VERIFY:
Logger.AssertTrue(addon.find(state), 'addon ' + addon.id + ' not found');
break;
case ACTION_VERIFY_NOT:
Logger.AssertFalse(addon.find(state), 'addon ' + addon.id + " is present, but it shouldn't be");
break;
case ACTION_SET_ENABLED:
Logger.AssertTrue(addon.setEnabled(state), 'addon ' + addon.id + ' not found');
break;
default:
throw new Error("Unknown action for add-on: " + action);
}
}
Logger.logPass("executing action " + action.toUpperCase() +
" on addons");
},
HandleBookmarks: function (bookmarks, action) {
try {
let items = [];
for (folder in bookmarks) {
let last_item_pos = -1;
for (let bookmark of bookmarks[folder]) {
Logger.clearPotentialError();
let placesItem;
bookmark['location'] = folder;
if (last_item_pos != -1)
bookmark['last_item_pos'] = last_item_pos;
let item_id = -1;
if (action != ACTION_MODIFY && action != ACTION_DELETE)
Logger.logInfo("executing action " + action.toUpperCase() +
" on bookmark " + JSON.stringify(bookmark));
if ("uri" in bookmark)
placesItem = new Bookmark(bookmark);
else if ("folder" in bookmark)
placesItem = new BookmarkFolder(bookmark);
else if ("livemark" in bookmark)
placesItem = new Livemark(bookmark);
else if ("separator" in bookmark)
placesItem = new Separator(bookmark);
if (action == ACTION_ADD) {
item_id = placesItem.Create();
}
else {
item_id = placesItem.Find();
if (action == ACTION_VERIFY_NOT) {
Logger.AssertTrue(item_id == -1,
"places item exists but it shouldn't: " +
JSON.stringify(bookmark));
}
else
Logger.AssertTrue(item_id != -1, "places item not found", true);
}
last_item_pos = placesItem.GetItemIndex();
items.push(placesItem);
}
}
if (action == ACTION_DELETE || action == ACTION_MODIFY) {
for (let item of items) {
Logger.logInfo("executing action " + action.toUpperCase() +
" on bookmark " + JSON.stringify(item));
switch(action) {
case ACTION_DELETE:
item.Remove();
break;
case ACTION_MODIFY:
if (item.updateProps != null)
item.Update();
break;
}
}
}
Logger.logPass("executing action " + action.toUpperCase() +
" on bookmarks");
}
catch (e) {
DumpBookmarks();
throw(e);
}
},
MozmillEndTestListener: function TPS__MozmillEndTestListener(obj) {
Logger.logInfo("mozmill endTest: " + JSON.stringify(obj));
if (obj.failed > 0) {
this.DumpError('mozmill test failed, name: ' + obj.name + ', reason: ' + JSON.stringify(obj.fails));
return;
}
else if ('skipped' in obj && obj.skipped) {
this.DumpError('mozmill test failed, name: ' + obj.name + ', reason: ' + obj.skipped_reason);
return;
}
else {
Utils.namedTimer(function() {
this.FinishAsyncOperation();
}, 2000, this, "postmozmilltest");
}
},
MozmillSetTestListener: function TPS__MozmillSetTestListener(obj) {
Logger.logInfo("mozmill setTest: " + obj.name);
},
RunNextTestAction: function() {
try {
if (this._currentAction >=
this._phaselist["phase" + this._currentPhase].length) {
// we're all done
Logger.logInfo("test phase " + this._currentPhase + ": " +
(this._errors ? "FAIL" : "PASS"));
this._phaseFinished = true;
this.quit();
return;
}
if (this.seconds_since_epoch)
this._usSinceEpoch = this.seconds_since_epoch * 1000 * 1000;
else {
this.DumpError("seconds-since-epoch not set");
return;
}
let phase = this._phaselist["phase" + this._currentPhase];
let action = phase[this._currentAction];
Logger.logInfo("starting action: " + action[0].name);
action[0].apply(this, action.slice(1));
// if we're in an async operation, don't continue on to the next action
if (this._operations_pending)
return;
this._currentAction++;
}
catch(e) {
this.DumpError("Exception caught: " + Utils.exceptionStr(e));
return;
}
this.RunNextTestAction();
},
/**
* Runs a single test phase.
*
* This is the main entry point for each phase of a test. The TPS command
* line driver loads this module and calls into the function with the
* arguments from the command line.
*
* When a phase is executed, the file is loaded as JavaScript into the
* current object.
*
* The following keys in the options argument have meaning:
*
* - ignoreUnusedEngines If true, unused engines will be unloaded from
* Sync. This makes output easier to parse and is
* useful for debugging test failures.
*
* @param file
* String URI of the file to open.
* @param phase
* String name of the phase to run.
* @param logpath
* String path of the log file to write to.
* @param options
* Object defining addition run-time options.
*/
RunTestPhase: function (file, phase, logpath, options) {
try {
let settings = options || {};
Logger.init(logpath);
Logger.logInfo("Sync version: " + WEAVE_VERSION);
Logger.logInfo("Firefox buildid: " + Services.appinfo.appBuildID);
Logger.logInfo("Firefox version: " + Services.appinfo.version);
Logger.logInfo('Firefox Accounts enabled: ' + this.fxaccounts_enabled);
// do some sync housekeeping
if (Weave.Service.isLoggedIn) {
this.DumpError("Sync logged in on startup...profile may be dirty");
return;
}
// Wait for Sync service to become ready.
if (!Weave.Status.ready) {
this.waitForEvent("weave:service:ready");
}
// Always give Sync an extra tick to initialize. If we waited for the
// service:ready event, this is required to ensure all handlers have
// executed.
Utils.nextTick(this._executeTestPhase.bind(this, file, phase, settings));
} catch(e) {
this.DumpError("Exception caught: " + Utils.exceptionStr(e));
return;
}
},
/**
* Executes a single test phase.
*
* This is called by RunTestPhase() after the environment is validated.
*/
_executeTestPhase: function _executeTestPhase(file, phase, settings) {
try {
// parse the test file
Services.scriptloader.loadSubScript(file, this);
this._currentPhase = phase;
let this_phase = this._phaselist["phase" + this._currentPhase];
if (this_phase == undefined) {
this.DumpError("invalid phase " + this._currentPhase);
return;
}
if (this.phases["phase" + this._currentPhase] == undefined) {
this.DumpError("no profile defined for phase " + this._currentPhase);
return;
}
// If we have restricted the active engines, unregister engines we don't
// care about.
if (settings.ignoreUnusedEngines && Array.isArray(this._enabledEngines)) {
let names = {};
for (let name of this._enabledEngines) {
names[name] = true;
}
for (let engine of Weave.Service.engineManager.getEnabled()) {
if (!(engine.name in names)) {
Logger.logInfo("Unregistering unused engine: " + engine.name);
Weave.Service.engineManager.unregister(engine);
}
}
}
Logger.logInfo("Starting phase " + parseInt(phase, 10) + "/" +
Object.keys(this._phaselist).length);
Logger.logInfo("setting client.name to " + this.phases["phase" + this._currentPhase]);
Weave.Svc.Prefs.set("client.name", this.phases["phase" + this._currentPhase]);
// TODO Phases should be defined in a data type that has strong
// ordering, not by lexical sorting.
let currentPhase = parseInt(this._currentPhase, 10);
// Login at the beginning of the test.
if (currentPhase <= 1) {
this_phase.unshift([this.Login]);
}
// Wipe the server at the end of the final test phase.
if (currentPhase >= Object.keys(this.phases).length) {
this._finalPhase = true;
}
// If a custom server was specified, set it now
if (this.config["serverURL"]) {
Weave.Service.serverURL = this.config.serverURL;
prefs.setCharPref('tps.serverURL', this.config.serverURL);
}
// Store account details as prefs so they're accessible to the Mozmill
// framework.
if (this.fxaccounts_enabled) {
prefs.setCharPref('tps.account.username', this.config.fx_account.username);
prefs.setCharPref('tps.account.password', this.config.fx_account.password);
}
else {
prefs.setCharPref('tps.account.username', this.config.sync_account.username);
prefs.setCharPref('tps.account.password', this.config.sync_account.password);
prefs.setCharPref('tps.account.passphrase', this.config.sync_account.passphrase);
}
// start processing the test actions
this._currentAction = 0;
}
catch(e) {
this.DumpError("Exception caught: " + Utils.exceptionStr(e));
return;
}
},
/**
* Register a single phase with the test harness.
*
* This is called when loading individual test files.
*
* @param phasename
* String name of the phase being loaded.
* @param fnlist
* Array of functions/actions to perform.
*/
Phase: function Test__Phase(phasename, fnlist) {
this._phaselist[phasename] = fnlist;
},
/**
* Restrict enabled Sync engines to a specified set.
*
* This can be called by a test to limit what engines are enabled. It is
* recommended to call it to reduce the overhead and log clutter for the
* test.
*
* The "clients" engine is special and is always enabled, so there is no
* need to specify it.
*
* @param names
* Array of Strings for engines to make active during the test.
*/
EnableEngines: function EnableEngines(names) {
if (!Array.isArray(names)) {
throw new Error("Argument to RestrictEngines() is not an array: "
+ typeof(names));
}
this._enabledEngines = names;
},
RunMozmillTest: function TPS__RunMozmillTest(testfile) {
var mozmillfile = Cc["@mozilla.org/file/local;1"]
.createInstance(Ci.nsILocalFile);
if (hh.oscpu.toLowerCase().indexOf('windows') > -1) {
let re = /\/(\w)\/(.*)/;
this.config.testdir = this.config.testdir.replace(re, "$1://$2").replace(/\//g, "\\");
}
mozmillfile.initWithPath(this.config.testdir);
mozmillfile.appendRelativePath(testfile);
Logger.logInfo("Running mozmill test " + mozmillfile.path);
var frame = {};
Cu.import('resource://mozmill/modules/frame.js', frame);
frame.events.addListener('setTest', this.MozmillSetTestListener.bind(this));
frame.events.addListener('endTest', this.MozmillEndTestListener.bind(this));
this.StartAsyncOperation();
frame.runTestFile(mozmillfile.path, null);
},
/**
* Synchronously wait for the named event to be observed.
*
* When the event is observed, the function will wait an extra tick before
* returning.
*
* @param aEventName
* String event to wait for.
*/
waitForEvent: function waitForEvent(aEventName) {
Logger.logInfo("Waiting for " + aEventName + "...");
let cb = Async.makeSpinningCallback();
Svc.Obs.add(aEventName, cb);
cb.wait();
Svc.Obs.remove(aEventName, cb);
Logger.logInfo(aEventName + " observed!");
cb = Async.makeSpinningCallback();
Utils.nextTick(cb);
cb.wait();
},
/**
* Waits for Sync to logged in before returning
*/
waitForSetupComplete: function waitForSetup() {
if (!this._setupComplete) {
this.waitForEvent("weave:service:setup-complete");
}
},
/**
* Waits for Sync to be finished before returning
*/
waitForSyncFinished: function TPS__waitForSyncFinished() {
if (this._syncActive) {
this.waitForEvent("weave:service:sync:finished");
}
},
/**
* Waits for Sync to start tracking before returning.
*/
waitForTracking: function waitForTracking() {
if (!this._isTracking) {
this.waitForEvent("weave:engine:start-tracking");
}
},
/**
* Login on the server
*/
Login: function Login(force) {
if (Authentication.isLoggedIn && !force) {
return;
}
Logger.logInfo("Setting client credentials and login.");
let account = this.fxaccounts_enabled ? this.config.fx_account
: this.config.sync_account;
Authentication.signIn(account);
this.waitForSetupComplete();
Logger.AssertEqual(Weave.Status.service, Weave.STATUS_OK, "Weave status OK");
this.waitForTracking();
},
/**
* Triggers a sync operation
*
* @param {String} [wipeAction]
* Type of wipe to perform (resetClient, wipeClient, wipeRemote)
*
*/
Sync: function TPS__Sync(wipeAction) {
Logger.logInfo("Executing Sync" + (wipeAction ? ": " + wipeAction : ""));
// Force a wipe action if requested. In case of an initial sync the pref
// will be overwritten by Sync itself (see bug 992198), so ensure that we
// also handle it via the "weave:service:setup-complete" notification.
if (wipeAction) {
this._syncWipeAction = wipeAction;
Weave.Svc.Prefs.set("firstSync", wipeAction);
}
else {
Weave.Svc.Prefs.reset("firstSync");
}
this.Login(false);
this._triggeredSync = true;
this.StartAsyncOperation();
Weave.Service.sync();
},
WipeServer: function TPS__WipeServer() {
Logger.logInfo("Wiping data from server.");
this.Login(false);
Weave.Service.login();
Weave.Service.wipeServer();
},
/**
* Action which ensures changes are being tracked before returning.
*/
EnsureTracking: function EnsureTracking() {
this.Login(false);
this.waitForTracking();
}
};
var Addons = {
install: function Addons__install(addons) {
TPS.HandleAddons(addons, ACTION_ADD);
},
setEnabled: function Addons__setEnabled(addons, state) {
TPS.HandleAddons(addons, ACTION_SET_ENABLED, state);
},
uninstall: function Addons__uninstall(addons) {
TPS.HandleAddons(addons, ACTION_DELETE);
},
verify: function Addons__verify(addons, state) {
TPS.HandleAddons(addons, ACTION_VERIFY, state);
},
verifyNot: function Addons__verifyNot(addons) {
TPS.HandleAddons(addons, ACTION_VERIFY_NOT);
},
};
var Bookmarks = {
add: function Bookmarks__add(bookmarks) {
TPS.HandleBookmarks(bookmarks, ACTION_ADD);
},
modify: function Bookmarks__modify(bookmarks) {
TPS.HandleBookmarks(bookmarks, ACTION_MODIFY);
},
delete: function Bookmarks__delete(bookmarks) {
TPS.HandleBookmarks(bookmarks, ACTION_DELETE);
},
verify: function Bookmarks__verify(bookmarks) {
TPS.HandleBookmarks(bookmarks, ACTION_VERIFY);
},
verifyNot: function Bookmarks__verifyNot(bookmarks) {
TPS.HandleBookmarks(bookmarks, ACTION_VERIFY_NOT);
}
};
var Formdata = {
add: function Formdata__add(formdata) {
this.HandleForms(formdata, ACTION_ADD);
},
delete: function Formdata__delete(formdata) {
this.HandleForms(formdata, ACTION_DELETE);
},
verify: function Formdata__verify(formdata) {
this.HandleForms(formdata, ACTION_VERIFY);
},
verifyNot: function Formdata__verifyNot(formdata) {
this.HandleForms(formdata, ACTION_VERIFY_NOT);
}
};
var History = {
add: function History__add(history) {
this.HandleHistory(history, ACTION_ADD);
},
delete: function History__delete(history) {
this.HandleHistory(history, ACTION_DELETE);
},
verify: function History__verify(history) {
this.HandleHistory(history, ACTION_VERIFY);
},
verifyNot: function History__verifyNot(history) {
this.HandleHistory(history, ACTION_VERIFY_NOT);
}
};
var Passwords = {
add: function Passwords__add(passwords) {
this.HandlePasswords(passwords, ACTION_ADD);
},
modify: function Passwords__modify(passwords) {
this.HandlePasswords(passwords, ACTION_MODIFY);
},
delete: function Passwords__delete(passwords) {
this.HandlePasswords(passwords, ACTION_DELETE);
},
verify: function Passwords__verify(passwords) {
this.HandlePasswords(passwords, ACTION_VERIFY);
},
verifyNot: function Passwords__verifyNot(passwords) {
this.HandlePasswords(passwords, ACTION_VERIFY_NOT);
}
};
var Prefs = {
modify: function Prefs__modify(prefs) {
TPS.HandlePrefs(prefs, ACTION_MODIFY);
},
verify: function Prefs__verify(prefs) {
TPS.HandlePrefs(prefs, ACTION_VERIFY);
}
};
var Tabs = {
add: function Tabs__add(tabs) {
TPS.StartAsyncOperation();
TPS.HandleTabs(tabs, ACTION_ADD);
},
verify: function Tabs__verify(tabs) {
TPS.HandleTabs(tabs, ACTION_VERIFY);
},
verifyNot: function Tabs__verifyNot(tabs) {
TPS.HandleTabs(tabs, ACTION_VERIFY_NOT);
}
};
var Windows = {
add: function Window__add(aWindow) {
TPS.StartAsyncOperation();
TPS.HandleWindows(aWindow, ACTION_ADD);
},
};
// Initialize TPS
TPS._init();
|