Programming exercises: Avoid unnecessary not authorized alert for instructors when using edit in editor

Author: krusche

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

@@ -2,7 +2,6 @@
 
 import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE;
 
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
@@ -406,18 +405,17 @@ public ResponseEntity<RepositoryStatusDTO> getStatus(@PathVariable Long particip
     }
 
     /**
-     * GET /repository/:participationId/buildlogs : get the build log for the "participationId" repository.
+     * GET /participations/:participationId/buildlogs : get the build log for the "participationId" repository.
      *
      * @param participationId to identify the repository with.
      * @param resultId        an optional result ID to get the build logs for the submission that the result belongs to. If the result ID is not specified, the latest submission is
      *                            used.
      * @return the ResponseEntity with status 200 (OK) and with body the result, or with status 404 (Not Found)
      */
-    // TODO: rename to participation/{participationId}/buildlogs
-    @GetMapping(value = "repository/{participationId}/buildlogs", produces = MediaType.APPLICATION_JSON_VALUE)
+    @GetMapping(value = "participations/{participationId}/buildlogs", produces = MediaType.APPLICATION_JSON_VALUE)
     @EnforceAtLeastStudent
     public ResponseEntity<List<BuildLogEntry>> getBuildLogs(@PathVariable Long participationId, @RequestParam(name = "resultId") Optional<Long> resultId) {
-        log.debug("REST request to get build log : {}", participationId);
+        log.debug("REST request to get build logs for participation {}", participationId);
 
         ProgrammingExerciseParticipation participation = participationService.findProgrammingExerciseParticipationWithLatestSubmissionAndResult(participationId);
         participationAuthCheckService.checkCanAccessParticipationElseThrow(participation);
@@ -436,16 +434,16 @@ public ResponseEntity<List<BuildLogEntry>> getBuildLogs(@PathVariable Long parti
         }
         else if (programmingSubmission == null) {
             // Can't return build logs if a submission doesn't exist yet
-            return ResponseEntity.ok(new ArrayList<>());
+            return ResponseEntity.ok(List.of());
         }
 
-        // Do not return build logs if the build hasn't failed
+        // Empty build logs are returned if the submission is not build failed
         if (!programmingSubmission.isBuildFailed()) {
-            throw new AccessForbiddenException("Build logs cannot be retrieved when the build hasn't failed!");
+            return ResponseEntity.ok(List.of());
         }
 
         // Load the logs from the database
         List<BuildLogEntry> buildLogs = buildLogService.getLatestBuildLogs(programmingSubmission);
-        return new ResponseEntity<>(buildLogs, HttpStatus.OK);
+        return ResponseEntity.ok(buildLogs);
     }
 }

src/main/webapp/app/programming/shared/services/build-log.service.spec.ts

@@ -8,7 +8,7 @@ describe('Build Log Service', () => {
     let service: BuildLogService;
     let httpMock: HttpTestingController;
 
-    const resourceUrl = 'api/programming/repository/42/buildlogs';
+    const resourceUrl = 'api/programming/participations/42/buildlogs';
 
     beforeEach(() => {
         TestBed.configureTestingModule({

src/main/webapp/app/programming/shared/services/build-log.service.ts

@@ -11,7 +11,7 @@ export interface IBuildLogService {
 export class BuildLogService implements IBuildLogService {
     private http = inject(HttpClient);
 
-    private assignmentResourceUrl = 'api/programming/repository';
+    private participationsResourceUrl = 'api/programming/participations';
 
     /**
      * Retrieves the build logs for a given participation and optionally, a given result.
@@ -23,6 +23,6 @@ export class BuildLogService implements IBuildLogService {
         if (resultId) {
             params = params.set('resultId', resultId);
         }
-        return this.http.get<BuildLogEntry[]>(`${this.assignmentResourceUrl}/${participationId}/buildlogs`, { params });
+        return this.http.get<BuildLogEntry[]>(`${this.participationsResourceUrl}/${participationId}/buildlogs`, { params });
     }
 }

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

@@ -195,7 +195,7 @@ private Result assertBuildError(Long participationId, String userLogin) throws E
 
         userUtilService.changeUser(userLogin);
         // Assert that the build logs can be retrieved from the REST API from the database
-        var receivedLogs = request.get("/api/programming/repository/" + participationId + "/buildlogs", HttpStatus.OK, List.class);
+        var receivedLogs = request.get("/api/programming/participations/" + participationId + "/buildlogs", HttpStatus.OK, List.class);
         assertThat(receivedLogs).isNotNull().isNotEmpty();
 
         return result;

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

@@ -118,6 +118,8 @@ class RepositoryIntegrationTest extends AbstractProgrammingIntegrationLocalCILoc
 
     private final String studentRepoBaseUrl = "/api/programming/repository/";
 
+    private final String participationsBaseUrl = "/api/programming/participations/";
+
     private final String filesContentBaseUrl = "/api/programming/repository-files-content/";
 
     private ProgrammingExercise programmingExercise;
@@ -942,15 +944,16 @@ void testGetStatus() throws Exception {
     @Test
     @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER")
     void testBuildLogsNoSubmission() throws Exception {
-        var receivedLogs = request.get(studentRepoBaseUrl + participation.getId() + "/buildlogs", HttpStatus.OK, List.class);
+        var receivedLogs = request.get(participationsBaseUrl + participation.getId() + "/buildlogs", HttpStatus.OK, List.class);
         assertThat(receivedLogs).isNotNull().isEmpty();
     }
 
     @Test
     @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER")
     void testBuildLogsWithSubmissionBuildSuccessful() throws Exception {
         programmingExerciseUtilService.createProgrammingSubmission(participation, false);
-        request.get(studentRepoBaseUrl + participation.getId() + "/buildlogs", HttpStatus.FORBIDDEN, List.class);
+        var buildLogs = request.get(participationsBaseUrl + participation.getId() + "/buildlogs", HttpStatus.OK, List.class);
+        assertThat(buildLogs).isEmpty();
     }
 
     @Test
@@ -960,7 +963,7 @@ void testBuildLogsWithManualResult() throws Exception {
         var buildLogEntries = buildLogEntryService.saveBuildLogs(logs, submission);
         submission.setBuildLogEntries(buildLogEntries);
         participationUtilService.addResultToSubmission(submission, AssessmentType.SEMI_AUTOMATIC);
-        var receivedLogs = request.getList(studentRepoBaseUrl + participation.getId() + "/buildlogs", HttpStatus.OK, BuildLogEntry.class);
+        var receivedLogs = request.getList(participationsBaseUrl + participation.getId() + "/buildlogs", HttpStatus.OK, BuildLogEntry.class);
         assertThat(receivedLogs).hasSize(2);
         assertLogsContent(receivedLogs);
     }
@@ -972,7 +975,7 @@ void testBuildLogs() throws Exception {
         var buildLogEntries = buildLogEntryService.saveBuildLogs(logs, submission);
         submission.setBuildLogEntries(buildLogEntries);
         participationUtilService.addResultToSubmission(submission, AssessmentType.AUTOMATIC);
-        var receivedLogs = request.getList(studentRepoBaseUrl + participation.getId() + "/buildlogs", HttpStatus.OK, BuildLogEntry.class);
+        var receivedLogs = request.getList(participationsBaseUrl + participation.getId() + "/buildlogs", HttpStatus.OK, BuildLogEntry.class);
         assertThat(receivedLogs).hasSize(2);
         assertLogsContent(receivedLogs);
     }
@@ -981,7 +984,7 @@ void testBuildLogs() throws Exception {
     @WithMockUser(username = TEST_PREFIX + "student2", roles = "USER")
     void testGetBuildLogs_cannotAccessParticipation() throws Exception {
         // student2 should not have access to student1's participation.
-        request.getList(studentRepoBaseUrl + participation.getId() + "/buildlogs", HttpStatus.FORBIDDEN, BuildLogEntry.class);
+        request.getList(participationsBaseUrl + participation.getId() + "/buildlogs", HttpStatus.FORBIDDEN, BuildLogEntry.class);
     }
 
     private void assertLogsContent(List<BuildLogEntry> receivedLogs) {
@@ -1012,7 +1015,7 @@ void testBuildLogsFromDatabase() throws Exception {
         submission.setBuildLogEntries(buildLogEntries);
         programmingExerciseUtilService.addProgrammingSubmission(programmingExercise, submission, TEST_PREFIX + "student1");
 
-        var receivedLogs = request.getList(studentRepoBaseUrl + participation.getId() + "/buildlogs", HttpStatus.OK, BuildLogEntry.class);
+        var receivedLogs = request.getList(participationsBaseUrl + participation.getId() + "/buildlogs", HttpStatus.OK, BuildLogEntry.class);
         assertThat(receivedLogs).hasSize(3).isEqualTo(buildLogEntries);
     }
 
@@ -1052,17 +1055,17 @@ void testBuildLogsFromDatabaseForSpecificResults() throws Exception {
         var result2 = participationUtilService.addResultToSubmission(submission2, AssessmentType.AUTOMATIC).getFirstResult();
 
         // Specify to use result1
-        var receivedLogs1 = request.getList(studentRepoBaseUrl + participation.getId() + "/buildlogs", HttpStatus.OK, BuildLogEntry.class,
+        var receivedLogs1 = request.getList(participationsBaseUrl + participation.getId() + "/buildlogs", HttpStatus.OK, BuildLogEntry.class,
                 parameters(Map.of("resultId", result1.getId())));
         assertThat(receivedLogs1).isEqualTo(submission1Logs);
 
         // Specify to use result2
-        var receivedLogs2 = request.getList(studentRepoBaseUrl + participation.getId() + "/buildlogs", HttpStatus.OK, BuildLogEntry.class,
+        var receivedLogs2 = request.getList(participationsBaseUrl + participation.getId() + "/buildlogs", HttpStatus.OK, BuildLogEntry.class,
                 parameters(Map.of("resultId", result2.getId())));
         assertThat(receivedLogs2).isEqualTo(submission2Logs);
 
         // Without parameters, the latest submission must be used
-        var receivedLogsLatest = request.getList(studentRepoBaseUrl + participation.getId() + "/buildlogs", HttpStatus.OK, BuildLogEntry.class);
+        var receivedLogsLatest = request.getList(participationsBaseUrl + participation.getId() + "/buildlogs", HttpStatus.OK, BuildLogEntry.class);
         assertThat(receivedLogsLatest).isEqualTo(submission2Logs);
     }
 
@@ -1072,7 +1075,7 @@ void testBuildLogsFromDatabaseForSpecificResults_otherParticipation() throws Exc
         var result = participationUtilService.addProgrammingParticipationWithResultForExercise(programmingExercise, TEST_PREFIX + "tutor1");
         programmingExerciseUtilService.addProgrammingSubmissionToResultAndParticipation(result, (StudentParticipation) result.getSubmission().getParticipation(), "xyz");
 
-        request.getList(studentRepoBaseUrl + participation.getId() + "/buildlogs", HttpStatus.FORBIDDEN, BuildLogEntry.class, parameters(Map.of("resultId", result.getId())));
+        request.getList(participationsBaseUrl + participation.getId() + "/buildlogs", HttpStatus.FORBIDDEN, BuildLogEntry.class, parameters(Map.of("resultId", result.getId())));
     }
 
     @Disabled

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

@@ -63,7 +63,7 @@ void testGetLatestBuildLogsFails() throws Exception {
         jenkinsRequestMockProvider.mockGetJob(programmingExercise.getProjectKey(), buildPlanId, jobWithDetails, false);
         jenkinsRequestMockProvider.mockGetBuildStatus(programmingExercise.getProjectKey(), buildPlanId, true, true, false, true);
 
-        var url = "/api/programming/repository/" + programmingExerciseParticipation.getId() + "/buildlogs";
+        var url = "/api/programming/participations/" + programmingExerciseParticipation.getId() + "/buildlogs";
         var buildLogs = request.getList(url, HttpStatus.OK, BuildLogEntry.class);
         assertThat(buildLogs).hasSize(3);
     }