blackbeard420/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf synced 2025-03-09 09:09:10 -04:00
Code Issues Projects Releases Wiki Activity

feat(tools): add option to execute steps only on a specific system

Browse Source 
At present, the steps are executed unconditionally. With this
modification, we can restrict each step individually to determine if it
should run on a particular system. For instance, we can execute
different commands on different systems. This is achieved by adding a
new key, "system," to the step dictionary, with possible values being
Linux, Windows, and Darwin.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
This commit is contained in:
Frantisek Hrbata 2025-01-27 13:12:50 +01:00
parent dfcc0b22c9
commit f7b754acfa
2 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
tools/idf_py_actions/diag/recipes/README.md
View File

@ -90,6 +90,11 @@ variable, format it as `${NAME}`, such as `${IDF_PATH}`.
Brief description of the `step`, displayed in the `idf.py diag` progress
beneath the `recipe` description.
* system: string (optional)
Can be used to restrict the operating system on which the step will be
executed. It should be Linux, Darwin, or Windows. If specified, the step
will only run on the designated system.
* output: string (optional)
Global output directory for the `step`. This directory serves as the main

17
tools/idf_py_actions/diag_ext.py
View File

@ -3,6 +3,7 @@
import atexit
import difflib
import os
import platform
import re
import shutil
import sys
@ -292,7 +293,7 @@ def validate_recipe(recipe: Dict) -> None:
dependencies and to provide more informative error messages.
"""
recipe_keys = ['description', 'tags', 'output', 'steps']
step_keys = ['name', 'cmds', 'output']
step_keys = ['name', 'cmds', 'output', 'system']
recipe_description = recipe.get('description')
recipe_tags = recipe.get('tags')
recipe_output = recipe.get('output')
@ -333,6 +334,7 @@ def validate_recipe(recipe: Dict) -> None:
step_name = step.get('name')
step_output = step.get('output')
step_cmds = step.get('cmds')
step_system = step.get('system')
if not step_name:
raise RuntimeError(f'Recipe step is missing "name" key')
@ -345,6 +347,12 @@ def validate_recipe(recipe: Dict) -> None:
if step_output:
if type(step_output) is not str:
raise RuntimeError(f'Step "output" key is not of type "str"')
if step_system:
if type(step_system) is not str:
raise RuntimeError(f'Step "system" key is not of type "str"')
if step_system not in ['Linux', 'Windows', 'Darwin']:
raise RuntimeError((f'Unknown "system" key value "{step_system}", '
f'expecting "Linux", "Windows" or "Darwin"'))
for cmd in step_cmds:
if 'exec' in cmd:
@ -731,6 +739,12 @@ def process_recipe(recipe: Dict) -> None:
"""execute commands for every stage in a recipe"""
for step in recipe['steps']:
step_name = step['name']
step_system = step.get('system')
if step_system and step_system != platform.system():
dbg(f'Skipping step "{step_name}" for "{step_system}"')
continue
dbg(f'Processing step "{step_name}"')
print(f'* {step_name}')
for cmd in step['cmds']:
@ -975,6 +989,7 @@ def create(action: str,
dbg(f'Recipe variables: {recipe_variables}')
dbg(f'Project directory: {project_dir}')
dbg(f'Build directory: {build_dir}')
dbg(f'System: {platform.system()}')
if list_recipes:
# List recipes command