DEVOPS-657 feat: extend update_dependency task to skip install package dependency if package version is already installed on the org (#4)

* DEVOPS-657 feat: add dependency installation check to skip already installed packages

* DEVOPS-657 test: add unit tests for unmanaged dependency checks and error handling

Author: jsun-clariti

cumulusci/tasks/salesforce/tests/test_update_dependencies.py

@@ -504,3 +504,71 @@ def test_freeze__interactive_exception():
         task.freeze(step)
 
     assert "cannot be frozen" in str(e)
+
+
+def test_is_dependency_already_installed_unmanaged():
+    """Test that unmanaged dependencies return False"""
+    task = create_task(UpdateDependencies, {"dependencies": []})
+    dependency = UnmanagedGitHubRefDependency.parse_obj({
+        "github": "https://github.com/Test/TestRepo",
+        "ref": "main",
+        "subfolder": "src"
+    })
+    
+    assert task._is_dependency_already_installed(dependency) is False
+
+
+def test_is_dependency_already_installed_error_handling():
+    """Test error handling when installed packages can't be retrieved"""
+    task = create_task(UpdateDependencies, {"dependencies": []})
+    task.org_config = mock.Mock()
+    # Mock the property to raise an exception
+    type(task.org_config).installed_packages = mock.PropertyMock(side_effect=Exception)
+    dependency = PackageVersionIdDependency(version_id="04t000000000000")
+    
+    assert task._is_dependency_already_installed(dependency) is False
+
+
+def test_is_dependency_already_installed_version_id():
+    """Test package version ID dependency checks"""
+    task = create_task(UpdateDependencies, {"dependencies": []})
+    task.org_config = mock.Mock()
+    
+    # Test with 18 character ID
+    task.org_config.installed_packages = {"ns": [mock.Mock(id="04t000000000000AAA")]}
+    dependency = PackageVersionIdDependency(version_id="04t000000000000AAA")
+    assert task._is_dependency_already_installed(dependency) is True
+    
+    # Test with 15 character ID
+    task.org_config.installed_packages = {"ns": [mock.Mock(id="04t000000000000")]}
+    dependency = PackageVersionIdDependency(version_id="04t000000000000AAA")
+    assert task._is_dependency_already_installed(dependency) is True
+
+
+def test_is_dependency_already_installed_namespace_version():
+    """Test namespace version dependency checks"""
+    task = create_task(UpdateDependencies, {"dependencies": []})
+    task.org_config = mock.Mock()
+    
+    # Test with version_id
+    task.org_config.installed_packages = {"ns": [mock.Mock(id="04t000000000000AAA")]}
+    dependency = PackageNamespaceVersionDependency(
+        namespace="ns",
+        version="1.0",
+        version_id="04t000000000000AAA"
+    )
+    assert task._is_dependency_already_installed(dependency) is True
+    
+    # Test with regular version
+    mock_version = mock.Mock()
+    mock_version.id = "04t000000000000AAA"
+    task.org_config.installed_packages = {"ns@1.0": [mock_version]}
+    dependency = PackageNamespaceVersionDependency(namespace="ns", version="1.0")
+    assert task._is_dependency_already_installed(dependency) is True
+    
+    # Test with beta version
+    mock_version = mock.Mock()
+    mock_version.id = "04t000000000000BBB"
+    task.org_config.installed_packages = {"ns@1.0b2": [mock_version]}
+    dependency = PackageNamespaceVersionDependency(namespace="ns", version="1.0 (Beta 2)")
+    assert task._is_dependency_already_installed(dependency) is True

cumulusci/tasks/salesforce/update_dependencies.py

@@ -226,6 +226,11 @@ def _run_task(self):
         self.org_config.reset_installed_packages()
 
     def _install_dependency(self, dependency):
+        # Log and short-circuit if dependency version is already present on the org
+        self.logger.info(f"Checking if already installed: {dependency}")
+        if self._is_dependency_already_installed(dependency):
+            self.logger.info(f"{dependency} is already installed; skipping.")
+            return
         if isinstance(
             dependency, (PackageNamespaceVersionDependency, PackageVersionIdDependency)
         ):
@@ -235,6 +240,63 @@ def _install_dependency(self, dependency):
         else:
             dependency.install(self.project_config, self.org_config)
 
+    def _is_dependency_already_installed(self, dependency) -> bool:
+        """Return True if the resolved managed package dependency is already installed."""
+        if not isinstance(
+            dependency, (PackageNamespaceVersionDependency, PackageVersionIdDependency)
+        ):
+            self.logger.debug("Dependency is unmanaged metadata; no installed check needed.")
+            return False
+
+        try:
+            installed = self.org_config.installed_packages
+        except Exception:
+            self.logger.warning(
+                "Could not retrieve installed packages from org; proceeding with install."
+            )
+            return False
+
+        installed_version_ids_18 = {v.id for versions in installed.values() for v in versions}
+        installed_version_ids_15 = {vid[:15] for vid in installed_version_ids_18}
+
+        if isinstance(dependency, PackageVersionIdDependency):
+            dep_id = dependency.version_id
+            dep_id_15 = dep_id[:15] if dep_id else None
+            is_installed = (
+                dep_id in installed_version_ids_18 or dep_id_15 in installed_version_ids_15
+            )
+            self.logger.info(
+                f"Already-installed check by version_id: {dep_id} (15:{dep_id_15}) -> {is_installed}"
+            )
+            return is_installed
+
+        if isinstance(dependency, PackageNamespaceVersionDependency):
+            if getattr(dependency, "version_id", None):
+                dep_id = dependency.version_id
+                dep_id_15 = dep_id[:15] if dep_id else None
+                is_installed = (
+                    dep_id in installed_version_ids_18 or dep_id_15 in installed_version_ids_15
+                )
+                self.logger.info(
+                    f"Already-installed check by version_id: {dep_id} (15:{dep_id_15}) -> {is_installed}"
+                )
+                return is_installed
+
+            version = dependency.version
+            if "Beta" in version:
+                version_string = version.split(" ")[0]
+                beta = version.split(" ")[-1].strip(")")
+                version = f"{version_string}b{beta}"
+
+            key = f"{dependency.namespace}@{version}"
+            is_installed = key in installed
+            self.logger.info(
+                f"Already-installed check by namespace@version: {key} -> {is_installed}"
+            )
+            return is_installed
+
+        return False
+
     def freeze(self, step):
         if self.options["interactive"]:
             raise CumulusCIException(