add api-key as an input argument

replace os.getenv() with os.environ[]

(need all of these)

fix api-key type : str

set INPUT_API-KEY in test

Author: beachdweller

.github/workflows/build.yml

@@ -36,9 +36,9 @@ jobs:
       with:
         report-files: tests/sample_report.json,tests/json_dict_div_zero_try_except.json
         student-files: tests/sample_code.py
+        api-key: ${{ secrets.GOOGLE_API_KEY }}
         readme-path: tests/sample_readme.md
-      env:
-        GOOGLE_API_KEY: ${{ secrets.GOOGLE_API_KEY }}
+      timeout-minutes: 5
 
     - name: Output the outputs of the integration test of the action
       run: |

README.md

@@ -20,11 +20,11 @@ Provide AI-powered feedback on Python code assignments using Google's Gemini lan
     with:
       # JSON files by pytest-json-report plugin
       report-files: report0.json, report1.json
+      # API key for AI
+      api-key: ${{ secrets.GOOGLE_API_KEY }}
       # python file including the student's code
       student-files: exercies.py
       # assignment instruction file
       readme-path: README.md
-    env:
-      GOOGLE_API_KEY: ${{ secrets.GOOGLE_API_KEY }}
     timeout-minutes: 5
 ```

action.yml

@@ -11,6 +11,10 @@ inputs:
     required: true
     default: 'report.json'
     type: list
+  api-key:
+    description: 'API token for AI'
+    required: true
+    type: string
   student-files:
     description: "Comma-separated list of student's Python file paths or a glob pattern"
     required: false

ai_tutor.py

@@ -12,7 +12,6 @@
 
 
 HEADER = Dict[str, str]
-GOOGLE_API_KEY = os.getenv('GOOGLE_API_KEY')
 
 
 logging.basicConfig(level=logging.INFO)
@@ -21,13 +20,9 @@
 RESOURCE_EXHAUSTED = 429
 
 
-def test_API_key():
-    assert GOOGLE_API_KEY, 'API KEY NOT Available'
-
-
 @functools.lru_cache
-def url() -> str:
-    return f'https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash-latest:generateContent?key={GOOGLE_API_KEY}'
+def url(api_key:str) -> str:
+    return f'https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash-latest:generateContent?key={api_key}'
 
 
 @functools.lru_cache
@@ -37,7 +32,7 @@ def header() -> HEADER:
 
 def ask_gemini(
             question: str,
-            url:str=url(),
+            api_key:str,
             header:HEADER=header(),
             retry_delay_sec: float = 5.0,
             max_retry_attempt: int = 3,
@@ -67,7 +62,7 @@ def ask_gemini(
             logging.error(f"Timeout exceeded for question: {question}")
             break  # Exit the loop on timeout
 
-        response = requests.post(url, headers=header, json=data)
+        response = requests.post(url(api_key), headers=header, json=data)
 
         if response.status_code == 200:
             result = response.json()
@@ -92,7 +87,8 @@ def ask_gemini(
 def gemini_qna(
         report_paths:List[pathlib.Path],
         student_files:List[pathlib.Path],
-        readme_file:pathlib.Path
+        readme_file:pathlib.Path,
+        api_key:str,
     ) -> str:
     '''
     Queries the Gemini API to provide explanations for failed pytest test cases.
@@ -133,7 +129,7 @@ def gemini_qna(
             "\n\n".join(questions)
             + get_code_instruction(student_files, readme_file)
         )  # Add code & instruction only once
-        answers = ask_gemini(consolidated_question)
+        answers = ask_gemini(consolidated_question, api_key)
 
     return answers
 

entrypoint.py

@@ -19,20 +19,20 @@
 
 
 def main() -> None:
-    # Check if the API key is available
-    ai_tutor.test_API_key()
-
-    report_files_str = os.getenv('INPUT_REPORT-FILES')
+    report_files_str = os.environ['INPUT_REPORT-FILES']
     report_files = get_path_tuple(report_files_str)
 
-    student_files_str = os.getenv('INPUT_STUDENT-FILES')
+    student_files_str = os.environ['INPUT_STUDENT-FILES']
     student_files = get_path_tuple(student_files_str)
 
-    readme_file_str = os.getenv('INPUT_README-PATH')
+    readme_file_str = os.environ['INPUT_README-PATH']
     readme_file = pathlib.Path(readme_file_str)
     assert readme_file.exists(), 'No README file'
 
-    feedback = ai_tutor.gemini_qna(report_files, student_files, readme_file)
+    assert 'INPUT_API-KEY' in os.environ, os.environ.keys()
+    api_key = os.environ['INPUT_API-KEY']
+
+    feedback = ai_tutor.gemini_qna(report_files, student_files, readme_file, api_key)
 
     print(feedback)
 

tests/test_ai_tutor.py

@@ -18,9 +18,6 @@
 )
 
 
-# fake API key
-os.environ['GOOGLE_API_KEY'] = 'test_key'
-
 import ai_tutor
 
 

tests/test_entrypoint.py

@@ -15,9 +15,6 @@
 )
 
 
-# fake API key
-os.environ['GOOGLE_API_KEY'] = 'test_key'
-
 import entrypoint
 
 

tests/test_integration.py

@@ -11,16 +11,14 @@
     str(pathlib.Path(__file__).parent.parent.resolve())
 )
 
-# fake API key
-os.environ['GOOGLE_API_KEY'] = 'test_key'
 
 import entrypoint
 
 
 @unittest.mock.patch('ai_tutor.gemini_qna')
 def test_main_argument_passing__all_exists(mock_gemini_qna, caplog, tmp_path) -> None:
     # Setup
-    os.environ['GOOGLE_API_KEY'] = 'test_key'
+    os.environ['INPUT_API-KEY'] = 'test_key'
 
     os.environ['GITHUB_OUTPUT'] = str(tmp_path / 'output.txt')
 
@@ -49,7 +47,8 @@ def test_main_argument_passing__all_exists(mock_gemini_qna, caplog, tmp_path) ->
     mock_gemini_qna.assert_called_once_with(
         (tmp_path / 'file1.txt', tmp_path / 'file2.txt', tmp_path / 'file3.txt'),
         (tmp_path / 'file4.txt', tmp_path / 'file5.txt', tmp_path / 'file6.txt'),
-        tmp_path / 'readme.txt'
+        tmp_path / 'readme.txt',
+        'test_key',
     )
 
     assert 'does not exist' not in caplog.text