classification
Title: Idle unittests: make gui, mock switching easier.
Type: enhancement Stage: needs patch
Components: IDLE Versions: Python 3.8, Python 3.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: terry.reedy Nosy List: Saimadhav.Heblikar, markroseman, terry.reedy
Priority: normal Keywords:

Created on 2014-06-03 05:58 by terry.reedy, last changed 2019-03-20 16:52 by terry.reedy.

Messages (3)
msg219663 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2014-06-03 05:58
Idle unittests that use tkinter.Text are developed using the gui widget and then switched, to the current extent possible, to mock_tk.Text. I have done this previously by commenting out gui lines and adding new lines, so it would be possible to switch back if needed. test_searchengine is an example. However, switching back would require commenting and uncommenting several lines.

When reviewing test_autoexpand #18292, I realized that everything after the imports

from tkinter import Text
from idlelib.idle_text.mock_tk import Text

can be made conditional on 'tkinter in str(Text)'. The only comment switching needed is for the import lines. This issue is about retrofitting test_searchengine and any other files that need it.
msg219870 - (view) Author: Saimadhav Heblikar (Saimadhav.Heblikar) * Date: 2014-06-06 10:52
Perhaps, we can move GUI/non GUI code into blocks. I will take Text as example. 

from test import support
if support._is_gui_available():
   from tkinter import Text
else:
   from idlelib.idle_test.mock_tk import Text
.
.
.
if not support._is_gui_available():
    parts of test which can be run keeping in mind mock.Text's      limitations.
else:
    everything, using tkinter.Text



Only drawback is _is_gui_available is not documented publicly. Also, we'd will have lot of if...else blocks all over the place. Avoiding code duplication will be tricky.
If nothing else, the if...else block can be used at the import level only.
msg219905 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2014-06-07 00:38
Tests that need at most tkinter Variables and message boxes run without gui since those are easy to mock and we want to set and retrieve values on MBox. Tests of displayed widgets other than Text are gui tests (unless we were to developed a substantial tk mock, which is beyond current plans). So the present issue is limited to test functions that involve Text and nothing else visible.

Having tried it, I prefer if-(and sometimes)-else blocks to commented out code. I dislike the latter in idle files: did someone just forget to remove it? If not, why is it there?  So I think your idea of completely switching to conditional code is a good idea. 

We must not directly switch on _is_gui_available(). If a system running tests under test, which means under test.regrtest, does not request 'gui', the gui tests should not run even if they could be. Try "python -m test -v test_idle" and you will see (at the moment) 67 OK and many skips, versus 110 ok and no skips with 'python -m test.text_idle'.

I think this should work:

import unicode
from test.support import requires
try:
    requires('gui')
    from tkinter import Tk, Text
    running_gui = True
except unicode.SkipTest:
    from idlelib.idle_test.mock_tk import Text
    running_gui = False

running_gui would then be used for conditional expressions. I believe we could wrap the above, modified, in a function, such as mock_tk.get_text.

def get_text(gui_ok=True):
    if gui_ok:
        import unicode
        from test.support import requires
        try:
            requires('gui')
            from tkinter import Text
            return Text, True
        except unicode.SkipTest:
            pass
   # else gui not ok or not available
   return Text, False

and use it as follows in a test_file.

from idlelib.idle_test.mock_tk import get_text # and anything else
Text, running_gui = get_text()  # (0), temporarily, to force non-gui 

This needs to be tested. Tests would be committed without 0, though forgetting to remove it would not be tragic.

Running a non-gui test on all buildbots is considered better than a gui test on a few. After thinking about your idea, I believe gui when possible, non-gui otherwise is even better. Should get_text work, but it be decided that all non-gui is better, the sense of the get_text parameter could be flipped to change all tests at once.
History
Date User Action Args
2019-03-20 16:52:08terry.reedysetassignee: terry.reedy
components: + IDLE
versions: + Python 3.7, Python 3.8, - Python 2.7, Python 3.4, Python 3.5
2015-09-18 16:38:27markrosemansetnosy: + markroseman
2014-06-07 00:38:07terry.reedysetmessages: + msg219905
2014-06-06 10:52:28Saimadhav.Heblikarsetmessages: + msg219870
2014-06-03 05:58:40terry.reedycreate