search

celestiaorg / knuu

Integration Test Framework
Apache License 2.0
38 stars 31 forks source link

chore: refactor funcs to receive resource.Quantity type #444

Closed mojtaba-esk closed 4 days ago

mojtaba-esk commented 1 week ago

Closes #426

Summary by CodeRabbit

These changes ensure more reliable and precise handling of CPU, memory, and volume resources, leading to better performance and stability.

coderabbitai[bot] commented 1 week ago

[!WARNING]

Rate limit exceeded

@mojtaba-esk has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 48 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 54c65e92ef859b4948092920d6cf223431ad866a and 1e1db06db90fa441d7930ab13e8f16b94d50dff0.

Walkthrough

Recent changes across multiple files (including pkg/instance/executor.go, pkg/instance/helper.go, and others) involve refactoring the handling of memory and CPU limits in various structs and methods. Instead of using strings, the code now uses resource.Quantity from the Kubernetes API to ensure proper resource management. This prevents errors and inconsistencies in resource allocation.

Changes

Files Change Summary
pkg/instance/executor.go CPU and memory limits now use resource.MustParse instead of plain strings to ensure proper parsing and resource management.
pkg/instance/helper.go Renamed variables for clarity and changed the way volume sizes are processed in the deployVolume function.
pkg/instance/instance.go Updated the Instance struct and several methods to use resource.Quantity for resource management instead of strings.
pkg/instance/otel.go Modified createOtelCollectorInstance to use resource.MustParse for CPU and memory settings.
pkg/instance/tshark.go Updated to use resource.MustParse for setting CPU, memory values, and volume sizes.
pkg/k8s/k8s_pod.go Adjusted types in ContainerConfig and Volume structs to use resource.Quantity. Updated related methods accordingly.
pkg/k8s/types.go Modified NewVolume function to accept resource.Quantity for the size parameter.
pkg/knuu/instance_old.go Updated methods to use resource.MustParse for parsing resource sizes and limits from strings.
pkg/minio/minio.go Changed createPVC method to accept resource.Quantity for storage size and updated constant to a variable using resource.MustParse.

Sequence Diagram(s)

No diagrams generated as the changes are focused on refactoring resource handling and do not introduce new features or complex control flow alterations.

Assessment against linked issues

Objective Addressed Explanation
Refactor resource allocation functions to use resource.Quantity (#426) ✅

Poem

In fields where bytes and limits reign,
Resources parsed, no more a strain.
Memory, CPU, now parsed with glee,
From strings to quantities, error-free.
A rabbit hops through code so grand,
With Kubernetes, hand in hand.
🎉🐇🌾

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.