feat: add support to upload tshark to s3

smuu commented 1 month ago

Overview

Closes https://github.com/celestiaorg/knuu/issues/378

Summary by CodeRabbit

New Features
- Introduced the ability to enable and manage Tshark collectors for instances in the test environment.
- Enhanced support for Docker settings and Minio deployment in testing scenarios.
Bug Fixes
- Resolved issues related to instance configuration and command execution during tests.
Refactor
- Updated instance methods to handle Tshark collector configurations seamlessly.
Documentation
- Added comprehensive documentation for new testing functionalities and instance management.

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent changes introduce the ability to trace network packets using Tshark in a test environment set up with the knuu package. This involves creating instances, enabling Tshark data collection, and handling the deployment of sidecars for packet capturing. Additionally, Minio configuration handling is integrated for storing the captured data.

Changes

File	Change Summary
`e2e/tshark/tshark_test.go`	Added `TestTshark` function to set up instances, enable Tshark collector, execute commands, and validate output.
`pkg/instance/helper.go`	Added `tsharkCollectorConfig` field to `Instance` struct and new method `addTsharkCollectorSidecar`.
`pkg/instance/instance.go`	Introduced `TsharkCollectorConfig` struct, added related fields and methods to `Instance` struct.
`pkg/minio/minio.go`	Added `Config` struct to `Minio` and new method `GetConfigs` for retrieving Minio configurations.

Sequence Diagram(s)

sequenceDiagram
    participant Tester as Tester
    participant Knuu as Knuu Package
    participant Instance as Instance
    participant Minio as Minio

    Tester ->> Knuu: New()
    Knuu -->> Tester: knuu instance
    Tester ->> Knuu: NewInstance()
    Knuu -->> Tester: instance
    Tester ->> Instance: SetImage(), SetCommand()
    Tester ->> Instance: EnableTsharkCollector(params)
    Instance ->> Instance: addTsharkCollectorSidecar()
    Tester ->> Knuu: Commit()
    Tester ->> Instance: Start()
    Tester ->> Instance: WaitInstanceIsRunning()
    Tester ->> Instance: ExecuteCommand()
    Tester ->> Minio: DeployMinio()
    Minio -->> Tester: Minio configurations

    note over Instance: Starts collecting packets using Tshark

Assessment against linked issues

Objective	Addressed	Explanation
Ability to trace packets from at least two nodes (#378)	✅
Upload packet trace file to an S3 bucket (#378)	✅

Poem

In code we traverse the network's maze,
With Tshark and packets, we now appraise.
Knuu sets the stage, instances rise,
Minio holds data beneath azure skies.
A rabbit's toil, from dawn till night,
Ensuring the network dances right. 🐰✨

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.

smuu commented 2 weeks ago

Thanks @mojtaba-esk for driving this home!

celestiaorg / knuu