smpp-pdu 0.1.4

use std::convert::TryFrom;
use std::io;

use crate::pdu::formats::Integer4;
use crate::pdu::validate_command_length::{
    validate_command_length, CommandLengthError,
};

#[derive(Debug)]
pub enum CheckError {
    CommandLengthError(CommandLengthError),
    IoError(io::Error),
}

impl From<CommandLengthError> for CheckError {
    fn from(e: CommandLengthError) -> Self {
        CheckError::CommandLengthError(e)
    }
}

/// Note: if you have an io::Error that is an UnexpectedEof, then
/// CheckError is not the right response.  You should instead return
/// a CheckOutcome::Incomplete.  So after converting to a CheckError
/// you must perform an additional step to remap into the right
/// response.
impl From<io::Error> for CheckError {
    fn from(e: io::Error) -> Self {
        CheckError::IoError(e)
    }
}

#[derive(Debug, PartialEq)]
pub enum CheckOutcome {
    Ready,
    Incomplete,
}

pub fn check(bytes: &mut dyn io::BufRead) -> Result<CheckOutcome, CheckError> {
    match check_can_read(bytes) {
        Err(CheckError::IoError(e)) => match e.kind() {
            io::ErrorKind::UnexpectedEof => Ok(CheckOutcome::Incomplete),
            _ => Err(CheckError::IoError(e)),
        },
        Ok(()) => Ok(CheckOutcome::Ready),
        Err(e) => Err(e),
    }
}

/// Note: this returns a CheckError even if we got UnexpectedEof.  This must
/// be mapped through the logic in check() before we return it to our caller.
fn check_can_read(bytes: &mut dyn io::BufRead) -> Result<(), CheckError> {
    let command_length = Integer4::read(bytes)?;
    validate_command_length(&command_length)?;

    let len = usize::try_from(command_length.value - 4).map_err(|_| {
        CheckError::CommandLengthError(CommandLengthError::TooShort(
            command_length.value,
        ))
    })?;
    // Is there a better way than allocating this vector?
    let mut buf = Vec::with_capacity(len);
    buf.resize(len, 0);
    Ok(bytes.read_exact(buf.as_mut_slice())?)
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::io::Cursor;

    use crate::unittest_utils::FailingRead;

    const BIND_TRANSMITTER_RESP_PDU_PLUS_EXTRA: &[u8; 0x1b + 0xa] =
        b"\x00\x00\x00\x1b\x80\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x02\
        TestServer\0extrabytes";

    #[test]
    fn check_is_ok_if_more_bytes() {
        let mut cursor = Cursor::new(&BIND_TRANSMITTER_RESP_PDU_PLUS_EXTRA[..]);
        assert_eq!(check(&mut cursor).unwrap(), CheckOutcome::Ready);
    }

    #[test]
    fn check_is_ok_if_exact_bytes() {
        let mut cursor =
            Cursor::new(&BIND_TRANSMITTER_RESP_PDU_PLUS_EXTRA[..0x1b]);
        assert_eq!(check(&mut cursor).unwrap(), CheckOutcome::Ready);
    }

    #[test]
    fn check_is_incomplete_if_fewer_bytes() {
        let mut cursor =
            Cursor::new(&BIND_TRANSMITTER_RESP_PDU_PLUS_EXTRA[..0x1a]);
        assert_eq!(check(&mut cursor).unwrap(), CheckOutcome::Incomplete);
    }

    #[test]
    fn check_errors_if_read_error() {
        let mut failing_read = FailingRead::new_bufreader();
        assert!(matches!(
            check(&mut failing_read).unwrap_err(),
            CheckError::IoError(_)
        ));
    }

    #[test]
    fn check_errors_if_short_length() {
        const PDU: &[u8; 4] = b"\x00\x00\x00\x04";
        let mut cursor = Cursor::new(&PDU);

        let res = check(&mut cursor).unwrap_err();
        assert!(matches!(
            res,
            CheckError::CommandLengthError(CommandLengthError::TooShort(4))
        ));
    }

    #[test]
    fn check_errors_without_reading_all_if_long_length() {
        const PDU: &[u8; 16] =
            b"\xff\xff\xff\xff\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00";
        let mut cursor = Cursor::new(&PDU);

        let res = check(&mut cursor).unwrap_err();
        assert!(matches!(
            res,
            CheckError::CommandLengthError(CommandLengthError::TooLong(
                4294967295
            ))
        ));
    }
}