charted_testkit_macros/lib.rs
1// 📦🦋 charted TestKit: testing library for Axum services with testcontainers support
2// Copyright (c) 2024 Noelware, LLC. <team@noelware.org>
3//
4// Permission is hereby granted, free of charge, to any person obtaining a copy
5// of this software and associated documentation files (the "Software"), to deal
6// in the Software without restriction, including without limitation the rights
7// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8// copies of the Software, and to permit persons to whom the Software is
9// furnished to do so, subject to the following conditions:
10//
11// The above copyright notice and this permission notice shall be included in all
12// copies or substantial portions of the Software.
13//
14// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20// SOFTWARE.
21
22mod attr;
23mod expand;
24
25use proc_macro::TokenStream;
26use syn::{parse_macro_input, ItemFn};
27
28/// Represents a procedural attribute macro that does the heavy lifting of `charted_testkit` for you. This macro
29/// also manages:
30///
31/// * setup functions, where a `fn(&TestContext) -> Result<(), Box<dyn ::std::error::Error>>` is called on each
32/// test to set it up
33/// * teardown functions, where a `fn(&TestContext) -> Result<(), Box<dyn ::std::error::Error>>` is called when
34/// a test is done being executed
35#[proc_macro_attribute]
36pub fn test(attrs: TokenStream, item: TokenStream) -> TokenStream {
37 let body = parse_macro_input!(item as ItemFn);
38 let attrs = match syn::parse::<attr::Attr>(attrs) {
39 Ok(attrs) => attrs,
40 Err(e) => return e.into_compile_error().into(),
41 };
42
43 expand::test(body, attrs).into()
44}