qnap 0.1.8

CLI for QNAP NAS management — human-friendly output and JSON mode for agent use
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

use anyhow::Result;
use serde::{Deserialize, Serialize};

use crate::client::QnapClient;
use crate::output::{ShareRow, print_shares};

#[derive(Debug, Deserialize)]
struct ShareEntry {
    id: String,
    text: String,
    real_total: Option<u64>,
}

#[derive(Debug, Serialize, PartialEq)]
struct ShareOutput {
    name: String,
    path: String,
    items_count: Option<u64>,
}

pub async fn run(client: &QnapClient, json: bool) -> Result<()> {
    let entries: Vec<ShareEntry> = client
        .get_json(
            "/cgi-bin/filemanager/utilRequest.cgi",
            &[("func", "get_tree"), ("node", "share_root")],
        )
        .await?;

    let rows: Vec<ShareOutput> = entries
        .into_iter()
        .map(|entry| ShareOutput {
            name: entry.text,
            path: entry.id,
            items_count: entry.real_total,
        })
        .collect();

    if json {
        println!(
            "{}",
            serde_json::to_string_pretty(&rows).unwrap_or_default()
        );
        return Ok(());
    }

    let table_rows: Vec<ShareRow> = rows
        .iter()
        .map(|row| ShareRow {
            name: row.name.clone(),
            path: row.path.clone(),
            items: row
                .items_count
                .map(|value| value.to_string())
                .unwrap_or_else(|| "-".to_string()),
        })
        .collect();
    print_shares(&table_rows);
    Ok(())
}

#[cfg(test)]
mod fixture_tests {
    use super::*;

    const SHARES: &str = include_str!("../../tests/fixtures/ts-xa28a-qts52/shares.json");

    #[test]
    fn fixture_shares_parses() {
        let entries: Vec<ShareEntry> =
            serde_json::from_str(SHARES).expect("failed to parse shares fixture");
        assert!(!entries.is_empty(), "no shares found in fixture");
    }

    #[test]
    fn fixture_shares_have_id_and_name() {
        let entries: Vec<ShareEntry> = serde_json::from_str(SHARES).unwrap();
        for entry in &entries {
            assert!(!entry.id.is_empty(), "share entry has empty id");
            assert!(!entry.text.is_empty(), "share entry has empty text");
        }
    }

    #[test]
    fn fixture_shares_output_is_typed() {
        let entries: Vec<ShareEntry> = serde_json::from_str(SHARES).unwrap();
        let rows: Vec<ShareOutput> = entries
            .into_iter()
            .map(|entry| ShareOutput {
                name: entry.text,
                path: entry.id,
                items_count: entry.real_total,
            })
            .collect();
        assert_eq!(rows[0].items_count, Some(2));
    }
}