From d8a9f7b358ce0b8cbf806d188a8c89abb4f54ffd Mon Sep 17 00:00:00 2001
From: Jose Celano <josecelano@gmail.com>
Date: Tue, 30 Jan 2024 10:19:22 +0000
Subject: [PATCH] refactor: [#661] move E2E tests runner mod

---
 src/bin/e2e_tests_runner.rs                   |  6 +-----
 src/{ => console/ci}/e2e/docker.rs            |  0
 src/{ => console/ci}/e2e/logs_parser.rs       |  0
 src/{ => console/ci}/e2e/mod.rs               |  1 +
 src/{ => console/ci}/e2e/runner.rs            | 11 ++++++++---
 src/{ => console/ci}/e2e/tracker_checker.rs   |  0
 src/{ => console/ci}/e2e/tracker_container.rs |  2 +-
 src/console/ci/mod.rs                         |  2 ++
 src/console/clients/mod.rs                    |  1 +
 src/console/mod.rs                            |  3 +++
 src/lib.rs                                    |  2 +-
 11 files changed, 18 insertions(+), 10 deletions(-)
 rename src/{ => console/ci}/e2e/docker.rs (100%)
 rename src/{ => console/ci}/e2e/logs_parser.rs (100%)
 rename src/{ => console/ci}/e2e/mod.rs (82%)
 rename src/{ => console/ci}/e2e/runner.rs (93%)
 rename src/{ => console/ci}/e2e/tracker_checker.rs (100%)
 rename src/{ => console/ci}/e2e/tracker_container.rs (98%)
 create mode 100644 src/console/ci/mod.rs
 create mode 100644 src/console/clients/mod.rs
 create mode 100644 src/console/mod.rs

diff --git a/src/bin/e2e_tests_runner.rs b/src/bin/e2e_tests_runner.rs
index 35368b61..b21459d2 100644
--- a/src/bin/e2e_tests_runner.rs
+++ b/src/bin/e2e_tests_runner.rs
@@ -1,9 +1,5 @@
 //! Program to run E2E tests.
-//!
-//! ```text
-//! cargo run --bin e2e_tests_runner share/default/config/tracker.e2e.container.sqlite3.toml
-//! ```
-use torrust_tracker::e2e;
+use torrust_tracker::console::ci::e2e;
 
 fn main() {
     e2e::runner::run();
diff --git a/src/e2e/docker.rs b/src/console/ci/e2e/docker.rs
similarity index 100%
rename from src/e2e/docker.rs
rename to src/console/ci/e2e/docker.rs
diff --git a/src/e2e/logs_parser.rs b/src/console/ci/e2e/logs_parser.rs
similarity index 100%
rename from src/e2e/logs_parser.rs
rename to src/console/ci/e2e/logs_parser.rs
diff --git a/src/e2e/mod.rs b/src/console/ci/e2e/mod.rs
similarity index 82%
rename from src/e2e/mod.rs
rename to src/console/ci/e2e/mod.rs
index e4384e16..58a876cb 100644
--- a/src/e2e/mod.rs
+++ b/src/console/ci/e2e/mod.rs
@@ -1,3 +1,4 @@
+//! E2E tests scripts.
 pub mod docker;
 pub mod logs_parser;
 pub mod runner;
diff --git a/src/e2e/runner.rs b/src/console/ci/e2e/runner.rs
similarity index 93%
rename from src/e2e/runner.rs
rename to src/console/ci/e2e/runner.rs
index a4bcb3aa..1a474680 100644
--- a/src/e2e/runner.rs
+++ b/src/console/ci/e2e/runner.rs
@@ -1,9 +1,14 @@
+//! Program to run E2E tests.
+//!
+//! ```text
+//! cargo run --bin e2e_tests_runner share/default/config/tracker.e2e.container.sqlite3.toml
+//! ```
 use log::{debug, info, LevelFilter};
 
 use super::tracker_container::TrackerContainer;
-use crate::e2e::docker::RunOptions;
-use crate::e2e::logs_parser::RunningServices;
-use crate::e2e::tracker_checker::{self};
+use crate::console::ci::e2e::docker::RunOptions;
+use crate::console::ci::e2e::logs_parser::RunningServices;
+use crate::console::ci::e2e::tracker_checker::{self};
 
 /* code-review:
      - We use always the same docker image name. Should we use a random image name (tag)?
diff --git a/src/e2e/tracker_checker.rs b/src/console/ci/e2e/tracker_checker.rs
similarity index 100%
rename from src/e2e/tracker_checker.rs
rename to src/console/ci/e2e/tracker_checker.rs
diff --git a/src/e2e/tracker_container.rs b/src/console/ci/e2e/tracker_container.rs
similarity index 98%
rename from src/e2e/tracker_container.rs
rename to src/console/ci/e2e/tracker_container.rs
index 3e70942b..5a4d11d0 100644
--- a/src/e2e/tracker_container.rs
+++ b/src/console/ci/e2e/tracker_container.rs
@@ -6,7 +6,7 @@ use rand::Rng;
 
 use super::docker::{RunOptions, RunningContainer};
 use super::logs_parser::RunningServices;
-use crate::e2e::docker::Docker;
+use crate::console::ci::e2e::docker::Docker;
 
 #[derive(Debug)]
 pub struct TrackerContainer {
diff --git a/src/console/ci/mod.rs b/src/console/ci/mod.rs
new file mode 100644
index 00000000..6eac3e12
--- /dev/null
+++ b/src/console/ci/mod.rs
@@ -0,0 +1,2 @@
+//! Continuos integration scripts.
+pub mod e2e;
diff --git a/src/console/clients/mod.rs b/src/console/clients/mod.rs
new file mode 100644
index 00000000..a3fd318b
--- /dev/null
+++ b/src/console/clients/mod.rs
@@ -0,0 +1 @@
+//! Console clients.
diff --git a/src/console/mod.rs b/src/console/mod.rs
new file mode 100644
index 00000000..54ed8e41
--- /dev/null
+++ b/src/console/mod.rs
@@ -0,0 +1,3 @@
+//! Console apps.
+pub mod ci;
+pub mod clients;
diff --git a/src/lib.rs b/src/lib.rs
index f239039b..398795d3 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -472,8 +472,8 @@
 pub mod app;
 pub mod bootstrap;
 pub mod checker;
+pub mod console;
 pub mod core;
-pub mod e2e;
 pub mod servers;
 pub mod shared;