mirror of
https://github.com/home-assistant/core.git
synced 2025-11-13 04:50:17 +00:00
Azure DevOps build sensor attributes to new sensors (#114948)
* Setup for split * Adjust to allow for None * Create * Add missing * Fix datetime parsing in Azure DevOps sensor * Remove definition id and name These aren't needed and will never change * Add tests for each sensor * Add tests for edge cases * Rename translations * Update * Use base sensor descriptions * Remove * Drop status using this later for an event entity * Switch to timestamp * Switch to timestamp * Merge * Update snapshot * Improvements from @joostlek * Update homeassistant/components/azure_devops/sensor.py --------- Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
This commit is contained in:
Aidan Timson
@@ -2,89 +2,186 @@
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from collections.abc import Callable
|
||||
from collections.abc import Callable, Mapping
|
||||
from dataclasses import dataclass
|
||||
from datetime import datetime
|
||||
import logging
|
||||
from typing import Any
|
||||
|
||||
from aioazuredevops.builds import DevOpsBuild
|
||||
|
||||
from homeassistant.components.sensor import SensorEntity, SensorEntityDescription
|
||||
from homeassistant.components.sensor import (
|
||||
SensorDeviceClass,
|
||||
SensorEntity,
|
||||
SensorEntityDescription,
|
||||
)
|
||||
from homeassistant.config_entries import ConfigEntry
|
||||
from homeassistant.core import HomeAssistant
|
||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||
from homeassistant.helpers.typing import StateType
|
||||
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
|
||||
from homeassistant.util import dt as dt_util
|
||||
|
||||
from . import AzureDevOpsDeviceEntity, AzureDevOpsEntityDescription
|
||||
from . import AzureDevOpsEntity
|
||||
from .const import CONF_ORG, DOMAIN
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
@dataclass(frozen=True, kw_only=True)
|
||||
class AzureDevOpsSensorEntityDescription(
|
||||
AzureDevOpsEntityDescription, SensorEntityDescription
|
||||
):
|
||||
"""Class describing Azure DevOps sensor entities."""
|
||||
class AzureDevOpsBuildSensorEntityDescription(SensorEntityDescription):
|
||||
"""Class describing Azure DevOps base build sensor entities."""
|
||||
|
||||
build_key: int
|
||||
attrs: Callable[[DevOpsBuild], Any]
|
||||
value: Callable[[DevOpsBuild], StateType]
|
||||
attr_fn: Callable[[DevOpsBuild], dict[str, Any] | None] = lambda _: None
|
||||
value_fn: Callable[[DevOpsBuild], datetime | StateType]
|
||||
|
||||
|
||||
BASE_BUILD_SENSOR_DESCRIPTIONS: tuple[AzureDevOpsBuildSensorEntityDescription, ...] = (
|
||||
# Attributes are deprecated in 2024.7 and can be removed in 2025.1
|
||||
AzureDevOpsBuildSensorEntityDescription(
|
||||
key="latest_build",
|
||||
translation_key="latest_build",
|
||||
attr_fn=lambda build: {
|
||||
"definition_id": (build.definition.build_id if build.definition else None),
|
||||
"definition_name": (build.definition.name if build.definition else None),
|
||||
"id": build.build_id,
|
||||
"reason": build.reason,
|
||||
"result": build.result,
|
||||
"source_branch": build.source_branch,
|
||||
"source_version": build.source_version,
|
||||
"status": build.status,
|
||||
"url": build.links.web if build.links else None,
|
||||
"queue_time": build.queue_time,
|
||||
"start_time": build.start_time,
|
||||
"finish_time": build.finish_time,
|
||||
},
|
||||
value_fn=lambda build: build.build_number,
|
||||
),
|
||||
AzureDevOpsBuildSensorEntityDescription(
|
||||
key="build_id",
|
||||
translation_key="build_id",
|
||||
entity_registry_visible_default=False,
|
||||
value_fn=lambda build: build.build_id,
|
||||
),
|
||||
AzureDevOpsBuildSensorEntityDescription(
|
||||
key="reason",
|
||||
translation_key="reason",
|
||||
entity_registry_visible_default=False,
|
||||
value_fn=lambda build: build.reason,
|
||||
),
|
||||
AzureDevOpsBuildSensorEntityDescription(
|
||||
key="result",
|
||||
translation_key="result",
|
||||
entity_registry_visible_default=False,
|
||||
value_fn=lambda build: build.result,
|
||||
),
|
||||
AzureDevOpsBuildSensorEntityDescription(
|
||||
key="source_branch",
|
||||
translation_key="source_branch",
|
||||
entity_registry_enabled_default=False,
|
||||
entity_registry_visible_default=False,
|
||||
value_fn=lambda build: build.source_branch,
|
||||
),
|
||||
AzureDevOpsBuildSensorEntityDescription(
|
||||
key="source_version",
|
||||
translation_key="source_version",
|
||||
entity_registry_visible_default=False,
|
||||
value_fn=lambda build: build.source_version,
|
||||
),
|
||||
AzureDevOpsBuildSensorEntityDescription(
|
||||
key="queue_time",
|
||||
translation_key="queue_time",
|
||||
device_class=SensorDeviceClass.TIMESTAMP,
|
||||
entity_registry_enabled_default=False,
|
||||
entity_registry_visible_default=False,
|
||||
value_fn=lambda build: parse_datetime(build.queue_time),
|
||||
),
|
||||
AzureDevOpsBuildSensorEntityDescription(
|
||||
key="start_time",
|
||||
translation_key="start_time",
|
||||
device_class=SensorDeviceClass.TIMESTAMP,
|
||||
entity_registry_visible_default=False,
|
||||
value_fn=lambda build: parse_datetime(build.start_time),
|
||||
),
|
||||
AzureDevOpsBuildSensorEntityDescription(
|
||||
key="finish_time",
|
||||
translation_key="finish_time",
|
||||
device_class=SensorDeviceClass.TIMESTAMP,
|
||||
entity_registry_visible_default=False,
|
||||
value_fn=lambda build: parse_datetime(build.finish_time),
|
||||
),
|
||||
AzureDevOpsBuildSensorEntityDescription(
|
||||
key="url",
|
||||
translation_key="url",
|
||||
value_fn=lambda build: build.links.web if build.links else None,
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
def parse_datetime(value: str | None) -> datetime | None:
|
||||
"""Parse datetime string."""
|
||||
if value is None:
|
||||
return None
|
||||
|
||||
return dt_util.parse_datetime(value)
|
||||
|
||||
|
||||
async def async_setup_entry(
|
||||
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
|
||||
hass: HomeAssistant,
|
||||
entry: ConfigEntry,
|
||||
async_add_entities: AddEntitiesCallback,
|
||||
) -> None:
|
||||
"""Set up Azure DevOps sensor based on a config entry."""
|
||||
coordinator, project = hass.data[DOMAIN][entry.entry_id]
|
||||
initial_builds: list[DevOpsBuild] = coordinator.data
|
||||
|
||||
sensors = [
|
||||
AzureDevOpsSensor(
|
||||
async_add_entities(
|
||||
AzureDevOpsBuildSensor(
|
||||
coordinator,
|
||||
AzureDevOpsSensorEntityDescription(
|
||||
key=f"{build.project.project_id}_{build.definition.build_id}_latest_build",
|
||||
translation_key="latest_build",
|
||||
translation_placeholders={"definition_name": build.definition.name},
|
||||
attrs=lambda build: {
|
||||
"definition_id": (
|
||||
build.definition.build_id if build.definition else None
|
||||
),
|
||||
"definition_name": (
|
||||
build.definition.name if build.definition else None
|
||||
),
|
||||
"id": build.build_id,
|
||||
"reason": build.reason,
|
||||
"result": build.result,
|
||||
"source_branch": build.source_branch,
|
||||
"source_version": build.source_version,
|
||||
"status": build.status,
|
||||
"url": build.links.web if build.links else None,
|
||||
"queue_time": build.queue_time,
|
||||
"start_time": build.start_time,
|
||||
"finish_time": build.finish_time,
|
||||
},
|
||||
build_key=key,
|
||||
organization=entry.data[CONF_ORG],
|
||||
project=project,
|
||||
value=lambda build: build.build_number,
|
||||
),
|
||||
description,
|
||||
entry.data[CONF_ORG],
|
||||
project.name,
|
||||
key,
|
||||
)
|
||||
for key, build in enumerate(coordinator.data)
|
||||
]
|
||||
|
||||
async_add_entities(sensors, True)
|
||||
for description in BASE_BUILD_SENSOR_DESCRIPTIONS
|
||||
for key, build in enumerate(initial_builds)
|
||||
if build.project and build.definition
|
||||
)
|
||||
|
||||
|
||||
class AzureDevOpsSensor(AzureDevOpsDeviceEntity, SensorEntity):
|
||||
"""Define a Azure DevOps sensor."""
|
||||
class AzureDevOpsBuildSensor(AzureDevOpsEntity, SensorEntity):
|
||||
"""Define a Azure DevOps build sensor."""
|
||||
|
||||
entity_description: AzureDevOpsSensorEntityDescription
|
||||
entity_description: AzureDevOpsBuildSensorEntityDescription
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
coordinator: DataUpdateCoordinator[list[DevOpsBuild]],
|
||||
description: AzureDevOpsBuildSensorEntityDescription,
|
||||
organization: str,
|
||||
project_name: str,
|
||||
item_key: int,
|
||||
) -> None:
|
||||
"""Initialize."""
|
||||
super().__init__(coordinator, organization, project_name)
|
||||
self.entity_description = description
|
||||
self.item_key = item_key
|
||||
self._attr_unique_id = f"{organization}_{self.build.project.project_id}_{self.build.definition.build_id}_{description.key}"
|
||||
self._attr_translation_placeholders = {
|
||||
"definition_name": self.build.definition.name
|
||||
}
|
||||
|
||||
@property
|
||||
def native_value(self) -> StateType:
|
||||
def build(self) -> DevOpsBuild:
|
||||
"""Return the build."""
|
||||
return self.coordinator.data[self.item_key]
|
||||
|
||||
@property
|
||||
def native_value(self) -> datetime | StateType:
|
||||
"""Return the state."""
|
||||
build: DevOpsBuild = self.coordinator.data[self.entity_description.build_key]
|
||||
return self.entity_description.value(build)
|
||||
return self.entity_description.value_fn(self.build)
|
||||
|
||||
@property
|
||||
def extra_state_attributes(self) -> dict[str, Any]:
|
||||
def extra_state_attributes(self) -> Mapping[str, Any] | None:
|
||||
"""Return the state attributes of the entity."""
|
||||
build: DevOpsBuild = self.coordinator.data[self.entity_description.build_key]
|
||||
return self.entity_description.attrs(build)
|
||||
return self.entity_description.attr_fn(self.build)
|
||||
|
||||
Reference in New Issue
Block a user