annatto 0.51.0

Converts linguistic data formats based on the graphANNIS data model as intermediate representation and can apply consistency tests.
Documentation
use std::{
    env,
    path::{Path, PathBuf},
    sync::mpsc,
};

use graphannis::update::GraphUpdate;
use insta::assert_snapshot;
use itertools::Itertools;

use crate::{
    ImporterStep, StepID, progress::ProgressReporter, test_util::import_as_graphml_string_2,
    workflow::StatusMessage,
};

use super::ImportEXMARaLDA;

#[test]
fn serialize() {
    let module = ImportEXMARaLDA::default();
    let serialization = toml::to_string(&module);
    assert!(
        serialization.is_ok(),
        "Serialization failed: {:?}",
        serialization.err()
    );
    assert_snapshot!(serialization.unwrap());
}

#[test]
fn timeline_fail() {
    let import = crate::ReadFrom::EXMARaLDA(ImportEXMARaLDA::default());
    let import_path = "./tests/data/import/exmaralda/fail-corrupt_timeline/import/";
    let import_step = ImporterStep {
        module: import,
        path: PathBuf::from(import_path),
        description: None,
        generic_config: None,
    };

    let (sender, _receiver) = mpsc::channel();
    let r = import_step.execute(Some(sender));
    assert!(r.is_err());
    assert_snapshot!(r.err().unwrap().to_string());
    let document_path = "./tests/data/import/exmaralda/fail-corrupt_timeline/import/test_doc.exb";
    let mut u = GraphUpdate::default();
    let import = ImportEXMARaLDA::default();
    let step_id = StepID::from_importer_step(&import_step);
    assert!(
        import
            .import_document(
                &step_id,
                "import/test_doc",
                Path::new(document_path),
                &mut u,
                &ProgressReporter::new(None, step_id.clone(), 1).unwrap(),
                &None,
            )
            .is_err()
    );
}

#[test]
fn category_fail() {
    let import = crate::ReadFrom::EXMARaLDA(ImportEXMARaLDA::default());
    let import_path = "./tests/data/import/exmaralda/fail-no_category/";
    let import_step = ImporterStep {
        module: import,
        path: PathBuf::from(import_path),
        description: None,
        generic_config: None,
    };

    let step_id = StepID::from_importer_step(&import_step);

    let (sender, _receiver) = mpsc::channel();
    let r = import_step.execute(Some(sender));
    assert!(r.is_err());
    assert_snapshot!(r.err().unwrap().to_string());
    let document_path = Path::new(import_path).join("test_doc.exb");
    let mut u = GraphUpdate::default();
    assert!(
        ImportEXMARaLDA::default()
            .import_document(
                &step_id,
                "fail-no_category/test_doc",
                document_path.as_path(),
                &mut u,
                &ProgressReporter::new(None, step_id.clone(), 1).unwrap(),
                &None
            )
            .is_err()
    );
}

#[test]
fn no_speaker_attr_pass() {
    assert!(run_test("./tests/data/import/exmaralda/pass-no_speaker/", 1).is_ok());
}

#[test]
fn undefined_speaker_fail() {
    let import = crate::ReadFrom::EXMARaLDA(ImportEXMARaLDA::default());
    let import_path = "./tests/data/import/exmaralda/fail-undefined_speaker/";
    let import_step = ImporterStep {
        module: import,
        path: PathBuf::from(import_path),
        description: None,
        generic_config: None,
    };

    let step_id = StepID::from_importer_step(&import_step);

    let (sender, _receiver) = mpsc::channel();
    let r = import_step.execute(Some(sender));
    assert!(r.is_err());
    assert_snapshot!(r.err().unwrap().to_string());
    let document_path = Path::new(import_path).join("test_doc.exb");
    let mut u = GraphUpdate::default();
    assert!(
        ImportEXMARaLDA::default()
            .import_document(
                &step_id,
                "fail-undefined_speaker/test_doc",
                document_path.as_path(),
                &mut u,
                &ProgressReporter::new(None, step_id.clone(), 1).unwrap(),
                &None
            )
            .is_err()
    );
}

#[test]
fn unknown_tli_fail() {
    let import = crate::ReadFrom::EXMARaLDA(ImportEXMARaLDA::default());
    let import_path = "./tests/data/import/exmaralda/fail-unknown_tli/";
    let import_step = ImporterStep {
        module: import,
        path: PathBuf::from(import_path),
        description: None,
        generic_config: None,
    };

    let step_id = StepID::from_importer_step(&import_step);

    let (sender, _receiver) = mpsc::channel();
    let r = import_step.execute(Some(sender));
    assert!(r.is_err());
    assert_snapshot!(r.err().unwrap().to_string());
    let document_path = Path::new(import_path).join("test_doc.exb");
    let mut u = GraphUpdate::default();
    assert!(
        ImportEXMARaLDA::default()
            .import_document(
                &step_id,
                "fail-unknown_tli/test_doc",
                document_path.as_path(),
                &mut u,
                &ProgressReporter::new(None, step_id.clone(), 1).unwrap(),
                &None
            )
            .is_err()
    );
}

#[test]
fn bad_timevalue_fail() {
    let import = crate::ReadFrom::EXMARaLDA(ImportEXMARaLDA::default());
    let import_path = "./tests/data/import/exmaralda/fail-bad_timevalue/";
    let import_step = ImporterStep {
        module: import,
        path: PathBuf::from(import_path),
        description: None,
        generic_config: None,
    };

    let step_id = StepID::from_importer_step(&import_step);

    let (sender, _receiver) = mpsc::channel();
    let r = import_step.execute(Some(sender));
    assert!(r.is_err());
    assert_snapshot!(r.err().unwrap().to_string());
    let document_path = Path::new(import_path).join("test_doc.exb");
    let mut u = GraphUpdate::default();
    assert!(
        ImportEXMARaLDA::default()
            .import_document(
                &step_id,
                "fail-bad_timevalue/test_doc",
                document_path.as_path(),
                &mut u,
                &ProgressReporter::new(None, step_id.clone(), 1).unwrap(),
                &None
            )
            .is_err()
    );
}

#[test]
fn underspec_event_fail() {
    let import = crate::ReadFrom::EXMARaLDA(ImportEXMARaLDA::default());
    let import_path = "./tests/data/import/exmaralda/fail-no_start_no_end/";
    let import_step = ImporterStep {
        module: import,
        path: PathBuf::from(import_path),
        description: None,
        generic_config: None,
    };

    let (sender, _receiver) = mpsc::channel();
    let r = import_step.execute(Some(sender));
    assert!(r.is_err());
    assert_snapshot!(r.err().unwrap().to_string());
}

#[test]
fn invalid_fail() {
    let import = crate::ReadFrom::EXMARaLDA(ImportEXMARaLDA::default());
    let import_path = "./tests/data/import/exmaralda/fail-invalid/import/";
    let import_step = ImporterStep {
        module: import,
        path: PathBuf::from(import_path),
        description: None,
        generic_config: None,
    };

    let step_id = StepID::from_importer_step(&import_step);

    let (sender, _receiver) = mpsc::channel();
    let r = import_step.execute(Some(sender));
    assert!(r.is_err());
    assert_snapshot!(r.err().unwrap().to_string());
    let document_path = "./tests/data/import/exmaralda/fail-invalid/import/test_doc_invalid.exb";
    let mut u = GraphUpdate::default();
    assert!(
        ImportEXMARaLDA::default()
            .import_document(
                &step_id,
                "import/test_doc_invalid",
                Path::new(document_path),
                &mut u,
                &ProgressReporter::new(None, step_id.clone(), 1).unwrap(),
                &None
            )
            .is_err()
    );
}

#[test]
fn import() {
    let r = run_test("./tests/data/import/exmaralda/clean/import/", 0);
    assert!(r.is_ok(), "Probing core test result {:?}", r);
    assert_snapshot!(r.unwrap());
}

#[test]
fn broken_audio_pass() {
    let r = run_test("./tests/data/import/exmaralda/broken_audio/import/", 1);
    assert!(r.is_ok(), "Probing core test result {:?}", r);
    assert_snapshot!(r.unwrap());
}

#[test]
fn missing_type_attr_pass() {
    let r = run_test("./tests/data/import/exmaralda/pass-no_tier_type/import/", 9);
    assert!(r.is_ok(), "Probing core test result {:?}", r);
    assert_snapshot!(r.unwrap());
}

#[test]
fn sparse_timeline_pass() {
    let r = run_test(
        "./tests/data/import/exmaralda/valid-sparse-timevalues/import/",
        0,
    );
    assert!(r.is_ok(), "Probing core test result {:?}", r);
    assert_snapshot!(r.unwrap());
}

#[test]
fn merge_spans_disabled() {
    let actual = import_as_graphml_string_2(
        ImportEXMARaLDA {
            merge_events: false,
        },
        env::current_dir()
            .unwrap()
            .join("tests/data/import/exmaralda/mergable_spans"),
        None,
        true,
        None,
    )
    .unwrap();

    assert_snapshot!(actual);
}

fn run_test(
    import_path: &str,
    expected_warnings_count: usize,
) -> Result<String, Box<dyn std::error::Error>> {
    let (sender, receiver) = mpsc::channel();
    let actual = import_as_graphml_string_2(
        ImportEXMARaLDA::default(),
        env::current_dir()?.join(import_path), // IMPORTANT: test with absolute paths, this is what Annatto does at runtime
        None,
        true,
        Some(sender),
    )?;
    let warnings = receiver
        .into_iter()
        .filter(|m| matches!(m, StatusMessage::Warning(..)))
        .collect_vec();
    assert_eq!(
        expected_warnings_count,
        warnings.len(),
        "Unexpected amount of warnings: {:?}",
        warnings
    );
    Ok(actual)
}