#![cfg_attr(docsrs, feature(doc_cfg))]

#![doc = include_str!("../README.md")]

// @@ begin lint list maintained by maint/add_warning @@

#![allow(renamed_and_removed_lints)] // @@REMOVE_WHEN(ci_arti_stable)

#![allow(unknown_lints)] // @@REMOVE_WHEN(ci_arti_nightly)

#![warn(missing_docs)]

#![warn(noop_method_call)]

#![warn(unreachable_pub)]

#![warn(clippy::all)]

#![deny(clippy::await_holding_lock)]

#![deny(clippy::cargo_common_metadata)]

#![deny(clippy::cast_lossless)]

#![deny(clippy::checked_conversions)]

#![allow(clippy::cognitive_complexity)] // See arti#2556

#![deny(clippy::debug_assert_with_mut_call)]

#![deny(clippy::exhaustive_enums)]

#![deny(clippy::exhaustive_structs)]

#![deny(clippy::expl_impl_clone_on_copy)]

#![deny(clippy::fallible_impl_from)]

#![deny(clippy::implicit_clone)]

#![deny(clippy::large_stack_arrays)]

#![warn(clippy::manual_ok_or)]

#![deny(clippy::missing_docs_in_private_items)]

#![warn(clippy::needless_borrow)]

#![warn(clippy::needless_pass_by_value)]

#![warn(clippy::option_option)]

#![warn(clippy::or_fun_call)]

#![deny(clippy::print_stderr)]

#![deny(clippy::print_stdout)]

#![warn(clippy::rc_buffer)]

#![deny(clippy::ref_option_ref)]

#![warn(clippy::semicolon_if_nothing_returned)]

#![warn(clippy::trait_duplication_in_bounds)]

#![deny(clippy::unchecked_time_subtraction)]

#![deny(clippy::unnecessary_wraps)]

#![warn(clippy::unseparated_literal_suffix)]

#![deny(clippy::unwrap_used)]

#![deny(clippy::mod_module_files)]

#![allow(clippy::let_unit_value)] // This can reasonably be done for explicitness

#![allow(clippy::uninlined_format_args)]

#![allow(clippy::significant_drop_in_scrutinee)] // arti/-/merge_requests/588/#note_2812945

#![allow(clippy::result_large_err)] // temporary workaround for arti#587

#![allow(clippy::needless_raw_string_hashes)] // complained-about code is fine, often best

#![allow(clippy::needless_lifetimes)] // See arti#1765

#![allow(mismatched_lifetime_syntaxes)] // temporary workaround for arti#2060

#![allow(clippy::collapsible_if)] // See arti#2342

#![deny(clippy::unused_async)]

#![deny(clippy::string_slice)] // See arti#2571

#![allow(recursion_depth_exceeding_limit)] // arti#2715, rust/issues/159228

//! <!-- @@ end lint list maintained by maint/add_warning @@ -->

// We have a nonstandard test lint block

#![allow(clippy::print_stdout)]

use std::env::{self, VarError};

use std::fs;

use std::io::{self, ErrorKind};

use std::marker::PhantomData;

use std::path::{Path, PathBuf};

use anyhow::{Context as _, anyhow};

use derive_more::{Deref, DerefMut};

use educe::Educe;

/// The env var the user should set to control test temp dir handling

const RETAIN_VAR: &str = "TEST_TEMP_RETAIN";

/// Directory for a test to store temporary files

///

/// Automatically deleted (if appropriate) when dropped.

#[derive(Debug)]

#[non_exhaustive]

pub enum TestTempDir {

    /// An ephemeral directory

    Ephemeral(tempfile::TempDir),

    /// A directory which should persist after the test completes

    Persistent(PathBuf),

}

/// A `T` which relies on some temporary directory with lifetime `d`

///

/// Obtained from `TestTempDir::used_by`.

///

/// Using this type means that the `T` won't outlive the temporary directory.

/// (Typically, if it were to, things would malfunction.

/// There might even be security hazards!)

#[derive(Clone, Copy, Deref, DerefMut, Educe)]

#[educe(Debug(bound))]

pub struct TestTempDirGuard<'d, T> {

    /// The thing

    #[deref]

    #[deref_mut]

    thing: T,

    /// Placate the compiler

    ///

    /// We use a notional `()` since we don't want the compiler to infer drop glue.

    #[educe(Debug(ignore))]

    tempdir: PhantomData<&'d ()>,

}

impl TestTempDir {

    /// Obtain a temp dir named after our thread, and the module path `mod_path`

    ///

    /// Expects that the current thread name is the module path within the crate,

    /// followed by the test function name.

    /// (This is how Rust's builtin `#[test]` names its threads.)

    // This is also used by some other crates.

    // If it turns out not to be true, we'll end up panicking.

    //

    // This is rather a shonky approach.  We take it here for the following reasons:

    //

    // It is important that the persistent test output filename is stable,

    // even if the source code is edited.  For example, if we used the line number

    // of the macro call, editing the source would change the output filenames.

    // When the output filenames change willy-nilly, it is very easy to accidentally

    // look at an out-of-date filename containing out-of-date test data,

    // which can be very confusing.

    //

    // We could ask the user to supply a string, but we'd then need

    // some kind of contraption for verifying its uniqueness, since

    // non-unique test names would risk tests overwriting each others'

    // files, making for flaky or malfunctioning tests.

    //

    // So the test function name is the best stable identifier we have,

    // and the thread name is the only way we have of discovering it.

    // Happily this works with `cargo nextest` too.

    //

    // For the same reasons, it wouldn't be a good idea to fall back

    // from the stable name to some less stable but more reliably obtainable id.

    //

    // And, the code structure is deliberately arranged that we *always*

    // try to determine the test name, even if TEST_TEMP_RETAIN isn't set.

    // Otherwise a latent situation, where TEST_TEMP_RETAIN doesn't work, could develop.

    //

    /// And, expects that `mod_path` is the crate name,

    /// and then the module path within the crate.

    /// This is what Rust's builtin `module_path!` macro returns.

    ///

    /// The two instances of the module path within the crate must be the same!

    ///

    /// # Panics

    ///

    /// Panics if the thread name and `mod_path` do not correspond

    /// (see the [self](module-level documentation).)

        })()

    /// Obtains a temp dir named after a complete item path

    ///

    /// The supplied `item_path` must be globally unique in the whole workspace,

    /// or it might collide with other tests from other crates.

    ///

    /// Handles the replacement of `::` with `,` on Windows.

        // Operating systems that can't have `::` in pathnames

        #[cfg(target_os = "windows")]

        let subdir = subdir.replace("::", ",");

        #[allow(clippy::needless_borrow)] // borrow not needed if we didn't rebind

    /// Obtains a temp dir given a stable unique subdirectory name

    ///

    /// The supplied `subdir` must be globally unique

    /// across every test in the whole workspace,

    /// or it might collide with other tests.

        };

        } else {

        };

        };

        let dir_display_lossy;

        #[allow(clippy::disallowed_methods)]

        }

    /// Obtain a reference to the `Path` of this temp directory

    ///

    /// Prefer to use [`.used_by()`](TestTempDir::used_by) where possible.

    ///

    /// The lifetime of the temporary directory will not be properly represented

    /// by Rust lifetimes.  For example, calling

    /// `.to_owned()`[ToOwned::to_owned]

    /// will get a `'static` value,

    /// which doesn't represent the fact that the directory will go away

    /// when the `TestTempDir` is dropped.

    ///

    /// So the resulting value can be passed to functions which

    /// store the path for later use, and might later malfunction because

    /// the `TestTempDir` is dropped too early.

        }

    /// Return a subdirectory, without lifetime tracking

    /// Obtain a `T` which uses paths in `self`

    ///

    /// Within `f`, construct `T` using the supplied filesystem path,

    /// which is the full path to the test's temporary directory.

    ///

    /// Do not store or copy the path anywhere other than the return value;

    /// such copies would not be protected by Rust lifetimes against early deletion.

    ///

    /// Rust lifetime tracking ensures that the temporary directory

    /// won't be cleaned up until the `T` is destroyed.

    #[allow(clippy::needless_lifetimes)] // explicit lifetimes for clarity (and symmetry)

    /// Obtain a `T` which uses paths in a subdir of `self`

    ///

    /// The directory `subdir` will be created,

    /// within the test's temporary directory,

    /// if it doesn't already exist.

    ///

    /// Within `f`, construct `T` using the supplied filesystem path,

    /// which is the fuill path to the subdirectory.

    ///

    /// Do not store or copy the path anywhere other than the return value;

    /// such copies would not be protected by Rust lifetimes against early deletion.

    ///

    /// Rust lifetime tracking ensures that the temporary directory

    /// won't be cleaned up until the `T` is destroyed.

            }

}

impl<'d, T> TestTempDirGuard<'d, T> {

    /// Obtain the inner `T`

    ///

    /// It is up to you to ensure that `T` doesn't outlive

    /// the temp directory used to create it.

    /// Create from a `T` and a `&Path` with the right lifetime

    /// Create from a raw `T`

    ///

    /// The returned lifetime is unfounded!

    /// It is up to you to ensure that the inferred lifetime is correct!

}

/// Obtain a `TestTempDir` for the current test

///

/// Must be called in the same thread as the actual `#[test]` entrypoint!

///

/// **`fn test_temp_dir() -> TestTempDir;`**

#[macro_export]

macro_rules! test_temp_dir { {} => {

    $crate::TestTempDir::from_module_path_and_thread(module_path!())

} }