1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
// Copyright 2017 Serde Developers // // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your // option. This file may not be copied, modified, or distributed // except according to those terms. //! This crate provides a convenient concise way to write unit tests for //! implementations of [`Serialize`] and [`Deserialize`]. //! //! [`Serialize`]: https://docs.serde.rs/serde/ser/trait.Serialize.html //! [`Deserialize`]: https://docs.serde.rs/serde/de/trait.Deserialize.html //! //! The `Serialize` impl for a value can be characterized by the sequence of //! [`Serializer`] calls that are made in the course of serializing the value, //! so `serde_test` provides a [`Token`] abstraction which corresponds roughly //! to `Serializer` method calls. There is an [`assert_ser_tokens`] function to //! test that a value serializes to a particular sequence of method calls, an //! [`assert_de_tokens`] function to test that a value can be deserialized from //! a particular sequence of method calls, and an [`assert_tokens`] function to //! test both directions. There are also functions to test expected failure //! conditions. //! //! [`Serializer`]: https://docs.serde.rs/serde/ser/trait.Serializer.html //! [`Token`]: https://docs.serde.rs/serde_test/enum.Token.html //! [`assert_ser_tokens`]: https://docs.serde.rs/serde_test/fn.assert_ser_tokens.html //! [`assert_de_tokens`]: https://docs.serde.rs/serde_test/fn.assert_de_tokens.html //! [`assert_tokens`]: https://docs.serde.rs/serde_test/fn.assert_tokens.html //! //! Here is an example from the [`linked-hash-map`] crate. //! //! [`linked-hash-map`]: https://github.com/contain-rs/linked-hash-map //! //! ```rust //! # extern crate serde; //! # //! # macro_rules! ignore { //! # ($($tt:tt)+) => {} //! # } //! # //! # ignore! { //! extern crate linked_hash_map; //! use linked_hash_map::LinkedHashMap; //! # } //! //! extern crate serde_test; //! use serde_test::{Token, assert_tokens}; //! //! # use std::fmt; //! # use std::marker::PhantomData; //! # //! # use serde::ser::{Serialize, Serializer, SerializeMap}; //! # use serde::de::{Deserialize, Deserializer, Visitor, MapAccess}; //! # //! # // Dumb immitation of LinkedHashMap. //! # #[derive(PartialEq, Debug)] //! # struct LinkedHashMap<K, V>(Vec<(K, V)>); //! # //! # impl<K, V> LinkedHashMap<K, V> { //! # fn new() -> Self { //! # LinkedHashMap(Vec::new()) //! # } //! # //! # fn insert(&mut self, k: K, v: V) { //! # self.0.push((k, v)); //! # } //! # } //! # //! # impl<K, V> Serialize for LinkedHashMap<K, V> //! # where K: Serialize, //! # V: Serialize //! # { //! # fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> //! # where S: Serializer //! # { //! # let mut map = serializer.serialize_map(Some(self.0.len()))?; //! # for &(ref k, ref v) in &self.0 { //! # map.serialize_entry(k, v)?; //! # } //! # map.end() //! # } //! # } //! # //! # struct LinkedHashMapVisitor<K, V>(PhantomData<(K, V)>); //! # //! # impl<'de, K, V> Visitor<'de> for LinkedHashMapVisitor<K, V> //! # where K: Deserialize<'de>, //! # V: Deserialize<'de> //! # { //! # type Value = LinkedHashMap<K, V>; //! # //! # fn expecting(&self, _: &mut fmt::Formatter) -> fmt::Result { //! # unimplemented!() //! # } //! # //! # fn visit_map<M>(self, mut access: M) -> Result<Self::Value, M::Error> //! # where M: MapAccess<'de> //! # { //! # let mut map = LinkedHashMap::new(); //! # while let Some((key, value)) = access.next_entry()? { //! # map.insert(key, value); //! # } //! # Ok(map) //! # } //! # } //! # //! # impl<'de, K, V> Deserialize<'de> for LinkedHashMap<K, V> //! # where K: Deserialize<'de>, //! # V: Deserialize<'de> //! # { //! # fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> //! # where D: Deserializer<'de> //! # { //! # deserializer.deserialize_map(LinkedHashMapVisitor(PhantomData)) //! # } //! # } //! # //! #[test] //! # fn not_a_test_ser_de_empty() {} //! fn test_ser_de_empty() { //! let map = LinkedHashMap::<char, u32>::new(); //! //! assert_tokens(&map, &[ //! Token::Map { len: Some(0) }, //! Token::MapEnd, //! ]); //! } //! //! #[test] //! # fn not_a_test_ser_de() {} //! fn test_ser_de() { //! let mut map = LinkedHashMap::new(); //! map.insert('b', 20); //! map.insert('a', 10); //! map.insert('c', 30); //! //! assert_tokens(&map, &[ //! Token::Map { len: Some(3) }, //! Token::Char('b'), //! Token::I32(20), //! //! Token::Char('a'), //! Token::I32(10), //! //! Token::Char('c'), //! Token::I32(30), //! Token::MapEnd, //! ]); //! } //! # //! # fn main() { //! # test_ser_de_empty(); //! # test_ser_de(); //! # } //! ``` #![doc(html_root_url = "https://docs.rs/serde_test/1.0.27")] #![cfg_attr(feature = "cargo-clippy", deny(clippy, clippy_pedantic))] // Whitelisted clippy lints #![cfg_attr(feature = "cargo-clippy", allow(float_cmp))] // Whitelisted clippy_pedantic lints #![cfg_attr(feature = "cargo-clippy", allow(missing_docs_in_private_items, stutter, use_debug, use_self))] #[macro_use] extern crate serde; mod ser; mod de; mod error; mod configure; mod token; mod assert; pub use token::Token; pub use assert::{assert_de_tokens, assert_de_tokens_error, assert_ser_tokens, assert_ser_tokens_error, assert_tokens}; pub use configure::{Compact, Configure, Readable}; // Not public API. #[doc(hidden)] pub use de::Deserializer;