mirror of
https://github.com/nushell/nushell
synced 2024-12-29 06:23:11 +00:00
b2e191f836
# Description With the current typechecking logic this property has no effect. It was only used in the example testing, and provided some indication of this vectorizing property. With #9742 all commands that previously declared it have explicit list signatures. If we want to get it back in the future we can reconstruct it from the signature. Simplifies the example testing a bit. # User-Facing Changes Causes a breaking change for plugins that previously declared it. While this causes a compile fail, this was already broken by our more stringent type checking. This will be a good reminder for plugin authors to update their signature as well to reflect the more stringent type checking.
112 lines
4.4 KiB
Rust
112 lines
4.4 KiB
Rust
#[cfg(test)]
|
|
use nu_protocol::engine::Command;
|
|
|
|
#[cfg(test)]
|
|
pub fn test_examples(cmd: impl Command + 'static) {
|
|
test_examples::test_examples(cmd);
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test_examples {
|
|
use super::super::{
|
|
Ansi, Date, Enumerate, Flatten, From, Get, Into, IntoString, Math, MathRound, ParEach,
|
|
Path, PathParse, Random, Sort, SortBy, Split, SplitColumn, SplitRow, Str, StrJoin,
|
|
StrLength, StrReplace, Update, Url, Values, Wrap,
|
|
};
|
|
use crate::{Each, To};
|
|
use nu_cmd_lang::example_support::{
|
|
check_all_signature_input_output_types_entries_have_examples,
|
|
check_example_evaluates_to_expected_output,
|
|
check_example_input_and_output_types_match_command_signature,
|
|
};
|
|
use nu_cmd_lang::{Break, Echo, If, Let, Mut};
|
|
use nu_protocol::{
|
|
engine::{Command, EngineState, StateWorkingSet},
|
|
Type,
|
|
};
|
|
use std::collections::HashSet;
|
|
|
|
pub fn test_examples(cmd: impl Command + 'static) {
|
|
let examples = cmd.examples();
|
|
let signature = cmd.signature();
|
|
let mut engine_state = make_engine_state(cmd.clone_box());
|
|
|
|
let cwd = std::env::current_dir().expect("Could not get current working directory.");
|
|
|
|
let mut witnessed_type_transformations = HashSet::<(Type, Type)>::new();
|
|
|
|
for example in examples {
|
|
if example.result.is_none() {
|
|
continue;
|
|
}
|
|
witnessed_type_transformations.extend(
|
|
check_example_input_and_output_types_match_command_signature(
|
|
&example,
|
|
&cwd,
|
|
&mut make_engine_state(cmd.clone_box()),
|
|
&signature.input_output_types,
|
|
signature.operates_on_cell_paths(),
|
|
),
|
|
);
|
|
check_example_evaluates_to_expected_output(&example, cwd.as_path(), &mut engine_state);
|
|
}
|
|
|
|
check_all_signature_input_output_types_entries_have_examples(
|
|
signature,
|
|
witnessed_type_transformations,
|
|
);
|
|
}
|
|
|
|
fn make_engine_state(cmd: Box<dyn Command>) -> Box<EngineState> {
|
|
let mut engine_state = Box::new(EngineState::new());
|
|
|
|
let delta = {
|
|
// Base functions that are needed for testing
|
|
// Try to keep this working set small to keep tests running as fast as possible
|
|
let mut working_set = StateWorkingSet::new(&engine_state);
|
|
working_set.add_decl(Box::new(Ansi));
|
|
working_set.add_decl(Box::new(Break));
|
|
working_set.add_decl(Box::new(Date));
|
|
working_set.add_decl(Box::new(Each));
|
|
working_set.add_decl(Box::new(Echo));
|
|
working_set.add_decl(Box::new(Enumerate));
|
|
working_set.add_decl(Box::new(Flatten));
|
|
working_set.add_decl(Box::new(From));
|
|
working_set.add_decl(Box::new(Get));
|
|
working_set.add_decl(Box::new(If));
|
|
working_set.add_decl(Box::new(Into));
|
|
working_set.add_decl(Box::new(IntoString));
|
|
working_set.add_decl(Box::new(Let));
|
|
working_set.add_decl(Box::new(Math));
|
|
working_set.add_decl(Box::new(MathRound));
|
|
working_set.add_decl(Box::new(Mut));
|
|
working_set.add_decl(Box::new(Path));
|
|
working_set.add_decl(Box::new(PathParse));
|
|
working_set.add_decl(Box::new(ParEach));
|
|
working_set.add_decl(Box::new(Random));
|
|
working_set.add_decl(Box::new(Sort));
|
|
working_set.add_decl(Box::new(SortBy));
|
|
working_set.add_decl(Box::new(Split));
|
|
working_set.add_decl(Box::new(SplitColumn));
|
|
working_set.add_decl(Box::new(SplitRow));
|
|
working_set.add_decl(Box::new(Str));
|
|
working_set.add_decl(Box::new(StrJoin));
|
|
working_set.add_decl(Box::new(StrLength));
|
|
working_set.add_decl(Box::new(StrReplace));
|
|
working_set.add_decl(Box::new(To));
|
|
working_set.add_decl(Box::new(Url));
|
|
working_set.add_decl(Box::new(Update));
|
|
working_set.add_decl(Box::new(Values));
|
|
working_set.add_decl(Box::new(Wrap));
|
|
// Adding the command that is being tested to the working set
|
|
working_set.add_decl(cmd);
|
|
|
|
working_set.render()
|
|
};
|
|
|
|
engine_state
|
|
.merge_delta(delta)
|
|
.expect("Error merging delta");
|
|
engine_state
|
|
}
|
|
}
|