[PATCH 1/3] meta/files: Add a jsonschema for bitbake-setup configuration files

[PATCH 1/3] meta/files: Add a jsonschema for bitbake-setup configuration files

[Yoann Congal]

From: Yoann Congal <yoann.congal@smile.fr>

This schema is a bit loose and should validate any configuration files working with
bitbake-setup but, also, some broken ones:
* If present, a "bb-layer" can be an empty array.
* bb-setup need at least one of "bb-layers" or "oe-template", that is
  not enforced in the current schema.
* bb-setup accepts "configurations = []" but it results in a impossible
  choice in interactive mode. This is rejected by the schema.
* In each configuration, "name" and "description" are optional but the
  flatten configuration must have them. This is not enforced by the
  schema.

To test a configuration files against this schema: (for exemple to
validate bitbake default registry)
   $ pip install check-jsonschema
   $ check-jsonschema -v --schemafile meta/files/bitbake-setup.schema.json bitbake/default-registry/configurations/*
  ok -- validation done
  The following files were checked:
    bitbake/default-registry/configurations/oe-nodistro.conf.json
    bitbake/default-registry/configurations/poky-master.conf.json

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
---
Notes:
* I plan to send a patch to make bb-setup reject "configurations = []"
* '"additionalProperties": false' makes "comments":"..."  impossible right now, I
  plan to add them later.
---
 meta/files/bitbake-setup.schema.json | 108 +++++++++++++++++++++++++++
 1 file changed, 108 insertions(+)
 create mode 100644 meta/files/bitbake-setup.schema.json

diff --git a/meta/files/bitbake-setup.schema.json b/meta/files/bitbake-setup.schema.json
new file mode 100644
index 0000000000..5101b0de53
--- /dev/null
+++ b/meta/files/bitbake-setup.schema.json
@@ -0,0 +1,108 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "description": "Schema for bitbake-setup configuration files",
+    "type": "object",
+    "required": [
+        "description",
+        "bitbake-setup",
+        "version"
+    ],
+    "properties": {
+        "description": {
+            "type": "string",
+            "description": "Description of the bitbake-setup configuration file"
+        },
+        "sources": {
+            "$ref": "layers.schema.json#/properties/sources"
+        },
+        "bitbake-setup": {
+            "type": "object",
+            "description": "BitBake-setup configurations",
+            "required": [
+                "configurations"
+            ],
+            "properties": {
+                "configurations": {
+                    "type": "array",
+                    "minItems": 1,
+                    "$anchor": "configurations",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "type": "string",
+                                "description": "Name of the configuration"
+                            },
+                            "description": {
+                                "type": "string",
+                                "description": "Human-readable description of the configuration"
+                            },
+                            "bb-layers": {
+                                "type": "array",
+                                "description": "List of BitBake layers to include",
+                                "items": {
+                                    "type": "string"
+                                }
+                            },
+                            "oe-template": {
+                                "type": "string",
+                                "description": "OE-template configuration"
+                            },
+                            "oe-fragments": {
+                                "$anchor": "oe-fragments",
+                                "type": "array",
+                                "description": "List of BitBake configuration fragments to enable",
+                                "items": {
+                                    "type": "string"
+                                }
+                            },
+                            "oe-fragments-one-of": {
+                                "type": "object",
+                                "description": "Mutually exclusive bitbake configuration fragment",
+                                "patternProperties": {
+                                    ".*": {
+                                        "type": "object",
+                                        "required": [
+                                            "description",
+                                            "options"
+                                        ],
+                                        "properties": {
+                                            "description": {
+                                                "type": "string",
+                                                "description": "Human-readable description of the fragment category"
+                                            },
+                                            "options": {
+                                                "$ref": "#oe-fragments"
+                                            }
+                                        },
+                                        "additionalProperties": false
+                                    }
+                                },
+                                "additionalProperties": false
+                            },
+                            "configurations": {
+                                "$ref": "#configurations"
+                            },
+                            "bb-env-passthrough-additions": {
+                                "type": "array",
+                                "description": "List of environment variables to include in BB_ENV_PASSTHROUGH_ADDITIONS",
+                                "items": {
+                                    "type": "string"
+                                }
+                            }
+                        },
+                        "additionalProperties": false
+                    }
+                }
+            },
+            "additionalProperties": false
+        },
+        "version": {
+            "description": "The version of this document; currently '1.0'",
+            "enum": [
+                "1.0"
+            ]
+        }
+    },
+    "additionalProperties": false
+}

[PATCH 2/3] selftest/bblayers: Refactor JSON schema validation

[Yoann Congal]

From: Yoann Congal <yoann.congal@smile.fr>

* Extract a function "validate_json"
* Allow to specify the schema relative to $COREBASE/meta/files/
* Specify the Base URI to allow schema to reference each other

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
---
RFC: Maybe I should split this commit?
---
 meta/lib/oeqa/selftest/cases/bblayers.py | 21 +++++++++++++++------
 1 file changed, 15 insertions(+), 6 deletions(-)

diff --git a/meta/lib/oeqa/selftest/cases/bblayers.py b/meta/lib/oeqa/selftest/cases/bblayers.py
index 982287c9a5..43a158fcf2 100644
--- a/meta/lib/oeqa/selftest/cases/bblayers.py
+++ b/meta/lib/oeqa/selftest/cases/bblayers.py
@@ -136,15 +136,24 @@ class BitbakeLayers(OESelftestTestCase):
         self.assertTrue(os.path.isfile(recipe_file), msg = "Can't find recipe file for %s" % recipe)
         return os.path.basename(recipe_file)
 
-    def validate_layersjson(self, json):
-        python = os.path.join(get_bb_var('STAGING_BINDIR', 'python3-jsonschema-native'), 'nativepython3')
-        jsonvalidator = os.path.join(get_bb_var('STAGING_BINDIR', 'python3-jsonschema-native'), 'jsonschema')
-        jsonschema = os.path.join(get_bb_var('COREBASE'), 'meta/files/layers.schema.json')
-        result = runCmd("{} {} -i {} {}".format(python, jsonvalidator, json, jsonschema))
+    def validate_json(self, json, jsonschema):
+        staging_bindir = get_bb_var('STAGING_BINDIR', 'python3-jsonschema-native')
+        python = os.path.join(staging_bindir, 'nativepython3')
+        jsonvalidator = os.path.join(staging_bindir, 'jsonschema')
+        schemas_dir = os.path.join(get_bb_var('COREBASE'), "meta/files/")
+        if not os.path.isabs(jsonschema):
+            jsonschema = os.path.join(schemas_dir, jsonschema)
+
+        result = runCmd(
+            "{} {} -i {} --base-uri file://{}/ {}".format(
+                python, jsonvalidator, json, schemas_dir, jsonschema
+            )
+        )
 
     def test_validate_examplelayersjson(self):
         json = os.path.join(get_bb_var('COREBASE'), "meta/files/layers.example.json")
-        self.validate_layersjson(json)
+        jsonschema = "layers.schema.json"
+        self.validate_json(json, jsonschema)
 
     def test_bitbakelayers_setup(self):
         result = runCmd('bitbake-layers create-layers-setup {}'.format(self.testlayer_path))

[PATCH 3/3] selftest/bblayers: Add a test to validate bitbake-setup registry schema

[Yoann Congal]

From: Yoann Congal <yoann.congal@smile.fr>

This test validates bitbake/default-registry/configurations/*.conf.json
against bitbake-setup.schema.json:
  INFO - test_validate_bitbake_setup_default_registry (bblayers.BitbakeLayers.test_validate_bitbake_setup_default_registry)
  DEBUG - Validating [...]/poky/bitbake/bin/../default-registry/configurations/oe-nodistro.conf.json
  DEBUG - Validating [...]/poky/bitbake/bin/../default-registry/configurations/poky-master.conf.json
  INFO -  ... ok
  INFO - test_validate_examplelayersjson (bblayers.BitbakeLayers.test_validate_examplelayersjson)
  INFO -  ... ok
  INFO - ----------------------------------------------------------------------
  INFO - Ran 2 tests in 121.119s
  INFO - OK
  INFO - RESULTS:
  INFO - RESULTS - bblayers.BitbakeLayers.test_validate_bitbake_setup_default_registry: PASSED (15.86s)
  INFO - RESULTS - bblayers.BitbakeLayers.test_validate_examplelayersjson: PASSED (7.12s)

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
---
RFC: This structure takes ~7s per schema validation. I guess because of
the multiple bb_get_var in each loop. I'll glady take suggestions on how
to improve this.
---
 meta/lib/oeqa/selftest/cases/bblayers.py | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/meta/lib/oeqa/selftest/cases/bblayers.py b/meta/lib/oeqa/selftest/cases/bblayers.py
index 43a158fcf2..8397506f04 100644
--- a/meta/lib/oeqa/selftest/cases/bblayers.py
+++ b/meta/lib/oeqa/selftest/cases/bblayers.py
@@ -155,6 +155,20 @@ class BitbakeLayers(OESelftestTestCase):
         jsonschema = "layers.schema.json"
         self.validate_json(json, jsonschema)
 
+    def test_validate_bitbake_setup_default_registry(self):
+        jsonschema = "bitbake-setup.schema.json"
+
+        bitbake_path = get_bb_var("BITBAKEPATH")
+        default_registry_path = os.path.join(bitbake_path, "..", "default-registry", "configurations")
+
+        for root, _, files in os.walk(default_registry_path):
+            for f in files:
+                if not f.endswith(".conf.json"):
+                    continue
+                json = os.path.join(root, f)
+                self.logger.debug("Validating %s", json)
+                self.validate_json(json, jsonschema)
+
     def test_bitbakelayers_setup(self):
         result = runCmd('bitbake-layers create-layers-setup {}'.format(self.testlayer_path))
         jsonfile = os.path.join(self.testlayer_path, "setup-layers.json")

Re: [OE-core] [PATCH 3/3] selftest/bblayers: Add a test to validate bitbake-setup registry schema

[Alexander Kanavin]

On Thu, 23 Oct 2025 at 09:25, Yoann Congal via lists.openembedded.org
<yoann.congal=smile.fr@lists.openembedded.org> wrote:
> RFC: This structure takes ~7s per schema validation. I guess because of
> the multiple bb_get_var in each loop. I'll glady take suggestions on how
> to improve this.

I guess you need to refactor the code to obtain them only once on the
top level (or even in the test initialization where
python3-jsonschema-native is built), and set as object properties:
self.something.

Otherwise lgtm, now that we have a schema and tests, we can start
messing around with it :)

Alex

Re: [OE-core] [PATCH 2/3] selftest/bblayers: Refactor JSON schema validation

[Mathieu Dubois-Briand]

On Thu Oct 23, 2025 at 9:25 AM CEST, Yoann Congal via lists.openembedded.org wrote:
> From: Yoann Congal <yoann.congal@smile.fr>
>
> * Extract a function "validate_json"
> * Allow to specify the schema relative to $COREBASE/meta/files/
> * Specify the Base URI to allow schema to reference each other
>
> Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
> ---
> RFC: Maybe I should split this commit?
> ---
>  meta/lib/oeqa/selftest/cases/bblayers.py | 21 +++++++++++++++------
>  1 file changed, 15 insertions(+), 6 deletions(-)
>
> diff --git a/meta/lib/oeqa/selftest/cases/bblayers.py b/meta/lib/oeqa/selftest/cases/bblayers.py
> index 982287c9a5..43a158fcf2 100644
> --- a/meta/lib/oeqa/selftest/cases/bblayers.py
> +++ b/meta/lib/oeqa/selftest/cases/bblayers.py
> @@ -136,15 +136,24 @@ class BitbakeLayers(OESelftestTestCase):
>          self.assertTrue(os.path.isfile(recipe_file), msg = "Can't find recipe file for %s" % recipe)
>          return os.path.basename(recipe_file)
>  
> -    def validate_layersjson(self, json):
> -        python = os.path.join(get_bb_var('STAGING_BINDIR', 'python3-jsonschema-native'), 'nativepython3')
> -        jsonvalidator = os.path.join(get_bb_var('STAGING_BINDIR', 'python3-jsonschema-native'), 'jsonschema')
> -        jsonschema = os.path.join(get_bb_var('COREBASE'), 'meta/files/layers.schema.json')
> -        result = runCmd("{} {} -i {} {}".format(python, jsonvalidator, json, jsonschema))
> +    def validate_json(self, json, jsonschema):
> +        staging_bindir = get_bb_var('STAGING_BINDIR', 'python3-jsonschema-native')
> +        python = os.path.join(staging_bindir, 'nativepython3')
> +        jsonvalidator = os.path.join(staging_bindir, 'jsonschema')
> +        schemas_dir = os.path.join(get_bb_var('COREBASE'), "meta/files/")
> +        if not os.path.isabs(jsonschema):
> +            jsonschema = os.path.join(schemas_dir, jsonschema)
> +
> +        result = runCmd(
> +            "{} {} -i {} --base-uri file://{}/ {}".format(
> +                python, jsonvalidator, json, schemas_dir, jsonschema
> +            )
> +        )
>  
>      def test_validate_examplelayersjson(self):
>          json = os.path.join(get_bb_var('COREBASE'), "meta/files/layers.example.json")
> -        self.validate_layersjson(json)
> +        jsonschema = "layers.schema.json"
> +        self.validate_json(json, jsonschema)

Hi Yoann,

Did you forget to replace some uses of validate_layersjson() or did I
miss a commit? I still have 5 calls to it in bblayers.py, after your
patches are applied.

2025-10-23 14:30:16,772 - oe-selftest - INFO - testtools.testresult.real._StringException: Traceback (most recent call last):
  File "/srv/pokybuild/yocto-worker/oe-selftest-fedora/build/layers/openembedded-core/meta/lib/oeqa/selftest/cases/bblayers.py", line 175, in test_bitbakelayers_setup
    self.validate_layersjson(jsonfile)
    ^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: 'BitbakeLayers' object has no attribute 'validate_layersjson'

https://autobuilder.yoctoproject.org/valkyrie/#/builders/48/builds/2499
https://autobuilder.yoctoproject.org/valkyrie/#/builders/35/builds/2589
https://autobuilder.yoctoproject.org/valkyrie/#/builders/23/builds/2737

I had a quick look at the v2 and I believe we have the same issue.

Thanks,
Mathieu

-- 
Mathieu Dubois-Briand, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [OE-core] [PATCH 2/3] selftest/bblayers: Refactor JSON schema validation

[Yoann Congal]

[-- Attachment #1: Type: text/plain, Size: 3917 bytes --]

Le ven. 24 oct. 2025 à 08:32, Mathieu Dubois-Briand <
mathieu.dubois-briand@bootlin.com> a écrit :

> On Thu Oct 23, 2025 at 9:25 AM CEST, Yoann Congal via
> lists.openembedded.org wrote:
> > From: Yoann Congal <yoann.congal@smile.fr>
> >
> > * Extract a function "validate_json"
> > * Allow to specify the schema relative to $COREBASE/meta/files/
> > * Specify the Base URI to allow schema to reference each other
> >
> > Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
> > ---
> > RFC: Maybe I should split this commit?
> > ---
> >  meta/lib/oeqa/selftest/cases/bblayers.py | 21 +++++++++++++++------
> >  1 file changed, 15 insertions(+), 6 deletions(-)
> >
> > diff --git a/meta/lib/oeqa/selftest/cases/bblayers.py
> b/meta/lib/oeqa/selftest/cases/bblayers.py
> > index 982287c9a5..43a158fcf2 100644
> > --- a/meta/lib/oeqa/selftest/cases/bblayers.py
> > +++ b/meta/lib/oeqa/selftest/cases/bblayers.py
> > @@ -136,15 +136,24 @@ class BitbakeLayers(OESelftestTestCase):
> >          self.assertTrue(os.path.isfile(recipe_file), msg = "Can't find
> recipe file for %s" % recipe)
> >          return os.path.basename(recipe_file)
> >
> > -    def validate_layersjson(self, json):
> > -        python = os.path.join(get_bb_var('STAGING_BINDIR',
> 'python3-jsonschema-native'), 'nativepython3')
> > -        jsonvalidator = os.path.join(get_bb_var('STAGING_BINDIR',
> 'python3-jsonschema-native'), 'jsonschema')
> > -        jsonschema = os.path.join(get_bb_var('COREBASE'),
> 'meta/files/layers.schema.json')
> > -        result = runCmd("{} {} -i {} {}".format(python, jsonvalidator,
> json, jsonschema))
> > +    def validate_json(self, json, jsonschema):
> > +        staging_bindir = get_bb_var('STAGING_BINDIR',
> 'python3-jsonschema-native')
> > +        python = os.path.join(staging_bindir, 'nativepython3')
> > +        jsonvalidator = os.path.join(staging_bindir, 'jsonschema')
> > +        schemas_dir = os.path.join(get_bb_var('COREBASE'),
> "meta/files/")
> > +        if not os.path.isabs(jsonschema):
> > +            jsonschema = os.path.join(schemas_dir, jsonschema)
> > +
> > +        result = runCmd(
> > +            "{} {} -i {} --base-uri file://{}/ {}".format(
> > +                python, jsonvalidator, json, schemas_dir, jsonschema
> > +            )
> > +        )
> >
> >      def test_validate_examplelayersjson(self):
> >          json = os.path.join(get_bb_var('COREBASE'),
> "meta/files/layers.example.json")
> > -        self.validate_layersjson(json)
> > +        jsonschema = "layers.schema.json"
> > +        self.validate_json(json, jsonschema)
>
> Hi Yoann,
>
> Did you forget to replace some uses of validate_layersjson() or did I
> miss a commit? I still have 5 calls to it in bblayers.py, after your
> patches are applied.
>

Yes I did in v1.


> 2025-10-23 14:30:16,772 - oe-selftest - INFO -
> testtools.testresult.real._StringException: Traceback (most recent call
> last):
>   File
> "/srv/pokybuild/yocto-worker/oe-selftest-fedora/build/layers/openembedded-core/meta/lib/oeqa/selftest/cases/bblayers.py",
> line 175, in test_bitbakelayers_setup
>     self.validate_layersjson(jsonfile)
>     ^^^^^^^^^^^^^^^^^^^^^^^^
> AttributeError: 'BitbakeLayers' object has no attribute
> 'validate_layersjson'
>
> https://autobuilder.yoctoproject.org/valkyrie/#/builders/48/builds/2499
> https://autobuilder.yoctoproject.org/valkyrie/#/builders/35/builds/2589
> https://autobuilder.yoctoproject.org/valkyrie/#/builders/23/builds/2737
>
> I had a quick look at the v2 and I believe we have the same issue.
>

I think I fixed that in v2 by keeping validate_layersjson() but changing it
to use the refactored function. Can you test this?

Thanks!

>
> Thanks,
> Mathieu
>
> --
> Mathieu Dubois-Briand, Bootlin
> Embedded Linux and Kernel engineering
> https://bootlin.com
>
>

[-- Attachment #2: Type: text/html, Size: 6130 bytes --]

Re: [OE-core] [PATCH 2/3] selftest/bblayers: Refactor JSON schema validation

[Mathieu Dubois-Briand]

On Fri Oct 24, 2025 at 8:47 AM CEST, Yoann Congal via lists.openembedded.org wrote:
> Le ven. 24 oct. 2025 à 08:32, Mathieu Dubois-Briand <
> mathieu.dubois-briand@bootlin.com> a écrit :
>
> Yes I did in v1.
>
>
>> 2025-10-23 14:30:16,772 - oe-selftest - INFO -
>> testtools.testresult.real._StringException: Traceback (most recent call
>> last):
>>   File
>> "/srv/pokybuild/yocto-worker/oe-selftest-fedora/build/layers/openembedded-core/meta/lib/oeqa/selftest/cases/bblayers.py",
>> line 175, in test_bitbakelayers_setup
>>     self.validate_layersjson(jsonfile)
>>     ^^^^^^^^^^^^^^^^^^^^^^^^
>> AttributeError: 'BitbakeLayers' object has no attribute
>> 'validate_layersjson'
>>
>> https://autobuilder.yoctoproject.org/valkyrie/#/builders/48/builds/2499
>> https://autobuilder.yoctoproject.org/valkyrie/#/builders/35/builds/2589
>> https://autobuilder.yoctoproject.org/valkyrie/#/builders/23/builds/2737
>>
>> I had a quick look at the v2 and I believe we have the same issue.
>>
>
> I think I fixed that in v2 by keeping validate_layersjson() but changing it
> to use the refactored function. Can you test this?
>

Sure, I will test it in my next run!

-- 
Mathieu Dubois-Briand, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com