homebridge-prometheus-exporter/tests/aggregator.test.ts

import { describe, expect, test } from '@jest/globals'
import { DeviceBoundary } from '../src/boundaries'
import { Metric, aggregate } from '../src/metrics'
import dysonData from './fixtures/dyson.json'
import emptyData from './fixtures/empty.json'
import tpLinkData from './fixtures/tp-link.json'
import harmonyData from './fixtures/harmony.json'
import unknownUuidData from './fixtures/issues/gh-9-unknown-uuid.json'
import nullableValueData from './fixtures/issues/gh-19-nullable-value.json'

describe('Metrics aggregator', () => {
    const timestamp = new Date('2000-01-01 00:00:00 UTC')

    test('Aggregates homebridge-dyson fan metrics', () => {
        const dyson = DeviceBoundary.parse(dysonData)

        const expectedLabels = {
            bridge: 'Dyson bridge',
            device_id: 'AA:AA:AA:AA:AA:AA',
            firmware_revision: '21.04.03',
            hardware_revision: 'TP02',
            manufacturer: 'Dyson',
            model: 'Dyson Pure Cool Link Tower',
            name: 'Office',
            serial_number: 'NN2-EU-KKA0717A',
        }

        expect(aggregate([dyson], timestamp)).toEqual([
            new Metric('air_purifier_active', 0, timestamp, expectedLabels),
            new Metric('air_purifier_current_air_purifier_state', 0, timestamp, expectedLabels),
            new Metric('air_purifier_target_air_purifier_state', 0, timestamp, expectedLabels),
            new Metric('air_purifier_filter_life_level_percentage', 85, timestamp, expectedLabels),
            new Metric('air_purifier_rotation_speed_percentage', 100, timestamp, expectedLabels),
            new Metric('air_purifier_current_temperature_celsius', 22.8, timestamp, expectedLabels),
            new Metric('air_purifier_swing_mode', 0, timestamp, expectedLabels),
            new Metric('air_purifier_filter_change_indication', 0, timestamp, expectedLabels),
            new Metric('air_purifier_current_relative_humidity_percentage', 52, timestamp, expectedLabels),
            new Metric('air_purifier_air_quality', 2, timestamp, expectedLabels),
        ])
    })

    test('Aggregates empty accessory metrics to empty metrics', () => {
        const empty = DeviceBoundary.parse(emptyData)

        expect(aggregate([empty], timestamp)).toEqual([])
    })

    test('Aggregates TP-Link plugs metrics', () => {
        const tpLink = DeviceBoundary.parse(tpLinkData)

        const expectedLabelsAccessory1 = {
            bridge: 'TP-Link bridge',
            device_id: 'AA:AA:AA:AA:AA:AA',
            firmware_revision: '1.5.6 Build 191125 Rel.083657',
            hardware_revision: '2.0',
            manufacturer: 'TP-Link',
            model: 'HS110(EU)',
            name: 'Drucker',
            serial_number: 'AA:AA:AA:AA:AA:AA 8006106A8B451F91FA0498A6615963E019CCD80A',
        }

        const expectedLabelsAccessory2 = {
            bridge: 'TP-Link bridge',
            device_id: 'AA:AA:AA:AA:AA:AA',
            firmware_revision: '1.5.6 Build 191125 Rel.083657',
            hardware_revision: '2.0',
            manufacturer: 'TP-Link',
            model: 'HS110(EU)',
            name: 'Espressomaschine',
            serial_number: 'AA:AA:AA:AA:AA:AA 800614AA26608873C919E4592765404019F64D07',
        }

        expect(aggregate([tpLink], timestamp)).toEqual([
            new Metric('outlet_on', 0, timestamp, expectedLabelsAccessory1),
            new Metric('outlet_in_use', 0, timestamp, expectedLabelsAccessory1),
            new Metric('outlet_amperes_a', 0.03, timestamp, expectedLabelsAccessory1),
            new Metric('outlet_total_consumption_kwh', 0.051, timestamp, expectedLabelsAccessory1),
            new Metric('outlet_apparent_power_va', 53248.8, timestamp, expectedLabelsAccessory1),
            new Metric('outlet_volts_v', 230.8, timestamp, expectedLabelsAccessory1),
            new Metric('outlet_consumption_w', 0, timestamp, expectedLabelsAccessory1),

            new Metric('outlet_on', 0, timestamp, expectedLabelsAccessory2),
            new Metric('outlet_in_use', 0, timestamp, expectedLabelsAccessory2),
            new Metric('outlet_amperes_a', 0.03, timestamp, expectedLabelsAccessory2),
            new Metric('outlet_total_consumption_kwh', 13.025, timestamp, expectedLabelsAccessory2),
            new Metric('outlet_apparent_power_va', 53365.6, timestamp, expectedLabelsAccessory2),
            new Metric('outlet_volts_v', 231, timestamp, expectedLabelsAccessory2),
            new Metric('outlet_consumption_w', 0, timestamp, expectedLabelsAccessory2),
        ])
    })

    test('Aggregates homebridge-harmony remote metrics', () => {
        const harmony = DeviceBoundary.parse(harmonyData)

        const expectedLabels1 = {
            bridge: 'Harmony bridge',
            device_id: 'AA:AA:AA:AA:AA:AA',
            configured_name: 'Fernbedienung',
            firmware_revision: '1.6.2',
            manufacturer: 'Logitech',
            model: 'Fernbedienung Wohnzimmer',
            name: 'Fernbedienung Wohnzimmer',
            serial_number: '0e88f449-2720-4000-8c4b-06775986e8ac',
        }

        const expectedLabels2 = {
            bridge: 'Harmony bridge',
            device_id: 'AA:AA:AA:AA:AA:AA',
            configured_name: 'CD',
            firmware_revision: '1.6.2',
            manufacturer: 'Logitech',
            model: 'Fernbedienung Wohnzimmer',
            name: 'CD',
            serial_number: '0e88f449-2720-4000-8c4b-06775986e8ac',
        }

        const expectedLabels3 = {
            bridge: 'Harmony bridge',
            device_id: 'AA:AA:AA:AA:AA:AA',
            configured_name: 'AirPlay',
            firmware_revision: '1.6.2',
            manufacturer: 'Logitech',
            model: 'Fernbedienung Wohnzimmer',
            name: 'AirPlay',
            serial_number: '0e88f449-2720-4000-8c4b-06775986e8ac',
        }

        const expectedLabels4 = {
            bridge: 'Harmony bridge',
            device_id: 'AA:AA:AA:AA:AA:AA',
            firmware_revision: '1.6.2',
            manufacturer: 'Logitech',
            model: 'Fernbedienung Wohnzimmer',
            name: 'Fernbedienung Wohnzimmer',
            serial_number: '0e88f449-2720-4000-8c4b-06775986e8ac',
        }

        expect(aggregate([harmony], timestamp)).toEqual([
            new Metric('television_sleep_discovery_mode', 1, timestamp, expectedLabels1),
            new Metric('television_active', 0, timestamp, expectedLabels1),
            new Metric('television_active_identifier', 0, timestamp, expectedLabels1),

            new Metric('input_source_type', 10, timestamp, expectedLabels2),
            new Metric('input_source_is_configured', 1, timestamp, expectedLabels2),
            new Metric('input_source_current_visibility_state', 0, timestamp, expectedLabels2),
            new Metric('input_source_target_visibility_state', 0, timestamp, expectedLabels2),

            new Metric('input_source_type', 10, timestamp, expectedLabels3),
            new Metric('input_source_is_configured', 1, timestamp, expectedLabels3),
            new Metric('input_source_current_visibility_state', 0, timestamp, expectedLabels3),
            new Metric('input_source_target_visibility_state', 0, timestamp, expectedLabels3),

            new Metric('television_speaker_active', 1, timestamp, expectedLabels4),
            new Metric('television_speaker_volume_control_type', 3, timestamp, expectedLabels4),
            new Metric('television_speaker_mute', 0, timestamp, expectedLabels4),
            new Metric('television_speaker_volume_percentage', 50, timestamp, expectedLabels4),
        ])
    })

    test('Aggregates metrics with unknown service UUID as "custom"', () => {
        const expectedLabels = {
            bridge: 'Test bridge',
            device_id: 'AA:AA:AA:AA:AA:AA',
            name: 'Phoscon-GW',
        }

        const unknowmnUuid = DeviceBoundary.parse(unknownUuidData)

        expect(aggregate([unknowmnUuid], timestamp)).toEqual([
            new Metric('custom_heartrate_seconds', 5, timestamp, expectedLabels),
            new Metric('custom_transition_time_seconds', 0.4, timestamp, expectedLabels),
            new Metric('custom_restart', 0, timestamp, expectedLabels),
        ])
    })

    test('Aggregates metrics with nullable values', () => {
        const unknowmnValue = DeviceBoundary.parse(nullableValueData)

        expect(aggregate([unknowmnValue], timestamp)).toEqual([])
    })
})