Create an ssh server to emulate ssh connection (#202)

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

Author: Peter Marki

.travis.yml

@@ -8,7 +8,7 @@ services:
   - docker
 
 before_install:
-  - if [[ "$RUN_DOCKER" == "yes" ]]; then docker pull iotjs/js_remote_test:0.4; fi
+  - if [[ "$RUN_DOCKER" == "yes" ]]; then docker pull iotjs/js_remote_test:0.5; fi
 
 install:
   - pip install pylint

install-deps.sh

@@ -29,4 +29,4 @@ sudo apt-get install -y binutils-arm-linux-gnueabi
 sudo apt-get install -y mosquitto
 sudo apt-get install -y autotools-dev automake
 
-sudo pip install paramiko pyserial pyrebase
+sudo pip install paramiko pyserial pyrebase twisted

jstest/__init__.py

@@ -14,7 +14,7 @@
 
 from jstest.builder.builder import Builder
 from jstest.common import console, paths, symbol_resolver, utils
-from jstest.emulate import pseudo_terminal
+from jstest.emulate import pseudo_terminal, twisted_server
 from jstest.flasher import flasher
 from jstest.testresult import TestResult
 from jstest.testrunner.testrunner import TestRunner

jstest/__main__.py

@@ -21,7 +21,7 @@
 
 import jstest
 from jstest import Builder, TestResult, TestRunner
-from jstest import flasher, paths, pseudo_terminal, utils
+from jstest import flasher, paths, pseudo_terminal, twisted_server, utils
 
 
 def parse_options():
@@ -83,11 +83,18 @@ def parse_options():
                         action='store_true', default=False,
                         help='display less verbose output')
 
+    parser.add_argument('--emulate',
+                       default=False, action='store_true',
+                       help='emulate the connection')
+
     group = parser.add_argument_group("Secure Shell communication")
 
     group.add_argument('--username',
                        metavar='USER',
-                       help='specify the username to login to the device.')
+                       help='specify the username to login to the device')
+
+    group.add_argument('--password',
+                       help='specify the password to login to the device')
 
     group.add_argument('--ip',
                        metavar='IPADDR',
@@ -111,9 +118,6 @@ def parse_options():
                        type=int, default=115200,
                        help='specify the baud rate (default: %(default)s)')
 
-    group.add_argument('--emulate',
-                       default=False, action='store_true',
-                       help='Emulate the serial connection.')
 
     group = parser.add_argument_group("Telnet communication")
 
@@ -144,7 +148,14 @@ def adjust_options(options):
         options.no_flash = True
 
         if options.device in ['rpi2', 'artik530']:
-            options.no_test = True
+            options.username = 'js-remote-test'
+            options.password = 'jerry'
+            options.ip = '127.0.0.1'
+            options.port = 2022
+            options.remote_workdir = 'emulated_workdir'
+            options.sshclient_no_exec_command = True
+            twisted_server.run()
+            atexit.register(twisted_server.stop)
 
         else:
             options.device_id = pseudo_terminal.open_pseudo_terminal(options.device)

jstest/emulate/private.key

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEowIBAAKCAQEAtxV6wowrKyEL4duGt3miJRoPd1AUc3kr6F8MA3j5t8e2G4+1
+F9CKhG0ja1LFyTv1pTc1pPjxe4qwgLYyhh9pDaf3ElmEiOsWWu9Uk71lhxfDpd+m
+Z8Oa9vUiczWPvU5DyqCcjYnjqOX4sJuZe3Osm/Wo61JNWsfsf+84mUOTbB8dsB+r
+0SDLx/T5V+Tc9R+aAllDPJippje8kXhWxfBYfuLtdqYf7Ks92Ye2m4nH3OmdDuKG
+xy+jPQu5qOOWwSnka+m/TchRYlZgZydBXbGk7WsDgnZ5jFr0KCKzMeS0th2tECfE
+EGwV8QQIxgtBtnJo7UE6CLhpwaLm9eYz+IehDQIDAQABAoIBACnWPrc2UKcKZiy2
+fZJvuR3BVsdtBT9d8SqojZY9jtLwUCz8KeXHQeABEJb10zyo9vlKJHgOayBQEQVY
+nTMI+nikaVFII4EmN3WQO0OHhCvawlqlQOF1UXQdkEHDe5VGzTcAfMXbPKrb4nh5
+Fhmf1VHOUUt1Azg7d0/E2qorRwTttGeb+TmxlNEt3tb4fXXyXpEtB12Ts/F5dE9x
+FHmAdc38KroiLDnHt1mssGHa0kQ86fkRL8LzwgH00scF/UqQRF0Jk2LgUFOuucz+
+4PKXM8GTp1ezf8X2xkJxXXhD6CcEGGf4i/609sSfqMW4rOI+oWCLTRlArbUOEuec
+Y6F68AECgYEA2wCwG+bdJPJzHvlcpozGJOPBcsuXXYUK6n7rZdT/hsZVGlK3861h
+qWBJR5csA7FTiK48ELjfECXuy+cC6hk7dt0+ZtegVYxcORL/Wlrsem/tOYluVH/D
+hP4/w6QQHwldxaC9VBI+YVRkKQbjwV+hb++Tufjz+1gzf9SHJGdUR3kCgYEA1gNl
+J5zzilemOo9dMlTu/LeOpH/bzSKWS1s15l38C3T2+ZjFCdrYDm7IG5+Gcq6b2pDe
+pvFDXJC0pId4q0dtFCrgH+gk66F7BGSw9pNQi28keV5RCueOeSAu+LBEttsJNouS
+Bx3jfgVES2pX3fbkml9gI4oPzKw+CTihmos1PTUCgYATuPYjLSFRSHxRl8deQGM/
+wzsSqX8SLv8Sqydr3ki8zHOxkS17xmt7I262Ack28+s/7eD+6Ic+HwxoVH+QsYEH
+bVlHTbfkvGU5xpo0eue9BwNoIRZMic0D1xnK9qV1BhTpzVX/kj0H6t+ySiqMqZ4S
+RJMbNm5Sflj09CDPiHawkQKBgQCm3ZDSeSre1AZ1JHEbHGQWwZxDoLml0XD0IpL9
+Ioyx9inXZQlE7NCHOFNoTlLLOl+k5E3mRrkqBF4E5ufsTE29aszDtAKNgqPjQgtE
+xooHncoHo8V2xiMtSC23k+CP3mrpj5t1VxWYncypLKqEE8wcnX7dVvmIsUfRcsl2
+MVJ6fQKBgFndag1Je9yKdXAqVMEFZ1tsrc2QA4V3OxhsTCxy/tdkAuFCUAQfpgRR
+n7UHwYTy2c1/MywGKlKUXQn8KovOXfbwzmom18YXB7y1jbLAiGONKzryA79cR9gx
+xy+R6b/W4vK8E2rnDTTsCUFqsy2y+c5xZT0wCqK1SE7mvUbiR6Yp
+-----END RSA PRIVATE KEY-----

jstest/emulate/public.key

@@ -0,0 +1 @@
+ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC3FXrCjCsrIQvh24a3eaIlGg93UBRzeSvoXwwDePm3x7Ybj7UX0IqEbSNrUsXJO/WlNzWk+PF7irCAtjKGH2kNp/cSWYSI6xZa71STvWWHF8Ol36Znw5r29SJzNY+9TkPKoJyNieOo5fiwm5l7c6yb9ajrUk1ax+x/7ziZQ5NsHx2wH6vRIMvH9PlX5Nz1H5oCWUM8mKmmN7yReFbF8Fh+4u12ph/sqz3Zh7abicfc6Z0O4obHL6M9C7mo45bBKeRr6b9NyFFiVmBnJ0FdsaTtawOCdnmMWvQoIrMx5LS2Ha0QJ8QQbBXxBAjGC0G2cmjtQToIuGnBoub15jP4h6EN marpeter@marpeter-H61M-S2V-B3

jstest/emulate/ssh-passwords

@@ -0,0 +1 @@
+js-remote-test:jerry

jstest/emulate/twisted_server.py

@@ -0,0 +1,111 @@
+# Copyright 2018-present Samsung Electronics Co., Ltd. and other contributors
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import json
+import os
+from threading import Thread
+
+from twisted.cred.portal import Portal
+from twisted.conch.ssh.factory import SSHFactory
+from twisted.internet import reactor
+from twisted.conch.ssh.keys import Key
+from twisted.cred.checkers import FilePasswordDB
+from twisted.conch.interfaces import IConchUser
+from twisted.conch.avatar import ConchUser
+from twisted.conch.ssh.channel import SSHChannel
+from twisted.internet.protocol import Protocol
+from twisted.conch.ssh.session import SSHSessionProcessProtocol, wrapProtocol
+
+
+class SimpleSession(SSHChannel):
+    name = 'session'
+
+    # pylint: disable=invalid-name
+    def dataReceived(self, data):
+        cmd = str(data)
+
+        if 'iotjs_build_info' in cmd:
+            result = {
+                'builtins': {},
+                'features': {},
+                'stability': 'stable'
+            }
+        else:
+            result = {
+                'output': 'Hello from the emulated device',
+                'memstat': {
+                    'heap-system': 'n/a',
+                    'heap-jerry': 'n/a',
+                    'stack': 'n/a'
+                },
+                'exitcode': int('fail' in cmd)
+            }
+
+        self.write(json.dumps(result) + '\r\n')
+
+    # pylint: enable=invalid-name
+    # pylint: disable=unused-argument
+    def request_shell(self, data):
+        protocol = Protocol()
+        transport = SSHSessionProcessProtocol(self)
+        protocol.makeConnection(transport)
+        transport.makeConnection(wrapProtocol(protocol))
+        self.client = transport
+        return True
+
+    @staticmethod
+    def request_pty_req(data):
+        return True
+    # pylint: enable=unused-argument
+
+class SimpleRealm(object):
+    @staticmethod
+    # pylint: disable=invalid-name,unused-argument
+    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():
+    '''
+    Run a threaded server.
+    '''
+    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()
+        private_key = Key.fromString(data=private_blob)
+
+    with open(os.path.join(this_dir, 'public.key')) as public_blob_file:
+        public_blob = public_blob_file.read()
+        public_key = Key.fromString(data=public_blob)
+
+    factory = SSHFactory()
+    factory.privateKeys = {'ssh-rsa': private_key}
+    factory.publicKeys = {'ssh-rsa': public_key}
+
+    factory.portal = Portal(SimpleRealm())
+    factory.portal.registerChecker(FilePasswordDB(os.path.join(this_dir, 'ssh-passwords')))
+
+    reactor.listenTCP(2022, factory, interface='127.0.0.1')
+    thread = Thread(target=reactor.run, args=(False,))
+    thread.daemon = True
+    thread.start()
+
+
+def stop():
+    '''
+    Stop the threaded server.
+    '''
+    reactor.callFromThread(reactor.stop)

jstest/testrunner/devices/connections/sshcom.py

@@ -24,25 +24,35 @@ class SSHConnection(object):
     '''
     def __init__(self, device_info):
         self.username = device_info['username']
+        self.password = device_info['password']
         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']
 
         # Note: add your SSH key to the known host file
         # to avoid getting password.
         self.ssh = paramiko.client.SSHClient()
-        self.ssh.load_system_host_keys()
+        if not self.password:
+            self.ssh.load_system_host_keys()
         self.ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
 
     def open(self):
         '''
-        Open the serial port.
+        Open the ssh port.
         '''
-        self.ssh.connect(hostname=self.ip, port=self.port, username=self.username)
+        self.ssh.connect(hostname=self.ip, port=self.port, username=self.username,
+                         password=self.password, look_for_keys=bool(self.password))
+
+        if self._no_exec_command:
+            self.chan = self.ssh.invoke_shell()
+            self.chan_file = self.chan.makefile('r')
 
     def close(self):
         '''
-        Close the serial port.
+        Close the ssh port.
         '''
         self.ssh.close()
 
@@ -51,9 +61,31 @@ def exec_command(self, cmd):
         Send command over the serial port.
         '''
         try:
-            _, stdout, _ = self.ssh.exec_command(cmd, timeout=self.timeout)
+            if self._no_exec_command:
+                self.send(cmd)
+                response = self.receive()
+
+            else:
+                _, stdout, _ = self.ssh.exec_command(cmd, timeout=self.timeout)
+
+                response = stdout.readline()
+
+        except socket.timeout:
+            raise TimeoutException
 
-            return stdout.readline()
+        return response
 
+    def send(self, cmd):
+        '''
+        Send data over the ssh channel.
+        '''
+        self.chan.send(cmd + '\n')
+
+    def receive(self):
+        '''
+        Receive data from the ssh channel.
+        '''
+        try:
+            return self.chan_file.readline().strip('\r\n')
         except socket.timeout:
             raise TimeoutException

jstest/testrunner/devices/ssh_device.py

@@ -33,9 +33,11 @@ def __init__(self, env, os):
 
         data = {
             'username': self.user,
+            'password': env.options.password,
             'ip': self.ip,
             'port': self.port,
-            'timeout': env.options.timeout
+            'timeout': env.options.timeout,
+            '_no_exec_command': hasattr(env.options, 'sshclient_no_exec_command')
         }
 
         self.channel = SSHConnection(data)