search

celestiaorg / knuu

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

chore: refactor to use logger obj instead #445

Closed mojtaba-esk closed 4 days ago

mojtaba-esk commented 1 week ago

Closes #396

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

[!WARNING]

Review failed

The pull request is closed.

Walkthrough

The update involves a comprehensive refactoring across the codebase to enhance logging capabilities by replacing the global logrus logger with custom logger instances passed through structs. This change improves modularity, composability, and control over logging across multiple packages, particularly focusing on Kubernetes-related functionalities.

Changes

Files/Group Change Summary
pkg/builder/kaniko/kaniko_test.go Updated NewClientCustom call to include a new logger parameter.
pkg/instance/destroy.go, helper.go, instance.go, pool.go Changed logrus logging statements to use i.Logger for the Instance struct.
pkg/k8s/k8s.go Added a logger field to the Client struct and updated NewClient functions to accept a logger.
pkg/k8s/k8s_custom_resource.go Replaced logrus with c.logger for logging in CreateCustomResource function.
pkg/k8s/k8s_daemonset.go Replaced logrus with c.logger for logging in CreateDaemonSet, UpdateDaemonSet, and DeleteDaemonSet functions.
pkg/k8s/k8s_networkpolicy.go Replaced logrus with c.logger for logging in NetworkPolicyExists function.
pkg/k8s/k8s_pod.go Removed logrus import and updated Client struct methods to use c.logger for logging.
pkg/k8s/k8s_pvc.go Replaced logrus with c.logger for logging in CreatePersistentVolumeClaim and DeletePersistentVolumeClaim functions.
pkg/k8s/k8s_replicaset.go Converted prepareReplicaSet to a method of the Client struct and updated logging to use c.logger.
pkg/k8s/k8s_service.go Replaced logrus with c.logger for logging service-related events.
pkg/k8s/test_suite_test.go Added logrus.New() call in the SetupTest() function within the TestSuite struct.
pkg/knuu/knuu.go Updated logging statements to use logger from Knuu struct and updated setDefaults function.

Sequence Diagram(s)

Not applicable for these changes as the modifications are primarily about logging refactoring without significant control flow changes.

Assessment against linked issues

Objective (from #396) Addressed Explanation
Refactor packages to receive a logger object instead of using default logrus ✅

Poem

In code where logs once prosperous grew, A rabbit hopped and knew what to do. With custom loggers bright, It set the codes alight, Bringing clarity to each debugging view.

🚀✨

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.