GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — Fix permission errors for mounts in rootless docker by matthewhughes934 · Pull Request #3446 · pre-commit/pre-commit

Fix permission errors for mounts in rootless docker #3446

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

Merged

asottile merged 1 commit into pre-commit:main from matthewhughes934:fix-docker-rootless-permission-mounts

May 23, 2025

Uh oh!

There was an error while loading. Please reload this page.

Merged

Fix permission errors for mounts in rootless docker #3446

Show file tree

Hide file tree

Changes from all commits

Commits

Show all changes

1 commit

Select commit

466f6c4

Fix permission errors for mounts in rootless docker

matthewhughes934 Apr 13, 2025

File filter

Filter by extension .py (2) All 1 file type selected

Viewed files

Clear filters

Conversations

Failed to load comments.

Uh oh!

There was an error while loading. Please reload this page.

Jump to

Jump to file

Failed to load files.

Uh oh!

There was an error while loading. Please reload this page.

Diff view

Unified

Split

Hide whitespace

Diff view

Unified

Split

Hide whitespace

There are no files selected for viewing

26 changes: 26 additions & 0 deletions 26 pre_commit/languages/docker.py

Show comments

View file

Open in desktop

Original file line number	Diff line number	Diff line change
		@@ -1,5 +1,6 @@
		from __future__ import annotations

		import functools
		import hashlib
		import json
		import os
Expand Down Expand Up		@@ -101,7 +102,32 @@ def install_environment(
		os.mkdir(directory)


		@functools.lru_cache(maxsize=1)
		def _is_rootless() -> bool: # pragma: win32 no cover
		retcode, out, _ = cmd_output_b(
		'docker', 'system', 'info', '--format', '{{ json . }}',
		)
		if retcode != 0:
		return False

		info = json.loads(out)
		try:
		return (
		# docker:
		# https://docs.docker.com/reference/api/engine/version/v1.48/#tag/System/operation/SystemInfo
		'name=rootless' in info.get('SecurityOptions', ()) or
		# podman:
		# https://docs.podman.io/en/latest/_static/api.html?version=v5.4#tag/system/operation/SystemInfoLibpod
		info['host']['security']['rootless']
		)
		except KeyError:
		return False


		def get_docker_user() -> tuple[str, ...]: # pragma: win32 no cover
		if _is_rootless():
		return ()

		try:
		return ('-u', f'{os.getuid()}:{os.getgid()}')
		except AttributeError:
Expand Down

47 changes: 47 additions & 0 deletions 47 tests/languages/docker_test.py

Show comments

View file

Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -62,6 +62,42 @@ def invalid_attribute():
		assert docker.get_docker_user() == ()


		@pytest.fixture(autouse=True)
		def _avoid_cache():
		with mock.patch.object(
		docker,
		'_is_rootless',
		docker._is_rootless.__wrapped__,
		):
		yield


		@pytest.mark.parametrize(
		'info_ret',
		(
		(0, b'{"SecurityOptions": ["name=rootless","name=cgroupns"]}', b''),
		(0, b'{"host": {"security": {"rootless": true}}}', b''),
		),
		)
		def test_docker_user_rootless(info_ret):
		with mock.patch.object(docker, 'cmd_output_b', return_value=info_ret):
		assert docker.get_docker_user() == ()


		@pytest.mark.parametrize(
		'info_ret',
		(
		(0, b'{"SecurityOptions": ["name=cgroupns"]}', b''),
		(0, b'{"host": {"security": {"rootless": false}}}', b''),
		(0, b'{"respone_from_some_other_container_engine": true}', b''),
		(1, b'', b''),
		),
		)
		def test_docker_user_non_rootless(info_ret):
		with mock.patch.object(docker, 'cmd_output_b', return_value=info_ret):
		assert docker.get_docker_user() != ()


		def test_in_docker_no_file():
		with mock.patch.object(builtins, 'open', side_effect=FileNotFoundError):
		assert docker._is_in_docker() is False
Expand Down Expand Up		@@ -195,3 +231,14 @@ def test_docker_hook(tmp_path):

		ret = run_language(tmp_path, docker, 'echo hello hello world')
		assert ret == (0, b'hello hello world\n')


		@xfailif_windows # pragma: win32 no cover
		def test_docker_hook_mount_permissions(tmp_path):
		dockerfile = '''\
		FROM ubuntu:22.04
		'''
		tmp_path.joinpath('Dockerfile').write_text(dockerfile)

		retcode, _ = run_language(tmp_path, docker, 'touch', ('README.md',))
		assert retcode == 0

Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.