Bug 814691 - Develop WebTelephony test to verify cannot have multiple calls on hold simultaneously and update manifest. r=davehunt

dom/telephony/test/marionette/manifest.ini

@@ -36,4 +36,5 @@ disabled = Bug 806138
 [test_incoming_onstatechange.js]
 [test_outgoing_onstatechange.js]
 [test_redundant_operations.js]
+[test_multiple_hold.js]
 

dom/telephony/test/marionette/test_multiple_hold.js

@@ -0,0 +1,289 @@
+/* Any copyright is dedicated to the Public Domain.
+ * http://creativecommons.org/publicdomain/zero/1.0/ */
+
+MARIONETTE_TIMEOUT = 15000;
+
+SpecialPowers.addPermission("telephony", true, document);
+
+let telephony = window.navigator.mozTelephony;
+let inNumber = "5555551111";
+let outNumber = "5555552222";
+let incomingCall;
+let outgoingCall;
+
+function verifyInitialState() {
+  log("Verifying initial state.");
+  ok(telephony);
+  is(telephony.active, null);
+  ok(telephony.calls);
+  is(telephony.calls.length, 0);
+
+  runEmulatorCmd("gsm list", function(result) {
+    log("Initial call list: " + result);
+    is(result[0], "OK");
+    simulateIncoming();
+  });
+}
+
+function simulateIncoming() {
+  log("Simulating an incoming call.");
+
+  telephony.onincoming = function onincoming(event) {
+    log("Received 'incoming' call event.");
+    incomingCall = event.call;
+    ok(incomingCall);
+    is(incomingCall.number, inNumber);
+    is(incomingCall.state, "incoming");
+
+    is(telephony.calls.length, 1);
+    is(telephony.calls[0], incomingCall);
+
+    runEmulatorCmd("gsm list", function(result) {
+      log("Call list is now: " + result);
+      is(result[0], "inbound from " + inNumber + " : incoming");
+      is(result[1], "OK");
+      answerIncoming();
+    });
+  };
+  runEmulatorCmd("gsm call " + inNumber);
+}
+
+function answerIncoming() {
+  log("Answering the incoming call.");
+
+  let gotConnecting = false;
+  incomingCall.onconnecting = function onconnectingIn(event) { 
+    log("Received 'connecting' call event for original (incoming) call.");
+    is(incomingCall, event.call);
+    is(incomingCall.state, "connecting");
+    gotConnecting = true;
+  };
+
+  incomingCall.onconnected = function onconnectedIn(event) {
+    log("Received 'connected' call event for original (incoming) call.");
+    is(incomingCall, event.call);
+    is(incomingCall.state, "connected");
+    ok(gotConnecting);
+    is(incomingCall, telephony.active);
+
+    runEmulatorCmd("gsm list", function(result) {
+      log("Call list is now: " + result);
+      is(result[0], "inbound from " + inNumber + " : active");
+      is(result[1], "OK");
+      holdCall();
+    });
+  };
+  incomingCall.answer();
+}
+
+// Put the original (incoming) call on hold
+function holdCall() {
+  log("Putting the original (incoming) call on hold.");
+
+  let gotHolding = false;
+  incomingCall.onholding = function onholding(event) {
+    log("Received 'holding' call event");
+    is(incomingCall, event.call);
+    is(incomingCall.state, "holding");
+    gotHolding = true;
+  };
+
+  incomingCall.onheld = function onheld(event) {
+    log("Received 'held' call event");
+    is(incomingCall, event.call);
+    is(incomingCall.state, "held");
+    ok(gotHolding);
+
+    is(telephony.active, null);
+    is(telephony.calls.length, 1);
+    is(telephony.calls[0], incomingCall);
+
+    runEmulatorCmd("gsm list", function(result) {
+      log("Call list is now: " + result);
+      is(result[0], "inbound from " + inNumber + " : held");
+      is(result[1], "OK");
+      dial();
+    });
+  };
+  incomingCall.hold();
+}
+
+// With one call on hold, make outgoing call
+function dial() {
+  log("Making an outgoing call (while have one call already held).");
+
+  outgoingCall = telephony.dial(outNumber);
+  ok(outgoingCall);
+  is(outgoingCall.number, outNumber);
+  is(outgoingCall.state, "dialing");
+  is(outgoingCall, telephony.active);
+  is(telephony.calls.length, 2);
+  is(telephony.calls[0], incomingCall);
+  is(telephony.calls[1], outgoingCall);
+
+  outgoingCall.onalerting = function onalerting(event) {
+    log("Received 'onalerting' call event.");
+    is(outgoingCall, event.call);
+    is(outgoingCall.state, "alerting");
+
+    runEmulatorCmd("gsm list", function(result) {
+      log("Call list is now: " + result);
+      is(result[0], "inbound from " + inNumber + " : held");
+      is(result[1], "outbound to  " + outNumber + " : ringing");
+      is(result[2], "OK");
+      answerOutgoing();
+    });
+  };
+}
+
+// Have the outgoing call answered
+function answerOutgoing() {
+  log("Answering the outgoing/2nd call");
+
+  // We get no "connecting" event when the remote party answers the call.
+  outgoingCall.onconnected = function onconnectedOut(event) {
+    log("Received 'connected' call event for outgoing/2nd call.");
+    is(outgoingCall, event.call);
+    is(outgoingCall.state, "connected");
+    is(outgoingCall, telephony.active);
+
+    runEmulatorCmd("gsm list", function(result) {
+      log("Call list is now: " + result);
+      is(result[0], "inbound from " + inNumber + " : held");
+      is(result[1], "outbound to  " + outNumber + " : active");
+      is(result[2], "OK");
+      holdSecondCall();
+    });
+  };
+  runEmulatorCmd("gsm accept " + outNumber);
+}
+
+// With one held call and one active, hold the active one; expect the first
+// (held) call to automatically become active, and the 2nd call to go on hold
+function holdSecondCall() {
+  let firstCallReconnected = false;
+  let secondCallHeld = false;
+
+  log("Putting the 2nd (outgoing) call on hold.");
+
+  // Since first call will become connected again, setup handler
+  incomingCall.onconnected = function onreconnected(event) {
+    log("Received 'connected' call event for original (incoming) call.");
+    is(incomingCall, event.call);
+    is(incomingCall.state, "connected");
+    is(incomingCall, telephony.active);
+    firstCallReconnected = true;
+    if (firstCallReconnected && secondCallHeld) {
+      verifyCalls();
+    }
+  };
+
+  // Handlers for holding 2nd call
+  let gotHolding = false;
+  outgoingCall.onholding = function onholdingOut(event) {
+    log("Received 'holding' call event for 2nd call.");
+    is(outgoingCall, event.call);
+    is(outgoingCall.state, "holding");
+    gotHolding = true;
+  };
+
+  outgoingCall.onheld = function onheldOut(event) {
+    log("Received 'held' call event for 2nd call.");
+    is(outgoingCall, event.call);
+    is(outgoingCall.state, "held");
+    ok(gotHolding);
+    secondCallHeld = true;
+    if (firstCallReconnected && secondCallHeld) {
+      verifyCalls();
+    }
+  };
+  outgoingCall.hold();
+}
+
+function verifyCalls() {
+  is(telephony.active, incomingCall);
+  is(telephony.calls.length, 2);
+  is(telephony.calls[0], incomingCall);
+  is(telephony.calls[1], outgoingCall);
+
+  runEmulatorCmd("gsm list", function(result) {
+    log("Call list is now: " + result);
+    is(result[0], "inbound from " + inNumber + " : active");
+    is(result[1], "outbound to  " + outNumber + " : held");
+    is(result[2], "OK");
+    hangUpIncoming();
+  });
+}
+
+// Hang-up the original incoming call, which is now active
+function hangUpIncoming() {
+  log("Hanging up the original incoming (now active) call.");
+
+  let gotDisconnecting = false;
+  incomingCall.ondisconnecting = function ondisconnectingIn(event) {
+    log("Received 'disconnecting' call event for original (incoming) call.");
+    is(incomingCall, event.call);
+    is(incomingCall.state, "disconnecting");
+    gotDisconnecting = true;
+  };
+
+  incomingCall.ondisconnected = function ondisconnectedIn(event) {
+    log("Received 'disconnected' call event for original (incoming) call.");
+    is(incomingCall, event.call);
+    is(incomingCall.state, "disconnected");
+    ok(gotDisconnecting);
+
+    // Now back to one call
+    is(telephony.active, null);
+    is(telephony.calls.length, 1);
+    is(telephony.calls[0], outgoingCall);
+
+    runEmulatorCmd("gsm list", function(result) {
+      log("Call list is now: " + result);
+      is(result[0], "outbound to  " + outNumber + " : held");
+      is(result[1], "OK");
+      hangUpOutgoing();
+    });
+  };
+  incomingCall.hangUp();
+}
+
+// Hang-up the remaining (outgoing) call, which is held
+function hangUpOutgoing() {
+  log("Hanging up the remaining (outgoing) held call.");
+
+  let gotDisconnecting = false;
+  outgoingCall.ondisconnecting = function ondisconnectingOut(event) {
+    log("Received 'disconnecting' call event for remaining (outgoing) call.");
+    is(outgoingCall, event.call);
+    is(outgoingCall.state, "disconnecting");
+    gotDisconnecting = true;
+  };
+
+  outgoingCall.ondisconnected = function ondisconnectedOut(event) {
+    log("Received 'disconnected' call event for remaining (outgoing) call.");
+    is(outgoingCall, event.call);
+    is(outgoingCall.state, "disconnected");
+    ok(gotDisconnecting);
+
+    // Now no calls
+    is(telephony.active, null);
+    is(telephony.calls.length, 0);
+
+    runEmulatorCmd("gsm list", function(result) {
+      log("Call list is now: " + result);
+      is(result[0], "OK");
+      cleanUp();
+    });
+  };
+  outgoingCall.hangUp();  
+}
+
+function cleanUp() {
+  telephony.onincoming = null;
+  SpecialPowers.removePermission("telephony", document);
+  finish();
+}
+
+// Start the test
+verifyInitialState();