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

Untangle DFCI from configuration repo #105

Merged
merged 13 commits into from
Feb 8, 2023
Merged

Conversation

kuqin12
Copy link
Contributor

@kuqin12 kuqin12 commented Feb 3, 2023

Preface

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

Description

As we removes support for YAML and migrate over to XML based solutions, the DFCI based configuration path is no longer needed for such package. This package untangled DFCI dependency from configuration repository, rebranded certain library from DFCI for our own usage and updated corresponding unit tests.

Usage-wise, the only user facing change is that the USB SVD support will no longer cover targeted file search, but instead will be looking for SetupConfUpdate.svd for potential application.

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

  • 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

This change is unit tested and platform integration test is still in progress.

Integration Instructions

Platforms needs to remove non-existent libraries/headers and add SvdXmlSettingSchemaSupportLib|SetupDataPkg/Library/SvdXmlSettingSchemaSupportLib/SvdXmlSettingSchemaSupportLib.inf in the platform dsc file.

@github-actions github-actions bot added language:python Pull requests that update Python code impact:breaking-change Requires integration attention impact:testing Affects testing labels Feb 3, 2023
@codecov-commenter
Copy link

codecov-commenter commented Feb 3, 2023

Codecov Report

Attention: Patch coverage is 21.15385% with 41 lines in your changes missing coverage. Please review.

Project coverage is 29.71%. Comparing base (07eeb3c) to head (a880b62).
Report is 276 commits behind head on main.

Files with missing lines Patch % Lines
SetupDataPkg/Tools/CommonUtility.py 34.37% 21 Missing ⚠️
SetupDataPkg/Tools/ConfigEditor.py 0.00% 20 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##             main     #105       +/-   ##
===========================================
- Coverage   45.79%   29.71%   -16.08%     
===========================================
  Files          18       15        -3     
  Lines        6804     4196     -2608     
===========================================
- Hits         3116     1247     -1869     
+ Misses       3688     2949      -739     
Flag Coverage Δ
Linux 29.71% <21.15%> (-16.08%) ⬇️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

SetupDataPkg/ConfApp/DfciUsb/DfciUsb.c Outdated Show resolved Hide resolved
SetupDataPkg/ConfApp/SetupConf.c Outdated Show resolved Hide resolved
SetupDataPkg/ConfApp/SetupConf.c Outdated Show resolved Hide resolved
SetupDataPkg/ConfApp/SetupConf.c Outdated Show resolved Hide resolved
SetupDataPkg/SetupDataPkg.dsc Show resolved Hide resolved
SetupDataPkg/Tools/ConfigEditor.py Outdated Show resolved Hide resolved
SetupDataPkg/Tools/ConfigEditor.py Outdated Show resolved Hide resolved
SetupDataPkg/SetupDataPkg.dec Outdated Show resolved Hide resolved
SetupDataPkg/SetupDataPkg.dec Show resolved Hide resolved
@kuqin12 kuqin12 force-pushed the dfci_overhaul branch 3 times, most recently from 177e7bd to ce41f03 Compare February 6, 2023 22:06
@kuqin12 kuqin12 marked this pull request as ready for review February 6, 2023 22:27
@kuqin12 kuqin12 requested review from apop5 and os-d February 6, 2023 23:08
This change removes the module that is no longer needed with the new XML
design.

Signed-off-by: Kun Qin <kuqin@microsoft.com>
This change removes the module that is no longer needed with the new XML
design.

Signed-off-by: Kun Qin <kuqin@microsoft.com>
This change removes the module that is no longer needed with the new XML
design.

Signed-off-by: Kun Qin <kuqin@microsoft.com>
This change removes the module that is no longer needed with the new XML
design.

Signed-off-by: Kun Qin <kuqin@microsoft.com>
This change removes the module that is no longer needed with the new XML
design.

Signed-off-by: Kun Qin <kuqin@microsoft.com>
This change removes the module that is no longer needed with the new XML
design.

Signed-off-by: Kun Qin <kuqin@microsoft.com>
This change removes the unit test module that is no longer needed with
the new XML design.

Signed-off-by: Kun Qin <kuqin@microsoft.com>
This change rebranded XML schema from DFCI package to this repository to
support our own XML creation and parsing usage.

Signed-off-by: Kun Qin <kuqin@microsoft.com>
This change removes the DFCI related logic that is no longer needed with
the new XML design.

The unit tests are also updated accordingly to accomodate the changes.

Signed-off-by: Kun Qin <kuqin@microsoft.com>
This change removes the scripts that is no longer needed with the new XML
design.

Signed-off-by: Kun Qin <kuqin@microsoft.com>
@kuqin12 kuqin12 force-pushed the dfci_overhaul branch 2 times, most recently from a5f1525 to 2f46b3f Compare February 8, 2023 01:29
This change removes the YAML related logic from ConfigEditor that is no
longer needed with the new XML design.

Signed-off-by: Kun Qin <kuqin@microsoft.com>
This change moved git dependencies for Mu Plus and Mu Tiano to Common
folder, so that checked out files are ignored as before.

Signed-off-by: Kun Qin <kuqin@microsoft.com>
This change updated breaking change notes to indicate steps needed for
platform integration as well as change logistics.

Signed-off-by: Kun Qin <kuqin@microsoft.com>
@kuqin12 kuqin12 merged commit a5327d1 into microsoft:main Feb 8, 2023
@kuqin12 kuqin12 deleted the dfci_overhaul branch February 8, 2023 01:57
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 impact:testing Affects testing language:python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants