add header & footer to the question

Author: beachdweller

ai_tutor.py

@@ -142,10 +142,14 @@ def get_initial_instruction(questions:List[str],language:str) -> str:
             initial_instruction = f'In {language}, please comment on the student code given the assignment instruction.'
         return initial_instruction
 
-    questions = [get_initial_instruction(questions, human_language)] + questions
-
-    # Add the code and instructions
-    questions.append(get_code_instruction(student_files, readme_file, human_language))
+    
+    questions = (
+        # Add the initial instruction
+        [get_initial_instruction(questions, human_language), get_question_header(human_language)]
+        + questions
+        # Add the code and instructions
+        + [get_question_footer(human_language), get_code_instruction(student_files, readme_file, human_language)]
+    )
 
     # Join all questions into a single string
     consolidated_question = "\n\n".join(questions)

tests/test_ai_tutor.py

@@ -22,8 +22,13 @@
 
 
 @pytest.fixture
-def json_dict() -> Dict[str, Union[str, List]]:
-    with open(test_folder/'sample_report.json', 'r') as f:
+def sample_report_path() -> pathlib.Path:
+    return test_folder/'sample_report.json'
+
+
+@pytest.fixture
+def json_dict(sample_report_path) -> Dict[str, Union[str, List]]:
+    with sample_report_path.open('rt') as f:
         result = json.load(f)
     return result
 
@@ -35,8 +40,13 @@ def test_collect_longrepr(json_dict):
 
 
 @pytest.fixture
-def json_dict_div_zero_try_except() -> Dict[str, Union[str, List]]:
-    with open(test_folder/'json_dict_div_zero_try_except.json', 'r') as f:
+def div_zero_report_path() -> pathlib.Path:
+    return test_folder/'json_dict_div_zero_try_except.json'
+
+
+@pytest.fixture
+def json_dict_div_zero_try_except(div_zero_report_path:pathlib.Path) -> Dict[str, Union[str, List]]:
+    with div_zero_report_path.open('rt') as f:
         result = json.load(f)
     return result
 
@@ -139,5 +149,26 @@ def test_get_code_instruction(
     assert instruction in result
 
 
+def test_get_the_question(
+        sample_report_path:pathlib.Path,
+        div_zero_report_path:pathlib.Path,
+        sample_student_code_path:pathlib.Path,
+        sample_readme_path:pathlib.Path,
+        human_language:str,
+        homework:str, msg:str,
+        instruction:str,
+    ):
+    result = ai_tutor.get_the_question(
+        report_paths=(sample_report_path,div_zero_report_path),
+        student_files=(sample_student_code_path,),
+        readme_file=sample_readme_path,
+        human_language=human_language,
+    ).lower()
+
+    assert homework in result
+    assert msg in result
+    assert instruction in result
+
+
 if '__main__' == __name__:
     pytest.main([__file__])