Add test coverage of shared class

tests/test_base/test_base_shared.py

@@ -0,0 +1,187 @@
+"""
+novelWriter – SharedData Class Tester
+=====================================
+
+This file is a part of novelWriter
+Copyright 2018–2023, Veronica Berglyd Olsen
+
+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/>.
+"""
+
+import pytest
+
+from mocked import MockGuiMain, MockTheme
+
+from PyQt5.QtWidgets import QMessageBox
+
+from novelwriter.core.project import NWProject
+from novelwriter.shared import SharedData, _GuiAlert
+from tests.tools import buildTestProject
+
+
+@pytest.mark.base
+def testBaseSharedData_Init():
+    """Test SharedData class initialisation."""
+    shared = SharedData()
+
+    # When not initialised, it should raise exceptions
+    with pytest.raises(Exception):
+        shared.mainGui
+    with pytest.raises(Exception):
+        shared.theme
+    with pytest.raises(Exception):
+        shared.project
+
+    # Create some mock objects
+    mockGui = MockGuiMain()
+    mockTheme = MockTheme()
+    assert mockGui is not mockTheme
+
+    # Properly initialise the class
+    shared.initSharedData(mockGui, mockTheme)  # 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
+
+    assert shared.alert is None
+
+# END Test testBaseSharedData_Init
+
+
+@pytest.mark.base
+def testBaseSharedData_Projects(fncPath, caplog: pytest.LogCaptureFixture):
+    """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.initSharedData(mockGui, mockTheme)  # 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 out shared instance
+    assert shared.hasProject is False
+    assert isinstance(shared.projectLock, list)
+
+# END Test testBaseSharedData_Projects
+
+
+@pytest.mark.base
+def testBaseSharedData_Alerts(monkeypatch, caplog: pytest.LogCaptureFixture):
+    """Test SharedData class alert helper functions."""
+    monkeypatch.setattr(QMessageBox, "exec_", lambda *a: None)
+    monkeypatch.setattr(QMessageBox, "result", lambda *a: QMessageBox.Yes)
+
+    shared = SharedData()
+
+    mockGui = MockGuiMain()
+    mockTheme = MockTheme()
+    shared.initSharedData(mockGui, mockTheme)  # type: ignore
+
+    assert shared.alert is None
+
+    # Info box
+    caplog.clear()
+    shared.info("Hello World", info="foo", details="bar")
+    assert isinstance(shared.alert, _GuiAlert)
+    assert shared.alert.text() == "Hello World"
+    assert shared.alert.informativeText() == "foo"
+    assert shared.alert.detailedText() == "bar"
+    assert caplog.text.strip().startswith("INFO")
+    assert caplog.text.strip().endswith("Hello World foo bar")
+    shared._alert = None
+
+    # Warning box
+    caplog.clear()
+    shared.warn("Oops!", info="foo", details="bar")
+    assert isinstance(shared.alert, _GuiAlert)
+    assert shared.alert.text() == "Oops!"
+    assert shared.alert.informativeText() == "foo"
+    assert shared.alert.detailedText() == "bar"
+    assert caplog.text.strip().startswith("WARNING")
+    assert caplog.text.strip().endswith("Oops! foo bar")
+    shared._alert = None
+
+    # Error box
+    caplog.clear()
+    shared.error("Oh noes!", info="foo", details="bar")
+    assert isinstance(shared.alert, _GuiAlert)
+    assert shared.alert.text() == "Oh noes!"
+    assert shared.alert.informativeText() == "foo"
+    assert shared.alert.detailedText() == "bar"
+    assert caplog.text.strip().startswith("ERROR")
+    assert caplog.text.strip().endswith("Oh noes! foo bar")
+    shared._alert = None
+
+    # Error box with exception
+    caplog.clear()
+    shared.error("Oh noes!", info="foo", details="bar", exc=Exception("Boom!"))
+    assert isinstance(shared.alert, _GuiAlert)
+    assert shared.alert.text() == "Oh noes!"
+    assert shared.alert.informativeText() == "foo<br><b>Exception</b>: Boom!"
+    assert shared.alert.detailedText() == "bar"
+    assert caplog.text.strip().startswith("ERROR")
+    assert caplog.text.strip().endswith("Oh noes! foo bar")
+    shared._alert = None
+
+    # Question box
+    assert shared.question("Why?") is True
+    assert isinstance(shared.alert, _GuiAlert)
+    assert shared.alert.text() == "Why?"
+    shared._alert = None
+
+# END Test testBaseSharedData_Alerts