Development: Adjust server tests to restructuring into modules

[MaximilianAnzinger]

Checklist

General

• I chose a title conforming to the naming conventions for pull requests.

Motivation and Context

After restructuring the server (prod) module structure, these changes adjust the test-code structure to the new prod-code structure.

Note: Most of the changes just come from moving files and methods.

Description

In detail, this includes:

• Moving tests to the same modules in test code that exist in prod code incl. adjusting (file) paths
• Adding test_repository subpackage to each module if this module uses a test repository
• Each existing TestRepository implements the respective (prod) Repository. If such a test repository exists, the prod repository must not be used in any test (-> arch test)
• Methods in prod repositories that are only used by test code must reside in the respective test repository (arch test)
• Each TestRepository must be annotated with @primary as otherwise, this causes conflicts with the prod-repository (arch test)
• AnswerMessageIntegrationTest#testCreateAnswerInExamChannel has been disabled. This test fails with JsonException No _valueDeserializer assigned but only if run as part of the whole test suite. The root cause for this issue is unclear.

Review Progress

Code Review

• Code Review 1
• Code Review 2

Summary by CodeRabbit

• Bug Fixes

  • Removed several methods from various repository interfaces, which may affect how users retrieve specific data.
  • Adjusted the functionality for retrieving user and course-related data, streamlining the user experience.

• Chores

  • Reorganized the AuditResource class into a more specific package for better project structure.

[coderabbitai]

Walkthrough

The pull request involves the removal of several methods from various repository interfaces in the codebase. These changes affect how certain entities, such as CompetencyProgress, LearningPath, ScienceEvent, and User, can be queried. The modifications streamline the repository interfaces by eliminating methods that may no longer be necessary or relevant, thus simplifying the overall code structure.

Changes

File	Change Summary
src/main/java/de/tum/cit/aet/artemis/atlas/repository/CompetencyProgressRepository.java	Method removed: findByCompetencyIdAndUserIdOrElseThrow(long competencyId, long userId).
src/main/java/de/tum/cit/aet/artemis/atlas/repository/LearningPathRepository.java	Method removed: findWithEagerCompetenciesByCourseIdAndUserIdElseThrow(long courseId, long userId).
src/main/java/de/tum/cit/aet/artemis/atlas/repository/ScienceEventRepository.java	Method removed: findAllByType(ScienceEventType type).
src/main/java/de/tum/cit/aet/artemis/communication/repository/ConversationParticipantRepository.java	Method removed: findConversationParticipantByConversationIdAndUserIdElseThrow(Long conversationId, Long userId).
src/main/java/de/tum/cit/aet/artemis/communication/repository/PostRepository.java	Method removed: findPostsByAuthorIdAndCourseId(@Param("authorId") long authorId, @Param("courseId") long courseId).
src/main/java/de/tum/cit/aet/artemis/communication/repository/ReactionRepository.java	Methods removed: findReactionsByPostId(Long postId), findReactionsByAnswerPostId(Long answerPostId).
src/main/java/de/tum/cit/aet/artemis/communication/repository/conversation/ChannelRepository.java	Method removed: findCourseWideChannelsInCourse(@Param("courseId") long courseId).
src/main/java/de/tum/cit/aet/artemis/communication/repository/conversation/ConversationRepository.java	Method removed: List<Conversation> findAllByCourseId(long courseId);.
src/main/java/de/tum/cit/aet/artemis/communication/repository/conversation/OneToOneChatRepository.java	Method removed: findByIdWithConversationParticipantsAndUserGroups(@Param("oneToOneChatId") Long oneToOneChatId).
src/main/java/de/tum/cit/aet/artemis/core/repository/CourseRepository.java	Methods removed: findWithEagerLearningPathsAndCompetenciesAndPrerequisitesById(long courseId), default Course findWithEagerLearningPathsAndCompetenciesAndPrerequisitesByIdElseThrow(long courseId).
src/main/java/de/tum/cit/aet/artemis/core/repository/DataExportRepository.java	Method removed: findAllSuccessfullyCreatedDataExports().
src/main/java/de/tum/cit/aet/artemis/core/repository/UserRepository.java	Multiple methods removed related to user learning paths and deletion status.

Possibly related PRs

• Adaptive learning: Add endpoint to retrieve student course metrics #8508: Introduces a new endpoint to fetch exercise-related data, which may relate to the changes in how competencies and learning paths are managed in the main PR.
• Development: Remove java assert statements #8574: Focuses on removing Java assert statements, which may indirectly relate to the overall code quality improvements seen in the main PR.
• Development: Fix cases of ignored return values #8575: Addresses ignored return values, which could be relevant to ensuring that repository methods in the main PR are correctly utilized.
• Development: Add dynamic fetches to simplify complexity in repositories #8607: Introduces dynamic fetching methods in repositories, aligning with the changes in repository methods in the main PR.
• Development: Improve code quality of competency and learning path repositories #8875: Improves the code quality of competency and learning path repositories, directly relating to the changes made in the main PR.
• Integrated code lifecycle: Add access tokens for authentication to LocalVC repositories #8929: Adds access tokens for authentication to LocalVC repositories, which may relate to the overall repository management changes in the main PR.
• Integrated code lifecycle: Add access log for repositories #9184: Adds access logs for repositories, which could be relevant to the changes in repository functionality in the main PR.
• Development: Fix cron task name in data export schedule tests #9312: Fixes the path of domain objects in the client, which may relate to the overall structure and organization of the code in the main PR.
• Development: Merge test classes for same service #9359: Merges test classes for the same service, which may relate to the overall testing improvements in the main PR.

Suggested labels

code quality, small, maintainer-approved

Suggested reviewers

• JohannesStoehr
• krusche
• pzdr7
• EneaGore
• coolchock
• Strohgelaender

---

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.

[cremertim]

Re-approve after new commit

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between a4d4947 and b2b58e7.

📒 Files selected for processing (6)

• src/main/java/de/tum/cit/aet/artemis/assessment/repository/ComplaintResponseRepository.java (0 hunks)
• src/main/java/de/tum/cit/aet/artemis/assessment/repository/ResultRepository.java (0 hunks)
• src/main/java/de/tum/cit/aet/artemis/exercise/repository/SubmissionRepository.java (0 hunks)
• src/main/java/de/tum/cit/aet/artemis/programming/repository/ProgrammingExerciseRepository.java (0 hunks)
• src/test/java/de/tum/cit/aet/artemis/assessment/TutorEffortIntegrationTest.java (2 hunks)
• src/test/java/de/tum/cit/aet/artemis/assessment/service/CourseScoreCalculationServiceTest.java (3 hunks)

💤 Files not reviewed due to no reviewable changes (4)

• src/main/java/de/tum/cit/aet/artemis/assessment/repository/ComplaintResponseRepository.java
• src/main/java/de/tum/cit/aet/artemis/assessment/repository/ResultRepository.java
• src/main/java/de/tum/cit/aet/artemis/exercise/repository/SubmissionRepository.java
• src/main/java/de/tum/cit/aet/artemis/programming/repository/ProgrammingExerciseRepository.java

🧰 Additional context used

📓 Path-based instructions (2)

src/test/java/de/tum/cit/aet/artemis/assessment/TutorEffortIntegrationTest.java (1)

Pattern src/test/java/**/*.java: test_naming: descriptive; test_size: small_specific; fixed_data: true; junit5_features: true; assert_use: assertThat; assert_specificity: true; archunit_use: enforce_package_rules; db_query_count_tests: track_performance; util_service_factory_pattern: true; avoid_db_access: true; mock_strategy: static_mocks; context_restart_minimize: true

src/test/java/de/tum/cit/aet/artemis/assessment/service/CourseScoreCalculationServiceTest.java (1)

Pattern src/test/java/**/*.java: test_naming: descriptive; test_size: small_specific; fixed_data: true; junit5_features: true; assert_use: assertThat; assert_specificity: true; archunit_use: enforce_package_rules; db_query_count_tests: track_performance; util_service_factory_pattern: true; avoid_db_access: true; mock_strategy: static_mocks; context_restart_minimize: true

📓 Learnings (1)

src/test/java/de/tum/cit/aet/artemis/assessment/service/CourseScoreCalculationServiceTest.java (1)

Learnt from: Strohgelaender
PR: ls1intum/Artemis#8030
File: src/main/java/de/tum/in/www1/artemis/service/CourseScoreCalculationService.java:21-49
Timestamp: 2024-02-16T16:56:16.054Z
Learning: The project consistently avoids using star-imports in Java files.

🔇 Additional comments (6)

src/test/java/de/tum/cit/aet/artemis/assessment/TutorEffortIntegrationTest.java (4)

21-22: LGTM: Import statements updated correctly.

The import statements have been updated to use the new test repository classes, which aligns with the PR objective of adjusting server tests to the restructured modules. The naming convention for test repositories is consistent, using the "Test" suffix.

Also applies to: 25-26

---

60-60: LGTM: Test case initialization updated correctly.

The initTestCase method has been updated to use the new TextSubmissionTestRepository, which aligns with the PR objective of adjusting server tests to the restructured modules. The method name, although long, is descriptive and follows the Spring Data naming conventions.

---

63-63: LGTM: User repository updated to test repository.

The change from userRepository to userTestRepository is consistent with the overall shift to using test repositories in this integration test. This aligns with the PR objectives and maintains consistency with other test repository usage in the file.

---

Line range hint 1-143: Overall assessment: Changes align with PR objectives.

The modifications to TutorEffortIntegrationTest.java successfully implement the transition to test repositories, which aligns with the PR objective of adjusting server tests to the restructured modules. The existing test logic remains unchanged, maintaining the current test coverage.

A minor naming inconsistency was noted for one repository field, but this doesn't impact functionality. Consider addressing this for improved code consistency.

The changes in this file appear to be ready for merging, pending the suggested minor improvement.

src/test/java/de/tum/cit/aet/artemis/assessment/service/CourseScoreCalculationServiceTest.java (2)

1-1: Package structure change aligns with modular restructuring.

The package change from de.tum.cit.aet.artemis.service to de.tum.cit.aet.artemis.assessment.service appropriately reflects the assessment-specific nature of this service, aligning with the PR's objective of restructuring the code into modules.

---

52-58: Variable type updates align with test repository usage.

The changes from StudentParticipationRepository to StudentParticipationTestRepository and ResultRepository to ResultTestRepository are consistent with the PR objective of using test repositories in place of production repositories for tests. This separation enhances the distinction between test and production code, promoting better maintainability and reducing potential conflicts.

[raffifasaro]

code LGTM