Skip to content
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.

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

Support scancode-toolkit v32.3.0 output format changes #634

Open
AyanSinhaMahapatra opened this issue Dec 17, 2024 · 2 comments
Open

Support scancode-toolkit v32.3.0 output format changes #634

AyanSinhaMahapatra opened this issue Dec 17, 2024 · 2 comments
Labels
good first issue Good for newcomers

Comments

@AyanSinhaMahapatra
Copy link
Member

Description

Please leave a brief discription of the bug or feature request:

See the output format changes in https://github.com/aboutcode-org/scancode-toolkit/releases/tag/v32.3.0
scancode-workbench needs to support the attirbute updates.

Changes in Output Data Structure:
The data structure of the JSON output has changed for: - dependencies at file level package_data, and at top-level. - license matches at file level or unique codebase level license detections Note that the change is a modification to the JSON output, so we have a major version bump 3.2.0 to 4.0.0:
Dependency attribute is_resolved renamed to is_pinned
LicenseMatch attribute spdx_license_expression renamed to license_expression_spdx

These updates are not causing any issues atm, the scan loads allright and does not show any errors/warnings.
But we need to update the Package Explorer view and the data imports to correctly load and display the info. Currently is_resolved is always shown as NULL. The license match table doesn't seem to be affected (?)

System configuration

For bug reports, it really helps us to know:

  • What OS are you running on? (Windows/MacOS/Linux) any
  • What version of scancode-workbench are you running on? 4.0.3
  • What version of scancode-toolkit was used to generate the scan file? v32.3.0
@AyanSinhaMahapatra AyanSinhaMahapatra added the good first issue Good for newcomers label Dec 17, 2024
@alok1304
Copy link
Contributor

alok1304 commented Dec 27, 2024

@AyanSinhaMahapatra I checked for the LicenseMatch there is no bug found or match table did not affected.
I think all is good, I check this with one of my project with containing MIT license I generated output from scanning of sctk
and generated the json file and I checked in scancode-workbench. Actullay what i do is:

  1. In my json file(i.e outputInfoSphere.json is my file name) in which i found this license_expression_spdx first I do not change in my json file.
    Output that i received from ScanCode Workbench for license i.e
    Screenshot 2024-12-28 111017

  2. I changed license_expression_spdx to spdx_license_expression in my json file. I got this result:
    Screenshot 2024-12-28 112808

Conclusion

All things are same as previous i.e in 1 and 2. After changing the license_expression_spdx to spdx_license_expression result are same.

Also I attach the json file for 1 and 2.

  1. Don't change any thing this contains the license_expression_spdx.
    outputInfoSphere.json

  2. changing the license_expression_spdx to spdx_license_expression
    InfoSphere_spdx_lic.json

@mjherzog mjherzog changed the title Support scancode-toolkit v32.3.0 Support scancode-toolkit v32.3.0 output format changes Dec 27, 2024
@alok1304
Copy link
Contributor

@AyanSinhaMahapatra

Checking Resolved dependencies

I checked in two steps. The first one I kept as it was, is_resolved; in the second step, I changed this is_resolved to is_pinned.
Results are different in both cases when I use scancode-workbench, also I attach JSON file which is taken from samples in both steps:

  1. is_resolved :
    scancode-32.0.0rc4_python_sample-wref_orig.json

Screenshot 2024-12-28 103917

  1. is_pinned :
    scancode-32.0.0rc4_python_sample-wref_is_pinned.json

Screenshot 2024-12-28 104625

Conclusion

The JSON file has 17 total dependencies. When I used is_resolved, 8 were Resolved, and 9 were Unresolved.
When I used is_pinned then I got all 17 are Unresolved, which means when we use is_pinned then our all is_resolved is mark as false.

alok1304 added a commit to alok1304/scancode-workbench that referenced this issue Dec 30, 2024
Renaming the dependency attribute is_resolved to is_pinned. Output changes when we use is_resolved.

Reference: aboutcode-org#634
alok1304 added a commit to alok1304/scancode-workbench that referenced this issue Dec 30, 2024
Renaming the dependency attribute is_resolved to is_pinned. Output changes when we use is_resolved.

Reference: aboutcode-org#634
alok1304 added a commit to alok1304/scancode-workbench that referenced this issue Dec 30, 2024
Renaming the dependency attribute is_resolved to is_pinned. Output changes when we use is_resolved.

Reference: aboutcode-org#634
Signed-off-by: Alok Kumar <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants