Veronica Berglyd Olsen
757 lines
24 KiB
Python
757 lines
24 KiB
Python
"""
|
||
novelWriter – Common Functions Tester
|
||
=====================================
|
||
|
||
This file is a part of novelWriter
|
||
Copyright 2018–2024, 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/>.
|
||
"""
|
||
from __future__ import annotations
|
||
|
||
import time
|
||
import pytest
|
||
|
||
from pathlib import Path
|
||
from xml.etree import ElementTree as ET
|
||
|
||
from tools import writeFile
|
||
from mocked import causeOSError
|
||
|
||
from PyQt5.QtGui import QDesktopServices
|
||
from PyQt5.QtCore import QUrl
|
||
|
||
from novelwriter.common import (
|
||
checkBool, checkFloat, checkInt, checkIntTuple, checkPath, checkString,
|
||
checkStringNone, checkUuid, formatFileFilter, formatInt, formatTime,
|
||
formatTimeStamp, formatVersion, fuzzyTime, getFileSize, hexToInt, isHandle,
|
||
isItemClass, isItemLayout, isItemType, isTitleTag, jsonEncode,
|
||
makeFileNameSafe, minmax, numberToRoman, NWConfigParser, openExternalPath,
|
||
readTextFile, simplified, transferCase, xmlIndent, yesNo
|
||
)
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_checkStringNone():
|
||
"""Test the checkStringNone function."""
|
||
assert checkStringNone("Stuff", "NotNone") == "Stuff"
|
||
assert checkStringNone("None", "NotNone") is None
|
||
assert checkStringNone(None, "NotNone") is None
|
||
assert checkStringNone(1, "NotNone") == "NotNone"
|
||
assert checkStringNone(1.0, "NotNone") == "NotNone"
|
||
assert checkStringNone(True, "NotNone") == "NotNone"
|
||
|
||
# END Test testBaseCommon_checkStringNone
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_checkString():
|
||
"""Test the checkString function. Anything that is a string should
|
||
be returned, otherwise it returns the default.
|
||
"""
|
||
assert checkString("None", "default") == "None"
|
||
assert checkString("Text", "default") == "Text"
|
||
assert checkString(None, "default") == "default"
|
||
assert checkString(1, "default") == "default"
|
||
assert checkString(1.0, "default") == "default"
|
||
assert checkString(True, "default") == "default"
|
||
|
||
# END Test testBaseCommon_checkString
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_checkInt():
|
||
"""Test the checkInt function. Anything that can be converted to an
|
||
integer should be returned, otherwise it returns the default.
|
||
"""
|
||
assert checkInt(1, 3) == 1
|
||
assert checkInt(1.0, 3) == 1
|
||
assert checkInt(True, 3) == 1
|
||
assert checkInt(False, 3) == 0
|
||
assert checkInt(None, 3) == 3
|
||
assert checkInt("1", 3) == 1
|
||
assert checkInt("1.0", 3) == 3
|
||
|
||
# END Test testBaseCommon_checkInt
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_checkFloat():
|
||
"""Test the checkFloat function. Anything that can be converted to an
|
||
integer should be returned, otherwise it returns the default.
|
||
"""
|
||
assert checkFloat(1, 3.0) == 1.0
|
||
assert checkFloat(1.0, 3.0) == 1.0
|
||
assert checkFloat(True, 3.0) == 1.0
|
||
assert checkFloat(False, 3.0) == 0.0
|
||
assert checkFloat(None, 3.0) == 3.0
|
||
assert checkFloat("1", 3.0) == 1.0
|
||
assert checkFloat("1.0", 3.0) == 1.0
|
||
|
||
# END Test testBaseCommon_checkFloat
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_checkBool():
|
||
"""Test the checkBool function. Any bool, string version of Python
|
||
bool, or integer 1 or 0, are returned as bool. Otherwise, the
|
||
default is returned.
|
||
"""
|
||
# Bools
|
||
assert checkBool(True, False) is True
|
||
assert checkBool(False, True) is False
|
||
|
||
# Valid Strings
|
||
assert checkBool("True", False) is True
|
||
assert checkBool("False", True) is False
|
||
assert checkBool("true", False) is True
|
||
assert checkBool("false", True) is False
|
||
assert checkBool("Yes", False) is True
|
||
assert checkBool("No", True) is False
|
||
assert checkBool("yes", False) is True
|
||
assert checkBool("no", True) is False
|
||
assert checkBool("On", False) is True
|
||
assert checkBool("Off", True) is False
|
||
assert checkBool("on", False) is True
|
||
assert checkBool("off", True) is False
|
||
|
||
# Invalid Strings
|
||
assert checkBool("Foo", False) is False
|
||
assert checkBool("Foo", True) is True
|
||
assert checkBool("bar", False) is False
|
||
assert checkBool("bar", True) is True
|
||
|
||
# Valid Integers
|
||
assert checkBool(0, True) is False
|
||
assert checkBool(1, False) is True
|
||
|
||
# Invalid Integers
|
||
assert checkBool(2, True) is True
|
||
assert checkBool(2, False) is False
|
||
|
||
# Other Types
|
||
assert checkBool(None, True) is True
|
||
assert checkBool(None, False) is False
|
||
assert checkBool(0.0, True) is True
|
||
assert checkBool(1.0, False) is False
|
||
assert checkBool(2.0, True) is True
|
||
assert checkBool(2.0, False) is False
|
||
|
||
# END Test testBaseCommon_checkBool
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_checkUuid():
|
||
"""Test the checkUuid function."""
|
||
testUuid = "e2be99af-f9bf-4403-857a-c3d1ac25abea"
|
||
assert checkUuid("", None) is None # type: ignore
|
||
assert checkUuid("e2be99af-f9bf-4403-857a-c3d1ac25abe", None) is None # type: ignore
|
||
assert checkUuid("e2be99af-f9bf-qq03-857a-c3d1ac25abea", None) is None # type: ignore
|
||
assert checkUuid("e2be99af-f9bf-4403-857a-c3d1ac25abeaa", None) is None # type: ignore
|
||
assert checkUuid(testUuid, None) == testUuid # type: ignore
|
||
|
||
# END Test testBaseCommon_checkUuid
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_checkPath():
|
||
"""Test the checkPath function."""
|
||
assert checkPath(Path("test"), None) == Path("test") # type: ignore
|
||
assert checkPath("test", None) == Path("test") # type: ignore
|
||
assert checkPath(None, None) is None # type: ignore
|
||
assert checkPath("", None) is None # type: ignore
|
||
assert checkPath(" ", None) is None # type: ignore
|
||
|
||
# END Test testBaseCommon_checkPath
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_isHandle():
|
||
"""Test the isHandle function."""
|
||
assert isHandle("47666c91c7ccf") is True
|
||
assert isHandle("47666C91C7CCF") is False
|
||
assert isHandle("h7666c91c7ccf") is False
|
||
assert isHandle("None") is False
|
||
assert isHandle(None) is False
|
||
assert isHandle("STUFF") is False
|
||
|
||
# END Test testBaseCommon_isHandle
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_isTitleTag():
|
||
"""Test the isTitleTag function."""
|
||
assert isTitleTag("T1234") is True
|
||
|
||
assert isTitleTag("t1234") is False
|
||
assert isTitleTag("S1234") is False
|
||
assert isTitleTag("T123A") is False
|
||
assert isTitleTag("T12345") is False
|
||
|
||
assert isTitleTag("None") is False
|
||
assert isTitleTag(None) is False
|
||
assert isTitleTag("STUFF") is False
|
||
|
||
# END Test testBaseCommon_isTitleTag
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_isItemClass():
|
||
"""Test the isItemClass function."""
|
||
assert isItemClass("NO_CLASS") is True
|
||
assert isItemClass("NOVEL") is True
|
||
assert isItemClass("PLOT") is True
|
||
assert isItemClass("CHARACTER") is True
|
||
assert isItemClass("WORLD") is True
|
||
assert isItemClass("TIMELINE") is True
|
||
assert isItemClass("OBJECT") is True
|
||
assert isItemClass("ENTITY") is True
|
||
assert isItemClass("CUSTOM") is True
|
||
assert isItemClass("ARCHIVE") is True
|
||
assert isItemClass("TRASH") is True
|
||
|
||
# Invalid
|
||
assert isItemClass("None") is False
|
||
assert isItemClass(None) is False
|
||
assert isItemClass("STUFF") is False
|
||
|
||
# END Test testBaseCommon_isItemClass
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_isItemType():
|
||
"""Test the isItemType function."""
|
||
assert isItemType("NO_TYPE") is True
|
||
assert isItemType("ROOT") is True
|
||
assert isItemType("FOLDER") is True
|
||
assert isItemType("FILE") is True
|
||
|
||
# Deprecated Type
|
||
assert isItemType("TRASH") is False
|
||
|
||
# Invalid
|
||
assert isItemType("None") is False
|
||
assert isItemType(None) is False # type: ignore
|
||
assert isItemType("STUFF") is False
|
||
|
||
# END Test testBaseCommon_isItemType
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_isItemLayout():
|
||
"""Test the isItemLayout function."""
|
||
assert isItemLayout("NO_LAYOUT") is True
|
||
assert isItemLayout("DOCUMENT") is True
|
||
assert isItemLayout("NOTE") is True
|
||
|
||
# Deprecated Layouts
|
||
assert isItemLayout("TITLE") is False
|
||
assert isItemLayout("PAGE") is False
|
||
assert isItemLayout("BOOK") is False
|
||
assert isItemLayout("PARTITION") is False
|
||
assert isItemLayout("UNNUMBERED") is False
|
||
assert isItemLayout("CHAPTER") is False
|
||
assert isItemLayout("SCENE") is False
|
||
|
||
# Invalid
|
||
assert isItemLayout("None") is False
|
||
assert isItemLayout(None) is False # type: ignore
|
||
assert isItemLayout("STUFF") is False
|
||
|
||
# END Test testBaseCommon_isItemLayout
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_hexToInt():
|
||
"""Test the hexToInt function."""
|
||
assert hexToInt(1) == 0
|
||
assert hexToInt("1") == 1
|
||
assert hexToInt("0xff") == 255
|
||
assert hexToInt("0xffff") == 65535
|
||
assert hexToInt("0xffffq") == 0
|
||
assert hexToInt("0xffffq", 12) == 12
|
||
|
||
# END Test testBaseCommon_hexToInt
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_minmax():
|
||
"""Test the minmax function."""
|
||
for i in range(-5, 15):
|
||
assert 0 <= minmax(i, 0, 10) <= 10
|
||
|
||
# END Test testBaseCommon_minmax
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_checkIntTuple():
|
||
"""Test the checkIntTuple function."""
|
||
assert checkIntTuple(0, (0, 1, 2), 3) == 0
|
||
assert checkIntTuple(5, (0, 1, 2), 3) == 3
|
||
|
||
# END Test testBaseCommon_checkIntTuple
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_formatTimeStamp():
|
||
"""Test the formatTimeStamp function."""
|
||
tTime = time.mktime(time.gmtime(0))
|
||
assert formatTimeStamp(tTime, False) == "1970-01-01 00:00:00"
|
||
assert formatTimeStamp(tTime, True) == "1970-01-01 00.00.00"
|
||
|
||
# END Test testBaseCommon_formatTimeStamp
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_formatTime():
|
||
"""Test the formatTime function."""
|
||
assert formatTime("1") == "ERROR" # type: ignore
|
||
assert formatTime(1.0) == "ERROR" # type: ignore
|
||
assert formatTime(1) == "00:00:01"
|
||
assert formatTime(59) == "00:00:59"
|
||
assert formatTime(60) == "00:01:00"
|
||
assert formatTime(180) == "00:03:00"
|
||
assert formatTime(194) == "00:03:14"
|
||
assert formatTime(3540) == "00:59:00"
|
||
assert formatTime(3599) == "00:59:59"
|
||
assert formatTime(3600) == "01:00:00"
|
||
assert formatTime(11640) == "03:14:00"
|
||
assert formatTime(11655) == "03:14:15"
|
||
assert formatTime(86399) == "23:59:59"
|
||
assert formatTime(86400) == "1-00:00:00"
|
||
assert formatTime(360000) == "4-04:00:00"
|
||
|
||
# END Test testBaseCommon_formatTime
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_formatVersion():
|
||
"""Test the formatVersion function."""
|
||
assert formatVersion("1.2") == "1.2"
|
||
assert formatVersion("1.2a1") == "1.2 Alpha 1"
|
||
assert formatVersion("1.2b2") == "1.2 Beta 2"
|
||
assert formatVersion("1.2rc3") == "1.2 RC 3"
|
||
|
||
# END Test testBaseCommon_formatVersion
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_formatFileFilter():
|
||
"""Test the formatFileFilter function."""
|
||
assert formatFileFilter(["*.txt"]) == "Text files (*.txt)"
|
||
assert formatFileFilter(["*.txt", "*"]) == "Text files (*.txt);;All files (*)"
|
||
assert formatFileFilter([("Stuff", "*.stuff"), "*.txt", "*"]) == (
|
||
"Stuff (*.stuff);;Text files (*.txt);;All files (*)"
|
||
)
|
||
|
||
# END Test testBaseCommon_formatFileFilter
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_simplified():
|
||
"""Test the simplified function."""
|
||
assert simplified("Hello World") == "Hello World"
|
||
assert simplified(" Hello World ") == "Hello World"
|
||
assert simplified("\tHello\n\r\tWorld") == "Hello World"
|
||
|
||
# END Test testBaseCommon_simplified
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_yesNo():
|
||
"""Test the yesNo function."""
|
||
# Bool
|
||
assert yesNo(True) == "yes"
|
||
assert yesNo(False) == "no"
|
||
|
||
# None
|
||
assert yesNo(None) == "no"
|
||
|
||
# String
|
||
assert yesNo("foo") == "yes" # type: ignore
|
||
assert yesNo("") == "no" # type: ignore
|
||
|
||
# Integer
|
||
assert yesNo(0) == "no"
|
||
assert yesNo(1) == "yes"
|
||
assert yesNo(2) == "yes"
|
||
|
||
# Float
|
||
assert yesNo(0.0) == "no" # type: ignore
|
||
assert yesNo(1.0) == "yes" # type: ignore
|
||
assert yesNo(2.0) == "yes" # type: ignore
|
||
|
||
# END Test testBaseCommon_yesNo
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_formatInt():
|
||
"""Test the formatInt function."""
|
||
# Normal Cases
|
||
assert formatInt(1) == "1"
|
||
assert formatInt(12) == "12"
|
||
assert formatInt(123) == "123"
|
||
assert formatInt(1234) == "1.23\u2009k"
|
||
assert formatInt(12345) == "12.3\u2009k"
|
||
assert formatInt(123456) == "123\u2009k"
|
||
assert formatInt(1234567) == "1.23\u2009M"
|
||
assert formatInt(12345678) == "12.3\u2009M"
|
||
assert formatInt(123456789) == "123\u2009M"
|
||
assert formatInt(1234567890) == "1.23\u2009G"
|
||
|
||
# Exceptions
|
||
assert formatInt(12.3) == "ERR" # type: ignore
|
||
assert formatInt(None) == "ERR" # type: ignore
|
||
assert formatInt("42") == "ERR" # type: ignore
|
||
|
||
# END Test testBaseCommon_formatInt
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_transferCase():
|
||
"""Test the transferCase function."""
|
||
assert transferCase(1, "TaRgEt") == "TaRgEt" # type: ignore
|
||
assert transferCase("source", 1) == 1 # type: ignore
|
||
assert transferCase("", "TaRgEt") == "TaRgEt"
|
||
assert transferCase("source", "") == ""
|
||
assert transferCase("Source", "target") == "Target"
|
||
assert transferCase("SOURCE", "target") == "TARGET"
|
||
assert transferCase("source", "TARGET") == "target"
|
||
|
||
# END Test testBaseCommon_transferCase
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_fuzzyTime():
|
||
"""Test the fuzzyTime function."""
|
||
assert fuzzyTime(-1) == "in the future"
|
||
assert fuzzyTime(0) == "just now"
|
||
assert fuzzyTime(29) == "just now"
|
||
assert fuzzyTime(30) == "a minute ago"
|
||
assert fuzzyTime(89) == "a minute ago"
|
||
assert fuzzyTime(90) == "2 minutes ago"
|
||
assert fuzzyTime(149) == "2 minutes ago"
|
||
assert fuzzyTime(151) == "3 minutes ago"
|
||
assert fuzzyTime(3299) == "55 minutes ago"
|
||
assert fuzzyTime(3300) == "an hour ago"
|
||
assert fuzzyTime(5399) == "an hour ago"
|
||
assert fuzzyTime(5400) == "2 hours ago"
|
||
assert fuzzyTime(84599) == "23 hours ago"
|
||
assert fuzzyTime(84600) == "a day ago"
|
||
assert fuzzyTime(129599) == "a day ago"
|
||
assert fuzzyTime(129600) == "2 days ago"
|
||
assert fuzzyTime(561599) == "6 days ago"
|
||
assert fuzzyTime(561600) == "a week ago"
|
||
assert fuzzyTime(907199) == "a week ago"
|
||
assert fuzzyTime(907200) == "2 weeks ago"
|
||
assert fuzzyTime(2419199) == "4 weeks ago"
|
||
assert fuzzyTime(2419200) == "a month ago"
|
||
assert fuzzyTime(3887999) == "a month ago"
|
||
assert fuzzyTime(3888000) == "2 months ago"
|
||
assert fuzzyTime(29807999) == "11 months ago"
|
||
assert fuzzyTime(29808000) == "a year ago"
|
||
assert fuzzyTime(47336399) == "a year ago"
|
||
assert fuzzyTime(47336400) == "2 years ago"
|
||
|
||
# END Test testBaseCommon_fuzzyTime
|
||
|
||
|
||
@pytest.mark.core
|
||
def testBaseCommon_numberToRoman():
|
||
"""Test conversion of integers to Roman numbers."""
|
||
assert numberToRoman(None, False) == "NAN" # type: ignore
|
||
assert numberToRoman(0, False) == "OOR"
|
||
assert numberToRoman(1, False) == "I"
|
||
assert numberToRoman(2, False) == "II"
|
||
assert numberToRoman(3, False) == "III"
|
||
assert numberToRoman(4, False) == "IV"
|
||
assert numberToRoman(5, False) == "V"
|
||
assert numberToRoman(6, False) == "VI"
|
||
assert numberToRoman(7, False) == "VII"
|
||
assert numberToRoman(8, False) == "VIII"
|
||
assert numberToRoman(9, False) == "IX"
|
||
assert numberToRoman(10, False) == "X"
|
||
assert numberToRoman(14, False) == "XIV"
|
||
assert numberToRoman(42, False) == "XLII"
|
||
assert numberToRoman(99, False) == "XCIX"
|
||
assert numberToRoman(142, False) == "CXLII"
|
||
assert numberToRoman(542, False) == "DXLII"
|
||
assert numberToRoman(999, False) == "CMXCIX"
|
||
assert numberToRoman(2010, False) == "MMX"
|
||
assert numberToRoman(999, True) == "cmxcix"
|
||
|
||
# END Test testBaseCommon_numberToRoman
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_jsonEncode():
|
||
"""Test the jsonEncode function."""
|
||
# Wrong type
|
||
assert jsonEncode(None) == "[]" # type: ignore
|
||
|
||
# Correct types
|
||
assert jsonEncode([1, 2]) == "[\n 1,\n 2\n]"
|
||
assert jsonEncode((1, 2)) == "[\n 1,\n 2\n]"
|
||
assert jsonEncode({1: 2}) == "{\n \"1\": 2\n}"
|
||
|
||
tstDict = {
|
||
"null": None,
|
||
"one": 1,
|
||
"two": "2",
|
||
"three": 3.0,
|
||
"four": False,
|
||
"five": (1, 2),
|
||
"six": {"a": 1, "b": 2},
|
||
"seven": [],
|
||
"eight": {},
|
||
}
|
||
|
||
# Complex Structure
|
||
assert jsonEncode(tstDict) == (
|
||
'{\n'
|
||
' "null": null,\n'
|
||
' "one": 1,\n'
|
||
' "two": "2",\n'
|
||
' "three": 3.0,\n'
|
||
' "four": false,\n'
|
||
' "five": [\n'
|
||
' 1,\n'
|
||
' 2\n'
|
||
' ],\n'
|
||
' "six": {\n'
|
||
' "a": 1,\n'
|
||
' "b": 2\n'
|
||
' },\n'
|
||
' "seven": [],\n'
|
||
' "eight": {}\n'
|
||
'}'
|
||
)
|
||
|
||
# Additional Indent
|
||
assert jsonEncode(tstDict, n=2) == (
|
||
'{\n'
|
||
' "null": null,\n'
|
||
' "one": 1,\n'
|
||
' "two": "2",\n'
|
||
' "three": 3.0,\n'
|
||
' "four": false,\n'
|
||
' "five": [\n'
|
||
' 1,\n'
|
||
' 2\n'
|
||
' ],\n'
|
||
' "six": {\n'
|
||
' "a": 1,\n'
|
||
' "b": 2\n'
|
||
' },\n'
|
||
' "seven": [],\n'
|
||
' "eight": {}\n'
|
||
' }'
|
||
)
|
||
|
||
# Max Indent
|
||
assert jsonEncode(tstDict, n=0, nmax=1) == (
|
||
'{\n'
|
||
' "null": null,\n'
|
||
' "one": 1,\n'
|
||
' "two": "2",\n'
|
||
' "three": 3.0,\n'
|
||
' "four": false,\n'
|
||
' "five": [1, 2],\n'
|
||
' "six": {"a": 1, "b": 2},\n'
|
||
' "seven": [],\n'
|
||
' "eight": {}\n'
|
||
'}'
|
||
)
|
||
|
||
# END Test testBaseCommon_jsonEncode
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_xmlIndent():
|
||
"""Test the xmlIndent function."""
|
||
xRoot = ET.fromstring(
|
||
"<xml>"
|
||
"<group>"
|
||
"<item>foo</item>"
|
||
"</group>"
|
||
"</xml>"
|
||
)
|
||
xmlIndent(ET.ElementTree(xRoot))
|
||
assert ET.tostring(xRoot) == (
|
||
b"<xml>\n"
|
||
b" <group>\n"
|
||
b" <item>foo</item>\n"
|
||
b" </group>\n"
|
||
b"</xml>\n"
|
||
)
|
||
|
||
# If we send nonsense, nothing is done
|
||
data = "foobar"
|
||
xmlIndent(data) # type: ignore
|
||
assert data == "foobar"
|
||
|
||
# END Test testBaseCommon_xmlIndent
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_readTextFile(monkeypatch, fncPath, ipsumText):
|
||
"""Test the readTextFile function."""
|
||
testText = "\n\n".join(ipsumText) + "\n"
|
||
testFile = fncPath / "ipsum.txt"
|
||
writeFile(testFile, testText)
|
||
|
||
assert readTextFile(fncPath / "not_a_file.txt") == ""
|
||
assert readTextFile(testFile) == testText
|
||
|
||
with monkeypatch.context() as mp:
|
||
mp.setattr("pathlib.Path.read_text", causeOSError)
|
||
assert readTextFile(testFile) == ""
|
||
|
||
# END Test testBaseCommon_readTextFile
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_makeFileNameSafe():
|
||
"""Test the makeFileNameSafe function."""
|
||
assert makeFileNameSafe(" aaaa ") == "aaaa"
|
||
assert makeFileNameSafe("aaaa,bbbb") == "aaaabbbb"
|
||
assert makeFileNameSafe("aaaa\tbbbb") == "aaaabbbb"
|
||
assert makeFileNameSafe("aaaa bbbb") == "aaaa bbbb"
|
||
assert makeFileNameSafe("æøå") == "æøå"
|
||
assert makeFileNameSafe("Stuff œfi2⁵") == "Stuff œfi25"
|
||
|
||
# END Test testBaseCommon_makeFileNameSafe
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_getFileSize(fncPath):
|
||
"""Test the getFileSize function."""
|
||
(fncPath / "one.txt").write_bytes(b"foobar")
|
||
(fncPath / "two.txt").touch()
|
||
|
||
assert getFileSize(fncPath / "nope.txt") == -1
|
||
assert getFileSize(fncPath / "one.txt") == 6
|
||
assert getFileSize(fncPath / "two.txt") == 0
|
||
|
||
# END Test testBaseCommon_getFileSize
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_openExternalPath(monkeypatch, tstPaths):
|
||
"""Test the openExternalPath function."""
|
||
lastUrl = ""
|
||
|
||
def mockOpenUrl(url: QUrl) -> None:
|
||
nonlocal lastUrl
|
||
lastUrl = url.toString()
|
||
return
|
||
|
||
monkeypatch.setattr(QDesktopServices, "openUrl", mockOpenUrl)
|
||
assert openExternalPath(Path("/foo/bar")) is False
|
||
assert openExternalPath(tstPaths.tmpDir) is True
|
||
assert lastUrl.startswith("file://")
|
||
|
||
# END Test testBaseCommon_openExternalPath
|
||
|
||
|
||
@pytest.mark.base
|
||
def testBaseCommon_NWConfigParser(fncPath):
|
||
"""Test the NWConfigParser subclass."""
|
||
tstConf = fncPath / "test.cfg"
|
||
writeFile(tstConf, (
|
||
"[main]\n"
|
||
"stropt = value\n"
|
||
"intopt1 = 42\n"
|
||
"intopt2 = 42.43\n"
|
||
"boolopt1 = true\n"
|
||
"boolopt2 = TRUE\n"
|
||
"boolopt3 = 1\n"
|
||
"boolopt4 = 0\n"
|
||
"list1 = a, b, c\n"
|
||
"list2 = 17, 18, 19\n"
|
||
"float1 = 4.2\n"
|
||
f"path1 = {fncPath}\n"
|
||
))
|
||
|
||
cfgParser = NWConfigParser()
|
||
cfgParser.read(tstConf)
|
||
|
||
# Readers
|
||
# =======
|
||
|
||
# Read String
|
||
assert cfgParser.rdStr("main", "stropt", "stuff") == "value"
|
||
assert cfgParser.rdStr("main", "boolopt1", "stuff") == "true"
|
||
assert cfgParser.rdStr("main", "intopt1", "stuff") == "42"
|
||
|
||
assert cfgParser.rdStr("nope", "stropt", "stuff") == "stuff"
|
||
assert cfgParser.rdStr("main", "blabla", "stuff") == "stuff"
|
||
|
||
# Read Boolean
|
||
assert cfgParser.rdBool("main", "boolopt1", None) is True # type: ignore
|
||
assert cfgParser.rdBool("main", "boolopt2", None) is True # type: ignore
|
||
assert cfgParser.rdBool("main", "boolopt3", None) is True # type: ignore
|
||
assert cfgParser.rdBool("main", "boolopt4", None) is False # type: ignore
|
||
assert cfgParser.rdBool("main", "intopt1", None) is None # type: ignore
|
||
|
||
assert cfgParser.rdBool("nope", "boolopt1", None) is None # type: ignore
|
||
assert cfgParser.rdBool("main", "blabla", None) is None # type: ignore
|
||
|
||
# Read Integer
|
||
assert cfgParser.rdInt("main", "intopt1", 13) == 42
|
||
assert cfgParser.rdInt("main", "intopt2", 13) == 13
|
||
assert cfgParser.rdInt("main", "stropt", 13) == 13
|
||
|
||
assert cfgParser.rdInt("nope", "intopt1", 13) == 13
|
||
assert cfgParser.rdInt("main", "blabla", 13) == 13
|
||
|
||
# Read Float
|
||
assert cfgParser.rdFlt("main", "intopt1", 13.0) == 42.0
|
||
assert cfgParser.rdFlt("main", "float1", 13.0) == 4.2
|
||
assert cfgParser.rdFlt("main", "stropt", 13.0) == 13.0
|
||
|
||
assert cfgParser.rdFlt("nope", "intopt1", 13.0) == 13.0
|
||
assert cfgParser.rdFlt("main", "blabla", 13.0) == 13.0
|
||
|
||
# Read Path
|
||
assert cfgParser.rdPath("main", "path1", Path.home()) == fncPath
|
||
|
||
# Read String List
|
||
assert cfgParser.rdStrList("main", "list1", []) == []
|
||
assert cfgParser.rdStrList("main", "list1", ["x"]) == ["a"]
|
||
assert cfgParser.rdStrList("main", "list1", ["x", "y"]) == ["a", "b"]
|
||
assert cfgParser.rdStrList("main", "list1", ["x", "y", "z"]) == ["a", "b", "c"]
|
||
assert cfgParser.rdStrList("main", "list1", ["x", "y", "z", "w"]) == ["a", "b", "c", "w"]
|
||
|
||
assert cfgParser.rdStrList("main", "stropt", ["x"]) == ["value"]
|
||
assert cfgParser.rdStrList("main", "intopt1", ["x"]) == ["42"]
|
||
|
||
assert cfgParser.rdStrList("nope", "list1", ["x"]) == ["x"]
|
||
assert cfgParser.rdStrList("main", "blabla", ["x"]) == ["x"]
|
||
|
||
# Read Integer List
|
||
assert cfgParser.rdIntList("main", "list2", []) == []
|
||
assert cfgParser.rdIntList("main", "list2", [1]) == [17]
|
||
assert cfgParser.rdIntList("main", "list2", [1, 2]) == [17, 18]
|
||
assert cfgParser.rdIntList("main", "list2", [1, 2, 3]) == [17, 18, 19]
|
||
assert cfgParser.rdIntList("main", "list2", [1, 2, 3, 4]) == [17, 18, 19, 4]
|
||
|
||
assert cfgParser.rdIntList("main", "stropt", [1]) == [1]
|
||
assert cfgParser.rdIntList("main", "boolopt1", [1]) == [1]
|
||
|
||
assert cfgParser.rdIntList("nope", "list2", [1]) == [1]
|
||
assert cfgParser.rdIntList("main", "blabla", [1]) == [1]
|
||
|
||
# END Test testBaseCommon_NWConfigParser
|