1'''Tests for WindowsConsoleIO
2'''
3
4import io
5import os
6import sys
7import tempfile
8import unittest
9from test import support
10
11if sys.platform != 'win32':
12    raise unittest.SkipTest("test only relevant on win32")
13
14from _testconsole import write_input
15
16ConIO = io._WindowsConsoleIO
17
18class WindowsConsoleIOTests(unittest.TestCase):
19    def test_abc(self):
20        self.assertTrue(issubclass(ConIO, io.RawIOBase))
21        self.assertFalse(issubclass(ConIO, io.BufferedIOBase))
22        self.assertFalse(issubclass(ConIO, io.TextIOBase))
23
24    def test_open_fd(self):
25        self.assertRaisesRegex(ValueError,
26            "negative file descriptor", ConIO, -1)
27
28        with tempfile.TemporaryFile() as tmpfile:
29            fd = tmpfile.fileno()
30            # Windows 10: "Cannot open non-console file"
31            # Earlier: "Cannot open console output buffer for reading"
32            self.assertRaisesRegex(ValueError,
33                "Cannot open (console|non-console file)", ConIO, fd)
34
35        try:
36            f = ConIO(0)
37        except ValueError:
38            # cannot open console because it's not a real console
39            pass
40        else:
41            self.assertTrue(f.readable())
42            self.assertFalse(f.writable())
43            self.assertEqual(0, f.fileno())
44            f.close()   # multiple close should not crash
45            f.close()
46
47        try:
48            f = ConIO(1, 'w')
49        except ValueError:
50            # cannot open console because it's not a real console
51            pass
52        else:
53            self.assertFalse(f.readable())
54            self.assertTrue(f.writable())
55            self.assertEqual(1, f.fileno())
56            f.close()
57            f.close()
58
59        try:
60            f = ConIO(2, 'w')
61        except ValueError:
62            # cannot open console because it's not a real console
63            pass
64        else:
65            self.assertFalse(f.readable())
66            self.assertTrue(f.writable())
67            self.assertEqual(2, f.fileno())
68            f.close()
69            f.close()
70
71    def test_open_name(self):
72        self.assertRaises(ValueError, ConIO, sys.executable)
73
74        f = ConIO("CON")
75        self.assertTrue(f.readable())
76        self.assertFalse(f.writable())
77        self.assertIsNotNone(f.fileno())
78        f.close()   # multiple close should not crash
79        f.close()
80
81        f = ConIO('CONIN$')
82        self.assertTrue(f.readable())
83        self.assertFalse(f.writable())
84        self.assertIsNotNone(f.fileno())
85        f.close()
86        f.close()
87
88        f = ConIO('CONOUT$', 'w')
89        self.assertFalse(f.readable())
90        self.assertTrue(f.writable())
91        self.assertIsNotNone(f.fileno())
92        f.close()
93        f.close()
94
95        f = open('C:/con', 'rb', buffering=0)
96        self.assertIsInstance(f, ConIO)
97        f.close()
98
99    @unittest.skipIf(sys.getwindowsversion()[:2] <= (6, 1),
100        "test does not work on Windows 7 and earlier")
101    def test_conin_conout_names(self):
102        f = open(r'\\.\conin$', 'rb', buffering=0)
103        self.assertIsInstance(f, ConIO)
104        f.close()
105
106        f = open('//?/conout$', 'wb', buffering=0)
107        self.assertIsInstance(f, ConIO)
108        f.close()
109
110    def test_conout_path(self):
111        temp_path = tempfile.mkdtemp()
112        self.addCleanup(support.rmtree, temp_path)
113
114        conout_path = os.path.join(temp_path, 'CONOUT$')
115
116        with open(conout_path, 'wb', buffering=0) as f:
117            if sys.getwindowsversion()[:2] > (6, 1):
118                self.assertIsInstance(f, ConIO)
119            else:
120                self.assertNotIsInstance(f, ConIO)
121
122    def test_write_empty_data(self):
123        with ConIO('CONOUT$', 'w') as f:
124            self.assertEqual(f.write(b''), 0)
125
126    def assertStdinRoundTrip(self, text):
127        stdin = open('CONIN$', 'r')
128        old_stdin = sys.stdin
129        try:
130            sys.stdin = stdin
131            write_input(
132                stdin.buffer.raw,
133                (text + '\r\n').encode('utf-16-le', 'surrogatepass')
134            )
135            actual = input()
136        finally:
137            sys.stdin = old_stdin
138        self.assertEqual(actual, text)
139
140    def test_input(self):
141        # ASCII
142        self.assertStdinRoundTrip('abc123')
143        # Non-ASCII
144        self.assertStdinRoundTrip('ϼўТλФЙ')
145        # Combining characters
146        self.assertStdinRoundTrip('A͏B ﬖ̳AA̝')
147        # Non-BMP
148        self.assertStdinRoundTrip('\U00100000\U0010ffff\U0010fffd')
149
150    def test_partial_reads(self):
151        # Test that reading less than 1 full character works when stdin
152        # contains multibyte UTF-8 sequences
153        source = 'ϼўТλФЙ\r\n'.encode('utf-16-le')
154        expected = 'ϼўТλФЙ\r\n'.encode('utf-8')
155        for read_count in range(1, 16):
156            with open('CONIN$', 'rb', buffering=0) as stdin:
157                write_input(stdin, source)
158
159                actual = b''
160                while not actual.endswith(b'\n'):
161                    b = stdin.read(read_count)
162                    actual += b
163
164                self.assertEqual(actual, expected, 'stdin.read({})'.format(read_count))
165
166    def test_partial_surrogate_reads(self):
167        # Test that reading less than 1 full character works when stdin
168        # contains surrogate pairs that cannot be decoded to UTF-8 without
169        # reading an extra character.
170        source = '\U00101FFF\U00101001\r\n'.encode('utf-16-le')
171        expected = '\U00101FFF\U00101001\r\n'.encode('utf-8')
172        for read_count in range(1, 16):
173            with open('CONIN$', 'rb', buffering=0) as stdin:
174                write_input(stdin, source)
175
176                actual = b''
177                while not actual.endswith(b'\n'):
178                    b = stdin.read(read_count)
179                    actual += b
180
181                self.assertEqual(actual, expected, 'stdin.read({})'.format(read_count))
182
183    def test_ctrl_z(self):
184        with open('CONIN$', 'rb', buffering=0) as stdin:
185            source = '\xC4\x1A\r\n'.encode('utf-16-le')
186            expected = '\xC4'.encode('utf-8')
187            write_input(stdin, source)
188            a, b = stdin.read(1), stdin.readall()
189            self.assertEqual(expected[0:1], a)
190            self.assertEqual(expected[1:], b)
191
192if __name__ == "__main__":
193    unittest.main()
194