timewall 2.1.0

#![allow(
    dead_code,
    clippy::missing_panics_doc,
    clippy::must_use_candidate,
    clippy::return_self_not_must_use,
    clippy::new_without_default,
    clippy::missing_const_for_fn,
    clippy::too_long_first_doc_paragraph,
    clippy::use_self
)]

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

use assert_cmd::{assert::Assert, cargo, Command};
use assert_fs::{
    fixture::ChildPath,
    prelude::{FileWriteStr, PathChild},
    TempDir,
};
use chrono::{DateTime, Local, TimeZone};
use rstest::fixture;
use std::sync::LazyLock;

/// Absolute path to example time-based wallpaper.
pub static EXAMPLE_TIME: LazyLock<PathBuf> = LazyLock::new(|| {
    PathBuf::from("tests/examples/time.heic")
        .canonicalize()
        .unwrap()
});
/// Absolute path to example sun-based wallpaper.
pub static EXAMPLE_SUN: LazyLock<PathBuf> = LazyLock::new(|| {
    PathBuf::from("tests/examples/sun.heic")
        .canonicalize()
        .unwrap()
});
/// Absolute path to example unsupported image file.
pub static EXAMPLE_UNSUPPORTED: LazyLock<PathBuf> = LazyLock::new(|| {
    PathBuf::from("tests/examples/unsupported.jpg")
        .canonicalize()
        .unwrap()
});
/// Absolute path to example time-based properties XML file.
pub static PROPERTIES_TIME: LazyLock<PathBuf> = LazyLock::new(|| {
    PathBuf::from("tests/examples/properties_time.xml")
        .canonicalize()
        .unwrap()
});
/// Absolute path to example sun-based properties XML file.
pub static PROPERTIES_SUN: LazyLock<PathBuf> = LazyLock::new(|| {
    PathBuf::from("tests/examples/properties_sun.xml")
        .canonicalize()
        .unwrap()
});
/// Mapping of examples wallpaper paths to their hashes.
pub static WALLPAPER_HASHES: LazyLock<HashMap<PathBuf, &'static str>> = LazyLock::new(|| {
    HashMap::from([
        (EXAMPLE_TIME.to_path_buf(), "dcbcd5f96ccdbdd"),
        (EXAMPLE_SUN.to_path_buf(), "a81fb8b5a1b35168"),
    ])
});
/// Datetime that should result in day-time image in example wallpapers.
pub static DATETIME_DAY: LazyLock<DateTime<Local>> = LazyLock::new(|| {
    Local
        .with_ymd_and_hms(2022, 10, 18, 14, 30, 30)
        .single()
        .unwrap()
});
/// Datetime that should result in night-time image in example wallpapers.
pub static DATETIME_NIGHT: LazyLock<DateTime<Local>> = LazyLock::new(|| {
    Local
        .with_ymd_and_hms(2022, 10, 18, 22, 30, 30)
        .single()
        .unwrap()
});

/// Name of the image that should be set for day-time in example wallpapers.
pub const IMAGE_DAY: &str = "0.png";
/// Name of the image that should be set for night-time in example wallpapers.
pub const IMAGE_NIGHT: &str = "1.png";
/// Message printed to stdout in dry-run mode to indicate that image is being set as a wallpaper.
pub const IMAGE_SET_MESSAGE: &str = "Set: ";
/// Message printed to stdout in dry-run mode to indicate that command is being run.
pub const COMMAND_RUN_MESSAGE: &str = "Run: ";

pub const CONFIG_WITH_LOCATION: &str = r"
[geoclue]
enable = false

[location]
lat = 52.2297
lon = 21.0122
";

pub const CONFIG_WITH_COMMAND: &str = r"
[setter]
command = ['feh', '--bg-fill', '%f']
";

/// Get full path to cached wallpaper directory.
pub fn cached_wallpaper_dir<CP: AsRef<Path>>(cache_dir: CP, wallpaper: &PathBuf) -> PathBuf {
    cache_dir
        .as_ref()
        .join("wallpapers")
        .join(WALLPAPER_HASHES.get(wallpaper).unwrap())
}

/// Get full path to cached wallpaper image as a string.
/// Path is determined based on root cache directory, used wallpaper and name of the image in this
/// wallpaper.
pub fn cached_image_path_str<CP: AsRef<Path>>(
    cache_dir: CP,
    wallpaper: &PathBuf,
    image: &str,
) -> String {
    cached_wallpaper_dir(cache_dir, wallpaper)
        .join(image)
        .to_str()
        .unwrap()
        .to_owned()
}

/// Test environment for `timewall` binary tests.
/// Sets up temporary directory to run the binary in, overrides config and cache directories,
/// enables dry-run, allows overriding date and time seen by the binary.
pub struct TestEnv {
    pub cwd: TempDir,
    pub config_dir: ChildPath,
    pub cache_dir: ChildPath,
    pub runtime_dir: ChildPath,
    datetime: Option<DateTime<Local>>,
}

impl TestEnv {
    pub fn new() -> Self {
        TestEnv {
            cwd: assert_fs::TempDir::new().unwrap(),
            config_dir: assert_fs::TempDir::new().unwrap().child("config"),
            cache_dir: assert_fs::TempDir::new().unwrap().child("cache"),
            runtime_dir: assert_fs::TempDir::new().unwrap().child("runtime"),
            datetime: None,
        }
    }

    /// Write given string as a contents of the config file.
    pub fn with_config(self, config: &str) -> Self {
        self.config_dir
            .child("config.toml")
            .write_str(config)
            .unwrap();
        self
    }

    /// Override datetime seen by the binary.
    pub fn with_time(mut self, time: DateTime<Local>) -> Self {
        self.datetime = Some(time);
        self
    }

    /// Run the command and return `Assert` object.
    pub fn run(&self, args: &[&str]) -> Assert {
        let mut command = Command::new(cargo::cargo_bin!());
        command
            .current_dir(&self.cwd)
            .env("TIMEWALL_DRY_RUN", "true")
            .env("TIMEWALL_CONFIG_DIR", self.config_dir.path())
            .env("TIMEWALL_CACHE_DIR", self.cache_dir.path())
            .env("TIMEWALL_RUNTIME_DIR", self.runtime_dir.path())
            .args(args);
        if let Some(datetime) = self.datetime {
            command.env("TIMEWALL_OVERRIDE_TIME", datetime.to_rfc3339());
        }
        command.assert()
    }
}

#[fixture]
pub fn testenv() -> TestEnv {
    TestEnv::new()
}