File: test_window.py

package info (click to toggle)
retext 8.1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,780 kB
  • sloc: python: 5,363; xml: 149; makefile: 20; sh: 8
file content (505 lines) | stat: -rw-r--r-- 19,553 bytes parent folder | download
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
# vim: ts=4:sw=4:expandtab

# This file is part of ReText
# Copyright: 2016 Maurice van der Pot
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import os
import platform
import sys
import tempfile
import unittest
import warnings
from contextlib import suppress
from unittest.mock import MagicMock, patch

import markups
from markups.abstract import ConvertedMarkup
from PyQt6.QtCore import QObject, Qt, pyqtSignal
from PyQt6.QtGui import QTextCursor
from PyQt6.QtTest import QTest
from PyQt6.QtWidgets import QApplication, QMessageBox

import ReText
from ReText.window import ReTextWindow

path_to_testdata = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'testdata')

QApplication.setAttribute(Qt.ApplicationAttribute.AA_ShareOpenGLContexts)
app = QApplication.instance() or QApplication(sys.argv)

def handle_timer_event():
    print('timer event received')


class FakeConverterProcess(QObject):
    conversionDone = pyqtSignal()

    def start_conversion(self, name, filename, extensions, text, current_dir):
        self.conversionDone.emit()

    def get_result(self):
        return ConvertedMarkup('')

@patch('ReText.tab.converterprocess.ConverterProcess', FakeConverterProcess)
class TestWindow(unittest.TestCase):

    def setUp(self):
        warnings.simplefilter("ignore", Warning)
        self.readListFromSettingsMock = patch('ReText.readListFromSettings', return_value=[]).start()
        self.writeListToSettingsMock = patch('ReText.writeListToSettings').start()
        self.globalSettingsMock = patch(
            'ReText.window.globalSettings',
            MagicMock(**ReText.configOptions),
        ).start()
        self.globalCacheMock = patch(
            'ReText.window.globalCache',
            MagicMock(**ReText.cacheOptions),
        ).start()
        self.fileSystemWatcherPatcher = patch('ReText.window.QFileSystemWatcher')
        self.fileSystemWatcherMock = self.fileSystemWatcherPatcher.start()
        ReText.tab.globalSettings = self.globalSettingsMock

    def tearDown(self):
        patch.stopall()


    #
    # Helper functions
    #

    @staticmethod
    def get_ui_enabled_states(window):
        enabled = set()
        disabled = set()

        for item in ('actionBold',
                     'actionCopy',
                     'actionCut',
                     'actionItalic',
                     'actionUnderline',
                     'actionUndo',
                     'actionRedo',
                     'actionReload',
                     'actionSave',
                     'actionSetEncoding',
                     'editBar',
                     'formattingBox',
                     'symbolBox'):
            if getattr(window, item).isEnabled():
                enabled.add(item)
            else:
                disabled.add(item)

        return enabled, disabled

    def check_widget_state(self, window, expected_enabled, expected_disabled):
        actually_enabled, actually_disabled = self.get_ui_enabled_states(window)

        self.assertEqual(
            expected_enabled - actually_enabled,
            set(),
            'These widgets are unexpectedly disabled',
        )
        self.assertEqual(
            expected_disabled - actually_disabled,
            set(),
            'These widgets are unexpectedly enabled',
        )

    def check_widgets_enabled_for_markdown(self, window):
        self.check_widget_state(
            window,
            {'actionBold', 'actionItalic', 'actionUnderline', 'formattingBox', 'symbolBox'},
            set(),
        )

    def check_widgets_enabled_for_restructuredtext(self, window):
        self.check_widget_state(
            window,
            {'actionBold', 'actionItalic'},
            {'actionUnderline', 'formattingBox', 'symbolBox'},
        )

    def check_widgets_enabled(self, window, widgets):
        self.check_widget_state(window, set(widgets), set())

    def check_widgets_disabled(self, window, widgets):
        self.check_widget_state(window, set(), set(widgets))


    #
    # Tests
    #

    def test_windowTitleAndTabs_afterStartWithEmptyTab(self):
        self.window = ReTextWindow()
        self.window.createNew('')
        app.processEvents()

        self.assertEqual(1, self.window.tabWidget.count())
        self.assertEqual('New document[*]', self.window.windowTitle())
        self.assertFalse(self.window.currentTab.fileName)

    @patch(
        'ReText.window.QFileDialog.getOpenFileNames',
        return_value=([os.path.join(path_to_testdata, 'existing_file.md')], None),
    )
    def test_windowTitleAndTabs_afterLoadingFile(self, getOpenFileNamesMock):
        self.window = ReTextWindow()
        self.window.createNew('')
        self.window.actionOpen.trigger()
        app.processEvents()

        # Check that file is opened in the existing empty tab
        self.assertEqual(1, self.window.tabWidget.count())
        self.assertEqual('existing_file.md[*]', self.window.windowTitle())
        self.assertTrue(self.window.currentTab.fileName.endswith('tests/testdata/existing_file.md'))
        self.assertEqual(self.window.tabWidget.tabText(0), 'existing_file')
        self.assertFalse(self.window.isWindowModified())

    @patch(
        'ReText.window.QFileDialog.getOpenFileNames',
        return_value=([os.path.join(path_to_testdata, 'existing_file.md')], None),
    )
    def test_windowTitleAndTabs_afterSwitchingTab(self, getOpenFileNamesMock):
        self.window = ReTextWindow()
        self.window.createNew('')
        self.window.actionOpen.trigger()
        app.processEvents()

        tab_with_file = self.window.currentTab

        self.window.createNew('bla')
        app.processEvents()

        tab_with_unsaved_content = self.window.currentTab

        self.assertEqual('New document[*]', self.window.windowTitle())
        self.assertIs(self.window.currentTab, tab_with_unsaved_content)
        self.assertIs(self.window.tabWidget.currentWidget(), tab_with_unsaved_content)
        self.assertEqual(self.window.ind, 1)
        self.assertEqual(self.window.tabWidget.tabText(0), 'existing_file')
        self.assertEqual(self.window.tabWidget.tabText(1), 'New document*')

        self.window.switchTab()
        app.processEvents()

        self.assertEqual('existing_file.md[*]', self.window.windowTitle())
        self.assertIs(self.window.currentTab, tab_with_file)
        self.assertIs(self.window.tabWidget.currentWidget(), tab_with_file)

    @patch(
        'ReText.window.QFileDialog.getOpenFileNames',
        return_value=([os.path.join(path_to_testdata, 'existing_file.md')], None),
    )
    def test_activeTab_afterLoadingFileThatIsAlreadyOpenInOtherTab(self, getOpenFileNamesMock):
        self.window = ReTextWindow()
        self.window.createNew('')
        self.window.actionOpen.trigger()
        app.processEvents()
        tab_with_file = self.window.currentTab

        self.window.createNew('')
        app.processEvents()

        # Make sure that the newly created tab is the active one
        self.assertFalse(self.window.currentTab.fileName)

        # Load the same document again
        self.window.actionOpen.trigger()
        app.processEvents()

        # Check that we have indeed been switched back to the previous tab
        self.assertIs(self.window.currentTab, tab_with_file)
        self.assertTrue(self.window.currentTab.fileName.endswith('tests/testdata/existing_file.md'))

    def test_markupDependentWidgetStates_afterStartWithEmptyTabAndMarkdownAsDefaultMarkup(self):
        self.window = ReTextWindow()
        self.window.createNew('')
        app.processEvents()

        # markdown is the default markup
        self.check_widgets_enabled_for_markdown(self.window)

    def test_markupDependentWidgetStates_afterStartWithEmptyTabAndRestructuredtextAsDefaultMarkup(self):
        self.globalSettingsMock.defaultMarkup = 'reStructuredText'
        self.window = ReTextWindow()
        self.window.createNew('')
        app.processEvents()

        self.check_widgets_enabled_for_restructuredtext(self.window)

    def test_markupDependentWidgetStates_afterChangingDefaultMarkup(self):
        self.window = ReTextWindow()
        self.window.createNew('')
        app.processEvents()

        self.window.setDefaultMarkup(markups.ReStructuredTextMarkup)

        self.check_widgets_enabled_for_restructuredtext(self.window)

    @patch(
        'ReText.window.QFileDialog.getOpenFileNames',
        return_value=([os.path.join(path_to_testdata, 'existing_file.md')], None),
    )
    def test_markupDependentWidgetStates_afterLoadingMarkdownDocument(self, getOpenFileNamesMock):
        self.window = ReTextWindow()
        self.window.createNew('')
        self.window.actionOpen.trigger()
        app.processEvents()

        self.check_widgets_enabled_for_markdown(self.window)

    @patch(
        'ReText.window.QFileDialog.getOpenFileNames',
        return_value=([os.path.join(path_to_testdata, 'existing_file.rst')], None),
    )
    def test_markupDependentWidgetStates_afterLoadingRestructuredtextDocument(
        self,
        getOpenFileNamesMock,
    ):
        self.window = ReTextWindow()
        self.window.createNew('')
        self.window.actionOpen.trigger()
        app.processEvents()

        self.check_widgets_enabled_for_restructuredtext(self.window)

    @patch(
        'ReText.window.QFileDialog.getOpenFileNames',
        side_effect=[
            ([os.path.join(path_to_testdata, 'existing_file.md')], None),
            ([os.path.join(path_to_testdata, 'existing_file.rst')], None),
        ],
    )
    def test_markupDependentWidgetStates_afterSwitchingTab(self, getOpenFileNamesMock):
        self.window = ReTextWindow()
        self.window.createNew('')
        self.window.actionOpen.trigger()
        self.window.actionOpen.trigger()
        app.processEvents()

        # Just to make sure that sending two actionOpen triggers has had the desired effect
        self.assertIn('.rst', self.window.windowTitle())

        self.window.switchTab()
        app.processEvents()

        self.assertIn('.md', self.window.windowTitle())
        self.check_widgets_enabled_for_markdown(self.window)

    @patch(
        'ReText.window.QFileDialog.getOpenFileNames',
        return_value=([os.path.join(path_to_testdata, 'existing_file.md')], None),
    )
    @patch(
        'ReText.window.QFileDialog.getSaveFileName',
        return_value=(os.path.join(path_to_testdata, 'not_existing_file.rst'), None),
    )
    def test_markupDependentWidgetStates_afterSavingDocumentAsDifferentMarkup(
        self,
        getSaveFileNameMock,
        getOpenFileNamesMock,
    ):
        self.window = ReTextWindow()
        self.window.createNew('')
        self.window.actionOpen.trigger()
        app.processEvents()

        try:
            self.window.actionSaveAs.trigger()
            app.processEvents()

        finally:
            os.remove(os.path.join(path_to_testdata, 'not_existing_file.rst'))

        self.check_widgets_enabled_for_restructuredtext(self.window)

    @patch(
        'ReText.window.QFileDialog.getOpenFileNames',
        return_value=([os.path.join(path_to_testdata, 'existing_file.md')], None),
    )
    @patch(
        'ReText.window.QFileDialog.getSaveFileName',
        return_value=(os.path.join(path_to_testdata, 'not_existing_file.md'), None),
    )
    def test_saveWidgetStates(self, getSaveFileNameMock, getOpenFileNamesMock):
        self.window = ReTextWindow()

        # check if save is disabled at first
        self.window.createNew('')
        app.processEvents()
        self.check_widgets_disabled(self.window, ('actionSave',))
        self.assertFalse(self.window.isWindowModified())
        self.assertEqual(self.window.tabWidget.tabText(0), 'New document')

        # check if it's enabled after inserting some text
        self.window.currentTab.editBox.textCursor().insertText('some text')
        app.processEvents()
        self.check_widgets_enabled(self.window, ('actionSave',))
        self.assertTrue(self.window.isWindowModified())
        self.assertEqual(self.window.tabWidget.tabText(0), 'New document*')

        # check if it's disabled again after loading a file in a second tab and switching to it
        self.window.actionOpen.trigger()
        app.processEvents()
        self.check_widgets_disabled(self.window, ('actionSave',))
        self.assertFalse(self.window.isWindowModified())
        self.assertEqual(self.window.tabWidget.tabText(0), 'New document*')
        self.assertEqual(self.window.tabWidget.tabText(1), 'existing_file')

        # check if it's enabled again after switching back
        self.window.switchTab()
        app.processEvents()
        self.check_widgets_enabled(self.window, ('actionSave',))
        self.assertTrue(self.window.isWindowModified())
        self.assertEqual(self.window.tabWidget.tabText(0), 'New document*')
        self.assertEqual(self.window.tabWidget.tabText(1), 'existing_file')

        # check if it's disabled after saving
        try:
            self.window.actionSaveAs.trigger()
            app.processEvents()
            self.check_widgets_disabled(self.window, ('actionSave',))
            self.assertFalse(self.window.isWindowModified())
            self.assertEqual(self.window.tabWidget.tabText(0), 'not_existing_file')
            self.assertEqual(self.window.tabWidget.tabText(1), 'existing_file')
        finally:
            os.remove(os.path.join(path_to_testdata, 'not_existing_file.md'))

    @patch(
        'ReText.window.QFileDialog.getOpenFileNames',
        return_value=([os.path.join(path_to_testdata, 'existing_file.md')], None),
    )
    def test_encodingAndReloadWidgetStates(self, getOpenFileNamesMock):
        self.window = ReTextWindow()

        # check if reload/set encoding is disabled for a tab without filename set
        self.window.createNew('')
        app.processEvents()
        self.check_widgets_disabled(self.window, ('actionReload','actionSetEncoding'))

        self.window.actionOpen.trigger()
        app.processEvents()
        self.check_widgets_enabled(self.window, ('actionReload','actionSetEncoding'))

    @patch(
        'ReText.window.QFileDialog.getOpenFileNames',
        return_value=([os.path.join(path_to_testdata, 'existing_file.md')], None),
    )
    def test_encodingAndReloadWidgetStates_alwaysDisabledWhenAutosaveEnabled(self, getOpenFileNamesMock):
        self.globalSettingsMock.autoSave = True
        self.window = ReTextWindow()

        # check if reload/set encoding is disabled for a tab without filename set
        self.window.createNew('')
        app.processEvents()
        self.check_widgets_disabled(self.window, ('actionReload','actionSetEncoding'))

        self.window.actionOpen.trigger()
        app.processEvents()
        self.check_widgets_disabled(self.window, ('actionReload','actionSetEncoding'))

    def test_doesNotTweakSpecialCharacters(self):
        fileName = tempfile.mkstemp(suffix='.mkd')[1]
        content = 'Non-breaking\u00a0space\n\nLine\u2028separator\n'
        with open(fileName, 'w', encoding='utf-8') as tempFile:
            tempFile.write(content)
        window = ReTextWindow()
        window.openFileWrapper(fileName)
        self.assertTrue(window.saveFile())
        with open(fileName, encoding='utf-8') as tempFile:
            self.assertMultiLineEqual(content, tempFile.read())
        with suppress(PermissionError):
            os.remove(fileName)

    def test_autoSave(self):
        self.globalSettingsMock.autoSave = True
        window = ReTextWindow()
        window.autoSaveTimer.start(250)
        fileName = tempfile.mkstemp(suffix='.mkd')[1]
        with open(fileName, 'w', encoding='utf-8') as tempFile:
            tempFile.write('first content')
        window.openFileWrapper(fileName)

        cursor = window.currentTab.editBox.textCursor()
        cursor.select(QTextCursor.SelectionType.Document)
        cursor.insertText('second content')
        QTest.qWait(300)  # more than the timer interval
        with open(fileName, encoding='utf-8') as tempFile:
            self.assertEqual(tempFile.read(), 'second content')

        window.closeTab(0)
        with suppress(PermissionError):
            os.remove(fileName)

    @unittest.skipIf(platform.system() == 'Windows', 'QFileSystemWatcher does not work reliably')
    @patch('ReText.window.QMessageBox.exec', return_value=None)
    def test_reloadFileNotModified(self, messageBoxExecMock):
        self.fileSystemWatcherPatcher.stop()
        window = ReTextWindow()
        fileName = tempfile.mkstemp(suffix='.mkd')[1]
        with open(fileName, 'w', encoding='utf-8') as tempFile:
            tempFile.write('first content')
        window.openFileWrapper(fileName)
        self.assertEqual(window.fileSystemWatcher.files(), [fileName.replace('\\', '/')])
        editBox = window.currentTab.editBox
        self.assertEqual(editBox.toPlainText(), 'first content')
        self.assertFalse(editBox.document().isModified())
        app.processEvents()

        with open(fileName, 'w', encoding='utf-8') as tempFile:
            tempFile.write('modified externally')
        QTest.qWait(100)
        self.assertEqual(editBox.toPlainText(), 'modified externally')
        self.assertFalse(window.currentTab.forceDisableAutoSave)

        window.closeTab(0)
        self.assertEqual(window.fileSystemWatcher.files(), [])
        with suppress(PermissionError):
            os.remove(fileName)

    @unittest.skipIf(platform.system() == 'Windows', 'QFileSystemWatcher does not work reliably')
    @patch('ReText.window.QMessageBox.warning', return_value=QMessageBox.StandardButton.Discard)
    @patch('ReText.window.QMessageBox.exec', return_value=None)
    def test_reloadFileModified(self, messageBoxExecMock, messageBoxWarningMock):
        self.fileSystemWatcherPatcher.stop()
        window = ReTextWindow()
        fileName = tempfile.mkstemp(suffix='.mkd')[1]
        with open(fileName, 'w', encoding='utf-8') as tempFile:
            tempFile.write('first content')
        window.openFileWrapper(fileName)
        self.assertEqual(window.fileSystemWatcher.files(), [fileName.replace('\\', '/')])
        editBox = window.currentTab.editBox
        self.assertEqual(editBox.toPlainText(), 'first content')

        editBox.textCursor().insertText('modified ')
        app.processEvents()
        self.assertTrue(editBox.document().isModified())

        with open(fileName, 'w', encoding='utf-8') as tempFile:
            tempFile.write('modified externally')
        QTest.qWait(100)
        self.assertEqual(editBox.toPlainText(), 'modified first content')
        self.assertTrue(window.currentTab.forceDisableAutoSave)

        window.closeTab(0)
        self.assertEqual(window.fileSystemWatcher.files(), [])
        with suppress(PermissionError):
            os.remove(fileName)

if __name__ == '__main__':
    unittest.main()