From 05448370788102525a02b06804d0aac40035abea Mon Sep 17 00:00:00 2001 From: Tim Cremer Date: Wed, 9 Oct 2024 11:46:55 +0200 Subject: [PATCH 01/23] First draft implementation: Propose FAQ as editor --- .../repository/FaqRepository.java | 3 + .../communication/web/FaqResource.java | 39 ++++++++++-- .../course-management-tab-bar.component.html | 2 +- .../course-management-card.component.html | 2 +- src/main/webapp/app/entities/faq.model.ts | 6 +- .../webapp/app/faq/faq-update.component.ts | 6 +- src/main/webapp/app/faq/faq.component.html | 62 +++++++++++++------ src/main/webapp/app/faq/faq.component.ts | 40 +++++++++++- src/main/webapp/app/faq/faq.service.ts | 14 +++++ .../course-faq/course-faq.component.ts | 4 +- src/main/webapp/i18n/de/faq.json | 14 +++-- src/main/webapp/i18n/en/faq.json | 14 +++-- 12 files changed, 166 insertions(+), 40 deletions(-) diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/repository/FaqRepository.java b/src/main/java/de/tum/cit/aet/artemis/communication/repository/FaqRepository.java index bd8bb8989995..0361014a2076 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/repository/FaqRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/repository/FaqRepository.java @@ -12,6 +12,7 @@ import org.springframework.transaction.annotation.Transactional; import de.tum.cit.aet.artemis.communication.domain.Faq; +import de.tum.cit.aet.artemis.communication.domain.FaqState; import de.tum.cit.aet.artemis.core.repository.base.ArtemisJpaRepository; /** @@ -30,6 +31,8 @@ public interface FaqRepository extends ArtemisJpaRepository { """) Set findAllCategoriesByCourseId(@Param("courseId") Long courseId); + Set findAllByCourseIdAndFaqState(Long courseId, FaqState faqState); + @Transactional @Modifying void deleteAllByCourseId(Long courseId); diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/web/FaqResource.java b/src/main/java/de/tum/cit/aet/artemis/communication/web/FaqResource.java index 91a542aaa220..3a513afcc1d6 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/web/FaqResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/web/FaqResource.java @@ -23,12 +23,14 @@ import org.springframework.web.bind.annotation.RestController; import de.tum.cit.aet.artemis.communication.domain.Faq; +import de.tum.cit.aet.artemis.communication.domain.FaqState; import de.tum.cit.aet.artemis.communication.dto.FaqDTO; import de.tum.cit.aet.artemis.communication.repository.FaqRepository; import de.tum.cit.aet.artemis.core.domain.Course; import de.tum.cit.aet.artemis.core.exception.BadRequestAlertException; import de.tum.cit.aet.artemis.core.repository.CourseRepository; import de.tum.cit.aet.artemis.core.security.Role; +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.service.AuthorizationCheckService; @@ -72,7 +74,7 @@ public FaqResource(CourseRepository courseRepository, AuthorizationCheckService * @throws URISyntaxException if the Location URI syntax is incorrect */ @PostMapping("courses/{courseId}/faqs") - @EnforceAtLeastInstructor + @EnforceAtLeastEditor public ResponseEntity createFaq(@RequestBody Faq faq, @PathVariable Long courseId) throws URISyntaxException { log.debug("REST request to save Faq : {}", faq); if (faq.getId() != null) { @@ -82,7 +84,7 @@ public ResponseEntity createFaq(@RequestBody Faq faq, @PathVariable Long if (faq.getCourse() == null || !faq.getCourse().getId().equals(courseId)) { throw new BadRequestAlertException("Course ID in path and FAQ do not match", ENTITY_NAME, "courseIdMismatch"); } - authCheckService.checkHasAtLeastRoleInCourseElseThrow(Role.INSTRUCTOR, faq.getCourse(), null); + authCheckService.checkHasAtLeastRoleInCourseElseThrow(Role.EDITOR, faq.getCourse(), null); Faq savedFaq = faqRepository.save(faq); FaqDTO dto = new FaqDTO(savedFaq); @@ -99,13 +101,14 @@ public ResponseEntity createFaq(@RequestBody Faq faq, @PathVariable Long * if the faq is not valid or if the faq course id does not match with the path variable */ @PutMapping("courses/{courseId}/faqs/{faqId}") - @EnforceAtLeastInstructor + @EnforceAtLeastEditor public ResponseEntity updateFaq(@RequestBody Faq faq, @PathVariable Long faqId, @PathVariable Long courseId) { log.debug("REST request to update Faq : {}", faq); if (faqId == null || !faqId.equals(faq.getId())) { throw new BadRequestAlertException("Id of FAQ and path must match", ENTITY_NAME, "idNull"); } - authCheckService.checkHasAtLeastRoleInCourseElseThrow(Role.INSTRUCTOR, faq.getCourse(), null); + Course course = courseRepository.findByIdElseThrow(courseId); + authCheckService.checkHasAtLeastRoleInCourseElseThrow(Role.STUDENT, course, null); Faq existingFaq = faqRepository.findByIdElseThrow(faqId); if (!Objects.equals(existingFaq.getCourse().getId(), courseId)) { throw new BadRequestAlertException("Course ID of the FAQ provided courseID must match", ENTITY_NAME, "idNull"); @@ -174,6 +177,34 @@ public ResponseEntity> getFaqForCourse(@PathVariable Long courseId) return ResponseEntity.ok().body(faqDTOS); } + /** + * GET /courses/:courseId/faq-status/:faqState : get all the faqs of a course in the specified status + * + * @param courseId the courseId of the course for which all faqs should be returned + * @param faqState the state of all returned FAQs + * @return the ResponseEntity with status 200 (OK) and the list of faqs in body + */ + @GetMapping("courses/{courseId}/faq-state/{faqState}") + @EnforceAtLeastStudent + public ResponseEntity> getAllFaqForCourseByStatus(@PathVariable Long courseId, @PathVariable String faqState) { + log.debug("REST request to get all Faqs for the course with id : {}", courseId); + FaqState retrivedState = defineState(faqState); + Course course = courseRepository.findByIdElseThrow(courseId); + authCheckService.checkHasAtLeastRoleInCourseElseThrow(Role.STUDENT, course, null); + Set faqs = faqRepository.findAllByCourseIdAndFaqState(courseId, retrivedState); + Set faqDTOS = faqs.stream().map(FaqDTO::new).collect(Collectors.toSet()); + return ResponseEntity.ok().body(faqDTOS); + } + + private FaqState defineState(String faqState) { + return switch (faqState) { + case "ACCEPTED" -> FaqState.ACCEPTED; + case "REJECTED" -> FaqState.REJECTED; + case "PROPOSED" -> FaqState.PROPOSED; + default -> throw new IllegalArgumentException("Unknown state: " + faqState); + }; + } + /** * GET /courses/:courseId/faq-categories : get all the faq categories of a course * diff --git a/src/main/webapp/app/course/manage/course-management-tab-bar/course-management-tab-bar.component.html b/src/main/webapp/app/course/manage/course-management-tab-bar/course-management-tab-bar.component.html index abbfdaf7c010..36645abad973 100644 --- a/src/main/webapp/app/course/manage/course-management-tab-bar/course-management-tab-bar.component.html +++ b/src/main/webapp/app/course/manage/course-management-tab-bar/course-management-tab-bar.component.html @@ -72,7 +72,7 @@ } - @if (course.isAtLeastInstructor && course.faqEnabled) { + @if (course.isAtLeastEditor && course.faqEnabled) { diff --git a/src/main/webapp/app/course/manage/overview/course-management-card.component.html b/src/main/webapp/app/course/manage/overview/course-management-card.component.html index d13dee53b6e5..c590b29a0d75 100644 --- a/src/main/webapp/app/course/manage/overview/course-management-card.component.html +++ b/src/main/webapp/app/course/manage/overview/course-management-card.component.html @@ -339,7 +339,7 @@

}
- - - - + @if (isAtleastInstrucor) { + + + + + } @else { + + + + + }
@@ -64,6 +71,10 @@

+ + + + @@ -83,6 +94,9 @@

+ +

+
@for (category of faq.categories; track category) { @@ -90,27 +104,39 @@

}

-
+ @if (faq.faqState == FaqState.PROPOSED && isAtleastInstrucor) { +
+ + +
+ }
- - + @if (isAtleastInstrucor) { + + }
diff --git a/src/main/webapp/app/faq/faq.component.ts b/src/main/webapp/app/faq/faq.component.ts index 3790932a47a8..a593206a7848 100644 --- a/src/main/webapp/app/faq/faq.component.ts +++ b/src/main/webapp/app/faq/faq.component.ts @@ -1,6 +1,6 @@ import { Component, OnDestroy, OnInit, inject } from '@angular/core'; -import { Faq } from 'app/entities/faq.model'; -import { faEdit, faFilter, faPencilAlt, faPlus, faSort, faTrash } from '@fortawesome/free-solid-svg-icons'; +import { Faq, FaqState } from 'app/entities/faq.model'; +import { faCancel, faCheck, faEdit, faFilter, faPencilAlt, faPlus, faSort, faTrash } from '@fortawesome/free-solid-svg-icons'; import { Subject } from 'rxjs'; import { map } from 'rxjs/operators'; import { AlertService } from 'app/core/util/alert.service'; @@ -15,6 +15,9 @@ import { CustomExerciseCategoryBadgeComponent } from 'app/shared/exercise-catego import { ArtemisSharedComponentModule } from 'app/shared/components/shared-component.module'; import { ArtemisSharedModule } from 'app/shared/shared.module'; import { ArtemisMarkdownModule } from 'app/shared/markdown.module'; +import { AccountService } from 'app/core/auth/account.service'; +import { Course } from 'app/entities/course.model'; +import { TranslateService } from '@ngx-translate/core'; @Component({ selector: 'jhi-faq', @@ -24,11 +27,14 @@ import { ArtemisMarkdownModule } from 'app/shared/markdown.module'; imports: [ArtemisSharedModule, CustomExerciseCategoryBadgeComponent, ArtemisSharedComponentModule, ArtemisMarkdownModule], }) export class FaqComponent implements OnInit, OnDestroy { + protected readonly FaqState = FaqState; faqs: Faq[]; + course: Course; filteredFaqs: Faq[]; existingCategories: FaqCategory[]; courseId: number; hasCategories: boolean = false; + isAtleastInstrucor: boolean = false; private dialogErrorSource = new Subject(); dialogError$ = this.dialogErrorSource.asObservable(); @@ -44,11 +50,15 @@ export class FaqComponent implements OnInit, OnDestroy { faPencilAlt = faPencilAlt; faFilter = faFilter; faSort = faSort; + faCancel = faCancel; + faCheck = faCheck; private faqService = inject(FaqService); private route = inject(ActivatedRoute); private alertService = inject(AlertService); private sortService = inject(SortService); + private accountService = inject(AccountService); + private translateService = inject(TranslateService); constructor() { this.predicate = 'id'; @@ -59,6 +69,14 @@ export class FaqComponent implements OnInit, OnDestroy { this.courseId = Number(this.route.snapshot.paramMap.get('courseId')); this.loadAll(); this.loadCourseFaqCategories(this.courseId); + this.route.data.subscribe((data) => { + const course = data['course']; + if (course) { + this.course = course; + this.isAtleastInstrucor = this.accountService.isAtLeastInstructorInCourse(course); + console.log(this.isAtleastInstrucor); + } + }); } ngOnDestroy(): void { @@ -121,4 +139,22 @@ export class FaqComponent implements OnInit, OnDestroy { }); this.applyFilters(); } + + rejectFaq(courseId: number, faq: Faq) { + faq.faqState = FaqState.REJECTED; + faq.course = this.course; + this.faqService.update(courseId, faq).subscribe({ + next: () => this.alertService.success(this.translateService.instant('artemisApp.faq.rejected', { id: faq.id })), + error: (error: HttpErrorResponse) => this.dialogErrorSource.next(error.message), + }); + } + + acceptProposedFaq(courseId: number, faq: Faq) { + faq.faqState = FaqState.ACCEPTED; + faq.course = this.course; + this.faqService.update(courseId, faq).subscribe({ + next: () => this.alertService.success(this.translateService.instant('artemisApp.faq.accepted', { id: faq.id })), + error: (error: HttpErrorResponse) => this.dialogErrorSource.next(error.message), + }); + } } diff --git a/src/main/webapp/app/faq/faq.service.ts b/src/main/webapp/app/faq/faq.service.ts index d0c80cf72e94..c7c9307c6106 100644 --- a/src/main/webapp/app/faq/faq.service.ts +++ b/src/main/webapp/app/faq/faq.service.ts @@ -24,7 +24,13 @@ export class FaqService { ); } + proposeFaq(courseId: number, faq: Faq) { + faq.faqState = FaqState.PROPOSED; + this.create(courseId, faq); + } + update(courseId: number, faq: Faq): Observable { + console.log(faq); const copy = FaqService.convertFaqFromClient(faq); return this.http.put(`${this.resourceUrl}/${courseId}/faqs/${faq.id}`, copy, { observe: 'response' }).pipe( map((res: EntityResponseType) => { @@ -47,6 +53,14 @@ export class FaqService { .pipe(map((res: EntityArrayResponseType) => FaqService.convertFaqCategoryArrayFromServer(res))); } + findAllByCourseIdAndState(courseId: number, faqState: FaqState): Observable { + return this.http + .get(`${this.resourceUrl}/${courseId}/faq-state/${faqState}`, { + observe: 'response', + }) + .pipe(map((res: EntityArrayResponseType) => FaqService.convertFaqCategoryArrayFromServer(res))); + } + delete(courseId: number, faqId: number): Observable> { return this.http.delete(`${this.resourceUrl}/${courseId}/faqs/${faqId}`, { observe: 'response' }); } diff --git a/src/main/webapp/app/overview/course-faq/course-faq.component.ts b/src/main/webapp/app/overview/course-faq/course-faq.component.ts index 51ce0a81b3b2..4adf721aed9e 100644 --- a/src/main/webapp/app/overview/course-faq/course-faq.component.ts +++ b/src/main/webapp/app/overview/course-faq/course-faq.component.ts @@ -8,7 +8,7 @@ import { SidebarData } from 'app/types/sidebar'; import { ArtemisSharedComponentModule } from 'app/shared/components/shared-component.module'; import { ArtemisSharedModule } from 'app/shared/shared.module'; import { CourseFaqAccordionComponent } from 'app/overview/course-faq/course-faq-accordion-component'; -import { Faq } from 'app/entities/faq.model'; +import { Faq, FaqState } from 'app/entities/faq.model'; import { FaqService } from 'app/faq/faq.service'; import { HttpErrorResponse, HttpResponse } from '@angular/common/http'; import { AlertService } from 'app/core/util/alert.service'; @@ -67,7 +67,7 @@ export class CourseFaqComponent implements OnInit, OnDestroy { private loadFaqs() { this.faqService - .findAllByCourseId(this.courseId) + .findAllByCourseIdAndState(this.courseId, FaqState.ACCEPTED) .pipe(map((res: HttpResponse) => res.body)) .subscribe({ next: (res: Faq[]) => { diff --git a/src/main/webapp/i18n/de/faq.json b/src/main/webapp/i18n/de/faq.json index 0cb07d298310..1dd3b4f2ac19 100644 --- a/src/main/webapp/i18n/de/faq.json +++ b/src/main/webapp/i18n/de/faq.json @@ -4,12 +4,17 @@ "home": { "title": "FAQ", "createLabel": "FAQ erstellen", + "proposeLabel": "FAQ vorschlagen", + "accept": "FAQ aktzeptieren", + "reject": "FAQ ablehnen", "filterLabel": "Filter", "createOrEditLabel": "FAQ erstellen oder bearbeiten" }, - "created": "Das FAQ wurde erfolgreich erstellt", - "updated": "Das FAQ wurde erfolgreich aktualisiert", - "deleted": "Das FAQ wurde erfolgreich gelöscht", + "created": "Das FAQ mit der ID {{ id }} wurde erfolgreich erstellt", + "updated": "Das FAQ mit der ID {{ id }} wurde erfolgreich aktualisiert", + "deleted": "Das FAQ mit der ID {{ param }} wurde erfolgreich gelöscht", + "accepted": "Das FAQ mit der ID {{ id }} wurde erfolgreich aktzeptiert", + "rejected": "Das FAQ mit der ID {{ id }} wurde erfolgreich abgelehnt", "delete": { "question": "Soll die FAQ {{ title }} wirklich dauerhaft gelöscht werden? Diese Aktion kann NICHT rückgängig gemacht werden!", "typeNameToConfirm": "Bitte gib den Namen des FAQ zur Bestätigung ein." @@ -18,7 +23,8 @@ "table": { "questionTitle": "Fragentitel", "questionAnswer": "Antwort auf die Frage", - "categories": "Kategorien" + "categories": "Kategorien", + "state": "Status" }, "course": "Kurs" } diff --git a/src/main/webapp/i18n/en/faq.json b/src/main/webapp/i18n/en/faq.json index 1a158eb52c40..c736c2602278 100644 --- a/src/main/webapp/i18n/en/faq.json +++ b/src/main/webapp/i18n/en/faq.json @@ -4,12 +4,17 @@ "home": { "title": "FAQ", "createLabel": "Create a new FAQ", + "proposeLabel": "Propose a new FAQ", + "accept": "Accept FAQ", + "reject": "Reject FAQ", "filterLabel": "Filter", "createOrEditLabel": "Create or edit FAQ" }, - "created": "The FAQ was successfully created", - "updated": "The FAQ was successfully updated", - "deleted": "The FAQ was successfully deleted", + "created": "The FAQ with ID {{ id }} was successfully created", + "updated": "The FAQ with ID {{ id }} was successfully updated", + "deleted": "The FAQ with ID {{ param }} was successfully deleted", + "accepted": "The FAQ with ID {{ id }} was successfully accepted", + "rejected": "The FAQ with ID {{ id }} was successfully rejected", "delete": { "question": "Are you sure you want to permanently delete the FAQ {{ title }}? This action can NOT be undone!", "typeNameToConfirm": "Please type in the name of the FAQ to confirm." @@ -18,7 +23,8 @@ "table": { "questionTitle": "Question title", "questionAnswer": "Question answer", - "categories": "Categories" + "categories": "Categories", + "state": "State" }, "course": "Course" } From 280e3f46fe87a60cd20cb82684f2bb5f231bc89b Mon Sep 17 00:00:00 2001 From: Tim Cremer Date: Wed, 9 Oct 2024 13:23:30 +0200 Subject: [PATCH 02/23] First draft implementation: Added test cases --- src/main/webapp/app/faq/faq.component.ts | 13 ++++-- src/main/webapp/app/faq/faq.service.ts | 7 --- .../communication/FaqIntegrationTest.java | 25 +++++++++- .../spec/component/faq/faq.component.spec.ts | 46 ++++++++++++++++--- .../course-faq/course-faq.component.spec.ts | 8 ++-- .../spec/service/faq.service.spec.ts | 20 ++++++++ 6 files changed, 97 insertions(+), 22 deletions(-) diff --git a/src/main/webapp/app/faq/faq.component.ts b/src/main/webapp/app/faq/faq.component.ts index a593206a7848..3220fd29c6ae 100644 --- a/src/main/webapp/app/faq/faq.component.ts +++ b/src/main/webapp/app/faq/faq.component.ts @@ -74,7 +74,6 @@ export class FaqComponent implements OnInit, OnDestroy { if (course) { this.course = course; this.isAtleastInstrucor = this.accountService.isAtLeastInstructorInCourse(course); - console.log(this.isAtleastInstrucor); } }); } @@ -141,20 +140,28 @@ export class FaqComponent implements OnInit, OnDestroy { } rejectFaq(courseId: number, faq: Faq) { + const previousState = faq.faqState; faq.faqState = FaqState.REJECTED; faq.course = this.course; this.faqService.update(courseId, faq).subscribe({ next: () => this.alertService.success(this.translateService.instant('artemisApp.faq.rejected', { id: faq.id })), - error: (error: HttpErrorResponse) => this.dialogErrorSource.next(error.message), + error: (error: HttpErrorResponse) => { + this.dialogErrorSource.next(error.message); + faq.faqState = previousState; + }, }); } acceptProposedFaq(courseId: number, faq: Faq) { + const previousState = faq.faqState; faq.faqState = FaqState.ACCEPTED; faq.course = this.course; this.faqService.update(courseId, faq).subscribe({ next: () => this.alertService.success(this.translateService.instant('artemisApp.faq.accepted', { id: faq.id })), - error: (error: HttpErrorResponse) => this.dialogErrorSource.next(error.message), + error: (error: HttpErrorResponse) => { + this.dialogErrorSource.next(error.message); + faq.faqState = previousState; + }, }); } } diff --git a/src/main/webapp/app/faq/faq.service.ts b/src/main/webapp/app/faq/faq.service.ts index c7c9307c6106..48e16923e7d4 100644 --- a/src/main/webapp/app/faq/faq.service.ts +++ b/src/main/webapp/app/faq/faq.service.ts @@ -16,7 +16,6 @@ export class FaqService { create(courseId: number, faq: Faq): Observable { const copy = FaqService.convertFaqFromClient(faq); - copy.faqState = FaqState.ACCEPTED; return this.http.post(`${this.resourceUrl}/${courseId}/faqs`, copy, { observe: 'response' }).pipe( map((res: EntityResponseType) => { return res; @@ -24,13 +23,7 @@ export class FaqService { ); } - proposeFaq(courseId: number, faq: Faq) { - faq.faqState = FaqState.PROPOSED; - this.create(courseId, faq); - } - update(courseId: number, faq: Faq): Observable { - console.log(faq); const copy = FaqService.convertFaqFromClient(faq); return this.http.put(`${this.resourceUrl}/${courseId}/faqs/${faq.id}`, copy, { observe: 'response' }).pipe( map((res: EntityResponseType) => { diff --git a/src/test/java/de/tum/cit/aet/artemis/communication/FaqIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/communication/FaqIntegrationTest.java index 5f226f52d4dc..a89c0ee8b3b8 100644 --- a/src/test/java/de/tum/cit/aet/artemis/communication/FaqIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/communication/FaqIntegrationTest.java @@ -15,6 +15,7 @@ import de.tum.cit.aet.artemis.communication.domain.Faq; import de.tum.cit.aet.artemis.communication.domain.FaqState; +import de.tum.cit.aet.artemis.communication.dto.FaqDTO; import de.tum.cit.aet.artemis.communication.repository.FaqRepository; import de.tum.cit.aet.artemis.core.domain.Course; import de.tum.cit.aet.artemis.core.exception.EntityNotFoundException; @@ -31,13 +32,16 @@ class FaqIntegrationTest extends AbstractSpringIntegrationIndependentTest { private Faq faq; + private FaqDTO faqDTO; + @BeforeEach void initTestCase() throws Exception { int numberOfTutors = 2; userUtilService.addUsers(TEST_PREFIX, 1, numberOfTutors, 0, 1); List courses = courseUtilService.createCoursesWithExercisesAndLectures(TEST_PREFIX, true, true, numberOfTutors); this.course1 = this.courseRepository.findByIdWithExercisesAndExerciseDetailsAndLecturesElseThrow(courses.getFirst().getId()); - this.faq = FaqFactory.generateFaq(course1, FaqState.ACCEPTED, "answer", "title"); + this.faq = FaqFactory.generateFaq(course1, FaqState.PROPOSED, "answer", "title"); + this.faqDTO = new FaqDTO(faq); faqRepository.save(this.faq); // Add users that are not in the course userUtilService.createAndSaveUser(TEST_PREFIX + "student42"); @@ -116,7 +120,8 @@ void updateFaq_IdsDoNotMatch_shouldNotUpdateFaq() throws Exception { Faq faq = faqRepository.findById(this.faq.getId()).orElseThrow(); faq.setQuestionTitle("Updated"); faq.setFaqState(FaqState.PROPOSED); - Faq updatedFaq = request.putWithResponseBody("/api/courses/" + faq.getCourse().getId() + 1 + "/faqs/" + faq.getId(), faq, Faq.class, HttpStatus.BAD_REQUEST); + faq.setId(faq.getId() + 1); + Faq updatedFaq = request.putWithResponseBody("/api/courses/" + course1.getId() + "/faqs/" + (faq.getId() - 1), faq, Faq.class, HttpStatus.BAD_REQUEST); } @Test @@ -161,4 +166,20 @@ void deleteFaq_IdsDoNotMatch_shouldNotDeleteFAQ() throws Exception { assertThat(faqOptional).isPresent(); } + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testgetFaqByCourseId() throws Exception { + Set faqs = faqRepository.findAllByCourseIdAndFaqState(this.course1.getId(), FaqState.PROPOSED); + Set returnedFaqs = request.get("/api/courses/" + course1.getId() + "/faqs", HttpStatus.OK, Set.class); + assertThat(returnedFaqs).hasSize(faqs.size()); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testgetFaqByCourseIdAndState() throws Exception { + Set faqs = faqRepository.findAllByCourseIdAndFaqState(this.course1.getId(), FaqState.PROPOSED); + Set returnedFaqs = request.get("/api/courses/" + course1.getId() + "/faq-state/" + "PROPOSED", HttpStatus.OK, Set.class); + assertThat(returnedFaqs).hasSize(faqs.size()); + } + } diff --git a/src/test/javascript/spec/component/faq/faq.component.spec.ts b/src/test/javascript/spec/component/faq/faq.component.spec.ts index d31f60b8e2f2..134f70bc1f7b 100644 --- a/src/test/javascript/spec/component/faq/faq.component.spec.ts +++ b/src/test/javascript/spec/component/faq/faq.component.spec.ts @@ -9,7 +9,7 @@ import { MockRouter } from '../../helpers/mocks/mock-router'; import { MockTranslateService } from '../../helpers/mocks/service/mock-translate.service'; import { ArtemisTestModule } from '../../test.module'; import { FaqService } from 'app/faq/faq.service'; -import { Faq } from 'app/entities/faq.model'; +import { Faq, FaqState } from 'app/entities/faq.model'; import { ArtemisMarkdownEditorModule } from 'app/shared/markdown-editor/markdown-editor.module'; import { BrowserAnimationsModule } from '@angular/platform-browser/animations'; @@ -18,6 +18,8 @@ import { FaqCategory } from 'app/entities/faq-category.model'; import { CustomExerciseCategoryBadgeComponent } from 'app/shared/exercise-categories/custom-exercise-category-badge/custom-exercise-category-badge.component'; import { AlertService } from 'app/core/util/alert.service'; import { SortService } from 'app/shared/service/sort.service'; +import { MockAccountService } from '../../helpers/mocks/service/mock-account.service'; +import { AccountService } from 'app/core/auth/account.service'; function createFaq(id: number, category: string, color: string): Faq { const faq = new Faq(); @@ -25,6 +27,7 @@ function createFaq(id: number, category: string, color: string): Faq { faq.questionTitle = 'questionTitle'; faq.questionAnswer = 'questionAnswer'; faq.categories = [new FaqCategory(category, color)]; + faq.faqState = FaqState.PROPOSED; return faq; } @@ -57,12 +60,11 @@ describe('FaqComponent', () => { providers: [ { provide: TranslateService, useClass: MockTranslateService }, { provide: Router, useClass: MockRouter }, + { provide: AccountService, useClass: MockAccountService }, { provide: ActivatedRoute, useValue: { - parent: { - data: of({ course: { id: 1 } }), - }, + data: of({ course: { id: 1 } }), snapshot: { paramMap: convertToParamMap({ courseId: '1', @@ -169,9 +171,41 @@ describe('FaqComponent', () => { it('should call sortService when sortRows is called', () => { jest.spyOn(sortService, 'sortByProperty').mockReturnValue([]); - faqComponent.sortRows(); - expect(sortService.sortByProperty).toHaveBeenCalledOnce(); }); + + it('should reject faq properly', () => { + jest.spyOn(faqService, 'update').mockReturnValue(of(new HttpResponse({ body: faq1 }))); + faqComponentFixture.detectChanges(); + faqComponent.rejectFaq(courseId, faq1); + expect(faqService.update).toHaveBeenCalledExactlyOnceWith(courseId, faq1); + expect(faq1.faqState).toEqual(FaqState.REJECTED); + }); + + it('should not change status if rejection fails', () => { + const error = { status: 500 }; + jest.spyOn(faqService, 'update').mockReturnValue(throwError(() => new HttpErrorResponse(error))); + faqComponentFixture.detectChanges(); + faqComponent.rejectFaq(courseId, faq1); + expect(faqService.update).toHaveBeenCalledExactlyOnceWith(courseId, faq1); + expect(faq1.faqState).toEqual(FaqState.PROPOSED); + }); + + it('should accepts proposed faq properly', () => { + jest.spyOn(faqService, 'update').mockReturnValue(of(new HttpResponse({ body: faq1 }))); + faqComponentFixture.detectChanges(); + faqComponent.acceptProposedFaq(courseId, faq1); + expect(faqService.update).toHaveBeenCalledExactlyOnceWith(courseId, faq1); + expect(faq1.faqState).toEqual(FaqState.ACCEPTED); + }); + + it('should not change status if acceptance fails', () => { + const error = { status: 500 }; + jest.spyOn(faqService, 'update').mockReturnValue(throwError(() => new HttpErrorResponse(error))); + faqComponentFixture.detectChanges(); + faqComponent.acceptProposedFaq(courseId, faq1); + expect(faqService.update).toHaveBeenCalledExactlyOnceWith(courseId, faq1); + expect(faq1.faqState).toEqual(FaqState.PROPOSED); + }); }); diff --git a/src/test/javascript/spec/component/overview/course-faq/course-faq.component.spec.ts b/src/test/javascript/spec/component/overview/course-faq/course-faq.component.spec.ts index 6c5a21b56ddb..b5dc43636ede 100644 --- a/src/test/javascript/spec/component/overview/course-faq/course-faq.component.spec.ts +++ b/src/test/javascript/spec/component/overview/course-faq/course-faq.component.spec.ts @@ -16,7 +16,7 @@ import { ArtemisSharedComponentModule } from 'app/shared/components/shared-compo import { ArtemisSharedModule } from 'app/shared/shared.module'; import { CustomExerciseCategoryBadgeComponent } from 'app/shared/exercise-categories/custom-exercise-category-badge/custom-exercise-category-badge.component'; import { CourseFaqAccordionComponent } from 'app/overview/course-faq/course-faq-accordion-component'; -import { Faq } from 'app/entities/faq.model'; +import { Faq, FaqState } from 'app/entities/faq.model'; import { FaqCategory } from 'app/entities/faq-category.model'; function createFaq(id: number, category: string, color: string): Faq { @@ -62,7 +62,7 @@ describe('CourseFaqs', () => { }, }, MockProvider(FaqService, { - findAllByCourseId: () => { + findAllByCourseIdAndState: () => { return of( new HttpResponse({ body: [faq1, faq2, faq3], @@ -108,10 +108,10 @@ describe('CourseFaqs', () => { }); it('should fetch faqs when initialized', () => { - const findAllSpy = jest.spyOn(faqService, 'findAllByCourseId'); + const findAllSpy = jest.spyOn(faqService, 'findAllByCourseIdAndState'); courseFaqComponentFixture.detectChanges(); - expect(findAllSpy).toHaveBeenCalledExactlyOnceWith(1); + expect(findAllSpy).toHaveBeenCalledExactlyOnceWith(1, FaqState.ACCEPTED); expect(courseFaqComponent.faqs).toHaveLength(3); }); diff --git a/src/test/javascript/spec/service/faq.service.spec.ts b/src/test/javascript/spec/service/faq.service.spec.ts index b5612f991ebd..8074b3047baa 100644 --- a/src/test/javascript/spec/service/faq.service.spec.ts +++ b/src/test/javascript/spec/service/faq.service.spec.ts @@ -132,6 +132,26 @@ describe('Faq Service', () => { expect(expectedResult.body).toEqual(expected); }); + it('should find faqs by courseId and status', () => { + const category = { + color: '#6ae8ac', + category: 'category1', + } as FaqCategory; + const returnedFromService = [{ ...elemDefault, categories: [JSON.stringify(category)] }]; + const expected = [{ ...elemDefault, categories: [new FaqCategory('category1', '#6ae8ac')] }]; + const courseId = 1; + service + .findAllByCourseIdAndState(courseId, FaqState.ACCEPTED) + .pipe(take(1)) + .subscribe((resp) => (expectedResult = resp)); + const req = httpMock.expectOne({ + url: `api/courses/${courseId}/faq-state/${FaqState.ACCEPTED}`, + method: 'GET', + }); + req.flush(returnedFromService); + expect(expectedResult.body).toEqual(expected); + }); + it('should find all categories by courseId', () => { const category = { color: '#6ae8ac', From 2eb7316e66e09cb08bfd2036f1d9becd1ca36256 Mon Sep 17 00:00:00 2001 From: Tim Cremer Date: Wed, 9 Oct 2024 16:02:57 +0200 Subject: [PATCH 03/23] fixed tests --- .../spec/component/faq/faq-update.component.spec.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/test/javascript/spec/component/faq/faq-update.component.spec.ts b/src/test/javascript/spec/component/faq/faq-update.component.spec.ts index 04c04b3d12d3..b0736061a8c9 100644 --- a/src/test/javascript/spec/component/faq/faq-update.component.spec.ts +++ b/src/test/javascript/spec/component/faq/faq-update.component.spec.ts @@ -11,7 +11,7 @@ import { MockTranslateService } from '../../helpers/mocks/service/mock-translate import { ArtemisTestModule } from '../../test.module'; import { FaqUpdateComponent } from 'app/faq/faq-update.component'; import { FaqService } from 'app/faq/faq.service'; -import { Faq, FaqState } from 'app/entities/faq.model'; +import { Faq } from 'app/entities/faq.model'; import { BrowserAnimationsModule } from '@angular/platform-browser/animations'; import { AlertService } from 'app/core/util/alert.service'; import { FaqCategory } from 'app/entities/faq-category.model'; @@ -111,7 +111,7 @@ describe('FaqUpdateComponent', () => { faqUpdateComponent.save(); tick(); - expect(createSpy).toHaveBeenCalledExactlyOnceWith(courseId, { faqState: FaqState.ACCEPTED, questionTitle: 'test1' }); + expect(createSpy).toHaveBeenCalledExactlyOnceWith(courseId, { questionTitle: 'test1', faqState: 'PROPOSED' }); expect(faqUpdateComponent.isSaving).toBeFalse(); })); @@ -140,7 +140,7 @@ describe('FaqUpdateComponent', () => { tick(); faqUpdateComponentFixture.detectChanges(); - expect(updateSpy).toHaveBeenCalledExactlyOnceWith(courseId, { id: 6, questionTitle: 'test1Updated' }); + expect(updateSpy).toHaveBeenCalledExactlyOnceWith(courseId, { id: 6, questionTitle: 'test1Updated', faqState: 'PROPOSED' }); })); it('should navigate to previous state', fakeAsync(() => { From 0ab7a919eb4cc5e62938aa7ee22c7284174f2899 Mon Sep 17 00:00:00 2001 From: Tim Cremer Date: Sat, 12 Oct 2024 13:47:36 +0200 Subject: [PATCH 04/23] Added proper alert messages --- .../webapp/app/faq/faq-update.component.ts | 18 +++++-- src/main/webapp/i18n/de/faq.json | 6 ++- src/main/webapp/i18n/en/faq.json | 2 + .../faq/faq-update.component.spec.ts | 54 ++++++++++++++++++- 4 files changed, 72 insertions(+), 8 deletions(-) diff --git a/src/main/webapp/app/faq/faq-update.component.ts b/src/main/webapp/app/faq/faq-update.component.ts index ca16f63e8413..5abd6ac1dd7f 100644 --- a/src/main/webapp/app/faq/faq-update.component.ts +++ b/src/main/webapp/app/faq/faq-update.component.ts @@ -32,7 +32,7 @@ export class FaqUpdateComponent implements OnInit { existingCategories: FaqCategory[]; faqCategories: FaqCategory[]; courseId: number; - isAtleastInstructor: boolean = false; + isAtLeastInstructor: boolean = false; domainActionsDescription = [new FormulaAction()]; // Icons @@ -59,7 +59,7 @@ export class FaqUpdateComponent implements OnInit { if (course) { this.faq.course = course; this.loadCourseFaqCategories(course.id); - this.isAtleastInstructor = this.accountService.isAtLeastInstructorInCourse(course); + this.isAtLeastInstructor = this.accountService.isAtLeastInstructorInCourse(course); } this.faqCategories = faq?.categories ? faq.categories : []; }); @@ -81,7 +81,7 @@ export class FaqUpdateComponent implements OnInit { */ save() { this.isSaving = true; - this.faq.faqState = this.isAtleastInstructor ? FaqState.ACCEPTED : FaqState.PROPOSED; + this.faq.faqState = this.isAtLeastInstructor ? FaqState.ACCEPTED : FaqState.PROPOSED; if (this.faq.id !== undefined) { this.subscribeToSaveResponse(this.faqService.update(this.courseId, this.faq)); } else { @@ -111,13 +111,21 @@ export class FaqUpdateComponent implements OnInit { if (faqBody) { this.faq = faqBody; } - this.alertService.success(this.translateService.instant('artemisApp.faq.created', { id: faq.id })); + if (this.isAtLeastInstructor) { + this.alertService.success(this.translateService.instant('artemisApp.faq.created', { id: faq.id })); + } else { + this.alertService.success(this.translateService.instant('artemisApp.faq.proposed', { id: faq.id })); + } this.router.navigate(['course-management', this.courseId, 'faqs']); }, }); } else { this.isSaving = false; - this.alertService.success(this.translateService.instant('artemisApp.faq.updated', { id: faq.id })); + if (this.isAtLeastInstructor) { + this.alertService.success(this.translateService.instant('artemisApp.faq.updated', { id: faq.id })); + } else { + this.alertService.success(this.translateService.instant('artemisApp.faq.proposedChange', { id: faq.id })); + } this.router.navigate(['course-management', this.courseId, 'faqs']); } } diff --git a/src/main/webapp/i18n/de/faq.json b/src/main/webapp/i18n/de/faq.json index 1dd3b4f2ac19..413239c161e1 100644 --- a/src/main/webapp/i18n/de/faq.json +++ b/src/main/webapp/i18n/de/faq.json @@ -5,15 +5,17 @@ "title": "FAQ", "createLabel": "FAQ erstellen", "proposeLabel": "FAQ vorschlagen", - "accept": "FAQ aktzeptieren", + "accept": "FAQ akzeptieren", "reject": "FAQ ablehnen", "filterLabel": "Filter", "createOrEditLabel": "FAQ erstellen oder bearbeiten" }, "created": "Das FAQ mit der ID {{ id }} wurde erfolgreich erstellt", "updated": "Das FAQ mit der ID {{ id }} wurde erfolgreich aktualisiert", + "proposed": "Das FAQ mit der ID {{ id }} wurde erfolgreich vorgeschlagen", + "proposedChange": "Die Änderungen am FAQ mit der ID {{ id }} wurde erfolgreich vorgeschlagen", "deleted": "Das FAQ mit der ID {{ param }} wurde erfolgreich gelöscht", - "accepted": "Das FAQ mit der ID {{ id }} wurde erfolgreich aktzeptiert", + "accepted": "Das FAQ mit der ID {{ id }} wurde erfolgreich akzeptieren", "rejected": "Das FAQ mit der ID {{ id }} wurde erfolgreich abgelehnt", "delete": { "question": "Soll die FAQ {{ title }} wirklich dauerhaft gelöscht werden? Diese Aktion kann NICHT rückgängig gemacht werden!", diff --git a/src/main/webapp/i18n/en/faq.json b/src/main/webapp/i18n/en/faq.json index c736c2602278..8aeac9a29c8e 100644 --- a/src/main/webapp/i18n/en/faq.json +++ b/src/main/webapp/i18n/en/faq.json @@ -12,6 +12,8 @@ }, "created": "The FAQ with ID {{ id }} was successfully created", "updated": "The FAQ with ID {{ id }} was successfully updated", + "proposed": "The FAQ with ID {{ id }} was successfully proposed", + "proposedChange": "The changes to the FAQ with the ID {{ id }} have been successfully proposed", "deleted": "The FAQ with ID {{ param }} was successfully deleted", "accepted": "The FAQ with ID {{ id }} was successfully accepted", "rejected": "The FAQ with ID {{ id }} was successfully rejected", diff --git a/src/test/javascript/spec/component/faq/faq-update.component.spec.ts b/src/test/javascript/spec/component/faq/faq-update.component.spec.ts index b0736061a8c9..275bd4cb4f48 100644 --- a/src/test/javascript/spec/component/faq/faq-update.component.spec.ts +++ b/src/test/javascript/spec/component/faq/faq-update.component.spec.ts @@ -93,6 +93,32 @@ describe('FaqUpdateComponent', () => { it('should create faq', fakeAsync(() => { faqUpdateComponent.faq = { questionTitle: 'test1' } as Faq; + faqUpdateComponent.isAtLeastInstructor = true; + const createSpy = jest.spyOn(faqService, 'create').mockReturnValue( + of( + new HttpResponse({ + body: { + id: 3, + questionTitle: 'test1', + course: { + id: 1, + }, + } as Faq, + }), + ), + ); + + faqUpdateComponentFixture.detectChanges(); + faqUpdateComponent.save(); + tick(); + + expect(createSpy).toHaveBeenCalledExactlyOnceWith(courseId, { questionTitle: 'test1', faqState: 'ACCEPTED' }); + expect(faqUpdateComponent.isSaving).toBeFalse(); + })); + + it('should propose faq', fakeAsync(() => { + faqUpdateComponent.faq = { questionTitle: 'test1' } as Faq; + faqUpdateComponent.isAtLeastInstructor = false; const createSpy = jest.spyOn(faqService, 'create').mockReturnValue( of( new HttpResponse({ @@ -117,7 +143,7 @@ describe('FaqUpdateComponent', () => { it('should edit a faq', fakeAsync(() => { activatedRoute.parent!.data = of({ course: { id: 1 }, faq: { id: 6 } }); - + faqUpdateComponent.isAtLeastInstructor = true; faqUpdateComponentFixture.detectChanges(); faqUpdateComponent.faq = { id: 6, questionTitle: 'test1Updated' } as Faq; @@ -139,7 +165,33 @@ describe('FaqUpdateComponent', () => { faqUpdateComponent.save(); tick(); faqUpdateComponentFixture.detectChanges(); + expect(updateSpy).toHaveBeenCalledExactlyOnceWith(courseId, { id: 6, questionTitle: 'test1Updated', faqState: 'ACCEPTED' }); + })); + + it('should propose to edit a faq', fakeAsync(() => { + activatedRoute.parent!.data = of({ course: { id: 1 }, faq: { id: 6 } }); + faqUpdateComponent.isAtLeastInstructor = false; + faqUpdateComponentFixture.detectChanges(); + faqUpdateComponent.faq = { id: 6, questionTitle: 'test1Updated' } as Faq; + const updateSpy = jest.spyOn(faqService, 'update').mockReturnValue( + of>( + new HttpResponse({ + body: { + id: 6, + questionTitle: 'test1Updated', + questionAnswer: 'answer', + course: { + id: 1, + }, + } as Faq, + }), + ), + ); + + faqUpdateComponent.save(); + tick(); + faqUpdateComponentFixture.detectChanges(); expect(updateSpy).toHaveBeenCalledExactlyOnceWith(courseId, { id: 6, questionTitle: 'test1Updated', faqState: 'PROPOSED' }); })); From edf208eb89db4e56e00702a64f734773179af438 Mon Sep 17 00:00:00 2001 From: Simon Entholzer <33342534+SimonEntholzer@users.noreply.github.com> Date: Sat, 12 Oct 2024 16:25:46 +0200 Subject: [PATCH 05/23] `Integrated code lifecycle`: Simplify user interface for ssh keys (#9 von 454) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Kaan Çaylı <38523756+kaancayli@users.noreply.github.com> --- .../tum/cit/aet/artemis/core/domain/User.java | 5 + .../tum/cit/aet/artemis/core/dto/UserDTO.java | 10 + .../core/web/open/PublicAccountResource.java | 1 + .../domain/AuthenticationMechanism.java | 2 +- src/main/webapp/app/core/user/user.model.ts | 1 + .../documentation-button.component.ts | 2 +- .../documentation-link.component.html | 5 + .../documentation-link.component.ts | 25 +++ .../ssh-user-settings.component.html | 197 ++++++++++++------ .../ssh-user-settings.component.scss | 134 ++++++++++++ .../ssh-user-settings.component.ts | 48 ++++- .../user-settings/user-settings.module.ts | 3 +- .../shared/user-settings/user-settings.scss | 5 - .../app/shared/util/os-detector.util.ts | 17 ++ .../content/scss/themes/_dark-variables.scss | 7 + .../scss/themes/_default-variables.scss | 7 + src/main/webapp/i18n/de/userSettings.json | 19 +- src/main/webapp/i18n/en/userSettings.json | 17 +- .../ssh-user-settings.component.spec.ts | 48 ++++- 19 files changed, 463 insertions(+), 90 deletions(-) create mode 100644 src/main/webapp/app/shared/components/documentation-link/documentation-link.component.html create mode 100644 src/main/webapp/app/shared/components/documentation-link/documentation-link.component.ts create mode 100644 src/main/webapp/app/shared/user-settings/ssh-settings/ssh-user-settings.component.scss create mode 100644 src/main/webapp/app/shared/util/os-detector.util.ts diff --git a/src/main/java/de/tum/cit/aet/artemis/core/domain/User.java b/src/main/java/de/tum/cit/aet/artemis/core/domain/User.java index 7fa995658af1..6498340f3bc2 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/domain/User.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/domain/User.java @@ -561,4 +561,9 @@ public void hasAcceptedIrisElseThrow() { public String getSshPublicKey() { return sshPublicKey; } + + @Nullable + public @Size(max = 100) String getSshPublicKeyHash() { + return sshPublicKeyHash; + } } diff --git a/src/main/java/de/tum/cit/aet/artemis/core/dto/UserDTO.java b/src/main/java/de/tum/cit/aet/artemis/core/dto/UserDTO.java index 1ac72940f919..3d627425a8f7 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/dto/UserDTO.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/dto/UserDTO.java @@ -78,6 +78,8 @@ public class UserDTO extends AuditingEntityDTO { private String sshPublicKey; + private String sshKeyHash; + private ZonedDateTime irisAccepted; public UserDTO() { @@ -291,4 +293,12 @@ public ZonedDateTime getIrisAccepted() { public void setIrisAccepted(ZonedDateTime irisAccepted) { this.irisAccepted = irisAccepted; } + + public String getSshKeyHash() { + return sshKeyHash; + } + + public void setSshKeyHash(String sshKeyHash) { + this.sshKeyHash = sshKeyHash; + } } diff --git a/src/main/java/de/tum/cit/aet/artemis/core/web/open/PublicAccountResource.java b/src/main/java/de/tum/cit/aet/artemis/core/web/open/PublicAccountResource.java index 992b340359a1..bd673ece51d4 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/web/open/PublicAccountResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/web/open/PublicAccountResource.java @@ -167,6 +167,7 @@ public ResponseEntity getAccount() { userDTO.setVcsAccessToken(user.getVcsAccessToken()); userDTO.setVcsAccessTokenExpiryDate(user.getVcsAccessTokenExpiryDate()); userDTO.setSshPublicKey(user.getSshPublicKey()); + userDTO.setSshKeyHash(user.getSshPublicKeyHash()); log.info("GET /account {} took {}ms", user.getLogin(), System.currentTimeMillis() - start); return ResponseEntity.ok(userDTO); } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/domain/AuthenticationMechanism.java b/src/main/java/de/tum/cit/aet/artemis/programming/domain/AuthenticationMechanism.java index 3caec801ed53..239ef3674d44 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/domain/AuthenticationMechanism.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/domain/AuthenticationMechanism.java @@ -20,5 +20,5 @@ public enum AuthenticationMechanism { /** * The user used the artemis client code editor to authenticate to the LocalVC */ - CODE_EDITOR + CODE_EDITOR, } diff --git a/src/main/webapp/app/core/user/user.model.ts b/src/main/webapp/app/core/user/user.model.ts index b55ff839fd54..f793581b21a3 100644 --- a/src/main/webapp/app/core/user/user.model.ts +++ b/src/main/webapp/app/core/user/user.model.ts @@ -16,6 +16,7 @@ export class User extends Account { public vcsAccessToken?: string; public vcsAccessTokenExpiryDate?: string; public sshPublicKey?: string; + public sshKeyHash?: string; public irisAccepted?: dayjs.Dayjs; constructor( diff --git a/src/main/webapp/app/shared/components/documentation-button/documentation-button.component.ts b/src/main/webapp/app/shared/components/documentation-button/documentation-button.component.ts index f598865bb6a6..7724361d798e 100644 --- a/src/main/webapp/app/shared/components/documentation-button/documentation-button.component.ts +++ b/src/main/webapp/app/shared/components/documentation-button/documentation-button.component.ts @@ -12,7 +12,7 @@ const DocumentationLinks = { Quiz: 'exercises/quiz/', Model: 'exercises/modeling/', Programming: 'exercises/programming/', - SshSetup: 'exercises/programming.html#repository-access', + SshSetup: 'icl/ssh-intro', Text: 'exercises/textual/', FileUpload: 'exercises/file-upload/', Notifications: 'notifications/', diff --git a/src/main/webapp/app/shared/components/documentation-link/documentation-link.component.html b/src/main/webapp/app/shared/components/documentation-link/documentation-link.component.html new file mode 100644 index 000000000000..b3e990001b2f --- /dev/null +++ b/src/main/webapp/app/shared/components/documentation-link/documentation-link.component.html @@ -0,0 +1,5 @@ +@if (displayString() && documentationType()) { + + + +} diff --git a/src/main/webapp/app/shared/components/documentation-link/documentation-link.component.ts b/src/main/webapp/app/shared/components/documentation-link/documentation-link.component.ts new file mode 100644 index 000000000000..86f5d19aafb6 --- /dev/null +++ b/src/main/webapp/app/shared/components/documentation-link/documentation-link.component.ts @@ -0,0 +1,25 @@ +import { Component, input } from '@angular/core'; +import { TranslateDirective } from 'app/shared/language/translate.directive'; + +// The routes here are used to build the link to the documentation. +// Therefore, it's important that they exactly match the url to the subpage of the documentation. +// Additionally, the case names must match the keys in documentationLinks.json for the tooltip. +const DocumentationLinks: { [key: string]: string } = { + SshSetup: 'icl/ssh-intro', +}; + +export type DocumentationType = keyof typeof DocumentationLinks; + +@Component({ + selector: 'jhi-documentation-link', + standalone: true, + templateUrl: './documentation-link.component.html', + imports: [TranslateDirective], +}) +export class DocumentationLinkComponent { + readonly BASE_URL = 'https://docs.artemis.cit.tum.de/user/'; + readonly DocumentationLinks = DocumentationLinks; + + documentationType = input(); + displayString = input(); +} diff --git a/src/main/webapp/app/shared/user-settings/ssh-settings/ssh-user-settings.component.html b/src/main/webapp/app/shared/user-settings/ssh-settings/ssh-user-settings.component.html index 8899797a2e8c..7372a07ac241 100644 --- a/src/main/webapp/app/shared/user-settings/ssh-settings/ssh-user-settings.component.html +++ b/src/main/webapp/app/shared/user-settings/ssh-settings/ssh-user-settings.component.html @@ -3,80 +3,153 @@

@if (currentUser) {
-
-
- - -
-
- @if (storedSshKey === '' && !editSshKey) { -
- -
- } - @if (storedSshKey !== '' && !editSshKey) { -
-
- {{ sshKey }} -
-
-
+ + @if (keyCount === 0 && !showSshKey) { +
+
+

+
+

+ + + +

+
+ +
-
- -
} - @if (editSshKey) { -
-
+ + + @if (keyCount > 0 && !showSshKey) { +
+

+ +
+

+ + + +

+
+ + + + + + + + + + + + + + + +
+
+
+ {{ sshKeyHash }} +
+ 		+
+
+ + + + +
+ + +
+
+
+
+ } + + + @if (showSshKey) {
+ @if (isKeyReadonly) { +

+ } @else { +

+ } + +
+

+ + + +

+
+
- +

+
-
-
- + +
+

+ + {{ copyInstructions }} +

+
+ + @if (!isKeyReadonly) { +
+
+ +
+
+ +
-
- + } @else { +
+
+ +
-
+ }
}
diff --git a/src/main/webapp/app/shared/user-settings/ssh-settings/ssh-user-settings.component.scss b/src/main/webapp/app/shared/user-settings/ssh-settings/ssh-user-settings.component.scss new file mode 100644 index 000000000000..8255e6ade0f4 --- /dev/null +++ b/src/main/webapp/app/shared/user-settings/ssh-settings/ssh-user-settings.component.scss @@ -0,0 +1,134 @@ +textarea { + width: 600px; + height: 150px; + font-size: small; + font-family: + Bitstream Vera Sans Mono, + Courier New, + monospace; +} + +table { + width: 100%; + border-collapse: collapse; + margin: 20px 0; + font-size: 16px; + text-align: left; +} + +th, +td { + padding: 15px 15px; +} + +/* Button styling */ + +.btn { + border-radius: 0; +} + +.container { + position: relative; +} + +.narrower-box { + max-width: 500px; + margin: 0 auto; +} + +.font-medium { + font-size: medium; +} + +.icon-column { + width: auto; + margin-right: 15px; +} + +.vertical-center { + margin: 0; + position: absolute; + top: 50%; + left: 50%; + -ms-transform: translateY(-50%); + transform: translateY(-50%); +} + +tbody tr:hover { + background-color: var(--ssh-key-table-hover-background); +} + +/* dd container */ +.dropdown { + display: inline-block; + position: relative; + outline: none; + margin: 0; +} + +/* button */ +.dropbtn { + padding: 0; + color: grey; + cursor: pointer; + transition: 0.35s ease-out; +} + +/* dd content */ +.dropdown .dropdown-content { + position: absolute; + top: 50%; + min-width: 120%; + box-shadow: 0 8px 16px var(--ssh-key-settings-shadow); + z-index: 100000; // makes sure the drop down menu is always shown at the highest view plane + visibility: hidden; + opacity: 1; + transition: 0.35s ease-out; + width: 80px; +} + +/* show dd content */ +.dropdown:focus .dropdown-content { + outline: none; + transform: translateY(20px); + visibility: visible; + opacity: 1; + background-color: var(--light); +} + +/* mask to close menu by clicking on the button */ +.dropdown .db2 { + position: absolute; + top: 0; + right: 0; + bottom: 0; + left: 0; + opacity: 0; + cursor: pointer; + z-index: 10; + display: none; +} + +.dropdown:focus .db2 { + display: inline-block; +} + +.dropdown .db2:focus .dropdown-content { + outline: none; + visibility: hidden; + margin-right: 15px; + opacity: 0; +} + +.dropdown-button { + margin: auto; + color: var(--ssh-key-settings-text-color); + background-color: var(--dropdown-bg); + border-color: var(--dropdown-bg); + width: 80px; +} + +.dropdown-button:hover { + background-color: var(--ssh-key-settings-dropdown-buttons-hover); + border-color: var(--ssh-key-settings-dropdown-buttons-hover); +} diff --git a/src/main/webapp/app/shared/user-settings/ssh-settings/ssh-user-settings.component.ts b/src/main/webapp/app/shared/user-settings/ssh-settings/ssh-user-settings.component.ts index 808fe99b016c..6fa6fbc9336e 100644 --- a/src/main/webapp/app/shared/user-settings/ssh-settings/ssh-user-settings.component.ts +++ b/src/main/webapp/app/shared/user-settings/ssh-settings/ssh-user-settings.component.ts @@ -4,27 +4,34 @@ import { AccountService } from 'app/core/auth/account.service'; import { Subject, Subscription, tap } from 'rxjs'; import { ProfileService } from 'app/shared/layouts/profiles/profile.service'; import { PROFILE_LOCALVC } from 'app/app.constants'; -import { faEdit, faSave, faTrash } from '@fortawesome/free-solid-svg-icons'; +import { faEdit, faEllipsis, faSave, faTrash } from '@fortawesome/free-solid-svg-icons'; import { DocumentationType } from 'app/shared/components/documentation-button/documentation-button.component'; import { ButtonSize, ButtonType } from 'app/shared/components/button.component'; import { AlertService } from 'app/core/util/alert.service'; +import { getOS } from 'app/shared/util/os-detector.util'; @Component({ selector: 'jhi-account-information', templateUrl: './ssh-user-settings.component.html', - styleUrls: ['../user-settings.scss'], + styleUrls: ['../user-settings.scss', './ssh-user-settings.component.scss'], }) export class SshUserSettingsComponent implements OnInit { readonly documentationType: DocumentationType = 'SshSetup'; currentUser?: User; localVCEnabled = false; sshKey = ''; + sshKeyHash = ''; storedSshKey = ''; - editSshKey = false; + showSshKey = false; + keyCount = 0; + isKeyReadonly = true; + copyInstructions = ''; readonly faEdit = faEdit; readonly faSave = faSave; readonly faTrash = faTrash; + readonly faEllipsis = faEllipsis; + private authStateSubscription: Subscription; private dialogErrorSource = new Subject(); @@ -40,14 +47,18 @@ export class SshUserSettingsComponent implements OnInit { this.profileService.getProfileInfo().subscribe((profileInfo) => { this.localVCEnabled = profileInfo.activeProfiles.includes(PROFILE_LOCALVC); }); - + this.setMessageBasedOnOS(getOS()); this.authStateSubscription = this.accountService .getAuthenticationState() .pipe( tap((user: User) => { this.storedSshKey = user.sshPublicKey || ''; this.sshKey = this.storedSshKey; + this.sshKeyHash = user.sshKeyHash || ''; this.currentUser = user; + // currently only 0 or 1 key are supported + this.keyCount = this.sshKey ? 1 : 0; + this.isKeyReadonly = !!this.sshKey; return this.currentUser; }), ) @@ -58,8 +69,10 @@ export class SshUserSettingsComponent implements OnInit { this.accountService.addSshPublicKey(this.sshKey).subscribe({ next: () => { this.alertService.success('artemisApp.userSettings.sshSettingsPage.saveSuccess'); - this.editSshKey = false; + this.showSshKey = false; this.storedSshKey = this.sshKey; + this.keyCount = this.keyCount + 1; + this.isKeyReadonly = true; }, error: () => { this.alertService.error('artemisApp.userSettings.sshSettingsPage.saveFailure'); @@ -68,12 +81,14 @@ export class SshUserSettingsComponent implements OnInit { } deleteSshKey() { - this.editSshKey = false; + this.showSshKey = false; this.accountService.deleteSshPublicKey().subscribe({ next: () => { this.alertService.success('artemisApp.userSettings.sshSettingsPage.deleteSuccess'); this.sshKey = ''; this.storedSshKey = ''; + this.keyCount = this.keyCount - 1; + this.isKeyReadonly = false; }, error: () => { this.alertService.error('artemisApp.userSettings.sshSettingsPage.deleteFailure'); @@ -83,10 +98,29 @@ export class SshUserSettingsComponent implements OnInit { } cancelEditingSshKey() { - this.editSshKey = !this.editSshKey; + this.showSshKey = !this.showSshKey; this.sshKey = this.storedSshKey; } protected readonly ButtonType = ButtonType; protected readonly ButtonSize = ButtonSize; + + private setMessageBasedOnOS(os: string): void { + switch (os) { + case 'Windows': + this.copyInstructions = 'cat ~/.ssh/id_ed25519.pub | clip'; + break; + case 'MacOS': + this.copyInstructions = 'pbcopy < ~/.ssh/id_ed25519.pub'; + break; + case 'Linux': + this.copyInstructions = 'xclip -selection clipboard < ~/.ssh/id_ed25519.pub'; + break; + case 'Android': + this.copyInstructions = 'termux-clipboard-set < ~/.ssh/id_ed25519.pub'; + break; + default: + this.copyInstructions = 'Ctrl + C'; + } + } } diff --git a/src/main/webapp/app/shared/user-settings/user-settings.module.ts b/src/main/webapp/app/shared/user-settings/user-settings.module.ts index bc91e586ecb2..fe912bdef56a 100644 --- a/src/main/webapp/app/shared/user-settings/user-settings.module.ts +++ b/src/main/webapp/app/shared/user-settings/user-settings.module.ts @@ -12,9 +12,10 @@ import { VcsAccessTokensSettingsComponent } from 'app/shared/user-settings/vcs-a import { ClipboardModule } from '@angular/cdk/clipboard'; import { FormDateTimePickerModule } from 'app/shared/date-time-picker/date-time-picker.module'; import { IdeSettingsComponent } from 'app/shared/user-settings/ide-preferences/ide-settings.component'; +import { DocumentationLinkComponent } from 'app/shared/components/documentation-link/documentation-link.component'; @NgModule({ - imports: [RouterModule.forChild(userSettingsState), ArtemisSharedModule, ArtemisSharedComponentModule, ClipboardModule, FormDateTimePickerModule], + imports: [RouterModule.forChild(userSettingsState), ArtemisSharedModule, ArtemisSharedComponentModule, ClipboardModule, FormDateTimePickerModule, DocumentationLinkComponent], declarations: [ UserSettingsContainerComponent, AccountInformationComponent, diff --git a/src/main/webapp/app/shared/user-settings/user-settings.scss b/src/main/webapp/app/shared/user-settings/user-settings.scss index 02a29cc3ae86..15bc60da27ed 100644 --- a/src/main/webapp/app/shared/user-settings/user-settings.scss +++ b/src/main/webapp/app/shared/user-settings/user-settings.scss @@ -19,11 +19,6 @@ dd { font-size: larger; } -span { - color: gray; - font-size: smaller; -} - .userSettings-info { span { font-style: italic; diff --git a/src/main/webapp/app/shared/util/os-detector.util.ts b/src/main/webapp/app/shared/util/os-detector.util.ts new file mode 100644 index 000000000000..59ef5027b69b --- /dev/null +++ b/src/main/webapp/app/shared/util/os-detector.util.ts @@ -0,0 +1,17 @@ +export function getOS(): string { + const userAgent = window.navigator.userAgent; + + if (userAgent.indexOf('Win') !== -1) { + return 'Windows'; + } else if (userAgent.indexOf('Mac') !== -1) { + return 'MacOS'; + } else if (/Android/.test(userAgent)) { + return 'Android'; + } else if (userAgent.indexOf('Linux') !== -1) { + return 'Linux'; + } else if (/iPhone|iPad|iPod/.test(userAgent)) { + return 'iOS'; + } else { + return 'Unknown'; + } +} diff --git a/src/main/webapp/content/scss/themes/_dark-variables.scss b/src/main/webapp/content/scss/themes/_dark-variables.scss index 40789ff78781..daa039c0e167 100644 --- a/src/main/webapp/content/scss/themes/_dark-variables.scss +++ b/src/main/webapp/content/scss/themes/_dark-variables.scss @@ -662,3 +662,10 @@ $iris-rate-background: var(--neutral-dark-l-15); // Image Cropper $cropper-overlay-color: transparent; + +// Settings +$ssh-key-table-hover-background: $gray-900; +$ssh-key-settings-dropdown-buttons: $gray-800; +$ssh-key-settings-dropdown-buttons-hover: $gray-700; +$ssh-key-settings-text-color: $white; +$ssh-key-settings-shadow: rgba(0, 0, 0, 0.5); diff --git a/src/main/webapp/content/scss/themes/_default-variables.scss b/src/main/webapp/content/scss/themes/_default-variables.scss index 92eca3165ea0..337a58ed3316 100644 --- a/src/main/webapp/content/scss/themes/_default-variables.scss +++ b/src/main/webapp/content/scss/themes/_default-variables.scss @@ -590,3 +590,10 @@ $iris-rate-background: var(--gray-300); // Image Cropper $cropper-overlay-color: transparent; + +// Settings +$ssh-key-settings-table-hover-background: $gray-200; +$ssh-key-settings-dropdown-buttons: $light; +$ssh-key-settings-dropdown-buttons-hover: $gray-200; +$ssh-key-settings-text-color: $black; +$ssh-key-settings-shadow: rgba(0, 0, 0, 0.2); diff --git a/src/main/webapp/i18n/de/userSettings.json b/src/main/webapp/i18n/de/userSettings.json index 1d5cbdacc854..6a2ebecc1763 100644 --- a/src/main/webapp/i18n/de/userSettings.json +++ b/src/main/webapp/i18n/de/userSettings.json @@ -27,11 +27,22 @@ "deleteFailure": "SSH-Schlüssel konnte nicht gelöscht werden.", "deleteSuccess": "SSH-Schlüssel erfolgreich gelöscht.", "cancelSavingSshKey": "Abbrechen", - "editExistingSshKey": "SSH-Schlüssel bearbeiten", - "addNewSshKey": "Neuer SSH-Schlüssel", + "editExistingSshKey": "Bearbeiten", + "viewExistingSshKey": "Ansehen", + "addNewSshKey": "SSH-Schlüssel hinzufügen", + "sshKeyDetails": "SSH-Schlüssel Informationen", "deleteSshKey": "Löschen", "sshKeyDisplayedInformation": "Das ist dein aktuell konfigurierter SSH-Schlüssel:", - "key": "SSH Schlüssel" + "key": "Schlüssel", + "noKeysHaveBeenAdded": "Es wurden noch keine SSH-Schlüssel hinzugefügt", + "whatToUseSSHForInfo": "Verwende SSH-Schlüssel, um einfach und sicher eine Verbindung zu Repositories herzustellen.", + "learnMore": "Erfahre mehr über SSH-Schlüssel", + "alreadyHaveKey": "Du hast bereits einen Schlüssel? Kopiere deinen Schlüssel in die Zwischenablage:", + "back": "Zurück", + "keysTablePageTitle": "SSH-Schlüssel", + "keys": "Schlüssel", + "actions": "Aktionen", + "keyName": "Key 1 (Aktuell wird nur ein Schlüssel unterstützt)" }, "vcsAccessTokensSettingsPage": { "addTokenTitle": "Neues Zugriffstoken erzeugen", @@ -56,7 +67,7 @@ "joinedArtemis": "Artemis beigetreten am", "profilePicture": "Profilbild", "addProfilePicture": "Profilbild hinzufügen", - "sshKey": "Öffentlicher SSH Schlüssel" + "sshKey": "Öffentlicher SSH-Schlüssel" }, "categories": { "NOTIFICATION_SETTINGS": "Benachrichtigungseinstellungen", diff --git a/src/main/webapp/i18n/en/userSettings.json b/src/main/webapp/i18n/en/userSettings.json index 328be05e823a..29afe83a0c3c 100644 --- a/src/main/webapp/i18n/en/userSettings.json +++ b/src/main/webapp/i18n/en/userSettings.json @@ -27,11 +27,22 @@ "deleteFailure": "Failed to delete SSH key.", "deleteSuccess": "Successfully deleted SSH key.", "cancelSavingSshKey": "Cancel", - "editExistingSshKey": "Edit SSH key", - "addNewSshKey": "New SSH key", + "editExistingSshKey": "Edit", + "viewExistingSshKey": "View", + "addNewSshKey": "Add SSH key", + "sshKeyDetails": "SSH key details", "deleteSshKey": "Delete", "sshKeyDisplayedInformation": "This is your currently configured SSH key:", - "key": "SSH Key" + "key": "Key", + "noKeysHaveBeenAdded": "No SSH keys have been added", + "whatToUseSSHForInfo": "Use SSH keys to connect simply and securely to repositories.", + "learnMore": "Learn more about SSH keys", + "alreadyHaveKey": "Already have a key? Copy your key to the clipboard:", + "back": "Back", + "keysTablePageTitle": "SSH keys", + "keys": "Keys", + "actions": "Actions", + "keyName": "Key 1 (at the moment you can only have one key)" }, "vcsAccessTokensSettingsPage": { "addTokenTitle": "Add personal access token", diff --git a/src/test/javascript/spec/component/account/ssh-user-settings.component.spec.ts b/src/test/javascript/spec/component/account/ssh-user-settings.component.spec.ts index c7b44b4f9e97..29b647dfb946 100644 --- a/src/test/javascript/spec/component/account/ssh-user-settings.component.spec.ts +++ b/src/test/javascript/spec/component/account/ssh-user-settings.component.spec.ts @@ -76,10 +76,10 @@ describe('SshUserSettingsComponent', () => { accountServiceMock.addSshPublicKey.mockReturnValue(of(new HttpResponse({ status: 200 }))); comp.ngOnInit(); comp.sshKey = 'new-key'; - comp.editSshKey = true; + comp.showSshKey = true; comp.saveSshKey(); expect(accountServiceMock.addSshPublicKey).toHaveBeenCalledWith('new-key'); - expect(comp.editSshKey).toBeFalse(); + expect(comp.showSshKey).toBeFalse(); }); it('should delete SSH key and disable edit mode', () => { @@ -87,10 +87,10 @@ describe('SshUserSettingsComponent', () => { comp.ngOnInit(); const empty = ''; comp.sshKey = 'new-key'; - comp.editSshKey = true; + comp.showSshKey = true; comp.deleteSshKey(); expect(accountServiceMock.deleteSshPublicKey).toHaveBeenCalled(); - expect(comp.editSshKey).toBeFalse(); + expect(comp.showSshKey).toBeFalse(); expect(comp.storedSshKey).toEqual(empty); }); @@ -113,12 +113,48 @@ describe('SshUserSettingsComponent', () => { const oldKey = 'old-key'; const newKey = 'new-key'; comp.sshKey = oldKey; - comp.editSshKey = true; + comp.showSshKey = true; comp.saveSshKey(); expect(comp.storedSshKey).toEqual(oldKey); - comp.editSshKey = true; + comp.showSshKey = true; comp.sshKey = newKey; comp.cancelEditingSshKey(); expect(comp.storedSshKey).toEqual(oldKey); }); + + it('should detect Windows', () => { + jest.spyOn(window.navigator, 'userAgent', 'get').mockReturnValue('Mozilla/5.0 (Windows NT 10.0; Win64; x64)'); + comp.ngOnInit(); + expect(comp.copyInstructions).toBe('cat ~/.ssh/id_ed25519.pub | clip'); + }); + + it('should detect MacOS', () => { + jest.spyOn(window.navigator, 'userAgent', 'get').mockReturnValue('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)'); + comp.ngOnInit(); + expect(comp.copyInstructions).toBe('pbcopy < ~/.ssh/id_ed25519.pub'); + }); + + it('should detect Linux', () => { + jest.spyOn(window.navigator, 'userAgent', 'get').mockReturnValue('Mozilla/5.0 (X11; Linux x86_64)'); + comp.ngOnInit(); + expect(comp.copyInstructions).toBe('xclip -selection clipboard < ~/.ssh/id_ed25519.pub'); + }); + + it('should detect Android', () => { + jest.spyOn(window.navigator, 'userAgent', 'get').mockReturnValue('Mozilla/5.0 (Linux; Android 10; Pixel 3)'); + comp.ngOnInit(); + expect(comp.copyInstructions).toBe('termux-clipboard-set < ~/.ssh/id_ed25519.pub'); + }); + + it('should detect iOS', () => { + jest.spyOn(window.navigator, 'userAgent', 'get').mockReturnValue('Mozilla/5.0 (iPhone; CPU iPhone OS 13_5)'); + comp.ngOnInit(); + expect(comp.copyInstructions).toBe('Ctrl + C'); + }); + + it('should return Unknown for unrecognized OS', () => { + jest.spyOn(window.navigator, 'userAgent', 'get').mockReturnValue('Mozilla/5.0 (Unknown OS)'); + comp.ngOnInit(); + expect(comp.copyInstructions).toBe('Ctrl + C'); + }); }); From 491e368a8052d9c6fd2e60d1904d90f46aed8ba2 Mon Sep 17 00:00:00 2001 From: Ole Vester <73833780+ole-ve@users.noreply.github.com> Date: Sat, 12 Oct 2024 17:30:12 +0200 Subject: [PATCH 06/23] Exam mode: Add summary to exam deletion dialog (#9185) --- .../artemis/communication/domain/Post.java | 4 + .../repository/AnswerPostRepository.java | 2 + .../repository/PostRepository.java | 4 + .../core/dto/CourseDeletionSummaryDTO.java | 7 + .../artemis/core/service/CourseService.java | 33 +++- .../core/web/admin/AdminCourseResource.java | 16 ++ .../exam/dto/ExamDeletionSummaryDTO.java | 8 + .../repository/StudentExamRepository.java | 4 + .../exam/service/ExamDeletionService.java | 48 +++++- .../aet/artemis/exam/web/ExamResource.java | 17 ++ .../repository/BuildJobRepository.java | 15 ++ .../ProgrammingExerciseRepository.java | 2 + .../app/course/manage/course-admin.service.ts | 9 ++ .../course-management-tab-bar.component.html | 2 + .../course-management-tab-bar.component.ts | 68 +++++++- .../entities/course-deletion-summary.model.ts | 5 + .../entities/exam-deletion-summary.model.ts | 9 ++ .../exam/manage/exam-management.service.ts | 10 ++ .../manage/exams/exam-detail.component.html | 2 + .../manage/exams/exam-detail.component.ts | 64 +++++++- .../delete-dialog/delete-button.directive.ts | 6 +- .../delete-dialog.component.html | 16 ++ .../delete-dialog/delete-dialog.component.ts | 4 +- .../delete-dialog/delete-dialog.model.ts | 14 ++ .../delete-dialog/delete-dialog.service.ts | 23 ++- src/main/webapp/i18n/de/course.json | 21 ++- src/main/webapp/i18n/de/exam.json | 21 ++- src/main/webapp/i18n/en/course.json | 21 ++- src/main/webapp/i18n/en/exam.json | 21 ++- .../util/ConversationUtilService.java | 1 + .../core/service/CourseServiceTest.java | 52 +++++++ .../exam/ExamDeletionIntegrationTest.java | 146 ++++++++++++++++++ .../artemis/exam/util/ExamUtilService.java | 41 +++++ 33 files changed, 703 insertions(+), 13 deletions(-) create mode 100644 src/main/java/de/tum/cit/aet/artemis/core/dto/CourseDeletionSummaryDTO.java create mode 100644 src/main/java/de/tum/cit/aet/artemis/exam/dto/ExamDeletionSummaryDTO.java create mode 100644 src/main/webapp/app/entities/course-deletion-summary.model.ts create mode 100644 src/main/webapp/app/entities/exam-deletion-summary.model.ts create mode 100644 src/test/java/de/tum/cit/aet/artemis/exam/ExamDeletionIntegrationTest.java diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/domain/Post.java b/src/main/java/de/tum/cit/aet/artemis/communication/domain/Post.java index d3bf4e217ea3..4ff2d48fedf5 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/domain/Post.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/domain/Post.java @@ -167,6 +167,10 @@ public void addTag(String tag) { this.tags.add(tag); } + public void setCourse(Course course) { + this.course = course; + } + public Conversation getConversation() { return conversation; } diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/repository/AnswerPostRepository.java b/src/main/java/de/tum/cit/aet/artemis/communication/repository/AnswerPostRepository.java index c6a915b994e2..db61138b3a73 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/repository/AnswerPostRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/repository/AnswerPostRepository.java @@ -30,4 +30,6 @@ default AnswerPost findAnswerPostByIdElseThrow(Long answerPostId) { default AnswerPost findAnswerMessageByIdElseThrow(Long answerPostId) { return getValueElseThrow(findById(answerPostId).filter(answerPost -> answerPost.getPost().getConversation() != null), answerPostId); } + + long countAnswerPostsByPostIdIn(List postIds); } diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/repository/PostRepository.java b/src/main/java/de/tum/cit/aet/artemis/communication/repository/PostRepository.java index 449a629fb4af..aacfbc33d179 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/repository/PostRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/repository/PostRepository.java @@ -45,4 +45,8 @@ default Post findPostByIdElseThrow(Long postId) throws EntityNotFoundException { default Post findPostOrMessagePostByIdElseThrow(Long postId) throws EntityNotFoundException { return getValueElseThrow(findById(postId), postId); } + + List findAllByConversationId(Long conversationId); + + List findAllByCourseId(Long courseId); } diff --git a/src/main/java/de/tum/cit/aet/artemis/core/dto/CourseDeletionSummaryDTO.java b/src/main/java/de/tum/cit/aet/artemis/core/dto/CourseDeletionSummaryDTO.java new file mode 100644 index 000000000000..2f3b8d51596c --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/core/dto/CourseDeletionSummaryDTO.java @@ -0,0 +1,7 @@ +package de.tum.cit.aet.artemis.core.dto; + +import com.fasterxml.jackson.annotation.JsonInclude; + +@JsonInclude(JsonInclude.Include.NON_EMPTY) +public record CourseDeletionSummaryDTO(long numberOfBuilds, long numberOfCommunicationPosts, long numberOfAnswerPosts) { +} diff --git a/src/main/java/de/tum/cit/aet/artemis/core/service/CourseService.java b/src/main/java/de/tum/cit/aet/artemis/core/service/CourseService.java index 01bb68edc441..cba16e58ad7e 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/service/CourseService.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/service/CourseService.java @@ -58,9 +58,12 @@ import de.tum.cit.aet.artemis.atlas.repository.PrerequisiteRepository; import de.tum.cit.aet.artemis.atlas.service.learningpath.LearningPathService; import de.tum.cit.aet.artemis.communication.domain.NotificationType; +import de.tum.cit.aet.artemis.communication.domain.Post; import de.tum.cit.aet.artemis.communication.domain.notification.GroupNotification; +import de.tum.cit.aet.artemis.communication.repository.AnswerPostRepository; import de.tum.cit.aet.artemis.communication.repository.FaqRepository; import de.tum.cit.aet.artemis.communication.repository.GroupNotificationRepository; +import de.tum.cit.aet.artemis.communication.repository.PostRepository; import de.tum.cit.aet.artemis.communication.repository.conversation.ConversationRepository; import de.tum.cit.aet.artemis.communication.service.notifications.GroupNotificationService; import de.tum.cit.aet.artemis.core.config.Constants; @@ -68,6 +71,7 @@ import de.tum.cit.aet.artemis.core.domain.DomainObject; import de.tum.cit.aet.artemis.core.domain.User; import de.tum.cit.aet.artemis.core.dto.CourseContentCount; +import de.tum.cit.aet.artemis.core.dto.CourseDeletionSummaryDTO; import de.tum.cit.aet.artemis.core.dto.CourseManagementDetailViewDTO; import de.tum.cit.aet.artemis.core.dto.DueDateStat; import de.tum.cit.aet.artemis.core.dto.SearchResultPageDTO; @@ -104,6 +108,7 @@ import de.tum.cit.aet.artemis.plagiarism.domain.PlagiarismCase; import de.tum.cit.aet.artemis.plagiarism.repository.PlagiarismCaseRepository; import de.tum.cit.aet.artemis.programming.domain.ProgrammingExercise; +import de.tum.cit.aet.artemis.programming.repository.BuildJobRepository; import de.tum.cit.aet.artemis.programming.repository.ProgrammingExerciseRepository; import de.tum.cit.aet.artemis.tutorialgroup.repository.TutorialGroupNotificationRepository; import de.tum.cit.aet.artemis.tutorialgroup.repository.TutorialGroupRepository; @@ -201,6 +206,12 @@ public class CourseService { private final TutorialGroupNotificationRepository tutorialGroupNotificationRepository; + private final PostRepository postRepository; + + private final AnswerPostRepository answerPostRepository; + + private final BuildJobRepository buildJobRepository; + public CourseService(CourseRepository courseRepository, ExerciseService exerciseService, ExerciseDeletionService exerciseDeletionService, AuthorizationCheckService authCheckService, UserRepository userRepository, LectureService lectureService, GroupNotificationRepository groupNotificationRepository, ExerciseGroupRepository exerciseGroupRepository, AuditEventRepository auditEventRepository, UserService userService, ExamDeletionService examDeletionService, @@ -213,7 +224,8 @@ public CourseService(CourseRepository courseRepository, ExerciseService exercise TutorialGroupRepository tutorialGroupRepository, PlagiarismCaseRepository plagiarismCaseRepository, ConversationRepository conversationRepository, LearningPathService learningPathService, Optional irisSettingsService, LectureRepository lectureRepository, TutorialGroupNotificationRepository tutorialGroupNotificationRepository, TutorialGroupChannelManagementService tutorialGroupChannelManagementService, - PrerequisiteRepository prerequisiteRepository, CompetencyRelationRepository competencyRelationRepository, FaqRepository faqRepository) { + PrerequisiteRepository prerequisiteRepository, CompetencyRelationRepository competencyRelationRepository, PostRepository postRepository, + AnswerPostRepository answerPostRepository, BuildJobRepository buildJobRepository, FaqRepository faqRepository) { this.courseRepository = courseRepository; this.exerciseService = exerciseService; this.exerciseDeletionService = exerciseDeletionService; @@ -253,6 +265,9 @@ public CourseService(CourseRepository courseRepository, ExerciseService exercise this.tutorialGroupChannelManagementService = tutorialGroupChannelManagementService; this.prerequisiteRepository = prerequisiteRepository; this.competencyRelationRepository = competencyRelationRepository; + this.buildJobRepository = buildJobRepository; + this.postRepository = postRepository; + this.answerPostRepository = answerPostRepository; this.faqRepository = faqRepository; } @@ -444,6 +459,22 @@ public Set findAllOnlineCoursesForPlatformForUser(String registrationId, .collect(Collectors.toSet()); } + /** + * Get the course deletion summary for the given course. + * + * @param course the course for which to get the deletion summary + * @return the course deletion summary + */ + public CourseDeletionSummaryDTO getDeletionSummary(Course course) { + List programmingExerciseIds = course.getExercises().stream().map(Exercise::getId).toList(); + long numberOfBuilds = buildJobRepository.countBuildJobsByExerciseIds(programmingExerciseIds); + + List posts = postRepository.findAllByCourseId(course.getId()); + long numberOfCommunicationPosts = posts.size(); + long numberOfAnswerPosts = answerPostRepository.countAnswerPostsByPostIdIn(posts.stream().map(Post::getId).toList()); + return new CourseDeletionSummaryDTO(numberOfBuilds, numberOfCommunicationPosts, numberOfAnswerPosts); + } + /** * Deletes all elements associated with the course including: *
    diff --git a/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminCourseResource.java b/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminCourseResource.java index 9cdcc9486f52..b83f757209c4 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminCourseResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminCourseResource.java @@ -34,6 +34,7 @@ import de.tum.cit.aet.artemis.core.config.Constants; import de.tum.cit.aet.artemis.core.domain.Course; import de.tum.cit.aet.artemis.core.domain.User; +import de.tum.cit.aet.artemis.core.dto.CourseDeletionSummaryDTO; import de.tum.cit.aet.artemis.core.exception.BadRequestAlertException; import de.tum.cit.aet.artemis.core.repository.CourseRepository; import de.tum.cit.aet.artemis.core.repository.UserRepository; @@ -181,6 +182,21 @@ public ResponseEntity deleteCourse(@PathVariable long courseId) { return ResponseEntity.ok().headers(HeaderUtil.createEntityDeletionAlert(applicationName, true, Course.ENTITY_NAME, course.getTitle())).build(); } + /** + * GET /courses/:courseId/deletion-summary : get the deletion summary for the course with the given id. + * + * @param courseId the id of the course + * @return the ResponseEntity with status 200 (OK) and the deletion summary in the body + */ + @GetMapping("courses/{courseId}/deletion-summary") + @EnforceAdmin + public ResponseEntity getDeletionSummary(@PathVariable long courseId) { + log.debug("REST request to get deletion summary course: {}", courseId); + final Course course = courseRepository.findByIdWithEagerExercisesElseThrow(courseId); + + return ResponseEntity.ok().body(courseService.getDeletionSummary(course)); + } + /** * Creates a default channel with the given name and adds all students, tutors and instructors as participants. * diff --git a/src/main/java/de/tum/cit/aet/artemis/exam/dto/ExamDeletionSummaryDTO.java b/src/main/java/de/tum/cit/aet/artemis/exam/dto/ExamDeletionSummaryDTO.java new file mode 100644 index 000000000000..c0cd6608ec2c --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/exam/dto/ExamDeletionSummaryDTO.java @@ -0,0 +1,8 @@ +package de.tum.cit.aet.artemis.exam.dto; + +import com.fasterxml.jackson.annotation.JsonInclude; + +@JsonInclude(JsonInclude.Include.NON_EMPTY) +public record ExamDeletionSummaryDTO(long numberOfBuilds, long numberOfCommunicationPosts, long numberOfAnswerPosts, long numberRegisteredStudents, long numberNotStartedExams, + long numberStartedExams, long numberSubmittedExams) { +} diff --git a/src/main/java/de/tum/cit/aet/artemis/exam/repository/StudentExamRepository.java b/src/main/java/de/tum/cit/aet/artemis/exam/repository/StudentExamRepository.java index 2236d4d2035c..4d3bcfe61369 100644 --- a/src/main/java/de/tum/cit/aet/artemis/exam/repository/StudentExamRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/exam/repository/StudentExamRepository.java @@ -245,6 +245,10 @@ SELECT MAX(se.workingTime) """) Set findAllUnsubmittedWithExercisesByExamId(@Param("examId") Long examId); + List findAllByExamId(Long examId); + + List findAllByExamId_AndTestRunIsTrue(Long examId); + @Query(""" SELECT DISTINCT se FROM StudentExam se diff --git a/src/main/java/de/tum/cit/aet/artemis/exam/service/ExamDeletionService.java b/src/main/java/de/tum/cit/aet/artemis/exam/service/ExamDeletionService.java index a8fd46512528..1c05e1d4be65 100644 --- a/src/main/java/de/tum/cit/aet/artemis/exam/service/ExamDeletionService.java +++ b/src/main/java/de/tum/cit/aet/artemis/exam/service/ExamDeletionService.java @@ -20,7 +20,10 @@ import de.tum.cit.aet.artemis.assessment.domain.GradingScale; import de.tum.cit.aet.artemis.assessment.repository.GradingScaleRepository; +import de.tum.cit.aet.artemis.communication.domain.Post; import de.tum.cit.aet.artemis.communication.domain.conversation.Channel; +import de.tum.cit.aet.artemis.communication.repository.AnswerPostRepository; +import de.tum.cit.aet.artemis.communication.repository.PostRepository; import de.tum.cit.aet.artemis.communication.repository.conversation.ChannelRepository; import de.tum.cit.aet.artemis.communication.service.conversation.ChannelService; import de.tum.cit.aet.artemis.core.config.Constants; @@ -29,13 +32,16 @@ import de.tum.cit.aet.artemis.exam.domain.Exam; import de.tum.cit.aet.artemis.exam.domain.ExerciseGroup; import de.tum.cit.aet.artemis.exam.domain.StudentExam; +import de.tum.cit.aet.artemis.exam.dto.ExamDeletionSummaryDTO; import de.tum.cit.aet.artemis.exam.repository.ExamLiveEventRepository; import de.tum.cit.aet.artemis.exam.repository.ExamRepository; import de.tum.cit.aet.artemis.exam.repository.StudentExamRepository; import de.tum.cit.aet.artemis.exercise.domain.Exercise; +import de.tum.cit.aet.artemis.exercise.domain.ExerciseType; import de.tum.cit.aet.artemis.exercise.repository.StudentParticipationRepository; import de.tum.cit.aet.artemis.exercise.service.ExerciseDeletionService; import de.tum.cit.aet.artemis.exercise.service.ParticipationService; +import de.tum.cit.aet.artemis.programming.repository.BuildJobRepository; import de.tum.cit.aet.artemis.quiz.domain.QuizPool; import de.tum.cit.aet.artemis.quiz.repository.QuizPoolRepository; @@ -71,10 +77,17 @@ public class ExamDeletionService { private final QuizPoolRepository quizPoolRepository; + private final BuildJobRepository buildJobRepository; + + private final PostRepository postRepository; + + private final AnswerPostRepository answerPostRepository; + public ExamDeletionService(ExerciseDeletionService exerciseDeletionService, ParticipationService participationService, CacheManager cacheManager, UserRepository userRepository, ExamRepository examRepository, AuditEventRepository auditEventRepository, StudentExamRepository studentExamRepository, GradingScaleRepository gradingScaleRepository, StudentParticipationRepository studentParticipationRepository, ChannelRepository channelRepository, ChannelService channelService, - ExamLiveEventRepository examLiveEventRepository, QuizPoolRepository quizPoolRepository) { + ExamLiveEventRepository examLiveEventRepository, QuizPoolRepository quizPoolRepository, BuildJobRepository buildJobRepository, PostRepository postRepository, + AnswerPostRepository answerPostRepository) { this.exerciseDeletionService = exerciseDeletionService; this.participationService = participationService; this.cacheManager = cacheManager; @@ -88,6 +101,9 @@ public ExamDeletionService(ExerciseDeletionService exerciseDeletionService, Part this.channelService = channelService; this.examLiveEventRepository = examLiveEventRepository; this.quizPoolRepository = quizPoolRepository; + this.buildJobRepository = buildJobRepository; + this.postRepository = postRepository; + this.answerPostRepository = answerPostRepository; } /** @@ -240,4 +256,34 @@ public void deleteTestRun(Long testRunId) { log.info("Request to delete Test Run {}", testRunId); studentExamRepository.deleteById(testRunId); } + + /** + * Get the exam deletion summary for the given exam. + * + * @param examId the ID of the exam for which the deletion summary should be fetched + * @return the exam deletion summary + */ + public ExamDeletionSummaryDTO getExamDeletionSummary(@NotNull long examId) { + Exam exam = examRepository.findOneWithEagerExercisesGroupsAndStudentExams(examId); + long numberOfBuilds = exam.getExerciseGroups().stream().flatMap(group -> group.getExercises().stream()) + .filter(exercise -> ExerciseType.PROGRAMMING.equals(exercise.getExerciseType())) + .mapToLong(exercise -> buildJobRepository.countBuildJobsByExerciseIds(List.of(exercise.getId()))).sum(); + + Channel channel = channelRepository.findChannelByExamId(examId); + Long conversationId = channel.getId(); + + List postIds = postRepository.findAllByConversationId(conversationId).stream().map(Post::getId).toList(); + long numberOfCommunicationPosts = postIds.size(); + long numberOfAnswerPosts = answerPostRepository.countAnswerPostsByPostIdIn(postIds); + + Set studentExams = exam.getStudentExams(); + long numberRegisteredStudents = studentExams.size(); + + // Boolean.TRUE/Boolean.FALSE are used to handle the case where isStarted/isSubmitted is null + long notStartedExams = studentExams.stream().filter(studentExam -> studentExam.isStarted() == null || !studentExam.isStarted()).count(); + long startedExams = studentExams.stream().filter(studentExam -> Boolean.TRUE.equals(studentExam.isStarted())).count(); + long submittedExams = studentExams.stream().filter(studentExam -> Boolean.TRUE.equals(studentExam.isStarted()) && Boolean.TRUE.equals(studentExam.isSubmitted())).count(); + + return new ExamDeletionSummaryDTO(numberOfBuilds, numberOfCommunicationPosts, numberOfAnswerPosts, numberRegisteredStudents, notStartedExams, startedExams, submittedExams); + } } diff --git a/src/main/java/de/tum/cit/aet/artemis/exam/web/ExamResource.java b/src/main/java/de/tum/cit/aet/artemis/exam/web/ExamResource.java index 209f2a4fa040..8223ba8e54a9 100644 --- a/src/main/java/de/tum/cit/aet/artemis/exam/web/ExamResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/exam/web/ExamResource.java @@ -77,6 +77,7 @@ 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.enforceRoleInCourse.EnforceAtLeastInstructorInCourse; import de.tum.cit.aet.artemis.core.service.AuthorizationCheckService; import de.tum.cit.aet.artemis.core.service.feature.Feature; import de.tum.cit.aet.artemis.core.service.feature.FeatureToggle; @@ -88,6 +89,7 @@ import de.tum.cit.aet.artemis.exam.domain.StudentExam; import de.tum.cit.aet.artemis.exam.domain.SuspiciousSessionsAnalysisOptions; import de.tum.cit.aet.artemis.exam.dto.ExamChecklistDTO; +import de.tum.cit.aet.artemis.exam.dto.ExamDeletionSummaryDTO; import de.tum.cit.aet.artemis.exam.dto.ExamInformationDTO; import de.tum.cit.aet.artemis.exam.dto.ExamScoresDTO; import de.tum.cit.aet.artemis.exam.dto.ExamUserDTO; @@ -1320,4 +1322,19 @@ public ResponseEntity> getAllSuspiciousExamSessio analyzeSessionsIpOutsideOfRange); return ResponseEntity.ok(examSessionService.retrieveAllSuspiciousExamSessionsByExamId(examId, options, Optional.ofNullable(ipSubnet))); } + + /** + * GET /courses/{courseId}/exams/{examId}/deletion-summary : Get a summary of the deletion of an exam. + * + * @param courseId the id of the course + * @param examId the id of the exam + * + * @return the ResponseEntity with status 200 (OK) and with body a summary of the deletion of the exam + */ + @GetMapping("courses/{courseId}/exams/{examId}/deletion-summary") + @EnforceAtLeastInstructorInCourse + public ResponseEntity getDeletionSummary(@PathVariable long courseId, @PathVariable long examId) { + log.debug("REST request to get deletion summary for exam : {}", examId); + return ResponseEntity.ok(examDeletionService.getExamDeletionSummary(examId)); + } } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/repository/BuildJobRepository.java b/src/main/java/de/tum/cit/aet/artemis/programming/repository/BuildJobRepository.java index 7c341585f60f..d7a5e662c744 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/repository/BuildJobRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/repository/BuildJobRepository.java @@ -89,4 +89,19 @@ default BuildJob findByBuildJobIdElseThrow(String buildJobId) { return getValueElseThrow(findByBuildJobId(buildJobId)); } + /** + * Get the number of build jobs for a list of exercise ids. + * + * @param exerciseIds the list of exercise ids + * @return the number of build jobs + */ + @Query(""" + SELECT COUNT(b) + FROM BuildJob b + LEFT JOIN Result r ON b.result.id = r.id + LEFT JOIN Participation p ON r.participation.id = p.id + LEFT JOIN Exercise e ON p.exercise.id = e.id + WHERE e.id IN :exerciseIds + """) + long countBuildJobsByExerciseIds(@Param("exerciseIds") List exerciseIds); } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/repository/ProgrammingExerciseRepository.java b/src/main/java/de/tum/cit/aet/artemis/programming/repository/ProgrammingExerciseRepository.java index ab64ca6e53a8..579d714b18a8 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/repository/ProgrammingExerciseRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/repository/ProgrammingExerciseRepository.java @@ -116,6 +116,8 @@ Optional findWithTemplateAndSolutionParticipationTeamAssign List findAllByProjectKey(String projectKey); + List findAllByCourseId(Long courseId); + @EntityGraph(type = LOAD, attributePaths = "submissionPolicy") List findWithSubmissionPolicyByProjectKey(String projectKey); diff --git a/src/main/webapp/app/course/manage/course-admin.service.ts b/src/main/webapp/app/course/manage/course-admin.service.ts index fe7ceef20670..1185c439a8d2 100644 --- a/src/main/webapp/app/course/manage/course-admin.service.ts +++ b/src/main/webapp/app/course/manage/course-admin.service.ts @@ -5,6 +5,7 @@ import { map } from 'rxjs/operators'; import { Course } from 'app/entities/course.model'; import { objectToJsonBlob } from 'app/utils/blob-util'; import { CourseManagementService } from 'app/course/manage/course-management.service'; +import { CourseDeletionSummaryDTO } from 'app/entities/course-deletion-summary.model'; export type EntityResponseType = HttpResponse; export type EntityArrayResponseType = HttpResponse; @@ -51,4 +52,12 @@ export class CourseAdminService { delete(courseId: number): Observable> { return this.http.delete(`${this.resourceUrl}/${courseId}`, { observe: 'response' }); } + + /** + * Returns a summary for the course providing information potentially relevant for the deletion. + * @param courseId - the id of the course to get the deletion summary for + */ + getDeletionSummary(courseId: number): Observable> { + return this.http.get(`${this.resourceUrl}/${courseId}/deletion-summary`, { observe: 'response' }); + } } diff --git a/src/main/webapp/app/course/manage/course-management-tab-bar/course-management-tab-bar.component.html b/src/main/webapp/app/course/manage/course-management-tab-bar/course-management-tab-bar.component.html index abbfdaf7c010..bc10fd753a7c 100644 --- a/src/main/webapp/app/course/manage/course-management-tab-bar/course-management-tab-bar.component.html +++ b/src/main/webapp/app/course/manage/course-management-tab-bar/course-management-tab-bar.component.html @@ -107,6 +107,8 @@ [buttonSize]="ButtonSize.MEDIUM" jhiDeleteButton [entityTitle]="course.title || ''" + entitySummaryTitle="artemisApp.course.delete.summary.title" + [fetchEntitySummary]="fetchCourseDeletionSummary()" deleteQuestion="artemisApp.course.delete.question" deleteConfirmationText="artemisApp.course.delete.typeNameToConfirm" (delete)="deleteCourse(course.id!)" diff --git a/src/main/webapp/app/course/manage/course-management-tab-bar/course-management-tab-bar.component.ts b/src/main/webapp/app/course/manage/course-management-tab-bar/course-management-tab-bar.component.ts index c25c182067e3..e4b3865d3dbc 100644 --- a/src/main/webapp/app/course/manage/course-management-tab-bar/course-management-tab-bar.component.ts +++ b/src/main/webapp/app/course/manage/course-management-tab-bar/course-management-tab-bar.component.ts @@ -1,7 +1,7 @@ import { AfterViewInit, Component, OnDestroy, OnInit } from '@angular/core'; import { ActivatedRoute, Router } from '@angular/router'; import { HttpErrorResponse } from '@angular/common/http'; -import { Subject, Subscription } from 'rxjs'; +import { Observable, Subject, Subscription, map, of } from 'rxjs'; import { Course, isCommunicationEnabled } from 'app/entities/course.model'; import { CourseManagementService } from 'app/course/manage/course-management.service'; import { ButtonSize } from 'app/shared/components/button.component'; @@ -34,6 +34,8 @@ import { ProfileService } from 'app/shared/layouts/profiles/profile.service'; import { PROFILE_IRIS, PROFILE_LOCALCI, PROFILE_LTI } from 'app/app.constants'; import { CourseAccessStorageService } from 'app/course/course-access-storage.service'; import { scrollToTopOfPage } from 'app/shared/util/utils'; +import { ExerciseType } from 'app/entities/exercise.model'; +import { EntitySummary } from 'app/shared/delete-dialog/delete-dialog.model'; @Component({ selector: 'jhi-course-management-tab-bar', @@ -200,4 +202,68 @@ export class CourseManagementTabBarComponent implements OnInit, OnDestroy, After const courseManagementRegex = /course-management\/[0-9]+(\/edit)?$/; return courseManagementRegex.test(this.router.url); } + + private getExistingSummaryEntries(): EntitySummary { + const numberRepositories = + this.course?.exercises + ?.filter((exercise) => exercise.type === 'programming') + .map((exercise) => exercise?.numberOfParticipations ?? 0) + .reduce((repositorySum, numberOfParticipationsForRepository) => repositorySum + numberOfParticipationsForRepository, 0) ?? 0; + + const numberOfExercisesPerType = new Map(); + this.course?.exercises?.forEach((exercise) => { + if (exercise.type === undefined) { + return; + } + const oldValue = numberOfExercisesPerType.get(exercise.type) ?? 0; + numberOfExercisesPerType.set(exercise.type, oldValue + 1); + }); + + const numberExams = this.course?.numberOfExams ?? 0; + const numberLectures = this.course?.lectures?.length ?? 0; + const numberStudents = this.course?.numberOfStudents ?? 0; + const numberTutors = this.course?.numberOfTeachingAssistants ?? 0; + const numberEditors = this.course?.numberOfEditors ?? 0; + const numberInstructors = this.course?.numberOfInstructors ?? 0; + const isTestCourse = this.course?.testCourse; + + return { + 'artemisApp.course.delete.summary.numberRepositories': numberRepositories, + 'artemisApp.course.delete.summary.numberProgrammingExercises': numberOfExercisesPerType.get(ExerciseType.PROGRAMMING) ?? 0, + 'artemisApp.course.delete.summary.numberModelingExercises': numberOfExercisesPerType.get(ExerciseType.MODELING) ?? 0, + 'artemisApp.course.delete.summary.numberTextExercises': numberOfExercisesPerType.get(ExerciseType.TEXT) ?? 0, + 'artemisApp.course.delete.summary.numberFileUploadExercises': numberOfExercisesPerType.get(ExerciseType.FILE_UPLOAD) ?? 0, + 'artemisApp.course.delete.summary.numberQuizExercises': numberOfExercisesPerType.get(ExerciseType.QUIZ) ?? 0, + 'artemisApp.course.delete.summary.numberExams': numberExams, + 'artemisApp.course.delete.summary.numberLectures': numberLectures, + 'artemisApp.course.delete.summary.numberStudents': numberStudents, + 'artemisApp.course.delete.summary.numberTutors': numberTutors, + 'artemisApp.course.delete.summary.numberEditors': numberEditors, + 'artemisApp.course.delete.summary.numberInstructors': numberInstructors, + 'artemisApp.course.delete.summary.isTestCourse': isTestCourse, + }; + } + + fetchCourseDeletionSummary(): Observable { + if (this.course?.id === undefined) { + return of({}); + } + + return this.courseAdminService.getDeletionSummary(this.course.id).pipe( + map((response) => { + const summary = response.body; + + if (summary === null) { + return {}; + } + + return { + ...this.getExistingSummaryEntries(), + 'artemisApp.course.delete.summary.numberBuilds': summary.numberOfBuilds, + 'artemisApp.course.delete.summary.numberCommunicationPosts': summary.numberOfCommunicationPosts, + 'artemisApp.course.delete.summary.numberAnswerPosts': summary.numberOfAnswerPosts, + }; + }), + ); + } } diff --git a/src/main/webapp/app/entities/course-deletion-summary.model.ts b/src/main/webapp/app/entities/course-deletion-summary.model.ts new file mode 100644 index 000000000000..606a9d440d49 --- /dev/null +++ b/src/main/webapp/app/entities/course-deletion-summary.model.ts @@ -0,0 +1,5 @@ +export interface CourseDeletionSummaryDTO { + numberOfBuilds: number; + numberOfCommunicationPosts: number; + numberOfAnswerPosts: number; +} diff --git a/src/main/webapp/app/entities/exam-deletion-summary.model.ts b/src/main/webapp/app/entities/exam-deletion-summary.model.ts new file mode 100644 index 000000000000..ed98a32d1628 --- /dev/null +++ b/src/main/webapp/app/entities/exam-deletion-summary.model.ts @@ -0,0 +1,9 @@ +export interface ExamDeletionSummaryDTO { + numberOfBuilds: number; + numberOfCommunicationPosts: number; + numberOfAnswerPosts: number; + numberRegisteredStudents: number; + numberNotStartedExams: number; + numberStartedExams: number; + numberSubmittedExams: number; +} diff --git a/src/main/webapp/app/exam/manage/exam-management.service.ts b/src/main/webapp/app/exam/manage/exam-management.service.ts index ef0a74bd28fc..24425d3a530e 100644 --- a/src/main/webapp/app/exam/manage/exam-management.service.ts +++ b/src/main/webapp/app/exam/manage/exam-management.service.ts @@ -21,6 +21,7 @@ import { EntityTitleService, EntityType } from 'app/shared/layouts/navbar/entity import { ExamExerciseStartPreparationStatus } from 'app/exam/manage/student-exams/student-exams.component'; import { Exercise } from 'app/entities/exercise.model'; import { ExamWideAnnouncementEvent } from 'app/exam/participate/exam-participation-live-events.service'; +import { ExamDeletionSummaryDTO } from 'app/entities/exam-deletion-summary.model'; type EntityResponseType = HttpResponse; type EntityArrayResponseType = HttpResponse; @@ -208,6 +209,15 @@ export class ExamManagementService { ); } + /** + * Returns a summary for the exam providing information potentially relevant for the deletion. + * @param courseId The course id. + * @param examId The exam id. + */ + getDeletionSummary(courseId: number, examId: number): Observable> { + return this.http.get(`${this.resourceUrl}/${courseId}/exams/${examId}/deletion-summary`, { observe: 'response' }); + } + /** * Delete an exam on the server using a DELETE request. * @param courseId The course id. diff --git a/src/main/webapp/app/exam/manage/exams/exam-detail.component.html b/src/main/webapp/app/exam/manage/exams/exam-detail.component.html index 243126fc3758..18dfd2f261a6 100644 --- a/src/main/webapp/app/exam/manage/exams/exam-detail.component.html +++ b/src/main/webapp/app/exam/manage/exams/exam-detail.component.html @@ -87,6 +87,8 @@

    jhiDeleteButton [buttonSize]="buttonSize" [entityTitle]="exam.title || ''" + entitySummaryTitle="artemisApp.examManagement.delete.summary.title" + [fetchEntitySummary]="fetchExamDeletionSummary()" deleteQuestion="artemisApp.examManagement.delete.question" deleteConfirmationText="artemisApp.examManagement.delete.typeNameToConfirm" (delete)="deleteExam(exam.id!)" diff --git a/src/main/webapp/app/exam/manage/exams/exam-detail.component.ts b/src/main/webapp/app/exam/manage/exams/exam-detail.component.ts index 21638aa00238..c0f4130e83c1 100644 --- a/src/main/webapp/app/exam/manage/exams/exam-detail.component.ts +++ b/src/main/webapp/app/exam/manage/exams/exam-detail.component.ts @@ -2,9 +2,9 @@ import { Component, OnDestroy, OnInit } from '@angular/core'; import { ActivatedRoute, Router } from '@angular/router'; import { SafeHtml } from '@angular/platform-browser'; import { HttpErrorResponse, HttpResponse } from '@angular/common/http'; -import { Subject } from 'rxjs'; +import { Observable, Subject, map } from 'rxjs'; import { Exam } from 'app/entities/exam/exam.model'; -import { ActionType } from 'app/shared/delete-dialog/delete-dialog.model'; +import { ActionType, EntitySummary } from 'app/shared/delete-dialog/delete-dialog.model'; import { ButtonSize } from 'app/shared/components/button.component'; import { ArtemisMarkdownService } from 'app/shared/markdown.service'; import { AccountService } from 'app/core/auth/account.service'; @@ -17,6 +17,7 @@ import { GradeType } from 'app/entities/grading-scale.model'; import { DetailOverviewSection, DetailType } from 'app/detail-overview-list/detail-overview-list.component'; import { ArtemisDurationFromSecondsPipe } from 'app/shared/pipes/artemis-duration-from-seconds.pipe'; import { scrollToTopOfPage } from 'app/shared/util/utils'; +import { ExerciseType } from 'app/entities/exercise.model'; @Component({ selector: 'jhi-exam-detail', @@ -160,4 +161,63 @@ export class ExamDetailComponent implements OnInit, OnDestroy { error: (error: HttpErrorResponse) => this.dialogErrorSource.next(error.message), }); } + + private getExistingSummaryEntries(): EntitySummary { + const numberOfProgrammingExerciseParticipations = + this.exam.exerciseGroups + ?.flatMap((exerciseGroup) => exerciseGroup.exercises) + .filter((exercise) => exercise?.type === ExerciseType.PROGRAMMING) + .map((exercise) => exercise?.numberOfParticipations ?? 0) + .reduce((repositorySum, numberOfParticipationsForRepository) => repositorySum + numberOfParticipationsForRepository, 0) ?? 0; + + const numberOfExercisesPerType = new Map(); + this.exam.exerciseGroups?.forEach((exerciseGroup) => { + exerciseGroup.exercises?.forEach((exercise) => { + if (exercise.type === undefined) { + return; + } + const oldValue = numberOfExercisesPerType.get(exercise.type) ?? 0; + numberOfExercisesPerType.set(exercise.type, oldValue + 1); + }); + }); + + const numberOfExerciseGroups = this.exam.exerciseGroups?.length ?? 0; + const isTestExam = this.exam.testExam ?? false; + const isTestCourse = this.exam.course?.testCourse ?? false; + + return { + 'artemisApp.examManagement.delete.summary.numberExerciseGroups': numberOfExerciseGroups, + 'artemisApp.examManagement.delete.summary.numberProgrammingExercises': numberOfExercisesPerType.get(ExerciseType.PROGRAMMING), + 'artemisApp.examManagement.delete.summary.numberModelingExercises': numberOfExercisesPerType.get(ExerciseType.MODELING), + 'artemisApp.examManagement.delete.summary.numberTextExercises': numberOfExercisesPerType.get(ExerciseType.TEXT), + 'artemisApp.examManagement.delete.summary.numberFileUploadExercises': numberOfExercisesPerType.get(ExerciseType.FILE_UPLOAD), + 'artemisApp.examManagement.delete.summary.numberQuizExercises': numberOfExercisesPerType.get(ExerciseType.QUIZ), + 'artemisApp.examManagement.delete.summary.numberRepositories': numberOfProgrammingExerciseParticipations, + 'artemisApp.examManagement.delete.summary.isTestExam': isTestExam, + 'artemisApp.examManagement.delete.summary.isTestCourse': isTestCourse, + }; + } + + fetchExamDeletionSummary(): Observable { + return this.examManagementService.getDeletionSummary(this.exam.course!.id!, this.exam.id!).pipe( + map((response) => { + const summary = response.body; + + if (summary === null) { + return {}; + } + + return { + ...this.getExistingSummaryEntries(), + 'artemisApp.examManagement.delete.summary.numberBuilds': summary.numberOfBuilds, + 'artemisApp.examManagement.delete.summary.numberRegisteredStudents': summary.numberRegisteredStudents, + 'artemisApp.examManagement.delete.summary.numberNotStartedExams': summary.numberNotStartedExams, + 'artemisApp.examManagement.delete.summary.numberStartedExams': summary.numberStartedExams, + 'artemisApp.examManagement.delete.summary.numberSubmittedExams': summary.numberSubmittedExams, + 'artemisApp.examManagement.delete.summary.numberCommunicationPosts': summary.numberOfCommunicationPosts, + 'artemisApp.examManagement.delete.summary.numberAnswerPosts': summary.numberOfAnswerPosts, + }; + }), + ); + } } diff --git a/src/main/webapp/app/shared/delete-dialog/delete-button.directive.ts b/src/main/webapp/app/shared/delete-dialog/delete-button.directive.ts index 4f1476ae508b..6fe508245dc8 100644 --- a/src/main/webapp/app/shared/delete-dialog/delete-button.directive.ts +++ b/src/main/webapp/app/shared/delete-dialog/delete-button.directive.ts @@ -1,7 +1,7 @@ import { DeleteDialogService } from 'app/shared/delete-dialog/delete-dialog.service'; import { Directive, ElementRef, EventEmitter, HostListener, Input, OnInit, Output, Renderer2 } from '@angular/core'; import { TranslateService } from '@ngx-translate/core'; -import { ActionType, DeleteDialogData } from 'app/shared/delete-dialog/delete-dialog.model'; +import { ActionType, DeleteDialogData, EntitySummary } from 'app/shared/delete-dialog/delete-dialog.model'; import { Observable } from 'rxjs'; import { ButtonSize, ButtonType } from 'app/shared/components/button.component'; @@ -9,6 +9,8 @@ import { ButtonSize, ButtonType } from 'app/shared/components/button.component'; export class DeleteButtonDirective implements OnInit { @Input() entityTitle?: string; @Input() deleteQuestion: string; + @Input() entitySummaryTitle?: string; + @Input() fetchEntitySummary?: Observable; @Input() translateValues: { [key: string]: unknown } = {}; @Input() deleteConfirmationText: string; @Input() buttonSize: ButtonSize = ButtonSize.SMALL; @@ -73,6 +75,8 @@ export class DeleteButtonDirective implements OnInit { translateValues: this.translateValues, deleteConfirmationText: this.deleteConfirmationText, additionalChecks: this.additionalChecks, + entitySummaryTitle: this.entitySummaryTitle, + fetchEntitySummary: this.fetchEntitySummary, actionType: this.actionType, buttonType: this.buttonType, delete: this.delete, diff --git a/src/main/webapp/app/shared/delete-dialog/delete-dialog.component.html b/src/main/webapp/app/shared/delete-dialog/delete-dialog.component.html index eaadd2bb1acd..47e8a7fd5b6c 100644 --- a/src/main/webapp/app/shared/delete-dialog/delete-dialog.component.html +++ b/src/main/webapp/app/shared/delete-dialog/delete-dialog.component.html @@ -29,6 +29,22 @@

Are you sure you want to delete?

+ + @if (entitySummaryTitle) { + + } + @if (entitySummary) { +
    + @for (summaryKey of objectKeys(entitySummary); track summaryKey; let i = $index) { + @if (entitySummary[summaryKey] !== undefined) { +
  • + : {{ entitySummary[summaryKey] }} +
    • + } + } +
+ } + @if (additionalChecks) {
@for (checkKey of objectKeys(additionalChecks); track checkKey; let i = $index) { diff --git a/src/main/webapp/app/shared/delete-dialog/delete-dialog.component.ts b/src/main/webapp/app/shared/delete-dialog/delete-dialog.component.ts index 6ce26216abf0..0a85965d0b38 100644 --- a/src/main/webapp/app/shared/delete-dialog/delete-dialog.component.ts +++ b/src/main/webapp/app/shared/delete-dialog/delete-dialog.component.ts @@ -1,7 +1,7 @@ import { Component, EventEmitter, OnDestroy, OnInit, Output, ViewChild } from '@angular/core'; import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; import { mapValues } from 'lodash-es'; -import { ActionType } from 'app/shared/delete-dialog/delete-dialog.model'; +import { ActionType, EntitySummary } from 'app/shared/delete-dialog/delete-dialog.model'; import { Observable, Subscription } from 'rxjs'; import { AlertService } from 'app/core/util/alert.service'; import { faBan, faCheck, faSpinner, faTimes, faTrash, faUndo } from '@fortawesome/free-solid-svg-icons'; @@ -24,6 +24,8 @@ export class DeleteDialogComponent implements OnInit, OnDestroy { @ViewChild('deleteForm', { static: true }) deleteForm: NgForm; deleteQuestion: string; + entitySummaryTitle?: string; + entitySummary?: EntitySummary = {}; translateValues: { [key: string]: unknown } = {}; deleteConfirmationText: string; requireConfirmationOnlyForAdditionalChecks: boolean; diff --git a/src/main/webapp/app/shared/delete-dialog/delete-dialog.model.ts b/src/main/webapp/app/shared/delete-dialog/delete-dialog.model.ts index c6fc632b98a4..9920bcd69fdf 100644 --- a/src/main/webapp/app/shared/delete-dialog/delete-dialog.model.ts +++ b/src/main/webapp/app/shared/delete-dialog/delete-dialog.model.ts @@ -15,6 +15,14 @@ export enum ActionType { EndNow = 'endNow', } +/** + * Summary of the entity that will be deleted. + * Key is i18n key, value is the value that will be displayed + */ +export interface EntitySummary { + [key: string]: number | boolean | undefined; +} + /** * Data that will be passed to the delete dialog component */ @@ -29,6 +37,12 @@ export class DeleteDialogData { // i18n key, that will be translated deleteQuestion: string; + // i18n key, that will be translated + entitySummaryTitle?: string; + + // observable that will fetch the entity summary + fetchEntitySummary?: Observable; + // parameters used for the delete question translateValues: { [key: string]: unknown }; diff --git a/src/main/webapp/app/shared/delete-dialog/delete-dialog.service.ts b/src/main/webapp/app/shared/delete-dialog/delete-dialog.service.ts index 5062a19518d6..02ab549f82a8 100644 --- a/src/main/webapp/app/shared/delete-dialog/delete-dialog.service.ts +++ b/src/main/webapp/app/shared/delete-dialog/delete-dialog.service.ts @@ -1,9 +1,10 @@ import { Injectable } from '@angular/core'; import { NgbModal, NgbModalRef } from '@ng-bootstrap/ng-bootstrap'; import { DeleteDialogComponent } from 'app/shared/delete-dialog/delete-dialog.component'; -import { DeleteDialogData } from 'app/shared/delete-dialog/delete-dialog.model'; -import { from } from 'rxjs'; +import { DeleteDialogData, EntitySummary } from 'app/shared/delete-dialog/delete-dialog.model'; +import { Observable, from } from 'rxjs'; import { AlertService } from 'app/core/util/alert.service'; +import { HttpErrorResponse } from '@angular/common/http'; @Injectable({ providedIn: 'root' }) export class DeleteDialogService { @@ -27,12 +28,30 @@ export class DeleteDialogService { this.modalRef.componentInstance.translateValues = { ...deleteDialogData.translateValues, title: deleteDialogData.entityTitle }; this.modalRef.componentInstance.deleteConfirmationText = deleteDialogData.deleteConfirmationText; this.modalRef.componentInstance.additionalChecks = deleteDialogData.additionalChecks; + this.modalRef.componentInstance.entitySummaryTitle = deleteDialogData.entitySummaryTitle; + this.modalRef.componentInstance.fetchEntitySummary = deleteDialogData.fetchEntitySummary; this.modalRef.componentInstance.actionType = deleteDialogData.actionType; this.modalRef.componentInstance.buttonType = deleteDialogData.buttonType; this.modalRef.componentInstance.delete = deleteDialogData.delete; this.modalRef.componentInstance.dialogError = deleteDialogData.dialogError; this.modalRef.componentInstance.requireConfirmationOnlyForAdditionalChecks = deleteDialogData.requireConfirmationOnlyForAdditionalChecks; + if (deleteDialogData.fetchEntitySummary !== undefined) { + this.fetchAndSetEntitySummary(deleteDialogData.fetchEntitySummary, this.modalRef.componentInstance); + } + from(this.modalRef.result).subscribe(() => (this.modalRef = null)); } + + /** + * Fetches and sets entity summary by subscribing to fetchEntitySummary. + * @param fetchEntitySummary observable that fetches entity summary + * @param componentInstance instance of DeleteDialogComponent + */ + fetchAndSetEntitySummary(fetchEntitySummary: Observable, componentInstance: DeleteDialogComponent): void { + fetchEntitySummary.subscribe({ + next: (entitySummary: EntitySummary) => (componentInstance.entitySummary = entitySummary), + error: (error: HttpErrorResponse) => this.alertService.error('error.unexpectedError', { error: error.message }), + }); + } } diff --git a/src/main/webapp/i18n/de/course.json b/src/main/webapp/i18n/de/course.json index 155b173b50bc..16c8ee6ae832 100644 --- a/src/main/webapp/i18n/de/course.json +++ b/src/main/webapp/i18n/de/course.json @@ -13,7 +13,26 @@ "delete": { "question": "Soll der Kurs {{ title }} wirklich dauerhaft gelöscht werden? Alle zugehörigen Elemente, inklusive der Klausuren, Aufgaben sowie Repositories und Build-Pläne werden gelöscht. Diese Aktion kann NICHT rückgängig gemacht werden!", "typeNameToConfirm": "Bitte gib den Namen des Kurses zur Bestätigung ein.", - "icon": "Kursicon löschen" + "icon": "Kursicon löschen", + "summary": { + "title": "Kurszusammenfassung", + "numberExams": "Anzahl der Klausuren", + "numberLectures": "Anzahl der Vorlesungen", + "numberStudents": "Anzahl der Studierenden", + "numberTutors": "Anzahl der Tutor:innen", + "numberEditors": "Anzahl der Editor:innen", + "numberInstructors": "Anzahl der Lehrenden", + "numberProgrammingExercises": "Anzahl der Programmieraufgaben", + "numberModelingExercises": "Anzahl der Modellierungsaufgaben", + "numberTextExercises": "Anzahl der Textaufgaben", + "numberFileUploadExercises": "Anzahl der Dateiupload-Aufgaben", + "numberQuizExercises": "Anzahl der Quizaufgaben", + "numberRepositories": "Anzahl der Repositories", + "numberBuilds": "Anzahl der Builds", + "numberCommunicationPosts": "Anzahl der Kommunikationsbeiträge", + "numberAnswerPosts": "Anzahl der Antwortbeiträge", + "isTestCourse": "Testkurs" + } }, "showActive": "Nur aktive Kurse anzeigen", "totalScore": "Gesamtergebnis:", diff --git a/src/main/webapp/i18n/de/exam.json b/src/main/webapp/i18n/de/exam.json index ff6b4685e0f5..bea5f259ab2a 100644 --- a/src/main/webapp/i18n/de/exam.json +++ b/src/main/webapp/i18n/de/exam.json @@ -600,7 +600,26 @@ "quizPool": "Quiz Pool", "delete": { "question": "Soll die Klausur {{ title }} wirklich dauerhaft gelöscht werden? Alle zugehörigen Elemente werden gelöscht, inklusive der Klausuren der Studierenden. Diese Aktion kann NICHT rückgängig gemacht werden!", - "typeNameToConfirm": "Bitte gib den Namen der Klausur zur Bestätigung ein." + "typeNameToConfirm": "Bitte gib den Namen der Klausur zur Bestätigung ein.", + "summary": { + "title": "Klausur-Zusammenfassung", + "numberExerciseGroups": "Anzahl der Aufgabengruppen", + "numberProgrammingExercises": "Anzahl der Programmieraufgaben", + "numberModelingExercises": "Anzahl der Modellierungsaufgaben", + "numberTextExercises": "Anzahl der Textaufgaben", + "numberFileUploadExercises": "Anzahl der Datei-Upload-Aufgaben", + "numberQuizExercises": "Anzahl der Quiz-Aufgaben", + "numberRepositories": "Anzahl der Repositories", + "numberBuilds": "Anzahl der Builds", + "numberRegisteredStudents": "Anzahl der angemeldeten Studierenden", + "numberNotStartedExams": "Anzahl der Klausuren (nicht gestartet)", + "numberStartedExams": "Anzahl der Klausuren", + "numberSubmittedExams": "Anzahl der Klausuren (abgegeben)", + "numberCommunicationPosts": "Anzahl der Kommunikationsbeiträge", + "numberAnswerPosts": "Anzahl der Antwortbeiträge", + "isTestExam": "Testklausur", + "isTestCourse": "Testkurs" + } }, "reset": { "question": "Soll die Klausur {{ title }} wirklich dauerhaft zurückgesetzt werden? Alle Klausuren der Studierenden werden gelöscht. Teilnehmende an der Klausur und die Konfigurationen der Aufgaben bleiben erhalten. Diese Aktion kann NICHT rückgängig gemacht werden!", diff --git a/src/main/webapp/i18n/en/course.json b/src/main/webapp/i18n/en/course.json index f2186bb72c16..d4246b664a54 100644 --- a/src/main/webapp/i18n/en/course.json +++ b/src/main/webapp/i18n/en/course.json @@ -13,7 +13,26 @@ "delete": { "question": "Are you sure you want to permanently delete the course {{ title }}? All associated elements will be deleted, including exams, exercises, repositories and build plans. This action can NOT be undone!", "typeNameToConfirm": "Please type in the name of the course to confirm.", - "icon": "Remove Icon" + "icon": "Remove Icon", + "summary": { + "title": "Course Summary", + "numberExams": "Number of Exams", + "numberLectures": "Number of Lectures", + "numberStudents": "Number of Students", + "numberTutors": "Number of Tutors", + "numberEditors": "Number of Editors", + "numberInstructors": "Number of Instructors", + "numberProgrammingExercises": "Number of Programming Exercises", + "numberModelingExercises": "Number of Modeling Exercises", + "numberTextExercises": "Number of Text Exercises", + "numberFileUploadExercises": "Number of File Upload Exercises", + "numberQuizExercises": "Number of Quiz Exercises", + "numberRepositories": "Number of Repositories", + "numberBuilds": "Number of Builds", + "numberCommunicationPosts": "Number of Communication Posts", + "numberAnswerPosts": "Number of Answer Posts", + "isTestCourse": "Test Course" + } }, "showActive": "Show only active courses", "totalScore": "Total Score:", diff --git a/src/main/webapp/i18n/en/exam.json b/src/main/webapp/i18n/en/exam.json index 713a9a92fd1a..cb75f38dece0 100644 --- a/src/main/webapp/i18n/en/exam.json +++ b/src/main/webapp/i18n/en/exam.json @@ -600,7 +600,26 @@ "quizPool": "Quiz Pool", "delete": { "question": "Are you sure you want to permanently delete the Exam {{ title }}? All associated elements will be deleted including the Student Exams. This action can NOT be undone!", - "typeNameToConfirm": "Please type in the name of the exam to confirm." + "typeNameToConfirm": "Please type in the name of the exam to confirm.", + "summary": { + "title": "Exam Summary", + "numberExerciseGroups": "Number of Exercise Groups", + "numberProgrammingExercises": "Number of Programming Exercises", + "numberModelingExercises": "Number of Modeling Exercises", + "numberTextExercises": "Number of Text Exercises", + "numberFileUploadExercises": "Number of File Upload Exercises", + "numberQuizExercises": "Number of Quiz Exercises", + "numberRepositories": "Number of Repositories", + "numberBuilds": "Number of Builds", + "numberRegisteredStudents": "Number of Registered Students", + "numberNotStartedExams": "Number of Exams (not started)", + "numberStartedExams": "Number of Exams", + "numberSubmittedExams": "Number of Exams (submitted)", + "numberCommunicationPosts": "Number of Communication Posts", + "numberAnswerPosts": "Number of Answer Posts", + "isTestExam": "Test Exam", + "isTestCourse": "Test Course" + } }, "reset": { "question": "Are you sure you want to permanently reset the Exam {{ title }}? All Student Exams will be deleted. Registered students and the exercise configurations will remain. This action can NOT be undone!", diff --git a/src/test/java/de/tum/cit/aet/artemis/communication/util/ConversationUtilService.java b/src/test/java/de/tum/cit/aet/artemis/communication/util/ConversationUtilService.java index 1d581ffc7c66..1a1855651224 100644 --- a/src/test/java/de/tum/cit/aet/artemis/communication/util/ConversationUtilService.java +++ b/src/test/java/de/tum/cit/aet/artemis/communication/util/ConversationUtilService.java @@ -660,6 +660,7 @@ private Post createMessageWithReactionForUser(String login, String messageText, message.setAuthor(userUtilService.getUserByLogin(login)); message.setContent(messageText); message.setCreationDate(ZonedDateTime.now()); + message.setCourse(conversation.getCourse()); conversation.setCreator(message.getAuthor()); addReactionForUserToPost(login, message); conversationRepository.save(conversation); diff --git a/src/test/java/de/tum/cit/aet/artemis/core/service/CourseServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/core/service/CourseServiceTest.java index 65e9c93d3cec..cf4cd87c422f 100644 --- a/src/test/java/de/tum/cit/aet/artemis/core/service/CourseServiceTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/core/service/CourseServiceTest.java @@ -20,6 +20,8 @@ import org.springframework.http.HttpStatus; import org.springframework.security.test.context.support.WithMockUser; +import de.tum.cit.aet.artemis.assessment.domain.Result; +import de.tum.cit.aet.artemis.communication.util.ConversationUtilService; import de.tum.cit.aet.artemis.core.domain.Course; import de.tum.cit.aet.artemis.core.domain.Language; import de.tum.cit.aet.artemis.core.dto.StudentDTO; @@ -28,9 +30,16 @@ import de.tum.cit.aet.artemis.core.test_repository.UserTestRepository; import de.tum.cit.aet.artemis.core.user.util.UserUtilService; import de.tum.cit.aet.artemis.core.util.CourseUtilService; +import de.tum.cit.aet.artemis.exercise.domain.participation.Participation; import de.tum.cit.aet.artemis.exercise.domain.participation.StudentParticipation; +import de.tum.cit.aet.artemis.exercise.participation.util.ParticipationUtilService; import de.tum.cit.aet.artemis.exercise.test_repository.StudentParticipationTestRepository; import de.tum.cit.aet.artemis.exercise.test_repository.SubmissionTestRepository; +import de.tum.cit.aet.artemis.programming.domain.ProgrammingExercise; +import de.tum.cit.aet.artemis.programming.domain.ProgrammingExerciseStudentParticipation; +import de.tum.cit.aet.artemis.programming.domain.build.BuildJob; +import de.tum.cit.aet.artemis.programming.repository.BuildJobRepository; +import de.tum.cit.aet.artemis.programming.util.ProgrammingExerciseFactory; import de.tum.cit.aet.artemis.shared.base.AbstractSpringIntegrationLocalCILocalVCTest; import de.tum.cit.aet.artemis.text.domain.TextSubmission; import de.tum.cit.aet.artemis.text.util.TextExerciseFactory; @@ -51,12 +60,21 @@ class CourseServiceTest extends AbstractSpringIntegrationLocalCILocalVCTest { @Autowired private StudentParticipationTestRepository studentParticipationRepo; + @Autowired + private BuildJobRepository buildJobRepo; + @Autowired private UserUtilService userUtilService; @Autowired private CourseUtilService courseUtilService; + @Autowired + private ParticipationUtilService participationUtilService; + + @Autowired + private ConversationUtilService conversationUtilService; + @BeforeEach void initTestCase() { userUtilService.addUsers(TEST_PREFIX, 2, 0, 0, 1); @@ -305,9 +323,43 @@ else if (dto1.email() != null) { assertThat(registrationFailures).containsExactly(dto2); } + @Test + void testDeletionSummary() { + SecurityUtils.setAuthorizationObject(); + Course course = courseUtilService.addEmptyCourse(); + + var programmingExercise = ProgrammingExerciseFactory.generateProgrammingExercise(ZonedDateTime.now(), ZonedDateTime.now().plusDays(7), course); + programmingExercise.setBuildConfig(programmingExerciseBuildConfigRepository.save(programmingExercise.getBuildConfig())); + programmingExerciseRepository.save(programmingExercise); + + var student1 = userUtilService.getUserByLogin(TEST_PREFIX + "student1"); + + conversationUtilService.addMessageInChannelOfCourseForUser(student1.getLogin(), course, TEST_PREFIX + "message"); + + ProgrammingExerciseStudentParticipation participation = participationUtilService.addStudentParticipationForProgrammingExercise(programmingExercise, student1.getLogin()); + Result result = participationUtilService.createSubmissionAndResult(participation, 1L, true); + createBuildJob(programmingExercise, course, participation, result); + + course = courseRepository.findByIdWithEagerExercisesElseThrow(course.getId()); + var summary = courseService.getDeletionSummary(course); + assertThat(summary.numberOfCommunicationPosts()).isEqualTo(1L); + assertThat(summary.numberOfAnswerPosts()).isEqualTo(1L); + assertThat(summary.numberOfBuilds()).isEqualTo(1L); + } + private void setEnrollmentConfiguration(Course course, ZonedDateTime start, ZonedDateTime end) { course.setEnrollmentEnabled(true); course.setEnrollmentStartDate(start); course.setEnrollmentEndDate(end); } + + private void createBuildJob(ProgrammingExercise programmingExercise, Course course, Participation participation, Result result) { + var buildJob = new BuildJob(); + buildJob.setExerciseId(programmingExercise.getId()); + buildJob.setCourseId(course.getId()); + buildJob.setParticipationId(participation.getId()); + buildJob.setResult(result); + + buildJobRepo.save(buildJob); + } } diff --git a/src/test/java/de/tum/cit/aet/artemis/exam/ExamDeletionIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/exam/ExamDeletionIntegrationTest.java new file mode 100644 index 000000000000..8e3ae010acd7 --- /dev/null +++ b/src/test/java/de/tum/cit/aet/artemis/exam/ExamDeletionIntegrationTest.java @@ -0,0 +1,146 @@ +package de.tum.cit.aet.artemis.exam; + +import static org.assertj.core.api.Assertions.assertThat; + +import java.time.ZonedDateTime; + +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.TestInstance; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpStatus; +import org.springframework.security.test.context.support.WithMockUser; + +import de.tum.cit.aet.artemis.assessment.domain.Result; +import de.tum.cit.aet.artemis.communication.domain.Post; +import de.tum.cit.aet.artemis.communication.domain.conversation.Channel; +import de.tum.cit.aet.artemis.core.domain.Course; +import de.tum.cit.aet.artemis.core.domain.User; +import de.tum.cit.aet.artemis.exam.domain.Exam; +import de.tum.cit.aet.artemis.exam.domain.StudentExam; +import de.tum.cit.aet.artemis.exam.dto.ExamDeletionSummaryDTO; +import de.tum.cit.aet.artemis.exam.repository.StudentExamRepository; +import de.tum.cit.aet.artemis.exam.service.ExamSessionService; +import de.tum.cit.aet.artemis.exam.util.ExamUtilService; +import de.tum.cit.aet.artemis.exercise.domain.ExerciseType; +import de.tum.cit.aet.artemis.exercise.domain.participation.Participation; +import de.tum.cit.aet.artemis.exercise.participation.util.ParticipationUtilService; +import de.tum.cit.aet.artemis.programming.domain.ProgrammingExercise; +import de.tum.cit.aet.artemis.programming.domain.ProgrammingExerciseStudentParticipation; +import de.tum.cit.aet.artemis.programming.domain.build.BuildJob; +import de.tum.cit.aet.artemis.programming.repository.BuildJobRepository; +import de.tum.cit.aet.artemis.shared.base.AbstractSpringIntegrationIndependentTest; + +@TestInstance(TestInstance.Lifecycle.PER_CLASS) +class ExamDeletionIntegrationTest extends AbstractSpringIntegrationIndependentTest { + + private static final String TEST_PREFIX = "examdeletion"; + + @Autowired + private ExamUtilService examUtilService; + + @Autowired + private ExamSessionService examSessionService; + + @Autowired + private StudentExamRepository studentExamRepository; + + @Autowired + private ParticipationUtilService participationUtilService; + + @Autowired + private BuildJobRepository buildJobRepository; + + private static final int NUMBER_OF_STUDENTS = 4; + + private static final int NUMBER_OF_TUTORS = 1; + + private Course course; + + private Exam exam; + + private ProgrammingExercise programmingExercise; + + private User student1; + + private User student2; + + private User student3; + + private User student4; + + @BeforeAll + void setup() { + // setup users + userUtilService.addUsers(TEST_PREFIX, NUMBER_OF_STUDENTS, NUMBER_OF_TUTORS, 0, 1); + + student1 = userUtilService.getUserByLogin(TEST_PREFIX + "student1"); + student2 = userUtilService.getUserByLogin(TEST_PREFIX + "student2"); + student3 = userUtilService.getUserByLogin(TEST_PREFIX + "student3"); + student4 = userUtilService.getUserByLogin(TEST_PREFIX + "student4"); + User instructor = userUtilService.getUserByLogin(TEST_PREFIX + "instructor1"); + + // reset courses + course = courseUtilService.addEmptyCourse(); + + exam = examUtilService.addExam(course); + exam = examUtilService.registerUsersForExamAndSaveExam(exam, TEST_PREFIX, NUMBER_OF_STUDENTS); + + Channel channel = examUtilService.addExamChannel(exam, "exam1 channel"); + Post instructorPost = examUtilService.createPost(channel, "Instructor Post", instructor); + examUtilService.createAnswerPost(instructorPost, "Student Answer", student1); + examUtilService.createAnswerPost(instructorPost, "Instructor Answer", instructor); + + exam = examUtilService.addTextModelingProgrammingExercisesToExam(exam, true, true); + programmingExercise = (ProgrammingExercise) exam.getExerciseGroups().stream().flatMap(exerciseGroup -> exerciseGroup.getExercises().stream()) + .filter(exercise -> ExerciseType.PROGRAMMING.equals(exercise.getExerciseType())).findFirst().orElseThrow(); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testDeletionSummary() throws Exception { + addStudentExam(student1, false, false); + addStudentExam(student2, false, false); + + addStudentExam(student3, true, false); + ProgrammingExerciseStudentParticipation participation = participationUtilService.addStudentParticipationForProgrammingExercise(programmingExercise, student3.getLogin()); + Result result = participationUtilService.createSubmissionAndResult(participation, 1L, true); + createBuildJob(participation, result); + + addStudentExam(student4, true, true); + + var response = request.get("/api/courses/" + course.getId() + "/exams/" + exam.getId() + "/deletion-summary", HttpStatus.OK, ExamDeletionSummaryDTO.class); + assertThat(response.numberOfBuilds()).isEqualTo(1); + assertThat(response.numberOfCommunicationPosts()).isEqualTo(1); + assertThat(response.numberOfAnswerPosts()).isEqualTo(2); + assertThat(response.numberNotStartedExams()).isEqualTo(2); + assertThat(response.numberStartedExams()).isEqualTo(2); + assertThat(response.numberSubmittedExams()).isEqualTo(1); + } + + private void addStudentExam(User student, boolean isStarted, boolean isSubmitted) { + StudentExam studentExam = examUtilService.addStudentExamWithUser(exam, student); + examSessionService.startExamSession(studentExam, null, null, null, null); + if (isStarted) { + studentExam.setStartedAndStartDate(ZonedDateTime.now()); + } + if (isSubmitted) { + studentExam.setSubmissionDate(ZonedDateTime.now()); + studentExam.setSubmitted(true); + } + + if (isStarted || isSubmitted) { + studentExamRepository.save(studentExam); + } + } + + private void createBuildJob(Participation participation, Result result) { + var buildJob = new BuildJob(); + buildJob.setExerciseId(programmingExercise.getId()); + buildJob.setCourseId(course.getId()); + buildJob.setParticipationId(participation.getId()); + buildJob.setResult(result); + + buildJobRepository.save(buildJob); + } +} diff --git a/src/test/java/de/tum/cit/aet/artemis/exam/util/ExamUtilService.java b/src/test/java/de/tum/cit/aet/artemis/exam/util/ExamUtilService.java index 0d6c8a6899c1..5add0a15006b 100644 --- a/src/test/java/de/tum/cit/aet/artemis/exam/util/ExamUtilService.java +++ b/src/test/java/de/tum/cit/aet/artemis/exam/util/ExamUtilService.java @@ -15,7 +15,11 @@ import org.springframework.stereotype.Service; import de.tum.cit.aet.artemis.assessment.domain.Result; +import de.tum.cit.aet.artemis.communication.domain.AnswerPost; +import de.tum.cit.aet.artemis.communication.domain.Post; import de.tum.cit.aet.artemis.communication.domain.conversation.Channel; +import de.tum.cit.aet.artemis.communication.repository.AnswerPostRepository; +import de.tum.cit.aet.artemis.communication.repository.PostRepository; import de.tum.cit.aet.artemis.communication.test_repository.ConversationTestRepository; import de.tum.cit.aet.artemis.communication.util.ConversationFactory; import de.tum.cit.aet.artemis.core.domain.Course; @@ -132,6 +136,12 @@ public class ExamUtilService { @Autowired private ConversationTestRepository conversationRepository; + @Autowired + private PostRepository postRepository; + + @Autowired + private AnswerPostRepository answerPostRepository; + @Autowired private ParticipationUtilService participationUtilService; @@ -521,6 +531,37 @@ public Channel addExamChannel(Exam exam, String channelName) { return conversationRepository.save(channel); } + /** + * Creates and saves a Post for the given Channel. + * + * @param channel The Channel for which the Post should be created + * @param title The title of the Post + * @param author The author of the Post + * @return The newly created Post + */ + public Post createPost(Channel channel, String title, User author) { + Post post = new Post(); + post.setTitle(title); + post.setConversation(channel); + post.setAuthor(author); + return postRepository.save(post); + } + + /** + * Creates and saves an AnswerPost for the given Post. + * + * @param post The Post for which the AnswerPost should be created + * @param content The content of the AnswerPost + * @param author The author of the AnswerPost + */ + public void createAnswerPost(Post post, String content, User author) { + AnswerPost answerPost = new AnswerPost(); + answerPost.setContent(content); + answerPost.setPost(post); + answerPost.setAuthor(author); + answerPostRepository.save(answerPost); + } + /** * Creates and saves an Exam and corresponding StudentExam with a registered User. The Exam started 1 hour ago and ends in 1 hour. * From 8045a7fce0cc0e5ce2a17b5c3c91abaaca5063b8 Mon Sep 17 00:00:00 2001 From: Ole Vester <73833780+ole-ve@users.noreply.github.com> Date: Sat, 12 Oct 2024 18:03:10 +0200 Subject: [PATCH 07/23] Development: Fix architecture tests for exam deletion summary (#9458) --- .../aet/artemis/core/web/admin/AdminCourseResource.java | 1 - .../cit/aet/artemis/core/service/CourseServiceTest.java | 4 ++-- .../cit/aet/artemis/exam/ExamDeletionIntegrationTest.java | 8 ++++---- .../de/tum/cit/aet/artemis/exam/util/ExamUtilService.java | 4 ++-- 4 files changed, 8 insertions(+), 9 deletions(-) diff --git a/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminCourseResource.java b/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminCourseResource.java index b83f757209c4..6c26cab4798f 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminCourseResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminCourseResource.java @@ -189,7 +189,6 @@ public ResponseEntity deleteCourse(@PathVariable long courseId) { * @return the ResponseEntity with status 200 (OK) and the deletion summary in the body */ @GetMapping("courses/{courseId}/deletion-summary") - @EnforceAdmin public ResponseEntity getDeletionSummary(@PathVariable long courseId) { log.debug("REST request to get deletion summary course: {}", courseId); final Course course = courseRepository.findByIdWithEagerExercisesElseThrow(courseId); diff --git a/src/test/java/de/tum/cit/aet/artemis/core/service/CourseServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/core/service/CourseServiceTest.java index cf4cd87c422f..9f17c65b4cc8 100644 --- a/src/test/java/de/tum/cit/aet/artemis/core/service/CourseServiceTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/core/service/CourseServiceTest.java @@ -38,7 +38,7 @@ import de.tum.cit.aet.artemis.programming.domain.ProgrammingExercise; import de.tum.cit.aet.artemis.programming.domain.ProgrammingExerciseStudentParticipation; import de.tum.cit.aet.artemis.programming.domain.build.BuildJob; -import de.tum.cit.aet.artemis.programming.repository.BuildJobRepository; +import de.tum.cit.aet.artemis.programming.test_repository.BuildJobTestRepository; import de.tum.cit.aet.artemis.programming.util.ProgrammingExerciseFactory; import de.tum.cit.aet.artemis.shared.base.AbstractSpringIntegrationLocalCILocalVCTest; import de.tum.cit.aet.artemis.text.domain.TextSubmission; @@ -61,7 +61,7 @@ class CourseServiceTest extends AbstractSpringIntegrationLocalCILocalVCTest { private StudentParticipationTestRepository studentParticipationRepo; @Autowired - private BuildJobRepository buildJobRepo; + private BuildJobTestRepository buildJobRepo; @Autowired private UserUtilService userUtilService; diff --git a/src/test/java/de/tum/cit/aet/artemis/exam/ExamDeletionIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/exam/ExamDeletionIntegrationTest.java index 8e3ae010acd7..77896ce4b74e 100644 --- a/src/test/java/de/tum/cit/aet/artemis/exam/ExamDeletionIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/exam/ExamDeletionIntegrationTest.java @@ -19,8 +19,8 @@ import de.tum.cit.aet.artemis.exam.domain.Exam; import de.tum.cit.aet.artemis.exam.domain.StudentExam; import de.tum.cit.aet.artemis.exam.dto.ExamDeletionSummaryDTO; -import de.tum.cit.aet.artemis.exam.repository.StudentExamRepository; import de.tum.cit.aet.artemis.exam.service.ExamSessionService; +import de.tum.cit.aet.artemis.exam.test_repository.StudentExamTestRepository; import de.tum.cit.aet.artemis.exam.util.ExamUtilService; import de.tum.cit.aet.artemis.exercise.domain.ExerciseType; import de.tum.cit.aet.artemis.exercise.domain.participation.Participation; @@ -28,7 +28,7 @@ import de.tum.cit.aet.artemis.programming.domain.ProgrammingExercise; import de.tum.cit.aet.artemis.programming.domain.ProgrammingExerciseStudentParticipation; import de.tum.cit.aet.artemis.programming.domain.build.BuildJob; -import de.tum.cit.aet.artemis.programming.repository.BuildJobRepository; +import de.tum.cit.aet.artemis.programming.test_repository.BuildJobTestRepository; import de.tum.cit.aet.artemis.shared.base.AbstractSpringIntegrationIndependentTest; @TestInstance(TestInstance.Lifecycle.PER_CLASS) @@ -43,13 +43,13 @@ class ExamDeletionIntegrationTest extends AbstractSpringIntegrationIndependentTe private ExamSessionService examSessionService; @Autowired - private StudentExamRepository studentExamRepository; + private StudentExamTestRepository studentExamRepository; @Autowired private ParticipationUtilService participationUtilService; @Autowired - private BuildJobRepository buildJobRepository; + private BuildJobTestRepository buildJobRepository; private static final int NUMBER_OF_STUDENTS = 4; diff --git a/src/test/java/de/tum/cit/aet/artemis/exam/util/ExamUtilService.java b/src/test/java/de/tum/cit/aet/artemis/exam/util/ExamUtilService.java index 5add0a15006b..d447ba617a5a 100644 --- a/src/test/java/de/tum/cit/aet/artemis/exam/util/ExamUtilService.java +++ b/src/test/java/de/tum/cit/aet/artemis/exam/util/ExamUtilService.java @@ -19,8 +19,8 @@ import de.tum.cit.aet.artemis.communication.domain.Post; import de.tum.cit.aet.artemis.communication.domain.conversation.Channel; import de.tum.cit.aet.artemis.communication.repository.AnswerPostRepository; -import de.tum.cit.aet.artemis.communication.repository.PostRepository; import de.tum.cit.aet.artemis.communication.test_repository.ConversationTestRepository; +import de.tum.cit.aet.artemis.communication.test_repository.PostTestRepository; import de.tum.cit.aet.artemis.communication.util.ConversationFactory; import de.tum.cit.aet.artemis.core.domain.Course; import de.tum.cit.aet.artemis.core.domain.Language; @@ -137,7 +137,7 @@ public class ExamUtilService { private ConversationTestRepository conversationRepository; @Autowired - private PostRepository postRepository; + private PostTestRepository postRepository; @Autowired private AnswerPostRepository answerPostRepository; From 29add8118108ab15e3c556adf3614b7864d0a547 Mon Sep 17 00:00:00 2001 From: Paul Rangger <48455539+PaRangger@users.noreply.github.com> Date: Sat, 12 Oct 2024 18:04:33 +0200 Subject: [PATCH 08/23] Tutorial groups: Redesign overview page (#9445) --- .../tutorial-group-detail.component.html | 142 +++++++++++++++++- .../tutorial-group-detail.component.scss | 23 +++ .../tutorial-group-detail.component.ts | 103 +++---------- .../shared/tutorial-groups-shared.module.ts | 3 +- .../shared/icon-card/icon-card.component.html | 12 ++ .../shared/icon-card/icon-card.component.scss | 0 .../shared/icon-card/icon-card.component.ts | 18 +++ src/main/webapp/i18n/de/tutorialGroups.json | 5 +- src/main/webapp/i18n/en/tutorialGroups.json | 5 +- .../icon-card/icon-card.component.spec.ts | 40 +++++ .../tutorial-group-detail.component.spec.ts | 11 +- 11 files changed, 273 insertions(+), 89 deletions(-) create mode 100644 src/main/webapp/app/shared/icon-card/icon-card.component.html create mode 100644 src/main/webapp/app/shared/icon-card/icon-card.component.scss create mode 100644 src/main/webapp/app/shared/icon-card/icon-card.component.ts create mode 100644 src/test/javascript/spec/component/shared/icon-card/icon-card.component.spec.ts diff --git a/src/main/webapp/app/course/tutorial-groups/shared/tutorial-group-detail/tutorial-group-detail.component.html b/src/main/webapp/app/course/tutorial-groups/shared/tutorial-group-detail/tutorial-group-detail.component.html index ced9dd74a469..26607ec88597 100644 --- a/src/main/webapp/app/course/tutorial-groups/shared/tutorial-group-detail/tutorial-group-detail.component.html +++ b/src/main/webapp/app/course/tutorial-groups/shared/tutorial-group-detail/tutorial-group-detail.component.html @@ -5,10 +5,144 @@

{{ tutorialGroup.title }}

} - @if (tutorialDetailSections) { - - } -
+
+
+ +
+
+ @if (tutorialGroup.teachingAssistantImageUrl) { + + } @else { + {{ + tutorInitials + }} + } +
+ +
+ : + {{ tutorialGroup.teachingAssistantName }} +
+ + @if (tutorialGroup.channel && isMessagingEnabled) { +
+ : + @if (tutorialGroup.channel.isMember) { + + {{ tutorialGroup.channel.name }} + + } @else { + {{ tutorialGroup.channel.name }} + } +
+ } +
+ +
+ +
+ +
+
+ : + {{ (tutorialGroup.averageAttendance && Math.round(tutorialGroup.averageAttendance)) ?? '-' }} + +
+ +
+ : + {{ tutorialGroup.capacity }} +
+ +
+ : + {{ !tutorialGroup.numberOfRegisteredUsers || tutorialGroup.numberOfRegisteredUsers === 0 ? '-' : tutorialGroup.numberOfRegisteredUsers }} +
+ +
+ : + + + @if (utilization) { +
+
+ {{ utilization }}% +
+
+ } @else { +
+
-
+
+ } +
+
+ +
+ +
+ +
+
+ : + {{ tutorialGroup.language }} +
+ +
+ : + {{ tutorialGroup.campus }} +
+ +
+ : + {{ tutorialTimeslotString }} +
+ +
+ : + + {{ tutorialGroup.tutorialGroupSchedule?.location }} +
+ +
+ @if (tutorialGroup.isOnline) { + + + } @else { + + + } +
+
+ +
+ + @if (formattedAdditionalInformation) { +
+
+
+
:
+ +
+
+
+
+ } +
+
@if (sessions && sessions.length) { diff --git a/src/main/webapp/app/course/tutorial-groups/shared/tutorial-group-detail/tutorial-group-detail.component.scss b/src/main/webapp/app/course/tutorial-groups/shared/tutorial-group-detail/tutorial-group-detail.component.scss index c25d9ed8613e..0a2501554636 100644 --- a/src/main/webapp/app/course/tutorial-groups/shared/tutorial-group-detail/tutorial-group-detail.component.scss +++ b/src/main/webapp/app/course/tutorial-groups/shared/tutorial-group-detail/tutorial-group-detail.component.scss @@ -1,3 +1,5 @@ +$tutor-image-size: 4.5rem; + .tutorial-group-detail { .scrollbar { position: relative; @@ -8,4 +10,25 @@ .table-wrapper-scroll-y { display: block; } + + .markdown-preview { + margin-bottom: -1rem; + } +} + +.tutorial-group-detail-tutor-image { + width: $tutor-image-size; + height: $tutor-image-size; + object-fit: cover; +} + +.tutorial-group-detail-tutor-default-image { + width: $tutor-image-size; + height: $tutor-image-size; + font-size: 2rem; + display: inline-flex; + align-items: center; + justify-content: center; + background-color: var(--gray-400); + color: var(--white); } diff --git a/src/main/webapp/app/course/tutorial-groups/shared/tutorial-group-detail/tutorial-group-detail.component.ts b/src/main/webapp/app/course/tutorial-groups/shared/tutorial-group-detail/tutorial-group-detail.component.ts index 65f3b52a53e4..2d2624ac55a4 100644 --- a/src/main/webapp/app/course/tutorial-groups/shared/tutorial-group-detail/tutorial-group-detail.component.ts +++ b/src/main/webapp/app/course/tutorial-groups/shared/tutorial-group-detail/tutorial-group-detail.component.ts @@ -5,10 +5,8 @@ import { SafeHtml } from '@angular/platform-browser'; import { ArtemisMarkdownService } from 'app/shared/markdown.service'; import { getDayTranslationKey } from '../weekdays'; import { TutorialGroupSession, TutorialGroupSessionStatus } from 'app/entities/tutorial-group/tutorial-group-session.model'; -import { faQuestionCircle } from '@fortawesome/free-solid-svg-icons'; -import { DetailOverviewSection, DetailType } from 'app/detail-overview-list/detail-overview-list.component'; import { TranslateService } from '@ngx-translate/core'; -import { Detail } from 'app/detail-overview-list/detail.model'; +import { faCircle, faCircleInfo, faCircleXmark, faPercent, faQuestionCircle, faUserCheck } from '@fortawesome/free-solid-svg-icons'; import dayjs from 'dayjs/esm'; import { SortService } from 'app/shared/service/sort.service'; import { getInitialsFromString } from 'app/utils/text.utils'; @@ -32,12 +30,23 @@ export class TutorialGroupDetailComponent implements OnChanges { course: Course; formattedAdditionalInformation?: SafeHtml; - faQuestionCircle = faQuestionCircle; readonly Math = Math; sessions: TutorialGroupSession[] = []; - tutorialDetailSections: DetailOverviewSection[]; + tutorInitials: string; + tutorialTimeslotString: string | undefined; + tutorDefaultProfilePictureHue: string; + isMessagingEnabled: boolean; + utilization: number | undefined; + + // Icons + readonly faUserCheck = faUserCheck; + readonly faPercent = faPercent; + readonly faCircleInfo = faCircleInfo; + readonly faQuestionCircle = faQuestionCircle; + readonly faCircle = faCircle; + readonly faCircleXmark = faCircleXmark; constructor( private artemisMarkdownService: ArtemisMarkdownService, @@ -60,7 +69,7 @@ export class TutorialGroupDetailComponent implements OnChanges { this.changeDetectorRef.detectChanges(); } } - this.getTutorialDetailSections(); + this.getTutorialDetail(); } getTutorialTimeSlotString(): string | undefined { @@ -79,80 +88,18 @@ export class TutorialGroupDetailComponent implements OnChanges { return `${day} ${start}-${end}, ${repetition}`; } - getTutorialDetailSections() { + getTutorialDetail() { const tutorialGroup = this.tutorialGroup; - const tutorialDetails: Detail[] = [ - { type: DetailType.Link, title: 'artemisApp.entities.tutorialGroup.course', data: { text: tutorialGroup.courseTitle, routerLink: ['../..'] } }, - { type: DetailType.Text, title: 'artemisApp.entities.tutorialGroup.title', data: { text: tutorialGroup.title } }, - { type: DetailType.Text, title: 'artemisApp.entities.tutorialGroup.teachingAssistant', data: { text: tutorialGroup.teachingAssistantName } }, - tutorialGroup.teachingAssistantImageUrl - ? { - type: DetailType.Image, - title: 'artemisApp.entities.tutorialGroup.profilePicture', - data: { imageUrl: tutorialGroup.teachingAssistantImageUrl, altText: 'Profile picture of ' + tutorialGroup.teachingAssistantName }, - } - : { - type: DetailType.DefaultProfilePicture, - title: 'artemisApp.entities.tutorialGroup.profilePicture', - data: { - color: getBackgroundColorHue(tutorialGroup.teachingAssistantId ? tutorialGroup.teachingAssistantId.toString() : 'default'), - initials: getInitialsFromString(tutorialGroup.teachingAssistantName ?? 'NA'), - }, - }, - { - type: DetailType.Text, - title: 'artemisApp.entities.tutorialGroup.utilization', - titleHelpText: 'artemisApp.entities.tutorialGroup.utilizationHelpDetail', - data: { text: tutorialGroup.averageAttendance && tutorialGroup.capacity && Math.round((tutorialGroup.averageAttendance / tutorialGroup.capacity) * 100) }, - }, - { - type: DetailType.Text, - title: 'artemisApp.entities.tutorialGroup.averageAttendanceDetail', - titleHelpText: 'artemisApp.entities.tutorialGroup.averageAttendanceHelpDetail', - data: { text: tutorialGroup.averageAttendance && Math.round(tutorialGroup.averageAttendance) }, - }, - { type: DetailType.Text, title: 'artemisApp.entities.tutorialGroup.capacity', data: { text: tutorialGroup.capacity } }, - { type: DetailType.Text, title: 'artemisApp.entities.tutorialGroup.registrations', data: { text: tutorialGroup.numberOfRegisteredUsers } }, - { type: DetailType.Boolean, title: 'artemisApp.entities.tutorialGroup.isOnline', data: { boolean: tutorialGroup.isOnline } }, - { type: DetailType.Text, title: 'artemisApp.entities.tutorialGroup.language', data: { text: tutorialGroup.language } }, - { type: DetailType.Text, title: 'artemisApp.entities.tutorialGroup.campus', data: { text: tutorialGroup.campus } }, - { type: DetailType.Markdown, title: 'artemisApp.entities.tutorialGroup.additionalInformation', data: { innerHtml: this.formattedAdditionalInformation } }, - { type: DetailType.Text, title: 'artemisApp.entities.tutorialGroup.schedule', data: { text: this.getTutorialTimeSlotString() } }, - ]; - - // inserting optional details in reversed order, so no index calculation is needed - if (tutorialGroup.isOnline) { - tutorialDetails.splice(12, 0, { - type: DetailType.Text, - title: 'artemisApp.forms.scheduleForm.locationInput.labelOnline', - data: { text: tutorialGroup.tutorialGroupSchedule?.location }, - }); - } else { - tutorialDetails.splice(12, 0, { - type: DetailType.Text, - title: 'artemisApp.forms.scheduleForm.locationInput.labelOffline', - data: { text: tutorialGroup.tutorialGroupSchedule?.location }, - }); - } - if (tutorialGroup.channel && isMessagingEnabled(this.course)) { - tutorialDetails.splice(2, 0, { - type: DetailType.Link, - title: 'artemisApp.entities.tutorialGroup.channel', - data: { - text: tutorialGroup.channel.name, - routerLink: tutorialGroup.channel.isMember ? ['/courses', this.course.id!, 'communication'] : undefined, - queryParams: { conversationId: tutorialGroup.channel.id }, - }, - }); + this.tutorDefaultProfilePictureHue = getBackgroundColorHue(tutorialGroup.teachingAssistantId ? tutorialGroup.teachingAssistantId.toString() : 'default'); + this.tutorInitials = getInitialsFromString(tutorialGroup.teachingAssistantName ?? 'NA'); + this.isMessagingEnabled = isMessagingEnabled(this.course); + if (tutorialGroup.averageAttendance && tutorialGroup.capacity) { + this.utilization = Math.round((tutorialGroup.averageAttendance / tutorialGroup.capacity) * 100); + } else { + this.utilization = undefined; } - - this.tutorialDetailSections = [ - { - headline: 'artemisApp.pages.courseTutorialGroupDetail.sections.general', - details: tutorialDetails, - }, - ]; + this.tutorialTimeslotString = this.getTutorialTimeSlotString(); } recalculateAttendanceDetails() { @@ -166,6 +113,6 @@ export class TutorialGroupDetailComponent implements OnChanges { this.tutorialGroup.averageAttendance = Math.round(averageAttendance); } - this.getTutorialDetailSections(); + this.getTutorialDetail(); } } diff --git a/src/main/webapp/app/course/tutorial-groups/shared/tutorial-groups-shared.module.ts b/src/main/webapp/app/course/tutorial-groups/shared/tutorial-groups-shared.module.ts index 6dc2bf654604..072ea574195e 100644 --- a/src/main/webapp/app/course/tutorial-groups/shared/tutorial-groups-shared.module.ts +++ b/src/main/webapp/app/course/tutorial-groups/shared/tutorial-groups-shared.module.ts @@ -13,9 +13,10 @@ import { TutorialGroupUtilizationIndicatorComponent } from './tutorial-group-uti import { RemoveSecondsPipe } from 'app/course/tutorial-groups/shared/remove-seconds.pipe'; import { MeetingPatternPipe } from 'app/course/tutorial-groups/shared/meeting-pattern.pipe'; import { DetailModule } from 'app/detail-overview-list/detail.module'; +import { IconCardComponent } from 'app/shared/icon-card/icon-card.component'; @NgModule({ - imports: [ArtemisSharedModule, RouterModule, ArtemisSidePanelModule, VerticalProgressBarModule, DetailModule], + imports: [ArtemisSharedModule, RouterModule, ArtemisSidePanelModule, VerticalProgressBarModule, DetailModule, IconCardComponent], declarations: [ TutorialGroupsTableComponent, TutorialGroupDetailComponent, diff --git a/src/main/webapp/app/shared/icon-card/icon-card.component.html b/src/main/webapp/app/shared/icon-card/icon-card.component.html new file mode 100644 index 000000000000..11aabaa71cdc --- /dev/null +++ b/src/main/webapp/app/shared/icon-card/icon-card.component.html @@ -0,0 +1,12 @@ +
+
+
+ + +
+ +
+ + +
+
diff --git a/src/main/webapp/app/shared/icon-card/icon-card.component.scss b/src/main/webapp/app/shared/icon-card/icon-card.component.scss new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/src/main/webapp/app/shared/icon-card/icon-card.component.ts b/src/main/webapp/app/shared/icon-card/icon-card.component.ts new file mode 100644 index 000000000000..dc0c603000a2 --- /dev/null +++ b/src/main/webapp/app/shared/icon-card/icon-card.component.ts @@ -0,0 +1,18 @@ +import { Component, input } from '@angular/core'; +import { faCircleInfo } from '@fortawesome/free-solid-svg-icons'; +import { IconDefinition } from '@fortawesome/fontawesome-common-types'; +import { ArtemisSharedCommonModule } from 'app/shared/shared-common.module'; +import { ArtemisSharedPipesModule } from 'app/shared/pipes/shared-pipes.module'; + +@Component({ + selector: 'jhi-icon-card', + templateUrl: './icon-card.component.html', + styleUrl: './icon-card.component.scss', + standalone: true, + imports: [ArtemisSharedCommonModule, ArtemisSharedPipesModule], +}) +export class IconCardComponent { + headerIcon = input(faCircleInfo); + + headline = input('Title'); +} diff --git a/src/main/webapp/i18n/de/tutorialGroups.json b/src/main/webapp/i18n/de/tutorialGroups.json index 021d7a6de739..6ba6bf79b1ef 100644 --- a/src/main/webapp/i18n/de/tutorialGroups.json +++ b/src/main/webapp/i18n/de/tutorialGroups.json @@ -55,7 +55,10 @@ "averageAttendanceDetail": "Durchschnittliche Anwesenheit", "averageAttendanceHelpDetail": "Durchschnittliche Anwesenheit in den letzten drei Sitzungen. Falls keine Anwesenheit eingetragen wurde, wird die entsprechende Sitzung ignoriert und die Berechnung mit zwei, bzw. einer Sitzung durchgeführt.", "profilePicture": "Tutor:in Profilbild", - "profilePictureAlt": "Profilbild von {{ user }}" + "profilePictureAlt": "Profilbild von {{ user }}", + "name": "Name", + "information": "Information", + "isNotOnline": "Nicht Online" }, "tutorialGroupSchedule": { "dayOfWeek": "Wochentag", diff --git a/src/main/webapp/i18n/en/tutorialGroups.json b/src/main/webapp/i18n/en/tutorialGroups.json index 7792eb659f6d..cc6b966db947 100644 --- a/src/main/webapp/i18n/en/tutorialGroups.json +++ b/src/main/webapp/i18n/en/tutorialGroups.json @@ -55,7 +55,10 @@ "averageAttendanceDetail": "Average Attendance", "averageAttendanceHelpDetail": "Average attendance in the last three sessions. If no attendance is entered, the corresponding session is ignored and the calculation is performed with two or one session.", "profilePicture": "Tutor Profile Picture", - "profilePictureAlt": "Profile picture of {{ user }}" + "profilePictureAlt": "Profile picture of {{ user }}", + "name": "Name", + "information": "Information", + "isNotOnline": "Not Online" }, "tutorialGroupSchedule": { "dayOfWeek": "Day of Week", diff --git a/src/test/javascript/spec/component/shared/icon-card/icon-card.component.spec.ts b/src/test/javascript/spec/component/shared/icon-card/icon-card.component.spec.ts new file mode 100644 index 000000000000..d96d5417b943 --- /dev/null +++ b/src/test/javascript/spec/component/shared/icon-card/icon-card.component.spec.ts @@ -0,0 +1,40 @@ +import { ComponentFixture, TestBed } from '@angular/core/testing'; +import { MockDirective } from 'ng-mocks'; +import { IconCardComponent } from 'app/shared/icon-card/icon-card.component'; +import { TranslateDirective } from 'app/shared/language/translate.directive'; +import { faCircleInfo, faCoffee } from '@fortawesome/free-solid-svg-icons'; + +describe('IconCardComponent', () => { + let component: IconCardComponent; + let fixture: ComponentFixture; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + imports: [], + declarations: [IconCardComponent, MockDirective(TranslateDirective)], + }).compileComponents(); + + fixture = TestBed.createComponent(IconCardComponent); + component = fixture.componentInstance; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).not.toBeNull(); + }); + + it('should display the default headerIcon and headline', () => { + expect(component.headerIcon()).toBe(faCircleInfo); + expect(component.headline()).toBe('Title'); + }); + + it('should display custom headerIcon and headline when inputs are set', () => { + fixture.componentRef.setInput('headerIcon', faCoffee); + fixture.componentRef.setInput('headline', 'Test'); + + fixture.detectChanges(); + + expect(component.headerIcon()).toBe(faCoffee); + expect(component.headline()).toBe('Test'); + }); +}); diff --git a/src/test/javascript/spec/component/tutorial-groups/shared/tutorial-group-detail.component.spec.ts b/src/test/javascript/spec/component/tutorial-groups/shared/tutorial-group-detail.component.spec.ts index 02d89da561e4..1290e595fbd3 100644 --- a/src/test/javascript/spec/component/tutorial-groups/shared/tutorial-group-detail.component.spec.ts +++ b/src/test/javascript/spec/component/tutorial-groups/shared/tutorial-group-detail.component.spec.ts @@ -1,7 +1,7 @@ import { TutorialGroupDetailComponent } from 'app/course/tutorial-groups/shared/tutorial-group-detail/tutorial-group-detail.component'; import { ComponentFixture, TestBed } from '@angular/core/testing'; import { ArtemisTranslatePipe } from 'app/shared/pipes/artemis-translate.pipe'; -import { MockComponent, MockPipe, MockProvider } from 'ng-mocks'; +import { MockComponent, MockDirective, MockPipe, MockProvider } from 'ng-mocks'; import { ArtemisMarkdownService } from 'app/shared/markdown.service'; import { generateExampleTutorialGroup } from '../helpers/tutorialGroupExampleModels'; import { ChangeDetectorRef, Component, Input, ViewChild } from '@angular/core'; @@ -11,7 +11,6 @@ import { FaIconComponent } from '@fortawesome/angular-fontawesome'; import { NgbTooltipMocksModule } from '../../../helpers/mocks/directive/ngbTooltipMocks.module'; import { TutorialGroupUtilizationIndicatorComponent } from 'app/course/tutorial-groups/shared/tutorial-group-utilization-indicator/tutorial-group-utilization-indicator.component'; import { RemoveSecondsPipe } from 'app/course/tutorial-groups/shared/remove-seconds.pipe'; -import { DetailOverviewListComponent } from 'app/detail-overview-list/detail-overview-list.component'; import { MockTranslateService } from '../../../helpers/mocks/service/mock-translate.service'; import { TranslateService } from '@ngx-translate/core'; import { provideHttpClientTesting } from '@angular/common/http/testing'; @@ -21,6 +20,8 @@ import dayjs from 'dayjs/esm'; import { TutorialGroupSessionStatus } from 'app/entities/tutorial-group/tutorial-group-session.model'; import { provideHttpClient } from '@angular/common/http'; import { RouterModule } from '@angular/router'; +import { TranslateDirective } from 'app/shared/language/translate.directive'; +import { IconCardComponent } from 'app/shared/icon-card/icon-card.component'; @Component({ selector: 'jhi-mock-header', template: '
' }) class MockHeaderComponent { @@ -60,13 +61,14 @@ describe('TutorialGroupDetailWrapperTest', () => { imports: [NgbTooltipMocksModule, RouterModule.forRoot([])], declarations: [ TutorialGroupDetailComponent, - DetailOverviewListComponent, MockWrapperComponent, MockHeaderComponent, + MockComponent(IconCardComponent), MockPipe(ArtemisTranslatePipe), MockPipe(RemoveSecondsPipe), MockComponent(FaIconComponent), MockComponent(TutorialGroupUtilizationIndicatorComponent), + MockDirective(TranslateDirective), ], providers: [ provideHttpClient(), @@ -78,7 +80,6 @@ describe('TutorialGroupDetailWrapperTest', () => { { provide: LocalStorageService, useClass: MockLocalStorageService }, ], }) - .overrideTemplate(DetailOverviewListComponent, '') .compileComponents() .then(() => { fixture = TestBed.createComponent(MockWrapperComponent); @@ -114,8 +115,10 @@ describe('TutorialGroupDetailComponent', () => { TutorialGroupDetailComponent, MockPipe(ArtemisTranslatePipe), MockComponent(FaIconComponent), + MockComponent(IconCardComponent), MockComponent(TutorialGroupUtilizationIndicatorComponent), MockPipe(RemoveSecondsPipe), + MockDirective(TranslateDirective), ], providers: [MockProvider(ArtemisMarkdownService), { provide: TranslateService, useClass: MockTranslateService }, MockProvider(ChangeDetectorRef)], }) From ebc28b21b833cc9d61d4ad02a6b5ae96727f4608 Mon Sep 17 00:00:00 2001 From: Michael Dyer <59163924+MichaelOwenDyer@users.noreply.github.com> Date: Sat, 12 Oct 2024 18:15:15 +0200 Subject: [PATCH 09/23] Iris: Add chat in text exercises (#9362) --- jest.config.js | 4 +- .../session/IrisTextExerciseChatSession.java | 48 +++ .../domain/settings/IrisCourseSettings.java | 14 + .../domain/settings/IrisExerciseSettings.java | 14 + .../domain/settings/IrisGlobalSettings.java | 14 + .../iris/domain/settings/IrisSettings.java | 4 + .../iris/domain/settings/IrisSubSettings.java | 1 + .../domain/settings/IrisSubSettingsType.java | 3 +- .../IrisTextExerciseChatSubSettings.java | 44 ++ .../iris/dto/IrisCombinedSettingsDTO.java | 11 +- ...ombinedTextExerciseChatSubSettingsDTO.java | 13 + .../repository/IrisSettingsRepository.java | 3 + ...IrisTextExerciseChatSessionRepository.java | 90 ++++ .../IrisCompetencyGenerationService.java | 2 +- .../iris/service/IrisSessionService.java | 10 +- .../pyris/PyrisStatusUpdateService.java | 22 +- ...sTextExerciseChatPipelineExecutionDTO.java | 14 + .../PyrisTextExerciseChatStatusUpdateDTO.java | 11 + .../pyris/dto/data/PyrisTextExerciseDTO.java | 33 ++ .../pyris/job/TextExerciseChatJob.java | 20 + .../IrisExerciseChatSessionService.java | 1 - .../IrisTextExerciseChatSessionService.java | 170 ++++++++ .../service/settings/IrisSettingsService.java | 118 ++++- .../settings/IrisSubSettingsService.java | 52 +++ .../web/IrisExerciseChatSessionResource.java | 3 + .../iris/web/IrisSettingsResource.java | 38 +- .../IrisTextExerciseChatSessionResource.java | 137 ++++++ .../open/PublicPyrisStatusUpdateResource.java | 28 +- .../changelog/20240909090909_changelog.xml | 11 + .../resources/config/liquibase/master.xml | 1 + .../iris/settings/iris-settings.model.ts | 11 +- .../iris/settings/iris-sub-settings.model.ts | 11 +- ...rcise-detail-common-actions.component.html | 11 + ...xercise-detail-common-actions.component.ts | 10 +- .../manage/exercise-hint-update.component.ts | 2 +- .../text-exercise/text-exercise.route.ts | 5 + .../participate/text-editor.component.html | 3 + .../text/participate/text-editor.component.ts | 19 + .../participate/text-participation.module.ts | 2 + .../exercise-chatbot-button.component.ts | 7 +- src/main/webapp/app/iris/iris-chat.service.ts | 3 +- .../iris-settings-update.component.html | 10 + .../iris-settings-update.component.ts | 14 +- .../settings/shared/iris-enabled.component.ts | 4 +- .../settings/shared/iris-settings.service.ts | 24 +- .../course-exercise-details.component.html | 2 +- .../course-exercise-details.component.ts | 2 + src/main/webapp/i18n/de/iris.json | 7 +- src/main/webapp/i18n/en/iris.json | 5 + .../connector/IrisRequestMockProvider.java | 17 +- .../iris/AbstractIrisIntegrationTest.java | 8 +- .../iris/IrisChatMessageIntegrationTest.java | 12 +- ...extExerciseChatMessageIntegrationTest.java | 404 ++++++++++++++++++ .../settings/IrisSettingsIntegrationTest.java | 32 +- .../exercise-hint-update.component.spec.ts | 2 +- ...s-course-settings-update.component.spec.ts | 2 +- .../settings/iris-enabled.component.spec.ts | 4 +- ...exercise-settings-update.component.spec.ts | 6 +- ...s-global-settings-update.component.spec.ts | 2 +- .../iris-settings-update-component.spec.ts | 2 +- .../settings/iris-settings.service.spec.ts | 6 +- .../component/iris/settings/mock-settings.ts | 11 +- .../exercise-chatbot-button.component.spec.ts | 23 +- ...se-detail-common-actions.component.spec.ts | 3 + 64 files changed, 1505 insertions(+), 115 deletions(-) create mode 100644 src/main/java/de/tum/cit/aet/artemis/iris/domain/session/IrisTextExerciseChatSession.java create mode 100644 src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisTextExerciseChatSubSettings.java create mode 100644 src/main/java/de/tum/cit/aet/artemis/iris/dto/IrisCombinedTextExerciseChatSubSettingsDTO.java create mode 100644 src/main/java/de/tum/cit/aet/artemis/iris/repository/IrisTextExerciseChatSessionRepository.java create mode 100644 src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/dto/chat/textexercise/PyrisTextExerciseChatPipelineExecutionDTO.java create mode 100644 src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/dto/chat/textexercise/PyrisTextExerciseChatStatusUpdateDTO.java create mode 100644 src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/dto/data/PyrisTextExerciseDTO.java create mode 100644 src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/job/TextExerciseChatJob.java create mode 100644 src/main/java/de/tum/cit/aet/artemis/iris/service/session/IrisTextExerciseChatSessionService.java create mode 100644 src/main/java/de/tum/cit/aet/artemis/iris/web/IrisTextExerciseChatSessionResource.java create mode 100644 src/main/resources/config/liquibase/changelog/20240909090909_changelog.xml create mode 100644 src/test/java/de/tum/cit/aet/artemis/iris/IrisTextExerciseChatMessageIntegrationTest.java diff --git a/jest.config.js b/jest.config.js index 77fd322375d8..24051b7ea3de 100644 --- a/jest.config.js +++ b/jest.config.js @@ -103,8 +103,8 @@ module.exports = { global: { // TODO: in the future, the following values should increase to at least 90% statements: 87.44, - branches: 73.74, - functions: 82.10, + branches: 73.73, + functions: 82.09, lines: 87.49, }, }, diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/domain/session/IrisTextExerciseChatSession.java b/src/main/java/de/tum/cit/aet/artemis/iris/domain/session/IrisTextExerciseChatSession.java new file mode 100644 index 000000000000..071c4c5ed325 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/iris/domain/session/IrisTextExerciseChatSession.java @@ -0,0 +1,48 @@ +package de.tum.cit.aet.artemis.iris.domain.session; + +import java.util.Optional; + +import jakarta.persistence.DiscriminatorValue; +import jakarta.persistence.Entity; +import jakarta.persistence.ManyToOne; + +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonInclude; + +import de.tum.cit.aet.artemis.core.domain.User; +import de.tum.cit.aet.artemis.text.domain.TextExercise; + +/** + * An IrisTextExerciseChatSession represents a conversation between a user and an LLM in the context of a text exercise. + * This is used for students receiving tutor assistance from Iris while working on a text exercise. + */ +@Entity +@DiscriminatorValue("TEXT_EXERCISE_CHAT") +@JsonInclude(JsonInclude.Include.NON_EMPTY) +public class IrisTextExerciseChatSession extends IrisChatSession { + + @ManyToOne + @JsonIgnore + private TextExercise exercise; + + public IrisTextExerciseChatSession() { + } + + public IrisTextExerciseChatSession(TextExercise exercise, User user) { + super(user); + this.exercise = exercise; + } + + public TextExercise getExercise() { + return exercise; + } + + public void setExercise(TextExercise exercise) { + this.exercise = exercise; + } + + @Override + public String toString() { + return "IrisTextExerciseChatSession{" + "user=" + Optional.ofNullable(getUser()).map(User::getLogin).orElse("null") + "," + "exercise=" + exercise + '}'; + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisCourseSettings.java b/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisCourseSettings.java index ca9d8723781f..fce389a7b95f 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisCourseSettings.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisCourseSettings.java @@ -28,6 +28,10 @@ public class IrisCourseSettings extends IrisSettings { @JoinColumn(name = "iris_chat_settings_id") private IrisChatSubSettings irisChatSettings; + @OneToOne(cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER) + @JoinColumn(name = "iris_text_exercise_chat_settings_id") + private IrisTextExerciseChatSubSettings irisTextExerciseChatSettings; + @OneToOne(cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER) @JoinColumn(name = "iris_lecture_ingestion_settings_id") private IrisLectureIngestionSubSettings irisLectureIngestionSettings; @@ -64,6 +68,16 @@ public void setIrisChatSettings(IrisChatSubSettings irisChatSettings) { this.irisChatSettings = irisChatSettings; } + @Override + public IrisTextExerciseChatSubSettings getIrisTextExerciseChatSettings() { + return irisTextExerciseChatSettings; + } + + @Override + public void setIrisTextExerciseChatSettings(IrisTextExerciseChatSubSettings irisTextExerciseChatSettings) { + this.irisTextExerciseChatSettings = irisTextExerciseChatSettings; + } + @Override public IrisCompetencyGenerationSubSettings getIrisCompetencyGenerationSettings() { return irisCompetencyGenerationSettings; diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisExerciseSettings.java b/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisExerciseSettings.java index fbfede75714c..ba095a018808 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisExerciseSettings.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisExerciseSettings.java @@ -28,6 +28,10 @@ public class IrisExerciseSettings extends IrisSettings { @JoinColumn(name = "iris_chat_settings_id") private IrisChatSubSettings irisChatSettings; + @OneToOne(cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER) + @JoinColumn(name = "iris_text_exercise_chat_settings_id") + private IrisTextExerciseChatSubSettings irisTextExerciseChatSettings; + public Exercise getExercise() { return exercise; } @@ -55,6 +59,16 @@ public void setIrisChatSettings(IrisChatSubSettings irisChatSettings) { this.irisChatSettings = irisChatSettings; } + @Override + public IrisTextExerciseChatSubSettings getIrisTextExerciseChatSettings() { + return irisTextExerciseChatSettings; + } + + @Override + public void setIrisTextExerciseChatSettings(IrisTextExerciseChatSubSettings irisTextExerciseChatSettings) { + this.irisTextExerciseChatSettings = irisTextExerciseChatSettings; + } + @Override public IrisCompetencyGenerationSubSettings getIrisCompetencyGenerationSettings() { return null; diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisGlobalSettings.java b/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisGlobalSettings.java index 587a85b37b22..ddb156da0038 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisGlobalSettings.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisGlobalSettings.java @@ -23,6 +23,10 @@ public class IrisGlobalSettings extends IrisSettings { @JoinColumn(name = "iris_chat_settings_id") private IrisChatSubSettings irisChatSettings; + @OneToOne(cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER, optional = false) + @JoinColumn(name = "iris_text_exercise_chat_settings_id") + private IrisTextExerciseChatSubSettings irisTextExerciseChatSettings; + @OneToOne(cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER, optional = false) @JoinColumn(name = "iris_lecture_ingestion_settings_id") private IrisLectureIngestionSubSettings irisLectureIngestionSettings; @@ -51,6 +55,16 @@ public void setIrisChatSettings(IrisChatSubSettings irisChatSettings) { this.irisChatSettings = irisChatSettings; } + @Override + public IrisTextExerciseChatSubSettings getIrisTextExerciseChatSettings() { + return irisTextExerciseChatSettings; + } + + @Override + public void setIrisTextExerciseChatSettings(IrisTextExerciseChatSubSettings irisTextExerciseChatSettings) { + this.irisTextExerciseChatSettings = irisTextExerciseChatSettings; + } + @Override public IrisCompetencyGenerationSubSettings getIrisCompetencyGenerationSettings() { return irisCompetencyGenerationSettings; diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisSettings.java b/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisSettings.java index 5efb75e76ea0..61b2912d5cf6 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisSettings.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisSettings.java @@ -45,6 +45,10 @@ public abstract class IrisSettings extends DomainObject { public abstract void setIrisChatSettings(IrisChatSubSettings irisChatSettings); + public abstract IrisTextExerciseChatSubSettings getIrisTextExerciseChatSettings(); + + public abstract void setIrisTextExerciseChatSettings(IrisTextExerciseChatSubSettings irisTextExerciseChatSettings); + public abstract IrisLectureIngestionSubSettings getIrisLectureIngestionSettings(); public abstract void setIrisLectureIngestionSettings(IrisLectureIngestionSubSettings irisLectureIngestionSettings); diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisSubSettings.java b/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisSubSettings.java index 5288c247e891..c9fc576311db 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisSubSettings.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisSubSettings.java @@ -39,6 +39,7 @@ // @formatter:off @JsonSubTypes({ @JsonSubTypes.Type(value = IrisChatSubSettings.class, name = "chat"), + @JsonSubTypes.Type(value = IrisTextExerciseChatSubSettings.class, name = "text-exercise-chat"), @JsonSubTypes.Type(value = IrisLectureIngestionSubSettings.class, name = "lecture-ingestion"), @JsonSubTypes.Type(value = IrisCompetencyGenerationSubSettings.class, name = "competency-generation") }) diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisSubSettingsType.java b/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisSubSettingsType.java index 2a8270d420bc..dafdd1edcfb9 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisSubSettingsType.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisSubSettingsType.java @@ -1,5 +1,6 @@ package de.tum.cit.aet.artemis.iris.domain.settings; public enum IrisSubSettingsType { - CHAT, COMPETENCY_GENERATION, LECTURE_INGESTION + CHAT, // TODO: Split into PROGRAMMING_EXERCISE_CHAT and COURSE_CHAT + TEXT_EXERCISE_CHAT, COMPETENCY_GENERATION, LECTURE_INGESTION } diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisTextExerciseChatSubSettings.java b/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisTextExerciseChatSubSettings.java new file mode 100644 index 000000000000..ed090bbe892a --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisTextExerciseChatSubSettings.java @@ -0,0 +1,44 @@ +package de.tum.cit.aet.artemis.iris.domain.settings; + +import jakarta.annotation.Nullable; +import jakarta.persistence.Column; +import jakarta.persistence.DiscriminatorValue; +import jakarta.persistence.Entity; + +import com.fasterxml.jackson.annotation.JsonInclude; + +/** + * An {@link IrisSubSettings} implementation for the settings for the chat in a text exercise. + */ +@Entity +@DiscriminatorValue("TEXT_EXERCISE_CHAT") +@JsonInclude(JsonInclude.Include.NON_EMPTY) +public class IrisTextExerciseChatSubSettings extends IrisSubSettings { + + @Nullable + @Column(name = "rate_limit") + private Integer rateLimit; + + @Nullable + @Column(name = "rate_limit_timeframe_hours") + private Integer rateLimitTimeframeHours; + + @Nullable + public Integer getRateLimit() { + return rateLimit; + } + + public void setRateLimit(@Nullable Integer rateLimit) { + this.rateLimit = rateLimit; + } + + @Nullable + public Integer getRateLimitTimeframeHours() { + return rateLimitTimeframeHours; + } + + public void setRateLimitTimeframeHours(@Nullable Integer rateLimitTimeframeHours) { + this.rateLimitTimeframeHours = rateLimitTimeframeHours; + } + +} diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/dto/IrisCombinedSettingsDTO.java b/src/main/java/de/tum/cit/aet/artemis/iris/dto/IrisCombinedSettingsDTO.java index 355b05ae551a..b05645603dbe 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/dto/IrisCombinedSettingsDTO.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/dto/IrisCombinedSettingsDTO.java @@ -2,7 +2,12 @@ import com.fasterxml.jackson.annotation.JsonInclude; +// @formatter:off @JsonInclude(JsonInclude.Include.NON_EMPTY) -public record IrisCombinedSettingsDTO(IrisCombinedChatSubSettingsDTO irisChatSettings, IrisCombinedLectureIngestionSubSettingsDTO irisLectureIngestionSettings, - IrisCombinedCompetencyGenerationSubSettingsDTO irisCompetencyGenerationSettings) { -} +public record IrisCombinedSettingsDTO( + IrisCombinedChatSubSettingsDTO irisChatSettings, + IrisCombinedTextExerciseChatSubSettingsDTO irisTextExerciseChatSettings, + IrisCombinedLectureIngestionSubSettingsDTO irisLectureIngestionSettings, + IrisCombinedCompetencyGenerationSubSettingsDTO irisCompetencyGenerationSettings +) {} +// @formatter:on diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/dto/IrisCombinedTextExerciseChatSubSettingsDTO.java b/src/main/java/de/tum/cit/aet/artemis/iris/dto/IrisCombinedTextExerciseChatSubSettingsDTO.java new file mode 100644 index 000000000000..4f02a2d87720 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/iris/dto/IrisCombinedTextExerciseChatSubSettingsDTO.java @@ -0,0 +1,13 @@ +package de.tum.cit.aet.artemis.iris.dto; + +import java.util.Set; + +import jakarta.annotation.Nullable; + +import com.fasterxml.jackson.annotation.JsonInclude; + +@JsonInclude(JsonInclude.Include.NON_EMPTY) +public record IrisCombinedTextExerciseChatSubSettingsDTO(boolean enabled, Integer rateLimit, Integer rateLimitTimeframeHours, @Nullable Set allowedVariants, + @Nullable String selectedVariant) { + +} diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/repository/IrisSettingsRepository.java b/src/main/java/de/tum/cit/aet/artemis/iris/repository/IrisSettingsRepository.java index 4dd037d54c77..c9e8eafba618 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/repository/IrisSettingsRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/repository/IrisSettingsRepository.java @@ -28,6 +28,7 @@ public interface IrisSettingsRepository extends ArtemisJpaRepository findExerciseSettings(@Param("exerciseId") long exerciseId); diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/repository/IrisTextExerciseChatSessionRepository.java b/src/main/java/de/tum/cit/aet/artemis/iris/repository/IrisTextExerciseChatSessionRepository.java new file mode 100644 index 000000000000..a8f76c5ff679 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/iris/repository/IrisTextExerciseChatSessionRepository.java @@ -0,0 +1,90 @@ +package de.tum.cit.aet.artemis.iris.repository; + +import static org.springframework.data.jpa.repository.EntityGraph.EntityGraphType.LOAD; + +import java.util.Collections; +import java.util.List; + +import jakarta.validation.constraints.NotNull; + +import org.springframework.data.domain.Pageable; +import org.springframework.data.jpa.repository.EntityGraph; +import org.springframework.data.jpa.repository.Query; +import org.springframework.data.repository.query.Param; + +import de.tum.cit.aet.artemis.core.domain.DomainObject; +import de.tum.cit.aet.artemis.core.exception.EntityNotFoundException; +import de.tum.cit.aet.artemis.core.repository.base.ArtemisJpaRepository; +import de.tum.cit.aet.artemis.iris.domain.session.IrisTextExerciseChatSession; + +/** + * Repository interface for managing {@link IrisTextExerciseChatSession} entities. + * Provides custom queries for finding text exercise chat sessions based on different criteria. + */ +public interface IrisTextExerciseChatSessionRepository extends ArtemisJpaRepository { + + /** + * Finds a list of {@link IrisTextExerciseChatSession} based on the exercise and user IDs. + * + * @param exerciseId The ID of the exercise. + * @param userId The ID of the user. + * @return A list of text exercise chat sessions sorted by creation date in descending order. + */ + @Query(""" + + SELECT s + FROM IrisTextExerciseChatSession s + WHERE s.exercise.id = :exerciseId + AND s.user.id = :userId + ORDER BY s.creationDate DESC + """) + List findByExerciseIdAndUserId(@Param("exerciseId") Long exerciseId, @Param("userId") Long userId); + + @Query(""" + SELECT s + FROM IrisTextExerciseChatSession s + WHERE s.exercise.id = :exerciseId + AND s.user.id = :userId + ORDER BY s.creationDate DESC + """) + List findSessionsByExerciseIdAndUserId(@Param("exerciseId") Long exerciseId, @Param("userId") Long userId, Pageable pageable); + + @EntityGraph(type = LOAD, attributePaths = "messages") + List findSessionsWithMessagesByIdIn(List ids); + + /** + * Finds the latest text exercise chat sessions by exercise ID and user ID, including their messages, with pagination support. + * This method avoids in-memory paging by retrieving the session IDs directly from the database. + * + * @param exerciseId the ID of the exercise to find the text exercise chat sessions for + * @param userId the ID of the user to find the text exercise chat sessions for + * @param pageable the pagination information + * @return a list of {@code IrisExerciseChatSession} with messages, or an empty list if no sessions are found + */ + default List findLatestByExerciseIdAndUserIdWithMessages(Long exerciseId, Long userId, Pageable pageable) { + List ids = findSessionsByExerciseIdAndUserId(exerciseId, userId, pageable).stream().map(DomainObject::getId).toList(); + + if (ids.isEmpty()) { + return Collections.emptyList(); + } + + return findSessionsWithMessagesByIdIn(ids); + } + + /** + * Finds a list of text exercise chat sessions or throws an exception if none are found. + * + * @param exerciseId The ID of the exercise. + * @param userId The ID of the user. + * @return A list of text exercise chat sessions. + * @throws EntityNotFoundException if no sessions are found. + */ + @NotNull + default List findByExerciseIdAndUserIdElseThrow(long exerciseId, long userId) throws EntityNotFoundException { + var result = findByExerciseIdAndUserId(exerciseId, userId); + if (result.isEmpty()) { + throw new EntityNotFoundException("Iris Text Exercise Chat Session"); + } + return result; + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/service/IrisCompetencyGenerationService.java b/src/main/java/de/tum/cit/aet/artemis/iris/service/IrisCompetencyGenerationService.java index 7c37831a611c..98182ae92b06 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/service/IrisCompetencyGenerationService.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/service/IrisCompetencyGenerationService.java @@ -17,7 +17,7 @@ import de.tum.cit.aet.artemis.iris.service.websocket.IrisWebsocketService; /** - * Service to handle the Competency generation subsytem of Iris. + * Service to handle the Competency generation subsystem of Iris. */ @Service @Profile(PROFILE_IRIS) diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/service/IrisSessionService.java b/src/main/java/de/tum/cit/aet/artemis/iris/service/IrisSessionService.java index c37844d9740a..308637e97bcf 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/service/IrisSessionService.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/service/IrisSessionService.java @@ -15,11 +15,13 @@ import de.tum.cit.aet.artemis.iris.domain.session.IrisCourseChatSession; import de.tum.cit.aet.artemis.iris.domain.session.IrisExerciseChatSession; import de.tum.cit.aet.artemis.iris.domain.session.IrisSession; +import de.tum.cit.aet.artemis.iris.domain.session.IrisTextExerciseChatSession; import de.tum.cit.aet.artemis.iris.service.session.IrisChatBasedFeatureInterface; import de.tum.cit.aet.artemis.iris.service.session.IrisCourseChatSessionService; import de.tum.cit.aet.artemis.iris.service.session.IrisExerciseChatSessionService; import de.tum.cit.aet.artemis.iris.service.session.IrisRateLimitedFeatureInterface; import de.tum.cit.aet.artemis.iris.service.session.IrisSubFeatureInterface; +import de.tum.cit.aet.artemis.iris.service.session.IrisTextExerciseChatSessionService; /** * Service for managing Iris sessions. @@ -30,13 +32,16 @@ public class IrisSessionService { private final UserRepository userRepository; + private final IrisTextExerciseChatSessionService irisTextExerciseChatSessionService; + private final IrisExerciseChatSessionService irisExerciseChatSessionService; private final IrisCourseChatSessionService irisCourseChatSessionService; - public IrisSessionService(UserRepository userRepository, IrisExerciseChatSessionService irisExerciseChatSessionService, - IrisCourseChatSessionService irisCourseChatSessionService) { + public IrisSessionService(UserRepository userRepository, IrisTextExerciseChatSessionService irisTextExerciseChatSessionService, + IrisExerciseChatSessionService irisExerciseChatSessionService, IrisCourseChatSessionService irisCourseChatSessionService) { this.userRepository = userRepository; + this.irisTextExerciseChatSessionService = irisTextExerciseChatSessionService; this.irisExerciseChatSessionService = irisExerciseChatSessionService; this.irisCourseChatSessionService = irisCourseChatSessionService; } @@ -131,6 +136,7 @@ public void checkRateLimit(IrisSession session, User user) { @SuppressWarnings("unchecked") private IrisSubFeatureWrapper getIrisSessionSubService(S session) { return switch (session) { + case IrisTextExerciseChatSession chatSession -> (IrisSubFeatureWrapper) new IrisSubFeatureWrapper<>(irisTextExerciseChatSessionService, chatSession); case IrisExerciseChatSession chatSession -> (IrisSubFeatureWrapper) new IrisSubFeatureWrapper<>(irisExerciseChatSessionService, chatSession); case IrisCourseChatSession courseChatSession -> (IrisSubFeatureWrapper) new IrisSubFeatureWrapper<>(irisCourseChatSessionService, courseChatSession); case null, default -> throw new BadRequestException("Unknown Iris session type " + session.getClass().getSimpleName()); diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/PyrisStatusUpdateService.java b/src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/PyrisStatusUpdateService.java index aed62b6049c1..9403da9beb56 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/PyrisStatusUpdateService.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/PyrisStatusUpdateService.java @@ -11,6 +11,7 @@ import de.tum.cit.aet.artemis.iris.service.IrisCompetencyGenerationService; import de.tum.cit.aet.artemis.iris.service.pyris.dto.chat.PyrisChatStatusUpdateDTO; +import de.tum.cit.aet.artemis.iris.service.pyris.dto.chat.textexercise.PyrisTextExerciseChatStatusUpdateDTO; import de.tum.cit.aet.artemis.iris.service.pyris.dto.competency.PyrisCompetencyStatusUpdateDTO; import de.tum.cit.aet.artemis.iris.service.pyris.dto.lectureingestionwebhook.PyrisLectureIngestionStatusUpdateDTO; import de.tum.cit.aet.artemis.iris.service.pyris.dto.status.PyrisStageDTO; @@ -19,8 +20,10 @@ import de.tum.cit.aet.artemis.iris.service.pyris.job.CourseChatJob; import de.tum.cit.aet.artemis.iris.service.pyris.job.ExerciseChatJob; import de.tum.cit.aet.artemis.iris.service.pyris.job.IngestionWebhookJob; +import de.tum.cit.aet.artemis.iris.service.pyris.job.TextExerciseChatJob; import de.tum.cit.aet.artemis.iris.service.session.IrisCourseChatSessionService; import de.tum.cit.aet.artemis.iris.service.session.IrisExerciseChatSessionService; +import de.tum.cit.aet.artemis.iris.service.session.IrisTextExerciseChatSessionService; @Service @Profile(PROFILE_IRIS) @@ -30,6 +33,8 @@ public class PyrisStatusUpdateService { private final IrisExerciseChatSessionService irisExerciseChatSessionService; + private final IrisTextExerciseChatSessionService irisTextExerciseChatSessionService; + private final IrisCourseChatSessionService courseChatSessionService; private final IrisCompetencyGenerationService competencyGenerationService; @@ -37,9 +42,11 @@ public class PyrisStatusUpdateService { private static final Logger log = LoggerFactory.getLogger(PyrisStatusUpdateService.class); public PyrisStatusUpdateService(PyrisJobService pyrisJobService, IrisExerciseChatSessionService irisExerciseChatSessionService, - IrisCourseChatSessionService courseChatSessionService, IrisCompetencyGenerationService competencyGenerationService) { + IrisTextExerciseChatSessionService irisTextExerciseChatSessionService, IrisCourseChatSessionService courseChatSessionService, + IrisCompetencyGenerationService competencyGenerationService) { this.pyrisJobService = pyrisJobService; this.irisExerciseChatSessionService = irisExerciseChatSessionService; + this.irisTextExerciseChatSessionService = irisTextExerciseChatSessionService; this.courseChatSessionService = courseChatSessionService; this.competencyGenerationService = competencyGenerationService; } @@ -56,6 +63,19 @@ public void handleStatusUpdate(ExerciseChatJob job, PyrisChatStatusUpdateDTO sta removeJobIfTerminated(statusUpdate.stages(), job.jobId()); } + /** + * Handles the status update of an exercise chat job and forwards it to + * {@link IrisTextExerciseChatSessionService#handleStatusUpdate(TextExerciseChatJob, PyrisTextExerciseChatStatusUpdateDTO)} + * + * @param job the job that is updated + * @param statusUpdate the status update + */ + public void handleStatusUpdate(TextExerciseChatJob job, PyrisTextExerciseChatStatusUpdateDTO statusUpdate) { + irisTextExerciseChatSessionService.handleStatusUpdate(job, statusUpdate); + + removeJobIfTerminated(statusUpdate.stages(), job.jobId()); + } + /** * Handles the status update of a course chat job and forwards it to * {@link de.tum.cit.aet.artemis.iris.service.session.IrisCourseChatSessionService#handleStatusUpdate(CourseChatJob, PyrisChatStatusUpdateDTO)} diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/dto/chat/textexercise/PyrisTextExerciseChatPipelineExecutionDTO.java b/src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/dto/chat/textexercise/PyrisTextExerciseChatPipelineExecutionDTO.java new file mode 100644 index 000000000000..1b2cf59d9fdb --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/dto/chat/textexercise/PyrisTextExerciseChatPipelineExecutionDTO.java @@ -0,0 +1,14 @@ +package de.tum.cit.aet.artemis.iris.service.pyris.dto.chat.textexercise; + +import java.util.List; + +import com.fasterxml.jackson.annotation.JsonInclude; + +import de.tum.cit.aet.artemis.iris.service.pyris.dto.PyrisPipelineExecutionDTO; +import de.tum.cit.aet.artemis.iris.service.pyris.dto.data.PyrisMessageDTO; +import de.tum.cit.aet.artemis.iris.service.pyris.dto.data.PyrisTextExerciseDTO; + +@JsonInclude(JsonInclude.Include.NON_EMPTY) +public record PyrisTextExerciseChatPipelineExecutionDTO(PyrisPipelineExecutionDTO execution, PyrisTextExerciseDTO exercise, List conversation, + String currentSubmission) { +} diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/dto/chat/textexercise/PyrisTextExerciseChatStatusUpdateDTO.java b/src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/dto/chat/textexercise/PyrisTextExerciseChatStatusUpdateDTO.java new file mode 100644 index 000000000000..e8b5de7a950b --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/dto/chat/textexercise/PyrisTextExerciseChatStatusUpdateDTO.java @@ -0,0 +1,11 @@ +package de.tum.cit.aet.artemis.iris.service.pyris.dto.chat.textexercise; + +import java.util.List; + +import com.fasterxml.jackson.annotation.JsonInclude; + +import de.tum.cit.aet.artemis.iris.service.pyris.dto.status.PyrisStageDTO; + +@JsonInclude(JsonInclude.Include.NON_EMPTY) +public record PyrisTextExerciseChatStatusUpdateDTO(String result, List stages) { +} diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/dto/data/PyrisTextExerciseDTO.java b/src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/dto/data/PyrisTextExerciseDTO.java new file mode 100644 index 000000000000..8ba3b1f9aaa8 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/dto/data/PyrisTextExerciseDTO.java @@ -0,0 +1,33 @@ +package de.tum.cit.aet.artemis.iris.service.pyris.dto.data; + +import java.time.Instant; +import java.time.chrono.ChronoZonedDateTime; +import java.util.Optional; + +import com.fasterxml.jackson.annotation.JsonInclude; + +import de.tum.cit.aet.artemis.text.domain.TextExercise; + +@JsonInclude(JsonInclude.Include.NON_EMPTY) +public record PyrisTextExerciseDTO(long id, String title, PyrisCourseDTO course, String problemStatement, Instant startDate, Instant endDate) { + + /** + * Create a new PyrisTextExerciseDTO from the given TextExercise + * + * @param exercise the exercise + * @return the dto + */ + public static PyrisTextExerciseDTO of(TextExercise exercise) { + // @formatter:off + return new PyrisTextExerciseDTO( + exercise.getId(), + exercise.getTitle(), + new PyrisCourseDTO(exercise.getCourseViaExerciseGroupOrCourseMember()), + exercise.getProblemStatement(), + Optional.ofNullable(exercise.getStartDate()).map(ChronoZonedDateTime::toInstant).orElse(null), + Optional.ofNullable(exercise.getDueDate()).map(ChronoZonedDateTime::toInstant).orElse(null) + ); + // @formatter:on + } + +} diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/job/TextExerciseChatJob.java b/src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/job/TextExerciseChatJob.java new file mode 100644 index 000000000000..b7dd4bb50046 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/job/TextExerciseChatJob.java @@ -0,0 +1,20 @@ +package de.tum.cit.aet.artemis.iris.service.pyris.job; + +import com.fasterxml.jackson.annotation.JsonInclude; + +import de.tum.cit.aet.artemis.core.domain.Course; +import de.tum.cit.aet.artemis.exercise.domain.Exercise; + +@JsonInclude(JsonInclude.Include.NON_EMPTY) +public record TextExerciseChatJob(String jobId, long courseId, long exerciseId, long sessionId) implements PyrisJob { + + @Override + public boolean canAccess(Course course) { + return course.getId().equals(courseId); + } + + @Override + public boolean canAccess(Exercise exercise) { + return exercise.getId().equals(exerciseId); + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/service/session/IrisExerciseChatSessionService.java b/src/main/java/de/tum/cit/aet/artemis/iris/service/session/IrisExerciseChatSessionService.java index 47e0da357ea9..d520540a2db4 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/service/session/IrisExerciseChatSessionService.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/service/session/IrisExerciseChatSessionService.java @@ -142,7 +142,6 @@ public void requestAndHandleResponse(IrisExerciseChatSession session) { if (chatSession.getExercise().isExamExercise()) { throw new ConflictException("Iris is not supported for exam exercises", "Iris", "irisExamExercise"); } - // TODO support more exercise types var exercise = programmingExerciseRepository.findByIdWithTemplateAndSolutionParticipationElseThrow(chatSession.getExercise().getId()); var latestSubmission = getLatestSubmissionIfExists(exercise, chatSession.getUser()); diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/service/session/IrisTextExerciseChatSessionService.java b/src/main/java/de/tum/cit/aet/artemis/iris/service/session/IrisTextExerciseChatSessionService.java new file mode 100644 index 000000000000..4520417aad48 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/iris/service/session/IrisTextExerciseChatSessionService.java @@ -0,0 +1,170 @@ +package de.tum.cit.aet.artemis.iris.service.session; + +import java.util.Comparator; + +import org.springframework.context.annotation.Profile; +import org.springframework.stereotype.Service; + +import de.tum.cit.aet.artemis.core.domain.User; +import de.tum.cit.aet.artemis.core.exception.AccessForbiddenException; +import de.tum.cit.aet.artemis.core.exception.ConflictException; +import de.tum.cit.aet.artemis.core.security.Role; +import de.tum.cit.aet.artemis.core.service.AuthorizationCheckService; +import de.tum.cit.aet.artemis.exercise.domain.Submission; +import de.tum.cit.aet.artemis.exercise.repository.StudentParticipationRepository; +import de.tum.cit.aet.artemis.iris.domain.message.IrisMessage; +import de.tum.cit.aet.artemis.iris.domain.message.IrisMessageSender; +import de.tum.cit.aet.artemis.iris.domain.message.IrisTextMessageContent; +import de.tum.cit.aet.artemis.iris.domain.session.IrisTextExerciseChatSession; +import de.tum.cit.aet.artemis.iris.domain.settings.IrisSubSettingsType; +import de.tum.cit.aet.artemis.iris.repository.IrisSessionRepository; +import de.tum.cit.aet.artemis.iris.service.IrisMessageService; +import de.tum.cit.aet.artemis.iris.service.IrisRateLimitService; +import de.tum.cit.aet.artemis.iris.service.pyris.PyrisJobService; +import de.tum.cit.aet.artemis.iris.service.pyris.PyrisPipelineService; +import de.tum.cit.aet.artemis.iris.service.pyris.dto.chat.textexercise.PyrisTextExerciseChatPipelineExecutionDTO; +import de.tum.cit.aet.artemis.iris.service.pyris.dto.chat.textexercise.PyrisTextExerciseChatStatusUpdateDTO; +import de.tum.cit.aet.artemis.iris.service.pyris.dto.data.PyrisMessageDTO; +import de.tum.cit.aet.artemis.iris.service.pyris.dto.data.PyrisTextExerciseDTO; +import de.tum.cit.aet.artemis.iris.service.pyris.job.TextExerciseChatJob; +import de.tum.cit.aet.artemis.iris.service.settings.IrisSettingsService; +import de.tum.cit.aet.artemis.iris.service.websocket.IrisChatWebsocketService; +import de.tum.cit.aet.artemis.text.domain.TextSubmission; +import de.tum.cit.aet.artemis.text.repository.TextExerciseRepository; + +@Service +@Profile("iris") +public class IrisTextExerciseChatSessionService implements IrisChatBasedFeatureInterface, IrisRateLimitedFeatureInterface { + + private final IrisSettingsService irisSettingsService; + + private final IrisSessionRepository irisSessionRepository; + + private final IrisRateLimitService rateLimitService; + + private final IrisMessageService irisMessageService; + + private final TextExerciseRepository textExerciseRepository; + + private final StudentParticipationRepository studentParticipationRepository; + + private final PyrisPipelineService pyrisPipelineService; + + private final PyrisJobService pyrisJobService; + + private final IrisChatWebsocketService irisChatWebsocketService; + + private final AuthorizationCheckService authCheckService; + + public IrisTextExerciseChatSessionService(IrisSettingsService irisSettingsService, IrisSessionRepository irisSessionRepository, IrisRateLimitService rateLimitService, + IrisMessageService irisMessageService, TextExerciseRepository textExerciseRepository, StudentParticipationRepository studentParticipationRepository, + PyrisPipelineService pyrisPipelineService, PyrisJobService pyrisJobService, IrisChatWebsocketService irisChatWebsocketService, + AuthorizationCheckService authCheckService) { + this.irisSettingsService = irisSettingsService; + this.irisSessionRepository = irisSessionRepository; + this.rateLimitService = rateLimitService; + this.irisMessageService = irisMessageService; + this.textExerciseRepository = textExerciseRepository; + this.studentParticipationRepository = studentParticipationRepository; + this.pyrisPipelineService = pyrisPipelineService; + this.pyrisJobService = pyrisJobService; + this.irisChatWebsocketService = irisChatWebsocketService; + this.authCheckService = authCheckService; + } + + @Override + public void sendOverWebsocket(IrisTextExerciseChatSession session, IrisMessage message) { + irisChatWebsocketService.sendMessage(session, message, null); + } + + @Override + public void requestAndHandleResponse(IrisTextExerciseChatSession irisSession) { + var session = (IrisTextExerciseChatSession) irisSessionRepository.findByIdWithMessagesAndContents(irisSession.getId()); + if (session.getExercise().isExamExercise()) { + throw new ConflictException("Iris is not supported for exam exercises", "Iris", "irisExamExercise"); + } + var exercise = textExerciseRepository.findByIdElseThrow(session.getExercise().getId()); + if (!irisSettingsService.isEnabledFor(IrisSubSettingsType.TEXT_EXERCISE_CHAT, exercise)) { + throw new ConflictException("Iris is not enabled for this exercise", "Iris", "irisDisabled"); + } + var course = exercise.getCourseViaExerciseGroupOrCourseMember(); + // TODO: Once we can receive client form data through the IrisMessageResource, we should use that instead of fetching the latest submission to get the text + var participation = studentParticipationRepository.findWithEagerLegalSubmissionsByExerciseIdAndStudentLogin(exercise.getId(), session.getUser().getLogin()); + var latestSubmission = participation.flatMap(p -> p.getSubmissions().stream().max(Comparator.comparingLong(Submission::getId))).orElse(null); + String latestSubmissionText; + if (latestSubmission instanceof TextSubmission textSubmission) { + latestSubmissionText = textSubmission.getText(); + } + else { + latestSubmissionText = null; + } + var conversation = session.getMessages().stream().map(PyrisMessageDTO::of).toList(); + // @formatter:off + pyrisPipelineService.executePipeline( + "text-exercise-chat", + "default", + pyrisJobService.createTokenForJob(token -> new TextExerciseChatJob(token, course.getId(), exercise.getId(), session.getId())), + dto -> new PyrisTextExerciseChatPipelineExecutionDTO(dto, PyrisTextExerciseDTO.of(exercise), conversation, latestSubmissionText), + stages -> irisChatWebsocketService.sendMessage(session, null, stages) + ); + // @formatter:on + } + + /** + * Handles the status update of a text exercise chat job. + * + * @param job The job that is updated + * @param statusUpdate The status update + */ + public void handleStatusUpdate(TextExerciseChatJob job, PyrisTextExerciseChatStatusUpdateDTO statusUpdate) { + var session = (IrisTextExerciseChatSession) irisSessionRepository.findByIdElseThrow(job.sessionId()); + if (statusUpdate.result() != null) { + var message = session.newMessage(); + message.addContent(new IrisTextMessageContent(statusUpdate.result())); + IrisMessage savedMessage = irisMessageService.saveMessage(message, session, IrisMessageSender.LLM); + irisChatWebsocketService.sendMessage(session, savedMessage, statusUpdate.stages()); + } + else { + irisChatWebsocketService.sendMessage(session, null, statusUpdate.stages()); + } + } + + @Override + public void checkHasAccessTo(User user, IrisTextExerciseChatSession session) { + // TODO: This check is probably unnecessary since we are fetching the sessions from the database with the user ID already + if (!session.getUser().equals(user)) { + throw new AccessForbiddenException("Iris Text Exercise Chat Session", session.getId()); + } + // TODO: This check is probably unnecessary as the endpoint already checks it via the @EnforceAtLeastStudentInExercise annotation + authCheckService.checkHasAtLeastRoleForExerciseElseThrow(Role.STUDENT, session.getExercise(), user); + } + + /** + * This method returns true if the user has access to the given session. + * The user has access iff the user is a student in the exercise's course, + * and they are the same user that created the session. + * + * @param user The user to check + * @param session The session to check + * @return True if the user has access, false otherwise + */ + public boolean hasAccess(User user, IrisTextExerciseChatSession session) { + try { + checkHasAccessTo(user, session); + return true; + } + catch (AccessForbiddenException e) { + return false; + } + } + + @Override + public void checkIsFeatureActivatedFor(IrisTextExerciseChatSession session) { + irisSettingsService.isEnabledForElseThrow(IrisSubSettingsType.TEXT_EXERCISE_CHAT, session.getExercise()); + } + + @Override + public void checkRateLimit(User user) { + rateLimitService.checkRateLimitElseThrow(user); + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/service/settings/IrisSettingsService.java b/src/main/java/de/tum/cit/aet/artemis/iris/service/settings/IrisSettingsService.java index bf9d4a8d35d3..fb8820a4c08b 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/service/settings/IrisSettingsService.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/service/settings/IrisSettingsService.java @@ -34,6 +34,7 @@ import de.tum.cit.aet.artemis.iris.domain.settings.IrisSettings; import de.tum.cit.aet.artemis.iris.domain.settings.IrisSubSettings; import de.tum.cit.aet.artemis.iris.domain.settings.IrisSubSettingsType; +import de.tum.cit.aet.artemis.iris.domain.settings.IrisTextExerciseChatSubSettings; import de.tum.cit.aet.artemis.iris.dto.IrisCombinedSettingsDTO; import de.tum.cit.aet.artemis.iris.repository.IrisSettingsRepository; @@ -86,6 +87,7 @@ private void createInitialGlobalSettings() { var settings = new IrisGlobalSettings(); initializeIrisChatSettings(settings); + initializeIrisTextExerciseChatSettings(settings); initializeIrisLectureIngestionSettings(settings); initializeIrisCompetencyGenerationSettings(settings); @@ -108,6 +110,12 @@ private void initializeIrisChatSettings(IrisGlobalSettings settings) { settings.setIrisChatSettings(irisChatSettings); } + private void initializeIrisTextExerciseChatSettings(IrisGlobalSettings settings) { + var irisChatSettings = settings.getIrisTextExerciseChatSettings(); + irisChatSettings = initializeSettings(irisChatSettings, IrisTextExerciseChatSubSettings::new); + settings.setIrisTextExerciseChatSettings(irisChatSettings); + } + private void initializeIrisLectureIngestionSettings(IrisGlobalSettings settings) { var irisLectureIngestionSettings = settings.getIrisLectureIngestionSettings(); irisLectureIngestionSettings = initializeSettings(irisLectureIngestionSettings, IrisLectureIngestionSubSettings::new); @@ -202,11 +210,32 @@ else if (existingSettings instanceof IrisExerciseSettings exerciseSettings && se * @return The updated global Iris settings */ private IrisGlobalSettings updateGlobalSettings(IrisGlobalSettings existingSettings, IrisGlobalSettings settingsUpdate) { - existingSettings.setIrisLectureIngestionSettings( - irisSubSettingsService.update(existingSettings.getIrisLectureIngestionSettings(), settingsUpdate.getIrisLectureIngestionSettings(), null, GLOBAL)); - existingSettings.setIrisChatSettings(irisSubSettingsService.update(existingSettings.getIrisChatSettings(), settingsUpdate.getIrisChatSettings(), null, GLOBAL)); - existingSettings.setIrisCompetencyGenerationSettings( - irisSubSettingsService.update(existingSettings.getIrisCompetencyGenerationSettings(), settingsUpdate.getIrisCompetencyGenerationSettings(), null, GLOBAL)); + // @formatter:off + existingSettings.setIrisLectureIngestionSettings(irisSubSettingsService.update( + existingSettings.getIrisLectureIngestionSettings(), + settingsUpdate.getIrisLectureIngestionSettings(), + null, + GLOBAL + )); + existingSettings.setIrisTextExerciseChatSettings(irisSubSettingsService.update( + existingSettings.getIrisTextExerciseChatSettings(), + settingsUpdate.getIrisTextExerciseChatSettings(), + null, + GLOBAL + )); + existingSettings.setIrisChatSettings(irisSubSettingsService.update( + existingSettings.getIrisChatSettings(), + settingsUpdate.getIrisChatSettings(), + null, + GLOBAL + )); + existingSettings.setIrisCompetencyGenerationSettings(irisSubSettingsService.update( + existingSettings.getIrisCompetencyGenerationSettings(), + settingsUpdate.getIrisCompetencyGenerationSettings(), + null, + GLOBAL + )); + // @formatter:on return irisSettingsRepository.save(existingSettings); } @@ -220,12 +249,32 @@ private IrisGlobalSettings updateGlobalSettings(IrisGlobalSettings existingSetti */ private IrisCourseSettings updateCourseSettings(IrisCourseSettings existingSettings, IrisCourseSettings settingsUpdate) { var parentSettings = getCombinedIrisGlobalSettings(); - existingSettings.setIrisChatSettings( - irisSubSettingsService.update(existingSettings.getIrisChatSettings(), settingsUpdate.getIrisChatSettings(), parentSettings.irisChatSettings(), COURSE)); - existingSettings.setIrisLectureIngestionSettings(irisSubSettingsService.update(existingSettings.getIrisLectureIngestionSettings(), - settingsUpdate.getIrisLectureIngestionSettings(), parentSettings.irisLectureIngestionSettings(), COURSE)); - existingSettings.setIrisCompetencyGenerationSettings(irisSubSettingsService.update(existingSettings.getIrisCompetencyGenerationSettings(), - settingsUpdate.getIrisCompetencyGenerationSettings(), parentSettings.irisCompetencyGenerationSettings(), COURSE)); + // @formatter:off + existingSettings.setIrisChatSettings(irisSubSettingsService.update( + existingSettings.getIrisChatSettings(), + settingsUpdate.getIrisChatSettings(), + parentSettings.irisChatSettings(), + COURSE + )); + existingSettings.setIrisTextExerciseChatSettings(irisSubSettingsService.update( + existingSettings.getIrisTextExerciseChatSettings(), + settingsUpdate.getIrisTextExerciseChatSettings(), + parentSettings.irisTextExerciseChatSettings(), + COURSE + )); + existingSettings.setIrisLectureIngestionSettings(irisSubSettingsService.update( + existingSettings.getIrisLectureIngestionSettings(), + settingsUpdate.getIrisLectureIngestionSettings(), + parentSettings.irisLectureIngestionSettings(), + COURSE + )); + existingSettings.setIrisCompetencyGenerationSettings(irisSubSettingsService.update( + existingSettings.getIrisCompetencyGenerationSettings(), + settingsUpdate.getIrisCompetencyGenerationSettings(), + parentSettings.irisCompetencyGenerationSettings(), + COURSE + )); + // @formatter:on return irisSettingsRepository.save(existingSettings); } @@ -239,8 +288,20 @@ private IrisCourseSettings updateCourseSettings(IrisCourseSettings existingSetti */ private IrisExerciseSettings updateExerciseSettings(IrisExerciseSettings existingSettings, IrisExerciseSettings settingsUpdate) { var parentSettings = getCombinedIrisSettingsFor(existingSettings.getExercise().getCourseViaExerciseGroupOrCourseMember(), false); - existingSettings.setIrisChatSettings( - irisSubSettingsService.update(existingSettings.getIrisChatSettings(), settingsUpdate.getIrisChatSettings(), parentSettings.irisChatSettings(), EXERCISE)); + // @formatter:off + existingSettings.setIrisChatSettings(irisSubSettingsService.update( + existingSettings.getIrisChatSettings(), + settingsUpdate.getIrisChatSettings(), + parentSettings.irisChatSettings(), + EXERCISE + )); + existingSettings.setIrisTextExerciseChatSettings(irisSubSettingsService.update( + existingSettings.getIrisTextExerciseChatSettings(), + settingsUpdate.getIrisTextExerciseChatSettings(), + parentSettings.irisTextExerciseChatSettings(), + EXERCISE + )); + // @formatter:on return irisSettingsRepository.save(existingSettings); } @@ -304,8 +365,14 @@ public IrisCombinedSettingsDTO getCombinedIrisGlobalSettings() { var settingsList = new ArrayList(); settingsList.add(getGlobalSettings()); - return new IrisCombinedSettingsDTO(irisSubSettingsService.combineChatSettings(settingsList, false), - irisSubSettingsService.combineLectureIngestionSubSettings(settingsList, false), irisSubSettingsService.combineCompetencyGenerationSettings(settingsList, false)); + // @formatter:off + return new IrisCombinedSettingsDTO( + irisSubSettingsService.combineChatSettings(settingsList, false), + irisSubSettingsService.combineTextExerciseChatSettings(settingsList, false), + irisSubSettingsService.combineLectureIngestionSubSettings(settingsList, false), + irisSubSettingsService.combineCompetencyGenerationSettings(settingsList, false) + ); + // @formatter:on } /** @@ -323,9 +390,14 @@ public IrisCombinedSettingsDTO getCombinedIrisSettingsFor(Course course, boolean settingsList.add(getGlobalSettings()); settingsList.add(irisSettingsRepository.findCourseSettings(course.getId()).orElse(null)); - return new IrisCombinedSettingsDTO(irisSubSettingsService.combineChatSettings(settingsList, minimal), + // @formatter:off + return new IrisCombinedSettingsDTO( + irisSubSettingsService.combineChatSettings(settingsList, minimal), + irisSubSettingsService.combineTextExerciseChatSettings(settingsList, minimal), irisSubSettingsService.combineLectureIngestionSubSettings(settingsList, minimal), - irisSubSettingsService.combineCompetencyGenerationSettings(settingsList, minimal)); + irisSubSettingsService.combineCompetencyGenerationSettings(settingsList, minimal) + ); + // @formatter:on } /** @@ -344,9 +416,14 @@ public IrisCombinedSettingsDTO getCombinedIrisSettingsFor(Exercise exercise, boo settingsList.add(getRawIrisSettingsFor(exercise.getCourseViaExerciseGroupOrCourseMember())); settingsList.add(getRawIrisSettingsFor(exercise)); - return new IrisCombinedSettingsDTO(irisSubSettingsService.combineChatSettings(settingsList, minimal), + // @formatter:off + return new IrisCombinedSettingsDTO( + irisSubSettingsService.combineChatSettings(settingsList, minimal), + irisSubSettingsService.combineTextExerciseChatSettings(settingsList, minimal), irisSubSettingsService.combineLectureIngestionSubSettings(settingsList, minimal), - irisSubSettingsService.combineCompetencyGenerationSettings(settingsList, minimal)); + irisSubSettingsService.combineCompetencyGenerationSettings(settingsList, minimal) + ); + // @formatter:on } /** @@ -373,6 +450,7 @@ public IrisCourseSettings getDefaultSettingsFor(Course course) { settings.setIrisLectureIngestionSettings(new IrisLectureIngestionSubSettings()); settings.setIrisChatSettings(new IrisChatSubSettings()); settings.setIrisCompetencyGenerationSettings(new IrisCompetencyGenerationSubSettings()); + settings.setIrisTextExerciseChatSettings(new IrisTextExerciseChatSubSettings()); return settings; } @@ -387,6 +465,7 @@ public IrisExerciseSettings getDefaultSettingsFor(Exercise exercise) { var settings = new IrisExerciseSettings(); settings.setExercise(exercise); settings.setIrisChatSettings(new IrisChatSubSettings()); + settings.setIrisTextExerciseChatSettings(new IrisTextExerciseChatSubSettings()); return settings; } @@ -444,6 +523,7 @@ public void deleteSettingsFor(Exercise exercise) { private boolean isFeatureEnabledInSettings(IrisCombinedSettingsDTO settings, IrisSubSettingsType type) { return switch (type) { case CHAT -> settings.irisChatSettings().enabled(); + case TEXT_EXERCISE_CHAT -> settings.irisTextExerciseChatSettings().enabled(); case COMPETENCY_GENERATION -> settings.irisCompetencyGenerationSettings().enabled(); case LECTURE_INGESTION -> settings.irisLectureIngestionSettings().enabled(); }; diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/service/settings/IrisSubSettingsService.java b/src/main/java/de/tum/cit/aet/artemis/iris/service/settings/IrisSubSettingsService.java index 5a3c20b4c810..4e804701151a 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/service/settings/IrisSubSettingsService.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/service/settings/IrisSubSettingsService.java @@ -22,9 +22,11 @@ import de.tum.cit.aet.artemis.iris.domain.settings.IrisSettings; import de.tum.cit.aet.artemis.iris.domain.settings.IrisSettingsType; import de.tum.cit.aet.artemis.iris.domain.settings.IrisSubSettings; +import de.tum.cit.aet.artemis.iris.domain.settings.IrisTextExerciseChatSubSettings; import de.tum.cit.aet.artemis.iris.dto.IrisCombinedChatSubSettingsDTO; import de.tum.cit.aet.artemis.iris.dto.IrisCombinedCompetencyGenerationSubSettingsDTO; import de.tum.cit.aet.artemis.iris.dto.IrisCombinedLectureIngestionSubSettingsDTO; +import de.tum.cit.aet.artemis.iris.dto.IrisCombinedTextExerciseChatSubSettingsDTO; /** * Service for handling {@link IrisSubSettings} objects. @@ -79,6 +81,39 @@ public IrisChatSubSettings update(IrisChatSubSettings currentSettings, IrisChatS return currentSettings; } + /** + * Updates a text exercise chat sub settings object. + * + * @param currentSettings Current chat sub settings. + * @param newSettings Updated chat sub settings. + * @param parentSettings Parent chat sub settings. + * @param settingsType Type of the settings the sub settings belong to. + * @return Updated chat sub settings. + */ + public IrisTextExerciseChatSubSettings update(IrisTextExerciseChatSubSettings currentSettings, IrisTextExerciseChatSubSettings newSettings, + IrisCombinedTextExerciseChatSubSettingsDTO parentSettings, IrisSettingsType settingsType) { + if (newSettings == null) { + if (parentSettings == null) { + throw new IllegalArgumentException("Cannot delete the chat settings"); + } + return null; + } + if (currentSettings == null) { + currentSettings = new IrisTextExerciseChatSubSettings(); + } + if (settingsType == IrisSettingsType.EXERCISE || authCheckService.isAdmin()) { + currentSettings.setEnabled(newSettings.isEnabled()); + } + if (authCheckService.isAdmin()) { + currentSettings.setRateLimit(newSettings.getRateLimit()); + currentSettings.setRateLimitTimeframeHours(newSettings.getRateLimitTimeframeHours()); + } + currentSettings.setAllowedVariants(selectAllowedVariants(currentSettings.getAllowedVariants(), newSettings.getAllowedVariants())); + currentSettings.setSelectedVariant(validateSelectedVariant(currentSettings.getSelectedVariant(), newSettings.getSelectedVariant(), currentSettings.getAllowedVariants(), + parentSettings != null ? parentSettings.allowedVariants() : null)); + return currentSettings; + } + /** * Updates a Lecture Ingestion sub settings object. * If the new settings are null, the current settings will be deleted (except if the parent settings are null == if the settings are global). @@ -180,6 +215,23 @@ private String validateSelectedVariant(String selectedVariant, String newSelecte return selectedVariant; } + /** + * Combines the chat settings of multiple {@link IrisSettings} objects. + * If minimal is true, the returned object will only contain the enabled and rateLimit fields. + * The minimal version can safely be sent to students. + * + * @param settingsList List of {@link IrisSettings} objects to combine. + * @param minimal Whether to return a minimal version of the combined settings. + * @return Combined chat settings. + */ + public IrisCombinedTextExerciseChatSubSettingsDTO combineTextExerciseChatSettings(ArrayList settingsList, boolean minimal) { + var enabled = getCombinedEnabled(settingsList, IrisSettings::getIrisTextExerciseChatSettings); + var rateLimit = getCombinedRateLimit(settingsList); + var allowedVariants = !minimal ? getCombinedAllowedVariants(settingsList, IrisSettings::getIrisChatSettings) : null; + var selectedVariant = !minimal ? getCombinedSelectedVariant(settingsList, IrisSettings::getIrisChatSettings) : null; + return new IrisCombinedTextExerciseChatSubSettingsDTO(enabled, rateLimit, null, allowedVariants, selectedVariant); + } + /** * Combines the chat settings of multiple {@link IrisSettings} objects. * If minimal is true, the returned object will only contain the enabled and rateLimit fields. diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/web/IrisExerciseChatSessionResource.java b/src/main/java/de/tum/cit/aet/artemis/iris/web/IrisExerciseChatSessionResource.java index 55204aa63397..9e736ce8c358 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/web/IrisExerciseChatSessionResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/web/IrisExerciseChatSessionResource.java @@ -35,6 +35,7 @@ @Profile(PROFILE_IRIS) @RestController @RequestMapping("api/iris/exercise-chat/") +// TODO: Rename to IrisProgrammingExerciseChatSessionResource public class IrisExerciseChatSessionResource { protected final UserRepository userRepository; @@ -47,6 +48,7 @@ public class IrisExerciseChatSessionResource { protected final IrisRateLimitService irisRateLimitService; + // TODO: This could be a ProgrammingExerciseRepository protected final ExerciseRepository exerciseRepository; private final IrisExerciseChatSessionRepository irisExerciseChatSessionRepository; @@ -134,6 +136,7 @@ public ResponseEntity createSessionForExercise(@PathVar private static ProgrammingExercise validateExercise(Exercise exercise) { if (!(exercise instanceof ProgrammingExercise programmingExercise)) { + // TODO: Remove this once we are only fetching ProgrammingExercises from the DB anyway throw new ConflictException("Iris is only supported for programming exercises", "Iris", "irisProgrammingExercise"); } if (exercise.isExamExercise()) { diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/web/IrisSettingsResource.java b/src/main/java/de/tum/cit/aet/artemis/iris/web/IrisSettingsResource.java index a4f51180b159..4f2c5416211d 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/web/IrisSettingsResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/web/IrisSettingsResource.java @@ -22,12 +22,12 @@ import de.tum.cit.aet.artemis.core.security.annotations.enforceRoleInExercise.EnforceAtLeastInstructorInExercise; import de.tum.cit.aet.artemis.core.security.annotations.enforceRoleInExercise.EnforceAtLeastStudentInExercise; import de.tum.cit.aet.artemis.core.service.AuthorizationCheckService; +import de.tum.cit.aet.artemis.exercise.repository.ExerciseRepository; import de.tum.cit.aet.artemis.iris.domain.settings.IrisCourseSettings; import de.tum.cit.aet.artemis.iris.domain.settings.IrisExerciseSettings; import de.tum.cit.aet.artemis.iris.domain.settings.IrisSettings; import de.tum.cit.aet.artemis.iris.dto.IrisCombinedSettingsDTO; import de.tum.cit.aet.artemis.iris.service.settings.IrisSettingsService; -import de.tum.cit.aet.artemis.programming.repository.ProgrammingExerciseRepository; /** * REST controller for managing {@link IrisSettings}. @@ -45,15 +45,15 @@ public class IrisSettingsResource { private final AuthorizationCheckService authCheckService; - private final ProgrammingExerciseRepository programmingExerciseRepository; + private final ExerciseRepository exerciseRepository; public IrisSettingsResource(UserRepository userRepository, CourseRepository courseRepository, IrisSettingsService irisSettingsService, - AuthorizationCheckService authCheckService, ProgrammingExerciseRepository programmingExerciseRepository) { + AuthorizationCheckService authCheckService, ExerciseRepository exerciseRepository) { this.userRepository = userRepository; this.courseRepository = courseRepository; this.irisSettingsService = irisSettingsService; this.authCheckService = authCheckService; - this.programmingExerciseRepository = programmingExerciseRepository; + this.exerciseRepository = exerciseRepository; } /** @@ -83,15 +83,15 @@ public ResponseEntity getRawCourseSettings(@PathVariable Long cour } /** - * GET programming-exercises/{exerciseId}/raw-iris-settings: Retrieve the raw iris settings for the programming exercise. + * GET exercises/{exerciseId}/raw-iris-settings: Retrieve the raw iris settings for the exercise. * - * @param exerciseId of the programming exercise + * @param exerciseId of the exercise * @return the {@link ResponseEntity} with status {@code 200 (Ok)} and with body the settings, or with status {@code 404 (Not Found)} if the exercise could not be found. */ - @GetMapping("programming-exercises/{exerciseId}/raw-iris-settings") + @GetMapping("exercises/{exerciseId}/raw-iris-settings") @EnforceAtLeastEditorInExercise - public ResponseEntity getRawProgrammingExerciseSettings(@PathVariable Long exerciseId) { - var exercise = programmingExerciseRepository.findByIdElseThrow(exerciseId); + public ResponseEntity getRawExerciseSettings(@PathVariable Long exerciseId) { + var exercise = exerciseRepository.findByIdElseThrow(exerciseId); var user = userRepository.getUserWithGroupsAndAuthorities(); authCheckService.checkHasAtLeastRoleForExerciseElseThrow(Role.STUDENT, exercise, user); @@ -118,15 +118,15 @@ public ResponseEntity getCourseSettings(@PathVariable L } /** - * GET programming-exercises/{exerciseId}/iris-settings: Retrieve the actual iris settings for the programming exercise. + * GET exercises/{exerciseId}/iris-settings: Retrieve the actual iris settings for the exercise. * - * @param exerciseId of the programming exercise + * @param exerciseId of the exercise * @return the {@link ResponseEntity} with status {@code 200 (Ok)} and with body the settings, or with status {@code 404 (Not Found)} if the exercise could not be found. */ - @GetMapping("programming-exercises/{exerciseId}/iris-settings") + @GetMapping("exercises/{exerciseId}/iris-settings") @EnforceAtLeastStudentInExercise - public ResponseEntity getProgrammingExerciseSettings(@PathVariable Long exerciseId) { - var exercise = programmingExerciseRepository.findByIdElseThrow(exerciseId); + public ResponseEntity getExerciseSettings(@PathVariable Long exerciseId) { + var exercise = exerciseRepository.findByIdElseThrow(exerciseId); var user = userRepository.getUserWithGroupsAndAuthorities(); var combinedIrisSettings = irisSettingsService.getCombinedIrisSettingsFor(exercise, irisSettingsService.shouldShowMinimalSettings(exercise, user)); @@ -150,17 +150,17 @@ public ResponseEntity updateCourseSettings(@PathVariable Lon } /** - * PUT programming-exercises/{exerciseId}/raw-iris-settings: Update the raw iris settings for the programming exercise. + * PUT exercises/{exerciseId}/raw-iris-settings: Update the raw iris settings for the exercise. * - * @param exerciseId of the programming exercise + * @param exerciseId of the exercise * @param settings the settings to update * @return the {@link ResponseEntity} with status {@code 200 (Ok)} and with body the updated settings, or with status {@code 404 (Not Found)} if the exercise could not be * found. */ - @PutMapping("programming-exercises/{exerciseId}/raw-iris-settings") + @PutMapping("exercises/{exerciseId}/raw-iris-settings") @EnforceAtLeastInstructorInExercise - public ResponseEntity updateProgrammingExerciseSettings(@PathVariable Long exerciseId, @RequestBody IrisExerciseSettings settings) { - var exercise = programmingExerciseRepository.findByIdElseThrow(exerciseId); + public ResponseEntity updateExerciseSettings(@PathVariable Long exerciseId, @RequestBody IrisExerciseSettings settings) { + var exercise = exerciseRepository.findByIdElseThrow(exerciseId); settings.setExercise(exercise); var updatedSettings = irisSettingsService.saveIrisSettings(settings); return ResponseEntity.ok(updatedSettings); diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/web/IrisTextExerciseChatSessionResource.java b/src/main/java/de/tum/cit/aet/artemis/iris/web/IrisTextExerciseChatSessionResource.java new file mode 100644 index 000000000000..9ebb7aa647a2 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/iris/web/IrisTextExerciseChatSessionResource.java @@ -0,0 +1,137 @@ +package de.tum.cit.aet.artemis.iris.web; + +import java.net.URI; +import java.net.URISyntaxException; +import java.util.List; + +import org.springframework.context.annotation.Profile; +import org.springframework.data.domain.Pageable; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +import de.tum.cit.aet.artemis.core.exception.ConflictException; +import de.tum.cit.aet.artemis.core.repository.UserRepository; +import de.tum.cit.aet.artemis.core.security.annotations.enforceRoleInExercise.EnforceAtLeastStudentInExercise; +import de.tum.cit.aet.artemis.iris.domain.session.IrisTextExerciseChatSession; +import de.tum.cit.aet.artemis.iris.domain.settings.IrisSubSettingsType; +import de.tum.cit.aet.artemis.iris.repository.IrisTextExerciseChatSessionRepository; +import de.tum.cit.aet.artemis.iris.service.IrisSessionService; +import de.tum.cit.aet.artemis.iris.service.session.IrisTextExerciseChatSessionService; +import de.tum.cit.aet.artemis.iris.service.settings.IrisSettingsService; +import de.tum.cit.aet.artemis.text.domain.TextExercise; +import de.tum.cit.aet.artemis.text.repository.TextExerciseRepository; + +/** + * REST controller for managing {@link IrisTextExerciseChatSession}. + */ +@Profile("iris") +@RestController +@RequestMapping("api/iris/text-exercise-chat/") +public class IrisTextExerciseChatSessionResource { + + private final UserRepository userRepository; + + private final IrisSessionService irisSessionService; + + private final IrisSettingsService irisSettingsService; + + private final TextExerciseRepository textExerciseRepository; + + private final IrisTextExerciseChatSessionService irisTextExerciseChatSessionService; + + private final IrisTextExerciseChatSessionRepository irisTextExerciseChatSessionRepository; + + protected IrisTextExerciseChatSessionResource(IrisTextExerciseChatSessionRepository irisTextExerciseChatSessionRepository, UserRepository userRepository, + TextExerciseRepository textExerciseRepository, IrisSessionService irisSessionService, IrisSettingsService irisSettingsService, + IrisTextExerciseChatSessionService irisTextExerciseChatSessionService) { + this.irisTextExerciseChatSessionRepository = irisTextExerciseChatSessionRepository; + this.userRepository = userRepository; + this.irisSessionService = irisSessionService; + this.irisSettingsService = irisSettingsService; + this.textExerciseRepository = textExerciseRepository; + this.irisTextExerciseChatSessionService = irisTextExerciseChatSessionService; + } + + /** + * GET exercise-chat/{exerciseId}/sessions/current: Retrieve the current iris session for the programming exercise. + * + * @param exerciseId of the exercise + * @return the {@link ResponseEntity} with status {@code 200 (Ok)} and with body the current iris session for the exercise or {@code 404 (Not Found)} if no session exists + */ + @PostMapping("{exerciseId}/sessions/current") + @EnforceAtLeastStudentInExercise + public ResponseEntity getCurrentSessionOrCreateIfNotExists(@PathVariable Long exerciseId) throws URISyntaxException { + var exercise = textExerciseRepository.findByIdElseThrow(exerciseId); + validateExercise(exercise); + + irisSettingsService.isEnabledForElseThrow(IrisSubSettingsType.TEXT_EXERCISE_CHAT, exercise); + var user = userRepository.getUserWithGroupsAndAuthorities(); + + var sessionOptional = irisTextExerciseChatSessionRepository.findLatestByExerciseIdAndUserIdWithMessages(exercise.getId(), user.getId(), Pageable.ofSize(1)).stream() + .findFirst(); + if (sessionOptional.isPresent()) { + var session = sessionOptional.get(); + irisSessionService.checkHasAccessToIrisSession(session, user); + return ResponseEntity.ok(session); + } + + return createSessionForExercise(exerciseId); + } + + /** + * POST exercise-chat/{exerciseId}/session: Create a new iris session for an exercise and user. + * If there already exists an iris session for the exercise and user, a new one is created. + * Note: The old session including messages is not deleted and can still be retrieved + * + * @param exerciseId of the exercise + * @return the {@link ResponseEntity} with status {@code 200 (Ok)} and with body the new iris session for the exercise + */ + @PostMapping("{exerciseId}/sessions") + @EnforceAtLeastStudentInExercise + public ResponseEntity createSessionForExercise(@PathVariable Long exerciseId) throws URISyntaxException { + var textExercise = textExerciseRepository.findByIdElseThrow(exerciseId); + validateExercise(textExercise); + + irisSettingsService.isEnabledForElseThrow(IrisSubSettingsType.TEXT_EXERCISE_CHAT, textExercise); + var user = userRepository.getUserWithGroupsAndAuthorities(); + user.hasAcceptedIrisElseThrow(); + + var session = irisTextExerciseChatSessionRepository.save(new IrisTextExerciseChatSession(textExercise, user)); + var uriString = "/api/iris/sessions/" + session.getId(); + + return ResponseEntity.created(new URI(uriString)).body(session); + } + + /** + * GET exercise-chat/{exerciseId}/sessions: Retrieve all Iris Sessions for the programming exercise + * + * @param exerciseId of the exercise + * @return the {@link ResponseEntity} with status {@code 200 (Ok)} and with body a list of the iris sessions for the exercise or {@code 404 (Not Found)} if no session exists + */ + @GetMapping("{exerciseId}/sessions") + @EnforceAtLeastStudentInExercise + public ResponseEntity> getAllSessions(@PathVariable Long exerciseId) { + var exercise = textExerciseRepository.findByIdElseThrow(exerciseId); + validateExercise(exercise); + + irisSettingsService.isEnabledForElseThrow(IrisSubSettingsType.TEXT_EXERCISE_CHAT, exercise); + var user = userRepository.getUserWithGroupsAndAuthorities(); + user.hasAcceptedIrisElseThrow(); + + var sessions = irisTextExerciseChatSessionRepository.findByExerciseIdAndUserIdElseThrow(exercise.getId(), user.getId()); + // TODO: Discuss this with the team: should we filter out sessions where the user does not have access, or throw an exception? + // Access check might not even be necessary here -> see comments in hasAccess method + var filteredSessions = sessions.stream().filter(session -> irisTextExerciseChatSessionService.hasAccess(user, session)).toList(); + return ResponseEntity.ok(filteredSessions); + } + + private static void validateExercise(TextExercise exercise) { + if (exercise.isExamExercise()) { + throw new ConflictException("Iris is not supported for exam exercises", "Iris", "irisExamExercise"); + } + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/iris/web/open/PublicPyrisStatusUpdateResource.java b/src/main/java/de/tum/cit/aet/artemis/iris/web/open/PublicPyrisStatusUpdateResource.java index 05fecc5a287e..025a6ce4e897 100644 --- a/src/main/java/de/tum/cit/aet/artemis/iris/web/open/PublicPyrisStatusUpdateResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/iris/web/open/PublicPyrisStatusUpdateResource.java @@ -20,6 +20,7 @@ import de.tum.cit.aet.artemis.iris.service.pyris.PyrisJobService; import de.tum.cit.aet.artemis.iris.service.pyris.PyrisStatusUpdateService; import de.tum.cit.aet.artemis.iris.service.pyris.dto.chat.PyrisChatStatusUpdateDTO; +import de.tum.cit.aet.artemis.iris.service.pyris.dto.chat.textexercise.PyrisTextExerciseChatStatusUpdateDTO; import de.tum.cit.aet.artemis.iris.service.pyris.dto.competency.PyrisCompetencyStatusUpdateDTO; import de.tum.cit.aet.artemis.iris.service.pyris.dto.lectureingestionwebhook.PyrisLectureIngestionStatusUpdateDTO; import de.tum.cit.aet.artemis.iris.service.pyris.job.CompetencyExtractionJob; @@ -27,6 +28,7 @@ import de.tum.cit.aet.artemis.iris.service.pyris.job.ExerciseChatJob; import de.tum.cit.aet.artemis.iris.service.pyris.job.IngestionWebhookJob; import de.tum.cit.aet.artemis.iris.service.pyris.job.PyrisJob; +import de.tum.cit.aet.artemis.iris.service.pyris.job.TextExerciseChatJob; /** * REST controller for providing Pyris access to Artemis internal data and status updates. @@ -59,7 +61,7 @@ public PublicPyrisStatusUpdateResource(PyrisJobService pyrisJobService, PyrisSta * @throws AccessForbiddenException if the token is invalid * @return a {@link ResponseEntity} with status {@code 200 (OK)} */ - @PostMapping("pipelines/tutor-chat/runs/{runId}/status") // TODO: Rename this to 'exercise-chat' with next breaking Pyris version + @PostMapping("pipelines/tutor-chat/runs/{runId}/status") // TODO: Rename this to 'programming-exercise-chat' with next breaking Pyris version @EnforceNothing public ResponseEntity setStatusOfJob(@PathVariable String runId, @RequestBody PyrisChatStatusUpdateDTO statusUpdateDTO, HttpServletRequest request) { var job = pyrisJobService.getAndAuthenticateJobFromHeaderElseThrow(request, ExerciseChatJob.class); @@ -123,6 +125,30 @@ public ResponseEntity setCompetencyExtractionJobStatus(@PathVariable Strin return ResponseEntity.ok().build(); } + /** + * {@code POST /api/public/pyris/pipelines/text-exercise-chat/runs/{runId}/status} : Set the status of a Text Exercise Chat job. + * + * @param runId the ID of the job + * @param statusUpdateDTO the status update + * @param request the HTTP request + * @return a {@link ResponseEntity} with status {@code 200 (OK)} + * @throws ConflictException if the run ID in the URL does not match the run ID in the request body + * @throws AccessForbiddenException if the token is invalid + */ + @PostMapping("pipelines/text-exercise-chat/runs/{runId}/status") + @EnforceNothing + public ResponseEntity respondInTextExerciseChat(@PathVariable String runId, @RequestBody PyrisTextExerciseChatStatusUpdateDTO statusUpdateDTO, + HttpServletRequest request) { + var job = pyrisJobService.getAndAuthenticateJobFromHeaderElseThrow(request, TextExerciseChatJob.class); + if (!Objects.equals(job.jobId(), runId)) { + throw new ConflictException("Run ID in URL does not match run ID in request body", "Job", "runIdMismatch"); + } + + pyrisStatusUpdateService.handleStatusUpdate(job, statusUpdateDTO); + + return ResponseEntity.ok().build(); + } + /** * {@code POST /api/public/pyris/webhooks/ingestion/runs/{runId}/status} : Set the status of an Ingestion job. * diff --git a/src/main/resources/config/liquibase/changelog/20240909090909_changelog.xml b/src/main/resources/config/liquibase/changelog/20240909090909_changelog.xml new file mode 100644 index 000000000000..86b235b1d655 --- /dev/null +++ b/src/main/resources/config/liquibase/changelog/20240909090909_changelog.xml @@ -0,0 +1,11 @@ + + + + + + + + + diff --git a/src/main/resources/config/liquibase/master.xml b/src/main/resources/config/liquibase/master.xml index b560fb1047fe..23186d8dbad3 100644 --- a/src/main/resources/config/liquibase/master.xml +++ b/src/main/resources/config/liquibase/master.xml @@ -23,6 +23,7 @@ + diff --git a/src/main/webapp/app/entities/iris/settings/iris-settings.model.ts b/src/main/webapp/app/entities/iris/settings/iris-settings.model.ts index ab7f3b475908..2bc612cde7b0 100644 --- a/src/main/webapp/app/entities/iris/settings/iris-settings.model.ts +++ b/src/main/webapp/app/entities/iris/settings/iris-settings.model.ts @@ -1,5 +1,10 @@ import { BaseEntity } from 'app/shared/model/base-entity'; -import { IrisChatSubSettings, IrisCompetencyGenerationSubSettings, IrisLectureIngestionSubSettings } from 'app/entities/iris/settings/iris-sub-settings.model'; +import { + IrisChatSubSettings, + IrisCompetencyGenerationSubSettings, + IrisLectureIngestionSubSettings, + IrisTextExerciseChatSubSettings, +} from 'app/entities/iris/settings/iris-sub-settings.model'; export enum IrisSettingsType { GLOBAL = 'global', @@ -11,6 +16,7 @@ export abstract class IrisSettings implements BaseEntity { id?: number; type: IrisSettingsType; irisChatSettings?: IrisChatSubSettings; + irisTextExerciseChatSettings?: IrisTextExerciseChatSubSettings; irisLectureIngestionSettings?: IrisLectureIngestionSubSettings; irisCompetencyGenerationSettings?: IrisCompetencyGenerationSubSettings; } @@ -19,6 +25,7 @@ export class IrisGlobalSettings implements IrisSettings { id?: number; type = IrisSettingsType.GLOBAL; irisChatSettings?: IrisChatSubSettings; + irisTextExerciseChatSettings?: IrisTextExerciseChatSubSettings; irisLectureIngestionSettings?: IrisLectureIngestionSubSettings; irisCompetencyGenerationSettings?: IrisCompetencyGenerationSubSettings; } @@ -28,6 +35,7 @@ export class IrisCourseSettings implements IrisSettings { type = IrisSettingsType.COURSE; courseId?: number; irisChatSettings?: IrisChatSubSettings; + irisTextExerciseChatSettings?: IrisTextExerciseChatSubSettings; irisLectureIngestionSettings?: IrisLectureIngestionSubSettings; irisCompetencyGenerationSettings?: IrisCompetencyGenerationSubSettings; } @@ -37,4 +45,5 @@ export class IrisExerciseSettings implements IrisSettings { type = IrisSettingsType.EXERCISE; exerciseId?: number; irisChatSettings?: IrisChatSubSettings; + irisTextExerciseChatSettings?: IrisTextExerciseChatSubSettings; } diff --git a/src/main/webapp/app/entities/iris/settings/iris-sub-settings.model.ts b/src/main/webapp/app/entities/iris/settings/iris-sub-settings.model.ts index 626155a43555..adb58a22b693 100644 --- a/src/main/webapp/app/entities/iris/settings/iris-sub-settings.model.ts +++ b/src/main/webapp/app/entities/iris/settings/iris-sub-settings.model.ts @@ -1,7 +1,8 @@ import { BaseEntity } from 'app/shared/model/base-entity'; export enum IrisSubSettingsType { - CHAT = 'chat', + TEXT_EXERCISE_CHAT = 'text-exercise-chat', + CHAT = 'chat', // TODO: Split into PROGRAMMING_EXERCISE_CHAT and COURSE_CHAT COMPETENCY_GENERATION = 'competency-generation', LECTURE_INGESTION = 'lecture-ingestion', } @@ -14,12 +15,20 @@ export abstract class IrisSubSettings implements BaseEntity { selectedVariant?: string; } +// TODO: Split into ProgrammingExerciseChatSubSettings and CourseChatSubSettings +// TODO: Each feature should probably get its own rate limit instead of sharing one export class IrisChatSubSettings extends IrisSubSettings { type = IrisSubSettingsType.CHAT; rateLimit?: number; rateLimitTimeframeHours?: number; } +export class IrisTextExerciseChatSubSettings extends IrisSubSettings { + type = IrisSubSettingsType.TEXT_EXERCISE_CHAT; + rateLimit?: number; + rateLimitTimeframeHours?: number; +} + export class IrisLectureIngestionSubSettings extends IrisSubSettings { type = IrisSubSettingsType.LECTURE_INGESTION; autoIngestOnLectureAttachmentUpload: boolean; diff --git a/src/main/webapp/app/exercises/shared/exercise-detail-common-actions/non-programming-exercise-detail-common-actions.component.html b/src/main/webapp/app/exercises/shared/exercise-detail-common-actions/non-programming-exercise-detail-common-actions.component.html index 98899a615586..517000c367cc 100644 --- a/src/main/webapp/app/exercises/shared/exercise-detail-common-actions/non-programming-exercise-detail-common-actions.component.html +++ b/src/main/webapp/app/exercises/shared/exercise-detail-common-actions/non-programming-exercise-detail-common-actions.component.html @@ -40,6 +40,17 @@ } + @if (irisEnabled && exercise.type === ExerciseType.TEXT && exercise.isAtLeastInstructor && exercise.course && !isExamExercise) { + + + + + + } @if (exercise.isAtLeastEditor && (exercise.type === ExerciseType.MODELING || exercise.type === ExerciseType.TEXT)) { diff --git a/src/main/webapp/app/exercises/shared/exercise-detail-common-actions/non-programming-exercise-detail-common-actions.component.ts b/src/main/webapp/app/exercises/shared/exercise-detail-common-actions/non-programming-exercise-detail-common-actions.component.ts index 6c76cfd3fecf..93f06518d4e8 100644 --- a/src/main/webapp/app/exercises/shared/exercise-detail-common-actions/non-programming-exercise-detail-common-actions.component.ts +++ b/src/main/webapp/app/exercises/shared/exercise-detail-common-actions/non-programming-exercise-detail-common-actions.component.ts @@ -9,7 +9,9 @@ import { Course } from 'app/entities/course.model'; import { Router } from '@angular/router'; import { AssessmentType } from 'app/entities/assessment-type.model'; import { EventManager } from 'app/core/util/event-manager.service'; -import { faBook, faChartBar, faListAlt, faTable, faTrash, faUserCheck, faUsers, faWrench } from '@fortawesome/free-solid-svg-icons'; +import { faBook, faChartBar, faListAlt, faRobot, faTable, faTrash, faUserCheck, faUsers, faWrench } from '@fortawesome/free-solid-svg-icons'; +import { ProfileService } from 'app/shared/layouts/profiles/profile.service'; +import { PROFILE_IRIS } from 'app/app.constants'; @Component({ selector: 'jhi-non-programming-exercise-detail-common-actions', @@ -30,6 +32,7 @@ export class NonProgrammingExerciseDetailCommonActionsComponent implements OnIni teamBaseResource: string; baseResource: string; shortBaseResource: string; + irisEnabled = false; readonly ExerciseType = ExerciseType; readonly AssessmentType = AssessmentType; @@ -43,11 +46,13 @@ export class NonProgrammingExerciseDetailCommonActionsComponent implements OnIni faListAlt = faListAlt; faChartBar = faChartBar; faUserCheck = faUserCheck; + faRobot = faRobot; constructor( private textExerciseService: TextExerciseService, private fileUploadExerciseService: FileUploadExerciseService, private modelingExerciseService: ModelingExerciseService, + private profileService: ProfileService, private eventManager: EventManager, private router: Router, ) {} @@ -66,6 +71,9 @@ export class NonProgrammingExerciseDetailCommonActionsComponent implements OnIni `/exercise-groups/${this.exercise.exerciseGroup?.id}/exercises/${this.exercise.id}/`; this.shortBaseResource = `/course-management/${this.course.id!}/exams/${this.exercise.exerciseGroup?.exam?.id}/`; } + this.profileService.getProfileInfo().subscribe(async (profileInfo) => { + this.irisEnabled = profileInfo.activeProfiles.includes(PROFILE_IRIS); + }); } deleteExercise() { diff --git a/src/main/webapp/app/exercises/shared/exercise-hint/manage/exercise-hint-update.component.ts b/src/main/webapp/app/exercises/shared/exercise-hint/manage/exercise-hint-update.component.ts index 11db13d1660f..260aba7f73e9 100644 --- a/src/main/webapp/app/exercises/shared/exercise-hint/manage/exercise-hint-update.component.ts +++ b/src/main/webapp/app/exercises/shared/exercise-hint/manage/exercise-hint-update.component.ts @@ -99,7 +99,7 @@ export class ExerciseHintUpdateComponent implements OnInit, OnDestroy { .getProfileInfo() .pipe( filter((profileInfo) => profileInfo?.activeProfiles?.includes(PROFILE_IRIS)), - switchMap(() => this.irisSettingsService.getCombinedProgrammingExerciseSettings(this.exercise.id!)), + switchMap(() => this.irisSettingsService.getCombinedExerciseSettings(this.exercise.id!)), ) .subscribe((settings) => { this.irisSettings = settings; diff --git a/src/main/webapp/app/exercises/text/manage/text-exercise/text-exercise.route.ts b/src/main/webapp/app/exercises/text/manage/text-exercise/text-exercise.route.ts index 2e3198bc4186..30d4763745fc 100644 --- a/src/main/webapp/app/exercises/text/manage/text-exercise/text-exercise.route.ts +++ b/src/main/webapp/app/exercises/text/manage/text-exercise/text-exercise.route.ts @@ -126,6 +126,11 @@ export const textExerciseRoute: Routes = [ path: ':courseId/text-exercises', redirectTo: ':courseId/exercises', }, + { + path: ':courseId/text-exercises/:exerciseId/iris-settings', + loadChildren: () => + import('app/iris/settings/iris-exercise-settings-update/iris-exercise-settings-update-routing.module').then((m) => m.IrisExerciseSettingsUpdateRoutingModule), + }, { path: ':courseId/text-exercises/:exerciseId/exercise-statistics', component: ExerciseStatisticsComponent, diff --git a/src/main/webapp/app/exercises/text/participate/text-editor.component.html b/src/main/webapp/app/exercises/text/participate/text-editor.component.html index 6a0d7d189269..75a81fd26d0f 100644 --- a/src/main/webapp/app/exercises/text/participate/text-editor.component.html +++ b/src/main/webapp/app/exercises/text/participate/text-editor.component.html @@ -127,5 +127,8 @@ + @if (!textExercise.exerciseGroup && irisSettings?.irisTextExerciseChatSettings?.enabled) { + + } }
diff --git a/src/main/webapp/app/exercises/text/participate/text-editor.component.ts b/src/main/webapp/app/exercises/text/participate/text-editor.component.ts index f80b1e6a1d7b..ca6401b6f59a 100644 --- a/src/main/webapp/app/exercises/text/participate/text-editor.component.ts +++ b/src/main/webapp/app/exercises/text/participate/text-editor.component.ts @@ -27,6 +27,11 @@ import { Course } from 'app/entities/course.model'; import { getCourseFromExercise } from 'app/entities/exercise.model'; import { faListAlt } from '@fortawesome/free-regular-svg-icons'; import { MAX_SUBMISSION_TEXT_LENGTH } from 'app/shared/constants/input.constants'; +import { ChatServiceMode } from 'app/iris/iris-chat.service'; +import { IrisSettings } from 'app/entities/iris/settings/iris-settings.model'; +import { ProfileService } from 'app/shared/layouts/profiles/profile.service'; +import { PROFILE_IRIS } from 'app/app.constants'; +import { IrisSettingsService } from 'app/iris/settings/shared/iris-settings.service'; import { AssessmentType } from 'app/entities/assessment-type.model'; @Component({ @@ -38,6 +43,7 @@ import { AssessmentType } from 'app/entities/assessment-type.model'; export class TextEditorComponent implements OnInit, OnDestroy, ComponentCanDeactivate { readonly ButtonType = ButtonType; readonly MAX_CHARACTER_COUNT = MAX_SUBMISSION_TEXT_LENGTH; + readonly ChatServiceMode = ChatServiceMode; @Input() participationId?: number; @Input() displayHeader: boolean = true; @@ -68,6 +74,8 @@ export class TextEditorComponent implements OnInit, OnDestroy, ComponentCanDeact isAfterAssessmentDueDate: boolean; examMode = false; + irisSettings?: IrisSettings; + // indicates, that it is an exam exercise and the publishResults date is in the past isAfterPublishDate: boolean; isOwnerOfParticipation: boolean; @@ -84,6 +92,8 @@ export class TextEditorComponent implements OnInit, OnDestroy, ComponentCanDeact private participationWebsocketService: ParticipationWebsocketService, private stringCountService: StringCountService, private accountService: AccountService, + private profileService: ProfileService, + private irisSettingsService: IrisSettingsService, ) { this.isSaving = false; } @@ -102,6 +112,15 @@ export class TextEditorComponent implements OnInit, OnDestroy, ComponentCanDeact error: (error: HttpErrorResponse) => onError(this.alertService, error), }); } + this.profileService.getProfileInfo().subscribe((profileInfo) => { + if (profileInfo?.activeProfiles?.includes(PROFILE_IRIS)) { + this.route.params.subscribe((params) => { + this.irisSettingsService.getCombinedExerciseSettings(params['exerciseId']).subscribe((irisSettings) => { + this.irisSettings = irisSettings; + }); + }); + } + }); } private inputValuesArePresent(): boolean { diff --git a/src/main/webapp/app/exercises/text/participate/text-participation.module.ts b/src/main/webapp/app/exercises/text/participate/text-participation.module.ts index 21e16e27b898..bcb805bf3a2e 100644 --- a/src/main/webapp/app/exercises/text/participate/text-participation.module.ts +++ b/src/main/webapp/app/exercises/text/participate/text-participation.module.ts @@ -12,6 +12,7 @@ import { ArtemisTeamSubmissionSyncModule } from 'app/exercises/shared/team-submi import { RatingModule } from 'app/exercises/shared/rating/rating.module'; import { ArtemisMarkdownModule } from 'app/shared/markdown.module'; import { ArtemisTeamParticipeModule } from 'app/exercises/shared/team/team-participate/team-participate.module'; +import { IrisModule } from 'app/iris/iris.module'; @NgModule({ imports: [ @@ -25,6 +26,7 @@ import { ArtemisTeamParticipeModule } from 'app/exercises/shared/team/team-parti RatingModule, ArtemisMarkdownModule, ArtemisTeamParticipeModule, + IrisModule, ], declarations: [TextEditorComponent, TextResultComponent], exports: [TextEditorComponent], diff --git a/src/main/webapp/app/iris/exercise-chatbot/exercise-chatbot-button.component.ts b/src/main/webapp/app/iris/exercise-chatbot/exercise-chatbot-button.component.ts index b06fbedbbe5f..0e0cb8b6a4ce 100644 --- a/src/main/webapp/app/iris/exercise-chatbot/exercise-chatbot-button.component.ts +++ b/src/main/webapp/app/iris/exercise-chatbot/exercise-chatbot-button.component.ts @@ -1,4 +1,4 @@ -import { Component, OnDestroy, OnInit } from '@angular/core'; +import { Component, Input, OnDestroy, OnInit } from '@angular/core'; import { MatDialog, MatDialogRef } from '@angular/material/dialog'; import { Overlay } from '@angular/cdk/overlay'; import { ActivatedRoute } from '@angular/router'; @@ -14,6 +14,9 @@ import { ChatServiceMode, IrisChatService } from 'app/iris/iris-chat.service'; styleUrls: ['./exercise-chatbot-button.component.scss'], }) export class IrisExerciseChatbotButtonComponent implements OnInit, OnDestroy { + @Input() + mode: ChatServiceMode; + dialogRef: MatDialogRef | null = null; chatOpen = false; hasNewMessages = false; @@ -38,7 +41,7 @@ export class IrisExerciseChatbotButtonComponent implements OnInit, OnDestroy { // Subscribes to route params and gets the exerciseId from the route this.paramsSubscription = this.route.params.subscribe((params) => { const exerciseId = parseInt(params['exerciseId'], 10); - this.chatService.switchTo(ChatServiceMode.EXERCISE, exerciseId); + this.chatService.switchTo(this.mode, exerciseId); }); // Subscribes to check for new messages diff --git a/src/main/webapp/app/iris/iris-chat.service.ts b/src/main/webapp/app/iris/iris-chat.service.ts index 8bb0c8f13059..515faab20a00 100644 --- a/src/main/webapp/app/iris/iris-chat.service.ts +++ b/src/main/webapp/app/iris/iris-chat.service.ts @@ -16,7 +16,8 @@ import { UserService } from 'app/core/user/user.service'; import { AccountService } from 'app/core/auth/account.service'; export enum ChatServiceMode { - EXERCISE = 'exercise-chat', + TEXT_EXERCISE = 'text-exercise-chat', + EXERCISE = 'exercise-chat', // TODO: Rename to PROGRAMMING_EXERCISE COURSE = 'course-chat', } diff --git a/src/main/webapp/app/iris/settings/iris-settings-update/iris-settings-update.component.html b/src/main/webapp/app/iris/settings/iris-settings-update/iris-settings-update.component.html index c1e15d609c1f..8865d90aee42 100644 --- a/src/main/webapp/app/iris/settings/iris-settings-update/iris-settings-update.component.html +++ b/src/main/webapp/app/iris/settings/iris-settings-update/iris-settings-update.component.html @@ -20,6 +20,16 @@

(onChanges)="isDirty = true" />
+
+

+
+ +
@if (settingsType !== EXERCISE) {
diff --git a/src/main/webapp/app/iris/settings/iris-settings-update/iris-settings-update.component.ts b/src/main/webapp/app/iris/settings/iris-settings-update/iris-settings-update.component.ts index aa9adac6be64..d10edadc9a69 100644 --- a/src/main/webapp/app/iris/settings/iris-settings-update/iris-settings-update.component.ts +++ b/src/main/webapp/app/iris/settings/iris-settings-update/iris-settings-update.component.ts @@ -8,7 +8,12 @@ import { ButtonType } from 'app/shared/components/button.component'; import { faRotate, faSave } from '@fortawesome/free-solid-svg-icons'; import { ComponentCanDeactivate } from 'app/shared/guard/can-deactivate.model'; import { cloneDeep, isEqual } from 'lodash-es'; -import { IrisChatSubSettings, IrisCompetencyGenerationSubSettings, IrisLectureIngestionSubSettings } from 'app/entities/iris/settings/iris-sub-settings.model'; +import { + IrisChatSubSettings, + IrisCompetencyGenerationSubSettings, + IrisLectureIngestionSubSettings, + IrisTextExerciseChatSubSettings, +} from 'app/entities/iris/settings/iris-sub-settings.model'; import { AccountService } from 'app/core/auth/account.service'; @Component({ @@ -99,6 +104,9 @@ export class IrisSettingsUpdateComponent implements OnInit, DoCheck, ComponentCa if (!this.irisSettings.irisChatSettings) { this.irisSettings.irisChatSettings = new IrisChatSubSettings(); } + if (!this.irisSettings.irisTextExerciseChatSettings) { + this.irisSettings.irisTextExerciseChatSettings = new IrisTextExerciseChatSubSettings(); + } if (!this.irisSettings.irisLectureIngestionSettings) { this.irisSettings.irisLectureIngestionSettings = new IrisLectureIngestionSubSettings(); } @@ -152,7 +160,7 @@ export class IrisSettingsUpdateComponent implements OnInit, DoCheck, ComponentCa case IrisSettingsType.COURSE: return this.irisSettingsService.getUncombinedCourseSettings(this.courseId!); case IrisSettingsType.EXERCISE: - return this.irisSettingsService.getUncombinedProgrammingExerciseSettings(this.exerciseId!); + return this.irisSettingsService.getUncombinedExerciseSettings(this.exerciseId!); } } @@ -163,7 +171,7 @@ export class IrisSettingsUpdateComponent implements OnInit, DoCheck, ComponentCa case IrisSettingsType.COURSE: return this.irisSettingsService.setCourseSettings(this.courseId!, this.irisSettings!); case IrisSettingsType.EXERCISE: - return this.irisSettingsService.setProgrammingExerciseSettings(this.exerciseId!, this.irisSettings!); + return this.irisSettingsService.setExerciseSettings(this.exerciseId!, this.irisSettings!); } } } diff --git a/src/main/webapp/app/iris/settings/shared/iris-enabled.component.ts b/src/main/webapp/app/iris/settings/shared/iris-enabled.component.ts index be64bd5d856b..37c7df6c7b76 100644 --- a/src/main/webapp/app/iris/settings/shared/iris-enabled.component.ts +++ b/src/main/webapp/app/iris/settings/shared/iris-enabled.component.ts @@ -22,7 +22,7 @@ export class IrisEnabledComponent implements OnInit { ngOnInit(): void { if (this.exercise) { - this.irisSettingsService.getUncombinedProgrammingExerciseSettings(this.exercise.id!).subscribe((settings) => { + this.irisSettingsService.getUncombinedExerciseSettings(this.exercise.id!).subscribe((settings) => { this.irisSettings = settings; this.setSubSettings(); }); @@ -38,7 +38,7 @@ export class IrisEnabledComponent implements OnInit { if (!this.disabled && this.irisSubSettings) { this.irisSubSettings.enabled = enabled; if (this.exercise) { - this.irisSettingsService.setProgrammingExerciseSettings(this.exercise.id!, this.irisSettings!).subscribe((response) => { + this.irisSettingsService.setExerciseSettings(this.exercise.id!, this.irisSettings!).subscribe((response) => { this.irisSettings = response.body ?? this.irisSettings; this.setSubSettings(); }); diff --git a/src/main/webapp/app/iris/settings/shared/iris-settings.service.ts b/src/main/webapp/app/iris/settings/shared/iris-settings.service.ts index 7273e5958cf6..f67609527e8e 100644 --- a/src/main/webapp/app/iris/settings/shared/iris-settings.service.ts +++ b/src/main/webapp/app/iris/settings/shared/iris-settings.service.ts @@ -45,22 +45,22 @@ export class IrisSettingsService { } /** - * Get the uncombined Iris settings for a programming exercise - * @param exerciseId the id of the programming exercise + * Get the uncombined Iris settings for an exercise + * @param exerciseId the id of the exercise */ - getUncombinedProgrammingExerciseSettings(exerciseId: number): Observable { + getUncombinedExerciseSettings(exerciseId: number): Observable { return this.http - .get(`${this.resourceUrl}/programming-exercises/${exerciseId}/raw-iris-settings`, { observe: 'response' }) + .get(`${this.resourceUrl}/exercises/${exerciseId}/raw-iris-settings`, { observe: 'response' }) .pipe(map((res: HttpResponse) => res.body ?? undefined)); } /** - * Get the combined Iris settings for a programming exercise - * @param exerciseId the id of the programming exercise + * Get the combined Iris settings for an exercise + * @param exerciseId the id of the exercise */ - getCombinedProgrammingExerciseSettings(exerciseId: number): Observable { + getCombinedExerciseSettings(exerciseId: number): Observable { return this.http - .get(`${this.resourceUrl}/programming-exercises/${exerciseId}/iris-settings`, { observe: 'response' }) + .get(`${this.resourceUrl}/exercises/${exerciseId}/iris-settings`, { observe: 'response' }) .pipe(map((res: HttpResponse) => res.body ?? undefined)); } @@ -82,12 +82,12 @@ export class IrisSettingsService { } /** - * Update the Iris settings for a programming exercise - * @param exerciseId the id of the programming exercise + * Update the Iris settings for an exercise + * @param exerciseId the id of the exercise * @param settings the settings to set */ - setProgrammingExerciseSettings(exerciseId: number, settings: IrisExerciseSettings): Observable> { - return this.http.put(`${this.resourceUrl}/programming-exercises/${exerciseId}/raw-iris-settings`, settings, { observe: 'response' }); + setExerciseSettings(exerciseId: number, settings: IrisExerciseSettings): Observable> { + return this.http.put(`${this.resourceUrl}/exercises/${exerciseId}/raw-iris-settings`, settings, { observe: 'response' }); } /** diff --git a/src/main/webapp/app/overview/exercise-details/course-exercise-details.component.html b/src/main/webapp/app/overview/exercise-details/course-exercise-details.component.html index a36bbde86268..29582939ece9 100644 --- a/src/main/webapp/app/overview/exercise-details/course-exercise-details.component.html +++ b/src/main/webapp/app/overview/exercise-details/course-exercise-details.component.html @@ -241,7 +241,7 @@

} @if (exercise.type === PROGRAMMING && !exercise.exerciseGroup && irisSettings?.irisChatSettings?.enabled) { - + } responseConsumer) { + public void mockProgrammingExerciseChatResponse(Consumer responseConsumer) { // @formatter:off mockServer .expect(ExpectedCount.once(), requestTo(pipelinesApiURL + "/tutor-chat/default/run")) @@ -99,6 +100,20 @@ public void mockRunResponse(Consumer resp // @formatter:on } + public void mockTextExerciseChatResponse(Consumer responseConsumer) { + // @formatter:off + mockServer + .expect(ExpectedCount.once(), requestTo(pipelinesApiURL + "/text-exercise-chat/default/run")) + .andExpect(method(HttpMethod.POST)) + .andRespond(request -> { + var mockRequest = (MockClientHttpRequest) request; + var dto = mapper.readValue(mockRequest.getBodyAsString(), PyrisTextExerciseChatPipelineExecutionDTO.class); + responseConsumer.accept(dto); + return MockRestResponseCreators.withRawStatus(HttpStatus.ACCEPTED.value()).createResponse(request); + }); + // @formatter:on + } + public void mockRunCompetencyExtractionResponseAnd(Consumer executionDTOConsumer) { // @formatter:off mockServer diff --git a/src/test/java/de/tum/cit/aet/artemis/iris/AbstractIrisIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/iris/AbstractIrisIntegrationTest.java index 28cf037fa204..c887cffce4d9 100644 --- a/src/test/java/de/tum/cit/aet/artemis/iris/AbstractIrisIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/iris/AbstractIrisIntegrationTest.java @@ -18,10 +18,10 @@ import de.tum.cit.aet.artemis.core.connector.IrisRequestMockProvider; import de.tum.cit.aet.artemis.core.domain.Course; +import de.tum.cit.aet.artemis.exercise.domain.Exercise; import de.tum.cit.aet.artemis.iris.domain.settings.IrisSubSettings; import de.tum.cit.aet.artemis.iris.repository.IrisSettingsRepository; import de.tum.cit.aet.artemis.iris.service.settings.IrisSettingsService; -import de.tum.cit.aet.artemis.programming.domain.ProgrammingExercise; import de.tum.cit.aet.artemis.programming.test_repository.ProgrammingExerciseTestRepository; import de.tum.cit.aet.artemis.programming.util.ProgrammingExerciseUtilService; import de.tum.cit.aet.artemis.shared.base.AbstractSpringIntegrationLocalCILocalVCTest; @@ -61,6 +61,7 @@ protected void activateIrisGlobally() { activateSubSettings(globalSettings.getIrisChatSettings()); activateSubSettings(globalSettings.getIrisLectureIngestionSettings()); activateSubSettings(globalSettings.getIrisCompetencyGenerationSettings()); + activateSubSettings(globalSettings.getIrisTextExerciseChatSettings()); irisSettingsRepository.save(globalSettings); } @@ -84,12 +85,15 @@ protected void activateIrisFor(Course course) { activateSubSettings(courseSettings.getIrisLectureIngestionSettings()); + activateSubSettings(courseSettings.getIrisTextExerciseChatSettings()); + irisSettingsRepository.save(courseSettings); } - protected void activateIrisFor(ProgrammingExercise exercise) { + protected void activateIrisFor(Exercise exercise) { var exerciseSettings = irisSettingsService.getDefaultSettingsFor(exercise); activateSubSettings(exerciseSettings.getIrisChatSettings()); + activateSubSettings(exerciseSettings.getIrisTextExerciseChatSettings()); irisSettingsRepository.save(exerciseSettings); } diff --git a/src/test/java/de/tum/cit/aet/artemis/iris/IrisChatMessageIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/iris/IrisChatMessageIntegrationTest.java index ec5028485504..8cda014838a1 100644 --- a/src/test/java/de/tum/cit/aet/artemis/iris/IrisChatMessageIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/iris/IrisChatMessageIntegrationTest.java @@ -127,7 +127,7 @@ void sendOneMessage() throws Exception { var messageToSend = createDefaultMockMessage(irisSession); messageToSend.setMessageDifferentiator(1453); - irisRequestMockProvider.mockRunResponse(dto -> { + irisRequestMockProvider.mockProgrammingExerciseChatResponse(dto -> { assertThat(dto.settings().authenticationToken()).isNotNull(); assertThatNoException().isThrownBy(() -> sendStatus(dto.settings().authenticationToken(), "Hello World", dto.initialStages(), null)); @@ -150,7 +150,7 @@ void sendSuggestions() throws Exception { var messageToSend = createDefaultMockMessage(irisSession); messageToSend.setMessageDifferentiator(1454); - irisRequestMockProvider.mockRunResponse(dto -> { + irisRequestMockProvider.mockProgrammingExerciseChatResponse(dto -> { assertThat(dto.settings().authenticationToken()).isNotNull(); List suggestions = List.of("suggestion1", "suggestion2", "suggestion3"); @@ -191,7 +191,7 @@ void sendTwoMessages() throws Exception { var irisSession = irisExerciseChatSessionService.createChatSessionForProgrammingExercise(exercise, userUtilService.getUserByLogin(TEST_PREFIX + "student1")); IrisMessage messageToSend1 = createDefaultMockMessage(irisSession); - irisRequestMockProvider.mockRunResponse(dto -> { + irisRequestMockProvider.mockProgrammingExerciseChatResponse(dto -> { assertThat(dto.settings().authenticationToken()).isNotNull(); assertThatNoException().isThrownBy(() -> sendStatus(dto.settings().authenticationToken(), "Hello World 1", dto.initialStages(), null)); @@ -199,7 +199,7 @@ void sendTwoMessages() throws Exception { pipelineDone.set(true); }); - irisRequestMockProvider.mockRunResponse(dto -> { + irisRequestMockProvider.mockProgrammingExerciseChatResponse(dto -> { assertThat(dto.settings().authenticationToken()).isNotNull(); assertThatNoException().isThrownBy(() -> sendStatus(dto.settings().authenticationToken(), "Hello World 2", dto.initialStages(), null)); @@ -295,7 +295,7 @@ void resendMessage() throws Exception { var irisSession = irisExerciseChatSessionService.createChatSessionForProgrammingExercise(exercise, userUtilService.getUserByLogin(TEST_PREFIX + "student1")); var messageToSend = createDefaultMockMessage(irisSession); - irisRequestMockProvider.mockRunResponse(dto -> { + irisRequestMockProvider.mockProgrammingExerciseChatResponse(dto -> { assertThat(dto.settings().authenticationToken()).isNotNull(); assertThatNoException().isThrownBy(() -> sendStatus(dto.settings().authenticationToken(), "Hello World", dto.initialStages(), null)); @@ -318,7 +318,7 @@ void sendMessageRateLimitReached() throws Exception { var messageToSend1 = createDefaultMockMessage(irisSession); var messageToSend2 = createDefaultMockMessage(irisSession); - irisRequestMockProvider.mockRunResponse(dto -> { + irisRequestMockProvider.mockProgrammingExerciseChatResponse(dto -> { assertThat(dto.settings().authenticationToken()).isNotNull(); assertThatNoException().isThrownBy(() -> sendStatus(dto.settings().authenticationToken(), "Hello World", dto.initialStages(), null)); diff --git a/src/test/java/de/tum/cit/aet/artemis/iris/IrisTextExerciseChatMessageIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/iris/IrisTextExerciseChatMessageIntegrationTest.java new file mode 100644 index 000000000000..7be2d0e8abc9 --- /dev/null +++ b/src/test/java/de/tum/cit/aet/artemis/iris/IrisTextExerciseChatMessageIntegrationTest.java @@ -0,0 +1,404 @@ +package de.tum.cit.aet.artemis.iris; + +import static de.tum.cit.aet.artemis.iris.service.pyris.dto.status.PyrisStageState.DONE; +import static de.tum.cit.aet.artemis.iris.service.pyris.dto.status.PyrisStageState.IN_PROGRESS; +import static de.tum.cit.aet.artemis.iris.service.pyris.dto.status.PyrisStageState.NOT_STARTED; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatNoException; +import static org.awaitility.Awaitility.await; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; + +import java.util.Arrays; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.concurrent.ThreadLocalRandom; +import java.util.concurrent.atomic.AtomicBoolean; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.ArgumentMatcher; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpStatus; +import org.springframework.security.test.context.support.WithMockUser; +import org.springframework.util.LinkedMultiValueMap; + +import de.tum.cit.aet.artemis.core.domain.Course; +import de.tum.cit.aet.artemis.exercise.domain.participation.StudentParticipation; +import de.tum.cit.aet.artemis.exercise.test_repository.StudentParticipationTestRepository; +import de.tum.cit.aet.artemis.iris.domain.message.IrisMessage; +import de.tum.cit.aet.artemis.iris.domain.message.IrisMessageContent; +import de.tum.cit.aet.artemis.iris.domain.message.IrisMessageSender; +import de.tum.cit.aet.artemis.iris.domain.message.IrisTextMessageContent; +import de.tum.cit.aet.artemis.iris.domain.session.IrisSession; +import de.tum.cit.aet.artemis.iris.domain.session.IrisTextExerciseChatSession; +import de.tum.cit.aet.artemis.iris.dto.IrisChatWebsocketDTO; +import de.tum.cit.aet.artemis.iris.repository.IrisMessageRepository; +import de.tum.cit.aet.artemis.iris.repository.IrisSessionRepository; +import de.tum.cit.aet.artemis.iris.service.IrisMessageService; +import de.tum.cit.aet.artemis.iris.service.pyris.dto.chat.PyrisChatStatusUpdateDTO; +import de.tum.cit.aet.artemis.iris.service.pyris.dto.status.PyrisStageDTO; +import de.tum.cit.aet.artemis.iris.service.pyris.dto.status.PyrisStageState; +import de.tum.cit.aet.artemis.text.domain.TextExercise; +import de.tum.cit.aet.artemis.text.repository.TextExerciseRepository; +import de.tum.cit.aet.artemis.text.util.TextExerciseUtilService; + +class IrisTextExerciseChatMessageIntegrationTest extends AbstractIrisIntegrationTest { + + private static final String TEST_PREFIX = "iristextchatmessageintegration"; + + @Autowired + private IrisMessageService irisMessageService; + + @Autowired + private IrisSessionRepository irisTextExerciseChatSessionRepository; + + @Autowired + private IrisMessageRepository irisMessageRepository; + + @Autowired + private TextExerciseRepository textExerciseRepository; + + @Autowired + private StudentParticipationTestRepository studentParticipationRepository; + + @Autowired + private TextExerciseUtilService exerciseUtilService; + + private TextExercise exercise; + + private AtomicBoolean pipelineDone; + + private IrisTextExerciseChatSession createSessionForUser(String userLogin) { + var user = userUtilService.getUserByLogin(TEST_PREFIX + userLogin); + return irisTextExerciseChatSessionRepository.save(new IrisTextExerciseChatSession(exercise, user)); + } + + @BeforeEach + void initTestCase() { + userUtilService.addUsers(TEST_PREFIX, 2, 0, 0, 0); + + final Course course = exerciseUtilService.addCourseWithOneReleasedTextExercise("Test Exercise Title"); + exercise = (TextExercise) course.getExercises().iterator().next(); + exercise = textExerciseRepository.save(exercise); + + // Add a participation for student1. + StudentParticipation studentParticipation = new StudentParticipation().exercise(exercise); + studentParticipation.setParticipant(userUtilService.getUserByLogin(TEST_PREFIX + "student1")); + studentParticipationRepository.save(studentParticipation); + + activateIrisGlobally(); + activateIrisFor(course); + activateIrisFor(exercise); + pipelineDone = new AtomicBoolean(false); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void sendOneMessage() throws Exception { + var irisSession = createSessionForUser("student1"); + var messageToSend = createDefaultMockMessage(irisSession); + messageToSend.setMessageDifferentiator(1453); + + irisRequestMockProvider.mockTextExerciseChatResponse(dto -> { + assertThat(dto.execution().settings().authenticationToken()).isNotNull(); + + assertThatNoException().isThrownBy(() -> sendStatus(dto.execution().settings().authenticationToken(), "Hello World", dto.execution().initialStages(), null)); + + pipelineDone.set(true); + }); + + request.postWithoutResponseBody("/api/iris/sessions/" + irisSession.getId() + "/messages", messageToSend, HttpStatus.CREATED); + + await().until(pipelineDone::get); + + verifyWebsocketActivityWasExactly(irisSession.getUser().getLogin(), String.valueOf(irisSession.getId()), messageDTO(messageToSend.getContent()), + statusDTO(IN_PROGRESS, NOT_STARTED), statusDTO(DONE, IN_PROGRESS), messageDTO("Hello World")); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void sendOneMessageToWrongSession() throws Exception { + createSessionForUser("student1"); + var irisSession = createSessionForUser("student2"); + IrisMessage messageToSend = createDefaultMockMessage(irisSession); + request.postWithoutResponseBody("/api/iris/sessions/" + irisSession.getId() + "/messages", messageToSend, HttpStatus.FORBIDDEN); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void sendMessageWithoutContent() throws Exception { + var irisSession = createSessionForUser("student1"); + var messageToSend = irisSession.newMessage(); + request.postWithoutResponseBody("/api/iris/sessions/" + irisSession.getId() + "/messages", messageToSend, HttpStatus.BAD_REQUEST); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void sendTwoMessages() throws Exception { + var irisSession = createSessionForUser("student1"); + IrisMessage messageToSend1 = createDefaultMockMessage(irisSession); + + irisRequestMockProvider.mockTextExerciseChatResponse(dto -> { + assertThat(dto.execution().settings().authenticationToken()).isNotNull(); + + assertThatNoException().isThrownBy(() -> sendStatus(dto.execution().settings().authenticationToken(), "Hello World 1", dto.execution().initialStages(), null)); + + pipelineDone.set(true); + }); + + irisRequestMockProvider.mockTextExerciseChatResponse(dto -> { + assertThat(dto.execution().settings().authenticationToken()).isNotNull(); + + assertThatNoException().isThrownBy(() -> sendStatus(dto.execution().settings().authenticationToken(), "Hello World 2", dto.execution().initialStages(), null)); + + pipelineDone.set(true); + }); + + request.postWithoutResponseBody("/api/iris/sessions/" + irisSession.getId() + "/messages", messageToSend1, HttpStatus.CREATED); + + IrisMessage messageToSend2 = createDefaultMockMessage(irisSession); + request.postWithoutResponseBody("/api/iris/sessions/" + irisSession.getId() + "/messages", messageToSend2, HttpStatus.CREATED); + + verify(websocketMessagingService, times(8)).sendMessageToUser(eq(TEST_PREFIX + "student1"), eq("/topic/iris/" + irisSession.getId()), any()); + + var irisSessionFromDb = irisTextExerciseChatSessionRepository.findByIdWithMessagesElseThrow(irisSession.getId()); + assertThat(irisSessionFromDb.getMessages()).hasSize(4); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void getMessages() throws Exception { + var irisSession = createSessionForUser("student1"); + + IrisMessage message1 = irisMessageService.saveMessage(createDefaultMockMessage(irisSession), irisSession, IrisMessageSender.USER); + IrisMessage message2 = irisMessageService.saveMessage(createDefaultMockMessage(irisSession), irisSession, IrisMessageSender.LLM); + IrisMessage message3 = irisMessageService.saveMessage(createDefaultMockMessage(irisSession), irisSession, IrisMessageSender.USER); + IrisMessage message4 = irisMessageService.saveMessage(createDefaultMockMessage(irisSession), irisSession, IrisMessageSender.LLM); + + var messages = request.getList("/api/iris/sessions/" + irisSession.getId() + "/messages", HttpStatus.OK, IrisMessage.class); + assertThat(messages).hasSize(4).containsAll(List.of(message1, message2, message3, message4)); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void rateMessageHelpfulTrue() throws Exception { + var irisSession = createSessionForUser("student1"); + var message = irisSession.newMessage(); + message.addContent(createMockTextContent()); + var irisMessage = irisMessageService.saveMessage(message, irisSession, IrisMessageSender.LLM); + request.putWithResponseBody("/api/iris/sessions/" + irisSession.getId() + "/messages/" + irisMessage.getId() + "/helpful", true, IrisMessage.class, HttpStatus.OK); + irisMessage = irisMessageRepository.findById(irisMessage.getId()).orElseThrow(); + assertThat(irisMessage.getHelpful()).isTrue(); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void rateMessageHelpfulFalse() throws Exception { + var irisSession = createSessionForUser("student1"); + var message = irisSession.newMessage(); + message.addContent(createMockTextContent()); + var irisMessage = irisMessageService.saveMessage(message, irisSession, IrisMessageSender.LLM); + request.putWithResponseBody("/api/iris/sessions/" + irisSession.getId() + "/messages/" + irisMessage.getId() + "/helpful", false, IrisMessage.class, HttpStatus.OK); + irisMessage = irisMessageRepository.findById(irisMessage.getId()).orElseThrow(); + assertThat(irisMessage.getHelpful()).isFalse(); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void rateMessageHelpfulNull() throws Exception { + var irisSession = createSessionForUser("student1"); + var message = irisSession.newMessage(); + message.addContent(createMockTextContent()); + var irisMessage = irisMessageService.saveMessage(message, irisSession, IrisMessageSender.LLM); + request.putWithResponseBody("/api/iris/sessions/" + irisSession.getId() + "/messages/" + irisMessage.getId() + "/helpful", null, IrisMessage.class, HttpStatus.OK); + irisMessage = irisMessageRepository.findById(irisMessage.getId()).orElseThrow(); + assertThat(irisMessage.getHelpful()).isNull(); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void rateMessageWrongSender() throws Exception { + var irisSession = createSessionForUser("student1"); + var message = irisSession.newMessage(); + message.addContent(createMockTextContent()); + var irisMessage = irisMessageService.saveMessage(message, irisSession, IrisMessageSender.USER); + request.putWithResponseBody("/api/iris/sessions/" + irisSession.getId() + "/messages/" + irisMessage.getId() + "/helpful", true, IrisMessage.class, HttpStatus.BAD_REQUEST); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void rateMessageWrongSession() throws Exception { + var irisSession1 = createSessionForUser("student1"); + var irisSession2 = createSessionForUser("student2"); + var message = irisSession1.newMessage(); + message.addContent(createMockTextContent()); + var irisMessage = irisMessageService.saveMessage(message, irisSession1, IrisMessageSender.USER); + request.putWithResponseBody("/api/iris/sessions/" + irisSession2.getId() + "/messages/" + irisMessage.getId() + "/helpful", true, IrisMessage.class, HttpStatus.CONFLICT); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void resendMessage() throws Exception { + var irisSession = createSessionForUser("student1"); + var messageToSend = createDefaultMockMessage(irisSession); + + irisRequestMockProvider.mockTextExerciseChatResponse(dto -> { + assertThat(dto.execution().settings().authenticationToken()).isNotNull(); + + assertThatNoException().isThrownBy(() -> sendStatus(dto.execution().settings().authenticationToken(), "Hello World", dto.execution().initialStages(), null)); + + pipelineDone.set(true); + }); + + var irisMessage = irisMessageService.saveMessage(messageToSend, irisSession, IrisMessageSender.USER); + request.postWithoutResponseBody("/api/iris/sessions/" + irisSession.getId() + "/messages/" + irisMessage.getId() + "/resend", null, HttpStatus.OK); + await().until(() -> irisTextExerciseChatSessionRepository.findByIdWithMessagesElseThrow(irisSession.getId()).getMessages().size() == 2); + verifyWebsocketActivityWasExactly(irisSession.getUser().getLogin(), String.valueOf(irisSession.getId()), statusDTO(IN_PROGRESS, NOT_STARTED), statusDTO(DONE, IN_PROGRESS), + messageDTO("Hello World")); + } + + // User needs to be Admin to change settings + @Test + @WithMockUser(username = TEST_PREFIX + "student2", roles = "ADMIN") + void sendMessageRateLimitReached() throws Exception { + var irisSession = createSessionForUser("student2"); + var messageToSend1 = createDefaultMockMessage(irisSession); + var messageToSend2 = createDefaultMockMessage(irisSession); + + irisRequestMockProvider.mockTextExerciseChatResponse(dto -> { + assertThat(dto.execution().settings().authenticationToken()).isNotNull(); + + assertThatNoException().isThrownBy(() -> sendStatus(dto.execution().settings().authenticationToken(), "Hello World", dto.execution().initialStages(), null)); + + pipelineDone.set(true); + }); + + var globalSettings = irisSettingsService.getGlobalSettings(); + globalSettings.getIrisChatSettings().setRateLimit(1); + globalSettings.getIrisChatSettings().setRateLimitTimeframeHours(10); + irisSettingsService.saveIrisSettings(globalSettings); + + try { + request.postWithoutResponseBody("/api/iris/sessions/" + irisSession.getId() + "/messages", messageToSend1, HttpStatus.CREATED); + await().until(() -> irisTextExerciseChatSessionRepository.findByIdWithMessagesElseThrow(irisSession.getId()).getMessages().size() == 2); + request.postWithoutResponseBody("/api/iris/sessions/" + irisSession.getId() + "/messages", messageToSend2, HttpStatus.TOO_MANY_REQUESTS); + var irisMessage = irisMessageService.saveMessage(messageToSend2, irisSession, IrisMessageSender.USER); + request.postWithoutResponseBody("/api/iris/sessions/" + irisSession.getId() + "/messages/" + irisMessage.getId() + "/resend", null, HttpStatus.TOO_MANY_REQUESTS); + + verifyWebsocketActivityWasExactly(irisSession.getUser().getLogin(), String.valueOf(irisSession.getId()), messageDTO(messageToSend1.getContent()), + statusDTO(IN_PROGRESS, NOT_STARTED), statusDTO(DONE, IN_PROGRESS), messageDTO("Hello World")); + } + finally { + // Reset to not interfere with other tests + globalSettings.getIrisChatSettings().setRateLimit(null); + globalSettings.getIrisChatSettings().setRateLimitTimeframeHours(null); + irisSettingsService.saveIrisSettings(globalSettings); + } + } + + private IrisMessage createDefaultMockMessage(IrisSession irisSession) { + var messageToSend = irisSession.newMessage(); + messageToSend.addContent(createMockTextContent(), createMockTextContent(), createMockTextContent()); + return messageToSend; + } + + private IrisMessageContent createMockTextContent() { + String[] adjectives = { "happy", "sad", "angry", "funny", "silly", "crazy", "beautiful", "smart" }; + String[] nouns = { "dog", "cat", "house", "car", "book", "computer", "phone", "shoe" }; + + var rdm = ThreadLocalRandom.current(); + String randomAdjective = adjectives[rdm.nextInt(adjectives.length)]; + String randomNoun = nouns[rdm.nextInt(nouns.length)]; + + var text = "The " + randomAdjective + " " + randomNoun + " jumped over the lazy dog."; + return new IrisTextMessageContent(text); + } + + private ArgumentMatcher messageDTO(String message) { + return messageDTO(List.of(new IrisTextMessageContent(message))); + } + + private ArgumentMatcher messageDTO(List content) { + return new ArgumentMatcher<>() { + + @Override + public boolean matches(Object argument) { + if (!(argument instanceof IrisChatWebsocketDTO websocketDTO)) { + return false; + } + if (websocketDTO.type() != IrisChatWebsocketDTO.IrisWebsocketMessageType.MESSAGE) { + return false; + } + return Objects.equals(websocketDTO.message().getContent().stream().map(IrisMessageContent::getContentAsString).toList(), + content.stream().map(IrisMessageContent::getContentAsString).toList()); + } + + @Override + public String toString() { + return "IrisChatWebsocketService.IrisWebsocketDTO with type MESSAGE and content " + content; + } + }; + } + + private ArgumentMatcher statusDTO(PyrisStageState... stageStates) { + return new ArgumentMatcher<>() { + + @Override + public boolean matches(Object argument) { + if (!(argument instanceof IrisChatWebsocketDTO websocketDTO)) { + return false; + } + if (websocketDTO.type() != IrisChatWebsocketDTO.IrisWebsocketMessageType.STATUS) { + return false; + } + if (websocketDTO.stages() == null) { + return stageStates == null; + } + if (websocketDTO.stages().size() != stageStates.length) { + return false; + } + return websocketDTO.stages().stream().map(PyrisStageDTO::state).toList().equals(List.of(stageStates)); + } + + @Override + public String toString() { + return "IrisChatWebsocketService.IrisWebsocketDTO with type STATUS and stage states " + Arrays.toString(stageStates); + } + }; + } + + private ArgumentMatcher suggestionsDTO(String... suggestions) { + return new ArgumentMatcher<>() { + + @Override + public boolean matches(Object argument) { + if (!(argument instanceof IrisChatWebsocketDTO websocketDTO)) { + return false; + } + if (websocketDTO.type() != IrisChatWebsocketDTO.IrisWebsocketMessageType.STATUS) { + return false; + } + if (websocketDTO.suggestions() == null) { + return suggestions == null; + } + return websocketDTO.suggestions().equals(List.of(suggestions)); + } + + @Override + public String toString() { + return "IrisChatWebsocketService.IrisWebsocketDTO with type STATUS and suggestions " + Arrays.toString(suggestions); + } + }; + } + + private void sendStatus(String jobId, String result, List stages, List suggestions) throws Exception { + var headers = new HttpHeaders(new LinkedMultiValueMap<>(Map.of("Authorization", List.of("Bearer " + jobId)))); + request.postWithoutResponseBody("/api/public/pyris/pipelines/text-exercise-chat/runs/" + jobId + "/status", new PyrisChatStatusUpdateDTO(result, stages, suggestions), + HttpStatus.OK, headers); + } +} diff --git a/src/test/java/de/tum/cit/aet/artemis/iris/settings/IrisSettingsIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/iris/settings/IrisSettingsIntegrationTest.java index 211b0d122d55..4ead87fa669a 100644 --- a/src/test/java/de/tum/cit/aet/artemis/iris/settings/IrisSettingsIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/iris/settings/IrisSettingsIntegrationTest.java @@ -174,8 +174,8 @@ void updateCourseSettings3() throws Exception { void getMissingSettingsForProgrammingExercise() throws Exception { activateIrisGlobally(); activateIrisFor(course); - var loadedSettings1 = request.get("/api/programming-exercises/" + programmingExercise.getId() + "/raw-iris-settings", HttpStatus.OK, IrisSettings.class); - var loadedSettings2 = request.get("/api/programming-exercises/" + programmingExercise.getId() + "/iris-settings", HttpStatus.OK, IrisCombinedSettingsDTO.class); + var loadedSettings1 = request.get("/api/exercises/" + programmingExercise.getId() + "/raw-iris-settings", HttpStatus.OK, IrisSettings.class); + var loadedSettings2 = request.get("/api/exercises/" + programmingExercise.getId() + "/iris-settings", HttpStatus.OK, IrisCombinedSettingsDTO.class); programmingExercise = programmingExerciseRepository.findByIdElseThrow(programmingExercise.getId()); @@ -193,11 +193,11 @@ void getProgrammingExerciseSettings() throws Exception { activateIrisFor(programmingExercise); programmingExercise = programmingExerciseRepository.findByIdElseThrow(programmingExercise.getId()); - var loadedSettings1 = request.get("/api/programming-exercises/" + programmingExercise.getId() + "/raw-iris-settings", HttpStatus.OK, IrisSettings.class); - var loadedSettings2 = request.get("/api/programming-exercises/" + programmingExercise.getId() + "/iris-settings", HttpStatus.OK, IrisCombinedSettingsDTO.class); + var loadedSettings1 = request.get("/api/exercises/" + programmingExercise.getId() + "/raw-iris-settings", HttpStatus.OK, IrisSettings.class); + var loadedSettings2 = request.get("/api/exercises/" + programmingExercise.getId() + "/iris-settings", HttpStatus.OK, IrisCombinedSettingsDTO.class); - assertThat(loadedSettings1).isNotNull().usingRecursiveComparison().ignoringFields("id", "exercise", "irisChatSettings.id").ignoringExpectedNullFields() - .isEqualTo(loadedSettings2); + assertThat(loadedSettings1).isNotNull().usingRecursiveComparison().ignoringFields("id", "exercise", "irisChatSettings.id", "irisTextExerciseChatSettings.id") + .ignoringExpectedNullFields().isEqualTo(loadedSettings2); assertThat(loadedSettings1.getIrisCompetencyGenerationSettings()).isNull(); assertThat(loadedSettings1.getIrisLectureIngestionSettings()).isNull(); assertThat(loadedSettings1).isNotNull().usingRecursiveComparison().ignoringFields("exercise") @@ -212,8 +212,8 @@ void getProgrammingExerciseSettingsAsUser() throws Exception { activateIrisFor(programmingExercise); programmingExercise = programmingExerciseRepository.findByIdElseThrow(programmingExercise.getId()); - request.get("/api/programming-exercises/" + programmingExercise.getId() + "/raw-iris-settings", HttpStatus.FORBIDDEN, IrisSettings.class); - var loadedSettings = request.get("/api/programming-exercises/" + programmingExercise.getId() + "/iris-settings", HttpStatus.OK, IrisCombinedSettingsDTO.class); + request.get("/api/exercises/" + programmingExercise.getId() + "/raw-iris-settings", HttpStatus.FORBIDDEN, IrisSettings.class); + var loadedSettings = request.get("/api/exercises/" + programmingExercise.getId() + "/iris-settings", HttpStatus.OK, IrisCombinedSettingsDTO.class); assertThat(loadedSettings).isNotNull().usingRecursiveComparison().ignoringFields("id") .ignoringCollectionOrderInFields("irisChatSettings.allowedVariants", "irisCompetencyGenerationSettings.allowedVariants") @@ -228,13 +228,13 @@ void updateProgrammingExerciseSettings1() throws Exception { activateIrisFor(programmingExercise); programmingExercise = programmingExerciseRepository.findByIdElseThrow(programmingExercise.getId()); - var loadedSettings1 = request.get("/api/programming-exercises/" + programmingExercise.getId() + "/raw-iris-settings", HttpStatus.OK, IrisSettings.class); + var loadedSettings1 = request.get("/api/exercises/" + programmingExercise.getId() + "/raw-iris-settings", HttpStatus.OK, IrisSettings.class); loadedSettings1.getIrisChatSettings().setEnabled(false); - var updatedSettings = request.putWithResponseBody("/api/programming-exercises/" + programmingExercise.getId() + "/raw-iris-settings", loadedSettings1, IrisSettings.class, + var updatedSettings = request.putWithResponseBody("/api/exercises/" + programmingExercise.getId() + "/raw-iris-settings", loadedSettings1, IrisSettings.class, HttpStatus.OK); - var loadedSettings2 = request.get("/api/programming-exercises/" + programmingExercise.getId() + "/raw-iris-settings", HttpStatus.OK, IrisSettings.class); + var loadedSettings2 = request.get("/api/exercises/" + programmingExercise.getId() + "/raw-iris-settings", HttpStatus.OK, IrisSettings.class); assertThat(updatedSettings).isNotNull().isEqualTo(loadedSettings2); // Ids of settings should not have changed @@ -250,14 +250,14 @@ void updateProgrammingExerciseSettings2() throws Exception { activateIrisFor(programmingExercise); programmingExercise = programmingExerciseRepository.findByIdElseThrow(programmingExercise.getId()); - var loadedSettings1 = request.get("/api/programming-exercises/" + programmingExercise.getId() + "/raw-iris-settings", HttpStatus.OK, IrisSettings.class); + var loadedSettings1 = request.get("/api/exercises/" + programmingExercise.getId() + "/raw-iris-settings", HttpStatus.OK, IrisSettings.class); var chatSubSettingsId = loadedSettings1.getIrisChatSettings().getId(); loadedSettings1.setIrisChatSettings(null); - var updatedSettings = request.putWithResponseBody("/api/programming-exercises/" + programmingExercise.getId() + "/raw-iris-settings", loadedSettings1, IrisSettings.class, + var updatedSettings = request.putWithResponseBody("/api/exercises/" + programmingExercise.getId() + "/raw-iris-settings", loadedSettings1, IrisSettings.class, HttpStatus.OK); - var loadedSettings2 = request.get("/api/programming-exercises/" + programmingExercise.getId() + "/raw-iris-settings", HttpStatus.OK, IrisSettings.class); + var loadedSettings2 = request.get("/api/exercises/" + programmingExercise.getId() + "/raw-iris-settings", HttpStatus.OK, IrisSettings.class); assertThat(updatedSettings).isNotNull().usingRecursiveComparison().ignoringFields("exercise").isEqualTo(loadedSettings1); assertThat(updatedSettings).isNotNull().usingRecursiveComparison().ignoringFields("exercise").isEqualTo(loadedSettings2); @@ -278,9 +278,9 @@ void updateProgrammingExerciseSettings3() throws Exception { exerciseSettings.getIrisChatSettings().setEnabled(true); exerciseSettings.getIrisChatSettings().setSelectedVariant(null); - var updatedSettings = request.putWithResponseBody("/api/programming-exercises/" + programmingExercise.getId() + "/raw-iris-settings", exerciseSettings, IrisSettings.class, + var updatedSettings = request.putWithResponseBody("/api/exercises/" + programmingExercise.getId() + "/raw-iris-settings", exerciseSettings, IrisSettings.class, HttpStatus.OK); - var loadedSettings1 = request.get("/api/programming-exercises/" + programmingExercise.getId() + "/raw-iris-settings", HttpStatus.OK, IrisSettings.class); + var loadedSettings1 = request.get("/api/exercises/" + programmingExercise.getId() + "/raw-iris-settings", HttpStatus.OK, IrisSettings.class); assertThat(updatedSettings).isNotNull().isEqualTo(loadedSettings1); assertThat(loadedSettings1).usingRecursiveComparison().ignoringFields("id", "exercise", "irisChatSettings.id", "irisChatSettings.template.id").isEqualTo(exerciseSettings); diff --git a/src/test/javascript/spec/component/exercise-hint/manage/exercise-hint-update.component.spec.ts b/src/test/javascript/spec/component/exercise-hint/manage/exercise-hint-update.component.spec.ts index 4ef9a51082c3..fe8282591d2b 100644 --- a/src/test/javascript/spec/component/exercise-hint/manage/exercise-hint-update.component.spec.ts +++ b/src/test/javascript/spec/component/exercise-hint/manage/exercise-hint-update.component.spec.ts @@ -162,7 +162,7 @@ describe('ExerciseHint Management Update Component', () => { // Mock getCombinedProgrammingExerciseSettings const irisSettingsService = TestBed.inject(IrisSettingsService); - const getCombinedProgrammingExerciseSettingsSpy = jest.spyOn(irisSettingsService, 'getCombinedProgrammingExerciseSettings').mockReturnValue(of(fakeSettings)); + const getCombinedProgrammingExerciseSettingsSpy = jest.spyOn(irisSettingsService, 'getCombinedExerciseSettings').mockReturnValue(of(fakeSettings)); // Run ngOnInit comp.ngOnInit(); diff --git a/src/test/javascript/spec/component/iris/settings/iris-course-settings-update.component.spec.ts b/src/test/javascript/spec/component/iris/settings/iris-course-settings-update.component.spec.ts index d31ecbaba114..8e721fcc7653 100644 --- a/src/test/javascript/spec/component/iris/settings/iris-course-settings-update.component.spec.ts +++ b/src/test/javascript/spec/component/iris/settings/iris-course-settings-update.component.spec.ts @@ -64,7 +64,7 @@ describe('IrisCourseSettingsUpdateComponent Component', () => { expect(getSettingsSpy).toHaveBeenCalledWith(1); expect(getParentSettingsSpy).toHaveBeenCalledOnce(); - expect(fixture.debugElement.queryAll(By.directive(IrisCommonSubSettingsUpdateComponent))).toHaveLength(3); + expect(fixture.debugElement.queryAll(By.directive(IrisCommonSubSettingsUpdateComponent))).toHaveLength(4); }); it('Can deactivate correctly', () => { diff --git a/src/test/javascript/spec/component/iris/settings/iris-enabled.component.spec.ts b/src/test/javascript/spec/component/iris/settings/iris-enabled.component.spec.ts index c47b91fdd5b1..8647d036e2a7 100644 --- a/src/test/javascript/spec/component/iris/settings/iris-enabled.component.spec.ts +++ b/src/test/javascript/spec/component/iris/settings/iris-enabled.component.spec.ts @@ -48,7 +48,7 @@ describe('IrisEnabledComponent', () => { }); it.each([IrisSubSettingsType.CHAT, IrisSubSettingsType.COMPETENCY_GENERATION])('should load exercise', async (subSettingstype) => { - const getExerciseSettingsSpy = jest.spyOn(irisSettingsService, 'getUncombinedProgrammingExerciseSettings').mockReturnValue(of(irisSettings)); + const getExerciseSettingsSpy = jest.spyOn(irisSettingsService, 'getUncombinedExerciseSettings').mockReturnValue(of(irisSettings)); comp.exercise = exercise; comp.irisSubSettingsType = subSettingstype; fixture.detectChanges(); @@ -70,7 +70,7 @@ describe('IrisEnabledComponent', () => { }); it('should set exercise enabled', async () => { - const setSettingsSpy = jest.spyOn(irisSettingsService, 'setProgrammingExerciseSettings').mockReturnValue(of(new HttpResponse({ body: null as any as IrisSettings }))); + const setSettingsSpy = jest.spyOn(irisSettingsService, 'setExerciseSettings').mockReturnValue(of(new HttpResponse({ body: null as any as IrisSettings }))); comp.exercise = exercise; comp.irisSettings = irisSettings; comp.irisSubSettingsType = IrisSubSettingsType.CHAT; diff --git a/src/test/javascript/spec/component/iris/settings/iris-exercise-settings-update.component.spec.ts b/src/test/javascript/spec/component/iris/settings/iris-exercise-settings-update.component.spec.ts index 140940787933..7d37655167c4 100644 --- a/src/test/javascript/spec/component/iris/settings/iris-exercise-settings-update.component.spec.ts +++ b/src/test/javascript/spec/component/iris/settings/iris-exercise-settings-update.component.spec.ts @@ -45,7 +45,7 @@ describe('IrisExerciseSettingsUpdateComponent Component', () => { paramsSpy = jest.spyOn(route.parent!.params, 'subscribe'); const irisSettings = mockSettings(); - getSettingsSpy = jest.spyOn(irisSettingsService, 'getUncombinedProgrammingExerciseSettings').mockReturnValue(of(irisSettings)); + getSettingsSpy = jest.spyOn(irisSettingsService, 'getUncombinedExerciseSettings').mockReturnValue(of(irisSettings)); getParentSettingsSpy = jest.spyOn(irisSettingsService, 'getCombinedCourseSettings').mockReturnValue(of(irisSettings)); }); fixture = TestBed.createComponent(IrisExerciseSettingsUpdateComponent); @@ -65,7 +65,7 @@ describe('IrisExerciseSettingsUpdateComponent Component', () => { expect(getSettingsSpy).toHaveBeenCalledWith(2); expect(getParentSettingsSpy).toHaveBeenCalledWith(1); - expect(fixture.debugElement.queryAll(By.directive(IrisCommonSubSettingsUpdateComponent))).toHaveLength(1); + expect(fixture.debugElement.queryAll(By.directive(IrisCommonSubSettingsUpdateComponent))).toHaveLength(2); }); it('Can deactivate correctly', () => { @@ -82,7 +82,7 @@ describe('IrisExerciseSettingsUpdateComponent Component', () => { const irisSettings = mockSettings(); irisSettings.id = undefined; const irisSettingsSaved = mockSettings(); - const setSettingsSpy = jest.spyOn(irisSettingsService, 'setProgrammingExerciseSettings').mockReturnValue(of(new HttpResponse({ body: irisSettingsSaved }))); + const setSettingsSpy = jest.spyOn(irisSettingsService, 'setExerciseSettings').mockReturnValue(of(new HttpResponse({ body: irisSettingsSaved }))); comp.settingsUpdateComponent!.irisSettings = irisSettings; comp.settingsUpdateComponent!.saveIrisSettings(); expect(setSettingsSpy).toHaveBeenCalledWith(2, irisSettings); diff --git a/src/test/javascript/spec/component/iris/settings/iris-global-settings-update.component.spec.ts b/src/test/javascript/spec/component/iris/settings/iris-global-settings-update.component.spec.ts index 44783963ac05..0478f3ad2f7a 100644 --- a/src/test/javascript/spec/component/iris/settings/iris-global-settings-update.component.spec.ts +++ b/src/test/javascript/spec/component/iris/settings/iris-global-settings-update.component.spec.ts @@ -52,7 +52,7 @@ describe('IrisGlobalSettingsUpdateComponent Component', () => { expect(comp.settingsUpdateComponent).toBeTruthy(); expect(getSettingsSpy).toHaveBeenCalledOnce(); - expect(fixture.debugElement.queryAll(By.directive(IrisCommonSubSettingsUpdateComponent))).toHaveLength(3); + expect(fixture.debugElement.queryAll(By.directive(IrisCommonSubSettingsUpdateComponent))).toHaveLength(4); }); it('Can deactivate correctly', () => { diff --git a/src/test/javascript/spec/component/iris/settings/iris-settings-update-component.spec.ts b/src/test/javascript/spec/component/iris/settings/iris-settings-update-component.spec.ts index 4fe2f213f845..d07481ba739e 100644 --- a/src/test/javascript/spec/component/iris/settings/iris-settings-update-component.spec.ts +++ b/src/test/javascript/spec/component/iris/settings/iris-settings-update-component.spec.ts @@ -33,7 +33,7 @@ describe('IrisSettingsUpdateComponent', () => { MockProvider(IrisSettingsService, { getGlobalSettings: () => of(mockSettings()), getUncombinedCourseSettings: () => of(mockSettings()), - getUncombinedProgrammingExerciseSettings: () => of(mockSettings()), + getUncombinedExerciseSettings: () => of(mockSettings()), }), ], }) diff --git a/src/test/javascript/spec/component/iris/settings/iris-settings.service.spec.ts b/src/test/javascript/spec/component/iris/settings/iris-settings.service.spec.ts index 0be52f134f7b..e835d8b6489b 100644 --- a/src/test/javascript/spec/component/iris/settings/iris-settings.service.spec.ts +++ b/src/test/javascript/spec/component/iris/settings/iris-settings.service.spec.ts @@ -76,7 +76,7 @@ describe('Iris Settings Service', () => { it('should get uncombined programming exercise settings', fakeAsync(() => { const mockedSettings = mockSettings(); service - .getUncombinedProgrammingExerciseSettings(1) + .getUncombinedExerciseSettings(1) .pipe(take(1)) .subscribe((resp) => expect(resp).toEqual(mockedSettings)); const req = httpMock.expectOne({ method: 'GET' }); @@ -87,7 +87,7 @@ describe('Iris Settings Service', () => { it('should get combined programming exercise settings', fakeAsync(() => { const mockedSettings = mockSettings(); service - .getCombinedProgrammingExerciseSettings(1) + .getCombinedExerciseSettings(1) .pipe(take(1)) .subscribe((resp) => expect(resp).toEqual(mockedSettings)); const req = httpMock.expectOne({ method: 'GET' }); @@ -98,7 +98,7 @@ describe('Iris Settings Service', () => { it('should set programming exercise settings', fakeAsync(() => { const mockedSettings = mockSettings(); service - .setProgrammingExerciseSettings(1, mockedSettings) + .setExerciseSettings(1, mockedSettings) .pipe(take(1)) .subscribe((resp) => expect(resp.body).toEqual(mockedSettings)); const req = httpMock.expectOne({ method: 'PUT' }); diff --git a/src/test/javascript/spec/component/iris/settings/mock-settings.ts b/src/test/javascript/spec/component/iris/settings/mock-settings.ts index 6c542caf9a91..109fb0fdc04f 100644 --- a/src/test/javascript/spec/component/iris/settings/mock-settings.ts +++ b/src/test/javascript/spec/component/iris/settings/mock-settings.ts @@ -1,11 +1,19 @@ import { IrisVariant } from 'app/entities/iris/settings/iris-variant'; -import { IrisChatSubSettings, IrisCompetencyGenerationSubSettings, IrisLectureIngestionSubSettings } from 'app/entities/iris/settings/iris-sub-settings.model'; +import { + IrisChatSubSettings, + IrisCompetencyGenerationSubSettings, + IrisLectureIngestionSubSettings, + IrisTextExerciseChatSubSettings, +} from 'app/entities/iris/settings/iris-sub-settings.model'; import { IrisGlobalSettings } from 'app/entities/iris/settings/iris-settings.model'; export function mockSettings() { const mockChatSettings = new IrisChatSubSettings(); mockChatSettings.id = 1; mockChatSettings.enabled = true; + const mockTextExerciseChatSettings = new IrisTextExerciseChatSubSettings(); + mockTextExerciseChatSettings.id = 13; + mockTextExerciseChatSettings.enabled = true; const mockLectureIngestionSettings = new IrisLectureIngestionSubSettings(); mockLectureIngestionSettings.id = 7; mockLectureIngestionSettings.enabled = true; @@ -16,6 +24,7 @@ export function mockSettings() { const irisSettings = new IrisGlobalSettings(); irisSettings.id = 1; irisSettings.irisChatSettings = mockChatSettings; + irisSettings.irisTextExerciseChatSettings = mockTextExerciseChatSettings; irisSettings.irisCompetencyGenerationSettings = mockCompetencyGenerationSettings; irisSettings.irisLectureIngestionSettings = mockLectureIngestionSettings; return irisSettings; diff --git a/src/test/javascript/spec/component/iris/ui/exercise-chatbot-button.component.spec.ts b/src/test/javascript/spec/component/iris/ui/exercise-chatbot-button.component.spec.ts index f26a10d679ca..0e78bb39e27a 100644 --- a/src/test/javascript/spec/component/iris/ui/exercise-chatbot-button.component.spec.ts +++ b/src/test/javascript/spec/component/iris/ui/exercise-chatbot-button.component.spec.ts @@ -101,12 +101,15 @@ describe('ExerciseChatbotButtonComponent', () => { jest.restoreAllMocks(); }); - it('should subscribe to route.params and call chatService.switchTo', fakeAsync(() => { + it('should subscribe to route.params and call chatService.switchTo with exercise mode', fakeAsync(() => { jest.spyOn(chatHttpServiceMock, 'getCurrentSessionOrCreateIfNotExists').mockReturnValueOnce(of(mockServerSessionHttpResponseWithId(123))); jest.spyOn(wsServiceMock, 'subscribeToSession').mockReturnValueOnce(of()); const mockExerciseId = 123; const spy = jest.spyOn(chatService, 'switchTo'); + component.mode = ChatServiceMode.EXERCISE; + fixture.detectChanges(); + mockParamsSubject.next({ exerciseId: mockExerciseId, }); @@ -116,6 +119,24 @@ describe('ExerciseChatbotButtonComponent', () => { expect(spy).toHaveBeenCalledExactlyOnceWith(ChatServiceMode.EXERCISE, mockExerciseId); })); + it('should subscribe to route.params and call chatService.switchTo with text exercise mode', fakeAsync(() => { + jest.spyOn(chatHttpServiceMock, 'getCurrentSessionOrCreateIfNotExists').mockReturnValueOnce(of(mockServerSessionHttpResponseWithId(123))); + jest.spyOn(wsServiceMock, 'subscribeToSession').mockReturnValueOnce(of()); + const mockExerciseId = 123; + const spy = jest.spyOn(chatService, 'switchTo'); + + component.mode = ChatServiceMode.TEXT_EXERCISE; + fixture.detectChanges(); + + mockParamsSubject.next({ + exerciseId: mockExerciseId, + }); + fixture.whenStable(); + tick(); + + expect(spy).toHaveBeenCalledExactlyOnceWith(ChatServiceMode.TEXT_EXERCISE, mockExerciseId); + })); + it('should close the dialog when destroying the object', () => { // given component.openChat(); diff --git a/src/test/javascript/spec/component/non-programming-exercise-detail-common-actions.component.spec.ts b/src/test/javascript/spec/component/non-programming-exercise-detail-common-actions.component.spec.ts index e81ad3cbd435..4fe946bec7d3 100644 --- a/src/test/javascript/spec/component/non-programming-exercise-detail-common-actions.component.spec.ts +++ b/src/test/javascript/spec/component/non-programming-exercise-detail-common-actions.component.spec.ts @@ -22,6 +22,7 @@ import { MockRouter } from '../helpers/mocks/mock-router'; import { Router } from '@angular/router'; import { MockRouterLinkDirective } from '../helpers/mocks/directive/mock-router-link.directive'; import { UMLDiagramType } from '@ls1intum/apollon'; +import { ProfileService } from 'app/shared/layouts/profiles/profile.service'; describe('Exercise detail common actions Component', () => { let comp: NonProgrammingExerciseDetailCommonActionsComponent; @@ -44,8 +45,10 @@ describe('Exercise detail common actions Component', () => { { provide: FileUploadExerciseService, useClass: MockFileUploadExerciseService }, MockProvider(ModelingExerciseService), { provide: Router, useClass: MockRouter }, + MockProvider(ProfileService), ], }).compileComponents(); + jest.spyOn(TestBed.inject(ProfileService), 'getProfileInfo').mockReturnValue(of()); fixture = TestBed.createComponent(NonProgrammingExerciseDetailCommonActionsComponent); comp = fixture.componentInstance; }); From a89302482b401fbdd89d2ec2d58f6f9f702e1811 Mon Sep 17 00:00:00 2001 From: Marcel Gaupp Date: Sat, 12 Oct 2024 18:59:37 +0200 Subject: [PATCH 10/23] Plagiarism checks: Use file extensions for plagiarism view (#9350) --- .../service/RepositoryService.java | 23 -- .../code-editor-file-browser.component.ts | 4 +- .../file-browser/supported-file-extensions.ts | 292 ----------------- .../service/code-editor-repository.service.ts | 7 - .../text-submission-viewer.component.ts | 39 ++- .../lecture/lecture-attachments.component.ts | 6 +- .../attachment-unit-form.component.ts | 6 +- .../app/lecture/lecture-update.component.ts | 6 +- .../constants/file-extensions.constants.ts | 307 +++++++++++++++++- .../app/shared/http/file-uploader.service.ts | 4 +- .../text-submission-viewer.component.spec.ts | 10 +- 11 files changed, 338 insertions(+), 366 deletions(-) delete mode 100644 src/main/webapp/app/exercises/programming/shared/code-editor/file-browser/supported-file-extensions.ts diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/RepositoryService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/RepositoryService.java index ed5dd6cbae45..9833a9ae040b 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/RepositoryService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/RepositoryService.java @@ -250,27 +250,6 @@ public byte[] getFile(Repository repository, String filename) throws IOException return fileInBytes; } - /** - * Get the mimetype of a single file from the repository - * - * @param repository in which the requested file is located. - * @param filename of the file to be probed. - * @return The mimetype of the file if found or throw an exception. - * @throws IOException if the file can't be found, is corrupt, etc. - */ - public String getFileType(Repository repository, String filename) throws IOException { - Optional file = gitService.getFileByName(repository, filename); - if (file.isEmpty()) { - throw new FileNotFoundException(); - } - String type = Files.probeContentType(file.get().toPath()); - // fallback to text/plain in case content type can not be determined - if (type == null) { - return "text/plain"; - } - return type; - } - /** * Gets the files of the repository and checks whether they were changed during a student participation. * Compares the files from the students' repository with the files of the template repository. @@ -519,8 +498,6 @@ public boolean isClean(VcsRepositoryUri repositoryUri, String defaultBranch) thr public ResponseEntity getFileFromRepository(String filename, Repository repository) throws IOException { byte[] out = getFile(repository, filename); HttpHeaders responseHeaders = new HttpHeaders(); - var contentType = getFileType(repository, filename); - responseHeaders.add("Content-Type", contentType); // Prevent the file from being interpreted as HTML by the browser when opened directly: responseHeaders.setContentDisposition(ContentDisposition.builder("attachment").filename(filename).build()); return new ResponseEntity<>(out, responseHeaders, HttpStatus.OK); diff --git a/src/main/webapp/app/exercises/programming/shared/code-editor/file-browser/code-editor-file-browser.component.ts b/src/main/webapp/app/exercises/programming/shared/code-editor/file-browser/code-editor-file-browser.component.ts index 16cd6c22176b..158129a2dab8 100644 --- a/src/main/webapp/app/exercises/programming/shared/code-editor/file-browser/code-editor-file-browser.component.ts +++ b/src/main/webapp/app/exercises/programming/shared/code-editor/file-browser/code-editor-file-browser.component.ts @@ -22,11 +22,11 @@ import { CodeEditorRepositoryFileService, CodeEditorRepositoryService } from 'ap import { CodeEditorStatusComponent } from 'app/exercises/programming/shared/code-editor/status/code-editor-status.component'; import { CodeEditorFileBrowserDeleteComponent } from 'app/exercises/programming/shared/code-editor/file-browser/code-editor-file-browser-delete'; import { IFileDeleteDelegate } from 'app/exercises/programming/shared/code-editor/file-browser/code-editor-file-browser-on-file-delete-delegate'; -import { supportedTextFileExtensions } from 'app/exercises/programming/shared/code-editor/file-browser/supported-file-extensions'; import { faAngleDoubleDown, faAngleDoubleUp, faChevronLeft, faChevronRight, faCircleNotch, faFile, faFolder, faFolderOpen, faPlus } from '@fortawesome/free-solid-svg-icons'; import { TreeItem, TreeviewItem } from 'app/exercises/programming/shared/code-editor/treeview/models/treeview-item'; import { TreeviewComponent } from 'app/exercises/programming/shared/code-editor/treeview/components/treeview/treeview.component'; import { findItemInList } from 'app/exercises/programming/shared/code-editor/treeview/helpers/treeview-helper'; +import { TEXT_FILE_EXTENSIONS } from 'app/shared/constants/file-extensions.constants'; export type InteractableEvent = { // Click event object; contains target information @@ -582,7 +582,7 @@ export class CodeEditorFileBrowserComponent implements OnInit, OnChanges, AfterV */ private static shouldDisplayFileBasedOnExtension(fileName: string): boolean { const fileSplit = fileName.split('.'); - return fileSplit.length === 1 || supportedTextFileExtensions.includes(fileSplit.pop()!); + return fileSplit.length === 1 || TEXT_FILE_EXTENSIONS.includes(fileSplit.pop()!); } /** diff --git a/src/main/webapp/app/exercises/programming/shared/code-editor/file-browser/supported-file-extensions.ts b/src/main/webapp/app/exercises/programming/shared/code-editor/file-browser/supported-file-extensions.ts deleted file mode 100644 index 89664e7f5963..000000000000 --- a/src/main/webapp/app/exercises/programming/shared/code-editor/file-browser/supported-file-extensions.ts +++ /dev/null @@ -1,292 +0,0 @@ -export const supportedTextFileExtensions = [ - 'Makefile', - 'R', - 'Rakefile', - 'ada', - 'adb', - 'ads', - 'applescript', - 'as', - 'ascx', - 'asm', - 'asmx', - 'asp', - 'aspx', - 'atom', - 'bas', - 'bash', - 'bashrc', - 'bat', - 'bbcolors', - 'bdsgroup', - 'bdsproj', - 'bib', - 'bowerrc', - 'c', - 'cbl', - 'cc', - 'cfc', - 'cfg', - 'cfm', - 'cfml', - 'cgi', - 'clj', - 'cls', - 'cmake', - 'cmd', - 'cnf', - 'cob', - 'coffee', - 'coffeekup', - 'conf', - 'cpp', - 'cpt', - 'cpy', - 'crt', - 'cs', - 'csh', - 'cson', - 'csr', - 'css', - 'csslintrc', - 'csv', - 'ctl', - 'curlrc', - 'cxx', - 'dart', - 'dfm', - 'diff', - 'dof', - 'dpk', - 'dproj', - 'dtd', - 'eco', - 'editorconfig', - 'ejs', - 'el', - 'emacs', - 'eml', - 'ent', - 'erb', - 'erl', - 'eslintignore', - 'eslintrc', - 'ex', - 'exp', - 'exs', - 'f', - 'f03', - 'f77', - 'f90', - 'f95', - 'fish', - 'for', - 'fpp', - 'frm', - 'ftn', - 'gemrc', - 'gitattributes', - 'gitconfig', - 'gitignore', - 'gitkeep', - 'gitmodules', - 'go', - 'gpp', - 'gradle', - 'groovy', - 'groupproj', - 'grunit', - 'gtmpl', - 'gvimrc', - 'h', - 'haml', - 'hbs', - 'hgignore', - 'hh', - 'hpp', - 'hrl', - 'hs', - 'hta', - 'htaccess', - 'htc', - 'htm', - 'html', - 'htpasswd', - 'hxx', - 'iced', - 'inc', - 'ini', - 'ino', - 'int', - 'irbrc', - 'itcl', - 'itermcolors', - 'itk', - 'jade', - 'java', - 'jhtm', - 'jhtml', - 'js', - 'jscsrc', - 'jshintignore', - 'jshintrc', - 'json', - 'json5', - 'jsonld', - 'jsp', - 'jspx', - 'jsx', - 'ksh', - 'kt', - 'less', - 'lhs', - 'lisp', - 'log', - 'ls', - 'lsp', - 'lua', - 'm', - 'mak', - 'map', - 'markdown', - 'master', - 'md', - 'mdown', - 'mdwn', - 'mdx', - 'metadata', - 'mht', - 'mhtml', - 'mjs', - 'mk', - 'mkd', - 'mkdn', - 'mkdown', - 'ml', - 'mli', - 'mm', - 'mxml', - 'nfm', - 'nfo', - 'noon', - 'npmignore', - 'npmrc', - 'nvmrc', - 'ops', - 'pas', - 'pasm', - 'patch', - 'pbxproj', - 'pch', - 'pem', - 'pg', - 'php', - 'php3', - 'php4', - 'php5', - 'phpt', - 'phtml', - 'pir', - 'pl', - 'pm', - 'pmc', - 'pod', - 'pot', - 'properties', - 'props', - 'pt', - 'pug', - 'py', - 'r', - 'rake', - 'rb', - 'rdoc', - 'rdoc_options', - 'resx', - 'rhtml', - 'rjs', - 'rlib', - 'ron', - 'rs', - 'rss', - 'rst', - 'rtf', - 'rvmrc', - 'rxml', - 's', - 'sass', - 'scala', - 'scm', - 'scss', - 'seestyle', - 'sh', - 'shtml', - 'sls', - 'spec', - 'sql', - 'sqlite', - 'ss', - 'sss', - 'st', - 'strings', - 'sty', - 'styl', - 'stylus', - 'sub', - 'sublime-build', - 'sublime-commands', - 'sublime-completions', - 'sublime-keymap', - 'sublime-macro', - 'sublime-menu', - 'sublime-project', - 'sublime-settings', - 'sublime-workspace', - 'sv', - 'svc', - 'svg', - 'swift', - 't', - 'tcl', - 'tcsh', - 'terminal', - 'tex', - 'text', - 'textile', - 'tg', - 'tmLanguage', - 'tmTheme', - 'tmpl', - 'tpl', - 'ts', - 'tsv', - 'tsx', - 'tt', - 'tt2', - 'ttml', - 'txt', - 'v', - 'vb', - 'vbs', - 'vh', - 'vhd', - 'vhdl', - 'vim', - 'viminfo', - 'vimrc', - 'vue', - 'webapp', - 'wxml', - 'x-php', - 'xht', - 'xhtml', - 'xml', - 'xs', - 'xsd', - 'xsl', - 'xslt', - 'yaml', - 'yml', - 'zsh', - 'zshrc', -]; diff --git a/src/main/webapp/app/exercises/programming/shared/code-editor/service/code-editor-repository.service.ts b/src/main/webapp/app/exercises/programming/shared/code-editor/service/code-editor-repository.service.ts index f2d182c0c87c..172146cafe15 100644 --- a/src/main/webapp/app/exercises/programming/shared/code-editor/service/code-editor-repository.service.ts +++ b/src/main/webapp/app/exercises/programming/shared/code-editor/service/code-editor-repository.service.ts @@ -225,13 +225,6 @@ export class CodeEditorRepositoryFileService extends DomainDependentEndpointServ ); }; - getFileHeaders = (fileName: string, domain?: DomainChange) => { - const restResourceUrl = domain ? this.calculateRestResourceURL(domain) : this.restResourceUrl; - return this.http - .head(`${restResourceUrl}/file-plagiarism-view`, { observe: 'response', params: new HttpParams().set('file', fileName) }) - .pipe(handleErrorResponse(this.conflictService)); - }; - getFilesWithContent = (domain?: DomainChange) => { const restResourceUrl = domain ? this.calculateRestResourceURL(domain) : this.restResourceUrl; return this.http.get(`${restResourceUrl}/files-content`).pipe(handleErrorResponse<{ [fileName: string]: string }>(this.conflictService)); diff --git a/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-split-view/text-submission-viewer/text-submission-viewer.component.ts b/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-split-view/text-submission-viewer/text-submission-viewer.component.ts index ba3fd8301876..9cd4b201f571 100644 --- a/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-split-view/text-submission-viewer/text-submission-viewer.component.ts +++ b/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-split-view/text-submission-viewer/text-submission-viewer.component.ts @@ -11,6 +11,7 @@ import { CodeEditorRepositoryFileService } from 'app/exercises/programming/share import { FileWithHasMatch } from 'app/exercises/shared/plagiarism/plagiarism-split-view/split-pane-header/split-pane-header.component'; import { escape } from 'lodash-es'; import { faExclamationTriangle } from '@fortawesome/free-solid-svg-icons'; +import { TEXT_FILE_EXTENSIONS } from 'app/shared/constants/file-extensions.constants'; type FilesWithType = { [p: string]: FileType }; @@ -174,26 +175,24 @@ export class TextSubmissionViewerComponent implements OnChanges { this.currentFile = file; this.loading = true; - const domain: DomainChange = [DomainType.PARTICIPATION, { id: this.plagiarismSubmission.submissionId }]; - - this.repositoryService.getFileHeaders(file, domain).subscribe((response) => { - const contentType = response.headers.get('content-type'); - if (contentType && !contentType.startsWith('text')) { - this.binaryFile = true; - this.loading = false; - } else { - this.binaryFile = false; - this.repositoryService.getFileForPlagiarismView(file, domain).subscribe({ - next: ({ fileContent }) => { - this.loading = false; - this.fileContent = this.insertMatchTokens(fileContent); - }, - error: () => { - this.loading = false; - }, - }); - } - }); + const fileExtension = file.split('.').last()!; + if (TEXT_FILE_EXTENSIONS.includes(fileExtension)) { + this.binaryFile = false; + + const domain: DomainChange = [DomainType.PARTICIPATION, { id: this.plagiarismSubmission.submissionId }]; + this.repositoryService.getFileForPlagiarismView(file, domain).subscribe({ + next: ({ fileContent }) => { + this.loading = false; + this.fileContent = this.insertMatchTokens(fileContent); + }, + error: () => { + this.loading = false; + }, + }); + } else { + this.binaryFile = true; + this.loading = false; + } } /** diff --git a/src/main/webapp/app/lecture/lecture-attachments.component.ts b/src/main/webapp/app/lecture/lecture-attachments.component.ts index 18e51fe70d38..5b12fa24b510 100644 --- a/src/main/webapp/app/lecture/lecture-attachments.component.ts +++ b/src/main/webapp/app/lecture/lecture-attachments.component.ts @@ -9,7 +9,7 @@ import { FileService } from 'app/shared/http/file.service'; import { Attachment, AttachmentType } from 'app/entities/attachment.model'; import { AttachmentService } from 'app/lecture/attachment.service'; import { faEye, faPaperclip, faPencilAlt, faQuestionCircle, faSpinner, faTimes, faTrash } from '@fortawesome/free-solid-svg-icons'; -import { FILE_EXTENSIONS } from 'app/shared/constants/file-extensions.constants'; +import { UPLOAD_FILE_EXTENSIONS } from 'app/shared/constants/file-extensions.constants'; import { LectureService } from 'app/lecture/lecture.service'; @Component({ @@ -34,9 +34,9 @@ export class LectureAttachmentsComponent implements OnInit, OnDestroy { viewButtonAvailable: Record = {}; // A human-readable list of allowed file extensions - readonly allowedFileExtensions = FILE_EXTENSIONS.join(', '); + readonly allowedFileExtensions = UPLOAD_FILE_EXTENSIONS.join(', '); // The list of file extensions for the "accept" attribute of the file input field - readonly acceptedFileExtensionsFileBrowser = FILE_EXTENSIONS.map((ext) => '.' + ext).join(','); + readonly acceptedFileExtensionsFileBrowser = UPLOAD_FILE_EXTENSIONS.map((ext) => '.' + ext).join(','); private dialogErrorSource = new Subject(); dialogError$ = this.dialogErrorSource.asObservable(); diff --git a/src/main/webapp/app/lecture/lecture-unit/lecture-unit-management/attachment-unit-form/attachment-unit-form.component.ts b/src/main/webapp/app/lecture/lecture-unit/lecture-unit-management/attachment-unit-form/attachment-unit-form.component.ts index 932fb8442f9e..ea597af554eb 100644 --- a/src/main/webapp/app/lecture/lecture-unit/lecture-unit-management/attachment-unit-form/attachment-unit-form.component.ts +++ b/src/main/webapp/app/lecture/lecture-unit/lecture-unit-management/attachment-unit-form/attachment-unit-form.component.ts @@ -3,7 +3,7 @@ import dayjs from 'dayjs/esm'; import { FormBuilder, FormGroup, Validators } from '@angular/forms'; import { TranslateService } from '@ngx-translate/core'; import { faQuestionCircle, faTimes } from '@fortawesome/free-solid-svg-icons'; -import { FILE_EXTENSIONS } from 'app/shared/constants/file-extensions.constants'; +import { UPLOAD_FILE_EXTENSIONS } from 'app/shared/constants/file-extensions.constants'; import { Competency } from 'app/entities/competency.model'; import { MAX_FILE_SIZE } from 'app/shared/constants/input.constants'; @@ -39,9 +39,9 @@ export class AttachmentUnitFormComponent implements OnInit, OnChanges { isEditMode = false; // A human-readable list of allowed file extensions - readonly allowedFileExtensions = FILE_EXTENSIONS.join(', '); + readonly allowedFileExtensions = UPLOAD_FILE_EXTENSIONS.join(', '); // The list of file extensions for the "accept" attribute of the file input field - readonly acceptedFileExtensionsFileBrowser = FILE_EXTENSIONS.map((ext) => '.' + ext).join(','); + readonly acceptedFileExtensionsFileBrowser = UPLOAD_FILE_EXTENSIONS.map((ext) => '.' + ext).join(','); faQuestionCircle = faQuestionCircle; diff --git a/src/main/webapp/app/lecture/lecture-update.component.ts b/src/main/webapp/app/lecture/lecture-update.component.ts index c7aa37c23ffc..8e8fbd4f6dcb 100644 --- a/src/main/webapp/app/lecture/lecture-update.component.ts +++ b/src/main/webapp/app/lecture/lecture-update.component.ts @@ -12,7 +12,7 @@ import { ArtemisNavigationUtilService } from 'app/utils/navigation.utils'; import { DocumentationType } from 'app/shared/components/documentation-button/documentation-button.component'; import { faBan, faHandshakeAngle, faPuzzlePiece, faQuestionCircle, faSave } from '@fortawesome/free-solid-svg-icons'; import { LectureUpdateWizardComponent } from 'app/lecture/wizard-mode/lecture-update-wizard.component'; -import { FILE_EXTENSIONS } from 'app/shared/constants/file-extensions.constants'; +import { UPLOAD_FILE_EXTENSIONS } from 'app/shared/constants/file-extensions.constants'; import { FormulaAction } from 'app/shared/monaco-editor/model/actions/formula.action'; @Component({ @@ -46,9 +46,9 @@ export class LectureUpdateComponent implements OnInit { faHandShakeAngle = faHandshakeAngle; // A human-readable list of allowed file extensions - readonly allowedFileExtensions = FILE_EXTENSIONS.join(', '); + readonly allowedFileExtensions = UPLOAD_FILE_EXTENSIONS.join(', '); // The list of file extensions for the "accept" attribute of the file input field - readonly acceptedFileExtensionsFileBrowser = FILE_EXTENSIONS.map((ext) => '.' + ext).join(','); + readonly acceptedFileExtensionsFileBrowser = UPLOAD_FILE_EXTENSIONS.map((ext) => '.' + ext).join(','); toggleModeFunction = () => this.toggleWizardMode(); saveLectureFunction = () => this.save(); diff --git a/src/main/webapp/app/shared/constants/file-extensions.constants.ts b/src/main/webapp/app/shared/constants/file-extensions.constants.ts index 363f41e6b19b..3d1797cb308d 100644 --- a/src/main/webapp/app/shared/constants/file-extensions.constants.ts +++ b/src/main/webapp/app/shared/constants/file-extensions.constants.ts @@ -1,16 +1,16 @@ /** * The list of file extensions that are allowed to be uploaded in a Markdown editor. * Extensions must be lower-case without leading dots. - * NOTE: Has to be kept in sync with the server-side definitions in FileResource.java + * NOTE: Has to be kept in sync with the server-side definitions in FileService.java */ -export const MARKDOWN_FILE_EXTENSIONS = ['png', 'jpg', 'jpeg', 'gif', 'svg', 'pdf']; +export const UPLOAD_MARKDOWN_FILE_EXTENSIONS = ['png', 'jpg', 'jpeg', 'gif', 'svg', 'pdf']; /** * The global list of file extensions that are allowed to be uploaded. * Extensions must be lower-case without leading dots. - * NOTE: Has to be kept in sync with the server-side definitions in FileResource.java + * NOTE: Has to be kept in sync with the server-side definitions in FileService.java */ -export const FILE_EXTENSIONS = [ +export const UPLOAD_FILE_EXTENSIONS = [ 'png', 'jpg', 'jpeg', @@ -44,3 +44,302 @@ export const FILE_EXTENSIONS = [ 'odi', 'odf', ]; + +/** + * The list of file extensions that are readable in a file editor. + * Extensions are case-sensitive. + * Extensions are the part of the filename after the last dot. + * Files without dots are represented with their full filename. + */ +export const TEXT_FILE_EXTENSIONS = [ + 'Makefile', + 'R', + 'Rakefile', + 'ada', + 'adb', + 'ads', + 'applescript', + 'as', + 'ascx', + 'asm', + 'asmx', + 'asp', + 'aspx', + 'atom', + 'bas', + 'bash', + 'bashrc', + 'bat', + 'bbcolors', + 'bdsgroup', + 'bdsproj', + 'bib', + 'bowerrc', + 'c', + 'cbl', + 'cc', + 'cfc', + 'cfg', + 'cfm', + 'cfml', + 'cgi', + 'clj', + 'cls', + 'cmake', + 'cmd', + 'cnf', + 'cob', + 'coffee', + 'coffeekup', + 'conf', + 'cpp', + 'cpt', + 'cpy', + 'crt', + 'cs', + 'csh', + 'cson', + 'csr', + 'css', + 'csslintrc', + 'csv', + 'ctl', + 'curlrc', + 'cxx', + 'dart', + 'dfm', + 'diff', + 'dof', + 'dpk', + 'dproj', + 'dtd', + 'eco', + 'editorconfig', + 'ejs', + 'el', + 'emacs', + 'eml', + 'ent', + 'erb', + 'erl', + 'eslintignore', + 'eslintrc', + 'ex', + 'exp', + 'exs', + 'f', + 'f03', + 'f77', + 'f90', + 'f95', + 'fish', + 'for', + 'fpp', + 'frm', + 'ftn', + 'gemrc', + 'gitattributes', + 'gitconfig', + 'gitignore', + 'gitkeep', + 'gitmodules', + 'go', + 'gpp', + 'gradle', + 'groovy', + 'groupproj', + 'grunit', + 'gtmpl', + 'gvimrc', + 'h', + 'haml', + 'hbs', + 'hgignore', + 'hh', + 'hpp', + 'hrl', + 'hs', + 'hta', + 'htaccess', + 'htc', + 'htm', + 'html', + 'htpasswd', + 'hxx', + 'iced', + 'inc', + 'ini', + 'ino', + 'int', + 'irbrc', + 'itcl', + 'itermcolors', + 'itk', + 'jade', + 'java', + 'jhtm', + 'jhtml', + 'js', + 'jscsrc', + 'jshintignore', + 'jshintrc', + 'json', + 'json5', + 'jsonld', + 'jsp', + 'jspx', + 'jsx', + 'ksh', + 'kt', + 'less', + 'lhs', + 'lisp', + 'log', + 'ls', + 'lsp', + 'lua', + 'm', + 'mak', + 'map', + 'markdown', + 'master', + 'md', + 'mdown', + 'mdwn', + 'mdx', + 'metadata', + 'mht', + 'mhtml', + 'mjs', + 'mk', + 'mkd', + 'mkdn', + 'mkdown', + 'ml', + 'mli', + 'mm', + 'mxml', + 'nfm', + 'nfo', + 'noon', + 'npmignore', + 'npmrc', + 'nvmrc', + 'ops', + 'pas', + 'pasm', + 'patch', + 'pbxproj', + 'pch', + 'pem', + 'pg', + 'php', + 'php3', + 'php4', + 'php5', + 'phpt', + 'phtml', + 'pir', + 'pl', + 'pm', + 'pmc', + 'pod', + 'pot', + 'properties', + 'props', + 'pt', + 'pug', + 'py', + 'r', + 'rake', + 'rb', + 'rdoc', + 'rdoc_options', + 'resx', + 'rhtml', + 'rjs', + 'rlib', + 'ron', + 'rs', + 'rss', + 'rst', + 'rtf', + 'rvmrc', + 'rxml', + 's', + 'sass', + 'scala', + 'scm', + 'scss', + 'seestyle', + 'sh', + 'shtml', + 'sls', + 'spec', + 'sql', + 'sqlite', + 'ss', + 'sss', + 'st', + 'strings', + 'sty', + 'styl', + 'stylus', + 'sub', + 'sublime-build', + 'sublime-commands', + 'sublime-completions', + 'sublime-keymap', + 'sublime-macro', + 'sublime-menu', + 'sublime-project', + 'sublime-settings', + 'sublime-workspace', + 'sv', + 'svc', + 'svg', + 'swift', + 't', + 'tcl', + 'tcsh', + 'terminal', + 'tex', + 'text', + 'textile', + 'tg', + 'tmLanguage', + 'tmTheme', + 'tmpl', + 'tpl', + 'ts', + 'tsv', + 'tsx', + 'tt', + 'tt2', + 'ttml', + 'txt', + 'v', + 'vb', + 'vbs', + 'vh', + 'vhd', + 'vhdl', + 'vim', + 'viminfo', + 'vimrc', + 'vue', + 'webapp', + 'wxml', + 'x-php', + 'xht', + 'xhtml', + 'xml', + 'xs', + 'xsd', + 'xsl', + 'xslt', + 'yaml', + 'yml', + 'zsh', + 'zshrc', +]; diff --git a/src/main/webapp/app/shared/http/file-uploader.service.ts b/src/main/webapp/app/shared/http/file-uploader.service.ts index fcdc203ea935..a6378198302a 100644 --- a/src/main/webapp/app/shared/http/file-uploader.service.ts +++ b/src/main/webapp/app/shared/http/file-uploader.service.ts @@ -2,7 +2,7 @@ import { HttpClient } from '@angular/common/http'; import { Injectable } from '@angular/core'; import { MAX_FILE_SIZE } from 'app/shared/constants/input.constants'; import { lastValueFrom } from 'rxjs'; -import { MARKDOWN_FILE_EXTENSIONS } from 'app/shared/constants/file-extensions.constants'; +import { UPLOAD_MARKDOWN_FILE_EXTENSIONS } from 'app/shared/constants/file-extensions.constants'; export interface FileUploadResponse { path?: string; @@ -14,7 +14,7 @@ type Options = { @Injectable({ providedIn: 'root' }) export class FileUploaderService { - readonly acceptedMarkdownFileExtensions = MARKDOWN_FILE_EXTENSIONS; + readonly acceptedMarkdownFileExtensions = UPLOAD_MARKDOWN_FILE_EXTENSIONS; constructor(private http: HttpClient) {} /** diff --git a/src/test/javascript/spec/component/plagiarism/text-submission-viewer.component.spec.ts b/src/test/javascript/spec/component/plagiarism/text-submission-viewer.component.spec.ts index 2118d941e1df..a404cf9e63f1 100644 --- a/src/test/javascript/spec/component/plagiarism/text-submission-viewer.component.spec.ts +++ b/src/test/javascript/spec/component/plagiarism/text-submission-viewer.component.spec.ts @@ -13,7 +13,6 @@ import { ProgrammingExercise } from 'app/entities/programming/programming-exerci import { DomainChange, DomainType, FileType } from 'app/exercises/programming/shared/code-editor/model/code-editor.model'; import { PlagiarismSubmission } from 'app/exercises/shared/plagiarism/types/PlagiarismSubmission'; import { TextSubmissionElement } from 'app/exercises/shared/plagiarism/types/text/TextSubmissionElement'; -import { HttpHeaders, HttpResponse } from '@angular/common/http'; import { SplitPaneHeaderComponent } from 'app/exercises/shared/plagiarism/plagiarism-split-view/split-pane-header/split-pane-header.component'; import { MockComponent, MockPipe } from 'ng-mocks'; import { ArtemisTranslatePipe } from 'app/shared/pipes/artemis-translate.pipe'; @@ -29,6 +28,7 @@ describe('Text Submission Viewer Component', () => { 'src/Main.java': FileType.FILE, 'src/Utils.java': FileType.FILE, 'src/Helper.java': FileType.FILE, + 'src/image.png': FileType.FILE, }; beforeEach(() => { @@ -137,7 +137,7 @@ describe('Text Submission Viewer Component', () => { it('filters files of type FILE', () => { const filtered = comp.filterFiles(files); - expect(filtered).toHaveLength(3); + expect(filtered).toHaveLength(4); expect(filtered).not.toContain('src/'); }); @@ -147,8 +147,6 @@ describe('Text Submission Viewer Component', () => { const fileName = Object.keys(files)[1]; comp.matches = new Map(); - const expectedHeaders = new HttpHeaders().append('content-type', 'text/plain'); - jest.spyOn(repositoryService, 'getFileHeaders').mockReturnValue(of(new HttpResponse({ headers: expectedHeaders }))); jest.spyOn(repositoryService, 'getFileForPlagiarismView').mockReturnValue(of({ fileContent: 'if(current>max)' })); comp.handleFileSelect(fileName); @@ -162,9 +160,7 @@ describe('Text Submission Viewer Component', () => { it('handles binary file selection', () => { comp.plagiarismSubmission = { submissionId: 1 } as PlagiarismSubmission; - const fileName = Object.keys(files)[1]; - const expectedHeaders = new HttpHeaders().append('content-type', 'audio/mpeg'); - jest.spyOn(repositoryService, 'getFileHeaders').mockReturnValue(of(new HttpResponse({ headers: expectedHeaders }))); + const fileName = Object.keys(files)[4]; jest.spyOn(repositoryService, 'getFileForPlagiarismView').mockReturnValue(of({ fileContent: 'Test' })); comp.handleFileSelect(fileName); From 3154064515ea84ab13d56e437419d21390ff71a0 Mon Sep 17 00:00:00 2001 From: Mohamed Bilel Besrour <58034472+BBesrour@users.noreply.github.com> Date: Sat, 12 Oct 2024 19:04:17 +0200 Subject: [PATCH 11/23] Integrated code lifecycle: Configure checkout path and timeout for programming exercises (#9217) --- .../artemis/buildagent/dto/BuildConfig.java | 2 +- .../service/BuildJobContainerService.java | 27 +++- .../service/BuildJobExecutionService.java | 3 +- .../service/BuildJobManagementService.java | 12 +- .../aet/artemis/core/config/Constants.java | 14 ++ .../ProgrammingExerciseBuildConfig.java | 38 ++++- .../service/AuxiliaryRepositoryService.java | 4 +- .../service/BuildScriptProviderService.java | 52 ++++++- .../ProgrammingExerciseRepositoryService.java | 27 +++- .../service/ProgrammingExerciseService.java | 39 +++++ .../service/aeolus/AeolusTemplateService.java | 12 +- .../LocalCIBuildConfigurationService.java | 24 +-- .../localci/LocalCITriggerService.java | 10 +- .../web/ProgrammingExerciseResource.java | 3 + .../config/application-buildagent.yml | 2 +- .../changelog/20240816150000_changelog.xml | 11 ++ .../resources/config/liquibase/master.xml | 1 + .../templates/aeolus/assembler/default.sh | 22 +-- .../templates/aeolus/assembler/default.yaml | 24 +-- src/main/resources/templates/aeolus/c/fact.sh | 14 +- .../resources/templates/aeolus/c/fact.yaml | 12 +- src/main/resources/templates/aeolus/c/gcc.sh | 24 +-- .../resources/templates/aeolus/c/gcc.yaml | 22 +-- .../templates/aeolus/c/gcc_static.sh | 24 +-- .../templates/aeolus/c/gcc_static.yaml | 22 +-- .../aeolus/java/plain_maven_blackbox.sh | 4 +- .../aeolus/java/plain_maven_blackbox.yaml | 4 +- .../java/plain_maven_blackbox_static.sh | 4 +- .../java/plain_maven_blackbox_static.yaml | 4 +- .../templates/aeolus/ocaml/default.sh | 2 +- .../templates/aeolus/ocaml/default.yaml | 2 +- .../resources/templates/aeolus/swift/plain.sh | 8 +- .../templates/aeolus/swift/plain.yaml | 8 +- .../templates/aeolus/swift/plain_static.sh | 14 +- .../templates/aeolus/swift/plain_static.yaml | 14 +- .../templates/aeolus/vhdl/default.sh | 18 +-- .../templates/aeolus/vhdl/default.yaml | 20 +-- .../templates/haskell/test/.gitignore | 4 +- .../templates/haskell/test/readme.md | 4 +- .../resources/templates/haskell/test/run.sh | 6 +- .../templates/haskell/test/test.cabal | 4 +- .../test/blackbox/projectTemplate/.gitignore | 2 +- .../test/gradle/projectTemplate/.gitignore | 2 +- .../test/gradle/projectTemplate/build.gradle | 2 +- .../test/maven/projectTemplate/.gitignore | 2 +- .../templates/java/test/stagePom.xml | 2 +- .../templates/javascript/test/.gitignore | 2 +- .../javascript/test/package-lock.json | 6 +- .../templates/javascript/test/package.json | 2 +- .../test/maven/projectTemplate/.gitignore | 2 +- .../templates/kotlin/test/stagePom.xml | 2 +- .../resources/templates/ocaml/test/.gitignore | 4 +- .../templates/ocaml/test/checker/checker.ml | 2 +- .../resources/templates/ocaml/test/run.sh | 19 +-- .../python/test/behavior/behavior_test.py | 6 +- .../python/test/structural/structural_test.py | 8 +- .../resources/templates/rust/test/.gitignore | 2 +- .../resources/templates/rust/test/Cargo.toml | 2 +- .../resources/templates/rust/test/build.rs | 2 +- .../templates/rust/test/tests/structural.rs | 18 +-- .../templates/swift/Swift-Server-Setup.md | 2 +- .../xcschemes/${appName}Test.xcscheme | 4 +- .../xcschemes/${appName}UITest.xcscheme | 4 +- .../contents.xcworkspacedata | 4 +- .../templates/swift/xcode/test/.swiftlint.yml | 2 +- .../templates/swift/xcode/test/README.md | 4 +- .../programming-exercise-build.config.ts | 4 +- .../programming/programming-exercise.model.ts | 4 +- .../programming-exercise-update.component.ts | 41 +++++ .../programming-exercise-update.module.ts | 6 +- ...xercise-build-configuration.component.html | 45 ++++++ ...-exercise-build-configuration.component.ts | 21 +++ ...se-custom-aeolus-build-plan.component.html | 3 +- ...cise-custom-aeolus-build-plan.component.ts | 4 +- ...-exercise-custom-build-plan.component.html | 5 +- ...ng-exercise-custom-build-plan.component.ts | 31 +++- ...mming-exercise-docker-image.component.html | 16 -- ...ramming-exercise-docker-image.component.ts | 14 -- ...amming-exercise-information.component.html | 23 +++ ...gramming-exercise-information.component.ts | 55 ++++++- ...programming-exercise-language.component.ts | 21 ++- ...e-edit-checkout-directories.component.html | 58 +++++++ ...ise-edit-checkout-directories.component.ts | 113 ++++++++++++++ ...sitory-and-build-plan-details.component.ts | 74 ++++++++- .../app/shared/constants/input.constants.ts | 2 + .../webapp/i18n/de/programmingExercise.json | 17 ++ .../webapp/i18n/en/programmingExercise.json | 17 ++ .../service/BuildAgentDockerServiceTest.java | 2 +- .../icl/LocalCIIntegrationTest.java | 12 ++ .../icl/LocalCIResourceIntegrationTest.java | 4 +- .../programming/icl/LocalCIServiceTest.java | 2 +- ...ExerciseLocalVCLocalCIIntegrationTest.java | 13 ++ ...ise-build-configuration.component.spec.ts} | 19 ++- ...ercise-custom-build-plan.component.spec.ts | 9 +- ...dit-checkout-directories.component.spec.ts | 147 ++++++++++++++++++ ...y-and-build-plan-details.component.spec.ts | 83 +++++++++- ...gramming-exercise-update.component.spec.ts | 43 +++++ ...ing-exercise-information.component.spec.ts | 17 +- 98 files changed, 1307 insertions(+), 290 deletions(-) create mode 100644 src/main/resources/config/liquibase/changelog/20240816150000_changelog.xml create mode 100644 src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-build-configuration/programming-exercise-build-configuration.component.html create mode 100644 src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-build-configuration/programming-exercise-build-configuration.component.ts delete mode 100644 src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-docker-image/programming-exercise-docker-image.component.html delete mode 100644 src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-docker-image/programming-exercise-docker-image.component.ts create mode 100644 src/main/webapp/app/exercises/programming/shared/build-details/programming-exercise-edit-checkout-directories/programming-exercise-edit-checkout-directories.component.html create mode 100644 src/main/webapp/app/exercises/programming/shared/build-details/programming-exercise-edit-checkout-directories/programming-exercise-edit-checkout-directories.component.ts rename src/test/javascript/spec/component/programming-exercise/{programming-exercise-docker-image.component.spec.ts => programming-exercise-build-configuration.component.spec.ts} (54%) create mode 100644 src/test/javascript/spec/component/programming-exercise/programming-exercise-edit-checkout-directories.component.spec.ts diff --git a/src/main/java/de/tum/cit/aet/artemis/buildagent/dto/BuildConfig.java b/src/main/java/de/tum/cit/aet/artemis/buildagent/dto/BuildConfig.java index bce9a9b20e65..9a41fc6fdc20 100644 --- a/src/main/java/de/tum/cit/aet/artemis/buildagent/dto/BuildConfig.java +++ b/src/main/java/de/tum/cit/aet/artemis/buildagent/dto/BuildConfig.java @@ -15,7 +15,7 @@ @JsonInclude(JsonInclude.Include.NON_EMPTY) public record BuildConfig(String buildScript, String dockerImage, String commitHashToBuild, String assignmentCommitHash, String testCommitHash, String branch, ProgrammingLanguage programmingLanguage, ProjectType projectType, boolean scaEnabled, boolean sequentialTestRunsEnabled, boolean testwiseCoverageEnabled, - List resultPaths) implements Serializable { + List resultPaths, int timeoutSeconds, String assignmentCheckoutPath, String testCheckoutPath, String solutionCheckoutPath) implements Serializable { @Override public String dockerImage() { diff --git a/src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobContainerService.java b/src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobContainerService.java index 8df60f45026f..b7c97daa9786 100644 --- a/src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobContainerService.java +++ b/src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobContainerService.java @@ -24,6 +24,7 @@ import org.apache.commons.compress.archivers.tar.TarArchiveEntry; import org.apache.commons.compress.archivers.tar.TarArchiveInputStream; import org.apache.commons.compress.archivers.tar.TarArchiveOutputStream; +import org.apache.commons.lang3.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Value; @@ -275,11 +276,22 @@ public String getIDOfRunningContainer(String containerName) { * @param auxiliaryRepositoriesPaths An array of paths for auxiliary repositories to be included in the build process. * @param auxiliaryRepositoryCheckoutDirectories An array of directory names within the container where each auxiliary repository should be checked out. * @param programmingLanguage The programming language of the repositories, which influences directory naming conventions. + * @param assignmentCheckoutPath The directory within the container where the assignment repository should be checked out; can be null if not applicable, + * default would be used. + * @param testCheckoutPath The directory within the container where the test repository should be checked out; can be null if not applicable, default + * would be used. + * @param solutionCheckoutPath The directory within the container where the solution repository should be checked out; can be null if not applicable, default + * would be used. */ public void populateBuildJobContainer(String buildJobContainerId, Path assignmentRepositoryPath, Path testRepositoryPath, Path solutionRepositoryPath, - Path[] auxiliaryRepositoriesPaths, String[] auxiliaryRepositoryCheckoutDirectories, ProgrammingLanguage programmingLanguage) { - String testCheckoutPath = RepositoryCheckoutPath.TEST.forProgrammingLanguage(programmingLanguage); - String assignmentCheckoutPath = RepositoryCheckoutPath.ASSIGNMENT.forProgrammingLanguage(programmingLanguage); + Path[] auxiliaryRepositoriesPaths, String[] auxiliaryRepositoryCheckoutDirectories, ProgrammingLanguage programmingLanguage, String assignmentCheckoutPath, + String testCheckoutPath, String solutionCheckoutPath) { + + assignmentCheckoutPath = (!StringUtils.isBlank(assignmentCheckoutPath)) ? assignmentCheckoutPath + : RepositoryCheckoutPath.ASSIGNMENT.forProgrammingLanguage(programmingLanguage); + + String defaultTestCheckoutPath = RepositoryCheckoutPath.TEST.forProgrammingLanguage(programmingLanguage); + testCheckoutPath = (!StringUtils.isBlank(defaultTestCheckoutPath) && !StringUtils.isBlank(testCheckoutPath)) ? testCheckoutPath : defaultTestCheckoutPath; // Make sure to create the working directory in case it does not exist. // In case the test checkout path is the working directory, we only create up to the parent, as the working directory is created below. @@ -292,7 +304,8 @@ public void populateBuildJobContainer(String buildJobContainerId, Path assignmen // Copy the assignment repository to the container and move it to the assignment checkout path addAndPrepareDirectory(buildJobContainerId, assignmentRepositoryPath, LOCALCI_WORKING_DIRECTORY + "/testing-dir/" + assignmentCheckoutPath); if (solutionRepositoryPath != null) { - String solutionCheckoutPath = RepositoryCheckoutPath.SOLUTION.forProgrammingLanguage(programmingLanguage); + solutionCheckoutPath = (!StringUtils.isBlank(solutionCheckoutPath)) ? solutionCheckoutPath + : RepositoryCheckoutPath.SOLUTION.forProgrammingLanguage(programmingLanguage); addAndPrepareDirectory(buildJobContainerId, solutionRepositoryPath, LOCALCI_WORKING_DIRECTORY + "/testing-dir/" + solutionCheckoutPath); } for (int i = 0; i < auxiliaryRepositoriesPaths.length; i++) { @@ -309,6 +322,7 @@ private void createScriptFile(String buildJobContainerId) { private void addAndPrepareDirectory(String containerId, Path repositoryPath, String newDirectoryName) { copyToContainer(repositoryPath.toString(), containerId); + addDirectory(containerId, getParentFolderPath(newDirectoryName), true); renameDirectoryOrFile(containerId, LOCALCI_WORKING_DIRECTORY + "/" + repositoryPath.getFileName().toString(), newDirectoryName); } @@ -428,4 +442,9 @@ private Container getContainerForName(String containerName) { List containers = dockerClient.listContainersCmd().withShowAll(true).exec(); return containers.stream().filter(container -> container.getNames()[0].equals("/" + containerName)).findFirst().orElse(null); } + + private String getParentFolderPath(String path) { + Path parentPath = Paths.get(path).normalize().getParent(); + return parentPath != null ? parentPath.toString() : ""; + } } diff --git a/src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobExecutionService.java b/src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobExecutionService.java index f25d5b6f749d..9c968c453e47 100644 --- a/src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobExecutionService.java +++ b/src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobExecutionService.java @@ -245,7 +245,8 @@ private BuildResult runScriptAndParseResults(BuildJobQueueItem buildJob, String buildLogsMap.appendBuildLogEntry(buildJob.id(), msg); log.debug(msg); buildJobContainerService.populateBuildJobContainer(containerId, assignmentRepositoryPath, testsRepositoryPath, solutionRepositoryPath, auxiliaryRepositoriesPaths, - buildJob.repositoryInfo().auxiliaryRepositoryCheckoutDirectories(), buildJob.buildConfig().programmingLanguage()); + buildJob.repositoryInfo().auxiliaryRepositoryCheckoutDirectories(), buildJob.buildConfig().programmingLanguage(), buildJob.buildConfig().assignmentCheckoutPath(), + buildJob.buildConfig().testCheckoutPath(), buildJob.buildConfig().solutionCheckoutPath()); msg = "~~~~~~~~~~~~~~~~~~~~ Executing Build Script for Build job " + buildJob.id() + " ~~~~~~~~~~~~~~~~~~~~"; buildLogsMap.appendBuildLogEntry(buildJob.id(), msg); diff --git a/src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobManagementService.java b/src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobManagementService.java index f514d59496cd..804d7d1e50df 100644 --- a/src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobManagementService.java +++ b/src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobManagementService.java @@ -58,7 +58,7 @@ public class BuildJobManagementService { private final ReentrantLock lock = new ReentrantLock(); - @Value("${artemis.continuous-integration.timeout-seconds:240}") + @Value("${artemis.continuous-integration.timeout-seconds:120}") private int timeoutSeconds; @Value("${artemis.continuous-integration.asynchronous:true}") @@ -149,9 +149,17 @@ public CompletableFuture executeBuildJob(BuildJobQueueItem buildJob lock.unlock(); } + int buildJobTimeoutSeconds; + if (buildJobItem.buildConfig().timeoutSeconds() != 0 && buildJobItem.buildConfig().timeoutSeconds() < this.timeoutSeconds) { + buildJobTimeoutSeconds = buildJobItem.buildConfig().timeoutSeconds(); + } + else { + buildJobTimeoutSeconds = this.timeoutSeconds; + } + CompletableFuture futureResult = createCompletableFuture(() -> { try { - return future.get(timeoutSeconds, TimeUnit.SECONDS); + return future.get(buildJobTimeoutSeconds, TimeUnit.SECONDS); } catch (Exception e) { // RejectedExecutionException is thrown if the queue size limit (defined in "artemis.continuous-integration.queue-size-limit") is reached. diff --git a/src/main/java/de/tum/cit/aet/artemis/core/config/Constants.java b/src/main/java/de/tum/cit/aet/artemis/core/config/Constants.java index 71e4dc0a5775..3f61f7de5ff0 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/config/Constants.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/config/Constants.java @@ -93,6 +93,8 @@ public final class Constants { // Used to cut off CI specific path segments when receiving static code analysis reports public static final String ASSIGNMENT_DIRECTORY = "/" + ASSIGNMENT_REPO_NAME + "/"; + public static final String TEST_WORKING_DIRECTORY = "test"; + // Used as a value for for the Java template pom.xml public static final String STUDENT_WORKING_DIRECTORY = ASSIGNMENT_DIRECTORY + "src"; @@ -390,6 +392,18 @@ public final class Constants { */ public static final int MIN_SCORE_ORANGE = 40; + public static final String ASSIGNMENT_REPO_PLACEHOLDER = "${studentWorkingDirectory}"; + + public static final String TEST_REPO_PLACEHOLDER = "${testWorkingDirectory}"; + + public static final String SOLUTION_REPO_PLACEHOLDER = "${solutionWorkingDirectory}"; + + public static final String ASSIGNMENT_REPO_PARENT_PLACEHOLDER = "${studentParentWorkingDirectoryName}"; + + public static final String ASSIGNMENT_REPO_PLACEHOLDER_NO_SLASH = "${studentWorkingDirectoryNoSlash}"; + + public static final Pattern ALLOWED_CHECKOUT_DIRECTORY = Pattern.compile("[\\w-]+(/[\\w-]+)*$"); + private Constants() { } } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/domain/ProgrammingExerciseBuildConfig.java b/src/main/java/de/tum/cit/aet/artemis/programming/domain/ProgrammingExerciseBuildConfig.java index e8b5e554c37d..a5ada6708999 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/domain/ProgrammingExerciseBuildConfig.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/domain/ProgrammingExerciseBuildConfig.java @@ -49,7 +49,13 @@ public class ProgrammingExerciseBuildConfig extends DomainObject { private boolean checkoutSolutionRepository = false; @Column(name = "checkout_path") - private String checkoutPath; + private String testCheckoutPath; + + @Column(name = "assignment_checkout_path") + private String assignmentCheckoutPath; + + @Column(name = "solution_checkout_path") + private String solutionCheckoutPath; @Column(name = "timeout_seconds") private int timeoutSeconds; @@ -85,7 +91,9 @@ public ProgrammingExerciseBuildConfig() { public ProgrammingExerciseBuildConfig(ProgrammingExerciseBuildConfig originalBuildConfig) { this.setBranch(originalBuildConfig.getBranch()); this.setBuildPlanConfiguration(originalBuildConfig.getBuildPlanConfiguration()); - this.setCheckoutPath(originalBuildConfig.getCheckoutPath()); + this.setTestCheckoutPath(originalBuildConfig.getTestCheckoutPath()); + this.setAssignmentCheckoutPath(originalBuildConfig.getAssignmentCheckoutPath()); + this.setSolutionCheckoutPath(originalBuildConfig.getSolutionCheckoutPath()); this.setCheckoutSolutionRepository(originalBuildConfig.getCheckoutSolutionRepository()); this.setDockerFlags(originalBuildConfig.getDockerFlags()); this.setSequentialTestRuns(originalBuildConfig.hasSequentialTestRuns()); @@ -166,12 +174,12 @@ public void setCheckoutSolutionRepository(boolean checkoutSolutionRepository) { this.checkoutSolutionRepository = checkoutSolutionRepository; } - public String getCheckoutPath() { - return checkoutPath; + public String getTestCheckoutPath() { + return testCheckoutPath; } - public void setCheckoutPath(String checkoutPath) { - this.checkoutPath = checkoutPath; + public void setTestCheckoutPath(String testCheckoutPath) { + this.testCheckoutPath = testCheckoutPath; } public int getTimeoutSeconds() { @@ -268,11 +276,27 @@ public void generateAndSetBuildPlanAccessSecret() { buildPlanAccessSecret = UUID.randomUUID().toString(); } + public String getAssignmentCheckoutPath() { + return assignmentCheckoutPath; + } + + public void setAssignmentCheckoutPath(String assignmentCheckoutPath) { + this.assignmentCheckoutPath = assignmentCheckoutPath; + } + + public String getSolutionCheckoutPath() { + return solutionCheckoutPath; + } + + public void setSolutionCheckoutPath(String solutionCheckoutPath) { + this.solutionCheckoutPath = solutionCheckoutPath; + } + @Override public String toString() { return "BuildJobConfig{" + "id=" + getId() + ", sequentialTestRuns=" + sequentialTestRuns + ", branch='" + branch + '\'' + ", buildPlanConfiguration='" + buildPlanConfiguration + '\'' + ", buildScript='" + buildScript + '\'' + ", checkoutSolutionRepository=" + checkoutSolutionRepository + ", checkoutPath='" - + checkoutPath + '\'' + ", timeoutSeconds=" + timeoutSeconds + ", dockerFlags='" + dockerFlags + '\'' + ", testwiseCoverageEnabled=" + testwiseCoverageEnabled + + testCheckoutPath + '\'' + ", timeoutSeconds=" + timeoutSeconds + ", dockerFlags='" + dockerFlags + '\'' + ", testwiseCoverageEnabled=" + testwiseCoverageEnabled + ", theiaImage='" + theiaImage + '\'' + ", allowBranching=" + allowBranching + ", branchRegex='" + branchRegex + '\'' + '}'; } } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/AuxiliaryRepositoryService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/AuxiliaryRepositoryService.java index 7d9a21297e75..23aa653d7301 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/AuxiliaryRepositoryService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/AuxiliaryRepositoryService.java @@ -1,5 +1,6 @@ package de.tum.cit.aet.artemis.programming.service; +import static de.tum.cit.aet.artemis.core.config.Constants.ALLOWED_CHECKOUT_DIRECTORY; import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE; import java.util.ArrayList; @@ -7,7 +8,6 @@ import java.util.Map; import java.util.Objects; import java.util.regex.Matcher; -import java.util.regex.Pattern; import org.springframework.context.annotation.Profile; import org.springframework.stereotype.Service; @@ -27,8 +27,6 @@ public class AuxiliaryRepositoryService { private static final String AUX_REPO_ENTITY_NAME = "programmingExercise"; - private static final Pattern ALLOWED_CHECKOUT_DIRECTORY = Pattern.compile("[\\w-]+(/[\\w-]+)*$"); - private final AuxiliaryRepositoryRepository auxiliaryRepositoryRepository; public AuxiliaryRepositoryService(AuxiliaryRepositoryRepository auxiliaryRepositoryRepository) { diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/BuildScriptProviderService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/BuildScriptProviderService.java index db9e37239d9e..487c92b3c21d 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/BuildScriptProviderService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/BuildScriptProviderService.java @@ -10,6 +10,7 @@ import java.util.concurrent.ConcurrentHashMap; import org.apache.commons.io.IOUtils; +import org.apache.commons.lang3.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.boot.context.event.ApplicationReadyEvent; @@ -18,6 +19,8 @@ import org.springframework.core.io.Resource; import org.springframework.stereotype.Service; +import de.tum.cit.aet.artemis.core.config.Constants; +import de.tum.cit.aet.artemis.core.service.ProfileService; import de.tum.cit.aet.artemis.core.service.ResourceLoaderService; import de.tum.cit.aet.artemis.programming.domain.ProgrammingExercise; import de.tum.cit.aet.artemis.programming.domain.ProgrammingExerciseBuildConfig; @@ -39,14 +42,17 @@ public class BuildScriptProviderService { private final Map scriptCache = new ConcurrentHashMap<>(); + private final ProfileService profileService; + /** * Constructor for BuildScriptProvider, which loads all scripts into the cache to speed up retrieval * during the runtime of the application * * @param resourceLoaderService resourceLoaderService */ - public BuildScriptProviderService(ResourceLoaderService resourceLoaderService) { + public BuildScriptProviderService(ResourceLoaderService resourceLoaderService, ProfileService profileService) { this.resourceLoaderService = resourceLoaderService; + this.profileService = profileService; } /** @@ -69,6 +75,9 @@ public void cacheOnBoot() { String uniqueKey = directory + "_" + filename; byte[] fileContent = IOUtils.toByteArray(resource.getInputStream()); String script = new String(fileContent, StandardCharsets.UTF_8); + if (!profileService.isLocalCiActive()) { + script = replacePlaceholders(script, null, null, null); + } scriptCache.put(uniqueKey, script); } catch (IOException e) { @@ -112,6 +121,9 @@ public String getScriptFor(ProgrammingLanguage programmingLanguage, Optional projectType, Boolean stati } return String.join("_", fileNameComponents) + "." + fileExtension; } + + /** + * Replaces placeholders in the given result paths with the actual paths. + * + * @param resultPaths the result paths to replace the placeholders in + * @param buildConfig the build configuration containing the actual paths + * @return the result paths with the placeholders replaced + */ + public List replaceResultPathsPlaceholders(List resultPaths, ProgrammingExerciseBuildConfig buildConfig) { + List replacedResultPaths = new ArrayList<>(); + for (String resultPath : resultPaths) { + String replacedResultPath = replacePlaceholders(resultPath, buildConfig.getAssignmentCheckoutPath(), buildConfig.getSolutionCheckoutPath(), + buildConfig.getTestCheckoutPath()); + replacedResultPaths.add(replacedResultPath); + } + return replacedResultPaths; + } + + /** + * Replaces placeholders in the given original string with the actual paths. + * + * @param originalString the original string to replace the placeholders in + * @param assignmentRepo the assignment repository name + * @param solutionRepo the solution repository name + * @param testRepo the test repository name + * @return the original string with the placeholders replaced + */ + public String replacePlaceholders(String originalString, String assignmentRepo, String solutionRepo, String testRepo) { + assignmentRepo = !StringUtils.isBlank(assignmentRepo) ? assignmentRepo : Constants.ASSIGNMENT_REPO_NAME; + solutionRepo = solutionRepo != null && !solutionRepo.isBlank() ? solutionRepo : Constants.SOLUTION_REPO_NAME; + testRepo = testRepo != null && !testRepo.isBlank() ? testRepo : Constants.TEST_REPO_NAME; + + String replacedResultPath = originalString.replace(Constants.ASSIGNMENT_REPO_PARENT_PLACEHOLDER, assignmentRepo); + replacedResultPath = replacedResultPath.replace(Constants.ASSIGNMENT_REPO_PLACEHOLDER, "/" + assignmentRepo + "/src"); + replacedResultPath = replacedResultPath.replace(Constants.SOLUTION_REPO_PLACEHOLDER, solutionRepo); + replacedResultPath = replacedResultPath.replace(Constants.TEST_REPO_PLACEHOLDER, testRepo); + return replacedResultPath; + } } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/ProgrammingExerciseRepositoryService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/ProgrammingExerciseRepositoryService.java index db7803c21c22..c302c5f147e5 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/ProgrammingExerciseRepositoryService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/ProgrammingExerciseRepositoryService.java @@ -17,6 +17,7 @@ import java.util.Optional; import org.apache.commons.io.FileUtils; +import org.apache.commons.lang3.StringUtils; import org.eclipse.jgit.api.errors.GitAPIException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -662,8 +663,32 @@ void replacePlaceholders(final ProgrammingExercise programmingExercise, final Re replacements.put("${exerciseNamePomXml}", programmingExercise.getTitle().replace(" ", "-")); // Used e.g. in artifactId replacements.put("${exerciseName}", programmingExercise.getTitle()); - replacements.put("${studentWorkingDirectory}", Constants.STUDENT_WORKING_DIRECTORY); replacements.put("${packaging}", programmingExercise.getBuildConfig().hasSequentialTestRuns() ? "pom" : "jar"); + + var buildConfig = programmingExercise.getBuildConfig(); + + // replace checkout directory placeholders + String studentWorkingDirectory = !StringUtils.isBlank(buildConfig.getAssignmentCheckoutPath()) ? buildConfig.getAssignmentCheckoutPath() : Constants.ASSIGNMENT_REPO_NAME; + if (studentWorkingDirectory.startsWith("/")) { + studentWorkingDirectory = studentWorkingDirectory.substring(1); + } + String testWorkingDirectory = buildConfig.getTestCheckoutPath() != null && !buildConfig.getTestCheckoutPath().isBlank() ? buildConfig.getTestCheckoutPath() + : Constants.TEST_REPO_NAME; + String solutionWorkingDirectory = buildConfig.getSolutionCheckoutPath() != null && !buildConfig.getSolutionCheckoutPath().isBlank() ? buildConfig.getSolutionCheckoutPath() + : Constants.SOLUTION_REPO_NAME; + + if (programmingLanguage == ProgrammingLanguage.PYTHON) { + replacements.put(Constants.ASSIGNMENT_REPO_PARENT_PLACEHOLDER, studentWorkingDirectory.replace("/", ".")); + } + else { + replacements.put(Constants.ASSIGNMENT_REPO_PARENT_PLACEHOLDER, studentWorkingDirectory); + } + replacements.put(Constants.ASSIGNMENT_REPO_PLACEHOLDER, "/" + studentWorkingDirectory + "/src"); + replacements.put(Constants.TEST_REPO_PLACEHOLDER, testWorkingDirectory); + replacements.put(Constants.SOLUTION_REPO_PLACEHOLDER, solutionWorkingDirectory); + if ((programmingLanguage == ProgrammingLanguage.JAVA && programmingExercise.getProjectType().isGradle()) || programmingLanguage == ProgrammingLanguage.RUST) { + replacements.put(Constants.ASSIGNMENT_REPO_PLACEHOLDER_NO_SLASH, studentWorkingDirectory + "/src"); + } fileService.replaceVariablesInFileRecursive(repository.getLocalPath().toAbsolutePath(), replacements, List.of("gradle-wrapper.jar")); } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/ProgrammingExerciseService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/ProgrammingExerciseService.java index 00e854f1d218..0cbf73da21ff 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/ProgrammingExerciseService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/ProgrammingExerciseService.java @@ -1,5 +1,6 @@ package de.tum.cit.aet.artemis.programming.service; +import static de.tum.cit.aet.artemis.core.config.Constants.ALLOWED_CHECKOUT_DIRECTORY; import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE; import static de.tum.cit.aet.artemis.programming.domain.build.BuildPlanType.SOLUTION; import static de.tum.cit.aet.artemis.programming.domain.build.BuildPlanType.TEMPLATE; @@ -362,6 +363,7 @@ public void validateNewProgrammingExerciseSettings(ProgrammingExercise programmi programmingExercise.validateGeneralSettings(); programmingExercise.validateProgrammingSettings(); programmingExercise.validateSettingsForFeedbackRequest(); + validateCustomCheckoutPaths(programmingExercise); auxiliaryRepositoryService.validateAndAddAuxiliaryRepositoriesOfProgrammingExercise(programmingExercise, programmingExercise.getAuxiliaryRepositories()); submissionPolicyService.validateSubmissionPolicyCreation(programmingExercise); @@ -427,6 +429,27 @@ private void validatePackageName(ProgrammingExercise programmingExercise, Progra } } + private void validateCustomCheckoutPaths(ProgrammingExercise programmingExercise) { + var buildConfig = programmingExercise.getBuildConfig(); + + boolean assignmentCheckoutPathIsValid = isValidCheckoutPath(buildConfig.getAssignmentCheckoutPath()); + boolean solutionCheckoutPathIsValid = isValidCheckoutPath(buildConfig.getSolutionCheckoutPath()); + boolean testCheckoutPathIsValid = isValidCheckoutPath(buildConfig.getTestCheckoutPath()); + + if (!assignmentCheckoutPathIsValid || !solutionCheckoutPathIsValid || !testCheckoutPathIsValid) { + throw new BadRequestAlertException("The custom checkout paths are invalid", "Exercise", "checkoutDirectoriesInvalid"); + } + } + + private boolean isValidCheckoutPath(String checkoutPath) { + // Checkout paths are optional for the assignment, solution, and test repositories. If not set, the default path is used. + if (checkoutPath == null) { + return true; + } + Matcher matcher = ALLOWED_CHECKOUT_DIRECTORY.matcher(checkoutPath); + return matcher.matches(); + } + /** * Validates static code analysis settings * @@ -438,6 +461,22 @@ public void validateStaticCodeAnalysisSettings(ProgrammingExercise programmingEx programmingExercise.validateStaticCodeAnalysisSettings(programmingLanguageFeature); } + /** + * Validates the settings of an updated programming exercise. Checks if the custom checkout paths have changed. + * + * @param originalProgrammingExercise The original programming exercise + * @param updatedProgrammingExercise The updated programming exercise + */ + public void validateCheckoutDirectoriesUnchanged(ProgrammingExercise originalProgrammingExercise, ProgrammingExercise updatedProgrammingExercise) { + var originalBuildConfig = originalProgrammingExercise.getBuildConfig(); + var updatedBuildConfig = updatedProgrammingExercise.getBuildConfig(); + if (!Objects.equals(originalBuildConfig.getAssignmentCheckoutPath(), updatedBuildConfig.getAssignmentCheckoutPath()) + || !Objects.equals(originalBuildConfig.getSolutionCheckoutPath(), updatedBuildConfig.getSolutionCheckoutPath()) + || !Objects.equals(originalBuildConfig.getTestCheckoutPath(), updatedBuildConfig.getTestCheckoutPath())) { + throw new BadRequestAlertException("The custom checkout paths cannot be changed!", "programmingExercise", "checkoutDirectoriesChanged"); + } + } + /** * Creates build plans for a new programming exercise. * 1. Create the project for the exercise on the CI Server diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/aeolus/AeolusTemplateService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/aeolus/AeolusTemplateService.java index 14bde3cf26b1..64321ad3b61d 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/aeolus/AeolusTemplateService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/aeolus/AeolusTemplateService.java @@ -20,6 +20,7 @@ import com.fasterxml.jackson.dataformat.yaml.YAMLFactory; import de.tum.cit.aet.artemis.core.config.ProgrammingLanguageConfiguration; +import de.tum.cit.aet.artemis.core.service.ProfileService; import de.tum.cit.aet.artemis.core.service.ResourceLoaderService; import de.tum.cit.aet.artemis.programming.domain.ProgrammingExercise; import de.tum.cit.aet.artemis.programming.domain.ProgrammingExerciseBuildConfig; @@ -46,13 +47,16 @@ public class AeolusTemplateService { private final BuildScriptProviderService buildScriptProviderService; + private final ProfileService profileService; + private static final ObjectMapper yamlMapper = new ObjectMapper(new YAMLFactory()); public AeolusTemplateService(ProgrammingLanguageConfiguration programmingLanguageConfiguration, ResourceLoaderService resourceLoaderService, - BuildScriptProviderService buildScriptProviderService) { + BuildScriptProviderService buildScriptProviderService, ProfileService profileService) { this.programmingLanguageConfiguration = programmingLanguageConfiguration; this.resourceLoaderService = resourceLoaderService; this.buildScriptProviderService = buildScriptProviderService; + this.profileService = profileService; } /** @@ -76,6 +80,9 @@ public void cacheOnBoot() { String uniqueKey = directory + "_" + filename; byte[] fileContent = IOUtils.toByteArray(resource.getInputStream()); String script = new String(fileContent, StandardCharsets.UTF_8); + if (!profileService.isLocalCiActive()) { + script = buildScriptProviderService.replacePlaceholders(script, null, null, null); + } Windfile windfile = readWindfile(script); this.addInstanceVariablesToWindfile(windfile, ProgrammingLanguage.valueOf(directory.toUpperCase()), optionalProjectType); templateCache.put(uniqueKey, windfile); @@ -140,6 +147,9 @@ public Windfile getWindfileFor(ProgrammingLanguage programmingLanguage, Optional log.error("No windfile found for key {}", uniqueKey); return null; } + if (!profileService.isLocalCiActive()) { + scriptCache = buildScriptProviderService.replacePlaceholders(scriptCache, null, null, null); + } Windfile windfile = readWindfile(scriptCache); this.addInstanceVariablesToWindfile(windfile, programmingLanguage, projectType); templateCache.put(uniqueKey, windfile); diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/LocalCIBuildConfigurationService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/LocalCIBuildConfigurationService.java index d8c03392661e..e4803619c97d 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/LocalCIBuildConfigurationService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/LocalCIBuildConfigurationService.java @@ -11,6 +11,7 @@ import de.tum.cit.aet.artemis.core.exception.LocalCIException; 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.service.BuildScriptProviderService; import de.tum.cit.aet.artemis.programming.service.aeolus.AeolusTemplateService; import de.tum.cit.aet.artemis.programming.service.aeolus.ScriptAction; import de.tum.cit.aet.artemis.programming.service.aeolus.Windfile; @@ -21,8 +22,11 @@ public class LocalCIBuildConfigurationService { private final AeolusTemplateService aeolusTemplateService; - public LocalCIBuildConfigurationService(AeolusTemplateService aeolusTemplateService) { + private final BuildScriptProviderService buildScriptProviderService; + + public LocalCIBuildConfigurationService(AeolusTemplateService aeolusTemplateService, BuildScriptProviderService buildScriptProviderService) { this.aeolusTemplateService = aeolusTemplateService; + this.buildScriptProviderService = buildScriptProviderService; } /** @@ -34,15 +38,15 @@ public LocalCIBuildConfigurationService(AeolusTemplateService aeolusTemplateServ */ public String createBuildScript(ProgrammingExercise programmingExercise) { - StringBuilder buildScript = new StringBuilder(); - buildScript.append("#!/bin/bash\n"); - buildScript.append("cd ").append(LOCALCI_WORKING_DIRECTORY).append("/testing-dir\n"); + StringBuilder buildScriptBuilder = new StringBuilder(); + buildScriptBuilder.append("#!/bin/bash\n"); + buildScriptBuilder.append("cd ").append(LOCALCI_WORKING_DIRECTORY).append("/testing-dir\n"); ProgrammingExerciseBuildConfig buildConfig = programmingExercise.getBuildConfig(); String customScript = buildConfig.getBuildScript(); // Todo: get default script if custom script is null before trying to get actions from windfile if (customScript != null) { - buildScript.append(customScript); + buildScriptBuilder.append(customScript); } else { List actions; @@ -62,16 +66,16 @@ public String createBuildScript(ProgrammingExercise programmingExercise) { actions.forEach(action -> { String workdir = action.getWorkdir(); if (workdir != null) { - buildScript.append("cd ").append(LOCALCI_WORKING_DIRECTORY).append("/testing-dir/").append(workdir).append("\n"); + buildScriptBuilder.append("cd ").append(LOCALCI_WORKING_DIRECTORY).append("/testing-dir/").append(workdir).append("\n"); } - buildScript.append(action.getScript()).append("\n"); + buildScriptBuilder.append(action.getScript()).append("\n"); if (workdir != null) { - buildScript.append("cd ").append(LOCALCI_WORKING_DIRECTORY).append("/testing-dir\n"); + buildScriptBuilder.append("cd ").append(LOCALCI_WORKING_DIRECTORY).append("/testing-dir\n"); } }); } - return buildScript.toString(); + return buildScriptProviderService.replacePlaceholders(buildScriptBuilder.toString(), programmingExercise.getBuildConfig().getAssignmentCheckoutPath(), + programmingExercise.getBuildConfig().getSolutionCheckoutPath(), programmingExercise.getBuildConfig().getTestCheckoutPath()); } - } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/LocalCITriggerService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/LocalCITriggerService.java index 10569adbbf30..5da2860ba799 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/LocalCITriggerService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/LocalCITriggerService.java @@ -42,6 +42,7 @@ import de.tum.cit.aet.artemis.programming.repository.AuxiliaryRepositoryRepository; import de.tum.cit.aet.artemis.programming.repository.ProgrammingExerciseBuildConfigRepository; import de.tum.cit.aet.artemis.programming.repository.SolutionProgrammingExerciseParticipationRepository; +import de.tum.cit.aet.artemis.programming.service.BuildScriptProviderService; import de.tum.cit.aet.artemis.programming.service.GitService; import de.tum.cit.aet.artemis.programming.service.ProgrammingLanguageFeature; import de.tum.cit.aet.artemis.programming.service.aeolus.AeolusResult; @@ -75,6 +76,8 @@ public class LocalCITriggerService implements ContinuousIntegrationTriggerServic private final AeolusTemplateService aeolusTemplateService; + private final BuildScriptProviderService buildScriptProviderService; + private final ProgrammingLanguageConfiguration programmingLanguageConfiguration; private final AuxiliaryRepositoryRepository auxiliaryRepositoryRepository; @@ -102,7 +105,7 @@ public LocalCITriggerService(@Qualifier("hazelcastInstance") HazelcastInstance h LocalCIProgrammingLanguageFeatureService programmingLanguageFeatureService, Optional versionControlService, SolutionProgrammingExerciseParticipationRepository solutionProgrammingExerciseParticipationRepository, LocalCIBuildConfigurationService localCIBuildConfigurationService, GitService gitService, ExerciseDateService exerciseDateService, - ProgrammingExerciseBuildConfigRepository programmingExerciseBuildConfigRepository) { + ProgrammingExerciseBuildConfigRepository programmingExerciseBuildConfigRepository, BuildScriptProviderService buildScriptProviderService) { this.hazelcastInstance = hazelcastInstance; this.aeolusTemplateService = aeolusTemplateService; this.programmingLanguageConfiguration = programmingLanguageConfiguration; @@ -114,6 +117,7 @@ public LocalCITriggerService(@Qualifier("hazelcastInstance") HazelcastInstance h this.gitService = gitService; this.programmingExerciseBuildConfigRepository = programmingExerciseBuildConfigRepository; this.exerciseDateService = exerciseDateService; + this.buildScriptProviderService = buildScriptProviderService; } @PostConstruct @@ -304,13 +308,15 @@ private BuildConfig getBuildConfig(ProgrammingExerciseParticipation participatio } List resultPaths = getTestResultPaths(windfile); + resultPaths = buildScriptProviderService.replaceResultPathsPlaceholders(resultPaths, buildConfig); // Todo: If build agent does not have access to filesystem, we need to send the build script to the build agent and execute it there. programmingExercise.setBuildConfig(buildConfig); String buildScript = localCIBuildConfigurationService.createBuildScript(programmingExercise); return new BuildConfig(buildScript, dockerImage, commitHashToBuild, assignmentCommitHash, testCommitHash, branch, programmingLanguage, projectType, - staticCodeAnalysisEnabled, sequentialTestRunsEnabled, testwiseCoverageEnabled, resultPaths); + staticCodeAnalysisEnabled, sequentialTestRunsEnabled, testwiseCoverageEnabled, resultPaths, buildConfig.getTimeoutSeconds(), + buildConfig.getAssignmentCheckoutPath(), buildConfig.getTestCheckoutPath(), buildConfig.getSolutionCheckoutPath()); } private ProgrammingExerciseBuildConfig loadBuildConfig(ProgrammingExercise programmingExercise) { 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 index 7462f19512c1..2225baa81759 100644 --- 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 @@ -327,6 +327,9 @@ public ResponseEntity updateProgrammingExercise(@RequestBod } } + // Verify that the checkout directories have not been changed. This is required since the buildScript and result paths are determined during the creation of the exercise. + programmingExerciseService.validateCheckoutDirectoriesUnchanged(programmingExerciseBeforeUpdate, updatedProgrammingExercise); + // Verify that a theia image is provided when the online IDE is enabled if (updatedProgrammingExercise.isAllowOnlineIde() && updatedProgrammingExercise.getBuildConfig().getTheiaImage() == null) { throw new BadRequestAlertException("You need to provide a Theia image when the online IDE is enabled", ENTITY_NAME, "noTheiaImageProvided"); diff --git a/src/main/resources/config/application-buildagent.yml b/src/main/resources/config/application-buildagent.yml index b013910100e5..1439567b2cc9 100644 --- a/src/main/resources/config/application-buildagent.yml +++ b/src/main/resources/config/application-buildagent.yml @@ -18,7 +18,7 @@ artemis: specify-concurrent-builds: false concurrent-build-size: 1 asynchronous: true - timeout-seconds: 240 + timeout-seconds: 120 build-container-prefix: local-ci- proxies: use-system-proxy: false diff --git a/src/main/resources/config/liquibase/changelog/20240816150000_changelog.xml b/src/main/resources/config/liquibase/changelog/20240816150000_changelog.xml new file mode 100644 index 000000000000..b3fa6c9e1c47 --- /dev/null +++ b/src/main/resources/config/liquibase/changelog/20240816150000_changelog.xml @@ -0,0 +1,11 @@ + + + + + + + + + diff --git a/src/main/resources/config/liquibase/master.xml b/src/main/resources/config/liquibase/master.xml index 23186d8dbad3..d496528a13ec 100644 --- a/src/main/resources/config/liquibase/master.xml +++ b/src/main/resources/config/liquibase/master.xml @@ -27,6 +27,7 @@ + diff --git a/src/main/resources/templates/aeolus/assembler/default.sh b/src/main/resources/templates/aeolus/assembler/default.sh index cca62d776297..e5a322facd87 100644 --- a/src/main/resources/templates/aeolus/assembler/default.sh +++ b/src/main/resources/templates/aeolus/assembler/default.sh @@ -8,15 +8,15 @@ provide_environment_information () { python3 --version pip3 --version echo "--------------------Contents of tests repository--------------------" - ls -la tests + ls -la ${testWorkingDirectory} echo "---------------------------------------------" echo "--------------------Contents of assignment repository--------------------" - ls -la assignment + ls -la ${studentParentWorkingDirectoryName} echo "---------------------------------------------" #Fallback in case Docker does not work as intended - REQ_FILE=tests/requirements.txt + REQ_FILE=${testWorkingDirectory}/requirements.txt if [ -f "$REQ_FILE" ]; then - pip3 install --user -r tests/requirements.txt + pip3 install --user -r ${testWorkingDirectory}/requirements.txt else echo "$REQ_FILE does not exist" fi @@ -25,18 +25,18 @@ provide_environment_information () { prepare_makefile () { echo '⚙️ executing prepare_makefile' #!/usr/bin/env bash - rm -f assignment/{GNUmakefile, Makefile, makefile} - rm -f assignment/io.inc - cp -f tests/Makefile assignment/Makefile || exit 2 - cp -f tests/io.inc assignment/io.inc || exit 2 + rm -f ${studentParentWorkingDirectoryName}/{GNUmakefile, Makefile, makefile} + rm -f ${studentParentWorkingDirectoryName}/io.inc + cp -f ${testWorkingDirectory}/Makefile ${studentParentWorkingDirectoryName}/Makefile || exit 2 + cp -f ${testWorkingDirectory}/io.inc ${studentParentWorkingDirectoryName}/io.inc || exit 2 } run_and_compile () { echo '⚙️ executing run_and_compile' - cd tests - python3 compileTest.py ../assignment/ + cd ${testWorkingDirectory} + python3 compileTest.py ../${studentParentWorkingDirectoryName}/ rm compileTest.py - cp result.xml ../assignment/result.xml + cp result.xml ../${studentParentWorkingDirectoryName}/result.xml } junit () { diff --git a/src/main/resources/templates/aeolus/assembler/default.yaml b/src/main/resources/templates/aeolus/assembler/default.yaml index 3017be0a331b..7649ec646a51 100644 --- a/src/main/resources/templates/aeolus/assembler/default.yaml +++ b/src/main/resources/templates/aeolus/assembler/default.yaml @@ -7,15 +7,15 @@ actions: python3 --version pip3 --version echo "--------------------Contents of tests repository--------------------" - ls -la tests + ls -la ${testWorkingDirectory} echo "---------------------------------------------" echo "--------------------Contents of assignment repository--------------------" - ls -la assignment + ls -la ${studentParentWorkingDirectoryName} echo "---------------------------------------------" #Fallback in case Docker does not work as intended - REQ_FILE=tests/requirements.txt + REQ_FILE=${testWorkingDirectory}/requirements.txt if [ -f "$REQ_FILE" ]; then - pip3 install --user -r tests/requirements.txt + pip3 install --user -r ${testWorkingDirectory}/requirements.txt else echo "$REQ_FILE does not exist" fi @@ -23,17 +23,17 @@ actions: - name: prepare_makefile script: |- #!/usr/bin/env bash - rm -f assignment/{GNUmakefile, Makefile, makefile} - rm -f assignment/io.inc - cp -f tests/Makefile assignment/Makefile || exit 2 - cp -f tests/io.inc assignment/io.inc || exit 2 + rm -f ${studentParentWorkingDirectoryName}/{GNUmakefile, Makefile, makefile} + rm -f ${studentParentWorkingDirectoryName}/io.inc + cp -f ${testWorkingDirectory}/Makefile ${studentParentWorkingDirectoryName}/Makefile || exit 2 + cp -f ${testWorkingDirectory}/io.inc ${studentParentWorkingDirectoryName}/io.inc || exit 2 runAlways: false - name: run_and_compile script: |- - cd tests - python3 compileTest.py ../assignment/ + cd ${testWorkingDirectory} + python3 compileTest.py ../${studentParentWorkingDirectoryName}/ rm compileTest.py - cp result.xml ../assignment/result.xml + cp result.xml ../${studentParentWorkingDirectoryName}/result.xml runAlways: false - name: junit script: |- @@ -41,6 +41,6 @@ actions: runAlways: true results: - name: junit_result.xml - path: assignment/result.xml + path: ${studentParentWorkingDirectoryName}/result.xml type: junit before: true diff --git a/src/main/resources/templates/aeolus/c/fact.sh b/src/main/resources/templates/aeolus/c/fact.sh index 3596904b322b..4f7252eefaba 100644 --- a/src/main/resources/templates/aeolus/c/fact.sh +++ b/src/main/resources/templates/aeolus/c/fact.sh @@ -8,8 +8,8 @@ setup_the_build_environment () { # Task Description: # Build and run all tests # ------------------------------ - # Updating assignment and test-reports ownership... - sudo chown artemis_user:artemis_user assignment/ -R || true + # Updating ${studentParentWorkingDirectoryName} and test-reports ownership... + sudo chown artemis_user:artemis_user ${studentParentWorkingDirectoryName}/ -R || true sudo mkdir test-reports sudo chown artemis_user:artemis_user test-reports/ -R || true } @@ -22,13 +22,13 @@ build_and_run_all_tests () { # Build and run all tests # ------------------------------ - rm -f assignment/GNUmakefile - rm -f assignment/Makefile - cp -f tests/Makefile assignment/Makefile || exit 2 - cd tests + rm -f ${studentParentWorkingDirectoryName}/GNUmakefile + rm -f ${studentParentWorkingDirectoryName}/Makefile + cp -f ${testWorkingDirectory}/Makefile ${studentParentWorkingDirectoryName}/Makefile || exit 2 + cd ${testWorkingDirectory} python3 Tests.py rm Tests.py - rm -rf ./tests || true + rm -rf ./${testWorkingDirectory} || true } main () { diff --git a/src/main/resources/templates/aeolus/c/fact.yaml b/src/main/resources/templates/aeolus/c/fact.yaml index 2cca1f9526b3..9d3527e65503 100644 --- a/src/main/resources/templates/aeolus/c/fact.yaml +++ b/src/main/resources/templates/aeolus/c/fact.yaml @@ -8,7 +8,7 @@ actions: # Build and run all tests # ------------------------------ # Updating assignment and test-reports ownership... - sudo chown artemis_user:artemis_user assignment/ -R || true + sudo chown artemis_user:artemis_user ${studentParentWorkingDirectoryName}/ -R || true sudo mkdir test-reports sudo chown artemis_user:artemis_user test-reports/ -R || true runAlways: false @@ -20,13 +20,13 @@ actions: # Build and run all tests # ------------------------------ - rm -f assignment/GNUmakefile - rm -f assignment/Makefile - cp -f tests/Makefile assignment/Makefile || exit 2 - cd tests + rm -f ${studentParentWorkingDirectoryName}/GNUmakefile + rm -f ${studentParentWorkingDirectoryName}/Makefile + cp -f ${testWorkingDirectory}/Makefile ${studentParentWorkingDirectoryName}/Makefile || exit 2 + cd ${testWorkingDirectory} python3 Tests.py rm Tests.py - rm -rf ./tests || true + rm -rf ./${testWorkingDirectory} || true runAlways: false results: - name: junit_test-reports/tests-results.xml diff --git a/src/main/resources/templates/aeolus/c/gcc.sh b/src/main/resources/templates/aeolus/c/gcc.sh index 259f0bd886e0..3272660657a1 100644 --- a/src/main/resources/templates/aeolus/c/gcc.sh +++ b/src/main/resources/templates/aeolus/c/gcc.sh @@ -10,13 +10,13 @@ setup_the_build_environment () { # Build and run all tests # ------------------------------ - # Updating assignment and test-reports ownership... - sudo chown artemis_user:artemis_user assignment/ -R + # Updating ${studentParentWorkingDirectoryName} and test-reports ownership... + sudo chown artemis_user:artemis_user ${studentParentWorkingDirectoryName}/ -R mkdir test-reports chown artemis_user:artemis_user test-reports/ -R # assignment - cd tests + cd ${testWorkingDirectory} REQ_FILE=requirements.txt if [ -f "$REQ_FILE" ]; then pip3 install --user -r requirements.txt || true @@ -35,18 +35,18 @@ setup_makefile () { # Setup makefile # ------------------------------ - shadowFilePath="../tests/testUtils/c/shadow_exec.c" + shadowFilePath="../${testWorkingDirectory}/testUtils/c/shadow_exec.c" - foundIncludeDirs=`grep -m 1 'INCLUDEDIRS\s*=' assignment/Makefile` + foundIncludeDirs=`grep -m 1 'INCLUDEDIRS\s*=' ${studentParentWorkingDirectoryName}/Makefile` - foundSource=`grep -m 1 'SOURCE\s*=' assignment/Makefile` + foundSource=`grep -m 1 'SOURCE\s*=' ${studentParentWorkingDirectoryName}/Makefile` foundSource="$foundSource $shadowFilePath" - rm -f assignment/GNUmakefile - rm -f assignment/makefile + rm -f ${studentParentWorkingDirectoryName}/GNUmakefile + rm -f ${studentParentWorkingDirectoryName}/makefile - cp -f tests/Makefile assignment/Makefile || exit 2 - sed -i "s~\bINCLUDEDIRS\s*=.*~${foundIncludeDirs}~; s~\bSOURCE\s*=.*~${foundSource}~" assignment/Makefile + cp -f ${testWorkingDirectory}/Makefile ${studentParentWorkingDirectoryName}/Makefile || exit 2 + sed -i "s~\bINCLUDEDIRS\s*=.*~${foundIncludeDirs}~; s~\bSOURCE\s*=.*~${foundSource}~" ${studentParentWorkingDirectoryName}/Makefile } build_and_run_all_tests () { @@ -58,10 +58,10 @@ build_and_run_all_tests () { # Build and run all tests if the compilation succeeds # ------------------------------ sudo chown artemis_user:artemis_user . - gcc -c -Wall assignment/*.c || error=true + gcc -c -Wall ${studentParentWorkingDirectoryName}/*.c || error=true if [ ! $error ] then - cd tests || exit 0 + cd ${testWorkingDirectory} || exit 0 python3 Tests.py || true fi } diff --git a/src/main/resources/templates/aeolus/c/gcc.yaml b/src/main/resources/templates/aeolus/c/gcc.yaml index 622b2148279d..29b2e2c635ec 100644 --- a/src/main/resources/templates/aeolus/c/gcc.yaml +++ b/src/main/resources/templates/aeolus/c/gcc.yaml @@ -10,12 +10,12 @@ actions: # ------------------------------ # Updating assignment and test-reports ownership... - sudo chown artemis_user:artemis_user assignment/ -R + sudo chown artemis_user:artemis_user ${studentParentWorkingDirectoryName}/ -R mkdir test-reports chown artemis_user:artemis_user test-reports/ -R # assignment - cd tests + cd ${testWorkingDirectory} REQ_FILE=requirements.txt if [ -f "$REQ_FILE" ]; then pip3 install --user -r requirements.txt || true @@ -33,18 +33,18 @@ actions: # Setup makefile # ------------------------------ - shadowFilePath="../tests/testUtils/c/shadow_exec.c" + shadowFilePath="../${testWorkingDirectory}/testUtils/c/shadow_exec.c" - foundIncludeDirs=`grep -m 1 'INCLUDEDIRS\s*=' assignment/Makefile` + foundIncludeDirs=`grep -m 1 'INCLUDEDIRS\s*=' ${studentParentWorkingDirectoryName}/Makefile` - foundSource=`grep -m 1 'SOURCE\s*=' assignment/Makefile` + foundSource=`grep -m 1 'SOURCE\s*=' ${studentParentWorkingDirectoryName}/Makefile` foundSource="$foundSource $shadowFilePath" - rm -f assignment/GNUmakefile - rm -f assignment/makefile + rm -f ${studentParentWorkingDirectoryName}/GNUmakefile + rm -f ${studentParentWorkingDirectoryName}/makefile - cp -f tests/Makefile assignment/Makefile || exit 2 - sed -i "s~\bINCLUDEDIRS\s*=.*~${foundIncludeDirs}~; s~\bSOURCE\s*=.*~${foundSource}~" assignment/Makefile + cp -f ${testWorkingDirectory}/Makefile ${studentParentWorkingDirectoryName}/Makefile || exit 2 + sed -i "s~\bINCLUDEDIRS\s*=.*~${foundIncludeDirs}~; s~\bSOURCE\s*=.*~${foundSource}~" ${studentParentWorkingDirectoryName}/Makefile runAlways: false - name: build_and_run_all_tests script: |- @@ -55,10 +55,10 @@ actions: # Build and run all tests if the compilation succeeds # ------------------------------ sudo chown artemis_user:artemis_user . - gcc -c -Wall assignment/*.c || error=true + gcc -c -Wall ${studentParentWorkingDirectoryName}/*.c || error=true if [ ! $error ] then - cd tests || exit 0 + cd ${testWorkingDirectory} || exit 0 python3 Tests.py || true fi runAlways: false diff --git a/src/main/resources/templates/aeolus/c/gcc_static.sh b/src/main/resources/templates/aeolus/c/gcc_static.sh index 96847a3bbc92..2dfa84c2a569 100644 --- a/src/main/resources/templates/aeolus/c/gcc_static.sh +++ b/src/main/resources/templates/aeolus/c/gcc_static.sh @@ -10,13 +10,13 @@ setup_the_build_environment () { # Build and run all tests # ------------------------------ - # Updating assignment and test-reports ownership... - sudo chown artemis_user:artemis_user assignment/ -R + # Updating ${studentParentWorkingDirectoryName} and test-reports ownership... + sudo chown artemis_user:artemis_user ${studentParentWorkingDirectoryName}/ -R mkdir test-reports chown artemis_user:artemis_user test-reports/ -R # assignment - cd tests + cd ${testWorkingDirectory} REQ_FILE=requirements.txt if [ -f "$REQ_FILE" ]; then pip3 install --user -r requirements.txt || true @@ -35,18 +35,18 @@ setup_makefile () { # Setup makefile # ------------------------------ - shadowFilePath="../tests/testUtils/c/shadow_exec.c" + shadowFilePath="../${testWorkingDirectory}/testUtils/c/shadow_exec.c" - foundIncludeDirs=`grep -m 1 'INCLUDEDIRS\s*=' assignment/Makefile` + foundIncludeDirs=`grep -m 1 'INCLUDEDIRS\s*=' ${studentParentWorkingDirectoryName}/Makefile` - foundSource=`grep -m 1 'SOURCE\s*=' assignment/Makefile` + foundSource=`grep -m 1 'SOURCE\s*=' ${studentParentWorkingDirectoryName}/Makefile` foundSource="$foundSource $shadowFilePath" - rm -f assignment/GNUmakefile - rm -f assignment/makefile + rm -f ${studentParentWorkingDirectoryName}/GNUmakefile + rm -f ${studentParentWorkingDirectoryName}/makefile - cp -f tests/Makefile assignment/Makefile || exit 2 - sed -i "s~\bINCLUDEDIRS\s*=.*~${foundIncludeDirs}~; s~\bSOURCE\s*=.*~${foundSource}~" assignment/Makefile + cp -f ${testWorkingDirectory}/Makefile ${studentParentWorkingDirectoryName}/Makefile || exit 2 + sed -i "s~\bINCLUDEDIRS\s*=.*~${foundIncludeDirs}~; s~\bSOURCE\s*=.*~${foundSource}~" ${studentParentWorkingDirectoryName}/Makefile } build_and_run_all_tests () { @@ -58,10 +58,10 @@ build_and_run_all_tests () { # Build and run all tests if the compilation succeeds # ------------------------------ sudo chown artemis_user:artemis_user . - gcc -c -Wall assignment/*.c || error=true + gcc -c -Wall ${studentParentWorkingDirectoryName}/*.c || error=true if [ ! $error ] then - cd tests || exit 0 + cd ${testWorkingDirectory} || exit 0 python3 Tests.py || true else exit 1 diff --git a/src/main/resources/templates/aeolus/c/gcc_static.yaml b/src/main/resources/templates/aeolus/c/gcc_static.yaml index be9e9eb1dc2f..21c0b506f179 100644 --- a/src/main/resources/templates/aeolus/c/gcc_static.yaml +++ b/src/main/resources/templates/aeolus/c/gcc_static.yaml @@ -10,12 +10,12 @@ actions: # ------------------------------ # Updating assignment and test-reports ownership... - sudo chown artemis_user:artemis_user assignment/ -R + sudo chown artemis_user:artemis_user ${studentParentWorkingDirectoryName}/ -R mkdir test-reports chown artemis_user:artemis_user test-reports/ -R # assignment - cd tests + cd ${testWorkingDirectory} REQ_FILE=requirements.txt if [ -f "$REQ_FILE" ]; then pip3 install --user -r requirements.txt || true @@ -33,18 +33,18 @@ actions: # Setup makefile # ------------------------------ - shadowFilePath="../tests/testUtils/c/shadow_exec.c" + shadowFilePath="../${testWorkingDirectory}/testUtils/c/shadow_exec.c" - foundIncludeDirs=`grep -m 1 'INCLUDEDIRS\s*=' assignment/Makefile` + foundIncludeDirs=`grep -m 1 'INCLUDEDIRS\s*=' ${studentParentWorkingDirectoryName}/Makefile` - foundSource=`grep -m 1 'SOURCE\s*=' assignment/Makefile` + foundSource=`grep -m 1 'SOURCE\s*=' ${studentParentWorkingDirectoryName}/Makefile` foundSource="$foundSource $shadowFilePath" - rm -f assignment/GNUmakefile - rm -f assignment/makefile + rm -f ${studentParentWorkingDirectoryName}/GNUmakefile + rm -f ${studentParentWorkingDirectoryName}/makefile - cp -f tests/Makefile assignment/Makefile || exit 2 - sed -i "s~\bINCLUDEDIRS\s*=.*~${foundIncludeDirs}~; s~\bSOURCE\s*=.*~${foundSource}~" assignment/Makefile + cp -f ${testWorkingDirectory}/Makefile ${studentParentWorkingDirectoryName}/Makefile || exit 2 + sed -i "s~\bINCLUDEDIRS\s*=.*~${foundIncludeDirs}~; s~\bSOURCE\s*=.*~${foundSource}~" ${studentParentWorkingDirectoryName}/Makefile runAlways: false - name: build_and_run_all_tests script: |- @@ -55,10 +55,10 @@ actions: # Build and run all tests if the compilation succeeds # ------------------------------ sudo chown artemis_user:artemis_user . - gcc -c -Wall assignment/*.c || error=true + gcc -c -Wall ${studentParentWorkingDirectoryName}/*.c || error=true if [ ! $error ] then - cd tests || exit 0 + cd ${testWorkingDirectory} || exit 0 python3 Tests.py || true else exit 1 diff --git a/src/main/resources/templates/aeolus/java/plain_maven_blackbox.sh b/src/main/resources/templates/aeolus/java/plain_maven_blackbox.sh index 46186cf50311..190bc88c4831 100644 --- a/src/main/resources/templates/aeolus/java/plain_maven_blackbox.sh +++ b/src/main/resources/templates/aeolus/java/plain_maven_blackbox.sh @@ -9,9 +9,9 @@ build () { checkers () { echo '⚙️ executing checkers' # all java files in the assignment folder should have maximal line length 80 - pipeline-helper line-length -l 80 -s assignment/ -e java + pipeline-helper line-length -l 80 -s ${studentParentWorkingDirectoryName}/ -e java # checks that the file exists and is not empty for non gui programs - pipeline-helper file-exists assignment/Tests.txt + pipeline-helper file-exists ${studentParentWorkingDirectoryName}/Tests.txt main_checker_output=$(pipeline-helper main-method -s target/classes) diff --git a/src/main/resources/templates/aeolus/java/plain_maven_blackbox.yaml b/src/main/resources/templates/aeolus/java/plain_maven_blackbox.yaml index 2b4428a585d1..02d0ff15b7ad 100644 --- a/src/main/resources/templates/aeolus/java/plain_maven_blackbox.yaml +++ b/src/main/resources/templates/aeolus/java/plain_maven_blackbox.yaml @@ -5,9 +5,9 @@ actions: - name: checkers script: |- # all java files in the assignment folder should have maximal line length 80 - pipeline-helper line-length -l 80 -s assignment/ -e java + pipeline-helper line-length -l 80 -s ${studentParentWorkingDirectoryName}/ -e java # checks that the file exists and is not empty for non gui programs - pipeline-helper file-exists assignment/Tests.txt + pipeline-helper file-exists ${studentParentWorkingDirectoryName}/Tests.txt main_checker_output=$(pipeline-helper main-method -s target/classes) diff --git a/src/main/resources/templates/aeolus/java/plain_maven_blackbox_static.sh b/src/main/resources/templates/aeolus/java/plain_maven_blackbox_static.sh index 9a6be87561a0..3a1af9d0d213 100644 --- a/src/main/resources/templates/aeolus/java/plain_maven_blackbox_static.sh +++ b/src/main/resources/templates/aeolus/java/plain_maven_blackbox_static.sh @@ -9,9 +9,9 @@ build () { checkers () { echo '⚙️ executing checkers' # all java files in the assignment folder should have maximal line length 80 - pipeline-helper line-length -l 80 -s assignment/ -e java + pipeline-helper line-length -l 80 -s ${studentParentWorkingDirectoryName}/ -e java # checks that the file exists and is not empty for non gui programs - pipeline-helper file-exists assignment/Tests.txt + pipeline-helper file-exists ${studentParentWorkingDirectoryName}/Tests.txt main_checker_output=$(pipeline-helper main-method -s target/classes) diff --git a/src/main/resources/templates/aeolus/java/plain_maven_blackbox_static.yaml b/src/main/resources/templates/aeolus/java/plain_maven_blackbox_static.yaml index 68c71c046d3d..7cd6a6c07773 100644 --- a/src/main/resources/templates/aeolus/java/plain_maven_blackbox_static.yaml +++ b/src/main/resources/templates/aeolus/java/plain_maven_blackbox_static.yaml @@ -5,9 +5,9 @@ actions: - name: checkers script: |- # all java files in the assignment folder should have maximal line length 80 - pipeline-helper line-length -l 80 -s assignment/ -e java + pipeline-helper line-length -l 80 -s ${studentParentWorkingDirectoryName}/ -e java # checks that the file exists and is not empty for non gui programs - pipeline-helper file-exists assignment/Tests.txt + pipeline-helper file-exists ${studentParentWorkingDirectoryName}/Tests.txt main_checker_output=$(pipeline-helper main-method -s target/classes) diff --git a/src/main/resources/templates/aeolus/ocaml/default.sh b/src/main/resources/templates/aeolus/ocaml/default.sh index ac1cf8b65b8d..f5b5f595b38d 100644 --- a/src/main/resources/templates/aeolus/ocaml/default.sh +++ b/src/main/resources/templates/aeolus/ocaml/default.sh @@ -3,7 +3,7 @@ set -e export AEOLUS_INITIAL_DIRECTORY=${PWD} build_and_test_the_code () { echo '⚙️ executing build_and_test_the_code' - cd "tests" + cd "${testWorkingDirectory}" # the build process is specified in `run.sh` in the test repository chmod +x run.sh ./run.sh -s diff --git a/src/main/resources/templates/aeolus/ocaml/default.yaml b/src/main/resources/templates/aeolus/ocaml/default.yaml index df5aef046d3a..70cdfcad1b9f 100644 --- a/src/main/resources/templates/aeolus/ocaml/default.yaml +++ b/src/main/resources/templates/aeolus/ocaml/default.yaml @@ -5,7 +5,7 @@ actions: # the build process is specified in `run.sh` in the test repository chmod +x run.sh ./run.sh -s - workdir: tests + workdir: ${testWorkingDirectory} runAlways: false - name: junit script: '#empty script action, just for the results' diff --git a/src/main/resources/templates/aeolus/swift/plain.sh b/src/main/resources/templates/aeolus/swift/plain.sh index 2673e861d564..71387b392783 100644 --- a/src/main/resources/templates/aeolus/swift/plain.sh +++ b/src/main/resources/templates/aeolus/swift/plain.sh @@ -4,12 +4,12 @@ set -e build_and_test_the_code () { echo '⚙️ executing build_and_test_the_code' # copy test files - cp -R Tests assignment - cp Package.swift assignment + cp -R Tests ${studentParentWorkingDirectoryName} + cp Package.swift ${studentParentWorkingDirectoryName} - # In order to get the correct console output we need to execute the command within the assignment directory + # In order to get the correct console output we need to execute the command within the ${studentParentWorkingDirectoryName} directory # swift build - cd assignment + cd ${studentParentWorkingDirectoryName} swift build || error=true if [ ! $error ] diff --git a/src/main/resources/templates/aeolus/swift/plain.yaml b/src/main/resources/templates/aeolus/swift/plain.yaml index c90994ea4c4a..48211dee715a 100644 --- a/src/main/resources/templates/aeolus/swift/plain.yaml +++ b/src/main/resources/templates/aeolus/swift/plain.yaml @@ -3,12 +3,12 @@ actions: - name: build_and_test_the_code script: |- # copy test files - cp -R Tests assignment - cp Package.swift assignment + cp -R Tests ${studentParentWorkingDirectoryName} + cp Package.swift ${studentParentWorkingDirectoryName} # In order to get the correct console output we need to execute the command within the assignment directory # swift build - cd assignment + cd ${studentParentWorkingDirectoryName} swift build || error=true if [ ! $error ] @@ -24,6 +24,6 @@ actions: runAlways: false results: - name: junit_tests.xml - path: assignment/tests.xml + path: ${studentParentWorkingDirectoryName}/tests.xml type: junit before: true diff --git a/src/main/resources/templates/aeolus/swift/plain_static.sh b/src/main/resources/templates/aeolus/swift/plain_static.sh index 835494ff5454..3bbaa9fe0662 100644 --- a/src/main/resources/templates/aeolus/swift/plain_static.sh +++ b/src/main/resources/templates/aeolus/swift/plain_static.sh @@ -3,14 +3,14 @@ set -e export AEOLUS_INITIAL_DIRECTORY=${PWD} build_and_test_the_code () { echo '⚙️ executing build_and_test_the_code' - cp -R Sources assignment + cp -R Sources ${studentParentWorkingDirectoryName} # copy test files - cp -R Tests assignment - cp Package.swift assignment + cp -R Tests ${studentParentWorkingDirectoryName} + cp Package.swift ${studentParentWorkingDirectoryName} - # In order to get the correct console output we need to execute the command within the assignment directory + # In order to get the correct console output we need to execute the command within the ${studentParentWorkingDirectoryName} directory # swift build - cd assignment + cd ${studentParentWorkingDirectoryName} swift build || error=true if [ ! $error ] @@ -28,10 +28,10 @@ build_and_test_the_code () { run_static_code_analysis () { echo '⚙️ executing run_static_code_analysis' # Copy SwiftLint rules - cp .swiftlint.yml assignment || true + cp .swiftlint.yml ${studentParentWorkingDirectoryName} || true # create target directory for SCA Parser mkdir target - cd assignment + cd ${studentParentWorkingDirectoryName} # Execute static code analysis swiftlint > ../target/swiftlint-result.xml } diff --git a/src/main/resources/templates/aeolus/swift/plain_static.yaml b/src/main/resources/templates/aeolus/swift/plain_static.yaml index c900edc82d44..72f683141903 100644 --- a/src/main/resources/templates/aeolus/swift/plain_static.yaml +++ b/src/main/resources/templates/aeolus/swift/plain_static.yaml @@ -2,14 +2,14 @@ api: v0.0.1 actions: - name: build_and_test_the_code script: |- - cp -R Sources assignment + cp -R Sources ${studentParentWorkingDirectoryName} # copy test files - cp -R Tests assignment - cp Package.swift assignment + cp -R Tests ${studentParentWorkingDirectoryName} + cp Package.swift ${studentParentWorkingDirectoryName} # In order to get the correct console output we need to execute the command within the assignment directory # swift build - cd assignment + cd ${studentParentWorkingDirectoryName} swift build || error=true if [ ! $error ] @@ -26,10 +26,10 @@ actions: - name: run_static_code_analysis script: |- # Copy SwiftLint rules - cp .swiftlint.yml assignment || true + cp .swiftlint.yml ${studentParentWorkingDirectoryName} || true # create target directory for SCA Parser mkdir target - cd assignment + cd ${studentParentWorkingDirectoryName} # Execute static code analysis swiftlint > ../target/swiftlint-result.xml runAlways: true @@ -39,6 +39,6 @@ actions: before: false type: static-code-analysis - name: junit_tests.xml - path: assignment/tests.xml + path: ${studentParentWorkingDirectoryName}/tests.xml type: junit before: true diff --git a/src/main/resources/templates/aeolus/vhdl/default.sh b/src/main/resources/templates/aeolus/vhdl/default.sh index f4f5a3f3f609..747c1b20c58f 100644 --- a/src/main/resources/templates/aeolus/vhdl/default.sh +++ b/src/main/resources/templates/aeolus/vhdl/default.sh @@ -9,16 +9,16 @@ provide_environment_information () { pip3 --version echo "--------------------Contents of tests repository--------------------" - ls -la tests + ls -la ${testWorkingDirectory} echo "---------------------------------------------" echo "--------------------Contents of assignment repository--------------------" - ls -la assignment + ls -la ${studentParentWorkingDirectoryName} echo "---------------------------------------------" #Fallback in case Docker does not work as intended - REQ_FILE=tests/requirements.txt + REQ_FILE=${testWorkingDirectory}/requirements.txt if [ -f "$REQ_FILE" ]; then - pip3 install --user -r tests/requirements.txt || true + pip3 install --user -r ${testWorkingDirectory}/requirements.txt || true else echo "$REQ_FILE does not exist" fi @@ -26,16 +26,16 @@ provide_environment_information () { prepare_makefile () { echo '⚙️ executing prepare_makefile' - rm -f assignment/{GNUmakefile, Makefile, makefile} - cp -f tests/Makefile assignment/Makefile || exit 2 + rm -f ${studentParentWorkingDirectoryName}/{GNUmakefile, Makefile, makefile} + cp -f ${testWorkingDirectory}/Makefile ${studentParentWorkingDirectoryName}/Makefile || exit 2 } run_and_compile () { echo '⚙️ executing run_and_compile' - cd "tests" - python3 compileTest.py ../assignment/ + cd "${testWorkingDirectory}" + python3 compileTest.py ../${studentParentWorkingDirectoryName}/ rm compileTest.py - cp result.xml ../assignment/result.xml + cp result.xml ../${studentParentWorkingDirectoryName}/result.xml } junit () { diff --git a/src/main/resources/templates/aeolus/vhdl/default.yaml b/src/main/resources/templates/aeolus/vhdl/default.yaml index 872f94622916..64bcb4365fc5 100644 --- a/src/main/resources/templates/aeolus/vhdl/default.yaml +++ b/src/main/resources/templates/aeolus/vhdl/default.yaml @@ -8,37 +8,37 @@ actions: pip3 --version echo "--------------------Contents of tests repository--------------------" - ls -la tests + ls -la ${testWorkingDirectory} echo "---------------------------------------------" echo "--------------------Contents of assignment repository--------------------" - ls -la assignment + ls -la ${studentParentWorkingDirectoryName} echo "---------------------------------------------" #Fallback in case Docker does not work as intended - REQ_FILE=tests/requirements.txt + REQ_FILE=${testWorkingDirectory}/requirements.txt if [ -f "$REQ_FILE" ]; then - pip3 install --user -r tests/requirements.txt || true + pip3 install --user -r ${testWorkingDirectory}/requirements.txt || true else echo "$REQ_FILE does not exist" fi runAlways: false - name: prepare_makefile script: |- - rm -f assignment/{GNUmakefile, Makefile, makefile} - cp -f tests/Makefile assignment/Makefile || exit 2 + rm -f ${studentParentWorkingDirectoryName}/{GNUmakefile, Makefile, makefile} + cp -f ${testWorkingDirectory}/Makefile ${studentParentWorkingDirectoryName}/Makefile || exit 2 runAlways: false - name: run_and_compile script: |- - python3 compileTest.py ../assignment/ + python3 compileTest.py ../${studentParentWorkingDirectoryName}/ rm compileTest.py - cp result.xml ../assignment/result.xml - workdir: tests + cp result.xml ../${studentParentWorkingDirectoryName}/result.xml + workdir: ${testWorkingDirectory} runAlways: false - name: junit script: '#empty script action, just for the results' runAlways: true results: - name: assignment_junit_results - path: assignment/result.xml + path: ${studentParentWorkingDirectoryName}/result.xml type: junit before: true diff --git a/src/main/resources/templates/haskell/test/.gitignore b/src/main/resources/templates/haskell/test/.gitignore index 38ce398dd22a..39312aeed502 100755 --- a/src/main/resources/templates/haskell/test/.gitignore +++ b/src/main/resources/templates/haskell/test/.gitignore @@ -3,10 +3,10 @@ test-reports/ # Subdirectories containing other repositories template/ -solution/ +${solutionWorkingDirectory}/ # Subdirectories with test submission -assignment/ +${studentParentWorkingDirectoryName}/ # Taken from https://github.com/github/gitignore diff --git a/src/main/resources/templates/haskell/test/readme.md b/src/main/resources/templates/haskell/test/readme.md index 7ab5dcefbf25..45ac2724c923 100644 --- a/src/main/resources/templates/haskell/test/readme.md +++ b/src/main/resources/templates/haskell/test/readme.md @@ -6,8 +6,8 @@ Tests are run using [stack](https://docs.haskellstack.org/en/stable/README/) in ## Setup -The executables specified in `test.cabal` expect the solution repository checked out in the `solution` subdirectory and -the submission checked out in the `assignment` subdirectory. +The executables specified in `test.cabal` expect the solution repository checked out in the `${solutionWorkingDirectory}` subdirectory and +the submission checked out in the `${studentParentWorkingDirectoryName}` subdirectory. Moreover, `test.cabal` provides an executable to test the template repository locally. For this, it expects the template repository in the `template` subdirectory. diff --git a/src/main/resources/templates/haskell/test/run.sh b/src/main/resources/templates/haskell/test/run.sh index 06169da575a2..562c1139cf0f 100755 --- a/src/main/resources/templates/haskell/test/run.sh +++ b/src/main/resources/templates/haskell/test/run.sh @@ -13,20 +13,20 @@ done shift $((OPTIND-1)) # check for symlinks as they might be abused to link to the sample solution -$safe && find assignment/ -type l | grep -q . && echo "Cannot build with symlinks in submission." && exit 1 +$safe && find ${studentParentWorkingDirectoryName}/ -type l | grep -q . && echo "Cannot build with symlinks in submission." && exit 1 # check for unsafe OPTIONS and OPTIONS_GHC pragma as they allow to overwrite command line arguments $safe && \ while IFS= read file; do cat $file | tr -d '\n' | grep -qim 1 "{-#[[:space:]]*options" && \ echo "Cannot build with \"{-# OPTIONS..\" pragma in source." && exit 1 -done < <(find assignment/src -type f) +done < <(find ${studentParentWorkingDirectoryName}/src -type f) # build the libraries - do not forget to set the right compilation flag (Prod) stack build --allow-different-user --flag test:Prod && \ # delete the solution and tests (so that students cannot access it) when in safe mode ($safe && \ - (rm -rf solution && rm -rf test) \ + (rm -rf ${solutionWorkingDirectory} && rm -rf test) \ ) \ # run the test executable and return 0 # Note: as a convention, a failed haskell tasty test suite returns 1, but this stops the JUnit Parser from running. diff --git a/src/main/resources/templates/haskell/test/test.cabal b/src/main/resources/templates/haskell/test/test.cabal index 7cf429c106e3..16977cf154b8 100644 --- a/src/main/resources/templates/haskell/test/test.cabal +++ b/src/main/resources/templates/haskell/test/test.cabal @@ -56,7 +56,7 @@ library submission -- by setting it to a non-existent program called `nonExistentCPP`. See -- https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/phases.html ghc-options: -fpackage-trust -trust base -pgmP nonExistentCPP - hs-source-dirs: assignment/src + hs-source-dirs: ${studentParentWorkingDirectoryName}/src exposed-modules: Exercise -- build the local template @@ -74,7 +74,7 @@ library template -- build the solution library solution import: common-all - hs-source-dirs: solution/src + hs-source-dirs: ${solutionWorkingDirectory}/src exposed-modules: Exercise -- run tests for a submission diff --git a/src/main/resources/templates/java/test/blackbox/projectTemplate/.gitignore b/src/main/resources/templates/java/test/blackbox/projectTemplate/.gitignore index 44c742ee253c..2bb4fca67c4f 100644 --- a/src/main/resources/templates/java/test/blackbox/projectTemplate/.gitignore +++ b/src/main/resources/templates/java/test/blackbox/projectTemplate/.gitignore @@ -1,4 +1,4 @@ -assignment/ +${studentParentWorkingDirectoryName}/ # Taken from https://github.com/github/gitignore diff --git a/src/main/resources/templates/java/test/gradle/projectTemplate/.gitignore b/src/main/resources/templates/java/test/gradle/projectTemplate/.gitignore index bde9056a0f14..964ec2319a13 100644 --- a/src/main/resources/templates/java/test/gradle/projectTemplate/.gitignore +++ b/src/main/resources/templates/java/test/gradle/projectTemplate/.gitignore @@ -1,5 +1,5 @@ .gradle -assignment/ +${studentParentWorkingDirectoryName}/ **/build/ !src/**/build/ target/ diff --git a/src/main/resources/templates/java/test/gradle/projectTemplate/build.gradle b/src/main/resources/templates/java/test/gradle/projectTemplate/build.gradle index c6d2e5f6689a..97be1ab67bfd 100644 --- a/src/main/resources/templates/java/test/gradle/projectTemplate/build.gradle +++ b/src/main/resources/templates/java/test/gradle/projectTemplate/build.gradle @@ -28,7 +28,7 @@ dependencies { // testImplementation(':${exerciseNamePomXml}-Solution') } -def assignmentSrcDir = "assignment/src" +def assignmentSrcDir = "${studentWorkingDirectoryNoSlash}" def studentOutputDir = sourceSets.main.java.destinationDirectory.get() // %static-code-analysis-start% def scaConfigDirectory = "$projectDir/staticCodeAnalysisConfig" diff --git a/src/main/resources/templates/java/test/maven/projectTemplate/.gitignore b/src/main/resources/templates/java/test/maven/projectTemplate/.gitignore index dd177405a0d3..dbf843d6c857 100644 --- a/src/main/resources/templates/java/test/maven/projectTemplate/.gitignore +++ b/src/main/resources/templates/java/test/maven/projectTemplate/.gitignore @@ -1,4 +1,4 @@ -assignment/ +${studentParentWorkingDirectoryName}/ target/ # Taken from https://github.com/github/gitignore diff --git a/src/main/resources/templates/java/test/stagePom.xml b/src/main/resources/templates/java/test/stagePom.xml index fea2492362ef..18cfa54fc39f 100644 --- a/src/main/resources/templates/java/test/stagePom.xml +++ b/src/main/resources/templates/java/test/stagePom.xml @@ -8,7 +8,7 @@ 4.0.0 ${exerciseNamePomXml}-Tests - ${project.basedir}/../assignment/src + ${project.basedir}/..${studentWorkingDirectory} org.apache.maven.plugins diff --git a/src/main/resources/templates/javascript/test/.gitignore b/src/main/resources/templates/javascript/test/.gitignore index d81d793eaed4..0d3cf4874427 100644 --- a/src/main/resources/templates/javascript/test/.gitignore +++ b/src/main/resources/templates/javascript/test/.gitignore @@ -1,4 +1,4 @@ node_modules/ -/assignment +/${studentParentWorkingDirectoryName} /junit.xml diff --git a/src/main/resources/templates/javascript/test/package-lock.json b/src/main/resources/templates/javascript/test/package-lock.json index b18c57c3b694..79830909997b 100644 --- a/src/main/resources/templates/javascript/test/package-lock.json +++ b/src/main/resources/templates/javascript/test/package-lock.json @@ -6,7 +6,7 @@ "": { "name": "artemis-test", "workspaces": [ - "assignment" + "${studentParentWorkingDirectoryName}" ], "devDependencies": { "@babel/core": "^7.24.7", @@ -17,7 +17,7 @@ "jest-junit": "^16.0.0" } }, - "assignment": { + "${studentParentWorkingDirectoryName}": { "name": "artemis-exercise" }, "node_modules/@ampproject/remapping": { @@ -2499,7 +2499,7 @@ } }, "node_modules/artemis-exercise": { - "resolved": "assignment", + "resolved": "${studentParentWorkingDirectoryName}", "link": true }, "node_modules/babel-jest": { diff --git a/src/main/resources/templates/javascript/test/package.json b/src/main/resources/templates/javascript/test/package.json index 3971d2b0f3c6..782e6c431492 100644 --- a/src/main/resources/templates/javascript/test/package.json +++ b/src/main/resources/templates/javascript/test/package.json @@ -6,7 +6,7 @@ "test:ci": "jest --ci --reporters=default --reporters=jest-junit" }, "workspaces": [ - "assignment" + "${studentParentWorkingDirectoryName}" ], "devDependencies": { "@babel/core": "^7.24.7", diff --git a/src/main/resources/templates/kotlin/test/maven/projectTemplate/.gitignore b/src/main/resources/templates/kotlin/test/maven/projectTemplate/.gitignore index bff99bd68dc5..5c7928c0bc37 100644 --- a/src/main/resources/templates/kotlin/test/maven/projectTemplate/.gitignore +++ b/src/main/resources/templates/kotlin/test/maven/projectTemplate/.gitignore @@ -1,4 +1,4 @@ -assignment/ +${studentParentWorkingDirectoryName}/ target/ # Taken from https://github.com/github/gitignore diff --git a/src/main/resources/templates/kotlin/test/stagePom.xml b/src/main/resources/templates/kotlin/test/stagePom.xml index 89bcbda7d484..d525536c92f6 100644 --- a/src/main/resources/templates/kotlin/test/stagePom.xml +++ b/src/main/resources/templates/kotlin/test/stagePom.xml @@ -8,7 +8,7 @@ 4.0.0 ${exerciseNamePomXml}-Tests - ${project.basedir}/../assignment/src + ${project.basedir}/..${studentWorkingDirectory} ${project.basedir}/test diff --git a/src/main/resources/templates/ocaml/test/.gitignore b/src/main/resources/templates/ocaml/test/.gitignore index e477e6e6a9b6..fdad97ced9bf 100644 --- a/src/main/resources/templates/ocaml/test/.gitignore +++ b/src/main/resources/templates/ocaml/test/.gitignore @@ -1,6 +1,6 @@ # Things generated by the test framework -/solution/*.ml -/assignment/*.ml +/${solutionWorkingDirectory}/*.ml +/${studentParentWorkingDirectoryName}/*.ml /test/runHidden.ml /checker/checker.exe diff --git a/src/main/resources/templates/ocaml/test/checker/checker.ml b/src/main/resources/templates/ocaml/test/checker/checker.ml index b13edbad4032..daa6d48b56fa 100644 --- a/src/main/resources/templates/ocaml/test/checker/checker.ml +++ b/src/main/resources/templates/ocaml/test/checker/checker.ml @@ -96,7 +96,7 @@ let checkFile fn = violation := true; Location.report_exception Format.err_formatter exn -let studentDir = "assignment" +let studentDir = "${studentParentWorkingDirectoryName}" (** check all student files for violations *) let _ = diff --git a/src/main/resources/templates/ocaml/test/run.sh b/src/main/resources/templates/ocaml/test/run.sh index fe73a2830c98..3dc4af3ff7cd 100755 --- a/src/main/resources/templates/ocaml/test/run.sh +++ b/src/main/resources/templates/ocaml/test/run.sh @@ -3,6 +3,7 @@ # copy code from the assignment or solution to the appropriate test folder cp_code() { + mv "$2" "$1" cd "$1" || exit rm ./*.ml >/dev/null 2>&1 # shellcheck disable=SC2086 @@ -44,13 +45,13 @@ else fi # check for symlink is the submission -find ../assignment/ -type l | grep -q . && echo "Cannot build with symlinks in submission." && exit 0 +find ../${studentParentWorkingDirectoryName}/ -type l | grep -q . && echo "Cannot build with symlinks in submission." && exit 0 # include solution and assignment in the tests # this will only pick up *.ml files in the /src folders if other files are required for the tests this needs to be adjusted -cp_code solution -echo 'include Assignment' > solution/solution.ml -cp_code assignment +cp_code ${solutionWorkingDirectory} solution +echo 'include Assignment' > ${solutionWorkingDirectory}/solution.ml +cp_code ${studentParentWorkingDirectoryName} assignment # select if tests are run by generated source code as student toplevel code may run before the tests and be able to spoof a runtime signal echo "let runHidden = $RUN_HIDDEN" > test/runHidden.ml @@ -71,7 +72,7 @@ if ! timeout -s SIGTERM $BUILD_TIMEOUT checker/checker.exe; then fi # build the student submission # don't reference the tests or solution, so that we can show the build output to the student and not leak test / solution code -if ! timeout -s SIGTERM $BUILD_TIMEOUT dune build --force assignment; then +if ! timeout -s SIGTERM $BUILD_TIMEOUT dune build --force ${solutionWorkingDirectory}; then echo "Unable to build submission, please ensure that your code builds and matches the provided interface" >&2 exit 0 fi @@ -85,13 +86,13 @@ fi cd "$BUILD_ROOT" || exit # copy the test executable into the project root -mv -f tests/test/test.exe ./ +mv -f ${testWorkingDirectory}/test/test.exe ./ # to then delete all source code, to prevent access to it while running the code if $SAFE; then - rm -rf assignment - rm -rf solution - rm -rf tests + rm -rf ${studentParentWorkingDirectoryName} + rm -rf ${solutionWorkingDirectory} + rm -rf ${testWorkingDirectory} fi; # running the test executable without arguments to cause them to exit without actually running any tests diff --git a/src/main/resources/templates/python/test/behavior/behavior_test.py b/src/main/resources/templates/python/test/behavior/behavior_test.py index 15ad384df904..31c0491b0a9c 100644 --- a/src/main/resources/templates/python/test/behavior/behavior_test.py +++ b/src/main/resources/templates/python/test/behavior/behavior_test.py @@ -1,7 +1,7 @@ import unittest -from assignment.sorting_algorithms import * -from assignment.context import Context -from assignment.policy import Policy +from ${studentParentWorkingDirectoryName}.sorting_algorithms import * +from ${studentParentWorkingDirectoryName}.context import Context +from ${studentParentWorkingDirectoryName}.policy import Policy class TestSortingBehavior(unittest.TestCase): diff --git a/src/main/resources/templates/python/test/structural/structural_test.py b/src/main/resources/templates/python/test/structural/structural_test.py index 24ed0f758476..96c30edd118e 100644 --- a/src/main/resources/templates/python/test/structural/structural_test.py +++ b/src/main/resources/templates/python/test/structural/structural_test.py @@ -1,8 +1,8 @@ import unittest -from assignment import sorting_algorithms -from assignment import sort_strategy -from assignment import context -from assignment import policy +from ${studentParentWorkingDirectoryName} import sorting_algorithms +from ${studentParentWorkingDirectoryName} import sort_strategy +from ${studentParentWorkingDirectoryName} import context +from ${studentParentWorkingDirectoryName} import policy from structural import structural_helpers diff --git a/src/main/resources/templates/rust/test/.gitignore b/src/main/resources/templates/rust/test/.gitignore index a37c5236a444..aecf1e1c91fa 100644 --- a/src/main/resources/templates/rust/test/.gitignore +++ b/src/main/resources/templates/rust/test/.gitignore @@ -1,2 +1,2 @@ /target -/assignment +/${studentParentWorkingDirectoryName} diff --git a/src/main/resources/templates/rust/test/Cargo.toml b/src/main/resources/templates/rust/test/Cargo.toml index 07f82b3f09f0..f7f39b905be0 100644 --- a/src/main/resources/templates/rust/test/Cargo.toml +++ b/src/main/resources/templates/rust/test/Cargo.toml @@ -5,7 +5,7 @@ edition = "2021" [dependencies] chrono = { version = "0.4.38", default-features = false } -rust-template-exercise = { path = "assignment" } +rust-template-exercise = { path = "${studentParentWorkingDirectoryName}" } syn = { version = "2.0.72", features = ["full"] } rust_template_test_macros = { path = "./rust_template_test_macros" } diff --git a/src/main/resources/templates/rust/test/build.rs b/src/main/resources/templates/rust/test/build.rs index 850fcb846cce..947f4783dbd7 100644 --- a/src/main/resources/templates/rust/test/build.rs +++ b/src/main/resources/templates/rust/test/build.rs @@ -6,7 +6,7 @@ use std::{fs, io}; use syn::{parse_file, FnArg, ImplItem, Item, TraitItem, Type, TypeParamBound}; -const SRC_DIR: &str = "assignment/src"; +const SRC_DIR: &str = "${studentWorkingDirectoryNoSlash}"; fn main() { println!("cargo::rerun-if-changed={SRC_DIR}"); diff --git a/src/main/resources/templates/rust/test/tests/structural.rs b/src/main/resources/templates/rust/test/tests/structural.rs index 70b0d19c9131..cf0bef375605 100644 --- a/src/main/resources/templates/rust/test/tests/structural.rs +++ b/src/main/resources/templates/rust/test/tests/structural.rs @@ -4,14 +4,14 @@ use structural_helpers::*; #[test] fn test_sort_strategy_trait() { - let ast = parse_file("./assignment/src/sort_strategy.rs"); + let ast = parse_file(".${studentWorkingDirectory}/sort_strategy.rs"); check_trait_names(&ast.items, ["SortStrategy"]) .unwrap_or_else(|name| panic!("A trait named \"{name}\" should be defined")); } #[test] fn test_sort_strategy_supertrait() { - let ast = parse_file("./assignment/src/sort_strategy.rs"); + let ast = parse_file(".${studentWorkingDirectory}/sort_strategy.rs"); let sort_strategy = find_trait(&ast.items, "SortStrategy") .expect("A trait named \"SortStrategy\" should be defined"); check_trait_supertrait(sort_strategy, "Any") @@ -20,7 +20,7 @@ fn test_sort_strategy_supertrait() { #[test] fn test_sort_strategy_methods() { - let ast = parse_file("./assignment/src/sort_strategy.rs"); + let ast = parse_file(".${studentWorkingDirectory}/sort_strategy.rs"); let sort_strategy = find_trait(&ast.items, "SortStrategy") .expect("A trait named \"SortStrategy\" should be defined"); check_trait_function_names(&sort_strategy.items, ["perform_sort"]) @@ -29,7 +29,7 @@ fn test_sort_strategy_methods() { #[test] fn test_context_fields() { - let ast = parse_file("./assignment/src/context.rs"); + let ast = parse_file(".${studentWorkingDirectory}/context.rs"); let context = find_struct(&ast.items, "Context").expect("A struct named \"Context\" should be defined"); check_struct_field_names(&context.fields, ["sort_algorithm"]) @@ -38,7 +38,7 @@ fn test_context_fields() { #[test] fn test_context_methods() { - let ast = parse_file("./assignment/src/context.rs"); + let ast = parse_file(".${studentWorkingDirectory}/context.rs"); let context_impl = find_impl(&ast.items, "Context").expect("SortStrategy should implement functions"); check_impl_function_names(&context_impl.items, ["new", "sort", "sort_algorithm"]) @@ -47,7 +47,7 @@ fn test_context_methods() { #[test] fn test_policy_fields() { - let ast = parse_file("./assignment/src/policy.rs"); + let ast = parse_file(".${studentWorkingDirectory}/policy.rs"); let policy = find_struct(&ast.items, "Policy").expect("A struct named \"Policy\" should be defined"); check_struct_field_names(&policy.fields, ["context"]) @@ -56,7 +56,7 @@ fn test_policy_fields() { #[test] fn test_policy_methods() { - let ast = parse_file("./assignment/src/policy.rs"); + let ast = parse_file(".${studentWorkingDirectory}/policy.rs"); let policy_impl = find_impl(&ast.items, "Policy").expect("Policy should implement functions"); check_impl_function_names(&policy_impl.items, ["new", "configure"]) .unwrap_or_else(|name| panic!("Policy should implement the function \"{name}\"")); @@ -64,7 +64,7 @@ fn test_policy_methods() { #[test] fn test_bubble_sort_struct() { - let ast = parse_file("./assignment/src/bubble_sort.rs"); + let ast = parse_file(".${studentWorkingDirectory}/bubble_sort.rs"); find_struct(&ast.items, "BubbleSort").expect("A struct named \"BubbleSort\" should be defined"); find_impl_for(&ast.items, "BubbleSort", "SortStrategy") .expect("BubbleSort should implement the trait \"SortStrategy\""); @@ -72,7 +72,7 @@ fn test_bubble_sort_struct() { #[test] fn test_merge_sort_struct() { - let ast = parse_file("./assignment/src/merge_sort.rs"); + let ast = parse_file("./${studentWorkingDirectory}/merge_sort.rs"); find_struct(&ast.items, "MergeSort").expect("A struct named \"MergeSort\" should be defined"); find_impl_for(&ast.items, "MergeSort", "SortStrategy") .expect("MergeSort should implement the trait \"SortStrategy\""); diff --git a/src/main/resources/templates/swift/Swift-Server-Setup.md b/src/main/resources/templates/swift/Swift-Server-Setup.md index 425f7244566c..58cc83d1a18b 100644 --- a/src/main/resources/templates/swift/Swift-Server-Setup.md +++ b/src/main/resources/templates/swift/Swift-Server-Setup.md @@ -55,7 +55,7 @@ Append following to ~/.bashrc: # Bamboo Build Plan ## Create Tasks Go to Plan Configuration > Default Job > Tasks -- Create default task to checkout repos "tests and assignment" +- Create default task to checkout repos "tests and ${studentParentWorkingDirectoryName}" - Create a task to build the swift project - Name the task `Build swift`. - Interpreter: `Shell` diff --git a/src/main/resources/templates/swift/xcode/test/${appName}Test.xcodeproj/xcshareddata/xcschemes/${appName}Test.xcscheme b/src/main/resources/templates/swift/xcode/test/${appName}Test.xcodeproj/xcshareddata/xcschemes/${appName}Test.xcscheme index fa4508ce15ce..1d83b9c00883 100644 --- a/src/main/resources/templates/swift/xcode/test/${appName}Test.xcodeproj/xcshareddata/xcschemes/${appName}Test.xcscheme +++ b/src/main/resources/templates/swift/xcode/test/${appName}Test.xcodeproj/xcshareddata/xcschemes/${appName}Test.xcscheme @@ -41,7 +41,7 @@ BlueprintIdentifier = "4F4474F426BD8F87004E6064" BuildableName = "${appName}.app" BlueprintName = "${appName}" - ReferencedContainer = "container:assignment/${appName}.xcodeproj"> + ReferencedContainer = "container:${studentParentWorkingDirectoryName}/${appName}.xcodeproj"> @@ -57,7 +57,7 @@ BlueprintIdentifier = "4F4474F426BD8F87004E6064" BuildableName = "${appName}.app" BlueprintName = "${appName}" - ReferencedContainer = "container:assignment/${appName}.xcodeproj"> + ReferencedContainer = "container:${studentParentWorkingDirectoryName}/${appName}.xcodeproj"> diff --git a/src/main/resources/templates/swift/xcode/test/${appName}Test.xcodeproj/xcshareddata/xcschemes/${appName}UITest.xcscheme b/src/main/resources/templates/swift/xcode/test/${appName}Test.xcodeproj/xcshareddata/xcschemes/${appName}UITest.xcscheme index 11353953efa7..86d626978f97 100644 --- a/src/main/resources/templates/swift/xcode/test/${appName}Test.xcodeproj/xcshareddata/xcschemes/${appName}UITest.xcscheme +++ b/src/main/resources/templates/swift/xcode/test/${appName}Test.xcodeproj/xcshareddata/xcschemes/${appName}UITest.xcscheme @@ -41,7 +41,7 @@ ${appName} BlueprintIdentifier = "4F4474F426BD8F87004E6064" BuildableName = "${appName}.app" BlueprintName = "${appName}" - ReferencedContainer = "container:assignment/${appName}.xcodeproj"> + ReferencedContainer = "container:${studentParentWorkingDirectoryName}/${appName}.xcodeproj"> @@ -57,7 +57,7 @@ ${appName} BlueprintIdentifier = "4F4474F426BD8F87004E6064" BuildableName = "${appName}.app" BlueprintName = "${appName}" - ReferencedContainer = "container:assignment/${appName}.xcodeproj"> + ReferencedContainer = "container:${studentParentWorkingDirectoryName}/${appName}.xcodeproj"> diff --git a/src/main/resources/templates/swift/xcode/test/${appName}Test.xcworkspace/contents.xcworkspacedata b/src/main/resources/templates/swift/xcode/test/${appName}Test.xcworkspace/contents.xcworkspacedata index 70fc7ea09f74..bcc06bae07c6 100644 --- a/src/main/resources/templates/swift/xcode/test/${appName}Test.xcworkspace/contents.xcworkspacedata +++ b/src/main/resources/templates/swift/xcode/test/${appName}Test.xcworkspace/contents.xcworkspacedata @@ -5,6 +5,6 @@ location = "group:${appName}Test.xcodeproj"> + location = "group:${studentParentWorkingDirectoryName}/${appName}.xcodeproj"> - \ No newline at end of file + diff --git a/src/main/resources/templates/swift/xcode/test/.swiftlint.yml b/src/main/resources/templates/swift/xcode/test/.swiftlint.yml index 5c35904fd2e7..39604f106d66 100644 --- a/src/main/resources/templates/swift/xcode/test/.swiftlint.yml +++ b/src/main/resources/templates/swift/xcode/test/.swiftlint.yml @@ -292,7 +292,7 @@ only_rules: # An XCTFail call should include a description of the assertion. included: # paths to include during linting. `--path` is ignored if present. - - assignment + - ${studentParentWorkingDirectoryName} excluded: # paths to ignore during linting. Takes precedence over `included`. - Carthage diff --git a/src/main/resources/templates/swift/xcode/test/README.md b/src/main/resources/templates/swift/xcode/test/README.md index 61991fee8ef8..d0093037df8c 100644 --- a/src/main/resources/templates/swift/xcode/test/README.md +++ b/src/main/resources/templates/swift/xcode/test/README.md @@ -1,7 +1,7 @@ This is the combined repo that will be produced on the build agent by cloning two repos -1) exercise --> everything in the assignment folder -2) tests --> everything except the assignment folder +1) exercise --> everything in the ${studentParentWorkingDirectoryName} folder +2) tests --> everything except the ${studentParentWorkingDirectoryName} folder The tests can be executed as follows diff --git a/src/main/webapp/app/entities/programming/programming-exercise-build.config.ts b/src/main/webapp/app/entities/programming/programming-exercise-build.config.ts index eaa526406e08..55e5f5f487e2 100644 --- a/src/main/webapp/app/entities/programming/programming-exercise-build.config.ts +++ b/src/main/webapp/app/entities/programming/programming-exercise-build.config.ts @@ -5,7 +5,9 @@ export class ProgrammingExerciseBuildConfig { public buildPlanConfiguration?: string; public buildScript?: string; public checkoutSolutionRepository?: boolean; - public checkoutPath?: string; + public assignmentCheckoutPath?: string; + public testCheckoutPath?: string; + public solutionCheckoutPath?: string; public timeoutSeconds?: number; public dockerFlags?: string; public windfile?: WindFile; diff --git a/src/main/webapp/app/entities/programming/programming-exercise.model.ts b/src/main/webapp/app/entities/programming/programming-exercise.model.ts index 17d04e971160..8dde59469c03 100644 --- a/src/main/webapp/app/entities/programming/programming-exercise.model.ts +++ b/src/main/webapp/app/entities/programming/programming-exercise.model.ts @@ -114,7 +114,9 @@ export function resetProgrammingForImport(exercise: ProgrammingExercise) { export function copyBuildConfigFromExerciseJson(exerciseJson: ProgrammingExerciseBuildConfig): ProgrammingExerciseBuildConfig { const buildConfig = new ProgrammingExerciseBuildConfig(); buildConfig.sequentialTestRuns = exerciseJson.sequentialTestRuns ?? false; - buildConfig.checkoutPath = exerciseJson.checkoutPath ?? ''; + buildConfig.assignmentCheckoutPath = exerciseJson.assignmentCheckoutPath ?? ''; + buildConfig.solutionCheckoutPath = exerciseJson.solutionCheckoutPath ?? ''; + buildConfig.testCheckoutPath = exerciseJson.testCheckoutPath ?? ''; buildConfig.buildPlanConfiguration = exerciseJson.buildPlanConfiguration ?? ''; buildConfig.checkoutSolutionRepository = exerciseJson.checkoutSolutionRepository ?? false; buildConfig.timeoutSeconds = exerciseJson.timeoutSeconds ?? 0; diff --git a/src/main/webapp/app/exercises/programming/manage/update/programming-exercise-update.component.ts b/src/main/webapp/app/exercises/programming/manage/update/programming-exercise-update.component.ts index aff229febc88..8b1a5ef9529a 100644 --- a/src/main/webapp/app/exercises/programming/manage/update/programming-exercise-update.component.ts +++ b/src/main/webapp/app/exercises/programming/manage/update/programming-exercise-update.component.ts @@ -411,6 +411,7 @@ export class ProgrammingExerciseUpdateComponent implements AfterViewInit, OnDest tap((segments) => { this.isImportFromExistingExercise = segments.some((segment) => segment.path === 'import'); this.isImportFromFile = segments.some((segment) => segment.path === 'import-from-file'); + this.isEdit = segments.some((segment) => segment.path === 'edit'); }), switchMap(() => this.activatedRoute.params), tap((params) => { @@ -627,6 +628,11 @@ export class ProgrammingExerciseUpdateComponent implements AfterViewInit, OnDest this.programmingExercise.buildConfig!.buildPlanConfiguration = undefined; this.programmingExercise.buildConfig!.windfile = undefined; } + + if (this.programmingExercise.buildConfig?.timeoutSeconds && this.programmingExercise.buildConfig?.timeoutSeconds < 1) { + this.programmingExercise.buildConfig!.timeoutSeconds = 0; + } + // If the programming exercise has a submission policy with a NONE type, the policy is removed altogether if (this.programmingExercise.submissionPolicy && this.programmingExercise.submissionPolicy.type === SubmissionPolicyType.NONE) { this.programmingExercise.submissionPolicy = undefined; @@ -870,6 +876,8 @@ export class ProgrammingExerciseUpdateComponent implements AfterViewInit, OnDest this.validateExerciseBonusPoints(validationErrorReasons); this.validateExerciseSCAMaxPenalty(validationErrorReasons); this.validateExerciseSubmissionLimit(validationErrorReasons); + this.validateTimeout(validationErrorReasons); + this.validateCheckoutPaths(validationErrorReasons); return validationErrorReasons; } @@ -1081,6 +1089,39 @@ export class ProgrammingExerciseUpdateComponent implements AfterViewInit, OnDest } } + private validateTimeout(validationErrorReasons: ValidationReason[]): void { + if (this.programmingExercise.buildConfig?.timeoutSeconds && this.programmingExercise.buildConfig.timeoutSeconds < 0) { + validationErrorReasons.push({ + translateKey: 'artemisApp.programmingExercise.timeout.alert', + translateValues: {}, + }); + } + } + + private validateCheckoutPaths(validationErrorReasons: ValidationReason[]): void { + const checkoutPaths = [ + this.programmingExercise.buildConfig?.assignmentCheckoutPath, + this.programmingExercise.buildConfig?.solutionCheckoutPath, + this.programmingExercise.buildConfig?.testCheckoutPath, + ]; + if (!this.areValuesUnique(checkoutPaths) || !this.testCheckoutPathsPattern(checkoutPaths)) { + validationErrorReasons.push({ + translateKey: 'artemisApp.programmingExercise.checkoutPath.invalid', + translateValues: {}, + }); + } + } + + private areValuesUnique(values: (string | undefined)[]): boolean { + const filteredValues = values.filter((value): value is string => value !== undefined && value !== ''); + const uniqueValues = new Set(filteredValues); + return filteredValues.length === uniqueValues.size; + } + + private testCheckoutPathsPattern(checkoutPath: (string | undefined)[]): boolean { + return checkoutPath.every((path) => path === undefined || path.trim() === '' || this.invalidDirectoryNamePattern.test(path)); + } + private createProgrammingExerciseForImportFromFile() { this.programmingExercise = cloneDeep(history.state.programmingExerciseForImportFromFile); this.programmingExercise.id = undefined; diff --git a/src/main/webapp/app/exercises/programming/manage/update/programming-exercise-update.module.ts b/src/main/webapp/app/exercises/programming/manage/update/programming-exercise-update.module.ts index 0a2fa9061344..5185968f143f 100644 --- a/src/main/webapp/app/exercises/programming/manage/update/programming-exercise-update.module.ts +++ b/src/main/webapp/app/exercises/programming/manage/update/programming-exercise-update.module.ts @@ -27,12 +27,13 @@ import { ExerciseUpdateNotificationModule } from 'app/exercises/shared/exercise- import { ExerciseUpdatePlagiarismModule } from 'app/exercises/shared/plagiarism/exercise-update-plagiarism/exercise-update-plagiarism.module'; import { ProgrammingExerciseCustomAeolusBuildPlanComponent } from 'app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-aeolus-build-plan.component'; import { ProgrammingExerciseCustomBuildPlanComponent } from 'app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-build-plan.component'; -import { ProgrammingExerciseDockerImageComponent } from 'app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-docker-image/programming-exercise-docker-image.component'; +import { ProgrammingExerciseBuildConfigurationComponent } from 'app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-build-configuration/programming-exercise-build-configuration.component'; import { FormsModule } from 'app/forms/forms.module'; import { ProgrammingExerciseBuildPlanCheckoutDirectoriesComponent } from 'app/exercises/programming/shared/build-details/programming-exercise-build-plan-checkout-directories.component'; import { ProgrammingExerciseRepositoryAndBuildPlanDetailsComponent } from 'app/exercises/programming/shared/build-details/programming-exercise-repository-and-build-plan-details.component'; import { ProgrammingExerciseTheiaComponent } from 'app/exercises/programming/manage/update/update-components/theia/programming-exercise-theia.component'; import { MonacoEditorComponent } from 'app/shared/monaco-editor/monaco-editor.component'; +import { ProgrammingExerciseEditCheckoutDirectoriesComponent } from 'app/exercises/programming/shared/build-details/programming-exercise-edit-checkout-directories/programming-exercise-edit-checkout-directories.component'; @NgModule({ imports: [ @@ -59,6 +60,7 @@ import { MonacoEditorComponent } from 'app/shared/monaco-editor/monaco-editor.co ProgrammingExerciseRepositoryAndBuildPlanDetailsComponent, MonacoEditorComponent, ProgrammingExerciseTheiaComponent, + ProgrammingExerciseEditCheckoutDirectoriesComponent, ], declarations: [ ProgrammingExerciseUpdateComponent, @@ -66,7 +68,7 @@ import { MonacoEditorComponent } from 'app/shared/monaco-editor/monaco-editor.co ProgrammingExerciseDifficultyComponent, ProgrammingExerciseCustomAeolusBuildPlanComponent, ProgrammingExerciseCustomBuildPlanComponent, - ProgrammingExerciseDockerImageComponent, + ProgrammingExerciseBuildConfigurationComponent, ProgrammingExerciseLanguageComponent, ProgrammingExerciseGradingComponent, ProgrammingExerciseProblemComponent, diff --git a/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-build-configuration/programming-exercise-build-configuration.component.html b/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-build-configuration/programming-exercise-build-configuration.component.html new file mode 100644 index 000000000000..6360bb509017 --- /dev/null +++ b/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-build-configuration/programming-exercise-build-configuration.component.html @@ -0,0 +1,45 @@ +
+
+ + + +
+ @if (!isAeolus()) { +
+
+ + +
+
+ +
+ + {{ timeout() }} s + +
+ } +
diff --git a/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-build-configuration/programming-exercise-build-configuration.component.ts b/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-build-configuration/programming-exercise-build-configuration.component.ts new file mode 100644 index 000000000000..a506333c9d87 --- /dev/null +++ b/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-build-configuration/programming-exercise-build-configuration.component.ts @@ -0,0 +1,21 @@ +import { Component, input, output, viewChild } from '@angular/core'; +import { NgModel } from '@angular/forms'; + +@Component({ + selector: 'jhi-programming-exercise-build-configuration', + templateUrl: './programming-exercise-build-configuration.component.html', + styleUrls: ['../../../../programming-exercise-form.scss'], +}) +export class ProgrammingExerciseBuildConfigurationComponent { + dockerImage = input.required(); + dockerImageChange = output(); + + timeout = input(); + timeoutChange = output(); + + isAeolus = input.required(); + + dockerImageField = viewChild('dockerImageField'); + + timeoutField = viewChild('timeoutField'); +} diff --git a/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-aeolus-build-plan.component.html b/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-aeolus-build-plan.component.html index bcfd1a078ac7..a3d6f1b70d30 100644 --- a/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-aeolus-build-plan.component.html +++ b/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-aeolus-build-plan.component.html @@ -7,9 +7,10 @@ @if (programmingExercise.customizeBuildPlanWithAeolus) {
@if (programmingExercise.buildConfig?.windfile && programmingExercise.buildConfig?.windfile?.metadata && programmingExercise.buildConfig?.windfile?.metadata?.docker) { - }
diff --git a/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-aeolus-build-plan.component.ts b/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-aeolus-build-plan.component.ts index e350d8c201b9..ab406d7e0193 100644 --- a/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-aeolus-build-plan.component.ts +++ b/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-aeolus-build-plan.component.ts @@ -4,7 +4,7 @@ import { ProgrammingExercise, ProgrammingLanguage, ProjectType } from 'app/entit import { faQuestionCircle } from '@fortawesome/free-solid-svg-icons'; import { ProgrammingExerciseCreationConfig } from 'app/exercises/programming/manage/update/programming-exercise-creation-config'; import { AeolusService } from 'app/exercises/programming/shared/service/aeolus.service'; -import { ProgrammingExerciseDockerImageComponent } from 'app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-docker-image/programming-exercise-docker-image.component'; +import { ProgrammingExerciseBuildConfigurationComponent } from 'app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-build-configuration/programming-exercise-build-configuration.component'; import { MonacoEditorComponent } from 'app/shared/monaco-editor/monaco-editor.component'; @Component({ @@ -16,7 +16,7 @@ export class ProgrammingExerciseCustomAeolusBuildPlanComponent implements OnChan @Input() programmingExercise: ProgrammingExercise; @Input() programmingExerciseCreationConfig: ProgrammingExerciseCreationConfig; - @ViewChild(ProgrammingExerciseDockerImageComponent) programmingExerciseDockerImageComponent?: ProgrammingExerciseDockerImageComponent; + @ViewChild(ProgrammingExerciseBuildConfigurationComponent) programmingExerciseDockerImageComponent?: ProgrammingExerciseBuildConfigurationComponent; programmingLanguage?: ProgrammingLanguage; projectType?: ProjectType; diff --git a/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-build-plan.component.html b/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-build-plan.component.html index 0c0e2c702af7..2993020efa28 100644 --- a/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-build-plan.component.html +++ b/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-build-plan.component.html @@ -7,9 +7,12 @@ @if (programmingExercise.customizeBuildPlanWithAeolus) {
@if (programmingExercise.buildConfig?.windfile && programmingExercise.buildConfig?.windfile?.metadata && programmingExercise.buildConfig?.windfile?.metadata?.docker) { - } diff --git a/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-build-plan.component.ts b/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-build-plan.component.ts index 437c22fc0f40..63b22457fe92 100644 --- a/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-build-plan.component.ts +++ b/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-custom-build-plan.component.ts @@ -3,8 +3,9 @@ import { ProgrammingExercise, ProgrammingLanguage, ProjectType } from 'app/entit import { faQuestionCircle } from '@fortawesome/free-solid-svg-icons'; import { ProgrammingExerciseCreationConfig } from 'app/exercises/programming/manage/update/programming-exercise-creation-config'; import { AeolusService } from 'app/exercises/programming/shared/service/aeolus.service'; -import { ProgrammingExerciseDockerImageComponent } from 'app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-docker-image/programming-exercise-docker-image.component'; +import { ProgrammingExerciseBuildConfigurationComponent } from 'app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-build-configuration/programming-exercise-build-configuration.component'; import { MonacoEditorComponent } from 'app/shared/monaco-editor/monaco-editor.component'; +import { ASSIGNMENT_REPO_NAME, TEST_REPO_NAME } from 'app/shared/constants/input.constants'; @Component({ selector: 'jhi-programming-exercise-custom-build-plan', @@ -15,7 +16,7 @@ export class ProgrammingExerciseCustomBuildPlanComponent implements OnChanges { @Input() programmingExercise: ProgrammingExercise; @Input() programmingExerciseCreationConfig: ProgrammingExerciseCreationConfig; - @ViewChild(ProgrammingExerciseDockerImageComponent) programmingExerciseDockerImageComponent?: ProgrammingExerciseDockerImageComponent; + @ViewChild(ProgrammingExerciseBuildConfigurationComponent) programmingExerciseDockerImageComponent?: ProgrammingExerciseBuildConfigurationComponent; programmingLanguage?: ProgrammingLanguage; projectType?: ProjectType; @@ -60,6 +61,15 @@ export class ProgrammingExerciseCustomBuildPlanComponent implements OnChanges { ); } + shouldReplacePlaceholders(): boolean { + return ( + (!!this.programmingExercise.buildConfig?.assignmentCheckoutPath && this.programmingExercise.buildConfig?.assignmentCheckoutPath.trim() !== '') || + (!!this.programmingExercise.buildConfig?.testCheckoutPath && this.programmingExercise.buildConfig?.testCheckoutPath.trim() !== '') || + !!this.programmingExercise.buildConfig?.buildScript?.includes('${studentParentWorkingDirectoryName}') || + !!this.programmingExercise.buildConfig?.buildScript?.includes('${testWorkingDirectory}') + ); + } + /** * In case the programming language or project type changes, we need to reset the template and the build plan * @private @@ -107,6 +117,7 @@ export class ProgrammingExerciseCustomBuildPlanComponent implements OnChanges { .getAeolusTemplateScript(this.programmingLanguage, this.projectType, this.staticCodeAnalysisEnabled, this.sequentialTestRuns, this.testwiseCoverageEnabled) .subscribe({ next: (file: string) => { + file = this.replacePlaceholders(file); this.codeChanged(file); this.editor?.setText(file); }, @@ -118,6 +129,9 @@ export class ProgrammingExerciseCustomBuildPlanComponent implements OnChanges { if (!this.programmingExercise.buildConfig?.buildScript) { this.resetCustomBuildPlan(); } + if (!this.programmingExercise.buildConfig?.timeoutSeconds) { + this.programmingExercise.buildConfig!.timeoutSeconds = 0; + } } get editor(): MonacoEditorComponent | undefined { @@ -128,6 +142,7 @@ export class ProgrammingExerciseCustomBuildPlanComponent implements OnChanges { codeChanged(code: string): void { this.code = code; + this.editor?.setText(code); this.programmingExercise.buildConfig!.buildScript = code; } @@ -147,4 +162,16 @@ export class ProgrammingExerciseCustomBuildPlanComponent implements OnChanges { } this.programmingExercise.buildConfig!.windfile.metadata.docker.image = dockerImage.trim(); } + + setTimeout(timeout: number) { + this.programmingExercise.buildConfig!.timeoutSeconds = timeout; + } + + replacePlaceholders(buildScript: string): string { + const assignmentRepoName = this.programmingExercise.buildConfig?.assignmentCheckoutPath || ASSIGNMENT_REPO_NAME; + const testRepoName = this.programmingExercise.buildConfig?.testCheckoutPath || TEST_REPO_NAME; + buildScript = buildScript.replaceAll('${studentParentWorkingDirectoryName}', assignmentRepoName); + buildScript = buildScript.replaceAll('${testWorkingDirectory}', testRepoName); + return buildScript; + } } diff --git a/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-docker-image/programming-exercise-docker-image.component.html b/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-docker-image/programming-exercise-docker-image.component.html deleted file mode 100644 index 914f14e4caf5..000000000000 --- a/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-docker-image/programming-exercise-docker-image.component.html +++ /dev/null @@ -1,16 +0,0 @@ -
- - - -
diff --git a/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-docker-image/programming-exercise-docker-image.component.ts b/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-docker-image/programming-exercise-docker-image.component.ts deleted file mode 100644 index 85d5f5f8d6fd..000000000000 --- a/src/main/webapp/app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-docker-image/programming-exercise-docker-image.component.ts +++ /dev/null @@ -1,14 +0,0 @@ -import { Component, EventEmitter, Input, Output, ViewChild } from '@angular/core'; -import { NgModel } from '@angular/forms'; - -@Component({ - selector: 'jhi-programming-exercise-docker-image', - templateUrl: './programming-exercise-docker-image.component.html', - styleUrls: ['../../../../programming-exercise-form.scss'], -}) -export class ProgrammingExerciseDockerImageComponent { - @Input() dockerImage: string; - @Output() dockerImageChange = new EventEmitter(); - - @ViewChild('dockerImageField') dockerImageField?: NgModel; -} diff --git a/src/main/webapp/app/exercises/programming/manage/update/update-components/programming-exercise-information.component.html b/src/main/webapp/app/exercises/programming/manage/update/update-components/programming-exercise-information.component.html index 78be8ae11ee0..acdc4cf0b5e0 100644 --- a/src/main/webapp/app/exercises/programming/manage/update/update-components/programming-exercise-information.component.html +++ b/src/main/webapp/app/exercises/programming/manage/update/update-components/programming-exercise-information.component.html @@ -56,7 +56,21 @@ [programmingLanguage]="programmingExerciseCreationConfig.selectedProgrammingLanguage" [isLocal]="isLocal" [checkoutSolutionRepository]="programmingExercise.buildConfig?.checkoutSolutionRepository" + (submissionBuildPlanEvent)="updateSubmissionBuildPlanCheckoutDirectories($event)" + [isCreateOrEdit]="true" + [isEditMode]="programmingExerciseCreationConfig.isEdit" + [programmingExerciseBuildConfig]="programmingExercise.buildConfig" /> + @if (editRepositoryCheckoutPath && isLocal && !isImport && !programmingExerciseCreationConfig.isEdit) { + + } @if (!programmingExerciseCreationConfig.isImportFromExistingExercise && programmingExerciseCreationConfig.auxiliaryRepositoriesSupported) {
@if (programmingExercise.auxiliaryRepositories && programmingExercise.auxiliaryRepositories.length > 0) { @@ -127,6 +141,15 @@ } + @if (isLocal && !isImport && !programmingExerciseCreationConfig.isEdit) { + + } (); @@ -35,12 +40,20 @@ export class ProgrammingExerciseInformationComponent implements AfterViewInit, O protected readonly ProjectType = ProjectType; + ButtonType = ButtonType; + ButtonSize = ButtonSize; + faPlus = faPlus; + + editRepositoryCheckoutPath: boolean = false; + submissionBuildPlanCheckoutRepositories: BuildPlanCheckoutDirectoriesDTO; + ngAfterViewInit() { this.inputFieldSubscriptions.push(this.exerciseTitleChannelComponent.titleChannelNameComponent?.formValidChanges.subscribe(() => this.calculateFormValid())); this.inputFieldSubscriptions.push(this.shortNameField.valueChanges?.subscribe(() => this.calculateFormValid())); this.inputFieldSubscriptions.push(this.checkoutSolutionRepositoryField?.valueChanges?.subscribe(() => this.calculateFormValid())); this.inputFieldSubscriptions.push(this.recreateBuildPlansField?.valueChanges?.subscribe(() => this.calculateFormValid())); this.inputFieldSubscriptions.push(this.updateTemplateFilesField?.valueChanges?.subscribe(() => this.calculateFormValid())); + this.inputFieldSubscriptions.push(this.programmingExerciseEditCheckoutDirectories?.formValidChanges.subscribe(() => this.calculateFormValid())); this.tableEditableFields?.changes.subscribe((fields: QueryList) => { fields.toArray().forEach((field) => this.inputFieldSubscriptions.push(field.editingInput.valueChanges?.subscribe(() => this.calculateFormValid()))); }); @@ -57,13 +70,15 @@ export class ProgrammingExerciseInformationComponent implements AfterViewInit, O const isRecreateBuildPlansValid = this.isRecreateBuildPlansValid(); const isUpdateTemplateFilesValid = this.isUpdateTemplateFilesValid(); const areAuxiliaryRepositoriesValid = this.areAuxiliaryRepositoriesValid(); + const areCheckoutPathsValid = this.areCheckoutPathsValid(); this.formValid = Boolean( this.exerciseTitleChannelComponent.titleChannelNameComponent?.formValid && !this.shortNameField.invalid && isCheckoutSolutionRepositoryValid && isRecreateBuildPlansValid && isUpdateTemplateFilesValid && - areAuxiliaryRepositoriesValid, + areAuxiliaryRepositoriesValid && + areCheckoutPathsValid, ); this.formValidChanges.next(this.formValid); } @@ -101,4 +116,42 @@ export class ProgrammingExerciseInformationComponent implements AfterViewInit, O !this.programmingExerciseCreationConfig.checkoutSolutionRepositoryAllowed, ); } + + areCheckoutPathsValid(): boolean { + return Boolean( + !this.programmingExerciseEditCheckoutDirectories || + (this.programmingExerciseEditCheckoutDirectories.formValid && + this.programmingExerciseEditCheckoutDirectories.areValuesUnique([ + this.programmingExercise.buildConfig?.assignmentCheckoutPath, + this.programmingExercise.buildConfig?.testCheckoutPath, + this.programmingExercise.buildConfig?.solutionCheckoutPath, + ])), + ); + } + + toggleEditRepositoryCheckoutPath() { + this.editRepositoryCheckoutPath = !this.editRepositoryCheckoutPath; + } + + updateSubmissionBuildPlanCheckoutDirectories(buildPlanCheckoutDirectoriesDTO: BuildPlanCheckoutDirectoriesDTO) { + this.submissionBuildPlanCheckoutRepositories = buildPlanCheckoutDirectoriesDTO; + } + + onAssigmentRepositoryCheckoutPathChange(event: string) { + this.programmingExercise.buildConfig!.assignmentCheckoutPath = event; + // We need to create a new object to trigger the change detection + this.programmingExercise.buildConfig = { ...this.programmingExercise.buildConfig }; + } + + onTestRepositoryCheckoutPathChange(event: string) { + this.programmingExercise.buildConfig!.testCheckoutPath = event; + // We need to create a new object to trigger the change detection + this.programmingExercise.buildConfig = { ...this.programmingExercise.buildConfig }; + } + + onSolutionRepositoryCheckoutPathChange(event: string) { + this.programmingExercise.buildConfig!.solutionCheckoutPath = event; + // We need to create a new object to trigger the change detection + this.programmingExercise.buildConfig = { ...this.programmingExercise.buildConfig }; + } } diff --git a/src/main/webapp/app/exercises/programming/manage/update/update-components/programming-exercise-language.component.ts b/src/main/webapp/app/exercises/programming/manage/update/update-components/programming-exercise-language.component.ts index 26951968a7b2..7514543ec6e9 100644 --- a/src/main/webapp/app/exercises/programming/manage/update/update-components/programming-exercise-language.component.ts +++ b/src/main/webapp/app/exercises/programming/manage/update/update-components/programming-exercise-language.component.ts @@ -52,11 +52,18 @@ export class ProgrammingExerciseLanguageComponent implements AfterViewChecked, A } const dockerImageField = - this.programmingExerciseCustomBuildPlanComponent?.programmingExerciseDockerImageComponent?.dockerImageField ?? - this.programmingExerciseCustomAeolusBuildPlanComponent?.programmingExerciseDockerImageComponent?.dockerImageField; + this.programmingExerciseCustomBuildPlanComponent?.programmingExerciseDockerImageComponent?.dockerImageField() ?? + this.programmingExerciseCustomAeolusBuildPlanComponent?.programmingExerciseDockerImageComponent?.dockerImageField(); if (!(dockerImageField?.valueChanges as EventEmitter)?.observed) { this.fieldSubscriptions.push(dockerImageField?.valueChanges?.subscribe(() => this.calculateFormValid())); } + + const timeoutField = + this.programmingExerciseCustomBuildPlanComponent?.programmingExerciseDockerImageComponent?.timeoutField() ?? + this.programmingExerciseCustomAeolusBuildPlanComponent?.programmingExerciseDockerImageComponent?.timeoutField(); + if (!(timeoutField?.valueChanges as EventEmitter)?.observed) { + this.fieldSubscriptions.push(timeoutField?.valueChanges?.subscribe(() => this.calculateFormValid())); + } } ngOnDestroy() { @@ -88,11 +95,17 @@ export class ProgrammingExerciseLanguageComponent implements AfterViewChecked, A } if (this.programmingExerciseCreationConfig.customBuildPlansSupported === PROFILE_LOCALCI) { - return this.programmingExerciseCustomBuildPlanComponent?.programmingExerciseDockerImageComponent?.dockerImageField?.valid ?? false; + return ( + (this.programmingExerciseCustomBuildPlanComponent?.programmingExerciseDockerImageComponent?.dockerImageField()?.valid ?? false) && + (this.programmingExerciseCustomBuildPlanComponent?.programmingExerciseDockerImageComponent?.timeoutField()?.valid ?? false) + ); } if (this.programmingExerciseCreationConfig.customBuildPlansSupported === PROFILE_AEOLUS) { - return this.programmingExerciseCustomAeolusBuildPlanComponent?.programmingExerciseDockerImageComponent?.dockerImageField?.valid ?? false; + return ( + (this.programmingExerciseCustomAeolusBuildPlanComponent?.programmingExerciseDockerImageComponent?.dockerImageField()?.valid ?? false) && + (this.programmingExerciseCustomAeolusBuildPlanComponent?.programmingExerciseDockerImageComponent?.timeoutField()?.valid ?? false) + ); } return true; diff --git a/src/main/webapp/app/exercises/programming/shared/build-details/programming-exercise-edit-checkout-directories/programming-exercise-edit-checkout-directories.component.html b/src/main/webapp/app/exercises/programming/shared/build-details/programming-exercise-edit-checkout-directories/programming-exercise-edit-checkout-directories.component.html new file mode 100644 index 000000000000..ac5f11f6362d --- /dev/null +++ b/src/main/webapp/app/exercises/programming/shared/build-details/programming-exercise-edit-checkout-directories/programming-exercise-edit-checkout-directories.component.html @@ -0,0 +1,58 @@ +
+ @if (isAssigmentRepositoryEditable) { + + + + } + @if (isTestRepositoryEditable) { + + + + } + @if (isSolutionRepositoryEditable) { + + + + } + @if (!formValid) { + + } + + +
diff --git a/src/main/webapp/app/exercises/programming/shared/build-details/programming-exercise-edit-checkout-directories/programming-exercise-edit-checkout-directories.component.ts b/src/main/webapp/app/exercises/programming/shared/build-details/programming-exercise-edit-checkout-directories/programming-exercise-edit-checkout-directories.component.ts new file mode 100644 index 000000000000..460a48c84aea --- /dev/null +++ b/src/main/webapp/app/exercises/programming/shared/build-details/programming-exercise-edit-checkout-directories/programming-exercise-edit-checkout-directories.component.ts @@ -0,0 +1,113 @@ +import { Component, effect, input, output, viewChild } from '@angular/core'; +import { ProgrammingExercise } from 'app/entities/programming/programming-exercise.model'; +import { ArtemisSharedComponentModule } from 'app/shared/components/shared-component.module'; +import { BuildPlanCheckoutDirectoriesDTO } from 'app/entities/programming/build-plan-checkout-directories-dto'; +import { ArtemisSharedCommonModule } from 'app/shared/shared-common.module'; +import { Subject } from 'rxjs'; +import { NgModel } from '@angular/forms'; + +@Component({ + selector: 'jhi-programming-exercise-edit-checkout-directories', + standalone: true, + imports: [ArtemisSharedComponentModule, ArtemisSharedCommonModule], + templateUrl: './programming-exercise-edit-checkout-directories.component.html', + styleUrls: ['../../../manage/programming-exercise-form.scss'], +}) +export class ProgrammingExerciseEditCheckoutDirectoriesComponent { + programmingExercise = input.required(); + pattern = input.required(); + submissionBuildPlanCheckoutRepositories = input.required(); + assignmentCheckoutPathEvent = output(); + testCheckoutPathEvent = output(); + solutionCheckoutPathEvent = output(); + + assignmentCheckoutPath: string; + testCheckoutPath: string; + solutionCheckoutPath: string; + + isAssigmentRepositoryEditable: boolean = false; + isTestRepositoryEditable: boolean = false; + isSolutionRepositoryEditable: boolean = false; + + formValid: boolean = true; + formValidChanges = new Subject(); + + field_assignmentRepositoryCheckoutPath = viewChild('field_assignmentRepositoryCheckoutPath'); + field_testRepositoryCheckoutPath = viewChild('field_testRepositoryCheckoutPath'); + field_solutionRepositoryCheckoutPath = viewChild('field_solutionRepositoryCheckoutPath'); + + constructor() { + effect(() => { + this.reset(); + }); + } + + reset() { + const submissionBuildPlan = this.submissionBuildPlanCheckoutRepositories(); + this.isAssigmentRepositoryEditable = + !!submissionBuildPlan?.exerciseCheckoutDirectory && + submissionBuildPlan?.exerciseCheckoutDirectory.trim() !== '' && + submissionBuildPlan?.exerciseCheckoutDirectory !== '/'; + if (this.isAssigmentRepositoryEditable) { + this.assignmentCheckoutPath = + this.programmingExercise().buildConfig?.assignmentCheckoutPath || this.removeLeadingSlash(submissionBuildPlan?.exerciseCheckoutDirectory) || ''; + } else { + this.assignmentCheckoutPath = ''; + } + this.isTestRepositoryEditable = + !!submissionBuildPlan?.testCheckoutDirectory && submissionBuildPlan?.testCheckoutDirectory.trim() !== '' && submissionBuildPlan?.testCheckoutDirectory !== '/'; + if (this.isTestRepositoryEditable) { + this.testCheckoutPath = this.programmingExercise().buildConfig?.testCheckoutPath || this.removeLeadingSlash(submissionBuildPlan?.testCheckoutDirectory) || ''; + } else { + this.testCheckoutPath = '/'; + } + this.isSolutionRepositoryEditable = + !!submissionBuildPlan?.solutionCheckoutDirectory && + submissionBuildPlan?.solutionCheckoutDirectory.trim() !== '' && + submissionBuildPlan?.solutionCheckoutDirectory !== '/'; + if (this.isSolutionRepositoryEditable) { + this.solutionCheckoutPath = + this.programmingExercise().buildConfig?.solutionCheckoutPath || this.removeLeadingSlash(submissionBuildPlan?.solutionCheckoutDirectory) || ''; + } else { + this.solutionCheckoutPath = ''; + } + } + + onAssigmentRepositoryCheckoutPathChange(event: string) { + this.assignmentCheckoutPath = event; + this.assignmentCheckoutPathEvent.emit(this.assignmentCheckoutPath); + this.calculateFormValid(); + } + + onTestRepositoryCheckoutPathChange(event: string) { + this.testCheckoutPath = event; + this.testCheckoutPathEvent.emit(this.testCheckoutPath); + this.calculateFormValid(); + } + + onSolutionRepositoryCheckoutPathChange(event: string) { + this.solutionCheckoutPath = event; + this.solutionCheckoutPathEvent.emit(this.solutionCheckoutPath); + this.calculateFormValid(); + } + + private removeLeadingSlash(path?: string): string | undefined { + return path?.replace(/^\//, ''); + } + + calculateFormValid(): void { + const isFormValid = Boolean( + (!this.field_assignmentRepositoryCheckoutPath() || this.field_assignmentRepositoryCheckoutPath()?.valid) && + (!this.field_testRepositoryCheckoutPath() || this.field_testRepositoryCheckoutPath()?.valid) && + (!this.field_solutionRepositoryCheckoutPath() || this.field_solutionRepositoryCheckoutPath()?.valid), + ); + this.formValid = isFormValid && this.areValuesUnique([this.assignmentCheckoutPath, this.testCheckoutPath, this.solutionCheckoutPath]); + this.formValidChanges.next(this.formValid); + } + + areValuesUnique(values: (string | undefined)[]): boolean { + const filteredValues = values.filter((value): value is string => value !== undefined && value.trim() !== ''); + const uniqueValues = new Set(filteredValues); + return filteredValues.length === uniqueValues.size; + } +} diff --git a/src/main/webapp/app/exercises/programming/shared/build-details/programming-exercise-repository-and-build-plan-details.component.ts b/src/main/webapp/app/exercises/programming/shared/build-details/programming-exercise-repository-and-build-plan-details.component.ts index f44d22e06ff7..ae0a3a091ca6 100644 --- a/src/main/webapp/app/exercises/programming/shared/build-details/programming-exercise-repository-and-build-plan-details.component.ts +++ b/src/main/webapp/app/exercises/programming/shared/build-details/programming-exercise-repository-and-build-plan-details.component.ts @@ -1,12 +1,14 @@ -import { Component, Input, OnChanges, OnDestroy, OnInit, SimpleChanges } from '@angular/core'; +import { Component, EventEmitter, Input, OnChanges, OnDestroy, OnInit, Output, SimpleChanges } from '@angular/core'; import { getCourseFromExercise } from 'app/entities/exercise.model'; import type { ProgrammingExercise, ProgrammingLanguage } from 'app/entities/programming/programming-exercise.model'; +import { ProgrammingExerciseBuildConfig } from 'app/entities/programming/programming-exercise-build.config'; import { ProgrammingExerciseService } from 'app/exercises/programming/manage/services/programming-exercise.service'; import { Subscription } from 'rxjs'; import type { CheckoutDirectoriesDto } from 'app/entities/programming/checkout-directories-dto'; import { ArtemisSharedComponentModule } from 'app/shared/components/shared-component.module'; import { ArtemisSharedCommonModule } from 'app/shared/shared-common.module'; import { ProgrammingExerciseBuildPlanCheckoutDirectoriesComponent } from 'app/exercises/programming/shared/build-details/programming-exercise-build-plan-checkout-directories.component'; +import { BuildPlanCheckoutDirectoriesDTO } from 'app/entities/programming/build-plan-checkout-directories-dto'; @Component({ selector: 'jhi-programming-exercise-repository-and-build-plan-details', @@ -17,9 +19,13 @@ import { ProgrammingExerciseBuildPlanCheckoutDirectoriesComponent } from 'app/ex }) export class ProgrammingExerciseRepositoryAndBuildPlanDetailsComponent implements OnInit, OnChanges, OnDestroy { @Input() programmingExercise: ProgrammingExercise; + @Input() programmingExerciseBuildConfig?: ProgrammingExerciseBuildConfig; @Input() programmingLanguage?: ProgrammingLanguage; @Input() isLocal: boolean; @Input() checkoutSolutionRepository?: boolean = true; + @Input() isCreateOrEdit = false; + @Input() isEditMode = false; + @Output() submissionBuildPlanEvent = new EventEmitter(); constructor(private programmingExerciseService: ProgrammingExerciseService) {} @@ -40,8 +46,16 @@ export class ProgrammingExerciseRepositoryAndBuildPlanDetailsComponent implement const isProgrammingLanguageUpdated = changes.programmingLanguage?.currentValue !== changes.programmingLanguage?.previousValue; const isCheckoutSolutionRepositoryUpdated = changes.checkoutSolutionRepository?.currentValue !== changes.checkoutSolutionRepository?.previousValue; if (this.isLocal && (isProgrammingLanguageUpdated || isCheckoutSolutionRepositoryUpdated)) { + if (this.isCreateOrEdit && !this.isEditMode) { + this.resetProgrammingExerciseBuildCheckoutPaths(); + } this.updateCheckoutDirectories(); } + + const isBuildConfigChanged = this.isBuildConfigAvailable(this.programmingExercise.buildConfig); + if (this.isLocal && this.isCreateOrEdit && isBuildConfigChanged) { + this.checkoutDirectories = this.setCheckoutDirectoriesFromBuildConfig(this.checkoutDirectories); + } } ngOnDestroy() { @@ -59,14 +73,70 @@ export class ProgrammingExerciseRepositoryAndBuildPlanDetailsComponent implement this.checkoutDirectorySubscription = this.programmingExerciseService .getCheckoutDirectoriesForProgrammingLanguage(this.programmingLanguage, this.checkoutSolutionRepository ?? CHECKOUT_SOLUTION_REPOSITORY_DEFAULT) .subscribe((checkoutDirectories) => { - this.checkoutDirectories = checkoutDirectories; + if ((this.isCreateOrEdit && !this.isEditMode) || !this.isBuildConfigAvailable(this.programmingExercise.buildConfig)) { + this.checkoutDirectories = checkoutDirectories; + this.submissionBuildPlanEvent.emit(checkoutDirectories.submissionBuildPlanCheckoutDirectories!); + } else { + this.checkoutDirectories = this.setCheckoutDirectoriesFromBuildConfig(checkoutDirectories); + } }); } + private setCheckoutDirectoriesFromBuildConfig(checkoutDirectories?: CheckoutDirectoriesDto): CheckoutDirectoriesDto | undefined { + if (this.programmingExercise.buildConfig || checkoutDirectories) { + checkoutDirectories = { + solutionBuildPlanCheckoutDirectories: { + solutionCheckoutDirectory: + this.addLeadingSlash(this.programmingExercise.buildConfig?.assignmentCheckoutPath) || + checkoutDirectories?.solutionBuildPlanCheckoutDirectories?.solutionCheckoutDirectory, + testCheckoutDirectory: + this.addLeadingSlash(this.programmingExercise.buildConfig?.testCheckoutPath) || + checkoutDirectories?.solutionBuildPlanCheckoutDirectories?.testCheckoutDirectory || + '/', + }, + submissionBuildPlanCheckoutDirectories: { + exerciseCheckoutDirectory: + this.addLeadingSlash(this.programmingExercise.buildConfig?.assignmentCheckoutPath) || + checkoutDirectories?.submissionBuildPlanCheckoutDirectories?.exerciseCheckoutDirectory, + solutionCheckoutDirectory: + this.addLeadingSlash(this.programmingExercise.buildConfig?.solutionCheckoutPath) || + checkoutDirectories?.submissionBuildPlanCheckoutDirectories?.solutionCheckoutDirectory, + testCheckoutDirectory: + this.addLeadingSlash(this.programmingExercise.buildConfig?.testCheckoutPath) || + checkoutDirectories?.submissionBuildPlanCheckoutDirectories?.testCheckoutDirectory || + '/', + }, + }; + } + return checkoutDirectories; + } + private updateCourseShortName() { if (!this.programmingExercise) { return; } this.courseShortName = getCourseFromExercise(this.programmingExercise)?.shortName; } + + private addLeadingSlash(path?: string): string | undefined { + if (!path) { + return undefined; + } + return path.startsWith('/') ? path : `/${path}`; + } + + private isBuildConfigAvailable(buildConfig?: ProgrammingExerciseBuildConfig): boolean { + return ( + buildConfig !== undefined && + ((buildConfig.assignmentCheckoutPath !== undefined && buildConfig.assignmentCheckoutPath.trim() !== '') || + (buildConfig.testCheckoutPath !== undefined && buildConfig.testCheckoutPath.trim() !== '') || + (buildConfig.solutionCheckoutPath !== undefined && buildConfig.solutionCheckoutPath.trim() !== '')) + ); + } + + private resetProgrammingExerciseBuildCheckoutPaths() { + this.programmingExercise.buildConfig!.assignmentCheckoutPath = undefined; + this.programmingExercise.buildConfig!.testCheckoutPath = undefined; + this.programmingExercise.buildConfig!.solutionCheckoutPath = undefined; + } } diff --git a/src/main/webapp/app/shared/constants/input.constants.ts b/src/main/webapp/app/shared/constants/input.constants.ts index 8b97589a59d6..1b1045b7f56f 100644 --- a/src/main/webapp/app/shared/constants/input.constants.ts +++ b/src/main/webapp/app/shared/constants/input.constants.ts @@ -22,3 +22,5 @@ export const MAX_QUIZ_QUESTION_POINTS = 9999; export const MAX_QUIZ_QUESTION_LENGTH_THRESHOLD = 250; export const MAX_QUIZ_QUESTION_EXPLANATION_LENGTH_THRESHOLD = 500; export const MAX_QUIZ_QUESTION_HINT_LENGTH_THRESHOLD = 255; +export const ASSIGNMENT_REPO_NAME = 'assignment'; +export const TEST_REPO_NAME = 'tests'; diff --git a/src/main/webapp/i18n/de/programmingExercise.json b/src/main/webapp/i18n/de/programmingExercise.json index b06ff3845c39..d1bf21030478 100644 --- a/src/main/webapp/i18n/de/programmingExercise.json +++ b/src/main/webapp/i18n/de/programmingExercise.json @@ -115,6 +115,23 @@ "customizeDockerImage": "Du kannst das Docker-Image anpassen. Stelle sicher, dass du es in amd64 und arm64 bereitstellst und alle Build Abhängigkeiten enthalten sind, um eine kurze Build Dauer zu gewährleisten.", "parameters": "Parameter", "dockerImage": "Docker Image", + "checkoutPath": { + "title": "Checkout-Pfad", + "customize": "Sie können den Checkout-Pfad anpassen, in dem die Repositories im Docker-Container geklont werden. Stellen Sie sicher, dass Sie einen gültigen absoluten UNIX-Pfad angeben. Der Standardpfad ist /var/tmp.", + "alert": "Checkout-Pfade dürfen nur Wörter, '_', '-', und '/' enthalten, dürfen jedoch nicht mit einem '/' beginnen oder enden. Die Pfade müssen für jedes Repository unterschiedlich sein.", + "edit": "Checkout-Pfad der Repositories bearbeiten", + "assignment": "Checkout-Pfad für das Aufgaben-Repository. Das kann nach der Erstellung nicht bearbeitet werden.", + "solution": "Checkout-Pfad für das Lösungs-Repository. Das kann nach der Erstellung nicht bearbeitet werden.", + "tests": "Checkout-Pfad für das Tests-Repository. Das kann nach der Erstellung nicht bearbeitet werden.", + "invalid": "Ungültige Checkout-Pfade", + "warning": "Das Ändern der Checkout-Pfade kann zu Build-Fehlern führen. Einige Programmiersprachen verlassen sich auf Docker-Images, die bestimmte Verzeichnisstrukturen für den Code voraussetzen.", + "warningBuildScript": "Stellen Sie sicher, dass Sie das Build-Skript und die Repositories entsprechend anpassen." + }, + "timeout": { + "title": "Maximale Build-Dauer in Sekunden ", + "customize": "Setze den Wert auf 0, um den Standardwert zu verwenden. Stelle sicher, dass du einen gültigen ganzzahligen Wert angibst. Die Einheit ist Sekunden. Beachte, dass dieser Wert durch das von den Administratoren festgelegte maximale Limit (Standard ist 240s) überschrieben werden kann.", + "alert": "Das Timeout muss ein gültiger ganzzahliger Wert sein." + }, "workdir": "Verzeichnis", "allowOnlineEditor": { "title": "Online-Editor erlauben", diff --git a/src/main/webapp/i18n/en/programmingExercise.json b/src/main/webapp/i18n/en/programmingExercise.json index 0362e88038db..9e88733b77e6 100644 --- a/src/main/webapp/i18n/en/programmingExercise.json +++ b/src/main/webapp/i18n/en/programmingExercise.json @@ -128,6 +128,23 @@ "dockerImage": "Docker Image", "script": "Build script", "customizeDockerImage": "You can customize the Docker image. Make sure to provide it in amd64 and arm64 and include all build dependencies to guarantee a short build duration.", + "checkoutPath": { + "title": "Checkout Path", + "customize": "You can customize the checkout path where the repositories are cloned inside the Docker container. Make sure to provide a valid absolute UNIX path. The default path is /var/tmp.", + "alert": "Checkout paths must only contain words, '_', '-', and '/' characters, but must not start nor end with a '/' character. The paths must be different for each repository.", + "edit": "Edit repositories checkout path", + "assignment": "Assignment Repository Checkout Path. This can't be edited after creation.", + "solution": "Solution Repository Checkout Path. This can't be edited after creation.", + "tests": "Tests Repository Checkout Path. This can't be edited after creation.", + "invalid": "Invalid checkout paths", + "warning": "Modifying checkout paths may result in build failures. Some programming languages rely on Docker images that assume specific directory structures for the code.", + "warningBuildScript": "Make sure to adjust the build script and repositories accordingly." + }, + "timeout": { + "title": "Maximum build duration in seconds", + "customize": "Set to 0 to use default value. Make sure to provide a valid integer value. The unit is seconds. Note that this value may be overridden by the maximum limit set by the administrators (default is 240s).", + "alert": "The timeout must be a valid integer value." + }, "allowOnlineEditor": { "title": "Allow Online Editor", "alert": "At least one option (Offline IDE, Online Editor, or Online IDE) must be selected", diff --git a/src/test/java/de/tum/cit/aet/artemis/buildagent/service/BuildAgentDockerServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/buildagent/service/BuildAgentDockerServiceTest.java index 1da83f9c87c3..b4012d1f7a6f 100644 --- a/src/test/java/de/tum/cit/aet/artemis/buildagent/service/BuildAgentDockerServiceTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/buildagent/service/BuildAgentDockerServiceTest.java @@ -91,7 +91,7 @@ void testPullDockerImage() { InspectImageCmd inspectImageCmd = mock(InspectImageCmd.class); doReturn(inspectImageCmd).when(dockerClient).inspectImageCmd(anyString()); doThrow(new NotFoundException("")).when(inspectImageCmd).exec(); - BuildConfig buildConfig = new BuildConfig("echo 'test'", "test-image-name", "test", "test", "test", "test", null, null, false, false, false, null); + BuildConfig buildConfig = new BuildConfig("echo 'test'", "test-image-name", "test", "test", "test", "test", null, null, false, false, false, null, 0, null, null, null); var build = new BuildJobQueueItem("1", "job1", "address1", 1, 1, 1, 1, 1, BuildStatus.SUCCESSFUL, null, null, buildConfig, null); // Pull image try { diff --git a/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIIntegrationTest.java index 46fcf73bdfb3..7d17a712b4ec 100644 --- a/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIIntegrationTest.java @@ -490,4 +490,16 @@ private void verifyUserNotification(ProgrammingExerciseStudentParticipation part return true; }), Mockito.eq(participation))); } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void testCustomCheckoutPaths() { + var buildConfig = programmingExercise.getBuildConfig(); + buildConfig.setAssignmentCheckoutPath("customAssignmentPath"); + ProgrammingExerciseStudentParticipation participation = localVCLocalCITestService.createParticipation(programmingExercise, student1Login); + programmingExerciseBuildConfigRepository.save(programmingExercise.getBuildConfig()); + + localVCServletService.processNewPush(commitHash, studentAssignmentRepository.originGit.getRepository()); + localVCLocalCITestService.testLatestSubmission(participation.getId(), commitHash, 1, false); + } } diff --git a/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIResourceIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIResourceIntegrationTest.java index 83f9d9019f27..3b7ced720320 100644 --- a/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIResourceIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIResourceIntegrationTest.java @@ -91,7 +91,7 @@ void createJobs() { JobTimingInfo jobTimingInfo2 = new JobTimingInfo(ZonedDateTime.now(), ZonedDateTime.now().plusMinutes(1), ZonedDateTime.now().plusMinutes(2)); JobTimingInfo jobTimingInfo3 = new JobTimingInfo(ZonedDateTime.now().minusMinutes(10), ZonedDateTime.now().minusMinutes(9), ZonedDateTime.now().plusSeconds(150)); - BuildConfig buildConfig = new BuildConfig("echo 'test'", "test", "test", "test", "test", "test", null, null, false, false, false, null); + BuildConfig buildConfig = new BuildConfig("echo 'test'", "test", "test", "test", "test", "test", null, null, false, false, false, null, 0, null, null, null); RepositoryInfo repositoryInfo = new RepositoryInfo("test", null, RepositoryType.USER, "test", "test", "test", null, null); job1 = new BuildJobQueueItem("1", "job1", "address1", 1, course.getId(), 1, 1, 1, BuildStatus.SUCCESSFUL, repositoryInfo, jobTimingInfo1, buildConfig, null); @@ -283,7 +283,7 @@ void testGetFinishedBuildJobs_returnsFilteredJobs() throws Exception { // Create a failed job to filter for JobTimingInfo jobTimingInfo = new JobTimingInfo(ZonedDateTime.now().plusDays(1), ZonedDateTime.now().plusDays(1).plusMinutes(2), ZonedDateTime.now().plusDays(1).plusMinutes(10)); - BuildConfig buildConfig = new BuildConfig("echo 'test'", "test", "test", "test", "test", "test", null, null, false, false, false, null); + BuildConfig buildConfig = new BuildConfig("echo 'test'", "test", "test", "test", "test", "test", null, null, false, false, false, null, 0, null, null, null); RepositoryInfo repositoryInfo = new RepositoryInfo("test", null, RepositoryType.USER, "test", "test", "test", null, null); var failedJob1 = new BuildJobQueueItem("5", "job5", "address1", 1, course.getId(), 1, 1, 1, BuildStatus.FAILED, repositoryInfo, jobTimingInfo, buildConfig, null); var jobResult = new Result().successful(false).rated(true).score(0D).assessmentType(AssessmentType.AUTOMATIC).completionDate(ZonedDateTime.now()); diff --git a/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIServiceTest.java index e61612cbb9bc..040aef91d87e 100644 --- a/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIServiceTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIServiceTest.java @@ -101,7 +101,7 @@ void testReturnCorrectBuildStatus() { ProgrammingExerciseStudentParticipation participation = participationUtilService.addStudentParticipationForProgrammingExercise(exercise, TEST_PREFIX + "student1"); JobTimingInfo jobTimingInfo = new JobTimingInfo(ZonedDateTime.now(), ZonedDateTime.now().plusMinutes(1), ZonedDateTime.now().plusMinutes(2)); - BuildConfig buildConfig = new BuildConfig("echo 'test'", "test", "test", "test", "test", "test", null, null, false, false, false, null); + BuildConfig buildConfig = new BuildConfig("echo 'test'", "test", "test", "test", "test", "test", null, null, false, false, false, null, 0, null, null, null); RepositoryInfo repositoryInfo = new RepositoryInfo("test", null, RepositoryType.USER, "test", "test", "test", null, null); BuildJobQueueItem job1 = new BuildJobQueueItem("1", "job1", "address1", participation.getId(), course.getId(), 1, 1, 1, diff --git a/src/test/java/de/tum/cit/aet/artemis/programming/icl/ProgrammingExerciseLocalVCLocalCIIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/programming/icl/ProgrammingExerciseLocalVCLocalCIIntegrationTest.java index e54b25a55283..f5ec144c6bf0 100644 --- a/src/test/java/de/tum/cit/aet/artemis/programming/icl/ProgrammingExerciseLocalVCLocalCIIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/programming/icl/ProgrammingExerciseLocalVCLocalCIIntegrationTest.java @@ -201,6 +201,19 @@ void testCreateProgrammingExercise() throws Exception { verify(competencyProgressService).updateProgressByLearningObjectAsync(eq(createdExercise)); } + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testCreateProgrammingExercise_Invalid_CheckoutPaths() throws Exception { + // The mock commit hashes don't allow the getPushDate() method in the LocalVCService to retrieve the push date using the commit hash. Thus, this method must be mocked. + doReturn(ZonedDateTime.now().minusSeconds(2)).when(versionControlService).getPushDate(any(), any(), any()); + + ProgrammingExercise newExercise = ProgrammingExerciseFactory.generateProgrammingExercise(ZonedDateTime.now().minusDays(1), ZonedDateTime.now().plusDays(7), course); + newExercise.setProjectType(ProjectType.PLAIN_GRADLE); + newExercise.getBuildConfig().setAssignmentCheckoutPath("/invalid/assignment"); + + request.postWithResponseBody("/api/programming-exercises/setup", newExercise, ProgrammingExercise.class, HttpStatus.BAD_REQUEST); + } + @Test @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") void testUpdateProgrammingExercise() throws Exception { diff --git a/src/test/javascript/spec/component/programming-exercise/programming-exercise-docker-image.component.spec.ts b/src/test/javascript/spec/component/programming-exercise/programming-exercise-build-configuration.component.spec.ts similarity index 54% rename from src/test/javascript/spec/component/programming-exercise/programming-exercise-docker-image.component.spec.ts rename to src/test/javascript/spec/component/programming-exercise/programming-exercise-build-configuration.component.spec.ts index 8f6987901422..978f821fb406 100644 --- a/src/test/javascript/spec/component/programming-exercise/programming-exercise-docker-image.component.spec.ts +++ b/src/test/javascript/spec/component/programming-exercise/programming-exercise-build-configuration.component.spec.ts @@ -1,34 +1,39 @@ import { TestBed } from '@angular/core/testing'; import { ArtemisTestModule } from '../../test.module'; -import { ProgrammingExerciseDockerImageComponent } from 'app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-docker-image/programming-exercise-docker-image.component'; +import { ProgrammingExerciseBuildConfigurationComponent } from 'app/exercises/programming/manage/update/update-components/custom-build-plans/programming-exercise-build-configuration/programming-exercise-build-configuration.component'; import { FormsModule } from '@angular/forms'; import { ArtemisProgrammingExerciseUpdateModule } from 'app/exercises/programming/manage/update/programming-exercise-update.module'; describe('ProgrammingExercise Docker Image', () => { - let comp: ProgrammingExerciseDockerImageComponent; + let comp: ProgrammingExerciseBuildConfigurationComponent; beforeEach(() => { TestBed.configureTestingModule({ imports: [ArtemisTestModule, FormsModule, ArtemisProgrammingExerciseUpdateModule], - declarations: [ProgrammingExerciseDockerImageComponent], + declarations: [ProgrammingExerciseBuildConfigurationComponent], providers: [], }) .compileComponents() .then(); - const fixture = TestBed.createComponent(ProgrammingExerciseDockerImageComponent); + const fixture = TestBed.createComponent(ProgrammingExerciseBuildConfigurationComponent); comp = fixture.componentInstance; - comp.dockerImage = 'testImage'; + fixture.componentRef.setInput('dockerImage', 'testImage'); + fixture.componentRef.setInput('timeout', 10); }); afterEach(() => { jest.restoreAllMocks(); }); - it('should update docker image', () => { - expect(comp.dockerImage).toBe('testImage'); + it('should update build values', () => { + expect(comp.dockerImage()).toBe('testImage'); comp.dockerImageChange.subscribe((value) => expect(value).toBe('newImage')); comp.dockerImageChange.emit('newImage'); + + expect(comp.timeout()).toBe(10); + comp.timeoutChange.subscribe((value) => expect(value).toBe(20)); + comp.timeoutChange.emit(20); }); }); diff --git a/src/test/javascript/spec/component/programming-exercise/programming-exercise-custom-build-plan.component.spec.ts b/src/test/javascript/spec/component/programming-exercise/programming-exercise-custom-build-plan.component.spec.ts index 7637950ee528..a02862b32a59 100644 --- a/src/test/javascript/spec/component/programming-exercise/programming-exercise-custom-build-plan.component.spec.ts +++ b/src/test/javascript/spec/component/programming-exercise/programming-exercise-custom-build-plan.component.spec.ts @@ -169,7 +169,7 @@ describe('ProgrammingExercise Custom Build Plan', () => { expect(loadAeolusTemplateSpy).toHaveBeenCalled(); }); - it('should update windfile', () => { + it('should update programming exercise values', () => { comp.programmingExercise.buildConfig!.windfile = undefined; programmingExerciseCreationConfigMock.customBuildPlansSupported = PROFILE_LOCALCI; comp.programmingExerciseCreationConfig = programmingExerciseCreationConfigMock; @@ -177,6 +177,7 @@ describe('ProgrammingExercise Custom Build Plan', () => { jest.spyOn(mockAeolusService, 'getAeolusTemplateScript').mockReturnValue(new Observable((subscriber) => subscriber.next("echo 'test'"))); comp.loadAeolusTemplate(); expect(comp.programmingExercise.buildConfig?.windfile).toBeDefined(); + expect(comp.programmingExercise.buildConfig?.timeoutSeconds).toBe(0); }); it('should call this.resetCustomBuildPlan', () => { @@ -264,4 +265,10 @@ describe('ProgrammingExercise Custom Build Plan', () => { expect(mockAeolusService.getAeolusTemplateFile).not.toHaveBeenCalled(); expect(comp.programmingExercise.buildConfig?.buildScript).toBe('echo "test"'); }); + + it('should set timeout correctly', () => { + comp.programmingExercise.buildConfig!.timeoutSeconds = 100; + comp.setTimeout(10); + expect(comp.programmingExercise.buildConfig?.timeoutSeconds).toBe(10); + }); }); diff --git a/src/test/javascript/spec/component/programming-exercise/programming-exercise-edit-checkout-directories.component.spec.ts b/src/test/javascript/spec/component/programming-exercise/programming-exercise-edit-checkout-directories.component.spec.ts new file mode 100644 index 000000000000..5702048b3e80 --- /dev/null +++ b/src/test/javascript/spec/component/programming-exercise/programming-exercise-edit-checkout-directories.component.spec.ts @@ -0,0 +1,147 @@ +import { ComponentFixture, TestBed } from '@angular/core/testing'; +import { ProgrammingExerciseEditCheckoutDirectoriesComponent } from 'app/exercises/programming/shared/build-details/programming-exercise-edit-checkout-directories/programming-exercise-edit-checkout-directories.component'; +import { ArtemisSharedComponentModule } from 'app/shared/components/shared-component.module'; +import { ArtemisSharedCommonModule } from 'app/shared/shared-common.module'; +import { MockTranslateService } from '../../helpers/mocks/service/mock-translate.service'; +import { TranslateService } from '@ngx-translate/core'; +import { HelpIconComponent } from 'app/shared/components/help-icon.component'; +import { MockComponent } from 'ng-mocks'; +import { ProgrammingExercise } from 'app/entities/programming/programming-exercise.model'; +import { BuildAction, PlatformAction, ScriptAction } from 'app/entities/programming/build.action'; +import { WindFile } from 'app/entities/programming/wind.file'; +import { WindMetadata } from 'app/entities/programming/wind.metadata'; +import { DockerConfiguration } from 'app/entities/programming/docker.configuration'; +import { Course } from 'app/entities/course.model'; +import { BuildPlanCheckoutDirectoriesDTO } from 'app/entities/programming/build-plan-checkout-directories-dto'; + +describe('ProgrammingExerciseEditCheckoutDirectoriesComponent', () => { + let component: ProgrammingExerciseEditCheckoutDirectoriesComponent; + let fixture: ComponentFixture; + const course = { id: 123 } as Course; + + let programmingExercise = new ProgrammingExercise(course, undefined); + let windFile: WindFile = new WindFile(); + let actions: BuildAction[] = []; + let gradleBuildAction: ScriptAction = new ScriptAction(); + let cleanBuildAction: ScriptAction = new ScriptAction(); + let platformAction: PlatformAction = new PlatformAction(); + + const submissionBuildPlanCheckoutRepositories: BuildPlanCheckoutDirectoriesDTO = { + exerciseCheckoutDirectory: '/assignment', + solutionCheckoutDirectory: '/solution', + testCheckoutDirectory: '/tests', + }; + + beforeEach(async () => { + programmingExercise = new ProgrammingExercise(course, undefined); + programmingExercise.customizeBuildPlanWithAeolus = true; + windFile = new WindFile(); + const metadata = new WindMetadata(); + metadata.docker = new DockerConfiguration(); + metadata.docker.image = 'testImage'; + windFile.metadata = metadata; + actions = []; + gradleBuildAction = new ScriptAction(); + gradleBuildAction.name = 'gradle'; + gradleBuildAction.script = './gradlew clean test'; + platformAction = new PlatformAction(); + platformAction.name = 'platform'; + platformAction.kind = 'junit'; + cleanBuildAction = new ScriptAction(); + cleanBuildAction.name = 'clean'; + cleanBuildAction.script = `chmod -R 777 .`; + actions.push(gradleBuildAction); + actions.push(cleanBuildAction); + actions.push(platformAction); + windFile.actions = actions; + programmingExercise.buildConfig!.windfile = windFile; + + await TestBed.configureTestingModule({ + imports: [ArtemisSharedComponentModule, ArtemisSharedCommonModule], + declarations: [ProgrammingExerciseEditCheckoutDirectoriesComponent, MockComponent(HelpIconComponent)], + providers: [{ provide: TranslateService, useClass: MockTranslateService }], + }).compileComponents(); + + fixture = TestBed.createComponent(ProgrammingExerciseEditCheckoutDirectoriesComponent); + component = fixture.componentInstance; + + fixture.componentRef.setInput('programmingExercise', programmingExercise); + fixture.componentRef.setInput('submissionBuildPlanCheckoutRepositories', { + testCheckoutDirectory: '/', + }); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('reset should set editable and input fields correctly', () => { + fixture.componentRef.setInput('submissionBuildPlanCheckoutRepositories', submissionBuildPlanCheckoutRepositories); + component.reset(); + expect(component.isAssigmentRepositoryEditable).toBeTrue(); + expect(component.assignmentCheckoutPath).toBe('assignment'); + expect(component.isTestRepositoryEditable).toBeTrue(); + expect(component.testCheckoutPath).toBe('tests'); + expect(component.isSolutionRepositoryEditable).toBeTrue(); + expect(component.solutionCheckoutPath).toBe('solution'); + + fixture.componentRef.setInput('submissionBuildPlanCheckoutRepositories', { + testCheckoutDirectory: '/', + }); + component.reset(); + expect(component.isAssigmentRepositoryEditable).toBeFalse(); + expect(component.assignmentCheckoutPath).toBe(''); + expect(component.isTestRepositoryEditable).toBeFalse(); + expect(component.testCheckoutPath).toBe('/'); + expect(component.isSolutionRepositoryEditable).toBeFalse(); + expect(component.solutionCheckoutPath).toBe(''); + }); + + it('should update fields correctly', () => { + component.onAssigmentRepositoryCheckoutPathChange('assignment'); + expect(component.assignmentCheckoutPath).toBe('assignment'); + expect(component.formValid).toBeTrue(); + component.onTestRepositoryCheckoutPathChange('tests'); + expect(component.formValid).toBeTrue(); + expect(component.testCheckoutPath).toBe('tests'); + component.onSolutionRepositoryCheckoutPathChange('solution'); + expect(component.formValid).toBeTrue(); + expect(component.solutionCheckoutPath).toBe('solution'); + + component.onAssigmentRepositoryCheckoutPathChange('solution'); + expect(component.formValid).toBeFalse(); + + component.calculateFormValid(); + }); + + it('should correctly check if values are unique', () => { + let stringArray: (string | undefined)[] = ['a', 'b', 'c']; + expect(component.areValuesUnique(stringArray)).toBeTrue(); + + stringArray = ['a', 'b', 'a']; + expect(component.areValuesUnique(stringArray)).toBeFalse(); + + stringArray = ['a', 'b', undefined]; + expect(component.areValuesUnique(stringArray)).toBeTrue(); + }); + + it('should should reset values correctly when buildconfig is null', () => { + fixture.componentRef.setInput('programmingExercise', new ProgrammingExercise(course, undefined)); + fixture.componentRef.setInput('submissionBuildPlanCheckoutRepositories', submissionBuildPlanCheckoutRepositories); + component.reset(); + + expect(component.assignmentCheckoutPath).toBe('assignment'); + expect(component.testCheckoutPath).toBe('tests'); + expect(component.solutionCheckoutPath).toBe('solution'); + }); + + it('should set values to their defaults if no buildConfig of submissionBuildPlan available', () => { + fixture.componentRef.setInput('programmingExercise', new ProgrammingExercise(course, undefined)); + fixture.componentRef.setInput('submissionBuildPlanCheckoutRepositories', undefined); + component.reset(); + + expect(component.assignmentCheckoutPath).toBe(''); + expect(component.testCheckoutPath).toBe('/'); + expect(component.solutionCheckoutPath).toBe(''); + }); +}); diff --git a/src/test/javascript/spec/component/programming-exercise/programming-exercise-repository-and-build-plan-details.component.spec.ts b/src/test/javascript/spec/component/programming-exercise/programming-exercise-repository-and-build-plan-details.component.spec.ts index aa7f5e3e80bb..582b93b71df9 100644 --- a/src/test/javascript/spec/component/programming-exercise/programming-exercise-repository-and-build-plan-details.component.spec.ts +++ b/src/test/javascript/spec/component/programming-exercise/programming-exercise-repository-and-build-plan-details.component.spec.ts @@ -2,6 +2,7 @@ import { ComponentFixture, TestBed } from '@angular/core/testing'; import { ProgrammingExerciseService } from 'app/exercises/programming/manage/services/programming-exercise.service'; import { CheckoutDirectoriesDto } from 'app/entities/programming/checkout-directories-dto'; import { ProgrammingExercise, ProgrammingLanguage } from 'app/entities/programming/programming-exercise.model'; +import { ProgrammingExerciseBuildConfig } from 'app/entities/programming/programming-exercise-build.config'; import { HelpIconComponent } from 'app/shared/components/help-icon.component'; import { MockComponent } from 'ng-mocks'; import { Subscription, of } from 'rxjs'; @@ -73,7 +74,7 @@ describe('ProgrammingExerciseRepositoryAndBuildPlanDetailsComponent', () => { programmingExerciseService = TestBed.inject(ProgrammingExerciseService); component.programmingLanguage = ProgrammingLanguage.C; - component.programmingExercise = { id: 1, shortName: 'shortName' } as ProgrammingExercise; + component.programmingExercise = { id: 1, shortName: 'shortName', buildConfig: new ProgrammingExerciseBuildConfig() } as ProgrammingExercise; component.isLocal = true; jest.spyOn(programmingExerciseService, 'getCheckoutDirectoriesForProgrammingLanguage').mockImplementation( @@ -177,6 +178,11 @@ describe('ProgrammingExerciseRepositoryAndBuildPlanDetailsComponent', () => { // assertion to check if ngOnChanges was executed properly and updated the checkout directories expect(programmingExerciseService.getCheckoutDirectoriesForProgrammingLanguage).toHaveBeenCalledWith(ProgrammingLanguage.OCAML, true); expect(component.checkoutDirectories?.submissionBuildPlanCheckoutDirectories?.solutionCheckoutDirectory).toBe('/solution'); // was null before with JAVA as programming language + + // should also reset build config + expect(component.programmingExercise?.buildConfig?.solutionCheckoutPath).toBeUndefined(); + expect(component.programmingExercise?.buildConfig?.testCheckoutPath).toBeUndefined(); + expect(component.programmingExercise?.buildConfig?.assignmentCheckoutPath).toBeUndefined(); }); it('should update checkout directories when checkoutSolution flag changes', () => { @@ -195,6 +201,58 @@ describe('ProgrammingExerciseRepositoryAndBuildPlanDetailsComponent', () => { expect(programmingExerciseService.getCheckoutDirectoriesForProgrammingLanguage).toHaveBeenCalledWith(ProgrammingLanguage.OCAML, false); // solution checkout directory was /solution before with OCaml as programming language and solution checkout allowed expect(component.checkoutDirectories?.submissionBuildPlanCheckoutDirectories?.solutionCheckoutDirectory).toBeUndefined(); + + // should also reset build config + expect(component.programmingExercise?.buildConfig?.solutionCheckoutPath).toBeUndefined(); + expect(component.programmingExercise?.buildConfig?.testCheckoutPath).toBeUndefined(); + expect(component.programmingExercise?.buildConfig?.assignmentCheckoutPath).toBeUndefined(); + }); + + it('should not call service without language', () => { + jest.spyOn(programmingExerciseService, 'getCheckoutDirectoriesForProgrammingLanguage'); + + component.programmingLanguage = undefined; + component.checkoutSolutionRepository = false; + component.ngOnChanges({ + checkoutSolutionRepository: { + previousValue: true, + currentValue: false, + }, + } as unknown as SimpleChanges); + + // assertion to check if ngOnChanges was executed properly and updated the checkout directories + expect(programmingExerciseService.getCheckoutDirectoriesForProgrammingLanguage).not.toHaveBeenCalledWith(ProgrammingLanguage.OCAML, false); + }); + + it('should not call service when inEdit and build config is available', () => { + jest.spyOn(programmingExerciseService, 'getCheckoutDirectoriesForProgrammingLanguage'); + + component.isCreateOrEdit = true; + component.programmingExercise!.buildConfig = new ProgrammingExerciseBuildConfig(); + component.programmingExercise!.buildConfig.solutionCheckoutPath = 'solution'; + component.programmingExercise!.buildConfig.testCheckoutPath = 'tests'; + component.programmingExercise!.buildConfig.assignmentCheckoutPath = 'assignment'; + + component.ngOnChanges({ + checkoutSolutionRepository: { + previousValue: true, + currentValue: true, + }, + } as unknown as SimpleChanges); + + // assertion to check if ngOnChanges was executed properly and updated the checkout directories + expect(programmingExerciseService.getCheckoutDirectoriesForProgrammingLanguage).not.toHaveBeenCalledWith(ProgrammingLanguage.OCAML, false); + expect(component.checkoutDirectories).toEqual({ + submissionBuildPlanCheckoutDirectories: { + exerciseCheckoutDirectory: '/assignment', + testCheckoutDirectory: '/tests', + solutionCheckoutDirectory: '/solution', + }, + solutionBuildPlanCheckoutDirectories: { + solutionCheckoutDirectory: '/assignment', + testCheckoutDirectory: '/tests', + }, + }); }); it('should update auxiliary repository directories on changes', () => { @@ -214,4 +272,27 @@ describe('ProgrammingExerciseRepositoryAndBuildPlanDetailsComponent', () => { expect(submissionPreviewElement).toBeTruthy(); expect(submissionPreviewElement.textContent).toContain('/assignment/src'); }); + + it('should update component when buildconfig was changed', () => { + component.isCreateOrEdit = true; + component.programmingExercise!.buildConfig = new ProgrammingExerciseBuildConfig(); + component.programmingExercise!.buildConfig.solutionCheckoutPath = 'solution'; + + component.ngOnChanges({ + programmingExercise: { + previousValue: { buildConfig: new ProgrammingExerciseBuildConfig() }, + currentValue: { buildConfig: component.programmingExercise!.buildConfig }, + }, + } as unknown as SimpleChanges); + + expect(component.checkoutDirectories).toEqual({ + solutionBuildPlanCheckoutDirectories: { + testCheckoutDirectory: '/', + }, + submissionBuildPlanCheckoutDirectories: { + solutionCheckoutDirectory: '/solution', + testCheckoutDirectory: '/', + }, + }); + }); }); diff --git a/src/test/javascript/spec/component/programming-exercise/programming-exercise-update.component.spec.ts b/src/test/javascript/spec/component/programming-exercise/programming-exercise-update.component.spec.ts index adc5d04cd682..561469eb9381 100644 --- a/src/test/javascript/spec/component/programming-exercise/programming-exercise-update.component.spec.ts +++ b/src/test/javascript/spec/component/programming-exercise/programming-exercise-update.component.spec.ts @@ -940,6 +940,49 @@ describe('ProgrammingExerciseUpdateComponent', () => { }); } }); + + it('should find invalid timeout', () => { + comp.programmingExercise.buildConfig!.timeoutSeconds = -1; + expect(comp.getInvalidReasons()).toContainEqual({ + translateKey: 'artemisApp.programmingExercise.timeout.alert', + translateValues: {}, + }); + + comp.programmingExercise.buildConfig!.timeoutSeconds = 100; + expect(comp.getInvalidReasons()).not.toContainEqual({ + translateKey: 'artemisApp.programmingExercise.timeout.alert', + translateValues: {}, + }); + }); + + it('should find invalid checkoutpaths', () => { + comp.programmingExercise.buildConfig!.assignmentCheckoutPath = 'assignment'; + comp.programmingExercise.buildConfig!.testCheckoutPath = 'assignment'; + comp.programmingExercise.buildConfig!.solutionCheckoutPath = 'solution'; + + expect(comp.getInvalidReasons()).toContainEqual({ + translateKey: 'artemisApp.programmingExercise.checkoutPath.invalid', + translateValues: {}, + }); + + comp.programmingExercise.buildConfig!.testCheckoutPath = 'test'; + expect(comp.getInvalidReasons()).not.toContainEqual({ + translateKey: 'artemisApp.programmingExercise.checkoutPath.invalid', + translateValues: {}, + }); + + comp.programmingExercise.buildConfig!.assignmentCheckoutPath = 'assignment/'; + expect(comp.getInvalidReasons()).toContainEqual({ + translateKey: 'artemisApp.programmingExercise.checkoutPath.invalid', + translateValues: {}, + }); + + comp.programmingExercise.buildConfig!.assignmentCheckoutPath = 'assignment'; + expect(comp.getInvalidReasons()).not.toContainEqual({ + translateKey: 'artemisApp.programmingExercise.checkoutPath.invalid', + translateValues: {}, + }); + }); }); describe('disable features based on selected language and project type', () => { diff --git a/src/test/javascript/spec/component/programming-exercise/update-components/programming-exercise-information.component.spec.ts b/src/test/javascript/spec/component/programming-exercise/update-components/programming-exercise-information.component.spec.ts index 963ef4c6ff37..5079df73e575 100644 --- a/src/test/javascript/spec/component/programming-exercise/update-components/programming-exercise-information.component.spec.ts +++ b/src/test/javascript/spec/component/programming-exercise/update-components/programming-exercise-information.component.spec.ts @@ -7,6 +7,7 @@ import { ProgrammingExerciseInformationComponent } from 'app/exercises/programmi import { DefaultValueAccessor, NgModel } from '@angular/forms'; import { RemoveKeysPipe } from 'app/shared/pipes/remove-keys.pipe'; import { ProgrammingExercise } from 'app/entities/programming/programming-exercise.model'; +import { ProgrammingExerciseBuildConfig } from 'app/entities/programming/programming-exercise-build.config'; import { HelpIconComponent } from 'app/shared/components/help-icon.component'; import { CategorySelectorComponent } from 'app/shared/category-selector/category-selector.component'; import { AddAuxiliaryRepositoryButtonComponent } from 'app/exercises/programming/manage/update/add-auxiliary-repository-button.component'; @@ -15,6 +16,7 @@ import { ExerciseTitleChannelNameComponent } from 'app/exercises/shared/exercise import { TableEditableFieldComponent } from 'app/shared/table/table-editable-field.component'; import { QueryList } from '@angular/core'; import { ProgrammingExerciseRepositoryAndBuildPlanDetailsComponent } from 'app/exercises/programming/shared/build-details/programming-exercise-repository-and-build-plan-details.component'; +import { ProgrammingExerciseEditCheckoutDirectoriesComponent } from 'app/exercises/programming/shared/build-details/programming-exercise-edit-checkout-directories/programming-exercise-edit-checkout-directories.component'; describe('ProgrammingExerciseInformationComponent', () => { let fixture: ComponentFixture; @@ -30,6 +32,7 @@ describe('ProgrammingExerciseInformationComponent', () => { MockComponent(HelpIconComponent), MockComponent(ExerciseTitleChannelNameComponent), MockComponent(ProgrammingExerciseRepositoryAndBuildPlanDetailsComponent), + MockComponent(ProgrammingExerciseEditCheckoutDirectoriesComponent), MockComponent(CategorySelectorComponent), MockComponent(AddAuxiliaryRepositoryButtonComponent), MockPipe(ArtemisTranslatePipe), @@ -51,6 +54,7 @@ describe('ProgrammingExerciseInformationComponent', () => { comp.programmingExerciseCreationConfig = programmingExerciseCreationConfigMock; comp.programmingExercise = new ProgrammingExercise(undefined, undefined); + comp.programmingExercise.buildConfig = new ProgrammingExerciseBuildConfig(); }); }); @@ -72,6 +76,7 @@ describe('ProgrammingExerciseInformationComponent', () => { comp.recreateBuildPlansField = { valueChanges: new Subject(), valid: true } as any as NgModel; comp.updateTemplateFilesField = { valueChanges: new Subject(), valid: true } as any as NgModel; comp.tableEditableFields = { changes: new Subject() } as any as QueryList; + comp.programmingExerciseEditCheckoutDirectories = { formValidChanges: new Subject() } as ProgrammingExerciseEditCheckoutDirectoriesComponent; comp.ngAfterViewInit(); (comp.tableEditableFields.changes as Subject).next({ toArray: () => [editableField] } as any as QueryList); comp.exerciseTitleChannelComponent.titleChannelNameComponent.formValidChanges.next(false); @@ -80,6 +85,16 @@ describe('ProgrammingExerciseInformationComponent', () => { (comp.recreateBuildPlansField.valueChanges as Subject).next(false); (comp.updateTemplateFilesField.valueChanges as Subject).next(false); (editableField.editingInput.valueChanges as Subject).next(false); - expect(calculateFormValidSpy).toHaveBeenCalledTimes(6); + comp.programmingExerciseEditCheckoutDirectories.formValidChanges.next(false); + expect(calculateFormValidSpy).toHaveBeenCalledTimes(7); + }); + + it('should update checkout directories', () => { + comp.onTestRepositoryCheckoutPathChange('test'); + expect(comp.programmingExercise.buildConfig?.testCheckoutPath).toBe('test'); + comp.onSolutionRepositoryCheckoutPathChange('solution'); + expect(comp.programmingExercise.buildConfig?.solutionCheckoutPath).toBe('solution'); + comp.onAssigmentRepositoryCheckoutPathChange('assignment'); + expect(comp.programmingExercise.buildConfig?.assignmentCheckoutPath).toBe('assignment'); }); }); From 87d73ec9ff2109b226a1646221e093e5d37e4ed4 Mon Sep 17 00:00:00 2001 From: Patrik Zander <38403547+pzdr7@users.noreply.github.com> Date: Sat, 12 Oct 2024 19:10:07 +0200 Subject: [PATCH 12/23] Development: Migrate the git diff report module to standalone components (#9443) --- ...rogramming-diff-report-detail.component.ts | 10 +- .../app/detail-overview-list/detail.module.ts | 2 - .../app/exam/manage/exam-management.module.ts | 4 +- ...rogramming-exercise-exam-diff.component.ts | 10 +- .../code-hint-generation-overview.module.ts | 8 +- .../git-diff-file-panel-title.component.html | 12 +- .../git-diff-file-panel-title.component.ts | 44 ++-- .../git-diff-file-panel.component.html | 20 +- .../git-diff-file-panel.component.ts | 90 ++++---- .../git-diff-file.component.html | 4 +- .../git-diff-file.component.ts | 67 ++---- .../git-diff-line-stat.component.html | 8 +- .../git-diff-line-stat.component.ts | 42 ++-- .../git-diff-report-modal.component.html | 25 +- .../git-diff-report-modal.component.ts | 216 +++++++++--------- .../git-diff-report.component.html | 43 ++-- .../git-diff-report.component.ts | 157 +++++++------ .../git-diff-report/git-diff-report.module.ts | 18 -- .../programming-exercise-management.module.ts | 2 - .../programming-repository.module.ts | 4 +- .../monaco-diff-editor.component.scss | 9 + .../monaco-diff-editor.component.ts | 34 +-- .../monaco-editor/monaco-editor.service.ts | 1 + .../programming-exam-diff.component.spec.ts | 2 +- ...it-diff-file-panel-title.component.spec.ts | 26 +-- .../git-diff-file-panel.component.spec.ts | 84 ++++--- .../git-diff-file.component.spec.ts | 26 +-- .../git-diff-line-stat.component.spec.ts | 12 +- .../git-diff-modal.component.spec.ts | 116 +++++----- .../git-diff-report.component.spec.ts | 113 ++++----- .../monaco-diff-editor.component.spec.ts | 9 +- 31 files changed, 589 insertions(+), 629 deletions(-) delete mode 100644 src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report.module.ts diff --git a/src/main/webapp/app/detail-overview-list/components/programming-diff-report-detail/programming-diff-report-detail.component.ts b/src/main/webapp/app/detail-overview-list/components/programming-diff-report-detail/programming-diff-report-detail.component.ts index e95dbf256ee2..94fb86848f4f 100644 --- a/src/main/webapp/app/detail-overview-list/components/programming-diff-report-detail/programming-diff-report-detail.component.ts +++ b/src/main/webapp/app/detail-overview-list/components/programming-diff-report-detail/programming-diff-report-detail.component.ts @@ -1,20 +1,20 @@ -import { Component, Input, OnDestroy, inject } from '@angular/core'; +import { Component, Input, OnDestroy, inject, signal } from '@angular/core'; import type { ProgrammingDiffReportDetail } from 'app/detail-overview-list/detail.model'; import { FeatureToggle } from 'app/shared/feature-toggle/feature-toggle.service'; import { ButtonSize, ButtonType, TooltipPlacement } from 'app/shared/components/button.component'; import { faCodeCompare } from '@fortawesome/free-solid-svg-icons'; import { ProgrammingExerciseGitDiffReport } from 'app/entities/hestia/programming-exercise-git-diff-report.model'; import { GitDiffReportModalComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-report-modal.component'; -import { GitDiffReportModule } from 'app/exercises/programming/hestia/git-diff-report/git-diff-report.module'; import { ArtemisSharedComponentModule } from 'app/shared/components/shared-component.module'; import { ArtemisSharedModule } from 'app/shared/shared.module'; import { NgbModal, NgbModalRef } from '@ng-bootstrap/ng-bootstrap'; +import { GitDiffLineStatComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-line-stat.component'; @Component({ selector: 'jhi-programming-diff-report-detail', templateUrl: 'programming-diff-report-detail.component.html', standalone: true, - imports: [ArtemisSharedModule, ArtemisSharedComponentModule, GitDiffReportModule], + imports: [ArtemisSharedModule, ArtemisSharedComponentModule, GitDiffLineStatComponent], }) export class ProgrammingDiffReportDetailComponent implements OnDestroy { protected readonly FeatureToggle = FeatureToggle; @@ -38,7 +38,7 @@ export class ProgrammingDiffReportDetailComponent implements OnDestroy { return; } - this.modalRef = this.modalService.open(GitDiffReportModalComponent, { windowClass: 'diff-view-modal' }); - this.modalRef.componentInstance.report = gitDiff; + this.modalRef = this.modalService.open(GitDiffReportModalComponent, { windowClass: GitDiffReportModalComponent.WINDOW_CLASS }); + this.modalRef.componentInstance.report = signal(gitDiff); } } diff --git a/src/main/webapp/app/detail-overview-list/detail.module.ts b/src/main/webapp/app/detail-overview-list/detail.module.ts index 28a1f3a8abb9..c661ae788647 100644 --- a/src/main/webapp/app/detail-overview-list/detail.module.ts +++ b/src/main/webapp/app/detail-overview-list/detail.module.ts @@ -6,7 +6,6 @@ import { ArtemisSharedComponentModule } from 'app/shared/components/shared-compo import { SubmissionResultStatusModule } from 'app/overview/submission-result-status.module'; import { ArtemisProgrammingExerciseStatusModule } from 'app/exercises/programming/manage/status/programming-exercise-status.module'; import { ArtemisProgrammingExerciseActionsModule } from 'app/exercises/programming/shared/actions/programming-exercise-actions.module'; -import { GitDiffReportModule } from 'app/exercises/programming/hestia/git-diff-report/git-diff-report.module'; import { ArtemisProgrammingExerciseInstructionsEditorModule } from 'app/exercises/programming/manage/instructions-editor/programming-exercise-instructions-editor.module'; import { ArtemisProgrammingExerciseLifecycleModule } from 'app/exercises/programming/shared/lifecycle/programming-exercise-lifecycle.module'; import { AssessmentInstructionsModule } from 'app/assessment/assessment-instructions/assessment-instructions.module'; @@ -25,7 +24,6 @@ import { NoDataComponent } from 'app/shared/no-data-component'; SubmissionResultStatusModule, ArtemisProgrammingExerciseStatusModule, ArtemisProgrammingExerciseActionsModule, - GitDiffReportModule, ArtemisProgrammingExerciseInstructionsEditorModule, ArtemisProgrammingExerciseLifecycleModule, AssessmentInstructionsModule, diff --git a/src/main/webapp/app/exam/manage/exam-management.module.ts b/src/main/webapp/app/exam/manage/exam-management.module.ts index a932fdd227b9..b9a9829ab1fa 100644 --- a/src/main/webapp/app/exam/manage/exam-management.module.ts +++ b/src/main/webapp/app/exam/manage/exam-management.module.ts @@ -67,11 +67,11 @@ import { ArtemisExamNavigationBarModule } from 'app/exam/participate/exam-naviga import { ArtemisExamSubmissionComponentsModule } from 'app/exam/participate/exercises/exam-submission-components.module'; import { MatSliderModule } from '@angular/material/slider'; import { ProgrammingExerciseExamDiffComponent } from './student-exams/student-exam-timeline/programming-exam-diff/programming-exercise-exam-diff.component'; -import { GitDiffReportModule } from 'app/exercises/programming/hestia/git-diff-report/git-diff-report.module'; import { ArtemisProgrammingExerciseModule } from 'app/exercises/programming/shared/programming-exercise.module'; import { DetailModule } from 'app/detail-overview-list/detail.module'; import { ArtemisDurationFromSecondsPipe } from 'app/shared/pipes/artemis-duration-from-seconds.pipe'; import { NoDataComponent } from 'app/shared/no-data-component'; +import { GitDiffLineStatComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-line-stat.component'; const ENTITY_STATES = [...examManagementState]; @@ -110,10 +110,10 @@ const ENTITY_STATES = [...examManagementState]; ArtemisExamNavigationBarModule, ArtemisExamSubmissionComponentsModule, MatSliderModule, - GitDiffReportModule, ArtemisProgrammingExerciseModule, DetailModule, NoDataComponent, + GitDiffLineStatComponent, ], declarations: [ ExamManagementComponent, diff --git a/src/main/webapp/app/exam/manage/student-exams/student-exam-timeline/programming-exam-diff/programming-exercise-exam-diff.component.ts b/src/main/webapp/app/exam/manage/student-exams/student-exam-timeline/programming-exam-diff/programming-exercise-exam-diff.component.ts index 7eafe4900d96..81a3f247a809 100644 --- a/src/main/webapp/app/exam/manage/student-exams/student-exam-timeline/programming-exam-diff/programming-exercise-exam-diff.component.ts +++ b/src/main/webapp/app/exam/manage/student-exams/student-exam-timeline/programming-exam-diff/programming-exercise-exam-diff.component.ts @@ -1,4 +1,4 @@ -import { ChangeDetectorRef, Component, EventEmitter, Input, OnDestroy, OnInit, Output } from '@angular/core'; +import { ChangeDetectorRef, Component, EventEmitter, Input, OnDestroy, OnInit, Output, signal } from '@angular/core'; import { ProgrammingExercise } from 'app/entities/programming/programming-exercise.model'; import { ProgrammingSubmission } from 'app/entities/programming/programming-submission.model'; import { FeatureToggle } from 'app/shared/feature-toggle/feature-toggle.service'; @@ -123,10 +123,10 @@ export class ProgrammingExerciseExamDiffComponent extends ExamPageComponent impl * Shows the git-diff in a modal. */ showGitDiff(): void { - const modalRef = this.modalService.open(GitDiffReportModalComponent, { size: 'xl' }); - modalRef.componentInstance.report = this.exercise.gitDiffReport; - modalRef.componentInstance.diffForTemplateAndSolution = false; - modalRef.componentInstance.cachedRepositoryFiles = this.cachedRepositoryFiles; + const modalRef = this.modalService.open(GitDiffReportModalComponent, { windowClass: GitDiffReportModalComponent.WINDOW_CLASS }); + modalRef.componentInstance.report = signal(this.exercise.gitDiffReport); + modalRef.componentInstance.diffForTemplateAndSolution = signal(false); + modalRef.componentInstance.cachedRepositoryFiles = signal(this.cachedRepositoryFiles); this.cachedRepositoryFilesService.getCachedRepositoryFilesObservable().subscribe((cachedRepositoryFiles) => { this.cachedRepositoryFiles = cachedRepositoryFiles; }); diff --git a/src/main/webapp/app/exercises/programming/hestia/generation-overview/code-hint-generation-overview/code-hint-generation-overview.module.ts b/src/main/webapp/app/exercises/programming/hestia/generation-overview/code-hint-generation-overview/code-hint-generation-overview.module.ts index 05be60e77689..a9d7088b56c9 100644 --- a/src/main/webapp/app/exercises/programming/hestia/generation-overview/code-hint-generation-overview/code-hint-generation-overview.module.ts +++ b/src/main/webapp/app/exercises/programming/hestia/generation-overview/code-hint-generation-overview/code-hint-generation-overview.module.ts @@ -9,13 +9,13 @@ import { CoverageGenerationStepComponent } from '../steps/coverage-generation-st import { SolutionEntryGenerationStepComponent } from '../steps/solution-entry-generation-step/solution-entry-generation-step.component'; import { CodeHintGenerationStepComponent } from '../steps/code-hint-generation-step/code-hint-generation-step.component'; import { TestwiseCoverageReportModule } from 'app/exercises/programming/hestia/testwise-coverage-report/testwise-coverage-report.module'; -import { GitDiffReportModule } from 'app/exercises/programming/hestia/git-diff-report/git-diff-report.module'; import { CodeHintGenerationOverviewComponent } from 'app/exercises/programming/hestia/generation-overview/code-hint-generation-overview/code-hint-generation-overview.component'; import { RouterModule } from '@angular/router'; import { ArtemisMarkdownModule } from 'app/shared/markdown.module'; import { MatExpansionModule } from '@angular/material/expansion'; import { CodeHintGenerationStatusStepComponent } from 'app/exercises/programming/hestia/generation-overview/code-hint-generation-status/code-hint-generation-status-step.component'; import { ManualSolutionEntryCreationModalComponent } from '../manual-solution-entry-creation-modal/manual-solution-entry-creation-modal.component'; +import { GitDiffReportComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-report.component'; @NgModule({ imports: [ @@ -24,13 +24,9 @@ import { ManualSolutionEntryCreationModalComponent } from '../manual-solution-en ArtemisExerciseHintSharedModule, ArtemisSharedComponentModule, TestwiseCoverageReportModule, - GitDiffReportModule, - GitDiffReportModule, - TestwiseCoverageReportModule, - ArtemisSharedComponentModule, ArtemisMarkdownModule, - ArtemisExerciseHintSharedModule, MatExpansionModule, + GitDiffReportComponent, ], declarations: [ CodeHintGenerationStatusComponent, diff --git a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file-panel-title.component.html b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file-panel-title.component.html index 80802af1dbd1..8b470a3e9fd5 100644 --- a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file-panel-title.component.html +++ b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file-panel-title.component.html @@ -1,13 +1,13 @@
- {{ title }} - @if (fileStatus !== FileStatus.UNCHANGED) { + {{ title() }} + @if (fileStatus() !== FileStatus.UNCHANGED) { } diff --git a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file-panel-title.component.ts b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file-panel-title.component.ts index 3e7706581b88..74b0f35dfab0 100644 --- a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file-panel-title.component.ts +++ b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file-panel-title.component.ts @@ -1,4 +1,6 @@ -import { Component, Input, OnInit } from '@angular/core'; +import { ChangeDetectionStrategy, Component, computed, input } from '@angular/core'; +import { TranslateDirective } from 'app/shared/language/translate.directive'; +import { CommonModule } from '@angular/common'; enum FileStatus { CREATED = 'created', @@ -10,35 +12,33 @@ enum FileStatus { selector: 'jhi-git-diff-file-panel-title', templateUrl: './git-diff-file-panel-title.component.html', styleUrls: ['./git-diff-file-panel-title.component.scss'], + standalone: true, + changeDetection: ChangeDetectionStrategy.OnPush, + imports: [TranslateDirective, CommonModule], }) -export class GitDiffFilePanelTitleComponent implements OnInit { - @Input() - previousFilePath?: string; +export class GitDiffFilePanelTitleComponent { + readonly originalFilePath = input(); + readonly modifiedFilePath = input(); - @Input() - filePath?: string; + readonly titleAndFileStatus = computed(() => this.getTitleAndFileStatus()); + readonly title = computed(() => this.titleAndFileStatus().title); + readonly fileStatus = computed(() => this.titleAndFileStatus().fileStatus); - title?: string; - fileStatus: FileStatus = FileStatus.UNCHANGED; - - // Expose to template protected readonly FileStatus = FileStatus; - ngOnInit(): void { - if (this.filePath && this.previousFilePath) { - if (this.filePath !== this.previousFilePath) { - this.title = `${this.previousFilePath} → ${this.filePath}`; - this.fileStatus = FileStatus.RENAMED; + private getTitleAndFileStatus(): { title?: string; fileStatus: FileStatus } { + const originalFilePath = this.originalFilePath(); + const modifiedFilePath = this.modifiedFilePath(); + if (modifiedFilePath && originalFilePath) { + if (modifiedFilePath !== originalFilePath) { + return { title: `${originalFilePath} → ${modifiedFilePath}`, fileStatus: FileStatus.RENAMED }; } else { - this.title = this.filePath; - this.fileStatus = FileStatus.UNCHANGED; + return { title: modifiedFilePath, fileStatus: FileStatus.UNCHANGED }; } - } else if (this.filePath) { - this.title = this.filePath; - this.fileStatus = FileStatus.CREATED; + } else if (modifiedFilePath) { + return { title: modifiedFilePath, fileStatus: FileStatus.CREATED }; } else { - this.title = this.previousFilePath; - this.fileStatus = FileStatus.DELETED; + return { title: originalFilePath, fileStatus: FileStatus.DELETED }; } } } diff --git a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file-panel.component.html b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file-panel.component.html index 7b8fafd1178e..bb9245843140 100644 --- a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file-panel.component.html +++ b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file-panel.component.html @@ -1,13 +1,13 @@
- +
diff --git a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file-panel.component.ts b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file-panel.component.ts index cd36cfc5b5f5..9e01edae26b9 100644 --- a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file-panel.component.ts +++ b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file-panel.component.ts @@ -1,58 +1,66 @@ -import { Component, EventEmitter, Input, OnInit, Output, ViewEncapsulation } from '@angular/core'; +import { ChangeDetectionStrategy, Component, ViewEncapsulation, computed, input, output } from '@angular/core'; import { ProgrammingExerciseGitDiffEntry } from 'app/entities/hestia/programming-exercise-git-diff-entry.model'; import { faAngleDown, faAngleUp } from '@fortawesome/free-solid-svg-icons'; +import { GitDiffFilePanelTitleComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-file-panel-title.component'; +import { GitDiffLineStatComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-line-stat.component'; +import { GitDiffFileComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-file.component'; +import { ArtemisSharedModule } from 'app/shared/shared.module'; @Component({ selector: 'jhi-git-diff-file-panel', templateUrl: './git-diff-file-panel.component.html', styleUrls: ['./git-diff-file-panel.component.scss'], encapsulation: ViewEncapsulation.None, + standalone: true, + changeDetection: ChangeDetectionStrategy.OnPush, + imports: [GitDiffFilePanelTitleComponent, GitDiffLineStatComponent, GitDiffFileComponent, ArtemisSharedModule], }) -export class GitDiffFilePanelComponent implements OnInit { - @Input() diffEntries: ProgrammingExerciseGitDiffEntry[]; +export class GitDiffFilePanelComponent { + protected readonly faAngleUp = faAngleUp; + protected readonly faAngleDown = faAngleDown; - @Input() templateFileContent: string | undefined; + readonly diffEntries = input.required(); + readonly originalFileContent = input(); + readonly modifiedFileContent = input(); + readonly diffForTemplateAndSolution = input(true); + readonly allowSplitView = input(true); + readonly onDiffReady = output(); - @Input() solutionFileContent: string | undefined; - - @Input() diffForTemplateAndSolution = true; - - @Input() allowSplitView = true; - - @Output() onDiffReady = new EventEmitter(); - - previousFilePath: string | undefined; - filePath: string | undefined; - - addedLineCount: number; - removedLineCount: number; - - faAngleUp = faAngleUp; - faAngleDown = faAngleDown; - - ngOnInit(): void { - this.filePath = this.diffEntries - .map((entry) => entry.filePath) + readonly originalFilePath = computed(() => + this.diffEntries() + .map((entry) => entry.previousFilePath) .filter((filePath) => filePath) - .first(); + .first(), + ); - this.previousFilePath = this.diffEntries - .map((entry) => entry.previousFilePath) + readonly modifiedFilePath = computed(() => + this.diffEntries() + .map((entry) => entry.filePath) .filter((filePath) => filePath) - .first(); + .first(), + ); - this.addedLineCount = this.diffEntries - .filter((entry) => entry && entry.filePath && entry.startLine && entry.lineCount) - .flatMap((entry) => { - return this.solutionFileContent?.split('\n').slice(entry.startLine! - 1, entry.startLine! + entry.lineCount! - 1); - }) - .filter((line) => line && line.trim().length !== 0).length; + readonly addedLineCount = computed( + () => + this.diffEntries() + .filter((entry) => entry && entry.filePath && entry.startLine && entry.lineCount) + .flatMap((entry) => { + return this.modifiedFileContent() + ?.split('\n') + .slice(entry.startLine! - 1, entry.startLine! + entry.lineCount! - 1); + }) + .filter((line) => line && line.trim().length !== 0).length, + ); - this.removedLineCount = this.diffEntries - .filter((entry) => entry && entry.previousFilePath && entry.previousStartLine && entry.previousLineCount) - .flatMap((entry) => { - return this.templateFileContent?.split('\n').slice(entry.previousStartLine! - 1, entry.previousStartLine! + entry.previousLineCount! - 1); - }) - .filter((line) => line && line.trim().length !== 0).length; - } + readonly removedLineCount = computed( + () => + this.diffEntries() + .filter((entry) => entry && entry.previousFilePath && entry.previousStartLine && entry.previousLineCount) + .flatMap((entry) => { + return this.originalFileContent() + ?.split('\n') + .slice(entry.previousStartLine! - 1, entry.previousStartLine! + entry.previousLineCount! - 1); + }) + .filter((line) => line && line.trim().length !== 0).length, + ); } diff --git a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file.component.html b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file.component.html index e06148d20072..2f9ca3570472 100644 --- a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file.component.html +++ b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file.component.html @@ -1,9 +1,9 @@
- @if (fileUnchanged) { + @if (fileUnchanged()) {
} - +
diff --git a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file.component.ts b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file.component.ts index 8c5c283c3c68..45456a115513 100644 --- a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file.component.ts +++ b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-file.component.ts @@ -1,56 +1,31 @@ -import { Component, EventEmitter, Input, OnInit, Output, ViewChild, ViewEncapsulation } from '@angular/core'; +import { ChangeDetectionStrategy, Component, ViewEncapsulation, computed, effect, input, output, viewChild } from '@angular/core'; import { ProgrammingExerciseGitDiffEntry } from 'app/entities/hestia/programming-exercise-git-diff-entry.model'; import { MonacoDiffEditorComponent } from 'app/shared/monaco-editor/monaco-diff-editor.component'; +import { TranslateDirective } from 'app/shared/language/translate.directive'; @Component({ selector: 'jhi-git-diff-file', templateUrl: './git-diff-file.component.html', encapsulation: ViewEncapsulation.None, + standalone: true, + changeDetection: ChangeDetectionStrategy.OnPush, + imports: [MonacoDiffEditorComponent, TranslateDirective], }) -export class GitDiffFileComponent implements OnInit { - @ViewChild(MonacoDiffEditorComponent, { static: true }) - monacoDiffEditor: MonacoDiffEditorComponent; - - @Input() - diffForTemplateAndSolution: boolean = false; - - @Input() - diffEntries: ProgrammingExerciseGitDiffEntry[]; - - @Input() - originalFileContent?: string; - - @Input() - modifiedFileContent?: string; - - @Input() - allowSplitView = true; - - @Output() - onDiffReady = new EventEmitter(); - - originalFilePath?: string; - modifiedFilePath?: string; - fileUnchanged = false; - - ngOnInit(): void { - this.determineFilePaths(); - this.monacoDiffEditor.setFileContents(this.originalFileContent, this.originalFilePath, this.modifiedFileContent, this.modifiedFilePath); - this.fileUnchanged = this.originalFileContent === this.modifiedFileContent; - } - - /** - * Determines the previous and current file path of the current file - */ - private determineFilePaths() { - this.modifiedFilePath = this.diffEntries - .map((entry) => entry.filePath) - .filter((filePath) => filePath) - .first(); - - this.originalFilePath = this.diffEntries - .map((entry) => entry.previousFilePath) - .filter((filePath) => filePath) - .first(); +export class GitDiffFileComponent { + readonly monacoDiffEditor = viewChild.required(MonacoDiffEditorComponent); + readonly diffForTemplateAndSolution = input(false); + readonly diffEntries = input.required(); + readonly originalFileContent = input(); + readonly originalFilePath = input(); + readonly modifiedFileContent = input(); + readonly modifiedFilePath = input(); + readonly allowSplitView = input(true); + readonly onDiffReady = output(); + readonly fileUnchanged = computed(() => this.originalFileContent() === this.modifiedFileContent()); + + constructor() { + effect(() => { + this.monacoDiffEditor().setFileContents(this.originalFileContent(), this.originalFilePath(), this.modifiedFileContent(), this.modifiedFilePath()); + }); } } diff --git a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-line-stat.component.html b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-line-stat.component.html index d23e649b7439..654c3a70afed 100644 --- a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-line-stat.component.html +++ b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-line-stat.component.html @@ -1,11 +1,11 @@ - +{{ addedLineCount }} - -{{ removedLineCount }} + +{{ addedLineCount() }} + -{{ removedLineCount() }} - @for (i of [].constructor(addedSquareCount); track $index) { + @for (i of addedSquareArray(); track $index) { } - @for (i of [].constructor(removedSquareCount); track $index) { + @for (i of removedSquareArray(); track $index) { } diff --git a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-line-stat.component.ts b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-line-stat.component.ts index 8f25b7794bfc..b82ab8d02c02 100644 --- a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-line-stat.component.ts +++ b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-line-stat.component.ts @@ -1,34 +1,34 @@ -import { Component, Input, OnInit } from '@angular/core'; +import { ChangeDetectionStrategy, Component, computed, input } from '@angular/core'; @Component({ selector: 'jhi-git-diff-line-stat', templateUrl: './git-diff-line-stat.component.html', styleUrls: ['./git-diff-line-stat.component.scss'], + standalone: true, + changeDetection: ChangeDetectionStrategy.OnPush, }) -export class GitDiffLineStatComponent implements OnInit { - @Input() - addedLineCount: number = 0; - @Input() - removedLineCount: number = 0; - addedSquareCount: number; - removedSquareCount: number; +export class GitDiffLineStatComponent { + readonly addedLineCount = input(0); + readonly removedLineCount = input(0); + readonly squareCounts = computed(() => this.getSquareCounts()); + readonly addedSquareArray = computed(() => Array.from({ length: this.squareCounts().addedSquareCount })); + readonly removedSquareArray = computed(() => Array.from({ length: this.squareCounts().removedSquareCount })); - ngOnInit(): void { - if (!this.addedLineCount && !this.removedLineCount) { - this.addedSquareCount = 1; - this.removedSquareCount = 1; - } else if (this.addedLineCount === 0) { - this.addedSquareCount = 0; - this.removedSquareCount = 5; - } else if (this.removedLineCount === 0) { - this.addedSquareCount = 5; - this.removedSquareCount = 0; + private getSquareCounts(): { addedSquareCount: number; removedSquareCount: number } { + const addedLineCount = this.addedLineCount(); + const removedLineCount = this.removedLineCount(); + if (!addedLineCount && !removedLineCount) { + return { addedSquareCount: 1, removedSquareCount: 1 }; + } else if (addedLineCount === 0) { + return { addedSquareCount: 0, removedSquareCount: 5 }; + } else if (removedLineCount === 0) { + return { addedSquareCount: 5, removedSquareCount: 0 }; } else { - const totalLineCount = this.addedLineCount + this.removedLineCount; + const totalLineCount = addedLineCount + removedLineCount; // Calculates the amount of green rectangles to show between 1 and 4 // This is the rounded percentage of added lines divided by total lines - this.addedSquareCount = Math.round(Math.max(1, Math.min(4, (this.addedLineCount / totalLineCount) * 5))); - this.removedSquareCount = 5 - this.addedSquareCount; + const addedSquareCount = Math.round(Math.max(1, Math.min(4, (addedLineCount / totalLineCount) * 5))); + return { addedSquareCount, removedSquareCount: 5 - addedSquareCount }; } } } diff --git a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report-modal.component.html b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report-modal.component.html index 198b27469831..6b95cf90f178 100644 --- a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report-modal.component.html +++ b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report-modal.component.html @@ -2,22 +2,22 @@

- @if (leftCommitFileContentByPath && rightCommitFileContentByPath) { + @if (leftCommitFileContentByPath() && rightCommitFileContentByPath()) {
} @else { - @if (!errorWhileFetchingRepos) { + @if (!errorWhileFetchingRepos()) {
} } - - @if (!errorWhileFetchingRepos) { -
- -
- } - - @if (errorWhileFetchingRepos) { + @if (errorWhileFetchingRepos()) {
diff --git a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report-modal.component.ts b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report-modal.component.ts index 107acb55c1de..7684573f821f 100644 --- a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report-modal.component.ts +++ b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report-modal.component.ts @@ -1,144 +1,148 @@ -import { Component, Input, OnDestroy, OnInit } from '@angular/core'; +import { ChangeDetectionStrategy, Component, effect, inject, input, signal, untracked } from '@angular/core'; import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; import { ProgrammingExerciseGitDiffReport } from 'app/entities/hestia/programming-exercise-git-diff-report.model'; import { ProgrammingExerciseService } from 'app/exercises/programming/manage/services/programming-exercise.service'; import { ProgrammingExerciseParticipationService } from 'app/exercises/programming/manage/services/programming-exercise-participation.service'; import { CachedRepositoryFilesService } from 'app/exercises/programming/manage/services/cached-repository-files.service'; -import { Subscription } from 'rxjs'; +import { firstValueFrom } from 'rxjs'; +import { GitDiffReportComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-report.component'; +import { TranslateDirective } from 'app/shared/language/translate.directive'; @Component({ selector: 'jhi-git-diff-report-modal', templateUrl: './git-diff-report-modal.component.html', + standalone: true, + changeDetection: ChangeDetectionStrategy.OnPush, + imports: [GitDiffReportComponent, TranslateDirective], }) -export class GitDiffReportModalComponent implements OnInit, OnDestroy { - @Input() report: ProgrammingExerciseGitDiffReport; - @Input() diffForTemplateAndSolution = true; - @Input() cachedRepositoryFiles: Map> = new Map>(); - - errorWhileFetchingRepos = false; - leftCommitFileContentByPath: Map; - rightCommitFileContentByPath: Map; - - private templateRepoFilesSubscription: Subscription; - private solutionRepoFilesSubscription: Subscription; - private participationRepoFilesAtLeftCommitSubscription: Subscription; - private participationRepoFilesAtRightCommitSubscription: Subscription; - - constructor( - protected activeModal: NgbActiveModal, - private programmingExerciseService: ProgrammingExerciseService, - private programmingExerciseParticipationService: ProgrammingExerciseParticipationService, - private cachedRepositoryFilesService: CachedRepositoryFilesService, - ) {} - - ngOnInit(): void { - if (this.diffForTemplateAndSolution) { - this.loadFilesForTemplateAndSolution(); - } else { - this.loadRepositoryFilesForParticipationsFromCacheIfAvailable(); - } - } - - ngOnDestroy(): void { - this.templateRepoFilesSubscription?.unsubscribe(); - this.solutionRepoFilesSubscription?.unsubscribe(); - this.participationRepoFilesAtLeftCommitSubscription?.unsubscribe(); - this.participationRepoFilesAtRightCommitSubscription?.unsubscribe(); +export class GitDiffReportModalComponent { + static readonly WINDOW_CLASS = 'diff-view-modal'; + + private readonly activeModal = inject(NgbActiveModal); + private readonly programmingExerciseService = inject(ProgrammingExerciseService); + private readonly programmingExerciseParticipationService = inject(ProgrammingExerciseParticipationService); + private readonly cachedRepositoryFilesService = inject(CachedRepositoryFilesService); + + readonly report = input.required(); + readonly diffForTemplateAndSolution = input(true); + readonly cachedRepositoryFiles = input>>(new Map>()); + + readonly errorWhileFetchingRepos = signal(false); + readonly leftCommitFileContentByPath = signal | undefined>(undefined); + readonly rightCommitFileContentByPath = signal | undefined>(undefined); + + constructor() { + effect( + () => { + // We call the signal here to ensure the effect always runs when the report changes. + this.report(); + const diffBetweenTemplateAndSolution = this.diffForTemplateAndSolution(); + untracked(async () => { + if (diffBetweenTemplateAndSolution) { + await this.loadFilesForTemplateAndSolution(); + } else { + await this.loadRepositoryFilesForParticipationsFromCacheIfAvailable(); + } + }); + }, + { allowSignalWrites: true }, + ); } - private loadFilesForTemplateAndSolution() { - this.fetchTemplateRepoFiles(); - this.fetchSolutionRepoFiles(); + private async loadFilesForTemplateAndSolution(): Promise { + await this.fetchTemplateRepoFiles(); + await this.fetchSolutionRepoFiles(); } - private fetchSolutionRepoFiles() { - this.solutionRepoFilesSubscription = this.programmingExerciseService.getSolutionRepositoryTestFilesWithContent(this.report.programmingExercise.id!).subscribe({ - next: (response: Map) => { - this.rightCommitFileContentByPath = response; - }, - error: () => { - this.errorWhileFetchingRepos = true; - }, - }); + private async fetchSolutionRepoFiles(): Promise { + try { + const solutionRepoFiles = await firstValueFrom(this.programmingExerciseService.getSolutionRepositoryTestFilesWithContent(this.report().programmingExercise.id!)); + this.rightCommitFileContentByPath.set(solutionRepoFiles); + } catch (e) { + this.errorWhileFetchingRepos.set(true); + } } - private loadRepositoryFilesForParticipationsFromCacheIfAvailable() { - if (this.report.participationIdForLeftCommit) { - const key = this.report.leftCommitHash!; - if (this.cachedRepositoryFiles.has(key)) { - this.leftCommitFileContentByPath = this.cachedRepositoryFiles.get(key)!; - this.loadParticipationRepoFilesAtRightCommitFromCacheIfAvailable(); + private async loadRepositoryFilesForParticipationsFromCacheIfAvailable(): Promise { + if (this.report().participationIdForLeftCommit) { + const key = this.report().leftCommitHash!; + if (this.cachedRepositoryFiles().has(key)) { + this.leftCommitFileContentByPath.set(this.cachedRepositoryFiles().get(key)!); + await this.loadParticipationRepoFilesAtRightCommitFromCacheIfAvailable(); } else { - this.fetchParticipationRepoFilesAtLeftCommit(); + await this.fetchParticipationRepoFilesAtLeftCommit(); } } else { - // if there is no left commit, we want to see the diff between the current submission and the template - this.loadTemplateRepoFilesFromCacheIfAvailable(); - this.loadParticipationRepoFilesAtRightCommitFromCacheIfAvailable(); + await this.loadTemplateRepoFilesFromCacheIfAvailable(); + await this.loadParticipationRepoFilesAtRightCommitFromCacheIfAvailable(); } } - private fetchParticipationRepoFilesAtLeftCommit() { - this.participationRepoFilesAtLeftCommitSubscription = this.programmingExerciseParticipationService - .getParticipationRepositoryFilesWithContentAtCommit(this.report.participationIdForLeftCommit!, this.report.leftCommitHash!) - .subscribe({ - next: (filesWithContent: Map) => { - this.leftCommitFileContentByPath = filesWithContent; - this.cachedRepositoryFiles.set(this.report.leftCommitHash!, filesWithContent); - this.cachedRepositoryFilesService.emitCachedRepositoryFiles(this.cachedRepositoryFiles); - this.loadParticipationRepoFilesAtRightCommitFromCacheIfAvailable(); - }, - error: () => { - this.errorWhileFetchingRepos = true; - }, - }); + private async fetchParticipationRepoFilesAtLeftCommit(): Promise { + try { + const filesWithContent = + (await firstValueFrom( + this.programmingExerciseParticipationService.getParticipationRepositoryFilesWithContentAtCommit( + this.report().participationIdForLeftCommit!, + this.report().leftCommitHash!, + ), + )) ?? new Map(); + this.leftCommitFileContentByPath.set(filesWithContent); + this.cachedRepositoryFiles().set(this.report().leftCommitHash!, filesWithContent); + this.cachedRepositoryFilesService.emitCachedRepositoryFiles(this.cachedRepositoryFiles()); + await this.loadParticipationRepoFilesAtRightCommitFromCacheIfAvailable(); + } catch (e) { + this.errorWhileFetchingRepos.set(true); + } } - private loadTemplateRepoFilesFromCacheIfAvailable() { + private async loadTemplateRepoFilesFromCacheIfAvailable(): Promise { const key = this.calculateTemplateMapKey(); - if (this.cachedRepositoryFiles.has(key)) { - this.leftCommitFileContentByPath = this.cachedRepositoryFiles.get(key)!; + if (this.cachedRepositoryFiles().has(key)) { + this.leftCommitFileContentByPath.set(this.cachedRepositoryFiles().get(key)!); } else { - this.fetchTemplateRepoFiles(); + await this.fetchTemplateRepoFiles(); } } - private loadParticipationRepoFilesAtRightCommitFromCacheIfAvailable() { - const key = this.report.rightCommitHash!; - if (this.cachedRepositoryFiles.has(key)) { - this.rightCommitFileContentByPath = this.cachedRepositoryFiles.get(key)!; + private async loadParticipationRepoFilesAtRightCommitFromCacheIfAvailable(): Promise { + const key = this.report().rightCommitHash!; + if (this.cachedRepositoryFiles().has(key)) { + this.rightCommitFileContentByPath.set(this.cachedRepositoryFiles().get(key)!); } else { - this.fetchParticipationRepoFilesAtRightCommit(); + await this.fetchParticipationRepoFilesAtRightCommit(); } } - private fetchTemplateRepoFiles() { + private async fetchTemplateRepoFiles(): Promise { const key = this.calculateTemplateMapKey(); - this.templateRepoFilesSubscription = this.programmingExerciseService.getTemplateRepositoryTestFilesWithContent(this.report.programmingExercise.id!).subscribe({ - next: (response: Map) => { - this.leftCommitFileContentByPath = response; - this.cachedRepositoryFiles.set(key, response); - this.cachedRepositoryFilesService.emitCachedRepositoryFiles(this.cachedRepositoryFiles); - }, - error: () => { - this.errorWhileFetchingRepos = true; - }, - }); + try { + const response = + (await firstValueFrom(this.programmingExerciseService.getTemplateRepositoryTestFilesWithContent(this.report().programmingExercise.id!))) ?? + new Map(); + this.leftCommitFileContentByPath.set(response); + this.cachedRepositoryFiles().set(key, response); + this.cachedRepositoryFilesService.emitCachedRepositoryFiles(this.cachedRepositoryFiles()); + } catch (e) { + this.errorWhileFetchingRepos.set(true); + } } - private fetchParticipationRepoFilesAtRightCommit() { - this.participationRepoFilesAtRightCommitSubscription = this.programmingExerciseParticipationService - .getParticipationRepositoryFilesWithContentAtCommit(this.report.participationIdForRightCommit!, this.report.rightCommitHash!) - .subscribe({ - next: (filesWithContent: Map) => { - this.rightCommitFileContentByPath = filesWithContent; - this.cachedRepositoryFiles.set(this.report.rightCommitHash!, filesWithContent); - this.cachedRepositoryFilesService.emitCachedRepositoryFiles(this.cachedRepositoryFiles); - }, - error: () => { - this.errorWhileFetchingRepos = true; - }, - }); + private async fetchParticipationRepoFilesAtRightCommit(): Promise { + try { + const filesWithContent = + (await firstValueFrom( + this.programmingExerciseParticipationService.getParticipationRepositoryFilesWithContentAtCommit( + this.report().participationIdForRightCommit!, + this.report().rightCommitHash!, + ), + )) ?? new Map(); + this.rightCommitFileContentByPath.set(filesWithContent); + this.cachedRepositoryFiles().set(this.report().rightCommitHash!, filesWithContent); + this.cachedRepositoryFilesService.emitCachedRepositoryFiles(this.cachedRepositoryFiles()); + } catch (e) { + this.errorWhileFetchingRepos.set(true); + } } close(): void { @@ -146,6 +150,6 @@ export class GitDiffReportModalComponent implements OnInit, OnDestroy { } private calculateTemplateMapKey() { - return this.report.programmingExercise.id! + '-template'; + return this.report().programmingExercise.id! + '-template'; } } diff --git a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report.component.html b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report.component.html index 9f6cfb6f1867..fbf8d6863357 100644 --- a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report.component.html +++ b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report.component.html @@ -1,18 +1,18 @@

- @if (isRepositoryView && leftCommit) { - @if (diffForTemplateAndEmptyRepository) { + @if (isRepositoryView() && leftCommit()) { + @if (diffForTemplateAndEmptyRepository()) { {{ 'artemisApp.programmingExercise.diffReport.emptyRepository' | artemisTranslate }} } @else { {{ 'artemisApp.programmingExercise.diffReport.previousCommit' | artemisTranslate }} - {{ leftCommit }} + {{ leftCommit() }} } } @else { {{ - (diffForTemplateAndSolution || !report.participationIdForLeftCommit + (diffForTemplateAndSolution() || !report().participationIdForLeftCommit ? 'artemisApp.programmingExercise.diffReport.template' : 'artemisApp.programmingExercise.diffReport.previousSubmission' ) | artemisTranslate @@ -22,18 +22,18 @@

- @if (isRepositoryView && rightCommit) { - @if (diffForTemplateAndEmptyRepository) { + @if (isRepositoryView() && rightCommit()) { + @if (diffForTemplateAndEmptyRepository()) { {{ 'artemisApp.programmingExercise.diffReport.template' | artemisTranslate }} } @else { {{ 'artemisApp.programmingExercise.diffReport.currentCommit' | artemisTranslate }} - {{ rightCommit }} + {{ rightCommit() }} } } @else { {{ - (diffForTemplateAndSolution ? 'artemisApp.programmingExercise.diffReport.solution' : 'artemisApp.programmingExercise.diffReport.currentSubmission') + (diffForTemplateAndSolution() ? 'artemisApp.programmingExercise.diffReport.solution' : 'artemisApp.programmingExercise.diffReport.currentSubmission') | artemisTranslate }} } @@ -46,15 +46,16 @@

[btnSize]="ButtonSize.SMALL" [icon]="faTableColumns" tooltip="artemisApp.programmingExercise.diffReport.splitView.tooltip" - [title]="'artemisApp.programmingExercise.diffReport.splitView.' + (allowSplitView ? 'disable' : 'enable')" - (onClick)="allowSplitView = !allowSplitView" + [tooltipPlacement]="TooltipPlacement.BOTTOM" + [title]="'artemisApp.programmingExercise.diffReport.splitView.' + (allowSplitView() ? 'disable' : 'enable')" + (onClick)="allowSplitView.set(!allowSplitView())" />

-
- @for (diffInformation of diffInformationForPaths; track diffInformation) { +
+ @for (diffInformation of diffInformationForPaths(); track diffInformation) {
}
- @if (nothingToDisplay) { + @if (nothingToDisplay()) {
- } @else if (!allDiffsReady) { + } @else if (!allDiffsReady()) {
diff --git a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report.component.ts b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report.component.ts index 87f30aade34a..cc916e5daf93 100644 --- a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report.component.ts +++ b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report.component.ts @@ -1,8 +1,12 @@ -import { Component, Input, OnInit } from '@angular/core'; +import { ChangeDetectionStrategy, Component, computed, effect, input, signal, untracked } from '@angular/core'; import { ProgrammingExerciseGitDiffReport } from 'app/entities/hestia/programming-exercise-git-diff-report.model'; import { ProgrammingExerciseGitDiffEntry } from 'app/entities/hestia/programming-exercise-git-diff-entry.model'; import { faSpinner, faTableColumns } from '@fortawesome/free-solid-svg-icons'; -import { ButtonSize, ButtonType } from 'app/shared/components/button.component'; +import { ButtonSize, ButtonType, TooltipPlacement } from 'app/shared/components/button.component'; +import { GitDiffLineStatComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-line-stat.component'; +import { ArtemisSharedComponentModule } from 'app/shared/components/shared-component.module'; +import { ArtemisSharedModule } from 'app/shared/shared.module'; +import { GitDiffFilePanelComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-file-panel.component'; interface DiffInformation { path: string; @@ -15,49 +19,27 @@ interface DiffInformation { @Component({ selector: 'jhi-git-diff-report', templateUrl: './git-diff-report.component.html', + standalone: true, + changeDetection: ChangeDetectionStrategy.OnPush, + imports: [GitDiffLineStatComponent, ArtemisSharedModule, ArtemisSharedComponentModule, GitDiffFilePanelComponent], }) -export class GitDiffReportComponent implements OnInit { - @Input() report: ProgrammingExerciseGitDiffReport; - - @Input() templateFileContentByPath: Map; - - @Input() solutionFileContentByPath: Map; - - @Input() filePaths: string[]; - - @Input() diffForTemplateAndSolution = true; - - @Input() diffForTemplateAndEmptyRepository = false; - - @Input() isRepositoryView = false; - - leftCommit: string | undefined; - - rightCommit: string | undefined; - - entries: ProgrammingExerciseGitDiffEntry[]; - entriesByPath: Map; - addedLineCount: number; - removedLineCount: number; - diffInformationForPaths: DiffInformation[] = []; - allDiffsReady = false; - nothingToDisplay = false; - allowSplitView = true; - renamedFilePaths: { [before: string]: string | undefined } = {}; - - faSpinner = faSpinner; - faTableColumns = faTableColumns; - - // Expose to template +export class GitDiffReportComponent { + protected readonly faSpinner = faSpinner; + protected readonly faTableColumns = faTableColumns; protected readonly ButtonSize = ButtonSize; protected readonly ButtonType = ButtonType; - - constructor() {} - - ngOnInit(): void { - // Sort the diff entries by file path and start lines - this.entries = - this.report.entries?.sort((a, b) => { + protected readonly TooltipPlacement = TooltipPlacement; + + readonly report = input.required(); + readonly templateFileContentByPath = input.required>(); + readonly solutionFileContentByPath = input.required>(); + readonly diffForTemplateAndSolution = input(true); + readonly diffForTemplateAndEmptyRepository = input(false); + readonly isRepositoryView = input(false); + + readonly sortedEntries = computed(() => { + return ( + this.report().entries?.sort((a, b) => { const filePathA = a.filePath ?? a.previousFilePath ?? ''; const filePathB = b.filePath ?? b.previousFilePath ?? ''; if (filePathA < filePathB) { @@ -67,65 +49,91 @@ export class GitDiffReportComponent implements OnInit { return 1; } return (a.startLine ?? a.previousStartLine ?? 0) - (b.startLine ?? b.previousStartLine ?? 0); - }) ?? []; + }) ?? [] + ); + }); - this.addedLineCount = this.entries + readonly addedLineCount = computed(() => { + return this.sortedEntries() .flatMap((entry) => { if (entry && entry.filePath && entry.startLine && entry.lineCount) { - return this.solutionFileContentByPath + return this.solutionFileContentByPath() .get(entry.filePath) ?.split('\n') .slice(entry.startLine - 1, entry.startLine + entry.lineCount - 1); } }) .filter((line) => line && line.trim().length !== 0).length; + }); - this.removedLineCount = this.entries + readonly removedLineCount = computed(() => { + return this.sortedEntries() .flatMap((entry) => { if (entry && entry.previousFilePath && entry.previousStartLine && entry.previousLineCount) { - return this.templateFileContentByPath + return this.templateFileContentByPath() .get(entry.previousFilePath!) ?.split('\n') .slice(entry.previousStartLine - 1, entry.previousStartLine + entry.previousLineCount - 1); } }) .filter((line) => line && line.trim().length !== 0).length; + }); + + readonly filePaths = computed(() => { + return [...new Set([...this.templateFileContentByPath().keys(), ...this.solutionFileContentByPath().keys()])].sort(); + }); - // Create a set of all file paths - this.filePaths = [...new Set([...this.templateFileContentByPath.keys(), ...this.solutionFileContentByPath.keys()])].sort(); - // Track renamed files - this.entries.forEach((entry) => { + readonly renamedFilePaths = computed(() => { + const renamedFilePaths: { [before: string]: string | undefined } = {}; + this.sortedEntries().forEach((entry) => { // Accounts only for files that have existed in the original and the modified version, but under different names if (entry.filePath && entry.previousFilePath && entry.filePath !== entry.previousFilePath) { - this.renamedFilePaths[entry.filePath] = entry.previousFilePath; + renamedFilePaths[entry.filePath] = entry.previousFilePath; } }); - // Group the diff entries by file path - this.entriesByPath = new Map(); - [...this.templateFileContentByPath.keys()].forEach((filePath) => { - this.entriesByPath.set( + return renamedFilePaths; + }); + + readonly entriesByPath = computed(() => { + const entriesByPath = new Map(); + [...this.templateFileContentByPath().keys()].forEach((filePath) => { + entriesByPath.set( filePath, - this.entries.filter((entry) => entry.previousFilePath === filePath && !entry.filePath), + this.sortedEntries().filter((entry) => entry.previousFilePath === filePath && !entry.filePath), ); }); - [...this.solutionFileContentByPath.keys()].forEach((filePath) => { - this.entriesByPath.set( + [...this.solutionFileContentByPath().keys()].forEach((filePath) => { + entriesByPath.set( filePath, - this.entries.filter((entry) => entry.filePath === filePath), + this.sortedEntries().filter((entry) => entry.filePath === filePath), ); }); - this.leftCommit = this.report.leftCommitHash?.substring(0, 10); - this.rightCommit = this.report.rightCommitHash?.substring(0, 10); - this.diffInformationForPaths = this.filePaths - .filter((path) => this.entriesByPath.get(path)?.length) - .map((path) => { - // entries is not undefined due to the filter - const entries = this.entriesByPath.get(path)!; - const templateFileContent = this.templateFileContentByPath.get(this.renamedFilePaths[path] ?? path); - const solutionFileContent = this.solutionFileContentByPath.get(path); - return { path, entries, templateFileContent, solutionFileContent, diffReady: false }; + return entriesByPath; + }); + + readonly leftCommit = computed(() => this.report().leftCommitHash?.substring(0, 10)); + readonly rightCommit = computed(() => this.report().rightCommitHash?.substring(0, 10)); + readonly diffInformationForPaths = signal([]); + readonly nothingToDisplay = computed(() => this.diffInformationForPaths().length === 0); + readonly allDiffsReady = computed(() => Object.values(this.diffInformationForPaths()).every((info) => info.diffReady)); + readonly allowSplitView = signal(true); + + constructor() { + effect(() => { + untracked(() => { + this.diffInformationForPaths.set( + this.filePaths() + .filter((path) => this.entriesByPath().get(path)?.length) + .map((path) => { + // entries is not undefined due to the filter above + const entries = this.entriesByPath().get(path)!; + const templateFileContent = this.templateFileContentByPath().get(this.renamedFilePaths()[path] ?? path); + const solutionFileContent = this.solutionFileContentByPath().get(path); + return { path, entries, templateFileContent, solutionFileContent, diffReady: false }; + }), + ); }); - this.nothingToDisplay = this.diffInformationForPaths.length === 0; + }); } /** @@ -135,10 +143,11 @@ export class GitDiffReportComponent implements OnInit { * @param ready Whether the diff is ready to be displayed or not. */ onDiffReady(path: string, ready: boolean) { - const index = this.diffInformationForPaths.findIndex((info) => info.path === path); + const diffInformation = [...this.diffInformationForPaths()]; + const index = diffInformation.findIndex((info) => info.path === path); if (index !== -1) { - this.diffInformationForPaths[index].diffReady = ready; - this.allDiffsReady = Object.values(this.diffInformationForPaths).every((info) => info.diffReady); + diffInformation[index].diffReady = ready; + this.diffInformationForPaths.set(diffInformation); } else { console.error(`Received diff ready event for unknown path: ${path}`); } diff --git a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report.module.ts b/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report.module.ts deleted file mode 100644 index 17b5682de4cb..000000000000 --- a/src/main/webapp/app/exercises/programming/hestia/git-diff-report/git-diff-report.module.ts +++ /dev/null @@ -1,18 +0,0 @@ -import { NgModule } from '@angular/core'; -import { ArtemisSharedModule } from 'app/shared/shared.module'; -import { GitDiffLineStatComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-line-stat.component'; -import { GitDiffReportComponent } from './git-diff-report.component'; -import { GitDiffFileComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-file.component'; -import { GitDiffReportModalComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-report-modal.component'; -import { GitDiffFilePanelComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-file-panel.component'; -import { NgbAccordionModule } from '@ng-bootstrap/ng-bootstrap'; -import { GitDiffFilePanelTitleComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-file-panel-title.component'; -import { ArtemisSharedComponentModule } from 'app/shared/components/shared-component.module'; -import { MonacoDiffEditorComponent } from 'app/shared/monaco-editor/monaco-diff-editor.component'; - -@NgModule({ - imports: [ArtemisSharedModule, NgbAccordionModule, MonacoDiffEditorComponent, ArtemisSharedComponentModule], - declarations: [GitDiffFilePanelComponent, GitDiffFilePanelTitleComponent, GitDiffReportComponent, GitDiffFileComponent, GitDiffReportModalComponent, GitDiffLineStatComponent], - exports: [GitDiffReportComponent, GitDiffReportModalComponent, GitDiffLineStatComponent], -}) -export class GitDiffReportModule {} diff --git a/src/main/webapp/app/exercises/programming/manage/programming-exercise-management.module.ts b/src/main/webapp/app/exercises/programming/manage/programming-exercise-management.module.ts index ce2056d24a44..7340599252c5 100644 --- a/src/main/webapp/app/exercises/programming/manage/programming-exercise-management.module.ts +++ b/src/main/webapp/app/exercises/programming/manage/programming-exercise-management.module.ts @@ -19,7 +19,6 @@ import { ArtemisPlagiarismModule } from 'app/exercises/shared/plagiarism/plagiar import { ArtemisProgrammingExerciseLifecycleModule } from 'app/exercises/programming/shared/lifecycle/programming-exercise-lifecycle.module'; import { ProgrammingExerciseInstructorExerciseDownloadComponent } from '../shared/actions/programming-exercise-instructor-exercise-download.component'; import { SubmissionResultStatusModule } from 'app/overview/submission-result-status.module'; -import { GitDiffReportModule } from 'app/exercises/programming/hestia/git-diff-report/git-diff-report.module'; import { ProgrammingExerciseExampleSolutionRepoDownloadComponent } from 'app/exercises/programming/shared/actions/programming-exercise-example-solution-repo-download.component'; import { TestwiseCoverageReportModule } from 'app/exercises/programming/hestia/testwise-coverage-report/testwise-coverage-report.module'; import { ArtemisCodeHintGenerationOverviewModule } from 'app/exercises/programming/hestia/generation-overview/code-hint-generation-overview/code-hint-generation-overview.module'; @@ -49,7 +48,6 @@ import { MonacoEditorComponent } from 'app/shared/monaco-editor/monaco-editor.co OrionModule, ArtemisProgrammingExerciseLifecycleModule, SubmissionResultStatusModule, - GitDiffReportModule, TestwiseCoverageReportModule, ArtemisCodeHintGenerationOverviewModule, ArtemisCodeEditorModule, diff --git a/src/main/webapp/app/exercises/programming/participate/programming-repository.module.ts b/src/main/webapp/app/exercises/programming/participate/programming-repository.module.ts index c1b68191f38a..d90997bc2ccd 100644 --- a/src/main/webapp/app/exercises/programming/participate/programming-repository.module.ts +++ b/src/main/webapp/app/exercises/programming/participate/programming-repository.module.ts @@ -18,8 +18,8 @@ import { FormsModule } from '@angular/forms'; import { ArtemisProgrammingExerciseModule } from 'app/exercises/programming/shared/programming-exercise.module'; import { CommitHistoryComponent } from 'app/localvc/commit-history/commit-history.component'; import { CommitDetailsViewComponent } from 'app/localvc/commit-details-view/commit-details-view.component'; -import { GitDiffReportModule } from 'app/exercises/programming/hestia/git-diff-report/git-diff-report.module'; import { ArtemisProgrammingExerciseActionsModule } from 'app/exercises/programming/shared/actions/programming-exercise-actions.module'; +import { GitDiffReportComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-report.component'; @NgModule({ imports: [ @@ -39,8 +39,8 @@ import { ArtemisProgrammingExerciseActionsModule } from 'app/exercises/programmi ArtemisHeaderExercisePageWithDetailsModule, SubmissionResultStatusModule, ArtemisProgrammingExerciseModule, - GitDiffReportModule, ArtemisProgrammingExerciseActionsModule, + GitDiffReportComponent, ], declarations: [RepositoryViewComponent, CommitHistoryComponent, CommitDetailsViewComponent], exports: [RepositoryViewComponent], diff --git a/src/main/webapp/app/shared/monaco-editor/monaco-diff-editor.component.scss b/src/main/webapp/app/shared/monaco-editor/monaco-diff-editor.component.scss index 85f7d08ca87a..34b221d82d90 100644 --- a/src/main/webapp/app/shared/monaco-editor/monaco-diff-editor.component.scss +++ b/src/main/webapp/app/shared/monaco-editor/monaco-diff-editor.component.scss @@ -1,3 +1,12 @@ +.diff-editor-container { + .monaco-diff-editor { + .monaco-editor { + // Disables the focus border around the editor. + outline: none; + } + } +} + /* * Hide the drag handles of the hidden lines, as this feature would result in unintuitive behavior. */ diff --git a/src/main/webapp/app/shared/monaco-editor/monaco-diff-editor.component.ts b/src/main/webapp/app/shared/monaco-editor/monaco-diff-editor.component.ts index 8cb86be9a233..bd234e45cdec 100644 --- a/src/main/webapp/app/shared/monaco-editor/monaco-diff-editor.component.ts +++ b/src/main/webapp/app/shared/monaco-editor/monaco-diff-editor.component.ts @@ -1,4 +1,4 @@ -import { ChangeDetectionStrategy, Component, ElementRef, OnDestroy, OnInit, Renderer2, ViewEncapsulation, effect, inject, input, output } from '@angular/core'; +import { ChangeDetectionStrategy, Component, ElementRef, OnDestroy, Renderer2, ViewEncapsulation, effect, inject, input, output } from '@angular/core'; import * as monaco from 'monaco-editor'; import { Disposable } from 'app/shared/monaco-editor/model/actions/monaco-editor.util'; @@ -13,7 +13,7 @@ export type MonacoEditorDiffText = { original: string; modified: string }; changeDetection: ChangeDetectionStrategy.OnPush, encapsulation: ViewEncapsulation.None, }) -export class MonacoDiffEditorComponent implements OnInit, OnDestroy { +export class MonacoDiffEditorComponent implements OnDestroy { private _editor: monaco.editor.IStandaloneDiffEditor; monacoDiffEditorContainerElement: HTMLElement; @@ -24,7 +24,6 @@ export class MonacoDiffEditorComponent implements OnInit, OnDestroy { * Subscriptions and listeners that need to be disposed of when this component is destroyed. */ listeners: Disposable[] = []; - resizeObserver?: ResizeObserver; /* * Injected services and elements. @@ -42,6 +41,7 @@ export class MonacoDiffEditorComponent implements OnInit, OnDestroy { this.monacoDiffEditorContainerElement = this.renderer.createElement('div'); this._editor = this.monacoEditorService.createStandaloneDiffEditor(this.monacoDiffEditorContainerElement); this.renderer.appendChild(this.elementRef.nativeElement, this.monacoDiffEditorContainerElement); + this.renderer.addClass(this.monacoDiffEditorContainerElement, 'diff-editor-container'); this.setupDiffListener(); this.setupContentHeightListeners(); @@ -52,15 +52,7 @@ export class MonacoDiffEditorComponent implements OnInit, OnDestroy { }); } - ngOnInit(): void { - this.resizeObserver = new ResizeObserver(() => { - this.layout(); - }); - this.resizeObserver.observe(this.monacoDiffEditorContainerElement); - } - ngOnDestroy(): void { - this.resizeObserver?.disconnect(); this.listeners.forEach((listener) => { listener.dispose(); }); @@ -73,7 +65,7 @@ export class MonacoDiffEditorComponent implements OnInit, OnDestroy { */ setupDiffListener(): void { const diffListener = this._editor.onDidUpdateDiff(() => { - this.adjustHeightAndLayout(this.getMaximumContentHeight()); + this.adjustContainerHeight(this.getMaximumContentHeight()); this.onReadyForDisplayChange.emit(true); }); @@ -91,13 +83,13 @@ export class MonacoDiffEditorComponent implements OnInit, OnDestroy { const contentSizeListener = editor.onDidContentSizeChange((e: monaco.editor.IContentSizeChangedEvent) => { if (e.contentHeightChanged) { // Using the content height of the larger editor here ensures that neither of the editors break out of the container. - this.adjustHeightAndLayout(this.getMaximumContentHeight()); + this.adjustContainerHeight(this.getMaximumContentHeight()); } }); // Called when the user reveals or collapses a hidden region. const hiddenAreaListener = editor.onDidChangeHiddenAreas(() => { - this.adjustHeightAndLayout(this.getContentHeightOfEditor(editor)); + this.adjustContainerHeight(this.getContentHeightOfEditor(editor)); }); this.listeners.push(contentSizeListener, hiddenAreaListener); @@ -105,21 +97,11 @@ export class MonacoDiffEditorComponent implements OnInit, OnDestroy { } /** - * Adjusts the height of the editor to fit the new content height. + * Adjusts the height of the editor's container to fit the new content height. * @param newContentHeight The new content height of the editor. */ - adjustHeightAndLayout(newContentHeight: number) { + adjustContainerHeight(newContentHeight: number) { this.monacoDiffEditorContainerElement.style.height = newContentHeight + 'px'; - this.layout(); - } - - /** - * Adjusts this editor to fit its container. - */ - layout(): void { - const width = this.monacoDiffEditorContainerElement.clientWidth; - const height = this.monacoDiffEditorContainerElement.clientHeight; - this._editor.layout({ width, height }); } /** diff --git a/src/main/webapp/app/shared/monaco-editor/monaco-editor.service.ts b/src/main/webapp/app/shared/monaco-editor/monaco-editor.service.ts index 0d00d81300a3..b16cb7cf6b18 100644 --- a/src/main/webapp/app/shared/monaco-editor/monaco-editor.service.ts +++ b/src/main/webapp/app/shared/monaco-editor/monaco-editor.service.ts @@ -61,6 +61,7 @@ export class MonacoEditorService { */ createStandaloneDiffEditor(domElement: HTMLElement): monaco.editor.IStandaloneDiffEditor { return monaco.editor.createDiffEditor(domElement, { + automaticLayout: true, glyphMargin: true, minimap: { enabled: false }, readOnly: true, diff --git a/src/test/javascript/spec/component/exam/manage/programming-exam-diff.component.spec.ts b/src/test/javascript/spec/component/exam/manage/programming-exam-diff.component.spec.ts index cb10c66e1574..3a0d9d6e640c 100644 --- a/src/test/javascript/spec/component/exam/manage/programming-exam-diff.component.spec.ts +++ b/src/test/javascript/spec/component/exam/manage/programming-exam-diff.component.spec.ts @@ -83,7 +83,7 @@ describe('ProgrammingExerciseExamDiffComponent', () => { const modalServiceSpy = jest.spyOn(modal, 'open'); component.exercise = { id: 1 } as ProgrammingExercise; component.showGitDiff(); - expect(modalServiceSpy).toHaveBeenCalledExactlyOnceWith(GitDiffReportModalComponent, { size: 'xl' }); + expect(modalServiceSpy).toHaveBeenCalledExactlyOnceWith(GitDiffReportModalComponent, { windowClass: GitDiffReportModalComponent.WINDOW_CLASS }); }); it('should use reports from cache if available', fakeAsync(() => { diff --git a/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-file-panel-title.component.spec.ts b/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-file-panel-title.component.spec.ts index 3dc633eb4b50..86380ebed0a7 100644 --- a/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-file-panel-title.component.spec.ts +++ b/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-file-panel-title.component.spec.ts @@ -22,34 +22,34 @@ describe('GitDiffFilePanelTitleComponent', () => { it.each([ { - filePath: 'some-unchanged-file.java', - previousFilePath: 'some-unchanged-file.java', + modifiedFilePath: 'some-unchanged-file.java', + originalFilePath: 'some-unchanged-file.java', status: 'unchanged', title: 'some-unchanged-file.java', }, { - filePath: undefined, - previousFilePath: 'some-deleted-file.java', + modifiedFilePath: undefined, + originalFilePath: 'some-deleted-file.java', status: 'deleted', title: 'some-deleted-file.java', }, { - filePath: 'some-created-file.java', - previousFilePath: undefined, + modifiedFilePath: 'some-created-file.java', + originalFilePath: undefined, status: 'created', title: 'some-created-file.java', }, { - filePath: 'some-renamed-file.java', - previousFilePath: 'some-file.java', + modifiedFilePath: 'some-renamed-file.java', + originalFilePath: 'some-file.java', status: 'renamed', title: 'some-file.java → some-renamed-file.java', }, - ])('should correctly set title and status', ({ filePath, previousFilePath, status, title }) => { - comp.previousFilePath = previousFilePath; - comp.filePath = filePath; + ])('should correctly set title and status', ({ originalFilePath, modifiedFilePath, status, title }) => { + fixture.componentRef.setInput('originalFilePath', originalFilePath); + fixture.componentRef.setInput('modifiedFilePath', modifiedFilePath); fixture.detectChanges(); - expect(comp.title).toBe(title); - expect(comp.fileStatus).toBe(status); + expect(comp.title()).toBe(title); + expect(comp.fileStatus()).toBe(status); }); }); diff --git a/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-file-panel.component.spec.ts b/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-file-panel.component.spec.ts index d4938caea953..26627dba3e8f 100644 --- a/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-file-panel.component.spec.ts +++ b/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-file-panel.component.spec.ts @@ -1,29 +1,27 @@ import { ArtemisTestModule } from '../../../test.module'; import { ComponentFixture, TestBed } from '@angular/core/testing'; -import { ArtemisTranslatePipe } from 'app/shared/pipes/artemis-translate.pipe'; -import { MockComponent, MockDirective, MockPipe } from 'ng-mocks'; +import { MockComponent, MockDirective } from 'ng-mocks'; import { GitDiffLineStatComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-line-stat.component'; import { ProgrammingExerciseGitDiffEntry } from 'app/entities/hestia/programming-exercise-git-diff-entry.model'; import { GitDiffFilePanelComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-file-panel.component'; -import { DeleteButtonDirective } from 'app/shared/delete-dialog/delete-button.directive'; import { NgbAccordionBody, NgbAccordionButton, NgbAccordionCollapse, NgbAccordionDirective, NgbAccordionHeader, NgbAccordionItem } from '@ng-bootstrap/ng-bootstrap'; import { GitDiffFileComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-file.component'; import { GitDiffFilePanelTitleComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-file-panel-title.component'; +import { MonacoDiffEditorComponent } from '../../../../../../main/webapp/app/shared/monaco-editor/monaco-diff-editor.component'; -describe('ProgrammingExerciseGitDiffFilePanel Component', () => { +describe('GitDiffFilePanelComponent', () => { let comp: GitDiffFilePanelComponent; let fixture: ComponentFixture; beforeEach(() => { TestBed.configureTestingModule({ - imports: [ArtemisTestModule], + // TODO: We cannot mock GitDiffFileComponent because of https://github.com/help-me-mom/ng-mocks/issues/8634. + imports: [ArtemisTestModule, GitDiffFileComponent], declarations: [ GitDiffFilePanelComponent, - MockPipe(ArtemisTranslatePipe), MockComponent(GitDiffFilePanelTitleComponent), MockComponent(GitDiffLineStatComponent), - MockComponent(GitDiffFileComponent), - MockDirective(DeleteButtonDirective), + MockComponent(MonacoDiffEditorComponent), MockDirective(NgbAccordionDirective), MockDirective(NgbAccordionItem), MockDirective(NgbAccordionHeader), @@ -35,8 +33,8 @@ describe('ProgrammingExerciseGitDiffFilePanel Component', () => { }).compileComponents(); fixture = TestBed.createComponent(GitDiffFilePanelComponent); comp = fixture.componentInstance; - comp.templateFileContent = 'L1\nL2\nL3\nL4\nL5\nL6\nL7\nL8\nL9\nL10\nL11\nL12\nL13\nL14\nL15\nL16'; - comp.solutionFileContent = 'L1\nL2\nL3\nL4\nL5\nL6\nL7\nL8\nL9\nL10\nL11\nL12\nL13\nL14\nL15\nL16'; + fixture.componentRef.setInput('originalFileContent', 'L1\nL2\nL3\nL4\nL5\nL6\nL7\nL8\nL9\nL10\nL11\nL12\nL13\nL14\nL15\nL16'); + fixture.componentRef.setInput('modifiedFileContent', 'L1\nL2\nL3\nL4\nL5\nL6\nL7\nL8\nL9\nL10\nL11\nL12\nL13\nL14\nL15\nL16'); }); afterEach(() => { @@ -44,21 +42,21 @@ describe('ProgrammingExerciseGitDiffFilePanel Component', () => { }); it('Should extract file path', () => { - comp.diffEntries = [{ filePath: 'src/a.java', previousFilePath: 'src/b.java' }] as ProgrammingExerciseGitDiffEntry[]; - comp.ngOnInit(); - expect(comp.filePath).toBe('src/a.java'); - expect(comp.previousFilePath).toBe('src/b.java'); + fixture.componentRef.setInput('diffEntries', [{ filePath: 'src/a.java', previousFilePath: 'src/b.java' }] as ProgrammingExerciseGitDiffEntry[]); + fixture.detectChanges(); + expect(comp.modifiedFilePath()).toBe('src/a.java'); + expect(comp.originalFilePath()).toBe('src/b.java'); }); it('Should set added/removed lines to 1-0', () => { - comp.diffEntries = [{ filePath: 'src/a.java', startLine: 1, lineCount: 1 }] as ProgrammingExerciseGitDiffEntry[]; - comp.ngOnInit(); - expect(comp.addedLineCount).toBe(1); - expect(comp.removedLineCount).toBe(0); + fixture.componentRef.setInput('diffEntries', [{ filePath: 'src/a.java', startLine: 1, lineCount: 1 }] as ProgrammingExerciseGitDiffEntry[]); + fixture.detectChanges(); + expect(comp.addedLineCount()).toBe(1); + expect(comp.removedLineCount()).toBe(0); }); it('Should set added/removed lines to 4-1', () => { - comp.diffEntries = [ + fixture.componentRef.setInput('diffEntries', [ { filePath: 'src/a.java', previousFilePath: 'src/a.java', @@ -67,14 +65,14 @@ describe('ProgrammingExerciseGitDiffFilePanel Component', () => { previousStartLine: 5, previousLineCount: 1, }, - ] as ProgrammingExerciseGitDiffEntry[]; - comp.ngOnInit(); - expect(comp.addedLineCount).toBe(4); - expect(comp.removedLineCount).toBe(1); + ] as ProgrammingExerciseGitDiffEntry[]); + fixture.detectChanges(); + expect(comp.addedLineCount()).toBe(4); + expect(comp.removedLineCount()).toBe(1); }); it('Should set added/removed lines to 3-2', () => { - comp.diffEntries = [ + fixture.componentRef.setInput('diffEntries', [ { filePath: 'src/a.java', previousFilePath: 'src/a.java', @@ -83,14 +81,14 @@ describe('ProgrammingExerciseGitDiffFilePanel Component', () => { previousStartLine: 5, previousLineCount: 2, }, - ] as ProgrammingExerciseGitDiffEntry[]; - comp.ngOnInit(); - expect(comp.addedLineCount).toBe(3); - expect(comp.removedLineCount).toBe(2); + ] as ProgrammingExerciseGitDiffEntry[]); + fixture.detectChanges(); + expect(comp.addedLineCount()).toBe(3); + expect(comp.removedLineCount()).toBe(2); }); it('Should set added/removed lines to 2-3', () => { - comp.diffEntries = [ + fixture.componentRef.setInput('diffEntries', [ { filePath: 'src/a.java', previousFilePath: 'src/a.java', @@ -99,14 +97,14 @@ describe('ProgrammingExerciseGitDiffFilePanel Component', () => { previousStartLine: 5, previousLineCount: 3, }, - ] as ProgrammingExerciseGitDiffEntry[]; - comp.ngOnInit(); - expect(comp.addedLineCount).toBe(2); - expect(comp.removedLineCount).toBe(3); + ] as ProgrammingExerciseGitDiffEntry[]); + fixture.detectChanges(); + expect(comp.addedLineCount()).toBe(2); + expect(comp.removedLineCount()).toBe(3); }); it('Should set added/removed lines to 1-4', () => { - comp.diffEntries = [ + fixture.componentRef.setInput('diffEntries', [ { filePath: 'src/a.java', previousFilePath: 'src/a.java', @@ -115,23 +113,23 @@ describe('ProgrammingExerciseGitDiffFilePanel Component', () => { previousStartLine: 5, previousLineCount: 4, }, - ] as ProgrammingExerciseGitDiffEntry[]; - comp.ngOnInit(); - expect(comp.addedLineCount).toBe(1); - expect(comp.removedLineCount).toBe(4); + ] as ProgrammingExerciseGitDiffEntry[]); + fixture.detectChanges(); + expect(comp.addedLineCount()).toBe(1); + expect(comp.removedLineCount()).toBe(4); }); it('Should set added/removed lines to 0-1', () => { - comp.diffEntries = [ + fixture.componentRef.setInput('diffEntries', [ { filePath: 'src/a.java', previousFilePath: 'src/a.java', previousStartLine: 1, previousLineCount: 1, }, - ] as ProgrammingExerciseGitDiffEntry[]; - comp.ngOnInit(); - expect(comp.addedLineCount).toBe(0); - expect(comp.removedLineCount).toBe(1); + ] as ProgrammingExerciseGitDiffEntry[]); + fixture.detectChanges(); + expect(comp.addedLineCount()).toBe(0); + expect(comp.removedLineCount()).toBe(1); }); }); diff --git a/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-file.component.spec.ts b/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-file.component.spec.ts index 47d3e75710b4..17007596e8a8 100644 --- a/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-file.component.spec.ts +++ b/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-file.component.spec.ts @@ -18,7 +18,7 @@ describe('GitDiffFileComponent', () => { beforeEach(() => { TestBed.configureTestingModule({ imports: [ArtemisTestModule, MonacoDiffEditorComponent], - declarations: [GitDiffFileComponent], + declarations: [], providers: [], }).compileComponents(); // Required because Monaco uses the ResizeObserver for the diff editor. @@ -33,28 +33,20 @@ describe('GitDiffFileComponent', () => { jest.restoreAllMocks(); }); - it.each([ - getDiffEntryWithPaths('same file', 'same file'), - getDiffEntryWithPaths('old file', 'renamed file'), - getDiffEntryWithPaths('deleted file', undefined), - getDiffEntryWithPaths(undefined, 'created file'), - ])('should infer file paths from the diff entries', (entry) => { - comp.diffEntries = [entry]; - fixture.detectChanges(); - expect(comp.modifiedFilePath).toBe(entry.filePath); - expect(comp.originalFilePath).toBe(entry.previousFilePath); - }); - it('should initialize the content of the diff editor', () => { const fileName = 'some-changed-file.java'; const originalContent = 'some file content'; const modifiedContent = 'some changed file content'; - const setFileContentsStub = jest.spyOn(comp.monacoDiffEditor, 'setFileContents').mockImplementation(); + const setFileContentsStub = jest.fn(); + jest.spyOn(comp, 'monacoDiffEditor').mockReturnValue({ setFileContents: setFileContentsStub } as unknown as MonacoDiffEditorComponent); const diffEntry = getDiffEntryWithPaths(fileName, fileName); - comp.originalFileContent = originalContent; - comp.modifiedFileContent = modifiedContent; - comp.diffEntries = [diffEntry]; + fixture.componentRef.setInput('diffEntries', [diffEntry]); + fixture.componentRef.setInput('originalFileContent', originalContent); + fixture.componentRef.setInput('originalFilePath', fileName); + fixture.componentRef.setInput('modifiedFileContent', modifiedContent); + fixture.componentRef.setInput('modifiedFilePath', fileName); fixture.detectChanges(); expect(setFileContentsStub).toHaveBeenCalledExactlyOnceWith(originalContent, fileName, modifiedContent, fileName); + expect(comp.fileUnchanged()).toBeFalse(); }); }); diff --git a/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-line-stat.component.spec.ts b/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-line-stat.component.spec.ts index 03a61f184b67..2ea540371804 100644 --- a/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-line-stat.component.spec.ts +++ b/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-line-stat.component.spec.ts @@ -4,7 +4,7 @@ import { GitDiffLineStatComponent } from 'app/exercises/programming/hestia/git-d import { ArtemisTranslatePipe } from 'app/shared/pipes/artemis-translate.pipe'; import { MockPipe } from 'ng-mocks'; -describe('Git-Diff line-stat Component', () => { +describe('GitDiffLineStatComponent', () => { let comp: GitDiffLineStatComponent; let fixture: ComponentFixture; @@ -29,10 +29,10 @@ describe('Git-Diff line-stat Component', () => { ]; it.each(boxesTestTable)('Should show %s-%s boxes', (expectedAddedSquareCount, expectedRemovedSquareCount, addedLineCount, removedLineCount) => { - comp.addedLineCount = addedLineCount; - comp.removedLineCount = removedLineCount; - comp.ngOnInit(); - expect(comp.addedSquareCount).toBe(expectedAddedSquareCount); - expect(comp.removedSquareCount).toBe(expectedRemovedSquareCount); + fixture.componentRef.setInput('addedLineCount', addedLineCount); + fixture.componentRef.setInput('removedLineCount', removedLineCount); + fixture.detectChanges(); + expect(comp.squareCounts().addedSquareCount).toBe(expectedAddedSquareCount); + expect(comp.squareCounts().removedSquareCount).toBe(expectedRemovedSquareCount); }); }); diff --git a/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-modal.component.spec.ts b/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-modal.component.spec.ts index cfae09afae32..7fc9a8693d0e 100644 --- a/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-modal.component.spec.ts +++ b/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-modal.component.spec.ts @@ -1,7 +1,7 @@ import { GitDiffReportComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-report.component'; import { ArtemisTestModule } from '../../../test.module'; import { ArtemisTranslatePipe } from 'app/shared/pipes/artemis-translate.pipe'; -import { ComponentFixture, TestBed, fakeAsync, flush } from '@angular/core/testing'; +import { ComponentFixture, TestBed } from '@angular/core/testing'; import { GitDiffReportModalComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-report-modal.component'; import { ProgrammingExerciseService } from 'app/exercises/programming/manage/services/programming-exercise.service'; import { of, throwError } from 'rxjs'; @@ -32,7 +32,7 @@ describe('GitDiffReportModalComponent', () => { beforeEach(() => { TestBed.configureTestingModule({ imports: [ArtemisTestModule], - declarations: [GitDiffReportModalComponent, MockPipe(ArtemisTranslatePipe), MockComponent(GitDiffReportComponent)], + declarations: [MockPipe(ArtemisTranslatePipe), MockComponent(GitDiffReportComponent)], }).compileComponents(); fixture = TestBed.createComponent(GitDiffReportModalComponent); comp = fixture.componentInstance; @@ -52,68 +52,80 @@ describe('GitDiffReportModalComponent', () => { jest.restoreAllMocks(); }); - it('should call correct service method onInit', fakeAsync(() => { + const finishEffects = async () => { + // We need to wait for all asynchronous code to finish execution before we can expect the results. + // See https://stackoverflow.com/questions/44741102/how-to-make-jest-wait-for-all-asynchronous-code-to-finish-execution-before-expec/51045733#51045733 + await new Promise(process.nextTick); + await fixture.whenStable(); + }; + + it('should call correct service method onInit', async () => { // case 1: diff for template and solution - comp.report = { programmingExercise: { id: 1 }, participationIdForRightCommit: 3, rightCommitHash: 'abc' } as ProgrammingExerciseGitDiffReport; - comp.diffForTemplateAndSolution = true; - comp.ngOnInit(); - flush(); + fixture.componentRef.setInput('report', { programmingExercise: { id: 1 }, participationIdForRightCommit: 3, rightCommitHash: 'abc' } as ProgrammingExerciseGitDiffReport); + fixture.componentRef.setInput('diffForTemplateAndSolution', true); + fixture.detectChanges(); + await finishEffects(); expect(loadTemplateFilesSpy).toHaveBeenCalledExactlyOnceWith(1); expect(loadSolutionFilesSpy).toHaveBeenCalledExactlyOnceWith(1); expect(loadParticipationFilesSpy).not.toHaveBeenCalled(); - expect(comp.leftCommitFileContentByPath).toEqual(filesWithContentTemplate); - expect(comp.rightCommitFileContentByPath).toEqual(filesWithContentSolution); - })); + expect(comp.leftCommitFileContentByPath()).toEqual(filesWithContentTemplate); + expect(comp.rightCommitFileContentByPath()).toEqual(filesWithContentSolution); + }); - it('should retrieve files for template and submission if diffForTemplateAndSolution is false and firstParticipationId is undefined', () => { - comp.report = { programmingExercise: { id: 1 }, participationIdForRightCommit: 3, rightCommitHash: 'abc' } as ProgrammingExerciseGitDiffReport; + it('should retrieve files for template and submission if diffForTemplateAndSolution is false and firstParticipationId is undefined', async () => { + fixture.componentRef.setInput('report', { programmingExercise: { id: 1 }, participationIdForRightCommit: 3, rightCommitHash: 'abc' } as ProgrammingExerciseGitDiffReport); // case 2: diff for submission with template - comp.diffForTemplateAndSolution = false; - comp.ngOnInit(); + fixture.componentRef.setInput('diffForTemplateAndSolution', false); + fixture.detectChanges(); + await finishEffects(); expect(loadParticipationFilesSpy).toHaveBeenCalledExactlyOnceWith(3, 'abc'); expect(loadTemplateFilesSpy).toHaveBeenCalledExactlyOnceWith(1); - expect(comp.leftCommitFileContentByPath).toEqual(filesWithContentTemplate); - expect(comp.rightCommitFileContentByPath).toEqual(filesWithContentParticipation1); + expect(comp.leftCommitFileContentByPath()).toEqual(filesWithContentTemplate); + expect(comp.rightCommitFileContentByPath()).toEqual(filesWithContentParticipation1); }); - it('should retrieve files for both submissions if diffForTemplateAndSolution is false and firstParticipationId is defined', function () { + it('should retrieve files for both submissions if diffForTemplateAndSolution is false and firstParticipationId is defined', async () => { // case 3: diff for two submissions - comp.report = { + fixture.componentRef.setInput('report', { programmingExercise: { id: 1 }, participationIdForRightCommit: 3, rightCommitHash: 'abc', participationIdForLeftCommit: 2, leftCommitHash: 'def', - } as ProgrammingExerciseGitDiffReport; - comp.diffForTemplateAndSolution = false; - comp.ngOnInit(); + } as ProgrammingExerciseGitDiffReport); + fixture.componentRef.setInput('diffForTemplateAndSolution', false); + fixture.detectChanges(); + await finishEffects(); expect(loadParticipationFilesSpy).toHaveBeenCalledTimes(2); expect(loadParticipationFilesSpy).toHaveBeenCalledWith(2, 'def'); expect(loadParticipationFilesSpy).toHaveBeenCalledWith(3, 'abc'); - expect(comp.leftCommitFileContentByPath).toEqual(filesWithContentParticipation1); - expect(comp.rightCommitFileContentByPath).toEqual(filesWithContentParticipation1); + expect(comp.leftCommitFileContentByPath()).toEqual(filesWithContentParticipation1); + expect(comp.rightCommitFileContentByPath()).toEqual(filesWithContentParticipation1); }); - it('should set error flag if loading files fails', () => { + it('should set error flag if loading files fails', async () => { jest.spyOn(programmingExerciseService, 'getTemplateRepositoryTestFilesWithContent').mockReturnValue(throwError('error')); jest.spyOn(programmingExerciseService, 'getSolutionRepositoryTestFilesWithContent').mockReturnValue(throwError('error')); jest.spyOn(programmingExerciseParticipationService, 'getParticipationRepositoryFilesWithContentAtCommit').mockReturnValue(throwError('error')); - comp.report = { programmingExercise: { id: 1 }, participationIdForRightCommit: 3, rightCommitHash: 'abc' } as ProgrammingExerciseGitDiffReport; - comp.diffForTemplateAndSolution = true; - comp.ngOnInit(); - expect(comp.errorWhileFetchingRepos).toBeTrue(); + fixture.componentRef.setInput('report', { programmingExercise: { id: 1 }, participationIdForRightCommit: 3, rightCommitHash: 'abc' } as ProgrammingExerciseGitDiffReport); + fixture.componentRef.setInput('diffForTemplateAndSolution', true); + fixture.detectChanges(); + await fixture.whenStable(); + expect(comp.errorWhileFetchingRepos()).toBeTrue(); //reset value - comp.errorWhileFetchingRepos = false; - comp.diffForTemplateAndSolution = false; - comp.ngOnInit(); - expect(comp.errorWhileFetchingRepos).toBeTrue(); + comp.errorWhileFetchingRepos.set(false); + fixture.componentRef.setInput('diffForTemplateAndSolution', false); + fixture.detectChanges(); + await fixture.whenStable(); + expect(comp.errorWhileFetchingRepos()).toBeTrue(); //reset value - comp.errorWhileFetchingRepos = false; - comp.report = { ...comp.report, participationIdForLeftCommit: 2, leftCommitHash: 'def' } as ProgrammingExerciseGitDiffReport; - comp.ngOnInit(); - expect(comp.errorWhileFetchingRepos).toBeTrue(); + comp.errorWhileFetchingRepos.set(false); + fixture.componentRef.setInput('report', { ...comp.report, participationIdForLeftCommit: 2, leftCommitHash: 'def' } as unknown as ProgrammingExerciseGitDiffReport); + fixture.detectChanges(); + await fixture.whenStable(); + expect(comp.errorWhileFetchingRepos()).toBeTrue(); }); it('should call modal service when close() is invoked', () => { @@ -122,36 +134,38 @@ describe('GitDiffReportModalComponent', () => { expect(modalServiceSpy).toHaveBeenCalled(); }); - it('should load files from cache if available for template and participation repo', () => { + it('should load files from cache if available for template and participation repo', async () => { const cachedRepositoryFiles = new Map>(); cachedRepositoryFiles.set('1-template', filesWithContentTemplate); cachedRepositoryFiles.set('def', filesWithContentParticipation1); - comp.cachedRepositoryFiles = cachedRepositoryFiles; - comp.report = { programmingExercise: { id: 1 }, participationIdForRightCommit: 3, rightCommitHash: 'def' } as ProgrammingExerciseGitDiffReport; - comp.diffForTemplateAndSolution = false; - comp.ngOnInit(); + fixture.componentRef.setInput('cachedRepositoryFiles', cachedRepositoryFiles); + fixture.componentRef.setInput('report', { programmingExercise: { id: 1 }, participationIdForRightCommit: 3, rightCommitHash: 'def' } as ProgrammingExerciseGitDiffReport); + fixture.componentRef.setInput('diffForTemplateAndSolution', false); + fixture.detectChanges(); + await finishEffects(); expect(loadParticipationFilesSpy).not.toHaveBeenCalled(); expect(loadTemplateFilesSpy).not.toHaveBeenCalled(); - expect(comp.leftCommitFileContentByPath).toEqual(filesWithContentTemplate); - expect(comp.rightCommitFileContentByPath).toEqual(filesWithContentParticipation1); + expect(comp.leftCommitFileContentByPath()).toEqual(filesWithContentTemplate); + expect(comp.rightCommitFileContentByPath()).toEqual(filesWithContentParticipation1); }); - it('should load files from cache if available for participation repo at both commits', () => { + it('should load files from cache if available for participation repo at both commits', async () => { const cachedRepositoryFiles = new Map>(); cachedRepositoryFiles.set('def', filesWithContentParticipation1); cachedRepositoryFiles.set('abc', filesWithContentParticipation2); - comp.cachedRepositoryFiles = cachedRepositoryFiles; - comp.report = { + fixture.componentRef.setInput('cachedRepositoryFiles', cachedRepositoryFiles); + fixture.componentRef.setInput('report', { programmingExercise: { id: 1 }, participationIdForRightCommit: 3, rightCommitHash: 'abc', participationIdForLeftCommit: 2, leftCommitHash: 'def', - } as ProgrammingExerciseGitDiffReport; - comp.diffForTemplateAndSolution = false; - comp.ngOnInit(); + } as ProgrammingExerciseGitDiffReport); + fixture.componentRef.setInput('diffForTemplateAndSolution', false); + fixture.detectChanges(); + await finishEffects(); expect(loadParticipationFilesSpy).not.toHaveBeenCalled(); - expect(comp.leftCommitFileContentByPath).toEqual(filesWithContentParticipation1); - expect(comp.rightCommitFileContentByPath).toEqual(filesWithContentParticipation2); + expect(comp.leftCommitFileContentByPath()).toEqual(filesWithContentParticipation1); + expect(comp.rightCommitFileContentByPath()).toEqual(filesWithContentParticipation2); }); }); diff --git a/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-report.component.spec.ts b/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-report.component.spec.ts index 18614f41c481..143c150edc57 100644 --- a/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-report.component.spec.ts +++ b/src/test/javascript/spec/component/hestia/git-diff-report/git-diff-report.component.spec.ts @@ -8,7 +8,6 @@ import { ProgrammingExerciseGitDiffReport } from 'app/entities/hestia/programmin import { ProgrammingExerciseGitDiffEntry } from 'app/entities/hestia/programming-exercise-git-diff-entry.model'; import { NgbTooltipMocksModule } from '../../../helpers/mocks/directive/ngbTooltipMocks.module'; import { GitDiffFilePanelComponent } from 'app/exercises/programming/hestia/git-diff-report/git-diff-file-panel.component'; -import { ButtonComponent } from 'app/shared/components/button.component'; describe('ProgrammingExerciseGitDiffReport Component', () => { let comp: GitDiffReportComponent; @@ -17,19 +16,19 @@ describe('ProgrammingExerciseGitDiffReport Component', () => { beforeEach(() => { TestBed.configureTestingModule({ imports: [ArtemisTestModule, NgbTooltipMocksModule], - declarations: [ - GitDiffReportComponent, - MockComponent(ButtonComponent), - MockPipe(ArtemisTranslatePipe), - MockComponent(GitDiffFilePanelComponent), - MockComponent(GitDiffLineStatComponent), - ], + declarations: [GitDiffReportComponent, MockPipe(ArtemisTranslatePipe), MockComponent(GitDiffFilePanelComponent), MockComponent(GitDiffLineStatComponent)], providers: [], }).compileComponents(); fixture = TestBed.createComponent(GitDiffReportComponent); comp = fixture.componentInstance; - comp.templateFileContentByPath = new Map([['src/a.java', 'L1\nL2\nL3\nL4\nL5\nL6\nL7\nL8\nL9\nL10\nL11\nL12\nL13\nL14\nL15\nL16']]); - comp.solutionFileContentByPath = new Map([['src/a.java', 'L1\nL2\nL3\nL4\nL5\nL6\nL7\nL8\nL9\nL10\nL11\nL12\nL13\nL14\nL15\nL16']]); + fixture.componentRef.setInput( + 'templateFileContentByPath', + new Map([['src/a.java', 'L1\nL2\nL3\nL4\nL5\nL6\nL7\nL8\nL9\nL10\nL11\nL12\nL13\nL14\nL15\nL16']]), + ); + fixture.componentRef.setInput( + 'solutionFileContentByPath', + new Map([['src/a.java', 'L1\nL2\nL3\nL4\nL5\nL6\nL7\nL8\nL9\nL10\nL11\nL12\nL13\nL14\nL15\nL16']]), + ); }); afterEach(() => { @@ -55,18 +54,18 @@ describe('ProgrammingExerciseGitDiffReport Component', () => { { filePath: 'src/b.java', startLine: 2 }, ] as ProgrammingExerciseGitDiffEntry[]; - comp.report = { entries } as ProgrammingExerciseGitDiffReport; - comp.ngOnInit(); - expect(comp.entries).toStrictEqual(expectedEntries); + fixture.componentRef.setInput('report', { entries } as ProgrammingExerciseGitDiffReport); + fixture.detectChanges(); + expect(comp.sortedEntries()).toStrictEqual(expectedEntries); }); it('Should set added/removed lines to 1-0', () => { const entries = [{ filePath: 'src/a.java', previousFilePath: 'src/a.java', startLine: 1, lineCount: 1 }] as ProgrammingExerciseGitDiffEntry[]; - comp.report = { entries } as ProgrammingExerciseGitDiffReport; - comp.ngOnInit(); - expect(comp.addedLineCount).toBe(1); - expect(comp.removedLineCount).toBe(0); + fixture.componentRef.setInput('report', { entries } as ProgrammingExerciseGitDiffReport); + fixture.detectChanges(); + expect(comp.addedLineCount()).toBe(1); + expect(comp.removedLineCount()).toBe(0); }); it('Should set added/removed lines to 4-1', () => { @@ -81,10 +80,10 @@ describe('ProgrammingExerciseGitDiffReport Component', () => { }, ] as ProgrammingExerciseGitDiffEntry[]; - comp.report = { entries } as ProgrammingExerciseGitDiffReport; - comp.ngOnInit(); - expect(comp.addedLineCount).toBe(4); - expect(comp.removedLineCount).toBe(1); + fixture.componentRef.setInput('report', { entries } as ProgrammingExerciseGitDiffReport); + fixture.detectChanges(); + expect(comp.addedLineCount()).toBe(4); + expect(comp.removedLineCount()).toBe(1); }); it('Should set added/removed lines to 3-2', () => { @@ -99,10 +98,10 @@ describe('ProgrammingExerciseGitDiffReport Component', () => { }, ] as ProgrammingExerciseGitDiffEntry[]; - comp.report = { entries } as ProgrammingExerciseGitDiffReport; - comp.ngOnInit(); - expect(comp.addedLineCount).toBe(3); - expect(comp.removedLineCount).toBe(2); + fixture.componentRef.setInput('report', { entries } as ProgrammingExerciseGitDiffReport); + fixture.detectChanges(); + expect(comp.addedLineCount()).toBe(3); + expect(comp.removedLineCount()).toBe(2); }); it('Should set added/removed lines to 2-3', () => { @@ -117,10 +116,10 @@ describe('ProgrammingExerciseGitDiffReport Component', () => { }, ] as ProgrammingExerciseGitDiffEntry[]; - comp.report = { entries } as ProgrammingExerciseGitDiffReport; - comp.ngOnInit(); - expect(comp.addedLineCount).toBe(2); - expect(comp.removedLineCount).toBe(3); + fixture.componentRef.setInput('report', { entries } as ProgrammingExerciseGitDiffReport); + fixture.detectChanges(); + expect(comp.addedLineCount()).toBe(2); + expect(comp.removedLineCount()).toBe(3); }); it('Should set added/removed lines to 1-4', () => { @@ -135,19 +134,19 @@ describe('ProgrammingExerciseGitDiffReport Component', () => { }, ] as ProgrammingExerciseGitDiffEntry[]; - comp.report = { entries } as ProgrammingExerciseGitDiffReport; - comp.ngOnInit(); - expect(comp.addedLineCount).toBe(1); - expect(comp.removedLineCount).toBe(4); + fixture.componentRef.setInput('report', { entries } as ProgrammingExerciseGitDiffReport); + fixture.detectChanges(); + expect(comp.addedLineCount()).toBe(1); + expect(comp.removedLineCount()).toBe(4); }); it('Should set added/removed lines to 0-1', () => { const entries = [{ filePath: 'src/a.java', previousFilePath: 'src/a.java', previousStartLine: 1, previousLineCount: 1 }] as ProgrammingExerciseGitDiffEntry[]; - comp.report = { entries } as ProgrammingExerciseGitDiffReport; - comp.ngOnInit(); - expect(comp.addedLineCount).toBe(0); - expect(comp.removedLineCount).toBe(1); + fixture.componentRef.setInput('report', { entries } as ProgrammingExerciseGitDiffReport); + fixture.detectChanges(); + expect(comp.addedLineCount()).toBe(0); + expect(comp.removedLineCount()).toBe(1); }); it('should record for each path whether the diff is ready', () => { @@ -161,26 +160,30 @@ describe('ProgrammingExerciseGitDiffReport Component', () => { { filePath: 'src/b.java', startLine: 2 }, { filePath: 'src/a.java', startLine: 1 }, ]; - comp.solutionFileContentByPath = new Map(); - comp.solutionFileContentByPath.set(filePath1, 'some file content'); - comp.solutionFileContentByPath.set(filePath2, 'some other file content'); - comp.templateFileContentByPath = comp.solutionFileContentByPath; - comp.report = { entries } as ProgrammingExerciseGitDiffReport; + fixture.componentRef.setInput( + 'solutionFileContentByPath', + new Map([ + ['src/a.java', 'some file content'], + ['src/b.java', 'some other file content'], + ]), + ); + fixture.componentRef.setInput('templateFileContentByPath', comp.solutionFileContentByPath()); + fixture.componentRef.setInput('report', { entries } as ProgrammingExerciseGitDiffReport); fixture.detectChanges(); // Initialization - expect(comp.allDiffsReady).toBeFalse(); - expect(comp.diffInformationForPaths[0].diffReady).toBeFalse(); - expect(comp.diffInformationForPaths[1].diffReady).toBeFalse(); + expect(comp.allDiffsReady()).toBeFalse(); + expect(comp.diffInformationForPaths()[0].diffReady).toBeFalse(); + expect(comp.diffInformationForPaths()[1].diffReady).toBeFalse(); // First file ready comp.onDiffReady(filePath1, true); - expect(comp.allDiffsReady).toBeFalse(); - expect(comp.diffInformationForPaths[0].diffReady).toBeTrue(); - expect(comp.diffInformationForPaths[1].diffReady).toBeFalse(); + expect(comp.allDiffsReady()).toBeFalse(); + expect(comp.diffInformationForPaths()[0].diffReady).toBeTrue(); + expect(comp.diffInformationForPaths()[1].diffReady).toBeFalse(); // Second file ready comp.onDiffReady(filePath2, true); - expect(comp.allDiffsReady).toBeTrue(); - expect(comp.diffInformationForPaths[0].diffReady).toBeTrue(); - expect(comp.diffInformationForPaths[1].diffReady).toBeTrue(); + expect(comp.allDiffsReady()).toBeTrue(); + expect(comp.diffInformationForPaths()[0].diffReady).toBeTrue(); + expect(comp.diffInformationForPaths()[1].diffReady).toBeTrue(); }); it('should correctly identify renamed files', () => { @@ -196,18 +199,18 @@ describe('ProgrammingExerciseGitDiffReport Component', () => { ]; const defaultContent = 'some content that might change'; const modifiedContent = 'some content that has changed'; - comp.report = { entries } as ProgrammingExerciseGitDiffReport; + fixture.componentRef.setInput('report', { entries } as ProgrammingExerciseGitDiffReport); const originalFileContents = new Map(); const modifiedFileContents = new Map(); [originalFilePath1, originalFilePath2, notRenamedFilePath].forEach((path) => { originalFileContents.set(path, defaultContent); modifiedFileContents.set(path, path === originalFilePath1 ? defaultContent : modifiedContent); }); - comp.templateFileContentByPath = originalFileContents; - comp.solutionFileContentByPath = modifiedFileContents; + fixture.componentRef.setInput('templateFileContentByPath', originalFileContents); + fixture.componentRef.setInput('solutionFileContentByPath', modifiedFileContents); fixture.detectChanges(); - expect(comp.renamedFilePaths).toEqual({ [renamedFilePath1]: originalFilePath1, [renamedFilePath2]: originalFilePath2 }); + expect(comp.renamedFilePaths()).toEqual({ [renamedFilePath1]: originalFilePath1, [renamedFilePath2]: originalFilePath2 }); }); }); diff --git a/src/test/javascript/spec/component/shared/monaco-editor/monaco-diff-editor.component.spec.ts b/src/test/javascript/spec/component/shared/monaco-editor/monaco-diff-editor.component.spec.ts index 459c093e3896..bdfd70b64723 100644 --- a/src/test/javascript/spec/component/shared/monaco-editor/monaco-diff-editor.component.spec.ts +++ b/src/test/javascript/spec/component/shared/monaco-editor/monaco-diff-editor.component.spec.ts @@ -27,22 +27,19 @@ describe('MonacoDiffEditorComponent', () => { it('should dispose its listeners and subscriptions when destroyed', () => { fixture.detectChanges(); - const resizeObserverDisconnectSpy = jest.spyOn(comp.resizeObserver!, 'disconnect'); const listenerDisposeSpies = comp.listeners.map((listener) => jest.spyOn(listener, 'dispose')); comp.ngOnDestroy(); - for (const spy of [resizeObserverDisconnectSpy, ...listenerDisposeSpies]) { + for (const spy of listenerDisposeSpies) { expect(spy).toHaveBeenCalledOnce(); } }); - it('should update the size of its container and layout the editor', () => { - const layoutSpy = jest.spyOn(comp, 'layout'); + it('should update the size of its container', () => { fixture.detectChanges(); const element = document.createElement('div'); comp.monacoDiffEditorContainerElement = element; - comp.adjustHeightAndLayout(100); + comp.adjustContainerHeight(100); expect(element.style.height).toBe('100px'); - expect(layoutSpy).toHaveBeenCalledOnce(); }); it('should set the text of the editor', () => { From db90e89be4538f864b0e0b85044872cb30c8793c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20Kn=C3=B6dlseder?= <53149143+chrisknedl@users.noreply.github.com> Date: Sat, 12 Oct 2024 19:12:05 +0200 Subject: [PATCH 13/23] General: Fix an issue when trying to delete too many users at once (#9430) --- .../cit/aet/artemis/core/web/admin/AdminUserResource.java | 3 +-- src/main/webapp/app/core/user/admin-user.service.ts | 8 ++------ .../cit/aet/artemis/core/user/util/UserTestService.java | 6 ++---- 3 files changed, 5 insertions(+), 12 deletions(-) diff --git a/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminUserResource.java b/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminUserResource.java index b2fb3b4fadd2..3f25c36d8a67 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminUserResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminUserResource.java @@ -25,7 +25,6 @@ import org.springframework.web.bind.annotation.PutMapping; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestMapping; -import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; import org.springframework.web.servlet.support.ServletUriComponentsBuilder; @@ -281,7 +280,7 @@ public ResponseEntity deleteUser(@PathVariable String login) { * @return the ResponseEntity with status 200 (OK) */ @DeleteMapping("users") - public ResponseEntity> deleteUsers(@RequestParam(name = "login") List logins) { + public ResponseEntity> deleteUsers(@RequestBody List logins) { log.debug("REST request to delete {} users", logins.size()); List deletedUsers = Collections.synchronizedList(new java.util.ArrayList<>()); diff --git a/src/main/webapp/app/core/user/admin-user.service.ts b/src/main/webapp/app/core/user/admin-user.service.ts index 0614e9229d3b..73e14d154597 100644 --- a/src/main/webapp/app/core/user/admin-user.service.ts +++ b/src/main/webapp/app/core/user/admin-user.service.ts @@ -1,5 +1,5 @@ import { Injectable } from '@angular/core'; -import { HttpClient, HttpParams, HttpResponse } from '@angular/common/http'; +import { HttpClient, HttpResponse } from '@angular/common/http'; import { Observable } from 'rxjs'; import { createRequestOption } from 'app/shared/util/request.util'; @@ -94,11 +94,7 @@ export class AdminUserService { * @return Observable> */ deleteUsers(logins: string[]): Observable> { - let params = new HttpParams(); - for (const login of logins) { - params = params.append('login', login); - } - return this.http.delete(`${this.resourceUrl}`, { params, observe: 'response' }); + return this.http.delete(`${this.resourceUrl}`, { body: logins, observe: 'response' }); } /** diff --git a/src/test/java/de/tum/cit/aet/artemis/core/user/util/UserTestService.java b/src/test/java/de/tum/cit/aet/artemis/core/user/util/UserTestService.java index 527230b8c446..77ea61f417ee 100644 --- a/src/test/java/de/tum/cit/aet/artemis/core/user/util/UserTestService.java +++ b/src/test/java/de/tum/cit/aet/artemis/core/user/util/UserTestService.java @@ -217,10 +217,8 @@ public void deleteUsers(String currentUserLogin) throws Exception { var users = Set.of(userUtilService.getUserByLogin(TEST_PREFIX + "student1"), userUtilService.getUserByLogin(TEST_PREFIX + "tutor1"), userUtilService.getUserByLogin(TEST_PREFIX + "editor1"), userUtilService.getUserByLogin(TEST_PREFIX + "instructor1")); - LinkedMultiValueMap params = new LinkedMultiValueMap<>(); - users.stream().map(User::getLogin).forEach(login -> params.add("login", login)); - - request.delete("/api/admin/users", HttpStatus.OK, params); + var logins = users.stream().map(User::getLogin).toList(); + request.delete("/api/admin/users", HttpStatus.OK, logins); for (var user : users) { final var deletedUser = userTestRepository.findById(user.getId()).orElseThrow(); From d8c99a2e8856c1fb287dd507bb0378fe0f84268e Mon Sep 17 00:00:00 2001 From: Leon Laurin Wehrhahn <58460654+LeonWehrhahn@users.noreply.github.com> Date: Sat, 12 Oct 2024 19:15:08 +0200 Subject: [PATCH 14/23] Modeling exercises: Fix submission error and redundant tooltip for AI feedback (#9437) --- .../artemis/assessment/repository/ResultRepository.java | 8 ++++++++ .../modeling/service/ModelingSubmissionService.java | 6 ++---- .../artemis/modeling/web/ModelingSubmissionResource.java | 1 - .../modeling/participate/modeling-submission.component.ts | 5 ++++- 4 files changed, 14 insertions(+), 6 deletions(-) diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/ResultRepository.java b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/ResultRepository.java index 87c381b777d9..5a7b75e82de5 100644 --- a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/ResultRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/ResultRepository.java @@ -427,6 +427,14 @@ SELECT COUNT(DISTINCT p) */ boolean existsByParticipationId(long participationId); + /** + * Checks if a result exists for the given submission ID. + * + * @param submissionId the ID of the submission to check. + * @return true if a result exists for the given submission ID, false otherwise. + */ + boolean existsBySubmissionId(long submissionId); + /** * Returns true if there is at least one result for the given exercise. * diff --git a/src/main/java/de/tum/cit/aet/artemis/modeling/service/ModelingSubmissionService.java b/src/main/java/de/tum/cit/aet/artemis/modeling/service/ModelingSubmissionService.java index 320d041325e9..c8b4285de3b9 100644 --- a/src/main/java/de/tum/cit/aet/artemis/modeling/service/ModelingSubmissionService.java +++ b/src/main/java/de/tum/cit/aet/artemis/modeling/service/ModelingSubmissionService.java @@ -131,12 +131,10 @@ public ModelingSubmission handleModelingSubmission(ModelingSubmission modelingSu } // if athena results are present, then create a new submission on submit - if (modelingSubmission.getParticipation() != null && modelingSubmission.getParticipation().getResults() != null - && !modelingSubmission.getParticipation().getResults().isEmpty()) { - log.debug("Creating a new submission due to Athena results for user: {}", user.getLogin()); + // If results exist for this submission, create a new submission by setting the ID to null + if (modelingSubmission.getId() != null && resultRepository.existsBySubmissionId(modelingSubmission.getId())) { modelingSubmission.setId(null); } - modelingSubmission = save(modelingSubmission, exercise, user, participation); return modelingSubmission; } diff --git a/src/main/java/de/tum/cit/aet/artemis/modeling/web/ModelingSubmissionResource.java b/src/main/java/de/tum/cit/aet/artemis/modeling/web/ModelingSubmissionResource.java index e48f94b8e955..501309aea8e8 100644 --- a/src/main/java/de/tum/cit/aet/artemis/modeling/web/ModelingSubmissionResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/modeling/web/ModelingSubmissionResource.java @@ -126,7 +126,6 @@ public ResponseEntity createModelingSubmission(@PathVariable @PutMapping("exercises/{exerciseId}/modeling-submissions") @EnforceAtLeastStudent public ResponseEntity updateModelingSubmission(@PathVariable long exerciseId, @Valid @RequestBody ModelingSubmission modelingSubmission) { - log.debug("REST request to update modeling submission: {}", modelingSubmission.getModel()); if (modelingSubmission.getId() == null) { return createModelingSubmission(exerciseId, modelingSubmission); } diff --git a/src/main/webapp/app/exercises/modeling/participate/modeling-submission.component.ts b/src/main/webapp/app/exercises/modeling/participate/modeling-submission.component.ts index 95cc45ed2483..e4684d85321b 100644 --- a/src/main/webapp/app/exercises/modeling/participate/modeling-submission.component.ts +++ b/src/main/webapp/app/exercises/modeling/participate/modeling-submission.component.ts @@ -35,6 +35,7 @@ import { faExclamationTriangle, faGripLines } from '@fortawesome/free-solid-svg- import { faListAlt } from '@fortawesome/free-regular-svg-icons'; import { onError } from 'app/shared/util/global.utils'; import { SubmissionPatch } from 'app/entities/submission-patch.model'; +import { AssessmentType } from 'app/entities/assessment-type.model'; @Component({ selector: 'jhi-modeling-submission', @@ -296,7 +297,9 @@ export class ModelingSubmissionComponent implements OnInit, OnDestroy, Component this.assessmentResult = newResult; this.assessmentResult = this.modelingAssessmentService.convertResult(newResult); this.prepareAssessmentData(); - this.alertService.info('artemisApp.modelingEditor.newAssessment'); + if (this.assessmentResult.assessmentType !== AssessmentType.AUTOMATIC_ATHENA) { + this.alertService.info('artemisApp.modelingEditor.newAssessment'); + } } }); } From 2259241021a00dc7ad293d9f2398b7249f716acd Mon Sep 17 00:00:00 2001 From: Simon Entholzer <33342534+SimonEntholzer@users.noreply.github.com> Date: Sat, 12 Oct 2024 19:24:19 +0200 Subject: [PATCH 15/23] Integrated code lifecycle: Disable access to personal VCS access tokens in account settings for students (#9397) --- .../webapp/app/core/auth/account.service.ts | 4 ++++ .../user-settings-container.component.html | 16 +++++++------ .../user-settings-container.component.ts | 23 +++++++++++++------ .../user-settings/user-settings.module.ts | 2 -- .../user-settings-container.component.spec.ts | 5 ++-- 5 files changed, 31 insertions(+), 19 deletions(-) diff --git a/src/main/webapp/app/core/auth/account.service.ts b/src/main/webapp/app/core/auth/account.service.ts index 93b66699ebba..8c22990b2a17 100644 --- a/src/main/webapp/app/core/auth/account.service.ts +++ b/src/main/webapp/app/core/auth/account.service.ts @@ -224,6 +224,10 @@ export class AccountService implements IAccountService { return this.hasAnyAuthorityDirect([Authority.ADMIN]); } + isAtLeastTutor(): boolean { + return this.hasAnyAuthorityDirect([Authority.ADMIN, Authority.EDITOR, Authority.INSTRUCTOR, Authority.TA]); + } + isAuthenticated(): boolean { return this.authenticated; } diff --git a/src/main/webapp/app/shared/user-settings/user-settings-container/user-settings-container.component.html b/src/main/webapp/app/shared/user-settings/user-settings-container/user-settings-container.component.html index ae5e4598aa04..6f0b0f4d68cd 100644 --- a/src/main/webapp/app/shared/user-settings/user-settings-container/user-settings-container.component.html +++ b/src/main/webapp/app/shared/user-settings/user-settings-container/user-settings-container.component.html @@ -31,13 +31,15 @@ @if (localVCEnabled) { - - + @if (isAtLeastTutor) { + + + } } diff --git a/src/main/webapp/app/shared/user-settings/user-settings-container/user-settings-container.component.ts b/src/main/webapp/app/shared/user-settings/user-settings-container/user-settings-container.component.ts index 77068b598121..46e74ca30b07 100644 --- a/src/main/webapp/app/shared/user-settings/user-settings-container/user-settings-container.component.ts +++ b/src/main/webapp/app/shared/user-settings/user-settings-container/user-settings-container.component.ts @@ -1,10 +1,13 @@ -import { Component, OnInit } from '@angular/core'; +import { Component, OnInit, inject } from '@angular/core'; import { faUser } from '@fortawesome/free-solid-svg-icons'; import { ProfileService } from 'app/shared/layouts/profiles/profile.service'; import { PROFILE_LOCALVC } from 'app/app.constants'; import { User } from 'app/core/user/user.model'; import { AccountService } from 'app/core/auth/account.service'; import { tap } from 'rxjs'; +import { TranslateDirective } from 'app/shared/language/translate.directive'; +import { RouterModule } from '@angular/router'; +import { FontAwesomeModule } from '@fortawesome/angular-fontawesome'; /** * UserSettingsContainerComponent serves as the common ground for different settings @@ -12,19 +15,20 @@ import { tap } from 'rxjs'; @Component({ selector: 'jhi-user-settings', templateUrl: 'user-settings-container.component.html', + standalone: true, styleUrls: ['user-settings-container.component.scss'], + imports: [TranslateDirective, RouterModule, FontAwesomeModule], }) export class UserSettingsContainerComponent implements OnInit { + private readonly profileService = inject(ProfileService); + private readonly accountService = inject(AccountService); + // Icons faUser = faUser; currentUser?: User; localVCEnabled = false; - - constructor( - private profileService: ProfileService, - private accountService: AccountService, - ) {} + isAtLeastTutor = false; ngOnInit() { this.profileService.getProfileInfo().subscribe((profileInfo) => { @@ -33,7 +37,12 @@ export class UserSettingsContainerComponent implements OnInit { this.accountService .getAuthenticationState() - .pipe(tap((user: User) => (this.currentUser = user))) + .pipe( + tap((user: User) => { + this.currentUser = user; + this.isAtLeastTutor = this.accountService.isAtLeastTutor(); + }), + ) .subscribe(); } } diff --git a/src/main/webapp/app/shared/user-settings/user-settings.module.ts b/src/main/webapp/app/shared/user-settings/user-settings.module.ts index fe912bdef56a..cd87f408b5a9 100644 --- a/src/main/webapp/app/shared/user-settings/user-settings.module.ts +++ b/src/main/webapp/app/shared/user-settings/user-settings.module.ts @@ -1,5 +1,4 @@ import { NgModule } from '@angular/core'; -import { UserSettingsContainerComponent } from 'app/shared/user-settings/user-settings-container/user-settings-container.component'; import { AccountInformationComponent } from 'app/shared/user-settings/account-information/account-information.component'; import { NotificationSettingsComponent } from 'app/shared/user-settings/notification-settings/notification-settings.component'; import { ArtemisSharedModule } from 'app/shared/shared.module'; @@ -17,7 +16,6 @@ import { DocumentationLinkComponent } from 'app/shared/components/documentation- @NgModule({ imports: [RouterModule.forChild(userSettingsState), ArtemisSharedModule, ArtemisSharedComponentModule, ClipboardModule, FormDateTimePickerModule, DocumentationLinkComponent], declarations: [ - UserSettingsContainerComponent, AccountInformationComponent, NotificationSettingsComponent, ScienceSettingsComponent, diff --git a/src/test/javascript/spec/component/account/user-settings-container.component.spec.ts b/src/test/javascript/spec/component/account/user-settings-container.component.spec.ts index 48ee21c6a6e8..d82f0614375c 100644 --- a/src/test/javascript/spec/component/account/user-settings-container.component.spec.ts +++ b/src/test/javascript/spec/component/account/user-settings-container.component.spec.ts @@ -4,7 +4,7 @@ import { of } from 'rxjs'; import { Router, RouterModule } from '@angular/router'; import { ArtemisTestModule } from '../../test.module'; import { MockNgbModalService } from '../../helpers/mocks/service/mock-ngb-modal.service'; -import { MockTranslateService, TranslatePipeMock } from '../../helpers/mocks/service/mock-translate.service'; +import { MockTranslateService } from '../../helpers/mocks/service/mock-translate.service'; import { TranslateService } from '@ngx-translate/core'; import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; import { PROFILE_LOCALVC } from 'app/app.constants'; @@ -27,8 +27,7 @@ describe('UserSettingsContainerComponent', () => { }; await TestBed.configureTestingModule({ - imports: [ArtemisTestModule, RouterModule], - declarations: [UserSettingsContainerComponent, TranslatePipeMock], + imports: [UserSettingsContainerComponent, ArtemisTestModule, RouterModule], providers: [ { provide: ProfileService, useValue: profileServiceMock }, { provide: TranslateService, useClass: MockTranslateService }, From 01396255d774c26307187f0e1a8c13587fbab1fc Mon Sep 17 00:00:00 2001 From: Stephan Krusche Date: Sat, 12 Oct 2024 19:36:42 +0200 Subject: [PATCH 16/23] Development: Adapt client test coverage --- jest.config.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/jest.config.js b/jest.config.js index 24051b7ea3de..9855e511a99a 100644 --- a/jest.config.js +++ b/jest.config.js @@ -102,10 +102,10 @@ module.exports = { coverageThreshold: { global: { // TODO: in the future, the following values should increase to at least 90% - statements: 87.44, - branches: 73.73, - functions: 82.09, - lines: 87.49, + statements: 87.39, + branches: 73.60, + functions: 81.97, + lines: 87.45, }, }, coverageReporters: ['clover', 'json', 'lcov', 'text-summary'], From 6deb17cf1a3427449c5284f5ac8ae29097886660 Mon Sep 17 00:00:00 2001 From: Michal Kawka <73854755+coolchock@users.noreply.github.com> Date: Sat, 12 Oct 2024 14:39:21 -0400 Subject: [PATCH 17/23] Exam mode: Generate student exam on demand if student is registered for the exam (#9123) --- .../exam/service/ExamAccessService.java | 23 ++++-- .../exam/service/ExamRegistrationService.java | 12 +++- .../exam/service/StudentExamService.java | 28 ++------ .../exam/ExamRegistrationIntegrationTest.java | 23 ++++++ .../exam/service/ExamAccessServiceTest.java | 71 +++++++++++++++---- 5 files changed, 116 insertions(+), 41 deletions(-) diff --git a/src/main/java/de/tum/cit/aet/artemis/exam/service/ExamAccessService.java b/src/main/java/de/tum/cit/aet/artemis/exam/service/ExamAccessService.java index b16e5af39eff..ca97f86bce7c 100644 --- a/src/main/java/de/tum/cit/aet/artemis/exam/service/ExamAccessService.java +++ b/src/main/java/de/tum/cit/aet/artemis/exam/service/ExamAccessService.java @@ -84,17 +84,26 @@ public StudentExam getExamInCourseElseThrow(Long courseId, Long examId) { studentExam = optionalStudentExam.get(); } else { - // Only Test Exams can be self-created by the user. Exam examWithExerciseGroupsAndExercises = examRepository.findWithExerciseGroupsAndExercisesByIdOrElseThrow(examId); + // An exam can be started 5 minutes before the start time, which is when programming exercises are unlocked + boolean canExamBeStarted = ZonedDateTime.now().isAfter(ExamDateService.getExamProgrammingExerciseUnlockDate(examWithExerciseGroupsAndExercises)); + boolean isExamEnded = ZonedDateTime.now().isAfter(examWithExerciseGroupsAndExercises.getEndDate()); + // Generate a student exam if the following conditions are met: + // 1. The exam has not ended. + // 2. The exam is either a test exam, OR it is a normal exam where the user is registered and can click the start button. + // Allowing student exams to be generated only when students can click the start button prevents inconsistencies. + // For example, this avoids a scenario where a student generates an exam and an instructor adds an exercise group afterward. + if (!isExamEnded + && (examWithExerciseGroupsAndExercises.isTestExam() || (examRegistrationService.isUserRegisteredForExam(examId, currentUser.getId()) && canExamBeStarted))) { + studentExam = studentExamService.generateIndividualStudentExam(examWithExerciseGroupsAndExercises, currentUser); + // For the start of the exam, the exercises are not needed. They are later loaded via StudentExamResource + studentExam.setExercises(null); - if (!examWithExerciseGroupsAndExercises.isTestExam()) { + } + else { // We skip the alert since this can happen when a tutor sees the exam card or the user did not participate yet is registered for the exam - throw new BadRequestAlertException("The requested Exam is no test exam and thus no student exam can be created", ENTITY_NAME, - "StudentExamGenerationOnlyForTestExams", true); + throw new BadRequestAlertException("Cannot generate student exam for exam ID " + examId + ".", ENTITY_NAME, "cannotGenerateStudentExam", true); } - studentExam = studentExamService.generateTestExam(examWithExerciseGroupsAndExercises, currentUser); - // For the start of the exam, the exercises are not needed. They are later loaded via StudentExamResource - studentExam.setExercises(null); } Exam exam = studentExam.getExam(); diff --git a/src/main/java/de/tum/cit/aet/artemis/exam/service/ExamRegistrationService.java b/src/main/java/de/tum/cit/aet/artemis/exam/service/ExamRegistrationService.java index 2f747de288ff..18b6aafbbe29 100644 --- a/src/main/java/de/tum/cit/aet/artemis/exam/service/ExamRegistrationService.java +++ b/src/main/java/de/tum/cit/aet/artemis/exam/service/ExamRegistrationService.java @@ -72,9 +72,12 @@ public class ExamRegistrationService { private static final boolean IS_TEST_RUN = false; + private final StudentExamService studentExamService; + public ExamRegistrationService(ExamUserRepository examUserRepository, ExamRepository examRepository, UserService userService, ParticipationService participationService, UserRepository userRepository, AuditEventRepository auditEventRepository, CourseRepository courseRepository, StudentExamRepository studentExamRepository, - StudentParticipationRepository studentParticipationRepository, AuthorizationCheckService authorizationCheckService, ExamUserService examUserService) { + StudentParticipationRepository studentParticipationRepository, AuthorizationCheckService authorizationCheckService, ExamUserService examUserService, + StudentExamService studentExamService) { this.examRepository = examRepository; this.userService = userService; this.userRepository = userRepository; @@ -86,6 +89,7 @@ public ExamRegistrationService(ExamUserRepository examUserRepository, ExamReposi this.authorizationCheckService = authorizationCheckService; this.examUserRepository = examUserRepository; this.examUserService = examUserService; + this.studentExamService = studentExamService; } /** @@ -193,6 +197,7 @@ public boolean isUserRegisteredForExam(Long examId, Long userId) { * Registers student to the exam. In order to do this, we add the user to the course group, because the user only has access to the exam of a course if the student also has * access to the course of the exam. * We only need to add the user to the course group, if the student is not yet part of it, otherwise the student cannot access the exam (within the course). + * If the exam has already started, a student exam is additionally generated. * * @param course the course containing the exam * @param exam the exam for which we want to register a student @@ -216,6 +221,11 @@ public void registerStudentToExam(Course course, Exam exam, User student) { registeredExamUser = examUserRepository.save(registeredExamUser); exam.addExamUser(registeredExamUser); examRepository.save(exam); + // Generate a student exam for the registered student if the exam has already started + if (exam.isStarted()) { + Exam examWithExerciseGroupsAndExercises = examRepository.findWithExerciseGroupsAndExercisesByIdOrElseThrow(exam.getId()); + studentExamService.generateIndividualStudentExam(examWithExerciseGroupsAndExercises, student); + } } else { log.warn("Student {} is already registered for the exam {}", student.getLogin(), exam.getId()); diff --git a/src/main/java/de/tum/cit/aet/artemis/exam/service/StudentExamService.java b/src/main/java/de/tum/cit/aet/artemis/exam/service/StudentExamService.java index 73e0ffaa8d8b..a2898a9df5ff 100644 --- a/src/main/java/de/tum/cit/aet/artemis/exam/service/StudentExamService.java +++ b/src/main/java/de/tum/cit/aet/artemis/exam/service/StudentExamService.java @@ -9,7 +9,6 @@ import java.time.temporal.ChronoUnit; import java.util.ArrayList; import java.util.Collections; -import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Objects; @@ -797,16 +796,17 @@ public void setUpExerciseParticipationsAndSubmissions(StudentExam studentExam, L } /** - * Generates a new test exam for the student and stores it in the database + * Generates a new individual StudentExam for the specified student and stores it in the database. * - * @param exam the exam with loaded exercise groups and exercises for which the StudentExam should be created - * @param student the corresponding student - * @return a StudentExam for the student and exam + * @param exam The exam with eagerly loaded users, exercise groups, and exercises. + * @param student The student for whom the StudentExam should be created. + * @return The generated StudentExam. */ - public StudentExam generateTestExam(Exam exam, User student) { + public StudentExam generateIndividualStudentExam(Exam exam, User student) { // To create a new StudentExam, the Exam with loaded ExerciseGroups and Exercises is needed long start = System.nanoTime(); - StudentExam studentExam = generateIndividualStudentExam(exam, student); + Set userSet = Collections.singleton(student); + StudentExam studentExam = studentExamRepository.createRandomStudentExams(exam, userSet, examQuizQuestionsGenerator).getFirst(); // we need to break a cycle for the serialization studentExam.getExam().setExerciseGroups(null); studentExam.getExam().setStudentExams(null); @@ -816,20 +816,6 @@ public StudentExam generateTestExam(Exam exam, User student) { return studentExam; } - /** - * Generates an individual StudentExam - * - * @param exam with eagerly loaded users, exerciseGroups and exercises loaded - * @param student the student for which the StudentExam should be created - * @return the generated StudentExam - */ - private StudentExam generateIndividualStudentExam(Exam exam, User student) { - // StudentExams are saved in the called method - HashSet userHashSet = new HashSet<>(); - userHashSet.add(student); - return studentExamRepository.createRandomStudentExams(exam, userHashSet, examQuizQuestionsGenerator).getFirst(); - } - /** * Generates the student exams randomly based on the exam configuration and the exercise groups * Important: the passed exams needs to include the registered users, exercise groups and exercises (eagerly loaded) diff --git a/src/test/java/de/tum/cit/aet/artemis/exam/ExamRegistrationIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/exam/ExamRegistrationIntegrationTest.java index 8402a7e431f3..8114e2e942ff 100644 --- a/src/test/java/de/tum/cit/aet/artemis/exam/ExamRegistrationIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/exam/ExamRegistrationIntegrationTest.java @@ -5,6 +5,7 @@ import static org.mockito.Mockito.doReturn; import static org.mockito.Mockito.verify; +import java.time.ZonedDateTime; import java.util.Arrays; import java.util.Collections; import java.util.List; @@ -30,8 +31,10 @@ import de.tum.cit.aet.artemis.core.user.util.UserFactory; import de.tum.cit.aet.artemis.exam.domain.Exam; import de.tum.cit.aet.artemis.exam.domain.ExamUser; +import de.tum.cit.aet.artemis.exam.domain.StudentExam; import de.tum.cit.aet.artemis.exam.repository.ExamRepository; import de.tum.cit.aet.artemis.exam.repository.ExamUserRepository; +import de.tum.cit.aet.artemis.exam.repository.StudentExamRepository; import de.tum.cit.aet.artemis.exam.service.ExamRegistrationService; import de.tum.cit.aet.artemis.exam.util.ExamFactory; import de.tum.cit.aet.artemis.exam.util.ExamUtilService; @@ -61,6 +64,9 @@ class ExamRegistrationIntegrationTest extends AbstractSpringIntegrationLocalCILo @Autowired private ExamUtilService examUtilService; + @Autowired + private StudentExamRepository studentExamRepository; + private Course course1; private Exam exam1; @@ -108,6 +114,23 @@ void testRegisterUserInExam_addedToCourseStudentsGroup() throws Exception { assertThat(studentsInCourseBefore).containsExactlyInAnyOrderElementsOf(studentsInCourseAfter); } + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testRegisterUserInExam_studentExamGenerated() throws Exception { + Exam exam = examUtilService.addExam(course1); + exam = examUtilService.addTextModelingProgrammingExercisesToExam(exam, false, false); + exam.setStartDate(ZonedDateTime.now().minusMinutes(3)); + examRepository.save(exam); + + Set studentExamsBefore = studentExamRepository.findByExamId(exam.getId()); + assertThat(studentExamsBefore).isEmpty(); + + request.postWithoutLocation("/api/courses/" + course1.getId() + "/exams/" + exam.getId() + "/students/" + TEST_PREFIX + "student42", null, HttpStatus.OK, null); + + Set studentExamsAfter = studentExamRepository.findByExamId(exam.getId()); + assertThat(studentExamsAfter).hasSize(1); + } + @Test @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") void testAddStudentToExam_testExam() throws Exception { diff --git a/src/test/java/de/tum/cit/aet/artemis/exam/service/ExamAccessServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/exam/service/ExamAccessServiceTest.java index e7cce14f7eb0..5aa78b2af5be 100644 --- a/src/test/java/de/tum/cit/aet/artemis/exam/service/ExamAccessServiceTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/exam/service/ExamAccessServiceTest.java @@ -1,6 +1,7 @@ package de.tum.cit.aet.artemis.exam.service; import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatNoException; import static org.assertj.core.api.Assertions.assertThatThrownBy; import static org.assertj.core.api.InstanceOfAssertFactories.type; @@ -33,6 +34,9 @@ import de.tum.cit.aet.artemis.exam.repository.ExamUserRepository; import de.tum.cit.aet.artemis.exam.test_repository.StudentExamTestRepository; import de.tum.cit.aet.artemis.exam.util.ExamUtilService; +import de.tum.cit.aet.artemis.exercise.repository.ExerciseRepository; +import de.tum.cit.aet.artemis.quiz.domain.QuizExercise; +import de.tum.cit.aet.artemis.quiz.util.QuizExerciseFactory; import de.tum.cit.aet.artemis.shared.base.AbstractSpringIntegrationIndependentTest; class ExamAccessServiceTest extends AbstractSpringIntegrationIndependentTest { @@ -60,6 +64,9 @@ class ExamAccessServiceTest extends AbstractSpringIntegrationIndependentTest { @Autowired private ExamUtilService examUtilService; + @Autowired + private ExerciseRepository exerciseRepository; + private Course course1; private Course course2; @@ -123,11 +130,20 @@ void init() { examUser1 = examUserRepository.save(examUser1); testExam2.setExamUsers(Set.of(examUser1)); exerciseGroup1 = exam1.getExerciseGroups().getFirst(); + QuizExercise quiz = QuizExerciseFactory.generateQuizExerciseForExam(exerciseGroup1); + exerciseGroup1.addExercise(quiz); + exerciseRepository.save(quiz); exerciseGroup2 = exam2.getExerciseGroups().getFirst(); - studentExam1 = examUtilService.addStudentExam(exam1); + studentExam1 = examUtilService.addStudentExamWithUser(exam1, student1); studentExam2 = examUtilService.addStudentExam(exam2); studentExamForTestExam1 = examUtilService.addStudentExamForTestExam(testExam1, student1); studentExamForTestExam2 = examUtilService.addStudentExamForTestExam(testExam2, student1); + ExamUser examUser2 = new ExamUser(); + examUser2.setExam(exam1); + examUser2.setUser(student1); + examUser2 = examUserRepository.save(examUser2); + exam1.setExamUsers(Set.of(examUser2)); + exam1 = examRepository.save(exam1); } @Test @@ -332,10 +348,49 @@ void testCheckAndGetCourseAndExamAccessForConduction_examBelongsToCourse() { @Test @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") - void testCheckAndGetCourseAndExamAccessForConduction_registeredUser() { - exam1.setExamUsers(Set.of()); + void testCheckAndGetCourseAndExamAccessForConduction_notRegisteredUser() { + assertThatThrownBy(() -> examAccessService.getExamInCourseElseThrow(course1.getId(), exam2.getId())).isInstanceOf(BadRequestAlertException.class); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void testCheckAndGetCourseAndExamAccessForConduction_registeredUser_noStudentExamPresent_examCanBeStarted() { + exam1.setStudentExams(Set.of()); + exam1.setStartDate(ZonedDateTime.now().plusMinutes(3)); + exam1.setEndDate(ZonedDateTime.now().plusMinutes(10)); + examRepository.save(exam1); + studentExamRepository.delete(studentExam1); + assertThatNoException().isThrownBy(() -> examAccessService.getExamInCourseElseThrow(course1.getId(), exam1.getId())); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void testCheckAndGetCourseAndExamAccessForConduction_registeredUser_noStudentExamPresent_examCannotBeStarted() { + exam1.setStudentExams(Set.of()); + exam1.setStartDate(ZonedDateTime.now().plusMinutes(7)); examRepository.save(exam1); - assertThatThrownBy(() -> examAccessService.getExamInCourseElseThrow(course1.getId(), exam1.getId())).isInstanceOf(BadRequestAlertException.class); + studentExamRepository.delete(studentExam1); + assertThatThrownBy(() -> examAccessService.getExamInCourseElseThrow(course1.getId(), exam1.getId())).asInstanceOf(type(BadRequestAlertException.class)) + .satisfies(error -> assertThat(error.getParameters().get("skipAlert")).isEqualTo(Boolean.TRUE)); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void testCheckAndGetCourseAndExamAccessForConduction_registeredUser_noStudentExamPresent_examHasEnded() { + exam1.setStudentExams(Set.of()); + exam1.setStartDate(ZonedDateTime.now().minusMinutes(10)); + exam1.setEndDate(ZonedDateTime.now().minusMinutes(7)); + examRepository.save(exam1); + studentExamRepository.delete(studentExam1); + assertThatThrownBy(() -> examAccessService.getExamInCourseElseThrow(course1.getId(), exam1.getId())).asInstanceOf(type(BadRequestAlertException.class)) + .satisfies(error -> assertThat(error.getParameters().get("skipAlert")).isEqualTo(Boolean.TRUE)); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void testCheckAndGetCourseAndExamAccessForConduction_registeredUser_studentExamPresent() { + StudentExam studentExam = examAccessService.getExamInCourseElseThrow(course1.getId(), exam1.getId()); + assertThat(studentExam.equals(studentExam1)).isEqualTo(true); } @Test @@ -355,14 +410,6 @@ void testGetExamInCourseElseThrow_noCourseAccess() { assertThatThrownBy(() -> examAccessService.getExamInCourseElseThrow(course1.getId(), testExam1.getId())).isInstanceOf(AccessForbiddenException.class); } - @Test - @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") - void testGetExamInCourseElseThrow_realExam() { - assertThatThrownBy(() -> examAccessService.getExamInCourseElseThrow(course1.getId(), exam1.getId())).asInstanceOf(type(BadRequestAlertException.class)) - .satisfies(error -> assertThat(error.getParameters().get("skipAlert")).isEqualTo(Boolean.TRUE)); - - } - @Test @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") void testGetExamInCourseElseThrow_notVisible() { From d801ef83065d59b710ae7bf3c4c293ce8f7ac57c Mon Sep 17 00:00:00 2001 From: Stephan Krusche Date: Sat, 12 Oct 2024 20:48:55 +0200 Subject: [PATCH 18/23] Development: Fix architecture tests in exam module --- .../cit/aet/artemis/exam/ExamRegistrationIntegrationTest.java | 4 ++-- .../cit/aet/artemis/exam/service/ExamAccessServiceTest.java | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/test/java/de/tum/cit/aet/artemis/exam/ExamRegistrationIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/exam/ExamRegistrationIntegrationTest.java index 8114e2e942ff..3026f09843d6 100644 --- a/src/test/java/de/tum/cit/aet/artemis/exam/ExamRegistrationIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/exam/ExamRegistrationIntegrationTest.java @@ -34,8 +34,8 @@ import de.tum.cit.aet.artemis.exam.domain.StudentExam; import de.tum.cit.aet.artemis.exam.repository.ExamRepository; import de.tum.cit.aet.artemis.exam.repository.ExamUserRepository; -import de.tum.cit.aet.artemis.exam.repository.StudentExamRepository; import de.tum.cit.aet.artemis.exam.service.ExamRegistrationService; +import de.tum.cit.aet.artemis.exam.test_repository.StudentExamTestRepository; import de.tum.cit.aet.artemis.exam.util.ExamFactory; import de.tum.cit.aet.artemis.exam.util.ExamUtilService; import de.tum.cit.aet.artemis.shared.base.AbstractSpringIntegrationLocalCILocalVCTest; @@ -65,7 +65,7 @@ class ExamRegistrationIntegrationTest extends AbstractSpringIntegrationLocalCILo private ExamUtilService examUtilService; @Autowired - private StudentExamRepository studentExamRepository; + private StudentExamTestRepository studentExamRepository; private Course course1; diff --git a/src/test/java/de/tum/cit/aet/artemis/exam/service/ExamAccessServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/exam/service/ExamAccessServiceTest.java index 5aa78b2af5be..73467cf82f0a 100644 --- a/src/test/java/de/tum/cit/aet/artemis/exam/service/ExamAccessServiceTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/exam/service/ExamAccessServiceTest.java @@ -34,7 +34,7 @@ import de.tum.cit.aet.artemis.exam.repository.ExamUserRepository; import de.tum.cit.aet.artemis.exam.test_repository.StudentExamTestRepository; import de.tum.cit.aet.artemis.exam.util.ExamUtilService; -import de.tum.cit.aet.artemis.exercise.repository.ExerciseRepository; +import de.tum.cit.aet.artemis.exercise.repository.ExerciseTestRepository; import de.tum.cit.aet.artemis.quiz.domain.QuizExercise; import de.tum.cit.aet.artemis.quiz.util.QuizExerciseFactory; import de.tum.cit.aet.artemis.shared.base.AbstractSpringIntegrationIndependentTest; @@ -65,7 +65,7 @@ class ExamAccessServiceTest extends AbstractSpringIntegrationIndependentTest { private ExamUtilService examUtilService; @Autowired - private ExerciseRepository exerciseRepository; + private ExerciseTestRepository exerciseRepository; private Course course1; From 330a677e5762f491ffef3515b7969c4a8f077044 Mon Sep 17 00:00:00 2001 From: Stephan Krusche Date: Sat, 12 Oct 2024 22:47:47 +0200 Subject: [PATCH 19/23] General: Cache course icons and profile pictures to improve performance (#9459) --- .../core/config/PublicResourcesConfiguration.java | 14 ++++++++++++++ .../tum/cit/aet/artemis/core/web/FileResource.java | 4 +++- .../conversation-messages.component.ts | 1 + .../app/shared/metis/metis-conversation.service.ts | 2 +- .../aet/artemis/core/util/CourseTestService.java | 3 +-- .../artemis/quiz/QuizExerciseIntegrationTest.java | 3 ++- 6 files changed, 22 insertions(+), 5 deletions(-) diff --git a/src/main/java/de/tum/cit/aet/artemis/core/config/PublicResourcesConfiguration.java b/src/main/java/de/tum/cit/aet/artemis/core/config/PublicResourcesConfiguration.java index 2d7adf676f74..e39b8915c94f 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/config/PublicResourcesConfiguration.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/config/PublicResourcesConfiguration.java @@ -10,6 +10,7 @@ import jakarta.validation.constraints.NotNull; +import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Profile; import org.springframework.http.CacheControl; @@ -32,6 +33,9 @@ public PublicResourcesConfiguration(JHipsterProperties jHipsterProperties) { this.jHipsterProperties = jHipsterProperties; } + @Value("${artemis.file-upload-path}") + private String fileUploadPath; + @Override public void addResourceHandlers(@NotNull ResourceHandlerRegistry registry) { // Enable static resource serving in general from "/public" from both classpath and hosts filesystem @@ -46,6 +50,16 @@ public void addResourceHandlers(@NotNull ResourceHandlerRegistry registry) { addResourceHandlerForPath(registry, "images", "about").setCacheControl(defaultCacheControl); addResourceHandlerForPath(registry, "emoji").setCacheControl(defaultCacheControl); + + // Add caching for course icons, user profile pictures, and drag and drop quiz pictures + // Add resource handlers for dynamic image paths based on fileUploadPath + // TODO: those paths have to be the same as in FilePathService, ideally we reuse the constants and define them only once + registry.addResourceHandler("/images/course/icons/**").addResourceLocations("file:" + fileUploadPath + "/images/course/icons/").setCacheControl(defaultCacheControl); + + registry.addResourceHandler("/images/user/profile-pictures/**").addResourceLocations("file:" + fileUploadPath + "/images/user/profile-pictures/") + .setCacheControl(defaultCacheControl); + + registry.addResourceHandler("/images/drag-and-drop/**").addResourceLocations("file:" + fileUploadPath + "/images/drag-and-drop/").setCacheControl(defaultCacheControl); } /** diff --git a/src/main/java/de/tum/cit/aet/artemis/core/web/FileResource.java b/src/main/java/de/tum/cit/aet/artemis/core/web/FileResource.java index 4413ec2f6a8d..e8ad0e1fc5fe 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/web/FileResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/web/FileResource.java @@ -12,6 +12,7 @@ import java.util.List; import java.util.Optional; import java.util.Set; +import java.util.concurrent.TimeUnit; import java.util.regex.Matcher; import java.util.regex.Pattern; @@ -646,7 +647,8 @@ private ResponseEntity responseEntityForFilePath(Path filePath) { if (file == null) { return ResponseEntity.notFound().build(); } - return ResponseEntity.ok(file); + return ResponseEntity.ok().cacheControl(CacheControl.maxAge(30, TimeUnit.DAYS)) // Cache for 30 days; + .contentType(getMediaTypeFromFilename(filePath.getFileName().toString())).body(file); } catch (IOException e) { log.error("Failed to return requested file with path {}", filePath, e); diff --git a/src/main/webapp/app/overview/course-conversations/layout/conversation-messages/conversation-messages.component.ts b/src/main/webapp/app/overview/course-conversations/layout/conversation-messages/conversation-messages.component.ts index e4b11dd87612..2590612104b4 100644 --- a/src/main/webapp/app/overview/course-conversations/layout/conversation-messages/conversation-messages.component.ts +++ b/src/main/webapp/app/overview/course-conversations/layout/conversation-messages/conversation-messages.component.ts @@ -136,6 +136,7 @@ export class ConversationMessagesComponent implements OnInit, AfterViewInit, OnD this.createEmptyPost(); } } + private subscribeToMetis() { this.metisService.posts.pipe(takeUntil(this.ngUnsubscribe)).subscribe((posts: Post[]) => { this.setPosts(posts); diff --git a/src/main/webapp/app/shared/metis/metis-conversation.service.ts b/src/main/webapp/app/shared/metis/metis-conversation.service.ts index 012ff7aa1565..b21b4074294d 100644 --- a/src/main/webapp/app/shared/metis/metis-conversation.service.ts +++ b/src/main/webapp/app/shared/metis/metis-conversation.service.ts @@ -116,7 +116,7 @@ export class MetisConversationService implements OnDestroy { public setActiveConversation(conversationIdentifier: ConversationDTO | number | undefined) { this.updateLastReadDateAndNumberOfUnreadMessages(); - let cachedConversation = undefined; + let cachedConversation: ConversationDTO | undefined = undefined; if (conversationIdentifier) { const parameterJustId = typeof conversationIdentifier === 'number'; cachedConversation = this.conversationsOfUser.find( diff --git a/src/test/java/de/tum/cit/aet/artemis/core/util/CourseTestService.java b/src/test/java/de/tum/cit/aet/artemis/core/util/CourseTestService.java index 3b8ce269954b..c80195c2b8aa 100644 --- a/src/test/java/de/tum/cit/aet/artemis/core/util/CourseTestService.java +++ b/src/test/java/de/tum/cit/aet/artemis/core/util/CourseTestService.java @@ -3303,8 +3303,7 @@ private Course createCourseWithCourseImageAndReturn() throws Exception { course = objectMapper.readValue(result.getResponse().getContentAsString(), Course.class); assertThat(course.getCourseIcon()).as("Course icon got stored").isNotNull(); - var imgResult = request.performMvcRequest(get(course.getCourseIcon())).andExpect(status().isOk()).andExpect(content().contentType(MediaType.APPLICATION_OCTET_STREAM)) - .andReturn(); + var imgResult = request.performMvcRequest(get(course.getCourseIcon())).andExpect(status().isOk()).andExpect(content().contentType(MediaType.IMAGE_PNG)).andReturn(); assertThat(imgResult.getResponse().getContentAsByteArray()).isNotEmpty(); var createdCourse = courseRepo.findByIdElseThrow(course.getId()); diff --git a/src/test/java/de/tum/cit/aet/artemis/quiz/QuizExerciseIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/quiz/QuizExerciseIntegrationTest.java index b11c688358fa..e787ee1533a0 100644 --- a/src/test/java/de/tum/cit/aet/artemis/quiz/QuizExerciseIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/quiz/QuizExerciseIntegrationTest.java @@ -306,7 +306,8 @@ private void checkCreatedFiles(QuizExercise quizExercise) throws Exception { } private void checkCreatedFile(String path) throws Exception { - MvcResult result = request.performMvcRequest(get(path)).andExpect(status().isOk()).andExpect(content().contentType(MediaType.APPLICATION_OCTET_STREAM)).andReturn(); + MediaType mediaType = path.endsWith(".png") ? MediaType.IMAGE_PNG : MediaType.IMAGE_JPEG; + MvcResult result = request.performMvcRequest(get(path)).andExpect(status().isOk()).andExpect(content().contentType(mediaType)).andReturn(); byte[] image = result.getResponse().getContentAsByteArray(); assertThat(image).isNotEmpty(); } From 1f6cc870c161241d330a48552bf5cb92a69b5edf Mon Sep 17 00:00:00 2001 From: Tim Cremer Date: Wed, 9 Oct 2024 11:46:55 +0200 Subject: [PATCH 20/23] merge changes --- .../repository/FaqRepository.java | 3 + .../communication/web/FaqResource.java | 39 ++++++++++-- .../course-management-tab-bar.component.html | 2 +- .../course-management-card.component.html | 2 +- src/main/webapp/app/entities/faq.model.ts | 6 +- .../webapp/app/faq/faq-update.component.ts | 6 +- src/main/webapp/app/faq/faq.component.html | 62 +++++++++++++------ src/main/webapp/app/faq/faq.component.ts | 46 ++++++++++++-- src/main/webapp/app/faq/faq.service.ts | 14 +++++ .../course-faq/course-faq.component.ts | 4 +- src/main/webapp/i18n/de/faq.json | 14 +++-- src/main/webapp/i18n/en/faq.json | 14 +++-- 12 files changed, 169 insertions(+), 43 deletions(-) diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/repository/FaqRepository.java b/src/main/java/de/tum/cit/aet/artemis/communication/repository/FaqRepository.java index bd8bb8989995..0361014a2076 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/repository/FaqRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/repository/FaqRepository.java @@ -12,6 +12,7 @@ import org.springframework.transaction.annotation.Transactional; import de.tum.cit.aet.artemis.communication.domain.Faq; +import de.tum.cit.aet.artemis.communication.domain.FaqState; import de.tum.cit.aet.artemis.core.repository.base.ArtemisJpaRepository; /** @@ -30,6 +31,8 @@ public interface FaqRepository extends ArtemisJpaRepository { """) Set findAllCategoriesByCourseId(@Param("courseId") Long courseId); + Set findAllByCourseIdAndFaqState(Long courseId, FaqState faqState); + @Transactional @Modifying void deleteAllByCourseId(Long courseId); diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/web/FaqResource.java b/src/main/java/de/tum/cit/aet/artemis/communication/web/FaqResource.java index 91a542aaa220..3a513afcc1d6 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/web/FaqResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/web/FaqResource.java @@ -23,12 +23,14 @@ import org.springframework.web.bind.annotation.RestController; import de.tum.cit.aet.artemis.communication.domain.Faq; +import de.tum.cit.aet.artemis.communication.domain.FaqState; import de.tum.cit.aet.artemis.communication.dto.FaqDTO; import de.tum.cit.aet.artemis.communication.repository.FaqRepository; import de.tum.cit.aet.artemis.core.domain.Course; import de.tum.cit.aet.artemis.core.exception.BadRequestAlertException; import de.tum.cit.aet.artemis.core.repository.CourseRepository; import de.tum.cit.aet.artemis.core.security.Role; +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.service.AuthorizationCheckService; @@ -72,7 +74,7 @@ public FaqResource(CourseRepository courseRepository, AuthorizationCheckService * @throws URISyntaxException if the Location URI syntax is incorrect */ @PostMapping("courses/{courseId}/faqs") - @EnforceAtLeastInstructor + @EnforceAtLeastEditor public ResponseEntity createFaq(@RequestBody Faq faq, @PathVariable Long courseId) throws URISyntaxException { log.debug("REST request to save Faq : {}", faq); if (faq.getId() != null) { @@ -82,7 +84,7 @@ public ResponseEntity createFaq(@RequestBody Faq faq, @PathVariable Long if (faq.getCourse() == null || !faq.getCourse().getId().equals(courseId)) { throw new BadRequestAlertException("Course ID in path and FAQ do not match", ENTITY_NAME, "courseIdMismatch"); } - authCheckService.checkHasAtLeastRoleInCourseElseThrow(Role.INSTRUCTOR, faq.getCourse(), null); + authCheckService.checkHasAtLeastRoleInCourseElseThrow(Role.EDITOR, faq.getCourse(), null); Faq savedFaq = faqRepository.save(faq); FaqDTO dto = new FaqDTO(savedFaq); @@ -99,13 +101,14 @@ public ResponseEntity createFaq(@RequestBody Faq faq, @PathVariable Long * if the faq is not valid or if the faq course id does not match with the path variable */ @PutMapping("courses/{courseId}/faqs/{faqId}") - @EnforceAtLeastInstructor + @EnforceAtLeastEditor public ResponseEntity updateFaq(@RequestBody Faq faq, @PathVariable Long faqId, @PathVariable Long courseId) { log.debug("REST request to update Faq : {}", faq); if (faqId == null || !faqId.equals(faq.getId())) { throw new BadRequestAlertException("Id of FAQ and path must match", ENTITY_NAME, "idNull"); } - authCheckService.checkHasAtLeastRoleInCourseElseThrow(Role.INSTRUCTOR, faq.getCourse(), null); + Course course = courseRepository.findByIdElseThrow(courseId); + authCheckService.checkHasAtLeastRoleInCourseElseThrow(Role.STUDENT, course, null); Faq existingFaq = faqRepository.findByIdElseThrow(faqId); if (!Objects.equals(existingFaq.getCourse().getId(), courseId)) { throw new BadRequestAlertException("Course ID of the FAQ provided courseID must match", ENTITY_NAME, "idNull"); @@ -174,6 +177,34 @@ public ResponseEntity> getFaqForCourse(@PathVariable Long courseId) return ResponseEntity.ok().body(faqDTOS); } + /** + * GET /courses/:courseId/faq-status/:faqState : get all the faqs of a course in the specified status + * + * @param courseId the courseId of the course for which all faqs should be returned + * @param faqState the state of all returned FAQs + * @return the ResponseEntity with status 200 (OK) and the list of faqs in body + */ + @GetMapping("courses/{courseId}/faq-state/{faqState}") + @EnforceAtLeastStudent + public ResponseEntity> getAllFaqForCourseByStatus(@PathVariable Long courseId, @PathVariable String faqState) { + log.debug("REST request to get all Faqs for the course with id : {}", courseId); + FaqState retrivedState = defineState(faqState); + Course course = courseRepository.findByIdElseThrow(courseId); + authCheckService.checkHasAtLeastRoleInCourseElseThrow(Role.STUDENT, course, null); + Set faqs = faqRepository.findAllByCourseIdAndFaqState(courseId, retrivedState); + Set faqDTOS = faqs.stream().map(FaqDTO::new).collect(Collectors.toSet()); + return ResponseEntity.ok().body(faqDTOS); + } + + private FaqState defineState(String faqState) { + return switch (faqState) { + case "ACCEPTED" -> FaqState.ACCEPTED; + case "REJECTED" -> FaqState.REJECTED; + case "PROPOSED" -> FaqState.PROPOSED; + default -> throw new IllegalArgumentException("Unknown state: " + faqState); + }; + } + /** * GET /courses/:courseId/faq-categories : get all the faq categories of a course * diff --git a/src/main/webapp/app/course/manage/course-management-tab-bar/course-management-tab-bar.component.html b/src/main/webapp/app/course/manage/course-management-tab-bar/course-management-tab-bar.component.html index bc10fd753a7c..1efef9ce1955 100644 --- a/src/main/webapp/app/course/manage/course-management-tab-bar/course-management-tab-bar.component.html +++ b/src/main/webapp/app/course/manage/course-management-tab-bar/course-management-tab-bar.component.html @@ -72,7 +72,7 @@ } - @if (course.isAtLeastInstructor && course.faqEnabled) { + @if (course.isAtLeastEditor && course.faqEnabled) { diff --git a/src/main/webapp/app/course/manage/overview/course-management-card.component.html b/src/main/webapp/app/course/manage/overview/course-management-card.component.html index d13dee53b6e5..c590b29a0d75 100644 --- a/src/main/webapp/app/course/manage/overview/course-management-card.component.html +++ b/src/main/webapp/app/course/manage/overview/course-management-card.component.html @@ -339,7 +339,7 @@

}

- - - - + @if (isAtleastInstrucor) { + + + + + } @else { + + + + + }
@@ -67,6 +74,10 @@

+ + + + @@ -86,6 +97,9 @@

+ +

+
@for (category of faq.categories; track category) { @@ -93,27 +107,39 @@

}

-
+ @if (faq.faqState == FaqState.PROPOSED && isAtleastInstrucor) { +
+ + +
+ }
- - + @if (isAtleastInstrucor) { + + }
diff --git a/src/main/webapp/app/faq/faq.component.ts b/src/main/webapp/app/faq/faq.component.ts index 0a8c1df808f8..ec2967abc31e 100644 --- a/src/main/webapp/app/faq/faq.component.ts +++ b/src/main/webapp/app/faq/faq.component.ts @@ -1,8 +1,8 @@ import { Component, OnDestroy, OnInit, inject } from '@angular/core'; -import { Faq } from 'app/entities/faq.model'; -import { faEdit, faFilter, faPencilAlt, faPlus, faSort, faTrash } from '@fortawesome/free-solid-svg-icons'; -import { BehaviorSubject, Subject } from 'rxjs'; -import { debounceTime, map } from 'rxjs/operators'; +import { Faq, FaqState } from 'app/entities/faq.model'; +import { faCancel, faCheck, faEdit, faFilter, faPencilAlt, faPlus, faSort, faTrash } from '@fortawesome/free-solid-svg-icons'; +import { Subject } from 'rxjs'; +import { map } from 'rxjs/operators'; import { AlertService } from 'app/core/util/alert.service'; import { ActivatedRoute } from '@angular/router'; import { FaqService } from 'app/faq/faq.service'; @@ -16,20 +16,26 @@ import { ArtemisSharedComponentModule } from 'app/shared/components/shared-compo import { ArtemisSharedModule } from 'app/shared/shared.module'; import { ArtemisMarkdownModule } from 'app/shared/markdown.module'; import { SearchFilterComponent } from 'app/shared/search-filter/search-filter.component'; +import { AccountService } from 'app/core/auth/account.service'; +import { Course } from 'app/entities/course.model'; +import { TranslateService } from '@ngx-translate/core'; @Component({ selector: 'jhi-faq', templateUrl: './faq.component.html', styleUrls: [], standalone: true, - imports: [ArtemisSharedModule, CustomExerciseCategoryBadgeComponent, ArtemisSharedComponentModule, ArtemisMarkdownModule, SearchFilterComponent], + imports: [ArtemisSharedModule, CustomExerciseCategoryBadgeComponent, ArtemisSharedComponentModule, ArtemisMarkdownModule], }) export class FaqComponent implements OnInit, OnDestroy { + protected readonly FaqState = FaqState; faqs: Faq[]; + course: Course; filteredFaqs: Faq[]; existingCategories: FaqCategory[]; courseId: number; hasCategories: boolean = false; + isAtleastInstrucor: boolean = false; private dialogErrorSource = new Subject(); dialogError$ = this.dialogErrorSource.asObservable(); @@ -46,11 +52,15 @@ export class FaqComponent implements OnInit, OnDestroy { faPencilAlt = faPencilAlt; faFilter = faFilter; faSort = faSort; + faCancel = faCancel; + faCheck = faCheck; private faqService = inject(FaqService); private route = inject(ActivatedRoute); private alertService = inject(AlertService); private sortService = inject(SortService); + private accountService = inject(AccountService); + private translateService = inject(TranslateService); constructor() { this.predicate = 'id'; @@ -64,6 +74,14 @@ export class FaqComponent implements OnInit, OnDestroy { this.searchInput.pipe(debounceTime(300)).subscribe((searchTerm: string) => { this.refreshFaqList(searchTerm); }); + this.route.data.subscribe((data) => { + const course = data['course']; + if (course) { + this.course = course; + this.isAtleastInstrucor = this.accountService.isAtLeastInstructorInCourse(course); + console.log(this.isAtleastInstrucor); + } + }); } ngOnDestroy(): void { @@ -142,4 +160,22 @@ export class FaqComponent implements OnInit, OnDestroy { this.applyFilters(); this.applySearch(searchTerm); } + + rejectFaq(courseId: number, faq: Faq) { + faq.faqState = FaqState.REJECTED; + faq.course = this.course; + this.faqService.update(courseId, faq).subscribe({ + next: () => this.alertService.success(this.translateService.instant('artemisApp.faq.rejected', { id: faq.id })), + error: (error: HttpErrorResponse) => this.dialogErrorSource.next(error.message), + }); + } + + acceptProposedFaq(courseId: number, faq: Faq) { + faq.faqState = FaqState.ACCEPTED; + faq.course = this.course; + this.faqService.update(courseId, faq).subscribe({ + next: () => this.alertService.success(this.translateService.instant('artemisApp.faq.accepted', { id: faq.id })), + error: (error: HttpErrorResponse) => this.dialogErrorSource.next(error.message), + }); + } } diff --git a/src/main/webapp/app/faq/faq.service.ts b/src/main/webapp/app/faq/faq.service.ts index bcdd824c671c..db06e44f9f5d 100644 --- a/src/main/webapp/app/faq/faq.service.ts +++ b/src/main/webapp/app/faq/faq.service.ts @@ -24,7 +24,13 @@ export class FaqService { ); } + proposeFaq(courseId: number, faq: Faq) { + faq.faqState = FaqState.PROPOSED; + this.create(courseId, faq); + } + update(courseId: number, faq: Faq): Observable { + console.log(faq); const copy = FaqService.convertFaqFromClient(faq); return this.http.put(`${this.resourceUrl}/${courseId}/faqs/${faq.id}`, copy, { observe: 'response' }).pipe( map((res: EntityResponseType) => { @@ -47,6 +53,14 @@ export class FaqService { .pipe(map((res: EntityArrayResponseType) => FaqService.convertFaqCategoryArrayFromServer(res))); } + findAllByCourseIdAndState(courseId: number, faqState: FaqState): Observable { + return this.http + .get(`${this.resourceUrl}/${courseId}/faq-state/${faqState}`, { + observe: 'response', + }) + .pipe(map((res: EntityArrayResponseType) => FaqService.convertFaqCategoryArrayFromServer(res))); + } + delete(courseId: number, faqId: number): Observable> { return this.http.delete(`${this.resourceUrl}/${courseId}/faqs/${faqId}`, { observe: 'response' }); } diff --git a/src/main/webapp/app/overview/course-faq/course-faq.component.ts b/src/main/webapp/app/overview/course-faq/course-faq.component.ts index 03fd207fda21..80bf8fa9bffb 100644 --- a/src/main/webapp/app/overview/course-faq/course-faq.component.ts +++ b/src/main/webapp/app/overview/course-faq/course-faq.component.ts @@ -7,7 +7,7 @@ import { ButtonType } from 'app/shared/components/button.component'; import { ArtemisSharedComponentModule } from 'app/shared/components/shared-component.module'; import { ArtemisSharedModule } from 'app/shared/shared.module'; import { CourseFaqAccordionComponent } from 'app/overview/course-faq/course-faq-accordion-component'; -import { Faq } from 'app/entities/faq.model'; +import { Faq, FaqState } from 'app/entities/faq.model'; import { FaqService } from 'app/faq/faq.service'; import { HttpErrorResponse, HttpResponse } from '@angular/common/http'; import { AlertService } from 'app/core/util/alert.service'; @@ -71,7 +71,7 @@ export class CourseFaqComponent implements OnInit, OnDestroy { private loadFaqs() { this.faqService - .findAllByCourseId(this.courseId) + .findAllByCourseIdAndState(this.courseId, FaqState.ACCEPTED) .pipe(map((res: HttpResponse) => res.body)) .subscribe({ next: (res: Faq[]) => { diff --git a/src/main/webapp/i18n/de/faq.json b/src/main/webapp/i18n/de/faq.json index 0cb07d298310..1dd3b4f2ac19 100644 --- a/src/main/webapp/i18n/de/faq.json +++ b/src/main/webapp/i18n/de/faq.json @@ -4,12 +4,17 @@ "home": { "title": "FAQ", "createLabel": "FAQ erstellen", + "proposeLabel": "FAQ vorschlagen", + "accept": "FAQ aktzeptieren", + "reject": "FAQ ablehnen", "filterLabel": "Filter", "createOrEditLabel": "FAQ erstellen oder bearbeiten" }, - "created": "Das FAQ wurde erfolgreich erstellt", - "updated": "Das FAQ wurde erfolgreich aktualisiert", - "deleted": "Das FAQ wurde erfolgreich gelöscht", + "created": "Das FAQ mit der ID {{ id }} wurde erfolgreich erstellt", + "updated": "Das FAQ mit der ID {{ id }} wurde erfolgreich aktualisiert", + "deleted": "Das FAQ mit der ID {{ param }} wurde erfolgreich gelöscht", + "accepted": "Das FAQ mit der ID {{ id }} wurde erfolgreich aktzeptiert", + "rejected": "Das FAQ mit der ID {{ id }} wurde erfolgreich abgelehnt", "delete": { "question": "Soll die FAQ {{ title }} wirklich dauerhaft gelöscht werden? Diese Aktion kann NICHT rückgängig gemacht werden!", "typeNameToConfirm": "Bitte gib den Namen des FAQ zur Bestätigung ein." @@ -18,7 +23,8 @@ "table": { "questionTitle": "Fragentitel", "questionAnswer": "Antwort auf die Frage", - "categories": "Kategorien" + "categories": "Kategorien", + "state": "Status" }, "course": "Kurs" } diff --git a/src/main/webapp/i18n/en/faq.json b/src/main/webapp/i18n/en/faq.json index 1a158eb52c40..c736c2602278 100644 --- a/src/main/webapp/i18n/en/faq.json +++ b/src/main/webapp/i18n/en/faq.json @@ -4,12 +4,17 @@ "home": { "title": "FAQ", "createLabel": "Create a new FAQ", + "proposeLabel": "Propose a new FAQ", + "accept": "Accept FAQ", + "reject": "Reject FAQ", "filterLabel": "Filter", "createOrEditLabel": "Create or edit FAQ" }, - "created": "The FAQ was successfully created", - "updated": "The FAQ was successfully updated", - "deleted": "The FAQ was successfully deleted", + "created": "The FAQ with ID {{ id }} was successfully created", + "updated": "The FAQ with ID {{ id }} was successfully updated", + "deleted": "The FAQ with ID {{ param }} was successfully deleted", + "accepted": "The FAQ with ID {{ id }} was successfully accepted", + "rejected": "The FAQ with ID {{ id }} was successfully rejected", "delete": { "question": "Are you sure you want to permanently delete the FAQ {{ title }}? This action can NOT be undone!", "typeNameToConfirm": "Please type in the name of the FAQ to confirm." @@ -18,7 +23,8 @@ "table": { "questionTitle": "Question title", "questionAnswer": "Question answer", - "categories": "Categories" + "categories": "Categories", + "state": "State" }, "course": "Course" } From 872076220b096a1114c1c08c6fff1fa57955fe65 Mon Sep 17 00:00:00 2001 From: Tim Cremer Date: Wed, 9 Oct 2024 13:23:30 +0200 Subject: [PATCH 21/23] First draft implementation: Added test cases --- src/main/webapp/app/faq/faq.component.ts | 13 ++++-- src/main/webapp/app/faq/faq.service.ts | 7 --- .../communication/FaqIntegrationTest.java | 25 ++++++++++- .../spec/component/faq/faq.component.spec.ts | 44 +++++++++++++++++-- .../course-faq/course-faq.component.spec.ts | 8 ++-- .../spec/service/faq.service.spec.ts | 20 +++++++++ 6 files changed, 97 insertions(+), 20 deletions(-) diff --git a/src/main/webapp/app/faq/faq.component.ts b/src/main/webapp/app/faq/faq.component.ts index ec2967abc31e..d5b3e425b66f 100644 --- a/src/main/webapp/app/faq/faq.component.ts +++ b/src/main/webapp/app/faq/faq.component.ts @@ -79,7 +79,6 @@ export class FaqComponent implements OnInit, OnDestroy { if (course) { this.course = course; this.isAtleastInstrucor = this.accountService.isAtLeastInstructorInCourse(course); - console.log(this.isAtleastInstrucor); } }); } @@ -162,20 +161,28 @@ export class FaqComponent implements OnInit, OnDestroy { } rejectFaq(courseId: number, faq: Faq) { + const previousState = faq.faqState; faq.faqState = FaqState.REJECTED; faq.course = this.course; this.faqService.update(courseId, faq).subscribe({ next: () => this.alertService.success(this.translateService.instant('artemisApp.faq.rejected', { id: faq.id })), - error: (error: HttpErrorResponse) => this.dialogErrorSource.next(error.message), + error: (error: HttpErrorResponse) => { + this.dialogErrorSource.next(error.message); + faq.faqState = previousState; + }, }); } acceptProposedFaq(courseId: number, faq: Faq) { + const previousState = faq.faqState; faq.faqState = FaqState.ACCEPTED; faq.course = this.course; this.faqService.update(courseId, faq).subscribe({ next: () => this.alertService.success(this.translateService.instant('artemisApp.faq.accepted', { id: faq.id })), - error: (error: HttpErrorResponse) => this.dialogErrorSource.next(error.message), + error: (error: HttpErrorResponse) => { + this.dialogErrorSource.next(error.message); + faq.faqState = previousState; + }, }); } } diff --git a/src/main/webapp/app/faq/faq.service.ts b/src/main/webapp/app/faq/faq.service.ts index db06e44f9f5d..ed6edc06c57e 100644 --- a/src/main/webapp/app/faq/faq.service.ts +++ b/src/main/webapp/app/faq/faq.service.ts @@ -16,7 +16,6 @@ export class FaqService { create(courseId: number, faq: Faq): Observable { const copy = FaqService.convertFaqFromClient(faq); - copy.faqState = FaqState.ACCEPTED; return this.http.post(`${this.resourceUrl}/${courseId}/faqs`, copy, { observe: 'response' }).pipe( map((res: EntityResponseType) => { return res; @@ -24,13 +23,7 @@ export class FaqService { ); } - proposeFaq(courseId: number, faq: Faq) { - faq.faqState = FaqState.PROPOSED; - this.create(courseId, faq); - } - update(courseId: number, faq: Faq): Observable { - console.log(faq); const copy = FaqService.convertFaqFromClient(faq); return this.http.put(`${this.resourceUrl}/${courseId}/faqs/${faq.id}`, copy, { observe: 'response' }).pipe( map((res: EntityResponseType) => { diff --git a/src/test/java/de/tum/cit/aet/artemis/communication/FaqIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/communication/FaqIntegrationTest.java index 5f226f52d4dc..a89c0ee8b3b8 100644 --- a/src/test/java/de/tum/cit/aet/artemis/communication/FaqIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/communication/FaqIntegrationTest.java @@ -15,6 +15,7 @@ import de.tum.cit.aet.artemis.communication.domain.Faq; import de.tum.cit.aet.artemis.communication.domain.FaqState; +import de.tum.cit.aet.artemis.communication.dto.FaqDTO; import de.tum.cit.aet.artemis.communication.repository.FaqRepository; import de.tum.cit.aet.artemis.core.domain.Course; import de.tum.cit.aet.artemis.core.exception.EntityNotFoundException; @@ -31,13 +32,16 @@ class FaqIntegrationTest extends AbstractSpringIntegrationIndependentTest { private Faq faq; + private FaqDTO faqDTO; + @BeforeEach void initTestCase() throws Exception { int numberOfTutors = 2; userUtilService.addUsers(TEST_PREFIX, 1, numberOfTutors, 0, 1); List courses = courseUtilService.createCoursesWithExercisesAndLectures(TEST_PREFIX, true, true, numberOfTutors); this.course1 = this.courseRepository.findByIdWithExercisesAndExerciseDetailsAndLecturesElseThrow(courses.getFirst().getId()); - this.faq = FaqFactory.generateFaq(course1, FaqState.ACCEPTED, "answer", "title"); + this.faq = FaqFactory.generateFaq(course1, FaqState.PROPOSED, "answer", "title"); + this.faqDTO = new FaqDTO(faq); faqRepository.save(this.faq); // Add users that are not in the course userUtilService.createAndSaveUser(TEST_PREFIX + "student42"); @@ -116,7 +120,8 @@ void updateFaq_IdsDoNotMatch_shouldNotUpdateFaq() throws Exception { Faq faq = faqRepository.findById(this.faq.getId()).orElseThrow(); faq.setQuestionTitle("Updated"); faq.setFaqState(FaqState.PROPOSED); - Faq updatedFaq = request.putWithResponseBody("/api/courses/" + faq.getCourse().getId() + 1 + "/faqs/" + faq.getId(), faq, Faq.class, HttpStatus.BAD_REQUEST); + faq.setId(faq.getId() + 1); + Faq updatedFaq = request.putWithResponseBody("/api/courses/" + course1.getId() + "/faqs/" + (faq.getId() - 1), faq, Faq.class, HttpStatus.BAD_REQUEST); } @Test @@ -161,4 +166,20 @@ void deleteFaq_IdsDoNotMatch_shouldNotDeleteFAQ() throws Exception { assertThat(faqOptional).isPresent(); } + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testgetFaqByCourseId() throws Exception { + Set faqs = faqRepository.findAllByCourseIdAndFaqState(this.course1.getId(), FaqState.PROPOSED); + Set returnedFaqs = request.get("/api/courses/" + course1.getId() + "/faqs", HttpStatus.OK, Set.class); + assertThat(returnedFaqs).hasSize(faqs.size()); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testgetFaqByCourseIdAndState() throws Exception { + Set faqs = faqRepository.findAllByCourseIdAndFaqState(this.course1.getId(), FaqState.PROPOSED); + Set returnedFaqs = request.get("/api/courses/" + course1.getId() + "/faq-state/" + "PROPOSED", HttpStatus.OK, Set.class); + assertThat(returnedFaqs).hasSize(faqs.size()); + } + } diff --git a/src/test/javascript/spec/component/faq/faq.component.spec.ts b/src/test/javascript/spec/component/faq/faq.component.spec.ts index d9f8b84c6cd5..6fe12d58bb4c 100644 --- a/src/test/javascript/spec/component/faq/faq.component.spec.ts +++ b/src/test/javascript/spec/component/faq/faq.component.spec.ts @@ -9,7 +9,7 @@ import { MockRouter } from '../../helpers/mocks/mock-router'; import { MockTranslateService } from '../../helpers/mocks/service/mock-translate.service'; import { ArtemisTestModule } from '../../test.module'; import { FaqService } from 'app/faq/faq.service'; -import { Faq } from 'app/entities/faq.model'; +import { Faq, FaqState } from 'app/entities/faq.model'; import { ArtemisMarkdownEditorModule } from 'app/shared/markdown-editor/markdown-editor.module'; import { BrowserAnimationsModule } from '@angular/platform-browser/animations'; @@ -18,6 +18,8 @@ import { FaqCategory } from 'app/entities/faq-category.model'; import { CustomExerciseCategoryBadgeComponent } from 'app/shared/exercise-categories/custom-exercise-category-badge/custom-exercise-category-badge.component'; import { AlertService } from 'app/core/util/alert.service'; import { SortService } from 'app/shared/service/sort.service'; +import { MockAccountService } from '../../helpers/mocks/service/mock-account.service'; +import { AccountService } from 'app/core/auth/account.service'; function createFaq(id: number, category: string, color: string): Faq { const faq = new Faq(); @@ -25,6 +27,7 @@ function createFaq(id: number, category: string, color: string): Faq { faq.questionTitle = 'questionTitle'; faq.questionAnswer = 'questionAnswer'; faq.categories = [new FaqCategory(category, color)]; + faq.faqState = FaqState.PROPOSED; return faq; } @@ -57,12 +60,11 @@ describe('FaqComponent', () => { providers: [ { provide: TranslateService, useClass: MockTranslateService }, { provide: Router, useClass: MockRouter }, + { provide: AccountService, useClass: MockAccountService }, { provide: ActivatedRoute, useValue: { - parent: { - data: of({ course: { id: 1 } }), - }, + data: of({ course: { id: 1 } }), snapshot: { paramMap: convertToParamMap({ courseId: '1', @@ -188,4 +190,38 @@ describe('FaqComponent', () => { faqComponent.sortRows(); expect(sortService.sortByProperty).toHaveBeenCalledOnce(); }); + + it('should reject faq properly', () => { + jest.spyOn(faqService, 'update').mockReturnValue(of(new HttpResponse({ body: faq1 }))); + faqComponentFixture.detectChanges(); + faqComponent.rejectFaq(courseId, faq1); + expect(faqService.update).toHaveBeenCalledExactlyOnceWith(courseId, faq1); + expect(faq1.faqState).toEqual(FaqState.REJECTED); + }); + + it('should not change status if rejection fails', () => { + const error = { status: 500 }; + jest.spyOn(faqService, 'update').mockReturnValue(throwError(() => new HttpErrorResponse(error))); + faqComponentFixture.detectChanges(); + faqComponent.rejectFaq(courseId, faq1); + expect(faqService.update).toHaveBeenCalledExactlyOnceWith(courseId, faq1); + expect(faq1.faqState).toEqual(FaqState.PROPOSED); + }); + + it('should accepts proposed faq properly', () => { + jest.spyOn(faqService, 'update').mockReturnValue(of(new HttpResponse({ body: faq1 }))); + faqComponentFixture.detectChanges(); + faqComponent.acceptProposedFaq(courseId, faq1); + expect(faqService.update).toHaveBeenCalledExactlyOnceWith(courseId, faq1); + expect(faq1.faqState).toEqual(FaqState.ACCEPTED); + }); + + it('should not change status if acceptance fails', () => { + const error = { status: 500 }; + jest.spyOn(faqService, 'update').mockReturnValue(throwError(() => new HttpErrorResponse(error))); + faqComponentFixture.detectChanges(); + faqComponent.acceptProposedFaq(courseId, faq1); + expect(faqService.update).toHaveBeenCalledExactlyOnceWith(courseId, faq1); + expect(faq1.faqState).toEqual(FaqState.PROPOSED); + }); }); diff --git a/src/test/javascript/spec/component/overview/course-faq/course-faq.component.spec.ts b/src/test/javascript/spec/component/overview/course-faq/course-faq.component.spec.ts index f7795a433603..43a2e61cbf5a 100644 --- a/src/test/javascript/spec/component/overview/course-faq/course-faq.component.spec.ts +++ b/src/test/javascript/spec/component/overview/course-faq/course-faq.component.spec.ts @@ -16,7 +16,7 @@ import { ArtemisSharedComponentModule } from 'app/shared/components/shared-compo import { ArtemisSharedModule } from 'app/shared/shared.module'; import { CustomExerciseCategoryBadgeComponent } from 'app/shared/exercise-categories/custom-exercise-category-badge/custom-exercise-category-badge.component'; import { CourseFaqAccordionComponent } from 'app/overview/course-faq/course-faq-accordion-component'; -import { Faq } from 'app/entities/faq.model'; +import { Faq, FaqState } from 'app/entities/faq.model'; import { FaqCategory } from 'app/entities/faq-category.model'; import { SearchFilterComponent } from 'app/shared/search-filter/search-filter.component'; @@ -69,7 +69,7 @@ describe('CourseFaqs', () => { }, }, MockProvider(FaqService, { - findAllByCourseId: () => { + findAllByCourseIdAndState: () => { return of( new HttpResponse({ body: [faq1, faq2, faq3], @@ -118,10 +118,10 @@ describe('CourseFaqs', () => { }); it('should fetch faqs when initialized', () => { - const findAllSpy = jest.spyOn(faqService, 'findAllByCourseId'); + const findAllSpy = jest.spyOn(faqService, 'findAllByCourseIdAndState'); courseFaqComponentFixture.detectChanges(); - expect(findAllSpy).toHaveBeenCalledExactlyOnceWith(1); + expect(findAllSpy).toHaveBeenCalledExactlyOnceWith(1, FaqState.ACCEPTED); expect(courseFaqComponent.faqs).toHaveLength(3); }); diff --git a/src/test/javascript/spec/service/faq.service.spec.ts b/src/test/javascript/spec/service/faq.service.spec.ts index 272a7352a091..ab4960d98354 100644 --- a/src/test/javascript/spec/service/faq.service.spec.ts +++ b/src/test/javascript/spec/service/faq.service.spec.ts @@ -134,6 +134,26 @@ describe('Faq Service', () => { expect(expectedResult.body).toEqual(expected); }); + it('should find faqs by courseId and status', () => { + const category = { + color: '#6ae8ac', + category: 'category1', + } as FaqCategory; + const returnedFromService = [{ ...elemDefault, categories: [JSON.stringify(category)] }]; + const expected = [{ ...elemDefault, categories: [new FaqCategory('category1', '#6ae8ac')] }]; + const courseId = 1; + service + .findAllByCourseIdAndState(courseId, FaqState.ACCEPTED) + .pipe(take(1)) + .subscribe((resp) => (expectedResult = resp)); + const req = httpMock.expectOne({ + url: `api/courses/${courseId}/faq-state/${FaqState.ACCEPTED}`, + method: 'GET', + }); + req.flush(returnedFromService); + expect(expectedResult.body).toEqual(expected); + }); + it('should find all categories by courseId', () => { const category = { color: '#6ae8ac', From 7beeea6a61f6281fdf90d239bbb72a01b6854654 Mon Sep 17 00:00:00 2001 From: Tim Cremer Date: Wed, 9 Oct 2024 16:02:57 +0200 Subject: [PATCH 22/23] fixed tests --- .../spec/component/faq/faq-update.component.spec.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/test/javascript/spec/component/faq/faq-update.component.spec.ts b/src/test/javascript/spec/component/faq/faq-update.component.spec.ts index 04c04b3d12d3..b0736061a8c9 100644 --- a/src/test/javascript/spec/component/faq/faq-update.component.spec.ts +++ b/src/test/javascript/spec/component/faq/faq-update.component.spec.ts @@ -11,7 +11,7 @@ import { MockTranslateService } from '../../helpers/mocks/service/mock-translate import { ArtemisTestModule } from '../../test.module'; import { FaqUpdateComponent } from 'app/faq/faq-update.component'; import { FaqService } from 'app/faq/faq.service'; -import { Faq, FaqState } from 'app/entities/faq.model'; +import { Faq } from 'app/entities/faq.model'; import { BrowserAnimationsModule } from '@angular/platform-browser/animations'; import { AlertService } from 'app/core/util/alert.service'; import { FaqCategory } from 'app/entities/faq-category.model'; @@ -111,7 +111,7 @@ describe('FaqUpdateComponent', () => { faqUpdateComponent.save(); tick(); - expect(createSpy).toHaveBeenCalledExactlyOnceWith(courseId, { faqState: FaqState.ACCEPTED, questionTitle: 'test1' }); + expect(createSpy).toHaveBeenCalledExactlyOnceWith(courseId, { questionTitle: 'test1', faqState: 'PROPOSED' }); expect(faqUpdateComponent.isSaving).toBeFalse(); })); @@ -140,7 +140,7 @@ describe('FaqUpdateComponent', () => { tick(); faqUpdateComponentFixture.detectChanges(); - expect(updateSpy).toHaveBeenCalledExactlyOnceWith(courseId, { id: 6, questionTitle: 'test1Updated' }); + expect(updateSpy).toHaveBeenCalledExactlyOnceWith(courseId, { id: 6, questionTitle: 'test1Updated', faqState: 'PROPOSED' }); })); it('should navigate to previous state', fakeAsync(() => { From ba80f4ebacceb1634459f56c47a09f7571ac6684 Mon Sep 17 00:00:00 2001 From: Tim Cremer Date: Sat, 12 Oct 2024 13:47:36 +0200 Subject: [PATCH 23/23] Added proper alert messages --- .../webapp/app/faq/faq-update.component.ts | 18 +++++-- src/main/webapp/i18n/de/faq.json | 6 ++- src/main/webapp/i18n/en/faq.json | 2 + .../faq/faq-update.component.spec.ts | 54 ++++++++++++++++++- 4 files changed, 72 insertions(+), 8 deletions(-) diff --git a/src/main/webapp/app/faq/faq-update.component.ts b/src/main/webapp/app/faq/faq-update.component.ts index ca16f63e8413..5abd6ac1dd7f 100644 --- a/src/main/webapp/app/faq/faq-update.component.ts +++ b/src/main/webapp/app/faq/faq-update.component.ts @@ -32,7 +32,7 @@ export class FaqUpdateComponent implements OnInit { existingCategories: FaqCategory[]; faqCategories: FaqCategory[]; courseId: number; - isAtleastInstructor: boolean = false; + isAtLeastInstructor: boolean = false; domainActionsDescription = [new FormulaAction()]; // Icons @@ -59,7 +59,7 @@ export class FaqUpdateComponent implements OnInit { if (course) { this.faq.course = course; this.loadCourseFaqCategories(course.id); - this.isAtleastInstructor = this.accountService.isAtLeastInstructorInCourse(course); + this.isAtLeastInstructor = this.accountService.isAtLeastInstructorInCourse(course); } this.faqCategories = faq?.categories ? faq.categories : []; }); @@ -81,7 +81,7 @@ export class FaqUpdateComponent implements OnInit { */ save() { this.isSaving = true; - this.faq.faqState = this.isAtleastInstructor ? FaqState.ACCEPTED : FaqState.PROPOSED; + this.faq.faqState = this.isAtLeastInstructor ? FaqState.ACCEPTED : FaqState.PROPOSED; if (this.faq.id !== undefined) { this.subscribeToSaveResponse(this.faqService.update(this.courseId, this.faq)); } else { @@ -111,13 +111,21 @@ export class FaqUpdateComponent implements OnInit { if (faqBody) { this.faq = faqBody; } - this.alertService.success(this.translateService.instant('artemisApp.faq.created', { id: faq.id })); + if (this.isAtLeastInstructor) { + this.alertService.success(this.translateService.instant('artemisApp.faq.created', { id: faq.id })); + } else { + this.alertService.success(this.translateService.instant('artemisApp.faq.proposed', { id: faq.id })); + } this.router.navigate(['course-management', this.courseId, 'faqs']); }, }); } else { this.isSaving = false; - this.alertService.success(this.translateService.instant('artemisApp.faq.updated', { id: faq.id })); + if (this.isAtLeastInstructor) { + this.alertService.success(this.translateService.instant('artemisApp.faq.updated', { id: faq.id })); + } else { + this.alertService.success(this.translateService.instant('artemisApp.faq.proposedChange', { id: faq.id })); + } this.router.navigate(['course-management', this.courseId, 'faqs']); } } diff --git a/src/main/webapp/i18n/de/faq.json b/src/main/webapp/i18n/de/faq.json index 1dd3b4f2ac19..413239c161e1 100644 --- a/src/main/webapp/i18n/de/faq.json +++ b/src/main/webapp/i18n/de/faq.json @@ -5,15 +5,17 @@ "title": "FAQ", "createLabel": "FAQ erstellen", "proposeLabel": "FAQ vorschlagen", - "accept": "FAQ aktzeptieren", + "accept": "FAQ akzeptieren", "reject": "FAQ ablehnen", "filterLabel": "Filter", "createOrEditLabel": "FAQ erstellen oder bearbeiten" }, "created": "Das FAQ mit der ID {{ id }} wurde erfolgreich erstellt", "updated": "Das FAQ mit der ID {{ id }} wurde erfolgreich aktualisiert", + "proposed": "Das FAQ mit der ID {{ id }} wurde erfolgreich vorgeschlagen", + "proposedChange": "Die Änderungen am FAQ mit der ID {{ id }} wurde erfolgreich vorgeschlagen", "deleted": "Das FAQ mit der ID {{ param }} wurde erfolgreich gelöscht", - "accepted": "Das FAQ mit der ID {{ id }} wurde erfolgreich aktzeptiert", + "accepted": "Das FAQ mit der ID {{ id }} wurde erfolgreich akzeptieren", "rejected": "Das FAQ mit der ID {{ id }} wurde erfolgreich abgelehnt", "delete": { "question": "Soll die FAQ {{ title }} wirklich dauerhaft gelöscht werden? Diese Aktion kann NICHT rückgängig gemacht werden!", diff --git a/src/main/webapp/i18n/en/faq.json b/src/main/webapp/i18n/en/faq.json index c736c2602278..8aeac9a29c8e 100644 --- a/src/main/webapp/i18n/en/faq.json +++ b/src/main/webapp/i18n/en/faq.json @@ -12,6 +12,8 @@ }, "created": "The FAQ with ID {{ id }} was successfully created", "updated": "The FAQ with ID {{ id }} was successfully updated", + "proposed": "The FAQ with ID {{ id }} was successfully proposed", + "proposedChange": "The changes to the FAQ with the ID {{ id }} have been successfully proposed", "deleted": "The FAQ with ID {{ param }} was successfully deleted", "accepted": "The FAQ with ID {{ id }} was successfully accepted", "rejected": "The FAQ with ID {{ id }} was successfully rejected", diff --git a/src/test/javascript/spec/component/faq/faq-update.component.spec.ts b/src/test/javascript/spec/component/faq/faq-update.component.spec.ts index b0736061a8c9..275bd4cb4f48 100644 --- a/src/test/javascript/spec/component/faq/faq-update.component.spec.ts +++ b/src/test/javascript/spec/component/faq/faq-update.component.spec.ts @@ -93,6 +93,32 @@ describe('FaqUpdateComponent', () => { it('should create faq', fakeAsync(() => { faqUpdateComponent.faq = { questionTitle: 'test1' } as Faq; + faqUpdateComponent.isAtLeastInstructor = true; + const createSpy = jest.spyOn(faqService, 'create').mockReturnValue( + of( + new HttpResponse({ + body: { + id: 3, + questionTitle: 'test1', + course: { + id: 1, + }, + } as Faq, + }), + ), + ); + + faqUpdateComponentFixture.detectChanges(); + faqUpdateComponent.save(); + tick(); + + expect(createSpy).toHaveBeenCalledExactlyOnceWith(courseId, { questionTitle: 'test1', faqState: 'ACCEPTED' }); + expect(faqUpdateComponent.isSaving).toBeFalse(); + })); + + it('should propose faq', fakeAsync(() => { + faqUpdateComponent.faq = { questionTitle: 'test1' } as Faq; + faqUpdateComponent.isAtLeastInstructor = false; const createSpy = jest.spyOn(faqService, 'create').mockReturnValue( of( new HttpResponse({ @@ -117,7 +143,7 @@ describe('FaqUpdateComponent', () => { it('should edit a faq', fakeAsync(() => { activatedRoute.parent!.data = of({ course: { id: 1 }, faq: { id: 6 } }); - + faqUpdateComponent.isAtLeastInstructor = true; faqUpdateComponentFixture.detectChanges(); faqUpdateComponent.faq = { id: 6, questionTitle: 'test1Updated' } as Faq; @@ -139,7 +165,33 @@ describe('FaqUpdateComponent', () => { faqUpdateComponent.save(); tick(); faqUpdateComponentFixture.detectChanges(); + expect(updateSpy).toHaveBeenCalledExactlyOnceWith(courseId, { id: 6, questionTitle: 'test1Updated', faqState: 'ACCEPTED' }); + })); + + it('should propose to edit a faq', fakeAsync(() => { + activatedRoute.parent!.data = of({ course: { id: 1 }, faq: { id: 6 } }); + faqUpdateComponent.isAtLeastInstructor = false; + faqUpdateComponentFixture.detectChanges(); + faqUpdateComponent.faq = { id: 6, questionTitle: 'test1Updated' } as Faq; + const updateSpy = jest.spyOn(faqService, 'update').mockReturnValue( + of>( + new HttpResponse({ + body: { + id: 6, + questionTitle: 'test1Updated', + questionAnswer: 'answer', + course: { + id: 1, + }, + } as Faq, + }), + ), + ); + + faqUpdateComponent.save(); + tick(); + faqUpdateComponentFixture.detectChanges(); expect(updateSpy).toHaveBeenCalledExactlyOnceWith(courseId, { id: 6, questionTitle: 'test1Updated', faqState: 'PROPOSED' }); }));