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.

Sign up for GitHub

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

Jump to bottom

Resolve 4605: enhance SCONS_MSCOMMON_DEBUG handling of invalid input #4611

Merged
merged 7 commits into from
Oct 12, 2024
Merged

Resolve 4605: enhance SCONS_MSCOMMON_DEBUG handling of invalid input #4611

merged 7 commits into from
Oct 12, 2024
+26 −3

Conversation

jcbrill
Copy link
Contributor

@jcbrill jcbrill commented Oct 7, 2024

Enhancements:

  • Detect double quote character(s) in SCONS_MSCOMMON_DEBUG value and raise a UserError immediately.
  • Catch logging module OSError and FileNotFoundError and wrap in SCons UserError.

Resolves #4605

Contributor Checklist:

  • I have created a new test or updated the unit tests to cover the new/changed functionality.
  • I have updated CHANGES.txt and RELEASE.txt (and read the README.rst).
  • I have updated the appropriate documentation

@jcbrill
Validate the SCONS_MSCOMMON_DEBUG file name.
c6987ca 
Changes:
* Issue warning and remove leading and trailing double quotes from SCONS_MSCOMMON_DEBUG file name when present.
* Issue warning when SCONS_MSCOMMON_DEBUG file name is likely invalid.

Known issues:
* A false positive warning may be issued when a colon is detected in the file name.  An output file and hidden alternate data stream file may be created.
@jcbrill
Simplify log file handling.
f1117e1 
Changes:
* Remove leading and trailing double quotes from SCONS_MSDEBUG_VALUE and issue a warning.
* Catch logging module OSError and FileNotFoundError and wrap in SCons UserError.
@jcbrill
Remove unnecessary f-string specification in ms common logging error …
29fe1db 
…message.
@jcbrill
Detect double quotes in SCONS_MSCOMMON_DEBUG value and raise UserErro…
444f44c 
…r immediately.
@jcbrill
Merge branch 'master' into jbrill-mscommon-debug
a9a2f61
@jcbrill jcbrill changed the title Resolves 4605: enhance SCONS_MSCOMMON_DEBUG handling of invalid input Resolve 4605: enhance SCONS_MSCOMMON_DEBUG handling of invalid input Oct 7, 2024
@mwichmann
Copy link
Collaborator

Looks straightforward enough to me.

@mwichmann mwichmann added the MSVC Microsoft Visual C++ Support label Oct 8, 2024
@bdbaddog bdbaddog merged commit d567831 into SCons:master Oct 12, 2024
6 of 8 checks passed
@mwichmann mwichmann added this to the NextRelease milestone Oct 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
MSVC Microsoft Visual C++ Support
Projects
Next Release
Status: Complete
Milestone
NextRelease
Development

Successfully merging this pull request may close these issues.

Setting SCONS_MSCOMMON_DEBUG to a full path throws exception
3 participants
@jcbrill @mwichmann @bdbaddog