Merge branch 'ci/wifi_remote_hook_cleanup' into 'master'

ci(esp_wifi): Update cleanup in script

See merge request espressif/esp-idf!48057
This commit is contained in:
Kapil Gupta
2026-04-30 16:37:12 +05:30

View File

@@ -15,15 +15,12 @@ from typing import cast
script_dir = os.path.dirname(os.path.abspath(__file__))
current_dir = os.path.abspath(os.getcwd())
if script_dir != current_dir:
print(f'Error: This script must be run from its own directory: {script_dir}')
print(f'Current working directory is: {current_dir}')
sys.exit(1)
idf_path = os.getenv('IDF_PATH')
if idf_path is None:
idf_path = os.path.realpath(os.path.join(script_dir, '..', '..', '..', '..'))
Param = namedtuple('Param', ['ptr', 'array', 'qual', 'type', 'name'])
component_path = os.path.normpath(os.path.join(os.path.realpath(__file__), '..', '..'))
@@ -114,10 +111,43 @@ def exec_cmd(what: list[str], out_file: IO[str] | None = None) -> tuple[int, str
return rc, output, err, ' '.join(what)
def _has_related_changes() -> bool:
try:
# Check if we are in a git repository
rc, _, _, _ = exec_cmd(['git', 'rev-parse', '--is-inside-work-tree'])
if rc != 0:
return True
# Get changes in tracked files (staged and unstaged) relative to HEAD
rc, output, _, _ = exec_cmd(['git', 'diff', 'HEAD', '--name-only'])
if rc != 0:
return True
except Exception:
return True
# Patterns from .pre-commit-config.yaml plus the script itself
related_files_re = re.compile(
r"""(?x)^(
components/esp_wifi/remote/scripts/(generate_and_check\.py|ignore_extensions\.h|copyright_header\.h)|
components/esp_wifi/include/(esp_wifi.*|esp_mesh.*|esp_now.*)\.h|
components/esp_wifi/Kconfig|
components/wpa_supplicant/esp_supplicant/include/esp_eap_client\.h|
components/soc/.+/include/soc/Kconfig\.soc_caps\.in
)$"""
)
for line in output.splitlines():
if related_files_re.match(line):
return True
return False
_cached_include_dir_flags: list[str] | None = None
def _handle_missing_tool(msg: str) -> None:
if not _has_related_changes():
sys.exit(0)
YELLOW = '\033[33m'
RESET = '\033[0m'
full_msg = (
@@ -132,12 +162,6 @@ def _handle_missing_tool(msg: str) -> None:
sys.exit(0)
try:
import pycparser # noqa: F401
except ImportError:
_handle_missing_tool('ESP-IDF environment not found (missing python dependencies)')
def preprocess(idf_path: str, header: str) -> str:
global _cached_include_dir_flags
project_dir = os.path.join(idf_path, 'examples', 'wifi', 'getting_started', 'station')
@@ -218,6 +242,8 @@ def preprocess(idf_path: str, header: str) -> str:
from pycparser import preprocess_file
preprocessed_code = preprocess_file(temp_file)
if os.path.exists(temp_file):
os.remove(temp_file)
return cast(str, preprocessed_code)
@@ -705,9 +731,26 @@ making changes you might need to modify 'copyright_header.h' in the script direc
parser.add_argument(
'-s', '--skip-check', help='Skip checking the versioned files against the re-generated', action='store_true'
)
parser.add_argument('-k', '--keep-test', help='Keep the generated test directory', action='store_true')
parser.add_argument('--base-dir', help='Base directory to compare generated files against')
args = parser.parse_args()
# Skip work if no related files have changed, unless we are in CI or doing a base-dir comparison.
# CI environments usually require a full check to ensure repository integrity even if
# no local uncommitted changes are present.
if args.base_dir is None and not os.getenv('CI') and not _has_related_changes():
sys.exit(0)
if script_dir != current_dir:
print(f'Error: This script must be run from its own directory: {script_dir}')
print(f'Current working directory is: {current_dir}')
sys.exit(1)
try:
import pycparser # noqa: F401
except ImportError:
_handle_missing_tool('ESP-IDF environment not found (missing python dependencies)')
header = os.path.join(idf_path, 'components', 'esp_wifi', 'include', 'esp_wifi.h')
eap_header = os.path.join(idf_path, 'components', 'wpa_supplicant', 'esp_supplicant', 'include', 'esp_eap_client.h')
function_prototypes = extract_function_prototypes(preprocess(idf_path, header), header, ['esp_wifi_'])
@@ -732,6 +775,15 @@ making changes you might need to modify 'copyright_header.h' in the script direc
if rc != 0:
modified_files.append(f)
# Cleanup test directory if not requested to keep it
if not args.keep_test:
test_dir = os.path.join(component_path, 'test')
if os.path.exists(test_dir):
try:
shutil.rmtree(test_dir)
except Exception as e:
print(f'Warning: Failed to clean up test directory {test_dir}: {e}')
if modified_files:
print('WiFi-remote API files were updated:')
for f in modified_files: