#!/usr/bin/env python

import unittest

from test import test_support

import errno

import socket

import select

import thread, threading

import time

import traceback

import Queue

import sys

import os

import array

from weakref import proxy

import signal

HOST = test_support.HOST

MSG = 'Michael Gilfix was here\n'

class SocketTCPTest(unittest.TestCase):

    def setUp(self):

        self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

        self.port = test_support.bind_port(self.serv)

        self.serv.listen(1)

    def tearDown(self):

        self.serv.close()

        self.serv = None

class SocketUDPTest(unittest.TestCase):

    def setUp(self):

        self.serv = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)

        self.port = test_support.bind_port(self.serv)

    def tearDown(self):

        self.serv.close()

        self.serv = None

class ThreadableTest:

    """Threadable Test class

    The ThreadableTest class makes it easy to create a threaded

    client/server pair from an existing unit test. To create a

    new threaded class from an existing unit test, use multiple

    inheritance:

        class NewClass (OldClass, ThreadableTest):

            pass

    This class defines two new fixture functions with obvious

    purposes for overriding:

        clientSetUp ()

        clientTearDown ()

    Any new test functions within the class must then define

    tests in pairs, where the test name is preceeded with a

    '_' to indicate the client portion of the test. Ex:

        def testFoo(self):

            # Server portion

        def _testFoo(self):

            # Client portion

    Any exceptions raised by the clients during their tests

    are caught and transferred to the main thread to alert

    the testing framework.

    Note, the server setup function cannot call any blocking

    functions that rely on the client thread during setup,

    unless serverExplicitReady() is called just before

    the blocking call (such as in setting up a client/server

    connection and performing the accept() in setUp().

    """

    def __init__(self):

        # Swap the true setup function

        self.__setUp = self.setUp

        self.__tearDown = self.tearDown

        self.setUp = self._setUp

        self.tearDown = self._tearDown

    def serverExplicitReady(self):

        """This method allows the server to explicitly indicate that

        it wants the client thread to proceed. This is useful if the

        server is about to execute a blocking routine that is

        dependent upon the client thread during its setup routine."""

        self.server_ready.set()

    def _setUp(self):

        self.server_ready = threading.Event()

        self.client_ready = threading.Event()

        self.done = threading.Event()

        self.queue = Queue.Queue(1)

        # Do some munging to start the client test.

        methodname = self.id()

        i = methodname.rfind('.')

        methodname = methodname[i+1:]

        test_method = getattr(self, '_' + methodname)

        self.client_thread = thread.start_new_thread(

            self.clientRun, (test_method,))

        self.__setUp()

        if not self.server_ready.is_set():

            self.server_ready.set()

        self.client_ready.wait()

    def _tearDown(self):

        self.__tearDown()

        self.done.wait()

        if not self.queue.empty():

            msg = self.queue.get()

            self.fail(msg)

    def clientRun(self, test_func):

        self.server_ready.wait()

        self.client_ready.set()

        self.clientSetUp()

        if not callable(test_func):

            raise TypeError, "test_func must be a callable function"

        try:

            test_func()

        except Exception, strerror:

            self.queue.put(strerror)

        self.clientTearDown()

    def clientSetUp(self):

        raise NotImplementedError, "clientSetUp must be implemented."

    def clientTearDown(self):

        self.done.set()

        thread.exit()

class ThreadedTCPSocketTest(SocketTCPTest, ThreadableTest):

    def __init__(self, methodName='runTest'):

        SocketTCPTest.__init__(self, methodName=methodName)

        ThreadableTest.__init__(self)

    def clientSetUp(self):

        self.cli = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

    def clientTearDown(self):

        self.cli.close()

        self.cli = None

        ThreadableTest.clientTearDown(self)

class ThreadedUDPSocketTest(SocketUDPTest, ThreadableTest):

    def __init__(self, methodName='runTest'):

        SocketUDPTest.__init__(self, methodName=methodName)

        ThreadableTest.__init__(self)

    def clientSetUp(self):

        self.cli = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)

class SocketConnectedTest(ThreadedTCPSocketTest):

    def __init__(self, methodName='runTest'):

        ThreadedTCPSocketTest.__init__(self, methodName=methodName)

    def setUp(self):

        ThreadedTCPSocketTest.setUp(self)

        # Indicate explicitly we're ready for the client thread to

        # proceed and then perform the blocking call to accept

        self.serverExplicitReady()

        conn, addr = self.serv.accept()

        self.cli_conn = conn

    def tearDown(self):

        self.cli_conn.close()

        self.cli_conn = None

        ThreadedTCPSocketTest.tearDown(self)

    def clientSetUp(self):

        ThreadedTCPSocketTest.clientSetUp(self)

        self.cli.connect((HOST, self.port))

        self.serv_conn = self.cli

    def clientTearDown(self):

        self.serv_conn.close()

        self.serv_conn = None

        ThreadedTCPSocketTest.clientTearDown(self)

class SocketPairTest(unittest.TestCase, ThreadableTest):

    def __init__(self, methodName='runTest'):

        unittest.TestCase.__init__(self, methodName=methodName)

        ThreadableTest.__init__(self)

    def setUp(self):

        self.serv, self.cli = socket.socketpair()

    def tearDown(self):

        self.serv.close()

        self.serv = None

    def clientSetUp(self):

        pass

    def clientTearDown(self):

        self.cli.close()

        self.cli = None

        ThreadableTest.clientTearDown(self)

#######################################################################

## Begin Tests

class GeneralModuleTests(unittest.TestCase):

    def test_weakref(self):

        s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

        p = proxy(s)

        self.assertEqual(p.fileno(), s.fileno())

        s.close()

        s = None

        try:

            p.fileno()

        except ReferenceError:

            pass

        else:

            self.fail('Socket proxy still exists')

    def testSocketError(self):

        # Testing socket module exceptions

        def raise_error(*args, **kwargs):

            raise socket.error

        def raise_herror(*args, **kwargs):

            raise socket.herror

        def raise_gaierror(*args, **kwargs):

            raise socket.gaierror

        self.failUnlessRaises(socket.error, raise_error,

                              "Error raising socket exception.")

        self.failUnlessRaises(socket.error, raise_herror,

                              "Error raising socket exception.")

        self.failUnlessRaises(socket.error, raise_gaierror,

                              "Error raising socket exception.")

    def testCrucialConstants(self):

        # Testing for mission critical constants

        socket.AF_INET

        socket.SOCK_STREAM

        socket.SOCK_DGRAM

        socket.SOCK_RAW

        socket.SOCK_RDM

        socket.SOCK_SEQPACKET

        socket.SOL_SOCKET

        socket.SO_REUSEADDR

    def testHostnameRes(self):

        # Testing hostname resolution mechanisms

        hostname = socket.gethostname()

        try:

            ip = socket.gethostbyname(hostname)

        except socket.error:

            # Probably name lookup wasn't set up right; skip this test

            return

        self.assert_(ip.find('.') >= 0, "Error resolving host to ip.")

        try:

            hname, aliases, ipaddrs = socket.gethostbyaddr(ip)

        except socket.error:

            # Probably a similar problem as above; skip this test

            return

        all_host_names = [hostname, hname] + aliases

        fqhn = socket.getfqdn(ip)

        if not fqhn in all_host_names:

            self.fail("Error testing host resolution mechanisms. (fqdn: %s, all: %s)" % (fqhn, repr(all_host_names)))

    def testRefCountGetNameInfo(self):

        # Testing reference count for getnameinfo

        if hasattr(sys, "getrefcount"):

            try:

                # On some versions, this loses a reference

                orig = sys.getrefcount(__name__)

                socket.getnameinfo(__name__,0)

            except SystemError:

                if sys.getrefcount(__name__) <> orig:

                    self.fail("socket.getnameinfo loses a reference")

    def testInterpreterCrash(self):

        # Making sure getnameinfo doesn't crash the interpreter

        try:

            # On some versions, this crashes the interpreter.

            socket.getnameinfo(('x', 0, 0, 0), 0)

        except socket.error:

            pass

    def testNtoH(self):

        # This just checks that htons etc. are their own inverse,

        # when looking at the lower 16 or 32 bits.

        sizes = {socket.htonl: 32, socket.ntohl: 32,

                 socket.htons: 16, socket.ntohs: 16}

        for func, size in sizes.items():

            mask = (1L<<size) - 1

            for i in (0, 1, 0xffff, ~0xffff, 2, 0x01234567, 0x76543210):

                self.assertEqual(i & mask, func(func(i&mask)) & mask)

            swapped = func(mask)

            self.assertEqual(swapped & mask, mask)

            self.assertRaises(OverflowError, func, 1L<<34)

    def testNtoHErrors(self):

        good_values = [ 1, 2, 3, 1L, 2L, 3L ]

        bad_values = [ -1, -2, -3, -1L, -2L, -3L ]

        for k in good_values:

            socket.ntohl(k)

            socket.ntohs(k)

            socket.htonl(k)

            socket.htons(k)

        for k in bad_values:

            self.assertRaises(OverflowError, socket.ntohl, k)

            self.assertRaises(OverflowError, socket.ntohs, k)

            self.assertRaises(OverflowError, socket.htonl, k)

            self.assertRaises(OverflowError, socket.htons, k)

    def testGetServBy(self):

        eq = self.assertEqual

        # Find one service that exists, then check all the related interfaces.

        # I've ordered this by protocols that have both a tcp and udp

        # protocol, at least for modern Linuxes.

        if sys.platform in ('linux2', 'freebsd4', 'freebsd5', 'freebsd6',

                            'freebsd7', 'freebsd8', 'darwin'):

            # avoid the 'echo' service on this platform, as there is an

            # assumption breaking non-standard port/protocol entry

            services = ('daytime', 'qotd', 'domain')

        else:

            services = ('echo', 'daytime', 'domain')

        for service in services:

            try:

                port = socket.getservbyname(service, 'tcp')

                break

            except socket.error:

                pass

        else:

            raise socket.error

        # Try same call with optional protocol omitted

        port2 = socket.getservbyname(service)

        eq(port, port2)

        # Try udp, but don't barf it it doesn't exist

        try:

            udpport = socket.getservbyname(service, 'udp')

        except socket.error:

            udpport = None

        else:

            eq(udpport, port)

        # Now make sure the lookup by port returns the same service name

        eq(socket.getservbyport(port2), service)

        eq(socket.getservbyport(port, 'tcp'), service)

        if udpport is not None:

            eq(socket.getservbyport(udpport, 'udp'), service)

    def testDefaultTimeout(self):

        # Testing default timeout

        # The default timeout should initially be None

        self.assertEqual(socket.getdefaulttimeout(), None)

        s = socket.socket()

        self.assertEqual(s.gettimeout(), None)

        s.close()

        # Set the default timeout to 10, and see if it propagates

        socket.setdefaulttimeout(10)

        self.assertEqual(socket.getdefaulttimeout(), 10)

        s = socket.socket()

        self.assertEqual(s.gettimeout(), 10)

        s.close()

        # Reset the default timeout to None, and see if it propagates

        socket.setdefaulttimeout(None)

        self.assertEqual(socket.getdefaulttimeout(), None)

        s = socket.socket()

        self.assertEqual(s.gettimeout(), None)

        s.close()

        # Check that setting it to an invalid value raises ValueError

        self.assertRaises(ValueError, socket.setdefaulttimeout, -1)

        # Check that setting it to an invalid type raises TypeError

        self.assertRaises(TypeError, socket.setdefaulttimeout, "spam")

    def testIPv4toString(self):

        if not hasattr(socket, 'inet_pton'):

            return # No inet_pton() on this platform

        from socket import inet_aton as f, inet_pton, AF_INET

        g = lambda a: inet_pton(AF_INET, a)

        self.assertEquals('\x00\x00\x00\x00', f('0.0.0.0'))

        self.assertEquals('\xff\x00\xff\x00', f('255.0.255.0'))

        self.assertEquals('\xaa\xaa\xaa\xaa', f('170.170.170.170'))

        self.assertEquals('\x01\x02\x03\x04', f('1.2.3.4'))

        self.assertEquals('\xff\xff\xff\xff', f('255.255.255.255'))

        self.assertEquals('\x00\x00\x00\x00', g('0.0.0.0'))

        self.assertEquals('\xff\x00\xff\x00', g('255.0.255.0'))

        self.assertEquals('\xaa\xaa\xaa\xaa', g('170.170.170.170'))

        self.assertEquals('\xff\xff\xff\xff', g('255.255.255.255'))

    def testIPv6toString(self):

        if not hasattr(socket, 'inet_pton'):

            return # No inet_pton() on this platform

        try:

            from socket import inet_pton, AF_INET6, has_ipv6

            if not has_ipv6:

                return

        except ImportError:

            return

        f = lambda a: inet_pton(AF_INET6, a)

        self.assertEquals('\x00' * 16, f('::'))

        self.assertEquals('\x00' * 16, f('0::0'))

        self.assertEquals('\x00\x01' + '\x00' * 14, f('1::'))

        self.assertEquals(

            '\x45\xef\x76\xcb\x00\x1a\x56\xef\xaf\xeb\x0b\xac\x19\x24\xae\xae',

            f('45ef:76cb:1a:56ef:afeb:bac:1924:aeae')

        )

    def testStringToIPv4(self):

        if not hasattr(socket, 'inet_ntop'):

            return # No inet_ntop() on this platform

        from socket import inet_ntoa as f, inet_ntop, AF_INET

        g = lambda a: inet_ntop(AF_INET, a)

        self.assertEquals('1.0.1.0', f('\x01\x00\x01\x00'))

        self.assertEquals('170.85.170.85', f('\xaa\x55\xaa\x55'))

        self.assertEquals('255.255.255.255', f('\xff\xff\xff\xff'))

        self.assertEquals('1.2.3.4', f('\x01\x02\x03\x04'))

        self.assertEquals('1.0.1.0', g('\x01\x00\x01\x00'))

        self.assertEquals('170.85.170.85', g('\xaa\x55\xaa\x55'))

        self.assertEquals('255.255.255.255', g('\xff\xff\xff\xff'))

    def testStringToIPv6(self):

        if not hasattr(socket, 'inet_ntop'):

            return # No inet_ntop() on this platform

        try:

            from socket import inet_ntop, AF_INET6, has_ipv6

            if not has_ipv6:

                return

        except ImportError:

            return

        f = lambda a: inet_ntop(AF_INET6, a)

        self.assertEquals('::', f('\x00' * 16))

        self.assertEquals('::1', f('\x00' * 15 + '\x01'))

        self.assertEquals(

            'aef:b01:506:1001:ffff:9997:55:170',

            f('\x0a\xef\x0b\x01\x05\x06\x10\x01\xff\xff\x99\x97\x00\x55\x01\x70')

        )

    # XXX The following don't test module-level functionality...

    def testSockName(self):

        # Testing getsockname().  Use a temporary socket to elicit an unused

        # ephemeral port that we can use later in the test.

        tempsock = socket.socket()

        tempsock.bind(("0.0.0.0", 0))

        (host, port) = tempsock.getsockname()

        tempsock.close()

        del tempsock

        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

        sock.bind(("0.0.0.0", port))

        name = sock.getsockname()

        # XXX(nnorwitz): http://tinyurl.com/os5jz seems to indicate

        # it reasonable to get the host's addr in addition to 0.0.0.0.

        # At least for eCos.  This is required for the S/390 to pass.

        my_ip_addr = socket.gethostbyname(socket.gethostname())

        self.assert_(name[0] in ("0.0.0.0", my_ip_addr), '%s invalid' % name[0])

        self.assertEqual(name[1], port)

    def testGetSockOpt(self):

        # Testing getsockopt()

        # We know a socket should start without reuse==0

        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

        reuse = sock.getsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR)

        self.failIf(reuse != 0, "initial mode is reuse")

    def testSetSockOpt(self):

        # Testing setsockopt()

        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

        sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)

        reuse = sock.getsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR)

        self.failIf(reuse == 0, "failed to set reuse mode")

    def testSendAfterClose(self):

        # testing send() after close() with timeout

        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

        sock.settimeout(1)

        sock.close()

        self.assertRaises(socket.error, sock.send, "spam")

    def testNewAttributes(self):

        # testing .family, .type and .protocol

        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

        self.assertEqual(sock.family, socket.AF_INET)

        self.assertEqual(sock.type, socket.SOCK_STREAM)

        self.assertEqual(sock.proto, 0)

        sock.close()

    def test_sock_ioctl(self):

        if os.name != "nt":

            return

        self.assert_(hasattr(socket.socket, 'ioctl'))

        self.assert_(hasattr(socket, 'SIO_RCVALL'))

        self.assert_(hasattr(socket, 'RCVALL_ON'))

        self.assert_(hasattr(socket, 'RCVALL_OFF'))

class BasicTCPTest(SocketConnectedTest):

    def __init__(self, methodName='runTest'):

        SocketConnectedTest.__init__(self, methodName=methodName)

    def testRecv(self):

        # Testing large receive over TCP

        msg = self.cli_conn.recv(1024)

        self.assertEqual(msg, MSG)

    def _testRecv(self):

        self.serv_conn.send(MSG)