term_transcript/test/

mod.rs

//! Snapshot testing tools for [`Transcript`]s.
//!
//! # Examples
//!
//! Simple scenario in which the tested transcript calls to one or more Cargo binaries / examples
//! by their original names.
//!
//! ```no_run
//! use term_transcript::{
//!     ShellOptions, Transcript,
//!     test::{MatchKind, TestConfig, TestOutputConfig},
//! };
//!
//! // Test configuration that can be shared across tests.
//! fn config() -> TestConfig {
//!     let shell_options = ShellOptions::default()
//!         .with_cargo_path_for("my-command");
//!     TestConfig::new(shell_options)
//!         .with_match_kind(MatchKind::Precise)
//!         .with_output(TestOutputConfig::Verbose)
//! }
//!
//! // Usage in tests:
//! #[test]
//! fn help_command() {
//!     config().test("tests/__snapshots__/help.svg", &["my-command --help"]);
//! }
//! ```
//!
//! ## Lower-level testing
//!
//! Use [`TestConfig::test_transcript()`] for more complex scenarios or increased control:
//!
//! ```
//! use term_transcript::{test::TestConfig, ShellOptions, Transcript, UserInput};
//! # use term_transcript::svg::Template;
//! use std::io;
//!
//! fn read_svg_file() -> anyhow::Result<impl io::BufRead> {
//!     // snipped...
//! #   let transcript = Transcript::from_inputs(
//! #        &mut ShellOptions::default(),
//! #        vec![UserInput::command(r#"echo "Hello world!""#)],
//! #   )?;
//! #   let mut writer = vec![];
//! #   Template::default().render(&transcript, &mut writer)?;
//! #   Ok(io::Cursor::new(writer))
//! }
//!
//! # fn main() -> anyhow::Result<()> {
//! let reader = read_svg_file()?;
//! let transcript = Transcript::from_svg(reader)?;
//! TestConfig::new(ShellOptions::default()).test_transcript(&transcript);
//! # Ok(())
//! # }
//! ```
//!
//! ## Testing with custom capture logic
//!
//! Use [`TestConfig::test_captured()`] if you need to customize snapshot capture logic.
//!
//! ```no_run
//! use term_transcript::{test::TestConfig, Transcript, UserInput};
//!
//! #[test]
//! fn captured_snapshot() {
//!     let mut captured = Transcript::default();
//!     let test_output = "result: [[bold green!]]OK[[/]]".parse().unwrap();
//!     captured.add_interaction(UserInput::command("test").hide(), test_output);
//!     TestConfig::new(())
//!         .test_captured("tests/__snapshots__/test.svg", captured);
//! }
//! ```

use std::{borrow::Cow, fmt, io, process::Command};
#[cfg(feature = "svg")]
use std::{env, ffi::OsStr};

use anstream::ColorChoice;

pub use self::{
    config_impl::compare_transcripts,
    parser::{LocatedParseError, ParseError},
};
#[cfg(feature = "svg")]
use crate::svg::Template;
use crate::{ShellOptions, Transcript, UserInput, traits::SpawnShell};

mod config_impl;
mod parser;
#[cfg(test)]
mod tests;
mod utils;

/// Configuration of output produced during testing.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum TestOutputConfig {
    /// Do not output anything.
    Quiet,
    /// Output normal amount of details.
    #[default]
    Normal,
    /// Output more details.
    Verbose,
}

/// Strategy for saving a new snapshot on a test failure within [`TestConfig::test()`] and
/// related methods.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[non_exhaustive]
#[cfg(feature = "svg")]
#[cfg_attr(docsrs, doc(cfg(feature = "svg")))]
pub enum UpdateMode {
    /// Never create a new snapshot on test failure.
    Never,
    /// Always create a new snapshot on test failure.
    Always,
}

#[cfg(feature = "svg")]
impl UpdateMode {
    /// Reads the update mode from the `TERM_TRANSCRIPT_UPDATE` env variable.
    ///
    /// If the `TERM_TRANSCRIPT_UPDATE` variable is not set, the output depends on whether
    /// the executable is running in CI (which is detected by the presence of
    /// the `CI` env variable):
    ///
    /// - In CI, the method returns [`Self::Never`].
    /// - Otherwise, the method returns [`Self::Always`].
    ///
    /// # Panics
    ///
    /// If the `TERM_TRANSCRIPT_UPDATE` env variable is set to an unrecognized value
    /// (something other than `never` or `always`), this method will panic.
    pub fn from_env() -> Self {
        const ENV_VAR: &str = "TERM_TRANSCRIPT_UPDATE";

        match env::var_os(ENV_VAR) {
            Some(s) => Self::from_os_str(&s).unwrap_or_else(|| {
                panic!(
                    "Cannot read update mode from env variable {ENV_VAR}: `{}` is not a valid value \
                     (use one of `never` or `always`)",
                    s.to_string_lossy()
                );
            }),
            None => {
                if env::var_os("CI").is_some() {
                    Self::Never
                } else {
                    Self::Always
                }
            }
        }
    }

    fn from_os_str(s: &OsStr) -> Option<Self> {
        match s {
            s if s == "never" => Some(Self::Never),
            s if s == "always" => Some(Self::Always),
            _ => None,
        }
    }

    fn should_create_snapshot(self) -> bool {
        match self {
            Self::Always => true,
            Self::Never => false,
        }
    }
}

/// Command executed during snapshot testing in [`TestConfig`] to reproduce a snapshot.
///
/// Two provided implementations are:
///
/// - [`ShellOptions`], which reproduces snapshots based on [`UserInput`]s and the provided shell.
///   Used in [`TestConfig::test()`] and related lower-level methods.
/// - `()`, which requires a captured [`Transcript`], i.e., delegates reproduction to the user code.
///   Used in [`TestConfig::test_captured()`].
///
/// The contents of this trait are implementation details.
pub trait TestCommand {
    #[doc(hidden)] // implementation detail
    type Inputs: fmt::Debug;

    #[doc(hidden)] // implementation detail
    fn extract_inputs(inputs: &Self::Inputs) -> Cow<'_, [UserInput]>;

    #[doc(hidden)] // implementation detail
    fn reproduce(&mut self, inputs: Self::Inputs) -> io::Result<Transcript>;
}

impl<Cmd: SpawnShell> TestCommand for ShellOptions<Cmd> {
    type Inputs = Vec<UserInput>;

    fn extract_inputs(inputs: &Self::Inputs) -> Cow<'_, [UserInput]> {
        Cow::Borrowed(inputs)
    }

    fn reproduce(&mut self, inputs: Self::Inputs) -> io::Result<Transcript> {
        Transcript::from_inputs(self, inputs)
    }
}

impl TestCommand for () {
    type Inputs = Transcript;

    fn extract_inputs(inputs: &Self::Inputs) -> Cow<'_, [UserInput]> {
        let inputs = inputs
            .interactions()
            .iter()
            .map(|interaction| interaction.input().clone());
        Cow::Owned(inputs.collect())
    }

    fn reproduce(&mut self, inputs: Self::Inputs) -> io::Result<Transcript> {
        Ok(inputs)
    }
}

/// Testing configuration.
///
/// # Examples
///
/// See the [module docs](crate::test) for the examples of usage.
#[derive(Debug)]
pub struct TestConfig<Cmd = ShellOptions<Command>, F = fn(&mut Transcript)> {
    command: Cmd,
    match_kind: MatchKind,
    output: TestOutputConfig,
    color_choice: ColorChoice,
    #[cfg(feature = "svg")]
    update_mode: UpdateMode,
    #[cfg(feature = "svg")]
    template: Template,
    transform: F,
}

impl<Cmd: TestCommand> TestConfig<Cmd> {
    /// Creates a new config.
    ///
    /// # Panics
    ///
    /// - Panics if the `svg` crate feature is enabled and the `TERM_TRANSCRIPT_UPDATE` variable
    ///   is set to an incorrect value. See [`UpdateMode::from_env()`] for more details.
    pub fn new(command: Cmd) -> Self {
        Self {
            command,
            match_kind: MatchKind::TextOnly,
            output: TestOutputConfig::Normal,
            color_choice: ColorChoice::Auto,
            #[cfg(feature = "svg")]
            update_mode: UpdateMode::from_env(),
            #[cfg(feature = "svg")]
            template: Template::default(),
            transform: |_| { /* do nothing */ },
        }
    }

    /// Sets the transcript transform for these options. This can be used to transform the captured transcript
    /// (e.g., to remove / replace uncontrollably varying data) before it's compared to the snapshot.
    #[must_use]
    pub fn with_transform<F>(self, transform: F) -> TestConfig<Cmd, F>
    where
        F: FnMut(&mut Transcript),
    {
        TestConfig {
            command: self.command,
            match_kind: self.match_kind,
            output: self.output,
            color_choice: self.color_choice,
            #[cfg(feature = "svg")]
            update_mode: self.update_mode,
            #[cfg(feature = "svg")]
            template: self.template,
            transform,
        }
    }
}

impl<Cmd: TestCommand, F: FnMut(&mut Transcript)> TestConfig<Cmd, F> {
    /// Sets the matching kind applied.
    #[must_use]
    pub fn with_match_kind(mut self, kind: MatchKind) -> Self {
        self.match_kind = kind;
        self
    }

    /// Sets coloring of the output.
    ///
    /// On Windows, `color_choice` has slightly different semantics than its usage
    /// in the `termcolor` crate. Namely, if colors can be used (stdout is a tty with
    /// color support), ANSI escape sequences will always be used.
    #[must_use]
    pub fn with_color_choice(mut self, color_choice: ColorChoice) -> Self {
        self.color_choice = color_choice;
        self
    }

    /// Configures test output.
    #[must_use]
    pub fn with_output(mut self, output: TestOutputConfig) -> Self {
        self.output = output;
        self
    }

    /// Sets the template for rendering new snapshots.
    #[cfg(feature = "svg")]
    #[cfg_attr(docsrs, doc(cfg(feature = "svg")))]
    #[must_use]
    pub fn with_template(mut self, template: Template) -> Self {
        self.template = template;
        self
    }

    /// Overrides the strategy for saving new snapshots for failed tests.
    ///
    /// By default, the strategy is determined from the execution environment
    /// using [`UpdateMode::from_env()`].
    #[cfg(feature = "svg")]
    #[cfg_attr(docsrs, doc(cfg(feature = "svg")))]
    #[must_use]
    pub fn with_update_mode(mut self, update_mode: UpdateMode) -> Self {
        self.update_mode = update_mode;
        self
    }
}

/// Kind of terminal output matching.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[non_exhaustive]
pub enum MatchKind {
    /// Relaxed matching: compare only output text, but not coloring.
    TextOnly,
    /// Precise matching: compare output together with colors.
    Precise,
}

/// Stats of a single snapshot test output by [`TestConfig::test_transcript_for_stats()`].
#[derive(Debug, Clone)]
pub struct TestStats {
    // Match kind per each user input.
    matches: Vec<Option<MatchKind>>,
}

impl TestStats {
    /// Returns the number of successfully matched user inputs with at least the specified
    /// `match_level`.
    pub fn passed(&self, match_level: MatchKind) -> usize {
        self.matches
            .iter()
            .filter(|&&kind| kind >= Some(match_level))
            .count()
    }

    /// Returns the number of user inputs that do not match with at least the specified
    /// `match_level`.
    pub fn errors(&self, match_level: MatchKind) -> usize {
        self.matches.len() - self.passed(match_level)
    }

    /// Returns match kinds per each user input of the tested [`Transcript`]. `None` values
    /// mean no match.
    ///
    /// [`Transcript`]: crate::Transcript
    pub fn matches(&self) -> &[Option<MatchKind>] {
        &self.matches
    }

    /// Panics if these stats contain errors.
    #[allow(clippy::missing_panics_doc)]
    pub fn assert_no_errors(&self, match_level: MatchKind) {
        assert_eq!(self.errors(match_level), 0, "There were test errors");
    }
}