elaborate 1.2.0

Wrappers for standard library functions and types to produce more elaborate error messages
Documentation
#![allow(clippy::disallowed_methods)]
#![cfg_attr(
    dylint_lib = "general",
    allow(crate_wide_allow, non_thread_safe_call_in_test)
)]

#[ctor::ctor(unsafe)]
fn initialize() {
    unsafe {
        // smoelius: `RUST_BACKTRACE` adds to the error messages and interferes with the tests.
        std::env::remove_var("RUST_BACKTRACE");
    }
}

#[test]
fn struct_call_failed_without_elaborate() {
    const MSG: &str = if cfg!(target_os = "windows") {
        "The system cannot find the file specified."
    } else {
        "No such file or directory"
    };
    let error = std::fs::OpenOptions::new()
        .read(true)
        .open("/nonexistent_file")
        .unwrap_err();
    assert_eq!(
        format!(
            "\
Os {{ code: 2, kind: NotFound, message: \"{MSG}\" }}"
        ),
        format!("{error:?}")
    );
}

#[test]
fn struct_call_failed_with_elaborate() {
    use elaborate::std::fs::OpenOptionsContext;
    let error = std::fs::OpenOptions::new()
        .read(true)
        .open_wc("/nonexistent_file")
        .unwrap_err();
    if cfg!(target_os = "windows") {
        assert_eq!(
            "\
call failed:
    OpenOptions(
        OpenOptions {
            read: true,
            write: false,
            append: false,
            truncate: false,
            create: false,
            create_new: false,
            custom_flags: 0,
            access_mode: None,
            attributes: 0,
            share_mode: 7,
            security_qos_flags: 0,
            inherit_handle: false,
        },
    ).open(
        \"/nonexistent_file\",
    )

Caused by:
    The system cannot find the file specified. (os error 2)",
            format!("{error:?}")
        );
    } else {
        assert_eq!(
            "\
call failed:
    OpenOptions(
        OpenOptions {
            read: true,
            write: false,
            append: false,
            truncate: false,
            create: false,
            create_new: false,
            custom_flags: 0,
            mode: 0o000666,
        },
    ).open(
        \"/nonexistent_file\",
    )

Caused by:
    No such file or directory (os error 2)",
            format!("{error:?}")
        );
    }
}

#[cfg(unix)]
mod unix {
    use std::{io::Result, os::unix::fs::PermissionsExt};
    use tempfile::NamedTempFile;

    #[test]
    fn call_failed_without_elaborate() {
        let error = std::fs::create_dir("/dir").unwrap_err();
        if cfg!(target_os = "macos") {
            assert_eq!(
                "\
Os { code: 30, kind: ReadOnlyFilesystem, message: \"Read-only file system\" }",
                format!("{error:?}")
            );
        } else {
            assert_eq!(
                "\
Os { code: 13, kind: PermissionDenied, message: \"Permission denied\" }",
                format!("{error:?}")
            );
        }
    }

    #[test]
    fn call_failed_with_elaborate() {
        const MSG: &str = if cfg!(target_os = "macos") {
            "Read-only file system (os error 30)"
        } else {
            "Permission denied (os error 13)"
        };
        let error = elaborate::std::fs::create_dir_wc("/dir").unwrap_err();
        assert_eq!(
            format!(
                "\
call failed:
    std::fs::create_dir(
        \"/dir\",
    )

Caused by:
    {MSG}"
            ),
            format!("{error:?}")
        );
    }

    #[test]
    fn trait_call_failed_without_elaborate() {
        use std::os::unix::fs::FileExt;
        let tempfile = readonly_tempfile().unwrap();
        let error = tempfile.write_at(&[], 1).unwrap_err();
        assert_eq!(
            "\
Os { code: 9, kind: Uncategorized, message: \"Bad file descriptor\" }",
            format!("{error:?}")
        );
    }

    #[test]
    fn trait_call_failed_with_elaborate() {
        use elaborate::std::os::unix::fs::FileExtContext;
        let tempfile = readonly_tempfile().unwrap();
        let error = tempfile.write_at_wc(&[], 0).unwrap_err();
        assert_eq!(
            "\
call failed:
    <value of type &std::fs::File>.write_at(
        [],
        0,
    )

Caused by:
    Bad file descriptor (os error 9)",
            format!("{error:?}")
        );
    }

    fn readonly_tempfile() -> Result<std::fs::File> {
        let tempfile = NamedTempFile::new()?;
        let temp_path = tempfile.into_temp_path();
        std::fs::set_permissions(&temp_path, PermissionsExt::from_mode(0o444))?;
        std::fs::OpenOptions::new().read(true).open(&temp_path)
    }
}