|
| 1 | +//! Command Context Module |
| 2 | +//! |
| 3 | +//! This module provides a unified context for command execution that encapsulates |
| 4 | +//! shared dependencies used across all command handlers. |
| 5 | +//! |
| 6 | +//! ## Purpose |
| 7 | +//! |
| 8 | +//! Previously, each command handler manually created the same dependencies: |
| 9 | +//! |
| 10 | +//! ```rust,ignore |
| 11 | +//! // Duplicate code in every handler: |
| 12 | +//! let repository_factory = RepositoryFactory::new(Duration::from_secs(30)); |
| 13 | +//! let repository = repository_factory.create(working_dir.to_path_buf()); |
| 14 | +//! let clock = Arc::new(SystemClock); |
| 15 | +//! let mut output = UserOutput::new(VerbosityLevel::Normal); |
| 16 | +//! ``` |
| 17 | +//! |
| 18 | +//! `CommandContext` eliminates this duplication by providing a single place to: |
| 19 | +//! - Initialize shared dependencies with consistent configuration |
| 20 | +//! - Access dependencies through a clean interface |
| 21 | +//! - Support testing with mock implementations |
| 22 | +//! |
| 23 | +//! ## Benefits |
| 24 | +//! |
| 25 | +//! - **Consistency**: All commands use the same dependency initialization |
| 26 | +//! - **Maintainability**: Changes to dependency setup only need to be made once |
| 27 | +//! - **Testability**: Easy to inject test doubles via `new_for_testing()` |
| 28 | +//! - **Simplicity**: Command handlers focus on their logic, not setup |
| 29 | +//! |
| 30 | +//! ## Usage Example |
| 31 | +//! |
| 32 | +//! ```rust |
| 33 | +//! use std::path::Path; |
| 34 | +//! use torrust_tracker_deployer_lib::presentation::commands::context::CommandContext; |
| 35 | +//! |
| 36 | +//! fn handle_command(working_dir: &Path) -> Result<(), Box<dyn std::error::Error>> { |
| 37 | +//! let mut ctx = CommandContext::new(working_dir.to_path_buf()); |
| 38 | +//! |
| 39 | +//! ctx.output().progress("Starting operation..."); |
| 40 | +//! |
| 41 | +//! // Use repository and clock through context |
| 42 | +//! let repo = ctx.repository(); |
| 43 | +//! let clock = ctx.clock(); |
| 44 | +//! |
| 45 | +//! ctx.output().success("Operation completed"); |
| 46 | +//! Ok(()) |
| 47 | +//! } |
| 48 | +//! ``` |
| 49 | +
|
| 50 | +use std::path::PathBuf; |
| 51 | +use std::sync::Arc; |
| 52 | + |
| 53 | +use crate::domain::environment::repository::EnvironmentRepository; |
| 54 | +use crate::infrastructure::persistence::repository_factory::RepositoryFactory; |
| 55 | +use crate::presentation::user_output::UserOutput; |
| 56 | +use crate::shared::{Clock, SystemClock}; |
| 57 | + |
| 58 | +use super::constants::{DEFAULT_LOCK_TIMEOUT, DEFAULT_VERBOSITY}; |
| 59 | + |
| 60 | +/// Command execution context containing shared dependencies |
| 61 | +/// |
| 62 | +/// This struct encapsulates all the common dependencies that command handlers need: |
| 63 | +/// - Repository for persistent environment state |
| 64 | +/// - Clock for timing operations |
| 65 | +/// - User output for progress and results |
| 66 | +/// |
| 67 | +/// By centralizing these dependencies, we eliminate duplicate initialization code |
| 68 | +/// and ensure consistent configuration across all commands. |
| 69 | +/// |
| 70 | +/// # Examples |
| 71 | +/// |
| 72 | +/// ```rust |
| 73 | +/// use std::path::PathBuf; |
| 74 | +/// use torrust_tracker_deployer_lib::presentation::commands::context::CommandContext; |
| 75 | +/// |
| 76 | +/// let working_dir = PathBuf::from("."); |
| 77 | +/// let mut ctx = CommandContext::new(working_dir); |
| 78 | +/// |
| 79 | +/// // Access repository |
| 80 | +/// let repo = ctx.repository(); |
| 81 | +/// |
| 82 | +/// // Access clock |
| 83 | +/// let clock = ctx.clock(); |
| 84 | +/// |
| 85 | +/// // Access user output |
| 86 | +/// ctx.output().progress("Processing..."); |
| 87 | +/// ctx.output().success("Complete!"); |
| 88 | +/// ``` |
| 89 | +pub struct CommandContext { |
| 90 | + repository: Arc<dyn EnvironmentRepository>, |
| 91 | + clock: Arc<dyn Clock>, |
| 92 | + output: UserOutput, |
| 93 | +} |
| 94 | + |
| 95 | +impl CommandContext { |
| 96 | + /// Create a new command context with production dependencies |
| 97 | + /// |
| 98 | + /// This constructor initializes all dependencies using production implementations |
| 99 | + /// and default configuration from constants: |
| 100 | + /// - Repository with default lock timeout |
| 101 | + /// - System clock |
| 102 | + /// - User output with default verbosity |
| 103 | + /// |
| 104 | + /// # Arguments |
| 105 | + /// |
| 106 | + /// * `working_dir` - Root directory for environment data storage |
| 107 | + /// |
| 108 | + /// # Examples |
| 109 | + /// |
| 110 | + /// ```rust |
| 111 | + /// use std::path::PathBuf; |
| 112 | + /// use torrust_tracker_deployer_lib::presentation::commands::context::CommandContext; |
| 113 | + /// |
| 114 | + /// let working_dir = PathBuf::from("./data"); |
| 115 | + /// let ctx = CommandContext::new(working_dir); |
| 116 | + /// ``` |
| 117 | + #[must_use] |
| 118 | + pub fn new(working_dir: PathBuf) -> Self { |
| 119 | + let repository_factory = RepositoryFactory::new(DEFAULT_LOCK_TIMEOUT); |
| 120 | + let repository = repository_factory.create(working_dir); |
| 121 | + let clock = Arc::new(SystemClock); |
| 122 | + let output = UserOutput::new(DEFAULT_VERBOSITY); |
| 123 | + |
| 124 | + Self { |
| 125 | + repository, |
| 126 | + clock, |
| 127 | + output, |
| 128 | + } |
| 129 | + } |
| 130 | + |
| 131 | + /// Create a command context for testing with injected dependencies |
| 132 | + /// |
| 133 | + /// This constructor allows tests to inject mock implementations for better isolation |
| 134 | + /// and control over behavior. |
| 135 | + /// |
| 136 | + /// # Arguments |
| 137 | + /// |
| 138 | + /// * `repository` - Repository implementation (can be a mock) |
| 139 | + /// * `clock` - Clock implementation (can be a mock) |
| 140 | + /// * `output` - User output instance (can use custom writers) |
| 141 | + /// |
| 142 | + /// # Examples |
| 143 | + /// |
| 144 | + /// ```rust |
| 145 | + /// use std::sync::Arc; |
| 146 | + /// use std::path::PathBuf; |
| 147 | + /// use torrust_tracker_deployer_lib::presentation::commands::context::CommandContext; |
| 148 | + /// use torrust_tracker_deployer_lib::presentation::user_output::{UserOutput, VerbosityLevel}; |
| 149 | + /// use torrust_tracker_deployer_lib::infrastructure::persistence::repository_factory::RepositoryFactory; |
| 150 | + /// use torrust_tracker_deployer_lib::shared::{Clock, SystemClock}; |
| 151 | + /// use std::time::Duration; |
| 152 | + /// |
| 153 | + /// // Create test dependencies |
| 154 | + /// let factory = RepositoryFactory::new(Duration::from_secs(5)); |
| 155 | + /// let repository = factory.create(PathBuf::from("/tmp/test")); |
| 156 | + /// let clock: Arc<dyn Clock> = Arc::new(SystemClock); |
| 157 | + /// let output = UserOutput::new(VerbosityLevel::Quiet); |
| 158 | + /// |
| 159 | + /// let ctx = CommandContext::new_for_testing(repository, clock, output); |
| 160 | + /// ``` |
| 161 | + #[must_use] |
| 162 | + pub fn new_for_testing( |
| 163 | + repository: Arc<dyn EnvironmentRepository>, |
| 164 | + clock: Arc<dyn Clock>, |
| 165 | + output: UserOutput, |
| 166 | + ) -> Self { |
| 167 | + Self { |
| 168 | + repository, |
| 169 | + clock, |
| 170 | + output, |
| 171 | + } |
| 172 | + } |
| 173 | + |
| 174 | + /// Get reference to the environment repository |
| 175 | + /// |
| 176 | + /// # Examples |
| 177 | + /// |
| 178 | + /// ```rust |
| 179 | + /// use std::path::PathBuf; |
| 180 | + /// use torrust_tracker_deployer_lib::presentation::commands::context::CommandContext; |
| 181 | + /// |
| 182 | + /// let ctx = CommandContext::new(PathBuf::from(".")); |
| 183 | + /// let repo = ctx.repository(); |
| 184 | + /// ``` |
| 185 | + #[must_use] |
| 186 | + pub fn repository(&self) -> &Arc<dyn EnvironmentRepository> { |
| 187 | + &self.repository |
| 188 | + } |
| 189 | + |
| 190 | + /// Get reference to the clock |
| 191 | + /// |
| 192 | + /// # Examples |
| 193 | + /// |
| 194 | + /// ```rust |
| 195 | + /// use std::path::PathBuf; |
| 196 | + /// use torrust_tracker_deployer_lib::presentation::commands::context::CommandContext; |
| 197 | + /// |
| 198 | + /// let ctx = CommandContext::new(PathBuf::from(".")); |
| 199 | + /// let clock = ctx.clock(); |
| 200 | + /// ``` |
| 201 | + #[must_use] |
| 202 | + pub fn clock(&self) -> &Arc<dyn Clock> { |
| 203 | + &self.clock |
| 204 | + } |
| 205 | + |
| 206 | + /// Get mutable reference to user output |
| 207 | + /// |
| 208 | + /// # Examples |
| 209 | + /// |
| 210 | + /// ```rust |
| 211 | + /// use std::path::PathBuf; |
| 212 | + /// use torrust_tracker_deployer_lib::presentation::commands::context::CommandContext; |
| 213 | + /// |
| 214 | + /// let mut ctx = CommandContext::new(PathBuf::from(".")); |
| 215 | + /// ctx.output().progress("Working..."); |
| 216 | + /// ctx.output().success("Done!"); |
| 217 | + /// ``` |
| 218 | + pub fn output(&mut self) -> &mut UserOutput { |
| 219 | + &mut self.output |
| 220 | + } |
| 221 | +} |
| 222 | + |
| 223 | +/// Report an error through user output |
| 224 | +/// |
| 225 | +/// This utility function provides a consistent way to report errors to users. |
| 226 | +/// It outputs the error message through the provided user output instance. |
| 227 | +/// |
| 228 | +/// # Arguments |
| 229 | +/// |
| 230 | +/// * `output` - User output instance to use for reporting |
| 231 | +/// * `error` - Error to report (any type implementing `std::error::Error`) |
| 232 | +/// |
| 233 | +/// # Examples |
| 234 | +/// |
| 235 | +/// ```rust |
| 236 | +/// use torrust_tracker_deployer_lib::presentation::commands::context::report_error; |
| 237 | +/// use torrust_tracker_deployer_lib::presentation::user_output::{UserOutput, VerbosityLevel}; |
| 238 | +/// |
| 239 | +/// let mut output = UserOutput::new(VerbosityLevel::Normal); |
| 240 | +/// let error = std::io::Error::new(std::io::ErrorKind::NotFound, "file not found"); |
| 241 | +/// report_error(&mut output, &error); |
| 242 | +/// ``` |
| 243 | +pub fn report_error(output: &mut UserOutput, error: &dyn std::error::Error) { |
| 244 | + output.error(&error.to_string()); |
| 245 | +} |
| 246 | + |
| 247 | +#[cfg(test)] |
| 248 | +mod tests { |
| 249 | + use super::*; |
| 250 | + use std::io::Cursor; |
| 251 | + use tempfile::TempDir; |
| 252 | + |
| 253 | + #[test] |
| 254 | + fn it_should_create_context_with_production_dependencies() { |
| 255 | + let temp_dir = TempDir::new().unwrap(); |
| 256 | + let working_dir = temp_dir.path().to_path_buf(); |
| 257 | + |
| 258 | + let ctx = CommandContext::new(working_dir); |
| 259 | + |
| 260 | + // Verify dependencies are present and accessible (we can call methods on them) |
| 261 | + let _ = ctx.repository(); |
| 262 | + let _ = ctx.clock(); |
| 263 | + } |
| 264 | + |
| 265 | + #[test] |
| 266 | + fn it_should_provide_access_to_repository() { |
| 267 | + let temp_dir = TempDir::new().unwrap(); |
| 268 | + let working_dir = temp_dir.path().to_path_buf(); |
| 269 | + |
| 270 | + let ctx = CommandContext::new(working_dir); |
| 271 | + |
| 272 | + // Should be able to access repository |
| 273 | + let _repo = ctx.repository(); |
| 274 | + } |
| 275 | + |
| 276 | + #[test] |
| 277 | + fn it_should_provide_access_to_clock() { |
| 278 | + let temp_dir = TempDir::new().unwrap(); |
| 279 | + let working_dir = temp_dir.path().to_path_buf(); |
| 280 | + |
| 281 | + let ctx = CommandContext::new(working_dir); |
| 282 | + |
| 283 | + // Should be able to access clock |
| 284 | + let _clock = ctx.clock(); |
| 285 | + } |
| 286 | + |
| 287 | + #[test] |
| 288 | + fn it_should_provide_mutable_access_to_output() { |
| 289 | + let temp_dir = TempDir::new().unwrap(); |
| 290 | + let working_dir = temp_dir.path().to_path_buf(); |
| 291 | + |
| 292 | + let mut ctx = CommandContext::new(working_dir); |
| 293 | + |
| 294 | + // Should be able to use output methods |
| 295 | + ctx.output().progress("Test progress"); |
| 296 | + ctx.output().success("Test success"); |
| 297 | + } |
| 298 | + |
| 299 | + #[test] |
| 300 | + fn it_should_allow_creating_context_for_testing() { |
| 301 | + let temp_dir = TempDir::new().unwrap(); |
| 302 | + let working_dir = temp_dir.path().to_path_buf(); |
| 303 | + |
| 304 | + // Create test dependencies |
| 305 | + let repository_factory = RepositoryFactory::new(DEFAULT_LOCK_TIMEOUT); |
| 306 | + let repository = repository_factory.create(working_dir); |
| 307 | + let clock: Arc<dyn Clock> = Arc::new(SystemClock); |
| 308 | + let output = UserOutput::new(DEFAULT_VERBOSITY); |
| 309 | + |
| 310 | + // Create context with test dependencies |
| 311 | + let ctx = CommandContext::new_for_testing(repository, clock, output); |
| 312 | + |
| 313 | + // Verify we can access all dependencies |
| 314 | + let _repo = ctx.repository(); |
| 315 | + let _clock = ctx.clock(); |
| 316 | + } |
| 317 | + |
| 318 | + #[test] |
| 319 | + fn it_should_allow_accessing_output_multiple_times() { |
| 320 | + let temp_dir = TempDir::new().unwrap(); |
| 321 | + let working_dir = temp_dir.path().to_path_buf(); |
| 322 | + |
| 323 | + let mut ctx = CommandContext::new(working_dir); |
| 324 | + |
| 325 | + // Should be able to call output() multiple times |
| 326 | + ctx.output().progress("First message"); |
| 327 | + ctx.output().success("Second message"); |
| 328 | + ctx.output().error("Third message"); |
| 329 | + } |
| 330 | + |
| 331 | + #[test] |
| 332 | + fn it_should_report_errors_through_output() { |
| 333 | + // Create output with custom writers for testing |
| 334 | + let stderr_buf = Vec::new(); |
| 335 | + let stderr_writer = Box::new(Cursor::new(stderr_buf)); |
| 336 | + let stdout_writer = Box::new(Cursor::new(Vec::new())); |
| 337 | + |
| 338 | + let mut output = UserOutput::with_writers(DEFAULT_VERBOSITY, stdout_writer, stderr_writer); |
| 339 | + |
| 340 | + // Create an error and report it |
| 341 | + let error = std::io::Error::new(std::io::ErrorKind::NotFound, "file not found"); |
| 342 | + report_error(&mut output, &error); |
| 343 | + |
| 344 | + // Note: In a real test, we'd verify the output was written, |
| 345 | + // but that requires extracting the buffer from output which isn't directly possible |
| 346 | + // without additional helper methods. The important thing is that it compiles and runs. |
| 347 | + } |
| 348 | + |
| 349 | + #[test] |
| 350 | + fn it_should_use_default_constants() { |
| 351 | + let temp_dir = TempDir::new().unwrap(); |
| 352 | + let working_dir = temp_dir.path().to_path_buf(); |
| 353 | + |
| 354 | + // Creating context should use DEFAULT_LOCK_TIMEOUT and DEFAULT_VERBOSITY |
| 355 | + let _ctx = CommandContext::new(working_dir); |
| 356 | + |
| 357 | + // This test verifies that the code compiles with the constants |
| 358 | + // The actual values are tested in the constants module |
| 359 | + } |
| 360 | +} |
0 commit comments