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/conftest.py at main · alu-/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 }}
alu-
/
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
/
conftest.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
252 lines (205 loc) · 6.96 KB
main
Breadcrumbs
pre-commit
/
tests
/
conftest.py
Copy path
Top
File metadata and controls
Code
Blame
252 lines (205 loc) · 6.96 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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
from
__future__
import
annotations
import
functools
import
io
import
logging
import
os
.
path
from
unittest
import
mock
import
pytest
from
pre_commit
import
output
from
pre_commit
.
envcontext
import
envcontext
from
pre_commit
.
logging_handler
import
logging_handler
from
pre_commit
.
store
import
Store
from
pre_commit
.
util
import
cmd_output
from
pre_commit
.
util
import
make_executable
from
testing
.
fixtures
import
git_dir
from
testing
.
fixtures
import
make_consuming_repo
from
testing
.
fixtures
import
write_config
from
testing
.
util
import
cwd
from
testing
.
util
import
git_commit
@
pytest
.
fixture
def
tempdir_factory
(
tmpdir
):
class
TmpdirFactory
:
def
__init__
(
self
):
self
.
tmpdir_count
=
0
def
get
(
self
):
path
=
tmpdir
.
join
(
str
(
self
.
tmpdir_count
)).
strpath
self
.
tmpdir_count
+=
1
os
.
mkdir
(
path
)
return
path
yield
TmpdirFactory
()
@
pytest
.
fixture
def
in_tmpdir
(
tempdir_factory
):
path
=
tempdir_factory
.
get
()
with
cwd
(
path
):
yield
path
@
pytest
.
fixture
def
in_git_dir
(
tmpdir
):
repo
=
tmpdir
.
join
(
'repo'
).
ensure_dir
()
with
repo
.
as_cwd
():
cmd_output
(
'git'
,
'init'
)
yield
repo
def
_make_conflict
():
cmd_output
(
'git'
,
'checkout'
,
'origin/master'
,
'-b'
,
'foo'
)
with
open
(
'conflict_file'
,
'w'
)
as
conflict_file
:
conflict_file
.
write
(
'herp
\n
derp
\n
'
)
cmd_output
(
'git'
,
'add'
,
'conflict_file'
)
with
open
(
'foo_only_file'
,
'w'
)
as
foo_only_file
:
foo_only_file
.
write
(
'foo'
)
cmd_output
(
'git'
,
'add'
,
'foo_only_file'
)
git_commit
(
msg
=
_make_conflict
.
__name__
)
cmd_output
(
'git'
,
'checkout'
,
'origin/master'
,
'-b'
,
'bar'
)
with
open
(
'conflict_file'
,
'w'
)
as
conflict_file
:
conflict_file
.
write
(
'harp
\n
ddrp
\n
'
)
cmd_output
(
'git'
,
'add'
,
'conflict_file'
)
with
open
(
'bar_only_file'
,
'w'
)
as
bar_only_file
:
bar_only_file
.
write
(
'bar'
)
cmd_output
(
'git'
,
'add'
,
'bar_only_file'
)
git_commit
(
msg
=
_make_conflict
.
__name__
)
cmd_output
(
'git'
,
'merge'
,
'foo'
,
check
=
False
)
@
pytest
.
fixture
def
in_merge_conflict
(
tempdir_factory
):
path
=
make_consuming_repo
(
tempdir_factory
,
'script_hooks_repo'
)
open
(
os
.
path
.
join
(
path
,
'placeholder'
),
'a'
).
close
()
cmd_output
(
'git'
,
'add'
,
'placeholder'
,
cwd
=
path
)
git_commit
(
msg
=
in_merge_conflict
.
__name__
,
cwd
=
path
)
conflict_path
=
tempdir_factory
.
get
()
cmd_output
(
'git'
,
'clone'
,
path
,
conflict_path
)
with
cwd
(
conflict_path
):
_make_conflict
()
yield
os
.
path
.
join
(
conflict_path
)
@
pytest
.
fixture
def
in_conflicting_submodule
(
tempdir_factory
):
git_dir_1
=
git_dir
(
tempdir_factory
)
git_dir_2
=
git_dir
(
tempdir_factory
)
git_commit
(
msg
=
in_conflicting_submodule
.
__name__
,
cwd
=
git_dir_2
)
cmd_output
(
'git'
,
'submodule'
,
'add'
,
git_dir_2
,
'sub'
,
cwd
=
git_dir_1
)
with
cwd
(
os
.
path
.
join
(
git_dir_1
,
'sub'
)):
_make_conflict
()
yield
@
pytest
.
fixture
def
commit_msg_repo
(
tempdir_factory
):
path
=
git_dir
(
tempdir_factory
)
config
=
{
'repo'
:
'local'
,
'hooks'
: [{
'id'
:
'must-have-signoff'
,
'name'
:
'Must have "Signed off by:"'
,
'entry'
:
'grep -q "Signed off by:"'
,
'language'
:
'system'
,
'stages'
: [
'commit-msg'
],
}],
}
write_config
(
path
,
config
)
with
cwd
(
path
):
cmd_output
(
'git'
,
'add'
,
'.'
)
git_commit
(
msg
=
commit_msg_repo
.
__name__
)
yield
path
@
pytest
.
fixture
def
prepare_commit_msg_repo
(
tempdir_factory
):
path
=
git_dir
(
tempdir_factory
)
script_name
=
'add_sign_off.sh'
config
=
{
'repo'
:
'local'
,
'hooks'
: [{
'id'
:
'add-signoff'
,
'name'
:
'Add "Signed off by:"'
,
'entry'
:
f'./
{
script_name
}
'
,
'language'
:
'script'
,
'stages'
: [
'prepare-commit-msg'
],
}],
}
write_config
(
path
,
config
)
with
cwd
(
path
):
with
open
(
script_name
,
'w'
)
as
script_file
:
script_file
.
write
(
'#!/usr/bin/env bash
\n
'
'set -eu
\n
'
'echo "
\n
Signed off by: " >> "$1"
\n
'
,
)
make_executable
(
script_name
)
cmd_output
(
'git'
,
'add'
,
'.'
)
git_commit
(
msg
=
prepare_commit_msg_repo
.
__name__
)
yield
path
@
pytest
.
fixture
def
failing_prepare_commit_msg_repo
(
tempdir_factory
):
path
=
git_dir
(
tempdir_factory
)
config
=
{
'repo'
:
'local'
,
'hooks'
: [{
'id'
:
'add-signoff'
,
'name'
:
'Add "Signed off by:"'
,
'entry'
:
'bash -c "exit 1"'
,
'language'
:
'system'
,
'stages'
: [
'prepare-commit-msg'
],
}],
}
write_config
(
path
,
config
)
with
cwd
(
path
):
cmd_output
(
'git'
,
'add'
,
'.'
)
git_commit
(
msg
=
failing_prepare_commit_msg_repo
.
__name__
)
yield
path
@
pytest
.
fixture
(
autouse
=
True
,
scope
=
'session'
)
def
dont_write_to_home_directory
():
"""pre_commit.store.Store will by default write to the home directory
We'll mock out `Store.get_default_directory` to raise invariantly so we
don't construct a `Store` object that writes to our home directory.
"""
class
YouForgotToExplicitlyChooseAStoreDirectory
(
AssertionError
):
pass
with
mock
.
patch
.
object
(
Store
,
'get_default_directory'
,
side_effect
=
YouForgotToExplicitlyChooseAStoreDirectory
,
):
yield
@
pytest
.
fixture
(
autouse
=
True
,
scope
=
'session'
)
def
configure_logging
():
with
logging_handler
(
use_color
=
False
):
yield
@
pytest
.
fixture
def
mock_store_dir
(
tempdir_factory
):
tmpdir
=
tempdir_factory
.
get
()
with
mock
.
patch
.
object
(
Store
,
'get_default_directory'
,
return_value
=
tmpdir
,
):
yield
tmpdir
@
pytest
.
fixture
def
store
(
tempdir_factory
):
yield
Store
(
os
.
path
.
join
(
tempdir_factory
.
get
(),
'.pre-commit'
))
@
pytest
.
fixture
def
log_info_mock
():
with
mock
.
patch
.
object
(
logging
.
getLogger
(
'pre_commit'
),
'info'
)
as
mck
:
yield
mck
class
FakeStream
:
def
__init__
(
self
):
self
.
data
=
io
.
BytesIO
()
def
write
(
self
,
s
):
self
.
data
.
write
(
s
)
def
flush
(
self
):
pass
class
Fixture
:
def
__init__
(
self
,
stream
):
self
.
_stream
=
stream
def
get_bytes
(
self
):
"""Get the output as-if no encoding occurred"""
data
=
self
.
_stream
.
data
.
getvalue
()
self
.
_stream
.
data
.
seek
(
0
)
self
.
_stream
.
data
.
truncate
()
return
data
.
replace
(
b'
\r
\n
'
,
b'
\n
'
)
def
get
(
self
):
"""Get the output assuming it was written as UTF-8 bytes"""
return
self
.
get_bytes
().
decode
()
@
pytest
.
fixture
def
cap_out
():
stream
=
FakeStream
()
write
=
functools
.
partial
(
output
.
write
,
stream
=
stream
)
write_line_b
=
functools
.
partial
(
output
.
write_line_b
,
stream
=
stream
)
with
mock
.
patch
.
multiple
(
output
,
write
=
write
,
write_line_b
=
write_line_b
):
yield
Fixture
(
stream
)
@
pytest
.
fixture
(
scope
=
'session'
,
autouse
=
True
)
def
set_git_templatedir
(
tmpdir_factory
):
tdir
=
str
(
tmpdir_factory
.
mktemp
(
'git_template_dir'
))
with
envcontext
(((
'GIT_TEMPLATE_DIR'
,
tdir
),)):
yield
You can’t perform that action at this time.