Source code
Revision control
Copy as Markdown
Other Tools
Test Info:
- Manifest: services/sync/tests/unit/xpcshell.toml
/* Any copyright is dedicated to the Public Domain.
const { Service } = ChromeUtils.importESModule(
);
Log.repository.rootLogger.addAppender(new Log.DumpAppender());
function login_handling(handler) {
return function (request, response) {
if (has_hawk_header(request)) {
handler(request, response);
} else {
let body = "Unauthorized";
response.setStatusLine(request.httpVersion, 401, "Unauthorized");
response.setHeader("Content-Type", "text/plain");
response.bodyOutputStream.write(body, body.length);
}
};
}
add_task(async function test_offline() {
try {
_("The right bits are set when we're offline.");
Services.io.offline = true;
Assert.ok(!(await Service.login()));
Assert.equal(Service.status.login, LOGIN_FAILED_NETWORK_ERROR);
Services.io.offline = false;
} finally {
for (const pref of Svc.PrefBranch.getChildList("")) {
Svc.PrefBranch.clearUserPref(pref);
}
}
});
function setup() {
let janeHelper = track_collections_helper();
let janeU = janeHelper.with_updated_collection;
let johnHelper = track_collections_helper();
let johnU = johnHelper.with_updated_collection;
let server = httpd_setup({
"/1.1/johndoe/info/collections": login_handling(johnHelper.handler),
"/1.1/janedoe/info/collections": login_handling(janeHelper.handler),
// We need these handlers because we test login, and login
// is where keys are generated or fetched.
// TODO: have Jane fetch her keys, not generate them...
"/1.1/johndoe/storage/crypto/keys": johnU(
"crypto",
new ServerWBO("keys").handler()
),
"/1.1/johndoe/storage/meta/global": johnU(
"meta",
new ServerWBO("global").handler()
),
"/1.1/janedoe/storage/crypto/keys": janeU(
"crypto",
new ServerWBO("keys").handler()
),
"/1.1/janedoe/storage/meta/global": janeU(
"meta",
new ServerWBO("global").handler()
),
});
return server;
}
add_task(async function test_not_logged_in() {
let server = setup();
try {
await Service.login();
Assert.ok(!Service.isLoggedIn, "no user configured, so can't be logged in");
Assert.equal(Service._checkSync(), kSyncNotConfigured);
} finally {
for (const pref of Svc.PrefBranch.getChildList("")) {
Svc.PrefBranch.clearUserPref(pref);
}
await promiseStopServer(server);
}
});
add_task(async function test_login_logout() {
enableValidationPrefs();
let server = setup();
try {
_("Force the initial state.");
Service.status.service = STATUS_OK;
Assert.equal(Service.status.service, STATUS_OK);
_("Try logging in. It won't work because we're not configured yet.");
await Service.login();
Assert.equal(Service.status.service, CLIENT_NOT_CONFIGURED);
Assert.equal(Service.status.login, LOGIN_FAILED_NO_USERNAME);
Assert.ok(!Service.isLoggedIn);
_("Try again with a configured account");
await configureIdentity({ username: "johndoe" }, server);
await Service.login();
Assert.equal(Service.status.service, STATUS_OK);
Assert.equal(Service.status.login, LOGIN_SUCCEEDED);
Assert.ok(Service.isLoggedIn);
_("Logout.");
Service.logout();
Assert.ok(!Service.isLoggedIn);
_("Logging out again won't do any harm.");
Service.logout();
Assert.ok(!Service.isLoggedIn);
} finally {
for (const pref of Svc.PrefBranch.getChildList("")) {
Svc.PrefBranch.clearUserPref(pref);
}
await promiseStopServer(server);
}
});
add_task(async function test_login_on_sync() {
enableValidationPrefs();
let server = setup();
await configureIdentity({ username: "johndoe" }, server);
try {
_("Sync calls login.");
let oldLogin = Service.login;
let loginCalled = false;
Service.login = async function () {
loginCalled = true;
Service.status.login = LOGIN_SUCCEEDED;
this._loggedIn = false; // So that sync aborts.
return true;
};
await Service.sync();
Assert.ok(loginCalled);
Service.login = oldLogin;
// Stub mpLocked.
let mpLocked = true;
Utils.mpLocked = () => mpLocked;
// Stub scheduleNextSync. This gets called within checkSyncStatus if we're
// ready to sync, so use it as an indicator.
let scheduleNextSyncF = Service.scheduler.scheduleNextSync;
let scheduleCalled = false;
Service.scheduler.scheduleNextSync = function (wait) {
scheduleCalled = true;
scheduleNextSyncF.call(this, wait);
};
// Autoconnect still tries to connect in the background (useful behavior:
// for non-MP users and unlocked MPs, this will detect version expiry
// earlier).
//
// and checkSyncStatus reflects that by waiting for login.
//
// This process doesn't apply if your MP is still locked, so we make
// checkSyncStatus accept a locked MP in place of being logged in.
//
// This test exercises these two branches.
_("We're ready to sync if locked.");
Service.enabled = true;
Services.io.offline = false;
Service.scheduler.checkSyncStatus();
Assert.ok(scheduleCalled);
_("... and also if we're not locked.");
scheduleCalled = false;
mpLocked = false;
Service.scheduler.checkSyncStatus();
Assert.ok(scheduleCalled);
Service.scheduler.scheduleNextSync = scheduleNextSyncF;
mpLocked = true;
// Testing exception handling if master password dialog is canceled.
// Do this by monkeypatching.
Service.identity.unlockAndVerifyAuthState = () =>
Promise.resolve(MASTER_PASSWORD_LOCKED);
let cSTCalled = false;
let lockedSyncCalled = false;
Service.scheduler.clearSyncTriggers = function () {
cSTCalled = true;
};
Service._lockedSync = async function () {
lockedSyncCalled = true;
};
_("If master password is canceled, login fails and we report lockage.");
Assert.ok(!(await Service.login()));
Assert.equal(Service.status.login, MASTER_PASSWORD_LOCKED);
Assert.equal(Service.status.service, LOGIN_FAILED);
_("Locked? " + Utils.mpLocked());
_("checkSync reports the correct term.");
Assert.equal(Service._checkSync(), kSyncMasterPasswordLocked);
_("Sync doesn't proceed and clears triggers if MP is still locked.");
await Service.sync();
Assert.ok(cSTCalled);
Assert.ok(!lockedSyncCalled);
// N.B., a bunch of methods are stubbed at this point. Be careful putting
// new tests after this point!
} finally {
for (const pref of Svc.PrefBranch.getChildList("")) {
Svc.PrefBranch.clearUserPref(pref);
}
await promiseStopServer(server);
}
});