Use interactive shell for all ssh devices (emulated and non-emulated) (#220)

JSRemoteTest-DCO-1.0-Signed-off-by: Peter Marki [email protected]

Author: Peter Marki

jstest/__main__.py

@@ -157,8 +157,8 @@ def adjust_options(options):
             options.ip = '127.0.0.1'
             options.port = 2022
             options.remote_workdir = 'emulated_workdir'
-            options.sshclient_no_exec_command = True
-            twisted_server.run()
+
+            twisted_server.run(options.device)
             atexit.register(twisted_server.stop)
 
         else:

jstest/emulate/twisted_server.py

@@ -31,7 +31,15 @@
 class SimpleSession(SSHChannel):
     name = 'session'
 
-    # pylint: disable=invalid-name
+    @staticmethod
+    def set_prompt(prompt):
+        SimpleSession.prompt = prompt
+
+    #pylint: disable=invalid-name,unused-argument
+    def channelOpen(self, specificData):
+        self.write(SimpleSession.prompt)
+    #pylint: enable=unused-argument
+
     def dataReceived(self, data):
         cmd = str(data)
 
@@ -53,6 +61,7 @@ def dataReceived(self, data):
             }
 
         self.write(json.dumps(result) + '\r\n')
+        self.write(SimpleSession.prompt)
 
     # pylint: enable=invalid-name
     # pylint: disable=unused-argument
@@ -70,18 +79,22 @@ def request_pty_req(data):
     # pylint: enable=unused-argument
 
 class SimpleRealm(object):
-    @staticmethod
     # pylint: disable=invalid-name,unused-argument
+    @staticmethod
     def requestAvatar(avatar_id, mind, *interfaces):
         user = ConchUser()
         user.channelLookup['session'] = SimpleSession
         return IConchUser, user, lambda: None
     # pylint: enable=invalid-name,unused-argument
 
-def run():
+def run(device):
     '''
     Run a threaded server.
     '''
+    prompts = {
+        'rpi2': ':~$',
+        'artik530': ':~>'
+    }
     this_dir = os.path.dirname(__file__)
     with open(os.path.join(this_dir, 'private.key')) as private_blob_file:
         private_blob = private_blob_file.read()
@@ -95,6 +108,7 @@ def run():
     factory.privateKeys = {'ssh-rsa': private_key}
     factory.publicKeys = {'ssh-rsa': public_key}
 
+    SimpleSession.set_prompt(prompts[device])
     factory.portal = Portal(SimpleRealm())
     factory.portal.registerChecker(FilePasswordDB(os.path.join(this_dir, 'ssh-passwords')))
 

jstest/resources/etc/tester.py

@@ -176,6 +176,9 @@ def run_iotjs(options):
     stack_peak = 'n/a'
     malloc_peak = 'n/a'
 
+    if options.iotjs_build_info:
+        return json.loads(output.split('\n')[0])
+
     if output.find('Heap stats:') != -1:
         # Process jerry-memstat output.
         match = re.search(r'Peak allocated = (\d+) bytes', str(output))
@@ -250,6 +253,10 @@ def parse_arguments():
                         action='store_true', default=False,
                         help='do not measure memory statistics (default: %(default)s)')
 
+    parser.add_argument('--iotjs-build-info',
+                        action='store_true', default=False,
+                        help='Run the buildinfo script for iotjs')
+
     return parser.parse_args()
 
 

jstest/testrunner/devices/artik530.py

@@ -19,4 +19,5 @@ class ARTIK530Device(SSHDevice):
     Device of the ARTIK530 target.
     '''
     def __init__(self, env):
-        SSHDevice.__init__(self, env, 'tizen')
+        # Note: the PS1 prompt on the device has to have this ending.
+        SSHDevice.__init__(self, env, 'tizen', ':~>')

jstest/testrunner/devices/connections/sshcom.py

@@ -28,9 +28,7 @@ def __init__(self, device_info):
         self.ip = device_info['ip']
         self.port = device_info['port']
         self.timeout = device_info['timeout']
-        # FIXME: the exec_command method of paramiko.client.SSHClient cannot be used with the
-        # emulated ssh server.
-        self._no_exec_command = device_info['_no_exec_command']
+        self.prompt = device_info['prompt']
 
         # Note: add your SSH key to the known host file
         # to avoid getting password.
@@ -46,9 +44,8 @@ def open(self):
         self.ssh.connect(hostname=self.ip, port=self.port, username=self.username,
                          password=self.password, look_for_keys=not bool(self.password))
 
-        if self._no_exec_command:
-            self.chan = self.ssh.invoke_shell()
-            self.chan_file = self.chan.makefile('r')
+        self.chan = self.ssh.invoke_shell()
+        self.read_until(self.prompt)
 
     def close(self):
         '''
@@ -60,32 +57,32 @@ def exec_command(self, cmd):
         '''
         Send command over the serial port.
         '''
+        self.chan.settimeout(self.timeout)
         try:
-            if self._no_exec_command:
-                self.send(cmd)
-                response = self.receive()
-
-            else:
-                _, stdout, _ = self.ssh.exec_command(cmd, timeout=self.timeout)
-
-                response = stdout.readline()
-
+            self.send(cmd)
+            data = self.read_until(self.prompt)
         except socket.timeout:
             raise TimeoutException
 
-        return response
+        return data
 
     def send(self, cmd):
         '''
         Send data over the ssh channel.
         '''
         self.chan.send(cmd + '\n')
 
-    def receive(self):
+    def read_until(self, expected):
         '''
-        Receive data from the ssh channel.
+        Receive data from the server until we get the expected pattern.
         '''
+        temp = ''
+        while expected not in temp:
+            temp += self.chan.recv(1)
+
+        temp = temp.split('\r\n')
         try:
-            return self.chan_file.readline().strip('\r\n')
-        except socket.timeout:
-            raise TimeoutException
+            temp.pop()
+            return temp[-1]
+        except IndexError:
+            pass

jstest/testrunner/devices/device_base.py

@@ -66,9 +66,11 @@ def iotjs_build_info(self):
             return set(), set(), 'stable'
 
         if self.device in ['rpi2', 'artik530']:
+            tester_py = 'python %s/tester.py ' % self.workdir
             iotjs = '%s/iotjs' % self.workdir
             buildinfo = '%s/tests/tools/iotjs_build_info.js' % self.workdir
-            command = '%s %s' % (iotjs, buildinfo)
+            template = '%s --cwd %s --cmd %s --testfile %s --iotjs-build-info'
+            command = template % (tester_py, self.workdir, iotjs, buildinfo)
 
         elif self.device in ['artik053', 'stm32f4dis']:
             buildinfo = '/test/tools/iotjs_build_info.js'
@@ -92,6 +94,4 @@ def iotjs_build_info(self):
         features = set(info['features'])
         stability = info['stability']
 
-        self.logout()
-
         return builtins, features, stability

jstest/testrunner/devices/rpi2.py

@@ -19,4 +19,5 @@ class RPi2Device(SSHDevice):
     Device of the Raspberry Pi 2 target.
     '''
     def __init__(self, env):
-        SSHDevice.__init__(self, env, 'linux')
+        # Note: the PS1 prompt on the device has to have this ending.
+        SSHDevice.__init__(self, env, 'linux', ':~$')

jstest/testrunner/devices/ssh_device.py

@@ -25,7 +25,7 @@ class SSHDevice(RemoteDevice):
     '''
     Common super class for ssh devices.
     '''
-    def __init__(self, env, os):
+    def __init__(self, env, os, prompt):
         self.user = env.options.username
         self.ip = env.options.ip
         self.port = env.options.port
@@ -37,12 +37,20 @@ def __init__(self, env, os):
             'ip': self.ip,
             'port': self.port,
             'timeout': env.options.timeout,
-            '_no_exec_command': hasattr(env.options, 'sshclient_no_exec_command')
+            'prompt': prompt
         }
 
         self.channel = SSHConnection(data)
         self.workdir = env.options.remote_workdir
 
+        self.login()
+
+    def __del__(self):
+        '''
+        Destructor function.
+        '''
+        self.logout()
+
     def check_args(self):
         '''
         Check that all the arguments are established.
@@ -64,8 +72,6 @@ def execute(self, testset, test):
         FIXME: Remove the external tester.py to eliminate code duplications.
                Instead, this function should send commands to the device.
         '''
-        self.login()
-
         template = 'python %s/tester.py --cwd %s --cmd %s --testfile %s'
         # Absolute path to the test folder.
         testdir = '%s/tests' % self.workdir
@@ -97,12 +103,9 @@ def execute(self, testset, test):
             client_thread.start()
 
         stdout = self.channel.exec_command(command)
-
         # Since the stdout is a JSON text, parse it.
         result = json.loads(stdout)
         # Make HTML friendly stdout.
         result['output'] = result['output'].rstrip('\n').replace('\n', '<br>')
 
-        self.logout()
-
         return result