Skip to content

Conversation

joaoantoniocardoso
Copy link
Member

@joaoantoniocardoso joaoantoniocardoso commented Aug 15, 2025

This is a backport of #3490 into 1.4

Summary by Sourcery

Backport DockerHub workaround into 1.4 by synthesizing TagMetadata for tags without image entries and adding an integration test to ensure TagFetcher fetches and validates remote tags correctly.

New Features:

  • Add TestTagFetcher integration test to verify real DockerHub tag fetching and metadata structure

Bug Fixes:

Enhancements:

  • Improve fetch_remote_tags to handle tags lacking image records by generating fallback metadata with a dummy digest

Tests:

  • Include asynchronous test in test_versionchooser.py that fetches real tags, validates metadata fields, and skips on network errors

Copy link

sourcery-ai bot commented Aug 15, 2025

Reviewer's Guide

This backport introduces a DockerHub API workaround in fetch_remote_tags to accommodate tags with no image entries and supplements the suite with an integration test for TagFetcher in the versionchooser service.

Sequence diagram for DockerHub tag processing workaround in fetch_remote_tags

sequenceDiagram
    participant TagFetcher
    participant DockerHubAPI
    participant TagMetadata
    TagFetcher->>DockerHubAPI: Request tags for repository
    DockerHubAPI-->>TagFetcher: Return tags (some with images, some without)
    loop For each tag
        TagFetcher->>TagMetadata: If tag["images"] is empty, create TagMetadata with digest="------"
        TagFetcher->>TagMetadata: Else, create TagMetadata for each image with matching architecture
    end
Loading

Class diagram for updated TagMetadata handling in fetch_remote_tags

classDiagram
    class TagMetadata {
        +repository: str
        +image: str
        +tag: str
        +last_modified: str
        +sha: str | None
        +digest: str
    }
    class TagFetcher {
        +fetch_remote_tags(repository: str, local_images: List[str])
    }
    TagFetcher --> TagMetadata : creates
Loading

File-Level Changes

Change Details Files
Add DockerHub TagFetcher integration test
  • Imported TagFetcher and TagMetadata in test_versionchooser
  • Added TestTagFetcher.test_fetch_real_blueos_core_tags with live DockerHub calls and assertions
  • Wrapped network failures in pytest.skip for reliability
core/services/versionchooser/test_versionchooser.py
Implement workaround for DockerHub tags with empty images
  • Detect when tag["images"] is empty
  • Construct placeholder TagMetadata with sha=None and digest="------"
  • Append placeholder to valid_images and continue processing
core/services/versionchooser/utils/dockerhub.py

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!

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

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

  • The new TestTagFetcher integration test depends on DockerHub and may be flaky—consider marking it as an integration test (e.g. with a custom pytest marker) or adding a timeout/mocking to improve reliability.
  • In fetch_remote_tags, avoid using the magic string "------" for the digest placeholder—extract it into a named constant or use None to make the fallback more explicit.
  • The test’s broad except Exception block can hide real failures; catch only network-related errors or specific exceptions when skipping due to connectivity issues.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The new TestTagFetcher integration test depends on DockerHub and may be flaky—consider marking it as an integration test (e.g. with a custom pytest marker) or adding a timeout/mocking to improve reliability.
- In fetch_remote_tags, avoid using the magic string "------" for the digest placeholder—extract it into a named constant or use None to make the fallback more explicit.
- The test’s broad except Exception block can hide real failures; catch only network-related errors or specific exceptions when skipping due to connectivity issues.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Collaborator

@ES-Alexander ES-Alexander left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like a reasonably straightforward cherry-pick backport of the specified functionality 👍

)
valid_images.append(tag)
continue
for image in tag["images"]:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
for image in tag["images"]:
for image in images:

If they've already been fetched into a variable, it makes sense to use that variable, right?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is a cherry-pick from master, it would be nice to move this change to master not here

@patrickelectric patrickelectric merged commit eb6ab62 into bluerobotics:1.4 Sep 11, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants