Refactor TURN server tests and logs. Bump version to 0.8.1 (#60)

Author: mickel8

README.md

@@ -30,7 +30,7 @@ as WebRTC multiplexes traffic on a single socket but PRs are welcomed
 ```elixir
 def deps do
   [
-    {:ex_ice, "~> 0.8.0"}
+    {:ex_ice, "~> 0.8.1"}
   ]
 end
 ```

lib/ex_ice/priv/ice_agent.ex

@@ -879,9 +879,13 @@ defmodule ExICE.Priv.ICEAgent do
         {t_id, t}
       else
         {false, client, sock_ip} ->
-          Logger.warning(
-            "Client's IP family doesn't match the socket's IP family (Client IP: #{inspect(client.turn_ip)} vs Socket IP: #{inspect(sock_ip)}). Ignoring."
-          )
+          Logger.debug("""
+          TURN's IP family doesn't match socket's IP family.
+          TURN: #{inspect(turn_server)}.
+          TURN IP: #{inspect(client.turn_ip)}.
+          Socket IP: #{inspect(sock_ip)}.
+          Ignoring.
+          """)
 
           {nil, nil}
 
@@ -2065,7 +2069,7 @@ defmodule ExICE.Priv.ICEAgent do
             |> Map.put(:url, url)
 
           :error ->
-            Logger.warning("Couldn't parse URL: #{inspect(ice_server.url)}. Ignoring.")
+            Logger.warning("Couldn't parse URL: #{inspect(url)}. Ignoring.")
             nil
         end
       end)

mix.exs

@@ -1,7 +1,7 @@
 defmodule ExICE.MixProject do
   use Mix.Project
 
-  @version "0.8.0"
+  @version "0.8.1"
   @source_url "https://github.com/elixir-webrtc/ex_ice"
 
   def project do

test/priv/ice_agent_test.exs

@@ -21,6 +21,16 @@ defmodule ExICE.Priv.ICEAgentTest do
     end
   end
 
+  defmodule IfDiscovery.IPV6.Mock do
+    @behaviour ExICE.Priv.IfDiscovery
+
+    @impl true
+    def getifaddrs() do
+      ifs = [{~c"mockif", [{:flags, [:up, :running]}, {:addr, {64_512, 0, 0, 0, 0, 0, 0, 1}}]}]
+      {:ok, ifs}
+    end
+  end
+
   defmodule Candidate.Mock do
     @moduledoc false
     @behaviour ExICE.Priv.Candidate
@@ -68,38 +78,6 @@ defmodule ExICE.Priv.ICEAgentTest do
     end
   end
 
-  describe "gather_candidates/1" do
-    setup do
-      ice_agent =
-        ICEAgent.new(
-          gathering_state: :new,
-          ice_transport_policy: :all,
-          controlling_process: self(),
-          role: :controlling,
-          if_discovery_module: IfDiscovery.Mock,
-          transport_module: Transport.Mock
-        )
-
-      %{ice_agent: ice_agent}
-    end
-
-    test ~c"Agent with invalid TURN server url doesn't raise an exception", %{
-      ice_agent: ice_agent
-    } do
-      assert %ICEAgent{gathering_state: :complete} =
-               ICEAgent.gather_candidates(%{
-                 ice_agent
-                 | turn_servers: [
-                     %{
-                       url: "invalid.turn.url",
-                       username: "user",
-                       credential: "pass"
-                     }
-                   ]
-               })
-    end
-  end
-
   describe "add_remote_candidate/2" do
     setup do
       ice_agent =
@@ -1550,6 +1528,46 @@ defmodule ExICE.Priv.ICEAgentTest do
       # assert gathering transaction failed
       assert ice_agent.gathering_transactions == %{}
     end
+
+    test "invalid TURN URL" do
+      ice_agent =
+        ICEAgent.new(
+          controlling_process: self(),
+          role: :controlling,
+          transport_module: Transport.Mock,
+          if_discovery_module: IfDiscovery.Mock,
+          ice_servers: [
+            %{
+              urls: "turn:invalid.turn.url:#{@turn_port}?transport=udp",
+              username: @turn_username,
+              credential: @turn_password
+            }
+          ]
+        )
+        |> ICEAgent.set_remote_credentials("someufrag", "somepwd")
+
+      assert %ICEAgent{gathering_state: :complete} = ICEAgent.gather_candidates(ice_agent)
+    end
+
+    test "non-matching IP families" do
+      ice_agent =
+        ICEAgent.new(
+          controlling_process: self(),
+          role: :controlling,
+          transport_module: Transport.Mock,
+          if_discovery_module: IfDiscovery.IPV6.Mock,
+          ice_servers: [
+            %{
+              urls: "turn:#{@turn_ip_str}:#{@turn_port}?transport=udp",
+              username: @turn_username,
+              credential: @turn_password
+            }
+          ]
+        )
+        |> ICEAgent.set_remote_credentials("someufrag", "somepwd")
+
+      assert %ICEAgent{gathering_state: :complete} = ICEAgent.gather_candidates(ice_agent)
+    end
   end
 
   test "relay ice_transport_policy" do