Fuzz serde enum representations

[juntyr]

Fixes #500, since all (known) roundtrip issues are now documented and tested. Once serde allows us to fix them, they can be removed from the newly expanded restrictions section.

• [x] externally tagged enums

• [x] internally tagged enums

• [x] internally tagged structs

• [x] adjacently tagged enums

• [x] untagged enums

• [x] other variant in internally tagged enums

• [x] other variant in adjacently tagged enums

• [x] serialize flattened struct

• [x] serialize flattened struct variant

• [x] deserialize flattened struct

• [x] deserialize flattened struct variant

  • [x] externally tagged
  • [x] untagged
  • [x] adjacently tagged
  • [x] internally tagged

• [x] document one-tuple/one-array limitation inside unwrapped newtype variants

• [x] document that serde only supports unit, bool, integer, float, char, string, and byte keys inside flattened structs, and only string and byte keys and u8 and u64 when the flattened struct is inside an untagged or internally tagged enum document that we only support string keys inside flattened maps (even though serde technically permits more, this support is not roundtrip-safe as soon as flattened maps are involved)

• [x] document that serde does not support flattened structs containing conflicting keys, e.g. an inner key matches a later outer key or two flattened maps in the same struct share a key

• [x] document that #[enable(implicit_some)] is not supported with Options inside #[serde(flatten)]

• [x] document that PrettyConfig::struct_names(true) is not supported inside flattened structs / struct variants

• [x] Add tests for any bug fixes

• [x] Add tests for all known bugs

  • [x] structs or struct variants that contain a #[serde(flatten)]ed field:
  • [x] are only serialised as maps and deserialised from maps
  • [x] must not contain duplicate fields / keys, e.g. where an inner-struct field matches an outer-struct or inner-struct field
  • [x] must not contain more than one (within the super-struct of all flattened structs) #[serde(flatten)]ed map field, which collects all unknown fields
  • [x] if they contain a #[serde(flatten)]ed map, they must not contain:
    • [x] a struct that is not flattened itself but contains some flattened fields and is flattened into the outer struct (variant)
    • [x] an untagged struct variant that contains some flattened fields
    • [x] a flattened externally tagged newtype, tuple, or struct variant, flattened internally tagged unit, newtype, or struct variant, or any flattened adjacently tagged variant
    • [x] a flattened tagged struct
  • [x] ron only supports string keys inside maps flattened into structs
  • [x] internally (or adjacently) tagged or untagged enum variants or #[serde(flatten)]ed fields must not contain:
  • [x] i128 or u128 values
  • [x] struct names, e.g. by enabling the PrettyConfig::struct_names setting
  • [x] newtypes
  • [x] zero-length arrays / tuples / tuple structs / structs / tuple variants / struct variants
    • [x] Options with #[enable(implicit_some)] must not contain any of these or a unit, unit struct, or an untagged unit variant
  • [x] externally tagged tuple variants with just one field (that are not newtype variants)
  • [x] tuples or arrays with just one element are not supported inside newtype variants with #[enable(unwrap_variant_newtypes)]
  • [x] a ron::value::RawValue
  • [x] untagged tuple / struct variants with no fields are not supported
  • [x] untagged tuple variants with just one field (that are not newtype variants) are not supported when the #![enable(unwrap_variant_newtypes)] extension is enabled
  • [x] internally tagged newtype variants and #[serde(flatten)]ed fields must not contain:
  • [x] a unit or a unit struct inside an untagged newtype variant
  • [x] an untagged unit variant
  • [x] serializing a ron::value::RawValue using a PrettyConfig may add leading and trailing whitespace and comments, which the ron::value::RawValue absorbs upon deserialization

• [x] I've included my change in CHANGELOG.md

• [x] Check all // BUG: comments in the fuzzer again to ensure that nothing was missed / is unnecessary or out of place

[codecov-commenter]

Codecov Report

All modified lines are covered by tests :white_check_mark:

Comparison is base (2f3e5a8) 100.00% compared to head (2493a59) 100.00%.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #502 +/- ## =========================================== Coverage 100.00% 100.00% =========================================== Files 80 82 +2 Lines 11178 14244 +3066 =========================================== + Hits 11178 14244 +3066 ``` | [Files](https://app.codecov.io/gh/ron-rs/ron/pull/502?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None) | Coverage Δ | | |---|---|---| | [src/de/id.rs](https://app.codecov.io/gh/ron-rs/ron/pull/502?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-c3JjL2RlL2lkLnJz) | `100.00% <100.00%> (ø)` | | | [src/de/mod.rs](https://app.codecov.io/gh/ron-rs/ron/pull/502?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-c3JjL2RlL21vZC5ycw==) | `100.00% <100.00%> (ø)` | | | [src/de/tag.rs](https://app.codecov.io/gh/ron-rs/ron/pull/502?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-c3JjL2RlL3RhZy5ycw==) | `100.00% <100.00%> (ø)` | | | [src/parse.rs](https://app.codecov.io/gh/ron-rs/ron/pull/502?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-c3JjL3BhcnNlLnJz) | `100.00% <100.00%> (ø)` | | | [src/value/raw.rs](https://app.codecov.io/gh/ron-rs/ron/pull/502?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-c3JjL3ZhbHVlL3Jhdy5ycw==) | `100.00% <100.00%> (ø)` | | | [tests/115\_minimal\_flattening.rs](https://app.codecov.io/gh/ron-rs/ron/pull/502?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-dGVzdHMvMTE1X21pbmltYWxfZmxhdHRlbmluZy5ycw==) | `100.00% <100.00%> (ø)` | | | [tests/401\_raw\_identifier.rs](https://app.codecov.io/gh/ron-rs/ron/pull/502?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-dGVzdHMvNDAxX3Jhd19pZGVudGlmaWVyLnJz) | `100.00% <100.00%> (ø)` | | | [tests/407\_raw\_value.rs](https://app.codecov.io/gh/ron-rs/ron/pull/502?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-dGVzdHMvNDA3X3Jhd192YWx1ZS5ycw==) | `100.00% <100.00%> (ø)` | | | [tests/449\_tagged\_enum.rs](https://app.codecov.io/gh/ron-rs/ron/pull/502?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-dGVzdHMvNDQ5X3RhZ2dlZF9lbnVtLnJz) | `100.00% <100.00%> (ø)` | | | [tests/502\_known\_bugs.rs](https://app.codecov.io/gh/ron-rs/ron/pull/502?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-dGVzdHMvNTAyX2tub3duX2J1Z3MucnM=) | `100.00% <100.00%> (ø)` | | | ... and [1 more](https://app.codecov.io/gh/ron-rs/ron/pull/502?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None) | |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[juntyr]

@torkleyy Holy dang, serde attributes are a mess. This nightmare has really only unearthed two or three bugs in ron (around tagged enum tag identifier deserialising), many cases where we cannot roundtrip because serde's Content loses information (see https://github.com/serde-rs/serde/issues/1183), but MANY nightmares around serde attributes just plain not roundtripping themselves. I will try to add some tests and update our restrictions README in the PR, but I won't spend any time prettifying our fuzzer at this point. It will hopefully get nicer over time as the above restrictions are lifted.

Hopefully I can get this PR merged early next week and then finally, with the confidence that we now know about the limitations of serde attributes in ron, release v0.9.

... and I need to fix those tests ... later. And as always, the fuzzer finds another bug just as I think I'm done with this ;(

[juntyr]

@torkleyy I think this is finally ready (I want to merge and rebase on #512 first). Gosh this PR is huge ... and soooo cursed. And probably once the fuzzer changes lands I get many new edge case reports soon. But it is a small step phew*

Oh and the benchmark failure should be fixed by this PR too