michael@0: /* Any copyright is dedicated to the Public Domain.
michael@0:    http://creativecommons.org/publicdomain/zero/1.0/ */
michael@0: 
michael@0: // This tests are for a sessionstore.js atomic backup.
michael@0: // Each test will wait for a write to the Session Store
michael@0: // before executing.
michael@0: 
michael@0: let tmp = {};
michael@0: Cu.import("resource://gre/modules/osfile.jsm", tmp);
michael@0: Cu.import("resource:///modules/sessionstore/SessionFile.jsm", tmp);
michael@0: 
michael@0: const {OS, SessionFile} = tmp;
michael@0: 
michael@0: const PREF_SS_INTERVAL = "browser.sessionstore.interval";
michael@0: // Full paths for sessionstore.js and sessionstore.bak.
michael@0: const path = OS.Path.join(OS.Constants.Path.profileDir, "sessionstore.js");
michael@0: const backupPath = OS.Path.join(OS.Constants.Path.profileDir,
michael@0:   "sessionstore.bak");
michael@0: 
michael@0: // A text decoder.
michael@0: let gDecoder = new TextDecoder();
michael@0: // Global variables that contain sessionstore.js and sessionstore.bak data for
michael@0: // comparison between tests.
michael@0: let gSSData;
michael@0: let gSSBakData;
michael@0: 
michael@0: 
michael@0: 
michael@0: add_task(function* testAfterFirstWrite() {
michael@0:   // Ensure sessionstore.bak is not created. We start with a clean
michael@0:   // profile so there was nothing to move to sessionstore.bak before
michael@0:   // initially writing sessionstore.js
michael@0:   let ssExists = yield OS.File.exists(path);
michael@0:   let ssBackupExists = yield OS.File.exists(backupPath);
michael@0:   ok(ssExists, "sessionstore.js should exist.");
michael@0:   ok(!ssBackupExists, "sessionstore.bak should not have been created, yet");
michael@0: 
michael@0:   // Save sessionstore.js data to compare to the sessionstore.bak data in the
michael@0:   // next test.
michael@0:   let array = yield OS.File.read(path);
michael@0:   gSSData = gDecoder.decode(array);
michael@0: 
michael@0:   // Manually move to the backup since the first write has already happened
michael@0:   // and a backup would not be triggered again.
michael@0:   yield OS.File.move(path, backupPath);
michael@0: 
michael@0:   yield forceSaveState();
michael@0: });
michael@0: 
michael@0: add_task(function* testReadBackup() {
michael@0:   // Ensure sessionstore.bak is finally created.
michael@0:   let ssExists = yield OS.File.exists(path);
michael@0:   let ssBackupExists = yield OS.File.exists(backupPath);
michael@0:   ok(ssExists, "sessionstore.js exists.");
michael@0:   ok(ssBackupExists, "sessionstore.bak should now be created.");
michael@0: 
michael@0:   // Read sessionstore.bak data.
michael@0:   let array = yield OS.File.read(backupPath);
michael@0:   gSSBakData = gDecoder.decode(array);
michael@0: 
michael@0:   // Make sure that the sessionstore.bak is identical to the last
michael@0:   // sessionstore.js.
michael@0:   is(gSSBakData, gSSData, "sessionstore.js is backed up correctly.");
michael@0: 
michael@0:   // Read latest sessionstore.js.
michael@0:   array = yield OS.File.read(path);
michael@0:   gSSData = gDecoder.decode(array);
michael@0: 
michael@0:   // Read sessionstore.js with SessionFile.read.
michael@0:   let ssDataRead = yield SessionFile.read();
michael@0:   is(ssDataRead, gSSData, "SessionFile.read read sessionstore.js correctly.");
michael@0: 
michael@0:   // Remove sessionstore.js to test fallback onto sessionstore.bak.
michael@0:   yield OS.File.remove(path);
michael@0:   ssExists = yield OS.File.exists(path);
michael@0:   ok(!ssExists, "sessionstore.js should be removed now.");
michael@0: 
michael@0:   // Read sessionstore.bak with SessionFile.read.
michael@0:   ssDataRead = yield SessionFile.read();
michael@0:   is(ssDataRead, gSSBakData,
michael@0:     "SessionFile.read read sessionstore.bak correctly.");
michael@0: 
michael@0:   yield forceSaveState();
michael@0: });
michael@0: 
michael@0: add_task(function* testBackupUnchanged() {
michael@0:   // Ensure sessionstore.bak is backed up only once.
michael@0: 
michael@0:   // Read sessionstore.bak data.
michael@0:   let array = yield OS.File.read(backupPath);
michael@0:   let ssBakData = gDecoder.decode(array);
michael@0:   // Ensure the sessionstore.bak did not change.
michael@0:   is(ssBakData, gSSBakData, "sessionstore.bak is unchanged.");
michael@0: });
michael@0: 
michael@0: add_task(function* cleanup() {
michael@0:   // Cleaning up after the test: removing the sessionstore.bak file.
michael@0:   yield OS.File.remove(backupPath);
michael@0: });