chore: refactor knuu object to use options as argument

mojtaba-esk commented 3 months ago

This PR proposes a change to use options as an argument in the new function instead of using WithFuncs.

Summary by CodeRabbit

Refactor
- Improved code readability and maintainability by centralizing configuration options into a single Options struct.
- Replaced individual option functions with a unified Options struct for easier management.
Tests
- Updated test cases to use the new Options struct instead of individual options, ensuring consistency and simplifying test setup.

coderabbitai[bot] commented 3 months 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 48 minutes and 8 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 83fb824325b98f6521fca27ad7ad1b321100b26b and 005067e96e24d37193a36dc8169a62333e44a37a.

Walkthrough

The changes involve refactoring the Knuu struct and its initialization process to use a consolidated Options struct instead of individual Option functions. This improves readability and maintainability by centralizing configuration options and separating specific functionalities into dedicated functions. The updates affect various test files and the main implementation files, ensuring consistent usage of the new Options struct across the codebase.

Changes

Files	Change Summary
`e2e/bittwister/suite_setup_test.go`	Updated `SetupSuite` to use `knuu.Options{ProxyEnabled: true}` instead of `knuu.WithProxyEnabled()`.
`e2e/system/build_from_git_test.go`	Modified `TestBuildFromGit` to initialize `kn` with `knuu.Options{}`.
`pkg/knuu/knuu.go`	Refactored `Knuu` struct and `New` function to use `Options` struct, added `setDefaults`, `setupProxy`, `loadEnvVariables` functions.
`pkg/knuu/knuu_old.go`	Updated `InitializeWithScope` to pass options as a struct `Options`.
`pkg/knuu/knuu_test.go`	Replaced `options` slice with `Options` struct in test cases.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TestSuite
    participant Knuu

    User->>TestSuite: Initialize Test
    TestSuite->>Knuu: New(ctx, Options{...})
    Knuu->>Knuu: setDefaults()
    Knuu->>Knuu: setupProxy()
    Knuu-->>TestSuite: Return Knuu instance
    TestSuite-->>User: Test initialized

Possibly related issues

celestiaorg/knuu#410: The refactor to use an Options struct addresses the issue of simplifying the initialization process and reducing the need for multiple With* functions.

Poem

In the code where options roam, A refactor brings them home. No more scattered, all in one, Easier now, the work is done. With Options set, the path is clear, For Knuu to shine, year after year. 🌟

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.

mojtaba-esk commented 3 months ago

Closes #410

Thanks for finding it. I did not.

celestiaorg / knuu