#![allow(
clippy::approx_constant,
clippy::useless_vec,
clippy::len_zero,
clippy::unnecessary_cast,
clippy::redundant_closure,
clippy::too_many_arguments,
clippy::type_complexity,
clippy::needless_borrow,
clippy::enum_variant_names,
clippy::upper_case_acronyms,
clippy::inconsistent_digit_grouping,
clippy::unit_cmp,
clippy::assertions_on_constants,
clippy::iter_on_single_items,
clippy::expect_fun_call,
clippy::redundant_pattern_matching,
variant_size_differences,
clippy::absurd_extreme_comparisons,
clippy::nonminimal_bool,
clippy::for_kv_map,
clippy::needless_range_loop,
clippy::single_match,
clippy::collapsible_if,
clippy::needless_return,
clippy::redundant_clone,
clippy::map_entry,
clippy::match_single_binding,
clippy::bool_comparison,
clippy::derivable_impls,
clippy::manual_range_contains,
clippy::needless_borrows_for_generic_args,
clippy::manual_map,
clippy::vec_init_then_push,
clippy::identity_op,
clippy::manual_flatten,
clippy::single_char_pattern,
clippy::search_is_some,
clippy::option_map_unit_fn,
clippy::while_let_on_iterator,
clippy::clone_on_copy,
clippy::box_collection,
clippy::redundant_field_names,
clippy::ptr_arg,
clippy::large_enum_variant,
clippy::match_ref_pats,
clippy::needless_pass_by_value,
clippy::unused_unit,
clippy::let_and_return,
clippy::suspicious_else_formatting,
clippy::manual_strip,
clippy::match_like_matches_macro,
clippy::from_over_into,
clippy::wrong_self_convention,
clippy::inherent_to_string,
clippy::new_without_default,
clippy::unnecessary_wraps,
clippy::field_reassign_with_default,
clippy::manual_find,
clippy::unnecessary_lazy_evaluations,
clippy::should_implement_trait,
clippy::missing_safety_doc,
clippy::unusual_byte_groupings,
clippy::bool_assert_comparison,
clippy::zero_prefixed_literal,
clippy::await_holding_lock,
clippy::manual_saturating_arithmetic,
clippy::explicit_counter_loop,
clippy::needless_lifetimes,
clippy::single_component_path_imports,
clippy::uninlined_format_args,
clippy::iter_cloned_collect,
clippy::manual_str_repeat,
clippy::excessive_precision,
clippy::precedence,
clippy::unnecessary_literal_unwrap
)]
use oxicode::{
decode_from_slice, encode_to_vec,
versioning::{
decode_versioned, decode_versioned_with_check, encode_versioned, extract_version,
is_versioned, CompatibilityLevel, Version, VersionedHeader,
},
Decode, Encode,
};
#[test]
fn test_version_1_0_0_roundtrip() {
let version = Version::new(1, 0, 0);
let payload = b"hello";
let encoded = encode_versioned(payload, version).expect("encode_versioned failed");
let (decoded_payload, decoded_ver) =
decode_versioned(&encoded).expect("decode_versioned failed");
assert_eq!(decoded_payload.as_slice(), payload.as_slice());
assert_eq!(decoded_ver, version);
}
#[test]
fn test_version_2_3_4_roundtrip() {
let version = Version::new(2, 3, 4);
let payload = b"data";
let encoded = encode_versioned(payload, version).expect("encode_versioned failed");
let (decoded_payload, decoded_ver) =
decode_versioned(&encoded).expect("decode_versioned failed");
assert_eq!(decoded_payload.as_slice(), payload.as_slice());
assert_eq!(decoded_ver, version);
}
#[test]
fn test_version_0_0_1_patch_only_roundtrip() {
let version = Version::new(0, 0, 1);
let payload = b"patch";
let encoded = encode_versioned(payload, version).expect("encode_versioned failed");
let (decoded_payload, decoded_ver) =
decode_versioned(&encoded).expect("decode_versioned failed");
assert_eq!(decoded_payload.as_slice(), payload.as_slice());
assert_eq!(decoded_ver, version);
}
#[test]
fn test_encode_versioned_value_u32_version_in_header() {
let version = Version::new(1, 0, 0);
let value: u32 = 42;
let payload_bytes = encode_to_vec(&value).expect("encode_to_vec failed");
let encoded = encode_versioned(&payload_bytes, version).expect("encode_versioned failed");
assert!(is_versioned(&encoded));
let extracted = extract_version(&encoded).expect("extract_version failed");
assert_eq!(extracted, version);
}
#[test]
fn test_encode_versioned_value_string_roundtrip() {
let version = Version::new(1, 2, 0);
let original = String::from("OxiCode versioning test");
let payload_bytes = encode_to_vec(&original).expect("encode_to_vec failed");
let encoded = encode_versioned(&payload_bytes, version).expect("encode_versioned failed");
let (raw_payload, ver) = decode_versioned(&encoded).expect("decode_versioned failed");
let (decoded_string, _consumed): (String, usize) =
decode_from_slice(&raw_payload).expect("decode_from_slice failed");
assert_eq!(decoded_string, original);
assert_eq!(ver, version);
}
#[test]
fn test_encode_versioned_value_vec_u8_roundtrip() {
let version = Version::new(3, 0, 0);
let original: Vec<u8> = vec![0x01, 0x02, 0x03, 0xFF, 0xFE];
let payload_bytes = encode_to_vec(&original).expect("encode_to_vec failed");
let encoded = encode_versioned(&payload_bytes, version).expect("encode_versioned failed");
let (raw_payload, ver) = decode_versioned(&encoded).expect("decode_versioned failed");
let (decoded_vec, _consumed): (Vec<u8>, usize) =
decode_from_slice(&raw_payload).expect("decode_from_slice failed");
assert_eq!(decoded_vec, original);
assert_eq!(ver, version);
}
#[test]
fn test_decode_versioned_with_check_same_version_succeeds() {
let version = Version::new(1, 0, 0);
let payload = b"same version";
let encoded = encode_versioned(payload, version).expect("encode_versioned failed");
let (decoded_payload, decoded_ver, compat) =
decode_versioned_with_check(&encoded, version, None)
.expect("decode_versioned_with_check failed");
assert_eq!(decoded_payload.as_slice(), payload.as_slice());
assert_eq!(decoded_ver, version);
assert!(compat.is_usable());
}
#[test]
fn test_decode_versioned_with_check_patch_bump_succeeds() {
let data_version = Version::new(1, 0, 0);
let current_version = Version::new(1, 0, 5);
let payload = b"patch bump";
let encoded = encode_versioned(payload, data_version).expect("encode_versioned failed");
let (decoded_payload, decoded_ver, compat) =
decode_versioned_with_check(&encoded, current_version, None)
.expect("patch bump should be compatible");
assert_eq!(decoded_payload.as_slice(), payload.as_slice());
assert_eq!(decoded_ver, data_version);
assert!(compat.is_usable());
assert_eq!(compat, CompatibilityLevel::Compatible);
}
#[test]
fn test_decode_versioned_with_check_minor_bump_post_1_0_compat_with_warnings() {
let data_version = Version::new(1, 0, 0);
let current_version = Version::new(1, 1, 0);
let payload = b"minor bump";
let encoded = encode_versioned(payload, data_version).expect("encode_versioned failed");
let result = decode_versioned_with_check(&encoded, current_version, None);
let (decoded_payload, _decoded_ver, compat) =
result.expect("minor bump within same major should be usable");
assert_eq!(decoded_payload.as_slice(), payload.as_slice());
assert_eq!(compat, CompatibilityLevel::CompatibleWithWarnings);
assert!(compat.is_usable());
assert!(!compat.is_fully_compatible());
}
#[derive(Encode, Decode, Debug, PartialEq)]
struct VersionedPoint {
x: i32,
y: i32,
}
#[test]
fn test_encode_versioned_value_struct_roundtrip() {
let version = Version::new(1, 0, 0);
let original = VersionedPoint { x: 10, y: -20 };
let payload_bytes = encode_to_vec(&original).expect("encode_to_vec failed");
let encoded = encode_versioned(&payload_bytes, version).expect("encode_versioned failed");
let (raw_payload, ver) = decode_versioned(&encoded).expect("decode_versioned failed");
let (decoded_point, _consumed): (VersionedPoint, usize) =
decode_from_slice(&raw_payload).expect("decode_from_slice failed");
assert_eq!(decoded_point, original);
assert_eq!(ver, version);
}
#[test]
fn test_version_comparison_major_bump_is_breaking() {
let v1 = Version::new(1, 0, 0);
let v2 = Version::new(2, 0, 0);
assert!(v2.is_breaking_change_from(&v1));
assert!(!v1.is_compatible_with(&v2));
assert!(!v2.is_compatible_with(&v1));
assert!(v2 > v1);
}
#[test]
fn test_version_comparison_minor_bump_pre_1_0_is_breaking() {
let v1 = Version::new(0, 1, 0);
let v2 = Version::new(0, 2, 0);
assert!(v2.is_breaking_change_from(&v1));
assert!(!v1.is_compatible_with(&v2));
assert!(v2.is_minor_update_from(&v1));
}
#[test]
fn test_is_versioned_on_encoded_versioned_output() {
let version = Version::new(1, 0, 0);
let payload = b"check magic";
let encoded = encode_versioned(payload, version).expect("encode_versioned failed");
assert!(is_versioned(&encoded));
}
#[test]
fn test_is_versioned_on_plain_encode_is_false() {
let plain_bytes = encode_to_vec(&9999u64).expect("encode_to_vec failed");
assert!(!is_versioned(&plain_bytes));
}
#[test]
fn test_extract_version_from_versioned_data() {
let version = Version::new(7, 13, 42);
let payload = b"extract me";
let encoded = encode_versioned(payload, version).expect("encode_versioned failed");
let extracted = extract_version(&encoded).expect("extract_version failed");
assert_eq!(extracted, version);
assert_eq!(extracted.major, 7);
assert_eq!(extracted.minor, 13);
assert_eq!(extracted.patch, 42);
}
#[test]
fn test_versioned_header_default_version_is_zero() {
let header = VersionedHeader::default();
assert_eq!(header.version(), Version::zero());
assert_eq!(header.version().major, 0);
assert_eq!(header.version().minor, 0);
assert_eq!(header.version().patch, 0);
}
#[test]
fn test_version_from_bytes_roundtrip() {
let original = Version::new(5, 10, 255);
let bytes = original.to_bytes();
let restored = Version::from_bytes(&bytes).expect("from_bytes returned None");
assert_eq!(restored, original);
assert_eq!(restored.major, 5);
assert_eq!(restored.minor, 10);
assert_eq!(restored.patch, 255);
}
#[test]
fn test_version_zero_comparison() {
let zero = Version::zero();
let one_patch = Version::new(0, 0, 1);
let one_minor = Version::new(0, 1, 0);
let one_major = Version::new(1, 0, 0);
assert!(zero < one_patch);
assert!(one_patch < one_minor);
assert!(one_minor < one_major);
assert_eq!(zero, Version::new(0, 0, 0));
}
#[test]
fn test_encode_versioned_value_bool_true_roundtrip() {
let version = Version::new(1, 0, 0);
let original: bool = true;
let payload_bytes = encode_to_vec(&original).expect("encode_to_vec failed");
let encoded = encode_versioned(&payload_bytes, version).expect("encode_versioned failed");
let (raw_payload, ver) = decode_versioned(&encoded).expect("decode_versioned failed");
let (decoded_bool, _consumed): (bool, usize) =
decode_from_slice(&raw_payload).expect("decode_from_slice failed");
assert!(decoded_bool);
assert_eq!(ver, version);
}
#[test]
fn test_encode_versioned_value_tuple_roundtrip() {
let version = Version::new(2, 0, 0);
let original: (u32, String) = (99, String::from("tuple"));
let payload_bytes = encode_to_vec(&original).expect("encode_to_vec failed");
let encoded = encode_versioned(&payload_bytes, version).expect("encode_versioned failed");
let (raw_payload, ver) = decode_versioned(&encoded).expect("decode_versioned failed");
let (decoded_tuple, _consumed): ((u32, String), usize) =
decode_from_slice(&raw_payload).expect("decode_from_slice failed");
assert_eq!(decoded_tuple.0, 99u32);
assert_eq!(decoded_tuple.1, "tuple");
assert_eq!(ver, version);
}
#[test]
fn test_decode_versioned_consumed_equals_encoded_length() {
let version = Version::new(1, 0, 0);
let value: u64 = 12345678;
let payload_bytes = encode_to_vec(&value).expect("encode_to_vec failed");
let encoded = encode_versioned(&payload_bytes, version).expect("encode_versioned failed");
let (raw_payload, _ver) = decode_versioned(&encoded).expect("decode_versioned failed");
let header_size = 11usize;
assert_eq!(header_size + raw_payload.len(), encoded.len());
assert_eq!(raw_payload.len(), payload_bytes.len());
}
#[test]
fn test_multiple_versioned_values_decoded_sequentially() {
let v1 = Version::new(1, 0, 0);
let v2 = Version::new(2, 0, 0);
let v3 = Version::new(3, 1, 5);
let p1 = encode_to_vec(&100u32).expect("encode p1");
let p2 = encode_to_vec(&String::from("second")).expect("encode p2");
let p3 = encode_to_vec(&false).expect("encode p3");
let e1 = encode_versioned(&p1, v1).expect("versioned e1");
let e2 = encode_versioned(&p2, v2).expect("versioned e2");
let e3 = encode_versioned(&p3, v3).expect("versioned e3");
let (raw1, ver1) = decode_versioned(&e1).expect("decode e1");
let (raw2, ver2) = decode_versioned(&e2).expect("decode e2");
let (raw3, ver3) = decode_versioned(&e3).expect("decode e3");
let (val1, _): (u32, usize) = decode_from_slice(&raw1).expect("decode val1");
let (val2, _): (String, usize) = decode_from_slice(&raw2).expect("decode val2");
let (val3, _): (bool, usize) = decode_from_slice(&raw3).expect("decode val3");
assert_eq!(val1, 100u32);
assert_eq!(val2, "second");
assert!(!val3);
assert_eq!(ver1, v1);
assert_eq!(ver2, v2);
assert_eq!(ver3, v3);
assert!(is_versioned(&e1));
assert!(is_versioned(&e2));
assert!(is_versioned(&e3));
assert!(!is_versioned(&p1));
assert!(!is_versioned(&p2));
assert!(!is_versioned(&p3));
}