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/parse_shebang_test.py at main · GruffElixir/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 }}
GruffElixir
/
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
/
parse_shebang_test.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
154 lines (109 loc) · 4.56 KB
main
Breadcrumbs
pre-commit
/
tests
/
parse_shebang_test.py
Copy path
Top
File metadata and controls
Code
Blame
154 lines (109 loc) · 4.56 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
from
__future__
import
annotations
import
contextlib
import
os
.
path
import
shutil
import
sys
import
pytest
from
pre_commit
import
parse_shebang
from
pre_commit
.
envcontext
import
envcontext
from
pre_commit
.
envcontext
import
Var
from
pre_commit
.
util
import
make_executable
def
_echo_exe
()
->
str
:
exe
=
shutil
.
which
(
'echo'
)
assert
exe
is
not
None
return
exe
def
test_file_doesnt_exist
():
assert
parse_shebang
.
parse_filename
(
'herp derp derp'
)
==
()
def
test_simple_case
(
tmpdir
):
x
=
tmpdir
.
join
(
'f'
)
x
.
write
(
'#!/usr/bin/env echo'
)
make_executable
(
x
.
strpath
)
assert
parse_shebang
.
parse_filename
(
x
.
strpath
)
==
(
'echo'
,)
def
test_find_executable_full_path
():
assert
parse_shebang
.
find_executable
(
sys
.
executable
)
==
sys
.
executable
def
test_find_executable_on_path
():
assert
parse_shebang
.
find_executable
(
'echo'
)
==
_echo_exe
()
def
test_find_executable_not_found_none
():
assert
parse_shebang
.
find_executable
(
'not-a-real-executable'
)
is
None
def
write_executable
(
shebang
,
filename
=
'run'
):
os
.
mkdir
(
'bin'
)
path
=
os
.
path
.
join
(
'bin'
,
filename
)
with
open
(
path
,
'w'
)
as
f
:
f
.
write
(
f'#!
{
shebang
}
'
)
make_executable
(
path
)
return
path
@
contextlib
.
contextmanager
def
bin_on_path
():
bindir
=
os
.
path
.
join
(
os
.
getcwd
(),
'bin'
)
with
envcontext
(((
'PATH'
, (
bindir
,
os
.
pathsep
,
Var
(
'PATH'
))),)):
yield
def
test_find_executable_path_added
(
in_tmpdir
):
path
=
os
.
path
.
abspath
(
write_executable
(
'/usr/bin/env sh'
))
assert
parse_shebang
.
find_executable
(
'run'
)
is
None
with
bin_on_path
():
assert
parse_shebang
.
find_executable
(
'run'
)
==
path
def
test_find_executable_path_ext
(
in_tmpdir
):
"""Windows exports PATHEXT as a list of extensions to automatically add
to executables when doing PATH searching.
"""
exe_path
=
os
.
path
.
abspath
(
write_executable
(
'/usr/bin/env sh'
,
filename
=
'run.myext'
),
)
env_path
=
{
'PATH'
:
os
.
path
.
dirname
(
exe_path
)}
env_path_ext
=
dict
(
env_path
,
PATHEXT
=
os
.
pathsep
.
join
((
'.exe'
,
'.myext'
)))
assert
parse_shebang
.
find_executable
(
'run'
)
is
None
assert
parse_shebang
.
find_executable
(
'run'
,
env
=
env_path
)
is
None
ret
=
parse_shebang
.
find_executable
(
'run.myext'
,
env
=
env_path
)
assert
ret
==
exe_path
ret
=
parse_shebang
.
find_executable
(
'run'
,
env
=
env_path_ext
)
assert
ret
==
exe_path
def
test_normexe_does_not_exist
():
with
pytest
.
raises
(
OSError
)
as
excinfo
:
parse_shebang
.
normexe
(
'i-dont-exist-lol'
)
assert
excinfo
.
value
.
args
==
(
'Executable `i-dont-exist-lol` not found'
,)
def
test_normexe_does_not_exist_sep
():
with
pytest
.
raises
(
OSError
)
as
excinfo
:
parse_shebang
.
normexe
(
'./i-dont-exist-lol'
)
assert
excinfo
.
value
.
args
==
(
'Executable `./i-dont-exist-lol` not found'
,)
@
pytest
.
mark
.
xfail
(
sys
.
platform
==
'win32'
,
reason
=
'posix only'
)
def
test_normexe_not_executable
(
tmpdir
):
# pragma: win32 no cover
tmpdir
.
join
(
'exe'
).
ensure
()
with
tmpdir
.
as_cwd
(),
pytest
.
raises
(
OSError
)
as
excinfo
:
parse_shebang
.
normexe
(
'./exe'
)
assert
excinfo
.
value
.
args
==
(
'Executable `./exe` is not executable'
,)
def
test_normexe_is_a_directory
(
tmpdir
):
with
tmpdir
.
as_cwd
():
tmpdir
.
join
(
'exe'
).
ensure_dir
()
exe
=
os
.
path
.
join
(
'.'
,
'exe'
)
with
pytest
.
raises
(
OSError
)
as
excinfo
:
parse_shebang
.
normexe
(
exe
)
msg
,
=
excinfo
.
value
.
args
assert
msg
==
f'Executable `
{
exe
}
` is a directory'
def
test_normexe_already_full_path
():
assert
parse_shebang
.
normexe
(
sys
.
executable
)
==
sys
.
executable
def
test_normexe_gives_full_path
():
assert
parse_shebang
.
normexe
(
'echo'
)
==
_echo_exe
()
assert
os
.
sep
in
_echo_exe
()
def
test_normalize_cmd_trivial
():
cmd
=
(
_echo_exe
(),
'hi'
)
assert
parse_shebang
.
normalize_cmd
(
cmd
)
==
cmd
def
test_normalize_cmd_PATH
():
cmd
=
(
'echo'
,
'--version'
)
expected
=
(
_echo_exe
(),
'--version'
)
assert
parse_shebang
.
normalize_cmd
(
cmd
)
==
expected
def
test_normalize_cmd_shebang
(
in_tmpdir
):
us
=
sys
.
executable
.
replace
(
os
.
sep
,
'/'
)
path
=
write_executable
(
us
)
assert
parse_shebang
.
normalize_cmd
((
path
,))
==
(
us
,
path
)
def
test_normalize_cmd_PATH_shebang_full_path
(
in_tmpdir
):
us
=
sys
.
executable
.
replace
(
os
.
sep
,
'/'
)
path
=
write_executable
(
us
)
with
bin_on_path
():
ret
=
parse_shebang
.
normalize_cmd
((
'run'
,))
assert
ret
==
(
us
,
os
.
path
.
abspath
(
path
))
def
test_normalize_cmd_PATH_shebang_PATH
(
in_tmpdir
):
echo
=
_echo_exe
()
path
=
write_executable
(
'/usr/bin/env echo'
)
with
bin_on_path
():
ret
=
parse_shebang
.
normalize_cmd
((
'run'
,))
assert
ret
==
(
echo
,
os
.
path
.
abspath
(
path
))
You can’t perform that action at this time.