Files
advanced-camera-card/tests/utils/ptz.test.ts
T
Dermot Duffy cc376a8be1 feat: Rename the card to advanced-camera-card (#1873)
Whilst the Frigate support in this card is the best among camera
engines, the name incorrectly suggests that Frigate is a requirement.
Instead, to broaden the appeal, change to more camera agnostic name.
This does not suggest any change in priority, role or support for
Frigate.

This change is likely to be bug prone, due to the size of the rename --
the code contains 1500+ references to "Frigate" most of which make sense
to rename, some which do not, all of which needed human assessment.

- Closes #1298


BREAKING CHANGE: References to `frigate-card` in all kinds of
configuration need to be updated to `advanced-camera-card`. An automated
config upgrade should take care of the majority of usecases (click `Edit
-> Upgrade -> Save`), though may not be perfect.
2025-02-06 19:32:32 -08:00

163 lines
4.6 KiB
TypeScript

import { describe, expect, it } from 'vitest';
import { Capabilities } from '../../src/camera-manager/capabilities';
import { AdvancedCameraCardView } from '../../src/config/types';
import { IMAGE_VIEW_ZOOM_TARGET_SENTINEL } from '../../src/const';
import {
getPTZTarget,
hasCameraTruePTZ,
ptzActionToCapabilityKey,
} from '../../src/utils/ptz';
import { MediaQueriesResults } from '../../src/view/media-queries-results';
import {
TestViewMedia,
createCameraManager,
createStore,
createView,
} from '../test-utils';
describe('getPTZTarget', () => {
describe('in a viewer view', () => {
it('with media', () => {
const media = [new TestViewMedia({ id: 'media-id' })];
const view = createView({
view: 'media',
queryResults: new MediaQueriesResults({ results: media, selectedIndex: 0 }),
});
expect(getPTZTarget(view, { cameraManager: createCameraManager() })).toEqual({
targetID: 'media-id',
type: 'digital',
});
});
it('without media', () => {
const view = createView({
view: 'media',
});
expect(getPTZTarget(view, { cameraManager: createCameraManager() })).toBeNull();
});
it('with true PTZ restriction', () => {
const media = [new TestViewMedia({ id: 'media-id' })];
const view = createView({
view: 'media',
queryResults: new MediaQueriesResults({ results: media, selectedIndex: 0 }),
});
expect(
getPTZTarget(view, { type: 'ptz', cameraManager: createCameraManager() }),
).toBeNull();
});
});
it('in image view', () => {
expect(getPTZTarget(createView({ view: 'image' }))).toEqual({
targetID: IMAGE_VIEW_ZOOM_TARGET_SENTINEL,
type: 'digital',
});
});
describe('in live view', () => {
it('without restriction with true PTZ capability', () => {
const view = createView({
view: 'live',
camera: 'camera-1',
});
const store = createStore([
{
cameraID: 'camera-1',
capabilities: new Capabilities({ ptz: { left: ['relative'] } }),
},
]);
expect(getPTZTarget(view, { cameraManager: createCameraManager(store) })).toEqual({
targetID: 'camera-1',
type: 'ptz',
});
});
it('without restriction without true PTZ capability', () => {
const view = createView({
view: 'live',
camera: 'camera-1',
});
expect(getPTZTarget(view, { cameraManager: createCameraManager() })).toEqual({
targetID: 'camera-1',
type: 'digital',
});
});
it('with truePTZ restriction without true PTZ capability', () => {
const view = createView({
view: 'live',
camera: 'camera-1',
});
expect(
getPTZTarget(view, { type: 'ptz', cameraManager: createCameraManager() }),
).toBeNull();
});
it('with digitalPTZ restriction with true PTZ capability', () => {
const view = createView({
view: 'live',
camera: 'camera-1',
});
const store = createStore([
{
cameraID: 'camera-1',
capabilities: new Capabilities({ ptz: { left: ['relative'] } }),
},
]);
expect(
getPTZTarget(view, {
type: 'digital',
cameraManager: createCameraManager(store),
}),
).toEqual({
targetID: 'camera-1',
type: 'digital',
});
});
});
describe('in non-media views', () => {
it.each([['timeline' as const], ['diagnostics' as const]])(
'%s',
(viewName: AdvancedCameraCardView) => {
const view = createView({
view: viewName,
});
expect(getPTZTarget(view, { cameraManager: createCameraManager() })).toBeNull();
},
);
});
});
describe('hasCameraTruePTZ', () => {
it('with true PTZ', () => {
const store = createStore([
{
cameraID: 'camera-1',
capabilities: new Capabilities({ ptz: { left: ['relative'] } }),
},
]);
expect(hasCameraTruePTZ(createCameraManager(store), 'camera-1')).toBeTruthy();
});
it('without true PTZ', () => {
expect(hasCameraTruePTZ(createCameraManager(createStore()), 'camera-1')).toBeFalsy();
});
});
it('ptzActionToCapabilityKey', () => {
expect(ptzActionToCapabilityKey('left')).toBe('left');
expect(ptzActionToCapabilityKey('right')).toBe('right');
expect(ptzActionToCapabilityKey('up')).toBe('up');
expect(ptzActionToCapabilityKey('down')).toBe('down');
expect(ptzActionToCapabilityKey('zoom_in')).toBe('zoomIn');
expect(ptzActionToCapabilityKey('zoom_out')).toBe('zoomOut');
expect(ptzActionToCapabilityKey('preset')).toBeNull();
});