476 lines
21 KiB
Python
476 lines
21 KiB
Python
from itertools import zip_longest
|
|
|
|
import pyparsing
|
|
import pytest
|
|
|
|
import bootstraparse.modules.syntax as sy
|
|
|
|
ptp = pytest.param
|
|
|
|
|
|
##############################################################################################################
|
|
# Error Classes
|
|
##############################################################################################################
|
|
class ReturnArgumentSizeError(Exception):
|
|
def __init__(self, expected, actual):
|
|
self.expected = expected
|
|
self.actual = actual
|
|
|
|
def __str__(self):
|
|
return f"Expected {self.expected} arguments, got {self.actual}"
|
|
|
|
|
|
##############################################################################################################
|
|
# PRE-PARSER
|
|
##############################################################################################################
|
|
# Dictionary of all label and associated token used in the Pre_parser
|
|
list_of_token_types = {
|
|
"alias": sy.AliasToken,
|
|
"image": sy.ImageToken,
|
|
}
|
|
|
|
# Dictionary of all lexical elements and a list of matching strings for the Pre_parser
|
|
expressions_to_match = {
|
|
# Base elements
|
|
"quotes": ["'hi, there'", "'hi, there'"],
|
|
"value": ["0.1", "'hello'"],
|
|
"assignation": ["a=1", "a=1.33", "tr2='hu'"],
|
|
|
|
# Composite elements
|
|
"var": ['["a"]',
|
|
'[a=12]',
|
|
'[a=12, b=13]',
|
|
'[12,"a",1.1,a=12, b=13, c=14]',
|
|
],
|
|
|
|
# Specific elements
|
|
"image_element": ["@{image}", "@{image123_456}"],
|
|
"alias_element": ["@[alias]", "@[alias123_456]"],
|
|
"expression": ["a+b+c"],
|
|
"html_insert": ['{test=12, 22=3, "=5}', "{testing=12, 22=3, 4=5, 6='7'}"],
|
|
|
|
# Optional elements
|
|
"optional": ["a=1", "a=1.33", "tr2='hu'"],
|
|
|
|
# Pre_parser elements
|
|
"image": ["@{image}{test=22}[a=12,22,c,d,ERE,r,3]", "@{image123_456}{a=12,22,c,d,ERE,r,3}",
|
|
"@{image123_456}[a=12,22,c,d,ERE,r,3]"],
|
|
"alias": ["@[alias]{test=22}[a=12,22,c,d,ERE,r,3]", "@[alias123_456]{a=12,22,c,d,ERE,r,3}",
|
|
"@[alias123_456]{a=12,22,c,d,ERE,r,3]"],
|
|
|
|
# Syntax elements
|
|
"line_to_replace": ["@{image}",
|
|
"@{image}{é=12}",
|
|
"@{image}{test=22}",
|
|
"@{image}{test=22}[a=12,22,c,d,ERE,r,3]",
|
|
"@[alias]{test=22}[a=12,22,c,d,ERE,r,3]",
|
|
],
|
|
|
|
}
|
|
|
|
##############################################################################################################
|
|
# PARSER
|
|
##############################################################################################################
|
|
|
|
# Testing the parser lexical elements
|
|
# test_advanced_expression_and_token_creation
|
|
dict_advanced_syntax_input_and_expected_output = {
|
|
# Enhanced text
|
|
"et_em": [
|
|
# Single em element, should only match the first "*"
|
|
("*", (sy.EtEmToken(["*"]),)),
|
|
],
|
|
"et_strong": [
|
|
# Single strong element, should only match the first "**"
|
|
("**", (sy.EtStrongToken(["**"]),)),
|
|
],
|
|
"et_underline": [
|
|
# Single underline element, should only match the first "__"
|
|
("__", (sy.EtUnderlineToken(["__"]),)),
|
|
],
|
|
"et_strikethrough": [
|
|
# Single strikethrough element, should only match the first "~~"
|
|
("~~", (sy.EtStrikethroughToken(["~~"]),)),
|
|
],
|
|
"et_custom_span": [
|
|
# Single custom span element, should only match the first "(#number)"
|
|
("(#12345)", (sy.EtCustomSpanToken(["12345"]),)),
|
|
],
|
|
"il_link": [
|
|
# Single link element, should only match the first "[link_name]('link')"
|
|
("[text_link]('text://www.website.com/link.html')",
|
|
[sy.HyperlinkToken(["[text_link]('text://www.website.com/link.html')"])])
|
|
],
|
|
|
|
# il_link | et_strong | et_em | et_strikethrough | et_underline | et_custom_span
|
|
# Enhanced Text
|
|
"enhanced_text": [
|
|
# Matches a line of text, with or without inline elements
|
|
("*test*", (sy.EtEmToken(["*"]), sy.TextToken(["test"]), sy.EtEmToken(["*"]))),
|
|
("**test**", (sy.EtStrongToken(["**"]), sy.TextToken(["test"]), sy.EtStrongToken(["**"]))),
|
|
("__test__", (sy.EtUnderlineToken(["__"]), sy.TextToken(["test"]), sy.EtUnderlineToken(["__"]))),
|
|
("~~test~~", (sy.EtStrikethroughToken(["~~"]), sy.TextToken(["test"]), sy.EtStrikethroughToken(["~~"]))),
|
|
("(#12345)", (sy.EtCustomSpanToken(["12345"]),)),
|
|
("*test*test*", (sy.EtEmToken(["*"]), sy.TextToken(["test"]), sy.EtEmToken(["*"]), sy.TextToken(["test"]),
|
|
sy.EtEmToken(["*"]))),
|
|
("**test**test**",
|
|
(sy.EtStrongToken(["**"]), sy.TextToken(["test"]), sy.EtStrongToken(["**"]), sy.TextToken(["test"]),
|
|
sy.EtStrongToken(["**"]),)),
|
|
("__test__test__", (sy.EtUnderlineToken(["__"]), sy.TextToken(["test"]), sy.EtUnderlineToken(["__"]),
|
|
sy.TextToken(["test"]), sy.EtUnderlineToken(["__"]),)),
|
|
("~~test~~test~~", (sy.EtStrikethroughToken(["~~"]), sy.TextToken(["test"]), sy.EtStrikethroughToken(["~~"]),
|
|
sy.TextToken(["test"]), sy.EtStrikethroughToken(["~~"]),)),
|
|
("(#12345)test(#12345)", (sy.EtCustomSpanToken(["12345"]), sy.TextToken(["test"]),
|
|
sy.EtCustomSpanToken(["12345"]),)),
|
|
("__test(#12)test**test__test~~", (sy.EtUnderlineToken(["__"]), sy.TextToken(["test"]),
|
|
sy.EtCustomSpanToken(["12"]), sy.TextToken(["test"]),
|
|
sy.EtStrongToken(["**"]),
|
|
sy.TextToken(["test"]), sy.EtUnderlineToken(["__"]),
|
|
sy.TextToken(["test"]), sy.EtStrikethroughToken(["~~"]),)),
|
|
("Test text with a link [link_name]('link')",
|
|
(sy.TextToken(["Test text with a link"]), sy.HyperlinkToken(["[link_name]('link')"]),)),
|
|
# noqa E501 (line too long)
|
|
("Test text with a link [link_name](\"link\") and a *bold* text", (sy.TextToken(["Test text with a link"]),
|
|
sy.HyperlinkToken(['[link_name]("link")']),
|
|
sy.TextToken(["and a"]), sy.EtEmToken(["*"]),
|
|
sy.TextToken(["bold"]),
|
|
sy.EtEmToken(["*"]),)),
|
|
("Reverse order (#123) Span __ Underline ~~ Strikethrough",
|
|
(sy.EtCustomSpanToken(["123"]), sy.TextToken(["Reverse order"]),
|
|
sy.EtCustomSpanToken(["123"]), sy.TextToken(["Span"]),
|
|
sy.EtUnderlineToken(["__"]), sy.TextToken(["Underline"]),
|
|
sy.EtStrikethroughToken(["~~"]), sy.TextToken(["Strikethrough"]),)), # noqa E501 (line too long)
|
|
],
|
|
|
|
# Structural Elements
|
|
"se_start": [
|
|
# Matches a start of a structural element
|
|
("<<div", (sy.StructuralElementStartToken(["div"]),)),
|
|
],
|
|
"se_end": [
|
|
("div>>", (sy.StructuralElementEndToken(["div"]),)),
|
|
],
|
|
"se": [
|
|
# Matches a div element, must be at the beginning of the line, the closing div can be with arguments
|
|
("div>> [class='blue', 123#]{var='test', number=11}", [sy.StructuralElementEndToken(["div", [
|
|
sy.OptionalToken(["[", "class='blue'", ",", "123#", "]", "{", "var='test'", ",", "number=11", "}"])]])]),
|
|
# noqa E501 (line too long)
|
|
("div>> [class='blue', 123#]",
|
|
[sy.StructuralElementEndToken(["div", [sy.OptionalToken(["[", "class='blue'", ",", "123#", "]"])]])]),
|
|
# noqa E501 (line too long)
|
|
("div>> {var='test', number=11}",
|
|
[sy.StructuralElementEndToken(["div", [sy.OptionalToken(["{", "var='test'", ",", "number=11", "}"])]])]),
|
|
# noqa E501 (line too long)
|
|
],
|
|
|
|
# List Elements
|
|
"one_olist": [
|
|
# Matches a one-level ordered list element, must be at the beginning of the line
|
|
# Drop the "." from the match
|
|
("#. Text", (sy.EtOlistToken(["#", "Text"]),)),
|
|
],
|
|
"one_ulist": [
|
|
# Matches a one-level unordered list element, must be at the beginning of the line
|
|
# Drop the "-" from the match
|
|
("- Text", [sy.EtUlistToken(["-", "Text"])]),
|
|
],
|
|
|
|
# Headers
|
|
"one_header": [
|
|
# Matches a one-level header element, must be at the beginning of the line
|
|
("# Text1 #", (sy.HeaderToken(["#", "Text1 "]),)),
|
|
("## Text2 ##", (sy.HeaderToken(["##", "Text2 "]),)),
|
|
("### Text3 ###", (sy.HeaderToken(["###", "Text3 "]),)),
|
|
("#### Text4 ####", (sy.HeaderToken(["####", "Text4 "]),)),
|
|
("##### Text5 #####", (sy.HeaderToken(["#####", "Text5 "]),)),
|
|
("###### Text6 ######", (sy.HeaderToken(["######", "Text6 "]),)),
|
|
("## Text2 ## {var='test', number=11}", (sy.HeaderToken(["##", "Text2 "]),
|
|
sy.OptionalToken(["{", "var='test'", ",", "number=11", "}"]))),
|
|
("### Text3 ### [class='blue', 123#]{var='test', number=11}", (sy.HeaderToken(["###", "Text3 "]),
|
|
sy.OptionalToken(
|
|
["[", "class='blue'", ",", "123#", "]"]),
|
|
# noqa E501 (line too long)
|
|
sy.OptionalToken(
|
|
["{", "var='test'", ",", "number=11",
|
|
"}"]))), # noqa E501 (line too long)
|
|
],
|
|
# Tables
|
|
"table_row": [
|
|
# Matches a table element, must be at the beginning of the line
|
|
("| Text1 | Text2 |", (sy.TableRowToken(["|", "Text1", "|", "Text2", "|"]),)),
|
|
("| Text1 | Text2 | Text3 |", (sy.TableRowToken(["|", "Text1", "|", "Text2", "|", "Text3", "|"]),)),
|
|
("|2 Text1 | Text2 |", (sy.TableRowToken(["|2", "Text1", "|", "Text2", "|"]),)),
|
|
("|2 Text1 |3 Text2 |", (sy.TableRowToken(["|2", "Text1", "|3", "Text2", "|"]),)),
|
|
("|2 Text1 |3 Text2 |4 Text3 |", (sy.TableRowToken(["|2", "Text1", "|3", "Text2", "|4", "Text3", "|"]),)),
|
|
("|3 Text1 | Text2 | {var='test', number=11}", (sy.TableRowToken(["|3", "Text1", "|", "Text2", "|"]),
|
|
sy.UnimplementedToken(
|
|
["{", "var='test'", ",", "number=11", "}"]))),
|
|
# noqa E501 (line too long)
|
|
],
|
|
"table_separator": [
|
|
# Matches a table element, must be at the beginning of the line # TODO: Tokens ?
|
|
("|---|---|", (sy.TableSeparatorToken(["|", "---", "|", "---", "|"]),)),
|
|
("|---|---|---|", (sy.TableSeparatorToken(["|", "---", "|", "---", "|", "---", "|"]),)),
|
|
("|:--|-:-|--:|--:|", (sy.TableSeparatorToken(["|", ":--", "|", "-:-", "|", "--:", "|", "--:", "|"]),)),
|
|
],
|
|
"line": [
|
|
# Match any line parsed by the parser (can match header, list table etc...) this is the main syntax element
|
|
("# Text1 #", (sy.HeaderToken(["#", "Text1 "]),)),
|
|
("Text *bold __underline__ still bold*", (
|
|
sy.TextToken(["Text ", sy.EtStrongToken(["bold", " ", sy.EtUnderlineToken(["underline"]), " still bold"])]),)), # noqa E501 (line too long)
|
|
("|2 Text1 | Text2 |", (sy.TableRowToken(["|2", "Text1", "|", "Text2", "|"]),)),
|
|
("|---|---|", (sy.TableSeparatorToken(["|", "---", "|", "---", "|"]),)),
|
|
("- Text", (sy.EtUlistToken([sy.TextToken(["Text"])]),)),
|
|
("div>>", (sy.StructuralElementEndToken(["div", ">>"]),)),
|
|
],
|
|
}
|
|
|
|
# Cursed zipping oneline
|
|
zipped_dict_advanced_syntax_input_and_expected_output = [
|
|
ptp(item[0], item[1][0], item[1][1], id=f"{item[0]}@{item[1][0][:8]} @") for sublist in [
|
|
zip_longest([key], dict_advanced_syntax_input_and_expected_output[key], fillvalue=key) for key in
|
|
dict_advanced_syntax_input_and_expected_output.keys() # noqa E501 (line too cursed)
|
|
] for item in sublist
|
|
]
|
|
|
|
# test__add_tag
|
|
list_add_tag_input_and_expected_output = [
|
|
# Test cases for the add_tag function
|
|
# Input:
|
|
(sy.TextToken(["Text"]), "Text"),
|
|
(sy.EtEmToken(["*"]), "<text:em />"),
|
|
(sy.EtStrongToken(["**"]), "<text:strong />"),
|
|
(sy.EtUnderlineToken(["__"]), "<text:underline />"),
|
|
(sy.EtStrikethroughToken(["~~"]), "<text:strikethrough />"),
|
|
(sy.StructuralElementStartToken(["div"]), "<se:start = 'div' />"),
|
|
(sy.StructuralElementEndToken(["div"]), "<se:end = 'div' />"),
|
|
(sy.EtCustomSpanToken(["(#12)"]), "<text:custom_span = '(#12)' />"),
|
|
(sy.HeaderToken(["#", "Text"]), "<header = '#,Text' />"),
|
|
]
|
|
|
|
# test_readable_markup
|
|
list_of_text_input_and_readable_output = [
|
|
# Header
|
|
("# Text1 #", "one_header", "<header = '#,Text1 ' />"),
|
|
("## Text2 ##", "one_header", "<header = '##,Text2 ' />"),
|
|
|
|
# Text
|
|
# il_link | et_strong | et_em | et_strikethrough | et_underline | et_custom_span
|
|
("*Italic*", "et_em", "<text:em />"),
|
|
("__Underline__", "et_underline", "<text:underline />"),
|
|
("**Bold**", "et_strong", "<text:strong />"),
|
|
("~~Strikethrough~~", "et_strikethrough", "<text:strikethrough />"),
|
|
("Text *bold __underline__ still bold*", "enhanced_text",
|
|
"Text <text:em /> bold <text:underline /> underline <text:underline /> still bold <text:em /> "),
|
|
# noqa E501 (line too long)
|
|
("[link]('http://www.google.com')", "il_link", "<hyperlink = '[link]('http://www.google.com')' />"),
|
|
("Reverse order: (#123) Span, __underline__ ~~strikethrough~~ **emphasis * Strong**", "enhanced_text",
|
|
"Reverse order: (<text:custom_span = '(#123)' /> Span, <text:underline /> ~~strikethrough~~ <text:strong /> emphasis <text:em /> Strong<text:strong /> "), # noqa E501 (line too long)
|
|
|
|
# Structural elements
|
|
("<<div", "se", "<se:start = 'div' />"),
|
|
("div>>", "se", "<se:end = 'div' />"),
|
|
|
|
# Lists
|
|
("- Text", "one_ulist", "<list:ulist = '-,Text' />"),
|
|
("#. Text", "one_olist", "<list:olist = '#,Text' />"),
|
|
|
|
# Tables
|
|
("| Text1 | Text2 |", "table", "<table: | Text1 | Text2 |>"),
|
|
("| Text1 |3 Text2 |", "table", "<table: | Text1 |3 Text2 |>"),
|
|
("|---|---|", "table_separator", "<table_separator: |---|---|>"),
|
|
("|:--|-:-|--:|--:|", "table_separator", "<table_separator: |:--|-:-|--:|--:|>"),
|
|
|
|
# Other Mostly for testing and coverage
|
|
("'", "quotes", "'"),
|
|
]
|
|
|
|
|
|
@pytest.mark.parametrize("token_name,token_class", list_of_token_types.items())
|
|
def test_token_type_exists(token_name, token_class):
|
|
"""
|
|
Test that the token type exists.
|
|
:param token_name: The name of the token type.
|
|
:param token_class: The class of the token type.
|
|
:type token_name: str
|
|
:type token_class: sy.SemanticType
|
|
"""
|
|
assert token_class.label == token_name
|
|
|
|
|
|
def test_token_type_exists_fail():
|
|
"""
|
|
Test that the token type does not exist.
|
|
"""
|
|
with pytest.raises(AttributeError):
|
|
# noinspection PyUnresolvedReferences, PyStatementEffect
|
|
sy.UnexistingTypeToken.label == "non_existing_token" # pylint: disable=pointless-statement
|
|
|
|
|
|
@pytest.mark.parametrize("token_class", list_of_token_types.values())
|
|
def test_of_type_creator(token_class):
|
|
"""
|
|
Test that the of_type_creator function returns the correct type.
|
|
:param token_class: The class of the token type.
|
|
:type token_class: sy.SemanticType
|
|
"""
|
|
fcr = sy.of_type(token_class)
|
|
tnk = fcr(None, None, None)
|
|
# noinspection PyTypeChecker
|
|
assert isinstance(tnk, token_class) # pylint: disable=unidiomatic-typecheck
|
|
assert tnk.label == token_class.label
|
|
|
|
|
|
def strings_in_token(token, string_list):
|
|
token_str = str(token)
|
|
for string in string_list:
|
|
if string not in token_str:
|
|
return False
|
|
return True
|
|
|
|
|
|
def test_semantic_type():
|
|
"""
|
|
Test that the semantic type is correctly created.
|
|
"""
|
|
st = sy.SemanticType("test")
|
|
assert st.label is None
|
|
assert strings_in_token(st, ["test", "None"])
|
|
assert strings_in_token(repr(st), ["test", "None"])
|
|
st = sy.SemanticType([1, 2, 3])
|
|
assert st.label is None
|
|
st.label = "test"
|
|
assert strings_in_token(st, ["[1, 2, 3]", "test"])
|
|
|
|
|
|
def test_semantic_type_eq():
|
|
"""
|
|
Test that the semantic type is correctly created.
|
|
"""
|
|
st1 = sy.SemanticType("test")
|
|
st2 = sy.SemanticType("test")
|
|
assert st1 == st2
|
|
st1 = sy.SemanticType(["test"])
|
|
st2 = sy.SemanticType(["test2"])
|
|
assert st1 != st2
|
|
st1 = sy.SemanticType("test")
|
|
st2 = sy.SemanticType([1, 2, 3])
|
|
assert st1 != st2
|
|
st1 = sy.SemanticType([1, 2, 3])
|
|
st2 = sy.SemanticType([1, 2, 3])
|
|
assert st1 == st2
|
|
st1 = sy.SemanticType([1, 2, 3])
|
|
st2 = sy.SemanticType([1, 2, 3, 4])
|
|
assert st1 != st2
|
|
st1 = sy.SemanticType([1, 2, 3, 4])
|
|
st2 = sy.SemanticType([1, 2, 3])
|
|
assert st1 != st2
|
|
st1 = sy.SemanticType([1, 2, 3])
|
|
st2 = sy.SemanticType([1, 2, 3, 4])
|
|
assert st1 != st2
|
|
|
|
|
|
def find_expression_from_str(expression_str):
|
|
"""
|
|
Find the expression from its string representation.
|
|
Just trust on this one.
|
|
:param expression_str: The string representation of the expression.
|
|
:type expression_str: str
|
|
:return: The expression.
|
|
:rtype: pyparsing.ParserElement
|
|
"""
|
|
# noinspection PyUnresolvedReferences
|
|
return sy.__getattribute__(expression_str) # pylint: disable=no-member
|
|
|
|
|
|
@pytest.mark.parametrize("expression,to_parse", expressions_to_match.items())
|
|
def test_expression_matching(expression, to_parse):
|
|
"""
|
|
Test that the expression is correctly parsed.
|
|
:param expression: The expression to test.
|
|
:param to_parse: A list of string that should be matched by the expression.
|
|
:type expression: str
|
|
:type to_parse: list
|
|
"""
|
|
expr = find_expression_from_str(expression)
|
|
assert isinstance(expr, pyparsing.ParserElement)
|
|
for string in to_parse:
|
|
assert expr.parse_string(string) is not None
|
|
|
|
|
|
@pytest.mark.parametrize("markup_element, to_parse, expected", zipped_dict_advanced_syntax_input_and_expected_output)
|
|
def test_advanced_expression_and_token_creation(markup_element, to_parse, expected):
|
|
"""
|
|
Test that the advanced syntax is correctly parsed and returns the correct tokens.
|
|
:param markup_element: The expression to test.
|
|
:param to_parse: The string to test.
|
|
:param expected: The expected tokens.
|
|
:type markup_element: str
|
|
:type to_parse: str
|
|
:type expected: list
|
|
"""
|
|
expr = find_expression_from_str(markup_element)
|
|
|
|
assert isinstance(expr, pyparsing.ParserElement)
|
|
result = expr.parse_string(to_parse)
|
|
print(f"Found: {result} (len:{len(result)}). Expected {expected} (len:{len(expected)})")
|
|
assert result is not None
|
|
if len(result) != len(expected):
|
|
raise ReturnArgumentSizeError(len(expected), len(result))
|
|
for token, expected_token in zip_longest(result, expected):
|
|
assert token == expected_token
|
|
|
|
|
|
########################################################################################################################
|
|
# TEXT OUTPUT
|
|
########################################################################################################################
|
|
# Test the add tag function
|
|
|
|
|
|
@pytest.mark.parametrize("token, expected_output", list_add_tag_input_and_expected_output)
|
|
def test__add_tag(token, expected_output):
|
|
"""
|
|
Test that the add_tag function works correctly.
|
|
:param token: The token to test.
|
|
:param expected_output: The expected output.
|
|
:type token: sy.SemanticType
|
|
:type expected_output: str
|
|
"""
|
|
assert token.to_markup() == expected_output
|
|
|
|
|
|
# Test text functions
|
|
@pytest.mark.parametrize("token_list, parsing_expression, expected", list_of_text_input_and_readable_output)
|
|
def test_readable_markup(token_list, parsing_expression, expected):
|
|
"""
|
|
Test that the readable markup is correctly generated.
|
|
:param token_list: The list of tokens.
|
|
:param parsing_expression: The parsing expression.
|
|
:param expected: The expected readable markup.
|
|
:type token_list: str
|
|
:type parsing_expression: str
|
|
:type expected: str
|
|
"""
|
|
expr = find_expression_from_str(parsing_expression)
|
|
assert isinstance(expr, pyparsing.ParserElement)
|
|
result = expr.parse_string(token_list)
|
|
assert result is not None
|
|
assert sy.readable_markup(result) == expected
|
|
|
|
|
|
def test_weird_markup():
|
|
"""
|
|
Test that the readable markup is correctly generated.
|
|
"""
|
|
assert sy.readable_markup([sy.EmptySemanticType("weird")]) == "weird"
|
|
empty_token = sy.SemanticType(None)
|
|
empty_token.label = "weird"
|
|
assert sy.readable_markup([empty_token]) == "<[NOC] weird />"
|
|
|
|
class WeirdClass:
|
|
def __str__(self):
|
|
return "weird"
|
|
|
|
assert sy.readable_markup(
|
|
[sy.EmptySemanticType("weird"), empty_token, WeirdClass()]) == "weird <[NOC] weird /> weird"
|