container-registry / harbor-satellite

Harbor Satellite (WIP)
Apache License 2.0
9 stars 2 forks source link

feat: Add E2E Test for Harbor Satellite #27

Closed bupd closed 20 hours ago

bupd commented 1 week ago

Overview:

This PR adds end-to-end testing with dagger.

Changes Introduced:

Prerequisites:

Tests require docker to be installed in the system.

How to Test:

Fixes: #26

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

[!WARNING]

Rate limit exceeded

@bupd has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 46 minutes and 9 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between fa67a73441206c727f750c6a51ca4211e8919776 and 2cf1671df233f6f80f5b9c6f7cbeecf14dc5297d.

Walkthrough

The updates introduce a new feature called "Harbor Satellite" aimed at decentralizing Harbor container registries for edge computing environments. Key changes include configuration and setup files, code implementations for building and running the satellite service, handling image replication and storage, and end-to-end tests. These modifications enable Harbor systems to function reliably in scenarios with intermittent internet connectivity by storing and serving container images locally.

Changes

Files Change Summary
.env, .gitignore, config.toml, config.json Added configuration files for environment variables, registry settings, and gitignore updates to exclude .env file.
README.md Updated to reflect the new "Harbor Satellite" project details, use cases, background, and proposal.
ci/main.go, main.go Introduced constants, new functions for satellite service, and configuration setup using viper.
go.mod Updated and added module dependencies for handling container registries and environment variables.
image-list/images.json New JSON file for storing image repository information.
internal/replicate/replicate.go Refactored functions to handle different image schemes and improved image reference handling.
internal/satellite/satellite.go Added functions for creating and running Satellite instances with error handling and immediate execution logic.
internal/store/… Introduced in-memory store, file fetch, and HTTP fetch functionality for managing images.
registry/launch-registry.go New function for initializing and launching the registry server.
test/e2e/… New end-to-end test files for setting up registries, pushing images, and building the satellite service using Dagger.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Satellite
    participant Registry

    User->>Satellite: Start Satellite Service
    activate Satellite
    Satellite->>Registry: Fetch Initial Configurations
    Registry-->>Satellite: Configurations
    User->>Satellite: Request Image
    Satellite->>Registry: Retrieve Image
    Registry-->>Satellite: Image Data
    Satellite-->>User: Serve Image
    deactivate Satellite

    Note over Satellite: Operates independently if registry is unavailable

Poem

In the wired world where data's streamed,
Harbor Satellite ensures dreams, At the edge where signals wane,
A beacon stands amidst the rain.
Images stored with care so neat,
Ensuring service, never beat.
Cheers to code, now furrows light,
Harbor's edge, forever bright! 🌟


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.
bupd commented 3 days ago

@Vad1mo ready to merge.