Merge branch 'release/0.5.5'

Author: hugoduncan

README.md

@@ -86,7 +86,7 @@ system, then a local, isolated ssh-agent can be used.
 
 ```clj
 (let [agent (ssh-agent {:use-system-ssh-agent false})]
-  (add-identity agent "/user/name/.ssh/id_rsa")
+  (add-identity agent {:private-key-path "/user/name/.ssh/id_rsa"})
   (let [session (session agent "localhost" {:strict-host-key-checking :no})]
     (with-connection session
       (let [result (ssh session {:in "echo hello"})]
@@ -143,7 +143,7 @@ Thanks to [Ryan Stradling](http://github.com/rstradling) for these.
 Via [clojars](http://clojars.org) and
 [Leiningen](http://github.com/technomancy/leiningen).
 
-    :dependencies [clj-ssh "0.5.4"]
+    :dependencies [clj-ssh "0.5.5"]
 
 or your favourite maven repository aware tool.
 

ReleaseNotes.md

@@ -1,6 +1,12 @@
 # Release Notes
 
-Current release is 0.5.4
+Current release is 0.5.5
+
+## 0.5.5
+
+- Wrap open-channel exceptions
+  When .openChannel throws an exception, wrap it in an ex-info exception. 
+  This allows easier procession of the exceptions in consuming code.
 
 ## 0.5.4
 

project.clj

@@ -1,4 +1,4 @@
-(defproject clj-ssh "0.5.4"
+(defproject clj-ssh "0.5.5"
   :description "Library for using SSH from clojure."
   :url "https://github.com/hugoduncan/clj-ssh"
   :license {:name "Eclipse Public License"

src/clj_ssh/ssh.clj

@@ -36,7 +36,7 @@
     ByteArrayInputStream ByteArrayOutputStream
     PipedInputStream PipedOutputStream]
    [com.jcraft.jsch
-    JSch Session Channel ChannelShell ChannelExec ChannelSftp
+    JSch Session Channel ChannelShell ChannelExec ChannelSftp JSchException
     Identity IdentityFile Logger KeyPair LocalIdentityRepository]))
 
 ;;; forward jsch's logging to java logging
@@ -373,7 +373,28 @@ keys.  All other option key pairs will be passed as SSH config options."
 (defn open-channel
   "Open a channel of the specified type in the session."
   [^Session session session-type]
-  (.openChannel session (name session-type)))
+  (try
+    (.openChannel session (name session-type))
+    (catch JSchException e
+      (let [msg (.getMessage e)]
+        (cond
+         (= msg "session is down")
+         (throw (ex-info (format "clj-ssh open-channel failure: %s" msg)
+                         {:type :clj-ssh/open-channel-failure
+                          :reason :clj-ssh/session-down}
+                         e))
+         (= msg "channel is not opened.")
+         (throw (ex-info
+                 (format
+                  "clj-ssh open-channel failure: %s (possible session timeout)"
+                  msg)
+                 {:type :clj-ssh/open-channel-failure
+                  :reason :clj-ssh/channel-open-failed}
+                 e))
+         :else (throw (ex-info (format "clj-ssh open-channel failure: %s" msg)
+                               {:type :clj-ssh/open-channel-failure
+                                :reason :clj-ssh/unknown}
+                               e)))))))
 
 (defn sftp-channel
   "Open a SFTP channel in the session."