Fix :out :stream in the cli namespace

Caller becomes responsible for closing the session.

Closes #29

Author: hugoduncan

src/clj_ssh/cli.clj

@@ -135,11 +135,14 @@ Options are:
 :cmd        specifies a command to exec.  If no cmd is given, a shell is started
             and input is taken from :in.
 :in         specifies input to the remote shell. A string or a stream.
+
 :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.
+            result string.
+            In the case of :stream, the shell can be polled for connected
+            status, and the session (in the :session key of the return value)
+            must be disconnected by the caller.
 :username   username to use for authentication
 :password   password to use for authentication
 :port       port to use if no session specified
@@ -152,13 +155,17 @@ sh returns a map of
   (let [{:keys [cmd in out username password port ssh-agent args]
          :or {ssh-agent *ssh-agent*}
          :as options} (parse-args args)
-        session (default-session ssh-agent hostname options)]
-    (ssh/with-connection session
-      (ssh/ssh
-       session
-       (if (seq args)
-         (merge {:cmd (string/join " " args)} options)
-         options)))))
+         session (default-session ssh-agent hostname options)
+         arg (if (seq args)
+               (merge {:cmd (string/join " " args)} options)
+               options)]
+    (if (= :stream (:out options))
+      (do
+        (ssh/connect session)
+        (assoc (ssh/ssh session arg)
+          :session session))
+      (ssh/with-connection session
+        (ssh/ssh session arg)))))
 
 (defn sftp
   "Execute SFTP commands.

test/clj_ssh/cli_test.clj

@@ -176,3 +176,34 @@
        (finally
         (.delete tmpfile1)
         (.delete tmpfile2))))))
+
+
+(deftest out-stream-test
+  (testing "exec"
+    (testing ":out :string"
+      (let [proc (ssh "localhost" "ls")]
+        (is (zero? (:exit proc)))
+        (is (pos? (count (:out proc))) "no options")))
+    (testing ":out :stream"
+      (let [proc (ssh "localhost" "ls" :out :stream :pty true)]
+        (is (clj-ssh.ssh/connected-channel? (:channel proc))
+            ":channel not connected")
+        (is (> (count (slurp (:out-stream proc))) 1) ":out-stream")
+        (Thread/sleep 100)
+        (is (zero? (clj-ssh.ssh/exit-status (:channel proc)))
+            "zero exit status")
+        (clj-ssh.ssh/disconnect (:session proc)))))
+  (testing "shell"
+    (testing ":out :string"
+      (let [proc (ssh "localhost" :in "ls")]
+        (is (pos? (count (:out proc))) ":out has content")
+        (is (zero? (:exit proc)) "zero exit status")))
+    (testing ":out stream"
+      (let [proc (ssh "localhost" :in "ls" :out :stream)]
+        (is (clj-ssh.ssh/connected-channel? (:channel proc))
+            ":channel connected")
+        (is (> (count (slurp (:out-stream proc))) 1) ":out-stream")
+        (Thread/sleep 100)
+        (is (zero? (clj-ssh.ssh/exit-status (:channel proc)))
+            "zero exit status")
+        (clj-ssh.ssh/disconnect (:session proc))))))

test/clj_ssh/ssh_test.clj

@@ -602,3 +602,36 @@
         (with-connection s
             (ssh-exec (the-session s) "ls" "" "" {})))
       "two hosts"))
+
+
+(deftest out-stream-test
+  (let [s (session (ssh-agent {}) "localhost" {})]
+    (with-connection s
+      (testing "exec"
+        (testing ":out :string"
+          (let [proc (ssh s {:cmd "ls"})]
+            (is (zero? (:exit proc)))
+            (is (pos? (count (:out proc))) "no options")))
+        (testing ":out :stream"
+          (let [proc (ssh s {:cmd "ls" :out :stream :pty true})]
+            (is (connected-channel? (:channel proc))
+                ":channel connected")
+            (is (> (count (slurp (:out-stream proc))) 1) ":out-stream")
+            (is (not (connected-channel? (:channel proc)))
+                ":channel not connected")
+            (is (zero? (exit-status (:channel proc)))
+                "zero exit status"))))
+      (testing "shell"
+        (testing ":out :string"
+          (let [proc (ssh s {:in "ls"})]
+            (is (pos? (count (:out proc))) ":out has content")
+            (is (zero? (:exit proc)) "zero exit status")))
+        (testing ":out stream"
+          (let [proc (ssh s {:in "ls" :out :stream})]
+            (is (connected-channel? (:channel proc))
+                ":channel connected")
+            (is (> (count (slurp (:out-stream proc))) 1) ":out-stream")
+            (is (not (connected-channel? (:channel proc)))
+                ":channel not connected")
+            (is (zero? (exit-status (:channel proc)))
+                "zero exit status")))))))