Resolve Mergeconflict

.vscode/launch.json

@@ -41,14 +41,21 @@
             "type": "python",
             "request": "launch",
             "cwd": "${workspaceFolder}/module_text_cofee",
-            "module": "module_text_cofee",
+            "module": "module_text_cofee"
         },
         {
             "name": "Module Programming ThemisML",
             "type": "python",
             "request": "launch",
             "cwd": "${workspaceFolder}/module_programming_themisml",
-            "module": "module_programming_themisml",
+            "module": "module_programming_themisml"
+        },
+        {
+            "name": "Module Programming AST",
+            "type": "python",
+            "request": "launch",
+            "cwd": "${workspaceFolder}/module_programming_ast",
+            "module": "module_programming_ast"
         },
         {
             "name": "Module Programming Code Embedding",
@@ -58,4 +65,5 @@
             "module": "module_programming_code_embedding"
         }
     ]
-}
+}
+

assessment_module_manager/modules.docker.ini

@@ -23,7 +23,12 @@ url = http://module-programming-themisml:5005
 type = programming
 supports_evaluation = false
 
+[module_programming_ast]
+url = http://module-programming-ast:5006
+type = programming
+supports_evaluation = false
+
 [module_programming_code_embedding]
 url = http://module-programming-code-embedding:5007
 type = programming
-supports_evaluation = false
+supports_evaluation = false

assessment_module_manager/modules.ini

@@ -23,7 +23,13 @@ url = http://localhost:5005
 type = programming
 supports_evaluation = false
 
+[module_programming_ast]
+url = http://localhost:5006
+type = programming
+supports_evaluation = false
+
 [module_programming_code_embedding]
 url = http://localhost:5007
 type = programming
 supports_evaluation = false
+

athena-workspace.code-workspace

@@ -28,6 +28,8 @@
 			"path": "module_programming_themisml"
 		},
 		{
+            "path": "module_programming_ast"
+		},
 			"path": "module_programming_code_embedding"
 		},
 	],

docker-compose.prod.yml

@@ -60,6 +60,14 @@ services:
       - postgres
     image: ls1tum/athena_module_programming_themisml:${ATHENA_TAG:-develop}
 
+  module_programming_ast:
+    hostname: module-programming-ast
+    env_file:
+      - ${ATHENA_ENV_DIR:-./env_example}/module_programming_ast.env
+    depends_on:
+      - postgres
+    image: ls1tum/athena_module_programming_ast:${ATHENA_TAG:-develop}
+
   module_programming_code_embedding:
     hostname: module-programming-code-embedding
     env_file:
@@ -79,6 +87,5 @@ services:
     ports:
       - "5432:5432"
 
-
 volumes:
   postgres_data:

docker-compose.yml

@@ -55,10 +55,20 @@ services:
     ports:
       - "5005:5005"
 
+  module_programming_ast:
+    hostname: module-programming-ast
+    build: ./module_programming_ast
+    depends_on:
+      - athena
+    ports:
+      - "5006:5006"
+
   module_programming_code_embedding:
     hostname: module-programming-code-embedding
     build: ./module_programming_code_embedding
     depends_on:
       - athena
     ports:
       - "5007:5007"
+
+

env_example/module_programming_ast.env

@@ -0,0 +1,3 @@
+PRODUCTION=1
+SECRET=12345abcdef
+DATABASE_URL=postgresql://postgres:password@postgres:5432/athena

module_programming_ast/.dockerignore

@@ -0,0 +1,4 @@
+.venv
+.vscode
+__pycache__
+.DS_Store

module_programming_ast/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "python.pythonPath": "./.venv/bin/python",
+  "python.analysis.typeCheckingMode": "basic",
+}

module_programming_ast/Dockerfile

@@ -0,0 +1,29 @@
+# syntax=docker/dockerfile:1
+
+# This is the Dockerfile for the module_programming_ast.
+
+FROM python:3.11
+LABEL org.opencontainers.image.source=https://github.com/ls1intum/Athena
+
+# Environment variable Python in Docker
+ENV PYTHONUNBUFFERED=1
+
+WORKDIR /code
+
+# Poetry
+RUN pip install --no-cache-dir poetry==1.5.0
+
+# Dependencies
+COPY pyproject.toml poetry.lock ./
+# athena module (from the Dockerfile in the athena folder)
+COPY --from=athena /code /athena
+# install dependencies
+RUN poetry config virtualenvs.create true \
+    && poetry config virtualenvs.in-project true \
+    && poetry install --no-interaction --no-ansi
+
+# Project files
+COPY . ./
+
+# poetry scripts don't work here
+CMD poetry run python -m module_*

module_programming_ast/README.md

@@ -0,0 +1,8 @@
+# Start Directly
+`poetry run module`
+
+# Start with Docker
+`docker-compose up --build`
+
+# Start with Docker in Production Mode
+`docker-compose up --env-file .env.production --build`

module_programming_ast/module.conf

@@ -0,0 +1,4 @@
+[module]
+name = module_programming_ast
+type = programming
+port = 5006

module_programming_ast/module_programming_ast/__main__.py

@@ -0,0 +1,169 @@
+"""
+Entry point for the module_programming_ast module.
+"""
+import random
+from typing import List, Any
+from pydantic import BaseModel, Field
+
+from athena import app, config_schema_provider, submissions_consumer, submission_selector, feedback_consumer, feedback_provider, evaluation_provider, emit_meta
+from athena.programming import Exercise, Submission, Feedback
+from athena.logger import logger
+from athena.storage import store_exercise, store_submissions, store_feedback
+
+
+@config_schema_provider
+class Configuration(BaseModel):
+    """Example configuration for the module_programming_ast module."""
+    debug: bool = Field(False, description="Whether the module is in **debug mode**. This is an example config option.")
+
+
+@submissions_consumer
+def receive_submissions(exercise: Exercise, submissions: List[Submission], module_config: Configuration):
+    logger.info("receive_submissions: Received %d submissions for exercise %d", len(submissions), exercise.id)
+    for submission in submissions:
+        logger.info("- Submission %d", submission.id)
+        zip_content = submission.get_zip()
+        # list the files in the zip
+        for file in zip_content.namelist():
+            logger.info("  - %s", file)
+    # Do something with the submissions
+    logger.info("Doing stuff")
+
+    # Example use module config
+    # If you are not using module_config for your module, you can remove it from the function signature
+    logger.info("Config: %s", module_config)
+    if module_config.debug:
+        emit_meta('debug', True)
+        emit_meta('comment', 'You can add any metadata you want here')
+
+    # Add data to exercise
+    exercise.meta["some_data"] = "some_value"
+    logger.info("- Exercise meta: %s", exercise.meta)
+
+    # Add data to submission
+    for submission in submissions:
+        submission.meta["some_data"] = "some_value"
+        logger.info("- Submission %d meta: %s", submission.id, submission.meta)
+
+    store_exercise(exercise)
+    store_submissions(submissions)
+
+
+@submission_selector
+def select_submission(exercise: Exercise, submissions: List[Submission]) -> Submission:
+    logger.info("select_submission: Received %d submissions for exercise %d", len(submissions), exercise.id)
+    for submission in submissions:
+        logger.info("- Submission %d", submission.id)
+    # Do something with the submissions and return the one that should be assessed next
+    return submissions[0]
+
+
+@feedback_consumer
+def process_incoming_feedback(exercise: Exercise, submission: Submission, feedbacks: List[Feedback]):
+    logger.info("process_feedback: Received feedbacks for submission %d of exercise %d", submission.id, exercise.id)
+    logger.info("process_feedback: Feedbacks: %s", feedbacks)
+    # Do something with the feedback
+    # Add data to feedback
+    for feedback in feedbacks:
+        feedback.meta["some_data"] = "some_value"
+        store_feedback(feedback)
+
+
+@feedback_provider
+def suggest_feedback(exercise: Exercise, submission: Submission, module_config: Configuration) -> List[Feedback]:
+    logger.info("suggest_feedback: Suggestions for submission %d of exercise %d were requested", submission.id, exercise.id)
+    # Do something with the submission and return a list of feedback
+
+    # Example use of module config
+    # If you are not using module_config for your module, you can remove it from the function signature
+    logger.info("Config: %s", module_config)
+    if module_config.debug:
+        emit_meta("costs", "100.00€")
+
+    return [
+        # Referenced feedback, line 8-9 in BinarySearch.java
+        Feedback(
+            id=None,
+            exercise_id=exercise.id,
+            submission_id=submission.id,
+            title="This is a suggestion.",
+            description="There is something wrong here.",
+            credits=-1.0,
+            file_path="BinarySearch.java",
+            line_start=8,
+            line_end=9,
+            structured_grading_instruction_id=None,
+            meta={}
+        ),
+        # Referenced feedback, line 13-18 in BinarySearch.java
+        Feedback(
+            id=None,
+            exercise_id=exercise.id,
+            submission_id=submission.id,
+            title="This is a second suggestion.",
+            description="This is very good!",
+            credits=2.0,
+            file_path="BinarySearch.java",
+            line_start=13,
+            line_end=18,
+            structured_grading_instruction_id=None,
+            meta={}
+        ),
+        # Unreferenced feedback without file
+        Feedback(
+            id=None,
+            exercise_id=exercise.id,
+            submission_id=submission.id,
+            title="This is an unreferenced suggestion.",
+            description="General feedback without any reference to the submission.",
+            credits=0.0,
+            file_path=None,
+            line_start=None,
+            line_end=None,
+            structured_grading_instruction_id=None,
+            meta={}
+        ),
+        # Unreferenced feedback in BinarySearch.java
+        Feedback(
+            id=None,
+            exercise_id=exercise.id,
+            submission_id=submission.id,
+            title="This is an unreferenced suggestion in a file.",
+            description="General feedback with only the reference to a file (BinarySearch.java)",
+            credits=0.0,
+            file_path="BinarySearch.java",
+            line_start=None,
+            line_end=None,
+            structured_grading_instruction_id=None,
+            meta={}
+        )
+    ]
+
+
+# Only if it makes sense for a module (Optional)
+@evaluation_provider
+def evaluate_feedback(exercise: Exercise, submission: Submission, true_feedbacks: List[Feedback], predicted_feedbacks: List[Feedback]) -> Any:
+    logger.info(
+        "evaluate_feedback: Evaluation for submission %d of exercise %d was requested with %d true and %d predicted feedbacks", 
+        submission.id, exercise.id, len(true_feedbacks), len(predicted_feedbacks)
+    )
+
+    # Do something with the true and predicted feedback and return the evaluation result
+    # Generate some example evaluation result
+    evaluation_results = []
+    true_feedback_embeddings = [random.random() for _ in true_feedbacks] 
+    predicted_feedback_embeddings = [random.random() for _ in predicted_feedbacks]
+    for feedback, embedding in zip(predicted_feedbacks, predicted_feedback_embeddings):
+        feedback_evaluation = {
+            "feedback_id": feedback.id,
+            "embedding": embedding,
+            "has_match": len([t for t in true_feedback_embeddings if abs(t - embedding) < 0.1]) > 0,
+            "correctness": random.random()
+        }
+        evaluation_results.append(feedback_evaluation)
+
+    return evaluation_results
+
+
+if __name__ == "__main__":
+    app.start()