ci: add component test apps

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -23,12 +23,15 @@ body:
         - bdc_motor
         - catch2
         - cbor
+        - ccomp_timer
         - coap
         - coremark
+        - dhara
         - eigen
+        - esp_delta_ota
         - esp_encrypted_img
-        - esp_lcd_qemu_rgb
         - esp_jpeg
+        - esp_lcd_qemu_rgb
         - esp_serial_slave_link
         - expat
         - fmt
@@ -38,15 +41,20 @@ body:
         - json_generator
         - json_parser
         - led_strip
+        - libpng
         - libsodium
+        - network_provisioning
         - nghttp
         - onewire_bus
         - pcap
         - pid_ctrl
         - qrcode
+        - quirc
         - sh2lib
-        - test_app
+        - spi_nand_flash
+        - supertinycron
         - thorvg
+        - zlib
         - Other
     validations:
       required: true

.github/PULL_REQUEST_TEMPLATE/new_component.md

@@ -4,8 +4,8 @@
 - [ ] Component contains README.md
 - [ ] Component contains idf_component.yml file with `url` field defined
 - [ ] Component was added to [upload job](https://github.com/espressif/idf-extra-components/blob/master/.github/workflows/upload_component.yml#L18)
-- [ ] Component was added to [build job](https://github.com/espressif/idf-extra-components/blob/master/test_app/CMakeLists.txt#L8)
-- [ ] _Optional:_ Component contains unit tests
+- [ ] Component has an example project
+- [ ] _Optional:_ Component has a test_app
 - [ ] CI passing
 
 # Change description

.github/consistency_check.py

@@ -0,0 +1,123 @@
+#!/usr/bin/env python
+# This script performs various consistency checks on the repository.
+import argparse
+import logging
+import glob
+import os
+from pathlib import Path
+
+import yaml
+
+
+LOG = logging.getLogger("consistency_check")
+failures = 0
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--root", default=".", help="Root directory of the repository")
+    args = parser.parse_args()
+
+    logging.basicConfig(level=logging.INFO)
+
+    check_build_manifests_added_to_config(args)
+    check_components_added_to_upload_job(args)
+    check_components_added_to_issue_template(args)
+
+    if failures:
+        LOG.error(f"Found {failures} issues")
+        raise SystemExit(1)
+
+
+#### Checks ####
+
+def check_build_manifests_added_to_config(args):
+    LOG.info("Checking that all .build-test-rules.yml files are added to .idf_build_apps.toml")
+
+    build_manifests_from_repo = set(glob.glob(f"{args.root}/**/.build-test-rules.yml", recursive=True))
+    # exclude the ones under 'managed_components'
+    build_manifests_from_repo = set([Path(f) for f in build_manifests_from_repo if "managed_components" not in f])
+
+    idf_build_apps_toml = load_toml(os.path.join(args.root, ".idf_build_apps.toml"))
+    build_manifests_from_config = set([Path(f) for f in idf_build_apps_toml.get("manifest_file", [])])
+
+    missing = build_manifests_from_repo - build_manifests_from_config
+    if missing:
+        LOG.error(f"Missing build manifests in .idf_build_apps.toml: {missing}") 
+        add_failure()
+
+
+def check_components_added_to_upload_job(args):
+    LOG.info("Checking that all components are added to the upload job")
+
+    components_from_repo = set([Path(f).name for f in get_component_dirs(args)])
+
+    upload_job = load_yaml(os.path.join(args.root, ".github/workflows/upload_component.yml"))
+    upload_job_steps = upload_job.get("jobs", {}).get("upload_components", {}).get("steps", [])
+    upload_job_step = next((step for step in upload_job_steps if step.get("name") == "Upload components to component service"), None)
+    components_from_upload_job = set([name.strip() for name in upload_job_step.get("with", {}).get("directories", "").split(";")])
+
+    missing = components_from_repo - components_from_upload_job
+    if missing:
+        LOG.error(f"Missing components in upload job: {missing}")
+        add_failure()
+
+
+def check_components_added_to_issue_template(args):
+    LOG.info("Checking that all components are added to the issue template")
+
+    issue_template = load_yaml(os.path.join(args.root, ".github/ISSUE_TEMPLATE/bug-report.yml"))
+    issue_template_component = next((element for element in issue_template.get("body", []) if element.get("id") == "component"), None)
+    components_from_issue_template = set(issue_template_component.get("attributes", {}).get("options", []))
+
+    components_from_repo = set([Path(component).name for component in get_component_dirs(args)])
+    missing = components_from_repo - components_from_issue_template
+    if missing:
+        LOG.error(f"Missing components in issue template: {missing}")
+        add_failure()
+    extra = components_from_issue_template - components_from_repo - set(["Other"])
+    if extra:
+        LOG.error(f"Extra components in issue template: {extra}")
+        add_failure()
+
+
+#### Utility functions ####
+
+def load_toml(filepath) -> dict:
+    try:
+        import tomllib  # type: ignore # python 3.11
+
+        try:
+            with open(str(filepath), 'rb') as fr:
+                return tomllib.load(fr)
+        except Exception as e:
+            raise ValueError(f"Failed to load {filepath}: {e}")
+    except ImportError:
+        import toml
+
+        try:
+            return toml.load(str(filepath))
+        except Exception as e:
+            raise ValueError(f"Failed to load {filepath}: {e}")
+
+
+def load_yaml(filepath) -> dict:
+    with open(filepath, "r") as f:
+        return yaml.safe_load(f)
+
+
+def get_component_dirs(args):
+    """
+    Returns a list of component paths in this repository.
+    """
+    components_from_repo = set(glob.glob(f"{args.root}/*/idf_component.yml"))
+    components_from_repo = [Path(f).parent.name for f in components_from_repo]
+    return components_from_repo
+
+def add_failure():
+    global failures
+    failures += 1
+
+
+if __name__ == "__main__":
+    main()

.github/get_idf_build_apps_args.py

@@ -0,0 +1,49 @@
+#!/usr/bin/env python3
+
+import argparse
+import os
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-v', '--verbose', action='store_true', help='Enable verbose output')
+    parser.add_argument('modified_files_list', type=argparse.FileType('r'), help='Input file containing list of modified files')
+    parser.add_argument('idf_build_apps_args', type=argparse.FileType('w'), help='Output file containing idf-build-apps arguments')
+    args = parser.parse_args()
+
+    modified_files = args.modified_files_list.read().splitlines()
+    idf_build_apps_args = []
+    idf_build_apps_args += [
+        '--modified-files',
+        ';'.join(modified_files)
+        ]
+
+    if args.verbose:
+        print('Modified files:')
+        for file in sorted(modified_files):
+            print(f'  - {file}')
+
+    modified_components = set()
+    excluded_dirs = ['.github', 'test_app']
+    for file in modified_files:
+        toplevel = file.split('/')[0]
+        if toplevel in excluded_dirs:
+            continue
+        if not os.path.isdir(toplevel):
+            continue
+        modified_components.add(toplevel)
+
+    idf_build_apps_args += [
+        '--modified-components',
+        ';'.join(modified_components)
+        ]
+
+    args.idf_build_apps_args.write(' '.join(idf_build_apps_args))
+
+    if args.verbose:
+        print('Modified components:')
+        for component in sorted(modified_components):
+            print(f'  - {component}')
+
+
+if __name__ == '__main__':
+    main()

.github/get_pytest_args.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python3
+
+import argparse
+import json
+import glob
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-v', '--verbose', action='store_true', help='Enable verbose output')
+    parser.add_argument('--target', type=str, required=True, help='Target to run tests for')
+    parser.add_argument('build_info_json', type=str, help='Input file(s) containing build info generated by idf-build-apps. Accepts globs.')
+    parser.add_argument('pytest_args', type=argparse.FileType('w'), help='Output file containing pytest arguments')
+
+    args = parser.parse_args()
+    pytest_args = []
+    app_json_files = glob.glob(args.build_info_json)
+    if args.verbose:
+        print(f'Found {len(app_json_files)} app_json files')
+        for app_json_file in app_json_files:
+            print(f'  - {app_json_file}')
+    for app_json_file in app_json_files:
+        with open(app_json_file, 'r') as build_info_json:
+            if args.verbose:
+                print(f'Processing {app_json_file}')
+            for app_json_line in build_info_json.readlines():
+                app_json = json.loads(app_json_line)
+                skip = False
+                if app_json['target'] != args.target:
+                    continue
+                if app_json['build_status'] == 'skipped':
+                    if args.verbose:
+                        print(f'Skipping {app_json["app_dir"]})')
+                    pytest_args += [
+                        '--ignore',
+                        app_json['app_dir']
+                    ]
+                else:
+                    if args.verbose:
+                        print(f'Not skipping {app_json["app_dir"]})')
+
+
+    args.pytest_args.write(' '.join(pytest_args))
+
+
+if __name__ == '__main__':
+    main()
+