fix: add disabled apps to junit with --include-all-apps flag

Author: achxkloel

idf_build_apps/app.py

@@ -511,7 +511,9 @@ def build(
             BuildStatus.UNKNOWN,
             BuildStatus.SHOULD_BE_BUILT,
         ):
-            self.build_comment = f'Build {self.build_status.value}. Skipping...'
+            if not self.build_comment:
+                self.build_comment = f'Build {self.build_status.value}. Skipping...'
+
             return
 
         # real build starts here

idf_build_apps/main.py

@@ -22,6 +22,7 @@
     BuildArguments,
     DumpManifestShaArguments,
     FindArguments,
+    FindBuildArguments,
     add_args_to_parser,
     apply_config_file,
 )
@@ -386,23 +387,32 @@ def main():
         sys.exit(0)
 
     kwargs = vars(args)
+    kwargs_without_none = drop_none_kwargs(kwargs)
     action = kwargs.pop('action')
     config_file = kwargs.pop('config_file')
     if config_file:
         apply_config_file(config_file)
 
     if action == 'dump-manifest-sha':
-        arguments = DumpManifestShaArguments(**drop_none_kwargs(kwargs))
+        arguments = DumpManifestShaArguments(**kwargs_without_none)
         Manifest.from_files(arguments.manifest_files).dump_sha_values(arguments.output)
         sys.exit(0)
-    elif action == 'find':
-        arguments = FindArguments(**drop_none_kwargs(kwargs))
+
+    if action == 'find':
+        arguments = FindArguments(**kwargs_without_none)
+        find_arguments = arguments
     else:
-        arguments = BuildArguments(**drop_none_kwargs(kwargs))
+        arguments = BuildArguments(**kwargs_without_none)
+
+        # Because build needs to find apps, we need to create find_arguments here
+        find_arguments = FindArguments(
+            **{k: v for k, v in kwargs_without_none.items() if k in FindBuildArguments.model_fields}
+        )
 
     # real call starts here
     # build also needs to find first
-    apps = find_apps(args.paths, args.target, find_arguments=arguments)
+    apps = find_apps(args.paths, args.target, find_arguments=find_arguments)
+
     if isinstance(arguments, FindArguments):  # find only
         if arguments.output:
             os.makedirs(os.path.dirname(os.path.realpath(arguments.output)), exist_ok=True)
@@ -444,6 +454,12 @@ def main():
         for app in failed_apps:
             print(f'  {app}')
 
+    disabled_apps = [app for app in apps if app.build_status == BuildStatus.DISABLED]
+    if disabled_apps:
+        print('Disabled the following apps:')
+        for app in disabled_apps:
+            print(f'  {app}')
+
     if ret_code != 0:
         sys.exit(ret_code)
 

tests/test_cmd.py

@@ -3,9 +3,13 @@
 import os
 import sys
 from pathlib import Path
+from textwrap import dedent
+from xml.etree import ElementTree
 
 import pytest
+from conftest import create_project
 
+from idf_build_apps.constants import SUPPORTED_TARGETS
 from idf_build_apps.main import main
 from idf_build_apps.utils import InvalidCommand
 
@@ -95,3 +99,65 @@ def test_manifest_patterns(tmp_path, monkeypatch, capsys):
     assert f'Loading manifest file {os.path.join(tmp_path, "manifest.yml")}' in err
     assert f'"{os.path.join(tmp_path, "foo")}" does not exist' in err
     assert f'"{os.path.join(tmp_path, "bar")}" does not exist' in err
+
+
+def test_build_include_all_apps(tmp_path, monkeypatch, capsys):
+    create_project('foo', tmp_path)
+
+    manifest = tmp_path / 'manifest.yml'
+    manifest.write_text(
+        dedent("""\
+        foo:
+          disable:
+            - if: IDF_TARGET == "esp32"
+        """)
+    )
+
+    with monkeypatch.context() as m:
+        m.setattr(
+            sys,
+            'argv',
+            [
+                'idf-build-apps',
+                'build',
+                '--paths',
+                'foo',
+                '--manifest-files',
+                str(manifest),
+                '--check-manifest-rules',
+                '--include-all-apps',
+                '--junitxml',
+                str(tmp_path / 'junit.xml'),
+                '--dry-run',
+            ],
+        )
+        main()
+
+    out, err = capsys.readouterr()
+    assert err == ''
+    assert 'Disabled the following apps' in out
+    assert out.count('Disabled by manifest rule: IDF_TARGET == "esp32"') == 1
+
+    with open(str(tmp_path / 'junit.xml')) as f:
+        xml = ElementTree.fromstring(f.read())
+
+    test_suite = xml.findall('testsuite')[0]
+    assert test_suite.attrib['tests'] == '0'
+    assert test_suite.attrib['failures'] == '0'
+    assert test_suite.attrib['errors'] == '0'
+    assert test_suite.attrib['skipped'] == str(len(SUPPORTED_TARGETS))
+
+    disabled_testcases = 0
+
+    for case in test_suite.findall('testcase'):
+        if case.get('name') != 'foo/build':
+            continue
+
+        skipped = case.find('skipped')
+        if skipped is None:
+            continue
+
+        if skipped.get('message') == 'Disabled by manifest rule: IDF_TARGET == "esp32"':
+            disabled_testcases += 1
+
+    assert disabled_testcases == 1

tests/test_finder.py

@@ -138,7 +138,7 @@ def test_include_disabled_apps(self, tmp_path):
         for app in apps:
             assert app.build_status == BuildStatus.DISABLED
             app.build()
-            assert app.build_comment == 'Build disabled. Skipping...'
+            assert app.build_comment.startswith('Not enabled by manifest rules:')
 
 
 class TestFindWithModifiedFilesComponents: