From: Ross Brattain <ross.b.brattain@intel.com>
Date: Tue, 29 Nov 2016 21:24:54 +0000 (-0800)
Subject: fix SSH object examples to use correct context manager form
X-Git-Tag: danube.1.0~182^2
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F81%2F25181%2F1;p=yardstick.git

fix SSH object examples to use correct context manager form

change PseudoFile example to use io.RawIOBase baseclass

Change-Id: Ib5e3c844a0514274e5098061beb0ee6f8af97977
Signed-off-by: Ross Brattain <ross.b.brattain@intel.com>
---

diff --git a/yardstick/ssh.py b/yardstick/ssh.py
index 8b71fe606..d6ecffcb9 100644
--- a/yardstick/ssh.py
+++ b/yardstick/ssh.py
@@ -29,24 +29,29 @@ Execute command and get output:
 
 Execute command with huge output:
 
-    class PseudoFile(object):
+    class PseudoFile(io.RawIOBase):
         def write(chunk):
             if "error" in chunk:
                 email_admin(chunk)
 
-    ssh = sshclient.SSH("root", "example.com")
-    ssh.run("tail -f /var/log/syslog", stdout=PseudoFile(), timeout=False)
+    ssh = SSH("root", "example.com")
+    with PseudoFile() as p:
+        ssh.run("tail -f /var/log/syslog", stdout=p, timeout=False)
 
 Execute local script on remote side:
 
     ssh = sshclient.SSH("user", "example.com")
-    status, out, err = ssh.execute("/bin/sh -s arg1 arg2",
-                                   stdin=open("~/myscript.sh", "r"))
+
+    with open("~/myscript.sh", "r") as stdin_file:
+        status, out, err = ssh.execute('/bin/sh -s "arg1" "arg2"',
+                                       stdin=stdin_file)
 
 Upload file:
 
-    ssh = sshclient.SSH("user", "example.com")
-    ssh.run("cat > ~/upload/file.gz", stdin=open("/store/file.gz", "rb"))
+    ssh = SSH("user", "example.com")
+    # use rb for binary files
+    with open("/store/file.gz", "rb") as stdin_file:
+        ssh.run("cat > ~/upload/file.gz", stdin=stdin_file)
 
 Eventlet:
 
@@ -54,7 +59,7 @@ Eventlet:
     or
     eventlet.monkey_patch()
     or
-    sshclient = eventlet.import_patched("opentstack.common.sshclient")
+    sshclient = eventlet.import_patched("yardstick.ssh")
 
 """