-
-
Notifications
You must be signed in to change notification settings - Fork 326
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
rust: event file read and write methods in the same module
- Loading branch information
Showing
5 changed files
with
184 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| // SPDX-License-Identifier: GPL-3.0-or-later | ||
|
|
||
| use crate::ipc::Envelope; | ||
| use serde_json::de::IoRead; | ||
| use serde_json::StreamDeserializer; | ||
| use std::io; | ||
|
|
||
| /// Generate the build events from the file. | ||
| /// | ||
| /// Returns an iterator over the build events. | ||
| /// Any error will interrupt the reading process and the remaining events will be lost. | ||
| pub fn read(reader: impl io::Read) -> impl Iterator<Item = Envelope> { | ||
| let stream = StreamDeserializer::new(IoRead::new(reader)); | ||
| stream.filter_map(|result| match result { | ||
| Ok(value) => Some(value), | ||
| Err(error) => { | ||
| log::error!("Failed to read event: {:?}", error); | ||
| None | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| /// Write the build events to the file. | ||
| /// | ||
| /// Can fail if the events cannot be serialized or written to the file. | ||
| /// Any error will interrupt the writing process and the file will be incomplete. | ||
| pub fn write( | ||
| mut writer: impl io::Write, | ||
| envelopes: impl IntoIterator<Item = Envelope>, | ||
| ) -> Result<(), anyhow::Error> { | ||
| for envelope in envelopes { | ||
| serde_json::to_writer(&mut writer, &envelope)?; | ||
| writer.write_all(b"\n")?; | ||
| } | ||
| Ok(()) | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod test { | ||
| use super::*; | ||
| use crate::ipc::{Event, Execution, ProcessId, ReporterId}; | ||
| use crate::vec_of_strings; | ||
| use serde_json::json; | ||
| use std::collections::HashMap; | ||
| use std::io::Cursor; | ||
| use std::path::PathBuf; | ||
|
|
||
| #[test] | ||
| fn read_write() { | ||
| let events = expected_values(); | ||
|
|
||
| let mut buffer = Vec::new(); | ||
| write(&mut buffer, events.iter().cloned()).unwrap(); | ||
| let mut cursor = Cursor::new(buffer); | ||
| let read_events: Vec<_> = read(&mut cursor).collect(); | ||
|
|
||
| assert_eq!(events, read_events); | ||
| } | ||
|
|
||
| #[test] | ||
| fn read_write_empty() { | ||
| let events = Vec::<Envelope>::new(); | ||
|
|
||
| let mut buffer = Vec::new(); | ||
| write(&mut buffer, events.iter().cloned()).unwrap(); | ||
| let mut cursor = Cursor::new(buffer); | ||
| let read_events: Vec<_> = read(&mut cursor).collect(); | ||
|
|
||
| assert_eq!(events, read_events); | ||
| } | ||
|
|
||
| #[test] | ||
| fn read_stops_on_errors() { | ||
| let line1 = json!({ | ||
| "rid": 42, | ||
| "timestamp": 0, | ||
| "event": { | ||
| "pid": 11782, | ||
| "execution": { | ||
| "executable": "/usr/bin/clang", | ||
| "arguments": ["clang", "-c", "main.c"], | ||
| "working_dir": "/home/user", | ||
| "environment": { | ||
| "PATH": "/usr/bin", | ||
| "HOME": "/home/user" | ||
| } | ||
| } | ||
| } | ||
| }); | ||
| let line2 = json!({"rid": 42 }); | ||
| let line3 = json!({ | ||
| "rid": 42, | ||
| "timestamp": 273, | ||
| "event": { | ||
| "pid": 11934, | ||
| "execution": { | ||
| "executable": "/usr/bin/clang", | ||
| "arguments": ["clang", "-c", "output.c"], | ||
| "working_dir": "/home/user", | ||
| "environment": {} | ||
| } | ||
| } | ||
| }); | ||
| let content = format!("{}\n{}\n{}\n", line1, line2, line3); | ||
|
|
||
| let mut cursor = Cursor::new(content); | ||
| let read_events: Vec<_> = read(&mut cursor).collect(); | ||
|
|
||
| // Only the fist event is read, all other lines are ignored. | ||
| assert_eq!(expected_values()[0..1], read_events); | ||
| } | ||
|
|
||
| const REPORTER_ID: ReporterId = ReporterId(42); | ||
|
|
||
| fn expected_values() -> Vec<Envelope> { | ||
| vec![ | ||
| Envelope { | ||
| rid: REPORTER_ID, | ||
| timestamp: 0, | ||
| event: Event { | ||
| pid: ProcessId(11782), | ||
| execution: Execution { | ||
| executable: PathBuf::from("/usr/bin/clang"), | ||
| arguments: vec_of_strings!["clang", "-c", "main.c"], | ||
| working_dir: PathBuf::from("/home/user"), | ||
| environment: HashMap::from([ | ||
| ("PATH".to_string(), "/usr/bin".to_string()), | ||
| ("HOME".to_string(), "/home/user".to_string()), | ||
| ]), | ||
| }, | ||
| }, | ||
| }, | ||
| Envelope { | ||
| rid: REPORTER_ID, | ||
| timestamp: 273, | ||
| event: Event { | ||
| pid: ProcessId(11934), | ||
| execution: Execution { | ||
| executable: PathBuf::from("/usr/bin/clang"), | ||
| arguments: vec_of_strings!["clang", "-c", "output.c"], | ||
| working_dir: PathBuf::from("/home/user"), | ||
| environment: HashMap::from([]), | ||
| }, | ||
| }, | ||
| }, | ||
| ] | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters