-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathhandler.rs
More file actions
374 lines (320 loc) · 13 KB
/
handler.rs
File metadata and controls
374 lines (320 loc) · 13 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
//! Run Command Handler
//!
//! This module handles the run command execution at the presentation layer,
//! including environment validation, state validation, and user interaction.
use std::cell::RefCell;
use std::sync::Arc;
use parking_lot::ReentrantMutex;
use crate::application::command_handlers::run::RunCommandHandler;
use crate::application::command_handlers::show::info::{GrafanaInfo, ServiceInfo};
use crate::domain::environment::name::EnvironmentName;
use crate::domain::environment::repository::EnvironmentRepository;
use crate::domain::environment::state::AnyEnvironmentState;
use crate::presentation::cli::input::cli::OutputFormat;
use crate::presentation::cli::views::commands::run::{JsonView, RunDetailsData, TextView};
use crate::presentation::cli::views::progress::ProgressReporter;
use crate::presentation::cli::views::Render;
use crate::presentation::cli::views::UserOutput;
use crate::shared::clock::Clock;
use super::errors::RunSubcommandError;
/// Steps in the run workflow
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum RunStep {
ValidateEnvironment,
RunServices,
}
impl RunStep {
/// All steps in execution order
const ALL: &'static [Self] = &[Self::ValidateEnvironment, Self::RunServices];
/// 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::ValidateEnvironment => "Validating environment",
Self::RunServices => "Running application services",
}
}
}
/// Presentation layer controller for run command workflow
///
/// Coordinates user interaction, progress reporting, and input validation
/// before delegating to the application layer `RunCommandHandler`.
///
/// # Responsibilities
///
/// - Validate user input (environment name format)
/// - Validate environment state (must be Released)
/// - Show progress updates to the user
/// - Format success/error messages for display
/// - Delegate business logic to application layer
///
/// # Architecture
///
/// This controller sits in the presentation layer and handles all user-facing
/// concerns. It delegates actual business logic to the application layer's
/// `RunCommandHandler`.
pub struct RunCommandController {
repository: Arc<dyn EnvironmentRepository + Send + Sync>,
clock: Arc<dyn Clock>,
progress: ProgressReporter,
}
impl RunCommandController {
/// Create a new run command controller
///
/// Creates a `RunCommandController` with direct repository injection.
/// This follows the single container architecture pattern.
#[allow(clippy::needless_pass_by_value)] // Constructor takes ownership of Arc parameters
pub fn new(
repository: Arc<dyn EnvironmentRepository + Send + Sync>,
clock: Arc<dyn Clock>,
user_output: Arc<ReentrantMutex<RefCell<UserOutput>>>,
) -> Self {
let progress = ProgressReporter::new(user_output, RunStep::count());
Self {
repository,
clock,
progress,
}
}
/// Execute the complete run workflow
///
/// Orchestrates all steps of the run command:
/// 1. Validate environment name
/// 2. Run application services via `RunCommandHandler`
/// 3. Complete with success message
///
/// # Arguments
///
/// * `environment_name` - The name of the environment to run services in
/// * `output_format` - Output format (Text or Json)
///
/// # Errors
///
/// Returns an error if:
/// - Environment name is invalid (format validation fails)
/// - Environment is not in the Released state
/// - Service start fails
///
/// # Returns
///
/// Returns `Ok(())` on success, or a `RunSubcommandError` if any step fails.
#[allow(clippy::result_large_err)]
#[allow(clippy::unused_async)] // Part of uniform async presentation layer interface
pub async fn execute(
&mut self,
environment_name: &str,
output_format: OutputFormat,
) -> Result<(), RunSubcommandError> {
let env_name = self.validate_environment_name(environment_name)?;
self.run_services(&env_name)?;
self.complete_workflow(environment_name, output_format)?;
Ok(())
}
/// Validate the environment name format
///
/// Shows progress to user and validates that the environment name
/// meets domain requirements (1-63 chars, alphanumeric + hyphens).
#[allow(clippy::result_large_err)]
fn validate_environment_name(
&mut self,
name: &str,
) -> Result<EnvironmentName, RunSubcommandError> {
self.progress
.start_step(RunStep::ValidateEnvironment.description())?;
let env_name = EnvironmentName::new(name.to_string()).map_err(|source| {
RunSubcommandError::InvalidEnvironmentName {
name: name.to_string(),
source,
}
})?;
self.progress
.complete_step(Some(&format!("Environment name validated: {name}")))?;
Ok(env_name)
}
/// Run services via the application layer handler
///
/// Delegates to `RunCommandHandler` to execute the run workflow:
/// 1. Load environment from repository
/// 2. Validate environment is in Released state
/// 3. Start Docker Compose services via Ansible
/// 4. Update environment state to Running
#[allow(clippy::result_large_err)]
fn run_services(&mut self, env_name: &EnvironmentName) -> Result<(), RunSubcommandError> {
self.progress
.start_step(RunStep::RunServices.description())?;
// Cast the repository to the base trait type that RunCommandHandler expects
let repository: Arc<dyn crate::domain::environment::repository::EnvironmentRepository> =
Arc::clone(&self.repository)
as Arc<dyn crate::domain::environment::repository::EnvironmentRepository>;
let handler = RunCommandHandler::new(repository, Arc::clone(&self.clock));
handler.execute(env_name)?;
self.progress.complete_step(Some("Services started"))?;
Ok(())
}
/// Complete the workflow with success message and service URLs
///
/// Loads environment info and displays:
/// 1. Service URLs (excluding localhost-only services)
/// 2. DNS hint for HTTPS/TLS services
/// 3. Tip to use `show` command for full details
///
/// Follows the same pattern as the show command for loading environment
/// and extracting service information.
#[allow(clippy::result_large_err)]
fn complete_workflow(
&mut self,
name: &str,
output_format: OutputFormat,
) -> Result<(), RunSubcommandError> {
// Load environment to get service information
let env_name = EnvironmentName::new(name.to_string()).map_err(|source| {
RunSubcommandError::InvalidEnvironmentName {
name: name.to_string(),
source,
}
})?;
let any_env = self.load_environment(&env_name)?;
// Display success message
self.progress
.complete(&format!("Run command completed for '{name}'"))?;
// Display service URLs and hints
self.display_service_urls(&any_env, output_format)?;
Ok(())
}
/// Load environment from repository
///
/// Reuses the same loading logic as the show command.
#[allow(clippy::result_large_err)]
fn load_environment(
&self,
env_name: &EnvironmentName,
) -> Result<AnyEnvironmentState, RunSubcommandError> {
if !self.repository.exists(env_name)? {
return Err(RunSubcommandError::EnvironmentNotAccessible {
name: env_name.to_string(),
data_dir: "data".to_string(),
});
}
self.repository.load(env_name)?.ok_or_else(|| {
RunSubcommandError::EnvironmentNotAccessible {
name: env_name.to_string(),
data_dir: "data".to_string(),
}
})
}
/// Display service URLs and DNS hints
///
/// Uses the Strategy Pattern to render output in the requested format:
/// - Text format: Uses `TextView` with `CompactServiceUrlsView` and `DnsHintView`
/// - JSON format: Uses `JsonView` for machine-readable output
///
/// # Architecture
///
/// Following the MVC pattern with functional composition:
/// - Model: `ServiceInfo` and `GrafanaInfo` (application layer DTOs)
/// - View: `TextView::render()` or `JsonView::render()` (formatting)
/// - Controller (this method): Orchestrates the pipeline
/// - Output: `ProgressReporter::result()` (routing to stdout)
#[allow(clippy::result_large_err)]
fn display_service_urls(
&mut self,
any_env: &AnyEnvironmentState,
output_format: OutputFormat,
) -> Result<(), RunSubcommandError> {
if let Some(instance_ip) = any_env.instance_ip() {
let tracker_config = any_env.tracker_config();
let grafana_config = any_env.grafana_config();
let services =
ServiceInfo::from_tracker_config(tracker_config, instance_ip, grafana_config);
let grafana =
grafana_config.map(|config| GrafanaInfo::from_config(config, instance_ip));
let data = RunDetailsData::new(any_env.name().to_string(), services, grafana);
// Render using appropriate view based on output format (Strategy Pattern)
let output = match output_format {
OutputFormat::Text => TextView::render(&data)?,
OutputFormat::Json => JsonView::render(&data)?,
};
// Pipeline: RunDetailsData → render → output to stdout
self.progress.result(&output)?;
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::infrastructure::persistence::file_repository_factory::FileRepositoryFactory;
use crate::presentation::cli::controllers::constants::DEFAULT_LOCK_TIMEOUT;
use crate::presentation::cli::input::cli::OutputFormat;
use crate::presentation::cli::views::testing::TestUserOutput;
use crate::presentation::cli::views::VerbosityLevel;
use crate::shared::SystemClock;
use tempfile::TempDir;
/// Create test dependencies for run command handler tests
#[allow(clippy::type_complexity)]
fn create_test_dependencies(
temp_dir: &TempDir,
) -> (
Arc<ReentrantMutex<RefCell<UserOutput>>>,
Arc<dyn EnvironmentRepository + Send + Sync>,
Arc<dyn Clock>,
) {
let (user_output, _, _) =
TestUserOutput::new(VerbosityLevel::Normal).into_reentrant_wrapped();
let data_dir = temp_dir.path().join("data");
let file_repository_factory = FileRepositoryFactory::new(DEFAULT_LOCK_TIMEOUT);
let repository = file_repository_factory.create(data_dir);
let clock = Arc::new(SystemClock);
(user_output, repository, clock)
}
#[tokio::test]
async fn it_should_return_error_for_invalid_environment_name() {
let temp_dir = TempDir::new().unwrap();
let (user_output, repository, clock) = create_test_dependencies(&temp_dir);
// Test with invalid environment name (contains underscore)
let result = RunCommandController::new(repository, clock, user_output.clone())
.execute("invalid_name", OutputFormat::Text)
.await;
assert!(result.is_err());
match result.unwrap_err() {
RunSubcommandError::InvalidEnvironmentName { name, .. } => {
assert_eq!(name, "invalid_name");
}
other => panic!("Expected InvalidEnvironmentName, got: {other:?}"),
}
}
#[tokio::test]
async fn it_should_return_error_for_empty_environment_name() {
let temp_dir = TempDir::new().unwrap();
let (user_output, repository, clock) = create_test_dependencies(&temp_dir);
let result = RunCommandController::new(repository, clock, user_output.clone())
.execute("", OutputFormat::Text)
.await;
assert!(result.is_err());
match result.unwrap_err() {
RunSubcommandError::InvalidEnvironmentName { name, .. } => {
assert_eq!(name, "");
}
other => panic!("Expected InvalidEnvironmentName, got: {other:?}"),
}
}
#[tokio::test]
async fn it_should_return_error_when_environment_not_found() {
let temp_dir = TempDir::new().unwrap();
let (user_output, repository, clock) = create_test_dependencies(&temp_dir);
// Valid environment name but doesn't exist
let result = RunCommandController::new(repository, clock, user_output.clone())
.execute("test-env", OutputFormat::Text)
.await;
assert!(result.is_err());
match result.unwrap_err() {
RunSubcommandError::EnvironmentNotAccessible { name, .. } => {
assert_eq!(name, "test-env");
}
other => panic!("Expected EnvironmentNotAccessible, got: {other:?}"),
}
}
}