nu-test-support 0.113.0

Support for writing Nushell tests
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

use std::{any::Any, fmt::Debug, num::NonZeroUsize, sync::atomic::Ordering, thread::Scope};

use kitest::{
    Whatever,
    capture::DefaultPanicHookProvider,
    outcome::TestOutcome,
    runner::{DefaultRunner, SimpleRunner, scope::NoScopeFactory},
    test::{TestMeta, TestResult},
};
use nu_experimental::ExperimentalOption;
use nu_utils::downcast;

use crate::{harness::group::RUN_TEST_GROUP_IN_SERIAL, tester::TestError};

#[derive(Debug)]
pub struct Extra {
    pub run_in_serial: bool,
    pub experimental_options: &'static [(&'static ExperimentalOption, bool)],
    pub environment_variables: &'static [(&'static str, &'static str)],
}

#[derive(Debug, Default)]
pub struct TestRunner {
    parallel: DefaultRunner<DefaultPanicHookProvider, NoScopeFactory>,
    serial: SimpleRunner<DefaultPanicHookProvider, NoScopeFactory>,
    exact: bool,
}

impl TestRunner {
    pub fn with_thread_count(self, thread_count: NonZeroUsize) -> Self {
        Self {
            parallel: self.parallel.with_thread_count(thread_count),
            ..self
        }
    }

    pub fn with_exact(self, exact: bool) -> Self {
        Self { exact, ..self }
    }
}

enum NuTestRunnerIterator<IP, IS> {
    Parallel(IP),
    Serial(IS),
}

impl<'t, IP, IS> Iterator for NuTestRunnerIterator<IP, IS>
where
    IP: Iterator<Item = (&'t TestMeta<Extra>, TestOutcome)>,
    IS: Iterator<Item = (&'t TestMeta<Extra>, TestOutcome)>,
    Extra: 't,
{
    type Item = (&'t TestMeta<Extra>, TestOutcome);

    fn next(&mut self) -> Option<Self::Item> {
        match self {
            Self::Parallel(iter) => iter.next(),
            Self::Serial(iter) => iter.next(),
        }
    }
}

impl<'t> kitest::runner::TestRunner<'t, Extra> for TestRunner {
    fn run<'s, I, F>(
        &self,
        tests: I,
        scope: &'s Scope<'s, 't>,
    ) -> impl Iterator<Item = (&'t TestMeta<Extra>, kitest::outcome::TestOutcome)>
    where
        I: ExactSizeIterator<Item = (F, &'t TestMeta<Extra>)>,
        F: (Fn() -> kitest::outcome::TestStatus) + Send + 's,
        Extra: 't,
    {
        match self.exact || RUN_TEST_GROUP_IN_SERIAL.load(Ordering::Relaxed) {
            false => NuTestRunnerIterator::Parallel(
                <DefaultRunner<_, _> as kitest::runner::TestRunner<Extra>>::run(
                    &self.parallel,
                    tests,
                    scope,
                ),
            ),
            true => {
                NuTestRunnerIterator::Serial(<SimpleRunner<_, _> as kitest::runner::TestRunner<
                    Extra,
                >>::run(&self.serial, tests, scope))
            }
        }
    }

    fn worker_count(&self, tests_count: usize) -> NonZeroUsize {
        match RUN_TEST_GROUP_IN_SERIAL.load(Ordering::Relaxed) {
            true => const { NonZeroUsize::new(1).unwrap() },
            false => <DefaultRunner<_, _> as kitest::runner::TestRunner<Extra>>::worker_count(
                &self.parallel,
                tests_count,
            ),
        }
    }
}

pub trait IntoTestResult {
    fn into_test_result(self) -> TestResult;
}

impl IntoTestResult for () {
    fn into_test_result(self) -> TestResult {
        self.into()
    }
}

impl<E: Debug + Any> IntoTestResult for Result<(), E> {
    fn into_test_result(self) -> TestResult {
        let Err(err) = self else {
            return TestResult(Ok(None));
        };

        match downcast::<E, TestError>(err) {
            Ok(test_error) => TestResult(Err(Whatever::from(test_error))),
            Err(err) => Err(err).into(),
        }
    }
}