tests/thin_check.rs - main - githubmirror/thin-provisioning-tools

tests/thin_check.rs
662 строки17 KB
Ming-Hung Tsai
[thin_check] Support overriding the details tree root
09 янв 2024, 13:50
09 янв 2024, 13:503b84b54
use anyhow::Result;

mod common;

use common::common_args::*;
use common::fixture::*;
use common::input_arg::*;
use common::process::*;
use common::program::*;
use common::target::*;
use common::test_dir::*;
use common::thin::*;

//------------------------------------------

const USAGE: &str = "Validates thin provisioning metadata on a device or file.

Usage: thin_check [OPTIONS] <INPUT>

Arguments:
  <INPUT>  Specify the input device to check

Options:
      --auto-repair                      Auto repair trivial issues.
      --clear-needs-check-flag           Clears the 'needs_check' flag in the superblock
  -h, --help                             Print help
      --ignore-non-fatal-errors          Only return a non-zero exit code if a fatal error is found.
  -m, --metadata-snap                    Check the metadata snapshot on a live pool
      --override-details-root <BLOCKNR>  Specify a details root to use
      --override-mapping-root <BLOCKNR>  Specify a mapping root to use
  -q, --quiet                            Suppress output messages, return only exit code.
      --skip-mappings                    Don't check the mapping tree
      --super-block-only                 Only check the superblock.
  -V, --version                          Print version";

//-----------------------------------------

struct ThinCheck;

impl<'a> Program<'a> for ThinCheck {
    fn name() -> &'a str {
        "thin_check"
    }

    fn cmd<I>(args: I) -> Command
    where
        I: IntoIterator,
        I::Item: Into<std::ffi::OsString>,
    {
        thin_check_cmd(args)
    }

    fn usage() -> &'a str {
        USAGE
    }

    fn arg_type() -> ArgType {
        ArgType::InputArg
    }

    fn bad_option_hint(option: &str) -> String {
        msg::bad_option_hint(option)
    }
}

impl<'a> InputProgram<'a> for ThinCheck {
    fn mk_valid_input(td: &mut TestDir) -> Result<std::path::PathBuf> {
        mk_valid_md(td)
    }

    fn file_not_found() -> &'a str {
        msg::FILE_NOT_FOUND
    }

    fn missing_input_arg() -> &'a str {
        msg::MISSING_INPUT_ARG
    }

    fn corrupted_input() -> &'a str {
        msg::BAD_SUPERBLOCK
    }
}

impl MetadataReader<'_> for ThinCheck {}

//------------------------------------------

test_accepts_help!(ThinCheck);
test_accepts_version!(ThinCheck);
test_rejects_bad_option!(ThinCheck);

test_missing_input_arg!(ThinCheck);
test_input_file_not_found!(ThinCheck);
test_input_cannot_be_a_directory!(ThinCheck);
test_unreadable_input_file!(ThinCheck);

test_help_message_for_tiny_input_file!(ThinCheck);
test_spot_xml_data!(ThinCheck);
test_corrupted_input_data!(ThinCheck);

test_readonly_input_file!(ThinCheck);

//------------------------------------------
// test exclusive flags

fn accepts_flag(flag: &str) -> Result<()> {
    let mut td = TestDir::new()?;
    let md = mk_valid_md(&mut td)?;
    run_ok(thin_check_cmd(args![flag, &md]))?;
    Ok(())
}

#[test]
fn accepts_superblock_only() -> Result<()> {
    accepts_flag("--super-block-only")
}

#[test]
fn accepts_skip_mappings() -> Result<()> {
    accepts_flag("--skip-mappings")
}

#[test]
fn accepts_ignore_non_fatal_errors() -> Result<()> {
    accepts_flag("--ignore-non-fatal-errors")
}

#[test]
fn accepts_clear_needs_check_flag() -> Result<()> {
    accepts_flag("--clear-needs-check-flag")
}

#[test]
fn accepts_auto_repair() -> Result<()> {
    accepts_flag("--auto-repair")
}

//------------------------------------------
// test the --quiet flag

#[test]
fn accepts_quiet() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = mk_valid_md(&mut td)?;

    let output = run_ok_raw(thin_check_cmd(args!["--quiet", &md]))?;
    if !output.stdout.is_empty() {
        eprintln!("stdout: {:?}", &std::str::from_utf8(&output.stdout));
    }

    if !output.stderr.is_empty() {
        eprintln!("stderr: {:?}", &std::str::from_utf8(&output.stderr));
    }
    assert_eq!(output.stdout.len(), 0);
    assert_eq!(output.stderr.len(), 0);
    Ok(())
}

//------------------------------------------
// test superblock-block-only

#[test]
fn detects_corrupt_superblock_with_superblock_only() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = mk_zeroed_md(&mut td)?;
    let _stderr = run_fail(thin_check_cmd(args!["--super-block-only", &md]))?;
    Ok(())
}

#[test]
fn checks_superblock_only() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = mk_valid_md(&mut td)?;

    // leave the superblock only
    {
        let f = std::fs::OpenOptions::new().write(true).open(&md)?;
        f.set_len(4096)?;
    }

    run_ok(thin_check_cmd(args!["--super-block-only", &md]))?;
    Ok(())
}

//------------------------------------------
// test info outputs

#[test]
fn prints_info_fields() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = mk_valid_md(&mut td)?;
    let stdout = run_ok(thin_check_cmd(args![&md]))?;
    eprintln!("info: {:?}", stdout);
    assert!(stdout.contains("TRANSACTION_ID="));
    assert!(stdout.contains("METADATA_FREE_BLOCKS="));
    Ok(())
}

#[test]
fn prints_info_with_superblock_only() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = mk_valid_md(&mut td)?;
    let stdout = run_ok(thin_check_cmd(args!["--super-block-only", &md]))?;
    eprintln!("info: {:?}", stdout);
    assert!(stdout.contains("TRANSACTION_ID="));
    assert!(stdout.contains("METADATA_FREE_BLOCKS="));
    Ok(())
}

//------------------------------------------
// test compatibility between options

#[test]
fn rejects_auto_repair_with_metadata_snap() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata_with_metadata_snap(&mut td)?;
    run_fail(thin_check_cmd(args!["--auto-repair", "-m", &md]))?;
    Ok(())
}

#[test]
fn rejects_auto_repair_with_override_mapping_root() -> Result<()> {
    use std::io::{Read, Seek};

    let mut td = TestDir::new()?;
    let md = mk_valid_md(&mut td)?;

    let mut f = std::fs::File::open(&md)?;
    let mut buf = [0; 8];
    f.seek(std::io::SeekFrom::Start(320))?;
    f.read_exact(&mut buf)?;
    let mapping_root = u64::from_le_bytes(buf).to_string();

    run_fail(thin_check_cmd(args![
        "--auto-repair",
        "--override-mapping-root",
        &mapping_root,
        &md
    ]))?;

    Ok(())
}

#[test]
fn rejects_auto_repair_with_override_details_root() -> Result<()> {
    use std::io::{Read, Seek};

    let mut td = TestDir::new()?;
    let md = mk_valid_md(&mut td)?;

    let mut f = std::fs::File::open(&md)?;
    let mut buf = [0; 8];
    f.seek(std::io::SeekFrom::Start(328))?;
    f.read_exact(&mut buf)?;
    let details_root = u64::from_le_bytes(buf).to_string();

    run_fail(thin_check_cmd(args![
        "--auto-repair",
        "--override-details-root",
        &details_root,
        &md
    ]))?;

    Ok(())
}

#[test]
fn rejects_auto_repair_with_superblock_only() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = mk_valid_md(&mut td)?;
    run_fail(thin_check_cmd(args![
        "--auto-repair",
        "--super-block-only",
        &md
    ]))?;
    Ok(())
}

#[test]
fn rejects_auto_repair_with_skip_mappings() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = mk_valid_md(&mut td)?;
    run_fail(thin_check_cmd(args![
        "--auto-repair",
        "--skip-mappings",
        &md
    ]))?;
    Ok(())
}

#[test]
fn rejects_auto_repair_with_ignore_non_fatal_errors() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = mk_valid_md(&mut td)?;

    run_fail(thin_check_cmd(args![
        "--auto-repair",
        "--ignore-non-fatal-errors",
        &md
    ]))?;
    Ok(())
}

#[test]
fn accepts_clear_needs_check_with_superblock_only() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = mk_valid_md(&mut td)?;
    run_ok(thin_check_cmd(args![
        "--clear-needs-check-flag",
        "--super-block-only",
        &md
    ]))?;
    Ok(())
}

#[test]
fn accepts_clear_needs_check_with_skip_mappings() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = mk_valid_md(&mut td)?;
    run_ok(thin_check_cmd(args![
        "--clear-needs-check-flag",
        "--skip-mappings",
        &md
    ]))?;
    Ok(())
}

#[test]
fn accepts_clear_needs_check_with_ignore_non_fatal_errors() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = mk_valid_md(&mut td)?;
    run_ok(thin_check_cmd(args![
        "--clear-needs-check-flag",
        "--ignore-non-fatal-errors",
        &md
    ]))?;
    Ok(())
}

#[test]
fn rejects_clear_needs_check_with_metadata_snap() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata_with_metadata_snap(&mut td)?;
    run_fail(thin_check_cmd(args!["--clear-needs-check-flag", "-m", &md]))?;
    Ok(())
}

#[test]
fn rejects_clear_needs_check_with_override_mapping_root() -> Result<()> {
    use std::io::{Read, Seek};

    let mut td = TestDir::new()?;
    let md = mk_valid_md(&mut td)?;

    let mut f = std::fs::File::open(&md)?;
    let mut buf = [0; 8];
    f.seek(std::io::SeekFrom::Start(320))?;
    f.read_exact(&mut buf)?;
    let mapping_root = u64::from_le_bytes(buf).to_string();

    run_fail(thin_check_cmd(args![
        "--clear-needs-check-flag",
        "--override-mapping-root",
        &mapping_root,
        &md
    ]))?;
    Ok(())
}

#[test]
fn rejects_clear_needs_check_with_override_details_root() -> Result<()> {
    use std::io::{Read, Seek};

    let mut td = TestDir::new()?;
    let md = mk_valid_md(&mut td)?;

    let mut f = std::fs::File::open(&md)?;
    let mut buf = [0; 8];
    f.seek(std::io::SeekFrom::Start(328))?;
    f.read_exact(&mut buf)?;
    let details_root = u64::from_le_bytes(buf).to_string();

    run_fail(thin_check_cmd(args![
        "--clear-needs-check-flag",
        "--override-details-root",
        &details_root,
        &md
    ]))?;
    Ok(())
}

//------------------------------------------
// test clear-needs-check

#[test]
fn clear_needs_check() -> Result<()> {
    test_option_clears_needs_check("--clear-needs-check-flag")
}

#[test]
fn clear_needs_check_opt_fixes_metadata_leaks() -> Result<()> {
    test_option_fixes_metadata_leaks("--clear-needs-check-flag")
}

#[test]
fn clear_needs_check_opt_fixes_metadata_leaks_and_clears_flag() -> Result<()> {
    test_option_fixes_metadata_leaks_and_clears_flag("--clear-needs-check-flag")
}

#[test]
fn clear_needs_check_opt_keeps_health_metadata_untouched() -> Result<()> {
    test_option_keeps_health_metadata_untouched("--clear-needs-check-flag")
}

#[test]
fn clear_needs_check_opt_cannot_fix_unexpected_ref_counts() -> Result<()> {
    test_option_cannot_fix_unexpected_ref_counts("--clear-needs-check-flag")
}

#[test]
fn clear_needs_check_if_superblock_only() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata(&mut td)?;

    set_needs_check(&md)?;
    generate_metadata_leaks(&md, 1, 0, 1)?; // non-fatal error

    assert!(get_needs_check(&md)?);
    run_ok(thin_check_cmd(args![
        "--clear-needs-check-flag",
        "--super-block-only",
        &md
    ]))?;
    assert!(!get_needs_check(&md)?);
    Ok(())
}

#[test]
fn clear_needs_check_if_skip_mappings() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata(&mut td)?;

    set_needs_check(&md)?;
    generate_metadata_leaks(&md, 1, 0, 1)?; // non-fatal error

    assert!(get_needs_check(&md)?);
    run_ok(thin_check_cmd(args![
        "--clear-needs-check-flag",
        "--skip-mappings",
        &md
    ]))?;
    assert!(!get_needs_check(&md)?);
    Ok(())
}

#[test]
fn clear_needs_check_if_ignore_non_fatal_errors() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata(&mut td)?;

    set_needs_check(&md)?;
    generate_metadata_leaks(&md, 1, 0, 1)?; // non-fatal error

    assert!(get_needs_check(&md)?);
    run_ok(thin_check_cmd(args![
        "--clear-needs-check-flag",
        "--ignore-non-fatal-errors",
        &md
    ]))?;
    assert!(!get_needs_check(&md)?);
    Ok(())
}

//------------------------------------------
// test ignore-non-fatal-errors

#[test]
fn metadata_leaks_are_non_fatal() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata(&mut td)?;
    generate_metadata_leaks(&md, 1, 0, 1)?;
    run_fail(thin_check_cmd(args![&md]))?;
    run_ok(thin_check_cmd(args!["--ignore-non-fatal-errors", &md]))?;
    Ok(())
}

#[test]
fn fatal_errors_cant_be_ignored() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata(&mut td)?;

    generate_metadata_leaks(&md, 1, 1, 0)?;
    ensure_untouched(&md, || {
        run_fail(thin_check_cmd(args!["--ignore-non-fatal-errors", &md]))?;
        Ok(())
    })
}

//------------------------------------------
// test auto-repair

fn test_option_fixes_metadata_leaks(option: &str) -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata(&mut td)?;

    generate_metadata_leaks(&md, 16, 0, 1)?; // non-fatal errors

    run_fail(thin_check_cmd(args![&md]))?;
    run_ok(thin_check_cmd(args![option, &md]))?;
    run_ok(thin_check_cmd(args![&md]))?; // ensure metadata is repaired

    Ok(())
}

fn test_option_fixes_metadata_leaks_and_clears_flag(option: &str) -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata(&mut td)?;

    set_needs_check(&md)?;
    generate_metadata_leaks(&md, 16, 0, 1)?; // non-fatal errors

    run_fail(thin_check_cmd(args![&md]))?;
    run_ok(thin_check_cmd(args![option, &md]))?;
    run_ok(thin_check_cmd(args![&md]))?; // ensure metadata is repaired
    assert!(!get_needs_check(&md)?);

    Ok(())
}

fn test_option_keeps_health_metadata_untouched(option: &str) -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata(&mut td)?;
    ensure_untouched(&md, || {
        run_ok(thin_check_cmd(args![option, &md]))?;
        Ok(())
    })?;
    Ok(())
}

fn test_option_cannot_fix_unexpected_ref_counts(option: &str) -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata(&mut td)?;

    generate_metadata_leaks(&md, 16, 1, 0)?;
    ensure_untouched(&md, || {
        run_fail(thin_check_cmd(args![option, &md]))?;
        Ok(())
    })?;
    Ok(())
}

fn test_option_clears_needs_check(option: &str) -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata(&mut td)?;

    set_needs_check(&md)?;
    assert!(get_needs_check(&md)?);
    run_ok(thin_check_cmd(args![option, &md]))?;
    assert!(!get_needs_check(&md)?);
    Ok(())
}

#[test]
fn auto_repair_fixes_metadata_leaks() -> Result<()> {
    test_option_fixes_metadata_leaks("--auto-repair")
}

#[test]
fn auto_repair_fixes_metadata_leaks_and_clears_flag() -> Result<()> {
    test_option_fixes_metadata_leaks_and_clears_flag("--auto-repair")
}

#[test]
fn auto_repair_keeps_health_metadata_untouched() -> Result<()> {
    test_option_keeps_health_metadata_untouched("--auto-repair")
}

#[test]
fn auto_repair_cannot_fix_unexpected_ref_counts() -> Result<()> {
    test_option_cannot_fix_unexpected_ref_counts("--auto-repair")
}

#[test]
fn auto_repair_clears_needs_check() -> Result<()> {
    test_option_clears_needs_check("--auto-repair")
}

//------------------------------------------
// test metadata snapshot

#[test]
fn online_check_metadata_snapshot() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata_with_metadata_snap(&mut td)?;
    run_ok(thin_check_cmd(args!["-m", &md]))?;
    Ok(())
}

#[test]
fn online_check_should_fail_if_no_metadata_snap() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata(&mut td)?;
    run_fail(thin_check_cmd(args!["-m", &md]))?;
    Ok(())
}

#[test]
fn online_check_should_fail_with_corrupted_metadata_snap() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata_from_file(&mut td, "tmeta_with_corrupted_metadata_snap.pack")?;
    let output = run_fail_raw(thin_check_cmd(args!["-m", &md]))?;
    assert!(output.stdout.is_empty());
    Ok(())
}

// Ensure that "thin_check -m" reads the metadata snapshot only.
// In other words, any issues within the active data structures won't be detected
// if the metadata snapshot doesn't share data blocks with the active metadata.
#[test]
fn online_check_should_read_metadata_snapshot_only() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata_from_file(&mut td, "corrupted_tmeta_with_metadata_snap.pack")?;
    run_ok(thin_check_cmd(args![&md, "-m"]))?;
    Ok(())
}

// Errors in metadata snapshot should be delayed reported if the metadata is inactive.
#[test]
fn offline_check_should_defer_checking_metadata_snap() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata_from_file(&mut td, "tmeta_with_corrupted_metadata_snap.pack")?;
    let output = run_fail_raw(thin_check_cmd(args![&md]))?;
    assert!(!output.stdout.is_empty());
    Ok(())
}

// Ensure that every subtree in metadata snapshot is checked properly.
#[test]
fn offline_check_should_examine_devices_with_reused_id() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata_from_file(&mut td, "tmeta_device_id_reuse_with_corrupted_thins.pack")?;
    run_fail(thin_check_cmd(args![&md]))?;
    Ok(())
}

#[test]
fn offline_check_metadata_with_reused_id_should_success() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata_from_file(&mut td, "tmeta_device_id_reuse.pack")?;
    run_ok(thin_check_cmd(args![&md]))?;
    Ok(())
}

#[test]
fn offline_check_metadata_with_deleted_snapshot_should_success() -> Result<()> {
    let mut td = TestDir::new()?;
    let md = prep_metadata_from_file(&mut td, "tmeta_with_deleted_snapshot.pack")?;
    run_ok(thin_check_cmd(args![&md]))?;
    Ok(())
}

//------------------------------------------