243 test dep group doesnt seem to install automatically (#267)

nathanjmcdougall · web-flow · commit 9b1ee0ebca7c · 2025-02-07T12:15:41.000+13:00
* Add functionality to register dependency groups with uv

* Add test for use_pytest that it registers the group

* Add test that pytest is installed in the dev env

* Don't add [tool.uv.default-groups] if it's just going to be the default

* Fix bug with adding dev dep multiple times

* Fix test
diff --git a/doc/lessons.md b/doc/lessons.md
@@ -54,3 +54,16 @@
   1. Use present tense ("Removing..." not "Removed...")
   2. Show messages as soon as possible, don't wait until after the operation
   3. Use a flag like `first_removal` to ensure messages are shown exactly once
+
+## Configuration Management
+
+- When modifying configuration files like `pyproject.toml`, always consider the impact on existing configurations:
+  1. Check if a configuration exists before modifying it
+  2. Don't overwrite existing configurations unless explicitly requested
+  3. Handle empty or invalid configurations gracefully
+  4. Use appropriate functions from `pyproject.core` to manage configuration values
+- Keep configuration behavior consistent and avoid special cases:
+  1. Document configuration behavior in docstrings
+  2. Add test cases to verify behavior
+  3. Handle edge cases like empty lists or missing configurations
+  4. Prefer simple, uniform behavior over complex special cases
diff --git a/src/usethis/_integrations/uv/deps.py b/src/usethis/_integrations/uv/deps.py
@@ -3,7 +3,13 @@
 
 from usethis._config import usethis_config
 from usethis._console import tick_print
-from usethis._integrations.pyproject.io_ import read_pyproject_toml
+from usethis._integrations.pyproject.core import (
+    append_config_list,
+    get_config_value,
+)
+from usethis._integrations.pyproject.io_ import (
+    read_pyproject_toml,
+)
 from usethis._integrations.uv.call import call_uv_subprocess
 from usethis._integrations.uv.errors import UVDepGroupError, UVSubprocessFailedError
 
@@ -51,6 +57,39 @@ def get_deps_from_group(group: str) -> list[Dependency]:
         return []
 
 
+def register_default_group(group: str) -> None:
+    """Register a group in the default-groups configuration if it's not already there.
+
+    This ensures that dependencies in the group will be installed by default.
+    """
+    if group == "dev":
+        return
+
+    ensure_dev_group_is_defined()
+
+    try:
+        default_groups = get_config_value(["tool", "uv", "default-groups"])
+        if not isinstance(default_groups, list):
+            default_groups = []
+    except KeyError:
+        default_groups = []
+
+    groups_to_add = []
+    if group not in default_groups:
+        groups_to_add.append(group)
+        # Add "dev" if section is empty or if we're adding a new group and "dev" isn't present
+        if (not default_groups or group != "dev") and "dev" not in default_groups:
+            groups_to_add.append("dev")
+
+    if groups_to_add:
+        append_config_list(["tool", "uv", "default-groups"], groups_to_add)
+
+
+def ensure_dev_group_is_defined() -> None:
+    # Ensure dev group exists in dependency-groups
+    append_config_list(["dependency-groups", "dev"], [])
+
+
 def add_deps_to_group(deps: list[Dependency], group: str) -> None:
     """Add a package as a non-build dependency using PEP 735 dependency groups."""
     existing_group = get_deps_from_group(group)
@@ -68,6 +107,8 @@ def add_deps_to_group(deps: list[Dependency], group: str) -> None:
         f"Adding dependenc{ies} {deps_str} to the '{group}' group in 'pyproject.toml'."
     )
 
+    register_default_group(group)  # Register the group before adding dependencies
+
     for dep in to_add_deps:
         try:
             if not usethis_config.offline:
diff --git a/tests/usethis/_core/test_tool.py b/tests/usethis/_core/test_tool.py
@@ -19,6 +19,7 @@
     _HOOK_ORDER,
     get_hook_names,
 )
+from usethis._integrations.pyproject.core import get_config_value
 from usethis._integrations.uv.call import call_uv_subprocess
 from usethis._integrations.uv.deps import (
     Dependency,
@@ -338,6 +339,27 @@ def test_use_deptry_removes_config(self, tmp_path: Path):
             # Assert
             assert "[tool.deptry]" not in pyproject.read_text()
 
+        @pytest.mark.usefixtures("_vary_network_conn")
+        def test_roundtrip(self, uv_init_dir: Path):
+            # Arrange
+            contents = (uv_init_dir / "pyproject.toml").read_text()
+
+            # Act
+            with change_cwd(uv_init_dir):
+                use_deptry()
+                use_deptry(remove=True)
+
+            # Assert
+            assert (
+                (uv_init_dir / "pyproject.toml").read_text()
+                == contents
+                + """\
+
+[dependency-groups]
+dev = []
+"""
+            )
+
     class TestPreCommitIntegration:
         @pytest.mark.usefixtures("_vary_network_conn")
         def test_pre_commit_first(
@@ -1013,6 +1035,25 @@ def test_coverage_integration(
                 "☐ Run 'pytest --cov' to run your tests with coverage.\n"
             )
 
+        @pytest.mark.usefixtures("_vary_network_conn")
+        def test_pytest_installed(self, tmp_path: Path):
+            with change_cwd(tmp_path):
+                # Act
+                use_pytest()
+
+                # Assert
+                # This will raise if pytest is not installed
+                call_uv_subprocess(["pip", "show", "pytest"])
+
+        def test_registers_test_group(self, tmp_path: Path):
+            with change_cwd(tmp_path):
+                # Act
+                use_pytest()
+
+                # Assert
+                default_groups = get_config_value(["tool", "uv", "default-groups"])
+                assert "test" in default_groups
+
     class TestRemove:
         class TestRuffIntegration:
             def test_deselected(self, uv_init_dir: Path):
diff --git a/tests/usethis/_integrations/uv/test_deps.py b/tests/usethis/_integrations/uv/test_deps.py
@@ -3,13 +3,18 @@
 import pytest
 
 from usethis._config import usethis_config
+from usethis._integrations.pyproject.core import (
+    get_config_value,
+    remove_config_value,
+)
 from usethis._integrations.uv.deps import (
     Dependency,
     add_deps_to_group,
     get_dep_groups,
     get_deps_from_group,
     is_dep_in_any_group,
     is_dep_satisfied_in,
+    register_default_group,
     remove_deps_from_group,
 )
 from usethis._test import change_cwd
@@ -242,6 +247,26 @@ def test_combine_extras_alphabetical(self, uv_init_dir: Path):
             content = (uv_init_dir / "pyproject.toml").read_text()
             assert "coverage[extra,toml]" in content
 
+    @pytest.mark.usefixtures("_vary_network_conn")
+    def test_registers_default_group(self, uv_init_dir: Path):
+        with change_cwd(uv_init_dir):
+            # Act
+            add_deps_to_group([Dependency(name="pytest")], "test")
+
+            # Assert
+            default_groups = get_config_value(["tool", "uv", "default-groups"])
+            assert "test" in default_groups
+
+    @pytest.mark.usefixtures("_vary_network_conn")
+    def test_dev_group_not_registered(self, uv_init_dir: Path):
+        with change_cwd(uv_init_dir):
+            # Act
+            add_deps_to_group([Dependency(name="black")], "dev")
+
+            # Assert
+            # Tool section shouldn't even exist in pyproject.toml
+            assert "tool" not in (uv_init_dir / "pyproject.toml").read_text()
+
 
 class TestRemoveDepsFromGroup:
     @pytest.mark.usefixtures("_vary_network_conn")
@@ -344,6 +369,27 @@ def test_extras(self, uv_init_dir: Path, capfd: pytest.CaptureFixture[str]):
                 == "✔ Removing dependency 'pytest' from the 'test' group in 'pyproject.toml'.\n"
             )
 
+    @pytest.mark.usefixtures("_vary_network_conn")
+    def test_group_not_in_dependency_groups(
+        self, uv_init_dir: Path, capfd: pytest.CaptureFixture[str]
+    ):
+        with change_cwd(uv_init_dir):
+            # Arrange
+            with usethis_config.set(quiet=True):
+                add_deps_to_group([Dependency(name="pytest")], "test")
+
+            # Remove the group from dependency-groups but keep it in default-groups
+            remove_config_value(["dependency-groups", "test"])
+
+            # Act
+            remove_deps_from_group([Dependency(name="pytest")], "test")
+
+            # Assert
+            assert not get_deps_from_group("test")
+            out, err = capfd.readouterr()
+            assert not err
+            assert not out
+
 
 class TestIsDepInAnyGroup:
     def test_no_group(self, uv_init_dir: Path):
@@ -430,3 +476,91 @@ def test_multiple(self):
 
         # Assert
         assert result
+
+
+class TestRegisterDefaultGroup:
+    def test_section_not_exists_adds_dev(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "pyproject.toml").write_text("")
+
+        with change_cwd(tmp_path):
+            # Act
+            register_default_group("test")
+
+            # Assert
+            default_groups = get_config_value(["tool", "uv", "default-groups"])
+            assert set(default_groups) == {"test", "dev"}
+
+    def test_empty_section_adds_dev(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "pyproject.toml").write_text("""\
+[tool.uv]
+""")
+
+        with change_cwd(tmp_path):
+            # Act
+            register_default_group("test")
+
+            # Assert
+            default_groups = get_config_value(["tool", "uv", "default-groups"])
+            assert set(default_groups) == {"test", "dev"}
+
+    def test_empty_default_groups_adds_dev(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "pyproject.toml").write_text("""\
+[tool.uv]
+default-groups = []
+""")
+
+        with change_cwd(tmp_path):
+            # Act
+            register_default_group("test")
+
+            # Assert
+            default_groups = get_config_value(["tool", "uv", "default-groups"])
+            assert set(default_groups) == {"test", "dev"}
+
+    def test_existing_section_no_dev_added_if_no_other_groups(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "pyproject.toml").write_text("""\
+[tool.uv]
+default-groups = ["test"]
+""")
+
+        with change_cwd(tmp_path):
+            # Act
+            register_default_group("test")
+
+            # Assert
+            default_groups = get_config_value(["tool", "uv", "default-groups"])
+            assert set(default_groups) == {"test"}
+
+    def test_existing_section_no_dev_added_if_dev_exists(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "pyproject.toml").write_text("""\
+[tool.uv]
+default-groups = ["test", "dev"]
+""")
+
+        with change_cwd(tmp_path):
+            # Act
+            register_default_group("docs")
+
+            # Assert
+            default_groups = get_config_value(["tool", "uv", "default-groups"])
+            assert set(default_groups) == {"test", "dev", "docs"}
+
+    def test_existing_section_adds_dev_with_new_group(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "pyproject.toml").write_text("""\
+[tool.uv]
+default-groups = ["test"]
+""")
+
+        with change_cwd(tmp_path):
+            # Act
+            register_default_group("docs")
+
+            # Assert
+            default_groups = get_config_value(["tool", "uv", "default-groups"])
+            assert set(default_groups) == {"test", "docs", "dev"}
