feat: add support for the /status route in mithril-aggregator-fake

Update documentation to reflect new aggregator stores directory with leader/follower feature

Author: dlachaume

internal/mithril-build-script/src/fake_aggregator.rs

@@ -14,6 +14,8 @@ pub type FileContent = String;
 /// of the fake aggregator.
 #[derive(Debug, Default)]
 pub struct FakeAggregatorData {
+    status: FileContent,
+
     epoch_settings: FileContent,
 
     certificates_list: FileContent,
@@ -50,6 +52,9 @@ impl FakeAggregatorData {
             });
 
             match filename.as_str() {
+                "status.json" => {
+                    data.status = file_content;
+                }
                 "epoch-settings.json" => {
                     data.epoch_settings = file_content;
                 }
@@ -155,6 +160,7 @@ impl FakeAggregatorData {
     pub fn generate_code_for_all_data(self) -> String {
         Self::assemble_code(
             &[
+                generate_list_getter("status", self.status),
                 generate_list_getter("epoch_settings", self.epoch_settings),
                 generate_ids_array(
                     "snapshot_digests",

mithril-test-lab/mithril-aggregator-fake/README.md

@@ -54,7 +54,7 @@ In another terminal:
 ```
 WORKING_DIR_END_TO_END=[SELECT A PATH]
 JSON_OUTPUT=./default_data
-TRANSACTION_HASH_SAMPLE=$(sqlite3 $WORKING_DIR_END_TO_END/stores/aggregator/cardano-transaction.sqlite3 "select transaction_hash from cardano_tx")
+TRANSACTION_HASH_SAMPLE=$(sqlite3 $WORKING_DIR_END_TO_END/stores/aggregator-1/cardano-transaction.sqlite3 "select transaction_hash from cardano_tx")
 
 ./scripts/import.sh $JSON_OUTPUT http://localhost:8080/aggregator "$TRANSACTION_HASH_SAMPLE"
 ```

mithril-test-lab/mithril-aggregator-fake/scripts/import.sh

@@ -200,6 +200,9 @@ export DATA_DIR URL;
 check_requirements;
 clean_directory;
 
+echo "Downloading aggregator status"
+download_data "$BASE_URL/status" "status"
+
 echo "Downloading epoch-settings"
 download_data "$BASE_URL/epoch-settings" "epoch-settings"
 

mithril-test-lab/mithril-aggregator-fake/src/application.rs

@@ -704,4 +704,29 @@ mod tests {
 
         test(task, PORT).await;
     }
+
+    #[tokio::test]
+    async fn get_status() {
+        const PORT: u16 = 3023;
+        let task = tokio::spawn(async move {
+            // Yield back to Tokio's scheduler to ensure the web server is ready before going on.
+            yield_now().await;
+
+            let path = "/status";
+            let response = http_request(PORT, path).await;
+
+            APISpec::verify_conformity(
+                get_spec_file(),
+                "GET",
+                path,
+                "application/json",
+                &Null,
+                &response,
+                &StatusCode::OK,
+            )
+            .map_err(|e| anyhow!(e))
+        });
+
+        test(task, PORT).await;
+    }
 }

mithril-test-lab/mithril-aggregator-fake/src/handlers.rs

@@ -23,6 +23,7 @@ use crate::shared_state::SharedState;
 
 pub async fn aggregator_router() -> Router<SharedState> {
     Router::new()
+        .route("/status", get(status))
         .route("/epoch-settings", get(epoch_settings))
         .route("/artifact/snapshots", get(snapshots))
         .route(
@@ -81,6 +82,14 @@ pub async fn aggregator_router() -> Router<SharedState> {
         )
 }
 
+/// HTTP: Return the aggregator status.
+pub async fn status(State(state): State<SharedState>) -> Result<String, AppError> {
+    let app_state = state.read().await;
+    let status = app_state.get_status().await?;
+
+    Ok(status)
+}
+
 /// HTTP: Return the Epoch Settings.
 pub async fn epoch_settings(State(state): State<SharedState>) -> Result<String, AppError> {
     let app_state = state.read().await;

mithril-test-lab/mithril-aggregator-fake/src/shared_state.rs

@@ -11,6 +11,7 @@ use tracing::{debug, trace};
 use crate::{StdResult, default_values};
 
 pub struct AppState {
+    status: String,
     epoch_settings: String,
     certificate_list: String,
     certificates: BTreeMap<String, String>,
@@ -40,6 +41,7 @@ impl From<AppState> for SharedState {
 impl Default for AppState {
     fn default() -> Self {
         Self {
+            status: default_values::status().to_owned(),
             epoch_settings: default_values::epoch_settings().to_owned(),
             certificate_list: default_values::certificate_list().to_owned(),
             certificates: default_values::certificates(),
@@ -67,6 +69,7 @@ impl AppState {
     /// This will fail if some files are missing or are inconsistent.
     pub fn from_directory(data_dir: &Path) -> StdResult<Self> {
         let reader = DataDir::new(data_dir)?;
+        let status = reader.read_file("status")?;
         let epoch_settings = reader.read_file("epoch-settings")?;
         let (certificate_list, certificates) = reader.read_files("certificate")?;
         let (snapshot_list, snapshots) = reader.read_files("snapshot")?;
@@ -81,6 +84,7 @@ impl AppState {
             reader.read_files("cardano-database")?;
 
         let instance = Self {
+            status,
             epoch_settings,
             certificate_list,
             certificates,
@@ -100,6 +104,11 @@ impl AppState {
         Ok(instance)
     }
 
+    /// return the aggregator status
+    pub async fn get_status(&self) -> StdResult<String> {
+        Ok(self.status.clone())
+    }
+
     /// return the compiled epoch settings
     pub async fn get_epoch_settings(&self) -> StdResult<String> {
         Ok(self.epoch_settings.clone())