Lib/test/test_asyncio/test_windows_utils.py

"""Tests for window_utils"""

import sys
import unittest
import warnings

if sys.platform != 'win32':
    raise unittest.SkipTest('Windows only')

import _overlapped
import _winapi

import asyncio
from asyncio import windows_utils
from test import support


def tearDownModule():
    asyncio.set_event_loop(None)


class PipeTests(unittest.TestCase):

    def test_pipe_overlapped(self):
        h1, h2 = windows_utils.pipe(overlapped=(True, True))
        try:
            ov1 = _overlapped.Overlapped()
            self.assertFalse(ov1.pending)
            self.assertEqual(ov1.error, 0)

            ov1.ReadFile(h1, 100)
            self.assertTrue(ov1.pending)
            self.assertEqual(ov1.error, _winapi.ERROR_IO_PENDING)
            ERROR_IO_INCOMPLETE = 996
            try:
                ov1.getresult()
            except OSError as e:
                self.assertEqual(e.winerror, ERROR_IO_INCOMPLETE)
            else:
                raise RuntimeError('expected ERROR_IO_INCOMPLETE')

            ov2 = _overlapped.Overlapped()
            self.assertFalse(ov2.pending)
            self.assertEqual(ov2.error, 0)

            ov2.WriteFile(h2, b"hello")
            self.assertIn(ov2.error, {0, _winapi.ERROR_IO_PENDING})

            res = _winapi.WaitForMultipleObjects([ov2.event], False, 100)
            self.assertEqual(res, _winapi.WAIT_OBJECT_0)

            self.assertFalse(ov1.pending)
            self.assertEqual(ov1.error, ERROR_IO_INCOMPLETE)
            self.assertFalse(ov2.pending)
            self.assertIn(ov2.error, {0, _winapi.ERROR_IO_PENDING})
            self.assertEqual(ov1.getresult(), b"hello")
        finally:
            _winapi.CloseHandle(h1)
            _winapi.CloseHandle(h2)

    def test_pipe_handle(self):
        h, _ = windows_utils.pipe(overlapped=(True, True))
        _winapi.CloseHandle(_)
        p = windows_utils.PipeHandle(h)
        self.assertEqual(p.fileno(), h)
        self.assertEqual(p.handle, h)

        # check garbage collection of p closes handle
        with warnings.catch_warnings():
            warnings.filterwarnings("ignore", "",  ResourceWarning)
            del p
            support.gc_collect()
        try:
            _winapi.CloseHandle(h)
        except OSError as e:
            self.assertEqual(e.winerror, 6)     # ERROR_INVALID_HANDLE
        else:
            raise RuntimeError('expected ERROR_INVALID_HANDLE')

    def test_pipe_handle_close_after_external_close(self):
        # gh-149388: PipeHandle.close() must clear ``_handle`` before calling
        # CloseHandle so that if CloseHandle raises on a stale handle the
        # PipeHandle is still marked closed and __del__ / subsequent close()
        # calls are silent no-ops.
        h1, h2 = windows_utils.pipe(overlapped=(False, False))
        try:
            p = windows_utils.PipeHandle(h1)
            # Simulate an external close of the underlying handle (e.g.
            # a finalizer race or a concurrent close on the same object).
            _winapi.CloseHandle(p.handle)
            # First close() still propagates the OSError from CloseHandle,
            # but must clear ``_handle`` first.
            with self.assertRaises(OSError):
                p.close()
            self.assertIsNone(p.handle)
            # Second close() is a no-op.
            p.close()
            # __del__ through GC is also a silent no-op — no unraisable.
            del p
            support.gc_collect()
        finally:
            _winapi.CloseHandle(h2)


class PopenTests(unittest.TestCase):

    def test_popen(self):
        command = r"""if 1:
            import sys
            s = sys.stdin.readline()
            sys.stdout.write(s.upper())
            sys.stderr.write('stderr')
            """
        msg = b"blah\n"

        p = windows_utils.Popen([sys.executable, '-c', command],
                                stdin=windows_utils.PIPE,
                                stdout=windows_utils.PIPE,
                                stderr=windows_utils.PIPE)

        for f in [p.stdin, p.stdout, p.stderr]:
            self.assertIsInstance(f, windows_utils.PipeHandle)

        ovin = _overlapped.Overlapped()
        ovout = _overlapped.Overlapped()
        overr = _overlapped.Overlapped()

        ovin.WriteFile(p.stdin.handle, msg)
        ovout.ReadFile(p.stdout.handle, 100)
        overr.ReadFile(p.stderr.handle, 100)

        events = [ovin.event, ovout.event, overr.event]
        # Super-long timeout for slow buildbots.
        res = _winapi.WaitForMultipleObjects(events, True,
                                             int(support.SHORT_TIMEOUT * 1000))
        self.assertEqual(res, _winapi.WAIT_OBJECT_0)
        self.assertFalse(ovout.pending)
        self.assertFalse(overr.pending)
        self.assertFalse(ovin.pending)

        self.assertEqual(ovin.getresult(), len(msg))
        out = ovout.getresult().rstrip()
        err = overr.getresult().rstrip()

        self.assertGreater(len(out), 0)
        self.assertGreater(len(err), 0)
        # allow for partial reads...
        self.assertStartsWith(msg.upper().rstrip(), out)
        self.assertStartsWith(b"stderr", err)

        # The context manager calls wait() and closes resources
        with p:
            pass


class OverlappedRefleakTests(unittest.TestCase):

    def test_wsasendto_failure(self):
        ov = _overlapped.Overlapped()
        buf = bytearray(4096)
        with self.assertRaises(OSError):
            ov.WSASendTo(0x1234, buf, 0, ("127.0.0.1", 1))

    def test_wsarecvfrom_failure(self):
        ov = _overlapped.Overlapped()
        with self.assertRaises(OSError):
            ov.WSARecvFrom(0x1234, 1024, 0)

    def test_wsarecvfrominto_failure(self):
        ov = _overlapped.Overlapped()
        buf = bytearray(4096)
        with self.assertRaises(OSError):
            ov.WSARecvFromInto(0x1234, buf, len(buf), 0)


if __name__ == '__main__':
    unittest.main()