sendword 0.8.7

Simple HTTP webhook to command runner sidecar. Frontend for managing hooks, JSON state for config portability, SQLite for execution history and logs.
Documentation 
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

use std::fs;
use std::io;
use std::path::Path;

use flate2::Compression;
use flate2::read::GzDecoder;
use flate2::write::GzEncoder;
use tar::{Archive, Builder};

/// Create a `.tar.gz` archive containing the config file, optional JSON overlay,
/// and the SQLite DB snapshot. Returns the number of bytes written.
///
/// File layout inside the archive:
/// - `sendword.toml` (from `config_path`)
/// - `sendword.db`   (from `db_snapshot_path`)
pub fn create_tarball(
    config_path: &Path,
    db_snapshot_path: &Path,
    output_path: &Path,
) -> io::Result<()> {
    let output_file = fs::File::create(output_path)?;
    let gz = GzEncoder::new(output_file, Compression::default());
    let mut archive = Builder::new(gz);

    // Add config file as sendword.toml
    let config_name = config_path
        .file_name()
        .and_then(|n| n.to_str())
        .unwrap_or("sendword.toml");
    archive.append_path_with_name(config_path, config_name)?;

    // Add DB snapshot as sendword.db
    archive.append_path_with_name(db_snapshot_path, "sendword.db")?;

    archive.into_inner()?.finish()?;
    Ok(())
}

/// Extract a `.tar.gz` archive to the given output directory.
pub fn extract_tarball(tarball_path: &Path, output_dir: &Path) -> io::Result<()> {
    fs::create_dir_all(output_dir)?;
    let file = fs::File::open(tarball_path)?;
    let gz = GzDecoder::new(file);
    let mut archive = Archive::new(gz);
    archive.unpack(output_dir)?;
    Ok(())
}

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

    #[test]
    fn create_and_extract_roundtrip() {
        let tmp = tempfile::TempDir::new().expect("temp dir");

        // Create dummy config and DB files
        let config_path = tmp.path().join("sendword.toml");
        let db_path = tmp.path().join("sendword.db");
        fs::write(&config_path, b"[server]\nport = 8080\n").expect("write config");
        fs::write(&db_path, b"SQLITE_FAKE_DB").expect("write db");

        let tarball_path = tmp.path().join("backup.tar.gz");
        create_tarball(&config_path, &db_path, &tarball_path).expect("create tarball");

        assert!(tarball_path.exists(), "tarball should be created");

        let extract_dir = tmp.path().join("extracted");
        extract_tarball(&tarball_path, &extract_dir).expect("extract tarball");

        let extracted_config = fs::read(extract_dir.join("sendword.toml")).expect("read config");
        assert_eq!(extracted_config, b"[server]\nport = 8080\n");

        let extracted_db = fs::read(extract_dir.join("sendword.db")).expect("read db");
        assert_eq!(extracted_db, b"SQLITE_FAKE_DB");
    }

    /// A tarball that doesn't include sendword.json (no JSON config overlay) should
    /// extract without error. The caller is responsible for deciding if the absence
    /// of config.json is acceptable — the extraction step itself must not fail.
    #[test]
    fn extract_handles_missing_json_config() {
        let tmp = tempfile::TempDir::new().expect("temp dir");

        // Build a tarball that contains only the TOML config and the DB snapshot.
        // There is no sendword.json in this archive.
        let config_path = tmp.path().join("sendword.toml");
        let db_path = tmp.path().join("sendword.db");
        fs::write(&config_path, b"[server]\nport = 9090\n").expect("write config");
        fs::write(&db_path, b"DB_BYTES").expect("write db");

        let tarball_path = tmp.path().join("no-json-backup.tar.gz");
        create_tarball(&config_path, &db_path, &tarball_path).expect("create tarball");

        // Extracting the tarball must succeed even though sendword.json is absent.
        let extract_dir = tmp.path().join("extracted");
        let result = extract_tarball(&tarball_path, &extract_dir);
        assert!(
            result.is_ok(),
            "extraction should succeed without sendword.json: {result:?}"
        );

        // The TOML config and DB snapshot are present.
        assert!(
            extract_dir.join("sendword.toml").exists(),
            "sendword.toml should be extracted"
        );
        assert!(
            extract_dir.join("sendword.db").exists(),
            "sendword.db should be extracted"
        );

        // The JSON overlay is absent — that's the point of this test.
        assert!(
            !extract_dir.join("sendword.json").exists(),
            "sendword.json should not exist in this archive"
        );
    }
}