/
mod.rs
449 lines (403 loc) · 12.4 KB
/
mod.rs
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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
pub(crate) mod fixture;
mod test;
mod wrapper;
use std::collections::HashMap;
use syn::token::Async;
use proc_macro2::{Span, TokenStream};
use syn::{parse_quote, Attribute, Expr, FnArg, Ident, ItemFn, Path, ReturnType, Stmt};
use quote::{format_ident, quote, ToTokens};
use unicode_ident::is_xid_continue;
use crate::utils::attr_ends_with;
use crate::{
parse::{
rstest::{RsTestAttributes, RsTestData, RsTestInfo},
testcase::TestCase,
vlist::ValueList,
},
utils::attr_is,
};
use crate::{
refident::MaybeIdent,
resolver::{self, Resolver},
};
use wrapper::WrapByModule;
pub(crate) use fixture::render as fixture;
pub(crate) mod inject;
pub(crate) fn single(mut test: ItemFn, info: RsTestInfo) -> TokenStream {
let resolver = resolver::fixtures::get(info.data.fixtures());
let args = test.sig.inputs.iter().cloned().collect::<Vec<_>>();
let attrs = std::mem::take(&mut test.attrs);
let asyncness = test.sig.asyncness;
let generic_types = test
.sig
.generics
.type_params()
.map(|tp| &tp.ident)
.cloned()
.collect::<Vec<_>>();
single_test_case(
&test.sig.ident,
&test.sig.ident,
&args,
&attrs,
&test.sig.output,
asyncness,
Some(&test),
resolver,
&info.attributes,
&generic_types,
)
}
pub(crate) fn parametrize(test: ItemFn, info: RsTestInfo) -> TokenStream {
let RsTestInfo { data, attributes } = info;
let resolver_fixtures = resolver::fixtures::get(data.fixtures());
let rendered_cases = cases_data(&data, test.sig.ident.span())
.map(|(name, attrs, resolver)| {
TestCaseRender::new(name, attrs, (resolver, &resolver_fixtures))
})
.map(|case| case.render(&test, &attributes))
.collect();
test_group(test, rendered_cases)
}
impl ValueList {
fn render(
&self,
test: &ItemFn,
resolver: &dyn Resolver,
attrs: &[syn::Attribute],
attributes: &RsTestAttributes,
) -> TokenStream {
let span = test.sig.ident.span();
let test_cases = self
.argument_data(resolver)
.map(|(name, r)| TestCaseRender::new(Ident::new(&name, span), attrs, r))
.map(|test_case| test_case.render(test, attributes));
quote! { #(#test_cases)* }
}
fn argument_data<'a>(
&'a self,
resolver: &'a dyn Resolver,
) -> impl Iterator<Item = (String, Box<(&'a dyn Resolver, (String, Expr))>)> + 'a {
let max_len = self.values.len();
self.values.iter().enumerate().map(move |(index, expr)| {
let sanitized_expr = sanitize_ident(expr);
let name = format!(
"{}_{:0len$}_{sanitized_expr:.64}",
self.arg,
index + 1,
len = max_len.display_len()
);
let resolver_this = (self.arg.to_string(), expr.clone());
(name, Box::new((resolver, resolver_this)))
})
}
}
fn _matrix_recursive<'a>(
test: &ItemFn,
list_values: &'a [&'a ValueList],
resolver: &dyn Resolver,
attrs: &'a [syn::Attribute],
attributes: &RsTestAttributes,
) -> TokenStream {
if list_values.is_empty() {
return Default::default();
}
let vlist = list_values[0];
let list_values = &list_values[1..];
if list_values.is_empty() {
vlist.render(test, resolver, attrs, attributes)
} else {
let span = test.sig.ident.span();
let modules = vlist.argument_data(resolver).map(move |(name, resolver)| {
_matrix_recursive(test, list_values, &resolver, attrs, attributes)
.wrap_by_mod(&Ident::new(&name, span))
});
quote! { #(#modules)* }
}
}
pub(crate) fn matrix(test: ItemFn, info: RsTestInfo) -> TokenStream {
let RsTestInfo {
data, attributes, ..
} = info;
let span = test.sig.ident.span();
let cases = cases_data(&data, span).collect::<Vec<_>>();
let resolver = resolver::fixtures::get(data.fixtures());
let rendered_cases = if cases.is_empty() {
let list_values = data.list_values().collect::<Vec<_>>();
_matrix_recursive(&test, &list_values, &resolver, &[], &attributes)
} else {
cases
.into_iter()
.map(|(case_name, attrs, case_resolver)| {
let list_values = data.list_values().collect::<Vec<_>>();
_matrix_recursive(
&test,
&list_values,
&(case_resolver, &resolver),
attrs,
&attributes,
)
.wrap_by_mod(&case_name)
})
.collect()
};
test_group(test, rendered_cases)
}
fn resolve_default_test_attr(is_async: bool) -> TokenStream {
if is_async {
quote! { #[async_std::test] }
} else {
quote! { #[test] }
}
}
fn render_exec_call(fn_path: Path, args: &[Ident], is_async: bool) -> TokenStream {
if is_async {
quote! {#fn_path(#(#args),*).await}
} else {
quote! {#fn_path(#(#args),*)}
}
}
fn render_test_call(
fn_path: Path,
args: &[Ident],
timeout: Option<Expr>,
is_async: bool,
) -> TokenStream {
match (timeout, is_async) {
(Some(to_expr), true) => quote! {
use rstest::timeout::*;
execute_with_timeout_async(move || #fn_path(#(#args),*), #to_expr).await
},
(Some(to_expr), false) => quote! {
use rstest::timeout::*;
execute_with_timeout_sync(move || #fn_path(#(#args),*), #to_expr)
},
_ => render_exec_call(fn_path, args, is_async),
}
}
/// Render a single test case:
///
/// * `name` - Test case name
/// * `testfn_name` - The name of test function to call
/// * `args` - The arguments of the test function
/// * `attrs` - The expected test attributes
/// * `output` - The expected test return type
/// * `asyncness` - The `async` fn token
/// * `test_impl` - If you want embed test function (should be the one called by `testfn_name`)
/// * `resolver` - The resolver used to resolve injected values
/// * `attributes` - Test attributes to select test behaviour
/// * `generic_types` - The genrics type used in signature
///
// Ok I need some refactoring here but now that not a real issue
#[allow(clippy::too_many_arguments)]
fn single_test_case<'a>(
name: &Ident,
testfn_name: &Ident,
args: &[FnArg],
attrs: &[Attribute],
output: &ReturnType,
asyncness: Option<Async>,
test_impl: Option<&ItemFn>,
resolver: impl Resolver,
attributes: &'a RsTestAttributes,
generic_types: &[Ident],
) -> TokenStream {
let (attrs, trace_me): (Vec<_>, Vec<_>) =
attrs.iter().cloned().partition(|a| !attr_is(a, "trace"));
let mut attributes = attributes.clone();
if !trace_me.is_empty() {
attributes.add_trace(format_ident!("trace"));
}
let inject = inject::resolve_aruments(args.iter(), &resolver, generic_types);
let args = args
.iter()
.filter_map(MaybeIdent::maybe_ident)
.cloned()
.collect::<Vec<_>>();
let trace_args = trace_arguments(args.iter(), &attributes);
let is_async = asyncness.is_some();
let (attrs, timeouts): (Vec<_>, Vec<_>) =
attrs.iter().cloned().partition(|a| !attr_is(a, "timeout"));
let timeout = timeouts
.into_iter()
.last()
.map(|attribute| attribute.parse_args::<Expr>().unwrap());
// If no injected attribut provided use the default one
let test_attr = if attrs
.iter()
.any(|a| attr_ends_with(a, &parse_quote! {test}))
{
None
} else {
Some(resolve_default_test_attr(is_async))
};
let execute = render_test_call(testfn_name.clone().into(), &args, timeout, is_async);
quote! {
#test_attr
#(#attrs)*
#asyncness fn #name() #output {
#test_impl
#inject
#trace_args
#execute
}
}
}
fn trace_arguments<'a>(
args: impl Iterator<Item = &'a Ident>,
attributes: &RsTestAttributes,
) -> Option<TokenStream> {
let mut statements = args
.filter(|&arg| attributes.trace_me(arg))
.map(|arg| {
let s: Stmt = parse_quote! {
println!("{} = {:?}", stringify!(#arg), #arg);
};
s
})
.peekable();
if statements.peek().is_some() {
Some(quote! {
println!("{:-^40}", " TEST ARGUMENTS ");
#(#statements)*
println!("{:-^40}", " TEST START ");
})
} else {
None
}
}
struct TestCaseRender<'a> {
name: Ident,
attrs: &'a [syn::Attribute],
resolver: Box<dyn Resolver + 'a>,
}
impl<'a> TestCaseRender<'a> {
pub fn new<R: Resolver + 'a>(name: Ident, attrs: &'a [syn::Attribute], resolver: R) -> Self {
TestCaseRender {
name,
attrs,
resolver: Box::new(resolver),
}
}
fn render(self, testfn: &ItemFn, attributes: &RsTestAttributes) -> TokenStream {
let args = testfn.sig.inputs.iter().cloned().collect::<Vec<_>>();
let mut attrs = testfn.attrs.clone();
attrs.extend(self.attrs.iter().cloned());
let asyncness = testfn.sig.asyncness;
let generic_types = testfn
.sig
.generics
.type_params()
.map(|tp| &tp.ident)
.cloned()
.collect::<Vec<_>>();
single_test_case(
&self.name,
&testfn.sig.ident,
&args,
&attrs,
&testfn.sig.output,
asyncness,
None,
self.resolver,
attributes,
&generic_types,
)
}
}
fn test_group(mut test: ItemFn, rendered_cases: TokenStream) -> TokenStream {
let fname = &test.sig.ident;
test.attrs = vec![];
quote! {
#[cfg(test)]
#test
#[cfg(test)]
mod #fname {
use super::*;
#rendered_cases
}
}
}
trait DisplayLen {
fn display_len(&self) -> usize;
}
impl<D: std::fmt::Display> DisplayLen for D {
fn display_len(&self) -> usize {
format!("{}", self).len()
}
}
fn format_case_name(case: &TestCase, index: usize, display_len: usize) -> String {
let description = case
.description
.as_ref()
.map(|d| format!("_{}", d))
.unwrap_or_default();
format!(
"case_{:0len$}{d}",
index,
len = display_len,
d = description
)
}
fn cases_data(
data: &RsTestData,
name_span: Span,
) -> impl Iterator<Item = (Ident, &[syn::Attribute], HashMap<String, &syn::Expr>)> {
let display_len = data.cases().count().display_len();
data.cases().enumerate().map({
move |(n, case)| {
let resolver_case = data
.case_args()
.map(|a| a.to_string())
.zip(case.args.iter())
.collect::<HashMap<_, _>>();
(
Ident::new(&format_case_name(case, n + 1, display_len), name_span),
case.attrs.as_slice(),
resolver_case,
)
}
})
}
fn sanitize_ident(expr: &Expr) -> String {
expr.to_token_stream()
.to_string()
.chars()
.filter(|c| !c.is_whitespace())
.map(|c| match c {
'"' | '\'' => "__".to_owned(),
':' | '(' | ')' | '{' | '}' | '[' | ']' | ',' | '.' | '*' | '+' | '/' | '-' | '%'
| '^' | '!' | '&' | '|' => "_".to_owned(),
_ => c.to_string(),
})
.collect::<String>()
.chars()
.filter(|&c| is_xid_continue(c))
.collect()
}
#[cfg(test)]
mod tests {
use crate::test::ToAst;
use super::*;
use crate::test::{assert_eq, *};
#[rstest]
#[case("1", "1")]
#[case(r#""1""#, "__1__")]
#[case(r#"Some::SomeElse"#, "Some__SomeElse")]
#[case(r#""minnie".to_owned()"#, "__minnie___to_owned__")]
#[case(
r#"vec![1 , 2,
3]"#,
"vec__1_2_3_"
)]
#[case(
r#"some_macro!("first", {second}, [third])"#,
"some_macro____first____second___third__"
)]
#[case(r#"'x'"#, "__x__")]
#[case::ops(r#"a*b+c/d-e%f^g"#, "a_b_c_d_e_f_g")]
fn sanitaze_ident_name(#[case] expression: impl AsRef<str>, #[case] expected: impl AsRef<str>) {
let expression: Expr = expression.as_ref().ast();
assert_eq!(expected.as_ref(), sanitize_ident(&expression));
}
}