idf-build-apps 2.5.0rc2__tar.gz → 2.5.2__tar.gz

{idf_build_apps-2.5.0rc2 → idf_build_apps-2.5.2}/.github/workflows/test-build-idf-apps.yml

@@ -76,7 +76,12 @@ jobs:
           python -m idf_build_apps build -vv -t esp32 \
             -p $IDF_PATH/examples/get-started/hello_world \
             --size-file size_info.json
-          pytest --cov idf_build_apps --cov-report term-missing --junit-xml report.xml
+          pytest --cov idf_build_apps --cov-report term-missing:skip-covered --junit-xml pytest.xml | tee pytest-coverage.txt
+      - name: Pytest coverage comment
+        uses: MishaKav/pytest-coverage-comment@main
+        with:
+          pytest-coverage-path: pytest-coverage.txt
+          junitxml-path: pytest.xml
 
   build-apps-on-idf-8266:
     runs-on: ubuntu-latest

{idf_build_apps-2.5.0rc2 → idf_build_apps-2.5.2}/CHANGELOG.md

@@ -2,43 +2,42 @@
 
 All notable changes to this project will be documented in this file.
 
-## v2.5.0rc2 (2024-09-23)
+## v2.5.2 (2024-09-27)
 
 ### Fix
 
-- chdir to tmp_path at the beginning of each test case
-- load config before cli args and func args
-- pickle dump default protocal different in python 3.7
-- keep backward compatibility in build_apps function
+- unset CLI argument wrongly overwrite config file settings with default value
+- allow unknown fields
 
-## v2.5.0rc1 (2024-09-17)
+## v2.5.1 (2024-09-26)
 
 ### Fix
 
-- build_arguments expand @p placeholders
+- stop using lambda functions since they cannot be pickled
 
-### Refactor
-
-- rename BuildArguments.ignore_warning_strings to ignore_warning_strs
-
-## v2.5.0rc0 (2024-09-10)
+## v2.5.0 (2024-09-26)
 
 ### Feat
 
-- support `idf-build-apps find` with checking modified manfiest files
+- raise exception when chaining `or`/`and` in manifest file if statements
+- support `idf-build-apps find` with checking modified manifest files
 - support `idf-build-apps dump-manifest-sha`
 
 ### Fix
 
-- loose env var requirements. IDF_PATH not required
-- stop print build log as error when build with warning-as-error
+- stop calling `sys.exit` when return code is 0
+- load config file before cli arguments and func arguments
+- pickle dump default protocol different in python 3.7
+- loose env var requirements. `IDF_PATH` not required
+- stop print build log as error when build failed due to `--warning-as-error`
 - requires typing-extensions below 3.11
-- temp build log got wrongly created/deleted
+- stop wrongly created/deleted temporary build log file
 
 ### Refactor
 
 - declare argument once. used in both function, cli, and docs
-- move Manifest.ROOTPATH to params
+- move Manifest.ROOTPATH to arguments
+- expand @p placeholders in `BuildArguments`
 
 ## v2.4.3 (2024-08-07)
 

{idf_build_apps-2.5.0rc2 → idf_build_apps-2.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: idf-build-apps
-Version: 2.5.0rc2
+Version: 2.5.2
 Summary: Tools for building ESP-IDF related apps.
 Author-email: Fu Hanxi <fuhanxi@espressif.com>
 Requires-Python: >=3.7

{idf_build_apps-2.5.0rc2 → idf_build_apps-2.5.2}/idf_build_apps/__init__.py

@@ -8,7 +8,7 @@ Tools for building ESP-IDF related apps.
 # ruff: noqa: E402
 # avoid circular imports
 
-__version__ = '2.5.0rc2'
+__version__ = '2.5.2'
 
 from .session_args import (
     SessionArgs,

{idf_build_apps-2.5.0rc2 → idf_build_apps-2.5.2}/idf_build_apps/args.py

@@ -11,6 +11,7 @@ import sys
 import typing as t
 from copy import deepcopy
 from dataclasses import dataclass
+from io import TextIOWrapper
 from pathlib import Path
 from typing import Any
 
@@ -51,6 +52,8 @@ class FieldMetadata:
     :param choices: choices for the argument, used in argparse
     :param type: type for the argument, used in argparse
     :param required: whether the argument is required, used in argparse
+    :param default: default value for the argument, used in argparse
+    :param hidden: whether the argument is hidden, used in argparse
     """
 
     # validate method
@@ -66,6 +69,8 @@ class FieldMetadata:
     required: bool = False
     # usually default is not needed. only set it when different from the default value of the field
     default: t.Any = None
+    # hidden field, use deprecated instead, or hide it in the argparse
+    hidden: bool = False
 
 
 P = ParamSpec('P')
@@ -112,6 +117,7 @@ class BaseArguments(BaseSettings):
         toml_file='.idf_build_apps.toml',
         pyproject_toml_table_header=('tool', 'idf-build-apps'),
         pyproject_toml_depth=sys.maxsize,
+        extra='ignore',
     )
 
     @classmethod
@@ -135,8 +141,9 @@ class BaseArguments(BaseSettings):
         if info.field_name and info.field_name in cls.model_fields:
             f = cls.model_fields[info.field_name]
             meta = get_meta(f)
-            if meta and meta.validate_method and ValidateMethod.TO_LIST in meta.validate_method:
-                return to_list(v)
+            if meta and meta.validate_method:
+                if ValidateMethod.TO_LIST in meta.validate_method:
+                    return to_list(v)
 
         return v
 
@@ -195,7 +202,9 @@ class DependencyDrivenBuildArguments(GlobalArguments):
             validate_method=[ValidateMethod.TO_LIST],
             type=semicolon_separated_str_to_list,
         ),
-        description='semicolon-separated list of modified components',
+        description='semicolon-separated list of modified components. '
+        'If set to "", the value would be considered as None. '
+        'If set to ";", the value would be considered as an empty list.',
         default=None,
     )
     modified_files: t.Optional[t.List[str]] = field(
@@ -203,7 +212,9 @@ class DependencyDrivenBuildArguments(GlobalArguments):
             validate_method=[ValidateMethod.TO_LIST],
             type=semicolon_separated_str_to_list,
         ),
-        description='semicolon-separated list of modified files',
+        description='semicolon-separated list of modified files. '
+        'If set to "", the value would be considered as None. '
+        'If set to ";", the value would be considered as an empty list.',
         default=None,
     )
     deactivate_dependency_driven_build_by_components: t.Optional[t.List[str]] = field(
@@ -219,7 +230,10 @@ class DependencyDrivenBuildArguments(GlobalArguments):
             shorthand='-dc',
         ),
         description='semicolon-separated list of components. '
-        'dependency-driven build feature will be deactivated when any of these components are modified',
+        'dependency-driven build feature will be deactivated when any of these components are modified. '
+        'Must be specified together with --modified-components. '
+        'If set to "", the value would be considered as None. '
+        'If set to ";", the value would be considered as an empty list.',
         validation_alias=AliasChoices(
             'deactivate_dependency_driven_build_by_components', 'ignore_app_dependencies_components'
         ),
@@ -238,7 +252,10 @@ class DependencyDrivenBuildArguments(GlobalArguments):
             shorthand='-df',
         ),
         description='semicolon-separated list of file patterns. '
-        'dependency-driven build feature will be deactivated when any of matched files are modified',
+        'dependency-driven build feature will be deactivated when any of matched files are modified. '
+        'Must be specified together with --modified-files. '
+        'If set to "", the value would be considered as None. '
+        'If set to ";", the value would be considered as an empty list.',
         validation_alias=AliasChoices(
             'deactivate_dependency_driven_build_by_filepatterns', 'ignore_app_dependencies_filepatterns'
         ),
@@ -253,7 +270,7 @@ class DependencyDrivenBuildArguments(GlobalArguments):
     )
     compare_manifest_sha_filepath: t.Optional[str] = field(
         None,
-        description='Path to the file containing the sha256 hash of the manifest rules. '
+        description='Path to the file containing the hash of the manifest rules. '
         'Compare the hash with the current manifest rules. '
         'All matched apps will be built if the corresponding manifest rule is modified',
         default=None,
@@ -443,7 +460,10 @@ class FindBuildArguments(DependencyDrivenBuildArguments):
         default=False,
     )
     default_build_targets: t.Optional[t.List[str]] = field(
-        None,
+        FieldMetadata(
+            validate_method=[ValidateMethod.TO_LIST],
+            nargs='+',
+        ),
         description='space-separated list of the default enabled build targets for the apps. '
         'When not specified, the default value is the targets listed by `idf.py --list-targets`',
         default=None,
@@ -602,10 +622,16 @@ class BuildArguments(FindBuildArguments):
         validation_alias=AliasChoices('ignore_warning_strs', 'ignore_warning_str'),
         default=None,
     )
-    ignore_warning_files: t.Optional[t.List[str]] = field(
+    ignore_warning_files: t.Optional[t.List[t.Union[str, TextIOWrapper]]] = field(
         FieldMetadata(
-            deprecates={'ignore_warning_file': {}},
+            validate_method=[ValidateMethod.TO_LIST],
+            deprecates={
+                'ignore_warning_file': {
+                    'type': argparse.FileType('r'),
+                }
+            },
             nargs='+',
+            type=argparse.FileType('r'),
         ),
         description='Path to the files containing the patterns to ignore the warnings in the build output',
         validation_alias=AliasChoices('ignore_warning_files', 'ignore_warning_file'),
@@ -621,7 +647,10 @@ class BuildArguments(FindBuildArguments):
 
     # Attrs that support placeholders
     collect_size_info_filename: t.Optional[str] = field(
-        None,
+        FieldMetadata(
+            deprecates={'collect_size_info': {}},
+            hidden=True,
+        ),
         description='Record size json filepath of the built apps to the specified file. '
         'Each line is a json string. Can expand placeholders @p',
         validation_alias=AliasChoices('collect_size_info_filename', 'collect_size_info'),
@@ -629,7 +658,10 @@ class BuildArguments(FindBuildArguments):
         exclude=True,  # computed field is used
     )
     collect_app_info_filename: t.Optional[str] = field(
-        None,
+        FieldMetadata(
+            deprecates={'collect_app_info': {}},
+            hidden=True,
+        ),
         description='Record serialized app model of the built apps to the specified file. '
         'Each line is a json string. Can expand placeholders @p',
         validation_alias=AliasChoices('collect_app_info_filename', 'collect_app_info'),
@@ -637,7 +669,10 @@ class BuildArguments(FindBuildArguments):
         exclude=True,  # computed field is used
     )
     junitxml_filename: t.Optional[str] = field(
-        None,
+        FieldMetadata(
+            deprecates={'junitxml': {}},
+            hidden=True,
+        ),
         description='Path to the junitxml file to record the build results. Can expand placeholder @p',
         validation_alias=AliasChoices('junitxml_filename', 'junitxml'),
         default=None,
@@ -654,8 +689,14 @@ class BuildArguments(FindBuildArguments):
             for s in self.ignore_warning_strs:
                 ignore_warnings_regexes.append(re.compile(s))
         if self.ignore_warning_files:
-            for s in self.ignore_warning_files:
-                ignore_warnings_regexes.append(re.compile(s.strip()))
+            for f in self.ignore_warning_files:
+                if isinstance(f, str):
+                    with open(f) as fr:
+                        for s in fr:
+                            ignore_warnings_regexes.append(re.compile(s.strip()))
+                else:
+                    for s in f:
+                        ignore_warnings_regexes.append(re.compile(s.strip()))
         App.IGNORE_WARNS_REGEXES = ignore_warnings_regexes
 
     @computed_field  # type: ignore
@@ -734,12 +775,20 @@ def add_args_to_parser(argument_cls: t.Type[BaseArguments], parser: argparse.Arg
                 if _shorthand:
                     _names.append(_shorthand)
 
+                if f_meta.hidden:  # f is hidden, use deprecated field instead
+                    help_msg = f.description
+                else:
+                    help_msg = f'[Deprecated] Use {_snake_case_to_cli_arg_name(f_name)} instead'
+
                 parser.add_argument(
                     *_names,
                     **dep_f_kwargs,
-                    help=f'[Deprecated] Use {_snake_case_to_cli_arg_name(f_name)} instead',
+                    help=help_msg,
                 )
 
+        if f_meta and f_meta.hidden:
+            continue
+
         names = [_snake_case_to_cli_arg_name(f_name)]
         if f_meta and f_meta.shorthand:
             names.append(f_meta.shorthand)
@@ -752,14 +801,19 @@ def add_args_to_parser(argument_cls: t.Type[BaseArguments], parser: argparse.Arg
                 kwargs['required'] = True
             if f_meta.action:
                 kwargs['action'] = f_meta.action
+                # to make the CLI override config file work
+                if f_meta.action == 'store_true':
+                    kwargs['default'] = None
+
             if f_meta.nargs:
                 kwargs['nargs'] = f_meta.nargs
             if f_meta.choices:
                 kwargs['choices'] = f_meta.choices
             if f_meta.default:
                 kwargs['default'] = f_meta.default
-        if 'default' not in kwargs:
-            kwargs['default'] = f.default
+
+        # here in CLI arguments, don't set the default to field.default
+        # otherwise it will override the config file settings
 
         parser.add_argument(
             *names,

{idf_build_apps-2.5.0rc2 → idf_build_apps-2.5.2}/idf_build_apps/finder.py

@@ -33,6 +33,7 @@ def _get_apps_from_path(
     app_cls: t.Type[App] = CMakeApp,
     args: FindArguments,
 ) -> t.List[App]:
+    # trigger test
     def _validate_app(_app: App) -> bool:
         if target not in _app.supported_targets:
             LOGGER.debug('=> Ignored. %s only supports targets: %s', _app, ', '.join(_app.supported_targets))

{idf_build_apps-2.5.0rc2 → idf_build_apps-2.5.2}/idf_build_apps/main.py

@@ -70,6 +70,15 @@ def find_apps(
     """
     apply_config_file(config_file)
 
+    # compatible with old usage
+    ## `preserve`
+    if 'preserve' in kwargs:
+        LOGGER.warning(
+            'Passing "preserve" directly is deprecated. '
+            'Pass "no_preserve" instead to disable preserving the build directory'
+        )
+        kwargs['no_preserve'] = not kwargs.pop('preserve')
+
     if find_arguments is None:
         find_arguments = FindArguments(
             paths=to_list(paths),  # type: ignore
@@ -125,7 +134,8 @@ def build_apps(
     """
     apply_config_file(config_file)
 
-    apps = to_list(apps)
+    # compatible with old usage
+    ## `check_app_dependencies`
     if 'check_app_dependencies' in kwargs:
         LOGGER.warning(
             'Passing "check_app_dependencies" directly is deprecated. '
@@ -138,6 +148,7 @@ def build_apps(
             **kwargs,
         )
 
+    apps = to_list(apps)
     if apps is None:
         apps = find_apps(
             find_arguments=FindArguments(
@@ -431,7 +442,8 @@ def main():
         for app in failed_apps:
             print(f'  {app}')
 
-    sys.exit(ret_code)
+    if ret_code != 0:
+        sys.exit(ret_code)
 
 
 def json_to_app(json_str: str, extra_classes: t.Optional[t.List[t.Type[App]]] = None) -> App:

{idf_build_apps-2.5.0rc2 → idf_build_apps-2.5.2}/idf_build_apps/manifest/if_parser.py

@@ -1,6 +1,5 @@
 # SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
-
 import operator
 import os
 from ast import (
@@ -16,6 +15,7 @@ from packaging.version import (
 from pyparsing import (
     Keyword,
     Literal,
+    MatchFirst,
     ParseResults,
     QuotedString,
     Suppress,
@@ -35,6 +35,7 @@ from ..constants import (
     IDF_VERSION_PATCH,
 )
 from ..utils import (
+    InvalidIfClause,
     InvalidInput,
     to_version,
 )
@@ -177,22 +178,31 @@ class BoolExpr(Stmt):
     pass
 
 
-class BoolAnd(BoolExpr):
-    def __init__(self, t: ParseResults):
-        self.left: BoolStmt = t[0][0]
-        self.right: BoolStmt = t[0][2]
+def _and(_l, _r):
+    return _l and _r
 
-    def get_value(self, target: str, config_name: str) -> Any:
-        return self.left.get_value(target, config_name) and self.right.get_value(target, config_name)
+
+def _or(_l, _r):
+    return _l or _r
 
 
-class BoolOr(BoolExpr):
+class BoolOrAnd(BoolExpr):
     def __init__(self, t: ParseResults):
+        if len(t[0]) > 3:
+            raise InvalidIfClause(
+                'Chaining "and"/"or" is not allowed. Please use paratheses instead. '
+                'For example: "a and b and c" should be "(a and b) and c".'
+            )
         self.left: BoolStmt = t[0][0]
         self.right: BoolStmt = t[0][2]
 
+        if t[0][1] == 'and':
+            self.operation = _and
+        if t[0][1] == 'or':
+            self.operation = _or
+
     def get_value(self, target: str, config_name: str) -> Any:
-        return self.left.get_value(target, config_name) or self.right.get_value(target, config_name)
+        return self.operation(self.left.get_value(target, config_name), self.right.get_value(target, config_name))
 
 
 CAP_WORD = Word(alphas.upper(), nums + alphas.upper() + '_').setParseAction(ChipAttr)
@@ -225,7 +235,6 @@ OR = Keyword('or')
 BOOL_EXPR = infixNotation(
     BOOL_STMT,
     [
-        (AND, 2, opAssoc.LEFT, BoolAnd),
-        (OR, 2, opAssoc.LEFT, BoolOr),
+        (MatchFirst((AND, OR)), 2, opAssoc.LEFT, BoolOrAnd),
     ],
 )

{idf_build_apps-2.5.0rc2 → idf_build_apps-2.5.2}/idf_build_apps/manifest/manifest.py

@@ -35,14 +35,21 @@ class IfClause:
     def __init__(self, stmt: str, temporary: bool = False, reason: t.Optional[str] = None) -> None:
         try:
             self.stmt: BoolStmt = BOOL_EXPR.parseString(stmt)[0]
-        except ParseException:
-            raise InvalidIfClause(f'Invalid if statement: {stmt}')
+        except (ParseException, InvalidIfClause) as ex:
+            raise InvalidIfClause(f'Invalid if clause: {stmt}. {ex}')
 
         self.temporary = temporary
         self.reason = reason
 
         if self.temporary is True and not self.reason:
-            raise InvalidIfClause('"reason" must be set when "temporary: true"')
+            raise InvalidIfClause(
+                f'Invalid if clause "{stmt}". '
+                f'"reason" must be set when "temporary: true". '
+                f'For example:\n'
+                f'  - if: {stmt}\n'
+                f'    temporary: true\n'
+                f'    reason: lack of ci runners'
+            )
 
     def get_value(self, target: str, config_name: str) -> t.Any:
         return self.stmt.get_value(target, config_name)
@@ -249,6 +256,7 @@ class Manifest:
 
         rules: t.List[FolderRule] = []
         for path in paths:
+            LOGGER.debug('Loading manifest file %s', path)
             _manifest = cls.from_file(path, root_path=root_path)
 
             for rule in _manifest.rules:
@@ -344,11 +352,14 @@ class Manifest:
                 return x
 
         for folder, sha_value in recorded__rel_folder__sha__dict.items():
+            # removed
             if folder not in self__rel_folder__sha__dict:
                 diff_folders.add(_path(folder))
+            # modified
             elif sha_value != self__rel_folder__sha__dict[folder]:
                 diff_folders.add(_path(folder))
 
+        # new
         for folder in self__rel_folder__sha__dict:
             if folder not in recorded__rel_folder__sha__dict:
                 diff_folders.add(_path(folder))

{idf_build_apps-2.5.0rc2 → idf_build_apps-2.5.2}/pyproject.toml

@@ -60,7 +60,7 @@ idf-build-apps = "idf_build_apps:main.main"
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "2.5.0rc2"
+version = "2.5.2"
 tag_format = "v$version"
 version_files = [
     "idf_build_apps/__init__.py",

{idf_build_apps-2.5.0rc2 → idf_build_apps-2.5.2}/setup.py

@@ -35,7 +35,7 @@ entry_points = \
 {'console_scripts': ['idf-build-apps = idf_build_apps:main.main']}
 
 setup(name='idf-build-apps',
-      version='2.5.0rc2',
+      version='2.5.2',
       description='Tools for building ESP-IDF related apps.',
       author=None,
       author_email='Fu Hanxi <fuhanxi@espressif.com>',

{idf_build_apps-2.5.0rc2 → idf_build_apps-2.5.2}/tests/conftest.py

@@ -10,13 +10,14 @@ from idf_build_apps import (
     setup_logging,
 )
 from idf_build_apps.args import apply_config_file
-from idf_build_apps.constants import IDF_BUILD_APPS_TOML_FN
+from idf_build_apps.constants import IDF_BUILD_APPS_TOML_FN, SUPPORTED_TARGETS
 from idf_build_apps.manifest.manifest import FolderRule
 
 
 @pytest.fixture(autouse=True)
 def clean_cls_attr(tmp_path):
     App.MANIFEST = None
+    FolderRule.DEFAULT_BUILD_TARGETS = SUPPORTED_TARGETS
     idf_build_apps.SESSION_ARGS.clean()
     apply_config_file(IDF_BUILD_APPS_TOML_FN)
     os.chdir(tmp_path)
@@ -66,3 +67,16 @@ def sha_of_enable_only_esp32():
     )
 
     return sha
+
+
+@pytest.fixture
+def sha_of_enable_esp32_or_esp32s2():
+    sha = FolderRule('test1', enable=[{'if': 'IDF_TARGET == "esp32" or IDF_TARGET == "esp32s2"'}]).sha
+
+    # !!! ONLY CHANGE IT WHEN NECESSARY !!!
+    assert (
+        sha
+        == 'f3408e9bf1d6b9a9e14559e6567917986678a3414229b29f96493aec4dc1bc3e6d0ecc4f79adced0d5c26bc1cd80a4d15fe6aaefa5d1e7033a58290374f4fc7f'  # noqa: E501
+    )
+
+    return sha

idf_build_apps-2.5.2/tests/test_args.py

@@ -0,0 +1,296 @@
+# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
+from xml.etree import ElementTree
+
+import pytest
+from conftest import (
+    create_project,
+)
+
+from idf_build_apps import App
+from idf_build_apps.args import (
+    BuildArguments,
+    DependencyDrivenBuildArguments,
+    FindArguments,
+    FindBuildArguments,
+)
+from idf_build_apps.constants import IDF_BUILD_APPS_TOML_FN
+from idf_build_apps.main import main
+
+
+def test_init_attr_deprecated_by():
+    args = DependencyDrivenBuildArguments(
+        ignore_app_dependencies_filepatterns=['bar'],
+        modified_files=['barfile'],
+    )
+    assert args.deactivate_dependency_driven_build_by_filepatterns == ['bar']
+
+    args = DependencyDrivenBuildArguments(
+        deactivate_dependency_driven_build_by_components=['foo'],
+        modified_components=['foocomp'],
+    )
+    assert args.deactivate_dependency_driven_build_by_components == ['foo']
+
+
+@pytest.mark.parametrize(
+    'kwargs, expected',
+    [
+        ({'config': 'foo'}, ['foo']),
+        ({'config_rules_str': 'bar'}, ['bar']),
+        ({'config_rules': ['baz']}, ['baz']),
+    ],
+)
+def test_init_attr_override(kwargs, expected):
+    args = FindBuildArguments(
+        **kwargs,
+    )
+    assert args.config_rules == expected
+
+
+def test_apply_config_with_deprecated_names():
+    with open(IDF_BUILD_APPS_TOML_FN, 'w') as fw:
+        fw.write("""config = [
+    "foo"
+]
+no_color = true
+""")
+
+    args = FindBuildArguments()
+    assert args.config_rules == ['foo']
+
+
+def test_empty_argument():
+    args = FindArguments()
+    assert args.config_rules is None
+
+
+def test_build_args_expansion():
+    args = BuildArguments(
+        parallel_index=2, collect_app_info='@p.txt', junitxml='x_@p.txt', collect_size_info='@p_@p.txt'
+    )
+    assert args.collect_app_info == '2.txt'
+    assert args.junitxml == 'x_2.txt'
+
+    args.parallel_index = 3
+    assert args.collect_app_info == '3.txt'
+    assert args.junitxml == 'x_3.txt'
+    assert args.collect_size_info == '3_3.txt'
+
+
+def test_func_overwrite_config():
+    with open(IDF_BUILD_APPS_TOML_FN, 'w') as fw:
+        fw.write("""config = [
+        "foo"
+    ]
+    modified_components = [
+        'comp1',
+    ]
+    no_color = true
+    """)
+
+    args = FindArguments(
+        config=['bar'],
+    )
+
+    assert args.config_rules == ['bar']
+    assert args.modified_components == ['comp1']
+    assert args.modified_files is None
+
+
+def test_func_overwrite_toml_overwrite_pyproject_toml():
+    with open('pyproject.toml', 'w') as fw:
+        fw.write("""[tool.idf-build-apps]
+config = [
+    "foo"
+]
+modified_components = [
+    'comp1',
+]
+ignore_app_dependencies_components = [
+    'baz'
+]
+verbose=3
+    """)
+
+    with open(IDF_BUILD_APPS_TOML_FN, 'w') as fw:
+        fw.write("""config = [
+    "bar"
+]
+modified_files = [
+    'file1',
+]
+        """)
+
+    args = FindArguments(
+        modified_components=['comp2'],
+    )
+    assert args.config_rules == ['bar']
+    assert args.modified_components == ['comp2']
+    assert args.modified_files == ['file1']
+    assert args.verbose == 3
+    assert args.deactivate_dependency_driven_build_by_components == ['baz']
+
+
+class TestIgnoreWarningFile:
+    def test_deprecated_cli(self, monkeypatch, capsys):
+        with open('foo.txt', 'w') as fw:
+            fw.write('warning:xxx')
+
+        with monkeypatch.context() as m:
+            m.setattr('sys.argv', ['idf-build-apps', 'build', '--ignore-warning-file', 'foo.txt'])
+            main()
+
+        assert len(App.IGNORE_WARNS_REGEXES) == 1
+        assert App.IGNORE_WARNS_REGEXES[0].pattern == 'warning:xxx'
+
+        with open('bar.txt', 'w') as fw:
+            fw.write('warning:yyy')
+
+        with monkeypatch.context() as m:
+            m.setattr('sys.argv', ['idf-build-apps', 'build', '--ignore-warning-file', 'foo.txt', 'bar.txt'])
+            with pytest.raises(SystemExit):
+                main()
+
+        assert 'unrecognized arguments: bar.txt' in capsys.readouterr().err
+
+    def test_new_cli(self, monkeypatch):
+        with open('foo.txt', 'w') as fw:
+            fw.write('warning:xxx')
+        with open('bar.txt', 'w') as fw:
+            fw.write('warning:yyy')
+
+        with monkeypatch.context() as m:
+            m.setattr('sys.argv', ['idf-build-apps', 'build', '--ignore-warning-files', 'foo.txt', 'bar.txt'])
+            main()
+
+        assert len(App.IGNORE_WARNS_REGEXES) == 2
+        assert App.IGNORE_WARNS_REGEXES[0].pattern == 'warning:xxx'
+        assert App.IGNORE_WARNS_REGEXES[1].pattern == 'warning:yyy'
+
+    def test_func_with_str(self):
+        with open('foo.txt', 'w') as fw:
+            fw.write('warning:xxx')
+        with open('bar.txt', 'w') as fw:
+            fw.write('warning:yyy')
+
+        BuildArguments(
+            ignore_warning_files=['foo.txt', 'bar.txt'],
+        )
+
+        assert len(App.IGNORE_WARNS_REGEXES) == 2
+        assert App.IGNORE_WARNS_REGEXES[0].pattern == 'warning:xxx'
+        assert App.IGNORE_WARNS_REGEXES[1].pattern == 'warning:yyy'
+
+    def test_func_with_fs(self):
+        with open('foo.txt', 'w') as fw:
+            fw.write('warning:xxx')
+        with open('bar.txt', 'w') as fw:
+            fw.write('warning:yyy')
+
+        BuildArguments(
+            ignore_warning_file=[open('foo.txt'), open('bar.txt')],
+        )
+
+        assert len(App.IGNORE_WARNS_REGEXES) == 2
+        assert App.IGNORE_WARNS_REGEXES[0].pattern == 'warning:xxx'
+        assert App.IGNORE_WARNS_REGEXES[1].pattern == 'warning:yyy'
+
+    def test_ignore_extra_fields(self):
+        with open(IDF_BUILD_APPS_TOML_FN, 'w') as fw:
+            fw.write("""dry_run = true""")
+
+        args = FindArguments()
+        assert not hasattr(args, 'dry_run')
+
+    def test_config_file(self, tmp_path, monkeypatch):
+        create_project('foo', tmp_path)
+
+        with open(IDF_BUILD_APPS_TOML_FN, 'w') as fw:
+            fw.write("""paths = ["foo"]
+target = "esp32"
+build_dir = "build_@t"
+junitxml = "test.xml"
+keep_going = true
+""")
+
+        # test basic config
+        with monkeypatch.context() as m:
+            m.setenv('PATH', 'foo')  # let build fail
+            m.setattr('sys.argv', ['idf-build-apps', 'build'])
+            with pytest.raises(SystemExit):
+                main()
+
+        with open('test.xml') as f:
+            xml = ElementTree.fromstring(f.read())
+        test_suite = xml.findall('testsuite')[0]
+        assert test_suite.attrib['failures'] == '1'
+        assert test_suite.attrib['errors'] == '0'
+        assert test_suite.attrib['skipped'] == '0'
+        assert test_suite.findall('testcase')[0].attrib['name'] == 'foo/build_esp32'
+
+        # test cli overrides config
+        with monkeypatch.context() as m:
+            m.setenv('PATH', 'foo')  # let build fail
+            m.setattr('sys.argv', ['idf-build-apps', 'build', '--build-dir', 'build_hi_@t'])
+            with pytest.raises(SystemExit):
+                main()
+
+        with open('test.xml') as f:
+            xml = ElementTree.fromstring(f.read())
+        test_suite = xml.findall('testsuite')[0]
+        assert test_suite.attrib['failures'] == '1'
+        assert test_suite.attrib['errors'] == '0'
+        assert test_suite.attrib['skipped'] == '0'
+        assert test_suite.findall('testcase')[0].attrib['name'] == 'foo/build_hi_esp32'
+
+        # test cli action_true
+        with monkeypatch.context() as m:
+            m.setattr('sys.argv', ['idf-build-apps', 'build', '--dry-run'])
+            main()
+
+        with open('test.xml') as f:
+            xml = ElementTree.fromstring(f.read())
+        test_suite = xml.findall('testsuite')[0]
+        assert test_suite.attrib['failures'] == '0'
+        assert test_suite.attrib['errors'] == '0'
+        assert test_suite.attrib['skipped'] == '1'
+        assert test_suite.findall('testcase')[0].attrib['name'] == 'foo/build_esp32'
+
+        # test config store_true set to true
+        with open(IDF_BUILD_APPS_TOML_FN, 'a') as fw:
+            fw.write('\ndry_run = true\n')
+
+        with monkeypatch.context() as m:
+            m.setattr('sys.argv', ['idf-build-apps', 'build'])
+            main()
+
+        with open('test.xml') as f:
+            xml = ElementTree.fromstring(f.read())
+        test_suite = xml.findall('testsuite')[0]
+        assert test_suite.attrib['failures'] == '0'
+        assert test_suite.attrib['errors'] == '0'
+        assert test_suite.attrib['skipped'] == '1'
+        assert test_suite.findall('testcase')[0].attrib['name'] == 'foo/build_esp32'
+
+        # test config store_true set to false, but CLI set to true
+        with open(IDF_BUILD_APPS_TOML_FN, 'w') as fw:
+            fw.write("""paths = ["foo"]
+build_dir = "build_@t"
+junitxml = "test.xml"
+dry_run = false
+""")
+
+        with monkeypatch.context() as m:
+            m.setattr(
+                'sys.argv', ['idf-build-apps', 'build', '--default-build-targets', 'esp32', 'esp32s2', '--dry-run']
+            )
+            main()
+
+        with open('test.xml') as f:
+            xml = ElementTree.fromstring(f.read())
+        test_suite = xml.findall('testsuite')[0]
+        assert test_suite.attrib['failures'] == '0'
+        assert test_suite.attrib['errors'] == '0'
+        assert test_suite.attrib['skipped'] == '2'
+        assert test_suite.findall('testcase')[0].attrib['name'] == 'foo/build_esp32'
+        assert test_suite.findall('testcase')[1].attrib['name'] == 'foo/build_esp32s2'

{idf_build_apps-2.5.0rc2 → idf_build_apps-2.5.2}/tests/test_cmd.py

@@ -10,13 +10,6 @@ from idf_build_apps.main import main
 from idf_build_apps.utils import InvalidCommand
 
 
-class FakeArgs:
-    """like what argparse.Namespace does"""
-
-    def __init__(self, **kwargs):
-        self.__dict__.update(kwargs)
-
-
 @pytest.mark.parametrize(
     'args, expected_error',
     [
@@ -26,7 +19,9 @@ class FakeArgs:
         (['--manifest-files', 'test.yml', '--output', 'test.sha1'], None),
     ],
 )
-def test_manifest_dump_sha_values(args, expected_error, sha_of_enable_only_esp32, capsys, monkeypatch):
+def test_manifest_dump_sha_values(
+    args, expected_error, sha_of_enable_only_esp32, sha_of_enable_esp32_or_esp32s2, capsys, monkeypatch
+):
     Path('test.yml').write_text(
         """
 foo:
@@ -38,6 +33,9 @@ bar:
 baz:
   enable:
     - if: IDF_TARGET == "esp32"
+foobar:
+  enable:
+    - if: IDF_TARGET == "esp32" or IDF_TARGET == "esp32s2"
 """,
         encoding='utf8',
     )
@@ -67,4 +65,5 @@ baz:
                 f'bar:{sha_of_enable_only_esp32}\n'
                 f'baz:{sha_of_enable_only_esp32}\n'
                 f'foo:{sha_of_enable_only_esp32}\n'
+                f'foobar:{sha_of_enable_esp32_or_esp32s2}\n'
             )

{idf_build_apps-2.5.0rc2 → idf_build_apps-2.5.2}/tests/test_finder.py

@@ -102,7 +102,7 @@ get-started:
             """
 examples/get-started:
     enable:
-        - if: IDF_VERSION_MAJOR > 0 and IDF_VERSION_MINOR < 999 and IDF_VERSION_PATCH in [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+        - if: IDF_VERSION_MAJOR > 0 and IDF_VERSION_MINOR < 999
 """,
             encoding='utf8',
         )

{idf_build_apps-2.5.0rc2 → idf_build_apps-2.5.2}/tests/test_manifest.py

@@ -1,6 +1,5 @@
 # SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
-
 import os
 
 import pytest
@@ -522,9 +521,17 @@ class TestIfParser:
 
     def test_invalid_if_statement(self):
         statement = '1'
-        with pytest.raises(InvalidIfClause, match='Invalid if statement: 1'):
+        with pytest.raises(InvalidIfClause, match='Invalid if clause: 1'):
             IfClause(statement)
 
     def test_temporary_must_with_reason(self):
         with pytest.raises(InvalidIfClause, match='"reason" must be set when "temporary: true"'):
             IfClause(stmt='IDF_TARGET == "esp32"', temporary=True)
+
+
+def test_consecutive_or_and_stml_manifest():
+    with pytest.raises(InvalidIfClause, match='Chaining "and"/"or" is not allowed'):
+        IfClause(stmt='IDF_TARGET == "esp32" or IDF_TARGET == "esp32c3" or IDF_TARGET == "esp32s3"')
+
+    with pytest.raises(InvalidIfClause, match='Chaining "and"/"or" is not allowed'):
+        IfClause(stmt='IDF_TARGET == "esp32" or IDF_TARGET == "esp32c3" and IDF_TARGET == "esp32s3"')

idf_build_apps-2.5.0rc2/tests/test_args.py

@@ -1,125 +0,0 @@
-# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
-# SPDX-License-Identifier: Apache-2.0
-
-import pytest
-
-from idf_build_apps.args import (
-    BuildArguments,
-    DependencyDrivenBuildArguments,
-    FindArguments,
-    FindBuildArguments,
-)
-from idf_build_apps.constants import IDF_BUILD_APPS_TOML_FN
-
-
-def test_init_attr_deprecated_by():
-    args = DependencyDrivenBuildArguments(
-        ignore_app_dependencies_filepatterns=['bar'],
-        modified_files=['barfile'],
-    )
-    assert args.deactivate_dependency_driven_build_by_filepatterns == ['bar']
-
-    args = DependencyDrivenBuildArguments(
-        deactivate_dependency_driven_build_by_components=['foo'],
-        modified_components=['foocomp'],
-    )
-    assert args.deactivate_dependency_driven_build_by_components == ['foo']
-
-
-@pytest.mark.parametrize(
-    'kwargs, expected',
-    [
-        ({'config': 'foo'}, ['foo']),
-        ({'config_rules_str': 'bar'}, ['bar']),
-        ({'config_rules': ['baz']}, ['baz']),
-    ],
-)
-def test_init_attr_override(kwargs, expected):
-    args = FindBuildArguments(
-        **kwargs,
-    )
-    assert args.config_rules == expected
-
-
-def test_apply_config_with_deprecated_names():
-    with open(IDF_BUILD_APPS_TOML_FN, 'w') as fw:
-        fw.write("""config = [
-    "foo"
-]
-no_color = true
-""")
-
-    args = FindBuildArguments()
-    assert args.config_rules == ['foo']
-
-
-def test_empty_argument():
-    args = FindArguments()
-    assert args.config_rules is None
-
-
-def test_build_args_expansion():
-    args = BuildArguments(
-        parallel_index=2, collect_app_info='@p.txt', junitxml='x_@p.txt', collect_size_info='@p_@p.txt'
-    )
-    assert args.collect_app_info == '2.txt'
-    assert args.junitxml == 'x_2.txt'
-
-    args.parallel_index = 3
-    assert args.collect_app_info == '3.txt'
-    assert args.junitxml == 'x_3.txt'
-    assert args.collect_size_info == '3_3.txt'
-
-
-def test_func_overwrite_config():
-    with open(IDF_BUILD_APPS_TOML_FN, 'w') as fw:
-        fw.write("""config = [
-        "foo"
-    ]
-    modified_components = [
-        'comp1',
-    ]
-    no_color = true
-    """)
-
-    args = FindArguments(
-        config=['bar'],
-    )
-
-    assert args.config_rules == ['bar']
-    assert args.modified_components == ['comp1']
-    assert args.modified_files is None
-
-
-def test_func_overwrite_toml_overwrite_pyproject_toml():
-    with open('pyproject.toml', 'w') as fw:
-        fw.write("""[tool.idf-build-apps]
-config = [
-    "foo"
-]
-modified_components = [
-    'comp1',
-]
-ignore_app_dependencies_components = [
-    'baz'
-]
-verbose=3
-    """)
-
-    with open(IDF_BUILD_APPS_TOML_FN, 'w') as fw:
-        fw.write("""config = [
-    "bar"
-]
-modified_files = [
-    'file1',
-]
-        """)
-
-    args = FindArguments(
-        modified_components=['comp2'],
-    )
-    assert args.config_rules == ['bar']
-    assert args.modified_components == ['comp2']
-    assert args.modified_files == ['file1']
-    assert args.verbose == 3
-    assert args.deactivate_dependency_driven_build_by_components == ['baz']