1 files changed, 217 insertions, 0 deletions
diff --git a/toolkit/components/crashes/CrashManagerTest.jsm b/toolkit/components/crashes/CrashManagerTest.jsm
new file mode 100644
index 0000000000..6636ccf296
--- /dev/null
+++ b/toolkit/components/crashes/CrashManagerTest.jsm
@@ -0,0 +1,217 @@
+/* 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 file provides common and shared functionality to facilitate
+ * testing of the Crashes component (CrashManager.jsm).
+ */
+
+"use strict";
+
+var EXPORTED_SYMBOLS = [
+  "configureLogging",
+  "getManager",
+  "sleep",
+  "TestingCrashManager",
+];
+
+const { CrashManager } = ChromeUtils.import(
+  "resource://gre/modules/CrashManager.jsm"
+);
+const { XPCOMUtils } = ChromeUtils.importESModule(
+  "resource://gre/modules/XPCOMUtils.sys.mjs"
+);
+
+const lazy = {};
+
+ChromeUtils.defineESModuleGetters(lazy, {
+  Log: "resource://gre/modules/Log.sys.mjs",
+  setTimeout: "resource://gre/modules/Timer.sys.mjs",
+});
+
+XPCOMUtils.defineLazyModuleGetters(lazy, {
+  OS: "resource://gre/modules/osfile.jsm",
+});
+
+var loggingConfigured = false;
+
+var configureLogging = function() {
+  if (loggingConfigured) {
+    return;
+  }
+
+  let log = lazy.Log.repository.getLogger("Crashes.CrashManager");
+  log.level = lazy.Log.Level.All;
+  let appender = new lazy.Log.DumpAppender();
+  appender.level = lazy.Log.Level.All;
+  log.addAppender(appender);
+  loggingConfigured = true;
+};
+
+var sleep = function(wait) {
+  return new Promise(resolve => {
+    lazy.setTimeout(() => {
+      resolve();
+    }, wait);
+  });
+};
+
+var TestingCrashManager = function(options) {
+  CrashManager.call(this, options);
+};
+
+TestingCrashManager.prototype = {
+  createDummyDump(submitted = false, date = new Date(), hr = false) {
+    let uuid = Services.uuid.generateUUID().toString();
+    uuid = uuid.substring(1, uuid.length - 1);
+
+    let path;
+    let mode;
+    if (submitted) {
+      if (hr) {
+        path = lazy.OS.Path.join(
+          this._submittedDumpsDir,
+          "bp-hr-" + uuid + ".txt"
+        );
+      } else {
+        path = lazy.OS.Path.join(
+          this._submittedDumpsDir,
+          "bp-" + uuid + ".txt"
+        );
+      }
+      mode =
+        lazy.OS.Constants.libc.S_IRUSR |
+        lazy.OS.Constants.libc.S_IWUSR |
+        lazy.OS.Constants.libc.S_IRGRP |
+        lazy.OS.Constants.libc.S_IROTH;
+    } else {
+      path = lazy.OS.Path.join(this._pendingDumpsDir, uuid + ".dmp");
+      mode = lazy.OS.Constants.libc.S_IRUSR | lazy.OS.Constants.libc.S_IWUSR;
+    }
+
+    return (async function() {
+      let f = await lazy.OS.File.open(
+        path,
+        { create: true },
+        { unixMode: mode }
+      );
+      await f.setDates(date, date);
+      await f.close();
+      dump("Created fake crash: " + path + "\n");
+
+      return uuid;
+    })();
+  },
+
+  createIgnoredDumpFile(filename, submitted = false) {
+    let path;
+    if (submitted) {
+      path = lazy.OS.Path.join(this._submittedDumpsDir, filename);
+    } else {
+      path = lazy.OS.Path.join(this._pendingDumpsDir, filename);
+    }
+
+    return (async function() {
+      let mode =
+        lazy.OS.Constants.libc.S_IRUSR | lazy.OS.Constants.libc.S_IWUSR;
+      await lazy.OS.File.open(path, { create: true }, { unixMode: mode });
+      dump("Create ignored dump file: " + path + "\n");
+    })();
+  },
+
+  createEventsFile(filename, type, date, id, content, index = 0) {
+    let path = lazy.OS.Path.join(this._eventsDirs[index], filename);
+    let dateInSecs = Math.floor(date.getTime() / 1000);
+    let data = type + "\n" + dateInSecs + "\n" + id + "\n" + content;
+    let encoder = new TextEncoder();
+    let array = encoder.encode(data);
+
+    return (async function() {
+      await lazy.OS.File.writeAtomic(path, array);
+      await lazy.OS.File.setDates(path, date, date);
+    })();
+  },
+
+  deleteEventsDirs() {
+    let dirs = this._eventsDirs;
+
+    return (async function() {
+      for (let dir of dirs) {
+        await lazy.OS.File.removeDir(dir);
+      }
+    })();
+  },
+
+  /**
+   * Overwrite event file handling to process our test file type.
+   *
+   * We can probably delete this once we have actual events defined.
+   */
+  _handleEventFilePayload(store, entry, type, date, payload) {
+    if (type == "test.1") {
+      if (payload == "malformed") {
+        return this.EVENT_FILE_ERROR_MALFORMED;
+      } else if (payload == "success") {
+        return this.EVENT_FILE_SUCCESS;
+      }
+      return this.EVENT_FILE_ERROR_UNKNOWN_EVENT;
+    }
+
+    return CrashManager.prototype._handleEventFilePayload.call(
+      this,
+      store,
+      entry,
+      type,
+      date,
+      payload
+    );
+  },
+};
+Object.setPrototypeOf(TestingCrashManager.prototype, CrashManager.prototype);
+
+var DUMMY_DIR_COUNT = 0;
+
+var getManager = function() {
+  return (async function() {
+    const dirMode = lazy.OS.Constants.libc.S_IRWXU;
+    let baseFile = lazy.OS.Constants.Path.profileDir;
+
+    function makeDir(create = true) {
+      return (async function() {
+        let path = lazy.OS.Path.join(
+          baseFile,
+          "dummy-dir-" + DUMMY_DIR_COUNT++
+        );
+
+        if (!create) {
+          return path;
+        }
+
+        dump("Creating directory: " + path + "\n");
+        await lazy.OS.File.makeDir(path, { unixMode: dirMode });
+
+        return path;
+      })();
+    }
+
+    let pendingD = await makeDir();
+    let submittedD = await makeDir();
+    let eventsD1 = await makeDir();
+    let eventsD2 = await makeDir();
+
+    // Store directory is created at run-time if needed. Ensure those code
+    // paths are triggered.
+    let storeD = await makeDir(false);
+
+    let m = new TestingCrashManager({
+      pendingDumpsDir: pendingD,
+      submittedDumpsDir: submittedD,
+      eventsDirs: [eventsD1, eventsD2],
+      storeDir: storeD,
+      telemetryStoreSizeKey: "CRASH_STORE_COMPRESSED_BYTES",
+    });
+
+    return m;
+  })();
+};