Merge pull request #174 from Cloud-Code-AI/173-refc-reformat-the-prompts-for-ui-test-case-generator

feat: Updated prompt for ui test generation

Author: sauravpanda

examples/basic/generate.py

@@ -1,15 +1,27 @@
 from kaizen.generator.ui import UITestGenerator
+import time
+import sys
 
 generator = UITestGenerator()
 
 WEBPAGE_URL = "https://cloudcode.ai"
 
-tests, _ = generator.generate_ui_tests(WEBPAGE_URL)
+print(f"Generating UI tests for `{WEBPAGE_URL}`, please wait...")
+start_time = time.time()
+
+try:
+    tests, _ = generator.generate_ui_tests(WEBPAGE_URL)
+except Exception as e:
+    print(f"Error: {e}")
+    sys.exit(1)
+
+end_time = time.time()
+elapsed_time = end_time - start_time
+print(f"\nUI tests generated in {elapsed_time:.2f} seconds.")
 
-# print("Generated Tests: ", json.dumps(tests))
 
 for test in tests:
-    print(f'#### ======== Module Title: {test["module_title"]} ========== ####')
+    print(f'#### ======== Module Title: {test["module_title"]} || Importance: {test["importance"]} ========== ####')
     for t in test["tests"]:
         print(f'Desc: {t["test_description"]}')
         print(f'Code: \n{t["code"]}')

kaizen/helpers/output.py

@@ -100,7 +100,9 @@ def create_test_files(json_tests, folder_path):
                     logger.info(f"Failed to clean code")
                 else:
                     cleaned_code = (
-                        f"''' Module Name: {module['module_title']}\n '''\n\n"
+                        f"'''Importance: {module['importance']}\
+                            \nModule Name: {module['module_title']}\
+                            \nDescription: {test['test_description']}\n'''\n\n"
                         + cleaned_code
                     )
                     f.write(cleaned_code)

kaizen/llms/prompts.py

@@ -143,34 +143,54 @@
 {CODE_DIFF}
 
 """
-# TODO: Rephrase prompt to make it more clear and accurate.
+
 UI_MODULES_PROMPT = """
-Assign yourself as a quality assurance engineer. Read this code and design comprehensive tests to test the UI
-of this html. Break it down into 5-10 separate modules and return the output as JSON with the following keys:
-id - serial number to identify
+Assign yourself as a quality assurance engineer. 
+Read this code and design comprehensive tests to test the UI of this HTML. 
+Break it down into 5-10 separate modules and identify the possible things to test for each module. 
+For each module, also identify which tests should be checked repeatedly (e.g., after every code change, every build, etc.).
+
+Return the output as JSON with the following keys:
+id - serial number to identify module
 module_title - title of the identified module
-tests - JSON containing list of tests steps to carry out for that module with keys - id, test_description, test_name.
+tests - JSON containing list of tests steps to carry out for that module with keys:
+  id - serial number for the test case
+  test_description - description of the test case
+  test_name - name of the test case
+  repeat - boolean indicating if this test should be checked repeatedly or not
 folder_name - relevant name for the module
 importance - level of importance of this test out of ['critical', 'good_to_have', 'non_essential']
-Share the JSON output ONLY. No other text.
 
-CONTENT:
-```{WEB_CONTENT}```
+Share the JSON output ONLY. No other text.
+CONTENT: ```{WEB_CONTENT}```
 """
 
-# TODO: Rephrase prompt to make it more clear and accurate.
 UI_TESTS_SYSTEM_PROMPT = """
-As a test case engineer, your task is to write comprehensive test cases for a given user interface. 
-You should review the user interface and identify all possible use cases and edge cases that need to be tested. 
-Your test cases should cover all aspects of the user interface, including functionality, usability, and accessibility.
+Here's a shortened version of the system prompt:
+
+You are a Quality Assurance AI assistant specializing in writing Playwright test scripts for web applications. Your goal is to create robust and maintainable test scripts that can be integrated into a CI/CD pipeline.
+
+When given requirements or specifications, you should:
+
+1. Analyze the requirements and design a comprehensive test plan.
+2. Write Playwright test scripts in Python 3.9 following best practices.
+3. Implement techniques like Page Object Model for reusability.
+4. Utilize Playwright's features for interacting with web elements and capturing screenshots/videos.
+5. Incorporate data-driven testing and parallelization strategies.
+6. Ensure compatibility with the CI/CD pipeline and provide clear documentation.
+7. Continuously maintain and improve the test scripts as the application evolves.
+
+Prioritize code quality, maintainability, and adherence to best practices in test automation. Collaborate with developers and stakeholders for seamless integration into the software development lifecycle.
+
+Remember, you cannot open URLs or links directly. Ask the human to provide relevant text or image content if needed.
 """
 
-# TODO: Rephrase prompt to make it more clear and accurate.
 PLAYWRIGHT_CODE_PROMPT = """
-Assign yourself as a quality assurance engineer. Read this code and write playwright code for test -
-{TEST_DESCRIPTION}. Return ONLY the playwright code based on python and strictly no other text.
+Read this code and write Playwright code in Python for the following test - {TEST_DESCRIPTION}. 
+Return ONLY the Playwright code in Python and strictly no other text.
 
 URL: {URL}
+Content: 
 ```{WEB_CONTENT}```
 """