fix: test scope mismatch error

[mojtaba-esk]

This PR proposes a fix to resolve an error is reported by @cmwaters:

❯ go run ./test/e2e/benchmark TwoNodeSimple
test-e2e-benchmark2024/07/22 10:49:10 === RUN TwoNodeSimple
test-e2e-benchmark2024/07/22 10:49:10 Running TwoNodeSimple
test-e2e-benchmark2024/07/22 10:49:10 version acf7fc1
{"level":"info","time":"2024-07-22T10:49:10+02:00","message":"Checking Grafana environment variables"}
{"level":"info","time":"2024-07-22T10:49:10+02:00","message":"Grafana environment variables found"}
INFO[0000] Initializing knuu with scope: TwoNodeSimple_20240722_104910 
INFO[2024-07-22T10:49:10+02:00]log/logger.go:37 LOG_LEVEL: info                              
2024/07/22 10:49:34 failed to create benchmark test: cannot initialize knuu: test scope 'TwoNodeSimple_20240722_104910' set in options does not match scope 'twonodesimple-20240722-104910' set by the k8sClient namespace
exit status 1

The main issue is that the namespace (scope) which is coming from the k8s clinet is already passed through the Sanitizer which lowers all the letters, but the validate option in knuu.New does not pass it before check it against it.
This PR adds that to the check.

Summary by CodeRabbit

• New Features
  • Introduced enhanced validation for the TestScope to ensure it is properly sanitized before comparison, improving robustness against invalid characters or formatting issues.

[coderabbitai]

Walkthrough

The recent changes enhance the validation process in the validateOptions function of the knuu package. By introducing a sanitization step for the TestScope field, the update ensures that the comparison with the Kubernetes client namespace is reliable and free from formatting issues. This improvement bolsters the integrity of namespace validation, contributing to a more robust and error-resistant application.

Changes

File	Change Summary
pkg/knuu/knuu.go	Added a sanitization step in validateOptions to validate TestScope against a sanitized name.

Possibly related issues

• Consider renaming TestScope field in knuu struct for more clarity #456: The renaming of the TestScope field as suggested in this issue could further clarify its purpose, addressing potential confusion alongside the validation improvements made in this PR.

🐇 In a land where namespaces play,
A rabbit hops, making changes today.
With TestScope now sanitized right,
Validation shines, oh what a sight!
So let’s celebrate with a joyful cheer,
For cleaner code is what we hold dear! 🥕✨

---

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
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a122afa and 65d1235.

Files selected for processing (1)

• pkg/knuu/knuu.go (1 hunks)