nuts-archive 0.7.9

// MIT License
//
// Copyright (c) 2023,2024 Robin Doer
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.

macro_rules! make_tests {
    ($setup:ident) => {
        #[test]
        fn no_content() {
            let mut archive = setup_archive_with_bsize(FULL as u32);
            $setup(&mut archive).build().unwrap();

            let id = lookup(&mut archive, 0).unwrap().clone();
            assert!(lookup(&mut archive, 1).is_none());

            let mut reader = archive.pager.read_buf(&id).unwrap();
            let entry = reader.read::<Inner>().unwrap();

            assert_eq!(entry.name, "foo");
            assert_eq!(entry.size, 0);
        }

        #[test]
        fn one_block() {
            let mut archive = setup_archive_with_bsize(FULL as u32);
            let mut entry = $setup(&mut archive).build().unwrap();

            assert_eq!(
                entry.write(&(0..FULL).collect::<Vec<u8>>()).unwrap(),
                FULL as usize
            );

            let id0 = lookup(&mut archive, 0).unwrap().clone();
            let id1 = lookup(&mut archive, 1).unwrap().clone();
            assert!(lookup(&mut archive, 2).is_none());

            let mut reader = archive.pager.read_buf(&id0).unwrap();
            let entry = reader.read::<Inner>().unwrap();

            assert_eq!(entry.name, "foo");
            assert_eq!(entry.size, FULL as u64);

            let buf = archive.pager.read_buf_raw(&id1).unwrap();
            assert_eq!(buf, (0..FULL).collect::<Vec<u8>>());
        }

        #[test]
        fn one_byte_one_block() {
            let mut archive = setup_archive_with_bsize(FULL as u32);
            let mut entry = $setup(&mut archive).build().unwrap();

            for i in 0..FULL {
                assert_eq!(entry.write(&[i]).unwrap(), 1);
            }

            let id0 = lookup(&mut archive, 0).unwrap().clone();
            let id1 = lookup(&mut archive, 1).unwrap().clone();
            assert!(lookup(&mut archive, 2).is_none());

            let mut reader = archive.pager.read_buf(&id0).unwrap();
            let entry = reader.read::<Inner>().unwrap();

            assert_eq!(entry.name, "foo");
            assert_eq!(entry.size, FULL as u64);

            let buf = archive.pager.read_buf_raw(&id1).unwrap();
            assert_eq!(buf, (0..FULL).collect::<Vec<u8>>());
        }

        #[test]
        fn one_byte_one_half_blocks() {
            let mut archive = setup_archive_with_bsize(FULL as u32);
            let mut entry = $setup(&mut archive).build().unwrap();

            for i in 0..FULL + HALF {
                assert_eq!(entry.write(&[i]).unwrap(), 1);
            }

            let id0 = lookup(&mut archive, 0).unwrap().clone();
            let id1 = lookup(&mut archive, 1).unwrap().clone();
            let id2 = lookup(&mut archive, 2).unwrap().clone();
            assert!(lookup(&mut archive, 3).is_none());

            let mut reader = archive.pager.read_buf(&id0).unwrap();
            let entry = reader.read::<Inner>().unwrap();

            assert_eq!(entry.name, "foo");
            assert_eq!(entry.size, FULL as u64 + HALF as u64);

            let buf = archive.pager.read_buf_raw(&id1).unwrap();
            assert_eq!(buf, (0..FULL).collect::<Vec<u8>>());

            let buf = archive.pager.read_buf_raw(&id2).unwrap();
            assert_eq!(
                buf[..HALF as usize],
                (FULL..FULL + HALF).collect::<Vec<u8>>()
            );
            assert_eq!(buf[HALF as usize..], [0; HALF as usize]);
        }

        #[test]
        fn one_byte_two_blocks() {
            let mut archive = setup_archive_with_bsize(FULL as u32);
            let mut entry = $setup(&mut archive).build().unwrap();

            for i in 0..2 * FULL {
                assert_eq!(entry.write(&[i]).unwrap(), 1);
            }

            let id0 = lookup(&mut archive, 0).unwrap().clone();
            let id1 = lookup(&mut archive, 1).unwrap().clone();
            let id2 = lookup(&mut archive, 2).unwrap().clone();
            assert!(lookup(&mut archive, 3).is_none());

            let mut reader = archive.pager.read_buf(&id0).unwrap();
            let entry = reader.read::<Inner>().unwrap();

            assert_eq!(entry.name, "foo");
            assert_eq!(entry.size, 2 * FULL as u64);

            let buf = archive.pager.read_buf_raw(&id1).unwrap();
            assert_eq!(buf, (0..FULL).collect::<Vec<u8>>());

            let buf = archive.pager.read_buf_raw(&id2).unwrap();
            assert_eq!(buf, (FULL..2 * FULL).collect::<Vec<u8>>());
        }

        #[test]
        fn two_bytes_one_block() {
            let mut archive = setup_archive_with_bsize(FULL as u32);
            let mut entry = $setup(&mut archive).build().unwrap();

            for buf in (0..FULL).collect::<Vec<u8>>().chunks(2) {
                assert_eq!(buf.len(), 2);
                assert_eq!(entry.write(buf).unwrap(), 2);
            }

            let id0 = lookup(&mut archive, 0).unwrap().clone();
            let id1 = lookup(&mut archive, 1).unwrap().clone();
            assert!(lookup(&mut archive, 2).is_none());

            let mut reader = archive.pager.read_buf(&id0).unwrap();
            let entry = reader.read::<Inner>().unwrap();

            assert_eq!(entry.name, "foo");
            assert_eq!(entry.size, FULL as u64);

            let buf = archive.pager.read_buf_raw(&id1).unwrap();
            assert_eq!(buf, (0..FULL).collect::<Vec<u8>>());
        }

        #[test]
        fn two_bytes_one_half_blocks() {
            let mut archive = setup_archive_with_bsize(FULL as u32);
            let mut entry = $setup(&mut archive).build().unwrap();

            for buf in (0..FULL + HALF + 1).collect::<Vec<u8>>().chunks(2) {
                assert_eq!(buf.len(), 2);
                assert_eq!(entry.write(buf).unwrap(), 2);
            }

            let id0 = lookup(&mut archive, 0).unwrap().clone();
            let id1 = lookup(&mut archive, 1).unwrap().clone();
            let id2 = lookup(&mut archive, 2).unwrap().clone();
            assert!(lookup(&mut archive, 3).is_none());

            let mut reader = archive.pager.read_buf(&id0).unwrap();
            let entry = reader.read::<Inner>().unwrap();

            assert_eq!(entry.name, "foo");
            assert_eq!(entry.size, FULL as u64 + HALF as u64 + 1);

            let buf = archive.pager.read_buf_raw(&id1).unwrap();
            assert_eq!(buf, (0..FULL).collect::<Vec<u8>>());

            let buf = archive.pager.read_buf_raw(&id2).unwrap();
            assert_eq!(
                buf[..HALF as usize + 1],
                (FULL..FULL + HALF + 1).collect::<Vec<u8>>()
            );
            assert_eq!(buf[HALF as usize + 1..], [0; HALF as usize - 1]);
        }

        #[test]
        fn two_bytes_two_blocks() {
            let mut archive = setup_archive_with_bsize(FULL as u32);
            let mut entry = $setup(&mut archive).build().unwrap();

            for buf in (0..2 * FULL).collect::<Vec<u8>>().chunks(2) {
                assert_eq!(buf.len(), 2);
                assert_eq!(entry.write(buf).unwrap(), 2);
            }

            let id0 = lookup(&mut archive, 0).unwrap().clone();
            let id1 = lookup(&mut archive, 1).unwrap().clone();
            let id2 = lookup(&mut archive, 2).unwrap().clone();
            assert!(lookup(&mut archive, 3).is_none());

            let mut reader = archive.pager.read_buf(&id0).unwrap();
            let entry = reader.read::<Inner>().unwrap();

            assert_eq!(entry.name, "foo");
            assert_eq!(entry.size, 2 * FULL as u64);

            let buf = archive.pager.read_buf_raw(&id1).unwrap();
            assert_eq!(buf, (0..FULL).collect::<Vec<u8>>());

            let buf = archive.pager.read_buf_raw(&id2).unwrap();
            assert_eq!(buf, (FULL..2 * FULL).collect::<Vec<u8>>());
        }

        #[test]
        fn three_bytes_one_block() {
            let mut archive = setup_archive_with_bsize(FULL as u32);
            let mut entry = $setup(&mut archive).build().unwrap();

            for buf in (0..FULL - 1).collect::<Vec<u8>>().chunks(3) {
                assert_eq!(buf.len(), 3);
                assert_eq!(entry.write(buf).unwrap(), 3);
            }

            assert_eq!(entry.write(&[FULL - 1, FULL, FULL + 1]).unwrap(), 1);

            let id0 = lookup(&mut archive, 0).unwrap().clone();
            let id1 = lookup(&mut archive, 1).unwrap().clone();
            assert!(lookup(&mut archive, 2).is_none());

            let mut reader = archive.pager.read_buf(&id0).unwrap();
            let entry = reader.read::<Inner>().unwrap();

            assert_eq!(entry.name, "foo");
            assert_eq!(entry.size, FULL as u64);

            let buf = archive.pager.read_buf_raw(&id1).unwrap();
            assert_eq!(buf, (0..FULL).collect::<Vec<u8>>());
        }

        #[test]
        fn three_bytes_one_half_blocks() {
            let mut archive = setup_archive_with_bsize(FULL as u32);
            let mut entry = $setup(&mut archive).build().unwrap();

            for buf in (0..FULL - 1).collect::<Vec<u8>>().chunks(3) {
                assert_eq!(buf.len(), 3);
                assert_eq!(entry.write(buf).unwrap(), 3);
            }

            assert_eq!(entry.write(&[FULL - 1, FULL, FULL + 1]).unwrap(), 1);

            for buf in (FULL..FULL + HALF - 2).collect::<Vec<u8>>().chunks(3) {
                assert_eq!(buf.len(), 3);
                assert_eq!(entry.write(buf).unwrap(), 3);
            }

            let id0 = lookup(&mut archive, 0).unwrap().clone();
            let id1 = lookup(&mut archive, 1).unwrap().clone();
            let id2 = lookup(&mut archive, 2).unwrap().clone();
            assert!(lookup(&mut archive, 3).is_none());

            let mut reader = archive.pager.read_buf(&id0).unwrap();
            let entry = reader.read::<Inner>().unwrap();

            assert_eq!(entry.name, "foo");
            assert_eq!(entry.size, FULL as u64 + HALF as u64 - 2);

            let buf = archive.pager.read_buf_raw(&id1).unwrap();
            assert_eq!(buf, (0..FULL).collect::<Vec<u8>>());

            let buf = archive.pager.read_buf_raw(&id2).unwrap();
            assert_eq!(
                buf[..HALF as usize - 2],
                (FULL..FULL + HALF - 2).collect::<Vec<u8>>()
            );
            assert_eq!(buf[HALF as usize - 2..], [0; HALF as usize + 2]);
        }

        #[test]
        fn three_bytes_two_blocks() {
            let mut archive = setup_archive_with_bsize(FULL as u32);
            let mut entry = $setup(&mut archive).build().unwrap();

            for buf in (0..FULL - 1).collect::<Vec<u8>>().chunks(3) {
                assert_eq!(buf.len(), 3);
                assert_eq!(entry.write(buf).unwrap(), 3);
            }

            assert_eq!(entry.write(&[FULL - 1, FULL, FULL + 1]).unwrap(), 1);

            for buf in (FULL..2 * FULL - 1).collect::<Vec<u8>>().chunks(3) {
                assert_eq!(buf.len(), 3);
                assert_eq!(entry.write(buf).unwrap(), 3);
            }

            assert_eq!(
                entry
                    .write(&[2 * FULL - 1, 2 * FULL, 2 * FULL + 1])
                    .unwrap(),
                1
            );

            let id0 = lookup(&mut archive, 0).unwrap().clone();
            let id1 = lookup(&mut archive, 1).unwrap().clone();
            let id2 = lookup(&mut archive, 2).unwrap().clone();
            assert!(lookup(&mut archive, 3).is_none());

            let mut reader = archive.pager.read_buf(&id0).unwrap();
            let entry = reader.read::<Inner>().unwrap();

            assert_eq!(entry.name, "foo");
            assert_eq!(entry.size, 2 * FULL as u64);

            let buf = archive.pager.read_buf_raw(&id1).unwrap();
            assert_eq!(buf, (0..FULL).collect::<Vec<u8>>());

            let buf = archive.pager.read_buf_raw(&id2).unwrap();
            assert_eq!(buf, (FULL..2 * FULL).collect::<Vec<u8>>());
        }
    };
}

mod inner {
    use crate::entry::r#mut::tests::{lookup, setup_inner_builder};
    use crate::entry::Inner;
    use crate::entry::{FULL, HALF};
    use crate::tests::setup_archive_with_bsize;

    make_tests!(setup_inner_builder);
}

mod file {
    use crate::entry::r#mut::tests::{lookup, setup_file_builder};
    use crate::entry::Inner;
    use crate::entry::{FULL, HALF};
    use crate::tests::setup_archive_with_bsize;

    make_tests!(setup_file_builder);
}