Lukas/gh/fix ort reuse scanner

[garazdawi]

No description provided.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces a new escript, ort-scanner.es, to manage ORT scanning, replacing the previous scan-code.escript. The workflow is updated to use this new script, incorporating steps for initializing scan results, restoring from cache, and scanning with scancode and reuse. The .ort.yml configuration is also updated to reflect the script's new location.

Sequence diagram for ORT scanner initialization

sequenceDiagram
    participant OS as Operating System
    participant ort-scanner.es
    participant git
    participant sha1sum

    OS->>ort-scanner.es: Execute init command with analyzer result and git repo path
    ort-scanner.es->>git: git rev-parse HEAD (get Git SHA)
    git-->>ort-scanner.es: Returns Git SHA
    ort-scanner.es->>sha1sum: sha1sum (calculate SHA1 sums of files)
    sha1sum-->>ort-scanner.es: Returns SHA1 sums
    ort-scanner.es->>OS: Write scan result to file

Loading

Sequence diagram for ORT scanner restore cache

sequenceDiagram
    participant OS as Operating System
    participant ort-scanner.es

    OS->>ort-scanner.es: Execute restore-cache command with input and cache scan results
    ort-scanner.es->>ort-scanner.es: Check files to restore from cache
    ort-scanner.es->>ort-scanner.es: Restore scan results from cache
    ort-scanner.es->>OS: Write updated scan result to file

Loading

File-Level Changes

Change	Details	Files
Introduces a new escript, ort-scanner.es, to handle ORT scanning, replacing the previous scan-code.escript.	Implements init command to create a basic scan result from analyzer results. Implements restore-cache command to restore license results from a previous scan. Implements scan command to update scan results using either scancode or reuse. Includes logic for setting up a scan area, running the selected scanner tool, and cleaning up temporary files. Adds functionality to deduplicate scan results and handle license mappings. Introduces argument parsing using the argparse library. Adds error handling and cleanup functions. Adds batch processing for sha1sum calculation and file copying to improve performance.	.github/scripts/ort-scanner.es scripts/scan-code.escript
Updates the main workflow to use the new ort-scanner.es script for scanning.	Replaces the direct scancode invocation with calls to ort-scanner.es for initialization, cache restoration, and scanning. Adds a step to overwrite scan results using reuse. Modifies the diff command to compare against the scan result cache. Installs reuse before running the reuse scan.	.github/workflows/main.yaml
Updates the .ort.yml configuration to point to the new ort-scanner.es script.	Changes the path for the CODE curation to the new script location.	.ort.yml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @garazdawi - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding a flag to disable the reuse scan step, as it might not always be desired.
• The new script introduces a lot of complexity; ensure it's thoroughly tested and handles edge cases gracefully.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}