Create tests for the faulty code blocks finder

Create the unit tests that check whether the finder recognizes Python
strings as codeblocks.

Author: roli2py

bot/exts/info/codeblock/_instructions.py

@@ -148,7 +148,7 @@ def get_instructions(content: str) -> str | None:
         instructions = _get_no_ticks_message(content)
     else:
         log.trace("Searching results for a code block with invalid ticks.")
-        block = next((block for block in blocks if block.tick != _parsing.BACKTICK), None)
+        block = _parsing._get_block_with_invalid_ticks(blocks)
 
         if block:
             log.trace("A code block exists but has invalid ticks.")

bot/exts/info/codeblock/_parsing.py

@@ -245,3 +245,16 @@ def _fix_indentation(content: str) -> str:
     content = first_line + "".join(line[first_indent:] for line in lines[1:])
 
     return content
+
+
+def _get_block_with_invalid_ticks(blocks: Sequence[CodeBlock]) -> CodeBlock | None:
+    """
+    Find a block with invalid ticks and return it.
+
+    Return `None` if there are no blocks with invalid ticks.
+    """
+    for block in blocks:
+        if block.tick != BACKTICK:
+            return block
+
+    return None

tests/bot/exts/info/codeblock/test_instructions.py

@@ -4,6 +4,52 @@
 from bot.exts.info.codeblock import _instructions as instructions, _parsing as parsing
 
 
+class FindCodeblockWithInvalidTicksTest(unittest.TestCase):
+    def test_should_return_codeblock_with_single_quotes(self) -> None:
+        first_block_content = dedent('''
+        """A script that iterates and prints the numbers"""
+        numbs = [1, 2, 3]
+
+        for numb in numbs:
+            print(numb)
+        ''').strip()
+        first_block_language = "py"
+        first_block_tick = parsing.BACKTICK
+        first_block_ticks = first_block_tick * 3
+
+        second_block_content = dedent('''
+        """A script that iterates and prints the letters"""
+        letters = ["a", "b", "c"]
+
+        for letter in letters:
+            print(letter)
+        ''').strip()
+        second_block_language = "py"
+        second_block_tick = "'"
+        second_block_ticks = second_block_tick * 3
+
+        first_block = parsing.CodeBlock(
+            first_block_content,
+            first_block_language,
+            first_block_ticks,
+            first_block_tick,
+            True,
+        )
+        second_block = parsing.CodeBlock(
+            second_block_content,
+            second_block_language,
+            second_block_ticks,
+            second_block_tick,
+            True,
+        )
+        blocks = (first_block, second_block)
+        expected_block = second_block
+
+        block_with_invalid_ticks = parsing._get_block_with_invalid_ticks(blocks)
+
+        self.assertEqual(block_with_invalid_ticks, expected_block)
+
+
 class ProvideBadTicksInstructionsTest(unittest.TestCase):
     def __assert_is_instructions_for_message_bad_ticks_one(self, message: str) -> None:
         code_blocks = parsing.find_faulty_code_blocks(message)

tests/bot/exts/info/codeblock/test_parsing.py

@@ -1,4 +1,5 @@
 import unittest
+from textwrap import dedent
 
 from bot.exts.info.codeblock import _parsing as parsing
 
@@ -92,6 +93,36 @@ def test_should_not_recognize_normal_double_quotes_python_text(self):
         self.assertIsNotNone(faulty_code_blocks)
         self.assertEqual(len(faulty_code_blocks), 0)
 
+    def test_should_not_recognize_multiline_single_quote_python_text(self) -> None:
+        message = dedent("""
+        ```py
+        \'\'\'A script that iterates and prints the numbers\'\'\'
+        numbs = [1, 2, 3]
+
+        for numb in numbs:
+            print(numb)
+        ```
+        """).strip()
+
+        faulty_code_blocks = parsing.find_faulty_code_blocks(message)
+
+        self.assertIsNone(faulty_code_blocks)
+
+    def test_should_not_recognize_multiline_double_quote_python_text(self) -> None:
+        message = dedent('''
+        ```py
+        """A script that iterates and prints the numbers"""
+        numbs = [1, 2, 3]
+
+        for numb in numbs:
+            print(numb)
+        ```
+        ''').strip()
+
+        faulty_code_blocks = parsing.find_faulty_code_blocks(message)
+
+        self.assertIsNone(faulty_code_blocks)
+
     def test_should_recognize_single_backtick_no_language(self):
         message = """`
         x = 4