Development: Theia integration test

src/main/java/de/tum/cit/aet/artemis/programming/domain/ProgrammingExerciseBuildConfig.java

@@ -25,6 +25,7 @@
 @Entity
 @Table(name = "programming_exercise_build_config")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
+@JsonIgnoreProperties(value = { "programmingExercise" })
 public class ProgrammingExerciseBuildConfig extends DomainObject {
 
     private static final Logger log = LoggerFactory.getLogger(ProgrammingExerciseBuildConfig.class);
@@ -64,7 +65,6 @@ public class ProgrammingExerciseBuildConfig extends DomainObject {
     private String dockerFlags;
 
     @OneToOne(mappedBy = "buildConfig")
-    @JsonIgnoreProperties("buildConfig")
     private ProgrammingExercise programmingExercise;
 
     @Nullable

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

@@ -35,4 +35,14 @@ default void generateBuildPlanAccessSecretIfNotExists(ProgrammingExerciseBuildCo
     default void loadAndSetBuildConfig(ProgrammingExercise programmingExercise) {
         programmingExercise.setBuildConfig(getProgrammingExerciseBuildConfigElseThrow(programmingExercise));
     }
+
+    /**
+     * Find a build config by its programming exercise's id and throw an Exception if it cannot be found
+     *
+     * @param programmingExerciseId of the programming exercise.
+     * @return The programming exercise related to the given id
+     */
+    default ProgrammingExerciseBuildConfig findByExerciseIdElseThrow(long programmingExerciseId) {
+        return getValueElseThrow(findByProgrammingExerciseId(programmingExerciseId));
+    }
 }

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

@@ -149,6 +149,25 @@ default ProgrammingExercise findOneByProjectKeyOrThrow(String projectKey, boolea
         return exercises.getFirst();
     }
 
+    /**
+     * Get a programmingExercise for a student, with the latest result and feedbacks.
+     *
+     * @param projectKey of the exercise that should be fetched.
+     * @return the exercise with the given ID, if found.
+     */
+    @Query("""
+            SELECT DISTINCT pe
+            FROM ProgrammingExercise pe
+                LEFT JOIN FETCH pe.studentParticipations sp
+                LEFT JOIN FETCH sp.results spr
+                LEFT JOIN FETCH spr.feedbacks sf
+                LEFT JOIN FETCH sf.testCase
+            WHERE pe.projectKey = :projectKey
+                AND (spr.id = (SELECT MAX(re2.id) FROM sp.results re2) OR spr.id IS NULL)
+                AND (sp.student.id IS NULL OR sp.student.id = :studentId)
+            """)
+    Optional<ProgrammingExercise> findWithStudentParticipationLatestResultFeedbackTestCasesByProjectKey(@Param("studentId") long studentId, @Param("projectKey") String projectKey);
+
     /**
      * Get a programmingExercise with template participation, each with the latest result and feedbacks.
      * NOTICE: this query is quite expensive because it loads all feedback and test cases, and it includes sub queries to retrieve the latest result

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

@@ -55,9 +55,13 @@
 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.EnforceAtLeastStudentInExercise;
 import de.tum.cit.aet.artemis.core.security.annotations.enforceRoleInExercise.EnforceAtLeastTutorInExercise;
 import de.tum.cit.aet.artemis.core.service.AuthorizationCheckService;
 import de.tum.cit.aet.artemis.core.service.CourseService;
@@ -71,13 +75,15 @@
 import de.tum.cit.aet.artemis.plagiarism.service.PlagiarismDetectionConfigHelper;
 import de.tum.cit.aet.artemis.programming.domain.AuxiliaryRepository;
 import de.tum.cit.aet.artemis.programming.domain.ProgrammingExercise;
+import de.tum.cit.aet.artemis.programming.domain.ProgrammingExerciseBuildConfig;
 import de.tum.cit.aet.artemis.programming.domain.ProgrammingExerciseTestCase;
 import de.tum.cit.aet.artemis.programming.domain.ProgrammingLanguage;
 import de.tum.cit.aet.artemis.programming.dto.BuildLogStatisticsDTO;
 import de.tum.cit.aet.artemis.programming.dto.CheckoutDirectoriesDTO;
 import de.tum.cit.aet.artemis.programming.dto.ProgrammingExerciseResetOptionsDTO;
 import de.tum.cit.aet.artemis.programming.dto.ProgrammingExerciseTestCaseStateDTO;
 import de.tum.cit.aet.artemis.programming.repository.BuildLogStatisticsEntryRepository;
+import de.tum.cit.aet.artemis.programming.repository.ProgrammingExerciseBuildConfigRepository;
 import de.tum.cit.aet.artemis.programming.repository.ProgrammingExerciseRepository;
 import de.tum.cit.aet.artemis.programming.repository.ProgrammingExerciseTestCaseRepository;
 import de.tum.cit.aet.artemis.programming.repository.SolutionProgrammingExerciseParticipationRepository;
@@ -114,6 +120,8 @@ public class ProgrammingExerciseResource {
 
     private final ProgrammingExerciseTestCaseRepository programmingExerciseTestCaseRepository;
 
+    private final ProgrammingExerciseBuildConfigRepository programmingExerciseBuildConfigRepository;
+
     private final UserRepository userRepository;
 
     private final CourseService courseService;
@@ -157,9 +165,9 @@ public class ProgrammingExerciseResource {
     private final Environment environment;
 
     public ProgrammingExerciseResource(ProgrammingExerciseRepository programmingExerciseRepository, ProgrammingExerciseTestCaseRepository programmingExerciseTestCaseRepository,
-            UserRepository userRepository, AuthorizationCheckService authCheckService, CourseService courseService,
-            Optional<ContinuousIntegrationService> continuousIntegrationService, Optional<VersionControlService> versionControlService, ExerciseService exerciseService,
-            ExerciseDeletionService exerciseDeletionService, ProgrammingExerciseService programmingExerciseService,
+            ProgrammingExerciseBuildConfigRepository programmingExerciseBuildConfigRepository, UserRepository userRepository, AuthorizationCheckService authCheckService,
+            CourseService courseService, Optional<ContinuousIntegrationService> continuousIntegrationService, Optional<VersionControlService> versionControlService,
+            ExerciseService exerciseService, ExerciseDeletionService exerciseDeletionService, ProgrammingExerciseService programmingExerciseService,
             ProgrammingExerciseRepositoryService programmingExerciseRepositoryService, ProgrammingExerciseTaskService programmingExerciseTaskService,
             StudentParticipationRepository studentParticipationRepository, StaticCodeAnalysisService staticCodeAnalysisService,
             GradingCriterionRepository gradingCriterionRepository, CourseRepository courseRepository, GitService gitService, AuxiliaryRepositoryService auxiliaryRepositoryService,
@@ -170,6 +178,7 @@ public ProgrammingExerciseResource(ProgrammingExerciseRepository programmingExer
         this.programmingExerciseTaskService = programmingExerciseTaskService;
         this.programmingExerciseRepository = programmingExerciseRepository;
         this.programmingExerciseTestCaseRepository = programmingExerciseTestCaseRepository;
+        this.programmingExerciseBuildConfigRepository = programmingExerciseBuildConfigRepository;
         this.userRepository = userRepository;
         this.courseService = courseService;
         this.authCheckService = authCheckService;
@@ -493,6 +502,21 @@ public ResponseEntity<ProgrammingExercise> getProgrammingExercise(@PathVariable
         return ResponseEntity.ok().body(programmingExercise);
     }
 
+    /**
+     * GET /programming-exercises/:exerciseId/build-config : get the build config of "exerciseId" programmingExercise.
+     *
+     * @param exerciseId the id of the programmingExercise to retrieve the config for
+     * @return the ResponseEntity with status 200 (OK) and with body the programmingExerciseBuildConfig, or with status 404 (Not Found)
+     */
+    @GetMapping("programming-exercises/{exerciseId}/build-config")
+    @EnforceAtLeastStudentInExercise
+    public ResponseEntity<ProgrammingExerciseBuildConfig> getBuildConfig(@PathVariable long exerciseId) {
+        log.debug("REST request to get build config of ProgrammingExercise : {}", exerciseId);
+        var buildConfig = programmingExerciseBuildConfigRepository.findByExerciseIdElseThrow(exerciseId);
+
+        return ResponseEntity.ok().body(buildConfig);
+    }
+
     /**
      * GET /programming-exercises/:exerciseId/with-participations/ : get the "exerciseId" programmingExercise.
      *
@@ -547,6 +571,26 @@ public ResponseEntity<ProgrammingExercise> getProgrammingExerciseWithAuxiliaryRe
         return ResponseEntity.ok(programmingExercise);
     }
 
+    /**
+     * GET /programming-exercises : Queries a programming exercise by its project key.
+     *
+     *
+     * @param projectKey the project key of the programming exercise
+     *
+     * @return the ProgrammingExercise of this project key in an ResponseEntity or 404 Not Found if no exercise exists
+     */
+    @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.findWithStudentParticipationLatestResultFeedbackTestCasesByProjectKey(user.getId(), projectKey)
+                .orElseThrow(() -> new EntityNotFoundException("ProgrammingExercise", projectKey));
+
+        return ResponseEntity.ok(exercise);
+    }
+
     /**
      * DELETE /programming-exercises/:id : delete the "id" programmingExercise.
      *

src/main/resources/config/application-dev.yml

@@ -131,15 +131,15 @@ eureka:
 
 # Theia configuration
 theia:
-    portal-url: https://theia-test.k8s.ase.cit.tum.de
+    portal-url: https://theia.artemis.cit.tum.de
 
     images:
         java:
-            Java-17: "ghcr.io/ls1intum/theia/java-17:latest"
-            Java-Test: "ghcr.io/ls1intum/theia/java-test:latest"
-            Java-Test2: "ghcr.io/ls1intum/theia/java-test:2"
+            Java-17: "java-17-latest"
+            Java-Test: "java-17-latest"
+            Java-Test2: "java-17-latest"
         c:
-            C: "ghcr.io/ls1intum/theia/c:latest"
+            C: "c-latest"
 
 artemis:
     push-notification-relay: https://hermes-sandbox.artemis.cit.tum.de

src/main/resources/config/application-theia.yml

@@ -6,8 +6,8 @@ theia:
         # Upper level key is the language category (must match the language key in the programming-exercise configuration)
         java:
             # Lower level key can be multiple flavors of the image, e.g. version, tag, or additional dependencies
-            Java-17: "my-registry/my-image:my-tag"
+            java17: "my-kubernetes-appdefinition"
             # Add more flavors here (e.g. Java-11, Java-8, etc.)
         # Add more languages here (e.g. c, python, etc.)
         c:
-            C: "my-registry/my-image:my-tag"
+            C: "my-kubernetes-appdefinition"

src/main/webapp/app/core/auth/account.service.ts

@@ -362,4 +362,12 @@ export class AccountService implements IAccountService {
         const params = new HttpParams().set('participationId', participationId);
         return this.http.put<string>('api/account/participation-vcs-access-token', null, { observe: 'response', params, responseType: 'text' as 'json' });
     }
+
+    /**
+     * Trades the current cookie for a new Tool-specific bearer token which is able to authenticate the user.
+     * The Cookie stays valid, a new bearer token is generated on every call with a validity of max 1d.
+     */
+    getToolToken(tool: string): Observable<string> {
+        return this.http.post<string>('api/tool-token', null, { params: { tool: tool }, responseType: 'text' as 'json' });
+    }
 }

src/main/webapp/app/exercises/programming/manage/services/programming-exercise.service.ts

@@ -22,6 +22,7 @@ import { Participation } from 'app/entities/participation/participation.model';
 import { PlagiarismResultDTO } from 'app/exercises/shared/plagiarism/types/PlagiarismResultDTO';
 import { ImportOptions } from 'app/types/programming-exercises';
 import { CheckoutDirectoriesDto } from 'app/entities/programming/checkout-directories-dto';
+import { ProgrammingExerciseBuildConfig } from 'app/entities/programming/programming-exercise-build.config';
 
 export type EntityResponseType = HttpResponse<ProgrammingExercise>;
 export type EntityArrayResponseType = HttpResponse<ProgrammingExercise[]>;
@@ -624,6 +625,10 @@ export class ProgrammingExerciseService {
         return this.http.get<BuildLogStatisticsDTO>(`${this.resourceUrl}/${exerciseId}/build-log-statistics`);
     }
 
+    getBuildConfig(exerciseId: number): Observable<ProgrammingExerciseBuildConfig> {
+        return this.http.get<ProgrammingExerciseBuildConfig>(`${this.resourceUrl}/${exerciseId}/build-config`);
+    }
+
     /** Imports a programming exercise from a given zip file **/
     importFromFile(exercise: ProgrammingExercise, courseId: number): Observable<EntityResponseType> {
         let copy = this.convertDataFromClient(exercise);

src/main/webapp/app/overview/exercise-details/exercise-details-student-actions.component.html

@@ -132,12 +132,6 @@
                             [useParticipationVcsAccessToken]="true"
                         />
                     }
-                    @if (theiaEnabled) {
-                        <a class="btn btn-primary" [class.btn-sm]="smallButtons" (click)="startOnlineIDE()" target="_blank" rel="noopener noreferrer">
-                            <fa-icon [icon]="faDesktop" [fixedWidth]="true" />
-                            <span class="d-none d-md-inline" jhiTranslate="artemisApp.exerciseActions.openOnlineIDE"></span>
-                        </a>
-                    }
                     @if (exercise.allowFeedbackRequests && gradedParticipation && exercise.type === ExerciseType.PROGRAMMING) {
                         <jhi-request-feedback-button [exercise]="exercise" [smallButtons]="smallButtons" />
                     }

src/main/webapp/app/overview/exercise-details/exercise-details-student-actions.component.ts

@@ -11,13 +11,13 @@ import { ProgrammingExercise } from 'app/entities/programming/programming-exerci
 import { StudentParticipation } from 'app/entities/participation/student-participation.model';
 import { ArtemisQuizService } from 'app/shared/quiz/quiz.service';
 import { finalize } from 'rxjs/operators';
-import { faDesktop, faEye, faFolderOpen, faPlayCircle, faRedo, faUsers } from '@fortawesome/free-solid-svg-icons';
+import { faEye, faFolderOpen, faPlayCircle, faRedo, faUsers } from '@fortawesome/free-solid-svg-icons';
 import { CourseExerciseService } from 'app/exercises/shared/course-exercises/course-exercise.service';
 import { ParticipationService } from 'app/exercises/shared/participation/participation.service';
 import dayjs from 'dayjs/esm';
 import { QuizExercise } from 'app/entities/quiz/quiz-exercise.model';
 import { ProfileService } from 'app/shared/layouts/profiles/profile.service';
-import { PROFILE_ATHENA, PROFILE_LOCALVC, PROFILE_THEIA } from 'app/app.constants';
+import { PROFILE_ATHENA, PROFILE_LOCALVC } from 'app/app.constants';
 import { AssessmentType } from 'app/entities/assessment-type.model';
 import { ButtonType } from 'app/shared/components/button.component';
 import { NgTemplateOutlet } from '@angular/common';
@@ -51,8 +51,8 @@ import { ArtemisTranslatePipe } from 'app/shared/pipes/artemis-translate.pipe';
     ],
     providers: [ExternalCloningService],
     selector: 'jhi-exercise-details-student-actions',
-    styleUrls: ['../course-overview.scss'],
     templateUrl: './exercise-details-student-actions.component.html',
+    styleUrls: ['../course-overview.scss'],
 })
 export class ExerciseDetailsStudentActionsComponent implements OnInit, OnChanges {
     private alertService = inject(AlertService);
@@ -95,16 +95,12 @@ export class ExerciseDetailsStudentActionsComponent implements OnInit, OnChanges
     routerLink: string;
     repositoryLink: string;
 
-    theiaEnabled = false;
-    theiaPortalURL: string;
-
     // Icons
     readonly faFolderOpen = faFolderOpen;
     readonly faUsers = faUsers;
     readonly faEye = faEye;
     readonly faPlayCircle = faPlayCircle;
     readonly faRedo = faRedo;
-    readonly faDesktop = faDesktop;
 
     ngOnInit(): void {
         this.repositoryLink = this.router.url;
@@ -132,29 +128,6 @@ export class ExerciseDetailsStudentActionsComponent implements OnInit, OnChanges
             this.profileService.getProfileInfo().subscribe((profileInfo) => {
                 this.localVCEnabled = profileInfo.activeProfiles?.includes(PROFILE_LOCALVC);
                 this.athenaEnabled = profileInfo.activeProfiles?.includes(PROFILE_ATHENA);
-
-                // The online IDE is only available with correct SpringProfile and if it's enabled for this exercise
-                if (profileInfo.activeProfiles?.includes(PROFILE_THEIA) && this.programmingExercise) {
-                    this.theiaEnabled = true;
-
-                    // Set variables now, sanitize later on
-                    this.theiaPortalURL = profileInfo.theiaPortalURL ?? '';
-
-                    // Verify that Theia's portal URL is set
-                    if (this.theiaPortalURL === '') {
-                        this.theiaEnabled = false;
-                    }
-
-                    // Verify that the exercise allows the online IDE
-                    if (!this.programmingExercise.allowOnlineIde) {
-                        this.theiaEnabled = false;
-                    }
-
-                    // Verify that the exercise has a theia blueprint configured
-                    if (!this.programmingExercise.buildConfig?.theiaImage) {
-                        this.theiaEnabled = false;
-                    }
-                }
             });
         } else if (this.exercise.type === ExerciseType.MODELING) {
             this.editorLabel = 'openModelingEditor';
@@ -181,10 +154,6 @@ export class ExerciseDetailsStudentActionsComponent implements OnInit, OnChanges
         this.isTeamAvailable = !!(this.exercise.teamMode && this.exercise.studentAssignedTeamIdComputed && this.exercise.studentAssignedTeamId);
     }
 
-    startOnlineIDE() {
-        window.open(this.theiaPortalURL, '_blank');
-    }
-
     receiveNewParticipation(newParticipation: StudentParticipation) {
         const studentParticipations = this.exercise.studentParticipations ?? [];
         if (studentParticipations.map((participation) => participation.id).includes(newParticipation.id)) {

src/main/webapp/app/shared/components/code-button/code-button.component.html

@@ -103,6 +103,11 @@ <h5>{{ cloneHeadline | artemisTranslate }}</h5>
             style="min-width: 100px"
             jhiTranslate="{{ wasCopied ? 'artemisApp.exerciseActions.copiedUrl' : 'artemisApp.exerciseActions.copyUrl' }}"
         ></button>
+        @if (theiaEnabled) {
+            <a class="btn btn-primary btn-sm me-2" (click)="startOnlineIDE()" target="_blank" rel="noopener noreferrer">
+                <span class="d-none d-md-inline" jhiTranslate="artemisApp.exerciseActions.openOnlineIDE"></span>
+            </a>
+        }
         <a
             class="btn btn-primary btn-sm"
             target="hidden-iframe"