Skip to content

Optimize Docker image pull #3573

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

Closed
artnc wants to merge 1 commit into from
Closed

Optimize Docker image pull #3573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions pre_commit/languages/docker_image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,18 @@ def run_hook(
require_serial: bool,
color: bool,
) -> tuple[int, bytes]: # pragma: win32 no cover
cmd = docker_cmd(color=color) + lang_base.hook_cmd(entry, args)
cmd = lang_base.hook_cmd(entry, args)

# To prevent duplicate simultaneous image pull attempts in `run_xargs`, we
# try to precache the Docker image by pulling it here first
try:
image_name = cmd[2 if cmd[0] == '--entrypoint' else 0]

@asottile asottile Nov 8, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this won't work reliably at all

lang_base.setup_cmd(prefix, ('docker', 'pull', image_name))
except Exception:
pass
Comment on lines +33 to +34

@asottile asottile Nov 8, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

? this is never acceptable


return lang_base.run_xargs(
cmd,
docker_cmd(color=color) + cmd,
file_args,
require_serial=require_serial,
color=color,
Expand Down
34 changes: 34 additions & 0 deletions tests/languages/docker_image_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
from __future__ import annotations

from unittest.mock import patch

import pytest

from pre_commit.languages import docker_image
Expand Down Expand Up @@ -57,3 +59,35 @@ def test_docker_image_no_color_no_tty(tmp_path):
color=False,
)
assert ret == (0, b'root:x:0:\n')


@xfailif_windows # pragma: win32 no cover
@patch('pre_commit.lang_base.setup_cmd')
def test_docker_image_pre_pull_regular_entry(mock_setup, tmp_path):
ret = run_language(
tmp_path,
docker_image,
'ubuntu:22.04 echo',
args=('hello hello world',),
)
mock_setup.assert_called_once_with(
mock_setup.call_args[0][0],
('docker', 'pull', 'ubuntu:22.04'),
)
assert ret == (0, b'hello hello world\n')


@xfailif_windows # pragma: win32 no cover
@patch('pre_commit.lang_base.setup_cmd')
def test_docker_image_pre_pull_entrypoint_entry(mock_setup, tmp_path):
ret = run_language(
tmp_path,
docker_image,
'--entrypoint echo ubuntu:22.04',
args=('hello hello world',),
)
mock_setup.assert_called_once_with(
mock_setup.call_args[0][0],
('docker', 'pull', 'ubuntu:22.04'),
)
assert ret == (0, b'hello hello world\n')
Loading