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
//! Types and methods for interacting with `Nix`
use bincode::{Decode, Encode};
use snafu::{ResultExt, Snafu};
use std::{
    path::{Path, PathBuf},
    process::Command,
    time::{Duration, Instant},
};
use tracing::{debug, debug_span, error, info, instrument};

/// Types for interacting with the store
mod store;

pub use store::{StoreError, StoreState};

/// Configuration needed to interact with `Nix` properly
///
/// The [`Default`] provided value for this type is as follows:
/// ``` rust
/// use nix_cache_watcher::nix::NixConfiguration;
///
/// let configuration = NixConfiguration {
///     store_path: "/nix/store".into(),
/// };
/// assert_eq!(configuration, NixConfiguration::default())
/// ```
#[derive(Clone, Debug, PartialEq, Eq, Encode, Decode)]
pub struct NixConfiguration {
    /// The path to the nix store
    pub store_path: PathBuf,
}

impl Default for NixConfiguration {
    fn default() -> Self {
        Self {
            store_path: "/nix/store/".into(),
        }
    }
}

/// Errors that can happen when shelling out to nix
#[derive(Debug, Snafu)]
#[non_exhaustive]
pub enum NixError {
    /// Error occured spawning process
    ProcessSpawn {
        /// Underlying error
        source: std::io::Error,
    },
    /// Error calling `nix store sign`
    #[snafu(display(
        "Error calling `nix store sign`:\nexit_code:{:?}\nstdout:{}\n\nstderr:{}`",
        exit_code,
        stdout,
        stderr
    ))]
    SignatureError {
        /// The exit code, if there was any
        exit_code: Option<i32>,
        /// The contents of stdout
        stdout: String,
        /// The contents of stderror
        stderr: String,
    },
    /// Error calling `nix copy`
    #[snafu(display(
        "Error calling `nix copy`:\nexit_code:{:?}\nstdout:{}\n\nstderr:{}`",
        exit_code,
        stdout,
        stderr
    ))]
    CopyError {
        /// The exit code, if there was any
        exit_code: Option<i32>,
        /// The contents of stdout
        stdout: String,
        /// The contents of stderror
        stderr: String,
    },
}

/// Results struct for [`sign_store_paths`]
pub struct SignatureResults {
    /// Total number of new signatures
    pub count: u64,
    /// Duration that the sign_store_paths took to complete
    pub duration: Duration,
}

/// Sign a list of top-level store paths recursively
///
/// Returns the number of paths signed
///
/// # Errors
///
/// Will propagate an error if the shelling out to the `nix` command fails
#[instrument(skip(paths, key_path))]
pub fn sign_store_paths(
    paths: impl IntoIterator<Item = impl AsRef<Path>>,
    key_path: impl AsRef<Path>,
    fanout_factor: usize,
) -> Result<SignatureResults, NixError> {
    // Start the timer
    let start = Instant::now();
    let key_path = key_path.as_ref();
    debug!(?key_path);
    // Get the paths owned first
    let paths: Vec<PathBuf> = paths.into_iter().map(|x| x.as_ref().to_owned()).collect();
    let count = paths
        .chunks(fanout_factor)
        .map(|paths| {
            debug_span!("nix store sign inner loop");
            // Start a timer
            let start = Instant::now();
            // TODO Call out to nix for the signing
            debug!("Attempting to sign {} paths", paths.len());
            let output = Command::new("nix")
                // Pass in our main arguments, we want to sign things recursively
                .args(["store", "sign", "-r", "-v", "--key-file"])
                // Add in the key file
                .arg(key_path)
                // Now add in the paths
                .args(paths)
                // Let it run and capture the output
                .output()
                .context(ProcessSpawnSnafu)?;
            // Process the output, first handle any errors
            if !output.status.success() {
                error!(?output);
                return SignatureSnafu {
                    exit_code: output.status.code(),
                    stdout: String::from(String::from_utf8_lossy(&output.stdout)),
                    stderr: String::from(String::from_utf8_lossy(&output.stderr)),
                }
                .fail();
            }
            // `nix store sign -v` outputs a format that looks like 'added 3 signatures' to stderr
            let stderr: String = String::from_utf8_lossy(&output.stderr).into();
            // The second one should be the number
            let count: u64 = match stderr.split(' ').nth(1) {
                Some(x) => match x.parse::<u64>() {
                    Ok(x) => x,
                    Err(_) => {
                        return SignatureSnafu {
                            exit_code: output.status.code(),
                            stdout: String::from(String::from_utf8_lossy(&output.stdout)),
                            stderr: String::from(String::from_utf8_lossy(&output.stderr)),
                        }
                        .fail();
                    }
                },
                None => {
                    return SignatureSnafu {
                        exit_code: output.status.code(),
                        stdout: String::from(String::from_utf8_lossy(&output.stdout)),
                        stderr: String::from(String::from_utf8_lossy(&output.stderr)),
                    }
                    .fail();
                }
            };

            // Stop the timer
            let end = Instant::now();
            let duration = end - start;
            info!(?count, ?duration, "nix sign store completed");
            Ok::<u64, NixError>(count)
        })
        .collect::<Result<Vec<_>, _>>()?
        .into_iter()
        .sum();
    // Stop the timer
    let end = Instant::now();
    let duration = end - start;
    info!(?duration, ?count, "Completed signatures");
    Ok(SignatureResults { count, duration })
}

/// Upload store paths to cache using the nix tooling
#[instrument(skip(paths))]
pub fn upload_paths_to_cache(
    paths: impl IntoIterator<Item = impl AsRef<Path>>,
    cache: &str,
    fanout_factor: usize,
) -> Result<(), NixError> {
    // Get the paths owned first
    let paths: Vec<PathBuf> = paths.into_iter().map(|x| x.as_ref().to_owned()).collect();
    for paths in paths.chunks(fanout_factor) {
        debug_span!("nix store sign inner loop");
        debug!("Attempting to upload {} paths", paths.len());
        let output = Command::new("nix")
            // Pass in our main arguments, we want to copy to a store
            .args(["copy", "--to"])
            // Add in the store location
            .arg(cache)
            // Now add in the paths
            .args(paths)
            // Let it run and capture the output
            .output()
            .context(ProcessSpawnSnafu)?;
        // Process the output, first handle any errors
        if !output.status.success() {
            error!(?output);
            return SignatureSnafu {
                exit_code: output.status.code(),
                stdout: String::from(String::from_utf8_lossy(&output.stdout)),
                stderr: String::from(String::from_utf8_lossy(&output.stderr)),
            }
            .fail();
        }
    }
    Ok(())
}