extern crate bumpalo; extern crate roc_collections; extern crate roc_load; extern crate roc_module; extern crate tempfile; use roc_utils::cargo; use roc_utils::pretty_command_string; use roc_utils::root_dir; use serde::Deserialize; use serde_xml_rs::from_str; use std::env; use std::ffi::{OsStr, OsString}; use std::io::Read; use std::io::Write; use std::path::Path; use std::path::PathBuf; use std::process::{Command, ExitStatus, Stdio}; use tempfile::NamedTempFile; #[derive(Debug)] pub struct Out { pub cmd_str: OsString, // command with all its arguments, for easy debugging pub stdout: String, pub stderr: String, pub status: ExitStatus, } pub fn run_roc(args: I, stdin_vals: &[&str], extra_env: &[(&str, &str)]) -> Out where I: IntoIterator, S: AsRef, { let roc_binary_path = build_roc_bin_cached(); run_roc_with_stdin_and_env(&roc_binary_path, args, stdin_vals, extra_env) } // If we don't already have a /target/release/roc, build it! pub fn build_roc_bin_cached() -> PathBuf { let roc_binary_path = path_to_roc_binary(); if !roc_binary_path.exists() { // Remove the /target/release/roc part let root_project_dir = roc_binary_path .parent() .unwrap() .parent() .unwrap() .parent() .unwrap(); // cargo build --bin roc // (with --release iff the test is being built with --release) let args = if cfg!(debug_assertions) { vec!["build", "--bin", "roc"] } else { vec!["build", "--release", "--bin", "roc"] }; let mut cargo_cmd = cargo(); cargo_cmd.current_dir(root_project_dir).args(&args); let cargo_cmd_str = format!("{:?}", cargo_cmd); let cargo_output = cargo_cmd.output().unwrap(); if !cargo_output.status.success() { panic!( "The following cargo command failed:\n\n {}\n\n stdout was:\n\n {}\n\n stderr was:\n\n {}\n", cargo_cmd_str, String::from_utf8(cargo_output.stdout).unwrap(), String::from_utf8(cargo_output.stderr).unwrap() ); } } roc_binary_path } pub fn run_glue(args: I) -> Out where I: IntoIterator, S: AsRef, { run_roc_with_stdin(&path_to_roc_binary(), args, &[]) } pub fn path_to_roc_binary() -> PathBuf { path_to_binary(if cfg!(windows) { "roc.exe" } else { "roc" }) } pub fn path_to_binary(binary_name: &str) -> PathBuf { // Adapted from https://github.com/volta-cli/volta/blob/cefdf7436a15af3ce3a38b8fe53bb0cfdb37d3dd/tests/acceptance/support/sandbox.rs#L680 // by the Volta Contributors - license information can be found in // the LEGAL_DETAILS file in the root directory of this distribution. // // Thank you, Volta contributors! let mut path = env::var_os("CARGO_BIN_PATH") .map(PathBuf::from) .or_else(|| { env::current_exe().ok().map(|mut path| { path.pop(); if path.ends_with("deps") { path.pop(); } path }) }) .unwrap_or_else(|| panic!("CARGO_BIN_PATH wasn't set, and couldn't be inferred from context. Can't run CLI tests.")); path.push(binary_name); path } pub fn strip_colors(str: &str) -> String { use roc_reporting::report::ANSI_STYLE_CODES; str.replace(ANSI_STYLE_CODES.red, "") .replace(ANSI_STYLE_CODES.green, "") .replace(ANSI_STYLE_CODES.yellow, "") .replace(ANSI_STYLE_CODES.blue, "") .replace(ANSI_STYLE_CODES.magenta, "") .replace(ANSI_STYLE_CODES.cyan, "") .replace(ANSI_STYLE_CODES.white, "") .replace(ANSI_STYLE_CODES.bold, "") .replace(ANSI_STYLE_CODES.underline, "") .replace(ANSI_STYLE_CODES.reset, "") .replace(ANSI_STYLE_CODES.color_reset, "") } pub fn run_roc_with_stdin(path: &Path, args: I, stdin_vals: &[&str]) -> Out where I: IntoIterator, S: AsRef, { run_roc_with_stdin_and_env(path, args, stdin_vals, &[]) } pub fn run_roc_with_stdin_and_env( roc_path: &Path, args: I, stdin_vals: &[&str], extra_env: &[(&str, &str)], ) -> Out where I: IntoIterator, S: AsRef, { let mut roc_cmd = Command::new(roc_path); for arg in args { roc_cmd.arg(arg); } for (k, v) in extra_env { roc_cmd.env(k, v); } let roc_cmd_str = pretty_command_string(&roc_cmd); let mut roc_cmd_child = roc_cmd .stdin(Stdio::piped()) .stdout(Stdio::piped()) .stderr(Stdio::piped()) .spawn() .unwrap_or_else(|err| { panic!("Failed to execute command\n\n {roc_cmd_str:?}\n\nwith error:\n\n {err}",) }); { let stdin = roc_cmd_child.stdin.as_mut().expect("Failed to open stdin"); for stdin_str in stdin_vals.iter() { stdin .write_all(stdin_str.as_bytes()) .unwrap_or_else(|err| { panic!( "Failed to write to stdin for command\n\n {roc_cmd_str:?}\n\nwith error:\n\n {err}", ) }); } } let roc_cmd_output = roc_cmd_child.wait_with_output().unwrap_or_else(|err| { panic!("Failed to get output for command\n\n {roc_cmd_str:?}\n\nwith error:\n\n {err}",) }); Out { cmd_str: roc_cmd_str, stdout: String::from_utf8(roc_cmd_output.stdout).unwrap(), stderr: String::from_utf8(roc_cmd_output.stderr).unwrap(), status: roc_cmd_output.status, } } pub fn run_cmd<'a, I: IntoIterator, E: IntoIterator>( cmd_name: &str, stdin_vals: I, args: &[String], env: E, ) -> Out { let mut cmd = Command::new(cmd_name); for arg in args { cmd.arg(arg); } for (env, val) in env.into_iter() { cmd.env(env, val); } let cmd_str = pretty_command_string(&cmd); let mut child = cmd .stdin(Stdio::piped()) .stdout(Stdio::piped()) .stderr(Stdio::piped()) .spawn() .unwrap_or_else(|_| panic!("failed to execute cmd `{}` in CLI test", cmd_name)); { let stdin = child.stdin.as_mut().expect("Failed to open stdin"); for stdin_str in stdin_vals { stdin .write_all(stdin_str.as_bytes()) .expect("Failed to write to stdin"); } } let output = child .wait_with_output() .unwrap_or_else(|_| panic!("failed to execute cmd `{}` in CLI test", cmd_name)); Out { cmd_str, stdout: String::from_utf8(output.stdout).unwrap(), stderr: String::from_utf8(output.stderr).unwrap(), status: output.status, } } pub fn run_with_valgrind<'a, I: IntoIterator>( stdin_vals: I, args: &[String], ) -> (Out, String) { //TODO: figure out if there is a better way to get the valgrind executable. let mut cmd = Command::new("valgrind"); let named_tempfile = NamedTempFile::new().expect("Unable to create tempfile for valgrind results"); let filepath = named_tempfile.path().to_str().unwrap(); cmd.arg("--tool=memcheck"); cmd.arg("--xml=yes"); // If you are having valgrind issues on MacOS, you may need to suppress some // of the errors. Read more here: https://github.com/roc-lang/roc/issues/746 if let Some(suppressions_file_os_str) = env::var_os("VALGRIND_SUPPRESSIONS") { match suppressions_file_os_str.to_str() { None => { panic!("Could not determine suppression file location from OsStr"); } Some(suppressions_file) => { let mut buf = String::new(); buf.push_str("--suppressions="); buf.push_str(suppressions_file); cmd.arg(buf); } } } cmd.arg(format!("--xml-file={}", filepath)); for arg in args { cmd.arg(arg); } let cmd_str = pretty_command_string(&cmd); cmd.stdin(Stdio::piped()); cmd.stdout(Stdio::piped()); cmd.stderr(Stdio::piped()); let mut child = cmd .spawn() .expect("failed to execute compiled `valgrind` binary in CLI test"); { let stdin = child.stdin.as_mut().expect("Failed to open stdin"); for stdin_str in stdin_vals { stdin .write_all(stdin_str.as_bytes()) .expect("Failed to write to stdin"); } } let output = child .wait_with_output() .expect("failed to execute compiled `valgrind` binary in CLI test"); let mut file = named_tempfile.into_file(); let mut raw_xml = String::new(); file.read_to_string(&mut raw_xml).unwrap(); ( Out { cmd_str, stdout: String::from_utf8(output.stdout).unwrap(), stderr: String::from_utf8(output.stderr).unwrap(), status: output.status, }, raw_xml, ) } #[derive(Debug, Deserialize)] struct ValgrindOutput { #[serde(rename = "$value")] pub fields: Vec, } #[derive(Deserialize, Debug)] #[serde(rename_all = "lowercase")] enum ValgrindField { ProtocolVersion(isize), ProtocolTool(String), Preamble(ValgrindDummyStruct), Pid(isize), PPid(isize), Tool(String), Args(ValgrindDummyStruct), Error(ValgrindError), Status(ValgrindDummyStruct), Stack(ValgrindDummyStruct), #[serde(rename = "fatal_signal")] FatalSignal(ValgrindDummyStruct), ErrorCounts(ValgrindDummyStruct), SuppCounts(ValgrindDummyStruct), } #[derive(Debug, Deserialize)] struct ValgrindDummyStruct {} #[derive(Debug, Deserialize, Clone)] pub struct ValgrindError { pub kind: String, #[serde(default)] pub what: Option, #[serde(default)] pub xwhat: Option, } #[derive(Debug, Deserialize, Clone)] pub struct ValgrindErrorXWhat { pub text: String, #[serde(default)] pub leakedbytes: Option, #[serde(default)] pub leakedblocks: Option, } #[allow(dead_code)] pub fn extract_valgrind_errors(xml: &str) -> Result, serde_xml_rs::Error> { let parsed_xml: ValgrindOutput = from_str(xml)?; let answer = parsed_xml .fields .iter() .filter_map(|field| match field { ValgrindField::Error(err) => Some(err.clone()), _ => None, }) .collect(); Ok(answer) } // start the dir with crates/cli_testing_examples #[allow(dead_code)] pub fn cli_testing_dir(dir_name: &str) -> PathBuf { let mut path = root_dir(); // Descend into examples/{dir_name} path.push("crates"); path.push("cli_testing_examples"); path.extend(dir_name.split("/")); // Make slashes cross-target path } #[allow(dead_code)] pub fn dir_path_from_root(dir_name: &str) -> PathBuf { let mut path = root_dir(); path.extend(dir_name.split("/")); // Make slashes cross-target path } #[allow(dead_code)] pub fn file_path_from_root(dir_name: &str, file_name: &str) -> PathBuf { let mut path = dir_path_from_root(dir_name); path.push(file_name); path } #[allow(dead_code)] pub fn fixtures_dir(dir_name: &str) -> PathBuf { let mut path = root_dir(); // Descend into crates/cli/tests/fixtures/{dir_name} path.push("crates"); path.push("cli"); path.push("tests"); path.push("fixtures"); path.extend(dir_name.split("/")); // Make slashes cross-target path } #[allow(dead_code)] pub fn fixture_file(dir_name: &str, file_name: &str) -> PathBuf { let mut path = fixtures_dir(dir_name); path.push(file_name); path } #[allow(dead_code)] pub fn known_bad_file(file_name: &str) -> PathBuf { let mut path = root_dir(); // Descend into cli/tests/known_bad/{file_name} path.push("crates"); path.push("cli"); path.push("tests"); path.push("known_bad"); path.push(file_name); path }