1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
# Copyright 2021 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
"""Tests for pw_console.console_app"""
import asyncio
import builtins
import inspect
import io
import sys
import threading
import unittest
from unittest.mock import MagicMock, call
from prompt_toolkit.application import create_app_session
from prompt_toolkit.output import (
ColorDepth,
# inclusive-language: ignore
DummyOutput as FakeOutput,
)
from pw_console.console_app import ConsoleApp
from pw_console.repl_pane import ReplPane
from pw_console.pw_ptpython_repl import PwPtPythonRepl
_PYTHON_3_8 = sys.version_info >= (
3,
8,
)
if _PYTHON_3_8:
from unittest import IsolatedAsyncioTestCase # type: ignore # pylint: disable=no-name-in-module
class TestReplPane(IsolatedAsyncioTestCase):
"""Tests for ReplPane."""
def setUp(self): # pylint: disable=invalid-name
self.maxDiff = None # pylint: disable=invalid-name
def test_repl_code_return_values(self) -> None:
"""Test stdout, return values, and exceptions can be returned from
running user repl code."""
app = MagicMock()
global_vars = {
'__name__': '__main__',
'__package__': None,
'__doc__': None,
'__builtins__': builtins,
}
pw_ptpython_repl = PwPtPythonRepl(
get_globals=lambda: global_vars,
get_locals=lambda: global_vars,
color_depth=ColorDepth.DEPTH_8_BIT)
repl_pane = ReplPane(
application=app,
python_repl=pw_ptpython_repl,
)
# Check pw_ptpython_repl has a reference to the parent repl_pane.
self.assertEqual(repl_pane, pw_ptpython_repl.repl_pane)
# Define a function, should return nothing.
code = inspect.cleandoc("""
def run():
print('The answer is ', end='')
return 1+1+4+16+20
""")
temp_stdout = io.StringIO()
temp_stderr = io.StringIO()
# pylint: disable=protected-access
result = asyncio.run(
pw_ptpython_repl._run_user_code(code, temp_stdout,
temp_stderr))
self.assertEqual(result, {
'stdout': '',
'stderr': '',
'result': None
})
temp_stdout = io.StringIO()
temp_stderr = io.StringIO()
# Check stdout and return value
result = asyncio.run(
pw_ptpython_repl._run_user_code('run()', temp_stdout,
temp_stderr))
self.assertEqual(result, {
'stdout': 'The answer is ',
'stderr': '',
'result': 42
})
temp_stdout = io.StringIO()
temp_stderr = io.StringIO()
# Check for repl exception
result = asyncio.run(
pw_ptpython_repl._run_user_code('return "blah"', temp_stdout,
temp_stderr))
self.assertIn("SyntaxError: 'return' outside function",
pw_ptpython_repl._last_exception) # type: ignore
async def test_user_thread(self) -> None:
"""Test user code thread."""
with create_app_session(output=FakeOutput()):
# Setup Mocks
app = ConsoleApp(color_depth=ColorDepth.DEPTH_8_BIT)
app.start_user_code_thread()
pw_ptpython_repl = app.pw_ptpython_repl
repl_pane = app.repl_pane
# Mock update_output_buffer to track number of update calls
repl_pane.update_output_buffer = MagicMock(
wraps=repl_pane.update_output_buffer)
# Mock complete callback
pw_ptpython_repl.user_code_complete_callback = MagicMock(
wraps=pw_ptpython_repl.user_code_complete_callback)
# Repl done flag for tests
user_code_done = threading.Event()
# Run some code
code = inspect.cleandoc("""
import time
def run():
for i in range(2):
time.sleep(0.5)
print(i)
print('The answer is ', end='')
return 1+1+4+16+20
""")
input_buffer = MagicMock(text=code)
pw_ptpython_repl._accept_handler(input_buffer) # pylint: disable=protected-access
# Get last executed code object.
user_code1 = repl_pane.executed_code[-1]
# Wait for repl code to finish.
user_code1.future.add_done_callback(
lambda future: user_code_done.set())
# Wait for stdout monitoring to complete.
if user_code1.stdout_check_task:
await user_code1.stdout_check_task
# Wait for test done callback.
user_code_done.wait(timeout=3)
# Check user_code1 results
# NOTE: Avoid using assert_has_calls. Thread timing can make the
# test flaky.
expected_calls = [
# Initial exec start
call('pw_ptpython_repl._accept_handler'),
# Code finishes
call('repl_pane.append_result_to_executed_code'),
# Complete callback
call('pw_ptpython_repl.user_code_complete_callback'),
]
for expected_call in expected_calls:
self.assertIn(expected_call,
repl_pane.update_output_buffer.mock_calls)
pw_ptpython_repl.user_code_complete_callback.assert_called_once(
)
self.assertIsNotNone(user_code1)
self.assertTrue(user_code1.future.done())
self.assertEqual(user_code1.input, code)
self.assertEqual(user_code1.output, None)
# stdout / stderr may be '' or None
self.assertFalse(user_code1.stdout)
self.assertFalse(user_code1.stderr)
# Reset mocks
user_code_done.clear()
pw_ptpython_repl.user_code_complete_callback.reset_mock()
repl_pane.update_output_buffer.reset_mock()
# Run some code
input_buffer = MagicMock(text='run()')
pw_ptpython_repl._accept_handler(input_buffer) # pylint: disable=protected-access
# Get last executed code object.
user_code2 = repl_pane.executed_code[-1]
# Wait for repl code to finish.
user_code2.future.add_done_callback(
lambda future: user_code_done.set())
# Wait for stdout monitoring to complete.
if user_code2.stdout_check_task:
await user_code2.stdout_check_task
# Wait for test done callback.
user_code_done.wait(timeout=3)
# Check user_code2 results
# NOTE: Avoid using assert_has_calls. Thread timing can make the
# test flaky.
expected_calls = [
# Initial exec start
call('pw_ptpython_repl._accept_handler'),
# Periodic checks, should be a total of 4:
# Code should take 1.0 second to run.
# Periodic checks every 0.3 seconds
# 1.0 / 0.3 = 3.33 (4) checks
call('repl_pane.periodic_check'),
call('repl_pane.periodic_check'),
call('repl_pane.periodic_check'),
# Code finishes
call('repl_pane.append_result_to_executed_code'),
# Complete callback
call('pw_ptpython_repl.user_code_complete_callback'),
# Final periodic check
call('repl_pane.periodic_check'),
]
for expected_call in expected_calls:
self.assertIn(expected_call,
repl_pane.update_output_buffer.mock_calls)
pw_ptpython_repl.user_code_complete_callback.assert_called_once(
)
self.assertIsNotNone(user_code2)
self.assertTrue(user_code2.future.done())
self.assertEqual(user_code2.input, 'run()')
self.assertEqual(user_code2.output, '42')
self.assertEqual(user_code2.stdout, '0\n1\nThe answer is ')
self.assertFalse(user_code2.stderr)
# Reset mocks
user_code_done.clear()
pw_ptpython_repl.user_code_complete_callback.reset_mock()
repl_pane.update_output_buffer.reset_mock()
if __name__ == '__main__':
unittest.main()
|
