public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Dominik Csapak <d.csapak@proxmox.com>
To: Lukas Wagner <l.wagner@proxmox.com>,
	Proxmox Backup Server development discussion
	<pbs-devel@lists.proxmox.com>
Subject: Re: [pbs-devel] [PATCH proxmox-backup v2 2/4] datastore: test DataBlob encode/decode roundtrip
Date: Wed, 31 Jul 2024 11:50:09 +0200	[thread overview]
Message-ID: <dfb56343-9e15-4825-8786-2ee6a8e4a82a@proxmox.com> (raw)
In-Reply-To: <a5f144a7-ce9a-4f18-8b9f-8613192c3691@proxmox.com>

On 7/31/24 11:47, Lukas Wagner wrote:
> On  2024-07-31 11:36, Dominik Csapak wrote:
>> so that we can be sure we can decode an encoded blob again
>>
>> Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
>> ---
>> new in v2
>>   pbs-datastore/src/data_blob.rs | 66 ++++++++++++++++++++++++++++++++++
>>   1 file changed, 66 insertions(+)
>>
>> diff --git a/pbs-datastore/src/data_blob.rs b/pbs-datastore/src/data_blob.rs
>> index a7a55fb7..8715afef 100644
>> --- a/pbs-datastore/src/data_blob.rs
>> +++ b/pbs-datastore/src/data_blob.rs
>> @@ -562,3 +562,69 @@ impl<'a, 'b> DataChunkBuilder<'a, 'b> {
>>           chunk_builder.build()
>>       }
>>   }
>> +
>> +#[cfg(test)]
>> +mod test {
>> +    use pbs_tools::crypt_config::CryptConfig;
>> +
>> +    use super::DataChunkBuilder;
>> +
>> +    const TEST_DATA_LEN: usize = 50;
>> +
>> +    #[test]
>> +    fn test_data_blob_builder() {
>> +        let mut data = Vec::with_capacity(TEST_DATA_LEN);
>> +        for i in 0..TEST_DATA_LEN / 10 {
>> +            for _ in 0..10 {
>> +                data.push(i as u8);
>> +            }
>> +        }
>> +
>> +        // unencrypted, uncompressed
>> +        let (chunk, digest) = DataChunkBuilder::new(&data)
>> +            .compress(false)
>> +            .build()
>> +            .expect("could not create unencrypted, uncompressed chunk");
>> +
>> +        let data_decoded = chunk
>> +            .decode(None, Some(&digest))
>> +            .expect("cannot decode unencrypted, uncompressed chunk");
>> +        assert_eq!(data, data_decoded);
>> +
>> +        // unencrypted, compressed
>> +        let (chunk, digest) = DataChunkBuilder::new(&data)
>> +            .compress(true)
>> +            .build()
>> +            .expect("could not create unencrypted, compressed chunk");
>> +
>> +        let data_decoded = chunk
>> +            .decode(None, Some(&digest))
>> +            .expect("cannot decode unencrypted, compressed chunk");
>> +        assert_eq!(data, data_decoded);
>> +
>> +        // encrypted, uncompressed
>> +        let crypt_config = CryptConfig::new([9; 32]).expect("could not create crypt config");
>> +        let (chunk, digest) = DataChunkBuilder::new(&data)
>> +            .compress(false)
>> +            .crypt_config(&crypt_config)
>> +            .build()
>> +            .expect("could not create encrypted, uncompressed chunk");
>> +
>> +        let data_decoded = chunk
>> +            .decode(Some(&crypt_config), Some(&digest))
>> +            .expect("cannot decode encrypted, uncompressed chunk");
>> +        assert_eq!(data, data_decoded);
>> +
>> +        // encrypted, compressed
>> +        let (chunk, digest) = DataChunkBuilder::new(&data)
>> +            .compress(true)
>> +            .crypt_config(&crypt_config)
>> +            .build()
>> +            .expect("could not create encrypted, compressed chunk");
>> +
>> +        let data_decoded = chunk
>> +            .decode(Some(&crypt_config), Some(&digest))
>> +            .expect("cannot decode encrypted, compressed chunk");
>> +        assert_eq!(data, data_decoded);
>> +    }
>> +}
> 
> IMO it would be nicer to move the (sub) testcases
> (e.g. 'encrypted, compressed', 'encrypted, uncompressed') to individual test cases,
> transforming the info from the comments into the test name, for instance:
> 
>    #[test]
>    fn test_encrypted_uncompressed() { ... }
> 
> (the fact that you test the data_blob module is clear from the full test name, which includes
> the module prefix - so I think you can drop it from the test name)
> 
> IMO that is quite nice when at some point we end up with a failing assertion, because
> you see exactly from the name of the failing test what scenario did not work.
> 
> What's your take on this?
> 

sure makes sense

i'll send a v3, but i'll wait for a review on the other patches first


_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel


  reply	other threads:[~2024-07-31  9:50 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-31  9:36 [pbs-devel] [PATCH proxmox-backup v2 0/4] improve compression throughput Dominik Csapak
2024-07-31  9:36 ` [pbs-devel] [PATCH proxmox-backup v2 1/4] remove data blob writer Dominik Csapak
2024-07-31  9:36 ` [pbs-devel] [PATCH proxmox-backup v2 2/4] datastore: test DataBlob encode/decode roundtrip Dominik Csapak
2024-07-31  9:47   ` Lukas Wagner
2024-07-31  9:50     ` Dominik Csapak [this message]
2024-07-31  9:36 ` [pbs-devel] [PATCH proxmox-backup v2 3/4] datastore: data blob: increase compression throughput Dominik Csapak
2024-07-31 14:39   ` Thomas Lamprecht
2024-08-01  6:55     ` Dominik Csapak
2024-08-02 10:47     ` Dominik Csapak
2024-08-02 11:59       ` Thomas Lamprecht
2024-08-02 12:38         ` Dominik Csapak
2024-08-07 15:01           ` Thomas Lamprecht
2024-07-31  9:36 ` [pbs-devel] [PATCH proxmox-backup v2 4/4] datastore: DataBlob encode: simplify code Dominik Csapak
2024-08-05  9:33 ` [pbs-devel] [PATCH proxmox-backup v2 0/4] improve compression throughput Dominik Csapak

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=dfb56343-9e15-4825-8786-2ee6a8e4a82a@proxmox.com \
    --to=d.csapak@proxmox.com \
    --cc=l.wagner@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
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal