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

Fix intermittent formatting issue with VCR test reports #19301

Closed
melinath opened this issue Aug 28, 2024 · 9 comments · Fixed by GoogleCloudPlatform/magic-modules#11861, hashicorp/terraform-provider-google-beta#8316 or #19699

Comments

@melinath
Copy link
Collaborator

What kind of contribution is this issue about?

Pull request UX

Details

Something about the way we're doing color formatting has a glitch that causes it to not always display properly.

Screenshot 2024-08-28 at 10 21 08 AM

We should try to find a way to make this more consistent (which may require moving this output to a check, or removing the color formatting.)

References

GoogleCloudPlatform/magic-modules#11272 (comment)

@roaks3
Copy link
Collaborator

roaks3 commented Sep 9, 2024

$\textcolor{red}{\textsf{Tests failed during RECORDING mode:}}$
TestAccContainerCluster_withInsecureKubeletReadonlyPortEnabledInNodeConfigUpdates[Error message] [Debug log]

$\textcolor{red}{\textsf{Errors occurred during RECORDING mode. Please fix them to complete your PR.}}$

@roaks3
Copy link
Collaborator

roaks3 commented Sep 10, 2024

$\textcolor{green}{\textsf{Tests passed during RECORDING mode:}}$
TestAccNetappVolume_autoTieredNetappVolumeExample_update[Debug log]

$\textcolor{green}{\textsf{No issues found for passed tests after REPLAYING rerun.}}$


$\textcolor{red}{\textsf{Tests failed during RECORDING mode:}}$
TestAccNetappStoragePool_autoTieredStoragePoolCreateExample_update[Error message] [Debug log]

$\textcolor{red}{\textsf{Errors occurred during RECORDING mode. Please fix them to complete your PR.}}$

View the build log or the debug log for each test

@roaks3
Copy link
Collaborator

roaks3 commented Sep 10, 2024

The above comment is now rendering fine after pasting here, and on the original PR, but it initially rendered as:

Screenshot 2024-09-10 at 11 07 08 AM

@roaks3
Copy link
Collaborator

roaks3 commented Sep 11, 2024

Note: this seems to be due to some sort of MathML/Latex issue, where the same content in the comment can be rendered with different html sometimes. I can't find any recent issues being raised about this, but it's possible we want to move away from this solution for rendering color/font to get more consistent results.

@melinath
Copy link
Collaborator Author

melinath added a commit to melinath/magic-modules that referenced this issue Sep 26, 2024
This is a preparatory step for hashicorp/terraform-provider-google#19301 since it will allow us to easily change the method we use to colorize text everywhere at once
melinath added a commit to melinath/magic-modules that referenced this issue Sep 26, 2024
This is a preparatory step for hashicorp/terraform-provider-google#19301 since it will allow us to easily change the method we use to colorize text everywhere at once
@wyardley
Copy link

The above comment is now rendering fine after pasting here, and on the original PR, but it initially rendered as:

I noticed this as well, where it would render weird and then show up properly later on the same comment.

Thanks for working on some changes towards fixing this, @melinath!

@melinath
Copy link
Collaborator Author

melinath commented Sep 27, 2024

See github/markup#1440, https://github.com/orgs/community/discussions/31570, and github/markup#369 for discussion about the different options for "color" in markdown. After consideration, I'm opting for emoji-based emphasis because I don't think the benefit is worth the effort of implementing an image rendering website. Alert coloring would work for actual alerts, but these aren't actually alerts.

@wyardley
Copy link

I'm glad they're color emojis and not like "Tests failed during recording mode 👎👎"

Copy link

github-actions bot commented Nov 1, 2024

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.