CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-12-05 08:52:31 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add snippet numbers to filenames in the Dev cog to fix exception formatting (#6135)

Browse Source
This commit is contained in:
Jakub Kuczys
2023-05-12 00:27:19 +02:00
committed by GitHub
parent e7d7eba68f
commit 70ca8ff1f4
2 changed files with 184 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
tests/core/test_dev_commands.py
View File

@@ -1,11 +1,12 @@
import sys
import textwrap
from typing import Any, Dict, Optional
from unittest.mock import MagicMock
import pytest
from redbot.core import commands
from redbot.core.dev_commands import DevOutput, cleanup_code
from redbot.core.dev_commands import DevOutput, SourceCache, cleanup_code
# the examples are based on how the markdown ends up being rendered by Discord
@@ -134,12 +135,20 @@ def test_cleanup_code(content: str, source: str) -> None:
assert cleanup_code(content) == source
def _get_dev_output(source: str) -> DevOutput:
def _get_dev_output(
source: str,
*,
source_cache: Optional[SourceCache] = None,
env: Optional[Dict[str, Any]] = None,
) -> DevOutput:
if source_cache is None:
source_cache = SourceCache()
return DevOutput(
MagicMock(spec=commands.Context),
source_cache=source_cache,
filename=f"<test run - snippet #{source_cache.take_next_index()}>",
source=source,
filename="<test run>",
env={"__builtins__": __builtins__, "__name__": "__main__", "_": None},
env={"__builtins__": __builtins__, "__name__": "__main__", "_": None, **(env or {})},
)
@@ -184,7 +193,7 @@ EXPRESSION_TESTS = {
(
lambda v: v < (3, 10),
"""\
File "<test run>", line 1
File "<test run - snippet #0>", line 1
12x
^
SyntaxError: invalid syntax
@@ -193,7 +202,7 @@ EXPRESSION_TESTS = {
(
lambda v: v >= (3, 10),
"""\
File "<test run>", line 1
File "<test run - snippet #0>", line 1
12x
^
SyntaxError: invalid decimal literal
@@ -204,7 +213,7 @@ EXPRESSION_TESTS = {
(
lambda v: v < (3, 10),
"""\
File "<test run>", line 1
File "<test run - snippet #0>", line 1
foo(x, z for z in range(10), t, w)
^
SyntaxError: Generator expression must be parenthesized
@@ -213,7 +222,7 @@ EXPRESSION_TESTS = {
(
lambda v: v >= (3, 10),
"""\
File "<test run>", line 1
File "<test run - snippet #0>", line 1
foo(x, z for z in range(10), t, w)
^^^^^^^^^^^^^^^^^^^^
SyntaxError: Generator expression must be parenthesized
@@ -226,7 +235,7 @@ EXPRESSION_TESTS = {
lambda v: v < (3, 11),
"""\
Traceback (most recent call last):
File "<test run>", line 1, in <module>
File "<test run - snippet #0>", line 1, in <module>
abs(1 / 0)
ZeroDivisionError: division by zero
""",
@@ -235,7 +244,7 @@ EXPRESSION_TESTS = {
lambda v: v >= (3, 11),
"""\
Traceback (most recent call last):
File "<test run>", line 1, in <module>
File "<test run - snippet #0>", line 1, in <module>
abs(1 / 0)
~~^~~
ZeroDivisionError: division by zero
@@ -252,7 +261,7 @@ STATEMENT_TESTS = {
(
lambda v: v < (3, 10),
"""\
File "<test run>", line 2
File "<test run - snippet #0>", line 2
12x
^
SyntaxError: invalid syntax
@@ -261,7 +270,7 @@ STATEMENT_TESTS = {
(
lambda v: v >= (3, 10),
"""\
File "<test run>", line 2
File "<test run - snippet #0>", line 2
12x
^
SyntaxError: invalid decimal literal
@@ -275,7 +284,7 @@ STATEMENT_TESTS = {
(
lambda v: v < (3, 10),
"""\
File "<test run>", line 2
File "<test run - snippet #0>", line 2
foo(x, z for z in range(10), t, w)
^
SyntaxError: Generator expression must be parenthesized
@@ -284,7 +293,7 @@ STATEMENT_TESTS = {
(
lambda v: v >= (3, 10),
"""\
File "<test run>", line 2
File "<test run - snippet #0>", line 2
foo(x, z for z in range(10), t, w)
^^^^^^^^^^^^^^^^^^^^
SyntaxError: Generator expression must be parenthesized
@@ -304,7 +313,7 @@ STATEMENT_TESTS = {
"""\
123
Traceback (most recent call last):
File "<test run>", line 3, in <module>
File "<test run - snippet #0>", line 3, in <module>
abs(1 / 0)
ZeroDivisionError: division by zero
""",
@@ -314,7 +323,7 @@ STATEMENT_TESTS = {
"""\
123
Traceback (most recent call last):
File "<test run>", line 3, in <module>
File "<test run - snippet #0>", line 3, in <module>
abs(1 / 0)
~~^~~
ZeroDivisionError: division by zero
@@ -389,3 +398,37 @@ async def test_successful_run_repl_exec(monkeypatch: pytest.MonkeyPatch) -> None
world
"""
await _run_dev_output(monkeypatch, source, result, repl=True)
async def test_regression_format_exception_from_previous_snippet(
monkeypatch: pytest.MonkeyPatch,
) -> None:
snippet_0 = textwrap.dedent(
"""\
def repro():
raise Exception("this is an error!")
return repro
"""
)
snippet_1 = "_()"
result = textwrap.dedent(
"""\
Traceback (most recent call last):
File "<test run - snippet #1>", line 1, in func
_()
File "<test run - snippet #0>", line 2, in repro
raise Exception("this is an error!")
Exception: this is an error!
"""
)
monkeypatch.setattr("redbot.core.dev_commands.sanitize_output", lambda ctx, s: s)
source_cache = SourceCache()
output = _get_dev_output(snippet_0, source_cache=source_cache)
await output.run_eval()
output = _get_dev_output(snippet_1, source_cache=source_cache, env={"_": output.result})
await output.run_eval()
assert str(output) == result
# ensure that our Context mock is never actually used by anything
assert not output.ctx.mock_calls