Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
pre-commit/tests/languages/docker_test.py at main · hack3ric/pre-commit · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
hack3ric
/
pre-commit
Public
forked from
pre-commit/pre-commit
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
0
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Security and quality
Insights
Files
Expand file tree
main
Breadcrumbs
pre-commit
/
tests
/
languages
/
docker_test.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
197 lines (143 loc) · 6.28 KB
main
Breadcrumbs
pre-commit
/
tests
/
languages
/
docker_test.py
Copy path
Top
File metadata and controls
Code
Blame
197 lines (143 loc) · 6.28 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
from
__future__
import
annotations
import
builtins
import
json
import
ntpath
import
os
.
path
import
posixpath
from
unittest
import
mock
import
pytest
from
pre_commit
.
languages
import
docker
from
pre_commit
.
util
import
CalledProcessError
from
testing
.
language_helpers
import
run_language
from
testing
.
util
import
xfailif_windows
DOCKER_CGROUP_EXAMPLE
=
b'''
\
12:hugetlb:/docker/c33988ec7651ebc867cb24755eaf637a6734088bc7eef59d5799293a9e5450f7
11:blkio:/docker/c33988ec7651ebc867cb24755eaf637a6734088bc7eef59d5799293a9e5450f7
10:freezer:/docker/c33988ec7651ebc867cb24755eaf637a6734088bc7eef59d5799293a9e5450f7
9:cpu,cpuacct:/docker/c33988ec7651ebc867cb24755eaf637a6734088bc7eef59d5799293a9e5450f7
8:pids:/docker/c33988ec7651ebc867cb24755eaf637a6734088bc7eef59d5799293a9e5450f7
7:rdma:/
6:net_cls,net_prio:/docker/c33988ec7651ebc867cb24755eaf637a6734088bc7eef59d5799293a9e5450f7
5:cpuset:/docker/c33988ec7651ebc867cb24755eaf637a6734088bc7eef59d5799293a9e5450f7
4:devices:/docker/c33988ec7651ebc867cb24755eaf637a6734088bc7eef59d5799293a9e5450f7
3:memory:/docker/c33988ec7651ebc867cb24755eaf637a6734088bc7eef59d5799293a9e5450f7
2:perf_event:/docker/c33988ec7651ebc867cb24755eaf637a6734088bc7eef59d5799293a9e5450f7
1:name=systemd:/docker/c33988ec7651ebc867cb24755eaf637a6734088bc7eef59d5799293a9e5450f7
0::/system.slice/containerd.service
'''
# noqa: E501
# The ID should match the above cgroup example.
CONTAINER_ID
=
'c33988ec7651ebc867cb24755eaf637a6734088bc7eef59d5799293a9e5450f7'
# noqa: E501
NON_DOCKER_CGROUP_EXAMPLE
=
b'''
\
12:perf_event:/
11:hugetlb:/
10:devices:/
9:blkio:/
8:rdma:/
7:cpuset:/
6:cpu,cpuacct:/
5:freezer:/
4:memory:/
3:pids:/
2:net_cls,net_prio:/
1:name=systemd:/init.scope
0::/init.scope
'''
def
test_docker_fallback_user
():
def
invalid_attribute
():
raise
AttributeError
with
mock
.
patch
.
multiple
(
'os'
,
create
=
True
,
getuid
=
invalid_attribute
,
getgid
=
invalid_attribute
,
):
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
def
_mock_open
(
data
):
return
mock
.
patch
.
object
(
builtins
,
'open'
,
new_callable
=
mock
.
mock_open
,
read_data
=
data
,
)
def
test_in_docker_docker_in_file
():
with
_mock_open
(
DOCKER_CGROUP_EXAMPLE
):
assert
docker
.
_is_in_docker
()
is
True
def
test_in_docker_docker_not_in_file
():
with
_mock_open
(
NON_DOCKER_CGROUP_EXAMPLE
):
assert
docker
.
_is_in_docker
()
is
False
def
test_get_container_id
():
with
_mock_open
(
DOCKER_CGROUP_EXAMPLE
):
assert
docker
.
_get_container_id
()
==
CONTAINER_ID
def
test_get_container_id_failure
():
with
_mock_open
(
b''
),
pytest
.
raises
(
RuntimeError
):
docker
.
_get_container_id
()
def
test_get_docker_path_not_in_docker_returns_same
():
with
mock
.
patch
.
object
(
docker
,
'_is_in_docker'
,
return_value
=
False
):
assert
docker
.
_get_docker_path
(
'abc'
)
==
'abc'
@
pytest
.
fixture
def
in_docker
():
with
mock
.
patch
.
object
(
docker
,
'_is_in_docker'
,
return_value
=
True
):
with
mock
.
patch
.
object
(
docker
,
'_get_container_id'
,
return_value
=
CONTAINER_ID
,
):
yield
def
_linux_commonpath
():
return
mock
.
patch
.
object
(
os
.
path
,
'commonpath'
,
posixpath
.
commonpath
)
def
_nt_commonpath
():
return
mock
.
patch
.
object
(
os
.
path
,
'commonpath'
,
ntpath
.
commonpath
)
def
_docker_output
(
out
):
ret
=
(
0
,
out
,
b''
)
return
mock
.
patch
.
object
(
docker
,
'cmd_output_b'
,
return_value
=
ret
)
def
test_get_docker_path_in_docker_no_binds_same_path
(
in_docker
):
docker_out
=
json
.
dumps
([{
'Mounts'
: []}]).
encode
()
with
_docker_output
(
docker_out
):
assert
docker
.
_get_docker_path
(
'abc'
)
==
'abc'
def
test_get_docker_path_in_docker_binds_path_equal
(
in_docker
):
binds_list
=
[{
'Source'
:
'/opt/my_code'
,
'Destination'
:
'/project'
}]
docker_out
=
json
.
dumps
([{
'Mounts'
:
binds_list
}]).
encode
()
with
_linux_commonpath
(),
_docker_output
(
docker_out
):
assert
docker
.
_get_docker_path
(
'/project'
)
==
'/opt/my_code'
def
test_get_docker_path_in_docker_binds_path_complex
(
in_docker
):
binds_list
=
[{
'Source'
:
'/opt/my_code'
,
'Destination'
:
'/project'
}]
docker_out
=
json
.
dumps
([{
'Mounts'
:
binds_list
}]).
encode
()
with
_linux_commonpath
(),
_docker_output
(
docker_out
):
path
=
'/project/test/something'
assert
docker
.
_get_docker_path
(
path
)
==
'/opt/my_code/test/something'
def
test_get_docker_path_in_docker_no_substring
(
in_docker
):
binds_list
=
[{
'Source'
:
'/opt/my_code'
,
'Destination'
:
'/project'
}]
docker_out
=
json
.
dumps
([{
'Mounts'
:
binds_list
}]).
encode
()
with
_linux_commonpath
(),
_docker_output
(
docker_out
):
path
=
'/projectSuffix/test/something'
assert
docker
.
_get_docker_path
(
path
)
==
path
def
test_get_docker_path_in_docker_binds_path_many_binds
(
in_docker
):
binds_list
=
[
{
'Source'
:
'/something_random'
,
'Destination'
:
'/not-related'
},
{
'Source'
:
'/opt/my_code'
,
'Destination'
:
'/project'
},
{
'Source'
:
'/something-random-2'
,
'Destination'
:
'/not-related-2'
},
]
docker_out
=
json
.
dumps
([{
'Mounts'
:
binds_list
}]).
encode
()
with
_linux_commonpath
(),
_docker_output
(
docker_out
):
assert
docker
.
_get_docker_path
(
'/project'
)
==
'/opt/my_code'
def
test_get_docker_path_in_docker_windows
(
in_docker
):
binds_list
=
[{
'Source'
:
r'c:\users\user'
,
'Destination'
:
r'c:\folder'
}]
docker_out
=
json
.
dumps
([{
'Mounts'
:
binds_list
}]).
encode
()
with
_nt_commonpath
(),
_docker_output
(
docker_out
):
path
=
r'c:\folder\test\something'
expected
=
r'c:\users\user\test\something'
assert
docker
.
_get_docker_path
(
path
)
==
expected
def
test_get_docker_path_in_docker_docker_in_docker
(
in_docker
):
# won't be able to discover "self" container in true docker-in-docker
err
=
CalledProcessError
(
1
, (),
b''
,
b''
)
with
mock
.
patch
.
object
(
docker
,
'cmd_output_b'
,
side_effect
=
err
):
assert
docker
.
_get_docker_path
(
'/project'
)
==
'/project'
@
xfailif_windows
# pragma: win32 no cover
def
test_docker_hook
(
tmp_path
):
dockerfile
=
'''
\
FROM ubuntu:22.04
CMD ["echo", "This is overwritten by the entry"']
'''
tmp_path
.
joinpath
(
'Dockerfile'
).
write_text
(
dockerfile
)
ret
=
run_language
(
tmp_path
,
docker
,
'echo hello hello world'
)
assert
ret
==
(
0
,
b'hello hello world
\n
'
)
You can’t perform that action at this time.