mithril_client_cli/commands/cardano_db_v2/
show.rs

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
use anyhow::{anyhow, Context};
use clap::Parser;
use cli_table::{print_stdout, Cell, CellStruct, Table};

use crate::{
    commands::{client_builder_with_fallback_genesis_key, SharedArgs},
    utils::{CardanoDbUtils, ExpanderUtils},
    CommandContext,
};

use mithril_client::{
    common::{AncillaryLocation, DigestLocation, ImmutablesLocation, MultiFilesUri},
    MithrilResult,
};

/// Clap command to show a given cardano db
#[derive(Parser, Debug, Clone)]
pub struct CardanoDbShowCommand {
    #[clap(flatten)]
    shared_args: SharedArgs,

    /// Cardano DB snapshot hash.
    ///
    /// If `latest` is specified as hash, the command will return the latest cardano db snapshot.
    hash: String,
}

impl CardanoDbShowCommand {
    /// Is JSON output enabled
    pub fn is_json_output_enabled(&self) -> bool {
        self.shared_args.json
    }

    /// Cardano DB snapshot Show command
    pub async fn execute(&self, context: CommandContext) -> MithrilResult<()> {
        let params = context.config_parameters()?;
        let client = client_builder_with_fallback_genesis_key(&params)?
            .with_logger(context.logger().clone())
            .build()?;

        let get_list_of_artifact_ids = || async {
            let cardano_dbs = client.cardano_database().list().await.with_context(|| {
                "Can not get the list of artifacts while retrieving the latest cardano db snapshot hash"
            })?;

            Ok(cardano_dbs
                .iter()
                .map(|cardano_db| cardano_db.hash.to_owned())
                .collect::<Vec<String>>())
        };

        let cardano_db_message = client
            .cardano_database()
            .get(
                &ExpanderUtils::expand_eventual_id_alias(&self.hash, get_list_of_artifact_ids())
                    .await?,
            )
            .await?
            .ok_or_else(|| anyhow!("Cardano DB snapshot not found for hash: '{}'", &self.hash))?;

        if self.is_json_output_enabled() {
            println!("{}", serde_json::to_string(&cardano_db_message)?);
        } else {
            let mut cardano_db_table = vec![
                vec![
                    "Epoch".cell(),
                    format!("{}", &cardano_db_message.beacon.epoch).cell(),
                ],
                vec![
                    "Immutable File Number".cell(),
                    format!("{}", &cardano_db_message.beacon.immutable_file_number).cell(),
                ],
                vec!["Hash".cell(), cardano_db_message.hash.cell()],
                vec!["Merkle root".cell(), cardano_db_message.merkle_root.cell()],
                vec![
                    "Database size".cell(),
                    CardanoDbUtils::format_bytes_to_gigabytes(
                        cardano_db_message.total_db_size_uncompressed,
                    )
                    .cell(),
                ],
                vec![
                    "Cardano node version".cell(),
                    cardano_db_message.cardano_node_version.cell(),
                ],
            ];

            cardano_db_table.append(&mut digest_location_rows(
                &cardano_db_message.locations.digests,
            ));

            cardano_db_table.append(&mut immutables_location_rows(
                &cardano_db_message.locations.immutables,
            ));

            cardano_db_table.append(&mut ancillary_location_rows(
                &cardano_db_message.locations.ancillary,
            ));

            cardano_db_table.push(vec![
                "Created".cell(),
                cardano_db_message.created_at.to_string().cell(),
            ]);
            cardano_db_table.push(vec![
                "Compression Algorithm".cell(),
                format!("{}", &cardano_db_message.compression_algorithm).cell(),
            ]);

            print_stdout(cardano_db_table.table())?;
        }

        Ok(())
    }
}

fn digest_location_iter(locations: &[DigestLocation]) -> impl Iterator<Item = String> + use<'_> {
    locations.iter().filter_map(|location| match location {
        DigestLocation::Aggregator { uri } => Some(format!("Aggregator, uri: \"{}\"", uri)),
        DigestLocation::CloudStorage { uri } => Some(format!("CloudStorage, uri: \"{}\"", uri)),
        DigestLocation::Unknown => None,
    })
}

fn digest_location_rows(locations: &[DigestLocation]) -> Vec<Vec<CellStruct>> {
    format_location_rows("Digest location", digest_location_iter(locations))
}

fn immutables_location_iter(
    locations: &[ImmutablesLocation],
) -> impl Iterator<Item = String> + use<'_> {
    locations.iter().filter_map(|location| match location {
        ImmutablesLocation::CloudStorage { uri } => match uri {
            MultiFilesUri::Template(template_uri) => Some(format!(
                "CloudStorage, template_uri: \"{}\"",
                template_uri.0
            )),
        },
        ImmutablesLocation::Unknown => None,
    })
}

fn immutables_location_rows(locations: &[ImmutablesLocation]) -> Vec<Vec<CellStruct>> {
    format_location_rows("Immutables location", immutables_location_iter(locations))
}

fn ancillary_location_iter(
    locations: &[AncillaryLocation],
) -> impl Iterator<Item = String> + use<'_> {
    locations.iter().filter_map(|location| match location {
        AncillaryLocation::CloudStorage { uri } => Some(format!("CloudStorage, uri: \"{uri}\"")),
        AncillaryLocation::Unknown => None,
    })
}

fn ancillary_location_rows(locations: &[AncillaryLocation]) -> Vec<Vec<CellStruct>> {
    format_location_rows("Ancillary location", ancillary_location_iter(locations))
}

fn format_location_rows(
    location_name: &str,
    locations: impl Iterator<Item = String>,
) -> Vec<Vec<CellStruct>> {
    locations
        .enumerate()
        .map(|(index, cell_content)| {
            vec![
                format!("{location_name} ({})", index + 1).cell(),
                cell_content.cell(),
            ]
        })
        .collect()
}

#[cfg(test)]
mod tests {
    use mithril_client::common::TemplateUri;

    use super::*;

    #[test]
    fn digest_location_rows_when_no_uri_found() {
        let rows = digest_location_rows(&[]);

        assert!(rows.is_empty());
    }

    #[test]
    fn digest_location_rows_when_uris_found() {
        let locations = vec![
            DigestLocation::Aggregator {
                uri: "http://aggregator.net/".to_string(),
            },
            DigestLocation::CloudStorage {
                uri: "http://cloudstorage.com/".to_string(),
            },
        ];

        let rows = digest_location_rows(&locations);
        assert!(rows.len() == 2);

        let table = rows.table();
        let rows_rendered = table.display().unwrap().to_string();

        assert!(rows_rendered.contains("Digest location (1)"));
        assert!(rows_rendered.contains("CloudStorage, uri: \"http://cloudstorage.com/\""));
        assert!(rows_rendered.contains("Digest location (2)"));
        assert!(rows_rendered.contains("Aggregator, uri: \"http://aggregator.net/\""));
    }

    #[test]
    fn digest_location_rows_display_and_count_only_known_location() {
        let locations = vec![
            DigestLocation::Unknown,
            DigestLocation::CloudStorage {
                uri: "http://cloudstorage.com/".to_string(),
            },
        ];

        let rows = digest_location_rows(&locations);
        assert_eq!(1, rows.len());

        let rows_rendered = rows.table().display().unwrap().to_string();
        assert!(rows_rendered.contains("Digest location (1)"));
    }

    #[test]
    fn immutables_location_rows_when_no_uri_found() {
        let rows = immutables_location_rows(&[]);

        assert!(rows.is_empty());
    }

    #[test]
    fn immutables_location_row_returns_some_when_uri_found() {
        let locations = vec![
            ImmutablesLocation::CloudStorage {
                uri: MultiFilesUri::Template(TemplateUri("http://cloudstorage1.com/".to_string())),
            },
            ImmutablesLocation::CloudStorage {
                uri: MultiFilesUri::Template(TemplateUri("http://cloudstorage2.com/".to_string())),
            },
        ];

        let rows = immutables_location_rows(&locations);

        assert!(rows.len() == 2);

        let table = rows.table();
        let rows_rendered = table.display().unwrap().to_string();

        assert!(rows_rendered.contains("Immutables location (1)"));
        assert!(rows_rendered.contains("CloudStorage, template_uri: \"http://cloudstorage1.com/\""));
        assert!(rows_rendered.contains("Immutables location (2)"));
        assert!(rows_rendered.contains("CloudStorage, template_uri: \"http://cloudstorage2.com/\""));
    }

    #[test]
    fn immutables_location_row_display_and_count_only_known_location() {
        let locations = vec![
            ImmutablesLocation::Unknown {},
            ImmutablesLocation::CloudStorage {
                uri: MultiFilesUri::Template(TemplateUri("http://cloudstorage2.com/".to_string())),
            },
        ];

        let rows = immutables_location_rows(&locations);
        assert_eq!(1, rows.len());

        let rows_rendered = rows.table().display().unwrap().to_string();
        assert!(rows_rendered.contains("Immutables location (1)"));
    }

    #[test]
    fn ancillary_location_rows_when_no_uri_found() {
        let rows = ancillary_location_rows(&[]);

        assert!(rows.is_empty());
    }

    #[test]
    fn ancillary_location_rows_when_uris_found() {
        let locations = vec![
            AncillaryLocation::CloudStorage {
                uri: "http://cloudstorage1.com/".to_string(),
            },
            AncillaryLocation::CloudStorage {
                uri: "http://cloudstorage2.com/".to_string(),
            },
        ];

        let rows = ancillary_location_rows(&locations);

        assert!(rows.len() == 2);

        let table = rows.table();
        let rows_rendered = table.display().unwrap().to_string();

        assert!(rows_rendered.contains("Ancillary location (1)"));
        assert!(rows_rendered.contains("CloudStorage, uri: \"http://cloudstorage1.com/\""));
        assert!(rows_rendered.contains("Ancillary location (2)"));
        assert!(rows_rendered.contains("CloudStorage, uri: \"http://cloudstorage2.com/\""));
    }

    #[test]
    fn ancillary_location_rows_display_and_count_only_known_location() {
        let locations = vec![
            AncillaryLocation::Unknown {},
            AncillaryLocation::CloudStorage {
                uri: "http://cloudstorage2.com/".to_string(),
            },
        ];

        let rows = ancillary_location_rows(&locations);
        assert_eq!(1, rows.len());

        let rows_rendered = rows.table().display().unwrap().to_string();
        assert!(rows_rendered.contains("Ancillary location (1)"));
    }
}