test_sort.rs

// This file is part of the uutils coreutils package.
//
// For the full copyright and license information, please view the LICENSE
// file that was distributed with this source code.

// spell-checker:ignore (words) ints (linux) NOFILE dfgi abmon avril
#![allow(clippy::cast_possible_wrap)]

use std::env;
use std::fmt::Write as FmtWrite;
#[cfg(unix)]
use std::process::Command;
use std::time::Duration;

use uutests::at_and_ucmd;
use uutests::new_ucmd;
use uutests::util::TestScenario;
#[cfg(unix)]
use uutests::util::is_locale_available;

fn test_helper(file_name: &str, possible_args: &[&str]) {
    for args in possible_args {
        new_ucmd!()
            .arg(format!("{file_name}.txt"))
            .args(&args.split_whitespace().collect::<Vec<&str>>())
            .succeeds()
            .stdout_is_fixture(format!("{file_name}.expected"));

        new_ucmd!()
            .arg(format!("{file_name}.txt"))
            .arg("--debug")
            .args(&args.split_whitespace().collect::<Vec<&str>>())
            .succeeds()
            .stdout_is_fixture(format!("{file_name}.expected.debug"));
    }
}

#[test]
fn test_buffer_sizes() {
    #[cfg(target_os = "linux")]
    let buffer_sizes = ["0", "50K", "50k", "1M", "100M", "0%", "10%"];
    // TODO Percentage sizes are not yet supported beyond Linux.
    #[cfg(not(target_os = "linux"))]
    let buffer_sizes = ["0", "50K", "50k", "1M", "100M"];
    for buffer_size in &buffer_sizes {
        new_ucmd!()
            .arg("-n")
            .arg("-S")
            .arg(buffer_size)
            .arg("ext_sort.txt")
            .succeeds()
            .stdout_is_fixture("ext_sort.expected");
    }

    #[cfg(not(target_pointer_width = "32"))]
    {
        let buffer_sizes = ["1000G", "10T"];
        for buffer_size in &buffer_sizes {
            new_ucmd!()
                .arg("-n")
                .arg("-S")
                .arg(buffer_size)
                .arg("ext_sort.txt")
                .succeeds()
                .stdout_is_fixture("ext_sort.expected");
        }
    }
}

#[test]
fn test_invalid_buffer_size() {
    new_ucmd!()
        .arg("-S")
        .arg("asd")
        .fails_with_code(2)
        .stderr_only("sort: invalid --buffer-size argument 'asd'\n");

    new_ucmd!()
        .arg("-S")
        .arg("100f")
        .fails_with_code(2)
        .stderr_only("sort: invalid suffix in --buffer-size argument '100f'\n");

    // TODO Percentage sizes are not yet supported beyond Linux.
    #[cfg(target_os = "linux")]
    new_ucmd!()
        .arg("-S")
        .arg("0x123%")
        .fails_with_code(2)
        .stderr_only("sort: invalid --buffer-size argument '0x123%'\n");

    new_ucmd!()
        .arg("-n")
        .arg("-S")
        .arg("1Y")
        .arg("ext_sort.txt")
        .fails_with_code(2)
        .stderr_only("sort: --buffer-size argument '1Y' too large\n");

    #[cfg(target_pointer_width = "32")]
    {
        let buffer_sizes = ["1000G", "10T"];
        for buffer_size in &buffer_sizes {
            new_ucmd!()
                .arg("-n")
                .arg("-S")
                .arg(buffer_size)
                .arg("ext_sort.txt")
                .fails_with_code(2)
                .stderr_only(format!(
                    "sort: --buffer-size argument '{buffer_size}' too large\n"
                ));
        }
    }
}

#[test]
fn test_legacy_plus_minus_accepts_when_modern_posix2() {
    let size_max = usize::MAX;
    let (at, mut ucmd) = at_and_ucmd!();
    at.write("input.txt", "aa\nbb\n");

    ucmd.env("_POSIX2_VERSION", "200809")
        .arg(format!("+0.{size_max}R"))
        .arg("input.txt")
        .succeeds()
        .stdout_is("aa\nbb\n");
}

#[test]
fn test_legacy_plus_minus_accepts_with_size_max() {
    let size_max = usize::MAX;
    let (at, mut ucmd) = at_and_ucmd!();
    at.write("input.txt", "aa\nbb\n");

    ucmd.env("_POSIX2_VERSION", "200809")
        .arg("+1")
        .arg(format!("-1.{size_max}R"))
        .arg("input.txt")
        .succeeds()
        .stdout_is("aa\nbb\n");
}

#[test]
fn test_ext_sort_stable() {
    new_ucmd!()
        .arg("-n")
        .arg("--stable")
        .arg("-S")
        .arg("0M")
        .arg("ext_stable.txt")
        .succeeds()
        .stdout_only_fixture("ext_stable.expected");
}

#[test]
fn test_ext_sort_zero_terminated() {
    new_ucmd!()
        .arg("-z")
        .arg("-S")
        .arg("10K")
        .arg("zero-terminated.txt")
        .succeeds()
        .stdout_is_fixture("zero-terminated.expected");
}

#[test]
fn test_months_whitespace() {
    test_helper(
        "months-whitespace",
        &[
            "-M",
            "--month-sort",
            "--sort=month",
            "--sort=mont",
            "--sort=m",
        ],
    );
}

#[test]
fn test_version_empty_lines() {
    test_helper("version-empty-lines", &["-V", "--version-sort"]);
}

#[test]
fn test_version_sort_unstable() {
    new_ucmd!()
        .arg("--sort=version")
        .pipe_in("0.1\n0.02\n0.2\n0.002\n0.3\n")
        .succeeds()
        .stdout_is("0.1\n0.002\n0.02\n0.2\n0.3\n");
    new_ucmd!()
        .arg("--sort=versio") // spell-checker:disable-line
        .pipe_in("0.1\n0.02\n0.2\n0.002\n0.3\n")
        .succeeds()
        .stdout_is("0.1\n0.002\n0.02\n0.2\n0.3\n");
    new_ucmd!()
        .arg("--sort=v")
        .pipe_in("0.1\n0.02\n0.2\n0.002\n0.3\n")
        .succeeds()
        .stdout_is("0.1\n0.002\n0.02\n0.2\n0.3\n");
}

#[test]
fn test_version_sort_stable() {
    new_ucmd!()
        .arg("--stable")
        .arg("--sort=version")
        .pipe_in("0.1\n0.02\n0.2\n0.002\n0.3\n")
        .succeeds()
        .stdout_is("0.1\n0.02\n0.2\n0.002\n0.3\n");
}

#[test]
fn test_ignore_case_orders_punctuation_after_letters() {
    new_ucmd!()
        .arg("-f")
        .pipe_in("A\na\n_\n")
        .succeeds()
        .stdout_is("A\na\n_\n");
}

#[test]
fn test_ignore_case_unique_orders_punctuation_after_letters() {
    new_ucmd!()
        .arg("-fu")
        .pipe_in("a\n_\n")
        .succeeds()
        .stdout_is("a\n_\n");
}

#[test]
fn test_human_numeric_whitespace() {
    test_helper(
        "human-numeric-whitespace",
        &[
            "-h",
            "--human-numeric-sort",
            "--sort=human-numeric",
            "--sort=human-numeri", // spell-checker:disable-line
            "--sort=human",
            "--sort=h",
        ],
    );
}

// This tests where serde often fails when reading back JSON
// if it finds a null value
#[test]
fn test_ext_sort_as64_bailout() {
    new_ucmd!()
        .arg("-g")
        .arg("-S 5K")
        .arg("multiple_decimals_general.txt")
        .succeeds()
        .stdout_is_fixture("multiple_decimals_general.expected");
}

#[test]
fn test_multiple_decimals_general() {
    test_helper(
        "multiple_decimals_general",
        &[
            "-g",
            "--general-numeric-sort",
            "--sort=general-numeric",
            "--sort=general-numeri", // spell-checker:disable-line
            "--sort=general",
            "--sort=g",
        ],
    );
}

#[test]
fn test_multiple_decimals_numeric() {
    test_helper(
        "multiple_decimals_numeric",
        &["-n", "--numeric-sort", "--sort=numeric", "--sort=n"],
    );
}

#[test]
fn test_multiple_groupings_numeric() {
    test_helper(
        "multiple_groupings_numeric",
        &["-n", "--numeric-sort", "--sort=numeric", "--sort=n"],
    );
}

#[test]
fn test_numeric_with_trailing_invalid_chars() {
    test_helper(
        "numeric_trailing_chars",
        &["-n", "--numeric-sort", "--sort=numeric"],
    );
}

#[test]
fn test_check_zero_terminated_failure() {
    new_ucmd!()
        .arg("-z")
        .arg("-c")
        .arg("zero-terminated.txt")
        .fails()
        .stderr_only("sort: zero-terminated.txt:2: disorder: ../../fixtures/du\n");
}

#[test]
fn test_check_zero_terminated_success() {
    new_ucmd!()
        .arg("-z")
        .arg("-c")
        .arg("zero-terminated.expected")
        .succeeds();
}

#[test]
fn test_random_shuffle_len() {
    // check whether output is the same length as the input
    const FILE: &str = "default_unsorted_ints.expected";
    let (at, _ucmd) = at_and_ucmd!();
    let result = new_ucmd!().arg("-R").arg(FILE).succeeds().stdout_move_str();
    let expected = at.read(FILE);

    assert_ne!(result, expected);
    assert_eq!(result.len(), expected.len());
}

#[test]
fn test_random_shuffle_contains_all_lines() {
    // check whether lines of input are all in output
    const FILE: &str = "default_unsorted_ints.expected";
    let (at, _ucmd) = at_and_ucmd!();
    let result = new_ucmd!().arg("-R").arg(FILE).succeeds().stdout_move_str();
    let expected = at.read(FILE);
    let result_sorted = new_ucmd!()
        .pipe_in(result.clone())
        .succeeds()
        .stdout_move_str();

    assert_ne!(result, expected);
    assert_eq!(result_sorted, expected);
}

#[test]
fn test_random_shuffle_two_runs_not_the_same() {
    for arg in ["-R", "-k1,1R"] {
        // check to verify that two random shuffles are not equal; this has the
        // potential to fail in the very unlikely event that the random order is the same
        // as the starting order, or if both random sorts end up having the same order.
        const FILE: &str = "default_unsorted_ints.expected";
        let (at, _ucmd) = at_and_ucmd!();
        let result = new_ucmd!().arg(arg).arg(FILE).succeeds().stdout_move_str();
        let expected = at.read(FILE);
        let unexpected = new_ucmd!().arg(arg).arg(FILE).succeeds().stdout_move_str();

        assert_ne!(result, expected);
        assert_ne!(result, unexpected);
    }
}

#[test]
fn test_random_ignore_case() {
    let input = "ABC\nABc\nAbC\nAbc\naBC\naBc\nabC\nabc\n";
    new_ucmd!()
        .args(&["-fR"])
        .pipe_in(input)
        .succeeds()
        .stdout_is(input);
}

#[test]
fn test_numeric_floats_and_ints() {
    test_helper(
        "numeric_floats_and_ints",
        &["-n", "--numeric-sort", "--sort=numeric"],
    );
}

#[test]
fn test_numeric_floats() {
    test_helper(
        "numeric_floats",
        &["-n", "--numeric-sort", "--sort=numeric"],
    );
}

#[test]
fn test_numeric_floats_with_nan() {
    test_helper(
        "numeric_floats_with_nan",
        &["-n", "--numeric-sort", "--sort=numeric"],
    );
}

#[test]
fn test_numeric_unfixed_floats() {
    test_helper(
        "numeric_unfixed_floats",
        &["-n", "--numeric-sort", "--sort=numeric"],
    );
}

#[test]
fn test_numeric_fixed_floats() {
    test_helper(
        "numeric_fixed_floats",
        &["-n", "--numeric-sort", "--sort=numeric"],
    );
}

#[test]
fn test_numeric_unsorted_ints() {
    test_helper(
        "numeric_unsorted_ints",
        &["-n", "--numeric-sort", "--sort=numeric"],
    );
}

#[test]
fn test_human_block_sizes() {
    test_helper(
        "human_block_sizes",
        &["-h", "--human-numeric-sort", "--sort=human-numeric"],
    );
}

#[test]
fn test_month_default() {
    test_helper("month_default", &["-M", "--month-sort", "--sort=month"]);
}

#[test]
fn test_month_stable() {
    test_helper("month_stable", &["-Ms"]);
}

#[test]
fn test_default_unsorted_ints() {
    test_helper("default_unsorted_ints", &[""]);
}

#[test]
fn test_numeric_unique_ints() {
    test_helper("numeric_unsorted_ints_unique", &["-nu"]);
}

#[test]
fn test_version() {
    test_helper("version", &["-V"]);
}

#[test]
fn test_ignore_case() {
    test_helper("ignore_case", &["-f"]);
}

#[test]
fn test_dictionary_order() {
    test_helper("dictionary_order", &["-d"]);
}

#[test]
fn test_dictionary_order2() {
    new_ucmd!()
        .pipe_in("a👦🏻aa\tb\naaaa\tb") // spell-checker:disable-line
        .arg("-d")
        .succeeds()
        .stdout_only("a👦🏻aa\tb\naaaa\tb\n"); // spell-checker:disable-line
}

#[test]
fn test_non_printing_chars() {
    new_ucmd!()
        .pipe_in("a👦🏻aa\naaaa") // spell-checker:disable-line
        .arg("-i")
        .succeeds()
        .stdout_only("a👦🏻aa\naaaa\n"); // spell-checker:disable-line
}

#[test]
fn test_exponents_general() {
    test_helper("exponents_general", &["-g"]);
}

#[test]
fn test_exponents_positive_general() {
    new_ucmd!()
        .pipe_in("1\n2e3\n1e-5")
        .arg("-g")
        .succeeds()
        .stdout_only("1e-5\n1\n2e3\n");
}

#[test]
fn test_exponents_positive_numeric() {
    test_helper(
        "exponents-positive-numeric",
        &["-n", "--numeric-sort", "--sort=numeric"],
    );
}

#[test]
fn test_months_dedup() {
    test_helper("months-dedup", &["-Mu"]);
}

#[test]
fn test_mixed_floats_ints_chars_numeric() {
    test_helper(
        "mixed_floats_ints_chars_numeric",
        &["-n", "--numeric-sort", "--sort=numeric"],
    );
}

#[test]
fn test_mixed_floats_ints_chars_numeric_unique() {
    test_helper("mixed_floats_ints_chars_numeric_unique", &["-nu"]);
}

#[test]
fn test_words_unique() {
    test_helper("words_unique", &["-u"]);
}

#[test]
fn test_numeric_unique() {
    test_helper("numeric_unique", &["-nu"]);
}

#[test]
fn test_mixed_floats_ints_chars_numeric_reverse() {
    test_helper("mixed_floats_ints_chars_numeric_unique_reverse", &["-nur"]);
}

#[test]
fn test_mixed_floats_ints_chars_numeric_stable() {
    test_helper("mixed_floats_ints_chars_numeric_stable", &["-ns"]);
}

#[test]
fn test_numeric_floats_and_ints2() {
    for numeric_sort_param in ["-n", "--numeric-sort"] {
        let input = "1.444\n8.013\n1\n-8\n1.04\n-1";
        new_ucmd!()
            .arg(numeric_sort_param)
            .pipe_in(input)
            .succeeds()
            .stdout_only("-8\n-1\n1\n1.04\n1.444\n8.013\n");
    }
}

#[test]
fn test_numeric_floats2() {
    for numeric_sort_param in ["-n", "--numeric-sort"] {
        let input = "1.444\n8.013\n1.58590\n-8.90880\n1.040000000\n-.05";
        new_ucmd!()
            .arg(numeric_sort_param)
            .pipe_in(input)
            .succeeds()
            .stdout_only("-8.90880\n-.05\n1.040000000\n1.444\n1.58590\n8.013\n");
    }
}

#[test]
fn test_numeric_floats_with_nan2() {
    test_helper(
        "numeric-floats-with-nan2",
        &["-n", "--numeric-sort", "--sort=numeric"],
    );
}

#[test]
fn test_human_block_sizes2() {
    for human_numeric_sort_param in ["-h", "--human-numeric-sort", "--sort=human-numeric"] {
        let input = "8981K\n909991M\n-8T\n21G\n0.8M";
        new_ucmd!()
            .arg(human_numeric_sort_param)
            .pipe_in(input)
            .succeeds()
            .stdout_only("-8T\n8981K\n0.8M\n909991M\n21G\n");
    }
}

#[test]
fn test_human_numeric_zero_stable() {
    let input = "0M\n0K\n-0K\n-P\n-0M\n";
    new_ucmd!()
        .arg("-hs")
        .pipe_in(input)
        .succeeds()
        .stdout_only(input);
}

#[test]
fn test_month_default2() {
    for month_sort_param in ["-M", "--month-sort", "--sort=month"] {
        let input = "JAn\nMAY\n000may\nJun\nFeb";
        new_ucmd!()
            .arg(month_sort_param)
            .pipe_in(input)
            .succeeds()
            .stdout_only("000may\nJAn\nFeb\nMAY\nJun\n");
    }
}

/// Query the system for abbreviated month names via `locale abmon`.
/// Returns a vector of 12 month abbreviations in order (Jan..Dec),
/// or None if the command fails or returns unexpected output.
#[cfg(any(target_vendor = "apple", target_os = "openbsd"))]
fn get_system_abmon(locale: &str) -> Option<Vec<String>> {
    let output = Command::new("locale")
        .env("LC_ALL", locale)
        .arg("abmon")
        .output()
        .ok()?;
    if !output.status.success() {
        return None;
    }
    let text = String::from_utf8(output.stdout).ok()?;
    let months: Vec<String> = text
        .trim()
        .split(';')
        .map(String::from)
        .filter(|m| !m.is_empty())
        .collect();
    if months.len() == 12 {
        Some(months)
    } else {
        None
    }
}

/// Build shuffled input and sorted expected output from month names.
#[cfg(any(target_vendor = "apple", target_os = "openbsd"))]
fn month_sort_input_expected(months: &[String]) -> (String, String) {
    // Shuffled order: May, Dec, Jan, Jun, Feb, Mar, Apr, Jul, Aug, Sep, Oct, Nov
    let shuffle_order = [4, 11, 0, 5, 1, 2, 3, 6, 7, 8, 9, 10];
    let input = shuffle_order
        .iter()
        .map(|&i| months[i].as_str())
        .collect::<Vec<_>>()
        .join("\n")
        + "\n";
    let expected = months.join("\n") + "\n";
    (input, expected)
}

#[test]
#[cfg(unix)]
fn test_month_sort_french_locale() {
    let locale = "fr_FR.UTF-8";
    if !is_locale_available(locale) {
        return;
    }
    // spell-checker:disable
    // On macOS/OpenBSD, abbreviated month names vary across OS versions (different CLDR data),
    // so we query the system dynamically. On other platforms, glibc values are stable.
    #[cfg(any(target_vendor = "apple", target_os = "openbsd"))]
    let (input, expected) = {
        let Some(months) = get_system_abmon(locale) else {
            return;
        };
        month_sort_input_expected(&months)
    };
    #[cfg(not(any(target_vendor = "apple", target_os = "openbsd")))]
    let (input, expected) = (
        "mai\ndéc.\njanv.\njuin\nfévr.\nmars\navril\njuil.\naoût\nsept.\noct.\nnov.\n".to_string(),
        "janv.\nfévr.\nmars\navril\nmai\njuin\njuil.\naoût\nsept.\noct.\nnov.\ndéc.\n".to_string(),
    );
    // spell-checker:enable
    new_ucmd!()
        .env("LC_ALL", locale)
        .arg("-M")
        .pipe_in(input)
        .succeeds()
        .stdout_is(expected);
}

#[test]
#[cfg(unix)]
fn test_month_sort_hungarian_locale() {
    let locale = "hu_HU.UTF-8";
    if !is_locale_available(locale) {
        return;
    }
    // spell-checker:disable
    #[cfg(any(target_vendor = "apple", target_os = "openbsd"))]
    let (input, expected) = {
        let Some(months) = get_system_abmon(locale) else {
            return;
        };
        month_sort_input_expected(&months)
    };
    #[cfg(not(any(target_vendor = "apple", target_os = "openbsd")))]
    let (input, expected) = (
        "máj\ndec\njan\njún\nfebr\nmárc\nápr\njúl\naug\nszept\nokt\nnov\n".to_string(),
        "jan\nfebr\nmárc\nápr\nmáj\njún\njúl\naug\nszept\nokt\nnov\ndec\n".to_string(),
    );
    // spell-checker:enable
    new_ucmd!()
        .env("LC_ALL", locale)
        .arg("-M")
        .pipe_in(input)
        .succeeds()
        .stdout_is(expected);
}

/// Test that embedded blanks in month names cause a non-match (GNU compat).
/// E.g. "av   ril" should NOT match "avril" — GNU treats it as unknown.
#[test]
#[cfg(unix)]
fn test_month_sort_french_embedded_blanks() {
    let locale = "fr_FR.UTF-8";
    if !is_locale_available(locale) {
        return;
    }
    // spell-checker:disable
    // Pick three locale months (indices 2=March, 3=April, 5=June) and verify
    // that inserting blanks into April's name causes a non-match.
    // On glibc these are "mars", "avril", "juin"; on other systems they vary.
    #[cfg(any(target_vendor = "apple", target_os = "openbsd"))]
    let months = {
        let Some(m) = get_system_abmon(locale) else {
            return;
        };
        m
    };
    #[cfg(not(any(target_vendor = "apple", target_os = "openbsd")))]
    let months = vec![
        "janv.", "févr.", "mars", "avril", "mai", "juin", "juil.", "août", "sept.", "oct.", "nov.",
        "déc.",
    ]
    .into_iter()
    .map(String::from)
    .collect::<Vec<_>>();

    let march = &months[2];
    let april = &months[3];
    let june = &months[5];

    // Build a mangled version of April with embedded spaces: e.g. "avril" -> "av   ril"
    // Insert spaces after the second byte.
    if april.len() < 3 {
        // Month name too short to meaningfully insert blanks; skip.
        return;
    }
    let mangled = format!("{}   {}", &april[..2], &april[2..]);

    // Input: june, mangled-april, march
    let input = format!("{june}\n{mangled}\n{march}\n");
    // Expected: mangled sorts as unknown (first), then march (3), then june (6)
    let expected = format!("{mangled}\n{march}\n{june}\n");
    // spell-checker:enable
    new_ucmd!()
        .env("LC_ALL", locale)
        .arg("-M")
        .pipe_in(input)
        .succeeds()
        .stdout_is(expected);
}

#[test]
#[cfg(unix)]
fn test_month_sort_japanese_locale() {
    let locale = "ja_JP.UTF-8";
    if !is_locale_available(locale) {
        return;
    }
    // On macOS/OpenBSD, abbreviated month names may differ, so query dynamically.
    #[cfg(any(target_vendor = "apple", target_os = "openbsd"))]
    let (input, expected) = {
        let Some(months) = get_system_abmon(locale) else {
            return;
        };
        month_sort_input_expected(&months)
    };
    // Japanese abbreviated months are numeric (1月..12月) on glibc
    #[cfg(not(any(target_vendor = "apple", target_os = "openbsd")))]
    let (input, expected) = (
        "5月\n12月\n1月\n6月\n2月\n3月\n4月\n7月\n8月\n9月\n10月\n11月\n".to_string(),
        "1月\n2月\n3月\n4月\n5月\n6月\n7月\n8月\n9月\n10月\n11月\n12月\n".to_string(),
    );
    new_ucmd!()
        .env("LC_ALL", locale)
        .arg("-M")
        .pipe_in(input)
        .succeeds()
        .stdout_is(expected);
}

#[test]
fn test_default_unsorted_ints2() {
    let input = "9\n1909888\n000\n1\n2";
    new_ucmd!()
        .pipe_in(input)
        .succeeds()
        .stdout_only("000\n1\n1909888\n2\n9\n");
}

#[test]
fn test_numeric_unique_ints2() {
    let input = "9\n9\n8\n1\n";
    new_ucmd!()
        .arg("-nu")
        .pipe_in(input)
        .succeeds()
        .stdout_only("1\n8\n9\n");
}

#[test]
fn test_keys_open_ended() {
    test_helper("keys_open_ended", &["-k 2.3"]);
}

#[test]
fn test_keys_closed_range() {
    test_helper("keys_closed_range", &["-k 2.2,2.2"]);
}

#[test]
fn test_keys_multiple_ranges() {
    test_helper("keys_multiple_ranges", &["-k 2,2 -k 3,3"]);
}

#[test]
fn test_keys_no_field_match() {
    test_helper("keys_no_field_match", &["-k 4,4"]);
}

#[test]
fn test_keys_no_char_match() {
    test_helper("keys_no_char_match", &["-k 1.2"]);
}

#[test]
fn test_keys_custom_separator() {
    test_helper("keys_custom_separator", &["-k 2.2,2.2 -t x"]);
}

#[test]
fn test_keys_invalid_field() {
    new_ucmd!()
        .args(&["-k", "1."])
        .fails()
        .stderr_only("sort: invalid number after '.': invalid count at start of ''\n");
}

#[test]
fn test_keys_invalid_field_option() {
    new_ucmd!()
        .args(&["-k", "1.1x"])
        .fails()
        .stderr_only("sort: stray character in field spec: invalid field specification '1.1x'\n");
}

#[test]
fn test_keys_invalid_field_zero() {
    new_ucmd!()
        .args(&["-k", "0.1"])
        .fails()
        .stderr_only("sort: field number is zero: invalid field specification '0.1'\n");
}

#[test]
fn test_keys_invalid_char_zero() {
    new_ucmd!()
        .args(&["-k", "1.0"])
        .fails()
        .stderr_only("sort: character offset is zero: invalid field specification '1.0'\n");
}

#[test]
fn test_keys_invalid_number_formats() {
    new_ucmd!()
        .args(&["-k", "0"])
        .fails_with_code(2)
        .stderr_only("sort: field number is zero: invalid field specification '0'\n");

    new_ucmd!()
        .args(&["-k", "2.,3"])
        .fails_with_code(2)
        .stderr_only("sort: invalid number after '.': invalid count at start of ',3'\n");

    new_ucmd!()
        .args(&["-k", "2,"])
        .fails_with_code(2)
        .stderr_only("sort: invalid number after ',': invalid count at start of ''\n");

    new_ucmd!()
        .args(&["-k", "1.1,-k0"])
        .fails_with_code(2)
        .stderr_only("sort: invalid number after ',': invalid count at start of '-k0'\n");
}

#[test]
fn test_incompatible_options() {
    new_ucmd!()
        .arg("-hn")
        .fails_with_code(2)
        .stderr_only("sort: options '-hn' are incompatible\n");

    new_ucmd!()
        .arg("-in")
        .fails_with_code(2)
        .stderr_only("sort: options '-in' are incompatible\n");

    new_ucmd!()
        .arg("-nR")
        .fails_with_code(2)
        .stderr_only("sort: options '-nR' are incompatible\n");

    new_ucmd!()
        .arg("-dfgiMnR")
        .fails_with_code(2)
        .stderr_only("sort: options '-dfgMnR' are incompatible\n");

    new_ucmd!()
        .args(&["--sort=random", "-n"])
        .fails_with_code(2)
        .stderr_only("sort: options '-nR' are incompatible\n");

    new_ucmd!()
        .args(&["-c", "-o", "out"])
        .fails_with_code(2)
        .stderr_only("sort: options '-co' are incompatible\n");

    new_ucmd!()
        .args(&["-C", "-o", "out"])
        .fails_with_code(2)
        .stderr_only("sort: options '-Co' are incompatible\n");

    new_ucmd!()
        .args(&["-c", "-C"])
        .fails_with_code(2)
        .stderr_only("sort: options '-cC' are incompatible\n");
}

#[test]
fn test_keys_with_options() {
    let input = "aa 3 cc\ndd 1 ff\ngg 2 cc\n";
    for param in [
        &["-k", "2,2n"][..],
        &["-k", "2n,2"][..],
        &["-k", "2,2", "-n"][..],
    ] {
        new_ucmd!()
            .args(param)
            .pipe_in(input)
            .succeeds()
            .stdout_only("dd 1 ff\ngg 2 cc\naa 3 cc\n");
    }
}

#[test]
fn test_keys_with_options_blanks_start() {
    let input = "aa   3 cc\ndd  1 ff\ngg         2 cc\n";
    for param in [&["-k", "2b,2"][..], &["-k", "2,2", "-b"][..]] {
        new_ucmd!()
            .args(param)
            .pipe_in(input)
            .succeeds()
            .stdout_only("dd  1 ff\ngg         2 cc\naa   3 cc\n");
    }
}

#[test]
fn test_keys_blanks_with_char_idx() {
    test_helper("keys_blanks", &["-k 1.2b"]);
}

#[test]
fn test_keys_with_options_blanks_end() {
    let input = "a  b
a b
a   b
";
    new_ucmd!()
        .args(&["-k", "1,2.1b", "-s"])
        .pipe_in(input)
        .succeeds()
        .stdout_only(
            "a   b
a  b
a b
",
        );
}

#[test]
fn test_keys_stable() {
    let input = "a  b
a b
a   b
";
    new_ucmd!()
        .args(&["-k", "1,2.1", "-s"])
        .pipe_in(input)
        .succeeds()
        .stdout_only(
            "a  b
a b
a   b
",
        );
}

#[test]
fn test_keys_empty_match() {
    let input = "a a a a
aaaa
";
    new_ucmd!()
        .args(&["-k", "1,1", "-t", "a"])
        .pipe_in(input)
        .succeeds()
        .stdout_only(input);
}

#[test]
fn test_keys_negative_size_match() {
    // If the end of a field is before its start, we should not crash.
    // Debug output should report "no match for key" at the start position (i.e. the later position).
    test_helper("keys_negative_size", &["-k 3,1"]);
}

#[test]
fn test_keys_ignore_flag() {
    test_helper("keys_ignore_flag", &["-k 1n -b"]);
}

#[test]
fn test_does_not_inherit_key_settings() {
    let input = " 1
2
   10
";
    new_ucmd!()
        .args(&["-k", "1b", "-n"])
        .pipe_in(input)
        .succeeds()
        .stdout_only(
            " 1
   10
2
",
        );
}

#[test]
fn test_inherits_key_settings() {
    let input = " 1
2
   10
";
    new_ucmd!()
        .args(&["-k", "1", "-n"])
        .pipe_in(input)
        .succeeds()
        .stdout_only(
            " 1
2
   10
",
        );
}

#[test]
fn test_zero_terminated() {
    test_helper("zero-terminated", &["-z"]);
}

#[test]
fn test_multiple_files() {
    new_ucmd!()
        .arg("-n")
        .arg("multiple_files1.txt")
        .arg("multiple_files2.txt")
        .succeeds()
        .stdout_only_fixture("multiple_files.expected");
}

#[test]
fn test_merge_interleaved() {
    new_ucmd!()
        .arg("-m")
        .arg("merge_ints_interleaved_1.txt")
        .arg("merge_ints_interleaved_2.txt")
        .arg("merge_ints_interleaved_3.txt")
        .succeeds()
        .stdout_only_fixture("merge_ints_interleaved.expected");
}

#[test]
fn test_merge_unique() {
    new_ucmd!()
        .arg("-m")
        .arg("--unique")
        .arg("merge_ints_interleaved_1.txt")
        .arg("merge_ints_interleaved_2.txt")
        .arg("merge_ints_interleaved_3.txt")
        .arg("merge_ints_interleaved_3.txt")
        .arg("merge_ints_interleaved_2.txt")
        .arg("merge_ints_interleaved_1.txt")
        .succeeds()
        .stdout_only_fixture("merge_ints_interleaved.expected");
}

#[test]
fn test_merge_stable() {
    new_ucmd!()
        .arg("-m")
        .arg("--stable")
        .arg("-n")
        .arg("merge_stable_1.txt")
        .arg("merge_stable_2.txt")
        .succeeds()
        .stdout_only_fixture("merge_stable.expected");
}

#[test]
fn test_merge_reversed() {
    new_ucmd!()
        .arg("-m")
        .arg("--reverse")
        .arg("merge_ints_reversed_1.txt")
        .arg("merge_ints_reversed_2.txt")
        .arg("merge_ints_reversed_3.txt")
        .succeeds()
        .stdout_only_fixture("merge_ints_reversed.expected");
}

#[test]
fn test_pipe() {
    // TODO: issue 1608 reports a panic when we attempt to read from stdin,
    // which was closed by the other side of the pipe. This test does not
    // protect against regressions in that case; we should add one at some
    // point.
    new_ucmd!()
        .pipe_in("one\ntwo\nfour")
        .succeeds()
        .stdout_is("four\none\ntwo\n")
        .stderr_is("");
}

#[test]
fn test_check() {
    for diagnose_arg in [
        "-c",
        "--check",
        "--check=diagnose-first",
        "--check=diagnose",
        "--check=d",
    ] {
        new_ucmd!()
            .arg(diagnose_arg)
            .arg("check_fail.txt")
            .arg("--buffer-size=10b")
            .fails()
            .stderr_only("sort: check_fail.txt:6: disorder: 5\n");

        new_ucmd!()
            .arg(diagnose_arg)
            .arg("multiple_files.expected")
            .succeeds()
            .stderr_is("");
    }
}

#[test]
fn test_check_silent() {
    for silent_arg in [
        "-C",
        "--check=silent",
        "--check=quiet",
        "--check=silen", // spell-checker:disable-line
        "--check=quie",  // spell-checker:disable-line
        "--check=s",
        "--check=q",
    ] {
        new_ucmd!()
            .arg(silent_arg)
            .arg("check_fail.txt")
            .fails()
            .stdout_is("");
        new_ucmd!()
            .arg(silent_arg)
            .arg("empty.txt")
            .succeeds()
            .no_output();
    }
}

#[test]
fn test_check_unique() {
    new_ucmd!()
        .args(&["-c", "-u"])
        .pipe_in("A\nA\n")
        .fails_with_code(1)
        .stderr_only("sort: -:2: disorder: A\n");
}

#[test]
fn test_check_unique_combined() {
    new_ucmd!()
        .args(&["-cu"])
        .pipe_in("A\nA\n")
        .fails_with_code(1)
        .stderr_only("sort: -:2: disorder: A\n");
}

#[test]
fn test_dictionary_and_nonprinting_conflicts() {
    let conflicting_args = ["n", "h", "g", "M"];
    for restricted_arg in ["d", "i"] {
        for conflicting_arg in &conflicting_args {
            new_ucmd!()
                .arg(format!("-{restricted_arg}{conflicting_arg}"))
                .fails();
        }
        for conflicting_arg in &conflicting_args {
            new_ucmd!()
                .args(&[
                    format!("-{restricted_arg}").as_str(),
                    "-k",
                    format!("1,1{conflicting_arg}").as_str(),
                ])
                .succeeds();
        }
        for conflicting_arg in &conflicting_args {
            new_ucmd!()
                .args(&["-k", &format!("1{restricted_arg},1{conflicting_arg}")])
                .fails();
        }
    }
}

#[test]
fn test_trailing_separator() {
    new_ucmd!()
        .args(&["-t", "x", "-k", "1,1"])
        .pipe_in("aax\naaa\n")
        .succeeds()
        .stdout_is("aax\naaa\n");
}

#[test]
fn test_nonexistent_file() {
    new_ucmd!()
        .arg("nonexistent.txt")
        .fails_with_code(2)
        .stderr_only(
            #[cfg(not(windows))]
            "sort: cannot read: nonexistent.txt: No such file or directory\n",
            #[cfg(windows)]
            "sort: cannot read: nonexistent.txt: The system cannot find the file specified.\n",
        );
}

#[test]
fn test_blanks() {
    test_helper("blanks", &["-b", "--ignore-leading-blanks"]);
}

#[test]
fn sort_multiple() {
    new_ucmd!()
        .args(&["no_trailing_newline1.txt", "no_trailing_newline2.txt"])
        .succeeds()
        .stdout_is("a\nb\nb\n");
}

#[test]
fn sort_empty_chunk() {
    new_ucmd!()
        .args(&["-S", "40b"])
        .pipe_in("a\na\n")
        .succeeds()
        .stdout_is("a\na\n");
}

#[test]
#[cfg(any(target_os = "linux", target_os = "android"))]
fn test_compress() {
    new_ucmd!()
        .args(&[
            "ext_sort.txt",
            "-n",
            "--compress-program",
            "gzip",
            "-S",
            "10",
        ])
        .succeeds()
        .stdout_only_fixture("ext_sort.expected");
}

#[test]
#[cfg(any(target_os = "linux", target_os = "android"))]
fn test_compress_merge() {
    new_ucmd!()
        .args(&[
            "--compress-program",
            "gzip",
            "-S",
            "10",
            "--batch-size=2",
            "-m",
            "--unique",
            "merge_ints_interleaved_1.txt",
            "merge_ints_interleaved_2.txt",
            "merge_ints_interleaved_3.txt",
            "merge_ints_interleaved_3.txt",
            "merge_ints_interleaved_2.txt",
            "merge_ints_interleaved_1.txt",
        ])
        .succeeds()
        .stdout_only_fixture("merge_ints_interleaved.expected");
}

#[test]
#[cfg(not(target_os = "android"))]
fn test_compress_fail() {
    let result = new_ucmd!()
        .args(&[
            "ext_sort.txt",
            "-n",
            "--compress-program",
            "nonexistent-program",
            "-S",
            "10",
        ])
        .succeeds();

    #[cfg(not(windows))]
    result.stderr_contains(
        "sort: could not run compress program 'nonexistent-program': No such file or directory",
    );

    #[cfg(windows)]
    result.stderr_contains("could not run compress program");

    // Check that it still produces correct sorted output to stdout
    let expected = new_ucmd!()
        .args(&["ext_sort.txt", "-n"])
        .succeeds()
        .stdout_move_str();
    assert_eq!(result.stdout_str(), expected);
}

#[test]
fn test_merge_batches() {
    new_ucmd!()
        .timeout(Duration::from_secs(120))
        .args(&["ext_sort.txt", "-n", "-S", "150b"])
        .succeeds()
        .stdout_only_fixture("ext_sort.expected");
}

#[test]
fn test_batch_size_invalid() {
    new_ucmd!()
        .arg("--batch-size=0")
        .fails_with_code(2)
        .stderr_contains("sort: invalid --batch-size argument '0'")
        .stderr_contains("sort: minimum --batch-size argument is '2'");

    // with -m, the error path is a bit different
    new_ucmd!()
        .args(&["-m", "--batch-size=a"])
        .fails_with_code(2)
        .stderr_contains("sort: invalid --batch-size argument 'a'");
}

#[test]
fn test_batch_size_too_large() {
    let large_batch_size = "18446744073709551616";
    new_ucmd!()
        .arg(format!("--batch-size={large_batch_size}"))
        .fails_with_code(2)
        .stderr_contains(format!(
            "--batch-size argument '{large_batch_size}' too large"
        ));

    #[cfg(target_os = "linux")]
    new_ucmd!()
        .arg(format!("--batch-size={large_batch_size}"))
        .fails_with_code(2)
        .stderr_contains("maximum --batch-size argument with current rlimit is");
}

#[test]
fn test_merge_batch_size() {
    new_ucmd!()
        .arg("--batch-size=2")
        .arg("-m")
        .arg("--unique")
        .arg("merge_ints_interleaved_1.txt")
        .arg("merge_ints_interleaved_2.txt")
        .arg("merge_ints_interleaved_3.txt")
        .arg("merge_ints_interleaved_3.txt")
        .arg("merge_ints_interleaved_2.txt")
        .arg("merge_ints_interleaved_1.txt")
        .succeeds()
        .stdout_only_fixture("merge_ints_interleaved.expected");
}

#[test]
// TODO(#7542): Re-enable on Android once we figure out why setting limit is broken.
// #[cfg(any(target_os = "linux", target_os = "android"))]
#[cfg(target_os = "linux")]
fn test_merge_batch_size_with_limit() {
    use rlimit::Resource;
    // Currently need...
    // 3 descriptors for stdin, stdout, stderr
    // 2 descriptors for CTRL+C handling logic (to be reworked at some point)
    // 2 descriptors for the input files (i.e. batch-size of 2).
    let limit_fd = 3 + 2 + 2;
    new_ucmd!()
        .limit(Resource::NOFILE, limit_fd, limit_fd)
        .arg("--batch-size=2")
        .arg("-m")
        .arg("--unique")
        .arg("merge_ints_interleaved_1.txt")
        .arg("merge_ints_interleaved_2.txt")
        .arg("merge_ints_interleaved_3.txt")
        .arg("merge_ints_interleaved_3.txt")
        .arg("merge_ints_interleaved_2.txt")
        .arg("merge_ints_interleaved_1.txt")
        .succeeds()
        .stdout_only_fixture("merge_ints_interleaved.expected");
}

#[test]
fn test_sigpipe_panic() {
    let mut cmd = new_ucmd!();
    let mut child = cmd.args(&["ext_sort.txt"]).run_no_wait();
    // Dropping the stdout should not lead to an error.
    // The "Broken pipe" error should be silently ignored.
    child.close_stdout();
    child.wait().unwrap().no_stderr();
}

#[test]
fn test_conflict_check_out() {
    let cases = [
        ("-c=silent", "sort: options '-Co' are incompatible\n"),
        ("-c=quiet", "sort: options '-Co' are incompatible\n"),
        (
            "-c=diagnose-first",
            "sort: options '-co' are incompatible\n",
        ),
        ("-c", "sort: options '-co' are incompatible\n"),
        ("-C", "sort: options '-Co' are incompatible\n"),
    ];
    for (check_flag, expected) in &cases {
        new_ucmd!()
            .arg(check_flag)
            .arg("-o=/dev/null")
            .fails()
            .stderr_contains(expected);
    }
}

#[test]
fn test_key_takes_one_arg() {
    new_ucmd!()
        .args(&["-k", "2.3", "keys_open_ended.txt"])
        .succeeds()
        .stdout_is_fixture("keys_open_ended.expected");
}

#[test]
fn test_verifies_out_file() {
    let inputs = ["" /* no input */, "some input"];
    for &input in &inputs {
        new_ucmd!()
            .args(&["-o", "nonexistent_dir/nonexistent_file"])
            .pipe_in(input)
            .ignore_stdin_write_error()
            .fails_with_code(2)
            .stderr_only(
                #[cfg(not(windows))]
                "sort: open failed: nonexistent_dir/nonexistent_file: No such file or directory\n",
                #[cfg(windows)]
                "sort: open failed: nonexistent_dir/nonexistent_file: The system cannot find the path specified.\n",
            );
    }
}

#[test]
fn test_verifies_files_after_keys() {
    new_ucmd!()
        .args(&[
            "-o",
            "nonexistent_dir/nonexistent_file",
            "-k",
            "0",
            "nonexistent_dir/input_file",
        ])
        .fails_with_code(2)
        .stderr_contains("invalid field specification '0'");
}

#[test]
#[cfg(unix)]
fn test_verifies_input_files() {
    new_ucmd!()
        .args(&["/dev/random", "nonexistent_file"])
        .fails_with_code(2)
        .stderr_is("sort: cannot read: nonexistent_file: No such file or directory\n");
}

#[test]
fn test_separator_null() {
    new_ucmd!()
        .args(&["-k1,1", "-k3,3", "-t", "\\0"])
        .pipe_in("z\0a\0b\nz\0b\0a\na\0z\0z\n")
        .succeeds()
        .stdout_only("a\0z\0z\nz\0b\0a\nz\0a\0b\n");
}

#[test]
fn test_output_is_input() {
    let input = "a\nb\nc\n";
    let (at, mut ucmd) = at_and_ucmd!();

    at.touch("file");
    at.append("file", input);

    ucmd.args(&["-m", "-u", "-o", "file", "file", "file", "file"])
        .succeeds();
    assert_eq!(at.read("file"), input);
}

#[test]
#[cfg(unix)]
fn test_output_device() {
    new_ucmd!()
        .args(&["-o", "/dev/null"])
        .pipe_in("input")
        .succeeds();
}

#[test]
fn test_merge_empty_input() {
    new_ucmd!()
        .args(&["-m", "empty.txt"])
        .succeeds()
        .no_stderr()
        .no_stdout();
}

#[test]
fn test_no_error_for_version() {
    new_ucmd!()
        .arg("--version")
        .succeeds()
        .stdout_contains("sort");
}

#[test]
fn test_wrong_args_exit_code() {
    new_ucmd!()
        .arg("--misspelled")
        .fails_with_code(2)
        .stderr_contains("--misspelled");
}

#[test]
#[cfg(unix)]
fn test_tmp_files_deleted_on_sigint() {
    use std::{fs::read_dir, time::Duration};

    use nix::{sys::signal, unistd::Pid};
    use rand::{RngExt as _, SeedableRng, rngs::SmallRng};

    let (at, mut ucmd) = at_and_ucmd!();
    at.mkdir("tmp_dir");
    let file_name = "big_file_to_sort.txt";
    {
        use std::io::Write;
        let mut file = at.make_file(file_name);
        // approximately 20 MB
        for _ in 0..40 {
            let lines = SmallRng::seed_from_u64(123)
                .sample_iter(rand::distr::uniform::Uniform::new(0, 10000).unwrap())
                .take(100_000)
                .map(|x| x.to_string() + "\n")
                .collect::<String>();
            file.write_all(lines.as_bytes()).unwrap();
        }
    }
    ucmd.args(&[
        file_name,
        "--buffer-size=1", // with a small buffer size `sort` will be forced to create a temporary directory very soon.
        "--temporary-directory=tmp_dir",
    ]);
    let child = ucmd.run_no_wait();
    // wait a short amount of time so that `sort` can create a temporary directory.
    let mut timeout = Duration::from_millis(100);
    for _ in 0..5 {
        std::thread::sleep(timeout);
        if read_dir(at.plus("tmp_dir")).unwrap().next().is_some() {
            break;
        }
        timeout *= 2;
    }
    // `sort` should have created a temporary directory.
    assert!(read_dir(at.plus("tmp_dir")).unwrap().next().is_some());
    // kill sort with SIGINT
    signal::kill(Pid::from_raw(child.id() as i32), signal::SIGINT).unwrap();
    // wait for `sort` to exit
    child.wait().unwrap().code_is(2);
    // `sort` should have deleted the temporary directory again.
    assert!(read_dir(at.plus("tmp_dir")).unwrap().next().is_none());
}

#[test]
fn test_same_sort_mode_twice() {
    new_ucmd!().args(&["-k", "2n,2n", "empty.txt"]).succeeds();
}

#[test]
fn test_args_override() {
    new_ucmd!().args(&["-f", "-f"]).pipe_in("foo").succeeds();
}

#[test]
fn test_k_overflow() {
    let input = "2\n1\n";
    let output = "1\n2\n";
    new_ucmd!()
        .args(&["-k", "18446744073709551616"])
        .pipe_in(input)
        .succeeds()
        .stdout_is(output);
}

#[test]
fn test_human_blocks_r_and_q() {
    let input = "1Q\n1R\n";
    let output = "1R\n1Q\n";
    new_ucmd!()
        .args(&["-h"])
        .pipe_in(input)
        .succeeds()
        .stdout_is(output);
}

#[test]
fn test_args_check_conflict() {
    new_ucmd!().arg("-c").arg("-C").fails();
}

#[cfg(target_os = "linux")]
#[test]
fn test_failed_write_is_reported() {
    new_ucmd!()
        .pipe_in("hello")
        .set_stdout(std::fs::File::create("/dev/full").unwrap())
        .fails()
        .stderr_is("sort: write failed: 'standard output': No space left on device\n");
}

#[test]
// Test for GNU tests/sort/sort.pl "o2"
fn test_multiple_output_files() {
    new_ucmd!()
        .args(&["-o", "foo", "-o", "bar"])
        .fails_with_code(2)
        .stderr_is("sort: multiple output files specified\n");
}

#[test]
// Test for GNU tests/sort/sort.pl "o3"
fn test_duplicate_output_files_allowed() {
    new_ucmd!()
        .args(&["-o", "foo", "-o", "foo"])
        .pipe_in("")
        .succeeds()
        .no_stderr();
}

#[test]
fn test_output_file_with_leading_dash() {
    let test_cases = [
        (
            ["--output", "--dash-file"],
            "banana\napple\ncherry\n",
            "apple\nbanana\ncherry\n",
        ),
        (
            ["-o", "--another-dash-file"],
            "zebra\nxray\nyak\n",
            "xray\nyak\nzebra\n",
        ),
    ];

    for (args, input, expected) in test_cases {
        let (at, mut ucmd) = at_and_ucmd!();
        ucmd.args(&args).pipe_in(input).succeeds().no_stdout();

        assert_eq!(at.read(args[1]), expected);
    }
}

#[test]
// Test for GNU tests/sort/sort-files0-from.pl "f-extra-arg"
fn test_files0_from_extra_arg() {
    new_ucmd!()
        .args(&["--files0-from", "-", "foo"])
        .fails_with_code(2)
        .stderr_contains(
            "sort: extra operand 'foo'\nfile operands cannot be combined with --files0-from\n",
        )
        .no_stdout();
}

#[test]
// Test for GNU tests/sort/sort-files0-from.pl "missing"
fn test_files0_from_missing() {
    new_ucmd!()
        .args(&["--files0-from", "missing_file"])
        .fails_with_code(2)
        .stderr_only(
            #[cfg(not(windows))]
            "sort: open failed: missing_file: No such file or directory\n",
            #[cfg(windows)]
            "sort: open failed: missing_file: The system cannot find the file specified.\n",
        );
}

#[test]
// Test for GNU tests/sort/sort-files0-from.pl "minus-in-stdin"
fn test_files0_from_minus_in_stdin() {
    new_ucmd!()
        .args(&["--files0-from", "-"])
        .pipe_in("-")
        .fails_with_code(2)
        .stderr_only(
            "sort: when reading file names from standard input, no file name of '-' allowed\n",
        );
}

#[test]
// Test for GNU tests/sort/sort-files0-from.pl "empty"
fn test_files0_from_empty() {
    let (at, mut ucmd) = at_and_ucmd!();

    at.touch("file");

    ucmd.args(&["--files0-from", "file"])
        .fails_with_code(2)
        .stderr_only("sort: no input from 'file'\n");
}

#[test]
#[cfg(unix)]
fn test_files0_read_error() {
    new_ucmd!()
        .args(&["--files0-from", "."])
        .fails_with_code(2)
        .stderr_only("sort: cannot read: .: Is a directory\n");
}

#[cfg(target_os = "linux")]
#[test]
// Test for GNU tests/sort/sort-files0-from.pl "empty-non-regular"
fn test_files0_from_empty_non_regular() {
    new_ucmd!()
        .args(&["--files0-from", "/dev/null"])
        .fails_with_code(2)
        .stderr_only("sort: no input from '/dev/null'\n");
}

#[test]
// Test for GNU tests/sort/sort-files0-from.pl "nul-1"
fn test_files0_from_nul() {
    new_ucmd!()
        .args(&["--files0-from", "-"])
        .pipe_in("\0")
        .fails_with_code(2)
        .stderr_only("sort: -:1: invalid zero-length file name\n");
}

#[test]
// Test for GNU tests/sort/sort-files0-from.pl "nul-2"
fn test_files0_from_nul2() {
    new_ucmd!()
        .args(&["--files0-from", "-"])
        .pipe_in("\0\0")
        .fails_with_code(2)
        .stderr_only("sort: -:1: invalid zero-length file name\n");
}

#[test]
// Test for GNU tests/sort/sort-files0-from.pl "1"
fn test_files0_from_1() {
    let (at, mut ucmd) = at_and_ucmd!();

    at.touch("file");
    at.append("file", "a");

    ucmd.args(&["--files0-from", "-"])
        .pipe_in("file")
        .succeeds()
        .stdout_only("a\n");
}

#[test]
// Test for GNU tests/sort/sort-files0-from.pl "1a"
fn test_files0_from_1a() {
    let (at, mut ucmd) = at_and_ucmd!();

    at.touch("file");
    at.append("file", "a");

    ucmd.args(&["--files0-from", "-"])
        .pipe_in("file\0")
        .succeeds()
        .stdout_only("a\n");
}

#[test]
// Test for GNU tests/sort/sort-files0-from.pl "2"
fn test_files0_from_2() {
    let (at, mut ucmd) = at_and_ucmd!();

    at.touch("file");
    at.append("file", "a");

    ucmd.args(&["--files0-from", "-"])
        .pipe_in("file\0file")
        .succeeds()
        .stdout_only("a\na\n");
}

#[test]
// Test for GNU tests/sort/sort-files0-from.pl "2a"
fn test_files0_from_2a() {
    let (at, mut ucmd) = at_and_ucmd!();

    at.touch("file");
    at.append("file", "a");

    ucmd.args(&["--files0-from", "-"])
        .pipe_in("file\0file\0")
        .succeeds()
        .stdout_only("a\na\n");
}

#[test]
// Test for GNU tests/sort/sort-files0-from.pl "zero-len"
fn test_files0_from_zero_length() {
    new_ucmd!()
        .args(&["--files0-from", "-"])
        .pipe_in("g\0\0b\0\0")
        .fails_with_code(2)
        .stderr_only("sort: -:2: invalid zero-length file name\n");
}

#[test]
// Test for GNU tests/sort/sort-float.sh
fn test_g_float() {
    let input = "0\n-3.3621031431120935063e-4932\n3.3621031431120935063e-4932\n";
    let output = "-3.3621031431120935063e-4932\n0\n3.3621031431120935063e-4932\n";
    new_ucmd!()
        .args(&["-g"])
        .pipe_in(input)
        .succeeds()
        .stdout_is(output);
}

#[test]
fn test_g_float_locale_decimal_separator() {
    let Ok(locale_fr_utf8) = env::var("LOCALE_FR_UTF8") else {
        return;
    };
    if locale_fr_utf8 == "none" {
        return;
    }

    let ts = TestScenario::new("sort");

    ts.ucmd()
        .env("LC_ALL", &locale_fr_utf8)
        .args(&["-g", "--stable"])
        .pipe_in("1,9\n1,10\n")
        .succeeds()
        .stdout_is("1,10\n1,9\n");

    ts.ucmd()
        .env("LC_ALL", &locale_fr_utf8)
        .args(&["-g", "--stable"])
        .pipe_in("1.9\n1.10\n")
        .succeeds()
        .stdout_is("1.10\n1.9\n");
}

#[test]
#[cfg(unix)]
fn test_human_numeric_blank_thousands_sep_locale() {
    fn thousands_sep_for(locale: &str) -> Option<String> {
        let output = Command::new("locale")
            .arg("thousands_sep")
            .env("LC_ALL", locale)
            .output()
            .ok()?;
        if !output.status.success() {
            return None;
        }
        let sep = String::from_utf8_lossy(&output.stdout);
        let sep = sep.trim_end_matches(&['\n', '\r'][..]);
        if sep.is_empty() || sep.len() != 1 || !sep.chars().all(char::is_whitespace) {
            return None;
        }
        Some(sep.to_string())
    }

    let candidates = ["sv_SE.UTF-8", "sv_SE"];
    let mut selected_locale = None;
    let mut thousands_sep = None;
    for candidate in candidates {
        if let Some(sep) = thousands_sep_for(candidate) {
            selected_locale = Some(candidate.to_string());
            thousands_sep = Some(sep);
            break;
        }
    }

    let (Some(locale), Some(sep)) = (selected_locale, thousands_sep) else {
        return;
    };

    let line1 = format!("1 1k 1 M 4{sep}003 1M");
    let line2 = format!("2k 2M 2 k 4{sep}002 2");
    let line3 = format!("3M 3 3 G 4{sep}001 3k");
    let input = format!("{line1}\n{line2}\n{line3}\n");

    let ts = TestScenario::new("sort");
    ts.fixtures.write("blank-thousands.txt", &input);

    let cases = [
        (1, format!("{line1}\n{line2}\n{line3}\n")),
        (2, format!("{line3}\n{line1}\n{line2}\n")),
        (3, format!("{line1}\n{line2}\n{line3}\n")),
        (5, format!("{line3}\n{line2}\n{line1}\n")),
    ];

    for (key, expected) in cases {
        let key_str = key.to_string();
        ts.ucmd()
            .env("LC_ALL", &locale)
            .arg("-h")
            .arg("-k")
            .arg(&key_str)
            .arg("blank-thousands.txt")
            .succeeds()
            .stdout_is(expected);
    }
}

#[test]
// Test misc numbers ("'a" is not interpreted as literal, trailing text is ignored...)
fn test_g_misc() {
    let input = "1\n100\n90\n'a\n85hello\n";
    let output = "'a\n1\n85hello\n90\n100\n";
    new_ucmd!()
        .args(&["-g"])
        .pipe_in(input)
        .succeeds()
        .stdout_is(output);
}

#[test]
// Test numbers with a large number of digits, where only the last digit is different.
// We use scientific notation to make sure string sorting does not correctly order them.
fn test_g_arbitrary() {
    let input = [
        // GNU coreutils doesn't handle those correctly as they don't fit exactly in long double
        "3",
        "3.000000000000000000000000000000000000000000000000000000000000000004",
        "0.3000000000000000000000000000000000000000000000000000000000000000002e1",
        "0.03000000000000000000000000000000000000000000000000000000000000000003e2",
        "0.003000000000000000000000000000000000000000000000000000000000000000001e3",
        // GNU coreutils does handle those correctly though
        "10",
        "10.000000000000004",
        "1.0000000000000002e1",
        "0.10000000000000003e2",
        "0.010000000000000001e3",
    ]
    .join("\n");
    let output = [
        "3",
        "0.003000000000000000000000000000000000000000000000000000000000000000001e3",
        "0.3000000000000000000000000000000000000000000000000000000000000000002e1",
        "0.03000000000000000000000000000000000000000000000000000000000000000003e2",
        "3.000000000000000000000000000000000000000000000000000000000000000004",
        "10",
        "0.010000000000000001e3",
        "1.0000000000000002e1",
        "0.10000000000000003e2",
        "10.000000000000004",
    ]
    .join("\n")
        + "\n";
    new_ucmd!()
        .args(&["-g"])
        .pipe_in(input)
        .succeeds()
        .stdout_is(output);
}

#[test]
// Test hexadecimal numbers (and hex floats)
fn test_g_float_hex() {
    let input = "0x123\n0x0\n0x2p10\n0x9p-10\n";
    let output = "0x0\n0x9p-10\n0x123\n0x2p10\n";
    new_ucmd!()
        .args(&["-g"])
        .pipe_in(input)
        .succeeds()
        .stdout_is(output);
}

/* spell-checker: disable */
#[test]
fn test_french_translations() {
    // Test that French translations work for clap error messages
    // Set LANG to French and test with an invalid argument
    let result = new_ucmd!()
        .env("LANG", "fr_FR.UTF-8")
        .env("LC_ALL", "fr_FR.UTF-8")
        .arg("--invalid-arg")
        .fails();

    let stderr = result.stderr_str();
    assert!(stderr.contains("erreur"));
    assert!(stderr.contains("argument inattendu"));
    assert!(stderr.contains("trouvé"));
}

#[test]
fn test_argument_suggestion() {
    let test_cases = vec![
        ("en_US.UTF-8", vec!["tip", "similar", "--reverse"]),
        ("fr_FR.UTF-8", vec!["conseil", "similaire", "--reverse"]),
    ];

    for (locale, expected_strings) in test_cases {
        let result = new_ucmd!()
            .env("LANG", locale)
            .env("LC_ALL", locale)
            .arg("--revrse") // Typo
            .fails();

        let stderr = result.stderr_str();
        for expected in expected_strings {
            assert!(stderr.contains(expected));
        }
    }
}

#[test]
fn test_clap_localization_unknown_argument() {
    let test_cases = vec![
        (
            "en_US.UTF-8",
            vec![
                "error: unexpected argument '--unknown-option' found",
                "Usage:",
                "For more information, try '--help'.",
            ],
        ),
        (
            "fr_FR.UTF-8",
            vec![
                "erreur : argument inattendu '--unknown-option' trouvé",
                "Utilisation:",
                "Pour plus d'informations, essayez '--help'.",
            ],
        ),
    ];

    for (locale, expected_strings) in test_cases {
        let result = new_ucmd!()
            .env("LANG", locale)
            .env("LC_ALL", locale)
            .arg("--unknown-option")
            .fails();

        result.code_is(2); // sort uses exit code 2 for invalid options
        let stderr = result.stderr_str();
        for expected in expected_strings {
            assert!(stderr.contains(expected));
        }
    }
}

#[test]
fn test_clap_localization_help_message() {
    // Test help message in English
    let result_en = new_ucmd!()
        .env("LANG", "en_US.UTF-8")
        .env("LC_ALL", "en_US.UTF-8")
        .arg("--help")
        .succeeds();

    let stdout_en = result_en.stdout_str();
    assert!(stdout_en.contains("Usage:"));
    assert!(stdout_en.contains("Options:"));

    // Test help message in French
    let result_fr = new_ucmd!()
        .env("LANG", "fr_FR.UTF-8")
        .env("LC_ALL", "fr_FR.UTF-8")
        .arg("--help")
        .succeeds();

    let stdout_fr = result_fr.stdout_str();
    assert!(stdout_fr.contains("Utilisation:"));
    assert!(stdout_fr.contains("Options:"));
}

#[test]
fn test_clap_localization_missing_required_argument() {
    // Test missing required argument
    let result_en = new_ucmd!().env("LC_ALL", "en_US.UTF-8").arg("-k").fails();

    let stderr_en = result_en.stderr_str();
    assert!(stderr_en.contains(" a value is required for '--key <key>' but none was supplied"));
    assert!(stderr_en.contains("-k"));
}

#[test]
fn test_clap_localization_invalid_value() {
    let test_cases = vec![
        (
            "en_US.UTF-8",
            "sort: invalid number at field start: invalid count at start of 'invalid'",
        ),
        (
            "fr_FR.UTF-8",
            "sort: nombre invalide au début du champ: nombre invalide au début de 'invalid'",
        ),
    ];

    for (locale, expected_message) in test_cases {
        let result = new_ucmd!()
            .env("LANG", locale)
            .env("LC_ALL", locale)
            .arg("-k")
            .arg("invalid")
            .fails();

        let stderr = result.stderr_str();
        assert!(stderr.contains(expected_message));
    }
}

#[test]
fn test_help_colors_enabled() {
    // Test that help messages have ANSI color codes when colors are forced
    let test_cases = vec![("en_US.UTF-8", "Usage"), ("fr_FR.UTF-8", "Utilisation")];

    for (locale, usage_word) in test_cases {
        let result = new_ucmd!()
            .env("LANG", locale)
            .env("LC_ALL", locale)
            .env("CLICOLOR_FORCE", "1")
            .arg("--help")
            .succeeds();

        let stdout = result.stdout_str();

        // Check for ANSI bold+underline codes around the usage header
        let expected_pattern = format!("\x1b[1m\x1b[4m{usage_word}:\x1b[0m");
        assert!(
            stdout.contains(&expected_pattern),
            "Expected bold+underline '{usage_word}:' in locale {locale}, got: {}",
            stdout.lines().take(10).collect::<Vec<_>>().join("\\n")
        );
    }
}

#[test]
fn test_help_colors_disabled() {
    // Test that help messages don't have ANSI color codes when colors are disabled
    let test_cases = vec![("en_US.UTF-8", "Usage"), ("fr_FR.UTF-8", "Utilisation")];

    for (locale, usage_word) in test_cases {
        let result = new_ucmd!()
            .env("LANG", locale)
            .env("LC_ALL", locale)
            .env("NO_COLOR", "1")
            .arg("--help")
            .succeeds();

        let stdout = result.stdout_str();

        // Check that we have the usage word but no ANSI codes
        assert!(stdout.contains(&format!("{usage_word}:")));
        assert!(
            !stdout.contains("\x1b["),
            "Found ANSI escape codes when colors should be disabled in locale {locale}"
        );
    }
}

#[test]
fn test_error_colors_enabled() {
    // Test that error messages have ANSI color codes when colors are forced
    let test_cases = vec![
        ("en_US.UTF-8", "error", "tip"),
        ("fr_FR.UTF-8", "erreur", "conseil"),
    ];

    for (locale, error_word, tip_word) in test_cases {
        let result = new_ucmd!()
            .env("LANG", locale)
            .env("LC_ALL", locale)
            .env("CLICOLOR_FORCE", "1")
            .arg("--numerc") // Typo to trigger suggestion for --numeric-sort
            .fails();

        let stderr = result.stderr_str();

        // Check for colored error word (red)
        let colored_error = format!("\x1b[31m{error_word}\x1b[0m");
        assert!(
            stderr.contains(&colored_error),
            "Expected red '{error_word}' in locale {locale}, got: {}",
            stderr.lines().take(5).collect::<Vec<_>>().join("\\n")
        );

        // Check for colored tip word (green)
        let colored_tip = format!("\x1b[32m{tip_word}\x1b[0m");
        assert!(
            stderr.contains(&colored_tip),
            "Expected green '{tip_word}' in locale {locale}, got: {}",
            stderr.lines().take(5).collect::<Vec<_>>().join("\\n")
        );
    }
}

#[test]
fn test_error_colors_disabled() {
    // Test that error messages don't have ANSI color codes when colors are disabled
    let test_cases = vec![
        ("en_US.UTF-8", "error", "tip"),
        ("fr_FR.UTF-8", "erreur", "conseil"),
    ];

    for (locale, error_word, tip_word) in test_cases {
        let result = new_ucmd!()
            .env("LANG", locale)
            .env("LC_ALL", locale)
            .env("NO_COLOR", "1")
            .arg("--numerc") // Typo to trigger suggestion for --numeric-sort
            .fails();

        let stderr = result.stderr_str();

        // Check that we have the error and tip words but no ANSI codes
        assert!(stderr.contains(error_word));
        assert!(stderr.contains(tip_word));
        assert!(
            !stderr.contains("\x1b["),
            "Found ANSI escape codes when colors should be disabled in locale {locale}"
        );
    }
}

#[test]
fn test_argument_suggestion_colors_enabled() {
    // Test that argument suggestions have colors
    let test_cases = vec![
        ("en_US.UTF-8", "tip", "--reverse"),
        ("fr_FR.UTF-8", "conseil", "--reverse"),
    ];

    for (locale, _tip_word, suggestion) in test_cases {
        let result = new_ucmd!()
            .env("LANG", locale)
            .env("LC_ALL", locale)
            .env("CLICOLOR_FORCE", "1")
            .arg("--revrse") // Typo to trigger suggestion
            .fails();

        let stderr = result.stderr_str();

        // Check for colored invalid argument (yellow)
        let colored_invalid = "\x1b[33m--revrse\x1b[0m";
        assert!(
            stderr.contains(colored_invalid),
            "Expected yellow '--revrse' in locale {locale}, got: {}",
            stderr.lines().take(10).collect::<Vec<_>>().join("\\n")
        );

        // Check for colored suggestion (green)
        let colored_suggestion = format!("\x1b[32m{suggestion}\x1b[0m");
        assert!(
            stderr.contains(&colored_suggestion),
            "Expected green '{suggestion}' in locale {locale}, got: {}",
            stderr.lines().take(10).collect::<Vec<_>>().join("\\n")
        );
    }
}

#[test]
fn test_debug_key_annotations() {
    let ts = TestScenario::new("sort");
    let output = debug_key_annotation_output(&ts);

    assert_eq!(output, EXPECTED_DEBUG_KEY_ANNOTATION);
}

#[test]
fn test_debug_key_annotations_locale() {
    let ts = TestScenario::new("sort");

    if let Ok(locale_fr_utf8) = env::var("LOCALE_FR_UTF8") {
        if locale_fr_utf8 != "none" {
            let probe = ts
                .ucmd()
                .args(&["-g", "--debug", "/dev/null"])
                .env("LC_NUMERIC", &locale_fr_utf8)
                .env("LC_MESSAGES", "C")
                .run();
            if probe
                .stderr_str()
                .contains("numbers use .*,.* as a decimal point")
            {
                let mut locale_output = String::new();
                locale_output.push_str(
                    &ts.ucmd()
                        .env("LC_ALL", "C")
                        .args(&["--debug", "-k2g", "-k1b,1"])
                        .pipe_in("   1²---++3   1,234  Mi\n")
                        .succeeds()
                        .stdout_move_str(),
                );
                locale_output.push_str(
                    &ts.ucmd()
                        .env("LC_ALL", &locale_fr_utf8)
                        .args(&["--debug", "-k2g", "-k1b,1"])
                        .pipe_in("   1²---++3   1,234  Mi\n")
                        .succeeds()
                        .stdout_move_str(),
                );
                locale_output.push_str(
                    &ts.ucmd()
                        .env("LC_ALL", &locale_fr_utf8)
                        .args(&[
                            "--debug", "-k1,1n", "-k1,1g", "-k1,1h", "-k2,2n", "-k2,2g", "-k2,2h",
                            "-k3,3n", "-k3,3g", "-k3,3h",
                        ])
                        .pipe_in("+1234 1234Gi 1,234M\n")
                        .succeeds()
                        .stdout_move_str(),
                );

                let normalized = locale_output
                    .lines()
                    .map(|line| {
                        if line.starts_with("^^ ") {
                            "^ no match for key".to_string()
                        } else {
                            line.to_string()
                        }
                    })
                    .collect::<Vec<_>>()
                    .join("\n")
                    + "\n";

                assert_eq!(normalized, EXPECTED_DEBUG_KEY_ANNOTATION_LOCALE);
            }
        }
    }
}

fn debug_key_annotation_output(ts: &TestScenario) -> String {
    let number = |input: &str| -> String {
        let mut out = String::new();
        for (idx, line) in input.split_terminator('\n').enumerate() {
            // build efficiently without collecting intermediary Strings
            writeln!(&mut out, "{}\t{line}", idx + 1).unwrap();
        }
        out
    };

    let run_sort = |args: &[&str], input: &str| -> String {
        ts.ucmd()
            .args(args)
            .pipe_in(input)
            .succeeds()
            .stdout_move_str()
    };

    let mut output = String::new();
    for mode in ["n", "h", "g"] {
        output.push_str(&run_sort(
            &["-s", &format!("-k2{mode}"), "--debug"],
            "1\n\n44\n33\n2\n",
        ));
        output.push_str(&run_sort(
            &["-s", &format!("-k1.3{mode}"), "--debug"],
            "1\n\n44\n33\n2\n",
        ));
        output.push_str(&run_sort(
            &["-s", &format!("-k1{mode}"), "--debug"],
            "1\n\n44\n33\n2\n",
        ));
        output.push_str(&run_sort(&["-s", "-k2g", "--debug"], &number("2\n\n1\n")));
    }

    output.push_str(&run_sort(&["-s", "-k1M", "--debug"], "FEB\n\nJAN\n"));
    output.push_str(&run_sort(&["-s", "-k2,2M", "--debug"], "FEB\n\nJAN\n"));
    output.push_str(&run_sort(&["-s", "-k1M", "--debug"], "FEB\nJAZZ\n\nJAN\n"));
    output.push_str(&run_sort(
        &["-s", "-k2,2M", "--debug"],
        &number("FEB\nJAZZ\n\nJAN\n"),
    ));
    output.push_str(&run_sort(&["-s", "-k1M", "--debug"], "FEB\nJANZ\n\nJAN\n"));
    output.push_str(&run_sort(
        &["-s", "-k2,2M", "--debug"],
        &number("FEB\nJANZ\n\nJAN\n"),
    ));

    output.push_str(&run_sort(
        &["-s", "-g", "--debug"],
        " 1.2ignore\n 1.1e4ignore\n",
    ));
    output.push_str(&run_sort(&["-s", "-d", "--debug"], "\tb\n\t\ta\n"));
    output.push_str(&run_sort(&["-s", "-k2,2", "--debug"], "a\n\n"));
    output.push_str(&run_sort(&["-s", "-k1", "--debug"], "b\na\n"));
    output.push_str(&run_sort(
        &["-s", "--debug", "-k1,1h"],
        "-0\n1\n-2\n--Mi-1\n-3\n-0\n",
    ));
    output.push_str(&run_sort(&["-b", "--debug"], " 1\n1\n"));
    output.push_str(&run_sort(&["-s", "-b", "--debug"], " 1\n1\n"));
    output.push_str(&run_sort(&["--debug"], " 1\n1\n"));
    output.push_str(&run_sort(&["-s", "-k1n", "--debug"], "2,5\n2.4\n"));
    output.push_str(&run_sort(&["-s", "-k1n", "--debug"], "2.,,3\n2.4\n"));
    output.push_str(&run_sort(&["-s", "-k1n", "--debug"], "2,,3\n2.4\n"));
    output.push_str(&run_sort(
        &["-s", "-n", "-z", "--debug"],
        concat!("1a\0", "2b\0"),
    ));

    let mut zero_mix = ts
        .ucmd()
        .args(&["-s", "-k2b,2", "--debug"])
        .pipe_in("\0\ta\n")
        .succeeds()
        .stdout_move_bytes();
    zero_mix.retain(|b| *b != 0);
    output.push_str(&String::from_utf8(zero_mix).unwrap());

    output.push_str(&run_sort(
        &["-s", "-k2.4b,2.3n", "--debug"],
        "A\tchr10\nB\tchr1\n",
    ));
    output.push_str(&run_sort(&["-s", "-k1.2b", "--debug"], "1 2\n1 3\n"));

    output
}

const EXPECTED_DEBUG_KEY_ANNOTATION: &str = r"1
 ^ no match for key

^ no match for key
44
  ^ no match for key
33
  ^ no match for key
2
 ^ no match for key
1
 ^ no match for key

^ no match for key
44
  ^ no match for key
33
  ^ no match for key
2
 ^ no match for key

^ no match for key
1
_
2
_
33
__
44
__
2>
  ^ no match for key
3>1
  _
1>2
  _
1
 ^ no match for key

^ no match for key
44
  ^ no match for key
33
  ^ no match for key
2
 ^ no match for key
1
 ^ no match for key

^ no match for key
44
  ^ no match for key
33
  ^ no match for key
2
 ^ no match for key

^ no match for key
1
_
2
_
33
__
44
__
2>
  ^ no match for key
3>1
  _
1>2
  _
1
 ^ no match for key

^ no match for key
44
  ^ no match for key
33
  ^ no match for key
2
 ^ no match for key
1
 ^ no match for key

^ no match for key
44
  ^ no match for key
33
  ^ no match for key
2
 ^ no match for key

^ no match for key
1
_
2
_
33
__
44
__
2>
  ^ no match for key
3>1
  _
1>2
  _

^ no match for key
JAN
___
FEB
___
FEB
   ^ no match for key

^ no match for key
JAN
   ^ no match for key
JAZZ
^ no match for key

^ no match for key
JAN
___
FEB
___
2>JAZZ
  ^ no match for key
3>
  ^ no match for key
4>JAN
  ___
1>FEB
  ___

^ no match for key
JANZ
___
JAN
___
FEB
___
3>
  ^ no match for key
2>JANZ
  ___
4>JAN
  ___
1>FEB
  ___
 1.2ignore
 ___
 1.1e4ignore
 _____
>>a
___
>b
__
a
 ^ no match for key

^ no match for key
a
_
b
_
-3
__
-2
__
-0
__
--Mi-1
^ no match for key
-0
__
1
_
 1
 _
__
1
_
_
 1
 _
1
_
 1
__
1
_
2,5
_
2.4
___
2.,,3
__
2.4
___
2,,3
_
2.4
___
1a
_
2b
_
>a
 _
A>chr10
     ^ no match for key
B>chr1
     ^ no match for key
1 2
 __
1 3
 __
";

const EXPECTED_DEBUG_KEY_ANNOTATION_LOCALE: &str = r"   1²---++3   1,234  Mi
               _
   _________
________________________
   1²---++3   1,234  Mi
              _____
   ________
_______________________
+1234 1234Gi 1,234M
^ no match for key
_____
^ no match for key
      ____
      ____
      _____
             _____
             _____
             ______
___________________
";

#[test]
fn test_color_environment_variables() {
    // Test different color environment variable combinations
    let test_env_vars = vec![
        // Colors should be enabled
        (vec![("CLICOLOR_FORCE", "1")], true, "CLICOLOR_FORCE=1"),
        // Colors should be disabled
        (vec![("NO_COLOR", "1")], false, "NO_COLOR=1"),
        (
            vec![("NO_COLOR", "1"), ("CLICOLOR_FORCE", "1")],
            false,
            "NO_COLOR overrides CLICOLOR_FORCE",
        ),
    ];

    for (env_vars, should_have_colors, description) in test_env_vars {
        let mut cmd = new_ucmd!();
        cmd.env("LANG", "en_US.UTF-8");

        for (key, value) in env_vars {
            cmd.env(key, value);
        }

        let result = cmd.arg("--help").succeeds();
        let stdout = result.stdout_str();

        let has_ansi_codes = stdout.contains("\x1b[");
        assert_eq!(
            has_ansi_codes, should_have_colors,
            "Color test failed for {description}: expected colors={should_have_colors}, found ANSI codes={has_ansi_codes}"
        );
    }
}

#[test]
fn test_start_buffer() {
    // Test that a file with the exact same size as the start buffer is handled correctly
    const FILE_B: &[u8] = &[b'b'; 8_000];
    const FILE_A: &[u8] = b"aaa";

    let mut expected = FILE_A.to_vec();
    expected.push(b'\n');
    expected.extend_from_slice(FILE_B);
    expected.push(b'\n');

    let (at, mut ucmd) = at_and_ucmd!();

    at.write_bytes("b", FILE_B);
    at.write_bytes("a", FILE_A);

    ucmd.args(&["b", "a"])
        .succeeds()
        .stdout_only_bytes(&expected);
}

#[test]
fn test_locale_collation_c_locale() {
    // C locale uses byte order - this is deterministic and tests the fix for #9148
    // Accented characters (UTF-8 multibyte) sort after ASCII letters
    let input = "é\ne\nE\na\nA\nz\n";
    // C locale byte order: A=0x41, E=0x45, a=0x61, e=0x65, z=0x7A, é=0xC3 0xA9
    let expected = "A\nE\na\ne\nz\né\n";

    new_ucmd!()
        .env("LC_ALL", "C")
        .pipe_in(input)
        .succeeds()
        .stdout_is(expected);
}

#[test]
fn test_locale_collation_utf8() {
    // Test French UTF-8 locale handling - behavior depends on i18n-collator feature
    // With feature: locale-aware collation (é sorts near e)
    // Without feature: byte order (é after z, since 0xC3A9 > 0x7A)
    let input = "z\né\ne\na\n";

    let result = new_ucmd!()
        .env("LC_ALL", "fr_FR.UTF-8")
        .pipe_in(input)
        .succeeds();

    let output = result.stdout_str();
    let lines: Vec<&str> = output.lines().collect();

    assert_eq!(lines.len(), 4, "Expected 4 sorted lines");
    assert_eq!(lines[0], "a", "'a' (0x61) should always sort first");

    // Validate based on which collation mode is active
    if lines[3] == "é" {
        // Byte order mode: é (0xC3A9) > z (0x7A)
        assert_eq!(
            lines,
            vec!["a", "e", "z", "é"],
            "Byte order mode: expected a < e < z < é"
        );
    } else {
        // Locale collation mode: é sorts with base letter e
        assert_eq!(lines[3], "z", "Locale mode: 'z' should sort last");
        let z_pos = lines.iter().position(|&x| x == "z").unwrap();
        let e_pos = lines.iter().position(|&x| x == "e").unwrap();
        let e_accent_pos = lines.iter().position(|&x| x == "é").unwrap();
        assert!(
            e_pos < z_pos && e_accent_pos < z_pos,
            "Locale mode: 'e' ({e_pos}) and 'é' ({e_accent_pos}) should sort before 'z' ({z_pos})"
        );
    }
}

#[test]
fn test_locale_interleaved_en_us_utf8() {
    // Test case for issue: locale-based collation support
    // In en_US.UTF-8, lowercase and uppercase letters should interleave
    // Expected: a, A, b, B (locale-aware)
    // Not: A, B, a, b (ASCII byte order)
    new_ucmd!()
        .env("LC_ALL", "en_US.UTF-8")
        .pipe_in("a\nA\nb\nB\n")
        .succeeds()
        .stdout_is("a\nA\nb\nB\n");
}

#[test]
fn test_locale_c_byte_order() {
    // Test case for issue: C locale should use ASCII byte order
    // In C locale: A < B < a < b (uppercase before lowercase)
    new_ucmd!()
        .env("LC_ALL", "C")
        .pipe_in("a\nA\nb\nB\n")
        .succeeds()
        .stdout_is("A\nB\na\nb\n");
}

#[test]
fn test_locale_posix_byte_order() {
    // POSIX locale should behave like C locale
    new_ucmd!()
        .env("LC_ALL", "POSIX")
        .pipe_in("a\nA\nb\nB\n")
        .succeeds()
        .stdout_is("A\nB\na\nb\n");
}

#[test]
fn test_locale_with_ignore_case_flag() {
    // When -f (ignore case) is used, the comparison uses custom_str_cmp
    // which converts to uppercase for comparison. With -f flag, all letters
    // are treated as equivalent regardless of case, so original order is preserved
    // for equal keys (stable sort behavior within equal elements).
    // Note: This may differ slightly from GNU in tie-breaking behavior.
    let result = new_ucmd!()
        .env("LC_ALL", "en_US.UTF-8")
        .arg("-f")
        .pipe_in("a\nA\nb\nB\n")
        .succeeds();

    // Verify that a/A come before b/B (case-insensitive grouping works)
    let output = result.stdout_str();
    let lines: Vec<&str> = output.lines().collect();
    assert_eq!(lines.len(), 4);
    // a and A should come before b and B
    let a_positions: Vec<usize> = lines
        .iter()
        .enumerate()
        .filter(|(_, l)| **l == "a" || **l == "A")
        .map(|(i, _)| i)
        .collect();
    let b_positions: Vec<usize> = lines
        .iter()
        .enumerate()
        .filter(|(_, l)| **l == "b" || **l == "B")
        .map(|(i, _)| i)
        .collect();
    assert!(
        a_positions
            .iter()
            .all(|&a| b_positions.iter().all(|&b| a < b)),
        "All 'a'/'A' should come before 'b'/'B' with -f flag"
    );
}

#[test]
fn test_locale_complex_utf8_sorting() {
    // More complex test with mixed case and special characters
    // In en_US.UTF-8, should respect locale collation rules
    // Locale collation is case-insensitive by default, with lowercase < uppercase for same base letter
    let input = "zebra\nApple\napple\nBanana\nbanana\nZebra\n";

    new_ucmd!()
        .env("LC_ALL", "en_US.UTF-8")
        .pipe_in(input)
        .succeeds()
        .stdout_is("apple\nApple\nbanana\nBanana\nzebra\nZebra\n");
}

#[test]
fn test_locale_posix_sort_debug_message() {
    new_ucmd!()
        .env("LC_ALL", "C")
        .arg("--debug")
        .pipe_in("a\nA\nb\nB\n")
        .succeeds()
        .stderr_contains("text ordering performed using simple byte comparison");
}

#[test]
fn test_locale_utf8_sort_debug_message() {
    new_ucmd!()
        .env("LC_ALL", "en_US.UTF-8")
        .arg("--debug")
        .pipe_in("a\nA\nb\nB\n")
        .succeeds()
        .stderr_contains("text ordering performed using ‘en_US.UTF-8’ sorting rules");
}

#[test]
#[cfg(unix)]
fn test_failed_to_set_locale_debug_message() {
    let result = new_ucmd!()
        .env("LC_ALL", "not-valid-locale")
        .arg("--debug")
        .pipe_in("a\nA\nb\nB\n")
        .succeeds();

    result.stderr_contains("text ordering performed using simple byte comparison");

    #[cfg(all(target_os = "linux", target_env = "gnu"))]
    result.stderr_contains("failed to set locale");
}

#[test]
fn test_locale_utf8_with_key_field() {
    // Regression test for issue #10909
    // Sort should not panic when using -k flag with UTF-8 locale
    // The bug occurred when rayon worker threads tried to access an uninitialized collator
    let input = "a b 5433 down data path1 path2 path3 path4 path5
c d 5435 down data path1 path2 path3 path4 path5
e f 5436 down data path1 path2 path3 path4 path5\n";

    new_ucmd!()
        .env("LANG", "en_US.utf8")
        .arg("-k3")
        .pipe_in(input)
        .succeeds()
        .stdout_is(input);
}

#[test]
fn test_empty_input_empty_output() {
    // check for inconsistency #11958
    let input = "test test test";
    let (at, mut ucmd) = at_and_ucmd!();

    at.touch("file");
    at.append("file", input);

    ucmd.args(&["-o", "file"]).pipe_in("").succeeds();
    assert_eq!(at.read("file"), "");
}

/* spell-checker: enable */