lib.rs

#![doc = include_str!("../README.md")]

pub use parameterized_macro::parameterized;

/// Attribute macro's such as 'parameterized' do not enable the run tests intent for a module
/// marked as cfg(test) (or a #[test] function for that matter) in Intellij.
///
/// To enable the intent within a module, we need at least a single test marked with `#[test]`.
/// The `ide!()` macro is a work around for this issue and creates this empty test. It can be called
/// within every module where we wish to run test cases using the run configuration / run test context
/// menu.
///
/// Using the intellij-rust new macro expansion engine, if this macro is called within a module,
/// the module will be marked as test, and the 'run as test' context menu will be provided in the
/// gutter.
#[macro_export]
macro_rules! ide {
    () => {
        #[test]
        fn __mark_with_test_intent() {}
    };
}

#[cfg(test)]
mod tests {
    use crate::ide;
    use crate::parameterized;

    fn add5<T: Into<u32>>(component: T) -> u32 {
        component.into() + 5
    }

    mod readme_test {
        use super::*;

        ide!();

        #[parameterized(input = {
            0, 1, 2
        }, expected = {
            5, 6, 7
        })]
        fn test_add5(input: u16, expected: u32) {
            assert_eq!(add5(input), expected)
        }
    }

    mod marked_as_test_module {
        use super::*;

        ide!();

        #[parameterized(input = { 2, 3, 4 }, output = { 4, 6, 8 })]
        fn test_times2(input: i32, output: i32) {
            let times2 = |receiver: i32| receiver * 2;

            assert_eq!(times2(input), output);
        }
    }

    mod transitive_attrs {
        use super::*;

        ide!();

        #[parameterized(input = { None, None, None })]
        #[should_panic]
        fn numbers(input: Option<()>) {
            input.unwrap()
        }
    }

    mod fn_signatures {
        use super::*;

        ide!();

        #[parameterized(_input = { 0, 1, 2 })]
        const fn constness(_input: u8) {
            assert!(true)
        }

        #[parameterized(input = { true, true, true })]
        #[parameterized_macro(tokio::test)]
        async fn asyncness(input: bool) {
            assert!(input)
        }

        #[parameterized(_input = { 0, 1, 2 })]
        const fn return_type(_input: u8) -> () {
            assert!(true)
        }
    }

    mod custom_test_attribute {
        use super::*;

        ide!();

        #[parameterized(input = { true, true, true })]
        #[parameterized_macro(tokio::test)]
        async fn tokio_simple_meta(input: bool) {
            assert!(input)
        }

        #[parameterized(input = { true, true, true })]
        #[parameterized_macro(tokio::test(flavor = "multi_thread", worker_threads = 1))]
        async fn tokio_complex_meta(input: bool) {
            assert!(input)
        }
    }
}