Wed, 31 Dec 2014 07:22:50 +0100
Correct previous dual key logic pending first delivery installment.
michael@0 | 1 | /* Any copyright is dedicated to the Public Domain. |
michael@0 | 2 | http://creativecommons.org/publicdomain/zero/1.0/ */ |
michael@0 | 3 | |
michael@0 | 4 | Cu.import("resource://services-common/observers.js"); |
michael@0 | 5 | Cu.import("resource://services-sync/engines.js"); |
michael@0 | 6 | Cu.import("resource://services-sync/service.js"); |
michael@0 | 7 | Cu.import("resource://services-sync/util.js"); |
michael@0 | 8 | |
michael@0 | 9 | function SteamStore(engine) { |
michael@0 | 10 | Store.call(this, "Steam", engine); |
michael@0 | 11 | this.wasWiped = false; |
michael@0 | 12 | } |
michael@0 | 13 | SteamStore.prototype = { |
michael@0 | 14 | __proto__: Store.prototype, |
michael@0 | 15 | |
michael@0 | 16 | wipe: function() { |
michael@0 | 17 | this.wasWiped = true; |
michael@0 | 18 | } |
michael@0 | 19 | }; |
michael@0 | 20 | |
michael@0 | 21 | function SteamTracker(name, engine) { |
michael@0 | 22 | Tracker.call(this, name || "Steam", engine); |
michael@0 | 23 | } |
michael@0 | 24 | SteamTracker.prototype = { |
michael@0 | 25 | __proto__: Tracker.prototype |
michael@0 | 26 | }; |
michael@0 | 27 | |
michael@0 | 28 | function SteamEngine(service) { |
michael@0 | 29 | Engine.call(this, "Steam", service); |
michael@0 | 30 | this.wasReset = false; |
michael@0 | 31 | this.wasSynced = false; |
michael@0 | 32 | } |
michael@0 | 33 | SteamEngine.prototype = { |
michael@0 | 34 | __proto__: Engine.prototype, |
michael@0 | 35 | _storeObj: SteamStore, |
michael@0 | 36 | _trackerObj: SteamTracker, |
michael@0 | 37 | |
michael@0 | 38 | _resetClient: function () { |
michael@0 | 39 | this.wasReset = true; |
michael@0 | 40 | }, |
michael@0 | 41 | |
michael@0 | 42 | _sync: function () { |
michael@0 | 43 | this.wasSynced = true; |
michael@0 | 44 | } |
michael@0 | 45 | }; |
michael@0 | 46 | |
michael@0 | 47 | let engineObserver = { |
michael@0 | 48 | topics: [], |
michael@0 | 49 | |
michael@0 | 50 | observe: function(subject, topic, data) { |
michael@0 | 51 | do_check_eq(data, "steam"); |
michael@0 | 52 | this.topics.push(topic); |
michael@0 | 53 | }, |
michael@0 | 54 | |
michael@0 | 55 | reset: function() { |
michael@0 | 56 | this.topics = []; |
michael@0 | 57 | } |
michael@0 | 58 | }; |
michael@0 | 59 | Observers.add("weave:engine:reset-client:start", engineObserver); |
michael@0 | 60 | Observers.add("weave:engine:reset-client:finish", engineObserver); |
michael@0 | 61 | Observers.add("weave:engine:wipe-client:start", engineObserver); |
michael@0 | 62 | Observers.add("weave:engine:wipe-client:finish", engineObserver); |
michael@0 | 63 | Observers.add("weave:engine:sync:start", engineObserver); |
michael@0 | 64 | Observers.add("weave:engine:sync:finish", engineObserver); |
michael@0 | 65 | |
michael@0 | 66 | function run_test() { |
michael@0 | 67 | run_next_test(); |
michael@0 | 68 | } |
michael@0 | 69 | |
michael@0 | 70 | add_test(function test_members() { |
michael@0 | 71 | _("Engine object members"); |
michael@0 | 72 | let engine = new SteamEngine(Service); |
michael@0 | 73 | do_check_eq(engine.Name, "Steam"); |
michael@0 | 74 | do_check_eq(engine.prefName, "steam"); |
michael@0 | 75 | do_check_true(engine._store instanceof SteamStore); |
michael@0 | 76 | do_check_true(engine._tracker instanceof SteamTracker); |
michael@0 | 77 | run_next_test(); |
michael@0 | 78 | }); |
michael@0 | 79 | |
michael@0 | 80 | add_test(function test_score() { |
michael@0 | 81 | _("Engine.score corresponds to tracker.score and is readonly"); |
michael@0 | 82 | let engine = new SteamEngine(Service); |
michael@0 | 83 | do_check_eq(engine.score, 0); |
michael@0 | 84 | engine._tracker.score += 5; |
michael@0 | 85 | do_check_eq(engine.score, 5); |
michael@0 | 86 | |
michael@0 | 87 | try { |
michael@0 | 88 | engine.score = 10; |
michael@0 | 89 | } catch(ex) { |
michael@0 | 90 | // Setting an attribute that has a getter produces an error in |
michael@0 | 91 | // Firefox <= 3.6 and is ignored in later versions. Either way, |
michael@0 | 92 | // the attribute's value won't change. |
michael@0 | 93 | } |
michael@0 | 94 | do_check_eq(engine.score, 5); |
michael@0 | 95 | run_next_test(); |
michael@0 | 96 | }); |
michael@0 | 97 | |
michael@0 | 98 | add_test(function test_resetClient() { |
michael@0 | 99 | _("Engine.resetClient calls _resetClient"); |
michael@0 | 100 | let engine = new SteamEngine(Service); |
michael@0 | 101 | do_check_false(engine.wasReset); |
michael@0 | 102 | |
michael@0 | 103 | engine.resetClient(); |
michael@0 | 104 | do_check_true(engine.wasReset); |
michael@0 | 105 | do_check_eq(engineObserver.topics[0], "weave:engine:reset-client:start"); |
michael@0 | 106 | do_check_eq(engineObserver.topics[1], "weave:engine:reset-client:finish"); |
michael@0 | 107 | |
michael@0 | 108 | engine.wasReset = false; |
michael@0 | 109 | engineObserver.reset(); |
michael@0 | 110 | run_next_test(); |
michael@0 | 111 | }); |
michael@0 | 112 | |
michael@0 | 113 | add_test(function test_invalidChangedIDs() { |
michael@0 | 114 | _("Test that invalid changed IDs on disk don't end up live."); |
michael@0 | 115 | let engine = new SteamEngine(Service); |
michael@0 | 116 | let tracker = engine._tracker; |
michael@0 | 117 | tracker.changedIDs = 5; |
michael@0 | 118 | tracker.saveChangedIDs(function onSaved() { |
michael@0 | 119 | tracker.changedIDs = {placeholder: true}; |
michael@0 | 120 | tracker.loadChangedIDs(function onLoaded(json) { |
michael@0 | 121 | do_check_null(json); |
michael@0 | 122 | do_check_true(tracker.changedIDs.placeholder); |
michael@0 | 123 | run_next_test(); |
michael@0 | 124 | }); |
michael@0 | 125 | }); |
michael@0 | 126 | }); |
michael@0 | 127 | |
michael@0 | 128 | add_test(function test_wipeClient() { |
michael@0 | 129 | _("Engine.wipeClient calls resetClient, wipes store, clears changed IDs"); |
michael@0 | 130 | let engine = new SteamEngine(Service); |
michael@0 | 131 | do_check_false(engine.wasReset); |
michael@0 | 132 | do_check_false(engine._store.wasWiped); |
michael@0 | 133 | do_check_true(engine._tracker.addChangedID("a-changed-id")); |
michael@0 | 134 | do_check_true("a-changed-id" in engine._tracker.changedIDs); |
michael@0 | 135 | |
michael@0 | 136 | engine.wipeClient(); |
michael@0 | 137 | do_check_true(engine.wasReset); |
michael@0 | 138 | do_check_true(engine._store.wasWiped); |
michael@0 | 139 | do_check_eq(JSON.stringify(engine._tracker.changedIDs), "{}"); |
michael@0 | 140 | do_check_eq(engineObserver.topics[0], "weave:engine:wipe-client:start"); |
michael@0 | 141 | do_check_eq(engineObserver.topics[1], "weave:engine:reset-client:start"); |
michael@0 | 142 | do_check_eq(engineObserver.topics[2], "weave:engine:reset-client:finish"); |
michael@0 | 143 | do_check_eq(engineObserver.topics[3], "weave:engine:wipe-client:finish"); |
michael@0 | 144 | |
michael@0 | 145 | engine.wasReset = false; |
michael@0 | 146 | engine._store.wasWiped = false; |
michael@0 | 147 | engineObserver.reset(); |
michael@0 | 148 | run_next_test(); |
michael@0 | 149 | }); |
michael@0 | 150 | |
michael@0 | 151 | add_test(function test_enabled() { |
michael@0 | 152 | _("Engine.enabled corresponds to preference"); |
michael@0 | 153 | let engine = new SteamEngine(Service); |
michael@0 | 154 | try { |
michael@0 | 155 | do_check_false(engine.enabled); |
michael@0 | 156 | Svc.Prefs.set("engine.steam", true); |
michael@0 | 157 | do_check_true(engine.enabled); |
michael@0 | 158 | |
michael@0 | 159 | engine.enabled = false; |
michael@0 | 160 | do_check_false(Svc.Prefs.get("engine.steam")); |
michael@0 | 161 | run_next_test(); |
michael@0 | 162 | } finally { |
michael@0 | 163 | Svc.Prefs.resetBranch(""); |
michael@0 | 164 | } |
michael@0 | 165 | }); |
michael@0 | 166 | |
michael@0 | 167 | add_test(function test_sync() { |
michael@0 | 168 | let engine = new SteamEngine(Service); |
michael@0 | 169 | try { |
michael@0 | 170 | _("Engine.sync doesn't call _sync if it's not enabled"); |
michael@0 | 171 | do_check_false(engine.enabled); |
michael@0 | 172 | do_check_false(engine.wasSynced); |
michael@0 | 173 | engine.sync(); |
michael@0 | 174 | do_check_false(engine.wasSynced); |
michael@0 | 175 | |
michael@0 | 176 | _("Engine.sync calls _sync if it's enabled"); |
michael@0 | 177 | engine.enabled = true; |
michael@0 | 178 | engine.sync(); |
michael@0 | 179 | do_check_true(engine.wasSynced); |
michael@0 | 180 | do_check_eq(engineObserver.topics[0], "weave:engine:sync:start"); |
michael@0 | 181 | do_check_eq(engineObserver.topics[1], "weave:engine:sync:finish"); |
michael@0 | 182 | run_next_test(); |
michael@0 | 183 | } finally { |
michael@0 | 184 | Svc.Prefs.resetBranch(""); |
michael@0 | 185 | engine.wasSynced = false; |
michael@0 | 186 | engineObserver.reset(); |
michael@0 | 187 | } |
michael@0 | 188 | }); |
michael@0 | 189 | |
michael@0 | 190 | add_test(function test_disabled_no_track() { |
michael@0 | 191 | _("When an engine is disabled, its tracker is not tracking."); |
michael@0 | 192 | let engine = new SteamEngine(Service); |
michael@0 | 193 | let tracker = engine._tracker; |
michael@0 | 194 | do_check_eq(engine, tracker.engine); |
michael@0 | 195 | |
michael@0 | 196 | do_check_false(engine.enabled); |
michael@0 | 197 | do_check_false(tracker._isTracking); |
michael@0 | 198 | do_check_empty(tracker.changedIDs); |
michael@0 | 199 | |
michael@0 | 200 | do_check_false(tracker.engineIsEnabled()); |
michael@0 | 201 | tracker.observe(null, "weave:engine:start-tracking", null); |
michael@0 | 202 | do_check_false(tracker._isTracking); |
michael@0 | 203 | do_check_empty(tracker.changedIDs); |
michael@0 | 204 | |
michael@0 | 205 | engine.enabled = true; |
michael@0 | 206 | tracker.observe(null, "weave:engine:start-tracking", null); |
michael@0 | 207 | do_check_true(tracker._isTracking); |
michael@0 | 208 | do_check_empty(tracker.changedIDs); |
michael@0 | 209 | |
michael@0 | 210 | tracker.addChangedID("abcdefghijkl"); |
michael@0 | 211 | do_check_true(0 < tracker.changedIDs["abcdefghijkl"]); |
michael@0 | 212 | engine.enabled = false; |
michael@0 | 213 | do_check_false(tracker._isTracking); |
michael@0 | 214 | do_check_empty(tracker.changedIDs); |
michael@0 | 215 | |
michael@0 | 216 | run_next_test(); |
michael@0 | 217 | }); |