Skip to content

Commit

Permalink
[CHERRY-PICK] .pytool/Plugin: UncrustifyCheck: use stat instead of os…
Browse files Browse the repository at this point in the history
….stat (#691)

## Description

The UncrustifyCheck plugin passes os.stat.S_IWRITE to os.chmod, when
attempting to change file permissions. os.stat.S_IWRITE does not exist
as os.stat is a function. The correct value is stat.S_IWRITE.


Cc: Liming Gao <[email protected]>
Cc: Michael D Kinney <[email protected]>
Cc: Sean Brogan <[email protected]>
Reviewed-by: Michael D Kinney <[email protected]>

- [ ] Impacts functionality?
- **Functionality** - Does the change ultimately impact how firmware
functions?
- Examples: Add a new library, publish a new PPI, update an algorithm,
...
- [ ] Impacts security?
- **Security** - Does the change have a direct security impact on an
application,
    flow, or firmware?
  - Examples: Crypto algorithm change, buffer overflow fix, parameter
    validation improvement, ...
- [ ] Breaking change?
- **Breaking change** - Will anyone consuming this change experience a
break
    in build or boot behavior?
- Examples: Add a new library class, move a module to a different repo,
call
    a function in a new library class in a pre-existing module, ...
- [ ] Includes tests?
  - **Tests** - Does the change include any explicit test code?
  - Examples: Unit tests, integration tests, robot tests, ...
- [ ] Includes documentation?
- **Documentation** - Does the change contain explicit documentation
additions
    outside direct code modifications (and comments)?
- Examples: Update readme file, add feature readme file, link to
documentation
    on an a separate Web page, ...

## How This Was Tested

Verified that when failing, the failure is no longer overshadowed by the
exception thrown for S_IWRITE not existing.

## Integration Instructions

N/A

Signed-off-by: Joey Vagedes <[email protected]>
  • Loading branch information
Javagedes authored Jan 24, 2024
1 parent ac447c4 commit ce5edfd
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import os
import pathlib
import shutil
import stat
import timeit
from edk2toolext.environment import version_aggregator
from edk2toolext.environment.plugin_manager import PluginManager
Expand Down Expand Up @@ -636,7 +637,7 @@ def _remove_readonly(func, path, _):
"""
Private function to attempt to change permissions on file/folder being deleted.
"""
os.chmod(path, os.stat.S_IWRITE)
os.chmod(path, stat.S_IWRITE)
func(path)

for _ in range(3): # retry up to 3 times
Expand Down

0 comments on commit ce5edfd

Please sign in to comment.