Skip to content

chore: Fix execution env verion and ConsoleWrapper for test mode #840

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

Merged
merged 2 commits into from
Apr 8, 2025

Conversation

hjgraca
Copy link
Contributor

@hjgraca hjgraca commented Apr 8, 2025

Please provide the issue number

Issue number: #839

Summary

Changes

This pull request includes several changes to improve testing and logging functionality in the AWS Lambda Powertools library. The most important changes include enhancements to the ConsoleWrapper class for better testability, updates to unit tests to reflect these changes, and modifications to ensure the correct version is set in the execution environment context.
Updates to execution environment version for tests

Enhancements to ConsoleWrapper:

  • Added _testOutputStream, _outputResetPerformed, and _inTestMode fields to support test mode and ensure console output is correctly overridden during tests.
  • Introduced the SetOut method to set a custom TextWriter for capturing output during tests.
  • Added ResetForTest and ClearOutputResetFlag methods to reset the ConsoleWrapper state after tests.

Unit test improvements:

  • Updated ConsoleWrapperTests to use a StringWriter for capturing console output and reset the ConsoleWrapper state before each test.
  • Modified tests to assert the correct version in the execution environment context for various components, including BatchProcessing, Idempotency, Logging, Metrics, and Tracing. [1] [2] [3] [4] [5] [6] [7]

Workflow configuration:

  • Updated .github/workflows/publish-artifacts-examples-tests.yml to continue on error when configuring the NuGet.org source.

User experience

Please share what the user experience looks like before and after this change

Checklist

Please leave checklist items unchecked if they do not apply to your change.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@boring-cyborg boring-cyborg bot added area/common Core Powertools utility github-actions Changes in GitHub workflows internal Maintenance changes tests labels Apr 8, 2025
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Apr 8, 2025
Copy link

codecov bot commented Apr 8, 2025

Codecov Report

Attention: Patch coverage is 97.50000% with 1 line in your changes missing coverage. Please review.

Project coverage is 75.86%. Comparing base (b06fa34) to head (f4c5ed4).
Report is 3 commits behind head on develop.

Files with missing lines Patch % Lines
...WS.Lambda.Powertools.Common/Core/ConsoleWrapper.cs 97.50% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #840      +/-   ##
===========================================
+ Coverage    75.71%   75.86%   +0.15%     
===========================================
  Files          233      233              
  Lines         9391     9422      +31     
  Branches      1027     1031       +4     
===========================================
+ Hits          7110     7148      +38     
+ Misses        1961     1954       -7     
  Partials       320      320              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link

sonarqubecloud bot commented Apr 8, 2025

@hjgraca hjgraca merged commit 126a283 into aws-powertools:develop Apr 8, 2025
10 checks passed
@hjgraca hjgraca deleted the fix/execution-env-version branch April 8, 2025 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/common Core Powertools utility github-actions Changes in GitHub workflows internal Maintenance changes size/L Denotes a PR that changes 100-499 lines, ignoring generated files. tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants