mirror of
https://github.com/freedomofpress/dangerzone.git
synced 2025-04-28 18:02:38 +02:00
0b45360384
In d632908a44 we improved our
`replace_control_chars()` function, by replacing every control or
invalid Unicode character with a placeholder one. This change, however,
made our debug logs harder to read, since newlines were not preserved.
There are indeed various cases in which replacing newlines is wise
(e.g., in filenames), so we should keep this behavior by default.
However, specifically for reading debug logs, we add an option to keep
newlines to improve readability, at no expense to security.
37 lines
1.2 KiB
Python
37 lines
1.2 KiB
Python
import platform
|
||
import subprocess
|
||
from pathlib import Path
|
||
|
||
import pytest
|
||
|
||
from dangerzone import util
|
||
|
||
from . import sanitized_text, uncommon_text
|
||
|
||
VERSION_FILE_NAME = "version.txt"
|
||
|
||
|
||
def test_get_resource_path() -> None:
|
||
share_dir = Path("share").resolve()
|
||
resource_path = Path(util.get_resource_path(VERSION_FILE_NAME)).parent
|
||
assert share_dir.samefile(
|
||
resource_path
|
||
), f"{share_dir} is not the same file as {resource_path}"
|
||
|
||
|
||
@pytest.mark.skipif(platform.system() != "Windows", reason="Windows-specific")
|
||
def test_get_subprocess_startupinfo() -> None:
|
||
startupinfo = util.get_subprocess_startupinfo()
|
||
assert isinstance(startupinfo, subprocess.STARTUPINFO) # type: ignore[attr-defined]
|
||
|
||
|
||
def test_replace_control_chars(uncommon_text: str, sanitized_text: str) -> None:
|
||
"""Test that the replace_control_chars() function works properly."""
|
||
assert util.replace_control_chars(uncommon_text) == sanitized_text
|
||
assert util.replace_control_chars("normal text") == "normal text"
|
||
assert util.replace_control_chars("") == ""
|
||
assert util.replace_control_chars("multi-line\ntext") == "multi-line<6E>text"
|
||
assert (
|
||
util.replace_control_chars("multi-line\ntext", keep_newlines=True)
|
||
== "multi-line\ntext"
|
||
)
|