Skip to content

docs: document MinimalLambda.Testing package and enhance testing guide#235

Merged
j-d-ha merged 6 commits into
mainfrom
docs/update-for-testing-pkg
Dec 14, 2025
Merged

docs: document MinimalLambda.Testing package and enhance testing guide#235
j-d-ha merged 6 commits into
mainfrom
docs/update-for-testing-pkg

Conversation

@j-d-ha

@j-d-ha j-d-ha commented Dec 14, 2025

Copy link
Copy Markdown
Collaborator

🚀 Pull Request

📋 Summary

This PR comprehensively documents the MinimalLambda.Testing package and significantly enhances the testing guide with advanced examples and best practices.

Key Changes:

  • Documented MinimalLambda.Testing package usage with detailed examples
  • Added advanced testing scenarios including fixture reuse patterns and pitfalls
  • Enriched the testing guide with practical use cases for the testing package
  • Added MinimalLambda.Testing references to all package README files
  • Linked to MinimalLambda.Testing in the getting started documentation
  • Bumped version to 2.0.0-beta.6

✅ Checklist

  • My changes build cleanly
  • I've added/updated relevant tests
  • I've added/updated documentation or README
  • I've followed the coding style for this project
  • I've tested the changes locally (if applicable)

🧪 Related Issues or PRs

N/A - Documentation enhancement


💬 Notes for Reviewers

This is primarily a documentation update focused on the MinimalLambda.Testing package. The testing guide now includes:

  • Comprehensive examples of using the testing package
  • Advanced patterns for fixture reuse
  • Common pitfalls and how to avoid them
  • Integration with the existing MinimalLambda ecosystem

- Updated references in multiple README files to include MinimalLambda.Testing.
- Added badges for MinimalLambda.Testing with links to NuGet package and download stats.
- Expanded testing guide with in-depth MinimalLambda.Testing documentation.
- Added quick start, invocation API details, and host customization patterns.
- Updated `index.md` with reference to MinimalLambda.Testing for in-memory tests.
- Linked `README.md` to the testing guide for detailed examples.
…ection

- Updated `index.md` to include reference to MinimalLambda.Testing for integration testing.
- Added warning section to highlight issues with shared LambdaApplicationFactory.
- Provided best practices for avoiding overlapping factory instances and side effects.
- Emphasized using consistent patterns for test class/collection and proper cleanup.
…g use cases

- Added detailed examples for error handling, middleware, and concurrent invocation testing.
- Documented lifecycle hook testing patterns such as OnInit and OnShutdown scenarios.
- Introduced performance testing guidance, including cold start and timeout testing.
- Clarified usage of custom DI containers and JSON serialization options.
- Included reference to the full MinimalLambda.Testing suite for comprehensive examples.
- Updated the `<Version>` property in `Directory.Build.props` from 2.0.0-beta.5 to 2.0.0-beta.6.
@github-actions github-actions Bot added the type: docs Documentation change label Dec 14, 2025
@sonarqubecloud

Copy link
Copy Markdown

@codecov

codecov Bot commented Dec 14, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #235   +/-   ##
=======================================
  Coverage   87.91%   87.91%           
=======================================
  Files         122      122           
  Lines        2864     2864           
  Branches      334      334           
=======================================
  Hits         2518     2518           
  Misses        216      216           
  Partials      130      130           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b85397d...a56bba5. Read the comment docs.

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

@j-d-ha
j-d-ha merged commit eabbe73 into main Dec 14, 2025
10 checks passed
@j-d-ha
j-d-ha deleted the docs/update-for-testing-pkg branch December 14, 2025 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: docs Documentation change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant