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

Add GUIDs to CSV output and support loading CSVs based on GUID + knob name #90

Merged
merged 10 commits into from
Jan 31, 2023

Conversation

os-d
Copy link
Contributor

@os-d os-d commented Jan 18, 2023

Preface

Please ensure you have read the contribution docs prior
to submitting the pull request. In particular,
pull request guidelines.

Description

Make CSV loading in ConfigEditor more robust by no longer relying on filenames to load the CSV but instead
loading via namespace GUID and knob name. This change added GUIDs to the CSV output and no longer accepts the older
style CSV output that does not include the GUID information.

For each item, place an "x" in between [ and ] if true. Example: [x].
(you can also check items in the GitHub UI)

  • Impacts functionality?
  • Impacts security?
  • Breaking change?
  • Includes tests?
  • Includes documentation?

How This Was Tested

Manually tested with multiple CSVs and XMLs loaded in ConfigEditor, including with additional knob namespaces.

Integration Instructions

To integrate this change, either manually add the GUID
information to existing CSV files or load the XML(s) with the new version of ConfigEditor, make the CSV changes in
the tool and regenerate the CSVs.

@github-actions github-actions bot added language:python Pull requests that update Python code impact:breaking-change Requires integration attention type:documentation Improvements or additions to documentation labels Jan 18, 2023
breaking_changes.md Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Jan 18, 2023

Codecov Report

Merging #90 (49f81fc) into main (1b66e93) will decrease coverage by 0.15%.
The diff coverage is 66.41%.

@@            Coverage Diff             @@
##             main      #90      +/-   ##
==========================================
- Coverage   49.57%   49.42%   -0.15%     
==========================================
  Files          17       17              
  Lines        6285     6306      +21     
==========================================
+ Hits         3116     3117       +1     
- Misses       3169     3189      +20     
Flag Coverage Δ
Linux 49.42% <66.41%> (-0.15%) ⬇️

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

Impacted Files Coverage Δ
SetupDataPkg/Tools/ConfigEditor.py 0.00% <0.00%> (ø)
SetupDataPkg/Tools/GenNCCfgData.py 64.82% <0.00%> (ø)
SetupDataPkg/Tools/VariableList.py 79.59% <18.18%> (-2.05%) ⬇️
SetupDataPkg/Tools/GenCfgData_test.py 95.73% <100.00%> (ø)
SetupDataPkg/Tools/GenNCCfgData_test.py 89.38% <100.00%> (ø)
SetupDataPkg/Tools/VariableList_test.py 99.47% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Member

@makubacki makubacki left a comment

Choose a reason for hiding this comment

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

I don't have a lot of context about how this change relates to the high-level design but I did look through the individual changes for what it's worth.

uefibot added a commit that referenced this pull request Jan 24, 2023
Closes #85

Adds a new selection to issues to request maintainer feedback.

The default is no maintainer feedback is necessary. Opting for
maintainer feedback adds the `state:needs-maintainer-feedback`
label to the issue.

Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>

Signed-off-by: Project Mu UEFI Bot <uefibot@microsoft.com>
SetupDataPkg/Tools/ConfigEditor.py Outdated Show resolved Hide resolved
@os-d os-d merged commit 1c2942f into microsoft:main Jan 31, 2023
@os-d os-d deleted the osde/csv_guid branch January 31, 2023 23:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact:breaking-change Requires integration attention language:python Pull requests that update Python code type:documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants