From 22bec4019f02a51bd2bd57e50cfb0f5beebb6aa3 Mon Sep 17 00:00:00 2001
From: Joey Vagedes <joey.vagedes@gmail.com>
Date: Fri, 13 Sep 2024 12:03:23 -0700
Subject: [PATCH] [202311] ImageValidation.py: Support gitignore style syntax
 for file exclusion (#1141)

## Description

Add gitignore style syntax for file exclusion

- [ ] Impacts functionality?
- [ ] Impacts security?
- [ ] Breaking change?
- [ ] Includes tests?
- [ ] Includes documentation?

## How This Was Tested

Ensured existing syntax (filename only) continues to work. Ensured
gitignore style syntax now works.

## Integration Instructions

N/A
---
 .pytool/Plugin/ImageValidation/ImageValidation.py | 9 ++++++---
 .pytool/Plugin/ImageValidation/ReadMe.md          | 3 ++-
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/.pytool/Plugin/ImageValidation/ImageValidation.py b/.pytool/Plugin/ImageValidation/ImageValidation.py
index 0a3de51048..2fcf87d1cd 100644
--- a/.pytool/Plugin/ImageValidation/ImageValidation.py
+++ b/.pytool/Plugin/ImageValidation/ImageValidation.py
@@ -17,6 +17,7 @@
 from edk2toollib.uefi.edk2.parsers.fdf_parser import FdfParser
 from edk2toollib.uefi.edk2.parsers.dsc_parser import DscParser
 from edk2toollib.uefi.edk2.parsers.inf_parser import InfParser
+from edk2toollib.gitignore_parser import parse_gitignore_lines
 import yaml
 from typing import List
 import logging
@@ -124,7 +125,9 @@ def do_post_build(self, thebuilder):
 
         self.test_manager.config_data = config_data
         self.config_data = config_data
-        self.ignore_list = config_data["IGNORE_LIST"]
+        self.ignore = parse_gitignore_lines(config_data.get("IGNORE_LIST", []), os.path.join(
+            thebuilder.ws, "nofile.txt"), thebuilder.ws)
+
         self.arch_dict = config_data["TARGET_ARCH"]
 
         count = 0
@@ -169,7 +172,7 @@ def do_post_build(self, thebuilder):
                             logging.warning(
                                 "Unable to parse the path to the pre-compiled efi")
                             continue
-                        if os.path.basename(efi_path) in self.ignore_list:
+                        if self.ignore(efi_path):
                             continue
                         logging.debug(
                             f'Performing Image Verification ... {os.path.basename(efi_path)}')
@@ -186,7 +189,7 @@ def do_post_build(self, thebuilder):
                 ['.efi'], f'{thebuilder.env.GetValue("BUILD_OUTPUT_BASE")}/{arch}')
 
             for efi_path in efi_path_list:
-                if os.path.basename(efi_path) in self.ignore_list:
+                if self.ignore(efi_path):
                     continue
 
                 # Perform Image Verification on any output efi's
diff --git a/.pytool/Plugin/ImageValidation/ReadMe.md b/.pytool/Plugin/ImageValidation/ReadMe.md
index ecd50dfd35..c24c5314e6 100644
--- a/.pytool/Plugin/ImageValidation/ReadMe.md
+++ b/.pytool/Plugin/ImageValidation/ReadMe.md
@@ -64,7 +64,8 @@ X64:
 If your platform deems a particular binary does not, and cannot meet the
 requirements set by the Image Validation plugin, or the platform's custom
 config, it can be ignored by adding a `IGNORE_LIST = [...]` section to the
-configuration file provided via PE_VALIDATION_PATH.
+configuration file provided via PE_VALIDATION_PATH. gitignore style syntax
+is supported for ignoring multiple files.
 
 ## Common Errors