#
#  gensio - A library for abstracting stream I/O
#  Copyright (C) 2018  Corey Minyard <minyard@acm.org>
#
#  SPDX-License-Identifier: GPL-2.0-only
#

#
# gensio test utilities
#
# This file contains some classes and functions useful for testing
# gensio handling
#

import os

# Since Python 3.8 non-system paths are not loaded to the DLL load order
# in python.  Work around that by adding all PATH directories to the DLL
# search path.
def fix_dll_path():
    if os.name != "nt":
        return
    path = os.getenv("PATH")
    if not path:
        return
    paths = path.split(";")
    # The patches added below are search last added first.  So preserved
    # the DLL order by putting them in backwards.
    for folder in reversed(paths):
        if os.path.exists(folder):
            os.add_dll_directory(folder)

fix_dll_path()

import gensio
import tempfile
import signal
import time
import curses.ascii
import sys
import platform
import sysconfig
import gensios_enabled

debug = 0

def conv_to_bytes(s):
    if (sysconfig.get_python_version() >= "3.0"):
        if (isinstance(s, str)):
            return bytes(s, "utf-8")
        else:
            return s
    else:
        return s

class OpEvent:
    def __init__(self, op, obj, obj2 = None):
        self.op = op
        self.obj = obj
        self.obj2 = obj2
        return

    def __str__(self):
        return "%s %s %s" % (self.op, str(self.obj), str(self.obj2))

class OpEventQueue:
    def __init__(self, o):
        self.queue = []
        self.waiter = gensio.waiter(o)
        return

    def clear(self):
        self.queue = []
        return

    def enqueue(self, ev):
        #print("Enqueuing: " + str(ev))
        self.queue.append(ev)
        self.waiter.wake()
        return

    def wait(self, timeout = 1000):
        """Wait for an event to come in or the timeout to expire.
        Returns a tuple with the event first (or None if timeout) and
        the remaining time second."""

        if len(self.queue) == 0:
            timeout = self.waiter.wait_timeout(1, timeout)
            if len(self.queue) == 0:
                return (None, timeout)
        ev = self.queue[0]
        del(self.queue[0])
        return (ev, timeout)

    def wait_one_ev(self, evs, timeout = 1000):
        """Wait for an event to come in or the timeout to expire.  If an
        event comes in and the event is in evs, delete it from there.  If
        it is not in evs, raise an exception.

        Returns a tuple with the event first (or None if timeout) and
        the remaining time milliseconds.
        """

        (ev, timeout) = self.wait(timeout = timeout)
        found = False
        if ev:
            for i in range(0, len(evs)):
                if evs[i].op == ev.op and evs[i].obj == ev.obj:
                    found = True
                    del(evs[i])
                    break
        return (found, ev, timeout)

    def wait_evs(self, evs, timeout = 1000):
        """Wait for all the events in evs to come in, or a timeout to
        occur.  If the timeout happens, raise an exception."""
        while len(evs) > 0 and timeout > 0:
            (found, ev, timeout) = self.wait_one_ev(evs, timeout = timeout)
            if ev and not found:
                raise Exception("Unexpected event: " + str(ev))
        if len(evs) > 0:
            s = ""
            for ev in evs:
                s += "\n  " + str(ev)
            raise Exception("All events not received, the following" +
                            " are remaining: " + s)
        return

class HandleData:
    """Data handler for testing gensio.

    This is designed to handle input and output from gensio.  To write
    data, call set_write_data() to set some data and write it.  To wait
    for data to be read, call set_compare() to wait for the given data
    to be read.

    This just starts things up and runs asynchronously.  You can wait
    for a completion with wait() or wait_timeout().

    The io handler is in the io attribute of the object.  The handler
    object of that io will be this object.
    """

    def __init__(self, o, iostr, name = None, chunksize=10240,
                 io = None, password = None, expect_remclose = True,
                 val_2fa = None, evq = None):
        """Start a gensio object with this handler"""
        if (name):
            self.name = name
        else:
            self.name = iostr
        self.waiter = gensio.waiter(o)
        self.evq = evq
        self.to_write = None
        self.compared = 0
        self.to_compare = None
        self.compared_oob = 0
        self.compare_auxdata = None
        self.to_compare_oob = None
        self.to_waitfor = None
        self.keep_waitfor_data = False
        self.kept_data = ""
        self.expecting_winsize = False
        self.expected_winsize_height = -1
        self.expected_winsize_width = -1
        self.expecting_modemstate = False
        self.expecting_modemstate_mask = False
        self.expecting_linestate = False
        self.expecting_linestate_mask = False
        self.expecting_remclose = expect_remclose
        self.expected_server_cb = None
        self.expected_server_value = 0
        self.expected_server_return = 0
        self.expected_sig_server_cb = False
        self.expected_sig_server_val = None
        self.ignore_input = False
        self.waiting_rem_close = False
        self.stream = None
        self.password = password
        self.val_2fa = val_2fa
        if (io):
            self.io = io
            io.set_cbs(self)
        else:
            gensios_enabled.check_iostr_gensios(iostr)
            self.io = gensio.gensio(o, iostr, self)
        self.io.handler = self
        self.chunksize = chunksize
        self.debug = 0
        return

    def __unicode__(self):
        return self.name

    def __str__(self):
        return self.name

    def set_compare(self, to_compare, start_reader = True, stream = None,
                    auxdata = None):
        """Set some data to compare

        If start_reader is true (default), it enable the read callback.
        If the data does not compare, an exception is raised.
        """
        self.compared = 0
        self.stream = stream
        self.compare_auxdata = auxdata
        self.to_compare = conv_to_bytes(to_compare);
        if (start_reader):
            self.io.read_cb_enable(True)
        return

    def set_compare_oob(self, to_compare, start_reader = True, stream = None,
                        auxdata = None):
        """Set some oob data to compare

        If start_reader is true (default), it enable the read callback.
        If the data does not compare, an exception is raised.
        """
        self.compared_oob = 0
        self.stream = stream
        self.compare_auxdata = auxdata
        self.to_compare_oob = conv_to_bytes(to_compare)
        if (start_reader):
            self.io.read_cb_enable(True)
        return

    def set_waitfor(self, waitfor, start_reader = True, keep_data = False):
        """Wait for the given string to come in

        If start_reader is true (default), it enable the read callback.
        If the data does not compare, an exception is raised.
        """
        self.compared = 0
        self.keep_waitfor_data = keep_data
        if keep_data:
            self.kept_data = ""
        self.to_waitfor = conv_to_bytes(waitfor)
        if (start_reader):
            self.io.read_cb_enable(True)
        return

    def get_waitfor_kept_data(self):
        return self.kept_data

    def set_write_data(self, to_write, start_writer = True,
                       close_on_done = False, auxdata = None):
        self.close_on_done = close_on_done
        self.wrpos = 0
        self.wrlen = len(to_write)
        self.to_write = conv_to_bytes(to_write)
        self.write_auxdata = auxdata
        if (start_writer):
            self.io.write_cb_enable(True)
        return

    def close(self):
        self.ignore_input = True
        self.io.close(self)
        return

    def wait(self):
        self.waiter.wait(1)

    def wait_timeout(self, timeout):
        return self.waiter.wait_timeout(1, timeout)

    def wake(self, op, obj2 = None):
        if self.evq:
            self.evq.enqueue(OpEvent(op, self, obj2))
        else:
            self.waiter.wake()
        return

    def exception(self, str):
        if self.evq:
            self.evq.enqueue(OpEvent("exception", self, str))
        else:
            raise
        return

    def enqueue(self, op, obj2 = None):
        if self.evq:
            self.evq.enqueue(OpEvent(op, self, obj2))
        return

    # Everything below here is internal handling functions.

    def read_callback(self, io, err, buf, auxdata):
        try:
            if self.to_compare:
                iolen = len(self.to_compare)
            elif self.to_waitfor:
                iolen = len(self.to_waitfor)
            else:
                iolen = None

            if (debug or self.debug) and iolen != None and buf is not None:
                print("%s: Got %d bytes at pos %d of %d" %
                      (self.name, len(buf),
                       self.compared, iolen))
            if ((debug >= 2 or self.debug >= 2) and not err):
                s = ""
                for i in range(0, len(buf)):
                    if curses.ascii.isprint(buf[i]):
                        if (sysconfig.get_python_version() >= "3.0"):
                            s = s + str(buf[i:i+1], "utf-8")
                        else:
                            s = s + str(buf[i:i+1])
                    else:
                        s = s + "\\x%2.2x" % ord(buf[i:i+1])
                print("%s: Got data: (err %s %d bytes) %s"
                      % (self.name, str(err), len(buf), s))
            if self.expecting_remclose and err == "Remote end closed connection":
                if self.waiting_rem_close or self.evq:
                    self.wake("close")
                io.read_cb_enable(False)
                return 0
            if err:
                raise Exception(self.name + ": read: " + err)
            if self.ignore_input:
                return len(buf)

            if self.to_waitfor:
                for i in range(0, len(buf)):
                    if buf[i] == self.to_waitfor[self.compared]:
                        self.compared += 1
                        if (len(self.to_waitfor) == self.compared):
                            self.to_waitfor = None
                            io.read_cb_enable(False)
                            self.wake("waitfor")
                            break
                    else:
                        self.compared = 0
                    if self.keep_waitfor_data:
                        self.kept_data = self.kept_data + str(buf[i:i+1], "utf-8")
                return i + 1

            oob = False;
            stream = 0

            if (self.compare_auxdata is not None):
                if not auxdata:
                    raise Exception("%s: no auxdata, expected %s" %
                                    (self.name, str(self.compare_auxdata)))
                    return 0
                if len(auxdata) != len(self.compare_auxdata):
                    raise Exception(
                        "%s: length mismatch in auxdata, expected %s, got %s" %
                        (self.name, str(self.compare_auxdata), str(auxdata)))
                    return 0

                for i in range(0, len(auxdata)):
                    if auxdata[i] != self.compare_auxdata[i]:
                        raise Exception(
                            "%s: auxdata item %d wrong, expected %s, got %s" %
                            (self.name, i, str(self.compare_auxdata),
                             str(auxdata)))
                        return 0

            if auxdata:
                for i in auxdata:
                    if i == "oob":
                        oob = True
                    elif i[0:7] == "stream=":
                        stream = int(i[7:])

            if self.stream and stream != self.stream:
                raise Exception("%s: stream mismatch, expected %d, got %d " %
                                (self.name, self.stream, stream))
                return 0
            if not self.stream and stream != 0:
                raise Exception("%s: not expecting stream, got %d " %
                                (self.name, stream))
                return 0

            if oob:
                if not self.to_compare_oob:
                    if (debug):
                        print(self.name +
                              ": Got oob data, but nothing to compare")
                    self.enqueue("unexpected oob")
                    io.read_cb_enable(False)
                    return len(buf)
                compared = self.compared_oob
                compare_with = self.to_compare_oob
                oob = "oob "
            else:
                if not self.to_compare:
                    if (debug):
                        print(self.name + ": Got data, but nothing to compare")
                    io.read_cb_enable(False)
                    return len(buf)
                compared = self.compared
                compare_with = self.to_compare
                oob = ""

            if (len(buf) > len(compare_with)):
                count = len(compare_with)
            else:
                count = len(buf)

            if count > self.chunksize:
                count = self.chunksize

            for i in range(0, count):
                if (buf[i] != compare_with[compared]):
                    raise Exception("%s: %scompare failure on byte %d, "
                                    "expected %x, got %x" %
                                    (self.name, oob, compared,
                                     compare_with[compared],
                                     buf[i]))
                    return 0
                compared += 1

            if oob == "oob ":
                self.compared_oob = compared
                if self.compared_oob >= len(self.to_compare_oob):
                    self.to_compare_oob = None
                    io.read_cb_enable(False)
                    self.wake("oob")
            else:
                self.compared = compared
                if self.compared >= len(self.to_compare):
                    self.to_compare = None
                    io.read_cb_enable(False)
                    self.wake("read_done")

            return count
        except Exception as e:
            io.read_cb_enable(False)
            self.exception("read_callback: Unknown exception" + str(e))
            return 0

    def write_callback(self, io):
        try:
            if not self.to_write:
                if debug or self.debug:
                    print(self.name + ": Got write, but no data")
                io.write_cb_enable(False)
                return

            if (self.wrpos + self.chunksize > self.wrlen):
                wrdata = self.to_write[self.wrpos:]
            else:
                wrdata = self.to_write[self.wrpos:self.wrpos + self.chunksize]
            count = io.write(wrdata, self.write_auxdata)
            if (debug or self.debug):
                print(self.name + ": wrote %d bytes" % count)

            if (count + self.wrpos >= self.wrlen):
                io.write_cb_enable(False)
                if (self.close_on_done):
                    self.io.closeme = False
                    self.close()
                self.to_write = None
                self.wake("write_done")
            else:
                self.wrpos += count
            return
        except Exception as e:
            io.write_cb_enable(False)
            self.exception("write_callback: Unknown exception " + str(e))

    def request_password(self, io):
        if self.password is None:
            return gensio.ENOTSUP
        return self.password

    def request_2fa(self, io):
        if self.val_2fa is None:
            return gensio.ENOTSUP
        return self.val_2fa

    def set_expecting_oob(self, data):
        self.to_compare_oob = data
        return

    def modemstate(self, io, modemstate):
        print("modemstate " + self.name + " " + str(modemstate))
        try:
            if (not self.expecting_modemstate):
                if (debug or self.debug):
                    print("Got unexpected modemstate for %s: %x" %
                          (self.name, modemstate))
                self.enqueue("unexpected modemstate", modemstate)
                return
            if (modemstate != self.expected_modemstate):
                raise Exception("%s: Expecting modemstate 0x%x, got 0x%x" %
                                (self.name, self.expected_modemstate,
                                 modemstate))
            self.expecting_modemstate = False
            self.wake("modemstate", modemstate)
        except Exception as e:
            self.exception("modemstate: Unknown exception " + str(e))
        return

    def set_expected_modemstate(self, modemstate):
        self.expecting_modemstate = True
        self.expected_modemstate = modemstate
        return

    def modemstate_mask(self, io, modemstate_mask):
        try:
            if (not self.expecting_modemstate_mask):
                if (debug or self.debug):
                    print("Got unexpected modemstate mask for %s: %x" %
                          (self.name, modemstate_mask))
                self.enqueue("unexpected modemstate mask", modemstate_mask)
                return
            if (modemstate_mask != self.expected_modemstate_mask):
                if (debug or self.debug):
                    print("%s: Expecting modemstate mask 0x%x, got 0x%x" %
                          (self.name, self.expected_modemstate_mask,
                           modemstate_mask))
                self.enqueue("invalid modemstate mask", modemstate_mask)
                return
            self.expecting_modemstate_mask = False
            io.acontrol(gensio.GENSIO_CONTROL_DEPTH_FIRST,
                        gensio.GENSIO_CONTROL_SET,
                        gensio.GENSIO_ACONTROL_SER_SET_MODEMSTATE_MASK,
                        str(modemstate_mask), None, -1)
            self.wake("modemstate_mask", modemstate_mask)
        except Exception as e:
            self.exception("modemstate_mask: Unknown exception " + str(e))
        return

    def set_expected_modemstate_mask(self, modemstate):
        self.expecting_modemstate_mask = True
        self.expected_modemstate_mask = modemstate
        return

    def win_size(self, io, height, width):
        try:
            if (not self.expecting_winsize):
                if (debug or self.debug):
                    print("Got unexpected window size for %s: %d %d" %
                          (self.name, height, width))
                self.enqueue("unexpected win_size", (height, width))
                return
            if (height != self.expected_winsize_height or
                width != self.expected_winsize_width):
                raise Exception(
                    "%s: Expecting window size %d:%d, got %d:%d" %
                    (self.name, self.expected_winsize_height,
                     self.expected_winsize_width, height, width))
            self.expecting_winsize = False
            self.wake("win_size", (height, width))
        except Exception as e:
            self.exception("win_size: Unknown exception " + str(e))
        return

    def set_expected_win_size(self, height, width):
        self.expecting_winsize = True
        self.expected_winsize_height = height
        self.expected_winsize_width = width
        return

    def linestate(self, io, linestate):
        try:
            if not self.expecting_linestate:
                if debug or self.debug:
                    print("Got unexpected linestate %x" % linestate)
                self.enqueue("unexpected linestate", linestate)
                return
            if linestate != self.expected_linestate:
                raise Exception("%s: Expecting linestate 0x%x, got 0x%x" %
                                (self.name, self.expected_linestate,
                                 linestate))
            if debug or self.debug:
                print("Got linestate %x" % linestate)
            self.expecting_linestate = False
            self.wake("linestate", linestate)
        except Exception as e:
            self.exception("linestate: Unknown exception " + str(e))
        return

    def set_expected_linestate(self, linestate):
        self.expecting_linestate = True
        self.expected_linestate = linestate
        return

    def linestate_mask(self, io, linestate_mask):
        try:
            if (not self.expecting_linestate_mask):
                if (debug or self.debug):
                    print("Got unexpected linestate mask for %s: %x" %
                          (self.name, linestate))
                self.enqueue("unexpected linestate mask", linestate_mask)
                return
            if (linestate_mask != self.expected_linestate_mask):
                if (debug or self.debug):
                    print("%s: Expecting linestate mask 0x%x, got 0x%x" %
                          (self.name, self.expected_linestate_mask,
                           linestate_mask))
                self.enqueue("invalid linestate mask", linestate_mask)
                return
            self.expecting_linestate_mask = False
            io.acontrol(gensio.GENSIO_CONTROL_DEPTH_FIRST,
                        gensio.GENSIO_CONTROL_SET,
                        gensio.GENSIO_ACONTROL_SER_SET_LINESTATE_MASK,
                        str(linestate_mask), None, -1)
            self.wake("linestate_mask", linestate_mask)
        except Exception as e:
            self.exception("linestate_mask: Unknown exception " + str(e))
        return

    def set_expected_linestate_mask(self, linestate):
        self.expecting_linestate_mask = True
        self.expected_linestate_mask = linestate
        return

    def set_expected_server_cb(self, name, value, retval):
        self.expected_server_cb = name
        self.expected_server_value = value
        self.expected_server_return = retval
        return

    def set_expected_client_cb(self, name, value):
        self.expected_server_cb = name
        self.expected_server_value = value
        return

    def check_set_expected_telnet_cb(self, name, value):
        try:
            if not self.expected_server_cb:
                if (debug or self.debug):
                    print("Got unexpected server cb: %s %d" % (name, value))
                self.enqueue("unexpected telnet_cb", (name, value))
                return False
            if self.expected_server_cb != name:
                raise Exception(
                    "Got wrong server cb, expected %s, got %s (%d)" %
                    (self.expected_server_cb, name, value))
            if self.expected_server_value != value:
                raise Exception(
                    "Got wrong server cb value for %s, expected %d, got %d" %
                    (name, self.expected_server_value, value))
            self.wake("telnet_cb", (name, value))
        except Exception as e:
            self.exception("telnet_cb: Unknown exception " + str(e))
        return True

    def baud(self, sio, err, baud):
        if not self.check_set_expected_telnet_cb("baud", baud):
            return
        return

    def datasize(self, sio, err, datasize):
        if not self.check_set_expected_telnet_cb("datasize", datasize):
            return
        return

    def parity(self, sio, err, parity):
        if not self.check_set_expected_telnet_cb("parity", parity):
            return
        return

    def stopbits(self, sio, err, stopbits):
        if not self.check_set_expected_telnet_cb("stopbits", stopbits):
            return
        return

    def flowcontrol(self, sio, err, flowcontrol):
        if not self.check_set_expected_telnet_cb("flowcontrol", flowcontrol):
            return
        return

    def iflowcontrol(self, sio, err, iflowcontrol):
        if not self.check_set_expected_telnet_cb("iflowcontrol", iflowcontrol):
            return
        return

    def sbreak(self, sio, err, sbreak):
        if not self.check_set_expected_telnet_cb("sbreak", sbreak):
            return
        return

    def dtr(self, sio, err, dtr):
        if not self.check_set_expected_telnet_cb("dtr", dtr):
            return
        return

    def rts(self, sio, err, rts):
        if not self.check_set_expected_telnet_cb("rts", rts):
            return
        return

    def set_expected_sig_server_cb(self, value):
        self.expected_sig_server_cb = True
        self.expected_sig_server_val = value
        return

    def sbaud(self, io, baud):
        if not self.check_set_expected_telnet_cb("baud", baud):
            return
        io.acontrol(gensio.GENSIO_CONTROL_DEPTH_FIRST,
                    gensio.GENSIO_CONTROL_SET,
                    gensio.GENSIO_ACONTROL_SER_BAUD,
                    str(self.expected_server_return), None, -1)
        return

    def sdatasize(self, io, datasize):
        if not self.check_set_expected_telnet_cb("datasize", datasize):
            return
        io.acontrol(gensio.GENSIO_CONTROL_DEPTH_FIRST,
                    gensio.GENSIO_CONTROL_SET,
                    gensio.GENSIO_ACONTROL_SER_DATASIZE,
                    str(self.expected_server_return), None, -1)
        return

    def sparity(self, io, parity):
        if not self.check_set_expected_telnet_cb("parity", parity):
            return
        io.acontrol(gensio.GENSIO_CONTROL_DEPTH_FIRST,
                    gensio.GENSIO_CONTROL_SET,
                    gensio.GENSIO_ACONTROL_SER_PARITY,
                    str(self.expected_server_return), None, -1)
        return

    def sstopbits(self, io, stopbits):
        if not self.check_set_expected_telnet_cb("stopbits", stopbits):
            return
        io.acontrol(gensio.GENSIO_CONTROL_DEPTH_FIRST,
                    gensio.GENSIO_CONTROL_SET,
                    gensio.GENSIO_ACONTROL_SER_STOPBITS,
                    str(self.expected_server_return), None, -1)
        return

    def sflowcontrol(self, io, flowcontrol):
        if not self.check_set_expected_telnet_cb("flowcontrol", flowcontrol):
            return
        io.acontrol(gensio.GENSIO_CONTROL_DEPTH_FIRST,
                    gensio.GENSIO_CONTROL_SET,
                    gensio.GENSIO_ACONTROL_SER_FLOWCONTROL,
                    str(self.expected_server_return), None, -1)
        return

    def siflowcontrol(self, io, iflowcontrol):
        if not self.check_set_expected_telnet_cb("iflowcontrol", iflowcontrol):
            return
        io.acontrol(gensio.GENSIO_CONTROL_DEPTH_FIRST,
                    gensio.GENSIO_CONTROL_SET,
                    gensio.GENSIO_ACONTROL_SER_IFLOWCONTROL,
                    str(self.expected_server_return), None, -1)
        return

    def ssbreak(self, io, sbreak):
        if not self.check_set_expected_telnet_cb("sbreak", sbreak):
            return
        io.acontrol(gensio.GENSIO_CONTROL_DEPTH_FIRST,
                    gensio.GENSIO_CONTROL_SET,
                    gensio.GENSIO_ACONTROL_SER_SBREAK,
                    str(self.expected_server_return), None, -1)
        return

    def sdtr(self, io, dtr):
        if not self.check_set_expected_telnet_cb("dtr", dtr):
            return
        io.acontrol(gensio.GENSIO_CONTROL_DEPTH_FIRST,
                    gensio.GENSIO_CONTROL_SET,
                    gensio.GENSIO_ACONTROL_SER_DTR,
                    str(self.expected_server_return), None, -1)
        return

    def srts(self, io, rts):
        if not self.check_set_expected_telnet_cb("rts", rts):
            return
        io.acontrol(gensio.GENSIO_CONTROL_DEPTH_FIRST,
                    gensio.GENSIO_CONTROL_SET,
                    gensio.GENSIO_ACONTROL_SER_RTS,
                    str(self.expected_server_return), None, -1)
        return

    def flush(self, io, val):
        if not self.check_set_expected_telnet_cb("flush", val):
            return
        io.acontrol(gensio.GENSIO_CONTROL_DEPTH_FIRST,
                    gensio.GENSIO_CONTROL_SET,
                    gensio.GENSIO_ACONTROL_SER_FLUSH,
                    str(self.expected_server_return), None, -1)
        return

    def signature(self, io):
        try:
            if not self.expected_sig_server_cb:
                raise Exception("Got unexpected signature request");
            io.acontrol(gensio.GENSIO_CONTROL_DEPTH_FIRST,
                        gensio.GENSIO_CONTROL_SET,
                        gensio.GENSIO_ACONTROL_SER_SIGNATURE,
                        self.expected_sig_server_val, None, -1)
            self.expected_sig_server_cb = False
        except:
            self.exception("signature: Unknown exception " + str(e))
        return

    def close_done(self, io):
        if (debug or self.debug):
            print(self.name + ": Closed")
        self.wake("close_done")
        return

def alloc_io(o, iostr, do_open = True, chunksize = 10240, enable_oob = False,
             evq = None):
    """Allocate an io instance with a HandlerData handler

    If do_open is True (default), open it, too.
    """
    gensios_enabled.check_iostr_gensios(iostr)
    h = HandleData(o, iostr, chunksize = chunksize, evq = evq)
    if enable_oob:
        h.io.control(0, gensio.GENSIO_CONTROL_SET,
                     gensio.GENSIO_CONTROL_ENABLE_OOB, "1")
    if (do_open):
        h.io.open_s()
    return h.io

def test_dataxfer(io1, io2, data, timeout = 1000, evq = None):
    """Test a transfer of data from io1 to io2

    If the transfer does not complete by "timeout" milliseconds, raise
    an exception.
    """
    io1.handler.set_write_data(data)
    io2.handler.set_compare(data)
    if evq:
        evq.wait_evs([OpEvent("write_done", io1.handler),
                      OpEvent("read_done", io2.handler)],
                     timeout = timeout)
    else:
        if (io1.handler.wait_timeout(timeout) == 0):
            raise Exception(("%s: %s: " % ("test_dataxfer",
                                           io1.handler.name)) +
                      ("Timed out waiting for write completion at byte %d" %
                       io1.handler.wrpos))
        if (io2.handler.wait_timeout(timeout) == 0):
            raise Exception(("%s: %s: " % ("test_dataxfer",
                                           io2.handler.name)) +
                       ("Timed out waiting for read completion at byte %d" %
                        io2.handler.compared))
    return

def test_dataxfer_oob(io1, io2, data, timeout = 1000, evq = None):
    """Test a transfer of data from io1 to io2

    If the transfer does not complete by "timeout" milliseconds, raise
    an exception.
    """
    io1.handler.set_write_data(data, auxdata = ["oob"])
    io2.handler.set_compare_oob(data)
    if evq:
        evq.wait_evs([OpEvent("write_done", io1.handler),
                      OpEvent("oob", io2.handler)],
                     timeout = timeout)
    else:
        if (io1.handler.wait_timeout(timeout) == 0):
            raise Exception(("%s: %s: " % ("test_dataxfer",
                                           io1.handler.name)) +
                       ("Timed out waiting for write completion at byte %d" %
                        io1.handler.wrpos))
        if (io2.handler.wait_timeout(timeout) == 0):
            raise Exception(("%s: %s: " % ("test_dataxfer",
                                           io2.handler.name)) +
                        ("Timed out waiting for read completion at byte %d" %
                         io2.handler.compared))
    return

def test_dataxfer_stream(io1, io2, data, stream, timeout = 1000, evq = None):
    """Test a transfer of data from io1 to io2

    If the transfer does not complete by "timeout" milliseconds, raise
    an exception.
    """
    io1.handler.set_write_data(data, auxdata = ["stream=%d" % stream])
    io2.handler.set_compare(data, stream = stream)
    if evq:
        evq.wait_evs([OpEvent("write_done", io1.handler),
                      OpEvent("read_done", io2.handler)],
                     timeout = timeout)
    else:
        if (io1.handler.wait_timeout(timeout) == 0):
            raise Exception(("%s: %s: " % ("test_dataxfer_s",
                                           io1.handler.name)) +
                        ("Timed out waiting for write completion at byte %d" %
                         io1.handler.wrpos))
        if (io2.handler.wait_timeout(timeout) == 0):
            raise Exception(("%s: %s: " % ("test_dataxfer_s",
                                           io2.handler.name)) +
                        ("Timed out waiting for read completion at byte %d" %
                         io2.handler.compared))
    return

def test_dataxfer_simul(io1, io2, data, timeout = 10000, evq = None):
    """Test a simultaneous bidirectional transfer of data between io1 to io2

    If the transfer does not complete by "timeout" milliseconds, raise
    an exception.
    """
    io1.handler.set_write_data(data)
    io1.handler.set_compare(data)
    io2.handler.set_write_data(data)
    io2.handler.set_compare(data)
    if evq:
        evq.wait_evs([OpEvent("write_done", io1.handler),
                      OpEvent("read_done", io2.handler),
                      OpEvent("write_done", io2.handler),
                      OpEvent("read_done", io1.handler)],
                     timeout = timeout)
    else:
        if (io1.handler.wait_timeout(timeout) == 0):
            raise Exception(
              "%s: %s: Timed out waiting for write completion at bytes %d %d" %
                ("test_dataxfer", io1.handler.name, io1.handler.wrpos,
                 io2.handler.wrpos))
        if (io2.handler.wait_timeout(timeout) == 0):
            raise Exception(
              "%s: %s: Timed out waiting for write completion at bytes %d %d" %
                ("test_dataxfer", io2.handler.name, io1.handler.wrpos,
                 io2.handler.wrpos))
        if (io1.handler.wait_timeout(timeout) == 0):
            raise Exception(
              "%s: %s: Timed out waiting for read completion at bytes %d %d" %
                ("test_dataxfer", io1.handler.name,
                 io1.handler.compared, io2.handler.compared))
        if (io2.handler.wait_timeout(timeout) == 0):
            raise Exception(
              "%s: %s: Timed out waiting for read completion at bytes %d %d" %
                ("test_dataxfer", io2.handler.name,
                 io1.handler.compared, io2.handler.compared))
    return

def test_write_drain(io1, io2, data, timeout = 1000, evq = None):
    """Test that a close does not loose data.

    If the transfer does not complete by "timeout" milliseconds, raise
    an exception.
    """
    io1.handler.set_write_data(data, close_on_done = True)
    io2.handler.set_compare(data)
    if evq:
        evq.wait_evs([OpEvent("write_done", io1.handler),
                      OpEvent("read_done", io2.handler)],
                     timeout = timeout)
    else:        
        if (io1.handler.wait_timeout(timeout) == 0):
            raise Exception(("%s: %s: " % ("test_dataxfer",
                                           io1.handler.name)) +
                        ("Timed out waiting for write completion at byte %d" %
                         io1.handler.wrpos))
        if (io2.handler.wait_timeout(timeout) == 0):
            raise Exception(("%s: %s: " % ("test_dataxfer",
                                           io2.handler.name)) +
                        ("Timed out waiting for read completion at byte %d" %
                         io2.handler.compared))
    return

def io_close(ios, timeout = 1000, evq = None):
    """close the given tuple of gensios

    If it does not succeed in timeout milliseconds, raise and exception.
    """
    evs = []
    for io in ios:
        if not io:
            continue
        if io.handler is not None:
            io.handler.close()
            if evq:
                evs.append(OpEvent("close_done", io.handler))
    if evq:
        while len(evs) > 0 and timeout > 0:
            (found, ev, timeout) = evq.wait_one_ev(evs, timeout = timeout)
        if len(evs) > 0:
            raise Exception("%s: %s: Timed out waiting for close" %
                            ("io_close", io.handler.name))
    for io in ios:
        if not io:
            continue
        if not evq:
            if (io.handler.wait_timeout(timeout) == 0):
                raise Exception("%s: %s: Timed out waiting for close" %
                            ("io_close", io.handler.name))
        # Break all the possible circular references.
        del io.handler.io
        del io.handler
    return

keydir = os.getenv("keydir")
if not keydir:
    if (not keydir):
        keydir = "ca"

class Logger:
    def gensio_log(self, level, log):
        print("***%s logger: %s" % (level, log))

gensio.gensio_set_log_mask(gensio.GENSIO_LOG_MASK_ALL)

oshndname = os.getenv("GENSIO_TEST_OS_HANDLER")
if oshndname is None or oshndname == "default":
    o = gensio.alloc_gensio_selector(Logger());
elif oshndname == "glib":
    import gensioglib
    o = gensioglib.alloc_glib_os_funcs(Logger());
elif oshndname == "tcl":
    import gensiotcl
    o = gensiotcl.alloc_tcl_os_funcs(Logger());
else:
    print("Unknown OS handler name: " + oshndname)
    sys.exit(1)

def test_shutdown():
    global o
    w = gensio.waiter(o)
    count = 0
    while gensio.gensio_num_alloced() > 0:
        count += 1
        if (count > 100):
            raise Exception("All gensios were not freed in time")
        w.service(1)
    while w.service_now() == 0:
        # Give some time for everyting to clear out.
        pass
    del w
    c = sys.getrefcount(o)
    if c != 2:
        raise Exception("OS object refcount was %d, not 2" % c)
    c = gensio.get_os_funcs_refcount(o)
    if c != 1:
        raise Exception("OS funcs refcount was %d, not 1" % c)
    gensio.gensio_cleanup_mem(o)
    del o

def check_raddr(io, testname, expected, expected2 = None):
    r = io.control(gensio.GENSIO_CONTROL_DEPTH_FIRST, gensio.GENSIO_CONTROL_GET,
                   gensio.GENSIO_CONTROL_RADDR, "0")
    if r != expected and r != expected2:
        raise Exception("%s raddr was not '%s', it was '%s'" %
                        (testname, expected, r));

def check_laddr(acc, testname, expected):
    r = acc.control(0, gensio.GENSIO_CONTROL_GET,
                    gensio.GENSIO_ACC_CONTROL_LADDR, "0")
    if r != expected:
        expected = expected.replace("127.0.0.1", "::1")
        expected = expected.replace("ipv4", "ipv6")
    if r != expected:
        raise Exception("%s laddr was not '%s', it was '%s'" %
                        (testname, expected, r));

def check_port(acc, testname, expected):
    r = acc.control(0, gensio.GENSIO_CONTROL_GET,
                    gensio.GENSIO_ACC_CONTROL_LPORT, "0")
    if r != expected:
        raise Exception("%s port was not '%s', it was '%s'" %
                        (testname, expected, r));

class AccHandler:
    """A class to represent an accepter.  It really just supplies a name
    for the event handler"""
    def __init__(self, opobj, name, evq = None):
        self.opobj = opobj
        self.name = name
        self.evq = evq
        return

    def __unicode__(self):
        return self.name

    def __str__(self):
        return self.name

    def new_connection(self, acc, io):
        HandleData(self.opobj.o, None, io = io, name = self.name,
                   evq = self.evq)
        self.opobj.io2 = io
        if self.evq:
            self.evq.enqueue(OpEvent("new_connection", self))
        else:
            print("Newcon")
            self.opobj.waiter.wake()

    def accepter_log(self, acc, level, logstr):
        if self.evq:
            self.evq.enqueue(OpEvent("accepter_log", self, (level, logstr)))
        else:
            print("***%s LOG: %s: %s" % (level, self.name, logstr))

    def auth_begin(self, acc, io):
        return self.opobj.auth_begin(acc, io)

    def precert_verify(self, acc, io):
        return self.opobj.precert_verify(acc, io)

    def password_verify(self, acc, io, password):
        return self.opobj.password_verify(acc, io, password)

    def verify_2fa(self, acc, io, val_2fa):
        return self.opobj.verify_2fa(acc, io, val_2fa)

class TestAccept:
    def __init__(self, o, io1str, accstr, tester, name = None,
                 io1_dummy_write = None, do_close = True,
                 expected_raddr = None, expected_acc_laddr = None,
                 chunksize = 10240, get_port = True, except_on_log = False,
                 enable_oob = False, timeout = 0,
                 close_timeout = 1000, enable_read_io1 = False, evq = None):
        self.o = o
        self.io1 = None
        self.io2 = None
        self.acc = None
        self.acc_started = False
        self.enable_oob = enable_oob
        self.close_timeout = close_timeout;
        if not evq:
            evq = OpEventQueue(o)
        self.evq = evq

        try:
            self.except_on_log = except_on_log
            if (name):
                self.name = name
            else:
                self.name = accstr
            if debug:
                print("TestAccept " + self.name);
            self.waiter = gensio.waiter(o)
            gensios_enabled.check_iostr_gensios(accstr)
            self.acc = gensio.gensio_accepter(o, accstr, self);
            if debug:
                print("acc startup");
            self.acc.startup()
            self.acc_started = True
            self.waiter.service(1) # Wait a bit for the accepter to start up.

            if get_port:
                port = self.acc.control(gensio.GENSIO_CONTROL_DEPTH_FIRST,
                                        gensio.GENSIO_CONTROL_GET,
                                        gensio.GENSIO_ACC_CONTROL_LPORT, "0")
            else:
                port = ""
            io1str = io1str + port
            io1 = alloc_io(o, io1str, do_open = False,
                           chunksize = chunksize, enable_oob = enable_oob)
            self.io1 = io1
            if expected_acc_laddr:
                expected_acc_laddr = expected_acc_laddr + port
            if expected_raddr:
                expected_raddr = expected_raddr + port

            if expected_acc_laddr:
                check_laddr(self.acc, self.name, expected_acc_laddr)
            if debug:
                print("io1 open " + self.name);
            try:
                io1.open_s()
            except:
                del io1.handler.io
                io1.handler = None
                raise
            if enable_read_io1:
                # Some gensios, like telnet, need to have read enabled
                # on the client for the accept to complete.
                io1.read_cb_enable(True);
            if expected_raddr:
                check_raddr(io1, self.name, expected_raddr)
            if (io1_dummy_write):
                # For UDP, kick start things.
                io1.write(io1_dummy_write, None)
            if debug:
                print("wait 1 " + self.name);
            # Wait for the accept to happen
            if (self.wait_timeout(1000) == 0):
                raise Exception(("%s: %s: " % ("test_accept", self.name)) +
                                ("Timed out waiting for initial connection"))
            if enable_read_io1:
                io1.read_cb_enable(False);
            if (io1_dummy_write):
                self.io2.handler.set_compare(io1_dummy_write)
                if (self.io2.handler.wait_timeout(1000) == 0):
                    raise Exception(("%s: %s: " % ("test_accept",
                                                   self.io2.handler.name)) +
                              ("Timed out waiting for dummy read at byte %d" %
                               self.io2.handler.compared))
            if timeout > 0:
                tester(self.io1, self.io2, timeout=timeout)
            else:
                tester(self.io1, self.io2)
            if do_close:
                self.close()
        except Exception as e:
            print("err: Unknown exception" + str(e))
            if do_close:
                self.close()
            self.io1 = None
            self.io2 = None
            self.acc = None
            if self.evq:
                self.evq.clear()
                self.evq = None
            raise

    def close(self):
        if self.io1:
            self.io1.read_cb_enable(False)
        if self.io2:
            self.io2.read_cb_enable(False)
        # Close the accepter first.  Some accepters (like conacc) will
        # re-open when the child closes.
        if self.acc_started:
            self.acc_started = False
            self.acc.shutdown_s()
            pass
        io_close((self.io1, self.io2), timeout = self.close_timeout)

        # Break all the possible circular references.
        self.io1 = None
        self.io2 = None
        self.acc = None
        if self.evq:
            self.evq.clear()
            self.evq = None

    def new_connection(self, acc, io):
        if self.enable_oob:
            io.control(0, gensio.GENSIO_CONTROL_SET,
                       gensio.GENSIO_CONTROL_ENABLE_OOB, "1")
        HandleData(self.o, None, io = io, name = self.name)
        print("New connection " + self.name);
        self.io2 = io
        self.waiter.wake()

    def accepter_log(self, acc, level, logstr):
        prstr = "***%s LOG: %s: %s" % (level, self.name, logstr)
        if self.except_on_log:
            raise Exception(prstr)
        else:
            print(prstr)

    def wait(self):
        self.waiter.wait(1)

    def wait_timeout(self, timeout):
        return self.waiter.wait_timeout(1, timeout)

def do_test(io1, io2, timeout = 1000):
    test_dataxfer(io1, io2, "This is a test string!", timeout = timeout)
    print("  Success!")

def do_small_test(io1, io2, timeout=2000, evq = None):
    rb = os.urandom(512)
    print("  testing io1 to io2")
    test_dataxfer(io1, io2, rb, timeout = timeout, evq = evq)
    print("  testing io2 to io1")
    test_dataxfer(io2, io1, rb, timeout = timeout, evq = evq)
    print("  testing bidirection between io1 and io2")
    test_dataxfer_simul(io1, io2, rb, timeout = timeout, evq = evq)
    print("  Success!")

def do_medium_test(io1, io2, timeout = 10000, evq = None):
    rb = os.urandom(131071)
    print("  testing io1 to io2")
    test_dataxfer(io1, io2, rb, timeout = timeout, evq = evq)
    print("  testing io2 to io1")
    test_dataxfer(io2, io1, rb, timeout = timeout, evq = evq)
    print("  testing bidirection between io1 and io2")
    test_dataxfer_simul(io1, io2, rb, timeout = timeout, evq = evq)
    print("  Success!")

def do_large_test(io1, io2, timeout = 30000, evq = None):
    rb = os.urandom(1048570)
    print("  testing io1 to io2")
    test_dataxfer(io1, io2, rb, timeout = timeout, evq = evq)
    print("  testing io2 to io1")
    test_dataxfer(io2, io1, rb, timeout = timeout, evq = evq)
    print("  testing bidirection between io1 and io2")
    test_dataxfer_simul(io1, io2, rb, timeout = timeout, evq = evq)
    print("  Success!")

def do_oob_test(io1, io2, evq = None):
    rb = os.urandom(512)
    print("  testing io1 to io2")
    test_dataxfer_oob(io1, io2, rb, evq = evq)
    print("  testing io2 to io1")
    test_dataxfer_oob(io2, io1, rb, evq = evq)
    print("  Success!")

class TestAcceptConnect:
    def __init__(self, o, iostr, io2str, io3str, tester, name = None,
                 io1_dummy_write = None, CA=None, do_close = True,
                 auth_begin_rv = gensio.GE_NOTSUP, expect_pw = None,
                 expect_pw_rv = gensio.GE_NOTSUP, password = None,
                 expect_remclose = True, use_port = True,
                 expect_2fa = None, expect_2fa_rv = gensio.GE_NOTSUP,
                 val_2fa = None, evq = None, timeout = 1000):
        self.o = o
        self.io1 = None
        self.io2 = None
        self.acc = None
        self.acc_started = False
        self.acc2 = None
        self.acc2_started = False
        if not evq:
            evq = OpEventQueue(o)
        self.evq = evq

        try:
            if (name):
                self.name = name
            else:
                self.name = iostr
            gensios_enabled.check_iostr_gensios(iostr)
            gensios_enabled.check_iostr_gensios(io2str)

            h = AccHandler(self, iostr, evq = evq)
            self.acc = gensio.gensio_accepter(o, iostr, h);
            self.acc.handler = h
            h.acc = self.acc
            self.acc.startup()
            self.acc_started = True

            h = AccHandler(self, io2str, evq = evq)
            self.acc2 = gensio.gensio_accepter(o, io2str, h);
            self.acc2.handler = h
            h.acc = self.acc2
            self.acc2.startup()
            self.acc2_started = True

            if (use_port):
                port = self.acc.control(gensio.GENSIO_CONTROL_DEPTH_FIRST,
                                        gensio.GENSIO_CONTROL_GET,
                                        gensio.GENSIO_ACC_CONTROL_LPORT, "0")
                io3str = io3str + port
            self.io1 = self.acc2.str_to_gensio(io3str, None);
            self.io2 = None
            self.CA = CA
            h = HandleData(o, io3str, io = self.io1, password = password,
                           expect_remclose = expect_remclose,
                           val_2fa = val_2fa, evq = evq)
            self.auth_begin_rv = auth_begin_rv
            self.expect_pw = expect_pw
            self.expect_pw_rv = expect_pw_rv
            self.expect_2fa = expect_2fa
            self.expect_2fa_rv = expect_2fa_rv
            try:
                self.io1.open_s()
            except:
                del self.io1.handler.io
                del self.io1.handler
                self.io1 = None
                raise

            self.io1.read_cb_enable(True)

            if (io1_dummy_write):
                # For UDP, kick start things.
                self.io1.write(io1_dummy_write, None)

            try:
                evs = [OpEvent("new_connection", self.acc.handler)]
                while timeout > 0:
                    (found, ev, timeout) = evq.wait_one_ev(
                        evs, timeout = timeout)
                    #print("Got event (%d): %s" % (timeout, str(ev)))
                    if ev:
                        if ev.op == "new_connection":
                            break;
                        if ev.op == "exception":
                            raise Exception(str(ev))
                if len(evs) > 0:
                    raise Exception("Didn't get new connection")
            except:
                raise

            if (io1_dummy_write):
                self.io2.handler.set_compare(io1_dummy_write)
                if evq:
                    evq.wait_evs([OpEvent("read_done", self.io2.handler)])
                else:
                    if (self.io2.handler.wait_timeout(1000) == 0):
                        raise Exception(("%s: %s: " % ("test_accept",
                                                      self.io2.handler.name)) +
                               ("Timed out waiting for dummy read at byte %d" %
                                self.io2.handler.compared))
            tester(self.io1, self.io2, evq = evq)
            if do_close:
                self.close()
        except:
            self.close()
            raise

    def close(self):
        if (self.io1):
            self.io1.read_cb_enable(False)
        if self.io2:
            self.io2.read_cb_enable(False)
        io_close((self.io1, self.io2), evq = self.evq)

        # Break all the possible circular references.
        self.io1 = None
        self.io2 = None
        if self.acc:
            if self.acc_started:
                self.acc.shutdown_s()
            del self.acc.handler.acc
            del self.acc.handler
        self.acc = None
        if self.acc2:
            if self.acc2_started:
                self.acc2.shutdown_s()
            del self.acc2.handler.acc
            del self.acc2.handler
        self.acc2 = None
        if self.evq:
            self.evq.clear()
            self.evq = None

    def enqueue(self, op, obj2 = None):
        if self.evq:
            self.evq.enqueue(OpEvent(op, self, obj2))
        return

    def exception(self, s):
        if self.evq:
            self.evq.enqueue(OpEvent("exception", self, str))
        else:
            raise
        return

    def auth_begin(self, acc, io):
        return self.auth_begin_rv;

    def precert_verify(self, acc, io):
        try:
            if self.CA:
                io.control(0, gensio.GENSIO_CONTROL_SET,
                       gensio.GENSIO_CONTROL_CERT_AUTH, self.CA)
                return gensio.GE_NOTSUP
            return gensio.GE_NOTSUP
        except Exception as e:
            self.exception("read_callback: Unknown exception" + str(e))

    def password_verify(self, acc, io, password):
        try:
            if self.expect_pw is None:
                raise Exception("got password verify when none expected")
            if self.expect_pw != password:
                raise Exception(
                    "Invalid password in verify, expected %s, got %s"
                    % (self.expect_pw, password))
            return self.expect_pw_rv
        except Exception as e:
            self.exception("password_verify: Unknown exception" + str(e))

    def verify_2fa(self, acc, io, val_2fa):
        try:
            if self.expect_2fa is None:
                raise Exception("got 2-factor auth verify when none expected")
            if self.expect_2fa != val_2fa:
                raise Exception(
                    "Invalid 2-factor auth in verify, expected %s, got %s"
                    % (self.expect_2fa, val_2fa))
            return self.expect_2fa_rv
        except Exception as e:
            self.exception("verify_2fa: Unknown exception" + str(e))

class TestConCon:
    def __init__(self, o, io1, io2, tester, name,
                 do_close = True,
                 expected_raddr1 = None, expected_raddr2 = None,
                 expected_raddr1b = None, expected_raddr2b = None,
                 timeout = None):
        self.o = o
        self.name = name
        self.io1 = io1
        self.io2 = io2
        self.waiter = gensio.waiter(o)
        io1.open(self)
        io2.open(self)
        self.wait(2)
        if expected_raddr1:
            check_raddr(io1, self.name, expected_raddr1, expected_raddr1b)
        if expected_raddr2:
            check_raddr(io2, self.name, expected_raddr2, expected_raddr2b)
        if timeout is None:
            tester(self.io1, self.io2)
        else:
            tester(self.io1, self.io2, timeout=timeout)
        if do_close:
            self.close()

    def close(self):
        self.io1.read_cb_enable(False)
        self.io2.read_cb_enable(False)
        io_close((self.io1, self.io2))

        # Break all the possible circular references.
        del self.io1
        del self.io2

    def open_done(self, io, err):
        if err:
            raise Exception("TestConCon open error for %s: %s" %
                            (self.name, err))
        self.waiter.wake()

    def wait(self, nr):
        self.waiter.wait(nr)

e = os.getenv("GENSIO_TEST_ECHO_DEV")
if e is not None:
    if e:
        ttyecho = e
    else:
        ttyecho = None
else:
    try:
        import serialsim
        (num, ttyecho) = serialsim.alloc_echo()
    except:
        ttyecho = "/dev/ttyEcho0"

ttyecho_def = ttyecho
if ttyecho and not os.path.exists(ttyecho):
    ttyecho = None

def check_echo_dev():
    if ttyecho is None:
        if ttyecho_def is None:
            print("Echo device is disabled")
        else:
            print("Echo device is not present")
        sys.exit(77)

e = os.getenv("GENSIO_TEST_PIPE_DEVS")
if e is not None:
    if e:
        ttypipe = e.split(":")
        if len(ttypipe) != 2:
            print("GENSIO_TESTS_PIPE_DEVS must be two devices separated by :")
            sys.exit(1)
    else:
        ttypipe = None
else:
    try:
        import serialsim
        (num, ttypipea, ttypipeb) = serialsim.alloc_pipe()
        ttypipe = [ ttypipea, ttypipeb ]
    except:
        ttypipe = [ "/dev/ttyPipeA1", "/dev/ttyPipeB1" ]

ttypipe_def = ttypipe
if ttypipe and (not os.path.exists(ttypipe[0])
                or not os.path.exists(ttypipe[1])):
    ttypipe = None

def is_serialsim_pipe():
    return (ttypipe[0].startswith("/dev/ttyPipe") and
            ttypipe[1].startswith("/dev/ttyPipe"))

def check_pipe_dev(is_serialsim = False):
    if ttypipe is None:
        if ttypipe_def is None:
            print("Pipe device is disabled")
        else:
            print("Pipe device is not present")
        sys.exit(77)
    elif is_serialsim and not is_serialsim_pipe():
        print("Test requires a serialsim device")
        sys.exit(77)

def remote_id_int(io):
    return int(io.control(0, gensio.GENSIO_CONTROL_GET,
                          gensio.GENSIO_CONTROL_REMOTE_ID, None))

def check_sctp():
    try:
        import socket
        socket.socket(socket.AF_INET, socket.SOCK_STREAM, socket.IPPROTO_SCTP)
    except:
        sys.exit(77)

def is_windows():
    if platform.system() == "Windows":
        return True
    return False

def get_exec_ext():
    if is_windows():
        return ".exe"
    return ""

execext = get_exec_ext()

def get_endline():
    if is_windows():
        return "\x0d\x0a"
    return "\n"

endline = get_endline()