add statistics route

ghubertpalo · Damien LACHAUME / PALO-IT · commit 3ed95f13478e · 2024-01-17T12:46:08.000+01:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/mithril-fake-aggregator/Cargo.toml b/mithril-fake-aggregator/Cargo.toml
@@ -23,3 +23,7 @@ tokio = { version = "1.35.0", features = ["full"] }
 tower-http = { version = "0.5.0", features = ["trace"] }
 tracing = "0.1.40"
 tracing-subscriber = "0.3.18"
+
+[dev-dependencies]
+mithril-common = { path = "../mithril-common", features = ["full"] }
+reqwest = "0.11.23"
diff --git a/mithril-fake-aggregator/README.md b/mithril-fake-aggregator/README.md
@@ -0,0 +1,46 @@
+# Mithril Fake Aggregator
+
+This software is made to test Mithril Client nodes in isolated situations where no real Mithril Aggregator can be reached. It serves a static set of data that can be loaded at start time.
+
+## Fake API
+
+For now, the following routes are implemented:
+
+ * GET /aggregator/epoch-settings
+ * GET /aggregator/certificates
+ * GET /aggregator/certificate/:hash
+ * GET /aggregator/artifact/snapshots
+ * GET /aggregator/artifact/snapshot/:digest
+ * GET /aggregator/artifact/mithril-stake-distributions/
+ * GET /aggregator/artifact/mithril-stake-distribution/:hash
+
+## Data fixtures
+
+It is either possible to use default data provided with the binary or to load a static set of data at start up using the `-d` or `--data-dir` option. When set the given directory is scanned for the following files:
+
+ * certificates.json
+ * snapshots.json
+ * mithril-stake-distributions.json
+
+For each file, the identifiers of the corresponding artifacts are extracted and the following files are read:
+
+ * certificate-{hash}.json
+ * snapshot-{digest}.json
+ * mithril-stake-distribution-{hash}.json
+
+If a file is missing or incomplete, the software will stop with an error message.
+
+## Command line synopsis
+
+Usage: `mithril-fake-aggregator [OPTIONS]`
+
+Options:
+
+```
+  -d, --data-directory <DATA_DIRECTORY>  Directory where the response files are located
+  -v, --verbose...                       Verbose mode (-q, -v, -vv, -vvv, etc)
+  -p, --tcp-port <TCP_PORT>              TCP port to listen on [default: 80]
+  -i, --ip-address <IP_ADDRESS>          IP Address to bind server to [default: 127.0.0.1]
+  -h, --help                             Print help
+  -V, --version                          Print version
+```
diff --git a/mithril-fake-aggregator/src/handlers.rs b/mithril-fake-aggregator/src/handlers.rs
@@ -1,7 +1,7 @@
 use axum::{
     body::Body,
     extract::{Path, State},
-    http::Response,
+    http::{Response, StatusCode},
     response::IntoResponse,
 };
 
@@ -74,3 +74,9 @@ pub async fn certificate(
         .map(|s| s.into_response())
         .ok_or_else(|| AppError::NotFound(format!("certificate hash={key}")))
 }
+
+pub async fn statistics() -> Result<Response<Body>, AppError> {
+    let response = Response::builder().status(StatusCode::CREATED);
+
+    response.body(String::new().into()).map_err(|e| e.into())
+}
diff --git a/mithril-fake-aggregator/src/main.rs b/mithril-fake-aggregator/src/main.rs
@@ -10,7 +10,7 @@ use axum::{
     http::{HeaderValue, Response, StatusCode},
     middleware::{self, Next},
     response::IntoResponse,
-    routing::get,
+    routing::{get, post},
     Router,
 };
 use clap::Parser;
@@ -35,7 +35,7 @@ pub struct CliArguments {
     #[arg(short, long)]
     data_directory: Option<PathBuf>,
 
-    /// Verbose mode (-q, -v, -vv, -vvv, etc)
+    /// Verbosity level  (-v WARN, -vv INFO, -vvv DEBUG, etc)
     #[arg(short, long, action = clap::ArgAction::Count)]
     verbose: u8,
 
@@ -46,16 +46,24 @@ pub struct CliArguments {
     /// IP Address to bind server to
     #[arg(short, long, default_value = "127.0.0.1")]
     ip_address: String,
+
+    /// Quiet mode, no log will be emitted. Critical error messages will still pop on STDERR
+    #[arg(short, long, default_value_t = false)]
+    quiet: bool,
 }
 
 impl CliArguments {
-    pub fn get_verbosity_level(&self) -> Level {
-        match self.verbose {
-            0 => Level::ERROR,
-            1 => Level::WARN,
-            2 => Level::INFO,
-            3 => Level::DEBUG,
-            _ => Level::TRACE,
+    pub fn get_verbosity_level(&self) -> Option<Level> {
+        if self.quiet {
+            None
+        } else {
+            match self.verbose {
+                0 => Some(Level::ERROR),
+                1 => Some(Level::WARN),
+                2 => Some(Level::INFO),
+                3 => Some(Level::DEBUG),
+                _ => Some(Level::TRACE),
+            }
         }
     }
 }
@@ -121,9 +129,10 @@ impl OsSignalHandler {
 #[tokio::main]
 async fn main() -> StdResult<()> {
     let params = CliArguments::parse();
-    tracing_subscriber::fmt()
-        .with_max_level(params.get_verbosity_level())
-        .init();
+
+    if let Some(level) = params.get_verbosity_level() {
+        tracing_subscriber::fmt().with_max_level(level).init();
+    }
 
     let result = Application::run(params).await;
 
@@ -180,13 +189,17 @@ impl Application {
             )
             .route("/aggregator/certificates", get(handlers::certificates))
             .route("/aggregator/certificate/:hash", get(handlers::certificate))
+            .route(
+                "/aggregator/statistics/snapshot",
+                post(handlers::statistics),
+            )
             .with_state(shared_state.clone())
             .layer(middleware::from_fn(set_json_app_header))
             .layer(
                 TraceLayer::new_for_http()
                     .make_span_with(
                         DefaultMakeSpan::new()
-                            .include_headers(true)
+                            .include_headers(false)
                             .level(Level::DEBUG),
                     )
                     .on_request(DefaultOnRequest::new().level(Level::DEBUG))
@@ -199,7 +212,7 @@ impl Application {
             );
         let listener = {
             let connection_string = format!("{}:{}", params.ip_address, params.tcp_port);
-            info!("binding on {connection_string}");
+            debug!("binding on {connection_string}");
             tokio::net::TcpListener::bind(&connection_string)
                 .await
                 .with_context(|| format!("Could not listen on '{}'.", connection_string))?
@@ -234,3 +247,6 @@ async fn set_json_app_header(
 
     Ok(res)
 }
+
+#[cfg(test)]
+mod tests {}
