cumulusci-plus 5.0.16__tar.gz → 5.0.17__tar.gz

{cumulusci_plus-5.0.16 → cumulusci_plus-5.0.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cumulusci-plus
-Version: 5.0.16
+Version: 5.0.17
 Summary: Build and release tools for Salesforce developers
 Project-URL: Homepage, https://github.com/jorgesolebur/CumulusCI
 Project-URL: Changelog, https://cumulusci.readthedocs.io/en/stable/history.html
@@ -127,7 +127,7 @@ license](https://github.com/SFDO-Tooling/CumulusCI/blob/main/LICENSE)
 and is not covered by the Salesforce Master Subscription Agreement.
 
 <!-- Changelog -->
-## v5.0.16 (2025-08-20)
+## v5.0.17 (2025-08-21)
 
 <!-- Release notes generated using configuration in .github/release.yml at main -->
 
@@ -135,6 +135,6 @@ and is not covered by the Salesforce Master Subscription Agreement.
 
 ### Changes
 
-- Add configure_env task and fix failing test classes. by [@rupeshjSFDC](https://github.com/rupeshjSFDC) in [#57](https://github.com/jorgesolebur/CumulusCI/pull/57)
+- Add custom data type vcs_repo. by [@rupeshjSFDC](https://github.com/rupeshjSFDC) in [#59](https://github.com/jorgesolebur/CumulusCI/pull/59)
 
-**Full Changelog**: https://github.com/jorgesolebur/CumulusCI/compare/v5.0.15...v5.0.16
+**Full Changelog**: https://github.com/jorgesolebur/CumulusCI/compare/v5.0.16...v5.0.17

cumulusci_plus-5.0.17/cumulusci/__about__.py

@@ -0,0 +1 @@
+__version__ = "5.0.17"

cumulusci_plus-5.0.17/cumulusci/tasks/utility/env_management.py

@@ -0,0 +1,190 @@
+import json
+import logging
+import os
+from datetime import date
+from pathlib import Path
+from typing import Any, List, Optional
+
+from pydantic import BaseModel, validator
+
+from cumulusci.core.config import BaseProjectConfig, OrgConfig, TaskConfig
+from cumulusci.core.tasks import BaseTask
+from cumulusci.utils.options import CCIOptions, Field
+from cumulusci.vcs.bootstrap import get_repo_from_url
+
+
+class EnvManagementOption(CCIOptions):
+    name: str = Field(
+        ...,
+        description="The name of the environment variable to get the value from the environment",
+    )
+    default: Any = Field(
+        default=None,
+        description="The default value of the environment variable. Defaults to None",
+    )
+    datatype: str = Field(
+        default="string",
+        description="The datatype of the environment variable. Defaults to string. Valid values are string, bool, int, float, date, list, dict, path, directory, filename, vcs_repo",
+    )
+    set: bool = Field(
+        default=False,
+        description="If True, sets the value of the environment variable if it is not already set. Defaults to False",
+    )
+
+    @validator("datatype")
+    def validate_datatype(cls, v):
+        if v not in [
+            "string",
+            "bool",
+            "int",
+            "float",
+            "date",
+            "list",
+            "dict",
+            "path",
+            "directory",
+            "filename",
+            "vcs_repo",
+        ]:
+            raise ValueError(f"Invalid datatype: {v}")
+        return v
+
+    def formated_value(
+        self,
+        task_values: dict[str, Any],
+        project_config: Optional[BaseProjectConfig],
+        org_config: Optional[OrgConfig],
+        logger: logging.Logger,
+    ) -> None:
+        value = os.getenv(self.name, self.default)
+        datatype = self.datatype or "string"
+
+        try:
+            if self.name not in task_values:
+                match datatype:
+                    case "string":
+                        task_values[self.name] = str(value)
+                    case "bool":
+                        v = DummyValidatorModel(b=value).b
+                        task_values[self.name] = v
+                    case "int":
+                        v = DummyValidatorModel(i=value).i
+                        task_values[self.name] = v
+                    case "float":
+                        v = DummyValidatorModel(f=value).f
+                        task_values[self.name] = v
+                    case "date":
+                        v = DummyValidatorModel(d=date.fromisoformat(str(value))).d
+                        task_values[self.name] = v
+                    case "list":
+                        v = value if isinstance(value, list) else value.split(",")
+                        task_values[self.name] = v
+                    case "dict":
+                        v = value if isinstance(value, dict) else json.loads(str(value))
+                        task_values[self.name] = v
+                    case "path":
+                        v = Path(str(value))
+                        task_values[self.name] = v.absolute()
+                    case "directory":
+                        v = Path(str(value)).parent.absolute()
+                        task_values[self.name] = v.absolute()
+                    case "filename":
+                        v = Path(str(value)).name
+                        task_values[self.name] = v
+                    case "vcs_repo":
+                        task_config = TaskConfig(
+                            {"options": {"url": self.default, "name": self.name}}
+                        )
+                        task = VcsRemoteBranch(project_config, task_config, org_config)
+                        result = task()
+                        task_values[self.name] = result["url"]
+                        task_values[f"{self.name}_BRANCH"] = result["branch"]
+                    case _:
+                        raise ValueError(f"Invalid datatype: {datatype}")
+            else:
+                logger.info(f"Variable {self.name} already set. Skipping.")
+
+        except Exception as e:
+            raise ValueError(
+                f"Formatting Error: {value} for datatype: {datatype} - {e}"
+            )
+
+        if self.set and self.name not in os.environ:
+            os.environ[self.name] = str(task_values[self.name])
+
+        if (
+            self.set
+            and self.datatype == "vcs_repo"
+            and f"{self.name}_BRANCH" not in os.environ
+        ):
+            os.environ[f"{self.name}_BRANCH"] = str(task_values[f"{self.name}_BRANCH"])
+
+
+class DummyValidatorModel(BaseModel):
+    b: Optional[bool]
+    i: Optional[int]
+    f: Optional[float]
+    d: Optional[date]
+
+
+class EnvManagement(BaseTask):
+    class Options(CCIOptions):
+        envs: List[EnvManagementOption] = Field(
+            default=[],
+            description="A list of environment variables definitions.",
+        )
+
+    parsed_options: Options
+
+    def _run_task(self):
+        self.return_values = {}
+
+        for env_option in self.parsed_options.envs:
+            env_option.formated_value(
+                self.return_values, self.project_config, self.org_config, self.logger
+            )
+
+        return self.return_values
+
+
+class VcsRemoteBranch(BaseTask):
+    class Options(CCIOptions):
+        url: str = Field(
+            ...,
+            description="Gets if the remote branch name exist with the same name in the remote repository.",
+        )
+        name: str = Field(
+            ...,
+            description="The name of the environment variable.",
+        )
+
+    parsed_options: Options
+
+    def _run_task(self):
+        self.return_values = {}
+
+        # Get current branch name. Based on Local Git Branch if not available from Environment Variable
+        local_branch = os.getenv(
+            f"{self.parsed_options.name}_BRANCH", self.project_config.repo_branch
+        )
+
+        # Get repository URL from Environment Variable
+        self.return_values["url"] = os.getenv(
+            self.parsed_options.name, self.parsed_options.url
+        )
+
+        repo = get_repo_from_url(self.project_config, self.return_values["url"])
+
+        try:
+            branch = repo.branch(local_branch)
+            self.logger.info(
+                f"Branch {local_branch} found in repository {self.return_values['url']}."
+            )
+            self.return_values["branch"] = branch.name
+        except Exception:
+            self.logger.warning(
+                f"Branch {local_branch} not found in repository {self.return_values['url']}. Using default branch {repo.default_branch}"
+            )
+            self.return_values["branch"] = repo.default_branch
+
+        return self.return_values

{cumulusci_plus-5.0.16 → cumulusci_plus-5.0.17}/cumulusci/tasks/utility/tests/test_env_management.py

@@ -18,7 +18,12 @@ class TestVcsRemoteBranch(unittest.TestCase):
         project_config = create_project_config()
         project_config.repo_info["branch"] = "feature/branch-1"
         task_config = TaskConfig(
-            {"options": {"url": "https://github.com/TestOwner/TestRepo"}}
+            {
+                "options": {
+                    "url": "https://github.com/TestOwner/TestRepo",
+                    "name": "VCS_URL",
+                }
+            }
         )
 
         with patch(
@@ -32,14 +37,22 @@ class TestVcsRemoteBranch(unittest.TestCase):
 
             task = VcsRemoteBranch(project_config, task_config)
             task()
-            self.assertEqual(task.return_values["remote_branch"], "feature/branch-1")
+            self.assertEqual(
+                task.return_values["url"], "https://github.com/TestOwner/TestRepo"
+            )
+            self.assertEqual(task.return_values["branch"], "feature/branch-1")
             repo_mock.branch.assert_called_once_with("feature/branch-1")
 
     def test_run_task_branch_not_exist(self):
         project_config = create_project_config()
         project_config.repo_info["branch"] = "feature/branch-1"
         task_config = TaskConfig(
-            {"options": {"url": "https://github.com/TestOwner/TestRepo"}}
+            {
+                "options": {
+                    "url": "https://github.com/TestOwner/TestRepo",
+                    "name": "VCS_URL",
+                }
+            }
         )
 
         with patch(
@@ -52,7 +65,10 @@ class TestVcsRemoteBranch(unittest.TestCase):
 
             task = VcsRemoteBranch(project_config, task_config)
             task()
-            self.assertEqual(task.return_values["remote_branch"], "main")
+            self.assertEqual(
+                task.return_values["url"], "https://github.com/TestOwner/TestRepo"
+            )
+            self.assertEqual(task.return_values["branch"], "main")
             repo_mock.branch.assert_called_once_with("feature/branch-1")
 
 
@@ -177,20 +193,21 @@ class TestEnvManagement(unittest.TestCase):
             task()
 
     @patch("cumulusci.tasks.utility.env_management.VcsRemoteBranch")
-    def test_vcs_branch_datatype(self, vcs_mock):
-        os.environ["TEST_VAR"] = ""  # vcs_branch doesn't use env var
-
+    def test_vcs_repo_datatype(self, vcs_mock):
         vcs_instance_mock = vcs_mock.return_value
-        vcs_instance_mock.return_value = {"remote_branch": "my-feature-branch"}
+        vcs_instance_mock.return_value = {
+            "url": "https://github.com/TestOwner/TestRepo",
+            "branch": "my-feature-branch",
+        }
 
         task_config = TaskConfig(
             {
                 "options": {
                     "envs": [
                         {
-                            "name": "VCS_BRANCH",
-                            "datatype": "vcs_branch",
-                            "url": "https://github.com/TestOwner/TestRepo",
+                            "name": "VCS_URL",
+                            "datatype": "vcs_repo",
+                            "default": "https://github.com/TestOwner/TestRepo",
                         }
                     ]
                 }
@@ -199,7 +216,8 @@ class TestEnvManagement(unittest.TestCase):
         task = EnvManagement(self.project_config, task_config, self.org_config)
         result = task()
 
-        self.assertEqual(result["VCS_BRANCH"], "my-feature-branch")
+        self.assertEqual(result["VCS_URL"], "https://github.com/TestOwner/TestRepo")
+        self.assertEqual(result["VCS_URL_BRANCH"], "my-feature-branch")
         vcs_mock.assert_called_once()
 
     @patch.dict(os.environ, {}, clear=True)

{cumulusci_plus-5.0.16 → cumulusci_plus-5.0.17}/docs/history.md

@@ -2,6 +2,20 @@
 
 <!-- latest-start -->
 
+## v5.0.17 (2025-08-21)
+
+<!-- Release notes generated using configuration in .github/release.yml at main -->
+
+## What's Changed
+
+### Changes
+
+- Add custom data type vcs_repo. by [@rupeshjSFDC](https://github.com/rupeshjSFDC) in [#59](https://github.com/jorgesolebur/CumulusCI/pull/59)
+
+**Full Changelog**: https://github.com/jorgesolebur/CumulusCI/compare/v5.0.16...v5.0.17
+
+<!-- latest-stop -->
+
 ## v5.0.16 (2025-08-20)
 
 <!-- Release notes generated using configuration in .github/release.yml at main -->
@@ -14,8 +28,6 @@
 
 **Full Changelog**: https://github.com/jorgesolebur/CumulusCI/compare/v5.0.15...v5.0.16
 
-<!-- latest-stop -->
-
 ## v5.0.15 (2025-08-03)
 
 <!-- Release notes generated using configuration in .github/release.yml at main -->
@@ -1897,9 +1909,9 @@ Critical Changes:
       subfolders will see a change in resolution behavior. Previously,
       a dependency specified like this:
 
-                                            dependencies:
-                                                - github: https://github.com/SalesforceFoundation/NPSP
-                                                  subfolder: unpackaged/config/trial
+                                              dependencies:
+                                                  - github: https://github.com/SalesforceFoundation/NPSP
+                                                    subfolder: unpackaged/config/trial
 
         would always deploy from the latest commit on the default
         branch. Now, this dependency will be resolved to a GitHub commit
@@ -1910,12 +1922,12 @@ Critical Changes:
     - The `project__dependencies` section in `cumulusci.yml` no longer
       supports nested dependencies specified like this:
 
-                                            dependencies:
-                                                - namespace: "test"
-                                                  version: "1.0"
-                                                  dependencies:
-                                                    - namespace: "parent"
-                                                      version: "2.2"
+                                              dependencies:
+                                                  - namespace: "test"
+                                                    version: "1.0"
+                                                    dependencies:
+                                                      - namespace: "parent"
+                                                        version: "2.2"
 
         All dependencies should be listed in install order.
 
@@ -2083,12 +2095,12 @@ Critical changes:
     - The `project__dependencies` section in `cumulusci.yml` will no
       longer support nested dependencies specified like this :
 
-                                            dependencies:
-                                              - namespace: "test"
-                                                version: "1.0"
-                                                dependencies:
-                                                  - namespace: "parent"
-                                                    version: "2.2"
+                                              dependencies:
+                                                - namespace: "test"
+                                                  version: "1.0"
+                                                  dependencies:
+                                                    - namespace: "parent"
+                                                      version: "2.2"
 
     All dependencies should be listed in install order.
 
@@ -3690,33 +3702,33 @@ New features:
 
     : -
 
-                                            Added keywords for generating a collection of sObjects according to a template:
+                                              Added keywords for generating a collection of sObjects according to a template:
 
-                                            :   -   `Generate Test Data`
-                                                -   `Salesforce Collection Insert`
-                                                -   `Salesforce Collection Update`
+                                              :   -   `Generate Test Data`
+                                                  -   `Salesforce Collection Insert`
+                                                  -   `Salesforce Collection Update`
 
-                                        -
+                                          -
 
-                                            Changes to Page Objects:
+                                              Changes to Page Objects:
 
-                                            :   -   More than one page object can be loaded at once.
-                                                    Once loaded, the keywords of a page object remain
-                                                    visible in the suite. Robot will give priority to
-                                                    keywords in the reverse order in which they were
-                                                    imported.
-                                                -   There is a new keyword, `Log Current Page Object`,
-                                                    which can be useful to see information about the
-                                                    most recently loaded page object.
-                                                -   There is a new keyword, `Get Page Object`, which
-                                                    will return the robot library for a given page
-                                                    object. This can be used in other keywords to access
-                                                    keywords from another page object if necessary.
-                                                -   The `Go To Page` keyword will now automatically load
-                                                    the page object for the given page.
+                                              :   -   More than one page object can be loaded at once.
+                                                      Once loaded, the keywords of a page object remain
+                                                      visible in the suite. Robot will give priority to
+                                                      keywords in the reverse order in which they were
+                                                      imported.
+                                                  -   There is a new keyword, `Log Current Page Object`,
+                                                      which can be useful to see information about the
+                                                      most recently loaded page object.
+                                                  -   There is a new keyword, `Get Page Object`, which
+                                                      will return the robot library for a given page
+                                                      object. This can be used in other keywords to access
+                                                      keywords from another page object if necessary.
+                                                  -   The `Go To Page` keyword will now automatically load
+                                                      the page object for the given page.
 
-                                        -   Added a basic debugger for Robot tests. It can be enabled
-                                            using the `-o debug True` option to the robot task.
+                                          -   Added a basic debugger for Robot tests. It can be enabled
+                                              using the `-o debug True` option to the robot task.
 
 - Added support for deploying new metadata types
   `ProfilePasswordPolicy` and `ProfileSessionSetting`.
@@ -3791,8 +3803,8 @@ New features:
   permanently set this option, add this in
   `~/.cumulusci/cumulusci.yml`:
 
-                                        cli:
-                                            plain_output: True
+                                          cli:
+                                              plain_output: True
 
 - Added additional info to the `cci version` command, including the
   Python version, an upgrade check, and a warning on Python 2.
@@ -5071,12 +5083,12 @@ Resolving a few issues from beta77:
   below. In flows that need to inject the actual namespace prefix,
   override the [unmanaged]{.title-ref} option .. :
 
-                                        custom_deploy_task:
-                                            class_path: cumulusci.tasks.salesforce.Deploy
-                                            options:
-                                                path: your/custom/metadata
-                                                namespace_inject: $project_config.project__package__namespace
-                                                unmanaged: False
+                                          custom_deploy_task:
+                                              class_path: cumulusci.tasks.salesforce.Deploy
+                                              options:
+                                                  path: your/custom/metadata
+                                                  namespace_inject: $project_config.project__package__namespace
+                                                  unmanaged: False
 
 ### Enhancements
 
@@ -5791,13 +5803,13 @@ Resolving a few issues from beta77:
 - **IMPORANT** This release changes the yaml structure for flows. The
   new structure now looks like this:
 
-                                        flows:
-                                            flow_name:
-                                                tasks:
-                                                    1:
-                                                        task: deploy
-                                                    2:
-                                                        task: run_tests
+                                          flows:
+                                              flow_name:
+                                                  tasks:
+                                                      1:
+                                                          task: deploy
+                                                      2:
+                                                          task: run_tests
 
 - See the new flow customization examples in the cookbook for examples
   of why this change was made and how to use it:

cumulusci_plus-5.0.16/cumulusci/__about__.py

@@ -1 +0,0 @@
-__version__ = "5.0.16"

cumulusci_plus-5.0.16/cumulusci/tasks/utility/env_management.py

@@ -1,157 +0,0 @@
-import json
-import os
-from datetime import date
-from pathlib import Path
-from typing import Any, List, Optional
-
-from pydantic import BaseModel, validator
-
-from cumulusci.core.config import BaseProjectConfig, OrgConfig, TaskConfig
-from cumulusci.core.tasks import BaseTask
-from cumulusci.utils.options import CCIOptions, Field
-from cumulusci.vcs.bootstrap import get_repo_from_url
-
-
-class EnvManagementOption(CCIOptions):
-    name: str = Field(
-        ...,
-        description="The name of the environment variable to get the value from the environment",
-    )
-    default: Any = Field(
-        default=None,
-        description="The default value of the environment variable. Defaults to None",
-    )
-    datatype: str = Field(
-        default="string",
-        description="The datatype of the environment variable. Defaults to string. Valid values are string, bool, int, float, date, list, dict, path, directory, filename, vcs_branch",
-    )
-    set: bool = Field(
-        default=False,
-        description="If True, sets the value of the environment variable if it is not already set. Defaults to False",
-    )
-    url: str = Field(
-        default="",
-        description="The url of the repository to get the branch value from, Applicable only for vcs_branch datatype. Defaults to empty string",
-    )
-
-    @validator("datatype")
-    def validate_datatype(cls, v):
-        if v not in [
-            "string",
-            "bool",
-            "int",
-            "float",
-            "date",
-            "list",
-            "dict",
-            "path",
-            "directory",
-            "filename",
-            "vcs_branch",
-        ]:
-            raise ValueError(f"Invalid datatype: {v}")
-        return v
-
-    def formated_value(
-        self,
-        project_config: Optional[BaseProjectConfig],
-        org_config: Optional[OrgConfig],
-    ) -> tuple[Any, str]:
-        value = os.getenv(self.name, self.default)
-        datatype = self.datatype or "string"
-
-        try:
-            match datatype:
-                case "string":
-                    return str(value), str(value)
-                case "bool":
-                    v = DummyValidatorModel(b=value).b
-                    return v, str(v)
-                case "int":
-                    v = DummyValidatorModel(i=value).i
-                    return v, str(v)
-                case "float":
-                    v = DummyValidatorModel(f=value).f
-                    return v, str(v)
-                case "date":
-                    v = DummyValidatorModel(d=date.fromisoformat(str(value))).d
-                    return v, str(v)
-                case "list":
-                    v = value if isinstance(value, list) else value.split(",")
-                    return v, str(v)
-                case "dict":
-                    v = value if isinstance(value, dict) else json.loads(str(value))
-                    return v, str(v)
-                case "path":
-                    v = Path(str(value))
-                    return v.absolute(), str(v.absolute())
-                case "directory":
-                    v = Path(str(value)).parent.absolute()
-                    return v, str(v.absolute())
-                case "filename":
-                    v = Path(str(value)).name
-                    return v, str(v)
-                case "vcs_branch":
-                    task_config = TaskConfig({"options": {"url": self.url}})
-                    task = VcsRemoteBranch(project_config, task_config, org_config)
-                    result = task()
-                    return result["remote_branch"], str(result["remote_branch"])
-                case _:
-                    raise ValueError(f"Invalid datatype: {datatype}")
-        except Exception as e:
-            raise ValueError(
-                f"Formatting Error: {value} for datatype: {datatype} - {e}"
-            )
-
-
-class DummyValidatorModel(BaseModel):
-    b: Optional[bool]
-    i: Optional[int]
-    f: Optional[float]
-    d: Optional[date]
-
-
-class EnvManagement(BaseTask):
-    class Options(CCIOptions):
-        envs: List[EnvManagementOption] = Field(
-            default=[],
-            description="A list of environment variables definitions.",
-        )
-
-    parsed_options: Options
-
-    def _run_task(self):
-        self.return_values = {}
-
-        for env_option in self.parsed_options.envs:
-            self.return_values[env_option.name], str_value = env_option.formated_value(
-                self.project_config, self.org_config
-            )
-            if env_option.set and env_option.name not in os.environ:
-                os.environ[env_option.name] = str_value
-
-        return self.return_values
-
-
-class VcsRemoteBranch(BaseTask):
-    class Options(CCIOptions):
-        url: str = Field(
-            ...,
-            description="Gets if the remote branch name exist with the same name in the remote repository.",
-        )
-
-    parsed_options: Options
-
-    def _run_task(self):
-        self.return_values = {}
-        # Get current branch name.
-        local_branch = self.project_config.repo_branch
-        repo = get_repo_from_url(self.project_config, self.parsed_options.url)
-
-        try:
-            branch = repo.branch(local_branch)
-            self.return_values["remote_branch"] = branch.name
-        except Exception:
-            self.return_values["remote_branch"] = repo.default_branch
-
-        return self.return_values