Add info/1 function for debugging connections

Author: pmeinhardt

lib/sshkit/connection.ex

@@ -101,7 +101,7 @@ defmodule SSHKit.Connection do
 
   Returns `{:ok, conn}` or `{:error, reason}`.
   """
-  @spec reopen(term(), keyword()) :: {:ok, t()} | {:error, term()}
+  @spec reopen(t(), keyword()) :: {:ok, t()} | {:error, term()}
   def reopen(conn, options \\ []) do
     options =
       conn.options
@@ -110,4 +110,21 @@ defmodule SSHKit.Connection do
 
     open(conn.host, options)
   end
+
+  @doc """
+  Returns information about a connection.
+
+  For OTP versions prior to 21.1, only `:client_version`, `:server_version`,
+  `:user`, `:peer` and `:sockname` are available.
+
+  For details, see [`:ssh.connection_info/1`](http://erlang.org/doc/man/ssh.html#connection_info-1).
+  """
+  @spec info(t()) :: keyword()
+  def info(conn) do
+    if function_exported?(@core, :connection_info, 1) do
+      @core.connection_info(conn.ref)
+    else
+      @core.connection_info(conn.ref, [:client_version, :server_version, :user, :peer, :sockname])
+    end
+  end
 end

test/sshkit/connection_test.exs

@@ -129,7 +129,7 @@ defmodule SSHKit.ConnectionTest do
       end)
 
       conn = %Connection{
-        host: 'foo.io',
+        host: 'test.io',
         port: 22,
         options: [user_interaction: false],
         ref: :connection_ref
@@ -140,7 +140,7 @@ defmodule SSHKit.ConnectionTest do
   end
 
   describe "reopen/2" do
-    test "opens a new connection with the same options as the existing connection" do
+    test "opens a new connection with the same options as an existing connection" do
       conn = %Connection{
         host: 'test.io',
         port: 22,
@@ -160,7 +160,7 @@ defmodule SSHKit.ConnectionTest do
       assert reopen(conn) == {:ok, new_conn}
     end
 
-    test "reopens a connection on new port" do
+    test "reopens a connection on a new port" do
       conn = %Connection{
         host: 'test.io',
         port: 22,
@@ -178,12 +178,12 @@ defmodule SSHKit.ConnectionTest do
       assert reopen(conn, port: 666) == {:ok, new_conn}
     end
 
-    test "errors when unable to open connection" do
+    test "errors when unable to open a connection" do
       conn = %Connection{
         host: 'test.io',
         port: 22,
-        options: [user_interaction: false],
-        ref: :sandbox
+        options: [],
+        ref: :connection_ref
       }
 
       expect(@core, :connect, fn _, _, _, _ ->
@@ -193,4 +193,30 @@ defmodule SSHKit.ConnectionTest do
       assert reopen(conn) == {:error, :failed}
     end
   end
+
+  describe "info/1" do
+    test "returns information about a connection" do
+      if function_exported?(@core, :connection_info, 1) do
+        expect(@core, :connection_info, fn ref ->
+          assert ref == :connection_ref
+          [info: :test]
+        end)
+      else
+        expect(@core, :connection_info, fn ref, keys ->
+          assert ref == :connection_ref
+          assert keys == [:client_version, :server_version, :user, :peer, :sockname]
+          [info: :test]
+        end)
+      end
+
+      conn = %Connection{
+        host: 'test.io',
+        port: 22,
+        options: [],
+        ref: :connection_ref
+      }
+
+      assert info(conn) == [info: :test]
+    end
+  end
 end