Skip to content

feat: add models.OrganizationalEntity.bom_ref #801

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
+225 −0
Draft

feat: add models.OrganizationalEntity.bom_ref #801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54cf48f
feat: add bom_ref to OrganizationalEntity
Yowgf Mar 12, 2025
3c9f234
Address concerns from gemini bot
Yowgf Mar 12, 2025
640a904
Add tests in tests/_data/models.py, remove current
Yowgf Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions cyclonedx/model/contact.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,16 +288,33 @@ class OrganizationalEntity:

def __init__(
self, *,
bom_ref: Optional[Union[str, BomRef]] = None,
name: Optional[str] = None,
urls: Optional[Iterable[XsUri]] = None,
contacts: Optional[Iterable[OrganizationalContact]] = None,
address: Optional[PostalAddress] = None,
) -> None:
self._bom_ref = bom_ref
self.name = name
self.address = address
self.urls = urls or [] # type:ignore[assignment]
self.contacts = contacts or [] # type:ignore[assignment]

@property
@serializable.json_name('bom-ref')
@serializable.type_mapping(BomRef)
@serializable.xml_attribute()
@serializable.xml_name('bom-ref')
def bom_ref(self) -> Optional[BomRef]:
"""
An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be
unique within the BOM.

Returns:
`BomRef`
"""
return self._bom_ref

@property
@serializable.xml_sequence(10)
@serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
Expand Down
20 changes: 20 additions & 0 deletions tests/_data/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1437,6 +1437,26 @@ def get_bom_for_issue540_duplicate_components() -> Bom:
bom.register_dependency(component1, [component3])
return bom


def get_bom_for_issue799_organizational_entity_bom_ref() -> Bom:
"""regression test for issue #799
see https://github.com/CycloneDX/cyclonedx-python-lib/issues/799
"""
return _make_bom(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please don't use the $.metadata.tools.services for this use case, as this particular structure is not available in all versions of CycloneDX, as this would render this test case almost unused.

please use $.components[].supplier instead.

metadata=BomMetaData(
tools=ToolRepository(
services=(
Service(name='service-1',
provider=OrganizationalEntity(
name='org-1',
bom_ref=BomRef('bom-ref-1'),
)),
)
)
)
)


# ---


Expand Down
4 changes: 4 additions & 0 deletions tests/_data/snapshots/get_bom_for_issue799_organizational_entity_bom_ref-1.0.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<?xml version="1.0" ?>
<bom xmlns="http://cyclonedx.org/schema/bom/1.0" version="1">
<components/>
</bom>
4 changes: 4 additions & 0 deletions tests/_data/snapshots/get_bom_for_issue799_organizational_entity_bom_ref-1.1.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<?xml version="1.0" ?>
<bom xmlns="http://cyclonedx.org/schema/bom/1.1" serialNumber="urn:uuid:1441d33a-e0fc-45b5-af3b-61ee52a88bac" version="1">
<components/>
</bom>
15 changes: 15 additions & 0 deletions tests/_data/snapshots/get_bom_for_issue799_organizational_entity_bom_ref-1.2.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"metadata": {
"timestamp": "2023-01-07T13:44:32.312678+00:00",
"tools": [
{
"name": "service-1"
}
]
},
"serialNumber": "urn:uuid:1441d33a-e0fc-45b5-af3b-61ee52a88bac",
"version": 1,
"$schema": "http://cyclonedx.org/schema/bom-1.2b.schema.json",
"bomFormat": "CycloneDX",
"specVersion": "1.2"
}
11 changes: 11 additions & 0 deletions tests/_data/snapshots/get_bom_for_issue799_organizational_entity_bom_ref-1.2.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?xml version="1.0" ?>
<bom xmlns="http://cyclonedx.org/schema/bom/1.2" serialNumber="urn:uuid:1441d33a-e0fc-45b5-af3b-61ee52a88bac" version="1">
<metadata>
<timestamp>2023-01-07T13:44:32.312678+00:00</timestamp>
<tools>
<tool>
<name>service-1</name>
</tool>
</tools>
</metadata>
</bom>
15 changes: 15 additions & 0 deletions tests/_data/snapshots/get_bom_for_issue799_organizational_entity_bom_ref-1.3.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"metadata": {
"timestamp": "2023-01-07T13:44:32.312678+00:00",
"tools": [
{
"name": "service-1"
}
]
},
"serialNumber": "urn:uuid:1441d33a-e0fc-45b5-af3b-61ee52a88bac",
"version": 1,
"$schema": "http://cyclonedx.org/schema/bom-1.3a.schema.json",
"bomFormat": "CycloneDX",
"specVersion": "1.3"
}
11 changes: 11 additions & 0 deletions tests/_data/snapshots/get_bom_for_issue799_organizational_entity_bom_ref-1.3.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?xml version="1.0" ?>
<bom xmlns="http://cyclonedx.org/schema/bom/1.3" serialNumber="urn:uuid:1441d33a-e0fc-45b5-af3b-61ee52a88bac" version="1">
<metadata>
<timestamp>2023-01-07T13:44:32.312678+00:00</timestamp>
<tools>
<tool>
<name>service-1</name>
</tool>
</tools>
</metadata>
</bom>
15 changes: 15 additions & 0 deletions tests/_data/snapshots/get_bom_for_issue799_organizational_entity_bom_ref-1.4.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"metadata": {
"timestamp": "2023-01-07T13:44:32.312678+00:00",
"tools": [
{
"name": "service-1"
}
]
},
"serialNumber": "urn:uuid:1441d33a-e0fc-45b5-af3b-61ee52a88bac",
"version": 1,
"$schema": "http://cyclonedx.org/schema/bom-1.4.schema.json",
"bomFormat": "CycloneDX",
"specVersion": "1.4"
}
11 changes: 11 additions & 0 deletions tests/_data/snapshots/get_bom_for_issue799_organizational_entity_bom_ref-1.4.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?xml version="1.0" ?>
<bom xmlns="http://cyclonedx.org/schema/bom/1.4" serialNumber="urn:uuid:1441d33a-e0fc-45b5-af3b-61ee52a88bac" version="1">
<metadata>
<timestamp>2023-01-07T13:44:32.312678+00:00</timestamp>
<tools>
<tool>
<name>service-1</name>
</tool>
</tools>
</metadata>
</bom>
31 changes: 31 additions & 0 deletions tests/_data/snapshots/get_bom_for_issue799_organizational_entity_bom_ref-1.5.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"metadata": {
"timestamp": "2023-01-07T13:44:32.312678+00:00",
"tools": {
"services": [
{
"name": "service-1",
"provider": {
"bom-ref": "bom-ref-1",
"name": "org-1"
}
}
]
}
},
"properties": [
{
"name": "key1",
"value": "val1"
},
{
"name": "key2",
"value": "val2"
}
],
"serialNumber": "urn:uuid:1441d33a-e0fc-45b5-af3b-61ee52a88bac",
"version": 1,
"$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
"bomFormat": "CycloneDX",
"specVersion": "1.5"
}
20 changes: 20 additions & 0 deletions tests/_data/snapshots/get_bom_for_issue799_organizational_entity_bom_ref-1.5.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?xml version="1.0" ?>
<bom xmlns="http://cyclonedx.org/schema/bom/1.5" serialNumber="urn:uuid:1441d33a-e0fc-45b5-af3b-61ee52a88bac" version="1">
<metadata>
<timestamp>2023-01-07T13:44:32.312678+00:00</timestamp>
<tools>
<services>
<service>
<provider bom-ref="bom-ref-1">
<name>org-1</name>
</provider>
<name>service-1</name>
</service>
</services>
</tools>
</metadata>
<properties>
<property name="key1">val1</property>
<property name="key2">val2</property>
</properties>
</bom>
31 changes: 31 additions & 0 deletions tests/_data/snapshots/get_bom_for_issue799_organizational_entity_bom_ref-1.6.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"metadata": {
"timestamp": "2023-01-07T13:44:32.312678+00:00",
"tools": {
"services": [
{
"name": "service-1",
"provider": {
"bom-ref": "bom-ref-1",
"name": "org-1"
}
}
]
}
},
"properties": [
{
"name": "key1",
"value": "val1"
},
{
"name": "key2",
"value": "val2"
}
],
"serialNumber": "urn:uuid:1441d33a-e0fc-45b5-af3b-61ee52a88bac",
"version": 1,
"$schema": "http://cyclonedx.org/schema/bom-1.6.schema.json",
"bomFormat": "CycloneDX",
"specVersion": "1.6"
}
20 changes: 20 additions & 0 deletions tests/_data/snapshots/get_bom_for_issue799_organizational_entity_bom_ref-1.6.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?xml version="1.0" ?>
<bom xmlns="http://cyclonedx.org/schema/bom/1.6" serialNumber="urn:uuid:1441d33a-e0fc-45b5-af3b-61ee52a88bac" version="1">
<metadata>
<timestamp>2023-01-07T13:44:32.312678+00:00</timestamp>
<tools>
<services>
<service>
<provider bom-ref="bom-ref-1">
<name>org-1</name>
</provider>
<name>service-1</name>
</service>
</services>
</tools>
</metadata>
<properties>
<property name="key1">val1</property>
<property name="key2">val2</property>
</properties>
</bom>