cumulusci-plus 5.0.16__py3-none-any.whl → 5.0.17__py3-none-any.whl

cumulusci/__about__.py

@@ -1 +1 @@
-__version__ = "5.0.16"
+__version__ = "5.0.17"

cumulusci/tasks/utility/env_management.py

@@ -1,4 +1,5 @@
 import json
+import logging
 import os
 from datetime import date
 from pathlib import Path
@@ -23,16 +24,12 @@ class EnvManagementOption(CCIOptions):
     )
     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",
+        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",
     )
-    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):
@@ -47,62 +44,81 @@ class EnvManagementOption(CCIOptions):
             "path",
             "directory",
             "filename",
-            "vcs_branch",
+            "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],
-    ) -> tuple[Any, str]:
+        logger: logging.Logger,
+    ) -> None:
         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}")
+            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]
@@ -124,11 +140,9 @@ class EnvManagement(BaseTask):
         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
+            env_option.formated_value(
+                self.return_values, self.project_config, self.org_config, self.logger
             )
-            if env_option.set and env_option.name not in os.environ:
-                os.environ[env_option.name] = str_value
 
         return self.return_values
 
@@ -139,19 +153,38 @@ class VcsRemoteBranch(BaseTask):
             ...,
             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.
-        local_branch = self.project_config.repo_branch
-        repo = get_repo_from_url(self.project_config, self.parsed_options.url)
+
+        # 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.return_values["remote_branch"] = branch.name
+            self.logger.info(
+                f"Branch {local_branch} found in repository {self.return_values['url']}."
+            )
+            self.return_values["branch"] = branch.name
         except Exception:
-            self.return_values["remote_branch"] = repo.default_branch
+            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/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.dist-info → cumulusci_plus-5.0.17.dist-info}/METADATA

@@ -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.16.dist-info → cumulusci_plus-5.0.17.dist-info}/RECORD

@@ -1,4 +1,4 @@
-cumulusci/__about__.py,sha256=6Zfa5_jynCBYIvtkYN0Ygch4VWXnobnaeed612gFG18,23
+cumulusci/__about__.py,sha256=x4NllGN1pNABBzi1vkIo-rQ2JSdgVyJUAI6uFT43BEA,23
 cumulusci/__init__.py,sha256=jdanFQ_i8vbdO7Eltsf4pOfvV4mwa_Osyc4gxWKJ8ng,764
 cumulusci/__main__.py,sha256=kgRH-n5AJrH_daCK_EJwH7azAUxdXEmpi-r-dPGMR6Y,43
 cumulusci/conftest.py,sha256=AIL98BDwNAQtdo8YFmLKwav0tmrQ5dpbw1cX2FyGouQ,5108
@@ -611,8 +611,8 @@ cumulusci/tasks/tests/test_pushfails.py,sha256=9JG9D0iD4dR-1fKheaRN7BEy3lzzuOKeR
 cumulusci/tasks/tests/test_salesforce.py,sha256=yCGtuHapxyAEmXQhuF2g2fh2naknTu7Md4OfEJQvGAA,2594
 cumulusci/tasks/tests/test_sfdx.py,sha256=oUbHo28d796m5RuskXMLitJw2rCLjjXIfxggzr4gsso,3545
 cumulusci/tasks/tests/test_util.py,sha256=D1T0QnvPTS0PHeZWo2xiVgE1jVTYcLzGTGHwEIoVmxk,7296
-cumulusci/tasks/utility/env_management.py,sha256=RIxciQHPVMnJjwNvYkeq30QrMISagF4qx2zSRiXjExQ,5382
-cumulusci/tasks/utility/tests/test_env_management.py,sha256=e0cVAohNzpDUPDvS5LrIcd2Cqv0pkQ_KYvjX6qsREj8,8155
+cumulusci/tasks/utility/env_management.py,sha256=nJyv7KFtaBaAUK_40h-FpyfHTd7xSfEFkm9cj-tOhqc,6715
+cumulusci/tasks/utility/tests/test_env_management.py,sha256=fw34meWGOe1YYZO449MMCi2O7BgSaOA_I_wScrIr1Uk,8702
 cumulusci/tasks/vcs/__init__.py,sha256=ZzpMZnhooXZ6r_ywBVTS3UNw9uMcXW6h33LylRqTDK0,700
 cumulusci/tasks/vcs/commit_status.py,sha256=hgPUVHeQyIfMsCuwrw2RI-ufnbjdRARc6HI3BEgdcxI,2332
 cumulusci/tasks/vcs/create_commit_status.py,sha256=kr_OFM3J32jxusS1og-K91Kl1F_Nr7SlevRsJKBhifs,1565
@@ -738,9 +738,9 @@ cumulusci/vcs/tests/dummy_service.py,sha256=RltOUpMIhSDNrfxk0LhLqlH4ppC0sK6NC2cO
 cumulusci/vcs/tests/test_vcs_base.py,sha256=9mp6uZ3lTxY4onjUNCucp9N9aB3UylKS7_2Zu_hdAZw,24331
 cumulusci/vcs/tests/test_vcs_bootstrap.py,sha256=N0NA48-rGNIIjY3Z7PtVnNwHObSlEGDk2K55TQGI8g4,27954
 cumulusci/vcs/utils/__init__.py,sha256=py4fEcHM7Vd0M0XWznOlywxaeCtG3nEVGmELmEKVGU8,869
-cumulusci_plus-5.0.16.dist-info/METADATA,sha256=1w8L_cNeKkI7tHu_r8PY7nltM-adAck3ZpmjDqihHCk,5773
-cumulusci_plus-5.0.16.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cumulusci_plus-5.0.16.dist-info/entry_points.txt,sha256=nTtu04b9iLXhzADcTrb5PwmdXE6e2MTUAMh9OK6Z2pg,80
-cumulusci_plus-5.0.16.dist-info/licenses/AUTHORS.rst,sha256=PvewjKImdKPhhJ6xR2EEZ4T7GbpY2ZeAeyWm2aLtiMQ,676
-cumulusci_plus-5.0.16.dist-info/licenses/LICENSE,sha256=NFsF_s7RVXk2dU6tmRAN8wF45pnD98VZ5IwqOsyBcaU,1499
-cumulusci_plus-5.0.16.dist-info/RECORD,,
+cumulusci_plus-5.0.17.dist-info/METADATA,sha256=hO8FAqzbbv4M0ugIDh2QHRGmg7WArDbaCBGrPgW4Vto,5751
+cumulusci_plus-5.0.17.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+cumulusci_plus-5.0.17.dist-info/entry_points.txt,sha256=nTtu04b9iLXhzADcTrb5PwmdXE6e2MTUAMh9OK6Z2pg,80
+cumulusci_plus-5.0.17.dist-info/licenses/AUTHORS.rst,sha256=PvewjKImdKPhhJ6xR2EEZ4T7GbpY2ZeAeyWm2aLtiMQ,676
+cumulusci_plus-5.0.17.dist-info/licenses/LICENSE,sha256=NFsF_s7RVXk2dU6tmRAN8wF45pnD98VZ5IwqOsyBcaU,1499
+cumulusci_plus-5.0.17.dist-info/RECORD,,