supercov-engine 4.10.0

//! A Python or Ruby test's kind from where it lives, read as the JavaScript
//! runtime reads one (`runtime/javascript/provenance.mjs`): the nearest
//! directory that names a kind, then the file's own name, then `unit`. A
//! Rails app's Capybara tests live in `test/system` or `spec/features`, and
//! its request specs in `spec/requests`; every one of them was reported as a
//! unit test.

const KINDS: &[(&str, &[&str])] = &[
    ("unit", &["unit"]),
    ("component", &["component", "components", "ct"]),
    ("integration", &["integration", "int", "requests"]),
    ("e2e", &["e2e", "end-to-end", "offline", "online"]),
];

/// Directories that say what a suite is only as a whole name.
const DIRECTORIES: &[(&str, &str)] = &[("system", "e2e"), ("features", "e2e")];

/// The kind one path segment names: the word furthest into it wins, as in
/// `checkout-integration-e2e`.
fn segment_kind(segment: &str) -> Option<&'static str> {
    // Words split on `_`, `.`, `-` and camel case, keeping `end-to-end`.
    let mut spaced = String::new();
    let mut previous: Option<char> = None;
    for character in segment.chars() {
        if character.is_ascii_uppercase()
            && previous.is_some_and(|before| before.is_ascii_lowercase() || before.is_ascii_digit())
        {
            spaced.push(' ');
        }
        spaced.push(if matches!(character, '_' | '.') {
            ' '
        } else {
            character.to_ascii_lowercase()
        });
        previous = Some(character);
    }
    let spaced = spaced.replace("end-to-end", "end~to~end").replace('-', " ");
    let mut best = None;
    for (position, word) in spaced.split(' ').enumerate() {
        let word = word.replace('~', "-");
        if let Some((kind, _)) = KINDS
            .iter()
            .find(|(_, words)| words.contains(&word.as_str()))
        {
            best = Some((position, *kind));
        }
    }
    best.map(|(_, kind)| kind)
}

pub fn from_path(file: Option<&str>) -> &'static str {
    let Some(file) = file else {
        return "unit";
    };
    let segments = file.split(['/', '\\']).collect::<Vec<_>>();
    let (name, directories) = segments.split_last().unwrap_or((&"", &[]));
    directories
        .iter()
        .rev()
        .find_map(|directory| {
            DIRECTORIES
                .iter()
                .find(|(name, _)| directory.eq_ignore_ascii_case(name))
                .map(|(_, kind)| *kind)
                .or_else(|| segment_kind(directory))
        })
        .or_else(|| segment_kind(name))
        .unwrap_or("unit")
}

#[cfg(test)]
mod tests {
    use super::from_path;

    #[test]
    fn a_test_is_the_kind_its_directory_names() {
        assert_eq!(from_path(Some("test/system/composer_test.rb")), "e2e");
        assert_eq!(from_path(Some("spec/features/sign_in_spec.rb")), "e2e");
        assert_eq!(
            from_path(Some("spec/requests/rooms_spec.rb")),
            "integration"
        );
        assert_eq!(
            from_path(Some("tests/integration/test_api.py")),
            "integration"
        );
        assert_eq!(from_path(Some("tests/e2e/test_flow.py")), "e2e");
        assert_eq!(from_path(Some("test/models/user_test.rb")), "unit");
        // The nearest directory wins, then the file's name.
        assert_eq!(from_path(Some("tests/e2e/unit/test_x.py")), "unit");
        assert_eq!(from_path(Some("tests/test_checkout_e2e.py")), "e2e");
        assert_eq!(from_path(Some("tests/end-to-end/test_x.py")), "e2e");
        assert_eq!(
            from_path(Some("spec/apiIntegration_spec.rb")),
            "integration"
        );
        // A word inside another word is not a kind.
        assert_eq!(from_path(Some("tests/interior/test_x.py")), "unit");
        assert_eq!(from_path(None), "unit");
    }
}