test-helpers-async 0.2.3

Jest style setup and teardown test helper macros
Documentation
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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
//
//! Some setup and teardown macro helpers to mimic [Jest's setup and teardown](https://jestjs.io/docs/setup-teardown)
//! functionality. Also includes a `skip` macro that mimics the [skip](https://jestjs.io/docs/api#testskipname-fn)
//! functionality in Jest.
//!
//! There are currently five macros provided: `after_all`,
//! `after_each`, `before_all`, `before_each`, and `skip`. I would like to implement `only` to
//! match [Jest's only](https://jestjs.io/docs/api#testonlyname-fn-timeout) functionality. I'm
//! unsure of a great way to do that currently, however.
//!
//! ## Getting Started
//! Using these macros is fairly simple. The four after/before functions all require a function
//! with the same name as the attribute and are only valid when applied to a mod. They are all used
//! like in the below example. Replace `before_each` with whichever method you want to use. The
//! code in the matching function will be inserted into every fn in the containing mod that has an
//! attribute with the word "test" in it. This is to allow for use with not just normal `#[test]`
//! attributes, but also other flavors like `#[tokio::test]` and `#[test_case(0)]`.
//! ```
//! #[cfg(test)]
//! use test_env_helpers::*;
//!
//! #[before_each]
//! #[cfg(test)]
//! mod my_tests{
//!     fn before_each(){println!("I'm in every test!")}
//!     #[test]
//!     fn test_1(){}
//!     #[test]
//!     fn test_2(){}
//!     #[test]
//!     fn test_3(){}
//! }
//! ```
//!
//! The `skip` macro is valid on either a mod or an individual test and will remove the mod or test
//! it is applied to. You can use it to skip tests that aren't working correctly or that you don't
//! want to run for some reason.
//!
//! ```
//! #[cfg(test)]
//! use test_env_helpers::*;
//!
//! #[cfg(test)]
//! mod my_tests{
//!     #[skip]
//!     #[test]
//!     fn broken_test(){panic!("I'm hella broke")}
//!     #[skip]
//!     mod broken_mod{
//!         #[test]
//!         fn i_will_not_be_run(){panic!("I get skipped too")}
//!     }
//!     #[test]
//!     fn test_2(){}
//!     #[test]
//!     fn test_3(){}
//! }
//! ```

extern crate proc_macro;
mod utils;

use crate::utils::traverse_use_item;

use proc_macro::TokenStream;
use quote::quote;
use syn::Stmt;
use syn::Item;
use syn::parse_quote;
use syn::parse_macro_input;

/// Will run the code in the matching `after_all` function exactly once when all of the tests have
/// run. This works by counting the number of `#[test]` attributes and decrementing a counter at
/// the beginning of every test. Once the counter reaches 0, it will run the code in `after_all`.
/// It uses [std::sync::Once](https://doc.rust-lang.org/std/sync/struct.Once.html) internally
/// to ensure that the code is run at maximum one time.
///
/// ```
/// #[cfg(test)]
/// use test_env_helpers::*;
///
/// #[after_all]
/// #[cfg(test)]
/// mod my_tests{
///     fn after_all(){println!("I only get run once at the very end")}
///     #[test]
///     fn test_1(){}
///     #[test]
///     fn test_2(){}
///     #[test]
///     fn test_3(){}
/// }
/// ```
#[proc_macro_attribute]
pub fn after_all_async(_metadata: TokenStream, input: TokenStream) -> TokenStream {
    let input: Item = match parse_macro_input!(input as Item) {
        Item::Mod(mut m) => {
            let (brace, items) = m.content.unwrap();
            let (after_all_fn, everything_else): (Vec<Item>, Vec<Item>) =
                items.into_iter().partition(|t| match t {
                    Item::Fn(f) => f.sig.ident == "after_all_async",
                    _ => false,
                });
            let after_all_fn_block = if after_all_fn.len() != 1 {
                panic!("The `after_all` macro attribute requires a single function named `after_all` in the body of the module it is called on.")
            } else {
                match after_all_fn.into_iter().next().unwrap() {
                    Item::Fn(f) => f.block,
                    _ => unreachable!(),
                }
            };
            let after_all_if: Stmt = parse_quote! {
                if REMAINING_TESTS.fetch_sub(1, Ordering::SeqCst) == 1 {
                    AFTER_ALL.call_once(|| {
                        #after_all_fn_block
                    });
                }
            };
            let resume: Stmt = parse_quote! {
                if let Err(err) = result {
                    panic::resume_unwind(err);
                }
            };
            let mut count: usize = 0;
            let mut has_once: bool = false;
            let mut has_atomic_usize: bool = false;
            let mut has_ordering: bool = false;
            let mut has_panic: bool = false;

            let mut e: Vec<Item> = everything_else
                .into_iter()
                .map(|t| match t {
                    Item::Fn(mut f) => {
                        let test_count = f
                            .attrs
                            .iter()
                            .filter(|attr| {
                                attr.path
                                    .segments
                                    .iter()
                                    .any(|segment| segment.ident.to_string().contains("test"))
                            })
                            .count();
                        if test_count > 0 {
                            count += test_count;
                            f.block.stmts.push(after_all_if.clone());
                            Item::Fn(f)
                        } else {
                            Item::Fn(f)
                        }
                    }
                    Item::Use(use_stmt) => {
                        if traverse_use_item(&use_stmt.tree, vec!["std", "sync", "Once"]).is_some()
                        {
                            has_once = true;
                        }
                        if traverse_use_item(
                            &use_stmt.tree,
                            vec!["std", "sync", "atomic", "AtomicUsize"],
                        )
                        .is_some()
                        {
                            has_atomic_usize = true;
                        }
                        if traverse_use_item(
                            &use_stmt.tree,
                            vec!["std", "sync", "atomic", "Ordering"],
                        )
                        .is_some()
                        {
                            has_ordering = true;
                        }
                        if traverse_use_item(
                            &use_stmt.tree,
                            vec!["std", "panic"],
                        )
                        .is_some() {
                            has_panic = true;
                        }
                        Item::Use(use_stmt)
                    }
                    el => el,
                })
                .collect();

            let use_once: Item = parse_quote!(
                use std::sync::Once;
            );
            let use_atomic_usize: Item = parse_quote!(
                use std::sync::atomic::AtomicUsize;
            );
            let use_ordering: Item = parse_quote!(
                use std::sync::atomic::Ordering;
            );
            let use_panic: Item = parse_quote!(
                use std::panic;
            );
            let static_once: Item = parse_quote!(
                static AFTER_ALL: Once = Once::new();
            );
            let static_count: Item = parse_quote!(
                static REMAINING_TESTS: AtomicUsize = AtomicUsize::new(#count);
            );

            let mut once_content = vec![];

            if !has_once {
                once_content.push(use_once);
            }
            if !has_atomic_usize {
                once_content.push(use_atomic_usize);
            }
            if !has_ordering {
                once_content.push(use_ordering);
            }
            if !has_panic {
                once_content.push(use_panic);
            }
            once_content.append(&mut vec![static_once, static_count]);
            once_content.append(&mut e);

            m.content = Some((brace, once_content));
            Item::Mod(m)
        }
        _ => {
            panic!("The `after_all` macro attribute is only valid when called on a module.")
        }
    };
    TokenStream::from(quote! (#input))
}


/// Will run the code in the matching `after_all` function exactly once when all of the tests have
/// run. This works by counting the number of `#[test]` attributes and decrementing a counter at
/// the beginning of every test. Once the counter reaches 0, it will run the code in `after_all`.
/// It uses [std::sync::Once](https://doc.rust-lang.org/std/sync/struct.Once.html) internally
/// to ensure that the code is run at maximum one time.
///
/// ```
/// #[cfg(test)]
/// use test_env_helpers::*;
///
/// #[after_all]
/// #[cfg(test)]
/// mod my_tests{
///     fn after_all(){println!("I only get run once at the very end")}
///     #[test]
///     fn test_1(){}
///     #[test]
///     fn test_2(){}
///     #[test]
///     fn test_3(){}
/// }
/// ```
#[proc_macro_attribute]
pub fn after_all(_metadata: TokenStream, input: TokenStream) -> TokenStream {
    let input: Item = match parse_macro_input!(input as Item) {
        Item::Mod(mut m) => {
            let (brace, items) = m.content.unwrap();
            let (after_all_fn, everything_else): (Vec<Item>, Vec<Item>) =
                items.into_iter().partition(|t| match t {
                    Item::Fn(f) => f.sig.ident == "after_all",
                    _ => false,
                });
            let after_all_fn_block = if after_all_fn.len() != 1 {
                panic!("The `after_all` macro attribute requires a single function named `after_all` in the body of the module it is called on.")
            } else {
                match after_all_fn.into_iter().next().unwrap() {
                    Item::Fn(f) => f.block,
                    _ => unreachable!(),
                }
            };
            let after_all_if: Stmt = parse_quote! {
                if REMAINING_TESTS.fetch_sub(1, Ordering::SeqCst) == 1 {
                    AFTER_ALL.call_once(|| {
                        #after_all_fn_block
                    });
                }
            };
            let resume: Stmt = parse_quote! {
                if let Err(err) = result {
                    panic::resume_unwind(err);
                }
            };
            let mut count: usize = 0;
            let mut has_once: bool = false;
            let mut has_atomic_usize: bool = false;
            let mut has_ordering: bool = false;
            let mut has_panic: bool = false;

            let mut e: Vec<Item> = everything_else
                .into_iter()
                .map(|t| match t {
                    Item::Fn(mut f) => {
                        let test_count = f
                            .attrs
                            .iter()
                            .filter(|attr| {
                                attr.path
                                    .segments
                                    .iter()
                                    .any(|segment| segment.ident.to_string().contains("test"))
                            })
                            .count();
                        if test_count > 0 {
                            count += test_count;
                            let block = f.block.clone();
                            let catch_unwind: Stmt = parse_quote! {
                                let result = panic::catch_unwind(|| {
                                    #block
                                });
                            };
                            f.block.stmts = vec![catch_unwind, after_all_if.clone(), resume.clone()];
                            Item::Fn(f)
                        } else {
                            Item::Fn(f)
                        }
                    }
                    Item::Use(use_stmt) => {
                        if traverse_use_item(&use_stmt.tree, vec!["std", "sync", "Once"]).is_some()
                        {
                            has_once = true;
                        }
                        if traverse_use_item(
                            &use_stmt.tree,
                            vec!["std", "sync", "atomic", "AtomicUsize"],
                        )
                        .is_some()
                        {
                            has_atomic_usize = true;
                        }
                        if traverse_use_item(
                            &use_stmt.tree,
                            vec!["std", "sync", "atomic", "Ordering"],
                        )
                        .is_some()
                        {
                            has_ordering = true;
                        }
                        if traverse_use_item(
                            &use_stmt.tree,
                            vec!["std", "panic"],
                        )
                        .is_some() {
                            has_panic = true;
                        }
                        Item::Use(use_stmt)
                    }
                    el => el,
                })
                .collect();

            let use_once: Item = parse_quote!(
                use std::sync::Once;
            );
            let use_atomic_usize: Item = parse_quote!(
                use std::sync::atomic::AtomicUsize;
            );
            let use_ordering: Item = parse_quote!(
                use std::sync::atomic::Ordering;
            );
            let use_panic: Item = parse_quote!(
                use std::panic;
            );
            let static_once: Item = parse_quote!(
                static AFTER_ALL: Once = Once::new();
            );
            let static_count: Item = parse_quote!(
                static REMAINING_TESTS: AtomicUsize = AtomicUsize::new(#count);
            );

            let mut once_content = vec![];

            if !has_once {
                once_content.push(use_once);
            }
            if !has_atomic_usize {
                once_content.push(use_atomic_usize);
            }
            if !has_ordering {
                once_content.push(use_ordering);
            }
            if !has_panic {
                once_content.push(use_panic);
            }
            once_content.append(&mut vec![static_once, static_count]);
            once_content.append(&mut e);

            m.content = Some((brace, once_content));
            Item::Mod(m)
        }
        _ => {
            panic!("The `after_all` macro attribute is only valid when called on a module.")
        }
    };
    TokenStream::from(quote! (#input))
}

// /// Will run the code in the matching `after_all` function exactly once when all of the tests have
// /// run. This works by counting the number of `#[test]` attributes and decrementing a counter at
// /// the beginning of every test. Once the counter reaches 0, it will run the code in `after_all`.
// /// It uses [std::sync::Once](https://doc.rust-lang.org/std/sync/struct.Once.html) internally
// /// to ensure that the code is run at maximum one time.
// ///
// /// ```
// /// #[cfg(test)]
// /// use test_env_helpers::*;
// ///
// /// #[after_all]
// /// #[cfg(test)]
// /// mod my_tests{
// ///     fn after_all(){println!("I only get run once at the very end")}
// ///     #[test]
// ///     fn test_1(){}
// ///     #[test]
// ///     fn test_2(){}
// ///     #[test]
// ///     fn test_3(){}
// /// }
// /// ```
// #[proc_macro_attribute]
// pub fn after_all_async(_metadata: TokenStream, input: TokenStream) -> TokenStream {
//     let input: Item = match parse_macro_input!(input as Item) {
//         Item::Mod(mut m) => {
//             let (brace, items) = m.content.unwrap();
//             let (after_all_fn, everything_else): (Vec<Item>, Vec<Item>) =
//                 items.into_iter().partition(|t| match t {
//                     Item::Fn(f) => f.sig.ident == "after_all_async",
//                     _ => false,
//                 });
//             let after_all_fn_block = if after_all_fn.len() != 1 {
//                 panic!("The `after_all_async` macro attribute requires a single function named `after_all_async` in the body of the module it is called on.")
//             } else {
//                 match after_all_fn.into_iter().next().unwrap() {
//                     Item::Fn(f) => f.block,
//                     _ => unreachable!(),
//                 }
//             };
//             let after_all_if: Stmt = parse_quote! {
//                 if REMAINING_TESTS.fetch_sub(1, Ordering::SeqCst) == 1 {
//                     AFTER_ALL.call_once(|| {
//                         #after_all_fn_block
//                     });
//                 }
//             };
//             let resume: Stmt = parse_quote! {
//                 if let Err(err) = result {
//                     panic::resume_unwind(err);
//                 }
//             };
//             let mut count: usize = 0;
//             let mut has_once: bool = false;
//             let mut has_atomic_usize: bool = false;
//             let mut has_ordering: bool = false;
//             let mut has_panic: bool = false;
//             let mut has_future_ext: bool = false;

//             let mut e: Vec<Item> = everything_else
//                 .into_iter()
//                 .map(|t| match t {
//                     Item::Fn(mut f) => {
//                         let test_count = f
//                             .attrs
//                             .iter()
//                             .filter(|attr| {
//                                 attr.path
//                                     .segments
//                                     .iter()
//                                     .any(|segment| segment.ident.to_string().contains("test"))
//                             })
//                             .count();
//                         if test_count > 0 {
//                             count += test_count;
//                             let block = f.block.clone();
//                             let catch_unwind: Stmt = parse_quote! {
//                                 let run = async {
//                                     #block
//                                 };
//                                 let result = run.catch_unwind().await;
//                             };
//                             f.block.stmts = vec![catch_unwind, after_all_if.clone(), resume.clone()];
//                             Item::Fn(f)
//                         } else {
//                             Item::Fn(f)
//                         }
//                     }
//                     Item::Use(use_stmt) => {
//                         if traverse_use_item(&use_stmt.tree, vec!["std", "sync", "Once"]).is_some()
//                         {
//                             has_once = true;
//                         }
//                         if traverse_use_item(
//                             &use_stmt.tree,
//                             vec!["std", "sync", "atomic", "AtomicUsize"],
//                         )
//                         .is_some()
//                         {
//                             has_atomic_usize = true;
//                         }
//                         if traverse_use_item(
//                             &use_stmt.tree,
//                             vec!["std", "sync", "atomic", "Ordering"],
//                         )
//                         .is_some()
//                         {
//                             has_ordering = true;
//                         }
//                         if traverse_use_item(
//                             &use_stmt.tree,
//                             vec!["std", "panic"],
//                         )
//                         .is_some() {
//                             has_panic = true;
//                         }
//                         Item::Use(use_stmt)
//                     }
//                     el => el,
//                 })
//                 .collect();

//             let use_once: Item = parse_quote!(
//                 use std::sync::Once;
//             );
//             let use_atomic_usize: Item = parse_quote!(
//                 use std::sync::atomic::AtomicUsize;
//             );
//             let use_ordering: Item = parse_quote!(
//                 use std::sync::atomic::Ordering;
//             );
//             let use_panic: Item = parse_quote!(
//                 use std::panic;
//             );
//             let use_future_ext: Item = parse_quote!(
//                 use futures::FutureExt;
//             );
//             let static_once: Item = parse_quote!(
//                 static AFTER_ALL: Once = Once::new();
//             );
//             let static_count: Item = parse_quote!(
//                 static REMAINING_TESTS: AtomicUsize = AtomicUsize::new(#count);
//             );

//             let mut once_content = vec![];

//             if !has_once {
//                 once_content.push(use_once);
//             }
//             if !has_atomic_usize {
//                 once_content.push(use_atomic_usize);
//             }
//             if !has_ordering {
//                 once_content.push(use_ordering);
//             }
//             if !has_panic {
//                 once_content.push(use_panic);
//             }
//             if !has_future_ext {
//                 once_content.push(use_future_ext);
//             }
//             once_content.append(&mut vec![static_once, static_count]);
//             once_content.append(&mut e);

//             m.content = Some((brace, once_content));
//             Item::Mod(m)
//         }
//         _ => {
//             panic!("The `after_all_async` macro attribute is only valid when called on a module.")
//         }
//     };
//     TokenStream::from(quote! (#input))
// }

/// Will run the code in the matching `after_each` function at the end of every `#[test]` function.
/// Useful if you want to cleanup after a test or reset some external state. If the test panics,
/// this code will not be run. If you need something that is infallible, you should use
/// `before_each` instead.
/// ```
/// #[cfg(test)]
/// use test_env_helpers::*;
///
/// #[after_each]
/// #[cfg(test)]
/// mod my_tests{
///     fn after_each(){println!("I get run at the very end of each function")}
///     #[test]
///     fn test_1(){}
///     #[test]
///     fn test_2(){}
///     #[test]
///     fn test_3(){}
/// }
/// ```
#[proc_macro_attribute]
pub fn after_each(_metadata: TokenStream, input: TokenStream) -> TokenStream {
    let input: Item = match parse_macro_input!(input as Item) {
        Item::Mod(mut m) => {
            let (brace, items) = m.content.unwrap();
            let (after_each_fn, everything_else): (Vec<Item>, Vec<Item>) =
                items.into_iter().partition(|t| match t {
                    Item::Fn(f) => f.sig.ident == "after_each",
                    _ => false,
                });
            let after_each_fn_block = if after_each_fn.len() != 1 {
                panic!("The `after_each` macro attribute requires a single function named `after_each` in the body of the module it is called on.")
            } else {
                match after_each_fn.into_iter().next().unwrap() {
                    Item::Fn(f) => f.block,
                    _ => unreachable!(),
                }
            };

            let e: Vec<Item> = everything_else
                .into_iter()
                .map(|t| match t {
                    Item::Fn(mut f) => {
                        if f.attrs.iter().any(|attr| {
                            attr.path
                                .segments
                                .iter()
                                .any(|segment| segment.ident.to_string().contains("test"))
                        }) {
                            f.block.stmts.append(&mut after_each_fn_block.stmts.clone());
                            Item::Fn(f)
                        } else {
                            Item::Fn(f)
                        }
                    }
                    e => e,
                })
                .collect();
            m.content = Some((brace, e));
            Item::Mod(m)
        }

        _ => {
            panic!("The `after_each` macro attribute is only valid when called on a module.")
        }
    };
    TokenStream::from(quote! {#input})
}

/// Will run the code in the matching `before_all` function exactly once at the very beginning of a
/// test run. It uses [std::sync::Once](https://doc.rust-lang.org/std/sync/struct.Once.html) internally
/// to ensure that the code is run at maximum one time. Useful for setting up some external state
/// that will be reused in multiple tests.
/// ```
/// #[cfg(test)]
/// use test_env_helpers::*;
///
/// #[before_all]
/// #[cfg(test)]
/// mod my_tests{
///     fn before_all(){println!("I get run at the very beginning of the test suite")}
///     #[test]
///     fn test_1(){}
///     #[test]
///     fn test_2(){}
///     #[test]
///     fn test_3(){}
/// }
/// ```
#[proc_macro_attribute]
pub fn before_all(_metadata: TokenStream, input: TokenStream) -> TokenStream {
    let input: Item = match parse_macro_input!(input as Item) {
        Item::Mod(mut m) => {
            let (brace, items) = m.content.unwrap();
            let (before_all_fn, everything_else): (Vec<Item>, Vec<Item>) =
                items.into_iter().partition(|t| match t {
                    Item::Fn(f) => f.sig.ident == "before_all",
                    _ => false,
                });
            let before_all_fn_block = if before_all_fn.len() != 1 {
                panic!("The `before_all` macro attribute requires a single function named `before_all` in the body of the module it is called on.")
            } else {
                match before_all_fn.into_iter().next().unwrap() {
                    Item::Fn(f) => f.block,
                    _ => unreachable!(),
                }
            };
            let q: Stmt = parse_quote! {
                BEFORE_ALL.call_once(|| {
                    #before_all_fn_block
                });
            };

            let mut has_once: bool = false;
            let mut e: Vec<Item> = everything_else
                .into_iter()
                .map(|t| match t {
                    Item::Fn(mut f) => {
                        if f.attrs.iter().any(|attr| {
                            attr.path
                                .segments
                                .iter()
                                .any(|segment| segment.ident.to_string().contains("test"))
                        }) {
                            let mut stmts = vec![q.clone()];
                            stmts.append(&mut f.block.stmts);
                            f.block.stmts = stmts;
                            Item::Fn(f)
                        } else {
                            Item::Fn(f)
                        }
                    }
                    Item::Use(use_stmt) => {
                        if traverse_use_item(&use_stmt.tree, vec!["std", "sync", "Once"]).is_some()
                        {
                            has_once = true;
                        }
                        Item::Use(use_stmt)
                    }
                    e => e,
                })
                .collect();
            let use_once: Item = parse_quote!(
                use std::sync::Once;
            );
            let static_once: Item = parse_quote!(
                static BEFORE_ALL: Once = Once::new();
            );

            let mut once_content = vec![];
            if !has_once {
                once_content.push(use_once);
            }
            once_content.push(static_once);
            once_content.append(&mut e);

            m.content = Some((brace, once_content));
            Item::Mod(m)
        }

        _ => {
            panic!("The `before_all` macro attribute is only valid when called on a module.")
        }
    };
    TokenStream::from(quote! (#input))
}

/// Will run the code in the matching `before_each` function at the beginning of every test. Useful
/// to reset state to ensure that a test has a clean slate.
/// ```
/// #[cfg(test)]
/// use test_env_helpers::*;
///
/// #[before_each]
/// #[cfg(test)]
/// mod my_tests{
///     fn before_each(){println!("I get run at the very beginning of every test")}
///     #[test]
///     fn test_1(){}
///     #[test]
///     fn test_2(){}
///     #[test]
///     fn test_3(){}
/// }
/// ```
///
/// Can be used to reduce the amount of boilerplate setup code that needs to be copied into each test.
/// For example, if you need to ensure that tests in a single test suite are not run in parallel, this can
/// easily be done with a [Mutex](https://doc.rust-lang.org/std/sync/struct.Mutex.html).
/// However, remembering to copy and paste the code to acquire a lock on the `Mutex` in every test
/// is tedious and error prone.
/// ```
/// #[cfg(test)]
/// mod without_before_each{
///     lazy_static! {
///         static ref MTX: Mutex<()> = Mutex::new(());
///     }
///     #[test]
///     fn test_1(){let _m = MTX.lock();}
///     #[test]
///     fn test_2(){let _m = MTX.lock();}
///     #[test]
///     fn test_3(){let _m = MTX.lock();}
/// }
/// ```
/// Using `before_each` removes the need to copy and paste so much and makes making changes easier
/// because they only need to be made in a single location instead of once for every test.
/// ```
/// #[cfg(test)]
/// use test_env_helpers::*;
///
/// #[before_each]
/// #[cfg(test)]
/// mod with_before_each{
///     lazy_static! {
///         static ref MTX: Mutex<()> = Mutex::new(());
///     }
///     fn before_each(){let _m = MTX.lock();}
///     #[test]
///     fn test_1(){}
///     #[test]
///     fn test_2(){}
///     #[test]
///     fn test_3(){}
/// }
/// ```
#[proc_macro_attribute]
pub fn before_each(_metadata: TokenStream, input: TokenStream) -> TokenStream {
    let input: Item = match parse_macro_input!(input as Item) {
        Item::Mod(mut m) => {
            let (brace, items) = m.content.unwrap();
            let (before_each_fn, everything_else): (Vec<Item>, Vec<Item>) =
                items.into_iter().partition(|t| match t {
                    Item::Fn(f) => f.sig.ident == "before_each",
                    _ => false,
                });
            let before_each_fn_block = if before_each_fn.len() != 1 {
                panic!("The `before_each` macro attribute requires a single function named `before_each` in the body of the module it is called on.")
            } else {
                match before_each_fn.into_iter().next().unwrap() {
                    Item::Fn(f) => f.block,
                    _ => unreachable!(),
                }
            };

            let e: Vec<Item> = everything_else
                .into_iter()
                .map(|t| match t {
                    Item::Fn(mut f) => {
                        if f.attrs.iter().any(|attr| {
                            attr.path
                                .segments
                                .iter()
                                .any(|segment| segment.ident.to_string().contains("test"))
                        }) {
                            let mut b = before_each_fn_block.stmts.clone();
                            b.append(&mut f.block.stmts);
                            f.block.stmts = b;
                            Item::Fn(f)
                        } else {
                            Item::Fn(f)
                        }
                    }
                    e => e,
                })
                .collect();
            m.content = Some((brace, e));
            Item::Mod(m)
        }

        _ => {
            panic!("The `before_each` macro attribute is only valid when called on a module.")
        }
    };
    TokenStream::from(quote! {#input})
}

/// Will skip running the code it is applied on. You can use it to skip tests that aren't working
/// correctly or that you don't want to run for some reason. There are no checks to make sure it's
/// applied to a `#[test]` or mod. It will remove whatever it is applied to from the final AST.
///
/// ```
/// #[cfg(test)]
/// use test_env_helpers::*;
///
/// #[cfg(test)]
/// mod my_tests{
///     #[skip]
///     #[test]
///     fn broken_test(){panic!("I'm hella broke")}
///     #[skip]
///     mod broken_mod{
///         #[test]
///         fn i_will_not_be_run(){panic!("I get skipped too")}
///     }
///     #[test]
///     fn test_2(){}
///     #[test]
///     fn test_3(){}
/// }
/// ```
#[proc_macro_attribute]
pub fn skip(_metadata: TokenStream, _input: TokenStream) -> TokenStream {
    TokenStream::from(quote! {})
}