Veronica Berglyd Olsen
293 lines
11 KiB
Python
293 lines
11 KiB
Python
"""
|
||
novelWriter – Build Dialog Class Tester
|
||
=======================================
|
||
|
||
This file is a part of novelWriter
|
||
Copyright 2018–2021, 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
|
||
import os
|
||
|
||
from shutil import copyfile
|
||
from tools import cmpFiles, getGuiItem
|
||
|
||
from PyQt5.QtCore import Qt
|
||
from PyQt5.QtWidgets import QAction, QMessageBox, QFileDialog
|
||
|
||
from nw.tools import GuiBuildNovel
|
||
|
||
keyDelay = 2
|
||
typeDelay = 1
|
||
stepDelay = 20
|
||
|
||
|
||
@pytest.mark.gui
|
||
def testToolBuild_Main(qtbot, monkeypatch, nwGUI, nwLipsum, refDir, outDir):
|
||
"""Test the build tool.
|
||
"""
|
||
# Block message box
|
||
monkeypatch.setattr(QMessageBox, "question", lambda *a: QMessageBox.Yes)
|
||
monkeypatch.setattr(QMessageBox, "information", lambda *a: QMessageBox.Yes)
|
||
monkeypatch.setattr(QFileDialog, "getSaveFileName", lambda a, b, c, **k: (c, None))
|
||
|
||
# Check that we cannot open when there is no project
|
||
nwGUI.mainMenu.aBuildProject.activate(QAction.Trigger)
|
||
assert getGuiItem("GuiBuildNovel") is None
|
||
|
||
# Open a project
|
||
assert nwGUI.openProject(nwLipsum)
|
||
|
||
# Open the tool
|
||
nwGUI.mainMenu.aBuildProject.activate(QAction.Trigger)
|
||
qtbot.waitUntil(lambda: getGuiItem("GuiBuildNovel") is not None, timeout=1000)
|
||
|
||
nwBuild = getGuiItem("GuiBuildNovel")
|
||
assert isinstance(nwBuild, GuiBuildNovel)
|
||
|
||
nwBuild.textFont.setText("DejaVu Sans")
|
||
nwBuild.textSize.setValue(11)
|
||
|
||
# Test Save
|
||
# =========
|
||
|
||
# Invalid file format
|
||
assert not nwBuild._saveDocument(-1)
|
||
|
||
# Non-existent path
|
||
with monkeypatch.context() as mp:
|
||
mp.setattr("os.path.expanduser", lambda *a, **k: nwLipsum)
|
||
assert nwGUI.mainConf.lastPath != nwLipsum
|
||
nwGUI.mainConf.lastPath = "no_such_path"
|
||
assert nwBuild._saveDocument(nwBuild.FMT_NWD)
|
||
assert nwGUI.mainConf.lastPath == nwLipsum
|
||
|
||
# No path selected
|
||
with monkeypatch.context() as mp:
|
||
mp.setattr(QFileDialog, "getSaveFileName", lambda *a, **k: ("", ""))
|
||
assert not nwBuild._saveDocument(nwBuild.FMT_NWD)
|
||
|
||
# Default Settings
|
||
nwGUI.mainConf.lastPath = nwLipsum
|
||
qtbot.mouseClick(nwBuild.buildNovel, Qt.LeftButton)
|
||
|
||
assert nwBuild._saveDocument(nwBuild.FMT_NWD)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.nwd")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step1_Lorem_Ipsum.nwd")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step1_Lorem_Ipsum.nwd")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile)
|
||
|
||
assert nwBuild._saveDocument(nwBuild.FMT_HTM)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.htm")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step1_Lorem_Ipsum.htm")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step1_Lorem_Ipsum.htm")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile)
|
||
|
||
assert nwBuild._saveDocument(nwBuild.FMT_MD)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.md")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step1_Lorem_Ipsum.md")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step1_Lorem_Ipsum.md")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile)
|
||
|
||
assert nwBuild._saveDocument(nwBuild.FMT_GH)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.md")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step1G_Lorem_Ipsum.md")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step1G_Lorem_Ipsum.md")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile)
|
||
|
||
assert nwBuild._saveDocument(nwBuild.FMT_FODT)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.fodt")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step1_Lorem_Ipsum.fodt")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step1_Lorem_Ipsum.fodt")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile, [4, 5])
|
||
|
||
# Change Title Formats and Flip Switches
|
||
nwBuild.fmtChapter.setText(r"Chapter %chw%: %title%")
|
||
qtbot.wait(stepDelay)
|
||
nwBuild.fmtScene.setText(r"Scene %ch%.%sc%: %title%")
|
||
qtbot.wait(stepDelay)
|
||
nwBuild.fmtSection.setText(r"%ch%.%sc%.1: %title%")
|
||
qtbot.wait(stepDelay)
|
||
|
||
qtbot.mouseClick(nwBuild.justifyText, Qt.LeftButton)
|
||
qtbot.wait(stepDelay)
|
||
qtbot.mouseClick(nwBuild.includeSynopsis, Qt.LeftButton)
|
||
qtbot.wait(stepDelay)
|
||
qtbot.mouseClick(nwBuild.includeComments, Qt.LeftButton)
|
||
qtbot.wait(stepDelay)
|
||
qtbot.mouseClick(nwBuild.includeKeywords, Qt.LeftButton)
|
||
qtbot.wait(stepDelay)
|
||
qtbot.mouseClick(nwBuild.replaceUCode, Qt.LeftButton)
|
||
qtbot.wait(stepDelay)
|
||
|
||
qtbot.mouseClick(nwBuild.noteFiles, Qt.LeftButton)
|
||
qtbot.wait(stepDelay)
|
||
qtbot.mouseClick(nwBuild.ignoreFlag, Qt.LeftButton)
|
||
qtbot.wait(stepDelay)
|
||
|
||
qtbot.mouseClick(nwBuild.buildNovel, Qt.LeftButton)
|
||
|
||
assert nwBuild._saveDocument(nwBuild.FMT_NWD)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.nwd")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step2_Lorem_Ipsum.nwd")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step2_Lorem_Ipsum.nwd")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile)
|
||
|
||
assert nwBuild._saveDocument(nwBuild.FMT_HTM)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.htm")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step2_Lorem_Ipsum.htm")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step2_Lorem_Ipsum.htm")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile)
|
||
|
||
assert nwBuild._saveDocument(nwBuild.FMT_MD)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.md")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step2_Lorem_Ipsum.md")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step2_Lorem_Ipsum.md")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile)
|
||
|
||
assert nwBuild._saveDocument(nwBuild.FMT_FODT)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.fodt")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step2_Lorem_Ipsum.fodt")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step2_Lorem_Ipsum.fodt")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile, [4, 5])
|
||
|
||
# Replace Tabs with Spaces
|
||
qtbot.mouseClick(nwBuild.replaceTabs, Qt.LeftButton)
|
||
qtbot.wait(stepDelay)
|
||
|
||
qtbot.mouseClick(nwBuild.buildNovel, Qt.LeftButton)
|
||
|
||
# Save files that can be compared
|
||
assert nwBuild._saveDocument(nwBuild.FMT_NWD)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.nwd")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step3_Lorem_Ipsum.nwd")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step3_Lorem_Ipsum.nwd")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile)
|
||
|
||
assert nwBuild._saveDocument(nwBuild.FMT_HTM)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.htm")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step3_Lorem_Ipsum.htm")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step3_Lorem_Ipsum.htm")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile)
|
||
|
||
assert nwBuild._saveDocument(nwBuild.FMT_MD)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.md")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step3_Lorem_Ipsum.md")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step3_Lorem_Ipsum.md")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile)
|
||
|
||
assert nwBuild._saveDocument(nwBuild.FMT_FODT)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.fodt")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step3_Lorem_Ipsum.fodt")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step3_Lorem_Ipsum.fodt")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile, [4, 5])
|
||
|
||
# Putline Mode
|
||
nwBuild.fmtChapter.setText(r"Chapter %chw%: %title%")
|
||
qtbot.wait(stepDelay)
|
||
nwBuild.fmtScene.setText(r"Scene %sca%: %title%")
|
||
qtbot.wait(stepDelay)
|
||
nwBuild.fmtSection.setText(r"Section: %title%")
|
||
qtbot.wait(stepDelay)
|
||
|
||
qtbot.mouseClick(nwBuild.includeComments, Qt.LeftButton)
|
||
qtbot.wait(stepDelay)
|
||
qtbot.mouseClick(nwBuild.noteFiles, Qt.LeftButton)
|
||
qtbot.wait(stepDelay)
|
||
qtbot.mouseClick(nwBuild.ignoreFlag, Qt.LeftButton)
|
||
qtbot.wait(stepDelay)
|
||
qtbot.mouseClick(nwBuild.includeBody, Qt.LeftButton)
|
||
qtbot.wait(stepDelay)
|
||
|
||
qtbot.mouseClick(nwBuild.buildNovel, Qt.LeftButton)
|
||
|
||
# Save files that can be compared
|
||
assert nwBuild._saveDocument(nwBuild.FMT_NWD)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.nwd")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step4_Lorem_Ipsum.nwd")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step4_Lorem_Ipsum.nwd")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile)
|
||
|
||
assert nwBuild._saveDocument(nwBuild.FMT_HTM)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.htm")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step4_Lorem_Ipsum.htm")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step4_Lorem_Ipsum.htm")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile)
|
||
|
||
# Check the JSON files too at this stage
|
||
assert nwBuild._saveDocument(nwBuild.FMT_JSON_H)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.json")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step4H_Lorem_Ipsum.json")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step4H_Lorem_Ipsum.json")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile, [8])
|
||
|
||
assert nwBuild._saveDocument(nwBuild.FMT_JSON_M)
|
||
projFile = os.path.join(nwLipsum, "Lorem Ipsum.json")
|
||
testFile = os.path.join(outDir, "guiBuild_Tool_Step4M_Lorem_Ipsum.json")
|
||
compFile = os.path.join(refDir, "guiBuild_Tool_Step4M_Lorem_Ipsum.json")
|
||
copyfile(projFile, testFile)
|
||
assert cmpFiles(testFile, compFile, [8])
|
||
|
||
# Since odt and fodt is built by the same code, we don't check the
|
||
# output. but just that the different format can be written as well
|
||
assert nwBuild._saveDocument(nwBuild.FMT_ODT)
|
||
assert os.path.isfile(os.path.join(nwLipsum, "Lorem Ipsum.odt"))
|
||
|
||
# Print to PDF
|
||
if not nwGUI.mainConf.osDarwin:
|
||
assert nwBuild._saveDocument(nwBuild.FMT_PDF)
|
||
assert os.path.isfile(os.path.join(nwLipsum, "Lorem Ipsum.pdf"))
|
||
|
||
# Close the build tool
|
||
htmlText = nwBuild.htmlText
|
||
htmlStyle = nwBuild.htmlStyle
|
||
buildTime = nwBuild.buildTime
|
||
nwBuild._doClose()
|
||
|
||
# Re-open build dialog from cahce
|
||
nwGUI.mainMenu.aBuildProject.activate(QAction.Trigger)
|
||
qtbot.waitUntil(lambda: getGuiItem("GuiBuildNovel") is not None, timeout=1000)
|
||
|
||
nwBuild = getGuiItem("GuiBuildNovel")
|
||
assert isinstance(nwBuild, GuiBuildNovel)
|
||
|
||
assert nwBuild.viewCachedDoc()
|
||
assert nwBuild.htmlText == htmlText
|
||
assert nwBuild.htmlStyle == htmlStyle
|
||
assert nwBuild.buildTime == buildTime
|
||
|
||
nwBuild._doClose()
|
||
|
||
# qtbot.stopForInteraction()
|
||
|
||
# END Test testToolBuild_Main
|