Programming exercises: Add ProgrammingExercise by ProjectKey endpoint

src/main/java/de/tum/cit/aet/artemis/programming/web/ProgrammingExerciseResource.java

@@ -48,15 +48,19 @@
 import de.tum.cit.aet.artemis.core.domain.User;
 import de.tum.cit.aet.artemis.core.dto.SearchResultPageDTO;
 import de.tum.cit.aet.artemis.core.dto.pageablesearch.SearchTermPageableSearchDTO;
+import de.tum.cit.aet.artemis.core.exception.AccessForbiddenException;
 import de.tum.cit.aet.artemis.core.exception.BadRequestAlertException;
 import de.tum.cit.aet.artemis.core.exception.ConflictException;
 import de.tum.cit.aet.artemis.core.exception.ContinuousIntegrationException;
 import de.tum.cit.aet.artemis.core.exception.EntityNotFoundException;
 import de.tum.cit.aet.artemis.core.repository.CourseRepository;
 import de.tum.cit.aet.artemis.core.repository.UserRepository;
 import de.tum.cit.aet.artemis.core.security.Role;
+import de.tum.cit.aet.artemis.core.security.allowedTools.AllowedTools;
+import de.tum.cit.aet.artemis.core.security.allowedTools.ToolTokenType;
 import de.tum.cit.aet.artemis.core.security.annotations.EnforceAtLeastEditor;
 import de.tum.cit.aet.artemis.core.security.annotations.EnforceAtLeastInstructor;
+import de.tum.cit.aet.artemis.core.security.annotations.EnforceAtLeastStudent;
 import de.tum.cit.aet.artemis.core.security.annotations.EnforceAtLeastTutor;
 import de.tum.cit.aet.artemis.core.security.annotations.enforceRoleInExercise.EnforceAtLeastTutorInExercise;
 import de.tum.cit.aet.artemis.core.service.AuthorizationCheckService;
@@ -547,6 +551,36 @@ public ResponseEntity<ProgrammingExercise> getProgrammingExerciseWithAuxiliaryRe
         return ResponseEntity.ok(programmingExercise);
     }
 
+    /**
+     * GET /programming-exercises/project-key/:projectKey : Queries a programming exercise by its project key.
+     *
+     *
+     * @param projectKey the project key of the programming exercise
+     *
+     * @return the ProgrammingExercise with this project key in an ResponseEntity or 404 Not Found if no exercise exists. It includes the students participation, submissions,
+     *         results and feedbacks.
+     */
+    @GetMapping("programming-exercises/project-key/{projectKey}")
+    @EnforceAtLeastStudent
+    @AllowedTools(ToolTokenType.SCORPIO)
+    public ResponseEntity<ProgrammingExercise> getExerciseByProjectKey(@PathVariable String projectKey) {
+        User user = userRepository.getUserWithGroupsAndAuthorities();
+
+        final ProgrammingExercise exercise = programmingExerciseRepository.findAllByProjectKey(projectKey).stream().findAny()
+                .orElseThrow(() -> new EntityNotFoundException("ProgrammingExercise", projectKey));
+
+        if (!authCheckService.isAllowedToSeeExercise(exercise, user)) {
+            throw new AccessForbiddenException("You are not allowed to access this exercise");
+        }
+
+        studentParticipationRepository.findByExerciseIdAndStudentIdAndTestRunWithEagerSubmissionsResultsFeedbacksTestCases(exercise.getId(), user.getId(), false)
+                .ifPresent(participation -> {
+                    exercise.setStudentParticipations(Set.of(participation));
+                });
+
+        return ResponseEntity.ok(exercise);
+    }
+
     /**
      * DELETE /programming-exercises/:id : delete the "id" programmingExercise.
      *

src/test/java/de/tum/cit/aet/artemis/programming/ProgrammingExerciseTest.java

@@ -248,6 +248,32 @@ void testFindRelevantParticipations() {
         }
     }
 
+    @Test
+    @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER")
+    void testGetProgrammingExerciseByProjectKey() throws Exception {
+        Course course = programmingExerciseUtilService.addCourseWithOneProgrammingExercise();
+        ProgrammingExercise programmingExercise = (ProgrammingExercise) course.getExercises().stream().findFirst().orElseThrow();
+
+        ProgrammingExercise programmingExerciseByProjectKey = request.get("/api/programming-exercises/project-key/" + programmingExercise.getProjectKey(), HttpStatus.OK,
+                ProgrammingExercise.class);
+        assertThat(programmingExerciseByProjectKey).isEqualTo(programmingExercise);
+        assertThat(programmingExerciseByProjectKey.getStudentParticipations()).isEmpty();
+    }
+
+    @Test
+    @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER")
+    void testGetProgrammingExerciseByProjectKeyWithParticipation() throws Exception {
+        Course course = programmingExerciseUtilService.addCourseWithOneProgrammingExercise();
+        ProgrammingExercise programmingExercise = (ProgrammingExercise) course.getExercises().stream().findFirst().orElseThrow();
+        ProgrammingExerciseStudentParticipation participation = participationUtilService.addStudentParticipationForProgrammingExercise(programmingExercise,
+                TEST_PREFIX + "student1");
+
+        ProgrammingExercise programmingExerciseByProjectKey = request.get("/api/programming-exercises/project-key/" + programmingExercise.getProjectKey(), HttpStatus.OK,
+                ProgrammingExercise.class);
+        assertThat(programmingExerciseByProjectKey).isEqualTo(programmingExercise);
+        assertThat(programmingExerciseByProjectKey.getStudentParticipations().contains(participation)).isTrue();
+    }
+
     @Test
     @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR")
     void testDeleteProgrammingExerciseChannel() throws Exception {