cozystack icon indicating copy to clipboard operation
cozystack copied to clipboard

Introduce new test framework

Open kvaps opened this issue 6 months ago • 1 comments

Signed-off-by: Andrei Kvapil [email protected]

kvaps avatar May 23 '25 18:05 kvaps

Walkthrough

The end-to-end test process for CozyStack has been refactored from a single shell script to a modular system using Bats test scripts and a custom test runner. The Makefile now runs separate cluster and application tests, with new scripts introduced for each, and the original monolithic script removed.

Changes

File(s) Change Summary
hack/e2e.sh Deleted the comprehensive end-to-end test automation shell script.
hack/e2e-cluster.bats, hack/e2e-apps.bats Added new Bats test scripts for cluster and application end-to-end testing.
hack/cozytest.sh Added a custom shell-based test runner for Bats scripts with enhanced output and tracing.
packages/core/testing/Makefile Refactored test targets: split into test-cluster and test-apps, updated apply env vars.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant Makefile
    participant CozyTest as hack/cozytest.sh
    participant BatsCluster as e2e-cluster.bats
    participant BatsApps as e2e-apps.bats

    Dev->>Makefile: make test
    Makefile->>CozyTest: Run test-cluster (e2e-cluster.bats)
    CozyTest->>BatsCluster: Execute all cluster E2E tests
    Makefile->>CozyTest: Run test-apps (e2e-apps.bats)
    CozyTest->>BatsApps: Execute all application E2E tests

Suggested labels

ok-to-test

Suggested reviewers

  • lllamnyp
  • klinch0

Poem

A rabbit hops through lines anew,
The old script’s gone, split into two.
With Bats and cozytest in tow,
The cluster and apps now each have their show.
Modular tests, clear and bright—
CozyStack’s future is looking right!
🐇✨

✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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[bot] avatar May 23 '25 18:05 coderabbitai[bot]