feat: add `cyclonedx.model.dependency.Dependency.provides` by uzairchhapra · Pull Request #735 · CycloneDX/cyclonedx-python-lib

uzairchhapra · 2024-11-05T19:06:52Z

Fixes #691

Signed-off-by: Uzair Chhapra <uzairchhapra@gmail.com>

uzairchhapra · 2024-11-05T21:48:06Z

@jkowalleck PR is ready for review.
I am not too sure about the test cases so any guidance here would help. Thanks!

jkowalleck · 2024-11-10T15:36:12Z

thank you for your contribution, @uzairchhapra .

the implementation looks promising.

Regarding tests, we tend to go with an integration-test snapshot-solution, over detailed unit tests.
Please add new fixtures to https://github.com/CycloneDX/cyclonedx-python-lib/blob/main/tests/_data/models.py. your new function must start with get_bom_.
After adding new test data, please recreate the snapshots as described here: https://github.com/CycloneDX/cyclonedx-python-lib/blob/main/tests/_data/snapshots/README.md

Signed-off-by: Uzair Chhapra <uzairchhapra@gmail.com>

jkowalleck · 2024-11-11T15:56:19Z

cyclonedx/model/bom.py

+        self,
+        target: Dependable,
+        depends_on: Optional[Iterable[Dependable]] = None,
+        provides: Optional[Iterable[Dependable]] = None,


instead of adding a new parameter here, how about adding a new method instead: register_provision(self, target: Dependable, provides: Optional[Iterable[Dependable]] = None).

what do you think about this?
this would fit the original architectural plans better.

I'll give this a try

@jkowalleck
How should this function work register_provision for the example mentioned pin models.py?

A -- requires -> C B -- provides -> C

Considering register_dependency and register_provision will be called for all A, B and C, should I look for existing dependencies added in register_provision to avoid creating a new Dependency?

this is still open.
could you consider adding a new method?

tests/_data/models.py

tests/_data/snapshots/get_bom_with_provides_valid-1.6.json.bin

Signed-off-by: Uzair Chhapra <uzairchhapra@gmail.com>

tests/_data/models.py

jkowalleck · 2025-01-15T12:10:55Z

@uzairchhapra, I just wanted to ask how things are going.
Do you need any help with one of the open discussions/points?

uzairchhapra · 2025-01-27T17:22:27Z

@uzairchhapra, I just wanted to ask how things are going. Do you need any help with one of the open discussions/points?

Apologies for the delayed response. I will get to this this weekend. If I remember correctly, I was stuck in making the test function work get_bom_v1_6_with_provides. I see my PR has some conflicts now, so will try to address that too.

aespogom · 2025-03-27T13:55:07Z

Hi everyone,
Thanks a lot for your amazing work!!
Just wanted to check in—I'm currently waiting on this fix to be released, as it's blocking some of our work. Really appreciate all the efforts from the maintainers and contributors here. Is there any estimated timeline for when this might be included in a release? Thanks in advance!

robertlagrant · 2025-04-03T18:45:45Z

@aespogom I'm not affiliated, but it looks as though the author has abandoned this PR. If it's blocking you, would you consider picking it up?

…ides Signed-off-by: Uzair Chhapra <uzairchhapra@gmail.com>

Signed-off-by: Uzair Chhapra <uzairchhapra@gmail.com>

tests/_data/models.py

Signed-off-by: Uzair Chhapra <uzairchhapra@gmail.com>

jkowalleck · 2025-04-11T07:42:51Z

cyclonedx/model/bom.py

+        self,
+        target: Dependable,
+        depends_on: Optional[Iterable[Dependable]] = None,
+        provides: Optional[Iterable[Dependable]] = None,


this is still open.
could you consider adding a new method?

feat: add cyclonedx.model.dependency.Dependency.provides

fb4598d

Signed-off-by: Uzair Chhapra <uzairchhapra@gmail.com>

uzairchhapra force-pushed the feat/691-uzair-provides branch from f2ad0ed to fb4598d Compare November 5, 2024 19:11

chore(test): add unit test test_dependency_with_provides

00536a7

Signed-off-by: Uzair Chhapra <uzairchhapra@gmail.com>

uzairchhapra marked this pull request as ready for review November 5, 2024 21:47

uzairchhapra requested a review from a team as a code owner November 5, 2024 21:47

jkowalleck changed the title ~~[WIP] feat: add cyclonedx.model.dependency.Dependency.provides~~ feat: add cyclonedx.model.dependency.Dependency.provides Nov 5, 2024

jkowalleck mentioned this pull request Nov 10, 2024

[TRACKING] Complete support for CycloneDX v1.6 #696

Open

4 tasks

uzairchhapra added 3 commits November 11, 2024 10:10

ft: update validate and register_dependency to read provides

abf6abf

Signed-off-by: Uzair Chhapra <uzairchhapra@gmail.com>

chore: set view schema to 1.6 for provides

8cdb39b

Signed-off-by: Uzair Chhapra <uzairchhapra@gmail.com>

chore(test): add test get_bom_with_provides_valid

2525660

Signed-off-by: Uzair Chhapra <uzairchhapra@gmail.com>

This comment was marked as outdated.

Sign in to view

jkowalleck reviewed Nov 11, 2024

View reviewed changes

uzairchhapra commented Nov 11, 2024

View reviewed changes

tests/_data/models.py Outdated Show resolved Hide resolved

tests/_data/snapshots/get_bom_with_provides_valid-1.6.json.bin Outdated Show resolved Hide resolved

jkowalleck self-requested a review November 12, 2024 12:54

fix: rename test to apply only for v1.6

bd370af

Signed-off-by: Uzair Chhapra <uzairchhapra@gmail.com>

jkowalleck reviewed Nov 18, 2024

View reviewed changes

tests/_data/models.py Outdated Show resolved Hide resolved

jkowalleck mentioned this pull request Jan 29, 2025

Tool name: CycloneDX Python Library aboutcode-org/workshop#60

Open

60 tasks

uzairchhapra added 3 commits April 3, 2025 19:05

Merge remote-tracking branch 'upstream/main' into feat/691-uzair-prov…

5bdc59d

…ides Signed-off-by: Uzair Chhapra <uzairchhapra@gmail.com>

chore(test): add test get_bom_with_provides

7b64985

Signed-off-by: Uzair Chhapra <uzairchhapra@gmail.com>

chore(test): add snapshots for get_bom_with_provides

3b4f790

Signed-off-by: Uzair Chhapra <uzairchhapra@gmail.com>

uzairchhapra commented Apr 3, 2025

View reviewed changes

tests/_data/models.py Show resolved Hide resolved

chore(test): updated model get_bom_with_provides

39a5f8f

Signed-off-by: Uzair Chhapra <uzairchhapra@gmail.com>

jkowalleck requested changes Apr 11, 2025

View reviewed changes

jkowalleck marked this pull request as draft April 23, 2025 09:52

Uh oh!

Conversation

uzairchhapra commented Nov 5, 2024

Uh oh!

uzairchhapra commented Nov 5, 2024

Uh oh!

jkowalleck commented Nov 10, 2024

Uh oh!

This comment was marked as outdated.

jkowalleck Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

uzairchhapra Nov 13, 2024

Choose a reason for hiding this comment

Uh oh!

uzairchhapra Apr 7, 2025

Choose a reason for hiding this comment

Uh oh!

jkowalleck Apr 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jkowalleck commented Jan 15, 2025

Uh oh!

uzairchhapra commented Jan 27, 2025

Uh oh!

aespogom commented Mar 27, 2025

Uh oh!

robertlagrant commented Apr 3, 2025

Uh oh!

Uh oh!

jkowalleck Apr 11, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants