package_managers: gomod: Add support for vendored workspaces

Introduced by Go 1.22 and controlled via 'go work vendor'. We already
can work with plain module vendoring. Workspace vendoring is the same
but relying on the logic backed by the go.work file.
Until now we weren't able to process workspaces properly and correctly,
but with the recent changes introduced in previous patches to address
that we're now fully ready to flip the switch on vendored workspaces
support.

Signed-off-by: Erik Skultety <[email protected]>

cachi2/core/package_managers/gomod.py

@@ -36,13 +36,7 @@
     from typing_extensions import Self
 
 from cachi2.core.config import get_config
-from cachi2.core.errors import (
-    FetchError,
-    PackageManagerError,
-    PackageRejected,
-    UnexpectedFormat,
-    UnsupportedFeature,
-)
+from cachi2.core.errors import FetchError, PackageManagerError, PackageRejected, UnexpectedFormat
 from cachi2.core.models.input import Request
 from cachi2.core.models.output import EnvironmentVariable, RequestOutput
 from cachi2.core.models.property_semantics import PropertySet
@@ -1033,14 +1027,7 @@ def _resolve_gomod(
     # Vendor dependencies if the gomod-vendor flag is set
     flags = request.flags
     if should_vendor:
-        # go_work.dir can't be None here
-        if go_work and go_work.dir.path.join("vendor").is_dir():  # type: ignore
-            # NOTE: the same error will be reported even for 1.21 which doesn't support workspace
-            # vendoring, but given it's an invalid configuration and that we plan full 1.22 support
-            # in the foreseeable future, a not so user friendly error should be fine
-            raise UnsupportedFeature("Go workspace vendoring is not supported")
-
-        downloaded_modules = _vendor_deps(go, app_dir, run_params)
+        downloaded_modules = _vendor_deps(go, app_dir, bool(go_work), run_params)
     else:
         log.info("Downloading the gomod dependencies")
         downloaded_modules = (
@@ -1555,9 +1542,9 @@ def _validate_local_replacements(modules: Iterable[ParsedModule], app_path: Root
         app_path.join_within_root(path)
 
 
-def _parse_vendor(module_dir: RootedPath) -> Iterable[ParsedModule]:
+def _parse_vendor(context_dir: RootedPath) -> Iterable[ParsedModule]:
     """Parse modules from vendor/modules.txt."""
-    modules_txt = module_dir.join_within_root("vendor", "modules.txt")
+    modules_txt = context_dir.join_within_root("vendor", "modules.txt")
     if not modules_txt.path.exists():
         return []
 
@@ -1615,7 +1602,8 @@ def parse_module_line(line: str) -> ParsedModule:
 
 def _vendor_deps(
     go: Go,
-    app_dir: RootedPath,
+    context_dir: RootedPath,
+    has_workspace: bool,
     run_params: dict[str, Any],
 ) -> Iterable[ParsedModule]:
     """
@@ -1625,13 +1613,16 @@ def _vendor_deps(
 
     :param app_dir: path to the module directory
     :param run_params: common params for the subprocess calls to `go`
+    :param has_workspace: whether we detected Go workspaces in the repo (affects @context_dir)
     :return: the list of Go modules parsed from vendor/modules.txt
     :raise PackageRejected: if vendor directory changed
     :raise UnexpectedFormat: if Cachi2 fails to parse vendor/modules.txt
     """
     log.info("Vendoring the gomod dependencies")
-    go(["mod", "vendor"], run_params)
-    if _vendor_changed(app_dir):
+
+    cmdscope = "work" if has_workspace else "mod"
+    go([cmdscope, "vendor"], run_params)
+    if _vendor_changed(context_dir):
         raise PackageRejected(
             reason=(
                 "The content of the vendor directory is not consistent with go.mod. "
@@ -1643,18 +1634,21 @@ def _vendor_deps(
             ),
             docs=VENDORING_DOC,
         )
-    return _parse_vendor(app_dir)
+    return _parse_vendor(context_dir)
 
 
-def _vendor_changed(app_dir: RootedPath) -> bool:
-    """Check for changes in the vendor directory."""
-    repo_root = app_dir.root
-    vendor = app_dir.path.relative_to(repo_root).joinpath("vendor")
+def _vendor_changed(context_dir: RootedPath) -> bool:
+    """Check for changes in the vendor directory.
+
+    :param context_dir: main module dir OR workspace context (directory containing go.work)
+    """
+    repo_root = context_dir.root
+    vendor = context_dir.path.relative_to(repo_root).joinpath("vendor")
     modules_txt = vendor / "modules.txt"
 
     repo = git.Repo(repo_root)
     # Add untracked files but do not stage them
-    repo.git.add("--intent-to-add", "--force", "--", app_dir)
+    repo.git.add("--intent-to-add", "--force", "--", context_dir)
 
     try:
         # Diffing modules.txt should catch most issues and produce relatively useful output
@@ -1669,6 +1663,6 @@ def _vendor_changed(app_dir: RootedPath) -> bool:
             log.error("%s directory changed after vendoring:\n%s", vendor, vendor_diff)
             return True
     finally:
-        repo.git.reset("--", app_dir)
+        repo.git.reset("--", context_dir)
 
     return False

tests/unit/package_managers/test_gomod.py

@@ -1473,11 +1473,13 @@ def test_invalid_local_replacements(tmpdir: Path) -> None:
 
 
 @pytest.mark.parametrize("vendor_changed", [True, False])
+@pytest.mark.parametrize("go_vendor_cmd", ["mod", "work"])
 @mock.patch("cachi2.core.package_managers.gomod.Go._run")
 @mock.patch("cachi2.core.package_managers.gomod._vendor_changed")
 def test_vendor_deps(
     mock_vendor_changed: mock.Mock,
     mock_run_cmd: mock.Mock,
+    go_vendor_cmd: str,
     vendor_changed: bool,
     rooted_tmp_path: RootedPath,
 ) -> None:
@@ -1488,11 +1490,11 @@ def test_vendor_deps(
     if vendor_changed:
         msg = "The content of the vendor directory is not consistent with go.mod."
         with pytest.raises(PackageRejected, match=msg):
-            _vendor_deps(Go(), app_dir, run_params)
+            _vendor_deps(Go(), app_dir, go_vendor_cmd == "work", run_params)
     else:
-        _vendor_deps(Go(), app_dir, run_params)
+        _vendor_deps(Go(), app_dir, go_vendor_cmd == "work", run_params)
 
-    mock_run_cmd.assert_called_once_with(["go", "mod", "vendor"], **run_params)
+    mock_run_cmd.assert_called_once_with(["go", go_vendor_cmd, "vendor"], **run_params)
     mock_vendor_changed.assert_called_once_with(app_dir)