[setup]: Pin docker-image-py to 0.1.13 by lunyue-ms · Pull Request #4660 · sonic-net/sonic-utilities

lunyue-ms · 2026-07-01T01:29:50Z

What I did

docker-image-py was unpinned (>=0.1.10). The 0.2.0 release (2026-06-29) breaks
sonic-utilities: its split_docker_domain() mis-parses Azure/sonic (failing
test_get_registry_for and corrupting registry paths), and it requires
regex>=2026.6.28, which breaks the wheel install against the apt regex
(uninstall-no-record-file). Pin to ==0.1.13 to keep the pre-0.2.0 behavior.

Minimal alternative to #4655 (which makes the code 0.2.0-compatible instead) —
merge only one.

How I did it

setup.py: 'docker-image-py>=0.1.10' -> 'docker-image-py==0.1.13'.

How to verify it

pytest tests/sonic_package_manager/test_registry.py -v

passes; pip resolves docker-image-py to 0.1.13 (not 0.2.0).

Previous command output (if the output of a command-line utility has changed)

N/A

New command output (if the output of a command-line utility has changed)

N/A

mssonicbld · 2026-07-01T01:29:58Z

/azp run

azure-pipelines · 2026-07-01T01:30:09Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull request overview

This PR pins docker-image-py to <0.2.0 in sonic-utilities’ Python packaging requirements to prevent a recently released upstream version from breaking sonic-package-manager behavior and the SONiC image build process.

Changes:

Restrict docker-image-py dependency from >=0.1.10 to >=0.1.10,<0.2.0 to avoid upstream behavior/dependency changes introduced in 0.2.0.

roeebar-arista · 2026-07-01T02:56:21Z

        'click-log>=0.3.2',
        'docker>=4.4.4',
-        'docker-image-py>=0.1.10',
+        'docker-image-py>=0.1.10,<0.2.0',


Why not docker-image-py==0.1.13? That is how it is pinned in sonic-buildimage, and we don't know what other versions of docker-image-py might be released.

It seems that there is no version between 0.1.13 and 0.2.0. Yes, docker-image-py==0.1.13 will be more accurate to pin the version.

docker-image-py 0.2.0 (released 2026-06-29) breaks sonic-utilities in two ways: 1. Its split_docker_domain() now treats an uppercase first path segment as a registry domain, so get_registry_for('Azure/sonic') no longer resolves to Docker Hub. This fails tests/sonic_package_manager/test_registry.py ::test_get_registry_for and would also break real package resolution for the Azure/* repositories used by sonic-package-manager. 2. It bumps its dependency to regex>=2026.6.28, which forces pip to upgrade the apt-installed regex inside the build container; that package has no RECORD file and cannot be uninstalled (error: uninstall-no-record-file), breaking the sonic_utilities wheel install and therefore the whole SONiC image build. Pin to ==0.1.13 to restore the previous behavior. 0.1.13 keeps regex>=2019.4.14 (satisfied by the existing regex) and the old domain splitting. This matches the exact version already pinned in the SONiC reproducible-build locks (files/build/versions/**/versions-py3). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Lun Yue <17232861+lunyue-ms@users.noreply.github.com>

mssonicbld · 2026-07-01T03:33:53Z

/azp run

azure-pipelines · 2026-07-01T03:34:03Z

Azure Pipelines successfully started running 1 pipeline(s).

roeebar-arista · 2026-07-01T04:50:41Z

@yijingyan2 Can you please also add this to 202511?

justin-wong-ce · 2026-07-09T18:14:18Z

@vaibhavhd @vmittal-msft could you help take a look and see if the cherry-pick job be triggered for this PR please?

lunyue-ms · 2026-07-10T02:39:41Z

#4655 fixed the unit test issue when using 0.2.0 docker-image-py. It also needs to be added for 202511

…re/sonic' in registry test (#4674) #### What I did `docker-image-py` was pulled in unpinned (`docker-image-py>=0.1.10`). When **0.2.0** was released (2026-06-29) it changed `Reference.split_docker_domain()` to treat an uppercase first path component as a registry domain (Docker Hub repository names must be lowercase). This broke `tests/sonic_package_manager/test_registry.py::test_get_registry_for`, which resolved the reference `Azure/sonic`. The key point is that `Azure/sonic` is **not a valid Docker Hub reference** in the first place — Docker Hub namespaces must be lowercase (`Azure/...` is rejected as an invalid namespace). So instead of pinning `docker-image-py` to `==0.1.13` (#4660) or reimplementing `split_docker_domain()`, this change simply fixes the test to use the valid lowercase reference `azure/sonic` and drops the pin (`>=0.1.10`), so registry resolution and the test are correct regardless of the installed `docker-image-py` version and the build can adopt 0.2.0. It pairs with sonic-net/sonic-buildimage#28144, which stops installing `python3-regex` via apt so 0.2.0's `regex>=2026.6.28` installs cleanly. #### How I did it - `setup.py`: `docker-image-py==0.1.13` → `docker-image-py>=0.1.10` (drop the pin added in #4660). - `tests/sonic_package_manager/test_registry.py`: `resolver.get_registry_for('Azure/sonic')` → `resolver.get_registry_for('azure/sonic')`. #### How to verify it Run the package-manager registry test with `docker-image-py` 0.2.0 installed: ``` pytest tests/sonic_package_manager/test_registry.py::test_get_registry_for ``` It passes (CI green) — `azure/sonic` resolves to the `DockerHubRegistry` singleton regardless of the `docker-image-py` version. #### Previous command output (if the output of a command-line utility has changed) N/A - no user-facing command output changes. #### New command output (if the output of a command-line utility has changed) N/A - no user-facing command output changes. Signed-off-by: Sonic Build Admin <sonicbld@microsoft.com>

docker-image-py 0.2.0 (released 2026-06-29) breaks sonic-utilities in two ways: 1. Its split_docker_domain() now treats an uppercase first path segment as a registry domain, so get_registry_for('Azure/sonic') no longer resolves to Docker Hub. This fails tests/sonic_package_manager/test_registry.py ::test_get_registry_for and would also break real package resolution for the Azure/* repositories used by sonic-package-manager. 2. It bumps its dependency to regex>=2026.6.28, which forces pip to upgrade the apt-installed regex inside the build container; that package has no RECORD file and cannot be uninstalled (error: uninstall-no-record-file), breaking the sonic_utilities wheel install and therefore the whole SONiC image build. Pin to ==0.1.13 to restore the previous behavior. 0.1.13 keeps regex>=2019.4.14 (satisfied by the existing regex) and the old domain splitting. This matches the exact version already pinned in the SONiC reproducible-build locks (files/build/versions/**/versions-py3). Signed-off-by: Lun Yue <17232861+lunyue-ms@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Yogapriya Mohankumar <ymohanku@cisco.com>

Copilot AI review requested due to automatic review settings July 1, 2026 01:29

Copilot started reviewing on behalf of lunyue-ms July 1, 2026 01:30 View session

lunyue-ms mentioned this pull request Jul 1, 2026

[sonic-package-manager]: Unpin docker-image-py and use lowercase 'azure/sonic' in registry test #4655

Merged

Copilot AI reviewed Jul 1, 2026

View reviewed changes

roeebar-arista reviewed Jul 1, 2026

View reviewed changes

lunyue-ms force-pushed the lunyue/pin-docker-image-py branch from 640dd6b to 87aa13f Compare July 1, 2026 03:33

roeebar-arista approved these changes Jul 1, 2026

View reviewed changes

lunyue-ms changed the title ~~[setup]: Pin docker-image-py<0.2.0~~ [setup]: Pin docker-image-py to 0.1.13 Jul 1, 2026

yijingyan2 approved these changes Jul 1, 2026

View reviewed changes

yijingyan2 merged commit 90f89d0 into sonic-net:master Jul 1, 2026
9 checks passed

yijingyan2 added the Request for 202605 Branch label Jul 1, 2026

lunyue-ms added the Request for 202511 Branch label Jul 1, 2026

mssonicbld mentioned this pull request Jul 10, 2026

[action] [PR:4655] [sonic-package-manager]: Unpin docker-image-py and use lowercase 'azure/sonic' in registry test #4674

Merged

lunyue-ms removed the Request for 202605 Branch label Jul 10, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[setup]: Pin docker-image-py to 0.1.13#4660

[setup]: Pin docker-image-py to 0.1.13#4660
yijingyan2 merged 1 commit into
sonic-net:masterfrom
lunyue-ms:lunyue/pin-docker-image-py

lunyue-ms commented Jul 1, 2026 •

edited

Loading

Uh oh!

mssonicbld commented Jul 1, 2026

Uh oh!

azure-pipelines Bot commented Jul 1, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

roeebar-arista Jul 1, 2026

Uh oh!

lunyue-ms Jul 1, 2026

Uh oh!

mssonicbld commented Jul 1, 2026

Uh oh!

azure-pipelines Bot commented Jul 1, 2026

Uh oh!

Uh oh!

roeebar-arista commented Jul 1, 2026

Uh oh!

justin-wong-ce commented Jul 9, 2026

Uh oh!

lunyue-ms commented Jul 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Conversation

lunyue-ms commented Jul 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What I did

How I did it

How to verify it

Previous command output (if the output of a command-line utility has changed)

New command output (if the output of a command-line utility has changed)

Uh oh!

mssonicbld commented Jul 1, 2026

Uh oh!

azure-pipelines Bot commented Jul 1, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

roeebar-arista Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

lunyue-ms Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

mssonicbld commented Jul 1, 2026

Uh oh!

azure-pipelines Bot commented Jul 1, 2026

Uh oh!

Uh oh!

roeebar-arista commented Jul 1, 2026

Uh oh!

justin-wong-ce commented Jul 9, 2026

Uh oh!

lunyue-ms commented Jul 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

lunyue-ms commented Jul 1, 2026 •

edited

Loading