jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-08-01 09:38:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename instead of deleting log file

Browse Source
This commit is contained in:
abmantis 2025-07-30 17:20:26 +01:00
parent ba67dd1d8b
commit 1d717f671b
2 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
homeassistant/bootstrap.py
View File

@ -627,7 +627,7 @@ async def async_enable_logging(
# it even on Supervisor # it even on Supervisor
if os.path.isfile(default_log_path): if os.path.isfile(default_log_path):
with contextlib.suppress(OSError): with contextlib.suppress(OSError):
os.remove(default_log_path) os.rename(default_log_path, f"{default_log_path}.old")
err_log_path = None err_log_path = None
else: else:
err_log_path = default_log_path err_log_path = default_log_path

32
tests/test_bootstrap.py
View File

@ -38,15 +38,15 @@ from .common import (
VERSION_PATH = os.path.join(get_test_config_dir(), config_util.VERSION_FILE) VERSION_PATH = os.path.join(get_test_config_dir(), config_util.VERSION_FILE)
CONFIG_LOG_FILE_PATTERN = get_test_config_dir("home-assistant.log*") CONFIG_LOG_FILE = get_test_config_dir("home-assistant.log")
ARG_LOG_FILE_PATTERN = "test.log*" ARG_LOG_FILE = "test.log"
def cleanup_log_files() -> None: def cleanup_log_files() -> None:
"""Remove all log files.""" """Remove all log files."""
for f in glob.glob(CONFIG_LOG_FILE_PATTERN): for f in glob.glob(f"{CONFIG_LOG_FILE}*"):
os.remove(f) os.remove(f)
for f in glob.glob(ARG_LOG_FILE_PATTERN): for f in glob.glob(f"{ARG_LOG_FILE}*"):
os.remove(f) os.remove(f)
@ -99,8 +99,8 @@ async def test_async_enable_logging(
# Ensure we start with a clean slate # Ensure we start with a clean slate
cleanup_log_files() cleanup_log_files()
assert len(glob.glob(CONFIG_LOG_FILE_PATTERN)) == 0 assert len(glob.glob(CONFIG_LOG_FILE)) == 0
assert len(glob.glob(ARG_LOG_FILE_PATTERN)) == 0 assert len(glob.glob(ARG_LOG_FILE)) == 0
with ( with (
patch("logging.getLogger"), patch("logging.getLogger"),
@ -114,7 +114,7 @@ async def test_async_enable_logging(
): ):
await bootstrap.async_enable_logging(hass) await bootstrap.async_enable_logging(hass)
mock_async_activate_log_queue_handler.assert_called_once() mock_async_activate_log_queue_handler.assert_called_once()
assert len(glob.glob(CONFIG_LOG_FILE_PATTERN)) > 0 assert len(glob.glob(CONFIG_LOG_FILE)) > 0
mock_async_activate_log_queue_handler.reset_mock() mock_async_activate_log_queue_handler.reset_mock()
await bootstrap.async_enable_logging( await bootstrap.async_enable_logging(
@ -123,7 +123,7 @@ async def test_async_enable_logging(
log_file="test.log", log_file="test.log",
) )
mock_async_activate_log_queue_handler.assert_called_once() mock_async_activate_log_queue_handler.assert_called_once()
assert len(glob.glob(ARG_LOG_FILE_PATTERN)) > 0 assert len(glob.glob(ARG_LOG_FILE)) > 0
assert "Error rolling over log file" in caplog.text assert "Error rolling over log file" in caplog.text
@ -137,8 +137,8 @@ async def test_async_enable_logging_supervisor(
# Ensure we start with a clean slate # Ensure we start with a clean slate
cleanup_log_files() cleanup_log_files()
assert len(glob.glob(CONFIG_LOG_FILE_PATTERN)) == 0 assert len(glob.glob(CONFIG_LOG_FILE)) == 0
assert len(glob.glob(ARG_LOG_FILE_PATTERN)) == 0 assert len(glob.glob(ARG_LOG_FILE)) == 0
with ( with (
patch.dict(os.environ, {"SUPERVISOR": "1"}), patch.dict(os.environ, {"SUPERVISOR": "1"}),
@ -148,11 +148,11 @@ async def test_async_enable_logging_supervisor(
patch("logging.getLogger"), patch("logging.getLogger"),
): ):
await bootstrap.async_enable_logging(hass) await bootstrap.async_enable_logging(hass)
assert len(glob.glob(CONFIG_LOG_FILE_PATTERN)) == 0 assert len(glob.glob(CONFIG_LOG_FILE)) == 0
mock_async_activate_log_queue_handler.assert_called_once() mock_async_activate_log_queue_handler.assert_called_once()
mock_async_activate_log_queue_handler.reset_mock() mock_async_activate_log_queue_handler.reset_mock()
# Check that if the log file exists, it is removed # Check that if the log file exists, it is renamed
def write_log_file(): def write_log_file():
with open( with open(
get_test_config_dir("home-assistant.log"), "w", encoding="utf8" get_test_config_dir("home-assistant.log"), "w", encoding="utf8"
@ -160,9 +160,11 @@ async def test_async_enable_logging_supervisor(
f.write("test") f.write("test")
await hass.async_add_executor_job(write_log_file) await hass.async_add_executor_job(write_log_file)
assert len(glob.glob(CONFIG_LOG_FILE_PATTERN)) == 1 assert len(glob.glob(CONFIG_LOG_FILE)) == 1
assert len(glob.glob(f"{CONFIG_LOG_FILE}.old")) == 0
await bootstrap.async_enable_logging(hass) await bootstrap.async_enable_logging(hass)
assert len(glob.glob(CONFIG_LOG_FILE_PATTERN)) == 0 assert len(glob.glob(CONFIG_LOG_FILE)) == 0
assert len(glob.glob(f"{CONFIG_LOG_FILE}.old")) == 1
mock_async_activate_log_queue_handler.assert_called_once() mock_async_activate_log_queue_handler.assert_called_once()
mock_async_activate_log_queue_handler.reset_mock() mock_async_activate_log_queue_handler.reset_mock()
@ -173,7 +175,7 @@ async def test_async_enable_logging_supervisor(
) )
mock_async_activate_log_queue_handler.assert_called_once() mock_async_activate_log_queue_handler.assert_called_once()
# Even on Supervisor, the log file should be created if it is explicitly specified # Even on Supervisor, the log file should be created if it is explicitly specified
assert len(glob.glob(ARG_LOG_FILE_PATTERN)) > 0 assert len(glob.glob(ARG_LOG_FILE)) > 0
cleanup_log_files() cleanup_log_files()