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

chore: re-enable console output in tests #32883

Merged
merged 4 commits into from
Jan 13, 2025
Merged

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Jan 13, 2025

Remove silent: true from the test config. console.log() is a time-honored debugging tradition, and the silent: true config makes that not work in a non-obvious way.

A nice behavior that many other testing frameworks have is to only print the console output of tests that fail. Use the "Jest Environments" feature to build an environment that replaces console.log() etc and buffers their output to only print it for failing tests.

This achieves the same goals of not polluting the terminal too much while running tests, while still allowing the ability to see the output of console.log.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

Remove `silent: true` from the test config. `console.log()` is a
time-honored debugging tradition, and the `silent: true` config makes
that not work in a non-obvious way.

A nice behavior that many other testing frameworks have is to only
print the console output of tests that fail. Use the "Jest Environments"
feature to build an environment that replaces `console.log()` etc and
buffers their output to only print it for failing tests.
@aws-cdk-automation aws-cdk-automation requested a review from a team January 13, 2025 10:21
@github-actions github-actions bot added the p2 label Jan 13, 2025
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Jan 13, 2025
@rix0rrr rix0rrr changed the title chore: disable silent tests chore: re-enable console output in tests Jan 13, 2025
Copy link

codecov bot commented Jan 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.38%. Comparing base (e7e908b) to head (2849820).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #32883   +/-   ##
=======================================
  Coverage   81.38%   81.38%           
=======================================
  Files         222      222           
  Lines       13698    13698           
  Branches     2413     2413           
=======================================
  Hits        11148    11148           
  Misses       2271     2271           
  Partials      279      279           
Flag Coverage Δ
suite.unit 81.38% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
packages/aws-cdk 80.69% <ø> (ø)
packages/aws-cdk-lib/core 82.10% <ø> (ø)

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 13, 2025
}

async teardown() {
this.global.console = this.originalConsole;
Copy link
Contributor

Choose a reason for hiding this comment

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

Doesn't this collide when running tests in parallel? or do they not run in the same process?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Inside one process tests run sequentially, except when using test.concurrent(). But we only use that in the CLI integ tests, and we're only using this environment in aws-cdk-lib.

Copy link
Contributor

mergify bot commented Jan 13, 2025

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 13, 2025
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 2849820
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify mergify bot merged commit a5bd76e into main Jan 13, 2025
22 checks passed
Copy link
Contributor

mergify bot commented Jan 13, 2025

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot deleted the huijbers/no-silent-tests branch January 13, 2025 15:15
Copy link

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 13, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
contribution/core This is a PR that came from AWS. p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants