9308287737

Committed 30 May 2024 07:45PM UTC coverage: 81.983% (-1.0%) from 83.029%

Build # 9308287737

Build Type

Pull #1111

github

Committed by

web-flow

Commit Message

Merge c773c03af into 7f6be196c

Pull Request Pull Request #1111: Support service calls with return values in codegen

Run Details

871 of 1209 branches covered (72.04%)

Branch coverage included in aggregate %.

32 of 74 new or added lines in 5 files covered. (43.24%)

14 existing lines in 1 file now uncovered.

3256 of 3825 relevant lines covered (85.12%)

81.06 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

63.64

/src/HassModel/NetDeamon.HassModel/Entities/EntityExtensions.cs

﻿namespace NetDaemon.HassModel.Entities;

/// <summary>
/// Provides Extension methods for Entities
/// </summary>
public static class EntityExtensions
{
    /// <summary>
    /// Checks if an EntityState has the state "on"
    /// </summary>
    /// <param name="entityState">The state to check</param>
    /// <returns>true if the state equals "on", otherwise false</returns>
    public static bool IsOn([NotNullWhen(true)] this EntityState? entityState) => string.Equals(entityState?.State, "on", StringComparison.OrdinalIgnoreCase);

    /// <summary>
    /// Checks if an EntityState has the state "off"
    /// </summary>
    /// <param name="entityState">The state to check</param>
    /// <returns>true if the state equals "off", otherwise false</returns>
    public static bool IsOff([NotNullWhen(true)] this EntityState? entityState) => string.Equals(entityState?.State, "off", StringComparison.OrdinalIgnoreCase);

    /// <summary>
    /// Checks if an Entity has the state "on"
    /// </summary>
    /// <param name="entity">The state to check</param>
    /// <returns>true if the state equals "on", otherwise false</returns>
    public static bool IsOn([NotNullWhen(true)] this Entity? entity) => entity?.EntityState?.IsOn() ?? false;

    /// <summary>
    /// Checks if an Entity has the state "off"
    /// </summary>
    /// <param name="entity">The state to check</param>
    /// <returns>true if the state equals "off", otherwise false</returns>
    public static bool IsOff([NotNullWhen(true)] this Entity? entity) => entity?.EntityState?.IsOff() ?? false;

    /// <summary>Gets a NumericEntity from a given Entity</summary>
    public static NumericEntity AsNumeric(this Entity entity) => new(entity);

    /// <summary>Gets a NumericEntity from a given Entity</summary>
    public static NumericEntity<TAttributes>
        AsNumeric<TEntity, TEntityState, TAttributes>(this Entity<TEntity, TEntityState, TAttributes> entity)
        where TEntity : Entity<TEntity, TEntityState, TAttributes>
        where TEntityState : EntityState<TAttributes>
        where TAttributes : class
        => new(entity);

    /// <summary>Gets a new Entity from this Entity with the specified type of attributes</summary>
    public static Entity<TAttributes> WithAttributesAs<TAttributes>(this Entity entity)
        where TAttributes : class
        => new(entity);

    /// <summary>Gets a new Entity from this Entity with the specified type of attributes</summary>
    public static NumericEntity<TAttributes> WithAttributesAs<TAttributes>(this NumericEntity entity)
        where TAttributes : class
        => new (entity);

    internal static IObservable<T> StateChangesOnly<T>(this IObservable<T> changes) where T : StateChange
        => changes.Where(c => c.New?.State != c.Old?.State);

    /// <summary>
    /// Calls a service using this entity as the target
    /// </summary>
    /// <param name="entity">The Entity to call the service for</param>
    /// <param name="service">Name of the service to call. If the Domain of the service is the same as the domain of the Entity it can be omitted</param>
    /// <param name="data">Data to provide</param>
    public static void CallService(this IEntityCore entity, string service, object? data = null)
    {
        ArgumentNullException.ThrowIfNull(entity);
        ArgumentNullException.ThrowIfNull(service);

        var (serviceDomain, serviceName) = service.SplitAtDot();

        serviceDomain ??= entity.EntityId.SplitAtDot().Left ?? throw new InvalidOperationException("EntityId must be formatted 'domain.name'");

        entity.HaContext.CallService(serviceDomain, serviceName, ServiceTarget.FromEntity(entity.EntityId), data);
    }

    /// <summary>
    /// Calls a service using this entity as the target
    /// </summary>
    /// <param name="entity">The Entity to call the service for</param>
    /// <param name="service">Name of the service to call. If the Domain of the service is the same as the domain of the Entity it can be omitted</param>
    /// <param name="data">Data to provide</param>
    public static Task<JsonElement?> CallServiceWithResponseAsync(this IEntityCore entity, string service, object? data = null)
    {
        ArgumentNullException.ThrowIfNull(entity);
        ArgumentNullException.ThrowIfNull(service);

        var (serviceDomain, serviceName) = service.SplitAtDot();

        serviceDomain ??= entity.EntityId.SplitAtDot().Left ?? throw new InvalidOperationException("EntityId must be formatted 'domain.name'");

        return entity.HaContext.CallServiceWithResponseAsync(serviceDomain, serviceName, ServiceTarget.FromEntity(entity.EntityId), data);
    }
}

1	namespace NetDaemon.HassModel.Entities;
2
3	/// <summary>
4	/// Provides Extension methods for Entities
5	/// </summary>
6	public static class EntityExtensions
7	{
8	/// <summary>
9	/// Checks if an EntityState has the state "on"
10	/// </summary>
11	/// <param name="entityState">The state to check</param>
12	/// <returns>true if the state equals "on", otherwise false</returns>
13	public static bool IsOn([NotNullWhen(true)] this EntityState? entityState) => string.Equals(entityState?.State, "on", StringComparison.OrdinalIgnoreCase);	24!
14
15	/// <summary>
16	/// Checks if an EntityState has the state "off"
17	/// </summary>
18	/// <param name="entityState">The state to check</param>
19	/// <returns>true if the state equals "off", otherwise false</returns>
20	public static bool IsOff([NotNullWhen(true)] this EntityState? entityState) => string.Equals(entityState?.State, "off", StringComparison.OrdinalIgnoreCase);	12!
21
22	/// <summary>
23	/// Checks if an Entity has the state "on"
24	/// </summary>
25	/// <param name="entity">The state to check</param>
26	/// <returns>true if the state equals "on", otherwise false</returns>
27	public static bool IsOn([NotNullWhen(true)] this Entity? entity) => entity?.EntityState?.IsOn() ?? false;	6!
28
29	/// <summary>
30	/// Checks if an Entity has the state "off"
31	/// </summary>
32	/// <param name="entity">The state to check</param>
33	/// <returns>true if the state equals "off", otherwise false</returns>
34	public static bool IsOff([NotNullWhen(true)] this Entity? entity) => entity?.EntityState?.IsOff() ?? false;	6!
35
36	/// <summary>Gets a NumericEntity from a given Entity</summary>
37	public static NumericEntity AsNumeric(this Entity entity) => new(entity);	2✔
38
39	/// <summary>Gets a NumericEntity from a given Entity</summary>
40	public static NumericEntity<TAttributes>
41	AsNumeric<TEntity, TEntityState, TAttributes>(this Entity<TEntity, TEntityState, TAttributes> entity)
42	where TEntity : Entity<TEntity, TEntityState, TAttributes>
43	where TEntityState : EntityState<TAttributes>
44	where TAttributes : class
45	=> new(entity);	2✔
46
47	/// <summary>Gets a new Entity from this Entity with the specified type of attributes</summary>
48	public static Entity<TAttributes> WithAttributesAs<TAttributes>(this Entity entity)
49	where TAttributes : class
50	=> new(entity);	1✔
51
52	/// <summary>Gets a new Entity from this Entity with the specified type of attributes</summary>
53	public static NumericEntity<TAttributes> WithAttributesAs<TAttributes>(this NumericEntity entity)
54	where TAttributes : class
55	=> new (entity);	2✔
56
57	internal static IObservable<T> StateChangesOnly<T>(this IObservable<T> changes) where T : StateChange
58	=> changes.Where(c => c.New?.State != c.Old?.State);	76✔
59
60	/// <summary>
61	/// Calls a service using this entity as the target
62	/// </summary>
63	/// <param name="entity">The Entity to call the service for</param>
64	/// <param name="service">Name of the service to call. If the Domain of the service is the same as the domain of the Entity it can be omitted</param>
65	/// <param name="data">Data to provide</param>
66	public static void CallService(this IEntityCore entity, string service, object? data = null)
67	{
68	ArgumentNullException.ThrowIfNull(entity);	1✔
69	ArgumentNullException.ThrowIfNull(service);	1✔
70
71	var (serviceDomain, serviceName) = service.SplitAtDot();	1✔
72
73	serviceDomain ??= entity.EntityId.SplitAtDot().Left ?? throw new InvalidOperationException("EntityId must be formatted 'domain.name'");	1!
74
75	entity.HaContext.CallService(serviceDomain, serviceName, ServiceTarget.FromEntity(entity.EntityId), data);	1✔
76	}	1✔
77
78	/// <summary>
79	/// Calls a service using this entity as the target
80	/// </summary>
81	/// <param name="entity">The Entity to call the service for</param>
82	/// <param name="service">Name of the service to call. If the Domain of the service is the same as the domain of the Entity it can be omitted</param>
83	/// <param name="data">Data to provide</param>
84	public static Task<JsonElement?> CallServiceWithResponseAsync(this IEntityCore entity, string service, object? data = null)
85	{
NEW 86	ArgumentNullException.ThrowIfNull(entity);	×
NEW 87	ArgumentNullException.ThrowIfNull(service);	×
88
NEW 89	var (serviceDomain, serviceName) = service.SplitAtDot();	×
90
NEW 91	serviceDomain ??= entity.EntityId.SplitAtDot().Left ?? throw new InvalidOperationException("EntityId must be formatted 'domain.name'");	×
92
NEW 93	return entity.HaContext.CallServiceWithResponseAsync(serviceDomain, serviceName, ServiceTarget.FromEntity(entity.EntityId), data);	×
94	}
95	}

net-daemon / netdaemon / 9308287737

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous