Merge branch 'bugfix/support_boolean_require' into 'main'

fix: support boolean type for require field Closes PACMAN-791 See merge request espressif/idf-component-manager!353
espressif · Feb 23, 2024 · 6ae82df · 6ae82df
2 parents cfb2d97 + a749a59
commit 6ae82df
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 2 deletions.
diff --git a/idf_component_tools/manifest/schemas.py b/idf_component_tools/manifest/schemas.py
@@ -230,8 +230,25 @@ def process_json_schema(
     json_schema['properties']['targets']['items']['type'] = 'string'
     _anyof[1]['properties']['pre_release']['type'] = 'boolean'
     _anyof[1]['properties']['public']['type'] = 'boolean'
-    _anyof[1]['properties']['require']['type'] = 'string'
 
+    # Require field might be a boolean or enum string
+    _anyof[1]['properties']['require'] = {
+        'type': 'object',
+        'anyOf': [
+            {
+                'enum': [
+                    'public',
+                    'private',
+                    'no',
+                ],
+                'type': 'string',
+            },
+            {
+                'type': 'boolean',
+                'enum': [False],  # Require can be only public, private or no/False
+            },
+        ],
+    }
     # normalize the final json schema
     json_schema = process_json_schema(json_schema)
 

diff --git a/tests/manifest/test_validator.py b/tests/manifest/test_validator.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
 import re
@@ -351,6 +351,27 @@ def test_validate_require_public_fields(self, valid_manifest):
         assert len(errors) == 1
         assert 'require' in errors[0]
 
+    def test_validate_require_field_support_boolean_string(self, valid_manifest):
+        valid_manifest['dependencies']['test']['require'] = 'public'
+        validator = ManifestValidator(valid_manifest)
+        errors = validator.validate_normalize()
+
+        assert not errors
+
+        valid_manifest['dependencies']['test']['require'] = False
+        validator = ManifestValidator(valid_manifest)
+        errors = validator.validate_normalize()
+
+        assert not errors
+
+    def test_validate_require_field_true_error(self, valid_manifest):
+        valid_manifest['dependencies']['test']['require'] = True
+        validator = ManifestValidator(valid_manifest)
+        errors = validator.validate_normalize()
+
+        assert len(errors) == 4
+        assert 'require' in errors[-1]
+
     def test_validate_links_wrong_url(self, valid_manifest):
         valid_manifest['issues'] = 'test.com/tracker'