Add status code sensor to Gatus integration (#178606)

This commit is contained in:
Hamish
2026-08-10 09:04:42 +02:00
committed by GitHub
parent 766af5c856
commit c70948651a
4 changed files with 82 additions and 1 deletions
+7 -1
View File
@@ -12,7 +12,7 @@ from homeassistant.components.sensor import (
SensorEntityDescription,
SensorStateClass,
)
from homeassistant.const import UnitOfTime
from homeassistant.const import EntityCategory, UnitOfTime
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
@@ -42,6 +42,12 @@ SENSOR_TYPES: tuple[GatusSensorEntityDescription, ...] = (
else None
),
),
GatusSensorEntityDescription(
key="status_code",
translation_key="status_code",
entity_category=EntityCategory.DIAGNOSTIC,
value_fn=lambda result: result.status,
),
)
@@ -33,6 +33,9 @@
"sensor": {
"response_time": {
"name": "Response time"
},
"status_code": {
"name": "Status code"
}
}
},
@@ -57,3 +57,53 @@
'state': '23.12',
})
# ---
# name: test_sensor_setup_and_states[sensor.core_backend_service_status_code-entry]
EntityRegistryEntrySnapshot({
'aliases': list([
None,
]),
'area_id': None,
'capabilities': None,
'config_entry_id': <ANY>,
'config_subentry_id': <ANY>,
'device_class': None,
'device_id': <ANY>,
'disabled_by': None,
'domain': 'sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'sensor.core_backend_service_status_code',
'has_entity_name': True,
'hidden_by': None,
'icon': None,
'id': <ANY>,
'labels': set({
}),
'name': None,
'object_id_base': 'Status code',
'options': dict({
}),
'original_device_class': None,
'original_icon': None,
'original_name': 'Status code',
'platform': 'gatus',
'previous_unique_id': None,
'suggested_object_id': None,
'supported_features': 0,
'translation_key': 'status_code',
'unique_id': '1234567890abcdef1234567890abcdef_backend_service_status_code',
'unit_of_measurement': None,
})
# ---
# name: test_sensor_setup_and_states[sensor.core_backend_service_status_code-state]
StateSnapshot({
'attributes': ReadOnlyDict({
<EntityStateAttribute.FRIENDLY_NAME: 'friendly_name'>: 'Core Backend Service Status code',
}),
'context': <ANY>,
'entity_id': 'sensor.core_backend_service_status_code',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': '200',
})
# ---
+22
View File
@@ -143,3 +143,25 @@ async def test_sensor_missing_duration(
state = hass.states.get("sensor.backend_service_response_time")
assert state is not None
assert state.state == STATE_UNKNOWN
async def test_sensor_missing_status_code(
hass: HomeAssistant,
mock_gatus_client: AsyncMock,
mock_config_entry: MockConfigEntry,
) -> None:
"""Test that a result missing status code evaluates to STATE_UNKNOWN for status code sensor."""
mock_gatus_client.get_endpoints_statuses.return_value = [
EndpointStatus(
key="backend_service",
name="Backend Service",
group=None,
results=[Result(success=True, status=None, duration=12500000)],
)
]
await setup_integration(hass, mock_config_entry)
state = hass.states.get("sensor.backend_service_status_code")
assert state is not None
assert state.state == STATE_UNKNOWN