cumulusci 3.53.0.dev1__tar.gz → 3.54.0.dev0__tar.gz

{cumulusci-3.53.0.dev1 → cumulusci-3.54.0.dev0}/HISTORY.rst

@@ -2,6 +2,27 @@
 History
 =======
 
+3.53.0 (2022-02-24)
+-------------------
+
+Critical Changes
+
+- CumulusCI now ships with Snowfakery 3.0. See the `Snowfakery release notes <https://github.com/SFDO-Tooling/Snowfakery/releases/tag/v3.0.0>`__. Snowfakery 3.0 ships with opt-in features that will become the default in June 2022; please `test your recipes <https://snowfakery.readthedocs.io/en/latest/#snowfakery-3>`__  now with ``snowfakery_version: 3`` to ensure compatibility.
+
+Changes
+
+- CumulusCI now has an ``update_data`` task that allows updates to existing datasets, in coordination with Snowfakery 3.0.
+- Orgs connected using ``cci org connect`` now keep track of which ``connected_app`` service was used to connect them, and will use the same ``connected_app`` service when getting a fresh access token, even if it isn't currently the default ``connected_app`` service. This makes it easier to use CumulusCI with multiple ``connected_app`` services. (Orgs that were connected before this update will continue to use the default ``connected_app`` service.)
+- When connecting a custom ``connected_app`` service, a default ``login_url`` can be specified (to use a login URL other than https://login.salesforce.com when connecting orgs using this ``connected_app`` service).
+- The ``deploy_marketing_cloud_package`` task now utilizes the new API endpoint for deployments.
+- CumulusCI commands are more resilient in the face of corrupted or impossible to decode org config files.
+- We added documentation about managing Robot Framework locators
+- CumulusCI will now warn Windows users if long pathname support is not set up correctly.
+
+Issues Closed
+
+- Fixed a bug in the JSON format output of cci service list --json
+
 3.52.0 (2022-02-03)
 -------------------
 

{cumulusci-3.53.0.dev1 → cumulusci-3.54.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cumulusci
-Version: 3.53.0.dev1
+Version: 3.54.0.dev0
 Summary: Build and release tools for Salesforce developers
 Home-page: https://github.com/SFDO-Tooling/CumulusCI
 Author: Salesforce.org
@@ -66,6 +66,27 @@ Description: =========
         History
         =======
         
+        3.53.0 (2022-02-24)
+        -------------------
+        
+        Critical Changes
+        
+        - CumulusCI now ships with Snowfakery 3.0. See the `Snowfakery release notes <https://github.com/SFDO-Tooling/Snowfakery/releases/tag/v3.0.0>`__. Snowfakery 3.0 ships with opt-in features that will become the default in June 2022; please `test your recipes <https://snowfakery.readthedocs.io/en/latest/#snowfakery-3>`__  now with ``snowfakery_version: 3`` to ensure compatibility.
+        
+        Changes
+        
+        - CumulusCI now has an ``update_data`` task that allows updates to existing datasets, in coordination with Snowfakery 3.0.
+        - Orgs connected using ``cci org connect`` now keep track of which ``connected_app`` service was used to connect them, and will use the same ``connected_app`` service when getting a fresh access token, even if it isn't currently the default ``connected_app`` service. This makes it easier to use CumulusCI with multiple ``connected_app`` services. (Orgs that were connected before this update will continue to use the default ``connected_app`` service.)
+        - When connecting a custom ``connected_app`` service, a default ``login_url`` can be specified (to use a login URL other than https://login.salesforce.com when connecting orgs using this ``connected_app`` service).
+        - The ``deploy_marketing_cloud_package`` task now utilizes the new API endpoint for deployments.
+        - CumulusCI commands are more resilient in the face of corrupted or impossible to decode org config files.
+        - We added documentation about managing Robot Framework locators
+        - CumulusCI will now warn Windows users if long pathname support is not set up correctly.
+        
+        Issues Closed
+        
+        - Fixed a bug in the JSON format output of cci service list --json
+        
         3.52.0 (2022-02-03)
         -------------------
         

{cumulusci-3.53.0.dev1 → cumulusci-3.54.0.dev0}/cumulusci/cli/cci.py

@@ -25,7 +25,12 @@ from .project import project
 from .runtime import CliRuntime, pass_runtime
 from .service import service
 from .task import task
-from .utils import check_latest_version, get_installed_version, get_latest_final_version
+from .utils import (
+    check_latest_version,
+    get_installed_version,
+    get_latest_final_version,
+    warn_if_no_long_paths,
+)
 
 SUGGEST_ERROR_COMMAND = (
     """Run this command for more information about debugging errors: cci error --help"""
@@ -142,6 +147,7 @@ def show_version_info():
     console.print(f"CumulusCI version: {cumulusci.__version__} ({sys.argv[0]})")
     console.print(f"Python version: {sys.version.split()[0]} ({sys.executable})")
     console.print()
+    warn_if_no_long_paths(console=console)
 
     current_version = get_installed_version()
     latest_version = get_latest_final_version()

{cumulusci-3.53.0.dev1 → cumulusci-3.54.0.dev0}/cumulusci/cli/error.py

@@ -8,6 +8,7 @@ import click
 import github3
 
 import cumulusci
+from cumulusci.cli.utils import warn_if_no_long_paths, win32_long_paths_enabled
 from cumulusci.core.exceptions import CumulusCIException
 from cumulusci.core.github import check_github_scopes, create_gist, get_github_api
 
@@ -40,7 +41,8 @@ def error():
     """
 
 
-CCI_LOGFILE_PATH = Path.home() / ".cumulusci" / "logs" / "cci.log"
+def get_logfile_path():
+    return Path.home() / ".cumulusci" / "logs" / "cci.log"
 
 
 @error.command(
@@ -48,11 +50,13 @@ CCI_LOGFILE_PATH = Path.home() / ".cumulusci" / "logs" / "cci.log"
     help="Outputs the most recent traceback (if one exists in the most recent log)",
 )
 def error_info():
-    if not CCI_LOGFILE_PATH.is_file():
-        click.echo(f"No logfile found at: {CCI_LOGFILE_PATH}")
+    warn_if_no_long_paths()
+    logfile_path = get_logfile_path()
+    if not logfile_path.is_file():
+        click.echo(f"No logfile found at: {logfile_path}")
         return
 
-    traceback = get_traceback(CCI_LOGFILE_PATH.read_text(encoding="utf-8"))
+    traceback = get_traceback(logfile_path.read_text(encoding="utf-8"))
     click.echo(traceback)
 
 
@@ -60,7 +64,7 @@ def get_traceback(log_content: str) -> str:
     """Returns the the traceback in a logfile if it exists."""
     stacktrace_start = "Traceback (most recent call last):"
     if stacktrace_start not in log_content:
-        return f"\nNo stacktrace found in: {CCI_LOGFILE_PATH}\n"
+        return f"\nNo stacktrace found in: {get_logfile_path()}\n"
 
     stacktrace = ""
     for i, line in enumerate(reversed(log_content.split("\n")), 1):
@@ -73,13 +77,14 @@ def get_traceback(log_content: str) -> str:
 
 @error.command(name="gist", help="Creates a GitHub gist from the latest logfile")
 @pass_runtime(require_project=False, require_keychain=True)
-def gist(runtime):
-    if CCI_LOGFILE_PATH.is_file():
-        log_content = CCI_LOGFILE_PATH.read_text(encoding="utf-8")
+def error_gist(runtime):
+    logfile_path = get_logfile_path()
+    if logfile_path.is_file():
+        log_content = logfile_path.read_text(encoding="utf-8")
     else:
         log_not_found_msg = """No logfile to open at path: {}
         Please ensure you're running this command from the same directory you were experiencing an issue."""
-        error_msg = log_not_found_msg.format(CCI_LOGFILE_PATH)
+        error_msg = log_not_found_msg.format(logfile_path)
         click.echo(error_msg)
         raise CumulusCIException(error_msg)
 
@@ -115,4 +120,6 @@ def get_context_info():
     info.append(f"CumulusCI version: {cumulusci.__version__}")
     info.append(f"Python version: {sys.version.split()[0]} ({sys.executable})")
     info.append(f"Environment Info: {host_info.system} / {host_info.machine}")
+    if host_info.system == "Windows":
+        info.append(f"Windows long path support enabled: {win32_long_paths_enabled()}")
     return "\n".join(info)

{cumulusci-3.53.0.dev1 → cumulusci-3.54.0.dev0}/cumulusci/cli/org.py

@@ -348,12 +348,22 @@ def org_info(runtime, org_name, print_json):
 )
 @pass_runtime(require_project=False, require_keychain=True)
 def org_list(runtime, json_flag, plain):
+    def _get_org_safe(org):
+        try:
+            return runtime.keychain.get_org(org)
+        except Exception as e:
+            click.echo(f"Cannot load org config for `{org}`: {e}")
+
     plain = plain or runtime.universal_config.cli__plain_output
-    org_configs = {
-        org: runtime.keychain.get_org(org) for org in runtime.keychain.list_orgs()
-    }
+    org_configs = ((org, _get_org_safe(org)) for org in runtime.keychain.list_orgs())
+    org_configs = {org: org_config for org, org_config in org_configs if org_config}
+
     json_data = {}
-    default_org_name, _ = runtime.keychain.get_default_org()
+    try:
+        default_org_name, _ = runtime.keychain.get_default_org()
+    except Exception:  # pragma: no cover
+        default_org_name = None
+
     for org, org_config in org_configs.items():
         is_org_default = org == default_org_name
         row_data = {"is_default": is_org_default, "name": org}
@@ -369,7 +379,12 @@ def org_list(runtime, json_flag, plain):
     console.print(scratch_table, justify="left")
     console.print(persistent_table, justify="left")
 
-    runtime.keychain.cleanup_org_cache_dirs()
+    try:
+        runtime.keychain.cleanup_org_cache_dirs()
+    except Exception:
+        click.echo(
+            "Cannot cleanup org cache dirs, perhaps due to org config files which cannot be decrypted."
+        )
 
 
 def _make_tables(json_data: dict):

{cumulusci-3.53.0.dev1 → cumulusci-3.54.0.dev0}/cumulusci/cli/tests/test_cci.py

@@ -416,6 +416,12 @@ def test_version__latest(capsys):
     assert "You have the latest version of CumulusCI" in console_output
 
 
+@mock.patch("cumulusci.cli.cci.warn_if_no_long_paths")
+def test_version__win_path_warning(warn_if):
+    run_click_command(cci.version)
+    warn_if.assert_called_once()
+
+
 @mock.patch("code.interact")
 def test_shell(interact):
     run_click_command(cci.shell)

{cumulusci-3.53.0.dev1 → cumulusci-3.54.0.dev0}/cumulusci/cli/tests/test_error.py

@@ -1,41 +1,46 @@
 import re
-from pathlib import Path
+import sys
 from unittest import mock
 
 import github3
 import pytest
 
 import cumulusci
-from cumulusci.cli.error import get_traceback
+from cumulusci.cli.error import get_context_info, get_traceback
 from cumulusci.core.exceptions import CumulusCIException
-from cumulusci.utils import temporary_dir
+from cumulusci.core.runtime import BaseCumulusCI
 
 from .. import error
-from .utils import run_click_command
+from .utils import run_cli_command
 
 
 class TestErrorCommands:
-    @mock.patch("click.echo")
-    @mock.patch("cumulusci.cli.error.CCI_LOGFILE_PATH")
-    def test_error_info_no_logfile_present(self, log_path, echo):
-        log_path.is_file.return_value = False
-        run_click_command(error.error_info)
-
-        echo.assert_called_once_with(f"No logfile found at: {error.CCI_LOGFILE_PATH}")
-
-    @mock.patch("click.echo")
-    def test_error_info(self, echo):
-        with temporary_dir() as path:
-            logfile = Path(path) / "cci.log"
-            logfile.write_text(
-                "This\nis\na\ntest\nTraceback (most recent call last):\n1\n2\n3\n\u2603",
-                encoding="utf-8",
-            )
-            with mock.patch("cumulusci.cli.error.CCI_LOGFILE_PATH", logfile):
-                run_click_command(error.error_info)
-        echo.assert_called_once_with(
-            "\nTraceback (most recent call last):\n1\n2\n3\n\u2603"
+    def test_error_info(self, capsys):
+        logfile = error.get_logfile_path()
+        logfile.parent.mkdir(parents=True)
+        logfile.write_text(
+            "This\nis\na\ntest\nTraceback (most recent call last):\n1\n2\n3\n\u2603",
+            encoding="utf-8",
         )
+        result = run_cli_command("error", "info")
+
+        assert "\nTraceback (most recent call last):\n1\n2\n3\n\u2603" in result.stdout
+
+    @mock.patch("cumulusci.cli.error.warn_if_no_long_paths")
+    def test_error_info_win_warn(self, warn_if):
+        logfile = error.get_logfile_path()
+        logfile.parent.mkdir(parents=True)
+        logfile.write_text(
+            "This\nis\na\ntest\nTraceback (most recent call last):\n1\n2\n3\n\u2603",
+            encoding="utf-8",
+        )
+        run_cli_command("error", "info")
+
+        warn_if.assert_called_once()
+
+    def test_error_info__no_logfile_present(self, capsys):
+        result = run_cli_command("error", "info")
+        assert f"No logfile found at: {error.get_logfile_path()}" in result.stdout
 
     def test_get_traceback__no_traceback(self):
         output = get_traceback("test_content")
@@ -47,7 +52,6 @@ class TestErrorCommands:
         output = get_traceback(content)
         assert output == traceback
 
-    @mock.patch("cumulusci.cli.error.CCI_LOGFILE_PATH")
     @mock.patch("webbrowser.open")
     @mock.patch("cumulusci.cli.error.platform")
     @mock.patch("cumulusci.cli.error.sys")
@@ -55,7 +59,7 @@ class TestErrorCommands:
     @mock.patch("cumulusci.cli.error.create_gist")
     @mock.patch("cumulusci.cli.error.get_github_api")
     def test_error_gist(
-        self, gh_api, create_gist, date, sys, platform, webbrowser_open, logfile_path
+        self, gh_api, create_gist, date, sys, platform, webbrowser_open
     ):
 
         platform.uname.return_value = mock.Mock(system="Rossian", machine="x68_46")
@@ -66,9 +70,10 @@ class TestErrorCommands:
         expected_gist_url = "https://gist.github.com/1234567890abcdefghijkl"
         create_gist.return_value = mock.Mock(html_url=expected_gist_url)
 
+        logfile_path = error.get_logfile_path()
+        logfile_path.parent.mkdir(parents=True)
         expected_logfile_content = "Hello there, I'm a logfile."
-        logfile_path.is_file.return_value = True
-        logfile_path.read_text.return_value = expected_logfile_content
+        logfile_path.write_text(expected_logfile_content)
 
         runtime = mock.Mock()
         runtime.project_config.repo_root = None
@@ -77,7 +82,7 @@ class TestErrorCommands:
             "token": "token",
         }
 
-        run_click_command(error.gist, runtime=runtime)
+        run_cli_command("error", "gist", runtime=runtime)
 
         expected_content = f"""CumulusCI version: {cumulusci.__version__}
 Python version: {sys.version.split()[0]} ({sys.executable})
@@ -93,20 +98,16 @@ Environment Info: Rossian / x68_46
         )
         webbrowser_open.assert_called_once_with(expected_gist_url)
 
-    @mock.patch("cumulusci.cli.error.CCI_LOGFILE_PATH")
-    @mock.patch("cumulusci.cli.error.click")
     @mock.patch("cumulusci.cli.error.platform")
     @mock.patch("cumulusci.cli.error.sys")
     @mock.patch("cumulusci.cli.error.datetime")
     @mock.patch("cumulusci.cli.error.create_gist")
     @mock.patch("cumulusci.cli.error.get_github_api")
-    def test_gist__creation_error(
-        self, gh_api, create_gist, date, sys, platform, click, logfile_path
-    ):
-
+    def test_gist__creation_error(self, gh_api, create_gist, date, sys, platform):
+        logfile_path = error.get_logfile_path()
+        logfile_path.parent.mkdir(parents=True)
         expected_logfile_content = "Hello there, I'm a logfile."
-        logfile_path.is_file.return_value = True
-        logfile_path.read_text.return_value = expected_logfile_content
+        logfile_path.write_text(expected_logfile_content)
 
         platform.uname.return_value = mock.Mock(sysname="Rossian", machine="x68_46")
         sys.version = "1.0.0 (default Jul 24 2019)"
@@ -130,7 +131,7 @@ Environment Info: Rossian / x68_46
         with pytest.raises(
             CumulusCIException, match="An error occurred attempting to create your gist"
         ):
-            run_click_command(error.gist, runtime=runtime)
+            run_cli_command("error", "gist", runtime=runtime)
 
         class GitHubExceptionWithResponse(github3.exceptions.NotFoundError, mock.Mock):
             def __init__(self, status_code):
@@ -142,14 +143,27 @@ Environment Info: Rossian / x68_46
 
         create_gist.side_effect = GitHubExceptionWithResponse(404)
         with pytest.raises(CumulusCIException, match=re.escape(error.GIST_404_ERR_MSG)):
-            run_click_command(error.gist, runtime=runtime)
-
-    @mock.patch("cumulusci.cli.error.CCI_LOGFILE_PATH")
-    @mock.patch("cumulusci.cli.error.click")
-    @mock.patch("cumulusci.cli.error.datetime")
-    @mock.patch("cumulusci.cli.error.create_gist")
-    @mock.patch("cumulusci.cli.error.get_github_api")
-    def test_gist__file_not_found(self, gh_api, create_gist, date, click, logfile_path):
-        logfile_path.is_file.return_value = False
-        with pytest.raises(CumulusCIException):
-            run_click_command(error.gist)
+            run_cli_command("error", "gist", runtime=runtime)
+
+    def test_gist__file_not_found(self):
+        runtime = BaseCumulusCI()
+        with pytest.raises(CumulusCIException, match="No logfile to open"):
+            run_cli_command("error", "gist", runtime=runtime)
+
+    @pytest.mark.skipif(
+        sys.platform.startswith("win"), reason="Requires Windows Registry"
+    )
+    @mock.patch("cumulusci.cli.error.win32_long_paths_enabled")
+    def test_get_context_not_win(self, win32_check):
+        info = get_context_info()
+        win32_check.assert_not_called()
+        assert "Windows" not in info
+
+    @pytest.mark.skipif(
+        not sys.platform.startswith("win"), reason="Requires Windows Registry"
+    )
+    @mock.patch("cumulusci.cli.error.win32_long_paths_enabled")
+    def test_get_context_win(self, win32_check):
+        info = get_context_info()
+        win32_check.assert_called_once()
+        assert "Windows" in info

{cumulusci-3.53.0.dev1 → cumulusci-3.54.0.dev0}/cumulusci/cli/tests/test_org.py

@@ -722,6 +722,73 @@ class TestOrgCommands:
 
         echo.assert_called_once_with(json.dumps(expected))
 
+    @mock.patch("click.echo")
+    @mock.patch("cumulusci.cli.org.CliTable")
+    def test_org_list__error(self, cli_tbl, echo):
+        runtime = mock.Mock()
+        runtime.universal_config.cli__plain_output = None
+        org_configs = {
+            "test0": ScratchOrgConfig(
+                {
+                    "default": True,
+                    "scratch": True,
+                    "date_created": datetime.now() - timedelta(days=8),
+                    "days": 7,
+                    "config_name": "dev",
+                    "username": "test0@example.com",
+                },
+                "test0",
+            ),
+            "test1": AssertionError("NOPE!"),
+            "test2": OrgConfig(
+                {
+                    "default": False,
+                    "scratch": False,
+                    "expires": "Persistent",
+                    "expired": False,
+                    "config_name": "dev",
+                    "username": "test2@example.com",
+                    "instance_url": "https://dude-chillin-2330-dev-ed.cs22.my.salesforce.com",
+                },
+                "test2",
+            ),
+        }
+
+        runtime.keychain.list_orgs.return_value = list(org_configs.keys())
+
+        def get_org(orgname):
+            value = org_configs[orgname]
+            if isinstance(value, Exception):
+                raise value
+            return value
+
+        runtime.keychain.get_org = get_org
+        runtime.project_config.cache_dir = Path("does_not_possibly_exist")
+        runtime.keychain.cleanup_org_cache_dirs.side_effect = AssertionError("OUCH!")
+
+        runtime.keychain.get_default_org.return_value = (
+            "test0",
+            ScratchOrgConfig(
+                {
+                    "default": True,
+                    "scratch": True,
+                    "date_created": datetime.now() - timedelta(days=8),
+                    "days": 7,
+                    "config_name": "dev",
+                    "username": "test0@example.com",
+                },
+                "test0",
+            ),
+        )
+
+        run_click_command(org.org_list, runtime=runtime, json_flag=False, plain=False)
+
+        assert "Cannot load org config for `test1`" in str(
+            echo.mock_calls
+        ), echo.mock_calls
+        assert "NOPE!" in str(echo.mock_calls), echo.mock_calls
+        assert "Cannot cleanup org cache dirs" in str(echo.mock_calls), echo.mock_calls
+
     @mock.patch("click.echo")
     def test_org_prune(self, echo):
         runtime = mock.Mock()

{cumulusci-3.53.0.dev1 → cumulusci-3.54.0.dev0}/cumulusci/cli/tests/test_service.py

@@ -1,4 +1,5 @@
 import json
+from unittest import mock
 
 import click
 import pytest
@@ -10,7 +11,8 @@ from cumulusci.core.tests.utils import EnvironmentVarGuard
 from .utils import run_cli_command
 
 
-def test_service_list():
+@mock.patch("cumulusci.cli.service.CliTable")
+def test_service_list(table_mock):
     runtime = BaseCumulusCI(
         config={
             "services": {
@@ -26,19 +28,18 @@ def test_service_list():
     }
     runtime.keychain._default_services = {"test": "test_alias", "bad": "bad_alias"}
 
-    result = run_cli_command("service", "list", runtime=runtime)
-    assert (
-        result.output
-        == """                            Services                             
-                                                                 
-  Default   Type             Name          Description           
- ─────────────────────────────────────────────────────────────── 
-  ✔         bad              bad_alias     Unconfigured Service  
-            something_else                 something else        
-            test             test2_alias   Test Service          
-  ✔         test             test_alias    Test Service          
-                                                                 
-"""  # noqa: W291,W293
+    run_cli_command("service", "list", runtime=runtime)
+
+    table_mock.assert_called_once_with(
+        [
+            ["Default", "Type", "Name", "Description"],
+            [True, "bad", "bad_alias", "Unconfigured Service"],
+            [False, "something_else", "", "something else"],
+            [False, "test", "test2_alias", "Test Service"],
+            [True, "test", "test_alias", "Test Service"],
+        ],
+        title="Services",
+        dim_rows=[2],
     )
 
 

{cumulusci-3.53.0.dev1 → cumulusci-3.54.0.dev0}/cumulusci/cli/tests/test_utils.py

@@ -4,6 +4,7 @@ import time
 from unittest import mock
 
 import pkg_resources
+import pytest
 import requests
 import responses
 
@@ -65,3 +66,57 @@ def test_check_latest_version_request_error(click, get_latest_final_version):
     utils.check_latest_version()
 
     click.echo.assert_any_call("Error checking cci version:", err=True)
+
+
+@pytest.mark.skipif(
+    not sys.platform.startswith("win"), reason="Requires Windows Registry"
+)
+@mock.patch("winreg.QueryValueEx")
+def test_win32_warning(query_value):
+    query_value.return_value = (1, 1)
+
+    is_enabled = utils.win32_long_paths_enabled()
+
+    query_value.assert_called_once()
+    assert "LongPathsEnabled" in query_value.call_args.args
+    assert is_enabled
+
+
+@pytest.mark.skipif(
+    sys.platform.startswith("win"), reason="Should not print on non-win32"
+)
+@mock.patch("cumulusci.cli.utils.win32_long_paths_enabled")
+@mock.patch("rich.console.Console.print")
+def test_no_longpath_warn_on_posix(console_print, is_enabled):
+    utils.warn_if_no_long_paths()
+
+    is_enabled.assert_not_called()
+    console_print.assert_not_called()
+
+
+@pytest.mark.skipif(
+    not sys.platform.startswith("win"), reason="Requires Windows Registry"
+)
+@mock.patch("cumulusci.cli.utils.win32_long_paths_enabled")
+@mock.patch("rich.console.Console.print")
+def test_no_longpath_warn_on_win(console_print, is_enabled):
+    is_enabled.return_value = True
+
+    utils.warn_if_no_long_paths()
+
+    is_enabled.assert_called_once()
+    console_print.assert_not_called()
+
+
+@pytest.mark.skipif(
+    not sys.platform.startswith("win"), reason="Requires Windows Registry"
+)
+@mock.patch("cumulusci.cli.utils.win32_long_paths_enabled")
+@mock.patch("rich.console.Console.print")
+def test_longpath_warn_on_win(console_print, is_enabled):
+    is_enabled.return_value = False
+
+    utils.warn_if_no_long_paths()
+
+    is_enabled.assert_called_once()
+    console_print.assert_called_once_with(utils.WIN_LONG_PATH_WARNING)

{cumulusci-3.53.0.dev1 → cumulusci-3.54.0.dev0}/cumulusci/cli/utils.py

@@ -8,6 +8,7 @@ from collections import defaultdict
 import click
 import pkg_resources
 import requests
+from rich.console import Console
 
 from cumulusci import __version__
 from cumulusci.core.config import UniversalConfig
@@ -15,6 +16,12 @@ from cumulusci.utils import get_cci_upgrade_command
 from cumulusci.utils.http.requests_utils import safe_json_from_response
 
 LOWEST_SUPPORTED_VERSION = (3, 8, 0)
+WIN_LONG_PATH_WARNING = """
+WARNING: Long path support is not enabled. This can lead to errors with some
+tasks. Your administrator will need to activate the "Enable Win32 long paths"
+group policy, or set LongPathsEnabled to 1 in the registry key
+HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Control\\FileSystem.
+"""
 
 
 def group_items(items):
@@ -106,3 +113,28 @@ def check_latest_version():
 def get_installed_version():
     """returns the version name (e.g. 2.0.0b58) that is installed"""
     return pkg_resources.parse_version(__version__)
+
+
+def win32_long_paths_enabled() -> bool:
+    """Boolean indicating whether long paths are available on Windows systems.
+
+    Reads the Windows Registry the running platform. Throws ModuleNotFoundError
+    if run on non-Windows platforms.
+    """
+    # Only present on windows, so import it here instead
+    import winreg
+
+    access_registry = winreg.ConnectRegistry(None, winreg.HKEY_LOCAL_MACHINE)
+    access_key = winreg.OpenKey(
+        access_registry, r"SYSTEM\CurrentControlSet\Control\FileSystem"
+    )
+
+    is_enabled, _ = winreg.QueryValueEx(access_key, "LongPathsEnabled")
+
+    return is_enabled == 1
+
+
+def warn_if_no_long_paths(console: Console = Console()) -> None:
+    """Print a warning to the user if long paths are not enabled."""
+    if sys.platform.startswith("win") and not win32_long_paths_enabled():
+        console.print(WIN_LONG_PATH_WARNING)