idf_build_apps 1.0.0.dev0__tar.gz → 1.0.0.dev1__tar.gz

{idf_build_apps-1.0.0.dev0 → idf_build_apps-1.0.0.dev1}/CHANGELOG.md

@@ -6,28 +6,23 @@ All notable changes to this project will be documented in this file.
 
 ## Added
 
-- Support keyword `depends_filepatterns` in the manfiest file
+- Support keyword `depends_filepatterns` in the manifest 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
+- Attributes Renamed
+  - `App.requires_components` renamed to `App.depends_components`
+  - `FolderRule.requires_components` renamed to `FolderRule.depends_components`
+- Functions Renamed
+  - `Manifest.requires_components()` renamed to `Manifest.depends_components()`
+- Signatures Changed
+  - `App.build()`
+  - `App.is_modified()`
   - `find_apps()`
   - `build_apps()`
+- CLI Options Renamed
+  - `--depends-on-components` renamed to `--modified-components`
+  - `--depends-on-files` renamed to `--modified-files`
 
 ## [0.6.1] (2023-05-10)
 

{idf_build_apps-1.0.0.dev0 → idf_build_apps-1.0.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: idf-build-apps
-Version: 1.0.0.dev0
+Version: 1.0.0.dev1
 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-1.0.0.dev0 → idf_build_apps-1.0.0.dev1}/idf_build_apps/__init__.py

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

{idf_build_apps-1.0.0.dev0 → idf_build_apps-1.0.0.dev1}/idf_build_apps/app.py

@@ -37,6 +37,7 @@ from .manifest.manifest import (
 )
 from .utils import (
     BuildError,
+    files_matches_patterns,
     find_first_match,
     rmdir,
     subprocess_run,
@@ -50,6 +51,12 @@ except ImportError:
     pass
 
 
+class BuildOrNot:
+    YES = 'yes'
+    NO = 'no'
+    UNKNOWN = 'unknown'
+
+
 class App(object):
     TARGET_PLACEHOLDER = '@t'  # replace it with self.target
     WILDCARD_PLACEHOLDER = '@w'  # replace it with the wildcard, usually the sdkconfig
@@ -101,6 +108,10 @@ class App(object):
         self.check_warnings = check_warnings
         self.preserve = preserve
 
+        # should be built or not
+        self.should_build = BuildOrNot.UNKNOWN
+        self._checked_should_build = False
+
         # Some miscellaneous build properties which are set later, at the build stage
         self.dry_run = False
         self.index = None
@@ -391,9 +402,10 @@ class App(object):
     @abstractmethod
     def build(
         self,
+        manifest_rootpath=None,  # type: str | None
         modified_components=None,  # type: list[str] | str | None
-        check_component_dependencies=False,  # type: bool
-        is_modified=False,  # type: bool
+        modified_files=None,  # type: list[str] | str | None
+        check_app_dependencies=False,  # type: bool
     ):  # type: (...) -> bool
         pass
 
@@ -469,6 +481,68 @@ class App(object):
 
         return False
 
+    def check_should_build(
+        self,
+        manifest_rootpath,  # type: str
+        check_app_dependencies,  # type: bool
+        modified_components,  # type: list[str] | None
+        modified_files,  # type: list[str] | None
+    ):  # type: (...) -> None
+        if self.should_build != BuildOrNot.UNKNOWN:
+            return
+
+        if not check_app_dependencies:
+            self.should_build = BuildOrNot.YES
+            self._checked_should_build = True
+            return
+
+        if self.is_modified(modified_files):
+            self.should_build = BuildOrNot.YES
+            self._checked_should_build = True
+            return
+
+        # check app dependencies
+        modified_components = to_list(modified_components)
+        modified_files = to_list(modified_files)
+
+        _modified_components = BuildOrNot.UNKNOWN
+        _modified_files = BuildOrNot.UNKNOWN
+
+        # depends components?
+        if check_app_dependencies and modified_components is not None:
+            if set(self.depends_components).intersection(set(modified_components)):
+                LOGGER.debug(
+                    '=> Should be built. %s requires components: %s, modified components %s',
+                    self,
+                    ', '.join(self.depends_components),
+                    ', '.join(modified_components),
+                )
+                _modified_components = BuildOrNot.YES
+            # if not defined dependency, we left it unknown and decide with idf.py reconfigure
+            elif self.depends_components:
+                _modified_components = BuildOrNot.NO
+
+        # or depends file patterns?
+        if check_app_dependencies and modified_files is not None:
+            if files_matches_patterns(modified_files, self.depends_filepatterns, manifest_rootpath):
+                LOGGER.debug(
+                    '=> Should be built. %s depends on file patterns: %s, modified files %s',
+                    self,
+                    ', '.join(self.depends_filepatterns),
+                    ', '.join(modified_files),
+                )
+                _modified_files = BuildOrNot.YES
+            # if not defined dependency, we left it unknown and decide with idf.py reconfigure
+            elif self.depends_filepatterns:
+                _modified_files = BuildOrNot.NO
+
+        if _modified_components == BuildOrNot.YES or _modified_files == BuildOrNot.YES:
+            self.should_build = BuildOrNot.YES
+        elif _modified_components == BuildOrNot.NO or _modified_files == BuildOrNot.NO:
+            self.should_build = BuildOrNot.NO
+
+        self._checked_should_build = True
+
 
 class CMakeApp(App):
     BUILD_SYSTEM = 'cmake'
@@ -493,10 +567,14 @@ class CMakeApp(App):
 
     def build(
         self,
+        manifest_rootpath=None,  # type: str | None
         modified_components=None,  # type: list[str] | str | None
-        check_component_dependencies=False,  # type: bool
-        is_modified=False,  # type: bool
+        modified_files=None,  # type: list[str] | str | None
+        check_app_dependencies=False,  # type: bool
     ):  # type: (...) -> bool
+        modified_components = to_list(modified_components)
+        modified_files = to_list(modified_files)
+
         LOGGER.debug('=> Preparing...')
         if self.work_dir != self.app_dir:
             if os.path.exists(self.work_dir):
@@ -554,8 +632,15 @@ class CMakeApp(App):
             '-DSDKCONFIG_DEFAULTS={}'.format(';'.join(self.sdkconfig_files) if self.sdkconfig_files else ';'),
         ]
 
-        modified_components = to_list(modified_components)
-        if modified_components is not None and check_component_dependencies and not is_modified:
+        if not self._checked_should_build:
+            self.check_should_build(
+                manifest_rootpath=manifest_rootpath,
+                modified_components=modified_components,
+                modified_files=modified_files,
+                check_app_dependencies=check_app_dependencies,
+            )
+
+        if modified_components is not None and check_app_dependencies and self.should_build == BuildOrNot.UNKNOWN:
             subprocess_run(
                 common_args + ['reconfigure'],
                 log_terminal=False if self.build_log_path else True,
@@ -575,6 +660,12 @@ class CMakeApp(App):
                     modified_components,
                 )
                 return False
+            else:
+                self.should_build = BuildOrNot.YES
+
+        if self.should_build == BuildOrNot.NO:
+            LOGGER.info('=> Skip building...')
+            return False
 
         # idf.py build
         build_args = deepcopy(common_args)

{idf_build_apps-1.0.0.dev0 → idf_build_apps-1.0.0.dev1}/idf_build_apps/finder.py

@@ -12,11 +12,11 @@ from . import (
 )
 from .app import (
     App,
+    BuildOrNot,
     CMakeApp,
 )
 from .utils import (
     config_rules_from_str,
-    files_matches_patterns,
     to_list,
 )
 
@@ -35,7 +35,7 @@ def _get_apps_from_path(
     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
+    check_app_dependencies=False,  # type: bool
     sdkconfig_defaults_str=None,  # type: str | None
 ):  # type: (...) -> list[App]
     modified_components = to_list(modified_components)
@@ -46,28 +46,16 @@ def _get_apps_from_path(
             LOGGER.debug('=> Skipping. %s only supports targets: %s', _app, ', '.join(_app.supported_targets))
             return False
 
-        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 depends on file patterns: %s, but you passed "--modified-files %s"',
-                    _app,
-                    ', '.join(_app.depends_filepatterns),
-                    ', '.join(modified_files),
-                )
-                return False
+        _app.check_should_build(
+            manifest_rootpath=manifest_rootpath,
+            modified_components=modified_components,
+            modified_files=modified_files,
+            check_app_dependencies=check_app_dependencies,
+        )
+
+        # for unknown ones, we keep them to the build stage to judge
+        if _app.should_build == BuildOrNot.NO:
+            return False
 
         return True
 

{idf_build_apps-1.0.0.dev0 → idf_build_apps-1.0.0.dev1}/idf_build_apps/main.py

@@ -51,20 +51,20 @@ except ImportError:
     pass
 
 
-def _check_components_dependency(
+def _check_app_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
+    # not check since modified_components and modified_files are 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
+    # not check since ignore_component_dependencies_file_patterns is passed and matched
     if (
         ignore_component_dependencies_file_patterns
-        and modified_files
+        and modified_files is not None
         and files_matches_patterns(modified_files, ignore_component_dependencies_file_patterns, manifest_rootpath)
     ):
         LOGGER.debug(
@@ -191,14 +191,14 @@ def find_apps(
                     check_warnings=check_warnings,
                     preserve=preserve,
                     manifest_rootpath=manifest_rootpath,
+                    check_app_dependencies=_check_app_dependency(
+                        manifest_rootpath=manifest_rootpath,
+                        modified_components=modified_components,
+                        modified_files=modified_files,
+                        ignore_component_dependencies_file_patterns=ignore_component_dependencies_file_patterns,
+                    ),
                     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,
                 )
             )
@@ -348,11 +348,12 @@ def build_apps(
         is_built = False
         try:
             is_built = app.build(
+                manifest_rootpath=manifest_rootpath,
                 modified_components=modified_components,
-                check_component_dependencies=_check_components_dependency(
+                modified_files=modified_files,
+                check_app_dependencies=_check_app_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))

{idf_build_apps-1.0.0.dev0 → idf_build_apps-1.0.0.dev1}/setup.py

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

{idf_build_apps-1.0.0.dev0 → idf_build_apps-1.0.0.dev1}/tests/test_build.py

@@ -24,7 +24,7 @@ class TestBuild:
         assert 'Project build complete.' in captured.out
 
     @pytest.mark.parametrize(
-        'modified_components, check_component_dependencies, assert_build_done',
+        'modified_components, check_app_dependencies, should_be_built',
         [
             (None, True, True),
             ([], True, False),
@@ -37,21 +37,15 @@ class TestBuild:
         ],
     )
     def test_build_with_modified_components(
-        self, tmpdir, capsys, modified_components, check_component_dependencies, assert_build_done
+        self, tmpdir, capsys, modified_components, check_app_dependencies, should_be_built
     ):
         path = IDF_PATH / 'examples' / 'get-started' / 'hello_world'
 
-        CMakeApp(str(path), 'esp32', work_dir=str(tmpdir / 'test')).build(
+        is_built = CMakeApp(str(path), 'esp32', work_dir=str(tmpdir / 'test')).build(
             modified_components=modified_components,
-            check_component_dependencies=check_component_dependencies,
+            check_app_dependencies=check_app_dependencies,
         )
-
-        captured = capsys.readouterr()
-        assert 'Configuring done' in captured.out
-        if assert_build_done:
-            assert 'Project build complete.' in captured.out
-        else:
-            assert 'Project build complete.' not in captured.out
+        assert is_built == should_be_built
 
     @pytest.mark.parametrize(
         'modified_files, is_built',
@@ -74,8 +68,8 @@ class TestBuild:
         app = CMakeApp(test_dir, 'esp32')
         built = app.build(
             modified_components=[],
-            check_component_dependencies=True,
-            is_modified=app.is_modified(modified_files),
+            modified_files=modified_files,
+            check_app_dependencies=True,
         )
 
         assert built == is_built

{idf_build_apps-1.0.0.dev0 → idf_build_apps-1.0.0.dev1}/tests/test_finder.py

@@ -111,7 +111,7 @@ get-started:
             (['soc', 'fake'], True),
         ],
     )
-    def test_with_requires_and_modified_components(self, tmpdir, modified_components, could_find_apps):
+    def test_with_depends_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
@@ -183,12 +183,13 @@ get-started:
             assert not filtered_apps
 
     @pytest.mark.parametrize(
-        'modified_files, could_find_apps',
+        'modified_components, 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),
+            ([], '/foo', True),
+            ([], str(IDF_PATH / 'examples' / 'README.md'), False),
+            (None, [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'),
@@ -197,7 +198,7 @@ get-started:
             ),
         ],
     )
-    def test_with_depends_filepatterns(self, tmp_path, modified_files, could_find_apps):
+    def test_with_depends_filepatterns(self, tmp_path, modified_components, 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
@@ -220,6 +221,39 @@ get-started:
             recursive=True,
             manifest_rootpath=str(IDF_PATH),
             manifest_files=yaml_file,
+            modified_components=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',
+        [
+            (None, True),
+            (str(IDF_PATH / 'examples' / 'README.md'), True),
+            ([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,
+            ),
+            ([str(IDF_PATH / 'examples' / 'a.c')], True),
+        ],
+    )
+    def test_with_filepattern_but_calculate_component_later(self, 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
+
+        filtered_apps = find_apps(
+            test_dir,
+            'esp32',
+            recursive=True,
             modified_files=modified_files,
         )
         if could_find_apps: