Development: Fix missing source files in Jacoco report

[ole-ve]

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.

Motivation and Context

The Jacoco report did not pick up the correct source files as the path was wrong (should be "src/main/java" instead of including any specific sub-path.

Description

Changes the sourceDirectories to be the exact same one coming from the root task.
Also, use the group and execution data from the rootTask instead of defining explicitly.

Steps for Testing

1. Download a coverage report generated on develop (example, scroll to the end and look for Coverage Report Server Tests)
2. Open a single file
3. See the message Source file ... was not found during generation of report. You cannot click on any methods.
4. Download a coverage report generated by a commit in this branch (example, click on Coverage Report Server Tests)
5. Open the same file, see that this message is gone and you can open a code-view (by clicking on the method name). This code view should highlight covered line green, uncovered lines in red.

Review Process

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Screenshots

Before:

After:

Clicking on a single file:

[coderabbitai]

Walkthrough

The changes update the configuration of the Jacoco report task in the Gradle build file. The prepareJacocoReportTask method now inherits properties such as group, executionData, and sourceDirectories from a root task instead of using hardcoded values. The variable sourcePath has been renamed to classPath, and the logic for setting classDirectories now uses the updated classPath. These modifications ensure that the Jacoco tasks are consistently configured based on the root task settings.

Changes

File	Change Summary
gradle/jacoco.gradle	Updated prepareJacocoReportTask method: now sets task.group, task.executionData, and task.sourceDirectories from the rootTask; replaced sourcePath with classPath for class directories.

Possibly related PRs

• ls1intum/Artemis#10299: Addresses similar modifications in the prepareJacocoReportTask method by updating the configuration for source directories.

Suggested labels

ready for review, small, chore

Suggested reviewers

• krusche
• SimonEntholzer

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

gradle/jacoco.gradle (1)

161-166: Refactor Class Path Determination.
For aggregated modules, the classPath is now set to "$BasePath/**/*.class", and for individual modules it is set to "$BasePath/$moduleName/**/*.class". This refactoring clarifies the file matching pattern. Please double-check that the value of BasePath correctly points to the expected source directory (e.g. "src/main/java") per the PR objectives.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 039e6c8 and a59964d.

📒 Files selected for processing (1)

• gradle/jacoco.gradle (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (8)

• GitHub Check: Call Build Workflow / Build and Push Docker Image
• GitHub Check: Call Build Workflow / Build .war artifact
• GitHub Check: Codacy Static Code Analysis
• GitHub Check: client-style
• GitHub Check: client-tests
• GitHub Check: server-style
• GitHub Check: server-tests
• GitHub Check: Analyse

🔇 Additional comments (3)

gradle/jacoco.gradle (3)

157-159: Inherit Task Properties from Root Task.
The changes on these lines assign the group and executionData properties from the rootTask to the current task. This enhances consistency by ensuring that the Jacoco report tasks inherit configuration centrally.

---

167-167: Align Source Directories with Root Task.
Assigning task.sourceDirectories from rootTask.sourceDirectories ensures that the correct source files are used for the Jacoco report, addressing the issue of missing source files in the report output.

---

170-173: Update Class Directories Inclusion Filter.
By updating the includes property to use the computed classPath, the report now properly filters class files based on the module context while excluding directories as defined in ignoredDirectories. This should help resolve the missing source file problem in the Jacoco report.

[BBesrour]

Nice, thanks for fixing this! Test and code

[tobias-lippert]

Code + Test

[HanyangXu0508]

tested locally and worked as expected

[Cathy0123456789]

Tested and works as described

[jfr2102]

tested, thanks for fixing!