serde/test_suite/tests/test_macros.rs

extern crate serde_test;
use self::serde_test::{
    Error,
    Token,
    assert_tokens,
    assert_ser_tokens,
    assert_de_tokens,
    assert_de_tokens_error,
};

use std::collections::BTreeMap;
use std::marker::PhantomData;

// That tests that the derived Serialize implementation doesn't trigger
// any warning about `serializer` not being used, in case of empty enums.
#[derive(Serialize)]
#[allow(dead_code)]
#[deny(unused_variables)]
enum Void {}

#[derive(Debug, PartialEq, Serialize, Deserialize)]
struct NamedUnit;

#[derive(Debug, PartialEq, Serialize)]
struct SerNamedTuple<'a, 'b, A: 'a, B: 'b, C>(&'a A, &'b mut B, C);

#[derive(Debug, PartialEq, Deserialize)]
struct DeNamedTuple<A, B, C>(A, B, C);

#[derive(Debug, PartialEq, Serialize)]
struct SerNamedMap<'a, 'b, A: 'a, B: 'b, C> {
    a: &'a A,
    b: &'b mut B,
    c: C,
}

#[derive(Debug, PartialEq, Deserialize)]
struct DeNamedMap<A, B, C> {
    a: A,
    b: B,
    c: C,
}

#[derive(Debug, PartialEq, Serialize)]
enum SerEnum<'a, B: 'a, C: 'a, D> where D: 'a {
    Unit,
    Seq(
        i8,
        B,
        &'a C,
        &'a mut D,
    ),
    Map {
        a: i8,
        b: B,
        c: &'a C,
        d: &'a mut D,
    },

    // Make sure we can support more than one variant.
    _Unit2,
    _Seq2(
        i8,
        B,
        &'a C,
        &'a mut D,
    ),
    _Map2 {
        a: i8,
        b: B,
        c: &'a C,
        d: &'a mut D,
    },
}

#[derive(Debug, PartialEq, Serialize, Deserialize)]
enum DeEnum<B, C, D> {
    Unit,
    Seq(
        i8,
        B,
        C,
        D,
    ),
    Map {
        a: i8,
        b: B,
        c: C,
        d: D,
    },

    // Make sure we can support more than one variant.
    _Unit2,
    _Seq2(
        i8,
        B,
        C,
        D,
    ),
    _Map2 {
        a: i8,
        b: B,
        c: C,
        d: D,
    },
}

#[derive(Serialize)]
enum Lifetimes<'a> {
    LifetimeSeq(&'a i32),
    NoLifetimeSeq(i32),
    LifetimeMap { a: &'a i32 },
    NoLifetimeMap { a: i32 },
}

#[derive(Debug, PartialEq, Serialize, Deserialize)]
pub struct GenericStruct<T> {
    x: T,
}

#[derive(Debug, PartialEq, Serialize, Deserialize)]
pub struct GenericNewTypeStruct<T>(T);

#[derive(Debug, PartialEq, Serialize, Deserialize)]
pub struct GenericTupleStruct<T, U>(T, U);

#[derive(Debug, PartialEq, Serialize, Deserialize)]
pub enum GenericEnum<T, U> {
    Unit,
    NewType(T),
    Seq(T, U),
    Map { x: T, y: U },
}

trait AssociatedType {
    type X;
}

impl AssociatedType for i32 {
    type X = i32;
}

#[derive(Debug, PartialEq, Serialize, Deserialize)]
struct DefaultTyParam<T: AssociatedType<X=i32> = i32> {
    phantom: PhantomData<T>
}

#[test]
fn test_named_unit() {
    assert_tokens(
        &NamedUnit,
        &[Token::UnitStruct("NamedUnit")]
    );
}

#[test]
fn test_ser_named_tuple() {
    let a = 5;
    let mut b = 6;
    let c = 7;
    assert_ser_tokens(
        &SerNamedTuple(&a, &mut b, c),
        &[
            Token::TupleStructStart("SerNamedTuple", 3),
            Token::TupleStructSep,
            Token::I32(5),

            Token::TupleStructSep,
            Token::I32(6),

            Token::TupleStructSep,
            Token::I32(7),

            Token::TupleStructEnd,
        ],
    );
}

#[test]
fn test_de_named_tuple() {
    assert_de_tokens(
        &DeNamedTuple(5, 6, 7),
        &[
            Token::SeqStart(Some(3)),
            Token::SeqSep,
            Token::I32(5),

            Token::SeqSep,
            Token::I32(6),

            Token::SeqSep,
            Token::I32(7),

            Token::SeqEnd,
        ]
    );

    assert_de_tokens(
        &DeNamedTuple(5, 6, 7),
        &[
            Token::TupleStructStart("DeNamedTuple", 3),
            Token::TupleStructSep,
            Token::I32(5),

            Token::TupleStructSep,
            Token::I32(6),

            Token::TupleStructSep,
            Token::I32(7),

            Token::TupleStructEnd,
        ]
    );
}

#[test]
fn test_ser_named_map() {
    let a = 5;
    let mut b = 6;
    let c = 7;

    assert_ser_tokens(
        &SerNamedMap {
            a: &a,
            b: &mut b,
            c: c,
        },
        &[
            Token::StructStart("SerNamedMap", 3),

            Token::StructSep,
            Token::Str("a"),
            Token::I32(5),

            Token::StructSep,
            Token::Str("b"),
            Token::I32(6),

            Token::StructSep,
            Token::Str("c"),
            Token::I32(7),

            Token::StructEnd,
        ]
    );
}

#[test]
fn test_de_named_map() {
    assert_de_tokens(
        &DeNamedMap {
            a: 5,
            b: 6,
            c: 7,
        },
        &[
            Token::StructStart("DeNamedMap", 3),

            Token::StructSep,
            Token::Str("a"),
            Token::I32(5),

            Token::StructSep,
            Token::Str("b"),
            Token::I32(6),

            Token::StructSep,
            Token::Str("c"),
            Token::I32(7),

            Token::StructEnd,
        ]
    );
}

#[test]
fn test_ser_enum_unit() {
    assert_ser_tokens(
        &SerEnum::Unit::<u32, u32, u32>,
        &[
            Token::EnumUnit("SerEnum", "Unit"),
        ]
    );
}

#[test]
fn test_ser_enum_seq() {
    let a = 1;
    let b = 2;
    let c = 3;
    let mut d = 4;

    assert_ser_tokens(
        &SerEnum::Seq(
            a,
            b,
            &c,
            &mut d,
        ),
        &[
            Token::EnumSeqStart("SerEnum", "Seq", 4),

            Token::EnumSeqSep,
            Token::I8(1),

            Token::EnumSeqSep,
            Token::I32(2),

            Token::EnumSeqSep,
            Token::I32(3),

            Token::EnumSeqSep,
            Token::I32(4),

            Token::EnumSeqEnd,
        ],
    );
}

#[test]
fn test_ser_enum_map() {
    let a = 1;
    let b = 2;
    let c = 3;
    let mut d = 4;

    assert_ser_tokens(
        &SerEnum::Map {
            a: a,
            b: b,
            c: &c,
            d: &mut d,
        },
        &[
            Token::EnumMapStart("SerEnum", "Map", 4),

            Token::EnumMapSep,
            Token::Str("a"),
            Token::I8(1),

            Token::EnumMapSep,
            Token::Str("b"),
            Token::I32(2),

            Token::EnumMapSep,
            Token::Str("c"),
            Token::I32(3),

            Token::EnumMapSep,
            Token::Str("d"),
            Token::I32(4),

            Token::EnumMapEnd,
        ],
    );
}

#[test]
fn test_de_enum_unit() {
    assert_tokens(
        &DeEnum::Unit::<u32, u32, u32>,
        &[
            Token::EnumUnit("DeEnum", "Unit"),
        ],
    );
}

#[test]
fn test_de_enum_seq() {
    let a = 1;
    let b = 2;
    let c = 3;
    let d = 4;

    assert_tokens(
        &DeEnum::Seq(
            a,
            b,
            c,
            d,
        ),
        &[
            Token::EnumSeqStart("DeEnum", "Seq", 4),

            Token::EnumSeqSep,
            Token::I8(1),

            Token::EnumSeqSep,
            Token::I32(2),

            Token::EnumSeqSep,
            Token::I32(3),

            Token::EnumSeqSep,
            Token::I32(4),

            Token::EnumSeqEnd,
        ],
    );
}

#[test]
fn test_de_enum_map() {
    let a = 1;
    let b = 2;
    let c = 3;
    let d = 4;

    assert_tokens(
        &DeEnum::Map {
            a: a,
            b: b,
            c: c,
            d: d,
        },
        &[
            Token::EnumMapStart("DeEnum", "Map", 4),

            Token::EnumMapSep,
            Token::Str("a"),
            Token::I8(1),

            Token::EnumMapSep,
            Token::Str("b"),
            Token::I32(2),

            Token::EnumMapSep,
            Token::Str("c"),
            Token::I32(3),

            Token::EnumMapSep,
            Token::Str("d"),
            Token::I32(4),

            Token::EnumMapEnd,
        ],
    );
}

#[test]
fn test_lifetimes() {
    let value = 5;

    assert_ser_tokens(
        &Lifetimes::LifetimeSeq(&value),
        &[
            Token::EnumNewType("Lifetimes", "LifetimeSeq"),
            Token::I32(5),
        ]
    );

    assert_ser_tokens(
        &Lifetimes::NoLifetimeSeq(5),
        &[
            Token::EnumNewType("Lifetimes", "NoLifetimeSeq"),
            Token::I32(5),
        ]
    );

    assert_ser_tokens(
        &Lifetimes::LifetimeMap { a: &value },
        &[
            Token::EnumMapStart("Lifetimes", "LifetimeMap", 1),

            Token::EnumMapSep,
            Token::Str("a"),
            Token::I32(5),

            Token::EnumMapEnd,
        ]
    );

    assert_ser_tokens(
        &Lifetimes::NoLifetimeMap { a: 5 },
        &[
            Token::EnumMapStart("Lifetimes", "NoLifetimeMap", 1),

            Token::EnumMapSep,
            Token::Str("a"),
            Token::I32(5),

            Token::EnumMapEnd,
        ]
    );
}

#[test]
fn test_generic_struct() {
    assert_tokens(
        &GenericStruct { x: 5u32 },
        &[
            Token::StructStart("GenericStruct", 1),

            Token::StructSep,
            Token::Str("x"),
            Token::U32(5),

            Token::StructEnd,
        ]
    );
}

#[test]
fn test_generic_newtype_struct() {
    assert_tokens(
        &GenericNewTypeStruct(5u32),
        &[
            Token::StructNewType("GenericNewTypeStruct"),
            Token::U32(5),
        ]
    );
}

#[test]
fn test_generic_tuple_struct() {
    assert_tokens(
        &GenericTupleStruct(5u32, 6u32),
        &[
            Token::TupleStructStart("GenericTupleStruct", 2),

            Token::TupleStructSep,
            Token::U32(5),

            Token::TupleStructSep,
            Token::U32(6),

            Token::TupleStructEnd,
        ]
    );
}

#[test]
fn test_generic_enum_unit() {
    assert_tokens(
        &GenericEnum::Unit::<u32, u32>,
        &[
            Token::EnumUnit("GenericEnum", "Unit"),
        ]
    );
}

#[test]
fn test_generic_enum_newtype() {
    assert_tokens(
        &GenericEnum::NewType::<u32, u32>(5),
        &[
            Token::EnumNewType("GenericEnum", "NewType"),
            Token::U32(5),
        ]
    );
}

#[test]
fn test_generic_enum_seq() {
    assert_tokens(
        &GenericEnum::Seq::<u32, u32>(5, 6),
        &[
            Token::EnumSeqStart("GenericEnum", "Seq", 2),

            Token::EnumSeqSep,
            Token::U32(5),

            Token::EnumSeqSep,
            Token::U32(6),

            Token::EnumSeqEnd,
        ]
    );
}

#[test]
fn test_generic_enum_map() {
    assert_tokens(
        &GenericEnum::Map::<u32, u32> { x: 5, y: 6 },
        &[
            Token::EnumMapStart("GenericEnum", "Map", 2),

            Token::EnumMapSep,
            Token::Str("x"),
            Token::U32(5),

            Token::EnumMapSep,
            Token::Str("y"),
            Token::U32(6),

            Token::EnumMapEnd,
        ]
    );
}

#[test]
fn test_default_ty_param() {
    assert_tokens(
        &DefaultTyParam::<i32> { phantom: PhantomData },
        &[
            Token::StructStart("DefaultTyParam", 1),

            Token::StructSep,
            Token::Str("phantom"),
            Token::UnitStruct("PhantomData"),

            Token::StructEnd,
        ]
    );
}

#[test]
fn test_enum_state_field() {
    #[derive(Debug, PartialEq, Serialize, Deserialize)]
    enum SomeEnum {
        Key { key: char, state: bool },
    }

    assert_tokens(
        &SomeEnum::Key { key: 'a', state: true },
        &[
            Token::EnumMapStart("SomeEnum", "Key", 2),

            Token::EnumMapSep,
            Token::Str("key"),
            Token::Char('a'),

            Token::EnumMapSep,
            Token::Str("state"),
            Token::Bool(true),

            Token::EnumMapEnd,
        ]
    );
}

#[test]
fn test_untagged_enum() {
    #[derive(Debug, PartialEq, Serialize, Deserialize)]
    #[serde(untagged)]
    enum Untagged {
        A {
            a: u8,
        },
        B {
            b: u8,
        },
        C,
        D(u8),
        E(String),
        F(u8, u8),
    }

    assert_tokens(
        &Untagged::A { a: 1 },
        &[
            Token::StructStart("Untagged", 1),

            Token::StructSep,
            Token::Str("a"),
            Token::U8(1),

            Token::StructEnd,
        ]
    );

    assert_tokens(
        &Untagged::B { b: 2 },
        &[
            Token::StructStart("Untagged", 1),

            Token::StructSep,
            Token::Str("b"),
            Token::U8(2),

            Token::StructEnd,
        ]
    );

    assert_tokens(
        &Untagged::C,
        &[
            Token::Unit,
        ]
    );

    assert_tokens(
        &Untagged::D(4),
        &[
            Token::U8(4),
        ]
    );
    assert_tokens(
        &Untagged::E("e".to_owned()),
        &[
            Token::Str("e"),
        ]
    );

    assert_tokens(
        &Untagged::F(1, 2),
        &[
            Token::TupleStart(2),

            Token::TupleSep,
            Token::U8(1),

            Token::TupleSep,
            Token::U8(2),

            Token::TupleEnd,
        ]
    );

    assert_de_tokens_error::<Untagged>(
        &[
            Token::Option(false),
        ],
        Error::Message("data did not match any variant of untagged enum Untagged".to_owned()),
    );

    assert_de_tokens_error::<Untagged>(
        &[
            Token::TupleStart(1),

            Token::TupleSep,
            Token::U8(1),

            Token::TupleEnd,
        ],
        Error::Message("data did not match any variant of untagged enum Untagged".to_owned()),
    );

    assert_de_tokens_error::<Untagged>(
        &[
            Token::TupleStart(3),

            Token::TupleSep,
            Token::U8(1),

            Token::TupleSep,
            Token::U8(2),

            Token::TupleSep,
            Token::U8(3),

            Token::TupleEnd,
        ],
        Error::Message("data did not match any variant of untagged enum Untagged".to_owned()),
    );
}

#[test]
fn test_internally_tagged_enum() {
    #[derive(Debug, PartialEq, Serialize, Deserialize)]
    struct Newtype(BTreeMap<String, String>);

    #[derive(Debug, PartialEq, Serialize, Deserialize)]
    struct Struct {
        f: u8,
    }

    #[derive(Debug, PartialEq, Serialize, Deserialize)]
    #[serde(tag = "type")]
    enum InternallyTagged {
        A {
            a: u8,
        },
        B {
            b: u8,
        },
        C,
        D(BTreeMap<String, String>),
        E(Newtype),
        F(Struct),
    }

    assert_tokens(
        &InternallyTagged::A { a: 1 },
        &[
            Token::StructStart("InternallyTagged", 2),

            Token::StructSep,
            Token::Str("type"),
            Token::Str("A"),

            Token::StructSep,
            Token::Str("a"),
            Token::U8(1),

            Token::StructEnd,
        ]
    );

    assert_tokens(
        &InternallyTagged::B { b: 2 },
        &[
            Token::StructStart("InternallyTagged", 2),

            Token::StructSep,
            Token::Str("type"),
            Token::Str("B"),

            Token::StructSep,
            Token::Str("b"),
            Token::U8(2),

            Token::StructEnd,
        ]
    );

    assert_tokens(
        &InternallyTagged::C,
        &[
            Token::StructStart("InternallyTagged", 1),

            Token::StructSep,
            Token::Str("type"),
            Token::Str("C"),

            Token::StructEnd,
        ]
    );

    assert_tokens(
        &InternallyTagged::D(BTreeMap::new()),
        &[
            Token::MapStart(Some(1)),

            Token::MapSep,
            Token::Str("type"),
            Token::Str("D"),

            Token::MapEnd,
        ]
    );

    assert_tokens(
        &InternallyTagged::E(Newtype(BTreeMap::new())),
        &[
            Token::MapStart(Some(1)),

            Token::MapSep,
            Token::Str("type"),
            Token::Str("E"),

            Token::MapEnd,
        ]
    );

    assert_tokens(
        &InternallyTagged::F(Struct { f: 6 }),
        &[
            Token::StructStart("Struct", 2),

            Token::StructSep,
            Token::Str("type"),
            Token::Str("F"),

            Token::StructSep,
            Token::Str("f"),
            Token::U8(6),

            Token::StructEnd,
        ]
    );

    assert_de_tokens_error::<InternallyTagged>(
        &[
            Token::MapStart(Some(0)),
            Token::MapEnd,
        ],
        Error::Message("missing field `type`".to_owned()),
    );

    assert_de_tokens_error::<InternallyTagged>(
        &[
            Token::MapStart(Some(1)),

            Token::MapSep,
            Token::Str("type"),
            Token::Str("Z"),

            Token::MapEnd,
        ],
        Error::Message("unknown variant `Z`, expected one of `A`, `B`, `C`, `D`, `E`, `F`".to_owned()),
    );
}

#[test]
fn test_adjacently_tagged_enum() {
    #[derive(Debug, PartialEq, Serialize)]
    #[serde(tag = "t", content = "c")]
    enum AdjacentlyTagged {
        Unit,
        Newtype(u8),
        Tuple(u8, u8),
        Struct { f: u8 },
    }

    assert_ser_tokens(
        &AdjacentlyTagged::Unit,
        &[
            Token::StructStart("AdjacentlyTagged", 1),

            Token::StructSep,
            Token::Str("t"),
            Token::Str("Unit"),

            Token::StructEnd,
        ]
    );

    assert_ser_tokens(
        &AdjacentlyTagged::Newtype(1),
        &[
            Token::StructStart("AdjacentlyTagged", 2),

            Token::StructSep,
            Token::Str("t"),
            Token::Str("Newtype"),

            Token::StructSep,
            Token::Str("c"),
            Token::U8(1),

            Token::StructEnd,
        ]
    );

    assert_ser_tokens(
        &AdjacentlyTagged::Tuple(1, 1),
        &[
            Token::StructStart("AdjacentlyTagged", 2),

            Token::StructSep,
            Token::Str("t"),
            Token::Str("Tuple"),

            Token::StructSep,
            Token::Str("c"),
            Token::TupleStart(2),
            Token::TupleSep,
            Token::U8(1),
            Token::TupleSep,
            Token::U8(1),
            Token::TupleEnd,

            Token::StructEnd,
        ]
    );

    assert_ser_tokens(
        &AdjacentlyTagged::Struct { f: 1 },
        &[
            Token::StructStart("AdjacentlyTagged", 2),

            Token::StructSep,
            Token::Str("t"),
            Token::Str("Struct"),

            Token::StructSep,
            Token::Str("c"),
            Token::StructStart("Struct", 1),
            Token::StructSep,
            Token::Str("f"),
            Token::U8(1),
            Token::StructEnd,

            Token::StructEnd,
        ]
    );
}