diff options
author | Martin Geisler <mgeisler@google.com> | 2023-09-07 08:26:12 +0000 |
---|---|---|
committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | 2023-09-07 08:26:12 +0000 |
commit | f4ceef636806915aa0d8497fa4e28ba8595fa4f3 (patch) | |
tree | d0685b32e84350c5a70e59c2ae5bfed7376f7c9f | |
parent | ce4294669b7fe0ff2679ae67fdf4803025f3eab3 (diff) | |
parent | 278801f0a40be53821bc769a0d47e3a13b477084 (diff) | |
download | googletest_macro-f4ceef636806915aa0d8497fa4e28ba8595fa4f3.tar.gz |
Import googletest_macro 0.10.0 am: 278801f0a4
Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/googletest_macro/+/2736563
Change-Id: I1df467b2efc712432fdf16d964ff28e416899b17
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
-rw-r--r-- | .cargo_vcs_info.json | 6 | ||||
-rw-r--r-- | Android.bp | 19 | ||||
-rw-r--r-- | Cargo.toml | 42 | ||||
-rw-r--r-- | LICENSE | 202 | ||||
-rw-r--r-- | METADATA | 19 | ||||
-rw-r--r-- | MODULE_LICENSE_APACHE2 | 0 | ||||
-rw-r--r-- | OWNERS | 1 | ||||
-rw-r--r-- | README.md | 5 | ||||
-rw-r--r-- | cargo2android.json | 5 | ||||
-rw-r--r-- | src/lib.rs | 128 |
10 files changed, 427 insertions, 0 deletions
diff --git a/.cargo_vcs_info.json b/.cargo_vcs_info.json new file mode 100644 index 0000000..6a70fdf --- /dev/null +++ b/.cargo_vcs_info.json @@ -0,0 +1,6 @@ +{ + "git": { + "sha1": "6e5405db2217d37006720c101beb1b91199a3a26" + }, + "path_in_vcs": "googletest_macro" +}
\ No newline at end of file diff --git a/Android.bp b/Android.bp new file mode 100644 index 0000000..480a3bc --- /dev/null +++ b/Android.bp @@ -0,0 +1,19 @@ +// This file is generated by cargo2android.py --config cargo2android.json. +// Do not modify this file as changes will be overridden on upgrade. + + + +rust_proc_macro { + name: "libgoogletest_macro", + crate_name: "googletest_macro", + cargo_env_compat: true, + cargo_pkg_version: "0.10.0", + srcs: ["src/lib.rs"], + edition: "2021", + rustlibs: [ + "libquote", + "libsyn", + ], + product_available: true, + vendor_available: true, +} diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..92d0de1 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,42 @@ +# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO +# +# When uploading crates to the registry Cargo will automatically +# "normalize" Cargo.toml files for maximal compatibility +# with all versions of Cargo and also rewrite `path` dependencies +# to registry (e.g., crates.io) dependencies. +# +# If you are reading this file be aware that the original Cargo.toml +# will likely look very different (and much more reasonable). +# See Cargo.toml.orig for the original contents. + +[package] +edition = "2021" +name = "googletest_macro" +version = "0.10.0" +authors = ["Bradford Hovinen <hovinen@google.com>"] +description = "Procedural macros for GoogleTest Rust" +readme = "README.md" +keywords = [ + "unit", + "matcher", + "testing", + "assertions", +] +categories = [ + "development-tools", + "development-tools::testing", +] +license = "Apache-2.0" +repository = "https://github.com/google/googletest-rust" +resolver = "1" + +[lib] +name = "googletest_macro" +proc-macro = true + +[dependencies.quote] +version = "1.0.21" + +[dependencies.syn] +version = "2.0.10" +features = ["full"] @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/METADATA b/METADATA new file mode 100644 index 0000000..cf14f5e --- /dev/null +++ b/METADATA @@ -0,0 +1,19 @@ +name: "googletest_macro" +description: "Procedural macros for GoogleTest Rust" +third_party { + identifier { + type: "crates.io" + value: "https://crates.io/crates/googletest_macro" + } + identifier { + type: "Archive" + value: "https://static.crates.io/crates/googletest_macro/googletest_macro-0.10.0.crate" + } + version: "0.10.0" + license_type: NOTICE + last_upgrade_date { + year: 2023 + month: 9 + day: 1 + } +} diff --git a/MODULE_LICENSE_APACHE2 b/MODULE_LICENSE_APACHE2 new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/MODULE_LICENSE_APACHE2 @@ -0,0 +1 @@ +include platform/prebuilts/rust:master:/OWNERS diff --git a/README.md b/README.md new file mode 100644 index 0000000..9b66ba9 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +## Procedural macros for GoogleTest Rust + +This crate is only useful as a dependency of +[GoogleTest Rust](https://crates.io/crates/googletest). It cannot be used on its +own. diff --git a/cargo2android.json b/cargo2android.json new file mode 100644 index 0000000..d36fb44 --- /dev/null +++ b/cargo2android.json @@ -0,0 +1,5 @@ +{ + "device": true, + "run": true, + "tests": true +}
\ No newline at end of file diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..87628ba --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,128 @@ +// Copyright 2022 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +use quote::quote; +use syn::{parse_macro_input, Attribute, ItemFn, ReturnType}; + +/// Marks a test to be run by the Google Rust test runner. +/// +/// Annotate tests the same way ordinary Rust tests are annotated: +/// +/// ```ignore +/// #[googletest::test] +/// fn should_work() { +/// ... +/// } +/// ``` +/// +/// The test function is not required to have a return type. If it does have a +/// return type, that type must be [`googletest::Result`]. One may do this if +/// one wishes to use both fatal and non-fatal assertions in the same test. For +/// example: +/// +/// ```ignore +/// #[googletest::test] +/// fn should_work() -> googletest::Result<()> { +/// let value = 2; +/// expect_that!(value, gt(0)); +/// verify_that!(value, eq(2)) +/// } +/// ``` +/// +/// [`googletest::Result`]: type.Result.html +#[proc_macro_attribute] +pub fn test( + _args: proc_macro::TokenStream, + input: proc_macro::TokenStream, +) -> proc_macro::TokenStream { + let mut parsed_fn = parse_macro_input!(input as ItemFn); + let attrs = parsed_fn.attrs.drain(..).collect::<Vec<_>>(); + let (mut sig, block) = (parsed_fn.sig, parsed_fn.block); + let output_type = match sig.output.clone() { + ReturnType::Type(_, output_type) => Some(output_type), + ReturnType::Default => None, + }; + sig.output = ReturnType::Default; + let (maybe_closure, invocation) = if sig.asyncness.is_some() { + ( + // In the async case, the ? operator returns from the *block* rather than the + // surrounding function. So we just put the test content in an async block. Async + // closures are still unstable (see https://github.com/rust-lang/rust/issues/62290), + // so we can't use the same solution as the sync case below. + quote! {}, + quote! { + async { #block }.await + }, + ) + } else { + ( + // In the sync case, the ? operator returns from the surrounding function. So we must + // create a separate closure from which the ? operator can return in order to capture + // the output. + quote! { + let test = move || #block; + }, + quote! { + test() + }, + ) + }; + let function = if let Some(output_type) = output_type { + quote! { + #(#attrs)* + #sig -> std::result::Result<(), googletest::internal::test_outcome::TestFailure> { + #maybe_closure + use googletest::internal::test_outcome::TestOutcome; + TestOutcome::init_current_test_outcome(); + let result: #output_type = #invocation; + TestOutcome::close_current_test_outcome(result) + } + } + } else { + quote! { + #(#attrs)* + #sig -> std::result::Result<(), googletest::internal::test_outcome::TestFailure> { + #maybe_closure + use googletest::internal::test_outcome::TestOutcome; + TestOutcome::init_current_test_outcome(); + #invocation; + TestOutcome::close_current_test_outcome(googletest::Result::Ok(())) + } + } + }; + let output = if attrs.iter().any(is_test_attribute) { + function + } else { + quote! { + #[::core::prelude::v1::test] + #function + } + }; + output.into() +} + +fn is_test_attribute(attr: &Attribute) -> bool { + let first_segment = match attr.path().segments.first() { + Some(first_segment) => first_segment, + None => return false, + }; + let last_segment = match attr.path().segments.last() { + Some(last_segment) => last_segment, + None => return false, + }; + last_segment.ident == "test" + || (first_segment.ident == "rstest" + && last_segment.ident == "rstest" + && attr.path().segments.len() <= 2) +} |