flan/advanced-camera-card
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: Align automations with Home Assistant triggers and conditions (#2527)

Browse Source 
Split automations into HA-style `triggers`, ongoing `conditions`, and
`actions`, with compatibility migrations for existing Advanced Camera
Card configs.

## Summary

At a glance (details below):

- **Added** `triggers:` -- a required, HA-shaped block: stock `state` /
`numeric_state` / `template` plus card-specific triggers (`camera`,
`view`, `fullscreen`, ...).
- **Added** the HA-native `if` / `then` / `else` action.
- **Removed** `actions_not` (replaced by `if` / `then` / `else`).
- **Removed** the ambient `advanced_camera_card` template namespace (use
`acc` instead).
- **Changed** the trigger template surface to a top-level `trigger.*`
variable (as in HA); the nested `acc.trigger.*` paths are removed.
- **Changed** `conditions:` to ongoing gates only -- they no longer wake
an automation, and change-only forms (`config`, valueless `camera` /
`view` / `state`) become triggers, not conditions.
- **Changed** action templates to render per step, so a later action
sees state an earlier one changed.
- **Compatibility:** HA-shaped YAML is accepted (singular keys,
single-or-list, `and` / `or` / `not` shorthand, `entity` / `entity_id`).
- **Migration:** existing configs upgrade automatically; anything that
cannot be converted faithfully is recorded under `__UPGRADE_FAILURE__`
for manual fixup.

## Breaking Changes

### 1. Automations now require triggers

Before this PR, `automations[].conditions` served two roles:

- They decided whether the automation should run.
- They also acted as the thing that woke the automation up.

After this PR:

- `triggers` wake the automation.
- `conditions` only gate it at the instant a trigger fires.

Most existing automations are migrated automatically from `conditions:`
to `triggers:`.

### 2. `actions_not` is retired

Legacy `actions_not` is replaced by an HA-style `if` action with `then`
/ `else`.

Faithful conversions are automatic. Cases that cannot be faithfully
converted are recorded under `__UPGRADE_FAILURE__.automations` and must
be migrated manually.

### 3. Template surface aligned with Home Assistant

Two related template changes, both auto-migrated:

- **Top-level `trigger.*`.** Automation actions now receive a top-level
`trigger` template variable, like Home Assistant. Legacy nested paths
such as `acc.trigger.state.to` and
`advanced_camera_card.trigger.camera.to` are migrated automatically when
they appear inside template strings.
- **The ambient `advanced_camera_card` template namespace is removed.**
The long-form ambient namespace (`advanced_camera_card.camera`,
`advanced_camera_card.view`, `advanced_camera_card.config`) is retired
in favour of its shorter `acc` alias -- supported since v7.1.0, and the
only spelling the new trigger surface uses. Existing templates are
migrated automatically by rewriting the `advanced_camera_card.` prefix
to `acc.`.

### 4. Trigger-only condition forms are no longer valid conditions

Some legacy "conditions" were really change detectors. These are now
triggers only:

- `condition: config`
- valueless `camera`
- valueless `view`
- valueless `state` / picture-elements state condition with neither
`state` nor `state_not`

These are automatically promoted in automations and stripped from
overrides/elements where they would no longer be meaningful as ongoing
conditions.

### 5. Template truthiness now follows Home Assistant behavior

Template conditions and template triggers intentionally use different
truthiness rules, matching HA:

- A template condition passes only when the rendered value is `true`
(case-insensitive), matching HA's `condition.py`.
- A template trigger uses HA's broader `result_as_boolean` coercion: a
non-zero number, or `1` / `true` / `yes` / `on` / `enable`
(case-insensitive), counts as true.

### 6. Action templates render when each action executes

Action templates are now rendered per action step, not once for the
whole sequence. This means a later action can see card-local state
changed by an earlier action in the same sequence.

The `trigger` context is fixed for the automation run. HA entity state
updates still depend on the frontend receiving updated HASS state over
the websocket.

## Automatic Migrations

### Automation `conditions:` to `triggers:`

Simple legacy automation:

```yaml
# Before
automations:
  - conditions:
      - condition: fullscreen
        fullscreen: true
    actions:
      - action: custom:advanced-camera-card-action
        advanced_camera_card_action: substream_on
```

```yaml
# After, automatic
automations:
  - triggers:
      - trigger: fullscreen
        fullscreen: true
    actions:
      - action: custom:advanced-camera-card-action
        advanced_camera_card_action: substream_on
```

State conditions become HA-style state triggers:

```yaml
# Before
automations:
  - conditions:
      - condition: state
        entity_id: binary_sensor.front_door
        state: 'on'
    actions:
      - action: custom:advanced-camera-card-action
        advanced_camera_card_action: live
```

```yaml
# After, automatic
automations:
  - triggers:
      - trigger: state
        entity_id: binary_sensor.front_door
        to: 'on'
    actions:
      - action: custom:advanced-camera-card-action
        advanced_camera_card_action: live
```

Multiple conditions become both triggers and ongoing conditions:

```yaml
# Before
automations:
  - conditions:
      - condition: camera
        cameras: [front_door]
      - condition: fullscreen
        fullscreen: true
    actions:
      - action: custom:advanced-camera-card-action
        advanced_camera_card_action: substream_on
```

```yaml
# After, automatic
automations:
  - triggers:
      - trigger: camera
        cameras: [front_door]
      - trigger: fullscreen
        fullscreen: true
    conditions:
      - condition: camera
        cameras: [front_door]
      - condition: fullscreen
        fullscreen: true
    actions:
      - action: custom:advanced-camera-card-action
        advanced_camera_card_action: substream_on
```

The flattened trigger list is an implicit OR. The retained `conditions:`
list is an implicit AND checked when any trigger fires.

### Trigger-only legacy conditions

Legacy `config` conditions become `config` triggers:

```yaml
# Before
automations:
  - conditions:
      - condition: config
        paths: [menu.style]
    actions:
      - action: custom:advanced-camera-card-action
        advanced_camera_card_action: status_bar
```

```yaml
# After, automatic
automations:
  - triggers:
      - trigger: config
        paths: [menu.style]
    actions:
      - action: custom:advanced-camera-card-action
        advanced_camera_card_action: status_bar
```

Trigger-only leaves are removed from retained `conditions:` blocks
because they no longer describe an ongoing state.

### `actions_not` to `if` / `then` / `else`

```yaml
# Before
automations:
  - conditions:
      - condition: state
        entity_id: input_boolean.camera_alerts
        state: 'on'
    actions:
      - action: custom:advanced-camera-card-action
        advanced_camera_card_action: live
    actions_not:
      - action: none
```

```yaml
# After, automatic
automations:
  - triggers:
      - trigger: state
        entity_id: input_boolean.camera_alerts
    actions:
      - if:
          - condition: state
            entity_id: input_boolean.camera_alerts
            state: 'on'
        then:
          - action: custom:advanced-camera-card-action
            advanced_camera_card_action: live
        else:
          - action: none
```

If the legacy automation had no conditions, or only trigger-only
conditions, `actions_not` is dropped because the old `else` branch could
not be reproduced as an ongoing predicate.

### Trigger template paths

```yaml
# Before
message: 'Door is {{ acc.trigger.state.to }} from {{ acc.trigger.state.from }}'
```

```yaml
# After, automatic
message: 'Door is {{ trigger.to_state.state }} from {{ trigger.from_state.state }}'
```

Path rewrites performed automatically:

| Old path                   | New path                   |
| -------------------------- | -------------------------- |
| `acc.trigger.state.entity` | `trigger.entity_id`        |
| `acc.trigger.state.from`   | `trigger.from_state.state` |
| `acc.trigger.state.to`     | `trigger.to_state.state`   |
| `acc.trigger.camera.from`  | `trigger.from_acc.camera`  |
| `acc.trigger.camera.to`    | `trigger.to_acc.camera`    |
| `acc.trigger.view.from`    | `trigger.from_acc.view`    |
| `acc.trigger.view.to`      | `trigger.to_acc.view`      |
| `acc.trigger.config.from`  | `trigger.from_acc.config`  |
| `acc.trigger.config.to`    | `trigger.to_acc.config`    |

The same rewrites are applied for the older
`advanced_camera_card.trigger.*` namespace.

### Ambient template namespace

Any remaining long-form ambient `advanced_camera_card.*` references
(outside the trigger surface) are rewritten to the `acc.*` alias:

```yaml
# Before
title: 'Now viewing {{ advanced_camera_card.camera }}'
```

```yaml
# After, automatic
title: 'Now viewing {{ acc.camera }}'
```

## Manual Migration Cases

### `__UPGRADE_FAILURE__.automations`

If a legacy automation cannot be converted faithfully, the original
automation is recorded under:

```yaml
__UPGRADE_FAILURE__:
  automations:
    - ...
```

These entries require manual migration.

The main known case is legacy `actions_not` with a condition whose
trigger can only fire on a rising edge, such as:

- `condition: template`
- `condition: screen`
- `condition: numeric_state` without an entity-backed state to watch

Those conditions can start the `then` branch, but cannot reliably start
the `else` branch when they stop matching.

### Unsupported HA conditions and triggers

This PR aligns the card with HA where supported, but it is not a full HA
automation engine.

Unsupported HA condition families include:

- `time`
- `zone`
- `sun`
- `location`
- `device`
- `condition: trigger`

Unsupported HA trigger platforms include:

- `event`
- `time`
- `time_pattern`
- `sun`
- `zone`
- `calendar`
- `webhook`
- `tag`
- `device`
- `mqtt`

The card-specific camera `triggers:` feature (which auto-selects and
wakes the card on camera events such as motion) is a separate feature
from automation `triggers:`, despite the shared word.

### Trigger IDs and variables

HA keys such as `id`, `alias`, and `variables` are accepted so pasted HA
YAML validates, but they are ignored by the card. There is no
`trigger.id` support in this PR.

## New Compatibility Features

This PR also makes card config more forgiving for HA-style YAML:

- `trigger`, `condition`, and `action` singular keys are accepted and
normalized to `triggers`, `conditions`, and `actions`.
- Single trigger, condition, and action objects are accepted where lists
are expected.
- `if`, `then`, and `else` accept a single item or a list.
- Composite condition shorthand is accepted:
  - `{ and: [...] }`
  - `{ or: [...] }`
  - `{ not: [...] }`
  - `{ condition: [...] }` as an implicit AND
- State conditions resolve expected state values that name another
entity, matching HA/Lovelace behavior.
- Both `entity` and `entity_id` are accepted on state and numeric
conditions and triggers (a superset of HA's two dialects), so there is
no forced rename.
- `state_not` remains supported as a card/Lovelace-friendly extension.

## Trigger Payloads

Automation action templates receive a top-level `trigger` object.

For stock `state` and `numeric_state` triggers:

```yaml
trigger.platform
trigger.entity_id
trigger.entity
trigger.from_state
trigger.to_state
```

For template triggers:

```yaml
trigger.platform
```

For card-specific triggers:

```yaml
trigger.platform # "acc"
trigger.type
trigger.from_acc
trigger.to_acc
```

The card does not currently expose HA's `id`, `idx`, `for`, `attribute`,
`above`, `below`, or `alias` trigger fields.

BREAKING CHANGE: Automations now follow Home Assistant's `triggers:` /
`conditions:` / `actions:` model. Automations require a `triggers:`
block and `conditions:` no longer wake an automation; `actions_not` is
removed in favour of an `if` / `then` / `else` action; the nested
`acc.trigger.*` template paths and the ambient `advanced_camera_card`
template namespace are removed (use the top-level `trigger.*` surface
and the `acc` alias); trigger-only condition forms (`config`, valueless
`camera` / `view` / `state`) are no longer valid conditions; and
template-condition vs template-trigger truthiness now follow HA.
Existing configs are upgraded automatically where a faithful conversion
exists; anything that cannot be converted is recorded under
`__UPGRADE_FAILURE__` for manual migration.

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Dermot Duffy
2026-06-30 17:45:13 -07:00
committed by dermotduffy
co-authored by Claude Opus 4.8
parent 209c873c58
commit b701366762
354 changed files with 11386 additions and 3020 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/condition-trigger/triggers/factory.test.ts
+58
View File
@@ -0,0 +1,58 @@
import { describe, expect, it } from 'vitest';
import { TemplateRenderer } from '../../../src/card-controller/templates';
import { ConditionStateManager } from '../../../src/condition-trigger/conditions/state-manager';
import { createTriggerEvaluator } from '../../../src/condition-trigger/triggers/factory';
import { CallTrigger } from '../../../src/condition-trigger/triggers/triggers/call';
import { CameraTrigger } from '../../../src/condition-trigger/triggers/triggers/camera';
import { ConfigTrigger } from '../../../src/condition-trigger/triggers/triggers/config';
import { DisplayModeTrigger } from '../../../src/condition-trigger/triggers/triggers/display-mode';
import { ExpandTrigger } from '../../../src/condition-trigger/triggers/triggers/expand';
import { FullscreenTrigger } from '../../../src/condition-trigger/triggers/triggers/fullscreen';
import { InitializedTrigger } from '../../../src/condition-trigger/triggers/triggers/initialized';
import { InteractionTrigger } from '../../../src/condition-trigger/triggers/triggers/interaction';
import { KeyTrigger } from '../../../src/condition-trigger/triggers/triggers/key';
import { MediaLoadedTrigger } from '../../../src/condition-trigger/triggers/triggers/media-loaded';
import { MicrophoneTrigger } from '../../../src/condition-trigger/triggers/triggers/microphone';
import { NumericStateTrigger } from '../../../src/condition-trigger/triggers/triggers/numeric-state';
import { ScreenTrigger } from '../../../src/condition-trigger/triggers/triggers/screen';
import { StateTrigger } from '../../../src/condition-trigger/triggers/triggers/state';
import { TemplateTrigger } from '../../../src/condition-trigger/triggers/triggers/template';
import { TriggeredTrigger } from '../../../src/condition-trigger/triggers/triggers/triggered';
import {
TriggerEvaluator,
TriggerEvaluatorContext,
} from '../../../src/condition-trigger/triggers/triggers/types';
import { ViewTrigger } from '../../../src/condition-trigger/triggers/triggers/view';
import { Trigger } from '../../../src/config/schema/condition-trigger/triggers/types';
type TriggerEvaluatorConstructor = new (...args: never[]) => TriggerEvaluator;
// @vitest-environment jsdom
describe('createTriggerEvaluator', () => {
const context = (): TriggerEvaluatorContext => ({
stateManager: new ConditionStateManager(),
templateRenderer: new TemplateRenderer(),
});
it.each<[Trigger, TriggerEvaluatorConstructor]>([
[{ trigger: 'state', entity_id: 'binary_sensor.x' }, StateTrigger],
[{ trigger: 'numeric_state', entity_id: 'sensor.x', above: 5 }, NumericStateTrigger],
[{ trigger: 'template', value_template: '{{ true }}' }, TemplateTrigger],
[{ trigger: 'call', call: true }, CallTrigger],
[{ trigger: 'camera', cameras: ['front'] }, CameraTrigger],
[{ trigger: 'config' }, ConfigTrigger],
[{ trigger: 'display_mode', display_mode: 'single' }, DisplayModeTrigger],
[{ trigger: 'expand', expand: true }, ExpandTrigger],
[{ trigger: 'fullscreen', fullscreen: true }, FullscreenTrigger],
[{ trigger: 'interaction', interaction: true }, InteractionTrigger],
[{ trigger: 'media_loaded', media_loaded: true }, MediaLoadedTrigger],
[{ trigger: 'microphone', muted: true }, MicrophoneTrigger],
[{ trigger: 'triggered' }, TriggeredTrigger],
[{ trigger: 'view', views: ['live'] }, ViewTrigger],
[{ trigger: 'initialized' }, InitializedTrigger],
[{ trigger: 'key', key: 'a' }, KeyTrigger],
[{ trigger: 'screen' }, ScreenTrigger],
])('should create the dedicated evaluator for a %o trigger', (trigger, expected) => {
expect(createTriggerEvaluator(trigger, context())).toBeInstanceOf(expected);
});
});
tests/condition-trigger/triggers/manager.test.ts
+189
View File
@@ -0,0 +1,189 @@
import { describe, expect, it, Mock, vi } from 'vitest';
import { ConditionStateManager } from '../../../src/condition-trigger/conditions/state-manager';
import { TriggersManager } from '../../../src/condition-trigger/triggers/manager';
import { Trigger } from '../../../src/config/schema/condition-trigger/triggers/types';
import { createHASS, createStateEntity } from '../../test-utils';
// @vitest-environment jsdom
describe('TriggersManager', () => {
const create = (
triggers: Trigger[],
): {
manager: TriggersManager;
stateManager: ConditionStateManager;
listener: Mock;
} => {
const stateManager = new ConditionStateManager();
const manager = new TriggersManager(triggers, stateManager);
const listener = vi.fn();
return { manager, stateManager, listener };
};
it('should notify a listener when any of its trigger evaluators triggers', () => {
const { manager, stateManager, listener } = create([
{ trigger: 'camera', cameras: ['front'] },
{ trigger: 'view', views: ['live'] },
]);
manager.addListener(listener);
stateManager.setState({ camera: 'front' });
expect(listener).toHaveBeenCalledTimes(1);
expect(listener).toHaveBeenLastCalledWith(
expect.objectContaining({ platform: 'acc', type: 'camera' }),
);
stateManager.setState({ view: 'live' });
expect(listener).toHaveBeenCalledTimes(2);
expect(listener).toHaveBeenLastCalledWith(
expect.objectContaining({ platform: 'acc', type: 'view' }),
);
});
it('should notify every registered listener', () => {
const { manager, stateManager, listener } = create([
{ trigger: 'camera', cameras: ['front'] },
]);
const other = vi.fn();
manager.addListener(listener);
manager.addListener(other);
stateManager.setState({ camera: 'front' });
expect(listener).toHaveBeenCalledTimes(1);
expect(other).toHaveBeenCalledTimes(1);
});
it('should register the same listener only once', () => {
const { manager, stateManager, listener } = create([
{ trigger: 'camera', cameras: ['front'] },
]);
manager.addListener(listener);
manager.addListener(listener);
stateManager.setState({ camera: 'front' });
expect(listener).toHaveBeenCalledTimes(1);
});
it('should not notify a removed listener', () => {
const { manager, stateManager, listener } = create([
{ trigger: 'camera', cameras: ['front'] },
]);
manager.addListener(listener);
manager.removeListener(listener);
stateManager.setState({ camera: 'front' });
expect(listener).not.toHaveBeenCalled();
});
it('should stop triggering after destroy', () => {
const { manager, stateManager, listener } = create([
{ trigger: 'camera', cameras: ['front'] },
]);
manager.addListener(listener);
manager.destroy();
stateManager.setState({ camera: 'front' });
expect(listener).not.toHaveBeenCalled();
});
describe('enabled', () => {
const ENABLED_TEMPLATE = '{{ is_state("binary_sensor.flag", "on") }}';
const createWithFlag = (
enabled: string,
state: string | null,
): { stateManager: ConditionStateManager; listener: Mock } => {
const stateManager = new ConditionStateManager();
if (state !== null) {
stateManager.setState({
hass: createHASS({
'binary_sensor.flag': createStateEntity({ state }),
}),
});
}
const manager = new TriggersManager(
[{ trigger: 'camera', cameras: ['front'], enabled }],
stateManager,
);
const listener = vi.fn();
manager.addListener(listener);
return { stateManager, listener };
};
it('should not trigger a disabled trigger', () => {
const { manager, stateManager, listener } = create([
{ trigger: 'camera', cameras: ['front'], enabled: false },
]);
manager.addListener(listener);
stateManager.setState({ camera: 'front' });
expect(listener).not.toHaveBeenCalled();
});
it('should trigger an explicitly enabled trigger', () => {
const { manager, stateManager, listener } = create([
{ trigger: 'camera', cameras: ['front'], enabled: true },
]);
manager.addListener(listener);
stateManager.setState({ camera: 'front' });
expect(listener).toHaveBeenCalledTimes(1);
});
it('should not trigger a trigger whose enabled template does not render true', () => {
const { stateManager, listener } = createWithFlag(ENABLED_TEMPLATE, 'off');
stateManager.setState({ camera: 'front' });
expect(listener).not.toHaveBeenCalled();
});
it('should trigger a trigger whose enabled template renders true', () => {
const { stateManager, listener } = createWithFlag(ENABLED_TEMPLATE, 'on');
stateManager.setState({ camera: 'front' });
expect(listener).toHaveBeenCalledTimes(1);
});
it('should not trigger a trigger whose enabled template cannot render without hass', () => {
const { stateManager, listener } = createWithFlag(ENABLED_TEMPLATE, null);
stateManager.setState({ camera: 'front' });
// With no hass the enabled template cannot render, so the trigger fails
// closed and does not fire.
expect(listener).not.toHaveBeenCalled();
});
it('should re-evaluate the enabled template on each trigger', () => {
const stateManager = new ConditionStateManager();
stateManager.setState({
hass: createHASS({ 'binary_sensor.flag': createStateEntity({ state: 'off' }) }),
});
const manager = new TriggersManager(
[{ trigger: 'camera', cameras: ['front', 'back'], enabled: ENABLED_TEMPLATE }],
stateManager,
);
const listener = vi.fn();
manager.addListener(listener);
// Flag off: the enabled template renders false, so the camera change is
// suppressed and the listener is not notified.
stateManager.setState({ camera: 'front' });
expect(listener).not.toHaveBeenCalled();
// Flag flips on: a subsequent trigger is now allowed through.
stateManager.setState({
hass: createHASS({ 'binary_sensor.flag': createStateEntity({ state: 'on' }) }),
});
stateManager.setState({ camera: 'back' });
expect(listener).toHaveBeenCalledTimes(1);
});
});
});
tests/condition-trigger/triggers/triggers/call.test.ts
+48
View File
@@ -0,0 +1,48 @@
import { describe, expect, it, Mock, vi } from 'vitest';
import { TemplateRenderer } from '../../../../src/card-controller/templates';
import { ConditionStateManager } from '../../../../src/condition-trigger/conditions/state-manager';
import { CallTrigger } from '../../../../src/condition-trigger/triggers/triggers/call';
import { TriggerOfType } from '../../../../src/condition-trigger/triggers/triggers/types';
// @vitest-environment jsdom
describe('CallTrigger', () => {
const create = (
trigger: TriggerOfType<'call'>,
): { stateManager: ConditionStateManager; callback: Mock } => {
const stateManager = new ConditionStateManager();
const callback = vi.fn();
new CallTrigger(trigger, {
stateManager,
templateRenderer: new TemplateRenderer(),
}).subscribe(callback);
return { stateManager, callback };
};
it('should treat an absent call state as not-in-call', () => {
const { stateManager, callback } = create({ trigger: 'call' });
// Absent (undefined) is equivalent to false, so this is not a change.
stateManager.setState({ call: false });
expect(callback).not.toHaveBeenCalled();
stateManager.setState({ call: true });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should trigger only on changes to the given value', () => {
const { stateManager, callback } = create({ trigger: 'call', call: true });
stateManager.setState({ call: true });
stateManager.setState({ call: false });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should trigger on the falling edge to a false value', () => {
const { stateManager, callback } = create({ trigger: 'call', call: false });
stateManager.setState({ call: true });
expect(callback).not.toHaveBeenCalled();
stateManager.setState({ call: false });
expect(callback).toHaveBeenCalledTimes(1);
});
});
tests/condition-trigger/triggers/triggers/camera.test.ts
+158
View File
@@ -0,0 +1,158 @@
import { describe, expect, it, Mock, vi } from 'vitest';
import { TemplateRenderer } from '../../../../src/card-controller/templates';
import { ConditionStateManager } from '../../../../src/condition-trigger/conditions/state-manager';
import { CameraTrigger } from '../../../../src/condition-trigger/triggers/triggers/camera';
import { TriggerOfType } from '../../../../src/condition-trigger/triggers/triggers/types';
import { createConfig } from '../../../test-utils';
// @vitest-environment jsdom
describe('CameraTrigger', () => {
const create = (
trigger: TriggerOfType<'camera'>,
): {
cameraTrigger: CameraTrigger;
stateManager: ConditionStateManager;
callback: Mock;
} => {
const stateManager = new ConditionStateManager();
const callback = vi.fn();
const cameraTrigger = new CameraTrigger(trigger, {
stateManager,
templateRenderer: new TemplateRenderer(),
});
return { cameraTrigger, stateManager, callback };
};
it('should trigger when the selected camera changes to a listed one', () => {
const { cameraTrigger, stateManager, callback } = create({
trigger: 'camera',
cameras: ['front', 'back'],
});
cameraTrigger.subscribe(callback);
// An unlisted camera does not trigger.
stateManager.setState({ camera: 'side' });
expect(callback).not.toHaveBeenCalled();
// Crossing to a listed camera triggers, with the before/after trigger data.
stateManager.setState({ camera: 'front' });
expect(callback).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenCalledWith({
platform: 'acc',
type: 'camera',
from_acc: { camera: 'side' },
to_acc: { camera: 'front' },
});
});
it('should trigger again when the camera changes between two listed cameras', () => {
const { cameraTrigger, stateManager, callback } = create({
trigger: 'camera',
cameras: ['front', 'back'],
});
cameraTrigger.subscribe(callback);
stateManager.setState({ camera: 'front' });
expect(callback).toHaveBeenCalledTimes(1);
// Still matching, but the camera moved: triggers again.
stateManager.setState({ camera: 'back' });
expect(callback).toHaveBeenCalledTimes(2);
expect(callback).toHaveBeenLastCalledWith({
platform: 'acc',
type: 'camera',
from_acc: { camera: 'front' },
to_acc: { camera: 'back' },
});
});
it('should not trigger on an unrelated state change while the camera is unchanged', () => {
const { cameraTrigger, stateManager, callback } = create({
trigger: 'camera',
cameras: ['front'],
});
cameraTrigger.subscribe(callback);
stateManager.setState({ camera: 'front' });
expect(callback).toHaveBeenCalledTimes(1);
stateManager.setState({ fullscreen: true });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should not trigger once the camera leaves the listed set', () => {
const { cameraTrigger, stateManager, callback } = create({
trigger: 'camera',
cameras: ['front'],
});
cameraTrigger.subscribe(callback);
stateManager.setState({ camera: 'front' });
expect(callback).toHaveBeenCalledTimes(1);
stateManager.setState({ camera: 'side' });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should trigger on any camera change without a listed set', () => {
const { cameraTrigger, stateManager, callback } = create({ trigger: 'camera' });
cameraTrigger.subscribe(callback);
stateManager.setState({ camera: 'side' });
expect(callback).toHaveBeenCalledTimes(1);
stateManager.setState({ camera: 'front' });
expect(callback).toHaveBeenCalledTimes(2);
// An unrelated change leaves the camera unchanged: no trigger.
stateManager.setState({ fullscreen: true });
expect(callback).toHaveBeenCalledTimes(2);
});
it('should trigger only when the camera becomes unselected for an empty list', () => {
const { cameraTrigger, stateManager, callback } = create({
trigger: 'camera',
cameras: [],
});
cameraTrigger.subscribe(callback);
// Changing between cameras does not trigger.
stateManager.setState({ camera: 'front' });
stateManager.setState({ camera: 'back' });
expect(callback).not.toHaveBeenCalled();
// Becoming unselected triggers.
stateManager.setState({ camera: undefined });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should include camera, view and config in the trigger data', () => {
const config = createConfig();
const { cameraTrigger, stateManager, callback } = create({
trigger: 'camera',
cameras: ['front'],
});
cameraTrigger.subscribe(callback);
stateManager.setState({ camera: 'side', view: 'live', config });
stateManager.setState({ camera: 'front' });
expect(callback).toHaveBeenLastCalledWith({
platform: 'acc',
type: 'camera',
from_acc: { camera: 'side', view: 'live', config },
to_acc: { camera: 'front', view: 'live', config },
});
});
it('should stop triggering after destroy', () => {
const { cameraTrigger, stateManager, callback } = create({
trigger: 'camera',
cameras: ['front'],
});
cameraTrigger.subscribe(callback);
cameraTrigger.destroy();
stateManager.setState({ camera: 'front' });
expect(callback).not.toHaveBeenCalled();
});
});
tests/condition-trigger/triggers/triggers/config.test.ts
+98
View File
@@ -0,0 +1,98 @@
import { describe, expect, it, Mock, vi } from 'vitest';
import { TemplateRenderer } from '../../../../src/card-controller/templates';
import { ConditionStateManager } from '../../../../src/condition-trigger/conditions/state-manager';
import { ConfigTrigger } from '../../../../src/condition-trigger/triggers/triggers/config';
import { TriggerOfType } from '../../../../src/condition-trigger/triggers/triggers/types';
import { createConfig } from '../../../test-utils';
// @vitest-environment jsdom
describe('ConfigTrigger', () => {
const create = (
trigger: TriggerOfType<'config'>,
): {
configTrigger: ConfigTrigger;
stateManager: ConditionStateManager;
callback: Mock;
} => {
const stateManager = new ConditionStateManager();
const callback = vi.fn();
const configTrigger = new ConfigTrigger(trigger, {
stateManager,
templateRenderer: new TemplateRenderer(),
});
return { configTrigger, stateManager, callback };
};
it('should trigger whenever the config changes', () => {
const { configTrigger, stateManager, callback } = create({ trigger: 'config' });
configTrigger.subscribe(callback);
stateManager.setState({ config: createConfig() });
expect(callback).toHaveBeenCalledTimes(1);
stateManager.setState({ config: createConfig({ menu: { style: 'outside' } }) });
expect(callback).toHaveBeenCalledTimes(2);
});
it('should not trigger when the config is unchanged', () => {
const { configTrigger, stateManager, callback } = create({ trigger: 'config' });
configTrigger.subscribe(callback);
stateManager.setState({ config: createConfig() });
expect(callback).toHaveBeenCalledTimes(1);
// An unrelated state change leaves the config untouched.
stateManager.setState({ fullscreen: true });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should trigger only when a listed path changes', () => {
const { configTrigger, stateManager, callback } = create({
trigger: 'config',
paths: ['menu.style'],
});
configTrigger.subscribe(callback);
stateManager.setState({
config: createConfig({ menu: { style: 'outside', position: 'top' } }),
});
expect(callback).toHaveBeenCalledTimes(1);
// A config change that leaves `menu.style` untouched does not trigger.
stateManager.setState({
config: createConfig({ menu: { style: 'outside', position: 'bottom' } }),
});
expect(callback).toHaveBeenCalledTimes(1);
// Changing `menu.style` triggers.
stateManager.setState({
config: createConfig({ menu: { style: 'hidden', position: 'bottom' } }),
});
expect(callback).toHaveBeenCalledTimes(2);
});
it('should include camera, view and config in the trigger data', () => {
const config = createConfig();
const config2 = createConfig({ menu: { style: 'outside' } });
const { configTrigger, stateManager, callback } = create({ trigger: 'config' });
configTrigger.subscribe(callback);
stateManager.setState({ config, camera: 'front', view: 'live' });
stateManager.setState({ config: config2 });
expect(callback).toHaveBeenLastCalledWith({
platform: 'acc',
type: 'config',
from_acc: { camera: 'front', view: 'live', config },
to_acc: { camera: 'front', view: 'live', config: config2 },
});
});
it('should stop triggering after destroy', () => {
const { configTrigger, stateManager, callback } = create({ trigger: 'config' });
configTrigger.subscribe(callback);
configTrigger.destroy();
stateManager.setState({ config: createConfig() });
expect(callback).not.toHaveBeenCalled();
});
});
tests/condition-trigger/triggers/triggers/display-mode.test.ts
+39
View File
@@ -0,0 +1,39 @@
import { describe, expect, it, Mock, vi } from 'vitest';
import { TemplateRenderer } from '../../../../src/card-controller/templates';
import { ConditionStateManager } from '../../../../src/condition-trigger/conditions/state-manager';
import { DisplayModeTrigger } from '../../../../src/condition-trigger/triggers/triggers/display-mode';
import { TriggerOfType } from '../../../../src/condition-trigger/triggers/triggers/types';
// @vitest-environment jsdom
describe('DisplayModeTrigger', () => {
const create = (
trigger: TriggerOfType<'display_mode'>,
): { stateManager: ConditionStateManager; callback: Mock } => {
const stateManager = new ConditionStateManager();
const callback = vi.fn();
new DisplayModeTrigger(trigger, {
stateManager,
templateRenderer: new TemplateRenderer(),
}).subscribe(callback);
return { stateManager, callback };
};
it('should trigger on any change without a value', () => {
const { stateManager, callback } = create({ trigger: 'display_mode' });
stateManager.setState({ displayMode: 'single' });
stateManager.setState({ displayMode: 'grid' });
expect(callback).toHaveBeenCalledTimes(2);
});
it('should trigger only on changes to the given value', () => {
const { stateManager, callback } = create({
trigger: 'display_mode',
display_mode: 'grid',
});
stateManager.setState({ displayMode: 'single' });
expect(callback).not.toHaveBeenCalled();
stateManager.setState({ displayMode: 'grid' });
expect(callback).toHaveBeenCalledTimes(1);
});
});
tests/condition-trigger/triggers/triggers/expand.test.ts
+44
View File
@@ -0,0 +1,44 @@
import { describe, expect, it, Mock, vi } from 'vitest';
import { TemplateRenderer } from '../../../../src/card-controller/templates';
import { ConditionStateManager } from '../../../../src/condition-trigger/conditions/state-manager';
import { ExpandTrigger } from '../../../../src/condition-trigger/triggers/triggers/expand';
import { TriggerOfType } from '../../../../src/condition-trigger/triggers/triggers/types';
// @vitest-environment jsdom
describe('ExpandTrigger', () => {
const create = (
trigger: TriggerOfType<'expand'>,
): { stateManager: ConditionStateManager; callback: Mock } => {
const stateManager = new ConditionStateManager();
const callback = vi.fn();
new ExpandTrigger(trigger, {
stateManager,
templateRenderer: new TemplateRenderer(),
}).subscribe(callback);
return { stateManager, callback };
};
it('should trigger on any change without a value', () => {
const { stateManager, callback } = create({ trigger: 'expand' });
stateManager.setState({ expand: true });
stateManager.setState({ expand: false });
expect(callback).toHaveBeenCalledTimes(2);
});
it('should trigger only on changes to the given value', () => {
const { stateManager, callback } = create({ trigger: 'expand', expand: true });
stateManager.setState({ expand: true });
stateManager.setState({ expand: false });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should trigger on the falling edge to a false value', () => {
const { stateManager, callback } = create({ trigger: 'expand', expand: false });
stateManager.setState({ expand: true });
expect(callback).not.toHaveBeenCalled();
stateManager.setState({ expand: false });
expect(callback).toHaveBeenCalledTimes(1);
});
});
tests/condition-trigger/triggers/triggers/fullscreen.test.ts
+83
View File
@@ -0,0 +1,83 @@
import { describe, expect, it, Mock, vi } from 'vitest';
import { TemplateRenderer } from '../../../../src/card-controller/templates';
import { ConditionStateManager } from '../../../../src/condition-trigger/conditions/state-manager';
import { FullscreenTrigger } from '../../../../src/condition-trigger/triggers/triggers/fullscreen';
import { TriggerOfType } from '../../../../src/condition-trigger/triggers/triggers/types';
// @vitest-environment jsdom
describe('FullscreenTrigger', () => {
const create = (
trigger: TriggerOfType<'fullscreen'>,
): {
fullscreenTrigger: FullscreenTrigger;
stateManager: ConditionStateManager;
callback: Mock;
} => {
const stateManager = new ConditionStateManager();
const callback = vi.fn();
const fullscreenTrigger = new FullscreenTrigger(trigger, {
stateManager,
templateRenderer: new TemplateRenderer(),
});
return { fullscreenTrigger, stateManager, callback };
};
it('should trigger on any change without a value', () => {
const { fullscreenTrigger, stateManager, callback } = create({
trigger: 'fullscreen',
});
fullscreenTrigger.subscribe(callback);
stateManager.setState({ fullscreen: true });
expect(callback).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenCalledWith({ platform: 'acc', type: 'fullscreen' });
// The falling edge triggers too.
stateManager.setState({ fullscreen: false });
expect(callback).toHaveBeenCalledTimes(2);
// An unrelated change does not.
stateManager.setState({ expand: true });
expect(callback).toHaveBeenCalledTimes(2);
});
it('should trigger only on changes to the given value', () => {
const { fullscreenTrigger, stateManager, callback } = create({
trigger: 'fullscreen',
fullscreen: true,
});
fullscreenTrigger.subscribe(callback);
stateManager.setState({ fullscreen: true });
expect(callback).toHaveBeenCalledTimes(1);
// Leaving fullscreen does not trigger this `true`-filtered trigger.
stateManager.setState({ fullscreen: false });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should trigger on the falling edge to a false value', () => {
const { fullscreenTrigger, stateManager, callback } = create({
trigger: 'fullscreen',
fullscreen: false,
});
fullscreenTrigger.subscribe(callback);
stateManager.setState({ fullscreen: true });
expect(callback).not.toHaveBeenCalled();
stateManager.setState({ fullscreen: false });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should stop triggering after destroy', () => {
const { fullscreenTrigger, stateManager, callback } = create({
trigger: 'fullscreen',
});
fullscreenTrigger.subscribe(callback);
fullscreenTrigger.destroy();
stateManager.setState({ fullscreen: true });
expect(callback).not.toHaveBeenCalled();
});
});
tests/condition-trigger/triggers/triggers/interaction.test.ts
+50
View File
@@ -0,0 +1,50 @@
import { describe, expect, it, Mock, vi } from 'vitest';
import { TemplateRenderer } from '../../../../src/card-controller/templates';
import { ConditionStateManager } from '../../../../src/condition-trigger/conditions/state-manager';
import { InteractionTrigger } from '../../../../src/condition-trigger/triggers/triggers/interaction';
import { TriggerOfType } from '../../../../src/condition-trigger/triggers/triggers/types';
// @vitest-environment jsdom
describe('InteractionTrigger', () => {
const create = (
trigger: TriggerOfType<'interaction'>,
): { stateManager: ConditionStateManager; callback: Mock } => {
const stateManager = new ConditionStateManager();
const callback = vi.fn();
new InteractionTrigger(trigger, {
stateManager,
templateRenderer: new TemplateRenderer(),
}).subscribe(callback);
return { stateManager, callback };
};
it('should trigger on any change without a value', () => {
const { stateManager, callback } = create({ trigger: 'interaction' });
stateManager.setState({ interaction: true });
stateManager.setState({ interaction: false });
expect(callback).toHaveBeenCalledTimes(2);
});
it('should trigger only on changes to the given value', () => {
const { stateManager, callback } = create({
trigger: 'interaction',
interaction: true,
});
stateManager.setState({ interaction: true });
stateManager.setState({ interaction: false });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should trigger on the falling edge to a false value', () => {
const { stateManager, callback } = create({
trigger: 'interaction',
interaction: false,
});
stateManager.setState({ interaction: true });
expect(callback).not.toHaveBeenCalled();
stateManager.setState({ interaction: false });
expect(callback).toHaveBeenCalledTimes(1);
});
});
tests/condition-trigger/triggers/triggers/is-template-true.test.ts
+29
View File
@@ -0,0 +1,29 @@
import { describe, expect, it } from 'vitest';
import { isTemplateTrue } from '../../../../src/condition-trigger/triggers/triggers/is-template-true';
describe('trigger isTemplateTrue', () => {
it('should pass booleans through', () => {
expect(isTemplateTrue(true)).toBe(true);
expect(isTemplateTrue(false)).toBe(false);
});
it('should treat a non-zero number as true', () => {
expect(isTemplateTrue(1)).toBe(true);
expect(isTemplateTrue(0)).toBe(false);
});
it('should accept HA truthy strings case-insensitively', () => {
for (const value of ['1', 'true', 'YES', 'On', 'enable']) {
expect(isTemplateTrue(value)).toBe(true);
}
});
it('should reject falsey strings and other types', () => {
for (const value of ['0', 'false', 'no', 'off', 'disable', 'whatever']) {
expect(isTemplateTrue(value)).toBe(false);
}
expect(isTemplateTrue(null)).toBe(false);
expect(isTemplateTrue(undefined)).toBe(false);
expect(isTemplateTrue({})).toBe(false);
});
});
tests/condition-trigger/triggers/triggers/media-loaded.test.ts
+57
View File
@@ -0,0 +1,57 @@
import { describe, expect, it, Mock, vi } from 'vitest';
import { TemplateRenderer } from '../../../../src/card-controller/templates';
import { ConditionStateManager } from '../../../../src/condition-trigger/conditions/state-manager';
import { MediaLoadedTrigger } from '../../../../src/condition-trigger/triggers/triggers/media-loaded';
import { TriggerOfType } from '../../../../src/condition-trigger/triggers/triggers/types';
import { createMediaLoadedInfo } from '../../../test-utils';
// @vitest-environment jsdom
describe('MediaLoadedTrigger', () => {
const create = (
trigger: TriggerOfType<'media_loaded'>,
): { stateManager: ConditionStateManager; callback: Mock } => {
const stateManager = new ConditionStateManager();
const callback = vi.fn();
new MediaLoadedTrigger(trigger, {
stateManager,
templateRenderer: new TemplateRenderer(),
}).subscribe(callback);
return { stateManager, callback };
};
it('should trigger when media presence changes without a value', () => {
const { stateManager, callback } = create({ trigger: 'media_loaded' });
stateManager.setState({ mediaLoadedInfo: createMediaLoadedInfo() });
expect(callback).toHaveBeenCalledTimes(1);
stateManager.setState({ mediaLoadedInfo: null });
expect(callback).toHaveBeenCalledTimes(2);
});
it('should trigger only on changes to the given value', () => {
const { stateManager, callback } = create({
trigger: 'media_loaded',
media_loaded: true,
});
stateManager.setState({ mediaLoadedInfo: createMediaLoadedInfo() });
expect(callback).toHaveBeenCalledTimes(1);
stateManager.setState({ mediaLoadedInfo: null });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should trigger on the falling edge to a false value', () => {
const { stateManager, callback } = create({
trigger: 'media_loaded',
media_loaded: false,
});
stateManager.setState({ mediaLoadedInfo: createMediaLoadedInfo() });
expect(callback).not.toHaveBeenCalled();
stateManager.setState({ mediaLoadedInfo: null });
expect(callback).toHaveBeenCalledTimes(1);
});
});
tests/condition-trigger/triggers/triggers/microphone.test.ts
+54
View File
@@ -0,0 +1,54 @@
import { describe, expect, it, Mock, vi } from 'vitest';
import { TemplateRenderer } from '../../../../src/card-controller/templates';
import { MicrophoneState } from '../../../../src/card-controller/types';
import { ConditionStateManager } from '../../../../src/condition-trigger/conditions/state-manager';
import { MicrophoneTrigger } from '../../../../src/condition-trigger/triggers/triggers/microphone';
import { TriggerOfType } from '../../../../src/condition-trigger/triggers/triggers/types';
// @vitest-environment jsdom
describe('MicrophoneTrigger', () => {
const createMicrophoneState = (state: Partial<MicrophoneState>): MicrophoneState => ({
connected: false,
muted: false,
forbidden: false,
...state,
});
const create = (
trigger: TriggerOfType<'microphone'>,
): { stateManager: ConditionStateManager; callback: Mock } => {
const stateManager = new ConditionStateManager();
const callback = vi.fn();
new MicrophoneTrigger(trigger, {
stateManager,
templateRenderer: new TemplateRenderer(),
}).subscribe(callback);
return { stateManager, callback };
};
it('should trigger on any mute change without a value', () => {
const { stateManager, callback } = create({ trigger: 'microphone' });
stateManager.setState({ microphone: createMicrophoneState({ muted: true }) });
stateManager.setState({ microphone: createMicrophoneState({ muted: false }) });
expect(callback).toHaveBeenCalledTimes(2);
});
it('should trigger only on changes to the given mute value', () => {
const { stateManager, callback } = create({ trigger: 'microphone', muted: true });
stateManager.setState({ microphone: createMicrophoneState({ muted: true }) });
expect(callback).toHaveBeenCalledTimes(1);
stateManager.setState({ microphone: createMicrophoneState({ muted: false }) });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should trigger on the falling edge to a false value', () => {
const { stateManager, callback } = create({ trigger: 'microphone', muted: false });
stateManager.setState({ microphone: createMicrophoneState({ muted: true }) });
expect(callback).not.toHaveBeenCalled();
stateManager.setState({ microphone: createMicrophoneState({ muted: false }) });
expect(callback).toHaveBeenCalledTimes(1);
});
});
tests/condition-trigger/triggers/triggers/numeric-state.test.ts
+455
View File
@@ -0,0 +1,455 @@
import { HassEntities, HassEntity } from 'home-assistant-js-websocket';
import { afterEach, beforeEach, describe, expect, it, Mock, vi } from 'vitest';
import { TemplateRenderer } from '../../../../src/card-controller/templates';
import { ConditionStateManager } from '../../../../src/condition-trigger/conditions/state-manager';
import { NumericStateTrigger } from '../../../../src/condition-trigger/triggers/triggers/numeric-state';
import { TriggerOfType } from '../../../../src/condition-trigger/triggers/triggers/types';
import { createHASS, createStateEntity } from '../../../test-utils';
const SENSOR = 'sensor.temperature';
const SENSOR_TWO = 'sensor.humidity';
const THRESHOLD = 'input_number.limit';
// @vitest-environment jsdom
describe('NumericStateTrigger', () => {
const create = (
config: TriggerOfType<'numeric_state'>,
): {
trigger: NumericStateTrigger;
stateManager: ConditionStateManager;
callback: Mock;
} => {
const stateManager = new ConditionStateManager();
const callback = vi.fn();
const trigger = new NumericStateTrigger(config, {
stateManager,
templateRenderer: new TemplateRenderer(),
});
return { trigger, stateManager, callback };
};
const setHass = (
manager: ConditionStateManager,
states: Record<string, Partial<HassEntity>>,
): void => {
const entities: HassEntities = {};
for (const [id, partial] of Object.entries(states)) {
entities[id] = createStateEntity(partial);
}
manager.setState({ hass: createHASS(entities) });
};
it('should trigger on the crossing into range', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
});
trigger.subscribe(callback);
// Below the threshold: arms but does not trigger.
setHass(stateManager, { [SENSOR]: { state: '10' } });
expect(callback).not.toHaveBeenCalled();
// Crosses above the threshold: triggers once.
setHass(stateManager, { [SENSOR]: { state: '25' } });
expect(callback).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenCalledWith(
expect.objectContaining({
platform: 'numeric_state',
entity_id: SENSOR,
entity: SENSOR,
}),
);
});
it('should not re-trigger while the value stays in range', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
});
trigger.subscribe(callback);
setHass(stateManager, { [SENSOR]: { state: '10' } });
setHass(stateManager, { [SENSOR]: { state: '25' } });
expect(callback).toHaveBeenCalledTimes(1);
// Still in range: not a fresh crossing, so no re-trigger.
setHass(stateManager, { [SENSOR]: { state: '26' } });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should trigger again after leaving and re-entering the range', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
});
trigger.subscribe(callback);
setHass(stateManager, { [SENSOR]: { state: '10' } });
setHass(stateManager, { [SENSOR]: { state: '25' } });
expect(callback).toHaveBeenCalledTimes(1);
// Leave the range (re-arms), then cross back in.
setHass(stateManager, { [SENSOR]: { state: '10' } });
setHass(stateManager, { [SENSOR]: { state: '25' } });
expect(callback).toHaveBeenCalledTimes(2);
});
it('should respect a range with both above and below', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
below: 30,
});
trigger.subscribe(callback);
// Below the range: arms.
setHass(stateManager, { [SENSOR]: { state: '10' } });
// Into the range: triggers.
setHass(stateManager, { [SENSOR]: { state: '25' } });
expect(callback).toHaveBeenCalledTimes(1);
// Out the top of the range: re-arms, no trigger.
setHass(stateManager, { [SENSOR]: { state: '35' } });
expect(callback).toHaveBeenCalledTimes(1);
// Back into the range: triggers again.
setHass(stateManager, { [SENSOR]: { state: '25' } });
expect(callback).toHaveBeenCalledTimes(2);
});
it('should resolve an entity-id reference as the threshold', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: THRESHOLD,
});
trigger.subscribe(callback);
// 10 > 20 is false: arms.
setHass(stateManager, { [SENSOR]: { state: '10' }, [THRESHOLD]: { state: '20' } });
// 25 > 20 is true: triggers.
setHass(stateManager, { [SENSOR]: { state: '25' }, [THRESHOLD]: { state: '20' } });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should match against an attribute', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
attribute: 'battery',
above: 20,
});
trigger.subscribe(callback);
setHass(stateManager, { [SENSOR]: { state: 'on', attributes: { battery: 10 } } });
setHass(stateManager, { [SENSOR]: { state: 'on', attributes: { battery: 25 } } });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should match the rendered value_template', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
value_template: `{{ states('${SENSOR}') | float * 10 }}`,
above: 20,
});
trigger.subscribe(callback);
// Template value 1 * 10 = 10: arms.
setHass(stateManager, { [SENSOR]: { state: '1' } });
// Template value 3 * 10 = 30: crosses in and triggers.
setHass(stateManager, { [SENSOR]: { state: '3' } });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should fan out independently over a list of entities', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: [SENSOR, SENSOR_TWO],
above: 20,
});
trigger.subscribe(callback);
setHass(stateManager, {
[SENSOR]: { state: '10' },
[SENSOR_TWO]: { state: '10' },
});
// Only SENSOR crosses in.
setHass(stateManager, { [SENSOR]: { state: '25' }, [SENSOR_TWO]: { state: '10' } });
expect(callback).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenLastCalledWith(
expect.objectContaining({ entity_id: SENSOR }),
);
// Now SENSOR_TWO crosses in.
setHass(stateManager, { [SENSOR]: { state: '25' }, [SENSOR_TWO]: { state: '25' } });
expect(callback).toHaveBeenCalledTimes(2);
expect(callback).toHaveBeenLastCalledWith(
expect.objectContaining({ entity_id: SENSOR_TWO }),
);
});
it('should not trigger for an entity that did not change', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
});
trigger.subscribe(callback);
setHass(stateManager, { [SENSOR]: { state: '10' } });
// An unrelated entity changes; SENSOR is unchanged so must not trigger.
setHass(stateManager, {
[SENSOR]: { state: '10' },
[SENSOR_TWO]: { state: '25' },
});
expect(callback).not.toHaveBeenCalled();
});
it('should arm an entity already outside the range at subscribe', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
});
// Already below the threshold before subscribe: armed at subscribe.
setHass(stateManager, { [SENSOR]: { state: '10' } });
trigger.subscribe(callback);
// The first crossing in triggers.
setHass(stateManager, { [SENSOR]: { state: '25' } });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should not trigger for an entity already in range at subscribe', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
});
// Already in range before subscribe: not armed.
setHass(stateManager, { [SENSOR]: { state: '25' } });
trigger.subscribe(callback);
// A further in-range change is not a crossing.
setHass(stateManager, { [SENSOR]: { state: '26' } });
expect(callback).not.toHaveBeenCalled();
});
it('should not trigger for an entity unreadable at subscribe until it crosses in afresh', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
});
// No value at subscribe: not armed (an unreadable entity is not a crossing
// source until it has been outside the range).
trigger.subscribe(callback);
setHass(stateManager, { [SENSOR]: { state: '25' } });
expect(callback).not.toHaveBeenCalled();
// After it has been outside, the next crossing in triggers.
setHass(stateManager, { [SENSOR]: { state: '10' } });
setHass(stateManager, { [SENSOR]: { state: '25' } });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should provide the full from_state/to_state objects', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
});
trigger.subscribe(callback);
setHass(stateManager, { [SENSOR]: { state: '10' } });
setHass(stateManager, { [SENSOR]: { state: '25' } });
expect(callback).toHaveBeenCalledWith(
expect.objectContaining({
from_state: expect.objectContaining({ state: '10' }),
to_state: expect.objectContaining({ state: '25' }),
}),
);
});
it('should trigger without a from_state when an armed entity is removed and reappears in range', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
});
trigger.subscribe(callback);
// Arm the entity below the range, then remove it (still armed).
setHass(stateManager, { [SENSOR]: { state: '10' } });
setHass(stateManager, {});
// It reappears already in range: triggers, but there is no prior state.
setHass(stateManager, { [SENSOR]: { state: '25' } });
expect(callback).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenLastCalledWith({
platform: 'numeric_state',
entity_id: SENSOR,
entity: SENSOR,
to_state: expect.objectContaining({ state: '25' }),
});
});
it('should accept the entity alias', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity: SENSOR,
above: 20,
});
trigger.subscribe(callback);
setHass(stateManager, { [SENSOR]: { state: '10' } });
setHass(stateManager, { [SENSOR]: { state: '25' } });
expect(callback).toHaveBeenCalledTimes(1);
});
describe('for', () => {
beforeEach(() => {
vi.useFakeTimers();
});
afterEach(() => {
vi.useRealTimers();
});
it('should trigger only after the value is held in range for the duration', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
for: '00:00:05',
});
trigger.subscribe(callback);
setHass(stateManager, { [SENSOR]: { state: '10' } });
setHass(stateManager, { [SENSOR]: { state: '25' } });
vi.advanceTimersByTime(4999);
expect(callback).not.toHaveBeenCalled();
vi.advanceTimersByTime(1);
expect(callback).toHaveBeenCalledTimes(1);
});
it('should cancel the pending trigger when the value leaves the range', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
for: '00:00:05',
});
trigger.subscribe(callback);
setHass(stateManager, { [SENSOR]: { state: '10' } });
setHass(stateManager, { [SENSOR]: { state: '25' } });
vi.advanceTimersByTime(3000);
// Leaves the range before the hold elapses: cancelled.
setHass(stateManager, { [SENSOR]: { state: '10' } });
vi.advanceTimersByTime(5000);
expect(callback).not.toHaveBeenCalled();
});
it('should keep the hold across an in-range change', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
for: '00:00:05',
});
trigger.subscribe(callback);
setHass(stateManager, { [SENSOR]: { state: '10' } });
setHass(stateManager, { [SENSOR]: { state: '25' } });
vi.advanceTimersByTime(3000);
// Still in range: the fixed-deadline hold keeps running, not reset.
setHass(stateManager, { [SENSOR]: { state: '26' } });
vi.advanceTimersByTime(2000);
expect(callback).toHaveBeenCalledTimes(1);
});
it('should clear a pending for: timer on destroy', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
for: '00:00:05',
});
trigger.subscribe(callback);
setHass(stateManager, { [SENSOR]: { state: '10' } });
setHass(stateManager, { [SENSOR]: { state: '25' } });
trigger.destroy();
vi.advanceTimersByTime(5000);
expect(callback).not.toHaveBeenCalled();
});
it('should reset the for: timer on a fresh crossing', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
for: '00:00:05',
});
trigger.subscribe(callback);
setHass(stateManager, { [SENSOR]: { state: '10' } });
setHass(stateManager, { [SENSOR]: { state: '25' } });
vi.advanceTimersByTime(3000);
// Leave and cross back in: the hold restarts from zero.
setHass(stateManager, { [SENSOR]: { state: '10' } });
setHass(stateManager, { [SENSOR]: { state: '25' } });
vi.advanceTimersByTime(4000);
expect(callback).not.toHaveBeenCalled();
vi.advanceTimersByTime(1000);
expect(callback).toHaveBeenCalledTimes(1);
});
it('should not trigger when for is unparseable', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
for: 'not-a-duration',
});
trigger.subscribe(callback);
setHass(stateManager, { [SENSOR]: { state: '10' } });
setHass(stateManager, { [SENSOR]: { state: '25' } });
vi.advanceTimersByTime(100000);
expect(callback).not.toHaveBeenCalled();
});
});
it('should stop triggering after destroy', () => {
const { trigger, stateManager, callback } = create({
trigger: 'numeric_state',
entity_id: SENSOR,
above: 20,
});
trigger.subscribe(callback);
trigger.destroy();
setHass(stateManager, { [SENSOR]: { state: '10' } });
setHass(stateManager, { [SENSOR]: { state: '25' } });
expect(callback).not.toHaveBeenCalled();
});
});
tests/condition-trigger/triggers/triggers/screen.test.ts
+112
View File
@@ -0,0 +1,112 @@
import { afterEach, describe, expect, it, Mock, vi } from 'vitest';
import { ScreenTrigger } from '../../../../src/condition-trigger/triggers/triggers/screen';
import { TriggerOfType } from '../../../../src/condition-trigger/triggers/triggers/types';
// @vitest-environment jsdom
describe('ScreenTrigger', () => {
let matches = false;
const addEventListener = vi.fn();
const removeEventListener = vi.fn();
const mockMatchMedia = (): void => {
vi.spyOn(window, 'matchMedia').mockImplementation(
() =>
({
get matches(): boolean {
return matches;
},
addEventListener,
removeEventListener,
}) as unknown as MediaQueryList,
);
};
const subscribe = (
trigger: TriggerOfType<'screen'>,
): { screenTrigger: ScreenTrigger; callback: Mock } => {
const callback = vi.fn();
const screenTrigger = new ScreenTrigger(trigger);
screenTrigger.subscribe(callback);
return { screenTrigger, callback };
};
const fireMediaQueryChange = (): void => addEventListener.mock.calls[0][1]();
afterEach(() => {
vi.restoreAllMocks();
matches = false;
addEventListener.mockClear();
removeEventListener.mockClear();
});
it('should trigger on the rising edge of the media query match', () => {
mockMatchMedia();
const { callback } = subscribe({
trigger: 'screen',
media_query: '(orientation: landscape)',
});
matches = true;
fireMediaQueryChange();
expect(callback).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenCalledWith({ platform: 'acc', type: 'screen' });
});
it('should not trigger again while the query stays matching', () => {
mockMatchMedia();
const { callback } = subscribe({
trigger: 'screen',
media_query: '(orientation: landscape)',
});
matches = true;
fireMediaQueryChange();
fireMediaQueryChange();
expect(callback).toHaveBeenCalledTimes(1);
});
it('should not trigger on the falling edge of the match', () => {
mockMatchMedia();
const { callback } = subscribe({
trigger: 'screen',
media_query: '(orientation: landscape)',
});
matches = true;
fireMediaQueryChange();
matches = false;
fireMediaQueryChange();
expect(callback).toHaveBeenCalledTimes(1);
});
it('should not trigger when already matching at subscribe', () => {
matches = true;
mockMatchMedia();
const { callback } = subscribe({
trigger: 'screen',
media_query: '(orientation: landscape)',
});
fireMediaQueryChange();
expect(callback).not.toHaveBeenCalled();
});
it('should stop listening after destroy', () => {
mockMatchMedia();
const { screenTrigger } = subscribe({
trigger: 'screen',
media_query: '(orientation: landscape)',
});
screenTrigger.destroy();
expect(removeEventListener).toHaveBeenCalledWith('change', expect.anything());
});
it('should never trigger without a media query', () => {
mockMatchMedia();
const { callback } = subscribe({ trigger: 'screen' });
expect(addEventListener).not.toHaveBeenCalled();
expect(callback).not.toHaveBeenCalled();
});
});
tests/condition-trigger/triggers/triggers/state.test.ts
+487
View File
@@ -0,0 +1,487 @@
import { HassEntities, HassEntity } from 'home-assistant-js-websocket';
import { afterEach, beforeEach, describe, expect, it, Mock, vi } from 'vitest';
import { TemplateRenderer } from '../../../../src/card-controller/templates';
import { ConditionStateManager } from '../../../../src/condition-trigger/conditions/state-manager';
import { StateTrigger } from '../../../../src/condition-trigger/triggers/triggers/state';
import { TriggerOfType } from '../../../../src/condition-trigger/triggers/triggers/types';
import { createHASS, createStateEntity } from '../../../test-utils';
const ENTITY = 'binary_sensor.door';
const ENTITY_TWO = 'binary_sensor.window';
// @vitest-environment jsdom
describe('StateTrigger', () => {
const create = (
config: TriggerOfType<'state'>,
): {
trigger: StateTrigger;
stateManager: ConditionStateManager;
callback: Mock;
} => {
const stateManager = new ConditionStateManager();
const callback = vi.fn();
const trigger = new StateTrigger(config, {
stateManager,
templateRenderer: new TemplateRenderer(),
});
return { trigger, stateManager, callback };
};
const setHass = (
manager: ConditionStateManager,
states: Record<string, Partial<HassEntity>>,
): void => {
const entities: HassEntities = {};
for (const [id, partial] of Object.entries(states)) {
entities[id] = createStateEntity(partial);
}
manager.setState({ hass: createHASS(entities) });
};
it('should trigger on a transition to a matching state', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
to: 'on',
});
trigger.subscribe(callback);
setHass(stateManager, { [ENTITY]: { state: 'off' } });
expect(callback).not.toHaveBeenCalled();
setHass(stateManager, { [ENTITY]: { state: 'on' } });
expect(callback).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenCalledWith(
expect.objectContaining({ platform: 'state', entity_id: ENTITY, entity: ENTITY }),
);
});
it('should not trigger on a transition to a non-matching state', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
to: 'on',
});
trigger.subscribe(callback);
setHass(stateManager, { [ENTITY]: { state: 'off' } });
setHass(stateManager, { [ENTITY]: { state: 'unavailable' } });
expect(callback).not.toHaveBeenCalled();
});
it('should require the from state to match', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
from: 'off',
to: 'on',
});
trigger.subscribe(callback);
setHass(stateManager, { [ENTITY]: { state: 'unknown' } });
setHass(stateManager, { [ENTITY]: { state: 'on' } });
// From 'unknown', not 'off'.
expect(callback).not.toHaveBeenCalled();
setHass(stateManager, { [ENTITY]: { state: 'off' } });
setHass(stateManager, { [ENTITY]: { state: 'on' } });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should match not_to', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
not_to: 'unavailable',
});
trigger.subscribe(callback);
// Triggers (initial -> off, not unavailable).
setHass(stateManager, { [ENTITY]: { state: 'off' } });
expect(callback).toHaveBeenCalledTimes(1);
// To unavailable -> excluded.
setHass(stateManager, { [ENTITY]: { state: 'unavailable' } });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should exclude transitions from a not_from state', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
not_from: 'unavailable',
});
trigger.subscribe(callback);
// From undefined (not 'unavailable') -> triggers.
setHass(stateManager, { [ENTITY]: { state: 'unavailable' } });
expect(callback).toHaveBeenCalledTimes(1);
// From 'unavailable' -> excluded.
setHass(stateManager, { [ENTITY]: { state: 'on' } });
expect(callback).toHaveBeenCalledTimes(1);
// From 'on' -> triggers.
setHass(stateManager, { [ENTITY]: { state: 'off' } });
expect(callback).toHaveBeenCalledTimes(2);
});
it('should match a list of to-states', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
to: ['armed_home', 'armed_away'],
});
trigger.subscribe(callback);
setHass(stateManager, { [ENTITY]: { state: 'disarmed' } });
setHass(stateManager, { [ENTITY]: { state: 'armed_home' } });
expect(callback).toHaveBeenCalledTimes(1);
setHass(stateManager, { [ENTITY]: { state: 'armed_away' } });
expect(callback).toHaveBeenCalledTimes(2);
});
it('should fan out independently over a list of entities', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: [ENTITY, ENTITY_TWO],
to: 'on',
});
trigger.subscribe(callback);
setHass(stateManager, {
[ENTITY]: { state: 'off' },
[ENTITY_TWO]: { state: 'off' },
});
setHass(stateManager, { [ENTITY]: { state: 'on' }, [ENTITY_TWO]: { state: 'off' } });
expect(callback).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenLastCalledWith(
expect.objectContaining({ entity_id: ENTITY }),
);
setHass(stateManager, { [ENTITY]: { state: 'on' }, [ENTITY_TWO]: { state: 'on' } });
expect(callback).toHaveBeenCalledTimes(2);
expect(callback).toHaveBeenLastCalledWith(
expect.objectContaining({ entity_id: ENTITY_TWO }),
);
});
it('should not trigger for a watched entity that did not change', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
to: 'on',
});
trigger.subscribe(callback);
setHass(stateManager, { [ENTITY]: { state: 'off' } });
// An unrelated entity changes; ENTITY is unchanged so must not trigger.
setHass(stateManager, {
[ENTITY]: { state: 'off' },
[ENTITY_TWO]: { state: 'on' },
});
expect(callback).not.toHaveBeenCalled();
});
it('should provide the full from_state/to_state objects', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
to: 'on',
});
trigger.subscribe(callback);
setHass(stateManager, { [ENTITY]: { state: 'off' } });
setHass(stateManager, { [ENTITY]: { state: 'on' } });
expect(callback).toHaveBeenCalledWith(
expect.objectContaining({
from_state: expect.objectContaining({ state: 'off' }),
to_state: expect.objectContaining({ state: 'on' }),
}),
);
});
it('should accept the entity alias', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity: ENTITY,
to: 'on',
});
trigger.subscribe(callback);
setHass(stateManager, { [ENTITY]: { state: 'off' } });
setHass(stateManager, { [ENTITY]: { state: 'on' } });
expect(callback).toHaveBeenCalledTimes(1);
});
describe('attribute-only changes', () => {
it('should trigger on an attribute-only change when no from/to is set', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
});
trigger.subscribe(callback);
// Initial change.
setHass(stateManager, { [ENTITY]: { state: 'on', attributes: { a: 1 } } });
expect(callback).toHaveBeenCalledTimes(1);
// Attribute-only change still triggers.
setHass(stateManager, { [ENTITY]: { state: 'on', attributes: { a: 2 } } });
expect(callback).toHaveBeenCalledTimes(2);
});
it('should not trigger on an attribute-only change when a to is set', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
to: 'on',
});
trigger.subscribe(callback);
setHass(stateManager, { [ENTITY]: { state: 'off' } });
// Off -> on.
setHass(stateManager, { [ENTITY]: { state: 'on', attributes: { a: 1 } } });
expect(callback).toHaveBeenCalledTimes(1);
// Attribute-only -> suppressed.
setHass(stateManager, { [ENTITY]: { state: 'on', attributes: { a: 2 } } });
expect(callback).toHaveBeenCalledTimes(1);
});
});
it('should treat a null to as matching any state change but not attributes', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
to: null,
});
trigger.subscribe(callback);
setHass(stateManager, { [ENTITY]: { state: 'off' } });
expect(callback).toHaveBeenCalledTimes(1);
// Any state change.
setHass(stateManager, { [ENTITY]: { state: 'on' } });
expect(callback).toHaveBeenCalledTimes(2);
// Attribute-only suppressed (key present).
setHass(stateManager, { [ENTITY]: { state: 'on', attributes: { a: 1 } } });
expect(callback).toHaveBeenCalledTimes(2);
});
it('should match against an attribute', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
attribute: 'device_class',
to: 'door',
});
trigger.subscribe(callback);
setHass(stateManager, {
[ENTITY]: { state: 'on', attributes: { device_class: 'window' } },
});
expect(callback).not.toHaveBeenCalled();
setHass(stateManager, {
[ENTITY]: { state: 'on', attributes: { device_class: 'door' } },
});
expect(callback).toHaveBeenCalledTimes(1);
});
it('should not trigger when the watched attribute is unchanged', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
attribute: 'device_class',
to: 'door',
});
trigger.subscribe(callback);
setHass(stateManager, {
[ENTITY]: { state: 'on', attributes: { device_class: 'window' } },
});
// The state changes but the watched attribute does not -> ignored.
setHass(stateManager, {
[ENTITY]: { state: 'off', attributes: { device_class: 'window' } },
});
expect(callback).not.toHaveBeenCalled();
});
it('should treat an absent watched attribute as no value', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
attribute: 'device_class',
to: 'door',
});
trigger.subscribe(callback);
// The entity has no `device_class` attribute, so there is no value to match.
setHass(stateManager, { [ENTITY]: { state: 'on' } });
setHass(stateManager, { [ENTITY]: { state: 'off' } });
expect(callback).not.toHaveBeenCalled();
});
it('should trigger without a to_state when the entity is removed', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
});
trigger.subscribe(callback);
setHass(stateManager, { [ENTITY]: { state: 'on' } });
expect(callback).toHaveBeenCalledTimes(1);
// Remove the entity from hass entirely.
stateManager.setState({ hass: createHASS({}) });
expect(callback).toHaveBeenCalledTimes(2);
expect(callback).toHaveBeenLastCalledWith({
platform: 'state',
entity_id: ENTITY,
entity: ENTITY,
from_state: expect.objectContaining({ state: 'on' }),
});
});
describe('for', () => {
beforeEach(() => {
vi.useFakeTimers();
});
afterEach(() => {
vi.useRealTimers();
});
it('should trigger only after the state has been held for the duration', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
to: 'on',
for: '00:00:05',
});
trigger.subscribe(callback);
setHass(stateManager, { [ENTITY]: { state: 'off' } });
setHass(stateManager, { [ENTITY]: { state: 'on' } });
vi.advanceTimersByTime(4999);
expect(callback).not.toHaveBeenCalled();
vi.advanceTimersByTime(1);
expect(callback).toHaveBeenCalledTimes(1);
});
it('should cancel the pending trigger when the state leaves the match', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
to: 'on',
for: '00:00:05',
});
trigger.subscribe(callback);
setHass(stateManager, { [ENTITY]: { state: 'off' } });
setHass(stateManager, { [ENTITY]: { state: 'on' } });
vi.advanceTimersByTime(3000);
setHass(stateManager, { [ENTITY]: { state: 'off' } });
vi.advanceTimersByTime(5000);
expect(callback).not.toHaveBeenCalled();
});
it('should clear a pending for: timer on destroy', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
to: 'on',
for: '00:00:05',
});
trigger.subscribe(callback);
setHass(stateManager, { [ENTITY]: { state: 'off' } });
// Arms the for: timer.
setHass(stateManager, { [ENTITY]: { state: 'on' } });
trigger.destroy();
vi.advanceTimersByTime(5000);
expect(callback).not.toHaveBeenCalled();
});
it('should reset the for: timer on a fresh matching transition', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
to: ['on', 'off'],
for: '00:00:05',
});
trigger.subscribe(callback);
// Arms (to includes 'off').
setHass(stateManager, { [ENTITY]: { state: 'off' } });
vi.advanceTimersByTime(3000);
// Re-arms (resets the 5s).
setHass(stateManager, { [ENTITY]: { state: 'on' } });
vi.advanceTimersByTime(4000);
// Would have triggered at 5s without the reset.
expect(callback).not.toHaveBeenCalled();
vi.advanceTimersByTime(1000);
expect(callback).toHaveBeenCalledTimes(1);
});
it('should not cancel the for: hold on an attribute-only change', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
to: 'on',
for: '00:00:05',
});
trigger.subscribe(callback);
setHass(stateManager, { [ENTITY]: { state: 'off' } });
// Arms.
setHass(stateManager, { [ENTITY]: { state: 'on', attributes: { a: 1 } } });
vi.advanceTimersByTime(3000);
// The state stays 'on'; only an attribute moves -- the hold must continue.
setHass(stateManager, { [ENTITY]: { state: 'on', attributes: { a: 2 } } });
// 5s total since arming.
vi.advanceTimersByTime(2000);
expect(callback).toHaveBeenCalledTimes(1);
});
it('should not trigger when for is unparseable', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
to: 'on',
for: 'not-a-duration',
});
trigger.subscribe(callback);
setHass(stateManager, { [ENTITY]: { state: 'off' } });
setHass(stateManager, { [ENTITY]: { state: 'on' } });
vi.advanceTimersByTime(100000);
expect(callback).not.toHaveBeenCalled();
});
});
it('should stop triggering after destroy', () => {
const { trigger, stateManager, callback } = create({
trigger: 'state',
entity_id: ENTITY,
to: 'on',
});
trigger.subscribe(callback);
trigger.destroy();
setHass(stateManager, { [ENTITY]: { state: 'off' } });
setHass(stateManager, { [ENTITY]: { state: 'on' } });
expect(callback).not.toHaveBeenCalled();
});
});
tests/condition-trigger/triggers/triggers/template.test.ts
+193
View File
@@ -0,0 +1,193 @@
import { afterEach, beforeEach, describe, expect, it, Mock, vi } from 'vitest';
import { TemplateRenderer } from '../../../../src/card-controller/templates';
import { ConditionStateManager } from '../../../../src/condition-trigger/conditions/state-manager';
import { TemplateTrigger } from '../../../../src/condition-trigger/triggers/triggers/template';
import { TriggerOfType } from '../../../../src/condition-trigger/triggers/triggers/types';
import { createHASS, createStateEntity } from '../../../test-utils';
const ENTITY_ONE = 'sensor.foo';
const ENTITY_TWO = 'sensor.bar';
const ENTITY_ONE_ON_TEMPLATE = `{{ is_state("${ENTITY_ONE}", "on") }}`;
// @vitest-environment jsdom
describe('TemplateTrigger', () => {
const create = (
config: TriggerOfType<'template'>,
): {
trigger: TemplateTrigger;
stateManager: ConditionStateManager;
callback: Mock;
} => {
const stateManager = new ConditionStateManager();
const callback = vi.fn();
const trigger = new TemplateTrigger(config, {
stateManager,
templateRenderer: new TemplateRenderer(),
});
return { trigger, stateManager, callback };
};
const setSensor = (manager: ConditionStateManager, state: string): void => {
manager.setState({
hass: createHASS({ [ENTITY_ONE]: createStateEntity({ state }) }),
});
};
it('should trigger on the rising edge to true', () => {
const { trigger, stateManager, callback } = create({
trigger: 'template',
value_template: ENTITY_ONE_ON_TEMPLATE,
});
trigger.subscribe(callback);
setSensor(stateManager, 'off');
expect(callback).not.toHaveBeenCalled();
setSensor(stateManager, 'on');
expect(callback).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenCalledWith({ platform: 'template' });
});
it('should not trigger when the template is already true at subscribe', () => {
const { trigger, stateManager, callback } = create({
trigger: 'template',
value_template: ENTITY_ONE_ON_TEMPLATE,
});
setSensor(stateManager, 'on');
trigger.subscribe(callback);
// A later change that keeps the template true must not trigger.
stateManager.setState({
hass: createHASS({
[ENTITY_ONE]: createStateEntity({ state: 'on' }),
[ENTITY_TWO]: createStateEntity({ state: 'x' }),
}),
});
expect(callback).not.toHaveBeenCalled();
});
it('should not re-trigger while the template remains true', () => {
const { trigger, stateManager, callback } = create({
trigger: 'template',
value_template: ENTITY_ONE_ON_TEMPLATE,
});
trigger.subscribe(callback);
setSensor(stateManager, 'on');
expect(callback).toHaveBeenCalledTimes(1);
stateManager.setState({
hass: createHASS({
[ENTITY_ONE]: createStateEntity({ state: 'on' }),
[ENTITY_TWO]: createStateEntity({ state: 'y' }),
}),
});
expect(callback).toHaveBeenCalledTimes(1);
});
it('should trigger again after returning to false then true', () => {
const { trigger, stateManager, callback } = create({
trigger: 'template',
value_template: ENTITY_ONE_ON_TEMPLATE,
});
trigger.subscribe(callback);
setSensor(stateManager, 'on');
setSensor(stateManager, 'off');
setSensor(stateManager, 'on');
expect(callback).toHaveBeenCalledTimes(2);
});
it('should trigger immediately when "for" is zero', () => {
const { trigger, stateManager, callback } = create({
trigger: 'template',
value_template: ENTITY_ONE_ON_TEMPLATE,
for: 0,
});
trigger.subscribe(callback);
setSensor(stateManager, 'on');
expect(callback).toHaveBeenCalledTimes(1);
});
describe('for', () => {
beforeEach(() => {
vi.useFakeTimers();
});
afterEach(() => {
vi.useRealTimers();
});
it('should trigger only after the template has held true for the duration', () => {
const { trigger, stateManager, callback } = create({
trigger: 'template',
value_template: ENTITY_ONE_ON_TEMPLATE,
for: '00:00:05',
});
trigger.subscribe(callback);
setSensor(stateManager, 'on');
vi.advanceTimersByTime(4999);
expect(callback).not.toHaveBeenCalled();
vi.advanceTimersByTime(1);
expect(callback).toHaveBeenCalledTimes(1);
});
it('should cancel the pending trigger when the template goes false before the duration', () => {
const { trigger, stateManager, callback } = create({
trigger: 'template',
value_template: ENTITY_ONE_ON_TEMPLATE,
for: '00:00:05',
});
trigger.subscribe(callback);
setSensor(stateManager, 'on');
vi.advanceTimersByTime(3000);
setSensor(stateManager, 'off');
vi.advanceTimersByTime(5000);
expect(callback).not.toHaveBeenCalled();
});
it('should not trigger when "for" is unparseable', () => {
const { trigger, stateManager, callback } = create({
trigger: 'template',
value_template: ENTITY_ONE_ON_TEMPLATE,
for: 'not-a-duration',
});
trigger.subscribe(callback);
setSensor(stateManager, 'on');
vi.advanceTimersByTime(100000);
expect(callback).not.toHaveBeenCalled();
});
});
it('should stop triggering after destroy', () => {
const { trigger, stateManager, callback } = create({
trigger: 'template',
value_template: ENTITY_ONE_ON_TEMPLATE,
});
trigger.subscribe(callback);
trigger.destroy();
setSensor(stateManager, 'on');
expect(callback).not.toHaveBeenCalled();
});
it('should trigger on a string-truthy template value for HA symmetry', () => {
const { trigger, stateManager, callback } = create({
trigger: 'template',
// Renders the string "on"/"off", not a boolean; HA treats "on" as true.
value_template: `{{ "on" if is_state("${ENTITY_ONE}", "on") else "off" }}`,
});
trigger.subscribe(callback);
setSensor(stateManager, 'off');
expect(callback).not.toHaveBeenCalled();
setSensor(stateManager, 'on');
expect(callback).toHaveBeenCalledTimes(1);
});
});
tests/condition-trigger/triggers/triggers/triggered.test.ts
+41
View File
@@ -0,0 +1,41 @@
import { describe, expect, it, Mock, vi } from 'vitest';
import { TemplateRenderer } from '../../../../src/card-controller/templates';
import { ConditionStateManager } from '../../../../src/condition-trigger/conditions/state-manager';
import { TriggeredTrigger } from '../../../../src/condition-trigger/triggers/triggers/triggered';
import { TriggerOfType } from '../../../../src/condition-trigger/triggers/triggers/types';
// @vitest-environment jsdom
describe('TriggeredTrigger', () => {
const create = (
trigger: TriggerOfType<'triggered'>,
): { stateManager: ConditionStateManager; callback: Mock } => {
const stateManager = new ConditionStateManager();
const callback = vi.fn();
new TriggeredTrigger(trigger, {
stateManager,
templateRenderer: new TemplateRenderer(),
}).subscribe(callback);
return { stateManager, callback };
};
it('should trigger on any change to the triggered set without a value', () => {
const { stateManager, callback } = create({ trigger: 'triggered' });
stateManager.setState({ triggered: new Set(['front']) });
stateManager.setState({ triggered: new Set(['front', 'back']) });
stateManager.setState({ triggered: new Set() });
expect(callback).toHaveBeenCalledTimes(3);
});
it('should trigger only when a listed camera is among the triggered set', () => {
const { stateManager, callback } = create({
trigger: 'triggered',
triggered: ['front'],
});
stateManager.setState({ triggered: new Set(['back']) });
expect(callback).not.toHaveBeenCalled();
stateManager.setState({ triggered: new Set(['front']) });
expect(callback).toHaveBeenCalledTimes(1);
});
});
tests/condition-trigger/triggers/triggers/view.test.ts
+95
View File
@@ -0,0 +1,95 @@
import { describe, expect, it, Mock, vi } from 'vitest';
import { TemplateRenderer } from '../../../../src/card-controller/templates';
import { ConditionStateManager } from '../../../../src/condition-trigger/conditions/state-manager';
import { TriggerOfType } from '../../../../src/condition-trigger/triggers/triggers/types';
import { ViewTrigger } from '../../../../src/condition-trigger/triggers/triggers/view';
// @vitest-environment jsdom
describe('ViewTrigger', () => {
const create = (
trigger: TriggerOfType<'view'>,
): {
viewTrigger: ViewTrigger;
stateManager: ConditionStateManager;
callback: Mock;
} => {
const stateManager = new ConditionStateManager();
const callback = vi.fn();
const viewTrigger = new ViewTrigger(trigger, {
stateManager,
templateRenderer: new TemplateRenderer(),
});
return { viewTrigger, stateManager, callback };
};
it('should trigger when the selected view changes to a listed one', () => {
const { viewTrigger, stateManager, callback } = create({
trigger: 'view',
views: ['live'],
});
viewTrigger.subscribe(callback);
stateManager.setState({ view: 'clip' });
expect(callback).not.toHaveBeenCalled();
stateManager.setState({ view: 'live' });
expect(callback).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenLastCalledWith({
platform: 'acc',
type: 'view',
from_acc: { view: 'clip' },
to_acc: { view: 'live' },
});
});
it('should trigger again when the view changes between two listed views', () => {
const { viewTrigger, stateManager, callback } = create({
trigger: 'view',
views: ['live', 'clips'],
});
viewTrigger.subscribe(callback);
stateManager.setState({ view: 'live' });
expect(callback).toHaveBeenCalledTimes(1);
stateManager.setState({ view: 'clips' });
expect(callback).toHaveBeenCalledTimes(2);
});
it('should not trigger once the view leaves the listed set', () => {
const { viewTrigger, stateManager, callback } = create({
trigger: 'view',
views: ['live'],
});
viewTrigger.subscribe(callback);
stateManager.setState({ view: 'live' });
expect(callback).toHaveBeenCalledTimes(1);
stateManager.setState({ view: 'clips' });
expect(callback).toHaveBeenCalledTimes(1);
});
it('should trigger on any view change without a listed set', () => {
const { viewTrigger, stateManager, callback } = create({ trigger: 'view' });
viewTrigger.subscribe(callback);
stateManager.setState({ view: 'clips' });
expect(callback).toHaveBeenCalledTimes(1);
stateManager.setState({ view: 'live' });
expect(callback).toHaveBeenCalledTimes(2);
});
it('should stop triggering after destroy', () => {
const { viewTrigger, stateManager, callback } = create({
trigger: 'view',
views: ['live'],
});
viewTrigger.subscribe(callback);
viewTrigger.destroy();
stateManager.setState({ view: 'live' });
expect(callback).not.toHaveBeenCalled();
});
});