use std::path::PathBuf; use rustc_span::edition::DEFAULT_EDITION; use super::{DocTestBuilder, GlobalTestOptions}; fn make_test( test_code: &str, crate_name: Option<&str>, dont_insert_main: bool, opts: &GlobalTestOptions, test_id: Option<&str>, ) -> (String, usize) { let doctest = DocTestBuilder::new( test_code, crate_name, DEFAULT_EDITION, false, test_id.map(|s| s.to_string()), None, ); let (code, line_offset) = doctest.generate_unique_doctest(test_code, dont_insert_main, opts, crate_name); (code, line_offset) } /// Default [`GlobalTestOptions`] for these unit tests. fn default_global_opts(crate_name: impl Into) -> GlobalTestOptions { GlobalTestOptions { crate_name: crate_name.into(), no_crate_inject: false, insert_indent_space: false, attrs: vec![], args_file: PathBuf::new(), } } #[test] fn make_test_basic() { //basic use: wraps with `fn main`, adds `#![allow(unused)]` let opts = default_global_opts(""); let input = "assert_eq!(2+2, 4);"; let expected = "#![allow(unused)] fn main() { assert_eq!(2+2, 4); }" .to_string(); let (output, len) = make_test(input, None, false, &opts, None); assert_eq!((output, len), (expected, 2)); } #[test] fn make_test_crate_name_no_use() { // If you give a crate name but *don't* use it within the test, it won't bother inserting // the `extern crate` statement. let opts = default_global_opts("asdf"); let input = "assert_eq!(2+2, 4);"; let expected = "#![allow(unused)] fn main() { assert_eq!(2+2, 4); }" .to_string(); let (output, len) = make_test(input, Some("asdf"), false, &opts, None); assert_eq!((output, len), (expected, 2)); } #[test] fn make_test_crate_name() { // If you give a crate name and use it within the test, it will insert an `extern crate` // statement before `fn main`. let opts = default_global_opts("asdf"); let input = "use asdf::qwop; assert_eq!(2+2, 4);"; let expected = "#![allow(unused)] #[allow(unused_extern_crates)] extern crate r#asdf; fn main() { use asdf::qwop; assert_eq!(2+2, 4); }" .to_string(); let (output, len) = make_test(input, Some("asdf"), false, &opts, None); assert_eq!((output, len), (expected, 3)); } #[test] fn make_test_no_crate_inject() { // Even if you do use the crate within the test, setting `opts.no_crate_inject` will skip // adding it anyway. let opts = GlobalTestOptions { no_crate_inject: true, ..default_global_opts("asdf") }; let input = "use asdf::qwop; assert_eq!(2+2, 4);"; let expected = "#![allow(unused)] fn main() { use asdf::qwop; assert_eq!(2+2, 4); }" .to_string(); let (output, len) = make_test(input, Some("asdf"), false, &opts, None); assert_eq!((output, len), (expected, 2)); } #[test] fn make_test_ignore_std() { // Even if you include a crate name, and use it in the doctest, we still won't include an // `extern crate` statement if the crate is "std" -- that's included already by the // compiler! let opts = default_global_opts("std"); let input = "use std::*; assert_eq!(2+2, 4);"; let expected = "#![allow(unused)] fn main() { use std::*; assert_eq!(2+2, 4); }" .to_string(); let (output, len) = make_test(input, Some("std"), false, &opts, None); assert_eq!((output, len), (expected, 2)); } #[test] fn make_test_manual_extern_crate() { // When you manually include an `extern crate` statement in your doctest, `make_test` // assumes you've included one for your own crate too. let opts = default_global_opts("asdf"); let input = "extern crate asdf; use asdf::qwop; assert_eq!(2+2, 4);"; let expected = "#![allow(unused)] extern crate asdf; fn main() { use asdf::qwop; assert_eq!(2+2, 4); }" .to_string(); let (output, len) = make_test(input, Some("asdf"), false, &opts, None); assert_eq!((output, len), (expected, 2)); } #[test] fn make_test_manual_extern_crate_with_macro_use() { let opts = default_global_opts("asdf"); let input = "#[macro_use] extern crate asdf; use asdf::qwop; assert_eq!(2+2, 4);"; let expected = "#![allow(unused)] #[macro_use] extern crate asdf; fn main() { use asdf::qwop; assert_eq!(2+2, 4); }" .to_string(); let (output, len) = make_test(input, Some("asdf"), false, &opts, None); assert_eq!((output, len), (expected, 2)); } #[test] fn make_test_opts_attrs() { // If you supplied some doctest attributes with `#![doc(test(attr(...)))]`, it will use // those instead of the stock `#![allow(unused)]`. let mut opts = default_global_opts("asdf"); opts.attrs.push("feature(sick_rad)".to_string()); let input = "use asdf::qwop; assert_eq!(2+2, 4);"; let expected = "#![feature(sick_rad)] #[allow(unused_extern_crates)] extern crate r#asdf; fn main() { use asdf::qwop; assert_eq!(2+2, 4); }" .to_string(); let (output, len) = make_test(input, Some("asdf"), false, &opts, None); assert_eq!((output, len), (expected, 3)); // Adding more will also bump the returned line offset. opts.attrs.push("feature(hella_dope)".to_string()); let expected = "#![feature(sick_rad)] #![feature(hella_dope)] #[allow(unused_extern_crates)] extern crate r#asdf; fn main() { use asdf::qwop; assert_eq!(2+2, 4); }" .to_string(); let (output, len) = make_test(input, Some("asdf"), false, &opts, None); assert_eq!((output, len), (expected, 4)); } #[test] fn make_test_crate_attrs() { // Including inner attributes in your doctest will apply them to the whole "crate", pasting // them outside the generated main function. let opts = default_global_opts(""); let input = "#![feature(sick_rad)] assert_eq!(2+2, 4);"; let expected = "#![allow(unused)] #![feature(sick_rad)] fn main() { assert_eq!(2+2, 4); }" .to_string(); let (output, len) = make_test(input, None, false, &opts, None); assert_eq!((output, len), (expected, 2)); } #[test] fn make_test_with_main() { // Including your own `fn main` wrapper lets the test use it verbatim. let opts = default_global_opts(""); let input = "fn main() { assert_eq!(2+2, 4); }"; let expected = "#![allow(unused)] fn main() { assert_eq!(2+2, 4); }" .to_string(); let (output, len) = make_test(input, None, false, &opts, None); assert_eq!((output, len), (expected, 1)); } #[test] fn make_test_fake_main() { // ... but putting it in a comment will still provide a wrapper. let opts = default_global_opts(""); let input = "//Ceci n'est pas une `fn main` assert_eq!(2+2, 4);"; let expected = "#![allow(unused)] fn main() { //Ceci n'est pas une `fn main` assert_eq!(2+2, 4); }" .to_string(); let (output, len) = make_test(input, None, false, &opts, None); assert_eq!((output, len), (expected, 2)); } #[test] fn make_test_dont_insert_main() { // Even with that, if you set `dont_insert_main`, it won't create the `fn main` wrapper. let opts = default_global_opts(""); let input = "//Ceci n'est pas une `fn main` assert_eq!(2+2, 4);"; let expected = "#![allow(unused)] //Ceci n'est pas une `fn main` assert_eq!(2+2, 4);" .to_string(); let (output, len) = make_test(input, None, true, &opts, None); assert_eq!((output, len), (expected, 1)); } #[test] fn make_test_issues_21299() { let opts = default_global_opts(""); let input = "// fn main assert_eq!(2+2, 4);"; let expected = "#![allow(unused)] fn main() { // fn main assert_eq!(2+2, 4); }" .to_string(); let (output, len) = make_test(input, None, false, &opts, None); assert_eq!((output, len), (expected, 2)); } #[test] fn make_test_issues_33731() { let opts = default_global_opts("asdf"); let input = "extern crate hella_qwop; assert_eq!(asdf::foo, 4);"; let expected = "#![allow(unused)] extern crate hella_qwop; #[allow(unused_extern_crates)] extern crate r#asdf; fn main() { assert_eq!(asdf::foo, 4); }" .to_string(); let (output, len) = make_test(input, Some("asdf"), false, &opts, None); assert_eq!((output, len), (expected, 3)); } #[test] fn make_test_main_in_macro() { let opts = default_global_opts("my_crate"); let input = "#[macro_use] extern crate my_crate; test_wrapper! { fn main() {} }"; let expected = "#![allow(unused)] #[macro_use] extern crate my_crate; test_wrapper! { fn main() {} }" .to_string(); let (output, len) = make_test(input, Some("my_crate"), false, &opts, None); assert_eq!((output, len), (expected, 1)); } #[test] fn make_test_returns_result() { // creates an inner function and unwraps it let opts = default_global_opts(""); let input = "use std::io; let mut input = String::new(); io::stdin().read_line(&mut input)?; Ok::<(), io:Error>(())"; let expected = "#![allow(unused)] fn main() { fn _inner() -> core::result::Result<(), impl core::fmt::Debug> { use std::io; let mut input = String::new(); io::stdin().read_line(&mut input)?; Ok::<(), io:Error>(()) } _inner().unwrap() }" .to_string(); let (output, len) = make_test(input, None, false, &opts, None); assert_eq!((output, len), (expected, 2)); } #[test] fn make_test_named_wrapper() { // creates an inner function with a specific name let opts = default_global_opts(""); let input = "assert_eq!(2+2, 4);"; let expected = "#![allow(unused)] fn main() { #[allow(non_snake_case)] fn _doctest_main__some_unique_name() { assert_eq!(2+2, 4); } _doctest_main__some_unique_name() }" .to_string(); let (output, len) = make_test(input, None, false, &opts, Some("_some_unique_name")); assert_eq!((output, len), (expected, 2)); } #[test] fn make_test_insert_extra_space() { // will insert indent spaces in the code block if `insert_indent_space` is true let opts = GlobalTestOptions { insert_indent_space: true, ..default_global_opts("") }; let input = "use std::*; assert_eq!(2+2, 4); eprintln!(\"hello anan\"); "; let expected = "#![allow(unused)] fn main() { use std::*; assert_eq!(2+2, 4); eprintln!(\"hello anan\"); }" .to_string(); let (output, len) = make_test(input, None, false, &opts, None); assert_eq!((output, len), (expected, 2)); } #[test] fn make_test_insert_extra_space_fn_main() { // if input already has a fn main, it should insert a space before it let opts = GlobalTestOptions { insert_indent_space: true, ..default_global_opts("") }; let input = "use std::*; fn main() { assert_eq!(2+2, 4); eprintln!(\"hello anan\"); }"; let expected = "#![allow(unused)] use std::*; fn main() { assert_eq!(2+2, 4); eprintln!(\"hello anan\"); }" .to_string(); let (output, len) = make_test(input, None, false, &opts, None); assert_eq!((output, len), (expected, 1)); } #[test] fn check_split_args() { fn compare(input: &str, expected: &[&str]) { let output = super::split_args(input); let expected = expected.iter().map(|s| s.to_string()).collect::>(); assert_eq!(expected, output, "test failed for {input:?}"); } compare("'a' \"b\"c", &["a", "bc"]); compare("'a' \"b \"c d", &["a", "b c", "d"]); compare("'a' \"b\\\"c\"", &["a", "b\"c"]); compare("'a\"'", &["a\""]); compare("\"a'\"", &["a'"]); compare("\\ a", &[" a"]); compare("\\\\", &["\\"]); compare("a'", &["a"]); compare("a ", &["a"]); compare("a b", &["a", "b"]); compare("a\n\t \rb", &["a", "b"]); compare("a\n\t1 \rb", &["a", "1", "b"]); } #[test] fn comment_in_attrs() { // if input already has a fn main, it should insert a space before it let opts = default_global_opts(""); let input = "\ #![feature(rustdoc_internals)] #![allow(internal_features)] #![doc(rust_logo)] //! This crate has the Rust(tm) branding on it."; let expected = "\ #![allow(unused)] #![feature(rustdoc_internals)] #![allow(internal_features)] #![doc(rust_logo)] //! This crate has the Rust(tm) branding on it. fn main() { }" .to_string(); let (output, len) = make_test(input, None, false, &opts, None); assert_eq!((output, len), (expected, 2)); }