rcodec 1.0.1

//
// Copyright (c) 2015-2019 Plausible Labs Cooperative, Inc.
// All rights reserved.
//

use std::fmt::Debug;

use pl_hlist::*;

use rcodec::byte_vector::ByteVector;
use rcodec::codec::*;
use rcodec::error::Error;
use rcodec::{byte_vector, hcodec, record_struct, struct_codec};

fn assert_round_trip<T, C>(codec: C, value: &T, raw_bytes: &Option<ByteVector>)
where
    T: 'static + Eq + Debug,
    C: Codec<Value = T>,
{
    // Encode
    let result = codec.encode(value).and_then(|encoded| {
        // Compare encoded bytes to the expected bytes, if provided
        let compare_result = match *raw_bytes {
            Some(ref expected) => {
                if encoded != *expected {
                    Err(Error::new(format!(
                        "Encoded bytes {:?} do not match expected bytes {:?}",
                        encoded, *expected
                    )))
                } else {
                    Ok(())
                }
            }
            None => Ok(()),
        };
        if let Err(error) = compare_result {
            return Err(error);
        }

        // Decode and drop the remainder
        codec.decode(&encoded).map(|decoded| decoded.value)
    });

    // Verify result
    match result {
        Ok(decoded) => assert_eq!(decoded, *value),
        Err(e) => panic!("Round-trip encoding failed: {}", e.message()),
    }
}

#[test]
fn a_u8_value_should_round_trip() {
    assert_round_trip(uint8, &7u8, &Some(byte_vector!(7)));
}

#[test]
fn a_u32_value_should_round_trip() {
    // This is an example from the README, so we spell it out longform instead of using `assert_round_trip`
    let codec = uint32;
    let v0 = 258u32;
    let bv = codec.encode(&v0).unwrap();
    assert_eq!(bv, byte_vector!(0x00, 0x00, 0x01, 0x02));
    let v1 = codec.decode(&bv).unwrap().value;
    assert_eq!(v0, v1);
}

#[derive(Debug, PartialEq, Eq, Clone, HListSupport)]
struct TestStruct {
    byte_field: u8,
    short_field: u16,
}

#[test]
fn a_simple_struct_should_round_trip() {
    // This is an example from the README, so we spell it out longform instead of using `assert_round_trip`
    let codec = struct_codec!(TestStruct from {uint8} :: {uint16});
    let s0 = TestStruct {
        byte_field: 7u8,
        short_field: 3u16,
    };
    let bv = codec.encode(&s0).unwrap();
    assert_eq!(bv, byte_vector!(7, 0, 3));
    let s1 = codec.decode(&bv).unwrap().value;
    assert_eq!(s0, s1);
}

#[derive(Debug, PartialEq, Eq, Clone, HListSupport)]
struct PacketHeader {
    version: u8,
    port: u16,
    checksum: u16,
    data_len: u16,
}

#[derive(Debug, PartialEq, Eq, Clone, HListSupport)]
struct Packet {
    header: PacketHeader,
    flags: u64,
    data: Vec<u8>,
}

#[test]
fn a_slightly_more_complex_struct_should_round_trip() {
    // This is an example from the README, so we spell it out longform instead of using `assert_round_trip`
    let magic = byte_vector!(0xCA, 0xFE, 0xCA, 0xFE);

    let header_codec = struct_codec!(
        PacketHeader from
        { "version"      => uint8  } ::
        { "port"         => uint16 } ::
        { "checksum"     => uint16 } ::
        { "data_len"     => uint16 }
    );

    let packet_codec = struct_codec!(
        Packet from
        { "magic"           => constant(&magic) } >>
        { "padding"         => ignore(4)        } >>
        { "header"          => header_codec     } >>= |hdr| {
            hcodec!(
                { "flags"    => uint64                                       } ::
                { "data"     => eager(bytes((hdr.data_len - 8u16) as usize)) })
        }
    );

    let p0 = Packet {
        header: PacketHeader {
            version: 1,
            port: 80,
            checksum: 0,
            data_len: 13,
        },
        flags: 666,
        data: vec![1, 2, 3, 4, 5],
    };
    let bv = packet_codec.encode(&p0).unwrap();
    let p1 = packet_codec.decode(&bv).unwrap().value;
    assert_eq!(p0, p1);
}

record_struct!(TestRecordVersion, compat_version: u8, feature_version: u8);

record_struct!(TestSectionRecord, offset: u8, length: u8);

record_struct!(
    TestFileHeader,
    version: TestRecordVersion,
    meta_section: TestSectionRecord,
    data_section: TestSectionRecord
);

record_struct!(
    TestFileItem,
    header: TestFileHeader,
    metadata: Vec<u8>,
    data: Vec<u8>
);

#[test]
fn a_complex_codec_should_round_trip() {
    const FILE_HEADER_SIZE: u8 = 6;

    let magic = byte_vector!(0xCA, 0xFE);

    let version_codec = struct_codec!(
        TestRecordVersion from
        { "compat_version"  => uint8  } ::
        { "feature_version" => uint8  } );

    let section_codec = || {
        struct_codec!(
        TestSectionRecord from
        { "section_offset"  => uint8  } ::
        { "section_length"  => uint8  } )
    };

    let header_codec = struct_codec!(
        TestFileHeader from
        { "magic"           => constant(&magic)      } >>
        { "file_version"    => version_codec         } ::
        { "meta_section"    => section_codec()       } ::
        { "data_section"    => section_codec()       } );

    let item_codec = struct_codec!(
    TestFileItem from
    { "header"          => header_codec } >>= |hdr| {
        let padding_1_len = (hdr.meta_section.offset - FILE_HEADER_SIZE) as usize;
        let metadata_len  = hdr.meta_section.length as usize;
        let padding_2_len = (hdr.data_section.offset as usize) - ((hdr.meta_section.offset as usize) + metadata_len);
        let data_len      = hdr.data_section.length as usize;
        hcodec!(
            { "padding_1"   => ignore(padding_1_len)      } >>
            { "metadata"    => eager(bytes(metadata_len)) } ::
            { "padding_2"   => ignore(padding_2_len)      } >>
            { "data"        => eager(bytes(data_len))     } )
    });

    let header = TestFileHeader {
        version: TestRecordVersion {
            compat_version: 1,
            feature_version: 2,
        },
        meta_section: TestSectionRecord {
            offset: FILE_HEADER_SIZE + 2,
            length: 2,
        },
        data_section: TestSectionRecord {
            offset: FILE_HEADER_SIZE + 6,
            length: 2,
        },
    };

    let item = TestFileItem {
        header,
        metadata: vec![1, 7],
        data: vec![6, 6],
    };

    assert_round_trip(
        item_codec,
        &item,
        &Some(byte_vector!(
            0xCA, 0xFE, // magic
            0x01, 0x02, // file_version
            0x08, 0x02, // meta_section
            0x0C, 0x02, // data_section
            0x00, 0x00, // padding_1 (ignored)
            0x01, 0x07, // metadata
            0x00, 0x00, // padding_2 (ignored)
            0x06, 0x06 // data
        )),
    );
}