allow multiple test suites

[mcalhoun]

what

• Allow multiple test suites

why

• To allow users to run multiple test suites at the same time

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes primarily involve updates to the documentation files README.md and README.yaml for the test-helpers library, enhancing clarity and usability. The cli.go, setup_test_suite.go, and test_suite.go files have been modified to introduce new command-line flags and improve the handling of test suites. Specifically, new fields have been added to the TestSuite structure, and a new TestSuites structure has been created to manage multiple test suites effectively. Overall, the modifications focus on improving documentation and functionality without altering existing logic.

Changes

File Path	Change Summary
README.md	Restructured and formatted; clarified introduction, installation instructions, usage, and packages sections; added examples and a table for test phases; updated contributing section.
README.yaml	Updated with a new introduction, expanded usage examples, and a new "Test Phases" section; included a contributors section.
pkg/atmos/aws-component-helper/cli.go	Added new command-line flags: force-new-suite (boolean) and suite-index (integer); updated TestSuite struct to include these fields.
pkg/atmos/aws-component-helper/setup_test_suite.go	Modified readOrCreateTestSuiteFile to manage multiple test suites; improved error handling for suite indexing; initialized TestSuites structure.
pkg/atmos/aws-component-helper/test_suite.go	Updated TestSuite struct to include ForceNewSuite (bool) and Index (int); added new TestSuites struct to manage multiple test suites.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant TestSuiteManager
    participant JSONFile

    User->>CLI: Run command with flags
    CLI->>TestSuiteManager: Parse CLI arguments
    TestSuiteManager->>JSONFile: Read existing test suites
    JSONFile-->>TestSuiteManager: Return data
    TestSuiteManager->>TestSuiteManager: Validate suite index
    alt Valid index
        TestSuiteManager->>User: Return existing test suite
    else Invalid index
        TestSuiteManager->>User: Create new test suite
        TestSuiteManager->>JSONFile: Write updated suites
    end

Loading

🐇 In the garden, we hop and play,
🐰 With flags and suites, we find our way.
📜 Documentation shines so bright,
🌟 Clarity blooms, a joyful sight!
🥕 Join us now, in code we trust,
🌼 Together we build, it's a must!

---

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