zephyr/scripts/dts/python-devicetree/tests/test-bindings-init/base_amend.yaml
Christophe Dufaza ee5c520326 edtlib: tests: refine coverage of Binding objects initialization
Add a series of unit tests which try to cover somewhat systematically
the possible inputs and what we finally get at the exit
of the Binding constructor.

Running the assumption that any (valid) YAML binding file is
something we can make a Binding instance with:
- check which properties are defined at which level (binding,
  child-binding, grandchild-binding, etc) and their specifications
  once the binding is initialized
- check how including bindings are permitted to specialize
  the specifications of inherited properties
- check the rules applied when overwriting a binding's description
  or compatible string (at the binding, child-binding, etc, levels)

Some tests covering known issues are disabled by default:
- this permits to document these issues
- while not causing CI errors (when running the python-devicetree
  unit tests)
- enabling these tests without causing errors should allow us
  to consider the related issues are fixed

Signed-off-by: Christophe Dufaza <chris@openmarl.org>
2025-01-08 19:17:51 +01:00

96 lines
2.7 KiB
YAML

# SPDX-License-Identifier: BSD-3-Clause
#
# Amends base properties specifications:
# - extends property specifications by adding definitions,
# e.g. setting a "default:" value
# - overwrites existing definitions of a property,
# e.g. change its "description:"
# - specify new properties
#
# The same kind of amendments are applied to the same properties
# at each level (binding, child-binding, grandchild-binding).
#
# | Definition | Extended for | Overwritten for |
# |----------------|--------------|-----------------|
# | description: | prop-2 | prop-1 |
# | required: | | prop-enum |
# | enum: | prop-2 | |
# | const: | prop-1 | |
# | default: | prop-2 | |
#
# Non authorized amendments, e.g. changing a "const:" value
# or downgrading a "required: true" definition are tested separately.
description: Amended description.
include: base.yaml
properties:
prop-1:
# The including binding is permitted to overwrite a property description.
description: Overwritten description.
# The including binding is permitted to set a "const:" value.
const: 0xf0
prop-2:
# The including binding is permitted to add a property description.
description: New description.
# The including binding is permitted to limit property values
# to an enumeration.
enum:
- EXT_FOO
- EXT_BAR
# The including binding is permitted to set a default value.
default: EXT_FOO
# The including binding is permitted to promote a property
# to requirement.
prop-enum:
required: true
# The including binding is permitted to define a new property.
prop-new:
type: int
# Same amendments at the child-binding level.
child-binding:
properties:
child-prop-1:
description: Overwritten description (child).
const: 0xf1
child-prop-2:
description: New description (child).
enum:
- CHILD_EXT_FOO
- CHILD_EXT_BAR
default: CHILD_EXT_FOO
child-prop-enum:
required: true
child-prop-new:
type: int
# Same amendments at the grandchild-binding level.
child-binding:
# Plus amended grandchild-binding description.
description: Amended grandchild-binding description.
properties:
grandchild-prop-1:
description: Overwritten description (grandchild).
const: 0xf2
grandchild-prop-2:
description: New description (grandchild).
enum:
- GRANDCHILD_EXT_FOO
- GRANDCHILD_EXT_BAR
default: GRANDCHILD_EXT_FOO
grandchild-prop-enum:
required: true
grandchild-prop-new:
type: int