FoPro Automatic UML Assessment

.env.example

@@ -0,0 +1,5 @@
+# Copy this file to .env and fill in real values.
+# Never commit .env to git.
+
+# OLLAMA API key used by Spring property: ollama.apiKey
+OLLAMA_API_KEY=

.gitignore

@@ -37,3 +37,8 @@ out/
 .vscode/
 
 node_modules/
+
+# Local environment secrets
+.env
+.env.local
+.env.*.local

README.md

@@ -14,6 +14,7 @@ It handles assignment creation, grading, and publishing grading results. Externa
 | spring.datasource.url      | PostgreSQL database URL            | jdbc:postgresql://localhost:1132/assignment_service | jdbc:postgresql://assignment-service-db-postgresql:5432/assignment-service |
 | spring.datasource.username | Database usernam                   | root                                                | gits                                                                       |
 | spring.datasource.password | Database password                  | root                                                | *secret*                                                                   |
+| OLLAMA_API_KEY            | API key for LLM requests (ollama.apiKey) | set via local .env file                             | set via deployment secret/env var                                          |
 | DAPR_HTTP_PORT             | Dapr HTTP Port*                    | 1100                                                | 3500                                                                       |
 | server.port                | Port on which the application runs | 1101                                                | 1101                                                                       |
 | course_service.url         | URL for course service GraphQL     | http://localhost:2001/graphql                       | http://localhost:3500/v1.0/invoke/course-service/method/graphql            |
@@ -36,6 +37,21 @@ It handles assignment creation, grading, and publishing grading results. Externa
 | logging.level.root                      | Logging level for root logger             | DEBUG                                   | -                                       |
 | DAPR_GRPC_PORT                          | Dapr gRPC Port                            | -                                       | 50001                                   |
 
+## Local secrets with .env
+
+For local development, keep secrets in a root-level `.env` file. The application imports this file via Spring configuration.
+
+1. Create `.env` in the repository root.
+2. Add your key:
+
+```properties
+OLLAMA_API_KEY=your_real_key_here
+```
+
+3. Do not commit `.env` (already ignored via `.gitignore`).
+
+Use `.env.example` as the template for required keys.
+
 ## API description
 
 The GraphQL API is described in the [api.md file](api.md).

build.gradle

@@ -111,8 +111,8 @@ repositories {
 }
 
 dependencies {
-    implementation 'de.unistuttgart.iste.meitrex:meitrex-common:1.4.12'
-    implementation 'de.unistuttgart.iste.meitrex:content_service:1.5.0rc7'
+    implementation 'de.unistuttgart.iste.meitrex:meitrex-common:1.6.0'
+    implementation 'de.unistuttgart.iste.meitrex:content_service:1.6.1'
     implementation 'de.unistuttgart.iste.meitrex:course_service:1.1.0rc2'
     implementation 'de.unistuttgart.iste.meitrex:user_service:1.0.0rc1'
     implementation 'com.google.code.gson:gson:2.13.1'
@@ -134,7 +134,7 @@ dependencies {
     runtimeOnly 'org.postgresql:postgresql'
     annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
     annotationProcessor 'org.projectlombok:lombok'
-    testImplementation 'de.unistuttgart.iste.meitrex:meitrex-common-test:1.4.12'
+    testImplementation 'de.unistuttgart.iste.meitrex:meitrex-common-test:1.6.0'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
     testImplementation 'org.springframework:spring-webflux'
     testImplementation 'org.springframework.graphql:spring-graphql-test'

docker-compose.yml

@@ -27,19 +27,26 @@ services:
       - "1101:1101"
     depends_on:
       - database
+    env_file:
+      - ./../assignment_service/.env
     environment:
       SPRING_DATASOURCE_URL: jdbc:postgresql://database:5432/assignment_service
       SPRING_DATASOURCE_USERNAME: root
       SPRING_DATASOURCE_PASSWORD: root
   dapr-assignment:
     image: "daprio/daprd"
-    command: [
-      "./daprd",
-      "--app-id", "assignment_service",
-      "--app-port", "1101",
-      "--dapr-http-port", "1100",
-      "--resources-path", "./components"
-    ]
+    command:
+      [
+        "./daprd",
+        "--app-id",
+        "assignment_service",
+        "--app-port",
+        "1101",
+        "--dapr-http-port",
+        "1100",
+        "--resources-path",
+        "./components",
+      ]
     volumes:
       - "./../assignment_service/components/:/components" # Mount our components folder for the runtime to use. The mounted location must match the --resources-path argument.
     depends_on:

src/main/java/de/unistuttgart/iste/meitrex/assignment_service/AssignmentServiceApplication.java

@@ -3,6 +3,8 @@
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.scheduling.annotation.EnableScheduling;
+import org.springframework.scheduling.annotation.EnableAsync;
 
 import java.util.Arrays;
 
@@ -11,6 +13,8 @@
  * <p>
  */
 @SpringBootApplication
+@EnableScheduling
+@EnableAsync
 @Slf4j
 public class AssignmentServiceApplication {
 

src/main/java/de/unistuttgart/iste/meitrex/assignment_service/config/OllamaClientConfiguration.java

@@ -0,0 +1,40 @@
+package de.unistuttgart.iste.meitrex.assignment_service.config;
+
+import de.unistuttgart.iste.meitrex.common.ollama.OllamaClient;
+import de.unistuttgart.iste.meitrex.common.config.OllamaConfig;
+import de.unistuttgart.iste.meitrex.common.service.JsonSchemaGeneratorService;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import java.net.http.HttpClient;
+import java.time.Duration;
+
+@Configuration
+public class OllamaClientConfiguration {
+
+    @Bean
+    public OllamaConfig ollamaConfig() {
+        return new OllamaConfig();
+    }
+
+    @Bean
+    public HttpClient ollamaHttpClient() {
+        return HttpClient.newBuilder()
+                .connectTimeout(Duration.ofSeconds(30))
+                .build();
+    }
+
+    @Bean
+    public JsonSchemaGeneratorService jsonSchemaGeneratorService() {
+        return new JsonSchemaGeneratorService();
+    }
+
+    @Bean
+    public OllamaClient ollamaClient(OllamaConfig config,
+                                     JsonSchemaGeneratorService schemaService,
+                                     ObjectMapper objectMapper,
+                                     HttpClient ollamaHttpClient) {
+        return new OllamaClient(config, schemaService, objectMapper, ollamaHttpClient);
+    }
+}

src/main/java/de/unistuttgart/iste/meitrex/assignment_service/controller/UmlExerciseController.java

@@ -0,0 +1,98 @@
+package de.unistuttgart.iste.meitrex.assignment_service.controller;
+
+import de.unistuttgart.iste.meitrex.assignment_service.persistence.entity.umlExercise.UmlEvaluationJobStatus;
+import de.unistuttgart.iste.meitrex.assignment_service.service.uml_assignment.UmlExerciseService;
+import de.unistuttgart.iste.meitrex.assignment_service.service.uml_assignment.UmlEvaluationQueueService;
+import de.unistuttgart.iste.meitrex.common.user_handling.LoggedInUser;
+import de.unistuttgart.iste.meitrex.generated.dto.*;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.graphql.data.method.annotation.*;
+import org.springframework.stereotype.Controller;
+
+import java.util.List;
+import java.util.UUID;
+
+@Slf4j
+@Controller
+@RequiredArgsConstructor
+public class UmlExerciseController {
+
+    private final UmlExerciseService umlExerciseService;
+    private final UmlEvaluationQueueService umlEvaluationQueueService;
+
+    @MutationMapping(name = "_internal_noauth_createUmlExercise")
+    public UmlExercise createUmlExercise(@Argument final UUID courseId,
+                                         @Argument final UUID assessmentId,
+                                         @Argument final CreateUmlExerciseInput input) {
+        return umlExerciseService.createExercise(courseId, assessmentId, input);
+    }
+
+    @MutationMapping
+    public UmlExerciseMutation mutateUmlExercise(@Argument final UUID assessmentId,
+                                                 @ContextValue final LoggedInUser currentUser) {
+        return umlExerciseService.mutateUmlExercise(assessmentId, currentUser);
+    }
+
+    @SchemaMapping(typeName = "UmlExerciseMutation")
+    public UmlExercise updateTutorSolution(final UmlExerciseMutation mutation,
+                                           @Argument final UmlDiagramInput tutorSolution) {
+        return umlExerciseService.updateTutorSolution(mutation.getAssessmentId(), tutorSolution);
+    }
+
+    @SchemaMapping(typeName = "UmlExerciseMutation")
+    public UmlExercise updateUmlExercise(final UmlExerciseMutation mutation,
+                                         @Argument final UpdateUmlExerciseInput input) {
+        return umlExerciseService.updateUmlExercise(mutation.getAssessmentId(), input);
+    }
+
+    @SchemaMapping(typeName = "UmlExerciseMutation")
+    public UmlStudentSolution createUmlSolution(final UmlExerciseMutation mutation,
+                                                @Argument UUID studentId,
+                                                @Argument boolean createFromPrevious) {
+        log.info("Mutation: createUmlSolution for assessmentId={}, studentId={}", mutation.getAssessmentId(), studentId);
+        return umlExerciseService.createNewSolution(mutation.getAssessmentId(), studentId, createFromPrevious);
+    }
+
+    @SchemaMapping(typeName = "UmlExerciseMutation")
+    public UmlStudentSolution saveStudentSolution(final UmlExerciseMutation mutation,
+                                                  @Argument final UUID studentId,
+                                                  @Argument final UmlDiagramInput diagram,
+                                                  @Argument final UUID solutionId,
+                                                  @Argument final Boolean submit) {
+        return umlExerciseService.saveStudentSolution(
+                mutation.getAssessmentId(), studentId, diagram, solutionId, submit != null && submit);
+    }
+
+    @QueryMapping
+    public UmlExercise getUmlExerciseByAssessmentId(@Argument UUID assessmentId) {
+        return umlExerciseService.getExerciseByAssessmentId(assessmentId);
+    }
+
+    @SchemaMapping(typeName = "UmlExercise")
+    public List<UmlStudentSolution> solutionsByStudent(UmlExercise exercise, @Argument UUID studentId) {
+        return umlExerciseService.getSolutionsByStudent(exercise, studentId);
+    }
+
+    @SchemaMapping(typeName = "UmlExercise")
+    public UmlStudentSolution latestSolution(UmlExercise exercise, @Argument UUID studentId) {
+        return umlExerciseService.getSolutionsByStudent(exercise, studentId).stream()
+            .findFirst()
+            .orElse(null);
+    }
+
+    @SchemaMapping(typeName = "UmlExerciseMutation")
+    public UmlStudentSolution evaluateLatestSolution(
+            final UmlExerciseMutation mutation,
+            @Argument UUID studentId) {
+        return umlExerciseService.enqueueLatestSolutionForEvaluation(mutation.getAssessmentId(), studentId);
+    }
+
+    @SchemaMapping(typeName = "UmlStudentSolution")
+    public UmlEvaluationJobStatus evaluationStatus(UmlStudentSolution solution) {
+        if (solution == null || solution.getId() == null) {
+            return null;
+        }
+        return umlEvaluationQueueService.getJobStatus(solution.getId());
+    }
+}

src/main/java/de/unistuttgart/iste/meitrex/assignment_service/exception/AiEvaluationException.java

@@ -0,0 +1,7 @@
+package de.unistuttgart.iste.meitrex.assignment_service.exception;
+
+public class AiEvaluationException extends RuntimeException {
+    public AiEvaluationException(String message) {
+        super(message);
+    }
+}

src/main/java/de/unistuttgart/iste/meitrex/assignment_service/persistence/entity/umlExercise/UmlDiagram.java

@@ -0,0 +1,26 @@
+package de.unistuttgart.iste.meitrex.assignment_service.persistence.entity.umlExercise;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.Embeddable;
+import lombok.*;
+
+@Embeddable
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class UmlDiagram {
+
+    @Column(name = "diagram", columnDefinition = "TEXT")
+    private String diagramCode;
+
+    @Column(columnDefinition = "TEXT")
+    private String semanticModel;
+
+    /**
+     * Helper to check if the diagram is actually "empty"
+     */
+    public boolean isEmpty() {
+        return (diagramCode == null || diagramCode.isBlank()) && (semanticModel == null || semanticModel.isBlank());
+    }
+}

src/main/java/de/unistuttgart/iste/meitrex/assignment_service/persistence/entity/umlExercise/UmlEvaluationJobEntity.java

@@ -0,0 +1,43 @@
+package de.unistuttgart.iste.meitrex.assignment_service.persistence.entity.umlExercise;
+
+import jakarta.persistence.*;
+import lombok.*;
+import de.unistuttgart.iste.meitrex.common.persistence.IWithId;
+
+import java.time.OffsetDateTime;
+import java.util.UUID;
+
+@Entity(name = "UmlEvaluationJob")
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class UmlEvaluationJobEntity implements IWithId<UUID> {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.UUID)
+    private UUID id;
+
+    @ManyToOne(fetch = FetchType.LAZY)
+    @JoinColumn(name = "solution_id", nullable = false)
+    private UmlStudentSolutionEntity solution;
+
+    @Enumerated(EnumType.STRING)
+    @Column(nullable = false)
+    private UmlEvaluationJobStatus status;
+
+    @Column(columnDefinition = "TEXT")
+    private String errorMessage;
+
+    @Column
+    private OffsetDateTime createdAt;
+
+    @Column
+    private OffsetDateTime startedAt;
+
+    @Column
+    private OffsetDateTime completedAt;
+
+    @Version
+    private Long version;
+}

src/main/java/de/unistuttgart/iste/meitrex/assignment_service/persistence/entity/umlExercise/UmlEvaluationJobStatus.java

@@ -0,0 +1,8 @@
+package de.unistuttgart.iste.meitrex.assignment_service.persistence.entity.umlExercise;
+
+public enum UmlEvaluationJobStatus {
+    ENQUEUED,
+    PROCESSING,
+    DONE,
+    FAILED
+}

src/main/java/de/unistuttgart/iste/meitrex/assignment_service/persistence/entity/umlExercise/UmlExerciseEntity.java

@@ -0,0 +1,47 @@
+package de.unistuttgart.iste.meitrex.assignment_service.persistence.entity.umlExercise;
+
+import jakarta.persistence.*;
+import lombok.*;
+import de.unistuttgart.iste.meitrex.common.persistence.IWithId;
+
+import java.util.List;
+import java.util.UUID;
+
+@Entity(name = "UmlExercise")
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class UmlExerciseEntity implements IWithId<UUID> {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.UUID)
+    private UUID id;
+
+    @Column(nullable = false, unique = true)
+    private UUID assessmentId;
+
+    @Column(nullable = false)
+    private UUID courseId;
+
+    @Column(nullable = false, columnDefinition = "TEXT")
+    private String description;
+
+    @Column(nullable = false)
+    private boolean showSolution;
+
+    @Embedded
+    private UmlDiagram tutorSolution;
+
+    @Column(columnDefinition = "TEXT")
+    private String gradingRules;
+
+    @Column(nullable = false)
+    private int totalPoints;
+
+    @Column(nullable = false)
+    private double requiredPercentage;
+
+    @OneToMany(mappedBy = "exercise", cascade = CascadeType.ALL, orphanRemoval = true)
+    private List<UmlStudentSubmissionEntity> studentSubmissions;
+}