protobuf/rust/test/shared/accessors_test.rs

// Protocol Buffers - Google's data interchange format
// Copyright 2023 Google LLC.  All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google LLC. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

//! Tests covering accessors for singular bool, int32, int64, and bytes fields.

use protobuf::Optional;
use unittest_proto::proto2_unittest::{TestAllTypes, TestAllTypes_};

#[test]
fn test_default_accessors() {
    let msg = TestAllTypes::new();
    assert_eq!(msg.default_int32(), 41);
    assert_eq!(msg.default_int64(), 42);
    assert_eq!(msg.default_uint32(), 43);
    assert_eq!(msg.default_uint64(), 44);
    assert_eq!(msg.default_sint32(), -45);
    assert_eq!(msg.default_sint64(), 46);
    assert_eq!(msg.default_fixed32(), 47);
    assert_eq!(msg.default_fixed64(), 48);
    assert_eq!(msg.default_sfixed32(), 49);
    assert_eq!(msg.default_sfixed64(), -50);
    assert_eq!(msg.default_float(), 51.5);
    assert_eq!(msg.default_double(), 52000.0);
    assert_eq!(msg.default_bool(), true);
}

#[test]
fn test_optional_fixed32_accessors() {
    let mut msg = TestAllTypes::new();
    assert_eq!(msg.optional_fixed32_opt(), None);
    assert_eq!(msg.optional_fixed32(), 0);

    msg.optional_fixed32_set(Some(99));
    assert_eq!(msg.optional_fixed32_opt(), Some(99));
    assert_eq!(msg.optional_fixed32(), 99);

    msg.optional_fixed32_set(None);
    assert_eq!(msg.optional_fixed32_opt(), None);

    assert_eq!(msg.optional_fixed32(), 0);
}

#[test]
fn test_optional_fixed64_accessors() {
    let mut msg = TestAllTypes::new();
    assert_eq!(msg.optional_fixed64_opt(), None);
    assert_eq!(msg.optional_fixed64(), 0);

    msg.optional_fixed64_set(Some(2000));
    assert_eq!(msg.optional_fixed64_opt(), Some(2000));
    assert_eq!(msg.optional_fixed64(), 2000);

    msg.optional_fixed64_set(None);
    assert_eq!(msg.optional_fixed64_opt(), None);
    assert_eq!(msg.optional_fixed64(), 0);
}

#[test]
fn test_optional_int32_accessors() {
    let mut msg = TestAllTypes::new();
    assert_eq!(msg.optional_int32_opt(), None);
    assert_eq!(msg.optional_int32(), 0);

    msg.optional_int32_set(Some(1));
    assert_eq!(msg.optional_int32_opt(), Some(1));
    assert_eq!(msg.optional_int32(), 1);

    msg.optional_int32_set(None);
    assert_eq!(msg.optional_int32_opt(), None);

    assert_eq!(msg.optional_int32(), 0);
}

#[test]
fn test_optional_int64_accessors() {
    let mut msg = TestAllTypes::new();
    assert_eq!(msg.optional_int64_opt(), None);
    assert_eq!(msg.optional_int64(), 0);

    msg.optional_int64_set(Some(42));
    assert_eq!(msg.optional_int64_opt(), Some(42));
    assert_eq!(msg.optional_int64(), 42);

    msg.optional_int64_set(None);
    assert_eq!(msg.optional_int64_opt(), None);
    assert_eq!(msg.optional_int64(), 0);
}

#[test]
fn test_optional_sint32_accessors() {
    let mut msg = TestAllTypes::new();
    assert_eq!(msg.optional_sint32_opt(), None);
    assert_eq!(msg.optional_sint32(), 0);

    msg.optional_sint32_set(Some(-22));
    assert_eq!(msg.optional_sint32_opt(), Some(-22));
    assert_eq!(msg.optional_sint32(), -22);

    msg.optional_sint32_set(None);
    assert_eq!(msg.optional_sint32_opt(), None);
    assert_eq!(msg.optional_sint32(), 0);
}

#[test]
fn test_optional_sint64_accessors() {
    let mut msg = TestAllTypes::new();
    assert_eq!(msg.optional_sint64_opt(), None);
    assert_eq!(msg.optional_sint64(), 0);

    msg.optional_sint64_set(Some(7000));
    assert_eq!(msg.optional_sint64_opt(), Some(7000));
    assert_eq!(msg.optional_sint64(), 7000);

    msg.optional_sint64_set(None);
    assert_eq!(msg.optional_sint64_opt(), None);
    assert_eq!(msg.optional_sint64(), 0);
}

#[test]
fn test_optional_uint32_accessors() {
    let mut msg = TestAllTypes::new();
    assert_eq!(msg.optional_uint32_opt(), None);
    assert_eq!(msg.optional_uint32(), 0);

    msg.optional_uint32_set(Some(9001));
    assert_eq!(msg.optional_uint32_opt(), Some(9001));
    assert_eq!(msg.optional_uint32(), 9001);

    msg.optional_uint32_set(None);
    assert_eq!(msg.optional_uint32_opt(), None);
    assert_eq!(msg.optional_uint32(), 0);
}

#[test]
fn test_optional_uint64_accessors() {
    let mut msg = TestAllTypes::new();
    assert_eq!(msg.optional_uint64_opt(), None);
    assert_eq!(msg.optional_uint64(), 0);

    msg.optional_uint64_set(Some(42));
    assert_eq!(msg.optional_uint64_opt(), Some(42));
    assert_eq!(msg.optional_uint64(), 42);

    msg.optional_uint64_set(None);
    assert_eq!(msg.optional_uint64_opt(), None);
    assert_eq!(msg.optional_uint64(), 0);
}

#[test]
fn test_optional_float_accessors() {
    let mut msg = TestAllTypes::new();
    assert_eq!(msg.optional_float_opt(), None);
    assert_eq!(msg.optional_float(), 0.0);

    msg.optional_float_set(Some(3.14));
    assert_eq!(msg.optional_float_opt(), Some(3.14));
    assert_eq!(msg.optional_float(), 3.14);

    msg.optional_float_set(None);
    assert_eq!(msg.optional_float_opt(), None);
    assert_eq!(msg.optional_float(), 0.0);
}

#[test]
fn test_optional_double_accessors() {
    let mut msg = TestAllTypes::new();
    assert_eq!(msg.optional_double_opt(), None);
    assert_eq!(msg.optional_double(), 0.0);

    msg.optional_double_set(Some(-10.99));
    assert_eq!(msg.optional_double_opt(), Some(-10.99));
    assert_eq!(msg.optional_double(), -10.99);

    msg.optional_double_set(None);
    assert_eq!(msg.optional_double_opt(), None);
    assert_eq!(msg.optional_double(), 0.0);
}

#[test]
fn test_optional_bool_accessors() {
    let mut msg = TestAllTypes::new();
    assert_eq!(msg.optional_bool_opt(), None);

    msg.optional_bool_set(Some(true));
    assert_eq!(msg.optional_bool_opt(), Some(true));

    msg.optional_bool_set(None);
    assert_eq!(msg.optional_bool_opt(), None);
}

#[test]
fn test_optional_bytes_accessors() {
    let mut msg = TestAllTypes::new();
    assert_eq!(msg.optional_bytes(), b"");
    assert_eq!(msg.optional_bytes_opt(), Optional::Unset(&b""[..]));
    assert_eq!(msg.optional_bytes_mut().get(), b"");
    assert!(msg.optional_bytes_mut().is_unset());

    {
        let s = Vec::from(&b"hello world"[..]);
        msg.optional_bytes_mut().set(&s[..]);
    }
    assert_eq!(msg.optional_bytes(), b"hello world");
    assert_eq!(msg.optional_bytes_opt(), Optional::Set(&b"hello world"[..]));
    assert!(msg.optional_bytes_mut().is_set());
    assert_eq!(msg.optional_bytes_mut().get(), b"hello world");

    msg.optional_bytes_mut().or_default().set(b"accessors_test");
    assert_eq!(msg.optional_bytes(), b"accessors_test");
    assert_eq!(msg.optional_bytes_opt(), Optional::Set(&b"accessors_test"[..]));
    assert!(msg.optional_bytes_mut().is_set());
    assert_eq!(msg.optional_bytes_mut().get(), b"accessors_test");
    assert_eq!(msg.optional_bytes_mut().or_default().get(), b"accessors_test");

    msg.optional_bytes_mut().clear();
    assert_eq!(msg.optional_bytes(), b"");
    assert_eq!(msg.optional_bytes_opt(), Optional::Unset(&b""[..]));
    assert!(msg.optional_bytes_mut().is_unset());

    msg.optional_bytes_mut().set(b"");
    assert_eq!(msg.optional_bytes(), b"");
    assert_eq!(msg.optional_bytes_opt(), Optional::Set(&b""[..]));

    msg.optional_bytes_mut().clear();
    msg.optional_bytes_mut().or_default();
    assert_eq!(msg.optional_bytes(), b"");
    assert_eq!(msg.optional_bytes_opt(), Optional::Set(&b""[..]));

    msg.optional_bytes_mut().or_default().set(b"\xffbinary\x85non-utf8");
    assert_eq!(msg.optional_bytes(), b"\xffbinary\x85non-utf8");
    assert_eq!(msg.optional_bytes_opt(), Optional::Set(&b"\xffbinary\x85non-utf8"[..]));
    assert!(msg.optional_bytes_mut().is_set());
    assert_eq!(msg.optional_bytes_mut().get(), b"\xffbinary\x85non-utf8");
    assert_eq!(msg.optional_bytes_mut().or_default().get(), b"\xffbinary\x85non-utf8");
}

#[test]
fn test_nonempty_default_bytes_accessors() {
    let mut msg = TestAllTypes::new();
    assert_eq!(msg.default_bytes(), b"world");
    assert_eq!(msg.default_bytes_opt(), Optional::Unset(&b"world"[..]));
    assert_eq!(msg.default_bytes_mut().get(), b"world");
    assert!(msg.default_bytes_mut().is_unset());

    {
        let s = String::from("hello world");
        msg.default_bytes_mut().set(s.as_bytes());
    }
    assert_eq!(msg.default_bytes(), b"hello world");
    assert_eq!(msg.default_bytes_opt(), Optional::Set(&b"hello world"[..]));
    assert!(msg.default_bytes_mut().is_set());
    assert_eq!(msg.default_bytes_mut().get(), b"hello world");

    msg.default_bytes_mut().or_default().set(b"accessors_test");
    assert_eq!(msg.default_bytes(), b"accessors_test");
    assert_eq!(msg.default_bytes_opt(), Optional::Set(&b"accessors_test"[..]));
    assert!(msg.default_bytes_mut().is_set());
    assert_eq!(msg.default_bytes_mut().get(), b"accessors_test");
    assert_eq!(msg.default_bytes_mut().or_default().get(), b"accessors_test");

    msg.default_bytes_mut().clear();
    assert_eq!(msg.default_bytes(), b"world");
    assert_eq!(msg.default_bytes_opt(), Optional::Unset(&b"world"[..]));
    assert!(msg.default_bytes_mut().is_unset());

    msg.default_bytes_mut().set(b"");
    assert_eq!(msg.default_bytes(), b"");
    assert_eq!(msg.default_bytes_opt(), Optional::Set(&b""[..]));

    msg.default_bytes_mut().clear();
    msg.default_bytes_mut().or_default();
    assert_eq!(msg.default_bytes(), b"world");
    assert_eq!(msg.default_bytes_opt(), Optional::Set(&b"world"[..]));

    msg.default_bytes_mut().or_default().set(b"\xffbinary\x85non-utf8");
    assert_eq!(msg.default_bytes(), b"\xffbinary\x85non-utf8");
    assert_eq!(msg.default_bytes_opt(), Optional::Set(&b"\xffbinary\x85non-utf8"[..]));
    assert!(msg.default_bytes_mut().is_set());
    assert_eq!(msg.default_bytes_mut().get(), b"\xffbinary\x85non-utf8");
    assert_eq!(msg.default_bytes_mut().or_default().get(), b"\xffbinary\x85non-utf8");
}

#[test]
fn test_singular_msg_field() {
    let msg = TestAllTypes::new();
    // TODO("b/285309454"): fetch the inner integer `bb`
    // call should look like msg.optional_nested_message().bb()
    let _msg: unittest_proto::proto2_unittest::TestAllTypesView = msg.optional_nested_message();
}

#[test]
fn test_oneof_accessors() {
    let mut msg = TestAllTypes::new();
    assert_eq!(msg.oneof_field(), TestAllTypes_::OneofField::not_set);

    msg.oneof_uint32_set(Some(7));
    assert_eq!(msg.oneof_uint32_opt(), Some(7));
    assert_eq!(msg.oneof_field(), TestAllTypes_::OneofField::OneofUint32(7));

    msg.oneof_uint32_set(None);
    assert_eq!(msg.oneof_uint32_opt(), None);
    assert_eq!(msg.oneof_field(), TestAllTypes_::OneofField::not_set);

    msg.oneof_uint32_set(Some(7));
    msg.oneof_bytes_mut().set(b"");
    assert_eq!(msg.oneof_uint32_opt(), None);
    // This should show it set to the OneofBytes but its not supported yet.
    assert_eq!(msg.oneof_field(), TestAllTypes_::OneofField::not_set);
}