Skip to content

Fix README tests #2

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

Closed
google-labs-jules wants to merge 1 commit into from
Closed

Fix README tests #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
47 changes: 11 additions & 36 deletions tests/test_readme.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,59 +8,34 @@


@patch("subprocess.run")
def test_example_1(mock, tmp_path, capfd):
block = get_toml_blocks_from_readme("publish")
def test_readme_example_1(mock, tmp_path, capfd):
block = get_toml_blocks_from_readme("Start dev server")
fn = tmp_path / "pyproject.toml"
fn.write_text(block)

_main(["-c", str(fn)])
check_outerr(
capfd,
snapshot("""\
\x1b[92mdev \x1b[0m: Start dev server (default on port 5001)
\x1b[92mpublish \x1b[0m: Publish to PyPI
\x1b[92mpyi \x1b[0m: Generate pyi stubs (python function)\
"""),
snapshot(
"""\
\x1b[92mdev \x1b[0m: Start dev server
\x1b[92mtest \x1b[0m: Run tests\
"""
),
)

_main(["-c", str(fn), "dev"])
mock.assert_called_once_with(
"uv run uvicorn --port 5001 superapp.main:app --reload", shell=True
"uv run uvicorn --port 5000 superapp.main:app --reload", shell=True
)

mock.reset_mock()
_main(["-c", str(fn), "dev", "--port", "8000"])
_main(["-c", str(fn), "dev", "--port", "8001"])
mock.assert_called_once_with(
"uv run uvicorn --port 8000 superapp.main:app --reload", shell=True
"uv run uvicorn --port 8001 superapp.main:app --reload", shell=True
)


def test_example_2(tmp_path, capfd):
block = get_toml_blocks_from_readme("Rendering documentation")
fn = tmp_path / "pyproject.toml"
fn.write_text(block)
_main(["-c", str(fn)])
check_outerr(
capfd,
snapshot("""\
\x1b[92mdoc \x1b[0m: Documentation for `doc` function
\x1b[92mhello \x1b[0m: This line is the documentation for `hello` function
\x1b[92mrun2 \x1b[0m: Run python function run2 from tests.myscript module
\x1b[92mdev \x1b[0m: A command with arguments and default values
\x1b[92mtest \x1b[0m: Lint and test\
"""),
)

_main(["-c", str(fn), "hello"])
check_outerr(capfd, "Hello world")

_main(["-c", str(fn), "doc"])
check_outerr(capfd, "Rendering documentation...")

_main(["-c", str(fn), "--debug", "1", "doc"])
assert "Rendering documentation..." in capfd.readouterr().out


def test_all(tmp_path, capfd):
fn = Path("README.md")
blocks = re.findall(r"^```toml\n(.*?)\n```", fn.read_text(), re.MULTILINE | re.DOTALL)
Expand Down
Loading