Exam mode: Add exam update audit event

[coolchock]

Checklist

General

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

Description

This pull request introduces an audit event for tracking updates made to exams.

Steps for Testing

Prerequisites:

• 1 Admin (ts3)
• 1 Exam

1. Log in to Artemis
2. Navigate to Course Management -> Select a course -> Exams -> Select an Exam
3. Edit an exam (for example change title or working time)
4. Navigate to Server Administrations -> Audits
5. Verify that UPDATE_EXAM audit event appears in the table

Testserver States

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

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

Summary by CodeRabbit

• New Features

  • Introduced a new constant for exam operations: UPDATE_EXAM.
  • Added audit logging for exam updates to enhance tracking of changes.
  • Improved validation for importing exams and updating exercise groups to prevent conflicts.

• Bug Fixes

  • Enhanced validation for suspicious exam sessions to ensure proper parameters are provided.

These updates improve the management and integrity of exam-related functionalities within the application.

[coderabbitai]

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 pmd (7.7.0)

src/main/java/de/tum/cit/aet/artemis/core/config/Constants.java

The following rules are missing or misspelled in your ruleset file category/vm/bestpractices.xml: BooleanInstantiation, DontImportJavaLang, DuplicateImports, EmptyFinallyBlock, EmptyIfStmt, EmptyInitializer, EmptyStatementBlock, EmptyStatementNotInLoop, EmptySwitchStatements, EmptySynchronizedBlock, EmptyTryBlock, EmptyWhileStmt, ExcessiveClassLength, ExcessiveMethodLength, ImportFromSamePackage, MissingBreakInSwitch, SimplifyBooleanAssertion. Please check your ruleset configuration.

src/main/java/de/tum/cit/aet/artemis/exam/web/ExamResource.java

The following rules are missing or misspelled in your ruleset file category/vm/bestpractices.xml: BooleanInstantiation, DontImportJavaLang, DuplicateImports, EmptyFinallyBlock, EmptyIfStmt, EmptyInitializer, EmptyStatementBlock, EmptyStatementNotInLoop, EmptySwitchStatements, EmptySynchronizedBlock, EmptyTryBlock, EmptyWhileStmt, ExcessiveClassLength, ExcessiveMethodLength, ImportFromSamePackage, MissingBreakInSwitch, SimplifyBooleanAssertion. Please check your ruleset configuration.

Walkthrough

This pull request introduces a new constant UPDATE_EXAM in the Constants class and implements several modifications to the ExamResource class. Key changes include the addition of audit event logging in the updateExam method, enhanced validation in the importExamWithExercises method, and checks in the updateOrderOfExerciseGroups and getAllSuspiciousExamSessions methods to maintain data integrity. These changes collectively improve the functionality and robustness of exam management within the application.

Changes

File Path	Change Summary
src/main/java/de/tum/cit/aet/artemis/core/config/Constants.java	Added constant: public static final String UPDATE_EXAM = "UPDATE_EXAM";
src/main/java/de/tum/cit/aet/artemis/exam/web/ExamResource.java	- Added audit logging in updateExam method. - Updated importExamWithExercises to check for existing exam ID. - Modified createExam to check for exercise group conflicts. - Updated updateOrderOfExerciseGroups to ensure matching exercise group counts. - Enhanced getAllSuspiciousExamSessions to validate ipSubnet parameter.

Possibly related PRs

• Exam mode: Fix an issue where notification button and message do not show up during exam #8914: This PR involves changes to the exam interface, which may indirectly relate to the new constant UPDATE_EXAM added in the main PR, as it pertains to exam functionalities.
• Exam mode: Adjust display of quiz on exam summary pdf #8953: This PR modifies the display of quiz exercises in the exam summary PDF, which could be relevant to the exam-related constants introduced in the main PR.
• Exam mode: Generate student exam on demand if student is registered for the exam #9123: This PR enhances the generation of student exams, which is closely related to the exam functionalities that the new constant in the main PR supports.
• Exam mode: Update student documentation #9625: This PR updates student documentation regarding the exam process, which is relevant to the exam functionalities associated with the new constant added in the main PR.

Suggested labels

client, bugfix, documentation

Suggested reviewers

• SimonEntholzer
• egekurt123
• krusche
• BBesrour

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8036d43 and 7552cdb.

📒 Files selected for processing (2)

• src/main/java/de/tum/cit/aet/artemis/core/config/Constants.java (1 hunks)
• src/main/java/de/tum/cit/aet/artemis/exam/web/ExamResource.java (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

src/main/java/de/tum/cit/aet/artemis/core/config/Constants.java (1)

Pattern src/main/java/**/*.java: naming:CamelCase; principles:{single_responsibility,small_methods,no_duplication}; db:{perf_queries,datetime_not_timestamp}; rest:{stateless,singleton,delegate_logic,http_only,minimal_dtos}; dtos:{java_records,no_entities,min_data,single_resp}; di:constructor_injection; kiss:simple_code; file_handling:os_indep_paths; practices:{least_access,avoid_transactions,code_reuse,static_member_ref,prefer_primitives}; sql:{param_annotation,uppercase,avoid_subqueries};java:avoid_star_imports

src/main/java/de/tum/cit/aet/artemis/exam/web/ExamResource.java (1)

Pattern src/main/java/**/*.java: naming:CamelCase; principles:{single_responsibility,small_methods,no_duplication}; db:{perf_queries,datetime_not_timestamp}; rest:{stateless,singleton,delegate_logic,http_only,minimal_dtos}; dtos:{java_records,no_entities,min_data,single_resp}; di:constructor_injection; kiss:simple_code; file_handling:os_indep_paths; practices:{least_access,avoid_transactions,code_reuse,static_member_ref,prefer_primitives}; sql:{param_annotation,uppercase,avoid_subqueries};java:avoid_star_imports

🔇 Additional comments (2)

src/main/java/de/tum/cit/aet/artemis/exam/web/ExamResource.java (1)

280-283: Audit event logging added correctly after exam update

The audit event is appropriately logged after updating an exam, ensuring that changes are tracked. The use of Constants.UPDATE_EXAM maintains consistency in audit event types.

src/main/java/de/tum/cit/aet/artemis/core/config/Constants.java (1)

195-196: New audit event constant UPDATE_EXAM added

The constant UPDATE_EXAM is correctly added to the Constants class for use in audit event logging.

---

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>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[SimonEntholzer]

code

[BBesrour]

Tested on TS3, editing an exam is shown in the audit view. Would be great to display some additional information in the future like exam ID.
Also code lgtm

[EneaGore]

Tested on TS3. Works as expected.

[Malekos74]

Is there a way to access "Server Administrations -> Audits" with a test account?

[raffifasaro]

code