Skip to content

Add test for struct safety annotations #388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
copybara-service merged 1 commit into from
Feb 3, 2026
Merged

Add test for struct safety annotations #388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions rs_bindings_from_cc/test/struct/unsafe_attributes/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
"""End-to-end example of using unsafe attributes on structs."""

load("//common:crubit_wrapper_macros_oss.bzl", "crubit_rust_test")
load("//rs_bindings_from_cc/test:test_bindings.bzl", "crubit_test_cc_library")

package(default_applicable_licenses = ["//:license"])

crubit_test_cc_library(
name = "unsafe_attributes",
srcs = ["unsafe_attributes.cc"],
hdrs = ["unsafe_attributes.h"],
deps = [
"//support:annotations",
],
)

crubit_rust_test(
name = "main",
srcs = ["test.rs"],
cc_deps = [":unsafe_attributes"],
deps = [
"@crate_index//:googletest",
],
)
23 changes: 23 additions & 0 deletions rs_bindings_from_cc/test/struct/unsafe_attributes/test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// Part of the Crubit project, under the Apache License v2.0 with LLVM
// Exceptions. See /LICENSE for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

#![deny(warnings)]

use unsafe_attributes::*;

#[googletest::gtest]
#[deny(unsafe_code)]
fn test_safe_struct() {
UseSafeStructUnannotated(SafeStructUnannotated::default());
}

#[googletest::gtest]
#[deny(unused_unsafe)]
fn test_unsafe_struct() {
unsafe { UseSafeStructAnnotatedUnsafe(SafeStructAnnotatedUnsafe::default()) };
unsafe { UseUnsafeStructUnannotated(UnsafeStructUnannotated::default()) };

// TODO(b/481018055): this should not be unsafe.
unsafe { UseUnsafeStructAnnotatedSafe(UnsafeStructAnnotatedSafe::default()) };
}
10 changes: 10 additions & 0 deletions rs_bindings_from_cc/test/struct/unsafe_attributes/unsafe_attributes.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Part of the Crubit project, under the Apache License v2.0 with LLVM
// Exceptions. See /LICENSE for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

#include "rs_bindings_from_cc/test/struct/unsafe_attributes/unsafe_attributes.h"

void UseSafeStructUnannotated(SafeStructUnannotated s) {}
void UseSafeStructAnnotatedUnsafe(SafeStructAnnotatedUnsafe s) {}
void UseUnsafeStructUnannotated(UnsafeStructUnannotated s) {}
void UseUnsafeStructAnnotatedSafe(UnsafeStructAnnotatedSafe s) {}
30 changes: 30 additions & 0 deletions rs_bindings_from_cc/test/struct/unsafe_attributes/unsafe_attributes.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// Part of the Crubit project, under the Apache License v2.0 with LLVM
// Exceptions. See /LICENSE for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

#ifndef CRUBIT_RS_BINDINGS_FROM_CC_TEST_STRUCT_UNSAFE_ATTRIBUTES_H_
#define CRUBIT_RS_BINDINGS_FROM_CC_TEST_STRUCT_UNSAFE_ATTRIBUTES_H_

#include "support/annotations.h"

struct SafeStructUnannotated {};

struct CRUBIT_UNSAFE SafeStructAnnotatedUnsafe {};

struct UnsafeStructUnannotated {
public:
void* ptr = nullptr;
};

struct CRUBIT_UNSAFE_MARK_SAFE UnsafeStructAnnotatedSafe {
public:
void* ptr = nullptr;
};

void UseSafeStructUnannotated(SafeStructUnannotated s);
void UseSafeStructAnnotatedUnsafe(SafeStructAnnotatedUnsafe s);

void UseUnsafeStructUnannotated(UnsafeStructUnannotated s);
void UseUnsafeStructAnnotatedSafe(UnsafeStructAnnotatedSafe s);

#endif // CRUBIT_RS_BINDINGS_FROM_CC_TEST_STRUCT_UNSAFE_ATTRIBUTES_H_