chore: add code coverage

[paul-nicolas]

No description provided.

[coderabbitai]

Walkthrough

The pull request introduces enhancements to the project's build and testing infrastructure by modifying the Earthfile and README.md. The changes focus on improving test configuration flexibility, allowing conditional integration test execution and optional coverage reporting. A Codecov badge is also added to the README to provide visibility into code coverage metrics.

Changes

File	Change Summary
Earthfile	- Added includeIntegrationTests argument with default "true" - Added coverage argument - Implemented conditional logic for test execution and coverage profiling
README.md	- Added Codecov badge to existing badge collection

Poem

🐰 In Earthly realms of code so bright,
Tests dance with flags of pure delight
Coverage tracked, integration's might
Badges gleam with metrics' light
A rabbit's build, precise and tight! 🔬

---

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 anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

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 (5)

Earthfile (5)

70-70: Use descriptive default value for includeIntegrationTests.
Currently, the default value is "true", which may be confusing. Consider providing a descriptive comment or a more explicit rationale for this default to help future contributors.

---

72-72: Document coverage argument usage for clarity.
While adding this argument enhances flexibility, it would be helpful to add a short comment describing valid values (e.g., true or empty) and their effects on the build/test process.

---

77-77: Confirm the necessity of -race for all test runs.
Enabling -race on every test run can increase test runtime and resource usage. If race detection is not required for certain builds, consider making it conditional or providing an option to disable it.

---

78-84: Combine coverage flags for legibility.
Combining multiple coverage flags into a single line can improve readability. For example, grouping -covermode and -coverpkg arguments into one SET goFlags=... statement.

Here’s an example diff snippet to illustrate a refactor:

IF [ "$coverage" = "true" ]
-    SET goFlags="$goFlags -covermode=atomic"
-    SET goFlags="$goFlags -coverpkg=github.com/formancehq/payments/internal/..."
-    SET goFlags="$goFlags,github.com/formancehq/payments/pkg/events/..."
-    SET goFlags="$goFlags,github.com/formancehq/payments/cmd/..."
-    SET goFlags="$goFlags -coverprofile coverage.txt"
+    SET goFlags="$goFlags -covermode=atomic -coverpkg=github.com/formancehq/payments/internal/...,github.com/formancehq/payments/pkg/events/...,github.com/formancehq/payments/cmd/... -coverprofile coverage.txt"
END

---

99-101: Automate coverage upload to Codecov.
This step saves the coverage report locally. Consider adding an automated upload step to continuously track coverage changes via Codecov.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ad7a898 and e877ba6.

⛔ Files ignored due to path filters (1)

• .github/workflows/main.yml is excluded by !**/*.yml

📒 Files selected for processing (2)

• Earthfile (2 hunks)
• README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[style] ~1-~1: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1380 characters long)
Context: # Formance Payments [![discord](https://img.shields.io/discord...

(EN_EXCESSIVE_EXCLAMATION)

🔇 Additional comments (1)

README.md (1)

1-1: Appreciate the new Codecov badge!
The Codecov badge integration complements the new coverage arguments in the Earthfile, enhancing visibility into test coverage. Everything looks good here.

🧰 Tools

🪛 LanguageTool

[style] ~1-~1: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1380 characters long)
Context: # Formance Payments [![discord](https://img.shields.io/discord...

(EN_EXCESSIVE_EXCLAMATION)