feat(Jingle): add 'failICE' config option

The flag when set to 'true' will enforce ICE failure. It is supposed to
be used in automatic testing.

modules/xmpp/JingleSessionPC.js

@@ -59,6 +59,12 @@ function JingleSessionPC(me, sid, peerjid, connection,
     this.jingleOfferIq = null;
     this.webrtcIceUdpDisable = !!this.service.options.webrtcIceUdpDisable;
     this.webrtcIceTcpDisable = !!this.service.options.webrtcIceTcpDisable;
+    /**
+     * Flag used to enforce ICE failure through the URL parameter for
+     * the automatic testing purpose.
+     * @type {boolean}
+     */
+    this.failICE = !!this.service.options.failICE;
 
     this.modifySourcesQueue = async.queue(this._modifySources.bind(this), 1);
 }
@@ -212,7 +218,12 @@ JingleSessionPC.prototype.sendIceCandidates = function (candidates) {
                 name: (cands[0].sdpMid? cands[0].sdpMid : mline.media)
             }).c('transport', ice);
             for (var i = 0; i < cands.length; i++) {
-                cand.c('candidate', SDPUtil.candidateToJingle(cands[i].candidate)).up();
+                var candidate = SDPUtil.candidateToJingle(cands[i].candidate);
+                // Mangle ICE candidate if 'failICE' test option is enabled
+                if (this.service.options.failICE) {
+                    candidate.ip = "1.1.1.1";
+                }
+                cand.c('candidate', candidate).up();
             }
             // add fingerprint
             var fingerprint_line = SDPUtil.find_line(this.localSDP.media[mid], 'a=fingerprint:', this.localSDP.session);
@@ -423,6 +434,9 @@ JingleSessionPC.prototype.sendSessionAccept = function (localSDP,
     if (this.webrtcIceUdpDisable) {
         localSDP.removeUdpCandidates = true;
     }
+    if (this.failICE) {
+        localSDP.failICE = true;
+    }
     localSDP.toJingle(
         accept,
         this.initiator == this.me ? 'initiator' : 'responder',
@@ -755,6 +769,9 @@ JingleSessionPC.prototype._modifySources = function (successCallback, queueCallb
         if (this.webrtcIceUdpDisable) {
             sdp.removeUdpCandidates = true;
         }
+        if (this.failICE) {
+            sdp.failICE = true;
+        }
 
         sdp.fromJingle(this.jingleOfferIq);
         this.readSsrcInfo($(this.jingleOfferIq).find(">content"));

modules/xmpp/SDP.js

@@ -19,6 +19,14 @@ function SDP(sdp) {
     this.session = session;
 }
 
+/**
+ * A flag will make {@link transportToJingle} and {@link jingle2media} replace
+ * ICE candidates IPs with invalid value of '1.1.1.1' which will cause ICE
+ * failure. The flag is used in the automated testing.
+ * @type {boolean}
+ */
+SDP.prototype.failICE = false;
+
 /**
  * Whether or not to remove TCP ice candidates when translating from/to jingle.
  * @type {boolean}
@@ -385,6 +393,9 @@ SDP.prototype.transportToJingle = function (mediaindex, elem) {
             var lines = SDPUtil.find_lines(this.media[mediaindex], 'a=candidate:', this.session);
             lines.forEach(function (line) {
                 var candidate = SDPUtil.candidateToJingle(line);
+                if (self.failICE) {
+                    candidate.ip = "1.1.1.1";
+                }
                 var protocol = (candidate &&
                         typeof candidate.protocol === 'string')
                     ? candidate.protocol.toLowerCase() : '';
@@ -598,6 +609,8 @@ SDP.prototype.jingle2media = function (content) {
         if ((self.removeTcpCandidates && protocol === 'tcp') ||
             (self.removeUdpCandidates && protocol === 'udp')) {
             return;
+        } else  if (self.failICE) {
+            this.setAttribute('ip', '1.1.1.1');
         }
 
         media += SDPUtil.candidateFromJingle(this);