70d74e675f
- Rename project name and package: novelWriter -> UmbraEdit, novelwriter -> umbraedit - Rename entry script novelWriter.py -> UmbraEdit.py - Rename package directory novelwriter/ -> umbraedit/ - Rename i18n translation sources nw_*.ts -> ue_*.ts - Rename packaging files (appdata, project xml template) - Update all imports, references, docs, workflows, tests and build config - Update pyproject.toml project name, GUI script and URLs - Preserve full upstream git history; origin repointed below
325 lines
10 KiB
Python
325 lines
10 KiB
Python
"""
|
|
UmbraEdit - Shared Data Class Tests
|
|
=====================================
|
|
|
|
This file is a part of UmbraEdit.
|
|
|
|
Copyright (C) 2023 Veronica Berglyd Olsen and UmbraEdit contributors.
|
|
|
|
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 3 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 <https://www.gnu.org/licenses/>.
|
|
""" # noqa
|
|
|
|
from __future__ import annotations
|
|
|
|
import sys
|
|
|
|
from pathlib import Path
|
|
from unittest.mock import MagicMock
|
|
|
|
import pytest
|
|
|
|
from PyQt6.QtCore import QThreadPool, QUrl
|
|
from PyQt6.QtGui import QDesktopServices
|
|
from PyQt6.QtWidgets import QFileDialog, QWidget
|
|
from pytestqt.qtbot import QtBot
|
|
|
|
from umbraedit import CONFIG
|
|
from umbraedit.core.project import NWProject
|
|
from umbraedit.shared import SharedData, _GuiAlert
|
|
|
|
from tests.helpers import buildTestProject
|
|
from tests.mocked import MockGuiMain, MockTheme
|
|
|
|
|
|
@pytest.mark.base
|
|
def testSharedData_Init():
|
|
"""Test SharedData class initialisation."""
|
|
shared = SharedData()
|
|
|
|
# When not initialised, it should raise exceptions
|
|
with pytest.raises(RuntimeError):
|
|
_ = shared.mainGui
|
|
with pytest.raises(RuntimeError):
|
|
_ = shared.theme
|
|
with pytest.raises(RuntimeError):
|
|
_ = shared.project
|
|
with pytest.raises(RuntimeError):
|
|
_ = shared.spelling
|
|
|
|
# Create some mock objects
|
|
mockGui = MockGuiMain()
|
|
mockTheme = MockTheme()
|
|
assert mockGui is not mockTheme
|
|
|
|
# Properly initialise the class
|
|
shared.initTheme(mockTheme) # type: ignore
|
|
shared.initSharedData(mockGui) # type: ignore
|
|
|
|
assert shared.mainGui is mockGui
|
|
assert shared.theme is mockTheme
|
|
|
|
assert isinstance(shared.project, NWProject)
|
|
assert shared.hasProject is False
|
|
assert shared.projectIdleTime == 0.0
|
|
assert shared.projectLock is None
|
|
|
|
|
|
@pytest.mark.base
|
|
def testSharedData_Functions(monkeypatch: pytest.MonkeyPatch):
|
|
"""Test SharedData class functions."""
|
|
shared = SharedData()
|
|
|
|
# Open URL
|
|
with monkeypatch.context() as mp:
|
|
openUrl = MagicMock()
|
|
mp.setattr(QDesktopServices, "openUrl", openUrl)
|
|
shared.openWebsite("http://www.example.com")
|
|
assert openUrl.called is True
|
|
assert openUrl.call_args[0][0] == QUrl("http://www.example.com")
|
|
|
|
|
|
@pytest.mark.base
|
|
def testSharedData_Projects(monkeypatch: pytest.MonkeyPatch, caplog: pytest.LogCaptureFixture, fncPath: Path):
|
|
"""Test SharedData handling of projects."""
|
|
project = NWProject()
|
|
buildTestProject(project, fncPath)
|
|
project.closeProject(0.0) # Clears the lockfile
|
|
|
|
shared = SharedData()
|
|
assert shared._project is None
|
|
|
|
# Initialise the instance, should create an empty project
|
|
mockGui = MockGuiMain()
|
|
mockTheme = MockTheme()
|
|
shared.initTheme(mockTheme) # type: ignore
|
|
shared.initSharedData(mockGui) # type: ignore
|
|
assert isinstance(shared.project, NWProject)
|
|
assert shared.hasProject is False
|
|
|
|
# Load the test project
|
|
assert shared.openProject(fncPath) is True
|
|
assert shared.hasProject is True
|
|
|
|
# We cannot open two projects
|
|
caplog.clear()
|
|
assert shared.openProject(fncPath) is False
|
|
assert caplog.messages[-1] == "A project is already open"
|
|
assert shared._idleTime == 0.0
|
|
|
|
# Update idle time
|
|
refTime = shared._idleRefTime
|
|
shared.updateIdleTime(refTime + 1.0, False)
|
|
shared.updateIdleTime(refTime + 2.0, True)
|
|
shared.updateIdleTime(refTime + 3.0, False)
|
|
shared.updateIdleTime(refTime + 4.0, True)
|
|
assert round(shared.projectIdleTime) == 2
|
|
|
|
# Save project
|
|
assert shared.saveProject() is True
|
|
|
|
# Close project
|
|
shared.closeProject()
|
|
assert shared.hasProject is False
|
|
|
|
# Cannot save a project after it's been closed
|
|
assert shared.saveProject() is False
|
|
|
|
# Check locked project info
|
|
project.openProject(fncPath) # First open with our independent project instance
|
|
assert shared.hasProject is False
|
|
assert shared.projectLock is None
|
|
assert shared.openProject(fncPath) is False # Then with our shared instance
|
|
assert shared.hasProject is False
|
|
assert isinstance(shared.projectLock, list)
|
|
|
|
# Test browsing for projects
|
|
with monkeypatch.context() as mp:
|
|
mp.setattr(QFileDialog, "getOpenFileName", lambda *a, **k: (a[2], ""))
|
|
assert shared.getProjectPath(QWidget(), fncPath, allowZip=True) == fncPath
|
|
|
|
|
|
@pytest.mark.base
|
|
def testSharedData_EdgeCases(qtbot: QtBot, monkeypatch: pytest.MonkeyPatch, mockGUI: MockGuiMain):
|
|
"""Test defensive branches in SharedData not covered by the other
|
|
functional tests: spell check no-ops, progress bar and thread pool
|
|
calls with no GUI, and a signal proxy for a stale project.
|
|
"""
|
|
monkeypatch.setattr(CONFIG, "spellLanguage", None)
|
|
|
|
shared = SharedData()
|
|
mockGui = MockGuiMain()
|
|
mockTheme = MockTheme()
|
|
shared.initTheme(mockTheme) # type: ignore
|
|
shared.initSharedData(mockGui) # type: ignore
|
|
|
|
# No project open: saving the editor is a no-op
|
|
assert shared.hasProject is False
|
|
shared.saveEditor()
|
|
assert mockGui.docEditor.saveText.called is False
|
|
|
|
# No requested spell check language yet: nothing to report
|
|
assert shared.spelling.requestedLanguage is None
|
|
shared.reportSpellCheckStatus() # Should not raise or warn
|
|
|
|
# The same (unset) language, with no reload requested, is a no-op
|
|
with qtbot.assertNotEmitted(shared.spellLanguageChanged, wait=100):
|
|
shared.updateSpellCheckLanguage()
|
|
|
|
# No GUI instance: progress bar helpers do nothing
|
|
shared._gui = None
|
|
shared.initMainProgress(10)
|
|
shared.incMainProgress()
|
|
shared.clearMainProgress()
|
|
|
|
# No thread pool available: nothing is queued
|
|
with monkeypatch.context() as mp:
|
|
mp.setattr(QThreadPool, "globalInstance", lambda *a: None)
|
|
shared.runInThreadPool(MagicMock())
|
|
|
|
# A signal proxy call for a project that isn't the active one is ignored
|
|
shared._gui = mockGui # type: ignore
|
|
otherProject = NWProject()
|
|
otherProject.data.setUuid("00000000-0000-0000-0000-000000000000")
|
|
with qtbot.assertNotEmitted(shared.statusLabelsChanged, wait=100):
|
|
shared.emitStatusLabelsChanged(otherProject, "s")
|
|
|
|
|
|
@pytest.mark.base
|
|
def testSharedData_Alerts(
|
|
qtbot: QtBot,
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
caplog: pytest.LogCaptureFixture,
|
|
mockGUI: MockGuiMain,
|
|
):
|
|
"""Test SharedData class alert helper functions."""
|
|
monkeypatch.setattr(_GuiAlert, "exec", lambda *a: None)
|
|
monkeypatch.setattr(_GuiAlert, "finalState", True)
|
|
|
|
shared = SharedData()
|
|
|
|
mockGui = MockGuiMain()
|
|
mockTheme = MockTheme()
|
|
shared.initTheme(mockTheme) # type: ignore
|
|
shared.initSharedData(mockGui) # type: ignore
|
|
|
|
assert shared.lastAlert == []
|
|
|
|
# Info box
|
|
caplog.clear()
|
|
shared.info("Hello World", info="foo", details="bar")
|
|
assert shared.lastAlert == ["Hello World", "foo", "bar"]
|
|
assert caplog.text.strip().startswith("INFO")
|
|
assert caplog.text.strip().endswith("bar")
|
|
|
|
# Warning box
|
|
caplog.clear()
|
|
shared.warn("Oops!", info="foo", details="bar")
|
|
assert shared.lastAlert == ["Oops!", "foo", "bar"]
|
|
assert caplog.text.strip().startswith("WARNING")
|
|
assert caplog.text.strip().endswith("bar")
|
|
|
|
# Warning box, not logged
|
|
caplog.clear()
|
|
shared.warn("Oops!", info="foo", details="bar", log=False)
|
|
assert shared.lastAlert == ["Oops!", "foo", "bar"]
|
|
assert caplog.text == ""
|
|
|
|
# Error box
|
|
caplog.clear()
|
|
shared.error("Oh noes!", info="foo", details="bar")
|
|
assert shared.lastAlert == ["Oh noes!", "foo", "bar"]
|
|
assert caplog.text.strip().startswith("ERROR")
|
|
assert caplog.text.strip().endswith("bar")
|
|
|
|
# Error box, not logged
|
|
caplog.clear()
|
|
shared.error("Oh noes!", info="foo", details="bar", log=False)
|
|
assert shared.lastAlert == ["Oh noes!", "foo", "bar"]
|
|
assert caplog.text == ""
|
|
|
|
# Error box with exception
|
|
caplog.clear()
|
|
shared.error("Oh noes!", info="foo", details="bar", exc=Exception("Boom!"))
|
|
assert shared.lastAlert == ["Oh noes!", "foo", "bar"]
|
|
assert caplog.text.strip().startswith("ERROR")
|
|
assert caplog.text.strip().endswith("bar")
|
|
|
|
# Question box
|
|
assert shared.question("Why?") is True
|
|
assert shared.lastAlert == ["Why?"]
|
|
|
|
|
|
@pytest.mark.base
|
|
def testSharedData_GuiAlert():
|
|
"""Test the _GuiAlert class."""
|
|
alert = _GuiAlert(None, MockTheme()) # type: ignore
|
|
|
|
# Default states
|
|
assert alert.logMessage == []
|
|
assert alert.finalState is False
|
|
|
|
# Populate message
|
|
text = "one"
|
|
info = "two"
|
|
details = "three"
|
|
alert.setMessage(text, info, details)
|
|
assert alert.logMessage == [text, info, details]
|
|
assert alert.text() == text
|
|
assert alert.informativeText() == info
|
|
assert alert.detailedText() == details
|
|
|
|
# Populate exception
|
|
exc = Exception("oops")
|
|
alert.setException(exc)
|
|
assert alert.logMessage == [text, info, details]
|
|
assert alert.informativeText() == f"{info}<br><b>Exception</b>: {exc!s}"
|
|
|
|
# Alert: Info
|
|
alert.setAlertType(_GuiAlert.INFO, False)
|
|
assert hasattr(alert, "_btnOk")
|
|
if sys.platform != "darwin": # Not set on MacOS
|
|
assert alert.windowTitle() == "Information"
|
|
alert._btnOk.click()
|
|
assert alert.finalState is True
|
|
alert._state = False
|
|
|
|
# Alert: Warning
|
|
alert.setAlertType(_GuiAlert.WARN, False)
|
|
assert hasattr(alert, "_btnOk")
|
|
if sys.platform != "darwin": # Not set on MacOS
|
|
assert alert.windowTitle() == "Warning"
|
|
alert._btnOk.click()
|
|
assert alert.finalState is True
|
|
alert._state = False
|
|
|
|
# Alert: Error
|
|
alert.setAlertType(_GuiAlert.ERROR, False)
|
|
assert hasattr(alert, "_btnOk")
|
|
if sys.platform != "darwin": # Not set on MacOS
|
|
assert alert.windowTitle() == "Error"
|
|
alert._btnOk.click()
|
|
assert alert.finalState is True
|
|
alert._state = False
|
|
|
|
# Alert: Question
|
|
alert.setAlertType(_GuiAlert.ASK, True)
|
|
assert hasattr(alert, "_btnYes")
|
|
assert hasattr(alert, "_btnNo")
|
|
if sys.platform != "darwin": # Not set on MacOS
|
|
assert alert.windowTitle() == "Question"
|
|
alert._btnYes.click()
|
|
assert alert.finalState is True
|
|
alert._btnNo.click()
|
|
assert alert.finalState is False
|