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/store_test.py at main · ruthra-kumar/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 }}
ruthra-kumar
/
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
/
store_test.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
247 lines (188 loc) · 7.48 KB
main
Breadcrumbs
pre-commit
/
tests
/
store_test.py
Copy path
Top
File metadata and controls
Code
Blame
247 lines (188 loc) · 7.48 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
from
__future__
import
annotations
import
os
.
path
import
sqlite3
import
stat
from
unittest
import
mock
import
pytest
from
pre_commit
import
git
from
pre_commit
.
store
import
_get_default_directory
from
pre_commit
.
store
import
Store
from
pre_commit
.
util
import
CalledProcessError
from
pre_commit
.
util
import
cmd_output
from
testing
.
fixtures
import
git_dir
from
testing
.
util
import
cwd
from
testing
.
util
import
git_commit
from
testing
.
util
import
xfailif_windows
def
test_our_session_fixture_works
():
"""There's a session fixture which makes `Store` invariantly raise to
prevent writing to the home directory.
"""
with
pytest
.
raises
(
AssertionError
):
Store
()
def
test_get_default_directory_defaults_to_home
():
# Not we use the module level one which is not mocked
ret
=
_get_default_directory
()
expected
=
os
.
path
.
realpath
(
os
.
path
.
expanduser
(
'~/.cache/pre-commit'
))
assert
ret
==
expected
def
test_adheres_to_xdg_specification
():
with
mock
.
patch
.
dict
(
os
.
environ
, {
'XDG_CACHE_HOME'
:
'/tmp/fakehome'
},
):
ret
=
_get_default_directory
()
expected
=
os
.
path
.
realpath
(
'/tmp/fakehome/pre-commit'
)
assert
ret
==
expected
def
test_uses_environment_variable_when_present
():
with
mock
.
patch
.
dict
(
os
.
environ
, {
'PRE_COMMIT_HOME'
:
'/tmp/pre_commit_home'
},
):
ret
=
_get_default_directory
()
expected
=
os
.
path
.
realpath
(
'/tmp/pre_commit_home'
)
assert
ret
==
expected
def
test_store_init
(
store
):
# Should create the store directory
assert
os
.
path
.
exists
(
store
.
directory
)
# Should create a README file indicating what the directory is about
with
open
(
os
.
path
.
join
(
store
.
directory
,
'README'
))
as
readme_file
:
readme_contents
=
readme_file
.
read
()
for
text_line
in
(
'This directory is maintained by the pre-commit project.'
,
'Learn more: https://github.com/pre-commit/pre-commit'
,
):
assert
text_line
in
readme_contents
def
test_clone
(
store
,
tempdir_factory
,
log_info_mock
):
path
=
git_dir
(
tempdir_factory
)
with
cwd
(
path
):
git_commit
()
rev
=
git
.
head_rev
(
path
)
git_commit
()
ret
=
store
.
clone
(
path
,
rev
)
# Should have printed some stuff
assert
log_info_mock
.
call_args_list
[
0
][
0
][
0
].
startswith
(
'Initializing environment for '
,
)
# Should return a directory inside of the store
assert
os
.
path
.
exists
(
ret
)
assert
ret
.
startswith
(
store
.
directory
)
# Directory should start with `repo`
_
,
dirname
=
os
.
path
.
split
(
ret
)
assert
dirname
.
startswith
(
'repo'
)
# Should be checked out to the rev we specified
assert
git
.
head_rev
(
ret
)
==
rev
# Assert there's an entry in the sqlite db for this
assert
store
.
select_all_repos
()
==
[(
path
,
rev
,
ret
)]
def
test_clone_cleans_up_on_checkout_failure
(
store
):
with
pytest
.
raises
(
Exception
)
as
excinfo
:
# This raises an exception because you can't clone something that
# doesn't exist!
store
.
clone
(
'/i_dont_exist_lol'
,
'fake_rev'
)
assert
'/i_dont_exist_lol'
in
str
(
excinfo
.
value
)
repo_dirs
=
[
d
for
d
in
os
.
listdir
(
store
.
directory
)
if
d
.
startswith
(
'repo'
)
]
assert
repo_dirs
==
[]
def
test_clone_when_repo_already_exists
(
store
):
# Create an entry in the sqlite db that makes it look like the repo has
# been cloned.
with
sqlite3
.
connect
(
store
.
db_path
)
as
db
:
db
.
execute
(
'INSERT INTO repos (repo, ref, path) '
'VALUES ("fake_repo", "fake_ref", "fake_path")'
,
)
assert
store
.
clone
(
'fake_repo'
,
'fake_ref'
)
==
'fake_path'
def
test_clone_shallow_failure_fallback_to_complete
(
store
,
tempdir_factory
,
log_info_mock
,
):
path
=
git_dir
(
tempdir_factory
)
with
cwd
(
path
):
git_commit
()
rev
=
git
.
head_rev
(
path
)
git_commit
()
# Force shallow clone failure
def
fake_shallow_clone
(
self
,
*
args
,
**
kwargs
):
raise
CalledProcessError
(
1
, (),
0
,
b''
,
None
)
store
.
_shallow_clone
=
fake_shallow_clone
ret
=
store
.
clone
(
path
,
rev
)
# Should have printed some stuff
assert
log_info_mock
.
call_args_list
[
0
][
0
][
0
].
startswith
(
'Initializing environment for '
,
)
# Should return a directory inside of the store
assert
os
.
path
.
exists
(
ret
)
assert
ret
.
startswith
(
store
.
directory
)
# Directory should start with `repo`
_
,
dirname
=
os
.
path
.
split
(
ret
)
assert
dirname
.
startswith
(
'repo'
)
# Should be checked out to the rev we specified
assert
git
.
head_rev
(
ret
)
==
rev
# Assert there's an entry in the sqlite db for this
assert
store
.
select_all_repos
()
==
[(
path
,
rev
,
ret
)]
def
test_clone_tag_not_on_mainline
(
store
,
tempdir_factory
):
path
=
git_dir
(
tempdir_factory
)
with
cwd
(
path
):
git_commit
()
cmd_output
(
'git'
,
'checkout'
,
'master'
,
'-b'
,
'branch'
)
git_commit
()
cmd_output
(
'git'
,
'tag'
,
'v1'
)
cmd_output
(
'git'
,
'checkout'
,
'master'
)
cmd_output
(
'git'
,
'branch'
,
'-D'
,
'branch'
)
# previously crashed on unreachable refs
store
.
clone
(
path
,
'v1'
)
def
test_create_when_directory_exists_but_not_db
(
store
):
# In versions <= 0.3.5, there was no sqlite db causing a need for
# backward compatibility
os
.
remove
(
store
.
db_path
)
store
=
Store
(
store
.
directory
)
assert
os
.
path
.
exists
(
store
.
db_path
)
def
test_create_when_store_already_exists
(
store
):
# an assertion that this is idempotent and does not crash
Store
(
store
.
directory
)
def
test_db_repo_name
(
store
):
assert
store
.
db_repo_name
(
'repo'
, ())
==
'repo'
assert
store
.
db_repo_name
(
'repo'
, (
'b'
,
'a'
,
'c'
))
==
'repo:a,b,c'
def
test_local_resources_reflects_reality
():
on_disk
=
{
res
[
len
(
'empty_template_'
):]
for
res
in
os
.
listdir
(
'pre_commit/resources'
)
if
res
.
startswith
(
'empty_template_'
)
}
assert
on_disk
==
{
os
.
path
.
basename
(
x
)
for
x
in
Store
.
LOCAL_RESOURCES
}
def
test_mark_config_as_used
(
store
,
tmpdir
):
with
tmpdir
.
as_cwd
():
f
=
tmpdir
.
join
(
'f'
).
ensure
()
store
.
mark_config_used
(
'f'
)
assert
store
.
select_all_configs
()
==
[
f
.
strpath
]
def
test_mark_config_as_used_idempotent
(
store
,
tmpdir
):
test_mark_config_as_used
(
store
,
tmpdir
)
test_mark_config_as_used
(
store
,
tmpdir
)
def
test_mark_config_as_used_does_not_exist
(
store
):
store
.
mark_config_used
(
'f'
)
assert
store
.
select_all_configs
()
==
[]
def
_simulate_pre_1_14_0
(
store
):
with
store
.
connect
()
as
db
:
db
.
executescript
(
'DROP TABLE configs'
)
def
test_select_all_configs_roll_forward
(
store
):
_simulate_pre_1_14_0
(
store
)
assert
store
.
select_all_configs
()
==
[]
def
test_mark_config_as_used_roll_forward
(
store
,
tmpdir
):
_simulate_pre_1_14_0
(
store
)
test_mark_config_as_used
(
store
,
tmpdir
)
@
xfailif_windows
# pragma: win32 no cover
def
test_mark_config_as_used_readonly
(
tmpdir
):
cfg
=
tmpdir
.
join
(
'f'
).
ensure
()
store_dir
=
tmpdir
.
join
(
'store'
)
# make a store, then we'll convert its directory to be readonly
assert
not
Store
(
str
(
store_dir
)).
readonly
# directory didn't exist
assert
not
Store
(
str
(
store_dir
)).
readonly
# directory did exist
def
_chmod_minus_w
(
p
):
st
=
os
.
stat
(
p
)
os
.
chmod
(
p
,
st
.
st_mode
&
~
(
stat
.
S_IWUSR
|
stat
.
S_IWOTH
|
stat
.
S_IWGRP
))
_chmod_minus_w
(
store_dir
)
for
fname
in
os
.
listdir
(
store_dir
):
assert
not
os
.
path
.
isdir
(
fname
)
_chmod_minus_w
(
os
.
path
.
join
(
store_dir
,
fname
))
store
=
Store
(
str
(
store_dir
))
assert
store
.
readonly
# should be skipped due to readonly
store
.
mark_config_used
(
str
(
cfg
))
assert
store
.
select_all_configs
()
==
[]
You can’t perform that action at this time.