cumulusci-plus 5.0.18__py3-none-any.whl → 5.0.20__py3-none-any.whl

cumulusci/__about__.py

@@ -1 +1 @@
-__version__ = "5.0.18"
+__version__ = "5.0.20"

cumulusci/core/dependencies/base.py

@@ -255,7 +255,9 @@ class UnmanagedDependency(UnmanagedStaticDependency, ABC):
 
         return package_zip
 
-    def install(self, context: BaseProjectConfig, org: OrgConfig):
+    def install(
+        self, context: BaseProjectConfig, org: OrgConfig, options: Optional[dict] = {}
+    ):
 
         context.logger.info(f"Deploying unmanaged metadata from {self.description}")
 
@@ -411,6 +413,7 @@ class VcsDynamicDependency(BaseVcsDynamicDependency, ABC):
                     unmanaged=not managed,
                     namespace_inject=namespace if namespace and managed else None,
                     namespace_strip=namespace if namespace and not managed else None,
+                    package_dependency=self.package_dependency,
                 )
             ]
         return []
@@ -446,6 +449,7 @@ class VcsDynamicDependency(BaseVcsDynamicDependency, ABC):
                         namespace_strip=namespace
                         if namespace and not managed
                         else None,
+                        package_dependency=self.package_dependency,
                     )
                 )
 
@@ -493,22 +497,22 @@ class VcsDynamicDependency(BaseVcsDynamicDependency, ABC):
 
         # Look for any flow to executed in project config
         # Pre flows will run to dynamically generate metadata and deploy.
-        deps.extend(
-            self._flatten_dependency_flow(
-                package_config,
-                "dependency_flow_pre",
-                managed=False,
-                namespace=namespace,
-            )
+        flow = self._flatten_dependency_flow(
+            package_config,
+            "dependency_flow_pre",
+            managed=False,
+            namespace=namespace,
         )
-
-        # Look for subfolders under unpackaged/pre
-        # unpackaged/pre is always deployed unmanaged, no namespace manipulation.
-        deps.extend(
-            self._flatten_unpackaged(
-                repo, "unpackaged/pre", self.skip, managed=False, namespace=None
+        if flow:
+            deps.extend(flow)
+        else:
+            # Look for subfolders under unpackaged/pre
+            # unpackaged/pre is always deployed unmanaged, no namespace manipulation.
+            deps.extend(
+                self._flatten_unpackaged(
+                    repo, "unpackaged/pre", self.skip, managed=False, namespace=None
+                )
             )
-        )
 
         if not self.package_dependency:
             if managed:
@@ -532,25 +536,26 @@ class VcsDynamicDependency(BaseVcsDynamicDependency, ABC):
 
         # Look for any flow to executed in project config
         # Pre flows will run to dynamically generate metadata and deploy.
-        deps.extend(
-            self._flatten_dependency_flow(
-                package_config,
-                "dependency_flow_post",
-                managed=managed,
-                namespace=namespace,
-            )
+        flow = self._flatten_dependency_flow(
+            package_config,
+            "dependency_flow_post",
+            managed=managed,
+            namespace=namespace,
         )
 
-        # We always inject the project's namespace into unpackaged/post metadata if managed
-        deps.extend(
-            self._flatten_unpackaged(
-                repo,
-                "unpackaged/post",
-                self.skip,
-                managed=managed,
-                namespace=namespace,
+        if flow:
+            deps.extend(flow)
+        else:
+            # We always inject the project's namespace into unpackaged/post metadata if managed
+            deps.extend(
+                self._flatten_unpackaged(
+                    repo,
+                    "unpackaged/post",
+                    self.skip,
+                    managed=managed,
+                    namespace=namespace,
+                )
             )
-        )
 
         return deps
 
@@ -574,6 +579,9 @@ class UnmanagedVcsDependency(UnmanagedDependency, ABC):
     namespace_inject: Optional[str] = None
     namespace_strip: Optional[str] = None
 
+    # Field to reference corresponding package dependency
+    package_dependency: Optional["BasePackageVersionDependency"] = None
+
     @root_validator(pre=True)
     @abstractmethod
     def sync_vcs_and_url(cls, values):
@@ -619,6 +627,19 @@ class UnmanagedVcsDependency(UnmanagedDependency, ABC):
 
         return f"{self.url}{subfolder} @{self.ref}"
 
+    def install(
+        self, context: BaseProjectConfig, org: OrgConfig, options: Optional[dict] = {}
+    ):
+        if (
+            self.package_dependency is not None
+            and not self.package_dependency.is_installable(org, options)
+        ):
+            context.logger.info(
+                f"{self.description} or a newer version is already deployed; skipping."
+            )
+            return
+        super().install(context, org)
+
 
 class UnmanagedVcsDependencyFlow(UnmanagedStaticDependency, ABC):
     vcs: str
@@ -632,6 +653,9 @@ class UnmanagedVcsDependencyFlow(UnmanagedStaticDependency, ABC):
     namespace_strip: Optional[str] = None
     password_env_name: Optional[str] = None
 
+    # Field to reference corresponding package dependency
+    package_dependency: Optional["BasePackageVersionDependency"] = None
+
     @property
     def name(self):
         return f"Deploy {self.url} Flow: {self.flow_name}"
@@ -640,7 +664,18 @@ class UnmanagedVcsDependencyFlow(UnmanagedStaticDependency, ABC):
     def description(self):
         return f"{self.url} Flow: {self.flow_name} @{self.commit}"
 
-    def install(self, context: BaseProjectConfig, org: OrgConfig):
+    def install(
+        self, context: BaseProjectConfig, org: OrgConfig, options: Optional[dict] = {}
+    ):
+        if (
+            self.package_dependency is not None
+            and not self.package_dependency.is_installable(org, options)
+        ):
+            context.logger.info(
+                f"{self.description} or a newer version is already deployed; skipping."
+            )
+            return
+
         context.logger.info(f"Deploying dependency Flow from {self.description}")
 
         from cumulusci.utils.yaml.cumulusci_yml import VCSSourceModel
@@ -656,7 +691,6 @@ class UnmanagedVcsDependencyFlow(UnmanagedStaticDependency, ABC):
         vcs_source = VCSSource.create(context, source_model)
 
         # Fetch the data and get remote project config.
-        context.logger.info(f"Fetching from {vcs_source}")
         project_config = vcs_source.fetch()
 
         project_config.set_keychain(context.keychain)
@@ -708,3 +742,13 @@ class UnmanagedVcsDependencyFlow(UnmanagedStaticDependency, ABC):
         coordinator.run(org)
         duration = datetime.now() - start_time
         context.logger.info(f"Ran {self.flow_name} in {format_duration(duration)}")
+
+
+class BasePackageVersionDependency(StaticDependency, ABC):
+    @abstractmethod
+    def is_installable(self, org: OrgConfig, options: Optional[dict] = {}) -> bool:
+        pass
+
+
+UnmanagedVcsDependency.update_forward_refs()
+UnmanagedVcsDependencyFlow.update_forward_refs()

cumulusci/core/dependencies/dependencies.py

@@ -20,7 +20,7 @@ from cumulusci.utils import download_extract_zip
 logger = logging.getLogger(__name__)
 
 
-class PackageNamespaceVersionDependency(base_dependency.StaticDependency):
+class PackageNamespaceVersionDependency(base_dependency.BasePackageVersionDependency):
     """Static dependency on a package identified by namespace and version number."""
 
     namespace: str
@@ -34,6 +34,21 @@ class PackageNamespaceVersionDependency(base_dependency.StaticDependency):
     def package(self):
         return self.package_name or self.namespace or "Unknown Package"
 
+    def is_installable(self, org: OrgConfig, options: Optional[dict] = {}) -> bool:
+        if "Beta" in self.version:
+            version_string = self.version.split(" ")[0]
+            beta = self.version.split(" ")[-1].strip(")")
+            version = f"{version_string}b{beta}"
+        else:
+            version = self.version
+
+        if org.has_minimum_package_version(
+            self.namespace,
+            version,
+        ):
+            return False
+        return True
+
     def install(
         self,
         context: BaseProjectConfig,
@@ -48,17 +63,7 @@ class PackageNamespaceVersionDependency(base_dependency.StaticDependency):
         if not retry_options:
             retry_options = DEFAULT_PACKAGE_RETRY_OPTIONS
 
-        if "Beta" in self.version:
-            version_string = self.version.split(" ")[0]
-            beta = self.version.split(" ")[-1].strip(")")
-            version = f"{version_string}b{beta}"
-        else:
-            version = self.version
-
-        if org.has_minimum_package_version(
-            self.namespace,
-            version,
-        ):
+        if not self.is_installable(org):
             context.logger.info(
                 f"{self} or a newer version is already installed; skipping."
             )
@@ -83,7 +88,7 @@ class PackageNamespaceVersionDependency(base_dependency.StaticDependency):
         return f"{self.package} {self.version}"
 
 
-class PackageVersionIdDependency(base_dependency.StaticDependency):
+class PackageVersionIdDependency(base_dependency.BasePackageVersionDependency):
     """Static dependency on a package identified by 04t version id."""
 
     version_id: str
@@ -96,6 +101,14 @@ class PackageVersionIdDependency(base_dependency.StaticDependency):
     def package(self):
         return self.package_name or "Unknown Package"
 
+    def is_installable(self, org: OrgConfig, options: Optional[dict] = {}) -> bool:
+        if any(
+            self.version_id == v.id
+            for v in itertools.chain(*org.installed_packages.values())
+        ) and not options.get("force_pre_post_install"):
+            return False
+        return True
+
     def install(
         self,
         context: BaseProjectConfig,
@@ -110,10 +123,7 @@ class PackageVersionIdDependency(base_dependency.StaticDependency):
         if not retry_options:
             retry_options = DEFAULT_PACKAGE_RETRY_OPTIONS
 
-        if any(
-            self.version_id == v.id
-            for v in itertools.chain(*org.installed_packages.values())
-        ):
+        if not self.is_installable(org):
             context.logger.info(
                 f"{self} or a newer version is already installed; skipping."
             )

cumulusci/core/dependencies/tests/test_dependencies.py

@@ -256,6 +256,8 @@ class TestGitHubDynamicDependency:
             namespace="bar", version="2.0"
         )
 
+        root_repo = PackageNamespaceVersionDependency(namespace="bar", version="2.0")
+
         assert gh.flatten(project_config) == [
             GitHubDynamicDependency(
                 github="https://github.com/SFDO-Tooling/DependencyRepo",
@@ -266,20 +268,23 @@ class TestGitHubDynamicDependency:
                 subfolder="unpackaged/pre/first",
                 unmanaged=True,
                 ref="aaaaa",
+                package_dependency=root_repo,
             ),
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/RootRepo",
                 subfolder="unpackaged/pre/second",
                 unmanaged=True,
                 ref="aaaaa",
+                package_dependency=root_repo,
             ),
-            PackageNamespaceVersionDependency(namespace="bar", version="2.0"),
+            root_repo,
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/RootRepo",
                 subfolder="unpackaged/post/first",
                 unmanaged=False,
                 ref="aaaaa",
                 namespace_inject="bar",
+                package_dependency=root_repo,
             ),
         ]
 
@@ -295,6 +300,8 @@ class TestGitHubDynamicDependency:
             namespace="bar", version="2.0"
         )
 
+        root_repo = PackageNamespaceVersionDependency(namespace="bar", version="2.0")
+
         assert gh.flatten(project_config) == [
             GitHubDynamicDependency(
                 github="https://github.com/SFDO-Tooling/DependencyRepo",
@@ -305,14 +312,16 @@ class TestGitHubDynamicDependency:
                 subfolder="unpackaged/pre/second",
                 unmanaged=True,
                 ref="aaaaa",
+                package_dependency=root_repo,
             ),
-            PackageNamespaceVersionDependency(namespace="bar", version="2.0"),
+            root_repo,
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/RootRepo",
                 subfolder="unpackaged/post/first",
                 unmanaged=False,
                 ref="aaaaa",
                 namespace_inject="bar",
+                package_dependency=root_repo,
             ),
         ]
 
@@ -1086,14 +1095,11 @@ class TestUnmanagedVcsDependencyFlow:
 
         # Verify logging
         assert (
-            mock_context.logger.info.call_count == 3
+            mock_context.logger.info.call_count == 2
         )  # Initial log, fetching log, final log
         mock_context.logger.info.assert_any_call(
             "Deploying dependency Flow from https://github.com/test/repo Flow: install_deps @abc123"
         )
-        mock_context.logger.info.assert_any_call(
-            f"Fetching from {mock_vcs_source_instance}"
-        )
         mock_context.logger.info.assert_any_call("Ran install_deps in 5.2s")
 
         # Verify datetime and format_duration calls

cumulusci/core/dependencies/tests/test_resolvers.py

@@ -767,6 +767,16 @@ class TestStaticDependencyResolution:
 
         gh = GitHubDynamicDependency(github="https://github.com/SFDO-Tooling/RootRepo")
 
+        dep_repo = PackageNamespaceVersionDependency(
+            namespace="foo",
+            version="1.1",
+            package_name="DependencyRepo",
+            password_env_name="DEP_PW",
+        )
+        root_repo = PackageNamespaceVersionDependency(
+            namespace="bar", version="2.0", package_name="RootRepo"
+        )
+
         assert get_static_dependencies(
             project_config,
             dependencies=[gh],
@@ -777,41 +787,39 @@ class TestStaticDependencyResolution:
                 subfolder="unpackaged/pre/top",
                 unmanaged=True,
                 ref="tag_sha",
+                package_dependency=dep_repo,
             ),
-            PackageNamespaceVersionDependency(
-                namespace="foo",
-                version="1.1",
-                package_name="DependencyRepo",
-                password_env_name="DEP_PW",
-            ),
+            dep_repo,
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/DependencyRepo",
                 subfolder="unpackaged/post/top",
                 unmanaged=False,
                 ref="tag_sha",
                 namespace_inject="foo",
+                package_dependency=dep_repo,
             ),
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/RootRepo",
                 subfolder="unpackaged/pre/first",
                 unmanaged=True,
                 ref="tag_sha",
+                package_dependency=root_repo,
             ),
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/RootRepo",
                 subfolder="unpackaged/pre/second",
                 unmanaged=True,
                 ref="tag_sha",
+                package_dependency=root_repo,
             ),
-            PackageNamespaceVersionDependency(
-                namespace="bar", version="2.0", package_name="RootRepo"
-            ),
+            root_repo,
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/RootRepo",
                 subfolder="unpackaged/post/first",
                 unmanaged=False,
                 ref="tag_sha",
                 namespace_inject="bar",
+                package_dependency=root_repo,
             ),
         ]
 
@@ -855,50 +863,58 @@ version_id: 04t000000000000""",
             pins=pins,
         )
 
+        dep_repo = PackageNamespaceVersionDependency(
+            namespace="foo",
+            version="1.0",  # from the pinned tag
+            package_name="DependencyRepo",
+            version_id="04t000000000000",
+        )
+        root_repo = PackageNamespaceVersionDependency(
+            namespace="bar",
+            version="1.5",  # From pinned tag
+            package_name="RootRepo",
+            version_id="04t000000000000",
+        )
+
         assert deps == [
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/DependencyRepo",
                 subfolder="unpackaged/pre/top",
                 unmanaged=True,
                 ref="tag_sha",
+                package_dependency=dep_repo,
             ),
-            PackageNamespaceVersionDependency(
-                namespace="foo",
-                version="1.0",  # from the pinned tag
-                package_name="DependencyRepo",
-                version_id="04t000000000000",
-            ),
+            dep_repo,
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/DependencyRepo",
                 subfolder="unpackaged/post/top",
                 unmanaged=False,
                 ref="tag_sha",
                 namespace_inject="foo",
+                package_dependency=dep_repo,
             ),
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/RootRepo",
                 subfolder="unpackaged/pre/first",
                 unmanaged=True,
                 ref="tag_sha",
+                package_dependency=root_repo,
             ),
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/RootRepo",
                 subfolder="unpackaged/pre/second",
                 unmanaged=True,
                 ref="tag_sha",
+                package_dependency=root_repo,
             ),
-            PackageNamespaceVersionDependency(
-                namespace="bar",
-                version="1.5",  # From pinned tag
-                package_name="RootRepo",
-                version_id="04t000000000000",
-            ),
+            root_repo,
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/RootRepo",
                 subfolder="unpackaged/post/first",
                 unmanaged=False,
                 ref="tag_sha",
                 namespace_inject="bar",
+                package_dependency=root_repo,
             ),
         ]
 
@@ -938,6 +954,16 @@ version_id: 04t000000000000""",
 
         gh = GitHubDynamicDependency(github="https://github.com/SFDO-Tooling/RootRepo")
 
+        root_repo = PackageNamespaceVersionDependency(
+            namespace="bar", version="2.0", package_name="RootRepo"
+        )
+        dep_repo = PackageNamespaceVersionDependency(
+            namespace="foo",
+            version="1.1",  # from the pinned tag
+            package_name="DependencyRepo",
+            password_env_name="DEP_PW",
+        )
+
         assert get_static_dependencies(
             project_config,
             dependencies=[gh],
@@ -949,6 +975,7 @@ version_id: 04t000000000000""",
                 subfolder="unpackaged/pre/top",
                 unmanaged=True,
                 ref="tag_sha",
+                package_dependency=dep_repo,
             ),
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/DependencyRepo",
@@ -956,28 +983,30 @@ version_id: 04t000000000000""",
                 unmanaged=False,
                 ref="tag_sha",
                 namespace_inject="foo",
+                package_dependency=dep_repo,
             ),
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/RootRepo",
                 subfolder="unpackaged/pre/first",
                 unmanaged=True,
                 ref="tag_sha",
+                package_dependency=root_repo,
             ),
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/RootRepo",
                 subfolder="unpackaged/pre/second",
                 unmanaged=True,
                 ref="tag_sha",
+                package_dependency=root_repo,
             ),
-            PackageNamespaceVersionDependency(
-                namespace="bar", version="2.0", package_name="RootRepo"
-            ),
+            root_repo,
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/RootRepo",
                 subfolder="unpackaged/post/first",
                 unmanaged=False,
                 ref="tag_sha",
                 namespace_inject="bar",
+                package_dependency=root_repo,
             ),
         ]
 
@@ -994,6 +1023,10 @@ version_id: 04t000000000000""",
 
         gh = GitHubDynamicDependency(github="https://github.com/SFDO-Tooling/RootRepo")
 
+        root_repo = PackageNamespaceVersionDependency(
+            namespace="bar", version="2.0", package_name="RootRepo"
+        )
+
         assert get_static_dependencies(
             project_config,
             dependencies=[gh],
@@ -1007,21 +1040,22 @@ version_id: 04t000000000000""",
                 subfolder="unpackaged/pre/first",
                 unmanaged=True,
                 ref="tag_sha",
+                package_dependency=root_repo,
             ),
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/RootRepo",
                 subfolder="unpackaged/pre/second",
                 unmanaged=True,
                 ref="tag_sha",
+                package_dependency=root_repo,
             ),
-            PackageNamespaceVersionDependency(
-                namespace="bar", version="2.0", package_name="RootRepo"
-            ),
+            root_repo,
             UnmanagedGitHubRefDependency(
                 github="https://github.com/SFDO-Tooling/RootRepo",
                 subfolder="unpackaged/post/first",
                 unmanaged=False,
                 ref="tag_sha",
                 namespace_inject="bar",
+                package_dependency=root_repo,
             ),
         ]

cumulusci/cumulusci.yml

@@ -823,10 +823,6 @@ tasks:
         class_path: cumulusci.tasks.salesforce.SfDataCommands.DataCreateRecordTask
         description: "Executes the `sf data create` command against an org"
         group: SalesforceDX Data Commands
-    get_first_item_from_record_list:
-        class_path: cumulusci.tasks.utility.data_management.GetFirstItemFromRecordListTask
-        description: "Get the first item from a record list"
-        group: Utilities
 flows:
     ci_beta:
         group: Continuous Integration