Newer
Older
NewLang / tests / parse / test_note.py
# SPDX-License-Identifier: LGPL-2.1-only
# Copyright 2022 Jookia <contact@jookia.org>

from hypothesis import assume
from hypothesis.strategies import (
    composite,
    lists,
)

from src.parse import (
    NoteSkipper,
    ParseContext,
    ParseError,
    ParseErrorException,
    ParseTask,
)
from tests.parse.templates import (
    insert_random_within,
    template_parse_invalid,
    template_parse_valid,
)
from tests.test_token import (
    static_token_by_value,
    draw_token_random,
)


# Draws a random token suitable for note building
@composite
def draw_note_value_token(draw):
    token = draw(draw_token_random())
    assume(token.value not in ["StartNote", "EndNote"])
    return token


# Draws a random token that isn't a StartNote token
@composite
def draw_token_not_startnote(draw):
    token = draw(draw_token_random())
    assume(token.value != "StartNote")
    return token


# Draws tokens to make a valid note
@composite
def draw_token_note_valid(draw):
    tokens = draw(lists(draw_note_value_token()))
    start = static_token_by_value("StartNote")
    end = static_token_by_value("EndNote")
    all_tokens = [start] + tokens + [end]
    return (all_tokens, None)


# Tests skip_note works correctly
# We expect the following behaviour:
# - No value is returned
# template_parse_valid provides general parsing properties
@template_parse_valid(NoteSkipper().skip_note, draw_token_note_valid())
def test_parse_note_valid():
    pass


# Tests parsing notes without StartNote
# We expect the following behaviour:
# - Error if StartNote's token value is not "StartNote"
# - Have ParseError.WRONG_TOKEN as the exception code
@template_parse_invalid(NoteSkipper().skip_note)
def test_parse_note_invalid_nostartnote(draw, parent_context):
    (tokens, _) = draw(draw_token_note_valid())
    token = draw(draw_token_not_startnote())
    new_tokens = [token] + tokens[1:0]
    context = ParseContext(ParseTask.PARSE_NOTE, new_tokens[0], parent_context)
    error = ParseErrorException(ParseError.WRONG_TOKEN, token, "StartNote", context)
    return (new_tokens, error)


# Tests parsing empty notes
# We expect the following behaviour:
# - Error if there is no StartNote token at all
# - Have ParseError.NO_TOKEN as the exception code
@template_parse_invalid(NoteSkipper().skip_note)
def test_parse_note_invalid_empty(draw, parent_context):
    context = ParseContext(ParseTask.PARSE_NOTE, None, parent_context)
    error = ParseErrorException(ParseError.NO_TOKEN, None, None, context)
    return ([], error)


# Tests parsing a note with a StartNote token in it
# We expect the following behaviour:
# - Error if a StartNote token is in the note content
@template_parse_invalid(NoteSkipper().skip_note)
def test_parse_note_invalid_extrastartnote(draw, parent_context):
    (tokens, _) = draw(draw_token_note_valid())
    start = static_token_by_value("StartNote")
    new_tokens = insert_random_within(draw, tokens, start)
    context = ParseContext(ParseTask.PARSE_NOTE, new_tokens[0], parent_context)
    error = ParseErrorException(ParseError.FOUND_STARTNOTE, start, None, context)
    return (new_tokens, error)


# Tests parsing a note without an EndNote token
# We expect the following behaviour:
# - Error if there is no EndNote token at all
# - Have ParseError.NO_TOKEN as the exception code
@template_parse_invalid(NoteSkipper().skip_note)
def test_parse_note_invalid_noendnote(draw, parent_context):
    (tokens, _) = draw(draw_token_note_valid())
    context = ParseContext(ParseTask.PARSE_NOTE, tokens[0], parent_context)
    error = ParseErrorException(ParseError.NO_TOKEN, None, None, context)
    return (tokens[0:-1], error)