Add support for dependency groups (#26)

Author: tofay

poetry.lock

@@ -16,7 +16,7 @@ include = [
 
 [tool.poetry.dependencies]
 python = "^3.7"
-poetry = "^1.2.0rc1"
+poetry = "^1.2.0"
 
 [tool.poetry.dev-dependencies]
 pre-commit = "^2.6"

pyproject.toml

@@ -25,6 +25,7 @@ def __init__(self) -> None:
         self._path: Path
         self._executable: str | None = None
         self._remove: bool = False
+        self._activated_groups: set[str] | None = None
 
     def set_path(self, path: Path) -> VenvBundler:
         self._path = path
@@ -36,6 +37,11 @@ def set_executable(self, executable: str) -> VenvBundler:
 
         return self
 
+    def set_activated_groups(self, activated_groups: set[str]) -> VenvBundler:
+        self._activated_groups = activated_groups
+
+        return self
+
     def set_remove(self, remove: bool = True) -> VenvBundler:
         self._remove = remove
 
@@ -111,10 +117,7 @@ def bundle(self, poetry: Poetry, io: IO) -> bool:
 
         env = VirtualEnv(self._path)
 
-        self._write(
-            io,
-            f"{message}: <info>Installing dependencies</info>",
-        )
+        self._write(io, f"{message}: <info>Installing dependencies</info>")
 
         installer = Installer(
             NullIO() if not io.is_debug() else io,
@@ -124,6 +127,8 @@ def bundle(self, poetry: Poetry, io: IO) -> bool:
             poetry.pool,
             poetry.config,
         )
+        if self._activated_groups is not None:
+            installer.only_groups(self._activated_groups)
         installer.requires_synchronization()
         installer.use_executor(poetry.config.get("experimental.new-installer", False))
 

src/poetry_plugin_bundle/bundlers/venv_bundler.py

@@ -2,15 +2,15 @@
 
 from typing import TYPE_CHECKING
 
-from poetry.console.commands.command import Command
+from poetry.console.commands.group_command import GroupCommand
 
 
 if TYPE_CHECKING:
     from poetry_plugin_bundle.bundlers.bundler import Bundler
     from poetry_plugin_bundle.bundlers.bundler_manager import BundlerManager
 
 
-class BundleCommand(Command):
+class BundleCommand(GroupCommand):
     """
     Base class for all bundle commands.
     """

src/poetry_plugin_bundle/console/commands/bundle/bundle_command.py

@@ -18,10 +18,11 @@ class BundleVenvCommand(BundleCommand):
     description = "Bundle the current project into a virtual environment"
 
     arguments = [
-        argument("path", "The path to the virtual environment to bundle into."),
+        argument("path", "The path to the virtual environment to bundle into.")
     ]
 
     options = [
+        *BundleCommand._group_dependency_options(),
         option(
             "python",
             "p",
@@ -44,3 +45,4 @@ def configure_bundler(self, bundler: VenvBundler) -> None:  # type: ignore[overr
         bundler.set_path(Path(self.argument("path")))
         bundler.set_executable(self.option("python"))
         bundler.set_remove(self.option("clear"))
+        bundler.set_activated_groups(self.activated_groups)

src/poetry_plugin_bundle/console/commands/bundle/venv.py

@@ -12,6 +12,7 @@
 from cleo.io.buffered_io import BufferedIO
 from poetry.core.packages.package import Package
 from poetry.factory import Factory
+from poetry.puzzle.exceptions import SolverProblemError
 from poetry.repositories.pool import Pool
 from poetry.repositories.repository import Repository
 
@@ -221,3 +222,49 @@ def test_bundler_should_display_a_warning_for_projects_with_no_module(
   • The root package was not installed because no matching module or package was found.
 """  # noqa: E501
     assert expected == io.fetch_output()
+
+
+def test_bundler_can_filter_dependency_groups(
+    io: BufferedIO, tmpdir: str, poetry: Poetry, mocker: MockerFixture, config: Config
+) -> None:
+    poetry = Factory().create_poetry(
+        Path(__file__).parent.parent / "fixtures" / "simple_project_with_dev_dep"
+    )
+    poetry.set_config(config)
+
+    # foo is in the main dependency group
+    # bar is a dev dependency
+    # add a repository for foo but not bar
+    pool = Pool()
+    repository = Repository("repo")
+    repository.add_package(Package("foo", "1.0.0"))
+    pool.add_repository(repository)
+    poetry.set_pool(pool)
+
+    mocker.patch("poetry.installation.executor.Executor._execute_operation")
+
+    bundler = VenvBundler()
+    bundler.set_path(Path(tmpdir))
+    bundler.set_remove(True)
+
+    # This should fail because there is not repo for bar
+    with pytest.raises(SolverProblemError):
+        assert not bundler.bundle(poetry, io)
+
+    bundler.set_activated_groups({"main"})
+    io.clear_output()
+
+    # This succeeds because the dev dependency group is filtered out
+    assert bundler.bundle(poetry, io)
+
+    path = tmpdir
+    python_version = ".".join(str(v) for v in sys.version_info[:3])
+    expected = f"""\
+  • Bundling simple-project (1.2.3) into {path}
+  • Bundling simple-project (1.2.3) into {path}: Removing existing virtual environment
+  • Bundling simple-project (1.2.3) into {path}: Creating a virtual environment using Python {python_version}
+  • Bundling simple-project (1.2.3) into {path}: Installing dependencies
+  • Bundling simple-project (1.2.3) into {path}: Installing simple-project (1.2.3)
+  • Bundled simple-project (1.2.3) into {path}
+"""  # noqa: E501
+    assert expected == io.fetch_output()