From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gate001.proxmox.com (gate001.proxmox.com [45.144.208.40]) by lore.proxmox.com (Postfix) with ESMTPS id 7B4D81FF125 for ; Fri, 31 Jul 2026 16:25:14 +0200 (CEST) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id 4C25A2156E; Fri, 31 Jul 2026 16:25:14 +0200 (CEST) From: Robert Obkircher To: pbs-devel@lists.proxmox.com Subject: [PATCH proxmox-backup 3/9] datastore: add tests for fixed and dynamic index reader Date: Fri, 31 Jul 2026 16:21:16 +0200 Message-ID: <20260731142430.289893-4-r.obkircher@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20260731142430.289893-1-r.obkircher@proxmox.com> References: <20260731142430.289893-1-r.obkircher@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1785507898984 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.147 Adjusted score from AWL reputation of From: address DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment (newer systems) RCVD_IN_DNSWL_LOW -0.7 Sender listed at https://www.dnswl.org/, low trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: NT35IUS5OSY32VJFH64BVIW5SPSRFUVQ X-Message-ID-Hash: NT35IUS5OSY32VJFH64BVIW5SPSRFUVQ X-MailFrom: r.obkircher@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox Backup Server development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Focus on the error paths to make it more visible if they change during refactoring. Signed-off-by: Robert Obkircher --- pbs-datastore/src/dynamic_index.rs | 77 ++++++++++++++++++++++++++ pbs-datastore/src/fixed_index.rs | 86 ++++++++++++++++++++++++++++++ 2 files changed, 163 insertions(+) diff --git a/pbs-datastore/src/dynamic_index.rs b/pbs-datastore/src/dynamic_index.rs index a0d9369a5..7ee8bdcab 100644 --- a/pbs-datastore/src/dynamic_index.rs +++ b/pbs-datastore/src/dynamic_index.rs @@ -586,3 +586,80 @@ impl ReadAt for LocalDynamicReadAt { panic!("LocalDynamicReadAt::start_read_at returned Pending"); } } + +#[cfg(test)] +mod tests { + use std::fs; + + use openssl::sha::sha256; + use tempfile::TempDir; + + use super::*; + + #[track_caller] + fn check_error_contains(result: Result, substring: &str) { + let error = result.map(|_| ()).unwrap_err().to_string(); + assert!( + error.contains(substring), + "'{error}' does not contain '{substring}'" + ); + } + + #[test] + fn test_index_reader() { + let dir = TempDir::new().unwrap(); + + check_error_contains( + DynamicIndexReader::open(Path::new("/dev/stdin")), + "Illegal seek", + ); + check_error_contains( + DynamicIndexReader::open(Path::new("/dev/zero")), + "index too small (0)", + ); + + let path = dir.path().join("file"); + check_error_contains(DynamicIndexReader::open(&path), "No such file or directory"); + + fs::write(&path, []).unwrap(); + check_error_contains(DynamicIndexReader::open(&path), "index too small (0)"); + + let mut data = vec![0; size_of::()]; + + fs::write(&path, &data).unwrap(); + check_error_contains(DynamicIndexReader::open(&path), "got unknown magic number"); + + data[..8].copy_from_slice(&file_formats::DYNAMIC_SIZED_CHUNK_INDEX_1_0); + fs::write(&path, &data).unwrap(); + check_error_contains( + DynamicIndexReader::open(&path), + "mapped length must not be zero", + ); + + data.extend_from_slice(&[0, 1, 2]); + fs::write(&path, &data).unwrap(); + check_error_contains(DynamicIndexReader::open(&path), "got unexpected file size"); + + data.extend(3u8..80); + fs::write(&path, &data).unwrap(); + let reader = DynamicIndexReader::open(&path).unwrap(); + let size = u64::from_le_bytes(std::array::from_fn(|i| i as u8 + 40)); + assert_eq!(reader.index_bytes(), size); + assert_eq!(reader.index_size(), 4096 + 80); + assert_eq!(reader.index_count(), 2); + assert_eq!( + reader.index_digest(0), + Some(&std::array::from_fn(|i| i as u8 + 8)) + ); + assert_eq!( + reader.index_digest(1), + Some(&std::array::from_fn(|i| i as u8 + 48)) + ); + assert_eq!( + reader.compute_csum(), + (sha256(&data[size_of::()..]), size,) + ); + + dir.close().unwrap(); + } +} diff --git a/pbs-datastore/src/fixed_index.rs b/pbs-datastore/src/fixed_index.rs index 2324fc3e0..8104cbe72 100644 --- a/pbs-datastore/src/fixed_index.rs +++ b/pbs-datastore/src/fixed_index.rs @@ -585,12 +585,98 @@ impl FixedIndexWriter { #[cfg(test)] mod tests { use std::fs; + + use openssl::sha::sha256; use tempfile::TempDir; use super::*; const CS: u32 = 4096; + #[track_caller] + fn check_error_contains(result: Result, substring: &str) { + let error = result.map(|_| ()).unwrap_err().to_string(); + assert!( + error.contains(substring), + "'{error}' does not contain '{substring}'" + ); + } + + #[test] + fn test_index_reader() { + let dir = TempDir::new().unwrap(); + + check_error_contains( + FixedIndexReader::open(Path::new("/dev/stdin")), + "Illegal seek", + ); + check_error_contains( + FixedIndexReader::open(Path::new("/dev/zero")), + "index too small (0)", + ); + + let path = dir.path().join("file"); + check_error_contains(FixedIndexReader::open(&path), "No such file or directory"); + + fs::write(&path, []).unwrap(); + check_error_contains(FixedIndexReader::open(&path), "index too small (0)"); + + let mut data = vec![0; size_of::()]; + + fs::write(&path, &data).unwrap(); + check_error_contains(FixedIndexReader::open(&path), "got unknown magic number"); + + data[..8].copy_from_slice(&file_formats::FIXED_SIZED_CHUNK_INDEX_1_0); + fs::write(&path, &data).unwrap(); + check_error_contains( + FixedIndexReader::open(&path), + "got non-power-of-two chunk size: 0", + ); + + let chunk_size = 4096 * 1024u64; + data[72..][..8].copy_from_slice(&chunk_size.to_le_bytes()); + fs::write(&path, &data).unwrap(); + check_error_contains(FixedIndexReader::open(&path), "invalid index size"); // 0 + + let size = chunk_size + 1; + data[64..][..8].copy_from_slice(&size.to_le_bytes()); + data.extend_from_slice(&[0, 1, 2]); + fs::write(&path, &data).unwrap(); + check_error_contains( + FixedIndexReader::open(&path), + "got unexpected file size (64 != 3)", + ); + + data.extend(3u8..32); + fs::write(&path, &data).unwrap(); + check_error_contains( + FixedIndexReader::open(&path), + "got unexpected file size (64 != 32)", + ); + + data.extend(32u8..64); + fs::write(&path, &data).unwrap(); + let reader = FixedIndexReader::open(&path).unwrap(); + assert_eq!(reader.index_bytes(), size); + assert_eq!(reader.index_size(), size as usize); + assert_eq!(reader.chunk_size, chunk_size as usize); + assert_eq!(reader.index_count(), 2); + assert_eq!( + reader.index_digest(0), + Some(&std::array::from_fn(|i| i as u8)) + ); + assert_eq!( + reader.index_digest(1), + Some(&std::array::from_fn(|i| i as u8 + 32)) + ); + assert_eq!( + reader.compute_csum(), + (sha256(&data[size_of::()..]), size) + ); + + dir.close().unwrap(); + } + #[test] fn test_empty() { let dir = TempDir::new().unwrap(); -- 2.47.3