idf-build-apps 2.5.1__tar.gz → 2.5.3__tar.gz

{idf_build_apps-2.5.1 → idf_build_apps-2.5.3}/.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.1 → idf_build_apps-2.5.3}/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to this project will be documented in this file.
 
+## v2.5.3 (2024-10-04)
+
+### Feat
+
+- support --manifest-filepatterns
+
+## v2.5.2 (2024-09-27)
+
+### Fix
+
+- unset CLI argument wrongly overwrite config file settings with default value
+- allow unknown fields
+
 ## v2.5.1 (2024-09-26)
 
 ### Fix

{idf_build_apps-2.5.1 → idf_build_apps-2.5.3}/PKG-INFO

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

{idf_build_apps-2.5.1 → idf_build_apps-2.5.3}/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.1'
+__version__ = '2.5.3'
 
 from .session_args import (
     SessionArgs,

{idf_build_apps-2.5.1 → idf_build_apps-2.5.3}/idf_build_apps/args.py

@@ -3,6 +3,7 @@
 
 import argparse
 import enum
+import glob
 import inspect
 import logging
 import os
@@ -117,6 +118,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
@@ -140,8 +142,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
 
@@ -189,6 +192,15 @@ class DependencyDrivenBuildArguments(GlobalArguments):
         validation_alias=AliasChoices('manifest_files', 'manifest_file'),
         default=None,
     )
+    manifest_filepatterns: t.Optional[t.List[str]] = field(
+        FieldMetadata(
+            validate_method=[ValidateMethod.TO_LIST],
+            nargs='+',
+        ),
+        description='space-separated list of file patterns to search for the manifest files. '
+        'The matched files will be loaded as the manifest files.',
+        default=None,
+    )
     manifest_rootpath: str = field(
         None,
         description='Root path to resolve the relative paths defined in the manifest files. '
@@ -268,7 +280,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,
@@ -277,6 +289,17 @@ class DependencyDrivenBuildArguments(GlobalArguments):
     def model_post_init(self, __context: Any) -> None:
         super().model_post_init(__context)
 
+        if self.manifest_filepatterns:
+            matched_paths = set()
+            for pat in [to_absolute_path(p, self.manifest_rootpath) for p in self.manifest_filepatterns]:
+                matched_paths.update(glob.glob(str(pat), recursive=True))
+
+            if matched_paths:
+                if self.manifest_files:
+                    self.manifest_files.extend(matched_paths)
+                else:
+                    self.manifest_files = list(matched_paths)
+
         Manifest.CHECK_MANIFEST_RULES = self.check_manifest_rules
         if self.manifest_files:
             App.MANIFEST = Manifest.from_files(
@@ -799,14 +822,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.1 → idf_build_apps-2.5.3}/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.1 → idf_build_apps-2.5.3}/pyproject.toml

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

{idf_build_apps-2.5.1 → idf_build_apps-2.5.3}/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.1',
+      version='2.5.3',
       description='Tools for building ESP-IDF related apps.',
       author=None,
       author_email='Fu Hanxi <fuhanxi@espressif.com>',

{idf_build_apps-2.5.1 → idf_build_apps-2.5.3}/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)

{idf_build_apps-2.5.1 → idf_build_apps-2.5.3}/tests/test_args.py

@@ -1,7 +1,11 @@
 # 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 (
@@ -190,3 +194,103 @@ class TestIgnoreWarningFile:
         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.1 → idf_build_apps-2.5.3}/tests/test_cmd.py

@@ -1,6 +1,6 @@
 # SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
-
+import os
 import sys
 from pathlib import Path
 
@@ -67,3 +67,31 @@ foobar:
                 f'foo:{sha_of_enable_only_esp32}\n'
                 f'foobar:{sha_of_enable_esp32_or_esp32s2}\n'
             )
+
+
+def test_manifest_patterns(tmp_path, monkeypatch, capsys):
+    manifest = tmp_path / 'manifest.yml'
+    manifest.write_text(
+        """foo:
+  enable:
+    - if: IDF_TARGET == "esp32"
+bar:
+  enable:
+    - if: IDF_TARGET == "esp32"
+        """
+    )
+
+    with pytest.raises(SystemExit) as e:
+        with monkeypatch.context() as m:
+            m.setattr(
+                sys,
+                'argv',
+                ['idf-build-apps', 'find', '--manifest-filepatterns', '**.whatever', '**/manifest.yml', '-vv'],
+            )
+            main()
+        assert e.retcode == 0
+
+    _, err = capsys.readouterr()
+    assert f'Loading manifest file {os.path.join(tmp_path, "manifest.yml")}' in err
+    assert f'"{os.path.join(tmp_path, "foo")}" does not exist' in err
+    assert f'"{os.path.join(tmp_path, "bar")}" does not exist' in err