Programming exercises: Exchange of Artemis programming exercises via CodeAbility Sharing Platform

[Wallenstein61]

This pull request resolves issue #3592

Checklist

This pull request is "Work in Progress". Please bear with us.

General

• I tested all changes and their related features with all corresponding user types on a test server.
• 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

• Important: I implemented the changes with a very good performance and prevented too many (unnecessary) and too complex database calls.
• I strictly followed the principle of data economy for all database calls.
• I strictly followed the server coding and design guidelines.
• I added multiple integration tests (Spring) related to the features (with a high test coverage).
• I added pre-authorization annotations according to the guidelines and checked the course groups for all new REST Calls (security).
• I documented the Java code using JavaDoc style.

Client

• Important: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data (e.g. using paging).
• I strictly followed the principle of data economy for all client-server REST calls.
• I strictly followed the client coding and design guidelines.
• Following the theming guidelines, I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
• I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
• 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.

Changes affecting Programming Exercises

• High priority: I tested all changes and their related features with all corresponding user types on a test server configured with the integrated lifecycle setup (LocalVC and LocalCI).
• I tested all changes and their related features with all corresponding user types on a test server configured with Gitlab and Jenkins.

Motivation and Context

The CodeAbility Project currently operates and maintains a platform for sharing (among other content) programming exercises between interested parties. It is open to the programming teaching community.

CodeAbility also operates an Artemis instance that serves its 6 Austrian partners as a platform for programming teaching.
Artemis is currently a major source of programming exercises, as well as a potential target for re-using programming exercises.
However the exchange between separated instances of Artemis is only supported by a manual exchange of zipped exercises files.

We have implemented a REST-based connector interface in the sharing platform to import and export exercises between interested applications.
This connector interface allows among other features the import and export of programming exercises in an appropriate format.

We have already implemented an prototype integration of Artemis with the sharing platform based on the connector interface in order to allow for the smooth sharing of exercises.

Description

An additional spring profile "sharing" is implemented, that enables the functionality to export/import programming exercises via the sharing plattform.

The sharing requires an registration of the artemis instance at [email protected]. During the registration a pre shared key is exchanged, that allows the communication between artemis and the sharing plattform.

When the sharing profile is enabled, (and configuration is initialized properly), the the sharing platform connects regularly with the artemis instance to query the connector configuration.
Additional the artemis instance can trigger an configuration request for the sharing plattform at application startup.

Details can be found at https://sharing-codeability.uibk.ac.at/development/sharing/codeability-sharing-platform/-/wikis/Artemis-Connection/Connector-Interface

Steps for Testing

Export from Artemis to the sharing plattform

Prerequisites:

• 1 Instructor
  with additional access right to the sharing plattform gitlab instance (https://sharing-codeability.uibk.ac.at)

1. Log in to Artemis
2. Log in to Sharing Plattform
3. Navigate in Artemis to Course Administration
4. Select a course / select an programming exercise, you should see an extra button https://user-images.githubusercontent.com/18215713/122518965-314c3a00-d012-11eb-920c-afb3fe029c66.png
5. After clicking this button, the user is transferred to the sharing platform and can enter the missing meta data for programming exercise.
6. After clicking on submit, the user can select a gitlab folder (aka namespace) where to put the exercise

Expected Result:

1. The programming exercise is stored in gitlab
2. The programming exercise can be found via the sharing platform search interface

Import from the sharing plattform to Artemis

Prerequisites:

• 1 Instructor
  with additional access right to the sharing plattform gitlab instance (https://sharing-codeability.uibk.ac.at)

1. Log in to Artemis
2. Log in to Sharing Platform
3. Search an Exercise via the Search Interface (select: format 'artemis')
4. Click on "More ..." to open the detail view
5. Click on "Export to Artemis"
6. The user is transferred to Artemis to select the course to import to
   https://user-images.githubusercontent.com/18215713/122518891-1aa5e300-d012-11eb-92a8-4c76f8fb31ac.png
7. Click on "Import Exercise ..." . The user is transferred to the "update exercise" page. Most of the exercise configuration should be already filled.
8. The user adjusts the data and clicks on "Import"

Expected Result:

1. The programming exercise is added to the selected course.

Testserver States

Work in Progress: It has to be clarified, against how the integration sharing platform instance at https://sharing.codeability-austria.uibk.ac.at/static/SharingCodeAbility.html

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.

Review Progress

Work in Progress: It has to be clarified, against how the integration sharing platform instance at https://sharing.codeability-austria.uibk.ac.at/static/SharingCodeAbility.html

Performance Review

• I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance even for very large courses with more than 2000 students.
• I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance even for very large courses with more than 2000 students.

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Exam Mode Test

• Test 1
• Test 2

Performance Tests

• Test 1
• Test 2

Test Coverage

Screenshots

Work in Progress: Please bear with us!