mit-commit-message-lints 6.0.11

Check the correctness of a specific commit message. Designed to be used in tools providing commit-msg style hooks
Documentation
#![allow(clippy::wildcard_imports)]

use std::{
    collections::BTreeMap,
    convert::{TryFrom, TryInto},
};

use indoc::indoc;

use crate::{
    external::InMemory,
    mit::{lib::author::Author, Authors},
};

#[test]
fn is_is_iterable() {
    let mut store = BTreeMap::new();
    store.insert(
        "bt".into(),
        Author::new("Billie Thompson".into(), "billie@example.com".into(), None),
    );
    let actual = Authors::new(store);

    assert_eq!(
        actual.into_iter().collect::<Vec<_>>(),
        vec![(
            "bt".to_string(),
            Author::new("Billie Thompson".into(), "billie@example.com".into(), None)
        )]
    );
}

#[test]
fn it_can_get_an_author_in_it() {
    let mut store = BTreeMap::new();
    store.insert(
        "bt".into(),
        Author::new("Billie Thompson".into(), "billie@example.com".into(), None),
    );
    let actual = Authors::new(store);

    assert_eq!(
        actual.get(&["bt"]),
        vec![&Author::new(
            "Billie Thompson".into(),
            "billie@example.com".into(),
            None
        )]
    );
}

#[test]
fn i_can_get_multiple_authors_out_at_the_same_time() {
    let mut store: BTreeMap<String, Author<'_>> = BTreeMap::new();
    store.insert(
        "bt".into(),
        Author::new("Billie Thompson".into(), "billie@example.com".into(), None),
    );
    store.insert(
        "se".into(),
        Author::new("Somebody Else".into(), "somebody@example.com".into(), None),
    );
    let actual = Authors::new(store);

    assert_eq!(
        actual.get(&["bt"]),
        vec![&Author::new(
            "Billie Thompson".into(),
            "billie@example.com".into(),
            None
        )]
    );
    assert_eq!(
        actual.get(&["se"]),
        vec![&Author::new(
            "Somebody Else".into(),
            "somebody@example.com".into(),
            None
        )]
    );
}

#[test]
fn there_is_an_example_constructor() {
    let mut store = BTreeMap::new();
    store.insert(
        "bt".into(),
        Author::new(
            "Billie Thompson".into(),
            "billie@example.com".into(),
            Some("0A46826A".into()),
        ),
    );
    store.insert(
        "se".into(),
        Author::new("Someone Else".into(), "someone@example.com".into(), None),
    );
    store.insert(
        "ae".into(),
        Author::new("Anyone Else".into(), "anyone@example.com".into(), None),
    );
    let expected = Authors::new(store);

    assert_eq!(Authors::example(), expected,);
}

#[test]
fn merge_multiple_authors_together() {
    let mut map1: BTreeMap<String, Author<'_>> = BTreeMap::new();
    map1.insert(
        "bt".into(),
        Author::new("Billie Thompson".into(), "billie@example.com".into(), None),
    );
    map1.insert(
        "se".into(),
        Author::new("Someone Else".into(), "someone@example.com".into(), None),
    );
    let input1: Authors<'_> = Authors::new(map1);

    let mut map2: BTreeMap<String, Author<'_>> = BTreeMap::new();
    map2.insert(
        "bt".into(),
        Author::new("Billie Thompson".into(), "bt@example.com".into(), None),
    );
    map2.insert(
        "ae".into(),
        Author::new("Anyone Else".into(), "anyone@example.com".into(), None),
    );
    let input2: Authors<'_> = Authors::new(map2);

    let mut expected_map: BTreeMap<String, Author<'_>> = BTreeMap::new();

    expected_map.insert(
        "bt".into(),
        Author::new("Billie Thompson".into(), "bt@example.com".into(), None),
    );
    expected_map.insert(
        "se".into(),
        Author::new("Someone Else".into(), "someone@example.com".into(), None),
    );
    expected_map.insert(
        "ae".into(),
        Author::new("Anyone Else".into(), "anyone@example.com".into(), None),
    );

    let expected: Authors<'_> = Authors::new(expected_map);

    assert_eq!(expected, input1.merge(&input2));
}

#[test]
fn it_can_tell_me_if_initials_are_not_in() {
    let mut store = BTreeMap::new();
    store.insert(
        "bt".into(),
        Author::new("Billie Thompson".into(), "billie@example.com".into(), None),
    );
    let actual = Authors::new(store);

    assert_eq!(actual.missing_initials(vec!["bt", "an"]), vec!["an"]);
}

#[test]
fn must_be_valid_yaml() {
    let actual: Result<_, _> = Authors::try_from("Hello I am invalid yaml : : :");
    actual.unwrap_err();
}

#[test]
fn it_can_parse_a_standard_toml_file() {
    let actual = Authors::try_from(indoc!(
        "
            [bt]
            name = \"Billie Thompson\"
            email = \"billie@example.com\"
            "
    ))
    .expect("Failed to parse yaml");

    let mut input: BTreeMap<String, Author<'_>> = BTreeMap::new();
    input.insert(
        "bt".into(),
        Author::new("Billie Thompson".into(), "billie@example.com".into(), None),
    );
    let expected = Authors::new(input);

    assert_eq!(expected, actual);
}

#[test]
fn an_empty_file_is_a_default_authors() {
    let actual = Authors::try_from("").expect("Failed to parse yaml");

    let expected = Authors::default();

    assert_eq!(expected, actual);
}

#[test]
fn it_can_parse_a_standard_yaml_file() {
    let actual = Authors::try_from(indoc!(
        "
            ---
            bt:
                name: Billie Thompson
                email: billie@example.com
            "
    ))
    .expect("Failed to parse yaml");

    let mut input: BTreeMap<String, Author<'_>> = BTreeMap::new();
    input.insert(
        "bt".into(),
        Author::new("Billie Thompson".into(), "billie@example.com".into(), None),
    );
    let expected = Authors::new(input);

    assert_eq!(expected, actual);
}

#[test]
fn yaml_files_can_contain_signing_keys() {
    let actual = Authors::try_from(indoc!(
        "
            ---
            bt:
                name: Billie Thompson
                email: billie@example.com
                signingkey: 0A46826A
            "
    ))
    .expect("Failed to parse yaml");

    let mut expected_authors: BTreeMap<String, Author<'_>> = BTreeMap::new();
    expected_authors.insert(
        "bt".into(),
        Author::new(
            "Billie Thompson".into(),
            "billie@example.com".into(),
            Some("0A46826A".into()),
        ),
    );
    let expected = Authors::new(expected_authors);

    assert_eq!(expected, actual);
}

#[test]
fn it_converts_to_standard_toml() {
    let mut map: BTreeMap<String, Author<'_>> = BTreeMap::new();
    map.insert(
        "bt".into(),
        Author::new("Billie Thompson".into(), "billie@example.com".into(), None),
    );
    let actual: String = Authors::new(map).try_into().unwrap();
    let expected = indoc!(
        "
            [bt]
            name = \"Billie Thompson\"
            email = \"billie@example.com\"
            "
    )
    .to_string();

    assert_eq!(expected, actual);
}

#[test]
fn it_includes_the_signing_key_if_set() {
    let mut map: BTreeMap<String, Author<'_>> = BTreeMap::new();
    map.insert(
        "bt".into(),
        Author::new(
            "Billie Thompson".into(),
            "billie@example.com".into(),
            Some("0A46826A".into()),
        ),
    );
    let actual: String = Authors::new(map).try_into().unwrap();
    let expected = indoc!(
        "
            [bt]
            name = \"Billie Thompson\"
            email = \"billie@example.com\"
            signingkey = \"0A46826A\"
            "
    )
    .to_string();

    assert_eq!(expected, actual);
}

#[test]
fn it_can_give_me_an_author() {
    let mut strings: BTreeMap<String, String> = BTreeMap::new();
    strings.insert("mit.author.config.zy.email".into(), "zy@example.com".into());
    strings.insert("mit.author.config.zy.name".into(), "Z Y".into());
    let vcs = InMemory::new(&mut strings);

    let actual = Authors::try_from(&vcs).expect("Failed to read VCS config");
    let expected_author = Author::new("Z Y".into(), "zy@example.com".into(), None);
    let mut store = BTreeMap::new();
    store.insert("zy".into(), expected_author);
    let expected = Authors::new(store);
    assert_eq!(
        expected, actual,
        "Expected the mit config to be {expected:?}, instead got {actual:?}"
    );
}

#[test]
fn it_can_give_me_multiple_authors() {
    let mut strings: BTreeMap<String, String> = BTreeMap::new();
    strings.insert("mit.author.config.zy.email".into(), "zy@example.com".into());
    strings.insert("mit.author.config.zy.name".into(), "Z Y".into());
    strings.insert(
        "mit.author.config.bt.email".into(),
        "billie@example.com".into(),
    );
    strings.insert("mit.author.config.bt.name".into(), "Billie Thompson".into());
    strings.insert("mit.author.config.bt.signingkey".into(), "ABC".into());
    let vcs = InMemory::new(&mut strings);

    let actual = Authors::try_from(&vcs).expect("Failed to read VCS config");
    let mut store = BTreeMap::new();
    store.insert(
        "zy".into(),
        Author::new("Z Y".into(), "zy@example.com".into(), None),
    );
    store.insert(
        "bt".into(),
        Author::new(
            "Billie Thompson".into(),
            "billie@example.com".into(),
            Some("ABC".into()),
        ),
    );
    let expected = Authors::new(store);
    assert_eq!(
        expected, actual,
        "Expected the mit config to be {expected:?}, instead got {actual:?}"
    );
}

#[test]
fn broken_authors_are_skipped() {
    let mut strings: BTreeMap<String, String> = BTreeMap::new();
    strings.insert("mit.author.config.zy.name".into(), "Z Y".into());
    strings.insert(
        "mit.author.config.bt.email".into(),
        "billie@example.com".into(),
    );
    strings.insert("mit.author.config.bt.name".into(), "Billie Thompson".into());
    strings.insert("mit.author.config.bt.signingkey".into(), "ABC".into());
    let vcs = InMemory::new(&mut strings);

    let actual = Authors::try_from(&vcs).expect("Failed to read VCS config");
    let mut store = BTreeMap::new();
    store.insert(
        "bt".into(),
        Author::new(
            "Billie Thompson".into(),
            "billie@example.com".into(),
            Some("ABC".into()),
        ),
    );
    let expected = Authors::new(store);
    assert_eq!(
        expected, actual,
        "Expected the mit config to be {expected:?}, instead got {actual:?}"
    );
}