fix resolve_gomod function typing

The input parameters to the resolve_gomod function for the application
directory and the overall source directory are both Paths or subclasses
of Path

Signed-off-by: Taylor Madore <tmadore@redhat.com>

Author: taylormadore

cachito/workers/pkg_managers/gomod.py

@@ -280,7 +280,12 @@ def match_parent_module(package_name: str, module_names: Iterable[str]) -> Optio
 
 
 @tracer.start_as_current_span("resolve_gomod")
-def resolve_gomod(app_source_path, request, dep_replacements=None, git_dir_path=None):
+def resolve_gomod(
+    app_source_path: Path,
+    request: dict[str, Any],
+    dep_replacements: Optional[list[dict[str, str]]] = None,
+    git_dir_path: Optional[Path] = None,
+) -> dict[str, Any]:
     """
     Resolve and fetch gomod dependencies for given app source archive.
 
@@ -455,10 +460,10 @@ def go_list_deps(pattern: Literal["./...", "all"]) -> Iterator[GoPackage]:
             main_packages.append({"pkg": main_pkg, "pkg_deps": pkg_deps})
 
         _vet_local_deps(main_module_deps, main_module_name, app_source_path, git_dir_path)
-        for pkg in main_packages:
+        for package in main_packages:
             # Local dependencies are always relative to the main module, even for subpackages
-            _vet_local_deps(pkg["pkg_deps"], main_module_name, app_source_path, git_dir_path)
-            _set_full_local_dep_relpaths(pkg["pkg_deps"], main_module_deps)
+            _vet_local_deps(package["pkg_deps"], main_module_name, app_source_path, git_dir_path)
+            _set_full_local_dep_relpaths(package["pkg_deps"], main_module_deps)
 
         return {
             "module": main_module,
@@ -503,7 +508,7 @@ def _get_name_and_version(module: GoModule) -> tuple[str, str]:
     return name, version
 
 
-def _should_vendor_deps(flags: List[str], app_dir: str, strict: bool) -> Tuple[bool, bool]:
+def _should_vendor_deps(flags: List[str], app_dir: Path, strict: bool) -> Tuple[bool, bool]:
     """
     Determine if Cachito should vendor dependencies and if it is allowed to make changes.
 
@@ -517,7 +522,7 @@ def _should_vendor_deps(flags: List[str], app_dir: str, strict: bool) -> Tuple[b
     :return: (should vendor: bool, allowed to make changes in the vendor directory: bool)
     :raise ValidationError: if the vendor dir is present, the flags are not used and we are strict
     """
-    vendor = Path(app_dir) / "vendor"
+    vendor = app_dir / "vendor"
 
     if "gomod-vendor-check" in flags:
         return True, not vendor.exists()
@@ -534,7 +539,7 @@ def _should_vendor_deps(flags: List[str], app_dir: str, strict: bool) -> Tuple[b
 
 
 @tracer.start_as_current_span("_vendor_deps")
-def _vendor_deps(go: Go, run_params: dict, can_make_changes: bool, git_dir: str) -> list[GoModule]:
+def _vendor_deps(go: Go, run_params: dict, can_make_changes: bool, git_dir: Path) -> list[GoModule]:
     """
     Vendor golang dependencies.
 
@@ -609,7 +614,7 @@ def parse_module_line(line: str) -> GoModule:
 
 
 @tracer.start_as_current_span("_vendor_changed")
-def _vendor_changed(git_dir: str, app_dir: str) -> bool:
+def _vendor_changed(git_dir: Path, app_dir: str) -> bool:
     """Check for changes in the vendor directory."""
     vendor = Path(app_dir).relative_to(git_dir).joinpath("vendor")
     modules_txt = vendor / "modules.txt"
@@ -640,7 +645,7 @@ def _vet_local_deps(
     dependencies: List[dict],
     module_name: str,
     app_source_path: Path,
-    git_dir_path: str,
+    git_dir_path: Path,
 ) -> None:
     """Fail if any local file dependency path is either absolute or outside the repository."""
     for dep in dependencies:
@@ -666,19 +671,19 @@ def _vet_local_deps(
 
 
 def _validate_local_dependency_path(
-    app_source_path: Path, git_dir_path: str, dep_path: str
+    app_source_path: Path, git_dir_path: Path, dep_path: str
 ) -> None:
     """
     Validate that the local dependency path is not outside the repository.
 
     :param Path app_source_path: the full path to the application source code
-    :param str git_dir_path: the full path to the git repository
+    :param Path git_dir_path: the full path to the git repository
     :param str dep_path: the relative path for local replacements (the dep version)
     :raise ValidationError: if the local dependency path is invalid
     """
     try:
         resolved_dep_path = Path(app_source_path, dep_path).resolve()
-        resolved_dep_path.relative_to(Path(git_dir_path).resolve())
+        resolved_dep_path.relative_to(git_dir_path.resolve())
     except ValueError:
         raise ValidationError(f"The local dependency path {dep_path} is outside the repository")
 

tests/test_workers/test_pkg_managers/test_gomod.py

@@ -122,7 +122,7 @@ def test_resolve_gomod(
     mock_go_release.return_value = "go0.1.0"
     mock_get_gomod_version.return_value = ("0.1.1", "0.1.2")
 
-    module_dir = str(tmp_path / "path/to/module")
+    module_dir = tmp_path / "path/to/module"
     request = {"id": 3, "ref": "c50b93a32df1c9d700e3e80996845bc2e13be848", "flags": []}
     if cgo_disable:
         request["flags"].append("cgo-disable")
@@ -255,7 +255,7 @@ def test_resolve_gomod_vendor_dependencies(
     if force_gomod_tidy:
         request["flags"].append("force-gomod-tidy")
 
-    gomod_ = gomod.resolve_gomod(str(module_dir), request)
+    gomod_ = gomod.resolve_gomod(module_dir, request)
 
     assert mock_run.call_args_list[0][0][0] == ["go", "mod", "vendor"]
     # when vendoring, go list should be called without -mod readonly
@@ -312,7 +312,7 @@ def test_resolve_gomod_strict_mode_raise_error(
         mock.Mock(returncode=0, stdout=""),  # go list -deps -json ./...
     ]
 
-    module_dir = str(tmp_path)
+    module_dir = tmp_path
     tmp_path.joinpath("vendor").mkdir()
 
     request = {"id": 3, "ref": "c50b93a32df1c9d700e3e80996845bc2e13be848"}
@@ -380,7 +380,7 @@ def test_resolve_gomod_no_deps(
     mock_go_release.return_value = "go1.21.0"
     mock_get_gomod_version.return_value = ("0.1.1", "0.1.2")
 
-    module_dir = str(tmp_path / "/path/to/module")
+    module_dir = tmp_path / "/path/to/module"
 
     request = {"id": 3, "ref": "c50b93a32df1c9d700e3e80996845bc2e13be848"}
     if force_gomod_tidy:
@@ -430,7 +430,7 @@ def test_go_list_cmd_failure(
     go_mod_rc: int,
     go_list_rc: int,
 ) -> None:
-    module_dir = "/path/to/module"
+    module_dir = Path("/path/to/module")
     request = {"id": 3, "ref": "c50b93a32df1c9d700e3e80996845bc2e13be848"}
 
     # Mock the tempfile.TemporaryDirectory context manager
@@ -695,8 +695,8 @@ def test_vet_local_deps(mock_validate_dep_path):
         {"name": "baz", "version": "./local/baz"},
     ]
     module_name = "some-module"
-    app_dir = "/repo/some-module"
-    git_dir = "/repo"
+    app_dir = Path("/repo/some-module")
+    git_dir = Path("/repo")
     mock_validate_dep_path.return_value = None
 
     gomod._vet_local_deps(dependencies, module_name, app_dir, git_dir)
@@ -719,7 +719,7 @@ def test_vet_local_deps(mock_validate_dep_path):
 )
 def test_vet_local_deps_abspath(platform_specific_path):
     dependencies = [{"name": "foo", "version": platform_specific_path}]
-    app_dir = "/some/path"
+    app_dir = Path("/some/path")
 
     expect_error = re.escape(
         f"Absolute paths to gomod dependencies are not supported: {platform_specific_path}"
@@ -902,7 +902,7 @@ def test_should_vendor_deps(flags, vendor_exists, expect_result, tmp_path):
     if vendor_exists:
         tmp_path.joinpath("vendor").mkdir()
 
-    assert gomod._should_vendor_deps(flags, str(tmp_path), False) == expect_result
+    assert gomod._should_vendor_deps(flags, tmp_path, False) == expect_result
 
 
 @pytest.mark.parametrize(
@@ -921,9 +921,9 @@ def test_should_vendor_deps_strict(flags, vendor_exists, expect_error, tmp_path)
     if expect_error:
         msg = 'The "gomod-vendor" or "gomod-vendor-check" flag must be set'
         with pytest.raises(ValidationError, match=msg):
-            gomod._should_vendor_deps(flags, str(tmp_path), True)
+            gomod._should_vendor_deps(flags, tmp_path, True)
     else:
-        gomod._should_vendor_deps(flags, str(tmp_path), True)
+        gomod._should_vendor_deps(flags, tmp_path, True)
 
 
 @pytest.mark.parametrize("can_make_changes", [True, False])