torrust_tracker_deployer_lib/presentation/cli/controllers/validate/

handler.rs

//! Validate Command Handler
//!
//! This module handles the validate command execution at the presentation layer,
//! including file validation and user feedback.

use std::cell::RefCell;
use std::path::Path;
use std::sync::Arc;

use parking_lot::ReentrantMutex;

use crate::application::command_handlers::validate::{ValidateCommandHandler, ValidationResult};
use crate::presentation::cli::input::cli::OutputFormat;
use crate::presentation::cli::views::commands::validate::{
    JsonView, TextView, ValidateDetailsData,
};
use crate::presentation::cli::views::progress::ProgressReporter;
use crate::presentation::cli::views::Render;
use crate::presentation::cli::views::UserOutput;

use super::errors::ValidateSubcommandError;

/// Steps in the validate workflow
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum ValidateStep {
    LoadConfiguration,
    ValidateSchema,
    ValidateFields,
}

impl ValidateStep {
    /// All steps in execution order
    const ALL: &'static [Self] = &[
        Self::LoadConfiguration,
        Self::ValidateSchema,
        Self::ValidateFields,
    ];

    /// Total number of steps
    const fn count() -> usize {
        Self::ALL.len()
    }

    /// User-facing description for the step
    fn description(self) -> &'static str {
        match self {
            Self::LoadConfiguration => "Loading configuration file",
            Self::ValidateSchema => "Validating JSON schema",
            Self::ValidateFields => "Validating configuration fields",
        }
    }
}

/// Presentation layer controller for validate command workflow
///
/// Coordinates user interaction, progress reporting, and input validation
/// for validating environment configuration files without deployment.
///
/// # Responsibilities
///
/// - Validate file path exists and is readable
/// - Show progress updates to the user
/// - Format validation results for display
/// - Delegate validation logic to application layer
///
/// # Architecture
///
/// This controller sits in the presentation layer and handles all user-facing
/// concerns. Business logic is delegated to the application layer's
/// `ValidateCommandHandler`.
pub struct ValidateCommandController {
    progress: ProgressReporter,
    handler: ValidateCommandHandler,
}

impl ValidateCommandController {
    /// Create a new validate command controller
    ///
    /// Creates a `ValidateCommandController` with user output.
    /// This follows the single container architecture pattern.
    #[allow(clippy::needless_pass_by_value)] // Constructor takes ownership of Arc parameters
    pub fn new(user_output: Arc<ReentrantMutex<RefCell<UserOutput>>>) -> Self {
        Self {
            progress: ProgressReporter::new(user_output, ValidateStep::count()),
            handler: ValidateCommandHandler::new(),
        }
    }

    /// Execute the validate command workflow
    ///
    /// Main entry point for the validate command. Orchestrates the validation
    /// workflow: loads configuration, validates schema and fields.
    ///
    /// # Arguments
    ///
    /// * `env_file` - Path to the environment configuration file
    ///
    /// # Returns
    ///
    /// Returns `Ok(())` on successful validation, or a `ValidateSubcommandError`
    /// if validation fails.
    ///
    /// # Errors
    ///
    /// Returns an error if:
    /// - File path does not exist
    /// - File is not readable
    /// - Configuration validation fails
    pub fn execute(
        &mut self,
        env_file: &Path,
        output_format: OutputFormat,
    ) -> Result<(), ValidateSubcommandError> {
        // Step 1: Load Configuration (file existence check)
        self.progress
            .start_step(ValidateStep::LoadConfiguration.description())?;
        Self::validate_file_exists(env_file)?;
        self.progress
            .complete_step(Some("Configuration file loaded"))?;

        // Step 2: Validate Schema (JSON parsing)
        self.progress
            .start_step(ValidateStep::ValidateSchema.description())?;

        // Delegate actual validation to application layer
        let result = self.handler.validate(env_file).map_err(|source| {
            ValidateSubcommandError::ValidationFailed {
                path: env_file.to_path_buf(),
                source,
            }
        })?;

        self.progress
            .complete_step(Some("Schema validation passed"))?;

        // Step 3: Validate Fields (domain rules)
        self.progress
            .start_step(ValidateStep::ValidateFields.description())?;
        self.progress
            .complete_step(Some("Field validation passed"))?;

        // Complete workflow with detailed results
        self.complete_workflow(env_file, &result, output_format)?;

        Ok(())
    }

    /// Validate that the configuration file exists and is readable
    fn validate_file_exists(env_file: &Path) -> Result<(), ValidateSubcommandError> {
        if !env_file.exists() {
            return Err(ValidateSubcommandError::ConfigFileNotFound {
                path: env_file.to_path_buf(),
            });
        }

        if !env_file.is_file() {
            return Err(ValidateSubcommandError::ConfigPathNotFile {
                path: env_file.to_path_buf(),
            });
        }

        Ok(())
    }

    /// Complete the workflow with validation details output
    ///
    /// Renders the validation details using the chosen output format
    /// (text or JSON) and displays them to the user.
    fn complete_workflow(
        &mut self,
        env_file: &Path,
        result: &ValidationResult,
        output_format: OutputFormat,
    ) -> Result<(), ValidateSubcommandError> {
        let data = ValidateDetailsData::from_result(env_file, result);

        match output_format {
            OutputFormat::Text => {
                self.progress.blank_line()?;
                self.progress.complete(&TextView::render(&data)?)?;
            }
            OutputFormat::Json => {
                self.progress.result(&JsonView::render(&data)?)?;
            }
        }

        Ok(())
    }
}