rs-aggregate/tests/cli.rs

use assert_cmd::Command;
use glob::glob;
use predicates::prelude::*;
use predicates::reflection::PredicateReflection;
// Used for writing assertions
use rstest::*;
use std::fmt::Display;
use std::{error::Error, fs::File, io::Read, path::Path, str};

struct SortedEquals {
    expect: Vec<u8>,
}

fn sort_buf(input: &[u8]) -> Vec<u8> {
    let mut lines = input
        .split(|x| *x == b'\n')
        .map(|x| Vec::<u8>::from(x))
        .collect::<Vec<Vec<u8>>>();
    lines.sort();
    lines.join(&b'\n')
}

impl SortedEquals {
    fn new(expect: &[u8]) -> SortedEquals {
        let sorted = sort_buf(expect);
        SortedEquals { expect: sorted }
    }
}

impl Display for SortedEquals {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(str::from_utf8(self.expect.as_slice()).unwrap())
    }
}

impl Predicate<[u8]> for SortedEquals {
    fn eval(&self, variable: &[u8]) -> bool {
        // sort self into temporary, then compare with variable
        let sorted = sort_buf(variable);
        sorted == self.expect
    }
}

impl PredicateReflection for SortedEquals {}

/// Compare the output with pre-prepared expected outputs. When functionality is
/// matching, we generate expected outputs with `aggregate6`, and expect byte-for-byte
/// output consistency, including ordering. When our functionality and `aggregate6`'s
/// diverge, we generate expected outputs ourselves, and expect output sorted by numeric
/// value of the address.
///
/// Normalization is available for future test cases.
#[rstest]
#[case::dfz_combined("test-data/dfz_combined", "", false)] // Basic aggregation test
#[case::max_pfxlen("test-data/max_pfxlen", "-m 20", false)] // Filter on prefix length
#[case::max_pfxlen_split("test-data/max_pfxlen_split", "-m 20,32", false)] // Filter on prefix length (split v4/v6)
#[case::v4_only("test-data/v4_only", "-4", false)] // Filter v4 only
#[case::v6_only("test-data/v6_only", "-6", false)] // Filter v6 only
fn dfz_test(
    #[case] path: &str,
    #[case] args: &str,
    #[case] normalize_data: bool,
) -> Result<(), Box<dyn Error>> {
    let mut cmd = Command::cargo_bin("rs-aggregate")?;
    let in_path = Path::new(path).join("input");
    let expect_path = Path::new(path).join("expected");
    let mut expect_file = File::open(expect_path)?;
    let mut expect_data: Vec<u8> =
        Vec::with_capacity(expect_file.metadata()?.len().try_into().unwrap());
    expect_file.read_to_end(&mut expect_data)?;

    let assert = cmd
        .arg(in_path)
        .args(args.split_whitespace())
        .timeout(std::time::Duration::from_secs(30))
        .assert();

    if normalize_data {
        assert
            .success()
            .stdout(SortedEquals::new(&expect_data))
            .stderr(predicate::str::is_empty());
    } else {
        assert
            .success()
            .stdout(predicate::eq(expect_data))
            .stderr(predicate::str::is_empty());
    }

    Ok(())
}

#[rstest]
#[case("2001:db8::23ab:f007/64", "2001:db8::/64")]
#[case("198.51.100.123/24", "198.51.100.0/24")]
fn truncate_test(#[case] input: &str, #[case] expect: &str) -> Result<(), Box<dyn Error>> {
    let mut cmd = Command::cargo_bin("rs-aggregate")?;

    let assert = cmd.write_stdin(input).assert();
    assert
        .success()
        .stdout(predicate::str::is_empty())
        .stderr(predicate::eq(format!(
            "ERROR: '{}' is not a valid IP network, ignoring.\n",
            input
        )));

    let assert = cmd.arg("-t").write_stdin(input).assert();
    assert
        .success()
        .stdout(predicate::eq(format!("{}\n", expect)))
        .stderr(predicate::str::is_empty());

    Ok(())
}

#[rstest]
#[case("test-data/multi_input", "")]
fn multi_input_test(#[case] path: &str, #[case] args: &str) -> Result<(), Box<dyn Error>> {
    let mut cmd = Command::cargo_bin("rs-aggregate")?;

    let inputs = glob((path.to_owned() + "/input*").as_str())?;

    let expect_path = Path::new(path).join("expected");
    let mut expect_file = File::open(expect_path)?;
    let mut expect_data: Vec<u8> =
        Vec::with_capacity(expect_file.metadata()?.len().try_into().unwrap());
    expect_file.read_to_end(&mut expect_data)?;

    let assert = cmd
        .args(args.split_whitespace())
        .args(inputs.map(|x| x.unwrap()))
        .timeout(std::time::Duration::from_secs(30))
        .assert();

    assert
        .success()
        .stdout(SortedEquals::new(&expect_data))
        .stderr(predicate::str::is_empty());

    Ok(())
}