Integrated code lifecycle: Add editing of auxiliary repositories in t…

…he online code editor for instructors (#9585)
ls1intum · Nov 2, 2024 · 7c7b7d4 · 7c7b7d4
1 parent ae9299d
commit 7c7b7d4
Show file tree

Hide file tree

Showing 10 changed files with 231 additions and 73 deletions.
diff --git a/...ain/java/de/tum/cit/aet/artemis/programming/repository/ProgrammingExerciseRepository.java b/...ain/java/de/tum/cit/aet/artemis/programming/repository/ProgrammingExerciseRepository.java
@@ -788,14 +788,17 @@ default ProgrammingExercise saveForCreation(ProgrammingExercise exercise) {
      * @throws EntityNotFoundException the programming exercise could not be found.
      */
     @NotNull
-    default ProgrammingExercise findByIdWithTemplateAndSolutionParticipationLatestResultFeedbackTestCasesElseThrow(long programmingExerciseId) throws EntityNotFoundException {
+    default ProgrammingExercise findByIdWithTemplateAndSolutionParticipationAndAuxiliaryReposAndLatestResultFeedbackTestCasesElseThrow(long programmingExerciseId)
+            throws EntityNotFoundException {
         // TODO: This is a dark hack. Move this into a service where we properly load only the solution participation in the second step
         ProgrammingExercise programmingExerciseWithTemplate = getValueElseThrow(findWithTemplateParticipationLatestResultFeedbackTestCasesById(programmingExerciseId),
                 programmingExerciseId);
         ProgrammingExercise programmingExerciseWithSolution = getValueElseThrow(findWithSolutionParticipationLatestResultFeedbackTestCasesById(programmingExerciseId),
                 programmingExerciseId);
+        ProgrammingExercise programmingExerciseWithAuxiliaryRepositories = findByIdWithAuxiliaryRepositoriesElseThrow(programmingExerciseId);
 
         programmingExerciseWithTemplate.setSolutionParticipation(programmingExerciseWithSolution.getSolutionParticipation());
+        programmingExerciseWithTemplate.setAuxiliaryRepositories(programmingExerciseWithAuxiliaryRepositories.getAuxiliaryRepositories());
 
         return programmingExerciseWithTemplate;
     }

diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/web/ProgrammingExerciseResource.java b/src/main/java/de/tum/cit/aet/artemis/programming/web/ProgrammingExerciseResource.java
@@ -505,7 +505,7 @@ public ResponseEntity<ProgrammingExercise> getProgrammingExercise(@PathVariable
     public ResponseEntity<ProgrammingExercise> getProgrammingExerciseWithSetupParticipations(@PathVariable long exerciseId) {
         log.debug("REST request to get ProgrammingExercise with setup participations : {}", exerciseId);
         User user = userRepository.getUserWithGroupsAndAuthorities();
-        var programmingExercise = programmingExerciseRepository.findByIdWithTemplateAndSolutionParticipationLatestResultFeedbackTestCasesElseThrow(exerciseId);
+        var programmingExercise = programmingExerciseRepository.findByIdWithTemplateAndSolutionParticipationAndAuxiliaryReposAndLatestResultFeedbackTestCasesElseThrow(exerciseId);
         authCheckService.checkHasAtLeastRoleForExerciseElseThrow(Role.EDITOR, programmingExercise, user);
         var assignmentParticipation = studentParticipationRepository.findByExerciseIdAndStudentIdAndTestRunWithLatestResult(programmingExercise.getId(), user.getId(), false);
         Set<StudentParticipation> participations = new HashSet<>();

diff --git a/...programming/manage/code-editor/code-editor-instructor-and-editor-container.component.html b/...programming/manage/code-editor/code-editor-instructor-and-editor-container.component.html
@@ -37,7 +37,9 @@
             />
             <!-- repository select -->
             <div ngbDropdown class="d-inline-block me-2">
-                <button class="btn btn-outline-primary" id="dropdownBasic1" ngbDropdownToggle>{{ selectedRepository }}</button>
+                <button class="btn btn-outline-primary" id="dropdownBasic1" ngbDropdownToggle>
+                    {{ selectedRepository === REPOSITORY.AUXILIARY ? selectedAuxiliaryRepositoryName : selectedRepository }}
+                </button>
                 <div ngbDropdownMenu aria-labelledby="dropdownBasic1">
                     <button
                         [disabled]="!exercise || !exercise.templateParticipation || !exercise.templateParticipation.id || !exercise.templateParticipation.repositoryUri"
@@ -51,7 +53,7 @@
                         [disabled]="!exercise || !exercise.solutionParticipation || !exercise.solutionParticipation.id || !exercise.solutionParticipation.repositoryUri"
                         (click)="selectSolutionParticipation()"
                         ngbDropdownItem
-                        [style.background-color]="selectedRepository === REPOSITORY.SOLUTION ? '#3e8acc' : 'transparent'"
+                        [style.background-color]="selectedRepository === REPOSITORY.SOLUTION ? 'var(--link-color)' : 'transparent'"
                         jhiTranslate="artemisApp.editor.repoSelect.solutionRepo"
                     >
                         <span jhiTranslate="artemisApp.editor.repoSelect.solutionRepo"></span>
@@ -67,7 +69,7 @@
                         "
                         (click)="selectAssignmentParticipation()"
                         ngbDropdownItem
-                        [style.background-color]="selectedRepository === REPOSITORY.ASSIGNMENT ? '#3e8acc' : 'transparent'"
+                        [style.background-color]="selectedRepository === REPOSITORY.ASSIGNMENT ? 'var(--link-color)' : 'transparent'"
                         jhiTranslate="artemisApp.editor.repoSelect.assignmentRepo"
                     >
                         Assignment Participation
@@ -76,9 +78,23 @@
                         [disabled]="!exercise"
                         (click)="selectTestRepository()"
                         ngbDropdownItem
-                        [style.background-color]="selectedRepository === REPOSITORY.TEST ? '#3e8acc' : 'transparent'"
+                        [style.background-color]="selectedRepository === REPOSITORY.TEST ? 'var(--link-color)' : 'transparent'"
                         jhiTranslate="artemisApp.editor.repoSelect.testRepo"
                     ></button>
+                    @for (auxiliaryRepository of exercise.auxiliaryRepositories; track exercise.auxiliaryRepositories; let i = $index) {
+                        @if (auxiliaryRepository.id) {
+                            <button
+                                [disabled]="!exercise"
+                                (click)="selectAuxiliaryRepository(auxiliaryRepository.id)"
+                                ngbDropdownItem
+                                [style.background-color]="
+                                    selectedRepository === REPOSITORY.AUXILIARY && selectedRepositoryId === auxiliaryRepository.id ? 'var(--link-color)' : 'transparent'
+                                "
+                            >
+                                {{ auxiliaryRepository.name }}
+                            </button>
+                        }
+                    }
                 </div>
             </div>
             <!-- action buttons -->

diff --git a/...s/programming/manage/code-editor/code-editor-instructor-and-editor-container.component.ts b/...s/programming/manage/code-editor/code-editor-instructor-and-editor-container.component.ts
@@ -17,6 +17,7 @@ import { IrisSettings } from 'app/entities/iris/settings/iris-settings.model';
 @Component({
     selector: 'jhi-code-editor-instructor',
     templateUrl: './code-editor-instructor-and-editor-container.component.html',
+    styleUrl: 'code-editor-instructor-and-editor-container.scss',
 })
 export class CodeEditorInstructorAndEditorContainerComponent extends CodeEditorInstructorBaseContainerComponent {
     @ViewChild(UpdatingResultComponent, { static: false }) resultComp: UpdatingResultComponent;

diff --git a/...exercises/programming/manage/code-editor/code-editor-instructor-and-editor-container.scss b/...exercises/programming/manage/code-editor/code-editor-instructor-and-editor-container.scss
@@ -0,0 +1,3 @@
+.btn-outline-primary:not(.list-group-item).dropdown-toggle.show {
+    color: var(--default-btn-font);
+}
diff --git a/...ercises/programming/manage/code-editor/code-editor-instructor-base-container.component.ts b/...ercises/programming/manage/code-editor/code-editor-instructor-base-container.component.ts
@@ -28,6 +28,7 @@ export enum REPOSITORY {
     TEMPLATE = 'TEMPLATE',
     SOLUTION = 'SOLUTION',
     TEST = 'TEST',
+    AUXILIARY = 'AUXILIARY',
 }
 
 /**
@@ -64,6 +65,8 @@ export abstract class CodeEditorInstructorBaseContainerComponent implements OnIn
     // Stores which repository is selected atm.
     // Needs to be set additionally to selectedParticipation as the test repository does not have a participation
     selectedRepository: REPOSITORY;
+    selectedRepositoryId: number;
+    selectedAuxiliaryRepositoryName?: string;
 
     // Fires when the selected domain changes.
     // This can either be a participation (solution, template, assignment) or the test repository.
@@ -95,6 +98,7 @@ export abstract class CodeEditorInstructorBaseContainerComponent implements OnIn
         this.paramSub = this.route!.params.subscribe((params) => {
             const exerciseId = Number(params['exerciseId']);
             const participationId = Number(params['participationId']);
+            const repositoryId = Number(params['repositoryId']);
             this.loadingState = LOADING_STATE.INITIALIZING;
             this.loadExercise(exerciseId)
                 .pipe(
@@ -107,6 +111,12 @@ export abstract class CodeEditorInstructorBaseContainerComponent implements OnIn
                     tap(() => {
                         if (this.router.url.endsWith('/test')) {
                             this.saveChangesAndSelectDomain([DomainType.TEST_REPOSITORY, this.exercise]);
+                        } else if (this.router.url.indexOf('auxiliary') >= 0) {
+                            const auxiliaryRepo = this.exercise.auxiliaryRepositories?.find((repo) => repo.id === repositoryId);
+                            if (auxiliaryRepo) {
+                                this.selectedAuxiliaryRepositoryName = auxiliaryRepo.name;
+                                this.saveChangesAndSelectDomain([DomainType.AUXILIARY_REPOSITORY, auxiliaryRepo]);
+                            }
                         } else {
                             const nextAvailableParticipation = this.getNextAvailableParticipation(participationId);
                             if (nextAvailableParticipation) {
@@ -190,7 +200,10 @@ export abstract class CodeEditorInstructorBaseContainerComponent implements OnIn
         if (this.codeEditorContainer != undefined) {
             this.codeEditorContainer.initializeProperties();
         }
-        if (domainType === DomainType.PARTICIPATION) {
+        if (domainType === DomainType.AUXILIARY_REPOSITORY) {
+            this.selectedRepository = REPOSITORY.AUXILIARY;
+            this.selectedRepositoryId = domainValue.id;
+        } else if (domainType === DomainType.PARTICIPATION) {
             this.setSelectedParticipation(domainValue.id);
         } else {
             this.selectedParticipation = this.exercise.templateParticipation!;
@@ -272,28 +285,42 @@ export abstract class CodeEditorInstructorBaseContainerComponent implements OnIn
      * Select the template participation repository and navigate to it
      */
     selectTemplateParticipation() {
-        this.router.navigate(['..', this.exercise.templateParticipation!.id], { relativeTo: this.route });
+        this.router.navigate([this.up(), this.exercise.templateParticipation!.id], { relativeTo: this.route });
     }
 
     /**
      * Select the solution participation repository and navigate to it
      */
     selectSolutionParticipation() {
-        this.router.navigate(['..', this.exercise.solutionParticipation!.id], { relativeTo: this.route });
+        this.router.navigate([this.up(), this.exercise.solutionParticipation!.id], { relativeTo: this.route });
     }
 
     /**
      * Select the assignment participation repository and navigate to it
      */
     selectAssignmentParticipation() {
-        this.router.navigate(['..', this.exercise.studentParticipations![0].id], { relativeTo: this.route });
+        this.router.navigate([this.up(), this.exercise.studentParticipations![0].id], { relativeTo: this.route });
     }
 
     /**
      * Select the test repository and navigate to it
      */
     selectTestRepository() {
-        this.router.navigate(['..', 'test'], { relativeTo: this.route });
+        this.router.navigate([this.up(), 'test'], { relativeTo: this.route });
+    }
+
+    /**
+     * Select the auxiliary repository and navigate to it
+     */
+    selectAuxiliaryRepository(repositoryId: number) {
+        this.router.navigate([this.up(), 'auxiliary', repositoryId], { relativeTo: this.route });
+    }
+
+    /**
+     * Go two folders up if the current view is an auxiliary repository, and one otherwise
+     */
+    up() {
+        return this.selectedRepository === REPOSITORY.AUXILIARY ? '../..' : '..';
     }
 
     /**

diff --git a/...app/app/exercises/programming/manage/code-editor/code-editor-management-routing.module.ts b/...app/app/exercises/programming/manage/code-editor/code-editor-management-routing.module.ts
@@ -54,6 +54,18 @@ const routes: Routes = [
         },
         canActivate: [UserRouteAccessService],
     },
+    {
+        path: 'auxiliary/:repositoryId',
+        component: CodeEditorInstructorAndEditorContainerComponent,
+        data: {
+            authorities: [Authority.EDITOR, Authority.INSTRUCTOR, Authority.ADMIN],
+            pageTitle: 'artemisApp.editor.home.title',
+            flushRepositoryCacheAfter: 900000, // 15 min
+            participationCache: {},
+            repositoryCache: {},
+        },
+        canActivate: [UserRouteAccessService],
+    },
 ];
 
 @NgModule({

diff --git a/src/test/java/de/tum/cit/aet/artemis/programming/ProgrammingExerciseGitIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/programming/ProgrammingExerciseGitIntegrationTest.java
@@ -113,8 +113,8 @@ void testRepositoryMethods() {
         assertThatExceptionOfType(EntityNotFoundException.class)
                 .isThrownBy(() -> programmingExerciseRepository.findByIdWithTemplateAndSolutionParticipationElseThrow(Long.MAX_VALUE));
 
-        assertThatExceptionOfType(EntityNotFoundException.class)
-                .isThrownBy(() -> programmingExerciseRepository.findByIdWithTemplateAndSolutionParticipationLatestResultFeedbackTestCasesElseThrow(Long.MAX_VALUE));
+        assertThatExceptionOfType(EntityNotFoundException.class).isThrownBy(
+                () -> programmingExerciseRepository.findByIdWithTemplateAndSolutionParticipationAndAuxiliaryReposAndLatestResultFeedbackTestCasesElseThrow(Long.MAX_VALUE));
 
         assertThatExceptionOfType(EntityNotFoundException.class)
                 .isThrownBy(() -> programmingExerciseRepository.findByIdWithTemplateAndSolutionParticipationTeamAssignmentConfigCategoriesElseThrow(Long.MAX_VALUE));

diff --git a/src/test/java/de/tum/cit/aet/artemis/programming/ProgrammingExerciseGradingServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/programming/ProgrammingExerciseGradingServiceTest.java
@@ -551,7 +551,8 @@ void shouldReEvaluateScoreOfTheCorrectResults() throws Exception {
         programmingExercise = (ProgrammingExercise) exerciseUtilService.addMaxScoreAndBonusPointsToExercise(programmingExercise);
         programmingExercise = programmingExerciseUtilService.addTemplateParticipationForProgrammingExercise(programmingExercise);
         programmingExercise = programmingExerciseUtilService.addSolutionParticipationForProgrammingExercise(programmingExercise);
-        programmingExercise = programmingExerciseRepository.findByIdWithTemplateAndSolutionParticipationLatestResultFeedbackTestCasesElseThrow(programmingExercise.getId());
+        programmingExercise = programmingExerciseRepository
+                .findByIdWithTemplateAndSolutionParticipationAndAuxiliaryReposAndLatestResultFeedbackTestCasesElseThrow(programmingExercise.getId());
 
         var testCases = createTestCases(false);
         var testParticipations = createTestParticipations();
@@ -566,7 +567,8 @@ void shouldReEvaluateScoreOfTheCorrectResults() throws Exception {
         SecurityContextHolder.setContext(TestSecurityContextHolder.getContext());
 
         // Tests
-        programmingExercise = programmingExerciseRepository.findByIdWithTemplateAndSolutionParticipationLatestResultFeedbackTestCasesElseThrow(programmingExercise.getId());
+        programmingExercise = programmingExerciseRepository
+                .findByIdWithTemplateAndSolutionParticipationAndAuxiliaryReposAndLatestResultFeedbackTestCasesElseThrow(programmingExercise.getId());
 
         // template 0 %
         {
@@ -610,7 +612,8 @@ void shouldNotIncludeTestsMarkedAsNeverVisibleInScoreCalculation(boolean isAfter
         programmingExercise = (ProgrammingExercise) exerciseUtilService.addMaxScoreAndBonusPointsToExercise(programmingExercise);
         programmingExercise = programmingExerciseUtilService.addTemplateParticipationForProgrammingExercise(programmingExercise);
         programmingExercise = programmingExerciseUtilService.addSolutionParticipationForProgrammingExercise(programmingExercise);
-        programmingExercise = programmingExerciseRepository.findByIdWithTemplateAndSolutionParticipationLatestResultFeedbackTestCasesElseThrow(programmingExercise.getId());
+        programmingExercise = programmingExerciseRepository
+                .findByIdWithTemplateAndSolutionParticipationAndAuxiliaryReposAndLatestResultFeedbackTestCasesElseThrow(programmingExercise.getId());
 
         final var testCases = createTestCases(true);
         final var testParticipations = createTestParticipations();
@@ -625,7 +628,8 @@ void shouldNotIncludeTestsMarkedAsNeverVisibleInScoreCalculation(boolean isAfter
         SecurityContextHolder.setContext(TestSecurityContextHolder.getContext());
 
         // Tests
-        programmingExercise = programmingExerciseRepository.findByIdWithTemplateAndSolutionParticipationLatestResultFeedbackTestCasesElseThrow(programmingExercise.getId());
+        programmingExercise = programmingExerciseRepository
+                .findByIdWithTemplateAndSolutionParticipationAndAuxiliaryReposAndLatestResultFeedbackTestCasesElseThrow(programmingExercise.getId());
 
         // the invisible test case should however be visible for the template and solution repos
 
@@ -658,7 +662,8 @@ void shouldUpdateTheLatestResultOfASingleParticipation() {
         programmingExercise = (ProgrammingExercise) exerciseUtilService.addMaxScoreAndBonusPointsToExercise(programmingExercise);
         programmingExercise = programmingExerciseUtilService.addTemplateParticipationForProgrammingExercise(programmingExercise);
         programmingExercise = programmingExerciseUtilService.addSolutionParticipationForProgrammingExercise(programmingExercise);
-        programmingExercise = programmingExerciseRepository.findByIdWithTemplateAndSolutionParticipationLatestResultFeedbackTestCasesElseThrow(programmingExercise.getId());
+        programmingExercise = programmingExerciseRepository
+                .findByIdWithTemplateAndSolutionParticipationAndAuxiliaryReposAndLatestResultFeedbackTestCasesElseThrow(programmingExercise.getId());
 
         final var testCases = createTestCases(false);
         final var testParticipations = createTestParticipations();
@@ -679,7 +684,8 @@ void shouldUpdateOnlyResultsForParticipationsWithoutIndividualDueDate() {
         programmingExercise = (ProgrammingExercise) exerciseUtilService.addMaxScoreAndBonusPointsToExercise(programmingExercise);
         programmingExercise = programmingExerciseUtilService.addTemplateParticipationForProgrammingExercise(programmingExercise);
         programmingExercise = programmingExerciseUtilService.addSolutionParticipationForProgrammingExercise(programmingExercise);
-        programmingExercise = programmingExerciseRepository.findByIdWithTemplateAndSolutionParticipationLatestResultFeedbackTestCasesElseThrow(programmingExercise.getId());
+        programmingExercise = programmingExerciseRepository
+                .findByIdWithTemplateAndSolutionParticipationAndAuxiliaryReposAndLatestResultFeedbackTestCasesElseThrow(programmingExercise.getId());
 
         final var testCases = createTestCases(false);
         final var testParticipations = createTestParticipations();
@@ -690,7 +696,8 @@ void shouldUpdateOnlyResultsForParticipationsWithoutIndividualDueDate() {
         participationWithIndividualDueDate = studentParticipationRepository.save((StudentParticipation) participationWithIndividualDueDate);
         final Long participationWithIndividualDueDateId = participationWithIndividualDueDate.getId();
 
-        programmingExercise = programmingExerciseRepository.findByIdWithTemplateAndSolutionParticipationLatestResultFeedbackTestCasesElseThrow(programmingExercise.getId());
+        programmingExercise = programmingExerciseRepository
+                .findByIdWithTemplateAndSolutionParticipationAndAuxiliaryReposAndLatestResultFeedbackTestCasesElseThrow(programmingExercise.getId());
 
         final var updated = programmingExerciseGradingService.updateResultsOnlyRegularDueDateParticipations(programmingExercise);
         // four student results + template + solution
@@ -706,7 +713,8 @@ void testWeightSumZero() {
         programmingExercise = (ProgrammingExercise) exerciseUtilService.addMaxScoreAndBonusPointsToExercise(programmingExercise);
         programmingExercise = programmingExerciseUtilService.addTemplateParticipationForProgrammingExercise(programmingExercise);
         programmingExercise = programmingExerciseUtilService.addSolutionParticipationForProgrammingExercise(programmingExercise);
-        programmingExercise = programmingExerciseRepository.findByIdWithTemplateAndSolutionParticipationLatestResultFeedbackTestCasesElseThrow(programmingExercise.getId());
+        programmingExercise = programmingExerciseRepository
+                .findByIdWithTemplateAndSolutionParticipationAndAuxiliaryReposAndLatestResultFeedbackTestCasesElseThrow(programmingExercise.getId());
 
         final var testCases = createTestCases(false);
         createTestParticipations();