Skip to content
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.

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

Add further testing to oof #27

Merged
merged 7 commits into from
May 24, 2021
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
10 changes: 5 additions & 5 deletions oof/src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use std::{error, ffi::OsString, fmt};
use crate::Flag;

#[derive(Debug)]
pub enum OofError<'t> {
pub enum OofError {
FlagValueConflict {
flag: Flag,
previous_value: OsString,
Expand All @@ -15,17 +15,17 @@ pub enum OofError<'t> {
UnknownShortFlag(char),
UnknownLongFlag(String),
MisplacedShortArgFlagError(char),
MissingValueToFlag(&'t Flag),
DuplicatedFlag(&'t Flag),
MissingValueToFlag(Flag),
DuplicatedFlag(Flag),
}

impl<'t> error::Error for OofError<'t> {
impl error::Error for OofError {
fn source(&self) -> Option<&(dyn error::Error + 'static)> {
None
}
}

impl<'t> fmt::Display for OofError<'t> {
impl fmt::Display for OofError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
// TODO: implement proper debug messages
match self {
Expand Down
57 changes: 48 additions & 9 deletions oof/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ pub fn filter_flags(
let is_last_letter = i == letters.len() - 1;

let flag_info =
short_flags_info.get(&letter).ok_or(OofError::UnknownShortFlag(letter))?;
*short_flags_info.get(&letter).ok_or(OofError::UnknownShortFlag(letter))?;

if !is_last_letter && flag_info.takes_value {
return Err(OofError::MisplacedShortArgFlagError(letter));
Expand All @@ -145,19 +145,20 @@ pub fn filter_flags(
if flag_info.takes_value {
// If it was already inserted
if result_flags.argument_flags.contains_key(flag_name) {
return Err(OofError::DuplicatedFlag(flag_info));
return Err(OofError::DuplicatedFlag(flag_info.clone()));
}

// pop the next one
let flag_argument =
iter.next().ok_or(OofError::MissingValueToFlag(flag_info))?;
let flag_argument = iter
.next()
.ok_or_else(|| OofError::MissingValueToFlag(flag_info.clone()))?;

// Otherwise, insert it.
result_flags.argument_flags.insert(flag_name, flag_argument);
} else {
// If it was already inserted
if result_flags.boolean_flags.contains(flag_name) {
return Err(OofError::DuplicatedFlag(flag_info));
return Err(OofError::DuplicatedFlag(flag_info.clone()));
}
// Otherwise, insert it
result_flags.boolean_flags.insert(flag_name);
Expand All @@ -168,7 +169,7 @@ pub fn filter_flags(
if let FlagType::Long = flag_type {
let flag = trim_double_hyphen(flag);

let flag_info = long_flags_info
let flag_info = *long_flags_info
.get(flag)
.ok_or_else(|| OofError::UnknownLongFlag(String::from(flag)))?;

Expand All @@ -177,15 +178,16 @@ pub fn filter_flags(
if flag_info.takes_value {
// If it was already inserted
if result_flags.argument_flags.contains_key(&flag_name) {
return Err(OofError::DuplicatedFlag(flag_info));
return Err(OofError::DuplicatedFlag(flag_info.clone()));
}

let flag_argument = iter.next().ok_or(OofError::MissingValueToFlag(flag_info))?;
let flag_argument =
iter.next().ok_or_else(|| OofError::MissingValueToFlag(flag_info.clone()))?;
result_flags.argument_flags.insert(flag_name, flag_argument);
} else {
// If it was already inserted
if result_flags.boolean_flags.contains(&flag_name) {
return Err(OofError::DuplicatedFlag(flag_info));
return Err(OofError::DuplicatedFlag(flag_info.clone()));
}
// Otherwise, insert it
result_flags.boolean_flags.insert(&flag_name);
Expand Down Expand Up @@ -220,6 +222,43 @@ mod tests {
args.map(OsString::from).collect()
}

fn setup_args_scenario(arg_str: &str) -> Result<(Vec<OsString>, Flags), OofError> {
let flags_info = [
ArgFlag::long("output_file").short('o'),
Flag::long("verbose").short('v'),
Flag::long("help").short('h'),
];

let args = gen_args(arg_str);
filter_flags(args, &flags_info)
demfabris marked this conversation as resolved.
Show resolved Hide resolved
}

#[test]
fn test_unknown_flags() {
let result = setup_args_scenario("ouch a.zip -s b.tar.gz c.tar").unwrap_err();
assert!(matches!(result, OofError::UnknownShortFlag('s')));
let result = setup_args_scenario("ouch a.zip --foobar b.tar.gz c.tar").unwrap_err();
// TODO: Try removing the `_` from `_foobar`
demfabris marked this conversation as resolved.
Show resolved Hide resolved
let _foobar = "foobar".to_string();
assert!(matches!(result, OofError::UnknownLongFlag(_foobar)));
}

#[test]
fn test_incomplete_flags() {
// TODO: Try removing the `_` from `_incomplete_flag`
let _incomplete_flag = Flag::long("output_file").short('o');
let result = setup_args_scenario("ouch a.zip b.tar.gz c.tar -o").unwrap_err();
assert!(matches!(result, OofError::MissingValueToFlag(_incomplete_flag)));
}

#[test]
fn test_duplicated_flags() {
// TODO: Try removing the `_` from `_duplicated_flag`
let _duplicated_flag = Flag::long("output_file").short('o');
let result = setup_args_scenario("ouch a.zip b.tar.gz c.tar -o -o -o").unwrap_err();
assert!(matches!(result, OofError::DuplicatedFlag(_duplicated_flag)));
}

// asdasdsa
#[test]
fn test_filter_flags() {
Expand Down
2 changes: 1 addition & 1 deletion src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ impl From<walkdir::Error> for Error {
}
}

impl<'t> From<oof::OofError<'t>> for Error {
impl From<oof::OofError> for Error {
fn from(err: oof::OofError) -> Self {
// To avoid entering a lifetime hell, we'll just print the Oof error here
// and skip saving it into a variant of Self
Expand Down