Skip to content

add DataFormat enum #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 14, 2022
Merged

add DataFormat enum #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions crates/snapbox/src/assert.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use crate::data::DataFormat;
use crate::Action;

/// Snapshot assertion against a file's contents
Expand All @@ -18,7 +19,7 @@ pub struct Assert {
action_var: Option<String>,
substitutions: crate::Substitutions,
pub(crate) palette: crate::report::Palette,
pub(crate) binary: Option<bool>,
pub(crate) data_format: Option<DataFormat>,
}

/// # Assertions
Expand Down Expand Up @@ -111,7 +112,7 @@ impl Assert {
Action::Ignore | Action::Verify | Action::Overwrite => {}
}

let expected = crate::Data::read_from(pattern_path, self.binary);
let expected = crate::Data::read_from(pattern_path, self.data_format());
let (expected, actual) = self.normalize_eq(expected, actual);

self.do_action(
Expand Down Expand Up @@ -159,7 +160,7 @@ impl Assert {
Action::Ignore | Action::Verify | Action::Overwrite => {}
}

let expected = crate::Data::read_from(pattern_path, self.binary);
let expected = crate::Data::read_from(pattern_path, self.data_format());
let (expected, actual) = self.normalize_match(expected, actual);

self.do_action(
Expand Down Expand Up @@ -483,9 +484,17 @@ impl Assert {
///
/// The default is to auto-detect
pub fn binary(mut self, yes: bool) -> Self {
self.binary = Some(yes);
self.data_format = if yes {
Some(DataFormat::Binary)
} else {
Some(DataFormat::Text)
};
self
}

pub(crate) fn data_format(&self) -> Option<DataFormat> {
self.data_format
}
}

impl Default for Assert {
Expand All @@ -495,7 +504,7 @@ impl Default for Assert {
action_var: Default::default(),
substitutions: Default::default(),
palette: crate::report::Palette::auto(),
binary: Default::default(),
data_format: Default::default(),
}
.substitutions(crate::Substitutions::with_exe())
}
Expand Down
8 changes: 4 additions & 4 deletions crates/snapbox/src/cmd.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -605,7 +605,7 @@ impl OutputAssert {
#[track_caller]
fn stdout_eq_path_inner(self, expected_path: &std::path::Path) -> Self {
let actual = crate::Data::from(self.output.stdout.as_slice());
let expected = crate::Data::read_from(expected_path, self.config.binary);
let expected = crate::Data::read_from(expected_path, self.config.data_format());
let (pattern, actual) = self.config.normalize_eq(expected, actual);
self.config.do_action(
pattern,
Expand Down Expand Up @@ -675,7 +675,7 @@ impl OutputAssert {
#[track_caller]
fn stdout_matches_path_inner(self, expected_path: &std::path::Path) -> Self {
let actual = crate::Data::from(self.output.stdout.as_slice());
let expected = crate::Data::read_from(expected_path, self.config.binary);
let expected = crate::Data::read_from(expected_path, self.config.data_format());
let (pattern, actual) = self.config.normalize_match(expected, actual);
self.config.do_action(
pattern,
Expand Down Expand Up @@ -745,7 +745,7 @@ impl OutputAssert {
#[track_caller]
fn stderr_eq_path_inner(self, expected_path: &std::path::Path) -> Self {
let actual = crate::Data::from(self.output.stderr.as_slice());
let expected = crate::Data::read_from(expected_path, self.config.binary);
let expected = crate::Data::read_from(expected_path, self.config.data_format());
let (pattern, actual) = self.config.normalize_eq(expected, actual);
self.config.do_action(
pattern,
Expand Down Expand Up @@ -815,7 +815,7 @@ impl OutputAssert {
#[track_caller]
fn stderr_matches_path_inner(self, expected_path: &std::path::Path) -> Self {
let actual = crate::Data::from(self.output.stderr.as_slice());
let expected = crate::Data::read_from(expected_path, self.config.binary);
let expected = crate::Data::read_from(expected_path, self.config.data_format());
let (pattern, actual) = self.config.normalize_match(expected, actual);
self.config.do_action(
pattern,
Expand Down
35 changes: 23 additions & 12 deletions crates/snapbox/src/data.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ enum DataInner {
Text(String),
}

#[derive(Clone, Debug, PartialEq, Eq, Copy, Hash)]
pub enum DataFormat {
Binary,
Text,
}

impl Data {
/// Mark the data as binary (no post-processing)
pub fn binary(raw: impl Into<Vec<u8>>) -> Self {
Expand All @@ -33,18 +39,23 @@ impl Data {
}

/// Load test data from a file
pub fn read_from(path: &std::path::Path, binary: Option<bool>) -> Result<Self, crate::Error> {
let data = match binary {
Some(true) => {
let data = std::fs::read(&path)
.map_err(|e| format!("Failed to read {}: {}", path.display(), e))?;
Self::binary(data)
}
Some(false) => {
let data = std::fs::read_to_string(&path)
.map_err(|e| format!("Failed to read {}: {}", path.display(), e))?;
Self::text(data)
}
pub fn read_from(
path: &std::path::Path,
data_format: Option<DataFormat>,
) -> Result<Self, crate::Error> {
let data = match data_format {
Some(df) => match df {
DataFormat::Binary => {
let data = std::fs::read(&path)
.map_err(|e| format!("Failed to read {}: {}", path.display(), e))?;
Self::binary(data)
}
DataFormat::Text => {
let data = std::fs::read_to_string(&path)
.map_err(|e| format!("Failed to read {}: {}", path.display(), e))?;
Self::text(data)
}
},
None => {
let data = std::fs::read(&path)
.map_err(|e| format!("Failed to read {}: {}", path.display(), e))?;
Expand Down
3 changes: 2 additions & 1 deletion crates/snapbox/src/harness.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
//! }
//! ```

use crate::data::DataFormat;
use crate::Action;

pub struct Harness<S, T> {
Expand Down Expand Up @@ -212,7 +213,7 @@ impl Verifier {
expected_path: &std::path::Path,
actual: crate::Data,
) -> crate::Result<()> {
let expected = crate::Data::read_from(expected_path, Some(false))?
let expected = crate::Data::read_from(expected_path, Some(DataFormat::Text))?
.map_text(crate::utils::normalize_lines);

if expected != actual {
Expand Down
1 change: 1 addition & 0 deletions crates/snapbox/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ pub use action::Action;
pub use action::DEFAULT_ACTION_ENV;
pub use assert::Assert;
pub use data::Data;
pub use data::DataFormat;
pub use error::Error;
pub use snapbox_macros::debug;
pub use substitutions::Substitutions;
Expand Down
9 changes: 6 additions & 3 deletions src/schema.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@ impl TryCmd {
.map_err(|e| format!("Failed to read {}: {}", path.display(), e))?;
let one_shot = OneShot::parse_toml(&raw)?;
let mut sequence: Self = one_shot.into();
let is_binary = sequence.steps[0].binary;
let is_binary = match sequence.steps[0].binary {
true => snapbox::DataFormat::Binary,
false => snapbox::DataFormat::Text,
};

if sequence.steps[0].stdin.is_none() {
let stdin_path = path.with_extension("stdin");
Expand Down Expand Up @@ -60,7 +63,7 @@ impl TryCmd {

sequence
} else if ext == std::ffi::OsStr::new("trycmd") || ext == std::ffi::OsStr::new("md") {
let raw = crate::Data::read_from(path, Some(false))?
let raw = crate::Data::read_from(path, Some(snapbox::DataFormat::Text))?
.map_text(snapbox::utils::normalize_lines)
.into_string()
.unwrap();
Expand Down Expand Up @@ -147,7 +150,7 @@ impl TryCmd {
.to_owned();
// Add back trailing newline removed when parsing
stdout.push('\n');
let mut raw = crate::Data::read_from(path, Some(false))?
let mut raw = crate::Data::read_from(path, Some(snapbox::DataFormat::Text))?
.map_text(snapbox::utils::normalize_lines);
replace_lines(&mut raw, line_nums, &stdout)?;
raw.write_to(path)?;
Expand Down