Add certificate expiration sensor to Gatus integration

homeassistant/components/gatus/sensor.py

@@ -48,6 +48,18 @@ class GatusSensorEntityDescription(SensorEntityDescription):
         entity_category=EntityCategory.DIAGNOSTIC,
         value_fn=lambda result: result.status,
     ),
+    GatusSensorEntityDescription(
+        key="certificate_expiration",
+        translation_key="certificate_expiration",
+        device_class=SensorDeviceClass.DURATION,
+        native_unit_of_measurement=UnitOfTime.DAYS,
+        entity_category=EntityCategory.DIAGNOSTIC,
+        value_fn=lambda result: (
+            round(result.certificate_expiration / 86_400_000_000_000, 2)
+            if result.certificate_expiration is not None
+            else None
+        ),
+    ),
 )
 
 
@@ -61,8 +73,10 @@ async def async_setup_entry(
 
     async_add_entities(
         GatusEndpointSensor(coordinator, entry, endpoint_key, description)
-        for endpoint_key in coordinator.data
+        for endpoint_key, endpoint in coordinator.data.items()
         for description in SENSOR_TYPES
+        if description.key != "certificate_expiration"
+        or (endpoint.results and endpoint.results[-1].certificate_expiration is not None)
     )
 
 

homeassistant/components/gatus/strings.json

@@ -31,6 +31,9 @@
   },
   "entity": {
     "sensor": {
+      "certificate_expiration": {
+        "name": "Certificate expiration"
+      },
       "response_time": {
         "name": "Response time"
       },

tests/components/gatus/conftest.py

@@ -41,7 +41,14 @@ def mock_gatus_client() -> Generator[AsyncMock]:
                     key="backend_service",
                     name="Backend Service",
                     group="Core",
-                    results=[Result(success=True, status=200, duration=23123100)],
+                    results=[
+                        Result(
+                            success=True,
+                            status=200,
+                            duration=23123100,
+                            certificate_expiration=7776000000000000,
+                        )
+                    ],
                 )
             ]
         )

tests/components/gatus/snapshots/test_sensor.ambr

@@ -1,4 +1,59 @@
 # serializer version: 1
+# name: test_sensor_setup_and_states[sensor.core_backend_service_duration-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_duration',
+    'has_entity_name': True,
+    'hidden_by': None,
+    'icon': None,
+    'id': <ANY>,
+    'labels': set({
+    }),
+    'name': None,
+    'object_id_base': 'Duration',
+    'options': dict({
+      'sensor': dict({
+        'suggested_display_precision': 2,
+      }),
+    }),
+    'original_device_class': <SensorDeviceClass.DURATION: 'duration'>,
+    'original_icon': None,
+    'original_name': 'Duration',
+    'platform': 'gatus',
+    'previous_unique_id': None,
+    'suggested_object_id': None,
+    'supported_features': 0,
+    'translation_key': 'certificate_expiration',
+    'unique_id': '1234567890abcdef1234567890abcdef_backend_service_certificate_expiration',
+    'unit_of_measurement': <UnitOfTime.DAYS: 'd'>,
+  })
+# ---
+# name: test_sensor_setup_and_states[sensor.core_backend_service_duration-state]
+  StateSnapshot({
+    'attributes': ReadOnlyDict({
+      <EntityStateAttribute.DEVICE_CLASS: 'device_class'>: 'duration',
+      <EntityStateAttribute.FRIENDLY_NAME: 'friendly_name'>: 'Core Backend Service Duration',
+      <EntityStateAttribute.UNIT_OF_MEASUREMENT: 'unit_of_measurement'>: <UnitOfTime.DAYS: 'd'>,
+    }),
+    'context': <ANY>,
+    'entity_id': 'sensor.core_backend_service_duration',
+    'last_changed': <ANY>,
+    'last_reported': <ANY>,
+    'last_updated': <ANY>,
+    'state': '90.0',
+  })
+# ---
 # name: test_sensor_setup_and_states[sensor.core_backend_service_response_time-entry]
   EntityRegistryEntrySnapshot({
     'aliases': list([

tests/components/gatus/test_sensor.py

@@ -47,6 +47,7 @@ def _to_endpoint_statuses(raw_data: list[dict[str, Any]]) -> list[EndpointStatus
                     success=r["success"],
                     status=r.get("status"),
                     duration=r.get("duration"),
+                    certificate_expiration=r.get("certificateExpiration"),
                 )
                 for r in ep.get("results", [])
             ],
@@ -165,3 +166,31 @@ async def test_sensor_missing_status_code(
     state = hass.states.get("sensor.backend_service_status_code")
     assert state is not None
     assert state.state == STATE_UNKNOWN
+
+
+async def test_sensor_missing_certificate_expiration(
+    hass: HomeAssistant,
+    mock_gatus_client: AsyncMock,
+    mock_config_entry: MockConfigEntry,
+) -> None:
+    """Test that a result missing certificate expiration creates no entity."""
+    mock_gatus_client.get_endpoints_statuses.return_value = [
+        EndpointStatus(
+            key="backend_service",
+            name="Backend Service",
+            group=None,
+            results=[
+                Result(
+                    success=True,
+                    status=200,
+                    duration=12500000,
+                    certificate_expiration=None,
+                )
+            ],
+        )
+    ]
+
+    await setup_integration(hass, mock_config_entry)
+
+    state = hass.states.get("sensor.backend_service_certificate_expiration")
+    assert state is None