Skip to content

[tests] JavaScript: developer/test-facing tweaks to fixture generation. #12531

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 4 commits into from
Jul 10, 2024
Merged

[tests] JavaScript: developer/test-facing tweaks to fixture generation. #12531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5a97e16
Tests: JavaScript fixtures: developer/testing experience improvements.
jayaddison Jul 10, 2024
efd4abc
Linting: use list comprehensions instead of ``list`` initialization, …
jayaddison Jul 10, 2024
3e4c17a
[utils] Use potentially-significantly-optimized ``shutil.copy2`` inst…
jayaddison Jul 10, 2024
c1e109b
Fixup: add required import.
jayaddison Jul 10, 2024
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
6 changes: 5 additions & 1 deletion tests/test_search.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@

from tests.utils import TESTS_ROOT

JAVASCRIPT_TEST_ROOTS = list((TESTS_ROOT / 'js' / 'roots').iterdir())
JAVASCRIPT_TEST_ROOTS = [
directory
for directory in (TESTS_ROOT / 'js' / 'roots').iterdir()
if (directory / 'conf.py').exists()
]


class DummyEnvironment:
Expand Down
13 changes: 9 additions & 4 deletions utils/generate_js_fixtures.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
#!/usr/bin/env python3

import shutil
import subprocess
from pathlib import Path

SPHINX_ROOT = Path(__file__).resolve().parent.parent
TEST_JS_FIXTURES = SPHINX_ROOT / 'tests' / 'js' / 'fixtures'
TEST_JS_ROOTS = SPHINX_ROOT / 'tests' / 'js' / 'roots'
TEST_JS_ROOTS = [
directory
for directory in (SPHINX_ROOT / 'tests' / 'js' / 'roots').iterdir()
if (directory / 'conf.py').exists()
]


def build(srcdir: Path) -> None:
Expand All @@ -20,15 +25,15 @@ def build(srcdir: Path) -> None:
subprocess.run(cmd, check=True, capture_output=True)


for directory in TEST_JS_ROOTS.iterdir():
for directory in TEST_JS_ROOTS:
searchindex = directory / '_build' / 'searchindex.js'
destination = TEST_JS_FIXTURES / directory.name / 'searchindex.js'

print(f'Building {directory} ... ', end='')
build(directory)
print('done')

print(f'Moving {searchindex} to {destination} ... ', end='')
print(f'Copying {searchindex} to {destination} ... ', end='')
destination.parent.mkdir(exist_ok=True)
searchindex.replace(destination)
shutil.copy2(searchindex, destination)
print('done')