idf_build_apps 0.6.1__tar.gz → 1.0.0.dev0__tar.gz

{idf-build-apps-0.6.1 → idf_build_apps-1.0.0.dev0}/CHANGELOG.md

@@ -2,6 +2,33 @@
 
 All notable changes to this project will be documented in this file.
 
+## [Unreleased - 1.0.0]
+
+## Added
+
+- Support keyword `depends_filepatterns` in the manfiest file
+
+## BREAKING CHANGES
+
+- Renames
+  - Members
+    - `App.requires_components` renamed to `App.depends_components`
+    - `FolderRule.requires_components` renamed to `FolderRule.depends_components`
+    - `Manifest.requires_components()` renamed to `Manifest.depends_components()`
+  - Parameters
+    - `App.build()` parameter `depends_on_components` renamed to `modified_components`
+    - `App.is_modified()` parameter `depends_on_components` renamed to `modified_components`
+    - `find_apps()`  parameter `depends_on_components` renamed to `modified_components`
+    - `find_apps()`  parameter `depends_on_files` renamed to `modified_files`
+    - `build_apps()`  parameter `depends_on_components` renamed to `modified_components`
+    - `build_apps()`  parameter `depends_on_files` renamed to `modified_files`
+  - CLI Options
+    - `--depends-on-components` renamed to `--modified-components`
+    - `--depends-on-files` renamed to `--modified-files`
+- Reorder Parameters
+  - `find_apps()`
+  - `build_apps()`
+
 ## [0.6.1] (2023-05-10)
 
 ### Fixed

{idf-build-apps-0.6.1 → idf_build_apps-1.0.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: idf-build-apps
-Version: 0.6.1
+Version: 1.0.0.dev0
 Summary: Tools for building ESP-IDF related apps.
 Author-email: Fu Hanxi <fuhanxi@espressif.com>
 Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*

{idf-build-apps-0.6.1 → idf_build_apps-1.0.0.dev0}/idf_build_apps/__init__.py

@@ -7,7 +7,7 @@ Tools for building ESP-IDF related apps.
 
 import logging
 
-__version__ = '0.6.1'
+__version__ = '1.0.0.dev0'
 
 LOGGER = logging.getLogger('idf_build_apps')
 

{idf-build-apps-0.6.1 → idf_build_apps-1.0.0.dev0}/idf_build_apps/app.py

@@ -40,6 +40,7 @@ from .utils import (
     find_first_match,
     rmdir,
     subprocess_run,
+    to_absolute_path,
     to_list,
 )
 
@@ -126,6 +127,13 @@ class App(object):
             self.build_path,
         )
 
+    def __str__(self):
+        return 'App {}, target {}, sdkconfig {}'.format(
+            self.app_dir,
+            self.target,
+            self.sdkconfig_path or '(default)',
+        )
+
     def __lt__(self, other):
         if self.app_dir != other.app_dir:
             return self.app_dir < other.app_dir
@@ -346,9 +354,16 @@ class App(object):
         return [os.path.realpath(file) for file in self._sdkconfig_files]
 
     @property
-    def requires_components(self):  # type: () -> list[str]
+    def depends_components(self):  # type: () -> list[str]
         if self.MANIFEST:
-            return self.MANIFEST.requires_components(self.app_dir)
+            return self.MANIFEST.depends_components(self.app_dir)
+
+        return []
+
+    @property
+    def depends_filepatterns(self):  # type: () -> list[str]
+        if self.MANIFEST:
+            return self.MANIFEST.depends_filepatterns(self.app_dir)
 
         return []
 
@@ -376,8 +391,9 @@ class App(object):
     @abstractmethod
     def build(
         self,
-        depends_on_components=None,  # type: list[str] | str | None
+        modified_components=None,  # type: list[str] | str | None
         check_component_dependencies=False,  # type: bool
+        is_modified=False,  # type: bool
     ):  # type: (...) -> bool
         pass
 
@@ -440,6 +456,19 @@ class App(object):
     def is_app(cls, path):  # type: (str) -> bool
         raise NotImplementedError('Please implement this function in sub classes')
 
+    def is_modified(self, modified_files):  # type: (list[str] | None) -> bool
+        _app_dir_fullpath = to_absolute_path(self.app_dir)
+        if modified_files:
+            for f in modified_files:
+                _f_fullpath = to_absolute_path(f)
+                if _f_fullpath.parts[-1].endswith('.md'):
+                    continue
+
+                if _app_dir_fullpath in _f_fullpath.parents:
+                    return True
+
+        return False
+
 
 class CMakeApp(App):
     BUILD_SYSTEM = 'cmake'
@@ -464,8 +493,9 @@ class CMakeApp(App):
 
     def build(
         self,
-        depends_on_components=None,  # type: list[str] | str | None
+        modified_components=None,  # type: list[str] | str | None
         check_component_dependencies=False,  # type: bool
+        is_modified=False,  # type: bool
     ):  # type: (...) -> bool
         LOGGER.debug('=> Preparing...')
         if self.work_dir != self.app_dir:
@@ -524,8 +554,8 @@ class CMakeApp(App):
             '-DSDKCONFIG_DEFAULTS={}'.format(';'.join(self.sdkconfig_files) if self.sdkconfig_files else ';'),
         ]
 
-        depends_on_components = to_list(depends_on_components)
-        if depends_on_components is not None and check_component_dependencies:
+        modified_components = to_list(modified_components)
+        if modified_components is not None and check_component_dependencies and not is_modified:
             subprocess_run(
                 common_args + ['reconfigure'],
                 log_terminal=False if self.build_log_path else True,
@@ -537,12 +567,12 @@ class CMakeApp(App):
             with open(os.path.join(self.build_path, PROJECT_DESCRIPTION_JSON)) as fr:
                 build_components = set(item for item in json.load(fr)['build_components'] if item)
 
-            if not set(depends_on_components).intersection(set(build_components)):
+            if not set(modified_components).intersection(set(build_components)):
                 LOGGER.info(
-                    '=> Skip building... app %s depends on components: %s, while current build based on component dependencies: %s',
+                    '=> Skip building... app %s depends components: %s, while current build modified components: %s',
                     self.app_dir,
                     build_components,
-                    depends_on_components,
+                    modified_components,
                 )
                 return False
 

{idf-build-apps-0.6.1 → idf_build_apps-1.0.0.dev0}/idf_build_apps/config.py

@@ -6,6 +6,10 @@ from pathlib import (
     Path,
 )
 
+from idf_build_apps.utils import (
+    to_absolute_path,
+)
+
 
 class InvalidTomlError(SystemExit):
     def __init__(self, filepath, msg):  # type: (str | Path, str) -> None
@@ -60,12 +64,12 @@ def _get_config_from_path(dirpath):  # type: (Path) -> (dict | None, Path)
 
 
 def get_valid_config(starts_from=os.getcwd(), custom_path=None):  # type: (str, str | None) -> dict | None
-    root_dir = Path('/').resolve()
-    cur_dir = Path(os.path.expanduser(starts_from)).resolve()
+    root_dir = to_absolute_path('/')
+    cur_dir = to_absolute_path(starts_from)
 
     config = None
     if custom_path and os.path.isfile(custom_path):
-        config, filepath = _get_config_from_file(Path(os.path.expanduser(custom_path)).resolve())
+        config, filepath = _get_config_from_file(to_absolute_path(custom_path))
         if config is not None:
             # use print here since the verbose settings may be set in the config file
             print('Using custom config file: {}'.format(filepath))

{idf-build-apps-0.6.1 → idf_build_apps-1.0.0.dev0}/idf_build_apps/finder.py

@@ -16,6 +16,7 @@ from .app import (
 )
 from .utils import (
     config_rules_from_str,
+    files_matches_patterns,
     to_list,
 )
 
@@ -31,24 +32,40 @@ def _get_apps_from_path(
     size_json_path=None,  # type: str | None
     check_warnings=False,  # type: bool
     preserve=True,  # type: bool
-    depends_on_components=None,  # type: list[str] | str | None
+    manifest_rootpath=None,  # type: str | None
+    modified_components=None,  # type: list[str] | str | None
+    modified_files=None,  # type: list[str] | str | None,
     check_component_dependencies=False,  # type: bool
     sdkconfig_defaults_str=None,  # type: str | None
 ):  # type: (...) -> list[App]
-    depends_on_components = to_list(depends_on_components)
+    modified_components = to_list(modified_components)
+    modified_files = to_list(modified_files)
 
     def _validate_app(_app):  # type: (App) -> bool
         if target not in _app.supported_targets:
             LOGGER.debug('=> Skipping. %s only supports targets: %s', _app, ', '.join(_app.supported_targets))
             return False
 
-        if _app.requires_components and check_component_dependencies:
-            if not set(_app.requires_components).intersection(set(depends_on_components)):
+        if _app.is_modified(modified_files):
+            return True
+
+        if _app.depends_components and check_component_dependencies:
+            if not set(_app.depends_components).intersection(set(modified_components)):
+                LOGGER.debug(
+                    '=> Skipping. %s requires components: %s, but you passed "--modified-components %s"',
+                    _app,
+                    ', '.join(_app.depends_components),
+                    ', '.join(modified_components),
+                )
+                return False
+
+        if _app.depends_filepatterns and check_component_dependencies:
+            if not files_matches_patterns(modified_files, _app.depends_filepatterns, manifest_rootpath):
                 LOGGER.debug(
-                    '=> Skipping. %s requires components: %s, but you passed "--depends-on-components %s"',
+                    '=> Skipping. %s depends on file patterns: %s, but you passed "--modified-files %s"',
                     _app,
-                    ', '.join(_app.requires_components),
-                    ', '.join(depends_on_components),
+                    ', '.join(_app.depends_filepatterns),
+                    ', '.join(modified_files),
                 )
                 return False
 

{idf-build-apps-0.6.1 → idf_build_apps-1.0.0.dev0}/idf_build_apps/main.py

@@ -41,6 +41,7 @@ from .utils import (
     InvalidCommand,
     files_matches_patterns,
     get_parallel_start_stop,
+    to_absolute_path,
     to_list,
 )
 
@@ -50,6 +51,32 @@ except ImportError:
     pass
 
 
+def _check_components_dependency(
+    manifest_rootpath,  # type: str
+    modified_components,  # type: list[str] | None
+    modified_files,  # type: list[str] | None
+    ignore_component_dependencies_file_patterns,  # type: list[str] | None
+):  # type: (...) -> bool
+    # not check since `--modified-components` is not passed
+    if modified_components is None and modified_files is None:
+        return False
+
+    # not check since `--ignore-component-dependency-file-pattern` is passed and matched
+    if (
+        ignore_component_dependencies_file_patterns
+        and modified_files
+        and files_matches_patterns(modified_files, ignore_component_dependencies_file_patterns, manifest_rootpath)
+    ):
+        LOGGER.debug(
+            'Skipping check component dependencies for apps since files %s matches patterns: %s',
+            ', '.join(modified_files),
+            ', '.join(ignore_component_dependencies_file_patterns),
+        )
+        return False
+
+    return True
+
+
 def find_apps(
     paths,  # type: list[str] | str
     target,  # type: str
@@ -63,12 +90,12 @@ def find_apps(
     size_json_path=None,  # type: str | None
     check_warnings=False,  # type: bool
     preserve=True,  # type: bool
+    manifest_rootpath=None,  # type: str | None
     manifest_files=None,  # type: list[str] | str | None
     default_build_targets=None,  # type: list[str] | str | None
-    depends_on_components=None,  # type: list[str] | str | None
-    manifest_rootpath=None,  # type: str | None
+    modified_components=None,  # type: list[str] | str | None
+    modified_files=None,  # type: list[str] | str | None
     ignore_component_dependencies_file_patterns=None,  # type: list[str] | str | None
-    depends_on_files=None,  # type: list[str] | str | None
     sdkconfig_defaults=None,  # type: str | None
 ):  # type: (...) -> list[App]
     """
@@ -101,22 +128,20 @@ def find_apps(
     :type check_warnings: bool
     :param preserve: Preserve the built binaries or not
     :type preserve: bool
+    :param manifest_rootpath: The root path of the manifest files. Usually the folders specified in the manifest files
+        are relative paths. Use the current directory if not specified
+    :type manifest_rootpath: str | None
     :param manifest_files: paths of the manifest files
     :type manifest_files: list[str] | str | None
     :param default_build_targets: default build targets used in manifest files
     :type default_build_targets: list[str] | str | None
-    :param depends_on_components: app with ``requires_components`` set in the corresponding manifest files will only
-        be built if it depends on any of the specified components
-    :type depends_on_components: list[str] | str | None
-    :param manifest_rootpath: The root path of the manifest files. Usually the folders specified in the manifest files
-        are relative paths. Use the current directory if not specified
-    :type manifest_rootpath: str | None
-    :param ignore_component_dependencies_file_patterns: file patterns that use to ignore checking the component
+    :param modified_components: modified components
+    :type modified_components: list[str] | str | None
+    :param modified_files: modified files
+    :type modified_files: list[str] | str | None
+    :param ignore_component_dependencies_file_patterns: file patterns that used for ignoring checking the component
         dependencies
     :type ignore_component_dependencies_file_patterns: list[str] | str | None
-    :param depends_on_files: skip check app's component dependencies if any of the specified files matches
-        ``ignore_component_dependencies_file_patterns``
-    :type depends_on_files: list[str] | str | None
     :param sdkconfig_defaults: semicolon-separated string, pass to idf.py -DSDKCONFIG_DEFAULTS if specified,
         also could be set via environment variables "SDKCONFIG_DEFAULTS"
     :type sdkconfig_defaults: str | None
@@ -129,7 +154,7 @@ def find_apps(
         FolderRule.DEFAULT_BUILD_TARGETS = default_build_targets
 
     # always set the manifest rootpath at the very beginning of find_apps in case ESP-IDF switches the branch.
-    Manifest.ROOTPATH = Path(manifest_rootpath or os.curdir).resolve()
+    Manifest.ROOTPATH = to_absolute_path(manifest_rootpath or os.curdir)
 
     if manifest_files:
         rules = set()
@@ -139,22 +164,9 @@ def find_apps(
         manifest = Manifest(rules)
         App.MANIFEST = manifest
 
-    depends_on_components = to_list(depends_on_components)
-    if depends_on_components is None:
-        check_component_dependencies = False
-    elif (
-        ignore_component_dependencies_file_patterns
-        and depends_on_files
-        and files_matches_patterns(depends_on_files, ignore_component_dependencies_file_patterns)
-    ):
-        LOGGER.debug(
-            'Skipping check component dependencies for apps since files %s matches patterns: %s',
-            ', '.join(depends_on_files),
-            ', '.join(ignore_component_dependencies_file_patterns),
-        )
-        check_component_dependencies = False
-    else:
-        check_component_dependencies = True
+    modified_components = to_list(modified_components)
+    modified_files = to_list(modified_files)
+    ignore_component_dependencies_file_patterns = to_list(ignore_component_dependencies_file_patterns)
 
     apps = []
     if target == 'all':
@@ -178,8 +190,15 @@ def find_apps(
                     size_json_path=size_json_path,
                     check_warnings=check_warnings,
                     preserve=preserve,
-                    depends_on_components=depends_on_components,
-                    check_component_dependencies=check_component_dependencies,
+                    manifest_rootpath=manifest_rootpath,
+                    modified_components=modified_components,
+                    modified_files=modified_files,
+                    check_component_dependencies=_check_components_dependency(
+                        manifest_rootpath,
+                        modified_components,
+                        modified_files,
+                        ignore_component_dependencies_file_patterns,
+                    ),
                     sdkconfig_defaults_str=sdkconfig_defaults,
                 )
             )
@@ -201,10 +220,10 @@ def build_apps(
     ignore_warning_strs=None,  # type: list[str] | None
     ignore_warning_file=None,  # type: t.TextIO | None
     copy_sdkconfig=False,  # type: bool
-    depends_on_components=None,  # type: list[str] | str | None
     manifest_rootpath=None,  # type: str | None
+    modified_components=None,  # type: list[str] | str | None
+    modified_files=None,  # type: list[str] | str | None
     ignore_component_dependencies_file_patterns=None,  # type: list[str] | str | None
-    depends_on_files=None,  # type: list[str] | str | None
 ):  # type: (...) -> (int, list[App]) | int
     """
     Build all the specified apps
@@ -232,24 +251,25 @@ def build_apps(
     :type ignore_warning_file: list[str] | None
     :param copy_sdkconfig: copy the sdkconfig file to the build directory or not
     :type copy_sdkconfig: bool
-    :param depends_on_components: app with ``requires_components`` set in the corresponding manifest files would only be
-        built if it depends on any of the specified components
-    :type depends_on_components: list[str] | str | None
     :param manifest_rootpath: The root path of the manifest files. Usually the folders specified in the manifest files
         are relative paths. Use the current directory if not specified
     :type manifest_rootpath: str | None
-    :param ignore_component_dependencies_file_patterns: file patterns that use to ignore checking the component
+    :param modified_components: modified components
+    :type modified_components: list[str] | str | None
+    :param modified_files: modified files
+    :type modified_files: list[str] | str | None
+    :param ignore_component_dependencies_file_patterns: file patterns that used for ignoring checking the component
         dependencies
     :type ignore_component_dependencies_file_patterns: list[str] | str | None
-    :param depends_on_files: skip check app's component dependencies if any of the specified files matches
-        ``ignore_component_dependencies_file_patterns``
-    :type depends_on_files: list[str] | str | None
-    :return: exit_code, built_apps if specified ``depends_on_components``
+    :return: (exit_code, built_apps) if specified ``modified_components``
     :rtype: int, list[App]
-    :return: exit_code if not specified ``depends_on_components``
+    :return: exit_code if not specified ``modified_components``
     :rtype: int
     """
     apps = to_list(apps)  # type: list[App]
+    modified_components = to_list(modified_components)
+    modified_files = to_list(modified_files)
+    ignore_component_dependencies_file_patterns = to_list(ignore_component_dependencies_file_patterns)
 
     ignore_warnings_regexes = []
     if ignore_warning_strs:
@@ -260,26 +280,6 @@ def build_apps(
             ignore_warnings_regexes.append(re.compile(s.strip()))
     App.IGNORE_WARNS_REGEXES = ignore_warnings_regexes
 
-    depends_on_components = to_list(depends_on_components)
-    # here depends_on_components [''] means that the user use --depends-on-components
-    # the ones with `requires_components` are already been filtered out
-    # if we skip all build, that would be too aggressive
-    if depends_on_components is None or depends_on_components == ['']:
-        check_component_dependencies = False
-    elif (
-        ignore_component_dependencies_file_patterns
-        and depends_on_files
-        and files_matches_patterns(depends_on_files, ignore_component_dependencies_file_patterns, manifest_rootpath)
-    ):
-        LOGGER.debug(
-            'Skipping check component dependencies for apps since files %s matches patterns: %s',
-            ', '.join(depends_on_files),
-            ', '.join(ignore_component_dependencies_file_patterns),
-        )
-        check_component_dependencies = False
-    else:
-        check_component_dependencies = True
-
     start, stop = get_parallel_start_stop(len(apps), parallel_count, parallel_index)
     LOGGER.info('Total %s apps. running build for app %s-%s', len(apps), start, stop)
 
@@ -332,6 +332,8 @@ def build_apps(
         Path(f).touch()
 
     actual_built_apps = []
+    built_apps = []  # type: list[App]
+    skipped_apps = []  # type: list[App]
     for i, app in enumerate(apps):
         index = i + 1  # we use 1-based
         if index < start or index > stop:
@@ -346,8 +348,11 @@ def build_apps(
         is_built = False
         try:
             is_built = app.build(
-                depends_on_components=depends_on_components,
-                check_component_dependencies=check_component_dependencies,
+                modified_components=modified_components,
+                check_component_dependencies=_check_components_dependency(
+                    manifest_rootpath, modified_components, modified_files, ignore_component_dependencies_file_patterns
+                ),
+                is_modified=app.is_modified(modified_files),
             )
         except BuildError as e:
             LOGGER.error(str(e))
@@ -355,11 +360,16 @@ def build_apps(
                 failed_apps.append(app)
                 exit_code = 1
             else:
-                if depends_on_components is not None:
+                if modified_components is not None:
                     return 1, actual_built_apps
                 else:
                     return 1
         finally:
+            if is_built:
+                built_apps.append(app)
+            else:
+                skipped_apps.append(app)
+
             if is_built:
                 actual_built_apps.append(app)
 
@@ -405,12 +415,22 @@ def build_apps(
 
             LOGGER.info('')  # add one empty line for separating different builds
 
+    if built_apps:
+        LOGGER.info('Built the following apps:')
+        for app in built_apps:
+            LOGGER.info('  %s', app)
+
+    if skipped_apps:
+        LOGGER.info('Skipped the following apps:')
+        for app in skipped_apps:
+            LOGGER.info('  %s', app)
+
     if failed_apps:
         LOGGER.error('Build failed for the following apps:')
         for app in failed_apps:
             LOGGER.error('  %s', app)
 
-    if depends_on_components is not None:
+    if modified_components is not None:
         return exit_code, actual_built_apps
     else:
         return exit_code
@@ -575,28 +595,31 @@ def get_parser():  # type: () -> argparse.ArgumentParser
         ),
     )
     common_args.add_argument(
-        '--depends-on-components',
+        '--modified-components',
         nargs='*',
         default=None,
-        help='space-separated components list, app with `requires_components` set in the corresponding manifest files '
-        'would only be built if depends on any of the specified components',
+        help='space-separated list which specifies the modified components. app with `depends_components` set in the '
+        'corresponding manifest files would only be built if depends on any of the specified components.',
     )
     common_args.add_argument(
-        '-if',
-        '--ignore-component-dependencies-file-patterns',
+        '--modified-files',
         nargs='*',
         default=None,
-        help='ignore component dependencies when changed files matches any of the specified file patterns. must used '
-        'with --depends-on-files',
+        help='space-separated list which specifies the modified files. app with `depends_filepatterns` set in the '
+        'corresponding manifest files would only be built if any of the specified file pattern matches any of the '
+        'specified modified files.',
     )
     common_args.add_argument(
-        '--depends-on-files',
+        '-if',
+        '--ignore-component-dependencies-file-patterns',
         nargs='*',
         default=None,
-        help='space-separated file pattern list, the `requires_components` set in the manifest files will be '
-        'ignored when specified files match any of the specified file patterns defined with '
-        '--ignore-component-dependencies-file-patterns. Must used with --ignore-component-dependencies-file-patterns',
+        help='space-separated list which specifies the file patterns used for ignoring the component dependencies. '
+        'The `depends_components` and `depends_filepatterns` set in the manifest files will be ignored when any of '
+        'the specified file patterns matches any of the modified files. Must be used together with '
+        '--modified-files',
     )
+
     common_args.add_argument(
         '--no-color',
         action='store_true',
@@ -701,11 +724,11 @@ def validate_args(parser, args):  # type: (argparse.ArgumentParser, argparse.Nam
 
     args.default_build_targets = default_build_targets
 
-    if (args.ignore_component_dependencies_file_patterns is None) != (args.depends_on_files is None):
-        raise InvalidCommand(
-            'Must specify both "--ignore-component-dependencies-file-patterns" and "--depends-on-files" '
-            'or neither of them'
-        )
+    if args.ignore_component_dependencies_file_patterns:
+        if args.modified_files is None:
+            raise InvalidCommand(
+                'Must specify "--ignore-component-dependencies-file-patterns" with "--modified-files", '
+            )
 
 
 def apply_config_args(args):  # type: (argparse.Namespace) -> None
@@ -738,12 +761,12 @@ def main():
         build_log_path=args.build_log,
         size_json_path=args.size_file,
         check_warnings=args.check_warnings,
+        manifest_rootpath=args.manifest_rootpath,
         manifest_files=args.manifest_file,
         default_build_targets=args.default_build_targets,
-        depends_on_components=args.depends_on_components,
-        manifest_rootpath=args.manifest_rootpath,
+        modified_components=args.modified_components,
+        modified_files=args.modified_files,
         ignore_component_dependencies_file_patterns=args.ignore_component_dependencies_file_patterns,
-        depends_on_files=args.depends_on_files,
         sdkconfig_defaults=args.sdkconfig_defaults,
     )
 
@@ -774,13 +797,13 @@ def main():
         ignore_warning_strs=args.ignore_warning_str,
         ignore_warning_file=args.ignore_warning_file,
         copy_sdkconfig=args.copy_sdkconfig,
-        depends_on_components=args.depends_on_components,
         manifest_rootpath=args.manifest_rootpath,
+        modified_components=args.modified_components,
+        modified_files=args.modified_files,
         ignore_component_dependencies_file_patterns=args.ignore_component_dependencies_file_patterns,
-        depends_on_files=args.depends_on_files,
     )
 
-    if args.depends_on_components is not None:
+    if args.modified_components is not None:
         sys.exit(res[0])
     else:
         sys.exit(res)

{idf-build-apps-0.6.1 → idf_build_apps-1.0.0.dev0}/idf_build_apps/manifest/manifest.py

@@ -43,7 +43,8 @@ class FolderRule:
         enable=None,  # type: list[dict[str, str]] | None
         disable=None,  # type: list[dict[str, str]] | None
         disable_test=None,  # type: list[dict[str, str]] | None
-        requires_components=None,  # type: list[str] | None
+        depends_components=None,  # type: list[str] | None
+        depends_filepatterns=None,  # type: list[str] | None
     ):  # type: (...) -> None
         self.folder = folder.resolve()
 
@@ -56,7 +57,8 @@ class FolderRule:
         self.enable = [IfClause(**clause) for clause in enable] if enable else []
         self.disable = [IfClause(**clause) for clause in disable] if disable else []
         self.disable_test = [IfClause(**clause) for clause in disable_test] if disable_test else []
-        self.requires_components = requires_components or []
+        self.depends_components = depends_components or []
+        self.depends_filepatterns = depends_filepatterns or []
 
     def __hash__(self):
         return hash(self.folder)
@@ -168,5 +170,8 @@ class Manifest:
     ):  # type: (str, str | None, str | None) -> list[str]
         return self._most_suitable_rule(folder).enable_test_targets(default_sdkconfig_target, config_name)
 
-    def requires_components(self, folder):  # type: (str) -> list[str]
-        return self._most_suitable_rule(folder).requires_components
+    def depends_components(self, folder):  # type: (str) -> list[str]
+        return self._most_suitable_rule(folder).depends_components
+
+    def depends_filepatterns(self, folder):  # type: (str) -> list[str]
+        return self._most_suitable_rule(folder).depends_filepatterns

{idf-build-apps-0.6.1 → idf_build_apps-1.0.0.dev0}/setup.py

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

{idf-build-apps-0.6.1 → idf_build_apps-1.0.0.dev0}/tests/conftest.py

@@ -17,7 +17,7 @@ def clean_cls_attr():
 
 @pytest.fixture(autouse=True)
 def setup_logging_debug():
-    setup_logging(2)
+    setup_logging(1)
 
 
 def create_project(name, folder):

{idf-build-apps-0.6.1 → idf_build_apps-1.0.0.dev0}/tests/test_build.py

@@ -24,7 +24,7 @@ class TestBuild:
         assert 'Project build complete.' in captured.out
 
     @pytest.mark.parametrize(
-        'depends_on_components, check_component_dependencies, assert_build_done',
+        'modified_components, check_component_dependencies, assert_build_done',
         [
             (None, True, True),
             ([], True, False),
@@ -36,13 +36,13 @@ class TestBuild:
             (['soc', 'fake'], True, True),
         ],
     )
-    def test_build_with_depends_on_components(
-        self, tmpdir, capsys, depends_on_components, check_component_dependencies, assert_build_done
+    def test_build_with_modified_components(
+        self, tmpdir, capsys, modified_components, check_component_dependencies, assert_build_done
     ):
         path = IDF_PATH / 'examples' / 'get-started' / 'hello_world'
 
         CMakeApp(str(path), 'esp32', work_dir=str(tmpdir / 'test')).build(
-            depends_on_components=depends_on_components,
+            modified_components=modified_components,
             check_component_dependencies=check_component_dependencies,
         )
 
@@ -53,6 +53,33 @@ class TestBuild:
         else:
             assert 'Project build complete.' not in captured.out
 
+    @pytest.mark.parametrize(
+        'modified_files, is_built',
+        [
+            ('/foo', False),
+            (str(IDF_PATH / 'examples' / 'README.md'), False),
+            ([str(IDF_PATH / 'examples' / 'get-started' / 'hello_world' / 'a.md')], False),
+            (
+                [
+                    str(IDF_PATH / 'examples' / 'get-started' / 'hello_world' / 'a.md'),
+                    str(IDF_PATH / 'examples' / 'get-started' / 'hello_world' / 'a.c'),
+                ],
+                True,
+            ),
+        ],
+    )
+    def test_build_with_modified_files(self, modified_files, is_built):
+        test_dir = str(IDF_PATH / 'examples' / 'get-started' / 'hello_world')
+
+        app = CMakeApp(test_dir, 'esp32')
+        built = app.build(
+            modified_components=[],
+            check_component_dependencies=True,
+            is_modified=app.is_modified(modified_files),
+        )
+
+        assert built == is_built
+
 
 @pytest.mark.skipif(not shutil.which('idf.py'), reason='idf.py not found')
 def test_idf_version_keywords_type():

{idf-build-apps-0.6.1 → idf_build_apps-1.0.0.dev0}/tests/test_finder.py

@@ -102,7 +102,7 @@ get-started:
         assert find_apps(str(test_dir), 'esp32', recursive=True, manifest_files=str(yaml_file)) == apps
 
     @pytest.mark.parametrize(
-        'depends_on_components, could_find_apps',
+        'modified_components, could_find_apps',
         [
             (None, True),
             ([], False),
@@ -111,7 +111,7 @@ get-started:
             (['soc', 'fake'], True),
         ],
     )
-    def test_with_requires_and_depends_on_components(self, tmpdir, depends_on_components, could_find_apps):
+    def test_with_requires_and_modified_components(self, tmpdir, modified_components, could_find_apps):
         test_dir = str(IDF_PATH / 'examples')
         apps = find_apps(test_dir, 'esp32', recursive=True)
         assert apps
@@ -120,7 +120,7 @@ get-started:
         yaml_file.write_text(
             f'''
 {test_dir}:
-    requires_components:
+    depends_components:
         - freertos
         - soc
 ''',
@@ -132,7 +132,95 @@ get-started:
             'esp32',
             recursive=True,
             manifest_files=yaml_file,
-            depends_on_components=depends_on_components,
+            modified_components=modified_components,
+        )
+        if could_find_apps:
+            assert filtered_apps == apps
+        else:
+            assert not filtered_apps
+
+    @pytest.mark.parametrize(
+        'modified_files, could_find_apps',
+        [
+            ('/foo', False),
+            (str(IDF_PATH / 'examples' / 'README.md'), False),
+            ([str(IDF_PATH / 'examples' / 'get-started' / 'hello_world' / 'a.md')], False),
+            (
+                [
+                    str(IDF_PATH / 'examples' / 'get-started' / 'hello_world' / 'a.md'),
+                    str(IDF_PATH / 'examples' / 'get-started' / 'hello_world' / 'a.c'),
+                ],
+                True,
+            ),
+        ],
+    )
+    def test_with_depends_components_but_modified(self, tmp_path, modified_files, could_find_apps):
+        test_dir = str(IDF_PATH / 'examples' / 'get-started' / 'hello_world')
+        apps = find_apps(test_dir, 'esp32', recursive=True)
+        assert apps
+
+        yaml_file = tmp_path / 'test.yml'
+        yaml_file.write_text(
+            f'''
+{test_dir}:
+    depends_components:
+        - soc
+''',
+            encoding='utf8',
+        )
+
+        filtered_apps = find_apps(
+            test_dir,
+            'esp32',
+            recursive=True,
+            manifest_files=yaml_file,
+            modified_components=[],
+            modified_files=modified_files,
+        )
+        if could_find_apps:
+            assert filtered_apps == apps
+        else:
+            assert not filtered_apps
+
+    @pytest.mark.parametrize(
+        'modified_files, could_find_apps',
+        [
+            ('/foo', True),
+            (str(IDF_PATH / 'examples' / 'README.md'), False),
+            ([str(IDF_PATH / 'examples' / 'get-started' / 'hello_world' / 'a.md')], True),
+            (
+                [
+                    str(IDF_PATH / 'examples' / 'get-started' / 'hello_world' / 'a.md'),
+                    str(IDF_PATH / 'examples' / 'get-started' / 'hello_world' / 'a.c'),
+                ],
+                True,
+            ),
+        ],
+    )
+    def test_with_depends_filepatterns(self, tmp_path, modified_files, could_find_apps):
+        test_dir = str(IDF_PATH / 'examples' / 'get-started' / 'hello_world')
+        apps = find_apps(test_dir, 'esp32', recursive=True)
+        assert apps
+
+        yaml_file = tmp_path / 'test.yml'
+        yaml_file.write_text(
+            f'''
+{test_dir}:
+    depends_filepatterns:
+        - /foo
+        - examples/get-started/hello_world/**
+        - examples/foo/**
+''',
+            encoding='utf8',
+        )
+
+        filtered_apps = find_apps(
+            test_dir,
+            'esp32',
+            recursive=True,
+            manifest_rootpath=str(IDF_PATH),
+            manifest_files=yaml_file,
+            modified_files=modified_files,
         )
         if could_find_apps:
             assert filtered_apps == apps