Merge branch 'release/0.2.3'

Author: hugoduncan

pom.xml

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>clj-ssh</groupId>
   <artifactId>clj-ssh</artifactId>
-  <version>0.2.3-SNAPSHOT</version>
+  <version>0.2.4-SNAPSHOT</version>
   <name>clj-ssh</name>
   <description>ssh from clojure</description>
   <scm>
@@ -64,9 +64,11 @@
           </configuration>
       </plugin>
       <plugin>
-	<groupId>org.apache.maven.plugins</groupId>
 	<artifactId>maven-release-plugin</artifactId>
 	<version>2.0</version>
+        <configuration>
+          <pushChanges>false</pushChanges>
+        </configuration>
       </plugin>
     </plugins>
   </build>

src/clj_ssh/ssh.clj

@@ -80,7 +80,7 @@ Licensed under EPL (http://www.eclipse.org/legal/epl-v10.html)"
 
 ;; Enable java logging of jsch when in clojure 1.2
 (when-feature deftype
- (def ssh-log-levels
+ (def ^{:dynamic true} *ssh-log-levels*
       {com.jcraft.jsch.Logger/DEBUG :debug
        com.jcraft.jsch.Logger/INFO  :info
        com.jcraft.jsch.Logger/WARN  :warn
@@ -94,7 +94,7 @@ Licensed under EPL (http://www.eclipse.org/legal/epl-v10.html)"
     (>= level log-level))
    (log
     [_ level message]
-    (logging/log (ssh-log-levels level) message nil "clj-ssh.ssh")))
+    (logging/log (*ssh-log-levels* level) message nil "clj-ssh.ssh")))
 
  (JSch/setLogger (SshLogger. com.jcraft.jsch.Logger/DEBUG)))
 
@@ -325,12 +325,18 @@ keys.  All other option key pairs will be passed as SSH config options."
   [#^Session session]
   (open-channel session :shell))
 
+(defn- streams-for-out
+  [out]
+  (if (= :stream out)
+    (let [os (java.io.PipedOutputStream.)]
+      [os (java.io.PipedInputStream. os)])
+    [(java.io.ByteArrayOutputStream.) nil]))
 
 (defn ssh-shell
   "Run a ssh-shell."
   [#^Session session in out opts]
   (let [#^ChannelShell shell (open-channel session :shell)
-        out-stream (java.io.ByteArrayOutputStream.)]
+        [out-stream out-inputstream] (streams-for-out out)]
     (doto shell
       (.setInputStream
        (if (string? in)
@@ -342,20 +348,24 @@ keys.  All other option key pairs will be passed as SSH config options."
       (call-method
        com.jcraft.jsch.ChannelSession 'setPty [Boolean/TYPE]
        shell (boolean (opts :pty))))
-    (with-connection shell
-      (while (connected? shell)
-             (Thread/sleep 100))
-      [(.getExitStatus shell)
-       (if (= :bytes out)
-         (.toByteArray out-stream)
-         (.toString out-stream out))])))
+    (if out-inputstream
+      (do
+        (connect shell)
+        [shell out-inputstream])
+      (with-connection shell
+        (while (connected? shell)
+          (Thread/sleep 100))
+        [(.getExitStatus shell)
+         (if (= :bytes out)
+           (.toByteArray out-stream)
+           (.toString out-stream out))]))))
 
 (defn ssh-exec
   "Run a command via ssh-exec."
   [#^Session session #^String cmd in out opts]
   (let [#^ChannelExec exec (open-channel session :exec)
-        out-stream (java.io.ByteArrayOutputStream.)
-        err-stream (java.io.ByteArrayOutputStream.)]
+        [out-stream out-inputstream] (streams-for-out out)
+        [err-stream err-inputstream] (streams-for-out out)]
     (doto exec
       (.setInputStream
        (if (string? in)
@@ -369,16 +379,20 @@ keys.  All other option key pairs will be passed as SSH config options."
       (call-method
        com.jcraft.jsch.ChannelSession 'setPty [Boolean/TYPE]
        exec (boolean (opts :pty))))
-    (with-connection exec
-      (while (connected? exec)
-             (Thread/sleep 100))
-      [(.getExitStatus exec)
-       (if (= :bytes out)
-        (.toByteArray out-stream)
-        (.toString out-stream out))
-       (if (= :bytes out)
-        (.toByteArray err-stream)
-        (.toString err-stream out))])))
+    (if out-inputstream
+      (do
+        (connect exec)
+        [exec out-inputstream err-inputstream])
+      (with-connection exec
+        (while (connected? exec)
+          (Thread/sleep 100))
+        [(.getExitStatus exec)
+         (if (= :bytes out)
+           (.toByteArray out-stream)
+           (.toString out-stream out))
+         (if (= :bytes out)
+           (.toByteArray err-stream)
+           (.toString err-stream out))]))))
 
 (defn default-session [host username port password]
   (doto (session-impl
@@ -409,7 +423,11 @@ cmd specifies a command to exec.  If no cmd is given, a shell is started and inp
 Options are
 
 :in         specifies input to the remote shell. A string or a stream.
-:out        specify :bytes or a string with an encoding specification.
+:out        specify :stream to obtain a an [inputstream shell],
+            specify :bytes to obtain a byte array,
+            or specify a string with an encoding specification for a
+            result string.  In the case of :stream, the shell can
+            be polled for connected status.
 :return-map when followed by boolean true, sh returns a map of
               :exit => sub-process's exit code
               :out  => sub-process's stdout (as byte[] or String)
@@ -437,14 +455,14 @@ Options are
        (let [result (ssh-shell
                      session
                      (:in opts) (:out opts) (dissoc opts :in :out :cmd))]
-         (if (opts :return-map)
+         (if (and (opts :return-map) (not= (:out opts) :stream))
            {:exit (first result) :out (second result)}
            result))
        (let [result (ssh-exec
                      session
                      (apply str (interpose " " (:cmd opts)))
                      (:in opts) (:out opts) (dissoc opts :in :out :cmd))]
-         (if (opts :return-map)
+         (if (and (opts :return-map) (not= (:out opts) :stream))
            {:exit (first result) :out (second result) :err (last result)}
            result)))
      (finally

test/clj_ssh/ssh_test.clj

@@ -234,6 +234,13 @@ list, Alan Dipert and MeikelBrandmeyer."
         (let [result (ssh-shell session "echo hello;exit 1" "UTF-8" {})]
           (is (= 1 (first result)))
           (is (.contains (second result) "hello")))
+        (let [[shell stream] (ssh-shell session "echo hello;exit 1" :stream {})]
+          (while (connected? shell) (Thread/sleep 100))
+          (is (= 1 (.getExitStatus shell)))
+          (is (pos? (.available stream)))
+          (let [bytes (byte-array 1024)
+                n (.read stream bytes 0 1024)]
+            (is (.contains (String. bytes 0 n)  "hello"))))
         (let [result (ssh-shell session "exit $(tty -s)" "UTF-8" {:pty true})]
           (is (= 0 (first result))))
         (let [result (ssh-shell session "exit $(tty -s)" "UTF-8" {:pty nil})]
@@ -249,10 +256,27 @@ list, Alan Dipert and MeikelBrandmeyer."
           (is (= 0 (first result)))
           (is (.contains (second result) "bin"))
           (is (= "" (last result))))
-        (let [result (ssh-exec session "/bin/bash -c 'lsxxxxx /'" nil "UTF-8" {})]
+        (let [result (ssh-exec
+                      session "/bin/bash -c 'lsxxxxx /'" nil "UTF-8" {})]
           (is (not (= 0 (first result))))
           (is (= "" (second result)))
-          (is (.contains (last result) "command not found")))))))
+          (is (.contains (last result) "command not found")))
+        (let [[exec out err] (ssh-exec
+                              session
+                              "/bin/bash -c 'ls / && lsxxxxx /'"
+                              nil :stream {})]
+          (while (connected? exec) (Thread/sleep 100))
+          (is (not= 0 (.getExitStatus exec)))
+          (is (pos? (.available out)))
+          (is (pos? (.available err)))
+          (let [out-bytes (byte-array 1024)
+                out-n (.read out out-bytes 0 1024)
+                err-bytes (byte-array 1024)
+                err-n (.read err err-bytes 0 1024)]
+            (is (.contains (String. out-bytes 0 out-n) "bin"))
+            (is (.contains
+                 (String. err-bytes 0 err-n)
+                 "command not found"))))))))
 
 (deftest ssh-test
   (with-ssh-agent [false]