Merge pull request #53 from devchat-ai/improve-propose-tests

feat: maintain a balance between happy paths and edge cases

Author: kagami-l

unit_tests/main.py

@@ -5,7 +5,11 @@
 import click
 from find_reference_tests import find_reference_tests
 from i18n import TUILanguage, get_translation
-from model import FuncToTest, TokenBudgetExceededException, UserCancelledException
+from model import (
+    FuncToTest,
+    TokenBudgetExceededException,
+    UserCancelledException,
+)
 from propose_test import propose_test
 from tools.file_util import retrieve_file_content
 from write_tests import write_and_print_tests
@@ -39,7 +43,9 @@ def run(self):
 
         self.step3_write_and_print_tests(cases, files)
 
-    def step1_propose_cases_and_reference_files(self) -> Tuple[List[str], List[str]]:
+    def step1_propose_cases_and_reference_files(
+        self,
+    ) -> Tuple[List[str], List[str]]:
         """
         Propose test cases and reference files for a specified function.
 
@@ -60,7 +66,9 @@ def step1_propose_cases_and_reference_files(self) -> Tuple[List[str], List[str]]
             )
 
             ref_files = find_reference_tests(
-                self.repo_root, self.func_to_test.func_name, self.func_to_test.file_path
+                self.repo_root,
+                self.func_to_test.func_name,
+                self.func_to_test.file_path,
             )
 
         if ref_files:
@@ -122,7 +130,7 @@ def step2_edit_cases_and_reference_files(
             try:
                 retrieve_file_content(file_path=ref_file, root_path=self.repo_root)
                 valid_files.append(ref_file)
-            except Exception as e:
+            except Exception:
                 invalid_files.append(ref_file)
 
         # Print summary

unit_tests/prompts.py

@@ -4,7 +4,7 @@
 
 PROPOSE_TEST_PROMPT = """
 You're an advanced AI test case generator.
-Given a user prompt and a target function, propose test cases for the function based on the prompt.
+Given a user prompt and a target function, propose detailed test cases for the function based on the prompt, categorizing each as either a 'happy path' or an 'edge case'.
 
 The user prompt is as follows:
 
@@ -16,15 +16,26 @@
 
 {relevant_content}
 
-Propose each test case with a one-line description of what behavior it tests.
+For each test case, provide a description that includes:
+- A brief explanation of the test's purpose
+- The specific conditions being tested.
+- The expected outcome the test is verifying.
+
+Categorize each test case as:
+- 'happy path': Tests the function with typical inputs and standard conditions, ensuring it performs as expected in normal use.
+- 'edge case': Tests the function with atypical inputs or in unusual conditions, checking its robustness and error handling.
+
 You don't have to write the test cases in code, just describe them in plain {chat_language}.
-Do not generate more than 6 test cases.
+
+Aim to generate 3 'happy path' test cases and 3 'edge case' test cases, totaling 6 test cases.
 
 Answer in JSON format:
 {{
     "test_cases": [
-        {{"description": "<describe test case 1 in {chat_language}>"}},
-        {{"description": "<describe test case 2 in {chat_language}>"}},
+        {{"description": "<describe test case 1 in {chat_language}>", "category": "happy path"}},
+        ...
+        {{"description": "<describe test case 4 in {chat_language}>", "category": "edge case"}},
+        ...
     ]
 }}
 """

unit_tests/propose_test.py

@@ -93,7 +93,11 @@ def propose_test(
     descriptions = []
     for case in cases:
         description = case.get("description", None)
+        category = case.get("category", None)
         if description:
-            descriptions.append(description)
+            if category:
+                descriptions.append(category + ": " + description)
+            else:
+                descriptions.append(description)
 
     return descriptions