gecko/browser/devtools/debugger/test/browser_dbg_createRemote.js

/*
 * Any copyright is dedicated to the Public Domain.
 * http://creativecommons.org/publicdomain/zero/1.0/
 */

// Tests that a remote debugger can be created in a new window.

var gWindow = null;
var gTab = null;
var gRemoteHost = null;
var gRemotePort = null;
var gRemoteTimeout = null;
var gAutoConnect = null;

const TEST_URL = EXAMPLE_URL + "browser_dbg_iframes.html";

function test() {
  debug_remote(TEST_URL, function(aTab, aDebuggee, aWindow) {
    gTab = aTab;
    gWindow = aWindow;
    let gDebugger = gWindow.panelWin;

    info("Current remote window x: " +
      Services.prefs.getIntPref("devtools.debugger.ui.win-x"));
    info("Current remote window y: " +
      Services.prefs.getIntPref("devtools.debugger.ui.win-y"));
    info("Current remote window width: " +
      Services.prefs.getIntPref("devtools.debugger.ui.win-width"));
    info("Current remote window height: " +
      Services.prefs.getIntPref("devtools.debugger.ui.win-height"));

    is(gDebugger.Prefs.windowX,
      Services.prefs.getIntPref("devtools.debugger.ui.win-x"),
      "Current window x pref corresponds to the debugger pref.");

    is(gDebugger.Prefs.windowY,
      Services.prefs.getIntPref("devtools.debugger.ui.win-y"),
      "Current window y pref corresponds to the debugger pref.");

    is(gDebugger.Prefs.windowWidth,
      Services.prefs.getIntPref("devtools.debugger.ui.win-width"),
      "Current window width pref corresponds to the debugger pref.");

    is(gDebugger.Prefs.windowHeight,
      Services.prefs.getIntPref("devtools.debugger.ui.win-height"),
      "Current window height pref corresponds to the debugger pref.");


    info("Current remote host: " +
      Services.prefs.getCharPref("devtools.debugger.remote-host"));
    info("Current remote port: " +
      Services.prefs.getIntPref("devtools.debugger.remote-port"));
    info("Current remote retries: " +
      Services.prefs.getIntPref("devtools.debugger.remote-connection-retries"));
    info("Current remote timeout: " +
      Services.prefs.getIntPref("devtools.debugger.remote-timeout"));
    info("Current autoconnect flag: " +
      Services.prefs.getBoolPref("devtools.debugger.remote-autoconnect"));

    is(gDebugger.Prefs.remoteHost,
      Services.prefs.getCharPref("devtools.debugger.remote-host"),
      "Current remote host corresponds to the debugger pref.");

    is(gDebugger.Prefs.remotePort,
      Services.prefs.getIntPref("devtools.debugger.remote-port"),
      "Current remote port corresponds to the debugger pref.");

    is(gDebugger.Prefs.remoteConnectionRetries,
      Services.prefs.getIntPref("devtools.debugger.remote-connection-retries"),
      "Current remote retries corresponds to the debugger pref.");

    is(gDebugger.Prefs.remoteTimeout,
      Services.prefs.getIntPref("devtools.debugger.remote-timeout"),
      "Current remote timeout corresponds to the debugger pref.");

    is(gDebugger.Prefs.remoteAutoConnect,
      Services.prefs.getBoolPref("devtools.debugger.remote-autoconnect"),
      "Current autoconnect flag corresponds to the debugger pref.");


    is(gDebugger.document.getElementById("close").getAttribute("hidden"), "true",
      "The close button should be hidden in a remote debugger.");

    is(gDebugger.DebuggerController.activeThread.paused, false,
      "Should be running after debug_remote.");

    gDebugger.DebuggerController.activeThread.addOneTimeListener("framesadded", function() {
      Services.tm.currentThread.dispatch({ run: function() {

        let frames = gDebugger.DebuggerView.StackFrames._container._list;
        let childNodes = frames.childNodes;

        is(gDebugger.DebuggerController.activeThread.paused, true,
          "Should be paused after an interrupt request.");

        is(frames.querySelectorAll(".dbg-stackframe").length, 1,
          "Should have one frame in the stack.");

        gDebugger.DebuggerController.activeThread.addOneTimeListener("resumed", function() {
          Services.tm.currentThread.dispatch({ run: function() {
            closeDebuggerAndFinish(true);
          }}, 0);
        });

        EventUtils.sendMouseEvent({ type: "mousedown" },
          gDebugger.document.getElementById("resume"),
          gDebugger);
      }}, 0);
    });

    let iframe = gTab.linkedBrowser.contentWindow.wrappedJSObject.frames[0];
    is(iframe.document.title, "Browser Debugger Test Tab", "Found the iframe");

    function handler() {
      if (iframe.document.readyState != "complete") {
        return;
      }
      iframe.window.removeEventListener("load", handler, false);
      executeSoon(iframe.runDebuggerStatement);
    };
    iframe.window.addEventListener("load", handler, false);
    handler();
  },
  function beforeTabAdded() {
    if (!DebuggerServer.initialized) {
      DebuggerServer.init(function() { return true; });
      DebuggerServer.addBrowserActors();
    }
    DebuggerServer.closeListener();

    gRemoteHost = Services.prefs.getCharPref("devtools.debugger.remote-host");
    gRemotePort = Services.prefs.getIntPref("devtools.debugger.remote-port");
    gRemoteTimeout = Services.prefs.getIntPref("devtools.debugger.remote-timeout");
    gAutoConnect = Services.prefs.getBoolPref("devtools.debugger.remote-autoconnect");

    // Open the listener at some point in the future to test automatic reconnect.
    openListener(gRemoteHost, gRemotePort + 1, gRemoteTimeout / 10);
  });
}

let attempts = 0;

function openListener(host, port, timeout) {
  Services.prefs.setCharPref("devtools.debugger.remote-host", host);
  Services.prefs.setIntPref("devtools.debugger.remote-port", port);
  Services.prefs.setIntPref("devtools.debugger.remote-timeout", timeout);
  Services.prefs.setBoolPref("devtools.debugger.remote-autoconnect", true);

  info("Attempting to open a new listener on port " + port);
  try {
    info("Closing listener...");
    DebuggerServer.closeListener();
    info("Opening listener...");
    DebuggerServer.openListener(port);
  } catch (e) {
    info(e);
    info("Exception caught when opening listener on port " + port);
    info("Retrying with port " + (++port));

    if (++attempts < 100) {
      DebuggerServer.closeListener();
      openListener(port);
    } else {
      ok(false, "Timed out while opening a listener.");
    }
  }
}

registerCleanupFunction(function() {
  Services.prefs.setCharPref("devtools.debugger.remote-host", gRemoteHost);
  Services.prefs.setIntPref("devtools.debugger.remote-port", gRemotePort);
  Services.prefs.setIntPref("devtools.debugger.remote-timeout", gRemoteTimeout);
  Services.prefs.setBoolPref("devtools.debugger.remote-autoconnect", gAutoConnect);
  removeTab(gTab);
  gWindow = null;
  gTab = null;
  gRemoteHost = null;
  gRemotePort = null;
  gRemoteTimeout = null;
  gAutoConnect = null;
});