Skip to content

Commit

Permalink
Fix code format
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicoretti committed Jan 13, 2025
1 parent f3d23be commit 1c19573
Show file tree
Hide file tree
Showing 3 changed files with 150 additions and 92 deletions.
3 changes: 2 additions & 1 deletion exasol/error/version.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# ATTENTION:
# This file is generated by exasol/toolbox/pre_commit_hooks/package_version.py when using:
# * either "poetry run nox -s fix"
# * either "poetry run nox -s project:fix"
# * or "poetry run version-check <path/version.py> --fix"
# Do not edit this file manually!
# If you need to change the version, do so in the project.toml, e.g. by using `poetry version X.Y.Z`.
MAJOR = 0
MINOR = 5
PATCH = 0
VERSION = f"{MAJOR}.{MINOR}.{PATCH}"
__version__ = VERSION
237 changes: 147 additions & 90 deletions test/unit/legacy/test_error_message_builder.py
Original file line number Diff line number Diff line change
@@ -1,196 +1,253 @@
from exasol_error_reporting_python.error_message_builder import \
ErrorMessageBuilder
from exasol_error_reporting_python.error_message_builder import ErrorMessageBuilder


def test_message():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Test message"))
message = str(ErrorMessageBuilder("E-ERJ-TEST-1").message("Test message"))
assert message == "E-ERJ-TEST-1: Test message"


def test_message_with_parameter():
message = str(ErrorMessageBuilder('E-ERJ-TEST-1')
.message("Test message {{my_placeholder}} "
"and a number {{number}}.")
.parameter("my_placeholder", "my_value")
.parameter("number", 1, "a number"))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Test message {{my_placeholder}} " "and a number {{number}}.")
.parameter("my_placeholder", "my_value")
.parameter("number", 1, "a number")
)
assert message == "E-ERJ-TEST-1: Test message 'my_value' and a number 1."


def test_message_with_none_parameter():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("{{my_placeholder}}")
.parameter("my_placeholder", None))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1")
.message("{{my_placeholder}}")
.parameter("my_placeholder", None)
)
assert message == "E-ERJ-TEST-1: <null>"


def test_message_without_parameter_name():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("test {{}}")) # TODO: different imp.
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1").message("test {{}}")
) # TODO: different imp.
assert message == "E-ERJ-TEST-1: test <null>"


def test_message_without_parameter_value():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("test {{my_placeholder}}")) # TODO: different imp.
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1").message("test {{my_placeholder}}")
) # TODO: different imp.
assert message == "E-ERJ-TEST-1: test <null>"


def test_message_with_group_reference_char():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("test {{my_placeholder}}")
.parameter("my_placeholder", "$2"))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1")
.message("test {{my_placeholder}}")
.parameter("my_placeholder", "$2")
)
assert message == "E-ERJ-TEST-1: test '$2'"


def test_single_mitigation():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.mitigation("Fix it."))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.mitigation("Fix it.")
)
assert message == "E-ERJ-TEST-1: Something went wrong. Fix it."


def test_single_mitigation_with_parameter():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.mitigation("Delete line {{LINE_NR}}.")
.parameter("LINE_NR", 1))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.mitigation("Delete line {{LINE_NR}}.")
.parameter("LINE_NR", 1)
)
assert message == "E-ERJ-TEST-1: Something went wrong. Delete line 1."


def test_mitigations():
support_hotline = "1234/56789"
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.mitigation("Fix it.")
.mitigation("Contact support under {{SUPPORT_HOTLINE}}.")
.parameter("SUPPORT_HOTLINE", support_hotline))
assert message == "E-ERJ-TEST-1: Something went wrong. Known mitigations:" \
"\n* Fix it.\n* Contact support under '1234/56789'."
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.mitigation("Fix it.")
.mitigation("Contact support under {{SUPPORT_HOTLINE}}.")
.parameter("SUPPORT_HOTLINE", support_hotline)
)
assert (
message == "E-ERJ-TEST-1: Something went wrong. Known mitigations:"
"\n* Fix it.\n* Contact support under '1234/56789'."
)


def test_ticket_mitigation():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.ticket_mitigation())
assert message == "E-ERJ-TEST-1: Something went wrong. " \
"This is an internal error that should not happen. " \
"Please report it by opening a GitHub issue."
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.ticket_mitigation()
)
assert (
message == "E-ERJ-TEST-1: Something went wrong. "
"This is an internal error that should not happen. "
"Please report it by opening a GitHub issue."
)


def test_mitigation_inline_single_parameter():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.mitigation("Delete line {{LINE_NR}}.", 1))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.mitigation("Delete line {{LINE_NR}}.", 1)
)
assert message == "E-ERJ-TEST-1: Something went wrong. Delete line 1."


def test_mitigation_inline_multiple_parameter():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.mitigation("Delete lines {{LINE_NR1}}, {{LINE_NR2}}", 1, 2))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.mitigation("Delete lines {{LINE_NR1}}, {{LINE_NR2}}", 1, 2)
)
assert message == "E-ERJ-TEST-1: Something went wrong. Delete lines 1, 2"


def test_mitigation_inline_parameter_without_value():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.mitigation("Delete line {{LINE_NR}}.")) # TODO: different imp.
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.mitigation("Delete line {{LINE_NR}}.")
) # TODO: different imp.
assert message == "E-ERJ-TEST-1: Something went wrong. Delete line <null>."


def test_mitigation_inline_single_null_value():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.mitigation("Delete line {{LINE_NR}}.", None))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.mitigation("Delete line {{LINE_NR}}.", None)
)
assert message == "E-ERJ-TEST-1: Something went wrong. Delete line <null>."


def test_mitigation_inline_multiple_null_value():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.mitigation("Delete lines {{LINE1}}, {{LINE2}}.", None, None))
assert message == "E-ERJ-TEST-1: Something went wrong. " \
"Delete lines <null>, <null>."
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Something went wrong.")
.mitigation("Delete lines {{LINE1}}, {{LINE2}}.", None, None)
)
assert (
message == "E-ERJ-TEST-1: Something went wrong. " "Delete lines <null>, <null>."
)


def test_message_inline_single_unquoted_parameter():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Message with {{parameter_name|uq}}.", "value"))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1").message(
"Message with {{parameter_name|uq}}.", "value"
)
)
assert message == "E-ERJ-TEST-1: Message with value."


def test_message_inline_single_quoted_parameter():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Message with {{parameter_name}}.", "value"))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1").message(
"Message with {{parameter_name}}.", "value"
)
)
assert message == "E-ERJ-TEST-1: Message with 'value'."


def test_message_inline_multiple_unquoted_parameter():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Message with {{parameter_name1|uq}} and "
"{{parameter_name2|uq}}.", "value1", "value2"))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1").message(
"Message with {{parameter_name1|uq}} and " "{{parameter_name2|uq}}.",
"value1",
"value2",
)
)
assert message == "E-ERJ-TEST-1: Message with value1 and value2."


def test_message_inline_multiple_quoted_parameter():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Message with {{parameter_name1}} and "
"{{parameter_name2}}.", "value1", "value2"))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1").message(
"Message with {{parameter_name1}} and " "{{parameter_name2}}.",
"value1",
"value2",
)
)
assert message == "E-ERJ-TEST-1: Message with 'value1' and 'value2'."


def test_message_inline_unquoted_parameter_without_name():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Message with {{|uq}}.", "value"))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1").message("Message with {{|uq}}.", "value")
)
assert message == "E-ERJ-TEST-1: Message with value."


def test_message_inline_unquoted_parameter_without_value():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Message with {{parameter_name|uq}}."))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1").message(
"Message with {{parameter_name|uq}}."
)
)
assert message == "E-ERJ-TEST-1: Message with <null>."


def test_message_inline_single_unquoted_parameter_none_value():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Message with {{parameter_name|uq}}.", None))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1").message(
"Message with {{parameter_name|uq}}.", None
)
)
assert message == "E-ERJ-TEST-1: Message with <null>."


def test_message_inline_multiple_unquoted_parameter_none_value():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Message with {{parameter_name|uq}} and "
"{{parameter_name2}}.", None, None))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1").message(
"Message with {{parameter_name|uq}} and " "{{parameter_name2}}.", None, None
)
)
assert message == "E-ERJ-TEST-1: Message with <null> and <null>."


def test_message_inline_multiple_unquoted_parameter_none_parameters():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Message with {{parameter_name|uq}} and "
"{{parameter_name2}}.")
.parameter("parameter_name", None)
.parameter("parameter_name2", None))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Message with {{parameter_name|uq}} and " "{{parameter_name2}}.")
.parameter("parameter_name", None)
.parameter("parameter_name2", None)
)
assert message == "E-ERJ-TEST-1: Message with <null> and <null>."


def test_message_inline_unquoted_parameter_with_group_reference_char():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("test {{my_placeholder|uq}}")
.parameter("my_placeholder", "$2"))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1")
.message("test {{my_placeholder|uq}}")
.parameter("my_placeholder", "$2")
)
assert message == "E-ERJ-TEST-1: test $2"


def test_message_inline_and_outline_order():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Message with {{parameter_name1}}", "value1")
.message(" {{parameter_name2}}.", "value2"))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Message with {{parameter_name1}}", "value1")
.message(" {{parameter_name2}}.", "value2")
)
assert message == "E-ERJ-TEST-1: Message with 'value1' 'value2'."


def test_message_inline_and_outline_unquoted_parameters():
message = str(ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Message with {{parameter_name1|uq}}", "value1")
.message(" {{parameter_name2|uq}}.", "value2"))
message = str(
ErrorMessageBuilder("E-ERJ-TEST-1")
.message("Message with {{parameter_name1|uq}}", "value1")
.message(" {{parameter_name2|uq}}.", "value2")
)
assert message == "E-ERJ-TEST-1: Message with value1 value2."

2 changes: 1 addition & 1 deletion test/unit/legacy/test_exa_error.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@


def test_message_builder():
assert str(ExaError.message_builder("E-ERJ-TEST-1")) == "E-ERJ-TEST-1"
assert str(ExaError.message_builder("E-ERJ-TEST-1")) == "E-ERJ-TEST-1"

0 comments on commit 1c19573

Please sign in to comment.