starred/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2026-10-06 22:38:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add out of memory binary sensor to Portainer (#183224)

Browse Source
This commit is contained in:
Erwin Douna
2026-09-29 18:27:13 +02:00
committed by GitHub
parent 6d3bd33f20
commit 25970a4f60
3 changed files with 322 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
homeassistant/components/portainer/binary_sensor.py
+13 -1
View File
@@ -33,6 +33,7 @@ class PortainerContainerBinarySensorEntityDescription(BinarySensorEntityDescript
"""Class to hold Portainer container binary sensor description."""
state_fn: Callable[[PortainerContainerData], bool | None]
supported_fn: Callable[[PortainerContainerData], bool]
@dataclass(frozen=True, kw_only=True)
@@ -54,9 +55,20 @@ CONTAINER_SENSORS: tuple[PortainerContainerBinarySensorEntityDescription, ...] =
key="status",
translation_key="status",
state_fn=lambda data: data.container.state == DockerContainerState.RUNNING,
supported_fn=lambda data: data.container.state == DockerContainerState.RUNNING,
device_class=BinarySensorDeviceClass.RUNNING,
entity_category=EntityCategory.DIAGNOSTIC,
),
PortainerContainerBinarySensorEntityDescription(
key="container_out_of_memory",
translation_key="container_out_of_memory",
state_fn=lambda data: (
state.oom_killed if (state := data.container_inspect.state) else None
),
supported_fn=lambda data: data.container_inspect.state is not None,
device_class=BinarySensorDeviceClass.PROBLEM,
entity_category=EntityCategory.DIAGNOSTIC,
),
)
ENDPOINT_SENSORS: tuple[PortainerEndpointBinarySensorEntityDescription, ...] = (
@@ -114,7 +126,7 @@ async def async_setup_entry(
)
for (endpoint, container) in containers
for entity_description in CONTAINER_SENSORS
if entity_description.state_fn(container)
if entity_description.supported_fn(container)
)
def _async_add_new_stacks(
homeassistant/components/portainer/strings.json
+3
View File
@@ -56,6 +56,9 @@
},
"entity": {
"binary_sensor": {
"container_out_of_memory": {
"name": "Out of memory"
},
"status": {
"name": "Status"
}
tests/components/portainer/snapshots/test_binary_sensor.ambr
+306
View File
@@ -1,4 +1,55 @@
# serializer version: 1
# name: test_all_entities[binary_sensor.dashy_dashy_1_qgza68hnz4n1qvyz3iohynx05_out_of_memory-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': 'binary_sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'binary_sensor.dashy_dashy_1_qgza68hnz4n1qvyz3iohynx05_out_of_memory',
'has_entity_name': True,
'hidden_by': None,
'icon': None,
'id': <ANY>,
'labels': set({
}),
'name': None,
'object_id_base': 'Out of memory',
'options': dict({
}),
'original_device_class': <BinarySensorDeviceClass.PROBLEM: 'problem'>,
'original_icon': None,
'original_name': 'Out of memory',
'platform': 'portainer',
'previous_unique_id': None,
'suggested_object_id': None,
'supported_features': 0,
'translation_key': 'container_out_of_memory',
'unique_id': 'portainer_test_entry_123_dashy_dashy.1.qgza68hnz4n1qvyz3iohynx05_container_out_of_memory',
'unit_of_measurement': None,
})
# ---
# name: test_all_entities[binary_sensor.dashy_dashy_1_qgza68hnz4n1qvyz3iohynx05_out_of_memory-state]
StateSnapshot({
'attributes': ReadOnlyDict({
<EntityStateAttribute.DEVICE_CLASS: 'device_class'>: 'problem',
<EntityStateAttribute.FRIENDLY_NAME: 'friendly_name'>: 'dashy_dashy.1.qgza68hnz4n1qvyz3iohynx05 Out of memory',
}),
'context': <ANY>,
'entity_id': 'binary_sensor.dashy_dashy_1_qgza68hnz4n1qvyz3iohynx05_out_of_memory',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': 'off',
})
# ---
# name: test_all_entities[binary_sensor.dashy_dashy_1_qgza68hnz4n1qvyz3iohynx05_status-entry]
EntityRegistryEntrySnapshot({
'aliases': list([
@@ -101,6 +152,57 @@
'state': 'on',
})
# ---
# name: test_all_entities[binary_sensor.focused_einstein_out_of_memory-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': 'binary_sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'binary_sensor.focused_einstein_out_of_memory',
'has_entity_name': True,
'hidden_by': None,
'icon': None,
'id': <ANY>,
'labels': set({
}),
'name': None,
'object_id_base': 'Out of memory',
'options': dict({
}),
'original_device_class': <BinarySensorDeviceClass.PROBLEM: 'problem'>,
'original_icon': None,
'original_name': 'Out of memory',
'platform': 'portainer',
'previous_unique_id': None,
'suggested_object_id': None,
'supported_features': 0,
'translation_key': 'container_out_of_memory',
'unique_id': 'portainer_test_entry_123_focused_einstein_container_out_of_memory',
'unit_of_measurement': None,
})
# ---
# name: test_all_entities[binary_sensor.focused_einstein_out_of_memory-state]
StateSnapshot({
'attributes': ReadOnlyDict({
<EntityStateAttribute.DEVICE_CLASS: 'device_class'>: 'problem',
<EntityStateAttribute.FRIENDLY_NAME: 'friendly_name'>: 'focused_einstein Out of memory',
}),
'context': <ANY>,
'entity_id': 'binary_sensor.focused_einstein_out_of_memory',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': 'off',
})
# ---
# name: test_all_entities[binary_sensor.focused_einstein_status-entry]
EntityRegistryEntrySnapshot({
'aliases': list([
@@ -152,6 +254,57 @@
'state': 'on',
})
# ---
# name: test_all_entities[binary_sensor.funny_chatelet_out_of_memory-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': 'binary_sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'binary_sensor.funny_chatelet_out_of_memory',
'has_entity_name': True,
'hidden_by': None,
'icon': None,
'id': <ANY>,
'labels': set({
}),
'name': None,
'object_id_base': 'Out of memory',
'options': dict({
}),
'original_device_class': <BinarySensorDeviceClass.PROBLEM: 'problem'>,
'original_icon': None,
'original_name': 'Out of memory',
'platform': 'portainer',
'previous_unique_id': None,
'suggested_object_id': None,
'supported_features': 0,
'translation_key': 'container_out_of_memory',
'unique_id': 'portainer_test_entry_123_funny_chatelet_container_out_of_memory',
'unit_of_measurement': None,
})
# ---
# name: test_all_entities[binary_sensor.funny_chatelet_out_of_memory-state]
StateSnapshot({
'attributes': ReadOnlyDict({
<EntityStateAttribute.DEVICE_CLASS: 'device_class'>: 'problem',
<EntityStateAttribute.FRIENDLY_NAME: 'friendly_name'>: 'funny_chatelet Out of memory',
}),
'context': <ANY>,
'entity_id': 'binary_sensor.funny_chatelet_out_of_memory',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': 'off',
})
# ---
# name: test_all_entities[binary_sensor.funny_chatelet_status-entry]
EntityRegistryEntrySnapshot({
'aliases': list([
@@ -254,6 +407,57 @@
'state': 'on',
})
# ---
# name: test_all_entities[binary_sensor.practical_morse_out_of_memory-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': 'binary_sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'binary_sensor.practical_morse_out_of_memory',
'has_entity_name': True,
'hidden_by': None,
'icon': None,
'id': <ANY>,
'labels': set({
}),
'name': None,
'object_id_base': 'Out of memory',
'options': dict({
}),
'original_device_class': <BinarySensorDeviceClass.PROBLEM: 'problem'>,
'original_icon': None,
'original_name': 'Out of memory',
'platform': 'portainer',
'previous_unique_id': None,
'suggested_object_id': None,
'supported_features': 0,
'translation_key': 'container_out_of_memory',
'unique_id': 'portainer_test_entry_123_practical_morse_container_out_of_memory',
'unit_of_measurement': None,
})
# ---
# name: test_all_entities[binary_sensor.practical_morse_out_of_memory-state]
StateSnapshot({
'attributes': ReadOnlyDict({
<EntityStateAttribute.DEVICE_CLASS: 'device_class'>: 'problem',
<EntityStateAttribute.FRIENDLY_NAME: 'friendly_name'>: 'practical_morse Out of memory',
}),
'context': <ANY>,
'entity_id': 'binary_sensor.practical_morse_out_of_memory',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': 'off',
})
# ---
# name: test_all_entities[binary_sensor.practical_morse_status-entry]
EntityRegistryEntrySnapshot({
'aliases': list([
@@ -305,6 +509,57 @@
'state': 'on',
})
# ---
# name: test_all_entities[binary_sensor.serene_banach_out_of_memory-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': 'binary_sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'binary_sensor.serene_banach_out_of_memory',
'has_entity_name': True,
'hidden_by': None,
'icon': None,
'id': <ANY>,
'labels': set({
}),
'name': None,
'object_id_base': 'Out of memory',
'options': dict({
}),
'original_device_class': <BinarySensorDeviceClass.PROBLEM: 'problem'>,
'original_icon': None,
'original_name': 'Out of memory',
'platform': 'portainer',
'previous_unique_id': None,
'suggested_object_id': None,
'supported_features': 0,
'translation_key': 'container_out_of_memory',
'unique_id': 'portainer_test_entry_123_serene_banach_container_out_of_memory',
'unit_of_measurement': None,
})
# ---
# name: test_all_entities[binary_sensor.serene_banach_out_of_memory-state]
StateSnapshot({
'attributes': ReadOnlyDict({
<EntityStateAttribute.DEVICE_CLASS: 'device_class'>: 'problem',
<EntityStateAttribute.FRIENDLY_NAME: 'friendly_name'>: 'serene_banach Out of memory',
}),
'context': <ANY>,
'entity_id': 'binary_sensor.serene_banach_out_of_memory',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': 'off',
})
# ---
# name: test_all_entities[binary_sensor.serene_banach_status-entry]
EntityRegistryEntrySnapshot({
'aliases': list([
@@ -356,6 +611,57 @@
'state': 'on',
})
# ---
# name: test_all_entities[binary_sensor.stoic_turing_out_of_memory-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': 'binary_sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'binary_sensor.stoic_turing_out_of_memory',
'has_entity_name': True,
'hidden_by': None,
'icon': None,
'id': <ANY>,
'labels': set({
}),
'name': None,
'object_id_base': 'Out of memory',
'options': dict({
}),
'original_device_class': <BinarySensorDeviceClass.PROBLEM: 'problem'>,
'original_icon': None,
'original_name': 'Out of memory',
'platform': 'portainer',
'previous_unique_id': None,
'suggested_object_id': None,
'supported_features': 0,
'translation_key': 'container_out_of_memory',
'unique_id': 'portainer_test_entry_123_stoic_turing_container_out_of_memory',
'unit_of_measurement': None,
})
# ---
# name: test_all_entities[binary_sensor.stoic_turing_out_of_memory-state]
StateSnapshot({
'attributes': ReadOnlyDict({
<EntityStateAttribute.DEVICE_CLASS: 'device_class'>: 'problem',
<EntityStateAttribute.FRIENDLY_NAME: 'friendly_name'>: 'stoic_turing Out of memory',
}),
'context': <ANY>,
'entity_id': 'binary_sensor.stoic_turing_out_of_memory',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': 'off',
})
# ---
# name: test_all_entities[binary_sensor.stoic_turing_status-entry]
EntityRegistryEntrySnapshot({
'aliases': list([