Setting system timezone using Controller.
Some checks are pending
CodeQL / Analyze (push) Waiting to run
Controller Tests / controller-tests (push) Waiting to run
Jest Tests / jest-tests (push) Waiting to run

This commit is contained in:
Roland 2026-03-13 15:56:21 -06:00
parent b1db71f04a
commit ccc6cf78d3
No known key found for this signature in database
GPG key ID: 1BA620CE6C9A4680
8 changed files with 390 additions and 2 deletions

View file

@ -7,14 +7,17 @@ from unittest import mock
import pytest
from controller.lib.admin import (
apply_timezone_from_config,
disable_hotspot,
disable_throttle,
enable_hotspot,
enable_throttle,
get_hotspot_status,
get_throttle_status,
get_timezone_status_dict,
reboot_system,
restart_all_services,
set_timezone,
shutdown_system,
HotspotStatus,
GovernorStatus,
@ -279,3 +282,145 @@ class TestRestartAllServices:
assert "services" in result
# Should include controller as pending
assert result["services"]["wrolpi-controller"]["pending"] is True
class TestGetTimezoneStatus:
"""Tests for get_timezone_status_dict function."""
def test_returns_unavailable_in_docker_mode(self):
"""Should return unavailable when in Docker mode."""
with mock.patch("controller.lib.admin.is_docker_mode", return_value=True):
result = get_timezone_status_dict()
assert result["available"] is False
assert result["timezone"] is None
assert "Docker" in result["reason"]
def test_returns_timezone_from_timedatectl(self):
"""Should return the current system timezone."""
mock_result = mock.Mock()
mock_result.returncode = 0
mock_result.stdout = "America/Denver\n"
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False):
with mock.patch("subprocess.run", return_value=mock_result):
result = get_timezone_status_dict()
assert result["available"] is True
assert result["timezone"] == "America/Denver"
assert result["reason"] is None
def test_handles_timedatectl_not_found(self):
"""Should handle timedatectl not being available."""
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False):
with mock.patch("subprocess.run", side_effect=FileNotFoundError()):
result = get_timezone_status_dict()
assert result["available"] is False
assert "not found" in result["reason"]
def test_handles_timeout(self):
"""Should handle subprocess timeout."""
import subprocess
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False):
with mock.patch("subprocess.run", side_effect=subprocess.TimeoutExpired("timedatectl", 5)):
result = get_timezone_status_dict()
assert result["available"] is False
assert "timed out" in result["reason"]
class TestSetTimezone:
"""Tests for set_timezone function."""
def test_returns_error_in_docker_mode(self):
"""Should return error when in Docker mode."""
with mock.patch("controller.lib.admin.is_docker_mode", return_value=True):
result = set_timezone("America/Denver")
assert result["success"] is False
assert "Docker" in result["error"]
def test_sets_timezone_successfully(self):
"""Should set timezone via timedatectl."""
mock_result = mock.Mock()
mock_result.returncode = 0
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False):
with mock.patch("subprocess.run", return_value=mock_result) as mock_run:
result = set_timezone("America/Denver")
assert result["success"] is True
assert result["timezone"] == "America/Denver"
mock_run.assert_called_once_with(
["timedatectl", "set-timezone", "America/Denver"],
capture_output=True,
text=True,
timeout=10,
)
def test_handles_invalid_timezone(self):
"""Should handle timedatectl rejecting an invalid timezone."""
mock_result = mock.Mock()
mock_result.returncode = 1
mock_result.stderr = "Failed to set time zone: Invalid time zone"
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False):
with mock.patch("subprocess.run", return_value=mock_result):
result = set_timezone("Invalid/Timezone")
assert result["success"] is False
assert "Invalid" in result["error"]
def test_handles_empty_timezone(self):
"""Should reject empty timezone strings."""
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False):
result = set_timezone("")
assert result["success"] is False
assert "empty" in result["error"].lower()
def test_handles_timedatectl_not_found(self):
"""Should handle timedatectl not being available."""
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False):
with mock.patch("subprocess.run", side_effect=FileNotFoundError()):
result = set_timezone("America/Denver")
assert result["success"] is False
assert "not found" in result["error"]
class TestApplyTimezoneFromConfig:
"""Tests for apply_timezone_from_config function."""
def test_skips_in_docker_mode(self):
"""Should do nothing in Docker mode."""
with mock.patch("controller.lib.admin.is_docker_mode", return_value=True):
with mock.patch("controller.lib.admin.set_timezone") as mock_set:
apply_timezone_from_config()
mock_set.assert_not_called()
def test_applies_timezone_from_config(self, tmp_path):
"""Should read timezone from wrolpi.yaml and apply it."""
config_dir = tmp_path / 'config'
config_dir.mkdir()
config_file = config_dir / 'wrolpi.yaml'
config_file.write_text("timezone: America/New_York\n")
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False):
with mock.patch("controller.lib.admin.get_media_directory", return_value=tmp_path):
with mock.patch("controller.lib.admin.set_timezone", return_value={"success": True}) as mock_set:
apply_timezone_from_config()
mock_set.assert_called_once_with("America/New_York")
def test_skips_when_no_timezone_in_config(self, tmp_path):
"""Should do nothing when timezone is not set in config."""
config_dir = tmp_path / 'config'
config_dir.mkdir()
config_file = config_dir / 'wrolpi.yaml'
config_file.write_text("download_wait: 60\n")
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False):
with mock.patch("controller.lib.admin.get_media_directory", return_value=tmp_path):
with mock.patch("controller.lib.admin.set_timezone") as mock_set:
apply_timezone_from_config()
mock_set.assert_not_called()
def test_skips_when_config_file_missing(self, tmp_path):
"""Should do nothing when wrolpi.yaml doesn't exist."""
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False):
with mock.patch("controller.lib.admin.get_media_directory", return_value=tmp_path):
with mock.patch("controller.lib.admin.set_timezone") as mock_set:
apply_timezone_from_config()
mock_set.assert_not_called()

View file

@ -117,6 +117,38 @@ class TestRestartEndpoint:
assert "Docker" in response.json()["detail"]
class TestTimezoneStatusEndpoint:
"""Tests for /api/timezone/status endpoint."""
def test_timezone_status_returns_200(self, test_client):
"""Timezone status endpoint should return 200 OK."""
response = test_client.get("/api/timezone/status")
assert response.status_code == 200
def test_timezone_status_returns_expected_fields(self, test_client):
"""Timezone status should return available and timezone fields."""
response = test_client.get("/api/timezone/status")
data = response.json()
assert "available" in data
assert "timezone" in data
def test_timezone_status_shows_unavailable_in_docker(self, test_client_docker_mode):
"""Timezone should be unavailable in Docker mode."""
response = test_client_docker_mode.get("/api/timezone/status")
data = response.json()
assert data["available"] is False
class TestTimezoneSetEndpoint:
"""Tests for /api/timezone/set endpoint."""
def test_timezone_set_fails_in_docker(self, test_client_docker_mode):
"""Timezone set should fail in Docker mode."""
response = test_client_docker_mode.post("/api/timezone/set", json={"timezone": "America/Denver"})
assert response.status_code == 500
assert "Docker" in response.json()["detail"]
class TestOpenAPIIncludesAdminEndpoints:
"""Tests that OpenAPI documentation includes admin endpoints."""
@ -136,6 +168,13 @@ class TestOpenAPIIncludesAdminEndpoints:
assert "/api/throttle/enable" in data["paths"]
assert "/api/throttle/disable" in data["paths"]
def test_openapi_has_timezone_paths(self, test_client):
"""OpenAPI schema should include timezone paths."""
response = test_client.get("/openapi.json")
data = response.json()
assert "/api/timezone/status" in data["paths"]
assert "/api/timezone/set" in data["paths"]
def test_openapi_has_system_control_paths(self, test_client):
"""OpenAPI schema should include system control paths."""
response = test_client.get("/openapi.json")