Add nomination failure test

Author: Karolk99

test/priv/ice_agent_test.exs

@@ -303,7 +303,7 @@ defmodule ExICE.Priv.ICEAgentTest do
     ice_agent = put_in(ice_agent.local_cands[cand.base.id], cand)
 
     [pair] = Map.values(ice_agent.checklist)
-    pair = %{pair | state: :failed}
+    pair = %{pair | state: :failed, valid?: false}
     ice_agent = put_in(ice_agent.checklist[pair.id], pair)
 
     # try to feed data on closed candidate, it should be ignored
@@ -363,7 +363,7 @@ defmodule ExICE.Priv.ICEAgentTest do
 
     assert ice_agent.state == :closed
     assert ice_agent.gathering_state == :complete
-    assert [%{state: :failed} = pair] = Map.values(ice_agent.checklist)
+    assert [%{state: :failed, valid?: false} = pair] = Map.values(ice_agent.checklist)
     assert [%{base: %{closed?: true}}] = Map.values(ice_agent.local_cands)
     # make sure that sockets and remote cands were not cleared
     assert [_remote_cand] = Map.values(ice_agent.remote_cands)
@@ -454,7 +454,7 @@ defmodule ExICE.Priv.ICEAgentTest do
 
     # mark pair as failed
     [pair] = Map.values(ice_agent.checklist)
-    ice_agent = put_in(ice_agent.checklist[pair.id], %{pair | state: :failed})
+    ice_agent = put_in(ice_agent.checklist[pair.id], %{pair | state: :failed, valid?: false})
 
     # clear ta_timer, ignore outgoing binding request that has been generated
     ice_agent = ICEAgent.handle_ta_timeout(ice_agent)
@@ -512,8 +512,7 @@ defmodule ExICE.Priv.ICEAgentTest do
 
       # mark pair as failed
       [pair] = Map.values(ice_agent.checklist)
-      ice_agent = put_in(ice_agent.checklist[pair.id], %{pair | state: :failed})
-
+      ice_agent = put_in(ice_agent.checklist[pair.id], %{pair | state: :failed, valid?: false})
       # clear ta_timer, ignore outgoing binding request that has been generated
       ice_agent = ICEAgent.handle_ta_timeout(ice_agent)
       assert ice_agent.ta_timer == nil
@@ -1246,6 +1245,7 @@ defmodule ExICE.Priv.ICEAgentTest do
   end
 
   @conn_check_byte_size 92
+  @conn_check_with_nomination_byte_size 96
 
   describe "connectivity check" do
     setup do
@@ -1518,7 +1518,7 @@ defmodule ExICE.Priv.ICEAgentTest do
           resp
         )
 
-      assert [%CandidatePair{state: :failed}] = Map.values(ice_agent.checklist)
+      assert [%CandidatePair{state: :failed, valid?: false}] = Map.values(ice_agent.checklist)
       assert [new_pair] = Map.values(ice_agent.checklist)
       assert new_pair.state == :failed
       assert new_pair.responses_received == pair.responses_received
@@ -1609,6 +1609,53 @@ defmodule ExICE.Priv.ICEAgentTest do
 
       assert ice_agent.state == :failed
     end
+
+    test "failure on send, when nominating" do
+      # 1. make ice agent connected
+      # 2. replace candidate with the mock one that always fails to send data
+      # 3. assert that after unsuccessful nomination sending, ice_agent moves conn pair to the failed state
+
+      ice_agent =
+        ICEAgent.new(
+          controlling_process: self(),
+          role: :controlling,
+          if_discovery_module: IfDiscovery.Mock,
+          transport_module: Transport.Mock
+        )
+        |> ICEAgent.set_remote_credentials("someufrag", "somepwd")
+        |> ICEAgent.gather_candidates()
+        |> ICEAgent.add_remote_candidate(@remote_cand)
+
+      assert ice_agent.gathering_state == :complete
+
+      # make ice_agent connected
+      ice_agent = connect(ice_agent)
+
+      # replace candidate with the mock one
+      [local_cand] = Map.values(ice_agent.local_cands)
+      mock_cand = %Candidate.Mock{base: local_cand.base}
+      ice_agent = %{ice_agent | local_cands: %{mock_cand.base.id => mock_cand}}
+
+      # trigger pair nomination
+      ice_agent = ICEAgent.end_of_candidates(ice_agent)
+
+      # assert that the candidate pair has moved to a failed state
+      # and that the state was updated after the packet was discarded
+      assert [
+               %{
+                 state: :failed,
+                 valid?: false,
+                 packets_discarded_on_send: 1,
+                 bytes_discarded_on_send: @conn_check_with_nomination_byte_size
+               }
+             ] = Map.values(ice_agent.checklist)
+
+      assert ice_agent.state == :connected
+
+      ice_agent = ICEAgent.handle_ta_timeout(ice_agent)
+
+      assert ice_agent.state == :failed
+    end
   end
 
   describe "connectivity check with aggressive nomination" do
@@ -1989,7 +2036,7 @@ defmodule ExICE.Priv.ICEAgentTest do
     ice_agent = ICEAgent.handle_pair_timeout(ice_agent)
 
     # assert that the pair is marked as failed
-    assert [%CandidatePair{state: :failed}] = Map.values(ice_agent.checklist)
+    assert [%CandidatePair{state: :failed, valid?: false}] = Map.values(ice_agent.checklist)
 
     # trigger eoc timeout
     ice_agent = ICEAgent.handle_eoc_timeout(ice_agent)
@@ -2019,7 +2066,7 @@ defmodule ExICE.Priv.ICEAgentTest do
 
     # mark pair as failed
     [pair] = Map.values(ice_agent.checklist)
-    ice_agent = put_in(ice_agent.checklist[pair.id], %{pair | state: :failed})
+    ice_agent = put_in(ice_agent.checklist[pair.id], %{pair | state: :failed, valid?: false})
 
     # set eoc flag
     failed_ice_agent = ICEAgent.end_of_candidates(ice_agent)