Skip to content

CodebaseResource does not have all the features of commoncode Resource model #1585

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

Jump to bottom
Open
AyanSinhaMahapatra opened this issue Feb 20, 2025 · 4 comments · May be fixed by #1638
Open

CodebaseResource does not have all the features of commoncode Resource model #1585

AyanSinhaMahapatra opened this issue Feb 20, 2025 · 4 comments · May be fixed by #1638
Labels
good first issue Good for newcomers

Comments

@AyanSinhaMahapatra
Copy link
Member

Due to a need of maintaining a Codebase/Resource model to traverse and support all the scancode-toolkit functions we have two similar models with same functions to integrate scancode-toolkit in SCIO:

  • the CodebaseResource model mirrors the commoncode.resource.Resource model
  • the Project model has necessary functions with the same behavior from the commoncode.resource.Codebase model

But the support is currently limited to the widely used functions in scancode-toolkit only, and not all the functions from the commoncode.resource models, and this causes failures when a new function is used on the scancode-toolkit side, which might not be supported on the scancode.io side yet.

For example:
In aboutcode-org/scancode-toolkit#3983 we fixed some issues related to package resource assignment for jar manifests, and in the process we started using commoncode.resource.Resource.extracted_to from the suggestion at aboutcode-org/scancode-toolkit#3983 (comment), but this is not something that is supported in SCIO, so after this was released and used in SCIO, we had the following failure:

'CodebaseResource' object has no attribute 'extracted_from'

Traceback:
  File "/opt/scancodeio/aboutcode/pipeline/__init__.py", line 199, in execute
    step(self)
  File "/opt/scancodeio/scanpipe/pipelines/inspect_packages.py", line 61, in scan_for_application_packages
    scancode.scan_for_application_packages(
  File "/opt/scancodeio/scanpipe/pipes/scancode.py", line 436, in scan_for_application_packages
    assemble_packages(project=project)
  File "/opt/scancodeio/scanpipe/pipes/scancode.py", line 493, in assemble_packages
    for item in items:
                ^^^^^
  File "/opt/scancodeio/.venv/lib/python3.12/site-packages/packagedcode/maven.py", line 123, in assemble
    yield from JavaJarManifestHandlerMixin.assemble(package_data, resource, codebase, package_adder)
  File "/opt/scancodeio/.venv/lib/python3.12/site-packages/packagedcode/models.py", line 1185, in assemble
    cls.assign_package_to_resources(
  File "/opt/scancodeio/.venv/lib/python3.12/site-packages/packagedcode/maven.py", line 158, in assign_package_to_resources
    models.DatafileHandler.assign_package_to_resources(
  File "/opt/scancodeio/.venv/lib/python3.12/site-packages/packagedcode/models.py", line 1225, in assign_package_to_resources
    archive_resource = resource.extracted_from(codebase)

So we need to do a review of all the functions present in commoncode.resource models which could be used in scancode-toolkit, and implement all of them here, and add tests to make sure they are all supported.
@AyanSinhaMahapatra
Copy link
Member Author

I will open a PR to support extracted_from and extracted_to functions just so we don't get these failures atleast, the rest can be done later.

AyanSinhaMahapatra added a commit that referenced this issue Feb 20, 2025
@AyanSinhaMahapatra
Add extracted_to and extracted_from methods
8813b4f 
Adds methods in CodebaseResource objects to navigate from an archive
to their corresponding extracted directory and vice versa. This is
added to match the functions in commoncode.resource.Resource so
these functions work in the scancode.io context similarly to how
they work in the scancode-toolkit context.

Reference: #1585
Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
@AyanSinhaMahapatra AyanSinhaMahapatra mentioned this issue Feb 20, 2025
Merged
tdruez pushed a commit that referenced this issue Feb 20, 2025
@AyanSinhaMahapatra
Add extracted_to and extracted_from methods (#1588)
f0cf10e 
Adds methods in CodebaseResource objects to navigate from an archive
to their corresponding extracted directory and vice versa. This is
added to match the functions in commoncode.resource.Resource so
these functions work in the scancode.io context similarly to how
they work in the scancode-toolkit context.

Reference: #1585

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
@tdruez
Copy link
Contributor

tdruez commented Feb 27, 2025

@AyanSinhaMahapatra Can this be closed following the merged of #1588 ?

@AyanSinhaMahapatra
Copy link
Member Author

@tdruez Not really, my PR above only fixes the specific errors we were having (which is part of this issue but not all of it). We need to do a bit more to ensure this doesn't happen again in the future. From my comment above, the goal is to:

do a review of all the functions present in commoncode.resource models which could be used in scancode-toolkit, and implement all of them here, and add tests to make sure they are all supported

@AyanSinhaMahapatra AyanSinhaMahapatra added the good first issue Good for newcomers label Mar 21, 2025
@abanoub-samy-farhan
Copy link

abanoub-samy-farhan commented Mar 22, 2025 •
edited
Loading

Hi @AyanSinhaMahapatra , I would like to contribute to this issue. Currently working on reviewing the CodebaseResource and it's mirror model commoncode.resource.Resource

@abanoub-samy-farhan abanoub-samy-farhan linked a pull request Mar 22, 2025 that will close this issue
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Codebaseresource features mapping with commoncode.resource #1585 abanoub-samy-farhan/scancode.io
3 participants
@tdruez @AyanSinhaMahapatra @abanoub-samy-farhan