Development: Tune data export test to prevent flakyness

[N0W0RK]

Checklist

General

• 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 strictly followed the server coding and design guidelines.
• I added multiple integration tests (Spring) related to the features (with a high test coverage).
• I documented the Java code using JavaDoc style.

Motivation and Context

Tests for the export nof science events were flaky.
This was probably related to timestamps of differtent test events beeing to close together causing issues wit hte custom comparator.

Description

Fixes test timestamps at save intervals.

Review Progress

Code Review

• Code Review 1
• Code Review 2

Summary by CodeRabbit

• New Features

  • Enhanced event creation flexibility by allowing predefined timestamps for science events.
  • Improved timestamp handling in event creation to increase accuracy and precision.

• Bug Fixes

  • Addressed timestamp discrepancies in data export logic.

• Refactor

  • Streamlined the event comparison logic for better maintainability and clarity.

• Style

  • Updated comments in test code for improved readability and understanding.

[coderabbitai]

Walkthrough

The recent updates enhance the functionality and maintainability of the ScienceUtilService and DataExportCreationServiceTest classes. The createScienceEvent method now accepts a ZonedDateTime timestamp parameter, increasing flexibility. Additionally, the comparator for ScienceEvent was refactored for improved efficiency. In the test class, timestamp handling was refined for greater precision in data exports, and the code's readability was enhanced with clearer comments.

Changes

File	Change Summary
src/test/java/de/tum/in/www1/artemis/science/ScienceUtilService.java	Updated createScienceEvent to accept a ZonedDateTime timestamp parameter for enhanced flexibility. Refactored comparator logic for efficiency.
src/test/java/de/tum/in/www1/artemis/service/DataExportCreationServiceTest.java	Improved test readability and logic. Updated createScienceEvents to round timestamps for precision in data export. Comments reformatted for clarity.

---

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 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

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

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.

[coderabbitai]

Actionable comments posted: 1

[SimonEntholzer]

I think the code changes make sense and fix the flakyness. I'm just not that sure about the comments changes, especially the ones which really weren't that long, but I think that's personal taste.

[pzdr7]

Same as Simon - some of the line breaks in the comments seem a bit early, especially when you look at the lines surrounding the comment

[JohannesStoehr]

Re-approve

[pzdr7]

Code

[github-actions]

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

[BBesrour]

code

[MaximilianAnzinger]

Maintainer approved