1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
//! Part of the ntest library. Add test cases to the rust test framework.
extern crate proc_macro;
extern crate syn;
use proc_macro::TokenStream;
use proc_macro2::Span;
use quote::quote;
use syn::parse_macro_input;
mod syn_helper;
/// Test cases can be used to have multiple inputs for a given function.
/// With the `#[test_case]` attribute multiple tests will be generated using the
/// [Procedural Macros](https://blog.rust-lang.org/2018/12/21/Procedural-Macros-in-Rust-2018.html)
/// capabilities of rust.
///
/// The function input can be of type `int`, `bool`, or `str`, or a path to an
/// enum or constant of those types.
///
/// Please note that rust functions can only contain alphanumeric characters and '_' signs.
/// Special characters will be escaped using a meaning full replacement (for example `#` will be replaced with `_hash`),
/// or as a default the '_' sign.
///
/// A function annotated with a `#[test_case]` attribute will be split into multiple rust functions annotated with the `#[test]` attribute.
///
/// # Examples
///
/// Example with a single argument
/// ```ignore
/// #[test_case(13)]
/// #[test_case(42)]
/// fn one_arg(x: u32) {
/// assert!(x == 13 || x == 42)
/// }
/// ```
///
/// The test cases above will be parsed at compile time and two rust test functions will be generated instead:
/// ```ignore
/// #[test]
/// fn one_arg_13() {
/// x = 13;
/// assert!(x == 13 || x == 42)
/// }
///
/// #[test]
/// fn one_arg_42() {
/// x = 42;
/// assert!(x == 13 || x == 42)
/// }
/// ```
///
/// Example with multiple arguments:
/// ```ignore
/// #[test_case(true, "true", 1)]
/// fn test_mix(x: bool, y: &str, z: u16) {
/// assert!(x);
/// assert_eq!(y, "true");
/// assert_eq!(z, 1);
/// }
/// ```
///
/// Example with name attribute:
/// ```ignore
/// #[test_case(42, name="my_fancy_test")]
/// fn with_name(x: u32) {
/// assert_eq!(x, 42)
/// }
/// ```
///
/// Example with rust test attributes.
/// All attributes after a test case will be appended after the generated `#[test]` attribute.
/// For example the following test cases...
///
/// ```ignore
/// #[test_case(18)]
/// #[ignore]
/// #[test_case(15)]
/// #[should_panic(expected = "I am panicing")]
/// fn attributes_test_case(x: u32) {
/// panic!("I am panicing");
/// }
/// ```
///
/// ... will be compiled to these two tests. One gets ignored and the other succeeds:
///
/// ```ignore
/// #[test]
/// #[ignore]
/// fn attributes_test_case_18 {
/// let x = 18;
/// panic!("I am panicing");
/// }
///
/// #[test]
/// #[should_panic(expected = "I am panicing")]
/// fn attributes_test_case_15() {
/// let x = 15;
/// panic!("I am panicing");
/// }
/// ```
///
/// Test functions with a `Result` return are also supported:
///
/// ```ignore
/// #[test_case(27)]
/// #[test_case(33)]
/// fn returns_result(x: u32) -> Result<(), ()> {
/// Ok(())
/// }
/// ```
#[proc_macro_attribute]
pub fn test_case(attr: TokenStream, item: TokenStream) -> TokenStream {
let input = parse_macro_input!(item as syn::ItemFn);
let attribute_args = parse_macro_input!(attr as syn::AttributeArgs);
let test_descriptions: Vec<TestDescription> =
collect_test_descriptions(&input, &attribute_args);
let fn_body = &input.block;
let (fn_args_idents, fn_args_ty ) = collect_function_arg_idents(&input);
let fn_return = &input.sig.output;
let mut result = proc_macro2::TokenStream::new();
for test_description in test_descriptions {
let test_case_name = syn::Ident::new(&test_description.name, Span::call_site());
let literals = test_description.args;
let attributes = test_description.attributes;
if literals.len() != fn_args_idents.len() {
panic!("Test case arguments and function input signature mismatch.");
}
let test_case_quote = quote! {
#[test]
#[allow(non_snake_case)]
#(#attributes)*
fn #test_case_name() #fn_return {
#(let #fn_args_idents: #fn_args_ty = #literals;)*
#fn_body
}
};
result.extend(test_case_quote);
}
result.into()
}
fn collect_function_arg_idents(input: &syn::ItemFn) -> (Vec<syn::Ident>, Vec<syn::Type>) {
let mut fn_args_idents: Vec<syn::Ident> = vec![];
let mut fn_types: Vec<syn::Type> = vec![];
let fn_args = &input.sig.inputs;
for i in fn_args {
match i {
syn::FnArg::Typed(t) => {
let ubox_t = *(t.pat.clone());
match ubox_t {
syn::Pat::Ident(i) => {
fn_args_idents.push(i.ident.clone());
}
_ => panic!("Unexpected function identifier."),
}
fn_types.push(*t.ty.clone());
}
syn::FnArg::Receiver(_) => {
panic!("Receiver function not expected for test case attribute.")
}
}
}
(fn_args_idents, fn_types)
}
struct TestDescription {
args: Vec<syn::Expr>,
name: String,
attributes: Vec<syn::Attribute>,
}
fn collect_test_descriptions(
input: &syn::ItemFn,
attribute_args: &syn::AttributeArgs,
) -> Vec<TestDescription> {
let mut test_case_descriptions: Vec<TestDescription> = vec![];
let fn_name = input.sig.ident.to_string();
let test_case_parameter = parse_test_case_attributes(attribute_args);
let test_name = calculate_test_name(&test_case_parameter, &fn_name);
let curr_test_attributes = TestDescription {
args: test_case_parameter.args,
name: test_name,
attributes: vec![],
};
test_case_descriptions.push(curr_test_attributes);
for attribute in &input.attrs {
let meta = attribute.parse_meta();
match meta {
Ok(m) => match m {
syn::Meta::Path(p) => {
let identifier = p.get_ident().expect("Expected identifier!");
if identifier == "test_case" {
panic!("Test case attributes need at least one argument such as #[test_case(42)].");
} else {
test_case_descriptions
.last_mut()
.unwrap()
.attributes
.push(attribute.clone());
}
}
syn::Meta::List(ml) => {
let identifier = ml.path.get_ident().expect("Expected identifier!");
if identifier == "test_case" {
let argument_args: syn::AttributeArgs = ml.nested.into_iter().collect();
let test_case_parameter = parse_test_case_attributes(&argument_args);
let test_name = calculate_test_name(&test_case_parameter, &fn_name);
let curr_test_attributes = TestDescription {
args: test_case_parameter.args,
name: test_name,
attributes: vec![],
};
test_case_descriptions.push(curr_test_attributes);
} else {
test_case_descriptions
.last_mut()
.unwrap()
.attributes
.push(attribute.clone());
}
}
syn::Meta::NameValue(_) => {
test_case_descriptions
.last_mut()
.unwrap()
.attributes
.push(attribute.clone());
}
},
Err(e) => panic!("Could not determine meta data. Error {}.", e),
}
}
test_case_descriptions
}
struct TestCaseAttributes {
args: Vec<syn::Expr>,
custom_name: Option<String>,
}
fn parse_test_case_attributes(attr: &syn::AttributeArgs) -> TestCaseAttributes {
let mut args: Vec<syn::Expr> = vec![];
let mut custom_name: Option<String> = None;
for a in attr {
match a {
syn::NestedMeta::Meta(m) => match m {
syn::Meta::Path(path) => {
args.push(syn::ExprPath { attrs: vec![], qself: None, path: path.clone() }.into());
}
syn::Meta::List(_) => {
panic!("Metalist not expected.");
}
syn::Meta::NameValue(nv) => {
let identifier = nv.path.get_ident().expect("Expected identifier!");
if identifier == "test_name" || identifier == "name" {
if custom_name.is_some() {
panic!("Test name can only be defined once.");
}
match &nv.lit {
syn::Lit::Str(_) => {
custom_name = Some(syn_helper::lit_to_str(&nv.lit));
}
_ => unimplemented!("Unexpected type for test name. Expected string."),
}
} else {
panic!("Unexpected identifier '{}'", identifier)
}
}
},
syn::NestedMeta::Lit(lit) => {
args.push(syn::ExprLit { attrs: vec![], lit: lit.clone() }.into());
}
}
}
TestCaseAttributes {
args,
custom_name,
}
}
fn calculate_test_name(attr: &TestCaseAttributes, fn_name: &str) -> String {
let mut name = "".to_string();
match &attr.custom_name {
None => {
name.push_str(fn_name);
for expr in &attr.args {
match expr {
syn::Expr::Lit(lit) => name.push_str(&format!("_{}", syn_helper::lit_to_str(&lit.lit))),
syn::Expr::Path(path) => name.push_str(&format!("_{}", path.path.segments.last().expect("Path to contain at least one segment").ident)),
_ => unimplemented!("Unexpected expr type when calculating test name."),
}
}
}
Some(custom_name) => name = custom_name.to_string(),
}
name
}