tame/tamer/src/xir/tree/test.rs

// Test XIR tree representation
//
//  Copyright (C) 2014-2021 Ryan Specialty Group, LLC.
//
//  This file is part of TAME.
//
//  This program is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program.  If not, see <http://www.gnu.org/licenses/>.

use super::*;
use crate::convert::ExpectInto;
use crate::sym::GlobalSymbolIntern;

lazy_static! {
    static ref S: Span =
        Span::from_byte_interval((0, 0), "test case, 1".intern());
    static ref S2: Span =
        Span::from_byte_interval((0, 0), "test case, 2".intern());
    static ref S3: Span =
        Span::from_byte_interval((0, 0), "test case, 3".intern());
}

mod tree {
    use crate::xir::Text;

    use super::*;

    #[test]
    fn element_from_tree() {
        let ele = Element {
            name: "foo".unwrap_into(),
            attrs: None,
            children: vec![],
            span: (*S, *S2),
        };

        let tree = Tree::Element(ele.clone());

        assert_eq!(Some(&ele), tree.as_element());
        assert_eq!(None, tree.as_text());
    }

    #[test]
    fn text_from_tree() {
        let text = Text::Escaped("foo".intern());
        let tree = Tree::Text(text, *S);

        assert!(!tree.is_element());
        assert_eq!(None, tree.as_element());
        assert_eq!(None, tree.clone().into_element());

        assert_eq!(Some(&text), tree.as_text());
        assert_eq!(Some(text), tree.into_text());
    }
}

mod attrs {
    use super::*;

    #[test]
    fn linear_search_for_attr_name_in_list() {
        let a = "a".unwrap_into();
        let b = "b".unwrap_into();

        let attra =
            Attr::new(a, AttrValue::from("a value".intern()), (*S, *S2));
        let attrb =
            Attr::new(b, AttrValue::from("b value".intern()), (*S, *S2));

        let attrs = AttrList::from([attra.clone(), attrb.clone()]);

        assert_eq!(attrs.find(a), Some(&attra));
        assert_eq!(attrs.find(b), Some(&attrb));

        assert_eq!(attrs.find("unknown".unwrap_into()), None);
    }
}

#[test]
fn empty_element_self_close_from_toks() {
    let name = ("ns", "elem").unwrap_into();

    let toks = [Token::Open(name, *S), Token::Close(None, *S2)].into_iter();

    let expected = Element {
        name,
        attrs: None,
        children: vec![],
        span: (*S, *S2),
    };

    let mut sut = toks.scan(ParserState::new(), parse);

    assert_eq!(sut.next(), Some(Ok(Parsed::Incomplete)));
    assert_eq!(sut.next(), Some(Ok(Parsed::Tree(Tree::Element(expected)))));
    assert_eq!(sut.next(), None);
}

// Same as above test, but with balanced closing instead of self
// closing.
#[test]
fn empty_element_balanced_close_from_toks() {
    let name = ("ns", "openclose").unwrap_into();

    let toks =
        [Token::Open(name, *S), Token::Close(Some(name), *S2)].into_iter();

    let expected = Element {
        name,
        attrs: None,
        children: vec![],
        span: (*S, *S2),
    };

    let mut sut = toks.scan(ParserState::new(), parse);

    assert_eq!(sut.next(), Some(Ok(Parsed::Incomplete)));
    assert_eq!(sut.next(), Some(Ok(Parsed::Tree(Tree::Element(expected)))));
    assert_eq!(sut.next(), None);
}

// Unbalanced should result in error.  This does not test what happens
// _after_ the error.
#[test]
fn empty_element_unbalanced_close_from_toks() {
    let open_name = "open".unwrap_into();
    let close_name = "unbalanced_name".unwrap_into();

    let toks = [
        Token::Open(open_name, *S),
        Token::Close(Some(close_name), *S2),
    ]
    .into_iter();

    let mut sut = toks.scan(ParserState::new(), parse);

    assert_eq!(sut.next(), Some(Ok(Parsed::Incomplete)));
    assert_eq!(
        sut.next(),
        Some(Err(ParseError::UnbalancedTag {
            open: (open_name, *S),
            close: (close_name, *S2),
        }))
    );

    // TODO: We need to figure out how to best implement recovery before
    // continuing with this design.
}

#[test]
fn empty_element_with_attrs_from_toks() {
    let name = ("ns", "elem").unwrap_into();
    let attr1 = "a".unwrap_into();
    let attr2 = "b".unwrap_into();
    let val1 = AttrValue::from("val1".intern());
    let val2a = AttrValue::from("val2a".intern());
    let val2b = AttrValue::from("val2b".intern());
    let val2c = AttrValue::from("val2b".intern());

    let toks = [
        Token::Open(name, *S),
        Token::AttrName(attr1, *S),
        Token::AttrValue(val1, *S2),
        Token::AttrName(attr2, *S),
        // More than one fragment to ensure we handle that state
        Token::AttrValueFragment(val2a, *S),
        Token::AttrValueFragment(val2b, *S2),
        Token::AttrValue(val2c, *S3),
        Token::Close(None, *S2),
    ]
    .into_iter();

    let expected = Element {
        name,
        attrs: Some(AttrList::from(vec![
            Attr::new(attr1, val1, (*S, *S2)),
            Attr::from_fragments(
                attr2,
                *S,
                vec![(val2a, *S), (val2b, *S2), (val2c, *S3)],
            ),
        ])),
        children: vec![],
        span: (*S, *S2),
    };

    let mut sut = toks.scan(ParserState::new(), parse);

    assert_eq!(sut.next(), Some(Ok(Parsed::Incomplete))); // Open
    assert_eq!(sut.next(), Some(Ok(Parsed::Incomplete))); // AttrName
    assert_eq!(sut.next(), Some(Ok(Parsed::Incomplete))); // AttrValue
    assert_eq!(sut.next(), Some(Ok(Parsed::Incomplete))); // AttrName
    assert_eq!(sut.next(), Some(Ok(Parsed::Incomplete))); // AttrValueFragment
    assert_eq!(sut.next(), Some(Ok(Parsed::Incomplete))); // AttrValueFragment
    assert_eq!(sut.next(), Some(Ok(Parsed::Incomplete))); // AttrValue
    assert_eq!(sut.next(), Some(Ok(Parsed::Tree(Tree::Element(expected)))));
    assert_eq!(sut.next(), None);
}

// We should accommodate missing AttrEnd in an element context so that we
//   can parse generated XIR without having to emit AttrEnd if we know it
//   will not be necessary.
// I may come to regret that accommodation after we have to go back and add
//   AttrEnd to systems that weren't providing it.
#[test]
fn child_element_after_attrs() {
    let name = ("ns", "elem").unwrap_into();
    let child = "child".unwrap_into();
    let attr = "a".unwrap_into();
    let val = AttrValue::from("val".intern());

    let toks = [
        Token::Open(name, *S),
        Token::AttrName(attr, *S),
        Token::AttrValue(val, *S2),
        // No AttrEnd
        Token::Open(child, *S),
        Token::Close(None, *S2),
        Token::Close(Some(name), *S3),
    ]
    .into_iter();

    let expected = Element {
        name,
        attrs: Some(AttrList::from(vec![Attr::new(attr, val, (*S, *S2))])),
        children: vec![Tree::Element(Element {
            name: child,
            attrs: None,
            children: vec![],
            span: (*S, *S2),
        })],
        span: (*S, *S3),
    };

    let mut sut = toks.scan(ParserState::new(), parse);

    assert_eq!(sut.next(), Some(Ok(Parsed::Incomplete))); // Open
    assert_eq!(sut.next(), Some(Ok(Parsed::Incomplete))); // AttrName
    assert_eq!(sut.next(), Some(Ok(Parsed::Incomplete))); // AttrValue
    assert_eq!(sut.next(), Some(Ok(Parsed::Incomplete))); // Open
    assert_eq!(sut.next(), Some(Ok(Parsed::Incomplete))); // Close
    assert_eq!(sut.next(), Some(Ok(Parsed::Tree(Tree::Element(expected)))));
    assert_eq!(sut.next(), None);
}

#[test]
fn element_with_empty_sibling_children() {
    let parent = "parent".unwrap_into();
    let childa = "childa".unwrap_into();
    let childb = "childb".unwrap_into();

    let toks = [
        Token::Open(parent, *S),
        Token::Open(childa, *S),
        Token::Close(None, *S2),
        Token::Open(childb, *S),
        Token::Close(None, *S2),
        Token::Close(Some(parent), *S2),
    ]
    .into_iter();

    let expected = Element {
        name: parent,
        attrs: None,
        children: vec![
            Tree::Element(Element {
                name: childa,
                attrs: None,
                children: vec![],
                span: (*S, *S2),
            }),
            Tree::Element(Element {
                name: childb,
                attrs: None,
                children: vec![],
                span: (*S, *S2),
            }),
        ],
        span: (*S, *S2),
    };

    let mut sut = parser_from(toks);

    assert_eq!(sut.next(), Some(Ok(Tree::Element(expected))));
    assert_eq!(sut.next(), None);
}

// Ensures that attributes do not cause the parent context to be lost.
#[test]
fn element_with_child_with_attributes() {
    let parent = "parent".unwrap_into();
    let child = "child".unwrap_into();
    let attr = "attr".unwrap_into();
    let value = AttrValue::from("attr value".intern());

    let toks = [
        Token::Open(parent, *S),
        Token::Open(child, *S),
        Token::AttrName(attr, *S),
        Token::AttrValue(value, *S2),
        Token::Close(None, *S3),
        Token::Close(Some(parent), *S3),
    ]
    .into_iter();

    let expected = Element {
        name: parent,
        attrs: None,
        children: vec![Tree::Element(Element {
            name: child,
            attrs: Some(AttrList::from([Attr::new(attr, value, (*S, *S2))])),
            children: vec![],
            span: (*S, *S3),
        })],
        span: (*S, *S3),
    };

    let mut sut = parser_from(toks);

    assert_eq!(sut.next(), Some(Ok(Tree::Element(expected))));
    assert_eq!(sut.next(), None);
}

#[test]
fn element_with_text() {
    let parent = "parent".unwrap_into();
    let text = Text::Escaped("inner text".into());

    let toks = [
        Token::Open(parent, *S),
        Token::Text(text, *S2),
        Token::Close(Some(parent), *S3),
    ]
    .into_iter();

    let expected = Element {
        name: parent,
        attrs: None,
        children: vec![Tree::Text(text, *S2)],
        span: (*S, *S3),
    };

    let mut sut = parser_from(toks);

    assert_eq!(sut.next(), Some(Ok(Tree::Element(expected))));
    assert_eq!(sut.next(), None);
}

#[test]
fn parser_from_filters_incomplete() {
    let name = ("ns", "elem").unwrap_into();
    let attr = "a".unwrap_into();
    let val = AttrValue::from("val1".intern());

    let toks = [
        Token::Open(name, *S),
        Token::AttrName(attr, *S),
        Token::AttrValue(val, *S2),
        Token::Close(None, *S2),
    ]
    .into_iter();

    let expected = Element {
        name,
        attrs: Some(AttrList::from([Attr::new(attr, val, (*S, *S2))])),
        children: vec![],
        span: (*S, *S2),
    };

    let mut sut = parser_from(toks);

    // Unlike the previous tests, we should filter out all the
    // `Parsed::Incomplete` and yield only when we have a fully parsed
    // object.
    assert_eq!(sut.next(), Some(Ok(Tree::Element(expected))));
    assert_eq!(sut.next(), None);
}

#[test]
fn parse_attrs_fails_if_first_token_is_non_attr() {
    let tok = Token::Open("foo".unwrap_into(), *S);
    let mut toks = [tok.clone()].into_iter();

    assert_eq!(
        Err(ParseError::AttrNameExpected(tok)),
        parse_attrs(&mut toks, AttrList::new()),
    );

    // The token should have been consumed, not copied.
    assert_eq!(0, toks.len());
}

// Since the purpose of this function is to parse the complete attribute
// list, it must fail if it does not encounter `AttrEnd`.
#[test]
fn parse_attrs_fails_if_end_before_attr_end() {
    let mut toks = [
        Token::AttrName("foo".unwrap_into(), *S),
        Token::AttrValue(AttrValue::from("bar".intern()), *S),
        // No Token::AttrEnd
    ]
    .into_iter();

    assert_eq!(
        Err(ParseError::UnexpectedAttrEof),
        parse_attrs(&mut toks, AttrList::new()),
    );
}

#[test]
fn parse_attrs_fails_if_missing_attr_end() {
    // Let's also ensure we fail if some other token is available in place
    // of Token::AttrEnd.
    let mut toks = [
        Token::AttrName("foo".unwrap_into(), *S),
        Token::AttrValue(AttrValue::from("bar".intern()), *S2),
        // No Token::AttrEnd
        Token::Close(None, *S3),
    ]
    .into_iter();

    assert_eq!(
        Err(ParseError::MissingIsolatedAttrEnd(*S3)),
        parse_attrs(&mut toks, AttrList::new()),
    );
}

#[test]
fn parse_attrs_isolated() {
    let attr1 = "one".unwrap_into();
    let attr2 = "two".unwrap_into();
    let val1 = AttrValue::from("val1".intern());
    let val2 = AttrValue::from("val2".intern());

    let mut toks = [
        Token::AttrName(attr1, *S),
        Token::AttrValue(val1, *S2),
        Token::AttrName(attr2, *S2),
        Token::AttrValue(val2, *S3),
        Token::AttrEnd,
    ]
    .into_iter();

    let expected = AttrList::from([
        Attr::new(attr1, val1, (*S, *S2)),
        Attr::new(attr2, val2, (*S2, *S3)),
    ]);

    assert_eq!(expected, parse_attrs(&mut toks, AttrList::new()).unwrap());
}

#[test]
fn attr_parser_with_non_attr_token() {
    let name = "unexpected".unwrap_into();
    let mut toks = [Token::Open(name, *S)].into_iter();

    let mut sut = attr_parser_from(&mut toks);

    assert_eq!(
        sut.next(),
        Some(Err(ParseError::AttrNameExpected(Token::Open(name, *S))))
    );
}

#[test]
fn parser_attr_multiple() {
    let attr1 = "one".unwrap_into();
    let attr2 = "two".unwrap_into();
    let val1 = AttrValue::from("val1".intern());
    let val2 = AttrValue::from("val2".intern());

    let mut toks = [
        Token::AttrName(attr1, *S),
        Token::AttrValue(val1, *S2),
        Token::AttrName(attr2, *S2),
        Token::AttrValue(val2, *S3),
        Token::AttrEnd,
    ]
    .into_iter();

    let mut sut = attr_parser_from(&mut toks);

    assert_eq!(sut.next(), Some(Ok(Attr::new(attr1, val1, (*S, *S2)))));
    assert_eq!(sut.next(), Some(Ok(Attr::new(attr2, val2, (*S2, *S3)))));
    assert_eq!(sut.next(), None);
}