Skip to content

Commit 59b165f

Browse files
Copilotjosecelano
andcommitted
docs: update codebase-architecture.md for new module structure
- Document src/bootstrap/ module with all bootstrap files - Document src/testing/network/ with network testing utilities - Update shared layer documentation to reflect removed port checkers - Fix logging integration test import Co-authored-by: josecelano <58816+josecelano@users.noreply.github.com>
1 parent 1f320b9 commit 59b165f

File tree

2 files changed

+26
-10
lines changed

2 files changed

+26
-10
lines changed

docs/codebase-architecture.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -189,11 +189,19 @@ All modules include comprehensive `//!` documentation with:
189189

190190
### Core Infrastructure
191191

192+
**Bootstrap Module:**
193+
194+
Application initialization and lifecycle management:
195+
196+
-`src/bootstrap/mod.rs` - Bootstrap module root with re-exports
197+
-`src/bootstrap/app.rs` - Main application bootstrap and entry point logic
198+
-`src/bootstrap/container.rs` - Dependency injection container (Services)
199+
-`src/bootstrap/help.rs` - Help and usage information display
200+
-`src/bootstrap/logging.rs` - Logging configuration and utilities
201+
192202
**Root Level Files:**
193203

194204
-`src/main.rs` - Main binary entry point
195-
-`src/container.rs` - Dependency injection container
196-
-`src/logging.rs` - Logging configuration and utilities
197205
-`src/lib.rs` - Library root module
198206

199207
**Binary Files:**
@@ -359,20 +367,28 @@ Generic utilities used across all layers:
359367
-`src/shared/command/mod.rs` - Command execution utilities (used by all adapters)
360368
-`src/shared/clock.rs` - Time abstraction for deterministic testing
361369
-`src/shared/error/mod.rs` - Shared error types
362-
-`src/shared/port_checker.rs` - Network port checking
363-
-`src/shared/port_usage_checker.rs` - Port usage validation
364370
-`src/shared/username.rs` - Username value object
365371

366-
Note: SSH and Docker adapters have been moved to `src/adapters/`
372+
Note: SSH and Docker adapters have been moved to `src/adapters/`. Network testing utilities (port_checker, port_usage_checker) have been moved to `src/testing/network/`.
367373

368374
### Testing Infrastructure
369375

370376
**E2E Testing Framework:**
371377

372-
-`src/e2e/mod.rs` - E2E testing framework coordination
373-
-`src/e2e/containers/mod.rs` - Container-based testing infrastructure
374-
-`src/e2e/containers/actions/` - E2E test actions
375-
-`src/e2e/containers/provisioned.rs` - Provisioned container management
378+
-`src/testing/mod.rs` - Testing framework root module
379+
-`src/testing/e2e/mod.rs` - E2E testing framework coordination
380+
-`src/testing/e2e/containers/mod.rs` - Container-based testing infrastructure
381+
-`src/testing/e2e/containers/actions/` - E2E test actions
382+
-`src/testing/e2e/containers/provisioned.rs` - Provisioned container management
383+
-`src/testing/integration/` - Integration testing utilities
384+
-`src/testing/fixtures.rs` - Reusable test fixtures
385+
-`src/testing/mock_clock.rs` - Mock clock implementation for deterministic testing
386+
387+
**Network Testing Utilities:**
388+
389+
-`src/testing/network/mod.rs` - Network testing utilities root
390+
-`src/testing/network/port_checker.rs` - TCP port connectivity checking
391+
-`src/testing/network/port_usage_checker.rs` - Port usage validation and process identification
376392

377393
**Configuration:**
378394

tests/logging_integration.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ use std::fs;
1717
use std::path::PathBuf;
1818
use std::process::Command;
1919
use tempfile::TempDir;
20-
use torrust_tracker_deployer_lib::logging::LOG_FILE_NAME;
20+
use torrust_tracker_deployer_lib::bootstrap::logging::LOG_FILE_NAME;
2121

2222
/// Helper struct to manage test execution and cleanup
2323
struct LoggingTest {

0 commit comments

Comments
 (0)