Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

allow skipping test runs #40

Merged
merged 1 commit into from
Nov 26, 2024
Merged

allow skipping test runs #40

merged 1 commit into from
Nov 26, 2024

Conversation

mcalhoun
Copy link
Member

what

  • allow skipping test runs with the -skip-tests flag

why

  • to give the developer more flexibility when iterating locally

@mcalhoun mcalhoun requested review from a team as code owners November 26, 2024 12:57
Copy link

coderabbitai bot commented Nov 26, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve modifications to the README.md, README.yaml, and several Go source files within the pkg/atmos/aws-component-helper package. The primary updates include the introduction of a SkipTests boolean field in the TestSuite struct, a new command-line flag --skip-tests, and conditional logic in the TestMain function to control test execution based on the SkipTests property. These alterations enhance the test management capabilities and improve the clarity and coverage of the associated test cases.

Changes

File Path Change Summary
README.md, README.yaml Added conditional statement in TestMain to check suite.SkipTests for test execution control.
pkg/atmos/aws-component-helper/cli.go Introduced --skip-tests flag in parseCLIArgs and updated ts.SkipTests accordingly.
pkg/atmos/aws-component-helper/cli_test.go Updated tests in TestParseCLIArgs, TestSkipDestroyDependencies, and TestSkipTeardownTestSuite; added TestSkipNukeTestAccount.
pkg/atmos/aws-component-helper/test_suite.go Added SkipTests boolean field to TestSuite struct.
test/aws-component-helper/test/basic_test.go Modified TestMain to conditionally run tests based on suite.SkipTests.

Poem

In the meadow where tests do play,
A new flag joins the fray today.
With SkipTests in the suite's embrace,
We hop along at a gentler pace.
So let the bunnies leap and cheer,
For flexible testing is finally here! 🐇✨


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

@mcalhoun mcalhoun added the no-release Do not create a new release (wait for additional code changes) label Nov 26, 2024
@mcalhoun mcalhoun merged commit c751907 into main Nov 26, 2024
3 of 5 checks passed
@mcalhoun mcalhoun deleted the allow/skipping-test-runs branch November 26, 2024 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-release Do not create a new release (wait for additional code changes)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant