Skip to content

gh-108747: Add unit tests for site.{usercustomize,sitecustomize} hooks #109470

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.

Sign up for GitHub

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
merged 12 commits into from
Oct 18, 2023
+40 −0
Merged

gh-108747: Add unit tests for site.{usercustomize,sitecustomize} hooks #109470

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
c9145ea
Add unit tests for site.{usercustomize,sitecustomize} hooks
csm10495 Sep 15, 2023
e442411
Check -s for usercustomize
csm10495 Sep 15, 2023
fcd24db
Fix to not need shell on posix
csm10495 Sep 15, 2023
d1f75de
Apparently these dirs don't have to exist
csm10495 Sep 15, 2023
0b00ba3
On certain configurations, skip part of test
csm10495 Sep 15, 2023
63907f9
make eyecatcher include more info to be sure its working
csm10495 Sep 15, 2023
8a14f39
try again?
csm10495 Sep 16, 2023
b870a6f
try again?
csm10495 Sep 16, 2023
c78aedd
Fix?
csm10495 Sep 16, 2023
22337a9
Fix?
csm10495 Sep 16, 2023
cbad68d
Fix?
csm10495 Sep 16, 2023
cc0e3bb
Clean up test based off pr suggestions
csm10495 Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions Lib/test/test_site.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,44 @@ def test_sitecustomize_executed(self):
else:
self.fail("sitecustomize not imported automatically")

@support.requires_subprocess()
def test_customization_modules_on_startup(self):
mod_names = [
'sitecustomize'
]

if site.ENABLE_USER_SITE:
mod_names.append('usercustomize')

temp_dir = tempfile.mkdtemp()
self.addCleanup(os_helper.rmtree, temp_dir)

with EnvironmentVarGuard() as environ:
environ['PYTHONPATH'] = temp_dir

for module_name in mod_names:
os_helper.rmtree(temp_dir)
os.mkdir(temp_dir)

customize_path = os.path.join(temp_dir, f'{module_name}.py')
eyecatcher = f'EXECUTED_{module_name}'

with open(customize_path, 'w') as f:
f.write(f'print("{eyecatcher}")')

output = subprocess.check_output([sys.executable, '-c', '""'])
self.assertIn(eyecatcher, output.decode('utf-8'))

# -S blocks any site-packages
output = subprocess.check_output([sys.executable, '-S', '-c', '""'])
self.assertNotIn(eyecatcher, output.decode('utf-8'))

# -s blocks user site-packages
if 'usercustomize' == module_name:
output = subprocess.check_output([sys.executable, '-s', '-c', '""'])
self.assertNotIn(eyecatcher, output.decode('utf-8'))


@unittest.skipUnless(hasattr(urllib.request, "HTTPSHandler"),
'need SSL support to download license')
@test.support.requires_resource('network')
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Tests/2023-09-15-15-00-14.gh-issue-108747.ql0owS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add unit test for ``usercustomize`` and ``sitecustomize`` hooks from
:class:`site`.