chore: add a check for Instance state when cloning

mojtaba-esk commented 1 month ago

Closes #531

Summary by CodeRabbit

New Features
- Introduced a new error message for cloning instances that are not in an appropriate state.
- Added validation to ensure instances can only be cloned if they are in the StateCommitted or StateStopped states.
Documentation
- Enhanced comments in the cloning method to clarify cloning behavior, especially concerning state requirements.
Tests
- Improved test cases for the Tshark struct by adding a logger and ensuring proper configuration of the test instance before cloning.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes introduce a new error variable ErrCannotCloneInstance in the pkg/instance/errors.go file to improve error handling when cloning instances. Additionally, the CloneWithName method in pkg/instance/instance.go is updated to enforce state checks, allowing cloning only if the instance is in StateCommitted or StateStopped. This modification enhances the control flow regarding instance cloning and provides clearer documentation about the cloning behavior, particularly concerning sidecars.

Changes

File Path	Change Summary
pkg/instance/errors.go	Added new error variable `ErrCannotCloneInstance` with a specific message.
pkg/instance/instance.go	Updated `CloneWithName` method to include state validation for cloning. Added a comment clarifying cloning behavior for sidecars.
pkg/sidecars/tshark/tshark_test.go	Enhanced `TestTsharkClone` with logger initialization and proper configuration of `testInstance`.

Assessment against linked issues

Objective	Addressed	Explanation
Check for instance state in `CloneWithSuffix` (#531)	❌	The changes do not address the `CloneWithSuffix` method.

Poem

In the fields where instances play,
A rabbit hops, brightening the day.
With states to check and errors to share,
Cloning now has a thoughtful care.
"Cannot clone!" it softly sings,
As it guards the joy that cloning brings! 🐇✨

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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### 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](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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

tty47 commented 1 month ago

hello! I found the CI broken, is it expected?

    build_image_test.go:35: 
            Error Trace:    /home/runner/work/knuu/knuu/e2e/system/build_image_test.go:35
            Error:          Received unexpected error:
                            build failed
            Test:           TestRunSuite/TestOneVolumeTwoFiles
            Messages:       Error setting git repo
--- FAIL: TestRunSuite (134.40s)
    --- PASS: TestRunSuite/TestStartWithCallback (1.70s)
    --- FAIL: TestRunSuite/TestBuildFromGit (9.38s)
panic: test executed panic(nil) or runtime.Goexit

mojtaba-esk commented 1 month ago

hello! I found the CI broken, is it expected? ...

No it is not expected. something might be wrong.

mojtaba-esk commented 1 month ago

When I run the failing test TestRunSuite/TestBuildFromGit locally it passes:

=== RUN   TestRunSuite
time="2024-10-08T15:46:06+03:30" level=info msg="Current log level" file="log/logger.go:41" env_log_level=LOG_LEVEL log_level=info
    suite_setup_test.go:53: Scope: 20241008-154533-860
=== RUN   TestRunSuite/TestBuildFromGit
=== PAUSE TestRunSuite/TestBuildFromGit
=== RUN   TestRunSuite/TestBuildFromGitWithModifications
=== PAUSE TestRunSuite/TestBuildFromGitWithModifications
=== CONT  TestRunSuite/TestBuildFromGit
=== CONT  TestRunSuite/TestBuildFromGitWithModifications
    build_image_test.go:22: Creating new instance
    build_image_test.go:64: Creating new instance
    build_image_test.go:68: Setting git repo
    build_image_test.go:26: Building the image
    build_image_test.go:36: Image built
    build_image_test.go:40: Starting instance
    build_image_test.go:43: Instance started
    build_image_test.go:45: Getting file bytes
=== NAME  TestRunSuite
    suite.go:59: Cleaning up knuu...
    suite.go:63: Knuu is cleaned up
--- PASS: TestRunSuite (54.40s)
    --- PASS: TestRunSuite/TestBuildFromGit (24.49s)
    --- PASS: TestRunSuite/TestBuildFromGitWithModifications (43.83s)
PASS
ok      github.com/celestiaorg/knuu/e2e/system  98.264s

celestiaorg / knuu