Development: Remove unnecessary build plan information from the exam conduction payload

[laurenzfb]

Checklist

General

• I tested all changes and their related features with all corresponding user types 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) database calls.
• I strictly followed the server coding and design guidelines.

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).

Motivation and Context

Build script and config are included in the server payload sent to the client when a student exam is being conducted. They contain information the student should not be able to see.

Description

This PR removes both fields before the payload is sent to the client.

Exam Mode Testing

Prerequisites:

• 1 Student
• 1 Exam with a Programming Exercise

1. Open developer tools in your browser and go the network tab
2. When starting the exam, you should receive a item "conduction"
3. Check the payload. The object should not contain the fields buildScript and buildPlanConfiguration

Testserver States

Note

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

Review Progress

Performance Review

• I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance

Code Review

• Code Review 1
• Code Review 2

Exam Mode Test

• Test 1
• Test 2

Test Coverage

Server

Class/File	Line Coverage	Confirmation (assert/expect)
ProgrammingExercise.java	91%	✅
StudentExamResource.java	86%	✅

Screenshots

Summary by CodeRabbit

• New Features
  • Enhanced privacy by removing build script and configuration information from programming exercises before quizzes are loaded.
• Bug Fixes
  • Ensured that programming exercises are properly prepared with default build plan creation for both tests and exercises.
• Tests
  • Expanded integration tests to cover new scenarios, including the addition of text modeling programming exercises to exams and the verification of programming exercise properties.

[coderabbitai]

Walkthrough

The recent updates focus on enhancing security and testing for programming exercises within a learning management system. Key changes include stripping build scripts and configurations from programming exercises to safeguard sensitive information during quiz conduction. Additionally, the testing framework has been expanded to cover new scenarios involving text, modeling, and programming exercises, ensuring a more robust examination process. These changes contribute to a secure and comprehensive testing environment for students.

Changes

File Path	Change Summary
.../web/rest/StudentExamResource.java	Removed build script and configuration information from programming exercises before loading quizzes.
.../domain/ProgrammingExercise.java	Added nullification of build plan configuration and build script in filterSensitiveInformation().
.../exam/StudentExamIntegrationTest.java	Enhanced exam utility service to include various exercise types and added assertions for ProgrammingExercise properties.
.../programmingexercise/ProgrammingExerciseFactory.java	Set up build script and build plan configuration for unreleased programming exercises.
.../programmingexercise/ProgrammingExerciseGitlabJenkinsIntegrationTest.java, .../programmingexercise/ProgrammingExerciseTemplateIntegrationTest.java	Introduced AeolusTarget enumeration and forceDefaultBuildPlanCreation method for testing with default build plan creation.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[tobias-lippert]

Code LGTM, can you add/extend a test for this change?

[Strohgelaender]

Is this only an issue for this one endpoint? If not, you should probably add this to the filterSensitiveInformation method that gets consitently used for many endpoints.

[rstief]

Code looks good 😃
But yeah this should probably be checked in a test :)

[MaximilianAnzinger]

Code

[pzdr7]

Reapproving as only the server tests have change since my previous review

[pzdr7]

Reapprove

[reschandreas]

tested locally, works as exepected. Thanks for fixing this!

[bassner]

LGTM