From: Filip Schauer <f.schauer@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH v3 proxmox 3/3] compression: Add unit tests for the ZipEncoder
Date: Thu, 14 Dec 2023 15:48:22 +0100 [thread overview]
Message-ID: <20231214144824.100616-4-f.schauer@proxmox.com> (raw)
In-Reply-To: <20231214144824.100616-1-f.schauer@proxmox.com>
Signed-off-by: Filip Schauer <f.schauer@proxmox.com>
---
proxmox-compression/Cargo.toml | 2 +-
proxmox-compression/tests/zip.rs | 134 +++++++++++++++++++++++++++++++
2 files changed, 135 insertions(+), 1 deletion(-)
create mode 100644 proxmox-compression/tests/zip.rs
diff --git a/proxmox-compression/Cargo.toml b/proxmox-compression/Cargo.toml
index 49735cb..8c9c47e 100644
--- a/proxmox-compression/Cargo.toml
+++ b/proxmox-compression/Cargo.toml
@@ -27,5 +27,5 @@ proxmox-io = { workspace = true, features = [ "tokio" ] }
proxmox-lang.workspace = true
[dev-dependencies]
-tokio = { workspace = true, features = [ "macros" ] }
+tokio = { workspace = true, features = [ "macros", "rt" ] }
diff --git a/proxmox-compression/tests/zip.rs b/proxmox-compression/tests/zip.rs
new file mode 100644
index 0000000..f684ccc
--- /dev/null
+++ b/proxmox-compression/tests/zip.rs
@@ -0,0 +1,134 @@
+use proxmox_compression::zip::{FileType, ZipEncoder, ZipEntry};
+
+use anyhow::{ensure, Error};
+use flate2::{Decompress, FlushDecompress};
+use std::ffi::OsString;
+use tokio::test;
+
+fn check_zip_with_one_file(
+ bytes: Vec<u8>,
+ expected_file_name: &str,
+ expected_content: &[u8],
+ expected_file_attributes: u16,
+ is_file: bool,
+) -> Result<(), Error> {
+ ensure!(
+ &bytes[..4] == b"PK\x03\x04",
+ "ZIP magic number does not match"
+ );
+
+ let general_purpose_flags = &bytes[6..8];
+ let size_compressed = &bytes[18..22];
+ let size_uncompressed = &bytes[22..26];
+ let file_name_len = (bytes[26] as usize) | ((bytes[27] as usize) << 8);
+ let extra_len = (bytes[28] as usize) | ((bytes[29] as usize) << 8);
+ let file_name = &bytes[30..30 + file_name_len];
+ let mut offset = 30 + file_name_len;
+
+ assert_eq!(expected_file_name.as_bytes(), file_name);
+
+ offset += extra_len;
+
+ if is_file {
+ let mut decompress = Decompress::new(false);
+ let mut decompressed_data = vec![0u8; expected_content.len()];
+ decompress.decompress(
+ &bytes[offset..],
+ &mut decompressed_data,
+ FlushDecompress::Finish,
+ )?;
+
+ assert_eq!(decompressed_data, expected_content);
+
+ offset += decompress.total_in() as usize;
+ }
+
+ // Optional data descriptor
+ if &bytes[offset..offset + 4] == b"PK\x07\x08" {
+ offset += 4;
+
+ if (general_purpose_flags[0] & 0x08) == 0x08 {
+ offset += 12;
+
+ if size_compressed == b"\xff\xff\xff\xff" && size_uncompressed == b"\xff\xff\xff\xff" {
+ offset += 8;
+ }
+ }
+ }
+
+ ensure!(
+ &bytes[offset..offset + 4] == b"PK\x01\x02",
+ "Missing central directory file header"
+ );
+
+ let external_file_attributes = &bytes[offset + 38..offset + 42];
+ let file_attributes = u16::from_le_bytes(external_file_attributes[2..4].try_into()?);
+
+ assert_eq!(expected_file_attributes, file_attributes);
+
+ Ok(())
+}
+
+#[test]
+async fn test_zip_text_file() -> Result<(), Error> {
+ let mut target = Vec::new();
+
+ let source_contents = "bar";
+ let source = source_contents.as_bytes();
+
+ let mut zip_encoder = ZipEncoder::new(&mut target);
+ zip_encoder
+ .add_entry(
+ ZipEntry::new("foo.txt", 0, 0o755, FileType::Regular),
+ Some(source),
+ )
+ .await?;
+
+ zip_encoder.finish().await?;
+
+ check_zip_with_one_file(target, "foo.txt", b"bar", 0o100755, true)?;
+
+ Ok(())
+}
+
+#[test]
+async fn test_zip_symlink() -> Result<(), Error> {
+ let mut target = Vec::new();
+
+ let link_path = OsString::from("/dev/null");
+
+ let mut zip_encoder = ZipEncoder::new(&mut target);
+ let content: Option<tokio::fs::File> = None;
+ zip_encoder
+ .add_entry(
+ ZipEntry::new("link", 0, 0o755, FileType::Symlink(link_path)),
+ content,
+ )
+ .await?;
+
+ zip_encoder.finish().await?;
+
+ check_zip_with_one_file(target, "link", b"/dev/null", 0o120755, true)?;
+
+ Ok(())
+}
+
+#[test]
+async fn test_zip_directory() -> Result<(), Error> {
+ let mut target = Vec::new();
+
+ let mut zip_encoder = ZipEncoder::new(&mut target);
+ let content: Option<tokio::fs::File> = None;
+ zip_encoder
+ .add_entry(
+ ZipEntry::new("directory", 0, 0o755, FileType::Directory),
+ content,
+ )
+ .await?;
+
+ zip_encoder.finish().await?;
+
+ check_zip_with_one_file(target, "directory/", b"", 0o40755, false)?;
+
+ Ok(())
+}
--
2.39.2
next prev parent reply other threads:[~2023-12-14 14:49 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-14 14:48 [pbs-devel] [PATCH v3 many] fix #4995: Include symlinks in zip file restore Filip Schauer
2023-12-14 14:48 ` [pbs-devel] [PATCH v3 proxmox 1/3] compression: Add a FileType enum to ZipEntry Filip Schauer
2023-12-14 14:48 ` [pbs-devel] [PATCH v3 proxmox 2/3] compression: Add support for symlinks in zip files Filip Schauer
2023-12-20 13:20 ` Wolfgang Bumiller
2023-12-21 11:37 ` Filip Schauer
2023-12-21 12:03 ` Wolfgang Bumiller
2023-12-21 12:15 ` Filip Schauer
2023-12-21 12:11 ` Wolfgang Bumiller
2024-01-24 10:19 ` Filip Schauer
2023-12-14 14:48 ` Filip Schauer [this message]
2023-12-14 14:48 ` [pbs-devel] [PATCH v3 backup 1/2] pxar: Adopt FileType enum when creating a ZipEntry Filip Schauer
2023-12-14 14:48 ` [pbs-devel] [PATCH v3 backup 2/2] fix #4995: pxar: Include symlinks in zip file creation Filip Schauer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231214144824.100616-4-f.schauer@proxmox.com \
--to=f.schauer@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox