Idle: test SearchDialogBase.py

[philwebster]

BPO	18592
Nosy	@terryjreedy, @ezio-melotti, @rovitotv, @serhiy-storchaka
Files	test_searchdialogbase.patch test_searchdialogbase2.patch 18592_test_searchdialog.diff 18592_test_searchdialog2.diff test-search-sdb-18592-34.diff grepdialog_bug.diff

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/terryjreedy'
closed_at = <Date 2014-07-01.03:54:03.829>
created_at = <Date 2013-07-30.01:12:50.255>
labels = ['expert-IDLE', 'type-feature']
title = 'Idle:  test SearchDialogBase.py'
updated_at = <Date 2014-07-13.21:28:26.118>
user = 'https://bugs.python.org/philwebster'

bugs.python.org fields:

activity = <Date 2014-07-13.21:28:26.118>
actor = 'python-dev'
assignee = 'terry.reedy'
closed = True
closed_date = <Date 2014-07-01.03:54:03.829>
closer = 'terry.reedy'
components = ['IDLE']
creation = <Date 2013-07-30.01:12:50.255>
creator = 'philwebster'
dependencies = []
files = ['31082', '31220', '31364', '31542', '35784', '35937']
hgrepos = []
issue_num = 18592
keywords = ['patch']
message_count = 21.0
messages = ['193911', '194838', '195581', '195582', '195591', '195712', '196699', '221592', '221593', '221598', '221997', '222006', '222464', '222484', '222485', '222488', '222513', '222544', '222723', '222914', '222976']
nosy_count = 8.0
nosy_names = ['terry.reedy', 'ezio.melotti', 'Todd.Rovito', 'python-dev', 'serhiy.storchaka', 'JayKrish', 'philwebster', 'Saimadhav.Heblikar']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue18592'
versions = ['Python 2.7', 'Python 3.4', 'Python 3.5']

[philwebster]

This is a basic set of tests for SearchDialogBase. It mainly consists of gui code, so I was not completely sure of how/what to test. Before venturing any further, I thought I would make sure I'm heading in the right direction.

[philwebster]

As suggested by Ezio, I factored out the button tests to a common method.

[python-dev]

New changeset 0d2b87ec9f2b by Terry Jan Reedy in branch '2.7':
Issue bpo-18592: Add docstrings to file being tested (idlelib.SearchDialogBase.py).
http://hg.python.org/cpython/rev/0d2b87ec9f2b

New changeset e09dfdbeb9a2 by Terry Jan Reedy in branch '3.3':
Issue bpo-18592: Add docstrings to file being tested (idlelib.SearchDialogBase.py).
http://hg.python.org/cpython/rev/e09dfdbeb9a2

New changeset 358a2b2fbad4 by Terry Jan Reedy in branch '3.3':
Issue bpo-18592: whitespace
http://hg.python.org/cpython/rev/358a2b2fbad4

New changeset 1f2b78941c4a by Terry Jan Reedy in branch '2.7':
Issue bpo-18592: whitespace
http://hg.python.org/cpython/rev/1f2b78941c4a

[terryjreedy]

I added the docstrings that I wish had already been present.
The only 2.7-3.3 difference in SearchDialogBase is Tkinter/tkinter.

[terryjreedy]

A subtle point about coverage. The target module must be imported.
from idlelib import SearchDialogBase as sdb # works.
import idlelib.SearchDialogBase as sdb # does not
at least not as I invoke coveragepy in my batch file.

With this change, the four uncovered lines were "btn.select()" after
if self.engine.is/re/case/word/back/():
in create_option_buttons and create_other_buttons. I added a parameter to checkboxtests and a new method test_create_option_buttons_flipped. That leaves the line after isback() and I think the radiobutton test probably covers that anyway.

The attached file has a few other cosmetic changes, like 'self.searchengine' to 'self.engine'.

I would like to remove the duplicate testing in test_create_widgets. All we care for that test is that create_widgets calls the other four create methods. This could be done either by mocking the other methods (unittest.mock or custom replacement) or by looking to see that there is one entry, option button, other button, and command button.

Were you planning to do the check-label todos?

[terryjreedy]

For next edit -- docstring for class SearchDialogBase:

+    a row of standard radiobuttons (create_option_buttons);

This is wrong -- these are Checkbuttons

+    a row of dialog specific radiobuttons (create_other_buttons).

dialog-specific Radiobuttons

[philwebster]

Added tests for labels, a mock function for widget creation, a back option for radiobuttontests, and the docstring fixes that Terry mentioned.

[python-dev]

New changeset 752439a6bdd9 by Terry Jan Reedy in branch '2.7':
Issue bpo-18592: For idlelib.SearchDialogBase, edit and add docstrings,
http://hg.python.org/cpython/rev/752439a6bdd9

New changeset ed60a73e1c82 by Terry Jan Reedy in branch '3.4':
Issue bpo-18592: For idlelib.SearchDialogBase, edit and add docstrings,
http://hg.python.org/cpython/rev/ed60a73e1c82

[terryjreedy]

I am getting the ttk Themechanges warning. The test needs to use an search engine altered as with test_searchengine. I will work on that next.

[terryjreedy]

The warning was due to absence of def self.root. Attached is close to what will commit.

[python-dev]

New changeset 2b7a4cbed2a0 by Terry Jan Reedy in branch '2.7':
Issue bpo-18592: Add unittests for SearchDialogBase. Patch by Phil Webster.
http://hg.python.org/cpython/rev/2b7a4cbed2a0

New changeset a0e8f2d882a3 by Terry Jan Reedy in branch '3.4':
Issue bpo-18592: Add unittests for SearchDialogBase. Patch by Phil Webster.
http://hg.python.org/cpython/rev/a0e8f2d882a3