serde_assert

Testing library for serde Serialize and Deserialize implementations.

This library provides a Serializer and Deserializer to be used in writing unit tests to assert the behavior of manual Serialize and Deserialize implementations, respectively. The implementation behavior can be verified by using Tokens representing an arbitrary serialized state.

Usage

The examples below use the claims crate for convenient assertions.

Testing Serialization

The Serializer returns Tokens representing the serialization of a value. The returned Tokens can be checked to be equal to an expected value.

use claims::assert_ok_eq;
use serde::Serialize;
use serde_assert::{
    Serializer,
    Token,
    Tokens,
};

let serializer = Serializer::builder().build();

assert_ok_eq!(true.serialize(&serializer), Tokens(vec![Token::Bool(true)]));

Testing Deserialization

A Deserializer is constructed by providing Tokens to be deserialized into a value.

use claims::assert_ok_eq;
use serde::Deserialize;
use serde_assert::{
    Deserializer,
    Token,
    Tokens,
};

let mut deserializer = Deserializer::builder()
    .tokens(Tokens(vec![Token::Bool(true)]))
    .build();

assert_ok_eq!(bool::deserialize(&mut deserializer), true);

Comparison with `serde_test`

This crate provides more flexibility than serde_test at the expense of more verbosity. While serde_test provides a small API of simple assertion macros, this crate will require you to call serialize() and deserialize() and assert yourself that the results are as expected.

While some users may find that the smaller API of serde_test is sufficient for their use-case, others will find that the flexibility of this crate makes testing more complicated Serailize and Deserialize implementations easier. Among other things, this crate's API provides these advantages:

Direct access to the Serializer and Deserializer, allowing use of all parts of the serde Serializer and Deserializer APIs, such as deserializing types that implement DeserializeSeed.
Customization of Serializers and Deserializers, allowing configuration of things like human-readability, whether the Deserializer should interpret Tokens as self-describing, and zero-copy deserialization.
Sophisticated comparison of serialized Tokens, including allowing testing of types whose serialized form can include items in arbitrary order, such as when serializing a HashSet.

Minimum Supported Rust Version

This crate is guaranteed to compile on stable rustc 1.61.0 and up.

License

This project is licensed under either of

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

serde_assert 0.5.0