celestiaorg / knuu

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

chore!: make minio client optional and improve initialization #434

Closed mojtaba-esk closed 4 days ago

mojtaba-esk commented 3 weeks ago

Closes #429

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes introduce a new field client of type *miniogo.Client in the Minio struct to optimize client reuse across requests. This improvement seeks to enhance performance by reusing a single Minio client instance. The New method initializes the client, while existing methods utilize this client for network operations, reducing redundant client creation.

Changes

Files Change Summary
pkg/minio/minio.go Added client field to Minio struct. Introduced New method for client initialization. Updated methods to use client instead of creating a new instance.
pkg/builder/kaniko/kaniko.go Renamed K8s to K8sClient and Minio to MinioClient in Kaniko struct. Updated related method calls accordingly.
e2e/tshark/tshark_test.go Initialized Minio client with minio.New(ctx, k8sClient) instead of direct deployment in TestTshark.
pkg/knuu/knuu.go Renamed variables in Options struct. Added Timeout field. Introduced validateOptions function. Adjusted logic in New function to validate options.
e2e/system/build_from_git_test.go Modified kn initialization by passing k8sClient and minioClient. Added TestBuildFromGitWithModifications function.
e2e/system/main_test.go Commented out knuu initialization and logging statements in TestMain.
e2e/bittwister/suite_setup_test.go Modified SetupSuite method to initialize Knuu with specific options and adjusted error handling.
pkg/knuu/errors.go Added new error variables ErrTestScopeNotSet, ErrK8sClientNotSet, and ErrTestScopeMistMatch.
pkg/knuu/knuu_test.go Removed minio import. Added test case for Minio enabled. Adjusted test cases for Knuu initialization options.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Minio
    Client->>Minio: Initialize
    Minio->>Client: Return client instance
    Client->>Minio: PushToMinio / DeleteFromMinio / GetMinioURL
    Minio->>Client: Ensure client initialization via New method
    Client->>Minio: Perform Minio operations

Assessment against linked issues

Objective Addressed Explanation
Reuse Minio client across requests for improved performance (Issue #429) βœ…
Refactor to reduce initialization overhead and leverage connection pooling (Issue #429) βœ…

Poem

In the land of code a change was made,
To stop the Minio client cascade,
One client to rule, to share the load,
Performance lifts, in speed mode.
A leap for bunnies, a hop in time,
Efficiency sings, in code’s sweet rhyme. πŸš€πŸ°


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.