idf-build-apps 2.4.1.dev0__tar.gz → 2.4.3__tar.gz

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.3}/.github/workflows/test-build-idf-apps.yml

@@ -52,9 +52,12 @@ jobs:
           bash $IDF_PATH/install.sh
           . $IDF_PATH/export.sh
           pip install idf_build_apps-*.whl
-          python -m idf_build_apps build -vv -t esp32 \
-            -p $IDF_PATH/examples/get-started/hello_world \
-            --size-file size_info.json
+          cd $IDF_PATH/examples/get-started/hello_world
+          cat 'CONFIG_IDF_TARGET="esp32"' >sdkconfig.defaults
+          idf-build-apps build --build-dir build_@t --size-file size_info.json
+          test -f build_esp32/hello_world.bin
+          test -f build_esp32/size_info.json
+          test ! -f build_esp32s2/hello_world.bin
 
   build-apps-on-idf-master:
     runs-on: ubuntu-latest

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.3}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -16,14 +16,13 @@ repos:
           - license_header.txt        # defaults to: LICENSE.txt
           - --use-current-year
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.2.1'
+    rev: 'v0.5.5'
     hooks:
       - id: ruff
-        args: ['--fix', '--preview']
+        args: ['--fix']
       - id: ruff-format
-        args: ['--preview']
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 'v1.8.0'
+    rev: 'v1.8.0'   # 1.9 doesn't support python 3.7
     hooks:
       - id: mypy
         args: ['--warn-unused-ignores']

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.3}/CHANGELOG.md

@@ -2,7 +2,33 @@
 
 All notable changes to this project will be documented in this file.
 
-## v2.4.1.dev0 (2024-06-17)
+## v2.4.3 (2024-08-07)
+
+### Feat
+
+- set default building target to "all" if `--target` is not specified
+- set default paths to current directory if `--paths` is not specified
+
+## v2.4.2 (2024-08-01)
+
+### Feat
+
+- support `--enable-preview-targets`
+- support `--include-all-apps` while find_apps
+- support `--output-format json` while find_apps
+- support `include_disabled_apps` while `find_apps`
+
+### Fix
+
+- ignore specified target if unknown in current ESP-IDF branch instead of raise exception
+- correct `post_build` actions for succeeded with warnings builds
+- **completions**: fix typos in help
+
+### Refactor
+
+- update deprecated `datetime.utcnow`
+
+## v2.4.1 (2024-06-18)
 
 ### Fix
 

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.3}/PKG-INFO

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

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.3}/docs/conf.py

@@ -52,15 +52,17 @@ docs_dir = os.path.dirname(__file__)
 api_dir = os.path.join(docs_dir, 'api')
 if os.path.isdir(api_dir):
     shutil.rmtree(api_dir)
-subprocess.run([
-    'sphinx-apidoc',
-    os.path.join(docs_dir, '..', 'idf_build_apps'),
-    '-f',
-    '-H',
-    'API Reference',
-    '--no-headings',
-    '-t',
-    '_apidoc_templates',
-    '-o',
-    api_dir,
-])
+subprocess.run(
+    [
+        'sphinx-apidoc',
+        os.path.join(docs_dir, '..', 'idf_build_apps'),
+        '-f',
+        '-H',
+        'API Reference',
+        '--no-headings',
+        '-t',
+        '_apidoc_templates',
+        '-o',
+        api_dir,
+    ]
+)

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.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.4.1.dev0'
+__version__ = '2.4.3'
 
 from .session_args import (
     SessionArgs,

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.3}/idf_build_apps/app.py

@@ -10,9 +10,7 @@ import re
 import shutil
 import sys
 import typing as t
-from datetime import (
-    datetime,
-)
+from datetime import datetime, timezone
 from pathlib import (
     Path,
 )
@@ -153,10 +151,12 @@ class App(BaseModel):
         size_json_filename: t.Optional[str] = None,
         **kwargs: t.Any,
     ) -> None:
-        kwargs.update({
-            'app_dir': app_dir,
-            'target': target,
-        })
+        kwargs.update(
+            {
+                'app_dir': app_dir,
+                'target': target,
+            }
+        )
         super().__init__(**kwargs)
 
         # These internal variables store the paths with environment variables and placeholders;
@@ -169,12 +169,14 @@ class App(BaseModel):
         self._is_build_log_path_temp = not bool(build_log_filename)
 
         # pass all parameters to initialize hook method
-        kwargs.update({
-            'work_dir': self._work_dir,
-            'build_dir': self._build_dir,
-            'build_log_filename': build_log_filename,
-            'size_json_filename': size_json_filename,
-        })
+        kwargs.update(
+            {
+                'work_dir': self._work_dir,
+                'build_dir': self._build_dir,
+                'build_log_filename': build_log_filename,
+                'size_json_filename': size_json_filename,
+            }
+        )
         self._kwargs = kwargs
         self._initialize_hook(**kwargs)
 
@@ -472,11 +474,11 @@ class App(BaseModel):
     def record_build_duration(func):
         @functools.wraps(func)
         def wrapper(self, *args, **kwargs):
-            self._build_timestamp = datetime.utcnow()
+            self._build_timestamp = datetime.now(timezone.utc)
             try:
                 return func(self, *args, **kwargs)
             finally:
-                self._build_duration = (datetime.utcnow() - self._build_timestamp).total_seconds()
+                self._build_duration = (datetime.now(timezone.utc) - self._build_timestamp).total_seconds()
 
         return wrapper
 
@@ -544,6 +546,14 @@ class App(BaseModel):
         modified_files: t.Union[t.List[str], str, None] = None,
         check_app_dependencies: bool = False,
     ) -> None:
+        if self.build_status not in (
+            BuildStatus.UNKNOWN,
+            BuildStatus.SHOULD_BE_BUILT,
+        ):
+            self.build_comment = f'Build {self.build_status.value}. Skipping...'
+            return
+
+        # real build starts here
         self._pre_build()
 
         try:
@@ -560,8 +570,16 @@ class App(BaseModel):
         self._post_build()
 
     def _post_build(self) -> None:
+        """Post build actions for failed/success builds"""
+        if self.build_status not in (
+            BuildStatus.FAILED,
+            BuildStatus.SUCCESS,
+        ):
+            return
+
         self._build_stage = BuildStage.POST_BUILD
 
+        # both status applied
         if self.copy_sdkconfig:
             try:
                 shutil.copy(
@@ -573,12 +591,21 @@ class App(BaseModel):
             else:
                 self._logger.debug('Copied sdkconfig file from %s to %s', self.work_dir, self.build_path)
 
+        # for originally success builds generate size.json if enabled
+        #
+        # for the rest of the actions, we need to check if there's further build warnings
+        # to tell if this build is successful or not
+        if self.build_status == BuildStatus.SUCCESS:
+            self.write_size_json()
+
         if not os.path.isfile(self.build_log_path):
+            self._logger.warning(f'{self.build_log_path} does not exist. Skipping post build actions...')
             return
 
+        # check warnings
         has_unignored_warning = False
         with open(self.build_log_path) as fr:
-            lines = [line.rstrip() for line in fr.readlines() if line.rstrip()]
+            lines = [line.rstrip() for line in fr if line.rstrip()]
             for line in lines:
                 is_error_or_warning, ignored = self.is_error_or_warning(line)
                 if is_error_or_warning:
@@ -588,6 +615,14 @@ class App(BaseModel):
                         self._logger.warning('%s', line)
                         has_unignored_warning = True
 
+        # correct build status for originally successful builds
+        if self.build_status == BuildStatus.SUCCESS:
+            if self.check_warnings and has_unignored_warning:
+                self.build_status = BuildStatus.FAILED
+                self.build_comment = 'build succeeded with warnings'
+            elif has_unignored_warning:
+                self.build_comment = 'build succeeded with warnings'
+
         if self.build_status == BuildStatus.FAILED:
             # print last few lines to help debug
             self._logger.error(
@@ -598,14 +633,14 @@ class App(BaseModel):
             for line in lines[-self.LOG_DEBUG_LINES :]:
                 self._logger.error('%s', line)
 
-        if self._is_build_log_path_temp and self.build_status == BuildStatus.SUCCESS:
+            return
+
+        # Actions for real success builds
+        # remove temp log file
+        if self._is_build_log_path_temp:
             os.unlink(self.build_log_path)
             self._logger.debug('Removed success build temporary log file: %s', self.build_log_path)
 
-        # Generate Size Files
-        if self.build_status == BuildStatus.SUCCESS:
-            self.write_size_json()
-
         # Cleanup build directory if not preserving
         if not self.preserve:
             exclude_list = []
@@ -619,13 +654,6 @@ class App(BaseModel):
             )
             self._logger.debug('Removed built binaries under: %s', self.build_path)
 
-        # Build Result
-        if self.check_warnings and has_unignored_warning:
-            self.build_status = BuildStatus.FAILED
-            self.build_comment = 'build succeeded with warnings'
-        elif has_unignored_warning:
-            self.build_comment = 'build succeeded with warnings'
-
     def _build(
         self,
         *,
@@ -665,12 +693,14 @@ class App(BaseModel):
         else:
             with open(self.size_json_path, 'w') as fw:
                 subprocess_run(
-                    ([
-                        sys.executable,
-                        str(IDF_SIZE_PY),
-                        '--json',
-                        map_file,
-                    ]),
+                    (
+                        [
+                            sys.executable,
+                            str(IDF_SIZE_PY),
+                            '--json',
+                            map_file,
+                        ]
+                    ),
                     log_terminal=False,
                     log_fs=fw,
                     check=True,
@@ -922,7 +952,7 @@ class CMakeApp(App):
             '-DSDKCONFIG_DEFAULTS={}'.format(';'.join(self.sdkconfig_files) if self.sdkconfig_files else ';'),
         ]
 
-        if modified_components is not None and check_app_dependencies and self.build_status == BuildStatus.UNKNOWN:
+        if self.build_status == BuildStatus.UNKNOWN and modified_components is not None and check_app_dependencies:
             subprocess_run(
                 [*common_args, 'reconfigure'],
                 log_terminal=self._is_build_log_path_temp,

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.3}/idf_build_apps/constants.py

@@ -80,6 +80,7 @@ IDF_VERSION = to_version(f'{IDF_VERSION_MAJOR}.{IDF_VERSION_MINOR}.{IDF_VERSION_
 
 class BuildStatus(str, enum.Enum):
     UNKNOWN = 'unknown'
+    DISABLED = 'disabled'
     SKIPPED = 'skipped'
     SHOULD_BE_BUILT = 'should be built'
     FAILED = 'build failed'
@@ -98,14 +99,14 @@ class BuildStage(str, enum.Enum):
 
 
 completion_instructions = """
-With `--activate` option detect your shell type and add the appropriate commands to your shell's config file
-so that it is run on startup. You will likely have to restart
+With the `--activate` option, detect your shell type and add the appropriate commands to your shell's config file
+so that it runs on startup. You will likely have to restart.
 or re-login for the autocompletion to start working.
 
-You can also specify your shell by the `--shell` option.
+You can also specify your shell using the `--shell` option.
 
-If you do not want automaticall modifying your shell config file
-you can manually add commands provided below to activate autocompletion
+If you do not want automatic modification of your shell configuration file
+You can manually add the commands provided below to activate autocompletion.
 or run them in your current terminal session for one-time activation.
 
 Once again, you will likely have to restart

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.3}/idf_build_apps/finder.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import logging
@@ -43,6 +43,7 @@ def _get_apps_from_path(
     check_app_dependencies: bool = False,
     sdkconfig_defaults_str: t.Optional[str] = None,
     include_skipped_apps: bool = False,
+    include_disabled_apps: bool = False,
 ) -> t.List[App]:
     modified_components = to_list(modified_components)
     modified_files = to_list(modified_files)
@@ -50,7 +51,8 @@ def _get_apps_from_path(
     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))
-            return False
+            _app.build_status = BuildStatus.DISABLED
+            return include_disabled_apps
 
         _app._check_should_build(
             manifest_rootpath=manifest_rootpath,

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.3}/idf_build_apps/junit/report.py

@@ -38,6 +38,7 @@ import os.path
 import typing as t
 from datetime import (
     datetime,
+    timezone,
 )
 from xml.etree import (
     ElementTree,
@@ -81,14 +82,17 @@ class TestCase:
             raise ValueError('Only one of failure_reason, skipped_reason, error_reason can be set')
 
         self.duration_sec = duration_sec
-        self.timestamp = timestamp or datetime.utcnow()
+        self.timestamp = timestamp or datetime.now(timezone.utc)
 
         self.properties = properties or {}
 
     @classmethod
     def from_app(cls, app: App) -> 'TestCase':
-        if app.build_status not in (BuildStatus.FAILED, BuildStatus.SUCCESS, BuildStatus.SKIPPED):
-            raise ValueError(f'Cannot create test case from app with build status {app.build_status}')
+        if app.build_status in (BuildStatus.UNKNOWN, BuildStatus.SHOULD_BE_BUILT):
+            raise ValueError(
+                f'Cannot create build report for apps with build status {app.build_status}. '
+                f'Please finish the build process first.'
+            )
 
         kwargs: t.Dict[str, t.Any] = {
             'name': app.build_path,
@@ -98,7 +102,7 @@ class TestCase:
         }
         if app.build_status == BuildStatus.FAILED:
             kwargs['failure_reason'] = app.build_comment
-        elif app.build_status == BuildStatus.SKIPPED:
+        elif app.build_status in (BuildStatus.DISABLED, BuildStatus.SKIPPED):
             kwargs['skipped_reason'] = app.build_comment
 
         if app.size_json_path and os.path.isfile(app.size_json_path):
@@ -106,7 +110,7 @@ class TestCase:
                 for k, v in json.load(f).items():
                     kwargs['properties'][f'{k}'] = str(v)
 
-        return cls(**kwargs)  # type
+        return cls(**kwargs)
 
     @property
     def is_failed(self) -> bool:
@@ -155,7 +159,7 @@ class TestSuite:
         self.skipped = 0
 
         self.duration_sec: float = 0
-        self.timestamp = datetime.utcnow()
+        self.timestamp = datetime.now(timezone.utc)
 
         self.properties = get_sys_info()
 

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.3}/idf_build_apps/junit/utils.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import os
@@ -26,7 +26,7 @@ def get_processor_name():
     if os.path.isfile('/proc/cpuinfo'):
         try:
             with open('/proc/cpuinfo') as f:
-                for line in f.readlines():
+                for line in f:
                     if 'model name' in line:
                         return re.sub('.*model name.*:', '', line, 1).strip()
         except Exception:

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.3}/idf_build_apps/main.py

@@ -11,6 +11,7 @@ import re
 import sys
 import textwrap
 import typing as t
+from copy import deepcopy
 
 import argcomplete
 from pydantic import (
@@ -127,6 +128,7 @@ def find_apps(
     ignore_app_dependencies_filepatterns: t.Optional[t.Union[t.List[str], str]] = None,
     sdkconfig_defaults: t.Optional[str] = None,
     include_skipped_apps: bool = False,
+    include_disabled_apps: bool = False,
 ) -> t.List[App]:
     """
     Find app directories in paths (possibly recursively), which contain apps for the given build system, compatible
@@ -158,6 +160,7 @@ def find_apps(
     :param sdkconfig_defaults: semicolon-separated string, pass to idf.py -DSDKCONFIG_DEFAULTS if specified,
         also could be set via environment variables "SDKCONFIG_DEFAULTS"
     :param include_skipped_apps: include skipped apps or not
+    :param include_disabled_apps: include disabled apps or not
     :return: list of found apps
     """
     if default_build_targets:
@@ -223,6 +226,7 @@ def find_apps(
                     modified_files=modified_files,
                     sdkconfig_defaults_str=sdkconfig_defaults,
                     include_skipped_apps=include_skipped_apps,
+                    include_disabled_apps=include_disabled_apps,
                 )
             )
 
@@ -365,12 +369,14 @@ def build_apps(
                 if os.path.isfile(app.size_json_path):
                     with open(build_apps_args.collect_size_info, 'a') as fw:
                         fw.write(
-                            json.dumps({
-                                'app_name': app.name,
-                                'config_name': app.config_name,
-                                'target': app.target,
-                                'path': app.size_json_path,
-                            })
+                            json.dumps(
+                                {
+                                    'app_name': app.name,
+                                    'config_name': app.config_name,
+                                    'target': app.target,
+                                    'path': app.size_json_path,
+                                }
+                            )
                             + '\n'
                         )
                     LOGGER.debug('Recorded size info file path in %s', build_apps_args.collect_size_info)
@@ -452,8 +458,12 @@ def get_parser() -> argparse.ArgumentParser:
         help='Path to the default configuration file, toml file',
     )
 
-    common_args.add_argument('-p', '--paths', nargs='+', help='One or more paths to look for apps')
-    common_args.add_argument('-t', '--target', help='filter apps by given target')
+    common_args.add_argument(
+        '-p', '--paths', nargs='*', help='One or more paths to look for apps. By default build the current directory.'
+    )
+    common_args.add_argument(
+        '-t', '--target', default='all', help='filter apps by given target. By default build all supported targets.'
+    )
     common_args.add_argument(
         '--build-system', default='cmake', choices=['cmake', 'make'], help='filter apps by given build system'
     )
@@ -551,14 +561,19 @@ def get_parser() -> argparse.ArgumentParser:
         action='store_true',
         help='Exit with error if any of the manifest rules does not exist on your filesystem',
     )
-
+    common_args.add_argument(
+        '--enable-preview-targets',
+        action='store_true',
+        help='Build the apps with all targets in the current ESP-IDF branch, '
+        'including preview targets, when the app supports the target.',
+    )
     common_args.add_argument(
         '--default-build-targets',
         nargs='+',
-        help='space-separated list of supported targets. Targets supported in current ESP-IDF branch '
-        '(except preview ones) would be used if this option is not set.',
+        help='space-separated list of string which specifies the targets for building the apps. '
+        'If provided, the apps will be built only with the specified targets '
+        'when the app supports the target.',
     )
-
     common_args.add_argument(
         '--modified-components',
         type=semicolon_separated_str_to_list,
@@ -610,7 +625,7 @@ def get_parser() -> argparse.ArgumentParser:
 
     find_parser = actions.add_parser(
         'find',
-        help='Find the buildable applications. Run `idf-build-apps find --help` for more information on a command',
+        help='Find the buildable applications. Run `idf-build-apps find --help` for more information on a command.',
         description='Find the buildable applications in the given path or paths for specified chips. '
         '`--path` and `--target` options must be provided. '
         'By default, print the found apps in stdout. '
@@ -618,12 +633,23 @@ def get_parser() -> argparse.ArgumentParser:
         parents=[common_args],
         formatter_class=IdfBuildAppsCliFormatter,
     )
-
     find_parser.add_argument('-o', '--output', help='Print the found apps to the specified file instead of stdout')
+    find_parser.add_argument(
+        '--output-format',
+        choices=['raw', 'json'],
+        default='raw',
+        help='Output format. In "raw" format, each line is a valid json that represents the app. '
+        'In "json" format, the whole file is a JSON file of a list of apps.',
+    )
+    find_parser.add_argument(
+        '--include-all-apps',
+        action='store_true',
+        help='Include skipped and disabled apps. By default only apps that should be built.',
+    )
 
     build_parser = actions.add_parser(
         'build',
-        help='Build the found applications. Run `idf-build-apps build --help` for more information on a command',
+        help='Build the found applications. Run `idf-build-apps build --help` for more information on a command.',
         description='Build the application in the given path or paths for specified chips. '
         '`--path` and `--target` options must be provided.',
         parents=[common_args],
@@ -696,18 +722,18 @@ def get_parser() -> argparse.ArgumentParser:
     completions_parser = actions.add_parser(
         'completions',
         help='Add the autocompletion activation script to the shell rc file. '
-        'Run `idf-build-apps complations --help` for more information on a command',
+        'Run `idf-build-apps completions --help` for more information on a command.',
         description='Without `--activate` option print instructions for manual activation. '
-        'With `--activate` option add the autocompletion activation script to the shell rc file '
-        'for bash, zsh, or fish. Other shells are not supported. '
-        'The `--shell` option used only with the `--activate` option, '
+        'With the `--activate` option, add the autocompletion activation script to the shell rc file '
+        'for bash, zsh, or fish. Other shells are not supported.'
+        'The `--shell` option is used only with the `--activate` option, '
         'if provided, add the autocompletion activation script to the given shell; '
         'without this argument, will detect shell type automatically. '
         'May need to restart or re-login for the autocompletion to start working',
         formatter_class=IdfBuildAppsCliFormatter,
     )
     completions_parser.add_argument(
-        '-a', '--activate', action='store_true', help='Activate autocompletion automatically and permanently'
+        '-a', '--activate', action='store_true', help='Activate autocompletion automatically and permanently. '
     )
     completions_parser.add_argument(
         '-s',
@@ -737,28 +763,27 @@ def validate_args(parser: argparse.ArgumentParser, args: argparse.Namespace) ->
         raise InvalidCommand('subcommand is required. {find, build, completions}')
 
     if not args.paths:
-        raise InvalidCommand(
-            'Must specify at least one path to search for the apps ' 'with CLI option "-p <path>" or "--path <path>"'
-        )
+        cur_dir = os.getcwd()
+        LOGGER.debug(f'--paths is missing. Set --path as current directory "{cur_dir}".')
+        args.paths = [cur_dir]
 
     if not args.target:
-        raise InvalidCommand(
-            'Must specify current build target with CLI option "-t <target>" or "--target <target>". '
-            '(choices: [{}]'.format(','.join([*ALL_TARGETS, 'all']))
-        )
+        LOGGER.debug('--target is missing. Set --target as "all".')
+        args.target = 'all'
 
     default_build_targets = []
     if args.default_build_targets:
         for target in args.default_build_targets:
             if target not in ALL_TARGETS:
-                raise InvalidCommand(
-                    f'Unrecognizable target {target} specified with "--default-build-targets". '
+                LOGGER.warning(
+                    f'Ignoring... Unrecognizable target {target} specified with "--default-build-targets". '
                     f'Current ESP-IDF available targets: {ALL_TARGETS}'
                 )
-
-            if target not in default_build_targets:
+            elif target not in default_build_targets:
                 default_build_targets.append(target)
-    args.default_build_targets = default_build_targets
+        args.default_build_targets = default_build_targets
+    elif args.enable_preview_targets:
+        args.default_build_targets = deepcopy(ALL_TARGETS)
 
     if args.ignore_app_dependencies_components is not None:
         if args.modified_components is None:
@@ -796,36 +821,49 @@ def main():
     if args.action == 'build':
         args.output = None  # build action doesn't support output option
 
+    kwargs = {
+        'build_system': args.build_system,
+        'recursive': args.recursive,
+        'exclude_list': args.exclude or [],
+        'work_dir': args.work_dir,
+        'build_dir': args.build_dir or 'build',
+        'config_rules_str': args.config,
+        'build_log_filename': args.build_log,
+        'size_json_filename': args.size_file,
+        'check_warnings': args.check_warnings,
+        'manifest_rootpath': args.manifest_rootpath,
+        'manifest_files': args.manifest_file,
+        'check_manifest_rules': args.check_manifest_rules,
+        'default_build_targets': args.default_build_targets,
+        'modified_components': args.modified_components,
+        'modified_files': args.modified_files,
+        'ignore_app_dependencies_components': args.ignore_app_dependencies_components,
+        'ignore_app_dependencies_filepatterns': args.ignore_app_dependencies_filepatterns,
+        'sdkconfig_defaults': args.sdkconfig_defaults,
+    }
+    # only useful in find
+    if args.action == 'find' and args.include_all_apps:
+        kwargs['include_skipped_apps'] = True
+        kwargs['include_disabled_apps'] = True
+
     # real call starts here
-    apps = find_apps(
-        args.paths,
-        args.target,
-        build_system=args.build_system,
-        recursive=args.recursive,
-        exclude_list=args.exclude or [],
-        work_dir=args.work_dir,
-        build_dir=args.build_dir or 'build',
-        config_rules_str=args.config,
-        build_log_filename=args.build_log,
-        size_json_filename=args.size_file,
-        check_warnings=args.check_warnings,
-        manifest_rootpath=args.manifest_rootpath,
-        manifest_files=args.manifest_file,
-        check_manifest_rules=args.check_manifest_rules,
-        default_build_targets=args.default_build_targets,
-        modified_components=args.modified_components,
-        modified_files=args.modified_files,
-        ignore_app_dependencies_components=args.ignore_app_dependencies_components,
-        ignore_app_dependencies_filepatterns=args.ignore_app_dependencies_filepatterns,
-        sdkconfig_defaults=args.sdkconfig_defaults,
-    )
+    apps = find_apps(args.paths, args.target, **kwargs)
 
     if args.action == 'find':
         if args.output:
             os.makedirs(os.path.dirname(os.path.realpath(args.output)), exist_ok=True)
+            if args.output.endswith('.json'):
+                LOGGER.info('Detecting output file ends with ".json", writing json file.')
+                args.output_format = 'json'
+
             with open(args.output, 'w') as fw:
-                for app in apps:
-                    fw.write(app.to_json() + '\n')
+                if args.output_format == 'raw':
+                    for app in apps:
+                        fw.write(app.to_json() + '\n')
+                elif args.output_format == 'json':
+                    fw.write(json.dumps([app.model_dump() for app in apps], indent=2))
+                else:
+                    raise ValueError(f'Output format {args.output_format} is not supported.')
         else:
             for app in apps:
                 print(app)

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.3}/idf_build_apps/manifest/soc_header.py

@@ -94,20 +94,24 @@ class SocHeader(dict):
 
     @classmethod
     def _parse_soc_header(cls, target: str) -> t.Dict[str, t.Any]:
-        soc_headers_dirs = cls._get_dirs_from_candidates([
-            # master c5 mp
-            os.path.abspath(os.path.join(IDF_PATH, 'components', 'soc', target, 'mp', 'include', 'soc')),
-            # other branches
-            os.path.abspath(os.path.join(IDF_PATH, 'components', 'soc', target, 'include', 'soc')),
-            # release/v4.2
-            os.path.abspath(os.path.join(IDF_PATH, 'components', 'soc', 'soc', target, 'include', 'soc')),
-        ])
-        esp_rom_headers_dirs = cls._get_dirs_from_candidates([
-            # master c5 mp
-            os.path.abspath(os.path.join(IDF_PATH, 'components', 'esp_rom', target, 'mp', target)),
-            # others
-            os.path.abspath(os.path.join(IDF_PATH, 'components', 'esp_rom', target)),
-        ])
+        soc_headers_dirs = cls._get_dirs_from_candidates(
+            [
+                # master c5 mp
+                os.path.abspath(os.path.join(IDF_PATH, 'components', 'soc', target, 'mp', 'include', 'soc')),
+                # other branches
+                os.path.abspath(os.path.join(IDF_PATH, 'components', 'soc', target, 'include', 'soc')),
+                # release/v4.2
+                os.path.abspath(os.path.join(IDF_PATH, 'components', 'soc', 'soc', target, 'include', 'soc')),
+            ]
+        )
+        esp_rom_headers_dirs = cls._get_dirs_from_candidates(
+            [
+                # master c5 mp
+                os.path.abspath(os.path.join(IDF_PATH, 'components', 'esp_rom', target, 'mp', target)),
+                # others
+                os.path.abspath(os.path.join(IDF_PATH, 'components', 'esp_rom', target)),
+            ]
+        )
 
         header_files: t.List[str] = []
         for d in [*soc_headers_dirs, *esp_rom_headers_dirs]:

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.3}/pyproject.toml

@@ -61,7 +61,7 @@ idf-build-apps = "idf_build_apps:main.main"
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "2.4.1.dev0"
+version = "2.4.3"
 tag_format = "v$version"
 version_files = [
     "idf_build_apps/__init__.py",
@@ -77,10 +77,6 @@ testpaths = [
 profile = 'black'
 force_grid_wrap = 1
 
-[tool.black]
-line-length = 120
-skip-string-normalization = true
-
 [tool.ruff]
 line-length = 120
 target-version = "py37"

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.3}/setup.py

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

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.3}/tests/test_build.py

@@ -112,7 +112,11 @@ class TestBuild:
         apps = [
             CMakeApp(test_dir, 'esp32', build_dir='build_1'),
             CMakeApp(test_dir, 'esp32', build_dir='build_2'),
+            CMakeApp(test_dir, 'esp32', build_dir='build_3'),
+            CMakeApp(test_dir, 'esp32', build_dir='build_4'),
         ]
+        apps[2].build_status = BuildStatus.DISABLED
+        apps[3].build_status = BuildStatus.SKIPPED
 
         build_apps(deepcopy(apps), dry_run=True, junitxml=str(tmpdir / 'test.xml'))
 
@@ -123,13 +127,20 @@ class TestBuild:
         assert test_suite.attrib['tests'] == '0'
         assert test_suite.attrib['failures'] == '0'
         assert test_suite.attrib['errors'] == '0'
-        assert test_suite.attrib['skipped'] == '2'
+        assert test_suite.attrib['skipped'] == '4'
 
         for i, testcase in enumerate(test_suite.findall('testcase')):
             assert testcase.attrib['name'] == apps[i].build_path
             assert float(testcase.attrib['time']) > 0
             assert testcase.find('skipped') is not None
-            assert testcase.find('skipped').attrib['message'] == 'dry run'
+            if i in (0, 1):
+                assert testcase.find('skipped').attrib['message'] == 'dry run'
+            elif i == 2:
+                assert testcase.find('skipped').attrib['message'] == 'Build disabled. Skipping...'
+            elif i == 3:
+                assert testcase.find('skipped').attrib['message'] == 'Build skipped. Skipping...'
+            else:
+                assert False  # not expected
 
         build_apps(deepcopy(apps), junitxml=str(tmpdir / 'test.xml'))
 
@@ -140,14 +151,21 @@ class TestBuild:
         assert test_suite.attrib['tests'] == '2'
         assert test_suite.attrib['failures'] == '0'
         assert test_suite.attrib['errors'] == '0'
-        assert test_suite.attrib['skipped'] == '0'
+        assert test_suite.attrib['skipped'] == '2'
 
         for i, testcase in enumerate(test_suite.findall('testcase')):
-            assert testcase.attrib['name'] == apps[i].build_path
             assert float(testcase.attrib['time']) > 0
-            assert testcase.find('skipped') is None
+            assert testcase.attrib['name'] == apps[i].build_path
             assert testcase.find('error') is None
             assert testcase.find('failure') is None
+            if i in (0, 1):
+                assert testcase.find('skipped') is None
+            elif i == 2:
+                assert testcase.find('skipped').attrib['message'] == 'Build disabled. Skipping...'
+            elif i == 3:
+                assert testcase.find('skipped').attrib['message'] == 'Build skipped. Skipping...'
+            else:
+                assert False  # not expected
 
     def test_work_dir_inside_relative_app_dir(self, tmp_path):
         create_project('foo', tmp_path)

{idf_build_apps-2.4.1.dev0 → idf_build_apps-2.4.3}/tests/test_finder.py

@@ -109,6 +109,33 @@ examples/get-started:
             == apps
         )
 
+    def test_include_disabled_apps(self, tmpdir):
+        test_dir = Path(IDF_PATH) / 'examples' / 'get-started'
+        yaml_file = tmpdir / 'test.yml'
+        yaml_file.write_text(
+            f"""
+        {test_dir}:
+            enable:
+                - if: IDF_TARGET == "esp32s2"
+        """,
+            encoding='utf8',
+        )
+
+        test_dir = Path(IDF_PATH) / 'examples' / 'get-started'
+        apps = find_apps(
+            str(test_dir), 'esp32', recursive=True, manifest_files=str(yaml_file), include_disabled_apps=False
+        )
+        assert not apps
+
+        apps = find_apps(
+            str(test_dir), 'esp32', recursive=True, manifest_files=str(yaml_file), include_disabled_apps=True
+        )
+        assert apps
+        for app in apps:
+            assert app.build_status == BuildStatus.DISABLED
+            app.build()
+            assert app.build_comment == 'Build disabled. Skipping...'
+
 
 class TestFindWithModifiedFilesComponents:
     @pytest.mark.parametrize(