General: Allow to publish example solutions for modeling, text and file upload exercises on a specific date

[akesfeden]

Checklist

General

• I tested all changes and their related features with all (student, instructor) corresponding user types on a test server locally.
• This is a small issue that I tested locally and was confirmed by another developer on a test server.
• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Server

• I followed the coding and design guidelines.
• I added multiple integration tests (Spring) related to the features (with a high test coverage).
• (No new REST calls) I added @PreAuthorize and checked the course groups for all new REST Calls (security).
• I implemented the changes with a good performance and prevented too many database calls.
• I documented the Java code using JavaDoc style.

Client

• I followed the coding and design guidelines.
• I added multiple unit tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
• (No new routes) I added authorities to all new routes and checked the course groups for displaying navigation elements (links, buttons).
• I documented the TypeScript code using JSDoc style.
• I added multiple screenshots/screencasts of my UI changes.
• I translated all newly inserted strings into English and German.

Motivation and Context

This PR solves #16 for the modeling, text and file upload exercises. It allows example solutions (previously called "sample solution") to be published to the students after a predefined date.

This functionality will be added to the programming exercises in a follow-up PR.

Description

Note: Contains a database migration.

This PR adds example_solution_publication_date to Exercise model and allows instructors to set a date to make the example solution that is already present in the database available to the students for modeling, text and file upload exercises. Currently presenting example solutions is explicitly disabled for exam exercises, it is planned to extend this feature to include them in a follow-up PR. Also, sampleSolution (and similar) fields, attributes, translation strings, etc. are renamed to exampleSolution (and similar) for Modeling, Text and File Upload Exercises because "Example solution" term is preferred over "Sample solution".

Steps for Testing

Contains a migration so please deploy only to TS1 or TS3 (new).
Prerequisites:

• 1 Instructor
• 1 Students
• 1 Modeling Exercise with a Example Solution
• 1 Text Exercise with a Example Solution
• 1 File Upload Exercise with a Example Solution

Instructor:

1. Log in to Artemis
2. Navigate to Course Administration
3. Go to the Edit page of the prerequisite Modeling Exercise.
4. Ensure current Example Solution Publication Date is empty or after current time.

Student:

5. Log in to Artemis
6. Navigate to the prerequisite Modeling Exercise's detail page.
7. Ensure example solution is not visible.

Instructor:

8. Change Example Solution Publication Date of the exercise to a time before current time.

Student:

9. Ensure example solution is visible.

10. Ensure the term "Example solution" is used instead "Sample solution".

11. Repeat steps 1-9 with Modeling Exercise replaced with Text Exercise and File Upload Exercise.

Instructor:

12. Import an existing Modeling Exercise with Example Solution Publication Date set to a non-null date.

13. Ensure new exercise has Example Solution Publication Date set to null.

14. Repeat steps 12-13 with Modeling Exercise replaced with Text Exercise.

Review Progress

Code Review

• Review 1
• Review 2

Manual Tests

• Test 1
• Test 2

Test Coverage

File: Branches % | Lines %

BaseExercise.java: 86% | 99%
FileUploadExercise.java: 100% | 100%
TextExercise.java: 100% | 100%
ModelingExercise.java: 100% | 89%
course-exercise-details.component.ts : 59.23% | 79.6%
modeling-exercise-update.component.ts: 81.92% | 92.07%

Screenshots

Course Management View (For Modeling Exercise)

Course Exercise Detail

Modeling Exercise

Text Exercise

File Upload Exercise

[MerlinMehmed]

Code changes look good

[canberkanar]

I noticed a small client bug although the functionality on the backend is implemented correctly.

• Create a modeling exercise and enter release date of sample solution.
• Re-import the same exercise.
• The sample solution release date of the new exercise should be emptied out but it is not done on the frontend.
• When the imported exercise is saved this way the correct behavior is seen in the backend however I think the date should be cleared as well.

Requested change is implemented

[willergeorg]

Tested on TS3. Checked the bug @canberkanar mentioned, it is fixed now. I also followed your testing steps for a modeling and a text exercise and checked the in exam mode. Did not encounter any problems. Nice work! 👍

[canberkanar]

The client-side issue seen when importing exercises has been resolved.

[ole-ve]

Tested on TS1, works as described and expected 👍
Code changes also look good to me.

[MerlinMehmed]

Code changes look good

[bassner]

Code: 👍