Merge release/0.5.11

Author: pbors

README.md

@@ -163,7 +163,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.10"]
+    :dependencies [clj-ssh "0.5.11"]
 
 or your favourite maven repository aware tool.
 
@@ -191,6 +191,10 @@ On OS X, use:
 ssh-add -K ~/.ssh/clj_ssh_pp
 ```
 
+## Other Libraries
+
+For plain `ftp`, you might want to look at [clj-ftp](https://github.com/miner/clj-ftp).
+
 ## License
 
 Copyright © 2012 Hugo Duncan

ReleaseNotes.md

@@ -1,3 +1,13 @@
+## 0.5.11
+
+- Lock known hosts file
+  Try and prevent concurrent read and writes to the known hosts file.
+
+- Fix :out :stream in the cli namespace
+  Caller becomes responsible for closing the session.
+
+  Closes #29
+
 ## 0.5.10
 
 - Fix session? predicate

project.clj

@@ -1,6 +1,6 @@
 (def agentproxy-version "0.0.7")
 
-(defproject clj-ssh "0.5.10"
+(defproject clj-ssh "0.5.11"
   :description "Library for using SSH from clojure."
   :url "https://github.com/hugoduncan/clj-ssh"
   :license {:name "Eclipse Public License"

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.

src/clj_ssh/ssh.clj

@@ -132,6 +132,11 @@
   (satisfies? protocols/Session x))
 
 ;;; Agent
+(def ^:private hosts-file
+  "Something to lock to tray and prevent concurrent updates/reads to
+  hosts file."
+  (Object.))
+
 (defn ssh-agent
   "Create a ssh-agent. By default a system ssh-agent is preferred."
   [{:keys [use-system-ssh-agent ^String known-hosts-path]
@@ -142,7 +147,8 @@
     (when use-system-ssh-agent
       (agent/connect agent))
     (when known-hosts-path
-      (.setKnownHosts agent known-hosts-path))
+      (locking hosts-file
+        (.setKnownHosts agent known-hosts-path)))
     agent))
 
 ;;; Identities
@@ -391,9 +397,11 @@ keys.  All other option key pairs will be passed as SSH config options."
 (defn connect
   "Connect a session."
   ([session]
-     (protocols/connect session))
+     (locking hosts-file
+       (protocols/connect session)))
   ([session timeout]
-     (protocols/connect session timeout)))
+     (locking hosts-file
+       (protocols/connect session timeout))))
 
 (defn disconnect
   "Disconnect a session."
@@ -611,11 +619,10 @@ config options."
       (.setPty shell (boolean (opts :pty))))
     (when (contains? opts :agent-forwarding)
       (.setAgentForwarding shell (boolean (opts :agent-forwarding))))
-    (let [resp {:channel shell
-                :out (or out (.getInputStream shell))
-                :in (or in (.getOutputStream shell))}]
-      (connect-channel shell)
-      resp)))
+    (connect-channel shell)
+    {:channel shell
+     :out (or out (.getInputStream shell))
+     :in (or in (.getOutputStream shell))}))
 
 (defn ssh-shell
   "Run a ssh-shell."
@@ -996,6 +1003,7 @@ cmd specifies a command to exec.  Valid commands are:
 
 
 ;; http://blogs.sun.com/janp/entry/how_the_scp_protocol_works
+;; https://blogs.oracle.com/janp/entry/how_the_scp_protocol_works
 (defn scp-to
   "Copy local path(s) to remote path via scp.
 

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")))))))