//! The tests in this file check the soundness of plugin persistence. When a plugin is needed by Nu, //! it is spawned only if it was not already running. Plugins that are spawned are kept running and //! are referenced in the engine state. Plugins can be stopped by the user if desired, but not //! removed. use nu_test_support::{nu, nu_with_plugins}; #[test] fn plugin_list_shows_installed_plugins() { let out = nu_with_plugins!( cwd: ".", plugins: [("nu_plugin_inc"), ("nu_plugin_custom_values")], r#"(plugin list).name | str join ','"# ); assert_eq!("custom_values,inc", out.out); assert!(out.status.success()); } #[test] fn plugin_list_shows_installed_plugin_version() { let out = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_inc"), r#"(plugin list).version.0"# ); assert_eq!(env!("CARGO_PKG_VERSION"), out.out); assert!(out.status.success()); } #[test] fn plugin_keeps_running_after_calling_it() { let out = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_inc"), r#" plugin stop inc (plugin list).0.status == running | print print ";" "2.0.0" | inc -m | ignore (plugin list).0.status == running | print "# ); assert_eq!( "false;true", out.out, "plugin list didn't show status = running" ); assert!(out.status.success()); } #[test] fn plugin_process_exits_after_stop() { let out = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_inc"), r#" "2.0.0" | inc -m | ignore sleep 500ms let pid = (plugin list).0.pid if (ps | where pid == $pid | is-empty) { error make { msg: "plugin process not running initially" } } plugin stop inc let start = (date now) mut cond = true while $cond { sleep 100ms $cond = ( (ps | where pid == $pid | is-not-empty) and ((date now) - $start) < 5sec ) } ((date now) - $start) | into int "# ); assert!(out.status.success()); let nanos = out.out.parse::().expect("not a number"); assert!( nanos < 5_000_000_000, "not stopped after more than 5 seconds: {nanos} ns" ); } #[test] fn plugin_stop_can_find_by_filename() { let result = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_inc"), r#"plugin stop (plugin list | where name == inc).0.filename"# ); assert!(result.status.success()); assert!(result.err.is_empty()); } #[test] fn plugin_process_exits_when_nushell_exits() { let out = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_inc"), r#" "2.0.0" | inc -m | ignore (plugin list).0.pid | print "# ); assert!(!out.out.is_empty()); assert!(out.status.success()); let pid = out.out.parse::().expect("failed to parse pid"); // use nu to check if process exists assert_eq!( "0", nu!(format!("sleep 500ms; ps | where pid == {pid} | length")).out, "plugin process {pid} is still running" ); } #[test] fn plugin_commands_run_without_error() { let out = nu_with_plugins!( cwd: ".", plugins: [ ("nu_plugin_inc"), ("nu_plugin_example"), ("nu_plugin_custom_values"), ], r#" "2.0.0" | inc -m | ignore example seq 1 10 | ignore custom-value generate | ignore "# ); assert!(out.err.is_empty()); assert!(out.status.success()); } #[test] fn plugin_commands_run_multiple_times_without_error() { let out = nu_with_plugins!( cwd: ".", plugins: [ ("nu_plugin_inc"), ("nu_plugin_example"), ("nu_plugin_custom_values"), ], r#" ["2.0.0" "2.1.0" "2.2.0"] | each { inc -m } | print example seq 1 10 | ignore custom-value generate | ignore example seq 1 20 | ignore custom-value generate2 | ignore "# ); assert!(out.err.is_empty()); assert!(out.status.success()); } #[test] fn multiple_plugin_commands_run_with_the_same_plugin_pid() { let out = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_custom_values"), r#" custom-value generate | ignore (plugin list).0.pid | print print ";" custom-value generate2 | ignore (plugin list).0.pid | print "# ); assert!(out.status.success()); let pids: Vec<&str> = out.out.split(';').collect(); assert_eq!(2, pids.len()); assert_eq!(pids[0], pids[1]); } #[test] fn plugin_pid_changes_after_stop_then_run_again() { let out = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_custom_values"), r#" custom-value generate | ignore (plugin list).0.pid | print print ";" plugin stop custom_values custom-value generate2 | ignore (plugin list).0.pid | print "# ); assert!(out.status.success()); let pids: Vec<&str> = out.out.split(';').collect(); assert_eq!(2, pids.len()); assert_ne!(pids[0], pids[1]); } #[test] fn custom_values_can_still_be_passed_to_plugin_after_stop() { let out = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_custom_values"), r#" let cv = custom-value generate plugin stop custom_values $cv | custom-value update "# ); assert!(!out.out.is_empty()); assert!(out.err.is_empty()); assert!(out.status.success()); } #[test] fn custom_values_can_still_be_collapsed_after_stop() { // print causes a collapse (ToBaseValue) call. let out = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_custom_values"), r#" let cv = custom-value generate plugin stop custom_values $cv | print "# ); assert!(!out.out.is_empty()); assert!(out.err.is_empty()); assert!(out.status.success()); } #[test] fn plugin_gc_can_be_configured_to_stop_plugins_immediately() { // I know the test is to stop "immediately", but if we actually check immediately it could // lead to a race condition. Using 100ms sleep just because with contention we don't really // know for sure how long this could take let out = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_inc"), r#" $env.config.plugin_gc = { default: { stop_after: 0sec } } "2.3.0" | inc -M sleep 100ms (plugin list | where name == inc).0.status == running "# ); assert!(out.status.success()); assert_eq!("false", out.out, "with config as default"); let out = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_inc"), r#" $env.config.plugin_gc = { plugins: { inc: { stop_after: 0sec } } } "2.3.0" | inc -M sleep 100ms (plugin list | where name == inc).0.status == running "# ); assert!(out.status.success()); assert_eq!("false", out.out, "with inc-specific config"); } #[test] fn plugin_gc_can_be_configured_to_stop_plugins_after_delay() { let out = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_inc"), r#" $env.config.plugin_gc = { default: { stop_after: 50ms } } "2.3.0" | inc -M let start = (date now) mut cond = true while $cond { sleep 100ms $cond = ( (plugin list | where name == inc).0.status == running and ((date now) - $start) < 5sec ) } ((date now) - $start) | into int "# ); assert!(out.status.success()); let nanos = out.out.parse::().expect("not a number"); assert!( nanos < 5_000_000_000, "with config as default: more than 5 seconds: {nanos} ns" ); let out = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_inc"), r#" $env.config.plugin_gc = { plugins: { inc: { stop_after: 50ms } } } "2.3.0" | inc -M let start = (date now) mut cond = true while $cond { sleep 100ms $cond = ( (plugin list | where name == inc).0.status == running and ((date now) - $start) < 5sec ) } ((date now) - $start) | into int "# ); assert!(out.status.success()); let nanos = out.out.parse::().expect("not a number"); assert!( nanos < 5_000_000_000, "with inc-specific config: more than 5 seconds: {nanos} ns" ); } #[test] fn plugin_gc_can_be_configured_as_disabled() { let out = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_inc"), r#" $env.config.plugin_gc = { default: { enabled: false, stop_after: 0sec } } "2.3.0" | inc -M (plugin list | where name == inc).0.status == running "# ); assert!(out.status.success()); assert_eq!("true", out.out, "with config as default"); let out = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_inc"), r#" $env.config.plugin_gc = { default: { enabled: true, stop_after: 0sec } plugins: { inc: { enabled: false, stop_after: 0sec } } } "2.3.0" | inc -M (plugin list | where name == inc).0.status == running "# ); assert!(out.status.success()); assert_eq!("true", out.out, "with inc-specific config"); } #[test] fn plugin_gc_can_be_disabled_by_plugin() { let out = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_example"), r#" example disable-gc $env.config.plugin_gc = { default: { stop_after: 0sec } } example one 1 foo | ignore # ensure we've run the plugin with the new config sleep 100ms (plugin list | where name == example).0.status == running "# ); assert!(out.status.success()); assert_eq!("true", out.out); } #[test] fn plugin_gc_does_not_stop_plugin_while_stream_output_is_active() { let out = nu_with_plugins!( cwd: ".", plugin: ("nu_plugin_example"), r#" $env.config.plugin_gc = { default: { stop_after: 10ms } } # This would exceed the configured time example seq 1 500 | each { |n| sleep 1ms; $n } | length | print "# ); assert!(out.status.success()); assert_eq!("500", out.out); }