Python code coverage for Lib/idlelib/idle_test/test_query.py

#	count	content
1	n/a	"""Test idlelib.query.
2	n/a
3	n/a	Non-gui tests for Query, SectionName, ModuleName, and HelpSource use
4	n/a	dummy versions that extract the non-gui methods and add other needed
5	n/a	attributes. GUI tests create an instance of each class and simulate
6	n/a	entries and button clicks. Subclass tests only target the new code in
7	n/a	the subclass definition.
8	n/a
9	n/a	The appearance of the widgets is checked by the Query and
10	n/a	HelpSource htests. These are run by running query.py.
11	n/a
12	n/a	Coverage: 94% (100% for Query and SectionName).
13	n/a	6 of 8 missing are ModuleName exceptions I don't know how to trigger.
14	n/a	"""
15	n/a	from test.support import requires
16	n/a	import sys
17	n/a	from tkinter import Tk
18	n/a	import unittest
19	n/a	from unittest import mock
20	n/a	from idlelib.idle_test.mock_tk import Var
21	n/a	from idlelib import query
22	n/a
23	n/a
24	n/a	# NON-GUI TESTS
25	n/a
26	n/a	class QueryTest(unittest.TestCase):
27	n/a	"Test Query base class."
28	n/a
29	n/a	class Dummy_Query:
30	n/a	# Test the following Query methods.
31	n/a	entry_ok = query.Query.entry_ok
32	n/a	ok = query.Query.ok
33	n/a	cancel = query.Query.cancel
34	n/a	# Add attributes and initialization needed for tests.
35	n/a	entry = Var()
36	n/a	entry_error = {}
37	n/a	def __init__(self, dummy_entry):
38	n/a	self.entry.set(dummy_entry)
39	n/a	self.entry_error['text'] = ''
40	n/a	self.result = None
41	n/a	self.destroyed = False
42	n/a	def showerror(self, message):
43	n/a	self.entry_error['text'] = message
44	n/a	def destroy(self):
45	n/a	self.destroyed = True
46	n/a
47	n/a	def test_entry_ok_blank(self):
48	n/a	dialog = self.Dummy_Query(' ')
49	n/a	self.assertEqual(dialog.entry_ok(), None)
50	n/a	self.assertEqual((dialog.result, dialog.destroyed), (None, False))
51	n/a	self.assertIn('blank line', dialog.entry_error['text'])
52	n/a
53	n/a	def test_entry_ok_good(self):
54	n/a	dialog = self.Dummy_Query(' good ')
55	n/a	Equal = self.assertEqual
56	n/a	Equal(dialog.entry_ok(), 'good')
57	n/a	Equal((dialog.result, dialog.destroyed), (None, False))
58	n/a	Equal(dialog.entry_error['text'], '')
59	n/a
60	n/a	def test_ok_blank(self):
61	n/a	dialog = self.Dummy_Query('')
62	n/a	dialog.entry.focus_set = mock.Mock()
63	n/a	self.assertEqual(dialog.ok(), None)
64	n/a	self.assertTrue(dialog.entry.focus_set.called)
65	n/a	del dialog.entry.focus_set
66	n/a	self.assertEqual((dialog.result, dialog.destroyed), (None, False))
67	n/a
68	n/a	def test_ok_good(self):
69	n/a	dialog = self.Dummy_Query('good')
70	n/a	self.assertEqual(dialog.ok(), None)
71	n/a	self.assertEqual((dialog.result, dialog.destroyed), ('good', True))
72	n/a
73	n/a	def test_cancel(self):
74	n/a	dialog = self.Dummy_Query('does not matter')
75	n/a	self.assertEqual(dialog.cancel(), None)
76	n/a	self.assertEqual((dialog.result, dialog.destroyed), (None, True))
77	n/a
78	n/a
79	n/a	class SectionNameTest(unittest.TestCase):
80	n/a	"Test SectionName subclass of Query."
81	n/a
82	n/a	class Dummy_SectionName:
83	n/a	entry_ok = query.SectionName.entry_ok # Function being tested.
84	n/a	used_names = ['used']
85	n/a	entry = Var()
86	n/a	entry_error = {}
87	n/a	def __init__(self, dummy_entry):
88	n/a	self.entry.set(dummy_entry)
89	n/a	self.entry_error['text'] = ''
90	n/a	def showerror(self, message):
91	n/a	self.entry_error['text'] = message
92	n/a
93	n/a	def test_blank_section_name(self):
94	n/a	dialog = self.Dummy_SectionName(' ')
95	n/a	self.assertEqual(dialog.entry_ok(), None)
96	n/a	self.assertIn('no name', dialog.entry_error['text'])
97	n/a
98	n/a	def test_used_section_name(self):
99	n/a	dialog = self.Dummy_SectionName('used')
100	n/a	self.assertEqual(dialog.entry_ok(), None)
101	n/a	self.assertIn('use', dialog.entry_error['text'])
102	n/a
103	n/a	def test_long_section_name(self):
104	n/a	dialog = self.Dummy_SectionName('good'*8)
105	n/a	self.assertEqual(dialog.entry_ok(), None)
106	n/a	self.assertIn('longer than 30', dialog.entry_error['text'])
107	n/a
108	n/a	def test_good_section_name(self):
109	n/a	dialog = self.Dummy_SectionName(' good ')
110	n/a	self.assertEqual(dialog.entry_ok(), 'good')
111	n/a	self.assertEqual(dialog.entry_error['text'], '')
112	n/a
113	n/a
114	n/a	class ModuleNameTest(unittest.TestCase):
115	n/a	"Test ModuleName subclass of Query."
116	n/a
117	n/a	class Dummy_ModuleName:
118	n/a	entry_ok = query.ModuleName.entry_ok # Function being tested.
119	n/a	text0 = ''
120	n/a	entry = Var()
121	n/a	entry_error = {}
122	n/a	def __init__(self, dummy_entry):
123	n/a	self.entry.set(dummy_entry)
124	n/a	self.entry_error['text'] = ''
125	n/a	def showerror(self, message):
126	n/a	self.entry_error['text'] = message
127	n/a
128	n/a	def test_blank_module_name(self):
129	n/a	dialog = self.Dummy_ModuleName(' ')
130	n/a	self.assertEqual(dialog.entry_ok(), None)
131	n/a	self.assertIn('no name', dialog.entry_error['text'])
132	n/a
133	n/a	def test_bogus_module_name(self):
134	n/a	dialog = self.Dummy_ModuleName('__name_xyz123_should_not_exist__')
135	n/a	self.assertEqual(dialog.entry_ok(), None)
136	n/a	self.assertIn('not found', dialog.entry_error['text'])
137	n/a
138	n/a	def test_c_source_name(self):
139	n/a	dialog = self.Dummy_ModuleName('itertools')
140	n/a	self.assertEqual(dialog.entry_ok(), None)
141	n/a	self.assertIn('source-based', dialog.entry_error['text'])
142	n/a
143	n/a	def test_good_module_name(self):
144	n/a	dialog = self.Dummy_ModuleName('idlelib')
145	n/a	self.assertTrue(dialog.entry_ok().endswith('__init__.py'))
146	n/a	self.assertEqual(dialog.entry_error['text'], '')
147	n/a
148	n/a
149	n/a	# 3 HelpSource test classes each test one function.
150	n/a
151	n/a	orig_platform = query.platform
152	n/a
153	n/a	class HelpsourceBrowsefileTest(unittest.TestCase):
154	n/a	"Test browse_file method of ModuleName subclass of Query."
155	n/a
156	n/a	class Dummy_HelpSource:
157	n/a	browse_file = query.HelpSource.browse_file
158	n/a	pathvar = Var()
159	n/a
160	n/a	def test_file_replaces_path(self):
161	n/a	dialog = self.Dummy_HelpSource()
162	n/a	# Path is widget entry, either '' or something.
163	n/a	# Func return is file dialog return, either '' or something.
164	n/a	# Func return should override widget entry.
165	n/a	# We need all 4 combination to test all (most) code paths.
166	n/a	for path, func, result in (
167	n/a	('', lambda a,b,c:'', ''),
168	n/a	('', lambda a,b,c: __file__, __file__),
169	n/a	('htest', lambda a,b,c:'', 'htest'),
170	n/a	('htest', lambda a,b,c: __file__, __file__)):
171	n/a	with self.subTest():
172	n/a	dialog.pathvar.set(path)
173	n/a	dialog.askfilename = func
174	n/a	dialog.browse_file()
175	n/a	self.assertEqual(dialog.pathvar.get(), result)
176	n/a
177	n/a
178	n/a	class HelpsourcePathokTest(unittest.TestCase):
179	n/a	"Test path_ok method of HelpSource subclass of Query."
180	n/a
181	n/a	class Dummy_HelpSource:
182	n/a	path_ok = query.HelpSource.path_ok
183	n/a	path = Var()
184	n/a	path_error = {}
185	n/a	def __init__(self, dummy_path):
186	n/a	self.path.set(dummy_path)
187	n/a	self.path_error['text'] = ''
188	n/a	def showerror(self, message, widget=None):
189	n/a	self.path_error['text'] = message
190	n/a
191	n/a	@classmethod
192	n/a	def tearDownClass(cls):
193	n/a	query.platform = orig_platform
194	n/a
195	n/a	def test_path_ok_blank(self):
196	n/a	dialog = self.Dummy_HelpSource(' ')
197	n/a	self.assertEqual(dialog.path_ok(), None)
198	n/a	self.assertIn('no help file', dialog.path_error['text'])
199	n/a
200	n/a	def test_path_ok_bad(self):
201	n/a	dialog = self.Dummy_HelpSource(__file__ + 'bad-bad-bad')
202	n/a	self.assertEqual(dialog.path_ok(), None)
203	n/a	self.assertIn('not exist', dialog.path_error['text'])
204	n/a
205	n/a	def test_path_ok_web(self):
206	n/a	dialog = self.Dummy_HelpSource('')
207	n/a	Equal = self.assertEqual
208	n/a	for url in 'www.py.org', 'http://py.org':
209	n/a	with self.subTest():
210	n/a	dialog.path.set(url)
211	n/a	self.assertEqual(dialog.path_ok(), url)
212	n/a	self.assertEqual(dialog.path_error['text'], '')
213	n/a
214	n/a	def test_path_ok_file(self):
215	n/a	dialog = self.Dummy_HelpSource('')
216	n/a	for platform, prefix in ('darwin', 'file://'), ('other', ''):
217	n/a	with self.subTest():
218	n/a	query.platform = platform
219	n/a	dialog.path.set(__file__)
220	n/a	self.assertEqual(dialog.path_ok(), prefix + __file__)
221	n/a	self.assertEqual(dialog.path_error['text'], '')
222	n/a
223	n/a
224	n/a	class HelpsourceEntryokTest(unittest.TestCase):
225	n/a	"Test entry_ok method of HelpSource subclass of Query."
226	n/a
227	n/a	class Dummy_HelpSource:
228	n/a	entry_ok = query.HelpSource.entry_ok
229	n/a	entry_error = {}
230	n/a	path_error = {}
231	n/a	def item_ok(self):
232	n/a	return self.name
233	n/a	def path_ok(self):
234	n/a	return self.path
235	n/a
236	n/a	def test_entry_ok_helpsource(self):
237	n/a	dialog = self.Dummy_HelpSource()
238	n/a	for name, path, result in ((None, None, None),
239	n/a	(None, 'doc.txt', None),
240	n/a	('doc', None, None),
241	n/a	('doc', 'doc.txt', ('doc', 'doc.txt'))):
242	n/a	with self.subTest():
243	n/a	dialog.name, dialog.path = name, path
244	n/a	self.assertEqual(dialog.entry_ok(), result)
245	n/a
246	n/a
247	n/a	# GUI TESTS
248	n/a
249	n/a	class QueryGuiTest(unittest.TestCase):
250	n/a
251	n/a	@classmethod
252	n/a	def setUpClass(cls):
253	n/a	requires('gui')
254	n/a	cls.root = root = Tk()
255	n/a	cls.root.withdraw()
256	n/a	cls.dialog = query.Query(root, 'TEST', 'test', _utest=True)
257	n/a	cls.dialog.destroy = mock.Mock()
258	n/a
259	n/a	@classmethod
260	n/a	def tearDownClass(cls):
261	n/a	del cls.dialog
262	n/a	cls.root.destroy()
263	n/a	del cls.root
264	n/a
265	n/a	def setUp(self):
266	n/a	self.dialog.entry.delete(0, 'end')
267	n/a	self.dialog.result = None
268	n/a	self.dialog.destroy.reset_mock()
269	n/a
270	n/a	def test_click_ok(self):
271	n/a	dialog = self.dialog
272	n/a	dialog.entry.insert(0, 'abc')
273	n/a	dialog.button_ok.invoke()
274	n/a	self.assertEqual(dialog.result, 'abc')
275	n/a	self.assertTrue(dialog.destroy.called)
276	n/a
277	n/a	def test_click_blank(self):
278	n/a	dialog = self.dialog
279	n/a	dialog.button_ok.invoke()
280	n/a	self.assertEqual(dialog.result, None)
281	n/a	self.assertFalse(dialog.destroy.called)
282	n/a
283	n/a	def test_click_cancel(self):
284	n/a	dialog = self.dialog
285	n/a	dialog.entry.insert(0, 'abc')
286	n/a	dialog.button_cancel.invoke()
287	n/a	self.assertEqual(dialog.result, None)
288	n/a	self.assertTrue(dialog.destroy.called)
289	n/a
290	n/a
291	n/a	class SectionnameGuiTest(unittest.TestCase):
292	n/a
293	n/a	@classmethod
294	n/a	def setUpClass(cls):
295	n/a	requires('gui')
296	n/a
297	n/a	def test_click_section_name(self):
298	n/a	root = Tk()
299	n/a	root.withdraw()
300	n/a	dialog = query.SectionName(root, 'T', 't', {'abc'}, _utest=True)
301	n/a	Equal = self.assertEqual
302	n/a	self.assertEqual(dialog.used_names, {'abc'})
303	n/a	dialog.entry.insert(0, 'okay')
304	n/a	dialog.button_ok.invoke()
305	n/a	self.assertEqual(dialog.result, 'okay')
306	n/a	del dialog
307	n/a	root.destroy()
308	n/a	del root
309	n/a
310	n/a
311	n/a	class ModulenameGuiTest(unittest.TestCase):
312	n/a
313	n/a	@classmethod
314	n/a	def setUpClass(cls):
315	n/a	requires('gui')
316	n/a
317	n/a	def test_click_module_name(self):
318	n/a	root = Tk()
319	n/a	root.withdraw()
320	n/a	dialog = query.ModuleName(root, 'T', 't', 'idlelib', _utest=True)
321	n/a	self.assertEqual(dialog.text0, 'idlelib')
322	n/a	self.assertEqual(dialog.entry.get(), 'idlelib')
323	n/a	dialog.button_ok.invoke()
324	n/a	self.assertTrue(dialog.result.endswith('__init__.py'))
325	n/a	del dialog
326	n/a	root.destroy()
327	n/a	del root
328	n/a
329	n/a
330	n/a	class HelpsourceGuiTest(unittest.TestCase):
331	n/a
332	n/a	@classmethod
333	n/a	def setUpClass(cls):
334	n/a	requires('gui')
335	n/a
336	n/a	def test_click_help_source(self):
337	n/a	root = Tk()
338	n/a	root.withdraw()
339	n/a	dialog = query.HelpSource(root, 'T', menuitem='__test__',
340	n/a	filepath=__file__, _utest=True)
341	n/a	Equal = self.assertEqual
342	n/a	Equal(dialog.entry.get(), '__test__')
343	n/a	Equal(dialog.path.get(), __file__)
344	n/a	dialog.button_ok.invoke()
345	n/a	prefix = "file://" if sys.platform == 'darwin' else ''
346	n/a	Equal(dialog.result, ('__test__', prefix + __file__))
347	n/a	del dialog
348	n/a	root.destroy()
349	n/a	del root
350	n/a
351	n/a
352	n/a	if __name__ == '__main__':
353	n/a	unittest.main(verbosity=2, exit=False)