summaryrefslogtreecommitdiffstats
path: root/browser/components/migration/InternalTestingProfileMigrator.sys.mjs
diff options
context:
space:
mode:
Diffstat (limited to 'browser/components/migration/InternalTestingProfileMigrator.sys.mjs')
-rw-r--r--browser/components/migration/InternalTestingProfileMigrator.sys.mjs63
1 files changed, 63 insertions, 0 deletions
diff --git a/browser/components/migration/InternalTestingProfileMigrator.sys.mjs b/browser/components/migration/InternalTestingProfileMigrator.sys.mjs
new file mode 100644
index 0000000000..e14b72607f
--- /dev/null
+++ b/browser/components/migration/InternalTestingProfileMigrator.sys.mjs
@@ -0,0 +1,63 @@
+/* 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/. */
+
+import { MigratorBase } from "resource:///modules/MigratorBase.sys.mjs";
+
+const lazy = {};
+
+ChromeUtils.defineESModuleGetters(lazy, {
+ MigrationUtils: "resource:///modules/MigrationUtils.sys.mjs",
+});
+
+/**
+ * A stub of a migrator used for automated testing only.
+ */
+export class InternalTestingProfileMigrator extends MigratorBase {
+ static get key() {
+ return "internal-testing";
+ }
+
+ static get displayNameL10nID() {
+ return "Internal Testing Migrator";
+ }
+
+ getSourceProfiles() {
+ return Promise.resolve([InternalTestingProfileMigrator.testProfile]);
+ }
+
+ // We will create a single MigratorResource for each resource type that
+ // just immediately reports a successful migration.
+ getResources(aProfile) {
+ if (
+ !aProfile ||
+ aProfile.id != InternalTestingProfileMigrator.testProfile.id
+ ) {
+ throw new Error(
+ "InternalTestingProfileMigrator.getResources expects test profile."
+ );
+ }
+ return Object.values(lazy.MigrationUtils.resourceTypes).map(type => {
+ return {
+ type,
+ migrate: callback => {
+ callback(true /* success */);
+ },
+ };
+ });
+ }
+
+ /**
+ * Clears the MigratorResources that are normally cached by the
+ * MigratorBase parent class after a call to getResources. This
+ * allows our automated tests to try different resource availability
+ * scenarios between tests.
+ */
+ flushResourceCache() {
+ this._resourcesByProfile = null;
+ }
+
+ static get testProfile() {
+ return { id: "test-profile", name: "Some test profile" };
+ }
+}