Test README examples are up-to-date (#484)

Author: nathanjmcdougall

README.md

@@ -77,26 +77,26 @@ To use Ruff on a fresh project, run:
 ```console
 $ uvx usethis tool ruff
 ✔ Writing 'pyproject.toml'.
-✔ Adding dependency 'ruff' to the 'dev' dependency group.
+✔ Adding dependency 'ruff' to the 'dev' group in 'pyproject.toml'.
 ✔ Adding Ruff config to 'pyproject.toml'.
 ✔ Enabling Ruff rules 'A', 'C4', 'E4', 'E7', 'E9', 'EM', 'F', 'FURB', 'I', 'PLE', 'PLR', 'RUF', 'SIM', 'UP' in 'pyproject.toml'.
 ✔ Ignoring Ruff rules 'PLR2004', 'SIM108' in 'pyproject.toml'.
-☐ Run 'ruff check --fix' to run the Ruff linter with autofixes.
-☐ Run 'ruff format' to run the Ruff formatter.
+☐ Run 'uv run ruff check --fix' to run the Ruff linter with autofixes.
+☐ Run 'uv run ruff format' to run the Ruff formatter.
 ```
 
 To use pytest, run:
 
 ```console
 $ uvx usethis tool pytest
-✔ Adding dependency 'pytest' to the 'test' dependency group in 'pyproject.toml'.
+✔ Adding dependency 'pytest' to the 'test' group in 'pyproject.toml'.
 ✔ Adding pytest config to 'pyproject.toml'.
 ✔ Enabling Ruff rule 'PT' in 'pyproject.toml'.
 ✔ Creating '/tests'.
 ✔ Writing '/tests/conftest.py'.
 ☐ Add test files to the '/tests' directory with the format 'test_*.py'.
 ☐ Add test functions with the format 'test_*()'.
-☐ Run 'pytest' to run the tests.
+☐ Run 'uv run pytest' to run the tests.
 ```
 
 To configure Bitbucket pipelines, run:
@@ -105,6 +105,7 @@ To configure Bitbucket pipelines, run:
 $ uvx usethis ci bitbucket
 ✔ Writing 'bitbucket-pipelines.yml'.
 ✔ Adding cache 'uv' definition to 'bitbucket-pipelines.yml'.
+✔ Adding 'Run Ruff' to default pipeline in 'bitbucket-pipelines.yml'.
 ✔ Adding 'Test on 3.12' to default pipeline in 'bitbucket-pipelines.yml'.
 ✔ Adding 'Test on 3.13' to default pipeline in 'bitbucket-pipelines.yml'.
 ☐ Run your pipeline via the Bitbucket website.

tests/usethis/_interface/test_ci.py

@@ -0,0 +1,45 @@
+from pathlib import Path
+
+from typer.testing import CliRunner
+
+from usethis._interface.ci import app
+from usethis._test import change_cwd
+
+
+class TestBitbucket:
+    def test_readme_example(self, tmp_path: Path):
+        """This example is used the README.md file.
+
+        Note carefully! If this test is updated, the README.md file must be
+        updated too.
+        """
+        # Arrange
+        # We've already run ruff and pytest...
+        (tmp_path / "pytest.ini").touch()
+        (tmp_path / "ruff.toml").touch()
+        # Consistent versions in the matrix - only two to demonstrate it, 3 is excessive
+        (tmp_path / "pyproject.toml").write_text(
+            """\
+[project]
+requires-python = ">=3.12"
+"""
+        )
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, [])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+        assert (
+            result.output
+            == """\
+✔ Writing 'bitbucket-pipelines.yml'.
+✔ Adding cache 'uv' definition to 'bitbucket-pipelines.yml'.
+✔ Adding 'Run Ruff' to default pipeline in 'bitbucket-pipelines.yml'.
+✔ Adding 'Test on 3.12' to default pipeline in 'bitbucket-pipelines.yml'.
+✔ Adding 'Test on 3.13' to default pipeline in 'bitbucket-pipelines.yml'.
+☐ Run your pipeline via the Bitbucket website.
+"""
+        )

tests/usethis/_interface/test_tool.py

@@ -152,6 +152,33 @@ def test_cli(self, uv_init_dir: Path):
             else:
                 call_subprocess(["usethis", "tool", "ruff", "--offline"])
 
+    def test_readme_example(self, tmp_path: Path):
+        """This example is used the README.md file.
+
+        Note carefully! If this test is updated, the README.md file must be
+        updated too.
+        """
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, ["ruff"])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+        assert (
+            result.output
+            == """\
+✔ Writing 'pyproject.toml'.
+✔ Adding dependency 'ruff' to the 'dev' group in 'pyproject.toml'.
+✔ Adding Ruff config to 'pyproject.toml'.
+✔ Enabling Ruff rules 'A', 'C4', 'E4', 'E7', 'E9', 'EM', 'F', 'FURB', 'I', 
+'PLE', 'PLR', 'RUF', 'SIM', 'UP' in 'pyproject.toml'.
+✔ Ignoring Ruff rules 'PLR2004', 'SIM108' in 'pyproject.toml'.
+☐ Run 'uv run ruff check --fix' to run the Ruff linter with autofixes.
+☐ Run 'uv run ruff format' to run the Ruff formatter.
+"""
+        )
+
 
 class TestPytest:
     @pytest.mark.usefixtures("_vary_network_conn")
@@ -167,6 +194,44 @@ def test_add(self, tmp_path: Path):
         # Assert
         assert result.exit_code == 0, result.output
 
+    def test_readme_example(self, tmp_path: Path):
+        """This example is used the README.md file.
+
+        Note carefully! If this test is updated, the README.md file must be
+        updated too.
+        """
+        # Arrange
+        # We've already run ruff...
+        (tmp_path / "pyproject.toml").write_text("""\
+[project]
+name = "example"
+version = "0.1.0"     
+
+[tool.ruff]
+line-length = 88                                       
+""")
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, ["pytest"])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+        assert (
+            result.output
+            == """\
+✔ Adding dependency 'pytest' to the 'test' group in 'pyproject.toml'.
+✔ Adding pytest config to 'pyproject.toml'.
+✔ Enabling Ruff rule 'PT' in 'pyproject.toml'.
+✔ Creating '/tests'.
+✔ Writing '/tests/conftest.py'.
+☐ Add test files to the '/tests' directory with the format 'test_*.py'.
+☐ Add test functions with the format 'test_*()'.
+☐ Run 'uv run pytest' to run the tests.
+"""
+        )
+
 
 @pytest.mark.benchmark
 def test_several_tools_add_and_remove(tmp_path: Path):