Skip to content

docs: document smoke tests, integration tests, and add smoke-test command#811

Merged
TomerFi merged 2 commits intomainfrom
docs/update-contributing-and-commands
Feb 14, 2026
Merged

docs: document smoke tests, integration tests, and add smoke-test command#811
TomerFi merged 2 commits intomainfrom
docs/update-contributing-and-commands

Conversation

@TomerFi
Copy link
Owner

@TomerFi TomerFi commented Feb 14, 2026

Summary

  • Add "Smoke testing" section to CONTRIBUTING.md with usage instructions for scripts/smoke-test.js
  • Add "Integration Tests" section describing tests/app-runner.test.js
  • Add smoke-test Cursor command (.cursor/commands/smoke-test.mdc)
  • List the new command in the Cursor Commands section of CONTRIBUTING.md

Test plan

  • No code changes, documentation only

Summary by CodeRabbit

  • Documentation
    • Added smoke testing documentation describing how to run tests against live Lambda functions, including environment variable configuration, usage examples for different event types, and retry logic for cold starts.
    • Added integration testing documentation explaining test instantiation, payload signing, and handler verification with fixture-based testing.

…mand

- Add smoke testing and integration tests sections to CONTRIBUTING.md
- Add smoke-test Cursor command for running tests against the live function
- List smoke-test in the Cursor commands section

Signed-off-by: Tomer Figenblat <tomer@figenblat.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@auto-me-bot auto-me-bot bot added the status: needs review Pull request needs a review label Feb 14, 2026
@coderabbitai
Copy link

coderabbitai bot commented Feb 14, 2026

Warning

Rate limit exceeded

@TomerFi has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 17 minutes and 26 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 for further information.

📝 Walkthrough

Walkthrough

A new Cursor IDE command configuration file is added for smoke testing, and the contributing guide is updated with documentation on smoke testing workflows, integration tests, required environment variables, and test fixture locations.

Changes

Cohort / File(s) Summary
Smoke Test Configuration
.cursor/commands/smoke-test.mdc
Adds Cursor IDE command configuration for running smoke tests against a live Lambda function; includes environment variable references and test execution command.
Documentation Updates
CONTRIBUTING.md
Expands contributing guide with new sections on smoke testing (including retry logic and GitHub Actions automation), integration tests, and references to test fixtures and Cursor commands.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

status: review started

Poem

🐰 A smoke test hops along with care,
Configuration files floating in the air,
Documentation blooms, so crisp and clean,
The finest workflows ever seen!

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and specifically summarizes the main changes: documenting smoke tests, integration tests, and adding a smoke-test command.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/update-contributing-and-commands

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link

codecov bot commented Feb 14, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.20%. Comparing base (2cee3df) to head (80ceb0e).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #811   +/-   ##
=======================================
  Coverage   99.20%   99.20%           
=======================================
  Files           8        8           
  Lines        1006     1006           
=======================================
  Hits          998      998           
  Misses          8        8           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Line 128: The long single line in CONTRIBUTING.md describing the Lambda
handler tests exceeds the 120-character limit; break that sentence into multiple
lines (wrap at sensible word boundaries) so each line is <=120 characters while
preserving the same text and links (retain references to
tests/app-runner.test.js, tests/fixtures/, and HMAC-SHA256/Probot/RSA key
wording), ensuring Markdown formatting remains unchanged.
- Around line 37-46: The CONTRIBUTING.md section describing the smoke test has
several lines exceeding the 120-character limit; wrap those long lines so no
line is longer than 120 chars (break at natural boundaries such as after
sentence ends, between list items, or within parentheses) while preserving
content and links for "node scripts/smoke-test.js ping", "node
scripts/smoke-test.js all", the ".github/workflows/smoke-test.yml" mention, and
the "tests/fixtures/" path; update the bullet list and paragraphs to use shorter
lines (or soft wraps) and ensure Markdown formatting and links remain intact.

@auto-me-bot auto-me-bot bot added status: review started Pull review in progress and removed status: needs review Pull request needs a review labels Feb 14, 2026
Signed-off-by: Tomer Figenblat <tomer@figenblat.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@TomerFi TomerFi merged commit 529d493 into main Feb 14, 2026
9 checks passed
@TomerFi TomerFi deleted the docs/update-contributing-and-commands branch February 14, 2026 19:43
@auto-me-bot auto-me-bot bot added status: merged Pull request merged and removed status: review started Pull review in progress labels Feb 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: merged Pull request merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant