Files
wecker/tests/test_api.py
T
Markus Graf 558c4ff5b6 Add isRinging query to check alarm state via API
Features:
- New GraphQL query 'isRinging' returns true/false if wecker is active
- Checks the wecker process via PID file (PID_FILE in common.py)

DRY refactoring:
- Extract PID_FILE into shared common.py module
- Both wecker.py and api/schema.py import from common
- DRY enforcement tests verify identity (is) not just equality

Tests:
- test_is_ringing_returns_false_when_not_running
- test_is_ringing_returns_true_when_running
- test_pid_file_defined_once_across_modules (DRY enforcement)
- test_pid_file_same_shared_constant_in_api (DRY enforcement)
- Cleaned up unused imports in test_single_instance.py

Docs:
- Updated README.md with isRinging query documentation
2026-05-19 15:15:05 +02:00

214 lines
6.0 KiB
Python

from unittest.mock import patch
from fastapi.testclient import TestClient
import tempfile
import os
# We need to set the environment variable before importing the app
os.environ["API_KEY"] = "test-secret"
dummy_tab = tempfile.mktemp()
with open(dummy_tab, "w") as f:
f.write("")
os.environ["TABFILE"] = dummy_tab
from api.main import app # noqa: E402
client = TestClient(app)
def test_is_ringing_returns_false_when_not_running():
"""Test that isRinging returns False when no wecker process is running."""
headers = {"X-API-Key": "test-secret"}
query = """
query {
isRinging
}
"""
res = client.post("/graphql", json={"query": query}, headers=headers)
assert res.status_code == 200
assert res.json()["data"]["isRinging"] is False
@patch("api.schema.is_wecker_ringing", return_value=True)
def test_is_ringing_returns_true_when_running(mock_is_ringing):
"""Test that isRinging returns True when a wecker process is running."""
headers = {"X-API-Key": "test-secret"}
query = """
query {
isRinging
}
"""
res = client.post("/graphql", json={"query": query}, headers=headers)
assert res.status_code == 200
assert res.json()["data"]["isRinging"] is True
def test_auth_missing():
query = """
query {
getAlarms {
id
}
}
"""
response = client.post("/graphql", json={"query": query})
assert response.status_code == 401
def test_auth_invalid():
query = """
query {
getAlarms {
id
}
}
"""
response = client.post(
"/graphql", json={"query": query}, headers={"X-API-Key": "wrong"}
)
assert response.status_code == 401
def test_bugfix_default_command_uses_append_for_logs():
"""
Test for bugfix: Ensure the default command appends (>>) to wecker.log
instead of overwriting (>) it.
"""
from api.schema import Mutation
mutation = Mutation()
# Call the resolver directly without command to trigger default command generation
alarm = mutation.set_alarm(cron_expression="0 9 * * *")
# Verify the generated command string
command = alarm.command
assert ">> wecker.log 2>&1" in command, (
f"Command must use append '>>' syntax. Got: {command}"
)
assert "> wecker.log 2>&1" not in command.replace(">> wecker.log", "REPLACED"), (
"Command must not use overwrite '>'"
)
# Cleanup
mutation.delete_alarm(id=alarm.id)
def test_set_alarm_default_command_append():
headers = {"X-API-Key": "test-secret"}
mutation = """
mutation {
setAlarm(cronExpression: "0 9 * * *") {
id
command
}
}
"""
res = client.post("/graphql", json={"query": mutation}, headers=headers)
assert res.status_code == 200
data = res.json()["data"]["setAlarm"]
# Assert the command contains the correct append syntax (>>) and not just overwrite (>)
command = data["command"]
assert ">> wecker.log 2>&1" in command
assert "> wecker.log 2>&1" not in command.replace(">> wecker.log", "REPLACED")
# Cleanup so we don't break subsequent tests
alarm_id = data["id"]
mutation_delete = f"""
mutation {{
deleteAlarm(id: "{alarm_id}")
}}
"""
client.post("/graphql", json={"query": mutation_delete}, headers=headers)
def test_graphql_workflow():
headers = {"X-API-Key": "test-secret"}
# 1. Get empty alarms
query_get = """
query {
getAlarms {
id
}
}
"""
res = client.post("/graphql", json={"query": query_get}, headers=headers)
assert res.status_code == 200
assert res.json()["data"]["getAlarms"] == []
# 2. Set alarm
mutation_set = """
mutation {
setAlarm(cronExpression: "30 7 * * *", command: "python wecker.py", isEnabled: true) {
id
cronExpression
command
isEnabled
}
}
"""
res = client.post("/graphql", json={"query": mutation_set}, headers=headers)
assert res.status_code == 200
alarm = res.json()["data"]["setAlarm"]
assert alarm["cronExpression"] == "30 7 * * *"
assert alarm["command"] == "python wecker.py"
assert alarm["isEnabled"] is True
alarm_id = alarm["id"]
# 3. Get alarms lists it
res = client.post("/graphql", json={"query": query_get}, headers=headers)
assert len(res.json()["data"]["getAlarms"]) == 1
assert res.json()["data"]["getAlarms"][0]["id"] == alarm_id
# 4. Get specific alarm
query_one = f"""
query {{
getAlarm(id: "{alarm_id}") {{
id
cronExpression
}}
}}
"""
res = client.post("/graphql", json={"query": query_one}, headers=headers)
assert res.json()["data"]["getAlarm"]["id"] == alarm_id
assert res.json()["data"]["getAlarm"]["cronExpression"] == "30 7 * * *"
# 5. Update alarm
mutation_update = f"""
mutation {{
setAlarm(id: "{alarm_id}", cronExpression: "0 8 * * *", command: "python wecker.py", isEnabled: false) {{
id
cronExpression
isEnabled
}}
}}
"""
res = client.post("/graphql", json={"query": mutation_update}, headers=headers)
alarm_updated = res.json()["data"]["setAlarm"]
assert alarm_updated["id"] == alarm_id
assert alarm_updated["cronExpression"] == "0 8 * * *"
assert alarm_updated["isEnabled"] is False
# 6. Delete alarm
mutation_delete = f"""
mutation {{
deleteAlarm(id: "{alarm_id}")
}}
"""
res = client.post("/graphql", json={"query": mutation_delete}, headers=headers)
assert res.json()["data"]["deleteAlarm"] is True
# 7. List again is empty
res = client.post("/graphql", json={"query": query_get}, headers=headers)
assert res.json()["data"]["getAlarms"] == []
def test_pid_file_same_shared_constant_in_api():
"""Ensure api.schema uses the same PID_FILE from common, not a redefinition."""
from api import schema as api_schema
import common
assert api_schema.PID_FILE is common.PID_FILE, (
"api.schema.PID_FILE must reference common.PID_FILE, not redefine it"
)