uutils-args/tests/coreutils/tail.rs

use std::{ffi::OsString, path::PathBuf};

use uutils_args::{Arguments, Initial, Options, Value};

// This format is way to specific to implement using a library. Basically, any
// deviation should be return `None` to indicate that we're not using the
// this format. If this fails, we fall back on the normal parsing, so errors
// from this function are not relevant, so we can just return an `Option`.
// Once this gets into uutils, I highly recommend that we make this format
// optional at compile time. As the GNU docs explain, it's very error-prone.
fn parse_deprecated<I>(iter: I) -> Option<Settings>
where
    I: IntoIterator + Clone + 'static,
    I::Item: Into<OsString>,
{
    let mut iter = iter.into_iter();

    // We don't use it, but the first argument is the binary name.
    iter.next()?;

    let shorthand = iter.next()?;
    let input = iter.next()?;

    // We can only have a maximum of 2 arguments in this format
    // The error doesn't really matter because we'll ignore any errors
    // from this format.
    if iter.next().is_some() {
        return None;
    }

    // Parse the shorthand by turning it into a String (via OsString)
    // The format we're parsing is `{+/-}[NUM][bcl][f]`.
    let os_string = shorthand.into();

    // The part of the string that is not parsed yet
    let mut rest = os_string.to_str()?;

    // Corner case: If it's just `-` then it needs to be parsed like
    // the nondeprecated syntax, because `-` represents standard input.
    // Curiously, GNU parses `tail + a.txt` as the deprecated syntax.
    if rest == "-" {
        return None;
    }

    // Corner case: `tail -c 10` is ambiguous and should be interpreted as
    // `tail -c10 -`, not as `tail -c10 10`. All other things in this syntax
    // do not create problems. For example, `tail -f a` has the same effect in
    // this syntax and normal parsing.
    if rest == "-c" {
        return None;
    }

    // Parse the sign
    let sig = if let Some(r) = rest.strip_prefix('-') {
        rest = r;
        SigNum::Negative
    } else if let Some(r) = rest.strip_prefix('+') {
        rest = r;
        SigNum::Positive
    } else {
        return None;
    };

    // Find and parse the number part of the string
    let end_num = rest
        .find(|c: char| !c.is_ascii_digit())
        .unwrap_or(rest.len());
    let mut num = rest[..end_num].parse().unwrap_or(10);
    rest = &rest[end_num..];

    // Parse the mode, one of `b`, `c`, 'l`.
    let mode = if let Some(r) = rest.strip_prefix('l') {
        rest = r;
        Mode::Lines
    } else if let Some(r) = rest.strip_prefix('c') {
        rest = r;
        Mode::Bytes
    } else if let Some(r) = rest.strip_prefix('b') {
        rest = r;
        num *= 512;
        Mode::Bytes
    } else {
        Mode::Lines
    };

    // Parse the `f`
    let follow = if let Some(r) = rest.strip_prefix('f') {
        rest = r;
        Some(FollowMode::Descriptor)
    } else {
        None
    };

    if !rest.is_empty() {
        return None;
    }

    Some(Settings {
        number: sig(num),
        mode,
        follow,
        inputs: vec![input.into().into()],
        ..Settings::initial()
    })
}

#[derive(Arguments)]
enum Arg {
    #[option("-c NUM", "--bytes=NUM")]
    Bytes(SigNum),

    #[option("-f", "--follow[=HOW]", default=FollowMode::Descriptor)]
    Follow(FollowMode),

    #[option("-F")]
    FollowRetry,

    #[option("--max-unchanged-stats=N")]
    MaxUnchangedStats(u32),

    #[option("-n NUM", "--lines=NUM")]
    Lines(SigNum),

    #[option("--pid=PID")]
    Pid(u64),

    #[option("-q", "--quiet", "--silent")]
    Quiet,

    #[option("--retry")]
    Retry,

    #[option("-s NUMBER", "--sleep-interval=NUMBER")]
    SleepInterval(u64),

    #[option("-v", "--verbose")]
    Verbose,

    #[option("-z", "--zero-terminated")]
    Zero,

    #[positional(..)]
    File(PathBuf),

    #[option("---presume-input-pipe", hidden)]
    PresumeInputPipe,
}

// We need both negative and positive 0
#[derive(Debug, PartialEq, Eq)]
enum SigNum {
    Positive(u64),
    Negative(u64),
}

impl Value for SigNum {
    fn from_value(value: &std::ffi::OsStr) -> uutils_args::ValueResult<Self> {
        let s = String::from_value(value)?;
        let mut rest: &str = &s;

        let sign = if let Some(r) = s.strip_prefix('+') {
            rest = r;
            Self::Positive
        } else if let Some(r) = s.strip_prefix('-') {
            rest = r;
            Self::Negative
        } else {
            Self::Negative
        };

        // Get the number from the front of the string
        let end_num = rest
            .find(|c: char| !c.is_ascii_digit())
            .unwrap_or(rest.len());
        let num = rest[..end_num].parse().unwrap_or(1);
        rest = &rest[end_num..];

        // Determine the multiplier
        let multiplier = match rest {
            "" => Some(1),
            "b" => Some(512),
            "K" | "KiB" => Some(1024),
            "M" | "MiB" => 1024_u64.checked_pow(2),
            "G" | "GiB" => 1024_u64.checked_pow(3),
            "T" | "TiB" => 1024_u64.checked_pow(4),
            "P" | "PiB" => 1024_u64.checked_pow(5),
            "E" | "EiB" => 1024_u64.checked_pow(6),
            "Z" | "ZiB" => 1024_u64.checked_pow(7),
            "Y" | "YiB" => 1024_u64.checked_pow(8),
            "KB" => Some(1000),
            "MB" => 1000_u64.checked_pow(2),
            "GB" => 1000_u64.checked_pow(3),
            "TB" => 1000_u64.checked_pow(4),
            "PB" => 1000_u64.checked_pow(5),
            "EB" => 1000_u64.checked_pow(6),
            "ZB" => 1000_u64.checked_pow(7),
            "YB" => 1000_u64.checked_pow(8),
            _ => return Err(format!("Invalid number of lines: {s}").into()),
        };

        let number = match multiplier.and_then(|m| m.checked_mul(num)) {
            Some(number) => number,
            None => return Err("Value too large for defined data type".into()),
        };

        Ok(sign(number))
    }
}

impl Default for SigNum {
    fn default() -> Self {
        Self::Negative(10)
    }
}

#[derive(Value, Debug, PartialEq, Eq)]
enum FollowMode {
    #[value("descriptor")]
    Descriptor,
    #[value("name")]
    Name,
}

#[derive(Default, Debug, PartialEq, Eq)]
pub enum Mode {
    Bytes,
    #[default]
    Lines,
}

#[derive(Initial)]
struct Settings {
    follow: Option<FollowMode>,
    max_unchanged_stats: u32,
    mode: Mode,
    number: SigNum,
    // TODO: Should be a dedicated PID type
    pid: u64,
    retry: bool,
    sleep_sec: u64,
    verbose: bool,
    presume_input_pipe: bool,
    inputs: Vec<PathBuf>,
    zero: bool,
}

impl Options<Arg> for Settings {
    fn apply(&mut self, arg: Arg) {
        match arg {
            Arg::Bytes(n) => {
                self.mode = Mode::Bytes;
                self.number = n;
            }
            Arg::Lines(n) => {
                self.mode = Mode::Lines;
                self.number = n;
            }
            Arg::Follow(mode) => self.follow = Some(mode),
            Arg::FollowRetry => {
                self.follow = Some(FollowMode::Name);
                self.retry = true;
            }
            Arg::MaxUnchangedStats(n) => self.max_unchanged_stats = n,
            Arg::Pid(pid) => self.pid = pid,
            Arg::Quiet => self.verbose = false,
            Arg::Retry => self.retry = true,
            Arg::SleepInterval(n) => self.sleep_sec = n,
            Arg::Verbose => self.verbose = true,
            Arg::Zero => self.zero = true,
            Arg::File(input) => self.inputs.push(input),
            Arg::PresumeInputPipe => self.presume_input_pipe = true,
        }
    }
}

fn parse_tail<I>(iter: I) -> Result<Settings, uutils_args::Error>
where
    I: IntoIterator + Clone + 'static,
    I::Item: Into<OsString>,
{
    match parse_deprecated(iter.clone()) {
        Some(s) => Ok(s),
        None => Settings::try_parse(iter),
    }
}

#[test]
fn shorthand() {
    let s = parse_tail(["tail", "-20", "some_file"]).unwrap();
    assert_eq!(s.number, SigNum::Negative(20));
    assert_eq!(s.mode, Mode::Lines);
    assert_eq!(s.follow, None);

    let s = parse_tail(["tail", "+20", "some_file"]).unwrap();
    assert_eq!(s.number, SigNum::Positive(20));
    assert_eq!(s.mode, Mode::Lines);
    assert_eq!(s.follow, None);

    let s = parse_tail(["tail", "-100cf", "some_file"]).unwrap();
    assert_eq!(s.number, SigNum::Negative(100));
    assert_eq!(s.mode, Mode::Bytes);
    assert_eq!(s.follow, Some(FollowMode::Descriptor));

    // Corner case where the shorthand does not apply
    let s = parse_tail(["tail", "-c", "42"]).unwrap();
    assert_eq!(s.number, SigNum::Negative(42));
    assert_eq!(s.mode, Mode::Bytes);
    assert_eq!(s.inputs, Vec::<PathBuf>::new());
}

#[test]
fn standard_input() {
    let s = parse_tail(["tail", "-"]).unwrap();
    assert_eq!(s.inputs, vec![PathBuf::from("-")])
}

#[test]
fn normal_format() {
    let s = parse_tail(["tail", "-c", "20", "some_file"]).unwrap();
    assert_eq!(s.number, SigNum::Negative(20));
    assert_eq!(s.mode, Mode::Bytes);
}

#[test]
fn signum() {
    let s = parse_tail(["tail", "-n", "20"]).unwrap();
    assert_eq!(s.number, SigNum::Negative(20));
    let s = parse_tail(["tail", "-n", "-20"]).unwrap();
    assert_eq!(s.number, SigNum::Negative(20));
    let s = parse_tail(["tail", "-n", "+20"]).unwrap();
    assert_eq!(s.number, SigNum::Positive(20));

    let s = parse_tail(["tail", "-n", "20b"]).unwrap();
    assert_eq!(s.number, SigNum::Negative(20 * 512));
    let s = parse_tail(["tail", "-n", "+20b"]).unwrap();
    assert_eq!(s.number, SigNum::Positive(20 * 512));

    let s = parse_tail(["tail", "-n", "b"]).unwrap();
    assert_eq!(s.number, SigNum::Negative(512));
    let s = parse_tail(["tail", "-n", "+b"]).unwrap();
    assert_eq!(s.number, SigNum::Positive(512));

    assert!(parse_tail(["tail", "-n", "20invalid_suffix"]).is_err());
}

#[test]
fn follow_mode() {
    // Sanity check: should be None initially
    let s = parse_tail(["tail"]).unwrap();
    assert_eq!(s.follow, None);

    let s = parse_tail(["tail", "--follow"]).unwrap();
    assert_eq!(s.follow, Some(FollowMode::Descriptor));

    let s = parse_tail(["tail", "-f"]).unwrap();
    assert_eq!(s.follow, Some(FollowMode::Descriptor));

    let s = parse_tail(["tail", "--follow=descriptor"]).unwrap();
    assert_eq!(s.follow, Some(FollowMode::Descriptor));

    let s = parse_tail(["tail", "--follow=des"]).unwrap();
    assert_eq!(s.follow, Some(FollowMode::Descriptor));

    let s = parse_tail(["tail", "--follow=d"]).unwrap();
    assert_eq!(s.follow, Some(FollowMode::Descriptor));

    let s = parse_tail(["tail", "--follow=name"]).unwrap();
    assert_eq!(s.follow, Some(FollowMode::Name));

    let s = parse_tail(["tail", "--follow=na"]).unwrap();
    assert_eq!(s.follow, Some(FollowMode::Name));

    let s = parse_tail(["tail", "--follow=n"]).unwrap();
    assert_eq!(s.follow, Some(FollowMode::Name));

    assert!(parse_tail(["tail", "--follow="]).is_err());

    let s = parse_tail(["tail", "-F"]).unwrap();
    assert_eq!(s.follow, Some(FollowMode::Name));
}