Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: sanitize name & ns test err #490

Merged
merged 1 commit into from
Jul 5, 2024

Conversation

mojtaba-esk
Copy link
Contributor

@mojtaba-esk mojtaba-esk commented Jul 5, 2024

There were two issues causing the tests fail.

  1. Sanitize name was called in the begning of knuu.New
  2. In the Namespace test, expected error was not updated so caused it to fail

This PR suggest to fix it

Summary by CodeRabbit

  • Bug Fixes

    • Corrected error handling in namespace existence tests to accurately reflect internal server errors.
  • Refactor

    • Simplified the initialization process by removing unnecessary sanitization of the TestScope field during validation.

@mojtaba-esk mojtaba-esk enabled auto-merge July 5, 2024 09:19
Copy link
Contributor

coderabbitai bot commented Jul 5, 2024

Walkthrough

The recent changes include modifying the error handling in a Kubernetes namespace test and altering the behavior of a function responsible for creating a new Knuu instance by removing the sanitization of the TestScope field before validation. These updates adjust the error expectations in the testing framework and influence how validation is performed during the initialization of Knuu objects.

Changes

Files Change Summary
pkg/k8s/k8s_namespace_test.go Updated expectedErr in TestNamespaceExists from a wrapped error to a direct reference to errInternalServerError.
pkg/knuu/knuu.go Modified New function to skip the sanitization of TestScope before validating options.

Poem

In the land of code, changes flow like wine,
With testing errors clear, and scopes divine.
Knuu now starts with a cleaner slate,
Validations unfurl without a wait.
Oh, how the logic danced and swirled,
A better, brighter, coding world! 🚀🐇


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
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>.
    • 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 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.

@mojtaba-esk mojtaba-esk self-assigned this Jul 5, 2024
@mojtaba-esk mojtaba-esk requested a review from a team July 5, 2024 09:20
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6f81e52 and 6de93c0.

Files selected for processing (2)
  • pkg/k8s/k8s_namespace_test.go (1 hunks)
  • pkg/knuu/knuu.go (1 hunks)
Additional comments not posted (2)
pkg/k8s/k8s_namespace_test.go (1)

231-231: Update the expected error.

The expectedErr value has been simplified to errInternalServerError, which matches the error returned by the mock setup. This change is correct and ensures the test checks for the correct error.

pkg/knuu/knuu.go (1)

49-51: Ensure proper validation of TestScope.

The TestScope field is no longer sanitized before validating options. Ensure that validateOptions handles any necessary sanitization or validation to prevent potential issues with unsanitized input.

@smuu smuu disabled auto-merge July 5, 2024 09:52
@smuu smuu merged commit 61cf919 into main Jul 5, 2024
14 of 18 checks passed
@smuu smuu deleted the mojtaba/fix-sanitize-name-err-and-ns-test-err branch July 5, 2024 09:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants