mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
bc16331ba0
Current version of the test is using "git-submodule foreach", which requires submodules to be initialized. Non-initialized submodules are ignored. Our CI is not performing submodule initialization, but instead it only downloads the submodule content in tools/ci/ci_fetch_submodule.py from cache and copies it into the submodule path. Since we already know the submodule path from .gitconfig, we can use it as argument to git-ls-tree and avoid calling git-submodule at all. This allows to perform the test even if the submodules are not initialization and also it makes the code simpler. Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
75 lines
2.6 KiB
Python
75 lines
2.6 KiB
Python
# SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
import os
|
|
from subprocess import run
|
|
from typing import Dict, List
|
|
|
|
|
|
def run_cmd(cmd: List[str]) -> str:
|
|
"""Simple helper to run command and return it's stdout."""
|
|
proc = run(cmd, capture_output=True, check=True, text=True)
|
|
return proc.stdout.strip()
|
|
|
|
|
|
def get_gitwdir() -> str:
|
|
"""Return absolute path to the current git working tree."""
|
|
return run_cmd(['git', 'rev-parse', '--show-toplevel'])
|
|
|
|
|
|
def get_submodules_config() -> Dict[str,Dict[str,str]]:
|
|
"""Return dictionary, where key is submodule name and value
|
|
is a dictionary with variable:value pairs."""
|
|
gitmodules_fn = os.path.join(get_gitwdir(), '.gitmodules')
|
|
gitmodules_data = run_cmd(['git', 'config', '--list', '--file', gitmodules_fn])
|
|
prefix = 'submodule.'
|
|
config: Dict[str, Dict[str,str]] = {}
|
|
for line in gitmodules_data.splitlines():
|
|
if not line.startswith(prefix):
|
|
continue
|
|
splitted = line.split('=', maxsplit=1)
|
|
if len(splitted) != 2:
|
|
continue
|
|
section, val = splitted
|
|
# remove "submodule." prefix
|
|
section = section[len(prefix):]
|
|
# split section into module name and variable
|
|
splitted = section.rsplit('.', maxsplit=1)
|
|
if len(splitted) != 2:
|
|
continue
|
|
module_name, var = splitted
|
|
if module_name not in config:
|
|
config[module_name] = {}
|
|
config[module_name][var] = val
|
|
|
|
return config
|
|
|
|
|
|
def test_sha() -> None:
|
|
""" Check that submodule SHA in git-tree and .gitmodules match
|
|
if sbom-hash variable is available in the .gitmodules file.
|
|
"""
|
|
submodules = get_submodules_config()
|
|
|
|
for name, variables in submodules.items():
|
|
sbom_hash = variables.get('sbom-hash')
|
|
if not sbom_hash:
|
|
continue
|
|
module_path = variables.get('path')
|
|
if not module_path:
|
|
continue
|
|
output = run_cmd(['git', 'ls-tree', 'HEAD', module_path])
|
|
if not output:
|
|
continue
|
|
module_hash = output.split()[2]
|
|
msg = (f'Submodule \"{name}\" SHA \"{module_hash}\" in git '
|
|
f'tree does not match SHA \"{sbom_hash}\" recorded in .gitmodules. '
|
|
f'Please update \"sbom-hash\" in .gitmodules for \"{name}\" '
|
|
f'and also please do not forget to update version and other submodule '
|
|
f'information if necessary. It is important to keep this information '
|
|
f'up-to-date for SBOM generation.')
|
|
assert module_hash == sbom_hash, msg
|
|
|
|
|
|
if __name__ == '__main__':
|
|
test_sha()
|