Jim Flynn / Mbed OS wifi_Example

wifi test

Dependencies:   X_NUCLEO_IKS01A2 mbed-http

easy-connect/esp8266-driver/TESTS/net/host_tests/tcp_echo.py@0:24d3eb812fd4, 2018-09-05 (annotated)

Committer:
JMF
Date:
Wed Sep 05 14:28:24 2018 +0000
Revision:
0:24d3eb812fd4
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
JMF 0:24d3eb812fd4 1 # Copyright 2015 ARM Limited, All rights reserved
JMF 0:24d3eb812fd4 2 #
JMF 0:24d3eb812fd4 3 # Licensed under the Apache License, Version 2.0 (the "License");
JMF 0:24d3eb812fd4 4 # you may not use this file except in compliance with the License.
JMF 0:24d3eb812fd4 5 # You may obtain a copy of the License at
JMF 0:24d3eb812fd4 6 #
JMF 0:24d3eb812fd4 7 # http://www.apache.org/licenses/LICENSE-2.0
JMF 0:24d3eb812fd4 8 #
JMF 0:24d3eb812fd4 9 # Unless required by applicable law or agreed to in writing, software
JMF 0:24d3eb812fd4 10 # distributed under the License is distributed on an "AS IS" BASIS,
JMF 0:24d3eb812fd4 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
JMF 0:24d3eb812fd4 12 # See the License for the specific language governing permissions and
JMF 0:24d3eb812fd4 13 # limitations under the License.
JMF 0:24d3eb812fd4 14
JMF 0:24d3eb812fd4 15 import sys
JMF 0:24d3eb812fd4 16 import select
JMF 0:24d3eb812fd4 17 import socket
JMF 0:24d3eb812fd4 18 import logging
JMF 0:24d3eb812fd4 19 from threading import Thread
JMF 0:24d3eb812fd4 20 from sys import stdout
JMF 0:24d3eb812fd4 21 from SocketServer import BaseRequestHandler, TCPServer
JMF 0:24d3eb812fd4 22 from mbed_host_tests import BaseHostTest, event_callback
JMF 0:24d3eb812fd4 23
JMF 0:24d3eb812fd4 24
JMF 0:24d3eb812fd4 25 class TCPEchoClientHandler(BaseRequestHandler):
JMF 0:24d3eb812fd4 26 def handle(self):
JMF 0:24d3eb812fd4 27 """
JMF 0:24d3eb812fd4 28 Handles a connection. Test starts by client(i.e. mbed) connecting to server.
JMF 0:24d3eb812fd4 29 This connection handler receives data and echoes back to the client util
JMF 0:24d3eb812fd4 30 {{end}} is received. Then it sits on recv() for client to terminate the
JMF 0:24d3eb812fd4 31 connection.
JMF 0:24d3eb812fd4 32
JMF 0:24d3eb812fd4 33 Note: reason for not echoing data back after receiving {{end}} is that send
JMF 0:24d3eb812fd4 34 fails raising a SocketError as client closes connection.
JMF 0:24d3eb812fd4 35 """
JMF 0:24d3eb812fd4 36 while self.server.isrunning():
JMF 0:24d3eb812fd4 37 try:
JMF 0:24d3eb812fd4 38 data = self.recv()
JMF 0:24d3eb812fd4 39 if not data: break
JMF 0:24d3eb812fd4 40 except Exception as e:
JMF 0:24d3eb812fd4 41 break
JMF 0:24d3eb812fd4 42
JMF 0:24d3eb812fd4 43 try:
JMF 0:24d3eb812fd4 44 # echo data back to the client
JMF 0:24d3eb812fd4 45 self.send(data)
JMF 0:24d3eb812fd4 46 except Exception as e:
JMF 0:24d3eb812fd4 47 break
JMF 0:24d3eb812fd4 48
JMF 0:24d3eb812fd4 49 def recv(self):
JMF 0:24d3eb812fd4 50 """
JMF 0:24d3eb812fd4 51 Try to receive until server is shutdown
JMF 0:24d3eb812fd4 52 """
JMF 0:24d3eb812fd4 53 while self.server.isrunning():
JMF 0:24d3eb812fd4 54 rl, wl, xl = select.select([self.request], [], [], 1)
JMF 0:24d3eb812fd4 55 if len(rl):
JMF 0:24d3eb812fd4 56 return self.request.recv(1024)
JMF 0:24d3eb812fd4 57
JMF 0:24d3eb812fd4 58 def send(self, data):
JMF 0:24d3eb812fd4 59 """
JMF 0:24d3eb812fd4 60 Try to send until server is shutdown
JMF 0:24d3eb812fd4 61 """
JMF 0:24d3eb812fd4 62 while self.server.isrunning():
JMF 0:24d3eb812fd4 63 rl, wl, xl = select.select([], [self.request], [], 1)
JMF 0:24d3eb812fd4 64 if len(wl):
JMF 0:24d3eb812fd4 65 self.request.sendall(data)
JMF 0:24d3eb812fd4 66 break
JMF 0:24d3eb812fd4 67
JMF 0:24d3eb812fd4 68
JMF 0:24d3eb812fd4 69 class TCPServerWrapper(TCPServer):
JMF 0:24d3eb812fd4 70 """
JMF 0:24d3eb812fd4 71 Wrapper over TCP server to implement server initiated shutdown.
JMF 0:24d3eb812fd4 72 Adds a flag:= running that a request handler can check and come out of
JMF 0:24d3eb812fd4 73 recv loop when shutdown is called.
JMF 0:24d3eb812fd4 74 """
JMF 0:24d3eb812fd4 75
JMF 0:24d3eb812fd4 76 def __init__(self, addr, request_handler):
JMF 0:24d3eb812fd4 77 # hmm, TCPServer is not sub-classed from object!
JMF 0:24d3eb812fd4 78 if issubclass(TCPServer, object):
JMF 0:24d3eb812fd4 79 super(TCPServerWrapper, self).__init__(addr, request_handler)
JMF 0:24d3eb812fd4 80 else:
JMF 0:24d3eb812fd4 81 TCPServer.__init__(self, addr, request_handler)
JMF 0:24d3eb812fd4 82 self.running = False
JMF 0:24d3eb812fd4 83
JMF 0:24d3eb812fd4 84 def serve_forever(self):
JMF 0:24d3eb812fd4 85 self.running = True
JMF 0:24d3eb812fd4 86 if issubclass(TCPServer, object):
JMF 0:24d3eb812fd4 87 super(TCPServerWrapper, self).serve_forever()
JMF 0:24d3eb812fd4 88 else:
JMF 0:24d3eb812fd4 89 TCPServer.serve_forever(self)
JMF 0:24d3eb812fd4 90
JMF 0:24d3eb812fd4 91 def shutdown(self):
JMF 0:24d3eb812fd4 92 self.running = False
JMF 0:24d3eb812fd4 93 if issubclass(TCPServer, object):
JMF 0:24d3eb812fd4 94 super(TCPServerWrapper, self).shutdown()
JMF 0:24d3eb812fd4 95 else:
JMF 0:24d3eb812fd4 96 TCPServer.shutdown(self)
JMF 0:24d3eb812fd4 97
JMF 0:24d3eb812fd4 98 def isrunning(self):
JMF 0:24d3eb812fd4 99 return self.running
JMF 0:24d3eb812fd4 100
JMF 0:24d3eb812fd4 101
JMF 0:24d3eb812fd4 102 class TCPEchoClientTest(BaseHostTest):
JMF 0:24d3eb812fd4 103
JMF 0:24d3eb812fd4 104 def __init__(self):
JMF 0:24d3eb812fd4 105 """
JMF 0:24d3eb812fd4 106 Initialise test parameters.
JMF 0:24d3eb812fd4 107
JMF 0:24d3eb812fd4 108 :return:
JMF 0:24d3eb812fd4 109 """
JMF 0:24d3eb812fd4 110 BaseHostTest.__init__(self)
JMF 0:24d3eb812fd4 111 self.SERVER_IP = None # Will be determined after knowing the target IP
JMF 0:24d3eb812fd4 112 self.SERVER_PORT = 0 # Let TCPServer choose an arbitrary port
JMF 0:24d3eb812fd4 113 self.server = None
JMF 0:24d3eb812fd4 114 self.server_thread = None
JMF 0:24d3eb812fd4 115 self.target_ip = None
JMF 0:24d3eb812fd4 116
JMF 0:24d3eb812fd4 117 @staticmethod
JMF 0:24d3eb812fd4 118 def find_interface_to_target_addr(target_ip):
JMF 0:24d3eb812fd4 119 """
JMF 0:24d3eb812fd4 120 Finds IP address of the interface through which it is connected to the target.
JMF 0:24d3eb812fd4 121
JMF 0:24d3eb812fd4 122 :return:
JMF 0:24d3eb812fd4 123 """
JMF 0:24d3eb812fd4 124 s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
JMF 0:24d3eb812fd4 125 try:
JMF 0:24d3eb812fd4 126 s.connect((target_ip, 0)) # Target IP, any port
JMF 0:24d3eb812fd4 127 except socket.error:
JMF 0:24d3eb812fd4 128 s.connect((target_ip, 8000)) # Target IP, 'random' port
JMF 0:24d3eb812fd4 129 ip = s.getsockname()[0]
JMF 0:24d3eb812fd4 130 s.close()
JMF 0:24d3eb812fd4 131 return ip
JMF 0:24d3eb812fd4 132
JMF 0:24d3eb812fd4 133 def setup_tcp_server(self):
JMF 0:24d3eb812fd4 134 """
JMF 0:24d3eb812fd4 135 sets up a TCP server for target to connect and send test data.
JMF 0:24d3eb812fd4 136
JMF 0:24d3eb812fd4 137 :return:
JMF 0:24d3eb812fd4 138 """
JMF 0:24d3eb812fd4 139 # !NOTE: There should mechanism to assert in the host test
JMF 0:24d3eb812fd4 140 if self.SERVER_IP is None:
JMF 0:24d3eb812fd4 141 self.log("setup_tcp_server() called before determining server IP!")
JMF 0:24d3eb812fd4 142 self.notify_complete(False)
JMF 0:24d3eb812fd4 143
JMF 0:24d3eb812fd4 144 # Returning none will suppress host test from printing success code
JMF 0:24d3eb812fd4 145 self.server = TCPServerWrapper((self.SERVER_IP, self.SERVER_PORT), TCPEchoClientHandler)
JMF 0:24d3eb812fd4 146 ip, port = self.server.server_address
JMF 0:24d3eb812fd4 147 self.SERVER_PORT = port
JMF 0:24d3eb812fd4 148 self.server.allow_reuse_address = True
JMF 0:24d3eb812fd4 149 self.log("HOST: Listening for TCP connections: " + self.SERVER_IP + ":" + str(self.SERVER_PORT))
JMF 0:24d3eb812fd4 150 self.server_thread = Thread(target=TCPEchoClientTest.server_thread_func, args=(self,))
JMF 0:24d3eb812fd4 151 self.server_thread.start()
JMF 0:24d3eb812fd4 152
JMF 0:24d3eb812fd4 153 @staticmethod
JMF 0:24d3eb812fd4 154 def server_thread_func(this):
JMF 0:24d3eb812fd4 155 """
JMF 0:24d3eb812fd4 156 Thread function to run TCP server forever.
JMF 0:24d3eb812fd4 157
JMF 0:24d3eb812fd4 158 :param this:
JMF 0:24d3eb812fd4 159 :return:
JMF 0:24d3eb812fd4 160 """
JMF 0:24d3eb812fd4 161 this.server.serve_forever()
JMF 0:24d3eb812fd4 162
JMF 0:24d3eb812fd4 163 @event_callback("target_ip")
JMF 0:24d3eb812fd4 164 def _callback_target_ip(self, key, value, timestamp):
JMF 0:24d3eb812fd4 165 """
JMF 0:24d3eb812fd4 166 Callback to handle reception of target's IP address.
JMF 0:24d3eb812fd4 167
JMF 0:24d3eb812fd4 168 :param key:
JMF 0:24d3eb812fd4 169 :param value:
JMF 0:24d3eb812fd4 170 :param timestamp:
JMF 0:24d3eb812fd4 171 :return:
JMF 0:24d3eb812fd4 172 """
JMF 0:24d3eb812fd4 173 self.target_ip = value
JMF 0:24d3eb812fd4 174 self.SERVER_IP = self.find_interface_to_target_addr(self.target_ip)
JMF 0:24d3eb812fd4 175 self.setup_tcp_server()
JMF 0:24d3eb812fd4 176
JMF 0:24d3eb812fd4 177 @event_callback("host_ip")
JMF 0:24d3eb812fd4 178 def _callback_host_ip(self, key, value, timestamp):
JMF 0:24d3eb812fd4 179 """
JMF 0:24d3eb812fd4 180 Callback for request for host IP Addr
JMF 0:24d3eb812fd4 181
JMF 0:24d3eb812fd4 182 """
JMF 0:24d3eb812fd4 183 self.send_kv("host_ip", self.SERVER_IP)
JMF 0:24d3eb812fd4 184
JMF 0:24d3eb812fd4 185 @event_callback("host_port")
JMF 0:24d3eb812fd4 186 def _callback_host_port(self, key, value, timestamp):
JMF 0:24d3eb812fd4 187 """
JMF 0:24d3eb812fd4 188 Callback for request for host port
JMF 0:24d3eb812fd4 189 """
JMF 0:24d3eb812fd4 190 self.send_kv("host_port", self.SERVER_PORT)
JMF 0:24d3eb812fd4 191
JMF 0:24d3eb812fd4 192 def teardown(self):
JMF 0:24d3eb812fd4 193 if self.server:
JMF 0:24d3eb812fd4 194 self.server.shutdown()
JMF 0:24d3eb812fd4 195 self.server_thread.join()