SpdxDocumentModelMapper: Revisit dependency relationship creation iteration(s)

[fviernau]

The following two iterations which are supposed to determine when to add an edge
slightly differ from one another in the following aspects

Determine linkage type of ID pairs which should be connected

This is done here: ¹, and calls following iteration APIs:

• ort/plugins/reporters/spdx/src/main/kotlin/SpdxDocumentModelMapper.kt

  Line 223 in fb2abce

  getProjects(omitExcluded = true, includeSubProjects = true).forEach { project ->

• ort/plugins/reporters/spdx/src/main/kotlin/SpdxDocumentModelMapper.kt

  Line 229 in fb2abce

  dependencyNavigator.directDependencies(project, scopeName).forEach { node ->

• ort/plugins/reporters/spdx/src/main/kotlin/SpdxDocumentModelMapper.kt

  Line 238 in fb2abce

  val children = parent.visitDependencies { children ->

Adding the relationships

This is done here: ², and calls following iteration APIs:

• ort/plugins/reporters/spdx/src/main/kotlin/SpdxDocumentModelMapper.kt

  Line 86 in fb2abce

  val projects = ortResult.getProjects(omitExcluded = true, includeSubProjects = false).sortedBy { it.id }

• ort/plugins/reporters/spdx/src/main/kotlin/SpdxDocumentModelMapper.kt

  Line 100 in fb2abce

  ortResult.getDependencies(

• ort/plugins/reporters/spdx/src/main/kotlin/SpdxDocumentModelMapper.kt

  Line 120 in fb2abce

  ortResult.getDependencies(

Question

• Are the two iterations semantically equivalent?
• If yes, can this be simplified?
  • One idea is to refactor addRelationShip calls to simply be done by an iteration over the map val linkageTypesForDependencyRelationships.

Footnotes

1. https://github.com/oss-review-toolkit/ort/blob/fb2abcedbd0ed43430814876a98d10acc99aa157/plugins/reporters/spdx/src/main/kotlin/SpdxDocumentModelMapper.kt#L218-L254 ↩

2. https://github.com/oss-review-toolkit/ort/blob/fb2abcedbd0ed43430814876a98d10acc99aa157/plugins/reporters/spdx/src/main/kotlin/SpdxDocumentModelMapper.kt#L86-L126 ↩

[fviernau]

@oheger-bosch as you are into the dependency graph API, would you have a hint here?

[oheger-bosch]

I don't yet have an idea why there is a difference in the results when using different navigation methods. But I am worried about the OrtResult.getLinkageTypesForDependencyRelationships() function in SpdxDocumentModelMapper: It does not have any detection for cycles. So, it could go in an infinite loop, couldn't it?

[fviernau]

So, it could go in an infinite loop, couldn't it?

Indeed. I'Ve addressed this with #11865.
Can you please take a look @oheger-bosch ?

[mvanhorn]

Implemented in #11994.