bacnet-objects 0.12.0

//! Lighting rows Tables 12-64 and 12-69 require that the objects used to lack
//! (#1092): Default_Ramp_Rate and Default_Step_Increment on Lighting Output,
//! and Current_Command_Priority on both objects. Lighting Output's
//! Default_Fade_Time, once a constant 0 below its range, joined them (#1111).
//! Lighting Output's COV_Increment follows them (#1227).

use super::*;
use bacnet_types::enums::{ErrorClass, ErrorCode};
use std::time::Duration;

fn assert_error<T: std::fmt::Debug>(result: Result<T, Error>, expected: ErrorCode) {
    match result {
        Err(Error::Protocol { class, code }) => {
            assert_eq!(class, ErrorClass::PROPERTY.to_raw() as u32);
            assert_eq!(code, expected.to_raw() as u32, "expected {expected:?}");
        }
        other => panic!("expected PROPERTY/{expected:?}, got {other:?}"),
    }
}

fn read(object: &dyn BACnetObject, property: PropertyIdentifier) -> PropertyValue {
    object.read_property(property, None).unwrap()
}

fn command(object: &mut dyn BACnetObject, value: PropertyValue, priority: u8) {
    object
        .write_property(
            PropertyIdentifier::PRESENT_VALUE,
            None,
            value,
            Some(priority),
        )
        .unwrap();
}

#[test]
fn lighting_output_default_ramp_rate_and_step_increment_take_writes_within_their_range() {
    for property in [
        PropertyIdentifier::DEFAULT_RAMP_RATE,
        PropertyIdentifier::DEFAULT_STEP_INCREMENT,
    ] {
        let mut lo = LightingOutputObject::new(1, "LO-1").unwrap();
        assert!(lo.is_writable_property(property));
        // Both ends of 0.1..=100.0 are allowed.
        for value in [0.1, 42.5, 100.0] {
            lo.write_property(property, None, PropertyValue::Real(value), None)
                .unwrap();
            assert_eq!(
                read(&lo, property),
                PropertyValue::Real(value),
                "{property:?}"
            );
        }
        // Outside the range, or not a number, the value stays at 100.0.
        for value in [0.0, 0.09, 100.01, -1.0, f32::NAN, f32::INFINITY] {
            assert_error(
                lo.write_property(property, None, PropertyValue::Real(value), None),
                ErrorCode::VALUE_OUT_OF_RANGE,
            );
            assert_eq!(read(&lo, property), PropertyValue::Real(100.0), "{value}");
        }
        for value in [PropertyValue::Unsigned(5), PropertyValue::Null] {
            assert_error(
                lo.write_property(property, None, value, None),
                ErrorCode::INVALID_DATA_TYPE,
            );
        }
        assert_eq!(read(&lo, property), PropertyValue::Real(100.0));
    }
}

#[test]
fn lighting_output_default_ramp_rate_and_step_increment_setters_share_the_range() {
    let mut lo = LightingOutputObject::new(1, "LO-1").unwrap();
    lo.set_default_ramp_rate(12.5).unwrap();
    lo.set_default_step_increment(0.5).unwrap();
    for value in [0.0, 100.5, f32::NAN] {
        assert_error(
            lo.set_default_ramp_rate(value),
            ErrorCode::VALUE_OUT_OF_RANGE,
        );
        assert_error(
            lo.set_default_step_increment(value),
            ErrorCode::VALUE_OUT_OF_RANGE,
        );
    }
    assert_eq!(
        read(&lo, PropertyIdentifier::DEFAULT_RAMP_RATE),
        PropertyValue::Real(12.5)
    );
    assert_eq!(
        read(&lo, PropertyIdentifier::DEFAULT_STEP_INCREMENT),
        PropertyValue::Real(0.5)
    );
}

#[test]
fn lighting_output_default_fade_time_starts_at_100_ms_and_takes_writes_within_its_range() {
    let fade = PropertyIdentifier::DEFAULT_FADE_TIME;
    let mut lo = LightingOutputObject::new(1, "LO-1").unwrap();
    // Clause 12.54.16 allows 100 ms to one day; a new object starts at 100.
    assert_eq!(read(&lo, fade), PropertyValue::Unsigned(100));
    assert!(lo.is_writable_property(fade));
    for value in [100, 2_500, 86_400_000] {
        lo.write_property(fade, None, PropertyValue::Unsigned(value), None)
            .unwrap();
        assert_eq!(read(&lo, fade), PropertyValue::Unsigned(value));
    }
    // Outside the range, including past u32, the value stays at one day.
    for value in [0, 99, 86_400_001, u64::from(u32::MAX) + 1, u64::MAX] {
        assert_error(
            lo.write_property(fade, None, PropertyValue::Unsigned(value), None),
            ErrorCode::VALUE_OUT_OF_RANGE,
        );
        assert_eq!(
            read(&lo, fade),
            PropertyValue::Unsigned(86_400_000),
            "{value}"
        );
    }
    for value in [
        PropertyValue::Real(500.0),
        PropertyValue::Signed(500),
        PropertyValue::Null,
    ] {
        assert_error(
            lo.write_property(fade, None, value, None),
            ErrorCode::INVALID_DATA_TYPE,
        );
    }
    assert_eq!(read(&lo, fade), PropertyValue::Unsigned(86_400_000));
}

#[test]
fn lighting_output_default_fade_time_setter_refuses_values_outside_its_range() {
    let mut lo = LightingOutputObject::new(1, "LO-1").unwrap();
    lo.set_default_fade_time(750).unwrap();
    for value in [0, 99, 86_400_001, u32::MAX] {
        assert_error(
            lo.set_default_fade_time(value),
            ErrorCode::VALUE_OUT_OF_RANGE,
        );
    }
    assert_eq!(
        read(&lo, PropertyIdentifier::DEFAULT_FADE_TIME),
        PropertyValue::Unsigned(750)
    );
}

/// Command and relinquish slots and check Current_Command_Priority names the
/// slot Present_Value comes from, or is Null on Relinquish_Default.
fn assert_current_command_priority_tracks_commands(
    object: &mut dyn BACnetObject,
    on: PropertyValue,
) {
    let ccp = PropertyIdentifier::CURRENT_COMMAND_PRIORITY;
    assert_eq!(read(object, ccp), PropertyValue::Null);
    command(object, on.clone(), 8);
    assert_eq!(read(object, ccp), PropertyValue::Unsigned(8));
    command(object, on.clone(), 16);
    assert_eq!(read(object, ccp), PropertyValue::Unsigned(8));
    command(object, on, 3);
    assert_eq!(read(object, ccp), PropertyValue::Unsigned(3));
    command(object, PropertyValue::Null, 3);
    assert_eq!(read(object, ccp), PropertyValue::Unsigned(8));
    command(object, PropertyValue::Null, 8);
    assert_eq!(read(object, ccp), PropertyValue::Unsigned(16));
    command(object, PropertyValue::Null, 16);
    assert_eq!(read(object, ccp), PropertyValue::Null);
    // Derived from Priority_Array, so no write reaches it.
    assert!(!object.is_writable_property(ccp));
    for value in [PropertyValue::Unsigned(8), PropertyValue::Null] {
        assert_error(
            object.write_property(ccp, None, value, None),
            ErrorCode::WRITE_ACCESS_DENIED,
        );
    }
    assert_eq!(read(object, ccp), PropertyValue::Null);
}

#[test]
fn lighting_output_current_command_priority_names_the_winning_slot() {
    let mut lo = LightingOutputObject::new(1, "LO-1").unwrap();
    assert_current_command_priority_tracks_commands(&mut lo, PropertyValue::Real(60.0));
}

#[test]
fn binary_lighting_output_current_command_priority_names_the_winning_slot() {
    let mut blo = BinaryLightingOutputObject::new(1, "BLO-1").unwrap();
    assert_current_command_priority_tracks_commands(&mut blo, PropertyValue::Enumerated(1));
}

#[test]
fn binary_lighting_output_current_command_priority_holds_through_egress() {
    let mut blo = BinaryLightingOutputObject::new(1, "BLO-1").unwrap();
    blo.write_property(
        PropertyIdentifier::BLINK_WARN_ENABLE,
        None,
        PropertyValue::Boolean(true),
        None,
    )
    .unwrap();
    blo.write_property(
        PropertyIdentifier::EGRESS_TIME,
        None,
        PropertyValue::Unsigned(5),
        None,
    )
    .unwrap();
    command(&mut blo, PropertyValue::Enumerated(1), 8);
    // WARN_RELINQUISH keeps the light on at priority 8 until egress ends.
    command(&mut blo, PropertyValue::Enumerated(4), 8);
    let ccp = PropertyIdentifier::CURRENT_COMMAND_PRIORITY;
    assert_eq!(
        read(&blo, PropertyIdentifier::EGRESS_ACTIVE),
        PropertyValue::Boolean(true)
    );
    assert_eq!(read(&blo, ccp), PropertyValue::Unsigned(8));
    assert!(blo.advance_time_internal(Duration::from_secs(5)));
    assert_eq!(read(&blo, ccp), PropertyValue::Null);
}

#[test]
fn lighting_output_cov_increment_starts_at_zero_and_takes_writes() {
    let mut lo = LightingOutputObject::new(1, "LO-1").unwrap();
    assert!(lo.is_writable_property(PropertyIdentifier::COV_INCREMENT));
    assert_eq!(
        read(&lo, PropertyIdentifier::COV_INCREMENT),
        PropertyValue::Real(0.0)
    );
    assert_eq!(lo.cov_increment(), Some(0.0));
    lo.write_property(
        PropertyIdentifier::COV_INCREMENT,
        None,
        PropertyValue::Real(2.5),
        None,
    )
    .unwrap();
    assert_eq!(
        read(&lo, PropertyIdentifier::COV_INCREMENT),
        PropertyValue::Real(2.5)
    );
    assert_eq!(lo.cov_increment(), Some(2.5));
    assert!(lo
        .property_list()
        .contains(&PropertyIdentifier::COV_INCREMENT));
}

#[test]
fn lighting_output_cov_increment_refuses_bad_values_and_keeps_the_old_one() {
    let mut lo = LightingOutputObject::new(1, "LO-1").unwrap();
    lo.write_property(
        PropertyIdentifier::COV_INCREMENT,
        None,
        PropertyValue::Real(1.0),
        None,
    )
    .unwrap();
    for value in [-0.5, f32::NAN, f32::INFINITY] {
        assert_error(
            lo.write_property(
                PropertyIdentifier::COV_INCREMENT,
                None,
                PropertyValue::Real(value),
                None,
            ),
            ErrorCode::VALUE_OUT_OF_RANGE,
        );
    }
    assert_error(
        lo.write_property(
            PropertyIdentifier::COV_INCREMENT,
            None,
            PropertyValue::Unsigned(3),
            None,
        ),
        ErrorCode::INVALID_DATA_TYPE,
    );
    assert_eq!(lo.cov_increment(), Some(1.0));
}

#[test]
fn binary_lighting_output_has_no_cov_increment() {
    let blo = BinaryLightingOutputObject::new(1, "BLO-1").unwrap();
    assert_eq!(blo.cov_increment(), None);
}